2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic.h>
30 #include <drm/drm_plane_helper.h>
31 #include <drm/drm_crtc_helper.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <linux/fence.h>
38 * This helper library provides implementations of check and commit functions on
39 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
40 * also provides convenience implementations for the atomic state handling
41 * callbacks for drivers which don't need to subclass the drm core structures to
42 * add their own additional internal state.
44 * This library also provides default implementations for the check callback in
45 * drm_atomic_helper_check() and for the commit callback with
46 * drm_atomic_helper_commit(). But the individual stages and callbacks are
47 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
48 * together with a driver private modeset implementation.
50 * This library also provides implementations for all the legacy driver
51 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
52 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
57 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
58 struct drm_plane_state *plane_state,
59 struct drm_plane *plane)
61 struct drm_crtc_state *crtc_state;
63 if (plane->state->crtc) {
64 crtc_state = state->crtc_states[drm_crtc_index(plane->state->crtc)];
66 if (WARN_ON(!crtc_state))
69 crtc_state->planes_changed = true;
72 if (plane_state->crtc) {
74 state->crtc_states[drm_crtc_index(plane_state->crtc)];
76 if (WARN_ON(!crtc_state))
79 crtc_state->planes_changed = true;
83 static struct drm_crtc *
84 get_current_crtc_for_encoder(struct drm_device *dev,
85 struct drm_encoder *encoder)
87 struct drm_mode_config *config = &dev->mode_config;
88 struct drm_connector *connector;
90 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
92 drm_for_each_connector(connector, dev) {
93 if (connector->state->best_encoder != encoder)
96 return connector->state->crtc;
103 steal_encoder(struct drm_atomic_state *state,
104 struct drm_encoder *encoder,
105 struct drm_crtc *encoder_crtc)
107 struct drm_mode_config *config = &state->dev->mode_config;
108 struct drm_crtc_state *crtc_state;
109 struct drm_connector *connector;
110 struct drm_connector_state *connector_state;
114 * We can only steal an encoder coming from a connector, which means we
115 * must already hold the connection_mutex.
117 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
119 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
120 encoder->base.id, encoder->name,
121 encoder_crtc->base.id);
123 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
124 if (IS_ERR(crtc_state))
125 return PTR_ERR(crtc_state);
127 crtc_state->connectors_changed = true;
129 list_for_each_entry(connector, &config->connector_list, head) {
130 if (connector->state->best_encoder != encoder)
133 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
137 connector_state = drm_atomic_get_connector_state(state,
139 if (IS_ERR(connector_state))
140 return PTR_ERR(connector_state);
142 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
145 connector_state->best_encoder = NULL;
152 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
154 const struct drm_connector_helper_funcs *funcs;
155 struct drm_encoder *new_encoder;
156 struct drm_crtc *encoder_crtc;
157 struct drm_connector *connector;
158 struct drm_connector_state *connector_state;
159 struct drm_crtc_state *crtc_state;
162 connector = state->connectors[conn_idx];
163 connector_state = state->connector_states[conn_idx];
168 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
172 if (connector->state->crtc != connector_state->crtc) {
173 if (connector->state->crtc) {
174 idx = drm_crtc_index(connector->state->crtc);
176 crtc_state = state->crtc_states[idx];
177 crtc_state->connectors_changed = true;
180 if (connector_state->crtc) {
181 idx = drm_crtc_index(connector_state->crtc);
183 crtc_state = state->crtc_states[idx];
184 crtc_state->connectors_changed = true;
188 if (!connector_state->crtc) {
189 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
193 connector_state->best_encoder = NULL;
198 funcs = connector->helper_private;
200 if (funcs->atomic_best_encoder)
201 new_encoder = funcs->atomic_best_encoder(connector,
204 new_encoder = funcs->best_encoder(connector);
207 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
213 if (new_encoder == connector_state->best_encoder) {
214 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
217 new_encoder->base.id,
219 connector_state->crtc->base.id);
224 encoder_crtc = get_current_crtc_for_encoder(state->dev,
228 ret = steal_encoder(state, new_encoder, encoder_crtc);
230 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
237 if (WARN_ON(!connector_state->crtc))
240 connector_state->best_encoder = new_encoder;
241 idx = drm_crtc_index(connector_state->crtc);
243 crtc_state = state->crtc_states[idx];
244 crtc_state->connectors_changed = true;
246 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
249 new_encoder->base.id,
251 connector_state->crtc->base.id);
257 mode_fixup(struct drm_atomic_state *state)
259 struct drm_crtc *crtc;
260 struct drm_crtc_state *crtc_state;
261 struct drm_connector *connector;
262 struct drm_connector_state *conn_state;
266 for_each_crtc_in_state(state, crtc, crtc_state, i) {
267 if (!crtc_state->mode_changed &&
268 !crtc_state->connectors_changed)
271 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
274 for_each_connector_in_state(state, connector, conn_state, i) {
275 const struct drm_encoder_helper_funcs *funcs;
276 struct drm_encoder *encoder;
278 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
280 if (!conn_state->crtc || !conn_state->best_encoder)
284 state->crtc_states[drm_crtc_index(conn_state->crtc)];
287 * Each encoder has at most one connector (since we always steal
288 * it away), so we won't call ->mode_fixup twice.
290 encoder = conn_state->best_encoder;
291 funcs = encoder->helper_private;
295 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
296 &crtc_state->adjusted_mode);
298 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
302 if (funcs->atomic_check) {
303 ret = funcs->atomic_check(encoder, crtc_state,
306 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
307 encoder->base.id, encoder->name);
310 } else if (funcs->mode_fixup) {
311 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
312 &crtc_state->adjusted_mode);
314 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
315 encoder->base.id, encoder->name);
321 for_each_crtc_in_state(state, crtc, crtc_state, i) {
322 const struct drm_crtc_helper_funcs *funcs;
324 if (!crtc_state->mode_changed &&
325 !crtc_state->connectors_changed)
328 funcs = crtc->helper_private;
329 if (!funcs->mode_fixup)
332 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
333 &crtc_state->adjusted_mode);
335 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
345 * drm_atomic_helper_check_modeset - validate state object for modeset changes
347 * @state: the driver state object
349 * Check the state object to see if the requested state is physically possible.
350 * This does all the crtc and connector related computations for an atomic
351 * update and adds any additional connectors needed for full modesets and calls
352 * down into ->mode_fixup functions of the driver backend.
354 * crtc_state->mode_changed is set when the input mode is changed.
355 * crtc_state->connectors_changed is set when a connector is added or
356 * removed from the crtc.
357 * crtc_state->active_changed is set when crtc_state->active changes,
358 * which is used for dpms.
362 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
363 * plane update can't be done without a full modeset) _must_ call this function
364 * afterwards after that change. It is permitted to call this function multiple
365 * times for the same update, e.g. when the ->atomic_check functions depend upon
366 * the adjusted dotclock for fifo space allocation and watermark computation.
369 * Zero for success or -errno
372 drm_atomic_helper_check_modeset(struct drm_device *dev,
373 struct drm_atomic_state *state)
375 struct drm_crtc *crtc;
376 struct drm_crtc_state *crtc_state;
377 struct drm_connector *connector;
378 struct drm_connector_state *connector_state;
381 for_each_crtc_in_state(state, crtc, crtc_state, i) {
382 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
383 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
385 crtc_state->mode_changed = true;
388 if (crtc->state->enable != crtc_state->enable) {
389 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
393 * For clarity this assignment is done here, but
394 * enable == 0 is only true when there are no
395 * connectors and a NULL mode.
397 * The other way around is true as well. enable != 0
398 * iff connectors are attached and a mode is set.
400 crtc_state->mode_changed = true;
401 crtc_state->connectors_changed = true;
405 for_each_connector_in_state(state, connector, connector_state, i) {
407 * This only sets crtc->mode_changed for routing changes,
408 * drivers must set crtc->mode_changed themselves when connector
409 * properties need to be updated.
411 ret = update_connector_routing(state, i);
417 * After all the routing has been prepared we need to add in any
418 * connector which is itself unchanged, but who's crtc changes it's
419 * configuration. This must be done before calling mode_fixup in case a
420 * crtc only changed its mode but has the same set of connectors.
422 for_each_crtc_in_state(state, crtc, crtc_state, i) {
426 * We must set ->active_changed after walking connectors for
427 * otherwise an update that only changes active would result in
428 * a full modeset because update_connector_routing force that.
430 if (crtc->state->active != crtc_state->active) {
431 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
433 crtc_state->active_changed = true;
436 if (!drm_atomic_crtc_needs_modeset(crtc_state))
439 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
441 crtc_state->enable ? 'y' : 'n',
442 crtc_state->active ? 'y' : 'n');
444 ret = drm_atomic_add_affected_connectors(state, crtc);
448 ret = drm_atomic_add_affected_planes(state, crtc);
452 num_connectors = drm_atomic_connectors_for_crtc(state,
455 if (crtc_state->enable != !!num_connectors) {
456 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
463 return mode_fixup(state);
465 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
468 * drm_atomic_helper_check_planes - validate state object for planes changes
470 * @state: the driver state object
472 * Check the state object to see if the requested state is physically possible.
473 * This does all the plane update related checks using by calling into the
474 * ->atomic_check hooks provided by the driver.
476 * It also sets crtc_state->planes_changed to indicate that a crtc has
480 * Zero for success or -errno
483 drm_atomic_helper_check_planes(struct drm_device *dev,
484 struct drm_atomic_state *state)
486 struct drm_crtc *crtc;
487 struct drm_crtc_state *crtc_state;
488 struct drm_plane *plane;
489 struct drm_plane_state *plane_state;
492 for_each_plane_in_state(state, plane, plane_state, i) {
493 const struct drm_plane_helper_funcs *funcs;
495 funcs = plane->helper_private;
497 drm_atomic_helper_plane_changed(state, plane_state, plane);
499 if (!funcs || !funcs->atomic_check)
502 ret = funcs->atomic_check(plane, plane_state);
504 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
510 for_each_crtc_in_state(state, crtc, crtc_state, i) {
511 const struct drm_crtc_helper_funcs *funcs;
513 funcs = crtc->helper_private;
515 if (!funcs || !funcs->atomic_check)
518 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
520 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
528 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
531 * drm_atomic_helper_check - validate state object
533 * @state: the driver state object
535 * Check the state object to see if the requested state is physically possible.
536 * Only crtcs and planes have check callbacks, so for any additional (global)
537 * checking that a driver needs it can simply wrap that around this function.
538 * Drivers without such needs can directly use this as their ->atomic_check()
541 * This just wraps the two parts of the state checking for planes and modeset
542 * state in the default order: First it calls drm_atomic_helper_check_modeset()
543 * and then drm_atomic_helper_check_planes(). The assumption is that the
544 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
545 * e.g. properly compute watermarks.
548 * Zero for success or -errno
550 int drm_atomic_helper_check(struct drm_device *dev,
551 struct drm_atomic_state *state)
555 ret = drm_atomic_helper_check_modeset(dev, state);
559 ret = drm_atomic_helper_check_planes(dev, state);
565 EXPORT_SYMBOL(drm_atomic_helper_check);
568 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
570 struct drm_connector *connector;
571 struct drm_connector_state *old_conn_state;
572 struct drm_crtc *crtc;
573 struct drm_crtc_state *old_crtc_state;
576 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
577 const struct drm_encoder_helper_funcs *funcs;
578 struct drm_encoder *encoder;
579 struct drm_crtc_state *old_crtc_state;
581 /* Shut down everything that's in the changeset and currently
582 * still on. So need to check the old, saved state. */
583 if (!old_conn_state->crtc)
586 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
588 if (!old_crtc_state->active ||
589 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
592 encoder = old_conn_state->best_encoder;
594 /* We shouldn't get this far if we didn't previously have
595 * an encoder.. but WARN_ON() rather than explode.
597 if (WARN_ON(!encoder))
600 funcs = encoder->helper_private;
602 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
603 encoder->base.id, encoder->name);
606 * Each encoder has at most one connector (since we always steal
607 * it away), so we won't call disable hooks twice.
609 drm_bridge_disable(encoder->bridge);
611 /* Right function depends upon target state. */
612 if (connector->state->crtc && funcs->prepare)
613 funcs->prepare(encoder);
614 else if (funcs->disable)
615 funcs->disable(encoder);
617 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
619 drm_bridge_post_disable(encoder->bridge);
622 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
623 const struct drm_crtc_helper_funcs *funcs;
625 /* Shut down everything that needs a full modeset. */
626 if (!drm_atomic_crtc_needs_modeset(crtc->state))
629 if (!old_crtc_state->active)
632 funcs = crtc->helper_private;
634 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
638 /* Right function depends upon target state. */
639 if (crtc->state->enable && funcs->prepare)
640 funcs->prepare(crtc);
641 else if (funcs->disable)
642 funcs->disable(crtc);
644 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
649 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
651 * @old_state: atomic state object with old state structures
653 * This function updates all the various legacy modeset state pointers in
654 * connectors, encoders and crtcs. It also updates the timestamping constants
655 * used for precise vblank timestamps by calling
656 * drm_calc_timestamping_constants().
658 * Drivers can use this for building their own atomic commit if they don't have
659 * a pure helper-based modeset implementation.
662 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
663 struct drm_atomic_state *old_state)
665 struct drm_connector *connector;
666 struct drm_connector_state *old_conn_state;
667 struct drm_crtc *crtc;
668 struct drm_crtc_state *old_crtc_state;
671 /* clear out existing links and update dpms */
672 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
673 if (connector->encoder) {
674 WARN_ON(!connector->encoder->crtc);
676 connector->encoder->crtc = NULL;
677 connector->encoder = NULL;
680 crtc = connector->state->crtc;
681 if ((!crtc && old_conn_state->crtc) ||
682 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
683 struct drm_property *dpms_prop =
684 dev->mode_config.dpms_property;
685 int mode = DRM_MODE_DPMS_OFF;
687 if (crtc && crtc->state->active)
688 mode = DRM_MODE_DPMS_ON;
690 connector->dpms = mode;
691 drm_object_property_set_value(&connector->base,
697 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
698 if (!connector->state->crtc)
701 if (WARN_ON(!connector->state->best_encoder))
704 connector->encoder = connector->state->best_encoder;
705 connector->encoder->crtc = connector->state->crtc;
708 /* set legacy state in the crtc structure */
709 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
710 struct drm_plane *primary = crtc->primary;
712 crtc->mode = crtc->state->mode;
713 crtc->enabled = crtc->state->enable;
715 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
716 primary->state->crtc == crtc) {
717 crtc->x = primary->state->src_x >> 16;
718 crtc->y = primary->state->src_y >> 16;
721 if (crtc->state->enable)
722 drm_calc_timestamping_constants(crtc,
723 &crtc->state->adjusted_mode);
726 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
729 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
731 struct drm_crtc *crtc;
732 struct drm_crtc_state *old_crtc_state;
733 struct drm_connector *connector;
734 struct drm_connector_state *old_conn_state;
737 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
738 const struct drm_crtc_helper_funcs *funcs;
740 if (!crtc->state->mode_changed)
743 funcs = crtc->helper_private;
745 if (crtc->state->enable && funcs->mode_set_nofb) {
746 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
749 funcs->mode_set_nofb(crtc);
753 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
754 const struct drm_encoder_helper_funcs *funcs;
755 struct drm_crtc_state *new_crtc_state;
756 struct drm_encoder *encoder;
757 struct drm_display_mode *mode, *adjusted_mode;
759 if (!connector->state->best_encoder)
762 encoder = connector->state->best_encoder;
763 funcs = encoder->helper_private;
764 new_crtc_state = connector->state->crtc->state;
765 mode = &new_crtc_state->mode;
766 adjusted_mode = &new_crtc_state->adjusted_mode;
768 if (!new_crtc_state->mode_changed)
771 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
772 encoder->base.id, encoder->name);
775 * Each encoder has at most one connector (since we always steal
776 * it away), so we won't call mode_set hooks twice.
779 funcs->mode_set(encoder, mode, adjusted_mode);
781 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
786 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
788 * @old_state: atomic state object with old state structures
790 * This function shuts down all the outputs that need to be shut down and
791 * prepares them (if required) with the new mode.
793 * For compatibility with legacy crtc helpers this should be called before
794 * drm_atomic_helper_commit_planes(), which is what the default commit function
795 * does. But drivers with different needs can group the modeset commits together
796 * and do the plane commits at the end. This is useful for drivers doing runtime
797 * PM since planes updates then only happen when the CRTC is actually enabled.
799 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
800 struct drm_atomic_state *old_state)
802 disable_outputs(dev, old_state);
804 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
806 crtc_set_mode(dev, old_state);
808 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
811 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
813 * @old_state: atomic state object with old state structures
815 * This function enables all the outputs with the new configuration which had to
816 * be turned off for the update.
818 * For compatibility with legacy crtc helpers this should be called after
819 * drm_atomic_helper_commit_planes(), which is what the default commit function
820 * does. But drivers with different needs can group the modeset commits together
821 * and do the plane commits at the end. This is useful for drivers doing runtime
822 * PM since planes updates then only happen when the CRTC is actually enabled.
824 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
825 struct drm_atomic_state *old_state)
827 struct drm_crtc *crtc;
828 struct drm_crtc_state *old_crtc_state;
829 struct drm_connector *connector;
830 struct drm_connector_state *old_conn_state;
833 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
834 const struct drm_crtc_helper_funcs *funcs;
836 /* Need to filter out CRTCs where only planes change. */
837 if (!drm_atomic_crtc_needs_modeset(crtc->state))
840 if (!crtc->state->active)
843 funcs = crtc->helper_private;
845 if (crtc->state->enable) {
846 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
856 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
857 const struct drm_encoder_helper_funcs *funcs;
858 struct drm_encoder *encoder;
860 if (!connector->state->best_encoder)
863 if (!connector->state->crtc->state->active ||
864 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
867 encoder = connector->state->best_encoder;
868 funcs = encoder->helper_private;
870 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
871 encoder->base.id, encoder->name);
874 * Each encoder has at most one connector (since we always steal
875 * it away), so we won't call enable hooks twice.
877 drm_bridge_pre_enable(encoder->bridge);
880 funcs->enable(encoder);
882 funcs->commit(encoder);
884 drm_bridge_enable(encoder->bridge);
887 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
889 static void wait_for_fences(struct drm_device *dev,
890 struct drm_atomic_state *state)
892 struct drm_plane *plane;
893 struct drm_plane_state *plane_state;
896 for_each_plane_in_state(state, plane, plane_state, i) {
897 if (!plane->state->fence)
900 WARN_ON(!plane->state->fb);
902 fence_wait(plane->state->fence, false);
903 fence_put(plane->state->fence);
904 plane->state->fence = NULL;
908 static bool framebuffer_changed(struct drm_device *dev,
909 struct drm_atomic_state *old_state,
910 struct drm_crtc *crtc)
912 struct drm_plane *plane;
913 struct drm_plane_state *old_plane_state;
916 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
917 if (plane->state->crtc != crtc &&
918 old_plane_state->crtc != crtc)
921 if (plane->state->fb != old_plane_state->fb)
929 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
931 * @old_state: atomic state object with old state structures
933 * Helper to, after atomic commit, wait for vblanks on all effected
934 * crtcs (ie. before cleaning up old framebuffers using
935 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
936 * framebuffers have actually changed to optimize for the legacy cursor and
937 * plane update use-case.
940 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
941 struct drm_atomic_state *old_state)
943 struct drm_crtc *crtc;
944 struct drm_crtc_state *old_crtc_state;
947 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
948 /* No one cares about the old state, so abuse it for tracking
949 * and store whether we hold a vblank reference (and should do a
950 * vblank wait) in the ->enable boolean. */
951 old_crtc_state->enable = false;
953 if (!crtc->state->enable)
956 /* Legacy cursor ioctls are completely unsynced, and userspace
957 * relies on that (by doing tons of cursor updates). */
958 if (old_state->legacy_cursor_update)
961 if (!framebuffer_changed(dev, old_state, crtc))
964 ret = drm_crtc_vblank_get(crtc);
968 old_crtc_state->enable = true;
969 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
972 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
973 if (!old_crtc_state->enable)
976 ret = wait_event_timeout(dev->vblank[i].queue,
977 old_crtc_state->last_vblank_count !=
978 drm_crtc_vblank_count(crtc),
979 msecs_to_jiffies(50));
981 drm_crtc_vblank_put(crtc);
984 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
987 * drm_atomic_helper_commit - commit validated state object
989 * @state: the driver state object
990 * @async: asynchronous commit
992 * This function commits a with drm_atomic_helper_check() pre-validated state
993 * object. This can still fail when e.g. the framebuffer reservation fails. For
994 * now this doesn't implement asynchronous commits.
996 * Note that right now this function does not support async commits, and hence
997 * driver writers must implement their own version for now. Also note that the
998 * default ordering of how the various stages are called is to match the legacy
999 * modeset helper library closest. One peculiarity of that is that it doesn't
1000 * mesh well with runtime PM at all.
1002 * For drivers supporting runtime PM the recommended sequence is
1004 * drm_atomic_helper_commit_modeset_disables(dev, state);
1006 * drm_atomic_helper_commit_modeset_enables(dev, state);
1008 * drm_atomic_helper_commit_planes(dev, state, true);
1010 * See the kerneldoc entries for these three functions for more details.
1013 * Zero for success or -errno.
1015 int drm_atomic_helper_commit(struct drm_device *dev,
1016 struct drm_atomic_state *state,
1024 ret = drm_atomic_helper_prepare_planes(dev, state);
1029 * This is the point of no return - everything below never fails except
1030 * when the hw goes bonghits. Which means we can commit the new state on
1031 * the software side now.
1034 drm_atomic_helper_swap_state(dev, state);
1037 * Everything below can be run asynchronously without the need to grab
1038 * any modeset locks at all under one condition: It must be guaranteed
1039 * that the asynchronous work has either been cancelled (if the driver
1040 * supports it, which at least requires that the framebuffers get
1041 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1042 * before the new state gets committed on the software side with
1043 * drm_atomic_helper_swap_state().
1045 * This scheme allows new atomic state updates to be prepared and
1046 * checked in parallel to the asynchronous completion of the previous
1047 * update. Which is important since compositors need to figure out the
1048 * composition of the next frame right after having submitted the
1052 wait_for_fences(dev, state);
1054 drm_atomic_helper_commit_modeset_disables(dev, state);
1056 drm_atomic_helper_commit_planes(dev, state, false);
1058 drm_atomic_helper_commit_modeset_enables(dev, state);
1060 drm_atomic_helper_wait_for_vblanks(dev, state);
1062 drm_atomic_helper_cleanup_planes(dev, state);
1064 drm_atomic_state_free(state);
1068 EXPORT_SYMBOL(drm_atomic_helper_commit);
1071 * DOC: implementing async commit
1073 * For now the atomic helpers don't support async commit directly. If there is
1074 * real need it could be added though, using the dma-buf fence infrastructure
1075 * for generic synchronization with outstanding rendering.
1077 * For now drivers have to implement async commit themselves, with the following
1078 * sequence being the recommended one:
1080 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1081 * which commit needs to call which can fail, so we want to run it first and
1084 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1085 * might be affected the new state update. This can be done by either cancelling
1086 * or flushing the work items, depending upon whether the driver can deal with
1087 * cancelled updates. Note that it is important to ensure that the framebuffer
1088 * cleanup is still done when cancelling.
1090 * For sufficient parallelism it is recommended to have a work item per crtc
1091 * (for updates which don't touch global state) and a global one. Then we only
1092 * need to synchronize with the crtc work items for changed crtcs and the global
1093 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1095 * 3. The software state is updated synchronously with
1096 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1097 * locks means concurrent callers never see inconsistent state. And doing this
1098 * while it's guaranteed that no relevant async worker runs means that async
1099 * workers do not need grab any locks. Actually they must not grab locks, for
1100 * otherwise the work flushing will deadlock.
1102 * 4. Schedule a work item to do all subsequent steps, using the split-out
1103 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1104 * then cleaning up the framebuffers after the old framebuffer is no longer
1109 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1111 * @state: atomic state object with new state structures
1113 * This function prepares plane state, specifically framebuffers, for the new
1114 * configuration. If any failure is encountered this function will call
1115 * ->cleanup_fb on any already successfully prepared framebuffer.
1118 * 0 on success, negative error code on failure.
1120 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1121 struct drm_atomic_state *state)
1123 int nplanes = dev->mode_config.num_total_plane;
1126 for (i = 0; i < nplanes; i++) {
1127 const struct drm_plane_helper_funcs *funcs;
1128 struct drm_plane *plane = state->planes[i];
1129 struct drm_plane_state *plane_state = state->plane_states[i];
1134 funcs = plane->helper_private;
1136 if (funcs->prepare_fb) {
1137 ret = funcs->prepare_fb(plane, plane_state);
1146 for (i--; i >= 0; i--) {
1147 const struct drm_plane_helper_funcs *funcs;
1148 struct drm_plane *plane = state->planes[i];
1149 struct drm_plane_state *plane_state = state->plane_states[i];
1154 funcs = plane->helper_private;
1156 if (funcs->cleanup_fb)
1157 funcs->cleanup_fb(plane, plane_state);
1163 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1165 bool plane_crtc_active(struct drm_plane_state *state)
1167 return state->crtc && state->crtc->state->active;
1171 * drm_atomic_helper_commit_planes - commit plane state
1173 * @old_state: atomic state object with old state structures
1174 * @active_only: Only commit on active CRTC if set
1176 * This function commits the new plane state using the plane and atomic helper
1177 * functions for planes and crtcs. It assumes that the atomic state has already
1178 * been pushed into the relevant object state pointers, since this step can no
1181 * It still requires the global state object @old_state to know which planes and
1182 * crtcs need to be updated though.
1184 * Note that this function does all plane updates across all CRTCs in one step.
1185 * If the hardware can't support this approach look at
1186 * drm_atomic_helper_commit_planes_on_crtc() instead.
1188 * Plane parameters can be updated by applications while the associated CRTC is
1189 * disabled. The DRM/KMS core will store the parameters in the plane state,
1190 * which will be available to the driver when the CRTC is turned on. As a result
1191 * most drivers don't need to be immediately notified of plane updates for a
1194 * Unless otherwise needed, drivers are advised to set the @active_only
1195 * parameters to true in order not to receive plane update notifications related
1196 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1197 * driver code when the driver and/or hardware can't or just don't need to deal
1198 * with updates on disabled CRTCs, for example when supporting runtime PM.
1200 * The drm_atomic_helper_commit() default implementation only sets @active_only
1201 * to false to most closely match the behaviour of the legacy helpers. This should
1202 * not be copied blindly by drivers.
1204 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1205 struct drm_atomic_state *old_state,
1208 struct drm_crtc *crtc;
1209 struct drm_crtc_state *old_crtc_state;
1210 struct drm_plane *plane;
1211 struct drm_plane_state *old_plane_state;
1214 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1215 const struct drm_crtc_helper_funcs *funcs;
1217 funcs = crtc->helper_private;
1219 if (!funcs || !funcs->atomic_begin)
1222 if (active_only && !crtc->state->active)
1225 funcs->atomic_begin(crtc, old_crtc_state);
1228 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1229 const struct drm_plane_helper_funcs *funcs;
1232 funcs = plane->helper_private;
1237 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1241 * Skip planes related to inactive CRTCs. If the plane
1242 * is enabled use the state of the current CRTC. If the
1243 * plane is being disabled use the state of the old
1244 * CRTC to avoid skipping planes being disabled on an
1247 if (!disabling && !plane_crtc_active(plane->state))
1249 if (disabling && !plane_crtc_active(old_plane_state))
1254 * Special-case disabling the plane if drivers support it.
1256 if (disabling && funcs->atomic_disable)
1257 funcs->atomic_disable(plane, old_plane_state);
1258 else if (plane->state->crtc || disabling)
1259 funcs->atomic_update(plane, old_plane_state);
1262 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1263 const struct drm_crtc_helper_funcs *funcs;
1265 funcs = crtc->helper_private;
1267 if (!funcs || !funcs->atomic_flush)
1270 if (active_only && !crtc->state->active)
1273 funcs->atomic_flush(crtc, old_crtc_state);
1276 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1279 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1280 * @old_crtc_state: atomic state object with the old crtc state
1282 * This function commits the new plane state using the plane and atomic helper
1283 * functions for planes on the specific crtc. It assumes that the atomic state
1284 * has already been pushed into the relevant object state pointers, since this
1285 * step can no longer fail.
1287 * This function is useful when plane updates should be done crtc-by-crtc
1288 * instead of one global step like drm_atomic_helper_commit_planes() does.
1290 * This function can only be savely used when planes are not allowed to move
1291 * between different CRTCs because this function doesn't handle inter-CRTC
1292 * depencies. Callers need to ensure that either no such depencies exist,
1293 * resolve them through ordering of commit calls or through some other means.
1296 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1298 const struct drm_crtc_helper_funcs *crtc_funcs;
1299 struct drm_crtc *crtc = old_crtc_state->crtc;
1300 struct drm_atomic_state *old_state = old_crtc_state->state;
1301 struct drm_plane *plane;
1302 unsigned plane_mask;
1304 plane_mask = old_crtc_state->plane_mask;
1305 plane_mask |= crtc->state->plane_mask;
1307 crtc_funcs = crtc->helper_private;
1308 if (crtc_funcs && crtc_funcs->atomic_begin)
1309 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1311 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1312 struct drm_plane_state *old_plane_state =
1313 drm_atomic_get_existing_plane_state(old_state, plane);
1314 const struct drm_plane_helper_funcs *plane_funcs;
1316 plane_funcs = plane->helper_private;
1318 if (!old_plane_state || !plane_funcs)
1321 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1323 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1324 plane_funcs->atomic_disable)
1325 plane_funcs->atomic_disable(plane, old_plane_state);
1326 else if (plane->state->crtc ||
1327 drm_atomic_plane_disabling(plane, old_plane_state))
1328 plane_funcs->atomic_update(plane, old_plane_state);
1331 if (crtc_funcs && crtc_funcs->atomic_flush)
1332 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1334 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1337 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1339 * @old_state: atomic state object with old state structures
1341 * This function cleans up plane state, specifically framebuffers, from the old
1342 * configuration. Hence the old configuration must be perserved in @old_state to
1343 * be able to call this function.
1345 * This function must also be called on the new state when the atomic update
1346 * fails at any point after calling drm_atomic_helper_prepare_planes().
1348 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1349 struct drm_atomic_state *old_state)
1351 struct drm_plane *plane;
1352 struct drm_plane_state *plane_state;
1355 for_each_plane_in_state(old_state, plane, plane_state, i) {
1356 const struct drm_plane_helper_funcs *funcs;
1358 funcs = plane->helper_private;
1360 if (funcs->cleanup_fb)
1361 funcs->cleanup_fb(plane, plane_state);
1364 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1367 * drm_atomic_helper_swap_state - store atomic state into current sw state
1369 * @state: atomic state
1371 * This function stores the atomic state into the current state pointers in all
1372 * driver objects. It should be called after all failing steps have been done
1373 * and succeeded, but before the actual hardware state is committed.
1375 * For cleanup and error recovery the current state for all changed objects will
1376 * be swaped into @state.
1378 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1380 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1382 * 2. Do any other steps that might fail.
1384 * 3. Put the staged state into the current state pointers with this function.
1386 * 4. Actually commit the hardware state.
1388 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1389 * contains the old state. Also do any other cleanup required with that state.
1391 void drm_atomic_helper_swap_state(struct drm_device *dev,
1392 struct drm_atomic_state *state)
1396 for (i = 0; i < dev->mode_config.num_connector; i++) {
1397 struct drm_connector *connector = state->connectors[i];
1402 connector->state->state = state;
1403 swap(state->connector_states[i], connector->state);
1404 connector->state->state = NULL;
1407 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1408 struct drm_crtc *crtc = state->crtcs[i];
1413 crtc->state->state = state;
1414 swap(state->crtc_states[i], crtc->state);
1415 crtc->state->state = NULL;
1418 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1419 struct drm_plane *plane = state->planes[i];
1424 plane->state->state = state;
1425 swap(state->plane_states[i], plane->state);
1426 plane->state->state = NULL;
1429 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1432 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1433 * @plane: plane object to update
1434 * @crtc: owning CRTC of owning plane
1435 * @fb: framebuffer to flip onto plane
1436 * @crtc_x: x offset of primary plane on crtc
1437 * @crtc_y: y offset of primary plane on crtc
1438 * @crtc_w: width of primary plane rectangle on crtc
1439 * @crtc_h: height of primary plane rectangle on crtc
1440 * @src_x: x offset of @fb for panning
1441 * @src_y: y offset of @fb for panning
1442 * @src_w: width of source rectangle in @fb
1443 * @src_h: height of source rectangle in @fb
1445 * Provides a default plane update handler using the atomic driver interface.
1448 * Zero on success, error code on failure
1450 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1451 struct drm_crtc *crtc,
1452 struct drm_framebuffer *fb,
1453 int crtc_x, int crtc_y,
1454 unsigned int crtc_w, unsigned int crtc_h,
1455 uint32_t src_x, uint32_t src_y,
1456 uint32_t src_w, uint32_t src_h)
1458 struct drm_atomic_state *state;
1459 struct drm_plane_state *plane_state;
1462 state = drm_atomic_state_alloc(plane->dev);
1466 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1468 plane_state = drm_atomic_get_plane_state(state, plane);
1469 if (IS_ERR(plane_state)) {
1470 ret = PTR_ERR(plane_state);
1474 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1477 drm_atomic_set_fb_for_plane(plane_state, fb);
1478 plane_state->crtc_x = crtc_x;
1479 plane_state->crtc_y = crtc_y;
1480 plane_state->crtc_h = crtc_h;
1481 plane_state->crtc_w = crtc_w;
1482 plane_state->src_x = src_x;
1483 plane_state->src_y = src_y;
1484 plane_state->src_h = src_h;
1485 plane_state->src_w = src_w;
1487 if (plane == crtc->cursor)
1488 state->legacy_cursor_update = true;
1490 ret = drm_atomic_commit(state);
1494 /* Driver takes ownership of state on successful commit. */
1497 if (ret == -EDEADLK)
1500 drm_atomic_state_free(state);
1504 drm_atomic_state_clear(state);
1505 drm_atomic_legacy_backoff(state);
1508 * Someone might have exchanged the framebuffer while we dropped locks
1509 * in the backoff code. We need to fix up the fb refcount tracking the
1512 plane->old_fb = plane->fb;
1516 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1519 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1520 * @plane: plane to disable
1522 * Provides a default plane disable handler using the atomic driver interface.
1525 * Zero on success, error code on failure
1527 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1529 struct drm_atomic_state *state;
1530 struct drm_plane_state *plane_state;
1534 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1535 * acquire context. The real fix will be to wire the acquire ctx through
1536 * everywhere we need it, but meanwhile prevent chaos by just skipping
1537 * this noop. The critical case is the cursor ioctls which a) only grab
1538 * crtc/cursor-plane locks (so we need the crtc to get at the right
1539 * acquire context) and b) can try to disable the plane multiple times.
1544 state = drm_atomic_state_alloc(plane->dev);
1548 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1550 plane_state = drm_atomic_get_plane_state(state, plane);
1551 if (IS_ERR(plane_state)) {
1552 ret = PTR_ERR(plane_state);
1556 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1560 ret = drm_atomic_commit(state);
1564 /* Driver takes ownership of state on successful commit. */
1567 if (ret == -EDEADLK)
1570 drm_atomic_state_free(state);
1574 drm_atomic_state_clear(state);
1575 drm_atomic_legacy_backoff(state);
1578 * Someone might have exchanged the framebuffer while we dropped locks
1579 * in the backoff code. We need to fix up the fb refcount tracking the
1582 plane->old_fb = plane->fb;
1586 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1588 /* just used from fb-helper and atomic-helper: */
1589 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1590 struct drm_plane_state *plane_state)
1594 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1598 drm_atomic_set_fb_for_plane(plane_state, NULL);
1599 plane_state->crtc_x = 0;
1600 plane_state->crtc_y = 0;
1601 plane_state->crtc_h = 0;
1602 plane_state->crtc_w = 0;
1603 plane_state->src_x = 0;
1604 plane_state->src_y = 0;
1605 plane_state->src_h = 0;
1606 plane_state->src_w = 0;
1608 if (plane->crtc && (plane == plane->crtc->cursor))
1609 plane_state->state->legacy_cursor_update = true;
1614 static int update_output_state(struct drm_atomic_state *state,
1615 struct drm_mode_set *set)
1617 struct drm_device *dev = set->crtc->dev;
1618 struct drm_crtc *crtc;
1619 struct drm_crtc_state *crtc_state;
1620 struct drm_connector *connector;
1621 struct drm_connector_state *conn_state;
1624 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1625 state->acquire_ctx);
1629 /* First grab all affected connector/crtc states. */
1630 for (i = 0; i < set->num_connectors; i++) {
1631 conn_state = drm_atomic_get_connector_state(state,
1632 set->connectors[i]);
1633 if (IS_ERR(conn_state))
1634 return PTR_ERR(conn_state);
1637 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1638 ret = drm_atomic_add_affected_connectors(state, crtc);
1643 /* Then recompute connector->crtc links and crtc enabling state. */
1644 for_each_connector_in_state(state, connector, conn_state, i) {
1645 if (conn_state->crtc == set->crtc) {
1646 ret = drm_atomic_set_crtc_for_connector(conn_state,
1652 for (j = 0; j < set->num_connectors; j++) {
1653 if (set->connectors[j] == connector) {
1654 ret = drm_atomic_set_crtc_for_connector(conn_state,
1663 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1664 /* Don't update ->enable for the CRTC in the set_config request,
1665 * since a mismatch would indicate a bug in the upper layers.
1666 * The actual modeset code later on will catch any
1667 * inconsistencies here. */
1668 if (crtc == set->crtc)
1671 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1672 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1677 crtc_state->active = false;
1685 * drm_atomic_helper_set_config - set a new config from userspace
1686 * @set: mode set configuration
1688 * Provides a default crtc set_config handler using the atomic driver interface.
1691 * Returns 0 on success, negative errno numbers on failure.
1693 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1695 struct drm_atomic_state *state;
1696 struct drm_crtc *crtc = set->crtc;
1699 state = drm_atomic_state_alloc(crtc->dev);
1703 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1705 ret = __drm_atomic_helper_set_config(set, state);
1709 ret = drm_atomic_commit(state);
1713 /* Driver takes ownership of state on successful commit. */
1716 if (ret == -EDEADLK)
1719 drm_atomic_state_free(state);
1723 drm_atomic_state_clear(state);
1724 drm_atomic_legacy_backoff(state);
1727 * Someone might have exchanged the framebuffer while we dropped locks
1728 * in the backoff code. We need to fix up the fb refcount tracking the
1731 crtc->primary->old_fb = crtc->primary->fb;
1735 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1737 /* just used from fb-helper and atomic-helper: */
1738 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1739 struct drm_atomic_state *state)
1741 struct drm_crtc_state *crtc_state;
1742 struct drm_plane_state *primary_state;
1743 struct drm_crtc *crtc = set->crtc;
1746 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1747 if (IS_ERR(crtc_state))
1748 return PTR_ERR(crtc_state);
1750 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1751 if (IS_ERR(primary_state))
1752 return PTR_ERR(primary_state);
1756 WARN_ON(set->num_connectors);
1758 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1762 crtc_state->active = false;
1764 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1768 drm_atomic_set_fb_for_plane(primary_state, NULL);
1774 WARN_ON(!set->num_connectors);
1776 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1780 crtc_state->active = true;
1782 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1786 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1787 primary_state->crtc_x = 0;
1788 primary_state->crtc_y = 0;
1789 primary_state->crtc_h = set->mode->vdisplay;
1790 primary_state->crtc_w = set->mode->hdisplay;
1791 primary_state->src_x = set->x << 16;
1792 primary_state->src_y = set->y << 16;
1793 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1794 primary_state->src_h = set->mode->hdisplay << 16;
1795 primary_state->src_w = set->mode->vdisplay << 16;
1797 primary_state->src_h = set->mode->vdisplay << 16;
1798 primary_state->src_w = set->mode->hdisplay << 16;
1802 ret = update_output_state(state, set);
1810 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1812 * @property: DRM property
1813 * @val: value of property
1815 * Provides a default crtc set_property handler using the atomic driver
1819 * Zero on success, error code on failure
1822 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1823 struct drm_property *property,
1826 struct drm_atomic_state *state;
1827 struct drm_crtc_state *crtc_state;
1830 state = drm_atomic_state_alloc(crtc->dev);
1834 /* ->set_property is always called with all locks held. */
1835 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1837 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1838 if (IS_ERR(crtc_state)) {
1839 ret = PTR_ERR(crtc_state);
1843 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1848 ret = drm_atomic_commit(state);
1852 /* Driver takes ownership of state on successful commit. */
1855 if (ret == -EDEADLK)
1858 drm_atomic_state_free(state);
1862 drm_atomic_state_clear(state);
1863 drm_atomic_legacy_backoff(state);
1867 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1870 * drm_atomic_helper_plane_set_property - helper for plane properties
1872 * @property: DRM property
1873 * @val: value of property
1875 * Provides a default plane set_property handler using the atomic driver
1879 * Zero on success, error code on failure
1882 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1883 struct drm_property *property,
1886 struct drm_atomic_state *state;
1887 struct drm_plane_state *plane_state;
1890 state = drm_atomic_state_alloc(plane->dev);
1894 /* ->set_property is always called with all locks held. */
1895 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1897 plane_state = drm_atomic_get_plane_state(state, plane);
1898 if (IS_ERR(plane_state)) {
1899 ret = PTR_ERR(plane_state);
1903 ret = drm_atomic_plane_set_property(plane, plane_state,
1908 ret = drm_atomic_commit(state);
1912 /* Driver takes ownership of state on successful commit. */
1915 if (ret == -EDEADLK)
1918 drm_atomic_state_free(state);
1922 drm_atomic_state_clear(state);
1923 drm_atomic_legacy_backoff(state);
1927 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1930 * drm_atomic_helper_connector_set_property - helper for connector properties
1931 * @connector: DRM connector
1932 * @property: DRM property
1933 * @val: value of property
1935 * Provides a default connector set_property handler using the atomic driver
1939 * Zero on success, error code on failure
1942 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1943 struct drm_property *property,
1946 struct drm_atomic_state *state;
1947 struct drm_connector_state *connector_state;
1950 state = drm_atomic_state_alloc(connector->dev);
1954 /* ->set_property is always called with all locks held. */
1955 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1957 connector_state = drm_atomic_get_connector_state(state, connector);
1958 if (IS_ERR(connector_state)) {
1959 ret = PTR_ERR(connector_state);
1963 ret = drm_atomic_connector_set_property(connector, connector_state,
1968 ret = drm_atomic_commit(state);
1972 /* Driver takes ownership of state on successful commit. */
1975 if (ret == -EDEADLK)
1978 drm_atomic_state_free(state);
1982 drm_atomic_state_clear(state);
1983 drm_atomic_legacy_backoff(state);
1987 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1990 * drm_atomic_helper_page_flip - execute a legacy page flip
1992 * @fb: DRM framebuffer
1993 * @event: optional DRM event to signal upon completion
1994 * @flags: flip flags for non-vblank sync'ed updates
1996 * Provides a default page flip implementation using the atomic driver interface.
1998 * Note that for now so called async page flips (i.e. updates which are not
1999 * synchronized to vblank) are not supported, since the atomic interfaces have
2000 * no provisions for this yet.
2003 * Returns 0 on success, negative errno numbers on failure.
2005 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2006 struct drm_framebuffer *fb,
2007 struct drm_pending_vblank_event *event,
2010 struct drm_plane *plane = crtc->primary;
2011 struct drm_atomic_state *state;
2012 struct drm_plane_state *plane_state;
2013 struct drm_crtc_state *crtc_state;
2016 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2019 state = drm_atomic_state_alloc(plane->dev);
2023 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2025 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2026 if (IS_ERR(crtc_state)) {
2027 ret = PTR_ERR(crtc_state);
2030 crtc_state->event = event;
2032 plane_state = drm_atomic_get_plane_state(state, plane);
2033 if (IS_ERR(plane_state)) {
2034 ret = PTR_ERR(plane_state);
2038 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2041 drm_atomic_set_fb_for_plane(plane_state, fb);
2043 ret = drm_atomic_async_commit(state);
2047 /* Driver takes ownership of state on successful async commit. */
2050 if (ret == -EDEADLK)
2053 drm_atomic_state_free(state);
2057 drm_atomic_state_clear(state);
2058 drm_atomic_legacy_backoff(state);
2061 * Someone might have exchanged the framebuffer while we dropped locks
2062 * in the backoff code. We need to fix up the fb refcount tracking the
2065 plane->old_fb = plane->fb;
2069 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2072 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2073 * @connector: affected connector
2076 * This is the main helper function provided by the atomic helper framework for
2077 * implementing the legacy DPMS connector interface. It computes the new desired
2078 * ->active state for the corresponding CRTC (if the connector is enabled) and
2082 * Returns 0 on success, negative errno numbers on failure.
2084 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2087 struct drm_mode_config *config = &connector->dev->mode_config;
2088 struct drm_atomic_state *state;
2089 struct drm_crtc_state *crtc_state;
2090 struct drm_crtc *crtc;
2091 struct drm_connector *tmp_connector;
2093 bool active = false;
2094 int old_mode = connector->dpms;
2096 if (mode != DRM_MODE_DPMS_ON)
2097 mode = DRM_MODE_DPMS_OFF;
2099 connector->dpms = mode;
2100 crtc = connector->state->crtc;
2105 state = drm_atomic_state_alloc(connector->dev);
2109 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2111 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2112 if (IS_ERR(crtc_state)) {
2113 ret = PTR_ERR(crtc_state);
2117 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2119 drm_for_each_connector(tmp_connector, connector->dev) {
2120 if (tmp_connector->state->crtc != crtc)
2123 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2128 crtc_state->active = active;
2130 ret = drm_atomic_commit(state);
2134 /* Driver takes ownership of state on successful commit. */
2137 if (ret == -EDEADLK)
2140 connector->dpms = old_mode;
2141 drm_atomic_state_free(state);
2145 drm_atomic_state_clear(state);
2146 drm_atomic_legacy_backoff(state);
2150 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2153 * DOC: atomic state reset and initialization
2155 * Both the drm core and the atomic helpers assume that there is always the full
2156 * and correct atomic software state for all connectors, CRTCs and planes
2157 * available. Which is a bit a problem on driver load and also after system
2158 * suspend. One way to solve this is to have a hardware state read-out
2159 * infrastructure which reconstructs the full software state (e.g. the i915
2162 * The simpler solution is to just reset the software state to everything off,
2163 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2164 * the atomic helpers provide default reset implementations for all hooks.
2168 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2171 * Resets the atomic state for @crtc by freeing the state pointer (which might
2172 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2174 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2176 if (crtc->state && crtc->state->mode_blob)
2177 drm_property_unreference_blob(crtc->state->mode_blob);
2179 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2182 crtc->state->crtc = crtc;
2184 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2187 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2188 * @crtc: CRTC object
2189 * @state: atomic CRTC state
2191 * Copies atomic state from a CRTC's current state and resets inferred values.
2192 * This is useful for drivers that subclass the CRTC state.
2194 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2195 struct drm_crtc_state *state)
2197 memcpy(state, crtc->state, sizeof(*state));
2199 if (state->mode_blob)
2200 drm_property_reference_blob(state->mode_blob);
2201 state->mode_changed = false;
2202 state->active_changed = false;
2203 state->planes_changed = false;
2204 state->connectors_changed = false;
2205 state->event = NULL;
2207 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2210 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2213 * Default CRTC state duplicate hook for drivers which don't have their own
2214 * subclassed CRTC state structure.
2216 struct drm_crtc_state *
2217 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2219 struct drm_crtc_state *state;
2221 if (WARN_ON(!crtc->state))
2224 state = kmalloc(sizeof(*state), GFP_KERNEL);
2226 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2230 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2233 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2234 * @crtc: CRTC object
2235 * @state: CRTC state object to release
2237 * Releases all resources stored in the CRTC state without actually freeing
2238 * the memory of the CRTC state. This is useful for drivers that subclass the
2241 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2242 struct drm_crtc_state *state)
2244 if (state->mode_blob)
2245 drm_property_unreference_blob(state->mode_blob);
2247 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2250 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2252 * @state: CRTC state object to release
2254 * Default CRTC state destroy hook for drivers which don't have their own
2255 * subclassed CRTC state structure.
2257 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2258 struct drm_crtc_state *state)
2260 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2263 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2266 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2269 * Resets the atomic state for @plane by freeing the state pointer (which might
2270 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2272 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2274 if (plane->state && plane->state->fb)
2275 drm_framebuffer_unreference(plane->state->fb);
2277 kfree(plane->state);
2278 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2281 plane->state->plane = plane;
2283 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2286 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2287 * @plane: plane object
2288 * @state: atomic plane state
2290 * Copies atomic state from a plane's current state. This is useful for
2291 * drivers that subclass the plane state.
2293 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2294 struct drm_plane_state *state)
2296 memcpy(state, plane->state, sizeof(*state));
2299 drm_framebuffer_reference(state->fb);
2301 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2304 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2307 * Default plane state duplicate hook for drivers which don't have their own
2308 * subclassed plane state structure.
2310 struct drm_plane_state *
2311 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2313 struct drm_plane_state *state;
2315 if (WARN_ON(!plane->state))
2318 state = kmalloc(sizeof(*state), GFP_KERNEL);
2320 __drm_atomic_helper_plane_duplicate_state(plane, state);
2324 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2327 * __drm_atomic_helper_plane_destroy_state - release plane state
2328 * @plane: plane object
2329 * @state: plane state object to release
2331 * Releases all resources stored in the plane state without actually freeing
2332 * the memory of the plane state. This is useful for drivers that subclass the
2335 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2336 struct drm_plane_state *state)
2339 drm_framebuffer_unreference(state->fb);
2341 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2344 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2346 * @state: plane state object to release
2348 * Default plane state destroy hook for drivers which don't have their own
2349 * subclassed plane state structure.
2351 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2352 struct drm_plane_state *state)
2354 __drm_atomic_helper_plane_destroy_state(plane, state);
2357 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2360 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2361 * @connector: drm connector
2363 * Resets the atomic state for @connector by freeing the state pointer (which
2364 * might be NULL, e.g. at driver load time) and allocating a new empty state
2367 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2369 kfree(connector->state);
2370 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2372 if (connector->state)
2373 connector->state->connector = connector;
2375 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2378 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2379 * @connector: connector object
2380 * @state: atomic connector state
2382 * Copies atomic state from a connector's current state. This is useful for
2383 * drivers that subclass the connector state.
2386 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2387 struct drm_connector_state *state)
2389 memcpy(state, connector->state, sizeof(*state));
2391 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2394 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2395 * @connector: drm connector
2397 * Default connector state duplicate hook for drivers which don't have their own
2398 * subclassed connector state structure.
2400 struct drm_connector_state *
2401 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2403 struct drm_connector_state *state;
2405 if (WARN_ON(!connector->state))
2408 state = kmalloc(sizeof(*state), GFP_KERNEL);
2410 __drm_atomic_helper_connector_duplicate_state(connector, state);
2414 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2417 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2419 * @ctx: lock acquisition context
2421 * Makes a copy of the current atomic state by looping over all objects and
2422 * duplicating their respective states.
2424 * Note that this treats atomic state as persistent between save and restore.
2425 * Drivers must make sure that this is possible and won't result in confusion
2426 * or erroneous behaviour.
2428 * Note that if callers haven't already acquired all modeset locks this might
2429 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2432 * A pointer to the copy of the atomic state object on success or an
2433 * ERR_PTR()-encoded error code on failure.
2435 struct drm_atomic_state *
2436 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2437 struct drm_modeset_acquire_ctx *ctx)
2439 struct drm_atomic_state *state;
2440 struct drm_connector *conn;
2441 struct drm_plane *plane;
2442 struct drm_crtc *crtc;
2445 state = drm_atomic_state_alloc(dev);
2447 return ERR_PTR(-ENOMEM);
2449 state->acquire_ctx = ctx;
2451 drm_for_each_crtc(crtc, dev) {
2452 struct drm_crtc_state *crtc_state;
2454 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2455 if (IS_ERR(crtc_state)) {
2456 err = PTR_ERR(crtc_state);
2461 drm_for_each_plane(plane, dev) {
2462 struct drm_plane_state *plane_state;
2464 plane_state = drm_atomic_get_plane_state(state, plane);
2465 if (IS_ERR(plane_state)) {
2466 err = PTR_ERR(plane_state);
2471 drm_for_each_connector(conn, dev) {
2472 struct drm_connector_state *conn_state;
2474 conn_state = drm_atomic_get_connector_state(state, conn);
2475 if (IS_ERR(conn_state)) {
2476 err = PTR_ERR(conn_state);
2481 /* clear the acquire context so that it isn't accidentally reused */
2482 state->acquire_ctx = NULL;
2486 drm_atomic_state_free(state);
2487 state = ERR_PTR(err);
2492 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2495 * __drm_atomic_helper_connector_destroy_state - release connector state
2496 * @connector: connector object
2497 * @state: connector state object to release
2499 * Releases all resources stored in the connector state without actually
2500 * freeing the memory of the connector state. This is useful for drivers that
2501 * subclass the connector state.
2504 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2505 struct drm_connector_state *state)
2508 * This is currently a placeholder so that drivers that subclass the
2509 * state will automatically do the right thing if code is ever added
2513 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2516 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2517 * @connector: drm connector
2518 * @state: connector state object to release
2520 * Default connector state destroy hook for drivers which don't have their own
2521 * subclassed connector state structure.
2523 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2524 struct drm_connector_state *state)
2526 __drm_atomic_helper_connector_destroy_state(connector, state);
2529 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);