drivers/staging/iio/Documentation/overview.txt

   1 Overview of IIO
   2
   3 The Industrial I/O subsytem is intended to provide support for devices
   4 that in some sense are analog to digital convertors (ADCs). As many
   5 actual devices combine some ADCs with digital to analog convertors
   6 (DACs) the intention is to add that functionality at a future date
   7 (hence the name).
   8
   9 The aim is to fill the gap between the somewhat similar hwmon and
  10 input subsystems.  Hwmon is very much directed at low sample rate
  11 sensors used in applications such as fan speed control and temperature
  12 measurement.  Input is, as it's name suggests focused on input
  13 devices. In some cases there is considerable overlap between these and
  14 IIO.
  15
  16 A typical device falling into this category would be connected via SPI
  17 or I2C.
  18
  19 Functionality of IIO
  20
  21 * Basic device registration and handling. This is very similar to
  22 hwmon with simple polled access to device channels via sysfs.
  23
  24 * Event chrdevs.  These are similar to input in that they provide a
  25 route to user space for hardware triggered events. Such events include
  26 threshold detectors, free-fall detectors and more complex action
  27 detection.  They events themselves are currently very simple with
  28 merely an event code and a timestamp.  Any data associated with the
  29 event must be accessed via polling. Note a given device may have one
  30 or more event channel.  These events are turned on or off (if possible)
  31 via sysfs interfaces.
  32
  33 * Hardware ring buffer support.  Some recent sensors have included
  34 fifo / ring buffers on the sensor chip.  These greatly reduce the load
  35 on the host CPU by buffering relatively large numbers of data samples
  36 based on an internal sampling clock. Examples include VTI SCA3000
  37 series and Analog Device ADXL345 accelerometers.  Each ring buffer
  38 typically has an event chrdev (similar to the more general ones above)
  39 to pass on events such as buffer 50% full and an access chrdev via
  40 which the raw data it self may be read back.
  41
  42 * Trigger and software ring buffer support. In many data analysis
  43 applications it it useful to be able to capture data based on some
  44 external signal (trigger).  These triggers might be a data ready
  45 signal, a gpio line connected to some external system or an on
  46 processor periodic interrupt.  A single trigger many initialize data
  47 capture or reading from a number of sensors.  These triggers are
  48 used in iio to fill software ring buffers acting in a very similar
  49 fashion to the hardware buffers described above.
  50
  51 Other documentation:
  52
  53 userspace.txt - overview of ring buffer reading from userspace
  54
  55 device.txt - elemennts of a typical device driver.
  56
  57 trigger.txt - elements of a typical trigger driver.
  58
  59 ring.txt - additional elements required for ring buffer support
  60
  61
  62