diff mbox series

[v3,2/3] iio: ABI: generalize shunt_resistor attribute

Message ID 20240722-iio-pac1921-v3-2-05dc9916cb33@gmail.com (mailing list archive)
State Accepted
Headers show
Series iio: adc: add support for pac1921 | expand

Commit Message

Matteo Martelli July 22, 2024, 10:03 a.m. UTC
Move ABI documentation for custom shunt resistor attributes into the
generic iio documentation file. Exception for pac1934: leave it
untouched since it does not comply with common iio ABI generalization.

Signed-off-by: Matteo Martelli <matteomartelli3@gmail.com>
---
 Documentation/ABI/testing/sysfs-bus-iio             |  8 ++++++++
 Documentation/ABI/testing/sysfs-bus-iio-adc-max9611 | 17 -----------------
 Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc  |  9 ---------
 3 files changed, 8 insertions(+), 26 deletions(-)

Comments

Jonathan Cameron July 22, 2024, 8:07 p.m. UTC | #1
On Mon, 22 Jul 2024 12:03:19 +0200
Matteo Martelli <matteomartelli3@gmail.com> wrote:

> Move ABI documentation for custom shunt resistor attributes into the
> generic iio documentation file. Exception for pac1934: leave it
> untouched since it does not comply with common iio ABI generalization.
> 
> Signed-off-by: Matteo Martelli <matteomartelli3@gmail.com>
This stands on it's own even if the driver needs a minor tweak or two yet.
Hence in the interests of not having to remember I've read it before,
I've queued this patch up;


Applied to the testing branch of iio.git. That will be rebased on rc1 once
available and pushed out as togreg for linux-next to pick it up.

Thanks,

Jonathan

> ---
>  Documentation/ABI/testing/sysfs-bus-iio             |  8 ++++++++
>  Documentation/ABI/testing/sysfs-bus-iio-adc-max9611 | 17 -----------------
>  Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc  |  9 ---------
>  3 files changed, 8 insertions(+), 26 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 7cee78ad4108..935d67fd1a43 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -2289,3 +2289,11 @@ KernelVersion:	6.7
>  Contact:	linux-iio@vger.kernel.org
>  Description:
>  		List of available timeout value for tap gesture confirmation.
> +
> +What:		/sys/.../iio:deviceX/in_shunt_resistor
> +What:		/sys/.../iio:deviceX/in_current_shunt_resistor
> +What:		/sys/.../iio:deviceX/in_power_shunt_resistor
> +KernelVersion:	6.10
> +Contact:	linux-iio@vger.kernel.org
> +Description:
> +		The value of current sense resistor in Ohms.
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611 b/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611
> deleted file mode 100644
> index 6d2d2b094941..000000000000
> --- a/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611
> +++ /dev/null
> @@ -1,17 +0,0 @@
> -What:		/sys/bus/iio/devices/iio:deviceX/in_power_shunt_resistor
> -Date:		March 2017
> -KernelVersion:	4.12
> -Contact:	linux-iio@vger.kernel.org
> -Description: 	The value of the shunt resistor used to compute power drain on
> -                common input voltage pin (RS+). In Ohms.
> -
> -What:		/sys/bus/iio/devices/iio:deviceX/in_current_shunt_resistor
> -Date:		March 2017
> -KernelVersion:	4.12
> -Contact:	linux-iio@vger.kernel.org
> -Description: 	The value of the shunt resistor used to compute current flowing
> -                between RS+ and RS- voltage sense inputs. In Ohms.
> -
> -These attributes describe a single physical component, exposed as two distinct
> -attributes as it is used to calculate two different values: power load and
> -current flowing between RS+ and RS- inputs.
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc b/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
> index 8916f7ec6507..8dbca113112d 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
> @@ -13,12 +13,3 @@ Description:
>  		available for reading data. However, samples can be occasionally skipped
>  		or repeated, depending on the beat between the capture and conversion
>  		rates.
> -
> -What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
> -Date:		December 2015
> -KernelVersion:	4.4
> -Contact:	linux-iio@vger.kernel.org
> -Description:
> -		The value of the shunt resistor may be known only at runtime fom an
> -		eeprom content read by a client application. This attribute allows to
> -		set its value in ohms.
>
Matteo Martelli July 23, 2024, 9:09 a.m. UTC | #2
Jonathan Cameron wrote:
> On Mon, 22 Jul 2024 12:03:19 +0200
> Matteo Martelli <matteomartelli3@gmail.com> wrote:
> 
> > Move ABI documentation for custom shunt resistor attributes into the
> > generic iio documentation file. Exception for pac1934: leave it
> > untouched since it does not comply with common iio ABI generalization.
> > 
> > Signed-off-by: Matteo Martelli <matteomartelli3@gmail.com>
> This stands on it's own even if the driver needs a minor tweak or two yet.
> Hence in the interests of not having to remember I've read it before,
> I've queued this patch up;
> 
> 
> Applied to the testing branch of iio.git. That will be rebased on rc1 once
> available and pushed out as togreg for linux-next to pick it up.
> 
> Thanks,
> 
> Jonathan
> 
Thanks Jonathan, should I remove this commit from next version of this patch
series or should I keep posting it?

