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