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