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