Best regards,
Matteo
Jonathan Cameron July 27, 2024, 12:28 p.m. UTC | #3
On Tue, 23 Jul 2024 11:09:11 +0200
Matteo Martelli <matteomartelli3@gmail.com> wrote:

> Jonathan Cameron wrote:
> > On Mon, 22 Jul 2024 12:03:19 +0200
> > Matteo Martelli <matteomartelli3@gmail.com> wrote:
> >   
> > > Move ABI documentation for custom shunt resistor attributes into the
> > > generic iio documentation file. Exception for pac1934: leave it
> > > untouched since it does not comply with common iio ABI generalization.
> > > 
> > > Signed-off-by: Matteo Martelli <matteomartelli3@gmail.com>  
> > This stands on it's own even if the driver needs a minor tweak or two yet.
> > Hence in the interests of not having to remember I've read it before,
> > I've queued this patch up;
> > 
> > 
> > Applied to the testing branch of iio.git. That will be rebased on rc1 once
> > available and pushed out as togreg for linux-next to pick it up.
> > 
> > Thanks,
> > 
> > Jonathan
> >   
> Thanks Jonathan, should I remove this commit from next version of this patch
> series or should I keep posting it?

Please drop it from future versions.

> 
> Best regards,
> Matteo
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 7cee78ad4108..935d67fd1a43 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -2289,3 +2289,11 @@  KernelVersion:	6.7
 Contact:	linux-iio@vger.kernel.org
 Description:
 		List of available timeout value for tap gesture confirmation.
+
+What:		/sys/.../iio:deviceX/in_shunt_resistor
+What:		/sys/.../iio:deviceX/in_current_shunt_resistor
+What:		/sys/.../iio:deviceX/in_power_shunt_resistor
+KernelVersion:	6.10
+Contact:	linux-iio@vger.kernel.org
+Description:
+		The value of current sense resistor in Ohms.
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611 b/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611
deleted file mode 100644
index 6d2d2b094941..000000000000
--- a/Documentation/ABI/testing/sysfs-bus-iio-adc-max9611
+++ /dev/null
@@ -1,17 +0,0 @@ 
-What:		/sys/bus/iio/devices/iio:deviceX/in_power_shunt_resistor
-Date:		March 2017
-KernelVersion:	4.12
-Contact:	linux-iio@vger.kernel.org
-Description: 	The value of the shunt resistor used to compute power drain on
-                common input voltage pin (RS+). In Ohms.
-
-What:		/sys/bus/iio/devices/iio:deviceX/in_current_shunt_resistor
-Date:		March 2017
-KernelVersion:	4.12
-Contact:	linux-iio@vger.kernel.org
-Description: 	The value of the shunt resistor used to compute current flowing
-                between RS+ and RS- voltage sense inputs. In Ohms.
-
-These attributes describe a single physical component, exposed as two distinct
-attributes as it is used to calculate two different values: power load and
-current flowing between RS+ and RS- inputs.
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc b/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
index 8916f7ec6507..8dbca113112d 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
+++ b/Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc
@@ -13,12 +13,3 @@  Description:
 		available for reading data. However, samples can be occasionally skipped
 		or repeated, depending on the beat between the capture and conversion
 		rates.
-
-What:		/sys/bus/iio/devices/iio:deviceX/in_shunt_resistor
-Date:		December 2015
-KernelVersion:	4.4
-Contact:	linux-iio@vger.kernel.org
-Description:
-		The value of the shunt resistor may be known only at runtime fom an
-		eeprom content read by a client application. This attribute allows to
-		set its value in ohms.