* [PATCH 1/2] iio: Documentation: Add missing documentation for power attribute [not found] <20170716233410.22880-1-stefan.bruens@rwth-aachen.de> @ 2017-07-16 23:34 ` Stefan Brüns 2017-07-17 20:56 ` Jonathan Cameron 2017-07-16 23:34 ` [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation Stefan Brüns 1 sibling, 1 reply; 6+ messages in thread From: Stefan Brüns @ 2017-07-16 23:34 UTC (permalink / raw) To: linux-iio Cc: linux-kernel, Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler, Stefan Brüns Commit c43a102e67db ("iio: ina2xx: add support for TI INA2xx Power Monitors") introduced the in_powerY_raw attribute, but omitted the corresponding documentation. The description is correct for the INA2xx and the MAX9611 IIO drivers. Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> --- Documentation/ABI/testing/sysfs-bus-iio | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 2db2cdf42d54..7eead5f97e02 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio @@ -119,6 +119,15 @@ Description: unique to allow association with event codes. Units after application of scale and offset are milliamps. +What: /sys/bus/iio/devices/iio:deviceX/in_powerY_raw +KernelVersion: 4.5 +Contact: linux-iio@vger.kernel.org +Description: + Raw (unscaled no bias removal etc.) power measurement from + channel Y. The number must always be specified and + unique to allow association with event codes. Units after + application of scale and offset are milliwatts. + What: /sys/bus/iio/devices/iio:deviceX/in_capacitanceY_raw KernelVersion: 3.2 Contact: linux-iio@vger.kernel.org -- 2.13.2 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 1/2] iio: Documentation: Add missing documentation for power attribute 2017-07-16 23:34 ` [PATCH 1/2] iio: Documentation: Add missing documentation for power attribute Stefan Brüns @ 2017-07-17 20:56 ` Jonathan Cameron 0 siblings, 0 replies; 6+ messages in thread From: Jonathan Cameron @ 2017-07-17 20:56 UTC (permalink / raw) To: Stefan Brüns Cc: linux-iio, linux-kernel, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler On Mon, 17 Jul 2017 01:34:09 +0200 Stefan Brüns <stefan.bruens@rwth-aachen.de> wrote: > Commit c43a102e67db ("iio: ina2xx: add support for TI INA2xx Power Monitors") > introduced the in_powerY_raw attribute, but omitted the corresponding > documentation. > > The description is correct for the INA2xx and the MAX9611 IIO drivers. > > Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> Applied to the togreg branch of iio.git - initially pushed out as testing. Thanks, Jonathan > --- > Documentation/ABI/testing/sysfs-bus-iio | 9 +++++++++ > 1 file changed, 9 insertions(+) > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio > index 2db2cdf42d54..7eead5f97e02 100644 > --- a/Documentation/ABI/testing/sysfs-bus-iio > +++ b/Documentation/ABI/testing/sysfs-bus-iio > @@ -119,6 +119,15 @@ Description: > unique to allow association with event codes. Units after > application of scale and offset are milliamps. > > +What: /sys/bus/iio/devices/iio:deviceX/in_powerY_raw > +KernelVersion: 4.5 > +Contact: linux-iio@vger.kernel.org > +Description: > + Raw (unscaled no bias removal etc.) power measurement from > + channel Y. The number must always be specified and > + unique to allow association with event codes. Units after > + application of scale and offset are milliwatts. > + > What: /sys/bus/iio/devices/iio:deviceX/in_capacitanceY_raw > KernelVersion: 3.2 > Contact: linux-iio@vger.kernel.org ^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation [not found] <20170716233410.22880-1-stefan.bruens@rwth-aachen.de> 2017-07-16 23:34 ` [PATCH 1/2] iio: Documentation: Add missing documentation for power attribute Stefan Brüns @ 2017-07-16 23:34 ` Stefan Brüns 2017-07-17 20:53 ` Jonathan Cameron 1 sibling, 1 reply; 6+ messages in thread From: Stefan Brüns @ 2017-07-16 23:34 UTC (permalink / raw) To: linux-iio Cc: linux-kernel, Jonathan Cameron, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler, Stefan Brüns The ina2xx driver appeared in the Linux kernel version 4.5, but provided no documentation. Contrary to other uses of resistance in IIO, ina2xx uses microohms instead of ohms in the sysfs attribute. Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> --- Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc new file mode 100644 index 000000000000..9525098f6822 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc @@ -0,0 +1,7 @@ +What: /sys/bus/iio/devices/iio:deviceX/in_shunt_resistor +Date: December 2015 +KernelVersion: 4.5 +Contact: linux-iio@vger.kernel.org +Description: The value of the shunt resistor connected to the V_IN+ and V_IN- + inputs, used to compute the current flowing through the shunt and + the corresponding power. In microohms. -- 2.13.2 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation 2017-07-16 23:34 ` [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation Stefan Brüns @ 2017-07-17 20:53 ` Jonathan Cameron 2017-07-17 21:44 ` Brüns, Stefan 0 siblings, 1 reply; 6+ messages in thread From: Jonathan Cameron @ 2017-07-17 20:53 UTC (permalink / raw) To: Stefan Brüns Cc: linux-iio, linux-kernel, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler On Mon, 17 Jul 2017 01:34:10 +0200 Stefan Brüns <stefan.bruens@rwth-aachen.de> wrote: > The ina2xx driver appeared in the Linux kernel version 4.5, but provided > no documentation. Contrary to other uses of resistance in IIO, ina2xx uses > microohms instead of ohms in the sysfs attribute. > > Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> This has me confused. The documentation is already there and lists it as being in ohms. Ah, subtle filename difference. Docs in are Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc This attribute effectively exists for other parts as well now. Jonathan > --- > Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc | 7 +++++++ > 1 file changed, 7 insertions(+) > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > new file mode 100644 > index 000000000000..9525098f6822 > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > @@ -0,0 +1,7 @@ > +What: /sys/bus/iio/devices/iio:deviceX/in_shunt_resistor > +Date: December 2015 > +KernelVersion: 4.5 > +Contact: linux-iio@vger.kernel.org > +Description: The value of the shunt resistor connected to the V_IN+ and V_IN- > + inputs, used to compute the current flowing through the shunt and > + the corresponding power. In microohms. ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation 2017-07-17 20:53 ` Jonathan Cameron @ 2017-07-17 21:44 ` Brüns, Stefan 2017-07-18 10:20 ` Jonathan Cameron 0 siblings, 1 reply; 6+ messages in thread From: Brüns, Stefan @ 2017-07-17 21:44 UTC (permalink / raw) To: Jonathan Cameron Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler On Montag, 17. Juli 2017 22:53:57 CEST Jonathan Cameron wrote: > On Mon, 17 Jul 2017 01:34:10 +0200 > > Stefan Brüns <stefan.bruens@rwth-aachen.de> wrote: > > The ina2xx driver appeared in the Linux kernel version 4.5, but provided > > no documentation. Contrary to other uses of resistance in IIO, ina2xx uses > > microohms instead of ohms in the sysfs attribute. > > > > Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> > > This has me confused. The documentation is already > there and lists it as being in ohms. Which obviously, from reading the source code, is wrong - it uses microohms. Also, the current Description contains IMHO irrelevant stuff: "The value of the shunt resistor may be known only at runtime fom an eeprom content read by a client application." > Ah, subtle filename difference. Docs in are > Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc Well spotted ... > This attribute effectively exists for other parts > as well now. My grep foo failed me here, the only parts I could find are the MAX9611 (which specifies and uses ohms) and the INA2xx. adc/qcom-spmi-iadc.c allows to read the RSENSE value from device tree (specified in microohms), but does not expose it via sysfs. Can you point me to other devices? Slightly off-topic: Some attributes in iio are read from device-tree (e.g. shunt resistor values), should the iio documentation point to the dt bindings? Currently, only mount_matrix in sysfs-bus-iio vaguely mentions device-tree. Kind regards, Stefan > > --- > > > > Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc | 7 +++++++ > > 1 file changed, 7 insertions(+) > > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc new file mode > > 100644 > > index 000000000000..9525098f6822 > > --- /dev/null > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > @@ -0,0 +1,7 @@ > > +What: /sys/bus/iio/devices/iio:deviceX/in_shunt_resistor > > +Date: December 2015 > > +KernelVersion: 4.5 > > +Contact: linux-iio@vger.kernel.org > > +Description: The value of the shunt resistor connected to the V_IN+ and > > V_IN- + inputs, used to compute the current flowing through the shunt > > and + the corresponding power. In microohms. ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation 2017-07-17 21:44 ` Brüns, Stefan @ 2017-07-18 10:20 ` Jonathan Cameron 0 siblings, 0 replies; 6+ messages in thread From: Jonathan Cameron @ 2017-07-18 10:20 UTC (permalink / raw) To: Brüns, Stefan Cc: Jonathan Cameron, linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, Hartmut Knaack, Lars-Peter Clausen, Peter Meerwald-Stadler On Mon, 17 Jul 2017 21:44:19 +0000 "Brüns, Stefan" <Stefan.Bruens@rwth-aachen.de> wrote: > On Montag, 17. Juli 2017 22:53:57 CEST Jonathan Cameron wrote: > > On Mon, 17 Jul 2017 01:34:10 +0200 > > > > Stefan Brüns <stefan.bruens@rwth-aachen.de> wrote: > > > The ina2xx driver appeared in the Linux kernel version 4.5, but provided > > > no documentation. Contrary to other uses of resistance in IIO, ina2xx uses > > > microohms instead of ohms in the sysfs attribute. > > > > > > Signed-off-by: Stefan Brüns <stefan.bruens@rwth-aachen.de> > > > > This has me confused. The documentation is already > > there and lists it as being in ohms. > > Which obviously, from reading the source code, is wrong - it uses microohms. Hmm. Not good > > Also, the current Description contains IMHO irrelevant stuff: > "The value of the shunt resistor may be known only at runtime fom an > eeprom content read by a client application." > > > Ah, subtle filename difference. Docs in are > > Documentation/ABI/testing/sysfs-bus-iio-ina2xx-adc > > Well spotted ... > > > This attribute effectively exists for other parts > > as well now. > > My grep foo failed me here, the only parts I could find are the MAX9611 (which > specifies and uses ohms) and the INA2xx. > > adc/qcom-spmi-iadc.c allows to read the RSENSE value from device tree > (specified in microohms), but does not expose it via sysfs. > > Can you point me to other devices? You found it - just the one other part be it with several different shunt related entries. Now this is a problem as the ABI has to be consistent. So one of these drivers is buggy, and right now I'm thinking it is this one given the docs are consistent. The whole 'micro/milli' units was an ill judged attempt to try and be consistent with hwmon (we rapidly ran into issues generalizing but by then were were stuck with a few odd units). Recent policy has been the basic SI units if at all possible. > > Slightly off-topic: Some attributes in iio are read from device-tree (e.g. > shunt resistor values), should the iio documentation point to the dt bindings? > Currently, only mount_matrix in sysfs-bus-iio vaguely mentions device-tree. > The ABI docs probably shouldn't as it's an implementation detail. However, if it's particularly useful for some reason I don't see any real problem with doing so. Jonathan > Kind regards, > > Stefan > > > > --- > > > > > > Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc | 7 +++++++ > > > 1 file changed, 7 insertions(+) > > > create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > > > > > diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > > b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc new file mode > > > 100644 > > > index 000000000000..9525098f6822 > > > --- /dev/null > > > +++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ina2xx-adc > > > @@ -0,0 +1,7 @@ > > > +What: /sys/bus/iio/devices/iio:deviceX/in_shunt_resistor > > > +Date: December 2015 > > > +KernelVersion: 4.5 > > > +Contact: linux-iio@vger.kernel.org > > > +Description: The value of the shunt resistor connected to the V_IN+ > and > > > V_IN- + inputs, used to compute the current flowing through the shunt > > > and + the corresponding power. In microohms. > > -- > To unsubscribe from this list: send the line "unsubscribe linux-iio" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2017-07-18 10:23 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
[not found] <20170716233410.22880-1-stefan.bruens@rwth-aachen.de>
2017-07-16 23:34 ` [PATCH 1/2] iio: Documentation: Add missing documentation for power attribute Stefan Brüns
2017-07-17 20:56 ` Jonathan Cameron
2017-07-16 23:34 ` [PATCH 2/2] iio: Documentation: Add ina2xx shunt_resistor attribute documentation Stefan Brüns
2017-07-17 20:53 ` Jonathan Cameron
2017-07-17 21:44 ` Brüns, Stefan
2017-07-18 10:20 ` Jonathan Cameron
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).