drm_gem_cma_helper.h revision 1.1 1 /* $NetBSD: drm_gem_cma_helper.h,v 1.1 2021/12/19 10:24:33 riastradh Exp $ */
2
3 /* SPDX-License-Identifier: GPL-2.0 */
4 #ifndef __DRM_GEM_CMA_HELPER_H__
5 #define __DRM_GEM_CMA_HELPER_H__
6
7 #include <drm/drm_file.h>
8 #include <drm/drm_ioctl.h>
9 #include <drm/drm_gem.h>
10
11 struct drm_mode_create_dumb;
12
13 /**
14 * struct drm_gem_cma_object - GEM object backed by CMA memory allocations
15 * @base: base GEM object
16 * @paddr: physical address of the backing memory
17 * @sgt: scatter/gather table for imported PRIME buffers. The table can have
18 * more than one entry but they are guaranteed to have contiguous
19 * DMA addresses.
20 * @vaddr: kernel virtual address of the backing memory
21 */
22 struct drm_gem_cma_object {
23 struct drm_gem_object base;
24 #ifdef __NetBSD__
25 bus_dma_tag_t dmat;
26 bus_dma_segment_t dmasegs[1];
27 bus_size_t dmasize;
28 bus_dmamap_t dmamap;
29 vmem_t *vmem_pool;
30 vmem_addr_t vmem_addr;
31 #else
32 dma_addr_t paddr;
33 #endif
34 struct sg_table *sgt;
35
36 /* For objects with DMA memory allocated by GEM CMA */
37 void *vaddr;
38 };
39
40 #define to_drm_gem_cma_obj(gem_obj) \
41 container_of(gem_obj, struct drm_gem_cma_object, base)
42
43 #ifndef CONFIG_MMU
44 #define DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
45 .get_unmapped_area = drm_gem_cma_get_unmapped_area,
46 #else
47 #define DRM_GEM_CMA_UNMAPPED_AREA_FOPS
48 #endif
49
50 /**
51 * DEFINE_DRM_GEM_CMA_FOPS() - macro to generate file operations for CMA drivers
52 * @name: name for the generated structure
53 *
54 * This macro autogenerates a suitable &struct file_operations for CMA based
55 * drivers, which can be assigned to &drm_driver.fops. Note that this structure
56 * cannot be shared between drivers, because it contains a reference to the
57 * current module using THIS_MODULE.
58 *
59 * Note that the declaration is already marked as static - if you need a
60 * non-static version of this you're probably doing it wrong and will break the
61 * THIS_MODULE reference by accident.
62 */
63 #define DEFINE_DRM_GEM_CMA_FOPS(name) \
64 static const struct file_operations name = {\
65 .owner = THIS_MODULE,\
66 .open = drm_open,\
67 .release = drm_release,\
68 .unlocked_ioctl = drm_ioctl,\
69 .compat_ioctl = drm_compat_ioctl,\
70 .poll = drm_poll,\
71 .read = drm_read,\
72 .llseek = noop_llseek,\
73 .mmap = drm_gem_cma_mmap,\
74 DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
75 }
76
77 /* free GEM object */
78 void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
79
80 /* create memory region for DRM framebuffer */
81 int drm_gem_cma_dumb_create_internal(struct drm_file *file_priv,
82 struct drm_device *drm,
83 struct drm_mode_create_dumb *args);
84
85 /* create memory region for DRM framebuffer */
86 int drm_gem_cma_dumb_create(struct drm_file *file_priv,
87 struct drm_device *drm,
88 struct drm_mode_create_dumb *args);
89
90 /* set vm_flags and we can change the VM attribute to other one at here */
91 #ifndef __NetBSD__
92 int drm_gem_cma_mmap(struct file *filp, struct vm_area_struct *vma);
93 #endif
94
95 /* allocate physical memory */
96 struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
97 size_t size);
98
99 #ifdef __NetBSD__
100 extern const struct uvm_pagerops drm_gem_cma_uvm_ops;
101 #else
102 extern const struct vm_operations_struct drm_gem_cma_vm_ops;
103 #endif
104
105 #ifndef CONFIG_MMU
106 unsigned long drm_gem_cma_get_unmapped_area(struct file *filp,
107 unsigned long addr,
108 unsigned long len,
109 unsigned long pgoff,
110 unsigned long flags);
111 #endif
112
113 void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
114 const struct drm_gem_object *obj);
115
116 struct sg_table *drm_gem_cma_prime_get_sg_table(struct drm_gem_object *obj);
117 struct drm_gem_object *
118 drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
119 struct dma_buf_attachment *attach,
120 struct sg_table *sgt);
121 #ifdef __NetBSD__
122 int drm_gem_cma_prime_mmap(struct drm_gem_object *, off_t *, size_t, int,
123 int *, int *, struct uvm_object **, int *);
124 #else
125 int drm_gem_cma_prime_mmap(struct drm_gem_object *obj,
126 struct vm_area_struct *vma);
127 #endif
128 void *drm_gem_cma_prime_vmap(struct drm_gem_object *obj);
129 void drm_gem_cma_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
130
131 struct drm_gem_object *
132 drm_cma_gem_create_object_default_funcs(struct drm_device *dev, size_t size);
133
134 /**
135 * DRM_GEM_CMA_VMAP_DRIVER_OPS - CMA GEM driver operations ensuring a virtual
136 * address on the buffer
137 *
138 * This macro provides a shortcut for setting the default GEM operations in the
139 * &drm_driver structure for drivers that need the virtual address also on
140 * imported buffers.
141 */
142 #define DRM_GEM_CMA_VMAP_DRIVER_OPS \
143 .gem_create_object = drm_cma_gem_create_object_default_funcs, \
144 .dumb_create = drm_gem_cma_dumb_create, \
145 .prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
146 .prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
147 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table_vmap, \
148 .gem_prime_mmap = drm_gem_prime_mmap
149
150 struct drm_gem_object *
151 drm_gem_cma_prime_import_sg_table_vmap(struct drm_device *drm,
152 struct dma_buf_attachment *attach,
153 struct sg_table *sgt);
154
155 #endif /* __DRM_GEM_CMA_HELPER_H__ */
156