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. 3785438a8dSThomas Zimmermann */ 3885438a8dSThomas Zimmermann struct drm_gem_vram_object { 3985438a8dSThomas Zimmermann struct ttm_buffer_object bo; 4085438a8dSThomas Zimmermann struct ttm_bo_kmap_obj kmap; 4185438a8dSThomas Zimmermann 4285438a8dSThomas Zimmermann /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */ 4385438a8dSThomas Zimmermann struct ttm_placement placement; 4485438a8dSThomas Zimmermann struct ttm_place placements[2]; 4585438a8dSThomas Zimmermann 4685438a8dSThomas Zimmermann int pin_count; 4785438a8dSThomas Zimmermann }; 4885438a8dSThomas Zimmermann 4985438a8dSThomas Zimmermann /** 5085438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 5185438a8dSThomas Zimmermann * for field bo. 5285438a8dSThomas Zimmermann * @bo: the VRAM buffer object 5385438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 5485438a8dSThomas Zimmermann */ 5585438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( 5685438a8dSThomas Zimmermann struct ttm_buffer_object *bo) 5785438a8dSThomas Zimmermann { 5885438a8dSThomas Zimmermann return container_of(bo, struct drm_gem_vram_object, bo); 5985438a8dSThomas Zimmermann } 6085438a8dSThomas Zimmermann 6185438a8dSThomas Zimmermann /** 6285438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 6385438a8dSThomas Zimmermann * for field gem. 6485438a8dSThomas Zimmermann * @gem: the GEM object 6585438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 6685438a8dSThomas Zimmermann */ 6785438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_gem( 6885438a8dSThomas Zimmermann struct drm_gem_object *gem) 6985438a8dSThomas Zimmermann { 700e580c6dSGerd Hoffmann return container_of(gem, struct drm_gem_vram_object, bo.base); 7185438a8dSThomas Zimmermann } 7285438a8dSThomas Zimmermann 7385438a8dSThomas Zimmermann struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev, 7485438a8dSThomas Zimmermann struct ttm_bo_device *bdev, 7585438a8dSThomas Zimmermann size_t size, 7685438a8dSThomas Zimmermann unsigned long pg_align, 7785438a8dSThomas Zimmermann bool interruptible); 7885438a8dSThomas Zimmermann void drm_gem_vram_put(struct drm_gem_vram_object *gbo); 7985438a8dSThomas Zimmermann u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo); 8085438a8dSThomas Zimmermann s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo); 8185438a8dSThomas Zimmermann int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag); 8285438a8dSThomas Zimmermann int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo); 8385438a8dSThomas Zimmermann void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map, 8485438a8dSThomas Zimmermann bool *is_iomem); 8585438a8dSThomas Zimmermann void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo); 8685438a8dSThomas Zimmermann 87fed1eec0SThomas Zimmermann int drm_gem_vram_fill_create_dumb(struct drm_file *file, 88fed1eec0SThomas Zimmermann struct drm_device *dev, 89fed1eec0SThomas Zimmermann struct ttm_bo_device *bdev, 90fed1eec0SThomas Zimmermann unsigned long pg_align, 91fed1eec0SThomas Zimmermann bool interruptible, 92fed1eec0SThomas Zimmermann struct drm_mode_create_dumb *args); 93fed1eec0SThomas Zimmermann 946c812bc5SThomas Zimmermann /* 956c812bc5SThomas Zimmermann * Helpers for struct ttm_bo_driver 966c812bc5SThomas Zimmermann */ 976c812bc5SThomas Zimmermann 986c812bc5SThomas Zimmermann void drm_gem_vram_bo_driver_evict_flags(struct ttm_buffer_object *bo, 996c812bc5SThomas Zimmermann struct ttm_placement *pl); 1006c812bc5SThomas Zimmermann 1016c812bc5SThomas Zimmermann int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo, 1026c812bc5SThomas Zimmermann struct file *filp); 1036c812bc5SThomas Zimmermann 1045c9dcacfSThomas Zimmermann extern const struct drm_vram_mm_funcs drm_gem_vram_mm_funcs; 1055c9dcacfSThomas Zimmermann 106737000fdSThomas Zimmermann /* 107737000fdSThomas Zimmermann * Helpers for struct drm_driver 108737000fdSThomas Zimmermann */ 109737000fdSThomas Zimmermann 11059f5989aSThomas Zimmermann int drm_gem_vram_driver_dumb_create(struct drm_file *file, 11159f5989aSThomas Zimmermann struct drm_device *dev, 11259f5989aSThomas Zimmermann struct drm_mode_create_dumb *args); 113737000fdSThomas Zimmermann int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file, 114737000fdSThomas Zimmermann struct drm_device *dev, 115737000fdSThomas Zimmermann uint32_t handle, uint64_t *offset); 11659f5989aSThomas Zimmermann 11759f5989aSThomas Zimmermann /** 11859f5989aSThomas Zimmermann * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 11959f5989aSThomas Zimmermann &struct drm_driver 12059f5989aSThomas Zimmermann * 12159f5989aSThomas Zimmermann * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 12259f5989aSThomas Zimmermann * &struct drm_driver with default functions. 12359f5989aSThomas Zimmermann */ 12459f5989aSThomas Zimmermann #define DRM_GEM_VRAM_DRIVER \ 12559f5989aSThomas Zimmermann .dumb_create = drm_gem_vram_driver_dumb_create, \ 12631070a87SThomas Zimmermann .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \ 12731070a87SThomas Zimmermann .gem_prime_mmap = drm_gem_prime_mmap 12859f5989aSThomas Zimmermann 12985438a8dSThomas Zimmermann #endif 130