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 = 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 /* plane index is used with 32bit bitmasks */
177 if (WARN_ON(config->num_total_plane >= 32))
180 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
181 (!funcs->atomic_destroy_state ||
182 !funcs->atomic_duplicate_state));
184 ret = drm_mode_object_add(dev, &plane->base, DRM_MODE_OBJECT_PLANE);
188 drm_modeset_lock_init(&plane->mutex);
190 plane->base.properties = &plane->properties;
192 plane->funcs = funcs;
193 plane->format_types = kmalloc_array(format_count, sizeof(uint32_t),
195 if (!plane->format_types) {
196 DRM_DEBUG_KMS("out of memory when allocating plane\n");
197 drm_mode_object_unregister(dev, &plane->base);
202 * First driver to need more than 64 formats needs to fix this. Each
203 * format is encoded as a bit and the current code only supports a u64.
205 if (WARN_ON(format_count > 64))
208 if (format_modifiers) {
209 const uint64_t *temp_modifiers = format_modifiers;
210 while (*temp_modifiers++ != DRM_FORMAT_MOD_INVALID)
211 format_modifier_count++;
214 plane->modifier_count = format_modifier_count;
215 plane->modifiers = kmalloc_array(format_modifier_count,
216 sizeof(format_modifiers[0]),
219 if (format_modifier_count && !plane->modifiers) {
220 DRM_DEBUG_KMS("out of memory when allocating plane\n");
221 kfree(plane->format_types);
222 drm_mode_object_unregister(dev, &plane->base);
230 plane->name = kvasprintf(GFP_KERNEL, name, ap);
233 plane->name = kasprintf(GFP_KERNEL, "plane-%d",
234 drm_num_planes(dev));
237 kfree(plane->format_types);
238 kfree(plane->modifiers);
239 drm_mode_object_unregister(dev, &plane->base);
243 memcpy(plane->format_types, formats, format_count * sizeof(uint32_t));
244 plane->format_count = format_count;
245 memcpy(plane->modifiers, format_modifiers,
246 format_modifier_count * sizeof(format_modifiers[0]));
247 plane->possible_crtcs = possible_crtcs;
250 list_add_tail(&plane->head, &config->plane_list);
251 plane->index = config->num_total_plane++;
253 drm_object_attach_property(&plane->base,
254 config->plane_type_property,
257 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
258 drm_object_attach_property(&plane->base, config->prop_fb_id, 0);
259 drm_object_attach_property(&plane->base, config->prop_in_fence_fd, -1);
260 drm_object_attach_property(&plane->base, config->prop_crtc_id, 0);
261 drm_object_attach_property(&plane->base, config->prop_crtc_x, 0);
262 drm_object_attach_property(&plane->base, config->prop_crtc_y, 0);
263 drm_object_attach_property(&plane->base, config->prop_crtc_w, 0);
264 drm_object_attach_property(&plane->base, config->prop_crtc_h, 0);
265 drm_object_attach_property(&plane->base, config->prop_src_x, 0);
266 drm_object_attach_property(&plane->base, config->prop_src_y, 0);
267 drm_object_attach_property(&plane->base, config->prop_src_w, 0);
268 drm_object_attach_property(&plane->base, config->prop_src_h, 0);
271 if (config->allow_fb_modifiers)
272 create_in_format_blob(dev, plane);
276 EXPORT_SYMBOL(drm_universal_plane_init);
278 int drm_plane_register_all(struct drm_device *dev)
280 struct drm_plane *plane;
283 drm_for_each_plane(plane, dev) {
284 if (plane->funcs->late_register)
285 ret = plane->funcs->late_register(plane);
293 void drm_plane_unregister_all(struct drm_device *dev)
295 struct drm_plane *plane;
297 drm_for_each_plane(plane, dev) {
298 if (plane->funcs->early_unregister)
299 plane->funcs->early_unregister(plane);
304 * drm_plane_init - Initialize a legacy plane
306 * @plane: plane object to init
307 * @possible_crtcs: bitmask of possible CRTCs
308 * @funcs: callbacks for the new plane
309 * @formats: array of supported formats (DRM_FORMAT\_\*)
310 * @format_count: number of elements in @formats
311 * @is_primary: plane type (primary vs overlay)
313 * Legacy API to initialize a DRM plane.
315 * New drivers should call drm_universal_plane_init() instead.
318 * Zero on success, error code on failure.
320 int drm_plane_init(struct drm_device *dev, struct drm_plane *plane,
321 uint32_t possible_crtcs,
322 const struct drm_plane_funcs *funcs,
323 const uint32_t *formats, unsigned int format_count,
326 enum drm_plane_type type;
328 type = is_primary ? DRM_PLANE_TYPE_PRIMARY : DRM_PLANE_TYPE_OVERLAY;
329 return drm_universal_plane_init(dev, plane, possible_crtcs, funcs,
330 formats, format_count,
333 EXPORT_SYMBOL(drm_plane_init);
336 * drm_plane_cleanup - Clean up the core plane usage
337 * @plane: plane to cleanup
339 * This function cleans up @plane and removes it from the DRM mode setting
340 * core. Note that the function does *not* free the plane structure itself,
341 * this is the responsibility of the caller.
343 void drm_plane_cleanup(struct drm_plane *plane)
345 struct drm_device *dev = plane->dev;
347 drm_modeset_lock_fini(&plane->mutex);
349 kfree(plane->format_types);
350 kfree(plane->modifiers);
351 drm_mode_object_unregister(dev, &plane->base);
353 BUG_ON(list_empty(&plane->head));
355 /* Note that the plane_list is considered to be static; should we
356 * remove the drm_plane at runtime we would have to decrement all
357 * the indices on the drm_plane after us in the plane_list.
360 list_del(&plane->head);
361 dev->mode_config.num_total_plane--;
363 WARN_ON(plane->state && !plane->funcs->atomic_destroy_state);
364 if (plane->state && plane->funcs->atomic_destroy_state)
365 plane->funcs->atomic_destroy_state(plane, plane->state);
369 memset(plane, 0, sizeof(*plane));
371 EXPORT_SYMBOL(drm_plane_cleanup);
374 * drm_plane_from_index - find the registered plane at an index
376 * @idx: index of registered plane to find for
378 * Given a plane index, return the registered plane from DRM device's
379 * list of planes with matching index. This is the inverse of drm_plane_index().
382 drm_plane_from_index(struct drm_device *dev, int idx)
384 struct drm_plane *plane;
386 drm_for_each_plane(plane, dev)
387 if (idx == plane->index)
392 EXPORT_SYMBOL(drm_plane_from_index);
395 * drm_plane_force_disable - Forcibly disable a plane
396 * @plane: plane to disable
398 * Forces the plane to be disabled.
400 * Used when the plane's current framebuffer is destroyed,
401 * and when restoring fbdev mode.
403 * Note that this function is not suitable for atomic drivers, since it doesn't
404 * wire through the lock acquisition context properly and hence can't handle
405 * retries or driver private locks. You probably want to use
406 * drm_atomic_helper_disable_plane() or
407 * drm_atomic_helper_disable_planes_on_crtc() instead.
409 void drm_plane_force_disable(struct drm_plane *plane)
416 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
418 plane->old_fb = plane->fb;
419 ret = plane->funcs->disable_plane(plane, NULL);
421 DRM_ERROR("failed to disable plane with busy fb\n");
422 plane->old_fb = NULL;
425 /* disconnect the plane from the fb and crtc: */
426 drm_framebuffer_put(plane->old_fb);
427 plane->old_fb = NULL;
431 EXPORT_SYMBOL(drm_plane_force_disable);
434 * drm_mode_plane_set_obj_prop - set the value of a property
435 * @plane: drm plane object to set property value for
436 * @property: property to set
437 * @value: value the property should be set to
439 * This functions sets a given property on a given plane object. This function
440 * calls the driver's ->set_property callback and changes the software state of
441 * the property if the callback succeeds.
444 * Zero on success, error code on failure.
446 int drm_mode_plane_set_obj_prop(struct drm_plane *plane,
447 struct drm_property *property,
451 struct drm_mode_object *obj = &plane->base;
453 if (plane->funcs->set_property)
454 ret = plane->funcs->set_property(plane, property, value);
456 drm_object_property_set_value(obj, property, value);
460 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop);
462 int drm_mode_getplane_res(struct drm_device *dev, void *data,
463 struct drm_file *file_priv)
465 struct drm_mode_get_plane_res *plane_resp = data;
466 struct drm_mode_config *config;
467 struct drm_plane *plane;
468 uint32_t __user *plane_ptr;
471 if (!drm_core_check_feature(dev, DRIVER_MODESET))
474 config = &dev->mode_config;
475 plane_ptr = u64_to_user_ptr(plane_resp->plane_id_ptr);
478 * This ioctl is called twice, once to determine how much space is
479 * needed, and the 2nd time to fill it.
481 drm_for_each_plane(plane, dev) {
483 * Unless userspace set the 'universal planes'
484 * capability bit, only advertise overlays.
486 if (plane->type != DRM_PLANE_TYPE_OVERLAY &&
487 !file_priv->universal_planes)
490 if (drm_lease_held(file_priv, plane->base.id)) {
491 if (count < plane_resp->count_planes &&
492 put_user(plane->base.id, plane_ptr + count))
497 plane_resp->count_planes = count;
502 int drm_mode_getplane(struct drm_device *dev, void *data,
503 struct drm_file *file_priv)
505 struct drm_mode_get_plane *plane_resp = data;
506 struct drm_plane *plane;
507 uint32_t __user *format_ptr;
509 if (!drm_core_check_feature(dev, DRIVER_MODESET))
512 plane = drm_plane_find(dev, file_priv, plane_resp->plane_id);
516 drm_modeset_lock(&plane->mutex, NULL);
517 if (plane->state && plane->state->crtc && drm_lease_held(file_priv, plane->state->crtc->base.id))
518 plane_resp->crtc_id = plane->state->crtc->base.id;
519 else if (!plane->state && plane->crtc && drm_lease_held(file_priv, plane->crtc->base.id))
520 plane_resp->crtc_id = plane->crtc->base.id;
522 plane_resp->crtc_id = 0;
524 if (plane->state && plane->state->fb)
525 plane_resp->fb_id = plane->state->fb->base.id;
526 else if (!plane->state && plane->fb)
527 plane_resp->fb_id = plane->fb->base.id;
529 plane_resp->fb_id = 0;
530 drm_modeset_unlock(&plane->mutex);
532 plane_resp->plane_id = plane->base.id;
533 plane_resp->possible_crtcs = drm_lease_filter_crtcs(file_priv,
534 plane->possible_crtcs);
536 plane_resp->gamma_size = 0;
539 * This ioctl is called twice, once to determine how much space is
540 * needed, and the 2nd time to fill it.
542 if (plane->format_count &&
543 (plane_resp->count_format_types >= plane->format_count)) {
544 format_ptr = (uint32_t __user *)(unsigned long)plane_resp->format_type_ptr;
545 if (copy_to_user(format_ptr,
547 sizeof(uint32_t) * plane->format_count)) {
551 plane_resp->count_format_types = plane->format_count;
556 int drm_plane_check_pixel_format(struct drm_plane *plane,
557 u32 format, u64 modifier)
561 for (i = 0; i < plane->format_count; i++) {
562 if (format == plane->format_types[i])
565 if (i == plane->format_count)
568 if (plane->funcs->format_mod_supported) {
569 if (!plane->funcs->format_mod_supported(plane, format, modifier))
572 if (!plane->modifier_count)
575 for (i = 0; i < plane->modifier_count; i++) {
576 if (modifier == plane->modifiers[i])
579 if (i == plane->modifier_count)
586 static int __setplane_check(struct drm_plane *plane,
587 struct drm_crtc *crtc,
588 struct drm_framebuffer *fb,
589 int32_t crtc_x, int32_t crtc_y,
590 uint32_t crtc_w, uint32_t crtc_h,
591 uint32_t src_x, uint32_t src_y,
592 uint32_t src_w, uint32_t src_h)
596 /* Check whether this plane is usable on this CRTC */
597 if (!(plane->possible_crtcs & drm_crtc_mask(crtc))) {
598 DRM_DEBUG_KMS("Invalid crtc for plane\n");
602 /* Check whether this plane supports the fb pixel format. */
603 ret = drm_plane_check_pixel_format(plane, fb->format->format,
606 struct drm_format_name_buf format_name;
608 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
609 drm_get_format_name(fb->format->format,
615 /* Give drivers some help against integer overflows */
616 if (crtc_w > INT_MAX ||
617 crtc_x > INT_MAX - (int32_t) crtc_w ||
619 crtc_y > INT_MAX - (int32_t) crtc_h) {
620 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
621 crtc_w, crtc_h, crtc_x, crtc_y);
625 ret = drm_framebuffer_check_src_coords(src_x, src_y, src_w, src_h, fb);
633 * __setplane_internal - setplane handler for internal callers
635 * This function will take a reference on the new fb for the plane
638 * src_{x,y,w,h} are provided in 16.16 fixed point format
640 static int __setplane_internal(struct drm_plane *plane,
641 struct drm_crtc *crtc,
642 struct drm_framebuffer *fb,
643 int32_t crtc_x, int32_t crtc_y,
644 uint32_t crtc_w, uint32_t crtc_h,
645 /* src_{x,y,w,h} values are 16.16 fixed point */
646 uint32_t src_x, uint32_t src_y,
647 uint32_t src_w, uint32_t src_h,
648 struct drm_modeset_acquire_ctx *ctx)
652 WARN_ON(drm_drv_uses_atomic_modeset(plane->dev));
654 /* No fb means shut it down */
656 plane->old_fb = plane->fb;
657 ret = plane->funcs->disable_plane(plane, ctx);
662 plane->old_fb = NULL;
667 ret = __setplane_check(plane, crtc, fb,
668 crtc_x, crtc_y, crtc_w, crtc_h,
669 src_x, src_y, src_w, src_h);
673 plane->old_fb = plane->fb;
674 ret = plane->funcs->update_plane(plane, crtc, fb,
675 crtc_x, crtc_y, crtc_w, crtc_h,
676 src_x, src_y, src_w, src_h, ctx);
680 drm_framebuffer_get(plane->fb);
682 plane->old_fb = NULL;
687 drm_framebuffer_put(plane->old_fb);
688 plane->old_fb = NULL;
693 static int __setplane_atomic(struct drm_plane *plane,
694 struct drm_crtc *crtc,
695 struct drm_framebuffer *fb,
696 int32_t crtc_x, int32_t crtc_y,
697 uint32_t crtc_w, uint32_t crtc_h,
698 uint32_t src_x, uint32_t src_y,
699 uint32_t src_w, uint32_t src_h,
700 struct drm_modeset_acquire_ctx *ctx)
704 WARN_ON(!drm_drv_uses_atomic_modeset(plane->dev));
706 /* No fb means shut it down */
708 return plane->funcs->disable_plane(plane, ctx);
711 * FIXME: This is redundant with drm_atomic_plane_check(),
712 * but the legacy cursor/"async" .update_plane() tricks
713 * don't call that so we still need this here. Should remove
714 * this when all .update_plane() implementations have been
715 * fixed to call drm_atomic_plane_check().
717 ret = __setplane_check(plane, crtc, fb,
718 crtc_x, crtc_y, crtc_w, crtc_h,
719 src_x, src_y, src_w, src_h);
723 return plane->funcs->update_plane(plane, crtc, fb,
724 crtc_x, crtc_y, crtc_w, crtc_h,
725 src_x, src_y, src_w, src_h, ctx);
728 static int setplane_internal(struct drm_plane *plane,
729 struct drm_crtc *crtc,
730 struct drm_framebuffer *fb,
731 int32_t crtc_x, int32_t crtc_y,
732 uint32_t crtc_w, uint32_t crtc_h,
733 /* src_{x,y,w,h} values are 16.16 fixed point */
734 uint32_t src_x, uint32_t src_y,
735 uint32_t src_w, uint32_t src_h)
737 struct drm_modeset_acquire_ctx ctx;
740 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
742 ret = drm_modeset_lock_all_ctx(plane->dev, &ctx);
746 if (drm_drv_uses_atomic_modeset(plane->dev))
747 ret = __setplane_atomic(plane, crtc, fb,
748 crtc_x, crtc_y, crtc_w, crtc_h,
749 src_x, src_y, src_w, src_h, &ctx);
751 ret = __setplane_internal(plane, crtc, fb,
752 crtc_x, crtc_y, crtc_w, crtc_h,
753 src_x, src_y, src_w, src_h, &ctx);
756 if (ret == -EDEADLK) {
757 ret = drm_modeset_backoff(&ctx);
761 drm_modeset_drop_locks(&ctx);
762 drm_modeset_acquire_fini(&ctx);
767 int drm_mode_setplane(struct drm_device *dev, void *data,
768 struct drm_file *file_priv)
770 struct drm_mode_set_plane *plane_req = data;
771 struct drm_plane *plane;
772 struct drm_crtc *crtc = NULL;
773 struct drm_framebuffer *fb = NULL;
776 if (!drm_core_check_feature(dev, DRIVER_MODESET))
780 * First, find the plane, crtc, and fb objects. If not available,
781 * we don't bother to call the driver.
783 plane = drm_plane_find(dev, file_priv, plane_req->plane_id);
785 DRM_DEBUG_KMS("Unknown plane ID %d\n",
786 plane_req->plane_id);
790 if (plane_req->fb_id) {
791 fb = drm_framebuffer_lookup(dev, file_priv, plane_req->fb_id);
793 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
798 crtc = drm_crtc_find(dev, file_priv, plane_req->crtc_id);
800 drm_framebuffer_put(fb);
801 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
807 ret = setplane_internal(plane, crtc, fb,
808 plane_req->crtc_x, plane_req->crtc_y,
809 plane_req->crtc_w, plane_req->crtc_h,
810 plane_req->src_x, plane_req->src_y,
811 plane_req->src_w, plane_req->src_h);
814 drm_framebuffer_put(fb);
819 static int drm_mode_cursor_universal(struct drm_crtc *crtc,
820 struct drm_mode_cursor2 *req,
821 struct drm_file *file_priv,
822 struct drm_modeset_acquire_ctx *ctx)
824 struct drm_device *dev = crtc->dev;
825 struct drm_plane *plane = crtc->cursor;
826 struct drm_framebuffer *fb = NULL;
827 struct drm_mode_fb_cmd2 fbreq = {
829 .height = req->height,
830 .pixel_format = DRM_FORMAT_ARGB8888,
831 .pitches = { req->width * 4 },
832 .handles = { req->handle },
834 int32_t crtc_x, crtc_y;
835 uint32_t crtc_w = 0, crtc_h = 0;
836 uint32_t src_w = 0, src_h = 0;
840 WARN_ON(plane->crtc != crtc && plane->crtc != NULL);
843 * Obtain fb we'll be using (either new or existing) and take an extra
844 * reference to it if fb != null. setplane will take care of dropping
845 * the reference if the plane update fails.
847 if (req->flags & DRM_MODE_CURSOR_BO) {
849 fb = drm_internal_framebuffer_create(dev, &fbreq, file_priv);
851 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
855 fb->hot_x = req->hot_x;
856 fb->hot_y = req->hot_y;
862 fb = plane->state->fb;
867 drm_framebuffer_get(fb);
870 if (req->flags & DRM_MODE_CURSOR_MOVE) {
874 crtc_x = crtc->cursor_x;
875 crtc_y = crtc->cursor_y;
881 src_w = fb->width << 16;
882 src_h = fb->height << 16;
885 if (drm_drv_uses_atomic_modeset(dev))
886 ret = __setplane_atomic(plane, crtc, fb,
887 crtc_x, crtc_y, crtc_w, crtc_h,
888 0, 0, src_w, src_h, ctx);
890 ret = __setplane_internal(plane, crtc, fb,
891 crtc_x, crtc_y, crtc_w, crtc_h,
892 0, 0, src_w, src_h, ctx);
895 drm_framebuffer_put(fb);
897 /* Update successful; save new cursor position, if necessary */
898 if (ret == 0 && req->flags & DRM_MODE_CURSOR_MOVE) {
899 crtc->cursor_x = req->x;
900 crtc->cursor_y = req->y;
906 static int drm_mode_cursor_common(struct drm_device *dev,
907 struct drm_mode_cursor2 *req,
908 struct drm_file *file_priv)
910 struct drm_crtc *crtc;
911 struct drm_modeset_acquire_ctx ctx;
914 if (!drm_core_check_feature(dev, DRIVER_MODESET))
917 if (!req->flags || (~DRM_MODE_CURSOR_FLAGS & req->flags))
920 crtc = drm_crtc_find(dev, file_priv, req->crtc_id);
922 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req->crtc_id);
926 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
928 ret = drm_modeset_lock(&crtc->mutex, &ctx);
932 * If this crtc has a universal cursor plane, call that plane's update
933 * handler rather than using legacy cursor handlers.
936 ret = drm_modeset_lock(&crtc->cursor->mutex, &ctx);
940 ret = drm_mode_cursor_universal(crtc, req, file_priv, &ctx);
944 if (req->flags & DRM_MODE_CURSOR_BO) {
945 if (!crtc->funcs->cursor_set && !crtc->funcs->cursor_set2) {
949 /* Turns off the cursor if handle is 0 */
950 if (crtc->funcs->cursor_set2)
951 ret = crtc->funcs->cursor_set2(crtc, file_priv, req->handle,
952 req->width, req->height, req->hot_x, req->hot_y);
954 ret = crtc->funcs->cursor_set(crtc, file_priv, req->handle,
955 req->width, req->height);
958 if (req->flags & DRM_MODE_CURSOR_MOVE) {
959 if (crtc->funcs->cursor_move) {
960 ret = crtc->funcs->cursor_move(crtc, req->x, req->y);
967 if (ret == -EDEADLK) {
968 ret = drm_modeset_backoff(&ctx);
973 drm_modeset_drop_locks(&ctx);
974 drm_modeset_acquire_fini(&ctx);
981 int drm_mode_cursor_ioctl(struct drm_device *dev,
982 void *data, struct drm_file *file_priv)
984 struct drm_mode_cursor *req = data;
985 struct drm_mode_cursor2 new_req;
987 memcpy(&new_req, req, sizeof(struct drm_mode_cursor));
988 new_req.hot_x = new_req.hot_y = 0;
990 return drm_mode_cursor_common(dev, &new_req, file_priv);
994 * Set the cursor configuration based on user request. This implements the 2nd
995 * version of the cursor ioctl, which allows userspace to additionally specify
996 * the hotspot of the pointer.
998 int drm_mode_cursor2_ioctl(struct drm_device *dev,
999 void *data, struct drm_file *file_priv)
1001 struct drm_mode_cursor2 *req = data;
1003 return drm_mode_cursor_common(dev, req, file_priv);
1006 int drm_mode_page_flip_ioctl(struct drm_device *dev,
1007 void *data, struct drm_file *file_priv)
1009 struct drm_mode_crtc_page_flip_target *page_flip = data;
1010 struct drm_crtc *crtc;
1011 struct drm_plane *plane;
1012 struct drm_framebuffer *fb = NULL, *old_fb;
1013 struct drm_pending_vblank_event *e = NULL;
1014 u32 target_vblank = page_flip->sequence;
1015 struct drm_modeset_acquire_ctx ctx;
1018 if (!drm_core_check_feature(dev, DRIVER_MODESET))
1021 if (page_flip->flags & ~DRM_MODE_PAGE_FLIP_FLAGS)
1024 if (page_flip->sequence != 0 && !(page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET))
1027 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
1030 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) == DRM_MODE_PAGE_FLIP_TARGET)
1033 if ((page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC) && !dev->mode_config.async_page_flip)
1036 crtc = drm_crtc_find(dev, file_priv, page_flip->crtc_id);
1040 plane = crtc->primary;
1042 if (crtc->funcs->page_flip_target) {
1046 r = drm_crtc_vblank_get(crtc);
1050 current_vblank = (u32)drm_crtc_vblank_count(crtc);
1052 switch (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET) {
1053 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE:
1054 if ((int)(target_vblank - current_vblank) > 1) {
1055 DRM_DEBUG("Invalid absolute flip target %u, "
1056 "must be <= %u\n", target_vblank,
1057 current_vblank + 1);
1058 drm_crtc_vblank_put(crtc);
1062 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE:
1063 if (target_vblank != 0 && target_vblank != 1) {
1064 DRM_DEBUG("Invalid relative flip target %u, "
1065 "must be 0 or 1\n", target_vblank);
1066 drm_crtc_vblank_put(crtc);
1069 target_vblank += current_vblank;
1072 target_vblank = current_vblank +
1073 !(page_flip->flags & DRM_MODE_PAGE_FLIP_ASYNC);
1076 } else if (crtc->funcs->page_flip == NULL ||
1077 (page_flip->flags & DRM_MODE_PAGE_FLIP_TARGET)) {
1081 drm_modeset_acquire_init(&ctx, DRM_MODESET_ACQUIRE_INTERRUPTIBLE);
1083 ret = drm_modeset_lock(&crtc->mutex, &ctx);
1086 ret = drm_modeset_lock(&plane->mutex, &ctx);
1091 old_fb = plane->state->fb;
1095 if (old_fb == NULL) {
1096 /* The framebuffer is currently unbound, presumably
1097 * due to a hotplug event, that userspace has not
1104 fb = drm_framebuffer_lookup(dev, file_priv, page_flip->fb_id);
1111 const struct drm_plane_state *state = plane->state;
1113 ret = drm_framebuffer_check_src_coords(state->src_x,
1119 ret = drm_crtc_check_viewport(crtc, crtc->x, crtc->y,
1125 if (old_fb->format != fb->format) {
1126 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1131 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT) {
1132 e = kzalloc(sizeof *e, GFP_KERNEL);
1138 e->event.base.type = DRM_EVENT_FLIP_COMPLETE;
1139 e->event.base.length = sizeof(e->event);
1140 e->event.vbl.user_data = page_flip->user_data;
1141 e->event.vbl.crtc_id = crtc->base.id;
1143 ret = drm_event_reserve_init(dev, file_priv, &e->base, &e->event.base);
1151 plane->old_fb = plane->fb;
1152 if (crtc->funcs->page_flip_target)
1153 ret = crtc->funcs->page_flip_target(crtc, fb, e,
1158 ret = crtc->funcs->page_flip(crtc, fb, e, page_flip->flags,
1161 if (page_flip->flags & DRM_MODE_PAGE_FLIP_EVENT)
1162 drm_event_cancel_free(dev, &e->base);
1163 /* Keep the old fb, don't unref it. */
1164 plane->old_fb = NULL;
1166 if (!plane->state) {
1168 drm_framebuffer_get(fb);
1174 drm_framebuffer_put(fb);
1176 drm_framebuffer_put(plane->old_fb);
1177 plane->old_fb = NULL;
1179 if (ret == -EDEADLK) {
1180 ret = drm_modeset_backoff(&ctx);
1185 drm_modeset_drop_locks(&ctx);
1186 drm_modeset_acquire_fini(&ctx);
1188 if (ret && crtc->funcs->page_flip_target)
1189 drm_crtc_vblank_put(crtc);