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/dma-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 *old_plane_state,
67 struct drm_plane_state *plane_state,
68 struct drm_plane *plane)
70 struct drm_crtc_state *crtc_state;
72 if (old_plane_state->crtc) {
73 crtc_state = drm_atomic_get_new_crtc_state(state,
74 old_plane_state->crtc);
76 if (WARN_ON(!crtc_state))
79 crtc_state->planes_changed = true;
82 if (plane_state->crtc) {
83 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
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 *new_conn_state;
96 struct drm_connector *connector;
97 struct drm_connector_list_iter conn_iter;
98 struct drm_encoder *encoder;
99 unsigned encoder_mask = 0;
103 * First loop, find all newly assigned encoders from the connectors
104 * part of the state. If the same encoder is assigned to multiple
105 * connectors bail out.
107 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
108 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
109 struct drm_encoder *new_encoder;
111 if (!new_conn_state->crtc)
114 if (funcs->atomic_best_encoder)
115 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
116 else if (funcs->best_encoder)
117 new_encoder = funcs->best_encoder(connector);
119 new_encoder = drm_atomic_helper_best_encoder(connector);
122 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
123 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
124 new_encoder->base.id, new_encoder->name,
125 connector->base.id, connector->name);
130 encoder_mask |= 1 << drm_encoder_index(new_encoder);
138 * Second loop, iterate over all connectors not part of the state.
140 * If a conflicting encoder is found and disable_conflicting_encoders
141 * is not set, an error is returned. Userspace can provide a solution
142 * through the atomic ioctl.
144 * If the flag is set conflicting connectors are removed from the crtc
145 * and the crtc is disabled if no encoder is left. This preserves
146 * compatibility with the legacy set_config behavior.
148 drm_connector_list_iter_begin(state->dev, &conn_iter);
149 drm_for_each_connector_iter(connector, &conn_iter) {
150 struct drm_crtc_state *crtc_state;
152 if (drm_atomic_get_new_connector_state(state, connector))
155 encoder = connector->state->best_encoder;
156 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
159 if (!disable_conflicting_encoders) {
160 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
161 encoder->base.id, encoder->name,
162 connector->state->crtc->base.id,
163 connector->state->crtc->name,
164 connector->base.id, connector->name);
169 new_conn_state = drm_atomic_get_connector_state(state, connector);
170 if (IS_ERR(new_conn_state)) {
171 ret = PTR_ERR(new_conn_state);
175 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
176 encoder->base.id, encoder->name,
177 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
178 connector->base.id, connector->name);
180 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
182 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
186 if (!crtc_state->connector_mask) {
187 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
192 crtc_state->active = false;
196 drm_connector_list_iter_end(&conn_iter);
202 set_best_encoder(struct drm_atomic_state *state,
203 struct drm_connector_state *conn_state,
204 struct drm_encoder *encoder)
206 struct drm_crtc_state *crtc_state;
207 struct drm_crtc *crtc;
209 if (conn_state->best_encoder) {
210 /* Unset the encoder_mask in the old crtc state. */
211 crtc = conn_state->connector->state->crtc;
213 /* A NULL crtc is an error here because we should have
214 * duplicated a NULL best_encoder when crtc was NULL.
215 * As an exception restoring duplicated atomic state
216 * during resume is allowed, so don't warn when
217 * best_encoder is equal to encoder we intend to set.
219 WARN_ON(!crtc && encoder != conn_state->best_encoder);
221 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
223 crtc_state->encoder_mask &=
224 ~(1 << drm_encoder_index(conn_state->best_encoder));
229 crtc = conn_state->crtc;
232 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
234 crtc_state->encoder_mask |=
235 1 << drm_encoder_index(encoder);
239 conn_state->best_encoder = encoder;
243 steal_encoder(struct drm_atomic_state *state,
244 struct drm_encoder *encoder)
246 struct drm_crtc_state *crtc_state;
247 struct drm_connector *connector;
248 struct drm_connector_state *old_connector_state, *new_connector_state;
251 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
252 struct drm_crtc *encoder_crtc;
254 if (new_connector_state->best_encoder != encoder)
257 encoder_crtc = old_connector_state->crtc;
259 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
260 encoder->base.id, encoder->name,
261 encoder_crtc->base.id, encoder_crtc->name);
263 set_best_encoder(state, new_connector_state, NULL);
265 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
266 crtc_state->connectors_changed = true;
273 update_connector_routing(struct drm_atomic_state *state,
274 struct drm_connector *connector,
275 struct drm_connector_state *old_connector_state,
276 struct drm_connector_state *new_connector_state)
278 const struct drm_connector_helper_funcs *funcs;
279 struct drm_encoder *new_encoder;
280 struct drm_crtc_state *crtc_state;
282 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
286 if (old_connector_state->crtc != new_connector_state->crtc) {
287 if (old_connector_state->crtc) {
288 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
289 crtc_state->connectors_changed = true;
292 if (new_connector_state->crtc) {
293 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
294 crtc_state->connectors_changed = true;
298 if (!new_connector_state->crtc) {
299 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
303 set_best_encoder(state, new_connector_state, NULL);
308 funcs = connector->helper_private;
310 if (funcs->atomic_best_encoder)
311 new_encoder = funcs->atomic_best_encoder(connector,
312 new_connector_state);
313 else if (funcs->best_encoder)
314 new_encoder = funcs->best_encoder(connector);
316 new_encoder = drm_atomic_helper_best_encoder(connector);
319 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
325 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
326 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
327 new_encoder->base.id,
329 new_connector_state->crtc->base.id,
330 new_connector_state->crtc->name);
334 if (new_encoder == new_connector_state->best_encoder) {
335 set_best_encoder(state, new_connector_state, new_encoder);
337 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
340 new_encoder->base.id,
342 new_connector_state->crtc->base.id,
343 new_connector_state->crtc->name);
348 steal_encoder(state, new_encoder);
350 set_best_encoder(state, new_connector_state, new_encoder);
352 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
353 crtc_state->connectors_changed = true;
355 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
358 new_encoder->base.id,
360 new_connector_state->crtc->base.id,
361 new_connector_state->crtc->name);
367 mode_fixup(struct drm_atomic_state *state)
369 struct drm_crtc *crtc;
370 struct drm_crtc_state *new_crtc_state;
371 struct drm_connector *connector;
372 struct drm_connector_state *new_conn_state;
376 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
377 if (!new_crtc_state->mode_changed &&
378 !new_crtc_state->connectors_changed)
381 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
384 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
385 const struct drm_encoder_helper_funcs *funcs;
386 struct drm_encoder *encoder;
388 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
390 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
394 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
397 * Each encoder has at most one connector (since we always steal
398 * it away), so we won't call ->mode_fixup twice.
400 encoder = new_conn_state->best_encoder;
401 funcs = encoder->helper_private;
403 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
404 &new_crtc_state->adjusted_mode);
406 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
410 if (funcs && funcs->atomic_check) {
411 ret = funcs->atomic_check(encoder, new_crtc_state,
414 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
415 encoder->base.id, encoder->name);
418 } else if (funcs && funcs->mode_fixup) {
419 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
420 &new_crtc_state->adjusted_mode);
422 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
423 encoder->base.id, encoder->name);
429 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
430 const struct drm_crtc_helper_funcs *funcs;
432 if (!new_crtc_state->enable)
435 if (!new_crtc_state->mode_changed &&
436 !new_crtc_state->connectors_changed)
439 funcs = crtc->helper_private;
440 if (!funcs->mode_fixup)
443 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
444 &new_crtc_state->adjusted_mode);
446 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
447 crtc->base.id, crtc->name);
456 * drm_atomic_helper_check_modeset - validate state object for modeset changes
458 * @state: the driver state object
460 * Check the state object to see if the requested state is physically possible.
461 * This does all the crtc and connector related computations for an atomic
462 * update and adds any additional connectors needed for full modesets and calls
463 * down into &drm_crtc_helper_funcs.mode_fixup and
464 * &drm_encoder_helper_funcs.mode_fixup or
465 * &drm_encoder_helper_funcs.atomic_check functions of the driver backend.
467 * &drm_crtc_state.mode_changed is set when the input mode is changed.
468 * &drm_crtc_state.connectors_changed is set when a connector is added or
469 * removed from the crtc. &drm_crtc_state.active_changed is set when
470 * &drm_crtc_state.active changes, which is used for DPMS.
471 * See also: drm_atomic_crtc_needs_modeset()
475 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
476 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
477 * without a full modeset) _must_ call this function afterwards after that
478 * change. It is permitted to call this function multiple times for the same
479 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
480 * upon the adjusted dotclock for fifo space allocation and watermark
484 * Zero for success or -errno
487 drm_atomic_helper_check_modeset(struct drm_device *dev,
488 struct drm_atomic_state *state)
490 struct drm_crtc *crtc;
491 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
492 struct drm_connector *connector;
493 struct drm_connector_state *old_connector_state, *new_connector_state;
496 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
497 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
498 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
499 crtc->base.id, crtc->name);
500 new_crtc_state->mode_changed = true;
503 if (old_crtc_state->enable != new_crtc_state->enable) {
504 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
505 crtc->base.id, crtc->name);
508 * For clarity this assignment is done here, but
509 * enable == 0 is only true when there are no
510 * connectors and a NULL mode.
512 * The other way around is true as well. enable != 0
513 * iff connectors are attached and a mode is set.
515 new_crtc_state->mode_changed = true;
516 new_crtc_state->connectors_changed = true;
520 ret = handle_conflicting_encoders(state, state->legacy_set_config);
524 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
526 * This only sets crtc->connectors_changed for routing changes,
527 * drivers must set crtc->connectors_changed themselves when
528 * connector properties need to be updated.
530 ret = update_connector_routing(state, connector,
532 new_connector_state);
535 if (old_connector_state->crtc) {
536 new_crtc_state = drm_atomic_get_new_crtc_state(state,
537 old_connector_state->crtc);
538 if (old_connector_state->link_status !=
539 new_connector_state->link_status)
540 new_crtc_state->connectors_changed = true;
545 * After all the routing has been prepared we need to add in any
546 * connector which is itself unchanged, but who's crtc changes it's
547 * configuration. This must be done before calling mode_fixup in case a
548 * crtc only changed its mode but has the same set of connectors.
550 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
551 bool has_connectors =
552 !!new_crtc_state->connector_mask;
555 * We must set ->active_changed after walking connectors for
556 * otherwise an update that only changes active would result in
557 * a full modeset because update_connector_routing force that.
559 if (old_crtc_state->active != new_crtc_state->active) {
560 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
561 crtc->base.id, crtc->name);
562 new_crtc_state->active_changed = true;
565 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
568 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
569 crtc->base.id, crtc->name,
570 new_crtc_state->enable ? 'y' : 'n',
571 new_crtc_state->active ? 'y' : 'n');
573 ret = drm_atomic_add_affected_connectors(state, crtc);
577 ret = drm_atomic_add_affected_planes(state, crtc);
581 if (new_crtc_state->enable != has_connectors) {
582 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
583 crtc->base.id, crtc->name);
589 return mode_fixup(state);
591 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
594 * drm_atomic_helper_check_planes - validate state object for planes changes
596 * @state: the driver state object
598 * Check the state object to see if the requested state is physically possible.
599 * This does all the plane update related checks using by calling into the
600 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
601 * hooks provided by the driver.
603 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
607 * Zero for success or -errno
610 drm_atomic_helper_check_planes(struct drm_device *dev,
611 struct drm_atomic_state *state)
613 struct drm_crtc *crtc;
614 struct drm_crtc_state *new_crtc_state;
615 struct drm_plane *plane;
616 struct drm_plane_state *new_plane_state, *old_plane_state;
619 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
620 const struct drm_plane_helper_funcs *funcs;
622 funcs = plane->helper_private;
624 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
626 if (!funcs || !funcs->atomic_check)
629 ret = funcs->atomic_check(plane, new_plane_state);
631 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
632 plane->base.id, plane->name);
637 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
638 const struct drm_crtc_helper_funcs *funcs;
640 funcs = crtc->helper_private;
642 if (!funcs || !funcs->atomic_check)
645 ret = funcs->atomic_check(crtc, new_crtc_state);
647 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
648 crtc->base.id, crtc->name);
655 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
658 * drm_atomic_helper_check - validate state object
660 * @state: the driver state object
662 * Check the state object to see if the requested state is physically possible.
663 * Only crtcs and planes have check callbacks, so for any additional (global)
664 * checking that a driver needs it can simply wrap that around this function.
665 * Drivers without such needs can directly use this as their
666 * &drm_mode_config_funcs.atomic_check callback.
668 * This just wraps the two parts of the state checking for planes and modeset
669 * state in the default order: First it calls drm_atomic_helper_check_modeset()
670 * and then drm_atomic_helper_check_planes(). The assumption is that the
671 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
672 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
676 * Zero for success or -errno
678 int drm_atomic_helper_check(struct drm_device *dev,
679 struct drm_atomic_state *state)
683 ret = drm_atomic_helper_check_modeset(dev, state);
687 ret = drm_atomic_helper_check_planes(dev, state);
693 EXPORT_SYMBOL(drm_atomic_helper_check);
696 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
698 struct drm_connector *connector;
699 struct drm_connector_state *old_conn_state, *new_conn_state;
700 struct drm_crtc *crtc;
701 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
704 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
705 const struct drm_encoder_helper_funcs *funcs;
706 struct drm_encoder *encoder;
708 /* Shut down everything that's in the changeset and currently
709 * still on. So need to check the old, saved state. */
710 if (!old_conn_state->crtc)
713 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
715 if (!old_crtc_state->active ||
716 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
719 encoder = old_conn_state->best_encoder;
721 /* We shouldn't get this far if we didn't previously have
722 * an encoder.. but WARN_ON() rather than explode.
724 if (WARN_ON(!encoder))
727 funcs = encoder->helper_private;
729 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
730 encoder->base.id, encoder->name);
733 * Each encoder has at most one connector (since we always steal
734 * it away), so we won't call disable hooks twice.
736 drm_bridge_disable(encoder->bridge);
738 /* Right function depends upon target state. */
740 if (new_conn_state->crtc && funcs->prepare)
741 funcs->prepare(encoder);
742 else if (funcs->disable)
743 funcs->disable(encoder);
744 else if (funcs->dpms)
745 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
748 drm_bridge_post_disable(encoder->bridge);
751 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
752 const struct drm_crtc_helper_funcs *funcs;
754 /* Shut down everything that needs a full modeset. */
755 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
758 if (!old_crtc_state->active)
761 funcs = crtc->helper_private;
763 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
764 crtc->base.id, crtc->name);
767 /* Right function depends upon target state. */
768 if (new_crtc_state->enable && funcs->prepare)
769 funcs->prepare(crtc);
770 else if (funcs->atomic_disable)
771 funcs->atomic_disable(crtc, old_crtc_state);
772 else if (funcs->disable)
773 funcs->disable(crtc);
775 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
780 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
782 * @old_state: atomic state object with old state structures
784 * This function updates all the various legacy modeset state pointers in
785 * connectors, encoders and crtcs. It also updates the timestamping constants
786 * used for precise vblank timestamps by calling
787 * drm_calc_timestamping_constants().
789 * Drivers can use this for building their own atomic commit if they don't have
790 * a pure helper-based modeset implementation.
793 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
794 struct drm_atomic_state *old_state)
796 struct drm_connector *connector;
797 struct drm_connector_state *old_conn_state, *new_conn_state;
798 struct drm_crtc *crtc;
799 struct drm_crtc_state *new_crtc_state;
802 /* clear out existing links and update dpms */
803 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
804 if (connector->encoder) {
805 WARN_ON(!connector->encoder->crtc);
807 connector->encoder->crtc = NULL;
808 connector->encoder = NULL;
811 crtc = new_conn_state->crtc;
812 if ((!crtc && old_conn_state->crtc) ||
813 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
814 struct drm_property *dpms_prop =
815 dev->mode_config.dpms_property;
816 int mode = DRM_MODE_DPMS_OFF;
818 if (crtc && crtc->state->active)
819 mode = DRM_MODE_DPMS_ON;
821 connector->dpms = mode;
822 drm_object_property_set_value(&connector->base,
828 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
829 if (!new_conn_state->crtc)
832 if (WARN_ON(!new_conn_state->best_encoder))
835 connector->encoder = new_conn_state->best_encoder;
836 connector->encoder->crtc = new_conn_state->crtc;
839 /* set legacy state in the crtc structure */
840 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
841 struct drm_plane *primary = crtc->primary;
842 struct drm_plane_state *new_plane_state;
844 crtc->mode = new_crtc_state->mode;
845 crtc->enabled = new_crtc_state->enable;
848 drm_atomic_get_new_plane_state(old_state, primary);
850 if (new_plane_state && new_plane_state->crtc == crtc) {
851 crtc->x = new_plane_state->src_x >> 16;
852 crtc->y = new_plane_state->src_y >> 16;
855 if (new_crtc_state->enable)
856 drm_calc_timestamping_constants(crtc,
857 &new_crtc_state->adjusted_mode);
860 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
863 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
865 struct drm_crtc *crtc;
866 struct drm_crtc_state *new_crtc_state;
867 struct drm_connector *connector;
868 struct drm_connector_state *new_conn_state;
871 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
872 const struct drm_crtc_helper_funcs *funcs;
874 if (!new_crtc_state->mode_changed)
877 funcs = crtc->helper_private;
879 if (new_crtc_state->enable && funcs->mode_set_nofb) {
880 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
881 crtc->base.id, crtc->name);
883 funcs->mode_set_nofb(crtc);
887 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
888 const struct drm_encoder_helper_funcs *funcs;
889 struct drm_encoder *encoder;
890 struct drm_display_mode *mode, *adjusted_mode;
892 if (!new_conn_state->best_encoder)
895 encoder = new_conn_state->best_encoder;
896 funcs = encoder->helper_private;
897 new_crtc_state = new_conn_state->crtc->state;
898 mode = &new_crtc_state->mode;
899 adjusted_mode = &new_crtc_state->adjusted_mode;
901 if (!new_crtc_state->mode_changed)
904 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
905 encoder->base.id, encoder->name);
908 * Each encoder has at most one connector (since we always steal
909 * it away), so we won't call mode_set hooks twice.
911 if (funcs && funcs->atomic_mode_set) {
912 funcs->atomic_mode_set(encoder, new_crtc_state,
914 } else if (funcs && funcs->mode_set) {
915 funcs->mode_set(encoder, mode, adjusted_mode);
918 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
923 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
925 * @old_state: atomic state object with old state structures
927 * This function shuts down all the outputs that need to be shut down and
928 * prepares them (if required) with the new mode.
930 * For compatibility with legacy crtc helpers this should be called before
931 * drm_atomic_helper_commit_planes(), which is what the default commit function
932 * does. But drivers with different needs can group the modeset commits together
933 * and do the plane commits at the end. This is useful for drivers doing runtime
934 * PM since planes updates then only happen when the CRTC is actually enabled.
936 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
937 struct drm_atomic_state *old_state)
939 disable_outputs(dev, old_state);
941 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
943 crtc_set_mode(dev, old_state);
945 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
948 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
950 * @old_state: atomic state object with old state structures
952 * This function enables all the outputs with the new configuration which had to
953 * be turned off for the update.
955 * For compatibility with legacy crtc helpers this should be called after
956 * drm_atomic_helper_commit_planes(), which is what the default commit function
957 * does. But drivers with different needs can group the modeset commits together
958 * and do the plane commits at the end. This is useful for drivers doing runtime
959 * PM since planes updates then only happen when the CRTC is actually enabled.
961 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
962 struct drm_atomic_state *old_state)
964 struct drm_crtc *crtc;
965 struct drm_crtc_state *new_crtc_state;
966 struct drm_connector *connector;
967 struct drm_connector_state *new_conn_state;
970 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
971 const struct drm_crtc_helper_funcs *funcs;
973 /* Need to filter out CRTCs where only planes change. */
974 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
977 if (!new_crtc_state->active)
980 funcs = crtc->helper_private;
982 if (new_crtc_state->enable) {
983 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
984 crtc->base.id, crtc->name);
993 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
994 const struct drm_encoder_helper_funcs *funcs;
995 struct drm_encoder *encoder;
997 if (!new_conn_state->best_encoder)
1000 if (!new_conn_state->crtc->state->active ||
1001 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1004 encoder = new_conn_state->best_encoder;
1005 funcs = encoder->helper_private;
1007 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1008 encoder->base.id, encoder->name);
1011 * Each encoder has at most one connector (since we always steal
1012 * it away), so we won't call enable hooks twice.
1014 drm_bridge_pre_enable(encoder->bridge);
1018 funcs->enable(encoder);
1019 else if (funcs->commit)
1020 funcs->commit(encoder);
1023 drm_bridge_enable(encoder->bridge);
1026 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1029 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1031 * @state: atomic state object with old state structures
1032 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1033 * Otherwise @state is the old state.
1035 * For implicit sync, driver should fish the exclusive fence out from the
1036 * incoming fb's and stash it in the drm_plane_state. This is called after
1037 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1038 * just uses the atomic state to find the changed planes)
1040 * Note that @pre_swap is needed since the point where we block for fences moves
1041 * around depending upon whether an atomic commit is blocking or
1042 * non-blocking. For async commit all waiting needs to happen after
1043 * drm_atomic_helper_swap_state() is called, but for synchronous commits we want
1044 * to wait **before** we do anything that can't be easily rolled back. That is
1045 * before we call drm_atomic_helper_swap_state().
1047 * Returns zero if success or < 0 if dma_fence_wait() fails.
1049 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1050 struct drm_atomic_state *state,
1053 struct drm_plane *plane;
1054 struct drm_plane_state *new_plane_state;
1057 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1058 if (!new_plane_state->fence)
1061 WARN_ON(!new_plane_state->fb);
1064 * If waiting for fences pre-swap (ie: nonblock), userspace can
1065 * still interrupt the operation. Instead of blocking until the
1066 * timer expires, make the wait interruptible.
1068 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1072 dma_fence_put(new_plane_state->fence);
1073 new_plane_state->fence = NULL;
1078 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1081 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1083 * @old_state: atomic state object with old state structures
1085 * Helper to, after atomic commit, wait for vblanks on all effected
1086 * crtcs (ie. before cleaning up old framebuffers using
1087 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1088 * framebuffers have actually changed to optimize for the legacy cursor and
1089 * plane update use-case.
1092 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1093 struct drm_atomic_state *old_state)
1095 struct drm_crtc *crtc;
1096 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1098 unsigned crtc_mask = 0;
1101 * Legacy cursor ioctls are completely unsynced, and userspace
1102 * relies on that (by doing tons of cursor updates).
1104 if (old_state->legacy_cursor_update)
1107 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1108 if (!new_crtc_state->active || !new_crtc_state->planes_changed)
1111 ret = drm_crtc_vblank_get(crtc);
1115 crtc_mask |= drm_crtc_mask(crtc);
1116 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1119 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1120 if (!(crtc_mask & drm_crtc_mask(crtc)))
1123 ret = wait_event_timeout(dev->vblank[i].queue,
1124 old_state->crtcs[i].last_vblank_count !=
1125 drm_crtc_vblank_count(crtc),
1126 msecs_to_jiffies(50));
1128 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1129 crtc->base.id, crtc->name);
1131 drm_crtc_vblank_put(crtc);
1134 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1137 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1138 * @old_state: atomic state object with old state structures
1140 * This is the default implementation for the
1141 * &drm_mode_config_helper_funcs.atomic_commit_tail hook.
1143 * Note that the default ordering of how the various stages are called is to
1144 * match the legacy modeset helper library closest. One peculiarity of that is
1145 * that it doesn't mesh well with runtime PM at all.
1147 * For drivers supporting runtime PM the recommended sequence is instead ::
1149 * drm_atomic_helper_commit_modeset_disables(dev, old_state);
1151 * drm_atomic_helper_commit_modeset_enables(dev, old_state);
1153 * drm_atomic_helper_commit_planes(dev, old_state,
1154 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
1156 * for committing the atomic update to hardware. See the kerneldoc entries for
1157 * these three functions for more details.
1159 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1161 struct drm_device *dev = old_state->dev;
1163 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1165 drm_atomic_helper_commit_planes(dev, old_state, 0);
1167 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1169 drm_atomic_helper_commit_hw_done(old_state);
1171 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1173 drm_atomic_helper_cleanup_planes(dev, old_state);
1175 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1177 static void commit_tail(struct drm_atomic_state *old_state)
1179 struct drm_device *dev = old_state->dev;
1180 const struct drm_mode_config_helper_funcs *funcs;
1182 funcs = dev->mode_config.helper_private;
1184 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1186 drm_atomic_helper_wait_for_dependencies(old_state);
1188 if (funcs && funcs->atomic_commit_tail)
1189 funcs->atomic_commit_tail(old_state);
1191 drm_atomic_helper_commit_tail(old_state);
1193 drm_atomic_helper_commit_cleanup_done(old_state);
1195 drm_atomic_state_put(old_state);
1198 static void commit_work(struct work_struct *work)
1200 struct drm_atomic_state *state = container_of(work,
1201 struct drm_atomic_state,
1207 * drm_atomic_helper_commit - commit validated state object
1209 * @state: the driver state object
1210 * @nonblock: whether nonblocking behavior is requested.
1212 * This function commits a with drm_atomic_helper_check() pre-validated state
1213 * object. This can still fail when e.g. the framebuffer reservation fails. This
1214 * function implements nonblocking commits, using
1215 * drm_atomic_helper_setup_commit() and related functions.
1217 * Committing the actual hardware state is done through the
1218 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default
1219 * implementation drm_atomic_helper_commit_tail().
1222 * Zero for success or -errno.
1224 int drm_atomic_helper_commit(struct drm_device *dev,
1225 struct drm_atomic_state *state,
1230 ret = drm_atomic_helper_setup_commit(state, nonblock);
1234 INIT_WORK(&state->commit_work, commit_work);
1236 ret = drm_atomic_helper_prepare_planes(dev, state);
1241 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1243 drm_atomic_helper_cleanup_planes(dev, state);
1249 * This is the point of no return - everything below never fails except
1250 * when the hw goes bonghits. Which means we can commit the new state on
1251 * the software side now.
1254 drm_atomic_helper_swap_state(state, true);
1257 * Everything below can be run asynchronously without the need to grab
1258 * any modeset locks at all under one condition: It must be guaranteed
1259 * that the asynchronous work has either been cancelled (if the driver
1260 * supports it, which at least requires that the framebuffers get
1261 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1262 * before the new state gets committed on the software side with
1263 * drm_atomic_helper_swap_state().
1265 * This scheme allows new atomic state updates to be prepared and
1266 * checked in parallel to the asynchronous completion of the previous
1267 * update. Which is important since compositors need to figure out the
1268 * composition of the next frame right after having submitted the
1271 * NOTE: Commit work has multiple phases, first hardware commit, then
1272 * cleanup. We want them to overlap, hence need system_unbound_wq to
1273 * make sure work items don't artifically stall on each another.
1276 drm_atomic_state_get(state);
1278 queue_work(system_unbound_wq, &state->commit_work);
1284 EXPORT_SYMBOL(drm_atomic_helper_commit);
1287 * DOC: implementing nonblocking commit
1289 * Nonblocking atomic commits have to be implemented in the following sequence:
1291 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1292 * which commit needs to call which can fail, so we want to run it first and
1295 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1296 * might be affected the new state update. This can be done by either cancelling
1297 * or flushing the work items, depending upon whether the driver can deal with
1298 * cancelled updates. Note that it is important to ensure that the framebuffer
1299 * cleanup is still done when cancelling.
1301 * Asynchronous workers need to have sufficient parallelism to be able to run
1302 * different atomic commits on different CRTCs in parallel. The simplest way to
1303 * achive this is by running them on the &system_unbound_wq work queue. Note
1304 * that drivers are not required to split up atomic commits and run an
1305 * individual commit in parallel - userspace is supposed to do that if it cares.
1306 * But it might be beneficial to do that for modesets, since those necessarily
1307 * must be done as one global operation, and enabling or disabling a CRTC can
1308 * take a long time. But even that is not required.
1310 * 3. The software state is updated synchronously with
1311 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1312 * locks means concurrent callers never see inconsistent state. And doing this
1313 * while it's guaranteed that no relevant nonblocking worker runs means that
1314 * nonblocking workers do not need grab any locks. Actually they must not grab
1315 * locks, for otherwise the work flushing will deadlock.
1317 * 4. Schedule a work item to do all subsequent steps, using the split-out
1318 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1319 * then cleaning up the framebuffers after the old framebuffer is no longer
1322 * The above scheme is implemented in the atomic helper libraries in
1323 * drm_atomic_helper_commit() using a bunch of helper functions. See
1324 * drm_atomic_helper_setup_commit() for a starting point.
1327 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1329 struct drm_crtc_commit *commit, *stall_commit = NULL;
1330 bool completed = true;
1334 spin_lock(&crtc->commit_lock);
1336 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1338 completed = try_wait_for_completion(&commit->flip_done);
1339 /* Userspace is not allowed to get ahead of the previous
1340 * commit with nonblocking ones. */
1341 if (!completed && nonblock) {
1342 spin_unlock(&crtc->commit_lock);
1345 } else if (i == 1) {
1346 stall_commit = commit;
1347 drm_crtc_commit_get(stall_commit);
1353 spin_unlock(&crtc->commit_lock);
1358 /* We don't want to let commits get ahead of cleanup work too much,
1359 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1361 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1364 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1365 crtc->base.id, crtc->name);
1367 drm_crtc_commit_put(stall_commit);
1369 return ret < 0 ? ret : 0;
1372 static void release_crtc_commit(struct completion *completion)
1374 struct drm_crtc_commit *commit = container_of(completion,
1378 drm_crtc_commit_put(commit);
1382 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1383 * @state: new modeset state to be committed
1384 * @nonblock: whether nonblocking behavior is requested.
1386 * This function prepares @state to be used by the atomic helper's support for
1387 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1388 * should always call this function from their
1389 * &drm_mode_config_funcs.atomic_commit hook.
1391 * To be able to use this support drivers need to use a few more helper
1392 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1393 * actually committing the hardware state, and for nonblocking commits this call
1394 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1395 * and it's stall parameter, for when a driver's commit hooks look at the
1396 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1398 * Completion of the hardware commit step must be signalled using
1399 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1400 * to read or change any permanent software or hardware modeset state. The only
1401 * exception is state protected by other means than &drm_modeset_lock locks.
1402 * Only the free standing @state with pointers to the old state structures can
1403 * be inspected, e.g. to clean up old buffers using
1404 * drm_atomic_helper_cleanup_planes().
1406 * At the very end, before cleaning up @state drivers must call
1407 * drm_atomic_helper_commit_cleanup_done().
1409 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1410 * complete and esay-to-use default implementation of the atomic_commit() hook.
1412 * The tracking of asynchronously executed and still pending commits is done
1413 * using the core structure &drm_crtc_commit.
1415 * By default there's no need to clean up resources allocated by this function
1416 * explicitly: drm_atomic_state_default_clear() will take care of that
1421 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1422 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1424 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1427 struct drm_crtc *crtc;
1428 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1429 struct drm_crtc_commit *commit;
1432 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1433 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1437 init_completion(&commit->flip_done);
1438 init_completion(&commit->hw_done);
1439 init_completion(&commit->cleanup_done);
1440 INIT_LIST_HEAD(&commit->commit_entry);
1441 kref_init(&commit->ref);
1442 commit->crtc = crtc;
1444 state->crtcs[i].commit = commit;
1446 ret = stall_checks(crtc, nonblock);
1450 /* Drivers only send out events when at least either current or
1451 * new CRTC state is active. Complete right away if everything
1453 if (!old_crtc_state->active && !new_crtc_state->active) {
1454 complete_all(&commit->flip_done);
1458 /* Legacy cursor updates are fully unsynced. */
1459 if (state->legacy_cursor_update) {
1460 complete_all(&commit->flip_done);
1464 if (!new_crtc_state->event) {
1465 commit->event = kzalloc(sizeof(*commit->event),
1470 new_crtc_state->event = commit->event;
1473 new_crtc_state->event->base.completion = &commit->flip_done;
1474 new_crtc_state->event->base.completion_release = release_crtc_commit;
1475 drm_crtc_commit_get(commit);
1480 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1483 static struct drm_crtc_commit *preceeding_commit(struct drm_crtc *crtc)
1485 struct drm_crtc_commit *commit;
1488 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1489 /* skip the first entry, that's the current commit */
1499 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1500 * @old_state: atomic state object with old state structures
1502 * This function waits for all preceeding commits that touch the same CRTC as
1503 * @old_state to both be committed to the hardware (as signalled by
1504 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1505 * by calling drm_crtc_vblank_send_event() on the &drm_crtc_state.event).
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 *old_state)
1512 struct drm_crtc *crtc;
1513 struct drm_crtc_state *new_crtc_state;
1514 struct drm_crtc_commit *commit;
1518 for_each_new_crtc_in_state(old_state, crtc, new_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 * @old_state: atomic state object with old state structures
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 *old_state)
1564 struct drm_crtc *crtc;
1565 struct drm_crtc_state *new_crtc_state;
1566 struct drm_crtc_commit *commit;
1569 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1570 commit = old_state->crtcs[i].commit;
1574 /* backend must have consumed any event by now */
1575 WARN_ON(new_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 * @old_state: atomic state object with old state structures
1587 * This signals completion of the atomic update @old_state, including any
1588 * cleanup work. If used, it must be called right before calling
1589 * drm_atomic_state_put().
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 *old_state)
1596 struct drm_crtc *crtc;
1597 struct drm_crtc_state *new_crtc_state;
1598 struct drm_crtc_commit *commit;
1602 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1603 commit = old_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, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
1643 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
1644 * any already successfully prepared framebuffer.
1647 * 0 on success, negative error code on failure.
1649 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1650 struct drm_atomic_state *state)
1652 struct drm_plane *plane;
1653 struct drm_plane_state *new_plane_state;
1656 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1657 const struct drm_plane_helper_funcs *funcs;
1659 funcs = plane->helper_private;
1661 if (funcs->prepare_fb) {
1662 ret = funcs->prepare_fb(plane, new_plane_state);
1671 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
1672 const struct drm_plane_helper_funcs *funcs;
1677 funcs = plane->helper_private;
1679 if (funcs->cleanup_fb)
1680 funcs->cleanup_fb(plane, new_plane_state);
1685 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1687 static bool plane_crtc_active(const struct drm_plane_state *state)
1689 return state->crtc && state->crtc->state->active;
1693 * drm_atomic_helper_commit_planes - commit plane state
1695 * @old_state: atomic state object with old state structures
1696 * @flags: flags for committing plane state
1698 * This function commits the new plane state using the plane and atomic helper
1699 * functions for planes and crtcs. It assumes that the atomic state has already
1700 * been pushed into the relevant object state pointers, since this step can no
1703 * It still requires the global state object @old_state to know which planes and
1704 * crtcs need to be updated though.
1706 * Note that this function does all plane updates across all CRTCs in one step.
1707 * If the hardware can't support this approach look at
1708 * drm_atomic_helper_commit_planes_on_crtc() instead.
1710 * Plane parameters can be updated by applications while the associated CRTC is
1711 * disabled. The DRM/KMS core will store the parameters in the plane state,
1712 * which will be available to the driver when the CRTC is turned on. As a result
1713 * most drivers don't need to be immediately notified of plane updates for a
1716 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
1717 * @flags in order not to receive plane update notifications related to a
1718 * disabled CRTC. This avoids the need to manually ignore plane updates in
1719 * driver code when the driver and/or hardware can't or just don't need to deal
1720 * with updates on disabled CRTCs, for example when supporting runtime PM.
1722 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
1723 * display controllers require to disable a CRTC's planes when the CRTC is
1724 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
1725 * call for a plane if the CRTC of the old plane state needs a modesetting
1726 * operation. Of course, the drivers need to disable the planes in their CRTC
1727 * disable callbacks since no one else would do that.
1729 * The drm_atomic_helper_commit() default implementation doesn't set the
1730 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
1731 * This should not be copied blindly by drivers.
1733 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1734 struct drm_atomic_state *old_state,
1737 struct drm_crtc *crtc;
1738 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1739 struct drm_plane *plane;
1740 struct drm_plane_state *old_plane_state, *new_plane_state;
1742 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
1743 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
1745 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1746 const struct drm_crtc_helper_funcs *funcs;
1748 funcs = crtc->helper_private;
1750 if (!funcs || !funcs->atomic_begin)
1753 if (active_only && !new_crtc_state->active)
1756 funcs->atomic_begin(crtc, old_crtc_state);
1759 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
1760 const struct drm_plane_helper_funcs *funcs;
1763 funcs = plane->helper_private;
1768 disabling = drm_atomic_plane_disabling(old_plane_state,
1773 * Skip planes related to inactive CRTCs. If the plane
1774 * is enabled use the state of the current CRTC. If the
1775 * plane is being disabled use the state of the old
1776 * CRTC to avoid skipping planes being disabled on an
1779 if (!disabling && !plane_crtc_active(new_plane_state))
1781 if (disabling && !plane_crtc_active(old_plane_state))
1786 * Special-case disabling the plane if drivers support it.
1788 if (disabling && funcs->atomic_disable) {
1789 struct drm_crtc_state *crtc_state;
1791 crtc_state = old_plane_state->crtc->state;
1793 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
1797 funcs->atomic_disable(plane, old_plane_state);
1798 } else if (new_plane_state->crtc || disabling) {
1799 funcs->atomic_update(plane, old_plane_state);
1803 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1804 const struct drm_crtc_helper_funcs *funcs;
1806 funcs = crtc->helper_private;
1808 if (!funcs || !funcs->atomic_flush)
1811 if (active_only && !new_crtc_state->active)
1814 funcs->atomic_flush(crtc, old_crtc_state);
1817 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1820 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1821 * @old_crtc_state: atomic state object with the old crtc state
1823 * This function commits the new plane state using the plane and atomic helper
1824 * functions for planes on the specific crtc. It assumes that the atomic state
1825 * has already been pushed into the relevant object state pointers, since this
1826 * step can no longer fail.
1828 * This function is useful when plane updates should be done crtc-by-crtc
1829 * instead of one global step like drm_atomic_helper_commit_planes() does.
1831 * This function can only be savely used when planes are not allowed to move
1832 * between different CRTCs because this function doesn't handle inter-CRTC
1833 * depencies. Callers need to ensure that either no such depencies exist,
1834 * resolve them through ordering of commit calls or through some other means.
1837 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1839 const struct drm_crtc_helper_funcs *crtc_funcs;
1840 struct drm_crtc *crtc = old_crtc_state->crtc;
1841 struct drm_atomic_state *old_state = old_crtc_state->state;
1842 struct drm_plane *plane;
1843 unsigned plane_mask;
1845 plane_mask = old_crtc_state->plane_mask;
1846 plane_mask |= crtc->state->plane_mask;
1848 crtc_funcs = crtc->helper_private;
1849 if (crtc_funcs && crtc_funcs->atomic_begin)
1850 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1852 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1853 struct drm_plane_state *old_plane_state =
1854 drm_atomic_get_old_plane_state(old_state, plane);
1855 const struct drm_plane_helper_funcs *plane_funcs;
1857 plane_funcs = plane->helper_private;
1859 if (!old_plane_state || !plane_funcs)
1862 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1864 if (drm_atomic_plane_disabling(old_plane_state, plane->state) &&
1865 plane_funcs->atomic_disable)
1866 plane_funcs->atomic_disable(plane, old_plane_state);
1867 else if (plane->state->crtc ||
1868 drm_atomic_plane_disabling(old_plane_state, plane->state))
1869 plane_funcs->atomic_update(plane, old_plane_state);
1872 if (crtc_funcs && crtc_funcs->atomic_flush)
1873 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1875 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1878 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1879 * @old_crtc_state: atomic state object with the old CRTC state
1880 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1882 * Disables all planes associated with the given CRTC. This can be
1883 * used for instance in the CRTC helper atomic_disable callback to disable
1886 * If the atomic-parameter is set the function calls the CRTC's
1887 * atomic_begin hook before and atomic_flush hook after disabling the
1890 * It is a bug to call this function without having implemented the
1891 * &drm_plane_helper_funcs.atomic_disable plane hook.
1894 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
1897 struct drm_crtc *crtc = old_crtc_state->crtc;
1898 const struct drm_crtc_helper_funcs *crtc_funcs =
1899 crtc->helper_private;
1900 struct drm_plane *plane;
1902 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1903 crtc_funcs->atomic_begin(crtc, NULL);
1905 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
1906 const struct drm_plane_helper_funcs *plane_funcs =
1907 plane->helper_private;
1912 WARN_ON(!plane_funcs->atomic_disable);
1913 if (plane_funcs->atomic_disable)
1914 plane_funcs->atomic_disable(plane, NULL);
1917 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1918 crtc_funcs->atomic_flush(crtc, NULL);
1920 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1923 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1925 * @old_state: atomic state object with old state structures
1927 * This function cleans up plane state, specifically framebuffers, from the old
1928 * configuration. Hence the old configuration must be perserved in @old_state to
1929 * be able to call this function.
1931 * This function must also be called on the new state when the atomic update
1932 * fails at any point after calling drm_atomic_helper_prepare_planes().
1934 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1935 struct drm_atomic_state *old_state)
1937 struct drm_plane *plane;
1938 struct drm_plane_state *old_plane_state, *new_plane_state;
1941 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
1942 const struct drm_plane_helper_funcs *funcs;
1943 struct drm_plane_state *plane_state;
1946 * This might be called before swapping when commit is aborted,
1947 * in which case we have to cleanup the new state.
1949 if (old_plane_state == plane->state)
1950 plane_state = new_plane_state;
1952 plane_state = old_plane_state;
1954 funcs = plane->helper_private;
1956 if (funcs->cleanup_fb)
1957 funcs->cleanup_fb(plane, plane_state);
1960 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1963 * drm_atomic_helper_swap_state - store atomic state into current sw state
1964 * @state: atomic state
1965 * @stall: stall for proceeding commits
1967 * This function stores the atomic state into the current state pointers in all
1968 * driver objects. It should be called after all failing steps have been done
1969 * and succeeded, but before the actual hardware state is committed.
1971 * For cleanup and error recovery the current state for all changed objects will
1972 * be swaped into @state.
1974 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1976 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1978 * 2. Do any other steps that might fail.
1980 * 3. Put the staged state into the current state pointers with this function.
1982 * 4. Actually commit the hardware state.
1984 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1985 * contains the old state. Also do any other cleanup required with that state.
1987 * @stall must be set when nonblocking commits for this driver directly access
1988 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
1989 * the current atomic helpers this is almost always the case, since the helpers
1990 * don't pass the right state structures to the callbacks.
1992 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
1997 struct drm_connector *connector;
1998 struct drm_connector_state *old_conn_state, *new_conn_state;
1999 struct drm_crtc *crtc;
2000 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2001 struct drm_plane *plane;
2002 struct drm_plane_state *old_plane_state, *new_plane_state;
2003 struct drm_crtc_commit *commit;
2006 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2007 spin_lock(&crtc->commit_lock);
2008 commit = list_first_entry_or_null(&crtc->commit_list,
2009 struct drm_crtc_commit, commit_entry);
2011 drm_crtc_commit_get(commit);
2012 spin_unlock(&crtc->commit_lock);
2017 ret = wait_for_completion_timeout(&commit->hw_done,
2020 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2021 crtc->base.id, crtc->name);
2022 drm_crtc_commit_put(commit);
2026 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2027 WARN_ON(connector->state != old_conn_state);
2029 old_conn_state->state = state;
2030 new_conn_state->state = NULL;
2032 state->connectors[i].state = old_conn_state;
2033 connector->state = new_conn_state;
2036 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2037 WARN_ON(crtc->state != old_crtc_state);
2039 old_crtc_state->state = state;
2040 new_crtc_state->state = NULL;
2042 state->crtcs[i].state = old_crtc_state;
2043 crtc->state = new_crtc_state;
2045 if (state->crtcs[i].commit) {
2046 spin_lock(&crtc->commit_lock);
2047 list_add(&state->crtcs[i].commit->commit_entry,
2048 &crtc->commit_list);
2049 spin_unlock(&crtc->commit_lock);
2051 state->crtcs[i].commit->event = NULL;
2055 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2056 WARN_ON(plane->state != old_plane_state);
2058 old_plane_state->state = state;
2059 new_plane_state->state = NULL;
2061 state->planes[i].state = old_plane_state;
2062 plane->state = new_plane_state;
2065 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2068 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2069 * @plane: plane object to update
2070 * @crtc: owning CRTC of owning plane
2071 * @fb: framebuffer to flip onto plane
2072 * @crtc_x: x offset of primary plane on crtc
2073 * @crtc_y: y offset of primary plane on crtc
2074 * @crtc_w: width of primary plane rectangle on crtc
2075 * @crtc_h: height of primary plane rectangle on crtc
2076 * @src_x: x offset of @fb for panning
2077 * @src_y: y offset of @fb for panning
2078 * @src_w: width of source rectangle in @fb
2079 * @src_h: height of source rectangle in @fb
2080 * @ctx: lock acquire context
2082 * Provides a default plane update handler using the atomic driver interface.
2085 * Zero on success, error code on failure
2087 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2088 struct drm_crtc *crtc,
2089 struct drm_framebuffer *fb,
2090 int crtc_x, int crtc_y,
2091 unsigned int crtc_w, unsigned int crtc_h,
2092 uint32_t src_x, uint32_t src_y,
2093 uint32_t src_w, uint32_t src_h,
2094 struct drm_modeset_acquire_ctx *ctx)
2096 struct drm_atomic_state *state;
2097 struct drm_plane_state *plane_state;
2100 state = drm_atomic_state_alloc(plane->dev);
2104 state->acquire_ctx = ctx;
2105 plane_state = drm_atomic_get_plane_state(state, plane);
2106 if (IS_ERR(plane_state)) {
2107 ret = PTR_ERR(plane_state);
2111 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2114 drm_atomic_set_fb_for_plane(plane_state, fb);
2115 plane_state->crtc_x = crtc_x;
2116 plane_state->crtc_y = crtc_y;
2117 plane_state->crtc_w = crtc_w;
2118 plane_state->crtc_h = crtc_h;
2119 plane_state->src_x = src_x;
2120 plane_state->src_y = src_y;
2121 plane_state->src_w = src_w;
2122 plane_state->src_h = src_h;
2124 if (plane == crtc->cursor)
2125 state->legacy_cursor_update = true;
2127 ret = drm_atomic_commit(state);
2129 drm_atomic_state_put(state);
2132 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2135 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2136 * @plane: plane to disable
2137 * @ctx: lock acquire context
2139 * Provides a default plane disable handler using the atomic driver interface.
2142 * Zero on success, error code on failure
2144 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2145 struct drm_modeset_acquire_ctx *ctx)
2147 struct drm_atomic_state *state;
2148 struct drm_plane_state *plane_state;
2151 state = drm_atomic_state_alloc(plane->dev);
2155 state->acquire_ctx = ctx;
2156 plane_state = drm_atomic_get_plane_state(state, plane);
2157 if (IS_ERR(plane_state)) {
2158 ret = PTR_ERR(plane_state);
2162 if (plane_state->crtc && (plane == plane->crtc->cursor))
2163 plane_state->state->legacy_cursor_update = true;
2165 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2169 ret = drm_atomic_commit(state);
2171 drm_atomic_state_put(state);
2174 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2176 /* just used from fb-helper and atomic-helper: */
2177 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2178 struct drm_plane_state *plane_state)
2182 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2186 drm_atomic_set_fb_for_plane(plane_state, NULL);
2187 plane_state->crtc_x = 0;
2188 plane_state->crtc_y = 0;
2189 plane_state->crtc_w = 0;
2190 plane_state->crtc_h = 0;
2191 plane_state->src_x = 0;
2192 plane_state->src_y = 0;
2193 plane_state->src_w = 0;
2194 plane_state->src_h = 0;
2199 static int update_output_state(struct drm_atomic_state *state,
2200 struct drm_mode_set *set)
2202 struct drm_device *dev = set->crtc->dev;
2203 struct drm_crtc *crtc;
2204 struct drm_crtc_state *new_crtc_state;
2205 struct drm_connector *connector;
2206 struct drm_connector_state *new_conn_state;
2209 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2210 state->acquire_ctx);
2214 /* First disable all connectors on the target crtc. */
2215 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2219 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2220 if (new_conn_state->crtc == set->crtc) {
2221 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2226 /* Make sure legacy setCrtc always re-trains */
2227 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2231 /* Then set all connectors from set->connectors on the target crtc */
2232 for (i = 0; i < set->num_connectors; i++) {
2233 new_conn_state = drm_atomic_get_connector_state(state,
2234 set->connectors[i]);
2235 if (IS_ERR(new_conn_state))
2236 return PTR_ERR(new_conn_state);
2238 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2244 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2245 /* Don't update ->enable for the CRTC in the set_config request,
2246 * since a mismatch would indicate a bug in the upper layers.
2247 * The actual modeset code later on will catch any
2248 * inconsistencies here. */
2249 if (crtc == set->crtc)
2252 if (!new_crtc_state->connector_mask) {
2253 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2258 new_crtc_state->active = false;
2266 * drm_atomic_helper_set_config - set a new config from userspace
2267 * @set: mode set configuration
2268 * @ctx: lock acquisition context
2270 * Provides a default crtc set_config handler using the atomic driver interface.
2272 * NOTE: For backwards compatibility with old userspace this automatically
2273 * resets the "link-status" property to GOOD, to force any link
2274 * re-training. The SETCRTC ioctl does not define whether an update does
2275 * need a full modeset or just a plane update, hence we're allowed to do
2276 * that. See also drm_mode_connector_set_link_status_property().
2279 * Returns 0 on success, negative errno numbers on failure.
2281 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2282 struct drm_modeset_acquire_ctx *ctx)
2284 struct drm_atomic_state *state;
2285 struct drm_crtc *crtc = set->crtc;
2288 state = drm_atomic_state_alloc(crtc->dev);
2292 state->legacy_set_config = true;
2293 state->acquire_ctx = ctx;
2294 ret = __drm_atomic_helper_set_config(set, state);
2298 ret = drm_atomic_commit(state);
2301 drm_atomic_state_put(state);
2304 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2306 /* just used from fb-helper and atomic-helper: */
2307 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2308 struct drm_atomic_state *state)
2310 struct drm_crtc_state *crtc_state;
2311 struct drm_plane_state *primary_state;
2312 struct drm_crtc *crtc = set->crtc;
2313 int hdisplay, vdisplay;
2316 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2317 if (IS_ERR(crtc_state))
2318 return PTR_ERR(crtc_state);
2320 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2321 if (IS_ERR(primary_state))
2322 return PTR_ERR(primary_state);
2326 WARN_ON(set->num_connectors);
2328 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2332 crtc_state->active = false;
2334 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2338 drm_atomic_set_fb_for_plane(primary_state, NULL);
2344 WARN_ON(!set->num_connectors);
2346 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2350 crtc_state->active = true;
2352 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2356 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2358 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2359 primary_state->crtc_x = 0;
2360 primary_state->crtc_y = 0;
2361 primary_state->crtc_w = hdisplay;
2362 primary_state->crtc_h = vdisplay;
2363 primary_state->src_x = set->x << 16;
2364 primary_state->src_y = set->y << 16;
2365 if (drm_rotation_90_or_270(primary_state->rotation)) {
2366 primary_state->src_w = vdisplay << 16;
2367 primary_state->src_h = hdisplay << 16;
2369 primary_state->src_w = hdisplay << 16;
2370 primary_state->src_h = vdisplay << 16;
2374 ret = update_output_state(state, set);
2382 * drm_atomic_helper_disable_all - disable all currently active outputs
2384 * @ctx: lock acquisition context
2386 * Loops through all connectors, finding those that aren't turned off and then
2387 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2388 * that they are connected to.
2390 * This is used for example in suspend/resume to disable all currently active
2391 * functions when suspending. If you just want to shut down everything at e.g.
2392 * driver unload, look at drm_atomic_helper_shutdown().
2394 * Note that if callers haven't already acquired all modeset locks this might
2395 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2398 * 0 on success or a negative error code on failure.
2401 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
2402 * drm_atomic_helper_shutdown().
2404 int drm_atomic_helper_disable_all(struct drm_device *dev,
2405 struct drm_modeset_acquire_ctx *ctx)
2407 struct drm_atomic_state *state;
2408 struct drm_connector_state *conn_state;
2409 struct drm_connector *conn;
2410 struct drm_plane_state *plane_state;
2411 struct drm_plane *plane;
2412 struct drm_crtc_state *crtc_state;
2413 struct drm_crtc *crtc;
2416 state = drm_atomic_state_alloc(dev);
2420 state->acquire_ctx = ctx;
2422 drm_for_each_crtc(crtc, dev) {
2423 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2424 if (IS_ERR(crtc_state)) {
2425 ret = PTR_ERR(crtc_state);
2429 crtc_state->active = false;
2431 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
2435 ret = drm_atomic_add_affected_planes(state, crtc);
2439 ret = drm_atomic_add_affected_connectors(state, crtc);
2444 for_each_connector_in_state(state, conn, conn_state, i) {
2445 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
2450 for_each_plane_in_state(state, plane, plane_state, i) {
2451 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2455 drm_atomic_set_fb_for_plane(plane_state, NULL);
2458 ret = drm_atomic_commit(state);
2460 drm_atomic_state_put(state);
2464 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2467 * drm_atomic_helper_shutdown - shutdown all CRTC
2470 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
2471 * suspend should instead be handled with drm_atomic_helper_suspend(), since
2472 * that also takes a snapshot of the modeset state to be restored on resume.
2474 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
2475 * and it is the atomic version of drm_crtc_force_disable_all().
2477 void drm_atomic_helper_shutdown(struct drm_device *dev)
2479 struct drm_modeset_acquire_ctx ctx;
2482 drm_modeset_acquire_init(&ctx, 0);
2484 ret = drm_modeset_lock_all_ctx(dev, &ctx);
2486 ret = drm_atomic_helper_disable_all(dev, &ctx);
2488 if (ret != -EDEADLK)
2491 drm_modeset_backoff(&ctx);
2495 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
2497 drm_modeset_drop_locks(&ctx);
2498 drm_modeset_acquire_fini(&ctx);
2500 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
2503 * drm_atomic_helper_suspend - subsystem-level suspend helper
2506 * Duplicates the current atomic state, disables all active outputs and then
2507 * returns a pointer to the original atomic state to the caller. Drivers can
2508 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2509 * restore the output configuration that was active at the time the system
2512 * Note that it is potentially unsafe to use this. The atomic state object
2513 * returned by this function is assumed to be persistent. Drivers must ensure
2514 * that this holds true. Before calling this function, drivers must make sure
2515 * to suspend fbdev emulation so that nothing can be using the device.
2518 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2519 * encoded error code on failure. Drivers should store the returned atomic
2520 * state object and pass it to the drm_atomic_helper_resume() helper upon
2524 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2525 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
2527 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2529 struct drm_modeset_acquire_ctx ctx;
2530 struct drm_atomic_state *state;
2533 drm_modeset_acquire_init(&ctx, 0);
2536 err = drm_modeset_lock_all_ctx(dev, &ctx);
2538 state = ERR_PTR(err);
2542 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2546 err = drm_atomic_helper_disable_all(dev, &ctx);
2548 drm_atomic_state_put(state);
2549 state = ERR_PTR(err);
2554 if (PTR_ERR(state) == -EDEADLK) {
2555 drm_modeset_backoff(&ctx);
2559 drm_modeset_drop_locks(&ctx);
2560 drm_modeset_acquire_fini(&ctx);
2563 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2566 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
2567 * @state: duplicated atomic state to commit
2568 * @ctx: pointer to acquire_ctx to use for commit.
2570 * The state returned by drm_atomic_helper_duplicate_state() and
2571 * drm_atomic_helper_suspend() is partially invalid, and needs to
2572 * be fixed up before commit.
2575 * 0 on success or a negative error code on failure.
2578 * drm_atomic_helper_suspend()
2580 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
2581 struct drm_modeset_acquire_ctx *ctx)
2584 struct drm_plane *plane;
2585 struct drm_plane_state *new_plane_state;
2586 struct drm_connector *connector;
2587 struct drm_connector_state *new_conn_state;
2588 struct drm_crtc *crtc;
2589 struct drm_crtc_state *new_crtc_state;
2591 state->acquire_ctx = ctx;
2593 for_each_new_plane_in_state(state, plane, new_plane_state, i)
2594 state->planes[i].old_state = plane->state;
2596 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
2597 state->crtcs[i].old_state = crtc->state;
2599 for_each_new_connector_in_state(state, connector, new_conn_state, i)
2600 state->connectors[i].old_state = connector->state;
2602 return drm_atomic_commit(state);
2604 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
2607 * drm_atomic_helper_resume - subsystem-level resume helper
2609 * @state: atomic state to resume to
2611 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2612 * grabs all modeset locks and commits the atomic state object. This can be
2613 * used in conjunction with the drm_atomic_helper_suspend() helper to
2614 * implement suspend/resume for drivers that support atomic mode-setting.
2617 * 0 on success or a negative error code on failure.
2620 * drm_atomic_helper_suspend()
2622 int drm_atomic_helper_resume(struct drm_device *dev,
2623 struct drm_atomic_state *state)
2625 struct drm_mode_config *config = &dev->mode_config;
2628 drm_mode_config_reset(dev);
2630 drm_modeset_lock_all(dev);
2631 err = drm_atomic_helper_commit_duplicated_state(state, config->acquire_ctx);
2632 drm_modeset_unlock_all(dev);
2636 EXPORT_SYMBOL(drm_atomic_helper_resume);
2639 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2641 * @property: DRM property
2642 * @val: value of property
2644 * Provides a default crtc set_property handler using the atomic driver
2648 * Zero on success, error code on failure
2651 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2652 struct drm_property *property,
2655 struct drm_atomic_state *state;
2656 struct drm_crtc_state *crtc_state;
2659 state = drm_atomic_state_alloc(crtc->dev);
2663 /* ->set_property is always called with all locks held. */
2664 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2666 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2667 if (IS_ERR(crtc_state)) {
2668 ret = PTR_ERR(crtc_state);
2672 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2677 ret = drm_atomic_commit(state);
2679 if (ret == -EDEADLK)
2682 drm_atomic_state_put(state);
2686 drm_atomic_state_clear(state);
2687 drm_atomic_legacy_backoff(state);
2691 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2694 * drm_atomic_helper_plane_set_property - helper for plane properties
2696 * @property: DRM property
2697 * @val: value of property
2699 * Provides a default plane set_property handler using the atomic driver
2703 * Zero on success, error code on failure
2706 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2707 struct drm_property *property,
2710 struct drm_atomic_state *state;
2711 struct drm_plane_state *plane_state;
2714 state = drm_atomic_state_alloc(plane->dev);
2718 /* ->set_property is always called with all locks held. */
2719 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2721 plane_state = drm_atomic_get_plane_state(state, plane);
2722 if (IS_ERR(plane_state)) {
2723 ret = PTR_ERR(plane_state);
2727 ret = drm_atomic_plane_set_property(plane, plane_state,
2732 ret = drm_atomic_commit(state);
2734 if (ret == -EDEADLK)
2737 drm_atomic_state_put(state);
2741 drm_atomic_state_clear(state);
2742 drm_atomic_legacy_backoff(state);
2746 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2749 * drm_atomic_helper_connector_set_property - helper for connector properties
2750 * @connector: DRM connector
2751 * @property: DRM property
2752 * @val: value of property
2754 * Provides a default connector set_property handler using the atomic driver
2758 * Zero on success, error code on failure
2761 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2762 struct drm_property *property,
2765 struct drm_atomic_state *state;
2766 struct drm_connector_state *connector_state;
2769 state = drm_atomic_state_alloc(connector->dev);
2773 /* ->set_property is always called with all locks held. */
2774 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2776 connector_state = drm_atomic_get_connector_state(state, connector);
2777 if (IS_ERR(connector_state)) {
2778 ret = PTR_ERR(connector_state);
2782 ret = drm_atomic_connector_set_property(connector, connector_state,
2787 ret = drm_atomic_commit(state);
2789 if (ret == -EDEADLK)
2792 drm_atomic_state_put(state);
2796 drm_atomic_state_clear(state);
2797 drm_atomic_legacy_backoff(state);
2801 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2803 static int page_flip_common(
2804 struct drm_atomic_state *state,
2805 struct drm_crtc *crtc,
2806 struct drm_framebuffer *fb,
2807 struct drm_pending_vblank_event *event,
2810 struct drm_plane *plane = crtc->primary;
2811 struct drm_plane_state *plane_state;
2812 struct drm_crtc_state *crtc_state;
2815 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2816 if (IS_ERR(crtc_state))
2817 return PTR_ERR(crtc_state);
2819 crtc_state->event = event;
2820 crtc_state->pageflip_flags = flags;
2822 plane_state = drm_atomic_get_plane_state(state, plane);
2823 if (IS_ERR(plane_state))
2824 return PTR_ERR(plane_state);
2826 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2829 drm_atomic_set_fb_for_plane(plane_state, fb);
2831 /* Make sure we don't accidentally do a full modeset. */
2832 state->allow_modeset = false;
2833 if (!crtc_state->active) {
2834 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
2835 crtc->base.id, crtc->name);
2843 * drm_atomic_helper_page_flip - execute a legacy page flip
2845 * @fb: DRM framebuffer
2846 * @event: optional DRM event to signal upon completion
2847 * @flags: flip flags for non-vblank sync'ed updates
2848 * @ctx: lock acquisition context
2850 * Provides a default &drm_crtc_funcs.page_flip implementation
2851 * using the atomic driver interface.
2854 * Returns 0 on success, negative errno numbers on failure.
2857 * drm_atomic_helper_page_flip_target()
2859 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2860 struct drm_framebuffer *fb,
2861 struct drm_pending_vblank_event *event,
2863 struct drm_modeset_acquire_ctx *ctx)
2865 struct drm_plane *plane = crtc->primary;
2866 struct drm_atomic_state *state;
2869 state = drm_atomic_state_alloc(plane->dev);
2873 state->acquire_ctx = ctx;
2875 ret = page_flip_common(state, crtc, fb, event, flags);
2879 ret = drm_atomic_nonblocking_commit(state);
2881 drm_atomic_state_put(state);
2884 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2887 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
2889 * @fb: DRM framebuffer
2890 * @event: optional DRM event to signal upon completion
2891 * @flags: flip flags for non-vblank sync'ed updates
2892 * @target: specifying the target vblank period when the flip to take effect
2893 * @ctx: lock acquisition context
2895 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
2896 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
2897 * target vblank period to flip.
2900 * Returns 0 on success, negative errno numbers on failure.
2902 int drm_atomic_helper_page_flip_target(
2903 struct drm_crtc *crtc,
2904 struct drm_framebuffer *fb,
2905 struct drm_pending_vblank_event *event,
2908 struct drm_modeset_acquire_ctx *ctx)
2910 struct drm_plane *plane = crtc->primary;
2911 struct drm_atomic_state *state;
2912 struct drm_crtc_state *crtc_state;
2915 state = drm_atomic_state_alloc(plane->dev);
2919 state->acquire_ctx = ctx;
2921 ret = page_flip_common(state, crtc, fb, event, flags);
2925 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2926 if (WARN_ON(!crtc_state)) {
2930 crtc_state->target_vblank = target;
2932 ret = drm_atomic_nonblocking_commit(state);
2934 drm_atomic_state_put(state);
2937 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
2940 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2941 * @connector: affected connector
2944 * This is the main helper function provided by the atomic helper framework for
2945 * implementing the legacy DPMS connector interface. It computes the new desired
2946 * &drm_crtc_state.active state for the corresponding CRTC (if the connector is
2947 * enabled) and updates it.
2950 * Returns 0 on success, negative errno numbers on failure.
2952 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2955 struct drm_mode_config *config = &connector->dev->mode_config;
2956 struct drm_atomic_state *state;
2957 struct drm_crtc_state *crtc_state;
2958 struct drm_crtc *crtc;
2959 struct drm_connector *tmp_connector;
2960 struct drm_connector_list_iter conn_iter;
2962 bool active = false;
2963 int old_mode = connector->dpms;
2965 if (mode != DRM_MODE_DPMS_ON)
2966 mode = DRM_MODE_DPMS_OFF;
2968 connector->dpms = mode;
2969 crtc = connector->state->crtc;
2974 state = drm_atomic_state_alloc(connector->dev);
2978 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2980 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2981 if (IS_ERR(crtc_state)) {
2982 ret = PTR_ERR(crtc_state);
2986 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2988 drm_connector_list_iter_begin(connector->dev, &conn_iter);
2989 drm_for_each_connector_iter(tmp_connector, &conn_iter) {
2990 if (tmp_connector->state->crtc != crtc)
2993 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2998 drm_connector_list_iter_end(&conn_iter);
2999 crtc_state->active = active;
3001 ret = drm_atomic_commit(state);
3003 if (ret == -EDEADLK)
3006 connector->dpms = old_mode;
3007 drm_atomic_state_put(state);
3011 drm_atomic_state_clear(state);
3012 drm_atomic_legacy_backoff(state);
3016 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
3019 * drm_atomic_helper_best_encoder - Helper for
3020 * &drm_connector_helper_funcs.best_encoder callback
3021 * @connector: Connector control structure
3023 * This is a &drm_connector_helper_funcs.best_encoder callback helper for
3024 * connectors that support exactly 1 encoder, statically determined at driver
3027 struct drm_encoder *
3028 drm_atomic_helper_best_encoder(struct drm_connector *connector)
3030 WARN_ON(connector->encoder_ids[1]);
3031 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
3033 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
3036 * DOC: atomic state reset and initialization
3038 * Both the drm core and the atomic helpers assume that there is always the full
3039 * and correct atomic software state for all connectors, CRTCs and planes
3040 * available. Which is a bit a problem on driver load and also after system
3041 * suspend. One way to solve this is to have a hardware state read-out
3042 * infrastructure which reconstructs the full software state (e.g. the i915
3045 * The simpler solution is to just reset the software state to everything off,
3046 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
3047 * the atomic helpers provide default reset implementations for all hooks.
3049 * On the upside the precise state tracking of atomic simplifies system suspend
3050 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
3051 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
3052 * For other drivers the building blocks are split out, see the documentation
3053 * for these functions.
3057 * drm_atomic_helper_crtc_reset - default &drm_crtc_funcs.reset hook for CRTCs
3060 * Resets the atomic state for @crtc by freeing the state pointer (which might
3061 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3063 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
3066 __drm_atomic_helper_crtc_destroy_state(crtc->state);
3069 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
3072 crtc->state->crtc = crtc;
3074 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
3077 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
3078 * @crtc: CRTC object
3079 * @state: atomic CRTC state
3081 * Copies atomic state from a CRTC's current state and resets inferred values.
3082 * This is useful for drivers that subclass the CRTC state.
3084 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
3085 struct drm_crtc_state *state)
3087 memcpy(state, crtc->state, sizeof(*state));
3089 if (state->mode_blob)
3090 drm_property_blob_get(state->mode_blob);
3091 if (state->degamma_lut)
3092 drm_property_blob_get(state->degamma_lut);
3094 drm_property_blob_get(state->ctm);
3095 if (state->gamma_lut)
3096 drm_property_blob_get(state->gamma_lut);
3097 state->mode_changed = false;
3098 state->active_changed = false;
3099 state->planes_changed = false;
3100 state->connectors_changed = false;
3101 state->color_mgmt_changed = false;
3102 state->zpos_changed = false;
3103 state->event = NULL;
3104 state->pageflip_flags = 0;
3106 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
3109 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3112 * Default CRTC state duplicate hook for drivers which don't have their own
3113 * subclassed CRTC state structure.
3115 struct drm_crtc_state *
3116 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
3118 struct drm_crtc_state *state;
3120 if (WARN_ON(!crtc->state))
3123 state = kmalloc(sizeof(*state), GFP_KERNEL);
3125 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
3129 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
3132 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3133 * @state: CRTC state object to release
3135 * Releases all resources stored in the CRTC state without actually freeing
3136 * the memory of the CRTC state. This is useful for drivers that subclass the
3139 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
3141 drm_property_blob_put(state->mode_blob);
3142 drm_property_blob_put(state->degamma_lut);
3143 drm_property_blob_put(state->ctm);
3144 drm_property_blob_put(state->gamma_lut);
3146 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3149 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3151 * @state: CRTC state object to release
3153 * Default CRTC state destroy hook for drivers which don't have their own
3154 * subclassed CRTC state structure.
3156 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3157 struct drm_crtc_state *state)
3159 __drm_atomic_helper_crtc_destroy_state(state);
3162 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3165 * drm_atomic_helper_plane_reset - default &drm_plane_funcs.reset hook for planes
3168 * Resets the atomic state for @plane by freeing the state pointer (which might
3169 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3171 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3174 __drm_atomic_helper_plane_destroy_state(plane->state);
3176 kfree(plane->state);
3177 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3180 plane->state->plane = plane;
3181 plane->state->rotation = DRM_ROTATE_0;
3184 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3187 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3188 * @plane: plane object
3189 * @state: atomic plane state
3191 * Copies atomic state from a plane's current state. This is useful for
3192 * drivers that subclass the plane state.
3194 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3195 struct drm_plane_state *state)
3197 memcpy(state, plane->state, sizeof(*state));
3200 drm_framebuffer_get(state->fb);
3202 state->fence = NULL;
3204 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3207 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3210 * Default plane state duplicate hook for drivers which don't have their own
3211 * subclassed plane state structure.
3213 struct drm_plane_state *
3214 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3216 struct drm_plane_state *state;
3218 if (WARN_ON(!plane->state))
3221 state = kmalloc(sizeof(*state), GFP_KERNEL);
3223 __drm_atomic_helper_plane_duplicate_state(plane, state);
3227 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3230 * __drm_atomic_helper_plane_destroy_state - release plane state
3231 * @state: plane state object to release
3233 * Releases all resources stored in the plane state without actually freeing
3234 * the memory of the plane state. This is useful for drivers that subclass the
3237 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3240 drm_framebuffer_put(state->fb);
3243 dma_fence_put(state->fence);
3245 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3248 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3250 * @state: plane state object to release
3252 * Default plane state destroy hook for drivers which don't have their own
3253 * subclassed plane state structure.
3255 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3256 struct drm_plane_state *state)
3258 __drm_atomic_helper_plane_destroy_state(state);
3261 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3264 * __drm_atomic_helper_connector_reset - reset state on connector
3265 * @connector: drm connector
3266 * @conn_state: connector state to assign
3268 * Initializes the newly allocated @conn_state and assigns it to
3269 * the &drm_conector->state pointer of @connector, usually required when
3270 * initializing the drivers or when called from the &drm_connector_funcs.reset
3273 * This is useful for drivers that subclass the connector state.
3276 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
3277 struct drm_connector_state *conn_state)
3280 conn_state->connector = connector;
3282 connector->state = conn_state;
3284 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3287 * drm_atomic_helper_connector_reset - default &drm_connector_funcs.reset hook for connectors
3288 * @connector: drm connector
3290 * Resets the atomic state for @connector by freeing the state pointer (which
3291 * might be NULL, e.g. at driver load time) and allocating a new empty state
3294 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3296 struct drm_connector_state *conn_state =
3297 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3299 if (connector->state)
3300 __drm_atomic_helper_connector_destroy_state(connector->state);
3302 kfree(connector->state);
3303 __drm_atomic_helper_connector_reset(connector, conn_state);
3305 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3308 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3309 * @connector: connector object
3310 * @state: atomic connector state
3312 * Copies atomic state from a connector's current state. This is useful for
3313 * drivers that subclass the connector state.
3316 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3317 struct drm_connector_state *state)
3319 memcpy(state, connector->state, sizeof(*state));
3321 drm_connector_get(connector);
3323 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3326 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3327 * @connector: drm connector
3329 * Default connector state duplicate hook for drivers which don't have their own
3330 * subclassed connector state structure.
3332 struct drm_connector_state *
3333 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3335 struct drm_connector_state *state;
3337 if (WARN_ON(!connector->state))
3340 state = kmalloc(sizeof(*state), GFP_KERNEL);
3342 __drm_atomic_helper_connector_duplicate_state(connector, state);
3346 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3349 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3351 * @ctx: lock acquisition context
3353 * Makes a copy of the current atomic state by looping over all objects and
3354 * duplicating their respective states. This is used for example by suspend/
3355 * resume support code to save the state prior to suspend such that it can
3356 * be restored upon resume.
3358 * Note that this treats atomic state as persistent between save and restore.
3359 * Drivers must make sure that this is possible and won't result in confusion
3360 * or erroneous behaviour.
3362 * Note that if callers haven't already acquired all modeset locks this might
3363 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3366 * A pointer to the copy of the atomic state object on success or an
3367 * ERR_PTR()-encoded error code on failure.
3370 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3372 struct drm_atomic_state *
3373 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3374 struct drm_modeset_acquire_ctx *ctx)
3376 struct drm_atomic_state *state;
3377 struct drm_connector *conn;
3378 struct drm_connector_list_iter conn_iter;
3379 struct drm_plane *plane;
3380 struct drm_crtc *crtc;
3383 state = drm_atomic_state_alloc(dev);
3385 return ERR_PTR(-ENOMEM);
3387 state->acquire_ctx = ctx;
3389 drm_for_each_crtc(crtc, dev) {
3390 struct drm_crtc_state *crtc_state;
3392 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3393 if (IS_ERR(crtc_state)) {
3394 err = PTR_ERR(crtc_state);
3399 drm_for_each_plane(plane, dev) {
3400 struct drm_plane_state *plane_state;
3402 plane_state = drm_atomic_get_plane_state(state, plane);
3403 if (IS_ERR(plane_state)) {
3404 err = PTR_ERR(plane_state);
3409 drm_connector_list_iter_begin(dev, &conn_iter);
3410 drm_for_each_connector_iter(conn, &conn_iter) {
3411 struct drm_connector_state *conn_state;
3413 conn_state = drm_atomic_get_connector_state(state, conn);
3414 if (IS_ERR(conn_state)) {
3415 err = PTR_ERR(conn_state);
3416 drm_connector_list_iter_end(&conn_iter);
3420 drm_connector_list_iter_end(&conn_iter);
3422 /* clear the acquire context so that it isn't accidentally reused */
3423 state->acquire_ctx = NULL;
3427 drm_atomic_state_put(state);
3428 state = ERR_PTR(err);
3433 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3436 * __drm_atomic_helper_connector_destroy_state - release connector state
3437 * @state: connector state object to release
3439 * Releases all resources stored in the connector state without actually
3440 * freeing the memory of the connector state. This is useful for drivers that
3441 * subclass the connector state.
3444 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3447 drm_connector_put(state->connector);
3449 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3452 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3453 * @connector: drm connector
3454 * @state: connector state object to release
3456 * Default connector state destroy hook for drivers which don't have their own
3457 * subclassed connector state structure.
3459 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3460 struct drm_connector_state *state)
3462 __drm_atomic_helper_connector_destroy_state(state);
3465 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3468 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3469 * @crtc: CRTC object
3470 * @red: red correction table
3471 * @green: green correction table
3472 * @blue: green correction table
3473 * @size: size of the tables
3475 * Implements support for legacy gamma correction table for drivers
3476 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3479 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3480 u16 *red, u16 *green, u16 *blue,
3483 struct drm_device *dev = crtc->dev;
3484 struct drm_mode_config *config = &dev->mode_config;
3485 struct drm_atomic_state *state;
3486 struct drm_crtc_state *crtc_state;
3487 struct drm_property_blob *blob = NULL;
3488 struct drm_color_lut *blob_data;
3491 state = drm_atomic_state_alloc(crtc->dev);
3495 blob = drm_property_create_blob(dev,
3496 sizeof(struct drm_color_lut) * size,
3499 ret = PTR_ERR(blob);
3504 /* Prepare GAMMA_LUT with the legacy values. */
3505 blob_data = (struct drm_color_lut *) blob->data;
3506 for (i = 0; i < size; i++) {
3507 blob_data[i].red = red[i];
3508 blob_data[i].green = green[i];
3509 blob_data[i].blue = blue[i];
3512 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
3514 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3515 if (IS_ERR(crtc_state)) {
3516 ret = PTR_ERR(crtc_state);
3520 /* Reset DEGAMMA_LUT and CTM properties. */
3521 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3522 config->degamma_lut_property, 0);
3526 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3527 config->ctm_property, 0);
3531 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3532 config->gamma_lut_property, blob->base.id);
3536 ret = drm_atomic_commit(state);
3538 if (ret == -EDEADLK)
3541 drm_atomic_state_put(state);
3542 drm_property_blob_put(blob);
3546 drm_atomic_state_clear(state);
3547 drm_atomic_legacy_backoff(state);
3551 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);