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.
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 drm_debugfs_crtc_add(crtc);
127 if (crtc->funcs->late_register)
128 ret = crtc->funcs->late_register(crtc);
136 void drm_crtc_unregister_all(struct drm_device *dev)
138 struct drm_crtc *crtc;
140 drm_for_each_crtc(crtc, dev) {
141 if (crtc->funcs->early_unregister)
142 crtc->funcs->early_unregister(crtc);
143 drm_debugfs_crtc_remove(crtc);
147 static int drm_crtc_crc_init(struct drm_crtc *crtc)
149 #ifdef CONFIG_DEBUG_FS
150 spin_lock_init(&crtc->crc.lock);
151 init_waitqueue_head(&crtc->crc.wq);
152 crtc->crc.source = kstrdup("auto", GFP_KERNEL);
153 if (!crtc->crc.source)
159 static void drm_crtc_crc_fini(struct drm_crtc *crtc)
161 #ifdef CONFIG_DEBUG_FS
162 kfree(crtc->crc.source);
166 static const struct dma_fence_ops drm_crtc_fence_ops;
168 static struct drm_crtc *fence_to_crtc(struct dma_fence *fence)
170 BUG_ON(fence->ops != &drm_crtc_fence_ops);
171 return container_of(fence->lock, struct drm_crtc, fence_lock);
174 static const char *drm_crtc_fence_get_driver_name(struct dma_fence *fence)
176 struct drm_crtc *crtc = fence_to_crtc(fence);
178 return crtc->dev->driver->name;
181 static const char *drm_crtc_fence_get_timeline_name(struct dma_fence *fence)
183 struct drm_crtc *crtc = fence_to_crtc(fence);
185 return crtc->timeline_name;
188 static const struct dma_fence_ops drm_crtc_fence_ops = {
189 .get_driver_name = drm_crtc_fence_get_driver_name,
190 .get_timeline_name = drm_crtc_fence_get_timeline_name,
193 struct dma_fence *drm_crtc_create_fence(struct drm_crtc *crtc)
195 struct dma_fence *fence;
197 fence = kzalloc(sizeof(*fence), GFP_KERNEL);
201 dma_fence_init(fence, &drm_crtc_fence_ops, &crtc->fence_lock,
202 crtc->fence_context, ++crtc->fence_seqno);
208 * DOC: standard CRTC properties
210 * DRM CRTCs have a few standardized properties:
213 * Atomic property for setting the power state of the CRTC. When set to 1
214 * the CRTC will actively display content. When set to 0 the CRTC will be
215 * powered off. There is no expectation that user-space will reset CRTC
216 * resources like the mode and planes when setting ACTIVE to 0.
218 * User-space can rely on an ACTIVE change to 1 to never fail an atomic
219 * test as long as no other property has changed. If a change to ACTIVE
220 * fails an atomic test, this is a driver bug. For this reason setting
221 * ACTIVE to 0 must not release internal resources (like reserved memory
222 * bandwidth or clock generators).
224 * Note that the legacy DPMS property on connectors is internally routed
225 * to control this property for atomic drivers.
227 * Atomic property for setting the CRTC display timings. The value is the
228 * ID of a blob containing the DRM mode info. To disable the CRTC,
229 * user-space must set this property to 0.
231 * Setting MODE_ID to 0 will release reserved resources for the CRTC.
233 * Atomic property for setting the scaling filter for CRTC scaler
235 * The value of this property can be one of the following:
238 * Driver's default scaling filter
240 * Nearest Neighbor scaling filter
244 * drm_crtc_init_with_planes - Initialise a new CRTC object with
245 * specified primary and cursor planes.
247 * @crtc: CRTC object to init
248 * @primary: Primary plane for CRTC
249 * @cursor: Cursor plane for CRTC
250 * @funcs: callbacks for the new CRTC
251 * @name: printf style format string for the CRTC name, or NULL for default name
253 * Inits a new object created as base part of a driver crtc object. Drivers
254 * should use this function instead of drm_crtc_init(), which is only provided
255 * for backwards compatibility with drivers which do not yet support universal
256 * planes). For really simple hardware which has only 1 plane look at
257 * drm_simple_display_pipe_init() instead.
259 * The @primary and @cursor planes are only relevant for legacy uAPI, see
260 * &drm_crtc.primary and &drm_crtc.cursor.
263 * Zero on success, error code on failure.
265 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
266 struct drm_plane *primary,
267 struct drm_plane *cursor,
268 const struct drm_crtc_funcs *funcs,
269 const char *name, ...)
271 struct drm_mode_config *config = &dev->mode_config;
274 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
275 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
277 /* crtc index is used with 32bit bitmasks */
278 if (WARN_ON(config->num_crtc >= 32))
281 WARN_ON(drm_drv_uses_atomic_modeset(dev) &&
282 (!funcs->atomic_destroy_state ||
283 !funcs->atomic_duplicate_state));
288 INIT_LIST_HEAD(&crtc->commit_list);
289 spin_lock_init(&crtc->commit_lock);
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 spin_lock_init(&crtc->fence_lock);
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 = drm_crtc_mask(crtc);
325 if (cursor && !cursor->possible_crtcs)
326 cursor->possible_crtcs = drm_crtc_mask(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);
339 drm_object_attach_property(&crtc->base,
340 config->prop_vrr_enabled, 0);
345 EXPORT_SYMBOL(drm_crtc_init_with_planes);
348 * drm_crtc_cleanup - Clean up the core crtc usage
349 * @crtc: CRTC to cleanup
351 * This function cleans up @crtc and removes it from the DRM mode setting
352 * core. Note that the function does *not* free the crtc structure itself,
353 * this is the responsibility of the caller.
355 void drm_crtc_cleanup(struct drm_crtc *crtc)
357 struct drm_device *dev = crtc->dev;
359 /* Note that the crtc_list is considered to be static; should we
360 * remove the drm_crtc at runtime we would have to decrement all
361 * the indices on the drm_crtc after us in the crtc_list.
364 drm_crtc_crc_fini(crtc);
366 kfree(crtc->gamma_store);
367 crtc->gamma_store = NULL;
369 drm_modeset_lock_fini(&crtc->mutex);
371 drm_mode_object_unregister(dev, &crtc->base);
372 list_del(&crtc->head);
373 dev->mode_config.num_crtc--;
375 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
376 if (crtc->state && crtc->funcs->atomic_destroy_state)
377 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
381 memset(crtc, 0, sizeof(*crtc));
383 EXPORT_SYMBOL(drm_crtc_cleanup);
386 * drm_mode_getcrtc - get CRTC configuration
387 * @dev: drm device for the ioctl
388 * @data: data pointer for the ioctl
389 * @file_priv: drm file for the ioctl call
391 * Construct a CRTC configuration structure to return to the user.
393 * Called by the user via ioctl.
396 * Zero on success, negative errno on failure.
398 int drm_mode_getcrtc(struct drm_device *dev,
399 void *data, struct drm_file *file_priv)
401 struct drm_mode_crtc *crtc_resp = data;
402 struct drm_crtc *crtc;
403 struct drm_plane *plane;
405 if (!drm_core_check_feature(dev, DRIVER_MODESET))
408 crtc = drm_crtc_find(dev, file_priv, crtc_resp->crtc_id);
412 plane = crtc->primary;
414 crtc_resp->gamma_size = crtc->gamma_size;
416 drm_modeset_lock(&plane->mutex, NULL);
417 if (plane->state && plane->state->fb)
418 crtc_resp->fb_id = plane->state->fb->base.id;
419 else if (!plane->state && plane->fb)
420 crtc_resp->fb_id = plane->fb->base.id;
422 crtc_resp->fb_id = 0;
425 crtc_resp->x = plane->state->src_x >> 16;
426 crtc_resp->y = plane->state->src_y >> 16;
428 drm_modeset_unlock(&plane->mutex);
430 drm_modeset_lock(&crtc->mutex, NULL);
432 if (crtc->state->enable) {
433 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
434 crtc_resp->mode_valid = 1;
436 crtc_resp->mode_valid = 0;
439 crtc_resp->x = crtc->x;
440 crtc_resp->y = crtc->y;
443 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
444 crtc_resp->mode_valid = 1;
447 crtc_resp->mode_valid = 0;
450 if (!file_priv->aspect_ratio_allowed)
451 crtc_resp->mode.flags &= ~DRM_MODE_FLAG_PIC_AR_MASK;
452 drm_modeset_unlock(&crtc->mutex);
457 static int __drm_mode_set_config_internal(struct drm_mode_set *set,
458 struct drm_modeset_acquire_ctx *ctx)
460 struct drm_crtc *crtc = set->crtc;
461 struct drm_framebuffer *fb;
462 struct drm_crtc *tmp;
465 WARN_ON(drm_drv_uses_atomic_modeset(crtc->dev));
468 * NOTE: ->set_config can also disable other crtcs (if we steal all
469 * connectors from it), hence we need to refcount the fbs across all
470 * crtcs. Atomic modeset will have saner semantics ...
472 drm_for_each_crtc(tmp, crtc->dev) {
473 struct drm_plane *plane = tmp->primary;
475 plane->old_fb = plane->fb;
480 ret = crtc->funcs->set_config(set, ctx);
482 struct drm_plane *plane = crtc->primary;
484 plane->crtc = fb ? crtc : NULL;
488 drm_for_each_crtc(tmp, crtc->dev) {
489 struct drm_plane *plane = tmp->primary;
492 drm_framebuffer_get(plane->fb);
494 drm_framebuffer_put(plane->old_fb);
495 plane->old_fb = NULL;
502 * drm_mode_set_config_internal - helper to call &drm_mode_config_funcs.set_config
503 * @set: modeset config to set
505 * This is a little helper to wrap internal calls to the
506 * &drm_mode_config_funcs.set_config driver interface. The only thing it adds is
507 * correct refcounting dance.
509 * This should only be used by non-atomic legacy drivers.
512 * Zero on success, negative errno on failure.
514 int drm_mode_set_config_internal(struct drm_mode_set *set)
516 WARN_ON(drm_drv_uses_atomic_modeset(set->crtc->dev));
518 return __drm_mode_set_config_internal(set, NULL);
520 EXPORT_SYMBOL(drm_mode_set_config_internal);
523 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
525 * @crtc: CRTC that framebuffer will be displayed on
528 * @mode: mode that framebuffer will be displayed under
529 * @fb: framebuffer to check size of
531 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
533 const struct drm_display_mode *mode,
534 const struct drm_framebuffer *fb)
537 int hdisplay, vdisplay;
539 drm_mode_get_hv_timing(mode, &hdisplay, &vdisplay);
542 drm_rotation_90_or_270(crtc->primary->state->rotation))
543 swap(hdisplay, vdisplay);
545 return drm_framebuffer_check_src_coords(x << 16, y << 16,
546 hdisplay << 16, vdisplay << 16,
549 EXPORT_SYMBOL(drm_crtc_check_viewport);
552 * drm_mode_setcrtc - set CRTC configuration
553 * @dev: drm device for the ioctl
554 * @data: data pointer for the ioctl
555 * @file_priv: drm file for the ioctl call
557 * Build a new CRTC configuration based on user request.
559 * Called by the user via ioctl.
562 * Zero on success, negative errno on failure.
564 int drm_mode_setcrtc(struct drm_device *dev, void *data,
565 struct drm_file *file_priv)
567 struct drm_mode_config *config = &dev->mode_config;
568 struct drm_mode_crtc *crtc_req = data;
569 struct drm_crtc *crtc;
570 struct drm_plane *plane;
571 struct drm_connector **connector_set = NULL, *connector;
572 struct drm_framebuffer *fb = NULL;
573 struct drm_display_mode *mode = NULL;
574 struct drm_mode_set set;
575 uint32_t __user *set_connectors_ptr;
576 struct drm_modeset_acquire_ctx ctx;
580 if (!drm_core_check_feature(dev, DRIVER_MODESET))
584 * Universal plane src offsets are only 16.16, prevent havoc for
585 * drivers using universal plane code internally.
587 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
590 crtc = drm_crtc_find(dev, file_priv, crtc_req->crtc_id);
592 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
595 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc->base.id, crtc->name);
597 plane = crtc->primary;
599 /* allow disabling with the primary plane leased */
600 if (crtc_req->mode_valid && !drm_lease_held(file_priv, plane->base.id))
603 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx,
604 DRM_MODESET_ACQUIRE_INTERRUPTIBLE, ret);
606 if (crtc_req->mode_valid) {
607 /* If we have a mode we need a framebuffer. */
608 /* If we pass -1, set the mode with the currently bound fb */
609 if (crtc_req->fb_id == -1) {
610 struct drm_framebuffer *old_fb;
613 old_fb = plane->state->fb;
618 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
624 /* Make refcounting symmetric with the lookup path. */
625 drm_framebuffer_get(fb);
627 fb = drm_framebuffer_lookup(dev, file_priv, crtc_req->fb_id);
629 DRM_DEBUG_KMS("Unknown FB ID%d\n",
636 mode = drm_mode_create(dev);
641 if (!file_priv->aspect_ratio_allowed &&
642 (crtc_req->mode.flags & DRM_MODE_FLAG_PIC_AR_MASK) != DRM_MODE_FLAG_PIC_AR_NONE) {
643 DRM_DEBUG_KMS("Unexpected aspect-ratio flag bits\n");
649 ret = drm_mode_convert_umode(dev, mode, &crtc_req->mode);
651 DRM_DEBUG_KMS("Invalid mode (ret=%d, status=%s)\n",
652 ret, drm_get_mode_status_name(mode->status));
653 drm_mode_debug_printmodeline(mode);
658 * Check whether the primary plane supports the fb pixel format.
659 * Drivers not implementing the universal planes API use a
660 * default formats list provided by the DRM core which doesn't
661 * match real hardware capabilities. Skip the check in that
664 if (!plane->format_default) {
665 ret = drm_plane_check_pixel_format(plane,
669 struct drm_format_name_buf format_name;
671 DRM_DEBUG_KMS("Invalid pixel format %s, modifier 0x%llx\n",
672 drm_get_format_name(fb->format->format,
679 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
686 if (crtc_req->count_connectors == 0 && mode) {
687 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
692 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
693 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
694 crtc_req->count_connectors);
699 if (crtc_req->count_connectors > 0) {
702 /* Avoid unbounded kernel memory allocation */
703 if (crtc_req->count_connectors > config->num_connector) {
708 connector_set = kmalloc_array(crtc_req->count_connectors,
709 sizeof(struct drm_connector *),
711 if (!connector_set) {
716 for (i = 0; i < crtc_req->count_connectors; i++) {
717 connector_set[i] = NULL;
718 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
719 if (get_user(out_id, &set_connectors_ptr[i])) {
724 connector = drm_connector_lookup(dev, file_priv, out_id);
726 DRM_DEBUG_KMS("Connector id %d unknown\n",
731 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
735 connector_set[i] = connector;
743 set.connectors = connector_set;
744 set.num_connectors = crtc_req->count_connectors;
747 if (drm_drv_uses_atomic_modeset(dev))
748 ret = crtc->funcs->set_config(&set, &ctx);
750 ret = __drm_mode_set_config_internal(&set, &ctx);
754 drm_framebuffer_put(fb);
757 for (i = 0; i < crtc_req->count_connectors; i++) {
758 if (connector_set[i])
759 drm_connector_put(connector_set[i]);
762 kfree(connector_set);
763 drm_mode_destroy(dev, mode);
765 /* In case we need to retry... */
766 connector_set = NULL;
770 DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
775 int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
776 struct drm_property *property,
780 struct drm_crtc *crtc = obj_to_crtc(obj);
782 if (crtc->funcs->set_property)
783 ret = crtc->funcs->set_property(crtc, property, value);
785 drm_object_property_set_value(obj, property, value);
791 * drm_crtc_create_scaling_filter_property - create a new scaling filter
795 * @supported_filters: bitmask of supported scaling filters, must include
796 * BIT(DRM_SCALING_FILTER_DEFAULT).
798 * This function lets driver to enable the scaling filter property on a given
802 * Zero for success or -errno
804 int drm_crtc_create_scaling_filter_property(struct drm_crtc *crtc,
805 unsigned int supported_filters)
807 struct drm_property *prop =
808 drm_create_scaling_filter_prop(crtc->dev, supported_filters);
811 return PTR_ERR(prop);
813 drm_object_attach_property(&crtc->base, prop,
814 DRM_SCALING_FILTER_DEFAULT);
815 crtc->scaling_filter_property = prop;
819 EXPORT_SYMBOL(drm_crtc_create_scaling_filter_property);