mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2024-11-21 19:46:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

iio: core: Add new DMABUF interface infrastructure

Browse Source 
Add the necessary infrastructure to the IIO core to support a new
optional DMABUF based interface.

With this new interface, DMABUF objects (externally created) can be
attached to a IIO buffer, and subsequently used for data transfer.

A userspace application can then use this interface to share DMABUF
objects between several interfaces, allowing it to transfer data in a
zero-copy fashion, for instance between IIO and the USB stack.

The userspace application can also memory-map the DMABUF objects, and
access the sample data directly. The advantage of doing this vs. the
read() interface is that it avoids an extra copy of the data between the
kernel and userspace. This is particularly userful for high-speed
devices which produce several megabytes or even gigabytes of data per
second.

As part of the interface, 3 new IOCTLs have been added:

IIO_BUFFER_DMABUF_ATTACH_IOCTL(int fd):
 Attach the DMABUF object identified by the given file descriptor to the
 buffer.

IIO_BUFFER_DMABUF_DETACH_IOCTL(int fd):
 Detach the DMABUF object identified by the given file descriptor from
 the buffer. Note that closing the IIO buffer's file descriptor will
 automatically detach all previously attached DMABUF objects.

IIO_BUFFER_DMABUF_ENQUEUE_IOCTL(struct iio_dmabuf *):
 Request a data transfer to/from the given DMABUF object. Its file
 descriptor, as well as the transfer size and flags are provided in the
 "iio_dmabuf" structure.

These three IOCTLs have to be performed on the IIO buffer's file
descriptor, obtained using the IIO_BUFFER_GET_FD_IOCTL() ioctl.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
Co-developed-by: Nuno Sa <nuno.sa@analog.com>
Signed-off-by: Nuno Sa <nuno.sa@analog.com>
Link: https://patch.msgid.link/20240620122726.41232-4-paul@crapouillou.net
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
This commit is contained in:
Paul Cercueil 2024-06-20 14:27:22 +02:00 committed by Jonathan Cameron
parent da5a6fa001
commit 3e26d9f08f
4 changed files with 515 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
drivers/iio/Kconfig
View File

@ -14,6 +14,7 @@ if IIO
config IIO_BUFFER
bool "Enable buffer support within IIO"
select DMA_SHARED_BUFFER
help
Provide core support for various buffer based data
acquisition methods.

459
drivers/iio/industrialio-buffer.c
View File

