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>
35 #include "drm_crtc_internal.h"
40 * This helper library provides implementations of check and commit functions on
41 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
42 * also provides convenience implementations for the atomic state handling
43 * callbacks for drivers which don't need to subclass the drm core structures to
44 * add their own additional internal state.
46 * This library also provides default implementations for the check callback in
47 * drm_atomic_helper_check() and for the commit callback with
48 * drm_atomic_helper_commit(). But the individual stages and callbacks are
49 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
50 * together with a driver private modeset implementation.
52 * This library also provides implementations for all the legacy driver
53 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
54 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
55 * various functions to implement set_property callbacks. New drivers must not
56 * implement these functions themselves but must use the provided helpers.
58 * The atomic helper uses the same function table structures as all other
59 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
60 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
61 * also shares the struct &drm_plane_helper_funcs function table with the plane
65 drm_atomic_helper_plane_changed(struct drm_atomic_state
*state
,
66 struct drm_plane_state
*plane_state
,
67 struct drm_plane
*plane
)
69 struct drm_crtc_state
*crtc_state
;
71 if (plane
->state
->crtc
) {
72 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
75 if (WARN_ON(!crtc_state
))
78 crtc_state
->planes_changed
= true;
81 if (plane_state
->crtc
) {
82 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
85 if (WARN_ON(!crtc_state
))
88 crtc_state
->planes_changed
= true;
92 static int handle_conflicting_encoders(struct drm_atomic_state
*state
,
93 bool disable_conflicting_encoders
)
95 struct drm_connector_state
*conn_state
;
96 struct drm_connector
*connector
;
97 struct drm_encoder
*encoder
;
98 unsigned encoder_mask
= 0;
102 * First loop, find all newly assigned encoders from the connectors
103 * part of the state. If the same encoder is assigned to multiple
104 * connectors bail out.
106 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
107 const struct drm_connector_helper_funcs
*funcs
= connector
->helper_private
;
108 struct drm_encoder
*new_encoder
;
110 if (!conn_state
->crtc
)
113 if (funcs
->atomic_best_encoder
)
114 new_encoder
= funcs
->atomic_best_encoder(connector
, conn_state
);
115 else if (funcs
->best_encoder
)
116 new_encoder
= funcs
->best_encoder(connector
);
118 new_encoder
= drm_atomic_helper_best_encoder(connector
);
121 if (encoder_mask
& (1 << drm_encoder_index(new_encoder
))) {
122 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
123 new_encoder
->base
.id
, new_encoder
->name
,
124 connector
->base
.id
, connector
->name
);
129 encoder_mask
|= 1 << drm_encoder_index(new_encoder
);
137 * Second loop, iterate over all connectors not part of the state.
139 * If a conflicting encoder is found and disable_conflicting_encoders
140 * is not set, an error is returned. Userspace can provide a solution
141 * through the atomic ioctl.
143 * If the flag is set conflicting connectors are removed from the crtc
144 * and the crtc is disabled if no encoder is left. This preserves
145 * compatibility with the legacy set_config behavior.
147 drm_for_each_connector(connector
, state
->dev
) {
148 struct drm_crtc_state
*crtc_state
;
150 if (drm_atomic_get_existing_connector_state(state
, connector
))
153 encoder
= connector
->state
->best_encoder
;
154 if (!encoder
|| !(encoder_mask
& (1 << drm_encoder_index(encoder
))))
157 if (!disable_conflicting_encoders
) {
158 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
159 encoder
->base
.id
, encoder
->name
,
160 connector
->state
->crtc
->base
.id
,
161 connector
->state
->crtc
->name
,
162 connector
->base
.id
, connector
->name
);
166 conn_state
= drm_atomic_get_connector_state(state
, connector
);
167 if (IS_ERR(conn_state
))
168 return PTR_ERR(conn_state
);
170 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
171 encoder
->base
.id
, encoder
->name
,
172 conn_state
->crtc
->base
.id
, conn_state
->crtc
->name
,
173 connector
->base
.id
, connector
->name
);
175 crtc_state
= drm_atomic_get_existing_crtc_state(state
, conn_state
->crtc
);
177 ret
= drm_atomic_set_crtc_for_connector(conn_state
, NULL
);
181 if (!crtc_state
->connector_mask
) {
182 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
187 crtc_state
->active
= false;
195 set_best_encoder(struct drm_atomic_state
*state
,
196 struct drm_connector_state
*conn_state
,
197 struct drm_encoder
*encoder
)
199 struct drm_crtc_state
*crtc_state
;
200 struct drm_crtc
*crtc
;
202 if (conn_state
->best_encoder
) {
203 /* Unset the encoder_mask in the old crtc state. */
204 crtc
= conn_state
->connector
->state
->crtc
;
206 /* A NULL crtc is an error here because we should have
207 * duplicated a NULL best_encoder when crtc was NULL.
208 * As an exception restoring duplicated atomic state
209 * during resume is allowed, so don't warn when
210 * best_encoder is equal to encoder we intend to set.
212 WARN_ON(!crtc
&& encoder
!= conn_state
->best_encoder
);
214 crtc_state
= drm_atomic_get_existing_crtc_state(state
, crtc
);
216 crtc_state
->encoder_mask
&=
217 ~(1 << drm_encoder_index(conn_state
->best_encoder
));
222 crtc
= conn_state
->crtc
;
225 crtc_state
= drm_atomic_get_existing_crtc_state(state
, crtc
);
227 crtc_state
->encoder_mask
|=
228 1 << drm_encoder_index(encoder
);
232 conn_state
->best_encoder
= encoder
;
236 steal_encoder(struct drm_atomic_state
*state
,
237 struct drm_encoder
*encoder
)
239 struct drm_crtc_state
*crtc_state
;
240 struct drm_connector
*connector
;
241 struct drm_connector_state
*connector_state
;
244 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
245 struct drm_crtc
*encoder_crtc
;
247 if (connector_state
->best_encoder
!= encoder
)
250 encoder_crtc
= connector
->state
->crtc
;
252 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
253 encoder
->base
.id
, encoder
->name
,
254 encoder_crtc
->base
.id
, encoder_crtc
->name
);
256 set_best_encoder(state
, connector_state
, NULL
);
258 crtc_state
= drm_atomic_get_existing_crtc_state(state
, encoder_crtc
);
259 crtc_state
->connectors_changed
= true;
266 update_connector_routing(struct drm_atomic_state
*state
,
267 struct drm_connector
*connector
,
268 struct drm_connector_state
*connector_state
)
270 const struct drm_connector_helper_funcs
*funcs
;
271 struct drm_encoder
*new_encoder
;
272 struct drm_crtc_state
*crtc_state
;
274 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
278 if (connector
->state
->crtc
!= connector_state
->crtc
) {
279 if (connector
->state
->crtc
) {
280 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector
->state
->crtc
);
281 crtc_state
->connectors_changed
= true;
284 if (connector_state
->crtc
) {
285 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector_state
->crtc
);
286 crtc_state
->connectors_changed
= true;
290 if (!connector_state
->crtc
) {
291 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
295 set_best_encoder(state
, connector_state
, NULL
);
300 funcs
= connector
->helper_private
;
302 if (funcs
->atomic_best_encoder
)
303 new_encoder
= funcs
->atomic_best_encoder(connector
,
305 else if (funcs
->best_encoder
)
306 new_encoder
= funcs
->best_encoder(connector
);
308 new_encoder
= drm_atomic_helper_best_encoder(connector
);
311 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
317 if (!drm_encoder_crtc_ok(new_encoder
, connector_state
->crtc
)) {
318 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
319 new_encoder
->base
.id
,
321 connector_state
->crtc
->base
.id
);
325 if (new_encoder
== connector_state
->best_encoder
) {
326 set_best_encoder(state
, connector_state
, new_encoder
);
328 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
331 new_encoder
->base
.id
,
333 connector_state
->crtc
->base
.id
,
334 connector_state
->crtc
->name
);
339 steal_encoder(state
, new_encoder
);
341 set_best_encoder(state
, connector_state
, new_encoder
);
343 crtc_state
= drm_atomic_get_existing_crtc_state(state
, connector_state
->crtc
);
344 crtc_state
->connectors_changed
= true;
346 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
349 new_encoder
->base
.id
,
351 connector_state
->crtc
->base
.id
,
352 connector_state
->crtc
->name
);
358 mode_fixup(struct drm_atomic_state
*state
)
360 struct drm_crtc
*crtc
;
361 struct drm_crtc_state
*crtc_state
;
362 struct drm_connector
*connector
;
363 struct drm_connector_state
*conn_state
;
367 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
368 if (!crtc_state
->mode_changed
&&
369 !crtc_state
->connectors_changed
)
372 drm_mode_copy(&crtc_state
->adjusted_mode
, &crtc_state
->mode
);
375 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
376 const struct drm_encoder_helper_funcs
*funcs
;
377 struct drm_encoder
*encoder
;
379 WARN_ON(!!conn_state
->best_encoder
!= !!conn_state
->crtc
);
381 if (!conn_state
->crtc
|| !conn_state
->best_encoder
)
384 crtc_state
= drm_atomic_get_existing_crtc_state(state
,
388 * Each encoder has at most one connector (since we always steal
389 * it away), so we won't call ->mode_fixup twice.
391 encoder
= conn_state
->best_encoder
;
392 funcs
= encoder
->helper_private
;
394 ret
= drm_bridge_mode_fixup(encoder
->bridge
, &crtc_state
->mode
,
395 &crtc_state
->adjusted_mode
);
397 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
401 if (funcs
&& funcs
->atomic_check
) {
402 ret
= funcs
->atomic_check(encoder
, crtc_state
,
405 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
406 encoder
->base
.id
, encoder
->name
);
409 } else if (funcs
&& funcs
->mode_fixup
) {
410 ret
= funcs
->mode_fixup(encoder
, &crtc_state
->mode
,
411 &crtc_state
->adjusted_mode
);
413 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
414 encoder
->base
.id
, encoder
->name
);
420 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
421 const struct drm_crtc_helper_funcs
*funcs
;
423 if (!crtc_state
->enable
)
426 if (!crtc_state
->mode_changed
&&
427 !crtc_state
->connectors_changed
)
430 funcs
= crtc
->helper_private
;
431 if (!funcs
->mode_fixup
)
434 ret
= funcs
->mode_fixup(crtc
, &crtc_state
->mode
,
435 &crtc_state
->adjusted_mode
);
437 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
438 crtc
->base
.id
, crtc
->name
);
447 * drm_atomic_helper_check_modeset - validate state object for modeset changes
449 * @state: the driver state object
451 * Check the state object to see if the requested state is physically possible.
452 * This does all the crtc and connector related computations for an atomic
453 * update and adds any additional connectors needed for full modesets and calls
454 * down into ->mode_fixup functions of the driver backend.
456 * crtc_state->mode_changed is set when the input mode is changed.
457 * crtc_state->connectors_changed is set when a connector is added or
458 * removed from the crtc.
459 * crtc_state->active_changed is set when crtc_state->active changes,
460 * which is used for dpms.
464 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
465 * plane update can't be done without a full modeset) _must_ call this function
466 * afterwards after that change. It is permitted to call this function multiple
467 * times for the same update, e.g. when the ->atomic_check functions depend upon
468 * the adjusted dotclock for fifo space allocation and watermark computation.
471 * Zero for success or -errno
474 drm_atomic_helper_check_modeset(struct drm_device
*dev
,
475 struct drm_atomic_state
*state
)
477 struct drm_crtc
*crtc
;
478 struct drm_crtc_state
*crtc_state
;
479 struct drm_connector
*connector
;
480 struct drm_connector_state
*connector_state
;
483 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
484 if (!drm_mode_equal(&crtc
->state
->mode
, &crtc_state
->mode
)) {
485 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
486 crtc
->base
.id
, crtc
->name
);
487 crtc_state
->mode_changed
= true;
490 if (crtc
->state
->enable
!= crtc_state
->enable
) {
491 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
492 crtc
->base
.id
, crtc
->name
);
495 * For clarity this assignment is done here, but
496 * enable == 0 is only true when there are no
497 * connectors and a NULL mode.
499 * The other way around is true as well. enable != 0
500 * iff connectors are attached and a mode is set.
502 crtc_state
->mode_changed
= true;
503 crtc_state
->connectors_changed
= true;
507 ret
= handle_conflicting_encoders(state
, state
->legacy_set_config
);
511 for_each_connector_in_state(state
, connector
, connector_state
, i
) {
513 * This only sets crtc->mode_changed for routing changes,
514 * drivers must set crtc->mode_changed themselves when connector
515 * properties need to be updated.
517 ret
= update_connector_routing(state
, connector
,
524 * After all the routing has been prepared we need to add in any
525 * connector which is itself unchanged, but who's crtc changes it's
526 * configuration. This must be done before calling mode_fixup in case a
527 * crtc only changed its mode but has the same set of connectors.
529 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
530 bool has_connectors
=
531 !!crtc_state
->connector_mask
;
534 * We must set ->active_changed after walking connectors for
535 * otherwise an update that only changes active would result in
536 * a full modeset because update_connector_routing force that.
538 if (crtc
->state
->active
!= crtc_state
->active
) {
539 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
540 crtc
->base
.id
, crtc
->name
);
541 crtc_state
->active_changed
= true;
544 if (!drm_atomic_crtc_needs_modeset(crtc_state
))
547 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
548 crtc
->base
.id
, crtc
->name
,
549 crtc_state
->enable
? 'y' : 'n',
550 crtc_state
->active
? 'y' : 'n');
552 ret
= drm_atomic_add_affected_connectors(state
, crtc
);
556 ret
= drm_atomic_add_affected_planes(state
, crtc
);
560 if (crtc_state
->enable
!= has_connectors
) {
561 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
562 crtc
->base
.id
, crtc
->name
);
568 return mode_fixup(state
);
570 EXPORT_SYMBOL(drm_atomic_helper_check_modeset
);
573 * drm_atomic_helper_check_planes - validate state object for planes changes
575 * @state: the driver state object
577 * Check the state object to see if the requested state is physically possible.
578 * This does all the plane update related checks using by calling into the
579 * ->atomic_check hooks provided by the driver.
581 * It also sets crtc_state->planes_changed to indicate that a crtc has
585 * Zero for success or -errno
588 drm_atomic_helper_check_planes(struct drm_device
*dev
,
589 struct drm_atomic_state
*state
)
591 struct drm_crtc
*crtc
;
592 struct drm_crtc_state
*crtc_state
;
593 struct drm_plane
*plane
;
594 struct drm_plane_state
*plane_state
;
597 ret
= drm_atomic_normalize_zpos(dev
, state
);
601 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
602 const struct drm_plane_helper_funcs
*funcs
;
604 funcs
= plane
->helper_private
;
606 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
608 if (!funcs
|| !funcs
->atomic_check
)
611 ret
= funcs
->atomic_check(plane
, plane_state
);
613 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
614 plane
->base
.id
, plane
->name
);
619 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
620 const struct drm_crtc_helper_funcs
*funcs
;
622 funcs
= crtc
->helper_private
;
624 if (!funcs
|| !funcs
->atomic_check
)
627 ret
= funcs
->atomic_check(crtc
, crtc_state
);
629 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
630 crtc
->base
.id
, crtc
->name
);
637 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
640 * drm_atomic_helper_check - validate state object
642 * @state: the driver state object
644 * Check the state object to see if the requested state is physically possible.
645 * Only crtcs and planes have check callbacks, so for any additional (global)
646 * checking that a driver needs it can simply wrap that around this function.
647 * Drivers without such needs can directly use this as their ->atomic_check()
650 * This just wraps the two parts of the state checking for planes and modeset
651 * state in the default order: First it calls drm_atomic_helper_check_modeset()
652 * and then drm_atomic_helper_check_planes(). The assumption is that the
653 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
654 * e.g. properly compute watermarks.
657 * Zero for success or -errno
659 int drm_atomic_helper_check(struct drm_device
*dev
,
660 struct drm_atomic_state
*state
)
664 ret
= drm_atomic_helper_check_modeset(dev
, state
);
668 ret
= drm_atomic_helper_check_planes(dev
, state
);
674 EXPORT_SYMBOL(drm_atomic_helper_check
);
677 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
679 struct drm_connector
*connector
;
680 struct drm_connector_state
*old_conn_state
;
681 struct drm_crtc
*crtc
;
682 struct drm_crtc_state
*old_crtc_state
;
685 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
686 const struct drm_encoder_helper_funcs
*funcs
;
687 struct drm_encoder
*encoder
;
689 /* Shut down everything that's in the changeset and currently
690 * still on. So need to check the old, saved state. */
691 if (!old_conn_state
->crtc
)
694 old_crtc_state
= drm_atomic_get_existing_crtc_state(old_state
,
695 old_conn_state
->crtc
);
697 if (!old_crtc_state
->active
||
698 !drm_atomic_crtc_needs_modeset(old_conn_state
->crtc
->state
))
701 encoder
= old_conn_state
->best_encoder
;
703 /* We shouldn't get this far if we didn't previously have
704 * an encoder.. but WARN_ON() rather than explode.
706 if (WARN_ON(!encoder
))
709 funcs
= encoder
->helper_private
;
711 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
712 encoder
->base
.id
, encoder
->name
);
715 * Each encoder has at most one connector (since we always steal
716 * it away), so we won't call disable hooks twice.
718 drm_bridge_disable(encoder
->bridge
);
720 /* Right function depends upon target state. */
722 if (connector
->state
->crtc
&& funcs
->prepare
)
723 funcs
->prepare(encoder
);
724 else if (funcs
->disable
)
725 funcs
->disable(encoder
);
726 else if (funcs
->dpms
)
727 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
730 drm_bridge_post_disable(encoder
->bridge
);
733 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
734 const struct drm_crtc_helper_funcs
*funcs
;
736 /* Shut down everything that needs a full modeset. */
737 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
740 if (!old_crtc_state
->active
)
743 funcs
= crtc
->helper_private
;
745 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
746 crtc
->base
.id
, crtc
->name
);
749 /* Right function depends upon target state. */
750 if (crtc
->state
->enable
&& funcs
->prepare
)
751 funcs
->prepare(crtc
);
752 else if (funcs
->atomic_disable
)
753 funcs
->atomic_disable(crtc
, old_crtc_state
);
754 else if (funcs
->disable
)
755 funcs
->disable(crtc
);
757 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
762 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
764 * @old_state: atomic state object with old state structures
766 * This function updates all the various legacy modeset state pointers in
767 * connectors, encoders and crtcs. It also updates the timestamping constants
768 * used for precise vblank timestamps by calling
769 * drm_calc_timestamping_constants().
771 * Drivers can use this for building their own atomic commit if they don't have
772 * a pure helper-based modeset implementation.
775 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
776 struct drm_atomic_state
*old_state
)
778 struct drm_connector
*connector
;
779 struct drm_connector_state
*old_conn_state
;
780 struct drm_crtc
*crtc
;
781 struct drm_crtc_state
*old_crtc_state
;
784 /* clear out existing links and update dpms */
785 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
786 if (connector
->encoder
) {
787 WARN_ON(!connector
->encoder
->crtc
);
789 connector
->encoder
->crtc
= NULL
;
790 connector
->encoder
= NULL
;
793 crtc
= connector
->state
->crtc
;
794 if ((!crtc
&& old_conn_state
->crtc
) ||
795 (crtc
&& drm_atomic_crtc_needs_modeset(crtc
->state
))) {
796 struct drm_property
*dpms_prop
=
797 dev
->mode_config
.dpms_property
;
798 int mode
= DRM_MODE_DPMS_OFF
;
800 if (crtc
&& crtc
->state
->active
)
801 mode
= DRM_MODE_DPMS_ON
;
803 connector
->dpms
= mode
;
804 drm_object_property_set_value(&connector
->base
,
810 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
811 if (!connector
->state
->crtc
)
814 if (WARN_ON(!connector
->state
->best_encoder
))
817 connector
->encoder
= connector
->state
->best_encoder
;
818 connector
->encoder
->crtc
= connector
->state
->crtc
;
821 /* set legacy state in the crtc structure */
822 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
823 struct drm_plane
*primary
= crtc
->primary
;
825 crtc
->mode
= crtc
->state
->mode
;
826 crtc
->enabled
= crtc
->state
->enable
;
828 if (drm_atomic_get_existing_plane_state(old_state
, primary
) &&
829 primary
->state
->crtc
== crtc
) {
830 crtc
->x
= primary
->state
->src_x
>> 16;
831 crtc
->y
= primary
->state
->src_y
>> 16;
834 if (crtc
->state
->enable
)
835 drm_calc_timestamping_constants(crtc
,
836 &crtc
->state
->adjusted_mode
);
839 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
842 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
844 struct drm_crtc
*crtc
;
845 struct drm_crtc_state
*old_crtc_state
;
846 struct drm_connector
*connector
;
847 struct drm_connector_state
*old_conn_state
;
850 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
851 const struct drm_crtc_helper_funcs
*funcs
;
853 if (!crtc
->state
->mode_changed
)
856 funcs
= crtc
->helper_private
;
858 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
859 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
860 crtc
->base
.id
, crtc
->name
);
862 funcs
->mode_set_nofb(crtc
);
866 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
867 const struct drm_encoder_helper_funcs
*funcs
;
868 struct drm_crtc_state
*new_crtc_state
;
869 struct drm_encoder
*encoder
;
870 struct drm_display_mode
*mode
, *adjusted_mode
;
872 if (!connector
->state
->best_encoder
)
875 encoder
= connector
->state
->best_encoder
;
876 funcs
= encoder
->helper_private
;
877 new_crtc_state
= connector
->state
->crtc
->state
;
878 mode
= &new_crtc_state
->mode
;
879 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
881 if (!new_crtc_state
->mode_changed
)
884 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
885 encoder
->base
.id
, encoder
->name
);
888 * Each encoder has at most one connector (since we always steal
889 * it away), so we won't call mode_set hooks twice.
891 if (funcs
&& funcs
->atomic_mode_set
) {
892 funcs
->atomic_mode_set(encoder
, new_crtc_state
,
894 } else if (funcs
&& funcs
->mode_set
) {
895 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
898 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
903 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
905 * @old_state: atomic state object with old state structures
907 * This function shuts down all the outputs that need to be shut down and
908 * prepares them (if required) with the new mode.
910 * For compatibility with legacy crtc helpers this should be called before
911 * drm_atomic_helper_commit_planes(), which is what the default commit function
912 * does. But drivers with different needs can group the modeset commits together
913 * and do the plane commits at the end. This is useful for drivers doing runtime
914 * PM since planes updates then only happen when the CRTC is actually enabled.
916 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
917 struct drm_atomic_state
*old_state
)
919 disable_outputs(dev
, old_state
);
921 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
923 crtc_set_mode(dev
, old_state
);
925 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
928 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
930 * @old_state: atomic state object with old state structures
932 * This function enables all the outputs with the new configuration which had to
933 * be turned off for the update.
935 * For compatibility with legacy crtc helpers this should be called after
936 * drm_atomic_helper_commit_planes(), which is what the default commit function
937 * does. But drivers with different needs can group the modeset commits together
938 * and do the plane commits at the end. This is useful for drivers doing runtime
939 * PM since planes updates then only happen when the CRTC is actually enabled.
941 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
942 struct drm_atomic_state
*old_state
)
944 struct drm_crtc
*crtc
;
945 struct drm_crtc_state
*old_crtc_state
;
946 struct drm_connector
*connector
;
947 struct drm_connector_state
*old_conn_state
;
950 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
951 const struct drm_crtc_helper_funcs
*funcs
;
953 /* Need to filter out CRTCs where only planes change. */
954 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
957 if (!crtc
->state
->active
)
960 funcs
= crtc
->helper_private
;
962 if (crtc
->state
->enable
) {
963 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
964 crtc
->base
.id
, crtc
->name
);
973 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
974 const struct drm_encoder_helper_funcs
*funcs
;
975 struct drm_encoder
*encoder
;
977 if (!connector
->state
->best_encoder
)
980 if (!connector
->state
->crtc
->state
->active
||
981 !drm_atomic_crtc_needs_modeset(connector
->state
->crtc
->state
))
984 encoder
= connector
->state
->best_encoder
;
985 funcs
= encoder
->helper_private
;
987 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
988 encoder
->base
.id
, encoder
->name
);
991 * Each encoder has at most one connector (since we always steal
992 * it away), so we won't call enable hooks twice.
994 drm_bridge_pre_enable(encoder
->bridge
);
998 funcs
->enable(encoder
);
999 else if (funcs
->commit
)
1000 funcs
->commit(encoder
);
1003 drm_bridge_enable(encoder
->bridge
);
1006 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
1009 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1011 * @state: atomic state object with old state structures
1013 * For implicit sync, driver should fish the exclusive fence out from the
1014 * incoming fb's and stash it in the drm_plane_state. This is called after
1015 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1016 * just uses the atomic state to find the changed planes)
1018 void drm_atomic_helper_wait_for_fences(struct drm_device
*dev
,
1019 struct drm_atomic_state
*state
)
1021 struct drm_plane
*plane
;
1022 struct drm_plane_state
*plane_state
;
1025 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1026 if (!plane
->state
->fence
)
1029 WARN_ON(!plane
->state
->fb
);
1031 fence_wait(plane
->state
->fence
, false);
1032 fence_put(plane
->state
->fence
);
1033 plane
->state
->fence
= NULL
;
1036 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences
);
1039 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1041 * @old_state: atomic state object with old state structures
1044 * Checks whether the framebuffer used for this CRTC changes as a result of
1045 * the atomic update. This is useful for drivers which cannot use
1046 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1050 * true if the framebuffer changed.
1052 bool drm_atomic_helper_framebuffer_changed(struct drm_device
*dev
,
1053 struct drm_atomic_state
*old_state
,
1054 struct drm_crtc
*crtc
)
1056 struct drm_plane
*plane
;
1057 struct drm_plane_state
*old_plane_state
;
1060 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1061 if (plane
->state
->crtc
!= crtc
&&
1062 old_plane_state
->crtc
!= crtc
)
1065 if (plane
->state
->fb
!= old_plane_state
->fb
)
1071 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed
);
1074 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1076 * @old_state: atomic state object with old state structures
1078 * Helper to, after atomic commit, wait for vblanks on all effected
1079 * crtcs (ie. before cleaning up old framebuffers using
1080 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1081 * framebuffers have actually changed to optimize for the legacy cursor and
1082 * plane update use-case.
1085 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
1086 struct drm_atomic_state
*old_state
)
1088 struct drm_crtc
*crtc
;
1089 struct drm_crtc_state
*old_crtc_state
;
1092 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1093 /* No one cares about the old state, so abuse it for tracking
1094 * and store whether we hold a vblank reference (and should do a
1095 * vblank wait) in the ->enable boolean. */
1096 old_crtc_state
->enable
= false;
1098 if (!crtc
->state
->enable
)
1101 /* Legacy cursor ioctls are completely unsynced, and userspace
1102 * relies on that (by doing tons of cursor updates). */
1103 if (old_state
->legacy_cursor_update
)
1106 if (!drm_atomic_helper_framebuffer_changed(dev
,
1110 ret
= drm_crtc_vblank_get(crtc
);
1114 old_crtc_state
->enable
= true;
1115 old_crtc_state
->last_vblank_count
= drm_crtc_vblank_count(crtc
);
1118 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1119 if (!old_crtc_state
->enable
)
1122 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
1123 old_crtc_state
->last_vblank_count
!=
1124 drm_crtc_vblank_count(crtc
),
1125 msecs_to_jiffies(50));
1127 WARN(!ret
, "[CRTC:%d] vblank wait timed out\n", crtc
->base
.id
);
1129 drm_crtc_vblank_put(crtc
);
1132 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
1135 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1136 * @state: new modeset state to be committed
1138 * This is the default implemenation for the ->atomic_commit_tail() hook of the
1139 * &drm_mode_config_helper_funcs vtable.
1141 * Note that the default ordering of how the various stages are called is to
1142 * match the legacy modeset helper library closest. One peculiarity of that is
1143 * that it doesn't mesh well with runtime PM at all.
1145 * For drivers supporting runtime PM the recommended sequence is instead ::
1147 * drm_atomic_helper_commit_modeset_disables(dev, state);
1149 * drm_atomic_helper_commit_modeset_enables(dev, state);
1151 * drm_atomic_helper_commit_planes(dev, state,
1152 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
1154 * for committing the atomic update to hardware. See the kerneldoc entries for
1155 * these three functions for more details.
1157 void drm_atomic_helper_commit_tail(struct drm_atomic_state
*state
)
1159 struct drm_device
*dev
= state
->dev
;
1161 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1163 drm_atomic_helper_commit_planes(dev
, state
, 0);
1165 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1167 drm_atomic_helper_commit_hw_done(state
);
1169 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1171 drm_atomic_helper_cleanup_planes(dev
, state
);
1173 EXPORT_SYMBOL(drm_atomic_helper_commit_tail
);
1175 static void commit_tail(struct drm_atomic_state
*state
)
1177 struct drm_device
*dev
= state
->dev
;
1178 struct drm_mode_config_helper_funcs
*funcs
;
1180 funcs
= dev
->mode_config
.helper_private
;
1182 drm_atomic_helper_wait_for_fences(dev
, state
);
1184 drm_atomic_helper_wait_for_dependencies(state
);
1186 if (funcs
&& funcs
->atomic_commit_tail
)
1187 funcs
->atomic_commit_tail(state
);
1189 drm_atomic_helper_commit_tail(state
);
1191 drm_atomic_helper_commit_cleanup_done(state
);
1193 drm_atomic_state_free(state
);
1196 static void commit_work(struct work_struct
*work
)
1198 struct drm_atomic_state
*state
= container_of(work
,
1199 struct drm_atomic_state
,
1205 * drm_atomic_helper_commit - commit validated state object
1207 * @state: the driver state object
1208 * @nonblock: whether nonblocking behavior is requested.
1210 * This function commits a with drm_atomic_helper_check() pre-validated state
1211 * object. This can still fail when e.g. the framebuffer reservation fails. This
1212 * function implements nonblocking commits, using
1213 * drm_atomic_helper_setup_commit() and related functions.
1215 * Note that right now this function does not support nonblocking commits, hence
1216 * driver writers must implement their own version for now.
1218 * Committing the actual hardware state is done through the
1219 * ->atomic_commit_tail() callback of the &drm_mode_config_helper_funcs vtable,
1220 * or it's default implementation drm_atomic_helper_commit_tail().
1223 * Zero for success or -errno.
1225 int drm_atomic_helper_commit(struct drm_device
*dev
,
1226 struct drm_atomic_state
*state
,
1231 ret
= drm_atomic_helper_setup_commit(state
, nonblock
);
1235 INIT_WORK(&state
->commit_work
, commit_work
);
1237 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
1242 * This is the point of no return - everything below never fails except
1243 * when the hw goes bonghits. Which means we can commit the new state on
1244 * the software side now.
1247 drm_atomic_helper_swap_state(state
, true);
1250 * Everything below can be run asynchronously without the need to grab
1251 * any modeset locks at all under one condition: It must be guaranteed
1252 * that the asynchronous work has either been cancelled (if the driver
1253 * supports it, which at least requires that the framebuffers get
1254 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1255 * before the new state gets committed on the software side with
1256 * drm_atomic_helper_swap_state().
1258 * This scheme allows new atomic state updates to be prepared and
1259 * checked in parallel to the asynchronous completion of the previous
1260 * update. Which is important since compositors need to figure out the
1261 * composition of the next frame right after having submitted the
1264 * NOTE: Commit work has multiple phases, first hardware commit, then
1265 * cleanup. We want them to overlap, hence need system_unbound_wq to
1266 * make sure work items don't artifically stall on each another.
1270 queue_work(system_unbound_wq
, &state
->commit_work
);
1276 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1279 * DOC: implementing nonblocking commit
1281 * Nonblocking atomic commits have to be implemented in the following sequence:
1283 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1284 * which commit needs to call which can fail, so we want to run it first and
1287 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1288 * might be affected the new state update. This can be done by either cancelling
1289 * or flushing the work items, depending upon whether the driver can deal with
1290 * cancelled updates. Note that it is important to ensure that the framebuffer
1291 * cleanup is still done when cancelling.
1293 * Asynchronous workers need to have sufficient parallelism to be able to run
1294 * different atomic commits on different CRTCs in parallel. The simplest way to
1295 * achive this is by running them on the &system_unbound_wq work queue. Note
1296 * that drivers are not required to split up atomic commits and run an
1297 * individual commit in parallel - userspace is supposed to do that if it cares.
1298 * But it might be beneficial to do that for modesets, since those necessarily
1299 * must be done as one global operation, and enabling or disabling a CRTC can
1300 * take a long time. But even that is not required.
1302 * 3. The software state is updated synchronously with
1303 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1304 * locks means concurrent callers never see inconsistent state. And doing this
1305 * while it's guaranteed that no relevant nonblocking worker runs means that
1306 * nonblocking workers do not need grab any locks. Actually they must not grab
1307 * locks, for otherwise the work flushing will deadlock.
1309 * 4. Schedule a work item to do all subsequent steps, using the split-out
1310 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1311 * then cleaning up the framebuffers after the old framebuffer is no longer
1314 * The above scheme is implemented in the atomic helper libraries in
1315 * drm_atomic_helper_commit() using a bunch of helper functions. See
1316 * drm_atomic_helper_setup_commit() for a starting point.
1319 static int stall_checks(struct drm_crtc
*crtc
, bool nonblock
)
1321 struct drm_crtc_commit
*commit
, *stall_commit
= NULL
;
1322 bool completed
= true;
1326 spin_lock(&crtc
->commit_lock
);
1328 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1330 completed
= try_wait_for_completion(&commit
->flip_done
);
1331 /* Userspace is not allowed to get ahead of the previous
1332 * commit with nonblocking ones. */
1333 if (!completed
&& nonblock
) {
1334 spin_unlock(&crtc
->commit_lock
);
1337 } else if (i
== 1) {
1338 stall_commit
= commit
;
1339 drm_crtc_commit_get(stall_commit
);
1345 spin_unlock(&crtc
->commit_lock
);
1350 /* We don't want to let commits get ahead of cleanup work too much,
1351 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1353 ret
= wait_for_completion_interruptible_timeout(&stall_commit
->cleanup_done
,
1356 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1357 crtc
->base
.id
, crtc
->name
);
1359 drm_crtc_commit_put(stall_commit
);
1361 return ret
< 0 ? ret
: 0;
1365 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1366 * @state: new modeset state to be committed
1367 * @nonblock: whether nonblocking behavior is requested.
1369 * This function prepares @state to be used by the atomic helper's support for
1370 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1371 * should always call this function from their ->atomic_commit hook.
1373 * To be able to use this support drivers need to use a few more helper
1374 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1375 * actually committing the hardware state, and for nonblocking commits this call
1376 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1377 * and it's stall parameter, for when a driver's commit hooks look at the
1378 * ->state pointers of struct &drm_crtc, &drm_plane or &drm_connector directly.
1380 * Completion of the hardware commit step must be signalled using
1381 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1382 * to read or change any permanent software or hardware modeset state. The only
1383 * exception is state protected by other means than &drm_modeset_lock locks.
1384 * Only the free standing @state with pointers to the old state structures can
1385 * be inspected, e.g. to clean up old buffers using
1386 * drm_atomic_helper_cleanup_planes().
1388 * At the very end, before cleaning up @state drivers must call
1389 * drm_atomic_helper_commit_cleanup_done().
1391 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1392 * complete and esay-to-use default implementation of the atomic_commit() hook.
1394 * The tracking of asynchronously executed and still pending commits is done
1395 * using the core structure &drm_crtc_commit.
1397 * By default there's no need to clean up resources allocated by this function
1398 * explicitly: drm_atomic_state_default_clear() will take care of that
1403 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1404 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1406 int drm_atomic_helper_setup_commit(struct drm_atomic_state
*state
,
1409 struct drm_crtc
*crtc
;
1410 struct drm_crtc_state
*crtc_state
;
1411 struct drm_crtc_commit
*commit
;
1414 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1415 commit
= kzalloc(sizeof(*commit
), GFP_KERNEL
);
1419 init_completion(&commit
->flip_done
);
1420 init_completion(&commit
->hw_done
);
1421 init_completion(&commit
->cleanup_done
);
1422 INIT_LIST_HEAD(&commit
->commit_entry
);
1423 kref_init(&commit
->ref
);
1424 commit
->crtc
= crtc
;
1426 state
->crtcs
[i
].commit
= commit
;
1428 ret
= stall_checks(crtc
, nonblock
);
1432 /* Drivers only send out events when at least either current or
1433 * new CRTC state is active. Complete right away if everything
1435 if (!crtc
->state
->active
&& !crtc_state
->active
) {
1436 complete_all(&commit
->flip_done
);
1440 /* Legacy cursor updates are fully unsynced. */
1441 if (state
->legacy_cursor_update
) {
1442 complete_all(&commit
->flip_done
);
1446 if (!crtc_state
->event
) {
1447 commit
->event
= kzalloc(sizeof(*commit
->event
),
1452 crtc_state
->event
= commit
->event
;
1455 crtc_state
->event
->base
.completion
= &commit
->flip_done
;
1460 EXPORT_SYMBOL(drm_atomic_helper_setup_commit
);
1463 static struct drm_crtc_commit
*preceeding_commit(struct drm_crtc
*crtc
)
1465 struct drm_crtc_commit
*commit
;
1468 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1469 /* skip the first entry, that's the current commit */
1479 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1480 * @state: new modeset state to be committed
1482 * This function waits for all preceeding commits that touch the same CRTC as
1483 * @state to both be committed to the hardware (as signalled by
1484 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1485 * by calling drm_crtc_vblank_send_event on the event member of
1488 * This is part of the atomic helper support for nonblocking commits, see
1489 * drm_atomic_helper_setup_commit() for an overview.
1491 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state
*state
)
1493 struct drm_crtc
*crtc
;
1494 struct drm_crtc_state
*crtc_state
;
1495 struct drm_crtc_commit
*commit
;
1499 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1500 spin_lock(&crtc
->commit_lock
);
1501 commit
= preceeding_commit(crtc
);
1503 drm_crtc_commit_get(commit
);
1504 spin_unlock(&crtc
->commit_lock
);
1509 ret
= wait_for_completion_timeout(&commit
->hw_done
,
1512 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1513 crtc
->base
.id
, crtc
->name
);
1515 /* Currently no support for overwriting flips, hence
1516 * stall for previous one to execute completely. */
1517 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1520 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1521 crtc
->base
.id
, crtc
->name
);
1523 drm_crtc_commit_put(commit
);
1526 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies
);
1529 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1530 * @state: new modeset state to be committed
1532 * This function is used to signal completion of the hardware commit step. After
1533 * this step the driver is not allowed to read or change any permanent software
1534 * or hardware modeset state. The only exception is state protected by other
1535 * means than &drm_modeset_lock locks.
1537 * Drivers should try to postpone any expensive or delayed cleanup work after
1538 * this function is called.
1540 * This is part of the atomic helper support for nonblocking commits, see
1541 * drm_atomic_helper_setup_commit() for an overview.
1543 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state
*state
)
1545 struct drm_crtc
*crtc
;
1546 struct drm_crtc_state
*crtc_state
;
1547 struct drm_crtc_commit
*commit
;
1550 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1551 commit
= state
->crtcs
[i
].commit
;
1555 /* backend must have consumed any event by now */
1556 WARN_ON(crtc
->state
->event
);
1557 spin_lock(&crtc
->commit_lock
);
1558 complete_all(&commit
->hw_done
);
1559 spin_unlock(&crtc
->commit_lock
);
1562 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done
);
1565 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1566 * @state: new modeset state to be committed
1568 * This signals completion of the atomic update @state, including any cleanup
1569 * work. If used, it must be called right before calling
1570 * drm_atomic_state_free().
1572 * This is part of the atomic helper support for nonblocking commits, see
1573 * drm_atomic_helper_setup_commit() for an overview.
1575 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state
*state
)
1577 struct drm_crtc
*crtc
;
1578 struct drm_crtc_state
*crtc_state
;
1579 struct drm_crtc_commit
*commit
;
1583 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1584 commit
= state
->crtcs
[i
].commit
;
1585 if (WARN_ON(!commit
))
1588 spin_lock(&crtc
->commit_lock
);
1589 complete_all(&commit
->cleanup_done
);
1590 WARN_ON(!try_wait_for_completion(&commit
->hw_done
));
1592 /* commit_list borrows our reference, need to remove before we
1593 * clean up our drm_atomic_state. But only after it actually
1594 * completed, otherwise subsequent commits won't stall properly. */
1595 if (try_wait_for_completion(&commit
->flip_done
))
1598 spin_unlock(&crtc
->commit_lock
);
1600 /* We must wait for the vblank event to signal our completion
1601 * before releasing our reference, since the vblank work does
1602 * not hold a reference of its own. */
1603 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1606 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1607 crtc
->base
.id
, crtc
->name
);
1609 spin_lock(&crtc
->commit_lock
);
1611 list_del(&commit
->commit_entry
);
1612 spin_unlock(&crtc
->commit_lock
);
1615 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done
);
1618 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1620 * @state: atomic state object with new state structures
1622 * This function prepares plane state, specifically framebuffers, for the new
1623 * configuration. If any failure is encountered this function will call
1624 * ->cleanup_fb on any already successfully prepared framebuffer.
1627 * 0 on success, negative error code on failure.
1629 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1630 struct drm_atomic_state
*state
)
1632 struct drm_plane
*plane
;
1633 struct drm_plane_state
*plane_state
;
1636 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1637 const struct drm_plane_helper_funcs
*funcs
;
1639 funcs
= plane
->helper_private
;
1641 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1644 if (funcs
->prepare_fb
) {
1645 ret
= funcs
->prepare_fb(plane
, plane_state
);
1654 for_each_plane_in_state(state
, plane
, plane_state
, j
) {
1655 const struct drm_plane_helper_funcs
*funcs
;
1660 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1663 funcs
= plane
->helper_private
;
1665 if (funcs
->cleanup_fb
)
1666 funcs
->cleanup_fb(plane
, plane_state
);
1671 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1673 bool plane_crtc_active(struct drm_plane_state
*state
)
1675 return state
->crtc
&& state
->crtc
->state
->active
;
1679 * drm_atomic_helper_commit_planes - commit plane state
1681 * @old_state: atomic state object with old state structures
1682 * @flags: flags for committing plane state
1684 * This function commits the new plane state using the plane and atomic helper
1685 * functions for planes and crtcs. It assumes that the atomic state has already
1686 * been pushed into the relevant object state pointers, since this step can no
1689 * It still requires the global state object @old_state to know which planes and
1690 * crtcs need to be updated though.
1692 * Note that this function does all plane updates across all CRTCs in one step.
1693 * If the hardware can't support this approach look at
1694 * drm_atomic_helper_commit_planes_on_crtc() instead.
1696 * Plane parameters can be updated by applications while the associated CRTC is
1697 * disabled. The DRM/KMS core will store the parameters in the plane state,
1698 * which will be available to the driver when the CRTC is turned on. As a result
1699 * most drivers don't need to be immediately notified of plane updates for a
1702 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
1703 * @flags in order not to receive plane update notifications related to a
1704 * disabled CRTC. This avoids the need to manually ignore plane updates in
1705 * driver code when the driver and/or hardware can't or just don't need to deal
1706 * with updates on disabled CRTCs, for example when supporting runtime PM.
1708 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
1709 * display controllers require to disable a CRTC's planes when the CRTC is
1710 * disabled. This function would skip the ->atomic_disable call for a plane if
1711 * the CRTC of the old plane state needs a modesetting operation. Of course,
1712 * the drivers need to disable the planes in their CRTC disable callbacks
1713 * since no one else would do that.
1715 * The drm_atomic_helper_commit() default implementation doesn't set the
1716 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
1717 * This should not be copied blindly by drivers.
1719 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1720 struct drm_atomic_state
*old_state
,
1723 struct drm_crtc
*crtc
;
1724 struct drm_crtc_state
*old_crtc_state
;
1725 struct drm_plane
*plane
;
1726 struct drm_plane_state
*old_plane_state
;
1728 bool active_only
= flags
& DRM_PLANE_COMMIT_ACTIVE_ONLY
;
1729 bool no_disable
= flags
& DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET
;
1731 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1732 const struct drm_crtc_helper_funcs
*funcs
;
1734 funcs
= crtc
->helper_private
;
1736 if (!funcs
|| !funcs
->atomic_begin
)
1739 if (active_only
&& !crtc
->state
->active
)
1742 funcs
->atomic_begin(crtc
, old_crtc_state
);
1745 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1746 const struct drm_plane_helper_funcs
*funcs
;
1749 funcs
= plane
->helper_private
;
1754 disabling
= drm_atomic_plane_disabling(plane
, old_plane_state
);
1758 * Skip planes related to inactive CRTCs. If the plane
1759 * is enabled use the state of the current CRTC. If the
1760 * plane is being disabled use the state of the old
1761 * CRTC to avoid skipping planes being disabled on an
1764 if (!disabling
&& !plane_crtc_active(plane
->state
))
1766 if (disabling
&& !plane_crtc_active(old_plane_state
))
1771 * Special-case disabling the plane if drivers support it.
1773 if (disabling
&& funcs
->atomic_disable
) {
1774 struct drm_crtc_state
*crtc_state
;
1776 crtc_state
= old_plane_state
->crtc
->state
;
1778 if (drm_atomic_crtc_needs_modeset(crtc_state
) &&
1782 funcs
->atomic_disable(plane
, old_plane_state
);
1783 } else if (plane
->state
->crtc
|| disabling
) {
1784 funcs
->atomic_update(plane
, old_plane_state
);
1788 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1789 const struct drm_crtc_helper_funcs
*funcs
;
1791 funcs
= crtc
->helper_private
;
1793 if (!funcs
|| !funcs
->atomic_flush
)
1796 if (active_only
&& !crtc
->state
->active
)
1799 funcs
->atomic_flush(crtc
, old_crtc_state
);
1802 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1805 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1806 * @old_crtc_state: atomic state object with the old crtc state
1808 * This function commits the new plane state using the plane and atomic helper
1809 * functions for planes on the specific crtc. It assumes that the atomic state
1810 * has already been pushed into the relevant object state pointers, since this
1811 * step can no longer fail.
1813 * This function is useful when plane updates should be done crtc-by-crtc
1814 * instead of one global step like drm_atomic_helper_commit_planes() does.
1816 * This function can only be savely used when planes are not allowed to move
1817 * between different CRTCs because this function doesn't handle inter-CRTC
1818 * depencies. Callers need to ensure that either no such depencies exist,
1819 * resolve them through ordering of commit calls or through some other means.
1822 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1824 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1825 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1826 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1827 struct drm_plane
*plane
;
1828 unsigned plane_mask
;
1830 plane_mask
= old_crtc_state
->plane_mask
;
1831 plane_mask
|= crtc
->state
->plane_mask
;
1833 crtc_funcs
= crtc
->helper_private
;
1834 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1835 crtc_funcs
->atomic_begin(crtc
, old_crtc_state
);
1837 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1838 struct drm_plane_state
*old_plane_state
=
1839 drm_atomic_get_existing_plane_state(old_state
, plane
);
1840 const struct drm_plane_helper_funcs
*plane_funcs
;
1842 plane_funcs
= plane
->helper_private
;
1844 if (!old_plane_state
|| !plane_funcs
)
1847 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1849 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1850 plane_funcs
->atomic_disable
)
1851 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1852 else if (plane
->state
->crtc
||
1853 drm_atomic_plane_disabling(plane
, old_plane_state
))
1854 plane_funcs
->atomic_update(plane
, old_plane_state
);
1857 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1858 crtc_funcs
->atomic_flush(crtc
, old_crtc_state
);
1860 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1863 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1864 * @old_crtc_state: atomic state object with the old CRTC state
1865 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1867 * Disables all planes associated with the given CRTC. This can be
1868 * used for instance in the CRTC helper atomic_disable callback to disable
1871 * If the atomic-parameter is set the function calls the CRTC's
1872 * atomic_begin hook before and atomic_flush hook after disabling the
1875 * It is a bug to call this function without having implemented the
1876 * ->atomic_disable() plane hook.
1879 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
,
1882 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1883 const struct drm_crtc_helper_funcs
*crtc_funcs
=
1884 crtc
->helper_private
;
1885 struct drm_plane
*plane
;
1887 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_begin
)
1888 crtc_funcs
->atomic_begin(crtc
, NULL
);
1890 drm_atomic_crtc_state_for_each_plane(plane
, old_crtc_state
) {
1891 const struct drm_plane_helper_funcs
*plane_funcs
=
1892 plane
->helper_private
;
1897 WARN_ON(!plane_funcs
->atomic_disable
);
1898 if (plane_funcs
->atomic_disable
)
1899 plane_funcs
->atomic_disable(plane
, NULL
);
1902 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_flush
)
1903 crtc_funcs
->atomic_flush(crtc
, NULL
);
1905 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc
);
1908 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1910 * @old_state: atomic state object with old state structures
1912 * This function cleans up plane state, specifically framebuffers, from the old
1913 * configuration. Hence the old configuration must be perserved in @old_state to
1914 * be able to call this function.
1916 * This function must also be called on the new state when the atomic update
1917 * fails at any point after calling drm_atomic_helper_prepare_planes().
1919 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1920 struct drm_atomic_state
*old_state
)
1922 struct drm_plane
*plane
;
1923 struct drm_plane_state
*plane_state
;
1926 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1927 const struct drm_plane_helper_funcs
*funcs
;
1929 if (!drm_atomic_helper_framebuffer_changed(dev
, old_state
, plane_state
->crtc
))
1932 funcs
= plane
->helper_private
;
1934 if (funcs
->cleanup_fb
)
1935 funcs
->cleanup_fb(plane
, plane_state
);
1938 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1941 * drm_atomic_helper_swap_state - store atomic state into current sw state
1942 * @state: atomic state
1943 * @stall: stall for proceeding commits
1945 * This function stores the atomic state into the current state pointers in all
1946 * driver objects. It should be called after all failing steps have been done
1947 * and succeeded, but before the actual hardware state is committed.
1949 * For cleanup and error recovery the current state for all changed objects will
1950 * be swaped into @state.
1952 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1954 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1956 * 2. Do any other steps that might fail.
1958 * 3. Put the staged state into the current state pointers with this function.
1960 * 4. Actually commit the hardware state.
1962 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1963 * contains the old state. Also do any other cleanup required with that state.
1965 * @stall must be set when nonblocking commits for this driver directly access
1966 * the ->state pointer of &drm_plane, &drm_crtc or &drm_connector. With the
1967 * current atomic helpers this is almost always the case, since the helpers
1968 * don't pass the right state structures to the callbacks.
1970 void drm_atomic_helper_swap_state(struct drm_atomic_state
*state
,
1975 struct drm_connector
*connector
;
1976 struct drm_connector_state
*conn_state
;
1977 struct drm_crtc
*crtc
;
1978 struct drm_crtc_state
*crtc_state
;
1979 struct drm_plane
*plane
;
1980 struct drm_plane_state
*plane_state
;
1981 struct drm_crtc_commit
*commit
;
1984 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1985 spin_lock(&crtc
->commit_lock
);
1986 commit
= list_first_entry_or_null(&crtc
->commit_list
,
1987 struct drm_crtc_commit
, commit_entry
);
1989 drm_crtc_commit_get(commit
);
1990 spin_unlock(&crtc
->commit_lock
);
1995 ret
= wait_for_completion_timeout(&commit
->hw_done
,
1998 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1999 crtc
->base
.id
, crtc
->name
);
2000 drm_crtc_commit_put(commit
);
2004 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
2005 connector
->state
->state
= state
;
2006 swap(state
->connectors
[i
].state
, connector
->state
);
2007 connector
->state
->state
= NULL
;
2010 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2011 crtc
->state
->state
= state
;
2012 swap(state
->crtcs
[i
].state
, crtc
->state
);
2013 crtc
->state
->state
= NULL
;
2015 if (state
->crtcs
[i
].commit
) {
2016 spin_lock(&crtc
->commit_lock
);
2017 list_add(&state
->crtcs
[i
].commit
->commit_entry
,
2018 &crtc
->commit_list
);
2019 spin_unlock(&crtc
->commit_lock
);
2021 state
->crtcs
[i
].commit
->event
= NULL
;
2025 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
2026 plane
->state
->state
= state
;
2027 swap(state
->planes
[i
].state
, plane
->state
);
2028 plane
->state
->state
= NULL
;
2031 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
2034 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2035 * @plane: plane object to update
2036 * @crtc: owning CRTC of owning plane
2037 * @fb: framebuffer to flip onto plane
2038 * @crtc_x: x offset of primary plane on crtc
2039 * @crtc_y: y offset of primary plane on crtc
2040 * @crtc_w: width of primary plane rectangle on crtc
2041 * @crtc_h: height of primary plane rectangle on crtc
2042 * @src_x: x offset of @fb for panning
2043 * @src_y: y offset of @fb for panning
2044 * @src_w: width of source rectangle in @fb
2045 * @src_h: height of source rectangle in @fb
2047 * Provides a default plane update handler using the atomic driver interface.
2050 * Zero on success, error code on failure
2052 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
2053 struct drm_crtc
*crtc
,
2054 struct drm_framebuffer
*fb
,
2055 int crtc_x
, int crtc_y
,
2056 unsigned int crtc_w
, unsigned int crtc_h
,
2057 uint32_t src_x
, uint32_t src_y
,
2058 uint32_t src_w
, uint32_t src_h
)
2060 struct drm_atomic_state
*state
;
2061 struct drm_plane_state
*plane_state
;
2064 state
= drm_atomic_state_alloc(plane
->dev
);
2068 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2070 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2071 if (IS_ERR(plane_state
)) {
2072 ret
= PTR_ERR(plane_state
);
2076 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2079 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2080 plane_state
->crtc_x
= crtc_x
;
2081 plane_state
->crtc_y
= crtc_y
;
2082 plane_state
->crtc_w
= crtc_w
;
2083 plane_state
->crtc_h
= crtc_h
;
2084 plane_state
->src_x
= src_x
;
2085 plane_state
->src_y
= src_y
;
2086 plane_state
->src_w
= src_w
;
2087 plane_state
->src_h
= src_h
;
2089 if (plane
== crtc
->cursor
)
2090 state
->legacy_cursor_update
= true;
2092 ret
= drm_atomic_commit(state
);
2096 /* Driver takes ownership of state on successful commit. */
2099 if (ret
== -EDEADLK
)
2102 drm_atomic_state_free(state
);
2106 drm_atomic_state_clear(state
);
2107 drm_atomic_legacy_backoff(state
);
2110 * Someone might have exchanged the framebuffer while we dropped locks
2111 * in the backoff code. We need to fix up the fb refcount tracking the
2114 plane
->old_fb
= plane
->fb
;
2118 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
2121 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2122 * @plane: plane to disable
2124 * Provides a default plane disable handler using the atomic driver interface.
2127 * Zero on success, error code on failure
2129 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
2131 struct drm_atomic_state
*state
;
2132 struct drm_plane_state
*plane_state
;
2136 * FIXME: Without plane->crtc set we can't get at the implicit legacy
2137 * acquire context. The real fix will be to wire the acquire ctx through
2138 * everywhere we need it, but meanwhile prevent chaos by just skipping
2139 * this noop. The critical case is the cursor ioctls which a) only grab
2140 * crtc/cursor-plane locks (so we need the crtc to get at the right
2141 * acquire context) and b) can try to disable the plane multiple times.
2146 state
= drm_atomic_state_alloc(plane
->dev
);
2150 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
2152 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2153 if (IS_ERR(plane_state
)) {
2154 ret
= PTR_ERR(plane_state
);
2158 if (plane_state
->crtc
&& (plane
== plane
->crtc
->cursor
))
2159 plane_state
->state
->legacy_cursor_update
= true;
2161 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
2165 ret
= drm_atomic_commit(state
);
2169 /* Driver takes ownership of state on successful commit. */
2172 if (ret
== -EDEADLK
)
2175 drm_atomic_state_free(state
);
2179 drm_atomic_state_clear(state
);
2180 drm_atomic_legacy_backoff(state
);
2183 * Someone might have exchanged the framebuffer while we dropped locks
2184 * in the backoff code. We need to fix up the fb refcount tracking the
2187 plane
->old_fb
= plane
->fb
;
2191 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
2193 /* just used from fb-helper and atomic-helper: */
2194 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
2195 struct drm_plane_state
*plane_state
)
2199 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
2203 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
2204 plane_state
->crtc_x
= 0;
2205 plane_state
->crtc_y
= 0;
2206 plane_state
->crtc_w
= 0;
2207 plane_state
->crtc_h
= 0;
2208 plane_state
->src_x
= 0;
2209 plane_state
->src_y
= 0;
2210 plane_state
->src_w
= 0;
2211 plane_state
->src_h
= 0;
2216 static int update_output_state(struct drm_atomic_state
*state
,
2217 struct drm_mode_set
*set
)
2219 struct drm_device
*dev
= set
->crtc
->dev
;
2220 struct drm_crtc
*crtc
;
2221 struct drm_crtc_state
*crtc_state
;
2222 struct drm_connector
*connector
;
2223 struct drm_connector_state
*conn_state
;
2226 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
2227 state
->acquire_ctx
);
2231 /* First disable all connectors on the target crtc. */
2232 ret
= drm_atomic_add_affected_connectors(state
, set
->crtc
);
2236 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
2237 if (conn_state
->crtc
== set
->crtc
) {
2238 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2245 /* Then set all connectors from set->connectors on the target crtc */
2246 for (i
= 0; i
< set
->num_connectors
; i
++) {
2247 conn_state
= drm_atomic_get_connector_state(state
,
2248 set
->connectors
[i
]);
2249 if (IS_ERR(conn_state
))
2250 return PTR_ERR(conn_state
);
2252 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2258 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2259 /* Don't update ->enable for the CRTC in the set_config request,
2260 * since a mismatch would indicate a bug in the upper layers.
2261 * The actual modeset code later on will catch any
2262 * inconsistencies here. */
2263 if (crtc
== set
->crtc
)
2266 if (!crtc_state
->connector_mask
) {
2267 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
2272 crtc_state
->active
= false;
2280 * drm_atomic_helper_set_config - set a new config from userspace
2281 * @set: mode set configuration
2283 * Provides a default crtc set_config handler using the atomic driver interface.
2286 * Returns 0 on success, negative errno numbers on failure.
2288 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
2290 struct drm_atomic_state
*state
;
2291 struct drm_crtc
*crtc
= set
->crtc
;
2294 state
= drm_atomic_state_alloc(crtc
->dev
);
2298 state
->legacy_set_config
= true;
2299 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2301 ret
= __drm_atomic_helper_set_config(set
, state
);
2305 ret
= drm_atomic_commit(state
);
2309 /* Driver takes ownership of state on successful commit. */
2312 if (ret
== -EDEADLK
)
2315 drm_atomic_state_free(state
);
2319 drm_atomic_state_clear(state
);
2320 drm_atomic_legacy_backoff(state
);
2323 * Someone might have exchanged the framebuffer while we dropped locks
2324 * in the backoff code. We need to fix up the fb refcount tracking the
2327 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
2331 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
2333 /* just used from fb-helper and atomic-helper: */
2334 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
2335 struct drm_atomic_state
*state
)
2337 struct drm_crtc_state
*crtc_state
;
2338 struct drm_plane_state
*primary_state
;
2339 struct drm_crtc
*crtc
= set
->crtc
;
2340 int hdisplay
, vdisplay
;
2343 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2344 if (IS_ERR(crtc_state
))
2345 return PTR_ERR(crtc_state
);
2347 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
2348 if (IS_ERR(primary_state
))
2349 return PTR_ERR(primary_state
);
2353 WARN_ON(set
->num_connectors
);
2355 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
2359 crtc_state
->active
= false;
2361 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
2365 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
2371 WARN_ON(!set
->num_connectors
);
2373 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
2377 crtc_state
->active
= true;
2379 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
2383 drm_crtc_get_hv_timing(set
->mode
, &hdisplay
, &vdisplay
);
2385 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
2386 primary_state
->crtc_x
= 0;
2387 primary_state
->crtc_y
= 0;
2388 primary_state
->crtc_w
= hdisplay
;
2389 primary_state
->crtc_h
= vdisplay
;
2390 primary_state
->src_x
= set
->x
<< 16;
2391 primary_state
->src_y
= set
->y
<< 16;
2392 if (primary_state
->rotation
& (DRM_ROTATE_90
| DRM_ROTATE_270
)) {
2393 primary_state
->src_w
= vdisplay
<< 16;
2394 primary_state
->src_h
= hdisplay
<< 16;
2396 primary_state
->src_w
= hdisplay
<< 16;
2397 primary_state
->src_h
= vdisplay
<< 16;
2401 ret
= update_output_state(state
, set
);
2409 * drm_atomic_helper_disable_all - disable all currently active outputs
2411 * @ctx: lock acquisition context
2413 * Loops through all connectors, finding those that aren't turned off and then
2414 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2415 * that they are connected to.
2417 * This is used for example in suspend/resume to disable all currently active
2418 * functions when suspending.
2420 * Note that if callers haven't already acquired all modeset locks this might
2421 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2424 * 0 on success or a negative error code on failure.
2427 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2429 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
2430 struct drm_modeset_acquire_ctx
*ctx
)
2432 struct drm_atomic_state
*state
;
2433 struct drm_connector
*conn
;
2436 state
= drm_atomic_state_alloc(dev
);
2440 state
->acquire_ctx
= ctx
;
2442 drm_for_each_connector(conn
, dev
) {
2443 struct drm_crtc
*crtc
= conn
->state
->crtc
;
2444 struct drm_crtc_state
*crtc_state
;
2446 if (!crtc
|| conn
->dpms
!= DRM_MODE_DPMS_ON
)
2449 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2450 if (IS_ERR(crtc_state
)) {
2451 err
= PTR_ERR(crtc_state
);
2455 crtc_state
->active
= false;
2458 err
= drm_atomic_commit(state
);
2462 drm_atomic_state_free(state
);
2466 EXPORT_SYMBOL(drm_atomic_helper_disable_all
);
2469 * drm_atomic_helper_suspend - subsystem-level suspend helper
2472 * Duplicates the current atomic state, disables all active outputs and then
2473 * returns a pointer to the original atomic state to the caller. Drivers can
2474 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2475 * restore the output configuration that was active at the time the system
2478 * Note that it is potentially unsafe to use this. The atomic state object
2479 * returned by this function is assumed to be persistent. Drivers must ensure
2480 * that this holds true. Before calling this function, drivers must make sure
2481 * to suspend fbdev emulation so that nothing can be using the device.
2484 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2485 * encoded error code on failure. Drivers should store the returned atomic
2486 * state object and pass it to the drm_atomic_helper_resume() helper upon
2490 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2491 * drm_atomic_helper_resume()
2493 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
)
2495 struct drm_modeset_acquire_ctx ctx
;
2496 struct drm_atomic_state
*state
;
2499 drm_modeset_acquire_init(&ctx
, 0);
2502 err
= drm_modeset_lock_all_ctx(dev
, &ctx
);
2504 state
= ERR_PTR(err
);
2508 state
= drm_atomic_helper_duplicate_state(dev
, &ctx
);
2512 err
= drm_atomic_helper_disable_all(dev
, &ctx
);
2514 drm_atomic_state_free(state
);
2515 state
= ERR_PTR(err
);
2520 if (PTR_ERR(state
) == -EDEADLK
) {
2521 drm_modeset_backoff(&ctx
);
2525 drm_modeset_drop_locks(&ctx
);
2526 drm_modeset_acquire_fini(&ctx
);
2529 EXPORT_SYMBOL(drm_atomic_helper_suspend
);
2532 * drm_atomic_helper_resume - subsystem-level resume helper
2534 * @state: atomic state to resume to
2536 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2537 * grabs all modeset locks and commits the atomic state object. This can be
2538 * used in conjunction with the drm_atomic_helper_suspend() helper to
2539 * implement suspend/resume for drivers that support atomic mode-setting.
2542 * 0 on success or a negative error code on failure.
2545 * drm_atomic_helper_suspend()
2547 int drm_atomic_helper_resume(struct drm_device
*dev
,
2548 struct drm_atomic_state
*state
)
2550 struct drm_mode_config
*config
= &dev
->mode_config
;
2553 drm_mode_config_reset(dev
);
2554 drm_modeset_lock_all(dev
);
2555 state
->acquire_ctx
= config
->acquire_ctx
;
2556 err
= drm_atomic_commit(state
);
2557 drm_modeset_unlock_all(dev
);
2561 EXPORT_SYMBOL(drm_atomic_helper_resume
);
2564 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2566 * @property: DRM property
2567 * @val: value of property
2569 * Provides a default crtc set_property handler using the atomic driver
2573 * Zero on success, error code on failure
2576 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
2577 struct drm_property
*property
,
2580 struct drm_atomic_state
*state
;
2581 struct drm_crtc_state
*crtc_state
;
2584 state
= drm_atomic_state_alloc(crtc
->dev
);
2588 /* ->set_property is always called with all locks held. */
2589 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2591 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2592 if (IS_ERR(crtc_state
)) {
2593 ret
= PTR_ERR(crtc_state
);
2597 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2602 ret
= drm_atomic_commit(state
);
2606 /* Driver takes ownership of state on successful commit. */
2609 if (ret
== -EDEADLK
)
2612 drm_atomic_state_free(state
);
2616 drm_atomic_state_clear(state
);
2617 drm_atomic_legacy_backoff(state
);
2621 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
2624 * drm_atomic_helper_plane_set_property - helper for plane properties
2626 * @property: DRM property
2627 * @val: value of property
2629 * Provides a default plane set_property handler using the atomic driver
2633 * Zero on success, error code on failure
2636 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
2637 struct drm_property
*property
,
2640 struct drm_atomic_state
*state
;
2641 struct drm_plane_state
*plane_state
;
2644 state
= drm_atomic_state_alloc(plane
->dev
);
2648 /* ->set_property is always called with all locks held. */
2649 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
2651 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2652 if (IS_ERR(plane_state
)) {
2653 ret
= PTR_ERR(plane_state
);
2657 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
2662 ret
= drm_atomic_commit(state
);
2666 /* Driver takes ownership of state on successful commit. */
2669 if (ret
== -EDEADLK
)
2672 drm_atomic_state_free(state
);
2676 drm_atomic_state_clear(state
);
2677 drm_atomic_legacy_backoff(state
);
2681 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
2684 * drm_atomic_helper_connector_set_property - helper for connector properties
2685 * @connector: DRM connector
2686 * @property: DRM property
2687 * @val: value of property
2689 * Provides a default connector set_property handler using the atomic driver
2693 * Zero on success, error code on failure
2696 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
2697 struct drm_property
*property
,
2700 struct drm_atomic_state
*state
;
2701 struct drm_connector_state
*connector_state
;
2704 state
= drm_atomic_state_alloc(connector
->dev
);
2708 /* ->set_property is always called with all locks held. */
2709 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
2711 connector_state
= drm_atomic_get_connector_state(state
, connector
);
2712 if (IS_ERR(connector_state
)) {
2713 ret
= PTR_ERR(connector_state
);
2717 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
2722 ret
= drm_atomic_commit(state
);
2726 /* Driver takes ownership of state on successful commit. */
2729 if (ret
== -EDEADLK
)
2732 drm_atomic_state_free(state
);
2736 drm_atomic_state_clear(state
);
2737 drm_atomic_legacy_backoff(state
);
2741 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
2744 * drm_atomic_helper_page_flip - execute a legacy page flip
2746 * @fb: DRM framebuffer
2747 * @event: optional DRM event to signal upon completion
2748 * @flags: flip flags for non-vblank sync'ed updates
2750 * Provides a default page flip implementation using the atomic driver interface.
2752 * Note that for now so called async page flips (i.e. updates which are not
2753 * synchronized to vblank) are not supported, since the atomic interfaces have
2754 * no provisions for this yet.
2757 * Returns 0 on success, negative errno numbers on failure.
2759 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
2760 struct drm_framebuffer
*fb
,
2761 struct drm_pending_vblank_event
*event
,
2764 struct drm_plane
*plane
= crtc
->primary
;
2765 struct drm_atomic_state
*state
;
2766 struct drm_plane_state
*plane_state
;
2767 struct drm_crtc_state
*crtc_state
;
2770 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
2773 state
= drm_atomic_state_alloc(plane
->dev
);
2777 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2779 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2780 if (IS_ERR(crtc_state
)) {
2781 ret
= PTR_ERR(crtc_state
);
2784 crtc_state
->event
= event
;
2786 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2787 if (IS_ERR(plane_state
)) {
2788 ret
= PTR_ERR(plane_state
);
2792 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2795 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2797 /* Make sure we don't accidentally do a full modeset. */
2798 state
->allow_modeset
= false;
2799 if (!crtc_state
->active
) {
2800 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2806 ret
= drm_atomic_nonblocking_commit(state
);
2810 /* Driver takes ownership of state on successful commit. */
2813 if (ret
== -EDEADLK
)
2816 drm_atomic_state_free(state
);
2820 drm_atomic_state_clear(state
);
2821 drm_atomic_legacy_backoff(state
);
2824 * Someone might have exchanged the framebuffer while we dropped locks
2825 * in the backoff code. We need to fix up the fb refcount tracking the
2828 plane
->old_fb
= plane
->fb
;
2832 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
2835 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2836 * @connector: affected connector
2839 * This is the main helper function provided by the atomic helper framework for
2840 * implementing the legacy DPMS connector interface. It computes the new desired
2841 * ->active state for the corresponding CRTC (if the connector is enabled) and
2845 * Returns 0 on success, negative errno numbers on failure.
2847 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
2850 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
2851 struct drm_atomic_state
*state
;
2852 struct drm_crtc_state
*crtc_state
;
2853 struct drm_crtc
*crtc
;
2854 struct drm_connector
*tmp_connector
;
2856 bool active
= false;
2857 int old_mode
= connector
->dpms
;
2859 if (mode
!= DRM_MODE_DPMS_ON
)
2860 mode
= DRM_MODE_DPMS_OFF
;
2862 connector
->dpms
= mode
;
2863 crtc
= connector
->state
->crtc
;
2868 state
= drm_atomic_state_alloc(connector
->dev
);
2872 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2874 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2875 if (IS_ERR(crtc_state
)) {
2876 ret
= PTR_ERR(crtc_state
);
2880 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
2882 drm_for_each_connector(tmp_connector
, connector
->dev
) {
2883 if (tmp_connector
->state
->crtc
!= crtc
)
2886 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2891 crtc_state
->active
= active
;
2893 ret
= drm_atomic_commit(state
);
2897 /* Driver takes ownership of state on successful commit. */
2900 if (ret
== -EDEADLK
)
2903 connector
->dpms
= old_mode
;
2904 drm_atomic_state_free(state
);
2908 drm_atomic_state_clear(state
);
2909 drm_atomic_legacy_backoff(state
);
2913 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2916 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2917 * ->best_encoder callback
2918 * @connector: Connector control structure
2920 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2921 * connectors that support exactly 1 encoder, statically determined at driver
2924 struct drm_encoder
*
2925 drm_atomic_helper_best_encoder(struct drm_connector
*connector
)
2927 WARN_ON(connector
->encoder_ids
[1]);
2928 return drm_encoder_find(connector
->dev
, connector
->encoder_ids
[0]);
2930 EXPORT_SYMBOL(drm_atomic_helper_best_encoder
);
2933 * DOC: atomic state reset and initialization
2935 * Both the drm core and the atomic helpers assume that there is always the full
2936 * and correct atomic software state for all connectors, CRTCs and planes
2937 * available. Which is a bit a problem on driver load and also after system
2938 * suspend. One way to solve this is to have a hardware state read-out
2939 * infrastructure which reconstructs the full software state (e.g. the i915
2942 * The simpler solution is to just reset the software state to everything off,
2943 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2944 * the atomic helpers provide default reset implementations for all hooks.
2946 * On the upside the precise state tracking of atomic simplifies system suspend
2947 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2948 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2949 * For other drivers the building blocks are split out, see the documentation
2950 * for these functions.
2954 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2957 * Resets the atomic state for @crtc by freeing the state pointer (which might
2958 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2960 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2963 __drm_atomic_helper_crtc_destroy_state(crtc
->state
);
2966 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2969 crtc
->state
->crtc
= crtc
;
2971 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2974 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2975 * @crtc: CRTC object
2976 * @state: atomic CRTC state
2978 * Copies atomic state from a CRTC's current state and resets inferred values.
2979 * This is useful for drivers that subclass the CRTC state.
2981 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2982 struct drm_crtc_state
*state
)
2984 memcpy(state
, crtc
->state
, sizeof(*state
));
2986 if (state
->mode_blob
)
2987 drm_property_reference_blob(state
->mode_blob
);
2988 if (state
->degamma_lut
)
2989 drm_property_reference_blob(state
->degamma_lut
);
2991 drm_property_reference_blob(state
->ctm
);
2992 if (state
->gamma_lut
)
2993 drm_property_reference_blob(state
->gamma_lut
);
2994 state
->mode_changed
= false;
2995 state
->active_changed
= false;
2996 state
->planes_changed
= false;
2997 state
->connectors_changed
= false;
2998 state
->color_mgmt_changed
= false;
2999 state
->zpos_changed
= false;
3000 state
->event
= NULL
;
3002 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
3005 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3008 * Default CRTC state duplicate hook for drivers which don't have their own
3009 * subclassed CRTC state structure.
3011 struct drm_crtc_state
*
3012 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
3014 struct drm_crtc_state
*state
;
3016 if (WARN_ON(!crtc
->state
))
3019 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3021 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
3025 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
3028 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3029 * @state: CRTC state object to release
3031 * Releases all resources stored in the CRTC state without actually freeing
3032 * the memory of the CRTC state. This is useful for drivers that subclass the
3035 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
)
3037 drm_property_unreference_blob(state
->mode_blob
);
3038 drm_property_unreference_blob(state
->degamma_lut
);
3039 drm_property_unreference_blob(state
->ctm
);
3040 drm_property_unreference_blob(state
->gamma_lut
);
3042 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
3045 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3047 * @state: CRTC state object to release
3049 * Default CRTC state destroy hook for drivers which don't have their own
3050 * subclassed CRTC state structure.
3052 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
3053 struct drm_crtc_state
*state
)
3055 __drm_atomic_helper_crtc_destroy_state(state
);
3058 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
3061 * drm_atomic_helper_plane_reset - default ->reset hook for planes
3064 * Resets the atomic state for @plane by freeing the state pointer (which might
3065 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3067 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
3070 __drm_atomic_helper_plane_destroy_state(plane
->state
);
3072 kfree(plane
->state
);
3073 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
3076 plane
->state
->plane
= plane
;
3077 plane
->state
->rotation
= DRM_ROTATE_0
;
3080 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
3083 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3084 * @plane: plane object
3085 * @state: atomic plane state
3087 * Copies atomic state from a plane's current state. This is useful for
3088 * drivers that subclass the plane state.
3090 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
3091 struct drm_plane_state
*state
)
3093 memcpy(state
, plane
->state
, sizeof(*state
));
3096 drm_framebuffer_reference(state
->fb
);
3098 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
3101 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3104 * Default plane state duplicate hook for drivers which don't have their own
3105 * subclassed plane state structure.
3107 struct drm_plane_state
*
3108 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
3110 struct drm_plane_state
*state
;
3112 if (WARN_ON(!plane
->state
))
3115 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3117 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
3121 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
3124 * __drm_atomic_helper_plane_destroy_state - release plane state
3125 * @state: plane state object to release
3127 * Releases all resources stored in the plane state without actually freeing
3128 * the memory of the plane state. This is useful for drivers that subclass the
3131 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state
*state
)
3134 drm_framebuffer_unreference(state
->fb
);
3136 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
3139 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3141 * @state: plane state object to release
3143 * Default plane state destroy hook for drivers which don't have their own
3144 * subclassed plane state structure.
3146 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
3147 struct drm_plane_state
*state
)
3149 __drm_atomic_helper_plane_destroy_state(state
);
3152 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
3155 * __drm_atomic_helper_connector_reset - reset state on connector
3156 * @connector: drm connector
3157 * @conn_state: connector state to assign
3159 * Initializes the newly allocated @conn_state and assigns it to
3160 * #connector ->state, usually required when initializing the drivers
3161 * or when called from the ->reset hook.
3163 * This is useful for drivers that subclass the connector state.
3166 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
3167 struct drm_connector_state
*conn_state
)
3170 conn_state
->connector
= connector
;
3172 connector
->state
= conn_state
;
3174 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
3177 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
3178 * @connector: drm connector
3180 * Resets the atomic state for @connector by freeing the state pointer (which
3181 * might be NULL, e.g. at driver load time) and allocating a new empty state
3184 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
3186 struct drm_connector_state
*conn_state
=
3187 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
3189 if (connector
->state
)
3190 __drm_atomic_helper_connector_destroy_state(connector
->state
);
3192 kfree(connector
->state
);
3193 __drm_atomic_helper_connector_reset(connector
, conn_state
);
3195 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
3198 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3199 * @connector: connector object
3200 * @state: atomic connector state
3202 * Copies atomic state from a connector's current state. This is useful for
3203 * drivers that subclass the connector state.
3206 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
3207 struct drm_connector_state
*state
)
3209 memcpy(state
, connector
->state
, sizeof(*state
));
3211 drm_connector_reference(connector
);
3213 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
3216 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3217 * @connector: drm connector
3219 * Default connector state duplicate hook for drivers which don't have their own
3220 * subclassed connector state structure.
3222 struct drm_connector_state
*
3223 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
3225 struct drm_connector_state
*state
;
3227 if (WARN_ON(!connector
->state
))
3230 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3232 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
3236 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
3239 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3241 * @ctx: lock acquisition context
3243 * Makes a copy of the current atomic state by looping over all objects and
3244 * duplicating their respective states. This is used for example by suspend/
3245 * resume support code to save the state prior to suspend such that it can
3246 * be restored upon resume.
3248 * Note that this treats atomic state as persistent between save and restore.
3249 * Drivers must make sure that this is possible and won't result in confusion
3250 * or erroneous behaviour.
3252 * Note that if callers haven't already acquired all modeset locks this might
3253 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3256 * A pointer to the copy of the atomic state object on success or an
3257 * ERR_PTR()-encoded error code on failure.
3260 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3262 struct drm_atomic_state
*
3263 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
3264 struct drm_modeset_acquire_ctx
*ctx
)
3266 struct drm_atomic_state
*state
;
3267 struct drm_connector
*conn
;
3268 struct drm_plane
*plane
;
3269 struct drm_crtc
*crtc
;
3272 state
= drm_atomic_state_alloc(dev
);
3274 return ERR_PTR(-ENOMEM
);
3276 state
->acquire_ctx
= ctx
;
3278 drm_for_each_crtc(crtc
, dev
) {
3279 struct drm_crtc_state
*crtc_state
;
3281 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3282 if (IS_ERR(crtc_state
)) {
3283 err
= PTR_ERR(crtc_state
);
3288 drm_for_each_plane(plane
, dev
) {
3289 struct drm_plane_state
*plane_state
;
3291 plane_state
= drm_atomic_get_plane_state(state
, plane
);
3292 if (IS_ERR(plane_state
)) {
3293 err
= PTR_ERR(plane_state
);
3298 drm_for_each_connector(conn
, dev
) {
3299 struct drm_connector_state
*conn_state
;
3301 conn_state
= drm_atomic_get_connector_state(state
, conn
);
3302 if (IS_ERR(conn_state
)) {
3303 err
= PTR_ERR(conn_state
);
3308 /* clear the acquire context so that it isn't accidentally reused */
3309 state
->acquire_ctx
= NULL
;
3313 drm_atomic_state_free(state
);
3314 state
= ERR_PTR(err
);
3319 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state
);
3322 * __drm_atomic_helper_connector_destroy_state - release connector state
3323 * @state: connector state object to release
3325 * Releases all resources stored in the connector state without actually
3326 * freeing the memory of the connector state. This is useful for drivers that
3327 * subclass the connector state.
3330 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state
*state
)
3333 * This is currently a placeholder so that drivers that subclass the
3334 * state will automatically do the right thing if code is ever added
3338 drm_connector_unreference(state
->connector
);
3340 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
3343 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3344 * @connector: drm connector
3345 * @state: connector state object to release
3347 * Default connector state destroy hook for drivers which don't have their own
3348 * subclassed connector state structure.
3350 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
3351 struct drm_connector_state
*state
)
3353 __drm_atomic_helper_connector_destroy_state(state
);
3356 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);
3359 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3360 * @crtc: CRTC object
3361 * @red: red correction table
3362 * @green: green correction table
3363 * @blue: green correction table
3364 * @size: size of the tables
3366 * Implements support for legacy gamma correction table for drivers
3367 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3370 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc
*crtc
,
3371 u16
*red
, u16
*green
, u16
*blue
,
3374 struct drm_device
*dev
= crtc
->dev
;
3375 struct drm_mode_config
*config
= &dev
->mode_config
;
3376 struct drm_atomic_state
*state
;
3377 struct drm_crtc_state
*crtc_state
;
3378 struct drm_property_blob
*blob
= NULL
;
3379 struct drm_color_lut
*blob_data
;
3382 state
= drm_atomic_state_alloc(crtc
->dev
);
3386 blob
= drm_property_create_blob(dev
,
3387 sizeof(struct drm_color_lut
) * size
,
3390 ret
= PTR_ERR(blob
);
3395 /* Prepare GAMMA_LUT with the legacy values. */
3396 blob_data
= (struct drm_color_lut
*) blob
->data
;
3397 for (i
= 0; i
< size
; i
++) {
3398 blob_data
[i
].red
= red
[i
];
3399 blob_data
[i
].green
= green
[i
];
3400 blob_data
[i
].blue
= blue
[i
];
3403 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
3405 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3406 if (IS_ERR(crtc_state
)) {
3407 ret
= PTR_ERR(crtc_state
);
3411 /* Reset DEGAMMA_LUT and CTM properties. */
3412 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3413 config
->degamma_lut_property
, 0);
3417 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3418 config
->ctm_property
, 0);
3422 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3423 config
->gamma_lut_property
, blob
->base
.id
);
3427 ret
= drm_atomic_commit(state
);
3431 /* Driver takes ownership of state on successful commit. */
3433 drm_property_unreference_blob(blob
);
3437 if (ret
== -EDEADLK
)
3440 drm_atomic_state_free(state
);
3441 drm_property_unreference_blob(blob
);
3445 drm_atomic_state_clear(state
);
3446 drm_atomic_legacy_backoff(state
);
3450 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set
);