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 * The driver callbacks are mostly compatible with the atomic modeset helpers,
55 * except for the handling of the primary plane: Atomic helpers require that the
56 * primary plane is implemented as a real standalone plane and not directly tied
57 * to the CRTC state. For easier transition this library provides functions to
58 * implement the old semantics required by the CRTC helpers using the new plane
59 * and atomic helper callbacks.
61 * Drivers are strongly urged to convert to the atomic helpers (by way of first
62 * converting to the plane helpers). New drivers must not use these functions
63 * but need to implement the atomic interface instead, potentially using the
64 * atomic helpers for that.
66 MODULE_AUTHOR("David Airlie, Jesse Barnes");
67 MODULE_DESCRIPTION("DRM KMS helper");
68 MODULE_LICENSE("GPL and additional rights");
71 * drm_helper_move_panel_connectors_to_head() - move panels to the front in the
73 * @dev: drm device to operate on
75 * Some userspace presumes that the first connected connector is the main
76 * display, where it's supposed to display e.g. the login screen. For
77 * laptops, this should be the main panel. Use this function to sort all
78 * (eDP/LVDS) panels to the front of the connector list, instead of
79 * painstakingly trying to initialize them in the right order.
81 void drm_helper_move_panel_connectors_to_head(struct drm_device
*dev
)
83 struct drm_connector
*connector
, *tmp
;
84 struct list_head panel_list
;
86 INIT_LIST_HEAD(&panel_list
);
88 list_for_each_entry_safe(connector
, tmp
,
89 &dev
->mode_config
.connector_list
, head
) {
90 if (connector
->connector_type
== DRM_MODE_CONNECTOR_LVDS
||
91 connector
->connector_type
== DRM_MODE_CONNECTOR_eDP
)
92 list_move_tail(&connector
->head
, &panel_list
);
95 list_splice(&panel_list
, &dev
->mode_config
.connector_list
);
97 EXPORT_SYMBOL(drm_helper_move_panel_connectors_to_head
);
100 * drm_helper_encoder_in_use - check if a given encoder is in use
101 * @encoder: encoder to check
103 * Checks whether @encoder is with the current mode setting output configuration
104 * in use by any connector. This doesn't mean that it is actually enabled since
105 * the DPMS state is tracked separately.
108 * True if @encoder is used, false otherwise.
110 bool drm_helper_encoder_in_use(struct drm_encoder
*encoder
)
112 struct drm_connector
*connector
;
113 struct drm_device
*dev
= encoder
->dev
;
116 * We can expect this mutex to be locked if we are not panicking.
117 * Locking is currently fubar in the panic handler.
119 if (!oops_in_progress
) {
120 WARN_ON(!mutex_is_locked(&dev
->mode_config
.mutex
));
121 WARN_ON(!drm_modeset_is_locked(&dev
->mode_config
.connection_mutex
));
124 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
)
125 if (connector
->encoder
== encoder
)
129 EXPORT_SYMBOL(drm_helper_encoder_in_use
);
132 * drm_helper_crtc_in_use - check if a given CRTC is in a mode_config
133 * @crtc: CRTC to check
135 * Checks whether @crtc is with the current mode setting output configuration
136 * in use by any connector. This doesn't mean that it is actually enabled since
137 * the DPMS state is tracked separately.
140 * True if @crtc is used, false otherwise.
142 bool drm_helper_crtc_in_use(struct drm_crtc
*crtc
)
144 struct drm_encoder
*encoder
;
145 struct drm_device
*dev
= crtc
->dev
;
148 * We can expect this mutex to be locked if we are not panicking.
149 * Locking is currently fubar in the panic handler.
151 if (!oops_in_progress
)
152 WARN_ON(!mutex_is_locked(&dev
->mode_config
.mutex
));
154 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
)
155 if (encoder
->crtc
== crtc
&& drm_helper_encoder_in_use(encoder
))
159 EXPORT_SYMBOL(drm_helper_crtc_in_use
);
162 drm_encoder_disable(struct drm_encoder
*encoder
)
164 const struct drm_encoder_helper_funcs
*encoder_funcs
= encoder
->helper_private
;
166 drm_bridge_disable(encoder
->bridge
);
168 if (encoder_funcs
->disable
)
169 (*encoder_funcs
->disable
)(encoder
);
171 (*encoder_funcs
->dpms
)(encoder
, DRM_MODE_DPMS_OFF
);
173 drm_bridge_post_disable(encoder
->bridge
);
176 static void __drm_helper_disable_unused_functions(struct drm_device
*dev
)
178 struct drm_encoder
*encoder
;
179 struct drm_crtc
*crtc
;
181 drm_warn_on_modeset_not_all_locked(dev
);
183 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
184 if (!drm_helper_encoder_in_use(encoder
)) {
185 drm_encoder_disable(encoder
);
186 /* disconnect encoder from any connector */
187 encoder
->crtc
= NULL
;
191 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
) {
192 const struct drm_crtc_helper_funcs
*crtc_funcs
= crtc
->helper_private
;
193 crtc
->enabled
= drm_helper_crtc_in_use(crtc
);
194 if (!crtc
->enabled
) {
195 if (crtc_funcs
->disable
)
196 (*crtc_funcs
->disable
)(crtc
);
198 (*crtc_funcs
->dpms
)(crtc
, DRM_MODE_DPMS_OFF
);
199 crtc
->primary
->fb
= NULL
;
205 * drm_helper_disable_unused_functions - disable unused objects
208 * This function walks through the entire mode setting configuration of @dev. It
209 * will remove any crtc links of unused encoders and encoder links of
210 * disconnected connectors. Then it will disable all unused encoders and crtcs
211 * either by calling their disable callback if available or by calling their
212 * dpms callback with DRM_MODE_DPMS_OFF.
214 void drm_helper_disable_unused_functions(struct drm_device
*dev
)
216 drm_modeset_lock_all(dev
);
217 __drm_helper_disable_unused_functions(dev
);
218 drm_modeset_unlock_all(dev
);
220 EXPORT_SYMBOL(drm_helper_disable_unused_functions
);
223 * Check the CRTC we're going to map each output to vs. its current
224 * CRTC. If they don't match, we have to disable the output and the CRTC
225 * since the driver will have to re-route things.
228 drm_crtc_prepare_encoders(struct drm_device
*dev
)
230 const struct drm_encoder_helper_funcs
*encoder_funcs
;
231 struct drm_encoder
*encoder
;
233 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
234 encoder_funcs
= encoder
->helper_private
;
235 /* Disable unused encoders */
236 if (encoder
->crtc
== NULL
)
237 drm_encoder_disable(encoder
);
238 /* Disable encoders whose CRTC is about to change */
239 if (encoder_funcs
->get_crtc
&&
240 encoder
->crtc
!= (*encoder_funcs
->get_crtc
)(encoder
))
241 drm_encoder_disable(encoder
);
246 * drm_crtc_helper_set_mode - internal helper to set a mode
247 * @crtc: CRTC to program
249 * @x: horizontal offset into the surface
250 * @y: vertical offset into the surface
251 * @old_fb: old framebuffer, for cleanup
253 * Try to set @mode on @crtc. Give @crtc and its associated connectors a chance
254 * to fixup or reject the mode prior to trying to set it. This is an internal
255 * helper that drivers could e.g. use to update properties that require the
256 * entire output pipe to be disabled and re-enabled in a new configuration. For
257 * example for changing whether audio is enabled on a hdmi link or for changing
258 * panel fitter or dither attributes. It is also called by the
259 * drm_crtc_helper_set_config() helper function to drive the mode setting
263 * True if the mode was set successfully, false otherwise.
265 bool drm_crtc_helper_set_mode(struct drm_crtc
*crtc
,
266 struct drm_display_mode
*mode
,
268 struct drm_framebuffer
*old_fb
)
270 struct drm_device
*dev
= crtc
->dev
;
271 struct drm_display_mode
*adjusted_mode
, saved_mode
, saved_hwmode
;
272 const struct drm_crtc_helper_funcs
*crtc_funcs
= crtc
->helper_private
;
273 const struct drm_encoder_helper_funcs
*encoder_funcs
;
274 int saved_x
, saved_y
;
276 struct drm_encoder
*encoder
;
279 drm_warn_on_modeset_not_all_locked(dev
);
281 saved_enabled
= crtc
->enabled
;
282 crtc
->enabled
= drm_helper_crtc_in_use(crtc
);
286 adjusted_mode
= drm_mode_duplicate(dev
, mode
);
287 if (!adjusted_mode
) {
288 crtc
->enabled
= saved_enabled
;
292 saved_mode
= crtc
->mode
;
293 saved_hwmode
= crtc
->hwmode
;
297 /* Update crtc values up front so the driver can rely on them for mode
304 /* Pass our mode to the connectors and the CRTC to give them a chance to
305 * adjust it according to limitations or connector properties, and also
306 * a chance to reject the mode entirely.
308 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
310 if (encoder
->crtc
!= crtc
)
313 ret
= drm_bridge_mode_fixup(encoder
->bridge
,
314 mode
, adjusted_mode
);
316 DRM_DEBUG_KMS("Bridge fixup failed\n");
320 encoder_funcs
= encoder
->helper_private
;
321 if (!(ret
= encoder_funcs
->mode_fixup(encoder
, mode
,
323 DRM_DEBUG_KMS("Encoder fixup failed\n");
328 if (!(ret
= crtc_funcs
->mode_fixup(crtc
, mode
, adjusted_mode
))) {
329 DRM_DEBUG_KMS("CRTC fixup failed\n");
332 DRM_DEBUG_KMS("[CRTC:%d]\n", crtc
->base
.id
);
334 crtc
->hwmode
= *adjusted_mode
;
336 /* Prepare the encoders and CRTCs before setting the mode. */
337 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
339 if (encoder
->crtc
!= crtc
)
342 drm_bridge_disable(encoder
->bridge
);
344 encoder_funcs
= encoder
->helper_private
;
345 /* Disable the encoders as the first thing we do. */
346 encoder_funcs
->prepare(encoder
);
348 drm_bridge_post_disable(encoder
->bridge
);
351 drm_crtc_prepare_encoders(dev
);
353 crtc_funcs
->prepare(crtc
);
355 /* Set up the DPLL and any encoders state that needs to adjust or depend
358 ret
= !crtc_funcs
->mode_set(crtc
, mode
, adjusted_mode
, x
, y
, old_fb
);
362 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
364 if (encoder
->crtc
!= crtc
)
367 DRM_DEBUG_KMS("[ENCODER:%d:%s] set [MODE:%d:%s]\n",
368 encoder
->base
.id
, encoder
->name
,
369 mode
->base
.id
, mode
->name
);
370 encoder_funcs
= encoder
->helper_private
;
371 encoder_funcs
->mode_set(encoder
, mode
, adjusted_mode
);
373 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
376 /* Now enable the clocks, plane, pipe, and connectors that we set up. */
377 crtc_funcs
->commit(crtc
);
379 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
381 if (encoder
->crtc
!= crtc
)
384 drm_bridge_pre_enable(encoder
->bridge
);
386 encoder_funcs
= encoder
->helper_private
;
387 encoder_funcs
->commit(encoder
);
389 drm_bridge_enable(encoder
->bridge
);
392 /* Calculate and store various constants which
393 * are later needed by vblank and swap-completion
394 * timestamping. They are derived from true hwmode.
396 drm_calc_timestamping_constants(crtc
, &crtc
->hwmode
);
398 /* FIXME: add subpixel order */
400 drm_mode_destroy(dev
, adjusted_mode
);
402 crtc
->enabled
= saved_enabled
;
403 crtc
->mode
= saved_mode
;
404 crtc
->hwmode
= saved_hwmode
;
411 EXPORT_SYMBOL(drm_crtc_helper_set_mode
);
414 drm_crtc_helper_disable(struct drm_crtc
*crtc
)
416 struct drm_device
*dev
= crtc
->dev
;
417 struct drm_connector
*connector
;
418 struct drm_encoder
*encoder
;
420 /* Decouple all encoders and their attached connectors from this crtc */
421 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
422 if (encoder
->crtc
!= crtc
)
425 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
426 if (connector
->encoder
!= encoder
)
429 connector
->encoder
= NULL
;
432 * drm_helper_disable_unused_functions() ought to be
433 * doing this, but since we've decoupled the encoder
434 * from the connector above, the required connection
435 * between them is henceforth no longer available.
437 connector
->dpms
= DRM_MODE_DPMS_OFF
;
441 __drm_helper_disable_unused_functions(dev
);
445 * drm_crtc_helper_set_config - set a new config from userspace
446 * @set: mode set configuration
448 * Setup a new configuration, provided by the upper layers (either an ioctl call
449 * from userspace or internally e.g. from the fbdev support code) in @set, and
450 * enable it. This is the main helper functions for drivers that implement
451 * kernel mode setting with the crtc helper functions and the assorted
452 * ->prepare(), ->modeset() and ->commit() helper callbacks.
455 * Returns 0 on success, negative errno numbers on failure.
457 int drm_crtc_helper_set_config(struct drm_mode_set
*set
)
459 struct drm_device
*dev
;
460 struct drm_crtc
*new_crtc
;
461 struct drm_encoder
*save_encoders
, *new_encoder
, *encoder
;
462 bool mode_changed
= false; /* if true do a full mode set */
463 bool fb_changed
= false; /* if true and !mode_changed just do a flip */
464 struct drm_connector
*save_connectors
, *connector
;
465 int count
= 0, ro
, fail
= 0;
466 const struct drm_crtc_helper_funcs
*crtc_funcs
;
467 struct drm_mode_set save_set
;
475 BUG_ON(!set
->crtc
->helper_private
);
477 /* Enforce sane interface api - has been abused by the fb helper. */
478 BUG_ON(!set
->mode
&& set
->fb
);
479 BUG_ON(set
->fb
&& set
->num_connectors
== 0);
481 crtc_funcs
= set
->crtc
->helper_private
;
487 DRM_DEBUG_KMS("[CRTC:%d] [FB:%d] #connectors=%d (x y) (%i %i)\n",
488 set
->crtc
->base
.id
, set
->fb
->base
.id
,
489 (int)set
->num_connectors
, set
->x
, set
->y
);
491 DRM_DEBUG_KMS("[CRTC:%d] [NOFB]\n", set
->crtc
->base
.id
);
492 drm_crtc_helper_disable(set
->crtc
);
496 dev
= set
->crtc
->dev
;
498 drm_warn_on_modeset_not_all_locked(dev
);
501 * Allocate space for the backup of all (non-pointer) encoder and
504 save_encoders
= kzalloc(dev
->mode_config
.num_encoder
*
505 sizeof(struct drm_encoder
), GFP_KERNEL
);
509 save_connectors
= kzalloc(dev
->mode_config
.num_connector
*
510 sizeof(struct drm_connector
), GFP_KERNEL
);
511 if (!save_connectors
) {
512 kfree(save_encoders
);
517 * Copy data. Note that driver private data is not affected.
518 * Should anything bad happen only the expected state is
519 * restored, not the drivers personal bookkeeping.
522 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
523 save_encoders
[count
++] = *encoder
;
527 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
528 save_connectors
[count
++] = *connector
;
531 save_set
.crtc
= set
->crtc
;
532 save_set
.mode
= &set
->crtc
->mode
;
533 save_set
.x
= set
->crtc
->x
;
534 save_set
.y
= set
->crtc
->y
;
535 save_set
.fb
= set
->crtc
->primary
->fb
;
537 /* We should be able to check here if the fb has the same properties
538 * and then just flip_or_move it */
539 if (set
->crtc
->primary
->fb
!= set
->fb
) {
540 /* If we have no fb then treat it as a full mode set */
541 if (set
->crtc
->primary
->fb
== NULL
) {
542 DRM_DEBUG_KMS("crtc has no fb, full mode set\n");
544 } else if (set
->fb
== NULL
) {
546 } else if (set
->fb
->pixel_format
!=
547 set
->crtc
->primary
->fb
->pixel_format
) {
553 if (set
->x
!= set
->crtc
->x
|| set
->y
!= set
->crtc
->y
)
556 if (set
->mode
&& !drm_mode_equal(set
->mode
, &set
->crtc
->mode
)) {
557 DRM_DEBUG_KMS("modes are different, full mode set\n");
558 drm_mode_debug_printmodeline(&set
->crtc
->mode
);
559 drm_mode_debug_printmodeline(set
->mode
);
563 /* a) traverse passed in connector list and get encoders for them */
565 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
566 const struct drm_connector_helper_funcs
*connector_funcs
=
567 connector
->helper_private
;
568 new_encoder
= connector
->encoder
;
569 for (ro
= 0; ro
< set
->num_connectors
; ro
++) {
570 if (set
->connectors
[ro
] == connector
) {
571 new_encoder
= connector_funcs
->best_encoder(connector
);
572 /* if we can't get an encoder for a connector
573 we are setting now - then fail */
574 if (new_encoder
== NULL
)
575 /* don't break so fail path works correct */
578 if (connector
->dpms
!= DRM_MODE_DPMS_ON
) {
579 DRM_DEBUG_KMS("connector dpms not on, full mode switch\n");
587 if (new_encoder
!= connector
->encoder
) {
588 DRM_DEBUG_KMS("encoder changed, full mode switch\n");
590 /* If the encoder is reused for another connector, then
591 * the appropriate crtc will be set later.
593 if (connector
->encoder
)
594 connector
->encoder
->crtc
= NULL
;
595 connector
->encoder
= new_encoder
;
605 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
606 if (!connector
->encoder
)
609 if (connector
->encoder
->crtc
== set
->crtc
)
612 new_crtc
= connector
->encoder
->crtc
;
614 for (ro
= 0; ro
< set
->num_connectors
; ro
++) {
615 if (set
->connectors
[ro
] == connector
)
616 new_crtc
= set
->crtc
;
619 /* Make sure the new CRTC will work with the encoder */
621 !drm_encoder_crtc_ok(connector
->encoder
, new_crtc
)) {
625 if (new_crtc
!= connector
->encoder
->crtc
) {
626 DRM_DEBUG_KMS("crtc changed, full mode switch\n");
628 connector
->encoder
->crtc
= new_crtc
;
631 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [CRTC:%d]\n",
632 connector
->base
.id
, connector
->name
,
635 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [NOCRTC]\n",
636 connector
->base
.id
, connector
->name
);
640 /* mode_set_base is not a required function */
641 if (fb_changed
&& !crtc_funcs
->mode_set_base
)
645 if (drm_helper_crtc_in_use(set
->crtc
)) {
646 DRM_DEBUG_KMS("attempting to set mode from"
648 drm_mode_debug_printmodeline(set
->mode
);
649 set
->crtc
->primary
->fb
= set
->fb
;
650 if (!drm_crtc_helper_set_mode(set
->crtc
, set
->mode
,
653 DRM_ERROR("failed to set mode on [CRTC:%d]\n",
655 set
->crtc
->primary
->fb
= save_set
.fb
;
659 DRM_DEBUG_KMS("Setting connector DPMS state to on\n");
660 for (i
= 0; i
< set
->num_connectors
; i
++) {
661 DRM_DEBUG_KMS("\t[CONNECTOR:%d:%s] set DPMS on\n", set
->connectors
[i
]->base
.id
,
662 set
->connectors
[i
]->name
);
663 set
->connectors
[i
]->funcs
->dpms(set
->connectors
[i
], DRM_MODE_DPMS_ON
);
666 __drm_helper_disable_unused_functions(dev
);
667 } else if (fb_changed
) {
668 set
->crtc
->x
= set
->x
;
669 set
->crtc
->y
= set
->y
;
670 set
->crtc
->primary
->fb
= set
->fb
;
671 ret
= crtc_funcs
->mode_set_base(set
->crtc
,
672 set
->x
, set
->y
, save_set
.fb
);
674 set
->crtc
->x
= save_set
.x
;
675 set
->crtc
->y
= save_set
.y
;
676 set
->crtc
->primary
->fb
= save_set
.fb
;
681 kfree(save_connectors
);
682 kfree(save_encoders
);
686 /* Restore all previous data. */
688 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
689 *encoder
= save_encoders
[count
++];
693 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
) {
694 *connector
= save_connectors
[count
++];
697 /* Try to restore the config */
699 !drm_crtc_helper_set_mode(save_set
.crtc
, save_set
.mode
, save_set
.x
,
700 save_set
.y
, save_set
.fb
))
701 DRM_ERROR("failed to restore config after modeset failure\n");
703 kfree(save_connectors
);
704 kfree(save_encoders
);
707 EXPORT_SYMBOL(drm_crtc_helper_set_config
);
709 static int drm_helper_choose_encoder_dpms(struct drm_encoder
*encoder
)
711 int dpms
= DRM_MODE_DPMS_OFF
;
712 struct drm_connector
*connector
;
713 struct drm_device
*dev
= encoder
->dev
;
715 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
)
716 if (connector
->encoder
== encoder
)
717 if (connector
->dpms
< dpms
)
718 dpms
= connector
->dpms
;
722 /* Helper which handles bridge ordering around encoder dpms */
723 static void drm_helper_encoder_dpms(struct drm_encoder
*encoder
, int mode
)
725 struct drm_bridge
*bridge
= encoder
->bridge
;
726 const struct drm_encoder_helper_funcs
*encoder_funcs
;
728 if (mode
== DRM_MODE_DPMS_ON
)
729 drm_bridge_pre_enable(bridge
);
731 drm_bridge_disable(bridge
);
733 encoder_funcs
= encoder
->helper_private
;
734 if (encoder_funcs
->dpms
)
735 encoder_funcs
->dpms(encoder
, mode
);
737 if (mode
== DRM_MODE_DPMS_ON
)
738 drm_bridge_enable(bridge
);
740 drm_bridge_post_disable(bridge
);
743 static int drm_helper_choose_crtc_dpms(struct drm_crtc
*crtc
)
745 int dpms
= DRM_MODE_DPMS_OFF
;
746 struct drm_connector
*connector
;
747 struct drm_device
*dev
= crtc
->dev
;
749 list_for_each_entry(connector
, &dev
->mode_config
.connector_list
, head
)
750 if (connector
->encoder
&& connector
->encoder
->crtc
== crtc
)
751 if (connector
->dpms
< dpms
)
752 dpms
= connector
->dpms
;
757 * drm_helper_connector_dpms() - connector dpms helper implementation
758 * @connector: affected connector
761 * This is the main helper function provided by the crtc helper framework for
762 * implementing the DPMS connector attribute. It computes the new desired DPMS
763 * state for all encoders and crtcs in the output mesh and calls the ->dpms()
764 * callback provided by the driver appropriately.
766 void drm_helper_connector_dpms(struct drm_connector
*connector
, int mode
)
768 struct drm_encoder
*encoder
= connector
->encoder
;
769 struct drm_crtc
*crtc
= encoder
? encoder
->crtc
: NULL
;
770 int old_dpms
, encoder_dpms
= DRM_MODE_DPMS_OFF
;
772 if (mode
== connector
->dpms
)
775 old_dpms
= connector
->dpms
;
776 connector
->dpms
= mode
;
779 encoder_dpms
= drm_helper_choose_encoder_dpms(encoder
);
781 /* from off to on, do crtc then encoder */
782 if (mode
< old_dpms
) {
784 const struct drm_crtc_helper_funcs
*crtc_funcs
= crtc
->helper_private
;
785 if (crtc_funcs
->dpms
)
786 (*crtc_funcs
->dpms
) (crtc
,
787 drm_helper_choose_crtc_dpms(crtc
));
790 drm_helper_encoder_dpms(encoder
, encoder_dpms
);
793 /* from on to off, do encoder then crtc */
794 if (mode
> old_dpms
) {
796 drm_helper_encoder_dpms(encoder
, encoder_dpms
);
798 const struct drm_crtc_helper_funcs
*crtc_funcs
= crtc
->helper_private
;
799 if (crtc_funcs
->dpms
)
800 (*crtc_funcs
->dpms
) (crtc
,
801 drm_helper_choose_crtc_dpms(crtc
));
807 EXPORT_SYMBOL(drm_helper_connector_dpms
);
810 * drm_helper_mode_fill_fb_struct - fill out framebuffer metadata
811 * @fb: drm_framebuffer object to fill out
812 * @mode_cmd: metadata from the userspace fb creation request
814 * This helper can be used in a drivers fb_create callback to pre-fill the fb's
817 void drm_helper_mode_fill_fb_struct(struct drm_framebuffer
*fb
,
818 struct drm_mode_fb_cmd2
*mode_cmd
)
822 fb
->width
= mode_cmd
->width
;
823 fb
->height
= mode_cmd
->height
;
824 for (i
= 0; i
< 4; i
++) {
825 fb
->pitches
[i
] = mode_cmd
->pitches
[i
];
826 fb
->offsets
[i
] = mode_cmd
->offsets
[i
];
827 fb
->modifier
[i
] = mode_cmd
->modifier
[i
];
829 drm_fb_get_bpp_depth(mode_cmd
->pixel_format
, &fb
->depth
,
830 &fb
->bits_per_pixel
);
831 fb
->pixel_format
= mode_cmd
->pixel_format
;
832 fb
->flags
= mode_cmd
->flags
;
834 EXPORT_SYMBOL(drm_helper_mode_fill_fb_struct
);
837 * drm_helper_resume_force_mode - force-restore mode setting configuration
838 * @dev: drm_device which should be restored
840 * Drivers which use the mode setting helpers can use this function to
841 * force-restore the mode setting configuration e.g. on resume or when something
842 * else might have trampled over the hw state (like some overzealous old BIOSen
845 * This helper doesn't provide a error return value since restoring the old
846 * config should never fail due to resource allocation issues since the driver
847 * has successfully set the restored configuration already. Hence this should
848 * boil down to the equivalent of a few dpms on calls, which also don't provide
851 * Drivers where simply restoring an old configuration again might fail (e.g.
852 * due to slight differences in allocating shared resources when the
853 * configuration is restored in a different order than when userspace set it up)
854 * need to use their own restore logic.
856 void drm_helper_resume_force_mode(struct drm_device
*dev
)
858 struct drm_crtc
*crtc
;
859 struct drm_encoder
*encoder
;
860 const struct drm_crtc_helper_funcs
*crtc_funcs
;
864 drm_modeset_lock_all(dev
);
865 list_for_each_entry(crtc
, &dev
->mode_config
.crtc_list
, head
) {
870 ret
= drm_crtc_helper_set_mode(crtc
, &crtc
->mode
,
871 crtc
->x
, crtc
->y
, crtc
->primary
->fb
);
873 /* Restoring the old config should never fail! */
875 DRM_ERROR("failed to set mode on crtc %p\n", crtc
);
877 /* Turn off outputs that were already powered off */
878 if (drm_helper_choose_crtc_dpms(crtc
)) {
879 list_for_each_entry(encoder
, &dev
->mode_config
.encoder_list
, head
) {
881 if(encoder
->crtc
!= crtc
)
884 encoder_dpms
= drm_helper_choose_encoder_dpms(
887 drm_helper_encoder_dpms(encoder
, encoder_dpms
);
890 crtc_funcs
= crtc
->helper_private
;
891 if (crtc_funcs
->dpms
)
892 (*crtc_funcs
->dpms
) (crtc
,
893 drm_helper_choose_crtc_dpms(crtc
));
897 /* disable the unused connectors while restoring the modesetting */
898 __drm_helper_disable_unused_functions(dev
);
899 drm_modeset_unlock_all(dev
);
901 EXPORT_SYMBOL(drm_helper_resume_force_mode
);
904 * drm_helper_crtc_mode_set - mode_set implementation for atomic plane helpers
906 * @mode: DRM display mode which userspace requested
907 * @adjusted_mode: DRM display mode adjusted by ->mode_fixup callbacks
908 * @x: x offset of the CRTC scanout area on the underlying framebuffer
909 * @y: y offset of the CRTC scanout area on the underlying framebuffer
910 * @old_fb: previous framebuffer
912 * This function implements a callback useable as the ->mode_set callback
913 * required by the crtc helpers. Besides the atomic plane helper functions for
914 * the primary plane the driver must also provide the ->mode_set_nofb callback
915 * to set up the crtc.
917 * This is a transitional helper useful for converting drivers to the atomic
920 int drm_helper_crtc_mode_set(struct drm_crtc
*crtc
, struct drm_display_mode
*mode
,
921 struct drm_display_mode
*adjusted_mode
, int x
, int y
,
922 struct drm_framebuffer
*old_fb
)
924 struct drm_crtc_state
*crtc_state
;
925 const struct drm_crtc_helper_funcs
*crtc_funcs
= crtc
->helper_private
;
928 if (crtc
->funcs
->atomic_duplicate_state
)
929 crtc_state
= crtc
->funcs
->atomic_duplicate_state(crtc
);
931 crtc_state
= kzalloc(sizeof(*crtc_state
), GFP_KERNEL
);
935 __drm_atomic_helper_crtc_duplicate_state(crtc
, crtc_state
);
937 crtc_state
->crtc
= crtc
;
940 crtc_state
->planes_changed
= true;
941 crtc_state
->mode_changed
= true;
942 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, mode
);
945 drm_mode_copy(&crtc_state
->adjusted_mode
, adjusted_mode
);
947 if (crtc_funcs
->atomic_check
) {
948 ret
= crtc_funcs
->atomic_check(crtc
, crtc_state
);
953 swap(crtc
->state
, crtc_state
);
955 crtc_funcs
->mode_set_nofb(crtc
);
957 ret
= drm_helper_crtc_mode_set_base(crtc
, x
, y
, old_fb
);
960 if (crtc
->funcs
->atomic_destroy_state
)
961 crtc
->funcs
->atomic_destroy_state(crtc
, crtc_state
);
963 __drm_atomic_helper_crtc_destroy_state(crtc
, crtc_state
);
969 EXPORT_SYMBOL(drm_helper_crtc_mode_set
);
972 * drm_helper_crtc_mode_set_base - mode_set_base implementation for atomic plane helpers
974 * @x: x offset of the CRTC scanout area on the underlying framebuffer
975 * @y: y offset of the CRTC scanout area on the underlying framebuffer
976 * @old_fb: previous framebuffer
978 * This function implements a callback useable as the ->mode_set_base used
979 * required by the crtc helpers. The driver must provide the atomic plane helper
980 * functions for the primary plane.
982 * This is a transitional helper useful for converting drivers to the atomic
985 int drm_helper_crtc_mode_set_base(struct drm_crtc
*crtc
, int x
, int y
,
986 struct drm_framebuffer
*old_fb
)
988 struct drm_plane_state
*plane_state
;
989 struct drm_plane
*plane
= crtc
->primary
;
991 if (plane
->funcs
->atomic_duplicate_state
)
992 plane_state
= plane
->funcs
->atomic_duplicate_state(plane
);
993 else if (plane
->state
)
994 plane_state
= drm_atomic_helper_plane_duplicate_state(plane
);
996 plane_state
= kzalloc(sizeof(*plane_state
), GFP_KERNEL
);
999 plane_state
->plane
= plane
;
1001 plane_state
->crtc
= crtc
;
1002 drm_atomic_set_fb_for_plane(plane_state
, crtc
->primary
->fb
);
1003 plane_state
->crtc_x
= 0;
1004 plane_state
->crtc_y
= 0;
1005 plane_state
->crtc_h
= crtc
->mode
.vdisplay
;
1006 plane_state
->crtc_w
= crtc
->mode
.hdisplay
;
1007 plane_state
->src_x
= x
<< 16;
1008 plane_state
->src_y
= y
<< 16;
1009 plane_state
->src_h
= crtc
->mode
.vdisplay
<< 16;
1010 plane_state
->src_w
= crtc
->mode
.hdisplay
<< 16;
1012 return drm_plane_helper_commit(plane
, plane_state
, old_fb
);
1014 EXPORT_SYMBOL(drm_helper_crtc_mode_set_base
);