include/linux/dma-buf.h

   1 /*
   2  * Header file for dma buffer sharing framework.
   3  *
   4  * Copyright(C) 2011 Linaro Limited. All rights reserved.
   5  * Author: Sumit Semwal <[email protected]>
   6  *
   7  * Many thanks to linaro-mm-sig list, and specially
   8  * Arnd Bergmann <[email protected]>, Rob Clark <[email protected]> and
   9  * Daniel Vetter <[email protected]> for their support in creation and
  10  * refining of this idea.
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms of the GNU General Public License version 2 as published by
  14  * the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  19  * more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along with
  22  * this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 #ifndef __DMA_BUF_H__
  25 #define __DMA_BUF_H__
  26
  27 #include <linux/file.h>
  28 #include <linux/err.h>
  29 #include <linux/scatterlist.h>
  30 #include <linux/list.h>
  31 #include <linux/dma-mapping.h>
  32 #include <linux/fs.h>
  33 #include <linux/dma-fence.h>
  34 #include <linux/wait.h>
  35
  36 struct device;
  37 struct dma_buf;
  38 struct dma_buf_attachment;
  39
  40 /**
  41  * struct dma_buf_ops - operations possible on struct dma_buf
  42  * @map_atomic: [optional] maps a page from the buffer into kernel address
  43  *              space, users may not block until the subsequent unmap call.
  44  *              This callback must not sleep.
  45  * @unmap_atomic: [optional] unmaps a atomically mapped page from the buffer.
  46  *                This Callback must not sleep.
  47  * @map: [optional] maps a page from the buffer into kernel address space.
  48  * @unmap: [optional] unmaps a page from the buffer.
  49  * @vmap: [optional] creates a virtual mapping for the buffer into kernel
  50  *        address space. Same restrictions as for vmap and friends apply.
  51  * @vunmap: [optional] unmaps a vmap from the buffer
  52  */
  53 struct dma_buf_ops {
  54         /**
  55          * @attach:
  56          *
  57          * This is called from dma_buf_attach() to make sure that a given
  58          * &dma_buf_attachment.dev can access the provided &dma_buf. Exporters
  59          * which support buffer objects in special locations like VRAM or
  60          * device-specific carveout areas should check whether the buffer could
  61          * be move to system memory (or directly accessed by the provided
  62          * device), and otherwise need to fail the attach operation.
  63          *
  64          * The exporter should also in general check whether the current
  65          * allocation fullfills the DMA constraints of the new device. If this
  66          * is not the case, and the allocation cannot be moved, it should also
  67          * fail the attach operation.
  68          *
  69          * Any exporter-private housekeeping data can be stored in the
  70          * &dma_buf_attachment.priv pointer.
  71          *
  72          * This callback is optional.
  73          *
  74          * Returns:
  75          *
  76          * 0 on success, negative error code on failure. It might return -EBUSY
  77          * to signal that backing storage is already allocated and incompatible
  78          * with the requirements of requesting device.
  79          */
  80         int (*attach)(struct dma_buf *, struct dma_buf_attachment *);
  81
  82         /**
  83          * @detach:
  84          *
  85          * This is called by dma_buf_detach() to release a &dma_buf_attachment.
  86          * Provided so that exporters can clean up any housekeeping for an
  87          * &dma_buf_attachment.
  88          *
  89          * This callback is optional.
  90          */
  91         void (*detach)(struct dma_buf *, struct dma_buf_attachment *);
  92
  93         /**
  94          * @map_dma_buf:
  95          *
  96          * This is called by dma_buf_map_attachment() and is used to map a
  97          * shared &dma_buf into device address space, and it is mandatory. It
  98          * can only be called if @attach has been called successfully. This
  99          * essentially pins the DMA buffer into place, and it cannot be moved
 100          * any more
 101          *
 102          * This call may sleep, e.g. when the backing storage first needs to be
 103          * allocated, or moved to a location suitable for all currently attached
 104          * devices.
 105          *
 106          * Note that any specific buffer attributes required for this function
 107          * should get added to device_dma_parameters accessible via
 108          * &device.dma_params from the &dma_buf_attachment. The @attach callback
 109          * should also check these constraints.
 110          *
 111          * If this is being called for the first time, the exporter can now
 112          * choose to scan through the list of attachments for this buffer,
 113          * collate the requirements of the attached devices, and choose an
 114          * appropriate backing storage for the buffer.
 115          *
 116          * Based on enum dma_data_direction, it might be possible to have
 117          * multiple users accessing at the same time (for reading, maybe), or
 118          * any other kind of sharing that the exporter might wish to make
 119          * available to buffer-users.
 120          *
 121          * Returns:
 122          *
 123          * A &sg_table scatter list of or the backing storage of the DMA buffer,
 124          * already mapped into the device address space of the &device attached
 125          * with the provided &dma_buf_attachment.
 126          *
 127          * On failure, returns a negative error value wrapped into a pointer.
 128          * May also return -EINTR when a signal was received while being
 129          * blocked.
 130          */
 131         struct sg_table * (*map_dma_buf)(struct dma_buf_attachment *,
 132                                          enum dma_data_direction);
 133         /**
 134          * @unmap_dma_buf:
 135          *
 136          * This is called by dma_buf_unmap_attachment() and should unmap and
 137          * release the &sg_table allocated in @map_dma_buf, and it is mandatory.
 138          * It should also unpin the backing storage if this is the last mapping
 139          * of the DMA buffer, it the exporter supports backing storage
 140          * migration.
 141          */
 142         void (*unmap_dma_buf)(struct dma_buf_attachment *,
 143                               struct sg_table *,
 144                               enum dma_data_direction);
 145
 146         /* TODO: Add try_map_dma_buf version, to return immed with -EBUSY
 147          * if the call would block.
 148          */
 149
 150         /**
 151          * @release:
 152          *
 153          * Called after the last dma_buf_put to release the &dma_buf, and
 154          * mandatory.
 155          */
 156         void (*release)(struct dma_buf *);
 157
 158         /**
 159          * @begin_cpu_access:
 160          *
 161          * This is called from dma_buf_begin_cpu_access() and allows the
 162          * exporter to ensure that the memory is actually available for cpu
 163          * access - the exporter might need to allocate or swap-in and pin the
 164          * backing storage. The exporter also needs to ensure that cpu access is
 165          * coherent for the access direction. The direction can be used by the
 166          * exporter to optimize the cache flushing, i.e. access with a different
 167          * direction (read instead of write) might return stale or even bogus
 168          * data (e.g. when the exporter needs to copy the data to temporary
 169          * storage).
 170          *
 171          * This callback is optional.
 172          *
 173          * FIXME: This is both called through the DMA_BUF_IOCTL_SYNC command
 174          * from userspace (where storage shouldn't be pinned to avoid handing
 175          * de-factor mlock rights to userspace) and for the kernel-internal
 176          * users of the various kmap interfaces, where the backing storage must
 177          * be pinned to guarantee that the atomic kmap calls can succeed. Since
 178          * there's no in-kernel users of the kmap interfaces yet this isn't a
 179          * real problem.
 180          *
 181          * Returns:
 182          *
 183          * 0 on success or a negative error code on failure. This can for
 184          * example fail when the backing storage can't be allocated. Can also
 185          * return -ERESTARTSYS or -EINTR when the call has been interrupted and
 186          * needs to be restarted.
 187          */
 188         int (*begin_cpu_access)(struct dma_buf *, enum dma_data_direction);
 189
 190         /**
 191          * @end_cpu_access:
 192          *
 193          * This is called from dma_buf_end_cpu_access() when the importer is
 194          * done accessing the CPU. The exporter can use this to flush caches and
 195          * unpin any resources pinned in @begin_cpu_access.
 196          * The result of any dma_buf kmap calls after end_cpu_access is
 197          * undefined.
 198          *
 199          * This callback is optional.
 200          *
 201          * Returns:
 202          *
 203          * 0 on success or a negative error code on failure. Can return
 204          * -ERESTARTSYS or -EINTR when the call has been interrupted and needs
 205          * to be restarted.
 206          */
 207         int (*end_cpu_access)(struct dma_buf *, enum dma_data_direction);
 208         void *(*map_atomic)(struct dma_buf *, unsigned long);
 209         void (*unmap_atomic)(struct dma_buf *, unsigned long, void *);
 210         void *(*map)(struct dma_buf *, unsigned long);
 211         void (*unmap)(struct dma_buf *, unsigned long, void *);
 212
 213         /**
 214          * @mmap:
 215          *
 216          * This callback is used by the dma_buf_mmap() function
 217          *
 218          * Note that the mapping needs to be incoherent, userspace is expected
 219          * to braket CPU access using the DMA_BUF_IOCTL_SYNC interface.
 220          *
 221          * Because dma-buf buffers have invariant size over their lifetime, the
 222          * dma-buf core checks whether a vma is too large and rejects such
 223          * mappings. The exporter hence does not need to duplicate this check.
 224          * Drivers do not need to check this themselves.
 225          *
 226          * If an exporter needs to manually flush caches and hence needs to fake
 227          * coherency for mmap support, it needs to be able to zap all the ptes
 228          * pointing at the backing storage. Now linux mm needs a struct
 229          * address_space associated with the struct file stored in vma->vm_file
 230          * to do that with the function unmap_mapping_range. But the dma_buf
 231          * framework only backs every dma_buf fd with the anon_file struct file,
 232          * i.e. all dma_bufs share the same file.
 233          *
 234          * Hence exporters need to setup their own file (and address_space)
 235          * association by setting vma->vm_file and adjusting vma->vm_pgoff in
 236          * the dma_buf mmap callback. In the specific case of a gem driver the
 237          * exporter could use the shmem file already provided by gem (and set
 238          * vm_pgoff = 0). Exporters can then zap ptes by unmapping the
 239          * corresponding range of the struct address_space associated with their
 240          * own file.
 241          *
 242          * This callback is optional.
 243          *
 244          * Returns:
 245          *
 246          * 0 on success or a negative error code on failure.
 247          */
 248         int (*mmap)(struct dma_buf *, struct vm_area_struct *vma);
 249
 250         void *(*vmap)(struct dma_buf *);
 251         void (*vunmap)(struct dma_buf *, void *vaddr);
 252 };
 253
 254 /**
 255  * struct dma_buf - shared buffer object
 256  * @size: size of the buffer
 257  * @file: file pointer used for sharing buffers across, and for refcounting.
 258  * @attachments: list of dma_buf_attachment that denotes all devices attached.
 259  * @ops: dma_buf_ops associated with this buffer object.
 260  * @lock: used internally to serialize list manipulation, attach/detach and vmap/unmap
 261  * @vmapping_counter: used internally to refcnt the vmaps
 262  * @vmap_ptr: the current vmap ptr if vmapping_counter > 0
 263  * @exp_name: name of the exporter; useful for debugging.
 264  * @owner: pointer to exporter module; used for refcounting when exporter is a
 265  *         kernel module.
 266  * @list_node: node for dma_buf accounting and debugging.
 267  * @priv: exporter specific private data for this buffer object.
 268  * @resv: reservation object linked to this dma-buf
 269  * @poll: for userspace poll support
 270  * @cb_excl: for userspace poll support
 271  * @cb_shared: for userspace poll support
 272  *
 273  * This represents a shared buffer, created by calling dma_buf_export(). The
 274  * userspace representation is a normal file descriptor, which can be created by
 275  * calling dma_buf_fd().
 276  *
 277  * Shared dma buffers are reference counted using dma_buf_put() and
 278  * get_dma_buf().
 279  *
 280  * Device DMA access is handled by the separate &struct dma_buf_attachment.
 281  */
 282 struct dma_buf {
 283         size_t size;
 284         struct file *file;
 285         struct list_head attachments;
 286         const struct dma_buf_ops *ops;
 287         struct mutex lock;
 288         unsigned vmapping_counter;
 289         void *vmap_ptr;
 290         const char *exp_name;
 291         struct module *owner;
 292         struct list_head list_node;
 293         void *priv;
 294         struct reservation_object *resv;
 295
 296         /* poll support */
 297         wait_queue_head_t poll;
 298
 299         struct dma_buf_poll_cb_t {
 300                 struct dma_fence_cb cb;
 301                 wait_queue_head_t *poll;
 302
 303                 __poll_t active;
 304         } cb_excl, cb_shared;
 305 };
 306
 307 /**
 308  * struct dma_buf_attachment - holds device-buffer attachment data
 309  * @dmabuf: buffer for this attachment.
 310  * @dev: device attached to the buffer.
 311  * @node: list of dma_buf_attachment.
 312  * @priv: exporter specific attachment data.
 313  *
 314  * This structure holds the attachment information between the dma_buf buffer
 315  * and its user device(s). The list contains one attachment struct per device
 316  * attached to the buffer.
 317  *
 318  * An attachment is created by calling dma_buf_attach(), and released again by
 319  * calling dma_buf_detach(). The DMA mapping itself needed to initiate a
 320  * transfer is created by dma_buf_map_attachment() and freed again by calling
 321  * dma_buf_unmap_attachment().
 322  */
 323 struct dma_buf_attachment {
 324         struct dma_buf *dmabuf;
 325         struct device *dev;
 326         struct list_head node;
 327         void *priv;
 328 };
 329
 330 /**
 331  * struct dma_buf_export_info - holds information needed to export a dma_buf
 332  * @exp_name:   name of the exporter - useful for debugging.
 333  * @owner:      pointer to exporter module - used for refcounting kernel module
 334  * @ops:        Attach allocator-defined dma buf ops to the new buffer
 335  * @size:       Size of the buffer
 336  * @flags:      mode flags for the file
 337  * @resv:       reservation-object, NULL to allocate default one
 338  * @priv:       Attach private data of allocator to this buffer
 339  *
 340  * This structure holds the information required to export the buffer. Used
 341  * with dma_buf_export() only.
 342  */
 343 struct dma_buf_export_info {
 344         const char *exp_name;
 345         struct module *owner;
 346         const struct dma_buf_ops *ops;
 347         size_t size;
 348         int flags;
 349         struct reservation_object *resv;
 350         void *priv;
 351 };
 352
 353 /**
 354  * DEFINE_DMA_BUF_EXPORT_INFO - helper macro for exporters
 355  * @name: export-info name
 356  *
 357  * DEFINE_DMA_BUF_EXPORT_INFO macro defines the &struct dma_buf_export_info,
 358  * zeroes it out and pre-populates exp_name in it.
 359  */
 360 #define DEFINE_DMA_BUF_EXPORT_INFO(name)        \
 361         struct dma_buf_export_info name = { .exp_name = KBUILD_MODNAME, \
 362                                          .owner = THIS_MODULE }
 363
 364 /**
 365  * get_dma_buf - convenience wrapper for get_file.
 366  * @dmabuf:     [in]    pointer to dma_buf
 367  *
 368  * Increments the reference count on the dma-buf, needed in case of drivers
 369  * that either need to create additional references to the dmabuf on the
 370  * kernel side.  For example, an exporter that needs to keep a dmabuf ptr
 371  * so that subsequent exports don't create a new dmabuf.
 372  */
 373 static inline void get_dma_buf(struct dma_buf *dmabuf)
 374 {
 375         get_file(dmabuf->file);
 376 }
 377
 378 struct dma_buf_attachment *dma_buf_attach(struct dma_buf *dmabuf,
 379                                                         struct device *dev);
 380 void dma_buf_detach(struct dma_buf *dmabuf,
 381                                 struct dma_buf_attachment *dmabuf_attach);
 382
 383 struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info);
 384
 385 int dma_buf_fd(struct dma_buf *dmabuf, int flags);
 386 struct dma_buf *dma_buf_get(int fd);
 387 void dma_buf_put(struct dma_buf *dmabuf);
 388
 389 struct sg_table *dma_buf_map_attachment(struct dma_buf_attachment *,
 390                                         enum dma_data_direction);
 391 void dma_buf_unmap_attachment(struct dma_buf_attachment *, struct sg_table *,
 392                                 enum dma_data_direction);
 393 int dma_buf_begin_cpu_access(struct dma_buf *dma_buf,
 394                              enum dma_data_direction dir);
 395 int dma_buf_end_cpu_access(struct dma_buf *dma_buf,
 396                            enum dma_data_direction dir);
 397 void *dma_buf_kmap_atomic(struct dma_buf *, unsigned long);
 398 void dma_buf_kunmap_atomic(struct dma_buf *, unsigned long, void *);
 399 void *dma_buf_kmap(struct dma_buf *, unsigned long);
 400 void dma_buf_kunmap(struct dma_buf *, unsigned long, void *);
 401
 402 int dma_buf_mmap(struct dma_buf *, struct vm_area_struct *,
 403                  unsigned long);
 404 void *dma_buf_vmap(struct dma_buf *);
 405 void dma_buf_vunmap(struct dma_buf *, void *vaddr);
 406 #endif /* __DMA_BUF_H__ */