2 * Copyright (c) 2016 Intel Corporation
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.
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
24 #include <drm/drm_plane.h>
26 #include "drm_crtc_internal.h"
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.
39 * To create a plane, a KMS drivers allocates and zeroes an instances of
40 * &struct drm_plane (possibly as part of a larger structure) and registers it
41 * with a call to drm_universal_plane_init().
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
45 * drm_plane_type for a more in-depth discussion of these special uapi-relevant
46 * plane types. Special planes are associated with their CRTC by calling
47 * drm_crtc_init_with_planes().
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".
53 static unsigned int drm_num_planes(struct drm_device *dev)
56 struct drm_plane *tmp;
58 drm_for_each_plane(tmp, dev) {
66 formats_ptr(struct drm_format_modifier_blob *blob)
68 return (u32 *)(((char *)blob) + blob->formats_offset);
71 static inline struct drm_format_modifier *
72 modifiers_ptr(struct drm_format_modifier_blob *blob)
74 return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset);
77 static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane)
79 const struct drm_mode_config *config = &dev->mode_config;
80 struct drm_property_blob *blob;
81 struct drm_format_modifier *mod;
82 size_t blob_size, formats_size, modifiers_size;
83 struct drm_format_modifier_blob *blob_data;
86 formats_size = sizeof(__u32) * plane->format_count;
87 if (WARN_ON(!formats_size)) {
88 /* 0 formats are never expected */
93 sizeof(struct drm_format_modifier) * plane->modifier_count;
95 blob_size = sizeof(struct drm_format_modifier_blob);
96 /* Modifiers offset is a pointer to a struct with a 64 bit field so it
97 * should be naturally aligned to 8B.
99 BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8);
100 blob_size += ALIGN(formats_size, 8);
101 blob_size += modifiers_size;
103 blob = drm_property_create_blob(dev, blob_size, NULL);
107 blob_data = (struct drm_format_modifier_blob *)blob->data;
108 blob_data->version = FORMAT_BLOB_CURRENT;
109 blob_data->count_formats = plane->format_count;
110 blob_data->formats_offset = sizeof(struct drm_format_modifier_blob);
111 blob_data->count_modifiers = plane->modifier_count;
113 blob_data->modifiers_offset =
114 ALIGN(blob_data->formats_offset + formats_size, 8);
116 memcpy(formats_ptr(blob_data), plane->format_types, formats_size);
118 /* If we can't determine support, just bail */
119 if (!plane->funcs->format_mod_supported)
122 mod = modifiers_ptr(blob_data);
123 for (i = 0; i < plane->modifier_count; i++) {
124 for (j = 0; j < plane->format_count; j++) {
125 if (plane->funcs->format_mod_supported(plane,
126 plane->format_types[j],
127 plane->modifiers[i])) {
129 mod->formats |= 1ULL << j;
133 mod->modifier = plane->modifiers[i];
140 drm_object_attach_property(&plane->base, config->modifiers_property,
147 * drm_universal_plane_init - Initialize a new universal plane object
149 * @plane: plane object to init
150 * @possible_crtcs: bitmask of possible CRTCs
151 * @funcs: callbacks for the new plane
152 * @formats: array of supported formats (DRM_FORMAT\_\*)
153 * @format_count: number of elements in @formats
154 * @format_modifiers: array of struct drm_format modifiers terminated by
155 * DRM_FORMAT_MOD_INVALID
156 * @type: type of plane (overlay, primary, cursor)
157 * @name: printf style format string for the plane name, or NULL for default name
159 * Initializes a plane object of type @type.
162 * Zero on success, error code on failure.
164 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
165 uint32_t possible_crtcs,
166 const struct drm_plane_funcs *funcs,
167 const uint32_t *formats, unsigned int format_count,
168 const uint64_t *format_modifiers,
169 enum drm_plane_type type,
170 const char *name, ...)
172 struct drm_mode_config *config = &dev->mode_config;
173 unsigned int format_modifier_count = 0;
176 ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
180 drm_modeset_lock_init(&plane->mutex);
182 plane->base.properties = &plane->properties;
184 plane->funcs = funcs;
185 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
187 if (!plane->format_types) {
188 DRM_DEBUG_KMS("out of memory when allocating plane\n");
189 drm_mode_object_unregister(dev, &plane->base);
194 * First driver to need more than 64 formats needs to fix this. Each
195 * format is encoded as a bit and the current code only supports a u64.
197 if (WARN_ON(format_count > 64))
200 if (format_modifiers) {
201 const uint64_t *temp_modifiers = format_modifiers;
202 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
203 format_modifier_count++;
206 if (format_modifier_count)
207 config->allow_fb_modifiers = true;
209 plane->modifier_count = format_modifier_count;
210 plane->modifiers = kmalloc_array(format_modifier_count,
211 sizeof(format_modifiers[0]),
214 if (format_modifier_count && !plane->modifiers) {
215 DRM_DEBUG_KMS("out of memory when allocating plane\n");
216 kfree(plane->format_types);
217 drm_mode_object_unregister(dev, &plane->base);
225 plane->name = kvasprintf(GFP_KERNEL, name, ap);
228 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
229 drm_num_planes(dev));
232 kfree(plane->format_types);
233 kfree(plane->modifiers);
234 drm_mode_object_unregister(dev, &plane->base);
238 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
239 plane->format_count = format_count;
240 memcpy(plane->modifiers, format_modifiers,
241 format_modifier_count * sizeof(format_modifiers[0]));
242 plane->possible_crtcs = possible_crtcs;
245 list_add_tail(&plane->head, &config->plane_list);
246 plane->index = config->num_total_plane++;
247 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
248 config->num_overlay_plane++;
250 drm_object_attach_property(&plane->base,
251 config->plane_type_property,
254 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
255 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
256 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
257 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
258 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
259 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
260 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
261 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
262 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
263 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
264 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
265 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
268 if (config->allow_fb_modifiers)
269 create_in_format_blob(dev, plane);
273 EXPORT_SYMBOL(drm_universal_plane_init);
275 int drm_plane_register_all(struct drm_device *dev)
277 struct drm_plane *plane;
280 drm_for_each_plane(plane, dev) {
281 if (plane->funcs->late_register)
282 ret = plane->funcs->late_register(plane);
290 void drm_plane_unregister_all(struct drm_device *dev)
292 struct drm_plane *plane;
294 drm_for_each_plane(plane, dev) {
295 if (plane->funcs->early_unregister)
296 plane->funcs->early_unregister(plane);
301 * drm_plane_init - Initialize a legacy plane
303 * @plane: plane object to init
304 * @possible_crtcs: bitmask of possible CRTCs
305 * @funcs: callbacks for the new plane
306 * @formats: array of supported formats (DRM_FORMAT\_\*)
307 * @format_count: number of elements in @formats
308 * @is_primary: plane type (primary vs overlay)
310 * Legacy API to initialize a DRM plane.
312 * New drivers should call drm_universal_plane_init() instead.
315 * Zero on success, error code on failure.
317 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
318 uint32_t possible_crtcs,
319 const struct drm_plane_funcs *funcs,
320 const uint32_t *formats, unsigned int format_count,
323 enum drm_plane_type type;
325 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
326 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
327 formats, format_count,
330 EXPORT_SYMBOL(drm_plane_init);
333 * drm_plane_cleanup - Clean up the core plane usage
334 * @plane: plane to cleanup
336 * This function cleans up @plane and removes it from the DRM mode setting
337 * core. Note that the function does *not* free the plane structure itself,
338 * this is the responsibility of the caller.
340 void drm_plane_cleanup(struct drm_plane *plane)
342 struct drm_device *dev = plane->dev;
344 drm_modeset_lock_fini(&plane->mutex);
346 kfree(plane->format_types);
347 kfree(plane->modifiers);
348 drm_mode_object_unregister(dev, &plane->base);
350 BUG_ON(list_empty(&plane->head));
352 /* Note that the plane_list is considered to be static; should we
353 * remove the drm_plane at runtime we would have to decrement all
354 * the indices on the drm_plane after us in the plane_list.
357 list_del(&plane->head);
358 dev->mode_config.num_total_plane--;
359 if (plane->type == DRM_PLANE_TYPE_OVERLAY)
360 dev->mode_config.num_overlay_plane--;
362 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
363 if (plane->state && plane->funcs->atomic_destroy_state)
364 plane->funcs->atomic_destroy_state(plane, plane->state);
368 memset(plane, 0, sizeof(*plane));
370 EXPORT_SYMBOL(drm_plane_cleanup);
373 * drm_plane_from_index - find the registered plane at an index
375 * @idx: index of registered plane to find for
377 * Given a plane index, return the registered plane from DRM device's
378 * list of planes with matching index. This is the inverse of drm_plane_index().
381 drm_plane_from_index(struct drm_device *dev, int idx)
383 struct drm_plane *plane;
385 drm_for_each_plane(plane, dev)
386 if (idx == plane->index)
391 EXPORT_SYMBOL(drm_plane_from_index);
394 * drm_plane_force_disable - Forcibly disable a plane
395 * @plane: plane to disable
397 * Forces the plane to be disabled.
399 * Used when the plane's current framebuffer is destroyed,
400 * and when restoring fbdev mode.
402 * Note that this function is not suitable for atomic drivers, since it doesn't
403 * wire through the lock acquisition context properly and hence can't handle
404 * retries or driver private locks. You probably want to use
405 * drm_atomic_helper_disable_plane() or
406 * drm_atomic_helper_disable_planes_on_crtc() instead.
408 void drm_plane_force_disable(struct drm_plane *plane)
415 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
417 plane->old_fb = plane->fb;
418 ret = plane->funcs->disable_plane(plane, NULL);
420 DRM_ERROR("failed to disable plane with busy fb\n");
421 plane->old_fb = NULL;
424 /* disconnect the plane from the fb and crtc: */
425 drm_framebuffer_put(plane->old_fb);
426 plane->old_fb = NULL;
430 EXPORT_SYMBOL(drm_plane_force_disable);
433 * drm_mode_plane_set_obj_prop - set the value of a property
434 * @plane: drm plane object to set property value for
435 * @property: property to set
436 * @value: value the property should be set to
438 * This functions sets a given property on a given plane object. This function
439 * calls the driver's ->set_property callback and changes the software state of
440 * the property if the callback succeeds.
443 * Zero on success, error code on failure.
445 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
446 struct drm_property *property,
450 struct drm_mode_object *obj = &plane->base;
452 if (plane->funcs->set_property)
453 ret = plane->funcs->set_property(plane, property, value);
455 drm_object_property_set_value(obj, property, value);
459 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
461 int drm_mode_getplane_res(struct drm_device *dev, void *data,
462 struct drm_file *file_priv)
464 struct drm_mode_get_plane_res *plane_resp = data;
465 struct drm_mode_config *config;
466 struct drm_plane *plane;
467 uint32_t __user *plane_ptr;
471 if (!drm_core_check_feature(dev, DRIVER_MODESET))
474 config = &dev->mode_config;
476 if (file_priv->universal_planes)
477 num_planes = config->num_total_plane;
479 num_planes = config->num_overlay_plane;
482 * This ioctl is called twice, once to determine how much space is
483 * needed, and the 2nd time to fill it.
486 (plane_resp->count_planes >= num_planes)) {
487 plane_ptr = (uint32_t __user *)(unsigned long)plane_resp->plane_id_ptr;
489 /* Plane lists are invariant, no locking needed. */
490 drm_for_each_plane(plane, dev) {
492 * Unless userspace set the 'universal planes'
493 * capability bit, only advertise overlays.
495 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
496 !file_priv->universal_planes)
499 if (put_user(plane->base.id, plane_ptr + copied))
504 plane_resp->count_planes = num_planes;
509 int drm_mode_getplane(struct drm_device *dev, void *data,
510 struct drm_file *file_priv)
512 struct drm_mode_get_plane *plane_resp = data;
513 struct drm_plane *plane;
514 uint32_t __user *format_ptr;
516 if (!drm_core_check_feature(dev, DRIVER_MODESET))
519 plane = drm_plane_find(dev, plane_resp->plane_id);
523 drm_modeset_lock(&plane->mutex, NULL);
524 if (plane->state && plane->state->crtc)
525 plane_resp->crtc_id = plane->state->crtc->base.id;
526 else if (!plane->state && plane->crtc)
527 plane_resp->crtc_id = plane->crtc->base.id;
529 plane_resp->crtc_id = 0;
531 if (plane->state && plane->state->fb)
532 plane_resp->fb_id = plane->state->fb->base.id;
533 else if (!plane->state && plane->fb)
534 plane_resp->fb_id = plane->fb->base.id;
536 plane_resp->fb_id = 0;
537 drm_modeset_unlock(&plane->mutex);
539 plane_resp->plane_id = plane->base.id;
540 plane_resp->possible_crtcs = plane->possible_crtcs;
541 plane_resp->gamma_size = 0;
544 * This ioctl is called twice, once to determine how much space is
545 * needed, and the 2nd time to fill it.
547 if (plane->format_count &&
548 (plane_resp->count_format_types >= plane->format_count)) {
549 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
550 if (copy_to_user(format_ptr,
552 sizeof(uint32_t) * plane->format_count)) {
556 plane_resp->count_format_types = plane->format_count;
561 int drm_plane_check_pixel_format(const struct drm_plane *plane, u32 format)
565 for (i = 0; i < plane->format_count; i++) {
566 if (format == plane->format_types[i])
574 * setplane_internal - setplane handler for internal callers
576 * Note that we assume an extra reference has already been taken on fb. If the
577 * update fails, this reference will be dropped before return; if it succeeds,
578 * the previous framebuffer (if any) will be unreferenced instead.
580 * src_{x,y,w,h} are provided in 16.16 fixed point format
582 static int __setplane_internal(struct drm_plane *plane,
583 struct drm_crtc *crtc,
584 struct drm_framebuffer *fb,
585 int32_t crtc_x, int32_t crtc_y,
586 uint32_t crtc_w, uint32_t crtc_h,
587 /* src_{x,y,w,h} values are 16.16 fixed point */
588 uint32_t src_x, uint32_t src_y,
589 uint32_t src_w, uint32_t src_h,
590 struct drm_modeset_acquire_ctx *ctx)
594 /* No fb means shut it down */
596 plane->old_fb = plane->fb;
597 ret = plane->funcs->disable_plane(plane, ctx);
602 plane->old_fb = NULL;
607 /* Check whether this plane is usable on this CRTC */
608 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
609 DRM_DEBUG_KMS("Invalid crtc for plane\n");
614 /* Check whether this plane supports the fb pixel format. */
615 ret = drm_plane_check_pixel_format(plane, fb->format->format);
617 struct drm_format_name_buf format_name;
618 DRM_DEBUG_KMS("Invalid pixel format %s\n",
619 drm_get_format_name(fb->format->format,
624 /* Give drivers some help against integer overflows */
625 if (crtc_w > INT_MAX ||
626 crtc_x > INT_MAX - (int32_t) crtc_w ||
628 crtc_y > INT_MAX - (int32_t) crtc_h) {
629 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
630 crtc_w, crtc_h, crtc_x, crtc_y);
635 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
639 plane->old_fb = plane->fb;
640 ret = plane->funcs->update_plane(plane, crtc, fb,
641 crtc_x, crtc_y, crtc_w, crtc_h,
642 src_x, src_y, src_w, src_h, ctx);
648 plane->old_fb = NULL;
653 drm_framebuffer_put(fb);
655 drm_framebuffer_put(plane->old_fb);
656 plane->old_fb = NULL;
661 static int setplane_internal(struct drm_plane *plane,
662 struct drm_crtc *crtc,
663 struct drm_framebuffer *fb,
664 int32_t crtc_x, int32_t crtc_y,
665 uint32_t crtc_w, uint32_t crtc_h,
666 /* src_{x,y,w,h} values are 16.16 fixed point */
667 uint32_t src_x, uint32_t src_y,
668 uint32_t src_w, uint32_t src_h)
670 struct drm_modeset_acquire_ctx ctx;
673 drm_modeset_acquire_init(&ctx, 0);
675 ret = drm_modeset_lock_all_ctx(plane->dev, &ctx);
678 ret = __setplane_internal(plane, crtc, fb,
679 crtc_x, crtc_y, crtc_w, crtc_h,
680 src_x, src_y, src_w, src_h, &ctx);
683 if (ret == -EDEADLK) {
684 drm_modeset_backoff(&ctx);
687 drm_modeset_drop_locks(&ctx);
688 drm_modeset_acquire_fini(&ctx);
693 int drm_mode_setplane(struct drm_device *dev, void *data,
694 struct drm_file *file_priv)
696 struct drm_mode_set_plane *plane_req = data;
697 struct drm_plane *plane;
698 struct drm_crtc *crtc = NULL;
699 struct drm_framebuffer *fb = NULL;
701 if (!drm_core_check_feature(dev, DRIVER_MODESET))
705 * First, find the plane, crtc, and fb objects. If not available,
706 * we don't bother to call the driver.
708 plane = drm_plane_find(dev, plane_req->plane_id);
710 DRM_DEBUG_KMS("Unknown plane ID %d\n",
711 plane_req->plane_id);
715 if (plane_req->fb_id) {
716 fb = drm_framebuffer_lookup(dev, plane_req->fb_id);
718 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
723 crtc = drm_crtc_find(dev, plane_req->crtc_id);
725 drm_framebuffer_put(fb);
726 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
733 * setplane_internal will take care of deref'ing either the old or new
734 * framebuffer depending on success.
736 return setplane_internal(plane, crtc, fb,
737 plane_req->crtc_x, plane_req->crtc_y,
738 plane_req->crtc_w, plane_req->crtc_h,
739 plane_req->src_x, plane_req->src_y,
740 plane_req->src_w, plane_req->src_h);
743 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
744 struct drm_mode_cursor2 *req,
745 struct drm_file *file_priv,
746 struct drm_modeset_acquire_ctx *ctx)
748 struct drm_device *dev = crtc->dev;
749 struct drm_framebuffer *fb = NULL;
750 struct drm_mode_fb_cmd2 fbreq = {
752 .height = req->height,
753 .pixel_format = DRM_FORMAT_ARGB8888,
754 .pitches = { req->width * 4 },
755 .handles = { req->handle },
757 int32_t crtc_x, crtc_y;
758 uint32_t crtc_w = 0, crtc_h = 0;
759 uint32_t src_w = 0, src_h = 0;
762 BUG_ON(!crtc->cursor);
763 WARN_ON(crtc->cursor->crtc != crtc && crtc->cursor->crtc != NULL);
766 * Obtain fb we'll be using (either new or existing) and take an extra
767 * reference to it if fb != null. setplane will take care of dropping
768 * the reference if the plane update fails.
770 if (req->flags & DRM_MODE_CURSOR_BO) {
772 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
774 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
777 fb->hot_x = req->hot_x;
778 fb->hot_y = req->hot_y;
783 fb = crtc->cursor->fb;
785 drm_framebuffer_get(fb);
788 if (req->flags & DRM_MODE_CURSOR_MOVE) {
792 crtc_x = crtc->cursor_x;
793 crtc_y = crtc->cursor_y;
799 src_w = fb->width << 16;
800 src_h = fb->height << 16;
804 * setplane_internal will take care of deref'ing either the old or new
805 * framebuffer depending on success.
807 ret = __setplane_internal(crtc->cursor, crtc, fb,
808 crtc_x, crtc_y, crtc_w, crtc_h,
809 0, 0, src_w, src_h, ctx);
811 /* Update successful; save new cursor position, if necessary */
812 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
813 crtc->cursor_x = req->x;
814 crtc->cursor_y = req->y;
820 static int drm_mode_cursor_common(struct drm_device *dev,
821 struct drm_mode_cursor2 *req,
822 struct drm_file *file_priv)
824 struct drm_crtc *crtc;
825 struct drm_modeset_acquire_ctx ctx;
828 if (!drm_core_check_feature(dev, DRIVER_MODESET))
831 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
834 crtc = drm_crtc_find(dev, req->crtc_id);
836 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
840 drm_modeset_acquire_init(&ctx, 0);
842 ret = drm_modeset_lock(&crtc->mutex, &ctx);
846 * If this crtc has a universal cursor plane, call that plane's update
847 * handler rather than using legacy cursor handlers.
850 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
854 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
858 if (req->flags & DRM_MODE_CURSOR_BO) {
859 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
863 /* Turns off the cursor if handle is 0 */
864 if (crtc->funcs->cursor_set2)
865 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
866 req->width, req->height, req->hot_x, req->hot_y);
868 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
869 req->width, req->height);
872 if (req->flags & DRM_MODE_CURSOR_MOVE) {
873 if (crtc->funcs->cursor_move) {
874 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
881 if (ret == -EDEADLK) {
882 drm_modeset_backoff(&ctx);
886 drm_modeset_drop_locks(&ctx);
887 drm_modeset_acquire_fini(&ctx);
894 int drm_mode_cursor_ioctl(struct drm_device *dev,
895 void *data, struct drm_file *file_priv)
897 struct drm_mode_cursor *req = data;
898 struct drm_mode_cursor2 new_req;
900 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
901 new_req.hot_x = new_req.hot_y = 0;
903 return drm_mode_cursor_common(dev, &new_req, file_priv);
907 * Set the cursor configuration based on user request. This implements the 2nd
908 * version of the cursor ioctl, which allows userspace to additionally specify
909 * the hotspot of the pointer.
911 int drm_mode_cursor2_ioctl(struct drm_device *dev,
912 void *data, struct drm_file *file_priv)
914 struct drm_mode_cursor2 *req = data;
916 return drm_mode_cursor_common(dev, req, file_priv);
919 int drm_mode_page_flip_ioctl(struct drm_device *dev,
920 void *data, struct drm_file *file_priv)
922 struct drm_mode_crtc_page_flip_target *page_flip = data;
923 struct drm_crtc *crtc;
924 struct drm_framebuffer *fb = NULL;
925 struct drm_pending_vblank_event *e = NULL;
926 u32 target_vblank = page_flip->sequence;
927 struct drm_modeset_acquire_ctx ctx;
930 if (!drm_core_check_feature(dev, DRIVER_MODESET))
933 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
936 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
939 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
942 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
945 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
948 crtc = drm_crtc_find(dev, page_flip->crtc_id);
952 if (crtc->funcs->page_flip_target) {
956 r = drm_crtc_vblank_get(crtc);
960 current_vblank = drm_crtc_vblank_count(crtc);
962 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
963 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
964 if ((int)(target_vblank - current_vblank) > 1) {
965 DRM_DEBUG("Invalid absolute flip target %u, "
966 "must be <= %u\n", target_vblank,
968 drm_crtc_vblank_put(crtc);
972 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
973 if (target_vblank != 0 && target_vblank != 1) {
974 DRM_DEBUG("Invalid relative flip target %u, "
975 "must be 0 or 1\n", target_vblank);
976 drm_crtc_vblank_put(crtc);
979 target_vblank += current_vblank;
982 target_vblank = current_vblank +
983 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
986 } else if (crtc->funcs->page_flip == NULL ||
987 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
991 drm_modeset_acquire_init(&ctx, 0);
993 ret = drm_modeset_lock(&crtc->mutex, &ctx);
996 ret = drm_modeset_lock(&crtc->primary->mutex, &ctx);
1000 if (crtc->primary->fb == NULL) {
1001 /* The framebuffer is currently unbound, presumably
1002 * due to a hotplug event, that userspace has not
1009 fb = drm_framebuffer_lookup(dev, page_flip->fb_id);
1016 const struct drm_plane_state *state = crtc->primary->state;
1018 ret = drm_framebuffer_check_src_coords(state->src_x,
1024 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y, &crtc->mode, fb);
1029 if (crtc->primary->fb->format != fb->format) {
1030 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1035 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1036 e = kzalloc(sizeof *e, GFP_KERNEL);
1041 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1042 e->event.base.length = sizeof(e->event);
1043 e->event.user_data = page_flip->user_data;
1044 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1052 crtc->primary->old_fb = crtc->primary->fb;
1053 if (crtc->funcs->page_flip_target)
1054 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1059 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1062 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1063 drm_event_cancel_free(dev, &e->base);
1064 /* Keep the old fb, don't unref it. */
1065 crtc->primary->old_fb = NULL;
1067 crtc->primary->fb = fb;
1068 /* Unref only the old framebuffer. */
1074 drm_framebuffer_put(fb);
1075 if (crtc->primary->old_fb)
1076 drm_framebuffer_put(crtc->primary->old_fb);
1077 crtc->primary->old_fb = NULL;
1079 if (ret == -EDEADLK) {
1080 drm_modeset_backoff(&ctx);
1084 drm_modeset_drop_locks(&ctx);
1085 drm_modeset_acquire_fini(&ctx);
1087 if (ret && crtc->funcs->page_flip_target)
1088 drm_crtc_vblank_put(crtc);