[PATCH] iio: Add ABI documentation for illuminance raw and scale values in light

[PATCH] iio: Add ABI documentation for illuminance raw and scale values in light

[Darshana Padmadas]

This patchset adds ABI documentation for the following attributes:

in_illuminance_scale, used atleast once in al3320a staging/iio/light/
in_illuminance_calibscale, used atleast once in cm32181
in_illuminance_input, used in cm3232 at least once
in_illuminance_raw used atleast once in al3320a
in_illuminance_clear_raw and in_illuminance_ir_raw exposed by
gp2ap020a00f with modifiers IIO_MOD_LIGHT_CLEAR and
IIO_MOD_LIGHT_IR respectively.

Signed-off-by: Darshana Padmadas <darshanapadmadas@gmail.com>
---
 Documentation/ABI/testing/sysfs-bus-iio | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 4fd3976..4d1cbba 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -297,6 +297,7 @@ What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_scale
 What:		/sys/bus/iio/devices/iio:deviceX/in_pressure_scale
 What:		/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_scale
 What:		/sys/bus/iio/devices/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_scale
+What:		/sys/bus/iio/devices/iio:deviceX/in_illuminance_scale
 KernelVersion:	2.6.35
 Contact:	linux-iio@vger.kernel.org
 Description:
@@ -337,6 +338,7 @@ what		/sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibscale
 what		/sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale
 What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_calibscale
 What:		/sys/bus/iio/devices/iio:deviceX/in_pressure_calibscale
+What:		/sys/bus/iio/devices/iio:deviceX/in_illuminance_calibscale
 KernelVersion:	2.6.35
 Contact:	linux-iio@vger.kernel.org
 Description:
@@ -1144,9 +1146,13 @@ Description:
 		values should behave in the same way as a distance, i.e. lower
 		values indicate something is closer to the sensor.
 
+What:		/sys/.../iio:deviceX/in_illuminance_input
+What:		/sys/.../iio:deviceX/in_illuminance_raw
 What:		/sys/.../iio:deviceX/in_illuminanceY_input
 What:		/sys/.../iio:deviceX/in_illuminanceY_raw
 What:		/sys/.../iio:deviceX/in_illuminanceY_mean_raw
+What:		/sys/.../iio:deviceX/in_illuminance_ir_raw
+What:		/sys/.../iio:deviceX/in_illuminance_clear_raw
 KernelVersion:	3.4
 Contact:	linux-iio@vger.kernel.org
 Description:
-- 
1.9.1

Re: [Outreachy kernel] [PATCH] iio: Add ABI documentation for illuminance raw and scale values in light

[Daniel Baluta]

On Mon, Mar 16, 2015 at 1:48 PM, Darshana Padmadas
<darshanapadmadas@gmail.com> wrote:
> This patchset adds ABI documentation for the following attributes:
>
> in_illuminance_scale, used atleast once in al3320a staging/iio/light/

Reference to staging/iio/light here is confusing. People might think
that al3320 is in staging, while staging is your source tree top directory.

Better drop it :).

Also s/atleast/at least/

Just say:

in_illuminance_scale, exported by  al3320a ambient light sensor.

> in_illuminance_calibscale, used atleast once in cm32181
> in_illuminance_input, used in cm3232 at least once
> in_illuminance_raw used atleast once in al3320a
> in_illuminance_clear_raw and in_illuminance_ir_raw exposed by
> gp2ap020a00f with modifiers IIO_MOD_LIGHT_CLEAR and
> IIO_MOD_LIGHT_IR respectively.

The same for all the above.

Other than that, the patch looks good to me.

Daniel.

Re: [PATCH] iio: Add ABI documentation for illuminance raw and scale values in light

[Jonathan Cameron]

On 16/03/15 11:48, Darshana Padmadas wrote:
> This patchset adds ABI documentation for the following attributes:
> 
> in_illuminance_scale, used atleast once in al3320a staging/iio/light/
> in_illuminance_calibscale, used atleast once in cm32181
> in_illuminance_input, used in cm3232 at least once
> in_illuminance_raw used atleast once in al3320a
> in_illuminance_clear_raw and in_illuminance_ir_raw exposed by
> gp2ap020a00f with modifiers IIO_MOD_LIGHT_CLEAR and
> IIO_MOD_LIGHT_IR respectively.
> 
> Signed-off-by: Darshana Padmadas <darshanapadmadas@gmail.com>
Applied to the togreg branch of iio.git

Thanks,
> ---
>  Documentation/ABI/testing/sysfs-bus-iio | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
> index 4fd3976..4d1cbba 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio
> +++ b/Documentation/ABI/testing/sysfs-bus-iio
> @@ -297,6 +297,7 @@ What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_pressure_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_scale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_velocity_sqrt(x^2+y^2+z^2)_scale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_illuminance_scale
>  KernelVersion:	2.6.35
>  Contact:	linux-iio@vger.kernel.org
>  Description:
> @@ -337,6 +338,7 @@ what		/sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibscale
>  what		/sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_calibscale
>  What:		/sys/bus/iio/devices/iio:deviceX/in_pressure_calibscale
> +What:		/sys/bus/iio/devices/iio:deviceX/in_illuminance_calibscale
>  KernelVersion:	2.6.35
>  Contact:	linux-iio@vger.kernel.org
>  Description:
> @@ -1144,9 +1146,13 @@ Description:
>  		values should behave in the same way as a distance, i.e. lower
>  		values indicate something is closer to the sensor.
>  
> +What:		/sys/.../iio:deviceX/in_illuminance_input
> +What:		/sys/.../iio:deviceX/in_illuminance_raw
>  What:		/sys/.../iio:deviceX/in_illuminanceY_input
>  What:		/sys/.../iio:deviceX/in_illuminanceY_raw
>  What:		/sys/.../iio:deviceX/in_illuminanceY_mean_raw
> +What:		/sys/.../iio:deviceX/in_illuminance_ir_raw
> +What:		/sys/.../iio:deviceX/in_illuminance_clear_raw
>  KernelVersion:	3.4
>  Contact:	linux-iio@vger.kernel.org
>  Description:
>