[PATCH 3/6] iio: hmc5843: Add ABI documentation file for hmc5843

Daniel Baluta daniel.baluta at gmail.com
Sun Feb 7 21:32:06 EET 2016


On Sun, Feb 7, 2016 at 8:15 PM, Cristina Moraru
<cristina.moraru09 at gmail.com> wrote:
> Add ABI file documenting hmc5843 interface to userspace.
> Driver supports measurement readings for channels X, Y, Z,
> reading and updating configurations for scale, sampling
> frequency and bias current and displaying the available
> values for each configuration.
>
> Signed-off-by: Cristina Moraru <cristina.moraru09 at gmail.com>
> ---
>  .../ABI/testing/sysfs-bus-iio-magnetometer-hmc5843 | 40 ++++++++++++++++++++++
>  1 file changed, 40 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-magnetometer-hmc5843
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-magnetometer-hmc5843 b/Documentation/ABI/testing/sysfs-bus-iio-magnetometer-hmc5843
> new file mode 100644
> index 0000000..7a86158
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-magnetometer-hmc5843
> @@ -0,0 +1,40 @@
> +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
> +KernelVersion:  4.3.0
> +Contact:        linux-iio at vger.kernel.org
> +Description:
> +                Reading returns the measured result for channels
> +               X, Y, Z.
> +
> +What:           /sys/bus/iio/devices/iio:deviceX/in_magn_scale
> +What:           /sys/bus/iio/devices/iio:deviceX/scale_available
> +KernelVersion:  4.3.0
> +Contact:        linux-iio at vger.kernel.org
> +Description:
> +               Current configuration and available configurations
> +               for the shared scale.
> +
> +What:           /sys/bus/iio/devices/iio:deviceX/in_magn_sampling_frequency
> +What:           /sys/bus/iio/devices/iio:deviceX/sampling_frequency_available
> +KernelVersion:  4.3.0
> +Contact:        linux-iio at vger.kernel.org
> +Description:
> +                Current configuration and available configurations
> +               for the sampling frequency.

These are standard attributes and I think they are already documented in
syhsfs-bus-iio file.

> +
> +What:           /sys/bus/iio/devices/iio:deviceX/meas_conf
> +What:           /sys/bus/iio/devices/iio:deviceX/meas_conf_available
> +KernelVersion:  4.3.0
> +Contact:        linux-iio at vger.kernel.org
> +Description:
> +                Current configuration and available configurations
> +               for the bias current.
> +               0 - Normal measurement configurations (default)
> +               1 - Positive bias configuration
> +               2 - Negative bias configuration
> +               3 - Only available on HMC5983. Disables magnetic
> +               sensor and enables temperature sensor.
> +               Note: The effect of this configuration may vary
> +               according to the device. For exact documentation
> +               check the device's datasheet.

This looks good.


More information about the firefly mailing list