docs: driver-api: iio: fix errors in documentation
Improve IIO documentation by fixing a few mistakes. Signed-off-by: Tomasz Duszynski <tduszyns@gmail.com> Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
d2b008f134
commit
8c56eebc0d
|
@ -26,7 +26,7 @@ IIO buffer setup
|
||||||
================
|
================
|
||||||
|
|
||||||
The meta information associated with a channel reading placed in a buffer is
|
The meta information associated with a channel reading placed in a buffer is
|
||||||
called a scan element . The important bits configuring scan elements are
|
called a scan element. The important bits configuring scan elements are
|
||||||
exposed to userspace applications via the
|
exposed to userspace applications via the
|
||||||
:file:`/sys/bus/iio/iio:device{X}/scan_elements/*` directory. This file contains
|
:file:`/sys/bus/iio/iio:device{X}/scan_elements/*` directory. This file contains
|
||||||
attributes of the following form:
|
attributes of the following form:
|
||||||
|
|
|
@ -2,8 +2,8 @@
|
||||||
Core elements
|
Core elements
|
||||||
=============
|
=============
|
||||||
|
|
||||||
The Industrial I/O core offers a unified framework for writing drivers for
|
The Industrial I/O core offers both a unified framework for writing drivers for
|
||||||
many different types of embedded sensors. a standard interface to user space
|
many different types of embedded sensors and a standard interface to user space
|
||||||
applications manipulating sensors. The implementation can be found under
|
applications manipulating sensors. The implementation can be found under
|
||||||
:file:`drivers/iio/industrialio-*`
|
:file:`drivers/iio/industrialio-*`
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ Industrial I/O Devices
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
* struct :c:type:`iio_dev` - industrial I/O device
|
* struct :c:type:`iio_dev` - industrial I/O device
|
||||||
* :c:func:`iio_device_alloc()` - alocate an :c:type:`iio_dev` from a driver
|
* :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver
|
||||||
* :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver
|
* :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver
|
||||||
* :c:func:`iio_device_register()` - register a device with the IIO subsystem
|
* :c:func:`iio_device_register()` - register a device with the IIO subsystem
|
||||||
* :c:func:`iio_device_unregister()` - unregister a device from the IIO
|
* :c:func:`iio_device_unregister()` - unregister a device from the IIO
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
===========
|
===========
|
||||||
HW consumer
|
HW consumer
|
||||||
===========
|
===========
|
||||||
An IIO device can be directly connected to another device in hardware. in this
|
An IIO device can be directly connected to another device in hardware. In this
|
||||||
case the buffers between IIO provider and IIO consumer are handled by hardware.
|
case the buffers between IIO provider and IIO consumer are handled by hardware.
|
||||||
The Industrial I/O HW consumer offers a way to bond these IIO devices without
|
The Industrial I/O HW consumer offers a way to bond these IIO devices without
|
||||||
software buffer for data. The implementation can be found under
|
software buffer for data. The implementation can be found under
|
||||||
|
|
|
@ -38,7 +38,7 @@ There are two locations in sysfs related to triggers:
|
||||||
|
|
||||||
* :file:`/sys/bus/iio/devices/iio:device{X}/trigger/*`, this directory is
|
* :file:`/sys/bus/iio/devices/iio:device{X}/trigger/*`, this directory is
|
||||||
created once the device supports a triggered buffer. We can associate a
|
created once the device supports a triggered buffer. We can associate a
|
||||||
trigger with our device by writing the trigger's name in the
|
trigger with our device by writing the trigger's name in the
|
||||||
:file:`current_trigger` file.
|
:file:`current_trigger` file.
|
||||||
|
|
||||||
IIO trigger setup
|
IIO trigger setup
|
||||||
|
|
Loading…
Reference in a new issue