aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ABI
diff options
context:
space:
mode:
authorPeter Meerwald <p.meerwald@bct-electronic.com>2012-06-12 09:31:27 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2012-06-12 17:52:03 -0400
commit8b417d78ea486280bf8e908e76214c44c533ed3d (patch)
tree904920afa7cb7b3b5e18ba779387126081a1a9af /Documentation/ABI
parent988bb033d703c8b2e0e71c63f3f55616a0220ced (diff)
iio: nitpicking on sysfs-bus-iio
v2: address comments by Jonathan Cameron * add more output power down modes * spelling of etc. Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net> Acked-by: Jonathan Cameron <jic23@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/ABI')
-rw-r--r--Documentation/ABI/testing/sysfs-bus-iio50
1 files changed, 26 insertions, 24 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
index 5bc8a476c15e..e0f68f6a0e2a 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -40,9 +40,9 @@ Contact: linux-iio@vger.kernel.org
40Description: 40Description:
41 Some devices have internal clocks. This parameter sets the 41 Some devices have internal clocks. This parameter sets the
42 resulting sampling frequency. In many devices this 42 resulting sampling frequency. In many devices this
43 parameter has an effect on input filters etc rather than 43 parameter has an effect on input filters etc. rather than
44 simply controlling when the input is sampled. As this 44 simply controlling when the input is sampled. As this
45 effects datardy triggers, hardware buffers and the sysfs 45 effects data ready triggers, hardware buffers and the sysfs
46 direct access interfaces, it may be found in any of the 46 direct access interfaces, it may be found in any of the
47 relevant directories. If it effects all of the above 47 relevant directories. If it effects all of the above
48 then it is to be found in the base device directory. 48 then it is to be found in the base device directory.
@@ -74,7 +74,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw
74KernelVersion: 2.6.35 74KernelVersion: 2.6.35
75Contact: linux-iio@vger.kernel.org 75Contact: linux-iio@vger.kernel.org
76Description: 76Description:
77 Raw (unscaled no bias removal etc) voltage measurement from 77 Raw (unscaled no bias removal etc.) voltage measurement from
78 channel Y. In special cases where the channel does not 78 channel Y. In special cases where the channel does not
79 correspond to externally available input one of the named 79 correspond to externally available input one of the named
80 versions may be used. The number must always be specified and 80 versions may be used. The number must always be specified and
@@ -118,7 +118,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_temp_z_raw
118KernelVersion: 2.6.35 118KernelVersion: 2.6.35
119Contact: linux-iio@vger.kernel.org 119Contact: linux-iio@vger.kernel.org
120Description: 120Description:
121 Raw (unscaled no bias removal etc) temperature measurement. 121 Raw (unscaled no bias removal etc.) temperature measurement.
122 If an axis is specified it generally means that the temperature 122 If an axis is specified it generally means that the temperature
123 sensor is associated with one part of a compound device (e.g. 123 sensor is associated with one part of a compound device (e.g.
124 a gyroscope axis). Units after application of scale and offset 124 a gyroscope axis). Units after application of scale and offset
@@ -148,10 +148,9 @@ KernelVersion: 2.6.35
148Contact: linux-iio@vger.kernel.org 148Contact: linux-iio@vger.kernel.org
149Description: 149Description:
150 Angular velocity about axis x, y or z (may be arbitrarily 150 Angular velocity about axis x, y or z (may be arbitrarily
151 assigned) Data converted by application of offset then scale to 151 assigned). Has all the equivalent parameters as per voltageY.
152 radians per second. Has all the equivalent parameters as 152 Units after application of scale and offset are radians per
153 per voltageY. Units after application of scale and offset are 153 second.
154 radians per second.
155 154
156What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw 155What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw
157What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw 156What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw
@@ -161,7 +160,7 @@ Contact: linux-iio@vger.kernel.org
161Description: 160Description:
162 Inclination raw reading about axis x, y or z (may be 161 Inclination raw reading about axis x, y or z (may be
163 arbitrarily assigned). Data converted by application of offset 162 arbitrarily assigned). Data converted by application of offset
164 and scale to Degrees. 163 and scale to degrees.
165 164
166What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw 165What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw
167What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw 166What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw
@@ -203,7 +202,7 @@ Contact: linux-iio@vger.kernel.org
203Description: 202Description:
204 If known for a device, offset to be added to <type>[Y]_raw prior 203 If known for a device, offset to be added to <type>[Y]_raw prior
205 to scaling by <type>[Y]_scale in order to obtain value in the 204 to scaling by <type>[Y]_scale in order to obtain value in the
206 <type> units as specified in <type>[y]_raw documentation. 205 <type> units as specified in <type>[Y]_raw documentation.
207 Not present if the offset is always 0 or unknown. If Y or 206 Not present if the offset is always 0 or unknown. If Y or
208 axis <x|y|z> is not present, then the offset applies to all 207 axis <x|y|z> is not present, then the offset applies to all
209 in channels of <type>. 208 in channels of <type>.
@@ -248,7 +247,7 @@ What: /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibbias
248KernelVersion: 2.6.35 247KernelVersion: 2.6.35
249Contact: linux-iio@vger.kernel.org 248Contact: linux-iio@vger.kernel.org
250Description: 249Description:
251 Hardware applied calibration offset. (assumed to fix production 250 Hardware applied calibration offset (assumed to fix production
252 inaccuracies). 251 inaccuracies).
253 252
254What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale 253What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale
@@ -265,7 +264,7 @@ what /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale
265KernelVersion: 2.6.35 264KernelVersion: 2.6.35
266Contact: linux-iio@vger.kernel.org 265Contact: linux-iio@vger.kernel.org
267Description: 266Description:
268 Hardware applied calibration scale factor. (assumed to fix 267 Hardware applied calibration scale factor (assumed to fix
269 production inaccuracies). If shared across all channels, 268 production inaccuracies). If shared across all channels,
270 <type>_calibscale is used. 269 <type>_calibscale is used.
271 270
@@ -277,7 +276,7 @@ What: /sys/.../iio:deviceX/in_capacitance_scale_available
277KernelVersion: 2.635 276KernelVersion: 2.635
278Contact: linux-iio@vger.kernel.org 277Contact: linux-iio@vger.kernel.org
279Description: 278Description:
280 If a discrete set of scale values are available, they 279 If a discrete set of scale values is available, they
281 are listed in this attribute. 280 are listed in this attribute.
282 281
283What /sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain 282What /sys/bus/iio/devices/iio:deviceX/out_voltageY_hardwaregain
@@ -321,9 +320,11 @@ Contact: linux-iio@vger.kernel.org
321Description: 320Description:
322 Specifies the output powerdown mode. 321 Specifies the output powerdown mode.
323 DAC output stage is disconnected from the amplifier and 322 DAC output stage is disconnected from the amplifier and
324 1kohm_to_gnd: connected to ground via an 1kOhm resistor 323 1kohm_to_gnd: connected to ground via an 1kOhm resistor,
325 100kohm_to_gnd: connected to ground via an 100kOhm resistor 324 6kohm_to_gnd: connected to ground via a 6kOhm resistor,
326 three_state: left floating 325 20kohm_to_gnd: connected to ground via a 20kOhm resistor,
326 100kohm_to_gnd: connected to ground via an 100kOhm resistor,
327 three_state: left floating.
327 For a list of available output power down options read 328 For a list of available output power down options read
328 outX_powerdown_mode_available. If Y is not present the 329 outX_powerdown_mode_available. If Y is not present the
329 mode is shared across all outputs. 330 mode is shared across all outputs.
@@ -342,9 +343,10 @@ KernelVersion: 2.6.38
342Contact: linux-iio@vger.kernel.org 343Contact: linux-iio@vger.kernel.org
343Description: 344Description:
344 Writing 1 causes output Y to enter the power down mode specified 345 Writing 1 causes output Y to enter the power down mode specified
345 by the corresponding outY_powerdown_mode. Clearing returns to 346 by the corresponding outY_powerdown_mode. DAC output stage is
346 normal operation. Y may be suppressed if all outputs are 347 disconnected from the amplifier. Clearing returns to normal
347 controlled together. 348 operation. Y may be suppressed if all outputs are controlled
349 together.
348 350
349What: /sys/bus/iio/devices/iio:deviceX/events 351What: /sys/bus/iio/devices/iio:deviceX/events
350KernelVersion: 2.6.35 352KernelVersion: 2.6.35
@@ -390,12 +392,12 @@ Description:
390 different values, but the device can only enable both thresholds 392 different values, but the device can only enable both thresholds
391 or neither. 393 or neither.
392 Note the driver will assume the last p events requested are 394 Note the driver will assume the last p events requested are
393 to be enabled where p is however many it supports (which may 395 to be enabled where p is how many it supports (which may vary
394 vary depending on the exact set requested. So if you want to be 396 depending on the exact set requested. So if you want to be
395 sure you have set what you think you have, check the contents of 397 sure you have set what you think you have, check the contents of
396 these attributes after everything is configured. Drivers may 398 these attributes after everything is configured. Drivers may
397 have to buffer any parameters so that they are consistent when 399 have to buffer any parameters so that they are consistent when
398 a given event type is enabled a future point (and not those for 400 a given event type is enabled at a future point (and not those for
399 whatever event was previously enabled). 401 whatever event was previously enabled).
400 402
401What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en 403What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en
@@ -671,7 +673,7 @@ What: /sys/.../buffer/scan_elements/in_anglvel_type
671What: /sys/.../buffer/scan_elements/in_magn_type 673What: /sys/.../buffer/scan_elements/in_magn_type
672What: /sys/.../buffer/scan_elements/in_incli_type 674What: /sys/.../buffer/scan_elements/in_incli_type
673What: /sys/.../buffer/scan_elements/in_voltageY_type 675What: /sys/.../buffer/scan_elements/in_voltageY_type
674What: /sys/.../buffer/scan_elements/in_voltage-in_type 676What: /sys/.../buffer/scan_elements/in_voltage_type
675What: /sys/.../buffer/scan_elements/in_voltageY_supply_type 677What: /sys/.../buffer/scan_elements/in_voltageY_supply_type
676What: /sys/.../buffer/scan_elements/in_timestamp_type 678What: /sys/.../buffer/scan_elements/in_timestamp_type
677KernelVersion: 2.6.37 679KernelVersion: 2.6.37
@@ -692,7 +694,7 @@ Description:
692 the buffer output value appropriately. The storagebits value 694 the buffer output value appropriately. The storagebits value
693 also specifies the data alignment. So s48/64>>2 will be a 695 also specifies the data alignment. So s48/64>>2 will be a
694 signed 48 bit integer stored in a 64 bit location aligned to 696 signed 48 bit integer stored in a 64 bit location aligned to
695 a a64 bit boundary. To obtain the clean value, shift right 2 697 a 64 bit boundary. To obtain the clean value, shift right 2
696 and apply a mask to zero the top 16 bits of the result. 698 and apply a mask to zero the top 16 bits of the result.
697 For other storage combinations this attribute will be extended 699 For other storage combinations this attribute will be extended
698 appropriately. 700 appropriately.