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