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