]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/gpu/drm/drm_plane.c
drm: Add acquire ctx parameter to ->update_plane
[mirror_ubuntu-bionic-kernel.git] / drivers / gpu / drm / drm_plane.c
CommitLineData
43968d7b
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 <drm/drmP.h>
24#include <drm/drm_plane.h>
25
26#include "drm_crtc_internal.h"
27
532b3671
DV
28/**
29 * DOC: overview
30 *
31 * A plane represents an image source that can be blended with or overlayed on
32 * top of a CRTC during the scanout process. Planes take their input data from a
33 * &drm_framebuffer object. The plane itself specifies the cropping and scaling
34 * of that image, and where it is placed on the visible are of a display
35 * pipeline, represented by &drm_crtc. A plane can also have additional
36 * properties that specify how the pixels are positioned and blended, like
37 * rotation or Z-position. All these properties are stored in &drm_plane_state.
38 *
39 * To create a plane, a KMS drivers allocates and zeroes an instances of
ea0dd85a 40 * &struct drm_plane (possibly as part of a larger structure) and registers it
532b3671
DV
41 * with a call to drm_universal_plane_init().
42 *
43 * Cursor and overlay planes are optional. All drivers should provide one
44 * primary plane per CRTC to avoid surprising userspace too much. See enum
d574528a 45 * drm_plane_type for a more in-depth discussion of these special uapi-relevant
532b3671
DV
46 * plane types. Special planes are associated with their CRTC by calling
47 * drm_crtc_init_with_planes().
1e4d84c6
DV
48 *
49 * The type of a plane is exposed in the immutable "type" enumeration property,
50 * which has one of the following values: "Overlay", "Primary", "Cursor".
532b3671
DV
51 */
52
43968d7b
DV
53static unsigned int drm_num_planes(struct drm_device *dev)
54{
55 unsigned int num = 0;
56 struct drm_plane *tmp;
57
58 drm_for_each_plane(tmp, dev) {
59 num++;
60 }
61
62 return num;
63}
64
65/**
66 * drm_universal_plane_init - Initialize a new universal plane object
67 * @dev: DRM device
68 * @plane: plane object to init
69 * @possible_crtcs: bitmask of possible CRTCs
70 * @funcs: callbacks for the new plane
71 * @formats: array of supported formats (DRM_FORMAT\_\*)
72 * @format_count: number of elements in @formats
73 * @type: type of plane (overlay, primary, cursor)
74 * @name: printf style format string for the plane name, or NULL for default name
75 *
76 * Initializes a plane object of type @type.
77 *
78 * Returns:
79 * Zero on success, error code on failure.
80 */
81int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
5cd57a46 82 uint32_t possible_crtcs,
43968d7b
DV
83 const struct drm_plane_funcs *funcs,
84 const uint32_t *formats, unsigned int format_count,
85 enum drm_plane_type type,
86 const char *name, ...)
87{
88 struct drm_mode_config *config = &dev->mode_config;
89 int ret;
90
2135ea7a 91 ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
43968d7b
DV
92 if (ret)
93 return ret;
94
95 drm_modeset_lock_init(&plane->mutex);
96
97 plane->base.properties = &plane->properties;
98 plane->dev = dev;
99 plane->funcs = funcs;
100 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
101 GFP_KERNEL);
102 if (!plane->format_types) {
103 DRM_DEBUG_KMS("out of memory when allocating plane\n");
104 drm_mode_object_unregister(dev, &plane->base);
105 return -ENOMEM;
106 }
107
108 if (name) {
109 va_list ap;
110
111 va_start(ap, name);
112 plane->name = kvasprintf(GFP_KERNEL, name, ap);
113 va_end(ap);
114 } else {
115 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
116 drm_num_planes(dev));
117 }
118 if (!plane->name) {
119 kfree(plane->format_types);
120 drm_mode_object_unregister(dev, &plane->base);
121 return -ENOMEM;
122 }
123
124 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
125 plane->format_count = format_count;
126 plane->possible_crtcs = possible_crtcs;
127 plane->type = type;
128
129 list_add_tail(&plane->head, &config->plane_list);
130 plane->index = config->num_total_plane++;
131 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
132 config->num_overlay_plane++;
133
134 drm_object_attach_property(&plane->base,
135 config->plane_type_property,
136 plane->type);
137
138 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
139 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
96260142 140 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
43968d7b
DV
141 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
142 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
143 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
144 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
145 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
146 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
147 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
148 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
149 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
150 }
151
152 return 0;
153}
154EXPORT_SYMBOL(drm_universal_plane_init);
155
156int drm_plane_register_all(struct drm_device *dev)
157{
158 struct drm_plane *plane;
159 int ret = 0;
160
161 drm_for_each_plane(plane, dev) {
162 if (plane->funcs->late_register)
163 ret = plane->funcs->late_register(plane);
164 if (ret)
165 return ret;
166 }
167
168 return 0;
169}
170
171void drm_plane_unregister_all(struct drm_device *dev)
172{
173 struct drm_plane *plane;
174
175 drm_for_each_plane(plane, dev) {
176 if (plane->funcs->early_unregister)
177 plane->funcs->early_unregister(plane);
178 }
179}
180
181/**
182 * drm_plane_init - Initialize a legacy plane
183 * @dev: DRM device
184 * @plane: plane object to init
185 * @possible_crtcs: bitmask of possible CRTCs
186 * @funcs: callbacks for the new plane
187 * @formats: array of supported formats (DRM_FORMAT\_\*)
188 * @format_count: number of elements in @formats
189 * @is_primary: plane type (primary vs overlay)
190 *
191 * Legacy API to initialize a DRM plane.
192 *
193 * New drivers should call drm_universal_plane_init() instead.
194 *
195 * Returns:
196 * Zero on success, error code on failure.
197 */
198int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
5cd57a46 199 uint32_t possible_crtcs,
43968d7b
DV
200 const struct drm_plane_funcs *funcs,
201 const uint32_t *formats, unsigned int format_count,
202 bool is_primary)
203{
204 enum drm_plane_type type;
205
206 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
207 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
208 formats, format_count, type, NULL);
209}
210EXPORT_SYMBOL(drm_plane_init);
211
212/**
213 * drm_plane_cleanup - Clean up the core plane usage
214 * @plane: plane to cleanup
215 *
216 * This function cleans up @plane and removes it from the DRM mode setting
217 * core. Note that the function does *not* free the plane structure itself,
218 * this is the responsibility of the caller.
219 */
220void drm_plane_cleanup(struct drm_plane *plane)
221{
222 struct drm_device *dev = plane->dev;
223
661a3755
DV
224 drm_modeset_lock_fini(&plane->mutex);
225
43968d7b
DV
226 kfree(plane->format_types);
227 drm_mode_object_unregister(dev, &plane->base);
228
229 BUG_ON(list_empty(&plane->head));
230
231 /* Note that the plane_list is considered to be static; should we
232 * remove the drm_plane at runtime we would have to decrement all
233 * the indices on the drm_plane after us in the plane_list.
234 */
235
236 list_del(&plane->head);
237 dev->mode_config.num_total_plane--;
238 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
239 dev->mode_config.num_overlay_plane--;
43968d7b
DV
240
241 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
242 if (plane->state && plane->funcs->atomic_destroy_state)
243 plane->funcs->atomic_destroy_state(plane, plane->state);
244
245 kfree(plane->name);
246
247 memset(plane, 0, sizeof(*plane));
248}
249EXPORT_SYMBOL(drm_plane_cleanup);
250
251/**
252 * drm_plane_from_index - find the registered plane at an index
253 * @dev: DRM device
254 * @idx: index of registered plane to find for
255 *
256 * Given a plane index, return the registered plane from DRM device's
931c670d 257 * list of planes with matching index. This is the inverse of drm_plane_index().
43968d7b
DV
258 */
259struct drm_plane *
260drm_plane_from_index(struct drm_device *dev, int idx)
261{
262 struct drm_plane *plane;
263
264 drm_for_each_plane(plane, dev)
265 if (idx == plane->index)
266 return plane;
267
268 return NULL;
269}
270EXPORT_SYMBOL(drm_plane_from_index);
271
272/**
273 * drm_plane_force_disable - Forcibly disable a plane
274 * @plane: plane to disable
275 *
276 * Forces the plane to be disabled.
277 *
278 * Used when the plane's current framebuffer is destroyed,
279 * and when restoring fbdev mode.
280 */
281void drm_plane_force_disable(struct drm_plane *plane)
282{
283 int ret;
284
285 if (!plane->fb)
286 return;
287
288 plane->old_fb = plane->fb;
289 ret = plane->funcs->disable_plane(plane);
290 if (ret) {
291 DRM_ERROR("failed to disable plane with busy fb\n");
292 plane->old_fb = NULL;
293 return;
294 }
295 /* disconnect the plane from the fb and crtc: */
a4a69da0 296 drm_framebuffer_put(plane->old_fb);
43968d7b
DV
297 plane->old_fb = NULL;
298 plane->fb = NULL;
299 plane->crtc = NULL;
300}
301EXPORT_SYMBOL(drm_plane_force_disable);
302
303/**
304 * drm_mode_plane_set_obj_prop - set the value of a property
305 * @plane: drm plane object to set property value for
306 * @property: property to set
307 * @value: value the property should be set to
308 *
309 * This functions sets a given property on a given plane object. This function
310 * calls the driver's ->set_property callback and changes the software state of
311 * the property if the callback succeeds.
312 *
313 * Returns:
314 * Zero on success, error code on failure.
315 */
316int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
317 struct drm_property *property,
318 uint64_t value)
319{
320 int ret = -EINVAL;
321 struct drm_mode_object *obj = &plane->base;
322
323 if (plane->funcs->set_property)
324 ret = plane->funcs->set_property(plane, property, value);
325 if (!ret)
326 drm_object_property_set_value(obj, property, value);
327
328 return ret;
329}
330EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
331
43968d7b
DV
332int drm_mode_getplane_res(struct drm_device *dev, void *data,
333 struct drm_file *file_priv)
334{
335 struct drm_mode_get_plane_res *plane_resp = data;
336 struct drm_mode_config *config;
337 struct drm_plane *plane;
338 uint32_t __user *plane_ptr;
339 int copied = 0;
340 unsigned num_planes;
341
342 if (!drm_core_check_feature(dev, DRIVER_MODESET))
343 return -EINVAL;
344
345 config = &dev->mode_config;
346
347 if (file_priv->universal_planes)
348 num_planes = config->num_total_plane;
349 else
350 num_planes = config->num_overlay_plane;
351
352 /*
353 * This ioctl is called twice, once to determine how much space is
354 * needed, and the 2nd time to fill it.
355 */
356 if (num_planes &&
357 (plane_resp->count_planes >= num_planes)) {
358 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
359
360 /* Plane lists are invariant, no locking needed. */
361 drm_for_each_plane(plane, dev) {
362 /*
363 * Unless userspace set the 'universal planes'
364 * capability bit, only advertise overlays.
365 */
366 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
367 !file_priv->universal_planes)
368 continue;
369
370 if (put_user(plane->base.id, plane_ptr + copied))
371 return -EFAULT;
372 copied++;
373 }
374 }
375 plane_resp->count_planes = num_planes;
376
377 return 0;
378}
379
43968d7b
DV
380int drm_mode_getplane(struct drm_device *dev, void *data,
381 struct drm_file *file_priv)
382{
383 struct drm_mode_get_plane *plane_resp = data;
384 struct drm_plane *plane;
385 uint32_t __user *format_ptr;
386
387 if (!drm_core_check_feature(dev, DRIVER_MODESET))
388 return -EINVAL;
389
390 plane = drm_plane_find(dev, plane_resp->plane_id);
391 if (!plane)
392 return -ENOENT;
393
394 drm_modeset_lock(&plane->mutex, NULL);
de7b6be7
DS
395 if (plane->state && plane->state->crtc)
396 plane_resp->crtc_id = plane->state->crtc->base.id;
397 else if (!plane->state && plane->crtc)
43968d7b
DV
398 plane_resp->crtc_id = plane->crtc->base.id;
399 else
400 plane_resp->crtc_id = 0;
401
de7b6be7
DS
402 if (plane->state && plane->state->fb)
403 plane_resp->fb_id = plane->state->fb->base.id;
404 else if (!plane->state && plane->fb)
43968d7b
DV
405 plane_resp->fb_id = plane->fb->base.id;
406 else
407 plane_resp->fb_id = 0;
408 drm_modeset_unlock(&plane->mutex);
409
410 plane_resp->plane_id = plane->base.id;
411 plane_resp->possible_crtcs = plane->possible_crtcs;
412 plane_resp->gamma_size = 0;
413
414 /*
415 * This ioctl is called twice, once to determine how much space is
416 * needed, and the 2nd time to fill it.
417 */
418 if (plane->format_count &&
419 (plane_resp->count_format_types >= plane->format_count)) {
420 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
421 if (copy_to_user(format_ptr,
422 plane->format_types,
423 sizeof(uint32_t) * plane->format_count)) {
424 return -EFAULT;
425 }
426 }
427 plane_resp->count_format_types = plane->format_count;
428
429 return 0;
430}
431
43968d7b
DV
432int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
433{
434 unsigned int i;
435
436 for (i = 0; i < plane->format_count; i++) {
437 if (format == plane->format_types[i])
438 return 0;
439 }
440
441 return -EINVAL;
442}
443
444/*
445 * setplane_internal - setplane handler for internal callers
446 *
447 * Note that we assume an extra reference has already been taken on fb. If the
448 * update fails, this reference will be dropped before return; if it succeeds,
449 * the previous framebuffer (if any) will be unreferenced instead.
450 *
451 * src_{x,y,w,h} are provided in 16.16 fixed point format
452 */
453static int __setplane_internal(struct drm_plane *plane,
454 struct drm_crtc *crtc,
455 struct drm_framebuffer *fb,
456 int32_t crtc_x, int32_t crtc_y,
457 uint32_t crtc_w, uint32_t crtc_h,
458 /* src_{x,y,w,h} values are 16.16 fixed point */
459 uint32_t src_x, uint32_t src_y,
232e8f70
DV
460 uint32_t src_w, uint32_t src_h,
461 struct drm_modeset_acquire_ctx *ctx)
43968d7b
DV
462{
463 int ret = 0;
464
465 /* No fb means shut it down */
466 if (!fb) {
467 plane->old_fb = plane->fb;
468 ret = plane->funcs->disable_plane(plane);
469 if (!ret) {
470 plane->crtc = NULL;
471 plane->fb = NULL;
472 } else {
473 plane->old_fb = NULL;
474 }
475 goto out;
476 }
477
478 /* Check whether this plane is usable on this CRTC */
479 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
480 DRM_DEBUG_KMS("Invalid crtc for plane\n");
481 ret = -EINVAL;
482 goto out;
483 }
484
485 /* Check whether this plane supports the fb pixel format. */
438b74a5 486 ret = drm_plane_check_pixel_format(plane, fb->format->format);
43968d7b 487 if (ret) {
b3c11ac2
EE
488 struct drm_format_name_buf format_name;
489 DRM_DEBUG_KMS("Invalid pixel format %s\n",
438b74a5 490 drm_get_format_name(fb->format->format,
b3c11ac2 491 &format_name));
43968d7b
DV
492 goto out;
493 }
494
495 /* Give drivers some help against integer overflows */
496 if (crtc_w > INT_MAX ||
497 crtc_x > INT_MAX - (int32_t) crtc_w ||
498 crtc_h > INT_MAX ||
499 crtc_y > INT_MAX - (int32_t) crtc_h) {
500 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
501 crtc_w, crtc_h, crtc_x, crtc_y);
502 ret = -ERANGE;
503 goto out;
504 }
505
506 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
507 if (ret)
508 goto out;
509
510 plane->old_fb = plane->fb;
511 ret = plane->funcs->update_plane(plane, crtc, fb,
512 crtc_x, crtc_y, crtc_w, crtc_h,
34a2ab5e 513 src_x, src_y, src_w, src_h, ctx);
43968d7b
DV
514 if (!ret) {
515 plane->crtc = crtc;
516 plane->fb = fb;
517 fb = NULL;
518 } else {
519 plane->old_fb = NULL;
520 }
521
522out:
523 if (fb)
a4a69da0 524 drm_framebuffer_put(fb);
43968d7b 525 if (plane->old_fb)
a4a69da0 526 drm_framebuffer_put(plane->old_fb);
43968d7b
DV
527 plane->old_fb = NULL;
528
529 return ret;
530}
531
532static int setplane_internal(struct drm_plane *plane,
533 struct drm_crtc *crtc,
534 struct drm_framebuffer *fb,
535 int32_t crtc_x, int32_t crtc_y,
536 uint32_t crtc_w, uint32_t crtc_h,
537 /* src_{x,y,w,h} values are 16.16 fixed point */
538 uint32_t src_x, uint32_t src_y,
539 uint32_t src_w, uint32_t src_h)
540{
232e8f70 541 struct drm_modeset_acquire_ctx ctx;
43968d7b
DV
542 int ret;
543
232e8f70
DV
544 drm_modeset_acquire_init(&ctx, 0);
545retry:
546 ret = drm_modeset_lock_all_ctx(plane->dev, &ctx);
547 if (ret)
548 goto fail;
549 plane->dev->mode_config.acquire_ctx = &ctx;
43968d7b
DV
550 ret = __setplane_internal(plane, crtc, fb,
551 crtc_x, crtc_y, crtc_w, crtc_h,
232e8f70
DV
552 src_x, src_y, src_w, src_h, &ctx);
553
554fail:
555 if (ret == -EDEADLK) {
556 drm_modeset_backoff(&ctx);
557 goto retry;
558 }
559 drm_modeset_drop_locks(&ctx);
560 drm_modeset_acquire_fini(&ctx);
43968d7b
DV
561
562 return ret;
563}
564
43968d7b
DV
565int drm_mode_setplane(struct drm_device *dev, void *data,
566 struct drm_file *file_priv)
567{
568 struct drm_mode_set_plane *plane_req = data;
569 struct drm_plane *plane;
570 struct drm_crtc *crtc = NULL;
571 struct drm_framebuffer *fb = NULL;
572
573 if (!drm_core_check_feature(dev, DRIVER_MODESET))
574 return -EINVAL;
575
576 /*
577 * First, find the plane, crtc, and fb objects. If not available,
578 * we don't bother to call the driver.
579 */
580 plane = drm_plane_find(dev, plane_req->plane_id);
581 if (!plane) {
582 DRM_DEBUG_KMS("Unknown plane ID %d\n",
583 plane_req->plane_id);
584 return -ENOENT;
585 }
586
587 if (plane_req->fb_id) {
588 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
589 if (!fb) {
590 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
591 plane_req->fb_id);
592 return -ENOENT;
593 }
594
595 crtc = drm_crtc_find(dev, plane_req->crtc_id);
596 if (!crtc) {
597 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
598 plane_req->crtc_id);
599 return -ENOENT;
600 }
601 }
602
603 /*
604 * setplane_internal will take care of deref'ing either the old or new
605 * framebuffer depending on success.
606 */
607 return setplane_internal(plane, crtc, fb,
608 plane_req->crtc_x, plane_req->crtc_y,
609 plane_req->crtc_w, plane_req->crtc_h,
610 plane_req->src_x, plane_req->src_y,
611 plane_req->src_w, plane_req->src_h);
612}
613
43968d7b
DV
614static int drm_mode_cursor_universal(struct drm_crtc *crtc,
615 struct drm_mode_cursor2 *req,
616 struct drm_file *file_priv)
617{
618 struct drm_device *dev = crtc->dev;
619 struct drm_framebuffer *fb = NULL;
620 struct drm_mode_fb_cmd2 fbreq = {
621 .width = req->width,
622 .height = req->height,
623 .pixel_format = DRM_FORMAT_ARGB8888,
624 .pitches = { req->width * 4 },
625 .handles = { req->handle },
626 };
627 int32_t crtc_x, crtc_y;
628 uint32_t crtc_w = 0, crtc_h = 0;
629 uint32_t src_w = 0, src_h = 0;
232e8f70 630 struct drm_modeset_acquire_ctx ctx;
43968d7b
DV
631 int ret = 0;
632
633 BUG_ON(!crtc->cursor);
634 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
635
232e8f70
DV
636 drm_modeset_acquire_init(&ctx, 0);
637retry:
638 ret = drm_modeset_lock(&crtc->mutex, &ctx);
639 if (ret)
640 goto fail;
641 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
642 if (ret)
643 goto fail;
644 crtc->acquire_ctx = &ctx;
645
43968d7b
DV
646 /*
647 * Obtain fb we'll be using (either new or existing) and take an extra
648 * reference to it if fb != null. setplane will take care of dropping
649 * the reference if the plane update fails.
650 */
651 if (req->flags & DRM_MODE_CURSOR_BO) {
652 if (req->handle) {
653 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
654 if (IS_ERR(fb)) {
655 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
656 return PTR_ERR(fb);
657 }
658 fb->hot_x = req->hot_x;
659 fb->hot_y = req->hot_y;
660 } else {
661 fb = NULL;
662 }
663 } else {
664 fb = crtc->cursor->fb;
665 if (fb)
a4a69da0 666 drm_framebuffer_get(fb);
43968d7b
DV
667 }
668
669 if (req->flags & DRM_MODE_CURSOR_MOVE) {
670 crtc_x = req->x;
671 crtc_y = req->y;
672 } else {
673 crtc_x = crtc->cursor_x;
674 crtc_y = crtc->cursor_y;
675 }
676
677 if (fb) {
678 crtc_w = fb->width;
679 crtc_h = fb->height;
680 src_w = fb->width << 16;
681 src_h = fb->height << 16;
682 }
683
684 /*
685 * setplane_internal will take care of deref'ing either the old or new
686 * framebuffer depending on success.
687 */
688 ret = __setplane_internal(crtc->cursor, crtc, fb,
689 crtc_x, crtc_y, crtc_w, crtc_h,
232e8f70 690 0, 0, src_w, src_h, &ctx);
43968d7b
DV
691
692 /* Update successful; save new cursor position, if necessary */
693 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
694 crtc->cursor_x = req->x;
695 crtc->cursor_y = req->y;
696 }
697
232e8f70
DV
698fail:
699 if (ret == -EDEADLK) {
700 drm_modeset_backoff(&ctx);
701 goto retry;
702 }
703
704 drm_modeset_drop_locks(&ctx);
705 drm_modeset_acquire_fini(&ctx);
706
43968d7b
DV
707 return ret;
708}
709
710static int drm_mode_cursor_common(struct drm_device *dev,
711 struct drm_mode_cursor2 *req,
712 struct drm_file *file_priv)
713{
714 struct drm_crtc *crtc;
715 int ret = 0;
716
717 if (!drm_core_check_feature(dev, DRIVER_MODESET))
718 return -EINVAL;
719
720 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
721 return -EINVAL;
722
723 crtc = drm_crtc_find(dev, req->crtc_id);
724 if (!crtc) {
725 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
726 return -ENOENT;
727 }
728
729 /*
730 * If this crtc has a universal cursor plane, call that plane's update
731 * handler rather than using legacy cursor handlers.
732 */
232e8f70
DV
733 if (crtc->cursor)
734 return drm_mode_cursor_universal(crtc, req, file_priv);
43968d7b 735
232e8f70 736 drm_modeset_lock_crtc(crtc, crtc->cursor);
43968d7b
DV
737 if (req->flags & DRM_MODE_CURSOR_BO) {
738 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
739 ret = -ENXIO;
740 goto out;
741 }
742 /* Turns off the cursor if handle is 0 */
743 if (crtc->funcs->cursor_set2)
744 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
745 req->width, req->height, req->hot_x, req->hot_y);
746 else
747 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
748 req->width, req->height);
749 }
750
751 if (req->flags & DRM_MODE_CURSOR_MOVE) {
752 if (crtc->funcs->cursor_move) {
753 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
754 } else {
755 ret = -EFAULT;
756 goto out;
757 }
758 }
759out:
760 drm_modeset_unlock_crtc(crtc);
761
762 return ret;
763
764}
765
766
43968d7b
DV
767int drm_mode_cursor_ioctl(struct drm_device *dev,
768 void *data, struct drm_file *file_priv)
769{
770 struct drm_mode_cursor *req = data;
771 struct drm_mode_cursor2 new_req;
772
773 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
774 new_req.hot_x = new_req.hot_y = 0;
775
776 return drm_mode_cursor_common(dev, &new_req, file_priv);
777}
778
532b3671 779/*
43968d7b
DV
780 * Set the cursor configuration based on user request. This implements the 2nd
781 * version of the cursor ioctl, which allows userspace to additionally specify
782 * the hotspot of the pointer.
43968d7b
DV
783 */
784int drm_mode_cursor2_ioctl(struct drm_device *dev,
785 void *data, struct drm_file *file_priv)
786{
787 struct drm_mode_cursor2 *req = data;
788
789 return drm_mode_cursor_common(dev, req, file_priv);
790}
791
43968d7b
DV
792int drm_mode_page_flip_ioctl(struct drm_device *dev,
793 void *data, struct drm_file *file_priv)
794{
795 struct drm_mode_crtc_page_flip_target *page_flip = data;
796 struct drm_crtc *crtc;
797 struct drm_framebuffer *fb = NULL;
798 struct drm_pending_vblank_event *e = NULL;
799 u32 target_vblank = page_flip->sequence;
800 int ret = -EINVAL;
801
802 if (!drm_core_check_feature(dev, DRIVER_MODESET))
803 return -EINVAL;
804
805 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
806 return -EINVAL;
807
808 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
809 return -EINVAL;
810
811 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
812 * can be specified
813 */
814 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
815 return -EINVAL;
816
817 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
818 return -EINVAL;
819
820 crtc = drm_crtc_find(dev, page_flip->crtc_id);
821 if (!crtc)
822 return -ENOENT;
823
2adb29b1
DV
824 if (crtc->funcs->page_flip_target) {
825 u32 current_vblank;
826 int r;
827
828 r = drm_crtc_vblank_get(crtc);
829 if (r)
830 return r;
831
832 current_vblank = drm_crtc_vblank_count(crtc);
833
834 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
835 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
836 if ((int)(target_vblank - current_vblank) > 1) {
837 DRM_DEBUG("Invalid absolute flip target %u, "
838 "must be <= %u\n", target_vblank,
839 current_vblank + 1);
840 drm_crtc_vblank_put(crtc);
841 return -EINVAL;
842 }
843 break;
844 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
845 if (target_vblank != 0 && target_vblank != 1) {
846 DRM_DEBUG("Invalid relative flip target %u, "
847 "must be 0 or 1\n", target_vblank);
848 drm_crtc_vblank_put(crtc);
849 return -EINVAL;
850 }
851 target_vblank += current_vblank;
852 break;
853 default:
854 target_vblank = current_vblank +
855 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
856 break;
857 }
858 } else if (crtc->funcs->page_flip == NULL ||
859 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
860 return -EINVAL;
861 }
862
43968d7b
DV
863 drm_modeset_lock_crtc(crtc, crtc->primary);
864 if (crtc->primary->fb == NULL) {
865 /* The framebuffer is currently unbound, presumably
866 * due to a hotplug event, that userspace has not
867 * yet discovered.
868 */
869 ret = -EBUSY;
870 goto out;
871 }
872
43968d7b
DV
873 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
874 if (!fb) {
875 ret = -ENOENT;
876 goto out;
877 }
878
879 if (crtc->state) {
880 const struct drm_plane_state *state = crtc->primary->state;
881
882 ret = drm_framebuffer_check_src_coords(state->src_x,
883 state->src_y,
884 state->src_w,
885 state->src_h,
886 fb);
887 } else {
888 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
889 }
890 if (ret)
891 goto out;
892
dbd4d576 893 if (crtc->primary->fb->format != fb->format) {
43968d7b
DV
894 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
895 ret = -EINVAL;
896 goto out;
897 }
898
899 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
900 e = kzalloc(sizeof *e, GFP_KERNEL);
901 if (!e) {
902 ret = -ENOMEM;
903 goto out;
904 }
905 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
906 e->event.base.length = sizeof(e->event);
907 e->event.user_data = page_flip->user_data;
908 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
909 if (ret) {
910 kfree(e);
911 goto out;
912 }
913 }
914
915 crtc->primary->old_fb = crtc->primary->fb;
43968d7b
DV
916 if (crtc->funcs->page_flip_target)
917 ret = crtc->funcs->page_flip_target(crtc, fb, e,
918 page_flip->flags,
919 target_vblank);
920 else
921 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags);
922 if (ret) {
923 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
924 drm_event_cancel_free(dev, &e->base);
925 /* Keep the old fb, don't unref it. */
926 crtc->primary->old_fb = NULL;
927 } else {
928 crtc->primary->fb = fb;
929 /* Unref only the old framebuffer. */
930 fb = NULL;
931 }
932
933out:
934 if (ret && crtc->funcs->page_flip_target)
935 drm_crtc_vblank_put(crtc);
e86fa21b 936 if (fb)
a4a69da0 937 drm_framebuffer_put(fb);
43968d7b 938 if (crtc->primary->old_fb)
a4a69da0 939 drm_framebuffer_put(crtc->primary->old_fb);
43968d7b
DV
940 crtc->primary->old_fb = NULL;
941 drm_modeset_unlock_crtc(crtc);
942
943 return ret;
944}