blob: 4915aee14d881769f2fb3d5ce6bfadb218e2f52f [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
Michael Hennerich7c31b982011-02-24 12:32:45 +0100114What: /sys/bus/iio/devices/deviceX/tempX_input
115KernelVersion: 2.6.38
116Contact: linux-iio@vger.kernel.org
117Description:
118 Scaled temperature measurement in milli degrees Celsius.
119
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000120What: /sys/bus/iio/devices/deviceX/accel_x_raw
121What: /sys/bus/iio/devices/deviceX/accel_y_raw
122What: /sys/bus/iio/devices/deviceX/accel_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100123KernelVersion: 2.6.35
124Contact: linux-iio@vger.kernel.org
125Description:
126 Acceleration in direction x, y or z (may be arbitrarily assigned
127 but should match other such assignments on device)
128 channel m (not present if only one accelerometer channel at
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100129 this orientation). Has all of the equivalent parameters as per
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000130 inY. Units after application of scale and offset are m/s^2.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100131
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000132What: /sys/bus/iio/devices/deviceX/gyro_x_raw
133What: /sys/bus/iio/devices/deviceX/gyro_y_raw
134What: /sys/bus/iio/devices/deviceX/gyro_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100135KernelVersion: 2.6.35
136Contact: linux-iio@vger.kernel.org
137Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100138 Angular velocity about axis x, y or z (may be arbitrarily
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000139 assigned) Data converted by application of offset then scale to
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100140 radians per second. Has all the equivalent parameters as
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000141 per inY.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100142
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000143What: /sys/bus/iio/devices/deviceX/incli_x_raw
144What: /sys/bus/iio/devices/deviceX/incli_y_raw
145What: /sys/bus/iio/devices/deviceX/incli_z_raw
Jonathan Camerone5107fb2010-05-07 15:38:57 +0100146KernelVersion: 2.6.35
147Contact: linux-iio@vger.kernel.org
148Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000149 Inclination raw reading about axis x, y or z (may be
150 arbitrarily assigned). Data converted by application of offset
Jonathan Camerone5107fb2010-05-07 15:38:57 +0100151 and scale to Degrees.
152
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000153What: /sys/bus/iio/devices/deviceX/magn_x_raw
154What: /sys/bus/iio/devices/deviceX/magn_y_raw
155What: /sys/bus/iio/devices/deviceX/magn_z_raw
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100156KernelVersion: 2.6.35
157Contact: linux-iio@vger.kernel.org
158Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100159 Magnetic field along axis x, y or z (may be arbitrarily
160 assigned) channel m (not present if only one magnetometer
161 at this orientation). Data converted by application of
162 offset then scale to Gauss. Has all the equivalent modifiers
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000163 as per inY.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100164
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000165What: /sys/bus/iio/devices/deviceX/accel_x_peak_raw
166What: /sys/bus/iio/devices/deviceX/accel_y_peak_raw
167What: /sys/bus/iio/devices/deviceX/accel_z_peak_raw
168KernelVersion: 2.6.36
169Contact: linux-iio@vger.kernel.org
170Description:
171 Some devices provide a store of the highest value seen since
172 some reset condition. These attributes allow access to this
173 and are otherwise the direct equivalent of the
174 <type>Y[_name]_raw attributes.
175
176What: /sys/bus/iio/devices/deviceX/accel_xyz_squared_peak_raw
177KernelVersion: 2.6.36
178Contact: linux-iio@vger.kernel.org
179Description:
180 A computed peak value based on the sum squared magnitude of
181 the underlying value in the specified directions.
182
183What: /sys/bus/iio/devices/deviceX/accel_offset
184What: /sys/bus/iio/devices/deviceX/temp_offset
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100185KernelVersion: 2.6.35
186Contact: linux-iio@vger.kernel.org
187Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000188 If known for a device, offset to be added to <type>[Y]_raw prior
189 to scaling by <type>[Y]_scale in order to obtain value in the
190 <type> units as specified in <type>[y]_raw documentation.
191 Not present if the offset is always 0 or unknown. If Y is not
192 present, then the offset applies to all in channels of <type>.
193 May be writable if a variable offset can be applied on the
194 device. Note that this is different to calibbias which
195 is for devices (or drivers) that apply offsets to compensate
196 for variation between different instances of the part, typically
197 adjusted by using some hardware supported calibration procedure.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100198
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000199What: /sys/bus/iio/devices/deviceX/inY_scale
200What: /sys/bus/iio/devices/deviceX/inY_supply_scale
201What: /sys/bus/iio/devices/deviceX/in_scale
Roland Stigge98069c32011-01-13 17:43:29 +0100202What: /sys/bus/iio/devices/deviceX/outY_scale
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000203What: /sys/bus/iio/devices/deviceX/accel_scale
204What: /sys/bus/iio/devices/deviceX/accel_peak_scale
205What: /sys/bus/iio/devices/deviceX/gyro_scale
206What: /sys/bus/iio/devices/deviceX/magn_scale
207What: /sys/bus/iio/devices/deviceX/magn_x_scale
208What: /sys/bus/iio/devices/deviceX/magn_y_scale
209What: /sys/bus/iio/devices/deviceX/magn_z_scale
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100210KernelVersion: 2.6.35
211Contact: linux-iio@vger.kernel.org
212Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000213 If known for a device, scale to be applied to <type>Y[_name]_raw
214 post addition of <type>[Y][_name]_offset in order to obtain the
215 measured value in <type> units as specified in
216 <type>[Y][_name]_raw documentation.. If shared across all in
217 channels then Y is not present and the value is called
218 <type>[Y][_name]_scale. The peak modifier means this value
219 is applied to <type>Y[_name]_peak_raw values.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100220
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000221What: /sys/bus/iio/devices/deviceX/accel_x_calibbias
222What: /sys/bus/iio/devices/deviceX/accel_y_calibbias
223What: /sys/bus/iio/devices/deviceX/accel_z_calibbias
224What: /sys/bus/iio/devices/deviceX/gyro_x_calibbias
225What: /sys/bus/iio/devices/deviceX/gyro_y_calibbias
226What: /sys/bus/iio/devices/deviceX/gyro_z_calibbias
227KernelVersion: 2.6.35
228Contact: linux-iio@vger.kernel.org
229Description:
230 Hardware applied calibration offset. (assumed to fix production
231 inaccuracies). If shared across all channels, <type>_calibbias
232 is used.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100233
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000234What /sys/bus/iio/devices/deviceX/inY_calibscale
235What /sys/bus/iio/devices/deviceX/inY_supply_calibscale
236What /sys/bus/iio/devices/deviceX/in_calibscale
237What /sys/bus/iio/devices/deviceX/accel_x_calibscale
238What /sys/bus/iio/devices/deviceX/accel_y_calibscale
239What /sys/bus/iio/devices/deviceX/accel_z_calibscale
240What /sys/bus/iio/devices/deviceX/gyro_x_calibscale
241What /sys/bus/iio/devices/deviceX/gyro_y_calibscale
242What /sys/bus/iio/devices/deviceX/gyro_z_calibscale
243KernelVersion: 2.6.35
244Contact: linux-iio@vger.kernel.org
245Description:
246 Hardware applied calibration scale factor. (assumed to fix
247 production inaccuracies). If shared across all channels,
248 <type>_calibscale is used.
249
250What: /sys/bus/iio/devices/deviceX/accel_scale_available
251KernelVersion: 2.635
252Contact: linux-iio@vger.kernel.org
253Description:
254 If a discrete set of scale values are available, they
255 are listed in this attribute.
256
Roland Stigge98069c32011-01-13 17:43:29 +0100257What: /sys/bus/iio/devices/deviceX/outY_raw
258KernelVersion: 2.6.37
259Contact: linux-iio@vger.kernel.org
260Description:
261 Raw (unscaled, no bias etc.) output voltage for
262 channel Y. The number must always be specified and
263 unique if the output corresponds to a single channel.
264
265What: /sys/bus/iio/devices/deviceX/outY&Z_raw
266KernelVersion: 2.6.37
267Contact: linux-iio@vger.kernel.org
268Description:
269 Raw (unscaled, no bias etc.) output voltage for an aggregate of
270 channel Y, channel Z, etc. This interface is available in cases
271 where a single output sets the value for multiple channels
272 simultaneously.
273
Michael Hennerich14f88f12011-03-09 16:01:45 +0100274What: /sys/bus/iio/devices/deviceX/outY_powerdown_mode
275What: /sys/bus/iio/devices/deviceX/out_powerdown_mode
276KernelVersion: 2.6.38
277Contact: linux-iio@vger.kernel.org
278Description:
279 Specifies the output powerdown mode.
280 DAC output stage is disconnected from the amplifier and
281 1kohm_to_gnd: connected to ground via an 1kOhm resistor
282 100kohm_to_gnd: connected to ground via an 100kOhm resistor
283 three_state: left floating
284 For a list of available output power down options read
285 outX_powerdown_mode_available. If Y is not present the
286 mode is shared across all outputs.
287
288What: /sys/bus/iio/devices/deviceX/outY_powerdown_mode_available
289What: /sys/bus/iio/devices/deviceX/out_powerdown_mode_available
290KernelVersion: 2.6.38
291Contact: linux-iio@vger.kernel.org
292Description:
293 Lists all available output power down modes.
294 If Y is not present the mode is shared across all outputs.
295
296What: /sys/bus/iio/devices/deviceX/outY_powerdown
297What: /sys/bus/iio/devices/deviceX/out_powerdown
298KernelVersion: 2.6.38
299Contact: linux-iio@vger.kernel.org
300Description:
301 Writing 1 causes output Y to enter the power down mode specified
302 by the corresponding outY_powerdown_mode. Clearing returns to
303 normal operation. Y may be suppressed if all outputs are
304 controlled together.
305
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000306What: /sys/bus/iio/devices/deviceX/deviceX:eventY
307KernelVersion: 2.6.35
308Contact: linux-iio@vger.kernel.org
309Description:
310 Configuration of which hardware generated events are passed up
311 to user-space.
312
313What: /sys/bus/iio/devices/deviceX:event/dev
314What: /sys/bus/iio/devices/deviceX:eventY/dev
315KernelVersion: 2.6.35
316Contact: linux-iio@vger.kernel.org
317Description:
318 major:minor character device numbers for the event line Y of
319 device X.
320
321What: /sys/.../deviceX:eventY/accel_x_thresh_rising_en
322What: /sys/.../deviceX:eventY/accel_x_thresh_falling_en
323What: /sys/.../deviceX:eventY/accel_y_thresh_rising_en
324What: /sys/.../deviceX:eventY/accel_y_thresh_falling_en
325What: /sys/.../deviceX:eventY/accel_z_thresh_rising_en
326What: /sys/.../deviceX:eventY/accel_z_thresh_falling_en
327What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_en
328What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_en
329What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_en
330What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_en
331What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_en
332What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_en
333What: /sys/.../deviceX:eventY/magn_x_thresh_rising_en
334What: /sys/.../deviceX:eventY/magn_x_thresh_falling_en
335What: /sys/.../deviceX:eventY/magn_y_thresh_rising_en
336What: /sys/.../deviceX:eventY/magn_y_thresh_falling_en
337What: /sys/.../deviceX:eventY/magn_z_thresh_rising_en
338What: /sys/.../deviceX:eventY/magn_z_thresh_falling_en
339What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_en
340What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_en
341What: /sys/.../deviceX:eventY/inZ_thresh_rising_en
342What: /sys/.../deviceX:eventY/inZ_thresh_falling_en
343What: /sys/.../deviceX:eventY/temp_thresh_rising_en
344What: /sys/.../deviceX:eventY/temp_thresh_falling_en
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100345KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100346Contact: linux-iio@vger.kernel.org
347Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000348 Event generated when channel passes a threshold in the specified
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100349 (_rising|_falling) direction. If the direction is not specified,
350 then either the device will report an event which ever direction
351 a single threshold value is called in (e.g.
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000352 <type>[Z][_name]_<raw|input>_thresh_value) or
353 <type>[Z][_name]_<raw|input>_thresh_rising_value and
354 <type>[Z][_name]_<raw|input>_thresh_falling_value may take
355 different values, but the device can only enable both thresholds
356 or neither.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100357 Note the driver will assume the last p events requested are
358 to be enabled where p is however many it supports (which may
359 vary depending on the exact set requested. So if you want to be
360 sure you have set what you think you have, check the contents of
361 these attributes after everything is configured. Drivers may
362 have to buffer any parameters so that they are consistent when
363 a given event type is enabled a future point (and not those for
364 whatever event was previously enabled).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100365
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000366What: /sys/.../deviceX:eventY/accel_x_roc_rising_en
367What: /sys/.../deviceX:eventY/accel_x_roc_falling_en
368What: /sys/.../deviceX:eventY/accel_y_roc_rising_en
369What: /sys/.../deviceX:eventY/accel_y_roc_falling_en
370What: /sys/.../deviceX:eventY/accel_z_roc_rising_en
371What: /sys/.../deviceX:eventY/accel_z_roc_falling_en
372What: /sys/.../deviceX:eventY/gyro_x_roc_rising_en
373What: /sys/.../deviceX:eventY/gyro_x_roc_falling_en
374What: /sys/.../deviceX:eventY/gyro_y_roc_rising_en
375What: /sys/.../deviceX:eventY/gyro_y_roc_falling_en
376What: /sys/.../deviceX:eventY/gyro_z_roc_rising_en
377What: /sys/.../deviceX:eventY/gyro_z_roc_falling_en
378What: /sys/.../deviceX:eventY/magn_x_roc_rising_en
379What: /sys/.../deviceX:eventY/magn_x_roc_falling_en
380What: /sys/.../deviceX:eventY/magn_y_roc_rising_en
381What: /sys/.../deviceX:eventY/magn_y_roc_falling_en
382What: /sys/.../deviceX:eventY/magn_z_roc_rising_en
383What: /sys/.../deviceX:eventY/magn_z_roc_falling_en
384What: /sys/.../deviceX:eventY/inZ_supply_roc_rising_en
385What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_en
386What: /sys/.../deviceX:eventY/inZ_roc_rising_en
387What: /sys/.../deviceX:eventY/inZ_roc_falling_en
388What: /sys/.../deviceX:eventY/temp_roc_rising_en
389What: /sys/.../deviceX:eventY/temp_roc_falling_en
390KernelVersion: 2.6.37
391Contact: linux-iio@vger.kernel.org
392Description:
393 Event generated when channel passes a threshold on the rate of
394 change (1st differential) in the specified (_rising|_falling)
395 direction. If the direction is not specified, then either the
396 device will report an event which ever direction a single
397 threshold value is called in (e.g.
398 <type>[Z][_name]_<raw|input>_roc_value) or
399 <type>[Z][_name]_<raw|input>_roc_rising_value and
400 <type>[Z][_name]_<raw|input>_roc_falling_value may take
401 different values, but the device can only enable both rate of
402 change thresholds or neither.
403 Note the driver will assume the last p events requested are
404 to be enabled where p is however many it supports (which may
405 vary depending on the exact set requested. So if you want to be
406 sure you have set what you think you have, check the contents of
407 these attributes after everything is configured. Drivers may
408 have to buffer any parameters so that they are consistent when
409 a given event type is enabled a future point (and not those for
410 whatever event was previously enabled).
411
412What: /sys/.../deviceX:eventY/accel_x_raw_thresh_rising_value
413What: /sys/.../deviceX:eventY/accel_x_raw_thresh_falling_value
414What: /sys/.../deviceX:eventY/accel_y_raw_thresh_rising_value
415What: /sys/.../deviceX:eventY/accel_y_raw_thresh_falling_value
416What: /sys/.../deviceX:eventY/accel_z_raw_thresh_rising_value
417What: /sys/.../deviceX:eventY/accel_z_raw_thresh_falling_value
418What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_rising_value
419What: /sys/.../deviceX:eventY/gyro_x_raw_thresh_falling_value
420What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_rising_value
421What: /sys/.../deviceX:eventY/gyro_y_raw_thresh_falling_value
422What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_rising_value
423What: /sys/.../deviceX:eventY/gyro_z_raw_thresh_falling_value
424What: /sys/.../deviceX:eventY/magn_x_raw_thresh_rising_value
425What: /sys/.../deviceX:eventY/magn_x_raw_thresh_falling_value
426What: /sys/.../deviceX:eventY/magn_y_raw_thresh_rising_value
427What: /sys/.../deviceX:eventY/magn_y_raw_thresh_falling_value
428What: /sys/.../deviceX:eventY/magn_z_raw_thresh_rising_value
429What: /sys/.../deviceX:eventY/magn_z_raw_thresh_falling_value
430What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_rising_value
431What: /sys/.../deviceX:eventY/inZ_supply_raw_thresh_falling_value
432What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value
433What: /sys/.../deviceX:eventY/inZ_raw_thresh_falling_value
434What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value
435What: /sys/.../deviceX:eventY/temp_raw_thresh_falling_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100436KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100437Contact: linux-iio@vger.kernel.org
438Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100439 Specifies the value of threshold that the device is comparing
440 against for the events enabled by
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000441 <type>Z[_name]_thresh[_rising|falling]_en.
442 If separate attributes exist for the two directions, but
443 direction is not specified for this attribute, then a single
444 threshold value applies to both directions.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100445 The raw or input element of the name indicates whether the
446 value is in raw device units or in processed units (as _raw
447 and _input do on sysfs direct channel read attributes).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100448
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000449What: /sys/.../deviceX:eventY/accel_x_raw_roc_rising_value
450What: /sys/.../deviceX:eventY/accel_x_raw_roc_falling_value
451What: /sys/.../deviceX:eventY/accel_y_raw_roc_rising_value
452What: /sys/.../deviceX:eventY/accel_y_raw_roc_falling_value
453What: /sys/.../deviceX:eventY/accel_z_raw_roc_rising_value
454What: /sys/.../deviceX:eventY/accel_z_raw_roc_falling_value
455What: /sys/.../deviceX:eventY/gyro_x_raw_roc_rising_value
456What: /sys/.../deviceX:eventY/gyro_x_raw_roc_falling_value
457What: /sys/.../deviceX:eventY/gyro_y_raw_roc_rising_value
458What: /sys/.../deviceX:eventY/gyro_y_raw_roc_falling_value
459What: /sys/.../deviceX:eventY/gyro_z_raw_roc_rising_value
460What: /sys/.../deviceX:eventY/gyro_z_raw_roc_falling_value
461What: /sys/.../deviceX:eventY/magn_x_raw_roc_rising_value
462What: /sys/.../deviceX:eventY/magn_x_raw_roc_falling_value
463What: /sys/.../deviceX:eventY/magn_y_raw_roc_rising_value
464What: /sys/.../deviceX:eventY/magn_y_raw_roc_falling_value
465What: /sys/.../deviceX:eventY/magn_z_raw_roc_rising_value
466What: /sys/.../deviceX:eventY/magn_z_raw_roc_falling_value
467What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_rising_value
468What: /sys/.../deviceX:eventY/inZ_supply_raw_roc_falling_value
469What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value
470What: /sys/.../deviceX:eventY/inZ_raw_roc_falling_value
471What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value
472What: /sys/.../deviceX:eventY/temp_raw_roc_falling_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100473KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100474Contact: linux-iio@vger.kernel.org
475Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000476 Specifies the value of rate of change threshold that the
477 device is comparing against for the events enabled by
478 <type>[Z][_name]_roc[_rising|falling]_en.
479 If separate attributes exist for the two directions,
480 but direction is not specified for this attribute,
481 then a single threshold value applies to both directions.
482 The raw or input element of the name indicates whether the
483 value is in raw device units or in processed units (as _raw
484 and _input do on sysfs direct channel read attributes).
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100485
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000486What: /sys/.../deviceX:eventY/accel_x_thresh_rising_period
487What: /sys/.../deviceX:eventY/accel_x_thresh_falling_period
488hat: /sys/.../deviceX:eventY/accel_x_roc_rising_period
489What: /sys/.../deviceX:eventY/accel_x_roc_falling_period
490What: /sys/.../deviceX:eventY/accel_y_thresh_rising_period
491What: /sys/.../deviceX:eventY/accel_y_thresh_falling_period
492What: /sys/.../deviceX:eventY/accel_y_roc_rising_period
493What: /sys/.../deviceX:eventY/accel_y_roc_falling_period
494What: /sys/.../deviceX:eventY/accel_z_thresh_rising_period
495What: /sys/.../deviceX:eventY/accel_z_thresh_falling_period
496What: /sys/.../deviceX:eventY/accel_z_roc_rising_period
497What: /sys/.../deviceX:eventY/accel_z_roc_falling_period
498What: /sys/.../deviceX:eventY/gyro_x_thresh_rising_period
499What: /sys/.../deviceX:eventY/gyro_x_thresh_falling_period
500What: /sys/.../deviceX:eventY/gyro_x_roc_rising_period
501What: /sys/.../deviceX:eventY/gyro_x_roc_falling_period
502What: /sys/.../deviceX:eventY/gyro_y_thresh_rising_period
503What: /sys/.../deviceX:eventY/gyro_y_thresh_falling_period
504What: /sys/.../deviceX:eventY/gyro_y_roc_rising_period
505What: /sys/.../deviceX:eventY/gyro_y_roc_falling_period
506What: /sys/.../deviceX:eventY/gyro_z_thresh_rising_period
507What: /sys/.../deviceX:eventY/gyro_z_thresh_falling_period
508What: /sys/.../deviceX:eventY/gyro_z_roc_rising_period
509What: /sys/.../deviceX:eventY/gyro_z_roc_falling_period
510What: /sys/.../deviceX:eventY/magn_x_thresh_rising_period
511What: /sys/.../deviceX:eventY/magn_x_thresh_falling_period
512What: /sys/.../deviceX:eventY/magn_x_roc_rising_period
513What: /sys/.../deviceX:eventY/magn_x_roc_falling_period
514What: /sys/.../deviceX:eventY/magn_y_thresh_rising_period
515What: /sys/.../deviceX:eventY/magn_y_thresh_falling_period
516What: /sys/.../deviceX:eventY/magn_y_roc_rising_period
517What: /sys/.../deviceX:eventY/magn_y_roc_falling_period
518What: /sys/.../deviceX:eventY/magn_z_thresh_rising_period
519What: /sys/.../deviceX:eventY/magn_z_thresh_falling_period
520What: /sys/.../deviceX:eventY/magn_z_roc_rising_period
521What: /sys/.../deviceX:eventY/magn_z_roc_falling_period
522What: /sys/.../deviceX:eventY/inZ_supply_thresh_rising_period
523What: /sys/.../deviceX:eventY/inZ_supply_thresh_falling_period
524What: /sys/.../deviceX:eventY/inz_supply_roc_rising_period
525What: /sys/.../deviceX:eventY/inZ_supply_roc_falling_period
526What: /sys/.../deviceX:eventY/inZ_thresh_rising_period
527What: /sys/.../deviceX:eventY/inZ_thresh_falling_period
528What: /sys/.../deviceX:eventY/inZ_roc_rising_period
529What: /sys/.../deviceX:eventY/inZ_roc_falling_period
530What: /sys/.../deviceX:eventY/temp_thresh_rising_period
531What: /sys/.../deviceX:eventY/temp_thresh_falling_period
532What: /sys/.../deviceX:eventY/temp_roc_rising_period
533What: /sys/.../deviceX:eventY/temp_roc_falling_period
534What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_period
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100535KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100536Contact: linux-iio@vger.kernel.org
537Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000538 Period of time (in seconds) for which the condition must be
539 met before an event is generated. If direction is not
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100540 specified then this period applies to both directions.
541
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000542What: /sys/.../deviceX:eventY/accel_mag_en
543What: /sys/.../deviceX:eventY/accel_mag_rising_en
544What: /sys/.../deviceX:eventY/accel_mag_falling_en
545What: /sys/.../deviceX:eventY/accel_x_mag_en
546What: /sys/.../deviceX:eventY/accel_x_mag_rising_en
547What: /sys/.../deviceX:eventY/accel_x_mag_falling_en
548What: /sys/.../deviceX:eventY/accel_y_mag_en
549What: /sys/.../deviceX:eventY/accel_y_mag_rising_en
550What: /sys/.../deviceX:eventY/accel_y_mag_falling_en
551What: /sys/.../deviceX:eventY/accel_z_mag_en
552What: /sys/.../deviceX:eventY/accel_z_mag_rising_en
553What: /sys/.../deviceX:eventY/accel_z_mag_falling_en
554What: /sys/.../deviceX:eventY/accel_x&y&z_mag_rising_en
555What: /sys/.../deviceX:eventY/accel_x&y&z_mag_falling_en
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100556KernelVersion: 2.6.37
557Contact: linux-iio@vger.kernel.org
558Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000559 Similar to accel_x_thresh[_rising|_falling]_en, but here the
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100560 magnitude of the channel is compared to the threshold, not its
561 signed value.
562
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000563What: /sys/.../accel_raw_mag_value
564What: /sys/.../accel_x_raw_mag_rising_value
565What: /sys/.../accel_y_raw_mag_rising_value
566What: /sys/.../accel_z_raw_mag_rising_value
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100567KernelVersion: 2.6.37
568Contact: linux-iio@vger.kernel.org
569Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000570 The value to which the magnitude of the channel is compared. If
571 number or direction is not specified, applies to all channels of
572 this type.
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100573
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000574What: /sys/bus/iio/devices/deviceX:buffer:event/dev
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100575KernelVersion: 2.6.35
576Contact: linux-iio@vger.kernel.org
577Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000578 Buffer for device X event character device major:minor numbers.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100579
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000580What: /sys/bus/iio/devices/deviceX:buffer:access/dev
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100581KernelVersion: 2.6.35
582Contact: linux-iio@vger.kernel.org
583Description:
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000584 Buffer for device X access character device major:minor numbers.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100585
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000586What: /sys/bus/iio/devices/deviceX:buffer/trigger
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100587KernelVersion: 2.6.35
588Contact: linux-iio@vger.kernel.org
589Description:
590 The name of the trigger source being used, as per string given
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000591 in /sys/class/iio/triggerY/name.
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100592
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000593What: /sys/bus/iio/devices/deviceX:buffer/length
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100594KernelVersion: 2.6.35
595Contact: linux-iio@vger.kernel.org
596Description:
597 Number of scans contained by the buffer.
598
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000599What: /sys/bus/iio/devices/deviceX:buffer/bytes_per_datum
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200600KernelVersion: 2.6.37
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100601Contact: linux-iio@vger.kernel.org
602Description:
603 Bytes per scan. Due to alignment fun, the scan may be larger
604 than implied directly by the scan_element parameters.
605
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000606What: /sys/bus/iio/devices/deviceX:buffer/enable
Jonathan Camerone34d2c52010-05-04 14:43:05 +0100607KernelVersion: 2.6.35
608Contact: linux-iio@vger.kernel.org
609Description:
610 Actually start the buffer capture up. Will start trigger
611 if first device and appropriate.
612
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000613What: /sys/bus/iio/devices/deviceX:buffer/scan_elements
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200614KernelVersion: 2.6.37
615Contact: linux-iio@vger.kernel.org
616Description:
Jonathan Cameron2f3cc662010-10-08 12:14:12 +0100617 Directory containing interfaces for elements that will be
618 captured for a single triggered sample set in the buffer.
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200619
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000620What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_en
621What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_en
622What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_en
623What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_en
624What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_en
625What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_en
626What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_en
627What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_en
628What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_en
629What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/timestamp_en
630What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_supply_en
631What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_en
632What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY-inZ_en
633What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_en
634What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_en
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200635KernelVersion: 2.6.37
636Contact: linux-iio@vger.kernel.org
637Description:
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100638 Scan element control for triggered data capture.
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200639
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000640What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_type
641What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_type
642What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_type
643What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_type
644What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_type
645What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/in-in_type
646What: /sys/.../deviceX:buffer/scan_elements/inY_supply_type
647What: /sys/.../deviceX:buffer/scan_elements/timestamp_type
Manuel Stahl5770b8f2010-08-31 11:32:53 +0200648KernelVersion: 2.6.37
649Contact: linux-iio@vger.kernel.org
650Description:
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100651 Description of the scan element data storage within the buffer
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000652 and hence the form in which it is read from user-space.
653 Form is [s|u]bits/storagebits[>>shift]. s or u specifies if
654 signed (2's complement) or unsigned. bits is the number of bits
655 of data and storagebits is the space (after padding) that it
656 occupies in the buffer. shift if specified, is the shift that
657 needs to be applied prior to masking out unused bits. Some
658 devices put their data in the middle of the transferred elements
659 with additional information on both sides. Note that some
660 devices will have additional information in the unused bits
661 so to get a clean value, the bits value must be used to mask
662 the buffer output value appropriately. The storagebits value
663 also specifies the data alignment. So s48/64>>2 will be a
664 signed 48 bit integer stored in a 64 bit location aligned to
665 a a64 bit boundary. To obtain the clean value, shift right 2
666 and apply a mask to zero the top 16 bits of the result.
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100667 For other storage combinations this attribute will be extended
668 appropriately.
669
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000670What: /sys/.../deviceX:buffer/scan_elements/accel_type_available
671KernelVersion: 2.6.37
672Contact: linux-iio@vger.kernel.org
673Description:
674 If the type parameter can take one of a small set of values,
675 this attribute lists them.
676
677What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/inY_index
678What: /sys/.../deviceX:buffer/scan_elements/inY_supply_index
679What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_x_index
680What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_y_index
681What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/accel_z_index
682What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_x_index
683What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_y_index
684What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/gyro_z_index
685What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_x_index
686What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_y_index
687What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/magn_z_index
688What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_x_index
689What: /sys/bus/iio/devices/deviceX:buffer/scan_elements/incli_y_index
690What: /sys/.../deviceX:buffer/scan_elements/timestamp_index
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100691KernelVersion: 2.6.37
692Contact: linux-iio@vger.kernel.org
693Description:
694 A single positive integer specifying the position of this
Jonathan Cameronf386caa2010-11-22 23:31:16 +0000695 scan element in the buffer. Note these are not dependent on
696 what is enabled and may not be contiguous. Thus for user-space
Jonathan Cameron10ba8ea2010-09-21 14:41:08 +0100697 to establish the full layout these must be used in conjunction
698 with all _en attributes to establish which channels are present,
699 and the relevant _type attributes to establish the data storage
700 format.