Add ABI documentation for the HMC5843 magnetometric sensor. Signed-off-by: Shubhrajyoti D <shubhrajyoti@xxxxxx> --- Documentation/ABI/testing/sysfs-i2c-hmc5843 | 68 +++++++++++++++++++++++++++ 1 files changed, 68 insertions(+), 0 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-i2c-hmc5843 diff --git a/Documentation/ABI/testing/sysfs-i2c-hmc5843 b/Documentation/ABI/testing/sysfs-i2c-hmc5843 new file mode 100644 index 0000000..febb246 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-i2c-hmc5843 @@ -0,0 +1,68 @@ +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/operating_mode +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Shows the operating mode of the device. The values permissible are + 0,1,2 and 3. + 0 - Continuous-conversion mode, the + device continuously performs conversions and places the result in the + data register. + 1 - Single-Conversion Mode : device performs a single measurement, + sets RDY high and returned to sleep mode. + 2 - Idle Mode : Device is placed in idle mode. + 3 - Sleep Mode. Device is placed in sleep mode. + + Reading: returns the current operating mode. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/available_sampling_frequency +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Shows the supported data output rates in Hz. + + Reading: returns the possible data output rates. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/sampling_frequency +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Shows the current data output rate in Hz. + + Reading: returns the current data output rate. + + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/magn_gain +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Shows the gain in units of counts/milli-gauss. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/magn_range +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Shows the sensor input field range in units of milli-gauss. + The permissible values are 700, 1000, 1500, 2000, 3200, 3800, + 4500 and 6500. + + Reading: returns the current input field range. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/magn_x_raw +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Start a Magnetometric measurement and read the result. Values + represent the raw or unscaled X cocordinate values. + + Reading: returns the current X co-ordinate values. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/magn_y_raw +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Start a Magnetometric measurement and read the result. Values + represent the raw or unscaled Y cocordinate values. + + Reading: returns the current Y co-ordinate values. + +What: /sys/bus/i2c/devices/<busnum>-<devaddr>/deviceX/magn_z_raw +Date: July 2010 +Contact: Shubhrajyoti D <shubhrajyoti@xxxxxx> +Description: Start a Magnetometric measurement and read the result. Values + represent the raw or unscaled Z cocordinate values. + + Reading: returns the current Z co-ordinate values. + -- 1.5.4.7 -- To unsubscribe from this list: send the line "unsubscribe linux-iio" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
