1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 3 #ifndef DRM_GEM_VRAM_HELPER_H 4 #define DRM_GEM_VRAM_HELPER_H 5 6 #include <drm/drm_file.h> 7 #include <drm/drm_gem.h> 8 #include <drm/drm_ioctl.h> 9 #include <drm/ttm/ttm_bo_api.h> 10 #include <drm/ttm/ttm_bo_driver.h> 11 #include <drm/ttm/ttm_placement.h> 12 13 #include <linux/kernel.h> /* for container_of() */ 14 15 struct drm_mode_create_dumb; 16 struct drm_vram_mm_funcs; 17 struct filp; 18 struct vm_area_struct; 19 20 #define DRM_GEM_VRAM_PL_FLAG_VRAM TTM_PL_FLAG_VRAM 21 #define DRM_GEM_VRAM_PL_FLAG_SYSTEM TTM_PL_FLAG_SYSTEM 22 23 /* 24 * Buffer-object helpers 25 */ 26 27 /** 28 * struct drm_gem_vram_object - GEM object backed by VRAM 29 * @gem: GEM object 30 * @bo: TTM buffer object 31 * @kmap: Mapping information for @bo 32 * @placement: TTM placement information. Supported placements are \ 33 %TTM_PL_VRAM and %TTM_PL_SYSTEM 34 * @placements: TTM placement information. 35 * @pin_count: Pin counter 36 * 37 * The type struct drm_gem_vram_object represents a GEM object that is 38 * backed by VRAM. It can be used for simple framebuffer devices with 39 * dedicated memory. The buffer object can be evicted to system memory if 40 * video memory becomes scarce. 41 * 42 * GEM VRAM objects perform reference counting for pin and mapping 43 * operations. So a buffer object that has been pinned N times with 44 * drm_gem_vram_pin() must be unpinned N times with 45 * drm_gem_vram_unpin(). The same applies to pairs of 46 * drm_gem_vram_kmap() and drm_gem_vram_kunmap(), as well as pairs of 47 * drm_gem_vram_vmap() and drm_gem_vram_vunmap(). 48 */ 49 struct drm_gem_vram_object { 50 struct ttm_buffer_object bo; 51 struct ttm_bo_kmap_obj kmap; 52 53 /** 54 * @kmap_use_count: 55 * 56 * Reference count on the virtual address. 57 * The address are un-mapped when the count reaches zero. 58 */ 59 unsigned int kmap_use_count; 60 61 /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */ 62 struct ttm_placement placement; 63 struct ttm_place placements[2]; 64 65 int pin_count; 66 }; 67 68 /** 69 * Returns the container of type &struct drm_gem_vram_object 70 * for field bo. 71 * @bo: the VRAM buffer object 72 * Returns: The containing GEM VRAM object 73 */ 74 static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( 75 struct ttm_buffer_object *bo) 76 { 77 return container_of(bo, struct drm_gem_vram_object, bo); 78 } 79 80 /** 81 * Returns the container of type &struct drm_gem_vram_object 82 * for field gem. 83 * @gem: the GEM object 84 * Returns: The containing GEM VRAM object 85 */ 86 static inline struct drm_gem_vram_object *drm_gem_vram_of_gem( 87 struct drm_gem_object *gem) 88 { 89 return container_of(gem, struct drm_gem_vram_object, bo.base); 90 } 91 92 struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev, 93 struct ttm_bo_device *bdev, 94 size_t size, 95 unsigned long pg_align, 96 bool interruptible); 97 void drm_gem_vram_put(struct drm_gem_vram_object *gbo); 98 u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo); 99 s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo); 100 int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag); 101 int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo); 102 void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map, 103 bool *is_iomem); 104 void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo); 105 void *drm_gem_vram_vmap(struct drm_gem_vram_object *gbo); 106 void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo, void *vaddr); 107 108 int drm_gem_vram_fill_create_dumb(struct drm_file *file, 109 struct drm_device *dev, 110 struct ttm_bo_device *bdev, 111 unsigned long pg_align, 112 bool interruptible, 113 struct drm_mode_create_dumb *args); 114 115 /* 116 * Helpers for struct drm_driver 117 */ 118 119 int drm_gem_vram_driver_dumb_create(struct drm_file *file, 120 struct drm_device *dev, 121 struct drm_mode_create_dumb *args); 122 int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file, 123 struct drm_device *dev, 124 uint32_t handle, uint64_t *offset); 125 126 /** 127 * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 128 &struct drm_driver 129 * 130 * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 131 * &struct drm_driver with default functions. 132 */ 133 #define DRM_GEM_VRAM_DRIVER \ 134 .debugfs_init = drm_vram_mm_debugfs_init, \ 135 .dumb_create = drm_gem_vram_driver_dumb_create, \ 136 .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \ 137 .gem_prime_mmap = drm_gem_prime_mmap 138 139 /* 140 * VRAM memory manager 141 */ 142 143 /** 144 * struct drm_vram_mm - An instance of VRAM MM 145 * @vram_base: Base address of the managed video memory 146 * @vram_size: Size of the managed video memory in bytes 147 * @bdev: The TTM BO device. 148 * @funcs: TTM BO functions 149 * 150 * The fields &struct drm_vram_mm.vram_base and 151 * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are 152 * available for public read access. Use the field 153 * &struct drm_vram_mm.bdev to access the TTM BO device. 154 */ 155 struct drm_vram_mm { 156 uint64_t vram_base; 157 size_t vram_size; 158 159 struct ttm_bo_device bdev; 160 }; 161 162 /** 163 * drm_vram_mm_of_bdev() - \ 164 Returns the container of type &struct ttm_bo_device for field bdev. 165 * @bdev: the TTM BO device 166 * 167 * Returns: 168 * The containing instance of &struct drm_vram_mm 169 */ 170 static inline struct drm_vram_mm *drm_vram_mm_of_bdev( 171 struct ttm_bo_device *bdev) 172 { 173 return container_of(bdev, struct drm_vram_mm, bdev); 174 } 175 176 int drm_vram_mm_debugfs_init(struct drm_minor *minor); 177 178 /* 179 * Helpers for integration with struct drm_device 180 */ 181 182 struct drm_vram_mm *drm_vram_helper_alloc_mm( 183 struct drm_device *dev, uint64_t vram_base, size_t vram_size); 184 void drm_vram_helper_release_mm(struct drm_device *dev); 185 186 /* 187 * Helpers for &struct file_operations 188 */ 189 190 int drm_vram_mm_file_operations_mmap( 191 struct file *filp, struct vm_area_struct *vma); 192 193 /** 194 * define DRM_VRAM_MM_FILE_OPERATIONS - default callback functions for \ 195 &struct file_operations 196 * 197 * Drivers that use VRAM MM can use this macro to initialize 198 * &struct file_operations with default functions. 199 */ 200 #define DRM_VRAM_MM_FILE_OPERATIONS \ 201 .llseek = no_llseek, \ 202 .read = drm_read, \ 203 .poll = drm_poll, \ 204 .unlocked_ioctl = drm_ioctl, \ 205 .compat_ioctl = drm_compat_ioctl, \ 206 .mmap = drm_vram_mm_file_operations_mmap, \ 207 .open = drm_open, \ 208 .release = drm_release \ 209 210 211 #endif 212