1 /* SPDX-License-Identifier: GPL-2.0 */ 2 3 #ifndef __DRM_GEM_SHMEM_HELPER_H__ 4 #define __DRM_GEM_SHMEM_HELPER_H__ 5 6 #include <linux/fs.h> 7 #include <linux/mm.h> 8 #include <linux/mutex.h> 9 10 #include <drm/drm_file.h> 11 #include <drm/drm_gem.h> 12 #include <drm/drm_ioctl.h> 13 #include <drm/drm_prime.h> 14 15 struct dma_buf_attachment; 16 struct drm_mode_create_dumb; 17 struct drm_printer; 18 struct sg_table; 19 20 /** 21 * struct drm_gem_shmem_object - GEM object backed by shmem 22 */ 23 struct drm_gem_shmem_object { 24 /** 25 * @base: Base GEM object 26 */ 27 struct drm_gem_object base; 28 29 /** 30 * @pages: Page table 31 */ 32 struct page **pages; 33 34 /** 35 * @pages_use_count: 36 * 37 * Reference count on the pages table. 38 * The pages are put when the count reaches zero. 39 */ 40 unsigned int pages_use_count; 41 42 /** 43 * @madv: State for madvise 44 * 45 * 0 is active/inuse. 46 * A negative value is the object is purged. 47 * Positive values are driver specific and not used by the helpers. 48 */ 49 int madv; 50 51 /** 52 * @madv_list: List entry for madvise tracking 53 * 54 * Typically used by drivers to track purgeable objects 55 */ 56 struct list_head madv_list; 57 58 /** 59 * @sgt: Scatter/gather table for imported PRIME buffers 60 */ 61 struct sg_table *sgt; 62 63 /** 64 * @vaddr: Kernel virtual address of the backing memory 65 */ 66 void *vaddr; 67 68 /** 69 * @vmap_use_count: 70 * 71 * Reference count on the virtual address. 72 * The address are un-mapped when the count reaches zero. 73 */ 74 unsigned int vmap_use_count; 75 76 /** 77 * @pages_mark_dirty_on_put: 78 * 79 * Mark pages as dirty when they are put. 80 */ 81 bool pages_mark_dirty_on_put : 1; 82 83 /** 84 * @pages_mark_accessed_on_put: 85 * 86 * Mark pages as accessed when they are put. 87 */ 88 bool pages_mark_accessed_on_put : 1; 89 90 /** 91 * @map_wc: map object write-combined (instead of using shmem defaults). 92 */ 93 bool map_wc : 1; 94 }; 95 96 #define to_drm_gem_shmem_obj(obj) \ 97 container_of(obj, struct drm_gem_shmem_object, base) 98 99 struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size); 100 void drm_gem_shmem_free(struct drm_gem_shmem_object *shmem); 101 102 void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem); 103 int drm_gem_shmem_pin(struct drm_gem_shmem_object *shmem); 104 void drm_gem_shmem_unpin(struct drm_gem_shmem_object *shmem); 105 int drm_gem_shmem_vmap(struct drm_gem_shmem_object *shmem, 106 struct iosys_map *map); 107 void drm_gem_shmem_vunmap(struct drm_gem_shmem_object *shmem, 108 struct iosys_map *map); 109 int drm_gem_shmem_mmap(struct drm_gem_shmem_object *shmem, struct vm_area_struct *vma); 110 111 int drm_gem_shmem_pin_locked(struct drm_gem_shmem_object *shmem); 112 void drm_gem_shmem_unpin_locked(struct drm_gem_shmem_object *shmem); 113 114 int drm_gem_shmem_madvise(struct drm_gem_shmem_object *shmem, int madv); 115 116 static inline bool drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object *shmem) 117 { 118 return (shmem->madv > 0) && 119 !shmem->vmap_use_count && shmem->sgt && 120 !shmem->base.dma_buf && !shmem->base.import_attach; 121 } 122 123 void drm_gem_shmem_purge(struct drm_gem_shmem_object *shmem); 124 125 struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_shmem_object *shmem); 126 struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_shmem_object *shmem); 127 128 void drm_gem_shmem_print_info(const struct drm_gem_shmem_object *shmem, 129 struct drm_printer *p, unsigned int indent); 130 131 extern const struct vm_operations_struct drm_gem_shmem_vm_ops; 132 133 /* 134 * GEM object functions 135 */ 136 137 /** 138 * drm_gem_shmem_object_free - GEM object function for drm_gem_shmem_free() 139 * @obj: GEM object to free 140 * 141 * This function wraps drm_gem_shmem_free(). Drivers that employ the shmem helpers 142 * should use it as their &drm_gem_object_funcs.free handler. 143 */ 144 static inline void drm_gem_shmem_object_free(struct drm_gem_object *obj) 145 { 146 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 147 148 drm_gem_shmem_free(shmem); 149 } 150 151 /** 152 * drm_gem_shmem_object_print_info() - Print &drm_gem_shmem_object info for debugfs 153 * @p: DRM printer 154 * @indent: Tab indentation level 155 * @obj: GEM object 156 * 157 * This function wraps drm_gem_shmem_print_info(). Drivers that employ the shmem helpers should 158 * use this function as their &drm_gem_object_funcs.print_info handler. 159 */ 160 static inline void drm_gem_shmem_object_print_info(struct drm_printer *p, unsigned int indent, 161 const struct drm_gem_object *obj) 162 { 163 const struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 164 165 drm_gem_shmem_print_info(shmem, p, indent); 166 } 167 168 /** 169 * drm_gem_shmem_object_pin - GEM object function for drm_gem_shmem_pin() 170 * @obj: GEM object 171 * 172 * This function wraps drm_gem_shmem_pin(). Drivers that employ the shmem helpers should 173 * use it as their &drm_gem_object_funcs.pin handler. 174 */ 175 static inline int drm_gem_shmem_object_pin(struct drm_gem_object *obj) 176 { 177 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 178 179 return drm_gem_shmem_pin_locked(shmem); 180 } 181 182 /** 183 * drm_gem_shmem_object_unpin - GEM object function for drm_gem_shmem_unpin() 184 * @obj: GEM object 185 * 186 * This function wraps drm_gem_shmem_unpin(). Drivers that employ the shmem helpers should 187 * use it as their &drm_gem_object_funcs.unpin handler. 188 */ 189 static inline void drm_gem_shmem_object_unpin(struct drm_gem_object *obj) 190 { 191 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 192 193 drm_gem_shmem_unpin_locked(shmem); 194 } 195 196 /** 197 * drm_gem_shmem_object_get_sg_table - GEM object function for drm_gem_shmem_get_sg_table() 198 * @obj: GEM object 199 * 200 * This function wraps drm_gem_shmem_get_sg_table(). Drivers that employ the shmem helpers should 201 * use it as their &drm_gem_object_funcs.get_sg_table handler. 202 * 203 * Returns: 204 * A pointer to the scatter/gather table of pinned pages or error pointer on failure. 205 */ 206 static inline struct sg_table *drm_gem_shmem_object_get_sg_table(struct drm_gem_object *obj) 207 { 208 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 209 210 return drm_gem_shmem_get_sg_table(shmem); 211 } 212 213 /* 214 * drm_gem_shmem_object_vmap - GEM object function for drm_gem_shmem_vmap() 215 * @obj: GEM object 216 * @map: Returns the kernel virtual address of the SHMEM GEM object's backing store. 217 * 218 * This function wraps drm_gem_shmem_vmap(). Drivers that employ the shmem helpers should 219 * use it as their &drm_gem_object_funcs.vmap handler. 220 * 221 * Returns: 222 * 0 on success or a negative error code on failure. 223 */ 224 static inline int drm_gem_shmem_object_vmap(struct drm_gem_object *obj, 225 struct iosys_map *map) 226 { 227 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 228 229 return drm_gem_shmem_vmap(shmem, map); 230 } 231 232 /* 233 * drm_gem_shmem_object_vunmap - GEM object function for drm_gem_shmem_vunmap() 234 * @obj: GEM object 235 * @map: Kernel virtual address where the SHMEM GEM object was mapped 236 * 237 * This function wraps drm_gem_shmem_vunmap(). Drivers that employ the shmem helpers should 238 * use it as their &drm_gem_object_funcs.vunmap handler. 239 */ 240 static inline void drm_gem_shmem_object_vunmap(struct drm_gem_object *obj, 241 struct iosys_map *map) 242 { 243 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 244 245 drm_gem_shmem_vunmap(shmem, map); 246 } 247 248 /** 249 * drm_gem_shmem_object_mmap - GEM object function for drm_gem_shmem_mmap() 250 * @obj: GEM object 251 * @vma: VMA for the area to be mapped 252 * 253 * This function wraps drm_gem_shmem_mmap(). Drivers that employ the shmem helpers should 254 * use it as their &drm_gem_object_funcs.mmap handler. 255 * 256 * Returns: 257 * 0 on success or a negative error code on failure. 258 */ 259 static inline int drm_gem_shmem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma) 260 { 261 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj); 262 263 return drm_gem_shmem_mmap(shmem, vma); 264 } 265 266 /* 267 * Driver ops 268 */ 269 270 struct drm_gem_object * 271 drm_gem_shmem_prime_import_sg_table(struct drm_device *dev, 272 struct dma_buf_attachment *attach, 273 struct sg_table *sgt); 274 int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev, 275 struct drm_mode_create_dumb *args); 276 277 /** 278 * DRM_GEM_SHMEM_DRIVER_OPS - Default shmem GEM operations 279 * 280 * This macro provides a shortcut for setting the shmem GEM operations in 281 * the &drm_driver structure. 282 */ 283 #define DRM_GEM_SHMEM_DRIVER_OPS \ 284 .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table, \ 285 .dumb_create = drm_gem_shmem_dumb_create 286 287 #endif /* __DRM_GEM_SHMEM_HELPER_H__ */ 288