include/drm/drm_gem_vram_helper.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2
   3 #ifndef DRM_GEM_VRAM_HELPER_H
   4 #define DRM_GEM_VRAM_HELPER_H
   5
   6 #include <drm/drm_file.h>
   7 #include <drm/drm_gem.h>
   8 #include <drm/drm_ioctl.h>
   9 #include <drm/ttm/ttm_bo_api.h>
  10 #include <drm/ttm/ttm_bo_driver.h>
  11 #include <drm/ttm/ttm_placement.h>
  12
  13 #include <linux/kernel.h> /* for container_of() */
  14
  15 struct drm_mode_create_dumb;
  16 struct drm_vram_mm_funcs;
  17 struct filp;
  18 struct vm_area_struct;
  19
  20 #define DRM_GEM_VRAM_PL_FLAG_VRAM       TTM_PL_FLAG_VRAM
  21 #define DRM_GEM_VRAM_PL_FLAG_SYSTEM     TTM_PL_FLAG_SYSTEM
  22
  23 /*
  24  * Buffer-object helpers
  25  */
  26
  27 /**
  28  * struct drm_gem_vram_object - GEM object backed by VRAM
  29  * @gem:        GEM object
  30  * @bo:         TTM buffer object
  31  * @kmap:       Mapping information for @bo
  32  * @placement:  TTM placement information. Supported placements are \
  33         %TTM_PL_VRAM and %TTM_PL_SYSTEM
  34  * @placements: TTM placement information.
  35  * @pin_count:  Pin counter
  36  *
  37  * The type struct drm_gem_vram_object represents a GEM object that is
  38  * backed by VRAM. It can be used for simple framebuffer devices with
  39  * dedicated memory. The buffer object can be evicted to system memory if
  40  * video memory becomes scarce.
  41  *
  42  * GEM VRAM objects perform reference counting for pin and mapping
  43  * operations. So a buffer object that has been pinned N times with
  44  * drm_gem_vram_pin() must be unpinned N times with
  45  * drm_gem_vram_unpin(). The same applies to pairs of
  46  * drm_gem_vram_kmap() and drm_gem_vram_kunmap().
  47  */
  48 struct drm_gem_vram_object {
  49         struct ttm_buffer_object bo;
  50         struct ttm_bo_kmap_obj kmap;
  51
  52         /**
  53          * @kmap_use_count:
  54          *
  55          * Reference count on the virtual address.
  56          * The address are un-mapped when the count reaches zero.
  57          */
  58         unsigned int kmap_use_count;
  59
  60         /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */
  61         struct ttm_placement placement;
  62         struct ttm_place placements[2];
  63
  64         int pin_count;
  65 };
  66
  67 /**
  68  * Returns the container of type &struct drm_gem_vram_object
  69  * for field bo.
  70  * @bo:         the VRAM buffer object
  71  * Returns:     The containing GEM VRAM object
  72  */
  73 static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
  74         struct ttm_buffer_object *bo)
  75 {
  76         return container_of(bo, struct drm_gem_vram_object, bo);
  77 }
  78
  79 /**
  80  * Returns the container of type &struct drm_gem_vram_object
  81  * for field gem.
  82  * @gem:        the GEM object
  83  * Returns:     The containing GEM VRAM object
  84  */
  85 static inline struct drm_gem_vram_object *drm_gem_vram_of_gem(
  86         struct drm_gem_object *gem)
  87 {
  88         return container_of(gem, struct drm_gem_vram_object, bo.base);
  89 }
  90
  91 struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev,
  92                                                 struct ttm_bo_device *bdev,
  93                                                 size_t size,
  94                                                 unsigned long pg_align,
  95                                                 bool interruptible);
  96 void drm_gem_vram_put(struct drm_gem_vram_object *gbo);
  97 u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo);
  98 s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo);
  99 int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag);
 100 int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo);
 101 void *drm_gem_vram_kmap(struct drm_gem_vram_object *gbo, bool map,
 102                         bool *is_iomem);
 103 void drm_gem_vram_kunmap(struct drm_gem_vram_object *gbo);
 104
 105 int drm_gem_vram_fill_create_dumb(struct drm_file *file,
 106                                   struct drm_device *dev,
 107                                   struct ttm_bo_device *bdev,
 108                                   unsigned long pg_align,
 109                                   bool interruptible,
 110                                   struct drm_mode_create_dumb *args);
 111
 112 /*
 113  * Helpers for struct drm_driver
 114  */
 115
 116 int drm_gem_vram_driver_dumb_create(struct drm_file *file,
 117                                     struct drm_device *dev,
 118                                     struct drm_mode_create_dumb *args);
 119 int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file,
 120                                          struct drm_device *dev,
 121                                          uint32_t handle, uint64_t *offset);
 122
 123 /**
 124  * define DRM_GEM_VRAM_DRIVER - default callback functions for \
 125         &struct drm_driver
 126  *
 127  * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize
 128  * &struct drm_driver with default functions.
 129  */
 130 #define DRM_GEM_VRAM_DRIVER \
 131         .debugfs_init             = drm_vram_mm_debugfs_init, \
 132         .dumb_create              = drm_gem_vram_driver_dumb_create, \
 133         .dumb_map_offset          = drm_gem_vram_driver_dumb_mmap_offset, \
 134         .gem_prime_mmap           = drm_gem_prime_mmap
 135
 136 /*
 137  *  VRAM memory manager
 138  */
 139
 140 /**
 141  * struct drm_vram_mm - An instance of VRAM MM
 142  * @vram_base:  Base address of the managed video memory
 143  * @vram_size:  Size of the managed video memory in bytes
 144  * @bdev:       The TTM BO device.
 145  * @funcs:      TTM BO functions
 146  *
 147  * The fields &struct drm_vram_mm.vram_base and
 148  * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are
 149  * available for public read access. Use the field
 150  * &struct drm_vram_mm.bdev to access the TTM BO device.
 151  */
 152 struct drm_vram_mm {
 153         uint64_t vram_base;
 154         size_t vram_size;
 155
 156         struct ttm_bo_device bdev;
 157 };
 158
 159 /**
 160  * drm_vram_mm_of_bdev() - \
 161         Returns the container of type &struct ttm_bo_device for field bdev.
 162  * @bdev:       the TTM BO device
 163  *
 164  * Returns:
 165  * The containing instance of &struct drm_vram_mm
 166  */
 167 static inline struct drm_vram_mm *drm_vram_mm_of_bdev(
 168         struct ttm_bo_device *bdev)
 169 {
 170         return container_of(bdev, struct drm_vram_mm, bdev);
 171 }
 172
 173 int drm_vram_mm_debugfs_init(struct drm_minor *minor);
 174 int drm_vram_mm_init(struct drm_vram_mm *vmm, struct drm_device *dev,
 175                      uint64_t vram_base, size_t vram_size);
 176 void drm_vram_mm_cleanup(struct drm_vram_mm *vmm);
 177
 178 int drm_vram_mm_mmap(struct file *filp, struct vm_area_struct *vma,
 179                      struct drm_vram_mm *vmm);
 180
 181 /*
 182  * Helpers for integration with struct drm_device
 183  */
 184
 185 struct drm_vram_mm *drm_vram_helper_alloc_mm(
 186         struct drm_device *dev, uint64_t vram_base, size_t vram_size);
 187 void drm_vram_helper_release_mm(struct drm_device *dev);
 188
 189 /*
 190  * Helpers for &struct file_operations
 191  */
 192
 193 int drm_vram_mm_file_operations_mmap(
 194         struct file *filp, struct vm_area_struct *vma);
 195
 196 /**
 197  * define DRM_VRAM_MM_FILE_OPERATIONS - default callback functions for \
 198         &struct file_operations
 199  *
 200  * Drivers that use VRAM MM can use this macro to initialize
 201  * &struct file_operations with default functions.
 202  */
 203 #define DRM_VRAM_MM_FILE_OPERATIONS \
 204         .llseek         = no_llseek, \
 205         .read           = drm_read, \
 206         .poll           = drm_poll, \
 207         .unlocked_ioctl = drm_ioctl, \
 208         .compat_ioctl   = drm_compat_ioctl, \
 209         .mmap           = drm_vram_mm_file_operations_mmap, \
 210         .open           = drm_open, \
 211         .release        = drm_release \
 212
 213
 214 #endif