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) {
469 * We must set ->active_changed after walking connectors for
470 * otherwise an update that only changes active would result in
471 * a full modeset because update_connector_routing force that.
473 if (crtc->state->active != crtc_state->active) {
474 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
475 crtc->base.id, crtc->name);
476 crtc_state->active_changed = true;
479 if (!drm_atomic_crtc_needs_modeset(crtc_state))
482 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
483 crtc->base.id, crtc->name,
484 crtc_state->enable ? 'y' : 'n',
485 crtc_state->active ? 'y' : 'n');
487 ret = drm_atomic_add_affected_connectors(state, crtc);
491 ret = drm_atomic_add_affected_planes(state, crtc);
495 num_connectors = drm_atomic_connectors_for_crtc(state,
498 if (crtc_state->enable != !!num_connectors) {
499 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
500 crtc->base.id, crtc->name);
506 return mode_fixup(state);
508 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
511 * drm_atomic_helper_check_planes - validate state object for planes changes
513 * @state: the driver state object
515 * Check the state object to see if the requested state is physically possible.
516 * This does all the plane update related checks using by calling into the
517 * ->atomic_check hooks provided by the driver.
519 * It also sets crtc_state->planes_changed to indicate that a crtc has
523 * Zero for success or -errno
526 drm_atomic_helper_check_planes(struct drm_device *dev,
527 struct drm_atomic_state *state)
529 struct drm_crtc *crtc;
530 struct drm_crtc_state *crtc_state;
531 struct drm_plane *plane;
532 struct drm_plane_state *plane_state;
535 for_each_plane_in_state(state, plane, plane_state, i) {
536 const struct drm_plane_helper_funcs *funcs;
538 funcs = plane->helper_private;
540 drm_atomic_helper_plane_changed(state, plane_state, plane);
542 if (!funcs || !funcs->atomic_check)
545 ret = funcs->atomic_check(plane, plane_state);
547 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
548 plane->base.id, plane->name);
553 for_each_crtc_in_state(state, crtc, crtc_state, i) {
554 const struct drm_crtc_helper_funcs *funcs;
556 funcs = crtc->helper_private;
558 if (!funcs || !funcs->atomic_check)
561 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
563 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
564 crtc->base.id, crtc->name);
571 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
574 * drm_atomic_helper_check - validate state object
576 * @state: the driver state object
578 * Check the state object to see if the requested state is physically possible.
579 * Only crtcs and planes have check callbacks, so for any additional (global)
580 * checking that a driver needs it can simply wrap that around this function.
581 * Drivers without such needs can directly use this as their ->atomic_check()
584 * This just wraps the two parts of the state checking for planes and modeset
585 * state in the default order: First it calls drm_atomic_helper_check_modeset()
586 * and then drm_atomic_helper_check_planes(). The assumption is that the
587 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
588 * e.g. properly compute watermarks.
591 * Zero for success or -errno
593 int drm_atomic_helper_check(struct drm_device *dev,
594 struct drm_atomic_state *state)
598 ret = drm_atomic_helper_check_modeset(dev, state);
602 ret = drm_atomic_helper_check_planes(dev, state);
608 EXPORT_SYMBOL(drm_atomic_helper_check);
611 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
613 struct drm_connector *connector;
614 struct drm_connector_state *old_conn_state;
615 struct drm_crtc *crtc;
616 struct drm_crtc_state *old_crtc_state;
619 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
620 const struct drm_encoder_helper_funcs *funcs;
621 struct drm_encoder *encoder;
622 struct drm_crtc_state *old_crtc_state;
624 /* Shut down everything that's in the changeset and currently
625 * still on. So need to check the old, saved state. */
626 if (!old_conn_state->crtc)
629 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
631 if (!old_crtc_state->active ||
632 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
635 encoder = old_conn_state->best_encoder;
637 /* We shouldn't get this far if we didn't previously have
638 * an encoder.. but WARN_ON() rather than explode.
640 if (WARN_ON(!encoder))
643 funcs = encoder->helper_private;
645 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
646 encoder->base.id, encoder->name);
649 * Each encoder has at most one connector (since we always steal
650 * it away), so we won't call disable hooks twice.
652 drm_bridge_disable(encoder->bridge);
654 /* Right function depends upon target state. */
655 if (connector->state->crtc && funcs->prepare)
656 funcs->prepare(encoder);
657 else if (funcs->disable)
658 funcs->disable(encoder);
660 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
662 drm_bridge_post_disable(encoder->bridge);
665 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
666 const struct drm_crtc_helper_funcs *funcs;
668 /* Shut down everything that needs a full modeset. */
669 if (!drm_atomic_crtc_needs_modeset(crtc->state))
672 if (!old_crtc_state->active)
675 funcs = crtc->helper_private;
677 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
678 crtc->base.id, crtc->name);
681 /* Right function depends upon target state. */
682 if (crtc->state->enable && funcs->prepare)
683 funcs->prepare(crtc);
684 else if (funcs->disable)
685 funcs->disable(crtc);
687 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
692 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
694 * @old_state: atomic state object with old state structures
696 * This function updates all the various legacy modeset state pointers in
697 * connectors, encoders and crtcs. It also updates the timestamping constants
698 * used for precise vblank timestamps by calling
699 * drm_calc_timestamping_constants().
701 * Drivers can use this for building their own atomic commit if they don't have
702 * a pure helper-based modeset implementation.
705 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
706 struct drm_atomic_state *old_state)
708 struct drm_connector *connector;
709 struct drm_connector_state *old_conn_state;
710 struct drm_crtc *crtc;
711 struct drm_crtc_state *old_crtc_state;
714 /* clear out existing links and update dpms */
715 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
716 if (connector->encoder) {
717 WARN_ON(!connector->encoder->crtc);
719 connector->encoder->crtc = NULL;
720 connector->encoder = NULL;
723 crtc = connector->state->crtc;
724 if ((!crtc && old_conn_state->crtc) ||
725 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
726 struct drm_property *dpms_prop =
727 dev->mode_config.dpms_property;
728 int mode = DRM_MODE_DPMS_OFF;
730 if (crtc && crtc->state->active)
731 mode = DRM_MODE_DPMS_ON;
733 connector->dpms = mode;
734 drm_object_property_set_value(&connector->base,
740 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
741 if (!connector->state->crtc)
744 if (WARN_ON(!connector->state->best_encoder))
747 connector->encoder = connector->state->best_encoder;
748 connector->encoder->crtc = connector->state->crtc;
751 /* set legacy state in the crtc structure */
752 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
753 struct drm_plane *primary = crtc->primary;
755 crtc->mode = crtc->state->mode;
756 crtc->enabled = crtc->state->enable;
758 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
759 primary->state->crtc == crtc) {
760 crtc->x = primary->state->src_x >> 16;
761 crtc->y = primary->state->src_y >> 16;
764 if (crtc->state->enable)
765 drm_calc_timestamping_constants(crtc,
766 &crtc->state->adjusted_mode);
769 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
772 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
774 struct drm_crtc *crtc;
775 struct drm_crtc_state *old_crtc_state;
776 struct drm_connector *connector;
777 struct drm_connector_state *old_conn_state;
780 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
781 const struct drm_crtc_helper_funcs *funcs;
783 if (!crtc->state->mode_changed)
786 funcs = crtc->helper_private;
788 if (crtc->state->enable && funcs->mode_set_nofb) {
789 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
790 crtc->base.id, crtc->name);
792 funcs->mode_set_nofb(crtc);
796 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
797 const struct drm_encoder_helper_funcs *funcs;
798 struct drm_crtc_state *new_crtc_state;
799 struct drm_encoder *encoder;
800 struct drm_display_mode *mode, *adjusted_mode;
802 if (!connector->state->best_encoder)
805 encoder = connector->state->best_encoder;
806 funcs = encoder->helper_private;
807 new_crtc_state = connector->state->crtc->state;
808 mode = &new_crtc_state->mode;
809 adjusted_mode = &new_crtc_state->adjusted_mode;
811 if (!new_crtc_state->mode_changed)
814 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
815 encoder->base.id, encoder->name);
818 * Each encoder has at most one connector (since we always steal
819 * it away), so we won't call mode_set hooks twice.
822 funcs->mode_set(encoder, mode, adjusted_mode);
824 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
829 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
831 * @old_state: atomic state object with old state structures
833 * This function shuts down all the outputs that need to be shut down and
834 * prepares them (if required) with the new mode.
836 * For compatibility with legacy crtc helpers this should be called before
837 * drm_atomic_helper_commit_planes(), which is what the default commit function
838 * does. But drivers with different needs can group the modeset commits together
839 * and do the plane commits at the end. This is useful for drivers doing runtime
840 * PM since planes updates then only happen when the CRTC is actually enabled.
842 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
843 struct drm_atomic_state *old_state)
845 disable_outputs(dev, old_state);
847 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
849 crtc_set_mode(dev, old_state);
851 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
854 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
856 * @old_state: atomic state object with old state structures
858 * This function enables all the outputs with the new configuration which had to
859 * be turned off for the update.
861 * For compatibility with legacy crtc helpers this should be called after
862 * drm_atomic_helper_commit_planes(), which is what the default commit function
863 * does. But drivers with different needs can group the modeset commits together
864 * and do the plane commits at the end. This is useful for drivers doing runtime
865 * PM since planes updates then only happen when the CRTC is actually enabled.
867 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
868 struct drm_atomic_state *old_state)
870 struct drm_crtc *crtc;
871 struct drm_crtc_state *old_crtc_state;
872 struct drm_connector *connector;
873 struct drm_connector_state *old_conn_state;
876 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
877 const struct drm_crtc_helper_funcs *funcs;
879 /* Need to filter out CRTCs where only planes change. */
880 if (!drm_atomic_crtc_needs_modeset(crtc->state))
883 if (!crtc->state->active)
886 funcs = crtc->helper_private;
888 if (crtc->state->enable) {
889 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
890 crtc->base.id, crtc->name);
899 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
900 const struct drm_encoder_helper_funcs *funcs;
901 struct drm_encoder *encoder;
903 if (!connector->state->best_encoder)
906 if (!connector->state->crtc->state->active ||
907 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
910 encoder = connector->state->best_encoder;
911 funcs = encoder->helper_private;
913 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
914 encoder->base.id, encoder->name);
917 * Each encoder has at most one connector (since we always steal
918 * it away), so we won't call enable hooks twice.
920 drm_bridge_pre_enable(encoder->bridge);
923 funcs->enable(encoder);
925 funcs->commit(encoder);
927 drm_bridge_enable(encoder->bridge);
930 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
932 static void wait_for_fences(struct drm_device *dev,
933 struct drm_atomic_state *state)
935 struct drm_plane *plane;
936 struct drm_plane_state *plane_state;
939 for_each_plane_in_state(state, plane, plane_state, i) {
940 if (!plane->state->fence)
943 WARN_ON(!plane->state->fb);
945 fence_wait(plane->state->fence, false);
946 fence_put(plane->state->fence);
947 plane->state->fence = NULL;
951 static bool framebuffer_changed(struct drm_device *dev,
952 struct drm_atomic_state *old_state,
953 struct drm_crtc *crtc)
955 struct drm_plane *plane;
956 struct drm_plane_state *old_plane_state;
959 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
960 if (plane->state->crtc != crtc &&
961 old_plane_state->crtc != crtc)
964 if (plane->state->fb != old_plane_state->fb)
972 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
974 * @old_state: atomic state object with old state structures
976 * Helper to, after atomic commit, wait for vblanks on all effected
977 * crtcs (ie. before cleaning up old framebuffers using
978 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
979 * framebuffers have actually changed to optimize for the legacy cursor and
980 * plane update use-case.
983 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
984 struct drm_atomic_state *old_state)
986 struct drm_crtc *crtc;
987 struct drm_crtc_state *old_crtc_state;
990 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
991 /* No one cares about the old state, so abuse it for tracking
992 * and store whether we hold a vblank reference (and should do a
993 * vblank wait) in the ->enable boolean. */
994 old_crtc_state->enable = false;
996 if (!crtc->state->enable)
999 /* Legacy cursor ioctls are completely unsynced, and userspace
1000 * relies on that (by doing tons of cursor updates). */
1001 if (old_state->legacy_cursor_update)
1004 if (!framebuffer_changed(dev, old_state, crtc))
1007 ret = drm_crtc_vblank_get(crtc);
1011 old_crtc_state->enable = true;
1012 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1015 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1016 if (!old_crtc_state->enable)
1019 ret = wait_event_timeout(dev->vblank[i].queue,
1020 old_crtc_state->last_vblank_count !=
1021 drm_crtc_vblank_count(crtc),
1022 msecs_to_jiffies(50));
1024 drm_crtc_vblank_put(crtc);
1027 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1030 * drm_atomic_helper_commit - commit validated state object
1032 * @state: the driver state object
1033 * @async: asynchronous commit
1035 * This function commits a with drm_atomic_helper_check() pre-validated state
1036 * object. This can still fail when e.g. the framebuffer reservation fails. For
1037 * now this doesn't implement asynchronous commits.
1039 * Note that right now this function does not support async commits, and hence
1040 * driver writers must implement their own version for now. Also note that the
1041 * default ordering of how the various stages are called is to match the legacy
1042 * modeset helper library closest. One peculiarity of that is that it doesn't
1043 * mesh well with runtime PM at all.
1045 * For drivers supporting runtime PM the recommended sequence is
1047 * drm_atomic_helper_commit_modeset_disables(dev, state);
1049 * drm_atomic_helper_commit_modeset_enables(dev, state);
1051 * drm_atomic_helper_commit_planes(dev, state, true);
1053 * See the kerneldoc entries for these three functions for more details.
1056 * Zero for success or -errno.
1058 int drm_atomic_helper_commit(struct drm_device *dev,
1059 struct drm_atomic_state *state,
1067 ret = drm_atomic_helper_prepare_planes(dev, state);
1072 * This is the point of no return - everything below never fails except
1073 * when the hw goes bonghits. Which means we can commit the new state on
1074 * the software side now.
1077 drm_atomic_helper_swap_state(dev, state);
1080 * Everything below can be run asynchronously without the need to grab
1081 * any modeset locks at all under one condition: It must be guaranteed
1082 * that the asynchronous work has either been cancelled (if the driver
1083 * supports it, which at least requires that the framebuffers get
1084 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1085 * before the new state gets committed on the software side with
1086 * drm_atomic_helper_swap_state().
1088 * This scheme allows new atomic state updates to be prepared and
1089 * checked in parallel to the asynchronous completion of the previous
1090 * update. Which is important since compositors need to figure out the
1091 * composition of the next frame right after having submitted the
1095 wait_for_fences(dev, state);
1097 drm_atomic_helper_commit_modeset_disables(dev, state);
1099 drm_atomic_helper_commit_planes(dev, state, false);
1101 drm_atomic_helper_commit_modeset_enables(dev, state);
1103 drm_atomic_helper_wait_for_vblanks(dev, state);
1105 drm_atomic_helper_cleanup_planes(dev, state);
1107 drm_atomic_state_free(state);
1111 EXPORT_SYMBOL(drm_atomic_helper_commit);
1114 * DOC: implementing async commit
1116 * For now the atomic helpers don't support async commit directly. If there is
1117 * real need it could be added though, using the dma-buf fence infrastructure
1118 * for generic synchronization with outstanding rendering.
1120 * For now drivers have to implement async commit themselves, with the following
1121 * sequence being the recommended one:
1123 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1124 * which commit needs to call which can fail, so we want to run it first and
1127 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1128 * might be affected the new state update. This can be done by either cancelling
1129 * or flushing the work items, depending upon whether the driver can deal with
1130 * cancelled updates. Note that it is important to ensure that the framebuffer
1131 * cleanup is still done when cancelling.
1133 * For sufficient parallelism it is recommended to have a work item per crtc
1134 * (for updates which don't touch global state) and a global one. Then we only
1135 * need to synchronize with the crtc work items for changed crtcs and the global
1136 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1138 * 3. The software state is updated synchronously with
1139 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1140 * locks means concurrent callers never see inconsistent state. And doing this
1141 * while it's guaranteed that no relevant async worker runs means that async
1142 * workers do not need grab any locks. Actually they must not grab locks, for
1143 * otherwise the work flushing will deadlock.
1145 * 4. Schedule a work item to do all subsequent steps, using the split-out
1146 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1147 * then cleaning up the framebuffers after the old framebuffer is no longer
1152 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1154 * @state: atomic state object with new state structures
1156 * This function prepares plane state, specifically framebuffers, for the new
1157 * configuration. If any failure is encountered this function will call
1158 * ->cleanup_fb on any already successfully prepared framebuffer.
1161 * 0 on success, negative error code on failure.
1163 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1164 struct drm_atomic_state *state)
1166 int nplanes = dev->mode_config.num_total_plane;
1169 for (i = 0; i < nplanes; i++) {
1170 const struct drm_plane_helper_funcs *funcs;
1171 struct drm_plane *plane = state->planes[i];
1172 struct drm_plane_state *plane_state = state->plane_states[i];
1177 funcs = plane->helper_private;
1179 if (funcs->prepare_fb) {
1180 ret = funcs->prepare_fb(plane, plane_state);
1189 for (i--; i >= 0; i--) {
1190 const struct drm_plane_helper_funcs *funcs;
1191 struct drm_plane *plane = state->planes[i];
1192 struct drm_plane_state *plane_state = state->plane_states[i];
1197 funcs = plane->helper_private;
1199 if (funcs->cleanup_fb)
1200 funcs->cleanup_fb(plane, plane_state);
1206 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1208 bool plane_crtc_active(struct drm_plane_state *state)
1210 return state->crtc && state->crtc->state->active;
1214 * drm_atomic_helper_commit_planes - commit plane state
1216 * @old_state: atomic state object with old state structures
1217 * @active_only: Only commit on active CRTC if set
1219 * This function commits the new plane state using the plane and atomic helper
1220 * functions for planes and crtcs. It assumes that the atomic state has already
1221 * been pushed into the relevant object state pointers, since this step can no
1224 * It still requires the global state object @old_state to know which planes and
1225 * crtcs need to be updated though.
1227 * Note that this function does all plane updates across all CRTCs in one step.
1228 * If the hardware can't support this approach look at
1229 * drm_atomic_helper_commit_planes_on_crtc() instead.
1231 * Plane parameters can be updated by applications while the associated CRTC is
1232 * disabled. The DRM/KMS core will store the parameters in the plane state,
1233 * which will be available to the driver when the CRTC is turned on. As a result
1234 * most drivers don't need to be immediately notified of plane updates for a
1237 * Unless otherwise needed, drivers are advised to set the @active_only
1238 * parameters to true in order not to receive plane update notifications related
1239 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1240 * driver code when the driver and/or hardware can't or just don't need to deal
1241 * with updates on disabled CRTCs, for example when supporting runtime PM.
1243 * The drm_atomic_helper_commit() default implementation only sets @active_only
1244 * to false to most closely match the behaviour of the legacy helpers. This should
1245 * not be copied blindly by drivers.
1247 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1248 struct drm_atomic_state *old_state,
1251 struct drm_crtc *crtc;
1252 struct drm_crtc_state *old_crtc_state;
1253 struct drm_plane *plane;
1254 struct drm_plane_state *old_plane_state;
1257 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1258 const struct drm_crtc_helper_funcs *funcs;
1260 funcs = crtc->helper_private;
1262 if (!funcs || !funcs->atomic_begin)
1265 if (active_only && !crtc->state->active)
1268 funcs->atomic_begin(crtc, old_crtc_state);
1271 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1272 const struct drm_plane_helper_funcs *funcs;
1275 funcs = plane->helper_private;
1280 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1284 * Skip planes related to inactive CRTCs. If the plane
1285 * is enabled use the state of the current CRTC. If the
1286 * plane is being disabled use the state of the old
1287 * CRTC to avoid skipping planes being disabled on an
1290 if (!disabling && !plane_crtc_active(plane->state))
1292 if (disabling && !plane_crtc_active(old_plane_state))
1297 * Special-case disabling the plane if drivers support it.
1299 if (disabling && funcs->atomic_disable)
1300 funcs->atomic_disable(plane, old_plane_state);
1301 else if (plane->state->crtc || disabling)
1302 funcs->atomic_update(plane, old_plane_state);
1305 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1306 const struct drm_crtc_helper_funcs *funcs;
1308 funcs = crtc->helper_private;
1310 if (!funcs || !funcs->atomic_flush)
1313 if (active_only && !crtc->state->active)
1316 funcs->atomic_flush(crtc, old_crtc_state);
1319 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1322 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1323 * @old_crtc_state: atomic state object with the old crtc state
1325 * This function commits the new plane state using the plane and atomic helper
1326 * functions for planes on the specific crtc. It assumes that the atomic state
1327 * has already been pushed into the relevant object state pointers, since this
1328 * step can no longer fail.
1330 * This function is useful when plane updates should be done crtc-by-crtc
1331 * instead of one global step like drm_atomic_helper_commit_planes() does.
1333 * This function can only be savely used when planes are not allowed to move
1334 * between different CRTCs because this function doesn't handle inter-CRTC
1335 * depencies. Callers need to ensure that either no such depencies exist,
1336 * resolve them through ordering of commit calls or through some other means.
1339 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1341 const struct drm_crtc_helper_funcs *crtc_funcs;
1342 struct drm_crtc *crtc = old_crtc_state->crtc;
1343 struct drm_atomic_state *old_state = old_crtc_state->state;
1344 struct drm_plane *plane;
1345 unsigned plane_mask;
1347 plane_mask = old_crtc_state->plane_mask;
1348 plane_mask |= crtc->state->plane_mask;
1350 crtc_funcs = crtc->helper_private;
1351 if (crtc_funcs && crtc_funcs->atomic_begin)
1352 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1354 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1355 struct drm_plane_state *old_plane_state =
1356 drm_atomic_get_existing_plane_state(old_state, plane);
1357 const struct drm_plane_helper_funcs *plane_funcs;
1359 plane_funcs = plane->helper_private;
1361 if (!old_plane_state || !plane_funcs)
1364 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1366 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1367 plane_funcs->atomic_disable)
1368 plane_funcs->atomic_disable(plane, old_plane_state);
1369 else if (plane->state->crtc ||
1370 drm_atomic_plane_disabling(plane, old_plane_state))
1371 plane_funcs->atomic_update(plane, old_plane_state);
1374 if (crtc_funcs && crtc_funcs->atomic_flush)
1375 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1377 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1380 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1382 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1384 * Disables all planes associated with the given CRTC. This can be
1385 * used for instance in the CRTC helper disable callback to disable
1386 * all planes before shutting down the display pipeline.
1388 * If the atomic-parameter is set the function calls the CRTC's
1389 * atomic_begin hook before and atomic_flush hook after disabling the
1392 * It is a bug to call this function without having implemented the
1393 * ->atomic_disable() plane hook.
1395 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1398 const struct drm_crtc_helper_funcs *crtc_funcs =
1399 crtc->helper_private;
1400 struct drm_plane *plane;
1402 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1403 crtc_funcs->atomic_begin(crtc, NULL);
1405 drm_for_each_plane(plane, crtc->dev) {
1406 const struct drm_plane_helper_funcs *plane_funcs =
1407 plane->helper_private;
1409 if (plane->state->crtc != crtc || !plane_funcs)
1412 WARN_ON(!plane_funcs->atomic_disable);
1413 if (plane_funcs->atomic_disable)
1414 plane_funcs->atomic_disable(plane, NULL);
1417 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1418 crtc_funcs->atomic_flush(crtc, NULL);
1420 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1423 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1425 * @old_state: atomic state object with old state structures
1427 * This function cleans up plane state, specifically framebuffers, from the old
1428 * configuration. Hence the old configuration must be perserved in @old_state to
1429 * be able to call this function.
1431 * This function must also be called on the new state when the atomic update
1432 * fails at any point after calling drm_atomic_helper_prepare_planes().
1434 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1435 struct drm_atomic_state *old_state)
1437 struct drm_plane *plane;
1438 struct drm_plane_state *plane_state;
1441 for_each_plane_in_state(old_state, plane, plane_state, i) {
1442 const struct drm_plane_helper_funcs *funcs;
1444 funcs = plane->helper_private;
1446 if (funcs->cleanup_fb)
1447 funcs->cleanup_fb(plane, plane_state);
1450 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1453 * drm_atomic_helper_swap_state - store atomic state into current sw state
1455 * @state: atomic state
1457 * This function stores the atomic state into the current state pointers in all
1458 * driver objects. It should be called after all failing steps have been done
1459 * and succeeded, but before the actual hardware state is committed.
1461 * For cleanup and error recovery the current state for all changed objects will
1462 * be swaped into @state.
1464 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1466 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1468 * 2. Do any other steps that might fail.
1470 * 3. Put the staged state into the current state pointers with this function.
1472 * 4. Actually commit the hardware state.
1474 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1475 * contains the old state. Also do any other cleanup required with that state.
1477 void drm_atomic_helper_swap_state(struct drm_device *dev,
1478 struct drm_atomic_state *state)
1482 for (i = 0; i < dev->mode_config.num_connector; i++) {
1483 struct drm_connector *connector = state->connectors[i];
1488 connector->state->state = state;
1489 swap(state->connector_states[i], connector->state);
1490 connector->state->state = NULL;
1493 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1494 struct drm_crtc *crtc = state->crtcs[i];
1499 crtc->state->state = state;
1500 swap(state->crtc_states[i], crtc->state);
1501 crtc->state->state = NULL;
1504 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1505 struct drm_plane *plane = state->planes[i];
1510 plane->state->state = state;
1511 swap(state->plane_states[i], plane->state);
1512 plane->state->state = NULL;
1515 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1518 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1519 * @plane: plane object to update
1520 * @crtc: owning CRTC of owning plane
1521 * @fb: framebuffer to flip onto plane
1522 * @crtc_x: x offset of primary plane on crtc
1523 * @crtc_y: y offset of primary plane on crtc
1524 * @crtc_w: width of primary plane rectangle on crtc
1525 * @crtc_h: height of primary plane rectangle on crtc
1526 * @src_x: x offset of @fb for panning
1527 * @src_y: y offset of @fb for panning
1528 * @src_w: width of source rectangle in @fb
1529 * @src_h: height of source rectangle in @fb
1531 * Provides a default plane update handler using the atomic driver interface.
1534 * Zero on success, error code on failure
1536 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1537 struct drm_crtc *crtc,
1538 struct drm_framebuffer *fb,
1539 int crtc_x, int crtc_y,
1540 unsigned int crtc_w, unsigned int crtc_h,
1541 uint32_t src_x, uint32_t src_y,
1542 uint32_t src_w, uint32_t src_h)
1544 struct drm_atomic_state *state;
1545 struct drm_plane_state *plane_state;
1548 state = drm_atomic_state_alloc(plane->dev);
1552 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1554 plane_state = drm_atomic_get_plane_state(state, plane);
1555 if (IS_ERR(plane_state)) {
1556 ret = PTR_ERR(plane_state);
1560 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1563 drm_atomic_set_fb_for_plane(plane_state, fb);
1564 plane_state->crtc_x = crtc_x;
1565 plane_state->crtc_y = crtc_y;
1566 plane_state->crtc_w = crtc_w;
1567 plane_state->crtc_h = crtc_h;
1568 plane_state->src_x = src_x;
1569 plane_state->src_y = src_y;
1570 plane_state->src_w = src_w;
1571 plane_state->src_h = src_h;
1573 if (plane == crtc->cursor)
1574 state->legacy_cursor_update = true;
1576 ret = drm_atomic_commit(state);
1580 /* Driver takes ownership of state on successful commit. */
1583 if (ret == -EDEADLK)
1586 drm_atomic_state_free(state);
1590 drm_atomic_state_clear(state);
1591 drm_atomic_legacy_backoff(state);
1594 * Someone might have exchanged the framebuffer while we dropped locks
1595 * in the backoff code. We need to fix up the fb refcount tracking the
1598 plane->old_fb = plane->fb;
1602 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1605 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1606 * @plane: plane to disable
1608 * Provides a default plane disable handler using the atomic driver interface.
1611 * Zero on success, error code on failure
1613 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1615 struct drm_atomic_state *state;
1616 struct drm_plane_state *plane_state;
1620 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1621 * acquire context. The real fix will be to wire the acquire ctx through
1622 * everywhere we need it, but meanwhile prevent chaos by just skipping
1623 * this noop. The critical case is the cursor ioctls which a) only grab
1624 * crtc/cursor-plane locks (so we need the crtc to get at the right
1625 * acquire context) and b) can try to disable the plane multiple times.
1630 state = drm_atomic_state_alloc(plane->dev);
1634 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1636 plane_state = drm_atomic_get_plane_state(state, plane);
1637 if (IS_ERR(plane_state)) {
1638 ret = PTR_ERR(plane_state);
1642 if (plane_state->crtc && (plane == plane->crtc->cursor))
1643 plane_state->state->legacy_cursor_update = true;
1645 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1649 ret = drm_atomic_commit(state);
1653 /* Driver takes ownership of state on successful commit. */
1656 if (ret == -EDEADLK)
1659 drm_atomic_state_free(state);
1663 drm_atomic_state_clear(state);
1664 drm_atomic_legacy_backoff(state);
1667 * Someone might have exchanged the framebuffer while we dropped locks
1668 * in the backoff code. We need to fix up the fb refcount tracking the
1671 plane->old_fb = plane->fb;
1675 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1677 /* just used from fb-helper and atomic-helper: */
1678 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1679 struct drm_plane_state *plane_state)
1683 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1687 drm_atomic_set_fb_for_plane(plane_state, NULL);
1688 plane_state->crtc_x = 0;
1689 plane_state->crtc_y = 0;
1690 plane_state->crtc_w = 0;
1691 plane_state->crtc_h = 0;
1692 plane_state->src_x = 0;
1693 plane_state->src_y = 0;
1694 plane_state->src_w = 0;
1695 plane_state->src_h = 0;
1700 static int update_output_state(struct drm_atomic_state *state,
1701 struct drm_mode_set *set)
1703 struct drm_device *dev = set->crtc->dev;
1704 struct drm_crtc *crtc;
1705 struct drm_crtc_state *crtc_state;
1706 struct drm_connector *connector;
1707 struct drm_connector_state *conn_state;
1710 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1711 state->acquire_ctx);
1715 /* First grab all affected connector/crtc states. */
1716 for (i = 0; i < set->num_connectors; i++) {
1717 conn_state = drm_atomic_get_connector_state(state,
1718 set->connectors[i]);
1719 if (IS_ERR(conn_state))
1720 return PTR_ERR(conn_state);
1723 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1724 ret = drm_atomic_add_affected_connectors(state, crtc);
1729 /* Then recompute connector->crtc links and crtc enabling state. */
1730 for_each_connector_in_state(state, connector, conn_state, i) {
1731 if (conn_state->crtc == set->crtc) {
1732 ret = drm_atomic_set_crtc_for_connector(conn_state,
1738 for (j = 0; j < set->num_connectors; j++) {
1739 if (set->connectors[j] == connector) {
1740 ret = drm_atomic_set_crtc_for_connector(conn_state,
1749 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1750 /* Don't update ->enable for the CRTC in the set_config request,
1751 * since a mismatch would indicate a bug in the upper layers.
1752 * The actual modeset code later on will catch any
1753 * inconsistencies here. */
1754 if (crtc == set->crtc)
1757 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1758 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1763 crtc_state->active = false;
1771 * drm_atomic_helper_set_config - set a new config from userspace
1772 * @set: mode set configuration
1774 * Provides a default crtc set_config handler using the atomic driver interface.
1777 * Returns 0 on success, negative errno numbers on failure.
1779 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1781 struct drm_atomic_state *state;
1782 struct drm_crtc *crtc = set->crtc;
1785 state = drm_atomic_state_alloc(crtc->dev);
1789 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1791 ret = __drm_atomic_helper_set_config(set, state);
1795 ret = drm_atomic_commit(state);
1799 /* Driver takes ownership of state on successful commit. */
1802 if (ret == -EDEADLK)
1805 drm_atomic_state_free(state);
1809 drm_atomic_state_clear(state);
1810 drm_atomic_legacy_backoff(state);
1813 * Someone might have exchanged the framebuffer while we dropped locks
1814 * in the backoff code. We need to fix up the fb refcount tracking the
1817 crtc->primary->old_fb = crtc->primary->fb;
1821 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1823 /* just used from fb-helper and atomic-helper: */
1824 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1825 struct drm_atomic_state *state)
1827 struct drm_crtc_state *crtc_state;
1828 struct drm_plane_state *primary_state;
1829 struct drm_crtc *crtc = set->crtc;
1830 int hdisplay, vdisplay;
1833 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1834 if (IS_ERR(crtc_state))
1835 return PTR_ERR(crtc_state);
1837 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1838 if (IS_ERR(primary_state))
1839 return PTR_ERR(primary_state);
1843 WARN_ON(set->num_connectors);
1845 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1849 crtc_state->active = false;
1851 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1855 drm_atomic_set_fb_for_plane(primary_state, NULL);
1861 WARN_ON(!set->num_connectors);
1863 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1867 crtc_state->active = true;
1869 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1873 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1875 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1876 primary_state->crtc_x = 0;
1877 primary_state->crtc_y = 0;
1878 primary_state->crtc_w = hdisplay;
1879 primary_state->crtc_h = vdisplay;
1880 primary_state->src_x = set->x << 16;
1881 primary_state->src_y = set->y << 16;
1882 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1883 primary_state->src_w = vdisplay << 16;
1884 primary_state->src_h = hdisplay << 16;
1886 primary_state->src_w = hdisplay << 16;
1887 primary_state->src_h = vdisplay << 16;
1891 ret = update_output_state(state, set);
1899 * drm_atomic_helper_disable_all - disable all currently active outputs
1901 * @ctx: lock acquisition context
1903 * Loops through all connectors, finding those that aren't turned off and then
1904 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1905 * that they are connected to.
1907 * This is used for example in suspend/resume to disable all currently active
1908 * functions when suspending.
1910 * Note that if callers haven't already acquired all modeset locks this might
1911 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1914 * 0 on success or a negative error code on failure.
1917 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1919 int drm_atomic_helper_disable_all(struct drm_device *dev,
1920 struct drm_modeset_acquire_ctx *ctx)
1922 struct drm_atomic_state *state;
1923 struct drm_connector *conn;
1926 state = drm_atomic_state_alloc(dev);
1930 state->acquire_ctx = ctx;
1932 drm_for_each_connector(conn, dev) {
1933 struct drm_crtc *crtc = conn->state->crtc;
1934 struct drm_crtc_state *crtc_state;
1936 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
1939 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1940 if (IS_ERR(crtc_state)) {
1941 err = PTR_ERR(crtc_state);
1945 crtc_state->active = false;
1948 err = drm_atomic_commit(state);
1952 drm_atomic_state_free(state);
1956 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
1959 * drm_atomic_helper_suspend - subsystem-level suspend helper
1962 * Duplicates the current atomic state, disables all active outputs and then
1963 * returns a pointer to the original atomic state to the caller. Drivers can
1964 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
1965 * restore the output configuration that was active at the time the system
1968 * Note that it is potentially unsafe to use this. The atomic state object
1969 * returned by this function is assumed to be persistent. Drivers must ensure
1970 * that this holds true. Before calling this function, drivers must make sure
1971 * to suspend fbdev emulation so that nothing can be using the device.
1974 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
1975 * encoded error code on failure. Drivers should store the returned atomic
1976 * state object and pass it to the drm_atomic_helper_resume() helper upon
1980 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
1981 * drm_atomic_helper_resume()
1983 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
1985 struct drm_modeset_acquire_ctx ctx;
1986 struct drm_atomic_state *state;
1989 drm_modeset_acquire_init(&ctx, 0);
1992 err = drm_modeset_lock_all_ctx(dev, &ctx);
1994 state = ERR_PTR(err);
1998 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2002 err = drm_atomic_helper_disable_all(dev, &ctx);
2004 drm_atomic_state_free(state);
2005 state = ERR_PTR(err);
2010 if (PTR_ERR(state) == -EDEADLK) {
2011 drm_modeset_backoff(&ctx);
2015 drm_modeset_drop_locks(&ctx);
2016 drm_modeset_acquire_fini(&ctx);
2019 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2022 * drm_atomic_helper_resume - subsystem-level resume helper
2024 * @state: atomic state to resume to
2026 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2027 * grabs all modeset locks and commits the atomic state object. This can be
2028 * used in conjunction with the drm_atomic_helper_suspend() helper to
2029 * implement suspend/resume for drivers that support atomic mode-setting.
2032 * 0 on success or a negative error code on failure.
2035 * drm_atomic_helper_suspend()
2037 int drm_atomic_helper_resume(struct drm_device *dev,
2038 struct drm_atomic_state *state)
2040 struct drm_mode_config *config = &dev->mode_config;
2043 drm_mode_config_reset(dev);
2044 drm_modeset_lock_all(dev);
2045 state->acquire_ctx = config->acquire_ctx;
2046 err = drm_atomic_commit(state);
2047 drm_modeset_unlock_all(dev);
2051 EXPORT_SYMBOL(drm_atomic_helper_resume);
2054 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2056 * @property: DRM property
2057 * @val: value of property
2059 * Provides a default crtc set_property handler using the atomic driver
2063 * Zero on success, error code on failure
2066 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2067 struct drm_property *property,
2070 struct drm_atomic_state *state;
2071 struct drm_crtc_state *crtc_state;
2074 state = drm_atomic_state_alloc(crtc->dev);
2078 /* ->set_property is always called with all locks held. */
2079 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2081 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2082 if (IS_ERR(crtc_state)) {
2083 ret = PTR_ERR(crtc_state);
2087 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2092 ret = drm_atomic_commit(state);
2096 /* Driver takes ownership of state on successful commit. */
2099 if (ret == -EDEADLK)
2102 drm_atomic_state_free(state);
2106 drm_atomic_state_clear(state);
2107 drm_atomic_legacy_backoff(state);
2111 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2114 * drm_atomic_helper_plane_set_property - helper for plane properties
2116 * @property: DRM property
2117 * @val: value of property
2119 * Provides a default plane set_property handler using the atomic driver
2123 * Zero on success, error code on failure
2126 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2127 struct drm_property *property,
2130 struct drm_atomic_state *state;
2131 struct drm_plane_state *plane_state;
2134 state = drm_atomic_state_alloc(plane->dev);
2138 /* ->set_property is always called with all locks held. */
2139 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2141 plane_state = drm_atomic_get_plane_state(state, plane);
2142 if (IS_ERR(plane_state)) {
2143 ret = PTR_ERR(plane_state);
2147 ret = drm_atomic_plane_set_property(plane, plane_state,
2152 ret = drm_atomic_commit(state);
2156 /* Driver takes ownership of state on successful commit. */
2159 if (ret == -EDEADLK)
2162 drm_atomic_state_free(state);
2166 drm_atomic_state_clear(state);
2167 drm_atomic_legacy_backoff(state);
2171 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2174 * drm_atomic_helper_connector_set_property - helper for connector properties
2175 * @connector: DRM connector
2176 * @property: DRM property
2177 * @val: value of property
2179 * Provides a default connector set_property handler using the atomic driver
2183 * Zero on success, error code on failure
2186 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2187 struct drm_property *property,
2190 struct drm_atomic_state *state;
2191 struct drm_connector_state *connector_state;
2194 state = drm_atomic_state_alloc(connector->dev);
2198 /* ->set_property is always called with all locks held. */
2199 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2201 connector_state = drm_atomic_get_connector_state(state, connector);
2202 if (IS_ERR(connector_state)) {
2203 ret = PTR_ERR(connector_state);
2207 ret = drm_atomic_connector_set_property(connector, connector_state,
2212 ret = drm_atomic_commit(state);
2216 /* Driver takes ownership of state on successful commit. */
2219 if (ret == -EDEADLK)
2222 drm_atomic_state_free(state);
2226 drm_atomic_state_clear(state);
2227 drm_atomic_legacy_backoff(state);
2231 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2234 * drm_atomic_helper_page_flip - execute a legacy page flip
2236 * @fb: DRM framebuffer
2237 * @event: optional DRM event to signal upon completion
2238 * @flags: flip flags for non-vblank sync'ed updates
2240 * Provides a default page flip implementation using the atomic driver interface.
2242 * Note that for now so called async page flips (i.e. updates which are not
2243 * synchronized to vblank) are not supported, since the atomic interfaces have
2244 * no provisions for this yet.
2247 * Returns 0 on success, negative errno numbers on failure.
2249 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2250 struct drm_framebuffer *fb,
2251 struct drm_pending_vblank_event *event,
2254 struct drm_plane *plane = crtc->primary;
2255 struct drm_atomic_state *state;
2256 struct drm_plane_state *plane_state;
2257 struct drm_crtc_state *crtc_state;
2260 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2263 state = drm_atomic_state_alloc(plane->dev);
2267 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2269 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2270 if (IS_ERR(crtc_state)) {
2271 ret = PTR_ERR(crtc_state);
2274 crtc_state->event = event;
2276 plane_state = drm_atomic_get_plane_state(state, plane);
2277 if (IS_ERR(plane_state)) {
2278 ret = PTR_ERR(plane_state);
2282 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2285 drm_atomic_set_fb_for_plane(plane_state, fb);
2287 ret = drm_atomic_async_commit(state);
2291 /* Driver takes ownership of state on successful async commit. */
2294 if (ret == -EDEADLK)
2297 drm_atomic_state_free(state);
2301 drm_atomic_state_clear(state);
2302 drm_atomic_legacy_backoff(state);
2305 * Someone might have exchanged the framebuffer while we dropped locks
2306 * in the backoff code. We need to fix up the fb refcount tracking the
2309 plane->old_fb = plane->fb;
2313 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2316 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2317 * @connector: affected connector
2320 * This is the main helper function provided by the atomic helper framework for
2321 * implementing the legacy DPMS connector interface. It computes the new desired
2322 * ->active state for the corresponding CRTC (if the connector is enabled) and
2326 * Returns 0 on success, negative errno numbers on failure.
2328 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2331 struct drm_mode_config *config = &connector->dev->mode_config;
2332 struct drm_atomic_state *state;
2333 struct drm_crtc_state *crtc_state;
2334 struct drm_crtc *crtc;
2335 struct drm_connector *tmp_connector;
2337 bool active = false;
2338 int old_mode = connector->dpms;
2340 if (mode != DRM_MODE_DPMS_ON)
2341 mode = DRM_MODE_DPMS_OFF;
2343 connector->dpms = mode;
2344 crtc = connector->state->crtc;
2349 state = drm_atomic_state_alloc(connector->dev);
2353 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2355 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2356 if (IS_ERR(crtc_state)) {
2357 ret = PTR_ERR(crtc_state);
2361 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2363 drm_for_each_connector(tmp_connector, connector->dev) {
2364 if (tmp_connector->state->crtc != crtc)
2367 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2372 crtc_state->active = active;
2374 ret = drm_atomic_commit(state);
2378 /* Driver takes ownership of state on successful commit. */
2381 if (ret == -EDEADLK)
2384 connector->dpms = old_mode;
2385 drm_atomic_state_free(state);
2389 drm_atomic_state_clear(state);
2390 drm_atomic_legacy_backoff(state);
2394 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2397 * DOC: atomic state reset and initialization
2399 * Both the drm core and the atomic helpers assume that there is always the full
2400 * and correct atomic software state for all connectors, CRTCs and planes
2401 * available. Which is a bit a problem on driver load and also after system
2402 * suspend. One way to solve this is to have a hardware state read-out
2403 * infrastructure which reconstructs the full software state (e.g. the i915
2406 * The simpler solution is to just reset the software state to everything off,
2407 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2408 * the atomic helpers provide default reset implementations for all hooks.
2410 * On the upside the precise state tracking of atomic simplifies system suspend
2411 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2412 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2413 * For other drivers the building blocks are split out, see the documentation
2414 * for these functions.
2418 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2421 * Resets the atomic state for @crtc by freeing the state pointer (which might
2422 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2424 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2427 drm_property_unreference_blob(crtc->state->mode_blob);
2429 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2432 crtc->state->crtc = crtc;
2434 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2437 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2438 * @crtc: CRTC object
2439 * @state: atomic CRTC state
2441 * Copies atomic state from a CRTC's current state and resets inferred values.
2442 * This is useful for drivers that subclass the CRTC state.
2444 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2445 struct drm_crtc_state *state)
2447 memcpy(state, crtc->state, sizeof(*state));
2449 if (state->mode_blob)
2450 drm_property_reference_blob(state->mode_blob);
2451 state->mode_changed = false;
2452 state->active_changed = false;
2453 state->planes_changed = false;
2454 state->connectors_changed = false;
2455 state->event = NULL;
2457 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2460 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2463 * Default CRTC state duplicate hook for drivers which don't have their own
2464 * subclassed CRTC state structure.
2466 struct drm_crtc_state *
2467 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2469 struct drm_crtc_state *state;
2471 if (WARN_ON(!crtc->state))
2474 state = kmalloc(sizeof(*state), GFP_KERNEL);
2476 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2480 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2483 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2484 * @crtc: CRTC object
2485 * @state: CRTC state object to release
2487 * Releases all resources stored in the CRTC state without actually freeing
2488 * the memory of the CRTC state. This is useful for drivers that subclass the
2491 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2492 struct drm_crtc_state *state)
2494 drm_property_unreference_blob(state->mode_blob);
2496 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2499 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2501 * @state: CRTC state object to release
2503 * Default CRTC state destroy hook for drivers which don't have their own
2504 * subclassed CRTC state structure.
2506 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2507 struct drm_crtc_state *state)
2509 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2512 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2515 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2518 * Resets the atomic state for @plane by freeing the state pointer (which might
2519 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2521 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2523 if (plane->state && plane->state->fb)
2524 drm_framebuffer_unreference(plane->state->fb);
2526 kfree(plane->state);
2527 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2530 plane->state->plane = plane;
2532 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2535 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2536 * @plane: plane object
2537 * @state: atomic plane state
2539 * Copies atomic state from a plane's current state. This is useful for
2540 * drivers that subclass the plane state.
2542 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2543 struct drm_plane_state *state)
2545 memcpy(state, plane->state, sizeof(*state));
2548 drm_framebuffer_reference(state->fb);
2550 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2553 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2556 * Default plane state duplicate hook for drivers which don't have their own
2557 * subclassed plane state structure.
2559 struct drm_plane_state *
2560 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2562 struct drm_plane_state *state;
2564 if (WARN_ON(!plane->state))
2567 state = kmalloc(sizeof(*state), GFP_KERNEL);
2569 __drm_atomic_helper_plane_duplicate_state(plane, state);
2573 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2576 * __drm_atomic_helper_plane_destroy_state - release plane state
2577 * @plane: plane object
2578 * @state: plane state object to release
2580 * Releases all resources stored in the plane state without actually freeing
2581 * the memory of the plane state. This is useful for drivers that subclass the
2584 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2585 struct drm_plane_state *state)
2588 drm_framebuffer_unreference(state->fb);
2590 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2593 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2595 * @state: plane state object to release
2597 * Default plane state destroy hook for drivers which don't have their own
2598 * subclassed plane state structure.
2600 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2601 struct drm_plane_state *state)
2603 __drm_atomic_helper_plane_destroy_state(plane, state);
2606 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2609 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2610 * @connector: drm connector
2612 * Resets the atomic state for @connector by freeing the state pointer (which
2613 * might be NULL, e.g. at driver load time) and allocating a new empty state
2616 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2618 kfree(connector->state);
2619 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2621 if (connector->state)
2622 connector->state->connector = connector;
2624 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2627 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2628 * @connector: connector object
2629 * @state: atomic connector state
2631 * Copies atomic state from a connector's current state. This is useful for
2632 * drivers that subclass the connector state.
2635 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2636 struct drm_connector_state *state)
2638 memcpy(state, connector->state, sizeof(*state));
2640 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2643 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2644 * @connector: drm connector
2646 * Default connector state duplicate hook for drivers which don't have their own
2647 * subclassed connector state structure.
2649 struct drm_connector_state *
2650 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2652 struct drm_connector_state *state;
2654 if (WARN_ON(!connector->state))
2657 state = kmalloc(sizeof(*state), GFP_KERNEL);
2659 __drm_atomic_helper_connector_duplicate_state(connector, state);
2663 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2666 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2668 * @ctx: lock acquisition context
2670 * Makes a copy of the current atomic state by looping over all objects and
2671 * duplicating their respective states. This is used for example by suspend/
2672 * resume support code to save the state prior to suspend such that it can
2673 * be restored upon resume.
2675 * Note that this treats atomic state as persistent between save and restore.
2676 * Drivers must make sure that this is possible and won't result in confusion
2677 * or erroneous behaviour.
2679 * Note that if callers haven't already acquired all modeset locks this might
2680 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2683 * A pointer to the copy of the atomic state object on success or an
2684 * ERR_PTR()-encoded error code on failure.
2687 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2689 struct drm_atomic_state *
2690 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2691 struct drm_modeset_acquire_ctx *ctx)
2693 struct drm_atomic_state *state;
2694 struct drm_connector *conn;
2695 struct drm_plane *plane;
2696 struct drm_crtc *crtc;
2699 state = drm_atomic_state_alloc(dev);
2701 return ERR_PTR(-ENOMEM);
2703 state->acquire_ctx = ctx;
2705 drm_for_each_crtc(crtc, dev) {
2706 struct drm_crtc_state *crtc_state;
2708 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2709 if (IS_ERR(crtc_state)) {
2710 err = PTR_ERR(crtc_state);
2715 drm_for_each_plane(plane, dev) {
2716 struct drm_plane_state *plane_state;
2718 plane_state = drm_atomic_get_plane_state(state, plane);
2719 if (IS_ERR(plane_state)) {
2720 err = PTR_ERR(plane_state);
2725 drm_for_each_connector(conn, dev) {
2726 struct drm_connector_state *conn_state;
2728 conn_state = drm_atomic_get_connector_state(state, conn);
2729 if (IS_ERR(conn_state)) {
2730 err = PTR_ERR(conn_state);
2735 /* clear the acquire context so that it isn't accidentally reused */
2736 state->acquire_ctx = NULL;
2740 drm_atomic_state_free(state);
2741 state = ERR_PTR(err);
2746 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2749 * __drm_atomic_helper_connector_destroy_state - release connector state
2750 * @connector: connector object
2751 * @state: connector state object to release
2753 * Releases all resources stored in the connector state without actually
2754 * freeing the memory of the connector state. This is useful for drivers that
2755 * subclass the connector state.
2758 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2759 struct drm_connector_state *state)
2762 * This is currently a placeholder so that drivers that subclass the
2763 * state will automatically do the right thing if code is ever added
2767 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2770 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2771 * @connector: drm connector
2772 * @state: connector state object to release
2774 * Default connector state destroy hook for drivers which don't have their own
2775 * subclassed connector state structure.
2777 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2778 struct drm_connector_state *state)
2780 __drm_atomic_helper_connector_destroy_state(connector, state);
2783 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);