[PATCH] iio: Add ABI documentation for in_magn offset and raw values

[PATCH] iio: Add ABI documentation for in_magn offset and raw values

[Darshana Padmadas]

This patch adds ABI documentation entries for in_magn_offset
and in_magn_raw. At least one user exists, mag3110 and
hid-sensor-magn-3d in drivers/iio/magnetometer.

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

diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 9a70c31..37564cb 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -177,6 +177,7 @@ Description:
 		arbitrarily assigned). Data converted by application of offset
 		and scale to degrees.
 
+What:		/sys/bus/iio/devices/iio:deviceX/in_magn_raw
 What:		/sys/bus/iio/devices/iio:deviceX/in_magn_x_raw
 What:		/sys/bus/iio/devices/iio:deviceX/in_magn_y_raw
 What:		/sys/bus/iio/devices/iio:deviceX/in_magn_z_raw
@@ -253,6 +254,7 @@ What:		/sys/bus/iio/devices/iio:deviceX/in_temp_offset
 What:		/sys/bus/iio/devices/iio:deviceX/in_pressureY_offset
 What:		/sys/bus/iio/devices/iio:deviceX/in_pressure_offset
 What:		/sys/bus/iio/devices/iio:deviceX/in_humidityrelative_offset
+What:		/sys/bus/iio/devices/iio:deviceX/in_magn_offset
 KernelVersion:	2.6.35
 Contact:	linux-iio@vger.kernel.org
 Description:
-- 
1.9.1

Re: [Outreachy kernel] [PATCH] iio: Add ABI documentation for in_magn offset and raw values

[Daniel Baluta]

On Fri, Mar 13, 2015 at 3:46 PM, Darshana Padmadas
<darshanapadmadas@gmail.com> wrote:
> This patch adds ABI documentation entries for in_magn_offset
> and in_magn_raw. At least one user exists, mag3110 and
> hid-sensor-magn-3d in drivers/iio/magnetometer.

Hi,

Because we have:

* .modified field set to 1
* .channel2 set to some modifier (e.g IIO_MOD_X)
* info_mask_separate  set to IIO_CHAN_INFO_RAW

resulting attributes will be of the form:

* in_magn_x_raw, in_magn_y_raw, in_magn_z_raw etc.


The patch looks good for offset attribute because in hid-sensor-magn-3d we have:
* info_mask_shared_by_type set to IIO_CHAN_OFFSET.

Please use the dummy driver to confirm this. And resend the patch keeping only
the entry for offset.

thanks,
Daniel.