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
23 #include <linux/slab.h>
24 #include <linux/uaccess.h>
26 #include <drm/drm_plane.h>
27 #include <drm/drm_drv.h>
28 #include <drm/drm_print.h>
29 #include <drm/drm_framebuffer.h>
30 #include <drm/drm_file.h>
31 #include <drm/drm_crtc.h>
32 #include <drm/drm_fourcc.h>
33 #include <drm/drm_vblank.h>
35 #include "drm_crtc_internal.h"
40 * A plane represents an image source that can be blended with or overlayed on
41 * top of a CRTC during the scanout process. Planes take their input data from a
42 * &drm_framebuffer object. The plane itself specifies the cropping and scaling
43 * of that image, and where it is placed on the visible are of a display
44 * pipeline, represented by &drm_crtc. A plane can also have additional
45 * properties that specify how the pixels are positioned and blended, like
46 * rotation or Z-position. All these properties are stored in &drm_plane_state.
48 * To create a plane, a KMS drivers allocates and zeroes an instances of
49 * &struct drm_plane (possibly as part of a larger structure) and registers it
50 * with a call to drm_universal_plane_init().
52 * Cursor and overlay planes are optional. All drivers should provide one
53 * primary plane per CRTC to avoid surprising userspace too much. See enum
54 * drm_plane_type for a more in-depth discussion of these special uapi-relevant
55 * plane types. Special planes are associated with their CRTC by calling
56 * drm_crtc_init_with_planes().
58 * The type of a plane is exposed in the immutable "type" enumeration property,
59 * which has one of the following values: "Overlay", "Primary", "Cursor".
62 static unsigned int drm_num_planes(struct drm_device *dev)
65 struct drm_plane *tmp;
67 drm_for_each_plane(tmp, dev) {
75 formats_ptr(struct drm_format_modifier_blob *blob)
77 return (u32 *)(((char *)blob) + blob->formats_offset);
80 static inline struct drm_format_modifier *
81 modifiers_ptr(struct drm_format_modifier_blob *blob)
83 return (struct drm_format_modifier *)(((char *)blob) + blob->modifiers_offset);
86 static int create_in_format_blob(struct drm_device *dev, struct drm_plane *plane)
88 const struct drm_mode_config *config = &dev->mode_config;
89 struct drm_property_blob *blob;
90 struct drm_format_modifier *mod;
91 size_t blob_size, formats_size, modifiers_size;
92 struct drm_format_modifier_blob *blob_data;
95 formats_size = sizeof(__u32) * plane->format_count;
96 if (WARN_ON(!formats_size)) {
97 /* 0 formats are never expected */
102 sizeof(struct drm_format_modifier) * plane->modifier_count;
104 blob_size = sizeof(struct drm_format_modifier_blob);
105 /* Modifiers offset is a pointer to a struct with a 64 bit field so it
106 * should be naturally aligned to 8B.
108 BUILD_BUG_ON(sizeof(struct drm_format_modifier_blob) % 8);
109 blob_size += ALIGN(formats_size, 8);
110 blob_size += modifiers_size;
112 blob = drm_property_create_blob(dev, blob_size, NULL);
116 blob_data = blob->data;
117 blob_data->version = FORMAT_BLOB_CURRENT;
118 blob_data->count_formats = plane->format_count;
119 blob_data->formats_offset = sizeof(struct drm_format_modifier_blob);
120 blob_data->count_modifiers = plane->modifier_count;
122 blob_data->modifiers_offset =
123 ALIGN(blob_data->formats_offset + formats_size, 8);
125 memcpy(formats_ptr(blob_data), plane->format_types, formats_size);
127 /* If we can't determine support, just bail */
128 if (!plane->funcs->format_mod_supported)
131 mod = modifiers_ptr(blob_data);
132 for (i = 0; i < plane->modifier_count; i++) {
133 for (j = 0; j < plane->format_count; j++) {
134 if (plane->funcs->format_mod_supported(plane,
135 plane->format_types[j],
136 plane->modifiers[i])) {
138 mod->formats |= 1ULL << j;
142 mod->modifier = plane->modifiers[i];
149 drm_object_attach_property(&plane->base, config->modifiers_property,
156 * drm_universal_plane_init - Initialize a new universal plane object
158 * @plane: plane object to init
159 * @possible_crtcs: bitmask of possible CRTCs
160 * @funcs: callbacks for the new plane
161 * @formats: array of supported formats (DRM_FORMAT\_\*)
162 * @format_count: number of elements in @formats
163 * @format_modifiers: array of struct drm_format modifiers terminated by
164 * DRM_FORMAT_MOD_INVALID
165 * @type: type of plane (overlay, primary, cursor)
166 * @name: printf style format string for the plane name, or NULL for default name
168 * Initializes a plane object of type @type.
171 * Zero on success, error code on failure.
173 int drm_universal_plane_init(struct drm_device *dev, struct drm_plane *plane,
174 uint32_t possible_crtcs,
175 const struct drm_plane_funcs *funcs,
176 const uint32_t *formats, unsigned int format_count,
177 const uint64_t *format_modifiers,
178 enum drm_plane_type type,
179 const char *name, ...)
181 struct drm_mode_config *config = &dev->mode_config;
182 unsigned int format_modifier_count = 0;
185 /* plane index is used with 32bit bitmasks */
186 if (WARN_ON(config->num_total_plane >= 32))
189 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
190 (!funcs->atomic_destroy_state ||
191 !funcs->atomic_duplicate_state));
193 ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
197 drm_modeset_lock_init(&plane->mutex);
199 plane->base.properties = &plane->properties;
201 plane->funcs = funcs;
202 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
204 if (!plane->format_types) {
205 DRM_DEBUG_KMS("out of memory when allocating plane\n");
206 drm_mode_object_unregister(dev, &plane->base);
211 * First driver to need more than 64 formats needs to fix this. Each
212 * format is encoded as a bit and the current code only supports a u64.
214 if (WARN_ON(format_count > 64))
217 if (format_modifiers) {
218 const uint64_t *temp_modifiers = format_modifiers;
219 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
220 format_modifier_count++;
223 if (format_modifier_count)
224 config->allow_fb_modifiers = true;
226 plane->modifier_count = format_modifier_count;
227 plane->modifiers = kmalloc_array(format_modifier_count,
228 sizeof(format_modifiers[0]),
231 if (format_modifier_count && !plane->modifiers) {
232 DRM_DEBUG_KMS("out of memory when allocating plane\n");
233 kfree(plane->format_types);
234 drm_mode_object_unregister(dev, &plane->base);
242 plane->name = kvasprintf(GFP_KERNEL, name, ap);
245 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
246 drm_num_planes(dev));
249 kfree(plane->format_types);
250 kfree(plane->modifiers);
251 drm_mode_object_unregister(dev, &plane->base);
255 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
256 plane->format_count = format_count;
257 memcpy(plane->modifiers, format_modifiers,
258 format_modifier_count * sizeof(format_modifiers[0]));
259 plane->possible_crtcs = possible_crtcs;
262 list_add_tail(&plane->head, &config->plane_list);
263 plane->index = config->num_total_plane++;
265 drm_object_attach_property(&plane->base,
266 config->plane_type_property,
269 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
270 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
271 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
272 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
273 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
274 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
275 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
276 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
277 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
278 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
279 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
280 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
283 if (config->allow_fb_modifiers)
284 create_in_format_blob(dev, plane);
288 EXPORT_SYMBOL(drm_universal_plane_init);
290 int drm_plane_register_all(struct drm_device *dev)
292 unsigned int num_planes = 0;
293 unsigned int num_zpos = 0;
294 struct drm_plane *plane;
297 drm_for_each_plane(plane, dev) {
298 if (plane->funcs->late_register)
299 ret = plane->funcs->late_register(plane);
303 if (plane->zpos_property)
308 drm_WARN(dev, num_zpos && num_planes != num_zpos,
309 "Mixing planes with and without zpos property is invalid\n");
314 void drm_plane_unregister_all(struct drm_device *dev)
316 struct drm_plane *plane;
318 drm_for_each_plane(plane, dev) {
319 if (plane->funcs->early_unregister)
320 plane->funcs->early_unregister(plane);
325 * drm_plane_init - Initialize a legacy plane
327 * @plane: plane object to init
328 * @possible_crtcs: bitmask of possible CRTCs
329 * @funcs: callbacks for the new plane
330 * @formats: array of supported formats (DRM_FORMAT\_\*)
331 * @format_count: number of elements in @formats
332 * @is_primary: plane type (primary vs overlay)
334 * Legacy API to initialize a DRM plane.
336 * New drivers should call drm_universal_plane_init() instead.
339 * Zero on success, error code on failure.
341 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
342 uint32_t possible_crtcs,
343 const struct drm_plane_funcs *funcs,
344 const uint32_t *formats, unsigned int format_count,
347 enum drm_plane_type type;
349 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
350 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
351 formats, format_count,
354 EXPORT_SYMBOL(drm_plane_init);
357 * drm_plane_cleanup - Clean up the core plane usage
358 * @plane: plane to cleanup
360 * This function cleans up @plane and removes it from the DRM mode setting
361 * core. Note that the function does *not* free the plane structure itself,
362 * this is the responsibility of the caller.
364 void drm_plane_cleanup(struct drm_plane *plane)
366 struct drm_device *dev = plane->dev;
368 drm_modeset_lock_fini(&plane->mutex);
370 kfree(plane->format_types);
371 kfree(plane->modifiers);
372 drm_mode_object_unregister(dev, &plane->base);
374 BUG_ON(list_empty(&plane->head));
376 /* Note that the plane_list is considered to be static; should we
377 * remove the drm_plane at runtime we would have to decrement all
378 * the indices on the drm_plane after us in the plane_list.
381 list_del(&plane->head);
382 dev->mode_config.num_total_plane--;
384 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
385 if (plane->state && plane->funcs->atomic_destroy_state)
386 plane->funcs->atomic_destroy_state(plane, plane->state);
390 memset(plane, 0, sizeof(*plane));
392 EXPORT_SYMBOL(drm_plane_cleanup);
395 * drm_plane_from_index - find the registered plane at an index
397 * @idx: index of registered plane to find for
399 * Given a plane index, return the registered plane from DRM device's
400 * list of planes with matching index. This is the inverse of drm_plane_index().
403 drm_plane_from_index(struct drm_device *dev, int idx)
405 struct drm_plane *plane;
407 drm_for_each_plane(plane, dev)
408 if (idx == plane->index)
413 EXPORT_SYMBOL(drm_plane_from_index);
416 * drm_plane_force_disable - Forcibly disable a plane
417 * @plane: plane to disable
419 * Forces the plane to be disabled.
421 * Used when the plane's current framebuffer is destroyed,
422 * and when restoring fbdev mode.
424 * Note that this function is not suitable for atomic drivers, since it doesn't
425 * wire through the lock acquisition context properly and hence can't handle
426 * retries or driver private locks. You probably want to use
427 * drm_atomic_helper_disable_plane() or
428 * drm_atomic_helper_disable_planes_on_crtc() instead.
430 void drm_plane_force_disable(struct drm_plane *plane)
437 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
439 plane->old_fb = plane->fb;
440 ret = plane->funcs->disable_plane(plane, NULL);
442 DRM_ERROR("failed to disable plane with busy fb\n");
443 plane->old_fb = NULL;
446 /* disconnect the plane from the fb and crtc: */
447 drm_framebuffer_put(plane->old_fb);
448 plane->old_fb = NULL;
452 EXPORT_SYMBOL(drm_plane_force_disable);
455 * drm_mode_plane_set_obj_prop - set the value of a property
456 * @plane: drm plane object to set property value for
457 * @property: property to set
458 * @value: value the property should be set to
460 * This functions sets a given property on a given plane object. This function
461 * calls the driver's ->set_property callback and changes the software state of
462 * the property if the callback succeeds.
465 * Zero on success, error code on failure.
467 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
468 struct drm_property *property,
472 struct drm_mode_object *obj = &plane->base;
474 if (plane->funcs->set_property)
475 ret = plane->funcs->set_property(plane, property, value);
477 drm_object_property_set_value(obj, property, value);
481 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
483 int drm_mode_getplane_res(struct drm_device *dev, void *data,
484 struct drm_file *file_priv)
486 struct drm_mode_get_plane_res *plane_resp = data;
487 struct drm_plane *plane;
488 uint32_t __user *plane_ptr;
491 if (!drm_core_check_feature(dev, DRIVER_MODESET))
494 plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
497 * This ioctl is called twice, once to determine how much space is
498 * needed, and the 2nd time to fill it.
500 drm_for_each_plane(plane, dev) {
502 * Unless userspace set the 'universal planes'
503 * capability bit, only advertise overlays.
505 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
506 !file_priv->universal_planes)
509 if (drm_lease_held(file_priv, plane->base.id)) {
510 if (count < plane_resp->count_planes &&
511 put_user(plane->base.id, plane_ptr + count))
516 plane_resp->count_planes = count;
521 int drm_mode_getplane(struct drm_device *dev, void *data,
522 struct drm_file *file_priv)
524 struct drm_mode_get_plane *plane_resp = data;
525 struct drm_plane *plane;
526 uint32_t __user *format_ptr;
528 if (!drm_core_check_feature(dev, DRIVER_MODESET))
531 plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
535 drm_modeset_lock(&plane->mutex, NULL);
536 if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
537 plane_resp->crtc_id = plane->state->crtc->base.id;
538 else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
539 plane_resp->crtc_id = plane->crtc->base.id;
541 plane_resp->crtc_id = 0;
543 if (plane->state && plane->state->fb)
544 plane_resp->fb_id = plane->state->fb->base.id;
545 else if (!plane->state && plane->fb)
546 plane_resp->fb_id = plane->fb->base.id;
548 plane_resp->fb_id = 0;
549 drm_modeset_unlock(&plane->mutex);
551 plane_resp->plane_id = plane->base.id;
552 plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
553 plane->possible_crtcs);
555 plane_resp->gamma_size = 0;
558 * This ioctl is called twice, once to determine how much space is
559 * needed, and the 2nd time to fill it.
561 if (plane->format_count &&
562 (plane_resp->count_format_types >= plane->format_count)) {
563 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
564 if (copy_to_user(format_ptr,
566 sizeof(uint32_t) * plane->format_count)) {
570 plane_resp->count_format_types = plane->format_count;
575 int drm_plane_check_pixel_format(struct drm_plane *plane,
576 u32 format, u64 modifier)
580 for (i = 0; i < plane->format_count; i++) {
581 if (format == plane->format_types[i])
584 if (i == plane->format_count)
587 if (plane->funcs->format_mod_supported) {
588 if (!plane->funcs->format_mod_supported(plane, format, modifier))
591 if (!plane->modifier_count)
594 for (i = 0; i < plane->modifier_count; i++) {
595 if (modifier == plane->modifiers[i])
598 if (i == plane->modifier_count)
605 static int __setplane_check(struct drm_plane *plane,
606 struct drm_crtc *crtc,
607 struct drm_framebuffer *fb,
608 int32_t crtc_x, int32_t crtc_y,
609 uint32_t crtc_w, uint32_t crtc_h,
610 uint32_t src_x, uint32_t src_y,
611 uint32_t src_w, uint32_t src_h)
615 /* Check whether this plane is usable on this CRTC */
616 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
617 DRM_DEBUG_KMS("Invalid crtc for plane\n");
621 /* Check whether this plane supports the fb pixel format. */
622 ret = drm_plane_check_pixel_format(plane, fb->format->format,
625 struct drm_format_name_buf format_name;
627 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
628 drm_get_format_name(fb->format->format,
634 /* Give drivers some help against integer overflows */
635 if (crtc_w > INT_MAX ||
636 crtc_x > INT_MAX - (int32_t) crtc_w ||
638 crtc_y > INT_MAX - (int32_t) crtc_h) {
639 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
640 crtc_w, crtc_h, crtc_x, crtc_y);
644 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
652 * drm_any_plane_has_format - Check whether any plane supports this format and modifier combination
654 * @format: pixel format (DRM_FORMAT_*)
655 * @modifier: data layout modifier
658 * Whether at least one plane supports the specified format and modifier combination.
660 bool drm_any_plane_has_format(struct drm_device *dev,
661 u32 format, u64 modifier)
663 struct drm_plane *plane;
665 drm_for_each_plane(plane, dev) {
666 if (drm_plane_check_pixel_format(plane, format, modifier) == 0)
672 EXPORT_SYMBOL(drm_any_plane_has_format);
675 * __setplane_internal - setplane handler for internal callers
677 * This function will take a reference on the new fb for the plane
680 * src_{x,y,w,h} are provided in 16.16 fixed point format
682 static int __setplane_internal(struct drm_plane *plane,
683 struct drm_crtc *crtc,
684 struct drm_framebuffer *fb,
685 int32_t crtc_x, int32_t crtc_y,
686 uint32_t crtc_w, uint32_t crtc_h,
687 /* src_{x,y,w,h} values are 16.16 fixed point */
688 uint32_t src_x, uint32_t src_y,
689 uint32_t src_w, uint32_t src_h,
690 struct drm_modeset_acquire_ctx *ctx)
694 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
696 /* No fb means shut it down */
698 plane->old_fb = plane->fb;
699 ret = plane->funcs->disable_plane(plane, ctx);
704 plane->old_fb = NULL;
709 ret = __setplane_check(plane, crtc, fb,
710 crtc_x, crtc_y, crtc_w, crtc_h,
711 src_x, src_y, src_w, src_h);
715 plane->old_fb = plane->fb;
716 ret = plane->funcs->update_plane(plane, crtc, fb,
717 crtc_x, crtc_y, crtc_w, crtc_h,
718 src_x, src_y, src_w, src_h, ctx);
722 drm_framebuffer_get(plane->fb);
724 plane->old_fb = NULL;
729 drm_framebuffer_put(plane->old_fb);
730 plane->old_fb = NULL;
735 static int __setplane_atomic(struct drm_plane *plane,
736 struct drm_crtc *crtc,
737 struct drm_framebuffer *fb,
738 int32_t crtc_x, int32_t crtc_y,
739 uint32_t crtc_w, uint32_t crtc_h,
740 uint32_t src_x, uint32_t src_y,
741 uint32_t src_w, uint32_t src_h,
742 struct drm_modeset_acquire_ctx *ctx)
746 WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev));
748 /* No fb means shut it down */
750 return plane->funcs->disable_plane(plane, ctx);
753 * FIXME: This is redundant with drm_atomic_plane_check(),
754 * but the legacy cursor/"async" .update_plane() tricks
755 * don't call that so we still need this here. Should remove
756 * this when all .update_plane() implementations have been
757 * fixed to call drm_atomic_plane_check().
759 ret = __setplane_check(plane, crtc, fb,
760 crtc_x, crtc_y, crtc_w, crtc_h,
761 src_x, src_y, src_w, src_h);
765 return plane->funcs->update_plane(plane, crtc, fb,
766 crtc_x, crtc_y, crtc_w, crtc_h,
767 src_x, src_y, src_w, src_h, ctx);
770 static int setplane_internal(struct drm_plane *plane,
771 struct drm_crtc *crtc,
772 struct drm_framebuffer *fb,
773 int32_t crtc_x, int32_t crtc_y,
774 uint32_t crtc_w, uint32_t crtc_h,
775 /* src_{x,y,w,h} values are 16.16 fixed point */
776 uint32_t src_x, uint32_t src_y,
777 uint32_t src_w, uint32_t src_h)
779 struct drm_modeset_acquire_ctx ctx;
782 DRM_MODESET_LOCK_ALL_BEGIN(plane->dev, ctx,
783 DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
785 if (drm_drv_uses_atomic_modeset(plane->dev))
786 ret = __setplane_atomic(plane, crtc, fb,
787 crtc_x, crtc_y, crtc_w, crtc_h,
788 src_x, src_y, src_w, src_h, &ctx);
790 ret = __setplane_internal(plane, crtc, fb,
791 crtc_x, crtc_y, crtc_w, crtc_h,
792 src_x, src_y, src_w, src_h, &ctx);
794 DRM_MODESET_LOCK_ALL_END(ctx, ret);
799 int drm_mode_setplane(struct drm_device *dev, void *data,
800 struct drm_file *file_priv)
802 struct drm_mode_set_plane *plane_req = data;
803 struct drm_plane *plane;
804 struct drm_crtc *crtc = NULL;
805 struct drm_framebuffer *fb = NULL;
808 if (!drm_core_check_feature(dev, DRIVER_MODESET))
812 * First, find the plane, crtc, and fb objects. If not available,
813 * we don't bother to call the driver.
815 plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
817 DRM_DEBUG_KMS("Unknown plane ID %d\n",
818 plane_req->plane_id);
822 if (plane_req->fb_id) {
823 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
825 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
830 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
832 drm_framebuffer_put(fb);
833 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
839 ret = setplane_internal(plane, crtc, fb,
840 plane_req->crtc_x, plane_req->crtc_y,
841 plane_req->crtc_w, plane_req->crtc_h,
842 plane_req->src_x, plane_req->src_y,
843 plane_req->src_w, plane_req->src_h);
846 drm_framebuffer_put(fb);
851 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
852 struct drm_mode_cursor2 *req,
853 struct drm_file *file_priv,
854 struct drm_modeset_acquire_ctx *ctx)
856 struct drm_device *dev = crtc->dev;
857 struct drm_plane *plane = crtc->cursor;
858 struct drm_framebuffer *fb = NULL;
859 struct drm_mode_fb_cmd2 fbreq = {
861 .height = req->height,
862 .pixel_format = DRM_FORMAT_ARGB8888,
863 .pitches = { req->width * 4 },
864 .handles = { req->handle },
866 int32_t crtc_x, crtc_y;
867 uint32_t crtc_w = 0, crtc_h = 0;
868 uint32_t src_w = 0, src_h = 0;
872 WARN_ON(plane->crtc != crtc && plane->crtc != NULL);
875 * Obtain fb we'll be using (either new or existing) and take an extra
876 * reference to it if fb != null. setplane will take care of dropping
877 * the reference if the plane update fails.
879 if (req->flags & DRM_MODE_CURSOR_BO) {
881 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
883 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
887 fb->hot_x = req->hot_x;
888 fb->hot_y = req->hot_y;
894 fb = plane->state->fb;
899 drm_framebuffer_get(fb);
902 if (req->flags & DRM_MODE_CURSOR_MOVE) {
906 crtc_x = crtc->cursor_x;
907 crtc_y = crtc->cursor_y;
913 src_w = fb->width << 16;
914 src_h = fb->height << 16;
917 if (drm_drv_uses_atomic_modeset(dev))
918 ret = __setplane_atomic(plane, crtc, fb,
919 crtc_x, crtc_y, crtc_w, crtc_h,
920 0, 0, src_w, src_h, ctx);
922 ret = __setplane_internal(plane, crtc, fb,
923 crtc_x, crtc_y, crtc_w, crtc_h,
924 0, 0, src_w, src_h, ctx);
927 drm_framebuffer_put(fb);
929 /* Update successful; save new cursor position, if necessary */
930 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
931 crtc->cursor_x = req->x;
932 crtc->cursor_y = req->y;
938 static int drm_mode_cursor_common(struct drm_device *dev,
939 struct drm_mode_cursor2 *req,
940 struct drm_file *file_priv)
942 struct drm_crtc *crtc;
943 struct drm_modeset_acquire_ctx ctx;
946 if (!drm_core_check_feature(dev, DRIVER_MODESET))
949 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
952 crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
954 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
958 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
960 ret = drm_modeset_lock(&crtc->mutex, &ctx);
964 * If this crtc has a universal cursor plane, call that plane's update
965 * handler rather than using legacy cursor handlers.
968 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
972 if (!drm_lease_held(file_priv, crtc->cursor->base.id)) {
977 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
981 if (req->flags & DRM_MODE_CURSOR_BO) {
982 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
986 /* Turns off the cursor if handle is 0 */
987 if (crtc->funcs->cursor_set2)
988 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
989 req->width, req->height, req->hot_x, req->hot_y);
991 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
992 req->width, req->height);
995 if (req->flags & DRM_MODE_CURSOR_MOVE) {
996 if (crtc->funcs->cursor_move) {
997 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
1004 if (ret == -EDEADLK) {
1005 ret = drm_modeset_backoff(&ctx);
1010 drm_modeset_drop_locks(&ctx);
1011 drm_modeset_acquire_fini(&ctx);
1018 int drm_mode_cursor_ioctl(struct drm_device *dev,
1019 void *data, struct drm_file *file_priv)
1021 struct drm_mode_cursor *req = data;
1022 struct drm_mode_cursor2 new_req;
1024 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
1025 new_req.hot_x = new_req.hot_y = 0;
1027 return drm_mode_cursor_common(dev, &new_req, file_priv);
1031 * Set the cursor configuration based on user request. This implements the 2nd
1032 * version of the cursor ioctl, which allows userspace to additionally specify
1033 * the hotspot of the pointer.
1035 int drm_mode_cursor2_ioctl(struct drm_device *dev,
1036 void *data, struct drm_file *file_priv)
1038 struct drm_mode_cursor2 *req = data;
1040 return drm_mode_cursor_common(dev, req, file_priv);
1043 int drm_mode_page_flip_ioctl(struct drm_device *dev,
1044 void *data, struct drm_file *file_priv)
1046 struct drm_mode_crtc_page_flip_target *page_flip = data;
1047 struct drm_crtc *crtc;
1048 struct drm_plane *plane;
1049 struct drm_framebuffer *fb = NULL, *old_fb;
1050 struct drm_pending_vblank_event *e = NULL;
1051 u32 target_vblank = page_flip->sequence;
1052 struct drm_modeset_acquire_ctx ctx;
1055 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1058 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
1061 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
1064 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
1067 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
1070 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
1073 crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
1077 plane = crtc->primary;
1079 if (!drm_lease_held(file_priv, plane->base.id))
1082 if (crtc->funcs->page_flip_target) {
1086 r = drm_crtc_vblank_get(crtc);
1090 current_vblank = (u32)drm_crtc_vblank_count(crtc);
1092 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
1093 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
1094 if ((int)(target_vblank - current_vblank) > 1) {
1095 DRM_DEBUG("Invalid absolute flip target %u, "
1096 "must be <= %u\n", target_vblank,
1097 current_vblank + 1);
1098 drm_crtc_vblank_put(crtc);
1102 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
1103 if (target_vblank != 0 && target_vblank != 1) {
1104 DRM_DEBUG("Invalid relative flip target %u, "
1105 "must be 0 or 1\n", target_vblank);
1106 drm_crtc_vblank_put(crtc);
1109 target_vblank += current_vblank;
1112 target_vblank = current_vblank +
1113 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
1116 } else if (crtc->funcs->page_flip == NULL ||
1117 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
1121 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1123 ret = drm_modeset_lock(&crtc->mutex, &ctx);
1126 ret = drm_modeset_lock(&plane->mutex, &ctx);
1131 old_fb = plane->state->fb;
1135 if (old_fb == NULL) {
1136 /* The framebuffer is currently unbound, presumably
1137 * due to a hotplug event, that userspace has not
1144 fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
1151 const struct drm_plane_state *state = plane->state;
1153 ret = drm_framebuffer_check_src_coords(state->src_x,
1159 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y,
1165 if (old_fb->format != fb->format) {
1166 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1171 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1172 e = kzalloc(sizeof *e, GFP_KERNEL);
1178 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1179 e->event.base.length = sizeof(e->event);
1180 e->event.vbl.user_data = page_flip->user_data;
1181 e->event.vbl.crtc_id = crtc->base.id;
1183 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1191 plane->old_fb = plane->fb;
1192 if (crtc->funcs->page_flip_target)
1193 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1198 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1201 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1202 drm_event_cancel_free(dev, &e->base);
1203 /* Keep the old fb, don't unref it. */
1204 plane->old_fb = NULL;
1206 if (!plane->state) {
1208 drm_framebuffer_get(fb);
1214 drm_framebuffer_put(fb);
1216 drm_framebuffer_put(plane->old_fb);
1217 plane->old_fb = NULL;
1219 if (ret == -EDEADLK) {
1220 ret = drm_modeset_backoff(&ctx);
1225 drm_modeset_drop_locks(&ctx);
1226 drm_modeset_acquire_fini(&ctx);
1228 if (ret && crtc->funcs->page_flip_target)
1229 drm_crtc_vblank_put(crtc);