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 expose
47 * 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.
57 drm_atomic_helper_plane_changed(struct drm_atomic_state
*state
,
58 struct drm_plane_state
*plane_state
,
59 struct drm_plane
*plane
)
61 struct drm_crtc_state
*crtc_state
;
63 if (plane
->state
->crtc
) {
64 crtc_state
= state
->crtc_states
[drm_crtc_index(plane
->state
->crtc
)];
66 if (WARN_ON(!crtc_state
))
69 crtc_state
->planes_changed
= true;
72 if (plane_state
->crtc
) {
74 state
->crtc_states
[drm_crtc_index(plane_state
->crtc
)];
76 if (WARN_ON(!crtc_state
))
79 crtc_state
->planes_changed
= true;
83 static struct drm_crtc
*
84 get_current_crtc_for_encoder(struct drm_device
*dev
,
85 struct drm_encoder
*encoder
)
87 struct drm_mode_config
*config
= &dev
->mode_config
;
88 struct drm_connector
*connector
;
90 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
92 list_for_each_entry(connector
, &config
->connector_list
, head
) {
93 if (connector
->state
->best_encoder
!= encoder
)
96 return connector
->state
->crtc
;
103 steal_encoder(struct drm_atomic_state
*state
,
104 struct drm_encoder
*encoder
,
105 struct drm_crtc
*encoder_crtc
)
107 struct drm_mode_config
*config
= &state
->dev
->mode_config
;
108 struct drm_crtc_state
*crtc_state
;
109 struct drm_connector
*connector
;
110 struct drm_connector_state
*connector_state
;
114 * We can only steal an encoder coming from a connector, which means we
115 * must already hold the connection_mutex.
117 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
119 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
120 encoder
->base
.id
, encoder
->name
,
121 encoder_crtc
->base
.id
);
123 crtc_state
= drm_atomic_get_crtc_state(state
, encoder_crtc
);
124 if (IS_ERR(crtc_state
))
125 return PTR_ERR(crtc_state
);
127 crtc_state
->mode_changed
= true;
129 list_for_each_entry(connector
, &config
->connector_list
, head
) {
130 if (connector
->state
->best_encoder
!= encoder
)
133 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
137 connector_state
= drm_atomic_get_connector_state(state
,
139 if (IS_ERR(connector_state
))
140 return PTR_ERR(connector_state
);
142 ret
= drm_atomic_set_crtc_for_connector(connector_state
, NULL
);
145 connector_state
->best_encoder
= NULL
;
152 update_connector_routing(struct drm_atomic_state
*state
, int conn_idx
)
154 const struct drm_connector_helper_funcs
*funcs
;
155 struct drm_encoder
*new_encoder
;
156 struct drm_crtc
*encoder_crtc
;
157 struct drm_connector
*connector
;
158 struct drm_connector_state
*connector_state
;
159 struct drm_crtc_state
*crtc_state
;
162 connector
= state
->connectors
[conn_idx
];
163 connector_state
= state
->connector_states
[conn_idx
];
168 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
172 if (connector
->state
->crtc
!= connector_state
->crtc
) {
173 if (connector
->state
->crtc
) {
174 idx
= drm_crtc_index(connector
->state
->crtc
);
176 crtc_state
= state
->crtc_states
[idx
];
177 crtc_state
->mode_changed
= true;
180 if (connector_state
->crtc
) {
181 idx
= drm_crtc_index(connector_state
->crtc
);
183 crtc_state
= state
->crtc_states
[idx
];
184 crtc_state
->mode_changed
= true;
188 if (!connector_state
->crtc
) {
189 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
193 connector_state
->best_encoder
= NULL
;
198 funcs
= connector
->helper_private
;
199 new_encoder
= funcs
->best_encoder(connector
);
202 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
208 if (new_encoder
== connector_state
->best_encoder
) {
209 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
212 new_encoder
->base
.id
,
214 connector_state
->crtc
->base
.id
);
219 encoder_crtc
= get_current_crtc_for_encoder(state
->dev
,
223 ret
= steal_encoder(state
, new_encoder
, encoder_crtc
);
225 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
232 connector_state
->best_encoder
= new_encoder
;
233 idx
= drm_crtc_index(connector_state
->crtc
);
235 crtc_state
= state
->crtc_states
[idx
];
236 crtc_state
->mode_changed
= true;
238 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
241 new_encoder
->base
.id
,
243 connector_state
->crtc
->base
.id
);
249 mode_fixup(struct drm_atomic_state
*state
)
251 struct drm_crtc
*crtc
;
252 struct drm_crtc_state
*crtc_state
;
253 struct drm_connector
*connector
;
254 struct drm_connector_state
*conn_state
;
258 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
259 if (!crtc_state
->mode_changed
)
262 drm_mode_copy(&crtc_state
->adjusted_mode
, &crtc_state
->mode
);
265 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
266 const struct drm_encoder_helper_funcs
*funcs
;
267 struct drm_encoder
*encoder
;
269 WARN_ON(!!conn_state
->best_encoder
!= !!conn_state
->crtc
);
271 if (!conn_state
->crtc
|| !conn_state
->best_encoder
)
275 state
->crtc_states
[drm_crtc_index(conn_state
->crtc
)];
278 * Each encoder has at most one connector (since we always steal
279 * it away), so we won't call ->mode_fixup twice.
281 encoder
= conn_state
->best_encoder
;
282 funcs
= encoder
->helper_private
;
286 ret
= drm_bridge_mode_fixup(encoder
->bridge
, &crtc_state
->mode
,
287 &crtc_state
->adjusted_mode
);
289 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
293 if (funcs
->atomic_check
) {
294 ret
= funcs
->atomic_check(encoder
, crtc_state
,
297 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
298 encoder
->base
.id
, encoder
->name
);
302 ret
= funcs
->mode_fixup(encoder
, &crtc_state
->mode
,
303 &crtc_state
->adjusted_mode
);
305 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
306 encoder
->base
.id
, encoder
->name
);
312 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
313 const struct drm_crtc_helper_funcs
*funcs
;
315 if (!crtc_state
->mode_changed
)
318 funcs
= crtc
->helper_private
;
319 if (!funcs
->mode_fixup
)
322 ret
= funcs
->mode_fixup(crtc
, &crtc_state
->mode
,
323 &crtc_state
->adjusted_mode
);
325 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
335 needs_modeset(struct drm_crtc_state
*state
)
337 return state
->mode_changed
|| state
->active_changed
;
341 * drm_atomic_helper_check_modeset - validate state object for modeset changes
343 * @state: the driver state object
345 * Check the state object to see if the requested state is physically possible.
346 * This does all the crtc and connector related computations for an atomic
347 * update. It computes and updates crtc_state->mode_changed, adds any additional
348 * connectors needed for full modesets and calls down into ->mode_fixup
349 * functions of the driver backend.
353 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
354 * plane update can't be done without a full modeset) _must_ call this function
355 * afterwards after that change. It is permitted to call this function multiple
356 * times for the same update, e.g. when the ->atomic_check functions depend upon
357 * the adjusted dotclock for fifo space allocation and watermark computation.
360 * Zero for success or -errno
363 drm_atomic_helper_check_modeset(struct drm_device
*dev
,
364 struct drm_atomic_state
*state
)
366 struct drm_crtc
*crtc
;
367 struct drm_crtc_state
*crtc_state
;
368 struct drm_connector
*connector
;
369 struct drm_connector_state
*connector_state
;
372 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
373 if (!drm_mode_equal(&crtc
->state
->mode
, &crtc_state
->mode
)) {
374 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
376 crtc_state
->mode_changed
= true;
379 if (crtc
->state
->enable
!= crtc_state
->enable
) {
380 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
382 crtc_state
->mode_changed
= true;
386 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
388 * This only sets crtc->mode_changed for routing changes,
389 * drivers must set crtc->mode_changed themselves when connector
390 * properties need to be updated.
392 ret
= update_connector_routing(state
, i
);
398 * After all the routing has been prepared we need to add in any
399 * connector which is itself unchanged, but who's crtc changes it's
400 * configuration. This must be done before calling mode_fixup in case a
401 * crtc only changed its mode but has the same set of connectors.
403 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
407 * We must set ->active_changed after walking connectors for
408 * otherwise an update that only changes active would result in
409 * a full modeset because update_connector_routing force that.
411 if (crtc
->state
->active
!= crtc_state
->active
) {
412 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
414 crtc_state
->active_changed
= true;
417 if (!needs_modeset(crtc_state
))
420 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
422 crtc_state
->enable
? 'y' : 'n',
423 crtc_state
->active
? 'y' : 'n');
425 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
429 ret
= drm_atomic_add_affected_planes(state
, crtc
);
433 num_connectors
= drm_atomic_connectors_for_crtc(state
,
436 if (crtc_state
->enable
!= !!num_connectors
) {
437 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
444 return mode_fixup(state
);
446 EXPORT_SYMBOL(drm_atomic_helper_check_modeset
);
449 * drm_atomic_helper_check_planes - validate state object for planes changes
451 * @state: the driver state object
453 * Check the state object to see if the requested state is physically possible.
454 * This does all the plane update related checks using by calling into the
455 * ->atomic_check hooks provided by the driver.
458 * Zero for success or -errno
461 drm_atomic_helper_check_planes(struct drm_device
*dev
,
462 struct drm_atomic_state
*state
)
464 struct drm_crtc
*crtc
;
465 struct drm_crtc_state
*crtc_state
;
466 struct drm_plane
*plane
;
467 struct drm_plane_state
*plane_state
;
470 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
471 const struct drm_plane_helper_funcs
*funcs
;
473 funcs
= plane
->helper_private
;
475 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
477 if (!funcs
|| !funcs
->atomic_check
)
480 ret
= funcs
->atomic_check(plane
, plane_state
);
482 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
488 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
489 const struct drm_crtc_helper_funcs
*funcs
;
491 funcs
= crtc
->helper_private
;
493 if (!funcs
|| !funcs
->atomic_check
)
496 ret
= funcs
->atomic_check(crtc
, state
->crtc_states
[i
]);
498 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
506 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
509 * drm_atomic_helper_check - validate state object
511 * @state: the driver state object
513 * Check the state object to see if the requested state is physically possible.
514 * Only crtcs and planes have check callbacks, so for any additional (global)
515 * checking that a driver needs it can simply wrap that around this function.
516 * Drivers without such needs can directly use this as their ->atomic_check()
519 * This just wraps the two parts of the state checking for planes and modeset
520 * state in the default order: First it calls drm_atomic_helper_check_modeset()
521 * and then drm_atomic_helper_check_planes(). The assumption is that the
522 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
523 * e.g. properly compute watermarks.
526 * Zero for success or -errno
528 int drm_atomic_helper_check(struct drm_device
*dev
,
529 struct drm_atomic_state
*state
)
533 ret
= drm_atomic_helper_check_modeset(dev
, state
);
537 ret
= drm_atomic_helper_check_planes(dev
, state
);
543 EXPORT_SYMBOL(drm_atomic_helper_check
);
546 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
548 struct drm_connector
*connector
;
549 struct drm_connector_state
*old_conn_state
;
550 struct drm_crtc
*crtc
;
551 struct drm_crtc_state
*old_crtc_state
;
554 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
555 const struct drm_encoder_helper_funcs
*funcs
;
556 struct drm_encoder
*encoder
;
557 struct drm_crtc_state
*old_crtc_state
;
559 /* Shut down everything that's in the changeset and currently
560 * still on. So need to check the old, saved state. */
561 if (!old_conn_state
->crtc
)
564 old_crtc_state
= old_state
->crtc_states
[drm_crtc_index(old_conn_state
->crtc
)];
566 if (!old_crtc_state
->active
||
567 !needs_modeset(old_conn_state
->crtc
->state
))
570 encoder
= old_conn_state
->best_encoder
;
572 /* We shouldn't get this far if we didn't previously have
573 * an encoder.. but WARN_ON() rather than explode.
575 if (WARN_ON(!encoder
))
578 funcs
= encoder
->helper_private
;
580 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
581 encoder
->base
.id
, encoder
->name
);
584 * Each encoder has at most one connector (since we always steal
585 * it away), so we won't call disable hooks twice.
587 drm_bridge_disable(encoder
->bridge
);
589 /* Right function depends upon target state. */
590 if (connector
->state
->crtc
&& funcs
->prepare
)
591 funcs
->prepare(encoder
);
592 else if (funcs
->disable
)
593 funcs
->disable(encoder
);
595 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
597 drm_bridge_post_disable(encoder
->bridge
);
600 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
601 const struct drm_crtc_helper_funcs
*funcs
;
603 /* Shut down everything that needs a full modeset. */
604 if (!needs_modeset(crtc
->state
))
607 if (!old_crtc_state
->active
)
610 funcs
= crtc
->helper_private
;
612 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
616 /* Right function depends upon target state. */
617 if (crtc
->state
->enable
&& funcs
->prepare
)
618 funcs
->prepare(crtc
);
619 else if (funcs
->disable
)
620 funcs
->disable(crtc
);
622 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
627 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
629 * @old_state: atomic state object with old state structures
631 * This function updates all the various legacy modeset state pointers in
632 * connectors, encoders and crtcs. It also updates the timestamping constants
633 * used for precise vblank timestamps by calling
634 * drm_calc_timestamping_constants().
636 * Drivers can use this for building their own atomic commit if they don't have
637 * a pure helper-based modeset implementation.
640 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
641 struct drm_atomic_state
*old_state
)
643 struct drm_connector
*connector
;
644 struct drm_connector_state
*old_conn_state
;
645 struct drm_crtc
*crtc
;
646 struct drm_crtc_state
*old_crtc_state
;
649 /* clear out existing links */
650 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
651 if (!connector
->encoder
)
654 WARN_ON(!connector
->encoder
->crtc
);
656 connector
->encoder
->crtc
= NULL
;
657 connector
->encoder
= NULL
;
661 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
662 if (!connector
->state
->crtc
)
665 if (WARN_ON(!connector
->state
->best_encoder
))
668 connector
->encoder
= connector
->state
->best_encoder
;
669 connector
->encoder
->crtc
= connector
->state
->crtc
;
672 /* set legacy state in the crtc structure */
673 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
674 crtc
->mode
= crtc
->state
->mode
;
675 crtc
->enabled
= crtc
->state
->enable
;
676 crtc
->x
= crtc
->primary
->state
->src_x
>> 16;
677 crtc
->y
= crtc
->primary
->state
->src_y
>> 16;
679 if (crtc
->state
->enable
)
680 drm_calc_timestamping_constants(crtc
,
681 &crtc
->state
->adjusted_mode
);
684 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
687 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
689 struct drm_crtc
*crtc
;
690 struct drm_crtc_state
*old_crtc_state
;
691 struct drm_connector
*connector
;
692 struct drm_connector_state
*old_conn_state
;
695 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
696 const struct drm_crtc_helper_funcs
*funcs
;
698 if (!crtc
->state
->mode_changed
)
701 funcs
= crtc
->helper_private
;
703 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
704 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
707 funcs
->mode_set_nofb(crtc
);
711 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
712 const struct drm_encoder_helper_funcs
*funcs
;
713 struct drm_crtc_state
*new_crtc_state
;
714 struct drm_encoder
*encoder
;
715 struct drm_display_mode
*mode
, *adjusted_mode
;
717 if (!connector
->state
->best_encoder
)
720 encoder
= connector
->state
->best_encoder
;
721 funcs
= encoder
->helper_private
;
722 new_crtc_state
= connector
->state
->crtc
->state
;
723 mode
= &new_crtc_state
->mode
;
724 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
726 if (!new_crtc_state
->mode_changed
)
729 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
730 encoder
->base
.id
, encoder
->name
);
733 * Each encoder has at most one connector (since we always steal
734 * it away), so we won't call mode_set hooks twice.
737 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
739 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
744 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
746 * @old_state: atomic state object with old state structures
748 * This function shuts down all the outputs that need to be shut down and
749 * prepares them (if required) with the new mode.
751 * For compatability with legacy crtc helpers this should be called before
752 * drm_atomic_helper_commit_planes(), which is what the default commit function
753 * does. But drivers with different needs can group the modeset commits together
754 * and do the plane commits at the end. This is useful for drivers doing runtime
755 * PM since planes updates then only happen when the CRTC is actually enabled.
757 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
758 struct drm_atomic_state
*old_state
)
760 disable_outputs(dev
, old_state
);
762 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
764 crtc_set_mode(dev
, old_state
);
766 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
769 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
771 * @old_state: atomic state object with old state structures
773 * This function enables all the outputs with the new configuration which had to
774 * be turned off for the update.
776 * For compatability with legacy crtc helpers this should be called after
777 * drm_atomic_helper_commit_planes(), which is what the default commit function
778 * does. But drivers with different needs can group the modeset commits together
779 * and do the plane commits at the end. This is useful for drivers doing runtime
780 * PM since planes updates then only happen when the CRTC is actually enabled.
782 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
783 struct drm_atomic_state
*old_state
)
785 struct drm_crtc
*crtc
;
786 struct drm_crtc_state
*old_crtc_state
;
787 struct drm_connector
*connector
;
788 struct drm_connector_state
*old_conn_state
;
791 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
792 const struct drm_crtc_helper_funcs
*funcs
;
794 /* Need to filter out CRTCs where only planes change. */
795 if (!needs_modeset(crtc
->state
))
798 if (!crtc
->state
->active
)
801 funcs
= crtc
->helper_private
;
803 if (crtc
->state
->enable
) {
804 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
814 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
815 const struct drm_encoder_helper_funcs
*funcs
;
816 struct drm_encoder
*encoder
;
818 if (!connector
->state
->best_encoder
)
821 if (!connector
->state
->crtc
->state
->active
||
822 !needs_modeset(connector
->state
->crtc
->state
))
825 encoder
= connector
->state
->best_encoder
;
826 funcs
= encoder
->helper_private
;
828 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
829 encoder
->base
.id
, encoder
->name
);
832 * Each encoder has at most one connector (since we always steal
833 * it away), so we won't call enable hooks twice.
835 drm_bridge_pre_enable(encoder
->bridge
);
838 funcs
->enable(encoder
);
840 funcs
->commit(encoder
);
842 drm_bridge_enable(encoder
->bridge
);
845 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
847 static void wait_for_fences(struct drm_device
*dev
,
848 struct drm_atomic_state
*state
)
850 struct drm_plane
*plane
;
851 struct drm_plane_state
*plane_state
;
854 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
855 if (!plane
->state
->fence
)
858 WARN_ON(!plane
->state
->fb
);
860 fence_wait(plane
->state
->fence
, false);
861 fence_put(plane
->state
->fence
);
862 plane
->state
->fence
= NULL
;
866 static bool framebuffer_changed(struct drm_device
*dev
,
867 struct drm_atomic_state
*old_state
,
868 struct drm_crtc
*crtc
)
870 struct drm_plane
*plane
;
871 struct drm_plane_state
*old_plane_state
;
874 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
875 if (plane
->state
->crtc
!= crtc
&&
876 old_plane_state
->crtc
!= crtc
)
879 if (plane
->state
->fb
!= old_plane_state
->fb
)
887 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
889 * @old_state: atomic state object with old state structures
891 * Helper to, after atomic commit, wait for vblanks on all effected
892 * crtcs (ie. before cleaning up old framebuffers using
893 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
894 * framebuffers have actually changed to optimize for the legacy cursor and
895 * plane update use-case.
898 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
899 struct drm_atomic_state
*old_state
)
901 struct drm_crtc
*crtc
;
902 struct drm_crtc_state
*old_crtc_state
;
905 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
906 /* No one cares about the old state, so abuse it for tracking
907 * and store whether we hold a vblank reference (and should do a
908 * vblank wait) in the ->enable boolean. */
909 old_crtc_state
->enable
= false;
911 if (!crtc
->state
->enable
)
914 /* Legacy cursor ioctls are completely unsynced, and userspace
915 * relies on that (by doing tons of cursor updates). */
916 if (old_state
->legacy_cursor_update
)
919 if (!framebuffer_changed(dev
, old_state
, crtc
))
922 ret
= drm_crtc_vblank_get(crtc
);
926 old_crtc_state
->enable
= true;
927 old_crtc_state
->last_vblank_count
= drm_vblank_count(dev
, i
);
930 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
931 if (!old_crtc_state
->enable
)
934 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
935 old_crtc_state
->last_vblank_count
!=
936 drm_vblank_count(dev
, i
),
937 msecs_to_jiffies(50));
939 drm_crtc_vblank_put(crtc
);
942 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
945 * drm_atomic_helper_commit - commit validated state object
947 * @state: the driver state object
948 * @async: asynchronous commit
950 * This function commits a with drm_atomic_helper_check() pre-validated state
951 * object. This can still fail when e.g. the framebuffer reservation fails. For
952 * now this doesn't implement asynchronous commits.
955 * Zero for success or -errno.
957 int drm_atomic_helper_commit(struct drm_device
*dev
,
958 struct drm_atomic_state
*state
,
966 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
971 * This is the point of no return - everything below never fails except
972 * when the hw goes bonghits. Which means we can commit the new state on
973 * the software side now.
976 drm_atomic_helper_swap_state(dev
, state
);
979 * Everything below can be run asynchronously without the need to grab
980 * any modeset locks at all under one condition: It must be guaranteed
981 * that the asynchronous work has either been cancelled (if the driver
982 * supports it, which at least requires that the framebuffers get
983 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
984 * before the new state gets committed on the software side with
985 * drm_atomic_helper_swap_state().
987 * This scheme allows new atomic state updates to be prepared and
988 * checked in parallel to the asynchronous completion of the previous
989 * update. Which is important since compositors need to figure out the
990 * composition of the next frame right after having submitted the
994 wait_for_fences(dev
, state
);
996 drm_atomic_helper_commit_modeset_disables(dev
, state
);
998 drm_atomic_helper_commit_planes(dev
, state
);
1000 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1002 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1004 drm_atomic_helper_cleanup_planes(dev
, state
);
1006 drm_atomic_state_free(state
);
1010 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1013 * DOC: implementing async commit
1015 * For now the atomic helpers don't support async commit directly. If there is
1016 * real need it could be added though, using the dma-buf fence infrastructure
1017 * for generic synchronization with outstanding rendering.
1019 * For now drivers have to implement async commit themselves, with the following
1020 * sequence being the recommended one:
1022 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1023 * which commit needs to call which can fail, so we want to run it first and
1026 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1027 * might be affected the new state update. This can be done by either cancelling
1028 * or flushing the work items, depending upon whether the driver can deal with
1029 * cancelled updates. Note that it is important to ensure that the framebuffer
1030 * cleanup is still done when cancelling.
1032 * For sufficient parallelism it is recommended to have a work item per crtc
1033 * (for updates which don't touch global state) and a global one. Then we only
1034 * need to synchronize with the crtc work items for changed crtcs and the global
1035 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1037 * 3. The software state is updated synchronously with
1038 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1039 * locks means concurrent callers never see inconsistent state. And doing this
1040 * while it's guaranteed that no relevant async worker runs means that async
1041 * workers do not need grab any locks. Actually they must not grab locks, for
1042 * otherwise the work flushing will deadlock.
1044 * 4. Schedule a work item to do all subsequent steps, using the split-out
1045 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1046 * then cleaning up the framebuffers after the old framebuffer is no longer
1051 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1053 * @state: atomic state object with new state structures
1055 * This function prepares plane state, specifically framebuffers, for the new
1056 * configuration. If any failure is encountered this function will call
1057 * ->cleanup_fb on any already successfully prepared framebuffer.
1060 * 0 on success, negative error code on failure.
1062 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1063 struct drm_atomic_state
*state
)
1065 int nplanes
= dev
->mode_config
.num_total_plane
;
1068 for (i
= 0; i
< nplanes
; i
++) {
1069 const struct drm_plane_helper_funcs
*funcs
;
1070 struct drm_plane
*plane
= state
->planes
[i
];
1071 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1072 struct drm_framebuffer
*fb
;
1077 funcs
= plane
->helper_private
;
1079 fb
= plane_state
->fb
;
1081 if (fb
&& funcs
->prepare_fb
) {
1082 ret
= funcs
->prepare_fb(plane
, fb
, plane_state
);
1091 for (i
--; i
>= 0; i
--) {
1092 const struct drm_plane_helper_funcs
*funcs
;
1093 struct drm_plane
*plane
= state
->planes
[i
];
1094 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1095 struct drm_framebuffer
*fb
;
1100 funcs
= plane
->helper_private
;
1102 fb
= state
->plane_states
[i
]->fb
;
1104 if (fb
&& funcs
->cleanup_fb
)
1105 funcs
->cleanup_fb(plane
, fb
, plane_state
);
1111 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1114 * drm_atomic_helper_commit_planes - commit plane state
1116 * @old_state: atomic state object with old state structures
1118 * This function commits the new plane state using the plane and atomic helper
1119 * functions for planes and crtcs. It assumes that the atomic state has already
1120 * been pushed into the relevant object state pointers, since this step can no
1123 * It still requires the global state object @old_state to know which planes and
1124 * crtcs need to be updated though.
1126 * Note that this function does all plane updates across all CRTCs in one step.
1127 * If the hardware can't support this approach look at
1128 * drm_atomic_helper_commit_planes_on_crtc() instead.
1130 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1131 struct drm_atomic_state
*old_state
)
1133 struct drm_crtc
*crtc
;
1134 struct drm_crtc_state
*old_crtc_state
;
1135 struct drm_plane
*plane
;
1136 struct drm_plane_state
*old_plane_state
;
1139 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1140 const struct drm_crtc_helper_funcs
*funcs
;
1142 funcs
= crtc
->helper_private
;
1144 if (!funcs
|| !funcs
->atomic_begin
)
1147 funcs
->atomic_begin(crtc
);
1150 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1151 const struct drm_plane_helper_funcs
*funcs
;
1153 funcs
= plane
->helper_private
;
1159 * Special-case disabling the plane if drivers support it.
1161 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1162 funcs
->atomic_disable
)
1163 funcs
->atomic_disable(plane
, old_plane_state
);
1164 else if (plane
->state
->crtc
||
1165 drm_atomic_plane_disabling(plane
, old_plane_state
))
1166 funcs
->atomic_update(plane
, old_plane_state
);
1169 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1170 const struct drm_crtc_helper_funcs
*funcs
;
1172 funcs
= crtc
->helper_private
;
1174 if (!funcs
|| !funcs
->atomic_flush
)
1177 funcs
->atomic_flush(crtc
);
1180 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1183 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1184 * @old_crtc_state: atomic state object with the old crtc state
1186 * This function commits the new plane state using the plane and atomic helper
1187 * functions for planes on the specific crtc. It assumes that the atomic state
1188 * has already been pushed into the relevant object state pointers, since this
1189 * step can no longer fail.
1191 * This function is useful when plane updates should be done crtc-by-crtc
1192 * instead of one global step like drm_atomic_helper_commit_planes() does.
1194 * This function can only be savely used when planes are not allowed to move
1195 * between different CRTCs because this function doesn't handle inter-CRTC
1196 * depencies. Callers need to ensure that either no such depencies exist,
1197 * resolve them through ordering of commit calls or through some other means.
1200 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1202 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1203 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1204 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1205 struct drm_plane
*plane
;
1206 unsigned plane_mask
;
1208 plane_mask
= old_crtc_state
->plane_mask
;
1209 plane_mask
|= crtc
->state
->plane_mask
;
1211 crtc_funcs
= crtc
->helper_private
;
1212 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1213 crtc_funcs
->atomic_begin(crtc
);
1215 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1216 struct drm_plane_state
*old_plane_state
=
1217 drm_atomic_get_existing_plane_state(old_state
, plane
);
1218 const struct drm_plane_helper_funcs
*plane_funcs
;
1220 plane_funcs
= plane
->helper_private
;
1222 if (!old_plane_state
|| !plane_funcs
)
1225 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1227 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1228 plane_funcs
->atomic_disable
)
1229 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1230 else if (plane
->state
->crtc
||
1231 drm_atomic_plane_disabling(plane
, old_plane_state
))
1232 plane_funcs
->atomic_update(plane
, old_plane_state
);
1235 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1236 crtc_funcs
->atomic_flush(crtc
);
1238 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1241 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1243 * @old_state: atomic state object with old state structures
1245 * This function cleans up plane state, specifically framebuffers, from the old
1246 * configuration. Hence the old configuration must be perserved in @old_state to
1247 * be able to call this function.
1249 * This function must also be called on the new state when the atomic update
1250 * fails at any point after calling drm_atomic_helper_prepare_planes().
1252 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1253 struct drm_atomic_state
*old_state
)
1255 struct drm_plane
*plane
;
1256 struct drm_plane_state
*plane_state
;
1259 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1260 const struct drm_plane_helper_funcs
*funcs
;
1261 struct drm_framebuffer
*old_fb
;
1263 funcs
= plane
->helper_private
;
1265 old_fb
= plane_state
->fb
;
1267 if (old_fb
&& funcs
->cleanup_fb
)
1268 funcs
->cleanup_fb(plane
, old_fb
, plane_state
);
1271 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1274 * drm_atomic_helper_swap_state - store atomic state into current sw state
1276 * @state: atomic state
1278 * This function stores the atomic state into the current state pointers in all
1279 * driver objects. It should be called after all failing steps have been done
1280 * and succeeded, but before the actual hardware state is committed.
1282 * For cleanup and error recovery the current state for all changed objects will
1283 * be swaped into @state.
1285 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1287 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1289 * 2. Do any other steps that might fail.
1291 * 3. Put the staged state into the current state pointers with this function.
1293 * 4. Actually commit the hardware state.
1295 * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1296 * contains the old state. Also do any other cleanup required with that state.
1298 void drm_atomic_helper_swap_state(struct drm_device
*dev
,
1299 struct drm_atomic_state
*state
)
1303 for (i
= 0; i
< dev
->mode_config
.num_connector
; i
++) {
1304 struct drm_connector
*connector
= state
->connectors
[i
];
1309 connector
->state
->state
= state
;
1310 swap(state
->connector_states
[i
], connector
->state
);
1311 connector
->state
->state
= NULL
;
1314 for (i
= 0; i
< dev
->mode_config
.num_crtc
; i
++) {
1315 struct drm_crtc
*crtc
= state
->crtcs
[i
];
1320 crtc
->state
->state
= state
;
1321 swap(state
->crtc_states
[i
], crtc
->state
);
1322 crtc
->state
->state
= NULL
;
1325 for (i
= 0; i
< dev
->mode_config
.num_total_plane
; i
++) {
1326 struct drm_plane
*plane
= state
->planes
[i
];
1331 plane
->state
->state
= state
;
1332 swap(state
->plane_states
[i
], plane
->state
);
1333 plane
->state
->state
= NULL
;
1336 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
1339 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1340 * @plane: plane object to update
1341 * @crtc: owning CRTC of owning plane
1342 * @fb: framebuffer to flip onto plane
1343 * @crtc_x: x offset of primary plane on crtc
1344 * @crtc_y: y offset of primary plane on crtc
1345 * @crtc_w: width of primary plane rectangle on crtc
1346 * @crtc_h: height of primary plane rectangle on crtc
1347 * @src_x: x offset of @fb for panning
1348 * @src_y: y offset of @fb for panning
1349 * @src_w: width of source rectangle in @fb
1350 * @src_h: height of source rectangle in @fb
1352 * Provides a default plane update handler using the atomic driver interface.
1355 * Zero on success, error code on failure
1357 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
1358 struct drm_crtc
*crtc
,
1359 struct drm_framebuffer
*fb
,
1360 int crtc_x
, int crtc_y
,
1361 unsigned int crtc_w
, unsigned int crtc_h
,
1362 uint32_t src_x
, uint32_t src_y
,
1363 uint32_t src_w
, uint32_t src_h
)
1365 struct drm_atomic_state
*state
;
1366 struct drm_plane_state
*plane_state
;
1369 state
= drm_atomic_state_alloc(plane
->dev
);
1373 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1375 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1376 if (IS_ERR(plane_state
)) {
1377 ret
= PTR_ERR(plane_state
);
1381 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1384 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1385 plane_state
->crtc_x
= crtc_x
;
1386 plane_state
->crtc_y
= crtc_y
;
1387 plane_state
->crtc_h
= crtc_h
;
1388 plane_state
->crtc_w
= crtc_w
;
1389 plane_state
->src_x
= src_x
;
1390 plane_state
->src_y
= src_y
;
1391 plane_state
->src_h
= src_h
;
1392 plane_state
->src_w
= src_w
;
1394 if (plane
== crtc
->cursor
)
1395 state
->legacy_cursor_update
= true;
1397 ret
= drm_atomic_commit(state
);
1401 /* Driver takes ownership of state on successful commit. */
1404 if (ret
== -EDEADLK
)
1407 drm_atomic_state_free(state
);
1411 drm_atomic_state_clear(state
);
1412 drm_atomic_legacy_backoff(state
);
1415 * Someone might have exchanged the framebuffer while we dropped locks
1416 * in the backoff code. We need to fix up the fb refcount tracking the
1419 plane
->old_fb
= plane
->fb
;
1423 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
1426 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1427 * @plane: plane to disable
1429 * Provides a default plane disable handler using the atomic driver interface.
1432 * Zero on success, error code on failure
1434 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
1436 struct drm_atomic_state
*state
;
1437 struct drm_plane_state
*plane_state
;
1441 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1442 * acquire context. The real fix will be to wire the acquire ctx through
1443 * everywhere we need it, but meanwhile prevent chaos by just skipping
1444 * this noop. The critical case is the cursor ioctls which a) only grab
1445 * crtc/cursor-plane locks (so we need the crtc to get at the right
1446 * acquire context) and b) can try to disable the plane multiple times.
1451 state
= drm_atomic_state_alloc(plane
->dev
);
1455 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
1457 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1458 if (IS_ERR(plane_state
)) {
1459 ret
= PTR_ERR(plane_state
);
1463 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
1466 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
1467 plane_state
->crtc_x
= 0;
1468 plane_state
->crtc_y
= 0;
1469 plane_state
->crtc_h
= 0;
1470 plane_state
->crtc_w
= 0;
1471 plane_state
->src_x
= 0;
1472 plane_state
->src_y
= 0;
1473 plane_state
->src_h
= 0;
1474 plane_state
->src_w
= 0;
1476 if (plane
== plane
->crtc
->cursor
)
1477 state
->legacy_cursor_update
= true;
1479 ret
= drm_atomic_commit(state
);
1483 /* Driver takes ownership of state on successful commit. */
1486 if (ret
== -EDEADLK
)
1489 drm_atomic_state_free(state
);
1493 drm_atomic_state_clear(state
);
1494 drm_atomic_legacy_backoff(state
);
1497 * Someone might have exchanged the framebuffer while we dropped locks
1498 * in the backoff code. We need to fix up the fb refcount tracking the
1501 plane
->old_fb
= plane
->fb
;
1505 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
1507 static int update_output_state(struct drm_atomic_state
*state
,
1508 struct drm_mode_set
*set
)
1510 struct drm_device
*dev
= set
->crtc
->dev
;
1511 struct drm_crtc
*crtc
;
1512 struct drm_crtc_state
*crtc_state
;
1513 struct drm_connector
*connector
;
1514 struct drm_connector_state
*conn_state
;
1517 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
1518 state
->acquire_ctx
);
1522 /* First grab all affected connector/crtc states. */
1523 for (i
= 0; i
< set
->num_connectors
; i
++) {
1524 conn_state
= drm_atomic_get_connector_state(state
,
1525 set
->connectors
[i
]);
1526 if (IS_ERR(conn_state
))
1527 return PTR_ERR(conn_state
);
1530 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1531 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
1536 /* Then recompute connector->crtc links and crtc enabling state. */
1537 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
1538 if (conn_state
->crtc
== set
->crtc
) {
1539 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1545 for (j
= 0; j
< set
->num_connectors
; j
++) {
1546 if (set
->connectors
[j
] == connector
) {
1547 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1556 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1557 /* Don't update ->enable for the CRTC in the set_config request,
1558 * since a mismatch would indicate a bug in the upper layers.
1559 * The actual modeset code later on will catch any
1560 * inconsistencies here. */
1561 if (crtc
== set
->crtc
)
1564 crtc_state
->enable
=
1565 drm_atomic_connectors_for_crtc(state
, crtc
);
1572 * drm_atomic_helper_set_config - set a new config from userspace
1573 * @set: mode set configuration
1575 * Provides a default crtc set_config handler using the atomic driver interface.
1578 * Returns 0 on success, negative errno numbers on failure.
1580 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
1582 struct drm_atomic_state
*state
;
1583 struct drm_crtc
*crtc
= set
->crtc
;
1584 struct drm_crtc_state
*crtc_state
;
1585 struct drm_plane_state
*primary_state
;
1588 state
= drm_atomic_state_alloc(crtc
->dev
);
1592 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1594 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1595 if (IS_ERR(crtc_state
)) {
1596 ret
= PTR_ERR(crtc_state
);
1600 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
1601 if (IS_ERR(primary_state
)) {
1602 ret
= PTR_ERR(primary_state
);
1608 WARN_ON(set
->num_connectors
);
1610 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
1614 crtc_state
->active
= false;
1616 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
1620 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
1626 WARN_ON(!set
->num_connectors
);
1628 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
1632 crtc_state
->active
= true;
1634 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
1637 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
1638 primary_state
->crtc_x
= 0;
1639 primary_state
->crtc_y
= 0;
1640 primary_state
->crtc_h
= set
->mode
->vdisplay
;
1641 primary_state
->crtc_w
= set
->mode
->hdisplay
;
1642 primary_state
->src_x
= set
->x
<< 16;
1643 primary_state
->src_y
= set
->y
<< 16;
1644 primary_state
->src_h
= set
->mode
->vdisplay
<< 16;
1645 primary_state
->src_w
= set
->mode
->hdisplay
<< 16;
1648 ret
= update_output_state(state
, set
);
1652 ret
= drm_atomic_commit(state
);
1656 /* Driver takes ownership of state on successful commit. */
1659 if (ret
== -EDEADLK
)
1662 drm_atomic_state_free(state
);
1666 drm_atomic_state_clear(state
);
1667 drm_atomic_legacy_backoff(state
);
1670 * Someone might have exchanged the framebuffer while we dropped locks
1671 * in the backoff code. We need to fix up the fb refcount tracking the
1674 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1678 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
1681 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1683 * @property: DRM property
1684 * @val: value of property
1686 * Provides a default crtc set_property handler using the atomic driver
1690 * Zero on success, error code on failure
1693 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
1694 struct drm_property
*property
,
1697 struct drm_atomic_state
*state
;
1698 struct drm_crtc_state
*crtc_state
;
1701 state
= drm_atomic_state_alloc(crtc
->dev
);
1705 /* ->set_property is always called with all locks held. */
1706 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
1708 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1709 if (IS_ERR(crtc_state
)) {
1710 ret
= PTR_ERR(crtc_state
);
1714 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
1719 ret
= drm_atomic_commit(state
);
1723 /* Driver takes ownership of state on successful commit. */
1726 if (ret
== -EDEADLK
)
1729 drm_atomic_state_free(state
);
1733 drm_atomic_state_clear(state
);
1734 drm_atomic_legacy_backoff(state
);
1738 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
1741 * drm_atomic_helper_plane_set_property - helper for plane properties
1743 * @property: DRM property
1744 * @val: value of property
1746 * Provides a default plane set_property handler using the atomic driver
1750 * Zero on success, error code on failure
1753 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
1754 struct drm_property
*property
,
1757 struct drm_atomic_state
*state
;
1758 struct drm_plane_state
*plane_state
;
1761 state
= drm_atomic_state_alloc(plane
->dev
);
1765 /* ->set_property is always called with all locks held. */
1766 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
1768 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1769 if (IS_ERR(plane_state
)) {
1770 ret
= PTR_ERR(plane_state
);
1774 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
1779 ret
= drm_atomic_commit(state
);
1783 /* Driver takes ownership of state on successful commit. */
1786 if (ret
== -EDEADLK
)
1789 drm_atomic_state_free(state
);
1793 drm_atomic_state_clear(state
);
1794 drm_atomic_legacy_backoff(state
);
1798 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
1801 * drm_atomic_helper_connector_set_property - helper for connector properties
1802 * @connector: DRM connector
1803 * @property: DRM property
1804 * @val: value of property
1806 * Provides a default connector set_property handler using the atomic driver
1810 * Zero on success, error code on failure
1813 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
1814 struct drm_property
*property
,
1817 struct drm_atomic_state
*state
;
1818 struct drm_connector_state
*connector_state
;
1821 state
= drm_atomic_state_alloc(connector
->dev
);
1825 /* ->set_property is always called with all locks held. */
1826 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
1828 connector_state
= drm_atomic_get_connector_state(state
, connector
);
1829 if (IS_ERR(connector_state
)) {
1830 ret
= PTR_ERR(connector_state
);
1834 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
1839 ret
= drm_atomic_commit(state
);
1843 /* Driver takes ownership of state on successful commit. */
1846 if (ret
== -EDEADLK
)
1849 drm_atomic_state_free(state
);
1853 drm_atomic_state_clear(state
);
1854 drm_atomic_legacy_backoff(state
);
1858 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
1861 * drm_atomic_helper_page_flip - execute a legacy page flip
1863 * @fb: DRM framebuffer
1864 * @event: optional DRM event to signal upon completion
1865 * @flags: flip flags for non-vblank sync'ed updates
1867 * Provides a default page flip implementation using the atomic driver interface.
1869 * Note that for now so called async page flips (i.e. updates which are not
1870 * synchronized to vblank) are not supported, since the atomic interfaces have
1871 * no provisions for this yet.
1874 * Returns 0 on success, negative errno numbers on failure.
1876 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
1877 struct drm_framebuffer
*fb
,
1878 struct drm_pending_vblank_event
*event
,
1881 struct drm_plane
*plane
= crtc
->primary
;
1882 struct drm_atomic_state
*state
;
1883 struct drm_plane_state
*plane_state
;
1884 struct drm_crtc_state
*crtc_state
;
1887 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
1890 state
= drm_atomic_state_alloc(plane
->dev
);
1894 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1896 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1897 if (IS_ERR(crtc_state
)) {
1898 ret
= PTR_ERR(crtc_state
);
1901 crtc_state
->event
= event
;
1903 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1904 if (IS_ERR(plane_state
)) {
1905 ret
= PTR_ERR(plane_state
);
1909 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1912 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1914 ret
= drm_atomic_async_commit(state
);
1918 /* TODO: ->page_flip is the only driver callback where the core
1919 * doesn't update plane->fb. For now patch it up here. */
1920 plane
->fb
= plane
->state
->fb
;
1922 /* Driver takes ownership of state on successful async commit. */
1925 if (ret
== -EDEADLK
)
1928 drm_atomic_state_free(state
);
1932 drm_atomic_state_clear(state
);
1933 drm_atomic_legacy_backoff(state
);
1936 * Someone might have exchanged the framebuffer while we dropped locks
1937 * in the backoff code. We need to fix up the fb refcount tracking the
1940 plane
->old_fb
= plane
->fb
;
1944 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
1947 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1948 * @connector: affected connector
1951 * This is the main helper function provided by the atomic helper framework for
1952 * implementing the legacy DPMS connector interface. It computes the new desired
1953 * ->active state for the corresponding CRTC (if the connector is enabled) and
1956 void drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
1959 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
1960 struct drm_atomic_state
*state
;
1961 struct drm_crtc_state
*crtc_state
;
1962 struct drm_crtc
*crtc
;
1963 struct drm_connector
*tmp_connector
;
1965 bool active
= false;
1967 if (mode
!= DRM_MODE_DPMS_ON
)
1968 mode
= DRM_MODE_DPMS_OFF
;
1970 connector
->dpms
= mode
;
1971 crtc
= connector
->state
->crtc
;
1976 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1977 state
= drm_atomic_state_alloc(connector
->dev
);
1981 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1983 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1984 if (IS_ERR(crtc_state
))
1987 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
1989 list_for_each_entry(tmp_connector
, &config
->connector_list
, head
) {
1990 if (tmp_connector
->state
->crtc
!= crtc
)
1993 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
1998 crtc_state
->active
= active
;
2000 ret
= drm_atomic_commit(state
);
2004 /* Driver takes ownership of state on successful async commit. */
2007 if (ret
== -EDEADLK
)
2010 drm_atomic_state_free(state
);
2012 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret
);
2016 drm_atomic_state_clear(state
);
2017 drm_atomic_legacy_backoff(state
);
2021 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2024 * DOC: atomic state reset and initialization
2026 * Both the drm core and the atomic helpers assume that there is always the full
2027 * and correct atomic software state for all connectors, CRTCs and planes
2028 * available. Which is a bit a problem on driver load and also after system
2029 * suspend. One way to solve this is to have a hardware state read-out
2030 * infrastructure which reconstructs the full software state (e.g. the i915
2033 * The simpler solution is to just reset the software state to everything off,
2034 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2035 * the atomic helpers provide default reset implementations for all hooks.
2039 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2042 * Resets the atomic state for @crtc by freeing the state pointer (which might
2043 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2045 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2048 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2051 crtc
->state
->crtc
= crtc
;
2053 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2056 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2057 * @crtc: CRTC object
2058 * @state: atomic CRTC state
2060 * Copies atomic state from a CRTC's current state and resets inferred values.
2061 * This is useful for drivers that subclass the CRTC state.
2063 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2064 struct drm_crtc_state
*state
)
2066 memcpy(state
, crtc
->state
, sizeof(*state
));
2068 state
->mode_changed
= false;
2069 state
->active_changed
= false;
2070 state
->planes_changed
= false;
2071 state
->event
= NULL
;
2073 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
2076 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2079 * Default CRTC state duplicate hook for drivers which don't have their own
2080 * subclassed CRTC state structure.
2082 struct drm_crtc_state
*
2083 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
2085 struct drm_crtc_state
*state
;
2087 if (WARN_ON(!crtc
->state
))
2090 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2092 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
2096 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
2099 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2100 * @crtc: CRTC object
2101 * @state: CRTC state object to release
2103 * Releases all resources stored in the CRTC state without actually freeing
2104 * the memory of the CRTC state. This is useful for drivers that subclass the
2107 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2108 struct drm_crtc_state
*state
)
2111 * This is currently a placeholder so that drivers that subclass the
2112 * state will automatically do the right thing if code is ever added
2116 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
2119 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2121 * @state: CRTC state object to release
2123 * Default CRTC state destroy hook for drivers which don't have their own
2124 * subclassed CRTC state structure.
2126 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2127 struct drm_crtc_state
*state
)
2129 __drm_atomic_helper_crtc_destroy_state(crtc
, state
);
2132 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
2135 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2138 * Resets the atomic state for @plane by freeing the state pointer (which might
2139 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2141 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
2143 if (plane
->state
&& plane
->state
->fb
)
2144 drm_framebuffer_unreference(plane
->state
->fb
);
2146 kfree(plane
->state
);
2147 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
2150 plane
->state
->plane
= plane
;
2152 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
2155 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2156 * @plane: plane object
2157 * @state: atomic plane state
2159 * Copies atomic state from a plane's current state. This is useful for
2160 * drivers that subclass the plane state.
2162 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
2163 struct drm_plane_state
*state
)
2165 memcpy(state
, plane
->state
, sizeof(*state
));
2168 drm_framebuffer_reference(state
->fb
);
2170 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
2173 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2176 * Default plane state duplicate hook for drivers which don't have their own
2177 * subclassed plane state structure.
2179 struct drm_plane_state
*
2180 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
2182 struct drm_plane_state
*state
;
2184 if (WARN_ON(!plane
->state
))
2187 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2189 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
2193 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
2196 * __drm_atomic_helper_plane_destroy_state - release plane state
2197 * @plane: plane object
2198 * @state: plane state object to release
2200 * Releases all resources stored in the plane state without actually freeing
2201 * the memory of the plane state. This is useful for drivers that subclass the
2204 void __drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2205 struct drm_plane_state
*state
)
2208 drm_framebuffer_unreference(state
->fb
);
2210 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
2213 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2215 * @state: plane state object to release
2217 * Default plane state destroy hook for drivers which don't have their own
2218 * subclassed plane state structure.
2220 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2221 struct drm_plane_state
*state
)
2223 __drm_atomic_helper_plane_destroy_state(plane
, state
);
2226 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
2229 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2230 * @connector: drm connector
2232 * Resets the atomic state for @connector by freeing the state pointer (which
2233 * might be NULL, e.g. at driver load time) and allocating a new empty state
2236 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
2238 kfree(connector
->state
);
2239 connector
->state
= kzalloc(sizeof(*connector
->state
), GFP_KERNEL
);
2241 if (connector
->state
)
2242 connector
->state
->connector
= connector
;
2244 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
2247 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2248 * @connector: connector object
2249 * @state: atomic connector state
2251 * Copies atomic state from a connector's current state. This is useful for
2252 * drivers that subclass the connector state.
2255 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
2256 struct drm_connector_state
*state
)
2258 memcpy(state
, connector
->state
, sizeof(*state
));
2260 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
2263 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2264 * @connector: drm connector
2266 * Default connector state duplicate hook for drivers which don't have their own
2267 * subclassed connector state structure.
2269 struct drm_connector_state
*
2270 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
2272 struct drm_connector_state
*state
;
2274 if (WARN_ON(!connector
->state
))
2277 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2279 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
2283 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
2286 * __drm_atomic_helper_connector_destroy_state - release connector state
2287 * @connector: connector object
2288 * @state: connector state object to release
2290 * Releases all resources stored in the connector state without actually
2291 * freeing the memory of the connector state. This is useful for drivers that
2292 * subclass the connector state.
2295 __drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2296 struct drm_connector_state
*state
)
2299 * This is currently a placeholder so that drivers that subclass the
2300 * state will automatically do the right thing if code is ever added
2304 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
2307 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2308 * @connector: drm connector
2309 * @state: connector state object to release
2311 * Default connector state destroy hook for drivers which don't have their own
2312 * subclassed connector state structure.
2314 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2315 struct drm_connector_state
*state
)
2317 __drm_atomic_helper_connector_destroy_state(connector
, state
);
2320 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);