2020-06-01 16:20:29

by Tomasz Duszynski

[permalink] [raw]
Subject: [PATCH] iio: improve IIO_CONCENTRATION channel type description

IIO_CONCENTRATION together with INFO_RAW specifier is used for reporting
raw concentrations of pollutants. Raw value should be meaningless
before being properly scaled. Because of that description shouldn't
mention raw value unit whatsoever.

Fix this by rephrasing existing description so it follows conventions
used throughout IIO ABI docs.

Fixes: 8ff6b3bc94930 ("iio: chemical: Add IIO_CONCENTRATION channel type")
Signed-off-by: Tomasz Duszynski <[email protected]>
---
Documentation/ABI/testing/sysfs-bus-iio | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index d3e53a6d8331..5c62bfb0f3f5 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -1569,7 +1569,8 @@ What: /sys/bus/iio/devices/iio:deviceX/in_concentrationX_voc_raw
KernelVersion: 4.3
Contact: [email protected]
Description:
- Raw (unscaled no offset etc.) percentage reading of a substance.
+ Raw (unscaled no offset etc.) reading of a substance. Units
+ after application of scale and offset are percents.

What: /sys/bus/iio/devices/iio:deviceX/in_resistance_raw
What: /sys/bus/iio/devices/iio:deviceX/in_resistanceX_raw
--
2.26.2


2020-06-01 21:22:22

by Matt Ranostay

[permalink] [raw]
Subject: Re: [PATCH] iio: improve IIO_CONCENTRATION channel type description

On Mon, Jun 1, 2020 at 9:18 AM Tomasz Duszynski
<[email protected]> wrote:
>
> IIO_CONCENTRATION together with INFO_RAW specifier is used for reporting
> raw concentrations of pollutants. Raw value should be meaningless
> before being properly scaled. Because of that description shouldn't
> mention raw value unit whatsoever.
>
> Fix this by rephrasing existing description so it follows conventions
> used throughout IIO ABI docs.

Acked-by: Matt Ranostay <[email protected]>

>
> Fixes: 8ff6b3bc94930 ("iio: chemical: Add IIO_CONCENTRATION channel type")
> Signed-off-by: Tomasz Duszynski <[email protected]>
> ---
> Documentation/ABI/testing/sysfs-bus-iio | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index d3e53a6d8331..5c62bfb0f3f5 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -1569,7 +1569,8 @@ What: /sys/bus/iio/devices/iio:deviceX/in_concentrationX_voc_raw
> KernelVersion: 4.3
> Contact: [email protected]
> Description:
> - Raw (unscaled no offset etc.) percentage reading of a substance.
> + Raw (unscaled no offset etc.) reading of a substance. Units
> + after application of scale and offset are percents.
>
> What: /sys/bus/iio/devices/iio:deviceX/in_resistance_raw
> What: /sys/bus/iio/devices/iio:deviceX/in_resistanceX_raw
> --
> 2.26.2
>

2020-06-06 14:50:09

by Jonathan Cameron

[permalink] [raw]
Subject: Re: [PATCH] iio: improve IIO_CONCENTRATION channel type description

On Mon, 1 Jun 2020 14:19:43 -0700
Matt Ranostay <[email protected]> wrote:

> On Mon, Jun 1, 2020 at 9:18 AM Tomasz Duszynski
> <[email protected]> wrote:
> >
> > IIO_CONCENTRATION together with INFO_RAW specifier is used for reporting
> > raw concentrations of pollutants. Raw value should be meaningless
> > before being properly scaled. Because of that description shouldn't
> > mention raw value unit whatsoever.
> >
> > Fix this by rephrasing existing description so it follows conventions
> > used throughout IIO ABI docs.
>
> Acked-by: Matt Ranostay <[email protected]>

Thanks for tidying that up.

Applied to the togreg branch of iio.git and pushed out as testing for
the autobuilders to ignore.

Thanks,

Jonathan

>
> >
> > Fixes: 8ff6b3bc94930 ("iio: chemical: Add IIO_CONCENTRATION channel type")
> > Signed-off-by: Tomasz Duszynski <[email protected]>
> > ---
> > Documentation/ABI/testing/sysfs-bus-iio | 3 ++-
> > 1 file changed, 2 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> > index d3e53a6d8331..5c62bfb0f3f5 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-iio
> > +++ b/Documentation/ABI/testing/sysfs-bus-iio
> > @@ -1569,7 +1569,8 @@ What: /sys/bus/iio/devices/iio:deviceX/in_concentrationX_voc_raw
> > KernelVersion: 4.3
> > Contact: [email protected]
> > Description:
> > - Raw (unscaled no offset etc.) percentage reading of a substance.
> > + Raw (unscaled no offset etc.) reading of a substance. Units
> > + after application of scale and offset are percents.
> >
> > What: /sys/bus/iio/devices/iio:deviceX/in_resistance_raw
> > What: /sys/bus/iio/devices/iio:deviceX/in_resistanceX_raw
> > --
> > 2.26.2
> >