diff options
author | Jonathan Herman <hermanjl@cs.unc.edu> | 2013-01-22 10:38:37 -0500 |
---|---|---|
committer | Jonathan Herman <hermanjl@cs.unc.edu> | 2013-01-22 10:38:37 -0500 |
commit | fcc9d2e5a6c89d22b8b773a64fb4ad21ac318446 (patch) | |
tree | a57612d1888735a2ec7972891b68c1ac5ec8faea /drivers/staging/iio/Documentation | |
parent | 8dea78da5cee153b8af9c07a2745f6c55057fe12 (diff) |
Diffstat (limited to 'drivers/staging/iio/Documentation')
-rw-r--r-- | drivers/staging/iio/Documentation/sysfs-bus-iio | 713 |
1 files changed, 713 insertions, 0 deletions
diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio b/drivers/staging/iio/Documentation/sysfs-bus-iio new file mode 100644 index 00000000000..467c49a4725 --- /dev/null +++ b/drivers/staging/iio/Documentation/sysfs-bus-iio | |||
@@ -0,0 +1,713 @@ | |||
1 | What: /sys/bus/iio/devices/deviceX | ||
2 | KernelVersion: 2.6.35 | ||
3 | Contact: linux-iio@vger.kernel.org | ||
4 | Description: | ||
5 | Hardware chip or device accessed by on 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/device[n]/power_state | ||
10 | KernelVersion: 2.6.37 | ||
11 | Contact: linux-iio@vger.kernel.org | ||
12 | Description: | ||
13 | This property gets/sets the device power state. | ||
14 | |||
15 | What: /sys/bus/iio/devices/triggerX | ||
16 | KernelVersion: 2.6.35 | ||
17 | Contact: linux-iio@vger.kernel.org | ||
18 | Description: | ||
19 | An event driven driver of data capture to an in kernel buffer. | ||
20 | May be provided by a device driver that also has an IIO device | ||
21 | based on hardware generated events (e.g. data ready) or | ||
22 | provided by a separate driver for other hardware (e.g. | ||
23 | periodic timer, GPIO or high resolution timer). | ||
24 | Contains trigger type specific elements. These do not | ||
25 | generalize well and hence are not documented in this file. | ||
26 | X is the IIO index of the trigger. | ||
27 | |||
28 | What: /sys/bus/iio/devices/deviceX:buffer | ||
29 | KernelVersion: 2.6.35 | ||
30 | Contact: linux-iio@vger.kernel.org | ||
31 | Description: | ||
32 | Link to /sys/class/iio/deviceX/deviceX:buffer. X indicates | ||
33 | the device with which this buffer buffer is associated. | ||
34 | |||
35 | What: /sys/bus/iio/devices/deviceX/name | ||
36 | KernelVersion: 2.6.35 | ||
37 | Contact: linux-iio@vger.kernel.org | ||
38 | Description: | ||
39 | Description of the physical chip / device for device X. | ||
40 | Typically a part number. | ||
41 | |||
42 | What: /sys/bus/iio/devices/deviceX/sampling_frequency | ||
43 | KernelVersion: 2.6.35 | ||
44 | Contact: linux-iio@vger.kernel.org | ||
45 | Description: | ||
46 | Some devices have internal clocks. This parameter sets the | ||
47 | resulting sampling frequency. In many devices this | ||
48 | parameter has an effect on input filters etc rather than | ||
49 | simply controlling when the input is sampled. As this | ||
50 | effects datardy triggers, hardware buffers and the sysfs | ||
51 | direct access interfaces, it may be found in any of the | ||
52 | relevant directories. If it effects all of the above | ||
53 | then it is to be found in the base device directory as here. | ||
54 | |||
55 | What: /sys/bus/iio/devices/deviceX/sampling_frequency_available | ||
56 | KernelVersion: 2.6.35 | ||
57 | Contact: linux-iio@vger.kernel.org | ||
58 | Description: | ||
59 | When the internal sampling clock can only take a small | ||
60 | discrete set of values, this file lists those available. | ||
61 | |||
62 | What: /sys/bus/iio/devices/deviceX/range | ||
63 | KernelVersion: 2.6.38 | ||
64 | Contact: linux-iio@vger.kernel.org | ||
65 | Description: | ||
66 | Hardware dependent ADC Full Scale Range in mVolt. | ||
67 | |||
68 | What: /sys/bus/iio/devices/deviceX/range_available | ||
69 | KernelVersion: 2.6.38 | ||
70 | Contact: linux-iio@vger.kernel.org | ||
71 | Description: | ||
72 | Hardware dependent supported vales for ADC Full Scale Range. | ||
73 | |||
74 | What: /sys/bus/iio/devices/deviceX/oversampling_ratio | ||
75 | KernelVersion: 2.6.38 | ||
76 | Contact: linux-iio@vger.kernel.org | ||
77 | Description: | ||
78 | Hardware dependent ADC oversampling. Controls the sampling ratio | ||
79 | of the digital filter if available. | ||
80 | |||
81 | What: /sys/bus/iio/devices/deviceX/oversampling_ratio_available | ||
82 | KernelVersion: 2.6.38 | ||
83 | Contact: linux-iio@vger.kernel.org | ||
84 | Description: | ||
85 | Hardware dependent values supported by the oversampling filter. | ||
86 | |||
87 | What: /sys/bus/iio/devices/deviceX/inY_raw | ||
88 | What: /sys/bus/iio/devices/deviceX/inY_supply_raw | ||
89 | KernelVersion: 2.6.35 | ||
90 | Contact: linux-iio@vger.kernel.org | ||
91 | Description: | ||
92 | Raw (unscaled no bias removal etc) voltage measurement from | ||
93 | channel Y. In special cases where the channel does not | ||
94 | correspond to externally available input one of the named | ||
95 | versions may be used. The number must always be specified and | ||
96 | unique to allow association with event codes. | ||
97 | |||
98 | What: /sys/bus/iio/devices/deviceX/inY-inZ_raw | ||
99 | KernelVersion: 2.6.35 | ||
100 | Contact: linux-iio@vger.kernel.org | ||
101 | Description: | ||
102 | Raw (unscaled) differential voltage measurement equivalent to | ||
103 | channel Y - channel Z where these channel numbers apply to the | ||
104 | physically equivalent inputs when non differential readings are | ||
105 | separately available. In differential only parts, then all that | ||
106 | is required is a consistent labeling. | ||
107 | |||
108 | What: /sys/bus/iio/devices/deviceX/temp_raw | ||
109 | What: /sys/bus/iio/devices/deviceX/temp_x_raw | ||
110 | What: /sys/bus/iio/devices/deviceX/temp_y_raw | ||
111 | What: /sys/bus/iio/devices/deviceX/temp_z_raw | ||
112 | KernelVersion: 2.6.35 | ||
113 | Contact: linux-iio@vger.kernel.org | ||
114 | Description: | ||
115 | Raw (unscaled no bias removal etc) temperature measurement. | ||
116 | It an axis is specified it generally means that the temperature | ||
117 | sensor is associated with one part of a compound device (e.g. | ||
118 | a gyroscope axis). | ||
119 | |||
120 | What: /sys/bus/iio/devices/deviceX/tempX_input | ||
121 | KernelVersion: 2.6.38 | ||
122 | Contact: linux-iio@vger.kernel.org | ||
123 | Description: | ||
124 | Scaled temperature measurement in milli degrees Celsius. | ||
125 | |||
126 | What: /sys/bus/iio/devices/deviceX/accel_x_raw | ||
127 | What: /sys/bus/iio/devices/deviceX/accel_y_raw | ||
128 | What: /sys/bus/iio/devices/deviceX/accel_z_raw | ||
129 | KernelVersion: 2.6.35 | ||
130 | Contact: linux-iio@vger.kernel.org | ||
131 | Description: | ||
132 | Acceleration in direction x, y or z (may be arbitrarily assigned | ||
133 | but should match other such assignments on device) | ||
134 | channel m (not present if only one accelerometer channel at | ||
135 | this orientation). Has all of the equivalent parameters as per | ||
136 | inY. Units after application of scale and offset are m/s^2. | ||
137 | |||
138 | What: /sys/bus/iio/devices/deviceX/gyro_x_raw | ||
139 | What: /sys/bus/iio/devices/deviceX/gyro_y_raw | ||
140 | What: /sys/bus/iio/devices/deviceX/gyro_z_raw | ||
141 | KernelVersion: 2.6.35 | ||
142 | Contact: linux-iio@vger.kernel.org | ||
143 | Description: | ||
144 | Angular velocity about axis x, y or z (may be arbitrarily | ||
145 | assigned) Data converted by application of offset then scale to | ||
146 | radians per second. Has all the equivalent parameters as | ||
147 | per inY. | ||
148 | |||
149 | What: /sys/bus/iio/devices/deviceX/incli_x_raw | ||
150 | What: /sys/bus/iio/devices/deviceX/incli_y_raw | ||
151 | What: /sys/bus/iio/devices/deviceX/incli_z_raw | ||
152 | KernelVersion: 2.6.35 | ||
153 | Contact: linux-iio@vger.kernel.org | ||
154 | Description: | ||
155 | Inclination raw reading about axis x, y or z (may be | ||
156 | arbitrarily assigned). Data converted by application of offset | ||
157 | and scale to Degrees. | ||
158 | |||
159 | What: /sys/bus/iio/devices/deviceX/magn_x_raw | ||
160 | What: /sys/bus/iio/devices/deviceX/magn_y_raw | ||
161 | What: /sys/bus/iio/devices/deviceX/magn_z_raw | ||
162 | KernelVersion: 2.6.35 | ||
163 | Contact: linux-iio@vger.kernel.org | ||
164 | Description: | ||
165 | Magnetic field along axis x, y or z (may be arbitrarily | ||
166 | assigned) channel m (not present if only one magnetometer | ||
167 | at this orientation). Data converted by application of | ||
168 | offset then scale to Gauss. Has all the equivalent modifiers | ||
169 | as per inY. | ||
170 | |||
171 | What: /sys/bus/iio/devices/deviceX/accel_x_peak_raw | ||
172 | What: /sys/bus/iio/devices/deviceX/accel_y_peak_raw | ||
173 | What: /sys/bus/iio/devices/deviceX/accel_z_peak_raw | ||
174 | KernelVersion: 2.6.36 | ||
175 | Contact: linux-iio@vger.kernel.org | ||
176 | Description: | ||
177 | Some devices provide a store of the highest value seen since | ||
178 | some reset condition. These attributes allow access to this | ||
179 | and are otherwise the direct equivalent of the | ||
180 | <type>Y[_name]_raw attributes. | ||
181 | |||
182 | What: /sys/bus/iio/devices/deviceX/accel_xyz_squared_peak_raw | ||
183 | KernelVersion: 2.6.36 | ||
184 | Contact: linux-iio@vger.kernel.org | ||
185 | Description: | ||
186 | A computed peak value based on the sum squared magnitude of | ||
187 | the underlying value in the specified directions. | ||
188 | |||
189 | What: /sys/bus/iio/devices/deviceX/accel_offset | ||
190 | What: /sys/bus/iio/devices/deviceX/temp_offset | ||
191 | KernelVersion: 2.6.35 | ||
192 | Contact: linux-iio@vger.kernel.org | ||
193 | Description: | ||
194 | If known for a device, offset to be added to <type>[Y]_raw prior | ||
195 | to scaling by <type>[Y]_scale in order to obtain value in the | ||
196 | <type> units as specified in <type>[y]_raw documentation. | ||
197 | Not present if the offset is always 0 or unknown. If Y is not | ||
198 | present, then the offset applies to all in channels of <type>. | ||
199 | May be writable if a variable offset can be applied on the | ||
200 | device. Note that this is different to calibbias which | ||
201 | is for devices (or drivers) that apply offsets to compensate | ||
202 | for variation between different instances of the part, typically | ||
203 | adjusted by using some hardware supported calibration procedure. | ||
204 | |||
205 | What: /sys/bus/iio/devices/deviceX/inY_scale | ||
206 | What: /sys/bus/iio/devices/deviceX/inY_supply_scale | ||
207 | What: /sys/bus/iio/devices/deviceX/in_scale | ||
208 | What: /sys/bus/iio/devices/deviceX/outY_scale | ||
209 | What: /sys/bus/iio/devices/deviceX/accel_scale | ||
210 | What: /sys/bus/iio/devices/deviceX/accel_peak_scale | ||
211 | What: /sys/bus/iio/devices/deviceX/gyro_scale | ||
212 | What: /sys/bus/iio/devices/deviceX/magn_scale | ||
213 | What: /sys/bus/iio/devices/deviceX/magn_x_scale | ||
214 | What: /sys/bus/iio/devices/deviceX/magn_y_scale | ||
215 | What: /sys/bus/iio/devices/deviceX/magn_z_scale | ||
216 | KernelVersion: 2.6.35 | ||
217 | Contact: linux-iio@vger.kernel.org | ||
218 | Description: | ||
219 | If known for a device, scale to be applied to <type>Y[_name]_raw | ||
220 | post addition of <type>[Y][_name]_offset in order to obtain the | ||
221 | measured value in <type> units as specified in | ||
222 | <type>[Y][_name]_raw documentation.. If shared across all in | ||
223 | channels then Y is not present and the value is called | ||
224 | <type>[Y][_name]_scale. The peak modifier means this value | ||
225 | is applied to <type>Y[_name]_peak_raw values. | ||
226 | |||
227 | What: /sys/bus/iio/devices/deviceX/accel_x_calibbias | ||
228 | What: /sys/bus/iio/devices/deviceX/accel_y_calibbias | ||
229 | What: /sys/bus/iio/devices/deviceX/accel_z_calibbias | ||
230 | What: /sys/bus/iio/devices/deviceX/gyro_x_calibbias | ||
231 | What: /sys/bus/iio/devices/deviceX/gyro_y_calibbias | ||
232 | What: /sys/bus/iio/devices/deviceX/gyro_z_calibbias | ||
233 | KernelVersion: 2.6.35 | ||
234 | Contact: linux-iio@vger.kernel.org | ||
235 | Description: | ||
236 | Hardware applied calibration offset. (assumed to fix production | ||
237 | inaccuracies). If shared across all channels, <type>_calibbias | ||
238 | is used. | ||
239 | |||
240 | What /sys/bus/iio/devices/deviceX/inY_calibscale | ||
241 | What /sys/bus/iio/devices/deviceX/inY_supply_calibscale | ||
242 | What /sys/bus/iio/devices/deviceX/in_calibscale | ||
243 | What /sys/bus/iio/devices/deviceX/accel_x_calibscale | ||
244 | What /sys/bus/iio/devices/deviceX/accel_y_calibscale | ||
245 | What /sys/bus/iio/devices/deviceX/accel_z_calibscale | ||
246 | What /sys/bus/iio/devices/deviceX/gyro_x_calibscale | ||
247 | What /sys/bus/iio/devices/deviceX/gyro_y_calibscale | ||
248 | What /sys/bus/iio/devices/deviceX/gyro_z_calibscale | ||
249 | KernelVersion: 2.6.35 | ||
250 | Contact: linux-iio@vger.kernel.org | ||
251 | Description: | ||
252 | Hardware applied calibration scale factor. (assumed to fix | ||
253 | production inaccuracies). If shared across all channels, | ||
254 | <type>_calibscale is used. | ||
255 | |||
256 | What: /sys/bus/iio/devices/deviceX/accel_scale_available | ||
257 | KernelVersion: 2.635 | ||
258 | Contact: linux-iio@vger.kernel.org | ||
259 | Description: | ||
260 | If a discrete set of scale values are available, they | ||
261 | are listed in this attribute. | ||
262 | |||
263 | What: /sys/bus/iio/devices/deviceX/outY_raw | ||
264 | KernelVersion: 2.6.37 | ||
265 | Contact: linux-iio@vger.kernel.org | ||
266 | Description: | ||
267 | Raw (unscaled, no bias etc.) output voltage for | ||
268 | channel Y. The number must always be specified and | ||
269 | unique if the output corresponds to a single channel. | ||
270 | |||
271 | What: /sys/bus/iio/devices/deviceX/outY&Z_raw | ||
272 | KernelVersion: 2.6.37 | ||
273 | Contact: linux-iio@vger.kernel.org | ||
274 | Description: | ||
275 | Raw (unscaled, no bias etc.) output voltage for an aggregate of | ||
276 | channel Y, channel Z, etc. This interface is available in cases | ||
277 | where a single output sets the value for multiple channels | ||
278 | simultaneously. | ||
279 | |||
280 | What: /sys/bus/iio/devices/deviceX/outY_powerdown_mode | ||
281 | What: /sys/bus/iio/devices/deviceX/out_powerdown_mode | ||
282 | KernelVersion: 2.6.38 | ||
283 | Contact: linux-iio@vger.kernel.org | ||
284 | Description: | ||
285 | Specifies the output powerdown mode. | ||
286 | DAC output stage is disconnected from the amplifier and | ||
287 | 1kohm_to_gnd: connected to ground via an 1kOhm resistor | ||
288 | 100kohm_to_gnd: connected to ground via an 100kOhm resistor | ||
289 | three_state: left floating | ||
290 | For a list of available output power down options read | ||
291 | outX_powerdown_mode_available. If Y is not present the | ||
292 | mode is shared across all outputs. | ||
293 | |||
294 | What: /sys/bus/iio/devices/deviceX/outY_powerdown_mode_available | ||
295 | What: /sys/bus/iio/devices/deviceX/out_powerdown_mode_available | ||
296 | KernelVersion: 2.6.38 | ||
297 | Contact: linux-iio@vger.kernel.org | ||
298 | Description: | ||
299 | Lists all available output power down modes. | ||
300 | If Y is not present the mode is shared across all outputs. | ||
301 | |||
302 | What: /sys/bus/iio/devices/deviceX/outY_powerdown | ||
303 | What: /sys/bus/iio/devices/deviceX/out_powerdown | ||
304 | KernelVersion: 2.6.38 | ||
305 | Contact: linux-iio@vger.kernel.org | ||
306 | Description: | ||
307 | Writing 1 causes output Y to enter the power down mode specified | ||
308 | by the corresponding outY_powerdown_mode. Clearing returns to | ||
309 | normal operation. Y may be suppressed if all outputs are | ||
310 | controlled together. | ||
311 | |||
312 | What: /sys/bus/iio/devices/deviceX/deviceX:eventY | ||
313 | KernelVersion: 2.6.35 | ||
314 | Contact: linux-iio@vger.kernel.org | ||
315 | Description: | ||
316 | Configuration of which hardware generated events are passed up | ||
317 | to user-space. | ||
318 | |||
319 | What: /sys/bus/iio/devices/deviceX:event/dev | ||
320 | What: /sys/bus/iio/devices/deviceX:eventY/dev | ||
321 | KernelVersion: 2.6.35 | ||
322 | Contact: linux-iio@vger.kernel.org | ||
323 | Description: | ||
324 | major:minor character device numbers for the event line Y of | ||
325 | device X. | ||
326 | |||
327 | What: /sys/.../deviceX:eventY/accel_x_thresh_rising_en | ||
328 | What: /sys/.../deviceX:eventY/accel_x_thresh_falling_en | ||
329 | What: /sys/.../deviceX:eventY/accel_y_thresh_rising_en | ||
330 | What: /sys/.../deviceX:eventY/accel_y_thresh_falling_en | ||
331 | What: /sys/.../deviceX:eventY/accel_z_thresh_rising_en | ||
332 | What: /sys/.../deviceX:eventY/accel_z_thresh_falling_en | ||
333 | What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_en | ||
334 | What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_en | ||
335 | What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_en | ||
336 | What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_en | ||
337 | What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_en | ||
338 | What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_en | ||
339 | What: /sys/.../deviceX:eventY/magn_x_thresh_rising_en | ||
340 | What: /sys/.../deviceX:eventY/magn_x_thresh_falling_en | ||
341 | What: /sys/.../deviceX:eventY/magn_y_thresh_rising_en | ||
342 | What: /sys/.../deviceX:eventY/magn_y_thresh_falling_en | ||
343 | What: /sys/.../deviceX:eventY/magn_z_thresh_rising_en | ||
344 | What: /sys/.../deviceX:eventY/magn_z_thresh_falling_en | ||
345 | What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_en | ||
346 | What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_en | ||
347 | What: /sys/.../deviceX:eventY/inZ_thresh_rising_en | ||
348 | What: /sys/.../deviceX:eventY/inZ_thresh_falling_en | ||
349 | What: /sys/.../deviceX:eventY/temp_thresh_rising_en | ||
350 | What: /sys/.../deviceX:eventY/temp_thresh_falling_en | ||
351 | KernelVersion: 2.6.37 | ||
352 | Contact: linux-iio@vger.kernel.org | ||
353 | Description: | ||
354 | Event generated when channel passes a threshold in the specified | ||
355 | (_rising|_falling) direction. If the direction is not specified, | ||
356 | then either the device will report an event which ever direction | ||
357 | a single threshold value is called in (e.g. | ||
358 | <type>[Z][_name]_<raw|input>_thresh_value) or | ||
359 | <type>[Z][_name]_<raw|input>_thresh_rising_value and | ||
360 | <type>[Z][_name]_<raw|input>_thresh_falling_value may take | ||
361 | different values, but the device can only enable both thresholds | ||
362 | or neither. | ||
363 | Note the driver will assume the last p events requested are | ||
364 | to be enabled where p is however many it supports (which may | ||
365 | vary depending on the exact set requested. So if you want to be | ||
366 | sure you have set what you think you have, check the contents of | ||
367 | these attributes after everything is configured. Drivers may | ||
368 | have to buffer any parameters so that they are consistent when | ||
369 | a given event type is enabled a future point (and not those for | ||
370 | whatever event was previously enabled). | ||
371 | |||
372 | What: /sys/.../deviceX:eventY/accel_x_roc_rising_en | ||
373 | What: /sys/.../deviceX:eventY/accel_x_roc_falling_en | ||
374 | What: /sys/.../deviceX:eventY/accel_y_roc_rising_en | ||
375 | What: /sys/.../deviceX:eventY/accel_y_roc_falling_en | ||
376 | What: /sys/.../deviceX:eventY/accel_z_roc_rising_en | ||
377 | What: /sys/.../deviceX:eventY/accel_z_roc_falling_en | ||
378 | What: /sys/.../deviceX:eventY/gyro_x_roc_rising_en | ||
379 | What: /sys/.../deviceX:eventY/gyro_x_roc_falling_en | ||
380 | What: /sys/.../deviceX:eventY/gyro_y_roc_rising_en | ||
381 | What: /sys/.../deviceX:eventY/gyro_y_roc_falling_en | ||
382 | What: /sys/.../deviceX:eventY/gyro_z_roc_rising_en | ||
383 | What: /sys/.../deviceX:eventY/gyro_z_roc_falling_en | ||
384 | What: /sys/.../deviceX:eventY/magn_x_roc_rising_en | ||
385 | What: /sys/.../deviceX:eventY/magn_x_roc_falling_en | ||
386 | What: /sys/.../deviceX:eventY/magn_y_roc_rising_en | ||
387 | What: /sys/.../deviceX:eventY/magn_y_roc_falling_en | ||
388 | What: /sys/.../deviceX:eventY/magn_z_roc_rising_en | ||
389 | What: /sys/.../deviceX:eventY/magn_z_roc_falling_en | ||
390 | What: /sys/.../deviceX:eventY/inZ_supply_roc_rising_en | ||
391 | What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_en | ||
392 | What: /sys/.../deviceX:eventY/inZ_roc_rising_en | ||
393 | What: /sys/.../deviceX:eventY/inZ_roc_falling_en | ||
394 | What: /sys/.../deviceX:eventY/temp_roc_rising_en | ||
395 | What: /sys/.../deviceX:eventY/temp_roc_falling_en | ||
396 | KernelVersion: 2.6.37 | ||
397 | Contact: linux-iio@vger.kernel.org | ||
398 | Description: | ||
399 | Event generated when channel passes a threshold on the rate of | ||
400 | change (1st differential) in the specified (_rising|_falling) | ||
401 | direction. If the direction is not specified, then either the | ||
402 | device will report an event which ever direction a single | ||
403 | threshold value is called in (e.g. | ||
404 | <type>[Z][_name]_<raw|input>_roc_value) or | ||
405 | <type>[Z][_name]_<raw|input>_roc_rising_value and | ||
406 | <type>[Z][_name]_<raw|input>_roc_falling_value may take | ||
407 | different values, but the device can only enable both rate of | ||
408 | change thresholds or neither. | ||
409 | Note the driver will assume the last p events requested are | ||
410 | to be enabled where p is however many it supports (which may | ||
411 | vary depending on the exact set requested. So if you want to be | ||
412 | sure you have set what you think you have, check the contents of | ||
413 | these attributes after everything is configured. Drivers may | ||
414 | have to buffer any parameters so that they are consistent when | ||
415 | a given event type is enabled a future point (and not those for | ||
416 | whatever event was previously enabled). | ||
417 | |||
418 | What: /sys/.../deviceX:eventY/accel_x_raw_thresh_rising_value | ||
419 | What: /sys/.../deviceX:eventY/accel_x_raw_thresh_falling_value | ||
420 | What: /sys/.../deviceX:eventY/accel_y_raw_thresh_rising_value | ||
421 | What: /sys/.../deviceX:eventY/accel_y_raw_thresh_falling_value | ||
422 | What: /sys/.../deviceX:eventY/accel_z_raw_thresh_rising_value | ||
423 | What: /sys/.../deviceX:eventY/accel_z_raw_thresh_falling_value | ||
424 | What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_rising_value | ||
425 | What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_falling_value | ||
426 | What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_rising_value | ||
427 | What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_falling_value | ||
428 | What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_rising_value | ||
429 | What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_falling_value | ||
430 | What: /sys/.../deviceX:eventY/magn_x_raw_thresh_rising_value | ||
431 | What: /sys/.../deviceX:eventY/magn_x_raw_thresh_falling_value | ||
432 | What: /sys/.../deviceX:eventY/magn_y_raw_thresh_rising_value | ||
433 | What: /sys/.../deviceX:eventY/magn_y_raw_thresh_falling_value | ||
434 | What: /sys/.../deviceX:eventY/magn_z_raw_thresh_rising_value | ||
435 | What: /sys/.../deviceX:eventY/magn_z_raw_thresh_falling_value | ||
436 | What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_rising_value | ||
437 | What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_falling_value | ||
438 | What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value | ||
439 | What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value | ||
440 | What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value | ||
441 | What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value | ||
442 | KernelVersion: 2.6.37 | ||
443 | Contact: linux-iio@vger.kernel.org | ||
444 | Description: | ||
445 | Specifies the value of threshold that the device is comparing | ||
446 | against for the events enabled by | ||
447 | <type>Z[_name]_thresh[_rising|falling]_en. | ||
448 | If separate attributes exist for the two directions, but | ||
449 | direction is not specified for this attribute, then a single | ||
450 | threshold value applies to both directions. | ||
451 | The raw or input element of the name indicates whether the | ||
452 | value is in raw device units or in processed units (as _raw | ||
453 | and _input do on sysfs direct channel read attributes). | ||
454 | |||
455 | What: /sys/.../deviceX:eventY/accel_x_raw_roc_rising_value | ||
456 | What: /sys/.../deviceX:eventY/accel_x_raw_roc_falling_value | ||
457 | What: /sys/.../deviceX:eventY/accel_y_raw_roc_rising_value | ||
458 | What: /sys/.../deviceX:eventY/accel_y_raw_roc_falling_value | ||
459 | What: /sys/.../deviceX:eventY/accel_z_raw_roc_rising_value | ||
460 | What: /sys/.../deviceX:eventY/accel_z_raw_roc_falling_value | ||
461 | What: /sys/.../deviceX:eventY/gyro_x_raw_roc_rising_value | ||
462 | What: /sys/.../deviceX:eventY/gyro_x_raw_roc_falling_value | ||
463 | What: /sys/.../deviceX:eventY/gyro_y_raw_roc_rising_value | ||
464 | What: /sys/.../deviceX:eventY/gyro_y_raw_roc_falling_value | ||
465 | What: /sys/.../deviceX:eventY/gyro_z_raw_roc_rising_value | ||
466 | What: /sys/.../deviceX:eventY/gyro_z_raw_roc_falling_value | ||
467 | What: /sys/.../deviceX:eventY/magn_x_raw_roc_rising_value | ||
468 | What: /sys/.../deviceX:eventY/magn_x_raw_roc_falling_value | ||
469 | What: /sys/.../deviceX:eventY/magn_y_raw_roc_rising_value | ||
470 | What: /sys/.../deviceX:eventY/magn_y_raw_roc_falling_value | ||
471 | What: /sys/.../deviceX:eventY/magn_z_raw_roc_rising_value | ||
472 | What: /sys/.../deviceX:eventY/magn_z_raw_roc_falling_value | ||
473 | What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_rising_value | ||
474 | What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_falling_value | ||
475 | What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value | ||
476 | What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value | ||
477 | What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value | ||
478 | What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value | ||
479 | KernelVersion: 2.6.37 | ||
480 | Contact: linux-iio@vger.kernel.org | ||
481 | Description: | ||
482 | Specifies the value of rate of change threshold that the | ||
483 | device is comparing against for the events enabled by | ||
484 | <type>[Z][_name]_roc[_rising|falling]_en. | ||
485 | If separate attributes exist for the two directions, | ||
486 | but direction is not specified for this attribute, | ||
487 | then a single threshold value applies to both directions. | ||
488 | The raw or input element of the name indicates whether the | ||
489 | value is in raw device units or in processed units (as _raw | ||
490 | and _input do on sysfs direct channel read attributes). | ||
491 | |||
492 | What: /sys/.../deviceX:eventY/accel_x_thresh_rising_period | ||
493 | What: /sys/.../deviceX:eventY/accel_x_thresh_falling_period | ||
494 | hat: /sys/.../deviceX:eventY/accel_x_roc_rising_period | ||
495 | What: /sys/.../deviceX:eventY/accel_x_roc_falling_period | ||
496 | What: /sys/.../deviceX:eventY/accel_y_thresh_rising_period | ||
497 | What: /sys/.../deviceX:eventY/accel_y_thresh_falling_period | ||
498 | What: /sys/.../deviceX:eventY/accel_y_roc_rising_period | ||
499 | What: /sys/.../deviceX:eventY/accel_y_roc_falling_period | ||
500 | What: /sys/.../deviceX:eventY/accel_z_thresh_rising_period | ||
501 | What: /sys/.../deviceX:eventY/accel_z_thresh_falling_period | ||
502 | What: /sys/.../deviceX:eventY/accel_z_roc_rising_period | ||
503 | What: /sys/.../deviceX:eventY/accel_z_roc_falling_period | ||
504 | What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_period | ||
505 | What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_period | ||
506 | What: /sys/.../deviceX:eventY/gyro_x_roc_rising_period | ||
507 | What: /sys/.../deviceX:eventY/gyro_x_roc_falling_period | ||
508 | What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_period | ||
509 | What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_period | ||
510 | What: /sys/.../deviceX:eventY/gyro_y_roc_rising_period | ||
511 | What: /sys/.../deviceX:eventY/gyro_y_roc_falling_period | ||
512 | What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_period | ||
513 | What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_period | ||
514 | What: /sys/.../deviceX:eventY/gyro_z_roc_rising_period | ||
515 | What: /sys/.../deviceX:eventY/gyro_z_roc_falling_period | ||
516 | What: /sys/.../deviceX:eventY/magn_x_thresh_rising_period | ||
517 | What: /sys/.../deviceX:eventY/magn_x_thresh_falling_period | ||
518 | What: /sys/.../deviceX:eventY/magn_x_roc_rising_period | ||
519 | What: /sys/.../deviceX:eventY/magn_x_roc_falling_period | ||
520 | What: /sys/.../deviceX:eventY/magn_y_thresh_rising_period | ||
521 | What: /sys/.../deviceX:eventY/magn_y_thresh_falling_period | ||
522 | What: /sys/.../deviceX:eventY/magn_y_roc_rising_period | ||
523 | What: /sys/.../deviceX:eventY/magn_y_roc_falling_period | ||
524 | What: /sys/.../deviceX:eventY/magn_z_thresh_rising_period | ||
525 | What: /sys/.../deviceX:eventY/magn_z_thresh_falling_period | ||
526 | What: /sys/.../deviceX:eventY/magn_z_roc_rising_period | ||
527 | What: /sys/.../deviceX:eventY/magn_z_roc_falling_period | ||
528 | What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_period | ||
529 | What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_period | ||
530 | What: /sys/.../deviceX:eventY/inz_supply_roc_rising_period | ||
531 | What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_period | ||
532 | What: /sys/.../deviceX:eventY/inZ_thresh_rising_period | ||
533 | What: /sys/.../deviceX:eventY/inZ_thresh_falling_period | ||
534 | What: /sys/.../deviceX:eventY/inZ_roc_rising_period | ||
535 | What: /sys/.../deviceX:eventY/inZ_roc_falling_period | ||
536 | What: /sys/.../deviceX:eventY/temp_thresh_rising_period | ||
537 | What: /sys/.../deviceX:eventY/temp_thresh_falling_period | ||
538 | What: /sys/.../deviceX:eventY/temp_roc_rising_period | ||
539 | What: /sys/.../deviceX:eventY/temp_roc_falling_period | ||
540 | What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_period | ||
541 | KernelVersion: 2.6.37 | ||
542 | Contact: linux-iio@vger.kernel.org | ||
543 | Description: | ||
544 | Period of time (in seconds) for which the condition must be | ||
545 | met before an event is generated. If direction is not | ||
546 | specified then this period applies to both directions. | ||
547 | |||
548 | What: /sys/.../deviceX:eventY/accel_mag_en | ||
549 | What: /sys/.../deviceX:eventY/accel_mag_rising_en | ||
550 | What: /sys/.../deviceX:eventY/accel_mag_falling_en | ||
551 | What: /sys/.../deviceX:eventY/accel_x_mag_en | ||
552 | What: /sys/.../deviceX:eventY/accel_x_mag_rising_en | ||
553 | What: /sys/.../deviceX:eventY/accel_x_mag_falling_en | ||
554 | What: /sys/.../deviceX:eventY/accel_y_mag_en | ||
555 | What: /sys/.../deviceX:eventY/accel_y_mag_rising_en | ||
556 | What: /sys/.../deviceX:eventY/accel_y_mag_falling_en | ||
557 | What: /sys/.../deviceX:eventY/accel_z_mag_en | ||
558 | What: /sys/.../deviceX:eventY/accel_z_mag_rising_en | ||
559 | What: /sys/.../deviceX:eventY/accel_z_mag_falling_en | ||
560 | What: /sys/.../deviceX:eventY/accel_x&y&z_mag_rising_en | ||
561 | What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_en | ||
562 | KernelVersion: 2.6.37 | ||
563 | Contact: linux-iio@vger.kernel.org | ||
564 | Description: | ||
565 | Similar to accel_x_thresh[_rising|_falling]_en, but here the | ||
566 | magnitude of the channel is compared to the threshold, not its | ||
567 | signed value. | ||
568 | |||
569 | What: /sys/.../accel_raw_mag_value | ||
570 | What: /sys/.../accel_x_raw_mag_rising_value | ||
571 | What: /sys/.../accel_y_raw_mag_rising_value | ||
572 | What: /sys/.../accel_z_raw_mag_rising_value | ||
573 | KernelVersion: 2.6.37 | ||
574 | Contact: linux-iio@vger.kernel.org | ||
575 | Description: | ||
576 | The value to which the magnitude of the channel is compared. If | ||
577 | number or direction is not specified, applies to all channels of | ||
578 | this type. | ||
579 | |||
580 | What: /sys/bus/iio/devices/deviceX:buffer:event/dev | ||
581 | KernelVersion: 2.6.35 | ||
582 | Contact: linux-iio@vger.kernel.org | ||
583 | Description: | ||
584 | Buffer for device X event character device major:minor numbers. | ||
585 | |||
586 | What: /sys/bus/iio/devices/deviceX:buffer:access/dev | ||
587 | KernelVersion: 2.6.35 | ||
588 | Contact: linux-iio@vger.kernel.org | ||
589 | Description: | ||
590 | Buffer for device X access character device major:minor numbers. | ||
591 | |||
592 | What: /sys/bus/iio/devices/deviceX:buffer/trigger | ||
593 | KernelVersion: 2.6.35 | ||
594 | Contact: linux-iio@vger.kernel.org | ||
595 | Description: | ||
596 | The name of the trigger source being used, as per string given | ||
597 | in /sys/class/iio/triggerY/name. | ||
598 | |||
599 | What: /sys/bus/iio/devices/deviceX:buffer/length | ||
600 | KernelVersion: 2.6.35 | ||
601 | Contact: linux-iio@vger.kernel.org | ||
602 | Description: | ||
603 | Number of scans contained by the buffer. | ||
604 | |||
605 | What: /sys/bus/iio/devices/deviceX:buffer/bytes_per_datum | ||
606 | KernelVersion: 2.6.37 | ||
607 | Contact: linux-iio@vger.kernel.org | ||
608 | Description: | ||
609 | Bytes per scan. Due to alignment fun, the scan may be larger | ||
610 | than implied directly by the scan_element parameters. | ||
611 | |||
612 | What: /sys/bus/iio/devices/deviceX:buffer/enable | ||
613 | KernelVersion: 2.6.35 | ||
614 | Contact: linux-iio@vger.kernel.org | ||
615 | Description: | ||
616 | Actually start the buffer capture up. Will start trigger | ||
617 | if first device and appropriate. | ||
618 | |||
619 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements | ||
620 | KernelVersion: 2.6.37 | ||
621 | Contact: linux-iio@vger.kernel.org | ||
622 | Description: | ||
623 | Directory containing interfaces for elements that will be | ||
624 | captured for a single triggered sample set in the buffer. | ||
625 | |||
626 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_en | ||
627 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_en | ||
628 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_en | ||
629 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_en | ||
630 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_en | ||
631 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_en | ||
632 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_en | ||
633 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_en | ||
634 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_en | ||
635 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/timestamp_en | ||
636 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_supply_en | ||
637 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_en | ||
638 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY-inZ_en | ||
639 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_en | ||
640 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_en | ||
641 | KernelVersion: 2.6.37 | ||
642 | Contact: linux-iio@vger.kernel.org | ||
643 | Description: | ||
644 | Scan element control for triggered data capture. | ||
645 | |||
646 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_type | ||
647 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_type | ||
648 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_type | ||
649 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_type | ||
650 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_type | ||
651 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/in-in_type | ||
652 | What: /sys/.../deviceX:buffer/scan_elements/inY_supply_type | ||
653 | What: /sys/.../deviceX:buffer/scan_elements/timestamp_type | ||
654 | KernelVersion: 2.6.37 | ||
655 | Contact: linux-iio@vger.kernel.org | ||
656 | Description: | ||
657 | Description of the scan element data storage within the buffer | ||
658 | and hence the form in which it is read from user-space. | ||
659 | Form is [s|u]bits/storagebits[>>shift]. s or u specifies if | ||
660 | signed (2's complement) or unsigned. bits is the number of bits | ||
661 | of data and storagebits is the space (after padding) that it | ||
662 | occupies in the buffer. shift if specified, is the shift that | ||
663 | needs to be applied prior to masking out unused bits. Some | ||
664 | devices put their data in the middle of the transferred elements | ||
665 | with additional information on both sides. Note that some | ||
666 | devices will have additional information in the unused bits | ||
667 | so to get a clean value, the bits value must be used to mask | ||
668 | the buffer output value appropriately. The storagebits value | ||
669 | also specifies the data alignment. So s48/64>>2 will be a | ||
670 | signed 48 bit integer stored in a 64 bit location aligned to | ||
671 | a a64 bit boundary. To obtain the clean value, shift right 2 | ||
672 | and apply a mask to zero the top 16 bits of the result. | ||
673 | For other storage combinations this attribute will be extended | ||
674 | appropriately. | ||
675 | |||
676 | What: /sys/.../deviceX:buffer/scan_elements/accel_type_available | ||
677 | KernelVersion: 2.6.37 | ||
678 | Contact: linux-iio@vger.kernel.org | ||
679 | Description: | ||
680 | If the type parameter can take one of a small set of values, | ||
681 | this attribute lists them. | ||
682 | |||
683 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_index | ||
684 | What: /sys/.../deviceX:buffer/scan_elements/inY_supply_index | ||
685 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_index | ||
686 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_index | ||
687 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_index | ||
688 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_index | ||
689 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_index | ||
690 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_index | ||
691 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_index | ||
692 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_index | ||
693 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_index | ||
694 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_index | ||
695 | What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_index | ||
696 | What: /sys/.../deviceX:buffer/scan_elements/timestamp_index | ||
697 | KernelVersion: 2.6.37 | ||
698 | Contact: linux-iio@vger.kernel.org | ||
699 | Description: | ||
700 | A single positive integer specifying the position of this | ||
701 | scan element in the buffer. Note these are not dependent on | ||
702 | what is enabled and may not be contiguous. Thus for user-space | ||
703 | to establish the full layout these must be used in conjunction | ||
704 | with all _en attributes to establish which channels are present, | ||
705 | and the relevant _type attributes to establish the data storage | ||
706 | format. | ||
707 | |||
708 | What: /sys/bus/iio/devices/deviceX/gyro_z_quadrature_correction_raw | ||
709 | KernelVersion: 2.6.38 | ||
710 | Contact: linux-iio@xxxxxxxxxxxxxxx | ||
711 | Description: | ||
712 | This attribute is used to read the amount of quadrature error | ||
713 | present in the device at a given time. | ||