sys/dev/drm/include/linux/dma-buf.h

   1 /*
   2  * Copyright (c) 2018-2019 François Tigeot <ftigeot@wolfpond.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice unmodified, this list of conditions, and the following
  10  *    disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef LINUX_DMA_BUF_H
  28 #define LINUX_DMA_BUF_H
  29
  30 #include <linux/err.h>
  31 #include <linux/scatterlist.h>
  32 #include <linux/list.h>
  33 #include <linux/dma-mapping.h>
  34 #include <linux/fs.h>
  35 #include <linux/fence.h>
  36 #include <linux/wait.h>
  37
  38 #include <linux/slab.h>
  39
  40 struct dma_buf;
  41 struct dma_buf_attachment;
  42
  43 struct dma_buf_ops {
  44         struct sg_table * (*map_dma_buf)(struct dma_buf_attachment *,
  45                                                 enum dma_data_direction);
  46         void (*unmap_dma_buf)(struct dma_buf_attachment *,
  47                                                 struct sg_table *,
  48                                                 enum dma_data_direction);
  49         void (*release)(struct dma_buf *);
  50         void *(*kmap)(struct dma_buf *, unsigned long);
  51         void *(*kmap_atomic)(struct dma_buf *, unsigned long);
  52         void (*kunmap)(struct dma_buf *, unsigned long, void *);
  53         void (*kunmap_atomic)(struct dma_buf *, unsigned long, void *);
  54         int (*mmap)(struct dma_buf *, struct vm_area_struct *vma);
  55         void *(*vmap)(struct dma_buf *);
  56         void (*vunmap)(struct dma_buf *, void *vaddr);
  57         int (*begin_cpu_access)(struct dma_buf *, enum dma_data_direction);
  58         int (*end_cpu_access)(struct dma_buf *, enum dma_data_direction);
  59         int (*attach)(struct dma_buf *, struct device *, struct dma_buf_attachment *);
  60         void (*detach)(struct dma_buf *, struct dma_buf_attachment *);
  61 };
  62
  63 struct dma_buf {
  64         struct reservation_object *resv;
  65         void *priv;
  66         const struct dma_buf_ops *ops;
  67         size_t size;
  68 };
  69
  70 struct dma_buf_attachment {
  71         struct dma_buf *dmabuf;
  72         struct device *dev;
  73         void *priv;
  74 };
  75
  76 struct dma_buf_export_info {
  77         const struct dma_buf_ops *ops;
  78         size_t size;
  79         int flags;
  80         void *priv;
  81         struct reservation_object *resv;
  82 };
  83
  84 struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info);
  85
  86 #define DEFINE_DMA_BUF_EXPORT_INFO(name)        \
  87         struct dma_buf_export_info name = {     \
  88         }
  89
  90 struct sg_table * dma_buf_map_attachment(struct dma_buf_attachment *,
  91                                                 enum dma_data_direction);
  92 void dma_buf_unmap_attachment(struct dma_buf_attachment *,
  93                                 struct sg_table *, enum dma_data_direction);
  94
  95 static inline struct dma_buf_attachment *
  96 dma_buf_attach(struct dma_buf *dmabuf, struct device *dev)
  97 {
  98         /* XXX: this function is a stub */
  99         struct dma_buf_attachment *attach;
 100
 101         attach = kmalloc(sizeof(struct dma_buf_attachment), M_DRM, M_WAITOK | M_ZERO);
 102
 103         return attach;
 104 }
 105
 106 #endif /* LINUX_DMA_BUF_H */