2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 * Copyright (c) 2008 Red Hat Inc.
6 * DRM core CRTC related functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28 * Eric Anholt <eric@anholt.net>
29 * Dave Airlie <airlied@linux.ie>
30 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <linux/slab.h>
35 #include <linux/export.h>
36 #include <linux/dma-fence.h>
38 #include <drm/drm_crtc.h>
39 #include <drm/drm_edid.h>
40 #include <drm/drm_fourcc.h>
41 #include <drm/drm_modeset_lock.h>
42 #include <drm/drm_atomic.h>
43 #include <drm/drm_auth.h>
44 #include <drm/drm_debugfs_crc.h>
46 #include "drm_crtc_internal.h"
47 #include "drm_internal.h"
52 * A CRTC represents the overall display pipeline. It receives pixel data from
53 * &drm_plane and blends them together. The &drm_display_mode is also attached
54 * to the CRTC, specifying display timings. On the output side the data is fed
55 * to one or more &drm_encoder, which are then each connected to one
58 * To create a CRTC, a KMS drivers allocates and zeroes an instances of
59 * &struct drm_crtc (possibly as part of a larger structure) and registers it
60 * with a call to drm_crtc_init_with_planes().
62 * The CRTC is also the entry point for legacy modeset operations, see
63 * &drm_crtc_funcs.set_config, legacy plane operations, see
64 * &drm_crtc_funcs.page_flip and &drm_crtc_funcs.cursor_set2, and other legacy
65 * operations like &drm_crtc_funcs.gamma_set. For atomic drivers all these
66 * features are controlled through &drm_property and
67 * &drm_mode_config_funcs.atomic_check and &drm_mode_config_funcs.atomic_check.
71 * drm_crtc_from_index - find the registered CRTC at an index
73 * @idx: index of registered CRTC to find for
75 * Given a CRTC index, return the registered CRTC from DRM device's
76 * list of CRTCs with matching index. This is the inverse of drm_crtc_index().
77 * It's useful in the vblank callbacks (like &drm_driver.enable_vblank or
78 * &drm_driver.disable_vblank), since that still deals with indices instead
79 * of pointers to &struct drm_crtc."
81 struct drm_crtc
*drm_crtc_from_index(struct drm_device
*dev
, int idx
)
83 struct drm_crtc
*crtc
;
85 drm_for_each_crtc(crtc
, dev
)
86 if (idx
== crtc
->index
)
91 EXPORT_SYMBOL(drm_crtc_from_index
);
94 * drm_crtc_force_disable - Forcibly turn off a CRTC
95 * @crtc: CRTC to turn off
97 * Note: This should only be used by non-atomic legacy drivers.
100 * Zero on success, error code on failure.
102 int drm_crtc_force_disable(struct drm_crtc
*crtc
)
104 struct drm_mode_set set
= {
108 WARN_ON(drm_drv_uses_atomic_modeset(crtc
->dev
));
110 return drm_mode_set_config_internal(&set
);
112 EXPORT_SYMBOL(drm_crtc_force_disable
);
115 * drm_crtc_force_disable_all - Forcibly turn off all enabled CRTCs
116 * @dev: DRM device whose CRTCs to turn off
118 * Drivers may want to call this on unload to ensure that all displays are
119 * unlit and the GPU is in a consistent, low power state. Takes modeset locks.
121 * Note: This should only be used by non-atomic legacy drivers. For an atomic
122 * version look at drm_atomic_helper_shutdown().
125 * Zero on success, error code on failure.
127 int drm_crtc_force_disable_all(struct drm_device
*dev
)
129 struct drm_crtc
*crtc
;
132 drm_modeset_lock_all(dev
);
133 drm_for_each_crtc(crtc
, dev
)
135 ret
= drm_crtc_force_disable(crtc
);
140 drm_modeset_unlock_all(dev
);
143 EXPORT_SYMBOL(drm_crtc_force_disable_all
);
145 static unsigned int drm_num_crtcs(struct drm_device
*dev
)
147 unsigned int num
= 0;
148 struct drm_crtc
*tmp
;
150 drm_for_each_crtc(tmp
, dev
) {
157 int drm_crtc_register_all(struct drm_device
*dev
)
159 struct drm_crtc
*crtc
;
162 drm_for_each_crtc(crtc
, dev
) {
163 if (drm_debugfs_crtc_add(crtc
))
164 DRM_ERROR("Failed to initialize debugfs entry for CRTC '%s'.\n",
167 if (crtc
->funcs
->late_register
)
168 ret
= crtc
->funcs
->late_register(crtc
);
176 void drm_crtc_unregister_all(struct drm_device
*dev
)
178 struct drm_crtc
*crtc
;
180 drm_for_each_crtc(crtc
, dev
) {
181 if (crtc
->funcs
->early_unregister
)
182 crtc
->funcs
->early_unregister(crtc
);
183 drm_debugfs_crtc_remove(crtc
);
187 static int drm_crtc_crc_init(struct drm_crtc
*crtc
)
189 #ifdef CONFIG_DEBUG_FS
190 spin_lock_init(&crtc
->crc
.lock
);
191 init_waitqueue_head(&crtc
->crc
.wq
);
192 crtc
->crc
.source
= kstrdup("auto", GFP_KERNEL
);
193 if (!crtc
->crc
.source
)
199 static void drm_crtc_crc_fini(struct drm_crtc
*crtc
)
201 #ifdef CONFIG_DEBUG_FS
202 kfree(crtc
->crc
.source
);
206 static const struct dma_fence_ops drm_crtc_fence_ops
;
208 static struct drm_crtc
*fence_to_crtc(struct dma_fence
*fence
)
210 BUG_ON(fence
->ops
!= &drm_crtc_fence_ops
);
211 return container_of(fence
->lock
, struct drm_crtc
, fence_lock
);
214 static const char *drm_crtc_fence_get_driver_name(struct dma_fence
*fence
)
216 struct drm_crtc
*crtc
= fence_to_crtc(fence
);
218 return crtc
->dev
->driver
->name
;
221 static const char *drm_crtc_fence_get_timeline_name(struct dma_fence
*fence
)
223 struct drm_crtc
*crtc
= fence_to_crtc(fence
);
225 return crtc
->timeline_name
;
228 static const struct dma_fence_ops drm_crtc_fence_ops
= {
229 .get_driver_name
= drm_crtc_fence_get_driver_name
,
230 .get_timeline_name
= drm_crtc_fence_get_timeline_name
,
233 struct dma_fence
*drm_crtc_create_fence(struct drm_crtc
*crtc
)
235 struct dma_fence
*fence
;
237 fence
= kzalloc(sizeof(*fence
), GFP_KERNEL
);
241 dma_fence_init(fence
, &drm_crtc_fence_ops
, &crtc
->fence_lock
,
242 crtc
->fence_context
, ++crtc
->fence_seqno
);
248 * drm_crtc_init_with_planes - Initialise a new CRTC object with
249 * specified primary and cursor planes.
251 * @crtc: CRTC object to init
252 * @primary: Primary plane for CRTC
253 * @cursor: Cursor plane for CRTC
254 * @funcs: callbacks for the new CRTC
255 * @name: printf style format string for the CRTC name, or NULL for default name
257 * Inits a new object created as base part of a driver crtc object. Drivers
258 * should use this function instead of drm_crtc_init(), which is only provided
259 * for backwards compatibility with drivers which do not yet support universal
260 * planes). For really simple hardware which has only 1 plane look at
261 * drm_simple_display_pipe_init() instead.
264 * Zero on success, error code on failure.
266 int drm_crtc_init_with_planes(struct drm_device
*dev
, struct drm_crtc
*crtc
,
267 struct drm_plane
*primary
,
268 struct drm_plane
*cursor
,
269 const struct drm_crtc_funcs
*funcs
,
270 const char *name
, ...)
272 struct drm_mode_config
*config
= &dev
->mode_config
;
275 WARN_ON(primary
&& primary
->type
!= DRM_PLANE_TYPE_PRIMARY
);
276 WARN_ON(cursor
&& cursor
->type
!= DRM_PLANE_TYPE_CURSOR
);
278 /* crtc index is used with 32bit bitmasks */
279 if (WARN_ON(config
->num_crtc
>= 32))
282 WARN_ON(drm_drv_uses_atomic_modeset(dev
) &&
283 (!funcs
->atomic_destroy_state
||
284 !funcs
->atomic_duplicate_state
));
289 INIT_LIST_HEAD(&crtc
->commit_list
);
290 spin_lock_init(&crtc
->commit_lock
);
292 drm_modeset_lock_init(&crtc
->mutex
);
293 ret
= drm_mode_object_add(dev
, &crtc
->base
, DRM_MODE_OBJECT_CRTC
);
301 crtc
->name
= kvasprintf(GFP_KERNEL
, name
, ap
);
304 crtc
->name
= kasprintf(GFP_KERNEL
, "crtc-%d",
308 drm_mode_object_unregister(dev
, &crtc
->base
);
312 crtc
->fence_context
= dma_fence_context_alloc(1);
313 spin_lock_init(&crtc
->fence_lock
);
314 snprintf(crtc
->timeline_name
, sizeof(crtc
->timeline_name
),
315 "CRTC:%d-%s", crtc
->base
.id
, crtc
->name
);
317 crtc
->base
.properties
= &crtc
->properties
;
319 list_add_tail(&crtc
->head
, &config
->crtc_list
);
320 crtc
->index
= config
->num_crtc
++;
322 crtc
->primary
= primary
;
323 crtc
->cursor
= cursor
;
324 if (primary
&& !primary
->possible_crtcs
)
325 primary
->possible_crtcs
= drm_crtc_mask(crtc
);
326 if (cursor
&& !cursor
->possible_crtcs
)
327 cursor
->possible_crtcs
= drm_crtc_mask(crtc
);
329 ret
= drm_crtc_crc_init(crtc
);
331 drm_mode_object_unregister(dev
, &crtc
->base
);
335 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
336 drm_object_attach_property(&crtc
->base
, config
->prop_active
, 0);
337 drm_object_attach_property(&crtc
->base
, config
->prop_mode_id
, 0);
338 drm_object_attach_property(&crtc
->base
,
339 config
->prop_out_fence_ptr
, 0);
344 EXPORT_SYMBOL(drm_crtc_init_with_planes
);
347 * drm_crtc_cleanup - Clean up the core crtc usage
348 * @crtc: CRTC to cleanup
350 * This function cleans up @crtc and removes it from the DRM mode setting
351 * core. Note that the function does *not* free the crtc structure itself,
352 * this is the responsibility of the caller.
354 void drm_crtc_cleanup(struct drm_crtc
*crtc
)
356 struct drm_device
*dev
= crtc
->dev
;
358 /* Note that the crtc_list is considered to be static; should we
359 * remove the drm_crtc at runtime we would have to decrement all
360 * the indices on the drm_crtc after us in the crtc_list.
363 drm_crtc_crc_fini(crtc
);
365 kfree(crtc
->gamma_store
);
366 crtc
->gamma_store
= NULL
;
368 drm_modeset_lock_fini(&crtc
->mutex
);
370 drm_mode_object_unregister(dev
, &crtc
->base
);
371 list_del(&crtc
->head
);
372 dev
->mode_config
.num_crtc
--;
374 WARN_ON(crtc
->state
&& !crtc
->funcs
->atomic_destroy_state
);
375 if (crtc
->state
&& crtc
->funcs
->atomic_destroy_state
)
376 crtc
->funcs
->atomic_destroy_state(crtc
, crtc
->state
);
380 memset(crtc
, 0, sizeof(*crtc
));
382 EXPORT_SYMBOL(drm_crtc_cleanup
);
385 * drm_mode_getcrtc - get CRTC configuration
386 * @dev: drm device for the ioctl
387 * @data: data pointer for the ioctl
388 * @file_priv: drm file for the ioctl call
390 * Construct a CRTC configuration structure to return to the user.
392 * Called by the user via ioctl.
395 * Zero on success, negative errno on failure.
397 int drm_mode_getcrtc(struct drm_device
*dev
,
398 void *data
, struct drm_file
*file_priv
)
400 struct drm_mode_crtc
*crtc_resp
= data
;
401 struct drm_crtc
*crtc
;
402 struct drm_plane
*plane
;
404 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
407 crtc
= drm_crtc_find(dev
, file_priv
, crtc_resp
->crtc_id
);
411 plane
= crtc
->primary
;
413 crtc_resp
->gamma_size
= crtc
->gamma_size
;
415 drm_modeset_lock(&plane
->mutex
, NULL
);
416 if (plane
->state
&& plane
->state
->fb
)
417 crtc_resp
->fb_id
= plane
->state
->fb
->base
.id
;
418 else if (!plane
->state
&& plane
->fb
)
419 crtc_resp
->fb_id
= plane
->fb
->base
.id
;
421 crtc_resp
->fb_id
= 0;
424 crtc_resp
->x
= plane
->state
->src_x
>> 16;
425 crtc_resp
->y
= plane
->state
->src_y
>> 16;
427 drm_modeset_unlock(&plane
->mutex
);
429 drm_modeset_lock(&crtc
->mutex
, NULL
);
431 if (crtc
->state
->enable
) {
432 drm_mode_convert_to_umode(&crtc_resp
->mode
, &crtc
->state
->mode
);
433 crtc_resp
->mode_valid
= 1;
435 crtc_resp
->mode_valid
= 0;
438 crtc_resp
->x
= crtc
->x
;
439 crtc_resp
->y
= crtc
->y
;
442 drm_mode_convert_to_umode(&crtc_resp
->mode
, &crtc
->mode
);
443 crtc_resp
->mode_valid
= 1;
446 crtc_resp
->mode_valid
= 0;
449 if (!file_priv
->aspect_ratio_allowed
)
450 crtc_resp
->mode
.flags
&= ~DRM_MODE_FLAG_PIC_AR_MASK
;
451 drm_modeset_unlock(&crtc
->mutex
);
456 static int __drm_mode_set_config_internal(struct drm_mode_set
*set
,
457 struct drm_modeset_acquire_ctx
*ctx
)
459 struct drm_crtc
*crtc
= set
->crtc
;
460 struct drm_framebuffer
*fb
;
461 struct drm_crtc
*tmp
;
464 WARN_ON(drm_drv_uses_atomic_modeset(crtc
->dev
));
467 * NOTE: ->set_config can also disable other crtcs (if we steal all
468 * connectors from it), hence we need to refcount the fbs across all
469 * crtcs. Atomic modeset will have saner semantics ...
471 drm_for_each_crtc(tmp
, crtc
->dev
) {
472 struct drm_plane
*plane
= tmp
->primary
;
474 plane
->old_fb
= plane
->fb
;
479 ret
= crtc
->funcs
->set_config(set
, ctx
);
481 struct drm_plane
*plane
= crtc
->primary
;
483 plane
->crtc
= fb
? crtc
: NULL
;
487 drm_for_each_crtc(tmp
, crtc
->dev
) {
488 struct drm_plane
*plane
= tmp
->primary
;
491 drm_framebuffer_get(plane
->fb
);
493 drm_framebuffer_put(plane
->old_fb
);
494 plane
->old_fb
= NULL
;
501 * drm_mode_set_config_internal - helper to call &drm_mode_config_funcs.set_config
502 * @set: modeset config to set
504 * This is a little helper to wrap internal calls to the
505 * &drm_mode_config_funcs.set_config driver interface. The only thing it adds is
506 * correct refcounting dance.
508 * This should only be used by non-atomic legacy drivers.
511 * Zero on success, negative errno on failure.
513 int drm_mode_set_config_internal(struct drm_mode_set
*set
)
515 WARN_ON(drm_drv_uses_atomic_modeset(set
->crtc
->dev
));
517 return __drm_mode_set_config_internal(set
, NULL
);
519 EXPORT_SYMBOL(drm_mode_set_config_internal
);
522 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
524 * @crtc: CRTC that framebuffer will be displayed on
527 * @mode: mode that framebuffer will be displayed under
528 * @fb: framebuffer to check size of
530 int drm_crtc_check_viewport(const struct drm_crtc
*crtc
,
532 const struct drm_display_mode
*mode
,
533 const struct drm_framebuffer
*fb
)
536 int hdisplay
, vdisplay
;
538 drm_mode_get_hv_timing(mode
, &hdisplay
, &vdisplay
);
541 drm_rotation_90_or_270(crtc
->primary
->state
->rotation
))
542 swap(hdisplay
, vdisplay
);
544 return drm_framebuffer_check_src_coords(x
<< 16, y
<< 16,
545 hdisplay
<< 16, vdisplay
<< 16,
548 EXPORT_SYMBOL(drm_crtc_check_viewport
);
551 * drm_mode_setcrtc - set CRTC configuration
552 * @dev: drm device for the ioctl
553 * @data: data pointer for the ioctl
554 * @file_priv: drm file for the ioctl call
556 * Build a new CRTC configuration based on user request.
558 * Called by the user via ioctl.
561 * Zero on success, negative errno on failure.
563 int drm_mode_setcrtc(struct drm_device
*dev
, void *data
,
564 struct drm_file
*file_priv
)
566 struct drm_mode_config
*config
= &dev
->mode_config
;
567 struct drm_mode_crtc
*crtc_req
= data
;
568 struct drm_crtc
*crtc
;
569 struct drm_plane
*plane
;
570 struct drm_connector
**connector_set
, *connector
;
571 struct drm_framebuffer
*fb
;
572 struct drm_display_mode
*mode
;
573 struct drm_mode_set set
;
574 uint32_t __user
*set_connectors_ptr
;
575 struct drm_modeset_acquire_ctx ctx
;
579 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
583 * Universal plane src offsets are only 16.16, prevent havoc for
584 * drivers using universal plane code internally.
586 if (crtc_req
->x
& 0xffff0000 || crtc_req
->y
& 0xffff0000)
589 crtc
= drm_crtc_find(dev
, file_priv
, crtc_req
->crtc_id
);
591 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req
->crtc_id
);
594 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc
->base
.id
, crtc
->name
);
596 plane
= crtc
->primary
;
598 /* allow disabling with the primary plane leased */
599 if (crtc_req
->mode_valid
&& !drm_lease_held(file_priv
, plane
->base
.id
))
602 mutex_lock(&crtc
->dev
->mode_config
.mutex
);
603 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
605 connector_set
= NULL
;
609 ret
= drm_modeset_lock_all_ctx(crtc
->dev
, &ctx
);
613 if (crtc_req
->mode_valid
) {
614 /* If we have a mode we need a framebuffer. */
615 /* If we pass -1, set the mode with the currently bound fb */
616 if (crtc_req
->fb_id
== -1) {
617 struct drm_framebuffer
*old_fb
;
620 old_fb
= plane
->state
->fb
;
625 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
631 /* Make refcounting symmetric with the lookup path. */
632 drm_framebuffer_get(fb
);
634 fb
= drm_framebuffer_lookup(dev
, file_priv
, crtc_req
->fb_id
);
636 DRM_DEBUG_KMS("Unknown FB ID%d\n",
643 mode
= drm_mode_create(dev
);
648 if (!file_priv
->aspect_ratio_allowed
&&
649 (crtc_req
->mode
.flags
& DRM_MODE_FLAG_PIC_AR_MASK
) != DRM_MODE_FLAG_PIC_AR_NONE
) {
650 DRM_DEBUG_KMS("Unexpected aspect-ratio flag bits\n");
656 ret
= drm_mode_convert_umode(dev
, mode
, &crtc_req
->mode
);
658 DRM_DEBUG_KMS("Invalid mode (ret=%d, status=%s)\n",
659 ret
, drm_get_mode_status_name(mode
->status
));
660 drm_mode_debug_printmodeline(mode
);
665 * Check whether the primary plane supports the fb pixel format.
666 * Drivers not implementing the universal planes API use a
667 * default formats list provided by the DRM core which doesn't
668 * match real hardware capabilities. Skip the check in that
671 if (!plane
->format_default
) {
672 ret
= drm_plane_check_pixel_format(plane
,
676 struct drm_format_name_buf format_name
;
677 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
678 drm_get_format_name(fb
->format
->format
,
685 ret
= drm_crtc_check_viewport(crtc
, crtc_req
->x
, crtc_req
->y
,
692 if (crtc_req
->count_connectors
== 0 && mode
) {
693 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
698 if (crtc_req
->count_connectors
> 0 && (!mode
|| !fb
)) {
699 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
700 crtc_req
->count_connectors
);
705 if (crtc_req
->count_connectors
> 0) {
708 /* Avoid unbounded kernel memory allocation */
709 if (crtc_req
->count_connectors
> config
->num_connector
) {
714 connector_set
= kmalloc_array(crtc_req
->count_connectors
,
715 sizeof(struct drm_connector
*),
717 if (!connector_set
) {
722 for (i
= 0; i
< crtc_req
->count_connectors
; i
++) {
723 connector_set
[i
] = NULL
;
724 set_connectors_ptr
= (uint32_t __user
*)(unsigned long)crtc_req
->set_connectors_ptr
;
725 if (get_user(out_id
, &set_connectors_ptr
[i
])) {
730 connector
= drm_connector_lookup(dev
, file_priv
, out_id
);
732 DRM_DEBUG_KMS("Connector id %d unknown\n",
737 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
741 connector_set
[i
] = connector
;
749 set
.connectors
= connector_set
;
750 set
.num_connectors
= crtc_req
->count_connectors
;
753 if (drm_drv_uses_atomic_modeset(dev
))
754 ret
= crtc
->funcs
->set_config(&set
, &ctx
);
756 ret
= __drm_mode_set_config_internal(&set
, &ctx
);
760 drm_framebuffer_put(fb
);
763 for (i
= 0; i
< crtc_req
->count_connectors
; i
++) {
764 if (connector_set
[i
])
765 drm_connector_put(connector_set
[i
]);
768 kfree(connector_set
);
769 drm_mode_destroy(dev
, mode
);
770 if (ret
== -EDEADLK
) {
771 ret
= drm_modeset_backoff(&ctx
);
775 drm_modeset_drop_locks(&ctx
);
776 drm_modeset_acquire_fini(&ctx
);
777 mutex_unlock(&crtc
->dev
->mode_config
.mutex
);
782 int drm_mode_crtc_set_obj_prop(struct drm_mode_object
*obj
,
783 struct drm_property
*property
,
787 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
789 if (crtc
->funcs
->set_property
)
790 ret
= crtc
->funcs
->set_property(crtc
, property
, value
);
792 drm_object_property_set_value(obj
, property
, value
);