2015-08-14 22:54:55 +08:00
|
|
|
#
|
|
|
|
# Industrial I/O generic buffer implementations
|
|
|
|
#
|
|
|
|
# When adding new entries keep the list in alphabetical order
|
|
|
|
|
|
|
|
config IIO_BUFFER_CB
|
|
|
|
tristate "IIO callback buffer used for push in-kernel interfaces"
|
|
|
|
help
|
|
|
|
Should be selected by any drivers that do in-kernel push
|
|
|
|
usage. That is, those where the data is pushed to the consumer.
|
|
|
|
|
iio: Add generic DMA buffer infrastructure
The traditional approach used in IIO to implement buffered capture requires
the generation of at least one interrupt per sample. In the interrupt
handler the driver reads the sample from the device and copies it to a
software buffer. This approach has a rather large per sample overhead
associated with it. And while it works fine for samplerates in the range of
up to 1000 samples per second it starts to consume a rather large share of
the available CPU processing time once we go beyond that, this is
especially true on an embedded system with limited processing power. The
regular interrupt also causes increased power consumption by not allowing
the hardware into deeper sleep states, which is something that becomes more
and more important on mobile battery powered devices.
And while the recently added watermark support mitigates some of the issues
by allowing the device to generate interrupts at a rate lower than the data
output rate, this still requires a storage buffer inside the device and
even if it exists it is only a few 100 samples deep at most.
DMA support on the other hand allows to capture multiple millions or even
more samples without any CPU interaction. This allows the CPU to either go
to sleep for longer periods or focus on other tasks which increases overall
system performance and power consumption. In addition to that some devices
might not even offer a way to read the data other than using DMA, which
makes DMA mandatory to use for them.
The tasks involved in implementing a DMA buffer can be divided into two
categories. The first category is memory buffer management (allocation,
mapping, etc.) and hooking this up the IIO buffer callbacks like read(),
enable(), disable(), etc. The second category of tasks is to setup the
DMA hardware and manage the DMA transfers. Tasks from the first category
will be very similar for all IIO drivers supporting DMA buffers, while the
tasks from the second category will be hardware specific.
This patch implements a generic infrastructure that take care of the former
tasks. It provides a set of functions that implement the standard IIO
buffer iio_buffer_access_funcs callbacks. These can either be used as is or
be overloaded and augmented with driver specific code where necessary.
For the DMA buffer support infrastructure that is introduced in this series
sample data is grouped by so called blocks. A block is the basic unit at
which data is exchanged between the application and the hardware. The
application is responsible for allocating the memory associated with the
block and then passes the block to the hardware. When the hardware has
captured the amount of samples equal to size of a block it will notify the
application, which can then read the data from the block and process it.
The block size can freely chosen (within the constraints of the hardware).
This allows to make a trade-off between latency and management overhead.
The larger the block size the lower the per sample overhead but the latency
between when the data was captured and when the application will be able to
access it increases, in a similar way smaller block sizes have a larger per
sample management overhead but a lower latency. The ideal block size thus
depends on system and application requirements.
For the time being the infrastructure only implements a simple double
buffered scheme which allocates two blocks each with half the size of the
configured buffer size. This provides basic support for capturing
continuous uninterrupted data over the existing file-IO ABI. Future
extensions to the DMA buffer infrastructure will give applications a more
fine grained control over how many blocks are allocated and the size of
each block. But this requires userspace ABI additions which are
intentionally not part of this patch and will be added separately.
Tasks of the second category need to be implemented by a device specific
driver. They can be hooked up into the generic infrastructure using two
simple callbacks, submit() and abort().
The submit() callback is used to schedule DMA transfers for blocks. Once a
DMA transfer has been completed it is expected that the buffer driver calls
iio_dma_buffer_block_done() to notify. The abort() callback is used for
stopping all pending and active DMA transfers when the buffer is disabled.
Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Signed-off-by: Jonathan Cameron <jic23@kernel.org>
2015-10-14 00:10:28 +08:00
|
|
|
config IIO_BUFFER_DMA
|
|
|
|
tristate
|
|
|
|
help
|
|
|
|
Provides the generic IIO DMA buffer infrastructure that can be used by
|
|
|
|
drivers for devices with DMA support to implement the IIO buffer.
|
|
|
|
|
|
|
|
Should be selected by drivers that want to use the generic DMA buffer
|
|
|
|
infrastructure.
|
|
|
|
|
2015-10-14 00:10:29 +08:00
|
|
|
config IIO_BUFFER_DMAENGINE
|
|
|
|
tristate
|
|
|
|
select IIO_BUFFER_DMA
|
|
|
|
help
|
|
|
|
Provides a bonding of the generic IIO DMA buffer infrastructure with the
|
|
|
|
DMAengine framework. This can be used by converter drivers with a DMA port
|
|
|
|
connected to an external DMA controller which is supported by the
|
|
|
|
DMAengine framework.
|
|
|
|
|
|
|
|
Should be selected by drivers that want to use this functionality.
|
|
|
|
|
2018-01-10 18:13:03 +08:00
|
|
|
config IIO_BUFFER_HW_CONSUMER
|
|
|
|
tristate "Industrial I/O HW buffering"
|
|
|
|
help
|
|
|
|
Provides a way to bonding when an IIO device has a direct connection
|
|
|
|
to another device in hardware. In this case buffers for data transfers
|
|
|
|
are handled by hardware.
|
|
|
|
|
|
|
|
Should be selected by drivers that want to use the generic Hw consumer
|
|
|
|
interface.
|
|
|
|
|
2015-08-14 22:54:55 +08:00
|
|
|
config IIO_KFIFO_BUF
|
|
|
|
tristate "Industrial I/O buffering based on kfifo"
|
|
|
|
help
|
|
|
|
A simple fifo based on kfifo. Note that this currently provides
|
|
|
|
no buffer events so it is up to userspace to work out how
|
|
|
|
often to read from the buffer.
|
|
|
|
|
|
|
|
config IIO_TRIGGERED_BUFFER
|
|
|
|
tristate
|
|
|
|
select IIO_TRIGGER
|
|
|
|
select IIO_KFIFO_BUF
|
|
|
|
help
|
|
|
|
Provides helper functions for setting up triggered buffers.
|