185438a8dSThomas Zimmermann /* SPDX-License-Identifier: GPL-2.0-or-later */ 285438a8dSThomas Zimmermann 385438a8dSThomas Zimmermann #ifndef DRM_GEM_VRAM_HELPER_H 485438a8dSThomas Zimmermann #define DRM_GEM_VRAM_HELPER_H 585438a8dSThomas Zimmermann 685438a8dSThomas Zimmermann #include <drm/drm_gem.h> 785438a8dSThomas Zimmermann #include <drm/ttm/ttm_bo_api.h> 885438a8dSThomas Zimmermann #include <drm/ttm/ttm_placement.h> 985438a8dSThomas Zimmermann #include <linux/kernel.h> /* for container_of() */ 1085438a8dSThomas Zimmermann 11fed1eec0SThomas Zimmermann struct drm_mode_create_dumb; 125c9dcacfSThomas Zimmermann struct drm_vram_mm_funcs; 1385438a8dSThomas Zimmermann struct filp; 1459f5989aSThomas Zimmermann struct vm_area_struct; 1585438a8dSThomas Zimmermann 1685438a8dSThomas Zimmermann #define DRM_GEM_VRAM_PL_FLAG_VRAM TTM_PL_FLAG_VRAM 1785438a8dSThomas Zimmermann #define DRM_GEM_VRAM_PL_FLAG_SYSTEM TTM_PL_FLAG_SYSTEM 1885438a8dSThomas Zimmermann 1985438a8dSThomas Zimmermann /* 2085438a8dSThomas Zimmermann * Buffer-object helpers 2185438a8dSThomas Zimmermann */ 2285438a8dSThomas Zimmermann 2385438a8dSThomas Zimmermann /** 2485438a8dSThomas Zimmermann * struct drm_gem_vram_object - GEM object backed by VRAM 2585438a8dSThomas Zimmermann * @gem: GEM object 2685438a8dSThomas Zimmermann * @bo: TTM buffer object 2785438a8dSThomas Zimmermann * @kmap: Mapping information for @bo 2885438a8dSThomas Zimmermann * @placement: TTM placement information. Supported placements are \ 2985438a8dSThomas Zimmermann %TTM_PL_VRAM and %TTM_PL_SYSTEM 3085438a8dSThomas Zimmermann * @placements: TTM placement information. 3185438a8dSThomas Zimmermann * @pin_count: Pin counter 3285438a8dSThomas Zimmermann * 3385438a8dSThomas Zimmermann * The type struct drm_gem_vram_object represents a GEM object that is 3485438a8dSThomas Zimmermann * backed by VRAM. It can be used for simple framebuffer devices with 3585438a8dSThomas Zimmermann * dedicated memory. The buffer object can be evicted to system memory if 3685438a8dSThomas Zimmermann * video memory becomes scarce. 3737a48adfSThomas Zimmermann * 3837a48adfSThomas Zimmermann * GEM VRAM objects perform reference counting for pin and mapping 3937a48adfSThomas Zimmermann * operations. So a buffer object that has been pinned N times with 4037a48adfSThomas Zimmermann * drm_gem_vram_pin() must be unpinned N times with 4137a48adfSThomas Zimmermann * drm_gem_vram_unpin(). The same applies to pairs of 4237a48adfSThomas Zimmermann * drm_gem_vram_kmap() and drm_gem_vram_kunmap(). 4385438a8dSThomas Zimmermann */ 4485438a8dSThomas Zimmermann struct drm_gem_vram_object { 4585438a8dSThomas Zimmermann struct ttm_buffer_object bo; 4685438a8dSThomas Zimmermann struct ttm_bo_kmap_obj kmap; 4785438a8dSThomas Zimmermann 4837a48adfSThomas Zimmermann /** 4937a48adfSThomas Zimmermann * @kmap_use_count: 5037a48adfSThomas Zimmermann * 5137a48adfSThomas Zimmermann * Reference count on the virtual address. 5237a48adfSThomas Zimmermann * The address are un-mapped when the count reaches zero. 5337a48adfSThomas Zimmermann */ 5437a48adfSThomas Zimmermann unsigned int kmap_use_count; 5537a48adfSThomas Zimmermann 5685438a8dSThomas Zimmermann /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */ 5785438a8dSThomas Zimmermann struct ttm_placement placement; 5885438a8dSThomas Zimmermann struct ttm_place placements[2]; 5985438a8dSThomas Zimmermann 6085438a8dSThomas Zimmermann int pin_count; 6185438a8dSThomas Zimmermann }; 6285438a8dSThomas Zimmermann 6385438a8dSThomas Zimmermann /** 6485438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 6585438a8dSThomas Zimmermann * for field bo. 6685438a8dSThomas Zimmermann * @bo: the VRAM buffer object 6785438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 6885438a8dSThomas Zimmermann */ 6985438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( 7085438a8dSThomas Zimmermann struct ttm_buffer_object *bo) 7185438a8dSThomas Zimmermann { 7285438a8dSThomas Zimmermann return container_of(bo, struct drm_gem_vram_object, bo); 7385438a8dSThomas Zimmermann } 7485438a8dSThomas Zimmermann 7585438a8dSThomas Zimmermann /** 7685438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 7785438a8dSThomas Zimmermann * for field gem. 7885438a8dSThomas Zimmermann * @gem: the GEM object 7985438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 8085438a8dSThomas Zimmermann */ 8185438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_gem( 8285438a8dSThomas Zimmermann struct drm_gem_object *gem) 8385438a8dSThomas Zimmermann { 840e580c6dSGerd Hoffmann return container_of(gem, struct drm_gem_vram_object, bo.base); 8585438a8dSThomas Zimmermann } 8685438a8dSThomas Zimmermann 8785438a8dSThomas Zimmermann struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev, 8885438a8dSThomas Zimmermann struct ttm_bo_device *bdev, 8985438a8dSThomas Zimmermann size_t size, 9085438a8dSThomas Zimmermann unsigned long pg_align, 9185438a8dSThomas Zimmermann bool interruptible); 9285438a8dSThomas Zimmermann void drm_gem_vram_put(struct drm_gem_vram_object *gbo); 9385438a8dSThomas Zimmermann u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo); 9485438a8dSThomas Zimmermann s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo); 9585438a8dSThomas Zimmermann int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag); 9685438a8dSThomas Zimmermann int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo); 9785438a8dSThomas Zimmermann void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map, 9885438a8dSThomas Zimmermann bool *is_iomem); 9985438a8dSThomas Zimmermann void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo); 10085438a8dSThomas Zimmermann 101fed1eec0SThomas Zimmermann int drm_gem_vram_fill_create_dumb(struct drm_file *file, 102fed1eec0SThomas Zimmermann struct drm_device *dev, 103fed1eec0SThomas Zimmermann struct ttm_bo_device *bdev, 104fed1eec0SThomas Zimmermann unsigned long pg_align, 105fed1eec0SThomas Zimmermann bool interruptible, 106fed1eec0SThomas Zimmermann struct drm_mode_create_dumb *args); 107fed1eec0SThomas Zimmermann 1086c812bc5SThomas Zimmermann /* 1096c812bc5SThomas Zimmermann * Helpers for struct ttm_bo_driver 1106c812bc5SThomas Zimmermann */ 1116c812bc5SThomas Zimmermann 1126c812bc5SThomas Zimmermann void drm_gem_vram_bo_driver_evict_flags(struct ttm_buffer_object *bo, 1136c812bc5SThomas Zimmermann struct ttm_placement *pl); 1146c812bc5SThomas Zimmermann 1156c812bc5SThomas Zimmermann int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, 1166c812bc5SThomas Zimmermann struct file *filp); 1176c812bc5SThomas Zimmermann 1185c9dcacfSThomas Zimmermann extern const struct drm_vram_mm_funcs drm_gem_vram_mm_funcs; 1195c9dcacfSThomas Zimmermann 120737000fdSThomas Zimmermann /* 121737000fdSThomas Zimmermann * Helpers for struct drm_driver 122737000fdSThomas Zimmermann */ 123737000fdSThomas Zimmermann 12459f5989aSThomas Zimmermann int drm_gem_vram_driver_dumb_create(struct drm_file *file, 12559f5989aSThomas Zimmermann struct drm_device *dev, 12659f5989aSThomas Zimmermann struct drm_mode_create_dumb *args); 127737000fdSThomas Zimmermann int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file, 128737000fdSThomas Zimmermann struct drm_device *dev, 129737000fdSThomas Zimmermann uint32_t handle, uint64_t *offset); 13059f5989aSThomas Zimmermann 13159f5989aSThomas Zimmermann /** 13259f5989aSThomas Zimmermann * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 13359f5989aSThomas Zimmermann &struct drm_driver 13459f5989aSThomas Zimmermann * 13559f5989aSThomas Zimmermann * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 13659f5989aSThomas Zimmermann * &struct drm_driver with default functions. 13759f5989aSThomas Zimmermann */ 13859f5989aSThomas Zimmermann #define DRM_GEM_VRAM_DRIVER \ 13959f5989aSThomas Zimmermann .dumb_create = drm_gem_vram_driver_dumb_create, \ 14031070a87SThomas Zimmermann .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \ 14131070a87SThomas Zimmermann .gem_prime_mmap = drm_gem_prime_mmap 14259f5989aSThomas Zimmermann 14385438a8dSThomas Zimmermann #endif 144