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
++;
248 drm_object_attach_property(&plane
->base
,
249 config
->plane_type_property
,
252 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
253 drm_object_attach_property(&plane
->base
, config
->prop_fb_id
, 0);
254 drm_object_attach_property(&plane
->base
, config
->prop_in_fence_fd
, -1);
255 drm_object_attach_property(&plane
->base
, config
->prop_crtc_id
, 0);
256 drm_object_attach_property(&plane
->base
, config
->prop_crtc_x
, 0);
257 drm_object_attach_property(&plane
->base
, config
->prop_crtc_y
, 0);
258 drm_object_attach_property(&plane
->base
, config
->prop_crtc_w
, 0);
259 drm_object_attach_property(&plane
->base
, config
->prop_crtc_h
, 0);
260 drm_object_attach_property(&plane
->base
, config
->prop_src_x
, 0);
261 drm_object_attach_property(&plane
->base
, config
->prop_src_y
, 0);
262 drm_object_attach_property(&plane
->base
, config
->prop_src_w
, 0);
263 drm_object_attach_property(&plane
->base
, config
->prop_src_h
, 0);
266 if (config
->allow_fb_modifiers
)
267 create_in_format_blob(dev
, plane
);
271 EXPORT_SYMBOL(drm_universal_plane_init
);
273 int drm_plane_register_all(struct drm_device
*dev
)
275 struct drm_plane
*plane
;
278 drm_for_each_plane(plane
, dev
) {
279 if (plane
->funcs
->late_register
)
280 ret
= plane
->funcs
->late_register(plane
);
288 void drm_plane_unregister_all(struct drm_device
*dev
)
290 struct drm_plane
*plane
;
292 drm_for_each_plane(plane
, dev
) {
293 if (plane
->funcs
->early_unregister
)
294 plane
->funcs
->early_unregister(plane
);
299 * drm_plane_init - Initialize a legacy plane
301 * @plane: plane object to init
302 * @possible_crtcs: bitmask of possible CRTCs
303 * @funcs: callbacks for the new plane
304 * @formats: array of supported formats (DRM_FORMAT\_\*)
305 * @format_count: number of elements in @formats
306 * @is_primary: plane type (primary vs overlay)
308 * Legacy API to initialize a DRM plane.
310 * New drivers should call drm_universal_plane_init() instead.
313 * Zero on success, error code on failure.
315 int drm_plane_init(struct drm_device
*dev
, struct drm_plane
*plane
,
316 uint32_t possible_crtcs
,
317 const struct drm_plane_funcs
*funcs
,
318 const uint32_t *formats
, unsigned int format_count
,
321 enum drm_plane_type type
;
323 type
= is_primary
? DRM_PLANE_TYPE_PRIMARY
: DRM_PLANE_TYPE_OVERLAY
;
324 return drm_universal_plane_init(dev
, plane
, possible_crtcs
, funcs
,
325 formats
, format_count
,
328 EXPORT_SYMBOL(drm_plane_init
);
331 * drm_plane_cleanup - Clean up the core plane usage
332 * @plane: plane to cleanup
334 * This function cleans up @plane and removes it from the DRM mode setting
335 * core. Note that the function does *not* free the plane structure itself,
336 * this is the responsibility of the caller.
338 void drm_plane_cleanup(struct drm_plane
*plane
)
340 struct drm_device
*dev
= plane
->dev
;
342 drm_modeset_lock_fini(&plane
->mutex
);
344 kfree(plane
->format_types
);
345 kfree(plane
->modifiers
);
346 drm_mode_object_unregister(dev
, &plane
->base
);
348 BUG_ON(list_empty(&plane
->head
));
350 /* Note that the plane_list is considered to be static; should we
351 * remove the drm_plane at runtime we would have to decrement all
352 * the indices on the drm_plane after us in the plane_list.
355 list_del(&plane
->head
);
356 dev
->mode_config
.num_total_plane
--;
358 WARN_ON(plane
->state
&& !plane
->funcs
->atomic_destroy_state
);
359 if (plane
->state
&& plane
->funcs
->atomic_destroy_state
)
360 plane
->funcs
->atomic_destroy_state(plane
, plane
->state
);
364 memset(plane
, 0, sizeof(*plane
));
366 EXPORT_SYMBOL(drm_plane_cleanup
);
369 * drm_plane_from_index - find the registered plane at an index
371 * @idx: index of registered plane to find for
373 * Given a plane index, return the registered plane from DRM device's
374 * list of planes with matching index. This is the inverse of drm_plane_index().
377 drm_plane_from_index(struct drm_device
*dev
, int idx
)
379 struct drm_plane
*plane
;
381 drm_for_each_plane(plane
, dev
)
382 if (idx
== plane
->index
)
387 EXPORT_SYMBOL(drm_plane_from_index
);
390 * drm_plane_force_disable - Forcibly disable a plane
391 * @plane: plane to disable
393 * Forces the plane to be disabled.
395 * Used when the plane's current framebuffer is destroyed,
396 * and when restoring fbdev mode.
398 * Note that this function is not suitable for atomic drivers, since it doesn't
399 * wire through the lock acquisition context properly and hence can't handle
400 * retries or driver private locks. You probably want to use
401 * drm_atomic_helper_disable_plane() or
402 * drm_atomic_helper_disable_planes_on_crtc() instead.
404 void drm_plane_force_disable(struct drm_plane
*plane
)
411 WARN_ON(drm_drv_uses_atomic_modeset(plane
->dev
));
413 plane
->old_fb
= plane
->fb
;
414 ret
= plane
->funcs
->disable_plane(plane
, NULL
);
416 DRM_ERROR("failed to disable plane with busy fb\n");
417 plane
->old_fb
= NULL
;
420 /* disconnect the plane from the fb and crtc: */
421 drm_framebuffer_put(plane
->old_fb
);
422 plane
->old_fb
= NULL
;
426 EXPORT_SYMBOL(drm_plane_force_disable
);
429 * drm_mode_plane_set_obj_prop - set the value of a property
430 * @plane: drm plane object to set property value for
431 * @property: property to set
432 * @value: value the property should be set to
434 * This functions sets a given property on a given plane object. This function
435 * calls the driver's ->set_property callback and changes the software state of
436 * the property if the callback succeeds.
439 * Zero on success, error code on failure.
441 int drm_mode_plane_set_obj_prop(struct drm_plane
*plane
,
442 struct drm_property
*property
,
446 struct drm_mode_object
*obj
= &plane
->base
;
448 if (plane
->funcs
->set_property
)
449 ret
= plane
->funcs
->set_property(plane
, property
, value
);
451 drm_object_property_set_value(obj
, property
, value
);
455 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop
);
457 int drm_mode_getplane_res(struct drm_device
*dev
, void *data
,
458 struct drm_file
*file_priv
)
460 struct drm_mode_get_plane_res
*plane_resp
= data
;
461 struct drm_mode_config
*config
;
462 struct drm_plane
*plane
;
463 uint32_t __user
*plane_ptr
;
466 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
469 config
= &dev
->mode_config
;
470 plane_ptr
= u64_to_user_ptr(plane_resp
->plane_id_ptr
);
473 * This ioctl is called twice, once to determine how much space is
474 * needed, and the 2nd time to fill it.
476 drm_for_each_plane(plane
, dev
) {
478 * Unless userspace set the 'universal planes'
479 * capability bit, only advertise overlays.
481 if (plane
->type
!= DRM_PLANE_TYPE_OVERLAY
&&
482 !file_priv
->universal_planes
)
485 if (drm_lease_held(file_priv
, plane
->base
.id
)) {
486 if (count
< plane_resp
->count_planes
&&
487 put_user(plane
->base
.id
, plane_ptr
+ count
))
492 plane_resp
->count_planes
= count
;
497 int drm_mode_getplane(struct drm_device
*dev
, void *data
,
498 struct drm_file
*file_priv
)
500 struct drm_mode_get_plane
*plane_resp
= data
;
501 struct drm_plane
*plane
;
502 uint32_t __user
*format_ptr
;
504 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
507 plane
= drm_plane_find(dev
, file_priv
, plane_resp
->plane_id
);
511 drm_modeset_lock(&plane
->mutex
, NULL
);
512 if (plane
->state
&& plane
->state
->crtc
&& drm_lease_held(file_priv
, plane
->state
->crtc
->base
.id
))
513 plane_resp
->crtc_id
= plane
->state
->crtc
->base
.id
;
514 else if (!plane
->state
&& plane
->crtc
&& drm_lease_held(file_priv
, plane
->crtc
->base
.id
))
515 plane_resp
->crtc_id
= plane
->crtc
->base
.id
;
517 plane_resp
->crtc_id
= 0;
519 if (plane
->state
&& plane
->state
->fb
)
520 plane_resp
->fb_id
= plane
->state
->fb
->base
.id
;
521 else if (!plane
->state
&& plane
->fb
)
522 plane_resp
->fb_id
= plane
->fb
->base
.id
;
524 plane_resp
->fb_id
= 0;
525 drm_modeset_unlock(&plane
->mutex
);
527 plane_resp
->plane_id
= plane
->base
.id
;
528 plane_resp
->possible_crtcs
= drm_lease_filter_crtcs(file_priv
,
529 plane
->possible_crtcs
);
531 plane_resp
->gamma_size
= 0;
534 * This ioctl is called twice, once to determine how much space is
535 * needed, and the 2nd time to fill it.
537 if (plane
->format_count
&&
538 (plane_resp
->count_format_types
>= plane
->format_count
)) {
539 format_ptr
= (uint32_t __user
*)(unsigned long)plane_resp
->format_type_ptr
;
540 if (copy_to_user(format_ptr
,
542 sizeof(uint32_t) * plane
->format_count
)) {
546 plane_resp
->count_format_types
= plane
->format_count
;
551 int drm_plane_check_pixel_format(const struct drm_plane
*plane
, u32 format
)
555 for (i
= 0; i
< plane
->format_count
; i
++) {
556 if (format
== plane
->format_types
[i
])
564 * __setplane_internal - setplane handler for internal callers
566 * This function will take a reference on the new fb for the plane
569 * src_{x,y,w,h} are provided in 16.16 fixed point format
571 static int __setplane_internal(struct drm_plane
*plane
,
572 struct drm_crtc
*crtc
,
573 struct drm_framebuffer
*fb
,
574 int32_t crtc_x
, int32_t crtc_y
,
575 uint32_t crtc_w
, uint32_t crtc_h
,
576 /* src_{x,y,w,h} values are 16.16 fixed point */
577 uint32_t src_x
, uint32_t src_y
,
578 uint32_t src_w
, uint32_t src_h
,
579 struct drm_modeset_acquire_ctx
*ctx
)
583 /* No fb means shut it down */
585 plane
->old_fb
= plane
->fb
;
586 ret
= plane
->funcs
->disable_plane(plane
, ctx
);
591 plane
->old_fb
= NULL
;
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");
603 /* Check whether this plane supports the fb pixel format. */
604 ret
= drm_plane_check_pixel_format(plane
, fb
->format
->format
);
606 struct drm_format_name_buf format_name
;
607 DRM_DEBUG_KMS("Invalid pixel format %s\n",
608 drm_get_format_name(fb
->format
->format
,
613 /* Give drivers some help against integer overflows */
614 if (crtc_w
> INT_MAX
||
615 crtc_x
> INT_MAX
- (int32_t) crtc_w
||
617 crtc_y
> INT_MAX
- (int32_t) crtc_h
) {
618 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
619 crtc_w
, crtc_h
, crtc_x
, crtc_y
);
624 ret
= drm_framebuffer_check_src_coords(src_x
, src_y
, src_w
, src_h
, fb
);
628 plane
->old_fb
= plane
->fb
;
629 ret
= plane
->funcs
->update_plane(plane
, crtc
, fb
,
630 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
631 src_x
, src_y
, src_w
, src_h
, ctx
);
635 drm_framebuffer_get(plane
->fb
);
637 plane
->old_fb
= NULL
;
642 drm_framebuffer_put(plane
->old_fb
);
643 plane
->old_fb
= NULL
;
648 static int setplane_internal(struct drm_plane
*plane
,
649 struct drm_crtc
*crtc
,
650 struct drm_framebuffer
*fb
,
651 int32_t crtc_x
, int32_t crtc_y
,
652 uint32_t crtc_w
, uint32_t crtc_h
,
653 /* src_{x,y,w,h} values are 16.16 fixed point */
654 uint32_t src_x
, uint32_t src_y
,
655 uint32_t src_w
, uint32_t src_h
)
657 struct drm_modeset_acquire_ctx ctx
;
660 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
662 ret
= drm_modeset_lock_all_ctx(plane
->dev
, &ctx
);
665 ret
= __setplane_internal(plane
, crtc
, fb
,
666 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
667 src_x
, src_y
, src_w
, src_h
, &ctx
);
670 if (ret
== -EDEADLK
) {
671 ret
= drm_modeset_backoff(&ctx
);
675 drm_modeset_drop_locks(&ctx
);
676 drm_modeset_acquire_fini(&ctx
);
681 int drm_mode_setplane(struct drm_device
*dev
, void *data
,
682 struct drm_file
*file_priv
)
684 struct drm_mode_set_plane
*plane_req
= data
;
685 struct drm_plane
*plane
;
686 struct drm_crtc
*crtc
= NULL
;
687 struct drm_framebuffer
*fb
= NULL
;
690 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
694 * First, find the plane, crtc, and fb objects. If not available,
695 * we don't bother to call the driver.
697 plane
= drm_plane_find(dev
, file_priv
, plane_req
->plane_id
);
699 DRM_DEBUG_KMS("Unknown plane ID %d\n",
700 plane_req
->plane_id
);
704 if (plane_req
->fb_id
) {
705 fb
= drm_framebuffer_lookup(dev
, file_priv
, plane_req
->fb_id
);
707 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
712 crtc
= drm_crtc_find(dev
, file_priv
, plane_req
->crtc_id
);
714 drm_framebuffer_put(fb
);
715 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
721 ret
= setplane_internal(plane
, crtc
, fb
,
722 plane_req
->crtc_x
, plane_req
->crtc_y
,
723 plane_req
->crtc_w
, plane_req
->crtc_h
,
724 plane_req
->src_x
, plane_req
->src_y
,
725 plane_req
->src_w
, plane_req
->src_h
);
728 drm_framebuffer_put(fb
);
733 static int drm_mode_cursor_universal(struct drm_crtc
*crtc
,
734 struct drm_mode_cursor2
*req
,
735 struct drm_file
*file_priv
,
736 struct drm_modeset_acquire_ctx
*ctx
)
738 struct drm_device
*dev
= crtc
->dev
;
739 struct drm_framebuffer
*fb
= NULL
;
740 struct drm_mode_fb_cmd2 fbreq
= {
742 .height
= req
->height
,
743 .pixel_format
= DRM_FORMAT_ARGB8888
,
744 .pitches
= { req
->width
* 4 },
745 .handles
= { req
->handle
},
747 int32_t crtc_x
, crtc_y
;
748 uint32_t crtc_w
= 0, crtc_h
= 0;
749 uint32_t src_w
= 0, src_h
= 0;
752 BUG_ON(!crtc
->cursor
);
753 WARN_ON(crtc
->cursor
->crtc
!= crtc
&& crtc
->cursor
->crtc
!= NULL
);
756 * Obtain fb we'll be using (either new or existing) and take an extra
757 * reference to it if fb != null. setplane will take care of dropping
758 * the reference if the plane update fails.
760 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
762 fb
= drm_internal_framebuffer_create(dev
, &fbreq
, file_priv
);
764 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
767 fb
->hot_x
= req
->hot_x
;
768 fb
->hot_y
= req
->hot_y
;
773 fb
= crtc
->cursor
->fb
;
775 drm_framebuffer_get(fb
);
778 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
782 crtc_x
= crtc
->cursor_x
;
783 crtc_y
= crtc
->cursor_y
;
789 src_w
= fb
->width
<< 16;
790 src_h
= fb
->height
<< 16;
793 ret
= __setplane_internal(crtc
->cursor
, crtc
, fb
,
794 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
795 0, 0, src_w
, src_h
, ctx
);
798 drm_framebuffer_put(fb
);
800 /* Update successful; save new cursor position, if necessary */
801 if (ret
== 0 && req
->flags
& DRM_MODE_CURSOR_MOVE
) {
802 crtc
->cursor_x
= req
->x
;
803 crtc
->cursor_y
= req
->y
;
809 static int drm_mode_cursor_common(struct drm_device
*dev
,
810 struct drm_mode_cursor2
*req
,
811 struct drm_file
*file_priv
)
813 struct drm_crtc
*crtc
;
814 struct drm_modeset_acquire_ctx ctx
;
817 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
820 if (!req
->flags
|| (~DRM_MODE_CURSOR_FLAGS
& req
->flags
))
823 crtc
= drm_crtc_find(dev
, file_priv
, req
->crtc_id
);
825 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req
->crtc_id
);
829 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
831 ret
= drm_modeset_lock(&crtc
->mutex
, &ctx
);
835 * If this crtc has a universal cursor plane, call that plane's update
836 * handler rather than using legacy cursor handlers.
839 ret
= drm_modeset_lock(&crtc
->cursor
->mutex
, &ctx
);
843 ret
= drm_mode_cursor_universal(crtc
, req
, file_priv
, &ctx
);
847 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
848 if (!crtc
->funcs
->cursor_set
&& !crtc
->funcs
->cursor_set2
) {
852 /* Turns off the cursor if handle is 0 */
853 if (crtc
->funcs
->cursor_set2
)
854 ret
= crtc
->funcs
->cursor_set2(crtc
, file_priv
, req
->handle
,
855 req
->width
, req
->height
, req
->hot_x
, req
->hot_y
);
857 ret
= crtc
->funcs
->cursor_set(crtc
, file_priv
, req
->handle
,
858 req
->width
, req
->height
);
861 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
862 if (crtc
->funcs
->cursor_move
) {
863 ret
= crtc
->funcs
->cursor_move(crtc
, req
->x
, req
->y
);
870 if (ret
== -EDEADLK
) {
871 ret
= drm_modeset_backoff(&ctx
);
876 drm_modeset_drop_locks(&ctx
);
877 drm_modeset_acquire_fini(&ctx
);
884 int drm_mode_cursor_ioctl(struct drm_device
*dev
,
885 void *data
, struct drm_file
*file_priv
)
887 struct drm_mode_cursor
*req
= data
;
888 struct drm_mode_cursor2 new_req
;
890 memcpy(&new_req
, req
, sizeof(struct drm_mode_cursor
));
891 new_req
.hot_x
= new_req
.hot_y
= 0;
893 return drm_mode_cursor_common(dev
, &new_req
, file_priv
);
897 * Set the cursor configuration based on user request. This implements the 2nd
898 * version of the cursor ioctl, which allows userspace to additionally specify
899 * the hotspot of the pointer.
901 int drm_mode_cursor2_ioctl(struct drm_device
*dev
,
902 void *data
, struct drm_file
*file_priv
)
904 struct drm_mode_cursor2
*req
= data
;
906 return drm_mode_cursor_common(dev
, req
, file_priv
);
909 int drm_mode_page_flip_ioctl(struct drm_device
*dev
,
910 void *data
, struct drm_file
*file_priv
)
912 struct drm_mode_crtc_page_flip_target
*page_flip
= data
;
913 struct drm_crtc
*crtc
;
914 struct drm_framebuffer
*fb
= NULL
;
915 struct drm_pending_vblank_event
*e
= NULL
;
916 u32 target_vblank
= page_flip
->sequence
;
917 struct drm_modeset_acquire_ctx ctx
;
920 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
923 if (page_flip
->flags
& ~DRM_MODE_PAGE_FLIP_FLAGS
)
926 if (page_flip
->sequence
!= 0 && !(page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
))
929 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
932 if ((page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
) == DRM_MODE_PAGE_FLIP_TARGET
)
935 if ((page_flip
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
) && !dev
->mode_config
.async_page_flip
)
938 crtc
= drm_crtc_find(dev
, file_priv
, page_flip
->crtc_id
);
942 if (crtc
->funcs
->page_flip_target
) {
946 r
= drm_crtc_vblank_get(crtc
);
950 current_vblank
= drm_crtc_vblank_count(crtc
);
952 switch (page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
) {
953 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE
:
954 if ((int)(target_vblank
- current_vblank
) > 1) {
955 DRM_DEBUG("Invalid absolute flip target %u, "
956 "must be <= %u\n", target_vblank
,
958 drm_crtc_vblank_put(crtc
);
962 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE
:
963 if (target_vblank
!= 0 && target_vblank
!= 1) {
964 DRM_DEBUG("Invalid relative flip target %u, "
965 "must be 0 or 1\n", target_vblank
);
966 drm_crtc_vblank_put(crtc
);
969 target_vblank
+= current_vblank
;
972 target_vblank
= current_vblank
+
973 !(page_flip
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
);
976 } else if (crtc
->funcs
->page_flip
== NULL
||
977 (page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
)) {
981 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
983 ret
= drm_modeset_lock(&crtc
->mutex
, &ctx
);
986 ret
= drm_modeset_lock(&crtc
->primary
->mutex
, &ctx
);
990 if (crtc
->primary
->fb
== NULL
) {
991 /* The framebuffer is currently unbound, presumably
992 * due to a hotplug event, that userspace has not
999 fb
= drm_framebuffer_lookup(dev
, file_priv
, page_flip
->fb_id
);
1006 const struct drm_plane_state
*state
= crtc
->primary
->state
;
1008 ret
= drm_framebuffer_check_src_coords(state
->src_x
,
1014 ret
= drm_crtc_check_viewport(crtc
, crtc
->x
, crtc
->y
, &crtc
->mode
, fb
);
1019 if (crtc
->primary
->fb
->format
!= fb
->format
) {
1020 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1025 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
) {
1026 e
= kzalloc(sizeof *e
, GFP_KERNEL
);
1031 e
->event
.base
.type
= DRM_EVENT_FLIP_COMPLETE
;
1032 e
->event
.base
.length
= sizeof(e
->event
);
1033 e
->event
.vbl
.user_data
= page_flip
->user_data
;
1034 e
->event
.vbl
.crtc_id
= crtc
->base
.id
;
1035 ret
= drm_event_reserve_init(dev
, file_priv
, &e
->base
, &e
->event
.base
);
1043 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1044 if (crtc
->funcs
->page_flip_target
)
1045 ret
= crtc
->funcs
->page_flip_target(crtc
, fb
, e
,
1050 ret
= crtc
->funcs
->page_flip(crtc
, fb
, e
, page_flip
->flags
,
1053 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
)
1054 drm_event_cancel_free(dev
, &e
->base
);
1055 /* Keep the old fb, don't unref it. */
1056 crtc
->primary
->old_fb
= NULL
;
1058 crtc
->primary
->fb
= fb
;
1059 /* Unref only the old framebuffer. */
1065 drm_framebuffer_put(fb
);
1066 if (crtc
->primary
->old_fb
)
1067 drm_framebuffer_put(crtc
->primary
->old_fb
);
1068 crtc
->primary
->old_fb
= NULL
;
1070 if (ret
== -EDEADLK
) {
1071 ret
= drm_modeset_backoff(&ctx
);
1076 drm_modeset_drop_locks(&ctx
);
1077 drm_modeset_acquire_fini(&ctx
);
1079 if (ret
&& crtc
->funcs
->page_flip_target
)
1080 drm_crtc_vblank_put(crtc
);