diff options
author | Jonathan Cameron <jic23@kernel.org> | 2012-04-25 10:55:00 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2012-04-25 14:12:23 -0400 |
commit | 8af2c75a328355c23d68d3f8651ad52af3c7979d (patch) | |
tree | 6e4a516128262ac43b19d4ae5a9c88afb2648b68 /Documentation/ABI | |
parent | a980e046098b0a40eaff5e4e7fcde6cf035b7c06 (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-iio | 730 |
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 @@ | |||
1 | What: /sys/bus/iio/devices/iio:deviceX | ||
2 | KernelVersion: 2.6.35 | ||
3 | Contact: linux-iio@vger.kernel.org | ||
4 | Description: | ||
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 | |||
9 | What: /sys/bus/iio/devices/triggerX | ||
10 | KernelVersion: 2.6.35 | ||
11 | Contact: linux-iio@vger.kernel.org | ||
12 | Description: | ||
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 | |||
22 | What: /sys/bus/iio/devices/iio:deviceX/buffer | ||
23 | KernelVersion: 2.6.35 | ||
24 | Contact: linux-iio@vger.kernel.org | ||
25 | Description: | ||
26 | Directory of attributes relating to the buffer for the device. | ||
27 | |||
28 | What: /sys/bus/iio/devices/iio:deviceX/name | ||
29 | KernelVersion: 2.6.35 | ||
30 | Contact: linux-iio@vger.kernel.org | ||
31 | Description: | ||
32 | Description of the physical chip / device for device X. | ||
33 | Typically a part number. | ||
34 | |||
35 | What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency | ||
36 | What: /sys/bus/iio/devices/iio:deviceX/buffer/sampling_frequency | ||
37 | What: /sys/bus/iio/devices/triggerX/sampling_frequency | ||
38 | KernelVersion: 2.6.35 | ||
39 | Contact: linux-iio@vger.kernel.org | ||
40 | Description: | ||
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 | |||
50 | What: /sys/bus/iio/devices/iio:deviceX/sampling_frequency_available | ||
51 | What: /sys/.../iio:deviceX/buffer/sampling_frequency_available | ||
52 | What: /sys/bus/iio/devices/triggerX/sampling_frequency_available | ||
53 | KernelVersion: 2.6.35 | ||
54 | Contact: linux-iio@vger.kernel.org | ||
55 | Description: | ||
56 | When the internal sampling clock can only take a small | ||
57 | discrete set of values, this file lists those available. | ||
58 | |||
59 | What: /sys/bus/iio/devices/iio:deviceX/oversampling_ratio | ||
60 | KernelVersion: 2.6.38 | ||
61 | Contact: linux-iio@vger.kernel.org | ||
62 | Description: | ||
63 | Hardware dependent ADC oversampling. Controls the sampling ratio | ||
64 | of the digital filter if available. | ||
65 | |||
66 | What: /sys/bus/iio/devices/iio:deviceX/oversampling_ratio_available | ||
67 | KernelVersion: 2.6.38 | ||
68 | Contact: linux-iio@vger.kernel.org | ||
69 | Description: | ||
70 | Hardware dependent values supported by the oversampling filter. | ||
71 | |||
72 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_raw | ||
73 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_raw | ||
74 | KernelVersion: 2.6.35 | ||
75 | Contact: linux-iio@vger.kernel.org | ||
76 | Description: | ||
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 | |||
84 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_raw | ||
85 | KernelVersion: 2.6.35 | ||
86 | Contact: linux-iio@vger.kernel.org | ||
87 | Description: | ||
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 | |||
95 | What: /sys/bus/iio/devices/iio:deviceX/in_capacitanceY_raw | ||
96 | KernelVersion: 3.2 | ||
97 | Contact: linux-iio@vger.kernel.org | ||
98 | Description: | ||
99 | Raw capacitance measurement from channel Y. Units after | ||
100 | application of scale and offset are nanofarads. | ||
101 | |||
102 | What: /sys/.../iio:deviceX/in_capacitanceY-in_capacitanceZ_raw | ||
103 | KernelVersion: 3.2 | ||
104 | Contact: linux-iio@vger.kernel.org | ||
105 | Description: | ||
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 | |||
113 | What: /sys/bus/iio/devices/iio:deviceX/in_temp_raw | ||
114 | What: /sys/bus/iio/devices/iio:deviceX/in_tempX_raw | ||
115 | What: /sys/bus/iio/devices/iio:deviceX/in_temp_x_raw | ||
116 | What: /sys/bus/iio/devices/iio:deviceX/in_temp_y_raw | ||
117 | What: /sys/bus/iio/devices/iio:deviceX/in_temp_z_raw | ||
118 | KernelVersion: 2.6.35 | ||
119 | Contact: linux-iio@vger.kernel.org | ||
120 | Description: | ||
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 | |||
127 | What: /sys/bus/iio/devices/iio:deviceX/in_tempX_input | ||
128 | KernelVersion: 2.6.38 | ||
129 | Contact: linux-iio@vger.kernel.org | ||
130 | Description: | ||
131 | Scaled temperature measurement in milli degrees Celsius. | ||
132 | |||
133 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_raw | ||
134 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_raw | ||
135 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_raw | ||
136 | KernelVersion: 2.6.35 | ||
137 | Contact: linux-iio@vger.kernel.org | ||
138 | Description: | ||
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 | |||
144 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_raw | ||
145 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_raw | ||
146 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_raw | ||
147 | KernelVersion: 2.6.35 | ||
148 | Contact: linux-iio@vger.kernel.org | ||
149 | Description: | ||
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 | |||
156 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_x_raw | ||
157 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_y_raw | ||
158 | What: /sys/bus/iio/devices/iio:deviceX/in_incli_z_raw | ||
159 | KernelVersion: 2.6.35 | ||
160 | Contact: linux-iio@vger.kernel.org | ||
161 | Description: | ||
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 | |||
166 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_raw | ||
167 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_raw | ||
168 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_raw | ||
169 | KernelVersion: 2.6.35 | ||
170 | Contact: linux-iio@vger.kernel.org | ||
171 | Description: | ||
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 | |||
176 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_peak_raw | ||
177 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_peak_raw | ||
178 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_peak_raw | ||
179 | KernelVersion: 2.6.36 | ||
180 | Contact: linux-iio@vger.kernel.org | ||
181 | Description: | ||
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 | |||
186 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_xyz_squared_peak_raw | ||
187 | KernelVersion: 2.6.36 | ||
188 | Contact: linux-iio@vger.kernel.org | ||
189 | Description: | ||
190 | A computed peak value based on the sum squared magnitude of | ||
191 | the underlying value in the specified directions. | ||
192 | |||
193 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_offset | ||
194 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_offset | ||
195 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_offset | ||
196 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_offset | ||
197 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_offset | ||
198 | What: /sys/bus/iio/devices/iio:deviceX/in_voltage_offset | ||
199 | What: /sys/bus/iio/devices/iio:deviceX/in_tempY_offset | ||
200 | What: /sys/bus/iio/devices/iio:deviceX/in_temp_offset | ||
201 | KernelVersion: 2.6.35 | ||
202 | Contact: linux-iio@vger.kernel.org | ||
203 | Description: | ||
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 | |||
218 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_scale | ||
219 | What: /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_scale | ||
220 | What: /sys/bus/iio/devices/iio:deviceX/in_voltage_scale | ||
221 | What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_scale | ||
222 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_scale | ||
223 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_peak_scale | ||
224 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_scale | ||
225 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_scale | ||
226 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_x_scale | ||
227 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_y_scale | ||
228 | What: /sys/bus/iio/devices/iio:deviceX/in_magn_z_scale | ||
229 | KernelVersion: 2.6.35 | ||
230 | Contact: linux-iio@vger.kernel.org | ||
231 | Description: | ||
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 | |||
240 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibbias | ||
241 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibbias | ||
242 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibbias | ||
243 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibbias | ||
244 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibbias | ||
245 | What: /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibbias | ||
246 | What: /sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibbias | ||
247 | What: /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibbias | ||
248 | KernelVersion: 2.6.35 | ||
249 | Contact: linux-iio@vger.kernel.org | ||
250 | Description: | ||
251 | Hardware applied calibration offset. (assumed to fix production | ||
252 | inaccuracies). | ||
253 | |||
254 | What /sys/bus/iio/devices/iio:deviceX/in_voltageY_calibscale | ||
255 | What /sys/bus/iio/devices/iio:deviceX/in_voltageY_supply_calibscale | ||
256 | What /sys/bus/iio/devices/iio:deviceX/in_voltage_calibscale | ||
257 | What /sys/bus/iio/devices/iio:deviceX/in_accel_x_calibscale | ||
258 | What /sys/bus/iio/devices/iio:deviceX/in_accel_y_calibscale | ||
259 | What /sys/bus/iio/devices/iio:deviceX/in_accel_z_calibscale | ||
260 | What /sys/bus/iio/devices/iio:deviceX/in_anglvel_x_calibscale | ||
261 | What /sys/bus/iio/devices/iio:deviceX/in_anglvel_y_calibscale | ||
262 | What /sys/bus/iio/devices/iio:deviceX/in_anglvel_z_calibscale | ||
263 | what /sys/bus/iio/devices/iio:deviceX/in_illuminance0_calibscale | ||
264 | what /sys/bus/iio/devices/iio:deviceX/in_proximity0_calibscale | ||
265 | KernelVersion: 2.6.35 | ||
266 | Contact: linux-iio@vger.kernel.org | ||
267 | Description: | ||
268 | Hardware applied calibration scale factor. (assumed to fix | ||
269 | production inaccuracies). If shared across all channels, | ||
270 | <type>_calibscale is used. | ||
271 | |||
272 | What: /sys/bus/iio/devices/iio:deviceX/in_accel_scale_available | ||
273 | What: /sys/.../iio:deviceX/in_voltageX_scale_available | ||
274 | What: /sys/.../iio:deviceX/in_voltage-voltage_scale_available | ||
275 | What: /sys/.../iio:deviceX/out_voltageX_scale_available | ||
276 | What: /sys/.../iio:deviceX/in_capacitance_scale_available | ||
277 | KernelVersion: 2.635 | ||
278 | Contact: linux-iio@vger.kernel.org | ||
279 | Description: | ||
280 | If a discrete set of scale values are available, they | ||
281 | are listed in this attribute. | ||
282 | |||
283 | What: /sys/.../in_accel_filter_low_pass_3db_frequency | ||
284 | What: /sys/.../in_magn_filter_low_pass_3db_frequency | ||
285 | What: /sys/.../in_anglvel_filter_low_pass_3db_frequency | ||
286 | KernelVersion: 3.2 | ||
287 | Contact: linux-iio@vger.kernel.org | ||
288 | Description: | ||
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 | |||
293 | What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_raw | ||
294 | KernelVersion: 2.6.37 | ||
295 | Contact: linux-iio@vger.kernel.org | ||
296 | Description: | ||
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 | |||
301 | What: /sys/bus/iio/devices/iio:deviceX/out_voltageY&Z_raw | ||
302 | KernelVersion: 2.6.37 | ||
303 | Contact: linux-iio@vger.kernel.org | ||
304 | Description: | ||
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 | |||
310 | What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown_mode | ||
311 | What: /sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown_mode | ||
312 | KernelVersion: 2.6.38 | ||
313 | Contact: linux-iio@vger.kernel.org | ||
314 | Description: | ||
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 | |||
324 | What: /sys/.../iio:deviceX/out_votlageY_powerdown_mode_available | ||
325 | What: /sys/.../iio:deviceX/out_voltage_powerdown_mode_available | ||
326 | KernelVersion: 2.6.38 | ||
327 | Contact: linux-iio@vger.kernel.org | ||
328 | Description: | ||
329 | Lists all available output power down modes. | ||
330 | If Y is not present the mode is shared across all outputs. | ||
331 | |||
332 | What: /sys/bus/iio/devices/iio:deviceX/out_voltageY_powerdown | ||
333 | What: /sys/bus/iio/devices/iio:deviceX/out_voltage_powerdown | ||
334 | KernelVersion: 2.6.38 | ||
335 | Contact: linux-iio@vger.kernel.org | ||
336 | Description: | ||
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 | |||
342 | What: /sys/bus/iio/devices/iio:deviceX/events | ||
343 | KernelVersion: 2.6.35 | ||
344 | Contact: linux-iio@vger.kernel.org | ||
345 | Description: | ||
346 | Configuration of which hardware generated events are passed up | ||
347 | to user-space. | ||
348 | |||
349 | What: /sys/.../iio:deviceX/events/in_accel_x_thresh_rising_en | ||
350 | What: /sys/.../iio:deviceX/events/in_accel_x_thresh_falling_en | ||
351 | What: /sys/.../iio:deviceX/events/in_accel_y_thresh_rising_en | ||
352 | What: /sys/.../iio:deviceX/events/in_accel_y_thresh_falling_en | ||
353 | What: /sys/.../iio:deviceX/events/in_accel_z_thresh_rising_en | ||
354 | What: /sys/.../iio:deviceX/events/in_accel_z_thresh_falling_en | ||
355 | What: /sys/.../iio:deviceX/events/in_anglvel_x_thresh_rising_en | ||
356 | What: /sys/.../iio:deviceX/events/in_anglvel_x_thresh_falling_en | ||
357 | What: /sys/.../iio:deviceX/events/in_anglvel_y_thresh_rising_en | ||
358 | What: /sys/.../iio:deviceX/events/in_anglvel_y_thresh_falling_en | ||
359 | What: /sys/.../iio:deviceX/events/in_anglvel_z_thresh_rising_en | ||
360 | What: /sys/.../iio:deviceX/events/in_anglvel_z_thresh_falling_en | ||
361 | What: /sys/.../iio:deviceX/events/in_magn_x_thresh_rising_en | ||
362 | What: /sys/.../iio:deviceX/events/in_magn_x_thresh_falling_en | ||
363 | What: /sys/.../iio:deviceX/events/in_magn_y_thresh_rising_en | ||
364 | What: /sys/.../iio:deviceX/events/in_magn_y_thresh_falling_en | ||
365 | What: /sys/.../iio:deviceX/events/in_magn_z_thresh_rising_en | ||
366 | What: /sys/.../iio:deviceX/events/in_magn_z_thresh_falling_en | ||
367 | What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_rising_en | ||
368 | What: /sys/.../iio:deviceX/events/in_voltageY_supply_thresh_falling_en | ||
369 | What: /sys/.../iio:deviceX/events/in_voltageY_thresh_rising_en | ||
370 | What: /sys/.../iio:deviceX/events/in_voltageY_thresh_falling_en | ||
371 | What: /sys/.../iio:deviceX/events/in_tempY_thresh_rising_en | ||
372 | What: /sys/.../iio:deviceX/events/in_tempY_thresh_falling_en | ||
373 | KernelVersion: 2.6.37 | ||
374 | Contact: linux-iio@vger.kernel.org | ||
375 | Description: | ||
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 | |||
394 | What: /sys/.../iio:deviceX/events/in_accel_x_roc_rising_en | ||
395 | What: /sys/.../iio:deviceX/events/in_accel_x_roc_falling_en | ||
396 | What: /sys/.../iio:deviceX/events/in_accel_y_roc_rising_en | ||
397 | What: /sys/.../iio:deviceX/events/in_accel_y_roc_falling_en | ||
398 | What: /sys/.../iio:deviceX/events/in_accel_z_roc_rising_en | ||
399 | What: /sys/.../iio:deviceX/events/in_accel_z_roc_falling_en | ||
400 | What: /sys/.../iio:deviceX/events/in_anglvel_x_roc_rising_en | ||
401 | What: /sys/.../iio:deviceX/events/in_anglvel_x_roc_falling_en | ||
402 | What: /sys/.../iio:deviceX/events/in_anglvel_y_roc_rising_en | ||
403 | What: /sys/.../iio:deviceX/events/in_anglvel_y_roc_falling_en | ||
404 | What: /sys/.../iio:deviceX/events/in_anglvel_z_roc_rising_en | ||
405 | What: /sys/.../iio:deviceX/events/in_anglvel_z_roc_falling_en | ||
406 | What: /sys/.../iio:deviceX/events/in_magn_x_roc_rising_en | ||
407 | What: /sys/.../iio:deviceX/events/in_magn_x_roc_falling_en | ||
408 | What: /sys/.../iio:deviceX/events/in_magn_y_roc_rising_en | ||
409 | What: /sys/.../iio:deviceX/events/in_magn_y_roc_falling_en | ||
410 | What: /sys/.../iio:deviceX/events/in_magn_z_roc_rising_en | ||
411 | What: /sys/.../iio:deviceX/events/in_magn_z_roc_falling_en | ||
412 | What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_rising_en | ||
413 | What: /sys/.../iio:deviceX/events/in_voltageY_supply_roc_falling_en | ||
414 | What: /sys/.../iio:deviceX/events/in_voltageY_roc_rising_en | ||
415 | What: /sys/.../iio:deviceX/events/in_voltageY_roc_falling_en | ||
416 | What: /sys/.../iio:deviceX/events/in_tempY_roc_rising_en | ||
417 | What: /sys/.../iio:deviceX/events/in_tempY_roc_falling_en | ||
418 | KernelVersion: 2.6.37 | ||
419 | Contact: linux-iio@vger.kernel.org | ||
420 | Description: | ||
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 | |||
440 | What: /sys/.../events/in_accel_x_raw_thresh_rising_value | ||
441 | What: /sys/.../events/in_accel_x_raw_thresh_falling_value | ||
442 | What: /sys/.../events/in_accel_y_raw_thresh_rising_value | ||
443 | What: /sys/.../events/in_accel_y_raw_thresh_falling_value | ||
444 | What: /sys/.../events/in_accel_z_raw_thresh_rising_value | ||
445 | What: /sys/.../events/in_accel_z_raw_thresh_falling_value | ||
446 | What: /sys/.../events/in_anglvel_x_raw_thresh_rising_value | ||
447 | What: /sys/.../events/in_anglvel_x_raw_thresh_falling_value | ||
448 | What: /sys/.../events/in_anglvel_y_raw_thresh_rising_value | ||
449 | What: /sys/.../events/in_anglvel_y_raw_thresh_falling_value | ||
450 | What: /sys/.../events/in_anglvel_z_raw_thresh_rising_value | ||
451 | What: /sys/.../events/in_anglvel_z_raw_thresh_falling_value | ||
452 | What: /sys/.../events/in_magn_x_raw_thresh_rising_value | ||
453 | What: /sys/.../events/in_magn_x_raw_thresh_falling_value | ||
454 | What: /sys/.../events/in_magn_y_raw_thresh_rising_value | ||
455 | What: /sys/.../events/in_magn_y_raw_thresh_falling_value | ||
456 | What: /sys/.../events/in_magn_z_raw_thresh_rising_value | ||
457 | What: /sys/.../events/in_magn_z_raw_thresh_falling_value | ||
458 | What: /sys/.../events/in_voltageY_supply_raw_thresh_rising_value | ||
459 | What: /sys/.../events/in_voltageY_supply_raw_thresh_falling_value | ||
460 | What: /sys/.../events/in_voltageY_raw_thresh_rising_value | ||
461 | What: /sys/.../events/in_voltageY_raw_thresh_falling_value | ||
462 | What: /sys/.../events/in_tempY_raw_thresh_rising_value | ||
463 | What: /sys/.../events/in_tempY_raw_thresh_falling_value | ||
464 | What: /sys/.../events/in_illuminance0_thresh_falling_value | ||
465 | what: /sys/.../events/in_illuminance0_thresh_rising_value | ||
466 | what: /sys/.../events/in_proximity0_thresh_falling_value | ||
467 | what: /sys/.../events/in_proximity0_thresh_rising_value | ||
468 | KernelVersion: 2.6.37 | ||
469 | Contact: linux-iio@vger.kernel.org | ||
470 | Description: | ||
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 | |||
481 | What: /sys/.../events/in_accel_x_raw_roc_rising_value | ||
482 | What: /sys/.../events/in_accel_x_raw_roc_falling_value | ||
483 | What: /sys/.../events/in_accel_y_raw_roc_rising_value | ||
484 | What: /sys/.../events/in_accel_y_raw_roc_falling_value | ||
485 | What: /sys/.../events/in_accel_z_raw_roc_rising_value | ||
486 | What: /sys/.../events/in_accel_z_raw_roc_falling_value | ||
487 | What: /sys/.../events/in_anglvel_x_raw_roc_rising_value | ||
488 | What: /sys/.../events/in_anglvel_x_raw_roc_falling_value | ||
489 | What: /sys/.../events/in_anglvel_y_raw_roc_rising_value | ||
490 | What: /sys/.../events/in_anglvel_y_raw_roc_falling_value | ||
491 | What: /sys/.../events/in_anglvel_z_raw_roc_rising_value | ||
492 | What: /sys/.../events/in_anglvel_z_raw_roc_falling_value | ||
493 | What: /sys/.../events/in_magn_x_raw_roc_rising_value | ||
494 | What: /sys/.../events/in_magn_x_raw_roc_falling_value | ||
495 | What: /sys/.../events/in_magn_y_raw_roc_rising_value | ||
496 | What: /sys/.../events/in_magn_y_raw_roc_falling_value | ||
497 | What: /sys/.../events/in_magn_z_raw_roc_rising_value | ||
498 | What: /sys/.../events/in_magn_z_raw_roc_falling_value | ||
499 | What: /sys/.../events/in_voltageY_supply_raw_roc_rising_value | ||
500 | What: /sys/.../events/in_voltageY_supply_raw_roc_falling_value | ||
501 | What: /sys/.../events/in_voltageY_raw_roc_rising_value | ||
502 | What: /sys/.../events/in_voltageY_raw_roc_falling_value | ||
503 | What: /sys/.../events/in_tempY_raw_roc_rising_value | ||
504 | What: /sys/.../events/in_tempY_raw_roc_falling_value | ||
505 | KernelVersion: 2.6.37 | ||
506 | Contact: linux-iio@vger.kernel.org | ||
507 | Description: | ||
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 | |||
518 | What: /sys/.../events/in_accel_x_thresh_rising_period | ||
519 | What: /sys/.../events/in_accel_x_thresh_falling_period | ||
520 | hat: /sys/.../events/in_accel_x_roc_rising_period | ||
521 | What: /sys/.../events/in_accel_x_roc_falling_period | ||
522 | What: /sys/.../events/in_accel_y_thresh_rising_period | ||
523 | What: /sys/.../events/in_accel_y_thresh_falling_period | ||
524 | What: /sys/.../events/in_accel_y_roc_rising_period | ||
525 | What: /sys/.../events/in_accel_y_roc_falling_period | ||
526 | What: /sys/.../events/in_accel_z_thresh_rising_period | ||
527 | What: /sys/.../events/in_accel_z_thresh_falling_period | ||
528 | What: /sys/.../events/in_accel_z_roc_rising_period | ||
529 | What: /sys/.../events/in_accel_z_roc_falling_period | ||
530 | What: /sys/.../events/in_anglvel_x_thresh_rising_period | ||
531 | What: /sys/.../events/in_anglvel_x_thresh_falling_period | ||
532 | What: /sys/.../events/in_anglvel_x_roc_rising_period | ||
533 | What: /sys/.../events/in_anglvel_x_roc_falling_period | ||
534 | What: /sys/.../events/in_anglvel_y_thresh_rising_period | ||
535 | What: /sys/.../events/in_anglvel_y_thresh_falling_period | ||
536 | What: /sys/.../events/in_anglvel_y_roc_rising_period | ||
537 | What: /sys/.../events/in_anglvel_y_roc_falling_period | ||
538 | What: /sys/.../events/in_anglvel_z_thresh_rising_period | ||
539 | What: /sys/.../events/in_anglvel_z_thresh_falling_period | ||
540 | What: /sys/.../events/in_anglvel_z_roc_rising_period | ||
541 | What: /sys/.../events/in_anglvel_z_roc_falling_period | ||
542 | What: /sys/.../events/in_magn_x_thresh_rising_period | ||
543 | What: /sys/.../events/in_magn_x_thresh_falling_period | ||
544 | What: /sys/.../events/in_magn_x_roc_rising_period | ||
545 | What: /sys/.../events/in_magn_x_roc_falling_period | ||
546 | What: /sys/.../events/in_magn_y_thresh_rising_period | ||
547 | What: /sys/.../events/in_magn_y_thresh_falling_period | ||
548 | What: /sys/.../events/in_magn_y_roc_rising_period | ||
549 | What: /sys/.../events/in_magn_y_roc_falling_period | ||
550 | What: /sys/.../events/in_magn_z_thresh_rising_period | ||
551 | What: /sys/.../events/in_magn_z_thresh_falling_period | ||
552 | What: /sys/.../events/in_magn_z_roc_rising_period | ||
553 | What: /sys/.../events/in_magn_z_roc_falling_period | ||
554 | What: /sys/.../events/in_voltageY_supply_thresh_rising_period | ||
555 | What: /sys/.../events/in_voltageY_supply_thresh_falling_period | ||
556 | What: /sys/.../events/in_voltageY_supply_roc_rising_period | ||
557 | What: /sys/.../events/in_voltageY_supply_roc_falling_period | ||
558 | What: /sys/.../events/in_voltageY_thresh_rising_period | ||
559 | What: /sys/.../events/in_voltageY_thresh_falling_period | ||
560 | What: /sys/.../events/in_voltageY_roc_rising_period | ||
561 | What: /sys/.../events/in_voltageY_roc_falling_period | ||
562 | What: /sys/.../events/in_tempY_thresh_rising_period | ||
563 | What: /sys/.../events/in_tempY_thresh_falling_period | ||
564 | What: /sys/.../events/in_tempY_roc_rising_period | ||
565 | What: /sys/.../events/in_tempY_roc_falling_period | ||
566 | What: /sys/.../events/in_accel_x&y&z_mag_falling_period | ||
567 | What: /sys/.../events/in_intensity0_thresh_period | ||
568 | What: /sys/.../events/in_proximity0_thresh_period | ||
569 | KernelVersion: 2.6.37 | ||
570 | Contact: linux-iio@vger.kernel.org | ||
571 | Description: | ||
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 | |||
576 | What: /sys/.../iio:deviceX/events/in_accel_mag_en | ||
577 | What: /sys/.../iio:deviceX/events/in_accel_mag_rising_en | ||
578 | What: /sys/.../iio:deviceX/events/in_accel_mag_falling_en | ||
579 | What: /sys/.../iio:deviceX/events/in_accel_x_mag_en | ||
580 | What: /sys/.../iio:deviceX/events/in_accel_x_mag_rising_en | ||
581 | What: /sys/.../iio:deviceX/events/in_accel_x_mag_falling_en | ||
582 | What: /sys/.../iio:deviceX/events/in_accel_y_mag_en | ||
583 | What: /sys/.../iio:deviceX/events/in_accel_y_mag_rising_en | ||
584 | What: /sys/.../iio:deviceX/events/in_accel_y_mag_falling_en | ||
585 | What: /sys/.../iio:deviceX/events/in_accel_z_mag_en | ||
586 | What: /sys/.../iio:deviceX/events/in_accel_z_mag_rising_en | ||
587 | What: /sys/.../iio:deviceX/events/in_accel_z_mag_falling_en | ||
588 | What: /sys/.../iio:deviceX/events/in_accel_x&y&z_mag_rising_en | ||
589 | What: /sys/.../iio:deviceX/events/in_accel_x&y&z_mag_falling_en | ||
590 | KernelVersion: 2.6.37 | ||
591 | Contact: linux-iio@vger.kernel.org | ||
592 | Description: | ||
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 | |||
597 | What: /sys/.../events/in_accel_raw_mag_value | ||
598 | What: /sys/.../events/in_accel_x_raw_mag_rising_value | ||
599 | What: /sys/.../events/in_accel_y_raw_mag_rising_value | ||
600 | What: /sys/.../events/in_accel_z_raw_mag_rising_value | ||
601 | KernelVersion: 2.6.37 | ||
602 | Contact: linux-iio@vger.kernel.org | ||
603 | Description: | ||
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 | |||
608 | What: /sys/bus/iio/devices/iio:deviceX/trigger/current_trigger | ||
609 | KernelVersion: 2.6.35 | ||
610 | Contact: linux-iio@vger.kernel.org | ||
611 | Description: | ||
612 | The name of the trigger source being used, as per string given | ||
613 | in /sys/class/iio/triggerY/name. | ||
614 | |||
615 | What: /sys/bus/iio/devices/iio:deviceX/buffer/length | ||
616 | KernelVersion: 2.6.35 | ||
617 | Contact: linux-iio@vger.kernel.org | ||
618 | Description: | ||
619 | Number of scans contained by the buffer. | ||
620 | |||
621 | What: /sys/bus/iio/devices/iio:deviceX/buffer/bytes_per_datum | ||
622 | KernelVersion: 2.6.37 | ||
623 | Contact: linux-iio@vger.kernel.org | ||
624 | Description: | ||
625 | Bytes per scan. Due to alignment fun, the scan may be larger | ||
626 | than implied directly by the scan_element parameters. | ||
627 | |||
628 | What: /sys/bus/iio/devices/iio:deviceX/buffer/enable | ||
629 | KernelVersion: 2.6.35 | ||
630 | Contact: linux-iio@vger.kernel.org | ||
631 | Description: | ||
632 | Actually start the buffer capture up. Will start trigger | ||
633 | if first device and appropriate. | ||
634 | |||
635 | What: /sys/bus/iio/devices/iio:deviceX/buffer/scan_elements | ||
636 | KernelVersion: 2.6.37 | ||
637 | Contact: linux-iio@vger.kernel.org | ||
638 | Description: | ||
639 | Directory containing interfaces for elements that will be | ||
640 | captured for a single triggered sample set in the buffer. | ||
641 | |||
642 | What: /sys/.../buffer/scan_elements/in_accel_x_en | ||
643 | What: /sys/.../buffer/scan_elements/in_accel_y_en | ||
644 | What: /sys/.../buffer/scan_elements/in_accel_z_en | ||
645 | What: /sys/.../buffer/scan_elements/in_anglvel_x_en | ||
646 | What: /sys/.../buffer/scan_elements/in_anglvel_y_en | ||
647 | What: /sys/.../buffer/scan_elements/in_anglvel_z_en | ||
648 | What: /sys/.../buffer/scan_elements/in_magn_x_en | ||
649 | What: /sys/.../buffer/scan_elements/in_magn_y_en | ||
650 | What: /sys/.../buffer/scan_elements/in_magn_z_en | ||
651 | What: /sys/.../buffer/scan_elements/in_timestamp_en | ||
652 | What: /sys/.../buffer/scan_elements/in_voltageY_supply_en | ||
653 | What: /sys/.../buffer/scan_elements/in_voltageY_en | ||
654 | What: /sys/.../buffer/scan_elements/in_voltageY-voltageZ_en | ||
655 | What: /sys/.../buffer/scan_elements/in_incli_x_en | ||
656 | What: /sys/.../buffer/scan_elements/in_incli_y_en | ||
657 | KernelVersion: 2.6.37 | ||
658 | Contact: linux-iio@vger.kernel.org | ||
659 | Description: | ||
660 | Scan element control for triggered data capture. | ||
661 | |||
662 | What: /sys/.../buffer/scan_elements/in_accel_type | ||
663 | What: /sys/.../buffer/scan_elements/in_anglvel_type | ||
664 | What: /sys/.../buffer/scan_elements/in_magn_type | ||
665 | What: /sys/.../buffer/scan_elements/in_incli_type | ||
666 | What: /sys/.../buffer/scan_elements/in_voltageY_type | ||
667 | What: /sys/.../buffer/scan_elements/in_voltage-in_type | ||
668 | What: /sys/.../buffer/scan_elements/in_voltageY_supply_type | ||
669 | What: /sys/.../buffer/scan_elements/in_timestamp_type | ||
670 | KernelVersion: 2.6.37 | ||
671 | Contact: linux-iio@vger.kernel.org | ||
672 | Description: | ||
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 | |||
693 | What: /sys/.../buffer/scan_elements/in_accel_type_available | ||
694 | KernelVersion: 2.6.37 | ||
695 | Contact: linux-iio@vger.kernel.org | ||
696 | Description: | ||
697 | If the type parameter can take one of a small set of values, | ||
698 | this attribute lists them. | ||
699 | |||
700 | What: /sys/.../buffer/scan_elements/in_voltageY_index | ||
701 | What: /sys/.../buffer/scan_elements/in_voltageY_supply_index | ||
702 | What: /sys/.../buffer/scan_elements/in_accel_x_index | ||
703 | What: /sys/.../buffer/scan_elements/in_accel_y_index | ||
704 | What: /sys/.../buffer/scan_elements/in_accel_z_index | ||
705 | What: /sys/.../buffer/scan_elements/in_anglvel_x_index | ||
706 | What: /sys/.../buffer/scan_elements/in_anglvel_y_index | ||
707 | What: /sys/.../buffer/scan_elements/in_anglvel_z_index | ||
708 | What: /sys/.../buffer/scan_elements/in_magn_x_index | ||
709 | What: /sys/.../buffer/scan_elements/in_magn_y_index | ||
710 | What: /sys/.../buffer/scan_elements/in_magn_z_index | ||
711 | What: /sys/.../buffer/scan_elements/in_incli_x_index | ||
712 | What: /sys/.../buffer/scan_elements/in_incli_y_index | ||
713 | What: /sys/.../buffer/scan_elements/in_timestamp_index | ||
714 | KernelVersion: 2.6.37 | ||
715 | Contact: linux-iio@vger.kernel.org | ||
716 | Description: | ||
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 | |||
725 | What: /sys/.../iio:deviceX/in_anglvel_z_quadrature_correction_raw | ||
726 | KernelVersion: 2.6.38 | ||
727 | Contact: linux-iio@vger.kernel.org | ||
728 | Description: | ||
729 | This attribute is used to read the amount of quadrature error | ||
730 | present in the device at a given time. | ||