1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 #ifndef DRM_GEM_VRAM_HELPER_H
4 #define DRM_GEM_VRAM_HELPER_H
6 #include <drm/drm_gem.h>
7 #include <drm/ttm/ttm_bo_api.h>
8 #include <drm/ttm/ttm_placement.h>
9 #include <linux/kernel.h> /* for container_of() */
11 struct drm_mode_create_dumb;
12 struct drm_vram_mm_funcs;
14 struct vm_area_struct;
16 #define DRM_GEM_VRAM_PL_FLAG_VRAM TTM_PL_FLAG_VRAM
17 #define DRM_GEM_VRAM_PL_FLAG_SYSTEM TTM_PL_FLAG_SYSTEM
20 * Buffer-object helpers
24 * struct drm_gem_vram_object - GEM object backed by VRAM
26 * @bo: TTM buffer object
27 * @kmap: Mapping information for @bo
28 * @placement: TTM placement information. Supported placements are \
29 %TTM_PL_VRAM and %TTM_PL_SYSTEM
30 * @placements: TTM placement information.
31 * @pin_count: Pin counter
33 * The type struct drm_gem_vram_object represents a GEM object that is
34 * backed by VRAM. It can be used for simple framebuffer devices with
35 * dedicated memory. The buffer object can be evicted to system memory if
36 * video memory becomes scarce.
38 * GEM VRAM objects perform reference counting for pin and mapping
39 * operations. So a buffer object that has been pinned N times with
40 * drm_gem_vram_pin() must be unpinned N times with
41 * drm_gem_vram_unpin(). The same applies to pairs of
42 * drm_gem_vram_kmap() and drm_gem_vram_kunmap().
44 struct drm_gem_vram_object {
45 struct ttm_buffer_object bo;
46 struct ttm_bo_kmap_obj kmap;
51 * Reference count on the virtual address.
52 * The address are un-mapped when the count reaches zero.
54 unsigned int kmap_use_count;
56 /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */
57 struct ttm_placement placement;
58 struct ttm_place placements[2];
64 * Returns the container of type &struct drm_gem_vram_object
66 * @bo: the VRAM buffer object
67 * Returns: The containing GEM VRAM object
69 static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
70 struct ttm_buffer_object *bo)
72 return container_of(bo, struct drm_gem_vram_object, bo);
76 * Returns the container of type &struct drm_gem_vram_object
78 * @gem: the GEM object
79 * Returns: The containing GEM VRAM object
81 static inline struct drm_gem_vram_object *drm_gem_vram_of_gem(
82 struct drm_gem_object *gem)
84 return container_of(gem, struct drm_gem_vram_object, bo.base);
87 struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev,
88 struct ttm_bo_device *bdev,
90 unsigned long pg_align,
92 void drm_gem_vram_put(struct drm_gem_vram_object *gbo);
93 u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo);
94 s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo);
95 int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag);
96 int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo);
97 void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map,
99 void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo);
101 int drm_gem_vram_fill_create_dumb(struct drm_file *file,
102 struct drm_device *dev,
103 struct ttm_bo_device *bdev,
104 unsigned long pg_align,
106 struct drm_mode_create_dumb *args);
109 * Helpers for struct ttm_bo_driver
112 void drm_gem_vram_bo_driver_evict_flags(struct ttm_buffer_object *bo,
113 struct ttm_placement *pl);
115 void drm_gem_vram_bo_driver_move_notify(struct ttm_buffer_object *bo,
117 struct ttm_mem_reg *new_mem);
119 int drm_gem_vram_bo_driver_verify_access(struct ttm_buffer_object *bo,
122 extern const struct drm_vram_mm_funcs drm_gem_vram_mm_funcs;
125 * Helpers for struct drm_driver
128 int drm_gem_vram_driver_dumb_create(struct drm_file *file,
129 struct drm_device *dev,
130 struct drm_mode_create_dumb *args);
131 int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file,
132 struct drm_device *dev,
133 uint32_t handle, uint64_t *offset);
136 * define DRM_GEM_VRAM_DRIVER - default callback functions for \
139 * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize
140 * &struct drm_driver with default functions.
142 #define DRM_GEM_VRAM_DRIVER \
143 .debugfs_init = drm_vram_mm_debugfs_init, \
144 .dumb_create = drm_gem_vram_driver_dumb_create, \
145 .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \
146 .gem_prime_mmap = drm_gem_prime_mmap