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 bool drm_crtc_fence_enable_signaling(struct dma_fence
*fence
)
233 static const struct dma_fence_ops drm_crtc_fence_ops
= {
234 .get_driver_name
= drm_crtc_fence_get_driver_name
,
235 .get_timeline_name
= drm_crtc_fence_get_timeline_name
,
236 .enable_signaling
= drm_crtc_fence_enable_signaling
,
237 .wait
= dma_fence_default_wait
,
240 struct dma_fence
*drm_crtc_create_fence(struct drm_crtc
*crtc
)
242 struct dma_fence
*fence
;
244 fence
= kzalloc(sizeof(*fence
), GFP_KERNEL
);
248 dma_fence_init(fence
, &drm_crtc_fence_ops
, &crtc
->fence_lock
,
249 crtc
->fence_context
, ++crtc
->fence_seqno
);
255 * drm_crtc_init_with_planes - Initialise a new CRTC object with
256 * specified primary and cursor planes.
258 * @crtc: CRTC object to init
259 * @primary: Primary plane for CRTC
260 * @cursor: Cursor plane for CRTC
261 * @funcs: callbacks for the new CRTC
262 * @name: printf style format string for the CRTC name, or NULL for default name
264 * Inits a new object created as base part of a driver crtc object. Drivers
265 * should use this function instead of drm_crtc_init(), which is only provided
266 * for backwards compatibility with drivers which do not yet support universal
267 * planes). For really simple hardware which has only 1 plane look at
268 * drm_simple_display_pipe_init() instead.
271 * Zero on success, error code on failure.
273 int drm_crtc_init_with_planes(struct drm_device
*dev
, struct drm_crtc
*crtc
,
274 struct drm_plane
*primary
,
275 struct drm_plane
*cursor
,
276 const struct drm_crtc_funcs
*funcs
,
277 const char *name
, ...)
279 struct drm_mode_config
*config
= &dev
->mode_config
;
282 WARN_ON(primary
&& primary
->type
!= DRM_PLANE_TYPE_PRIMARY
);
283 WARN_ON(cursor
&& cursor
->type
!= DRM_PLANE_TYPE_CURSOR
);
288 INIT_LIST_HEAD(&crtc
->commit_list
);
289 lockinit(&crtc
->commit_lock
, "dccl", 0, 0);
291 drm_modeset_lock_init(&crtc
->mutex
);
292 ret
= drm_mode_object_add(dev
, &crtc
->base
, DRM_MODE_OBJECT_CRTC
);
300 crtc
->name
= kvasprintf(GFP_KERNEL
, name
, ap
);
303 crtc
->name
= kasprintf(GFP_KERNEL
, "crtc-%d",
307 drm_mode_object_unregister(dev
, &crtc
->base
);
311 crtc
->fence_context
= dma_fence_context_alloc(1);
312 lockinit(&crtc
->fence_lock
, "drmcfl", 0, 0);
313 snprintf(crtc
->timeline_name
, sizeof(crtc
->timeline_name
),
314 "CRTC:%d-%s", crtc
->base
.id
, crtc
->name
);
316 crtc
->base
.properties
= &crtc
->properties
;
318 list_add_tail(&crtc
->head
, &config
->crtc_list
);
319 crtc
->index
= config
->num_crtc
++;
321 crtc
->primary
= primary
;
322 crtc
->cursor
= cursor
;
323 if (primary
&& !primary
->possible_crtcs
)
324 primary
->possible_crtcs
= 1 << drm_crtc_index(crtc
);
325 if (cursor
&& !cursor
->possible_crtcs
)
326 cursor
->possible_crtcs
= 1 << drm_crtc_index(crtc
);
328 ret
= drm_crtc_crc_init(crtc
);
330 drm_mode_object_unregister(dev
, &crtc
->base
);
334 if (drm_core_check_feature(dev
, DRIVER_ATOMIC
)) {
335 drm_object_attach_property(&crtc
->base
, config
->prop_active
, 0);
336 drm_object_attach_property(&crtc
->base
, config
->prop_mode_id
, 0);
337 drm_object_attach_property(&crtc
->base
,
338 config
->prop_out_fence_ptr
, 0);
343 EXPORT_SYMBOL(drm_crtc_init_with_planes
);
346 * drm_crtc_cleanup - Clean up the core crtc usage
347 * @crtc: CRTC to cleanup
349 * This function cleans up @crtc and removes it from the DRM mode setting
350 * core. Note that the function does *not* free the crtc structure itself,
351 * this is the responsibility of the caller.
353 void drm_crtc_cleanup(struct drm_crtc
*crtc
)
355 struct drm_device
*dev
= crtc
->dev
;
357 /* Note that the crtc_list is considered to be static; should we
358 * remove the drm_crtc at runtime we would have to decrement all
359 * the indices on the drm_crtc after us in the crtc_list.
362 drm_crtc_crc_fini(crtc
);
364 kfree(crtc
->gamma_store
);
365 crtc
->gamma_store
= NULL
;
367 drm_modeset_lock_fini(&crtc
->mutex
);
369 drm_mode_object_unregister(dev
, &crtc
->base
);
370 list_del(&crtc
->head
);
371 dev
->mode_config
.num_crtc
--;
373 WARN_ON(crtc
->state
&& !crtc
->funcs
->atomic_destroy_state
);
374 if (crtc
->state
&& crtc
->funcs
->atomic_destroy_state
)
375 crtc
->funcs
->atomic_destroy_state(crtc
, crtc
->state
);
379 memset(crtc
, 0, sizeof(*crtc
));
381 EXPORT_SYMBOL(drm_crtc_cleanup
);
384 * drm_connector_index - find the index of a registered connector
385 * @connector: connector to find index for
387 * Given a registered connector, return the index of that connector within a DRM
388 * device's list of connectors.
390 unsigned int drm_connector_index(struct drm_connector
*connector
)
392 unsigned int index
= 0;
393 struct drm_connector
*tmp
;
394 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
395 struct drm_connector_list_iter conn_iter
;
397 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
399 drm_connector_list_iter_begin(connector
->dev
, &conn_iter
);
400 drm_for_each_connector_iter(tmp
, &conn_iter
) {
401 if (tmp
== connector
) {
402 drm_connector_list_iter_end(&conn_iter
);
408 drm_connector_list_iter_end(&conn_iter
);
412 EXPORT_SYMBOL(drm_connector_index
);
415 * drm_mode_getcrtc - get CRTC configuration
416 * @dev: drm device for the ioctl
417 * @data: data pointer for the ioctl
418 * @file_priv: drm file for the ioctl call
420 * Construct a CRTC configuration structure to return to the user.
422 * Called by the user via ioctl.
425 * Zero on success, negative errno on failure.
427 int drm_mode_getcrtc(struct drm_device
*dev
,
428 void *data
, struct drm_file
*file_priv
)
430 struct drm_mode_crtc
*crtc_resp
= data
;
431 struct drm_crtc
*crtc
;
433 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
436 crtc
= drm_crtc_find(dev
, file_priv
, crtc_resp
->crtc_id
);
440 crtc_resp
->gamma_size
= crtc
->gamma_size
;
442 drm_modeset_lock(&crtc
->primary
->mutex
, NULL
);
443 if (crtc
->primary
->state
&& crtc
->primary
->state
->fb
)
444 crtc_resp
->fb_id
= crtc
->primary
->state
->fb
->base
.id
;
445 else if (!crtc
->primary
->state
&& crtc
->primary
->fb
)
446 crtc_resp
->fb_id
= crtc
->primary
->fb
->base
.id
;
448 crtc_resp
->fb_id
= 0;
450 if (crtc
->primary
->state
) {
451 crtc_resp
->x
= crtc
->primary
->state
->src_x
>> 16;
452 crtc_resp
->y
= crtc
->primary
->state
->src_y
>> 16;
454 drm_modeset_unlock(&crtc
->primary
->mutex
);
456 drm_modeset_lock(&crtc
->mutex
, NULL
);
458 if (crtc
->state
->enable
) {
459 drm_mode_convert_to_umode(&crtc_resp
->mode
, &crtc
->state
->mode
);
460 crtc_resp
->mode_valid
= 1;
463 crtc_resp
->mode_valid
= 0;
466 crtc_resp
->x
= crtc
->x
;
467 crtc_resp
->y
= crtc
->y
;
469 drm_mode_convert_to_umode(&crtc_resp
->mode
, &crtc
->mode
);
470 crtc_resp
->mode_valid
= 1;
473 crtc_resp
->mode_valid
= 0;
476 drm_modeset_unlock(&crtc
->mutex
);
481 static int __drm_mode_set_config_internal(struct drm_mode_set
*set
,
482 struct drm_modeset_acquire_ctx
*ctx
)
484 struct drm_crtc
*crtc
= set
->crtc
;
485 struct drm_framebuffer
*fb
;
486 struct drm_crtc
*tmp
;
490 * NOTE: ->set_config can also disable other crtcs (if we steal all
491 * connectors from it), hence we need to refcount the fbs across all
492 * crtcs. Atomic modeset will have saner semantics ...
494 drm_for_each_crtc(tmp
, crtc
->dev
)
495 tmp
->primary
->old_fb
= tmp
->primary
->fb
;
499 ret
= crtc
->funcs
->set_config(set
, ctx
);
501 crtc
->primary
->crtc
= crtc
;
502 crtc
->primary
->fb
= fb
;
505 drm_for_each_crtc(tmp
, crtc
->dev
) {
506 if (tmp
->primary
->fb
)
507 drm_framebuffer_get(tmp
->primary
->fb
);
508 if (tmp
->primary
->old_fb
)
509 drm_framebuffer_put(tmp
->primary
->old_fb
);
510 tmp
->primary
->old_fb
= NULL
;
516 * drm_mode_set_config_internal - helper to call &drm_mode_config_funcs.set_config
517 * @set: modeset config to set
519 * This is a little helper to wrap internal calls to the
520 * &drm_mode_config_funcs.set_config driver interface. The only thing it adds is
521 * correct refcounting dance.
523 * This should only be used by non-atomic legacy drivers.
526 * Zero on success, negative errno on failure.
528 int drm_mode_set_config_internal(struct drm_mode_set
*set
)
530 WARN_ON(drm_drv_uses_atomic_modeset(set
->crtc
->dev
));
532 return __drm_mode_set_config_internal(set
, NULL
);
534 EXPORT_SYMBOL(drm_mode_set_config_internal
);
537 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
539 * @crtc: CRTC that framebuffer will be displayed on
542 * @mode: mode that framebuffer will be displayed under
543 * @fb: framebuffer to check size of
545 int drm_crtc_check_viewport(const struct drm_crtc
*crtc
,
547 const struct drm_display_mode
*mode
,
548 const struct drm_framebuffer
*fb
)
551 int hdisplay
, vdisplay
;
553 drm_mode_get_hv_timing(mode
, &hdisplay
, &vdisplay
);
556 drm_rotation_90_or_270(crtc
->primary
->state
->rotation
))
557 swap(hdisplay
, vdisplay
);
559 return drm_framebuffer_check_src_coords(x
<< 16, y
<< 16,
560 hdisplay
<< 16, vdisplay
<< 16,
563 EXPORT_SYMBOL(drm_crtc_check_viewport
);
566 * drm_mode_setcrtc - set CRTC configuration
567 * @dev: drm device for the ioctl
568 * @data: data pointer for the ioctl
569 * @file_priv: drm file for the ioctl call
571 * Build a new CRTC configuration based on user request.
573 * Called by the user via ioctl.
576 * Zero on success, negative errno on failure.
578 int drm_mode_setcrtc(struct drm_device
*dev
, void *data
,
579 struct drm_file
*file_priv
)
581 struct drm_mode_config
*config
= &dev
->mode_config
;
582 struct drm_mode_crtc
*crtc_req
= data
;
583 struct drm_crtc
*crtc
;
584 struct drm_connector
**connector_set
= NULL
, *connector
;
585 struct drm_framebuffer
*fb
= NULL
;
586 struct drm_display_mode
*mode
= NULL
;
587 struct drm_mode_set set
;
588 uint32_t __user
*set_connectors_ptr
;
589 struct drm_modeset_acquire_ctx ctx
;
593 if (!drm_core_check_feature(dev
, DRIVER_MODESET
))
597 * Universal plane src offsets are only 16.16, prevent havoc for
598 * drivers using universal plane code internally.
600 if (crtc_req
->x
& 0xffff0000 || crtc_req
->y
& 0xffff0000)
603 crtc
= drm_crtc_find(dev
, file_priv
, crtc_req
->crtc_id
);
605 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req
->crtc_id
);
608 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc
->base
.id
, crtc
->name
);
610 mutex_lock(&crtc
->dev
->mode_config
.mutex
);
611 drm_modeset_acquire_init(&ctx
, DRM_MODESET_ACQUIRE_INTERRUPTIBLE
);
613 ret
= drm_modeset_lock_all_ctx(crtc
->dev
, &ctx
);
616 if (crtc_req
->mode_valid
) {
617 /* If we have a mode we need a framebuffer. */
618 /* If we pass -1, set the mode with the currently bound fb */
619 if (crtc_req
->fb_id
== -1) {
620 if (!crtc
->primary
->fb
) {
621 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
625 fb
= crtc
->primary
->fb
;
626 /* Make refcounting symmetric with the lookup path. */
627 drm_framebuffer_get(fb
);
629 fb
= drm_framebuffer_lookup(dev
, file_priv
, crtc_req
->fb_id
);
631 DRM_DEBUG_KMS("Unknown FB ID%d\n",
638 mode
= drm_mode_create(dev
);
644 ret
= drm_mode_convert_umode(mode
, &crtc_req
->mode
);
646 DRM_DEBUG_KMS("Invalid mode\n");
651 * Check whether the primary plane supports the fb pixel format.
652 * Drivers not implementing the universal planes API use a
653 * default formats list provided by the DRM core which doesn't
654 * match real hardware capabilities. Skip the check in that
657 if (!crtc
->primary
->format_default
) {
658 ret
= drm_plane_check_pixel_format(crtc
->primary
,
661 struct drm_format_name_buf format_name
;
662 DRM_DEBUG_KMS("Invalid pixel format %s\n",
663 drm_get_format_name(fb
->format
->format
,
669 ret
= drm_crtc_check_viewport(crtc
, crtc_req
->x
, crtc_req
->y
,
676 if (crtc_req
->count_connectors
== 0 && mode
) {
677 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
682 if (crtc_req
->count_connectors
> 0 && (!mode
|| !fb
)) {
683 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
684 crtc_req
->count_connectors
);
689 if (crtc_req
->count_connectors
> 0) {
692 /* Avoid unbounded kernel memory allocation */
693 if (crtc_req
->count_connectors
> config
->num_connector
) {
698 connector_set
= kmalloc_array(crtc_req
->count_connectors
,
699 sizeof(struct drm_connector
*),
701 if (!connector_set
) {
706 for (i
= 0; i
< crtc_req
->count_connectors
; i
++) {
707 connector_set
[i
] = NULL
;
708 set_connectors_ptr
= (uint32_t __user
*)(unsigned long)crtc_req
->set_connectors_ptr
;
709 if (get_user(out_id
, &set_connectors_ptr
[i
])) {
714 connector
= drm_connector_lookup(dev
, file_priv
, out_id
);
716 DRM_DEBUG_KMS("Connector id %d unknown\n",
721 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
725 connector_set
[i
] = connector
;
733 set
.connectors
= connector_set
;
734 set
.num_connectors
= crtc_req
->count_connectors
;
736 ret
= __drm_mode_set_config_internal(&set
, &ctx
);
740 drm_framebuffer_put(fb
);
743 for (i
= 0; i
< crtc_req
->count_connectors
; i
++) {
744 if (connector_set
[i
])
745 drm_connector_put(connector_set
[i
]);
748 kfree(connector_set
);
749 drm_mode_destroy(dev
, mode
);
750 if (ret
== -EDEADLK
) {
751 ret
= drm_modeset_backoff(&ctx
);
755 drm_modeset_drop_locks(&ctx
);
756 drm_modeset_acquire_fini(&ctx
);
757 mutex_unlock(&crtc
->dev
->mode_config
.mutex
);
762 int drm_mode_crtc_set_obj_prop(struct drm_mode_object
*obj
,
763 struct drm_property
*property
,
767 struct drm_crtc
*crtc
= obj_to_crtc(obj
);
769 if (crtc
->funcs
->set_property
)
770 ret
= crtc
->funcs
->set_property(crtc
, property
, value
);
772 drm_object_property_set_value(obj
, property
, value
);