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 1385438a8dSThomas Zimmermann #include <linux/kernel.h> /* for container_of() */ 1485438a8dSThomas Zimmermann 15fed1eec0SThomas Zimmermann struct drm_mode_create_dumb; 166542ad89SThomas Zimmermann struct drm_plane; 176542ad89SThomas Zimmermann struct drm_plane_state; 186542ad89SThomas Zimmermann struct drm_simple_display_pipe; 1985438a8dSThomas Zimmermann struct filp; 2059f5989aSThomas Zimmermann struct vm_area_struct; 2185438a8dSThomas Zimmermann 227053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_SYSTEM (1 << 0) 237053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_VRAM (1 << 1) 247053e0eaSChristian König #define DRM_GEM_VRAM_PL_FLAG_TOPDOWN (1 << 2) 2585438a8dSThomas Zimmermann 2685438a8dSThomas Zimmermann /* 2785438a8dSThomas Zimmermann * Buffer-object helpers 2885438a8dSThomas Zimmermann */ 2985438a8dSThomas Zimmermann 3085438a8dSThomas Zimmermann /** 3185438a8dSThomas Zimmermann * struct drm_gem_vram_object - GEM object backed by VRAM 3285438a8dSThomas Zimmermann * @gem: GEM object 3385438a8dSThomas Zimmermann * @bo: TTM buffer object 3485438a8dSThomas Zimmermann * @kmap: 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 * @pin_count: Pin counter 3985438a8dSThomas Zimmermann * 4085438a8dSThomas Zimmermann * The type struct drm_gem_vram_object represents a GEM object that is 4185438a8dSThomas Zimmermann * backed by VRAM. It can be used for simple framebuffer devices with 4285438a8dSThomas Zimmermann * dedicated memory. The buffer object can be evicted to system memory if 4385438a8dSThomas Zimmermann * video memory becomes scarce. 4437a48adfSThomas Zimmermann * 4537a48adfSThomas Zimmermann * GEM VRAM objects perform reference counting for pin and mapping 4637a48adfSThomas Zimmermann * operations. So a buffer object that has been pinned N times with 4737a48adfSThomas Zimmermann * drm_gem_vram_pin() must be unpinned N times with 4837a48adfSThomas Zimmermann * drm_gem_vram_unpin(). The same applies to pairs of 49c8908bdeSThomas Zimmermann * drm_gem_vram_kmap() and drm_gem_vram_kunmap(), as well as pairs of 50c8908bdeSThomas Zimmermann * drm_gem_vram_vmap() and drm_gem_vram_vunmap(). 5185438a8dSThomas Zimmermann */ 5285438a8dSThomas Zimmermann struct drm_gem_vram_object { 5385438a8dSThomas Zimmermann struct ttm_buffer_object bo; 5485438a8dSThomas Zimmermann struct ttm_bo_kmap_obj kmap; 5585438a8dSThomas Zimmermann 5637a48adfSThomas Zimmermann /** 5737a48adfSThomas Zimmermann * @kmap_use_count: 5837a48adfSThomas Zimmermann * 5937a48adfSThomas Zimmermann * Reference count on the virtual address. 6037a48adfSThomas Zimmermann * The address are un-mapped when the count reaches zero. 6137a48adfSThomas Zimmermann */ 6237a48adfSThomas Zimmermann unsigned int kmap_use_count; 6337a48adfSThomas Zimmermann 6485438a8dSThomas Zimmermann /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */ 6585438a8dSThomas Zimmermann struct ttm_placement placement; 6685438a8dSThomas Zimmermann struct ttm_place placements[2]; 6785438a8dSThomas Zimmermann 6885438a8dSThomas Zimmermann int pin_count; 6985438a8dSThomas Zimmermann }; 7085438a8dSThomas Zimmermann 7185438a8dSThomas Zimmermann /** 7285438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 7385438a8dSThomas Zimmermann * for field bo. 7485438a8dSThomas Zimmermann * @bo: the VRAM buffer object 7585438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 7685438a8dSThomas Zimmermann */ 7785438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_bo( 7885438a8dSThomas Zimmermann struct ttm_buffer_object *bo) 7985438a8dSThomas Zimmermann { 8085438a8dSThomas Zimmermann return container_of(bo, struct drm_gem_vram_object, bo); 8185438a8dSThomas Zimmermann } 8285438a8dSThomas Zimmermann 8385438a8dSThomas Zimmermann /** 8485438a8dSThomas Zimmermann * Returns the container of type &struct drm_gem_vram_object 8585438a8dSThomas Zimmermann * for field gem. 8685438a8dSThomas Zimmermann * @gem: the GEM object 8785438a8dSThomas Zimmermann * Returns: The containing GEM VRAM object 8885438a8dSThomas Zimmermann */ 8985438a8dSThomas Zimmermann static inline struct drm_gem_vram_object *drm_gem_vram_of_gem( 9085438a8dSThomas Zimmermann struct drm_gem_object *gem) 9185438a8dSThomas Zimmermann { 920e580c6dSGerd Hoffmann return container_of(gem, struct drm_gem_vram_object, bo.base); 9385438a8dSThomas Zimmermann } 9485438a8dSThomas Zimmermann 9585438a8dSThomas Zimmermann struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev, 9685438a8dSThomas Zimmermann size_t size, 97ebe9428bSThomas Zimmermann unsigned long pg_align); 9885438a8dSThomas Zimmermann void drm_gem_vram_put(struct drm_gem_vram_object *gbo); 9985438a8dSThomas Zimmermann u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo); 10085438a8dSThomas Zimmermann s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo); 10185438a8dSThomas Zimmermann int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag); 10285438a8dSThomas Zimmermann int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo); 10385438a8dSThomas Zimmermann void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map, 10485438a8dSThomas Zimmermann bool *is_iomem); 10585438a8dSThomas Zimmermann void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo); 106c8908bdeSThomas Zimmermann void *drm_gem_vram_vmap(struct drm_gem_vram_object *gbo); 107c8908bdeSThomas Zimmermann void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo, void *vaddr); 10885438a8dSThomas Zimmermann 109fed1eec0SThomas Zimmermann int drm_gem_vram_fill_create_dumb(struct drm_file *file, 110fed1eec0SThomas Zimmermann struct drm_device *dev, 111fed1eec0SThomas Zimmermann unsigned long pg_align, 11298707327SThomas Zimmermann unsigned long pitch_align, 113fed1eec0SThomas Zimmermann struct drm_mode_create_dumb *args); 114fed1eec0SThomas Zimmermann 1156c812bc5SThomas Zimmermann /* 116737000fdSThomas Zimmermann * Helpers for struct drm_driver 117737000fdSThomas Zimmermann */ 118737000fdSThomas Zimmermann 11959f5989aSThomas Zimmermann int drm_gem_vram_driver_dumb_create(struct drm_file *file, 12059f5989aSThomas Zimmermann struct drm_device *dev, 12159f5989aSThomas Zimmermann struct drm_mode_create_dumb *args); 122737000fdSThomas Zimmermann int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file, 123737000fdSThomas Zimmermann struct drm_device *dev, 124737000fdSThomas Zimmermann uint32_t handle, uint64_t *offset); 12559f5989aSThomas Zimmermann 1266542ad89SThomas Zimmermann /* 1276542ad89SThomas Zimmermann * Helpers for struct drm_plane_helper_funcs 1286542ad89SThomas Zimmermann */ 1296542ad89SThomas Zimmermann int 1306542ad89SThomas Zimmermann drm_gem_vram_plane_helper_prepare_fb(struct drm_plane *plane, 1316542ad89SThomas Zimmermann struct drm_plane_state *new_state); 1326542ad89SThomas Zimmermann void 1336542ad89SThomas Zimmermann drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane, 1346542ad89SThomas Zimmermann struct drm_plane_state *old_state); 1356542ad89SThomas Zimmermann 1366542ad89SThomas Zimmermann /* 1376542ad89SThomas Zimmermann * Helpers for struct drm_simple_display_pipe_funcs 1386542ad89SThomas Zimmermann */ 1396542ad89SThomas Zimmermann 1406542ad89SThomas Zimmermann int drm_gem_vram_simple_display_pipe_prepare_fb( 1416542ad89SThomas Zimmermann struct drm_simple_display_pipe *pipe, 1426542ad89SThomas Zimmermann struct drm_plane_state *new_state); 1436542ad89SThomas Zimmermann 1446542ad89SThomas Zimmermann void drm_gem_vram_simple_display_pipe_cleanup_fb( 1456542ad89SThomas Zimmermann struct drm_simple_display_pipe *pipe, 1466542ad89SThomas Zimmermann struct drm_plane_state *old_state); 1476542ad89SThomas Zimmermann 14859f5989aSThomas Zimmermann /** 14959f5989aSThomas Zimmermann * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 15059f5989aSThomas Zimmermann &struct drm_driver 15159f5989aSThomas Zimmermann * 15259f5989aSThomas Zimmermann * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 15359f5989aSThomas Zimmermann * &struct drm_driver with default functions. 15459f5989aSThomas Zimmermann */ 15559f5989aSThomas Zimmermann #define DRM_GEM_VRAM_DRIVER \ 1569286766bSGerd Hoffmann .debugfs_init = drm_vram_mm_debugfs_init, \ 15759f5989aSThomas Zimmermann .dumb_create = drm_gem_vram_driver_dumb_create, \ 15831070a87SThomas Zimmermann .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \ 15931070a87SThomas Zimmermann .gem_prime_mmap = drm_gem_prime_mmap 16059f5989aSThomas Zimmermann 1616b5ce4a1SThomas Zimmermann /* 1626b5ce4a1SThomas Zimmermann * VRAM memory manager 1636b5ce4a1SThomas Zimmermann */ 1646b5ce4a1SThomas Zimmermann 1656b5ce4a1SThomas Zimmermann /** 1666b5ce4a1SThomas Zimmermann * struct drm_vram_mm - An instance of VRAM MM 1676b5ce4a1SThomas Zimmermann * @vram_base: Base address of the managed video memory 1686b5ce4a1SThomas Zimmermann * @vram_size: Size of the managed video memory in bytes 1696b5ce4a1SThomas Zimmermann * @bdev: The TTM BO device. 1706b5ce4a1SThomas Zimmermann * @funcs: TTM BO functions 1716b5ce4a1SThomas Zimmermann * 1726b5ce4a1SThomas Zimmermann * The fields &struct drm_vram_mm.vram_base and 1736b5ce4a1SThomas Zimmermann * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are 1746b5ce4a1SThomas Zimmermann * available for public read access. Use the field 1756b5ce4a1SThomas Zimmermann * &struct drm_vram_mm.bdev to access the TTM BO device. 1766b5ce4a1SThomas Zimmermann */ 1776b5ce4a1SThomas Zimmermann struct drm_vram_mm { 1786b5ce4a1SThomas Zimmermann uint64_t vram_base; 1796b5ce4a1SThomas Zimmermann size_t vram_size; 1806b5ce4a1SThomas Zimmermann 1816b5ce4a1SThomas Zimmermann struct ttm_bo_device bdev; 1826b5ce4a1SThomas Zimmermann }; 1836b5ce4a1SThomas Zimmermann 1846b5ce4a1SThomas Zimmermann /** 1856b5ce4a1SThomas Zimmermann * drm_vram_mm_of_bdev() - \ 1866b5ce4a1SThomas Zimmermann Returns the container of type &struct ttm_bo_device for field bdev. 1876b5ce4a1SThomas Zimmermann * @bdev: the TTM BO device 1886b5ce4a1SThomas Zimmermann * 1896b5ce4a1SThomas Zimmermann * Returns: 1906b5ce4a1SThomas Zimmermann * The containing instance of &struct drm_vram_mm 1916b5ce4a1SThomas Zimmermann */ 1926b5ce4a1SThomas Zimmermann static inline struct drm_vram_mm *drm_vram_mm_of_bdev( 1936b5ce4a1SThomas Zimmermann struct ttm_bo_device *bdev) 1946b5ce4a1SThomas Zimmermann { 1956b5ce4a1SThomas Zimmermann return container_of(bdev, struct drm_vram_mm, bdev); 1966b5ce4a1SThomas Zimmermann } 1976b5ce4a1SThomas Zimmermann 1987ce84471SWambui Karuga void drm_vram_mm_debugfs_init(struct drm_minor *minor); 1996b5ce4a1SThomas Zimmermann 2006b5ce4a1SThomas Zimmermann /* 2016b5ce4a1SThomas Zimmermann * Helpers for integration with struct drm_device 2026b5ce4a1SThomas Zimmermann */ 2036b5ce4a1SThomas Zimmermann 2046b5ce4a1SThomas Zimmermann struct drm_vram_mm *drm_vram_helper_alloc_mm( 205b0e40e08SThomas Zimmermann struct drm_device *dev, uint64_t vram_base, size_t vram_size); 2066b5ce4a1SThomas Zimmermann void drm_vram_helper_release_mm(struct drm_device *dev); 2076b5ce4a1SThomas Zimmermann 208a5f23a72SThomas Zimmermann int drmm_vram_helper_init(struct drm_device *dev, uint64_t vram_base, 209a5f23a72SThomas Zimmermann size_t vram_size); 210a5f23a72SThomas Zimmermann 21180f7c3f7SThomas Zimmermann /* 21280f7c3f7SThomas Zimmermann * Mode-config helpers 21380f7c3f7SThomas Zimmermann */ 21480f7c3f7SThomas Zimmermann 21580f7c3f7SThomas Zimmermann enum drm_mode_status 21680f7c3f7SThomas Zimmermann drm_vram_helper_mode_valid(struct drm_device *dev, 21780f7c3f7SThomas Zimmermann const struct drm_display_mode *mode); 21880f7c3f7SThomas Zimmermann 21985438a8dSThomas Zimmermann #endif 220