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_helper_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
->disable
)
753 funcs
->disable(crtc
);
755 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
760 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
762 * @old_state: atomic state object with old state structures
764 * This function updates all the various legacy modeset state pointers in
765 * connectors, encoders and crtcs. It also updates the timestamping constants
766 * used for precise vblank timestamps by calling
767 * drm_calc_timestamping_constants().
769 * Drivers can use this for building their own atomic commit if they don't have
770 * a pure helper-based modeset implementation.
773 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
774 struct drm_atomic_state
*old_state
)
776 struct drm_connector
*connector
;
777 struct drm_connector_state
*old_conn_state
;
778 struct drm_crtc
*crtc
;
779 struct drm_crtc_state
*old_crtc_state
;
782 /* clear out existing links and update dpms */
783 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
784 if (connector
->encoder
) {
785 WARN_ON(!connector
->encoder
->crtc
);
787 connector
->encoder
->crtc
= NULL
;
788 connector
->encoder
= NULL
;
791 crtc
= connector
->state
->crtc
;
792 if ((!crtc
&& old_conn_state
->crtc
) ||
793 (crtc
&& drm_atomic_crtc_needs_modeset(crtc
->state
))) {
794 struct drm_property
*dpms_prop
=
795 dev
->mode_config
.dpms_property
;
796 int mode
= DRM_MODE_DPMS_OFF
;
798 if (crtc
&& crtc
->state
->active
)
799 mode
= DRM_MODE_DPMS_ON
;
801 connector
->dpms
= mode
;
802 drm_object_property_set_value(&connector
->base
,
808 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
809 if (!connector
->state
->crtc
)
812 if (WARN_ON(!connector
->state
->best_encoder
))
815 connector
->encoder
= connector
->state
->best_encoder
;
816 connector
->encoder
->crtc
= connector
->state
->crtc
;
819 /* set legacy state in the crtc structure */
820 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
821 struct drm_plane
*primary
= crtc
->primary
;
823 crtc
->mode
= crtc
->state
->mode
;
824 crtc
->enabled
= crtc
->state
->enable
;
826 if (drm_atomic_get_existing_plane_state(old_state
, primary
) &&
827 primary
->state
->crtc
== crtc
) {
828 crtc
->x
= primary
->state
->src_x
>> 16;
829 crtc
->y
= primary
->state
->src_y
>> 16;
832 if (crtc
->state
->enable
)
833 drm_calc_timestamping_constants(crtc
,
834 &crtc
->state
->adjusted_mode
);
837 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
840 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
842 struct drm_crtc
*crtc
;
843 struct drm_crtc_state
*old_crtc_state
;
844 struct drm_connector
*connector
;
845 struct drm_connector_state
*old_conn_state
;
848 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
849 const struct drm_crtc_helper_funcs
*funcs
;
851 if (!crtc
->state
->mode_changed
)
854 funcs
= crtc
->helper_private
;
856 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
857 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
858 crtc
->base
.id
, crtc
->name
);
860 funcs
->mode_set_nofb(crtc
);
864 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
865 const struct drm_encoder_helper_funcs
*funcs
;
866 struct drm_crtc_state
*new_crtc_state
;
867 struct drm_encoder
*encoder
;
868 struct drm_display_mode
*mode
, *adjusted_mode
;
870 if (!connector
->state
->best_encoder
)
873 encoder
= connector
->state
->best_encoder
;
874 funcs
= encoder
->helper_private
;
875 new_crtc_state
= connector
->state
->crtc
->state
;
876 mode
= &new_crtc_state
->mode
;
877 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
879 if (!new_crtc_state
->mode_changed
)
882 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
883 encoder
->base
.id
, encoder
->name
);
886 * Each encoder has at most one connector (since we always steal
887 * it away), so we won't call mode_set hooks twice.
889 if (funcs
&& funcs
->mode_set
)
890 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
892 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
897 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
899 * @old_state: atomic state object with old state structures
901 * This function shuts down all the outputs that need to be shut down and
902 * prepares them (if required) with the new mode.
904 * For compatibility with legacy crtc helpers this should be called before
905 * drm_atomic_helper_commit_planes(), which is what the default commit function
906 * does. But drivers with different needs can group the modeset commits together
907 * and do the plane commits at the end. This is useful for drivers doing runtime
908 * PM since planes updates then only happen when the CRTC is actually enabled.
910 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
911 struct drm_atomic_state
*old_state
)
913 disable_outputs(dev
, old_state
);
915 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
917 crtc_set_mode(dev
, old_state
);
919 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
922 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
924 * @old_state: atomic state object with old state structures
926 * This function enables all the outputs with the new configuration which had to
927 * be turned off for the update.
929 * For compatibility with legacy crtc helpers this should be called after
930 * drm_atomic_helper_commit_planes(), which is what the default commit function
931 * does. But drivers with different needs can group the modeset commits together
932 * and do the plane commits at the end. This is useful for drivers doing runtime
933 * PM since planes updates then only happen when the CRTC is actually enabled.
935 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
936 struct drm_atomic_state
*old_state
)
938 struct drm_crtc
*crtc
;
939 struct drm_crtc_state
*old_crtc_state
;
940 struct drm_connector
*connector
;
941 struct drm_connector_state
*old_conn_state
;
944 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
945 const struct drm_crtc_helper_funcs
*funcs
;
947 /* Need to filter out CRTCs where only planes change. */
948 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
951 if (!crtc
->state
->active
)
954 funcs
= crtc
->helper_private
;
956 if (crtc
->state
->enable
) {
957 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
958 crtc
->base
.id
, crtc
->name
);
967 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
968 const struct drm_encoder_helper_funcs
*funcs
;
969 struct drm_encoder
*encoder
;
971 if (!connector
->state
->best_encoder
)
974 if (!connector
->state
->crtc
->state
->active
||
975 !drm_atomic_crtc_needs_modeset(connector
->state
->crtc
->state
))
978 encoder
= connector
->state
->best_encoder
;
979 funcs
= encoder
->helper_private
;
981 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
982 encoder
->base
.id
, encoder
->name
);
985 * Each encoder has at most one connector (since we always steal
986 * it away), so we won't call enable hooks twice.
988 drm_bridge_pre_enable(encoder
->bridge
);
992 funcs
->enable(encoder
);
993 else if (funcs
->commit
)
994 funcs
->commit(encoder
);
997 drm_bridge_enable(encoder
->bridge
);
1000 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
1003 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1005 * @state: atomic state object with old state structures
1007 * For implicit sync, driver should fish the exclusive fence out from the
1008 * incoming fb's and stash it in the drm_plane_state. This is called after
1009 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1010 * just uses the atomic state to find the changed planes)
1012 void drm_atomic_helper_wait_for_fences(struct drm_device
*dev
,
1013 struct drm_atomic_state
*state
)
1015 struct drm_plane
*plane
;
1016 struct drm_plane_state
*plane_state
;
1019 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1020 if (!plane
->state
->fence
)
1023 WARN_ON(!plane
->state
->fb
);
1025 fence_wait(plane
->state
->fence
, false);
1026 fence_put(plane
->state
->fence
);
1027 plane
->state
->fence
= NULL
;
1030 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences
);
1033 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1035 * @old_state: atomic state object with old state structures
1038 * Checks whether the framebuffer used for this CRTC changes as a result of
1039 * the atomic update. This is useful for drivers which cannot use
1040 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1044 * true if the framebuffer changed.
1046 bool drm_atomic_helper_framebuffer_changed(struct drm_device
*dev
,
1047 struct drm_atomic_state
*old_state
,
1048 struct drm_crtc
*crtc
)
1050 struct drm_plane
*plane
;
1051 struct drm_plane_state
*old_plane_state
;
1054 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1055 if (plane
->state
->crtc
!= crtc
&&
1056 old_plane_state
->crtc
!= crtc
)
1059 if (plane
->state
->fb
!= old_plane_state
->fb
)
1065 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed
);
1068 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1070 * @old_state: atomic state object with old state structures
1072 * Helper to, after atomic commit, wait for vblanks on all effected
1073 * crtcs (ie. before cleaning up old framebuffers using
1074 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1075 * framebuffers have actually changed to optimize for the legacy cursor and
1076 * plane update use-case.
1079 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
1080 struct drm_atomic_state
*old_state
)
1082 struct drm_crtc
*crtc
;
1083 struct drm_crtc_state
*old_crtc_state
;
1086 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1087 /* No one cares about the old state, so abuse it for tracking
1088 * and store whether we hold a vblank reference (and should do a
1089 * vblank wait) in the ->enable boolean. */
1090 old_crtc_state
->enable
= false;
1092 if (!crtc
->state
->enable
)
1095 /* Legacy cursor ioctls are completely unsynced, and userspace
1096 * relies on that (by doing tons of cursor updates). */
1097 if (old_state
->legacy_cursor_update
)
1100 if (!drm_atomic_helper_framebuffer_changed(dev
,
1104 ret
= drm_crtc_vblank_get(crtc
);
1108 old_crtc_state
->enable
= true;
1109 old_crtc_state
->last_vblank_count
= drm_crtc_vblank_count(crtc
);
1112 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1113 if (!old_crtc_state
->enable
)
1116 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
1117 old_crtc_state
->last_vblank_count
!=
1118 drm_crtc_vblank_count(crtc
),
1119 msecs_to_jiffies(50));
1121 WARN(!ret
, "[CRTC:%d] vblank wait timed out\n", crtc
->base
.id
);
1123 drm_crtc_vblank_put(crtc
);
1126 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
1129 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1130 * @state: new modeset state to be committed
1132 * This is the default implemenation for the ->atomic_commit_tail() hook of the
1133 * &drm_mode_config_helper_funcs vtable.
1135 * Note that the default ordering of how the various stages are called is to
1136 * match the legacy modeset helper library closest. One peculiarity of that is
1137 * that it doesn't mesh well with runtime PM at all.
1139 * For drivers supporting runtime PM the recommended sequence is instead ::
1141 * drm_atomic_helper_commit_modeset_disables(dev, state);
1143 * drm_atomic_helper_commit_modeset_enables(dev, state);
1145 * drm_atomic_helper_commit_planes(dev, state, true);
1147 * for committing the atomic update to hardware. See the kerneldoc entries for
1148 * these three functions for more details.
1150 void drm_atomic_helper_commit_tail(struct drm_atomic_state
*state
)
1152 struct drm_device
*dev
= state
->dev
;
1154 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1156 drm_atomic_helper_commit_planes(dev
, state
, false);
1158 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1160 drm_atomic_helper_commit_hw_done(state
);
1162 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1164 drm_atomic_helper_cleanup_planes(dev
, state
);
1166 EXPORT_SYMBOL(drm_atomic_helper_commit_tail
);
1168 static void commit_tail(struct drm_atomic_state
*state
)
1170 struct drm_device
*dev
= state
->dev
;
1171 struct drm_mode_config_helper_funcs
*funcs
;
1173 funcs
= dev
->mode_config
.helper_private
;
1175 drm_atomic_helper_wait_for_fences(dev
, state
);
1177 drm_atomic_helper_wait_for_dependencies(state
);
1179 if (funcs
&& funcs
->atomic_commit_tail
)
1180 funcs
->atomic_commit_tail(state
);
1182 drm_atomic_helper_commit_tail(state
);
1184 drm_atomic_helper_commit_cleanup_done(state
);
1186 drm_atomic_state_free(state
);
1189 static void commit_work(struct work_struct
*work
)
1191 struct drm_atomic_state
*state
= container_of(work
,
1192 struct drm_atomic_state
,
1198 * drm_atomic_helper_commit - commit validated state object
1200 * @state: the driver state object
1201 * @nonblock: whether nonblocking behavior is requested.
1203 * This function commits a with drm_atomic_helper_check() pre-validated state
1204 * object. This can still fail when e.g. the framebuffer reservation fails. This
1205 * function implements nonblocking commits, using
1206 * drm_atomic_helper_setup_commit() and related functions.
1208 * Note that right now this function does not support nonblocking commits, hence
1209 * driver writers must implement their own version for now.
1211 * Committing the actual hardware state is done through the
1212 * ->atomic_commit_tail() callback of the &drm_mode_config_helper_funcs vtable,
1213 * or it's default implementation drm_atomic_helper_commit_tail().
1216 * Zero for success or -errno.
1218 int drm_atomic_helper_commit(struct drm_device
*dev
,
1219 struct drm_atomic_state
*state
,
1224 ret
= drm_atomic_helper_setup_commit(state
, nonblock
);
1228 INIT_WORK(&state
->commit_work
, commit_work
);
1230 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
1235 * This is the point of no return - everything below never fails except
1236 * when the hw goes bonghits. Which means we can commit the new state on
1237 * the software side now.
1240 drm_atomic_helper_swap_state(state
, true);
1243 * Everything below can be run asynchronously without the need to grab
1244 * any modeset locks at all under one condition: It must be guaranteed
1245 * that the asynchronous work has either been cancelled (if the driver
1246 * supports it, which at least requires that the framebuffers get
1247 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1248 * before the new state gets committed on the software side with
1249 * drm_atomic_helper_swap_state().
1251 * This scheme allows new atomic state updates to be prepared and
1252 * checked in parallel to the asynchronous completion of the previous
1253 * update. Which is important since compositors need to figure out the
1254 * composition of the next frame right after having submitted the
1257 * NOTE: Commit work has multiple phases, first hardware commit, then
1258 * cleanup. We want them to overlap, hence need system_unbound_wq to
1259 * make sure work items don't artifically stall on each another.
1263 queue_work(system_unbound_wq
, &state
->commit_work
);
1269 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1272 * DOC: implementing nonblocking commit
1274 * Nonblocking atomic commits have to be implemented in the following sequence:
1276 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1277 * which commit needs to call which can fail, so we want to run it first and
1280 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1281 * might be affected the new state update. This can be done by either cancelling
1282 * or flushing the work items, depending upon whether the driver can deal with
1283 * cancelled updates. Note that it is important to ensure that the framebuffer
1284 * cleanup is still done when cancelling.
1286 * Asynchronous workers need to have sufficient parallelism to be able to run
1287 * different atomic commits on different CRTCs in parallel. The simplest way to
1288 * achive this is by running them on the &system_unbound_wq work queue. Note
1289 * that drivers are not required to split up atomic commits and run an
1290 * individual commit in parallel - userspace is supposed to do that if it cares.
1291 * But it might be beneficial to do that for modesets, since those necessarily
1292 * must be done as one global operation, and enabling or disabling a CRTC can
1293 * take a long time. But even that is not required.
1295 * 3. The software state is updated synchronously with
1296 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1297 * locks means concurrent callers never see inconsistent state. And doing this
1298 * while it's guaranteed that no relevant nonblocking worker runs means that
1299 * nonblocking workers do not need grab any locks. Actually they must not grab
1300 * locks, for otherwise the work flushing will deadlock.
1302 * 4. Schedule a work item to do all subsequent steps, using the split-out
1303 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1304 * then cleaning up the framebuffers after the old framebuffer is no longer
1307 * The above scheme is implemented in the atomic helper libraries in
1308 * drm_atomic_helper_commit() using a bunch of helper functions. See
1309 * drm_atomic_helper_setup_commit() for a starting point.
1312 static int stall_checks(struct drm_crtc
*crtc
, bool nonblock
)
1314 struct drm_crtc_commit
*commit
, *stall_commit
= NULL
;
1315 bool completed
= true;
1319 spin_lock(&crtc
->commit_lock
);
1321 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1323 completed
= try_wait_for_completion(&commit
->flip_done
);
1324 /* Userspace is not allowed to get ahead of the previous
1325 * commit with nonblocking ones. */
1326 if (!completed
&& nonblock
) {
1327 spin_unlock(&crtc
->commit_lock
);
1330 } else if (i
== 1) {
1331 stall_commit
= commit
;
1332 drm_crtc_commit_get(stall_commit
);
1338 spin_unlock(&crtc
->commit_lock
);
1343 /* We don't want to let commits get ahead of cleanup work too much,
1344 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1346 ret
= wait_for_completion_interruptible_timeout(&stall_commit
->cleanup_done
,
1349 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1350 crtc
->base
.id
, crtc
->name
);
1352 drm_crtc_commit_put(stall_commit
);
1354 return ret
< 0 ? ret
: 0;
1358 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1359 * @state: new modeset state to be committed
1360 * @nonblock: whether nonblocking behavior is requested.
1362 * This function prepares @state to be used by the atomic helper's support for
1363 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1364 * should always call this function from their ->atomic_commit hook.
1366 * To be able to use this support drivers need to use a few more helper
1367 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1368 * actually committing the hardware state, and for nonblocking commits this call
1369 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1370 * and it's stall parameter, for when a driver's commit hooks look at the
1371 * ->state pointers of struct &drm_crtc, &drm_plane or &drm_connector directly.
1373 * Completion of the hardware commit step must be signalled using
1374 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1375 * to read or change any permanent software or hardware modeset state. The only
1376 * exception is state protected by other means than &drm_modeset_lock locks.
1377 * Only the free standing @state with pointers to the old state structures can
1378 * be inspected, e.g. to clean up old buffers using
1379 * drm_atomic_helper_cleanup_planes().
1381 * At the very end, before cleaning up @state drivers must call
1382 * drm_atomic_helper_commit_cleanup_done().
1384 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1385 * complete and esay-to-use default implementation of the atomic_commit() hook.
1387 * The tracking of asynchronously executed and still pending commits is done
1388 * using the core structure &drm_crtc_commit.
1390 * By default there's no need to clean up resources allocated by this function
1391 * explicitly: drm_atomic_state_default_clear() will take care of that
1396 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1397 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1399 int drm_atomic_helper_setup_commit(struct drm_atomic_state
*state
,
1402 struct drm_crtc
*crtc
;
1403 struct drm_crtc_state
*crtc_state
;
1404 struct drm_crtc_commit
*commit
;
1407 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1408 commit
= kzalloc(sizeof(*commit
), GFP_KERNEL
);
1412 init_completion(&commit
->flip_done
);
1413 init_completion(&commit
->hw_done
);
1414 init_completion(&commit
->cleanup_done
);
1415 INIT_LIST_HEAD(&commit
->commit_entry
);
1416 kref_init(&commit
->ref
);
1417 commit
->crtc
= crtc
;
1419 state
->crtcs
[i
].commit
= commit
;
1421 ret
= stall_checks(crtc
, nonblock
);
1425 /* Drivers only send out events when at least either current or
1426 * new CRTC state is active. Complete right away if everything
1428 if (!crtc
->state
->active
&& !crtc_state
->active
) {
1429 complete_all(&commit
->flip_done
);
1433 /* Legacy cursor updates are fully unsynced. */
1434 if (state
->legacy_cursor_update
) {
1435 complete_all(&commit
->flip_done
);
1439 if (!crtc_state
->event
) {
1440 commit
->event
= kzalloc(sizeof(*commit
->event
),
1445 crtc_state
->event
= commit
->event
;
1448 crtc_state
->event
->base
.completion
= &commit
->flip_done
;
1453 EXPORT_SYMBOL(drm_atomic_helper_setup_commit
);
1456 static struct drm_crtc_commit
*preceeding_commit(struct drm_crtc
*crtc
)
1458 struct drm_crtc_commit
*commit
;
1461 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1462 /* skip the first entry, that's the current commit */
1472 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1473 * @state: new modeset state to be committed
1475 * This function waits for all preceeding commits that touch the same CRTC as
1476 * @state to both be committed to the hardware (as signalled by
1477 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1478 * by calling drm_crtc_vblank_send_event on the event member of
1481 * This is part of the atomic helper support for nonblocking commits, see
1482 * drm_atomic_helper_setup_commit() for an overview.
1484 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state
*state
)
1486 struct drm_crtc
*crtc
;
1487 struct drm_crtc_state
*crtc_state
;
1488 struct drm_crtc_commit
*commit
;
1492 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1493 spin_lock(&crtc
->commit_lock
);
1494 commit
= preceeding_commit(crtc
);
1496 drm_crtc_commit_get(commit
);
1497 spin_unlock(&crtc
->commit_lock
);
1502 ret
= wait_for_completion_timeout(&commit
->hw_done
,
1505 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1506 crtc
->base
.id
, crtc
->name
);
1508 /* Currently no support for overwriting flips, hence
1509 * stall for previous one to execute completely. */
1510 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1513 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1514 crtc
->base
.id
, crtc
->name
);
1516 drm_crtc_commit_put(commit
);
1519 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies
);
1522 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1523 * @state: new modeset state to be committed
1525 * This function is used to signal completion of the hardware commit step. After
1526 * this step the driver is not allowed to read or change any permanent software
1527 * or hardware modeset state. The only exception is state protected by other
1528 * means than &drm_modeset_lock locks.
1530 * Drivers should try to postpone any expensive or delayed cleanup work after
1531 * this function is called.
1533 * This is part of the atomic helper support for nonblocking commits, see
1534 * drm_atomic_helper_setup_commit() for an overview.
1536 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state
*state
)
1538 struct drm_crtc
*crtc
;
1539 struct drm_crtc_state
*crtc_state
;
1540 struct drm_crtc_commit
*commit
;
1543 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1544 commit
= state
->crtcs
[i
].commit
;
1548 /* backend must have consumed any event by now */
1549 WARN_ON(crtc
->state
->event
);
1550 spin_lock(&crtc
->commit_lock
);
1551 complete_all(&commit
->hw_done
);
1552 spin_unlock(&crtc
->commit_lock
);
1555 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done
);
1558 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1559 * @state: new modeset state to be committed
1561 * This signals completion of the atomic update @state, including any cleanup
1562 * work. If used, it must be called right before calling
1563 * drm_atomic_state_free().
1565 * This is part of the atomic helper support for nonblocking commits, see
1566 * drm_atomic_helper_setup_commit() for an overview.
1568 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state
*state
)
1570 struct drm_crtc
*crtc
;
1571 struct drm_crtc_state
*crtc_state
;
1572 struct drm_crtc_commit
*commit
;
1576 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1577 commit
= state
->crtcs
[i
].commit
;
1578 if (WARN_ON(!commit
))
1581 spin_lock(&crtc
->commit_lock
);
1582 complete_all(&commit
->cleanup_done
);
1583 WARN_ON(!try_wait_for_completion(&commit
->hw_done
));
1585 /* commit_list borrows our reference, need to remove before we
1586 * clean up our drm_atomic_state. But only after it actually
1587 * completed, otherwise subsequent commits won't stall properly. */
1588 if (try_wait_for_completion(&commit
->flip_done
))
1591 spin_unlock(&crtc
->commit_lock
);
1593 /* We must wait for the vblank event to signal our completion
1594 * before releasing our reference, since the vblank work does
1595 * not hold a reference of its own. */
1596 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1599 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1600 crtc
->base
.id
, crtc
->name
);
1602 spin_lock(&crtc
->commit_lock
);
1604 list_del(&commit
->commit_entry
);
1605 spin_unlock(&crtc
->commit_lock
);
1608 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done
);
1611 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1613 * @state: atomic state object with new state structures
1615 * This function prepares plane state, specifically framebuffers, for the new
1616 * configuration. If any failure is encountered this function will call
1617 * ->cleanup_fb on any already successfully prepared framebuffer.
1620 * 0 on success, negative error code on failure.
1622 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1623 struct drm_atomic_state
*state
)
1625 struct drm_plane
*plane
;
1626 struct drm_plane_state
*plane_state
;
1629 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1630 const struct drm_plane_helper_funcs
*funcs
;
1632 funcs
= plane
->helper_private
;
1634 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1637 if (funcs
->prepare_fb
) {
1638 ret
= funcs
->prepare_fb(plane
, plane_state
);
1647 for_each_plane_in_state(state
, plane
, plane_state
, j
) {
1648 const struct drm_plane_helper_funcs
*funcs
;
1653 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1656 funcs
= plane
->helper_private
;
1658 if (funcs
->cleanup_fb
)
1659 funcs
->cleanup_fb(plane
, plane_state
);
1664 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1666 bool plane_crtc_active(struct drm_plane_state
*state
)
1668 return state
->crtc
&& state
->crtc
->state
->active
;
1672 * drm_atomic_helper_commit_planes - commit plane state
1674 * @old_state: atomic state object with old state structures
1675 * @active_only: Only commit on active CRTC if set
1677 * This function commits the new plane state using the plane and atomic helper
1678 * functions for planes and crtcs. It assumes that the atomic state has already
1679 * been pushed into the relevant object state pointers, since this step can no
1682 * It still requires the global state object @old_state to know which planes and
1683 * crtcs need to be updated though.
1685 * Note that this function does all plane updates across all CRTCs in one step.
1686 * If the hardware can't support this approach look at
1687 * drm_atomic_helper_commit_planes_on_crtc() instead.
1689 * Plane parameters can be updated by applications while the associated CRTC is
1690 * disabled. The DRM/KMS core will store the parameters in the plane state,
1691 * which will be available to the driver when the CRTC is turned on. As a result
1692 * most drivers don't need to be immediately notified of plane updates for a
1695 * Unless otherwise needed, drivers are advised to set the @active_only
1696 * parameters to true in order not to receive plane update notifications related
1697 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1698 * driver code when the driver and/or hardware can't or just don't need to deal
1699 * with updates on disabled CRTCs, for example when supporting runtime PM.
1701 * The drm_atomic_helper_commit() default implementation only sets @active_only
1702 * to false to most closely match the behaviour of the legacy helpers. This should
1703 * not be copied blindly by drivers.
1705 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1706 struct drm_atomic_state
*old_state
,
1709 struct drm_crtc
*crtc
;
1710 struct drm_crtc_state
*old_crtc_state
;
1711 struct drm_plane
*plane
;
1712 struct drm_plane_state
*old_plane_state
;
1715 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1716 const struct drm_crtc_helper_funcs
*funcs
;
1718 funcs
= crtc
->helper_private
;
1720 if (!funcs
|| !funcs
->atomic_begin
)
1723 if (active_only
&& !crtc
->state
->active
)
1726 funcs
->atomic_begin(crtc
, old_crtc_state
);
1729 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1730 const struct drm_plane_helper_funcs
*funcs
;
1733 funcs
= plane
->helper_private
;
1738 disabling
= drm_atomic_plane_disabling(plane
, old_plane_state
);
1742 * Skip planes related to inactive CRTCs. If the plane
1743 * is enabled use the state of the current CRTC. If the
1744 * plane is being disabled use the state of the old
1745 * CRTC to avoid skipping planes being disabled on an
1748 if (!disabling
&& !plane_crtc_active(plane
->state
))
1750 if (disabling
&& !plane_crtc_active(old_plane_state
))
1755 * Special-case disabling the plane if drivers support it.
1757 if (disabling
&& funcs
->atomic_disable
)
1758 funcs
->atomic_disable(plane
, old_plane_state
);
1759 else if (plane
->state
->crtc
|| disabling
)
1760 funcs
->atomic_update(plane
, old_plane_state
);
1763 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1764 const struct drm_crtc_helper_funcs
*funcs
;
1766 funcs
= crtc
->helper_private
;
1768 if (!funcs
|| !funcs
->atomic_flush
)
1771 if (active_only
&& !crtc
->state
->active
)
1774 funcs
->atomic_flush(crtc
, old_crtc_state
);
1777 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1780 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1781 * @old_crtc_state: atomic state object with the old crtc state
1783 * This function commits the new plane state using the plane and atomic helper
1784 * functions for planes on the specific crtc. It assumes that the atomic state
1785 * has already been pushed into the relevant object state pointers, since this
1786 * step can no longer fail.
1788 * This function is useful when plane updates should be done crtc-by-crtc
1789 * instead of one global step like drm_atomic_helper_commit_planes() does.
1791 * This function can only be savely used when planes are not allowed to move
1792 * between different CRTCs because this function doesn't handle inter-CRTC
1793 * depencies. Callers need to ensure that either no such depencies exist,
1794 * resolve them through ordering of commit calls or through some other means.
1797 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1799 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1800 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1801 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1802 struct drm_plane
*plane
;
1803 unsigned plane_mask
;
1805 plane_mask
= old_crtc_state
->plane_mask
;
1806 plane_mask
|= crtc
->state
->plane_mask
;
1808 crtc_funcs
= crtc
->helper_private
;
1809 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1810 crtc_funcs
->atomic_begin(crtc
, old_crtc_state
);
1812 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1813 struct drm_plane_state
*old_plane_state
=
1814 drm_atomic_get_existing_plane_state(old_state
, plane
);
1815 const struct drm_plane_helper_funcs
*plane_funcs
;
1817 plane_funcs
= plane
->helper_private
;
1819 if (!old_plane_state
|| !plane_funcs
)
1822 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1824 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1825 plane_funcs
->atomic_disable
)
1826 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1827 else if (plane
->state
->crtc
||
1828 drm_atomic_plane_disabling(plane
, old_plane_state
))
1829 plane_funcs
->atomic_update(plane
, old_plane_state
);
1832 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1833 crtc_funcs
->atomic_flush(crtc
, old_crtc_state
);
1835 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1838 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1840 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1842 * Disables all planes associated with the given CRTC. This can be
1843 * used for instance in the CRTC helper disable callback to disable
1844 * all planes before shutting down the display pipeline.
1846 * If the atomic-parameter is set the function calls the CRTC's
1847 * atomic_begin hook before and atomic_flush hook after disabling the
1850 * It is a bug to call this function without having implemented the
1851 * ->atomic_disable() plane hook.
1853 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc
*crtc
,
1856 const struct drm_crtc_helper_funcs
*crtc_funcs
=
1857 crtc
->helper_private
;
1858 struct drm_plane
*plane
;
1860 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_begin
)
1861 crtc_funcs
->atomic_begin(crtc
, NULL
);
1863 drm_for_each_plane(plane
, crtc
->dev
) {
1864 const struct drm_plane_helper_funcs
*plane_funcs
=
1865 plane
->helper_private
;
1867 if (plane
->state
->crtc
!= crtc
|| !plane_funcs
)
1870 WARN_ON(!plane_funcs
->atomic_disable
);
1871 if (plane_funcs
->atomic_disable
)
1872 plane_funcs
->atomic_disable(plane
, NULL
);
1875 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_flush
)
1876 crtc_funcs
->atomic_flush(crtc
, NULL
);
1878 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc
);
1881 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1883 * @old_state: atomic state object with old state structures
1885 * This function cleans up plane state, specifically framebuffers, from the old
1886 * configuration. Hence the old configuration must be perserved in @old_state to
1887 * be able to call this function.
1889 * This function must also be called on the new state when the atomic update
1890 * fails at any point after calling drm_atomic_helper_prepare_planes().
1892 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1893 struct drm_atomic_state
*old_state
)
1895 struct drm_plane
*plane
;
1896 struct drm_plane_state
*plane_state
;
1899 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1900 const struct drm_plane_helper_funcs
*funcs
;
1902 if (!drm_atomic_helper_framebuffer_changed(dev
, old_state
, plane_state
->crtc
))
1905 funcs
= plane
->helper_private
;
1907 if (funcs
->cleanup_fb
)
1908 funcs
->cleanup_fb(plane
, plane_state
);
1911 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1914 * drm_atomic_helper_swap_state - store atomic state into current sw state
1915 * @state: atomic state
1916 * @stall: stall for proceeding commits
1918 * This function stores the atomic state into the current state pointers in all
1919 * driver objects. It should be called after all failing steps have been done
1920 * and succeeded, but before the actual hardware state is committed.
1922 * For cleanup and error recovery the current state for all changed objects will
1923 * be swaped into @state.
1925 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1927 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1929 * 2. Do any other steps that might fail.
1931 * 3. Put the staged state into the current state pointers with this function.
1933 * 4. Actually commit the hardware state.
1935 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1936 * contains the old state. Also do any other cleanup required with that state.
1938 * @stall must be set when nonblocking commits for this driver directly access
1939 * the ->state pointer of &drm_plane, &drm_crtc or &drm_connector. With the
1940 * current atomic helpers this is almost always the case, since the helpers
1941 * don't pass the right state structures to the callbacks.
1943 void drm_atomic_helper_swap_state(struct drm_atomic_state
*state
,
1948 struct drm_connector
*connector
;
1949 struct drm_connector_state
*conn_state
;
1950 struct drm_crtc
*crtc
;
1951 struct drm_crtc_state
*crtc_state
;
1952 struct drm_plane
*plane
;
1953 struct drm_plane_state
*plane_state
;
1954 struct drm_crtc_commit
*commit
;
1957 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1958 spin_lock(&crtc
->commit_lock
);
1959 commit
= list_first_entry_or_null(&crtc
->commit_list
,
1960 struct drm_crtc_commit
, commit_entry
);
1962 drm_crtc_commit_get(commit
);
1963 spin_unlock(&crtc
->commit_lock
);
1968 ret
= wait_for_completion_timeout(&commit
->hw_done
,
1971 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1972 crtc
->base
.id
, crtc
->name
);
1973 drm_crtc_commit_put(commit
);
1977 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
1978 connector
->state
->state
= state
;
1979 swap(state
->connectors
[i
].state
, connector
->state
);
1980 connector
->state
->state
= NULL
;
1983 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1984 crtc
->state
->state
= state
;
1985 swap(state
->crtcs
[i
].state
, crtc
->state
);
1986 crtc
->state
->state
= NULL
;
1988 if (state
->crtcs
[i
].commit
) {
1989 spin_lock(&crtc
->commit_lock
);
1990 list_add(&state
->crtcs
[i
].commit
->commit_entry
,
1991 &crtc
->commit_list
);
1992 spin_unlock(&crtc
->commit_lock
);
1994 state
->crtcs
[i
].commit
->event
= NULL
;
1998 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1999 plane
->state
->state
= state
;
2000 swap(state
->planes
[i
].state
, plane
->state
);
2001 plane
->state
->state
= NULL
;
2004 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
2007 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2008 * @plane: plane object to update
2009 * @crtc: owning CRTC of owning plane
2010 * @fb: framebuffer to flip onto plane
2011 * @crtc_x: x offset of primary plane on crtc
2012 * @crtc_y: y offset of primary plane on crtc
2013 * @crtc_w: width of primary plane rectangle on crtc
2014 * @crtc_h: height of primary plane rectangle on crtc
2015 * @src_x: x offset of @fb for panning
2016 * @src_y: y offset of @fb for panning
2017 * @src_w: width of source rectangle in @fb
2018 * @src_h: height of source rectangle in @fb
2020 * Provides a default plane update handler using the atomic driver interface.
2023 * Zero on success, error code on failure
2025 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
2026 struct drm_crtc
*crtc
,
2027 struct drm_framebuffer
*fb
,
2028 int crtc_x
, int crtc_y
,
2029 unsigned int crtc_w
, unsigned int crtc_h
,
2030 uint32_t src_x
, uint32_t src_y
,
2031 uint32_t src_w
, uint32_t src_h
)
2033 struct drm_atomic_state
*state
;
2034 struct drm_plane_state
*plane_state
;
2037 state
= drm_atomic_state_alloc(plane
->dev
);
2041 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2043 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2044 if (IS_ERR(plane_state
)) {
2045 ret
= PTR_ERR(plane_state
);
2049 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2052 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2053 plane_state
->crtc_x
= crtc_x
;
2054 plane_state
->crtc_y
= crtc_y
;
2055 plane_state
->crtc_w
= crtc_w
;
2056 plane_state
->crtc_h
= crtc_h
;
2057 plane_state
->src_x
= src_x
;
2058 plane_state
->src_y
= src_y
;
2059 plane_state
->src_w
= src_w
;
2060 plane_state
->src_h
= src_h
;
2062 if (plane
== crtc
->cursor
)
2063 state
->legacy_cursor_update
= true;
2065 ret
= drm_atomic_commit(state
);
2069 /* Driver takes ownership of state on successful commit. */
2072 if (ret
== -EDEADLK
)
2075 drm_atomic_state_free(state
);
2079 drm_atomic_state_clear(state
);
2080 drm_atomic_legacy_backoff(state
);
2083 * Someone might have exchanged the framebuffer while we dropped locks
2084 * in the backoff code. We need to fix up the fb refcount tracking the
2087 plane
->old_fb
= plane
->fb
;
2091 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
2094 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2095 * @plane: plane to disable
2097 * Provides a default plane disable handler using the atomic driver interface.
2100 * Zero on success, error code on failure
2102 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
2104 struct drm_atomic_state
*state
;
2105 struct drm_plane_state
*plane_state
;
2109 * FIXME: Without plane->crtc set we can't get at the implicit legacy
2110 * acquire context. The real fix will be to wire the acquire ctx through
2111 * everywhere we need it, but meanwhile prevent chaos by just skipping
2112 * this noop. The critical case is the cursor ioctls which a) only grab
2113 * crtc/cursor-plane locks (so we need the crtc to get at the right
2114 * acquire context) and b) can try to disable the plane multiple times.
2119 state
= drm_atomic_state_alloc(plane
->dev
);
2123 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
2125 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2126 if (IS_ERR(plane_state
)) {
2127 ret
= PTR_ERR(plane_state
);
2131 if (plane_state
->crtc
&& (plane
== plane
->crtc
->cursor
))
2132 plane_state
->state
->legacy_cursor_update
= true;
2134 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
2138 ret
= drm_atomic_commit(state
);
2142 /* Driver takes ownership of state on successful commit. */
2145 if (ret
== -EDEADLK
)
2148 drm_atomic_state_free(state
);
2152 drm_atomic_state_clear(state
);
2153 drm_atomic_legacy_backoff(state
);
2156 * Someone might have exchanged the framebuffer while we dropped locks
2157 * in the backoff code. We need to fix up the fb refcount tracking the
2160 plane
->old_fb
= plane
->fb
;
2164 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
2166 /* just used from fb-helper and atomic-helper: */
2167 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
2168 struct drm_plane_state
*plane_state
)
2172 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
2176 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
2177 plane_state
->crtc_x
= 0;
2178 plane_state
->crtc_y
= 0;
2179 plane_state
->crtc_w
= 0;
2180 plane_state
->crtc_h
= 0;
2181 plane_state
->src_x
= 0;
2182 plane_state
->src_y
= 0;
2183 plane_state
->src_w
= 0;
2184 plane_state
->src_h
= 0;
2189 static int update_output_state(struct drm_atomic_state
*state
,
2190 struct drm_mode_set
*set
)
2192 struct drm_device
*dev
= set
->crtc
->dev
;
2193 struct drm_crtc
*crtc
;
2194 struct drm_crtc_state
*crtc_state
;
2195 struct drm_connector
*connector
;
2196 struct drm_connector_state
*conn_state
;
2199 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
2200 state
->acquire_ctx
);
2204 /* First disable all connectors on the target crtc. */
2205 ret
= drm_atomic_add_affected_connectors(state
, set
->crtc
);
2209 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
2210 if (conn_state
->crtc
== set
->crtc
) {
2211 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2218 /* Then set all connectors from set->connectors on the target crtc */
2219 for (i
= 0; i
< set
->num_connectors
; i
++) {
2220 conn_state
= drm_atomic_get_connector_state(state
,
2221 set
->connectors
[i
]);
2222 if (IS_ERR(conn_state
))
2223 return PTR_ERR(conn_state
);
2225 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2231 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2232 /* Don't update ->enable for the CRTC in the set_config request,
2233 * since a mismatch would indicate a bug in the upper layers.
2234 * The actual modeset code later on will catch any
2235 * inconsistencies here. */
2236 if (crtc
== set
->crtc
)
2239 if (!crtc_state
->connector_mask
) {
2240 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
2245 crtc_state
->active
= false;
2253 * drm_atomic_helper_set_config - set a new config from userspace
2254 * @set: mode set configuration
2256 * Provides a default crtc set_config handler using the atomic driver interface.
2259 * Returns 0 on success, negative errno numbers on failure.
2261 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
2263 struct drm_atomic_state
*state
;
2264 struct drm_crtc
*crtc
= set
->crtc
;
2267 state
= drm_atomic_state_alloc(crtc
->dev
);
2271 state
->legacy_set_config
= true;
2272 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2274 ret
= __drm_atomic_helper_set_config(set
, state
);
2278 ret
= drm_atomic_commit(state
);
2282 /* Driver takes ownership of state on successful commit. */
2285 if (ret
== -EDEADLK
)
2288 drm_atomic_state_free(state
);
2292 drm_atomic_state_clear(state
);
2293 drm_atomic_legacy_backoff(state
);
2296 * Someone might have exchanged the framebuffer while we dropped locks
2297 * in the backoff code. We need to fix up the fb refcount tracking the
2300 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
2304 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
2306 /* just used from fb-helper and atomic-helper: */
2307 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
2308 struct drm_atomic_state
*state
)
2310 struct drm_crtc_state
*crtc_state
;
2311 struct drm_plane_state
*primary_state
;
2312 struct drm_crtc
*crtc
= set
->crtc
;
2313 int hdisplay
, vdisplay
;
2316 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2317 if (IS_ERR(crtc_state
))
2318 return PTR_ERR(crtc_state
);
2320 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
2321 if (IS_ERR(primary_state
))
2322 return PTR_ERR(primary_state
);
2326 WARN_ON(set
->num_connectors
);
2328 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
2332 crtc_state
->active
= false;
2334 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
2338 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
2344 WARN_ON(!set
->num_connectors
);
2346 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
2350 crtc_state
->active
= true;
2352 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
2356 drm_crtc_get_hv_timing(set
->mode
, &hdisplay
, &vdisplay
);
2358 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
2359 primary_state
->crtc_x
= 0;
2360 primary_state
->crtc_y
= 0;
2361 primary_state
->crtc_w
= hdisplay
;
2362 primary_state
->crtc_h
= vdisplay
;
2363 primary_state
->src_x
= set
->x
<< 16;
2364 primary_state
->src_y
= set
->y
<< 16;
2365 if (primary_state
->rotation
& (BIT(DRM_ROTATE_90
) | BIT(DRM_ROTATE_270
))) {
2366 primary_state
->src_w
= vdisplay
<< 16;
2367 primary_state
->src_h
= hdisplay
<< 16;
2369 primary_state
->src_w
= hdisplay
<< 16;
2370 primary_state
->src_h
= vdisplay
<< 16;
2374 ret
= update_output_state(state
, set
);
2382 * drm_atomic_helper_disable_all - disable all currently active outputs
2384 * @ctx: lock acquisition context
2386 * Loops through all connectors, finding those that aren't turned off and then
2387 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2388 * that they are connected to.
2390 * This is used for example in suspend/resume to disable all currently active
2391 * functions when suspending.
2393 * Note that if callers haven't already acquired all modeset locks this might
2394 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2397 * 0 on success or a negative error code on failure.
2400 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2402 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
2403 struct drm_modeset_acquire_ctx
*ctx
)
2405 struct drm_atomic_state
*state
;
2406 struct drm_connector
*conn
;
2409 state
= drm_atomic_state_alloc(dev
);
2413 state
->acquire_ctx
= ctx
;
2415 drm_for_each_connector(conn
, dev
) {
2416 struct drm_crtc
*crtc
= conn
->state
->crtc
;
2417 struct drm_crtc_state
*crtc_state
;
2419 if (!crtc
|| conn
->dpms
!= DRM_MODE_DPMS_ON
)
2422 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2423 if (IS_ERR(crtc_state
)) {
2424 err
= PTR_ERR(crtc_state
);
2428 crtc_state
->active
= false;
2431 err
= drm_atomic_commit(state
);
2435 drm_atomic_state_free(state
);
2439 EXPORT_SYMBOL(drm_atomic_helper_disable_all
);
2442 * drm_atomic_helper_suspend - subsystem-level suspend helper
2445 * Duplicates the current atomic state, disables all active outputs and then
2446 * returns a pointer to the original atomic state to the caller. Drivers can
2447 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2448 * restore the output configuration that was active at the time the system
2451 * Note that it is potentially unsafe to use this. The atomic state object
2452 * returned by this function is assumed to be persistent. Drivers must ensure
2453 * that this holds true. Before calling this function, drivers must make sure
2454 * to suspend fbdev emulation so that nothing can be using the device.
2457 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2458 * encoded error code on failure. Drivers should store the returned atomic
2459 * state object and pass it to the drm_atomic_helper_resume() helper upon
2463 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2464 * drm_atomic_helper_resume()
2466 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
)
2468 struct drm_modeset_acquire_ctx ctx
;
2469 struct drm_atomic_state
*state
;
2472 drm_modeset_acquire_init(&ctx
, 0);
2475 err
= drm_modeset_lock_all_ctx(dev
, &ctx
);
2477 state
= ERR_PTR(err
);
2481 state
= drm_atomic_helper_duplicate_state(dev
, &ctx
);
2485 err
= drm_atomic_helper_disable_all(dev
, &ctx
);
2487 drm_atomic_state_free(state
);
2488 state
= ERR_PTR(err
);
2493 if (PTR_ERR(state
) == -EDEADLK
) {
2494 drm_modeset_backoff(&ctx
);
2498 drm_modeset_drop_locks(&ctx
);
2499 drm_modeset_acquire_fini(&ctx
);
2502 EXPORT_SYMBOL(drm_atomic_helper_suspend
);
2505 * drm_atomic_helper_resume - subsystem-level resume helper
2507 * @state: atomic state to resume to
2509 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2510 * grabs all modeset locks and commits the atomic state object. This can be
2511 * used in conjunction with the drm_atomic_helper_suspend() helper to
2512 * implement suspend/resume for drivers that support atomic mode-setting.
2515 * 0 on success or a negative error code on failure.
2518 * drm_atomic_helper_suspend()
2520 int drm_atomic_helper_resume(struct drm_device
*dev
,
2521 struct drm_atomic_state
*state
)
2523 struct drm_mode_config
*config
= &dev
->mode_config
;
2526 drm_mode_config_reset(dev
);
2527 drm_modeset_lock_all(dev
);
2528 state
->acquire_ctx
= config
->acquire_ctx
;
2529 err
= drm_atomic_commit(state
);
2530 drm_modeset_unlock_all(dev
);
2534 EXPORT_SYMBOL(drm_atomic_helper_resume
);
2537 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2539 * @property: DRM property
2540 * @val: value of property
2542 * Provides a default crtc set_property handler using the atomic driver
2546 * Zero on success, error code on failure
2549 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
2550 struct drm_property
*property
,
2553 struct drm_atomic_state
*state
;
2554 struct drm_crtc_state
*crtc_state
;
2557 state
= drm_atomic_state_alloc(crtc
->dev
);
2561 /* ->set_property is always called with all locks held. */
2562 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2564 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2565 if (IS_ERR(crtc_state
)) {
2566 ret
= PTR_ERR(crtc_state
);
2570 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2575 ret
= drm_atomic_commit(state
);
2579 /* Driver takes ownership of state on successful commit. */
2582 if (ret
== -EDEADLK
)
2585 drm_atomic_state_free(state
);
2589 drm_atomic_state_clear(state
);
2590 drm_atomic_legacy_backoff(state
);
2594 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
2597 * drm_atomic_helper_plane_set_property - helper for plane properties
2599 * @property: DRM property
2600 * @val: value of property
2602 * Provides a default plane set_property handler using the atomic driver
2606 * Zero on success, error code on failure
2609 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
2610 struct drm_property
*property
,
2613 struct drm_atomic_state
*state
;
2614 struct drm_plane_state
*plane_state
;
2617 state
= drm_atomic_state_alloc(plane
->dev
);
2621 /* ->set_property is always called with all locks held. */
2622 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
2624 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2625 if (IS_ERR(plane_state
)) {
2626 ret
= PTR_ERR(plane_state
);
2630 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
2635 ret
= drm_atomic_commit(state
);
2639 /* Driver takes ownership of state on successful commit. */
2642 if (ret
== -EDEADLK
)
2645 drm_atomic_state_free(state
);
2649 drm_atomic_state_clear(state
);
2650 drm_atomic_legacy_backoff(state
);
2654 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
2657 * drm_atomic_helper_connector_set_property - helper for connector properties
2658 * @connector: DRM connector
2659 * @property: DRM property
2660 * @val: value of property
2662 * Provides a default connector set_property handler using the atomic driver
2666 * Zero on success, error code on failure
2669 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
2670 struct drm_property
*property
,
2673 struct drm_atomic_state
*state
;
2674 struct drm_connector_state
*connector_state
;
2677 state
= drm_atomic_state_alloc(connector
->dev
);
2681 /* ->set_property is always called with all locks held. */
2682 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
2684 connector_state
= drm_atomic_get_connector_state(state
, connector
);
2685 if (IS_ERR(connector_state
)) {
2686 ret
= PTR_ERR(connector_state
);
2690 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
2695 ret
= drm_atomic_commit(state
);
2699 /* Driver takes ownership of state on successful commit. */
2702 if (ret
== -EDEADLK
)
2705 drm_atomic_state_free(state
);
2709 drm_atomic_state_clear(state
);
2710 drm_atomic_legacy_backoff(state
);
2714 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
2717 * drm_atomic_helper_page_flip - execute a legacy page flip
2719 * @fb: DRM framebuffer
2720 * @event: optional DRM event to signal upon completion
2721 * @flags: flip flags for non-vblank sync'ed updates
2723 * Provides a default page flip implementation using the atomic driver interface.
2725 * Note that for now so called async page flips (i.e. updates which are not
2726 * synchronized to vblank) are not supported, since the atomic interfaces have
2727 * no provisions for this yet.
2730 * Returns 0 on success, negative errno numbers on failure.
2732 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
2733 struct drm_framebuffer
*fb
,
2734 struct drm_pending_vblank_event
*event
,
2737 struct drm_plane
*plane
= crtc
->primary
;
2738 struct drm_atomic_state
*state
;
2739 struct drm_plane_state
*plane_state
;
2740 struct drm_crtc_state
*crtc_state
;
2743 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
2746 state
= drm_atomic_state_alloc(plane
->dev
);
2750 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2752 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2753 if (IS_ERR(crtc_state
)) {
2754 ret
= PTR_ERR(crtc_state
);
2757 crtc_state
->event
= event
;
2759 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2760 if (IS_ERR(plane_state
)) {
2761 ret
= PTR_ERR(plane_state
);
2765 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2768 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2770 /* Make sure we don't accidentally do a full modeset. */
2771 state
->allow_modeset
= false;
2772 if (!crtc_state
->active
) {
2773 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2779 ret
= drm_atomic_nonblocking_commit(state
);
2783 /* Driver takes ownership of state on successful commit. */
2786 if (ret
== -EDEADLK
)
2789 drm_atomic_state_free(state
);
2793 drm_atomic_state_clear(state
);
2794 drm_atomic_legacy_backoff(state
);
2797 * Someone might have exchanged the framebuffer while we dropped locks
2798 * in the backoff code. We need to fix up the fb refcount tracking the
2801 plane
->old_fb
= plane
->fb
;
2805 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
2808 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2809 * @connector: affected connector
2812 * This is the main helper function provided by the atomic helper framework for
2813 * implementing the legacy DPMS connector interface. It computes the new desired
2814 * ->active state for the corresponding CRTC (if the connector is enabled) and
2818 * Returns 0 on success, negative errno numbers on failure.
2820 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
2823 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
2824 struct drm_atomic_state
*state
;
2825 struct drm_crtc_state
*crtc_state
;
2826 struct drm_crtc
*crtc
;
2827 struct drm_connector
*tmp_connector
;
2829 bool active
= false;
2830 int old_mode
= connector
->dpms
;
2832 if (mode
!= DRM_MODE_DPMS_ON
)
2833 mode
= DRM_MODE_DPMS_OFF
;
2835 connector
->dpms
= mode
;
2836 crtc
= connector
->state
->crtc
;
2841 state
= drm_atomic_state_alloc(connector
->dev
);
2845 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2847 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2848 if (IS_ERR(crtc_state
)) {
2849 ret
= PTR_ERR(crtc_state
);
2853 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
2855 drm_for_each_connector(tmp_connector
, connector
->dev
) {
2856 if (tmp_connector
->state
->crtc
!= crtc
)
2859 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2864 crtc_state
->active
= active
;
2866 ret
= drm_atomic_commit(state
);
2870 /* Driver takes ownership of state on successful commit. */
2873 if (ret
== -EDEADLK
)
2876 connector
->dpms
= old_mode
;
2877 drm_atomic_state_free(state
);
2881 drm_atomic_state_clear(state
);
2882 drm_atomic_legacy_backoff(state
);
2886 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2889 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2890 * ->best_encoder callback
2891 * @connector: Connector control structure
2893 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2894 * connectors that support exactly 1 encoder, statically determined at driver
2897 struct drm_encoder
*
2898 drm_atomic_helper_best_encoder(struct drm_connector
*connector
)
2900 WARN_ON(connector
->encoder_ids
[1]);
2901 return drm_encoder_find(connector
->dev
, connector
->encoder_ids
[0]);
2903 EXPORT_SYMBOL(drm_atomic_helper_best_encoder
);
2906 * DOC: atomic state reset and initialization
2908 * Both the drm core and the atomic helpers assume that there is always the full
2909 * and correct atomic software state for all connectors, CRTCs and planes
2910 * available. Which is a bit a problem on driver load and also after system
2911 * suspend. One way to solve this is to have a hardware state read-out
2912 * infrastructure which reconstructs the full software state (e.g. the i915
2915 * The simpler solution is to just reset the software state to everything off,
2916 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2917 * the atomic helpers provide default reset implementations for all hooks.
2919 * On the upside the precise state tracking of atomic simplifies system suspend
2920 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2921 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2922 * For other drivers the building blocks are split out, see the documentation
2923 * for these functions.
2927 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2930 * Resets the atomic state for @crtc by freeing the state pointer (which might
2931 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2933 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2936 __drm_atomic_helper_crtc_destroy_state(crtc
->state
);
2939 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2942 crtc
->state
->crtc
= crtc
;
2944 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2947 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2948 * @crtc: CRTC object
2949 * @state: atomic CRTC state
2951 * Copies atomic state from a CRTC's current state and resets inferred values.
2952 * This is useful for drivers that subclass the CRTC state.
2954 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
2955 struct drm_crtc_state
*state
)
2957 memcpy(state
, crtc
->state
, sizeof(*state
));
2959 if (state
->mode_blob
)
2960 drm_property_reference_blob(state
->mode_blob
);
2961 if (state
->degamma_lut
)
2962 drm_property_reference_blob(state
->degamma_lut
);
2964 drm_property_reference_blob(state
->ctm
);
2965 if (state
->gamma_lut
)
2966 drm_property_reference_blob(state
->gamma_lut
);
2967 state
->mode_changed
= false;
2968 state
->active_changed
= false;
2969 state
->planes_changed
= false;
2970 state
->connectors_changed
= false;
2971 state
->color_mgmt_changed
= false;
2972 state
->zpos_changed
= false;
2973 state
->event
= NULL
;
2975 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
2978 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2981 * Default CRTC state duplicate hook for drivers which don't have their own
2982 * subclassed CRTC state structure.
2984 struct drm_crtc_state
*
2985 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
2987 struct drm_crtc_state
*state
;
2989 if (WARN_ON(!crtc
->state
))
2992 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
2994 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
2998 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
3001 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3002 * @state: CRTC state object to release
3004 * Releases all resources stored in the CRTC state without actually freeing
3005 * the memory of the CRTC state. This is useful for drivers that subclass the
3008 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
)
3010 drm_property_unreference_blob(state
->mode_blob
);
3011 drm_property_unreference_blob(state
->degamma_lut
);
3012 drm_property_unreference_blob(state
->ctm
);
3013 drm_property_unreference_blob(state
->gamma_lut
);
3015 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
3018 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3020 * @state: CRTC state object to release
3022 * Default CRTC state destroy hook for drivers which don't have their own
3023 * subclassed CRTC state structure.
3025 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
3026 struct drm_crtc_state
*state
)
3028 __drm_atomic_helper_crtc_destroy_state(state
);
3031 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
3034 * drm_atomic_helper_plane_reset - default ->reset hook for planes
3037 * Resets the atomic state for @plane by freeing the state pointer (which might
3038 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3040 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
3043 __drm_atomic_helper_plane_destroy_state(plane
->state
);
3045 kfree(plane
->state
);
3046 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
3049 plane
->state
->plane
= plane
;
3050 plane
->state
->rotation
= BIT(DRM_ROTATE_0
);
3053 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
3056 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3057 * @plane: plane object
3058 * @state: atomic plane state
3060 * Copies atomic state from a plane's current state. This is useful for
3061 * drivers that subclass the plane state.
3063 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
3064 struct drm_plane_state
*state
)
3066 memcpy(state
, plane
->state
, sizeof(*state
));
3069 drm_framebuffer_reference(state
->fb
);
3071 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
3074 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3077 * Default plane state duplicate hook for drivers which don't have their own
3078 * subclassed plane state structure.
3080 struct drm_plane_state
*
3081 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
3083 struct drm_plane_state
*state
;
3085 if (WARN_ON(!plane
->state
))
3088 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3090 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
3094 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
3097 * __drm_atomic_helper_plane_destroy_state - release plane state
3098 * @state: plane state object to release
3100 * Releases all resources stored in the plane state without actually freeing
3101 * the memory of the plane state. This is useful for drivers that subclass the
3104 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state
*state
)
3107 drm_framebuffer_unreference(state
->fb
);
3109 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
3112 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3114 * @state: plane state object to release
3116 * Default plane state destroy hook for drivers which don't have their own
3117 * subclassed plane state structure.
3119 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
3120 struct drm_plane_state
*state
)
3122 __drm_atomic_helper_plane_destroy_state(state
);
3125 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
3128 * __drm_atomic_helper_connector_reset - reset state on connector
3129 * @connector: drm connector
3130 * @conn_state: connector state to assign
3132 * Initializes the newly allocated @conn_state and assigns it to
3133 * #connector ->state, usually required when initializing the drivers
3134 * or when called from the ->reset hook.
3136 * This is useful for drivers that subclass the connector state.
3139 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
3140 struct drm_connector_state
*conn_state
)
3143 conn_state
->connector
= connector
;
3145 connector
->state
= conn_state
;
3147 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
3150 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
3151 * @connector: drm connector
3153 * Resets the atomic state for @connector by freeing the state pointer (which
3154 * might be NULL, e.g. at driver load time) and allocating a new empty state
3157 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
3159 struct drm_connector_state
*conn_state
=
3160 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
3162 if (connector
->state
)
3163 __drm_atomic_helper_connector_destroy_state(connector
->state
);
3165 kfree(connector
->state
);
3166 __drm_atomic_helper_connector_reset(connector
, conn_state
);
3168 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
3171 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3172 * @connector: connector object
3173 * @state: atomic connector state
3175 * Copies atomic state from a connector's current state. This is useful for
3176 * drivers that subclass the connector state.
3179 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
3180 struct drm_connector_state
*state
)
3182 memcpy(state
, connector
->state
, sizeof(*state
));
3184 drm_connector_reference(connector
);
3186 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
3189 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3190 * @connector: drm connector
3192 * Default connector state duplicate hook for drivers which don't have their own
3193 * subclassed connector state structure.
3195 struct drm_connector_state
*
3196 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
3198 struct drm_connector_state
*state
;
3200 if (WARN_ON(!connector
->state
))
3203 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3205 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
3209 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
3212 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3214 * @ctx: lock acquisition context
3216 * Makes a copy of the current atomic state by looping over all objects and
3217 * duplicating their respective states. This is used for example by suspend/
3218 * resume support code to save the state prior to suspend such that it can
3219 * be restored upon resume.
3221 * Note that this treats atomic state as persistent between save and restore.
3222 * Drivers must make sure that this is possible and won't result in confusion
3223 * or erroneous behaviour.
3225 * Note that if callers haven't already acquired all modeset locks this might
3226 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3229 * A pointer to the copy of the atomic state object on success or an
3230 * ERR_PTR()-encoded error code on failure.
3233 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3235 struct drm_atomic_state
*
3236 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
3237 struct drm_modeset_acquire_ctx
*ctx
)
3239 struct drm_atomic_state
*state
;
3240 struct drm_connector
*conn
;
3241 struct drm_plane
*plane
;
3242 struct drm_crtc
*crtc
;
3245 state
= drm_atomic_state_alloc(dev
);
3247 return ERR_PTR(-ENOMEM
);
3249 state
->acquire_ctx
= ctx
;
3251 drm_for_each_crtc(crtc
, dev
) {
3252 struct drm_crtc_state
*crtc_state
;
3254 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3255 if (IS_ERR(crtc_state
)) {
3256 err
= PTR_ERR(crtc_state
);
3261 drm_for_each_plane(plane
, dev
) {
3262 struct drm_plane_state
*plane_state
;
3264 plane_state
= drm_atomic_get_plane_state(state
, plane
);
3265 if (IS_ERR(plane_state
)) {
3266 err
= PTR_ERR(plane_state
);
3271 drm_for_each_connector(conn
, dev
) {
3272 struct drm_connector_state
*conn_state
;
3274 conn_state
= drm_atomic_get_connector_state(state
, conn
);
3275 if (IS_ERR(conn_state
)) {
3276 err
= PTR_ERR(conn_state
);
3281 /* clear the acquire context so that it isn't accidentally reused */
3282 state
->acquire_ctx
= NULL
;
3286 drm_atomic_state_free(state
);
3287 state
= ERR_PTR(err
);
3292 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state
);
3295 * __drm_atomic_helper_connector_destroy_state - release connector state
3296 * @state: connector state object to release
3298 * Releases all resources stored in the connector state without actually
3299 * freeing the memory of the connector state. This is useful for drivers that
3300 * subclass the connector state.
3303 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state
*state
)
3306 * This is currently a placeholder so that drivers that subclass the
3307 * state will automatically do the right thing if code is ever added
3311 drm_connector_unreference(state
->connector
);
3313 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
3316 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3317 * @connector: drm connector
3318 * @state: connector state object to release
3320 * Default connector state destroy hook for drivers which don't have their own
3321 * subclassed connector state structure.
3323 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
3324 struct drm_connector_state
*state
)
3326 __drm_atomic_helper_connector_destroy_state(state
);
3329 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);
3332 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3333 * @crtc: CRTC object
3334 * @red: red correction table
3335 * @green: green correction table
3336 * @blue: green correction table
3337 * @size: size of the tables
3339 * Implements support for legacy gamma correction table for drivers
3340 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3343 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc
*crtc
,
3344 u16
*red
, u16
*green
, u16
*blue
,
3347 struct drm_device
*dev
= crtc
->dev
;
3348 struct drm_mode_config
*config
= &dev
->mode_config
;
3349 struct drm_atomic_state
*state
;
3350 struct drm_crtc_state
*crtc_state
;
3351 struct drm_property_blob
*blob
= NULL
;
3352 struct drm_color_lut
*blob_data
;
3355 state
= drm_atomic_state_alloc(crtc
->dev
);
3359 blob
= drm_property_create_blob(dev
,
3360 sizeof(struct drm_color_lut
) * size
,
3363 ret
= PTR_ERR(blob
);
3368 /* Prepare GAMMA_LUT with the legacy values. */
3369 blob_data
= (struct drm_color_lut
*) blob
->data
;
3370 for (i
= 0; i
< size
; i
++) {
3371 blob_data
[i
].red
= red
[i
];
3372 blob_data
[i
].green
= green
[i
];
3373 blob_data
[i
].blue
= blue
[i
];
3376 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
3378 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3379 if (IS_ERR(crtc_state
)) {
3380 ret
= PTR_ERR(crtc_state
);
3384 /* Reset DEGAMMA_LUT and CTM properties. */
3385 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3386 config
->degamma_lut_property
, 0);
3390 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3391 config
->ctm_property
, 0);
3395 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3396 config
->gamma_lut_property
, blob
->base
.id
);
3400 ret
= drm_atomic_commit(state
);
3404 /* Driver takes ownership of state on successful commit. */
3406 drm_property_unreference_blob(blob
);
3410 if (ret
== -EDEADLK
)
3413 drm_atomic_state_free(state
);
3414 drm_property_unreference_blob(blob
);
3418 drm_atomic_state_clear(state
);
3419 drm_atomic_legacy_backoff(state
);
3423 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set
);