mirror of
https://github.com/torvalds/linux.git
synced 2024-11-24 21:21:41 +00:00
docs: iio: add documentation for interfacing tools
Add documentation for IIO interfacing tools describing the available tools which can be used to retrieve data from IIO sysfs. Reference this documentation in adis16475.rst Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com> Reviewed-by: Nuno Sa <nuno.sa@analog.com> Link: https://lore.kernel.org/r/20240528142409.239187-6-ramona.gradinariu@analog.com Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
This commit is contained in:
parent
85b2aeaa2f
commit
9bc8b4d27c
@ -380,24 +380,5 @@ data is structured.
|
|||||||
4. IIO Interfacing Tools
|
4. IIO Interfacing Tools
|
||||||
========================
|
========================
|
||||||
|
|
||||||
Linux Kernel Tools
|
See ``Documentation/iio/iio_tools.rst`` for the description of the available IIO
|
||||||
------------------
|
interfacing tools.
|
||||||
|
|
||||||
Linux Kernel provides some userspace tools that can be used to retrieve data
|
|
||||||
from IIO sysfs:
|
|
||||||
|
|
||||||
* lsiio: example application that provides a list of IIO devices and triggers
|
|
||||||
* iio_event_monitor: example application that reads events from an IIO device
|
|
||||||
and prints them
|
|
||||||
* iio_generic_buffer: example application that reads data from buffer
|
|
||||||
* iio_utils: set of APIs, typically used to access sysfs files.
|
|
||||||
|
|
||||||
LibIIO
|
|
||||||
------
|
|
||||||
|
|
||||||
LibIIO is a C/C++ library that provides generic access to IIO devices. The
|
|
||||||
library abstracts the low-level details of the hardware, and provides a simple
|
|
||||||
yet complete programming interface that can be used for advanced projects.
|
|
||||||
|
|
||||||
For more information about LibIIO, please see:
|
|
||||||
https://github.com/analogdevicesinc/libiio
|
|
||||||
|
27
Documentation/iio/iio_tools.rst
Normal file
27
Documentation/iio/iio_tools.rst
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
.. SPDX-License-Identifier: GPL-2.0
|
||||||
|
|
||||||
|
=====================
|
||||||
|
IIO Interfacing Tools
|
||||||
|
=====================
|
||||||
|
|
||||||
|
1. Linux Kernel Tools
|
||||||
|
=====================
|
||||||
|
|
||||||
|
Linux Kernel provides some userspace tools that can be used to retrieve data
|
||||||
|
from IIO sysfs:
|
||||||
|
|
||||||
|
* lsiio: example application that provides a list of IIO devices and triggers
|
||||||
|
* iio_event_monitor: example application that reads events from an IIO device
|
||||||
|
and prints them
|
||||||
|
* iio_generic_buffer: example application that reads data from buffer
|
||||||
|
* iio_utils: set of APIs, typically used to access sysfs files.
|
||||||
|
|
||||||
|
2. LibIIO
|
||||||
|
=========
|
||||||
|
|
||||||
|
LibIIO is a C/C++ library that provides generic access to IIO devices. The
|
||||||
|
library abstracts the low-level details of the hardware, and provides a simple
|
||||||
|
yet complete programming interface that can be used for advanced projects.
|
||||||
|
|
||||||
|
For more information about LibIIO, please see:
|
||||||
|
https://github.com/analogdevicesinc/libiio
|
@ -9,6 +9,7 @@ Industrial I/O
|
|||||||
|
|
||||||
iio_configfs
|
iio_configfs
|
||||||
iio_devbuf
|
iio_devbuf
|
||||||
|
iio_tools
|
||||||
|
|
||||||
Industrial I/O Kernel Drivers
|
Industrial I/O Kernel Drivers
|
||||||
=============================
|
=============================
|
||||||
|
Loading…
Reference in New Issue
Block a user