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.
56 * The atomic helper uses the same function table structures as all other
57 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
58 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
59 * also shares the struct &drm_plane_helper_funcs function table with the plane
63 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
64 struct drm_plane_state *plane_state,
65 struct drm_plane *plane)
67 struct drm_crtc_state *crtc_state;
69 if (plane->state->crtc) {
70 crtc_state = state->crtc_states[drm_crtc_index(plane->state->crtc)];
72 if (WARN_ON(!crtc_state))
75 crtc_state->planes_changed = true;
78 if (plane_state->crtc) {
80 state->crtc_states[drm_crtc_index(plane_state->crtc)];
82 if (WARN_ON(!crtc_state))
85 crtc_state->planes_changed = true;
90 check_pending_encoder_assignment(struct drm_atomic_state *state,
91 struct drm_encoder *new_encoder)
93 struct drm_connector *connector;
94 struct drm_connector_state *conn_state;
97 for_each_connector_in_state(state, connector, conn_state, i) {
98 if (conn_state->best_encoder != new_encoder)
101 /* encoder already assigned and we're trying to re-steal it! */
102 if (connector->state->best_encoder != conn_state->best_encoder)
109 static struct drm_crtc *
110 get_current_crtc_for_encoder(struct drm_device *dev,
111 struct drm_encoder *encoder)
113 struct drm_mode_config *config = &dev->mode_config;
114 struct drm_connector *connector;
116 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
118 drm_for_each_connector(connector, dev) {
119 if (connector->state->best_encoder != encoder)
122 return connector->state->crtc;
129 steal_encoder(struct drm_atomic_state *state,
130 struct drm_encoder *encoder,
131 struct drm_crtc *encoder_crtc)
133 struct drm_mode_config *config = &state->dev->mode_config;
134 struct drm_crtc_state *crtc_state;
135 struct drm_connector *connector;
136 struct drm_connector_state *connector_state;
140 * We can only steal an encoder coming from a connector, which means we
141 * must already hold the connection_mutex.
143 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
145 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
146 encoder->base.id, encoder->name,
147 encoder_crtc->base.id, encoder_crtc->name);
149 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
150 if (IS_ERR(crtc_state))
151 return PTR_ERR(crtc_state);
153 crtc_state->connectors_changed = true;
155 list_for_each_entry(connector, &config->connector_list, head) {
156 if (connector->state->best_encoder != encoder)
159 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
163 connector_state = drm_atomic_get_connector_state(state,
165 if (IS_ERR(connector_state))
166 return PTR_ERR(connector_state);
168 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
171 connector_state->best_encoder = NULL;
178 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
180 const struct drm_connector_helper_funcs *funcs;
181 struct drm_encoder *new_encoder;
182 struct drm_crtc *encoder_crtc;
183 struct drm_connector *connector;
184 struct drm_connector_state *connector_state;
185 struct drm_crtc_state *crtc_state;
188 connector = state->connectors[conn_idx];
189 connector_state = state->connector_states[conn_idx];
194 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
198 if (connector->state->crtc != connector_state->crtc) {
199 if (connector->state->crtc) {
200 idx = drm_crtc_index(connector->state->crtc);
202 crtc_state = state->crtc_states[idx];
203 crtc_state->connectors_changed = true;
206 if (connector_state->crtc) {
207 idx = drm_crtc_index(connector_state->crtc);
209 crtc_state = state->crtc_states[idx];
210 crtc_state->connectors_changed = true;
214 if (!connector_state->crtc) {
215 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
219 connector_state->best_encoder = NULL;
224 funcs = connector->helper_private;
226 if (funcs->atomic_best_encoder)
227 new_encoder = funcs->atomic_best_encoder(connector,
230 new_encoder = funcs->best_encoder(connector);
233 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
239 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
240 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
241 new_encoder->base.id,
243 connector_state->crtc->base.id);
247 if (new_encoder == connector_state->best_encoder) {
248 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
251 new_encoder->base.id,
253 connector_state->crtc->base.id,
254 connector_state->crtc->name);
259 if (!check_pending_encoder_assignment(state, new_encoder)) {
260 DRM_DEBUG_ATOMIC("Encoder for [CONNECTOR:%d:%s] already assigned\n",
266 encoder_crtc = get_current_crtc_for_encoder(state->dev,
270 ret = steal_encoder(state, new_encoder, encoder_crtc);
272 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
279 if (WARN_ON(!connector_state->crtc))
282 connector_state->best_encoder = new_encoder;
283 idx = drm_crtc_index(connector_state->crtc);
285 crtc_state = state->crtc_states[idx];
286 crtc_state->connectors_changed = true;
288 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
291 new_encoder->base.id,
293 connector_state->crtc->base.id,
294 connector_state->crtc->name);
300 mode_fixup(struct drm_atomic_state *state)
302 struct drm_crtc *crtc;
303 struct drm_crtc_state *crtc_state;
304 struct drm_connector *connector;
305 struct drm_connector_state *conn_state;
309 for_each_crtc_in_state(state, crtc, crtc_state, i) {
310 if (!crtc_state->mode_changed &&
311 !crtc_state->connectors_changed)
314 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
317 for_each_connector_in_state(state, connector, conn_state, i) {
318 const struct drm_encoder_helper_funcs *funcs;
319 struct drm_encoder *encoder;
321 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
323 if (!conn_state->crtc || !conn_state->best_encoder)
327 state->crtc_states[drm_crtc_index(conn_state->crtc)];
330 * Each encoder has at most one connector (since we always steal
331 * it away), so we won't call ->mode_fixup twice.
333 encoder = conn_state->best_encoder;
334 funcs = encoder->helper_private;
338 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
339 &crtc_state->adjusted_mode);
341 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
345 if (funcs->atomic_check) {
346 ret = funcs->atomic_check(encoder, crtc_state,
349 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
350 encoder->base.id, encoder->name);
353 } else if (funcs->mode_fixup) {
354 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
355 &crtc_state->adjusted_mode);
357 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
358 encoder->base.id, encoder->name);
364 for_each_crtc_in_state(state, crtc, crtc_state, i) {
365 const struct drm_crtc_helper_funcs *funcs;
367 if (!crtc_state->mode_changed &&
368 !crtc_state->connectors_changed)
371 funcs = crtc->helper_private;
372 if (!funcs->mode_fixup)
375 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
376 &crtc_state->adjusted_mode);
378 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
379 crtc->base.id, crtc->name);
388 * drm_atomic_helper_check_modeset - validate state object for modeset changes
390 * @state: the driver state object
392 * Check the state object to see if the requested state is physically possible.
393 * This does all the crtc and connector related computations for an atomic
394 * update and adds any additional connectors needed for full modesets and calls
395 * down into ->mode_fixup functions of the driver backend.
397 * crtc_state->mode_changed is set when the input mode is changed.
398 * crtc_state->connectors_changed is set when a connector is added or
399 * removed from the crtc.
400 * crtc_state->active_changed is set when crtc_state->active changes,
401 * which is used for dpms.
405 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
406 * plane update can't be done without a full modeset) _must_ call this function
407 * afterwards after that change. It is permitted to call this function multiple
408 * times for the same update, e.g. when the ->atomic_check functions depend upon
409 * the adjusted dotclock for fifo space allocation and watermark computation.
412 * Zero for success or -errno
415 drm_atomic_helper_check_modeset(struct drm_device *dev,
416 struct drm_atomic_state *state)
418 struct drm_crtc *crtc;
419 struct drm_crtc_state *crtc_state;
420 struct drm_connector *connector;
421 struct drm_connector_state *connector_state;
424 for_each_crtc_in_state(state, crtc, crtc_state, i) {
425 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
426 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
427 crtc->base.id, crtc->name);
428 crtc_state->mode_changed = true;
431 if (crtc->state->enable != crtc_state->enable) {
432 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
433 crtc->base.id, crtc->name);
436 * For clarity this assignment is done here, but
437 * enable == 0 is only true when there are no
438 * connectors and a NULL mode.
440 * The other way around is true as well. enable != 0
441 * iff connectors are attached and a mode is set.
443 crtc_state->mode_changed = true;
444 crtc_state->connectors_changed = true;
448 for_each_connector_in_state(state, connector, connector_state, i) {
450 * This only sets crtc->mode_changed for routing changes,
451 * drivers must set crtc->mode_changed themselves when connector
452 * properties need to be updated.
454 ret = update_connector_routing(state, i);
460 * After all the routing has been prepared we need to add in any
461 * connector which is itself unchanged, but who's crtc changes it's
462 * configuration. This must be done before calling mode_fixup in case a
463 * crtc only changed its mode but has the same set of connectors.
465 for_each_crtc_in_state(state, crtc, crtc_state, i) {
466 bool has_connectors =
467 !!crtc_state->connector_mask;
470 * We must set ->active_changed after walking connectors for
471 * otherwise an update that only changes active would result in
472 * a full modeset because update_connector_routing force that.
474 if (crtc->state->active != crtc_state->active) {
475 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
476 crtc->base.id, crtc->name);
477 crtc_state->active_changed = true;
480 if (!drm_atomic_crtc_needs_modeset(crtc_state))
483 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
484 crtc->base.id, crtc->name,
485 crtc_state->enable ? 'y' : 'n',
486 crtc_state->active ? 'y' : 'n');
488 ret = drm_atomic_add_affected_connectors(state, crtc);
492 ret = drm_atomic_add_affected_planes(state, crtc);
496 if (crtc_state->enable != has_connectors) {
497 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
498 crtc->base.id, crtc->name);
504 return mode_fixup(state);
506 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
509 * drm_atomic_helper_check_planes - validate state object for planes changes
511 * @state: the driver state object
513 * Check the state object to see if the requested state is physically possible.
514 * This does all the plane update related checks using by calling into the
515 * ->atomic_check hooks provided by the driver.
517 * It also sets crtc_state->planes_changed to indicate that a crtc has
521 * Zero for success or -errno
524 drm_atomic_helper_check_planes(struct drm_device *dev,
525 struct drm_atomic_state *state)
527 struct drm_crtc *crtc;
528 struct drm_crtc_state *crtc_state;
529 struct drm_plane *plane;
530 struct drm_plane_state *plane_state;
533 for_each_plane_in_state(state, plane, plane_state, i) {
534 const struct drm_plane_helper_funcs *funcs;
536 funcs = plane->helper_private;
538 drm_atomic_helper_plane_changed(state, plane_state, plane);
540 if (!funcs || !funcs->atomic_check)
543 ret = funcs->atomic_check(plane, plane_state);
545 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
546 plane->base.id, plane->name);
551 for_each_crtc_in_state(state, crtc, crtc_state, i) {
552 const struct drm_crtc_helper_funcs *funcs;
554 funcs = crtc->helper_private;
556 if (!funcs || !funcs->atomic_check)
559 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
561 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
562 crtc->base.id, crtc->name);
569 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
572 * drm_atomic_helper_check - validate state object
574 * @state: the driver state object
576 * Check the state object to see if the requested state is physically possible.
577 * Only crtcs and planes have check callbacks, so for any additional (global)
578 * checking that a driver needs it can simply wrap that around this function.
579 * Drivers without such needs can directly use this as their ->atomic_check()
582 * This just wraps the two parts of the state checking for planes and modeset
583 * state in the default order: First it calls drm_atomic_helper_check_modeset()
584 * and then drm_atomic_helper_check_planes(). The assumption is that the
585 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
586 * e.g. properly compute watermarks.
589 * Zero for success or -errno
591 int drm_atomic_helper_check(struct drm_device *dev,
592 struct drm_atomic_state *state)
596 ret = drm_atomic_helper_check_modeset(dev, state);
600 ret = drm_atomic_helper_check_planes(dev, state);
606 EXPORT_SYMBOL(drm_atomic_helper_check);
609 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
611 struct drm_connector *connector;
612 struct drm_connector_state *old_conn_state;
613 struct drm_crtc *crtc;
614 struct drm_crtc_state *old_crtc_state;
617 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
618 const struct drm_encoder_helper_funcs *funcs;
619 struct drm_encoder *encoder;
620 struct drm_crtc_state *old_crtc_state;
622 /* Shut down everything that's in the changeset and currently
623 * still on. So need to check the old, saved state. */
624 if (!old_conn_state->crtc)
627 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
629 if (!old_crtc_state->active ||
630 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
633 encoder = old_conn_state->best_encoder;
635 /* We shouldn't get this far if we didn't previously have
636 * an encoder.. but WARN_ON() rather than explode.
638 if (WARN_ON(!encoder))
641 funcs = encoder->helper_private;
643 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
644 encoder->base.id, encoder->name);
647 * Each encoder has at most one connector (since we always steal
648 * it away), so we won't call disable hooks twice.
650 drm_bridge_disable(encoder->bridge);
652 /* Right function depends upon target state. */
653 if (connector->state->crtc && funcs->prepare)
654 funcs->prepare(encoder);
655 else if (funcs->disable)
656 funcs->disable(encoder);
658 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
660 drm_bridge_post_disable(encoder->bridge);
663 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
664 const struct drm_crtc_helper_funcs *funcs;
666 /* Shut down everything that needs a full modeset. */
667 if (!drm_atomic_crtc_needs_modeset(crtc->state))
670 if (!old_crtc_state->active)
673 funcs = crtc->helper_private;
675 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
676 crtc->base.id, crtc->name);
679 /* Right function depends upon target state. */
680 if (crtc->state->enable && funcs->prepare)
681 funcs->prepare(crtc);
682 else if (funcs->disable)
683 funcs->disable(crtc);
685 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
690 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
692 * @old_state: atomic state object with old state structures
694 * This function updates all the various legacy modeset state pointers in
695 * connectors, encoders and crtcs. It also updates the timestamping constants
696 * used for precise vblank timestamps by calling
697 * drm_calc_timestamping_constants().
699 * Drivers can use this for building their own atomic commit if they don't have
700 * a pure helper-based modeset implementation.
703 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
704 struct drm_atomic_state *old_state)
706 struct drm_connector *connector;
707 struct drm_connector_state *old_conn_state;
708 struct drm_crtc *crtc;
709 struct drm_crtc_state *old_crtc_state;
712 /* clear out existing links and update dpms */
713 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
714 if (connector->encoder) {
715 WARN_ON(!connector->encoder->crtc);
717 connector->encoder->crtc = NULL;
718 connector->encoder = NULL;
721 crtc = connector->state->crtc;
722 if ((!crtc && old_conn_state->crtc) ||
723 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
724 struct drm_property *dpms_prop =
725 dev->mode_config.dpms_property;
726 int mode = DRM_MODE_DPMS_OFF;
728 if (crtc && crtc->state->active)
729 mode = DRM_MODE_DPMS_ON;
731 connector->dpms = mode;
732 drm_object_property_set_value(&connector->base,
738 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
739 if (!connector->state->crtc)
742 if (WARN_ON(!connector->state->best_encoder))
745 connector->encoder = connector->state->best_encoder;
746 connector->encoder->crtc = connector->state->crtc;
749 /* set legacy state in the crtc structure */
750 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
751 struct drm_plane *primary = crtc->primary;
753 crtc->mode = crtc->state->mode;
754 crtc->enabled = crtc->state->enable;
756 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
757 primary->state->crtc == crtc) {
758 crtc->x = primary->state->src_x >> 16;
759 crtc->y = primary->state->src_y >> 16;
762 if (crtc->state->enable)
763 drm_calc_timestamping_constants(crtc,
764 &crtc->state->adjusted_mode);
767 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
770 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
772 struct drm_crtc *crtc;
773 struct drm_crtc_state *old_crtc_state;
774 struct drm_connector *connector;
775 struct drm_connector_state *old_conn_state;
778 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
779 const struct drm_crtc_helper_funcs *funcs;
781 if (!crtc->state->mode_changed)
784 funcs = crtc->helper_private;
786 if (crtc->state->enable && funcs->mode_set_nofb) {
787 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
788 crtc->base.id, crtc->name);
790 funcs->mode_set_nofb(crtc);
794 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
795 const struct drm_encoder_helper_funcs *funcs;
796 struct drm_crtc_state *new_crtc_state;
797 struct drm_encoder *encoder;
798 struct drm_display_mode *mode, *adjusted_mode;
800 if (!connector->state->best_encoder)
803 encoder = connector->state->best_encoder;
804 funcs = encoder->helper_private;
805 new_crtc_state = connector->state->crtc->state;
806 mode = &new_crtc_state->mode;
807 adjusted_mode = &new_crtc_state->adjusted_mode;
809 if (!new_crtc_state->mode_changed)
812 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
813 encoder->base.id, encoder->name);
816 * Each encoder has at most one connector (since we always steal
817 * it away), so we won't call mode_set hooks twice.
820 funcs->mode_set(encoder, mode, adjusted_mode);
822 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
827 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
829 * @old_state: atomic state object with old state structures
831 * This function shuts down all the outputs that need to be shut down and
832 * prepares them (if required) with the new mode.
834 * For compatibility with legacy crtc helpers this should be called before
835 * drm_atomic_helper_commit_planes(), which is what the default commit function
836 * does. But drivers with different needs can group the modeset commits together
837 * and do the plane commits at the end. This is useful for drivers doing runtime
838 * PM since planes updates then only happen when the CRTC is actually enabled.
840 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
841 struct drm_atomic_state *old_state)
843 disable_outputs(dev, old_state);
845 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
847 crtc_set_mode(dev, old_state);
849 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
852 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
854 * @old_state: atomic state object with old state structures
856 * This function enables all the outputs with the new configuration which had to
857 * be turned off for the update.
859 * For compatibility with legacy crtc helpers this should be called after
860 * drm_atomic_helper_commit_planes(), which is what the default commit function
861 * does. But drivers with different needs can group the modeset commits together
862 * and do the plane commits at the end. This is useful for drivers doing runtime
863 * PM since planes updates then only happen when the CRTC is actually enabled.
865 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
866 struct drm_atomic_state *old_state)
868 struct drm_crtc *crtc;
869 struct drm_crtc_state *old_crtc_state;
870 struct drm_connector *connector;
871 struct drm_connector_state *old_conn_state;
874 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
875 const struct drm_crtc_helper_funcs *funcs;
877 /* Need to filter out CRTCs where only planes change. */
878 if (!drm_atomic_crtc_needs_modeset(crtc->state))
881 if (!crtc->state->active)
884 funcs = crtc->helper_private;
886 if (crtc->state->enable) {
887 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
888 crtc->base.id, crtc->name);
897 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
898 const struct drm_encoder_helper_funcs *funcs;
899 struct drm_encoder *encoder;
901 if (!connector->state->best_encoder)
904 if (!connector->state->crtc->state->active ||
905 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
908 encoder = connector->state->best_encoder;
909 funcs = encoder->helper_private;
911 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
912 encoder->base.id, encoder->name);
915 * Each encoder has at most one connector (since we always steal
916 * it away), so we won't call enable hooks twice.
918 drm_bridge_pre_enable(encoder->bridge);
921 funcs->enable(encoder);
923 funcs->commit(encoder);
925 drm_bridge_enable(encoder->bridge);
928 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
930 static void wait_for_fences(struct drm_device *dev,
931 struct drm_atomic_state *state)
933 struct drm_plane *plane;
934 struct drm_plane_state *plane_state;
937 for_each_plane_in_state(state, plane, plane_state, i) {
938 if (!plane->state->fence)
941 WARN_ON(!plane->state->fb);
943 fence_wait(plane->state->fence, false);
944 fence_put(plane->state->fence);
945 plane->state->fence = NULL;
950 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
952 * @old_state: atomic state object with old state structures
955 * Checks whether the framebuffer used for this CRTC changes as a result of
956 * the atomic update. This is useful for drivers which cannot use
957 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
961 * true if the framebuffer changed.
963 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
964 struct drm_atomic_state *old_state,
965 struct drm_crtc *crtc)
967 struct drm_plane *plane;
968 struct drm_plane_state *old_plane_state;
971 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
972 if (plane->state->crtc != crtc &&
973 old_plane_state->crtc != crtc)
976 if (plane->state->fb != old_plane_state->fb)
982 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
985 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
987 * @old_state: atomic state object with old state structures
989 * Helper to, after atomic commit, wait for vblanks on all effected
990 * crtcs (ie. before cleaning up old framebuffers using
991 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
992 * framebuffers have actually changed to optimize for the legacy cursor and
993 * plane update use-case.
996 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
997 struct drm_atomic_state *old_state)
999 struct drm_crtc *crtc;
1000 struct drm_crtc_state *old_crtc_state;
1003 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1004 /* No one cares about the old state, so abuse it for tracking
1005 * and store whether we hold a vblank reference (and should do a
1006 * vblank wait) in the ->enable boolean. */
1007 old_crtc_state->enable = false;
1009 if (!crtc->state->enable)
1012 /* Legacy cursor ioctls are completely unsynced, and userspace
1013 * relies on that (by doing tons of cursor updates). */
1014 if (old_state->legacy_cursor_update)
1017 if (!drm_atomic_helper_framebuffer_changed(dev,
1021 ret = drm_crtc_vblank_get(crtc);
1025 old_crtc_state->enable = true;
1026 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1029 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1030 if (!old_crtc_state->enable)
1033 ret = wait_event_timeout(dev->vblank[i].queue,
1034 old_crtc_state->last_vblank_count !=
1035 drm_crtc_vblank_count(crtc),
1036 msecs_to_jiffies(50));
1038 drm_crtc_vblank_put(crtc);
1041 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1044 * drm_atomic_helper_commit - commit validated state object
1046 * @state: the driver state object
1047 * @async: asynchronous commit
1049 * This function commits a with drm_atomic_helper_check() pre-validated state
1050 * object. This can still fail when e.g. the framebuffer reservation fails. For
1051 * now this doesn't implement asynchronous commits.
1053 * Note that right now this function does not support async commits, and hence
1054 * driver writers must implement their own version for now. Also note that the
1055 * default ordering of how the various stages are called is to match the legacy
1056 * modeset helper library closest. One peculiarity of that is that it doesn't
1057 * mesh well with runtime PM at all.
1059 * For drivers supporting runtime PM the recommended sequence is
1061 * drm_atomic_helper_commit_modeset_disables(dev, state);
1063 * drm_atomic_helper_commit_modeset_enables(dev, state);
1065 * drm_atomic_helper_commit_planes(dev, state, true);
1067 * See the kerneldoc entries for these three functions for more details.
1070 * Zero for success or -errno.
1072 int drm_atomic_helper_commit(struct drm_device *dev,
1073 struct drm_atomic_state *state,
1081 ret = drm_atomic_helper_prepare_planes(dev, state);
1086 * This is the point of no return - everything below never fails except
1087 * when the hw goes bonghits. Which means we can commit the new state on
1088 * the software side now.
1091 drm_atomic_helper_swap_state(dev, state);
1094 * Everything below can be run asynchronously without the need to grab
1095 * any modeset locks at all under one condition: It must be guaranteed
1096 * that the asynchronous work has either been cancelled (if the driver
1097 * supports it, which at least requires that the framebuffers get
1098 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1099 * before the new state gets committed on the software side with
1100 * drm_atomic_helper_swap_state().
1102 * This scheme allows new atomic state updates to be prepared and
1103 * checked in parallel to the asynchronous completion of the previous
1104 * update. Which is important since compositors need to figure out the
1105 * composition of the next frame right after having submitted the
1109 wait_for_fences(dev, state);
1111 drm_atomic_helper_commit_modeset_disables(dev, state);
1113 drm_atomic_helper_commit_planes(dev, state, false);
1115 drm_atomic_helper_commit_modeset_enables(dev, state);
1117 drm_atomic_helper_wait_for_vblanks(dev, state);
1119 drm_atomic_helper_cleanup_planes(dev, state);
1121 drm_atomic_state_free(state);
1125 EXPORT_SYMBOL(drm_atomic_helper_commit);
1128 * DOC: implementing async commit
1130 * For now the atomic helpers don't support async commit directly. If there is
1131 * real need it could be added though, using the dma-buf fence infrastructure
1132 * for generic synchronization with outstanding rendering.
1134 * For now drivers have to implement async commit themselves, with the following
1135 * sequence being the recommended one:
1137 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1138 * which commit needs to call which can fail, so we want to run it first and
1141 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1142 * might be affected the new state update. This can be done by either cancelling
1143 * or flushing the work items, depending upon whether the driver can deal with
1144 * cancelled updates. Note that it is important to ensure that the framebuffer
1145 * cleanup is still done when cancelling.
1147 * For sufficient parallelism it is recommended to have a work item per crtc
1148 * (for updates which don't touch global state) and a global one. Then we only
1149 * need to synchronize with the crtc work items for changed crtcs and the global
1150 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1152 * 3. The software state is updated synchronously with
1153 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1154 * locks means concurrent callers never see inconsistent state. And doing this
1155 * while it's guaranteed that no relevant async worker runs means that async
1156 * workers do not need grab any locks. Actually they must not grab locks, for
1157 * otherwise the work flushing will deadlock.
1159 * 4. Schedule a work item to do all subsequent steps, using the split-out
1160 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1161 * then cleaning up the framebuffers after the old framebuffer is no longer
1166 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1168 * @state: atomic state object with new state structures
1170 * This function prepares plane state, specifically framebuffers, for the new
1171 * configuration. If any failure is encountered this function will call
1172 * ->cleanup_fb on any already successfully prepared framebuffer.
1175 * 0 on success, negative error code on failure.
1177 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1178 struct drm_atomic_state *state)
1180 int nplanes = dev->mode_config.num_total_plane;
1183 for (i = 0; i < nplanes; i++) {
1184 const struct drm_plane_helper_funcs *funcs;
1185 struct drm_plane *plane = state->planes[i];
1186 struct drm_plane_state *plane_state = state->plane_states[i];
1191 funcs = plane->helper_private;
1193 if (funcs->prepare_fb) {
1194 ret = funcs->prepare_fb(plane, plane_state);
1203 for (i--; i >= 0; i--) {
1204 const struct drm_plane_helper_funcs *funcs;
1205 struct drm_plane *plane = state->planes[i];
1206 struct drm_plane_state *plane_state = state->plane_states[i];
1211 funcs = plane->helper_private;
1213 if (funcs->cleanup_fb)
1214 funcs->cleanup_fb(plane, plane_state);
1220 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1222 bool plane_crtc_active(struct drm_plane_state *state)
1224 return state->crtc && state->crtc->state->active;
1228 * drm_atomic_helper_commit_planes - commit plane state
1230 * @old_state: atomic state object with old state structures
1231 * @active_only: Only commit on active CRTC if set
1233 * This function commits the new plane state using the plane and atomic helper
1234 * functions for planes and crtcs. It assumes that the atomic state has already
1235 * been pushed into the relevant object state pointers, since this step can no
1238 * It still requires the global state object @old_state to know which planes and
1239 * crtcs need to be updated though.
1241 * Note that this function does all plane updates across all CRTCs in one step.
1242 * If the hardware can't support this approach look at
1243 * drm_atomic_helper_commit_planes_on_crtc() instead.
1245 * Plane parameters can be updated by applications while the associated CRTC is
1246 * disabled. The DRM/KMS core will store the parameters in the plane state,
1247 * which will be available to the driver when the CRTC is turned on. As a result
1248 * most drivers don't need to be immediately notified of plane updates for a
1251 * Unless otherwise needed, drivers are advised to set the @active_only
1252 * parameters to true in order not to receive plane update notifications related
1253 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1254 * driver code when the driver and/or hardware can't or just don't need to deal
1255 * with updates on disabled CRTCs, for example when supporting runtime PM.
1257 * The drm_atomic_helper_commit() default implementation only sets @active_only
1258 * to false to most closely match the behaviour of the legacy helpers. This should
1259 * not be copied blindly by drivers.
1261 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1262 struct drm_atomic_state *old_state,
1265 struct drm_crtc *crtc;
1266 struct drm_crtc_state *old_crtc_state;
1267 struct drm_plane *plane;
1268 struct drm_plane_state *old_plane_state;
1271 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1272 const struct drm_crtc_helper_funcs *funcs;
1274 funcs = crtc->helper_private;
1276 if (!funcs || !funcs->atomic_begin)
1279 if (active_only && !crtc->state->active)
1282 funcs->atomic_begin(crtc, old_crtc_state);
1285 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1286 const struct drm_plane_helper_funcs *funcs;
1289 funcs = plane->helper_private;
1294 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1298 * Skip planes related to inactive CRTCs. If the plane
1299 * is enabled use the state of the current CRTC. If the
1300 * plane is being disabled use the state of the old
1301 * CRTC to avoid skipping planes being disabled on an
1304 if (!disabling && !plane_crtc_active(plane->state))
1306 if (disabling && !plane_crtc_active(old_plane_state))
1311 * Special-case disabling the plane if drivers support it.
1313 if (disabling && funcs->atomic_disable)
1314 funcs->atomic_disable(plane, old_plane_state);
1315 else if (plane->state->crtc || disabling)
1316 funcs->atomic_update(plane, old_plane_state);
1319 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1320 const struct drm_crtc_helper_funcs *funcs;
1322 funcs = crtc->helper_private;
1324 if (!funcs || !funcs->atomic_flush)
1327 if (active_only && !crtc->state->active)
1330 funcs->atomic_flush(crtc, old_crtc_state);
1333 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1336 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1337 * @old_crtc_state: atomic state object with the old crtc state
1339 * This function commits the new plane state using the plane and atomic helper
1340 * functions for planes on the specific crtc. It assumes that the atomic state
1341 * has already been pushed into the relevant object state pointers, since this
1342 * step can no longer fail.
1344 * This function is useful when plane updates should be done crtc-by-crtc
1345 * instead of one global step like drm_atomic_helper_commit_planes() does.
1347 * This function can only be savely used when planes are not allowed to move
1348 * between different CRTCs because this function doesn't handle inter-CRTC
1349 * depencies. Callers need to ensure that either no such depencies exist,
1350 * resolve them through ordering of commit calls or through some other means.
1353 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1355 const struct drm_crtc_helper_funcs *crtc_funcs;
1356 struct drm_crtc *crtc = old_crtc_state->crtc;
1357 struct drm_atomic_state *old_state = old_crtc_state->state;
1358 struct drm_plane *plane;
1359 unsigned plane_mask;
1361 plane_mask = old_crtc_state->plane_mask;
1362 plane_mask |= crtc->state->plane_mask;
1364 crtc_funcs = crtc->helper_private;
1365 if (crtc_funcs && crtc_funcs->atomic_begin)
1366 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1368 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1369 struct drm_plane_state *old_plane_state =
1370 drm_atomic_get_existing_plane_state(old_state, plane);
1371 const struct drm_plane_helper_funcs *plane_funcs;
1373 plane_funcs = plane->helper_private;
1375 if (!old_plane_state || !plane_funcs)
1378 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1380 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1381 plane_funcs->atomic_disable)
1382 plane_funcs->atomic_disable(plane, old_plane_state);
1383 else if (plane->state->crtc ||
1384 drm_atomic_plane_disabling(plane, old_plane_state))
1385 plane_funcs->atomic_update(plane, old_plane_state);
1388 if (crtc_funcs && crtc_funcs->atomic_flush)
1389 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1391 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1394 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1396 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1398 * Disables all planes associated with the given CRTC. This can be
1399 * used for instance in the CRTC helper disable callback to disable
1400 * all planes before shutting down the display pipeline.
1402 * If the atomic-parameter is set the function calls the CRTC's
1403 * atomic_begin hook before and atomic_flush hook after disabling the
1406 * It is a bug to call this function without having implemented the
1407 * ->atomic_disable() plane hook.
1409 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1412 const struct drm_crtc_helper_funcs *crtc_funcs =
1413 crtc->helper_private;
1414 struct drm_plane *plane;
1416 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1417 crtc_funcs->atomic_begin(crtc, NULL);
1419 drm_for_each_plane(plane, crtc->dev) {
1420 const struct drm_plane_helper_funcs *plane_funcs =
1421 plane->helper_private;
1423 if (plane->state->crtc != crtc || !plane_funcs)
1426 WARN_ON(!plane_funcs->atomic_disable);
1427 if (plane_funcs->atomic_disable)
1428 plane_funcs->atomic_disable(plane, NULL);
1431 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1432 crtc_funcs->atomic_flush(crtc, NULL);
1434 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1437 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1439 * @old_state: atomic state object with old state structures
1441 * This function cleans up plane state, specifically framebuffers, from the old
1442 * configuration. Hence the old configuration must be perserved in @old_state to
1443 * be able to call this function.
1445 * This function must also be called on the new state when the atomic update
1446 * fails at any point after calling drm_atomic_helper_prepare_planes().
1448 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1449 struct drm_atomic_state *old_state)
1451 struct drm_plane *plane;
1452 struct drm_plane_state *plane_state;
1455 for_each_plane_in_state(old_state, plane, plane_state, i) {
1456 const struct drm_plane_helper_funcs *funcs;
1458 funcs = plane->helper_private;
1460 if (funcs->cleanup_fb)
1461 funcs->cleanup_fb(plane, plane_state);
1464 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1467 * drm_atomic_helper_swap_state - store atomic state into current sw state
1469 * @state: atomic state
1471 * This function stores the atomic state into the current state pointers in all
1472 * driver objects. It should be called after all failing steps have been done
1473 * and succeeded, but before the actual hardware state is committed.
1475 * For cleanup and error recovery the current state for all changed objects will
1476 * be swaped into @state.
1478 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1480 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1482 * 2. Do any other steps that might fail.
1484 * 3. Put the staged state into the current state pointers with this function.
1486 * 4. Actually commit the hardware state.
1488 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1489 * contains the old state. Also do any other cleanup required with that state.
1491 void drm_atomic_helper_swap_state(struct drm_device *dev,
1492 struct drm_atomic_state *state)
1496 for (i = 0; i < dev->mode_config.num_connector; i++) {
1497 struct drm_connector *connector = state->connectors[i];
1502 connector->state->state = state;
1503 swap(state->connector_states[i], connector->state);
1504 connector->state->state = NULL;
1507 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1508 struct drm_crtc *crtc = state->crtcs[i];
1513 crtc->state->state = state;
1514 swap(state->crtc_states[i], crtc->state);
1515 crtc->state->state = NULL;
1518 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1519 struct drm_plane *plane = state->planes[i];
1524 plane->state->state = state;
1525 swap(state->plane_states[i], plane->state);
1526 plane->state->state = NULL;
1529 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1532 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1533 * @plane: plane object to update
1534 * @crtc: owning CRTC of owning plane
1535 * @fb: framebuffer to flip onto plane
1536 * @crtc_x: x offset of primary plane on crtc
1537 * @crtc_y: y offset of primary plane on crtc
1538 * @crtc_w: width of primary plane rectangle on crtc
1539 * @crtc_h: height of primary plane rectangle on crtc
1540 * @src_x: x offset of @fb for panning
1541 * @src_y: y offset of @fb for panning
1542 * @src_w: width of source rectangle in @fb
1543 * @src_h: height of source rectangle in @fb
1545 * Provides a default plane update handler using the atomic driver interface.
1548 * Zero on success, error code on failure
1550 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1551 struct drm_crtc *crtc,
1552 struct drm_framebuffer *fb,
1553 int crtc_x, int crtc_y,
1554 unsigned int crtc_w, unsigned int crtc_h,
1555 uint32_t src_x, uint32_t src_y,
1556 uint32_t src_w, uint32_t src_h)
1558 struct drm_atomic_state *state;
1559 struct drm_plane_state *plane_state;
1562 state = drm_atomic_state_alloc(plane->dev);
1566 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1568 plane_state = drm_atomic_get_plane_state(state, plane);
1569 if (IS_ERR(plane_state)) {
1570 ret = PTR_ERR(plane_state);
1574 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1577 drm_atomic_set_fb_for_plane(plane_state, fb);
1578 plane_state->crtc_x = crtc_x;
1579 plane_state->crtc_y = crtc_y;
1580 plane_state->crtc_w = crtc_w;
1581 plane_state->crtc_h = crtc_h;
1582 plane_state->src_x = src_x;
1583 plane_state->src_y = src_y;
1584 plane_state->src_w = src_w;
1585 plane_state->src_h = src_h;
1587 if (plane == crtc->cursor)
1588 state->legacy_cursor_update = true;
1590 ret = drm_atomic_commit(state);
1594 /* Driver takes ownership of state on successful commit. */
1597 if (ret == -EDEADLK)
1600 drm_atomic_state_free(state);
1604 drm_atomic_state_clear(state);
1605 drm_atomic_legacy_backoff(state);
1608 * Someone might have exchanged the framebuffer while we dropped locks
1609 * in the backoff code. We need to fix up the fb refcount tracking the
1612 plane->old_fb = plane->fb;
1616 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1619 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1620 * @plane: plane to disable
1622 * Provides a default plane disable handler using the atomic driver interface.
1625 * Zero on success, error code on failure
1627 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1629 struct drm_atomic_state *state;
1630 struct drm_plane_state *plane_state;
1634 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1635 * acquire context. The real fix will be to wire the acquire ctx through
1636 * everywhere we need it, but meanwhile prevent chaos by just skipping
1637 * this noop. The critical case is the cursor ioctls which a) only grab
1638 * crtc/cursor-plane locks (so we need the crtc to get at the right
1639 * acquire context) and b) can try to disable the plane multiple times.
1644 state = drm_atomic_state_alloc(plane->dev);
1648 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1650 plane_state = drm_atomic_get_plane_state(state, plane);
1651 if (IS_ERR(plane_state)) {
1652 ret = PTR_ERR(plane_state);
1656 if (plane_state->crtc && (plane == plane->crtc->cursor))
1657 plane_state->state->legacy_cursor_update = true;
1659 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1663 ret = drm_atomic_commit(state);
1667 /* Driver takes ownership of state on successful commit. */
1670 if (ret == -EDEADLK)
1673 drm_atomic_state_free(state);
1677 drm_atomic_state_clear(state);
1678 drm_atomic_legacy_backoff(state);
1681 * Someone might have exchanged the framebuffer while we dropped locks
1682 * in the backoff code. We need to fix up the fb refcount tracking the
1685 plane->old_fb = plane->fb;
1689 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1691 /* just used from fb-helper and atomic-helper: */
1692 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1693 struct drm_plane_state *plane_state)
1697 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1701 drm_atomic_set_fb_for_plane(plane_state, NULL);
1702 plane_state->crtc_x = 0;
1703 plane_state->crtc_y = 0;
1704 plane_state->crtc_w = 0;
1705 plane_state->crtc_h = 0;
1706 plane_state->src_x = 0;
1707 plane_state->src_y = 0;
1708 plane_state->src_w = 0;
1709 plane_state->src_h = 0;
1714 static int update_output_state(struct drm_atomic_state *state,
1715 struct drm_mode_set *set)
1717 struct drm_device *dev = set->crtc->dev;
1718 struct drm_crtc *crtc;
1719 struct drm_crtc_state *crtc_state;
1720 struct drm_connector *connector;
1721 struct drm_connector_state *conn_state;
1724 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1725 state->acquire_ctx);
1729 /* First grab all affected connector/crtc states. */
1730 for (i = 0; i < set->num_connectors; i++) {
1731 conn_state = drm_atomic_get_connector_state(state,
1732 set->connectors[i]);
1733 if (IS_ERR(conn_state))
1734 return PTR_ERR(conn_state);
1737 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1738 ret = drm_atomic_add_affected_connectors(state, crtc);
1743 /* Then recompute connector->crtc links and crtc enabling state. */
1744 for_each_connector_in_state(state, connector, conn_state, i) {
1745 if (conn_state->crtc == set->crtc) {
1746 ret = drm_atomic_set_crtc_for_connector(conn_state,
1752 for (j = 0; j < set->num_connectors; j++) {
1753 if (set->connectors[j] == connector) {
1754 ret = drm_atomic_set_crtc_for_connector(conn_state,
1763 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1764 /* Don't update ->enable for the CRTC in the set_config request,
1765 * since a mismatch would indicate a bug in the upper layers.
1766 * The actual modeset code later on will catch any
1767 * inconsistencies here. */
1768 if (crtc == set->crtc)
1771 if (!crtc_state->connector_mask) {
1772 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1777 crtc_state->active = false;
1785 * drm_atomic_helper_set_config - set a new config from userspace
1786 * @set: mode set configuration
1788 * Provides a default crtc set_config handler using the atomic driver interface.
1791 * Returns 0 on success, negative errno numbers on failure.
1793 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1795 struct drm_atomic_state *state;
1796 struct drm_crtc *crtc = set->crtc;
1799 state = drm_atomic_state_alloc(crtc->dev);
1803 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1805 ret = __drm_atomic_helper_set_config(set, state);
1809 ret = drm_atomic_commit(state);
1813 /* Driver takes ownership of state on successful commit. */
1816 if (ret == -EDEADLK)
1819 drm_atomic_state_free(state);
1823 drm_atomic_state_clear(state);
1824 drm_atomic_legacy_backoff(state);
1827 * Someone might have exchanged the framebuffer while we dropped locks
1828 * in the backoff code. We need to fix up the fb refcount tracking the
1831 crtc->primary->old_fb = crtc->primary->fb;
1835 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1837 /* just used from fb-helper and atomic-helper: */
1838 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1839 struct drm_atomic_state *state)
1841 struct drm_crtc_state *crtc_state;
1842 struct drm_plane_state *primary_state;
1843 struct drm_crtc *crtc = set->crtc;
1844 int hdisplay, vdisplay;
1847 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1848 if (IS_ERR(crtc_state))
1849 return PTR_ERR(crtc_state);
1851 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1852 if (IS_ERR(primary_state))
1853 return PTR_ERR(primary_state);
1857 WARN_ON(set->num_connectors);
1859 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1863 crtc_state->active = false;
1865 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1869 drm_atomic_set_fb_for_plane(primary_state, NULL);
1875 WARN_ON(!set->num_connectors);
1877 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1881 crtc_state->active = true;
1883 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1887 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1889 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1890 primary_state->crtc_x = 0;
1891 primary_state->crtc_y = 0;
1892 primary_state->crtc_w = hdisplay;
1893 primary_state->crtc_h = vdisplay;
1894 primary_state->src_x = set->x << 16;
1895 primary_state->src_y = set->y << 16;
1896 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1897 primary_state->src_w = vdisplay << 16;
1898 primary_state->src_h = hdisplay << 16;
1900 primary_state->src_w = hdisplay << 16;
1901 primary_state->src_h = vdisplay << 16;
1905 ret = update_output_state(state, set);
1913 * drm_atomic_helper_disable_all - disable all currently active outputs
1915 * @ctx: lock acquisition context
1917 * Loops through all connectors, finding those that aren't turned off and then
1918 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1919 * that they are connected to.
1921 * This is used for example in suspend/resume to disable all currently active
1922 * functions when suspending.
1924 * Note that if callers haven't already acquired all modeset locks this might
1925 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1928 * 0 on success or a negative error code on failure.
1931 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1933 int drm_atomic_helper_disable_all(struct drm_device *dev,
1934 struct drm_modeset_acquire_ctx *ctx)
1936 struct drm_atomic_state *state;
1937 struct drm_connector *conn;
1940 state = drm_atomic_state_alloc(dev);
1944 state->acquire_ctx = ctx;
1946 drm_for_each_connector(conn, dev) {
1947 struct drm_crtc *crtc = conn->state->crtc;
1948 struct drm_crtc_state *crtc_state;
1950 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
1953 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1954 if (IS_ERR(crtc_state)) {
1955 err = PTR_ERR(crtc_state);
1959 crtc_state->active = false;
1962 err = drm_atomic_commit(state);
1966 drm_atomic_state_free(state);
1970 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
1973 * drm_atomic_helper_suspend - subsystem-level suspend helper
1976 * Duplicates the current atomic state, disables all active outputs and then
1977 * returns a pointer to the original atomic state to the caller. Drivers can
1978 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
1979 * restore the output configuration that was active at the time the system
1982 * Note that it is potentially unsafe to use this. The atomic state object
1983 * returned by this function is assumed to be persistent. Drivers must ensure
1984 * that this holds true. Before calling this function, drivers must make sure
1985 * to suspend fbdev emulation so that nothing can be using the device.
1988 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
1989 * encoded error code on failure. Drivers should store the returned atomic
1990 * state object and pass it to the drm_atomic_helper_resume() helper upon
1994 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
1995 * drm_atomic_helper_resume()
1997 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
1999 struct drm_modeset_acquire_ctx ctx;
2000 struct drm_atomic_state *state;
2003 drm_modeset_acquire_init(&ctx, 0);
2006 err = drm_modeset_lock_all_ctx(dev, &ctx);
2008 state = ERR_PTR(err);
2012 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2016 err = drm_atomic_helper_disable_all(dev, &ctx);
2018 drm_atomic_state_free(state);
2019 state = ERR_PTR(err);
2024 if (PTR_ERR(state) == -EDEADLK) {
2025 drm_modeset_backoff(&ctx);
2029 drm_modeset_drop_locks(&ctx);
2030 drm_modeset_acquire_fini(&ctx);
2033 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2036 * drm_atomic_helper_resume - subsystem-level resume helper
2038 * @state: atomic state to resume to
2040 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2041 * grabs all modeset locks and commits the atomic state object. This can be
2042 * used in conjunction with the drm_atomic_helper_suspend() helper to
2043 * implement suspend/resume for drivers that support atomic mode-setting.
2046 * 0 on success or a negative error code on failure.
2049 * drm_atomic_helper_suspend()
2051 int drm_atomic_helper_resume(struct drm_device *dev,
2052 struct drm_atomic_state *state)
2054 struct drm_mode_config *config = &dev->mode_config;
2057 drm_mode_config_reset(dev);
2058 drm_modeset_lock_all(dev);
2059 state->acquire_ctx = config->acquire_ctx;
2060 err = drm_atomic_commit(state);
2061 drm_modeset_unlock_all(dev);
2065 EXPORT_SYMBOL(drm_atomic_helper_resume);
2068 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2070 * @property: DRM property
2071 * @val: value of property
2073 * Provides a default crtc set_property handler using the atomic driver
2077 * Zero on success, error code on failure
2080 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2081 struct drm_property *property,
2084 struct drm_atomic_state *state;
2085 struct drm_crtc_state *crtc_state;
2088 state = drm_atomic_state_alloc(crtc->dev);
2092 /* ->set_property is always called with all locks held. */
2093 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2095 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2096 if (IS_ERR(crtc_state)) {
2097 ret = PTR_ERR(crtc_state);
2101 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2106 ret = drm_atomic_commit(state);
2110 /* Driver takes ownership of state on successful commit. */
2113 if (ret == -EDEADLK)
2116 drm_atomic_state_free(state);
2120 drm_atomic_state_clear(state);
2121 drm_atomic_legacy_backoff(state);
2125 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2128 * drm_atomic_helper_plane_set_property - helper for plane properties
2130 * @property: DRM property
2131 * @val: value of property
2133 * Provides a default plane set_property handler using the atomic driver
2137 * Zero on success, error code on failure
2140 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2141 struct drm_property *property,
2144 struct drm_atomic_state *state;
2145 struct drm_plane_state *plane_state;
2148 state = drm_atomic_state_alloc(plane->dev);
2152 /* ->set_property is always called with all locks held. */
2153 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2155 plane_state = drm_atomic_get_plane_state(state, plane);
2156 if (IS_ERR(plane_state)) {
2157 ret = PTR_ERR(plane_state);
2161 ret = drm_atomic_plane_set_property(plane, plane_state,
2166 ret = drm_atomic_commit(state);
2170 /* Driver takes ownership of state on successful commit. */
2173 if (ret == -EDEADLK)
2176 drm_atomic_state_free(state);
2180 drm_atomic_state_clear(state);
2181 drm_atomic_legacy_backoff(state);
2185 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2188 * drm_atomic_helper_connector_set_property - helper for connector properties
2189 * @connector: DRM connector
2190 * @property: DRM property
2191 * @val: value of property
2193 * Provides a default connector set_property handler using the atomic driver
2197 * Zero on success, error code on failure
2200 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2201 struct drm_property *property,
2204 struct drm_atomic_state *state;
2205 struct drm_connector_state *connector_state;
2208 state = drm_atomic_state_alloc(connector->dev);
2212 /* ->set_property is always called with all locks held. */
2213 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2215 connector_state = drm_atomic_get_connector_state(state, connector);
2216 if (IS_ERR(connector_state)) {
2217 ret = PTR_ERR(connector_state);
2221 ret = drm_atomic_connector_set_property(connector, connector_state,
2226 ret = drm_atomic_commit(state);
2230 /* Driver takes ownership of state on successful commit. */
2233 if (ret == -EDEADLK)
2236 drm_atomic_state_free(state);
2240 drm_atomic_state_clear(state);
2241 drm_atomic_legacy_backoff(state);
2245 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2248 * drm_atomic_helper_page_flip - execute a legacy page flip
2250 * @fb: DRM framebuffer
2251 * @event: optional DRM event to signal upon completion
2252 * @flags: flip flags for non-vblank sync'ed updates
2254 * Provides a default page flip implementation using the atomic driver interface.
2256 * Note that for now so called async page flips (i.e. updates which are not
2257 * synchronized to vblank) are not supported, since the atomic interfaces have
2258 * no provisions for this yet.
2261 * Returns 0 on success, negative errno numbers on failure.
2263 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2264 struct drm_framebuffer *fb,
2265 struct drm_pending_vblank_event *event,
2268 struct drm_plane *plane = crtc->primary;
2269 struct drm_atomic_state *state;
2270 struct drm_plane_state *plane_state;
2271 struct drm_crtc_state *crtc_state;
2274 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2277 state = drm_atomic_state_alloc(plane->dev);
2281 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2283 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2284 if (IS_ERR(crtc_state)) {
2285 ret = PTR_ERR(crtc_state);
2288 crtc_state->event = event;
2290 plane_state = drm_atomic_get_plane_state(state, plane);
2291 if (IS_ERR(plane_state)) {
2292 ret = PTR_ERR(plane_state);
2296 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2299 drm_atomic_set_fb_for_plane(plane_state, fb);
2301 /* Make sure we don't accidentally do a full modeset. */
2302 state->allow_modeset = false;
2303 if (!crtc_state->active) {
2304 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2310 ret = drm_atomic_async_commit(state);
2314 /* Driver takes ownership of state on successful async commit. */
2317 if (ret == -EDEADLK)
2320 drm_atomic_state_free(state);
2324 drm_atomic_state_clear(state);
2325 drm_atomic_legacy_backoff(state);
2328 * Someone might have exchanged the framebuffer while we dropped locks
2329 * in the backoff code. We need to fix up the fb refcount tracking the
2332 plane->old_fb = plane->fb;
2336 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2339 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2340 * @connector: affected connector
2343 * This is the main helper function provided by the atomic helper framework for
2344 * implementing the legacy DPMS connector interface. It computes the new desired
2345 * ->active state for the corresponding CRTC (if the connector is enabled) and
2349 * Returns 0 on success, negative errno numbers on failure.
2351 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2354 struct drm_mode_config *config = &connector->dev->mode_config;
2355 struct drm_atomic_state *state;
2356 struct drm_crtc_state *crtc_state;
2357 struct drm_crtc *crtc;
2358 struct drm_connector *tmp_connector;
2360 bool active = false;
2361 int old_mode = connector->dpms;
2363 if (mode != DRM_MODE_DPMS_ON)
2364 mode = DRM_MODE_DPMS_OFF;
2366 connector->dpms = mode;
2367 crtc = connector->state->crtc;
2372 state = drm_atomic_state_alloc(connector->dev);
2376 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2378 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2379 if (IS_ERR(crtc_state)) {
2380 ret = PTR_ERR(crtc_state);
2384 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2386 drm_for_each_connector(tmp_connector, connector->dev) {
2387 if (tmp_connector->state->crtc != crtc)
2390 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2395 crtc_state->active = active;
2397 ret = drm_atomic_commit(state);
2401 /* Driver takes ownership of state on successful commit. */
2404 if (ret == -EDEADLK)
2407 connector->dpms = old_mode;
2408 drm_atomic_state_free(state);
2412 drm_atomic_state_clear(state);
2413 drm_atomic_legacy_backoff(state);
2417 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2420 * DOC: atomic state reset and initialization
2422 * Both the drm core and the atomic helpers assume that there is always the full
2423 * and correct atomic software state for all connectors, CRTCs and planes
2424 * available. Which is a bit a problem on driver load and also after system
2425 * suspend. One way to solve this is to have a hardware state read-out
2426 * infrastructure which reconstructs the full software state (e.g. the i915
2429 * The simpler solution is to just reset the software state to everything off,
2430 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2431 * the atomic helpers provide default reset implementations for all hooks.
2433 * On the upside the precise state tracking of atomic simplifies system suspend
2434 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2435 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2436 * For other drivers the building blocks are split out, see the documentation
2437 * for these functions.
2441 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2444 * Resets the atomic state for @crtc by freeing the state pointer (which might
2445 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2447 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2450 drm_property_unreference_blob(crtc->state->mode_blob);
2452 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2455 crtc->state->crtc = crtc;
2457 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2460 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2461 * @crtc: CRTC object
2462 * @state: atomic CRTC state
2464 * Copies atomic state from a CRTC's current state and resets inferred values.
2465 * This is useful for drivers that subclass the CRTC state.
2467 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2468 struct drm_crtc_state *state)
2470 memcpy(state, crtc->state, sizeof(*state));
2472 if (state->mode_blob)
2473 drm_property_reference_blob(state->mode_blob);
2474 state->mode_changed = false;
2475 state->active_changed = false;
2476 state->planes_changed = false;
2477 state->connectors_changed = false;
2478 state->event = NULL;
2480 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2483 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2486 * Default CRTC state duplicate hook for drivers which don't have their own
2487 * subclassed CRTC state structure.
2489 struct drm_crtc_state *
2490 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2492 struct drm_crtc_state *state;
2494 if (WARN_ON(!crtc->state))
2497 state = kmalloc(sizeof(*state), GFP_KERNEL);
2499 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2503 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2506 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2507 * @crtc: CRTC object
2508 * @state: CRTC state object to release
2510 * Releases all resources stored in the CRTC state without actually freeing
2511 * the memory of the CRTC state. This is useful for drivers that subclass the
2514 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2515 struct drm_crtc_state *state)
2517 drm_property_unreference_blob(state->mode_blob);
2519 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2522 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2524 * @state: CRTC state object to release
2526 * Default CRTC state destroy hook for drivers which don't have their own
2527 * subclassed CRTC state structure.
2529 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2530 struct drm_crtc_state *state)
2532 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2535 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2538 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2541 * Resets the atomic state for @plane by freeing the state pointer (which might
2542 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2544 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2546 if (plane->state && plane->state->fb)
2547 drm_framebuffer_unreference(plane->state->fb);
2549 kfree(plane->state);
2550 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2553 plane->state->plane = plane;
2555 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2558 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2559 * @plane: plane object
2560 * @state: atomic plane state
2562 * Copies atomic state from a plane's current state. This is useful for
2563 * drivers that subclass the plane state.
2565 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2566 struct drm_plane_state *state)
2568 memcpy(state, plane->state, sizeof(*state));
2571 drm_framebuffer_reference(state->fb);
2573 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2576 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2579 * Default plane state duplicate hook for drivers which don't have their own
2580 * subclassed plane state structure.
2582 struct drm_plane_state *
2583 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2585 struct drm_plane_state *state;
2587 if (WARN_ON(!plane->state))
2590 state = kmalloc(sizeof(*state), GFP_KERNEL);
2592 __drm_atomic_helper_plane_duplicate_state(plane, state);
2596 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2599 * __drm_atomic_helper_plane_destroy_state - release plane state
2600 * @plane: plane object
2601 * @state: plane state object to release
2603 * Releases all resources stored in the plane state without actually freeing
2604 * the memory of the plane state. This is useful for drivers that subclass the
2607 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2608 struct drm_plane_state *state)
2611 drm_framebuffer_unreference(state->fb);
2613 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2616 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2618 * @state: plane state object to release
2620 * Default plane state destroy hook for drivers which don't have their own
2621 * subclassed plane state structure.
2623 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2624 struct drm_plane_state *state)
2626 __drm_atomic_helper_plane_destroy_state(plane, state);
2629 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2632 * __drm_atomic_helper_connector_reset - reset state on connector
2633 * @connector: drm connector
2634 * @conn_state: connector state to assign
2636 * Initializes the newly allocated @conn_state and assigns it to
2637 * #connector ->state, usually required when initializing the drivers
2638 * or when called from the ->reset hook.
2640 * This is useful for drivers that subclass the connector state.
2643 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2644 struct drm_connector_state *conn_state)
2647 conn_state->connector = connector;
2649 connector->state = conn_state;
2651 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2654 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2655 * @connector: drm connector
2657 * Resets the atomic state for @connector by freeing the state pointer (which
2658 * might be NULL, e.g. at driver load time) and allocating a new empty state
2661 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2663 struct drm_connector_state *conn_state =
2664 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2666 kfree(connector->state);
2667 __drm_atomic_helper_connector_reset(connector, conn_state);
2669 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2672 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2673 * @connector: connector object
2674 * @state: atomic connector state
2676 * Copies atomic state from a connector's current state. This is useful for
2677 * drivers that subclass the connector state.
2680 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2681 struct drm_connector_state *state)
2683 memcpy(state, connector->state, sizeof(*state));
2685 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2688 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2689 * @connector: drm connector
2691 * Default connector state duplicate hook for drivers which don't have their own
2692 * subclassed connector state structure.
2694 struct drm_connector_state *
2695 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2697 struct drm_connector_state *state;
2699 if (WARN_ON(!connector->state))
2702 state = kmalloc(sizeof(*state), GFP_KERNEL);
2704 __drm_atomic_helper_connector_duplicate_state(connector, state);
2708 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2711 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2713 * @ctx: lock acquisition context
2715 * Makes a copy of the current atomic state by looping over all objects and
2716 * duplicating their respective states. This is used for example by suspend/
2717 * resume support code to save the state prior to suspend such that it can
2718 * be restored upon resume.
2720 * Note that this treats atomic state as persistent between save and restore.
2721 * Drivers must make sure that this is possible and won't result in confusion
2722 * or erroneous behaviour.
2724 * Note that if callers haven't already acquired all modeset locks this might
2725 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2728 * A pointer to the copy of the atomic state object on success or an
2729 * ERR_PTR()-encoded error code on failure.
2732 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2734 struct drm_atomic_state *
2735 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2736 struct drm_modeset_acquire_ctx *ctx)
2738 struct drm_atomic_state *state;
2739 struct drm_connector *conn;
2740 struct drm_plane *plane;
2741 struct drm_crtc *crtc;
2744 state = drm_atomic_state_alloc(dev);
2746 return ERR_PTR(-ENOMEM);
2748 state->acquire_ctx = ctx;
2750 drm_for_each_crtc(crtc, dev) {
2751 struct drm_crtc_state *crtc_state;
2753 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2754 if (IS_ERR(crtc_state)) {
2755 err = PTR_ERR(crtc_state);
2760 drm_for_each_plane(plane, dev) {
2761 struct drm_plane_state *plane_state;
2763 plane_state = drm_atomic_get_plane_state(state, plane);
2764 if (IS_ERR(plane_state)) {
2765 err = PTR_ERR(plane_state);
2770 drm_for_each_connector(conn, dev) {
2771 struct drm_connector_state *conn_state;
2773 conn_state = drm_atomic_get_connector_state(state, conn);
2774 if (IS_ERR(conn_state)) {
2775 err = PTR_ERR(conn_state);
2780 /* clear the acquire context so that it isn't accidentally reused */
2781 state->acquire_ctx = NULL;
2785 drm_atomic_state_free(state);
2786 state = ERR_PTR(err);
2791 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2794 * __drm_atomic_helper_connector_destroy_state - release connector state
2795 * @connector: connector object
2796 * @state: connector state object to release
2798 * Releases all resources stored in the connector state without actually
2799 * freeing the memory of the connector state. This is useful for drivers that
2800 * subclass the connector state.
2803 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2804 struct drm_connector_state *state)
2807 * This is currently a placeholder so that drivers that subclass the
2808 * state will automatically do the right thing if code is ever added
2812 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2815 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2816 * @connector: drm connector
2817 * @state: connector state object to release
2819 * Default connector state destroy hook for drivers which don't have their own
2820 * subclassed connector state structure.
2822 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2823 struct drm_connector_state *state)
2825 __drm_atomic_helper_connector_destroy_state(connector, state);
2828 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);