2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic.h>
30 #include <drm/drm_plane_helper.h>
31 #include <drm/drm_crtc_helper.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <linux/fence.h>
38 * This helper library provides implementations of check and commit functions on
39 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
40 * also provides convenience implementations for the atomic state handling
41 * callbacks for drivers which don't need to subclass the drm core structures to
42 * add their own additional internal state.
44 * This library also provides default implementations for the check callback in
45 * drm_atomic_helper_check() and for the commit callback with
46 * drm_atomic_helper_commit(). But the individual stages and callbacks are
47 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
48 * together with a driver private modeset implementation.
50 * This library also provides implementations for all the legacy driver
51 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
52 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
56 * The atomic helper uses the same function table structures as all other
57 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
58 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
59 * also shares the struct &drm_plane_helper_funcs function table with the plane
63 drm_atomic_helper_plane_changed(struct drm_atomic_state
*state
,
64 struct drm_plane_state
*plane_state
,
65 struct drm_plane
*plane
)
67 struct drm_crtc_state
*crtc_state
;
69 if (plane
->state
->crtc
) {
70 crtc_state
= state
->crtc_states
[drm_crtc_index(plane
->state
->crtc
)];
72 if (WARN_ON(!crtc_state
))
75 crtc_state
->planes_changed
= true;
78 if (plane_state
->crtc
) {
80 state
->crtc_states
[drm_crtc_index(plane_state
->crtc
)];
82 if (WARN_ON(!crtc_state
))
85 crtc_state
->planes_changed
= true;
90 check_pending_encoder_assignment(struct drm_atomic_state
*state
,
91 struct drm_encoder
*new_encoder
)
93 struct drm_connector
*connector
;
94 struct drm_connector_state
*conn_state
;
97 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
98 if (conn_state
->best_encoder
!= new_encoder
)
101 /* encoder already assigned and we're trying to re-steal it! */
102 if (connector
->state
->best_encoder
!= conn_state
->best_encoder
)
109 static struct drm_crtc
*
110 get_current_crtc_for_encoder(struct drm_device
*dev
,
111 struct drm_encoder
*encoder
)
113 struct drm_mode_config
*config
= &dev
->mode_config
;
114 struct drm_connector
*connector
;
116 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
118 drm_for_each_connector(connector
, dev
) {
119 if (connector
->state
->best_encoder
!= encoder
)
122 return connector
->state
->crtc
;
129 steal_encoder(struct drm_atomic_state
*state
,
130 struct drm_encoder
*encoder
,
131 struct drm_crtc
*encoder_crtc
)
133 struct drm_mode_config
*config
= &state
->dev
->mode_config
;
134 struct drm_crtc_state
*crtc_state
;
135 struct drm_connector
*connector
;
136 struct drm_connector_state
*connector_state
;
140 * We can only steal an encoder coming from a connector, which means we
141 * must already hold the connection_mutex.
143 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
145 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
146 encoder
->base
.id
, encoder
->name
,
147 encoder_crtc
->base
.id
, encoder_crtc
->name
);
149 crtc_state
= drm_atomic_get_crtc_state(state
, encoder_crtc
);
150 if (IS_ERR(crtc_state
))
151 return PTR_ERR(crtc_state
);
153 crtc_state
->connectors_changed
= true;
155 list_for_each_entry(connector
, &config
->connector_list
, head
) {
156 if (connector
->state
->best_encoder
!= encoder
)
159 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
163 connector_state
= drm_atomic_get_connector_state(state
,
165 if (IS_ERR(connector_state
))
166 return PTR_ERR(connector_state
);
168 ret
= drm_atomic_set_crtc_for_connector(connector_state
, NULL
);
171 connector_state
->best_encoder
= NULL
;
178 update_connector_routing(struct drm_atomic_state
*state
, int conn_idx
)
180 const struct drm_connector_helper_funcs
*funcs
;
181 struct drm_encoder
*new_encoder
;
182 struct drm_crtc
*encoder_crtc
;
183 struct drm_connector
*connector
;
184 struct drm_connector_state
*connector_state
;
185 struct drm_crtc_state
*crtc_state
;
188 connector
= state
->connectors
[conn_idx
];
189 connector_state
= state
->connector_states
[conn_idx
];
194 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
198 if (connector
->state
->crtc
!= connector_state
->crtc
) {
199 if (connector
->state
->crtc
) {
200 idx
= drm_crtc_index(connector
->state
->crtc
);
202 crtc_state
= state
->crtc_states
[idx
];
203 crtc_state
->connectors_changed
= true;
206 if (connector_state
->crtc
) {
207 idx
= drm_crtc_index(connector_state
->crtc
);
209 crtc_state
= state
->crtc_states
[idx
];
210 crtc_state
->connectors_changed
= true;
214 if (!connector_state
->crtc
) {
215 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
219 connector_state
->best_encoder
= NULL
;
224 funcs
= connector
->helper_private
;
226 if (funcs
->atomic_best_encoder
)
227 new_encoder
= funcs
->atomic_best_encoder(connector
,
230 new_encoder
= funcs
->best_encoder(connector
);
233 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
239 if (!drm_encoder_crtc_ok(new_encoder
, connector_state
->crtc
)) {
240 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
241 new_encoder
->base
.id
,
243 connector_state
->crtc
->base
.id
);
247 if (new_encoder
== connector_state
->best_encoder
) {
248 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
251 new_encoder
->base
.id
,
253 connector_state
->crtc
->base
.id
,
254 connector_state
->crtc
->name
);
259 if (!check_pending_encoder_assignment(state
, new_encoder
)) {
260 DRM_DEBUG_ATOMIC("Encoder for [CONNECTOR:%d:%s] already assigned\n",
266 encoder_crtc
= get_current_crtc_for_encoder(state
->dev
,
270 ret
= steal_encoder(state
, new_encoder
, encoder_crtc
);
272 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
279 if (WARN_ON(!connector_state
->crtc
))
282 connector_state
->best_encoder
= new_encoder
;
283 idx
= drm_crtc_index(connector_state
->crtc
);
285 crtc_state
= state
->crtc_states
[idx
];
286 crtc_state
->connectors_changed
= true;
288 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
291 new_encoder
->base
.id
,
293 connector_state
->crtc
->base
.id
,
294 connector_state
->crtc
->name
);
300 mode_fixup(struct drm_atomic_state
*state
)
302 struct drm_crtc
*crtc
;
303 struct drm_crtc_state
*crtc_state
;
304 struct drm_connector
*connector
;
305 struct drm_connector_state
*conn_state
;
309 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
310 if (!crtc_state
->mode_changed
&&
311 !crtc_state
->connectors_changed
)
314 drm_mode_copy(&crtc_state
->adjusted_mode
, &crtc_state
->mode
);
317 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
318 const struct drm_encoder_helper_funcs
*funcs
;
319 struct drm_encoder
*encoder
;
321 WARN_ON(!!conn_state
->best_encoder
!= !!conn_state
->crtc
);
323 if (!conn_state
->crtc
|| !conn_state
->best_encoder
)
327 state
->crtc_states
[drm_crtc_index(conn_state
->crtc
)];
330 * Each encoder has at most one connector (since we always steal
331 * it away), so we won't call ->mode_fixup twice.
333 encoder
= conn_state
->best_encoder
;
334 funcs
= encoder
->helper_private
;
338 ret
= drm_bridge_mode_fixup(encoder
->bridge
, &crtc_state
->mode
,
339 &crtc_state
->adjusted_mode
);
341 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
345 if (funcs
->atomic_check
) {
346 ret
= funcs
->atomic_check(encoder
, crtc_state
,
349 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
350 encoder
->base
.id
, encoder
->name
);
353 } else if (funcs
->mode_fixup
) {
354 ret
= funcs
->mode_fixup(encoder
, &crtc_state
->mode
,
355 &crtc_state
->adjusted_mode
);
357 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
358 encoder
->base
.id
, encoder
->name
);
364 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
365 const struct drm_crtc_helper_funcs
*funcs
;
367 if (!crtc_state
->mode_changed
&&
368 !crtc_state
->connectors_changed
)
371 funcs
= crtc
->helper_private
;
372 if (!funcs
->mode_fixup
)
375 ret
= funcs
->mode_fixup(crtc
, &crtc_state
->mode
,
376 &crtc_state
->adjusted_mode
);
378 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
379 crtc
->base
.id
, crtc
->name
);
388 * drm_atomic_helper_check_modeset - validate state object for modeset changes
390 * @state: the driver state object
392 * Check the state object to see if the requested state is physically possible.
393 * This does all the crtc and connector related computations for an atomic
394 * update and adds any additional connectors needed for full modesets and calls
395 * down into ->mode_fixup functions of the driver backend.
397 * crtc_state->mode_changed is set when the input mode is changed.
398 * crtc_state->connectors_changed is set when a connector is added or
399 * removed from the crtc.
400 * crtc_state->active_changed is set when crtc_state->active changes,
401 * which is used for dpms.
405 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
406 * plane update can't be done without a full modeset) _must_ call this function
407 * afterwards after that change. It is permitted to call this function multiple
408 * times for the same update, e.g. when the ->atomic_check functions depend upon
409 * the adjusted dotclock for fifo space allocation and watermark computation.
412 * Zero for success or -errno
415 drm_atomic_helper_check_modeset(struct drm_device
*dev
,
416 struct drm_atomic_state
*state
)
418 struct drm_crtc
*crtc
;
419 struct drm_crtc_state
*crtc_state
;
420 struct drm_connector
*connector
;
421 struct drm_connector_state
*connector_state
;
424 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
425 if (!drm_mode_equal(&crtc
->state
->mode
, &crtc_state
->mode
)) {
426 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
427 crtc
->base
.id
, crtc
->name
);
428 crtc_state
->mode_changed
= true;
431 if (crtc
->state
->enable
!= crtc_state
->enable
) {
432 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
433 crtc
->base
.id
, crtc
->name
);
436 * For clarity this assignment is done here, but
437 * enable == 0 is only true when there are no
438 * connectors and a NULL mode.
440 * The other way around is true as well. enable != 0
441 * iff connectors are attached and a mode is set.
443 crtc_state
->mode_changed
= true;
444 crtc_state
->connectors_changed
= true;
448 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
450 * This only sets crtc->mode_changed for routing changes,
451 * drivers must set crtc->mode_changed themselves when connector
452 * properties need to be updated.
454 ret
= update_connector_routing(state
, i
);
460 * After all the routing has been prepared we need to add in any
461 * connector which is itself unchanged, but who's crtc changes it's
462 * configuration. This must be done before calling mode_fixup in case a
463 * crtc only changed its mode but has the same set of connectors.
465 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
466 bool has_connectors
=
467 !!crtc_state
->connector_mask
;
470 * We must set ->active_changed after walking connectors for
471 * otherwise an update that only changes active would result in
472 * a full modeset because update_connector_routing force that.
474 if (crtc
->state
->active
!= crtc_state
->active
) {
475 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
476 crtc
->base
.id
, crtc
->name
);
477 crtc_state
->active_changed
= true;
480 if (!drm_atomic_crtc_needs_modeset(crtc_state
))
483 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
484 crtc
->base
.id
, crtc
->name
,
485 crtc_state
->enable
? 'y' : 'n',
486 crtc_state
->active
? 'y' : 'n');
488 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
492 ret
= drm_atomic_add_affected_planes(state
, crtc
);
496 if (crtc_state
->enable
!= has_connectors
) {
497 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
498 crtc
->base
.id
, crtc
->name
);
504 return mode_fixup(state
);
506 EXPORT_SYMBOL(drm_atomic_helper_check_modeset
);
509 * drm_atomic_helper_check_planes - validate state object for planes changes
511 * @state: the driver state object
513 * Check the state object to see if the requested state is physically possible.
514 * This does all the plane update related checks using by calling into the
515 * ->atomic_check hooks provided by the driver.
517 * It also sets crtc_state->planes_changed to indicate that a crtc has
521 * Zero for success or -errno
524 drm_atomic_helper_check_planes(struct drm_device
*dev
,
525 struct drm_atomic_state
*state
)
527 struct drm_crtc
*crtc
;
528 struct drm_crtc_state
*crtc_state
;
529 struct drm_plane
*plane
;
530 struct drm_plane_state
*plane_state
;
533 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
534 const struct drm_plane_helper_funcs
*funcs
;
536 funcs
= plane
->helper_private
;
538 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
540 if (!funcs
|| !funcs
->atomic_check
)
543 ret
= funcs
->atomic_check(plane
, plane_state
);
545 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
546 plane
->base
.id
, plane
->name
);
551 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
552 const struct drm_crtc_helper_funcs
*funcs
;
554 funcs
= crtc
->helper_private
;
556 if (!funcs
|| !funcs
->atomic_check
)
559 ret
= funcs
->atomic_check(crtc
, state
->crtc_states
[i
]);
561 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
562 crtc
->base
.id
, crtc
->name
);
569 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
572 * drm_atomic_helper_check - validate state object
574 * @state: the driver state object
576 * Check the state object to see if the requested state is physically possible.
577 * Only crtcs and planes have check callbacks, so for any additional (global)
578 * checking that a driver needs it can simply wrap that around this function.
579 * Drivers without such needs can directly use this as their ->atomic_check()
582 * This just wraps the two parts of the state checking for planes and modeset
583 * state in the default order: First it calls drm_atomic_helper_check_modeset()
584 * and then drm_atomic_helper_check_planes(). The assumption is that the
585 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
586 * e.g. properly compute watermarks.
589 * Zero for success or -errno
591 int drm_atomic_helper_check(struct drm_device
*dev
,
592 struct drm_atomic_state
*state
)
596 ret
= drm_atomic_helper_check_modeset(dev
, state
);
600 ret
= drm_atomic_helper_check_planes(dev
, state
);
606 EXPORT_SYMBOL(drm_atomic_helper_check
);
609 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
611 struct drm_connector
*connector
;
612 struct drm_connector_state
*old_conn_state
;
613 struct drm_crtc
*crtc
;
614 struct drm_crtc_state
*old_crtc_state
;
617 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
618 const struct drm_encoder_helper_funcs
*funcs
;
619 struct drm_encoder
*encoder
;
620 struct drm_crtc_state
*old_crtc_state
;
622 /* Shut down everything that's in the changeset and currently
623 * still on. So need to check the old, saved state. */
624 if (!old_conn_state
->crtc
)
627 old_crtc_state
= old_state
->crtc_states
[drm_crtc_index(old_conn_state
->crtc
)];
629 if (!old_crtc_state
->active
||
630 !drm_atomic_crtc_needs_modeset(old_conn_state
->crtc
->state
))
633 encoder
= old_conn_state
->best_encoder
;
635 /* We shouldn't get this far if we didn't previously have
636 * an encoder.. but WARN_ON() rather than explode.
638 if (WARN_ON(!encoder
))
641 funcs
= encoder
->helper_private
;
643 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
644 encoder
->base
.id
, encoder
->name
);
647 * Each encoder has at most one connector (since we always steal
648 * it away), so we won't call disable hooks twice.
650 drm_bridge_disable(encoder
->bridge
);
652 /* Right function depends upon target state. */
653 if (connector
->state
->crtc
&& funcs
->prepare
)
654 funcs
->prepare(encoder
);
655 else if (funcs
->disable
)
656 funcs
->disable(encoder
);
658 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
660 drm_bridge_post_disable(encoder
->bridge
);
663 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
664 const struct drm_crtc_helper_funcs
*funcs
;
666 /* Shut down everything that needs a full modeset. */
667 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
670 if (!old_crtc_state
->active
)
673 funcs
= crtc
->helper_private
;
675 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
676 crtc
->base
.id
, crtc
->name
);
679 /* Right function depends upon target state. */
680 if (crtc
->state
->enable
&& funcs
->prepare
)
681 funcs
->prepare(crtc
);
682 else if (funcs
->disable
)
683 funcs
->disable(crtc
);
685 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
690 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
692 * @old_state: atomic state object with old state structures
694 * This function updates all the various legacy modeset state pointers in
695 * connectors, encoders and crtcs. It also updates the timestamping constants
696 * used for precise vblank timestamps by calling
697 * drm_calc_timestamping_constants().
699 * Drivers can use this for building their own atomic commit if they don't have
700 * a pure helper-based modeset implementation.
703 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
704 struct drm_atomic_state
*old_state
)
706 struct drm_connector
*connector
;
707 struct drm_connector_state
*old_conn_state
;
708 struct drm_crtc
*crtc
;
709 struct drm_crtc_state
*old_crtc_state
;
712 /* clear out existing links and update dpms */
713 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
714 if (connector
->encoder
) {
715 WARN_ON(!connector
->encoder
->crtc
);
717 connector
->encoder
->crtc
= NULL
;
718 connector
->encoder
= NULL
;
721 crtc
= connector
->state
->crtc
;
722 if ((!crtc
&& old_conn_state
->crtc
) ||
723 (crtc
&& drm_atomic_crtc_needs_modeset(crtc
->state
))) {
724 struct drm_property
*dpms_prop
=
725 dev
->mode_config
.dpms_property
;
726 int mode
= DRM_MODE_DPMS_OFF
;
728 if (crtc
&& crtc
->state
->active
)
729 mode
= DRM_MODE_DPMS_ON
;
731 connector
->dpms
= mode
;
732 drm_object_property_set_value(&connector
->base
,
738 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
739 if (!connector
->state
->crtc
)
742 if (WARN_ON(!connector
->state
->best_encoder
))
745 connector
->encoder
= connector
->state
->best_encoder
;
746 connector
->encoder
->crtc
= connector
->state
->crtc
;
749 /* set legacy state in the crtc structure */
750 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
751 struct drm_plane
*primary
= crtc
->primary
;
753 crtc
->mode
= crtc
->state
->mode
;
754 crtc
->enabled
= crtc
->state
->enable
;
756 if (drm_atomic_get_existing_plane_state(old_state
, primary
) &&
757 primary
->state
->crtc
== crtc
) {
758 crtc
->x
= primary
->state
->src_x
>> 16;
759 crtc
->y
= primary
->state
->src_y
>> 16;
762 if (crtc
->state
->enable
)
763 drm_calc_timestamping_constants(crtc
,
764 &crtc
->state
->adjusted_mode
);
767 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
770 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
772 struct drm_crtc
*crtc
;
773 struct drm_crtc_state
*old_crtc_state
;
774 struct drm_connector
*connector
;
775 struct drm_connector_state
*old_conn_state
;
778 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
779 const struct drm_crtc_helper_funcs
*funcs
;
781 if (!crtc
->state
->mode_changed
)
784 funcs
= crtc
->helper_private
;
786 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
787 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
788 crtc
->base
.id
, crtc
->name
);
790 funcs
->mode_set_nofb(crtc
);
794 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
795 const struct drm_encoder_helper_funcs
*funcs
;
796 struct drm_crtc_state
*new_crtc_state
;
797 struct drm_encoder
*encoder
;
798 struct drm_display_mode
*mode
, *adjusted_mode
;
800 if (!connector
->state
->best_encoder
)
803 encoder
= connector
->state
->best_encoder
;
804 funcs
= encoder
->helper_private
;
805 new_crtc_state
= connector
->state
->crtc
->state
;
806 mode
= &new_crtc_state
->mode
;
807 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
809 if (!new_crtc_state
->mode_changed
)
812 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
813 encoder
->base
.id
, encoder
->name
);
816 * Each encoder has at most one connector (since we always steal
817 * it away), so we won't call mode_set hooks twice.
820 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
822 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
827 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
829 * @old_state: atomic state object with old state structures
831 * This function shuts down all the outputs that need to be shut down and
832 * prepares them (if required) with the new mode.
834 * For compatibility with legacy crtc helpers this should be called before
835 * drm_atomic_helper_commit_planes(), which is what the default commit function
836 * does. But drivers with different needs can group the modeset commits together
837 * and do the plane commits at the end. This is useful for drivers doing runtime
838 * PM since planes updates then only happen when the CRTC is actually enabled.
840 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
841 struct drm_atomic_state
*old_state
)
843 disable_outputs(dev
, old_state
);
845 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
847 crtc_set_mode(dev
, old_state
);
849 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
852 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
854 * @old_state: atomic state object with old state structures
856 * This function enables all the outputs with the new configuration which had to
857 * be turned off for the update.
859 * For compatibility with legacy crtc helpers this should be called after
860 * drm_atomic_helper_commit_planes(), which is what the default commit function
861 * does. But drivers with different needs can group the modeset commits together
862 * and do the plane commits at the end. This is useful for drivers doing runtime
863 * PM since planes updates then only happen when the CRTC is actually enabled.
865 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
866 struct drm_atomic_state
*old_state
)
868 struct drm_crtc
*crtc
;
869 struct drm_crtc_state
*old_crtc_state
;
870 struct drm_connector
*connector
;
871 struct drm_connector_state
*old_conn_state
;
874 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
875 const struct drm_crtc_helper_funcs
*funcs
;
877 /* Need to filter out CRTCs where only planes change. */
878 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
881 if (!crtc
->state
->active
)
884 funcs
= crtc
->helper_private
;
886 if (crtc
->state
->enable
) {
887 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
888 crtc
->base
.id
, crtc
->name
);
897 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
898 const struct drm_encoder_helper_funcs
*funcs
;
899 struct drm_encoder
*encoder
;
901 if (!connector
->state
->best_encoder
)
904 if (!connector
->state
->crtc
->state
->active
||
905 !drm_atomic_crtc_needs_modeset(connector
->state
->crtc
->state
))
908 encoder
= connector
->state
->best_encoder
;
909 funcs
= encoder
->helper_private
;
911 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
912 encoder
->base
.id
, encoder
->name
);
915 * Each encoder has at most one connector (since we always steal
916 * it away), so we won't call enable hooks twice.
918 drm_bridge_pre_enable(encoder
->bridge
);
921 funcs
->enable(encoder
);
923 funcs
->commit(encoder
);
925 drm_bridge_enable(encoder
->bridge
);
928 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
930 static void wait_for_fences(struct drm_device
*dev
,
931 struct drm_atomic_state
*state
)
933 struct drm_plane
*plane
;
934 struct drm_plane_state
*plane_state
;
937 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
938 if (!plane
->state
->fence
)
941 WARN_ON(!plane
->state
->fb
);
943 fence_wait(plane
->state
->fence
, false);
944 fence_put(plane
->state
->fence
);
945 plane
->state
->fence
= NULL
;
949 static bool framebuffer_changed(struct drm_device
*dev
,
950 struct drm_atomic_state
*old_state
,
951 struct drm_crtc
*crtc
)
953 struct drm_plane
*plane
;
954 struct drm_plane_state
*old_plane_state
;
957 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
958 if (plane
->state
->crtc
!= crtc
&&
959 old_plane_state
->crtc
!= crtc
)
962 if (plane
->state
->fb
!= old_plane_state
->fb
)
970 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
972 * @old_state: atomic state object with old state structures
974 * Helper to, after atomic commit, wait for vblanks on all effected
975 * crtcs (ie. before cleaning up old framebuffers using
976 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
977 * framebuffers have actually changed to optimize for the legacy cursor and
978 * plane update use-case.
981 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
982 struct drm_atomic_state
*old_state
)
984 struct drm_crtc
*crtc
;
985 struct drm_crtc_state
*old_crtc_state
;
988 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
989 /* No one cares about the old state, so abuse it for tracking
990 * and store whether we hold a vblank reference (and should do a
991 * vblank wait) in the ->enable boolean. */
992 old_crtc_state
->enable
= false;
994 if (!crtc
->state
->enable
)
997 /* Legacy cursor ioctls are completely unsynced, and userspace
998 * relies on that (by doing tons of cursor updates). */
999 if (old_state
->legacy_cursor_update
)
1002 if (!framebuffer_changed(dev
, old_state
, crtc
))
1005 ret
= drm_crtc_vblank_get(crtc
);
1009 old_crtc_state
->enable
= true;
1010 old_crtc_state
->last_vblank_count
= drm_crtc_vblank_count(crtc
);
1013 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1014 if (!old_crtc_state
->enable
)
1017 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
1018 old_crtc_state
->last_vblank_count
!=
1019 drm_crtc_vblank_count(crtc
),
1020 msecs_to_jiffies(50));
1022 drm_crtc_vblank_put(crtc
);
1025 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
1028 * drm_atomic_helper_commit - commit validated state object
1030 * @state: the driver state object
1031 * @async: asynchronous commit
1033 * This function commits a with drm_atomic_helper_check() pre-validated state
1034 * object. This can still fail when e.g. the framebuffer reservation fails. For
1035 * now this doesn't implement asynchronous commits.
1037 * Note that right now this function does not support async commits, and hence
1038 * driver writers must implement their own version for now. Also note that the
1039 * default ordering of how the various stages are called is to match the legacy
1040 * modeset helper library closest. One peculiarity of that is that it doesn't
1041 * mesh well with runtime PM at all.
1043 * For drivers supporting runtime PM the recommended sequence is
1045 * drm_atomic_helper_commit_modeset_disables(dev, state);
1047 * drm_atomic_helper_commit_modeset_enables(dev, state);
1049 * drm_atomic_helper_commit_planes(dev, state, true);
1051 * See the kerneldoc entries for these three functions for more details.
1054 * Zero for success or -errno.
1056 int drm_atomic_helper_commit(struct drm_device
*dev
,
1057 struct drm_atomic_state
*state
,
1065 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
1070 * This is the point of no return - everything below never fails except
1071 * when the hw goes bonghits. Which means we can commit the new state on
1072 * the software side now.
1075 drm_atomic_helper_swap_state(dev
, state
);
1078 * Everything below can be run asynchronously without the need to grab
1079 * any modeset locks at all under one condition: It must be guaranteed
1080 * that the asynchronous work has either been cancelled (if the driver
1081 * supports it, which at least requires that the framebuffers get
1082 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1083 * before the new state gets committed on the software side with
1084 * drm_atomic_helper_swap_state().
1086 * This scheme allows new atomic state updates to be prepared and
1087 * checked in parallel to the asynchronous completion of the previous
1088 * update. Which is important since compositors need to figure out the
1089 * composition of the next frame right after having submitted the
1093 wait_for_fences(dev
, state
);
1095 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1097 drm_atomic_helper_commit_planes(dev
, state
, false);
1099 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1101 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1103 drm_atomic_helper_cleanup_planes(dev
, state
);
1105 drm_atomic_state_free(state
);
1109 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1112 * DOC: implementing async commit
1114 * For now the atomic helpers don't support async commit directly. If there is
1115 * real need it could be added though, using the dma-buf fence infrastructure
1116 * for generic synchronization with outstanding rendering.
1118 * For now drivers have to implement async commit themselves, with the following
1119 * sequence being the recommended one:
1121 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1122 * which commit needs to call which can fail, so we want to run it first and
1125 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1126 * might be affected the new state update. This can be done by either cancelling
1127 * or flushing the work items, depending upon whether the driver can deal with
1128 * cancelled updates. Note that it is important to ensure that the framebuffer
1129 * cleanup is still done when cancelling.
1131 * For sufficient parallelism it is recommended to have a work item per crtc
1132 * (for updates which don't touch global state) and a global one. Then we only
1133 * need to synchronize with the crtc work items for changed crtcs and the global
1134 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1136 * 3. The software state is updated synchronously with
1137 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1138 * locks means concurrent callers never see inconsistent state. And doing this
1139 * while it's guaranteed that no relevant async worker runs means that async
1140 * workers do not need grab any locks. Actually they must not grab locks, for
1141 * otherwise the work flushing will deadlock.
1143 * 4. Schedule a work item to do all subsequent steps, using the split-out
1144 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1145 * then cleaning up the framebuffers after the old framebuffer is no longer
1150 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1152 * @state: atomic state object with new state structures
1154 * This function prepares plane state, specifically framebuffers, for the new
1155 * configuration. If any failure is encountered this function will call
1156 * ->cleanup_fb on any already successfully prepared framebuffer.
1159 * 0 on success, negative error code on failure.
1161 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1162 struct drm_atomic_state
*state
)
1164 int nplanes
= dev
->mode_config
.num_total_plane
;
1167 for (i
= 0; i
< nplanes
; i
++) {
1168 const struct drm_plane_helper_funcs
*funcs
;
1169 struct drm_plane
*plane
= state
->planes
[i
];
1170 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1175 funcs
= plane
->helper_private
;
1177 if (funcs
->prepare_fb
) {
1178 ret
= funcs
->prepare_fb(plane
, plane_state
);
1187 for (i
--; i
>= 0; i
--) {
1188 const struct drm_plane_helper_funcs
*funcs
;
1189 struct drm_plane
*plane
= state
->planes
[i
];
1190 struct drm_plane_state
*plane_state
= state
->plane_states
[i
];
1195 funcs
= plane
->helper_private
;
1197 if (funcs
->cleanup_fb
)
1198 funcs
->cleanup_fb(plane
, plane_state
);
1204 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1206 bool plane_crtc_active(struct drm_plane_state
*state
)
1208 return state
->crtc
&& state
->crtc
->state
->active
;
1212 * drm_atomic_helper_commit_planes - commit plane state
1214 * @old_state: atomic state object with old state structures
1215 * @active_only: Only commit on active CRTC if set
1217 * This function commits the new plane state using the plane and atomic helper
1218 * functions for planes and crtcs. It assumes that the atomic state has already
1219 * been pushed into the relevant object state pointers, since this step can no
1222 * It still requires the global state object @old_state to know which planes and
1223 * crtcs need to be updated though.
1225 * Note that this function does all plane updates across all CRTCs in one step.
1226 * If the hardware can't support this approach look at
1227 * drm_atomic_helper_commit_planes_on_crtc() instead.
1229 * Plane parameters can be updated by applications while the associated CRTC is
1230 * disabled. The DRM/KMS core will store the parameters in the plane state,
1231 * which will be available to the driver when the CRTC is turned on. As a result
1232 * most drivers don't need to be immediately notified of plane updates for a
1235 * Unless otherwise needed, drivers are advised to set the @active_only
1236 * parameters to true in order not to receive plane update notifications related
1237 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1238 * driver code when the driver and/or hardware can't or just don't need to deal
1239 * with updates on disabled CRTCs, for example when supporting runtime PM.
1241 * The drm_atomic_helper_commit() default implementation only sets @active_only
1242 * to false to most closely match the behaviour of the legacy helpers. This should
1243 * not be copied blindly by drivers.
1245 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1246 struct drm_atomic_state
*old_state
,
1249 struct drm_crtc
*crtc
;
1250 struct drm_crtc_state
*old_crtc_state
;
1251 struct drm_plane
*plane
;
1252 struct drm_plane_state
*old_plane_state
;
1255 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1256 const struct drm_crtc_helper_funcs
*funcs
;
1258 funcs
= crtc
->helper_private
;
1260 if (!funcs
|| !funcs
->atomic_begin
)
1263 if (active_only
&& !crtc
->state
->active
)
1266 funcs
->atomic_begin(crtc
, old_crtc_state
);
1269 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1270 const struct drm_plane_helper_funcs
*funcs
;
1273 funcs
= plane
->helper_private
;
1278 disabling
= drm_atomic_plane_disabling(plane
, old_plane_state
);
1282 * Skip planes related to inactive CRTCs. If the plane
1283 * is enabled use the state of the current CRTC. If the
1284 * plane is being disabled use the state of the old
1285 * CRTC to avoid skipping planes being disabled on an
1288 if (!disabling
&& !plane_crtc_active(plane
->state
))
1290 if (disabling
&& !plane_crtc_active(old_plane_state
))
1295 * Special-case disabling the plane if drivers support it.
1297 if (disabling
&& funcs
->atomic_disable
)
1298 funcs
->atomic_disable(plane
, old_plane_state
);
1299 else if (plane
->state
->crtc
|| disabling
)
1300 funcs
->atomic_update(plane
, old_plane_state
);
1303 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1304 const struct drm_crtc_helper_funcs
*funcs
;
1306 funcs
= crtc
->helper_private
;
1308 if (!funcs
|| !funcs
->atomic_flush
)
1311 if (active_only
&& !crtc
->state
->active
)
1314 funcs
->atomic_flush(crtc
, old_crtc_state
);
1317 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1320 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1321 * @old_crtc_state: atomic state object with the old crtc state
1323 * This function commits the new plane state using the plane and atomic helper
1324 * functions for planes on the specific crtc. It assumes that the atomic state
1325 * has already been pushed into the relevant object state pointers, since this
1326 * step can no longer fail.
1328 * This function is useful when plane updates should be done crtc-by-crtc
1329 * instead of one global step like drm_atomic_helper_commit_planes() does.
1331 * This function can only be savely used when planes are not allowed to move
1332 * between different CRTCs because this function doesn't handle inter-CRTC
1333 * depencies. Callers need to ensure that either no such depencies exist,
1334 * resolve them through ordering of commit calls or through some other means.
1337 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1339 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1340 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1341 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1342 struct drm_plane
*plane
;
1343 unsigned plane_mask
;
1345 plane_mask
= old_crtc_state
->plane_mask
;
1346 plane_mask
|= crtc
->state
->plane_mask
;
1348 crtc_funcs
= crtc
->helper_private
;
1349 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1350 crtc_funcs
->atomic_begin(crtc
, old_crtc_state
);
1352 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1353 struct drm_plane_state
*old_plane_state
=
1354 drm_atomic_get_existing_plane_state(old_state
, plane
);
1355 const struct drm_plane_helper_funcs
*plane_funcs
;
1357 plane_funcs
= plane
->helper_private
;
1359 if (!old_plane_state
|| !plane_funcs
)
1362 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1364 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1365 plane_funcs
->atomic_disable
)
1366 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1367 else if (plane
->state
->crtc
||
1368 drm_atomic_plane_disabling(plane
, old_plane_state
))
1369 plane_funcs
->atomic_update(plane
, old_plane_state
);
1372 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1373 crtc_funcs
->atomic_flush(crtc
, old_crtc_state
);
1375 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1378 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1380 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1382 * Disables all planes associated with the given CRTC. This can be
1383 * used for instance in the CRTC helper disable callback to disable
1384 * all planes before shutting down the display pipeline.
1386 * If the atomic-parameter is set the function calls the CRTC's
1387 * atomic_begin hook before and atomic_flush hook after disabling the
1390 * It is a bug to call this function without having implemented the
1391 * ->atomic_disable() plane hook.
1393 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc
*crtc
,
1396 const struct drm_crtc_helper_funcs
*crtc_funcs
=
1397 crtc
->helper_private
;
1398 struct drm_plane
*plane
;
1400 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_begin
)
1401 crtc_funcs
->atomic_begin(crtc
, NULL
);
1403 drm_for_each_plane(plane
, crtc
->dev
) {
1404 const struct drm_plane_helper_funcs
*plane_funcs
=
1405 plane
->helper_private
;
1407 if (plane
->state
->crtc
!= crtc
|| !plane_funcs
)
1410 WARN_ON(!plane_funcs
->atomic_disable
);
1411 if (plane_funcs
->atomic_disable
)
1412 plane_funcs
->atomic_disable(plane
, NULL
);
1415 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_flush
)
1416 crtc_funcs
->atomic_flush(crtc
, NULL
);
1418 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc
);
1421 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1423 * @old_state: atomic state object with old state structures
1425 * This function cleans up plane state, specifically framebuffers, from the old
1426 * configuration. Hence the old configuration must be perserved in @old_state to
1427 * be able to call this function.
1429 * This function must also be called on the new state when the atomic update
1430 * fails at any point after calling drm_atomic_helper_prepare_planes().
1432 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1433 struct drm_atomic_state
*old_state
)
1435 struct drm_plane
*plane
;
1436 struct drm_plane_state
*plane_state
;
1439 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1440 const struct drm_plane_helper_funcs
*funcs
;
1442 funcs
= plane
->helper_private
;
1444 if (funcs
->cleanup_fb
)
1445 funcs
->cleanup_fb(plane
, plane_state
);
1448 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1451 * drm_atomic_helper_swap_state - store atomic state into current sw state
1453 * @state: atomic state
1455 * This function stores the atomic state into the current state pointers in all
1456 * driver objects. It should be called after all failing steps have been done
1457 * and succeeded, but before the actual hardware state is committed.
1459 * For cleanup and error recovery the current state for all changed objects will
1460 * be swaped into @state.
1462 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1464 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1466 * 2. Do any other steps that might fail.
1468 * 3. Put the staged state into the current state pointers with this function.
1470 * 4. Actually commit the hardware state.
1472 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1473 * contains the old state. Also do any other cleanup required with that state.
1475 void drm_atomic_helper_swap_state(struct drm_device
*dev
,
1476 struct drm_atomic_state
*state
)
1480 for (i
= 0; i
< dev
->mode_config
.num_connector
; i
++) {
1481 struct drm_connector
*connector
= state
->connectors
[i
];
1486 connector
->state
->state
= state
;
1487 swap(state
->connector_states
[i
], connector
->state
);
1488 connector
->state
->state
= NULL
;
1491 for (i
= 0; i
< dev
->mode_config
.num_crtc
; i
++) {
1492 struct drm_crtc
*crtc
= state
->crtcs
[i
];
1497 crtc
->state
->state
= state
;
1498 swap(state
->crtc_states
[i
], crtc
->state
);
1499 crtc
->state
->state
= NULL
;
1502 for (i
= 0; i
< dev
->mode_config
.num_total_plane
; i
++) {
1503 struct drm_plane
*plane
= state
->planes
[i
];
1508 plane
->state
->state
= state
;
1509 swap(state
->plane_states
[i
], plane
->state
);
1510 plane
->state
->state
= NULL
;
1513 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
1516 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1517 * @plane: plane object to update
1518 * @crtc: owning CRTC of owning plane
1519 * @fb: framebuffer to flip onto plane
1520 * @crtc_x: x offset of primary plane on crtc
1521 * @crtc_y: y offset of primary plane on crtc
1522 * @crtc_w: width of primary plane rectangle on crtc
1523 * @crtc_h: height of primary plane rectangle on crtc
1524 * @src_x: x offset of @fb for panning
1525 * @src_y: y offset of @fb for panning
1526 * @src_w: width of source rectangle in @fb
1527 * @src_h: height of source rectangle in @fb
1529 * Provides a default plane update handler using the atomic driver interface.
1532 * Zero on success, error code on failure
1534 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
1535 struct drm_crtc
*crtc
,
1536 struct drm_framebuffer
*fb
,
1537 int crtc_x
, int crtc_y
,
1538 unsigned int crtc_w
, unsigned int crtc_h
,
1539 uint32_t src_x
, uint32_t src_y
,
1540 uint32_t src_w
, uint32_t src_h
)
1542 struct drm_atomic_state
*state
;
1543 struct drm_plane_state
*plane_state
;
1546 state
= drm_atomic_state_alloc(plane
->dev
);
1550 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1552 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1553 if (IS_ERR(plane_state
)) {
1554 ret
= PTR_ERR(plane_state
);
1558 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
1561 drm_atomic_set_fb_for_plane(plane_state
, fb
);
1562 plane_state
->crtc_x
= crtc_x
;
1563 plane_state
->crtc_y
= crtc_y
;
1564 plane_state
->crtc_w
= crtc_w
;
1565 plane_state
->crtc_h
= crtc_h
;
1566 plane_state
->src_x
= src_x
;
1567 plane_state
->src_y
= src_y
;
1568 plane_state
->src_w
= src_w
;
1569 plane_state
->src_h
= src_h
;
1571 if (plane
== crtc
->cursor
)
1572 state
->legacy_cursor_update
= true;
1574 ret
= drm_atomic_commit(state
);
1578 /* Driver takes ownership of state on successful commit. */
1581 if (ret
== -EDEADLK
)
1584 drm_atomic_state_free(state
);
1588 drm_atomic_state_clear(state
);
1589 drm_atomic_legacy_backoff(state
);
1592 * Someone might have exchanged the framebuffer while we dropped locks
1593 * in the backoff code. We need to fix up the fb refcount tracking the
1596 plane
->old_fb
= plane
->fb
;
1600 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
1603 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1604 * @plane: plane to disable
1606 * Provides a default plane disable handler using the atomic driver interface.
1609 * Zero on success, error code on failure
1611 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
1613 struct drm_atomic_state
*state
;
1614 struct drm_plane_state
*plane_state
;
1618 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1619 * acquire context. The real fix will be to wire the acquire ctx through
1620 * everywhere we need it, but meanwhile prevent chaos by just skipping
1621 * this noop. The critical case is the cursor ioctls which a) only grab
1622 * crtc/cursor-plane locks (so we need the crtc to get at the right
1623 * acquire context) and b) can try to disable the plane multiple times.
1628 state
= drm_atomic_state_alloc(plane
->dev
);
1632 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
1634 plane_state
= drm_atomic_get_plane_state(state
, plane
);
1635 if (IS_ERR(plane_state
)) {
1636 ret
= PTR_ERR(plane_state
);
1640 if (plane_state
->crtc
&& (plane
== plane
->crtc
->cursor
))
1641 plane_state
->state
->legacy_cursor_update
= true;
1643 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
1647 ret
= drm_atomic_commit(state
);
1651 /* Driver takes ownership of state on successful commit. */
1654 if (ret
== -EDEADLK
)
1657 drm_atomic_state_free(state
);
1661 drm_atomic_state_clear(state
);
1662 drm_atomic_legacy_backoff(state
);
1665 * Someone might have exchanged the framebuffer while we dropped locks
1666 * in the backoff code. We need to fix up the fb refcount tracking the
1669 plane
->old_fb
= plane
->fb
;
1673 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
1675 /* just used from fb-helper and atomic-helper: */
1676 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
1677 struct drm_plane_state
*plane_state
)
1681 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
1685 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
1686 plane_state
->crtc_x
= 0;
1687 plane_state
->crtc_y
= 0;
1688 plane_state
->crtc_w
= 0;
1689 plane_state
->crtc_h
= 0;
1690 plane_state
->src_x
= 0;
1691 plane_state
->src_y
= 0;
1692 plane_state
->src_w
= 0;
1693 plane_state
->src_h
= 0;
1698 static int update_output_state(struct drm_atomic_state
*state
,
1699 struct drm_mode_set
*set
)
1701 struct drm_device
*dev
= set
->crtc
->dev
;
1702 struct drm_crtc
*crtc
;
1703 struct drm_crtc_state
*crtc_state
;
1704 struct drm_connector
*connector
;
1705 struct drm_connector_state
*conn_state
;
1708 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
1709 state
->acquire_ctx
);
1713 /* First grab all affected connector/crtc states. */
1714 for (i
= 0; i
< set
->num_connectors
; i
++) {
1715 conn_state
= drm_atomic_get_connector_state(state
,
1716 set
->connectors
[i
]);
1717 if (IS_ERR(conn_state
))
1718 return PTR_ERR(conn_state
);
1721 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1722 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
1727 /* Then recompute connector->crtc links and crtc enabling state. */
1728 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
1729 if (conn_state
->crtc
== set
->crtc
) {
1730 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1736 for (j
= 0; j
< set
->num_connectors
; j
++) {
1737 if (set
->connectors
[j
] == connector
) {
1738 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
1747 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1748 /* Don't update ->enable for the CRTC in the set_config request,
1749 * since a mismatch would indicate a bug in the upper layers.
1750 * The actual modeset code later on will catch any
1751 * inconsistencies here. */
1752 if (crtc
== set
->crtc
)
1755 if (!crtc_state
->connector_mask
) {
1756 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
1761 crtc_state
->active
= false;
1769 * drm_atomic_helper_set_config - set a new config from userspace
1770 * @set: mode set configuration
1772 * Provides a default crtc set_config handler using the atomic driver interface.
1775 * Returns 0 on success, negative errno numbers on failure.
1777 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
1779 struct drm_atomic_state
*state
;
1780 struct drm_crtc
*crtc
= set
->crtc
;
1783 state
= drm_atomic_state_alloc(crtc
->dev
);
1787 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
1789 ret
= __drm_atomic_helper_set_config(set
, state
);
1793 ret
= drm_atomic_commit(state
);
1797 /* Driver takes ownership of state on successful commit. */
1800 if (ret
== -EDEADLK
)
1803 drm_atomic_state_free(state
);
1807 drm_atomic_state_clear(state
);
1808 drm_atomic_legacy_backoff(state
);
1811 * Someone might have exchanged the framebuffer while we dropped locks
1812 * in the backoff code. We need to fix up the fb refcount tracking the
1815 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
1819 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
1821 /* just used from fb-helper and atomic-helper: */
1822 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
1823 struct drm_atomic_state
*state
)
1825 struct drm_crtc_state
*crtc_state
;
1826 struct drm_plane_state
*primary_state
;
1827 struct drm_crtc
*crtc
= set
->crtc
;
1828 int hdisplay
, vdisplay
;
1831 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1832 if (IS_ERR(crtc_state
))
1833 return PTR_ERR(crtc_state
);
1835 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
1836 if (IS_ERR(primary_state
))
1837 return PTR_ERR(primary_state
);
1841 WARN_ON(set
->num_connectors
);
1843 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
1847 crtc_state
->active
= false;
1849 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
1853 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
1859 WARN_ON(!set
->num_connectors
);
1861 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
1865 crtc_state
->active
= true;
1867 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
1871 drm_crtc_get_hv_timing(set
->mode
, &hdisplay
, &vdisplay
);
1873 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
1874 primary_state
->crtc_x
= 0;
1875 primary_state
->crtc_y
= 0;
1876 primary_state
->crtc_w
= hdisplay
;
1877 primary_state
->crtc_h
= vdisplay
;
1878 primary_state
->src_x
= set
->x
<< 16;
1879 primary_state
->src_y
= set
->y
<< 16;
1880 if (primary_state
->rotation
& (BIT(DRM_ROTATE_90
) | BIT(DRM_ROTATE_270
))) {
1881 primary_state
->src_w
= vdisplay
<< 16;
1882 primary_state
->src_h
= hdisplay
<< 16;
1884 primary_state
->src_w
= hdisplay
<< 16;
1885 primary_state
->src_h
= vdisplay
<< 16;
1889 ret
= update_output_state(state
, set
);
1897 * drm_atomic_helper_disable_all - disable all currently active outputs
1899 * @ctx: lock acquisition context
1901 * Loops through all connectors, finding those that aren't turned off and then
1902 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1903 * that they are connected to.
1905 * This is used for example in suspend/resume to disable all currently active
1906 * functions when suspending.
1908 * Note that if callers haven't already acquired all modeset locks this might
1909 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1912 * 0 on success or a negative error code on failure.
1915 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1917 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
1918 struct drm_modeset_acquire_ctx
*ctx
)
1920 struct drm_atomic_state
*state
;
1921 struct drm_connector
*conn
;
1924 state
= drm_atomic_state_alloc(dev
);
1928 state
->acquire_ctx
= ctx
;
1930 drm_for_each_connector(conn
, dev
) {
1931 struct drm_crtc
*crtc
= conn
->state
->crtc
;
1932 struct drm_crtc_state
*crtc_state
;
1934 if (!crtc
|| conn
->dpms
!= DRM_MODE_DPMS_ON
)
1937 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1938 if (IS_ERR(crtc_state
)) {
1939 err
= PTR_ERR(crtc_state
);
1943 crtc_state
->active
= false;
1946 err
= drm_atomic_commit(state
);
1950 drm_atomic_state_free(state
);
1954 EXPORT_SYMBOL(drm_atomic_helper_disable_all
);
1957 * drm_atomic_helper_suspend - subsystem-level suspend helper
1960 * Duplicates the current atomic state, disables all active outputs and then
1961 * returns a pointer to the original atomic state to the caller. Drivers can
1962 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
1963 * restore the output configuration that was active at the time the system
1966 * Note that it is potentially unsafe to use this. The atomic state object
1967 * returned by this function is assumed to be persistent. Drivers must ensure
1968 * that this holds true. Before calling this function, drivers must make sure
1969 * to suspend fbdev emulation so that nothing can be using the device.
1972 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
1973 * encoded error code on failure. Drivers should store the returned atomic
1974 * state object and pass it to the drm_atomic_helper_resume() helper upon
1978 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
1979 * drm_atomic_helper_resume()
1981 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
)
1983 struct drm_modeset_acquire_ctx ctx
;
1984 struct drm_atomic_state
*state
;
1987 drm_modeset_acquire_init(&ctx
, 0);
1990 err
= drm_modeset_lock_all_ctx(dev
, &ctx
);
1992 state
= ERR_PTR(err
);
1996 state
= drm_atomic_helper_duplicate_state(dev
, &ctx
);
2000 err
= drm_atomic_helper_disable_all(dev
, &ctx
);
2002 drm_atomic_state_free(state
);
2003 state
= ERR_PTR(err
);
2008 if (PTR_ERR(state
) == -EDEADLK
) {
2009 drm_modeset_backoff(&ctx
);
2013 drm_modeset_drop_locks(&ctx
);
2014 drm_modeset_acquire_fini(&ctx
);
2017 EXPORT_SYMBOL(drm_atomic_helper_suspend
);
2020 * drm_atomic_helper_resume - subsystem-level resume helper
2022 * @state: atomic state to resume to
2024 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2025 * grabs all modeset locks and commits the atomic state object. This can be
2026 * used in conjunction with the drm_atomic_helper_suspend() helper to
2027 * implement suspend/resume for drivers that support atomic mode-setting.
2030 * 0 on success or a negative error code on failure.
2033 * drm_atomic_helper_suspend()
2035 int drm_atomic_helper_resume(struct drm_device
*dev
,
2036 struct drm_atomic_state
*state
)
2038 struct drm_mode_config
*config
= &dev
->mode_config
;
2041 drm_mode_config_reset(dev
);
2042 drm_modeset_lock_all(dev
);
2043 state
->acquire_ctx
= config
->acquire_ctx
;
2044 err
= drm_atomic_commit(state
);
2045 drm_modeset_unlock_all(dev
);
2049 EXPORT_SYMBOL(drm_atomic_helper_resume
);
2052 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2054 * @property: DRM property
2055 * @val: value of property
2057 * Provides a default crtc set_property handler using the atomic driver
2061 * Zero on success, error code on failure
2064 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
2065 struct drm_property
*property
,
2068 struct drm_atomic_state
*state
;
2069 struct drm_crtc_state
*crtc_state
;
2072 state
= drm_atomic_state_alloc(crtc
->dev
);
2076 /* ->set_property is always called with all locks held. */
2077 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2079 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2080 if (IS_ERR(crtc_state
)) {
2081 ret
= PTR_ERR(crtc_state
);
2085 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2090 ret
= drm_atomic_commit(state
);
2094 /* Driver takes ownership of state on successful commit. */
2097 if (ret
== -EDEADLK
)
2100 drm_atomic_state_free(state
);
2104 drm_atomic_state_clear(state
);
2105 drm_atomic_legacy_backoff(state
);
2109 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
2112 * drm_atomic_helper_plane_set_property - helper for plane properties
2114 * @property: DRM property
2115 * @val: value of property
2117 * Provides a default plane set_property handler using the atomic driver
2121 * Zero on success, error code on failure
2124 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
2125 struct drm_property
*property
,
2128 struct drm_atomic_state
*state
;
2129 struct drm_plane_state
*plane_state
;
2132 state
= drm_atomic_state_alloc(plane
->dev
);
2136 /* ->set_property is always called with all locks held. */
2137 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
2139 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2140 if (IS_ERR(plane_state
)) {
2141 ret
= PTR_ERR(plane_state
);
2145 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
2150 ret
= drm_atomic_commit(state
);
2154 /* Driver takes ownership of state on successful commit. */
2157 if (ret
== -EDEADLK
)
2160 drm_atomic_state_free(state
);
2164 drm_atomic_state_clear(state
);
2165 drm_atomic_legacy_backoff(state
);
2169 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
2172 * drm_atomic_helper_connector_set_property - helper for connector properties
2173 * @connector: DRM connector
2174 * @property: DRM property
2175 * @val: value of property
2177 * Provides a default connector set_property handler using the atomic driver
2181 * Zero on success, error code on failure
2184 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
2185 struct drm_property
*property
,
2188 struct drm_atomic_state
*state
;
2189 struct drm_connector_state
*connector_state
;
2192 state
= drm_atomic_state_alloc(connector
->dev
);
2196 /* ->set_property is always called with all locks held. */
2197 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
2199 connector_state
= drm_atomic_get_connector_state(state
, connector
);
2200 if (IS_ERR(connector_state
)) {
2201 ret
= PTR_ERR(connector_state
);
2205 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
2210 ret
= drm_atomic_commit(state
);
2214 /* Driver takes ownership of state on successful commit. */
2217 if (ret
== -EDEADLK
)
2220 drm_atomic_state_free(state
);
2224 drm_atomic_state_clear(state
);
2225 drm_atomic_legacy_backoff(state
);
2229 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
2232 * drm_atomic_helper_page_flip - execute a legacy page flip
2234 * @fb: DRM framebuffer
2235 * @event: optional DRM event to signal upon completion
2236 * @flags: flip flags for non-vblank sync'ed updates
2238 * Provides a default page flip implementation using the atomic driver interface.
2240 * Note that for now so called async page flips (i.e. updates which are not
2241 * synchronized to vblank) are not supported, since the atomic interfaces have
2242 * no provisions for this yet.
2245 * Returns 0 on success, negative errno numbers on failure.
2247 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
2248 struct drm_framebuffer
*fb
,
2249 struct drm_pending_vblank_event
*event
,
2252 struct drm_plane
*plane
= crtc
->primary
;
2253 struct drm_atomic_state
*state
;
2254 struct drm_plane_state
*plane_state
;
2255 struct drm_crtc_state
*crtc_state
;
2258 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
2261 state
= drm_atomic_state_alloc(plane
->dev
);
2265 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2267 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2268 if (IS_ERR(crtc_state
)) {
2269 ret
= PTR_ERR(crtc_state
);
2272 crtc_state
->event
= event
;
2274 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2275 if (IS_ERR(plane_state
)) {
2276 ret
= PTR_ERR(plane_state
);
2280 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2283 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2285 /* Make sure we don't accidentally do a full modeset. */
2286 state
->allow_modeset
= false;
2287 if (!crtc_state
->active
) {
2288 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2294 ret
= drm_atomic_async_commit(state
);
2298 /* Driver takes ownership of state on successful async commit. */
2301 if (ret
== -EDEADLK
)
2304 drm_atomic_state_free(state
);
2308 drm_atomic_state_clear(state
);
2309 drm_atomic_legacy_backoff(state
);
2312 * Someone might have exchanged the framebuffer while we dropped locks
2313 * in the backoff code. We need to fix up the fb refcount tracking the
2316 plane
->old_fb
= plane
->fb
;
2320 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
2323 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2324 * @connector: affected connector
2327 * This is the main helper function provided by the atomic helper framework for
2328 * implementing the legacy DPMS connector interface. It computes the new desired
2329 * ->active state for the corresponding CRTC (if the connector is enabled) and
2333 * Returns 0 on success, negative errno numbers on failure.
2335 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
2338 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
2339 struct drm_atomic_state
*state
;
2340 struct drm_crtc_state
*crtc_state
;
2341 struct drm_crtc
*crtc
;
2342 struct drm_connector
*tmp_connector
;
2344 bool active
= false;
2345 int old_mode
= connector
->dpms
;
2347 if (mode
!= DRM_MODE_DPMS_ON
)
2348 mode
= DRM_MODE_DPMS_OFF
;
2350 connector
->dpms
= mode
;
2351 crtc
= connector
->state
->crtc
;
2356 state
= drm_atomic_state_alloc(connector
->dev
);
2360 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2362 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2363 if (IS_ERR(crtc_state
)) {
2364 ret
= PTR_ERR(crtc_state
);
2368 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
2370 drm_for_each_connector(tmp_connector
, connector
->dev
) {
2371 if (tmp_connector
->state
->crtc
!= crtc
)
2374 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2379 crtc_state
->active
= active
;
2381 ret
= drm_atomic_commit(state
);
2385 /* Driver takes ownership of state on successful commit. */
2388 if (ret
== -EDEADLK
)
2391 connector
->dpms
= old_mode
;
2392 drm_atomic_state_free(state
);
2396 drm_atomic_state_clear(state
);
2397 drm_atomic_legacy_backoff(state
);
2401 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2404 * DOC: atomic state reset and initialization
2406 * Both the drm core and the atomic helpers assume that there is always the full
2407 * and correct atomic software state for all connectors, CRTCs and planes
2408 * available. Which is a bit a problem on driver load and also after system
2409 * suspend. One way to solve this is to have a hardware state read-out
2410 * infrastructure which reconstructs the full software state (e.g. the i915
2413 * The simpler solution is to just reset the software state to everything off,
2414 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2415 * the atomic helpers provide default reset implementations for all hooks.
2417 * On the upside the precise state tracking of atomic simplifies system suspend
2418 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2419 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2420 * For other drivers the building blocks are split out, see the documentation
2421 * for these functions.
2425 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2428 * Resets the atomic state for @crtc by freeing the state pointer (which might
2429 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2431 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2434 drm_property_unreference_blob(crtc
->state
->mode_blob
);
2436 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2439 crtc
->state
->crtc
= crtc
;
2441 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2444 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2445 * @crtc: CRTC object
2446 * @state: atomic CRTC state
2448 * Copies atomic state from a CRTC's current state and resets inferred values.
2449 * This is useful for drivers that subclass the CRTC state.
2451 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2452 struct drm_crtc_state
*state
)
2454 memcpy(state
, crtc
->state
, sizeof(*state
));
2456 if (state
->mode_blob
)
2457 drm_property_reference_blob(state
->mode_blob
);
2458 state
->mode_changed
= false;
2459 state
->active_changed
= false;
2460 state
->planes_changed
= false;
2461 state
->connectors_changed
= false;
2462 state
->event
= NULL
;
2464 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
2467 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2470 * Default CRTC state duplicate hook for drivers which don't have their own
2471 * subclassed CRTC state structure.
2473 struct drm_crtc_state
*
2474 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
2476 struct drm_crtc_state
*state
;
2478 if (WARN_ON(!crtc
->state
))
2481 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2483 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
2487 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
2490 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2491 * @crtc: CRTC object
2492 * @state: CRTC state object to release
2494 * Releases all resources stored in the CRTC state without actually freeing
2495 * the memory of the CRTC state. This is useful for drivers that subclass the
2498 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2499 struct drm_crtc_state
*state
)
2501 drm_property_unreference_blob(state
->mode_blob
);
2503 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
2506 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2508 * @state: CRTC state object to release
2510 * Default CRTC state destroy hook for drivers which don't have their own
2511 * subclassed CRTC state structure.
2513 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
2514 struct drm_crtc_state
*state
)
2516 __drm_atomic_helper_crtc_destroy_state(crtc
, state
);
2519 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
2522 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2525 * Resets the atomic state for @plane by freeing the state pointer (which might
2526 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2528 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
2530 if (plane
->state
&& plane
->state
->fb
)
2531 drm_framebuffer_unreference(plane
->state
->fb
);
2533 kfree(plane
->state
);
2534 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
2537 plane
->state
->plane
= plane
;
2539 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
2542 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2543 * @plane: plane object
2544 * @state: atomic plane state
2546 * Copies atomic state from a plane's current state. This is useful for
2547 * drivers that subclass the plane state.
2549 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
2550 struct drm_plane_state
*state
)
2552 memcpy(state
, plane
->state
, sizeof(*state
));
2555 drm_framebuffer_reference(state
->fb
);
2557 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
2560 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2563 * Default plane state duplicate hook for drivers which don't have their own
2564 * subclassed plane state structure.
2566 struct drm_plane_state
*
2567 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
2569 struct drm_plane_state
*state
;
2571 if (WARN_ON(!plane
->state
))
2574 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2576 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
2580 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
2583 * __drm_atomic_helper_plane_destroy_state - release plane state
2584 * @plane: plane object
2585 * @state: plane state object to release
2587 * Releases all resources stored in the plane state without actually freeing
2588 * the memory of the plane state. This is useful for drivers that subclass the
2591 void __drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2592 struct drm_plane_state
*state
)
2595 drm_framebuffer_unreference(state
->fb
);
2597 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
2600 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2602 * @state: plane state object to release
2604 * Default plane state destroy hook for drivers which don't have their own
2605 * subclassed plane state structure.
2607 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
2608 struct drm_plane_state
*state
)
2610 __drm_atomic_helper_plane_destroy_state(plane
, state
);
2613 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
2616 * __drm_atomic_helper_connector_reset - reset state on connector
2617 * @connector: drm connector
2618 * @conn_state: connector state to assign
2620 * Initializes the newly allocated @conn_state and assigns it to
2621 * #connector ->state, usually required when initializing the drivers
2622 * or when called from the ->reset hook.
2624 * This is useful for drivers that subclass the connector state.
2627 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
2628 struct drm_connector_state
*conn_state
)
2631 conn_state
->connector
= connector
;
2633 connector
->state
= conn_state
;
2635 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
2638 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2639 * @connector: drm connector
2641 * Resets the atomic state for @connector by freeing the state pointer (which
2642 * might be NULL, e.g. at driver load time) and allocating a new empty state
2645 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
2647 struct drm_connector_state
*conn_state
=
2648 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
2650 kfree(connector
->state
);
2651 __drm_atomic_helper_connector_reset(connector
, conn_state
);
2653 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
2656 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2657 * @connector: connector object
2658 * @state: atomic connector state
2660 * Copies atomic state from a connector's current state. This is useful for
2661 * drivers that subclass the connector state.
2664 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
2665 struct drm_connector_state
*state
)
2667 memcpy(state
, connector
->state
, sizeof(*state
));
2669 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
2672 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2673 * @connector: drm connector
2675 * Default connector state duplicate hook for drivers which don't have their own
2676 * subclassed connector state structure.
2678 struct drm_connector_state
*
2679 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
2681 struct drm_connector_state
*state
;
2683 if (WARN_ON(!connector
->state
))
2686 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2688 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
2692 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
2695 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2697 * @ctx: lock acquisition context
2699 * Makes a copy of the current atomic state by looping over all objects and
2700 * duplicating their respective states. This is used for example by suspend/
2701 * resume support code to save the state prior to suspend such that it can
2702 * be restored upon resume.
2704 * Note that this treats atomic state as persistent between save and restore.
2705 * Drivers must make sure that this is possible and won't result in confusion
2706 * or erroneous behaviour.
2708 * Note that if callers haven't already acquired all modeset locks this might
2709 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2712 * A pointer to the copy of the atomic state object on success or an
2713 * ERR_PTR()-encoded error code on failure.
2716 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2718 struct drm_atomic_state
*
2719 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
2720 struct drm_modeset_acquire_ctx
*ctx
)
2722 struct drm_atomic_state
*state
;
2723 struct drm_connector
*conn
;
2724 struct drm_plane
*plane
;
2725 struct drm_crtc
*crtc
;
2728 state
= drm_atomic_state_alloc(dev
);
2730 return ERR_PTR(-ENOMEM
);
2732 state
->acquire_ctx
= ctx
;
2734 drm_for_each_crtc(crtc
, dev
) {
2735 struct drm_crtc_state
*crtc_state
;
2737 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2738 if (IS_ERR(crtc_state
)) {
2739 err
= PTR_ERR(crtc_state
);
2744 drm_for_each_plane(plane
, dev
) {
2745 struct drm_plane_state
*plane_state
;
2747 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2748 if (IS_ERR(plane_state
)) {
2749 err
= PTR_ERR(plane_state
);
2754 drm_for_each_connector(conn
, dev
) {
2755 struct drm_connector_state
*conn_state
;
2757 conn_state
= drm_atomic_get_connector_state(state
, conn
);
2758 if (IS_ERR(conn_state
)) {
2759 err
= PTR_ERR(conn_state
);
2764 /* clear the acquire context so that it isn't accidentally reused */
2765 state
->acquire_ctx
= NULL
;
2769 drm_atomic_state_free(state
);
2770 state
= ERR_PTR(err
);
2775 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state
);
2778 * __drm_atomic_helper_connector_destroy_state - release connector state
2779 * @connector: connector object
2780 * @state: connector state object to release
2782 * Releases all resources stored in the connector state without actually
2783 * freeing the memory of the connector state. This is useful for drivers that
2784 * subclass the connector state.
2787 __drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2788 struct drm_connector_state
*state
)
2791 * This is currently a placeholder so that drivers that subclass the
2792 * state will automatically do the right thing if code is ever added
2796 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
2799 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2800 * @connector: drm connector
2801 * @state: connector state object to release
2803 * Default connector state destroy hook for drivers which don't have their own
2804 * subclassed connector state structure.
2806 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
2807 struct drm_connector_state
*state
)
2809 __drm_atomic_helper_connector_destroy_state(connector
, state
);
2812 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);