driver-api/iio/core.rst

8 :file:`drivers/iio/industrialio-*`
11 ----------------------
13 * struct iio_dev - industrial I/O device
14 * iio_device_alloc() - allocate an :c:type:`iio_dev` from a driver
15 * iio_device_free() - free an :c:type:`iio_dev` from a driver
16 * iio_device_register() - register a device with the IIO subsystem
17 * iio_device_unregister() - unregister a device from the IIO
25 There are two ways for a user space application to interact with an IIO driver.
33 :doc:`SPI <../spi>` driver and will create two routines, probe and remove.
63   :file:`Documentation/ABI/testing/sysfs-bus-iio` file in the Linux kernel
69 struct iio_chan_spec - specification of a single channel
71 An IIO device channel is a representation of a data channel. An IIO device can
74 * a thermometer sensor has one channel representing the temperature measurement.
75 * a light sensor with two channels indicating the measurements in the visible
80 An IIO channel is described by the struct iio_chan_spec.
82 have to describe its channel as follows::
91 Channel sysfs attributes exposed to userspace are specified in the form of
96   this channel
103 When there are multiple data channels per channel type we have two ways to
109   channel such as its direction or spectral response. For example, a light
110   sensor can have two channels, one for infrared light and one for both
113   channel is simply another instance with an index specified by the **.channel**
116 Here is how we can make use of the channel's modifiers::
140 This channel's definition will generate two separate sysfs files for raw data
154 Here is how we can make use of the channel's indexing::
160 		   .channel = 0,
166                    .channel = 1,
171 This will generate two separate attributes files for raw data retrieval:
174   voltage measurement for channel 0.
176   voltage measurement for channel 1.
180 .. kernel-doc:: include/linux/iio/iio.h
181 .. kernel-doc:: drivers/iio/industrialio-core.c