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);
114 new_encoder = funcs->best_encoder(connector);
117 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
118 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
119 new_encoder->base.id, new_encoder->name,
120 connector->base.id, connector->name);
125 encoder_mask |= 1 << drm_encoder_index(new_encoder);
133 * Second loop, iterate over all connectors not part of the state.
135 * If a conflicting encoder is found and disable_conflicting_encoders
136 * is not set, an error is returned. Userspace can provide a solution
137 * through the atomic ioctl.
139 * If the flag is set conflicting connectors are removed from the crtc
140 * and the crtc is disabled if no encoder is left. This preserves
141 * compatibility with the legacy set_config behavior.
143 drm_for_each_connector(connector, state->dev) {
144 struct drm_crtc_state *crtc_state;
146 if (drm_atomic_get_existing_connector_state(state, connector))
149 encoder = connector->state->best_encoder;
150 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
153 if (!disable_conflicting_encoders) {
154 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
155 encoder->base.id, encoder->name,
156 connector->state->crtc->base.id,
157 connector->state->crtc->name,
158 connector->base.id, connector->name);
162 conn_state = drm_atomic_get_connector_state(state, connector);
163 if (IS_ERR(conn_state))
164 return PTR_ERR(conn_state);
166 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
167 encoder->base.id, encoder->name,
168 conn_state->crtc->base.id, conn_state->crtc->name,
169 connector->base.id, connector->name);
171 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
173 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
177 if (!crtc_state->connector_mask) {
178 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
183 crtc_state->active = false;
191 set_best_encoder(struct drm_atomic_state *state,
192 struct drm_connector_state *conn_state,
193 struct drm_encoder *encoder)
195 struct drm_crtc_state *crtc_state;
196 struct drm_crtc *crtc;
198 if (conn_state->best_encoder) {
199 /* Unset the encoder_mask in the old crtc state. */
200 crtc = conn_state->connector->state->crtc;
202 /* A NULL crtc is an error here because we should have
203 * duplicated a NULL best_encoder when crtc was NULL.
204 * As an exception restoring duplicated atomic state
205 * during resume is allowed, so don't warn when
206 * best_encoder is equal to encoder we intend to set.
208 WARN_ON(!crtc && encoder != conn_state->best_encoder);
210 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
212 crtc_state->encoder_mask &=
213 ~(1 << drm_encoder_index(conn_state->best_encoder));
218 crtc = conn_state->crtc;
221 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
223 crtc_state->encoder_mask |=
224 1 << drm_encoder_index(encoder);
228 conn_state->best_encoder = encoder;
232 steal_encoder(struct drm_atomic_state *state,
233 struct drm_encoder *encoder)
235 struct drm_crtc_state *crtc_state;
236 struct drm_connector *connector;
237 struct drm_connector_state *connector_state;
240 for_each_connector_in_state(state, connector, connector_state, i) {
241 struct drm_crtc *encoder_crtc;
243 if (connector_state->best_encoder != encoder)
246 encoder_crtc = connector->state->crtc;
248 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
249 encoder->base.id, encoder->name,
250 encoder_crtc->base.id, encoder_crtc->name);
252 set_best_encoder(state, connector_state, NULL);
254 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
255 crtc_state->connectors_changed = true;
262 update_connector_routing(struct drm_atomic_state *state,
263 struct drm_connector *connector,
264 struct drm_connector_state *connector_state)
266 const struct drm_connector_helper_funcs *funcs;
267 struct drm_encoder *new_encoder;
268 struct drm_crtc_state *crtc_state;
270 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
274 if (connector->state->crtc != connector_state->crtc) {
275 if (connector->state->crtc) {
276 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
277 crtc_state->connectors_changed = true;
280 if (connector_state->crtc) {
281 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
282 crtc_state->connectors_changed = true;
286 if (!connector_state->crtc) {
287 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
291 set_best_encoder(state, connector_state, NULL);
296 funcs = connector->helper_private;
298 if (funcs->atomic_best_encoder)
299 new_encoder = funcs->atomic_best_encoder(connector,
302 new_encoder = funcs->best_encoder(connector);
305 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
311 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
312 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
313 new_encoder->base.id,
315 connector_state->crtc->base.id);
319 if (new_encoder == connector_state->best_encoder) {
320 set_best_encoder(state, connector_state, new_encoder);
322 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
325 new_encoder->base.id,
327 connector_state->crtc->base.id,
328 connector_state->crtc->name);
333 steal_encoder(state, new_encoder);
335 set_best_encoder(state, connector_state, new_encoder);
337 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
338 crtc_state->connectors_changed = true;
340 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
343 new_encoder->base.id,
345 connector_state->crtc->base.id,
346 connector_state->crtc->name);
352 mode_fixup(struct drm_atomic_state *state)
354 struct drm_crtc *crtc;
355 struct drm_crtc_state *crtc_state;
356 struct drm_connector *connector;
357 struct drm_connector_state *conn_state;
361 for_each_crtc_in_state(state, crtc, crtc_state, i) {
362 if (!crtc_state->mode_changed &&
363 !crtc_state->connectors_changed)
366 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
369 for_each_connector_in_state(state, connector, conn_state, i) {
370 const struct drm_encoder_helper_funcs *funcs;
371 struct drm_encoder *encoder;
373 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
375 if (!conn_state->crtc || !conn_state->best_encoder)
378 crtc_state = drm_atomic_get_existing_crtc_state(state,
382 * Each encoder has at most one connector (since we always steal
383 * it away), so we won't call ->mode_fixup twice.
385 encoder = conn_state->best_encoder;
386 funcs = encoder->helper_private;
388 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
389 &crtc_state->adjusted_mode);
391 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
395 if (funcs && funcs->atomic_check) {
396 ret = funcs->atomic_check(encoder, crtc_state,
399 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
400 encoder->base.id, encoder->name);
403 } else if (funcs && funcs->mode_fixup) {
404 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
405 &crtc_state->adjusted_mode);
407 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
408 encoder->base.id, encoder->name);
414 for_each_crtc_in_state(state, crtc, crtc_state, i) {
415 const struct drm_crtc_helper_funcs *funcs;
417 if (!crtc_state->mode_changed &&
418 !crtc_state->connectors_changed)
421 funcs = crtc->helper_private;
422 if (!funcs->mode_fixup)
425 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
426 &crtc_state->adjusted_mode);
428 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
429 crtc->base.id, crtc->name);
438 * drm_atomic_helper_check_modeset - validate state object for modeset changes
440 * @state: the driver state object
442 * Check the state object to see if the requested state is physically possible.
443 * This does all the crtc and connector related computations for an atomic
444 * update and adds any additional connectors needed for full modesets and calls
445 * down into ->mode_fixup functions of the driver backend.
447 * crtc_state->mode_changed is set when the input mode is changed.
448 * crtc_state->connectors_changed is set when a connector is added or
449 * removed from the crtc.
450 * crtc_state->active_changed is set when crtc_state->active changes,
451 * which is used for dpms.
455 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
456 * plane update can't be done without a full modeset) _must_ call this function
457 * afterwards after that change. It is permitted to call this function multiple
458 * times for the same update, e.g. when the ->atomic_check functions depend upon
459 * the adjusted dotclock for fifo space allocation and watermark computation.
462 * Zero for success or -errno
465 drm_atomic_helper_check_modeset(struct drm_device *dev,
466 struct drm_atomic_state *state)
468 struct drm_crtc *crtc;
469 struct drm_crtc_state *crtc_state;
470 struct drm_connector *connector;
471 struct drm_connector_state *connector_state;
474 for_each_crtc_in_state(state, crtc, crtc_state, i) {
475 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
476 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
477 crtc->base.id, crtc->name);
478 crtc_state->mode_changed = true;
481 if (crtc->state->enable != crtc_state->enable) {
482 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
483 crtc->base.id, crtc->name);
486 * For clarity this assignment is done here, but
487 * enable == 0 is only true when there are no
488 * connectors and a NULL mode.
490 * The other way around is true as well. enable != 0
491 * iff connectors are attached and a mode is set.
493 crtc_state->mode_changed = true;
494 crtc_state->connectors_changed = true;
498 ret = handle_conflicting_encoders(state, state->legacy_set_config);
502 for_each_connector_in_state(state, connector, connector_state, i) {
504 * This only sets crtc->mode_changed for routing changes,
505 * drivers must set crtc->mode_changed themselves when connector
506 * properties need to be updated.
508 ret = update_connector_routing(state, connector,
515 * After all the routing has been prepared we need to add in any
516 * connector which is itself unchanged, but who's crtc changes it's
517 * configuration. This must be done before calling mode_fixup in case a
518 * crtc only changed its mode but has the same set of connectors.
520 for_each_crtc_in_state(state, crtc, crtc_state, i) {
521 bool has_connectors =
522 !!crtc_state->connector_mask;
525 * We must set ->active_changed after walking connectors for
526 * otherwise an update that only changes active would result in
527 * a full modeset because update_connector_routing force that.
529 if (crtc->state->active != crtc_state->active) {
530 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
531 crtc->base.id, crtc->name);
532 crtc_state->active_changed = true;
535 if (!drm_atomic_crtc_needs_modeset(crtc_state))
538 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
539 crtc->base.id, crtc->name,
540 crtc_state->enable ? 'y' : 'n',
541 crtc_state->active ? 'y' : 'n');
543 ret = drm_atomic_add_affected_connectors(state, crtc);
547 ret = drm_atomic_add_affected_planes(state, crtc);
551 if (crtc_state->enable != has_connectors) {
552 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
553 crtc->base.id, crtc->name);
559 return mode_fixup(state);
561 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
564 * drm_atomic_helper_check_planes - validate state object for planes changes
566 * @state: the driver state object
568 * Check the state object to see if the requested state is physically possible.
569 * This does all the plane update related checks using by calling into the
570 * ->atomic_check hooks provided by the driver.
572 * It also sets crtc_state->planes_changed to indicate that a crtc has
576 * Zero for success or -errno
579 drm_atomic_helper_check_planes(struct drm_device *dev,
580 struct drm_atomic_state *state)
582 struct drm_crtc *crtc;
583 struct drm_crtc_state *crtc_state;
584 struct drm_plane *plane;
585 struct drm_plane_state *plane_state;
588 for_each_plane_in_state(state, plane, plane_state, i) {
589 const struct drm_plane_helper_funcs *funcs;
591 funcs = plane->helper_private;
593 drm_atomic_helper_plane_changed(state, plane_state, plane);
595 if (!funcs || !funcs->atomic_check)
598 ret = funcs->atomic_check(plane, plane_state);
600 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
601 plane->base.id, plane->name);
606 for_each_crtc_in_state(state, crtc, crtc_state, i) {
607 const struct drm_crtc_helper_funcs *funcs;
609 funcs = crtc->helper_private;
611 if (!funcs || !funcs->atomic_check)
614 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
616 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
617 crtc->base.id, crtc->name);
624 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
627 * drm_atomic_helper_check - validate state object
629 * @state: the driver state object
631 * Check the state object to see if the requested state is physically possible.
632 * Only crtcs and planes have check callbacks, so for any additional (global)
633 * checking that a driver needs it can simply wrap that around this function.
634 * Drivers without such needs can directly use this as their ->atomic_check()
637 * This just wraps the two parts of the state checking for planes and modeset
638 * state in the default order: First it calls drm_atomic_helper_check_modeset()
639 * and then drm_atomic_helper_check_planes(). The assumption is that the
640 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
641 * e.g. properly compute watermarks.
644 * Zero for success or -errno
646 int drm_atomic_helper_check(struct drm_device *dev,
647 struct drm_atomic_state *state)
651 ret = drm_atomic_helper_check_modeset(dev, state);
655 ret = drm_atomic_helper_check_planes(dev, state);
661 EXPORT_SYMBOL(drm_atomic_helper_check);
664 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
666 struct drm_connector *connector;
667 struct drm_connector_state *old_conn_state;
668 struct drm_crtc *crtc;
669 struct drm_crtc_state *old_crtc_state;
672 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
673 const struct drm_encoder_helper_funcs *funcs;
674 struct drm_encoder *encoder;
676 /* Shut down everything that's in the changeset and currently
677 * still on. So need to check the old, saved state. */
678 if (!old_conn_state->crtc)
681 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
682 old_conn_state->crtc);
684 if (!old_crtc_state->active ||
685 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
688 encoder = old_conn_state->best_encoder;
690 /* We shouldn't get this far if we didn't previously have
691 * an encoder.. but WARN_ON() rather than explode.
693 if (WARN_ON(!encoder))
696 funcs = encoder->helper_private;
698 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
699 encoder->base.id, encoder->name);
702 * Each encoder has at most one connector (since we always steal
703 * it away), so we won't call disable hooks twice.
705 drm_bridge_disable(encoder->bridge);
707 /* Right function depends upon target state. */
709 if (connector->state->crtc && funcs->prepare)
710 funcs->prepare(encoder);
711 else if (funcs->disable)
712 funcs->disable(encoder);
713 else if (funcs->dpms)
714 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
717 drm_bridge_post_disable(encoder->bridge);
720 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
721 const struct drm_crtc_helper_funcs *funcs;
723 /* Shut down everything that needs a full modeset. */
724 if (!drm_atomic_crtc_needs_modeset(crtc->state))
727 if (!old_crtc_state->active)
730 funcs = crtc->helper_private;
732 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
733 crtc->base.id, crtc->name);
736 /* Right function depends upon target state. */
737 if (crtc->state->enable && funcs->prepare)
738 funcs->prepare(crtc);
739 else if (funcs->disable)
740 funcs->disable(crtc);
742 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
747 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
749 * @old_state: atomic state object with old state structures
751 * This function updates all the various legacy modeset state pointers in
752 * connectors, encoders and crtcs. It also updates the timestamping constants
753 * used for precise vblank timestamps by calling
754 * drm_calc_timestamping_constants().
756 * Drivers can use this for building their own atomic commit if they don't have
757 * a pure helper-based modeset implementation.
760 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
761 struct drm_atomic_state *old_state)
763 struct drm_connector *connector;
764 struct drm_connector_state *old_conn_state;
765 struct drm_crtc *crtc;
766 struct drm_crtc_state *old_crtc_state;
769 /* clear out existing links and update dpms */
770 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
771 if (connector->encoder) {
772 WARN_ON(!connector->encoder->crtc);
774 connector->encoder->crtc = NULL;
775 connector->encoder = NULL;
778 crtc = connector->state->crtc;
779 if ((!crtc && old_conn_state->crtc) ||
780 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
781 struct drm_property *dpms_prop =
782 dev->mode_config.dpms_property;
783 int mode = DRM_MODE_DPMS_OFF;
785 if (crtc && crtc->state->active)
786 mode = DRM_MODE_DPMS_ON;
788 connector->dpms = mode;
789 drm_object_property_set_value(&connector->base,
795 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
796 if (!connector->state->crtc)
799 if (WARN_ON(!connector->state->best_encoder))
802 connector->encoder = connector->state->best_encoder;
803 connector->encoder->crtc = connector->state->crtc;
806 /* set legacy state in the crtc structure */
807 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
808 struct drm_plane *primary = crtc->primary;
810 crtc->mode = crtc->state->mode;
811 crtc->enabled = crtc->state->enable;
813 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
814 primary->state->crtc == crtc) {
815 crtc->x = primary->state->src_x >> 16;
816 crtc->y = primary->state->src_y >> 16;
819 if (crtc->state->enable)
820 drm_calc_timestamping_constants(crtc,
821 &crtc->state->adjusted_mode);
824 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
827 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
829 struct drm_crtc *crtc;
830 struct drm_crtc_state *old_crtc_state;
831 struct drm_connector *connector;
832 struct drm_connector_state *old_conn_state;
835 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
836 const struct drm_crtc_helper_funcs *funcs;
838 if (!crtc->state->mode_changed)
841 funcs = crtc->helper_private;
843 if (crtc->state->enable && funcs->mode_set_nofb) {
844 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
845 crtc->base.id, crtc->name);
847 funcs->mode_set_nofb(crtc);
851 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
852 const struct drm_encoder_helper_funcs *funcs;
853 struct drm_crtc_state *new_crtc_state;
854 struct drm_encoder *encoder;
855 struct drm_display_mode *mode, *adjusted_mode;
857 if (!connector->state->best_encoder)
860 encoder = connector->state->best_encoder;
861 funcs = encoder->helper_private;
862 new_crtc_state = connector->state->crtc->state;
863 mode = &new_crtc_state->mode;
864 adjusted_mode = &new_crtc_state->adjusted_mode;
866 if (!new_crtc_state->mode_changed)
869 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
870 encoder->base.id, encoder->name);
873 * Each encoder has at most one connector (since we always steal
874 * it away), so we won't call mode_set hooks twice.
876 if (funcs && funcs->mode_set)
877 funcs->mode_set(encoder, mode, adjusted_mode);
879 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
884 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
886 * @old_state: atomic state object with old state structures
888 * This function shuts down all the outputs that need to be shut down and
889 * prepares them (if required) with the new mode.
891 * For compatibility with legacy crtc helpers this should be called before
892 * drm_atomic_helper_commit_planes(), which is what the default commit function
893 * does. But drivers with different needs can group the modeset commits together
894 * and do the plane commits at the end. This is useful for drivers doing runtime
895 * PM since planes updates then only happen when the CRTC is actually enabled.
897 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
898 struct drm_atomic_state *old_state)
900 disable_outputs(dev, old_state);
902 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
904 crtc_set_mode(dev, old_state);
906 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
909 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
911 * @old_state: atomic state object with old state structures
913 * This function enables all the outputs with the new configuration which had to
914 * be turned off for the update.
916 * For compatibility with legacy crtc helpers this should be called after
917 * drm_atomic_helper_commit_planes(), which is what the default commit function
918 * does. But drivers with different needs can group the modeset commits together
919 * and do the plane commits at the end. This is useful for drivers doing runtime
920 * PM since planes updates then only happen when the CRTC is actually enabled.
922 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
923 struct drm_atomic_state *old_state)
925 struct drm_crtc *crtc;
926 struct drm_crtc_state *old_crtc_state;
927 struct drm_connector *connector;
928 struct drm_connector_state *old_conn_state;
931 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
932 const struct drm_crtc_helper_funcs *funcs;
934 /* Need to filter out CRTCs where only planes change. */
935 if (!drm_atomic_crtc_needs_modeset(crtc->state))
938 if (!crtc->state->active)
941 funcs = crtc->helper_private;
943 if (crtc->state->enable) {
944 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
945 crtc->base.id, crtc->name);
954 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
955 const struct drm_encoder_helper_funcs *funcs;
956 struct drm_encoder *encoder;
958 if (!connector->state->best_encoder)
961 if (!connector->state->crtc->state->active ||
962 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
965 encoder = connector->state->best_encoder;
966 funcs = encoder->helper_private;
968 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
969 encoder->base.id, encoder->name);
972 * Each encoder has at most one connector (since we always steal
973 * it away), so we won't call enable hooks twice.
975 drm_bridge_pre_enable(encoder->bridge);
979 funcs->enable(encoder);
980 else if (funcs->commit)
981 funcs->commit(encoder);
984 drm_bridge_enable(encoder->bridge);
987 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
990 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
992 * @state: atomic state object with old state structures
994 * For implicit sync, driver should fish the exclusive fence out from the
995 * incoming fb's and stash it in the drm_plane_state. This is called after
996 * drm_atomic_helper_swap_state() so it uses the current plane state (and
997 * just uses the atomic state to find the changed planes)
999 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1000 struct drm_atomic_state *state)
1002 /* XXX: implement linux/fence.h first */
1004 struct drm_plane *plane;
1005 struct drm_plane_state *plane_state;
1008 for_each_plane_in_state(state, plane, plane_state, i) {
1009 if (!plane->state->fence)
1012 WARN_ON(!plane->state->fb);
1014 fence_wait(plane->state->fence, false);
1015 fence_put(plane->state->fence);
1016 plane->state->fence = NULL;
1020 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1023 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1025 * @old_state: atomic state object with old state structures
1028 * Checks whether the framebuffer used for this CRTC changes as a result of
1029 * the atomic update. This is useful for drivers which cannot use
1030 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1034 * true if the framebuffer changed.
1036 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1037 struct drm_atomic_state *old_state,
1038 struct drm_crtc *crtc)
1040 struct drm_plane *plane;
1041 struct drm_plane_state *old_plane_state;
1044 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1045 if (plane->state->crtc != crtc &&
1046 old_plane_state->crtc != crtc)
1049 if (plane->state->fb != old_plane_state->fb)
1055 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1058 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1060 * @old_state: atomic state object with old state structures
1062 * Helper to, after atomic commit, wait for vblanks on all effected
1063 * crtcs (ie. before cleaning up old framebuffers using
1064 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1065 * framebuffers have actually changed to optimize for the legacy cursor and
1066 * plane update use-case.
1069 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1070 struct drm_atomic_state *old_state)
1072 struct drm_crtc *crtc;
1073 struct drm_crtc_state *old_crtc_state;
1076 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1077 /* No one cares about the old state, so abuse it for tracking
1078 * and store whether we hold a vblank reference (and should do a
1079 * vblank wait) in the ->enable boolean. */
1080 old_crtc_state->enable = false;
1082 if (!crtc->state->enable)
1085 /* Legacy cursor ioctls are completely unsynced, and userspace
1086 * relies on that (by doing tons of cursor updates). */
1087 if (old_state->legacy_cursor_update)
1090 if (!drm_atomic_helper_framebuffer_changed(dev,
1094 ret = drm_crtc_vblank_get(crtc);
1098 old_crtc_state->enable = true;
1099 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1102 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1103 if (!old_crtc_state->enable)
1106 ret = wait_event_timeout(dev->vblank[i].queue,
1107 old_crtc_state->last_vblank_count !=
1108 drm_crtc_vblank_count(crtc),
1109 msecs_to_jiffies(50));
1111 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1113 drm_crtc_vblank_put(crtc);
1116 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1119 * drm_atomic_helper_commit - commit validated state object
1121 * @state: the driver state object
1122 * @nonblocking: whether nonblocking behavior is requested.
1124 * This function commits a with drm_atomic_helper_check() pre-validated state
1125 * object. This can still fail when e.g. the framebuffer reservation fails. For
1126 * now this doesn't implement nonblocking commits.
1128 * Note that right now this function does not support nonblocking commits, hence
1129 * driver writers must implement their own version for now. Also note that the
1130 * default ordering of how the various stages are called is to match the legacy
1131 * modeset helper library closest. One peculiarity of that is that it doesn't
1132 * mesh well with runtime PM at all.
1134 * For drivers supporting runtime PM the recommended sequence is
1136 * drm_atomic_helper_commit_modeset_disables(dev, state);
1138 * drm_atomic_helper_commit_modeset_enables(dev, state);
1140 * drm_atomic_helper_commit_planes(dev, state, true);
1142 * See the kerneldoc entries for these three functions for more details.
1145 * Zero for success or -errno.
1147 int drm_atomic_helper_commit(struct drm_device *dev,
1148 struct drm_atomic_state *state,
1156 ret = drm_atomic_helper_prepare_planes(dev, state);
1161 * This is the point of no return - everything below never fails except
1162 * when the hw goes bonghits. Which means we can commit the new state on
1163 * the software side now.
1166 drm_atomic_helper_swap_state(dev, state);
1169 * Everything below can be run asynchronously without the need to grab
1170 * any modeset locks at all under one condition: It must be guaranteed
1171 * that the asynchronous work has either been cancelled (if the driver
1172 * supports it, which at least requires that the framebuffers get
1173 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1174 * before the new state gets committed on the software side with
1175 * drm_atomic_helper_swap_state().
1177 * This scheme allows new atomic state updates to be prepared and
1178 * checked in parallel to the asynchronous completion of the previous
1179 * update. Which is important since compositors need to figure out the
1180 * composition of the next frame right after having submitted the
1184 drm_atomic_helper_wait_for_fences(dev, state);
1186 drm_atomic_helper_commit_modeset_disables(dev, state);
1188 drm_atomic_helper_commit_planes(dev, state, false);
1190 drm_atomic_helper_commit_modeset_enables(dev, state);
1192 drm_atomic_helper_wait_for_vblanks(dev, state);
1194 drm_atomic_helper_cleanup_planes(dev, state);
1196 drm_atomic_state_free(state);
1200 EXPORT_SYMBOL(drm_atomic_helper_commit);
1203 * DOC: implementing nonblocking commit
1205 * For now the atomic helpers don't support nonblocking commit directly. If
1206 * there is real need it could be added though, using the dma-buf fence
1207 * infrastructure for generic synchronization with outstanding rendering.
1209 * For now drivers have to implement nonblocking commit themselves, with the
1210 * following sequence being the recommended one:
1212 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1213 * which commit needs to call which can fail, so we want to run it first and
1216 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1217 * might be affected the new state update. This can be done by either cancelling
1218 * or flushing the work items, depending upon whether the driver can deal with
1219 * cancelled updates. Note that it is important to ensure that the framebuffer
1220 * cleanup is still done when cancelling.
1222 * For sufficient parallelism it is recommended to have a work item per crtc
1223 * (for updates which don't touch global state) and a global one. Then we only
1224 * need to synchronize with the crtc work items for changed crtcs and the global
1225 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1227 * 3. The software state is updated synchronously with
1228 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1229 * locks means concurrent callers never see inconsistent state. And doing this
1230 * while it's guaranteed that no relevant nonblocking worker runs means that
1231 * nonblocking workers do not need grab any locks. Actually they must not grab
1232 * locks, for otherwise the work flushing will deadlock.
1234 * 4. Schedule a work item to do all subsequent steps, using the split-out
1235 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1236 * then cleaning up the framebuffers after the old framebuffer is no longer
1241 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1243 * @state: atomic state object with new state structures
1245 * This function prepares plane state, specifically framebuffers, for the new
1246 * configuration. If any failure is encountered this function will call
1247 * ->cleanup_fb on any already successfully prepared framebuffer.
1250 * 0 on success, negative error code on failure.
1252 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1253 struct drm_atomic_state *state)
1255 int nplanes = dev->mode_config.num_total_plane;
1258 for (i = 0; i < nplanes; i++) {
1259 const struct drm_plane_helper_funcs *funcs;
1260 struct drm_plane *plane = state->planes[i];
1261 struct drm_plane_state *plane_state = state->plane_states[i];
1266 funcs = plane->helper_private;
1268 if (funcs->prepare_fb) {
1269 ret = funcs->prepare_fb(plane, plane_state);
1278 for (i--; i >= 0; i--) {
1279 const struct drm_plane_helper_funcs *funcs;
1280 struct drm_plane *plane = state->planes[i];
1281 struct drm_plane_state *plane_state = state->plane_states[i];
1286 funcs = plane->helper_private;
1288 if (funcs->cleanup_fb)
1289 funcs->cleanup_fb(plane, plane_state);
1295 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1297 static bool plane_crtc_active(struct drm_plane_state *state)
1299 return state->crtc && state->crtc->state->active;
1303 * drm_atomic_helper_commit_planes - commit plane state
1305 * @old_state: atomic state object with old state structures
1306 * @active_only: Only commit on active CRTC if set
1308 * This function commits the new plane state using the plane and atomic helper
1309 * functions for planes and crtcs. It assumes that the atomic state has already
1310 * been pushed into the relevant object state pointers, since this step can no
1313 * It still requires the global state object @old_state to know which planes and
1314 * crtcs need to be updated though.
1316 * Note that this function does all plane updates across all CRTCs in one step.
1317 * If the hardware can't support this approach look at
1318 * drm_atomic_helper_commit_planes_on_crtc() instead.
1320 * Plane parameters can be updated by applications while the associated CRTC is
1321 * disabled. The DRM/KMS core will store the parameters in the plane state,
1322 * which will be available to the driver when the CRTC is turned on. As a result
1323 * most drivers don't need to be immediately notified of plane updates for a
1326 * Unless otherwise needed, drivers are advised to set the @active_only
1327 * parameters to true in order not to receive plane update notifications related
1328 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1329 * driver code when the driver and/or hardware can't or just don't need to deal
1330 * with updates on disabled CRTCs, for example when supporting runtime PM.
1332 * The drm_atomic_helper_commit() default implementation only sets @active_only
1333 * to false to most closely match the behaviour of the legacy helpers. This should
1334 * not be copied blindly by drivers.
1336 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1337 struct drm_atomic_state *old_state,
1340 struct drm_crtc *crtc;
1341 struct drm_crtc_state *old_crtc_state;
1342 struct drm_plane *plane;
1343 struct drm_plane_state *old_plane_state;
1346 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1347 const struct drm_crtc_helper_funcs *funcs;
1349 funcs = crtc->helper_private;
1351 if (!funcs || !funcs->atomic_begin)
1354 if (active_only && !crtc->state->active)
1357 funcs->atomic_begin(crtc, old_crtc_state);
1360 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1361 const struct drm_plane_helper_funcs *funcs;
1364 funcs = plane->helper_private;
1369 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1373 * Skip planes related to inactive CRTCs. If the plane
1374 * is enabled use the state of the current CRTC. If the
1375 * plane is being disabled use the state of the old
1376 * CRTC to avoid skipping planes being disabled on an
1379 if (!disabling && !plane_crtc_active(plane->state))
1381 if (disabling && !plane_crtc_active(old_plane_state))
1386 * Special-case disabling the plane if drivers support it.
1388 if (disabling && funcs->atomic_disable)
1389 funcs->atomic_disable(plane, old_plane_state);
1390 else if (plane->state->crtc || disabling)
1391 funcs->atomic_update(plane, old_plane_state);
1394 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1395 const struct drm_crtc_helper_funcs *funcs;
1397 funcs = crtc->helper_private;
1399 if (!funcs || !funcs->atomic_flush)
1402 if (active_only && !crtc->state->active)
1405 funcs->atomic_flush(crtc, old_crtc_state);
1408 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1411 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1412 * @old_crtc_state: atomic state object with the old crtc state
1414 * This function commits the new plane state using the plane and atomic helper
1415 * functions for planes on the specific crtc. It assumes that the atomic state
1416 * has already been pushed into the relevant object state pointers, since this
1417 * step can no longer fail.
1419 * This function is useful when plane updates should be done crtc-by-crtc
1420 * instead of one global step like drm_atomic_helper_commit_planes() does.
1422 * This function can only be savely used when planes are not allowed to move
1423 * between different CRTCs because this function doesn't handle inter-CRTC
1424 * depencies. Callers need to ensure that either no such depencies exist,
1425 * resolve them through ordering of commit calls or through some other means.
1428 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1430 const struct drm_crtc_helper_funcs *crtc_funcs;
1431 struct drm_crtc *crtc = old_crtc_state->crtc;
1432 struct drm_atomic_state *old_state = old_crtc_state->state;
1433 struct drm_plane *plane;
1434 unsigned plane_mask;
1436 plane_mask = old_crtc_state->plane_mask;
1437 plane_mask |= crtc->state->plane_mask;
1439 crtc_funcs = crtc->helper_private;
1440 if (crtc_funcs && crtc_funcs->atomic_begin)
1441 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1443 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1444 struct drm_plane_state *old_plane_state =
1445 drm_atomic_get_existing_plane_state(old_state, plane);
1446 const struct drm_plane_helper_funcs *plane_funcs;
1448 plane_funcs = plane->helper_private;
1450 if (!old_plane_state || !plane_funcs)
1453 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1455 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1456 plane_funcs->atomic_disable)
1457 plane_funcs->atomic_disable(plane, old_plane_state);
1458 else if (plane->state->crtc ||
1459 drm_atomic_plane_disabling(plane, old_plane_state))
1460 plane_funcs->atomic_update(plane, old_plane_state);
1463 if (crtc_funcs && crtc_funcs->atomic_flush)
1464 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1466 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1469 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1471 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1473 * Disables all planes associated with the given CRTC. This can be
1474 * used for instance in the CRTC helper disable callback to disable
1475 * all planes before shutting down the display pipeline.
1477 * If the atomic-parameter is set the function calls the CRTC's
1478 * atomic_begin hook before and atomic_flush hook after disabling the
1481 * It is a bug to call this function without having implemented the
1482 * ->atomic_disable() plane hook.
1484 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1487 const struct drm_crtc_helper_funcs *crtc_funcs =
1488 crtc->helper_private;
1489 struct drm_plane *plane;
1491 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1492 crtc_funcs->atomic_begin(crtc, NULL);
1494 drm_for_each_plane(plane, crtc->dev) {
1495 const struct drm_plane_helper_funcs *plane_funcs =
1496 plane->helper_private;
1498 if (plane->state->crtc != crtc || !plane_funcs)
1501 WARN_ON(!plane_funcs->atomic_disable);
1502 if (plane_funcs->atomic_disable)
1503 plane_funcs->atomic_disable(plane, NULL);
1506 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1507 crtc_funcs->atomic_flush(crtc, NULL);
1509 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1512 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1514 * @old_state: atomic state object with old state structures
1516 * This function cleans up plane state, specifically framebuffers, from the old
1517 * configuration. Hence the old configuration must be perserved in @old_state to
1518 * be able to call this function.
1520 * This function must also be called on the new state when the atomic update
1521 * fails at any point after calling drm_atomic_helper_prepare_planes().
1523 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1524 struct drm_atomic_state *old_state)
1526 struct drm_plane *plane;
1527 struct drm_plane_state *plane_state;
1530 for_each_plane_in_state(old_state, plane, plane_state, i) {
1531 const struct drm_plane_helper_funcs *funcs;
1533 funcs = plane->helper_private;
1535 if (funcs->cleanup_fb)
1536 funcs->cleanup_fb(plane, plane_state);
1539 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1542 * drm_atomic_helper_swap_state - store atomic state into current sw state
1544 * @state: atomic state
1546 * This function stores the atomic state into the current state pointers in all
1547 * driver objects. It should be called after all failing steps have been done
1548 * and succeeded, but before the actual hardware state is committed.
1550 * For cleanup and error recovery the current state for all changed objects will
1551 * be swaped into @state.
1553 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1555 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1557 * 2. Do any other steps that might fail.
1559 * 3. Put the staged state into the current state pointers with this function.
1561 * 4. Actually commit the hardware state.
1563 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1564 * contains the old state. Also do any other cleanup required with that state.
1566 void drm_atomic_helper_swap_state(struct drm_device *dev,
1567 struct drm_atomic_state *state)
1571 for (i = 0; i < state->num_connector; i++) {
1572 struct drm_connector *connector = state->connectors[i];
1577 connector->state->state = state;
1578 swap(state->connector_states[i], connector->state);
1579 connector->state->state = NULL;
1582 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1583 struct drm_crtc *crtc = state->crtcs[i];
1588 crtc->state->state = state;
1589 swap(state->crtc_states[i], crtc->state);
1590 crtc->state->state = NULL;
1593 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1594 struct drm_plane *plane = state->planes[i];
1599 plane->state->state = state;
1600 swap(state->plane_states[i], plane->state);
1601 plane->state->state = NULL;
1604 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1607 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1608 * @plane: plane object to update
1609 * @crtc: owning CRTC of owning plane
1610 * @fb: framebuffer to flip onto plane
1611 * @crtc_x: x offset of primary plane on crtc
1612 * @crtc_y: y offset of primary plane on crtc
1613 * @crtc_w: width of primary plane rectangle on crtc
1614 * @crtc_h: height of primary plane rectangle on crtc
1615 * @src_x: x offset of @fb for panning
1616 * @src_y: y offset of @fb for panning
1617 * @src_w: width of source rectangle in @fb
1618 * @src_h: height of source rectangle in @fb
1620 * Provides a default plane update handler using the atomic driver interface.
1623 * Zero on success, error code on failure
1625 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1626 struct drm_crtc *crtc,
1627 struct drm_framebuffer *fb,
1628 int crtc_x, int crtc_y,
1629 unsigned int crtc_w, unsigned int crtc_h,
1630 uint32_t src_x, uint32_t src_y,
1631 uint32_t src_w, uint32_t src_h)
1633 struct drm_atomic_state *state;
1634 struct drm_plane_state *plane_state;
1637 state = drm_atomic_state_alloc(plane->dev);
1641 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1643 plane_state = drm_atomic_get_plane_state(state, plane);
1644 if (IS_ERR(plane_state)) {
1645 ret = PTR_ERR(plane_state);
1649 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1652 drm_atomic_set_fb_for_plane(plane_state, fb);
1653 plane_state->crtc_x = crtc_x;
1654 plane_state->crtc_y = crtc_y;
1655 plane_state->crtc_w = crtc_w;
1656 plane_state->crtc_h = crtc_h;
1657 plane_state->src_x = src_x;
1658 plane_state->src_y = src_y;
1659 plane_state->src_w = src_w;
1660 plane_state->src_h = src_h;
1662 if (plane == crtc->cursor)
1663 state->legacy_cursor_update = true;
1665 ret = drm_atomic_commit(state);
1669 /* Driver takes ownership of state on successful commit. */
1672 if (ret == -EDEADLK)
1675 drm_atomic_state_free(state);
1679 drm_atomic_state_clear(state);
1680 drm_atomic_legacy_backoff(state);
1683 * Someone might have exchanged the framebuffer while we dropped locks
1684 * in the backoff code. We need to fix up the fb refcount tracking the
1687 plane->old_fb = plane->fb;
1691 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1694 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1695 * @plane: plane to disable
1697 * Provides a default plane disable handler using the atomic driver interface.
1700 * Zero on success, error code on failure
1702 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1704 struct drm_atomic_state *state;
1705 struct drm_plane_state *plane_state;
1709 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1710 * acquire context. The real fix will be to wire the acquire ctx through
1711 * everywhere we need it, but meanwhile prevent chaos by just skipping
1712 * this noop. The critical case is the cursor ioctls which a) only grab
1713 * crtc/cursor-plane locks (so we need the crtc to get at the right
1714 * acquire context) and b) can try to disable the plane multiple times.
1719 state = drm_atomic_state_alloc(plane->dev);
1723 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1725 plane_state = drm_atomic_get_plane_state(state, plane);
1726 if (IS_ERR(plane_state)) {
1727 ret = PTR_ERR(plane_state);
1731 if (plane_state->crtc && (plane == plane->crtc->cursor))
1732 plane_state->state->legacy_cursor_update = true;
1734 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1738 ret = drm_atomic_commit(state);
1742 /* Driver takes ownership of state on successful commit. */
1745 if (ret == -EDEADLK)
1748 drm_atomic_state_free(state);
1752 drm_atomic_state_clear(state);
1753 drm_atomic_legacy_backoff(state);
1756 * Someone might have exchanged the framebuffer while we dropped locks
1757 * in the backoff code. We need to fix up the fb refcount tracking the
1760 plane->old_fb = plane->fb;
1764 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1766 /* just used from fb-helper and atomic-helper: */
1767 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1768 struct drm_plane_state *plane_state)
1772 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1776 drm_atomic_set_fb_for_plane(plane_state, NULL);
1777 plane_state->crtc_x = 0;
1778 plane_state->crtc_y = 0;
1779 plane_state->crtc_w = 0;
1780 plane_state->crtc_h = 0;
1781 plane_state->src_x = 0;
1782 plane_state->src_y = 0;
1783 plane_state->src_w = 0;
1784 plane_state->src_h = 0;
1789 static int update_output_state(struct drm_atomic_state *state,
1790 struct drm_mode_set *set)
1792 struct drm_device *dev = set->crtc->dev;
1793 struct drm_crtc *crtc;
1794 struct drm_crtc_state *crtc_state;
1795 struct drm_connector *connector;
1796 struct drm_connector_state *conn_state;
1799 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1800 state->acquire_ctx);
1804 /* First disable all connectors on the target crtc. */
1805 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1809 for_each_connector_in_state(state, connector, conn_state, i) {
1810 if (conn_state->crtc == set->crtc) {
1811 ret = drm_atomic_set_crtc_for_connector(conn_state,
1818 /* Then set all connectors from set->connectors on the target crtc */
1819 for (i = 0; i < set->num_connectors; i++) {
1820 conn_state = drm_atomic_get_connector_state(state,
1821 set->connectors[i]);
1822 if (IS_ERR(conn_state))
1823 return PTR_ERR(conn_state);
1825 ret = drm_atomic_set_crtc_for_connector(conn_state,
1831 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1832 /* Don't update ->enable for the CRTC in the set_config request,
1833 * since a mismatch would indicate a bug in the upper layers.
1834 * The actual modeset code later on will catch any
1835 * inconsistencies here. */
1836 if (crtc == set->crtc)
1839 if (!crtc_state->connector_mask) {
1840 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1845 crtc_state->active = false;
1853 * drm_atomic_helper_set_config - set a new config from userspace
1854 * @set: mode set configuration
1856 * Provides a default crtc set_config handler using the atomic driver interface.
1859 * Returns 0 on success, negative errno numbers on failure.
1861 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1863 struct drm_atomic_state *state;
1864 struct drm_crtc *crtc = set->crtc;
1867 state = drm_atomic_state_alloc(crtc->dev);
1871 state->legacy_set_config = true;
1872 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1874 ret = __drm_atomic_helper_set_config(set, state);
1878 ret = drm_atomic_commit(state);
1882 /* Driver takes ownership of state on successful commit. */
1885 if (ret == -EDEADLK)
1888 drm_atomic_state_free(state);
1892 drm_atomic_state_clear(state);
1893 drm_atomic_legacy_backoff(state);
1896 * Someone might have exchanged the framebuffer while we dropped locks
1897 * in the backoff code. We need to fix up the fb refcount tracking the
1900 crtc->primary->old_fb = crtc->primary->fb;
1904 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1906 /* just used from fb-helper and atomic-helper: */
1907 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1908 struct drm_atomic_state *state)
1910 struct drm_crtc_state *crtc_state;
1911 struct drm_plane_state *primary_state;
1912 struct drm_crtc *crtc = set->crtc;
1913 int hdisplay, vdisplay;
1916 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1917 if (IS_ERR(crtc_state))
1918 return PTR_ERR(crtc_state);
1920 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1921 if (IS_ERR(primary_state))
1922 return PTR_ERR(primary_state);
1926 WARN_ON(set->num_connectors);
1928 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1932 crtc_state->active = false;
1934 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1938 drm_atomic_set_fb_for_plane(primary_state, NULL);
1944 WARN_ON(!set->num_connectors);
1946 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1950 crtc_state->active = true;
1952 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1956 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1958 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1959 primary_state->crtc_x = 0;
1960 primary_state->crtc_y = 0;
1961 primary_state->crtc_w = hdisplay;
1962 primary_state->crtc_h = vdisplay;
1963 primary_state->src_x = set->x << 16;
1964 primary_state->src_y = set->y << 16;
1965 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1966 primary_state->src_w = vdisplay << 16;
1967 primary_state->src_h = hdisplay << 16;
1969 primary_state->src_w = hdisplay << 16;
1970 primary_state->src_h = vdisplay << 16;
1974 ret = update_output_state(state, set);
1982 * drm_atomic_helper_disable_all - disable all currently active outputs
1984 * @ctx: lock acquisition context
1986 * Loops through all connectors, finding those that aren't turned off and then
1987 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1988 * that they are connected to.
1990 * This is used for example in suspend/resume to disable all currently active
1991 * functions when suspending.
1993 * Note that if callers haven't already acquired all modeset locks this might
1994 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1997 * 0 on success or a negative error code on failure.
2000 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2002 int drm_atomic_helper_disable_all(struct drm_device *dev,
2003 struct drm_modeset_acquire_ctx *ctx)
2005 struct drm_atomic_state *state;
2006 struct drm_connector *conn;
2009 state = drm_atomic_state_alloc(dev);
2013 state->acquire_ctx = ctx;
2015 drm_for_each_connector(conn, dev) {
2016 struct drm_crtc *crtc = conn->state->crtc;
2017 struct drm_crtc_state *crtc_state;
2019 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2022 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2023 if (IS_ERR(crtc_state)) {
2024 err = PTR_ERR(crtc_state);
2028 crtc_state->active = false;
2031 err = drm_atomic_commit(state);
2035 drm_atomic_state_free(state);
2039 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2042 * drm_atomic_helper_suspend - subsystem-level suspend helper
2045 * Duplicates the current atomic state, disables all active outputs and then
2046 * returns a pointer to the original atomic state to the caller. Drivers can
2047 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2048 * restore the output configuration that was active at the time the system
2051 * Note that it is potentially unsafe to use this. The atomic state object
2052 * returned by this function is assumed to be persistent. Drivers must ensure
2053 * that this holds true. Before calling this function, drivers must make sure
2054 * to suspend fbdev emulation so that nothing can be using the device.
2057 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2058 * encoded error code on failure. Drivers should store the returned atomic
2059 * state object and pass it to the drm_atomic_helper_resume() helper upon
2063 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2064 * drm_atomic_helper_resume()
2066 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2068 struct drm_modeset_acquire_ctx ctx;
2069 struct drm_atomic_state *state;
2072 drm_modeset_acquire_init(&ctx, 0);
2075 err = drm_modeset_lock_all_ctx(dev, &ctx);
2077 state = ERR_PTR(err);
2081 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2085 err = drm_atomic_helper_disable_all(dev, &ctx);
2087 drm_atomic_state_free(state);
2088 state = ERR_PTR(err);
2093 if (PTR_ERR(state) == -EDEADLK) {
2094 drm_modeset_backoff(&ctx);
2098 drm_modeset_drop_locks(&ctx);
2099 drm_modeset_acquire_fini(&ctx);
2102 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2105 * drm_atomic_helper_resume - subsystem-level resume helper
2107 * @state: atomic state to resume to
2109 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2110 * grabs all modeset locks and commits the atomic state object. This can be
2111 * used in conjunction with the drm_atomic_helper_suspend() helper to
2112 * implement suspend/resume for drivers that support atomic mode-setting.
2115 * 0 on success or a negative error code on failure.
2118 * drm_atomic_helper_suspend()
2120 int drm_atomic_helper_resume(struct drm_device *dev,
2121 struct drm_atomic_state *state)
2123 struct drm_mode_config *config = &dev->mode_config;
2126 drm_mode_config_reset(dev);
2127 drm_modeset_lock_all(dev);
2128 state->acquire_ctx = config->acquire_ctx;
2129 err = drm_atomic_commit(state);
2130 drm_modeset_unlock_all(dev);
2134 EXPORT_SYMBOL(drm_atomic_helper_resume);
2137 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2139 * @property: DRM property
2140 * @val: value of property
2142 * Provides a default crtc set_property handler using the atomic driver
2146 * Zero on success, error code on failure
2149 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2150 struct drm_property *property,
2153 struct drm_atomic_state *state;
2154 struct drm_crtc_state *crtc_state;
2157 state = drm_atomic_state_alloc(crtc->dev);
2161 /* ->set_property is always called with all locks held. */
2162 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2164 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2165 if (IS_ERR(crtc_state)) {
2166 ret = PTR_ERR(crtc_state);
2170 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2175 ret = drm_atomic_commit(state);
2179 /* Driver takes ownership of state on successful commit. */
2182 if (ret == -EDEADLK)
2185 drm_atomic_state_free(state);
2189 drm_atomic_state_clear(state);
2190 drm_atomic_legacy_backoff(state);
2194 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2197 * drm_atomic_helper_plane_set_property - helper for plane properties
2199 * @property: DRM property
2200 * @val: value of property
2202 * Provides a default plane set_property handler using the atomic driver
2206 * Zero on success, error code on failure
2209 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2210 struct drm_property *property,
2213 struct drm_atomic_state *state;
2214 struct drm_plane_state *plane_state;
2217 state = drm_atomic_state_alloc(plane->dev);
2221 /* ->set_property is always called with all locks held. */
2222 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2224 plane_state = drm_atomic_get_plane_state(state, plane);
2225 if (IS_ERR(plane_state)) {
2226 ret = PTR_ERR(plane_state);
2230 ret = drm_atomic_plane_set_property(plane, plane_state,
2235 ret = drm_atomic_commit(state);
2239 /* Driver takes ownership of state on successful commit. */
2242 if (ret == -EDEADLK)
2245 drm_atomic_state_free(state);
2249 drm_atomic_state_clear(state);
2250 drm_atomic_legacy_backoff(state);
2254 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2257 * drm_atomic_helper_connector_set_property - helper for connector properties
2258 * @connector: DRM connector
2259 * @property: DRM property
2260 * @val: value of property
2262 * Provides a default connector set_property handler using the atomic driver
2266 * Zero on success, error code on failure
2269 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2270 struct drm_property *property,
2273 struct drm_atomic_state *state;
2274 struct drm_connector_state *connector_state;
2277 state = drm_atomic_state_alloc(connector->dev);
2281 /* ->set_property is always called with all locks held. */
2282 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2284 connector_state = drm_atomic_get_connector_state(state, connector);
2285 if (IS_ERR(connector_state)) {
2286 ret = PTR_ERR(connector_state);
2290 ret = drm_atomic_connector_set_property(connector, connector_state,
2295 ret = drm_atomic_commit(state);
2299 /* Driver takes ownership of state on successful commit. */
2302 if (ret == -EDEADLK)
2305 drm_atomic_state_free(state);
2309 drm_atomic_state_clear(state);
2310 drm_atomic_legacy_backoff(state);
2314 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2317 * drm_atomic_helper_page_flip - execute a legacy page flip
2319 * @fb: DRM framebuffer
2320 * @event: optional DRM event to signal upon completion
2321 * @flags: flip flags for non-vblank sync'ed updates
2323 * Provides a default page flip implementation using the atomic driver interface.
2325 * Note that for now so called async page flips (i.e. updates which are not
2326 * synchronized to vblank) are not supported, since the atomic interfaces have
2327 * no provisions for this yet.
2330 * Returns 0 on success, negative errno numbers on failure.
2332 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2333 struct drm_framebuffer *fb,
2334 struct drm_pending_vblank_event *event,
2337 struct drm_plane *plane = crtc->primary;
2338 struct drm_atomic_state *state;
2339 struct drm_plane_state *plane_state;
2340 struct drm_crtc_state *crtc_state;
2343 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2346 state = drm_atomic_state_alloc(plane->dev);
2350 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2352 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2353 if (IS_ERR(crtc_state)) {
2354 ret = PTR_ERR(crtc_state);
2357 crtc_state->event = event;
2359 plane_state = drm_atomic_get_plane_state(state, plane);
2360 if (IS_ERR(plane_state)) {
2361 ret = PTR_ERR(plane_state);
2365 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2368 drm_atomic_set_fb_for_plane(plane_state, fb);
2370 /* Make sure we don't accidentally do a full modeset. */
2371 state->allow_modeset = false;
2372 if (!crtc_state->active) {
2373 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2379 ret = drm_atomic_nonblocking_commit(state);
2383 /* Driver takes ownership of state on successful commit. */
2386 if (ret == -EDEADLK)
2389 drm_atomic_state_free(state);
2393 drm_atomic_state_clear(state);
2394 drm_atomic_legacy_backoff(state);
2397 * Someone might have exchanged the framebuffer while we dropped locks
2398 * in the backoff code. We need to fix up the fb refcount tracking the
2401 plane->old_fb = plane->fb;
2405 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2408 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2409 * @connector: affected connector
2412 * This is the main helper function provided by the atomic helper framework for
2413 * implementing the legacy DPMS connector interface. It computes the new desired
2414 * ->active state for the corresponding CRTC (if the connector is enabled) and
2418 * Returns 0 on success, negative errno numbers on failure.
2420 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2423 struct drm_mode_config *config = &connector->dev->mode_config;
2424 struct drm_atomic_state *state;
2425 struct drm_crtc_state *crtc_state;
2426 struct drm_crtc *crtc;
2427 struct drm_connector *tmp_connector;
2429 bool active = false;
2430 int old_mode = connector->dpms;
2432 if (mode != DRM_MODE_DPMS_ON)
2433 mode = DRM_MODE_DPMS_OFF;
2435 connector->dpms = mode;
2436 crtc = connector->state->crtc;
2441 state = drm_atomic_state_alloc(connector->dev);
2445 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2447 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2448 if (IS_ERR(crtc_state)) {
2449 ret = PTR_ERR(crtc_state);
2453 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2455 drm_for_each_connector(tmp_connector, connector->dev) {
2456 if (tmp_connector->state->crtc != crtc)
2459 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2464 crtc_state->active = active;
2466 ret = drm_atomic_commit(state);
2470 /* Driver takes ownership of state on successful commit. */
2473 if (ret == -EDEADLK)
2476 connector->dpms = old_mode;
2477 drm_atomic_state_free(state);
2481 drm_atomic_state_clear(state);
2482 drm_atomic_legacy_backoff(state);
2486 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2489 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2490 * ->best_encoder callback
2491 * @connector: Connector control structure
2493 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2494 * connectors that support exactly 1 encoder, statically determined at driver
2497 struct drm_encoder *
2498 drm_atomic_helper_best_encoder(struct drm_connector *connector)
2500 WARN_ON(connector->encoder_ids[1]);
2501 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
2503 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
2506 * DOC: atomic state reset and initialization
2508 * Both the drm core and the atomic helpers assume that there is always the full
2509 * and correct atomic software state for all connectors, CRTCs and planes
2510 * available. Which is a bit a problem on driver load and also after system
2511 * suspend. One way to solve this is to have a hardware state read-out
2512 * infrastructure which reconstructs the full software state (e.g. the i915
2515 * The simpler solution is to just reset the software state to everything off,
2516 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2517 * the atomic helpers provide default reset implementations for all hooks.
2519 * On the upside the precise state tracking of atomic simplifies system suspend
2520 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2521 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2522 * For other drivers the building blocks are split out, see the documentation
2523 * for these functions.
2527 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2530 * Resets the atomic state for @crtc by freeing the state pointer (which might
2531 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2533 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2536 __drm_atomic_helper_crtc_destroy_state(crtc->state);
2539 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2542 crtc->state->crtc = crtc;
2544 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2547 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2548 * @crtc: CRTC object
2549 * @state: atomic CRTC state
2551 * Copies atomic state from a CRTC's current state and resets inferred values.
2552 * This is useful for drivers that subclass the CRTC state.
2554 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2555 struct drm_crtc_state *state)
2557 memcpy(state, crtc->state, sizeof(*state));
2559 if (state->mode_blob)
2560 drm_property_reference_blob(state->mode_blob);
2561 if (state->degamma_lut)
2562 drm_property_reference_blob(state->degamma_lut);
2564 drm_property_reference_blob(state->ctm);
2565 if (state->gamma_lut)
2566 drm_property_reference_blob(state->gamma_lut);
2567 state->mode_changed = false;
2568 state->active_changed = false;
2569 state->planes_changed = false;
2570 state->connectors_changed = false;
2571 state->color_mgmt_changed = false;
2572 state->event = NULL;
2574 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2577 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2580 * Default CRTC state duplicate hook for drivers which don't have their own
2581 * subclassed CRTC state structure.
2583 struct drm_crtc_state *
2584 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2586 struct drm_crtc_state *state;
2588 if (WARN_ON(!crtc->state))
2591 state = kmalloc(sizeof(*state), M_DRM, M_WAITOK);
2593 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2597 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2600 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2601 * @state: CRTC state object to release
2603 * Releases all resources stored in the CRTC state without actually freeing
2604 * the memory of the CRTC state. This is useful for drivers that subclass the
2607 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
2609 drm_property_unreference_blob(state->mode_blob);
2610 drm_property_unreference_blob(state->degamma_lut);
2611 drm_property_unreference_blob(state->ctm);
2612 drm_property_unreference_blob(state->gamma_lut);
2614 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2617 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2619 * @state: CRTC state object to release
2621 * Default CRTC state destroy hook for drivers which don't have their own
2622 * subclassed CRTC state structure.
2624 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2625 struct drm_crtc_state *state)
2627 __drm_atomic_helper_crtc_destroy_state(state);
2630 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2633 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2636 * Resets the atomic state for @plane by freeing the state pointer (which might
2637 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2639 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2642 __drm_atomic_helper_plane_destroy_state(plane->state);
2644 kfree(plane->state);
2645 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2648 plane->state->plane = plane;
2649 plane->state->rotation = BIT(DRM_ROTATE_0);
2652 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2655 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2656 * @plane: plane object
2657 * @state: atomic plane state
2659 * Copies atomic state from a plane's current state. This is useful for
2660 * drivers that subclass the plane state.
2662 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2663 struct drm_plane_state *state)
2665 memcpy(state, plane->state, sizeof(*state));
2668 drm_framebuffer_reference(state->fb);
2670 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2673 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2676 * Default plane state duplicate hook for drivers which don't have their own
2677 * subclassed plane state structure.
2679 struct drm_plane_state *
2680 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2682 struct drm_plane_state *state;
2684 if (WARN_ON(!plane->state))
2687 state = kmalloc(sizeof(*state), M_DRM, M_WAITOK);
2689 __drm_atomic_helper_plane_duplicate_state(plane, state);
2693 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2696 * __drm_atomic_helper_plane_destroy_state - release plane state
2697 * @state: plane state object to release
2699 * Releases all resources stored in the plane state without actually freeing
2700 * the memory of the plane state. This is useful for drivers that subclass the
2703 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
2706 drm_framebuffer_unreference(state->fb);
2708 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2711 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2713 * @state: plane state object to release
2715 * Default plane state destroy hook for drivers which don't have their own
2716 * subclassed plane state structure.
2718 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2719 struct drm_plane_state *state)
2721 __drm_atomic_helper_plane_destroy_state(state);
2724 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2727 * __drm_atomic_helper_connector_reset - reset state on connector
2728 * @connector: drm connector
2729 * @conn_state: connector state to assign
2731 * Initializes the newly allocated @conn_state and assigns it to
2732 * #connector ->state, usually required when initializing the drivers
2733 * or when called from the ->reset hook.
2735 * This is useful for drivers that subclass the connector state.
2738 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2739 struct drm_connector_state *conn_state)
2742 conn_state->connector = connector;
2744 connector->state = conn_state;
2746 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2749 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2750 * @connector: drm connector
2752 * Resets the atomic state for @connector by freeing the state pointer (which
2753 * might be NULL, e.g. at driver load time) and allocating a new empty state
2756 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2758 struct drm_connector_state *conn_state =
2759 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2761 if (connector->state)
2762 __drm_atomic_helper_connector_destroy_state(connector->state);
2764 kfree(connector->state);
2765 __drm_atomic_helper_connector_reset(connector, conn_state);
2767 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2770 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2771 * @connector: connector object
2772 * @state: atomic connector state
2774 * Copies atomic state from a connector's current state. This is useful for
2775 * drivers that subclass the connector state.
2778 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2779 struct drm_connector_state *state)
2781 memcpy(state, connector->state, sizeof(*state));
2783 drm_connector_reference(connector);
2785 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2788 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2789 * @connector: drm connector
2791 * Default connector state duplicate hook for drivers which don't have their own
2792 * subclassed connector state structure.
2794 struct drm_connector_state *
2795 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2797 struct drm_connector_state *state;
2799 if (WARN_ON(!connector->state))
2802 state = kmalloc(sizeof(*state), M_DRM, M_WAITOK);
2804 __drm_atomic_helper_connector_duplicate_state(connector, state);
2808 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2811 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2813 * @ctx: lock acquisition context
2815 * Makes a copy of the current atomic state by looping over all objects and
2816 * duplicating their respective states. This is used for example by suspend/
2817 * resume support code to save the state prior to suspend such that it can
2818 * be restored upon resume.
2820 * Note that this treats atomic state as persistent between save and restore.
2821 * Drivers must make sure that this is possible and won't result in confusion
2822 * or erroneous behaviour.
2824 * Note that if callers haven't already acquired all modeset locks this might
2825 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2828 * A pointer to the copy of the atomic state object on success or an
2829 * ERR_PTR()-encoded error code on failure.
2832 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2834 struct drm_atomic_state *
2835 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2836 struct drm_modeset_acquire_ctx *ctx)
2838 struct drm_atomic_state *state;
2839 struct drm_connector *conn;
2840 struct drm_plane *plane;
2841 struct drm_crtc *crtc;
2844 state = drm_atomic_state_alloc(dev);
2846 return ERR_PTR(-ENOMEM);
2848 state->acquire_ctx = ctx;
2850 drm_for_each_crtc(crtc, dev) {
2851 struct drm_crtc_state *crtc_state;
2853 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2854 if (IS_ERR(crtc_state)) {
2855 err = PTR_ERR(crtc_state);
2860 drm_for_each_plane(plane, dev) {
2861 struct drm_plane_state *plane_state;
2863 plane_state = drm_atomic_get_plane_state(state, plane);
2864 if (IS_ERR(plane_state)) {
2865 err = PTR_ERR(plane_state);
2870 drm_for_each_connector(conn, dev) {
2871 struct drm_connector_state *conn_state;
2873 conn_state = drm_atomic_get_connector_state(state, conn);
2874 if (IS_ERR(conn_state)) {
2875 err = PTR_ERR(conn_state);
2880 /* clear the acquire context so that it isn't accidentally reused */
2881 state->acquire_ctx = NULL;
2885 drm_atomic_state_free(state);
2886 state = ERR_PTR(err);
2891 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2894 * __drm_atomic_helper_connector_destroy_state - release connector state
2895 * @state: connector state object to release
2897 * Releases all resources stored in the connector state without actually
2898 * freeing the memory of the connector state. This is useful for drivers that
2899 * subclass the connector state.
2902 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
2905 * This is currently a placeholder so that drivers that subclass the
2906 * state will automatically do the right thing if code is ever added
2910 drm_connector_unreference(state->connector);
2912 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2915 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2916 * @connector: drm connector
2917 * @state: connector state object to release
2919 * Default connector state destroy hook for drivers which don't have their own
2920 * subclassed connector state structure.
2922 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2923 struct drm_connector_state *state)
2925 __drm_atomic_helper_connector_destroy_state(state);
2928 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2931 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2932 * @crtc: CRTC object
2933 * @red: red correction table
2934 * @green: green correction table
2935 * @blue: green correction table
2937 * @size: size of the tables
2939 * Implements support for legacy gamma correction table for drivers
2940 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2943 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2944 u16 *red, u16 *green, u16 *blue,
2945 uint32_t start, uint32_t size)
2947 struct drm_device *dev = crtc->dev;
2948 struct drm_mode_config *config = &dev->mode_config;
2949 struct drm_atomic_state *state;
2950 struct drm_crtc_state *crtc_state;
2951 struct drm_property_blob *blob = NULL;
2952 struct drm_color_lut *blob_data;
2955 state = drm_atomic_state_alloc(crtc->dev);
2959 blob = drm_property_create_blob(dev,
2960 sizeof(struct drm_color_lut) * size,
2963 ret = PTR_ERR(blob);
2968 /* Prepare GAMMA_LUT with the legacy values. */
2969 blob_data = (struct drm_color_lut *) blob->data;
2970 for (i = 0; i < size; i++) {
2971 blob_data[i].red = red[i];
2972 blob_data[i].green = green[i];
2973 blob_data[i].blue = blue[i];
2976 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2978 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2979 if (IS_ERR(crtc_state)) {
2980 ret = PTR_ERR(crtc_state);
2984 /* Reset DEGAMMA_LUT and CTM properties. */
2985 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2986 config->degamma_lut_property, 0);
2990 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2991 config->ctm_property, 0);
2995 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2996 config->gamma_lut_property, blob->base.id);
3000 ret = drm_atomic_commit(state);
3004 /* Driver takes ownership of state on successful commit. */
3006 drm_property_unreference_blob(blob);
3010 if (ret == -EDEADLK)
3013 drm_atomic_state_free(state);
3014 drm_property_unreference_blob(blob);
3018 drm_atomic_state_clear(state);
3019 drm_atomic_legacy_backoff(state);
3023 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);