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 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
598 const struct drm_plane_helper_funcs
*funcs
;
600 funcs
= plane
->helper_private
;
602 drm_atomic_helper_plane_changed(state
, plane_state
, plane
);
604 if (!funcs
|| !funcs
->atomic_check
)
607 ret
= funcs
->atomic_check(plane
, plane_state
);
609 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
610 plane
->base
.id
, plane
->name
);
615 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
616 const struct drm_crtc_helper_funcs
*funcs
;
618 funcs
= crtc
->helper_private
;
620 if (!funcs
|| !funcs
->atomic_check
)
623 ret
= funcs
->atomic_check(crtc
, crtc_state
);
625 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
626 crtc
->base
.id
, crtc
->name
);
633 EXPORT_SYMBOL(drm_atomic_helper_check_planes
);
636 * drm_atomic_helper_check - validate state object
638 * @state: the driver state object
640 * Check the state object to see if the requested state is physically possible.
641 * Only crtcs and planes have check callbacks, so for any additional (global)
642 * checking that a driver needs it can simply wrap that around this function.
643 * Drivers without such needs can directly use this as their ->atomic_check()
646 * This just wraps the two parts of the state checking for planes and modeset
647 * state in the default order: First it calls drm_atomic_helper_check_modeset()
648 * and then drm_atomic_helper_check_planes(). The assumption is that the
649 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
650 * e.g. properly compute watermarks.
653 * Zero for success or -errno
655 int drm_atomic_helper_check(struct drm_device
*dev
,
656 struct drm_atomic_state
*state
)
660 ret
= drm_atomic_helper_check_modeset(dev
, state
);
664 ret
= drm_atomic_helper_check_planes(dev
, state
);
670 EXPORT_SYMBOL(drm_atomic_helper_check
);
673 disable_outputs(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
675 struct drm_connector
*connector
;
676 struct drm_connector_state
*old_conn_state
;
677 struct drm_crtc
*crtc
;
678 struct drm_crtc_state
*old_crtc_state
;
681 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
682 const struct drm_encoder_helper_funcs
*funcs
;
683 struct drm_encoder
*encoder
;
685 /* Shut down everything that's in the changeset and currently
686 * still on. So need to check the old, saved state. */
687 if (!old_conn_state
->crtc
)
690 old_crtc_state
= drm_atomic_get_existing_crtc_state(old_state
,
691 old_conn_state
->crtc
);
693 if (!old_crtc_state
->active
||
694 !drm_atomic_crtc_needs_modeset(old_conn_state
->crtc
->state
))
697 encoder
= old_conn_state
->best_encoder
;
699 /* We shouldn't get this far if we didn't previously have
700 * an encoder.. but WARN_ON() rather than explode.
702 if (WARN_ON(!encoder
))
705 funcs
= encoder
->helper_private
;
707 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
708 encoder
->base
.id
, encoder
->name
);
711 * Each encoder has at most one connector (since we always steal
712 * it away), so we won't call disable hooks twice.
714 drm_bridge_disable(encoder
->bridge
);
716 /* Right function depends upon target state. */
718 if (connector
->state
->crtc
&& funcs
->prepare
)
719 funcs
->prepare(encoder
);
720 else if (funcs
->disable
)
721 funcs
->disable(encoder
);
722 else if (funcs
->dpms
)
723 funcs
->dpms(encoder
, DRM_MODE_DPMS_OFF
);
726 drm_bridge_post_disable(encoder
->bridge
);
729 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
730 const struct drm_crtc_helper_funcs
*funcs
;
732 /* Shut down everything that needs a full modeset. */
733 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
736 if (!old_crtc_state
->active
)
739 funcs
= crtc
->helper_private
;
741 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
742 crtc
->base
.id
, crtc
->name
);
745 /* Right function depends upon target state. */
746 if (crtc
->state
->enable
&& funcs
->prepare
)
747 funcs
->prepare(crtc
);
748 else if (funcs
->atomic_disable
)
749 funcs
->atomic_disable(crtc
, old_crtc_state
);
750 else if (funcs
->disable
)
751 funcs
->disable(crtc
);
753 funcs
->dpms(crtc
, DRM_MODE_DPMS_OFF
);
758 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
760 * @old_state: atomic state object with old state structures
762 * This function updates all the various legacy modeset state pointers in
763 * connectors, encoders and crtcs. It also updates the timestamping constants
764 * used for precise vblank timestamps by calling
765 * drm_calc_timestamping_constants().
767 * Drivers can use this for building their own atomic commit if they don't have
768 * a pure helper-based modeset implementation.
771 drm_atomic_helper_update_legacy_modeset_state(struct drm_device
*dev
,
772 struct drm_atomic_state
*old_state
)
774 struct drm_connector
*connector
;
775 struct drm_connector_state
*old_conn_state
;
776 struct drm_crtc
*crtc
;
777 struct drm_crtc_state
*old_crtc_state
;
780 /* clear out existing links and update dpms */
781 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
782 if (connector
->encoder
) {
783 WARN_ON(!connector
->encoder
->crtc
);
785 connector
->encoder
->crtc
= NULL
;
786 connector
->encoder
= NULL
;
789 crtc
= connector
->state
->crtc
;
790 if ((!crtc
&& old_conn_state
->crtc
) ||
791 (crtc
&& drm_atomic_crtc_needs_modeset(crtc
->state
))) {
792 struct drm_property
*dpms_prop
=
793 dev
->mode_config
.dpms_property
;
794 int mode
= DRM_MODE_DPMS_OFF
;
796 if (crtc
&& crtc
->state
->active
)
797 mode
= DRM_MODE_DPMS_ON
;
799 connector
->dpms
= mode
;
800 drm_object_property_set_value(&connector
->base
,
806 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
807 if (!connector
->state
->crtc
)
810 if (WARN_ON(!connector
->state
->best_encoder
))
813 connector
->encoder
= connector
->state
->best_encoder
;
814 connector
->encoder
->crtc
= connector
->state
->crtc
;
817 /* set legacy state in the crtc structure */
818 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
819 struct drm_plane
*primary
= crtc
->primary
;
821 crtc
->mode
= crtc
->state
->mode
;
822 crtc
->enabled
= crtc
->state
->enable
;
824 if (drm_atomic_get_existing_plane_state(old_state
, primary
) &&
825 primary
->state
->crtc
== crtc
) {
826 crtc
->x
= primary
->state
->src_x
>> 16;
827 crtc
->y
= primary
->state
->src_y
>> 16;
830 if (crtc
->state
->enable
)
831 drm_calc_timestamping_constants(crtc
,
832 &crtc
->state
->adjusted_mode
);
835 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state
);
838 crtc_set_mode(struct drm_device
*dev
, struct drm_atomic_state
*old_state
)
840 struct drm_crtc
*crtc
;
841 struct drm_crtc_state
*old_crtc_state
;
842 struct drm_connector
*connector
;
843 struct drm_connector_state
*old_conn_state
;
846 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
847 const struct drm_crtc_helper_funcs
*funcs
;
849 if (!crtc
->state
->mode_changed
)
852 funcs
= crtc
->helper_private
;
854 if (crtc
->state
->enable
&& funcs
->mode_set_nofb
) {
855 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
856 crtc
->base
.id
, crtc
->name
);
858 funcs
->mode_set_nofb(crtc
);
862 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
863 const struct drm_encoder_helper_funcs
*funcs
;
864 struct drm_crtc_state
*new_crtc_state
;
865 struct drm_encoder
*encoder
;
866 struct drm_display_mode
*mode
, *adjusted_mode
;
868 if (!connector
->state
->best_encoder
)
871 encoder
= connector
->state
->best_encoder
;
872 funcs
= encoder
->helper_private
;
873 new_crtc_state
= connector
->state
->crtc
->state
;
874 mode
= &new_crtc_state
->mode
;
875 adjusted_mode
= &new_crtc_state
->adjusted_mode
;
877 if (!new_crtc_state
->mode_changed
)
880 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
881 encoder
->base
.id
, encoder
->name
);
884 * Each encoder has at most one connector (since we always steal
885 * it away), so we won't call mode_set hooks twice.
887 if (funcs
&& funcs
->atomic_mode_set
) {
888 funcs
->atomic_mode_set(encoder
, new_crtc_state
,
890 } else if (funcs
&& funcs
->mode_set
) {
891 funcs
->mode_set(encoder
, mode
, adjusted_mode
);
894 drm_bridge_mode_set(encoder
->bridge
, mode
, adjusted_mode
);
899 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
901 * @old_state: atomic state object with old state structures
903 * This function shuts down all the outputs that need to be shut down and
904 * prepares them (if required) with the new mode.
906 * For compatibility with legacy crtc helpers this should be called before
907 * drm_atomic_helper_commit_planes(), which is what the default commit function
908 * does. But drivers with different needs can group the modeset commits together
909 * and do the plane commits at the end. This is useful for drivers doing runtime
910 * PM since planes updates then only happen when the CRTC is actually enabled.
912 void drm_atomic_helper_commit_modeset_disables(struct drm_device
*dev
,
913 struct drm_atomic_state
*old_state
)
915 disable_outputs(dev
, old_state
);
917 drm_atomic_helper_update_legacy_modeset_state(dev
, old_state
);
919 crtc_set_mode(dev
, old_state
);
921 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables
);
924 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
926 * @old_state: atomic state object with old state structures
928 * This function enables all the outputs with the new configuration which had to
929 * be turned off for the update.
931 * For compatibility with legacy crtc helpers this should be called after
932 * drm_atomic_helper_commit_planes(), which is what the default commit function
933 * does. But drivers with different needs can group the modeset commits together
934 * and do the plane commits at the end. This is useful for drivers doing runtime
935 * PM since planes updates then only happen when the CRTC is actually enabled.
937 void drm_atomic_helper_commit_modeset_enables(struct drm_device
*dev
,
938 struct drm_atomic_state
*old_state
)
940 struct drm_crtc
*crtc
;
941 struct drm_crtc_state
*old_crtc_state
;
942 struct drm_connector
*connector
;
943 struct drm_connector_state
*old_conn_state
;
946 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
947 const struct drm_crtc_helper_funcs
*funcs
;
949 /* Need to filter out CRTCs where only planes change. */
950 if (!drm_atomic_crtc_needs_modeset(crtc
->state
))
953 if (!crtc
->state
->active
)
956 funcs
= crtc
->helper_private
;
958 if (crtc
->state
->enable
) {
959 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
960 crtc
->base
.id
, crtc
->name
);
969 for_each_connector_in_state(old_state
, connector
, old_conn_state
, i
) {
970 const struct drm_encoder_helper_funcs
*funcs
;
971 struct drm_encoder
*encoder
;
973 if (!connector
->state
->best_encoder
)
976 if (!connector
->state
->crtc
->state
->active
||
977 !drm_atomic_crtc_needs_modeset(connector
->state
->crtc
->state
))
980 encoder
= connector
->state
->best_encoder
;
981 funcs
= encoder
->helper_private
;
983 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
984 encoder
->base
.id
, encoder
->name
);
987 * Each encoder has at most one connector (since we always steal
988 * it away), so we won't call enable hooks twice.
990 drm_bridge_pre_enable(encoder
->bridge
);
994 funcs
->enable(encoder
);
995 else if (funcs
->commit
)
996 funcs
->commit(encoder
);
999 drm_bridge_enable(encoder
->bridge
);
1002 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables
);
1005 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1007 * @state: atomic state object with old state structures
1008 * @pre_swap: if true, do an interruptible wait
1010 * For implicit sync, driver should fish the exclusive fence out from the
1011 * incoming fb's and stash it in the drm_plane_state. This is called after
1012 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1013 * just uses the atomic state to find the changed planes)
1015 * Returns zero if success or < 0 if fence_wait() fails.
1017 int drm_atomic_helper_wait_for_fences(struct drm_device
*dev
,
1018 struct drm_atomic_state
*state
,
1021 struct drm_plane
*plane
;
1022 struct drm_plane_state
*plane_state
;
1025 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1027 plane_state
= plane
->state
;
1029 if (!plane_state
->fence
)
1032 WARN_ON(!plane_state
->fb
);
1035 * If waiting for fences pre-swap (ie: nonblock), userspace can
1036 * still interrupt the operation. Instead of blocking until the
1037 * timer expires, make the wait interruptible.
1039 ret
= fence_wait(plane_state
->fence
, pre_swap
);
1043 fence_put(plane_state
->fence
);
1044 plane_state
->fence
= NULL
;
1049 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences
);
1052 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1054 * @old_state: atomic state object with old state structures
1057 * Checks whether the framebuffer used for this CRTC changes as a result of
1058 * the atomic update. This is useful for drivers which cannot use
1059 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1063 * true if the framebuffer changed.
1065 bool drm_atomic_helper_framebuffer_changed(struct drm_device
*dev
,
1066 struct drm_atomic_state
*old_state
,
1067 struct drm_crtc
*crtc
)
1069 struct drm_plane
*plane
;
1070 struct drm_plane_state
*old_plane_state
;
1073 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1074 if (plane
->state
->crtc
!= crtc
&&
1075 old_plane_state
->crtc
!= crtc
)
1078 if (plane
->state
->fb
!= old_plane_state
->fb
)
1084 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed
);
1087 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1089 * @old_state: atomic state object with old state structures
1091 * Helper to, after atomic commit, wait for vblanks on all effected
1092 * crtcs (ie. before cleaning up old framebuffers using
1093 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1094 * framebuffers have actually changed to optimize for the legacy cursor and
1095 * plane update use-case.
1098 drm_atomic_helper_wait_for_vblanks(struct drm_device
*dev
,
1099 struct drm_atomic_state
*old_state
)
1101 struct drm_crtc
*crtc
;
1102 struct drm_crtc_state
*old_crtc_state
;
1105 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1106 /* No one cares about the old state, so abuse it for tracking
1107 * and store whether we hold a vblank reference (and should do a
1108 * vblank wait) in the ->enable boolean. */
1109 old_crtc_state
->enable
= false;
1111 if (!crtc
->state
->enable
)
1114 /* Legacy cursor ioctls are completely unsynced, and userspace
1115 * relies on that (by doing tons of cursor updates). */
1116 if (old_state
->legacy_cursor_update
)
1119 if (!drm_atomic_helper_framebuffer_changed(dev
,
1123 ret
= drm_crtc_vblank_get(crtc
);
1127 old_crtc_state
->enable
= true;
1128 old_crtc_state
->last_vblank_count
= drm_crtc_vblank_count(crtc
);
1131 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1132 if (!old_crtc_state
->enable
)
1135 ret
= wait_event_timeout(dev
->vblank
[i
].queue
,
1136 old_crtc_state
->last_vblank_count
!=
1137 drm_crtc_vblank_count(crtc
),
1138 msecs_to_jiffies(50));
1140 WARN(!ret
, "[CRTC:%d] vblank wait timed out\n", crtc
->base
.id
);
1142 drm_crtc_vblank_put(crtc
);
1145 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks
);
1148 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1149 * @state: new modeset state to be committed
1151 * This is the default implemenation for the ->atomic_commit_tail() hook of the
1152 * &drm_mode_config_helper_funcs vtable.
1154 * Note that the default ordering of how the various stages are called is to
1155 * match the legacy modeset helper library closest. One peculiarity of that is
1156 * that it doesn't mesh well with runtime PM at all.
1158 * For drivers supporting runtime PM the recommended sequence is instead ::
1160 * drm_atomic_helper_commit_modeset_disables(dev, state);
1162 * drm_atomic_helper_commit_modeset_enables(dev, state);
1164 * drm_atomic_helper_commit_planes(dev, state,
1165 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
1167 * for committing the atomic update to hardware. See the kerneldoc entries for
1168 * these three functions for more details.
1170 void drm_atomic_helper_commit_tail(struct drm_atomic_state
*state
)
1172 struct drm_device
*dev
= state
->dev
;
1174 drm_atomic_helper_commit_modeset_disables(dev
, state
);
1176 drm_atomic_helper_commit_planes(dev
, state
, 0);
1178 drm_atomic_helper_commit_modeset_enables(dev
, state
);
1180 drm_atomic_helper_commit_hw_done(state
);
1182 drm_atomic_helper_wait_for_vblanks(dev
, state
);
1184 drm_atomic_helper_cleanup_planes(dev
, state
);
1186 EXPORT_SYMBOL(drm_atomic_helper_commit_tail
);
1188 static void commit_tail(struct drm_atomic_state
*state
)
1190 struct drm_device
*dev
= state
->dev
;
1191 struct drm_mode_config_helper_funcs
*funcs
;
1193 funcs
= dev
->mode_config
.helper_private
;
1195 drm_atomic_helper_wait_for_fences(dev
, state
, false);
1197 drm_atomic_helper_wait_for_dependencies(state
);
1199 if (funcs
&& funcs
->atomic_commit_tail
)
1200 funcs
->atomic_commit_tail(state
);
1202 drm_atomic_helper_commit_tail(state
);
1204 drm_atomic_helper_commit_cleanup_done(state
);
1206 drm_atomic_state_free(state
);
1209 static void commit_work(struct work_struct
*work
)
1211 struct drm_atomic_state
*state
= container_of(work
,
1212 struct drm_atomic_state
,
1218 * drm_atomic_helper_commit - commit validated state object
1220 * @state: the driver state object
1221 * @nonblock: whether nonblocking behavior is requested.
1223 * This function commits a with drm_atomic_helper_check() pre-validated state
1224 * object. This can still fail when e.g. the framebuffer reservation fails. This
1225 * function implements nonblocking commits, using
1226 * drm_atomic_helper_setup_commit() and related functions.
1228 * Note that right now this function does not support nonblocking commits, hence
1229 * driver writers must implement their own version for now.
1231 * Committing the actual hardware state is done through the
1232 * ->atomic_commit_tail() callback of the &drm_mode_config_helper_funcs vtable,
1233 * or it's default implementation drm_atomic_helper_commit_tail().
1236 * Zero for success or -errno.
1238 int drm_atomic_helper_commit(struct drm_device
*dev
,
1239 struct drm_atomic_state
*state
,
1244 ret
= drm_atomic_helper_setup_commit(state
, nonblock
);
1248 INIT_WORK(&state
->commit_work
, commit_work
);
1250 ret
= drm_atomic_helper_prepare_planes(dev
, state
);
1255 ret
= drm_atomic_helper_wait_for_fences(dev
, state
, true);
1261 * This is the point of no return - everything below never fails except
1262 * when the hw goes bonghits. Which means we can commit the new state on
1263 * the software side now.
1266 drm_atomic_helper_swap_state(state
, true);
1269 * Everything below can be run asynchronously without the need to grab
1270 * any modeset locks at all under one condition: It must be guaranteed
1271 * that the asynchronous work has either been cancelled (if the driver
1272 * supports it, which at least requires that the framebuffers get
1273 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1274 * before the new state gets committed on the software side with
1275 * drm_atomic_helper_swap_state().
1277 * This scheme allows new atomic state updates to be prepared and
1278 * checked in parallel to the asynchronous completion of the previous
1279 * update. Which is important since compositors need to figure out the
1280 * composition of the next frame right after having submitted the
1283 * NOTE: Commit work has multiple phases, first hardware commit, then
1284 * cleanup. We want them to overlap, hence need system_unbound_wq to
1285 * make sure work items don't artifically stall on each another.
1289 queue_work(system_unbound_wq
, &state
->commit_work
);
1295 EXPORT_SYMBOL(drm_atomic_helper_commit
);
1298 * DOC: implementing nonblocking commit
1300 * Nonblocking atomic commits have to be implemented in the following sequence:
1302 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1303 * which commit needs to call which can fail, so we want to run it first and
1306 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1307 * might be affected the new state update. This can be done by either cancelling
1308 * or flushing the work items, depending upon whether the driver can deal with
1309 * cancelled updates. Note that it is important to ensure that the framebuffer
1310 * cleanup is still done when cancelling.
1312 * Asynchronous workers need to have sufficient parallelism to be able to run
1313 * different atomic commits on different CRTCs in parallel. The simplest way to
1314 * achive this is by running them on the &system_unbound_wq work queue. Note
1315 * that drivers are not required to split up atomic commits and run an
1316 * individual commit in parallel - userspace is supposed to do that if it cares.
1317 * But it might be beneficial to do that for modesets, since those necessarily
1318 * must be done as one global operation, and enabling or disabling a CRTC can
1319 * take a long time. But even that is not required.
1321 * 3. The software state is updated synchronously with
1322 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1323 * locks means concurrent callers never see inconsistent state. And doing this
1324 * while it's guaranteed that no relevant nonblocking worker runs means that
1325 * nonblocking workers do not need grab any locks. Actually they must not grab
1326 * locks, for otherwise the work flushing will deadlock.
1328 * 4. Schedule a work item to do all subsequent steps, using the split-out
1329 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1330 * then cleaning up the framebuffers after the old framebuffer is no longer
1333 * The above scheme is implemented in the atomic helper libraries in
1334 * drm_atomic_helper_commit() using a bunch of helper functions. See
1335 * drm_atomic_helper_setup_commit() for a starting point.
1338 static int stall_checks(struct drm_crtc
*crtc
, bool nonblock
)
1340 struct drm_crtc_commit
*commit
, *stall_commit
= NULL
;
1341 bool completed
= true;
1345 spin_lock(&crtc
->commit_lock
);
1347 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1349 completed
= try_wait_for_completion(&commit
->flip_done
);
1350 /* Userspace is not allowed to get ahead of the previous
1351 * commit with nonblocking ones. */
1352 if (!completed
&& nonblock
) {
1353 spin_unlock(&crtc
->commit_lock
);
1356 } else if (i
== 1) {
1357 stall_commit
= commit
;
1358 drm_crtc_commit_get(stall_commit
);
1364 spin_unlock(&crtc
->commit_lock
);
1369 /* We don't want to let commits get ahead of cleanup work too much,
1370 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1372 ret
= wait_for_completion_interruptible_timeout(&stall_commit
->cleanup_done
,
1375 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1376 crtc
->base
.id
, crtc
->name
);
1378 drm_crtc_commit_put(stall_commit
);
1380 return ret
< 0 ? ret
: 0;
1384 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1385 * @state: new modeset state to be committed
1386 * @nonblock: whether nonblocking behavior is requested.
1388 * This function prepares @state to be used by the atomic helper's support for
1389 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1390 * should always call this function from their ->atomic_commit hook.
1392 * To be able to use this support drivers need to use a few more helper
1393 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1394 * actually committing the hardware state, and for nonblocking commits this call
1395 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1396 * and it's stall parameter, for when a driver's commit hooks look at the
1397 * ->state pointers of struct &drm_crtc, &drm_plane or &drm_connector directly.
1399 * Completion of the hardware commit step must be signalled using
1400 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1401 * to read or change any permanent software or hardware modeset state. The only
1402 * exception is state protected by other means than &drm_modeset_lock locks.
1403 * Only the free standing @state with pointers to the old state structures can
1404 * be inspected, e.g. to clean up old buffers using
1405 * drm_atomic_helper_cleanup_planes().
1407 * At the very end, before cleaning up @state drivers must call
1408 * drm_atomic_helper_commit_cleanup_done().
1410 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1411 * complete and esay-to-use default implementation of the atomic_commit() hook.
1413 * The tracking of asynchronously executed and still pending commits is done
1414 * using the core structure &drm_crtc_commit.
1416 * By default there's no need to clean up resources allocated by this function
1417 * explicitly: drm_atomic_state_default_clear() will take care of that
1422 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1423 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1425 int drm_atomic_helper_setup_commit(struct drm_atomic_state
*state
,
1428 struct drm_crtc
*crtc
;
1429 struct drm_crtc_state
*crtc_state
;
1430 struct drm_crtc_commit
*commit
;
1433 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1434 commit
= kzalloc(sizeof(*commit
), GFP_KERNEL
);
1438 init_completion(&commit
->flip_done
);
1439 init_completion(&commit
->hw_done
);
1440 init_completion(&commit
->cleanup_done
);
1441 INIT_LIST_HEAD(&commit
->commit_entry
);
1442 kref_init(&commit
->ref
);
1443 commit
->crtc
= crtc
;
1445 state
->crtcs
[i
].commit
= commit
;
1447 ret
= stall_checks(crtc
, nonblock
);
1451 /* Drivers only send out events when at least either current or
1452 * new CRTC state is active. Complete right away if everything
1454 if (!crtc
->state
->active
&& !crtc_state
->active
) {
1455 complete_all(&commit
->flip_done
);
1459 /* Legacy cursor updates are fully unsynced. */
1460 if (state
->legacy_cursor_update
) {
1461 complete_all(&commit
->flip_done
);
1465 if (!crtc_state
->event
) {
1466 commit
->event
= kzalloc(sizeof(*commit
->event
),
1471 crtc_state
->event
= commit
->event
;
1474 crtc_state
->event
->base
.completion
= &commit
->flip_done
;
1479 EXPORT_SYMBOL(drm_atomic_helper_setup_commit
);
1482 static struct drm_crtc_commit
*preceeding_commit(struct drm_crtc
*crtc
)
1484 struct drm_crtc_commit
*commit
;
1487 list_for_each_entry(commit
, &crtc
->commit_list
, commit_entry
) {
1488 /* skip the first entry, that's the current commit */
1498 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1499 * @state: new modeset state to be committed
1501 * This function waits for all preceeding commits that touch the same CRTC as
1502 * @state to both be committed to the hardware (as signalled by
1503 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1504 * by calling drm_crtc_vblank_send_event on the event member of
1507 * This is part of the atomic helper support for nonblocking commits, see
1508 * drm_atomic_helper_setup_commit() for an overview.
1510 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state
*state
)
1512 struct drm_crtc
*crtc
;
1513 struct drm_crtc_state
*crtc_state
;
1514 struct drm_crtc_commit
*commit
;
1518 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1519 spin_lock(&crtc
->commit_lock
);
1520 commit
= preceeding_commit(crtc
);
1522 drm_crtc_commit_get(commit
);
1523 spin_unlock(&crtc
->commit_lock
);
1528 ret
= wait_for_completion_timeout(&commit
->hw_done
,
1531 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1532 crtc
->base
.id
, crtc
->name
);
1534 /* Currently no support for overwriting flips, hence
1535 * stall for previous one to execute completely. */
1536 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1539 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1540 crtc
->base
.id
, crtc
->name
);
1542 drm_crtc_commit_put(commit
);
1545 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies
);
1548 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1549 * @state: new modeset state to be committed
1551 * This function is used to signal completion of the hardware commit step. After
1552 * this step the driver is not allowed to read or change any permanent software
1553 * or hardware modeset state. The only exception is state protected by other
1554 * means than &drm_modeset_lock locks.
1556 * Drivers should try to postpone any expensive or delayed cleanup work after
1557 * this function is called.
1559 * This is part of the atomic helper support for nonblocking commits, see
1560 * drm_atomic_helper_setup_commit() for an overview.
1562 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state
*state
)
1564 struct drm_crtc
*crtc
;
1565 struct drm_crtc_state
*crtc_state
;
1566 struct drm_crtc_commit
*commit
;
1569 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1570 commit
= state
->crtcs
[i
].commit
;
1574 /* backend must have consumed any event by now */
1575 WARN_ON(crtc
->state
->event
);
1576 spin_lock(&crtc
->commit_lock
);
1577 complete_all(&commit
->hw_done
);
1578 spin_unlock(&crtc
->commit_lock
);
1581 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done
);
1584 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1585 * @state: new modeset state to be committed
1587 * This signals completion of the atomic update @state, including any cleanup
1588 * work. If used, it must be called right before calling
1589 * drm_atomic_state_free().
1591 * This is part of the atomic helper support for nonblocking commits, see
1592 * drm_atomic_helper_setup_commit() for an overview.
1594 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state
*state
)
1596 struct drm_crtc
*crtc
;
1597 struct drm_crtc_state
*crtc_state
;
1598 struct drm_crtc_commit
*commit
;
1602 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
1603 commit
= state
->crtcs
[i
].commit
;
1604 if (WARN_ON(!commit
))
1607 spin_lock(&crtc
->commit_lock
);
1608 complete_all(&commit
->cleanup_done
);
1609 WARN_ON(!try_wait_for_completion(&commit
->hw_done
));
1611 /* commit_list borrows our reference, need to remove before we
1612 * clean up our drm_atomic_state. But only after it actually
1613 * completed, otherwise subsequent commits won't stall properly. */
1614 if (try_wait_for_completion(&commit
->flip_done
))
1617 spin_unlock(&crtc
->commit_lock
);
1619 /* We must wait for the vblank event to signal our completion
1620 * before releasing our reference, since the vblank work does
1621 * not hold a reference of its own. */
1622 ret
= wait_for_completion_timeout(&commit
->flip_done
,
1625 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1626 crtc
->base
.id
, crtc
->name
);
1628 spin_lock(&crtc
->commit_lock
);
1630 list_del(&commit
->commit_entry
);
1631 spin_unlock(&crtc
->commit_lock
);
1634 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done
);
1637 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1639 * @state: atomic state object with new state structures
1641 * This function prepares plane state, specifically framebuffers, for the new
1642 * configuration. If any failure is encountered this function will call
1643 * ->cleanup_fb on any already successfully prepared framebuffer.
1646 * 0 on success, negative error code on failure.
1648 int drm_atomic_helper_prepare_planes(struct drm_device
*dev
,
1649 struct drm_atomic_state
*state
)
1651 struct drm_plane
*plane
;
1652 struct drm_plane_state
*plane_state
;
1655 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
1656 const struct drm_plane_helper_funcs
*funcs
;
1658 funcs
= plane
->helper_private
;
1660 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1663 if (funcs
->prepare_fb
) {
1664 ret
= funcs
->prepare_fb(plane
, plane_state
);
1673 for_each_plane_in_state(state
, plane
, plane_state
, j
) {
1674 const struct drm_plane_helper_funcs
*funcs
;
1679 if (!drm_atomic_helper_framebuffer_changed(dev
, state
, plane_state
->crtc
))
1682 funcs
= plane
->helper_private
;
1684 if (funcs
->cleanup_fb
)
1685 funcs
->cleanup_fb(plane
, plane_state
);
1690 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes
);
1692 static bool plane_crtc_active(const struct drm_plane_state
*state
)
1694 return state
->crtc
&& state
->crtc
->state
->active
;
1698 * drm_atomic_helper_commit_planes - commit plane state
1700 * @old_state: atomic state object with old state structures
1701 * @flags: flags for committing plane state
1703 * This function commits the new plane state using the plane and atomic helper
1704 * functions for planes and crtcs. It assumes that the atomic state has already
1705 * been pushed into the relevant object state pointers, since this step can no
1708 * It still requires the global state object @old_state to know which planes and
1709 * crtcs need to be updated though.
1711 * Note that this function does all plane updates across all CRTCs in one step.
1712 * If the hardware can't support this approach look at
1713 * drm_atomic_helper_commit_planes_on_crtc() instead.
1715 * Plane parameters can be updated by applications while the associated CRTC is
1716 * disabled. The DRM/KMS core will store the parameters in the plane state,
1717 * which will be available to the driver when the CRTC is turned on. As a result
1718 * most drivers don't need to be immediately notified of plane updates for a
1721 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
1722 * @flags in order not to receive plane update notifications related to a
1723 * disabled CRTC. This avoids the need to manually ignore plane updates in
1724 * driver code when the driver and/or hardware can't or just don't need to deal
1725 * with updates on disabled CRTCs, for example when supporting runtime PM.
1727 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
1728 * display controllers require to disable a CRTC's planes when the CRTC is
1729 * disabled. This function would skip the ->atomic_disable call for a plane if
1730 * the CRTC of the old plane state needs a modesetting operation. Of course,
1731 * the drivers need to disable the planes in their CRTC disable callbacks
1732 * since no one else would do that.
1734 * The drm_atomic_helper_commit() default implementation doesn't set the
1735 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
1736 * This should not be copied blindly by drivers.
1738 void drm_atomic_helper_commit_planes(struct drm_device
*dev
,
1739 struct drm_atomic_state
*old_state
,
1742 struct drm_crtc
*crtc
;
1743 struct drm_crtc_state
*old_crtc_state
;
1744 struct drm_plane
*plane
;
1745 struct drm_plane_state
*old_plane_state
;
1747 bool active_only
= flags
& DRM_PLANE_COMMIT_ACTIVE_ONLY
;
1748 bool no_disable
= flags
& DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET
;
1750 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1751 const struct drm_crtc_helper_funcs
*funcs
;
1753 funcs
= crtc
->helper_private
;
1755 if (!funcs
|| !funcs
->atomic_begin
)
1758 if (active_only
&& !crtc
->state
->active
)
1761 funcs
->atomic_begin(crtc
, old_crtc_state
);
1764 for_each_plane_in_state(old_state
, plane
, old_plane_state
, i
) {
1765 const struct drm_plane_helper_funcs
*funcs
;
1768 funcs
= plane
->helper_private
;
1773 disabling
= drm_atomic_plane_disabling(plane
, old_plane_state
);
1777 * Skip planes related to inactive CRTCs. If the plane
1778 * is enabled use the state of the current CRTC. If the
1779 * plane is being disabled use the state of the old
1780 * CRTC to avoid skipping planes being disabled on an
1783 if (!disabling
&& !plane_crtc_active(plane
->state
))
1785 if (disabling
&& !plane_crtc_active(old_plane_state
))
1790 * Special-case disabling the plane if drivers support it.
1792 if (disabling
&& funcs
->atomic_disable
) {
1793 struct drm_crtc_state
*crtc_state
;
1795 crtc_state
= old_plane_state
->crtc
->state
;
1797 if (drm_atomic_crtc_needs_modeset(crtc_state
) &&
1801 funcs
->atomic_disable(plane
, old_plane_state
);
1802 } else if (plane
->state
->crtc
|| disabling
) {
1803 funcs
->atomic_update(plane
, old_plane_state
);
1807 for_each_crtc_in_state(old_state
, crtc
, old_crtc_state
, i
) {
1808 const struct drm_crtc_helper_funcs
*funcs
;
1810 funcs
= crtc
->helper_private
;
1812 if (!funcs
|| !funcs
->atomic_flush
)
1815 if (active_only
&& !crtc
->state
->active
)
1818 funcs
->atomic_flush(crtc
, old_crtc_state
);
1821 EXPORT_SYMBOL(drm_atomic_helper_commit_planes
);
1824 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1825 * @old_crtc_state: atomic state object with the old crtc state
1827 * This function commits the new plane state using the plane and atomic helper
1828 * functions for planes on the specific crtc. It assumes that the atomic state
1829 * has already been pushed into the relevant object state pointers, since this
1830 * step can no longer fail.
1832 * This function is useful when plane updates should be done crtc-by-crtc
1833 * instead of one global step like drm_atomic_helper_commit_planes() does.
1835 * This function can only be savely used when planes are not allowed to move
1836 * between different CRTCs because this function doesn't handle inter-CRTC
1837 * depencies. Callers need to ensure that either no such depencies exist,
1838 * resolve them through ordering of commit calls or through some other means.
1841 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
)
1843 const struct drm_crtc_helper_funcs
*crtc_funcs
;
1844 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1845 struct drm_atomic_state
*old_state
= old_crtc_state
->state
;
1846 struct drm_plane
*plane
;
1847 unsigned plane_mask
;
1849 plane_mask
= old_crtc_state
->plane_mask
;
1850 plane_mask
|= crtc
->state
->plane_mask
;
1852 crtc_funcs
= crtc
->helper_private
;
1853 if (crtc_funcs
&& crtc_funcs
->atomic_begin
)
1854 crtc_funcs
->atomic_begin(crtc
, old_crtc_state
);
1856 drm_for_each_plane_mask(plane
, crtc
->dev
, plane_mask
) {
1857 struct drm_plane_state
*old_plane_state
=
1858 drm_atomic_get_existing_plane_state(old_state
, plane
);
1859 const struct drm_plane_helper_funcs
*plane_funcs
;
1861 plane_funcs
= plane
->helper_private
;
1863 if (!old_plane_state
|| !plane_funcs
)
1866 WARN_ON(plane
->state
->crtc
&& plane
->state
->crtc
!= crtc
);
1868 if (drm_atomic_plane_disabling(plane
, old_plane_state
) &&
1869 plane_funcs
->atomic_disable
)
1870 plane_funcs
->atomic_disable(plane
, old_plane_state
);
1871 else if (plane
->state
->crtc
||
1872 drm_atomic_plane_disabling(plane
, old_plane_state
))
1873 plane_funcs
->atomic_update(plane
, old_plane_state
);
1876 if (crtc_funcs
&& crtc_funcs
->atomic_flush
)
1877 crtc_funcs
->atomic_flush(crtc
, old_crtc_state
);
1879 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc
);
1882 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1883 * @old_crtc_state: atomic state object with the old CRTC state
1884 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1886 * Disables all planes associated with the given CRTC. This can be
1887 * used for instance in the CRTC helper atomic_disable callback to disable
1890 * If the atomic-parameter is set the function calls the CRTC's
1891 * atomic_begin hook before and atomic_flush hook after disabling the
1894 * It is a bug to call this function without having implemented the
1895 * ->atomic_disable() plane hook.
1898 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state
*old_crtc_state
,
1901 struct drm_crtc
*crtc
= old_crtc_state
->crtc
;
1902 const struct drm_crtc_helper_funcs
*crtc_funcs
=
1903 crtc
->helper_private
;
1904 struct drm_plane
*plane
;
1906 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_begin
)
1907 crtc_funcs
->atomic_begin(crtc
, NULL
);
1909 drm_atomic_crtc_state_for_each_plane(plane
, old_crtc_state
) {
1910 const struct drm_plane_helper_funcs
*plane_funcs
=
1911 plane
->helper_private
;
1916 WARN_ON(!plane_funcs
->atomic_disable
);
1917 if (plane_funcs
->atomic_disable
)
1918 plane_funcs
->atomic_disable(plane
, NULL
);
1921 if (atomic
&& crtc_funcs
&& crtc_funcs
->atomic_flush
)
1922 crtc_funcs
->atomic_flush(crtc
, NULL
);
1924 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc
);
1927 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1929 * @old_state: atomic state object with old state structures
1931 * This function cleans up plane state, specifically framebuffers, from the old
1932 * configuration. Hence the old configuration must be perserved in @old_state to
1933 * be able to call this function.
1935 * This function must also be called on the new state when the atomic update
1936 * fails at any point after calling drm_atomic_helper_prepare_planes().
1938 void drm_atomic_helper_cleanup_planes(struct drm_device
*dev
,
1939 struct drm_atomic_state
*old_state
)
1941 struct drm_plane
*plane
;
1942 struct drm_plane_state
*plane_state
;
1945 for_each_plane_in_state(old_state
, plane
, plane_state
, i
) {
1946 const struct drm_plane_helper_funcs
*funcs
;
1948 if (!drm_atomic_helper_framebuffer_changed(dev
, old_state
, plane_state
->crtc
))
1951 funcs
= plane
->helper_private
;
1953 if (funcs
->cleanup_fb
)
1954 funcs
->cleanup_fb(plane
, plane_state
);
1957 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes
);
1960 * drm_atomic_helper_swap_state - store atomic state into current sw state
1961 * @state: atomic state
1962 * @stall: stall for proceeding commits
1964 * This function stores the atomic state into the current state pointers in all
1965 * driver objects. It should be called after all failing steps have been done
1966 * and succeeded, but before the actual hardware state is committed.
1968 * For cleanup and error recovery the current state for all changed objects will
1969 * be swaped into @state.
1971 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1973 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1975 * 2. Do any other steps that might fail.
1977 * 3. Put the staged state into the current state pointers with this function.
1979 * 4. Actually commit the hardware state.
1981 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1982 * contains the old state. Also do any other cleanup required with that state.
1984 * @stall must be set when nonblocking commits for this driver directly access
1985 * the ->state pointer of &drm_plane, &drm_crtc or &drm_connector. With the
1986 * current atomic helpers this is almost always the case, since the helpers
1987 * don't pass the right state structures to the callbacks.
1989 void drm_atomic_helper_swap_state(struct drm_atomic_state
*state
,
1994 struct drm_connector
*connector
;
1995 struct drm_connector_state
*conn_state
;
1996 struct drm_crtc
*crtc
;
1997 struct drm_crtc_state
*crtc_state
;
1998 struct drm_plane
*plane
;
1999 struct drm_plane_state
*plane_state
;
2000 struct drm_crtc_commit
*commit
;
2003 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2004 spin_lock(&crtc
->commit_lock
);
2005 commit
= list_first_entry_or_null(&crtc
->commit_list
,
2006 struct drm_crtc_commit
, commit_entry
);
2008 drm_crtc_commit_get(commit
);
2009 spin_unlock(&crtc
->commit_lock
);
2014 ret
= wait_for_completion_timeout(&commit
->hw_done
,
2017 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2018 crtc
->base
.id
, crtc
->name
);
2019 drm_crtc_commit_put(commit
);
2023 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
2024 connector
->state
->state
= state
;
2025 swap(state
->connectors
[i
].state
, connector
->state
);
2026 connector
->state
->state
= NULL
;
2029 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2030 crtc
->state
->state
= state
;
2031 swap(state
->crtcs
[i
].state
, crtc
->state
);
2032 crtc
->state
->state
= NULL
;
2034 if (state
->crtcs
[i
].commit
) {
2035 spin_lock(&crtc
->commit_lock
);
2036 list_add(&state
->crtcs
[i
].commit
->commit_entry
,
2037 &crtc
->commit_list
);
2038 spin_unlock(&crtc
->commit_lock
);
2040 state
->crtcs
[i
].commit
->event
= NULL
;
2044 for_each_plane_in_state(state
, plane
, plane_state
, i
) {
2045 plane
->state
->state
= state
;
2046 swap(state
->planes
[i
].state
, plane
->state
);
2047 plane
->state
->state
= NULL
;
2050 EXPORT_SYMBOL(drm_atomic_helper_swap_state
);
2053 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2054 * @plane: plane object to update
2055 * @crtc: owning CRTC of owning plane
2056 * @fb: framebuffer to flip onto plane
2057 * @crtc_x: x offset of primary plane on crtc
2058 * @crtc_y: y offset of primary plane on crtc
2059 * @crtc_w: width of primary plane rectangle on crtc
2060 * @crtc_h: height of primary plane rectangle on crtc
2061 * @src_x: x offset of @fb for panning
2062 * @src_y: y offset of @fb for panning
2063 * @src_w: width of source rectangle in @fb
2064 * @src_h: height of source rectangle in @fb
2066 * Provides a default plane update handler using the atomic driver interface.
2069 * Zero on success, error code on failure
2071 int drm_atomic_helper_update_plane(struct drm_plane
*plane
,
2072 struct drm_crtc
*crtc
,
2073 struct drm_framebuffer
*fb
,
2074 int crtc_x
, int crtc_y
,
2075 unsigned int crtc_w
, unsigned int crtc_h
,
2076 uint32_t src_x
, uint32_t src_y
,
2077 uint32_t src_w
, uint32_t src_h
)
2079 struct drm_atomic_state
*state
;
2080 struct drm_plane_state
*plane_state
;
2083 state
= drm_atomic_state_alloc(plane
->dev
);
2087 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2089 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2090 if (IS_ERR(plane_state
)) {
2091 ret
= PTR_ERR(plane_state
);
2095 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2098 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2099 plane_state
->crtc_x
= crtc_x
;
2100 plane_state
->crtc_y
= crtc_y
;
2101 plane_state
->crtc_w
= crtc_w
;
2102 plane_state
->crtc_h
= crtc_h
;
2103 plane_state
->src_x
= src_x
;
2104 plane_state
->src_y
= src_y
;
2105 plane_state
->src_w
= src_w
;
2106 plane_state
->src_h
= src_h
;
2108 if (plane
== crtc
->cursor
)
2109 state
->legacy_cursor_update
= true;
2111 ret
= drm_atomic_commit(state
);
2115 /* Driver takes ownership of state on successful commit. */
2118 if (ret
== -EDEADLK
)
2121 drm_atomic_state_free(state
);
2125 drm_atomic_state_clear(state
);
2126 drm_atomic_legacy_backoff(state
);
2129 * Someone might have exchanged the framebuffer while we dropped locks
2130 * in the backoff code. We need to fix up the fb refcount tracking the
2133 plane
->old_fb
= plane
->fb
;
2137 EXPORT_SYMBOL(drm_atomic_helper_update_plane
);
2140 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2141 * @plane: plane to disable
2143 * Provides a default plane disable handler using the atomic driver interface.
2146 * Zero on success, error code on failure
2148 int drm_atomic_helper_disable_plane(struct drm_plane
*plane
)
2150 struct drm_atomic_state
*state
;
2151 struct drm_plane_state
*plane_state
;
2155 * FIXME: Without plane->crtc set we can't get at the implicit legacy
2156 * acquire context. The real fix will be to wire the acquire ctx through
2157 * everywhere we need it, but meanwhile prevent chaos by just skipping
2158 * this noop. The critical case is the cursor ioctls which a) only grab
2159 * crtc/cursor-plane locks (so we need the crtc to get at the right
2160 * acquire context) and b) can try to disable the plane multiple times.
2165 state
= drm_atomic_state_alloc(plane
->dev
);
2169 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(plane
->crtc
);
2171 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2172 if (IS_ERR(plane_state
)) {
2173 ret
= PTR_ERR(plane_state
);
2177 if (plane_state
->crtc
&& (plane
== plane
->crtc
->cursor
))
2178 plane_state
->state
->legacy_cursor_update
= true;
2180 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
2184 ret
= drm_atomic_commit(state
);
2188 /* Driver takes ownership of state on successful commit. */
2191 if (ret
== -EDEADLK
)
2194 drm_atomic_state_free(state
);
2198 drm_atomic_state_clear(state
);
2199 drm_atomic_legacy_backoff(state
);
2202 * Someone might have exchanged the framebuffer while we dropped locks
2203 * in the backoff code. We need to fix up the fb refcount tracking the
2206 plane
->old_fb
= plane
->fb
;
2210 EXPORT_SYMBOL(drm_atomic_helper_disable_plane
);
2212 /* just used from fb-helper and atomic-helper: */
2213 int __drm_atomic_helper_disable_plane(struct drm_plane
*plane
,
2214 struct drm_plane_state
*plane_state
)
2218 ret
= drm_atomic_set_crtc_for_plane(plane_state
, NULL
);
2222 drm_atomic_set_fb_for_plane(plane_state
, NULL
);
2223 plane_state
->crtc_x
= 0;
2224 plane_state
->crtc_y
= 0;
2225 plane_state
->crtc_w
= 0;
2226 plane_state
->crtc_h
= 0;
2227 plane_state
->src_x
= 0;
2228 plane_state
->src_y
= 0;
2229 plane_state
->src_w
= 0;
2230 plane_state
->src_h
= 0;
2235 static int update_output_state(struct drm_atomic_state
*state
,
2236 struct drm_mode_set
*set
)
2238 struct drm_device
*dev
= set
->crtc
->dev
;
2239 struct drm_crtc
*crtc
;
2240 struct drm_crtc_state
*crtc_state
;
2241 struct drm_connector
*connector
;
2242 struct drm_connector_state
*conn_state
;
2245 ret
= drm_modeset_lock(&dev
->mode_config
.connection_mutex
,
2246 state
->acquire_ctx
);
2250 /* First disable all connectors on the target crtc. */
2251 ret
= drm_atomic_add_affected_connectors(state
, set
->crtc
);
2255 for_each_connector_in_state(state
, connector
, conn_state
, i
) {
2256 if (conn_state
->crtc
== set
->crtc
) {
2257 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2264 /* Then set all connectors from set->connectors on the target crtc */
2265 for (i
= 0; i
< set
->num_connectors
; i
++) {
2266 conn_state
= drm_atomic_get_connector_state(state
,
2267 set
->connectors
[i
]);
2268 if (IS_ERR(conn_state
))
2269 return PTR_ERR(conn_state
);
2271 ret
= drm_atomic_set_crtc_for_connector(conn_state
,
2277 for_each_crtc_in_state(state
, crtc
, crtc_state
, i
) {
2278 /* Don't update ->enable for the CRTC in the set_config request,
2279 * since a mismatch would indicate a bug in the upper layers.
2280 * The actual modeset code later on will catch any
2281 * inconsistencies here. */
2282 if (crtc
== set
->crtc
)
2285 if (!crtc_state
->connector_mask
) {
2286 ret
= drm_atomic_set_mode_prop_for_crtc(crtc_state
,
2291 crtc_state
->active
= false;
2299 * drm_atomic_helper_set_config - set a new config from userspace
2300 * @set: mode set configuration
2302 * Provides a default crtc set_config handler using the atomic driver interface.
2305 * Returns 0 on success, negative errno numbers on failure.
2307 int drm_atomic_helper_set_config(struct drm_mode_set
*set
)
2309 struct drm_atomic_state
*state
;
2310 struct drm_crtc
*crtc
= set
->crtc
;
2313 state
= drm_atomic_state_alloc(crtc
->dev
);
2317 state
->legacy_set_config
= true;
2318 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2320 ret
= __drm_atomic_helper_set_config(set
, state
);
2324 ret
= drm_atomic_commit(state
);
2328 /* Driver takes ownership of state on successful commit. */
2331 if (ret
== -EDEADLK
)
2334 drm_atomic_state_free(state
);
2338 drm_atomic_state_clear(state
);
2339 drm_atomic_legacy_backoff(state
);
2342 * Someone might have exchanged the framebuffer while we dropped locks
2343 * in the backoff code. We need to fix up the fb refcount tracking the
2346 crtc
->primary
->old_fb
= crtc
->primary
->fb
;
2350 EXPORT_SYMBOL(drm_atomic_helper_set_config
);
2352 /* just used from fb-helper and atomic-helper: */
2353 int __drm_atomic_helper_set_config(struct drm_mode_set
*set
,
2354 struct drm_atomic_state
*state
)
2356 struct drm_crtc_state
*crtc_state
;
2357 struct drm_plane_state
*primary_state
;
2358 struct drm_crtc
*crtc
= set
->crtc
;
2359 int hdisplay
, vdisplay
;
2362 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2363 if (IS_ERR(crtc_state
))
2364 return PTR_ERR(crtc_state
);
2366 primary_state
= drm_atomic_get_plane_state(state
, crtc
->primary
);
2367 if (IS_ERR(primary_state
))
2368 return PTR_ERR(primary_state
);
2372 WARN_ON(set
->num_connectors
);
2374 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, NULL
);
2378 crtc_state
->active
= false;
2380 ret
= drm_atomic_set_crtc_for_plane(primary_state
, NULL
);
2384 drm_atomic_set_fb_for_plane(primary_state
, NULL
);
2390 WARN_ON(!set
->num_connectors
);
2392 ret
= drm_atomic_set_mode_for_crtc(crtc_state
, set
->mode
);
2396 crtc_state
->active
= true;
2398 ret
= drm_atomic_set_crtc_for_plane(primary_state
, crtc
);
2402 drm_crtc_get_hv_timing(set
->mode
, &hdisplay
, &vdisplay
);
2404 drm_atomic_set_fb_for_plane(primary_state
, set
->fb
);
2405 primary_state
->crtc_x
= 0;
2406 primary_state
->crtc_y
= 0;
2407 primary_state
->crtc_w
= hdisplay
;
2408 primary_state
->crtc_h
= vdisplay
;
2409 primary_state
->src_x
= set
->x
<< 16;
2410 primary_state
->src_y
= set
->y
<< 16;
2411 if (primary_state
->rotation
& (DRM_ROTATE_90
| DRM_ROTATE_270
)) {
2412 primary_state
->src_w
= vdisplay
<< 16;
2413 primary_state
->src_h
= hdisplay
<< 16;
2415 primary_state
->src_w
= hdisplay
<< 16;
2416 primary_state
->src_h
= vdisplay
<< 16;
2420 ret
= update_output_state(state
, set
);
2428 * drm_atomic_helper_disable_all - disable all currently active outputs
2430 * @ctx: lock acquisition context
2432 * Loops through all connectors, finding those that aren't turned off and then
2433 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2434 * that they are connected to.
2436 * This is used for example in suspend/resume to disable all currently active
2437 * functions when suspending.
2439 * Note that if callers haven't already acquired all modeset locks this might
2440 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2443 * 0 on success or a negative error code on failure.
2446 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2448 int drm_atomic_helper_disable_all(struct drm_device
*dev
,
2449 struct drm_modeset_acquire_ctx
*ctx
)
2451 struct drm_atomic_state
*state
;
2452 struct drm_connector
*conn
;
2455 state
= drm_atomic_state_alloc(dev
);
2459 state
->acquire_ctx
= ctx
;
2461 drm_for_each_connector(conn
, dev
) {
2462 struct drm_crtc
*crtc
= conn
->state
->crtc
;
2463 struct drm_crtc_state
*crtc_state
;
2465 if (!crtc
|| conn
->dpms
!= DRM_MODE_DPMS_ON
)
2468 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2469 if (IS_ERR(crtc_state
)) {
2470 err
= PTR_ERR(crtc_state
);
2474 crtc_state
->active
= false;
2477 err
= drm_atomic_commit(state
);
2481 drm_atomic_state_free(state
);
2485 EXPORT_SYMBOL(drm_atomic_helper_disable_all
);
2488 * drm_atomic_helper_suspend - subsystem-level suspend helper
2491 * Duplicates the current atomic state, disables all active outputs and then
2492 * returns a pointer to the original atomic state to the caller. Drivers can
2493 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2494 * restore the output configuration that was active at the time the system
2497 * Note that it is potentially unsafe to use this. The atomic state object
2498 * returned by this function is assumed to be persistent. Drivers must ensure
2499 * that this holds true. Before calling this function, drivers must make sure
2500 * to suspend fbdev emulation so that nothing can be using the device.
2503 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2504 * encoded error code on failure. Drivers should store the returned atomic
2505 * state object and pass it to the drm_atomic_helper_resume() helper upon
2509 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2510 * drm_atomic_helper_resume()
2512 struct drm_atomic_state
*drm_atomic_helper_suspend(struct drm_device
*dev
)
2514 struct drm_modeset_acquire_ctx ctx
;
2515 struct drm_atomic_state
*state
;
2518 drm_modeset_acquire_init(&ctx
, 0);
2521 err
= drm_modeset_lock_all_ctx(dev
, &ctx
);
2523 state
= ERR_PTR(err
);
2527 state
= drm_atomic_helper_duplicate_state(dev
, &ctx
);
2531 err
= drm_atomic_helper_disable_all(dev
, &ctx
);
2533 drm_atomic_state_free(state
);
2534 state
= ERR_PTR(err
);
2539 if (PTR_ERR(state
) == -EDEADLK
) {
2540 drm_modeset_backoff(&ctx
);
2544 drm_modeset_drop_locks(&ctx
);
2545 drm_modeset_acquire_fini(&ctx
);
2548 EXPORT_SYMBOL(drm_atomic_helper_suspend
);
2551 * drm_atomic_helper_resume - subsystem-level resume helper
2553 * @state: atomic state to resume to
2555 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2556 * grabs all modeset locks and commits the atomic state object. This can be
2557 * used in conjunction with the drm_atomic_helper_suspend() helper to
2558 * implement suspend/resume for drivers that support atomic mode-setting.
2561 * 0 on success or a negative error code on failure.
2564 * drm_atomic_helper_suspend()
2566 int drm_atomic_helper_resume(struct drm_device
*dev
,
2567 struct drm_atomic_state
*state
)
2569 struct drm_mode_config
*config
= &dev
->mode_config
;
2572 drm_mode_config_reset(dev
);
2573 drm_modeset_lock_all(dev
);
2574 state
->acquire_ctx
= config
->acquire_ctx
;
2575 err
= drm_atomic_commit(state
);
2576 drm_modeset_unlock_all(dev
);
2580 EXPORT_SYMBOL(drm_atomic_helper_resume
);
2583 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2585 * @property: DRM property
2586 * @val: value of property
2588 * Provides a default crtc set_property handler using the atomic driver
2592 * Zero on success, error code on failure
2595 drm_atomic_helper_crtc_set_property(struct drm_crtc
*crtc
,
2596 struct drm_property
*property
,
2599 struct drm_atomic_state
*state
;
2600 struct drm_crtc_state
*crtc_state
;
2603 state
= drm_atomic_state_alloc(crtc
->dev
);
2607 /* ->set_property is always called with all locks held. */
2608 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
2610 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2611 if (IS_ERR(crtc_state
)) {
2612 ret
= PTR_ERR(crtc_state
);
2616 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
2621 ret
= drm_atomic_commit(state
);
2625 /* Driver takes ownership of state on successful commit. */
2628 if (ret
== -EDEADLK
)
2631 drm_atomic_state_free(state
);
2635 drm_atomic_state_clear(state
);
2636 drm_atomic_legacy_backoff(state
);
2640 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property
);
2643 * drm_atomic_helper_plane_set_property - helper for plane properties
2645 * @property: DRM property
2646 * @val: value of property
2648 * Provides a default plane set_property handler using the atomic driver
2652 * Zero on success, error code on failure
2655 drm_atomic_helper_plane_set_property(struct drm_plane
*plane
,
2656 struct drm_property
*property
,
2659 struct drm_atomic_state
*state
;
2660 struct drm_plane_state
*plane_state
;
2663 state
= drm_atomic_state_alloc(plane
->dev
);
2667 /* ->set_property is always called with all locks held. */
2668 state
->acquire_ctx
= plane
->dev
->mode_config
.acquire_ctx
;
2670 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2671 if (IS_ERR(plane_state
)) {
2672 ret
= PTR_ERR(plane_state
);
2676 ret
= drm_atomic_plane_set_property(plane
, plane_state
,
2681 ret
= drm_atomic_commit(state
);
2685 /* Driver takes ownership of state on successful commit. */
2688 if (ret
== -EDEADLK
)
2691 drm_atomic_state_free(state
);
2695 drm_atomic_state_clear(state
);
2696 drm_atomic_legacy_backoff(state
);
2700 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property
);
2703 * drm_atomic_helper_connector_set_property - helper for connector properties
2704 * @connector: DRM connector
2705 * @property: DRM property
2706 * @val: value of property
2708 * Provides a default connector set_property handler using the atomic driver
2712 * Zero on success, error code on failure
2715 drm_atomic_helper_connector_set_property(struct drm_connector
*connector
,
2716 struct drm_property
*property
,
2719 struct drm_atomic_state
*state
;
2720 struct drm_connector_state
*connector_state
;
2723 state
= drm_atomic_state_alloc(connector
->dev
);
2727 /* ->set_property is always called with all locks held. */
2728 state
->acquire_ctx
= connector
->dev
->mode_config
.acquire_ctx
;
2730 connector_state
= drm_atomic_get_connector_state(state
, connector
);
2731 if (IS_ERR(connector_state
)) {
2732 ret
= PTR_ERR(connector_state
);
2736 ret
= drm_atomic_connector_set_property(connector
, connector_state
,
2741 ret
= drm_atomic_commit(state
);
2745 /* Driver takes ownership of state on successful commit. */
2748 if (ret
== -EDEADLK
)
2751 drm_atomic_state_free(state
);
2755 drm_atomic_state_clear(state
);
2756 drm_atomic_legacy_backoff(state
);
2760 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property
);
2763 * drm_atomic_helper_page_flip - execute a legacy page flip
2765 * @fb: DRM framebuffer
2766 * @event: optional DRM event to signal upon completion
2767 * @flags: flip flags for non-vblank sync'ed updates
2769 * Provides a default page flip implementation using the atomic driver interface.
2771 * Note that for now so called async page flips (i.e. updates which are not
2772 * synchronized to vblank) are not supported, since the atomic interfaces have
2773 * no provisions for this yet.
2776 * Returns 0 on success, negative errno numbers on failure.
2778 int drm_atomic_helper_page_flip(struct drm_crtc
*crtc
,
2779 struct drm_framebuffer
*fb
,
2780 struct drm_pending_vblank_event
*event
,
2783 struct drm_plane
*plane
= crtc
->primary
;
2784 struct drm_atomic_state
*state
;
2785 struct drm_plane_state
*plane_state
;
2786 struct drm_crtc_state
*crtc_state
;
2789 if (flags
& DRM_MODE_PAGE_FLIP_ASYNC
)
2792 state
= drm_atomic_state_alloc(plane
->dev
);
2796 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2798 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2799 if (IS_ERR(crtc_state
)) {
2800 ret
= PTR_ERR(crtc_state
);
2803 crtc_state
->event
= event
;
2805 plane_state
= drm_atomic_get_plane_state(state
, plane
);
2806 if (IS_ERR(plane_state
)) {
2807 ret
= PTR_ERR(plane_state
);
2811 ret
= drm_atomic_set_crtc_for_plane(plane_state
, crtc
);
2814 drm_atomic_set_fb_for_plane(plane_state
, fb
);
2816 /* Make sure we don't accidentally do a full modeset. */
2817 state
->allow_modeset
= false;
2818 if (!crtc_state
->active
) {
2819 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2825 ret
= drm_atomic_nonblocking_commit(state
);
2829 /* Driver takes ownership of state on successful commit. */
2832 if (ret
== -EDEADLK
)
2835 drm_atomic_state_free(state
);
2839 drm_atomic_state_clear(state
);
2840 drm_atomic_legacy_backoff(state
);
2843 * Someone might have exchanged the framebuffer while we dropped locks
2844 * in the backoff code. We need to fix up the fb refcount tracking the
2847 plane
->old_fb
= plane
->fb
;
2851 EXPORT_SYMBOL(drm_atomic_helper_page_flip
);
2854 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2855 * @connector: affected connector
2858 * This is the main helper function provided by the atomic helper framework for
2859 * implementing the legacy DPMS connector interface. It computes the new desired
2860 * ->active state for the corresponding CRTC (if the connector is enabled) and
2864 * Returns 0 on success, negative errno numbers on failure.
2866 int drm_atomic_helper_connector_dpms(struct drm_connector
*connector
,
2869 struct drm_mode_config
*config
= &connector
->dev
->mode_config
;
2870 struct drm_atomic_state
*state
;
2871 struct drm_crtc_state
*crtc_state
;
2872 struct drm_crtc
*crtc
;
2873 struct drm_connector
*tmp_connector
;
2875 bool active
= false;
2876 int old_mode
= connector
->dpms
;
2878 if (mode
!= DRM_MODE_DPMS_ON
)
2879 mode
= DRM_MODE_DPMS_OFF
;
2881 connector
->dpms
= mode
;
2882 crtc
= connector
->state
->crtc
;
2887 state
= drm_atomic_state_alloc(connector
->dev
);
2891 state
->acquire_ctx
= drm_modeset_legacy_acquire_ctx(crtc
);
2893 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
2894 if (IS_ERR(crtc_state
)) {
2895 ret
= PTR_ERR(crtc_state
);
2899 WARN_ON(!drm_modeset_is_locked(&config
->connection_mutex
));
2901 drm_for_each_connector(tmp_connector
, connector
->dev
) {
2902 if (tmp_connector
->state
->crtc
!= crtc
)
2905 if (tmp_connector
->dpms
== DRM_MODE_DPMS_ON
) {
2910 crtc_state
->active
= active
;
2912 ret
= drm_atomic_commit(state
);
2916 /* Driver takes ownership of state on successful commit. */
2919 if (ret
== -EDEADLK
)
2922 connector
->dpms
= old_mode
;
2923 drm_atomic_state_free(state
);
2927 drm_atomic_state_clear(state
);
2928 drm_atomic_legacy_backoff(state
);
2932 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms
);
2935 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2936 * ->best_encoder callback
2937 * @connector: Connector control structure
2939 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2940 * connectors that support exactly 1 encoder, statically determined at driver
2943 struct drm_encoder
*
2944 drm_atomic_helper_best_encoder(struct drm_connector
*connector
)
2946 WARN_ON(connector
->encoder_ids
[1]);
2947 return drm_encoder_find(connector
->dev
, connector
->encoder_ids
[0]);
2949 EXPORT_SYMBOL(drm_atomic_helper_best_encoder
);
2952 * DOC: atomic state reset and initialization
2954 * Both the drm core and the atomic helpers assume that there is always the full
2955 * and correct atomic software state for all connectors, CRTCs and planes
2956 * available. Which is a bit a problem on driver load and also after system
2957 * suspend. One way to solve this is to have a hardware state read-out
2958 * infrastructure which reconstructs the full software state (e.g. the i915
2961 * The simpler solution is to just reset the software state to everything off,
2962 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2963 * the atomic helpers provide default reset implementations for all hooks.
2965 * On the upside the precise state tracking of atomic simplifies system suspend
2966 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2967 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2968 * For other drivers the building blocks are split out, see the documentation
2969 * for these functions.
2973 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2976 * Resets the atomic state for @crtc by freeing the state pointer (which might
2977 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2979 void drm_atomic_helper_crtc_reset(struct drm_crtc
*crtc
)
2982 __drm_atomic_helper_crtc_destroy_state(crtc
->state
);
2985 crtc
->state
= kzalloc(sizeof(*crtc
->state
), GFP_KERNEL
);
2988 crtc
->state
->crtc
= crtc
;
2990 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset
);
2993 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2994 * @crtc: CRTC object
2995 * @state: atomic CRTC state
2997 * Copies atomic state from a CRTC's current state and resets inferred values.
2998 * This is useful for drivers that subclass the CRTC state.
3000 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
,
3001 struct drm_crtc_state
*state
)
3003 memcpy(state
, crtc
->state
, sizeof(*state
));
3005 if (state
->mode_blob
)
3006 drm_property_reference_blob(state
->mode_blob
);
3007 if (state
->degamma_lut
)
3008 drm_property_reference_blob(state
->degamma_lut
);
3010 drm_property_reference_blob(state
->ctm
);
3011 if (state
->gamma_lut
)
3012 drm_property_reference_blob(state
->gamma_lut
);
3013 state
->mode_changed
= false;
3014 state
->active_changed
= false;
3015 state
->planes_changed
= false;
3016 state
->connectors_changed
= false;
3017 state
->color_mgmt_changed
= false;
3018 state
->zpos_changed
= false;
3019 state
->event
= NULL
;
3021 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state
);
3024 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3027 * Default CRTC state duplicate hook for drivers which don't have their own
3028 * subclassed CRTC state structure.
3030 struct drm_crtc_state
*
3031 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc
*crtc
)
3033 struct drm_crtc_state
*state
;
3035 if (WARN_ON(!crtc
->state
))
3038 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3040 __drm_atomic_helper_crtc_duplicate_state(crtc
, state
);
3044 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state
);
3047 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3048 * @state: CRTC state object to release
3050 * Releases all resources stored in the CRTC state without actually freeing
3051 * the memory of the CRTC state. This is useful for drivers that subclass the
3054 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state
*state
)
3056 drm_property_unreference_blob(state
->mode_blob
);
3057 drm_property_unreference_blob(state
->degamma_lut
);
3058 drm_property_unreference_blob(state
->ctm
);
3059 drm_property_unreference_blob(state
->gamma_lut
);
3061 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state
);
3064 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3066 * @state: CRTC state object to release
3068 * Default CRTC state destroy hook for drivers which don't have their own
3069 * subclassed CRTC state structure.
3071 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc
*crtc
,
3072 struct drm_crtc_state
*state
)
3074 __drm_atomic_helper_crtc_destroy_state(state
);
3077 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state
);
3080 * drm_atomic_helper_plane_reset - default ->reset hook for planes
3083 * Resets the atomic state for @plane by freeing the state pointer (which might
3084 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3086 void drm_atomic_helper_plane_reset(struct drm_plane
*plane
)
3089 __drm_atomic_helper_plane_destroy_state(plane
->state
);
3091 kfree(plane
->state
);
3092 plane
->state
= kzalloc(sizeof(*plane
->state
), GFP_KERNEL
);
3095 plane
->state
->plane
= plane
;
3096 plane
->state
->rotation
= DRM_ROTATE_0
;
3099 EXPORT_SYMBOL(drm_atomic_helper_plane_reset
);
3102 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3103 * @plane: plane object
3104 * @state: atomic plane state
3106 * Copies atomic state from a plane's current state. This is useful for
3107 * drivers that subclass the plane state.
3109 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
,
3110 struct drm_plane_state
*state
)
3112 memcpy(state
, plane
->state
, sizeof(*state
));
3115 drm_framebuffer_reference(state
->fb
);
3117 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state
);
3120 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3123 * Default plane state duplicate hook for drivers which don't have their own
3124 * subclassed plane state structure.
3126 struct drm_plane_state
*
3127 drm_atomic_helper_plane_duplicate_state(struct drm_plane
*plane
)
3129 struct drm_plane_state
*state
;
3131 if (WARN_ON(!plane
->state
))
3134 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3136 __drm_atomic_helper_plane_duplicate_state(plane
, state
);
3140 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state
);
3143 * __drm_atomic_helper_plane_destroy_state - release plane state
3144 * @state: plane state object to release
3146 * Releases all resources stored in the plane state without actually freeing
3147 * the memory of the plane state. This is useful for drivers that subclass the
3150 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state
*state
)
3153 drm_framebuffer_unreference(state
->fb
);
3155 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state
);
3158 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3160 * @state: plane state object to release
3162 * Default plane state destroy hook for drivers which don't have their own
3163 * subclassed plane state structure.
3165 void drm_atomic_helper_plane_destroy_state(struct drm_plane
*plane
,
3166 struct drm_plane_state
*state
)
3168 __drm_atomic_helper_plane_destroy_state(state
);
3171 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state
);
3174 * __drm_atomic_helper_connector_reset - reset state on connector
3175 * @connector: drm connector
3176 * @conn_state: connector state to assign
3178 * Initializes the newly allocated @conn_state and assigns it to
3179 * #connector ->state, usually required when initializing the drivers
3180 * or when called from the ->reset hook.
3182 * This is useful for drivers that subclass the connector state.
3185 __drm_atomic_helper_connector_reset(struct drm_connector
*connector
,
3186 struct drm_connector_state
*conn_state
)
3189 conn_state
->connector
= connector
;
3191 connector
->state
= conn_state
;
3193 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset
);
3196 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
3197 * @connector: drm connector
3199 * Resets the atomic state for @connector by freeing the state pointer (which
3200 * might be NULL, e.g. at driver load time) and allocating a new empty state
3203 void drm_atomic_helper_connector_reset(struct drm_connector
*connector
)
3205 struct drm_connector_state
*conn_state
=
3206 kzalloc(sizeof(*conn_state
), GFP_KERNEL
);
3208 if (connector
->state
)
3209 __drm_atomic_helper_connector_destroy_state(connector
->state
);
3211 kfree(connector
->state
);
3212 __drm_atomic_helper_connector_reset(connector
, conn_state
);
3214 EXPORT_SYMBOL(drm_atomic_helper_connector_reset
);
3217 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3218 * @connector: connector object
3219 * @state: atomic connector state
3221 * Copies atomic state from a connector's current state. This is useful for
3222 * drivers that subclass the connector state.
3225 __drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
,
3226 struct drm_connector_state
*state
)
3228 memcpy(state
, connector
->state
, sizeof(*state
));
3230 drm_connector_reference(connector
);
3232 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state
);
3235 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3236 * @connector: drm connector
3238 * Default connector state duplicate hook for drivers which don't have their own
3239 * subclassed connector state structure.
3241 struct drm_connector_state
*
3242 drm_atomic_helper_connector_duplicate_state(struct drm_connector
*connector
)
3244 struct drm_connector_state
*state
;
3246 if (WARN_ON(!connector
->state
))
3249 state
= kmalloc(sizeof(*state
), GFP_KERNEL
);
3251 __drm_atomic_helper_connector_duplicate_state(connector
, state
);
3255 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state
);
3258 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3260 * @ctx: lock acquisition context
3262 * Makes a copy of the current atomic state by looping over all objects and
3263 * duplicating their respective states. This is used for example by suspend/
3264 * resume support code to save the state prior to suspend such that it can
3265 * be restored upon resume.
3267 * Note that this treats atomic state as persistent between save and restore.
3268 * Drivers must make sure that this is possible and won't result in confusion
3269 * or erroneous behaviour.
3271 * Note that if callers haven't already acquired all modeset locks this might
3272 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3275 * A pointer to the copy of the atomic state object on success or an
3276 * ERR_PTR()-encoded error code on failure.
3279 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3281 struct drm_atomic_state
*
3282 drm_atomic_helper_duplicate_state(struct drm_device
*dev
,
3283 struct drm_modeset_acquire_ctx
*ctx
)
3285 struct drm_atomic_state
*state
;
3286 struct drm_connector
*conn
;
3287 struct drm_plane
*plane
;
3288 struct drm_crtc
*crtc
;
3291 state
= drm_atomic_state_alloc(dev
);
3293 return ERR_PTR(-ENOMEM
);
3295 state
->acquire_ctx
= ctx
;
3297 drm_for_each_crtc(crtc
, dev
) {
3298 struct drm_crtc_state
*crtc_state
;
3300 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3301 if (IS_ERR(crtc_state
)) {
3302 err
= PTR_ERR(crtc_state
);
3307 drm_for_each_plane(plane
, dev
) {
3308 struct drm_plane_state
*plane_state
;
3310 plane_state
= drm_atomic_get_plane_state(state
, plane
);
3311 if (IS_ERR(plane_state
)) {
3312 err
= PTR_ERR(plane_state
);
3317 drm_for_each_connector(conn
, dev
) {
3318 struct drm_connector_state
*conn_state
;
3320 conn_state
= drm_atomic_get_connector_state(state
, conn
);
3321 if (IS_ERR(conn_state
)) {
3322 err
= PTR_ERR(conn_state
);
3327 /* clear the acquire context so that it isn't accidentally reused */
3328 state
->acquire_ctx
= NULL
;
3332 drm_atomic_state_free(state
);
3333 state
= ERR_PTR(err
);
3338 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state
);
3341 * __drm_atomic_helper_connector_destroy_state - release connector state
3342 * @state: connector state object to release
3344 * Releases all resources stored in the connector state without actually
3345 * freeing the memory of the connector state. This is useful for drivers that
3346 * subclass the connector state.
3349 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state
*state
)
3352 * This is currently a placeholder so that drivers that subclass the
3353 * state will automatically do the right thing if code is ever added
3357 drm_connector_unreference(state
->connector
);
3359 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state
);
3362 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3363 * @connector: drm connector
3364 * @state: connector state object to release
3366 * Default connector state destroy hook for drivers which don't have their own
3367 * subclassed connector state structure.
3369 void drm_atomic_helper_connector_destroy_state(struct drm_connector
*connector
,
3370 struct drm_connector_state
*state
)
3372 __drm_atomic_helper_connector_destroy_state(state
);
3375 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state
);
3378 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3379 * @crtc: CRTC object
3380 * @red: red correction table
3381 * @green: green correction table
3382 * @blue: green correction table
3383 * @size: size of the tables
3385 * Implements support for legacy gamma correction table for drivers
3386 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3389 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc
*crtc
,
3390 u16
*red
, u16
*green
, u16
*blue
,
3393 struct drm_device
*dev
= crtc
->dev
;
3394 struct drm_mode_config
*config
= &dev
->mode_config
;
3395 struct drm_atomic_state
*state
;
3396 struct drm_crtc_state
*crtc_state
;
3397 struct drm_property_blob
*blob
= NULL
;
3398 struct drm_color_lut
*blob_data
;
3401 state
= drm_atomic_state_alloc(crtc
->dev
);
3405 blob
= drm_property_create_blob(dev
,
3406 sizeof(struct drm_color_lut
) * size
,
3409 ret
= PTR_ERR(blob
);
3414 /* Prepare GAMMA_LUT with the legacy values. */
3415 blob_data
= (struct drm_color_lut
*) blob
->data
;
3416 for (i
= 0; i
< size
; i
++) {
3417 blob_data
[i
].red
= red
[i
];
3418 blob_data
[i
].green
= green
[i
];
3419 blob_data
[i
].blue
= blue
[i
];
3422 state
->acquire_ctx
= crtc
->dev
->mode_config
.acquire_ctx
;
3424 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
3425 if (IS_ERR(crtc_state
)) {
3426 ret
= PTR_ERR(crtc_state
);
3430 /* Reset DEGAMMA_LUT and CTM properties. */
3431 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3432 config
->degamma_lut_property
, 0);
3436 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3437 config
->ctm_property
, 0);
3441 ret
= drm_atomic_crtc_set_property(crtc
, crtc_state
,
3442 config
->gamma_lut_property
, blob
->base
.id
);
3446 ret
= drm_atomic_commit(state
);
3450 /* Driver takes ownership of state on successful commit. */
3452 drm_property_unreference_blob(blob
);
3456 if (ret
== -EDEADLK
)
3459 drm_atomic_state_free(state
);
3460 drm_property_unreference_blob(blob
);
3464 drm_atomic_state_clear(state
);
3465 drm_atomic_legacy_backoff(state
);
3469 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set
);