diff options
Diffstat (limited to 'Documentation/ABI/testing/sysfs-bus-iio')
| -rw-r--r-- | Documentation/ABI/testing/sysfs-bus-iio | 69 |
1 files changed, 69 insertions, 0 deletions
diff --git a/Documentation/ABI/testing/sysfs-bus-iio b/Documentation/ABI/testing/sysfs-bus-iio index 0b6f0abf3370..6bf79072179f 100644 --- a/Documentation/ABI/testing/sysfs-bus-iio +++ b/Documentation/ABI/testing/sysfs-bus-iio | |||
| @@ -1295,3 +1295,72 @@ Description: | |||
| 1295 | allows the application to block on poll with a timeout and read | 1295 | allows the application to block on poll with a timeout and read |
| 1296 | the available samples after the timeout expires and thus have a | 1296 | the available samples after the timeout expires and thus have a |
| 1297 | maximum delay guarantee. | 1297 | maximum delay guarantee. |
| 1298 | |||
| 1299 | What: /sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_enabled | ||
| 1300 | KernelVersion: 4.2 | ||
| 1301 | Contact: linux-iio@vger.kernel.org | ||
| 1302 | Description: | ||
| 1303 | A read-only boolean value that indicates if the hardware fifo is | ||
| 1304 | currently enabled or disabled. If the device does not have a | ||
| 1305 | hardware fifo this entry is not present. | ||
| 1306 | The hardware fifo is enabled when the buffer is enabled if the | ||
| 1307 | current hardware fifo watermark level is set and other current | ||
| 1308 | device settings allows it (e.g. if a trigger is set that samples | ||
| 1309 | data differently that the hardware fifo does then hardware fifo | ||
| 1310 | will not enabled). | ||
| 1311 | If the hardware fifo is enabled and the level of the hardware | ||
| 1312 | fifo reaches the hardware fifo watermark level the device will | ||
| 1313 | flush its hardware fifo to the device buffer. Doing a non | ||
| 1314 | blocking read on the device when no samples are present in the | ||
| 1315 | device buffer will also force a flush. | ||
| 1316 | When the hardware fifo is enabled there is no need to use a | ||
| 1317 | trigger to use buffer mode since the watermark settings | ||
| 1318 | guarantees that the hardware fifo is flushed to the device | ||
| 1319 | buffer. | ||
| 1320 | |||
| 1321 | What: /sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark | ||
| 1322 | KernelVersion: 4.2 | ||
| 1323 | Contact: linux-iio@vger.kernel.org | ||
| 1324 | Description: | ||
| 1325 | Read-only entry that contains a single integer specifying the | ||
| 1326 | current watermark level for the hardware fifo. If the device | ||
| 1327 | does not have a hardware fifo this entry is not present. | ||
| 1328 | The watermark level for the hardware fifo is set by the driver | ||
| 1329 | based on the value set by the user in buffer/watermark but | ||
| 1330 | taking into account hardware limitations (e.g. most hardware | ||
| 1331 | buffers are limited to 32-64 samples, some hardware buffers | ||
| 1332 | watermarks are fixed or have minimum levels). A value of 0 | ||
| 1333 | means that the hardware watermark is unset. | ||
| 1334 | |||
| 1335 | What: /sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_min | ||
| 1336 | KernelVersion: 4.2 | ||
| 1337 | Contact: linux-iio@vger.kernel.org | ||
| 1338 | Description: | ||
| 1339 | A single positive integer specifying the minimum watermark level | ||
| 1340 | for the hardware fifo of this device. If the device does not | ||
| 1341 | have a hardware fifo this entry is not present. | ||
| 1342 | If the user sets buffer/watermark to a value less than this one, | ||
| 1343 | then the hardware watermark will remain unset. | ||
| 1344 | |||
| 1345 | What: /sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_max | ||
| 1346 | KernelVersion: 4.2 | ||
| 1347 | Contact: linux-iio@vger.kernel.org | ||
| 1348 | Description: | ||
| 1349 | A single positive integer specifying the maximum watermark level | ||
| 1350 | for the hardware fifo of this device. If the device does not | ||
| 1351 | have a hardware fifo this entry is not present. | ||
| 1352 | If the user sets buffer/watermark to a value greater than this | ||
| 1353 | one, then the hardware watermark will be capped at this value. | ||
| 1354 | |||
| 1355 | What: /sys/bus/iio/devices/iio:deviceX/buffer/hwfifo_watermark_available | ||
| 1356 | KernelVersion: 4.2 | ||
| 1357 | Contact: linux-iio@vger.kernel.org | ||
| 1358 | Description: | ||
| 1359 | A list of positive integers specifying the available watermark | ||
| 1360 | levels for the hardware fifo. This entry is optional and if it | ||
| 1361 | is not present it means that all the values between | ||
| 1362 | hwfifo_watermark_min and hwfifo_watermark_max are supported. | ||
| 1363 | If the user sets buffer/watermark to a value greater than | ||
| 1364 | hwfifo_watermak_min but not equal to any of the values in this | ||
| 1365 | list, the driver will chose an appropriate value for the | ||
| 1366 | hardware fifo watermark level. | ||
