2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 * DRM core CRTC related functions
7 * Permission to use, copy, modify, distribute, and sell this software and its
8 * documentation for any purpose is hereby granted without fee, provided that
9 * the above copyright notice appear in all copies and that both that copyright
10 * notice and this permission notice appear in supporting documentation, and
11 * that the name of the copyright holders not be used in advertising or
12 * publicity pertaining to distribution of the software without specific,
13 * written prior permission. The copyright holders make no representations
14 * about the suitability of this software for any purpose. It is provided "as
15 * is" without express or implied warranty.
17 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
19 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
20 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
22 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Eric Anholt <eric@anholt.net>
28 * Dave Airlie <airlied@linux.ie>
29 * Jesse Barnes <jesse.barnes@intel.com>
32 #include <linux/kernel.h>
33 #include <linux/export.h>
34 #include <linux/moduleparam.h>
37 #include <drm/drm_atomic.h>
38 #include <drm/drm_crtc.h>
39 #include <drm/drm_fourcc.h>
40 #include <drm/drm_crtc_helper.h>
41 #include <drm/drm_fb_helper.h>
42 #include <drm/drm_plane_helper.h>
43 #include <drm/drm_atomic_helper.h>
44 #include <drm/drm_edid.h>
49 * The CRTC modeset helper library provides a default set_config implementation
50 * in drm_crtc_helper_set_config(). Plus a few other convenience functions using
51 * the same callbacks which drivers can use to e.g. restore the modeset
52 * configuration on resume with drm_helper_resume_force_mode().
54 * Note that this helper library doesn't track the current power state of CRTCs
55 * and encoders. It can call callbacks like ->dpms() even though the hardware is
56 * already in the desired state. This deficiency has been fixed in the atomic
59 * The driver callbacks are mostly compatible with the atomic modeset helpers,
60 * except for the handling of the primary plane: Atomic helpers require that the
61 * primary plane is implemented as a real standalone plane and not directly tied
62 * to the CRTC state. For easier transition this library provides functions to
63 * implement the old semantics required by the CRTC helpers using the new plane
64 * and atomic helper callbacks.
66 * Drivers are strongly urged to convert to the atomic helpers (by way of first
67 * converting to the plane helpers). New drivers must not use these functions
68 * but need to implement the atomic interface instead, potentially using the
69 * atomic helpers for that.
71 * These legacy modeset helpers use the same function table structures as
72 * all other modesetting helpers. See the documentation for struct
73 * &drm_crtc_helper_funcs, struct &drm_encoder_helper_funcs and struct
74 * &drm_connector_helper_funcs.
78 * drm_helper_move_panel_connectors_to_head() - move panels to the front in the
80 * @dev: drm device to operate on
82 * Some userspace presumes that the first connected connector is the main
83 * display, where it's supposed to display e.g. the login screen. For
84 * laptops, this should be the main panel. Use this function to sort all
85 * (eDP/LVDS) panels to the front of the connector list, instead of
86 * painstakingly trying to initialize them in the right order.
88 void drm_helper_move_panel_connectors_to_head(struct drm_device *dev)
90 struct drm_connector *connector, *tmp;
91 struct list_head panel_list;
93 INIT_LIST_HEAD(&panel_list);
95 list_for_each_entry_safe(connector, tmp,
96 &dev->mode_config.connector_list, head) {
97 if (connector->connector_type == DRM_MODE_CONNECTOR_LVDS ||
98 connector->connector_type == DRM_MODE_CONNECTOR_eDP)
99 list_move_tail(&connector->head, &panel_list);
102 list_splice(&panel_list, &dev->mode_config.connector_list);
104 EXPORT_SYMBOL(drm_helper_move_panel_connectors_to_head);
107 * drm_helper_encoder_in_use - check if a given encoder is in use
108 * @encoder: encoder to check
110 * Checks whether @encoder is with the current mode setting output configuration
111 * in use by any connector. This doesn't mean that it is actually enabled since
112 * the DPMS state is tracked separately.
115 * True if @encoder is used, false otherwise.
117 bool drm_helper_encoder_in_use(struct drm_encoder *encoder)
119 struct drm_connector *connector;
120 struct drm_device *dev = encoder->dev;
123 * We can expect this mutex to be locked if we are not panicking.
124 * Locking is currently fubar in the panic handler.
126 if (!oops_in_progress) {
127 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
128 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
131 drm_for_each_connector(connector, dev)
132 if (connector->encoder == encoder)
136 EXPORT_SYMBOL(drm_helper_encoder_in_use);
139 * drm_helper_crtc_in_use - check if a given CRTC is in a mode_config
140 * @crtc: CRTC to check
142 * Checks whether @crtc is with the current mode setting output configuration
143 * in use by any connector. This doesn't mean that it is actually enabled since
144 * the DPMS state is tracked separately.
147 * True if @crtc is used, false otherwise.
149 bool drm_helper_crtc_in_use(struct drm_crtc *crtc)
151 struct drm_encoder *encoder;
152 struct drm_device *dev = crtc->dev;
155 * We can expect this mutex to be locked if we are not panicking.
156 * Locking is currently fubar in the panic handler.
158 if (!oops_in_progress)
159 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
161 drm_for_each_encoder(encoder, dev)
162 if (encoder->crtc == crtc && drm_helper_encoder_in_use(encoder))
166 EXPORT_SYMBOL(drm_helper_crtc_in_use);
169 drm_encoder_disable(struct drm_encoder *encoder)
171 const struct drm_encoder_helper_funcs *encoder_funcs = encoder->helper_private;
173 drm_bridge_disable(encoder->bridge);
175 if (encoder_funcs->disable)
176 (*encoder_funcs->disable)(encoder);
178 (*encoder_funcs->dpms)(encoder, DRM_MODE_DPMS_OFF);
180 drm_bridge_post_disable(encoder->bridge);
183 static void __drm_helper_disable_unused_functions(struct drm_device *dev)
185 struct drm_encoder *encoder;
186 struct drm_crtc *crtc;
188 drm_warn_on_modeset_not_all_locked(dev);
190 drm_for_each_encoder(encoder, dev) {
191 if (!drm_helper_encoder_in_use(encoder)) {
192 drm_encoder_disable(encoder);
193 /* disconnect encoder from any connector */
194 encoder->crtc = NULL;
198 drm_for_each_crtc(crtc, dev) {
199 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
200 crtc->enabled = drm_helper_crtc_in_use(crtc);
201 if (!crtc->enabled) {
202 if (crtc_funcs->disable)
203 (*crtc_funcs->disable)(crtc);
205 (*crtc_funcs->dpms)(crtc, DRM_MODE_DPMS_OFF);
206 crtc->primary->fb = NULL;
212 * drm_helper_disable_unused_functions - disable unused objects
215 * This function walks through the entire mode setting configuration of @dev. It
216 * will remove any CRTC links of unused encoders and encoder links of
217 * disconnected connectors. Then it will disable all unused encoders and CRTCs
218 * either by calling their disable callback if available or by calling their
219 * dpms callback with DRM_MODE_DPMS_OFF.
223 * This function is part of the legacy modeset helper library and will cause
224 * major confusion with atomic drivers. This is because atomic helpers guarantee
225 * to never call ->disable() hooks on a disabled function, or ->enable() hooks
226 * on an enabled functions. drm_helper_disable_unused_functions() on the other
227 * hand throws such guarantees into the wind and calls disable hooks
228 * unconditionally on unused functions.
230 void drm_helper_disable_unused_functions(struct drm_device *dev)
232 drm_modeset_lock_all(dev);
233 __drm_helper_disable_unused_functions(dev);
234 drm_modeset_unlock_all(dev);
236 EXPORT_SYMBOL(drm_helper_disable_unused_functions);
239 * Check the CRTC we're going to map each output to vs. its current
240 * CRTC. If they don't match, we have to disable the output and the CRTC
241 * since the driver will have to re-route things.
244 drm_crtc_prepare_encoders(struct drm_device *dev)
246 const struct drm_encoder_helper_funcs *encoder_funcs;
247 struct drm_encoder *encoder;
249 drm_for_each_encoder(encoder, dev) {
250 encoder_funcs = encoder->helper_private;
251 /* Disable unused encoders */
252 if (encoder->crtc == NULL)
253 drm_encoder_disable(encoder);
254 /* Disable encoders whose CRTC is about to change */
255 if (encoder_funcs->get_crtc &&
256 encoder->crtc != (*encoder_funcs->get_crtc)(encoder))
257 drm_encoder_disable(encoder);
262 * drm_crtc_helper_set_mode - internal helper to set a mode
263 * @crtc: CRTC to program
265 * @x: horizontal offset into the surface
266 * @y: vertical offset into the surface
267 * @old_fb: old framebuffer, for cleanup
269 * Try to set @mode on @crtc. Give @crtc and its associated connectors a chance
270 * to fixup or reject the mode prior to trying to set it. This is an internal
271 * helper that drivers could e.g. use to update properties that require the
272 * entire output pipe to be disabled and re-enabled in a new configuration. For
273 * example for changing whether audio is enabled on a hdmi link or for changing
274 * panel fitter or dither attributes. It is also called by the
275 * drm_crtc_helper_set_config() helper function to drive the mode setting
279 * True if the mode was set successfully, false otherwise.
281 bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
282 struct drm_display_mode *mode,
284 struct drm_framebuffer *old_fb)
286 struct drm_device *dev = crtc->dev;
287 struct drm_display_mode *adjusted_mode, saved_mode, saved_hwmode;
288 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
289 const struct drm_encoder_helper_funcs *encoder_funcs;
290 int saved_x, saved_y;
292 struct drm_encoder *encoder;
295 drm_warn_on_modeset_not_all_locked(dev);
297 saved_enabled = crtc->enabled;
298 crtc->enabled = drm_helper_crtc_in_use(crtc);
302 adjusted_mode = drm_mode_duplicate(dev, mode);
303 if (!adjusted_mode) {
304 crtc->enabled = saved_enabled;
308 saved_mode = crtc->mode;
309 saved_hwmode = crtc->hwmode;
313 /* Update crtc values up front so the driver can rely on them for mode
320 /* Pass our mode to the connectors and the CRTC to give them a chance to
321 * adjust it according to limitations or connector properties, and also
322 * a chance to reject the mode entirely.
324 drm_for_each_encoder(encoder, dev) {
326 if (encoder->crtc != crtc)
329 ret = drm_bridge_mode_fixup(encoder->bridge,
330 mode, adjusted_mode);
332 DRM_DEBUG_KMS("Bridge fixup failed\n");
336 encoder_funcs = encoder->helper_private;
337 if (encoder_funcs->mode_fixup) {
338 if (!(ret = encoder_funcs->mode_fixup(encoder, mode,
340 DRM_DEBUG_KMS("Encoder fixup failed\n");
346 if (crtc_funcs->mode_fixup) {
347 if (!(ret = crtc_funcs->mode_fixup(crtc, mode,
349 DRM_DEBUG_KMS("CRTC fixup failed\n");
353 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc->base.id, crtc->name);
355 crtc->hwmode = *adjusted_mode;
357 /* Prepare the encoders and CRTCs before setting the mode. */
358 drm_for_each_encoder(encoder, dev) {
360 if (encoder->crtc != crtc)
363 drm_bridge_disable(encoder->bridge);
365 encoder_funcs = encoder->helper_private;
366 /* Disable the encoders as the first thing we do. */
367 encoder_funcs->prepare(encoder);
369 drm_bridge_post_disable(encoder->bridge);
372 drm_crtc_prepare_encoders(dev);
374 crtc_funcs->prepare(crtc);
376 /* Set up the DPLL and any encoders state that needs to adjust or depend
379 ret = !crtc_funcs->mode_set(crtc, mode, adjusted_mode, x, y, old_fb);
383 drm_for_each_encoder(encoder, dev) {
385 if (encoder->crtc != crtc)
388 DRM_DEBUG_KMS("[ENCODER:%d:%s] set [MODE:%d:%s]\n",
389 encoder->base.id, encoder->name,
390 mode->base.id, mode->name);
391 encoder_funcs = encoder->helper_private;
392 encoder_funcs->mode_set(encoder, mode, adjusted_mode);
394 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
397 /* Now enable the clocks, plane, pipe, and connectors that we set up. */
398 crtc_funcs->commit(crtc);
400 drm_for_each_encoder(encoder, dev) {
402 if (encoder->crtc != crtc)
405 drm_bridge_pre_enable(encoder->bridge);
407 encoder_funcs = encoder->helper_private;
408 encoder_funcs->commit(encoder);
410 drm_bridge_enable(encoder->bridge);
413 /* Calculate and store various constants which
414 * are later needed by vblank and swap-completion
415 * timestamping. They are derived from true hwmode.
417 drm_calc_timestamping_constants(crtc, &crtc->hwmode);
419 /* FIXME: add subpixel order */
421 drm_mode_destroy(dev, adjusted_mode);
423 crtc->enabled = saved_enabled;
424 crtc->mode = saved_mode;
425 crtc->hwmode = saved_hwmode;
432 EXPORT_SYMBOL(drm_crtc_helper_set_mode);
435 drm_crtc_helper_disable(struct drm_crtc *crtc)
437 struct drm_device *dev = crtc->dev;
438 struct drm_connector *connector;
439 struct drm_encoder *encoder;
441 /* Decouple all encoders and their attached connectors from this crtc */
442 drm_for_each_encoder(encoder, dev) {
443 if (encoder->crtc != crtc)
446 drm_for_each_connector(connector, dev) {
447 if (connector->encoder != encoder)
450 connector->encoder = NULL;
453 * drm_helper_disable_unused_functions() ought to be
454 * doing this, but since we've decoupled the encoder
455 * from the connector above, the required connection
456 * between them is henceforth no longer available.
458 connector->dpms = DRM_MODE_DPMS_OFF;
462 __drm_helper_disable_unused_functions(dev);
466 * drm_crtc_helper_set_config - set a new config from userspace
467 * @set: mode set configuration
469 * The drm_crtc_helper_set_config() helper function implements the set_config
470 * callback of struct &drm_crtc_funcs for drivers using the legacy CRTC helpers.
472 * It first tries to locate the best encoder for each connector by calling the
473 * connector ->best_encoder() (struct &drm_connector_helper_funcs) helper
476 * After locating the appropriate encoders, the helper function will call the
477 * mode_fixup encoder and CRTC helper operations to adjust the requested mode,
478 * or reject it completely in which case an error will be returned to the
479 * application. If the new configuration after mode adjustment is identical to
480 * the current configuration the helper function will return without performing
481 * any other operation.
483 * If the adjusted mode is identical to the current mode but changes to the
484 * frame buffer need to be applied, the drm_crtc_helper_set_config() function
485 * will call the CRTC ->mode_set_base() (struct &drm_crtc_helper_funcs) helper
488 * If the adjusted mode differs from the current mode, or if the
489 * ->mode_set_base() helper operation is not provided, the helper function
490 * performs a full mode set sequence by calling the ->prepare(), ->mode_set()
491 * and ->commit() CRTC and encoder helper operations, in that order.
492 * Alternatively it can also use the dpms and disable helper operations. For
493 * details see struct &drm_crtc_helper_funcs and struct
494 * &drm_encoder_helper_funcs.
496 * This function is deprecated. New drivers must implement atomic modeset
497 * support, for which this function is unsuitable. Instead drivers should use
498 * drm_atomic_helper_set_config().
501 * Returns 0 on success, negative errno numbers on failure.
503 int drm_crtc_helper_set_config(struct drm_mode_set *set)
505 struct drm_device *dev;
506 struct drm_crtc *new_crtc;
507 struct drm_encoder *save_encoders, *new_encoder, *encoder;
508 bool mode_changed = false; /* if true do a full mode set */
509 bool fb_changed = false; /* if true and !mode_changed just do a flip */
510 struct drm_connector *save_connectors, *connector;
511 int count = 0, ro, fail = 0;
512 const struct drm_crtc_helper_funcs *crtc_funcs;
513 struct drm_mode_set save_set;
521 BUG_ON(!set->crtc->helper_private);
523 /* Enforce sane interface api - has been abused by the fb helper. */
524 BUG_ON(!set->mode && set->fb);
525 BUG_ON(set->fb && set->num_connectors == 0);
527 crtc_funcs = set->crtc->helper_private;
533 DRM_DEBUG_KMS("[CRTC:%d:%s] [FB:%d] #connectors=%d (x y) (%i %i)\n",
534 set->crtc->base.id, set->crtc->name,
536 (int)set->num_connectors, set->x, set->y);
538 DRM_DEBUG_KMS("[CRTC:%d:%s] [NOFB]\n",
539 set->crtc->base.id, set->crtc->name);
540 drm_crtc_helper_disable(set->crtc);
544 dev = set->crtc->dev;
546 drm_warn_on_modeset_not_all_locked(dev);
549 * Allocate space for the backup of all (non-pointer) encoder and
552 save_encoders = kzalloc(dev->mode_config.num_encoder *
553 sizeof(struct drm_encoder), GFP_KERNEL);
557 save_connectors = kzalloc(dev->mode_config.num_connector *
558 sizeof(struct drm_connector), GFP_KERNEL);
559 if (!save_connectors) {
560 kfree(save_encoders);
565 * Copy data. Note that driver private data is not affected.
566 * Should anything bad happen only the expected state is
567 * restored, not the drivers personal bookkeeping.
570 drm_for_each_encoder(encoder, dev) {
571 save_encoders[count++] = *encoder;
575 drm_for_each_connector(connector, dev) {
576 save_connectors[count++] = *connector;
579 save_set.crtc = set->crtc;
580 save_set.mode = &set->crtc->mode;
581 save_set.x = set->crtc->x;
582 save_set.y = set->crtc->y;
583 save_set.fb = set->crtc->primary->fb;
585 /* We should be able to check here if the fb has the same properties
586 * and then just flip_or_move it */
587 if (set->crtc->primary->fb != set->fb) {
588 /* If we have no fb then treat it as a full mode set */
589 if (set->crtc->primary->fb == NULL) {
590 DRM_DEBUG_KMS("crtc has no fb, full mode set\n");
592 } else if (set->fb->pixel_format !=
593 set->crtc->primary->fb->pixel_format) {
599 if (set->x != set->crtc->x || set->y != set->crtc->y)
602 if (!drm_mode_equal(set->mode, &set->crtc->mode)) {
603 DRM_DEBUG_KMS("modes are different, full mode set\n");
604 drm_mode_debug_printmodeline(&set->crtc->mode);
605 drm_mode_debug_printmodeline(set->mode);
609 /* a) traverse passed in connector list and get encoders for them */
611 drm_for_each_connector(connector, dev) {
612 const struct drm_connector_helper_funcs *connector_funcs =
613 connector->helper_private;
614 new_encoder = connector->encoder;
615 for (ro = 0; ro < set->num_connectors; ro++) {
616 if (set->connectors[ro] == connector) {
617 new_encoder = connector_funcs->best_encoder(connector);
618 /* if we can't get an encoder for a connector
619 we are setting now - then fail */
620 if (new_encoder == NULL)
621 /* don't break so fail path works correct */
624 if (connector->dpms != DRM_MODE_DPMS_ON) {
625 DRM_DEBUG_KMS("connector dpms not on, full mode switch\n");
633 if (new_encoder != connector->encoder) {
634 DRM_DEBUG_KMS("encoder changed, full mode switch\n");
636 /* If the encoder is reused for another connector, then
637 * the appropriate crtc will be set later.
639 if (connector->encoder)
640 connector->encoder->crtc = NULL;
641 connector->encoder = new_encoder;
651 drm_for_each_connector(connector, dev) {
652 if (!connector->encoder)
655 if (connector->encoder->crtc == set->crtc)
658 new_crtc = connector->encoder->crtc;
660 for (ro = 0; ro < set->num_connectors; ro++) {
661 if (set->connectors[ro] == connector)
662 new_crtc = set->crtc;
665 /* Make sure the new CRTC will work with the encoder */
667 !drm_encoder_crtc_ok(connector->encoder, new_crtc)) {
671 if (new_crtc != connector->encoder->crtc) {
672 DRM_DEBUG_KMS("crtc changed, full mode switch\n");
674 connector->encoder->crtc = new_crtc;
677 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [CRTC:%d:%s]\n",
678 connector->base.id, connector->name,
679 new_crtc->base.id, new_crtc->name);
681 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [NOCRTC]\n",
682 connector->base.id, connector->name);
686 /* mode_set_base is not a required function */
687 if (fb_changed && !crtc_funcs->mode_set_base)
691 if (drm_helper_crtc_in_use(set->crtc)) {
692 DRM_DEBUG_KMS("attempting to set mode from"
694 drm_mode_debug_printmodeline(set->mode);
695 set->crtc->primary->fb = set->fb;
696 if (!drm_crtc_helper_set_mode(set->crtc, set->mode,
699 DRM_ERROR("failed to set mode on [CRTC:%d:%s]\n",
700 set->crtc->base.id, set->crtc->name);
701 set->crtc->primary->fb = save_set.fb;
705 DRM_DEBUG_KMS("Setting connector DPMS state to on\n");
706 for (i = 0; i < set->num_connectors; i++) {
707 DRM_DEBUG_KMS("\t[CONNECTOR:%d:%s] set DPMS on\n", set->connectors[i]->base.id,
708 set->connectors[i]->name);
709 set->connectors[i]->funcs->dpms(set->connectors[i], DRM_MODE_DPMS_ON);
712 __drm_helper_disable_unused_functions(dev);
713 } else if (fb_changed) {
714 set->crtc->x = set->x;
715 set->crtc->y = set->y;
716 set->crtc->primary->fb = set->fb;
717 ret = crtc_funcs->mode_set_base(set->crtc,
718 set->x, set->y, save_set.fb);
720 set->crtc->x = save_set.x;
721 set->crtc->y = save_set.y;
722 set->crtc->primary->fb = save_set.fb;
727 kfree(save_connectors);
728 kfree(save_encoders);
732 /* Restore all previous data. */
734 drm_for_each_encoder(encoder, dev) {
735 *encoder = save_encoders[count++];
739 drm_for_each_connector(connector, dev) {
740 *connector = save_connectors[count++];
743 /* Try to restore the config */
745 !drm_crtc_helper_set_mode(save_set.crtc, save_set.mode, save_set.x,
746 save_set.y, save_set.fb))
747 DRM_ERROR("failed to restore config after modeset failure\n");
749 kfree(save_connectors);
750 kfree(save_encoders);
753 EXPORT_SYMBOL(drm_crtc_helper_set_config);
755 static int drm_helper_choose_encoder_dpms(struct drm_encoder *encoder)
757 int dpms = DRM_MODE_DPMS_OFF;
758 struct drm_connector *connector;
759 struct drm_device *dev = encoder->dev;
761 drm_for_each_connector(connector, dev)
762 if (connector->encoder == encoder)
763 if (connector->dpms < dpms)
764 dpms = connector->dpms;
768 /* Helper which handles bridge ordering around encoder dpms */
769 static void drm_helper_encoder_dpms(struct drm_encoder *encoder, int mode)
771 struct drm_bridge *bridge = encoder->bridge;
772 const struct drm_encoder_helper_funcs *encoder_funcs;
774 if (mode == DRM_MODE_DPMS_ON)
775 drm_bridge_pre_enable(bridge);
777 drm_bridge_disable(bridge);
779 encoder_funcs = encoder->helper_private;
780 if (encoder_funcs->dpms)
781 encoder_funcs->dpms(encoder, mode);
783 if (mode == DRM_MODE_DPMS_ON)
784 drm_bridge_enable(bridge);
786 drm_bridge_post_disable(bridge);
789 static int drm_helper_choose_crtc_dpms(struct drm_crtc *crtc)
791 int dpms = DRM_MODE_DPMS_OFF;
792 struct drm_connector *connector;
793 struct drm_device *dev = crtc->dev;
795 drm_for_each_connector(connector, dev)
796 if (connector->encoder && connector->encoder->crtc == crtc)
797 if (connector->dpms < dpms)
798 dpms = connector->dpms;
803 * drm_helper_connector_dpms() - connector dpms helper implementation
804 * @connector: affected connector
807 * The drm_helper_connector_dpms() helper function implements the ->dpms()
808 * callback of struct &drm_connector_funcs for drivers using the legacy CRTC helpers.
810 * This is the main helper function provided by the CRTC helper framework for
811 * implementing the DPMS connector attribute. It computes the new desired DPMS
812 * state for all encoders and CRTCs in the output mesh and calls the ->dpms()
813 * callbacks provided by the driver in struct &drm_crtc_helper_funcs and struct
814 * &drm_encoder_helper_funcs appropriately.
816 * This function is deprecated. New drivers must implement atomic modeset
817 * support, for which this function is unsuitable. Instead drivers should use
818 * drm_atomic_helper_connector_dpms().
823 int drm_helper_connector_dpms(struct drm_connector *connector, int mode)
825 struct drm_encoder *encoder = connector->encoder;
826 struct drm_crtc *crtc = encoder ? encoder->crtc : NULL;
827 int old_dpms, encoder_dpms = DRM_MODE_DPMS_OFF;
829 if (mode == connector->dpms)
832 old_dpms = connector->dpms;
833 connector->dpms = mode;
836 encoder_dpms = drm_helper_choose_encoder_dpms(encoder);
838 /* from off to on, do crtc then encoder */
839 if (mode < old_dpms) {
841 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
842 if (crtc_funcs->dpms)
843 (*crtc_funcs->dpms) (crtc,
844 drm_helper_choose_crtc_dpms(crtc));
847 drm_helper_encoder_dpms(encoder, encoder_dpms);
850 /* from on to off, do encoder then crtc */
851 if (mode > old_dpms) {
853 drm_helper_encoder_dpms(encoder, encoder_dpms);
855 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
856 if (crtc_funcs->dpms)
857 (*crtc_funcs->dpms) (crtc,
858 drm_helper_choose_crtc_dpms(crtc));
864 EXPORT_SYMBOL(drm_helper_connector_dpms);
867 * drm_helper_mode_fill_fb_struct - fill out framebuffer metadata
868 * @fb: drm_framebuffer object to fill out
869 * @mode_cmd: metadata from the userspace fb creation request
871 * This helper can be used in a drivers fb_create callback to pre-fill the fb's
874 void drm_helper_mode_fill_fb_struct(struct drm_framebuffer *fb,
875 const struct drm_mode_fb_cmd2 *mode_cmd)
879 fb->width = mode_cmd->width;
880 fb->height = mode_cmd->height;
881 for (i = 0; i < 4; i++) {
882 fb->pitches[i] = mode_cmd->pitches[i];
883 fb->offsets[i] = mode_cmd->offsets[i];
884 fb->modifier[i] = mode_cmd->modifier[i];
886 drm_fb_get_bpp_depth(mode_cmd->pixel_format, &fb->depth,
887 &fb->bits_per_pixel);
888 fb->pixel_format = mode_cmd->pixel_format;
889 fb->flags = mode_cmd->flags;
891 EXPORT_SYMBOL(drm_helper_mode_fill_fb_struct);
894 * drm_helper_resume_force_mode - force-restore mode setting configuration
895 * @dev: drm_device which should be restored
897 * Drivers which use the mode setting helpers can use this function to
898 * force-restore the mode setting configuration e.g. on resume or when something
899 * else might have trampled over the hw state (like some overzealous old BIOSen
902 * This helper doesn't provide a error return value since restoring the old
903 * config should never fail due to resource allocation issues since the driver
904 * has successfully set the restored configuration already. Hence this should
905 * boil down to the equivalent of a few dpms on calls, which also don't provide
908 * Drivers where simply restoring an old configuration again might fail (e.g.
909 * due to slight differences in allocating shared resources when the
910 * configuration is restored in a different order than when userspace set it up)
911 * need to use their own restore logic.
913 * This function is deprecated. New drivers should implement atomic mode-
914 * setting and use the atomic suspend/resume helpers.
917 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
919 void drm_helper_resume_force_mode(struct drm_device *dev)
921 struct drm_crtc *crtc;
922 struct drm_encoder *encoder;
923 const struct drm_crtc_helper_funcs *crtc_funcs;
927 drm_modeset_lock_all(dev);
928 drm_for_each_crtc(crtc, dev) {
933 ret = drm_crtc_helper_set_mode(crtc, &crtc->mode,
934 crtc->x, crtc->y, crtc->primary->fb);
936 /* Restoring the old config should never fail! */
938 DRM_ERROR("failed to set mode on crtc %p\n", crtc);
940 /* Turn off outputs that were already powered off */
941 if (drm_helper_choose_crtc_dpms(crtc)) {
942 drm_for_each_encoder(encoder, dev) {
944 if(encoder->crtc != crtc)
947 encoder_dpms = drm_helper_choose_encoder_dpms(
950 drm_helper_encoder_dpms(encoder, encoder_dpms);
953 crtc_funcs = crtc->helper_private;
954 if (crtc_funcs->dpms)
955 (*crtc_funcs->dpms) (crtc,
956 drm_helper_choose_crtc_dpms(crtc));
960 /* disable the unused connectors while restoring the modesetting */
961 __drm_helper_disable_unused_functions(dev);
962 drm_modeset_unlock_all(dev);
964 EXPORT_SYMBOL(drm_helper_resume_force_mode);
967 * drm_helper_crtc_mode_set - mode_set implementation for atomic plane helpers
969 * @mode: DRM display mode which userspace requested
970 * @adjusted_mode: DRM display mode adjusted by ->mode_fixup callbacks
971 * @x: x offset of the CRTC scanout area on the underlying framebuffer
972 * @y: y offset of the CRTC scanout area on the underlying framebuffer
973 * @old_fb: previous framebuffer
975 * This function implements a callback useable as the ->mode_set callback
976 * required by the CRTC helpers. Besides the atomic plane helper functions for
977 * the primary plane the driver must also provide the ->mode_set_nofb callback
978 * to set up the CRTC.
980 * This is a transitional helper useful for converting drivers to the atomic
983 int drm_helper_crtc_mode_set(struct drm_crtc *crtc, struct drm_display_mode *mode,
984 struct drm_display_mode *adjusted_mode, int x, int y,
985 struct drm_framebuffer *old_fb)
987 struct drm_crtc_state *crtc_state;
988 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
991 if (crtc->funcs->atomic_duplicate_state)
992 crtc_state = crtc->funcs->atomic_duplicate_state(crtc);
995 drm_atomic_helper_crtc_reset(crtc);
997 crtc_state = drm_atomic_helper_crtc_duplicate_state(crtc);
1003 crtc_state->planes_changed = true;
1004 crtc_state->mode_changed = true;
1005 ret = drm_atomic_set_mode_for_crtc(crtc_state, mode);
1008 drm_mode_copy(&crtc_state->adjusted_mode, adjusted_mode);
1010 if (crtc_funcs->atomic_check) {
1011 ret = crtc_funcs->atomic_check(crtc, crtc_state);
1016 swap(crtc->state, crtc_state);
1018 crtc_funcs->mode_set_nofb(crtc);
1020 ret = drm_helper_crtc_mode_set_base(crtc, x, y, old_fb);
1024 if (crtc->funcs->atomic_destroy_state)
1025 crtc->funcs->atomic_destroy_state(crtc, crtc_state);
1027 drm_atomic_helper_crtc_destroy_state(crtc, crtc_state);
1032 EXPORT_SYMBOL(drm_helper_crtc_mode_set);
1035 * drm_helper_crtc_mode_set_base - mode_set_base implementation for atomic plane helpers
1037 * @x: x offset of the CRTC scanout area on the underlying framebuffer
1038 * @y: y offset of the CRTC scanout area on the underlying framebuffer
1039 * @old_fb: previous framebuffer
1041 * This function implements a callback useable as the ->mode_set_base used
1042 * required by the CRTC helpers. The driver must provide the atomic plane helper
1043 * functions for the primary plane.
1045 * This is a transitional helper useful for converting drivers to the atomic
1048 int drm_helper_crtc_mode_set_base(struct drm_crtc *crtc, int x, int y,
1049 struct drm_framebuffer *old_fb)
1051 struct drm_plane_state *plane_state;
1052 struct drm_plane *plane = crtc->primary;
1054 if (plane->funcs->atomic_duplicate_state)
1055 plane_state = plane->funcs->atomic_duplicate_state(plane);
1058 drm_atomic_helper_plane_reset(plane);
1060 plane_state = drm_atomic_helper_plane_duplicate_state(plane);
1064 plane_state->plane = plane;
1066 plane_state->crtc = crtc;
1067 drm_atomic_set_fb_for_plane(plane_state, crtc->primary->fb);
1068 plane_state->crtc_x = 0;
1069 plane_state->crtc_y = 0;
1070 plane_state->crtc_h = crtc->mode.vdisplay;
1071 plane_state->crtc_w = crtc->mode.hdisplay;
1072 plane_state->src_x = x << 16;
1073 plane_state->src_y = y << 16;
1074 plane_state->src_h = crtc->mode.vdisplay << 16;
1075 plane_state->src_w = crtc->mode.hdisplay << 16;
1077 return drm_plane_helper_commit(plane, plane_state, old_fb);
1079 EXPORT_SYMBOL(drm_helper_crtc_mode_set_base);
1082 * drm_helper_crtc_enable_color_mgmt - enable color management properties
1084 * @degamma_lut_size: the size of the degamma lut (before CSC)
1085 * @gamma_lut_size: the size of the gamma lut (after CSC)
1087 * This function lets the driver enable the color correction properties on a
1088 * CRTC. This includes 3 degamma, csc and gamma properties that userspace can
1089 * set and 2 size properties to inform the userspace of the lut sizes.
1091 void drm_helper_crtc_enable_color_mgmt(struct drm_crtc *crtc,
1092 int degamma_lut_size,
1095 struct drm_device *dev = crtc->dev;
1096 struct drm_mode_config *config = &dev->mode_config;
1098 drm_object_attach_property(&crtc->base,
1099 config->degamma_lut_property, 0);
1100 drm_object_attach_property(&crtc->base,
1101 config->ctm_property, 0);
1102 drm_object_attach_property(&crtc->base,
1103 config->gamma_lut_property, 0);
1105 drm_object_attach_property(&crtc->base,
1106 config->degamma_lut_size_property,
1108 drm_object_attach_property(&crtc->base,
1109 config->gamma_lut_size_property,
1112 EXPORT_SYMBOL(drm_helper_crtc_enable_color_mgmt);