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,
303 else if (funcs->best_encoder)
304 new_encoder = funcs->best_encoder(connector);
306 new_encoder = drm_atomic_helper_best_encoder(connector);
309 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
315 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
316 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
317 new_encoder->base.id,
319 connector_state->crtc->base.id);
323 if (new_encoder == connector_state->best_encoder) {
324 set_best_encoder(state, connector_state, new_encoder);
326 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
329 new_encoder->base.id,
331 connector_state->crtc->base.id,
332 connector_state->crtc->name);
337 steal_encoder(state, new_encoder);
339 set_best_encoder(state, connector_state, new_encoder);
341 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
342 crtc_state->connectors_changed = true;
344 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
347 new_encoder->base.id,
349 connector_state->crtc->base.id,
350 connector_state->crtc->name);
356 mode_fixup(struct drm_atomic_state *state)
358 struct drm_crtc *crtc;
359 struct drm_crtc_state *crtc_state;
360 struct drm_connector *connector;
361 struct drm_connector_state *conn_state;
365 for_each_crtc_in_state(state, crtc, crtc_state, i) {
366 if (!crtc_state->mode_changed &&
367 !crtc_state->connectors_changed)
370 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
373 for_each_connector_in_state(state, connector, conn_state, i) {
374 const struct drm_encoder_helper_funcs *funcs;
375 struct drm_encoder *encoder;
377 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
379 if (!conn_state->crtc || !conn_state->best_encoder)
382 crtc_state = drm_atomic_get_existing_crtc_state(state,
386 * Each encoder has at most one connector (since we always steal
387 * it away), so we won't call ->mode_fixup twice.
389 encoder = conn_state->best_encoder;
390 funcs = encoder->helper_private;
392 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
393 &crtc_state->adjusted_mode);
395 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
399 if (funcs && funcs->atomic_check) {
400 ret = funcs->atomic_check(encoder, crtc_state,
403 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
404 encoder->base.id, encoder->name);
407 } else if (funcs && funcs->mode_fixup) {
408 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
409 &crtc_state->adjusted_mode);
411 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
412 encoder->base.id, encoder->name);
418 for_each_crtc_in_state(state, crtc, crtc_state, i) {
419 const struct drm_crtc_helper_funcs *funcs;
421 if (!crtc_state->enable)
424 if (!crtc_state->mode_changed &&
425 !crtc_state->connectors_changed)
428 funcs = crtc->helper_private;
429 if (!funcs->mode_fixup)
432 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
433 &crtc_state->adjusted_mode);
435 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
436 crtc->base.id, crtc->name);
445 * drm_atomic_helper_check_modeset - validate state object for modeset changes
447 * @state: the driver state object
449 * Check the state object to see if the requested state is physically possible.
450 * This does all the crtc and connector related computations for an atomic
451 * update and adds any additional connectors needed for full modesets and calls
452 * down into ->mode_fixup functions of the driver backend.
454 * crtc_state->mode_changed is set when the input mode is changed.
455 * crtc_state->connectors_changed is set when a connector is added or
456 * removed from the crtc.
457 * crtc_state->active_changed is set when crtc_state->active changes,
458 * which is used for dpms.
462 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
463 * plane update can't be done without a full modeset) _must_ call this function
464 * afterwards after that change. It is permitted to call this function multiple
465 * times for the same update, e.g. when the ->atomic_check functions depend upon
466 * the adjusted dotclock for fifo space allocation and watermark computation.
469 * Zero for success or -errno
472 drm_atomic_helper_check_modeset(struct drm_device *dev,
473 struct drm_atomic_state *state)
475 struct drm_crtc *crtc;
476 struct drm_crtc_state *crtc_state;
477 struct drm_connector *connector;
478 struct drm_connector_state *connector_state;
481 for_each_crtc_in_state(state, crtc, crtc_state, i) {
482 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
483 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
484 crtc->base.id, crtc->name);
485 crtc_state->mode_changed = true;
488 if (crtc->state->enable != crtc_state->enable) {
489 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
490 crtc->base.id, crtc->name);
493 * For clarity this assignment is done here, but
494 * enable == 0 is only true when there are no
495 * connectors and a NULL mode.
497 * The other way around is true as well. enable != 0
498 * iff connectors are attached and a mode is set.
500 crtc_state->mode_changed = true;
501 crtc_state->connectors_changed = true;
505 ret = handle_conflicting_encoders(state, state->legacy_set_config);
509 for_each_connector_in_state(state, connector, connector_state, i) {
511 * This only sets crtc->mode_changed for routing changes,
512 * drivers must set crtc->mode_changed themselves when connector
513 * properties need to be updated.
515 ret = update_connector_routing(state, connector,
522 * After all the routing has been prepared we need to add in any
523 * connector which is itself unchanged, but who's crtc changes it's
524 * configuration. This must be done before calling mode_fixup in case a
525 * crtc only changed its mode but has the same set of connectors.
527 for_each_crtc_in_state(state, crtc, crtc_state, i) {
528 bool has_connectors =
529 !!crtc_state->connector_mask;
532 * We must set ->active_changed after walking connectors for
533 * otherwise an update that only changes active would result in
534 * a full modeset because update_connector_routing force that.
536 if (crtc->state->active != crtc_state->active) {
537 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
538 crtc->base.id, crtc->name);
539 crtc_state->active_changed = true;
542 if (!drm_atomic_crtc_needs_modeset(crtc_state))
545 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
546 crtc->base.id, crtc->name,
547 crtc_state->enable ? 'y' : 'n',
548 crtc_state->active ? 'y' : 'n');
550 ret = drm_atomic_add_affected_connectors(state, crtc);
554 ret = drm_atomic_add_affected_planes(state, crtc);
558 if (crtc_state->enable != has_connectors) {
559 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
560 crtc->base.id, crtc->name);
566 return mode_fixup(state);
568 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
571 * drm_atomic_helper_check_planes - validate state object for planes changes
573 * @state: the driver state object
575 * Check the state object to see if the requested state is physically possible.
576 * This does all the plane update related checks using by calling into the
577 * ->atomic_check hooks provided by the driver.
579 * It also sets crtc_state->planes_changed to indicate that a crtc has
583 * Zero for success or -errno
586 drm_atomic_helper_check_planes(struct drm_device *dev,
587 struct drm_atomic_state *state)
589 struct drm_crtc *crtc;
590 struct drm_crtc_state *crtc_state;
591 struct drm_plane *plane;
592 struct drm_plane_state *plane_state;
595 for_each_plane_in_state(state, plane, plane_state, i) {
596 const struct drm_plane_helper_funcs *funcs;
598 funcs = plane->helper_private;
600 drm_atomic_helper_plane_changed(state, plane_state, plane);
602 if (!funcs || !funcs->atomic_check)
605 ret = funcs->atomic_check(plane, plane_state);
607 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
608 plane->base.id, plane->name);
613 for_each_crtc_in_state(state, crtc, crtc_state, i) {
614 const struct drm_crtc_helper_funcs *funcs;
616 funcs = crtc->helper_private;
618 if (!funcs || !funcs->atomic_check)
621 ret = funcs->atomic_check(crtc, crtc_state);
623 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
624 crtc->base.id, crtc->name);
631 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
634 * drm_atomic_helper_check - validate state object
636 * @state: the driver state object
638 * Check the state object to see if the requested state is physically possible.
639 * Only crtcs and planes have check callbacks, so for any additional (global)
640 * checking that a driver needs it can simply wrap that around this function.
641 * Drivers without such needs can directly use this as their ->atomic_check()
644 * This just wraps the two parts of the state checking for planes and modeset
645 * state in the default order: First it calls drm_atomic_helper_check_modeset()
646 * and then drm_atomic_helper_check_planes(). The assumption is that the
647 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
648 * e.g. properly compute watermarks.
651 * Zero for success or -errno
653 int drm_atomic_helper_check(struct drm_device *dev,
654 struct drm_atomic_state *state)
658 ret = drm_atomic_helper_check_modeset(dev, state);
662 ret = drm_atomic_helper_check_planes(dev, state);
668 EXPORT_SYMBOL(drm_atomic_helper_check);
671 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
673 struct drm_connector *connector;
674 struct drm_connector_state *old_conn_state;
675 struct drm_crtc *crtc;
676 struct drm_crtc_state *old_crtc_state;
679 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
680 const struct drm_encoder_helper_funcs *funcs;
681 struct drm_encoder *encoder;
683 /* Shut down everything that's in the changeset and currently
684 * still on. So need to check the old, saved state. */
685 if (!old_conn_state->crtc)
688 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
689 old_conn_state->crtc);
691 if (!old_crtc_state->active ||
692 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
695 encoder = old_conn_state->best_encoder;
697 /* We shouldn't get this far if we didn't previously have
698 * an encoder.. but WARN_ON() rather than explode.
700 if (WARN_ON(!encoder))
703 funcs = encoder->helper_private;
705 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
706 encoder->base.id, encoder->name);
709 * Each encoder has at most one connector (since we always steal
710 * it away), so we won't call disable hooks twice.
712 drm_bridge_disable(encoder->bridge);
714 /* Right function depends upon target state. */
716 if (connector->state->crtc && funcs->prepare)
717 funcs->prepare(encoder);
718 else if (funcs->disable)
719 funcs->disable(encoder);
720 else if (funcs->dpms)
721 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
724 drm_bridge_post_disable(encoder->bridge);
727 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
728 const struct drm_crtc_helper_funcs *funcs;
730 /* Shut down everything that needs a full modeset. */
731 if (!drm_atomic_crtc_needs_modeset(crtc->state))
734 if (!old_crtc_state->active)
737 funcs = crtc->helper_private;
739 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
740 crtc->base.id, crtc->name);
743 /* Right function depends upon target state. */
744 if (crtc->state->enable && funcs->prepare)
745 funcs->prepare(crtc);
746 else if (funcs->disable)
747 funcs->disable(crtc);
749 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
754 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
756 * @old_state: atomic state object with old state structures
758 * This function updates all the various legacy modeset state pointers in
759 * connectors, encoders and crtcs. It also updates the timestamping constants
760 * used for precise vblank timestamps by calling
761 * drm_calc_timestamping_constants().
763 * Drivers can use this for building their own atomic commit if they don't have
764 * a pure helper-based modeset implementation.
767 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
768 struct drm_atomic_state *old_state)
770 struct drm_connector *connector;
771 struct drm_connector_state *old_conn_state;
772 struct drm_crtc *crtc;
773 struct drm_crtc_state *old_crtc_state;
776 /* clear out existing links and update dpms */
777 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
778 if (connector->encoder) {
779 WARN_ON(!connector->encoder->crtc);
781 connector->encoder->crtc = NULL;
782 connector->encoder = NULL;
785 crtc = connector->state->crtc;
786 if ((!crtc && old_conn_state->crtc) ||
787 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
788 struct drm_property *dpms_prop =
789 dev->mode_config.dpms_property;
790 int mode = DRM_MODE_DPMS_OFF;
792 if (crtc && crtc->state->active)
793 mode = DRM_MODE_DPMS_ON;
795 connector->dpms = mode;
796 drm_object_property_set_value(&connector->base,
802 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
803 if (!connector->state->crtc)
806 if (WARN_ON(!connector->state->best_encoder))
809 connector->encoder = connector->state->best_encoder;
810 connector->encoder->crtc = connector->state->crtc;
813 /* set legacy state in the crtc structure */
814 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
815 struct drm_plane *primary = crtc->primary;
817 crtc->mode = crtc->state->mode;
818 crtc->enabled = crtc->state->enable;
820 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
821 primary->state->crtc == crtc) {
822 crtc->x = primary->state->src_x >> 16;
823 crtc->y = primary->state->src_y >> 16;
826 if (crtc->state->enable)
827 drm_calc_timestamping_constants(crtc,
828 &crtc->state->adjusted_mode);
831 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
834 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
836 struct drm_crtc *crtc;
837 struct drm_crtc_state *old_crtc_state;
838 struct drm_connector *connector;
839 struct drm_connector_state *old_conn_state;
842 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
843 const struct drm_crtc_helper_funcs *funcs;
845 if (!crtc->state->mode_changed)
848 funcs = crtc->helper_private;
850 if (crtc->state->enable && funcs->mode_set_nofb) {
851 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
852 crtc->base.id, crtc->name);
854 funcs->mode_set_nofb(crtc);
858 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
859 const struct drm_encoder_helper_funcs *funcs;
860 struct drm_crtc_state *new_crtc_state;
861 struct drm_encoder *encoder;
862 struct drm_display_mode *mode, *adjusted_mode;
864 if (!connector->state->best_encoder)
867 encoder = connector->state->best_encoder;
868 funcs = encoder->helper_private;
869 new_crtc_state = connector->state->crtc->state;
870 mode = &new_crtc_state->mode;
871 adjusted_mode = &new_crtc_state->adjusted_mode;
873 if (!new_crtc_state->mode_changed)
876 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
877 encoder->base.id, encoder->name);
880 * Each encoder has at most one connector (since we always steal
881 * it away), so we won't call mode_set hooks twice.
883 if (funcs && funcs->mode_set)
884 funcs->mode_set(encoder, mode, adjusted_mode);
886 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
891 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
893 * @old_state: atomic state object with old state structures
895 * This function shuts down all the outputs that need to be shut down and
896 * prepares them (if required) with the new mode.
898 * For compatibility with legacy crtc helpers this should be called before
899 * drm_atomic_helper_commit_planes(), which is what the default commit function
900 * does. But drivers with different needs can group the modeset commits together
901 * and do the plane commits at the end. This is useful for drivers doing runtime
902 * PM since planes updates then only happen when the CRTC is actually enabled.
904 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
905 struct drm_atomic_state *old_state)
907 disable_outputs(dev, old_state);
909 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
911 crtc_set_mode(dev, old_state);
913 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
916 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
918 * @old_state: atomic state object with old state structures
920 * This function enables all the outputs with the new configuration which had to
921 * be turned off for the update.
923 * For compatibility with legacy crtc helpers this should be called after
924 * drm_atomic_helper_commit_planes(), which is what the default commit function
925 * does. But drivers with different needs can group the modeset commits together
926 * and do the plane commits at the end. This is useful for drivers doing runtime
927 * PM since planes updates then only happen when the CRTC is actually enabled.
929 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
930 struct drm_atomic_state *old_state)
932 struct drm_crtc *crtc;
933 struct drm_crtc_state *old_crtc_state;
934 struct drm_connector *connector;
935 struct drm_connector_state *old_conn_state;
938 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
939 const struct drm_crtc_helper_funcs *funcs;
941 /* Need to filter out CRTCs where only planes change. */
942 if (!drm_atomic_crtc_needs_modeset(crtc->state))
945 if (!crtc->state->active)
948 funcs = crtc->helper_private;
950 if (crtc->state->enable) {
951 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
952 crtc->base.id, crtc->name);
961 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
962 const struct drm_encoder_helper_funcs *funcs;
963 struct drm_encoder *encoder;
965 if (!connector->state->best_encoder)
968 if (!connector->state->crtc->state->active ||
969 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
972 encoder = connector->state->best_encoder;
973 funcs = encoder->helper_private;
975 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
976 encoder->base.id, encoder->name);
979 * Each encoder has at most one connector (since we always steal
980 * it away), so we won't call enable hooks twice.
982 drm_bridge_pre_enable(encoder->bridge);
986 funcs->enable(encoder);
987 else if (funcs->commit)
988 funcs->commit(encoder);
991 drm_bridge_enable(encoder->bridge);
994 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
997 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
999 * @state: atomic state object with old state structures
1001 * For implicit sync, driver should fish the exclusive fence out from the
1002 * incoming fb's and stash it in the drm_plane_state. This is called after
1003 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1004 * just uses the atomic state to find the changed planes)
1006 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1007 struct drm_atomic_state *state)
1009 struct drm_plane *plane;
1010 struct drm_plane_state *plane_state;
1013 for_each_plane_in_state(state, plane, plane_state, i) {
1014 if (!plane->state->fence)
1017 WARN_ON(!plane->state->fb);
1019 fence_wait(plane->state->fence, false);
1020 fence_put(plane->state->fence);
1021 plane->state->fence = NULL;
1024 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1027 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1029 * @old_state: atomic state object with old state structures
1032 * Checks whether the framebuffer used for this CRTC changes as a result of
1033 * the atomic update. This is useful for drivers which cannot use
1034 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1038 * true if the framebuffer changed.
1040 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1041 struct drm_atomic_state *old_state,
1042 struct drm_crtc *crtc)
1044 struct drm_plane *plane;
1045 struct drm_plane_state *old_plane_state;
1048 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1049 if (plane->state->crtc != crtc &&
1050 old_plane_state->crtc != crtc)
1053 if (plane->state->fb != old_plane_state->fb)
1059 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1062 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1064 * @old_state: atomic state object with old state structures
1066 * Helper to, after atomic commit, wait for vblanks on all effected
1067 * crtcs (ie. before cleaning up old framebuffers using
1068 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1069 * framebuffers have actually changed to optimize for the legacy cursor and
1070 * plane update use-case.
1073 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1074 struct drm_atomic_state *old_state)
1076 struct drm_crtc *crtc;
1077 struct drm_crtc_state *old_crtc_state;
1080 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1081 /* No one cares about the old state, so abuse it for tracking
1082 * and store whether we hold a vblank reference (and should do a
1083 * vblank wait) in the ->enable boolean. */
1084 old_crtc_state->enable = false;
1086 if (!crtc->state->enable)
1089 /* Legacy cursor ioctls are completely unsynced, and userspace
1090 * relies on that (by doing tons of cursor updates). */
1091 if (old_state->legacy_cursor_update)
1094 if (!drm_atomic_helper_framebuffer_changed(dev,
1098 ret = drm_crtc_vblank_get(crtc);
1102 old_crtc_state->enable = true;
1103 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1106 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1107 if (!old_crtc_state->enable)
1110 ret = wait_event_timeout(dev->vblank[i].queue,
1111 old_crtc_state->last_vblank_count !=
1112 drm_crtc_vblank_count(crtc),
1113 msecs_to_jiffies(50));
1115 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1117 drm_crtc_vblank_put(crtc);
1120 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1123 * drm_atomic_helper_commit - commit validated state object
1125 * @state: the driver state object
1126 * @nonblocking: whether nonblocking behavior is requested.
1128 * This function commits a with drm_atomic_helper_check() pre-validated state
1129 * object. This can still fail when e.g. the framebuffer reservation fails. For
1130 * now this doesn't implement nonblocking commits.
1132 * Note that right now this function does not support nonblocking commits, hence
1133 * driver writers must implement their own version for now. Also note that the
1134 * default ordering of how the various stages are called is to match the legacy
1135 * modeset helper library closest. One peculiarity of that is that it doesn't
1136 * mesh well with runtime PM at all.
1138 * For drivers supporting runtime PM the recommended sequence is
1140 * drm_atomic_helper_commit_modeset_disables(dev, state);
1142 * drm_atomic_helper_commit_modeset_enables(dev, state);
1144 * drm_atomic_helper_commit_planes(dev, state, true);
1146 * See the kerneldoc entries for these three functions for more details.
1149 * Zero for success or -errno.
1151 int drm_atomic_helper_commit(struct drm_device *dev,
1152 struct drm_atomic_state *state,
1160 ret = drm_atomic_helper_prepare_planes(dev, state);
1165 * This is the point of no return - everything below never fails except
1166 * when the hw goes bonghits. Which means we can commit the new state on
1167 * the software side now.
1170 drm_atomic_helper_swap_state(state, true);
1173 * Everything below can be run asynchronously without the need to grab
1174 * any modeset locks at all under one condition: It must be guaranteed
1175 * that the asynchronous work has either been cancelled (if the driver
1176 * supports it, which at least requires that the framebuffers get
1177 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1178 * before the new state gets committed on the software side with
1179 * drm_atomic_helper_swap_state().
1181 * This scheme allows new atomic state updates to be prepared and
1182 * checked in parallel to the asynchronous completion of the previous
1183 * update. Which is important since compositors need to figure out the
1184 * composition of the next frame right after having submitted the
1188 drm_atomic_helper_wait_for_fences(dev, state);
1190 drm_atomic_helper_commit_modeset_disables(dev, state);
1192 drm_atomic_helper_commit_planes(dev, state, false);
1194 drm_atomic_helper_commit_modeset_enables(dev, state);
1196 drm_atomic_helper_wait_for_vblanks(dev, state);
1198 drm_atomic_helper_cleanup_planes(dev, state);
1200 drm_atomic_state_free(state);
1204 EXPORT_SYMBOL(drm_atomic_helper_commit);
1207 * DOC: implementing nonblocking commit
1209 * For now the atomic helpers don't support nonblocking commit directly. If
1210 * there is real need it could be added though, using the dma-buf fence
1211 * infrastructure for generic synchronization with outstanding rendering.
1213 * For now drivers have to implement nonblocking commit themselves, with the
1214 * following sequence being the recommended one:
1216 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1217 * which commit needs to call which can fail, so we want to run it first and
1220 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1221 * might be affected the new state update. This can be done by either cancelling
1222 * or flushing the work items, depending upon whether the driver can deal with
1223 * cancelled updates. Note that it is important to ensure that the framebuffer
1224 * cleanup is still done when cancelling.
1226 * For sufficient parallelism it is recommended to have a work item per crtc
1227 * (for updates which don't touch global state) and a global one. Then we only
1228 * need to synchronize with the crtc work items for changed crtcs and the global
1229 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1231 * 3. The software state is updated synchronously with
1232 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1233 * locks means concurrent callers never see inconsistent state. And doing this
1234 * while it's guaranteed that no relevant nonblocking worker runs means that
1235 * nonblocking workers do not need grab any locks. Actually they must not grab
1236 * locks, for otherwise the work flushing will deadlock.
1238 * 4. Schedule a work item to do all subsequent steps, using the split-out
1239 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1240 * then cleaning up the framebuffers after the old framebuffer is no longer
1245 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1247 * @state: atomic state object with new state structures
1249 * This function prepares plane state, specifically framebuffers, for the new
1250 * configuration. If any failure is encountered this function will call
1251 * ->cleanup_fb on any already successfully prepared framebuffer.
1254 * 0 on success, negative error code on failure.
1256 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1257 struct drm_atomic_state *state)
1259 struct drm_plane *plane;
1260 struct drm_plane_state *plane_state;
1263 for_each_plane_in_state(state, plane, plane_state, i) {
1264 const struct drm_plane_helper_funcs *funcs;
1266 funcs = plane->helper_private;
1268 if (funcs->prepare_fb) {
1269 ret = funcs->prepare_fb(plane, plane_state);
1278 for_each_plane_in_state(state, plane, plane_state, j) {
1279 const struct drm_plane_helper_funcs *funcs;
1284 funcs = plane->helper_private;
1286 if (funcs->cleanup_fb)
1287 funcs->cleanup_fb(plane, plane_state);
1293 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1295 bool plane_crtc_active(struct drm_plane_state *state)
1297 return state->crtc && state->crtc->state->active;
1301 * drm_atomic_helper_commit_planes - commit plane state
1303 * @old_state: atomic state object with old state structures
1304 * @active_only: Only commit on active CRTC if set
1306 * This function commits the new plane state using the plane and atomic helper
1307 * functions for planes and crtcs. It assumes that the atomic state has already
1308 * been pushed into the relevant object state pointers, since this step can no
1311 * It still requires the global state object @old_state to know which planes and
1312 * crtcs need to be updated though.
1314 * Note that this function does all plane updates across all CRTCs in one step.
1315 * If the hardware can't support this approach look at
1316 * drm_atomic_helper_commit_planes_on_crtc() instead.
1318 * Plane parameters can be updated by applications while the associated CRTC is
1319 * disabled. The DRM/KMS core will store the parameters in the plane state,
1320 * which will be available to the driver when the CRTC is turned on. As a result
1321 * most drivers don't need to be immediately notified of plane updates for a
1324 * Unless otherwise needed, drivers are advised to set the @active_only
1325 * parameters to true in order not to receive plane update notifications related
1326 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1327 * driver code when the driver and/or hardware can't or just don't need to deal
1328 * with updates on disabled CRTCs, for example when supporting runtime PM.
1330 * The drm_atomic_helper_commit() default implementation only sets @active_only
1331 * to false to most closely match the behaviour of the legacy helpers. This should
1332 * not be copied blindly by drivers.
1334 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1335 struct drm_atomic_state *old_state,
1338 struct drm_crtc *crtc;
1339 struct drm_crtc_state *old_crtc_state;
1340 struct drm_plane *plane;
1341 struct drm_plane_state *old_plane_state;
1344 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1345 const struct drm_crtc_helper_funcs *funcs;
1347 funcs = crtc->helper_private;
1349 if (!funcs || !funcs->atomic_begin)
1352 if (active_only && !crtc->state->active)
1355 funcs->atomic_begin(crtc, old_crtc_state);
1358 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1359 const struct drm_plane_helper_funcs *funcs;
1362 funcs = plane->helper_private;
1367 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1371 * Skip planes related to inactive CRTCs. If the plane
1372 * is enabled use the state of the current CRTC. If the
1373 * plane is being disabled use the state of the old
1374 * CRTC to avoid skipping planes being disabled on an
1377 if (!disabling && !plane_crtc_active(plane->state))
1379 if (disabling && !plane_crtc_active(old_plane_state))
1384 * Special-case disabling the plane if drivers support it.
1386 if (disabling && funcs->atomic_disable)
1387 funcs->atomic_disable(plane, old_plane_state);
1388 else if (plane->state->crtc || disabling)
1389 funcs->atomic_update(plane, old_plane_state);
1392 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1393 const struct drm_crtc_helper_funcs *funcs;
1395 funcs = crtc->helper_private;
1397 if (!funcs || !funcs->atomic_flush)
1400 if (active_only && !crtc->state->active)
1403 funcs->atomic_flush(crtc, old_crtc_state);
1406 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1409 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1410 * @old_crtc_state: atomic state object with the old crtc state
1412 * This function commits the new plane state using the plane and atomic helper
1413 * functions for planes on the specific crtc. It assumes that the atomic state
1414 * has already been pushed into the relevant object state pointers, since this
1415 * step can no longer fail.
1417 * This function is useful when plane updates should be done crtc-by-crtc
1418 * instead of one global step like drm_atomic_helper_commit_planes() does.
1420 * This function can only be savely used when planes are not allowed to move
1421 * between different CRTCs because this function doesn't handle inter-CRTC
1422 * depencies. Callers need to ensure that either no such depencies exist,
1423 * resolve them through ordering of commit calls or through some other means.
1426 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1428 const struct drm_crtc_helper_funcs *crtc_funcs;
1429 struct drm_crtc *crtc = old_crtc_state->crtc;
1430 struct drm_atomic_state *old_state = old_crtc_state->state;
1431 struct drm_plane *plane;
1432 unsigned plane_mask;
1434 plane_mask = old_crtc_state->plane_mask;
1435 plane_mask |= crtc->state->plane_mask;
1437 crtc_funcs = crtc->helper_private;
1438 if (crtc_funcs && crtc_funcs->atomic_begin)
1439 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1441 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1442 struct drm_plane_state *old_plane_state =
1443 drm_atomic_get_existing_plane_state(old_state, plane);
1444 const struct drm_plane_helper_funcs *plane_funcs;
1446 plane_funcs = plane->helper_private;
1448 if (!old_plane_state || !plane_funcs)
1451 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1453 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1454 plane_funcs->atomic_disable)
1455 plane_funcs->atomic_disable(plane, old_plane_state);
1456 else if (plane->state->crtc ||
1457 drm_atomic_plane_disabling(plane, old_plane_state))
1458 plane_funcs->atomic_update(plane, old_plane_state);
1461 if (crtc_funcs && crtc_funcs->atomic_flush)
1462 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1464 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1467 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1469 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1471 * Disables all planes associated with the given CRTC. This can be
1472 * used for instance in the CRTC helper disable callback to disable
1473 * all planes before shutting down the display pipeline.
1475 * If the atomic-parameter is set the function calls the CRTC's
1476 * atomic_begin hook before and atomic_flush hook after disabling the
1479 * It is a bug to call this function without having implemented the
1480 * ->atomic_disable() plane hook.
1482 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1485 const struct drm_crtc_helper_funcs *crtc_funcs =
1486 crtc->helper_private;
1487 struct drm_plane *plane;
1489 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1490 crtc_funcs->atomic_begin(crtc, NULL);
1492 drm_for_each_plane(plane, crtc->dev) {
1493 const struct drm_plane_helper_funcs *plane_funcs =
1494 plane->helper_private;
1496 if (plane->state->crtc != crtc || !plane_funcs)
1499 WARN_ON(!plane_funcs->atomic_disable);
1500 if (plane_funcs->atomic_disable)
1501 plane_funcs->atomic_disable(plane, NULL);
1504 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1505 crtc_funcs->atomic_flush(crtc, NULL);
1507 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1510 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1512 * @old_state: atomic state object with old state structures
1514 * This function cleans up plane state, specifically framebuffers, from the old
1515 * configuration. Hence the old configuration must be perserved in @old_state to
1516 * be able to call this function.
1518 * This function must also be called on the new state when the atomic update
1519 * fails at any point after calling drm_atomic_helper_prepare_planes().
1521 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1522 struct drm_atomic_state *old_state)
1524 struct drm_plane *plane;
1525 struct drm_plane_state *plane_state;
1528 for_each_plane_in_state(old_state, plane, plane_state, i) {
1529 const struct drm_plane_helper_funcs *funcs;
1531 funcs = plane->helper_private;
1533 if (funcs->cleanup_fb)
1534 funcs->cleanup_fb(plane, plane_state);
1537 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1540 * drm_atomic_helper_swap_state - store atomic state into current sw state
1541 * @state: atomic state
1542 * @stall: stall for proceeding commits
1544 * This function stores the atomic state into the current state pointers in all
1545 * driver objects. It should be called after all failing steps have been done
1546 * and succeeded, but before the actual hardware state is committed.
1548 * For cleanup and error recovery the current state for all changed objects will
1549 * be swaped into @state.
1551 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1553 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1555 * 2. Do any other steps that might fail.
1557 * 3. Put the staged state into the current state pointers with this function.
1559 * 4. Actually commit the hardware state.
1561 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1562 * contains the old state. Also do any other cleanup required with that state.
1564 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
1568 struct drm_connector *connector;
1569 struct drm_connector_state *conn_state;
1570 struct drm_crtc *crtc;
1571 struct drm_crtc_state *crtc_state;
1572 struct drm_plane *plane;
1573 struct drm_plane_state *plane_state;
1575 for_each_connector_in_state(state, connector, conn_state, i) {
1576 connector->state->state = state;
1577 swap(state->connectors[i].state, connector->state);
1578 connector->state->state = NULL;
1581 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1582 crtc->state->state = state;
1583 swap(state->crtcs[i].state, crtc->state);
1584 crtc->state->state = NULL;
1587 for_each_plane_in_state(state, plane, plane_state, i) {
1588 plane->state->state = state;
1589 swap(state->planes[i].state, plane->state);
1590 plane->state->state = NULL;
1593 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1596 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1597 * @plane: plane object to update
1598 * @crtc: owning CRTC of owning plane
1599 * @fb: framebuffer to flip onto plane
1600 * @crtc_x: x offset of primary plane on crtc
1601 * @crtc_y: y offset of primary plane on crtc
1602 * @crtc_w: width of primary plane rectangle on crtc
1603 * @crtc_h: height of primary plane rectangle on crtc
1604 * @src_x: x offset of @fb for panning
1605 * @src_y: y offset of @fb for panning
1606 * @src_w: width of source rectangle in @fb
1607 * @src_h: height of source rectangle in @fb
1609 * Provides a default plane update handler using the atomic driver interface.
1612 * Zero on success, error code on failure
1614 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1615 struct drm_crtc *crtc,
1616 struct drm_framebuffer *fb,
1617 int crtc_x, int crtc_y,
1618 unsigned int crtc_w, unsigned int crtc_h,
1619 uint32_t src_x, uint32_t src_y,
1620 uint32_t src_w, uint32_t src_h)
1622 struct drm_atomic_state *state;
1623 struct drm_plane_state *plane_state;
1626 state = drm_atomic_state_alloc(plane->dev);
1630 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1632 plane_state = drm_atomic_get_plane_state(state, plane);
1633 if (IS_ERR(plane_state)) {
1634 ret = PTR_ERR(plane_state);
1638 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1641 drm_atomic_set_fb_for_plane(plane_state, fb);
1642 plane_state->crtc_x = crtc_x;
1643 plane_state->crtc_y = crtc_y;
1644 plane_state->crtc_w = crtc_w;
1645 plane_state->crtc_h = crtc_h;
1646 plane_state->src_x = src_x;
1647 plane_state->src_y = src_y;
1648 plane_state->src_w = src_w;
1649 plane_state->src_h = src_h;
1651 if (plane == crtc->cursor)
1652 state->legacy_cursor_update = true;
1654 ret = drm_atomic_commit(state);
1658 /* Driver takes ownership of state on successful commit. */
1661 if (ret == -EDEADLK)
1664 drm_atomic_state_free(state);
1668 drm_atomic_state_clear(state);
1669 drm_atomic_legacy_backoff(state);
1672 * Someone might have exchanged the framebuffer while we dropped locks
1673 * in the backoff code. We need to fix up the fb refcount tracking the
1676 plane->old_fb = plane->fb;
1680 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1683 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1684 * @plane: plane to disable
1686 * Provides a default plane disable handler using the atomic driver interface.
1689 * Zero on success, error code on failure
1691 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1693 struct drm_atomic_state *state;
1694 struct drm_plane_state *plane_state;
1698 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1699 * acquire context. The real fix will be to wire the acquire ctx through
1700 * everywhere we need it, but meanwhile prevent chaos by just skipping
1701 * this noop. The critical case is the cursor ioctls which a) only grab
1702 * crtc/cursor-plane locks (so we need the crtc to get at the right
1703 * acquire context) and b) can try to disable the plane multiple times.
1708 state = drm_atomic_state_alloc(plane->dev);
1712 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1714 plane_state = drm_atomic_get_plane_state(state, plane);
1715 if (IS_ERR(plane_state)) {
1716 ret = PTR_ERR(plane_state);
1720 if (plane_state->crtc && (plane == plane->crtc->cursor))
1721 plane_state->state->legacy_cursor_update = true;
1723 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1727 ret = drm_atomic_commit(state);
1731 /* Driver takes ownership of state on successful commit. */
1734 if (ret == -EDEADLK)
1737 drm_atomic_state_free(state);
1741 drm_atomic_state_clear(state);
1742 drm_atomic_legacy_backoff(state);
1745 * Someone might have exchanged the framebuffer while we dropped locks
1746 * in the backoff code. We need to fix up the fb refcount tracking the
1749 plane->old_fb = plane->fb;
1753 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1755 /* just used from fb-helper and atomic-helper: */
1756 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1757 struct drm_plane_state *plane_state)
1761 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1765 drm_atomic_set_fb_for_plane(plane_state, NULL);
1766 plane_state->crtc_x = 0;
1767 plane_state->crtc_y = 0;
1768 plane_state->crtc_w = 0;
1769 plane_state->crtc_h = 0;
1770 plane_state->src_x = 0;
1771 plane_state->src_y = 0;
1772 plane_state->src_w = 0;
1773 plane_state->src_h = 0;
1778 static int update_output_state(struct drm_atomic_state *state,
1779 struct drm_mode_set *set)
1781 struct drm_device *dev = set->crtc->dev;
1782 struct drm_crtc *crtc;
1783 struct drm_crtc_state *crtc_state;
1784 struct drm_connector *connector;
1785 struct drm_connector_state *conn_state;
1788 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1789 state->acquire_ctx);
1793 /* First disable all connectors on the target crtc. */
1794 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1798 for_each_connector_in_state(state, connector, conn_state, i) {
1799 if (conn_state->crtc == set->crtc) {
1800 ret = drm_atomic_set_crtc_for_connector(conn_state,
1807 /* Then set all connectors from set->connectors on the target crtc */
1808 for (i = 0; i < set->num_connectors; i++) {
1809 conn_state = drm_atomic_get_connector_state(state,
1810 set->connectors[i]);
1811 if (IS_ERR(conn_state))
1812 return PTR_ERR(conn_state);
1814 ret = drm_atomic_set_crtc_for_connector(conn_state,
1820 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1821 /* Don't update ->enable for the CRTC in the set_config request,
1822 * since a mismatch would indicate a bug in the upper layers.
1823 * The actual modeset code later on will catch any
1824 * inconsistencies here. */
1825 if (crtc == set->crtc)
1828 if (!crtc_state->connector_mask) {
1829 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1834 crtc_state->active = false;
1842 * drm_atomic_helper_set_config - set a new config from userspace
1843 * @set: mode set configuration
1845 * Provides a default crtc set_config handler using the atomic driver interface.
1848 * Returns 0 on success, negative errno numbers on failure.
1850 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1852 struct drm_atomic_state *state;
1853 struct drm_crtc *crtc = set->crtc;
1856 state = drm_atomic_state_alloc(crtc->dev);
1860 state->legacy_set_config = true;
1861 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1863 ret = __drm_atomic_helper_set_config(set, state);
1867 ret = drm_atomic_commit(state);
1871 /* Driver takes ownership of state on successful commit. */
1874 if (ret == -EDEADLK)
1877 drm_atomic_state_free(state);
1881 drm_atomic_state_clear(state);
1882 drm_atomic_legacy_backoff(state);
1885 * Someone might have exchanged the framebuffer while we dropped locks
1886 * in the backoff code. We need to fix up the fb refcount tracking the
1889 crtc->primary->old_fb = crtc->primary->fb;
1893 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1895 /* just used from fb-helper and atomic-helper: */
1896 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1897 struct drm_atomic_state *state)
1899 struct drm_crtc_state *crtc_state;
1900 struct drm_plane_state *primary_state;
1901 struct drm_crtc *crtc = set->crtc;
1902 int hdisplay, vdisplay;
1905 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1906 if (IS_ERR(crtc_state))
1907 return PTR_ERR(crtc_state);
1909 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1910 if (IS_ERR(primary_state))
1911 return PTR_ERR(primary_state);
1915 WARN_ON(set->num_connectors);
1917 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1921 crtc_state->active = false;
1923 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1927 drm_atomic_set_fb_for_plane(primary_state, NULL);
1933 WARN_ON(!set->num_connectors);
1935 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1939 crtc_state->active = true;
1941 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1945 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1947 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1948 primary_state->crtc_x = 0;
1949 primary_state->crtc_y = 0;
1950 primary_state->crtc_w = hdisplay;
1951 primary_state->crtc_h = vdisplay;
1952 primary_state->src_x = set->x << 16;
1953 primary_state->src_y = set->y << 16;
1954 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1955 primary_state->src_w = vdisplay << 16;
1956 primary_state->src_h = hdisplay << 16;
1958 primary_state->src_w = hdisplay << 16;
1959 primary_state->src_h = vdisplay << 16;
1963 ret = update_output_state(state, set);
1971 * drm_atomic_helper_disable_all - disable all currently active outputs
1973 * @ctx: lock acquisition context
1975 * Loops through all connectors, finding those that aren't turned off and then
1976 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1977 * that they are connected to.
1979 * This is used for example in suspend/resume to disable all currently active
1980 * functions when suspending.
1982 * Note that if callers haven't already acquired all modeset locks this might
1983 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1986 * 0 on success or a negative error code on failure.
1989 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1991 int drm_atomic_helper_disable_all(struct drm_device *dev,
1992 struct drm_modeset_acquire_ctx *ctx)
1994 struct drm_atomic_state *state;
1995 struct drm_connector *conn;
1998 state = drm_atomic_state_alloc(dev);
2002 state->acquire_ctx = ctx;
2004 drm_for_each_connector(conn, dev) {
2005 struct drm_crtc *crtc = conn->state->crtc;
2006 struct drm_crtc_state *crtc_state;
2008 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2011 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2012 if (IS_ERR(crtc_state)) {
2013 err = PTR_ERR(crtc_state);
2017 crtc_state->active = false;
2020 err = drm_atomic_commit(state);
2024 drm_atomic_state_free(state);
2028 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2031 * drm_atomic_helper_suspend - subsystem-level suspend helper
2034 * Duplicates the current atomic state, disables all active outputs and then
2035 * returns a pointer to the original atomic state to the caller. Drivers can
2036 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2037 * restore the output configuration that was active at the time the system
2040 * Note that it is potentially unsafe to use this. The atomic state object
2041 * returned by this function is assumed to be persistent. Drivers must ensure
2042 * that this holds true. Before calling this function, drivers must make sure
2043 * to suspend fbdev emulation so that nothing can be using the device.
2046 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2047 * encoded error code on failure. Drivers should store the returned atomic
2048 * state object and pass it to the drm_atomic_helper_resume() helper upon
2052 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2053 * drm_atomic_helper_resume()
2055 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2057 struct drm_modeset_acquire_ctx ctx;
2058 struct drm_atomic_state *state;
2061 drm_modeset_acquire_init(&ctx, 0);
2064 err = drm_modeset_lock_all_ctx(dev, &ctx);
2066 state = ERR_PTR(err);
2070 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2074 err = drm_atomic_helper_disable_all(dev, &ctx);
2076 drm_atomic_state_free(state);
2077 state = ERR_PTR(err);
2082 if (PTR_ERR(state) == -EDEADLK) {
2083 drm_modeset_backoff(&ctx);
2087 drm_modeset_drop_locks(&ctx);
2088 drm_modeset_acquire_fini(&ctx);
2091 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2094 * drm_atomic_helper_resume - subsystem-level resume helper
2096 * @state: atomic state to resume to
2098 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2099 * grabs all modeset locks and commits the atomic state object. This can be
2100 * used in conjunction with the drm_atomic_helper_suspend() helper to
2101 * implement suspend/resume for drivers that support atomic mode-setting.
2104 * 0 on success or a negative error code on failure.
2107 * drm_atomic_helper_suspend()
2109 int drm_atomic_helper_resume(struct drm_device *dev,
2110 struct drm_atomic_state *state)
2112 struct drm_mode_config *config = &dev->mode_config;
2115 drm_mode_config_reset(dev);
2116 drm_modeset_lock_all(dev);
2117 state->acquire_ctx = config->acquire_ctx;
2118 err = drm_atomic_commit(state);
2119 drm_modeset_unlock_all(dev);
2123 EXPORT_SYMBOL(drm_atomic_helper_resume);
2126 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2128 * @property: DRM property
2129 * @val: value of property
2131 * Provides a default crtc set_property handler using the atomic driver
2135 * Zero on success, error code on failure
2138 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2139 struct drm_property *property,
2142 struct drm_atomic_state *state;
2143 struct drm_crtc_state *crtc_state;
2146 state = drm_atomic_state_alloc(crtc->dev);
2150 /* ->set_property is always called with all locks held. */
2151 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2153 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2154 if (IS_ERR(crtc_state)) {
2155 ret = PTR_ERR(crtc_state);
2159 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2164 ret = drm_atomic_commit(state);
2168 /* Driver takes ownership of state on successful commit. */
2171 if (ret == -EDEADLK)
2174 drm_atomic_state_free(state);
2178 drm_atomic_state_clear(state);
2179 drm_atomic_legacy_backoff(state);
2183 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2186 * drm_atomic_helper_plane_set_property - helper for plane properties
2188 * @property: DRM property
2189 * @val: value of property
2191 * Provides a default plane set_property handler using the atomic driver
2195 * Zero on success, error code on failure
2198 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2199 struct drm_property *property,
2202 struct drm_atomic_state *state;
2203 struct drm_plane_state *plane_state;
2206 state = drm_atomic_state_alloc(plane->dev);
2210 /* ->set_property is always called with all locks held. */
2211 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2213 plane_state = drm_atomic_get_plane_state(state, plane);
2214 if (IS_ERR(plane_state)) {
2215 ret = PTR_ERR(plane_state);
2219 ret = drm_atomic_plane_set_property(plane, plane_state,
2224 ret = drm_atomic_commit(state);
2228 /* Driver takes ownership of state on successful commit. */
2231 if (ret == -EDEADLK)
2234 drm_atomic_state_free(state);
2238 drm_atomic_state_clear(state);
2239 drm_atomic_legacy_backoff(state);
2243 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2246 * drm_atomic_helper_connector_set_property - helper for connector properties
2247 * @connector: DRM connector
2248 * @property: DRM property
2249 * @val: value of property
2251 * Provides a default connector set_property handler using the atomic driver
2255 * Zero on success, error code on failure
2258 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2259 struct drm_property *property,
2262 struct drm_atomic_state *state;
2263 struct drm_connector_state *connector_state;
2266 state = drm_atomic_state_alloc(connector->dev);
2270 /* ->set_property is always called with all locks held. */
2271 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2273 connector_state = drm_atomic_get_connector_state(state, connector);
2274 if (IS_ERR(connector_state)) {
2275 ret = PTR_ERR(connector_state);
2279 ret = drm_atomic_connector_set_property(connector, connector_state,
2284 ret = drm_atomic_commit(state);
2288 /* Driver takes ownership of state on successful commit. */
2291 if (ret == -EDEADLK)
2294 drm_atomic_state_free(state);
2298 drm_atomic_state_clear(state);
2299 drm_atomic_legacy_backoff(state);
2303 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2306 * drm_atomic_helper_page_flip - execute a legacy page flip
2308 * @fb: DRM framebuffer
2309 * @event: optional DRM event to signal upon completion
2310 * @flags: flip flags for non-vblank sync'ed updates
2312 * Provides a default page flip implementation using the atomic driver interface.
2314 * Note that for now so called async page flips (i.e. updates which are not
2315 * synchronized to vblank) are not supported, since the atomic interfaces have
2316 * no provisions for this yet.
2319 * Returns 0 on success, negative errno numbers on failure.
2321 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2322 struct drm_framebuffer *fb,
2323 struct drm_pending_vblank_event *event,
2326 struct drm_plane *plane = crtc->primary;
2327 struct drm_atomic_state *state;
2328 struct drm_plane_state *plane_state;
2329 struct drm_crtc_state *crtc_state;
2332 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2335 state = drm_atomic_state_alloc(plane->dev);
2339 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2341 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2342 if (IS_ERR(crtc_state)) {
2343 ret = PTR_ERR(crtc_state);
2346 crtc_state->event = event;
2348 plane_state = drm_atomic_get_plane_state(state, plane);
2349 if (IS_ERR(plane_state)) {
2350 ret = PTR_ERR(plane_state);
2354 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2357 drm_atomic_set_fb_for_plane(plane_state, fb);
2359 /* Make sure we don't accidentally do a full modeset. */
2360 state->allow_modeset = false;
2361 if (!crtc_state->active) {
2362 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2368 ret = drm_atomic_nonblocking_commit(state);
2372 /* Driver takes ownership of state on successful commit. */
2375 if (ret == -EDEADLK)
2378 drm_atomic_state_free(state);
2382 drm_atomic_state_clear(state);
2383 drm_atomic_legacy_backoff(state);
2386 * Someone might have exchanged the framebuffer while we dropped locks
2387 * in the backoff code. We need to fix up the fb refcount tracking the
2390 plane->old_fb = plane->fb;
2394 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2397 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2398 * @connector: affected connector
2401 * This is the main helper function provided by the atomic helper framework for
2402 * implementing the legacy DPMS connector interface. It computes the new desired
2403 * ->active state for the corresponding CRTC (if the connector is enabled) and
2407 * Returns 0 on success, negative errno numbers on failure.
2409 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2412 struct drm_mode_config *config = &connector->dev->mode_config;
2413 struct drm_atomic_state *state;
2414 struct drm_crtc_state *crtc_state;
2415 struct drm_crtc *crtc;
2416 struct drm_connector *tmp_connector;
2418 bool active = false;
2419 int old_mode = connector->dpms;
2421 if (mode != DRM_MODE_DPMS_ON)
2422 mode = DRM_MODE_DPMS_OFF;
2424 connector->dpms = mode;
2425 crtc = connector->state->crtc;
2430 state = drm_atomic_state_alloc(connector->dev);
2434 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2436 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2437 if (IS_ERR(crtc_state)) {
2438 ret = PTR_ERR(crtc_state);
2442 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2444 drm_for_each_connector(tmp_connector, connector->dev) {
2445 if (tmp_connector->state->crtc != crtc)
2448 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2453 crtc_state->active = active;
2455 ret = drm_atomic_commit(state);
2459 /* Driver takes ownership of state on successful commit. */
2462 if (ret == -EDEADLK)
2465 connector->dpms = old_mode;
2466 drm_atomic_state_free(state);
2470 drm_atomic_state_clear(state);
2471 drm_atomic_legacy_backoff(state);
2475 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2478 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2479 * ->best_encoder callback
2480 * @connector: Connector control structure
2482 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2483 * connectors that support exactly 1 encoder, statically determined at driver
2486 struct drm_encoder *
2487 drm_atomic_helper_best_encoder(struct drm_connector *connector)
2489 WARN_ON(connector->encoder_ids[1]);
2490 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
2492 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
2495 * DOC: atomic state reset and initialization
2497 * Both the drm core and the atomic helpers assume that there is always the full
2498 * and correct atomic software state for all connectors, CRTCs and planes
2499 * available. Which is a bit a problem on driver load and also after system
2500 * suspend. One way to solve this is to have a hardware state read-out
2501 * infrastructure which reconstructs the full software state (e.g. the i915
2504 * The simpler solution is to just reset the software state to everything off,
2505 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2506 * the atomic helpers provide default reset implementations for all hooks.
2508 * On the upside the precise state tracking of atomic simplifies system suspend
2509 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2510 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2511 * For other drivers the building blocks are split out, see the documentation
2512 * for these functions.
2516 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2519 * Resets the atomic state for @crtc by freeing the state pointer (which might
2520 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2522 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2525 __drm_atomic_helper_crtc_destroy_state(crtc->state);
2528 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2531 crtc->state->crtc = crtc;
2533 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2536 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2537 * @crtc: CRTC object
2538 * @state: atomic CRTC state
2540 * Copies atomic state from a CRTC's current state and resets inferred values.
2541 * This is useful for drivers that subclass the CRTC state.
2543 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2544 struct drm_crtc_state *state)
2546 memcpy(state, crtc->state, sizeof(*state));
2548 if (state->mode_blob)
2549 drm_property_reference_blob(state->mode_blob);
2550 if (state->degamma_lut)
2551 drm_property_reference_blob(state->degamma_lut);
2553 drm_property_reference_blob(state->ctm);
2554 if (state->gamma_lut)
2555 drm_property_reference_blob(state->gamma_lut);
2556 state->mode_changed = false;
2557 state->active_changed = false;
2558 state->planes_changed = false;
2559 state->connectors_changed = false;
2560 state->color_mgmt_changed = false;
2561 state->event = NULL;
2563 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2566 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2569 * Default CRTC state duplicate hook for drivers which don't have their own
2570 * subclassed CRTC state structure.
2572 struct drm_crtc_state *
2573 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2575 struct drm_crtc_state *state;
2577 if (WARN_ON(!crtc->state))
2580 state = kmalloc(sizeof(*state), GFP_KERNEL);
2582 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2586 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2589 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2590 * @state: CRTC state object to release
2592 * Releases all resources stored in the CRTC state without actually freeing
2593 * the memory of the CRTC state. This is useful for drivers that subclass the
2596 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
2598 drm_property_unreference_blob(state->mode_blob);
2599 drm_property_unreference_blob(state->degamma_lut);
2600 drm_property_unreference_blob(state->ctm);
2601 drm_property_unreference_blob(state->gamma_lut);
2603 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2606 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2608 * @state: CRTC state object to release
2610 * Default CRTC state destroy hook for drivers which don't have their own
2611 * subclassed CRTC state structure.
2613 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2614 struct drm_crtc_state *state)
2616 __drm_atomic_helper_crtc_destroy_state(state);
2619 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2622 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2625 * Resets the atomic state for @plane by freeing the state pointer (which might
2626 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2628 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2631 __drm_atomic_helper_plane_destroy_state(plane->state);
2633 kfree(plane->state);
2634 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2637 plane->state->plane = plane;
2638 plane->state->rotation = BIT(DRM_ROTATE_0);
2641 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2644 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2645 * @plane: plane object
2646 * @state: atomic plane state
2648 * Copies atomic state from a plane's current state. This is useful for
2649 * drivers that subclass the plane state.
2651 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2652 struct drm_plane_state *state)
2654 memcpy(state, plane->state, sizeof(*state));
2657 drm_framebuffer_reference(state->fb);
2659 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2662 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2665 * Default plane state duplicate hook for drivers which don't have their own
2666 * subclassed plane state structure.
2668 struct drm_plane_state *
2669 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2671 struct drm_plane_state *state;
2673 if (WARN_ON(!plane->state))
2676 state = kmalloc(sizeof(*state), GFP_KERNEL);
2678 __drm_atomic_helper_plane_duplicate_state(plane, state);
2682 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2685 * __drm_atomic_helper_plane_destroy_state - release plane state
2686 * @state: plane state object to release
2688 * Releases all resources stored in the plane state without actually freeing
2689 * the memory of the plane state. This is useful for drivers that subclass the
2692 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
2695 drm_framebuffer_unreference(state->fb);
2697 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2700 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2702 * @state: plane state object to release
2704 * Default plane state destroy hook for drivers which don't have their own
2705 * subclassed plane state structure.
2707 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2708 struct drm_plane_state *state)
2710 __drm_atomic_helper_plane_destroy_state(state);
2713 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2716 * __drm_atomic_helper_connector_reset - reset state on connector
2717 * @connector: drm connector
2718 * @conn_state: connector state to assign
2720 * Initializes the newly allocated @conn_state and assigns it to
2721 * #connector ->state, usually required when initializing the drivers
2722 * or when called from the ->reset hook.
2724 * This is useful for drivers that subclass the connector state.
2727 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2728 struct drm_connector_state *conn_state)
2731 conn_state->connector = connector;
2733 connector->state = conn_state;
2735 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2738 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2739 * @connector: drm connector
2741 * Resets the atomic state for @connector by freeing the state pointer (which
2742 * might be NULL, e.g. at driver load time) and allocating a new empty state
2745 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2747 struct drm_connector_state *conn_state =
2748 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2750 if (connector->state)
2751 __drm_atomic_helper_connector_destroy_state(connector->state);
2753 kfree(connector->state);
2754 __drm_atomic_helper_connector_reset(connector, conn_state);
2756 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2759 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2760 * @connector: connector object
2761 * @state: atomic connector state
2763 * Copies atomic state from a connector's current state. This is useful for
2764 * drivers that subclass the connector state.
2767 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2768 struct drm_connector_state *state)
2770 memcpy(state, connector->state, sizeof(*state));
2772 drm_connector_reference(connector);
2774 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2777 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2778 * @connector: drm connector
2780 * Default connector state duplicate hook for drivers which don't have their own
2781 * subclassed connector state structure.
2783 struct drm_connector_state *
2784 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2786 struct drm_connector_state *state;
2788 if (WARN_ON(!connector->state))
2791 state = kmalloc(sizeof(*state), GFP_KERNEL);
2793 __drm_atomic_helper_connector_duplicate_state(connector, state);
2797 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2800 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2802 * @ctx: lock acquisition context
2804 * Makes a copy of the current atomic state by looping over all objects and
2805 * duplicating their respective states. This is used for example by suspend/
2806 * resume support code to save the state prior to suspend such that it can
2807 * be restored upon resume.
2809 * Note that this treats atomic state as persistent between save and restore.
2810 * Drivers must make sure that this is possible and won't result in confusion
2811 * or erroneous behaviour.
2813 * Note that if callers haven't already acquired all modeset locks this might
2814 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2817 * A pointer to the copy of the atomic state object on success or an
2818 * ERR_PTR()-encoded error code on failure.
2821 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2823 struct drm_atomic_state *
2824 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2825 struct drm_modeset_acquire_ctx *ctx)
2827 struct drm_atomic_state *state;
2828 struct drm_connector *conn;
2829 struct drm_plane *plane;
2830 struct drm_crtc *crtc;
2833 state = drm_atomic_state_alloc(dev);
2835 return ERR_PTR(-ENOMEM);
2837 state->acquire_ctx = ctx;
2839 drm_for_each_crtc(crtc, dev) {
2840 struct drm_crtc_state *crtc_state;
2842 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2843 if (IS_ERR(crtc_state)) {
2844 err = PTR_ERR(crtc_state);
2849 drm_for_each_plane(plane, dev) {
2850 struct drm_plane_state *plane_state;
2852 plane_state = drm_atomic_get_plane_state(state, plane);
2853 if (IS_ERR(plane_state)) {
2854 err = PTR_ERR(plane_state);
2859 drm_for_each_connector(conn, dev) {
2860 struct drm_connector_state *conn_state;
2862 conn_state = drm_atomic_get_connector_state(state, conn);
2863 if (IS_ERR(conn_state)) {
2864 err = PTR_ERR(conn_state);
2869 /* clear the acquire context so that it isn't accidentally reused */
2870 state->acquire_ctx = NULL;
2874 drm_atomic_state_free(state);
2875 state = ERR_PTR(err);
2880 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2883 * __drm_atomic_helper_connector_destroy_state - release connector state
2884 * @state: connector state object to release
2886 * Releases all resources stored in the connector state without actually
2887 * freeing the memory of the connector state. This is useful for drivers that
2888 * subclass the connector state.
2891 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
2894 * This is currently a placeholder so that drivers that subclass the
2895 * state will automatically do the right thing if code is ever added
2899 drm_connector_unreference(state->connector);
2901 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2904 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2905 * @connector: drm connector
2906 * @state: connector state object to release
2908 * Default connector state destroy hook for drivers which don't have their own
2909 * subclassed connector state structure.
2911 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2912 struct drm_connector_state *state)
2914 __drm_atomic_helper_connector_destroy_state(state);
2917 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2920 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2921 * @crtc: CRTC object
2922 * @red: red correction table
2923 * @green: green correction table
2924 * @blue: green correction table
2925 * @size: size of the tables
2927 * Implements support for legacy gamma correction table for drivers
2928 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2931 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2932 u16 *red, u16 *green, u16 *blue,
2935 struct drm_device *dev = crtc->dev;
2936 struct drm_mode_config *config = &dev->mode_config;
2937 struct drm_atomic_state *state;
2938 struct drm_crtc_state *crtc_state;
2939 struct drm_property_blob *blob = NULL;
2940 struct drm_color_lut *blob_data;
2943 state = drm_atomic_state_alloc(crtc->dev);
2947 blob = drm_property_create_blob(dev,
2948 sizeof(struct drm_color_lut) * size,
2951 ret = PTR_ERR(blob);
2956 /* Prepare GAMMA_LUT with the legacy values. */
2957 blob_data = (struct drm_color_lut *) blob->data;
2958 for (i = 0; i < size; i++) {
2959 blob_data[i].red = red[i];
2960 blob_data[i].green = green[i];
2961 blob_data[i].blue = blue[i];
2964 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2966 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2967 if (IS_ERR(crtc_state)) {
2968 ret = PTR_ERR(crtc_state);
2972 /* Reset DEGAMMA_LUT and CTM properties. */
2973 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2974 config->degamma_lut_property, 0);
2978 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2979 config->ctm_property, 0);
2983 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2984 config->gamma_lut_property, blob->base.id);
2988 ret = drm_atomic_commit(state);
2992 /* Driver takes ownership of state on successful commit. */
2994 drm_property_unreference_blob(blob);
2998 if (ret == -EDEADLK)
3001 drm_atomic_state_free(state);
3002 drm_property_unreference_blob(blob);
3006 drm_atomic_state_clear(state);
3007 drm_atomic_legacy_backoff(state);
3011 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);