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 = drm_atomic_get_existing_crtc_state(state,
73 if (WARN_ON(!crtc_state))
76 crtc_state->planes_changed = true;
79 if (plane_state->crtc) {
80 crtc_state = drm_atomic_get_existing_crtc_state(state,
83 if (WARN_ON(!crtc_state))
86 crtc_state->planes_changed = true;
90 static int handle_conflicting_encoders(struct drm_atomic_state *state,
91 bool disable_conflicting_encoders)
93 struct drm_connector_state *conn_state;
94 struct drm_connector *connector;
95 struct drm_encoder *encoder;
96 unsigned encoder_mask = 0;
100 * First loop, find all newly assigned encoders from the connectors
101 * part of the state. If the same encoder is assigned to multiple
102 * connectors bail out.
104 for_each_connector_in_state(state, connector, conn_state, i) {
105 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
106 struct drm_encoder *new_encoder;
108 if (!conn_state->crtc)
111 if (funcs->atomic_best_encoder)
112 new_encoder = funcs->atomic_best_encoder(connector, conn_state);
113 else if (funcs->best_encoder)
114 new_encoder = funcs->best_encoder(connector);
116 new_encoder = drm_atomic_helper_best_encoder(connector);
119 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
120 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
121 new_encoder->base.id, new_encoder->name,
122 connector->base.id, connector->name);
127 encoder_mask |= 1 << drm_encoder_index(new_encoder);
135 * Second loop, iterate over all connectors not part of the state.
137 * If a conflicting encoder is found and disable_conflicting_encoders
138 * is not set, an error is returned. Userspace can provide a solution
139 * through the atomic ioctl.
141 * If the flag is set conflicting connectors are removed from the crtc
142 * and the crtc is disabled if no encoder is left. This preserves
143 * compatibility with the legacy set_config behavior.
145 drm_for_each_connector(connector, state->dev) {
146 struct drm_crtc_state *crtc_state;
148 if (drm_atomic_get_existing_connector_state(state, connector))
151 encoder = connector->state->best_encoder;
152 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
155 if (!disable_conflicting_encoders) {
156 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
157 encoder->base.id, encoder->name,
158 connector->state->crtc->base.id,
159 connector->state->crtc->name,
160 connector->base.id, connector->name);
164 conn_state = drm_atomic_get_connector_state(state, connector);
165 if (IS_ERR(conn_state))
166 return PTR_ERR(conn_state);
168 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
169 encoder->base.id, encoder->name,
170 conn_state->crtc->base.id, conn_state->crtc->name,
171 connector->base.id, connector->name);
173 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
175 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
179 if (!crtc_state->connector_mask) {
180 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
185 crtc_state->active = false;
193 set_best_encoder(struct drm_atomic_state *state,
194 struct drm_connector_state *conn_state,
195 struct drm_encoder *encoder)
197 struct drm_crtc_state *crtc_state;
198 struct drm_crtc *crtc;
200 if (conn_state->best_encoder) {
201 /* Unset the encoder_mask in the old crtc state. */
202 crtc = conn_state->connector->state->crtc;
204 /* A NULL crtc is an error here because we should have
205 * duplicated a NULL best_encoder when crtc was NULL.
206 * As an exception restoring duplicated atomic state
207 * during resume is allowed, so don't warn when
208 * best_encoder is equal to encoder we intend to set.
210 WARN_ON(!crtc && encoder != conn_state->best_encoder);
212 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
214 crtc_state->encoder_mask &=
215 ~(1 << drm_encoder_index(conn_state->best_encoder));
220 crtc = conn_state->crtc;
223 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
225 crtc_state->encoder_mask |=
226 1 << drm_encoder_index(encoder);
230 conn_state->best_encoder = encoder;
234 steal_encoder(struct drm_atomic_state *state,
235 struct drm_encoder *encoder)
237 struct drm_crtc_state *crtc_state;
238 struct drm_connector *connector;
239 struct drm_connector_state *connector_state;
242 for_each_connector_in_state(state, connector, connector_state, i) {
243 struct drm_crtc *encoder_crtc;
245 if (connector_state->best_encoder != encoder)
248 encoder_crtc = connector->state->crtc;
250 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
251 encoder->base.id, encoder->name,
252 encoder_crtc->base.id, encoder_crtc->name);
254 set_best_encoder(state, connector_state, NULL);
256 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
257 crtc_state->connectors_changed = true;
264 update_connector_routing(struct drm_atomic_state *state,
265 struct drm_connector *connector,
266 struct drm_connector_state *connector_state)
268 const struct drm_connector_helper_funcs *funcs;
269 struct drm_encoder *new_encoder;
270 struct drm_crtc_state *crtc_state;
272 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
276 if (connector->state->crtc != connector_state->crtc) {
277 if (connector->state->crtc) {
278 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
279 crtc_state->connectors_changed = true;
282 if (connector_state->crtc) {
283 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
284 crtc_state->connectors_changed = true;
288 if (!connector_state->crtc) {
289 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
293 set_best_encoder(state, connector_state, NULL);
298 funcs = connector->helper_private;
300 if (funcs->atomic_best_encoder)
301 new_encoder = funcs->atomic_best_encoder(connector,
304 new_encoder = funcs->best_encoder(connector);
307 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
313 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
314 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
315 new_encoder->base.id,
317 connector_state->crtc->base.id);
321 if (new_encoder == connector_state->best_encoder) {
322 set_best_encoder(state, connector_state, new_encoder);
324 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
327 new_encoder->base.id,
329 connector_state->crtc->base.id,
330 connector_state->crtc->name);
335 steal_encoder(state, new_encoder);
337 set_best_encoder(state, connector_state, new_encoder);
339 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
340 crtc_state->connectors_changed = true;
342 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
345 new_encoder->base.id,
347 connector_state->crtc->base.id,
348 connector_state->crtc->name);
354 mode_fixup(struct drm_atomic_state *state)
356 struct drm_crtc *crtc;
357 struct drm_crtc_state *crtc_state;
358 struct drm_connector *connector;
359 struct drm_connector_state *conn_state;
363 for_each_crtc_in_state(state, crtc, crtc_state, i) {
364 if (!crtc_state->mode_changed &&
365 !crtc_state->connectors_changed)
368 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
371 for_each_connector_in_state(state, connector, conn_state, i) {
372 const struct drm_encoder_helper_funcs *funcs;
373 struct drm_encoder *encoder;
375 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
377 if (!conn_state->crtc || !conn_state->best_encoder)
380 crtc_state = drm_atomic_get_existing_crtc_state(state,
384 * Each encoder has at most one connector (since we always steal
385 * it away), so we won't call ->mode_fixup twice.
387 encoder = conn_state->best_encoder;
388 funcs = encoder->helper_private;
390 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
391 &crtc_state->adjusted_mode);
393 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
397 if (funcs && funcs->atomic_check) {
398 ret = funcs->atomic_check(encoder, crtc_state,
401 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
402 encoder->base.id, encoder->name);
405 } else if (funcs && funcs->mode_fixup) {
406 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
407 &crtc_state->adjusted_mode);
409 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
410 encoder->base.id, encoder->name);
416 for_each_crtc_in_state(state, crtc, crtc_state, i) {
417 const struct drm_crtc_helper_funcs *funcs;
419 if (!crtc_state->enable)
422 if (!crtc_state->mode_changed &&
423 !crtc_state->connectors_changed)
426 funcs = crtc->helper_private;
427 if (!funcs->mode_fixup)
430 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
431 &crtc_state->adjusted_mode);
433 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
434 crtc->base.id, crtc->name);
443 * drm_atomic_helper_check_modeset - validate state object for modeset changes
445 * @state: the driver state object
447 * Check the state object to see if the requested state is physically possible.
448 * This does all the crtc and connector related computations for an atomic
449 * update and adds any additional connectors needed for full modesets and calls
450 * down into ->mode_fixup functions of the driver backend.
452 * crtc_state->mode_changed is set when the input mode is changed.
453 * crtc_state->connectors_changed is set when a connector is added or
454 * removed from the crtc.
455 * crtc_state->active_changed is set when crtc_state->active changes,
456 * which is used for dpms.
460 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
461 * plane update can't be done without a full modeset) _must_ call this function
462 * afterwards after that change. It is permitted to call this function multiple
463 * times for the same update, e.g. when the ->atomic_check functions depend upon
464 * the adjusted dotclock for fifo space allocation and watermark computation.
467 * Zero for success or -errno
470 drm_atomic_helper_check_modeset(struct drm_device *dev,
471 struct drm_atomic_state *state)
473 struct drm_crtc *crtc;
474 struct drm_crtc_state *crtc_state;
475 struct drm_connector *connector;
476 struct drm_connector_state *connector_state;
479 for_each_crtc_in_state(state, crtc, crtc_state, i) {
480 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
481 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
482 crtc->base.id, crtc->name);
483 crtc_state->mode_changed = true;
486 if (crtc->state->enable != crtc_state->enable) {
487 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
488 crtc->base.id, crtc->name);
491 * For clarity this assignment is done here, but
492 * enable == 0 is only true when there are no
493 * connectors and a NULL mode.
495 * The other way around is true as well. enable != 0
496 * iff connectors are attached and a mode is set.
498 crtc_state->mode_changed = true;
499 crtc_state->connectors_changed = true;
503 ret = handle_conflicting_encoders(state, state->legacy_set_config);
507 for_each_connector_in_state(state, connector, connector_state, i) {
509 * This only sets crtc->mode_changed for routing changes,
510 * drivers must set crtc->mode_changed themselves when connector
511 * properties need to be updated.
513 ret = update_connector_routing(state, connector,
520 * After all the routing has been prepared we need to add in any
521 * connector which is itself unchanged, but who's crtc changes it's
522 * configuration. This must be done before calling mode_fixup in case a
523 * crtc only changed its mode but has the same set of connectors.
525 for_each_crtc_in_state(state, crtc, crtc_state, i) {
526 bool has_connectors =
527 !!crtc_state->connector_mask;
530 * We must set ->active_changed after walking connectors for
531 * otherwise an update that only changes active would result in
532 * a full modeset because update_connector_routing force that.
534 if (crtc->state->active != crtc_state->active) {
535 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
536 crtc->base.id, crtc->name);
537 crtc_state->active_changed = true;
540 if (!drm_atomic_crtc_needs_modeset(crtc_state))
543 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
544 crtc->base.id, crtc->name,
545 crtc_state->enable ? 'y' : 'n',
546 crtc_state->active ? 'y' : 'n');
548 ret = drm_atomic_add_affected_connectors(state, crtc);
552 ret = drm_atomic_add_affected_planes(state, crtc);
556 if (crtc_state->enable != has_connectors) {
557 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
558 crtc->base.id, crtc->name);
564 return mode_fixup(state);
566 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
569 * drm_atomic_helper_check_planes - validate state object for planes changes
571 * @state: the driver state object
573 * Check the state object to see if the requested state is physically possible.
574 * This does all the plane update related checks using by calling into the
575 * ->atomic_check hooks provided by the driver.
577 * It also sets crtc_state->planes_changed to indicate that a crtc has
581 * Zero for success or -errno
584 drm_atomic_helper_check_planes(struct drm_device *dev,
585 struct drm_atomic_state *state)
587 struct drm_crtc *crtc;
588 struct drm_crtc_state *crtc_state;
589 struct drm_plane *plane;
590 struct drm_plane_state *plane_state;
593 for_each_plane_in_state(state, plane, plane_state, i) {
594 const struct drm_plane_helper_funcs *funcs;
596 funcs = plane->helper_private;
598 drm_atomic_helper_plane_changed(state, plane_state, plane);
600 if (!funcs || !funcs->atomic_check)
603 ret = funcs->atomic_check(plane, plane_state);
605 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
606 plane->base.id, plane->name);
611 for_each_crtc_in_state(state, crtc, crtc_state, i) {
612 const struct drm_crtc_helper_funcs *funcs;
614 funcs = crtc->helper_private;
616 if (!funcs || !funcs->atomic_check)
619 ret = funcs->atomic_check(crtc, crtc_state);
621 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
622 crtc->base.id, crtc->name);
629 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
632 * drm_atomic_helper_check - validate state object
634 * @state: the driver state object
636 * Check the state object to see if the requested state is physically possible.
637 * Only crtcs and planes have check callbacks, so for any additional (global)
638 * checking that a driver needs it can simply wrap that around this function.
639 * Drivers without such needs can directly use this as their ->atomic_check()
642 * This just wraps the two parts of the state checking for planes and modeset
643 * state in the default order: First it calls drm_atomic_helper_check_modeset()
644 * and then drm_atomic_helper_check_planes(). The assumption is that the
645 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
646 * e.g. properly compute watermarks.
649 * Zero for success or -errno
651 int drm_atomic_helper_check(struct drm_device *dev,
652 struct drm_atomic_state *state)
656 ret = drm_atomic_helper_check_modeset(dev, state);
660 ret = drm_atomic_helper_check_planes(dev, state);
666 EXPORT_SYMBOL(drm_atomic_helper_check);
669 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
671 struct drm_connector *connector;
672 struct drm_connector_state *old_conn_state;
673 struct drm_crtc *crtc;
674 struct drm_crtc_state *old_crtc_state;
677 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
678 const struct drm_encoder_helper_funcs *funcs;
679 struct drm_encoder *encoder;
681 /* Shut down everything that's in the changeset and currently
682 * still on. So need to check the old, saved state. */
683 if (!old_conn_state->crtc)
686 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
687 old_conn_state->crtc);
689 if (!old_crtc_state->active ||
690 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
693 encoder = old_conn_state->best_encoder;
695 /* We shouldn't get this far if we didn't previously have
696 * an encoder.. but WARN_ON() rather than explode.
698 if (WARN_ON(!encoder))
701 funcs = encoder->helper_private;
703 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
704 encoder->base.id, encoder->name);
707 * Each encoder has at most one connector (since we always steal
708 * it away), so we won't call disable hooks twice.
710 drm_bridge_disable(encoder->bridge);
712 /* Right function depends upon target state. */
714 if (connector->state->crtc && funcs->prepare)
715 funcs->prepare(encoder);
716 else if (funcs->disable)
717 funcs->disable(encoder);
718 else if (funcs->dpms)
719 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
722 drm_bridge_post_disable(encoder->bridge);
725 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
726 const struct drm_crtc_helper_funcs *funcs;
728 /* Shut down everything that needs a full modeset. */
729 if (!drm_atomic_crtc_needs_modeset(crtc->state))
732 if (!old_crtc_state->active)
735 funcs = crtc->helper_private;
737 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
738 crtc->base.id, crtc->name);
741 /* Right function depends upon target state. */
742 if (crtc->state->enable && funcs->prepare)
743 funcs->prepare(crtc);
744 else if (funcs->disable)
745 funcs->disable(crtc);
747 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
752 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
754 * @old_state: atomic state object with old state structures
756 * This function updates all the various legacy modeset state pointers in
757 * connectors, encoders and crtcs. It also updates the timestamping constants
758 * used for precise vblank timestamps by calling
759 * drm_calc_timestamping_constants().
761 * Drivers can use this for building their own atomic commit if they don't have
762 * a pure helper-based modeset implementation.
765 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
766 struct drm_atomic_state *old_state)
768 struct drm_connector *connector;
769 struct drm_connector_state *old_conn_state;
770 struct drm_crtc *crtc;
771 struct drm_crtc_state *old_crtc_state;
774 /* clear out existing links and update dpms */
775 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
776 if (connector->encoder) {
777 WARN_ON(!connector->encoder->crtc);
779 connector->encoder->crtc = NULL;
780 connector->encoder = NULL;
783 crtc = connector->state->crtc;
784 if ((!crtc && old_conn_state->crtc) ||
785 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
786 struct drm_property *dpms_prop =
787 dev->mode_config.dpms_property;
788 int mode = DRM_MODE_DPMS_OFF;
790 if (crtc && crtc->state->active)
791 mode = DRM_MODE_DPMS_ON;
793 connector->dpms = mode;
794 drm_object_property_set_value(&connector->base,
800 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
801 if (!connector->state->crtc)
804 if (WARN_ON(!connector->state->best_encoder))
807 connector->encoder = connector->state->best_encoder;
808 connector->encoder->crtc = connector->state->crtc;
811 /* set legacy state in the crtc structure */
812 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
813 struct drm_plane *primary = crtc->primary;
815 crtc->mode = crtc->state->mode;
816 crtc->enabled = crtc->state->enable;
818 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
819 primary->state->crtc == crtc) {
820 crtc->x = primary->state->src_x >> 16;
821 crtc->y = primary->state->src_y >> 16;
824 if (crtc->state->enable)
825 drm_calc_timestamping_constants(crtc,
826 &crtc->state->adjusted_mode);
829 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
832 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
834 struct drm_crtc *crtc;
835 struct drm_crtc_state *old_crtc_state;
836 struct drm_connector *connector;
837 struct drm_connector_state *old_conn_state;
840 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
841 const struct drm_crtc_helper_funcs *funcs;
843 if (!crtc->state->mode_changed)
846 funcs = crtc->helper_private;
848 if (crtc->state->enable && funcs->mode_set_nofb) {
849 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
850 crtc->base.id, crtc->name);
852 funcs->mode_set_nofb(crtc);
856 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
857 const struct drm_encoder_helper_funcs *funcs;
858 struct drm_crtc_state *new_crtc_state;
859 struct drm_encoder *encoder;
860 struct drm_display_mode *mode, *adjusted_mode;
862 if (!connector->state->best_encoder)
865 encoder = connector->state->best_encoder;
866 funcs = encoder->helper_private;
867 new_crtc_state = connector->state->crtc->state;
868 mode = &new_crtc_state->mode;
869 adjusted_mode = &new_crtc_state->adjusted_mode;
871 if (!new_crtc_state->mode_changed)
874 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
875 encoder->base.id, encoder->name);
878 * Each encoder has at most one connector (since we always steal
879 * it away), so we won't call mode_set hooks twice.
881 if (funcs && funcs->mode_set)
882 funcs->mode_set(encoder, mode, adjusted_mode);
884 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
889 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
891 * @old_state: atomic state object with old state structures
893 * This function shuts down all the outputs that need to be shut down and
894 * prepares them (if required) with the new mode.
896 * For compatibility with legacy crtc helpers this should be called before
897 * drm_atomic_helper_commit_planes(), which is what the default commit function
898 * does. But drivers with different needs can group the modeset commits together
899 * and do the plane commits at the end. This is useful for drivers doing runtime
900 * PM since planes updates then only happen when the CRTC is actually enabled.
902 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
903 struct drm_atomic_state *old_state)
905 disable_outputs(dev, old_state);
907 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
909 crtc_set_mode(dev, old_state);
911 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
914 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
916 * @old_state: atomic state object with old state structures
918 * This function enables all the outputs with the new configuration which had to
919 * be turned off for the update.
921 * For compatibility with legacy crtc helpers this should be called after
922 * drm_atomic_helper_commit_planes(), which is what the default commit function
923 * does. But drivers with different needs can group the modeset commits together
924 * and do the plane commits at the end. This is useful for drivers doing runtime
925 * PM since planes updates then only happen when the CRTC is actually enabled.
927 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
928 struct drm_atomic_state *old_state)
930 struct drm_crtc *crtc;
931 struct drm_crtc_state *old_crtc_state;
932 struct drm_connector *connector;
933 struct drm_connector_state *old_conn_state;
936 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
937 const struct drm_crtc_helper_funcs *funcs;
939 /* Need to filter out CRTCs where only planes change. */
940 if (!drm_atomic_crtc_needs_modeset(crtc->state))
943 if (!crtc->state->active)
946 funcs = crtc->helper_private;
948 if (crtc->state->enable) {
949 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
950 crtc->base.id, crtc->name);
959 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
960 const struct drm_encoder_helper_funcs *funcs;
961 struct drm_encoder *encoder;
963 if (!connector->state->best_encoder)
966 if (!connector->state->crtc->state->active ||
967 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
970 encoder = connector->state->best_encoder;
971 funcs = encoder->helper_private;
973 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
974 encoder->base.id, encoder->name);
977 * Each encoder has at most one connector (since we always steal
978 * it away), so we won't call enable hooks twice.
980 drm_bridge_pre_enable(encoder->bridge);
984 funcs->enable(encoder);
985 else if (funcs->commit)
986 funcs->commit(encoder);
989 drm_bridge_enable(encoder->bridge);
992 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
995 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
997 * @state: atomic state object with old state structures
999 * For implicit sync, driver should fish the exclusive fence out from the
1000 * incoming fb's and stash it in the drm_plane_state. This is called after
1001 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1002 * just uses the atomic state to find the changed planes)
1004 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1005 struct drm_atomic_state *state)
1007 struct drm_plane *plane;
1008 struct drm_plane_state *plane_state;
1011 for_each_plane_in_state(state, plane, plane_state, i) {
1012 if (!plane->state->fence)
1015 WARN_ON(!plane->state->fb);
1017 fence_wait(plane->state->fence, false);
1018 fence_put(plane->state->fence);
1019 plane->state->fence = NULL;
1022 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1025 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1027 * @old_state: atomic state object with old state structures
1030 * Checks whether the framebuffer used for this CRTC changes as a result of
1031 * the atomic update. This is useful for drivers which cannot use
1032 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1036 * true if the framebuffer changed.
1038 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1039 struct drm_atomic_state *old_state,
1040 struct drm_crtc *crtc)
1042 struct drm_plane *plane;
1043 struct drm_plane_state *old_plane_state;
1046 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1047 if (plane->state->crtc != crtc &&
1048 old_plane_state->crtc != crtc)
1051 if (plane->state->fb != old_plane_state->fb)
1057 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1060 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1062 * @old_state: atomic state object with old state structures
1064 * Helper to, after atomic commit, wait for vblanks on all effected
1065 * crtcs (ie. before cleaning up old framebuffers using
1066 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1067 * framebuffers have actually changed to optimize for the legacy cursor and
1068 * plane update use-case.
1071 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1072 struct drm_atomic_state *old_state)
1074 struct drm_crtc *crtc;
1075 struct drm_crtc_state *old_crtc_state;
1078 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1079 /* No one cares about the old state, so abuse it for tracking
1080 * and store whether we hold a vblank reference (and should do a
1081 * vblank wait) in the ->enable boolean. */
1082 old_crtc_state->enable = false;
1084 if (!crtc->state->enable)
1087 /* Legacy cursor ioctls are completely unsynced, and userspace
1088 * relies on that (by doing tons of cursor updates). */
1089 if (old_state->legacy_cursor_update)
1092 if (!drm_atomic_helper_framebuffer_changed(dev,
1096 ret = drm_crtc_vblank_get(crtc);
1100 old_crtc_state->enable = true;
1101 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1104 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1105 if (!old_crtc_state->enable)
1108 ret = wait_event_timeout(dev->vblank[i].queue,
1109 old_crtc_state->last_vblank_count !=
1110 drm_crtc_vblank_count(crtc),
1111 msecs_to_jiffies(50));
1113 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1115 drm_crtc_vblank_put(crtc);
1118 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1121 * drm_atomic_helper_commit - commit validated state object
1123 * @state: the driver state object
1124 * @nonblocking: whether nonblocking behavior is requested.
1126 * This function commits a with drm_atomic_helper_check() pre-validated state
1127 * object. This can still fail when e.g. the framebuffer reservation fails. For
1128 * now this doesn't implement nonblocking commits.
1130 * Note that right now this function does not support nonblocking commits, hence
1131 * driver writers must implement their own version for now. Also note that the
1132 * default ordering of how the various stages are called is to match the legacy
1133 * modeset helper library closest. One peculiarity of that is that it doesn't
1134 * mesh well with runtime PM at all.
1136 * For drivers supporting runtime PM the recommended sequence is
1138 * drm_atomic_helper_commit_modeset_disables(dev, state);
1140 * drm_atomic_helper_commit_modeset_enables(dev, state);
1142 * drm_atomic_helper_commit_planes(dev, state, true);
1144 * See the kerneldoc entries for these three functions for more details.
1147 * Zero for success or -errno.
1149 int drm_atomic_helper_commit(struct drm_device *dev,
1150 struct drm_atomic_state *state,
1158 ret = drm_atomic_helper_prepare_planes(dev, state);
1163 * This is the point of no return - everything below never fails except
1164 * when the hw goes bonghits. Which means we can commit the new state on
1165 * the software side now.
1168 drm_atomic_helper_swap_state(dev, state);
1171 * Everything below can be run asynchronously without the need to grab
1172 * any modeset locks at all under one condition: It must be guaranteed
1173 * that the asynchronous work has either been cancelled (if the driver
1174 * supports it, which at least requires that the framebuffers get
1175 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1176 * before the new state gets committed on the software side with
1177 * drm_atomic_helper_swap_state().
1179 * This scheme allows new atomic state updates to be prepared and
1180 * checked in parallel to the asynchronous completion of the previous
1181 * update. Which is important since compositors need to figure out the
1182 * composition of the next frame right after having submitted the
1186 drm_atomic_helper_wait_for_fences(dev, state);
1188 drm_atomic_helper_commit_modeset_disables(dev, state);
1190 drm_atomic_helper_commit_planes(dev, state, false);
1192 drm_atomic_helper_commit_modeset_enables(dev, state);
1194 drm_atomic_helper_wait_for_vblanks(dev, state);
1196 drm_atomic_helper_cleanup_planes(dev, state);
1198 drm_atomic_state_free(state);
1202 EXPORT_SYMBOL(drm_atomic_helper_commit);
1205 * DOC: implementing nonblocking commit
1207 * For now the atomic helpers don't support nonblocking commit directly. If
1208 * there is real need it could be added though, using the dma-buf fence
1209 * infrastructure for generic synchronization with outstanding rendering.
1211 * For now drivers have to implement nonblocking commit themselves, with the
1212 * following sequence being the recommended one:
1214 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1215 * which commit needs to call which can fail, so we want to run it first and
1218 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1219 * might be affected the new state update. This can be done by either cancelling
1220 * or flushing the work items, depending upon whether the driver can deal with
1221 * cancelled updates. Note that it is important to ensure that the framebuffer
1222 * cleanup is still done when cancelling.
1224 * For sufficient parallelism it is recommended to have a work item per crtc
1225 * (for updates which don't touch global state) and a global one. Then we only
1226 * need to synchronize with the crtc work items for changed crtcs and the global
1227 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1229 * 3. The software state is updated synchronously with
1230 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1231 * locks means concurrent callers never see inconsistent state. And doing this
1232 * while it's guaranteed that no relevant nonblocking worker runs means that
1233 * nonblocking workers do not need grab any locks. Actually they must not grab
1234 * locks, for otherwise the work flushing will deadlock.
1236 * 4. Schedule a work item to do all subsequent steps, using the split-out
1237 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1238 * then cleaning up the framebuffers after the old framebuffer is no longer
1243 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1245 * @state: atomic state object with new state structures
1247 * This function prepares plane state, specifically framebuffers, for the new
1248 * configuration. If any failure is encountered this function will call
1249 * ->cleanup_fb on any already successfully prepared framebuffer.
1252 * 0 on success, negative error code on failure.
1254 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1255 struct drm_atomic_state *state)
1257 struct drm_plane *plane;
1258 struct drm_plane_state *plane_state;
1261 for_each_plane_in_state(state, plane, plane_state, i) {
1262 const struct drm_plane_helper_funcs *funcs;
1264 funcs = plane->helper_private;
1266 if (funcs->prepare_fb) {
1267 ret = funcs->prepare_fb(plane, plane_state);
1276 for_each_plane_in_state(state, plane, plane_state, j) {
1277 const struct drm_plane_helper_funcs *funcs;
1282 funcs = plane->helper_private;
1284 if (funcs->cleanup_fb)
1285 funcs->cleanup_fb(plane, plane_state);
1291 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1293 bool plane_crtc_active(struct drm_plane_state *state)
1295 return state->crtc && state->crtc->state->active;
1299 * drm_atomic_helper_commit_planes - commit plane state
1301 * @old_state: atomic state object with old state structures
1302 * @active_only: Only commit on active CRTC if set
1304 * This function commits the new plane state using the plane and atomic helper
1305 * functions for planes and crtcs. It assumes that the atomic state has already
1306 * been pushed into the relevant object state pointers, since this step can no
1309 * It still requires the global state object @old_state to know which planes and
1310 * crtcs need to be updated though.
1312 * Note that this function does all plane updates across all CRTCs in one step.
1313 * If the hardware can't support this approach look at
1314 * drm_atomic_helper_commit_planes_on_crtc() instead.
1316 * Plane parameters can be updated by applications while the associated CRTC is
1317 * disabled. The DRM/KMS core will store the parameters in the plane state,
1318 * which will be available to the driver when the CRTC is turned on. As a result
1319 * most drivers don't need to be immediately notified of plane updates for a
1322 * Unless otherwise needed, drivers are advised to set the @active_only
1323 * parameters to true in order not to receive plane update notifications related
1324 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1325 * driver code when the driver and/or hardware can't or just don't need to deal
1326 * with updates on disabled CRTCs, for example when supporting runtime PM.
1328 * The drm_atomic_helper_commit() default implementation only sets @active_only
1329 * to false to most closely match the behaviour of the legacy helpers. This should
1330 * not be copied blindly by drivers.
1332 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1333 struct drm_atomic_state *old_state,
1336 struct drm_crtc *crtc;
1337 struct drm_crtc_state *old_crtc_state;
1338 struct drm_plane *plane;
1339 struct drm_plane_state *old_plane_state;
1342 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1343 const struct drm_crtc_helper_funcs *funcs;
1345 funcs = crtc->helper_private;
1347 if (!funcs || !funcs->atomic_begin)
1350 if (active_only && !crtc->state->active)
1353 funcs->atomic_begin(crtc, old_crtc_state);
1356 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1357 const struct drm_plane_helper_funcs *funcs;
1360 funcs = plane->helper_private;
1365 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1369 * Skip planes related to inactive CRTCs. If the plane
1370 * is enabled use the state of the current CRTC. If the
1371 * plane is being disabled use the state of the old
1372 * CRTC to avoid skipping planes being disabled on an
1375 if (!disabling && !plane_crtc_active(plane->state))
1377 if (disabling && !plane_crtc_active(old_plane_state))
1382 * Special-case disabling the plane if drivers support it.
1384 if (disabling && funcs->atomic_disable)
1385 funcs->atomic_disable(plane, old_plane_state);
1386 else if (plane->state->crtc || disabling)
1387 funcs->atomic_update(plane, old_plane_state);
1390 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1391 const struct drm_crtc_helper_funcs *funcs;
1393 funcs = crtc->helper_private;
1395 if (!funcs || !funcs->atomic_flush)
1398 if (active_only && !crtc->state->active)
1401 funcs->atomic_flush(crtc, old_crtc_state);
1404 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1407 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1408 * @old_crtc_state: atomic state object with the old crtc state
1410 * This function commits the new plane state using the plane and atomic helper
1411 * functions for planes on the specific crtc. It assumes that the atomic state
1412 * has already been pushed into the relevant object state pointers, since this
1413 * step can no longer fail.
1415 * This function is useful when plane updates should be done crtc-by-crtc
1416 * instead of one global step like drm_atomic_helper_commit_planes() does.
1418 * This function can only be savely used when planes are not allowed to move
1419 * between different CRTCs because this function doesn't handle inter-CRTC
1420 * depencies. Callers need to ensure that either no such depencies exist,
1421 * resolve them through ordering of commit calls or through some other means.
1424 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1426 const struct drm_crtc_helper_funcs *crtc_funcs;
1427 struct drm_crtc *crtc = old_crtc_state->crtc;
1428 struct drm_atomic_state *old_state = old_crtc_state->state;
1429 struct drm_plane *plane;
1430 unsigned plane_mask;
1432 plane_mask = old_crtc_state->plane_mask;
1433 plane_mask |= crtc->state->plane_mask;
1435 crtc_funcs = crtc->helper_private;
1436 if (crtc_funcs && crtc_funcs->atomic_begin)
1437 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1439 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1440 struct drm_plane_state *old_plane_state =
1441 drm_atomic_get_existing_plane_state(old_state, plane);
1442 const struct drm_plane_helper_funcs *plane_funcs;
1444 plane_funcs = plane->helper_private;
1446 if (!old_plane_state || !plane_funcs)
1449 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1451 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1452 plane_funcs->atomic_disable)
1453 plane_funcs->atomic_disable(plane, old_plane_state);
1454 else if (plane->state->crtc ||
1455 drm_atomic_plane_disabling(plane, old_plane_state))
1456 plane_funcs->atomic_update(plane, old_plane_state);
1459 if (crtc_funcs && crtc_funcs->atomic_flush)
1460 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1462 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1465 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1467 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1469 * Disables all planes associated with the given CRTC. This can be
1470 * used for instance in the CRTC helper disable callback to disable
1471 * all planes before shutting down the display pipeline.
1473 * If the atomic-parameter is set the function calls the CRTC's
1474 * atomic_begin hook before and atomic_flush hook after disabling the
1477 * It is a bug to call this function without having implemented the
1478 * ->atomic_disable() plane hook.
1480 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1483 const struct drm_crtc_helper_funcs *crtc_funcs =
1484 crtc->helper_private;
1485 struct drm_plane *plane;
1487 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1488 crtc_funcs->atomic_begin(crtc, NULL);
1490 drm_for_each_plane(plane, crtc->dev) {
1491 const struct drm_plane_helper_funcs *plane_funcs =
1492 plane->helper_private;
1494 if (plane->state->crtc != crtc || !plane_funcs)
1497 WARN_ON(!plane_funcs->atomic_disable);
1498 if (plane_funcs->atomic_disable)
1499 plane_funcs->atomic_disable(plane, NULL);
1502 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1503 crtc_funcs->atomic_flush(crtc, NULL);
1505 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1508 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1510 * @old_state: atomic state object with old state structures
1512 * This function cleans up plane state, specifically framebuffers, from the old
1513 * configuration. Hence the old configuration must be perserved in @old_state to
1514 * be able to call this function.
1516 * This function must also be called on the new state when the atomic update
1517 * fails at any point after calling drm_atomic_helper_prepare_planes().
1519 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1520 struct drm_atomic_state *old_state)
1522 struct drm_plane *plane;
1523 struct drm_plane_state *plane_state;
1526 for_each_plane_in_state(old_state, plane, plane_state, i) {
1527 const struct drm_plane_helper_funcs *funcs;
1529 funcs = plane->helper_private;
1531 if (funcs->cleanup_fb)
1532 funcs->cleanup_fb(plane, plane_state);
1535 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1538 * drm_atomic_helper_swap_state - store atomic state into current sw state
1540 * @state: atomic state
1542 * This function stores the atomic state into the current state pointers in all
1543 * driver objects. It should be called after all failing steps have been done
1544 * and succeeded, but before the actual hardware state is committed.
1546 * For cleanup and error recovery the current state for all changed objects will
1547 * be swaped into @state.
1549 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1551 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1553 * 2. Do any other steps that might fail.
1555 * 3. Put the staged state into the current state pointers with this function.
1557 * 4. Actually commit the hardware state.
1559 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1560 * contains the old state. Also do any other cleanup required with that state.
1562 void drm_atomic_helper_swap_state(struct drm_device *dev,
1563 struct drm_atomic_state *state)
1566 struct drm_connector *connector;
1567 struct drm_connector_state *conn_state;
1568 struct drm_crtc *crtc;
1569 struct drm_crtc_state *crtc_state;
1570 struct drm_plane *plane;
1571 struct drm_plane_state *plane_state;
1573 for_each_connector_in_state(state, connector, conn_state, i) {
1574 connector->state->state = state;
1575 swap(state->connectors[i].state, connector->state);
1576 connector->state->state = NULL;
1579 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1580 crtc->state->state = state;
1581 swap(state->crtc_states[i], crtc->state);
1582 crtc->state->state = NULL;
1585 for_each_plane_in_state(state, plane, plane_state, i) {
1586 plane->state->state = state;
1587 swap(state->plane_states[i], plane->state);
1588 plane->state->state = NULL;
1591 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1594 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1595 * @plane: plane object to update
1596 * @crtc: owning CRTC of owning plane
1597 * @fb: framebuffer to flip onto plane
1598 * @crtc_x: x offset of primary plane on crtc
1599 * @crtc_y: y offset of primary plane on crtc
1600 * @crtc_w: width of primary plane rectangle on crtc
1601 * @crtc_h: height of primary plane rectangle on crtc
1602 * @src_x: x offset of @fb for panning
1603 * @src_y: y offset of @fb for panning
1604 * @src_w: width of source rectangle in @fb
1605 * @src_h: height of source rectangle in @fb
1607 * Provides a default plane update handler using the atomic driver interface.
1610 * Zero on success, error code on failure
1612 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1613 struct drm_crtc *crtc,
1614 struct drm_framebuffer *fb,
1615 int crtc_x, int crtc_y,
1616 unsigned int crtc_w, unsigned int crtc_h,
1617 uint32_t src_x, uint32_t src_y,
1618 uint32_t src_w, uint32_t src_h)
1620 struct drm_atomic_state *state;
1621 struct drm_plane_state *plane_state;
1624 state = drm_atomic_state_alloc(plane->dev);
1628 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1630 plane_state = drm_atomic_get_plane_state(state, plane);
1631 if (IS_ERR(plane_state)) {
1632 ret = PTR_ERR(plane_state);
1636 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1639 drm_atomic_set_fb_for_plane(plane_state, fb);
1640 plane_state->crtc_x = crtc_x;
1641 plane_state->crtc_y = crtc_y;
1642 plane_state->crtc_w = crtc_w;
1643 plane_state->crtc_h = crtc_h;
1644 plane_state->src_x = src_x;
1645 plane_state->src_y = src_y;
1646 plane_state->src_w = src_w;
1647 plane_state->src_h = src_h;
1649 if (plane == crtc->cursor)
1650 state->legacy_cursor_update = true;
1652 ret = drm_atomic_commit(state);
1656 /* Driver takes ownership of state on successful commit. */
1659 if (ret == -EDEADLK)
1662 drm_atomic_state_free(state);
1666 drm_atomic_state_clear(state);
1667 drm_atomic_legacy_backoff(state);
1670 * Someone might have exchanged the framebuffer while we dropped locks
1671 * in the backoff code. We need to fix up the fb refcount tracking the
1674 plane->old_fb = plane->fb;
1678 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1681 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1682 * @plane: plane to disable
1684 * Provides a default plane disable handler using the atomic driver interface.
1687 * Zero on success, error code on failure
1689 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1691 struct drm_atomic_state *state;
1692 struct drm_plane_state *plane_state;
1696 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1697 * acquire context. The real fix will be to wire the acquire ctx through
1698 * everywhere we need it, but meanwhile prevent chaos by just skipping
1699 * this noop. The critical case is the cursor ioctls which a) only grab
1700 * crtc/cursor-plane locks (so we need the crtc to get at the right
1701 * acquire context) and b) can try to disable the plane multiple times.
1706 state = drm_atomic_state_alloc(plane->dev);
1710 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1712 plane_state = drm_atomic_get_plane_state(state, plane);
1713 if (IS_ERR(plane_state)) {
1714 ret = PTR_ERR(plane_state);
1718 if (plane_state->crtc && (plane == plane->crtc->cursor))
1719 plane_state->state->legacy_cursor_update = true;
1721 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1725 ret = drm_atomic_commit(state);
1729 /* Driver takes ownership of state on successful commit. */
1732 if (ret == -EDEADLK)
1735 drm_atomic_state_free(state);
1739 drm_atomic_state_clear(state);
1740 drm_atomic_legacy_backoff(state);
1743 * Someone might have exchanged the framebuffer while we dropped locks
1744 * in the backoff code. We need to fix up the fb refcount tracking the
1747 plane->old_fb = plane->fb;
1751 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1753 /* just used from fb-helper and atomic-helper: */
1754 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1755 struct drm_plane_state *plane_state)
1759 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1763 drm_atomic_set_fb_for_plane(plane_state, NULL);
1764 plane_state->crtc_x = 0;
1765 plane_state->crtc_y = 0;
1766 plane_state->crtc_w = 0;
1767 plane_state->crtc_h = 0;
1768 plane_state->src_x = 0;
1769 plane_state->src_y = 0;
1770 plane_state->src_w = 0;
1771 plane_state->src_h = 0;
1776 static int update_output_state(struct drm_atomic_state *state,
1777 struct drm_mode_set *set)
1779 struct drm_device *dev = set->crtc->dev;
1780 struct drm_crtc *crtc;
1781 struct drm_crtc_state *crtc_state;
1782 struct drm_connector *connector;
1783 struct drm_connector_state *conn_state;
1786 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1787 state->acquire_ctx);
1791 /* First disable all connectors on the target crtc. */
1792 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1796 for_each_connector_in_state(state, connector, conn_state, i) {
1797 if (conn_state->crtc == set->crtc) {
1798 ret = drm_atomic_set_crtc_for_connector(conn_state,
1805 /* Then set all connectors from set->connectors on the target crtc */
1806 for (i = 0; i < set->num_connectors; i++) {
1807 conn_state = drm_atomic_get_connector_state(state,
1808 set->connectors[i]);
1809 if (IS_ERR(conn_state))
1810 return PTR_ERR(conn_state);
1812 ret = drm_atomic_set_crtc_for_connector(conn_state,
1818 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1819 /* Don't update ->enable for the CRTC in the set_config request,
1820 * since a mismatch would indicate a bug in the upper layers.
1821 * The actual modeset code later on will catch any
1822 * inconsistencies here. */
1823 if (crtc == set->crtc)
1826 if (!crtc_state->connector_mask) {
1827 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1832 crtc_state->active = false;
1840 * drm_atomic_helper_set_config - set a new config from userspace
1841 * @set: mode set configuration
1843 * Provides a default crtc set_config handler using the atomic driver interface.
1846 * Returns 0 on success, negative errno numbers on failure.
1848 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1850 struct drm_atomic_state *state;
1851 struct drm_crtc *crtc = set->crtc;
1854 state = drm_atomic_state_alloc(crtc->dev);
1858 state->legacy_set_config = true;
1859 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1861 ret = __drm_atomic_helper_set_config(set, state);
1865 ret = drm_atomic_commit(state);
1869 /* Driver takes ownership of state on successful commit. */
1872 if (ret == -EDEADLK)
1875 drm_atomic_state_free(state);
1879 drm_atomic_state_clear(state);
1880 drm_atomic_legacy_backoff(state);
1883 * Someone might have exchanged the framebuffer while we dropped locks
1884 * in the backoff code. We need to fix up the fb refcount tracking the
1887 crtc->primary->old_fb = crtc->primary->fb;
1891 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1893 /* just used from fb-helper and atomic-helper: */
1894 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1895 struct drm_atomic_state *state)
1897 struct drm_crtc_state *crtc_state;
1898 struct drm_plane_state *primary_state;
1899 struct drm_crtc *crtc = set->crtc;
1900 int hdisplay, vdisplay;
1903 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1904 if (IS_ERR(crtc_state))
1905 return PTR_ERR(crtc_state);
1907 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1908 if (IS_ERR(primary_state))
1909 return PTR_ERR(primary_state);
1913 WARN_ON(set->num_connectors);
1915 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1919 crtc_state->active = false;
1921 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1925 drm_atomic_set_fb_for_plane(primary_state, NULL);
1931 WARN_ON(!set->num_connectors);
1933 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1937 crtc_state->active = true;
1939 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1943 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1945 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1946 primary_state->crtc_x = 0;
1947 primary_state->crtc_y = 0;
1948 primary_state->crtc_w = hdisplay;
1949 primary_state->crtc_h = vdisplay;
1950 primary_state->src_x = set->x << 16;
1951 primary_state->src_y = set->y << 16;
1952 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1953 primary_state->src_w = vdisplay << 16;
1954 primary_state->src_h = hdisplay << 16;
1956 primary_state->src_w = hdisplay << 16;
1957 primary_state->src_h = vdisplay << 16;
1961 ret = update_output_state(state, set);
1969 * drm_atomic_helper_disable_all - disable all currently active outputs
1971 * @ctx: lock acquisition context
1973 * Loops through all connectors, finding those that aren't turned off and then
1974 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1975 * that they are connected to.
1977 * This is used for example in suspend/resume to disable all currently active
1978 * functions when suspending.
1980 * Note that if callers haven't already acquired all modeset locks this might
1981 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1984 * 0 on success or a negative error code on failure.
1987 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1989 int drm_atomic_helper_disable_all(struct drm_device *dev,
1990 struct drm_modeset_acquire_ctx *ctx)
1992 struct drm_atomic_state *state;
1993 struct drm_connector *conn;
1996 state = drm_atomic_state_alloc(dev);
2000 state->acquire_ctx = ctx;
2002 drm_for_each_connector(conn, dev) {
2003 struct drm_crtc *crtc = conn->state->crtc;
2004 struct drm_crtc_state *crtc_state;
2006 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2009 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2010 if (IS_ERR(crtc_state)) {
2011 err = PTR_ERR(crtc_state);
2015 crtc_state->active = false;
2018 err = drm_atomic_commit(state);
2022 drm_atomic_state_free(state);
2026 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2029 * drm_atomic_helper_suspend - subsystem-level suspend helper
2032 * Duplicates the current atomic state, disables all active outputs and then
2033 * returns a pointer to the original atomic state to the caller. Drivers can
2034 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2035 * restore the output configuration that was active at the time the system
2038 * Note that it is potentially unsafe to use this. The atomic state object
2039 * returned by this function is assumed to be persistent. Drivers must ensure
2040 * that this holds true. Before calling this function, drivers must make sure
2041 * to suspend fbdev emulation so that nothing can be using the device.
2044 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2045 * encoded error code on failure. Drivers should store the returned atomic
2046 * state object and pass it to the drm_atomic_helper_resume() helper upon
2050 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2051 * drm_atomic_helper_resume()
2053 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2055 struct drm_modeset_acquire_ctx ctx;
2056 struct drm_atomic_state *state;
2059 drm_modeset_acquire_init(&ctx, 0);
2062 err = drm_modeset_lock_all_ctx(dev, &ctx);
2064 state = ERR_PTR(err);
2068 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2072 err = drm_atomic_helper_disable_all(dev, &ctx);
2074 drm_atomic_state_free(state);
2075 state = ERR_PTR(err);
2080 if (PTR_ERR(state) == -EDEADLK) {
2081 drm_modeset_backoff(&ctx);
2085 drm_modeset_drop_locks(&ctx);
2086 drm_modeset_acquire_fini(&ctx);
2089 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2092 * drm_atomic_helper_resume - subsystem-level resume helper
2094 * @state: atomic state to resume to
2096 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2097 * grabs all modeset locks and commits the atomic state object. This can be
2098 * used in conjunction with the drm_atomic_helper_suspend() helper to
2099 * implement suspend/resume for drivers that support atomic mode-setting.
2102 * 0 on success or a negative error code on failure.
2105 * drm_atomic_helper_suspend()
2107 int drm_atomic_helper_resume(struct drm_device *dev,
2108 struct drm_atomic_state *state)
2110 struct drm_mode_config *config = &dev->mode_config;
2113 drm_mode_config_reset(dev);
2114 drm_modeset_lock_all(dev);
2115 state->acquire_ctx = config->acquire_ctx;
2116 err = drm_atomic_commit(state);
2117 drm_modeset_unlock_all(dev);
2121 EXPORT_SYMBOL(drm_atomic_helper_resume);
2124 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2126 * @property: DRM property
2127 * @val: value of property
2129 * Provides a default crtc set_property handler using the atomic driver
2133 * Zero on success, error code on failure
2136 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2137 struct drm_property *property,
2140 struct drm_atomic_state *state;
2141 struct drm_crtc_state *crtc_state;
2144 state = drm_atomic_state_alloc(crtc->dev);
2148 /* ->set_property is always called with all locks held. */
2149 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2151 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2152 if (IS_ERR(crtc_state)) {
2153 ret = PTR_ERR(crtc_state);
2157 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2162 ret = drm_atomic_commit(state);
2166 /* Driver takes ownership of state on successful commit. */
2169 if (ret == -EDEADLK)
2172 drm_atomic_state_free(state);
2176 drm_atomic_state_clear(state);
2177 drm_atomic_legacy_backoff(state);
2181 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2184 * drm_atomic_helper_plane_set_property - helper for plane properties
2186 * @property: DRM property
2187 * @val: value of property
2189 * Provides a default plane set_property handler using the atomic driver
2193 * Zero on success, error code on failure
2196 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2197 struct drm_property *property,
2200 struct drm_atomic_state *state;
2201 struct drm_plane_state *plane_state;
2204 state = drm_atomic_state_alloc(plane->dev);
2208 /* ->set_property is always called with all locks held. */
2209 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2211 plane_state = drm_atomic_get_plane_state(state, plane);
2212 if (IS_ERR(plane_state)) {
2213 ret = PTR_ERR(plane_state);
2217 ret = drm_atomic_plane_set_property(plane, plane_state,
2222 ret = drm_atomic_commit(state);
2226 /* Driver takes ownership of state on successful commit. */
2229 if (ret == -EDEADLK)
2232 drm_atomic_state_free(state);
2236 drm_atomic_state_clear(state);
2237 drm_atomic_legacy_backoff(state);
2241 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2244 * drm_atomic_helper_connector_set_property - helper for connector properties
2245 * @connector: DRM connector
2246 * @property: DRM property
2247 * @val: value of property
2249 * Provides a default connector set_property handler using the atomic driver
2253 * Zero on success, error code on failure
2256 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2257 struct drm_property *property,
2260 struct drm_atomic_state *state;
2261 struct drm_connector_state *connector_state;
2264 state = drm_atomic_state_alloc(connector->dev);
2268 /* ->set_property is always called with all locks held. */
2269 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2271 connector_state = drm_atomic_get_connector_state(state, connector);
2272 if (IS_ERR(connector_state)) {
2273 ret = PTR_ERR(connector_state);
2277 ret = drm_atomic_connector_set_property(connector, connector_state,
2282 ret = drm_atomic_commit(state);
2286 /* Driver takes ownership of state on successful commit. */
2289 if (ret == -EDEADLK)
2292 drm_atomic_state_free(state);
2296 drm_atomic_state_clear(state);
2297 drm_atomic_legacy_backoff(state);
2301 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2304 * drm_atomic_helper_page_flip - execute a legacy page flip
2306 * @fb: DRM framebuffer
2307 * @event: optional DRM event to signal upon completion
2308 * @flags: flip flags for non-vblank sync'ed updates
2310 * Provides a default page flip implementation using the atomic driver interface.
2312 * Note that for now so called async page flips (i.e. updates which are not
2313 * synchronized to vblank) are not supported, since the atomic interfaces have
2314 * no provisions for this yet.
2317 * Returns 0 on success, negative errno numbers on failure.
2319 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2320 struct drm_framebuffer *fb,
2321 struct drm_pending_vblank_event *event,
2324 struct drm_plane *plane = crtc->primary;
2325 struct drm_atomic_state *state;
2326 struct drm_plane_state *plane_state;
2327 struct drm_crtc_state *crtc_state;
2330 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2333 state = drm_atomic_state_alloc(plane->dev);
2337 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2339 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2340 if (IS_ERR(crtc_state)) {
2341 ret = PTR_ERR(crtc_state);
2344 crtc_state->event = event;
2346 plane_state = drm_atomic_get_plane_state(state, plane);
2347 if (IS_ERR(plane_state)) {
2348 ret = PTR_ERR(plane_state);
2352 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2355 drm_atomic_set_fb_for_plane(plane_state, fb);
2357 /* Make sure we don't accidentally do a full modeset. */
2358 state->allow_modeset = false;
2359 if (!crtc_state->active) {
2360 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2366 ret = drm_atomic_nonblocking_commit(state);
2370 /* Driver takes ownership of state on successful commit. */
2373 if (ret == -EDEADLK)
2376 drm_atomic_state_free(state);
2380 drm_atomic_state_clear(state);
2381 drm_atomic_legacy_backoff(state);
2384 * Someone might have exchanged the framebuffer while we dropped locks
2385 * in the backoff code. We need to fix up the fb refcount tracking the
2388 plane->old_fb = plane->fb;
2392 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2395 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2396 * @connector: affected connector
2399 * This is the main helper function provided by the atomic helper framework for
2400 * implementing the legacy DPMS connector interface. It computes the new desired
2401 * ->active state for the corresponding CRTC (if the connector is enabled) and
2405 * Returns 0 on success, negative errno numbers on failure.
2407 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2410 struct drm_mode_config *config = &connector->dev->mode_config;
2411 struct drm_atomic_state *state;
2412 struct drm_crtc_state *crtc_state;
2413 struct drm_crtc *crtc;
2414 struct drm_connector *tmp_connector;
2416 bool active = false;
2417 int old_mode = connector->dpms;
2419 if (mode != DRM_MODE_DPMS_ON)
2420 mode = DRM_MODE_DPMS_OFF;
2422 connector->dpms = mode;
2423 crtc = connector->state->crtc;
2428 state = drm_atomic_state_alloc(connector->dev);
2432 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2434 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2435 if (IS_ERR(crtc_state)) {
2436 ret = PTR_ERR(crtc_state);
2440 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2442 drm_for_each_connector(tmp_connector, connector->dev) {
2443 if (tmp_connector->state->crtc != crtc)
2446 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2451 crtc_state->active = active;
2453 ret = drm_atomic_commit(state);
2457 /* Driver takes ownership of state on successful commit. */
2460 if (ret == -EDEADLK)
2463 connector->dpms = old_mode;
2464 drm_atomic_state_free(state);
2468 drm_atomic_state_clear(state);
2469 drm_atomic_legacy_backoff(state);
2473 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2476 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2477 * ->best_encoder callback
2478 * @connector: Connector control structure
2480 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2481 * connectors that support exactly 1 encoder, statically determined at driver
2484 struct drm_encoder *
2485 drm_atomic_helper_best_encoder(struct drm_connector *connector)
2487 WARN_ON(connector->encoder_ids[1]);
2488 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
2490 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
2493 * DOC: atomic state reset and initialization
2495 * Both the drm core and the atomic helpers assume that there is always the full
2496 * and correct atomic software state for all connectors, CRTCs and planes
2497 * available. Which is a bit a problem on driver load and also after system
2498 * suspend. One way to solve this is to have a hardware state read-out
2499 * infrastructure which reconstructs the full software state (e.g. the i915
2502 * The simpler solution is to just reset the software state to everything off,
2503 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2504 * the atomic helpers provide default reset implementations for all hooks.
2506 * On the upside the precise state tracking of atomic simplifies system suspend
2507 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2508 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2509 * For other drivers the building blocks are split out, see the documentation
2510 * for these functions.
2514 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2517 * Resets the atomic state for @crtc by freeing the state pointer (which might
2518 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2520 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2523 __drm_atomic_helper_crtc_destroy_state(crtc->state);
2526 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2529 crtc->state->crtc = crtc;
2531 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2534 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2535 * @crtc: CRTC object
2536 * @state: atomic CRTC state
2538 * Copies atomic state from a CRTC's current state and resets inferred values.
2539 * This is useful for drivers that subclass the CRTC state.
2541 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2542 struct drm_crtc_state *state)
2544 memcpy(state, crtc->state, sizeof(*state));
2546 if (state->mode_blob)
2547 drm_property_reference_blob(state->mode_blob);
2548 if (state->degamma_lut)
2549 drm_property_reference_blob(state->degamma_lut);
2551 drm_property_reference_blob(state->ctm);
2552 if (state->gamma_lut)
2553 drm_property_reference_blob(state->gamma_lut);
2554 state->mode_changed = false;
2555 state->active_changed = false;
2556 state->planes_changed = false;
2557 state->connectors_changed = false;
2558 state->color_mgmt_changed = false;
2559 state->event = NULL;
2561 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2564 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2567 * Default CRTC state duplicate hook for drivers which don't have their own
2568 * subclassed CRTC state structure.
2570 struct drm_crtc_state *
2571 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2573 struct drm_crtc_state *state;
2575 if (WARN_ON(!crtc->state))
2578 state = kmalloc(sizeof(*state), GFP_KERNEL);
2580 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2584 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2587 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2588 * @state: CRTC state object to release
2590 * Releases all resources stored in the CRTC state without actually freeing
2591 * the memory of the CRTC state. This is useful for drivers that subclass the
2594 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
2596 drm_property_unreference_blob(state->mode_blob);
2597 drm_property_unreference_blob(state->degamma_lut);
2598 drm_property_unreference_blob(state->ctm);
2599 drm_property_unreference_blob(state->gamma_lut);
2601 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2604 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2606 * @state: CRTC state object to release
2608 * Default CRTC state destroy hook for drivers which don't have their own
2609 * subclassed CRTC state structure.
2611 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2612 struct drm_crtc_state *state)
2614 __drm_atomic_helper_crtc_destroy_state(state);
2617 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2620 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2623 * Resets the atomic state for @plane by freeing the state pointer (which might
2624 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2626 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2629 __drm_atomic_helper_plane_destroy_state(plane->state);
2631 kfree(plane->state);
2632 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2635 plane->state->plane = plane;
2636 plane->state->rotation = BIT(DRM_ROTATE_0);
2639 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2642 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2643 * @plane: plane object
2644 * @state: atomic plane state
2646 * Copies atomic state from a plane's current state. This is useful for
2647 * drivers that subclass the plane state.
2649 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2650 struct drm_plane_state *state)
2652 memcpy(state, plane->state, sizeof(*state));
2655 drm_framebuffer_reference(state->fb);
2657 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2660 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2663 * Default plane state duplicate hook for drivers which don't have their own
2664 * subclassed plane state structure.
2666 struct drm_plane_state *
2667 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2669 struct drm_plane_state *state;
2671 if (WARN_ON(!plane->state))
2674 state = kmalloc(sizeof(*state), GFP_KERNEL);
2676 __drm_atomic_helper_plane_duplicate_state(plane, state);
2680 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2683 * __drm_atomic_helper_plane_destroy_state - release plane state
2684 * @state: plane state object to release
2686 * Releases all resources stored in the plane state without actually freeing
2687 * the memory of the plane state. This is useful for drivers that subclass the
2690 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
2693 drm_framebuffer_unreference(state->fb);
2695 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2698 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2700 * @state: plane state object to release
2702 * Default plane state destroy hook for drivers which don't have their own
2703 * subclassed plane state structure.
2705 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2706 struct drm_plane_state *state)
2708 __drm_atomic_helper_plane_destroy_state(state);
2711 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2714 * __drm_atomic_helper_connector_reset - reset state on connector
2715 * @connector: drm connector
2716 * @conn_state: connector state to assign
2718 * Initializes the newly allocated @conn_state and assigns it to
2719 * #connector ->state, usually required when initializing the drivers
2720 * or when called from the ->reset hook.
2722 * This is useful for drivers that subclass the connector state.
2725 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2726 struct drm_connector_state *conn_state)
2729 conn_state->connector = connector;
2731 connector->state = conn_state;
2733 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2736 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2737 * @connector: drm connector
2739 * Resets the atomic state for @connector by freeing the state pointer (which
2740 * might be NULL, e.g. at driver load time) and allocating a new empty state
2743 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2745 struct drm_connector_state *conn_state =
2746 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2748 if (connector->state)
2749 __drm_atomic_helper_connector_destroy_state(connector->state);
2751 kfree(connector->state);
2752 __drm_atomic_helper_connector_reset(connector, conn_state);
2754 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2757 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2758 * @connector: connector object
2759 * @state: atomic connector state
2761 * Copies atomic state from a connector's current state. This is useful for
2762 * drivers that subclass the connector state.
2765 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2766 struct drm_connector_state *state)
2768 memcpy(state, connector->state, sizeof(*state));
2770 drm_connector_reference(connector);
2772 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2775 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2776 * @connector: drm connector
2778 * Default connector state duplicate hook for drivers which don't have their own
2779 * subclassed connector state structure.
2781 struct drm_connector_state *
2782 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2784 struct drm_connector_state *state;
2786 if (WARN_ON(!connector->state))
2789 state = kmalloc(sizeof(*state), GFP_KERNEL);
2791 __drm_atomic_helper_connector_duplicate_state(connector, state);
2795 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2798 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2800 * @ctx: lock acquisition context
2802 * Makes a copy of the current atomic state by looping over all objects and
2803 * duplicating their respective states. This is used for example by suspend/
2804 * resume support code to save the state prior to suspend such that it can
2805 * be restored upon resume.
2807 * Note that this treats atomic state as persistent between save and restore.
2808 * Drivers must make sure that this is possible and won't result in confusion
2809 * or erroneous behaviour.
2811 * Note that if callers haven't already acquired all modeset locks this might
2812 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2815 * A pointer to the copy of the atomic state object on success or an
2816 * ERR_PTR()-encoded error code on failure.
2819 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2821 struct drm_atomic_state *
2822 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2823 struct drm_modeset_acquire_ctx *ctx)
2825 struct drm_atomic_state *state;
2826 struct drm_connector *conn;
2827 struct drm_plane *plane;
2828 struct drm_crtc *crtc;
2831 state = drm_atomic_state_alloc(dev);
2833 return ERR_PTR(-ENOMEM);
2835 state->acquire_ctx = ctx;
2837 drm_for_each_crtc(crtc, dev) {
2838 struct drm_crtc_state *crtc_state;
2840 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2841 if (IS_ERR(crtc_state)) {
2842 err = PTR_ERR(crtc_state);
2847 drm_for_each_plane(plane, dev) {
2848 struct drm_plane_state *plane_state;
2850 plane_state = drm_atomic_get_plane_state(state, plane);
2851 if (IS_ERR(plane_state)) {
2852 err = PTR_ERR(plane_state);
2857 drm_for_each_connector(conn, dev) {
2858 struct drm_connector_state *conn_state;
2860 conn_state = drm_atomic_get_connector_state(state, conn);
2861 if (IS_ERR(conn_state)) {
2862 err = PTR_ERR(conn_state);
2867 /* clear the acquire context so that it isn't accidentally reused */
2868 state->acquire_ctx = NULL;
2872 drm_atomic_state_free(state);
2873 state = ERR_PTR(err);
2878 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2881 * __drm_atomic_helper_connector_destroy_state - release connector state
2882 * @state: connector state object to release
2884 * Releases all resources stored in the connector state without actually
2885 * freeing the memory of the connector state. This is useful for drivers that
2886 * subclass the connector state.
2889 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
2892 * This is currently a placeholder so that drivers that subclass the
2893 * state will automatically do the right thing if code is ever added
2897 drm_connector_unreference(state->connector);
2899 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2902 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2903 * @connector: drm connector
2904 * @state: connector state object to release
2906 * Default connector state destroy hook for drivers which don't have their own
2907 * subclassed connector state structure.
2909 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2910 struct drm_connector_state *state)
2912 __drm_atomic_helper_connector_destroy_state(state);
2915 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2918 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2919 * @crtc: CRTC object
2920 * @red: red correction table
2921 * @green: green correction table
2922 * @blue: green correction table
2924 * @size: size of the tables
2926 * Implements support for legacy gamma correction table for drivers
2927 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2930 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2931 u16 *red, u16 *green, u16 *blue,
2932 uint32_t start, uint32_t size)
2934 struct drm_device *dev = crtc->dev;
2935 struct drm_mode_config *config = &dev->mode_config;
2936 struct drm_atomic_state *state;
2937 struct drm_crtc_state *crtc_state;
2938 struct drm_property_blob *blob = NULL;
2939 struct drm_color_lut *blob_data;
2942 state = drm_atomic_state_alloc(crtc->dev);
2946 blob = drm_property_create_blob(dev,
2947 sizeof(struct drm_color_lut) * size,
2950 ret = PTR_ERR(blob);
2955 /* Prepare GAMMA_LUT with the legacy values. */
2956 blob_data = (struct drm_color_lut *) blob->data;
2957 for (i = 0; i < size; i++) {
2958 blob_data[i].red = red[i];
2959 blob_data[i].green = green[i];
2960 blob_data[i].blue = blue[i];
2963 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2965 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2966 if (IS_ERR(crtc_state)) {
2967 ret = PTR_ERR(crtc_state);
2971 /* Reset DEGAMMA_LUT and CTM properties. */
2972 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2973 config->degamma_lut_property, 0);
2977 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2978 config->ctm_property, 0);
2982 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2983 config->gamma_lut_property, blob->base.id);
2987 ret = drm_atomic_commit(state);
2991 /* Driver takes ownership of state on successful commit. */
2993 drm_property_unreference_blob(blob);
2997 if (ret == -EDEADLK)
3000 drm_atomic_state_free(state);
3001 drm_property_unreference_blob(blob);
3005 drm_atomic_state_clear(state);
3006 drm_atomic_legacy_backoff(state);
3010 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);