1 What: /sys/bus/iio/devices/iio:devic 1 What: /sys/bus/iio/devices/iio:deviceX/buffer/length
2 KernelVersion: 2.6.35 2 KernelVersion: 2.6.35
3 Contact: linux-iio@vger.kernel.org 3 Contact: linux-iio@vger.kernel.org
4 Description: 4 Description:
5 Number of scans contained by t 5 Number of scans contained by the buffer.
6 6
7 Since Kernel 5.11, multiple bu 7 Since Kernel 5.11, multiple buffers are supported.
8 so, it is better to use, inste 8 so, it is better to use, instead:
9 9
10 /sys/bus/iio/devices/i 10 /sys/bus/iio/devices/iio:deviceX/bufferY/length
11 11
12 What: /sys/bus/iio/devices/iio:devic 12 What: /sys/bus/iio/devices/iio:deviceX/buffer/enable
13 KernelVersion: 2.6.35 13 KernelVersion: 2.6.35
14 Contact: linux-iio@vger.kernel.org 14 Contact: linux-iio@vger.kernel.org
15 Description: 15 Description:
16 Actually start the buffer capt 16 Actually start the buffer capture up. Will start trigger
17 if first device and appropriat 17 if first device and appropriate.
18 18
19 Since Kernel 5.11, multiple bu 19 Since Kernel 5.11, multiple buffers are supported.
20 so, it is better to use, inste 20 so, it is better to use, instead:
21 21
22 /sys/bus/iio/devices/i 22 /sys/bus/iio/devices/iio:deviceX/bufferY/enable
23 23
24 What: /sys/bus/iio/devices/iio:devic 24 What: /sys/bus/iio/devices/iio:deviceX/scan_elements
25 KernelVersion: 2.6.37 25 KernelVersion: 2.6.37
26 Contact: linux-iio@vger.kernel.org 26 Contact: linux-iio@vger.kernel.org
27 Description: 27 Description:
28 Directory containing interface 28 Directory containing interfaces for elements that will be
29 captured for a single triggere 29 captured for a single triggered sample set in the buffer.
30 30
31 Since kernel 5.11 the scan_ele 31 Since kernel 5.11 the scan_elements attributes are merged into
32 the bufferY directory, to be c 32 the bufferY directory, to be configurable per buffer.
33 33
34 What: /sys/.../iio:deviceX/scan_elem 34 What: /sys/.../iio:deviceX/scan_elements/in_accel_x_en
35 What: /sys/.../iio:deviceX/scan_elem 35 What: /sys/.../iio:deviceX/scan_elements/in_accel_y_en
36 What: /sys/.../iio:deviceX/scan_elem 36 What: /sys/.../iio:deviceX/scan_elements/in_accel_z_en
37 What: /sys/.../iio:deviceX/scan_elem 37 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_x_en
38 What: /sys/.../iio:deviceX/scan_elem 38 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_y_en
39 What: /sys/.../iio:deviceX/scan_elem 39 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_z_en
40 What: /sys/.../iio:deviceX/scan_elem 40 What: /sys/.../iio:deviceX/scan_elements/in_magn_x_en
41 What: /sys/.../iio:deviceX/scan_elem 41 What: /sys/.../iio:deviceX/scan_elements/in_magn_y_en
42 What: /sys/.../iio:deviceX/scan_elem 42 What: /sys/.../iio:deviceX/scan_elements/in_magn_z_en
43 What: /sys/.../iio:deviceX/scan_elem 43 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_en
44 What: /sys/.../iio:deviceX/scan_elem 44 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_en
45 What: /sys/.../iio:deviceX/scan_elem 45 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_en
46 What: /sys/.../iio:deviceX/scan_elem 46 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_en
47 What: /sys/.../iio:deviceX/scan_elem 47 What: /sys/.../iio:deviceX/scan_elements/in_timestamp_en
48 What: /sys/.../iio:deviceX/scan_elem 48 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_supply_en
49 What: /sys/.../iio:deviceX/scan_elem 49 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_en
50 What: /sys/.../iio:deviceX/scan_elem 50 What: /sys/.../iio:deviceX/scan_elements/in_voltageY-voltageZ_en
51 What: /sys/.../iio:deviceX/scan_elem 51 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_i_en
52 What: /sys/.../iio:deviceX/scan_elem 52 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_q_en
53 What: /sys/.../iio:deviceX/scan_elem 53 What: /sys/.../iio:deviceX/scan_elements/in_voltage_i_en
54 What: /sys/.../iio:deviceX/scan_elem 54 What: /sys/.../iio:deviceX/scan_elements/in_voltage_q_en
55 What: /sys/.../iio:deviceX/scan_elem 55 What: /sys/.../iio:deviceX/scan_elements/in_incli_x_en
56 What: /sys/.../iio:deviceX/scan_elem 56 What: /sys/.../iio:deviceX/scan_elements/in_incli_y_en
57 What: /sys/.../iio:deviceX/scan_elem 57 What: /sys/.../iio:deviceX/scan_elements/in_pressureY_en
58 What: /sys/.../iio:deviceX/scan_elem 58 What: /sys/.../iio:deviceX/scan_elements/in_pressure_en
59 What: /sys/.../iio:deviceX/scan_elem 59 What: /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_en
60 What: /sys/.../iio:deviceX/scan_elem 60 What: /sys/.../iio:deviceX/scan_elements/in_proximity_en
61 KernelVersion: 2.6.37 61 KernelVersion: 2.6.37
62 Contact: linux-iio@vger.kernel.org 62 Contact: linux-iio@vger.kernel.org
63 Description: 63 Description:
64 Scan element control for trigg 64 Scan element control for triggered data capture.
65 65
66 Since kernel 5.11 the scan_ele 66 Since kernel 5.11 the scan_elements attributes are merged into
67 the bufferY directory, to be c 67 the bufferY directory, to be configurable per buffer.
68 68
69 What: /sys/.../iio:deviceX/scan_elem 69 What: /sys/.../iio:deviceX/scan_elements/in_accel_type
70 What: /sys/.../iio:deviceX/scan_elem 70 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_type
71 What: /sys/.../iio:deviceX/scan_elem 71 What: /sys/.../iio:deviceX/scan_elements/in_magn_type
72 What: /sys/.../iio:deviceX/scan_elem 72 What: /sys/.../iio:deviceX/scan_elements/in_incli_type
73 What: /sys/.../iio:deviceX/scan_elem 73 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_type
74 What: /sys/.../iio:deviceX/scan_elem 74 What: /sys/.../iio:deviceX/scan_elements/in_voltage_type
75 What: /sys/.../iio:deviceX/scan_elem 75 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_supply_type
76 What: /sys/.../iio:deviceX/scan_elem 76 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_i_type
77 What: /sys/.../iio:deviceX/scan_elem 77 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_q_type
78 What: /sys/.../iio:deviceX/scan_elem 78 What: /sys/.../iio:deviceX/scan_elements/in_voltage_i_type
79 What: /sys/.../iio:deviceX/scan_elem 79 What: /sys/.../iio:deviceX/scan_elements/in_voltage_q_type
80 What: /sys/.../iio:deviceX/scan_elem 80 What: /sys/.../iio:deviceX/scan_elements/in_timestamp_type
81 What: /sys/.../iio:deviceX/scan_elem 81 What: /sys/.../iio:deviceX/scan_elements/in_pressureY_type
82 What: /sys/.../iio:deviceX/scan_elem 82 What: /sys/.../iio:deviceX/scan_elements/in_pressure_type
83 What: /sys/.../iio:deviceX/scan_elem 83 What: /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_type
84 What: /sys/.../iio:deviceX/scan_elem 84 What: /sys/.../iio:deviceX/scan_elements/in_proximity_type
85 KernelVersion: 2.6.37 85 KernelVersion: 2.6.37
86 Contact: linux-iio@vger.kernel.org 86 Contact: linux-iio@vger.kernel.org
87 Description: 87 Description:
88 Description of the scan elemen 88 Description of the scan element data storage within the buffer
89 and hence the form in which it 89 and hence the form in which it is read from user-space.
90 Form is [be|le]:[s|u]bits/stor 90 Form is [be|le]:[s|u]bits/storagebits[>>shift].
91 be or le specifies big or litt 91 be or le specifies big or little endian. s or u specifies if
92 signed (2's complement) or uns 92 signed (2's complement) or unsigned. bits is the number of bits
93 of data and storagebits is the 93 of data and storagebits is the space (after padding) that it
94 occupies in the buffer. shift 94 occupies in the buffer. shift if specified, is the shift that
95 needs to be applied prior to m 95 needs to be applied prior to masking out unused bits. Some
96 devices put their data in the 96 devices put their data in the middle of the transferred elements
97 with additional information on 97 with additional information on both sides. Note that some
98 devices will have additional i 98 devices will have additional information in the unused bits
99 so to get a clean value, the b 99 so to get a clean value, the bits value must be used to mask
100 the buffer output value approp 100 the buffer output value appropriately. The storagebits value
101 also specifies the data alignm 101 also specifies the data alignment. So s48/64>>2 will be a
102 signed 48 bit integer stored i 102 signed 48 bit integer stored in a 64 bit location aligned to
103 a 64 bit boundary. To obtain t 103 a 64 bit boundary. To obtain the clean value, shift right 2
104 and apply a mask to zero the t 104 and apply a mask to zero the top 16 bits of the result.
105 For other storage combinations 105 For other storage combinations this attribute will be extended
106 appropriately. 106 appropriately.
107 107
108 Since kernel 5.11 the scan_ele 108 Since kernel 5.11 the scan_elements attributes are merged into
109 the bufferY directory, to be c 109 the bufferY directory, to be configurable per buffer.
110 110
111 What: /sys/.../iio:deviceX/scan_elem 111 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_index
112 What: /sys/.../iio:deviceX/scan_elem 112 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_supply_index
113 What: /sys/.../iio:deviceX/scan_elem 113 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_i_index
114 What: /sys/.../iio:deviceX/scan_elem 114 What: /sys/.../iio:deviceX/scan_elements/in_voltageY_q_index
115 What: /sys/.../iio:deviceX/scan_elem 115 What: /sys/.../iio:deviceX/scan_elements/in_voltage_i_index
116 What: /sys/.../iio:deviceX/scan_elem 116 What: /sys/.../iio:deviceX/scan_elements/in_voltage_q_index
117 What: /sys/.../iio:deviceX/scan_elem 117 What: /sys/.../iio:deviceX/scan_elements/in_accel_x_index
118 What: /sys/.../iio:deviceX/scan_elem 118 What: /sys/.../iio:deviceX/scan_elements/in_accel_y_index
119 What: /sys/.../iio:deviceX/scan_elem 119 What: /sys/.../iio:deviceX/scan_elements/in_accel_z_index
120 What: /sys/.../iio:deviceX/scan_elem 120 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_x_index
121 What: /sys/.../iio:deviceX/scan_elem 121 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_y_index
122 What: /sys/.../iio:deviceX/scan_elem 122 What: /sys/.../iio:deviceX/scan_elements/in_anglvel_z_index
123 What: /sys/.../iio:deviceX/scan_elem 123 What: /sys/.../iio:deviceX/scan_elements/in_magn_x_index
124 What: /sys/.../iio:deviceX/scan_elem 124 What: /sys/.../iio:deviceX/scan_elements/in_magn_y_index
125 What: /sys/.../iio:deviceX/scan_elem 125 What: /sys/.../iio:deviceX/scan_elements/in_magn_z_index
126 What: /sys/.../iio:deviceX/scan_elem 126 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_index
127 What: /sys/.../iio:deviceX/scan_elem 127 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_index
128 What: /sys/.../iio:deviceX/scan_elem 128 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_magnetic_tilt_comp_index
129 What: /sys/.../iio:deviceX/scan_elem 129 What: /sys/.../iio:deviceX/scan_elements/in_rot_from_north_true_tilt_comp_index
130 What: /sys/.../iio:deviceX/scan_elem 130 What: /sys/.../iio:deviceX/scan_elements/in_incli_x_index
131 What: /sys/.../iio:deviceX/scan_elem 131 What: /sys/.../iio:deviceX/scan_elements/in_incli_y_index
132 What: /sys/.../iio:deviceX/scan_elem 132 What: /sys/.../iio:deviceX/scan_elements/in_timestamp_index
133 What: /sys/.../iio:deviceX/scan_elem 133 What: /sys/.../iio:deviceX/scan_elements/in_pressureY_index
134 What: /sys/.../iio:deviceX/scan_elem 134 What: /sys/.../iio:deviceX/scan_elements/in_pressure_index
135 What: /sys/.../iio:deviceX/scan_elem 135 What: /sys/.../iio:deviceX/scan_elements/in_rot_quaternion_index
136 What: /sys/.../iio:deviceX/scan_elem 136 What: /sys/.../iio:deviceX/scan_elements/in_proximity_index
137 KernelVersion: 2.6.37 137 KernelVersion: 2.6.37
138 Description: 138 Description:
139 A single positive integer spec 139 A single positive integer specifying the position of this
140 scan element in the buffer. No 140 scan element in the buffer. Note these are not dependent on
141 what is enabled and may not be 141 what is enabled and may not be contiguous. Thus for user-space
142 to establish the full layout t 142 to establish the full layout these must be used in conjunction
143 with all _en attributes to est 143 with all _en attributes to establish which channels are present,
144 and the relevant _type attribu 144 and the relevant _type attributes to establish the data storage
145 format. 145 format.
146 146
147 Since kernel 5.11 the scan_ele 147 Since kernel 5.11 the scan_elements attributes are merged into
148 the bufferY directory, to be c 148 the bufferY directory, to be configurable per buffer.
149 149
150 What: /sys/bus/iio/devices/iio:devic 150 What: /sys/bus/iio/devices/iio:deviceX/buffer/watermark
151 KernelVersion: 4.2 151 KernelVersion: 4.2
152 Contact: linux-iio@vger.kernel.org 152 Contact: linux-iio@vger.kernel.org
153 Description: 153 Description:
154 A single positive integer spec 154 A single positive integer specifying the maximum number of scan
155 elements to wait for. 155 elements to wait for.
156 156
157 Poll will block until the wate 157 Poll will block until the watermark is reached.
158 158
159 Blocking read will wait until 159 Blocking read will wait until the minimum between the requested
160 read amount or the low water m 160 read amount or the low water mark is available.
161 161
162 Non-blocking read will retriev 162 Non-blocking read will retrieve the available samples from the
163 buffer even if there are less 163 buffer even if there are less samples then watermark level. This
164 allows the application to bloc 164 allows the application to block on poll with a timeout and read
165 the available samples after th 165 the available samples after the timeout expires and thus have a
166 maximum delay guarantee. 166 maximum delay guarantee.
167 167
168 Since Kernel 5.11, multiple bu 168 Since Kernel 5.11, multiple buffers are supported.
169 so, it is better to use, inste 169 so, it is better to use, instead:
170 170
171 /sys/bus/iio/devices/i 171 /sys/bus/iio/devices/iio:deviceX/bufferY/watermark
172 172
173 What: /sys/bus/iio/devices/iio:devic 173 What: /sys/bus/iio/devices/iio:deviceX/buffer/data_available
174 KernelVersion: 4.16 174 KernelVersion: 4.16
175 Contact: linux-iio@vger.kernel.org 175 Contact: linux-iio@vger.kernel.org
176 Description: 176 Description:
177 A read-only value indicating t 177 A read-only value indicating the bytes of data available in the
178 buffer. In the case of an outp 178 buffer. In the case of an output buffer, this indicates the
179 amount of empty space availabl 179 amount of empty space available to write data to. In the case of
180 an input buffer, this indicate 180 an input buffer, this indicates the amount of data available for
181 reading. 181 reading.
182 182
183 Since Kernel 5.11, multiple bu 183 Since Kernel 5.11, multiple buffers are supported.
184 so, it is better to use, inste 184 so, it is better to use, instead:
185 185
186 /sys/bus/iio/devices/i 186 /sys/bus/iio/devices/iio:deviceX/bufferY/data_available
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.