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 if (encoder
->bridge
&& encoder
->bridge
->funcs
->mode_fixup
) {
287 ret
= encoder
->bridge
->funcs
->mode_fixup(
288 encoder
->bridge
, &crtc_state
->mode
,
289 &crtc_state
->adjusted_mode
);
291 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
296 if (funcs
->atomic_check
) {
297 ret
= funcs
->atomic_check(encoder
, crtc_state
,
300 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
301 encoder
->base
.id
, encoder
->name
);
305 ret
= funcs
->mode_fixup(encoder
, &crtc_state
->mode
,
306 &crtc_state
->adjusted_mode
);
308 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
309 encoder
->base
.id
, encoder
->name
);
315 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
316 const struct drm_crtc_helper_funcs
*funcs
;
318 if (!crtc_state
->mode_changed
)
321 funcs
= crtc
->helper_private
;
322 if (!funcs
->mode_fixup
)
325 ret
= funcs
->mode_fixup(crtc
, &crtc_state
->mode
,
326 &crtc_state
->adjusted_mode
);
328 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
338 needs_modeset(struct drm_crtc_state
*state
)
340 return state
->mode_changed
|| state
->active_changed
;
344 * drm_atomic_helper_check_modeset - validate state object for modeset changes
346 * @state: the driver state object
348 * Check the state object to see if the requested state is physically possible.
349 * This does all the crtc and connector related computations for an atomic
350 * update. It computes and updates crtc_state->mode_changed, adds any additional
351 * connectors needed for full modesets and calls down into ->mode_fixup
352 * functions of the driver backend.
356 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
357 * plane update can't be done without a full modeset) _must_ call this function
358 * afterwards after that change. It is permitted to call this function multiple
359 * times for the same update, e.g. when the ->atomic_check functions depend upon
360 * the adjusted dotclock for fifo space allocation and watermark computation.
363 * Zero for success or -errno
366 drm_atomic_helper_check_modeset(struct drm_device
*dev
,
367 struct drm_atomic_state
*state
)
369 struct drm_crtc
*crtc
;
370 struct drm_crtc_state
*crtc_state
;
371 struct drm_connector
*connector
;
372 struct drm_connector_state
*connector_state
;
375 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
376 if (!drm_mode_equal(&crtc
->state
->mode
, &crtc_state
->mode
)) {
377 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
379 crtc_state
->mode_changed
= true;
382 if (crtc
->state
->enable
!= crtc_state
->enable
) {
383 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
385 crtc_state
->mode_changed
= true;
389 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
391 * This only sets crtc->mode_changed for routing changes,
392 * drivers must set crtc->mode_changed themselves when connector
393 * properties need to be updated.
395 ret
= update_connector_routing(state
, i
);
401 * After all the routing has been prepared we need to add in any
402 * connector which is itself unchanged, but who's crtc changes it's
403 * configuration. This must be done before calling mode_fixup in case a
404 * crtc only changed its mode but has the same set of connectors.
406 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
410 * We must set ->active_changed after walking connectors for
411 * otherwise an update that only changes active would result in
412 * a full modeset because update_connector_routing force that.
414 if (crtc
->state
->active
!= crtc_state
->active
) {
415 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
417 crtc_state
->active_changed
= true;
420 if (!needs_modeset(crtc_state
))
423 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
425 crtc_state
->enable
? 'y' : 'n',
426 crtc_state
->active
? 'y' : 'n');
428 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
432 ret
= drm_atomic_add_affected_planes(state
, crtc
);
436 num_connectors
= drm_atomic_connectors_for_crtc(state
,
439 if (crtc_state
->enable
!= !!num_connectors
) {
440 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
447 return mode_fixup(state
);
449 EXPORT_SYMBOL(drm_atomic_helper_check_modeset
);
452 * drm_atomic_helper_check_planes - validate state object for planes changes
454 * @state: the driver state object
456 * Check the state object to see if the requested state is physically possible.
457 * This does all the plane update related checks using by calling into the
458 * ->atomic_check hooks provided by the driver.
461 * Zero for success or -errno
464 drm_atomic_helper_check_planes(struct drm_device
*dev
,
465 struct drm_atomic_state
*state
)
467 struct drm_crtc
*crtc
;
468 struct drm_crtc_state
*crtc_state
;
469 struct drm_plane
*plane
;
470 struct drm_plane_state
*plane_state
;
473 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
474 const struct drm_plane_helper_funcs
*funcs
;
476 funcs
= plane
->helper_private
;
478 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
480 if (!funcs
|| !funcs
->atomic_check
)
483 ret
= funcs
->atomic_check(plane
, plane_state
);
485 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
491 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
492 const struct drm_crtc_helper_funcs
*funcs
;
494 funcs
= crtc
->helper_private
;
496 if (!funcs
|| !funcs
->atomic_check
)
499 ret
= funcs
->atomic_check(crtc
, state
->crtc_states
[i
]);
501 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
509 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
512 * drm_atomic_helper_check - validate state object
514 * @state: the driver state object
516 * Check the state object to see if the requested state is physically possible.
517 * Only crtcs and planes have check callbacks, so for any additional (global)
518 * checking that a driver needs it can simply wrap that around this function.
519 * Drivers without such needs can directly use this as their ->atomic_check()
522 * This just wraps the two parts of the state checking for planes and modeset
523 * state in the default order: First it calls drm_atomic_helper_check_modeset()
524 * and then drm_atomic_helper_check_planes(). The assumption is that the
525 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
526 * e.g. properly compute watermarks.
529 * Zero for success or -errno
531 int drm_atomic_helper_check(struct drm_device
*dev
,
532 struct drm_atomic_state
*state
)
536 ret
= drm_atomic_helper_check_modeset(dev
, state
);
540 ret
= drm_atomic_helper_check_planes(dev
, state
);
546 EXPORT_SYMBOL(drm_atomic_helper_check
);
549 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
551 struct drm_connector
*connector
;
552 struct drm_connector_state
*old_conn_state
;
553 struct drm_crtc
*crtc
;
554 struct drm_crtc_state
*old_crtc_state
;
557 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
558 const struct drm_encoder_helper_funcs
*funcs
;
559 struct drm_encoder
*encoder
;
560 struct drm_crtc_state
*old_crtc_state
;
562 /* Shut down everything that's in the changeset and currently
563 * still on. So need to check the old, saved state. */
564 if (!old_conn_state
->crtc
)
567 old_crtc_state
= old_state
->crtc_states
[drm_crtc_index(old_conn_state
->crtc
)];
569 if (!old_crtc_state
->active
||
570 !needs_modeset(old_conn_state
->crtc
->state
))
573 encoder
= old_conn_state
->best_encoder
;
575 /* We shouldn't get this far if we didn't previously have
576 * an encoder.. but WARN_ON() rather than explode.
578 if (WARN_ON(!encoder
))
581 funcs
= encoder
->helper_private
;
583 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
584 encoder
->base
.id
, encoder
->name
);
587 * Each encoder has at most one connector (since we always steal
588 * it away), so we won't call disable hooks twice.
591 encoder
->bridge
->funcs
->disable(encoder
->bridge
);
593 /* Right function depends upon target state. */
594 if (connector
->state
->crtc
&& funcs
->prepare
)
595 funcs
->prepare(encoder
);
596 else if (funcs
->disable
)
597 funcs
->disable(encoder
);
599 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
602 encoder
->bridge
->funcs
->post_disable(encoder
->bridge
);
605 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
606 const struct drm_crtc_helper_funcs
*funcs
;
608 /* Shut down everything that needs a full modeset. */
609 if (!needs_modeset(crtc
->state
))
612 if (!old_crtc_state
->active
)
615 funcs
= crtc
->helper_private
;
617 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
621 /* Right function depends upon target state. */
622 if (crtc
->state
->enable
&& funcs
->prepare
)
623 funcs
->prepare(crtc
);
624 else if (funcs
->disable
)
625 funcs
->disable(crtc
);
627 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
632 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
634 * @old_state: atomic state object with old state structures
636 * This function updates all the various legacy modeset state pointers in
637 * connectors, encoders and crtcs. It also updates the timestamping constants
638 * used for precise vblank timestamps by calling
639 * drm_calc_timestamping_constants().
641 * Drivers can use this for building their own atomic commit if they don't have
642 * a pure helper-based modeset implementation.
645 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
646 struct drm_atomic_state
*old_state
)
648 struct drm_connector
*connector
;
649 struct drm_connector_state
*old_conn_state
;
650 struct drm_crtc
*crtc
;
651 struct drm_crtc_state
*old_crtc_state
;
654 /* clear out existing links */
655 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
656 if (!connector
->encoder
)
659 WARN_ON(!connector
->encoder
->crtc
);
661 connector
->encoder
->crtc
= NULL
;
662 connector
->encoder
= NULL
;
666 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
667 if (!connector
->state
->crtc
)
670 if (WARN_ON(!connector
->state
->best_encoder
))
673 connector
->encoder
= connector
->state
->best_encoder
;
674 connector
->encoder
->crtc
= connector
->state
->crtc
;
677 /* set legacy state in the crtc structure */
678 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
679 crtc
->mode
= crtc
->state
->mode
;
680 crtc
->enabled
= crtc
->state
->enable
;
681 crtc
->x
= crtc
->primary
->state
->src_x
>> 16;
682 crtc
->y
= crtc
->primary
->state
->src_y
>> 16;
684 if (crtc
->state
->enable
)
685 drm_calc_timestamping_constants(crtc
,
686 &crtc
->state
->adjusted_mode
);
689 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
692 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
694 struct drm_crtc
*crtc
;
695 struct drm_crtc_state
*old_crtc_state
;
696 struct drm_connector
*connector
;
697 struct drm_connector_state
*old_conn_state
;
700 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
701 const struct drm_crtc_helper_funcs
*funcs
;
703 if (!crtc
->state
->mode_changed
)
706 funcs
= crtc
->helper_private
;
708 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
709 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
712 funcs
->mode_set_nofb(crtc
);
716 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
717 const struct drm_encoder_helper_funcs
*funcs
;
718 struct drm_crtc_state
*new_crtc_state
;
719 struct drm_encoder
*encoder
;
720 struct drm_display_mode
*mode
, *adjusted_mode
;
722 if (!connector
->state
->best_encoder
)
725 encoder
= connector
->state
->best_encoder
;
726 funcs
= encoder
->helper_private
;
727 new_crtc_state
= connector
->state
->crtc
->state
;
728 mode
= &new_crtc_state
->mode
;
729 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
731 if (!new_crtc_state
->mode_changed
)
734 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
735 encoder
->base
.id
, encoder
->name
);
738 * Each encoder has at most one connector (since we always steal
739 * it away), so we won't call mode_set hooks twice.
742 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
744 if (encoder
->bridge
&& encoder
->bridge
->funcs
->mode_set
)
745 encoder
->bridge
->funcs
->mode_set(encoder
->bridge
,
746 mode
, adjusted_mode
);
751 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
753 * @old_state: atomic state object with old state structures
755 * This function shuts down all the outputs that need to be shut down and
756 * prepares them (if required) with the new mode.
758 * For compatability with legacy crtc helpers this should be called before
759 * drm_atomic_helper_commit_planes(), which is what the default commit function
760 * does. But drivers with different needs can group the modeset commits together
761 * and do the plane commits at the end. This is useful for drivers doing runtime
762 * PM since planes updates then only happen when the CRTC is actually enabled.
764 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
765 struct drm_atomic_state
*old_state
)
767 disable_outputs(dev
, old_state
);
769 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
771 crtc_set_mode(dev
, old_state
);
773 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
776 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
778 * @old_state: atomic state object with old state structures
780 * This function enables all the outputs with the new configuration which had to
781 * be turned off for the update.
783 * For compatability with legacy crtc helpers this should be called after
784 * drm_atomic_helper_commit_planes(), which is what the default commit function
785 * does. But drivers with different needs can group the modeset commits together
786 * and do the plane commits at the end. This is useful for drivers doing runtime
787 * PM since planes updates then only happen when the CRTC is actually enabled.
789 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
790 struct drm_atomic_state
*old_state
)
792 struct drm_crtc
*crtc
;
793 struct drm_crtc_state
*old_crtc_state
;
794 struct drm_connector
*connector
;
795 struct drm_connector_state
*old_conn_state
;
798 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
799 const struct drm_crtc_helper_funcs
*funcs
;
801 /* Need to filter out CRTCs where only planes change. */
802 if (!needs_modeset(crtc
->state
))
805 if (!crtc
->state
->active
)
808 funcs
= crtc
->helper_private
;
810 if (crtc
->state
->enable
) {
811 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
821 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
822 const struct drm_encoder_helper_funcs
*funcs
;
823 struct drm_encoder
*encoder
;
825 if (!connector
->state
->best_encoder
)
828 if (!connector
->state
->crtc
->state
->active
||
829 !needs_modeset(connector
->state
->crtc
->state
))
832 encoder
= connector
->state
->best_encoder
;
833 funcs
= encoder
->helper_private
;
835 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
836 encoder
->base
.id
, encoder
->name
);
839 * Each encoder has at most one connector (since we always steal
840 * it away), so we won't call enable hooks twice.
843 encoder
->bridge
->funcs
->pre_enable(encoder
->bridge
);
846 funcs
->enable(encoder
);
848 funcs
->commit(encoder
);
851 encoder
->bridge
->funcs
->enable(encoder
->bridge
);
854 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
856 static void wait_for_fences(struct drm_device
*dev
,
857 struct drm_atomic_state
*state
)
859 struct drm_plane
*plane
;
860 struct drm_plane_state
*plane_state
;
863 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
864 if (!plane
->state
->fence
)
867 WARN_ON(!plane
->state
->fb
);
869 fence_wait(plane
->state
->fence
, false);
870 fence_put(plane
->state
->fence
);
871 plane
->state
->fence
= NULL
;
875 static bool framebuffer_changed(struct drm_device
*dev
,
876 struct drm_atomic_state
*old_state
,
877 struct drm_crtc
*crtc
)
879 struct drm_plane
*plane
;
880 struct drm_plane_state
*old_plane_state
;
883 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
884 if (plane
->state
->crtc
!= crtc
&&
885 old_plane_state
->crtc
!= crtc
)
888 if (plane
->state
->fb
!= old_plane_state
->fb
)
896 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
898 * @old_state: atomic state object with old state structures
900 * Helper to, after atomic commit, wait for vblanks on all effected
901 * crtcs (ie. before cleaning up old framebuffers using
902 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
903 * framebuffers have actually changed to optimize for the legacy cursor and
904 * plane update use-case.
907 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
908 struct drm_atomic_state
*old_state
)
910 struct drm_crtc
*crtc
;
911 struct drm_crtc_state
*old_crtc_state
;
914 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
915 /* No one cares about the old state, so abuse it for tracking
916 * and store whether we hold a vblank reference (and should do a
917 * vblank wait) in the ->enable boolean. */
918 old_crtc_state
->enable
= false;
920 if (!crtc
->state
->enable
)
923 /* Legacy cursor ioctls are completely unsynced, and userspace
924 * relies on that (by doing tons of cursor updates). */
925 if (old_state
->legacy_cursor_update
)
928 if (!framebuffer_changed(dev
, old_state
, crtc
))
931 ret
= drm_crtc_vblank_get(crtc
);
935 old_crtc_state
->enable
= true;
936 old_crtc_state
->last_vblank_count
= drm_vblank_count(dev
, i
);
939 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
940 if (!old_crtc_state
->enable
)
943 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
944 old_crtc_state
->last_vblank_count
!=
945 drm_vblank_count(dev
, i
),
946 msecs_to_jiffies(50));
948 drm_crtc_vblank_put(crtc
);
951 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
954 * drm_atomic_helper_commit - commit validated state object
956 * @state: the driver state object
957 * @async: asynchronous commit
959 * This function commits a with drm_atomic_helper_check() pre-validated state
960 * object. This can still fail when e.g. the framebuffer reservation fails. For
961 * now this doesn't implement asynchronous commits.
964 * Zero for success or -errno.
966 int drm_atomic_helper_commit(struct drm_device
*dev
,
967 struct drm_atomic_state
*state
,
975 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
980 * This is the point of no return - everything below never fails except
981 * when the hw goes bonghits. Which means we can commit the new state on
982 * the software side now.
985 drm_atomic_helper_swap_state(dev
, state
);
988 * Everything below can be run asynchronously without the need to grab
989 * any modeset locks at all under one condition: It must be guaranteed
990 * that the asynchronous work has either been cancelled (if the driver
991 * supports it, which at least requires that the framebuffers get
992 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
993 * before the new state gets committed on the software side with
994 * drm_atomic_helper_swap_state().
996 * This scheme allows new atomic state updates to be prepared and
997 * checked in parallel to the asynchronous completion of the previous
998 * update. Which is important since compositors need to figure out the
999 * composition of the next frame right after having submitted the
1003 wait_for_fences(dev
, state
);
1005 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1007 drm_atomic_helper_commit_planes(dev
, state
);
1009 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1011 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1013 drm_atomic_helper_cleanup_planes(dev
, state
);
1015 drm_atomic_state_free(state
);
1019 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1022 * DOC: implementing async commit
1024 * For now the atomic helpers don't support async commit directly. If there is
1025 * real need it could be added though, using the dma-buf fence infrastructure
1026 * for generic synchronization with outstanding rendering.
1028 * For now drivers have to implement async commit themselves, with the following
1029 * sequence being the recommended one:
1031 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1032 * which commit needs to call which can fail, so we want to run it first and
1035 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1036 * might be affected the new state update. This can be done by either cancelling
1037 * or flushing the work items, depending upon whether the driver can deal with
1038 * cancelled updates. Note that it is important to ensure that the framebuffer
1039 * cleanup is still done when cancelling.
1041 * For sufficient parallelism it is recommended to have a work item per crtc
1042 * (for updates which don't touch global state) and a global one. Then we only
1043 * need to synchronize with the crtc work items for changed crtcs and the global
1044 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1046 * 3. The software state is updated synchronously with
1047 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1048 * locks means concurrent callers never see inconsistent state. And doing this
1049 * while it's guaranteed that no relevant async worker runs means that async
1050 * workers do not need grab any locks. Actually they must not grab locks, for
1051 * otherwise the work flushing will deadlock.
1053 * 4. Schedule a work item to do all subsequent steps, using the split-out
1054 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1055 * then cleaning up the framebuffers after the old framebuffer is no longer
1060 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1062 * @state: atomic state object with new state structures
1064 * This function prepares plane state, specifically framebuffers, for the new
1065 * configuration. If any failure is encountered this function will call
1066 * ->cleanup_fb on any already successfully prepared framebuffer.
1069 * 0 on success, negative error code on failure.
1071 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1072 struct drm_atomic_state
*state
)
1074 int nplanes
= dev
->mode_config
.num_total_plane
;
1077 for (i
= 0; i
< nplanes
; i
++) {
1078 const struct drm_plane_helper_funcs
*funcs
;
1079 struct drm_plane
*plane
= state
->planes
[i
];
1080 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1081 struct drm_framebuffer
*fb
;
1086 funcs
= plane
->helper_private
;
1088 fb
= plane_state
->fb
;
1090 if (fb
&& funcs
->prepare_fb
) {
1091 ret
= funcs
->prepare_fb(plane
, fb
, plane_state
);
1100 for (i
--; i
>= 0; i
--) {
1101 const struct drm_plane_helper_funcs
*funcs
;
1102 struct drm_plane
*plane
= state
->planes
[i
];
1103 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1104 struct drm_framebuffer
*fb
;
1109 funcs
= plane
->helper_private
;
1111 fb
= state
->plane_states
[i
]->fb
;
1113 if (fb
&& funcs
->cleanup_fb
)
1114 funcs
->cleanup_fb(plane
, fb
, plane_state
);
1120 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1123 * drm_atomic_helper_commit_planes - commit plane state
1125 * @old_state: atomic state object with old state structures
1127 * This function commits the new plane state using the plane and atomic helper
1128 * functions for planes and crtcs. It assumes that the atomic state has already
1129 * been pushed into the relevant object state pointers, since this step can no
1132 * It still requires the global state object @old_state to know which planes and
1133 * crtcs need to be updated though.
1135 * Note that this function does all plane updates across all CRTCs in one step.
1136 * If the hardware can't support this approach look at
1137 * drm_atomic_helper_commit_planes_on_crtc() instead.
1139 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1140 struct drm_atomic_state
*old_state
)
1142 struct drm_crtc
*crtc
;
1143 struct drm_crtc_state
*old_crtc_state
;
1144 struct drm_plane
*plane
;
1145 struct drm_plane_state
*old_plane_state
;
1148 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1149 const struct drm_crtc_helper_funcs
*funcs
;
1151 funcs
= crtc
->helper_private
;
1153 if (!funcs
|| !funcs
->atomic_begin
)
1156 funcs
->atomic_begin(crtc
);
1159 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1160 const struct drm_plane_helper_funcs
*funcs
;
1162 funcs
= plane
->helper_private
;
1168 * Special-case disabling the plane if drivers support it.
1170 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1171 funcs
->atomic_disable
)
1172 funcs
->atomic_disable(plane
, old_plane_state
);
1173 else if (plane
->state
->crtc
||
1174 drm_atomic_plane_disabling(plane
, old_plane_state
))
1175 funcs
->atomic_update(plane
, old_plane_state
);
1178 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1179 const struct drm_crtc_helper_funcs
*funcs
;
1181 funcs
= crtc
->helper_private
;
1183 if (!funcs
|| !funcs
->atomic_flush
)
1186 funcs
->atomic_flush(crtc
);
1189 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1192 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1193 * @old_crtc_state: atomic state object with the old crtc state
1195 * This function commits the new plane state using the plane and atomic helper
1196 * functions for planes on the specific crtc. It assumes that the atomic state
1197 * has already been pushed into the relevant object state pointers, since this
1198 * step can no longer fail.
1200 * This function is useful when plane updates should be done crtc-by-crtc
1201 * instead of one global step like drm_atomic_helper_commit_planes() does.
1203 * This function can only be savely used when planes are not allowed to move
1204 * between different CRTCs because this function doesn't handle inter-CRTC
1205 * depencies. Callers need to ensure that either no such depencies exist,
1206 * resolve them through ordering of commit calls or through some other means.
1209 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1211 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1212 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1213 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1214 struct drm_plane
*plane
;
1215 unsigned plane_mask
;
1217 plane_mask
= old_crtc_state
->plane_mask
;
1218 plane_mask
|= crtc
->state
->plane_mask
;
1220 crtc_funcs
= crtc
->helper_private
;
1221 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1222 crtc_funcs
->atomic_begin(crtc
);
1224 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1225 struct drm_plane_state
*old_plane_state
=
1226 drm_atomic_get_existing_plane_state(old_state
, plane
);
1227 const struct drm_plane_helper_funcs
*plane_funcs
;
1229 plane_funcs
= plane
->helper_private
;
1231 if (!old_plane_state
|| !plane_funcs
)
1234 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1236 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1237 plane_funcs
->atomic_disable
)
1238 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1239 else if (plane
->state
->crtc
||
1240 drm_atomic_plane_disabling(plane
, old_plane_state
))
1241 plane_funcs
->atomic_update(plane
, old_plane_state
);
1244 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1245 crtc_funcs
->atomic_flush(crtc
);
1247 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1250 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1252 * @old_state: atomic state object with old state structures
1254 * This function cleans up plane state, specifically framebuffers, from the old
1255 * configuration. Hence the old configuration must be perserved in @old_state to
1256 * be able to call this function.
1258 * This function must also be called on the new state when the atomic update
1259 * fails at any point after calling drm_atomic_helper_prepare_planes().
1261 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1262 struct drm_atomic_state
*old_state
)
1264 struct drm_plane
*plane
;
1265 struct drm_plane_state
*plane_state
;
1268 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1269 const struct drm_plane_helper_funcs
*funcs
;
1270 struct drm_framebuffer
*old_fb
;
1272 funcs
= plane
->helper_private
;
1274 old_fb
= plane_state
->fb
;
1276 if (old_fb
&& funcs
->cleanup_fb
)
1277 funcs
->cleanup_fb(plane
, old_fb
, plane_state
);
1280 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1283 * drm_atomic_helper_swap_state - store atomic state into current sw state
1285 * @state: atomic state
1287 * This function stores the atomic state into the current state pointers in all
1288 * driver objects. It should be called after all failing steps have been done
1289 * and succeeded, but before the actual hardware state is committed.
1291 * For cleanup and error recovery the current state for all changed objects will
1292 * be swaped into @state.
1294 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1296 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1298 * 2. Do any other steps that might fail.
1300 * 3. Put the staged state into the current state pointers with this function.
1302 * 4. Actually commit the hardware state.
1304 * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1305 * contains the old state. Also do any other cleanup required with that state.
1307 void drm_atomic_helper_swap_state(struct drm_device
*dev
,
1308 struct drm_atomic_state
*state
)
1312 for (i
= 0; i
< dev
->mode_config
.num_connector
; i
++) {
1313 struct drm_connector
*connector
= state
->connectors
[i
];
1318 connector
->state
->state
= state
;
1319 swap(state
->connector_states
[i
], connector
->state
);
1320 connector
->state
->state
= NULL
;
1323 for (i
= 0; i
< dev
->mode_config
.num_crtc
; i
++) {
1324 struct drm_crtc
*crtc
= state
->crtcs
[i
];
1329 crtc
->state
->state
= state
;
1330 swap(state
->crtc_states
[i
], crtc
->state
);
1331 crtc
->state
->state
= NULL
;
1334 for (i
= 0; i
< dev
->mode_config
.num_total_plane
; i
++) {
1335 struct drm_plane
*plane
= state
->planes
[i
];
1340 plane
->state
->state
= state
;
1341 swap(state
->plane_states
[i
], plane
->state
);
1342 plane
->state
->state
= NULL
;
1345 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
1348 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1349 * @plane: plane object to update
1350 * @crtc: owning CRTC of owning plane
1351 * @fb: framebuffer to flip onto plane
1352 * @crtc_x: x offset of primary plane on crtc
1353 * @crtc_y: y offset of primary plane on crtc
1354 * @crtc_w: width of primary plane rectangle on crtc
1355 * @crtc_h: height of primary plane rectangle on crtc
1356 * @src_x: x offset of @fb for panning
1357 * @src_y: y offset of @fb for panning
1358 * @src_w: width of source rectangle in @fb
1359 * @src_h: height of source rectangle in @fb
1361 * Provides a default plane update handler using the atomic driver interface.
1364 * Zero on success, error code on failure
1366 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
1367 struct drm_crtc
*crtc
,
1368 struct drm_framebuffer
*fb
,
1369 int crtc_x
, int crtc_y
,
1370 unsigned int crtc_w
, unsigned int crtc_h
,
1371 uint32_t src_x
, uint32_t src_y
,
1372 uint32_t src_w
, uint32_t src_h
)
1374 struct drm_atomic_state
*state
;
1375 struct drm_plane_state
*plane_state
;
1378 state
= drm_atomic_state_alloc(plane
->dev
);
1382 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1384 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1385 if (IS_ERR(plane_state
)) {
1386 ret
= PTR_ERR(plane_state
);
1390 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1393 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1394 plane_state
->crtc_x
= crtc_x
;
1395 plane_state
->crtc_y
= crtc_y
;
1396 plane_state
->crtc_h
= crtc_h
;
1397 plane_state
->crtc_w
= crtc_w
;
1398 plane_state
->src_x
= src_x
;
1399 plane_state
->src_y
= src_y
;
1400 plane_state
->src_h
= src_h
;
1401 plane_state
->src_w
= src_w
;
1403 if (plane
== crtc
->cursor
)
1404 state
->legacy_cursor_update
= true;
1406 ret
= drm_atomic_commit(state
);
1410 /* Driver takes ownership of state on successful commit. */
1413 if (ret
== -EDEADLK
)
1416 drm_atomic_state_free(state
);
1420 drm_atomic_state_clear(state
);
1421 drm_atomic_legacy_backoff(state
);
1424 * Someone might have exchanged the framebuffer while we dropped locks
1425 * in the backoff code. We need to fix up the fb refcount tracking the
1428 plane
->old_fb
= plane
->fb
;
1432 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
1435 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1436 * @plane: plane to disable
1438 * Provides a default plane disable handler using the atomic driver interface.
1441 * Zero on success, error code on failure
1443 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
1445 struct drm_atomic_state
*state
;
1446 struct drm_plane_state
*plane_state
;
1450 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1451 * acquire context. The real fix will be to wire the acquire ctx through
1452 * everywhere we need it, but meanwhile prevent chaos by just skipping
1453 * this noop. The critical case is the cursor ioctls which a) only grab
1454 * crtc/cursor-plane locks (so we need the crtc to get at the right
1455 * acquire context) and b) can try to disable the plane multiple times.
1460 state
= drm_atomic_state_alloc(plane
->dev
);
1464 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
1466 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1467 if (IS_ERR(plane_state
)) {
1468 ret
= PTR_ERR(plane_state
);
1472 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
1475 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
1476 plane_state
->crtc_x
= 0;
1477 plane_state
->crtc_y
= 0;
1478 plane_state
->crtc_h
= 0;
1479 plane_state
->crtc_w
= 0;
1480 plane_state
->src_x
= 0;
1481 plane_state
->src_y
= 0;
1482 plane_state
->src_h
= 0;
1483 plane_state
->src_w
= 0;
1485 if (plane
== plane
->crtc
->cursor
)
1486 state
->legacy_cursor_update
= true;
1488 ret
= drm_atomic_commit(state
);
1492 /* Driver takes ownership of state on successful commit. */
1495 if (ret
== -EDEADLK
)
1498 drm_atomic_state_free(state
);
1502 drm_atomic_state_clear(state
);
1503 drm_atomic_legacy_backoff(state
);
1506 * Someone might have exchanged the framebuffer while we dropped locks
1507 * in the backoff code. We need to fix up the fb refcount tracking the
1510 plane
->old_fb
= plane
->fb
;
1514 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
1516 static int update_output_state(struct drm_atomic_state
*state
,
1517 struct drm_mode_set
*set
)
1519 struct drm_device
*dev
= set
->crtc
->dev
;
1520 struct drm_crtc
*crtc
;
1521 struct drm_crtc_state
*crtc_state
;
1522 struct drm_connector
*connector
;
1523 struct drm_connector_state
*conn_state
;
1526 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
1527 state
->acquire_ctx
);
1531 /* First grab all affected connector/crtc states. */
1532 for (i
= 0; i
< set
->num_connectors
; i
++) {
1533 conn_state
= drm_atomic_get_connector_state(state
,
1534 set
->connectors
[i
]);
1535 if (IS_ERR(conn_state
))
1536 return PTR_ERR(conn_state
);
1539 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1540 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
1545 /* Then recompute connector->crtc links and crtc enabling state. */
1546 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
1547 if (conn_state
->crtc
== set
->crtc
) {
1548 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1554 for (j
= 0; j
< set
->num_connectors
; j
++) {
1555 if (set
->connectors
[j
] == connector
) {
1556 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1565 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1566 /* Don't update ->enable for the CRTC in the set_config request,
1567 * since a mismatch would indicate a bug in the upper layers.
1568 * The actual modeset code later on will catch any
1569 * inconsistencies here. */
1570 if (crtc
== set
->crtc
)
1573 crtc_state
->enable
=
1574 drm_atomic_connectors_for_crtc(state
, crtc
);
1581 * drm_atomic_helper_set_config - set a new config from userspace
1582 * @set: mode set configuration
1584 * Provides a default crtc set_config handler using the atomic driver interface.
1587 * Returns 0 on success, negative errno numbers on failure.
1589 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
1591 struct drm_atomic_state
*state
;
1592 struct drm_crtc
*crtc
= set
->crtc
;
1593 struct drm_crtc_state
*crtc_state
;
1594 struct drm_plane_state
*primary_state
;
1597 state
= drm_atomic_state_alloc(crtc
->dev
);
1601 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1603 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1604 if (IS_ERR(crtc_state
)) {
1605 ret
= PTR_ERR(crtc_state
);
1609 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
1610 if (IS_ERR(primary_state
)) {
1611 ret
= PTR_ERR(primary_state
);
1617 WARN_ON(set
->num_connectors
);
1619 crtc_state
->enable
= false;
1620 crtc_state
->active
= false;
1622 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
1626 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
1632 WARN_ON(!set
->num_connectors
);
1634 crtc_state
->enable
= true;
1635 crtc_state
->active
= true;
1636 drm_mode_copy(&crtc_state
->mode
, set
->mode
);
1638 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
1641 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
1642 primary_state
->crtc_x
= 0;
1643 primary_state
->crtc_y
= 0;
1644 primary_state
->crtc_h
= set
->mode
->vdisplay
;
1645 primary_state
->crtc_w
= set
->mode
->hdisplay
;
1646 primary_state
->src_x
= set
->x
<< 16;
1647 primary_state
->src_y
= set
->y
<< 16;
1648 primary_state
->src_h
= set
->mode
->vdisplay
<< 16;
1649 primary_state
->src_w
= set
->mode
->hdisplay
<< 16;
1652 ret
= update_output_state(state
, set
);
1656 ret
= drm_atomic_commit(state
);
1660 /* Driver takes ownership of state on successful commit. */
1663 if (ret
== -EDEADLK
)
1666 drm_atomic_state_free(state
);
1670 drm_atomic_state_clear(state
);
1671 drm_atomic_legacy_backoff(state
);
1674 * Someone might have exchanged the framebuffer while we dropped locks
1675 * in the backoff code. We need to fix up the fb refcount tracking the
1678 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1682 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
1685 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1687 * @property: DRM property
1688 * @val: value of property
1690 * Provides a default crtc set_property handler using the atomic driver
1694 * Zero on success, error code on failure
1697 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
1698 struct drm_property
*property
,
1701 struct drm_atomic_state
*state
;
1702 struct drm_crtc_state
*crtc_state
;
1705 state
= drm_atomic_state_alloc(crtc
->dev
);
1709 /* ->set_property is always called with all locks held. */
1710 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
1712 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1713 if (IS_ERR(crtc_state
)) {
1714 ret
= PTR_ERR(crtc_state
);
1718 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
1723 ret
= drm_atomic_commit(state
);
1727 /* Driver takes ownership of state on successful commit. */
1730 if (ret
== -EDEADLK
)
1733 drm_atomic_state_free(state
);
1737 drm_atomic_state_clear(state
);
1738 drm_atomic_legacy_backoff(state
);
1742 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
1745 * drm_atomic_helper_plane_set_property - helper for plane properties
1747 * @property: DRM property
1748 * @val: value of property
1750 * Provides a default plane set_property handler using the atomic driver
1754 * Zero on success, error code on failure
1757 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
1758 struct drm_property
*property
,
1761 struct drm_atomic_state
*state
;
1762 struct drm_plane_state
*plane_state
;
1765 state
= drm_atomic_state_alloc(plane
->dev
);
1769 /* ->set_property is always called with all locks held. */
1770 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
1772 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1773 if (IS_ERR(plane_state
)) {
1774 ret
= PTR_ERR(plane_state
);
1778 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
1783 ret
= drm_atomic_commit(state
);
1787 /* Driver takes ownership of state on successful commit. */
1790 if (ret
== -EDEADLK
)
1793 drm_atomic_state_free(state
);
1797 drm_atomic_state_clear(state
);
1798 drm_atomic_legacy_backoff(state
);
1802 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
1805 * drm_atomic_helper_connector_set_property - helper for connector properties
1806 * @connector: DRM connector
1807 * @property: DRM property
1808 * @val: value of property
1810 * Provides a default connector set_property handler using the atomic driver
1814 * Zero on success, error code on failure
1817 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
1818 struct drm_property
*property
,
1821 struct drm_atomic_state
*state
;
1822 struct drm_connector_state
*connector_state
;
1825 state
= drm_atomic_state_alloc(connector
->dev
);
1829 /* ->set_property is always called with all locks held. */
1830 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
1832 connector_state
= drm_atomic_get_connector_state(state
, connector
);
1833 if (IS_ERR(connector_state
)) {
1834 ret
= PTR_ERR(connector_state
);
1838 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
1843 ret
= drm_atomic_commit(state
);
1847 /* Driver takes ownership of state on successful commit. */
1850 if (ret
== -EDEADLK
)
1853 drm_atomic_state_free(state
);
1857 drm_atomic_state_clear(state
);
1858 drm_atomic_legacy_backoff(state
);
1862 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
1865 * drm_atomic_helper_page_flip - execute a legacy page flip
1867 * @fb: DRM framebuffer
1868 * @event: optional DRM event to signal upon completion
1869 * @flags: flip flags for non-vblank sync'ed updates
1871 * Provides a default page flip implementation using the atomic driver interface.
1873 * Note that for now so called async page flips (i.e. updates which are not
1874 * synchronized to vblank) are not supported, since the atomic interfaces have
1875 * no provisions for this yet.
1878 * Returns 0 on success, negative errno numbers on failure.
1880 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
1881 struct drm_framebuffer
*fb
,
1882 struct drm_pending_vblank_event
*event
,
1885 struct drm_plane
*plane
= crtc
->primary
;
1886 struct drm_atomic_state
*state
;
1887 struct drm_plane_state
*plane_state
;
1888 struct drm_crtc_state
*crtc_state
;
1891 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
1894 state
= drm_atomic_state_alloc(plane
->dev
);
1898 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1900 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1901 if (IS_ERR(crtc_state
)) {
1902 ret
= PTR_ERR(crtc_state
);
1905 crtc_state
->event
= event
;
1907 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1908 if (IS_ERR(plane_state
)) {
1909 ret
= PTR_ERR(plane_state
);
1913 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1916 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1918 ret
= drm_atomic_async_commit(state
);
1922 /* TODO: ->page_flip is the only driver callback where the core
1923 * doesn't update plane->fb. For now patch it up here. */
1924 plane
->fb
= plane
->state
->fb
;
1926 /* Driver takes ownership of state on successful async commit. */
1929 if (ret
== -EDEADLK
)
1932 drm_atomic_state_free(state
);
1936 drm_atomic_state_clear(state
);
1937 drm_atomic_legacy_backoff(state
);
1940 * Someone might have exchanged the framebuffer while we dropped locks
1941 * in the backoff code. We need to fix up the fb refcount tracking the
1944 plane
->old_fb
= plane
->fb
;
1948 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
1951 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1952 * @connector: affected connector
1955 * This is the main helper function provided by the atomic helper framework for
1956 * implementing the legacy DPMS connector interface. It computes the new desired
1957 * ->active state for the corresponding CRTC (if the connector is enabled) and
1960 void drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
1963 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
1964 struct drm_atomic_state
*state
;
1965 struct drm_crtc_state
*crtc_state
;
1966 struct drm_crtc
*crtc
;
1967 struct drm_connector
*tmp_connector
;
1969 bool active
= false;
1971 if (mode
!= DRM_MODE_DPMS_ON
)
1972 mode
= DRM_MODE_DPMS_OFF
;
1974 connector
->dpms
= mode
;
1975 crtc
= connector
->state
->crtc
;
1980 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1981 state
= drm_atomic_state_alloc(connector
->dev
);
1985 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1987 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1988 if (IS_ERR(crtc_state
))
1991 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
1993 list_for_each_entry(tmp_connector
, &config
->connector_list
, head
) {
1994 if (tmp_connector
->state
->crtc
!= crtc
)
1997 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2002 crtc_state
->active
= active
;
2004 ret
= drm_atomic_commit(state
);
2008 /* Driver takes ownership of state on successful async commit. */
2011 if (ret
== -EDEADLK
)
2014 drm_atomic_state_free(state
);
2016 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret
);
2020 drm_atomic_state_clear(state
);
2021 drm_atomic_legacy_backoff(state
);
2025 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2028 * DOC: atomic state reset and initialization
2030 * Both the drm core and the atomic helpers assume that there is always the full
2031 * and correct atomic software state for all connectors, CRTCs and planes
2032 * available. Which is a bit a problem on driver load and also after system
2033 * suspend. One way to solve this is to have a hardware state read-out
2034 * infrastructure which reconstructs the full software state (e.g. the i915
2037 * The simpler solution is to just reset the software state to everything off,
2038 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2039 * the atomic helpers provide default reset implementations for all hooks.
2043 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2046 * Resets the atomic state for @crtc by freeing the state pointer (which might
2047 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2049 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2052 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2055 crtc
->state
->crtc
= crtc
;
2057 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2060 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2061 * @crtc: CRTC object
2062 * @state: atomic CRTC state
2064 * Copies atomic state from a CRTC's current state and resets inferred values.
2065 * This is useful for drivers that subclass the CRTC state.
2067 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2068 struct drm_crtc_state
*state
)
2070 memcpy(state
, crtc
->state
, sizeof(*state
));
2072 state
->mode_changed
= false;
2073 state
->active_changed
= false;
2074 state
->planes_changed
= false;
2075 state
->event
= NULL
;
2077 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
2080 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2083 * Default CRTC state duplicate hook for drivers which don't have their own
2084 * subclassed CRTC state structure.
2086 struct drm_crtc_state
*
2087 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
2089 struct drm_crtc_state
*state
;
2091 if (WARN_ON(!crtc
->state
))
2094 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2096 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
2100 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
2103 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2104 * @crtc: CRTC object
2105 * @state: CRTC state object to release
2107 * Releases all resources stored in the CRTC state without actually freeing
2108 * the memory of the CRTC state. This is useful for drivers that subclass the
2111 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2112 struct drm_crtc_state
*state
)
2115 * This is currently a placeholder so that drivers that subclass the
2116 * state will automatically do the right thing if code is ever added
2120 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
2123 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2125 * @state: CRTC state object to release
2127 * Default CRTC state destroy hook for drivers which don't have their own
2128 * subclassed CRTC state structure.
2130 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2131 struct drm_crtc_state
*state
)
2133 __drm_atomic_helper_crtc_destroy_state(crtc
, state
);
2136 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
2139 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2142 * Resets the atomic state for @plane by freeing the state pointer (which might
2143 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2145 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
2147 if (plane
->state
&& plane
->state
->fb
)
2148 drm_framebuffer_unreference(plane
->state
->fb
);
2150 kfree(plane
->state
);
2151 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
2154 plane
->state
->plane
= plane
;
2156 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
2159 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2160 * @plane: plane object
2161 * @state: atomic plane state
2163 * Copies atomic state from a plane's current state. This is useful for
2164 * drivers that subclass the plane state.
2166 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
2167 struct drm_plane_state
*state
)
2169 memcpy(state
, plane
->state
, sizeof(*state
));
2172 drm_framebuffer_reference(state
->fb
);
2174 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
2177 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2180 * Default plane state duplicate hook for drivers which don't have their own
2181 * subclassed plane state structure.
2183 struct drm_plane_state
*
2184 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
2186 struct drm_plane_state
*state
;
2188 if (WARN_ON(!plane
->state
))
2191 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2193 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
2197 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
2200 * __drm_atomic_helper_plane_destroy_state - release plane state
2201 * @plane: plane object
2202 * @state: plane state object to release
2204 * Releases all resources stored in the plane state without actually freeing
2205 * the memory of the plane state. This is useful for drivers that subclass the
2208 void __drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2209 struct drm_plane_state
*state
)
2212 drm_framebuffer_unreference(state
->fb
);
2214 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
2217 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2219 * @state: plane state object to release
2221 * Default plane state destroy hook for drivers which don't have their own
2222 * subclassed plane state structure.
2224 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2225 struct drm_plane_state
*state
)
2227 __drm_atomic_helper_plane_destroy_state(plane
, state
);
2230 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
2233 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2234 * @connector: drm connector
2236 * Resets the atomic state for @connector by freeing the state pointer (which
2237 * might be NULL, e.g. at driver load time) and allocating a new empty state
2240 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
2242 kfree(connector
->state
);
2243 connector
->state
= kzalloc(sizeof(*connector
->state
), GFP_KERNEL
);
2245 if (connector
->state
)
2246 connector
->state
->connector
= connector
;
2248 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
2251 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2252 * @connector: connector object
2253 * @state: atomic connector state
2255 * Copies atomic state from a connector's current state. This is useful for
2256 * drivers that subclass the connector state.
2259 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
2260 struct drm_connector_state
*state
)
2262 memcpy(state
, connector
->state
, sizeof(*state
));
2264 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
2267 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2268 * @connector: drm connector
2270 * Default connector state duplicate hook for drivers which don't have their own
2271 * subclassed connector state structure.
2273 struct drm_connector_state
*
2274 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
2276 struct drm_connector_state
*state
;
2278 if (WARN_ON(!connector
->state
))
2281 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2283 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
2287 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
2290 * __drm_atomic_helper_connector_destroy_state - release connector state
2291 * @connector: connector object
2292 * @state: connector state object to release
2294 * Releases all resources stored in the connector state without actually
2295 * freeing the memory of the connector state. This is useful for drivers that
2296 * subclass the connector state.
2299 __drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2300 struct drm_connector_state
*state
)
2303 * This is currently a placeholder so that drivers that subclass the
2304 * state will automatically do the right thing if code is ever added
2308 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
2311 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2312 * @connector: drm connector
2313 * @state: connector state object to release
2315 * Default connector state destroy hook for drivers which don't have their own
2316 * subclassed connector state structure.
2318 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2319 struct drm_connector_state
*state
)
2321 __drm_atomic_helper_connector_destroy_state(connector
, state
);
2324 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);