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>
37 #include <linux/uaccess.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>
45 #include <drm/drm_drv.h>
46 #include <drm/drm_print.h>
47 #include <drm/drm_file.h>
49 #include "drm_crtc_internal.h"
50 #include "drm_internal.h"
55 * A CRTC represents the overall display pipeline. It receives pixel data from
56 * &drm_plane and blends them together. The &drm_display_mode is also attached
57 * to the CRTC, specifying display timings. On the output side the data is fed
58 * to one or more &drm_encoder, which are then each connected to one
61 * To create a CRTC, a KMS drivers allocates and zeroes an instances of
62 * &struct drm_crtc (possibly as part of a larger structure) and registers it
63 * with a call to drm_crtc_init_with_planes().
65 * The CRTC is also the entry point for legacy modeset operations, see
66 * &drm_crtc_funcs.set_config, legacy plane operations, see
67 * &drm_crtc_funcs.page_flip and &drm_crtc_funcs.cursor_set2, and other legacy
68 * operations like &drm_crtc_funcs.gamma_set. For atomic drivers all these
69 * features are controlled through &drm_property and
70 * &drm_mode_config_funcs.atomic_check and &drm_mode_config_funcs.atomic_check.
74 * drm_crtc_from_index - find the registered CRTC at an index
76 * @idx: index of registered CRTC to find for
78 * Given a CRTC index, return the registered CRTC from DRM device's
79 * list of CRTCs with matching index. This is the inverse of drm_crtc_index().
80 * It's useful in the vblank callbacks (like &drm_driver.enable_vblank or
81 * &drm_driver.disable_vblank), since that still deals with indices instead
82 * of pointers to &struct drm_crtc."
84 struct drm_crtc *drm_crtc_from_index(struct drm_device *dev, int idx)
86 struct drm_crtc *crtc;
88 drm_for_each_crtc(crtc, dev)
89 if (idx == crtc->index)
94 EXPORT_SYMBOL(drm_crtc_from_index);
96 int drm_crtc_force_disable(struct drm_crtc *crtc)
98 struct drm_mode_set set = {
102 WARN_ON(drm_drv_uses_atomic_modeset(crtc->dev));
104 return drm_mode_set_config_internal(&set);
107 static unsigned int drm_num_crtcs(struct drm_device *dev)
109 unsigned int num = 0;
110 struct drm_crtc *tmp;
112 drm_for_each_crtc(tmp, dev) {
119 int drm_crtc_register_all(struct drm_device *dev)
121 struct drm_crtc *crtc;
124 drm_for_each_crtc(crtc, dev) {
125 if (drm_debugfs_crtc_add(crtc))
126 DRM_ERROR("Failed to initialize debugfs entry for CRTC '%s'.\n",
129 if (crtc->funcs->late_register)
130 ret = crtc->funcs->late_register(crtc);
138 void drm_crtc_unregister_all(struct drm_device *dev)
140 struct drm_crtc *crtc;
142 drm_for_each_crtc(crtc, dev) {
143 if (crtc->funcs->early_unregister)
144 crtc->funcs->early_unregister(crtc);
145 drm_debugfs_crtc_remove(crtc);
149 static int drm_crtc_crc_init(struct drm_crtc *crtc)
151 #ifdef CONFIG_DEBUG_FS
152 spin_lock_init(&crtc->crc.lock);
153 init_waitqueue_head(&crtc->crc.wq);
154 crtc->crc.source = kstrdup("auto", GFP_KERNEL);
155 if (!crtc->crc.source)
161 static void drm_crtc_crc_fini(struct drm_crtc *crtc)
163 #ifdef CONFIG_DEBUG_FS
164 kfree(crtc->crc.source);
168 static const struct dma_fence_ops drm_crtc_fence_ops;
170 static struct drm_crtc *fence_to_crtc(struct dma_fence *fence)
172 BUG_ON(fence->ops != &drm_crtc_fence_ops);
173 return container_of(fence->lock, struct drm_crtc, fence_lock);
176 static const char *drm_crtc_fence_get_driver_name(struct dma_fence *fence)
178 struct drm_crtc *crtc = fence_to_crtc(fence);
180 return crtc->dev->driver->name;
183 static const char *drm_crtc_fence_get_timeline_name(struct dma_fence *fence)
185 struct drm_crtc *crtc = fence_to_crtc(fence);
187 return crtc->timeline_name;
190 static const struct dma_fence_ops drm_crtc_fence_ops = {
191 .get_driver_name = drm_crtc_fence_get_driver_name,
192 .get_timeline_name = drm_crtc_fence_get_timeline_name,
195 struct dma_fence *drm_crtc_create_fence(struct drm_crtc *crtc)
197 struct dma_fence *fence;
199 fence = kzalloc(sizeof(*fence), GFP_KERNEL);
203 dma_fence_init(fence, &drm_crtc_fence_ops, &crtc->fence_lock,
204 crtc->fence_context, ++crtc->fence_seqno);
210 * drm_crtc_init_with_planes - Initialise a new CRTC object with
211 * specified primary and cursor planes.
213 * @crtc: CRTC object to init
214 * @primary: Primary plane for CRTC
215 * @cursor: Cursor plane for CRTC
216 * @funcs: callbacks for the new CRTC
217 * @name: printf style format string for the CRTC name, or NULL for default name
219 * Inits a new object created as base part of a driver crtc object. Drivers
220 * should use this function instead of drm_crtc_init(), which is only provided
221 * for backwards compatibility with drivers which do not yet support universal
222 * planes). For really simple hardware which has only 1 plane look at
223 * drm_simple_display_pipe_init() instead.
226 * Zero on success, error code on failure.
228 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
229 struct drm_plane *primary,
230 struct drm_plane *cursor,
231 const struct drm_crtc_funcs *funcs,
232 const char *name, ...)
234 struct drm_mode_config *config = &dev->mode_config;
237 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
238 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
240 /* crtc index is used with 32bit bitmasks */
241 if (WARN_ON(config->num_crtc >= 32))
244 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
245 (!funcs->atomic_destroy_state ||
246 !funcs->atomic_duplicate_state));
251 INIT_LIST_HEAD(&crtc->commit_list);
252 spin_lock_init(&crtc->commit_lock);
254 drm_modeset_lock_init(&crtc->mutex);
255 ret = drm_mode_object_add(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
263 crtc->name = kvasprintf(GFP_KERNEL, name, ap);
266 crtc->name = kasprintf(GFP_KERNEL, "crtc-%d",
270 drm_mode_object_unregister(dev, &crtc->base);
274 crtc->fence_context = dma_fence_context_alloc(1);
275 spin_lock_init(&crtc->fence_lock);
276 snprintf(crtc->timeline_name, sizeof(crtc->timeline_name),
277 "CRTC:%d-%s", crtc->base.id, crtc->name);
279 crtc->base.properties = &crtc->properties;
281 list_add_tail(&crtc->head, &config->crtc_list);
282 crtc->index = config->num_crtc++;
284 crtc->primary = primary;
285 crtc->cursor = cursor;
286 if (primary && !primary->possible_crtcs)
287 primary->possible_crtcs = drm_crtc_mask(crtc);
288 if (cursor && !cursor->possible_crtcs)
289 cursor->possible_crtcs = drm_crtc_mask(crtc);
291 ret = drm_crtc_crc_init(crtc);
293 drm_mode_object_unregister(dev, &crtc->base);
297 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
298 drm_object_attach_property(&crtc->base, config->prop_active, 0);
299 drm_object_attach_property(&crtc->base, config->prop_mode_id, 0);
300 drm_object_attach_property(&crtc->base,
301 config->prop_out_fence_ptr, 0);
302 drm_object_attach_property(&crtc->base,
303 config->prop_vrr_enabled, 0);
308 EXPORT_SYMBOL(drm_crtc_init_with_planes);
311 * drm_crtc_cleanup - Clean up the core crtc usage
312 * @crtc: CRTC to cleanup
314 * This function cleans up @crtc and removes it from the DRM mode setting
315 * core. Note that the function does *not* free the crtc structure itself,
316 * this is the responsibility of the caller.
318 void drm_crtc_cleanup(struct drm_crtc *crtc)
320 struct drm_device *dev = crtc->dev;
322 /* Note that the crtc_list is considered to be static; should we
323 * remove the drm_crtc at runtime we would have to decrement all
324 * the indices on the drm_crtc after us in the crtc_list.
327 drm_crtc_crc_fini(crtc);
329 kfree(crtc->gamma_store);
330 crtc->gamma_store = NULL;
332 drm_modeset_lock_fini(&crtc->mutex);
334 drm_mode_object_unregister(dev, &crtc->base);
335 list_del(&crtc->head);
336 dev->mode_config.num_crtc--;
338 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
339 if (crtc->state && crtc->funcs->atomic_destroy_state)
340 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
344 memset(crtc, 0, sizeof(*crtc));
346 EXPORT_SYMBOL(drm_crtc_cleanup);
349 * drm_mode_getcrtc - get CRTC configuration
350 * @dev: drm device for the ioctl
351 * @data: data pointer for the ioctl
352 * @file_priv: drm file for the ioctl call
354 * Construct a CRTC configuration structure to return to the user.
356 * Called by the user via ioctl.
359 * Zero on success, negative errno on failure.
361 int drm_mode_getcrtc(struct drm_device *dev,
362 void *data, struct drm_file *file_priv)
364 struct drm_mode_crtc *crtc_resp = data;
365 struct drm_crtc *crtc;
366 struct drm_plane *plane;
368 if (!drm_core_check_feature(dev, DRIVER_MODESET))
371 crtc = drm_crtc_find(dev, file_priv, crtc_resp->crtc_id);
375 plane = crtc->primary;
377 crtc_resp->gamma_size = crtc->gamma_size;
379 drm_modeset_lock(&plane->mutex, NULL);
380 if (plane->state && plane->state->fb)
381 crtc_resp->fb_id = plane->state->fb->base.id;
382 else if (!plane->state && plane->fb)
383 crtc_resp->fb_id = plane->fb->base.id;
385 crtc_resp->fb_id = 0;
388 crtc_resp->x = plane->state->src_x >> 16;
389 crtc_resp->y = plane->state->src_y >> 16;
391 drm_modeset_unlock(&plane->mutex);
393 drm_modeset_lock(&crtc->mutex, NULL);
395 if (crtc->state->enable) {
396 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
397 crtc_resp->mode_valid = 1;
399 crtc_resp->mode_valid = 0;
402 crtc_resp->x = crtc->x;
403 crtc_resp->y = crtc->y;
406 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
407 crtc_resp->mode_valid = 1;
410 crtc_resp->mode_valid = 0;
413 if (!file_priv->aspect_ratio_allowed)
414 crtc_resp->mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
415 drm_modeset_unlock(&crtc->mutex);
420 static int __drm_mode_set_config_internal(struct drm_mode_set *set,
421 struct drm_modeset_acquire_ctx *ctx)
423 struct drm_crtc *crtc = set->crtc;
424 struct drm_framebuffer *fb;
425 struct drm_crtc *tmp;
428 WARN_ON(drm_drv_uses_atomic_modeset(crtc->dev));
431 * NOTE: ->set_config can also disable other crtcs (if we steal all
432 * connectors from it), hence we need to refcount the fbs across all
433 * crtcs. Atomic modeset will have saner semantics ...
435 drm_for_each_crtc(tmp, crtc->dev) {
436 struct drm_plane *plane = tmp->primary;
438 plane->old_fb = plane->fb;
443 ret = crtc->funcs->set_config(set, ctx);
445 struct drm_plane *plane = crtc->primary;
447 plane->crtc = fb ? crtc : NULL;
451 drm_for_each_crtc(tmp, crtc->dev) {
452 struct drm_plane *plane = tmp->primary;
455 drm_framebuffer_get(plane->fb);
457 drm_framebuffer_put(plane->old_fb);
458 plane->old_fb = NULL;
465 * drm_mode_set_config_internal - helper to call &drm_mode_config_funcs.set_config
466 * @set: modeset config to set
468 * This is a little helper to wrap internal calls to the
469 * &drm_mode_config_funcs.set_config driver interface. The only thing it adds is
470 * correct refcounting dance.
472 * This should only be used by non-atomic legacy drivers.
475 * Zero on success, negative errno on failure.
477 int drm_mode_set_config_internal(struct drm_mode_set *set)
479 WARN_ON(drm_drv_uses_atomic_modeset(set->crtc->dev));
481 return __drm_mode_set_config_internal(set, NULL);
483 EXPORT_SYMBOL(drm_mode_set_config_internal);
486 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
488 * @crtc: CRTC that framebuffer will be displayed on
491 * @mode: mode that framebuffer will be displayed under
492 * @fb: framebuffer to check size of
494 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
496 const struct drm_display_mode *mode,
497 const struct drm_framebuffer *fb)
500 int hdisplay, vdisplay;
502 drm_mode_get_hv_timing(mode, &hdisplay, &vdisplay);
505 drm_rotation_90_or_270(crtc->primary->state->rotation))
506 swap(hdisplay, vdisplay);
508 return drm_framebuffer_check_src_coords(x << 16, y << 16,
509 hdisplay << 16, vdisplay << 16,
512 EXPORT_SYMBOL(drm_crtc_check_viewport);
515 * drm_mode_setcrtc - set CRTC configuration
516 * @dev: drm device for the ioctl
517 * @data: data pointer for the ioctl
518 * @file_priv: drm file for the ioctl call
520 * Build a new CRTC configuration based on user request.
522 * Called by the user via ioctl.
525 * Zero on success, negative errno on failure.
527 int drm_mode_setcrtc(struct drm_device *dev, void *data,
528 struct drm_file *file_priv)
530 struct drm_mode_config *config = &dev->mode_config;
531 struct drm_mode_crtc *crtc_req = data;
532 struct drm_crtc *crtc;
533 struct drm_plane *plane;
534 struct drm_connector **connector_set = NULL, *connector;
535 struct drm_framebuffer *fb = NULL;
536 struct drm_display_mode *mode = NULL;
537 struct drm_mode_set set;
538 uint32_t __user *set_connectors_ptr;
539 struct drm_modeset_acquire_ctx ctx;
543 if (!drm_core_check_feature(dev, DRIVER_MODESET))
547 * Universal plane src offsets are only 16.16, prevent havoc for
548 * drivers using universal plane code internally.
550 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
553 crtc = drm_crtc_find(dev, file_priv, crtc_req->crtc_id);
555 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
558 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc->base.id, crtc->name);
560 plane = crtc->primary;
562 /* allow disabling with the primary plane leased */
563 if (crtc_req->mode_valid && !drm_lease_held(file_priv, plane->base.id))
566 mutex_lock(&crtc->dev->mode_config.mutex);
567 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx,
568 DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
570 if (crtc_req->mode_valid) {
571 /* If we have a mode we need a framebuffer. */
572 /* If we pass -1, set the mode with the currently bound fb */
573 if (crtc_req->fb_id == -1) {
574 struct drm_framebuffer *old_fb;
577 old_fb = plane->state->fb;
582 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
588 /* Make refcounting symmetric with the lookup path. */
589 drm_framebuffer_get(fb);
591 fb = drm_framebuffer_lookup(dev, file_priv, crtc_req->fb_id);
593 DRM_DEBUG_KMS("Unknown FB ID%d\n",
600 mode = drm_mode_create(dev);
605 if (!file_priv->aspect_ratio_allowed &&
606 (crtc_req->mode.flags & DRM_MODE_FLAG_PIC_AR_MASK) != DRM_MODE_FLAG_PIC_AR_NONE) {
607 DRM_DEBUG_KMS("Unexpected aspect-ratio flag bits\n");
613 ret = drm_mode_convert_umode(dev, mode, &crtc_req->mode);
615 DRM_DEBUG_KMS("Invalid mode (ret=%d, status=%s)\n",
616 ret, drm_get_mode_status_name(mode->status));
617 drm_mode_debug_printmodeline(mode);
622 * Check whether the primary plane supports the fb pixel format.
623 * Drivers not implementing the universal planes API use a
624 * default formats list provided by the DRM core which doesn't
625 * match real hardware capabilities. Skip the check in that
628 if (!plane->format_default) {
629 ret = drm_plane_check_pixel_format(plane,
633 struct drm_format_name_buf format_name;
634 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
635 drm_get_format_name(fb->format->format,
642 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
649 if (crtc_req->count_connectors == 0 && mode) {
650 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
655 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
656 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
657 crtc_req->count_connectors);
662 if (crtc_req->count_connectors > 0) {
665 /* Avoid unbounded kernel memory allocation */
666 if (crtc_req->count_connectors > config->num_connector) {
671 connector_set = kmalloc_array(crtc_req->count_connectors,
672 sizeof(struct drm_connector *),
674 if (!connector_set) {
679 for (i = 0; i < crtc_req->count_connectors; i++) {
680 connector_set[i] = NULL;
681 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
682 if (get_user(out_id, &set_connectors_ptr[i])) {
687 connector = drm_connector_lookup(dev, file_priv, out_id);
689 DRM_DEBUG_KMS("Connector id %d unknown\n",
694 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
698 connector_set[i] = connector;
706 set.connectors = connector_set;
707 set.num_connectors = crtc_req->count_connectors;
710 if (drm_drv_uses_atomic_modeset(dev))
711 ret = crtc->funcs->set_config(&set, &ctx);
713 ret = __drm_mode_set_config_internal(&set, &ctx);
717 drm_framebuffer_put(fb);
720 for (i = 0; i < crtc_req->count_connectors; i++) {
721 if (connector_set[i])
722 drm_connector_put(connector_set[i]);
725 kfree(connector_set);
726 drm_mode_destroy(dev, mode);
728 /* In case we need to retry... */
729 connector_set = NULL;
733 DRM_MODESET_LOCK_ALL_END(ctx, ret);
734 mutex_unlock(&crtc->dev->mode_config.mutex);
739 int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
740 struct drm_property *property,
744 struct drm_crtc *crtc = obj_to_crtc(obj);
746 if (crtc->funcs->set_property)
747 ret = crtc->funcs->set_property(crtc, property, value);
749 drm_object_property_set_value(obj, property, value);