Skip to content

Commit

Permalink
docs: driver-api: iio: fix errors in documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
tduszynski authored and Jonathan Corbet committed Mar 4, 2019
1 parent d2b008f commit 8c56eeb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Documentation/driver-api/iio/buffers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ IIO buffer setup
================

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
:file:`/sys/bus/iio/iio:device{X}/scan_elements/*` directory. This file contains
attributes of the following form:
Expand Down
6 changes: 3 additions & 3 deletions Documentation/driver-api/iio/core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
Core elements
=============

The Industrial I/O core offers a unified framework for writing drivers for
many different types of embedded sensors. a standard interface to user space
The Industrial I/O core offers both a unified framework for writing drivers for
many different types of embedded sensors and a standard interface to user space
applications manipulating sensors. The implementation can be found under
:file:`drivers/iio/industrialio-*`

Industrial I/O Devices
----------------------

* 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_register()` - register a device with the IIO subsystem
* :c:func:`iio_device_unregister()` - unregister a device from the IIO
Expand Down
2 changes: 1 addition & 1 deletion Documentation/driver-api/iio/hw-consumer.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
===========
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.
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
Expand Down
2 changes: 1 addition & 1 deletion Documentation/driver-api/iio/triggers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
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.

IIO trigger setup
Expand Down

0 comments on commit 8c56eeb

Please sign in to comment.