drm_gem_vram_helper.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. #ifndef DRM_GEM_VRAM_HELPER_H
  3. #define DRM_GEM_VRAM_HELPER_H
  4. #include <drm/drm_file.h>
  5. #include <drm/drm_gem.h>
  6. #include <drm/drm_ioctl.h>
  7. #include <drm/drm_modes.h>
  8. #include <drm/ttm/ttm_bo_api.h>
  9. #include <drm/ttm/ttm_bo_driver.h>
  10. #include <linux/kernel.h> /* for container_of() */
  11. struct drm_mode_create_dumb;
  12. struct drm_plane;
  13. struct drm_plane_state;
  14. struct drm_simple_display_pipe;
  15. struct filp;
  16. struct vm_area_struct;
  17. #define DRM_GEM_VRAM_PL_FLAG_SYSTEM (1 << 0)
  18. #define DRM_GEM_VRAM_PL_FLAG_VRAM (1 << 1)
  19. #define DRM_GEM_VRAM_PL_FLAG_TOPDOWN (1 << 2)
  20. /*
  21. * Buffer-object helpers
  22. */
  23. /**
  24. * struct drm_gem_vram_object - GEM object backed by VRAM
  25. * @gem: GEM object
  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
  32. *
  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.
  37. *
  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(), as well as pairs of
  43. * drm_gem_vram_vmap() and drm_gem_vram_vunmap().
  44. */
  45. struct drm_gem_vram_object {
  46. struct ttm_buffer_object bo;
  47. struct ttm_bo_kmap_obj kmap;
  48. /**
  49. * @kmap_use_count:
  50. *
  51. * Reference count on the virtual address.
  52. * The address are un-mapped when the count reaches zero.
  53. */
  54. unsigned int kmap_use_count;
  55. /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */
  56. struct ttm_placement placement;
  57. struct ttm_place placements[2];
  58. int pin_count;
  59. };
  60. /**
  61. * Returns the container of type &struct drm_gem_vram_object
  62. * for field bo.
  63. * @bo: the VRAM buffer object
  64. * Returns: The containing GEM VRAM object
  65. */
  66. static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
  67. struct ttm_buffer_object *bo)
  68. {
  69. return container_of(bo, struct drm_gem_vram_object, bo);
  70. }
  71. /**
  72. * Returns the container of type &struct drm_gem_vram_object
  73. * for field gem.
  74. * @gem: the GEM object
  75. * Returns: The containing GEM VRAM object
  76. */
  77. static inline struct drm_gem_vram_object *drm_gem_vram_of_gem(
  78. struct drm_gem_object *gem)
  79. {
  80. return container_of(gem, struct drm_gem_vram_object, bo.base);
  81. }
  82. struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev,
  83. size_t size,
  84. unsigned long pg_align);
  85. void drm_gem_vram_put(struct drm_gem_vram_object *gbo);
  86. u64 drm_gem_vram_mmap_offset(struct drm_gem_vram_object *gbo);
  87. s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo);
  88. int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag);
  89. int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo);
  90. void *drm_gem_vram_vmap(struct drm_gem_vram_object *gbo);
  91. void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo, void *vaddr);
  92. int drm_gem_vram_fill_create_dumb(struct drm_file *file,
  93. struct drm_device *dev,
  94. unsigned long pg_align,
  95. unsigned long pitch_align,
  96. struct drm_mode_create_dumb *args);
  97. /*
  98. * Helpers for struct drm_driver
  99. */
  100. int drm_gem_vram_driver_dumb_create(struct drm_file *file,
  101. struct drm_device *dev,
  102. struct drm_mode_create_dumb *args);
  103. int drm_gem_vram_driver_dumb_mmap_offset(struct drm_file *file,
  104. struct drm_device *dev,
  105. uint32_t handle, uint64_t *offset);
  106. /*
  107. * Helpers for struct drm_plane_helper_funcs
  108. */
  109. int
  110. drm_gem_vram_plane_helper_prepare_fb(struct drm_plane *plane,
  111. struct drm_plane_state *new_state);
  112. void
  113. drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane,
  114. struct drm_plane_state *old_state);
  115. /*
  116. * Helpers for struct drm_simple_display_pipe_funcs
  117. */
  118. int drm_gem_vram_simple_display_pipe_prepare_fb(
  119. struct drm_simple_display_pipe *pipe,
  120. struct drm_plane_state *new_state);
  121. void drm_gem_vram_simple_display_pipe_cleanup_fb(
  122. struct drm_simple_display_pipe *pipe,
  123. struct drm_plane_state *old_state);
  124. /**
  125. * define DRM_GEM_VRAM_DRIVER - default callback functions for \
  126. &struct drm_driver
  127. *
  128. * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize
  129. * &struct drm_driver with default functions.
  130. */
  131. #define DRM_GEM_VRAM_DRIVER \
  132. .debugfs_init = drm_vram_mm_debugfs_init, \
  133. .dumb_create = drm_gem_vram_driver_dumb_create, \
  134. .dumb_map_offset = drm_gem_vram_driver_dumb_mmap_offset, \
  135. .gem_prime_mmap = drm_gem_prime_mmap
  136. /*
  137. * VRAM memory manager
  138. */
  139. /**
  140. * struct drm_vram_mm - An instance of VRAM MM
  141. * @vram_base: Base address of the managed video memory
  142. * @vram_size: Size of the managed video memory in bytes
  143. * @bdev: The TTM BO device.
  144. * @funcs: TTM BO functions
  145. *
  146. * The fields &struct drm_vram_mm.vram_base and
  147. * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are
  148. * available for public read access. Use the field
  149. * &struct drm_vram_mm.bdev to access the TTM BO device.
  150. */
  151. struct drm_vram_mm {
  152. uint64_t vram_base;
  153. size_t vram_size;
  154. struct ttm_bo_device bdev;
  155. };
  156. /**
  157. * drm_vram_mm_of_bdev() - \
  158. Returns the container of type &struct ttm_bo_device for field bdev.
  159. * @bdev: the TTM BO device
  160. *
  161. * Returns:
  162. * The containing instance of &struct drm_vram_mm
  163. */
  164. static inline struct drm_vram_mm *drm_vram_mm_of_bdev(
  165. struct ttm_bo_device *bdev)
  166. {
  167. return container_of(bdev, struct drm_vram_mm, bdev);
  168. }
  169. void drm_vram_mm_debugfs_init(struct drm_minor *minor);
  170. /*
  171. * Helpers for integration with struct drm_device
  172. */
  173. struct drm_vram_mm *drm_vram_helper_alloc_mm(
  174. struct drm_device *dev, uint64_t vram_base, size_t vram_size);
  175. void drm_vram_helper_release_mm(struct drm_device *dev);
  176. int drmm_vram_helper_init(struct drm_device *dev, uint64_t vram_base,
  177. size_t vram_size);
  178. /*
  179. * Mode-config helpers
  180. */
  181. enum drm_mode_status
  182. drm_vram_helper_mode_valid(struct drm_device *dev,
  183. const struct drm_display_mode *mode);
  184. #endif