@ -9,15 +9,20 @@
* - Better memory allocation techniques?
* - Alternative access techniques?
*/
#include <linux/atomic.h>
#include <linux/anon_inodes.h>
#include <linux/cleanup.h>
#include <linux/kernel.h>
#include <linux/export.h>
#include <linux/device.h>
#include <linux/dma-buf.h>
#include <linux/dma-fence.h>
#include <linux/dma-resv.h>
#include <linux/file.h>
#include <linux/fs.h>
#include <linux/cdev.h>
#include <linux/slab.h>
#include <linux/mm.h>
#include <linux/poll.h>
#include <linux/sched/signal.h>
@ -29,6 +34,34 @@
#include <linux/iio/buffer.h>
#include <linux/iio/buffer_impl.h>
#define DMABUF_ENQUEUE_TIMEOUT_MS 5000
MODULE_IMPORT_NS(DMA_BUF);
struct iio_dmabuf_priv {
struct list_head entry;
struct kref ref;
struct iio_buffer *buffer;
struct iio_dma_buffer_block *block;
u64 context;
/* Spinlock used for locking the dma_fence */
spinlock_t lock;
struct dma_buf_attachment *attach;
struct sg_table *sgt;
enum dma_data_direction dir;
atomic_t seqno;
};
struct iio_dma_fence {
struct dma_fence base;
struct iio_dmabuf_priv *priv;
struct work_struct work;
};
static const char * const iio_endian_prefix[] = {
[IIO_BE] = "be",
[IIO_LE] = "le",
@ -333,6 +366,8 @@ void iio_buffer_init(struct iio_buffer *buffer)
{
INIT_LIST_HEAD(&buffer->demux_list);
INIT_LIST_HEAD(&buffer->buffer_list);
INIT_LIST_HEAD(&buffer->dmabufs);
mutex_init(&buffer->dmabufs_mutex);
init_waitqueue_head(&buffer->pollq);
kref_init(&buffer->ref);
if (!buffer->watermark)
@ -1526,14 +1561,55 @@ static void iio_buffer_unregister_legacy_sysfs_groups(struct iio_dev *indio_dev)
kfree(iio_dev_opaque->legacy_scan_el_group.attrs);
}
static void iio_buffer_dmabuf_release(struct kref *ref)
{
struct iio_dmabuf_priv *priv = container_of(ref, struct iio_dmabuf_priv, ref);
struct dma_buf_attachment *attach = priv->attach;
struct iio_buffer *buffer = priv->buffer;
struct dma_buf *dmabuf = attach->dmabuf;
dma_resv_lock(dmabuf->resv, NULL);
dma_buf_unmap_attachment(attach, priv->sgt, priv->dir);
dma_resv_unlock(dmabuf->resv);
buffer->access->detach_dmabuf(buffer, priv->block);
dma_buf_detach(attach->dmabuf, attach);
dma_buf_put(dmabuf);
kfree(priv);
}
static void iio_buffer_dmabuf_get(struct dma_buf_attachment *attach)
{
struct iio_dmabuf_priv *priv = attach->importer_priv;
kref_get(&priv->ref);
}
static void iio_buffer_dmabuf_put(struct dma_buf_attachment *attach)
{
struct iio_dmabuf_priv *priv = attach->importer_priv;
kref_put(&priv->ref, iio_buffer_dmabuf_release);
}
static int iio_buffer_chrdev_release(struct inode *inode, struct file *filep)
{
struct iio_dev_buffer_pair *ib = filep->private_data;
struct iio_dev *indio_dev = ib->indio_dev;
struct iio_buffer *buffer = ib->buffer;
struct iio_dmabuf_priv *priv, *tmp;
wake_up(&buffer->pollq);
guard(mutex)(&buffer->dmabufs_mutex);
/* Close all attached DMABUFs */
list_for_each_entry_safe(priv, tmp, &buffer->dmabufs, entry) {
list_del_init(&priv->entry);
iio_buffer_dmabuf_put(priv->attach);
}
kfree(ib);
clear_bit(IIO_BUSY_BIT_POS, &buffer->flags);
iio_device_put(indio_dev);
@ -1541,11 +1617,393 @@ static int iio_buffer_chrdev_release(struct inode *inode, struct file *filep)
return 0;
}
static int iio_dma_resv_lock(struct dma_buf *dmabuf, bool nonblock)
{
if (!nonblock)
return dma_resv_lock_interruptible(dmabuf->resv, NULL);
if (!dma_resv_trylock(dmabuf->resv))
return -EBUSY;
return 0;
}
static struct dma_buf_attachment *
iio_buffer_find_attachment(struct iio_dev_buffer_pair *ib,
struct dma_buf *dmabuf, bool nonblock)
{
struct device *dev = ib->indio_dev->dev.parent;
struct iio_buffer *buffer = ib->buffer;
struct dma_buf_attachment *attach = NULL;
struct iio_dmabuf_priv *priv;
guard(mutex)(&buffer->dmabufs_mutex);
list_for_each_entry(priv, &buffer->dmabufs, entry) {
if (priv->attach->dev == dev
&& priv->attach->dmabuf == dmabuf) {
attach = priv->attach;
break;
}
}
if (attach)
iio_buffer_dmabuf_get(attach);
return attach ?: ERR_PTR(-EPERM);
}
static int iio_buffer_attach_dmabuf(struct iio_dev_buffer_pair *ib,
int __user *user_fd, bool nonblock)
{
struct iio_dev *indio_dev = ib->indio_dev;
struct iio_buffer *buffer = ib->buffer;
struct dma_buf_attachment *attach;
struct iio_dmabuf_priv *priv, *each;
struct dma_buf *dmabuf;
int err, fd;
if (!buffer->access->attach_dmabuf
|| !buffer->access->detach_dmabuf
|| !buffer->access->enqueue_dmabuf)
return -EPERM;
if (copy_from_user(&fd, user_fd, sizeof(fd)))
return -EFAULT;
priv = kzalloc(sizeof(*priv), GFP_KERNEL);
if (!priv)
return -ENOMEM;
spin_lock_init(&priv->lock);
priv->context = dma_fence_context_alloc(1);
dmabuf = dma_buf_get(fd);
if (IS_ERR(dmabuf)) {
err = PTR_ERR(dmabuf);
goto err_free_priv;
}
attach = dma_buf_attach(dmabuf, indio_dev->dev.parent);
if (IS_ERR(attach)) {
err = PTR_ERR(attach);
goto err_dmabuf_put;
}
err = iio_dma_resv_lock(dmabuf, nonblock);
if (err)
goto err_dmabuf_detach;
priv->dir = buffer->direction == IIO_BUFFER_DIRECTION_IN
? DMA_FROM_DEVICE : DMA_TO_DEVICE;
priv->sgt = dma_buf_map_attachment(attach, priv->dir);
if (IS_ERR(priv->sgt)) {
err = PTR_ERR(priv->sgt);
dev_err(&indio_dev->dev, "Unable to map attachment: %d\n", err);
goto err_resv_unlock;
}
kref_init(&priv->ref);
priv->buffer = buffer;
priv->attach = attach;
attach->importer_priv = priv;
priv->block = buffer->access->attach_dmabuf(buffer, attach);
if (IS_ERR(priv->block)) {
err = PTR_ERR(priv->block);
goto err_dmabuf_unmap_attachment;
}
dma_resv_unlock(dmabuf->resv);
mutex_lock(&buffer->dmabufs_mutex);
/*
* Check whether we already have an attachment for this driver/DMABUF
* combo. If we do, refuse to attach.
*/
list_for_each_entry(each, &buffer->dmabufs, entry) {
if (each->attach->dev == indio_dev->dev.parent
&& each->attach->dmabuf == dmabuf) {
/*
* We unlocked the reservation object, so going through
* the cleanup code would mean re-locking it first.
* At this stage it is simpler to free the attachment
* using iio_buffer_dma_put().
*/
mutex_unlock(&buffer->dmabufs_mutex);
iio_buffer_dmabuf_put(attach);
return -EBUSY;
}
}
/* Otherwise, add the new attachment to our dmabufs list. */
list_add(&priv->entry, &buffer->dmabufs);
mutex_unlock(&buffer->dmabufs_mutex);
return 0;
err_dmabuf_unmap_attachment:
dma_buf_unmap_attachment(attach, priv->sgt, priv->dir);
err_resv_unlock:
dma_resv_unlock(dmabuf->resv);
err_dmabuf_detach:
dma_buf_detach(dmabuf, attach);
err_dmabuf_put:
dma_buf_put(dmabuf);
err_free_priv:
kfree(priv);
return err;
}
static int iio_buffer_detach_dmabuf(struct iio_dev_buffer_pair *ib,
int __user *user_req, bool nonblock)
{
struct iio_buffer *buffer = ib->buffer;
struct iio_dev *indio_dev = ib->indio_dev;
struct iio_dmabuf_priv *priv;
struct dma_buf *dmabuf;
int dmabuf_fd, ret = -EPERM;
if (copy_from_user(&dmabuf_fd, user_req, sizeof(dmabuf_fd)))
return -EFAULT;
dmabuf = dma_buf_get(dmabuf_fd);
if (IS_ERR(dmabuf))
return PTR_ERR(dmabuf);
guard(mutex)(&buffer->dmabufs_mutex);
list_for_each_entry(priv, &buffer->dmabufs, entry) {
if (priv->attach->dev == indio_dev->dev.parent
&& priv->attach->dmabuf == dmabuf) {
list_del(&priv->entry);
/* Unref the reference from iio_buffer_attach_dmabuf() */
iio_buffer_dmabuf_put(priv->attach);
ret = 0;
break;
}
}
dma_buf_put(dmabuf);
return ret;
}
static const char *
iio_buffer_dma_fence_get_driver_name(struct dma_fence *fence)
{
return "iio";
}
static void iio_buffer_dma_fence_release(struct dma_fence *fence)
{
struct iio_dma_fence *iio_fence =
container_of(fence, struct iio_dma_fence, base);
kfree(iio_fence);
}
static const struct dma_fence_ops iio_buffer_dma_fence_ops = {
.get_driver_name = iio_buffer_dma_fence_get_driver_name,
.get_timeline_name = iio_buffer_dma_fence_get_driver_name,
.release = iio_buffer_dma_fence_release,
};
static int iio_buffer_enqueue_dmabuf(struct iio_dev_buffer_pair *ib,
struct iio_dmabuf __user *iio_dmabuf_req,
bool nonblock)
{
struct iio_buffer *buffer = ib->buffer;
struct iio_dmabuf iio_dmabuf;
struct dma_buf_attachment *attach;
struct iio_dmabuf_priv *priv;
struct iio_dma_fence *fence;
struct dma_buf *dmabuf;
unsigned long timeout;
bool cookie, cyclic, dma_to_ram;
long retl;
u32 seqno;
int ret;
if (copy_from_user(&iio_dmabuf, iio_dmabuf_req, sizeof(iio_dmabuf)))
return -EFAULT;
if (iio_dmabuf.flags & ~IIO_BUFFER_DMABUF_SUPPORTED_FLAGS)
return -EINVAL;
cyclic = iio_dmabuf.flags & IIO_BUFFER_DMABUF_CYCLIC;
/* Cyclic flag is only supported on output buffers */
if (cyclic && buffer->direction != IIO_BUFFER_DIRECTION_OUT)
return -EINVAL;
dmabuf = dma_buf_get(iio_dmabuf.fd);
if (IS_ERR(dmabuf))
return PTR_ERR(dmabuf);
if (!iio_dmabuf.bytes_used || iio_dmabuf.bytes_used > dmabuf->size) {
ret = -EINVAL;
goto err_dmabuf_put;
}
attach = iio_buffer_find_attachment(ib, dmabuf, nonblock);
if (IS_ERR(attach)) {
ret = PTR_ERR(attach);
goto err_dmabuf_put;
}
priv = attach->importer_priv;
fence = kmalloc(sizeof(*fence), GFP_KERNEL);
if (!fence) {
ret = -ENOMEM;
goto err_attachment_put;
}
fence->priv = priv;
seqno = atomic_add_return(1, &priv->seqno);
/*
* The transfers are guaranteed to be processed in the order they are
* enqueued, so we can use a simple incrementing sequence number for
* the dma_fence.
*/
dma_fence_init(&fence->base, &iio_buffer_dma_fence_ops,
&priv->lock, priv->context, seqno);
ret = iio_dma_resv_lock(dmabuf, nonblock);
if (ret)
goto err_fence_put;
timeout = nonblock ? 0 : msecs_to_jiffies(DMABUF_ENQUEUE_TIMEOUT_MS);
dma_to_ram = buffer->direction == IIO_BUFFER_DIRECTION_IN;
/* Make sure we don't have writers */
retl = dma_resv_wait_timeout(dmabuf->resv,
dma_resv_usage_rw(dma_to_ram),
true, timeout);
if (retl == 0)
retl = -EBUSY;
if (retl < 0) {
ret = (int)retl;
goto err_resv_unlock;
}
if (buffer->access->lock_queue)
buffer->access->lock_queue(buffer);
ret = dma_resv_reserve_fences(dmabuf->resv, 1);
if (ret)
goto err_queue_unlock;
dma_resv_add_fence(dmabuf->resv, &fence->base,
dma_to_ram ? DMA_RESV_USAGE_WRITE : DMA_RESV_USAGE_READ);
dma_resv_unlock(dmabuf->resv);
cookie = dma_fence_begin_signalling();
ret = buffer->access->enqueue_dmabuf(buffer, priv->block, &fence->base,
priv->sgt, iio_dmabuf.bytes_used,
cyclic);
if (ret) {
/*
* DMABUF enqueue failed, but we already added the fence.
* Signal the error through the fence completion mechanism.
*/
iio_buffer_signal_dmabuf_done(&fence->base, ret);
}
if (buffer->access->unlock_queue)
buffer->access->unlock_queue(buffer);
dma_fence_end_signalling(cookie);
dma_buf_put(dmabuf);
return ret;
err_queue_unlock:
if (buffer->access->unlock_queue)
buffer->access->unlock_queue(buffer);
err_resv_unlock:
dma_resv_unlock(dmabuf->resv);
err_fence_put:
dma_fence_put(&fence->base);
err_attachment_put:
iio_buffer_dmabuf_put(attach);
err_dmabuf_put:
dma_buf_put(dmabuf);
return ret;
}
static void iio_buffer_cleanup(struct work_struct *work)
{
struct iio_dma_fence *fence =
container_of(work, struct iio_dma_fence, work);
struct iio_dmabuf_priv *priv = fence->priv;
struct dma_buf_attachment *attach = priv->attach;
dma_fence_put(&fence->base);
iio_buffer_dmabuf_put(attach);
}
void iio_buffer_signal_dmabuf_done(struct dma_fence *fence, int ret)
{
struct iio_dma_fence *iio_fence =
container_of(fence, struct iio_dma_fence, base);
bool cookie = dma_fence_begin_signalling();
/*
* Get a reference to the fence, so that it's not freed as soon as
* it's signaled.
*/
dma_fence_get(fence);
fence->error = ret;
dma_fence_signal(fence);
dma_fence_end_signalling(cookie);
/*
* The fence will be unref'd in iio_buffer_cleanup.
* It can't be done here, as the unref functions might try to lock the
* resv object, which can deadlock.
*/
INIT_WORK(&iio_fence->work, iio_buffer_cleanup);
schedule_work(&iio_fence->work);
}
EXPORT_SYMBOL_GPL(iio_buffer_signal_dmabuf_done);
static long iio_buffer_chrdev_ioctl(struct file *filp,
unsigned int cmd, unsigned long arg)
{
struct iio_dev_buffer_pair *ib = filp->private_data;
void __user *_arg = (void __user *)arg;
bool nonblock = filp->f_flags & O_NONBLOCK;
switch (cmd) {
case IIO_BUFFER_DMABUF_ATTACH_IOCTL:
return iio_buffer_attach_dmabuf(ib, _arg, nonblock);
case IIO_BUFFER_DMABUF_DETACH_IOCTL:
return iio_buffer_detach_dmabuf(ib, _arg, nonblock);
case IIO_BUFFER_DMABUF_ENQUEUE_IOCTL:
return iio_buffer_enqueue_dmabuf(ib, _arg, nonblock);
default:
return -EINVAL;
}
}
static const struct file_operations iio_buffer_chrdev_fileops = {
.owner = THIS_MODULE,
.llseek = noop_llseek,
.read = iio_buffer_read,
.write = iio_buffer_write,
.unlocked_ioctl = iio_buffer_chrdev_ioctl,
.compat_ioctl = compat_ptr_ioctl,
.poll = iio_buffer_poll,
.release = iio_buffer_chrdev_release,
};
@ -1994,6 +2452,7 @@ static void iio_buffer_release(struct kref *ref)
{
struct iio_buffer *buffer = container_of(ref, struct iio_buffer, ref);
mutex_destroy(&buffer->dmabufs_mutex);
buffer->access->release(buffer);
}

33
include/linux/iio/buffer_impl.h
View File

@ -9,8 +9,12 @@
#include <uapi/linux/iio/buffer.h>
#include <linux/iio/buffer.h>
struct dma_buf_attachment;
struct dma_fence;
struct iio_dev;
struct iio_dma_buffer_block;
struct iio_buffer;
struct sg_table;
/**
* INDIO_BUFFER_FLAG_FIXED_WATERMARK - Watermark level of the buffer can not be
@ -39,6 +43,16 @@ struct iio_buffer;
* device stops sampling. Calles are balanced with @enable.
* @release: called when the last reference to the buffer is dropped,
* should free all resources allocated by the buffer.
* @attach_dmabuf: called from userspace via ioctl to attach one external
* DMABUF.
* @detach_dmabuf: called from userspace via ioctl to detach one previously
* attached DMABUF.
* @enqueue_dmabuf: called from userspace via ioctl to queue this DMABUF
* object to this buffer. Requires a valid DMABUF fd, that
* was previouly attached to this buffer.
* @lock_queue: called when the core needs to lock the buffer queue;
* it is used when enqueueing DMABUF objects.
* @unlock_queue: used to unlock a previously locked buffer queue
* @modes: Supported operating modes by this buffer type
* @flags: A bitmask combination of INDIO_BUFFER_FLAG_*
*
@ -68,6 +82,17 @@ struct iio_buffer_access_funcs {
void (*release)(struct iio_buffer *buffer);
struct iio_dma_buffer_block * (*attach_dmabuf)(struct iio_buffer *buffer,
struct dma_buf_attachment *attach);
void (*detach_dmabuf)(struct iio_buffer *buffer,
struct iio_dma_buffer_block *block);
int (*enqueue_dmabuf)(struct iio_buffer *buffer,
struct iio_dma_buffer_block *block,
struct dma_fence *fence, struct sg_table *sgt,
size_t size, bool cyclic);
void (*lock_queue)(struct iio_buffer *buffer);
void (*unlock_queue)(struct iio_buffer *buffer);
unsigned int modes;
unsigned int flags;
};
@ -136,6 +161,12 @@ struct iio_buffer {
/* @ref: Reference count of the buffer. */
struct kref ref;
/* @dmabufs: List of DMABUF attachments */
struct list_head dmabufs; /* P: dmabufs_mutex */
/* @dmabufs_mutex: Protects dmabufs */
struct mutex dmabufs_mutex;
};
/**
@ -159,6 +190,8 @@ void iio_buffer_init(struct iio_buffer *buffer);
struct iio_buffer *iio_buffer_get(struct iio_buffer *buffer);
void iio_buffer_put(struct iio_buffer *buffer);
void iio_buffer_signal_dmabuf_done(struct dma_fence *fence, int ret);
#else /* CONFIG_IIO_BUFFER */
static inline void iio_buffer_get(struct iio_buffer *buffer) {}

