blob: 9a73f786f4ad4cadd54cb32ddae5bdb49ad0e62c [file] [log] [blame]
Thomas Zimmermann85438a82019-05-08 10:26:11 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
2
3#ifndef DRM_GEM_VRAM_HELPER_H
4#define DRM_GEM_VRAM_HELPER_H
5
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +02006#include <drm/drm_file.h>
Thomas Zimmermann85438a82019-05-08 10:26:11 +02007#include <drm/drm_gem.h>
Thomas Zimmermannede0c692021-04-08 16:01:37 +02008#include <drm/drm_gem_ttm_helper.h>
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +02009#include <drm/drm_ioctl.h>
Thomas Zimmermann80f7c3f2020-02-03 16:52:55 +010010#include <drm/drm_modes.h>
Christian Königa3185f92022-05-09 21:13:35 +020011#include <drm/ttm/ttm_bo.h>
12#include <drm/ttm/ttm_placement.h>
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +020013
Andy Shevchenkoae710a42021-11-10 12:24:23 +020014#include <linux/container_of.h>
Lucas De Marchi7938f422022-02-04 09:05:41 -080015#include <linux/iosys-map.h>
Thomas Zimmermann85438a82019-05-08 10:26:11 +020016
Thomas Zimmermannfed1eec2019-05-08 10:26:14 +020017struct drm_mode_create_dumb;
Thomas Zimmermann6542ad82019-10-24 10:14:01 +020018struct drm_plane;
19struct drm_plane_state;
20struct drm_simple_display_pipe;
Thomas Zimmermann85438a82019-05-08 10:26:11 +020021struct filp;
Thomas Zimmermann59f59892019-05-08 10:26:18 +020022struct vm_area_struct;
Thomas Zimmermann85438a82019-05-08 10:26:11 +020023
Christian König7053e0e2020-09-07 16:14:52 +020024#define DRM_GEM_VRAM_PL_FLAG_SYSTEM (1 << 0)
25#define DRM_GEM_VRAM_PL_FLAG_VRAM (1 << 1)
26#define DRM_GEM_VRAM_PL_FLAG_TOPDOWN (1 << 2)
Thomas Zimmermann85438a82019-05-08 10:26:11 +020027
28/*
29 * Buffer-object helpers
30 */
31
32/**
33 * struct drm_gem_vram_object - GEM object backed by VRAM
Thomas Zimmermann85438a82019-05-08 10:26:11 +020034 * @bo: TTM buffer object
Thomas Zimmermann49a3f512020-11-03 10:30:11 +010035 * @map: Mapping information for @bo
Anna-Maria Behnsena0abb822024-01-22 10:31:51 +010036 * @placement: TTM placement information. Supported placements are %TTM_PL_VRAM
37 * and %TTM_PL_SYSTEM
Thomas Zimmermann85438a82019-05-08 10:26:11 +020038 * @placements: TTM placement information.
Thomas Zimmermann85438a82019-05-08 10:26:11 +020039 *
40 * The type struct drm_gem_vram_object represents a GEM object that is
41 * backed by VRAM. It can be used for simple framebuffer devices with
42 * dedicated memory. The buffer object can be evicted to system memory if
43 * video memory becomes scarce.
Thomas Zimmermann37a48ad2019-09-06 14:20:53 +020044 *
45 * GEM VRAM objects perform reference counting for pin and mapping
46 * operations. So a buffer object that has been pinned N times with
47 * drm_gem_vram_pin() must be unpinned N times with
48 * drm_gem_vram_unpin(). The same applies to pairs of
Thomas Zimmermannc8908bd2019-09-11 14:03:50 +020049 * drm_gem_vram_kmap() and drm_gem_vram_kunmap(), as well as pairs of
50 * drm_gem_vram_vmap() and drm_gem_vram_vunmap().
Thomas Zimmermann85438a82019-05-08 10:26:11 +020051 */
52struct drm_gem_vram_object {
Thomas Zimmermann85438a82019-05-08 10:26:11 +020053 struct ttm_buffer_object bo;
Lucas De Marchi7938f422022-02-04 09:05:41 -080054 struct iosys_map map;
Thomas Zimmermann85438a82019-05-08 10:26:11 +020055
Thomas Zimmermann37a48ad2019-09-06 14:20:53 +020056 /**
Thomas Zimmermann49a3f512020-11-03 10:30:11 +010057 * @vmap_use_count:
Thomas Zimmermann37a48ad2019-09-06 14:20:53 +020058 *
59 * Reference count on the virtual address.
60 * The address are un-mapped when the count reaches zero.
61 */
Thomas Zimmermann49a3f512020-11-03 10:30:11 +010062 unsigned int vmap_use_count;
Thomas Zimmermann37a48ad2019-09-06 14:20:53 +020063
Thomas Zimmermann85438a82019-05-08 10:26:11 +020064 /* Supported placements are %TTM_PL_VRAM and %TTM_PL_SYSTEM */
65 struct ttm_placement placement;
66 struct ttm_place placements[2];
Thomas Zimmermann85438a82019-05-08 10:26:11 +020067};
68
69/**
Mauro Carvalho Chehabe9d28712020-11-16 11:18:01 +010070 * drm_gem_vram_of_bo - Returns the container of type
71 * &struct drm_gem_vram_object for field bo.
Thomas Zimmermann85438a82019-05-08 10:26:11 +020072 * @bo: the VRAM buffer object
73 * Returns: The containing GEM VRAM object
74 */
75static inline struct drm_gem_vram_object *drm_gem_vram_of_bo(
76 struct ttm_buffer_object *bo)
77{
78 return container_of(bo, struct drm_gem_vram_object, bo);
79}
80
81/**
Mauro Carvalho Chehabe9d28712020-11-16 11:18:01 +010082 * drm_gem_vram_of_gem - Returns the container of type
83 * &struct drm_gem_vram_object for field gem.
Thomas Zimmermann85438a82019-05-08 10:26:11 +020084 * @gem: the GEM object
85 * Returns: The containing GEM VRAM object
86 */
87static inline struct drm_gem_vram_object *drm_gem_vram_of_gem(
88 struct drm_gem_object *gem)
89{
Gerd Hoffmann0e580c62019-08-05 16:01:04 +020090 return container_of(gem, struct drm_gem_vram_object, bo.base);
Thomas Zimmermann85438a82019-05-08 10:26:11 +020091}
92
93struct drm_gem_vram_object *drm_gem_vram_create(struct drm_device *dev,
Thomas Zimmermann85438a82019-05-08 10:26:11 +020094 size_t size,
Thomas Zimmermannebe94282020-01-06 13:57:43 +010095 unsigned long pg_align);
Thomas Zimmermann85438a82019-05-08 10:26:11 +020096void drm_gem_vram_put(struct drm_gem_vram_object *gbo);
Thomas Zimmermann85438a82019-05-08 10:26:11 +020097s64 drm_gem_vram_offset(struct drm_gem_vram_object *gbo);
98int drm_gem_vram_pin(struct drm_gem_vram_object *gbo, unsigned long pl_flag);
99int drm_gem_vram_unpin(struct drm_gem_vram_object *gbo);
Lucas De Marchi7938f422022-02-04 09:05:41 -0800100int drm_gem_vram_vmap(struct drm_gem_vram_object *gbo, struct iosys_map *map);
101void drm_gem_vram_vunmap(struct drm_gem_vram_object *gbo,
102 struct iosys_map *map);
Thomas Zimmermann85438a82019-05-08 10:26:11 +0200103
Thomas Zimmermannfed1eec2019-05-08 10:26:14 +0200104int drm_gem_vram_fill_create_dumb(struct drm_file *file,
105 struct drm_device *dev,
Thomas Zimmermannfed1eec2019-05-08 10:26:14 +0200106 unsigned long pg_align,
Thomas Zimmermann98707322019-12-03 09:38:17 +0100107 unsigned long pitch_align,
Thomas Zimmermannfed1eec2019-05-08 10:26:14 +0200108 struct drm_mode_create_dumb *args);
109
Thomas Zimmermann6c812bc2019-05-08 10:26:12 +0200110/*
Thomas Zimmermann737000f2019-05-08 10:26:13 +0200111 * Helpers for struct drm_driver
112 */
113
Thomas Zimmermann59f59892019-05-08 10:26:18 +0200114int drm_gem_vram_driver_dumb_create(struct drm_file *file,
115 struct drm_device *dev,
116 struct drm_mode_create_dumb *args);
Thomas Zimmermann59f59892019-05-08 10:26:18 +0200117
Thomas Zimmermann6542ad82019-10-24 10:14:01 +0200118/*
119 * Helpers for struct drm_plane_helper_funcs
120 */
121int
122drm_gem_vram_plane_helper_prepare_fb(struct drm_plane *plane,
123 struct drm_plane_state *new_state);
124void
125drm_gem_vram_plane_helper_cleanup_fb(struct drm_plane *plane,
126 struct drm_plane_state *old_state);
127
Daniel Vetterf8bd3db2021-06-22 18:55:06 +0200128/**
Anna-Maria Behnsena0abb822024-01-22 10:31:51 +0100129 * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - Initializes struct drm_plane_helper_funcs
130 * for VRAM handling
Daniel Vetterf8bd3db2021-06-22 18:55:06 +0200131 *
132 * Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This
133 * macro initializes struct drm_plane_helper_funcs to use the respective helper
134 * functions.
135 */
136#define DRM_GEM_VRAM_PLANE_HELPER_FUNCS \
137 .prepare_fb = drm_gem_vram_plane_helper_prepare_fb, \
138 .cleanup_fb = drm_gem_vram_plane_helper_cleanup_fb
139
Thomas Zimmermann6542ad82019-10-24 10:14:01 +0200140/*
141 * Helpers for struct drm_simple_display_pipe_funcs
142 */
143
144int drm_gem_vram_simple_display_pipe_prepare_fb(
145 struct drm_simple_display_pipe *pipe,
146 struct drm_plane_state *new_state);
147
148void drm_gem_vram_simple_display_pipe_cleanup_fb(
149 struct drm_simple_display_pipe *pipe,
150 struct drm_plane_state *old_state);
151
Thomas Zimmermann59f59892019-05-08 10:26:18 +0200152/**
Anna-Maria Behnsena0abb822024-01-22 10:31:51 +0100153 * define DRM_GEM_VRAM_DRIVER - default callback functions for
154 * &struct drm_driver
Thomas Zimmermann59f59892019-05-08 10:26:18 +0200155 *
156 * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize
157 * &struct drm_driver with default functions.
158 */
159#define DRM_GEM_VRAM_DRIVER \
Thomas Zimmermann71e801b2023-06-20 09:59:58 +0200160 .debugfs_init = drm_vram_mm_debugfs_init, \
161 .dumb_create = drm_gem_vram_driver_dumb_create, \
162 .dumb_map_offset = drm_gem_ttm_dumb_map_offset
Thomas Zimmermann59f59892019-05-08 10:26:18 +0200163
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200164/*
165 * VRAM memory manager
166 */
167
168/**
169 * struct drm_vram_mm - An instance of VRAM MM
170 * @vram_base: Base address of the managed video memory
171 * @vram_size: Size of the managed video memory in bytes
172 * @bdev: The TTM BO device.
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200173 *
174 * The fields &struct drm_vram_mm.vram_base and
175 * &struct drm_vram_mm.vrm_size are managed by VRAM MM, but are
176 * available for public read access. Use the field
177 * &struct drm_vram_mm.bdev to access the TTM BO device.
178 */
179struct drm_vram_mm {
180 uint64_t vram_base;
181 size_t vram_size;
182
Christian König8af8a102020-10-01 14:51:40 +0200183 struct ttm_device bdev;
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200184};
185
186/**
Anna-Maria Behnsena0abb822024-01-22 10:31:51 +0100187 * drm_vram_mm_of_bdev() - Returns the container of type &struct ttm_device for
188 * field bdev.
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200189 * @bdev: the TTM BO device
190 *
191 * Returns:
192 * The containing instance of &struct drm_vram_mm
193 */
194static inline struct drm_vram_mm *drm_vram_mm_of_bdev(
Christian König8af8a102020-10-01 14:51:40 +0200195 struct ttm_device *bdev)
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200196{
197 return container_of(bdev, struct drm_vram_mm, bdev);
198}
199
Wambui Karuga7ce844712020-03-10 16:31:21 +0300200void drm_vram_mm_debugfs_init(struct drm_minor *minor);
Thomas Zimmermann6b5ce4a2019-09-11 13:09:07 +0200201
202/*
203 * Helpers for integration with struct drm_device
204 */
205
Thomas Zimmermanna5f23a72020-07-16 14:53:48 +0200206int drmm_vram_helper_init(struct drm_device *dev, uint64_t vram_base,
207 size_t vram_size);
208
Thomas Zimmermann80f7c3f2020-02-03 16:52:55 +0100209/*
210 * Mode-config helpers
211 */
212
213enum drm_mode_status
214drm_vram_helper_mode_valid(struct drm_device *dev,
215 const struct drm_display_mode *mode);
216
Thomas Zimmermann85438a82019-05-08 10:26:11 +0200217#endif