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 66b5ce4a1SThomas Zimmermann #include <drm/drm_file.h> 785438a8dSThomas Zimmermann #include <drm/drm_gem.h> 86b5ce4a1SThomas Zimmermann #include <drm/drm_ioctl.h> 980f7c3f7SThomas Zimmermann #include <drm/drm_modes.h> 1085438a8dSThomas Zimmermann #include <drm/ttm/ttm_bo_api.h> 116b5ce4a1SThomas Zimmermann #include <drm/ttm/ttm_bo_driver.h> 126b5ce4a1SThomas Zimmermann 1349a3f51dSThomas Zimmermann #include <linux/dma-buf-map.h> 1485438a8dSThomas Zimmermann #include <linux/kernel.h> /* for container_of() */ 1585438a8dSThomas Zimmermann 16fed1eec0SThomas Zimmermann struct drm_mode_create_dumb; 176542ad89SThomas Zimmermann struct drm_plane; 186542ad89SThomas Zimmermann struct drm_plane_state; 196542ad89SThomas Zimmermann struct drm_simple_display_pipe; 2085438a8dSThomas Zimmermann struct filp; 2159f5989aSThomas Zimmermann struct vm_area_struct; 2285438a8dSThomas Zimmermann 237053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_SYSTEM (1 << 0) 247053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_VRAM (1 << 1) 257053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_TOPDOWN (1 << 2) 2685438a8dSThomas Zimmermann 2785438a8dSThomas Zimmermann /* 2885438a8dSThomas Zimmermann * Buffer-object helpers 2985438a8dSThomas Zimmermann */ 3085438a8dSThomas Zimmermann 3185438a8dSThomas Zimmermann /** 3285438a8dSThomas Zimmermann * struct drm_gem_vram_object - GEM object backed by VRAM 3385438a8dSThomas Zimmermann * @bo: TTM buffer object 3449a3f51dSThomas Zimmermann * @map: Mapping information for @bo 3585438a8dSThomas Zimmermann * @placement: TTM placement information. Supported placements are \ 3685438a8dSThomas Zimmermann %TTM_PL_VRAM and %TTM_PL_SYSTEM 3785438a8dSThomas Zimmermann * @placements: TTM placement information. 3885438a8dSThomas Zimmermann * 3985438a8dSThomas Zimmermann * The type struct drm_gem_vram_object represents a GEM object that is 4085438a8dSThomas Zimmermann * backed by VRAM. It can be used for simple framebuffer devices with 4185438a8dSThomas Zimmermann * dedicated memory. The buffer object can be evicted to system memory if 4285438a8dSThomas Zimmermann * video memory becomes scarce. 4337a48adfSThomas Zimmermann * 4437a48adfSThomas Zimmermann * GEM VRAM objects perform reference counting for pin and mapping 4537a48adfSThomas Zimmermann * operations. So a buffer object that has been pinned N times with 4637a48adfSThomas Zimmermann * drm_gem_vram_pin() must be unpinned N times with 4737a48adfSThomas Zimmermann * drm_gem_vram_unpin(). The same applies to pairs of 48c8908bdeSThomas Zimmermann * drm_gem_vram_kmap() and drm_gem_vram_kunmap(), as well as pairs of 49c8908bdeSThomas Zimmermann * drm_gem_vram_vmap() and drm_gem_vram_vunmap(). 5085438a8dSThomas Zimmermann */ 5185438a8dSThomas Zimmermann struct drm_gem_vram_object { 5285438a8dSThomas Zimmermann struct ttm_buffer_object bo; 5349a3f51dSThomas Zimmermann struct dma_buf_map map; 5485438a8dSThomas Zimmermann 5537a48adfSThomas Zimmermann /** 5649a3f51dSThomas Zimmermann * @vmap_use_count: 5737a48adfSThomas Zimmermann * 5837a48adfSThomas Zimmermann * Reference count on the virtual address. 5937a48adfSThomas Zimmermann * The address are un-mapped when the count reaches zero. 6037a48adfSThomas Zimmermann */ 6149a3f51dSThomas Zimmermann unsigned int vmap_use_count; 6237a48adfSThomas Zimmermann 6385438a8dSThomas Zimmermann /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */ 6485438a8dSThomas Zimmermann struct ttm_placement placement; 6585438a8dSThomas Zimmermann struct ttm_place placements[2]; 6685438a8dSThomas Zimmermann }; 6785438a8dSThomas Zimmermann 6885438a8dSThomas Zimmermann /** 69e9d2871fSMauro Carvalho Chehab * drm_gem_vram_of_bo - Returns the container of type 70e9d2871fSMauro Carvalho Chehab * &struct drm_gem_vram_object for field bo. 7185438a8dSThomas Zimmermann * @bo: the VRAM buffer object 7285438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 7385438a8dSThomas Zimmermann */ 7485438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( 7585438a8dSThomas Zimmermann struct ttm_buffer_object *bo) 7685438a8dSThomas Zimmermann { 7785438a8dSThomas Zimmermann return container_of(bo, struct drm_gem_vram_object, bo); 7885438a8dSThomas Zimmermann } 7985438a8dSThomas Zimmermann 8085438a8dSThomas Zimmermann /** 81e9d2871fSMauro Carvalho Chehab * drm_gem_vram_of_gem - Returns the container of type 82e9d2871fSMauro Carvalho Chehab * &struct drm_gem_vram_object for field gem. 8385438a8dSThomas Zimmermann * @gem: the GEM object 8485438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 8585438a8dSThomas Zimmermann */ 8685438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_gem( 8785438a8dSThomas Zimmermann struct drm_gem_object *gem) 8885438a8dSThomas Zimmermann { 890e580c6dSGerd Hoffmann return container_of(gem, struct drm_gem_vram_object, bo.base); 9085438a8dSThomas Zimmermann } 9185438a8dSThomas Zimmermann 9285438a8dSThomas Zimmermann struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev, 9385438a8dSThomas Zimmermann size_t size, 94ebe9428bSThomas Zimmermann unsigned long pg_align); 9585438a8dSThomas Zimmermann void drm_gem_vram_put(struct drm_gem_vram_object *gbo); 9685438a8dSThomas Zimmermann u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo); 9785438a8dSThomas Zimmermann s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo); 9885438a8dSThomas Zimmermann int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag); 9985438a8dSThomas Zimmermann int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo); 10049a3f51dSThomas Zimmermann int drm_gem_vram_vmap(struct drm_gem_vram_object *gbo, struct dma_buf_map *map); 10149a3f51dSThomas Zimmermann void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo, struct dma_buf_map *map); 10285438a8dSThomas Zimmermann 103fed1eec0SThomas Zimmermann int drm_gem_vram_fill_create_dumb(struct drm_file *file, 104fed1eec0SThomas Zimmermann struct drm_device *dev, 105fed1eec0SThomas Zimmermann unsigned long pg_align, 10698707327SThomas Zimmermann unsigned long pitch_align, 107fed1eec0SThomas Zimmermann struct drm_mode_create_dumb *args); 108fed1eec0SThomas Zimmermann 1096c812bc5SThomas Zimmermann /* 110737000fdSThomas Zimmermann * Helpers for struct drm_driver 111737000fdSThomas Zimmermann */ 112737000fdSThomas Zimmermann 11359f5989aSThomas Zimmermann int drm_gem_vram_driver_dumb_create(struct drm_file *file, 11459f5989aSThomas Zimmermann struct drm_device *dev, 11559f5989aSThomas Zimmermann struct drm_mode_create_dumb *args); 116737000fdSThomas Zimmermann int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file, 117737000fdSThomas Zimmermann struct drm_device *dev, 118737000fdSThomas Zimmermann uint32_t handle, uint64_t *offset); 11959f5989aSThomas Zimmermann 1206542ad89SThomas Zimmermann /* 1216542ad89SThomas Zimmermann * Helpers for struct drm_plane_helper_funcs 1226542ad89SThomas Zimmermann */ 1236542ad89SThomas Zimmermann int 1246542ad89SThomas Zimmermann drm_gem_vram_plane_helper_prepare_fb(struct drm_plane *plane, 1256542ad89SThomas Zimmermann struct drm_plane_state *new_state); 1266542ad89SThomas Zimmermann void 1276542ad89SThomas Zimmermann drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane, 1286542ad89SThomas Zimmermann struct drm_plane_state *old_state); 1296542ad89SThomas Zimmermann 1306542ad89SThomas Zimmermann /* 1316542ad89SThomas Zimmermann * Helpers for struct drm_simple_display_pipe_funcs 1326542ad89SThomas Zimmermann */ 1336542ad89SThomas Zimmermann 1346542ad89SThomas Zimmermann int drm_gem_vram_simple_display_pipe_prepare_fb( 1356542ad89SThomas Zimmermann struct drm_simple_display_pipe *pipe, 1366542ad89SThomas Zimmermann struct drm_plane_state *new_state); 1376542ad89SThomas Zimmermann 1386542ad89SThomas Zimmermann void drm_gem_vram_simple_display_pipe_cleanup_fb( 1396542ad89SThomas Zimmermann struct drm_simple_display_pipe *pipe, 1406542ad89SThomas Zimmermann struct drm_plane_state *old_state); 1416542ad89SThomas Zimmermann 14259f5989aSThomas Zimmermann /** 14359f5989aSThomas Zimmermann * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 14459f5989aSThomas Zimmermann &struct drm_driver 14559f5989aSThomas Zimmermann * 14659f5989aSThomas Zimmermann * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 14759f5989aSThomas Zimmermann * &struct drm_driver with default functions. 14859f5989aSThomas Zimmermann */ 14959f5989aSThomas Zimmermann #define DRM_GEM_VRAM_DRIVER \ 1509286766bSGerd Hoffmann .debugfs_init = drm_vram_mm_debugfs_init, \ 15159f5989aSThomas Zimmermann .dumb_create = drm_gem_vram_driver_dumb_create, \ 15231070a87SThomas Zimmermann .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \ 15331070a87SThomas Zimmermann .gem_prime_mmap = drm_gem_prime_mmap 15459f5989aSThomas Zimmermann 1556b5ce4a1SThomas Zimmermann /* 1566b5ce4a1SThomas Zimmermann * VRAM memory manager 1576b5ce4a1SThomas Zimmermann */ 1586b5ce4a1SThomas Zimmermann 1596b5ce4a1SThomas Zimmermann /** 1606b5ce4a1SThomas Zimmermann * struct drm_vram_mm - An instance of VRAM MM 1616b5ce4a1SThomas Zimmermann * @vram_base: Base address of the managed video memory 1626b5ce4a1SThomas Zimmermann * @vram_size: Size of the managed video memory in bytes 1636b5ce4a1SThomas Zimmermann * @bdev: The TTM BO device. 1646b5ce4a1SThomas Zimmermann * @funcs: TTM BO functions 1656b5ce4a1SThomas Zimmermann * 1666b5ce4a1SThomas Zimmermann * The fields &struct drm_vram_mm.vram_base and 1676b5ce4a1SThomas Zimmermann * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are 1686b5ce4a1SThomas Zimmermann * available for public read access. Use the field 1696b5ce4a1SThomas Zimmermann * &struct drm_vram_mm.bdev to access the TTM BO device. 1706b5ce4a1SThomas Zimmermann */ 1716b5ce4a1SThomas Zimmermann struct drm_vram_mm { 1726b5ce4a1SThomas Zimmermann uint64_t vram_base; 1736b5ce4a1SThomas Zimmermann size_t vram_size; 1746b5ce4a1SThomas Zimmermann 175*8af8a109SChristian König struct ttm_device bdev; 1766b5ce4a1SThomas Zimmermann }; 1776b5ce4a1SThomas Zimmermann 1786b5ce4a1SThomas Zimmermann /** 1796b5ce4a1SThomas Zimmermann * drm_vram_mm_of_bdev() - \ 180*8af8a109SChristian König Returns the container of type &struct ttm_device for field bdev. 1816b5ce4a1SThomas Zimmermann * @bdev: the TTM BO device 1826b5ce4a1SThomas Zimmermann * 1836b5ce4a1SThomas Zimmermann * Returns: 1846b5ce4a1SThomas Zimmermann * The containing instance of &struct drm_vram_mm 1856b5ce4a1SThomas Zimmermann */ 1866b5ce4a1SThomas Zimmermann static inline struct drm_vram_mm *drm_vram_mm_of_bdev( 187*8af8a109SChristian König struct ttm_device *bdev) 1886b5ce4a1SThomas Zimmermann { 1896b5ce4a1SThomas Zimmermann return container_of(bdev, struct drm_vram_mm, bdev); 1906b5ce4a1SThomas Zimmermann } 1916b5ce4a1SThomas Zimmermann 1927ce84471SWambui Karuga void drm_vram_mm_debugfs_init(struct drm_minor *minor); 1936b5ce4a1SThomas Zimmermann 1946b5ce4a1SThomas Zimmermann /* 1956b5ce4a1SThomas Zimmermann * Helpers for integration with struct drm_device 1966b5ce4a1SThomas Zimmermann */ 1976b5ce4a1SThomas Zimmermann 1986b5ce4a1SThomas Zimmermann struct drm_vram_mm *drm_vram_helper_alloc_mm( 199b0e40e08SThomas Zimmermann struct drm_device *dev, uint64_t vram_base, size_t vram_size); 2006b5ce4a1SThomas Zimmermann void drm_vram_helper_release_mm(struct drm_device *dev); 2016b5ce4a1SThomas Zimmermann 202a5f23a72SThomas Zimmermann int drmm_vram_helper_init(struct drm_device *dev, uint64_t vram_base, 203a5f23a72SThomas Zimmermann size_t vram_size); 204a5f23a72SThomas Zimmermann 20580f7c3f7SThomas Zimmermann /* 20680f7c3f7SThomas Zimmermann * Mode-config helpers 20780f7c3f7SThomas Zimmermann */ 20880f7c3f7SThomas Zimmermann 20980f7c3f7SThomas Zimmermann enum drm_mode_status 21080f7c3f7SThomas Zimmermann drm_vram_helper_mode_valid(struct drm_device *dev, 21180f7c3f7SThomas Zimmermann const struct drm_display_mode *mode); 21280f7c3f7SThomas Zimmermann 21385438a8dSThomas Zimmermann #endif 214