2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic.h>
30 #include <drm/drm_plane_helper.h>
31 #include <drm/drm_crtc_helper.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <linux/fence.h>
38 * This helper library provides implementations of check and commit functions on
39 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
40 * also provides convenience implementations for the atomic state handling
41 * callbacks for drivers which don't need to subclass the drm core structures to
42 * add their own additional internal state.
44 * This library also provides default implementations for the check callback in
45 * drm_atomic_helper_check() and for the commit callback with
46 * drm_atomic_helper_commit(). But the individual stages and callbacks are
47 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
48 * together with a driver private modeset implementation.
50 * This library also provides implementations for all the legacy driver
51 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
52 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
56 * The atomic helper uses the same function table structures as all other
57 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
58 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
59 * also shares the struct &drm_plane_helper_funcs function table with the plane
63 drm_atomic_helper_plane_changed(struct drm_atomic_state
*state
,
64 struct drm_plane_state
*plane_state
,
65 struct drm_plane
*plane
)
67 struct drm_crtc_state
*crtc_state
;
69 if (plane
->state
->crtc
) {
70 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
73 if (WARN_ON(!crtc_state
))
76 crtc_state
->planes_changed
= true;
79 if (plane_state
->crtc
) {
80 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
83 if (WARN_ON(!crtc_state
))
86 crtc_state
->planes_changed
= true;
90 static int handle_conflicting_encoders(struct drm_atomic_state
*state
,
91 bool disable_conflicting_encoders
)
93 struct drm_connector_state
*conn_state
;
94 struct drm_connector
*connector
;
95 struct drm_encoder
*encoder
;
96 unsigned encoder_mask
= 0;
100 * First loop, find all newly assigned encoders from the connectors
101 * part of the state. If the same encoder is assigned to multiple
102 * connectors bail out.
104 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
105 const struct drm_connector_helper_funcs
*funcs
= connector
->helper_private
;
106 struct drm_encoder
*new_encoder
;
108 if (!conn_state
->crtc
)
111 if (funcs
->atomic_best_encoder
)
112 new_encoder
= funcs
->atomic_best_encoder(connector
, conn_state
);
114 new_encoder
= funcs
->best_encoder(connector
);
117 if (encoder_mask
& (1 << drm_encoder_index(new_encoder
))) {
118 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
119 new_encoder
->base
.id
, new_encoder
->name
,
120 connector
->base
.id
, connector
->name
);
125 encoder_mask
|= 1 << drm_encoder_index(new_encoder
);
133 * Second loop, iterate over all connectors not part of the state.
135 * If a conflicting encoder is found and disable_conflicting_encoders
136 * is not set, an error is returned. Userspace can provide a solution
137 * through the atomic ioctl.
139 * If the flag is set conflicting connectors are removed from the crtc
140 * and the crtc is disabled if no encoder is left. This preserves
141 * compatibility with the legacy set_config behavior.
143 drm_for_each_connector(connector
, state
->dev
) {
144 struct drm_crtc_state
*crtc_state
;
146 if (drm_atomic_get_existing_connector_state(state
, connector
))
149 encoder
= connector
->state
->best_encoder
;
150 if (!encoder
|| !(encoder_mask
& (1 << drm_encoder_index(encoder
))))
153 if (!disable_conflicting_encoders
) {
154 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
155 encoder
->base
.id
, encoder
->name
,
156 connector
->state
->crtc
->base
.id
,
157 connector
->state
->crtc
->name
,
158 connector
->base
.id
, connector
->name
);
162 conn_state
= drm_atomic_get_connector_state(state
, connector
);
163 if (IS_ERR(conn_state
))
164 return PTR_ERR(conn_state
);
166 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
167 encoder
->base
.id
, encoder
->name
,
168 conn_state
->crtc
->base
.id
, conn_state
->crtc
->name
,
169 connector
->base
.id
, connector
->name
);
171 crtc_state
= drm_atomic_get_existing_crtc_state(state
, conn_state
->crtc
);
173 ret
= drm_atomic_set_crtc_for_connector(conn_state
, NULL
);
177 if (!crtc_state
->connector_mask
) {
178 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
183 crtc_state
->active
= false;
191 set_best_encoder(struct drm_atomic_state
*state
,
192 struct drm_connector_state
*conn_state
,
193 struct drm_encoder
*encoder
)
195 struct drm_crtc_state
*crtc_state
;
196 struct drm_crtc
*crtc
;
198 if (conn_state
->best_encoder
) {
199 /* Unset the encoder_mask in the old crtc state. */
200 crtc
= conn_state
->connector
->state
->crtc
;
202 /* A NULL crtc is an error here because we should have
203 * duplicated a NULL best_encoder when crtc was NULL.
204 * As an exception restoring duplicated atomic state
205 * during resume is allowed, so don't warn when
206 * best_encoder is equal to encoder we intend to set.
208 WARN_ON(!crtc
&& encoder
!= conn_state
->best_encoder
);
210 crtc_state
= drm_atomic_get_existing_crtc_state(state
, crtc
);
212 crtc_state
->encoder_mask
&=
213 ~(1 << drm_encoder_index(conn_state
->best_encoder
));
218 crtc
= conn_state
->crtc
;
221 crtc_state
= drm_atomic_get_existing_crtc_state(state
, crtc
);
223 crtc_state
->encoder_mask
|=
224 1 << drm_encoder_index(encoder
);
228 conn_state
->best_encoder
= encoder
;
232 steal_encoder(struct drm_atomic_state
*state
,
233 struct drm_encoder
*encoder
)
235 struct drm_crtc_state
*crtc_state
;
236 struct drm_connector
*connector
;
237 struct drm_connector_state
*connector_state
;
240 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
241 struct drm_crtc
*encoder_crtc
;
243 if (connector_state
->best_encoder
!= encoder
)
246 encoder_crtc
= connector
->state
->crtc
;
248 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
249 encoder
->base
.id
, encoder
->name
,
250 encoder_crtc
->base
.id
, encoder_crtc
->name
);
252 set_best_encoder(state
, connector_state
, NULL
);
254 crtc_state
= drm_atomic_get_existing_crtc_state(state
, encoder_crtc
);
255 crtc_state
->connectors_changed
= true;
262 update_connector_routing(struct drm_atomic_state
*state
,
263 struct drm_connector
*connector
,
264 struct drm_connector_state
*connector_state
)
266 const struct drm_connector_helper_funcs
*funcs
;
267 struct drm_encoder
*new_encoder
;
268 struct drm_crtc_state
*crtc_state
;
270 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
274 if (connector
->state
->crtc
!= connector_state
->crtc
) {
275 if (connector
->state
->crtc
) {
276 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector
->state
->crtc
);
277 crtc_state
->connectors_changed
= true;
280 if (connector_state
->crtc
) {
281 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector_state
->crtc
);
282 crtc_state
->connectors_changed
= true;
286 if (!connector_state
->crtc
) {
287 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
291 set_best_encoder(state
, connector_state
, NULL
);
296 funcs
= connector
->helper_private
;
298 if (funcs
->atomic_best_encoder
)
299 new_encoder
= funcs
->atomic_best_encoder(connector
,
302 new_encoder
= funcs
->best_encoder(connector
);
305 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
311 if (!drm_encoder_crtc_ok(new_encoder
, connector_state
->crtc
)) {
312 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
313 new_encoder
->base
.id
,
315 connector_state
->crtc
->base
.id
);
319 if (new_encoder
== connector_state
->best_encoder
) {
320 set_best_encoder(state
, connector_state
, new_encoder
);
322 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
325 new_encoder
->base
.id
,
327 connector_state
->crtc
->base
.id
,
328 connector_state
->crtc
->name
);
333 steal_encoder(state
, new_encoder
);
335 set_best_encoder(state
, connector_state
, new_encoder
);
337 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector_state
->crtc
);
338 crtc_state
->connectors_changed
= true;
340 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
343 new_encoder
->base
.id
,
345 connector_state
->crtc
->base
.id
,
346 connector_state
->crtc
->name
);
352 mode_fixup(struct drm_atomic_state
*state
)
354 struct drm_crtc
*crtc
;
355 struct drm_crtc_state
*crtc_state
;
356 struct drm_connector
*connector
;
357 struct drm_connector_state
*conn_state
;
361 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
362 if (!crtc_state
->mode_changed
&&
363 !crtc_state
->connectors_changed
)
366 drm_mode_copy(&crtc_state
->adjusted_mode
, &crtc_state
->mode
);
369 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
370 const struct drm_encoder_helper_funcs
*funcs
;
371 struct drm_encoder
*encoder
;
373 WARN_ON(!!conn_state
->best_encoder
!= !!conn_state
->crtc
);
375 if (!conn_state
->crtc
|| !conn_state
->best_encoder
)
378 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
382 * Each encoder has at most one connector (since we always steal
383 * it away), so we won't call ->mode_fixup twice.
385 encoder
= conn_state
->best_encoder
;
386 funcs
= encoder
->helper_private
;
388 ret
= drm_bridge_mode_fixup(encoder
->bridge
, &crtc_state
->mode
,
389 &crtc_state
->adjusted_mode
);
391 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
395 if (funcs
&& funcs
->atomic_check
) {
396 ret
= funcs
->atomic_check(encoder
, crtc_state
,
399 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
400 encoder
->base
.id
, encoder
->name
);
403 } else if (funcs
&& funcs
->mode_fixup
) {
404 ret
= funcs
->mode_fixup(encoder
, &crtc_state
->mode
,
405 &crtc_state
->adjusted_mode
);
407 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
408 encoder
->base
.id
, encoder
->name
);
414 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
415 const struct drm_crtc_helper_funcs
*funcs
;
417 if (!crtc_state
->mode_changed
&&
418 !crtc_state
->connectors_changed
)
421 funcs
= crtc
->helper_private
;
422 if (!funcs
->mode_fixup
)
425 ret
= funcs
->mode_fixup(crtc
, &crtc_state
->mode
,
426 &crtc_state
->adjusted_mode
);
428 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
429 crtc
->base
.id
, crtc
->name
);
438 * drm_atomic_helper_check_modeset - validate state object for modeset changes
440 * @state: the driver state object
442 * Check the state object to see if the requested state is physically possible.
443 * This does all the crtc and connector related computations for an atomic
444 * update and adds any additional connectors needed for full modesets and calls
445 * down into ->mode_fixup functions of the driver backend.
447 * crtc_state->mode_changed is set when the input mode is changed.
448 * crtc_state->connectors_changed is set when a connector is added or
449 * removed from the crtc.
450 * crtc_state->active_changed is set when crtc_state->active changes,
451 * which is used for dpms.
455 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
456 * plane update can't be done without a full modeset) _must_ call this function
457 * afterwards after that change. It is permitted to call this function multiple
458 * times for the same update, e.g. when the ->atomic_check functions depend upon
459 * the adjusted dotclock for fifo space allocation and watermark computation.
462 * Zero for success or -errno
465 drm_atomic_helper_check_modeset(struct drm_device
*dev
,
466 struct drm_atomic_state
*state
)
468 struct drm_crtc
*crtc
;
469 struct drm_crtc_state
*crtc_state
;
470 struct drm_connector
*connector
;
471 struct drm_connector_state
*connector_state
;
474 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
475 if (!drm_mode_equal(&crtc
->state
->mode
, &crtc_state
->mode
)) {
476 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
477 crtc
->base
.id
, crtc
->name
);
478 crtc_state
->mode_changed
= true;
481 if (crtc
->state
->enable
!= crtc_state
->enable
) {
482 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
483 crtc
->base
.id
, crtc
->name
);
486 * For clarity this assignment is done here, but
487 * enable == 0 is only true when there are no
488 * connectors and a NULL mode.
490 * The other way around is true as well. enable != 0
491 * iff connectors are attached and a mode is set.
493 crtc_state
->mode_changed
= true;
494 crtc_state
->connectors_changed
= true;
498 ret
= handle_conflicting_encoders(state
, state
->legacy_set_config
);
502 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
504 * This only sets crtc->mode_changed for routing changes,
505 * drivers must set crtc->mode_changed themselves when connector
506 * properties need to be updated.
508 ret
= update_connector_routing(state
, connector
,
515 * After all the routing has been prepared we need to add in any
516 * connector which is itself unchanged, but who's crtc changes it's
517 * configuration. This must be done before calling mode_fixup in case a
518 * crtc only changed its mode but has the same set of connectors.
520 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
521 bool has_connectors
=
522 !!crtc_state
->connector_mask
;
525 * We must set ->active_changed after walking connectors for
526 * otherwise an update that only changes active would result in
527 * a full modeset because update_connector_routing force that.
529 if (crtc
->state
->active
!= crtc_state
->active
) {
530 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
531 crtc
->base
.id
, crtc
->name
);
532 crtc_state
->active_changed
= true;
535 if (!drm_atomic_crtc_needs_modeset(crtc_state
))
538 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
539 crtc
->base
.id
, crtc
->name
,
540 crtc_state
->enable
? 'y' : 'n',
541 crtc_state
->active
? 'y' : 'n');
543 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
547 ret
= drm_atomic_add_affected_planes(state
, crtc
);
551 if (crtc_state
->enable
!= has_connectors
) {
552 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
553 crtc
->base
.id
, crtc
->name
);
559 return mode_fixup(state
);
561 EXPORT_SYMBOL(drm_atomic_helper_check_modeset
);
564 * drm_atomic_helper_check_planes - validate state object for planes changes
566 * @state: the driver state object
568 * Check the state object to see if the requested state is physically possible.
569 * This does all the plane update related checks using by calling into the
570 * ->atomic_check hooks provided by the driver.
572 * It also sets crtc_state->planes_changed to indicate that a crtc has
576 * Zero for success or -errno
579 drm_atomic_helper_check_planes(struct drm_device
*dev
,
580 struct drm_atomic_state
*state
)
582 struct drm_crtc
*crtc
;
583 struct drm_crtc_state
*crtc_state
;
584 struct drm_plane
*plane
;
585 struct drm_plane_state
*plane_state
;
588 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
589 const struct drm_plane_helper_funcs
*funcs
;
591 funcs
= plane
->helper_private
;
593 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
595 if (!funcs
|| !funcs
->atomic_check
)
598 ret
= funcs
->atomic_check(plane
, plane_state
);
600 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
601 plane
->base
.id
, plane
->name
);
606 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
607 const struct drm_crtc_helper_funcs
*funcs
;
609 funcs
= crtc
->helper_private
;
611 if (!funcs
|| !funcs
->atomic_check
)
614 ret
= funcs
->atomic_check(crtc
, state
->crtc_states
[i
]);
616 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
617 crtc
->base
.id
, crtc
->name
);
624 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
627 * drm_atomic_helper_check - validate state object
629 * @state: the driver state object
631 * Check the state object to see if the requested state is physically possible.
632 * Only crtcs and planes have check callbacks, so for any additional (global)
633 * checking that a driver needs it can simply wrap that around this function.
634 * Drivers without such needs can directly use this as their ->atomic_check()
637 * This just wraps the two parts of the state checking for planes and modeset
638 * state in the default order: First it calls drm_atomic_helper_check_modeset()
639 * and then drm_atomic_helper_check_planes(). The assumption is that the
640 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
641 * e.g. properly compute watermarks.
644 * Zero for success or -errno
646 int drm_atomic_helper_check(struct drm_device
*dev
,
647 struct drm_atomic_state
*state
)
651 ret
= drm_atomic_helper_check_modeset(dev
, state
);
655 ret
= drm_atomic_helper_check_planes(dev
, state
);
661 EXPORT_SYMBOL(drm_atomic_helper_check
);
664 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
666 struct drm_connector
*connector
;
667 struct drm_connector_state
*old_conn_state
;
668 struct drm_crtc
*crtc
;
669 struct drm_crtc_state
*old_crtc_state
;
672 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
673 const struct drm_encoder_helper_funcs
*funcs
;
674 struct drm_encoder
*encoder
;
676 /* Shut down everything that's in the changeset and currently
677 * still on. So need to check the old, saved state. */
678 if (!old_conn_state
->crtc
)
681 old_crtc_state
= drm_atomic_get_existing_crtc_state(old_state
,
682 old_conn_state
->crtc
);
684 if (!old_crtc_state
->active
||
685 !drm_atomic_crtc_needs_modeset(old_conn_state
->crtc
->state
))
688 encoder
= old_conn_state
->best_encoder
;
690 /* We shouldn't get this far if we didn't previously have
691 * an encoder.. but WARN_ON() rather than explode.
693 if (WARN_ON(!encoder
))
696 funcs
= encoder
->helper_private
;
698 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
699 encoder
->base
.id
, encoder
->name
);
702 * Each encoder has at most one connector (since we always steal
703 * it away), so we won't call disable hooks twice.
705 drm_bridge_disable(encoder
->bridge
);
707 /* Right function depends upon target state. */
709 if (connector
->state
->crtc
&& funcs
->prepare
)
710 funcs
->prepare(encoder
);
711 else if (funcs
->disable
)
712 funcs
->disable(encoder
);
713 else if (funcs
->dpms
)
714 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
717 drm_bridge_post_disable(encoder
->bridge
);
720 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
721 const struct drm_crtc_helper_funcs
*funcs
;
723 /* Shut down everything that needs a full modeset. */
724 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
727 if (!old_crtc_state
->active
)
730 funcs
= crtc
->helper_private
;
732 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
733 crtc
->base
.id
, crtc
->name
);
736 /* Right function depends upon target state. */
737 if (crtc
->state
->enable
&& funcs
->prepare
)
738 funcs
->prepare(crtc
);
739 else if (funcs
->disable
)
740 funcs
->disable(crtc
);
742 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
747 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
749 * @old_state: atomic state object with old state structures
751 * This function updates all the various legacy modeset state pointers in
752 * connectors, encoders and crtcs. It also updates the timestamping constants
753 * used for precise vblank timestamps by calling
754 * drm_calc_timestamping_constants().
756 * Drivers can use this for building their own atomic commit if they don't have
757 * a pure helper-based modeset implementation.
760 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
761 struct drm_atomic_state
*old_state
)
763 struct drm_connector
*connector
;
764 struct drm_connector_state
*old_conn_state
;
765 struct drm_crtc
*crtc
;
766 struct drm_crtc_state
*old_crtc_state
;
769 /* clear out existing links and update dpms */
770 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
771 if (connector
->encoder
) {
772 WARN_ON(!connector
->encoder
->crtc
);
774 connector
->encoder
->crtc
= NULL
;
775 connector
->encoder
= NULL
;
778 crtc
= connector
->state
->crtc
;
779 if ((!crtc
&& old_conn_state
->crtc
) ||
780 (crtc
&& drm_atomic_crtc_needs_modeset(crtc
->state
))) {
781 struct drm_property
*dpms_prop
=
782 dev
->mode_config
.dpms_property
;
783 int mode
= DRM_MODE_DPMS_OFF
;
785 if (crtc
&& crtc
->state
->active
)
786 mode
= DRM_MODE_DPMS_ON
;
788 connector
->dpms
= mode
;
789 drm_object_property_set_value(&connector
->base
,
795 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
796 if (!connector
->state
->crtc
)
799 if (WARN_ON(!connector
->state
->best_encoder
))
802 connector
->encoder
= connector
->state
->best_encoder
;
803 connector
->encoder
->crtc
= connector
->state
->crtc
;
806 /* set legacy state in the crtc structure */
807 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
808 struct drm_plane
*primary
= crtc
->primary
;
810 crtc
->mode
= crtc
->state
->mode
;
811 crtc
->enabled
= crtc
->state
->enable
;
813 if (drm_atomic_get_existing_plane_state(old_state
, primary
) &&
814 primary
->state
->crtc
== crtc
) {
815 crtc
->x
= primary
->state
->src_x
>> 16;
816 crtc
->y
= primary
->state
->src_y
>> 16;
819 if (crtc
->state
->enable
)
820 drm_calc_timestamping_constants(crtc
,
821 &crtc
->state
->adjusted_mode
);
824 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
827 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
829 struct drm_crtc
*crtc
;
830 struct drm_crtc_state
*old_crtc_state
;
831 struct drm_connector
*connector
;
832 struct drm_connector_state
*old_conn_state
;
835 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
836 const struct drm_crtc_helper_funcs
*funcs
;
838 if (!crtc
->state
->mode_changed
)
841 funcs
= crtc
->helper_private
;
843 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
844 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
845 crtc
->base
.id
, crtc
->name
);
847 funcs
->mode_set_nofb(crtc
);
851 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
852 const struct drm_encoder_helper_funcs
*funcs
;
853 struct drm_crtc_state
*new_crtc_state
;
854 struct drm_encoder
*encoder
;
855 struct drm_display_mode
*mode
, *adjusted_mode
;
857 if (!connector
->state
->best_encoder
)
860 encoder
= connector
->state
->best_encoder
;
861 funcs
= encoder
->helper_private
;
862 new_crtc_state
= connector
->state
->crtc
->state
;
863 mode
= &new_crtc_state
->mode
;
864 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
866 if (!new_crtc_state
->mode_changed
)
869 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
870 encoder
->base
.id
, encoder
->name
);
873 * Each encoder has at most one connector (since we always steal
874 * it away), so we won't call mode_set hooks twice.
876 if (funcs
&& funcs
->mode_set
)
877 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
879 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
884 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
886 * @old_state: atomic state object with old state structures
888 * This function shuts down all the outputs that need to be shut down and
889 * prepares them (if required) with the new mode.
891 * For compatibility with legacy crtc helpers this should be called before
892 * drm_atomic_helper_commit_planes(), which is what the default commit function
893 * does. But drivers with different needs can group the modeset commits together
894 * and do the plane commits at the end. This is useful for drivers doing runtime
895 * PM since planes updates then only happen when the CRTC is actually enabled.
897 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
898 struct drm_atomic_state
*old_state
)
900 disable_outputs(dev
, old_state
);
902 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
904 crtc_set_mode(dev
, old_state
);
906 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
909 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
911 * @old_state: atomic state object with old state structures
913 * This function enables all the outputs with the new configuration which had to
914 * be turned off for the update.
916 * For compatibility with legacy crtc helpers this should be called after
917 * drm_atomic_helper_commit_planes(), which is what the default commit function
918 * does. But drivers with different needs can group the modeset commits together
919 * and do the plane commits at the end. This is useful for drivers doing runtime
920 * PM since planes updates then only happen when the CRTC is actually enabled.
922 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
923 struct drm_atomic_state
*old_state
)
925 struct drm_crtc
*crtc
;
926 struct drm_crtc_state
*old_crtc_state
;
927 struct drm_connector
*connector
;
928 struct drm_connector_state
*old_conn_state
;
931 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
932 const struct drm_crtc_helper_funcs
*funcs
;
934 /* Need to filter out CRTCs where only planes change. */
935 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
938 if (!crtc
->state
->active
)
941 funcs
= crtc
->helper_private
;
943 if (crtc
->state
->enable
) {
944 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
945 crtc
->base
.id
, crtc
->name
);
954 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
955 const struct drm_encoder_helper_funcs
*funcs
;
956 struct drm_encoder
*encoder
;
958 if (!connector
->state
->best_encoder
)
961 if (!connector
->state
->crtc
->state
->active
||
962 !drm_atomic_crtc_needs_modeset(connector
->state
->crtc
->state
))
965 encoder
= connector
->state
->best_encoder
;
966 funcs
= encoder
->helper_private
;
968 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
969 encoder
->base
.id
, encoder
->name
);
972 * Each encoder has at most one connector (since we always steal
973 * it away), so we won't call enable hooks twice.
975 drm_bridge_pre_enable(encoder
->bridge
);
979 funcs
->enable(encoder
);
980 else if (funcs
->commit
)
981 funcs
->commit(encoder
);
984 drm_bridge_enable(encoder
->bridge
);
987 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
990 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
992 * @state: atomic state object with old state structures
994 * For implicit sync, driver should fish the exclusive fence out from the
995 * incoming fb's and stash it in the drm_plane_state. This is called after
996 * drm_atomic_helper_swap_state() so it uses the current plane state (and
997 * just uses the atomic state to find the changed planes)
999 void drm_atomic_helper_wait_for_fences(struct drm_device
*dev
,
1000 struct drm_atomic_state
*state
)
1002 struct drm_plane
*plane
;
1003 struct drm_plane_state
*plane_state
;
1006 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1007 if (!plane
->state
->fence
)
1010 WARN_ON(!plane
->state
->fb
);
1012 fence_wait(plane
->state
->fence
, false);
1013 fence_put(plane
->state
->fence
);
1014 plane
->state
->fence
= NULL
;
1017 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences
);
1020 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1022 * @old_state: atomic state object with old state structures
1025 * Checks whether the framebuffer used for this CRTC changes as a result of
1026 * the atomic update. This is useful for drivers which cannot use
1027 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1031 * true if the framebuffer changed.
1033 bool drm_atomic_helper_framebuffer_changed(struct drm_device
*dev
,
1034 struct drm_atomic_state
*old_state
,
1035 struct drm_crtc
*crtc
)
1037 struct drm_plane
*plane
;
1038 struct drm_plane_state
*old_plane_state
;
1041 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1042 if (plane
->state
->crtc
!= crtc
&&
1043 old_plane_state
->crtc
!= crtc
)
1046 if (plane
->state
->fb
!= old_plane_state
->fb
)
1052 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed
);
1055 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1057 * @old_state: atomic state object with old state structures
1059 * Helper to, after atomic commit, wait for vblanks on all effected
1060 * crtcs (ie. before cleaning up old framebuffers using
1061 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1062 * framebuffers have actually changed to optimize for the legacy cursor and
1063 * plane update use-case.
1066 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
1067 struct drm_atomic_state
*old_state
)
1069 struct drm_crtc
*crtc
;
1070 struct drm_crtc_state
*old_crtc_state
;
1073 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1074 /* No one cares about the old state, so abuse it for tracking
1075 * and store whether we hold a vblank reference (and should do a
1076 * vblank wait) in the ->enable boolean. */
1077 old_crtc_state
->enable
= false;
1079 if (!crtc
->state
->enable
)
1082 /* Legacy cursor ioctls are completely unsynced, and userspace
1083 * relies on that (by doing tons of cursor updates). */
1084 if (old_state
->legacy_cursor_update
)
1087 if (!drm_atomic_helper_framebuffer_changed(dev
,
1091 ret
= drm_crtc_vblank_get(crtc
);
1095 old_crtc_state
->enable
= true;
1096 old_crtc_state
->last_vblank_count
= drm_crtc_vblank_count(crtc
);
1099 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1100 if (!old_crtc_state
->enable
)
1103 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
1104 old_crtc_state
->last_vblank_count
!=
1105 drm_crtc_vblank_count(crtc
),
1106 msecs_to_jiffies(50));
1108 WARN(!ret
, "[CRTC:%d] vblank wait timed out\n", crtc
->base
.id
);
1110 drm_crtc_vblank_put(crtc
);
1113 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
1116 * drm_atomic_helper_commit - commit validated state object
1118 * @state: the driver state object
1119 * @nonblocking: whether nonblocking behavior is requested.
1121 * This function commits a with drm_atomic_helper_check() pre-validated state
1122 * object. This can still fail when e.g. the framebuffer reservation fails. For
1123 * now this doesn't implement nonblocking commits.
1125 * Note that right now this function does not support nonblocking commits, hence
1126 * driver writers must implement their own version for now. Also note that the
1127 * default ordering of how the various stages are called is to match the legacy
1128 * modeset helper library closest. One peculiarity of that is that it doesn't
1129 * mesh well with runtime PM at all.
1131 * For drivers supporting runtime PM the recommended sequence is
1133 * drm_atomic_helper_commit_modeset_disables(dev, state);
1135 * drm_atomic_helper_commit_modeset_enables(dev, state);
1137 * drm_atomic_helper_commit_planes(dev, state, true);
1139 * See the kerneldoc entries for these three functions for more details.
1142 * Zero for success or -errno.
1144 int drm_atomic_helper_commit(struct drm_device
*dev
,
1145 struct drm_atomic_state
*state
,
1153 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
1158 * This is the point of no return - everything below never fails except
1159 * when the hw goes bonghits. Which means we can commit the new state on
1160 * the software side now.
1163 drm_atomic_helper_swap_state(dev
, state
);
1166 * Everything below can be run asynchronously without the need to grab
1167 * any modeset locks at all under one condition: It must be guaranteed
1168 * that the asynchronous work has either been cancelled (if the driver
1169 * supports it, which at least requires that the framebuffers get
1170 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1171 * before the new state gets committed on the software side with
1172 * drm_atomic_helper_swap_state().
1174 * This scheme allows new atomic state updates to be prepared and
1175 * checked in parallel to the asynchronous completion of the previous
1176 * update. Which is important since compositors need to figure out the
1177 * composition of the next frame right after having submitted the
1181 drm_atomic_helper_wait_for_fences(dev
, state
);
1183 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1185 drm_atomic_helper_commit_planes(dev
, state
, false);
1187 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1189 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1191 drm_atomic_helper_cleanup_planes(dev
, state
);
1193 drm_atomic_state_free(state
);
1197 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1200 * DOC: implementing nonblocking commit
1202 * For now the atomic helpers don't support nonblocking commit directly. If
1203 * there is real need it could be added though, using the dma-buf fence
1204 * infrastructure for generic synchronization with outstanding rendering.
1206 * For now drivers have to implement nonblocking commit themselves, with the
1207 * following sequence being the recommended one:
1209 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1210 * which commit needs to call which can fail, so we want to run it first and
1213 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1214 * might be affected the new state update. This can be done by either cancelling
1215 * or flushing the work items, depending upon whether the driver can deal with
1216 * cancelled updates. Note that it is important to ensure that the framebuffer
1217 * cleanup is still done when cancelling.
1219 * For sufficient parallelism it is recommended to have a work item per crtc
1220 * (for updates which don't touch global state) and a global one. Then we only
1221 * need to synchronize with the crtc work items for changed crtcs and the global
1222 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1224 * 3. The software state is updated synchronously with
1225 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1226 * locks means concurrent callers never see inconsistent state. And doing this
1227 * while it's guaranteed that no relevant nonblocking worker runs means that
1228 * nonblocking workers do not need grab any locks. Actually they must not grab
1229 * locks, for otherwise the work flushing will deadlock.
1231 * 4. Schedule a work item to do all subsequent steps, using the split-out
1232 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1233 * then cleaning up the framebuffers after the old framebuffer is no longer
1238 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1240 * @state: atomic state object with new state structures
1242 * This function prepares plane state, specifically framebuffers, for the new
1243 * configuration. If any failure is encountered this function will call
1244 * ->cleanup_fb on any already successfully prepared framebuffer.
1247 * 0 on success, negative error code on failure.
1249 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1250 struct drm_atomic_state
*state
)
1252 int nplanes
= dev
->mode_config
.num_total_plane
;
1255 for (i
= 0; i
< nplanes
; i
++) {
1256 const struct drm_plane_helper_funcs
*funcs
;
1257 struct drm_plane
*plane
= state
->planes
[i
];
1258 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1263 funcs
= plane
->helper_private
;
1265 if (funcs
->prepare_fb
) {
1266 ret
= funcs
->prepare_fb(plane
, plane_state
);
1275 for (i
--; i
>= 0; i
--) {
1276 const struct drm_plane_helper_funcs
*funcs
;
1277 struct drm_plane
*plane
= state
->planes
[i
];
1278 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1283 funcs
= plane
->helper_private
;
1285 if (funcs
->cleanup_fb
)
1286 funcs
->cleanup_fb(plane
, plane_state
);
1292 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1294 bool plane_crtc_active(struct drm_plane_state
*state
)
1296 return state
->crtc
&& state
->crtc
->state
->active
;
1300 * drm_atomic_helper_commit_planes - commit plane state
1302 * @old_state: atomic state object with old state structures
1303 * @active_only: Only commit on active CRTC if set
1305 * This function commits the new plane state using the plane and atomic helper
1306 * functions for planes and crtcs. It assumes that the atomic state has already
1307 * been pushed into the relevant object state pointers, since this step can no
1310 * It still requires the global state object @old_state to know which planes and
1311 * crtcs need to be updated though.
1313 * Note that this function does all plane updates across all CRTCs in one step.
1314 * If the hardware can't support this approach look at
1315 * drm_atomic_helper_commit_planes_on_crtc() instead.
1317 * Plane parameters can be updated by applications while the associated CRTC is
1318 * disabled. The DRM/KMS core will store the parameters in the plane state,
1319 * which will be available to the driver when the CRTC is turned on. As a result
1320 * most drivers don't need to be immediately notified of plane updates for a
1323 * Unless otherwise needed, drivers are advised to set the @active_only
1324 * parameters to true in order not to receive plane update notifications related
1325 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1326 * driver code when the driver and/or hardware can't or just don't need to deal
1327 * with updates on disabled CRTCs, for example when supporting runtime PM.
1329 * The drm_atomic_helper_commit() default implementation only sets @active_only
1330 * to false to most closely match the behaviour of the legacy helpers. This should
1331 * not be copied blindly by drivers.
1333 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1334 struct drm_atomic_state
*old_state
,
1337 struct drm_crtc
*crtc
;
1338 struct drm_crtc_state
*old_crtc_state
;
1339 struct drm_plane
*plane
;
1340 struct drm_plane_state
*old_plane_state
;
1343 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1344 const struct drm_crtc_helper_funcs
*funcs
;
1346 funcs
= crtc
->helper_private
;
1348 if (!funcs
|| !funcs
->atomic_begin
)
1351 if (active_only
&& !crtc
->state
->active
)
1354 funcs
->atomic_begin(crtc
, old_crtc_state
);
1357 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1358 const struct drm_plane_helper_funcs
*funcs
;
1361 funcs
= plane
->helper_private
;
1366 disabling
= drm_atomic_plane_disabling(plane
, old_plane_state
);
1370 * Skip planes related to inactive CRTCs. If the plane
1371 * is enabled use the state of the current CRTC. If the
1372 * plane is being disabled use the state of the old
1373 * CRTC to avoid skipping planes being disabled on an
1376 if (!disabling
&& !plane_crtc_active(plane
->state
))
1378 if (disabling
&& !plane_crtc_active(old_plane_state
))
1383 * Special-case disabling the plane if drivers support it.
1385 if (disabling
&& funcs
->atomic_disable
)
1386 funcs
->atomic_disable(plane
, old_plane_state
);
1387 else if (plane
->state
->crtc
|| disabling
)
1388 funcs
->atomic_update(plane
, old_plane_state
);
1391 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1392 const struct drm_crtc_helper_funcs
*funcs
;
1394 funcs
= crtc
->helper_private
;
1396 if (!funcs
|| !funcs
->atomic_flush
)
1399 if (active_only
&& !crtc
->state
->active
)
1402 funcs
->atomic_flush(crtc
, old_crtc_state
);
1405 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1408 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1409 * @old_crtc_state: atomic state object with the old crtc state
1411 * This function commits the new plane state using the plane and atomic helper
1412 * functions for planes on the specific crtc. It assumes that the atomic state
1413 * has already been pushed into the relevant object state pointers, since this
1414 * step can no longer fail.
1416 * This function is useful when plane updates should be done crtc-by-crtc
1417 * instead of one global step like drm_atomic_helper_commit_planes() does.
1419 * This function can only be savely used when planes are not allowed to move
1420 * between different CRTCs because this function doesn't handle inter-CRTC
1421 * depencies. Callers need to ensure that either no such depencies exist,
1422 * resolve them through ordering of commit calls or through some other means.
1425 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1427 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1428 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1429 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1430 struct drm_plane
*plane
;
1431 unsigned plane_mask
;
1433 plane_mask
= old_crtc_state
->plane_mask
;
1434 plane_mask
|= crtc
->state
->plane_mask
;
1436 crtc_funcs
= crtc
->helper_private
;
1437 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1438 crtc_funcs
->atomic_begin(crtc
, old_crtc_state
);
1440 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1441 struct drm_plane_state
*old_plane_state
=
1442 drm_atomic_get_existing_plane_state(old_state
, plane
);
1443 const struct drm_plane_helper_funcs
*plane_funcs
;
1445 plane_funcs
= plane
->helper_private
;
1447 if (!old_plane_state
|| !plane_funcs
)
1450 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1452 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1453 plane_funcs
->atomic_disable
)
1454 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1455 else if (plane
->state
->crtc
||
1456 drm_atomic_plane_disabling(plane
, old_plane_state
))
1457 plane_funcs
->atomic_update(plane
, old_plane_state
);
1460 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1461 crtc_funcs
->atomic_flush(crtc
, old_crtc_state
);
1463 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1466 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1468 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1470 * Disables all planes associated with the given CRTC. This can be
1471 * used for instance in the CRTC helper disable callback to disable
1472 * all planes before shutting down the display pipeline.
1474 * If the atomic-parameter is set the function calls the CRTC's
1475 * atomic_begin hook before and atomic_flush hook after disabling the
1478 * It is a bug to call this function without having implemented the
1479 * ->atomic_disable() plane hook.
1481 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc
*crtc
,
1484 const struct drm_crtc_helper_funcs
*crtc_funcs
=
1485 crtc
->helper_private
;
1486 struct drm_plane
*plane
;
1488 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_begin
)
1489 crtc_funcs
->atomic_begin(crtc
, NULL
);
1491 drm_for_each_plane(plane
, crtc
->dev
) {
1492 const struct drm_plane_helper_funcs
*plane_funcs
=
1493 plane
->helper_private
;
1495 if (plane
->state
->crtc
!= crtc
|| !plane_funcs
)
1498 WARN_ON(!plane_funcs
->atomic_disable
);
1499 if (plane_funcs
->atomic_disable
)
1500 plane_funcs
->atomic_disable(plane
, NULL
);
1503 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_flush
)
1504 crtc_funcs
->atomic_flush(crtc
, NULL
);
1506 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc
);
1509 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1511 * @old_state: atomic state object with old state structures
1513 * This function cleans up plane state, specifically framebuffers, from the old
1514 * configuration. Hence the old configuration must be perserved in @old_state to
1515 * be able to call this function.
1517 * This function must also be called on the new state when the atomic update
1518 * fails at any point after calling drm_atomic_helper_prepare_planes().
1520 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1521 struct drm_atomic_state
*old_state
)
1523 struct drm_plane
*plane
;
1524 struct drm_plane_state
*plane_state
;
1527 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1528 const struct drm_plane_helper_funcs
*funcs
;
1530 funcs
= plane
->helper_private
;
1532 if (funcs
->cleanup_fb
)
1533 funcs
->cleanup_fb(plane
, plane_state
);
1536 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1539 * drm_atomic_helper_swap_state - store atomic state into current sw state
1541 * @state: atomic state
1543 * This function stores the atomic state into the current state pointers in all
1544 * driver objects. It should be called after all failing steps have been done
1545 * and succeeded, but before the actual hardware state is committed.
1547 * For cleanup and error recovery the current state for all changed objects will
1548 * be swaped into @state.
1550 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1552 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1554 * 2. Do any other steps that might fail.
1556 * 3. Put the staged state into the current state pointers with this function.
1558 * 4. Actually commit the hardware state.
1560 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1561 * contains the old state. Also do any other cleanup required with that state.
1563 void drm_atomic_helper_swap_state(struct drm_device
*dev
,
1564 struct drm_atomic_state
*state
)
1568 for (i
= 0; i
< state
->num_connector
; i
++) {
1569 struct drm_connector
*connector
= state
->connectors
[i
];
1574 connector
->state
->state
= state
;
1575 swap(state
->connector_states
[i
], connector
->state
);
1576 connector
->state
->state
= NULL
;
1579 for (i
= 0; i
< dev
->mode_config
.num_crtc
; i
++) {
1580 struct drm_crtc
*crtc
= state
->crtcs
[i
];
1585 crtc
->state
->state
= state
;
1586 swap(state
->crtc_states
[i
], crtc
->state
);
1587 crtc
->state
->state
= NULL
;
1590 for (i
= 0; i
< dev
->mode_config
.num_total_plane
; i
++) {
1591 struct drm_plane
*plane
= state
->planes
[i
];
1596 plane
->state
->state
= state
;
1597 swap(state
->plane_states
[i
], plane
->state
);
1598 plane
->state
->state
= NULL
;
1601 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
1604 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1605 * @plane: plane object to update
1606 * @crtc: owning CRTC of owning plane
1607 * @fb: framebuffer to flip onto plane
1608 * @crtc_x: x offset of primary plane on crtc
1609 * @crtc_y: y offset of primary plane on crtc
1610 * @crtc_w: width of primary plane rectangle on crtc
1611 * @crtc_h: height of primary plane rectangle on crtc
1612 * @src_x: x offset of @fb for panning
1613 * @src_y: y offset of @fb for panning
1614 * @src_w: width of source rectangle in @fb
1615 * @src_h: height of source rectangle in @fb
1617 * Provides a default plane update handler using the atomic driver interface.
1620 * Zero on success, error code on failure
1622 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
1623 struct drm_crtc
*crtc
,
1624 struct drm_framebuffer
*fb
,
1625 int crtc_x
, int crtc_y
,
1626 unsigned int crtc_w
, unsigned int crtc_h
,
1627 uint32_t src_x
, uint32_t src_y
,
1628 uint32_t src_w
, uint32_t src_h
)
1630 struct drm_atomic_state
*state
;
1631 struct drm_plane_state
*plane_state
;
1634 state
= drm_atomic_state_alloc(plane
->dev
);
1638 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1640 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1641 if (IS_ERR(plane_state
)) {
1642 ret
= PTR_ERR(plane_state
);
1646 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1649 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1650 plane_state
->crtc_x
= crtc_x
;
1651 plane_state
->crtc_y
= crtc_y
;
1652 plane_state
->crtc_w
= crtc_w
;
1653 plane_state
->crtc_h
= crtc_h
;
1654 plane_state
->src_x
= src_x
;
1655 plane_state
->src_y
= src_y
;
1656 plane_state
->src_w
= src_w
;
1657 plane_state
->src_h
= src_h
;
1659 if (plane
== crtc
->cursor
)
1660 state
->legacy_cursor_update
= true;
1662 ret
= drm_atomic_commit(state
);
1666 /* Driver takes ownership of state on successful commit. */
1669 if (ret
== -EDEADLK
)
1672 drm_atomic_state_free(state
);
1676 drm_atomic_state_clear(state
);
1677 drm_atomic_legacy_backoff(state
);
1680 * Someone might have exchanged the framebuffer while we dropped locks
1681 * in the backoff code. We need to fix up the fb refcount tracking the
1684 plane
->old_fb
= plane
->fb
;
1688 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
1691 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1692 * @plane: plane to disable
1694 * Provides a default plane disable handler using the atomic driver interface.
1697 * Zero on success, error code on failure
1699 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
1701 struct drm_atomic_state
*state
;
1702 struct drm_plane_state
*plane_state
;
1706 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1707 * acquire context. The real fix will be to wire the acquire ctx through
1708 * everywhere we need it, but meanwhile prevent chaos by just skipping
1709 * this noop. The critical case is the cursor ioctls which a) only grab
1710 * crtc/cursor-plane locks (so we need the crtc to get at the right
1711 * acquire context) and b) can try to disable the plane multiple times.
1716 state
= drm_atomic_state_alloc(plane
->dev
);
1720 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
1722 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1723 if (IS_ERR(plane_state
)) {
1724 ret
= PTR_ERR(plane_state
);
1728 if (plane_state
->crtc
&& (plane
== plane
->crtc
->cursor
))
1729 plane_state
->state
->legacy_cursor_update
= true;
1731 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
1735 ret
= drm_atomic_commit(state
);
1739 /* Driver takes ownership of state on successful commit. */
1742 if (ret
== -EDEADLK
)
1745 drm_atomic_state_free(state
);
1749 drm_atomic_state_clear(state
);
1750 drm_atomic_legacy_backoff(state
);
1753 * Someone might have exchanged the framebuffer while we dropped locks
1754 * in the backoff code. We need to fix up the fb refcount tracking the
1757 plane
->old_fb
= plane
->fb
;
1761 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
1763 /* just used from fb-helper and atomic-helper: */
1764 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
1765 struct drm_plane_state
*plane_state
)
1769 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
1773 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
1774 plane_state
->crtc_x
= 0;
1775 plane_state
->crtc_y
= 0;
1776 plane_state
->crtc_w
= 0;
1777 plane_state
->crtc_h
= 0;
1778 plane_state
->src_x
= 0;
1779 plane_state
->src_y
= 0;
1780 plane_state
->src_w
= 0;
1781 plane_state
->src_h
= 0;
1786 static int update_output_state(struct drm_atomic_state
*state
,
1787 struct drm_mode_set
*set
)
1789 struct drm_device
*dev
= set
->crtc
->dev
;
1790 struct drm_crtc
*crtc
;
1791 struct drm_crtc_state
*crtc_state
;
1792 struct drm_connector
*connector
;
1793 struct drm_connector_state
*conn_state
;
1796 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
1797 state
->acquire_ctx
);
1801 /* First disable all connectors on the target crtc. */
1802 ret
= drm_atomic_add_affected_connectors(state
, set
->crtc
);
1806 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
1807 if (conn_state
->crtc
== set
->crtc
) {
1808 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1815 /* Then set all connectors from set->connectors on the target crtc */
1816 for (i
= 0; i
< set
->num_connectors
; i
++) {
1817 conn_state
= drm_atomic_get_connector_state(state
,
1818 set
->connectors
[i
]);
1819 if (IS_ERR(conn_state
))
1820 return PTR_ERR(conn_state
);
1822 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1828 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1829 /* Don't update ->enable for the CRTC in the set_config request,
1830 * since a mismatch would indicate a bug in the upper layers.
1831 * The actual modeset code later on will catch any
1832 * inconsistencies here. */
1833 if (crtc
== set
->crtc
)
1836 if (!crtc_state
->connector_mask
) {
1837 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
1842 crtc_state
->active
= false;
1850 * drm_atomic_helper_set_config - set a new config from userspace
1851 * @set: mode set configuration
1853 * Provides a default crtc set_config handler using the atomic driver interface.
1856 * Returns 0 on success, negative errno numbers on failure.
1858 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
1860 struct drm_atomic_state
*state
;
1861 struct drm_crtc
*crtc
= set
->crtc
;
1864 state
= drm_atomic_state_alloc(crtc
->dev
);
1868 state
->legacy_set_config
= true;
1869 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1871 ret
= __drm_atomic_helper_set_config(set
, state
);
1875 ret
= drm_atomic_commit(state
);
1879 /* Driver takes ownership of state on successful commit. */
1882 if (ret
== -EDEADLK
)
1885 drm_atomic_state_free(state
);
1889 drm_atomic_state_clear(state
);
1890 drm_atomic_legacy_backoff(state
);
1893 * Someone might have exchanged the framebuffer while we dropped locks
1894 * in the backoff code. We need to fix up the fb refcount tracking the
1897 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1901 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
1903 /* just used from fb-helper and atomic-helper: */
1904 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
1905 struct drm_atomic_state
*state
)
1907 struct drm_crtc_state
*crtc_state
;
1908 struct drm_plane_state
*primary_state
;
1909 struct drm_crtc
*crtc
= set
->crtc
;
1910 int hdisplay
, vdisplay
;
1913 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1914 if (IS_ERR(crtc_state
))
1915 return PTR_ERR(crtc_state
);
1917 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
1918 if (IS_ERR(primary_state
))
1919 return PTR_ERR(primary_state
);
1923 WARN_ON(set
->num_connectors
);
1925 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
1929 crtc_state
->active
= false;
1931 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
1935 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
1941 WARN_ON(!set
->num_connectors
);
1943 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
1947 crtc_state
->active
= true;
1949 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
1953 drm_crtc_get_hv_timing(set
->mode
, &hdisplay
, &vdisplay
);
1955 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
1956 primary_state
->crtc_x
= 0;
1957 primary_state
->crtc_y
= 0;
1958 primary_state
->crtc_w
= hdisplay
;
1959 primary_state
->crtc_h
= vdisplay
;
1960 primary_state
->src_x
= set
->x
<< 16;
1961 primary_state
->src_y
= set
->y
<< 16;
1962 if (primary_state
->rotation
& (BIT(DRM_ROTATE_90
) | BIT(DRM_ROTATE_270
))) {
1963 primary_state
->src_w
= vdisplay
<< 16;
1964 primary_state
->src_h
= hdisplay
<< 16;
1966 primary_state
->src_w
= hdisplay
<< 16;
1967 primary_state
->src_h
= vdisplay
<< 16;
1971 ret
= update_output_state(state
, set
);
1979 * drm_atomic_helper_disable_all - disable all currently active outputs
1981 * @ctx: lock acquisition context
1983 * Loops through all connectors, finding those that aren't turned off and then
1984 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1985 * that they are connected to.
1987 * This is used for example in suspend/resume to disable all currently active
1988 * functions when suspending.
1990 * Note that if callers haven't already acquired all modeset locks this might
1991 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1994 * 0 on success or a negative error code on failure.
1997 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1999 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
2000 struct drm_modeset_acquire_ctx
*ctx
)
2002 struct drm_atomic_state
*state
;
2003 struct drm_connector
*conn
;
2006 state
= drm_atomic_state_alloc(dev
);
2010 state
->acquire_ctx
= ctx
;
2012 drm_for_each_connector(conn
, dev
) {
2013 struct drm_crtc
*crtc
= conn
->state
->crtc
;
2014 struct drm_crtc_state
*crtc_state
;
2016 if (!crtc
|| conn
->dpms
!= DRM_MODE_DPMS_ON
)
2019 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2020 if (IS_ERR(crtc_state
)) {
2021 err
= PTR_ERR(crtc_state
);
2025 crtc_state
->active
= false;
2028 err
= drm_atomic_commit(state
);
2032 drm_atomic_state_free(state
);
2036 EXPORT_SYMBOL(drm_atomic_helper_disable_all
);
2039 * drm_atomic_helper_suspend - subsystem-level suspend helper
2042 * Duplicates the current atomic state, disables all active outputs and then
2043 * returns a pointer to the original atomic state to the caller. Drivers can
2044 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2045 * restore the output configuration that was active at the time the system
2048 * Note that it is potentially unsafe to use this. The atomic state object
2049 * returned by this function is assumed to be persistent. Drivers must ensure
2050 * that this holds true. Before calling this function, drivers must make sure
2051 * to suspend fbdev emulation so that nothing can be using the device.
2054 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2055 * encoded error code on failure. Drivers should store the returned atomic
2056 * state object and pass it to the drm_atomic_helper_resume() helper upon
2060 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2061 * drm_atomic_helper_resume()
2063 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
)
2065 struct drm_modeset_acquire_ctx ctx
;
2066 struct drm_atomic_state
*state
;
2069 drm_modeset_acquire_init(&ctx
, 0);
2072 err
= drm_modeset_lock_all_ctx(dev
, &ctx
);
2074 state
= ERR_PTR(err
);
2078 state
= drm_atomic_helper_duplicate_state(dev
, &ctx
);
2082 err
= drm_atomic_helper_disable_all(dev
, &ctx
);
2084 drm_atomic_state_free(state
);
2085 state
= ERR_PTR(err
);
2090 if (PTR_ERR(state
) == -EDEADLK
) {
2091 drm_modeset_backoff(&ctx
);
2095 drm_modeset_drop_locks(&ctx
);
2096 drm_modeset_acquire_fini(&ctx
);
2099 EXPORT_SYMBOL(drm_atomic_helper_suspend
);
2102 * drm_atomic_helper_resume - subsystem-level resume helper
2104 * @state: atomic state to resume to
2106 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2107 * grabs all modeset locks and commits the atomic state object. This can be
2108 * used in conjunction with the drm_atomic_helper_suspend() helper to
2109 * implement suspend/resume for drivers that support atomic mode-setting.
2112 * 0 on success or a negative error code on failure.
2115 * drm_atomic_helper_suspend()
2117 int drm_atomic_helper_resume(struct drm_device
*dev
,
2118 struct drm_atomic_state
*state
)
2120 struct drm_mode_config
*config
= &dev
->mode_config
;
2123 drm_mode_config_reset(dev
);
2124 drm_modeset_lock_all(dev
);
2125 state
->acquire_ctx
= config
->acquire_ctx
;
2126 err
= drm_atomic_commit(state
);
2127 drm_modeset_unlock_all(dev
);
2131 EXPORT_SYMBOL(drm_atomic_helper_resume
);
2134 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2136 * @property: DRM property
2137 * @val: value of property
2139 * Provides a default crtc set_property handler using the atomic driver
2143 * Zero on success, error code on failure
2146 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
2147 struct drm_property
*property
,
2150 struct drm_atomic_state
*state
;
2151 struct drm_crtc_state
*crtc_state
;
2154 state
= drm_atomic_state_alloc(crtc
->dev
);
2158 /* ->set_property is always called with all locks held. */
2159 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2161 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2162 if (IS_ERR(crtc_state
)) {
2163 ret
= PTR_ERR(crtc_state
);
2167 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2172 ret
= drm_atomic_commit(state
);
2176 /* Driver takes ownership of state on successful commit. */
2179 if (ret
== -EDEADLK
)
2182 drm_atomic_state_free(state
);
2186 drm_atomic_state_clear(state
);
2187 drm_atomic_legacy_backoff(state
);
2191 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
2194 * drm_atomic_helper_plane_set_property - helper for plane properties
2196 * @property: DRM property
2197 * @val: value of property
2199 * Provides a default plane set_property handler using the atomic driver
2203 * Zero on success, error code on failure
2206 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
2207 struct drm_property
*property
,
2210 struct drm_atomic_state
*state
;
2211 struct drm_plane_state
*plane_state
;
2214 state
= drm_atomic_state_alloc(plane
->dev
);
2218 /* ->set_property is always called with all locks held. */
2219 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
2221 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2222 if (IS_ERR(plane_state
)) {
2223 ret
= PTR_ERR(plane_state
);
2227 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
2232 ret
= drm_atomic_commit(state
);
2236 /* Driver takes ownership of state on successful commit. */
2239 if (ret
== -EDEADLK
)
2242 drm_atomic_state_free(state
);
2246 drm_atomic_state_clear(state
);
2247 drm_atomic_legacy_backoff(state
);
2251 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
2254 * drm_atomic_helper_connector_set_property - helper for connector properties
2255 * @connector: DRM connector
2256 * @property: DRM property
2257 * @val: value of property
2259 * Provides a default connector set_property handler using the atomic driver
2263 * Zero on success, error code on failure
2266 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
2267 struct drm_property
*property
,
2270 struct drm_atomic_state
*state
;
2271 struct drm_connector_state
*connector_state
;
2274 state
= drm_atomic_state_alloc(connector
->dev
);
2278 /* ->set_property is always called with all locks held. */
2279 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
2281 connector_state
= drm_atomic_get_connector_state(state
, connector
);
2282 if (IS_ERR(connector_state
)) {
2283 ret
= PTR_ERR(connector_state
);
2287 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
2292 ret
= drm_atomic_commit(state
);
2296 /* Driver takes ownership of state on successful commit. */
2299 if (ret
== -EDEADLK
)
2302 drm_atomic_state_free(state
);
2306 drm_atomic_state_clear(state
);
2307 drm_atomic_legacy_backoff(state
);
2311 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
2314 * drm_atomic_helper_page_flip - execute a legacy page flip
2316 * @fb: DRM framebuffer
2317 * @event: optional DRM event to signal upon completion
2318 * @flags: flip flags for non-vblank sync'ed updates
2320 * Provides a default page flip implementation using the atomic driver interface.
2322 * Note that for now so called async page flips (i.e. updates which are not
2323 * synchronized to vblank) are not supported, since the atomic interfaces have
2324 * no provisions for this yet.
2327 * Returns 0 on success, negative errno numbers on failure.
2329 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
2330 struct drm_framebuffer
*fb
,
2331 struct drm_pending_vblank_event
*event
,
2334 struct drm_plane
*plane
= crtc
->primary
;
2335 struct drm_atomic_state
*state
;
2336 struct drm_plane_state
*plane_state
;
2337 struct drm_crtc_state
*crtc_state
;
2340 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
2343 state
= drm_atomic_state_alloc(plane
->dev
);
2347 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2349 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2350 if (IS_ERR(crtc_state
)) {
2351 ret
= PTR_ERR(crtc_state
);
2354 crtc_state
->event
= event
;
2356 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2357 if (IS_ERR(plane_state
)) {
2358 ret
= PTR_ERR(plane_state
);
2362 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2365 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2367 /* Make sure we don't accidentally do a full modeset. */
2368 state
->allow_modeset
= false;
2369 if (!crtc_state
->active
) {
2370 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2376 ret
= drm_atomic_nonblocking_commit(state
);
2380 /* Driver takes ownership of state on successful commit. */
2383 if (ret
== -EDEADLK
)
2386 drm_atomic_state_free(state
);
2390 drm_atomic_state_clear(state
);
2391 drm_atomic_legacy_backoff(state
);
2394 * Someone might have exchanged the framebuffer while we dropped locks
2395 * in the backoff code. We need to fix up the fb refcount tracking the
2398 plane
->old_fb
= plane
->fb
;
2402 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
2405 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2406 * @connector: affected connector
2409 * This is the main helper function provided by the atomic helper framework for
2410 * implementing the legacy DPMS connector interface. It computes the new desired
2411 * ->active state for the corresponding CRTC (if the connector is enabled) and
2415 * Returns 0 on success, negative errno numbers on failure.
2417 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
2420 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
2421 struct drm_atomic_state
*state
;
2422 struct drm_crtc_state
*crtc_state
;
2423 struct drm_crtc
*crtc
;
2424 struct drm_connector
*tmp_connector
;
2426 bool active
= false;
2427 int old_mode
= connector
->dpms
;
2429 if (mode
!= DRM_MODE_DPMS_ON
)
2430 mode
= DRM_MODE_DPMS_OFF
;
2432 connector
->dpms
= mode
;
2433 crtc
= connector
->state
->crtc
;
2438 state
= drm_atomic_state_alloc(connector
->dev
);
2442 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2444 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2445 if (IS_ERR(crtc_state
)) {
2446 ret
= PTR_ERR(crtc_state
);
2450 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
2452 drm_for_each_connector(tmp_connector
, connector
->dev
) {
2453 if (tmp_connector
->state
->crtc
!= crtc
)
2456 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2461 crtc_state
->active
= active
;
2463 ret
= drm_atomic_commit(state
);
2467 /* Driver takes ownership of state on successful commit. */
2470 if (ret
== -EDEADLK
)
2473 connector
->dpms
= old_mode
;
2474 drm_atomic_state_free(state
);
2478 drm_atomic_state_clear(state
);
2479 drm_atomic_legacy_backoff(state
);
2483 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2486 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2487 * ->best_encoder callback
2488 * @connector: Connector control structure
2490 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2491 * connectors that support exactly 1 encoder, statically determined at driver
2494 struct drm_encoder
*
2495 drm_atomic_helper_best_encoder(struct drm_connector
*connector
)
2497 WARN_ON(connector
->encoder_ids
[1]);
2498 return drm_encoder_find(connector
->dev
, connector
->encoder_ids
[0]);
2500 EXPORT_SYMBOL(drm_atomic_helper_best_encoder
);
2503 * DOC: atomic state reset and initialization
2505 * Both the drm core and the atomic helpers assume that there is always the full
2506 * and correct atomic software state for all connectors, CRTCs and planes
2507 * available. Which is a bit a problem on driver load and also after system
2508 * suspend. One way to solve this is to have a hardware state read-out
2509 * infrastructure which reconstructs the full software state (e.g. the i915
2512 * The simpler solution is to just reset the software state to everything off,
2513 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2514 * the atomic helpers provide default reset implementations for all hooks.
2516 * On the upside the precise state tracking of atomic simplifies system suspend
2517 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2518 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2519 * For other drivers the building blocks are split out, see the documentation
2520 * for these functions.
2524 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2527 * Resets the atomic state for @crtc by freeing the state pointer (which might
2528 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2530 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2533 __drm_atomic_helper_crtc_destroy_state(crtc
->state
);
2536 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2539 crtc
->state
->crtc
= crtc
;
2541 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2544 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2545 * @crtc: CRTC object
2546 * @state: atomic CRTC state
2548 * Copies atomic state from a CRTC's current state and resets inferred values.
2549 * This is useful for drivers that subclass the CRTC state.
2551 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2552 struct drm_crtc_state
*state
)
2554 memcpy(state
, crtc
->state
, sizeof(*state
));
2556 if (state
->mode_blob
)
2557 drm_property_reference_blob(state
->mode_blob
);
2558 if (state
->degamma_lut
)
2559 drm_property_reference_blob(state
->degamma_lut
);
2561 drm_property_reference_blob(state
->ctm
);
2562 if (state
->gamma_lut
)
2563 drm_property_reference_blob(state
->gamma_lut
);
2564 state
->mode_changed
= false;
2565 state
->active_changed
= false;
2566 state
->planes_changed
= false;
2567 state
->connectors_changed
= false;
2568 state
->color_mgmt_changed
= false;
2569 state
->event
= NULL
;
2571 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
2574 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2577 * Default CRTC state duplicate hook for drivers which don't have their own
2578 * subclassed CRTC state structure.
2580 struct drm_crtc_state
*
2581 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
2583 struct drm_crtc_state
*state
;
2585 if (WARN_ON(!crtc
->state
))
2588 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2590 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
2594 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
2597 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2598 * @state: CRTC state object to release
2600 * Releases all resources stored in the CRTC state without actually freeing
2601 * the memory of the CRTC state. This is useful for drivers that subclass the
2604 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
)
2606 drm_property_unreference_blob(state
->mode_blob
);
2607 drm_property_unreference_blob(state
->degamma_lut
);
2608 drm_property_unreference_blob(state
->ctm
);
2609 drm_property_unreference_blob(state
->gamma_lut
);
2611 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
2614 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2616 * @state: CRTC state object to release
2618 * Default CRTC state destroy hook for drivers which don't have their own
2619 * subclassed CRTC state structure.
2621 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2622 struct drm_crtc_state
*state
)
2624 __drm_atomic_helper_crtc_destroy_state(state
);
2627 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
2630 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2633 * Resets the atomic state for @plane by freeing the state pointer (which might
2634 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2636 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
2639 __drm_atomic_helper_plane_destroy_state(plane
->state
);
2641 kfree(plane
->state
);
2642 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
2645 plane
->state
->plane
= plane
;
2646 plane
->state
->rotation
= BIT(DRM_ROTATE_0
);
2649 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
2652 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2653 * @plane: plane object
2654 * @state: atomic plane state
2656 * Copies atomic state from a plane's current state. This is useful for
2657 * drivers that subclass the plane state.
2659 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
2660 struct drm_plane_state
*state
)
2662 memcpy(state
, plane
->state
, sizeof(*state
));
2665 drm_framebuffer_reference(state
->fb
);
2667 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
2670 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2673 * Default plane state duplicate hook for drivers which don't have their own
2674 * subclassed plane state structure.
2676 struct drm_plane_state
*
2677 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
2679 struct drm_plane_state
*state
;
2681 if (WARN_ON(!plane
->state
))
2684 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2686 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
2690 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
2693 * __drm_atomic_helper_plane_destroy_state - release plane state
2694 * @state: plane state object to release
2696 * Releases all resources stored in the plane state without actually freeing
2697 * the memory of the plane state. This is useful for drivers that subclass the
2700 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state
*state
)
2703 drm_framebuffer_unreference(state
->fb
);
2705 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
2708 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2710 * @state: plane state object to release
2712 * Default plane state destroy hook for drivers which don't have their own
2713 * subclassed plane state structure.
2715 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2716 struct drm_plane_state
*state
)
2718 __drm_atomic_helper_plane_destroy_state(state
);
2721 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
2724 * __drm_atomic_helper_connector_reset - reset state on connector
2725 * @connector: drm connector
2726 * @conn_state: connector state to assign
2728 * Initializes the newly allocated @conn_state and assigns it to
2729 * #connector ->state, usually required when initializing the drivers
2730 * or when called from the ->reset hook.
2732 * This is useful for drivers that subclass the connector state.
2735 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
2736 struct drm_connector_state
*conn_state
)
2739 conn_state
->connector
= connector
;
2741 connector
->state
= conn_state
;
2743 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
2746 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2747 * @connector: drm connector
2749 * Resets the atomic state for @connector by freeing the state pointer (which
2750 * might be NULL, e.g. at driver load time) and allocating a new empty state
2753 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
2755 struct drm_connector_state
*conn_state
=
2756 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
2758 if (connector
->state
)
2759 __drm_atomic_helper_connector_destroy_state(connector
->state
);
2761 kfree(connector
->state
);
2762 __drm_atomic_helper_connector_reset(connector
, conn_state
);
2764 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
2767 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2768 * @connector: connector object
2769 * @state: atomic connector state
2771 * Copies atomic state from a connector's current state. This is useful for
2772 * drivers that subclass the connector state.
2775 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
2776 struct drm_connector_state
*state
)
2778 memcpy(state
, connector
->state
, sizeof(*state
));
2780 drm_connector_reference(connector
);
2782 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
2785 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2786 * @connector: drm connector
2788 * Default connector state duplicate hook for drivers which don't have their own
2789 * subclassed connector state structure.
2791 struct drm_connector_state
*
2792 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
2794 struct drm_connector_state
*state
;
2796 if (WARN_ON(!connector
->state
))
2799 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2801 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
2805 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
2808 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2810 * @ctx: lock acquisition context
2812 * Makes a copy of the current atomic state by looping over all objects and
2813 * duplicating their respective states. This is used for example by suspend/
2814 * resume support code to save the state prior to suspend such that it can
2815 * be restored upon resume.
2817 * Note that this treats atomic state as persistent between save and restore.
2818 * Drivers must make sure that this is possible and won't result in confusion
2819 * or erroneous behaviour.
2821 * Note that if callers haven't already acquired all modeset locks this might
2822 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2825 * A pointer to the copy of the atomic state object on success or an
2826 * ERR_PTR()-encoded error code on failure.
2829 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2831 struct drm_atomic_state
*
2832 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
2833 struct drm_modeset_acquire_ctx
*ctx
)
2835 struct drm_atomic_state
*state
;
2836 struct drm_connector
*conn
;
2837 struct drm_plane
*plane
;
2838 struct drm_crtc
*crtc
;
2841 state
= drm_atomic_state_alloc(dev
);
2843 return ERR_PTR(-ENOMEM
);
2845 state
->acquire_ctx
= ctx
;
2847 drm_for_each_crtc(crtc
, dev
) {
2848 struct drm_crtc_state
*crtc_state
;
2850 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2851 if (IS_ERR(crtc_state
)) {
2852 err
= PTR_ERR(crtc_state
);
2857 drm_for_each_plane(plane
, dev
) {
2858 struct drm_plane_state
*plane_state
;
2860 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2861 if (IS_ERR(plane_state
)) {
2862 err
= PTR_ERR(plane_state
);
2867 drm_for_each_connector(conn
, dev
) {
2868 struct drm_connector_state
*conn_state
;
2870 conn_state
= drm_atomic_get_connector_state(state
, conn
);
2871 if (IS_ERR(conn_state
)) {
2872 err
= PTR_ERR(conn_state
);
2877 /* clear the acquire context so that it isn't accidentally reused */
2878 state
->acquire_ctx
= NULL
;
2882 drm_atomic_state_free(state
);
2883 state
= ERR_PTR(err
);
2888 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state
);
2891 * __drm_atomic_helper_connector_destroy_state - release connector state
2892 * @state: connector state object to release
2894 * Releases all resources stored in the connector state without actually
2895 * freeing the memory of the connector state. This is useful for drivers that
2896 * subclass the connector state.
2899 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state
*state
)
2902 * This is currently a placeholder so that drivers that subclass the
2903 * state will automatically do the right thing if code is ever added
2907 drm_connector_unreference(state
->connector
);
2909 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
2912 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2913 * @connector: drm connector
2914 * @state: connector state object to release
2916 * Default connector state destroy hook for drivers which don't have their own
2917 * subclassed connector state structure.
2919 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2920 struct drm_connector_state
*state
)
2922 __drm_atomic_helper_connector_destroy_state(state
);
2925 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);
2928 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2929 * @crtc: CRTC object
2930 * @red: red correction table
2931 * @green: green correction table
2932 * @blue: green correction table
2934 * @size: size of the tables
2936 * Implements support for legacy gamma correction table for drivers
2937 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2940 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc
*crtc
,
2941 u16
*red
, u16
*green
, u16
*blue
,
2942 uint32_t start
, uint32_t size
)
2944 struct drm_device
*dev
= crtc
->dev
;
2945 struct drm_mode_config
*config
= &dev
->mode_config
;
2946 struct drm_atomic_state
*state
;
2947 struct drm_crtc_state
*crtc_state
;
2948 struct drm_property_blob
*blob
= NULL
;
2949 struct drm_color_lut
*blob_data
;
2952 state
= drm_atomic_state_alloc(crtc
->dev
);
2956 blob
= drm_property_create_blob(dev
,
2957 sizeof(struct drm_color_lut
) * size
,
2960 ret
= PTR_ERR(blob
);
2965 /* Prepare GAMMA_LUT with the legacy values. */
2966 blob_data
= (struct drm_color_lut
*) blob
->data
;
2967 for (i
= 0; i
< size
; i
++) {
2968 blob_data
[i
].red
= red
[i
];
2969 blob_data
[i
].green
= green
[i
];
2970 blob_data
[i
].blue
= blue
[i
];
2973 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2975 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2976 if (IS_ERR(crtc_state
)) {
2977 ret
= PTR_ERR(crtc_state
);
2981 /* Reset DEGAMMA_LUT and CTM properties. */
2982 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2983 config
->degamma_lut_property
, 0);
2987 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2988 config
->ctm_property
, 0);
2992 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2993 config
->gamma_lut_property
, blob
->base
.id
);
2997 ret
= drm_atomic_commit(state
);
3001 /* Driver takes ownership of state on successful commit. */
3003 drm_property_unreference_blob(blob
);
3007 if (ret
== -EDEADLK
)
3010 drm_atomic_state_free(state
);
3011 drm_property_unreference_blob(blob
);
3015 drm_atomic_state_clear(state
);
3016 drm_atomic_legacy_backoff(state
);
3020 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set
);