xref: /dflybsd-src/sys/dev/drm/include/linux/dma-buf.h (revision 0ffa96a296bcf3e38b9a03a409a10889186072ae)
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 struct dma_buf_ops {
39 	struct sg_table * (*map_dma_buf)(struct dma_buf_attachment *,
40 						enum dma_data_direction);
41 	void (*unmap_dma_buf)(struct dma_buf_attachment *,
42 						struct sg_table *,
43 						enum dma_data_direction);
44 	void (*release)(struct dma_buf *);
45 	void *(*kmap)(struct dma_buf *, unsigned long);
46 	void *(*kmap_atomic)(struct dma_buf *, unsigned long);
47 	void (*kunmap)(struct dma_buf *, unsigned long, void *);
48 	void (*kunmap_atomic)(struct dma_buf *, unsigned long, void *);
49 	int (*mmap)(struct dma_buf *, struct vm_area_struct *vma);
50 	void *(*vmap)(struct dma_buf *);
51 	void (*vunmap)(struct dma_buf *, void *vaddr);
52 	int (*begin_cpu_access)(struct dma_buf *, enum dma_data_direction);
53 	int (*end_cpu_access)(struct dma_buf *, enum dma_data_direction);
54 };
55 
56 struct dma_buf {
57 	struct reservation_object *resv;
58 	void *priv;
59 	const struct dma_buf_ops *ops;
60 	size_t size;
61 };
62 
63 struct dma_buf_attachment {
64 	struct dma_buf *dmabuf;
65 	struct device *dev;
66 };
67 
68 struct dma_buf_export_info {
69 	const struct dma_buf_ops *ops;
70 	size_t size;
71 	int flags;
72 	void *priv;
73 };
74 
75 struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info);
76 
77 #define DEFINE_DMA_BUF_EXPORT_INFO(name)	\
78 	struct dma_buf_export_info name = {	\
79 	}
80 
81 struct sg_table * dma_buf_map_attachment(struct dma_buf_attachment *,
82 						enum dma_data_direction);
83 void dma_buf_unmap_attachment(struct dma_buf_attachment *,
84 				struct sg_table *, enum dma_data_direction);
85 
86 static inline struct dma_buf_attachment *
87 dma_buf_attach(struct dma_buf *dmabuf, struct device *dev)
88 {
89 	/* XXX: this function is a stub */
90 	struct dma_buf_attachment *attach;
91 
92 	attach = kmalloc(sizeof(struct dma_buf_attachment), M_DRM, M_WAITOK | M_ZERO);
93 
94 	return attach;
95 }
96 
97 
98 
99 #endif /* LINUX_DMA_BUF_H */
100