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