blob: da25bc73983a911cd67fbe319407a6db8e0de4bb [file] [log] [blame]
Jonathan Cameronf386caa2010-11-22 23:31:16 +00001What: /sys/bus/iio/devices/deviceX
Jonathan Camerone34d2c52010-05-04 14:43:05 +01002KernelVersion: 2.6.35
3Contact: linux-iio@vger.kernel.org
4Description:
5 Hardware chip or device accessed by on communication port.
Jonathan Cameronf386caa2010-11-22 23:31:16 +00006 Corresponds to a grouping of sensor channels. X is the IIO
7 index of the device.
Jonathan Camerone34d2c52010-05-04 14:43:05 +01008
Jonathan Cameronf386caa2010-11-22 23:31:16 +00009What: /sys/bus/iio/devices/triggerX
Jonathan Camerone34d2c52010-05-04 14:43:05 +010010KernelVersion: 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.
Jonathan Cameronf386caa2010-11-22 23:31:16 +000017 periodic timer, GPIO or high resolution timer).
Jonathan Camerone34d2c52010-05-04 14:43:05 +010018 Contains trigger type specific elements. These do not
19 generalize well and hence are not documented in this file.
Jonathan Cameronf386caa2010-11-22 23:31:16 +000020 X is the IIO index of the trigger.
Jonathan Camerone34d2c52010-05-04 14:43:05 +010021
Jonathan Cameronf386caa2010-11-22 23:31:16 +000022What: /sys/bus/iio/devices/deviceX:buffer
Jonathan Camerone34d2c52010-05-04 14:43:05 +010023KernelVersion: 2.6.35
24Contact: linux-iio@vger.kernel.org
25Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +000026 Link to /sys/class/iio/deviceX/deviceX:buffer. X indicates
Jonathan Cameron2f3cc662010-10-08 12:14:12 +010027 the device with which this buffer buffer is associated.
Jonathan Camerone34d2c52010-05-04 14:43:05 +010028
Jonathan Cameronf386caa2010-11-22 23:31:16 +000029What: /sys/bus/iio/devices/deviceX/name
Jonathan Camerone34d2c52010-05-04 14:43:05 +010030KernelVersion: 2.6.35
31Contact: linux-iio@vger.kernel.org
32Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +000033 Description of the physical chip / device for device X.
34 Typically a part number.
Jonathan Camerone34d2c52010-05-04 14:43:05 +010035
Jonathan Cameronf386caa2010-11-22 23:31:16 +000036What: /sys/bus/iio/devices/deviceX/sampling_frequency
Jonathan Camerone34d2c52010-05-04 14:43:05 +010037KernelVersion: 2.6.35
38Contact: linux-iio@vger.kernel.org
39Description:
40 Some devices have internal clocks. This parameter sets the
41 resulting sampling frequency. In many devices this
42 parameter has an effect on input filters etc rather than
43 simply controlling when the input is sampled. As this
44 effects datardy triggers, hardware buffers and the sysfs
45 direct access interfaces, it may be found in any of the
46 relevant directories. If it effects all of the above
47 then it is to be found in the base device directory as here.
48
Jonathan Cameronf386caa2010-11-22 23:31:16 +000049What: /sys/bus/iio/devices/deviceX/sampling_frequency_available
Jonathan Camerone34d2c52010-05-04 14:43:05 +010050KernelVersion: 2.6.35
51Contact: linux-iio@vger.kernel.org
52Description:
53 When the internal sampling clock can only take a small
Jonathan Cameronf386caa2010-11-22 23:31:16 +000054 discrete set of values, this file lists those available.
Jonathan Camerone34d2c52010-05-04 14:43:05 +010055
Michael Hennerichb9618c02011-02-22 21:46:18 +010056What: /sys/bus/iio/devices/deviceX/range
57KernelVersion: 2.6.38
58Contact: linux-iio@vger.kernel.org
59Description:
60 Hardware dependent ADC Full Scale Range in mVolt.
61
62What: /sys/bus/iio/devices/deviceX/range_available
63KernelVersion: 2.6.38
64Contact: linux-iio@vger.kernel.org
65Description:
66 Hardware dependent supported vales for ADC Full Scale Range.
67
68What: /sys/bus/iio/devices/deviceX/oversampling_ratio
69KernelVersion: 2.6.38
70Contact: linux-iio@vger.kernel.org
71Description:
72 Hardware dependent ADC oversampling. Controls the sampling ratio
73 of the digital filter if available.
74
75What: /sys/bus/iio/devices/deviceX/oversampling_ratio_available
76KernelVersion: 2.6.38
77Contact: linux-iio@vger.kernel.org
78Description:
79 Hardware dependent values supported by the oversampling filter.
80
Jonathan Cameronf386caa2010-11-22 23:31:16 +000081What: /sys/bus/iio/devices/deviceX/inY_raw
82What: /sys/bus/iio/devices/deviceX/inY_supply_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +010083KernelVersion: 2.6.35
84Contact: linux-iio@vger.kernel.org
85Description:
86 Raw (unscaled no bias removal etc) voltage measurement from
Jonathan Cameronf386caa2010-11-22 23:31:16 +000087 channel Y. In special cases where the channel does not
88 correspond to externally available input one of the named
89 versions may be used. The number must always be specified and
90 unique to allow association with event codes.
Jonathan Camerone34d2c52010-05-04 14:43:05 +010091
Jonathan Cameronf386caa2010-11-22 23:31:16 +000092What: /sys/bus/iio/devices/deviceX/inY-inZ_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +010093KernelVersion: 2.6.35
94Contact: linux-iio@vger.kernel.org
95Description:
96 Raw (unscaled) differential voltage measurement equivalent to
Jonathan Cameronf386caa2010-11-22 23:31:16 +000097 channel Y - channel Z where these channel numbers apply to the
Jonathan Cameron2f3cc662010-10-08 12:14:12 +010098 physically equivalent inputs when non differential readings are
99 separately available. In differential only parts, then all that
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000100 is required is a consistent labeling.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100101
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000102What: /sys/bus/iio/devices/deviceX/temp_raw
103What: /sys/bus/iio/devices/deviceX/temp_x_raw
104What: /sys/bus/iio/devices/deviceX/temp_y_raw
105What: /sys/bus/iio/devices/deviceX/temp_z_raw
106KernelVersion: 2.6.35
107Contact: linux-iio@vger.kernel.org
108Description:
109 Raw (unscaled no bias removal etc) temperature measurement.
110 It an axis is specified it generally means that the temperature
111 sensor is associated with one part of a compound device (e.g.
112 a gyroscope axis).
113
114What: /sys/bus/iio/devices/deviceX/accel_x_raw
115What: /sys/bus/iio/devices/deviceX/accel_y_raw
116What: /sys/bus/iio/devices/deviceX/accel_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100117KernelVersion: 2.6.35
118Contact: linux-iio@vger.kernel.org
119Description:
120 Acceleration in direction x, y or z (may be arbitrarily assigned
121 but should match other such assignments on device)
122 channel m (not present if only one accelerometer channel at
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100123 this orientation). Has all of the equivalent parameters as per
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000124 inY. Units after application of scale and offset are m/s^2.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100125
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000126What: /sys/bus/iio/devices/deviceX/gyro_x_raw
127What: /sys/bus/iio/devices/deviceX/gyro_y_raw
128What: /sys/bus/iio/devices/deviceX/gyro_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100129KernelVersion: 2.6.35
130Contact: linux-iio@vger.kernel.org
131Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100132 Angular velocity about axis x, y or z (may be arbitrarily
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000133 assigned) Data converted by application of offset then scale to
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100134 radians per second. Has all the equivalent parameters as
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000135 per inY.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100136
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000137What: /sys/bus/iio/devices/deviceX/incli_x_raw
138What: /sys/bus/iio/devices/deviceX/incli_y_raw
139What: /sys/bus/iio/devices/deviceX/incli_z_raw
Jonathan Camerone5107fb2010-05-07 15:38:57 +0100140KernelVersion: 2.6.35
141Contact: linux-iio@vger.kernel.org
142Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000143 Inclination raw reading about axis x, y or z (may be
144 arbitrarily assigned). Data converted by application of offset
Jonathan Camerone5107fb2010-05-07 15:38:57 +0100145 and scale to Degrees.
146
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000147What: /sys/bus/iio/devices/deviceX/magn_x_raw
148What: /sys/bus/iio/devices/deviceX/magn_y_raw
149What: /sys/bus/iio/devices/deviceX/magn_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100150KernelVersion: 2.6.35
151Contact: linux-iio@vger.kernel.org
152Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100153 Magnetic field along axis x, y or z (may be arbitrarily
154 assigned) channel m (not present if only one magnetometer
155 at this orientation). Data converted by application of
156 offset then scale to Gauss. Has all the equivalent modifiers
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000157 as per inY.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100158
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000159What: /sys/bus/iio/devices/deviceX/accel_x_peak_raw
160What: /sys/bus/iio/devices/deviceX/accel_y_peak_raw
161What: /sys/bus/iio/devices/deviceX/accel_z_peak_raw
162KernelVersion: 2.6.36
163Contact: linux-iio@vger.kernel.org
164Description:
165 Some devices provide a store of the highest value seen since
166 some reset condition. These attributes allow access to this
167 and are otherwise the direct equivalent of the
168 <type>Y[_name]_raw attributes.
169
170What: /sys/bus/iio/devices/deviceX/accel_xyz_squared_peak_raw
171KernelVersion: 2.6.36
172Contact: linux-iio@vger.kernel.org
173Description:
174 A computed peak value based on the sum squared magnitude of
175 the underlying value in the specified directions.
176
177What: /sys/bus/iio/devices/deviceX/accel_offset
178What: /sys/bus/iio/devices/deviceX/temp_offset
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100179KernelVersion: 2.6.35
180Contact: linux-iio@vger.kernel.org
181Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000182 If known for a device, offset to be added to <type>[Y]_raw prior
183 to scaling by <type>[Y]_scale in order to obtain value in the
184 <type> units as specified in <type>[y]_raw documentation.
185 Not present if the offset is always 0 or unknown. If Y is not
186 present, then the offset applies to all in channels of <type>.
187 May be writable if a variable offset can be applied on the
188 device. Note that this is different to calibbias which
189 is for devices (or drivers) that apply offsets to compensate
190 for variation between different instances of the part, typically
191 adjusted by using some hardware supported calibration procedure.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100192
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000193What: /sys/bus/iio/devices/deviceX/inY_scale
194What: /sys/bus/iio/devices/deviceX/inY_supply_scale
195What: /sys/bus/iio/devices/deviceX/in_scale
Roland Stigge98069c32011-01-13 17:43:29 +0100196What: /sys/bus/iio/devices/deviceX/outY_scale
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000197What: /sys/bus/iio/devices/deviceX/accel_scale
198What: /sys/bus/iio/devices/deviceX/accel_peak_scale
199What: /sys/bus/iio/devices/deviceX/gyro_scale
200What: /sys/bus/iio/devices/deviceX/magn_scale
201What: /sys/bus/iio/devices/deviceX/magn_x_scale
202What: /sys/bus/iio/devices/deviceX/magn_y_scale
203What: /sys/bus/iio/devices/deviceX/magn_z_scale
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100204KernelVersion: 2.6.35
205Contact: linux-iio@vger.kernel.org
206Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000207 If known for a device, scale to be applied to <type>Y[_name]_raw
208 post addition of <type>[Y][_name]_offset in order to obtain the
209 measured value in <type> units as specified in
210 <type>[Y][_name]_raw documentation.. If shared across all in
211 channels then Y is not present and the value is called
212 <type>[Y][_name]_scale. The peak modifier means this value
213 is applied to <type>Y[_name]_peak_raw values.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100214
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000215What: /sys/bus/iio/devices/deviceX/accel_x_calibbias
216What: /sys/bus/iio/devices/deviceX/accel_y_calibbias
217What: /sys/bus/iio/devices/deviceX/accel_z_calibbias
218What: /sys/bus/iio/devices/deviceX/gyro_x_calibbias
219What: /sys/bus/iio/devices/deviceX/gyro_y_calibbias
220What: /sys/bus/iio/devices/deviceX/gyro_z_calibbias
221KernelVersion: 2.6.35
222Contact: linux-iio@vger.kernel.org
223Description:
224 Hardware applied calibration offset. (assumed to fix production
225 inaccuracies). If shared across all channels, <type>_calibbias
226 is used.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100227
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000228What /sys/bus/iio/devices/deviceX/inY_calibscale
229What /sys/bus/iio/devices/deviceX/inY_supply_calibscale
230What /sys/bus/iio/devices/deviceX/in_calibscale
231What /sys/bus/iio/devices/deviceX/accel_x_calibscale
232What /sys/bus/iio/devices/deviceX/accel_y_calibscale
233What /sys/bus/iio/devices/deviceX/accel_z_calibscale
234What /sys/bus/iio/devices/deviceX/gyro_x_calibscale
235What /sys/bus/iio/devices/deviceX/gyro_y_calibscale
236What /sys/bus/iio/devices/deviceX/gyro_z_calibscale
237KernelVersion: 2.6.35
238Contact: linux-iio@vger.kernel.org
239Description:
240 Hardware applied calibration scale factor. (assumed to fix
241 production inaccuracies). If shared across all channels,
242 <type>_calibscale is used.
243
244What: /sys/bus/iio/devices/deviceX/accel_scale_available
245KernelVersion: 2.635
246Contact: linux-iio@vger.kernel.org
247Description:
248 If a discrete set of scale values are available, they
249 are listed in this attribute.
250
Roland Stigge98069c32011-01-13 17:43:29 +0100251What: /sys/bus/iio/devices/deviceX/outY_raw
252KernelVersion: 2.6.37
253Contact: linux-iio@vger.kernel.org
254Description:
255 Raw (unscaled, no bias etc.) output voltage for
256 channel Y. The number must always be specified and
257 unique if the output corresponds to a single channel.
258
259What: /sys/bus/iio/devices/deviceX/outY&Z_raw
260KernelVersion: 2.6.37
261Contact: linux-iio@vger.kernel.org
262Description:
263 Raw (unscaled, no bias etc.) output voltage for an aggregate of
264 channel Y, channel Z, etc. This interface is available in cases
265 where a single output sets the value for multiple channels
266 simultaneously.
267
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000268What: /sys/bus/iio/devices/deviceX/deviceX:eventY
269KernelVersion: 2.6.35
270Contact: linux-iio@vger.kernel.org
271Description:
272 Configuration of which hardware generated events are passed up
273 to user-space.
274
275What: /sys/bus/iio/devices/deviceX:event/dev
276What: /sys/bus/iio/devices/deviceX:eventY/dev
277KernelVersion: 2.6.35
278Contact: linux-iio@vger.kernel.org
279Description:
280 major:minor character device numbers for the event line Y of
281 device X.
282
283What: /sys/.../deviceX:eventY/accel_x_thresh_rising_en
284What: /sys/.../deviceX:eventY/accel_x_thresh_falling_en
285What: /sys/.../deviceX:eventY/accel_y_thresh_rising_en
286What: /sys/.../deviceX:eventY/accel_y_thresh_falling_en
287What: /sys/.../deviceX:eventY/accel_z_thresh_rising_en
288What: /sys/.../deviceX:eventY/accel_z_thresh_falling_en
289What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_en
290What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_en
291What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_en
292What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_en
293What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_en
294What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_en
295What: /sys/.../deviceX:eventY/magn_x_thresh_rising_en
296What: /sys/.../deviceX:eventY/magn_x_thresh_falling_en
297What: /sys/.../deviceX:eventY/magn_y_thresh_rising_en
298What: /sys/.../deviceX:eventY/magn_y_thresh_falling_en
299What: /sys/.../deviceX:eventY/magn_z_thresh_rising_en
300What: /sys/.../deviceX:eventY/magn_z_thresh_falling_en
301What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_en
302What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_en
303What: /sys/.../deviceX:eventY/inZ_thresh_rising_en
304What: /sys/.../deviceX:eventY/inZ_thresh_falling_en
305What: /sys/.../deviceX:eventY/temp_thresh_rising_en
306What: /sys/.../deviceX:eventY/temp_thresh_falling_en
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100307KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100308Contact: linux-iio@vger.kernel.org
309Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000310 Event generated when channel passes a threshold in the specified
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100311 (_rising|_falling) direction. If the direction is not specified,
312 then either the device will report an event which ever direction
313 a single threshold value is called in (e.g.
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000314 <type>[Z][_name]_<raw|input>_thresh_value) or
315 <type>[Z][_name]_<raw|input>_thresh_rising_value and
316 <type>[Z][_name]_<raw|input>_thresh_falling_value may take
317 different values, but the device can only enable both thresholds
318 or neither.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100319 Note the driver will assume the last p events requested are
320 to be enabled where p is however many it supports (which may
321 vary depending on the exact set requested. So if you want to be
322 sure you have set what you think you have, check the contents of
323 these attributes after everything is configured. Drivers may
324 have to buffer any parameters so that they are consistent when
325 a given event type is enabled a future point (and not those for
326 whatever event was previously enabled).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100327
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000328What: /sys/.../deviceX:eventY/accel_x_roc_rising_en
329What: /sys/.../deviceX:eventY/accel_x_roc_falling_en
330What: /sys/.../deviceX:eventY/accel_y_roc_rising_en
331What: /sys/.../deviceX:eventY/accel_y_roc_falling_en
332What: /sys/.../deviceX:eventY/accel_z_roc_rising_en
333What: /sys/.../deviceX:eventY/accel_z_roc_falling_en
334What: /sys/.../deviceX:eventY/gyro_x_roc_rising_en
335What: /sys/.../deviceX:eventY/gyro_x_roc_falling_en
336What: /sys/.../deviceX:eventY/gyro_y_roc_rising_en
337What: /sys/.../deviceX:eventY/gyro_y_roc_falling_en
338What: /sys/.../deviceX:eventY/gyro_z_roc_rising_en
339What: /sys/.../deviceX:eventY/gyro_z_roc_falling_en
340What: /sys/.../deviceX:eventY/magn_x_roc_rising_en
341What: /sys/.../deviceX:eventY/magn_x_roc_falling_en
342What: /sys/.../deviceX:eventY/magn_y_roc_rising_en
343What: /sys/.../deviceX:eventY/magn_y_roc_falling_en
344What: /sys/.../deviceX:eventY/magn_z_roc_rising_en
345What: /sys/.../deviceX:eventY/magn_z_roc_falling_en
346What: /sys/.../deviceX:eventY/inZ_supply_roc_rising_en
347What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_en
348What: /sys/.../deviceX:eventY/inZ_roc_rising_en
349What: /sys/.../deviceX:eventY/inZ_roc_falling_en
350What: /sys/.../deviceX:eventY/temp_roc_rising_en
351What: /sys/.../deviceX:eventY/temp_roc_falling_en
352KernelVersion: 2.6.37
353Contact: linux-iio@vger.kernel.org
354Description:
355 Event generated when channel passes a threshold on the rate of
356 change (1st differential) in the specified (_rising|_falling)
357 direction. If the direction is not specified, then either the
358 device will report an event which ever direction a single
359 threshold value is called in (e.g.
360 <type>[Z][_name]_<raw|input>_roc_value) or
361 <type>[Z][_name]_<raw|input>_roc_rising_value and
362 <type>[Z][_name]_<raw|input>_roc_falling_value may take
363 different values, but the device can only enable both rate of
364 change thresholds or neither.
365 Note the driver will assume the last p events requested are
366 to be enabled where p is however many it supports (which may
367 vary depending on the exact set requested. So if you want to be
368 sure you have set what you think you have, check the contents of
369 these attributes after everything is configured. Drivers may
370 have to buffer any parameters so that they are consistent when
371 a given event type is enabled a future point (and not those for
372 whatever event was previously enabled).
373
374What: /sys/.../deviceX:eventY/accel_x_raw_thresh_rising_value
375What: /sys/.../deviceX:eventY/accel_x_raw_thresh_falling_value
376What: /sys/.../deviceX:eventY/accel_y_raw_thresh_rising_value
377What: /sys/.../deviceX:eventY/accel_y_raw_thresh_falling_value
378What: /sys/.../deviceX:eventY/accel_z_raw_thresh_rising_value
379What: /sys/.../deviceX:eventY/accel_z_raw_thresh_falling_value
380What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_rising_value
381What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_falling_value
382What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_rising_value
383What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_falling_value
384What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_rising_value
385What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_falling_value
386What: /sys/.../deviceX:eventY/magn_x_raw_thresh_rising_value
387What: /sys/.../deviceX:eventY/magn_x_raw_thresh_falling_value
388What: /sys/.../deviceX:eventY/magn_y_raw_thresh_rising_value
389What: /sys/.../deviceX:eventY/magn_y_raw_thresh_falling_value
390What: /sys/.../deviceX:eventY/magn_z_raw_thresh_rising_value
391What: /sys/.../deviceX:eventY/magn_z_raw_thresh_falling_value
392What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_rising_value
393What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_falling_value
394What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value
395What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value
396What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value
397What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100398KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100399Contact: linux-iio@vger.kernel.org
400Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100401 Specifies the value of threshold that the device is comparing
402 against for the events enabled by
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000403 <type>Z[_name]_thresh[_rising|falling]_en.
404 If separate attributes exist for the two directions, but
405 direction is not specified for this attribute, then a single
406 threshold value applies to both directions.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100407 The raw or input element of the name indicates whether the
408 value is in raw device units or in processed units (as _raw
409 and _input do on sysfs direct channel read attributes).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100410
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000411What: /sys/.../deviceX:eventY/accel_x_raw_roc_rising_value
412What: /sys/.../deviceX:eventY/accel_x_raw_roc_falling_value
413What: /sys/.../deviceX:eventY/accel_y_raw_roc_rising_value
414What: /sys/.../deviceX:eventY/accel_y_raw_roc_falling_value
415What: /sys/.../deviceX:eventY/accel_z_raw_roc_rising_value
416What: /sys/.../deviceX:eventY/accel_z_raw_roc_falling_value
417What: /sys/.../deviceX:eventY/gyro_x_raw_roc_rising_value
418What: /sys/.../deviceX:eventY/gyro_x_raw_roc_falling_value
419What: /sys/.../deviceX:eventY/gyro_y_raw_roc_rising_value
420What: /sys/.../deviceX:eventY/gyro_y_raw_roc_falling_value
421What: /sys/.../deviceX:eventY/gyro_z_raw_roc_rising_value
422What: /sys/.../deviceX:eventY/gyro_z_raw_roc_falling_value
423What: /sys/.../deviceX:eventY/magn_x_raw_roc_rising_value
424What: /sys/.../deviceX:eventY/magn_x_raw_roc_falling_value
425What: /sys/.../deviceX:eventY/magn_y_raw_roc_rising_value
426What: /sys/.../deviceX:eventY/magn_y_raw_roc_falling_value
427What: /sys/.../deviceX:eventY/magn_z_raw_roc_rising_value
428What: /sys/.../deviceX:eventY/magn_z_raw_roc_falling_value
429What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_rising_value
430What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_falling_value
431What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value
432What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value
433What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value
434What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100435KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100436Contact: linux-iio@vger.kernel.org
437Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000438 Specifies the value of rate of change threshold that the
439 device is comparing against for the events enabled by
440 <type>[Z][_name]_roc[_rising|falling]_en.
441 If separate attributes exist for the two directions,
442 but direction is not specified for this attribute,
443 then a single threshold value applies to both directions.
444 The raw or input element of the name indicates whether the
445 value is in raw device units or in processed units (as _raw
446 and _input do on sysfs direct channel read attributes).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100447
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000448What: /sys/.../deviceX:eventY/accel_x_thresh_rising_period
449What: /sys/.../deviceX:eventY/accel_x_thresh_falling_period
450hat: /sys/.../deviceX:eventY/accel_x_roc_rising_period
451What: /sys/.../deviceX:eventY/accel_x_roc_falling_period
452What: /sys/.../deviceX:eventY/accel_y_thresh_rising_period
453What: /sys/.../deviceX:eventY/accel_y_thresh_falling_period
454What: /sys/.../deviceX:eventY/accel_y_roc_rising_period
455What: /sys/.../deviceX:eventY/accel_y_roc_falling_period
456What: /sys/.../deviceX:eventY/accel_z_thresh_rising_period
457What: /sys/.../deviceX:eventY/accel_z_thresh_falling_period
458What: /sys/.../deviceX:eventY/accel_z_roc_rising_period
459What: /sys/.../deviceX:eventY/accel_z_roc_falling_period
460What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_period
461What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_period
462What: /sys/.../deviceX:eventY/gyro_x_roc_rising_period
463What: /sys/.../deviceX:eventY/gyro_x_roc_falling_period
464What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_period
465What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_period
466What: /sys/.../deviceX:eventY/gyro_y_roc_rising_period
467What: /sys/.../deviceX:eventY/gyro_y_roc_falling_period
468What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_period
469What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_period
470What: /sys/.../deviceX:eventY/gyro_z_roc_rising_period
471What: /sys/.../deviceX:eventY/gyro_z_roc_falling_period
472What: /sys/.../deviceX:eventY/magn_x_thresh_rising_period
473What: /sys/.../deviceX:eventY/magn_x_thresh_falling_period
474What: /sys/.../deviceX:eventY/magn_x_roc_rising_period
475What: /sys/.../deviceX:eventY/magn_x_roc_falling_period
476What: /sys/.../deviceX:eventY/magn_y_thresh_rising_period
477What: /sys/.../deviceX:eventY/magn_y_thresh_falling_period
478What: /sys/.../deviceX:eventY/magn_y_roc_rising_period
479What: /sys/.../deviceX:eventY/magn_y_roc_falling_period
480What: /sys/.../deviceX:eventY/magn_z_thresh_rising_period
481What: /sys/.../deviceX:eventY/magn_z_thresh_falling_period
482What: /sys/.../deviceX:eventY/magn_z_roc_rising_period
483What: /sys/.../deviceX:eventY/magn_z_roc_falling_period
484What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_period
485What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_period
486What: /sys/.../deviceX:eventY/inz_supply_roc_rising_period
487What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_period
488What: /sys/.../deviceX:eventY/inZ_thresh_rising_period
489What: /sys/.../deviceX:eventY/inZ_thresh_falling_period
490What: /sys/.../deviceX:eventY/inZ_roc_rising_period
491What: /sys/.../deviceX:eventY/inZ_roc_falling_period
492What: /sys/.../deviceX:eventY/temp_thresh_rising_period
493What: /sys/.../deviceX:eventY/temp_thresh_falling_period
494What: /sys/.../deviceX:eventY/temp_roc_rising_period
495What: /sys/.../deviceX:eventY/temp_roc_falling_period
496What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_period
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100497KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100498Contact: linux-iio@vger.kernel.org
499Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000500 Period of time (in seconds) for which the condition must be
501 met before an event is generated. If direction is not
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100502 specified then this period applies to both directions.
503
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000504What: /sys/.../deviceX:eventY/accel_mag_en
505What: /sys/.../deviceX:eventY/accel_mag_rising_en
506What: /sys/.../deviceX:eventY/accel_mag_falling_en
507What: /sys/.../deviceX:eventY/accel_x_mag_en
508What: /sys/.../deviceX:eventY/accel_x_mag_rising_en
509What: /sys/.../deviceX:eventY/accel_x_mag_falling_en
510What: /sys/.../deviceX:eventY/accel_y_mag_en
511What: /sys/.../deviceX:eventY/accel_y_mag_rising_en
512What: /sys/.../deviceX:eventY/accel_y_mag_falling_en
513What: /sys/.../deviceX:eventY/accel_z_mag_en
514What: /sys/.../deviceX:eventY/accel_z_mag_rising_en
515What: /sys/.../deviceX:eventY/accel_z_mag_falling_en
516What: /sys/.../deviceX:eventY/accel_x&y&z_mag_rising_en
517What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_en
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100518KernelVersion: 2.6.37
519Contact: linux-iio@vger.kernel.org
520Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000521 Similar to accel_x_thresh[_rising|_falling]_en, but here the
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100522 magnitude of the channel is compared to the threshold, not its
523 signed value.
524
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000525What: /sys/.../accel_raw_mag_value
526What: /sys/.../accel_x_raw_mag_rising_value
527What: /sys/.../accel_y_raw_mag_rising_value
528What: /sys/.../accel_z_raw_mag_rising_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100529KernelVersion: 2.6.37
530Contact: linux-iio@vger.kernel.org
531Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000532 The value to which the magnitude of the channel is compared. If
533 number or direction is not specified, applies to all channels of
534 this type.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100535
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000536What: /sys/bus/iio/devices/deviceX:buffer:event/dev
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100537KernelVersion: 2.6.35
538Contact: linux-iio@vger.kernel.org
539Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000540 Buffer for device X event character device major:minor numbers.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100541
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000542What: /sys/bus/iio/devices/deviceX:buffer:access/dev
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100543KernelVersion: 2.6.35
544Contact: linux-iio@vger.kernel.org
545Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000546 Buffer for device X access character device major:minor numbers.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100547
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000548What: /sys/bus/iio/devices/deviceX:buffer/trigger
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100549KernelVersion: 2.6.35
550Contact: linux-iio@vger.kernel.org
551Description:
552 The name of the trigger source being used, as per string given
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000553 in /sys/class/iio/triggerY/name.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100554
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000555What: /sys/bus/iio/devices/deviceX:buffer/length
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100556KernelVersion: 2.6.35
557Contact: linux-iio@vger.kernel.org
558Description:
559 Number of scans contained by the buffer.
560
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000561What: /sys/bus/iio/devices/deviceX:buffer/bytes_per_datum
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200562KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100563Contact: linux-iio@vger.kernel.org
564Description:
565 Bytes per scan. Due to alignment fun, the scan may be larger
566 than implied directly by the scan_element parameters.
567
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000568What: /sys/bus/iio/devices/deviceX:buffer/enable
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100569KernelVersion: 2.6.35
570Contact: linux-iio@vger.kernel.org
571Description:
572 Actually start the buffer capture up. Will start trigger
573 if first device and appropriate.
574
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000575What: /sys/bus/iio/devices/deviceX:buffer/scan_elements
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200576KernelVersion: 2.6.37
577Contact: linux-iio@vger.kernel.org
578Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100579 Directory containing interfaces for elements that will be
580 captured for a single triggered sample set in the buffer.
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200581
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000582What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_en
583What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_en
584What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_en
585What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_en
586What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_en
587What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_en
588What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_en
589What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_en
590What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_en
591What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/timestamp_en
592What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_supply_en
593What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_en
594What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY-inZ_en
595What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_en
596What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_en
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200597KernelVersion: 2.6.37
598Contact: linux-iio@vger.kernel.org
599Description:
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100600 Scan element control for triggered data capture.
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200601
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000602What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_type
603What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_type
604What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_type
605What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_type
606What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_type
607What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/in-in_type
608What: /sys/.../deviceX:buffer/scan_elements/inY_supply_type
609What: /sys/.../deviceX:buffer/scan_elements/timestamp_type
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200610KernelVersion: 2.6.37
611Contact: linux-iio@vger.kernel.org
612Description:
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100613 Description of the scan element data storage within the buffer
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000614 and hence the form in which it is read from user-space.
615 Form is [s|u]bits/storagebits[>>shift]. s or u specifies if
616 signed (2's complement) or unsigned. bits is the number of bits
617 of data and storagebits is the space (after padding) that it
618 occupies in the buffer. shift if specified, is the shift that
619 needs to be applied prior to masking out unused bits. Some
620 devices put their data in the middle of the transferred elements
621 with additional information on both sides. Note that some
622 devices will have additional information in the unused bits
623 so to get a clean value, the bits value must be used to mask
624 the buffer output value appropriately. The storagebits value
625 also specifies the data alignment. So s48/64>>2 will be a
626 signed 48 bit integer stored in a 64 bit location aligned to
627 a a64 bit boundary. To obtain the clean value, shift right 2
628 and apply a mask to zero the top 16 bits of the result.
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100629 For other storage combinations this attribute will be extended
630 appropriately.
631
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000632What: /sys/.../deviceX:buffer/scan_elements/accel_type_available
633KernelVersion: 2.6.37
634Contact: linux-iio@vger.kernel.org
635Description:
636 If the type parameter can take one of a small set of values,
637 this attribute lists them.
638
639What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_index
640What: /sys/.../deviceX:buffer/scan_elements/inY_supply_index
641What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_index
642What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_index
643What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_index
644What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_index
645What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_index
646What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_index
647What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_index
648What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_index
649What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_index
650What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_index
651What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_index
652What: /sys/.../deviceX:buffer/scan_elements/timestamp_index
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100653KernelVersion: 2.6.37
654Contact: linux-iio@vger.kernel.org
655Description:
656 A single positive integer specifying the position of this
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000657 scan element in the buffer. Note these are not dependent on
658 what is enabled and may not be contiguous. Thus for user-space
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100659 to establish the full layout these must be used in conjunction
660 with all _en attributes to establish which channels are present,
661 and the relevant _type attributes to establish the data storage
662 format.