2 * Copyright (c) 2006-2008 Intel Corporation
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
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"
50 * drm_crtc_force_disable - Forcibly turn off a CRTC
51 * @crtc: CRTC to turn off
54 * Zero on success, error code on failure.
56 int drm_crtc_force_disable(struct drm_crtc *crtc)
58 struct drm_mode_set set = {
62 return drm_mode_set_config_internal(&set);
64 EXPORT_SYMBOL(drm_crtc_force_disable);
67 * drm_crtc_force_disable_all - Forcibly turn off all enabled CRTCs
68 * @dev: DRM device whose CRTCs to turn off
70 * Drivers may want to call this on unload to ensure that all displays are
71 * unlit and the GPU is in a consistent, low power state. Takes modeset locks.
74 * Zero on success, error code on failure.
76 int drm_crtc_force_disable_all(struct drm_device *dev)
78 struct drm_crtc *crtc;
81 drm_modeset_lock_all(dev);
82 drm_for_each_crtc(crtc, dev)
84 ret = drm_crtc_force_disable(crtc);
89 drm_modeset_unlock_all(dev);
92 EXPORT_SYMBOL(drm_crtc_force_disable_all);
94 static unsigned int drm_num_crtcs(struct drm_device *dev)
99 drm_for_each_crtc(tmp, dev) {
106 int drm_crtc_register_all(struct drm_device *dev)
108 struct drm_crtc *crtc;
111 drm_for_each_crtc(crtc, dev) {
112 if (drm_debugfs_crtc_add(crtc))
113 DRM_ERROR("Failed to initialize debugfs entry for CRTC '%s'.\n",
116 if (crtc->funcs->late_register)
117 ret = crtc->funcs->late_register(crtc);
125 void drm_crtc_unregister_all(struct drm_device *dev)
127 struct drm_crtc *crtc;
129 drm_for_each_crtc(crtc, dev) {
130 if (crtc->funcs->early_unregister)
131 crtc->funcs->early_unregister(crtc);
132 drm_debugfs_crtc_remove(crtc);
136 static int drm_crtc_crc_init(struct drm_crtc *crtc)
138 #ifdef CONFIG_DEBUG_FS
139 spin_lock_init(&crtc->crc.lock);
140 init_waitqueue_head(&crtc->crc.wq);
141 crtc->crc.source = kstrdup("auto", GFP_KERNEL);
142 if (!crtc->crc.source)
148 static void drm_crtc_crc_fini(struct drm_crtc *crtc)
150 #ifdef CONFIG_DEBUG_FS
151 kfree(crtc->crc.source);
155 static const struct dma_fence_ops drm_crtc_fence_ops;
157 static struct drm_crtc *fence_to_crtc(struct dma_fence *fence)
159 BUG_ON(fence->ops != &drm_crtc_fence_ops);
160 return container_of(fence->lock, struct drm_crtc, fence_lock);
163 static const char *drm_crtc_fence_get_driver_name(struct dma_fence *fence)
165 struct drm_crtc *crtc = fence_to_crtc(fence);
167 return crtc->dev->driver->name;
170 static const char *drm_crtc_fence_get_timeline_name(struct dma_fence *fence)
172 struct drm_crtc *crtc = fence_to_crtc(fence);
174 return crtc->timeline_name;
177 static bool drm_crtc_fence_enable_signaling(struct dma_fence *fence)
182 static const struct dma_fence_ops drm_crtc_fence_ops = {
183 .get_driver_name = drm_crtc_fence_get_driver_name,
184 .get_timeline_name = drm_crtc_fence_get_timeline_name,
185 .enable_signaling = drm_crtc_fence_enable_signaling,
186 .wait = dma_fence_default_wait,
189 struct dma_fence *drm_crtc_create_fence(struct drm_crtc *crtc)
191 struct dma_fence *fence;
193 fence = kzalloc(sizeof(*fence), GFP_KERNEL);
197 dma_fence_init(fence, &drm_crtc_fence_ops, &crtc->fence_lock,
198 crtc->fence_context, ++crtc->fence_seqno);
204 * drm_crtc_init_with_planes - Initialise a new CRTC object with
205 * specified primary and cursor planes.
207 * @crtc: CRTC object to init
208 * @primary: Primary plane for CRTC
209 * @cursor: Cursor plane for CRTC
210 * @funcs: callbacks for the new CRTC
211 * @name: printf style format string for the CRTC name, or NULL for default name
213 * Inits a new object created as base part of a driver crtc object. Drivers
214 * should use this function instead of drm_crtc_init(), which is only provided
215 * for backwards compatibility with drivers which do not yet support universal
216 * planes). For really simple hardware which has only 1 plane look at
217 * drm_simple_display_pipe_init() instead.
220 * Zero on success, error code on failure.
222 int drm_crtc_init_with_planes(struct drm_device *dev, struct drm_crtc *crtc,
223 struct drm_plane *primary,
224 struct drm_plane *cursor,
225 const struct drm_crtc_funcs *funcs,
226 const char *name, ...)
228 struct drm_mode_config *config = &dev->mode_config;
231 WARN_ON(primary && primary->type != DRM_PLANE_TYPE_PRIMARY);
232 WARN_ON(cursor && cursor->type != DRM_PLANE_TYPE_CURSOR);
237 INIT_LIST_HEAD(&crtc->commit_list);
238 spin_lock_init(&crtc->commit_lock);
240 drm_modeset_lock_init(&crtc->mutex);
241 ret = drm_mode_object_get(dev, &crtc->base, DRM_MODE_OBJECT_CRTC);
249 crtc->name = kvasprintf(GFP_KERNEL, name, ap);
252 crtc->name = kasprintf(GFP_KERNEL, "crtc-%d",
256 drm_mode_object_unregister(dev, &crtc->base);
260 crtc->fence_context = dma_fence_context_alloc(1);
261 spin_lock_init(&crtc->fence_lock);
262 snprintf(crtc->timeline_name, sizeof(crtc->timeline_name),
263 "CRTC:%d-%s", crtc->base.id, crtc->name);
265 crtc->base.properties = &crtc->properties;
267 list_add_tail(&crtc->head, &config->crtc_list);
268 crtc->index = config->num_crtc++;
270 crtc->primary = primary;
271 crtc->cursor = cursor;
272 if (primary && !primary->possible_crtcs)
273 primary->possible_crtcs = 1 << drm_crtc_index(crtc);
274 if (cursor && !cursor->possible_crtcs)
275 cursor->possible_crtcs = 1 << drm_crtc_index(crtc);
277 ret = drm_crtc_crc_init(crtc);
279 drm_mode_object_unregister(dev, &crtc->base);
283 if (drm_core_check_feature(dev, DRIVER_ATOMIC)) {
284 drm_object_attach_property(&crtc->base, config->prop_active, 0);
285 drm_object_attach_property(&crtc->base, config->prop_mode_id, 0);
286 drm_object_attach_property(&crtc->base,
287 config->prop_out_fence_ptr, 0);
292 EXPORT_SYMBOL(drm_crtc_init_with_planes);
295 * drm_crtc_cleanup - Clean up the core crtc usage
296 * @crtc: CRTC to cleanup
298 * This function cleans up @crtc and removes it from the DRM mode setting
299 * core. Note that the function does *not* free the crtc structure itself,
300 * this is the responsibility of the caller.
302 void drm_crtc_cleanup(struct drm_crtc *crtc)
304 struct drm_device *dev = crtc->dev;
306 /* Note that the crtc_list is considered to be static; should we
307 * remove the drm_crtc at runtime we would have to decrement all
308 * the indices on the drm_crtc after us in the crtc_list.
311 drm_crtc_crc_fini(crtc);
313 kfree(crtc->gamma_store);
314 crtc->gamma_store = NULL;
316 drm_modeset_lock_fini(&crtc->mutex);
318 drm_mode_object_unregister(dev, &crtc->base);
319 list_del(&crtc->head);
320 dev->mode_config.num_crtc--;
322 WARN_ON(crtc->state && !crtc->funcs->atomic_destroy_state);
323 if (crtc->state && crtc->funcs->atomic_destroy_state)
324 crtc->funcs->atomic_destroy_state(crtc, crtc->state);
328 memset(crtc, 0, sizeof(*crtc));
330 EXPORT_SYMBOL(drm_crtc_cleanup);
333 * drm_mode_getcrtc - get CRTC configuration
334 * @dev: drm device for the ioctl
335 * @data: data pointer for the ioctl
336 * @file_priv: drm file for the ioctl call
338 * Construct a CRTC configuration structure to return to the user.
340 * Called by the user via ioctl.
343 * Zero on success, negative errno on failure.
345 int drm_mode_getcrtc(struct drm_device *dev,
346 void *data, struct drm_file *file_priv)
348 struct drm_mode_crtc *crtc_resp = data;
349 struct drm_crtc *crtc;
351 if (!drm_core_check_feature(dev, DRIVER_MODESET))
354 crtc = drm_crtc_find(dev, crtc_resp->crtc_id);
358 drm_modeset_lock_crtc(crtc, crtc->primary);
359 crtc_resp->gamma_size = crtc->gamma_size;
360 if (crtc->primary->fb)
361 crtc_resp->fb_id = crtc->primary->fb->base.id;
363 crtc_resp->fb_id = 0;
366 crtc_resp->x = crtc->primary->state->src_x >> 16;
367 crtc_resp->y = crtc->primary->state->src_y >> 16;
368 if (crtc->state->enable) {
369 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->state->mode);
370 crtc_resp->mode_valid = 1;
373 crtc_resp->mode_valid = 0;
376 crtc_resp->x = crtc->x;
377 crtc_resp->y = crtc->y;
379 drm_mode_convert_to_umode(&crtc_resp->mode, &crtc->mode);
380 crtc_resp->mode_valid = 1;
383 crtc_resp->mode_valid = 0;
386 drm_modeset_unlock_crtc(crtc);
392 * drm_mode_set_config_internal - helper to call ->set_config
393 * @set: modeset config to set
395 * This is a little helper to wrap internal calls to the ->set_config driver
396 * interface. The only thing it adds is correct refcounting dance.
399 * Zero on success, negative errno on failure.
401 int drm_mode_set_config_internal(struct drm_mode_set *set)
403 struct drm_crtc *crtc = set->crtc;
404 struct drm_framebuffer *fb;
405 struct drm_crtc *tmp;
409 * NOTE: ->set_config can also disable other crtcs (if we steal all
410 * connectors from it), hence we need to refcount the fbs across all
411 * crtcs. Atomic modeset will have saner semantics ...
413 drm_for_each_crtc(tmp, crtc->dev)
414 tmp->primary->old_fb = tmp->primary->fb;
418 ret = crtc->funcs->set_config(set);
420 crtc->primary->crtc = crtc;
421 crtc->primary->fb = fb;
424 drm_for_each_crtc(tmp, crtc->dev) {
425 if (tmp->primary->fb)
426 drm_framebuffer_reference(tmp->primary->fb);
427 if (tmp->primary->old_fb)
428 drm_framebuffer_unreference(tmp->primary->old_fb);
429 tmp->primary->old_fb = NULL;
434 EXPORT_SYMBOL(drm_mode_set_config_internal);
437 * drm_crtc_get_hv_timing - Fetches hdisplay/vdisplay for given mode
438 * @mode: mode to query
439 * @hdisplay: hdisplay value to fill in
440 * @vdisplay: vdisplay value to fill in
442 * The vdisplay value will be doubled if the specified mode is a stereo mode of
443 * the appropriate layout.
445 void drm_crtc_get_hv_timing(const struct drm_display_mode *mode,
446 int *hdisplay, int *vdisplay)
448 struct drm_display_mode adjusted;
450 drm_mode_copy(&adjusted, mode);
451 drm_mode_set_crtcinfo(&adjusted, CRTC_STEREO_DOUBLE_ONLY);
452 *hdisplay = adjusted.crtc_hdisplay;
453 *vdisplay = adjusted.crtc_vdisplay;
455 EXPORT_SYMBOL(drm_crtc_get_hv_timing);
458 * drm_crtc_check_viewport - Checks that a framebuffer is big enough for the
460 * @crtc: CRTC that framebuffer will be displayed on
463 * @mode: mode that framebuffer will be displayed under
464 * @fb: framebuffer to check size of
466 int drm_crtc_check_viewport(const struct drm_crtc *crtc,
468 const struct drm_display_mode *mode,
469 const struct drm_framebuffer *fb)
472 int hdisplay, vdisplay;
474 drm_crtc_get_hv_timing(mode, &hdisplay, &vdisplay);
477 drm_rotation_90_or_270(crtc->primary->state->rotation))
478 swap(hdisplay, vdisplay);
480 return drm_framebuffer_check_src_coords(x << 16, y << 16,
481 hdisplay << 16, vdisplay << 16,
484 EXPORT_SYMBOL(drm_crtc_check_viewport);
487 * drm_mode_setcrtc - set CRTC configuration
488 * @dev: drm device for the ioctl
489 * @data: data pointer for the ioctl
490 * @file_priv: drm file for the ioctl call
492 * Build a new CRTC configuration based on user request.
494 * Called by the user via ioctl.
497 * Zero on success, negative errno on failure.
499 int drm_mode_setcrtc(struct drm_device *dev, void *data,
500 struct drm_file *file_priv)
502 struct drm_mode_config *config = &dev->mode_config;
503 struct drm_mode_crtc *crtc_req = data;
504 struct drm_crtc *crtc;
505 struct drm_connector **connector_set = NULL, *connector;
506 struct drm_framebuffer *fb = NULL;
507 struct drm_display_mode *mode = NULL;
508 struct drm_mode_set set;
509 uint32_t __user *set_connectors_ptr;
513 if (!drm_core_check_feature(dev, DRIVER_MODESET))
517 * Universal plane src offsets are only 16.16, prevent havoc for
518 * drivers using universal plane code internally.
520 if (crtc_req->x & 0xffff0000 || crtc_req->y & 0xffff0000)
523 drm_modeset_lock_all(dev);
524 crtc = drm_crtc_find(dev, crtc_req->crtc_id);
526 DRM_DEBUG_KMS("Unknown CRTC ID %d\n", crtc_req->crtc_id);
530 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc->base.id, crtc->name);
532 if (crtc_req->mode_valid) {
533 /* If we have a mode we need a framebuffer. */
534 /* If we pass -1, set the mode with the currently bound fb */
535 if (crtc_req->fb_id == -1) {
536 if (!crtc->primary->fb) {
537 DRM_DEBUG_KMS("CRTC doesn't have current FB\n");
541 fb = crtc->primary->fb;
542 /* Make refcounting symmetric with the lookup path. */
543 drm_framebuffer_reference(fb);
545 fb = drm_framebuffer_lookup(dev, crtc_req->fb_id);
547 DRM_DEBUG_KMS("Unknown FB ID%d\n",
554 mode = drm_mode_create(dev);
560 ret = drm_mode_convert_umode(mode, &crtc_req->mode);
562 DRM_DEBUG_KMS("Invalid mode\n");
567 * Check whether the primary plane supports the fb pixel format.
568 * Drivers not implementing the universal planes API use a
569 * default formats list provided by the DRM core which doesn't
570 * match real hardware capabilities. Skip the check in that
573 if (!crtc->primary->format_default) {
574 ret = drm_plane_check_pixel_format(crtc->primary,
577 struct drm_format_name_buf format_name;
578 DRM_DEBUG_KMS("Invalid pixel format %s\n",
579 drm_get_format_name(fb->pixel_format,
585 ret = drm_crtc_check_viewport(crtc, crtc_req->x, crtc_req->y,
592 if (crtc_req->count_connectors == 0 && mode) {
593 DRM_DEBUG_KMS("Count connectors is 0 but mode set\n");
598 if (crtc_req->count_connectors > 0 && (!mode || !fb)) {
599 DRM_DEBUG_KMS("Count connectors is %d but no mode or fb set\n",
600 crtc_req->count_connectors);
605 if (crtc_req->count_connectors > 0) {
608 /* Avoid unbounded kernel memory allocation */
609 if (crtc_req->count_connectors > config->num_connector) {
614 connector_set = kmalloc_array(crtc_req->count_connectors,
615 sizeof(struct drm_connector *),
617 if (!connector_set) {
622 for (i = 0; i < crtc_req->count_connectors; i++) {
623 connector_set[i] = NULL;
624 set_connectors_ptr = (uint32_t __user *)(unsigned long)crtc_req->set_connectors_ptr;
625 if (get_user(out_id, &set_connectors_ptr[i])) {
630 connector = drm_connector_lookup(dev, out_id);
632 DRM_DEBUG_KMS("Connector id %d unknown\n",
637 DRM_DEBUG_KMS("[CONNECTOR:%d:%s]\n",
641 connector_set[i] = connector;
649 set.connectors = connector_set;
650 set.num_connectors = crtc_req->count_connectors;
652 ret = drm_mode_set_config_internal(&set);
656 drm_framebuffer_unreference(fb);
659 for (i = 0; i < crtc_req->count_connectors; i++) {
660 if (connector_set[i])
661 drm_connector_unreference(connector_set[i]);
664 kfree(connector_set);
665 drm_mode_destroy(dev, mode);
666 drm_modeset_unlock_all(dev);
670 int drm_mode_crtc_set_obj_prop(struct drm_mode_object *obj,
671 struct drm_property *property,
675 struct drm_crtc *crtc = obj_to_crtc(obj);
677 if (crtc->funcs->set_property)
678 ret = crtc->funcs->set_property(crtc, property, value);
680 drm_object_property_set_value(obj, property, value);