Commit | Line | Data |
---|---|---|
7520a277 DV |
1 | /* |
2 | * Copyright (c) 2016 Intel Corporation | |
3 | * | |
4 | * Permission to use, copy, modify, distribute, and sell this software and its | |
5 | * documentation for any purpose is hereby granted without fee, provided that | |
6 | * the above copyright notice appear in all copies and that both that copyright | |
7 | * notice and this permission notice appear in supporting documentation, and | |
8 | * that the name of the copyright holders not be used in advertising or | |
9 | * publicity pertaining to distribution of the software without specific, | |
10 | * written prior permission. The copyright holders make no representations | |
11 | * about the suitability of this software for any purpose. It is provided "as | |
12 | * is" without express or implied warranty. | |
13 | * | |
14 | * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, | |
15 | * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO | |
16 | * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR | |
17 | * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, | |
18 | * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER | |
19 | * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE | |
20 | * OF THIS SOFTWARE. | |
21 | */ | |
22 | ||
23 | #include <linux/export.h> | |
24 | #include <drm/drmP.h> | |
25 | #include <drm/drm_auth.h> | |
26 | #include <drm/drm_framebuffer.h> | |
941b8caa | 27 | #include <drm/drm_atomic.h> |
45d58b40 | 28 | #include <drm/drm_print.h> |
7520a277 | 29 | |
45d58b40 | 30 | #include "drm_internal.h" |
7520a277 DV |
31 | #include "drm_crtc_internal.h" |
32 | ||
750fb8c4 DV |
33 | /** |
34 | * DOC: overview | |
35 | * | |
36 | * Frame buffers are abstract memory objects that provide a source of pixels to | |
37 | * scanout to a CRTC. Applications explicitly request the creation of frame | |
38 | * buffers through the DRM_IOCTL_MODE_ADDFB(2) ioctls and receive an opaque | |
39 | * handle that can be passed to the KMS CRTC control, plane configuration and | |
40 | * page flip functions. | |
41 | * | |
42 | * Frame buffers rely on the underlying memory manager for allocating backing | |
43 | * storage. When creating a frame buffer applications pass a memory handle | |
44 | * (or a list of memory handles for multi-planar formats) through the | |
ea0dd85a | 45 | * &struct drm_mode_fb_cmd2 argument. For drivers using GEM as their userspace |
750fb8c4 DV |
46 | * buffer management interface this would be a GEM handle. Drivers are however |
47 | * free to use their own backing storage object handles, e.g. vmwgfx directly | |
48 | * exposes special TTM handles to userspace and so expects TTM handles in the | |
49 | * create ioctl and not GEM handles. | |
50 | * | |
ea0dd85a | 51 | * Framebuffers are tracked with &struct drm_framebuffer. They are published |
750fb8c4 DV |
52 | * using drm_framebuffer_init() - after calling that function userspace can use |
53 | * and access the framebuffer object. The helper function | |
54 | * drm_helper_mode_fill_fb_struct() can be used to pre-fill the required | |
55 | * metadata fields. | |
56 | * | |
57 | * The lifetime of a drm framebuffer is controlled with a reference count, | |
a4a69da0 TR |
58 | * drivers can grab additional references with drm_framebuffer_get() and drop |
59 | * them again with drm_framebuffer_put(). For driver-private framebuffers for | |
60 | * which the last reference is never dropped (e.g. for the fbdev framebuffer | |
61 | * when the struct &struct drm_framebuffer is embedded into the fbdev helper | |
62 | * struct) drivers can manually clean up a framebuffer at module unload time | |
63 | * with drm_framebuffer_unregister_private(). But doing this is not | |
64 | * recommended, and it's better to have a normal free-standing &struct | |
d574528a | 65 | * drm_framebuffer. |
750fb8c4 DV |
66 | */ |
67 | ||
43968d7b DV |
68 | int drm_framebuffer_check_src_coords(uint32_t src_x, uint32_t src_y, |
69 | uint32_t src_w, uint32_t src_h, | |
70 | const struct drm_framebuffer *fb) | |
71 | { | |
72 | unsigned int fb_width, fb_height; | |
73 | ||
74 | fb_width = fb->width << 16; | |
75 | fb_height = fb->height << 16; | |
76 | ||
77 | /* Make sure source coordinates are inside the fb. */ | |
78 | if (src_w > fb_width || | |
79 | src_x > fb_width - src_w || | |
80 | src_h > fb_height || | |
81 | src_y > fb_height - src_h) { | |
82 | DRM_DEBUG_KMS("Invalid source coordinates " | |
0338f0d0 | 83 | "%u.%06ux%u.%06u+%u.%06u+%u.%06u (fb %ux%u)\n", |
43968d7b DV |
84 | src_w >> 16, ((src_w & 0xffff) * 15625) >> 10, |
85 | src_h >> 16, ((src_h & 0xffff) * 15625) >> 10, | |
86 | src_x >> 16, ((src_x & 0xffff) * 15625) >> 10, | |
0338f0d0 VS |
87 | src_y >> 16, ((src_y & 0xffff) * 15625) >> 10, |
88 | fb->width, fb->height); | |
43968d7b DV |
89 | return -ENOSPC; |
90 | } | |
91 | ||
92 | return 0; | |
93 | } | |
94 | ||
7520a277 DV |
95 | /** |
96 | * drm_mode_addfb - add an FB to the graphics configuration | |
97 | * @dev: drm device for the ioctl | |
d30827ce NT |
98 | * @or: pointer to request structure |
99 | * @file_priv: drm file | |
7520a277 DV |
100 | * |
101 | * Add a new FB to the specified CRTC, given a user request. This is the | |
102 | * original addfb ioctl which only supported RGB formats. | |
103 | * | |
d30827ce | 104 | * Called by the user via ioctl, or by an in-kernel client. |
7520a277 DV |
105 | * |
106 | * Returns: | |
107 | * Zero on success, negative errno on failure. | |
108 | */ | |
d30827ce NT |
109 | int drm_mode_addfb(struct drm_device *dev, struct drm_mode_fb_cmd *or, |
110 | struct drm_file *file_priv) | |
7520a277 | 111 | { |
7520a277 DV |
112 | struct drm_mode_fb_cmd2 r = {}; |
113 | int ret; | |
114 | ||
115 | /* convert to new format and call new ioctl */ | |
116 | r.fb_id = or->fb_id; | |
117 | r.width = or->width; | |
118 | r.height = or->height; | |
119 | r.pitches[0] = or->pitch; | |
120 | r.pixel_format = drm_mode_legacy_fb_format(or->bpp, or->depth); | |
121 | r.handles[0] = or->handle; | |
122 | ||
c20bb155 IM |
123 | if (r.pixel_format == DRM_FORMAT_XRGB2101010 && |
124 | dev->driver->driver_features & DRIVER_PREFER_XBGR_30BPP) | |
125 | r.pixel_format = DRM_FORMAT_XBGR2101010; | |
126 | ||
7520a277 DV |
127 | ret = drm_mode_addfb2(dev, &r, file_priv); |
128 | if (ret) | |
129 | return ret; | |
130 | ||
131 | or->fb_id = r.fb_id; | |
132 | ||
133 | return 0; | |
134 | } | |
135 | ||
d30827ce NT |
136 | int drm_mode_addfb_ioctl(struct drm_device *dev, |
137 | void *data, struct drm_file *file_priv) | |
138 | { | |
139 | return drm_mode_addfb(dev, data, file_priv); | |
140 | } | |
141 | ||
568c5e45 VS |
142 | static int fb_plane_width(int width, |
143 | const struct drm_format_info *format, int plane) | |
144 | { | |
145 | if (plane == 0) | |
146 | return width; | |
147 | ||
33f673aa | 148 | return DIV_ROUND_UP(width, format->hsub); |
568c5e45 VS |
149 | } |
150 | ||
151 | static int fb_plane_height(int height, | |
152 | const struct drm_format_info *format, int plane) | |
153 | { | |
154 | if (plane == 0) | |
155 | return height; | |
156 | ||
33f673aa | 157 | return DIV_ROUND_UP(height, format->vsub); |
568c5e45 VS |
158 | } |
159 | ||
6a0f9ebf VS |
160 | static int framebuffer_check(struct drm_device *dev, |
161 | const struct drm_mode_fb_cmd2 *r) | |
7520a277 | 162 | { |
d5493490 LP |
163 | const struct drm_format_info *info; |
164 | int i; | |
7520a277 | 165 | |
6a0f9ebf | 166 | /* check if the format is supported at all */ |
333d2da5 | 167 | info = __drm_format_info(r->pixel_format & ~DRM_FORMAT_BIG_ENDIAN); |
d5493490 | 168 | if (!info) { |
b3c11ac2 | 169 | struct drm_format_name_buf format_name; |
c10496c8 | 170 | |
b3c11ac2 | 171 | DRM_DEBUG_KMS("bad framebuffer format %s\n", |
c10496c8 VS |
172 | drm_get_format_name(r->pixel_format, |
173 | &format_name)); | |
d5493490 | 174 | return -EINVAL; |
7520a277 DV |
175 | } |
176 | ||
6a0f9ebf VS |
177 | /* now let the driver pick its own format info */ |
178 | info = drm_get_format_info(dev, r); | |
179 | ||
33f673aa | 180 | if (r->width == 0) { |
7520a277 DV |
181 | DRM_DEBUG_KMS("bad framebuffer width %u\n", r->width); |
182 | return -EINVAL; | |
183 | } | |
184 | ||
33f673aa | 185 | if (r->height == 0) { |
7520a277 DV |
186 | DRM_DEBUG_KMS("bad framebuffer height %u\n", r->height); |
187 | return -EINVAL; | |
188 | } | |
189 | ||
d5493490 | 190 | for (i = 0; i < info->num_planes; i++) { |
568c5e45 VS |
191 | unsigned int width = fb_plane_width(r->width, info, i); |
192 | unsigned int height = fb_plane_height(r->height, info, i); | |
d5493490 | 193 | unsigned int cpp = info->cpp[i]; |
7520a277 DV |
194 | |
195 | if (!r->handles[i]) { | |
196 | DRM_DEBUG_KMS("no buffer object handle for plane %d\n", i); | |
197 | return -EINVAL; | |
198 | } | |
199 | ||
200 | if ((uint64_t) width * cpp > UINT_MAX) | |
201 | return -ERANGE; | |
202 | ||
203 | if ((uint64_t) height * r->pitches[i] + r->offsets[i] > UINT_MAX) | |
204 | return -ERANGE; | |
205 | ||
206 | if (r->pitches[i] < width * cpp) { | |
207 | DRM_DEBUG_KMS("bad pitch %u for plane %d\n", r->pitches[i], i); | |
208 | return -EINVAL; | |
209 | } | |
210 | ||
211 | if (r->modifier[i] && !(r->flags & DRM_MODE_FB_MODIFIERS)) { | |
212 | DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n", | |
213 | r->modifier[i], i); | |
214 | return -EINVAL; | |
215 | } | |
216 | ||
bae781b2 VS |
217 | if (r->flags & DRM_MODE_FB_MODIFIERS && |
218 | r->modifier[i] != r->modifier[0]) { | |
219 | DRM_DEBUG_KMS("bad fb modifier %llu for plane %d\n", | |
220 | r->modifier[i], i); | |
221 | return -EINVAL; | |
222 | } | |
223 | ||
7520a277 DV |
224 | /* modifier specific checks: */ |
225 | switch (r->modifier[i]) { | |
226 | case DRM_FORMAT_MOD_SAMSUNG_64_32_TILE: | |
227 | /* NOTE: the pitch restriction may be lifted later if it turns | |
228 | * out that no hw has this restriction: | |
229 | */ | |
230 | if (r->pixel_format != DRM_FORMAT_NV12 || | |
231 | width % 128 || height % 32 || | |
232 | r->pitches[i] % 128) { | |
233 | DRM_DEBUG_KMS("bad modifier data for plane %d\n", i); | |
234 | return -EINVAL; | |
235 | } | |
236 | break; | |
237 | ||
238 | default: | |
239 | break; | |
240 | } | |
241 | } | |
242 | ||
d5493490 | 243 | for (i = info->num_planes; i < 4; i++) { |
7520a277 DV |
244 | if (r->modifier[i]) { |
245 | DRM_DEBUG_KMS("non-zero modifier for unused plane %d\n", i); | |
246 | return -EINVAL; | |
247 | } | |
248 | ||
249 | /* Pre-FB_MODIFIERS userspace didn't clear the structs properly. */ | |
250 | if (!(r->flags & DRM_MODE_FB_MODIFIERS)) | |
251 | continue; | |
252 | ||
253 | if (r->handles[i]) { | |
254 | DRM_DEBUG_KMS("buffer object handle for unused plane %d\n", i); | |
255 | return -EINVAL; | |
256 | } | |
257 | ||
258 | if (r->pitches[i]) { | |
259 | DRM_DEBUG_KMS("non-zero pitch for unused plane %d\n", i); | |
260 | return -EINVAL; | |
261 | } | |
262 | ||
263 | if (r->offsets[i]) { | |
264 | DRM_DEBUG_KMS("non-zero offset for unused plane %d\n", i); | |
265 | return -EINVAL; | |
266 | } | |
267 | } | |
268 | ||
269 | return 0; | |
270 | } | |
271 | ||
272 | struct drm_framebuffer * | |
273 | drm_internal_framebuffer_create(struct drm_device *dev, | |
274 | const struct drm_mode_fb_cmd2 *r, | |
275 | struct drm_file *file_priv) | |
276 | { | |
277 | struct drm_mode_config *config = &dev->mode_config; | |
278 | struct drm_framebuffer *fb; | |
279 | int ret; | |
280 | ||
281 | if (r->flags & ~(DRM_MODE_FB_INTERLACED | DRM_MODE_FB_MODIFIERS)) { | |
282 | DRM_DEBUG_KMS("bad framebuffer flags 0x%08x\n", r->flags); | |
283 | return ERR_PTR(-EINVAL); | |
284 | } | |
285 | ||
286 | if ((config->min_width > r->width) || (r->width > config->max_width)) { | |
287 | DRM_DEBUG_KMS("bad framebuffer width %d, should be >= %d && <= %d\n", | |
288 | r->width, config->min_width, config->max_width); | |
289 | return ERR_PTR(-EINVAL); | |
290 | } | |
291 | if ((config->min_height > r->height) || (r->height > config->max_height)) { | |
292 | DRM_DEBUG_KMS("bad framebuffer height %d, should be >= %d && <= %d\n", | |
293 | r->height, config->min_height, config->max_height); | |
294 | return ERR_PTR(-EINVAL); | |
295 | } | |
296 | ||
297 | if (r->flags & DRM_MODE_FB_MODIFIERS && | |
298 | !dev->mode_config.allow_fb_modifiers) { | |
299 | DRM_DEBUG_KMS("driver does not support fb modifiers\n"); | |
300 | return ERR_PTR(-EINVAL); | |
301 | } | |
302 | ||
6a0f9ebf | 303 | ret = framebuffer_check(dev, r); |
7520a277 DV |
304 | if (ret) |
305 | return ERR_PTR(ret); | |
306 | ||
307 | fb = dev->mode_config.funcs->fb_create(dev, file_priv, r); | |
308 | if (IS_ERR(fb)) { | |
309 | DRM_DEBUG_KMS("could not create framebuffer\n"); | |
310 | return fb; | |
311 | } | |
312 | ||
313 | return fb; | |
314 | } | |
315 | ||
316 | /** | |
317 | * drm_mode_addfb2 - add an FB to the graphics configuration | |
318 | * @dev: drm device for the ioctl | |
319 | * @data: data pointer for the ioctl | |
320 | * @file_priv: drm file for the ioctl call | |
321 | * | |
322 | * Add a new FB to the specified CRTC, given a user request with format. This is | |
323 | * the 2nd version of the addfb ioctl, which supports multi-planar framebuffers | |
324 | * and uses fourcc codes as pixel format specifiers. | |
325 | * | |
326 | * Called by the user via ioctl. | |
327 | * | |
328 | * Returns: | |
329 | * Zero on success, negative errno on failure. | |
330 | */ | |
331 | int drm_mode_addfb2(struct drm_device *dev, | |
332 | void *data, struct drm_file *file_priv) | |
333 | { | |
334 | struct drm_mode_fb_cmd2 *r = data; | |
335 | struct drm_framebuffer *fb; | |
336 | ||
337 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
338 | return -EINVAL; | |
339 | ||
340 | fb = drm_internal_framebuffer_create(dev, r, file_priv); | |
341 | if (IS_ERR(fb)) | |
342 | return PTR_ERR(fb); | |
343 | ||
344 | DRM_DEBUG_KMS("[FB:%d]\n", fb->base.id); | |
345 | r->fb_id = fb->base.id; | |
346 | ||
347 | /* Transfer ownership to the filp for reaping on close */ | |
348 | mutex_lock(&file_priv->fbs_lock); | |
349 | list_add(&fb->filp_head, &file_priv->fbs); | |
350 | mutex_unlock(&file_priv->fbs_lock); | |
351 | ||
352 | return 0; | |
353 | } | |
354 | ||
355 | struct drm_mode_rmfb_work { | |
356 | struct work_struct work; | |
357 | struct list_head fbs; | |
358 | }; | |
359 | ||
360 | static void drm_mode_rmfb_work_fn(struct work_struct *w) | |
361 | { | |
362 | struct drm_mode_rmfb_work *arg = container_of(w, typeof(*arg), work); | |
363 | ||
364 | while (!list_empty(&arg->fbs)) { | |
365 | struct drm_framebuffer *fb = | |
366 | list_first_entry(&arg->fbs, typeof(*fb), filp_head); | |
367 | ||
368 | list_del_init(&fb->filp_head); | |
369 | drm_framebuffer_remove(fb); | |
370 | } | |
371 | } | |
372 | ||
373 | /** | |
374 | * drm_mode_rmfb - remove an FB from the configuration | |
d30827ce NT |
375 | * @dev: drm device |
376 | * @fb_id: id of framebuffer to remove | |
377 | * @file_priv: drm file | |
7520a277 | 378 | * |
d30827ce | 379 | * Remove the specified FB. |
7520a277 | 380 | * |
d30827ce | 381 | * Called by the user via ioctl, or by an in-kernel client. |
7520a277 DV |
382 | * |
383 | * Returns: | |
384 | * Zero on success, negative errno on failure. | |
385 | */ | |
d30827ce NT |
386 | int drm_mode_rmfb(struct drm_device *dev, u32 fb_id, |
387 | struct drm_file *file_priv) | |
7520a277 DV |
388 | { |
389 | struct drm_framebuffer *fb = NULL; | |
390 | struct drm_framebuffer *fbl = NULL; | |
7520a277 DV |
391 | int found = 0; |
392 | ||
393 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
394 | return -EINVAL; | |
395 | ||
d30827ce | 396 | fb = drm_framebuffer_lookup(dev, file_priv, fb_id); |
7520a277 DV |
397 | if (!fb) |
398 | return -ENOENT; | |
399 | ||
400 | mutex_lock(&file_priv->fbs_lock); | |
401 | list_for_each_entry(fbl, &file_priv->fbs, filp_head) | |
402 | if (fb == fbl) | |
403 | found = 1; | |
404 | if (!found) { | |
405 | mutex_unlock(&file_priv->fbs_lock); | |
406 | goto fail_unref; | |
407 | } | |
408 | ||
409 | list_del_init(&fb->filp_head); | |
410 | mutex_unlock(&file_priv->fbs_lock); | |
411 | ||
412 | /* drop the reference we picked up in framebuffer lookup */ | |
a4a69da0 | 413 | drm_framebuffer_put(fb); |
7520a277 DV |
414 | |
415 | /* | |
416 | * we now own the reference that was stored in the fbs list | |
417 | * | |
418 | * drm_framebuffer_remove may fail with -EINTR on pending signals, | |
419 | * so run this in a separate stack as there's no way to correctly | |
420 | * handle this after the fb is already removed from the lookup table. | |
421 | */ | |
422 | if (drm_framebuffer_read_refcount(fb) > 1) { | |
423 | struct drm_mode_rmfb_work arg; | |
424 | ||
425 | INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn); | |
426 | INIT_LIST_HEAD(&arg.fbs); | |
427 | list_add_tail(&fb->filp_head, &arg.fbs); | |
428 | ||
429 | schedule_work(&arg.work); | |
430 | flush_work(&arg.work); | |
431 | destroy_work_on_stack(&arg.work); | |
432 | } else | |
a4a69da0 | 433 | drm_framebuffer_put(fb); |
7520a277 DV |
434 | |
435 | return 0; | |
436 | ||
437 | fail_unref: | |
a4a69da0 | 438 | drm_framebuffer_put(fb); |
7520a277 DV |
439 | return -ENOENT; |
440 | } | |
441 | ||
d30827ce NT |
442 | int drm_mode_rmfb_ioctl(struct drm_device *dev, |
443 | void *data, struct drm_file *file_priv) | |
444 | { | |
445 | uint32_t *fb_id = data; | |
446 | ||
447 | return drm_mode_rmfb(dev, *fb_id, file_priv); | |
448 | } | |
449 | ||
7520a277 DV |
450 | /** |
451 | * drm_mode_getfb - get FB info | |
452 | * @dev: drm device for the ioctl | |
453 | * @data: data pointer for the ioctl | |
454 | * @file_priv: drm file for the ioctl call | |
455 | * | |
456 | * Lookup the FB given its ID and return info about it. | |
457 | * | |
458 | * Called by the user via ioctl. | |
459 | * | |
460 | * Returns: | |
461 | * Zero on success, negative errno on failure. | |
462 | */ | |
463 | int drm_mode_getfb(struct drm_device *dev, | |
464 | void *data, struct drm_file *file_priv) | |
465 | { | |
466 | struct drm_mode_fb_cmd *r = data; | |
467 | struct drm_framebuffer *fb; | |
468 | int ret; | |
469 | ||
470 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
471 | return -EINVAL; | |
472 | ||
418da172 | 473 | fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id); |
7520a277 DV |
474 | if (!fb) |
475 | return -ENOENT; | |
476 | ||
b24791fe DS |
477 | /* Multi-planar framebuffers need getfb2. */ |
478 | if (fb->format->num_planes > 1) { | |
479 | ret = -EINVAL; | |
480 | goto out; | |
481 | } | |
482 | ||
487da617 DS |
483 | if (!fb->funcs->create_handle) { |
484 | ret = -ENODEV; | |
485 | goto out; | |
486 | } | |
487 | ||
7520a277 DV |
488 | r->height = fb->height; |
489 | r->width = fb->width; | |
b00c600e | 490 | r->depth = fb->format->depth; |
272725c7 | 491 | r->bpp = fb->format->cpp[0] * 8; |
7520a277 | 492 | r->pitch = fb->pitches[0]; |
487da617 DS |
493 | |
494 | /* GET_FB() is an unprivileged ioctl so we must not return a | |
495 | * buffer-handle to non-master processes! For | |
496 | * backwards-compatibility reasons, we cannot make GET_FB() privileged, | |
497 | * so just return an invalid handle for non-masters. | |
498 | */ | |
0d49f303 | 499 | if (!drm_is_current_master(file_priv) && !capable(CAP_SYS_ADMIN)) { |
487da617 DS |
500 | r->handle = 0; |
501 | ret = 0; | |
502 | goto out; | |
7520a277 DV |
503 | } |
504 | ||
487da617 DS |
505 | ret = fb->funcs->create_handle(fb, file_priv, &r->handle); |
506 | ||
b24791fe | 507 | out: |
a4a69da0 | 508 | drm_framebuffer_put(fb); |
7520a277 DV |
509 | |
510 | return ret; | |
511 | } | |
512 | ||
513 | /** | |
514 | * drm_mode_dirtyfb_ioctl - flush frontbuffer rendering on an FB | |
515 | * @dev: drm device for the ioctl | |
516 | * @data: data pointer for the ioctl | |
517 | * @file_priv: drm file for the ioctl call | |
518 | * | |
519 | * Lookup the FB and flush out the damaged area supplied by userspace as a clip | |
520 | * rectangle list. Generic userspace which does frontbuffer rendering must call | |
521 | * this ioctl to flush out the changes on manual-update display outputs, e.g. | |
522 | * usb display-link, mipi manual update panels or edp panel self refresh modes. | |
523 | * | |
524 | * Modesetting drivers which always update the frontbuffer do not need to | |
d574528a | 525 | * implement the corresponding &drm_framebuffer_funcs.dirty callback. |
7520a277 DV |
526 | * |
527 | * Called by the user via ioctl. | |
528 | * | |
529 | * Returns: | |
530 | * Zero on success, negative errno on failure. | |
531 | */ | |
532 | int drm_mode_dirtyfb_ioctl(struct drm_device *dev, | |
533 | void *data, struct drm_file *file_priv) | |
534 | { | |
535 | struct drm_clip_rect __user *clips_ptr; | |
536 | struct drm_clip_rect *clips = NULL; | |
537 | struct drm_mode_fb_dirty_cmd *r = data; | |
538 | struct drm_framebuffer *fb; | |
539 | unsigned flags; | |
540 | int num_clips; | |
541 | int ret; | |
542 | ||
543 | if (!drm_core_check_feature(dev, DRIVER_MODESET)) | |
544 | return -EINVAL; | |
545 | ||
418da172 | 546 | fb = drm_framebuffer_lookup(dev, file_priv, r->fb_id); |
7520a277 DV |
547 | if (!fb) |
548 | return -ENOENT; | |
549 | ||
550 | num_clips = r->num_clips; | |
551 | clips_ptr = (struct drm_clip_rect __user *)(unsigned long)r->clips_ptr; | |
552 | ||
553 | if (!num_clips != !clips_ptr) { | |
554 | ret = -EINVAL; | |
555 | goto out_err1; | |
556 | } | |
557 | ||
558 | flags = DRM_MODE_FB_DIRTY_FLAGS & r->flags; | |
559 | ||
560 | /* If userspace annotates copy, clips must come in pairs */ | |
561 | if (flags & DRM_MODE_FB_DIRTY_ANNOTATE_COPY && (num_clips % 2)) { | |
562 | ret = -EINVAL; | |
563 | goto out_err1; | |
564 | } | |
565 | ||
566 | if (num_clips && clips_ptr) { | |
567 | if (num_clips < 0 || num_clips > DRM_MODE_FB_DIRTY_MAX_CLIPS) { | |
568 | ret = -EINVAL; | |
569 | goto out_err1; | |
570 | } | |
571 | clips = kcalloc(num_clips, sizeof(*clips), GFP_KERNEL); | |
572 | if (!clips) { | |
573 | ret = -ENOMEM; | |
574 | goto out_err1; | |
575 | } | |
576 | ||
577 | ret = copy_from_user(clips, clips_ptr, | |
578 | num_clips * sizeof(*clips)); | |
579 | if (ret) { | |
580 | ret = -EFAULT; | |
581 | goto out_err2; | |
582 | } | |
583 | } | |
584 | ||
585 | if (fb->funcs->dirty) { | |
586 | ret = fb->funcs->dirty(fb, file_priv, flags, r->color, | |
587 | clips, num_clips); | |
588 | } else { | |
589 | ret = -ENOSYS; | |
590 | } | |
591 | ||
592 | out_err2: | |
593 | kfree(clips); | |
594 | out_err1: | |
a4a69da0 | 595 | drm_framebuffer_put(fb); |
7520a277 DV |
596 | |
597 | return ret; | |
598 | } | |
599 | ||
600 | /** | |
601 | * drm_fb_release - remove and free the FBs on this file | |
602 | * @priv: drm file for the ioctl | |
603 | * | |
604 | * Destroy all the FBs associated with @filp. | |
605 | * | |
606 | * Called by the user via ioctl. | |
607 | * | |
608 | * Returns: | |
609 | * Zero on success, negative errno on failure. | |
610 | */ | |
611 | void drm_fb_release(struct drm_file *priv) | |
612 | { | |
613 | struct drm_framebuffer *fb, *tfb; | |
614 | struct drm_mode_rmfb_work arg; | |
615 | ||
616 | INIT_LIST_HEAD(&arg.fbs); | |
617 | ||
618 | /* | |
619 | * When the file gets released that means no one else can access the fb | |
620 | * list any more, so no need to grab fpriv->fbs_lock. And we need to | |
621 | * avoid upsetting lockdep since the universal cursor code adds a | |
622 | * framebuffer while holding mutex locks. | |
623 | * | |
624 | * Note that a real deadlock between fpriv->fbs_lock and the modeset | |
625 | * locks is impossible here since no one else but this function can get | |
626 | * at it any more. | |
627 | */ | |
628 | list_for_each_entry_safe(fb, tfb, &priv->fbs, filp_head) { | |
629 | if (drm_framebuffer_read_refcount(fb) > 1) { | |
630 | list_move_tail(&fb->filp_head, &arg.fbs); | |
631 | } else { | |
632 | list_del_init(&fb->filp_head); | |
633 | ||
634 | /* This drops the fpriv->fbs reference. */ | |
a4a69da0 | 635 | drm_framebuffer_put(fb); |
7520a277 DV |
636 | } |
637 | } | |
638 | ||
639 | if (!list_empty(&arg.fbs)) { | |
640 | INIT_WORK_ONSTACK(&arg.work, drm_mode_rmfb_work_fn); | |
641 | ||
642 | schedule_work(&arg.work); | |
643 | flush_work(&arg.work); | |
644 | destroy_work_on_stack(&arg.work); | |
645 | } | |
646 | } | |
647 | ||
648 | void drm_framebuffer_free(struct kref *kref) | |
649 | { | |
650 | struct drm_framebuffer *fb = | |
651 | container_of(kref, struct drm_framebuffer, base.refcount); | |
652 | struct drm_device *dev = fb->dev; | |
653 | ||
654 | /* | |
655 | * The lookup idr holds a weak reference, which has not necessarily been | |
656 | * removed at this point. Check for that. | |
657 | */ | |
658 | drm_mode_object_unregister(dev, &fb->base); | |
659 | ||
660 | fb->funcs->destroy(fb); | |
661 | } | |
662 | ||
663 | /** | |
664 | * drm_framebuffer_init - initialize a framebuffer | |
665 | * @dev: DRM device | |
666 | * @fb: framebuffer to be initialized | |
667 | * @funcs: ... with these functions | |
668 | * | |
669 | * Allocates an ID for the framebuffer's parent mode object, sets its mode | |
670 | * functions & device file and adds it to the master fd list. | |
671 | * | |
672 | * IMPORTANT: | |
673 | * This functions publishes the fb and makes it available for concurrent access | |
674 | * by other users. Which means by this point the fb _must_ be fully set up - | |
675 | * since all the fb attributes are invariant over its lifetime, no further | |
676 | * locking but only correct reference counting is required. | |
677 | * | |
678 | * Returns: | |
679 | * Zero on success, error code on failure. | |
680 | */ | |
681 | int drm_framebuffer_init(struct drm_device *dev, struct drm_framebuffer *fb, | |
682 | const struct drm_framebuffer_funcs *funcs) | |
683 | { | |
684 | int ret; | |
685 | ||
570cec32 | 686 | if (WARN_ON_ONCE(fb->dev != dev || !fb->format)) |
95bce760 VS |
687 | return -EINVAL; |
688 | ||
7520a277 | 689 | INIT_LIST_HEAD(&fb->filp_head); |
95bce760 | 690 | |
7520a277 | 691 | fb->funcs = funcs; |
8d44e9e6 | 692 | strcpy(fb->comm, current->comm); |
7520a277 | 693 | |
2135ea7a TR |
694 | ret = __drm_mode_object_add(dev, &fb->base, DRM_MODE_OBJECT_FB, |
695 | false, drm_framebuffer_free); | |
7520a277 DV |
696 | if (ret) |
697 | goto out; | |
698 | ||
699 | mutex_lock(&dev->mode_config.fb_lock); | |
700 | dev->mode_config.num_fb++; | |
701 | list_add(&fb->head, &dev->mode_config.fb_list); | |
702 | mutex_unlock(&dev->mode_config.fb_lock); | |
703 | ||
704 | drm_mode_object_register(dev, &fb->base); | |
705 | out: | |
706 | return ret; | |
707 | } | |
708 | EXPORT_SYMBOL(drm_framebuffer_init); | |
709 | ||
710 | /** | |
711 | * drm_framebuffer_lookup - look up a drm framebuffer and grab a reference | |
712 | * @dev: drm device | |
e7e62c7e | 713 | * @file_priv: drm file to check for lease against. |
7520a277 DV |
714 | * @id: id of the fb object |
715 | * | |
716 | * If successful, this grabs an additional reference to the framebuffer - | |
717 | * callers need to make sure to eventually unreference the returned framebuffer | |
a4a69da0 | 718 | * again, using drm_framebuffer_put(). |
7520a277 DV |
719 | */ |
720 | struct drm_framebuffer *drm_framebuffer_lookup(struct drm_device *dev, | |
418da172 | 721 | struct drm_file *file_priv, |
7520a277 DV |
722 | uint32_t id) |
723 | { | |
724 | struct drm_mode_object *obj; | |
725 | struct drm_framebuffer *fb = NULL; | |
726 | ||
418da172 | 727 | obj = __drm_mode_object_find(dev, file_priv, id, DRM_MODE_OBJECT_FB); |
7520a277 DV |
728 | if (obj) |
729 | fb = obj_to_fb(obj); | |
730 | return fb; | |
731 | } | |
732 | EXPORT_SYMBOL(drm_framebuffer_lookup); | |
733 | ||
734 | /** | |
735 | * drm_framebuffer_unregister_private - unregister a private fb from the lookup idr | |
736 | * @fb: fb to unregister | |
737 | * | |
738 | * Drivers need to call this when cleaning up driver-private framebuffers, e.g. | |
739 | * those used for fbdev. Note that the caller must hold a reference of it's own, | |
740 | * i.e. the object may not be destroyed through this call (since it'll lead to a | |
741 | * locking inversion). | |
03e93ac7 RZ |
742 | * |
743 | * NOTE: This function is deprecated. For driver-private framebuffers it is not | |
744 | * recommended to embed a framebuffer struct info fbdev struct, instead, a | |
a4a69da0 TR |
745 | * framebuffer pointer is preferred and drm_framebuffer_put() should be called |
746 | * when the framebuffer is to be cleaned up. | |
7520a277 DV |
747 | */ |
748 | void drm_framebuffer_unregister_private(struct drm_framebuffer *fb) | |
749 | { | |
750 | struct drm_device *dev; | |
751 | ||
752 | if (!fb) | |
753 | return; | |
754 | ||
755 | dev = fb->dev; | |
756 | ||
757 | /* Mark fb as reaped and drop idr ref. */ | |
758 | drm_mode_object_unregister(dev, &fb->base); | |
759 | } | |
760 | EXPORT_SYMBOL(drm_framebuffer_unregister_private); | |
761 | ||
762 | /** | |
763 | * drm_framebuffer_cleanup - remove a framebuffer object | |
764 | * @fb: framebuffer to remove | |
765 | * | |
766 | * Cleanup framebuffer. This function is intended to be used from the drivers | |
d574528a DV |
767 | * &drm_framebuffer_funcs.destroy callback. It can also be used to clean up |
768 | * driver private framebuffers embedded into a larger structure. | |
7520a277 | 769 | * |
d574528a | 770 | * Note that this function does not remove the fb from active usage - if it is |
7520a277 DV |
771 | * still used anywhere, hilarity can ensue since userspace could call getfb on |
772 | * the id and get back -EINVAL. Obviously no concern at driver unload time. | |
773 | * | |
774 | * Also, the framebuffer will not be removed from the lookup idr - for | |
775 | * user-created framebuffers this will happen in in the rmfb ioctl. For | |
776 | * driver-private objects (e.g. for fbdev) drivers need to explicitly call | |
777 | * drm_framebuffer_unregister_private. | |
778 | */ | |
779 | void drm_framebuffer_cleanup(struct drm_framebuffer *fb) | |
780 | { | |
781 | struct drm_device *dev = fb->dev; | |
782 | ||
783 | mutex_lock(&dev->mode_config.fb_lock); | |
784 | list_del(&fb->head); | |
785 | dev->mode_config.num_fb--; | |
786 | mutex_unlock(&dev->mode_config.fb_lock); | |
787 | } | |
788 | EXPORT_SYMBOL(drm_framebuffer_cleanup); | |
789 | ||
941b8caa DV |
790 | static int atomic_remove_fb(struct drm_framebuffer *fb) |
791 | { | |
792 | struct drm_modeset_acquire_ctx ctx; | |
793 | struct drm_device *dev = fb->dev; | |
794 | struct drm_atomic_state *state; | |
795 | struct drm_plane *plane; | |
796 | struct drm_connector *conn; | |
797 | struct drm_connector_state *conn_state; | |
846c7dfc | 798 | int i, ret; |
941b8caa | 799 | unsigned plane_mask; |
846c7dfc | 800 | bool disable_crtcs = false; |
941b8caa | 801 | |
846c7dfc | 802 | retry_disable: |
941b8caa | 803 | drm_modeset_acquire_init(&ctx, 0); |
846c7dfc ML |
804 | |
805 | state = drm_atomic_state_alloc(dev); | |
806 | if (!state) { | |
807 | ret = -ENOMEM; | |
808 | goto out; | |
809 | } | |
941b8caa DV |
810 | state->acquire_ctx = &ctx; |
811 | ||
812 | retry: | |
813 | plane_mask = 0; | |
814 | ret = drm_modeset_lock_all_ctx(dev, &ctx); | |
815 | if (ret) | |
816 | goto unlock; | |
817 | ||
818 | drm_for_each_plane(plane, dev) { | |
819 | struct drm_plane_state *plane_state; | |
820 | ||
821 | if (plane->state->fb != fb) | |
822 | continue; | |
823 | ||
824 | plane_state = drm_atomic_get_plane_state(state, plane); | |
825 | if (IS_ERR(plane_state)) { | |
826 | ret = PTR_ERR(plane_state); | |
827 | goto unlock; | |
828 | } | |
829 | ||
846c7dfc | 830 | if (disable_crtcs && plane_state->crtc->primary == plane) { |
941b8caa DV |
831 | struct drm_crtc_state *crtc_state; |
832 | ||
833 | crtc_state = drm_atomic_get_existing_crtc_state(state, plane_state->crtc); | |
834 | ||
835 | ret = drm_atomic_add_affected_connectors(state, plane_state->crtc); | |
836 | if (ret) | |
837 | goto unlock; | |
838 | ||
839 | crtc_state->active = false; | |
840 | ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL); | |
841 | if (ret) | |
842 | goto unlock; | |
843 | } | |
844 | ||
845 | drm_atomic_set_fb_for_plane(plane_state, NULL); | |
846 | ret = drm_atomic_set_crtc_for_plane(plane_state, NULL); | |
847 | if (ret) | |
848 | goto unlock; | |
849 | ||
850 | plane_mask |= BIT(drm_plane_index(plane)); | |
941b8caa DV |
851 | } |
852 | ||
846c7dfc | 853 | /* This list is only filled when disable_crtcs is set. */ |
0c3eb123 | 854 | for_each_new_connector_in_state(state, conn, conn_state, i) { |
941b8caa DV |
855 | ret = drm_atomic_set_crtc_for_connector(conn_state, NULL); |
856 | ||
857 | if (ret) | |
858 | goto unlock; | |
859 | } | |
860 | ||
861 | if (plane_mask) | |
862 | ret = drm_atomic_commit(state); | |
863 | ||
864 | unlock: | |
941b8caa | 865 | if (ret == -EDEADLK) { |
4086d90c | 866 | drm_atomic_state_clear(state); |
941b8caa DV |
867 | drm_modeset_backoff(&ctx); |
868 | goto retry; | |
869 | } | |
870 | ||
871 | drm_atomic_state_put(state); | |
872 | ||
846c7dfc | 873 | out: |
941b8caa DV |
874 | drm_modeset_drop_locks(&ctx); |
875 | drm_modeset_acquire_fini(&ctx); | |
876 | ||
846c7dfc ML |
877 | if (ret == -EINVAL && !disable_crtcs) { |
878 | disable_crtcs = true; | |
879 | goto retry_disable; | |
880 | } | |
881 | ||
941b8caa DV |
882 | return ret; |
883 | } | |
884 | ||
885 | static void legacy_remove_fb(struct drm_framebuffer *fb) | |
886 | { | |
887 | struct drm_device *dev = fb->dev; | |
888 | struct drm_crtc *crtc; | |
889 | struct drm_plane *plane; | |
890 | ||
891 | drm_modeset_lock_all(dev); | |
892 | /* remove from any CRTC */ | |
893 | drm_for_each_crtc(crtc, dev) { | |
894 | if (crtc->primary->fb == fb) { | |
895 | /* should turn off the crtc */ | |
896 | if (drm_crtc_force_disable(crtc)) | |
897 | DRM_ERROR("failed to reset crtc %p when fb was deleted\n", crtc); | |
898 | } | |
899 | } | |
900 | ||
901 | drm_for_each_plane(plane, dev) { | |
902 | if (plane->fb == fb) | |
903 | drm_plane_force_disable(plane); | |
904 | } | |
905 | drm_modeset_unlock_all(dev); | |
906 | } | |
907 | ||
7520a277 DV |
908 | /** |
909 | * drm_framebuffer_remove - remove and unreference a framebuffer object | |
910 | * @fb: framebuffer to remove | |
911 | * | |
912 | * Scans all the CRTCs and planes in @dev's mode_config. If they're | |
913 | * using @fb, removes it, setting it to NULL. Then drops the reference to the | |
914 | * passed-in framebuffer. Might take the modeset locks. | |
915 | * | |
916 | * Note that this function optimizes the cleanup away if the caller holds the | |
917 | * last reference to the framebuffer. It is also guaranteed to not take the | |
918 | * modeset locks in this case. | |
919 | */ | |
920 | void drm_framebuffer_remove(struct drm_framebuffer *fb) | |
921 | { | |
922 | struct drm_device *dev; | |
7520a277 DV |
923 | |
924 | if (!fb) | |
925 | return; | |
926 | ||
927 | dev = fb->dev; | |
928 | ||
929 | WARN_ON(!list_empty(&fb->filp_head)); | |
930 | ||
931 | /* | |
932 | * drm ABI mandates that we remove any deleted framebuffers from active | |
933 | * useage. But since most sane clients only remove framebuffers they no | |
934 | * longer need, try to optimize this away. | |
935 | * | |
936 | * Since we're holding a reference ourselves, observing a refcount of 1 | |
937 | * means that we're the last holder and can skip it. Also, the refcount | |
938 | * can never increase from 1 again, so we don't need any barriers or | |
939 | * locks. | |
940 | * | |
941 | * Note that userspace could try to race with use and instate a new | |
942 | * usage _after_ we've cleared all current ones. End result will be an | |
943 | * in-use fb with fb-id == 0. Userspace is allowed to shoot its own foot | |
944 | * in this manner. | |
945 | */ | |
946 | if (drm_framebuffer_read_refcount(fb) > 1) { | |
db8f6403 | 947 | if (drm_drv_uses_atomic_modeset(dev)) { |
941b8caa | 948 | int ret = atomic_remove_fb(fb); |
db8f6403 | 949 | WARN(ret, "atomic remove_fb failed with %i\n", ret); |
941b8caa DV |
950 | } else |
951 | legacy_remove_fb(fb); | |
7520a277 DV |
952 | } |
953 | ||
a4a69da0 | 954 | drm_framebuffer_put(fb); |
7520a277 DV |
955 | } |
956 | EXPORT_SYMBOL(drm_framebuffer_remove); | |
8f8f6a6c VS |
957 | |
958 | /** | |
959 | * drm_framebuffer_plane_width - width of the plane given the first plane | |
960 | * @width: width of the first plane | |
961 | * @fb: the framebuffer | |
962 | * @plane: plane index | |
963 | * | |
964 | * Returns: | |
965 | * The width of @plane, given that the width of the first plane is @width. | |
966 | */ | |
967 | int drm_framebuffer_plane_width(int width, | |
968 | const struct drm_framebuffer *fb, int plane) | |
969 | { | |
970 | if (plane >= fb->format->num_planes) | |
971 | return 0; | |
972 | ||
568c5e45 | 973 | return fb_plane_width(width, fb->format, plane); |
8f8f6a6c VS |
974 | } |
975 | EXPORT_SYMBOL(drm_framebuffer_plane_width); | |
976 | ||
977 | /** | |
978 | * drm_framebuffer_plane_height - height of the plane given the first plane | |
979 | * @height: height of the first plane | |
980 | * @fb: the framebuffer | |
981 | * @plane: plane index | |
982 | * | |
983 | * Returns: | |
984 | * The height of @plane, given that the height of the first plane is @height. | |
985 | */ | |
986 | int drm_framebuffer_plane_height(int height, | |
987 | const struct drm_framebuffer *fb, int plane) | |
988 | { | |
989 | if (plane >= fb->format->num_planes) | |
990 | return 0; | |
991 | ||
568c5e45 | 992 | return fb_plane_height(height, fb->format, plane); |
8f8f6a6c VS |
993 | } |
994 | EXPORT_SYMBOL(drm_framebuffer_plane_height); | |
45d58b40 NT |
995 | |
996 | void drm_framebuffer_print_info(struct drm_printer *p, unsigned int indent, | |
997 | const struct drm_framebuffer *fb) | |
998 | { | |
999 | struct drm_format_name_buf format_name; | |
1000 | unsigned int i; | |
1001 | ||
8d44e9e6 | 1002 | drm_printf_indent(p, indent, "allocated by = %s\n", fb->comm); |
45d58b40 NT |
1003 | drm_printf_indent(p, indent, "refcount=%u\n", |
1004 | drm_framebuffer_read_refcount(fb)); | |
1005 | drm_printf_indent(p, indent, "format=%s\n", | |
1006 | drm_get_format_name(fb->format->format, &format_name)); | |
1007 | drm_printf_indent(p, indent, "modifier=0x%llx\n", fb->modifier); | |
1008 | drm_printf_indent(p, indent, "size=%ux%u\n", fb->width, fb->height); | |
1009 | drm_printf_indent(p, indent, "layers:\n"); | |
1010 | ||
1011 | for (i = 0; i < fb->format->num_planes; i++) { | |
1012 | drm_printf_indent(p, indent + 1, "size[%u]=%dx%d\n", i, | |
1013 | drm_framebuffer_plane_width(fb->width, fb, i), | |
1014 | drm_framebuffer_plane_height(fb->height, fb, i)); | |
1015 | drm_printf_indent(p, indent + 1, "pitch[%u]=%u\n", i, fb->pitches[i]); | |
1016 | drm_printf_indent(p, indent + 1, "offset[%u]=%u\n", i, fb->offsets[i]); | |
1017 | drm_printf_indent(p, indent + 1, "obj[%u]:%s\n", i, | |
1018 | fb->obj[i] ? "" : "(null)"); | |
1019 | if (fb->obj[i]) | |
1020 | drm_gem_print_info(p, indent + 2, fb->obj[i]); | |
1021 | } | |
1022 | } | |
1023 | ||
1024 | #ifdef CONFIG_DEBUG_FS | |
1025 | static int drm_framebuffer_info(struct seq_file *m, void *data) | |
1026 | { | |
1027 | struct drm_info_node *node = m->private; | |
1028 | struct drm_device *dev = node->minor->dev; | |
1029 | struct drm_printer p = drm_seq_file_printer(m); | |
1030 | struct drm_framebuffer *fb; | |
1031 | ||
1032 | mutex_lock(&dev->mode_config.fb_lock); | |
1033 | drm_for_each_fb(fb, dev) { | |
1034 | drm_printf(&p, "framebuffer[%u]:\n", fb->base.id); | |
1035 | drm_framebuffer_print_info(&p, 1, fb); | |
1036 | } | |
1037 | mutex_unlock(&dev->mode_config.fb_lock); | |
1038 | ||
1039 | return 0; | |
1040 | } | |
1041 | ||
1042 | static const struct drm_info_list drm_framebuffer_debugfs_list[] = { | |
1043 | { "framebuffer", drm_framebuffer_info, 0 }, | |
1044 | }; | |
1045 | ||
1046 | int drm_framebuffer_debugfs_init(struct drm_minor *minor) | |
1047 | { | |
1048 | return drm_debugfs_create_files(drm_framebuffer_debugfs_list, | |
1049 | ARRAY_SIZE(drm_framebuffer_debugfs_list), | |
1050 | minor->debugfs_root, minor); | |
1051 | } | |
1052 | #endif |