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 (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
214 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
215 new_encoder->base.id,
217 connector_state->crtc->base.id);
221 if (new_encoder == connector_state->best_encoder) {
222 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
225 new_encoder->base.id,
227 connector_state->crtc->base.id);
232 encoder_crtc = get_current_crtc_for_encoder(state->dev,
236 ret = steal_encoder(state, new_encoder, encoder_crtc);
238 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
245 if (WARN_ON(!connector_state->crtc))
248 connector_state->best_encoder = new_encoder;
249 idx = drm_crtc_index(connector_state->crtc);
251 crtc_state = state->crtc_states[idx];
252 crtc_state->connectors_changed = true;
254 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
257 new_encoder->base.id,
259 connector_state->crtc->base.id);
265 mode_fixup(struct drm_atomic_state *state)
267 struct drm_crtc *crtc;
268 struct drm_crtc_state *crtc_state;
269 struct drm_connector *connector;
270 struct drm_connector_state *conn_state;
274 for_each_crtc_in_state(state, crtc, crtc_state, i) {
275 if (!crtc_state->mode_changed &&
276 !crtc_state->connectors_changed)
279 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
282 for_each_connector_in_state(state, connector, conn_state, i) {
283 const struct drm_encoder_helper_funcs *funcs;
284 struct drm_encoder *encoder;
286 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
288 if (!conn_state->crtc || !conn_state->best_encoder)
292 state->crtc_states[drm_crtc_index(conn_state->crtc)];
295 * Each encoder has at most one connector (since we always steal
296 * it away), so we won't call ->mode_fixup twice.
298 encoder = conn_state->best_encoder;
299 funcs = encoder->helper_private;
303 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
304 &crtc_state->adjusted_mode);
306 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
310 if (funcs->atomic_check) {
311 ret = funcs->atomic_check(encoder, crtc_state,
314 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
315 encoder->base.id, encoder->name);
318 } else if (funcs->mode_fixup) {
319 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
320 &crtc_state->adjusted_mode);
322 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
323 encoder->base.id, encoder->name);
329 for_each_crtc_in_state(state, crtc, crtc_state, i) {
330 const struct drm_crtc_helper_funcs *funcs;
332 if (!crtc_state->mode_changed &&
333 !crtc_state->connectors_changed)
336 funcs = crtc->helper_private;
337 if (!funcs->mode_fixup)
340 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
341 &crtc_state->adjusted_mode);
343 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
353 * drm_atomic_helper_check_modeset - validate state object for modeset changes
355 * @state: the driver state object
357 * Check the state object to see if the requested state is physically possible.
358 * This does all the crtc and connector related computations for an atomic
359 * update and adds any additional connectors needed for full modesets and calls
360 * down into ->mode_fixup functions of the driver backend.
362 * crtc_state->mode_changed is set when the input mode is changed.
363 * crtc_state->connectors_changed is set when a connector is added or
364 * removed from the crtc.
365 * crtc_state->active_changed is set when crtc_state->active changes,
366 * which is used for dpms.
370 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
371 * plane update can't be done without a full modeset) _must_ call this function
372 * afterwards after that change. It is permitted to call this function multiple
373 * times for the same update, e.g. when the ->atomic_check functions depend upon
374 * the adjusted dotclock for fifo space allocation and watermark computation.
377 * Zero for success or -errno
380 drm_atomic_helper_check_modeset(struct drm_device *dev,
381 struct drm_atomic_state *state)
383 struct drm_crtc *crtc;
384 struct drm_crtc_state *crtc_state;
385 struct drm_connector *connector;
386 struct drm_connector_state *connector_state;
389 for_each_crtc_in_state(state, crtc, crtc_state, i) {
390 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
391 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
393 crtc_state->mode_changed = true;
396 if (crtc->state->enable != crtc_state->enable) {
397 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
401 * For clarity this assignment is done here, but
402 * enable == 0 is only true when there are no
403 * connectors and a NULL mode.
405 * The other way around is true as well. enable != 0
406 * iff connectors are attached and a mode is set.
408 crtc_state->mode_changed = true;
409 crtc_state->connectors_changed = true;
413 for_each_connector_in_state(state, connector, connector_state, i) {
415 * This only sets crtc->mode_changed for routing changes,
416 * drivers must set crtc->mode_changed themselves when connector
417 * properties need to be updated.
419 ret = update_connector_routing(state, i);
425 * After all the routing has been prepared we need to add in any
426 * connector which is itself unchanged, but who's crtc changes it's
427 * configuration. This must be done before calling mode_fixup in case a
428 * crtc only changed its mode but has the same set of connectors.
430 for_each_crtc_in_state(state, crtc, crtc_state, i) {
434 * We must set ->active_changed after walking connectors for
435 * otherwise an update that only changes active would result in
436 * a full modeset because update_connector_routing force that.
438 if (crtc->state->active != crtc_state->active) {
439 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
441 crtc_state->active_changed = true;
444 if (!drm_atomic_crtc_needs_modeset(crtc_state))
447 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
449 crtc_state->enable ? 'y' : 'n',
450 crtc_state->active ? 'y' : 'n');
452 ret = drm_atomic_add_affected_connectors(state, crtc);
456 ret = drm_atomic_add_affected_planes(state, crtc);
460 num_connectors = drm_atomic_connectors_for_crtc(state,
463 if (crtc_state->enable != !!num_connectors) {
464 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
471 return mode_fixup(state);
473 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
476 * drm_atomic_helper_check_planes - validate state object for planes changes
478 * @state: the driver state object
480 * Check the state object to see if the requested state is physically possible.
481 * This does all the plane update related checks using by calling into the
482 * ->atomic_check hooks provided by the driver.
484 * It also sets crtc_state->planes_changed to indicate that a crtc has
488 * Zero for success or -errno
491 drm_atomic_helper_check_planes(struct drm_device *dev,
492 struct drm_atomic_state *state)
494 struct drm_crtc *crtc;
495 struct drm_crtc_state *crtc_state;
496 struct drm_plane *plane;
497 struct drm_plane_state *plane_state;
500 for_each_plane_in_state(state, plane, plane_state, i) {
501 const struct drm_plane_helper_funcs *funcs;
503 funcs = plane->helper_private;
505 drm_atomic_helper_plane_changed(state, plane_state, plane);
507 if (!funcs || !funcs->atomic_check)
510 ret = funcs->atomic_check(plane, plane_state);
512 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
518 for_each_crtc_in_state(state, crtc, crtc_state, i) {
519 const struct drm_crtc_helper_funcs *funcs;
521 funcs = crtc->helper_private;
523 if (!funcs || !funcs->atomic_check)
526 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
528 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
536 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
539 * drm_atomic_helper_check - validate state object
541 * @state: the driver state object
543 * Check the state object to see if the requested state is physically possible.
544 * Only crtcs and planes have check callbacks, so for any additional (global)
545 * checking that a driver needs it can simply wrap that around this function.
546 * Drivers without such needs can directly use this as their ->atomic_check()
549 * This just wraps the two parts of the state checking for planes and modeset
550 * state in the default order: First it calls drm_atomic_helper_check_modeset()
551 * and then drm_atomic_helper_check_planes(). The assumption is that the
552 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
553 * e.g. properly compute watermarks.
556 * Zero for success or -errno
558 int drm_atomic_helper_check(struct drm_device *dev,
559 struct drm_atomic_state *state)
563 ret = drm_atomic_helper_check_modeset(dev, state);
567 ret = drm_atomic_helper_check_planes(dev, state);
573 EXPORT_SYMBOL(drm_atomic_helper_check);
576 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
578 struct drm_connector *connector;
579 struct drm_connector_state *old_conn_state;
580 struct drm_crtc *crtc;
581 struct drm_crtc_state *old_crtc_state;
584 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
585 const struct drm_encoder_helper_funcs *funcs;
586 struct drm_encoder *encoder;
587 struct drm_crtc_state *old_crtc_state;
589 /* Shut down everything that's in the changeset and currently
590 * still on. So need to check the old, saved state. */
591 if (!old_conn_state->crtc)
594 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
596 if (!old_crtc_state->active ||
597 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
600 encoder = old_conn_state->best_encoder;
602 /* We shouldn't get this far if we didn't previously have
603 * an encoder.. but WARN_ON() rather than explode.
605 if (WARN_ON(!encoder))
608 funcs = encoder->helper_private;
610 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
611 encoder->base.id, encoder->name);
614 * Each encoder has at most one connector (since we always steal
615 * it away), so we won't call disable hooks twice.
617 drm_bridge_disable(encoder->bridge);
619 /* Right function depends upon target state. */
620 if (connector->state->crtc && funcs->prepare)
621 funcs->prepare(encoder);
622 else if (funcs->disable)
623 funcs->disable(encoder);
625 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
627 drm_bridge_post_disable(encoder->bridge);
630 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
631 const struct drm_crtc_helper_funcs *funcs;
633 /* Shut down everything that needs a full modeset. */
634 if (!drm_atomic_crtc_needs_modeset(crtc->state))
637 if (!old_crtc_state->active)
640 funcs = crtc->helper_private;
642 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
646 /* Right function depends upon target state. */
647 if (crtc->state->enable && funcs->prepare)
648 funcs->prepare(crtc);
649 else if (funcs->disable)
650 funcs->disable(crtc);
652 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
657 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
659 * @old_state: atomic state object with old state structures
661 * This function updates all the various legacy modeset state pointers in
662 * connectors, encoders and crtcs. It also updates the timestamping constants
663 * used for precise vblank timestamps by calling
664 * drm_calc_timestamping_constants().
666 * Drivers can use this for building their own atomic commit if they don't have
667 * a pure helper-based modeset implementation.
670 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
671 struct drm_atomic_state *old_state)
673 struct drm_connector *connector;
674 struct drm_connector_state *old_conn_state;
675 struct drm_crtc *crtc;
676 struct drm_crtc_state *old_crtc_state;
679 /* clear out existing links and update dpms */
680 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
681 if (connector->encoder) {
682 WARN_ON(!connector->encoder->crtc);
684 connector->encoder->crtc = NULL;
685 connector->encoder = NULL;
688 crtc = connector->state->crtc;
689 if ((!crtc && old_conn_state->crtc) ||
690 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
691 struct drm_property *dpms_prop =
692 dev->mode_config.dpms_property;
693 int mode = DRM_MODE_DPMS_OFF;
695 if (crtc && crtc->state->active)
696 mode = DRM_MODE_DPMS_ON;
698 connector->dpms = mode;
699 drm_object_property_set_value(&connector->base,
705 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
706 if (!connector->state->crtc)
709 if (WARN_ON(!connector->state->best_encoder))
712 connector->encoder = connector->state->best_encoder;
713 connector->encoder->crtc = connector->state->crtc;
716 /* set legacy state in the crtc structure */
717 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
718 struct drm_plane *primary = crtc->primary;
720 crtc->mode = crtc->state->mode;
721 crtc->enabled = crtc->state->enable;
723 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
724 primary->state->crtc == crtc) {
725 crtc->x = primary->state->src_x >> 16;
726 crtc->y = primary->state->src_y >> 16;
729 if (crtc->state->enable)
730 drm_calc_timestamping_constants(crtc,
731 &crtc->state->adjusted_mode);
734 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
737 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
739 struct drm_crtc *crtc;
740 struct drm_crtc_state *old_crtc_state;
741 struct drm_connector *connector;
742 struct drm_connector_state *old_conn_state;
745 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
746 const struct drm_crtc_helper_funcs *funcs;
748 if (!crtc->state->mode_changed)
751 funcs = crtc->helper_private;
753 if (crtc->state->enable && funcs->mode_set_nofb) {
754 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
757 funcs->mode_set_nofb(crtc);
761 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
762 const struct drm_encoder_helper_funcs *funcs;
763 struct drm_crtc_state *new_crtc_state;
764 struct drm_encoder *encoder;
765 struct drm_display_mode *mode, *adjusted_mode;
767 if (!connector->state->best_encoder)
770 encoder = connector->state->best_encoder;
771 funcs = encoder->helper_private;
772 new_crtc_state = connector->state->crtc->state;
773 mode = &new_crtc_state->mode;
774 adjusted_mode = &new_crtc_state->adjusted_mode;
776 if (!new_crtc_state->mode_changed)
779 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
780 encoder->base.id, encoder->name);
783 * Each encoder has at most one connector (since we always steal
784 * it away), so we won't call mode_set hooks twice.
787 funcs->mode_set(encoder, mode, adjusted_mode);
789 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
794 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
796 * @old_state: atomic state object with old state structures
798 * This function shuts down all the outputs that need to be shut down and
799 * prepares them (if required) with the new mode.
801 * For compatibility with legacy crtc helpers this should be called before
802 * drm_atomic_helper_commit_planes(), which is what the default commit function
803 * does. But drivers with different needs can group the modeset commits together
804 * and do the plane commits at the end. This is useful for drivers doing runtime
805 * PM since planes updates then only happen when the CRTC is actually enabled.
807 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
808 struct drm_atomic_state *old_state)
810 disable_outputs(dev, old_state);
812 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
814 crtc_set_mode(dev, old_state);
816 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
819 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
821 * @old_state: atomic state object with old state structures
823 * This function enables all the outputs with the new configuration which had to
824 * be turned off for the update.
826 * For compatibility with legacy crtc helpers this should be called after
827 * drm_atomic_helper_commit_planes(), which is what the default commit function
828 * does. But drivers with different needs can group the modeset commits together
829 * and do the plane commits at the end. This is useful for drivers doing runtime
830 * PM since planes updates then only happen when the CRTC is actually enabled.
832 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
833 struct drm_atomic_state *old_state)
835 struct drm_crtc *crtc;
836 struct drm_crtc_state *old_crtc_state;
837 struct drm_connector *connector;
838 struct drm_connector_state *old_conn_state;
841 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
842 const struct drm_crtc_helper_funcs *funcs;
844 /* Need to filter out CRTCs where only planes change. */
845 if (!drm_atomic_crtc_needs_modeset(crtc->state))
848 if (!crtc->state->active)
851 funcs = crtc->helper_private;
853 if (crtc->state->enable) {
854 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
864 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
865 const struct drm_encoder_helper_funcs *funcs;
866 struct drm_encoder *encoder;
868 if (!connector->state->best_encoder)
871 if (!connector->state->crtc->state->active ||
872 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
875 encoder = connector->state->best_encoder;
876 funcs = encoder->helper_private;
878 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
879 encoder->base.id, encoder->name);
882 * Each encoder has at most one connector (since we always steal
883 * it away), so we won't call enable hooks twice.
885 drm_bridge_pre_enable(encoder->bridge);
888 funcs->enable(encoder);
890 funcs->commit(encoder);
892 drm_bridge_enable(encoder->bridge);
895 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
897 static void wait_for_fences(struct drm_device *dev,
898 struct drm_atomic_state *state)
900 struct drm_plane *plane;
901 struct drm_plane_state *plane_state;
904 for_each_plane_in_state(state, plane, plane_state, i) {
905 if (!plane->state->fence)
908 WARN_ON(!plane->state->fb);
910 fence_wait(plane->state->fence, false);
911 fence_put(plane->state->fence);
912 plane->state->fence = NULL;
917 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
919 * @old_state: atomic state object with old state structures
922 * Checks whether the framebuffer used for this CRTC changes as a result of
923 * the atomic update. This is useful for drivers which cannot use
924 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
928 * true if the framebuffer changed.
930 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
931 struct drm_atomic_state *old_state,
932 struct drm_crtc *crtc)
934 struct drm_plane *plane;
935 struct drm_plane_state *old_plane_state;
938 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
939 if (plane->state->crtc != crtc &&
940 old_plane_state->crtc != crtc)
943 if (plane->state->fb != old_plane_state->fb)
949 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
952 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
954 * @old_state: atomic state object with old state structures
956 * Helper to, after atomic commit, wait for vblanks on all effected
957 * crtcs (ie. before cleaning up old framebuffers using
958 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
959 * framebuffers have actually changed to optimize for the legacy cursor and
960 * plane update use-case.
963 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
964 struct drm_atomic_state *old_state)
966 struct drm_crtc *crtc;
967 struct drm_crtc_state *old_crtc_state;
970 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
971 /* No one cares about the old state, so abuse it for tracking
972 * and store whether we hold a vblank reference (and should do a
973 * vblank wait) in the ->enable boolean. */
974 old_crtc_state->enable = false;
976 if (!crtc->state->enable)
979 /* Legacy cursor ioctls are completely unsynced, and userspace
980 * relies on that (by doing tons of cursor updates). */
981 if (old_state->legacy_cursor_update)
984 if (!drm_atomic_helper_framebuffer_changed(dev,
988 ret = drm_crtc_vblank_get(crtc);
992 old_crtc_state->enable = true;
993 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
996 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
997 if (!old_crtc_state->enable)
1000 ret = wait_event_timeout(dev->vblank[i].queue,
1001 old_crtc_state->last_vblank_count !=
1002 drm_crtc_vblank_count(crtc),
1003 msecs_to_jiffies(50));
1005 drm_crtc_vblank_put(crtc);
1008 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1011 * drm_atomic_helper_commit - commit validated state object
1013 * @state: the driver state object
1014 * @async: asynchronous commit
1016 * This function commits a with drm_atomic_helper_check() pre-validated state
1017 * object. This can still fail when e.g. the framebuffer reservation fails. For
1018 * now this doesn't implement asynchronous commits.
1020 * Note that right now this function does not support async commits, and hence
1021 * driver writers must implement their own version for now. Also note that the
1022 * default ordering of how the various stages are called is to match the legacy
1023 * modeset helper library closest. One peculiarity of that is that it doesn't
1024 * mesh well with runtime PM at all.
1026 * For drivers supporting runtime PM the recommended sequence is
1028 * drm_atomic_helper_commit_modeset_disables(dev, state);
1030 * drm_atomic_helper_commit_modeset_enables(dev, state);
1032 * drm_atomic_helper_commit_planes(dev, state, true);
1034 * See the kerneldoc entries for these three functions for more details.
1037 * Zero for success or -errno.
1039 int drm_atomic_helper_commit(struct drm_device *dev,
1040 struct drm_atomic_state *state,
1048 ret = drm_atomic_helper_prepare_planes(dev, state);
1053 * This is the point of no return - everything below never fails except
1054 * when the hw goes bonghits. Which means we can commit the new state on
1055 * the software side now.
1058 drm_atomic_helper_swap_state(dev, state);
1061 * Everything below can be run asynchronously without the need to grab
1062 * any modeset locks at all under one condition: It must be guaranteed
1063 * that the asynchronous work has either been cancelled (if the driver
1064 * supports it, which at least requires that the framebuffers get
1065 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1066 * before the new state gets committed on the software side with
1067 * drm_atomic_helper_swap_state().
1069 * This scheme allows new atomic state updates to be prepared and
1070 * checked in parallel to the asynchronous completion of the previous
1071 * update. Which is important since compositors need to figure out the
1072 * composition of the next frame right after having submitted the
1076 wait_for_fences(dev, state);
1078 drm_atomic_helper_commit_modeset_disables(dev, state);
1080 drm_atomic_helper_commit_planes(dev, state, false);
1082 drm_atomic_helper_commit_modeset_enables(dev, state);
1084 drm_atomic_helper_wait_for_vblanks(dev, state);
1086 drm_atomic_helper_cleanup_planes(dev, state);
1088 drm_atomic_state_free(state);
1092 EXPORT_SYMBOL(drm_atomic_helper_commit);
1095 * DOC: implementing async commit
1097 * For now the atomic helpers don't support async commit directly. If there is
1098 * real need it could be added though, using the dma-buf fence infrastructure
1099 * for generic synchronization with outstanding rendering.
1101 * For now drivers have to implement async commit themselves, with the following
1102 * sequence being the recommended one:
1104 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1105 * which commit needs to call which can fail, so we want to run it first and
1108 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1109 * might be affected the new state update. This can be done by either cancelling
1110 * or flushing the work items, depending upon whether the driver can deal with
1111 * cancelled updates. Note that it is important to ensure that the framebuffer
1112 * cleanup is still done when cancelling.
1114 * For sufficient parallelism it is recommended to have a work item per crtc
1115 * (for updates which don't touch global state) and a global one. Then we only
1116 * need to synchronize with the crtc work items for changed crtcs and the global
1117 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1119 * 3. The software state is updated synchronously with
1120 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1121 * locks means concurrent callers never see inconsistent state. And doing this
1122 * while it's guaranteed that no relevant async worker runs means that async
1123 * workers do not need grab any locks. Actually they must not grab locks, for
1124 * otherwise the work flushing will deadlock.
1126 * 4. Schedule a work item to do all subsequent steps, using the split-out
1127 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1128 * then cleaning up the framebuffers after the old framebuffer is no longer
1133 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1135 * @state: atomic state object with new state structures
1137 * This function prepares plane state, specifically framebuffers, for the new
1138 * configuration. If any failure is encountered this function will call
1139 * ->cleanup_fb on any already successfully prepared framebuffer.
1142 * 0 on success, negative error code on failure.
1144 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1145 struct drm_atomic_state *state)
1147 int nplanes = dev->mode_config.num_total_plane;
1150 for (i = 0; i < nplanes; i++) {
1151 const struct drm_plane_helper_funcs *funcs;
1152 struct drm_plane *plane = state->planes[i];
1153 struct drm_plane_state *plane_state = state->plane_states[i];
1158 funcs = plane->helper_private;
1160 if (funcs->prepare_fb) {
1161 ret = funcs->prepare_fb(plane, plane_state);
1170 for (i--; i >= 0; i--) {
1171 const struct drm_plane_helper_funcs *funcs;
1172 struct drm_plane *plane = state->planes[i];
1173 struct drm_plane_state *plane_state = state->plane_states[i];
1178 funcs = plane->helper_private;
1180 if (funcs->cleanup_fb)
1181 funcs->cleanup_fb(plane, plane_state);
1187 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1189 bool plane_crtc_active(struct drm_plane_state *state)
1191 return state->crtc && state->crtc->state->active;
1195 * drm_atomic_helper_commit_planes - commit plane state
1197 * @old_state: atomic state object with old state structures
1198 * @active_only: Only commit on active CRTC if set
1200 * This function commits the new plane state using the plane and atomic helper
1201 * functions for planes and crtcs. It assumes that the atomic state has already
1202 * been pushed into the relevant object state pointers, since this step can no
1205 * It still requires the global state object @old_state to know which planes and
1206 * crtcs need to be updated though.
1208 * Note that this function does all plane updates across all CRTCs in one step.
1209 * If the hardware can't support this approach look at
1210 * drm_atomic_helper_commit_planes_on_crtc() instead.
1212 * Plane parameters can be updated by applications while the associated CRTC is
1213 * disabled. The DRM/KMS core will store the parameters in the plane state,
1214 * which will be available to the driver when the CRTC is turned on. As a result
1215 * most drivers don't need to be immediately notified of plane updates for a
1218 * Unless otherwise needed, drivers are advised to set the @active_only
1219 * parameters to true in order not to receive plane update notifications related
1220 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1221 * driver code when the driver and/or hardware can't or just don't need to deal
1222 * with updates on disabled CRTCs, for example when supporting runtime PM.
1224 * The drm_atomic_helper_commit() default implementation only sets @active_only
1225 * to false to most closely match the behaviour of the legacy helpers. This should
1226 * not be copied blindly by drivers.
1228 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1229 struct drm_atomic_state *old_state,
1232 struct drm_crtc *crtc;
1233 struct drm_crtc_state *old_crtc_state;
1234 struct drm_plane *plane;
1235 struct drm_plane_state *old_plane_state;
1238 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1239 const struct drm_crtc_helper_funcs *funcs;
1241 funcs = crtc->helper_private;
1243 if (!funcs || !funcs->atomic_begin)
1246 if (active_only && !crtc->state->active)
1249 funcs->atomic_begin(crtc, old_crtc_state);
1252 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1253 const struct drm_plane_helper_funcs *funcs;
1256 funcs = plane->helper_private;
1261 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1265 * Skip planes related to inactive CRTCs. If the plane
1266 * is enabled use the state of the current CRTC. If the
1267 * plane is being disabled use the state of the old
1268 * CRTC to avoid skipping planes being disabled on an
1271 if (!disabling && !plane_crtc_active(plane->state))
1273 if (disabling && !plane_crtc_active(old_plane_state))
1278 * Special-case disabling the plane if drivers support it.
1280 if (disabling && funcs->atomic_disable)
1281 funcs->atomic_disable(plane, old_plane_state);
1282 else if (plane->state->crtc || disabling)
1283 funcs->atomic_update(plane, old_plane_state);
1286 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1287 const struct drm_crtc_helper_funcs *funcs;
1289 funcs = crtc->helper_private;
1291 if (!funcs || !funcs->atomic_flush)
1294 if (active_only && !crtc->state->active)
1297 funcs->atomic_flush(crtc, old_crtc_state);
1300 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1303 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1304 * @old_crtc_state: atomic state object with the old crtc state
1306 * This function commits the new plane state using the plane and atomic helper
1307 * functions for planes on the specific crtc. It assumes that the atomic state
1308 * has already been pushed into the relevant object state pointers, since this
1309 * step can no longer fail.
1311 * This function is useful when plane updates should be done crtc-by-crtc
1312 * instead of one global step like drm_atomic_helper_commit_planes() does.
1314 * This function can only be savely used when planes are not allowed to move
1315 * between different CRTCs because this function doesn't handle inter-CRTC
1316 * depencies. Callers need to ensure that either no such depencies exist,
1317 * resolve them through ordering of commit calls or through some other means.
1320 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1322 const struct drm_crtc_helper_funcs *crtc_funcs;
1323 struct drm_crtc *crtc = old_crtc_state->crtc;
1324 struct drm_atomic_state *old_state = old_crtc_state->state;
1325 struct drm_plane *plane;
1326 unsigned plane_mask;
1328 plane_mask = old_crtc_state->plane_mask;
1329 plane_mask |= crtc->state->plane_mask;
1331 crtc_funcs = crtc->helper_private;
1332 if (crtc_funcs && crtc_funcs->atomic_begin)
1333 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1335 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1336 struct drm_plane_state *old_plane_state =
1337 drm_atomic_get_existing_plane_state(old_state, plane);
1338 const struct drm_plane_helper_funcs *plane_funcs;
1340 plane_funcs = plane->helper_private;
1342 if (!old_plane_state || !plane_funcs)
1345 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1347 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1348 plane_funcs->atomic_disable)
1349 plane_funcs->atomic_disable(plane, old_plane_state);
1350 else if (plane->state->crtc ||
1351 drm_atomic_plane_disabling(plane, old_plane_state))
1352 plane_funcs->atomic_update(plane, old_plane_state);
1355 if (crtc_funcs && crtc_funcs->atomic_flush)
1356 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1358 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1361 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1363 * @old_state: atomic state object with old state structures
1365 * This function cleans up plane state, specifically framebuffers, from the old
1366 * configuration. Hence the old configuration must be perserved in @old_state to
1367 * be able to call this function.
1369 * This function must also be called on the new state when the atomic update
1370 * fails at any point after calling drm_atomic_helper_prepare_planes().
1372 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1373 struct drm_atomic_state *old_state)
1375 struct drm_plane *plane;
1376 struct drm_plane_state *plane_state;
1379 for_each_plane_in_state(old_state, plane, plane_state, i) {
1380 const struct drm_plane_helper_funcs *funcs;
1382 funcs = plane->helper_private;
1384 if (funcs->cleanup_fb)
1385 funcs->cleanup_fb(plane, plane_state);
1388 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1391 * drm_atomic_helper_swap_state - store atomic state into current sw state
1393 * @state: atomic state
1395 * This function stores the atomic state into the current state pointers in all
1396 * driver objects. It should be called after all failing steps have been done
1397 * and succeeded, but before the actual hardware state is committed.
1399 * For cleanup and error recovery the current state for all changed objects will
1400 * be swaped into @state.
1402 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1404 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1406 * 2. Do any other steps that might fail.
1408 * 3. Put the staged state into the current state pointers with this function.
1410 * 4. Actually commit the hardware state.
1412 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1413 * contains the old state. Also do any other cleanup required with that state.
1415 void drm_atomic_helper_swap_state(struct drm_device *dev,
1416 struct drm_atomic_state *state)
1420 for (i = 0; i < dev->mode_config.num_connector; i++) {
1421 struct drm_connector *connector = state->connectors[i];
1426 connector->state->state = state;
1427 swap(state->connector_states[i], connector->state);
1428 connector->state->state = NULL;
1431 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1432 struct drm_crtc *crtc = state->crtcs[i];
1437 crtc->state->state = state;
1438 swap(state->crtc_states[i], crtc->state);
1439 crtc->state->state = NULL;
1442 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1443 struct drm_plane *plane = state->planes[i];
1448 plane->state->state = state;
1449 swap(state->plane_states[i], plane->state);
1450 plane->state->state = NULL;
1453 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1456 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1457 * @plane: plane object to update
1458 * @crtc: owning CRTC of owning plane
1459 * @fb: framebuffer to flip onto plane
1460 * @crtc_x: x offset of primary plane on crtc
1461 * @crtc_y: y offset of primary plane on crtc
1462 * @crtc_w: width of primary plane rectangle on crtc
1463 * @crtc_h: height of primary plane rectangle on crtc
1464 * @src_x: x offset of @fb for panning
1465 * @src_y: y offset of @fb for panning
1466 * @src_w: width of source rectangle in @fb
1467 * @src_h: height of source rectangle in @fb
1469 * Provides a default plane update handler using the atomic driver interface.
1472 * Zero on success, error code on failure
1474 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1475 struct drm_crtc *crtc,
1476 struct drm_framebuffer *fb,
1477 int crtc_x, int crtc_y,
1478 unsigned int crtc_w, unsigned int crtc_h,
1479 uint32_t src_x, uint32_t src_y,
1480 uint32_t src_w, uint32_t src_h)
1482 struct drm_atomic_state *state;
1483 struct drm_plane_state *plane_state;
1486 state = drm_atomic_state_alloc(plane->dev);
1490 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1492 plane_state = drm_atomic_get_plane_state(state, plane);
1493 if (IS_ERR(plane_state)) {
1494 ret = PTR_ERR(plane_state);
1498 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1501 drm_atomic_set_fb_for_plane(plane_state, fb);
1502 plane_state->crtc_x = crtc_x;
1503 plane_state->crtc_y = crtc_y;
1504 plane_state->crtc_h = crtc_h;
1505 plane_state->crtc_w = crtc_w;
1506 plane_state->src_x = src_x;
1507 plane_state->src_y = src_y;
1508 plane_state->src_h = src_h;
1509 plane_state->src_w = src_w;
1511 if (plane == crtc->cursor)
1512 state->legacy_cursor_update = true;
1514 ret = drm_atomic_commit(state);
1518 /* Driver takes ownership of state on successful commit. */
1521 if (ret == -EDEADLK)
1524 drm_atomic_state_free(state);
1528 drm_atomic_state_clear(state);
1529 drm_atomic_legacy_backoff(state);
1532 * Someone might have exchanged the framebuffer while we dropped locks
1533 * in the backoff code. We need to fix up the fb refcount tracking the
1536 plane->old_fb = plane->fb;
1540 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1543 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1544 * @plane: plane to disable
1546 * Provides a default plane disable handler using the atomic driver interface.
1549 * Zero on success, error code on failure
1551 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1553 struct drm_atomic_state *state;
1554 struct drm_plane_state *plane_state;
1558 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1559 * acquire context. The real fix will be to wire the acquire ctx through
1560 * everywhere we need it, but meanwhile prevent chaos by just skipping
1561 * this noop. The critical case is the cursor ioctls which a) only grab
1562 * crtc/cursor-plane locks (so we need the crtc to get at the right
1563 * acquire context) and b) can try to disable the plane multiple times.
1568 state = drm_atomic_state_alloc(plane->dev);
1572 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1574 plane_state = drm_atomic_get_plane_state(state, plane);
1575 if (IS_ERR(plane_state)) {
1576 ret = PTR_ERR(plane_state);
1580 if (plane_state->crtc && (plane == plane->crtc->cursor))
1581 plane_state->state->legacy_cursor_update = true;
1583 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1587 ret = drm_atomic_commit(state);
1591 /* Driver takes ownership of state on successful commit. */
1594 if (ret == -EDEADLK)
1597 drm_atomic_state_free(state);
1601 drm_atomic_state_clear(state);
1602 drm_atomic_legacy_backoff(state);
1605 * Someone might have exchanged the framebuffer while we dropped locks
1606 * in the backoff code. We need to fix up the fb refcount tracking the
1609 plane->old_fb = plane->fb;
1613 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1615 /* just used from fb-helper and atomic-helper: */
1616 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1617 struct drm_plane_state *plane_state)
1621 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1625 drm_atomic_set_fb_for_plane(plane_state, NULL);
1626 plane_state->crtc_x = 0;
1627 plane_state->crtc_y = 0;
1628 plane_state->crtc_h = 0;
1629 plane_state->crtc_w = 0;
1630 plane_state->src_x = 0;
1631 plane_state->src_y = 0;
1632 plane_state->src_h = 0;
1633 plane_state->src_w = 0;
1638 static int update_output_state(struct drm_atomic_state *state,
1639 struct drm_mode_set *set)
1641 struct drm_device *dev = set->crtc->dev;
1642 struct drm_crtc *crtc;
1643 struct drm_crtc_state *crtc_state;
1644 struct drm_connector *connector;
1645 struct drm_connector_state *conn_state;
1648 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1649 state->acquire_ctx);
1653 /* First grab all affected connector/crtc states. */
1654 for (i = 0; i < set->num_connectors; i++) {
1655 conn_state = drm_atomic_get_connector_state(state,
1656 set->connectors[i]);
1657 if (IS_ERR(conn_state))
1658 return PTR_ERR(conn_state);
1661 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1662 ret = drm_atomic_add_affected_connectors(state, crtc);
1667 /* Then recompute connector->crtc links and crtc enabling state. */
1668 for_each_connector_in_state(state, connector, conn_state, i) {
1669 if (conn_state->crtc == set->crtc) {
1670 ret = drm_atomic_set_crtc_for_connector(conn_state,
1676 for (j = 0; j < set->num_connectors; j++) {
1677 if (set->connectors[j] == connector) {
1678 ret = drm_atomic_set_crtc_for_connector(conn_state,
1687 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1688 /* Don't update ->enable for the CRTC in the set_config request,
1689 * since a mismatch would indicate a bug in the upper layers.
1690 * The actual modeset code later on will catch any
1691 * inconsistencies here. */
1692 if (crtc == set->crtc)
1695 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1696 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1701 crtc_state->active = false;
1709 * drm_atomic_helper_set_config - set a new config from userspace
1710 * @set: mode set configuration
1712 * Provides a default crtc set_config handler using the atomic driver interface.
1715 * Returns 0 on success, negative errno numbers on failure.
1717 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1719 struct drm_atomic_state *state;
1720 struct drm_crtc *crtc = set->crtc;
1723 state = drm_atomic_state_alloc(crtc->dev);
1727 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1729 ret = __drm_atomic_helper_set_config(set, state);
1733 ret = drm_atomic_commit(state);
1737 /* Driver takes ownership of state on successful commit. */
1740 if (ret == -EDEADLK)
1743 drm_atomic_state_free(state);
1747 drm_atomic_state_clear(state);
1748 drm_atomic_legacy_backoff(state);
1751 * Someone might have exchanged the framebuffer while we dropped locks
1752 * in the backoff code. We need to fix up the fb refcount tracking the
1755 crtc->primary->old_fb = crtc->primary->fb;
1759 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1761 /* just used from fb-helper and atomic-helper: */
1762 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1763 struct drm_atomic_state *state)
1765 struct drm_crtc_state *crtc_state;
1766 struct drm_plane_state *primary_state;
1767 struct drm_crtc *crtc = set->crtc;
1768 int hdisplay, vdisplay;
1771 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1772 if (IS_ERR(crtc_state))
1773 return PTR_ERR(crtc_state);
1775 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1776 if (IS_ERR(primary_state))
1777 return PTR_ERR(primary_state);
1781 WARN_ON(set->num_connectors);
1783 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1787 crtc_state->active = false;
1789 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1793 drm_atomic_set_fb_for_plane(primary_state, NULL);
1799 WARN_ON(!set->num_connectors);
1801 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1805 crtc_state->active = true;
1807 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1811 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1813 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1814 primary_state->crtc_x = 0;
1815 primary_state->crtc_y = 0;
1816 primary_state->crtc_h = vdisplay;
1817 primary_state->crtc_w = hdisplay;
1818 primary_state->src_x = set->x << 16;
1819 primary_state->src_y = set->y << 16;
1820 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1821 primary_state->src_h = hdisplay << 16;
1822 primary_state->src_w = vdisplay << 16;
1824 primary_state->src_h = vdisplay << 16;
1825 primary_state->src_w = hdisplay << 16;
1829 ret = update_output_state(state, set);
1837 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1839 * @property: DRM property
1840 * @val: value of property
1842 * Provides a default crtc set_property handler using the atomic driver
1846 * Zero on success, error code on failure
1849 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1850 struct drm_property *property,
1853 struct drm_atomic_state *state;
1854 struct drm_crtc_state *crtc_state;
1857 state = drm_atomic_state_alloc(crtc->dev);
1861 /* ->set_property is always called with all locks held. */
1862 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1864 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1865 if (IS_ERR(crtc_state)) {
1866 ret = PTR_ERR(crtc_state);
1870 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1875 ret = drm_atomic_commit(state);
1879 /* Driver takes ownership of state on successful commit. */
1882 if (ret == -EDEADLK)
1885 drm_atomic_state_free(state);
1889 drm_atomic_state_clear(state);
1890 drm_atomic_legacy_backoff(state);
1894 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1897 * drm_atomic_helper_plane_set_property - helper for plane properties
1899 * @property: DRM property
1900 * @val: value of property
1902 * Provides a default plane set_property handler using the atomic driver
1906 * Zero on success, error code on failure
1909 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1910 struct drm_property *property,
1913 struct drm_atomic_state *state;
1914 struct drm_plane_state *plane_state;
1917 state = drm_atomic_state_alloc(plane->dev);
1921 /* ->set_property is always called with all locks held. */
1922 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1924 plane_state = drm_atomic_get_plane_state(state, plane);
1925 if (IS_ERR(plane_state)) {
1926 ret = PTR_ERR(plane_state);
1930 ret = drm_atomic_plane_set_property(plane, plane_state,
1935 ret = drm_atomic_commit(state);
1939 /* Driver takes ownership of state on successful commit. */
1942 if (ret == -EDEADLK)
1945 drm_atomic_state_free(state);
1949 drm_atomic_state_clear(state);
1950 drm_atomic_legacy_backoff(state);
1954 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1957 * drm_atomic_helper_connector_set_property - helper for connector properties
1958 * @connector: DRM connector
1959 * @property: DRM property
1960 * @val: value of property
1962 * Provides a default connector set_property handler using the atomic driver
1966 * Zero on success, error code on failure
1969 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1970 struct drm_property *property,
1973 struct drm_atomic_state *state;
1974 struct drm_connector_state *connector_state;
1977 state = drm_atomic_state_alloc(connector->dev);
1981 /* ->set_property is always called with all locks held. */
1982 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1984 connector_state = drm_atomic_get_connector_state(state, connector);
1985 if (IS_ERR(connector_state)) {
1986 ret = PTR_ERR(connector_state);
1990 ret = drm_atomic_connector_set_property(connector, connector_state,
1995 ret = drm_atomic_commit(state);
1999 /* Driver takes ownership of state on successful commit. */
2002 if (ret == -EDEADLK)
2005 drm_atomic_state_free(state);
2009 drm_atomic_state_clear(state);
2010 drm_atomic_legacy_backoff(state);
2014 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2017 * drm_atomic_helper_page_flip - execute a legacy page flip
2019 * @fb: DRM framebuffer
2020 * @event: optional DRM event to signal upon completion
2021 * @flags: flip flags for non-vblank sync'ed updates
2023 * Provides a default page flip implementation using the atomic driver interface.
2025 * Note that for now so called async page flips (i.e. updates which are not
2026 * synchronized to vblank) are not supported, since the atomic interfaces have
2027 * no provisions for this yet.
2030 * Returns 0 on success, negative errno numbers on failure.
2032 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2033 struct drm_framebuffer *fb,
2034 struct drm_pending_vblank_event *event,
2037 struct drm_plane *plane = crtc->primary;
2038 struct drm_atomic_state *state;
2039 struct drm_plane_state *plane_state;
2040 struct drm_crtc_state *crtc_state;
2043 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2046 state = drm_atomic_state_alloc(plane->dev);
2050 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2052 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2053 if (IS_ERR(crtc_state)) {
2054 ret = PTR_ERR(crtc_state);
2057 crtc_state->event = event;
2059 plane_state = drm_atomic_get_plane_state(state, plane);
2060 if (IS_ERR(plane_state)) {
2061 ret = PTR_ERR(plane_state);
2065 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2068 drm_atomic_set_fb_for_plane(plane_state, fb);
2070 ret = drm_atomic_async_commit(state);
2074 /* Driver takes ownership of state on successful async commit. */
2077 if (ret == -EDEADLK)
2080 drm_atomic_state_free(state);
2084 drm_atomic_state_clear(state);
2085 drm_atomic_legacy_backoff(state);
2088 * Someone might have exchanged the framebuffer while we dropped locks
2089 * in the backoff code. We need to fix up the fb refcount tracking the
2092 plane->old_fb = plane->fb;
2096 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2099 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2100 * @connector: affected connector
2103 * This is the main helper function provided by the atomic helper framework for
2104 * implementing the legacy DPMS connector interface. It computes the new desired
2105 * ->active state for the corresponding CRTC (if the connector is enabled) and
2109 * Returns 0 on success, negative errno numbers on failure.
2111 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2114 struct drm_mode_config *config = &connector->dev->mode_config;
2115 struct drm_atomic_state *state;
2116 struct drm_crtc_state *crtc_state;
2117 struct drm_crtc *crtc;
2118 struct drm_connector *tmp_connector;
2120 bool active = false;
2121 int old_mode = connector->dpms;
2123 if (mode != DRM_MODE_DPMS_ON)
2124 mode = DRM_MODE_DPMS_OFF;
2126 connector->dpms = mode;
2127 crtc = connector->state->crtc;
2132 state = drm_atomic_state_alloc(connector->dev);
2136 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2138 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2139 if (IS_ERR(crtc_state)) {
2140 ret = PTR_ERR(crtc_state);
2144 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2146 drm_for_each_connector(tmp_connector, connector->dev) {
2147 if (tmp_connector->state->crtc != crtc)
2150 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2155 crtc_state->active = active;
2157 ret = drm_atomic_commit(state);
2161 /* Driver takes ownership of state on successful commit. */
2164 if (ret == -EDEADLK)
2167 connector->dpms = old_mode;
2168 drm_atomic_state_free(state);
2172 drm_atomic_state_clear(state);
2173 drm_atomic_legacy_backoff(state);
2177 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2180 * DOC: atomic state reset and initialization
2182 * Both the drm core and the atomic helpers assume that there is always the full
2183 * and correct atomic software state for all connectors, CRTCs and planes
2184 * available. Which is a bit a problem on driver load and also after system
2185 * suspend. One way to solve this is to have a hardware state read-out
2186 * infrastructure which reconstructs the full software state (e.g. the i915
2189 * The simpler solution is to just reset the software state to everything off,
2190 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2191 * the atomic helpers provide default reset implementations for all hooks.
2195 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2198 * Resets the atomic state for @crtc by freeing the state pointer (which might
2199 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2201 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2203 if (crtc->state && crtc->state->mode_blob)
2204 drm_property_unreference_blob(crtc->state->mode_blob);
2206 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2209 crtc->state->crtc = crtc;
2211 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2214 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2215 * @crtc: CRTC object
2216 * @state: atomic CRTC state
2218 * Copies atomic state from a CRTC's current state and resets inferred values.
2219 * This is useful for drivers that subclass the CRTC state.
2221 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2222 struct drm_crtc_state *state)
2224 memcpy(state, crtc->state, sizeof(*state));
2226 if (state->mode_blob)
2227 drm_property_reference_blob(state->mode_blob);
2228 state->mode_changed = false;
2229 state->active_changed = false;
2230 state->planes_changed = false;
2231 state->connectors_changed = false;
2232 state->event = NULL;
2234 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2237 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2240 * Default CRTC state duplicate hook for drivers which don't have their own
2241 * subclassed CRTC state structure.
2243 struct drm_crtc_state *
2244 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2246 struct drm_crtc_state *state;
2248 if (WARN_ON(!crtc->state))
2251 state = kmalloc(sizeof(*state), GFP_KERNEL);
2253 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2257 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2260 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2261 * @crtc: CRTC object
2262 * @state: CRTC state object to release
2264 * Releases all resources stored in the CRTC state without actually freeing
2265 * the memory of the CRTC state. This is useful for drivers that subclass the
2268 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2269 struct drm_crtc_state *state)
2271 if (state->mode_blob)
2272 drm_property_unreference_blob(state->mode_blob);
2274 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2277 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2279 * @state: CRTC state object to release
2281 * Default CRTC state destroy hook for drivers which don't have their own
2282 * subclassed CRTC state structure.
2284 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2285 struct drm_crtc_state *state)
2287 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2290 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2293 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2296 * Resets the atomic state for @plane by freeing the state pointer (which might
2297 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2299 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2301 if (plane->state && plane->state->fb)
2302 drm_framebuffer_unreference(plane->state->fb);
2304 kfree(plane->state);
2305 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2308 plane->state->plane = plane;
2310 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2313 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2314 * @plane: plane object
2315 * @state: atomic plane state
2317 * Copies atomic state from a plane's current state. This is useful for
2318 * drivers that subclass the plane state.
2320 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2321 struct drm_plane_state *state)
2323 memcpy(state, plane->state, sizeof(*state));
2326 drm_framebuffer_reference(state->fb);
2328 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2331 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2334 * Default plane state duplicate hook for drivers which don't have their own
2335 * subclassed plane state structure.
2337 struct drm_plane_state *
2338 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2340 struct drm_plane_state *state;
2342 if (WARN_ON(!plane->state))
2345 state = kmalloc(sizeof(*state), GFP_KERNEL);
2347 __drm_atomic_helper_plane_duplicate_state(plane, state);
2351 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2354 * __drm_atomic_helper_plane_destroy_state - release plane state
2355 * @plane: plane object
2356 * @state: plane state object to release
2358 * Releases all resources stored in the plane state without actually freeing
2359 * the memory of the plane state. This is useful for drivers that subclass the
2362 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2363 struct drm_plane_state *state)
2366 drm_framebuffer_unreference(state->fb);
2368 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2371 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2373 * @state: plane state object to release
2375 * Default plane state destroy hook for drivers which don't have their own
2376 * subclassed plane state structure.
2378 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2379 struct drm_plane_state *state)
2381 __drm_atomic_helper_plane_destroy_state(plane, state);
2384 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2387 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2388 * @connector: drm connector
2390 * Resets the atomic state for @connector by freeing the state pointer (which
2391 * might be NULL, e.g. at driver load time) and allocating a new empty state
2394 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2396 kfree(connector->state);
2397 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2399 if (connector->state)
2400 connector->state->connector = connector;
2402 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2405 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2406 * @connector: connector object
2407 * @state: atomic connector state
2409 * Copies atomic state from a connector's current state. This is useful for
2410 * drivers that subclass the connector state.
2413 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2414 struct drm_connector_state *state)
2416 memcpy(state, connector->state, sizeof(*state));
2418 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2421 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2422 * @connector: drm connector
2424 * Default connector state duplicate hook for drivers which don't have their own
2425 * subclassed connector state structure.
2427 struct drm_connector_state *
2428 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2430 struct drm_connector_state *state;
2432 if (WARN_ON(!connector->state))
2435 state = kmalloc(sizeof(*state), GFP_KERNEL);
2437 __drm_atomic_helper_connector_duplicate_state(connector, state);
2441 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2444 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2446 * @ctx: lock acquisition context
2448 * Makes a copy of the current atomic state by looping over all objects and
2449 * duplicating their respective states.
2451 * Note that this treats atomic state as persistent between save and restore.
2452 * Drivers must make sure that this is possible and won't result in confusion
2453 * or erroneous behaviour.
2455 * Note that if callers haven't already acquired all modeset locks this might
2456 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2459 * A pointer to the copy of the atomic state object on success or an
2460 * ERR_PTR()-encoded error code on failure.
2462 struct drm_atomic_state *
2463 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2464 struct drm_modeset_acquire_ctx *ctx)
2466 struct drm_atomic_state *state;
2467 struct drm_connector *conn;
2468 struct drm_plane *plane;
2469 struct drm_crtc *crtc;
2472 state = drm_atomic_state_alloc(dev);
2474 return ERR_PTR(-ENOMEM);
2476 state->acquire_ctx = ctx;
2478 drm_for_each_crtc(crtc, dev) {
2479 struct drm_crtc_state *crtc_state;
2481 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2482 if (IS_ERR(crtc_state)) {
2483 err = PTR_ERR(crtc_state);
2488 drm_for_each_plane(plane, dev) {
2489 struct drm_plane_state *plane_state;
2491 plane_state = drm_atomic_get_plane_state(state, plane);
2492 if (IS_ERR(plane_state)) {
2493 err = PTR_ERR(plane_state);
2498 drm_for_each_connector(conn, dev) {
2499 struct drm_connector_state *conn_state;
2501 conn_state = drm_atomic_get_connector_state(state, conn);
2502 if (IS_ERR(conn_state)) {
2503 err = PTR_ERR(conn_state);
2508 /* clear the acquire context so that it isn't accidentally reused */
2509 state->acquire_ctx = NULL;
2513 drm_atomic_state_free(state);
2514 state = ERR_PTR(err);
2519 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2522 * __drm_atomic_helper_connector_destroy_state - release connector state
2523 * @connector: connector object
2524 * @state: connector state object to release
2526 * Releases all resources stored in the connector state without actually
2527 * freeing the memory of the connector state. This is useful for drivers that
2528 * subclass the connector state.
2531 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2532 struct drm_connector_state *state)
2535 * This is currently a placeholder so that drivers that subclass the
2536 * state will automatically do the right thing if code is ever added
2540 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2543 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2544 * @connector: drm connector
2545 * @state: connector state object to release
2547 * Default connector state destroy hook for drivers which don't have their own
2548 * subclassed connector state structure.
2550 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2551 struct drm_connector_state *state)
2553 __drm_atomic_helper_connector_destroy_state(connector, state);
2556 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);