aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/ABI
diff options
context:
space:
mode:
authorJonathan Cameron <jic23@kernel.org>2012-04-25 10:55:00 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2012-04-25 14:12:23 -0400
commit8af2c75a328355c23d68d3f8651ad52af3c7979d (patch)
tree6e4a516128262ac43b19d4ae5a9c88afb2648b68 /Documentation/ABI
parenta980e046098b0a40eaff5e4e7fcde6cf035b7c06 (diff)
IIO: Move the core abi documentation from staging
This file contains only the most generic elements. Other class specific and device specific ABI documents will follow over time. Signed-off-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-iio730
1 files changed, 730 insertions, 0 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio
new file mode 100644
index 000000000000..2ce4dadaf3f5
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio
@@ -0,0 +1,730 @@
1What: /sys/bus/iio/devices/iio:deviceX
2KernelVersion: 2.6.35
3Contact: linux-iio@vger.kernel.org
4Description:
5 Hardware chip or device accessed by one communication port.
6 Corresponds to a grouping of sensor channels. X is the IIO
7 index of the device.
8
9What: /sys/bus/iio/devices/triggerX
10KernelVersion: 2.6.35
11Contact: linux-iio@vger.kernel.org
12Description:
13 An event driven driver of data capture to an in kernel buffer.
14 May be provided by a device driver that also has an IIO device
15 based on hardware generated events (e.g. data ready) or
16 provided by a separate driver for other hardware (e.g.
17 periodic timer, GPIO or high resolution timer).
18 Contains trigger type specific elements. These do not
19 generalize well and hence are not documented in this file.
20 X is the IIO index of the trigger.
21
22What: /sys/bus/iio/devices/iio:deviceX/buffer
23KernelVersion: 2.6.35
24Contact: linux-iio@vger.kernel.org
25Description:
26 Directory of attributes relating to the buffer for the device.
27
28What: /sys/bus/iio/devices/iio:deviceX/name
29KernelVersion: 2.6.35
30Contact: linux-iio@vger.kernel.org
31Description:
32 Description of the physical chip / device for device X.
33 Typically a part number.
34
35What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency
36What: /sys/bus/iio/devices/iio:deviceX/buffer/sampling_frequency
37What: /sys/bus/iio/devices/triggerX/sampling_frequency
38KernelVersion: 2.6.35
39Contact: linux-iio@vger.kernel.org
40Description:
41 Some devices have internal clocks. This parameter sets the
42 resulting sampling frequency. In many devices this
43 parameter has an effect on input filters etc rather than
44 simply controlling when the input is sampled. As this
45 effects datardy triggers, hardware buffers and the sysfs
46 direct access interfaces, it may be found in any of the
47 relevant directories. If it effects all of the above
48 then it is to be found in the base device directory.
49
50What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency_available
51What: /sys/.../iio:deviceX/buffer/sampling_frequency_available
52What: /sys/bus/iio/devices/triggerX/sampling_frequency_available
53KernelVersion: 2.6.35
54Contact: linux-iio@vger.kernel.org
55Description:
56 When the internal sampling clock can only take a small
57 discrete set of values, this file lists those available.
58
59What: /sys/bus/iio/devices/iio:deviceX/oversampling_ratio
60KernelVersion: 2.6.38
61Contact: linux-iio@vger.kernel.org
62Description:
63 Hardware dependent ADC oversampling. Controls the sampling ratio
64 of the digital filter if available.
65
66What: /sys/bus/iio/devices/iio:deviceX/oversampling_ratio_available
67KernelVersion: 2.6.38
68Contact: linux-iio@vger.kernel.org
69Description:
70 Hardware dependent values supported by the oversampling filter.
71
72What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_raw
73What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw
74KernelVersion: 2.6.35
75Contact: linux-iio@vger.kernel.org
76Description:
77 Raw (unscaled no bias removal etc) voltage measurement from
78 channel Y. In special cases where the channel does not
79 correspond to externally available input one of the named
80 versions may be used. The number must always be specified and
81 unique to allow association with event codes. Units after
82 application of scale and offset are microvolts.
83
84What: /sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_raw
85KernelVersion: 2.6.35
86Contact: linux-iio@vger.kernel.org
87Description:
88 Raw (unscaled) differential voltage measurement equivalent to
89 channel Y - channel Z where these channel numbers apply to the
90 physically equivalent inputs when non differential readings are
91 separately available. In differential only parts, then all that
92 is required is a consistent labeling. Units after application
93 of scale and offset are microvolts.
94
95What: /sys/bus/iio/devices/iio:deviceX/in_capacitanceY_raw
96KernelVersion: 3.2
97Contact: linux-iio@vger.kernel.org
98Description:
99 Raw capacitance measurement from channel Y. Units after
100 application of scale and offset are nanofarads.
101
102What: /sys/.../iio:deviceX/in_capacitanceY-in_capacitanceZ_raw
103KernelVersion: 3.2
104Contact: linux-iio@vger.kernel.org
105Description:
106 Raw differential capacitance measurement equivalent to
107 channel Y - channel Z where these channel numbers apply to the
108 physically equivalent inputs when non differential readings are
109 separately available. In differential only parts, then all that
110 is required is a consistent labeling. Units after application
111 of scale and offset are nanofarads.
112
113What: /sys/bus/iio/devices/iio:deviceX/in_temp_raw
114What: /sys/bus/iio/devices/iio:deviceX/in_tempX_raw
115What: /sys/bus/iio/devices/iio:deviceX/in_temp_x_raw
116What: /sys/bus/iio/devices/iio:deviceX/in_temp_y_raw
117What: /sys/bus/iio/devices/iio:deviceX/in_temp_z_raw
118KernelVersion: 2.6.35
119Contact: linux-iio@vger.kernel.org
120Description:
121 Raw (unscaled no bias removal etc) temperature measurement.
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.
124 a gyroscope axis). Units after application of scale and offset
125 are milli degrees Celsuis.
126
127What: /sys/bus/iio/devices/iio:deviceX/in_tempX_input
128KernelVersion: 2.6.38
129Contact: linux-iio@vger.kernel.org
130Description:
131 Scaled temperature measurement in milli degrees Celsius.
132
133What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_raw
134What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_raw
135What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_raw
136KernelVersion: 2.6.35
137Contact: linux-iio@vger.kernel.org
138Description:
139 Acceleration in direction x, y or z (may be arbitrarily assigned
140 but should match other such assignments on device).
141 Has all of the equivalent parameters as per voltageY. Units
142 after application of scale and offset are m/s^2.
143
144What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_raw
145What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_raw
146What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_raw
147KernelVersion: 2.6.35
148Contact: linux-iio@vger.kernel.org
149Description:
150 Angular velocity about axis x, y or z (may be arbitrarily
151 assigned) Data converted by application of offset then scale to
152 radians per second. Has all the equivalent parameters as
153 per voltageY. Units after application of scale and offset are
154 radians per second.
155
156What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw
157What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw
158What: /sys/bus/iio/devices/iio:deviceX/in_incli_z_raw
159KernelVersion: 2.6.35
160Contact: linux-iio@vger.kernel.org
161Description:
162 Inclination raw reading about axis x, y or z (may be
163 arbitrarily assigned). Data converted by application of offset
164 and scale to Degrees.
165
166What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw
167What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw
168What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_raw
169KernelVersion: 2.6.35
170Contact: linux-iio@vger.kernel.org
171Description:
172 Magnetic field along axis x, y or z (may be arbitrarily
173 assigned). Data converted by application of offset
174 then scale to Gauss.
175
176What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_peak_raw
177What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_peak_raw
178What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_peak_raw
179KernelVersion: 2.6.36
180Contact: linux-iio@vger.kernel.org
181Description:
182 Highest value since some reset condition. These
183 attributes allow access to this and are otherwise
184 the direct equivalent of the <type>Y[_name]_raw attributes.
185
186What: /sys/bus/iio/devices/iio:deviceX/in_accel_xyz_squared_peak_raw
187KernelVersion: 2.6.36
188Contact: linux-iio@vger.kernel.org
189Description:
190 A computed peak value based on the sum squared magnitude of
191 the underlying value in the specified directions.
192
193What: /sys/bus/iio/devices/iio:deviceX/in_accel_offset
194What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_offset
195What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_offset
196What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_offset
197What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_offset
198What: /sys/bus/iio/devices/iio:deviceX/in_voltage_offset
199What: /sys/bus/iio/devices/iio:deviceX/in_tempY_offset
200What: /sys/bus/iio/devices/iio:deviceX/in_temp_offset
201KernelVersion: 2.6.35
202Contact: linux-iio@vger.kernel.org
203Description:
204 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
206 <type> units as specified in <type>[y]_raw documentation.
207 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
209 in channels of <type>.
210 May be writable if a variable offset can be applied on the
211 device. Note that this is different to calibbias which
212 is for devices (or drivers) that apply offsets to compensate
213 for variation between different instances of the part, typically
214 adjusted by using some hardware supported calibration procedure.
215 Calibbias is applied internally, offset is applied in userspace
216 to the _raw output.
217
218What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_scale
219What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_scale
220What: /sys/bus/iio/devices/iio:deviceX/in_voltage_scale
221What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_scale
222What: /sys/bus/iio/devices/iio:deviceX/in_accel_scale
223What: /sys/bus/iio/devices/iio:deviceX/in_accel_peak_scale
224What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_scale
225What: /sys/bus/iio/devices/iio:deviceX/in_magn_scale
226What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_scale
227What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_scale
228What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_scale
229KernelVersion: 2.6.35
230Contact: linux-iio@vger.kernel.org
231Description:
232 If known for a device, scale to be applied to <type>Y[_name]_raw
233 post addition of <type>[Y][_name]_offset in order to obtain the
234 measured value in <type> units as specified in
235 <type>[Y][_name]_raw documentation. If shared across all in
236 channels then Y and <x|y|z> are not present and the value is
237 called <type>[Y][_name]_scale. The peak modifier means this
238 value is applied to <type>Y[_name]_peak_raw values.
239
240What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias
241What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias
242What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias
243What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias
244What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias
245What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias
246What: /sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibbias
247What: /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibbias
248KernelVersion: 2.6.35
249Contact: linux-iio@vger.kernel.org
250Description:
251 Hardware applied calibration offset. (assumed to fix production
252 inaccuracies).
253
254What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale
255What /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_calibscale
256What /sys/bus/iio/devices/iio:deviceX/in_voltage_calibscale
257What /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibscale
258What /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibscale
259What /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibscale
260What /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibscale
261What /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibscale
262What /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibscale
263what /sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibscale
264what /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale
265KernelVersion: 2.6.35
266Contact: linux-iio@vger.kernel.org
267Description:
268 Hardware applied calibration scale factor. (assumed to fix
269 production inaccuracies). If shared across all channels,
270 <type>_calibscale is used.
271
272What: /sys/bus/iio/devices/iio:deviceX/in_accel_scale_available
273What: /sys/.../iio:deviceX/in_voltageX_scale_available
274What: /sys/.../iio:deviceX/in_voltage-voltage_scale_available
275What: /sys/.../iio:deviceX/out_voltageX_scale_available
276What: /sys/.../iio:deviceX/in_capacitance_scale_available
277KernelVersion: 2.635
278Contact: linux-iio@vger.kernel.org
279Description:
280 If a discrete set of scale values are available, they
281 are listed in this attribute.
282
283What: /sys/.../in_accel_filter_low_pass_3db_frequency
284What: /sys/.../in_magn_filter_low_pass_3db_frequency
285What: /sys/.../in_anglvel_filter_low_pass_3db_frequency
286KernelVersion: 3.2
287Contact: linux-iio@vger.kernel.org
288Description:
289 If a known or controllable low pass filter is applied
290 to the underlying data channel, then this parameter
291 gives the 3dB frequency of the filter in Hz.
292
293What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw
294KernelVersion: 2.6.37
295Contact: linux-iio@vger.kernel.org
296Description:
297 Raw (unscaled, no bias etc.) output voltage for
298 channel Y. The number must always be specified and
299 unique if the output corresponds to a single channel.
300
301What: /sys/bus/iio/devices/iio:deviceX/out_voltageY&Z_raw
302KernelVersion: 2.6.37
303Contact: linux-iio@vger.kernel.org
304Description:
305 Raw (unscaled, no bias etc.) output voltage for an aggregate of
306 channel Y, channel Z, etc. This interface is available in cases
307 where a single output sets the value for multiple channels
308 simultaneously.
309
310What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown_mode
311What: /sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown_mode
312KernelVersion: 2.6.38
313Contact: linux-iio@vger.kernel.org
314Description:
315 Specifies the output powerdown mode.
316 DAC output stage is disconnected from the amplifier and
317 1kohm_to_gnd: connected to ground via an 1kOhm resistor
318 100kohm_to_gnd: connected to ground via an 100kOhm resistor
319 three_state: left floating
320 For a list of available output power down options read
321 outX_powerdown_mode_available. If Y is not present the
322 mode is shared across all outputs.
323
324What: /sys/.../iio:deviceX/out_votlageY_powerdown_mode_available
325What: /sys/.../iio:deviceX/out_voltage_powerdown_mode_available
326KernelVersion: 2.6.38
327Contact: linux-iio@vger.kernel.org
328Description:
329 Lists all available output power down modes.
330 If Y is not present the mode is shared across all outputs.
331
332What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown
333What: /sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown
334KernelVersion: 2.6.38
335Contact: linux-iio@vger.kernel.org
336Description:
337 Writing 1 causes output Y to enter the power down mode specified
338 by the corresponding outY_powerdown_mode. Clearing returns to
339 normal operation. Y may be suppressed if all outputs are
340 controlled together.
341
342What: /sys/bus/iio/devices/iio:deviceX/events
343KernelVersion: 2.6.35
344Contact: linux-iio@vger.kernel.org
345Description:
346 Configuration of which hardware generated events are passed up
347 to user-space.
348
349What: /sys/.../iio:deviceX/events/in_accel_x_thresh_rising_en
350What: /sys/.../iio:deviceX/events/in_accel_x_thresh_falling_en
351What: /sys/.../iio:deviceX/events/in_accel_y_thresh_rising_en
352What: /sys/.../iio:deviceX/events/in_accel_y_thresh_falling_en
353What: /sys/.../iio:deviceX/events/in_accel_z_thresh_rising_en
354What: /sys/.../iio:deviceX/events/in_accel_z_thresh_falling_en
355What: /sys/.../iio:deviceX/events/in_anglvel_x_thresh_rising_en
356What: /sys/.../iio:deviceX/events/in_anglvel_x_thresh_falling_en
357What: /sys/.../iio:deviceX/events/in_anglvel_y_thresh_rising_en
358What: /sys/.../iio:deviceX/events/in_anglvel_y_thresh_falling_en
359What: /sys/.../iio:deviceX/events/in_anglvel_z_thresh_rising_en
360What: /sys/.../iio:deviceX/events/in_anglvel_z_thresh_falling_en
361What: /sys/.../iio:deviceX/events/in_magn_x_thresh_rising_en
362What: /sys/.../iio:deviceX/events/in_magn_x_thresh_falling_en
363What: /sys/.../iio:deviceX/events/in_magn_y_thresh_rising_en
364What: /sys/.../iio:deviceX/events/in_magn_y_thresh_falling_en
365What: /sys/.../iio:deviceX/events/in_magn_z_thresh_rising_en
366What: /sys/.../iio:deviceX/events/in_magn_z_thresh_falling_en
367What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_rising_en
368What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_falling_en
369What: /sys/.../iio:deviceX/events/in_voltageY_thresh_rising_en
370What: /sys/.../iio:deviceX/events/in_voltageY_thresh_falling_en
371What: /sys/.../iio:deviceX/events/in_tempY_thresh_rising_en
372What: /sys/.../iio:deviceX/events/in_tempY_thresh_falling_en
373KernelVersion: 2.6.37
374Contact: linux-iio@vger.kernel.org
375Description:
376 Event generated when channel passes a threshold in the specified
377 (_rising|_falling) direction. If the direction is not specified,
378 then either the device will report an event which ever direction
379 a single threshold value is passed in (e.g.
380 <type>[Y][_name]_<raw|input>_thresh_value) or
381 <type>[Y][_name]_<raw|input>_thresh_rising_value and
382 <type>[Y][_name]_<raw|input>_thresh_falling_value may take
383 different values, but the device can only enable both thresholds
384 or neither.
385 Note the driver will assume the last p events requested are
386 to be enabled where p is however many it supports (which may
387 vary depending on the exact set requested. So if you want to be
388 sure you have set what you think you have, check the contents of
389 these attributes after everything is configured. Drivers may
390 have to buffer any parameters so that they are consistent when
391 a given event type is enabled a future point (and not those for
392 whatever event was previously enabled).
393
394What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en
395What: /sys/.../iio:deviceX/events/in_accel_x_roc_falling_en
396What: /sys/.../iio:deviceX/events/in_accel_y_roc_rising_en
397What: /sys/.../iio:deviceX/events/in_accel_y_roc_falling_en
398What: /sys/.../iio:deviceX/events/in_accel_z_roc_rising_en
399What: /sys/.../iio:deviceX/events/in_accel_z_roc_falling_en
400What: /sys/.../iio:deviceX/events/in_anglvel_x_roc_rising_en
401What: /sys/.../iio:deviceX/events/in_anglvel_x_roc_falling_en
402What: /sys/.../iio:deviceX/events/in_anglvel_y_roc_rising_en
403What: /sys/.../iio:deviceX/events/in_anglvel_y_roc_falling_en
404What: /sys/.../iio:deviceX/events/in_anglvel_z_roc_rising_en
405What: /sys/.../iio:deviceX/events/in_anglvel_z_roc_falling_en
406What: /sys/.../iio:deviceX/events/in_magn_x_roc_rising_en
407What: /sys/.../iio:deviceX/events/in_magn_x_roc_falling_en
408What: /sys/.../iio:deviceX/events/in_magn_y_roc_rising_en
409What: /sys/.../iio:deviceX/events/in_magn_y_roc_falling_en
410What: /sys/.../iio:deviceX/events/in_magn_z_roc_rising_en
411What: /sys/.../iio:deviceX/events/in_magn_z_roc_falling_en
412What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_rising_en
413What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_falling_en
414What: /sys/.../iio:deviceX/events/in_voltageY_roc_rising_en
415What: /sys/.../iio:deviceX/events/in_voltageY_roc_falling_en
416What: /sys/.../iio:deviceX/events/in_tempY_roc_rising_en
417What: /sys/.../iio:deviceX/events/in_tempY_roc_falling_en
418KernelVersion: 2.6.37
419Contact: linux-iio@vger.kernel.org
420Description:
421 Event generated when channel passes a threshold on the rate of
422 change (1st differential) in the specified (_rising|_falling)
423 direction. If the direction is not specified, then either the
424 device will report an event which ever direction a single
425 threshold value is passed in (e.g.
426 <type>[Y][_name]_<raw|input>_roc_value) or
427 <type>[Y][_name]_<raw|input>_roc_rising_value and
428 <type>[Y][_name]_<raw|input>_roc_falling_value may take
429 different values, but the device can only enable both rate of
430 change thresholds or neither.
431 Note the driver will assume the last p events requested are
432 to be enabled where p is however many it supports (which may
433 vary depending on the exact set requested. So if you want to be
434 sure you have set what you think you have, check the contents of
435 these attributes after everything is configured. Drivers may
436 have to buffer any parameters so that they are consistent when
437 a given event type is enabled a future point (and not those for
438 whatever event was previously enabled).
439
440What: /sys/.../events/in_accel_x_raw_thresh_rising_value
441What: /sys/.../events/in_accel_x_raw_thresh_falling_value
442What: /sys/.../events/in_accel_y_raw_thresh_rising_value
443What: /sys/.../events/in_accel_y_raw_thresh_falling_value
444What: /sys/.../events/in_accel_z_raw_thresh_rising_value
445What: /sys/.../events/in_accel_z_raw_thresh_falling_value
446What: /sys/.../events/in_anglvel_x_raw_thresh_rising_value
447What: /sys/.../events/in_anglvel_x_raw_thresh_falling_value
448What: /sys/.../events/in_anglvel_y_raw_thresh_rising_value
449What: /sys/.../events/in_anglvel_y_raw_thresh_falling_value
450What: /sys/.../events/in_anglvel_z_raw_thresh_rising_value
451What: /sys/.../events/in_anglvel_z_raw_thresh_falling_value
452What: /sys/.../events/in_magn_x_raw_thresh_rising_value
453What: /sys/.../events/in_magn_x_raw_thresh_falling_value
454What: /sys/.../events/in_magn_y_raw_thresh_rising_value
455What: /sys/.../events/in_magn_y_raw_thresh_falling_value
456What: /sys/.../events/in_magn_z_raw_thresh_rising_value
457What: /sys/.../events/in_magn_z_raw_thresh_falling_value
458What: /sys/.../events/in_voltageY_supply_raw_thresh_rising_value
459What: /sys/.../events/in_voltageY_supply_raw_thresh_falling_value
460What: /sys/.../events/in_voltageY_raw_thresh_rising_value
461What: /sys/.../events/in_voltageY_raw_thresh_falling_value
462What: /sys/.../events/in_tempY_raw_thresh_rising_value
463What: /sys/.../events/in_tempY_raw_thresh_falling_value
464What: /sys/.../events/in_illuminance0_thresh_falling_value
465what: /sys/.../events/in_illuminance0_thresh_rising_value
466what: /sys/.../events/in_proximity0_thresh_falling_value
467what: /sys/.../events/in_proximity0_thresh_rising_value
468KernelVersion: 2.6.37
469Contact: linux-iio@vger.kernel.org
470Description:
471 Specifies the value of threshold that the device is comparing
472 against for the events enabled by
473 <type>Y[_name]_thresh[_rising|falling]_en.
474 If separate attributes exist for the two directions, but
475 direction is not specified for this attribute, then a single
476 threshold value applies to both directions.
477 The raw or input element of the name indicates whether the
478 value is in raw device units or in processed units (as _raw
479 and _input do on sysfs direct channel read attributes).
480
481What: /sys/.../events/in_accel_x_raw_roc_rising_value
482What: /sys/.../events/in_accel_x_raw_roc_falling_value
483What: /sys/.../events/in_accel_y_raw_roc_rising_value
484What: /sys/.../events/in_accel_y_raw_roc_falling_value
485What: /sys/.../events/in_accel_z_raw_roc_rising_value
486What: /sys/.../events/in_accel_z_raw_roc_falling_value
487What: /sys/.../events/in_anglvel_x_raw_roc_rising_value
488What: /sys/.../events/in_anglvel_x_raw_roc_falling_value
489What: /sys/.../events/in_anglvel_y_raw_roc_rising_value
490What: /sys/.../events/in_anglvel_y_raw_roc_falling_value
491What: /sys/.../events/in_anglvel_z_raw_roc_rising_value
492What: /sys/.../events/in_anglvel_z_raw_roc_falling_value
493What: /sys/.../events/in_magn_x_raw_roc_rising_value
494What: /sys/.../events/in_magn_x_raw_roc_falling_value
495What: /sys/.../events/in_magn_y_raw_roc_rising_value
496What: /sys/.../events/in_magn_y_raw_roc_falling_value
497What: /sys/.../events/in_magn_z_raw_roc_rising_value
498What: /sys/.../events/in_magn_z_raw_roc_falling_value
499What: /sys/.../events/in_voltageY_supply_raw_roc_rising_value
500What: /sys/.../events/in_voltageY_supply_raw_roc_falling_value
501What: /sys/.../events/in_voltageY_raw_roc_rising_value
502What: /sys/.../events/in_voltageY_raw_roc_falling_value
503What: /sys/.../events/in_tempY_raw_roc_rising_value
504What: /sys/.../events/in_tempY_raw_roc_falling_value
505KernelVersion: 2.6.37
506Contact: linux-iio@vger.kernel.org
507Description:
508 Specifies the value of rate of change threshold that the
509 device is comparing against for the events enabled by
510 <type>[Y][_name]_roc[_rising|falling]_en.
511 If separate attributes exist for the two directions,
512 but direction is not specified for this attribute,
513 then a single threshold value applies to both directions.
514 The raw or input element of the name indicates whether the
515 value is in raw device units or in processed units (as _raw
516 and _input do on sysfs direct channel read attributes).
517
518What: /sys/.../events/in_accel_x_thresh_rising_period
519What: /sys/.../events/in_accel_x_thresh_falling_period
520hat: /sys/.../events/in_accel_x_roc_rising_period
521What: /sys/.../events/in_accel_x_roc_falling_period
522What: /sys/.../events/in_accel_y_thresh_rising_period
523What: /sys/.../events/in_accel_y_thresh_falling_period
524What: /sys/.../events/in_accel_y_roc_rising_period
525What: /sys/.../events/in_accel_y_roc_falling_period
526What: /sys/.../events/in_accel_z_thresh_rising_period
527What: /sys/.../events/in_accel_z_thresh_falling_period
528What: /sys/.../events/in_accel_z_roc_rising_period
529What: /sys/.../events/in_accel_z_roc_falling_period
530What: /sys/.../events/in_anglvel_x_thresh_rising_period
531What: /sys/.../events/in_anglvel_x_thresh_falling_period
532What: /sys/.../events/in_anglvel_x_roc_rising_period
533What: /sys/.../events/in_anglvel_x_roc_falling_period
534What: /sys/.../events/in_anglvel_y_thresh_rising_period
535What: /sys/.../events/in_anglvel_y_thresh_falling_period
536What: /sys/.../events/in_anglvel_y_roc_rising_period
537What: /sys/.../events/in_anglvel_y_roc_falling_period
538What: /sys/.../events/in_anglvel_z_thresh_rising_period
539What: /sys/.../events/in_anglvel_z_thresh_falling_period
540What: /sys/.../events/in_anglvel_z_roc_rising_period
541What: /sys/.../events/in_anglvel_z_roc_falling_period
542What: /sys/.../events/in_magn_x_thresh_rising_period
543What: /sys/.../events/in_magn_x_thresh_falling_period
544What: /sys/.../events/in_magn_x_roc_rising_period
545What: /sys/.../events/in_magn_x_roc_falling_period
546What: /sys/.../events/in_magn_y_thresh_rising_period
547What: /sys/.../events/in_magn_y_thresh_falling_period
548What: /sys/.../events/in_magn_y_roc_rising_period
549What: /sys/.../events/in_magn_y_roc_falling_period
550What: /sys/.../events/in_magn_z_thresh_rising_period
551What: /sys/.../events/in_magn_z_thresh_falling_period
552What: /sys/.../events/in_magn_z_roc_rising_period
553What: /sys/.../events/in_magn_z_roc_falling_period
554What: /sys/.../events/in_voltageY_supply_thresh_rising_period
555What: /sys/.../events/in_voltageY_supply_thresh_falling_period
556What: /sys/.../events/in_voltageY_supply_roc_rising_period
557What: /sys/.../events/in_voltageY_supply_roc_falling_period
558What: /sys/.../events/in_voltageY_thresh_rising_period
559What: /sys/.../events/in_voltageY_thresh_falling_period
560What: /sys/.../events/in_voltageY_roc_rising_period
561What: /sys/.../events/in_voltageY_roc_falling_period
562What: /sys/.../events/in_tempY_thresh_rising_period
563What: /sys/.../events/in_tempY_thresh_falling_period
564What: /sys/.../events/in_tempY_roc_rising_period
565What: /sys/.../events/in_tempY_roc_falling_period
566What: /sys/.../events/in_accel_x&y&z_mag_falling_period
567What: /sys/.../events/in_intensity0_thresh_period
568What: /sys/.../events/in_proximity0_thresh_period
569KernelVersion: 2.6.37
570Contact: linux-iio@vger.kernel.org
571Description:
572 Period of time (in seconds) for which the condition must be
573 met before an event is generated. If direction is not
574 specified then this period applies to both directions.
575
576What: /sys/.../iio:deviceX/events/in_accel_mag_en
577What: /sys/.../iio:deviceX/events/in_accel_mag_rising_en
578What: /sys/.../iio:deviceX/events/in_accel_mag_falling_en
579What: /sys/.../iio:deviceX/events/in_accel_x_mag_en
580What: /sys/.../iio:deviceX/events/in_accel_x_mag_rising_en
581What: /sys/.../iio:deviceX/events/in_accel_x_mag_falling_en
582What: /sys/.../iio:deviceX/events/in_accel_y_mag_en
583What: /sys/.../iio:deviceX/events/in_accel_y_mag_rising_en
584What: /sys/.../iio:deviceX/events/in_accel_y_mag_falling_en
585What: /sys/.../iio:deviceX/events/in_accel_z_mag_en
586What: /sys/.../iio:deviceX/events/in_accel_z_mag_rising_en
587What: /sys/.../iio:deviceX/events/in_accel_z_mag_falling_en
588What: /sys/.../iio:deviceX/events/in_accel_x&y&z_mag_rising_en
589What: /sys/.../iio:deviceX/events/in_accel_x&y&z_mag_falling_en
590KernelVersion: 2.6.37
591Contact: linux-iio@vger.kernel.org
592Description:
593 Similar to in_accel_x_thresh[_rising|_falling]_en, but here the
594 magnitude of the channel is compared to the threshold, not its
595 signed value.
596
597What: /sys/.../events/in_accel_raw_mag_value
598What: /sys/.../events/in_accel_x_raw_mag_rising_value
599What: /sys/.../events/in_accel_y_raw_mag_rising_value
600What: /sys/.../events/in_accel_z_raw_mag_rising_value
601KernelVersion: 2.6.37
602Contact: linux-iio@vger.kernel.org
603Description:
604 The value to which the magnitude of the channel is compared. If
605 number or direction is not specified, applies to all channels of
606 this type.
607
608What: /sys/bus/iio/devices/iio:deviceX/trigger/current_trigger
609KernelVersion: 2.6.35
610Contact: linux-iio@vger.kernel.org
611Description:
612 The name of the trigger source being used, as per string given
613 in /sys/class/iio/triggerY/name.
614
615What: /sys/bus/iio/devices/iio:deviceX/buffer/length
616KernelVersion: 2.6.35
617Contact: linux-iio@vger.kernel.org
618Description:
619 Number of scans contained by the buffer.
620
621What: /sys/bus/iio/devices/iio:deviceX/buffer/bytes_per_datum
622KernelVersion: 2.6.37
623Contact: linux-iio@vger.kernel.org
624Description:
625 Bytes per scan. Due to alignment fun, the scan may be larger
626 than implied directly by the scan_element parameters.
627
628What: /sys/bus/iio/devices/iio:deviceX/buffer/enable
629KernelVersion: 2.6.35
630Contact: linux-iio@vger.kernel.org
631Description:
632 Actually start the buffer capture up. Will start trigger
633 if first device and appropriate.
634
635What: /sys/bus/iio/devices/iio:deviceX/buffer/scan_elements
636KernelVersion: 2.6.37
637Contact: linux-iio@vger.kernel.org
638Description:
639 Directory containing interfaces for elements that will be
640 captured for a single triggered sample set in the buffer.
641
642What: /sys/.../buffer/scan_elements/in_accel_x_en
643What: /sys/.../buffer/scan_elements/in_accel_y_en
644What: /sys/.../buffer/scan_elements/in_accel_z_en
645What: /sys/.../buffer/scan_elements/in_anglvel_x_en
646What: /sys/.../buffer/scan_elements/in_anglvel_y_en
647What: /sys/.../buffer/scan_elements/in_anglvel_z_en
648What: /sys/.../buffer/scan_elements/in_magn_x_en
649What: /sys/.../buffer/scan_elements/in_magn_y_en
650What: /sys/.../buffer/scan_elements/in_magn_z_en
651What: /sys/.../buffer/scan_elements/in_timestamp_en
652What: /sys/.../buffer/scan_elements/in_voltageY_supply_en
653What: /sys/.../buffer/scan_elements/in_voltageY_en
654What: /sys/.../buffer/scan_elements/in_voltageY-voltageZ_en
655What: /sys/.../buffer/scan_elements/in_incli_x_en
656What: /sys/.../buffer/scan_elements/in_incli_y_en
657KernelVersion: 2.6.37
658Contact: linux-iio@vger.kernel.org
659Description:
660 Scan element control for triggered data capture.
661
662What: /sys/.../buffer/scan_elements/in_accel_type
663What: /sys/.../buffer/scan_elements/in_anglvel_type
664What: /sys/.../buffer/scan_elements/in_magn_type
665What: /sys/.../buffer/scan_elements/in_incli_type
666What: /sys/.../buffer/scan_elements/in_voltageY_type
667What: /sys/.../buffer/scan_elements/in_voltage-in_type
668What: /sys/.../buffer/scan_elements/in_voltageY_supply_type
669What: /sys/.../buffer/scan_elements/in_timestamp_type
670KernelVersion: 2.6.37
671Contact: linux-iio@vger.kernel.org
672Description:
673 Description of the scan element data storage within the buffer
674 and hence the form in which it is read from user-space.
675 Form is [be|le]:[s|u]bits/storagebits[>>shift].
676 be or le specifies big or little endian. s or u specifies if
677 signed (2's complement) or unsigned. bits is the number of bits
678 of data and storagebits is the space (after padding) that it
679 occupies in the buffer. shift if specified, is the shift that
680 needs to be applied prior to masking out unused bits. Some
681 devices put their data in the middle of the transferred elements
682 with additional information on both sides. Note that some
683 devices will have additional information in the unused bits
684 so to get a clean value, the bits value must be used to mask
685 the buffer output value appropriately. The storagebits value
686 also specifies the data alignment. So s48/64>>2 will be a
687 signed 48 bit integer stored in a 64 bit location aligned to
688 a a64 bit boundary. To obtain the clean value, shift right 2
689 and apply a mask to zero the top 16 bits of the result.
690 For other storage combinations this attribute will be extended
691 appropriately.
692
693What: /sys/.../buffer/scan_elements/in_accel_type_available
694KernelVersion: 2.6.37
695Contact: linux-iio@vger.kernel.org
696Description:
697 If the type parameter can take one of a small set of values,
698 this attribute lists them.
699
700What: /sys/.../buffer/scan_elements/in_voltageY_index
701What: /sys/.../buffer/scan_elements/in_voltageY_supply_index
702What: /sys/.../buffer/scan_elements/in_accel_x_index
703What: /sys/.../buffer/scan_elements/in_accel_y_index
704What: /sys/.../buffer/scan_elements/in_accel_z_index
705What: /sys/.../buffer/scan_elements/in_anglvel_x_index
706What: /sys/.../buffer/scan_elements/in_anglvel_y_index
707What: /sys/.../buffer/scan_elements/in_anglvel_z_index
708What: /sys/.../buffer/scan_elements/in_magn_x_index
709What: /sys/.../buffer/scan_elements/in_magn_y_index
710What: /sys/.../buffer/scan_elements/in_magn_z_index
711What: /sys/.../buffer/scan_elements/in_incli_x_index
712What: /sys/.../buffer/scan_elements/in_incli_y_index
713What: /sys/.../buffer/scan_elements/in_timestamp_index
714KernelVersion: 2.6.37
715Contact: linux-iio@vger.kernel.org
716Description:
717 A single positive integer specifying the position of this
718 scan element in the buffer. Note these are not dependent on
719 what is enabled and may not be contiguous. Thus for user-space
720 to establish the full layout these must be used in conjunction
721 with all _en attributes to establish which channels are present,
722 and the relevant _type attributes to establish the data storage
723 format.
724
725What: /sys/.../iio:deviceX/in_anglvel_z_quadrature_correction_raw
726KernelVersion: 2.6.38
727Contact: linux-iio@vger.kernel.org
728Description:
729 This attribute is used to read the amount of quadrature error
730 present in the device at a given time.