docs: IIO documentation sphinx conversion
Subsystems (2)
Jonathan Cameron
maintainerPATCH v2 1/1 docs: IIO documentation sphinx conversion
This is a manual conversion of the existing DocBook documentation for IIO. The intent is not to substantially change any of the content in this patch, but to give a base to build upon.
---
V2 changes:
- some small cleanups around shortening titles where the IIO bit is obvious from the file location.
- put the :: on the same line as the statement introducing the code block as Jon Corbet suggested.
There are quite a few outstanding 'buglets' in the kernel-doc that I'll work through over time, but those don't need to go in with this patch.
Documentation/DocBook/Makefile | 2 +- Documentation/DocBook/iio.tmpl | 697 --------------------- Documentation/driver-api/iio/buffers.rst | 125 ++++ Documentation/driver-api/iio/core.rst | 182 ++++++ Documentation/driver-api/iio/index.rst | 17 + Documentation/driver-api/iio/intro.rst | 33 + Documentation/driver-api/iio/triggered-buffers.rst | 69 ++ Documentation/driver-api/iio/triggers.rst | 80 +++ Documentation/driver-api/index.rst | 1 + 9 files changed, 508 insertions(+), 698 deletions(-)
Documentation/DocBook/Makefile +1 -1
@@ -13,7 +13,7 @@ DOCBOOKS := z8530book.xml \ gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ 80211.xml sh.xml regulator.xml w1.xml \ - writing_musb_glue_layer.xml iio.xml + writing_musb_glue_layer.xml ifeq ($(DOCBOOKS),)
Documentation/DocBook/iio.tmpl deleted +0 -697
697 lines not on this page · raw message
Documentation/driver-api/iio/buffers.rst new file +125 -0
125 lines not on this page · raw message
Documentation/driver-api/iio/core.rst new file +182 -0
182 lines not on this page · raw message
Documentation/driver-api/iio/index.rst new file +17 -0
@@ -0,0 +1,17 @@ +.. include:: <isonum.txt> + +Industrial I/O +============== + +**Copyright** |copy| 2015 Intel Corporation + +Contents: + +.. toctree:: + :maxdepth: 2 + + intro + core + buffers + triggers + triggered-buffers
Documentation/driver-api/iio/intro.rst new file +33 -0
@@ -0,0 +1,33 @@ +.. include:: <isonum.txt> + +============ +Introduction +============ + +The main purpose of the Industrial I/O subsystem (IIO) is to provide support +for devices that in some sense perform either +analog-to-digital conversion (ADC) or digital-to-analog conversion (DAC) +or both. The aim is to fill the gap between the somewhat similar hwmon and +:doc:`input <../input>` subsystems. Hwmon is directed at low sample rate +sensors used to monitor and control the system itself, like fan speed control +or temperature measurement. :doc:`Input <../input>` is, as its name suggests, +focused on human interaction input devices (keyboard, mouse, touchscreen). +In some cases there is considerable overlap between these and IIO. + +Devices that fall into this category include: + +* analog to digital converters (ADCs) +* accelerometers +* capacitance to digital converters (CDCs) +* digital to analog converters (DACs) +* gyroscopes +* inertial measurement units (IMUs) +* color and light sensors +* magnetometers +* pressure sensors +* proximity sensors +* temperature sensors + +Usually these sensors are connected via :doc:`SPI <../spi>` or +:doc:`I2C <../i2c>`. A common use case of the sensors devices is to have +combined functionality (e.g. light plus proximity sensor).
Documentation/driver-api/iio/triggered-buffers.rst new file +69 -0
69 lines not on this page · raw message
Documentation/driver-api/iio/triggers.rst new file +80 -0
80 lines not on this page · raw message
Documentation/driver-api/index.rst +1 -0
@@ -21,6 +21,7 @@ available subsections can be seen below. message-based sound frame-buffer + iio/index input usb spi
Signature · 1 line
2.11.0
Jonathan Corbet
maintainerQuoted 3 lines · On Sun, 1 Jan 2017 12:32:45 +0000 Jonathan Cameron <[email protected]> wrote:
This is a manual conversion of the existing DocBook documentation for IIO. The intent is not to substantially change any of the content in this patch, but to give a base to build upon.
This looks good. Applied to the docs-tree, thanks.
jon