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 plane
->modifier_count
= format_modifier_count
;
207 plane
->modifiers
= kmalloc_array(format_modifier_count
,
208 sizeof(format_modifiers
[0]),
211 if (format_modifier_count
&& !plane
->modifiers
) {
212 DRM_DEBUG_KMS("out of memory when allocating plane\n");
213 kfree(plane
->format_types
);
214 drm_mode_object_unregister(dev
, &plane
->base
);
222 plane
->name
= kvasprintf(GFP_KERNEL
, name
, ap
);
225 plane
->name
= kasprintf(GFP_KERNEL
, "plane-%d",
226 drm_num_planes(dev
));
229 kfree(plane
->format_types
);
230 kfree(plane
->modifiers
);
231 drm_mode_object_unregister(dev
, &plane
->base
);
235 memcpy(plane
->format_types
, formats
, format_count
* sizeof(uint32_t));
236 plane
->format_count
= format_count
;
237 memcpy(plane
->modifiers
, format_modifiers
,
238 format_modifier_count
* sizeof(format_modifiers
[0]));
239 plane
->possible_crtcs
= possible_crtcs
;
242 list_add_tail(&plane
->head
, &config
->plane_list
);
243 plane
->index
= config
->num_total_plane
++;
245 drm_object_attach_property(&plane
->base
,
246 config
->plane_type_property
,
249 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
250 drm_object_attach_property(&plane
->base
, config
->prop_fb_id
, 0);
251 drm_object_attach_property(&plane
->base
, config
->prop_in_fence_fd
, -1);
252 drm_object_attach_property(&plane
->base
, config
->prop_crtc_id
, 0);
253 drm_object_attach_property(&plane
->base
, config
->prop_crtc_x
, 0);
254 drm_object_attach_property(&plane
->base
, config
->prop_crtc_y
, 0);
255 drm_object_attach_property(&plane
->base
, config
->prop_crtc_w
, 0);
256 drm_object_attach_property(&plane
->base
, config
->prop_crtc_h
, 0);
257 drm_object_attach_property(&plane
->base
, config
->prop_src_x
, 0);
258 drm_object_attach_property(&plane
->base
, config
->prop_src_y
, 0);
259 drm_object_attach_property(&plane
->base
, config
->prop_src_w
, 0);
260 drm_object_attach_property(&plane
->base
, config
->prop_src_h
, 0);
263 if (config
->allow_fb_modifiers
)
264 create_in_format_blob(dev
, plane
);
268 EXPORT_SYMBOL(drm_universal_plane_init
);
270 int drm_plane_register_all(struct drm_device
*dev
)
272 struct drm_plane
*plane
;
275 drm_for_each_plane(plane
, dev
) {
276 if (plane
->funcs
->late_register
)
277 ret
= plane
->funcs
->late_register(plane
);
285 void drm_plane_unregister_all(struct drm_device
*dev
)
287 struct drm_plane
*plane
;
289 drm_for_each_plane(plane
, dev
) {
290 if (plane
->funcs
->early_unregister
)
291 plane
->funcs
->early_unregister(plane
);
296 * drm_plane_init - Initialize a legacy plane
298 * @plane: plane object to init
299 * @possible_crtcs: bitmask of possible CRTCs
300 * @funcs: callbacks for the new plane
301 * @formats: array of supported formats (DRM_FORMAT\_\*)
302 * @format_count: number of elements in @formats
303 * @is_primary: plane type (primary vs overlay)
305 * Legacy API to initialize a DRM plane.
307 * New drivers should call drm_universal_plane_init() instead.
310 * Zero on success, error code on failure.
312 int drm_plane_init(struct drm_device
*dev
, struct drm_plane
*plane
,
313 uint32_t possible_crtcs
,
314 const struct drm_plane_funcs
*funcs
,
315 const uint32_t *formats
, unsigned int format_count
,
318 enum drm_plane_type type
;
320 type
= is_primary
? DRM_PLANE_TYPE_PRIMARY
: DRM_PLANE_TYPE_OVERLAY
;
321 return drm_universal_plane_init(dev
, plane
, possible_crtcs
, funcs
,
322 formats
, format_count
,
325 EXPORT_SYMBOL(drm_plane_init
);
328 * drm_plane_cleanup - Clean up the core plane usage
329 * @plane: plane to cleanup
331 * This function cleans up @plane and removes it from the DRM mode setting
332 * core. Note that the function does *not* free the plane structure itself,
333 * this is the responsibility of the caller.
335 void drm_plane_cleanup(struct drm_plane
*plane
)
337 struct drm_device
*dev
= plane
->dev
;
339 drm_modeset_lock_fini(&plane
->mutex
);
341 kfree(plane
->format_types
);
342 kfree(plane
->modifiers
);
343 drm_mode_object_unregister(dev
, &plane
->base
);
345 BUG_ON(list_empty(&plane
->head
));
347 /* Note that the plane_list is considered to be static; should we
348 * remove the drm_plane at runtime we would have to decrement all
349 * the indices on the drm_plane after us in the plane_list.
352 list_del(&plane
->head
);
353 dev
->mode_config
.num_total_plane
--;
355 WARN_ON(plane
->state
&& !plane
->funcs
->atomic_destroy_state
);
356 if (plane
->state
&& plane
->funcs
->atomic_destroy_state
)
357 plane
->funcs
->atomic_destroy_state(plane
, plane
->state
);
361 memset(plane
, 0, sizeof(*plane
));
363 EXPORT_SYMBOL(drm_plane_cleanup
);
366 * drm_plane_from_index - find the registered plane at an index
368 * @idx: index of registered plane to find for
370 * Given a plane index, return the registered plane from DRM device's
371 * list of planes with matching index. This is the inverse of drm_plane_index().
374 drm_plane_from_index(struct drm_device
*dev
, int idx
)
376 struct drm_plane
*plane
;
378 drm_for_each_plane(plane
, dev
)
379 if (idx
== plane
->index
)
384 EXPORT_SYMBOL(drm_plane_from_index
);
387 * drm_plane_force_disable - Forcibly disable a plane
388 * @plane: plane to disable
390 * Forces the plane to be disabled.
392 * Used when the plane's current framebuffer is destroyed,
393 * and when restoring fbdev mode.
395 * Note that this function is not suitable for atomic drivers, since it doesn't
396 * wire through the lock acquisition context properly and hence can't handle
397 * retries or driver private locks. You probably want to use
398 * drm_atomic_helper_disable_plane() or
399 * drm_atomic_helper_disable_planes_on_crtc() instead.
401 void drm_plane_force_disable(struct drm_plane
*plane
)
408 WARN_ON(drm_drv_uses_atomic_modeset(plane
->dev
));
410 plane
->old_fb
= plane
->fb
;
411 ret
= plane
->funcs
->disable_plane(plane
, NULL
);
413 DRM_ERROR("failed to disable plane with busy fb\n");
414 plane
->old_fb
= NULL
;
417 /* disconnect the plane from the fb and crtc: */
418 drm_framebuffer_put(plane
->old_fb
);
419 plane
->old_fb
= NULL
;
423 EXPORT_SYMBOL(drm_plane_force_disable
);
426 * drm_mode_plane_set_obj_prop - set the value of a property
427 * @plane: drm plane object to set property value for
428 * @property: property to set
429 * @value: value the property should be set to
431 * This functions sets a given property on a given plane object. This function
432 * calls the driver's ->set_property callback and changes the software state of
433 * the property if the callback succeeds.
436 * Zero on success, error code on failure.
438 int drm_mode_plane_set_obj_prop(struct drm_plane
*plane
,
439 struct drm_property
*property
,
443 struct drm_mode_object
*obj
= &plane
->base
;
445 if (plane
->funcs
->set_property
)
446 ret
= plane
->funcs
->set_property(plane
, property
, value
);
448 drm_object_property_set_value(obj
, property
, value
);
452 EXPORT_SYMBOL(drm_mode_plane_set_obj_prop
);
454 int drm_mode_getplane_res(struct drm_device
*dev
, void *data
,
455 struct drm_file
*file_priv
)
457 struct drm_mode_get_plane_res
*plane_resp
= data
;
458 struct drm_mode_config
*config
;
459 struct drm_plane
*plane
;
460 uint32_t __user
*plane_ptr
;
463 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
466 config
= &dev
->mode_config
;
467 plane_ptr
= u64_to_user_ptr(plane_resp
->plane_id_ptr
);
470 * This ioctl is called twice, once to determine how much space is
471 * needed, and the 2nd time to fill it.
473 drm_for_each_plane(plane
, dev
) {
475 * Unless userspace set the 'universal planes'
476 * capability bit, only advertise overlays.
478 if (plane
->type
!= DRM_PLANE_TYPE_OVERLAY
&&
479 !file_priv
->universal_planes
)
482 if (drm_lease_held(file_priv
, plane
->base
.id
)) {
483 if (count
< plane_resp
->count_planes
&&
484 put_user(plane
->base
.id
, plane_ptr
+ count
))
489 plane_resp
->count_planes
= count
;
494 int drm_mode_getplane(struct drm_device
*dev
, void *data
,
495 struct drm_file
*file_priv
)
497 struct drm_mode_get_plane
*plane_resp
= data
;
498 struct drm_plane
*plane
;
499 uint32_t __user
*format_ptr
;
501 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
504 plane
= drm_plane_find(dev
, file_priv
, plane_resp
->plane_id
);
508 drm_modeset_lock(&plane
->mutex
, NULL
);
509 if (plane
->state
&& plane
->state
->crtc
&& drm_lease_held(file_priv
, plane
->state
->crtc
->base
.id
))
510 plane_resp
->crtc_id
= plane
->state
->crtc
->base
.id
;
511 else if (!plane
->state
&& plane
->crtc
&& drm_lease_held(file_priv
, plane
->crtc
->base
.id
))
512 plane_resp
->crtc_id
= plane
->crtc
->base
.id
;
514 plane_resp
->crtc_id
= 0;
516 if (plane
->state
&& plane
->state
->fb
)
517 plane_resp
->fb_id
= plane
->state
->fb
->base
.id
;
518 else if (!plane
->state
&& plane
->fb
)
519 plane_resp
->fb_id
= plane
->fb
->base
.id
;
521 plane_resp
->fb_id
= 0;
522 drm_modeset_unlock(&plane
->mutex
);
524 plane_resp
->plane_id
= plane
->base
.id
;
525 plane_resp
->possible_crtcs
= drm_lease_filter_crtcs(file_priv
,
526 plane
->possible_crtcs
);
528 plane_resp
->gamma_size
= 0;
531 * This ioctl is called twice, once to determine how much space is
532 * needed, and the 2nd time to fill it.
534 if (plane
->format_count
&&
535 (plane_resp
->count_format_types
>= plane
->format_count
)) {
536 format_ptr
= (uint32_t __user
*)(unsigned long)plane_resp
->format_type_ptr
;
537 if (copy_to_user(format_ptr
,
539 sizeof(uint32_t) * plane
->format_count
)) {
543 plane_resp
->count_format_types
= plane
->format_count
;
548 int drm_plane_check_pixel_format(const struct drm_plane
*plane
, u32 format
)
552 for (i
= 0; i
< plane
->format_count
; i
++) {
553 if (format
== plane
->format_types
[i
])
561 * setplane_internal - setplane handler for internal callers
563 * Note that we assume an extra reference has already been taken on fb. If the
564 * update fails, this reference will be dropped before return; if it succeeds,
565 * the previous framebuffer (if any) will be unreferenced instead.
567 * src_{x,y,w,h} are provided in 16.16 fixed point format
569 static int __setplane_internal(struct drm_plane
*plane
,
570 struct drm_crtc
*crtc
,
571 struct drm_framebuffer
*fb
,
572 int32_t crtc_x
, int32_t crtc_y
,
573 uint32_t crtc_w
, uint32_t crtc_h
,
574 /* src_{x,y,w,h} values are 16.16 fixed point */
575 uint32_t src_x
, uint32_t src_y
,
576 uint32_t src_w
, uint32_t src_h
,
577 struct drm_modeset_acquire_ctx
*ctx
)
581 /* No fb means shut it down */
583 plane
->old_fb
= plane
->fb
;
584 ret
= plane
->funcs
->disable_plane(plane
, ctx
);
589 plane
->old_fb
= NULL
;
594 /* Check whether this plane is usable on this CRTC */
595 if (!(plane
->possible_crtcs
& drm_crtc_mask(crtc
))) {
596 DRM_DEBUG_KMS("Invalid crtc for plane\n");
601 /* Check whether this plane supports the fb pixel format. */
602 ret
= drm_plane_check_pixel_format(plane
, fb
->format
->format
);
604 struct drm_format_name_buf format_name
;
605 DRM_DEBUG_KMS("Invalid pixel format %s\n",
606 drm_get_format_name(fb
->format
->format
,
611 /* Give drivers some help against integer overflows */
612 if (crtc_w
> INT_MAX
||
613 crtc_x
> INT_MAX
- (int32_t) crtc_w
||
615 crtc_y
> INT_MAX
- (int32_t) crtc_h
) {
616 DRM_DEBUG_KMS("Invalid CRTC coordinates %ux%u+%d+%d\n",
617 crtc_w
, crtc_h
, crtc_x
, crtc_y
);
622 ret
= drm_framebuffer_check_src_coords(src_x
, src_y
, src_w
, src_h
, fb
);
626 plane
->old_fb
= plane
->fb
;
627 ret
= plane
->funcs
->update_plane(plane
, crtc
, fb
,
628 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
629 src_x
, src_y
, src_w
, src_h
, ctx
);
635 plane
->old_fb
= NULL
;
640 drm_framebuffer_put(fb
);
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
;
689 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
693 * First, find the plane, crtc, and fb objects. If not available,
694 * we don't bother to call the driver.
696 plane
= drm_plane_find(dev
, file_priv
, plane_req
->plane_id
);
698 DRM_DEBUG_KMS("Unknown plane ID %d\n",
699 plane_req
->plane_id
);
703 if (plane_req
->fb_id
) {
704 fb
= drm_framebuffer_lookup(dev
, file_priv
, plane_req
->fb_id
);
706 DRM_DEBUG_KMS("Unknown framebuffer ID %d\n",
711 crtc
= drm_crtc_find(dev
, file_priv
, plane_req
->crtc_id
);
713 drm_framebuffer_put(fb
);
714 DRM_DEBUG_KMS("Unknown crtc ID %d\n",
721 * setplane_internal will take care of deref'ing either the old or new
722 * framebuffer depending on success.
724 return setplane_internal(plane
, crtc
, fb
,
725 plane_req
->crtc_x
, plane_req
->crtc_y
,
726 plane_req
->crtc_w
, plane_req
->crtc_h
,
727 plane_req
->src_x
, plane_req
->src_y
,
728 plane_req
->src_w
, plane_req
->src_h
);
731 static int drm_mode_cursor_universal(struct drm_crtc
*crtc
,
732 struct drm_mode_cursor2
*req
,
733 struct drm_file
*file_priv
,
734 struct drm_modeset_acquire_ctx
*ctx
)
736 struct drm_device
*dev
= crtc
->dev
;
737 struct drm_framebuffer
*fb
= NULL
;
738 struct drm_mode_fb_cmd2 fbreq
= {
740 .height
= req
->height
,
741 .pixel_format
= DRM_FORMAT_ARGB8888
,
742 .pitches
= { req
->width
* 4 },
743 .handles
= { req
->handle
},
745 int32_t crtc_x
, crtc_y
;
746 uint32_t crtc_w
= 0, crtc_h
= 0;
747 uint32_t src_w
= 0, src_h
= 0;
750 BUG_ON(!crtc
->cursor
);
751 WARN_ON(crtc
->cursor
->crtc
!= crtc
&& crtc
->cursor
->crtc
!= NULL
);
754 * Obtain fb we'll be using (either new or existing) and take an extra
755 * reference to it if fb != null. setplane will take care of dropping
756 * the reference if the plane update fails.
758 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
760 fb
= drm_internal_framebuffer_create(dev
, &fbreq
, file_priv
);
762 DRM_DEBUG_KMS("failed to wrap cursor buffer in drm framebuffer\n");
765 fb
->hot_x
= req
->hot_x
;
766 fb
->hot_y
= req
->hot_y
;
771 fb
= crtc
->cursor
->fb
;
773 drm_framebuffer_get(fb
);
776 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
780 crtc_x
= crtc
->cursor_x
;
781 crtc_y
= crtc
->cursor_y
;
787 src_w
= fb
->width
<< 16;
788 src_h
= fb
->height
<< 16;
792 * setplane_internal will take care of deref'ing either the old or new
793 * framebuffer depending on success.
795 ret
= __setplane_internal(crtc
->cursor
, crtc
, fb
,
796 crtc_x
, crtc_y
, crtc_w
, crtc_h
,
797 0, 0, src_w
, src_h
, ctx
);
799 /* Update successful; save new cursor position, if necessary */
800 if (ret
== 0 && req
->flags
& DRM_MODE_CURSOR_MOVE
) {
801 crtc
->cursor_x
= req
->x
;
802 crtc
->cursor_y
= req
->y
;
808 static int drm_mode_cursor_common(struct drm_device
*dev
,
809 struct drm_mode_cursor2
*req
,
810 struct drm_file
*file_priv
)
812 struct drm_crtc
*crtc
;
813 struct drm_modeset_acquire_ctx ctx
;
816 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
819 if (!req
->flags
|| (~DRM_MODE_CURSOR_FLAGS
& req
->flags
))
822 crtc
= drm_crtc_find(dev
, file_priv
, req
->crtc_id
);
824 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", req
->crtc_id
);
828 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
830 ret
= drm_modeset_lock(&crtc
->mutex
, &ctx
);
834 * If this crtc has a universal cursor plane, call that plane's update
835 * handler rather than using legacy cursor handlers.
838 ret
= drm_modeset_lock(&crtc
->cursor
->mutex
, &ctx
);
842 ret
= drm_mode_cursor_universal(crtc
, req
, file_priv
, &ctx
);
846 if (req
->flags
& DRM_MODE_CURSOR_BO
) {
847 if (!crtc
->funcs
->cursor_set
&& !crtc
->funcs
->cursor_set2
) {
851 /* Turns off the cursor if handle is 0 */
852 if (crtc
->funcs
->cursor_set2
)
853 ret
= crtc
->funcs
->cursor_set2(crtc
, file_priv
, req
->handle
,
854 req
->width
, req
->height
, req
->hot_x
, req
->hot_y
);
856 ret
= crtc
->funcs
->cursor_set(crtc
, file_priv
, req
->handle
,
857 req
->width
, req
->height
);
860 if (req
->flags
& DRM_MODE_CURSOR_MOVE
) {
861 if (crtc
->funcs
->cursor_move
) {
862 ret
= crtc
->funcs
->cursor_move(crtc
, req
->x
, req
->y
);
869 if (ret
== -EDEADLK
) {
870 ret
= drm_modeset_backoff(&ctx
);
875 drm_modeset_drop_locks(&ctx
);
876 drm_modeset_acquire_fini(&ctx
);
883 int drm_mode_cursor_ioctl(struct drm_device
*dev
,
884 void *data
, struct drm_file
*file_priv
)
886 struct drm_mode_cursor
*req
= data
;
887 struct drm_mode_cursor2 new_req
;
889 memcpy(&new_req
, req
, sizeof(struct drm_mode_cursor
));
890 new_req
.hot_x
= new_req
.hot_y
= 0;
892 return drm_mode_cursor_common(dev
, &new_req
, file_priv
);
896 * Set the cursor configuration based on user request. This implements the 2nd
897 * version of the cursor ioctl, which allows userspace to additionally specify
898 * the hotspot of the pointer.
900 int drm_mode_cursor2_ioctl(struct drm_device
*dev
,
901 void *data
, struct drm_file
*file_priv
)
903 struct drm_mode_cursor2
*req
= data
;
905 return drm_mode_cursor_common(dev
, req
, file_priv
);
908 int drm_mode_page_flip_ioctl(struct drm_device
*dev
,
909 void *data
, struct drm_file
*file_priv
)
911 struct drm_mode_crtc_page_flip_target
*page_flip
= data
;
912 struct drm_crtc
*crtc
;
913 struct drm_framebuffer
*fb
= NULL
;
914 struct drm_pending_vblank_event
*e
= NULL
;
915 u32 target_vblank
= page_flip
->sequence
;
916 struct drm_modeset_acquire_ctx ctx
;
919 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
922 if (page_flip
->flags
& ~DRM_MODE_PAGE_FLIP_FLAGS
)
925 if (page_flip
->sequence
!= 0 && !(page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
))
928 /* Only one of the DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE/RELATIVE flags
931 if ((page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
) == DRM_MODE_PAGE_FLIP_TARGET
)
934 if ((page_flip
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
) && !dev
->mode_config
.async_page_flip
)
937 crtc
= drm_crtc_find(dev
, file_priv
, page_flip
->crtc_id
);
941 if (crtc
->funcs
->page_flip_target
) {
945 r
= drm_crtc_vblank_get(crtc
);
949 current_vblank
= drm_crtc_vblank_count(crtc
);
951 switch (page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
) {
952 case DRM_MODE_PAGE_FLIP_TARGET_ABSOLUTE
:
953 if ((int)(target_vblank
- current_vblank
) > 1) {
954 DRM_DEBUG("Invalid absolute flip target %u, "
955 "must be <= %u\n", target_vblank
,
957 drm_crtc_vblank_put(crtc
);
961 case DRM_MODE_PAGE_FLIP_TARGET_RELATIVE
:
962 if (target_vblank
!= 0 && target_vblank
!= 1) {
963 DRM_DEBUG("Invalid relative flip target %u, "
964 "must be 0 or 1\n", target_vblank
);
965 drm_crtc_vblank_put(crtc
);
968 target_vblank
+= current_vblank
;
971 target_vblank
= current_vblank
+
972 !(page_flip
->flags
& DRM_MODE_PAGE_FLIP_ASYNC
);
975 } else if (crtc
->funcs
->page_flip
== NULL
||
976 (page_flip
->flags
& DRM_MODE_PAGE_FLIP_TARGET
)) {
980 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
982 ret
= drm_modeset_lock(&crtc
->mutex
, &ctx
);
985 ret
= drm_modeset_lock(&crtc
->primary
->mutex
, &ctx
);
989 if (crtc
->primary
->fb
== NULL
) {
990 /* The framebuffer is currently unbound, presumably
991 * due to a hotplug event, that userspace has not
998 fb
= drm_framebuffer_lookup(dev
, file_priv
, page_flip
->fb_id
);
1005 const struct drm_plane_state
*state
= crtc
->primary
->state
;
1007 ret
= drm_framebuffer_check_src_coords(state
->src_x
,
1013 ret
= drm_crtc_check_viewport(crtc
, crtc
->x
, crtc
->y
, &crtc
->mode
, fb
);
1018 if (crtc
->primary
->fb
->format
!= fb
->format
) {
1019 DRM_DEBUG_KMS("Page flip is not allowed to change frame buffer format.\n");
1024 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
) {
1025 e
= kzalloc(sizeof *e
, GFP_KERNEL
);
1030 e
->event
.base
.type
= DRM_EVENT_FLIP_COMPLETE
;
1031 e
->event
.base
.length
= sizeof(e
->event
);
1032 e
->event
.vbl
.user_data
= page_flip
->user_data
;
1033 e
->event
.vbl
.crtc_id
= crtc
->base
.id
;
1034 ret
= drm_event_reserve_init(dev
, file_priv
, &e
->base
, &e
->event
.base
);
1042 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1043 if (crtc
->funcs
->page_flip_target
)
1044 ret
= crtc
->funcs
->page_flip_target(crtc
, fb
, e
,
1049 ret
= crtc
->funcs
->page_flip(crtc
, fb
, e
, page_flip
->flags
,
1052 if (page_flip
->flags
& DRM_MODE_PAGE_FLIP_EVENT
)
1053 drm_event_cancel_free(dev
, &e
->base
);
1054 /* Keep the old fb, don't unref it. */
1055 crtc
->primary
->old_fb
= NULL
;
1057 crtc
->primary
->fb
= fb
;
1058 /* Unref only the old framebuffer. */
1064 drm_framebuffer_put(fb
);
1065 if (crtc
->primary
->old_fb
)
1066 drm_framebuffer_put(crtc
->primary
->old_fb
);
1067 crtc
->primary
->old_fb
= NULL
;
1069 if (ret
== -EDEADLK
) {
1070 ret
= drm_modeset_backoff(&ctx
);
1075 drm_modeset_drop_locks(&ctx
);
1076 drm_modeset_acquire_fini(&ctx
);
1078 if (ret
&& crtc
->funcs
->page_flip_target
)
1079 drm_crtc_vblank_put(crtc
);