22
include/uapi/linux/iio/buffer.h
View File

@ -5,6 +5,28 @@
#ifndef _UAPI_IIO_BUFFER_H_
#define _UAPI_IIO_BUFFER_H_
#include <linux/types.h>
/* Flags for iio_dmabuf.flags */
#define IIO_BUFFER_DMABUF_CYCLIC (1 << 0)
#define IIO_BUFFER_DMABUF_SUPPORTED_FLAGS 0x00000001
/**
* struct iio_dmabuf - Descriptor for a single IIO DMABUF object
* @fd: file descriptor of the DMABUF object
* @flags: one or more IIO_BUFFER_DMABUF_* flags
* @bytes_used: number of bytes used in this DMABUF for the data transfer.
* Should generally be set to the DMABUF's size.
*/
struct iio_dmabuf {
__u32 fd;
__u32 flags;
__u64 bytes_used;
};
#define IIO_BUFFER_GET_FD_IOCTL _IOWR('i', 0x91, int)
#define IIO_BUFFER_DMABUF_ATTACH_IOCTL _IOW('i', 0x92, int)
#define IIO_BUFFER_DMABUF_DETACH_IOCTL _IOW('i', 0x93, int)
#define IIO_BUFFER_DMABUF_ENQUEUE_IOCTL _IOW('i', 0x94, struct iio_dmabuf)
#endif /* _UAPI_IIO_BUFFER_H_ */