Branch data Line data Source code
1 : : // SPDX-License-Identifier: GPL-2.0-or-later
2 : : /*
3 : : * drm gem framebuffer helper functions
4 : : *
5 : : * Copyright (C) 2017 Noralf Trønnes
6 : : */
7 : :
8 : : #include <linux/dma-buf.h>
9 : : #include <linux/dma-fence.h>
10 : : #include <linux/dma-resv.h>
11 : : #include <linux/slab.h>
12 : :
13 : : #include <drm/drm_atomic.h>
14 : : #include <drm/drm_atomic_uapi.h>
15 : : #include <drm/drm_damage_helper.h>
16 : : #include <drm/drm_fb_helper.h>
17 : : #include <drm/drm_fourcc.h>
18 : : #include <drm/drm_framebuffer.h>
19 : : #include <drm/drm_gem.h>
20 : : #include <drm/drm_gem_framebuffer_helper.h>
21 : : #include <drm/drm_modeset_helper.h>
22 : : #include <drm/drm_simple_kms_helper.h>
23 : :
24 : : /**
25 : : * DOC: overview
26 : : *
27 : : * This library provides helpers for drivers that don't subclass
28 : : * &drm_framebuffer and use &drm_gem_object for their backing storage.
29 : : *
30 : : * Drivers without additional needs to validate framebuffers can simply use
31 : : * drm_gem_fb_create() and everything is wired up automatically. Other drivers
32 : : * can use all parts independently.
33 : : */
34 : :
35 : : /**
36 : : * drm_gem_fb_get_obj() - Get GEM object backing the framebuffer
37 : : * @fb: Framebuffer
38 : : * @plane: Plane index
39 : : *
40 : : * No additional reference is taken beyond the one that the &drm_frambuffer
41 : : * already holds.
42 : : *
43 : : * Returns:
44 : : * Pointer to &drm_gem_object for the given framebuffer and plane index or NULL
45 : : * if it does not exist.
46 : : */
47 : 0 : struct drm_gem_object *drm_gem_fb_get_obj(struct drm_framebuffer *fb,
48 : : unsigned int plane)
49 : : {
50 [ # # ]: 0 : if (plane >= 4)
51 : : return NULL;
52 : :
53 : 0 : return fb->obj[plane];
54 : : }
55 : : EXPORT_SYMBOL_GPL(drm_gem_fb_get_obj);
56 : :
57 : : static struct drm_framebuffer *
58 : 0 : drm_gem_fb_alloc(struct drm_device *dev,
59 : : const struct drm_mode_fb_cmd2 *mode_cmd,
60 : : struct drm_gem_object **obj, unsigned int num_planes,
61 : : const struct drm_framebuffer_funcs *funcs)
62 : : {
63 : 0 : struct drm_framebuffer *fb;
64 : 0 : int ret, i;
65 : :
66 : 0 : fb = kzalloc(sizeof(*fb), GFP_KERNEL);
67 [ # # ]: 0 : if (!fb)
68 : : return ERR_PTR(-ENOMEM);
69 : :
70 : 0 : drm_helper_mode_fill_fb_struct(dev, fb, mode_cmd);
71 : :
72 [ # # ]: 0 : for (i = 0; i < num_planes; i++)
73 : 0 : fb->obj[i] = obj[i];
74 : :
75 : 0 : ret = drm_framebuffer_init(dev, fb, funcs);
76 [ # # ]: 0 : if (ret) {
77 : 0 : drm_err(dev, "Failed to init framebuffer: %d\n", ret);
78 : 0 : kfree(fb);
79 : 0 : return ERR_PTR(ret);
80 : : }
81 : :
82 : : return fb;
83 : : }
84 : :
85 : : /**
86 : : * drm_gem_fb_destroy - Free GEM backed framebuffer
87 : : * @fb: Framebuffer
88 : : *
89 : : * Frees a GEM backed framebuffer with its backing buffer(s) and the structure
90 : : * itself. Drivers can use this as their &drm_framebuffer_funcs->destroy
91 : : * callback.
92 : : */
93 : 0 : void drm_gem_fb_destroy(struct drm_framebuffer *fb)
94 : : {
95 : 0 : int i;
96 : :
97 [ # # ]: 0 : for (i = 0; i < 4; i++)
98 : 0 : drm_gem_object_put_unlocked(fb->obj[i]);
99 : :
100 : 0 : drm_framebuffer_cleanup(fb);
101 : 0 : kfree(fb);
102 : 0 : }
103 : : EXPORT_SYMBOL(drm_gem_fb_destroy);
104 : :
105 : : /**
106 : : * drm_gem_fb_create_handle - Create handle for GEM backed framebuffer
107 : : * @fb: Framebuffer
108 : : * @file: DRM file to register the handle for
109 : : * @handle: Pointer to return the created handle
110 : : *
111 : : * This function creates a handle for the GEM object backing the framebuffer.
112 : : * Drivers can use this as their &drm_framebuffer_funcs->create_handle
113 : : * callback. The GETFB IOCTL calls into this callback.
114 : : *
115 : : * Returns:
116 : : * 0 on success or a negative error code on failure.
117 : : */
118 : 0 : int drm_gem_fb_create_handle(struct drm_framebuffer *fb, struct drm_file *file,
119 : : unsigned int *handle)
120 : : {
121 : 0 : return drm_gem_handle_create(file, fb->obj[0], handle);
122 : : }
123 : : EXPORT_SYMBOL(drm_gem_fb_create_handle);
124 : :
125 : : /**
126 : : * drm_gem_fb_create_with_funcs() - Helper function for the
127 : : * &drm_mode_config_funcs.fb_create
128 : : * callback
129 : : * @dev: DRM device
130 : : * @file: DRM file that holds the GEM handle(s) backing the framebuffer
131 : : * @mode_cmd: Metadata from the userspace framebuffer creation request
132 : : * @funcs: vtable to be used for the new framebuffer object
133 : : *
134 : : * This function can be used to set &drm_framebuffer_funcs for drivers that need
135 : : * custom framebuffer callbacks. Use drm_gem_fb_create() if you don't need to
136 : : * change &drm_framebuffer_funcs. The function does buffer size validation.
137 : : *
138 : : * Returns:
139 : : * Pointer to a &drm_framebuffer on success or an error pointer on failure.
140 : : */
141 : : struct drm_framebuffer *
142 : 0 : drm_gem_fb_create_with_funcs(struct drm_device *dev, struct drm_file *file,
143 : : const struct drm_mode_fb_cmd2 *mode_cmd,
144 : : const struct drm_framebuffer_funcs *funcs)
145 : : {
146 : 0 : const struct drm_format_info *info;
147 : 0 : struct drm_gem_object *objs[4];
148 : 0 : struct drm_framebuffer *fb;
149 : 0 : int ret, i;
150 : :
151 : 0 : info = drm_get_format_info(dev, mode_cmd);
152 [ # # ]: 0 : if (!info)
153 : : return ERR_PTR(-EINVAL);
154 : :
155 [ # # ]: 0 : for (i = 0; i < info->num_planes; i++) {
156 [ # # ]: 0 : unsigned int width = mode_cmd->width / (i ? info->hsub : 1);
157 [ # # ]: 0 : unsigned int height = mode_cmd->height / (i ? info->vsub : 1);
158 : 0 : unsigned int min_size;
159 : :
160 : 0 : objs[i] = drm_gem_object_lookup(file, mode_cmd->handles[i]);
161 [ # # ]: 0 : if (!objs[i]) {
162 : 0 : drm_dbg_kms(dev, "Failed to lookup GEM object\n");
163 : 0 : ret = -ENOENT;
164 : 0 : goto err_gem_object_put;
165 : : }
166 : :
167 : 0 : min_size = (height - 1) * mode_cmd->pitches[i]
168 : 0 : + drm_format_info_min_pitch(info, i, width)
169 : 0 : + mode_cmd->offsets[i];
170 : :
171 [ # # ]: 0 : if (objs[i]->size < min_size) {
172 : 0 : drm_gem_object_put_unlocked(objs[i]);
173 : 0 : ret = -EINVAL;
174 : 0 : goto err_gem_object_put;
175 : : }
176 : : }
177 : :
178 : 0 : fb = drm_gem_fb_alloc(dev, mode_cmd, objs, i, funcs);
179 [ # # ]: 0 : if (IS_ERR(fb)) {
180 : 0 : ret = PTR_ERR(fb);
181 : 0 : goto err_gem_object_put;
182 : : }
183 : :
184 : : return fb;
185 : :
186 : 0 : err_gem_object_put:
187 [ # # ]: 0 : for (i--; i >= 0; i--)
188 : 0 : drm_gem_object_put_unlocked(objs[i]);
189 : :
190 : 0 : return ERR_PTR(ret);
191 : : }
192 : : EXPORT_SYMBOL_GPL(drm_gem_fb_create_with_funcs);
193 : :
194 : : static const struct drm_framebuffer_funcs drm_gem_fb_funcs = {
195 : : .destroy = drm_gem_fb_destroy,
196 : : .create_handle = drm_gem_fb_create_handle,
197 : : };
198 : :
199 : : /**
200 : : * drm_gem_fb_create() - Helper function for the
201 : : * &drm_mode_config_funcs.fb_create callback
202 : : * @dev: DRM device
203 : : * @file: DRM file that holds the GEM handle(s) backing the framebuffer
204 : : * @mode_cmd: Metadata from the userspace framebuffer creation request
205 : : *
206 : : * This function creates a new framebuffer object described by
207 : : * &drm_mode_fb_cmd2. This description includes handles for the buffer(s)
208 : : * backing the framebuffer.
209 : : *
210 : : * If your hardware has special alignment or pitch requirements these should be
211 : : * checked before calling this function. The function does buffer size
212 : : * validation. Use drm_gem_fb_create_with_dirty() if you need framebuffer
213 : : * flushing.
214 : : *
215 : : * Drivers can use this as their &drm_mode_config_funcs.fb_create callback.
216 : : * The ADDFB2 IOCTL calls into this callback.
217 : : *
218 : : * Returns:
219 : : * Pointer to a &drm_framebuffer on success or an error pointer on failure.
220 : : */
221 : : struct drm_framebuffer *
222 : 0 : drm_gem_fb_create(struct drm_device *dev, struct drm_file *file,
223 : : const struct drm_mode_fb_cmd2 *mode_cmd)
224 : : {
225 : 0 : return drm_gem_fb_create_with_funcs(dev, file, mode_cmd,
226 : : &drm_gem_fb_funcs);
227 : : }
228 : : EXPORT_SYMBOL_GPL(drm_gem_fb_create);
229 : :
230 : : static const struct drm_framebuffer_funcs drm_gem_fb_funcs_dirtyfb = {
231 : : .destroy = drm_gem_fb_destroy,
232 : : .create_handle = drm_gem_fb_create_handle,
233 : : .dirty = drm_atomic_helper_dirtyfb,
234 : : };
235 : :
236 : : /**
237 : : * drm_gem_fb_create_with_dirty() - Helper function for the
238 : : * &drm_mode_config_funcs.fb_create callback
239 : : * @dev: DRM device
240 : : * @file: DRM file that holds the GEM handle(s) backing the framebuffer
241 : : * @mode_cmd: Metadata from the userspace framebuffer creation request
242 : : *
243 : : * This function creates a new framebuffer object described by
244 : : * &drm_mode_fb_cmd2. This description includes handles for the buffer(s)
245 : : * backing the framebuffer. drm_atomic_helper_dirtyfb() is used for the dirty
246 : : * callback giving framebuffer flushing through the atomic machinery. Use
247 : : * drm_gem_fb_create() if you don't need the dirty callback.
248 : : * The function does buffer size validation.
249 : : *
250 : : * Drivers should also call drm_plane_enable_fb_damage_clips() on all planes
251 : : * to enable userspace to use damage clips also with the ATOMIC IOCTL.
252 : : *
253 : : * Drivers can use this as their &drm_mode_config_funcs.fb_create callback.
254 : : * The ADDFB2 IOCTL calls into this callback.
255 : : *
256 : : * Returns:
257 : : * Pointer to a &drm_framebuffer on success or an error pointer on failure.
258 : : */
259 : : struct drm_framebuffer *
260 : 0 : drm_gem_fb_create_with_dirty(struct drm_device *dev, struct drm_file *file,
261 : : const struct drm_mode_fb_cmd2 *mode_cmd)
262 : : {
263 : 0 : return drm_gem_fb_create_with_funcs(dev, file, mode_cmd,
264 : : &drm_gem_fb_funcs_dirtyfb);
265 : : }
266 : : EXPORT_SYMBOL_GPL(drm_gem_fb_create_with_dirty);
267 : :
268 : : /**
269 : : * drm_gem_fb_prepare_fb() - Prepare a GEM backed framebuffer
270 : : * @plane: Plane
271 : : * @state: Plane state the fence will be attached to
272 : : *
273 : : * This function extracts the exclusive fence from &drm_gem_object.resv and
274 : : * attaches it to plane state for the atomic helper to wait on. This is
275 : : * necessary to correctly implement implicit synchronization for any buffers
276 : : * shared as a struct &dma_buf. This function can be used as the
277 : : * &drm_plane_helper_funcs.prepare_fb callback.
278 : : *
279 : : * There is no need for &drm_plane_helper_funcs.cleanup_fb hook for simple
280 : : * gem based framebuffer drivers which have their buffers always pinned in
281 : : * memory.
282 : : *
283 : : * See drm_atomic_set_fence_for_plane() for a discussion of implicit and
284 : : * explicit fencing in atomic modeset updates.
285 : : */
286 : 0 : int drm_gem_fb_prepare_fb(struct drm_plane *plane,
287 : : struct drm_plane_state *state)
288 : : {
289 : 0 : struct drm_gem_object *obj;
290 : 0 : struct dma_fence *fence;
291 : :
292 [ # # ]: 0 : if (!state->fb)
293 : : return 0;
294 : :
295 : 0 : obj = drm_gem_fb_get_obj(state->fb, 0);
296 [ # # ]: 0 : fence = dma_resv_get_excl_rcu(obj->resv);
297 : 0 : drm_atomic_set_fence_for_plane(state, fence);
298 : :
299 : 0 : return 0;
300 : : }
301 : : EXPORT_SYMBOL_GPL(drm_gem_fb_prepare_fb);
302 : :
303 : : /**
304 : : * drm_gem_fb_simple_display_pipe_prepare_fb - prepare_fb helper for
305 : : * &drm_simple_display_pipe
306 : : * @pipe: Simple display pipe
307 : : * @plane_state: Plane state
308 : : *
309 : : * This function uses drm_gem_fb_prepare_fb() to extract the exclusive fence
310 : : * from &drm_gem_object.resv and attaches it to plane state for the atomic
311 : : * helper to wait on. This is necessary to correctly implement implicit
312 : : * synchronization for any buffers shared as a struct &dma_buf. Drivers can use
313 : : * this as their &drm_simple_display_pipe_funcs.prepare_fb callback.
314 : : *
315 : : * See drm_atomic_set_fence_for_plane() for a discussion of implicit and
316 : : * explicit fencing in atomic modeset updates.
317 : : */
318 : 0 : int drm_gem_fb_simple_display_pipe_prepare_fb(struct drm_simple_display_pipe *pipe,
319 : : struct drm_plane_state *plane_state)
320 : : {
321 : 0 : return drm_gem_fb_prepare_fb(&pipe->plane, plane_state);
322 : : }
323 : : EXPORT_SYMBOL(drm_gem_fb_simple_display_pipe_prepare_fb);
|
