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;
390 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
391 &crtc_state->adjusted_mode);
393 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
397 if (funcs->atomic_check) {
398 ret = funcs->atomic_check(encoder, crtc_state,
401 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
402 encoder->base.id, encoder->name);
405 } else if (funcs->mode_fixup) {
406 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
407 &crtc_state->adjusted_mode);
409 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
410 encoder->base.id, encoder->name);
416 for_each_crtc_in_state(state, crtc, crtc_state, i) {
417 const struct drm_crtc_helper_funcs *funcs;
419 if (!crtc_state->mode_changed &&
420 !crtc_state->connectors_changed)
423 funcs = crtc->helper_private;
424 if (!funcs->mode_fixup)
427 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
428 &crtc_state->adjusted_mode);
430 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
431 crtc->base.id, crtc->name);
440 * drm_atomic_helper_check_modeset - validate state object for modeset changes
442 * @state: the driver state object
444 * Check the state object to see if the requested state is physically possible.
445 * This does all the crtc and connector related computations for an atomic
446 * update and adds any additional connectors needed for full modesets and calls
447 * down into ->mode_fixup functions of the driver backend.
449 * crtc_state->mode_changed is set when the input mode is changed.
450 * crtc_state->connectors_changed is set when a connector is added or
451 * removed from the crtc.
452 * crtc_state->active_changed is set when crtc_state->active changes,
453 * which is used for dpms.
457 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
458 * plane update can't be done without a full modeset) _must_ call this function
459 * afterwards after that change. It is permitted to call this function multiple
460 * times for the same update, e.g. when the ->atomic_check functions depend upon
461 * the adjusted dotclock for fifo space allocation and watermark computation.
464 * Zero for success or -errno
467 drm_atomic_helper_check_modeset(struct drm_device *dev,
468 struct drm_atomic_state *state)
470 struct drm_crtc *crtc;
471 struct drm_crtc_state *crtc_state;
472 struct drm_connector *connector;
473 struct drm_connector_state *connector_state;
476 for_each_crtc_in_state(state, crtc, crtc_state, i) {
477 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
478 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
479 crtc->base.id, crtc->name);
480 crtc_state->mode_changed = true;
483 if (crtc->state->enable != crtc_state->enable) {
484 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
485 crtc->base.id, crtc->name);
488 * For clarity this assignment is done here, but
489 * enable == 0 is only true when there are no
490 * connectors and a NULL mode.
492 * The other way around is true as well. enable != 0
493 * iff connectors are attached and a mode is set.
495 crtc_state->mode_changed = true;
496 crtc_state->connectors_changed = true;
500 ret = handle_conflicting_encoders(state, state->legacy_set_config);
504 for_each_connector_in_state(state, connector, connector_state, i) {
506 * This only sets crtc->mode_changed for routing changes,
507 * drivers must set crtc->mode_changed themselves when connector
508 * properties need to be updated.
510 ret = update_connector_routing(state, connector,
517 * After all the routing has been prepared we need to add in any
518 * connector which is itself unchanged, but who's crtc changes it's
519 * configuration. This must be done before calling mode_fixup in case a
520 * crtc only changed its mode but has the same set of connectors.
522 for_each_crtc_in_state(state, crtc, crtc_state, i) {
523 bool has_connectors =
524 !!crtc_state->connector_mask;
527 * We must set ->active_changed after walking connectors for
528 * otherwise an update that only changes active would result in
529 * a full modeset because update_connector_routing force that.
531 if (crtc->state->active != crtc_state->active) {
532 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
533 crtc->base.id, crtc->name);
534 crtc_state->active_changed = true;
537 if (!drm_atomic_crtc_needs_modeset(crtc_state))
540 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
541 crtc->base.id, crtc->name,
542 crtc_state->enable ? 'y' : 'n',
543 crtc_state->active ? 'y' : 'n');
545 ret = drm_atomic_add_affected_connectors(state, crtc);
549 ret = drm_atomic_add_affected_planes(state, crtc);
553 if (crtc_state->enable != has_connectors) {
554 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
555 crtc->base.id, crtc->name);
561 return mode_fixup(state);
563 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
566 * drm_atomic_helper_check_planes - validate state object for planes changes
568 * @state: the driver state object
570 * Check the state object to see if the requested state is physically possible.
571 * This does all the plane update related checks using by calling into the
572 * ->atomic_check hooks provided by the driver.
574 * It also sets crtc_state->planes_changed to indicate that a crtc has
578 * Zero for success or -errno
581 drm_atomic_helper_check_planes(struct drm_device *dev,
582 struct drm_atomic_state *state)
584 struct drm_crtc *crtc;
585 struct drm_crtc_state *crtc_state;
586 struct drm_plane *plane;
587 struct drm_plane_state *plane_state;
590 for_each_plane_in_state(state, plane, plane_state, i) {
591 const struct drm_plane_helper_funcs *funcs;
593 funcs = plane->helper_private;
595 drm_atomic_helper_plane_changed(state, plane_state, plane);
597 if (!funcs || !funcs->atomic_check)
600 ret = funcs->atomic_check(plane, plane_state);
602 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
603 plane->base.id, plane->name);
608 for_each_crtc_in_state(state, crtc, crtc_state, i) {
609 const struct drm_crtc_helper_funcs *funcs;
611 funcs = crtc->helper_private;
613 if (!funcs || !funcs->atomic_check)
616 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
618 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
619 crtc->base.id, crtc->name);
626 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
629 * drm_atomic_helper_check - validate state object
631 * @state: the driver state object
633 * Check the state object to see if the requested state is physically possible.
634 * Only crtcs and planes have check callbacks, so for any additional (global)
635 * checking that a driver needs it can simply wrap that around this function.
636 * Drivers without such needs can directly use this as their ->atomic_check()
639 * This just wraps the two parts of the state checking for planes and modeset
640 * state in the default order: First it calls drm_atomic_helper_check_modeset()
641 * and then drm_atomic_helper_check_planes(). The assumption is that the
642 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
643 * e.g. properly compute watermarks.
646 * Zero for success or -errno
648 int drm_atomic_helper_check(struct drm_device *dev,
649 struct drm_atomic_state *state)
653 ret = drm_atomic_helper_check_modeset(dev, state);
657 ret = drm_atomic_helper_check_planes(dev, state);
663 EXPORT_SYMBOL(drm_atomic_helper_check);
666 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
668 struct drm_connector *connector;
669 struct drm_connector_state *old_conn_state;
670 struct drm_crtc *crtc;
671 struct drm_crtc_state *old_crtc_state;
674 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
675 const struct drm_encoder_helper_funcs *funcs;
676 struct drm_encoder *encoder;
678 /* Shut down everything that's in the changeset and currently
679 * still on. So need to check the old, saved state. */
680 if (!old_conn_state->crtc)
683 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
684 old_conn_state->crtc);
686 if (!old_crtc_state->active ||
687 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
690 encoder = old_conn_state->best_encoder;
692 /* We shouldn't get this far if we didn't previously have
693 * an encoder.. but WARN_ON() rather than explode.
695 if (WARN_ON(!encoder))
698 funcs = encoder->helper_private;
700 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
701 encoder->base.id, encoder->name);
704 * Each encoder has at most one connector (since we always steal
705 * it away), so we won't call disable hooks twice.
707 drm_bridge_disable(encoder->bridge);
709 /* Right function depends upon target state. */
710 if (connector->state->crtc && funcs->prepare)
711 funcs->prepare(encoder);
712 else if (funcs->disable)
713 funcs->disable(encoder);
715 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.
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);
978 funcs->enable(encoder);
980 funcs->commit(encoder);
982 drm_bridge_enable(encoder->bridge);
985 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
988 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
990 * @state: atomic state object with old state structures
992 * For implicit sync, driver should fish the exclusive fence out from the
993 * incoming fb's and stash it in the drm_plane_state. This is called after
994 * drm_atomic_helper_swap_state() so it uses the current plane state (and
995 * just uses the atomic state to find the changed planes)
997 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
998 struct drm_atomic_state *state)
1000 struct drm_plane *plane;
1001 struct drm_plane_state *plane_state;
1004 for_each_plane_in_state(state, plane, plane_state, i) {
1005 if (!plane->state->fence)
1008 WARN_ON(!plane->state->fb);
1010 fence_wait(plane->state->fence, false);
1011 fence_put(plane->state->fence);
1012 plane->state->fence = NULL;
1015 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1018 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1020 * @old_state: atomic state object with old state structures
1023 * Checks whether the framebuffer used for this CRTC changes as a result of
1024 * the atomic update. This is useful for drivers which cannot use
1025 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1029 * true if the framebuffer changed.
1031 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1032 struct drm_atomic_state *old_state,
1033 struct drm_crtc *crtc)
1035 struct drm_plane *plane;
1036 struct drm_plane_state *old_plane_state;
1039 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1040 if (plane->state->crtc != crtc &&
1041 old_plane_state->crtc != crtc)
1044 if (plane->state->fb != old_plane_state->fb)
1050 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1053 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1055 * @old_state: atomic state object with old state structures
1057 * Helper to, after atomic commit, wait for vblanks on all effected
1058 * crtcs (ie. before cleaning up old framebuffers using
1059 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1060 * framebuffers have actually changed to optimize for the legacy cursor and
1061 * plane update use-case.
1064 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1065 struct drm_atomic_state *old_state)
1067 struct drm_crtc *crtc;
1068 struct drm_crtc_state *old_crtc_state;
1071 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1072 /* No one cares about the old state, so abuse it for tracking
1073 * and store whether we hold a vblank reference (and should do a
1074 * vblank wait) in the ->enable boolean. */
1075 old_crtc_state->enable = false;
1077 if (!crtc->state->enable)
1080 /* Legacy cursor ioctls are completely unsynced, and userspace
1081 * relies on that (by doing tons of cursor updates). */
1082 if (old_state->legacy_cursor_update)
1085 if (!drm_atomic_helper_framebuffer_changed(dev,
1089 ret = drm_crtc_vblank_get(crtc);
1093 old_crtc_state->enable = true;
1094 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1097 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1098 if (!old_crtc_state->enable)
1101 ret = wait_event_timeout(dev->vblank[i].queue,
1102 old_crtc_state->last_vblank_count !=
1103 drm_crtc_vblank_count(crtc),
1104 msecs_to_jiffies(50));
1106 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1108 drm_crtc_vblank_put(crtc);
1111 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1114 * drm_atomic_helper_commit - commit validated state object
1116 * @state: the driver state object
1117 * @nonblocking: whether nonblocking behavior is requested.
1119 * This function commits a with drm_atomic_helper_check() pre-validated state
1120 * object. This can still fail when e.g. the framebuffer reservation fails. For
1121 * now this doesn't implement nonblocking commits.
1123 * Note that right now this function does not support nonblocking commits, hence
1124 * driver writers must implement their own version for now. Also note that the
1125 * default ordering of how the various stages are called is to match the legacy
1126 * modeset helper library closest. One peculiarity of that is that it doesn't
1127 * mesh well with runtime PM at all.
1129 * For drivers supporting runtime PM the recommended sequence is
1131 * drm_atomic_helper_commit_modeset_disables(dev, state);
1133 * drm_atomic_helper_commit_modeset_enables(dev, state);
1135 * drm_atomic_helper_commit_planes(dev, state, true);
1137 * See the kerneldoc entries for these three functions for more details.
1140 * Zero for success or -errno.
1142 int drm_atomic_helper_commit(struct drm_device *dev,
1143 struct drm_atomic_state *state,
1151 ret = drm_atomic_helper_prepare_planes(dev, state);
1156 * This is the point of no return - everything below never fails except
1157 * when the hw goes bonghits. Which means we can commit the new state on
1158 * the software side now.
1161 drm_atomic_helper_swap_state(dev, state);
1164 * Everything below can be run asynchronously without the need to grab
1165 * any modeset locks at all under one condition: It must be guaranteed
1166 * that the asynchronous work has either been cancelled (if the driver
1167 * supports it, which at least requires that the framebuffers get
1168 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1169 * before the new state gets committed on the software side with
1170 * drm_atomic_helper_swap_state().
1172 * This scheme allows new atomic state updates to be prepared and
1173 * checked in parallel to the asynchronous completion of the previous
1174 * update. Which is important since compositors need to figure out the
1175 * composition of the next frame right after having submitted the
1179 drm_atomic_helper_wait_for_fences(dev, state);
1181 drm_atomic_helper_commit_modeset_disables(dev, state);
1183 drm_atomic_helper_commit_planes(dev, state, false);
1185 drm_atomic_helper_commit_modeset_enables(dev, state);
1187 drm_atomic_helper_wait_for_vblanks(dev, state);
1189 drm_atomic_helper_cleanup_planes(dev, state);
1191 drm_atomic_state_free(state);
1195 EXPORT_SYMBOL(drm_atomic_helper_commit);
1198 * DOC: implementing nonblocking commit
1200 * For now the atomic helpers don't support nonblocking commit directly. If
1201 * there is real need it could be added though, using the dma-buf fence
1202 * infrastructure for generic synchronization with outstanding rendering.
1204 * For now drivers have to implement nonblocking commit themselves, with the
1205 * following sequence being the recommended one:
1207 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1208 * which commit needs to call which can fail, so we want to run it first and
1211 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1212 * might be affected the new state update. This can be done by either cancelling
1213 * or flushing the work items, depending upon whether the driver can deal with
1214 * cancelled updates. Note that it is important to ensure that the framebuffer
1215 * cleanup is still done when cancelling.
1217 * For sufficient parallelism it is recommended to have a work item per crtc
1218 * (for updates which don't touch global state) and a global one. Then we only
1219 * need to synchronize with the crtc work items for changed crtcs and the global
1220 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1222 * 3. The software state is updated synchronously with
1223 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1224 * locks means concurrent callers never see inconsistent state. And doing this
1225 * while it's guaranteed that no relevant nonblocking worker runs means that
1226 * nonblocking workers do not need grab any locks. Actually they must not grab
1227 * locks, for otherwise the work flushing will deadlock.
1229 * 4. Schedule a work item to do all subsequent steps, using the split-out
1230 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1231 * then cleaning up the framebuffers after the old framebuffer is no longer
1236 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1238 * @state: atomic state object with new state structures
1240 * This function prepares plane state, specifically framebuffers, for the new
1241 * configuration. If any failure is encountered this function will call
1242 * ->cleanup_fb on any already successfully prepared framebuffer.
1245 * 0 on success, negative error code on failure.
1247 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1248 struct drm_atomic_state *state)
1250 int nplanes = dev->mode_config.num_total_plane;
1253 for (i = 0; i < nplanes; i++) {
1254 const struct drm_plane_helper_funcs *funcs;
1255 struct drm_plane *plane = state->planes[i];
1256 struct drm_plane_state *plane_state = state->plane_states[i];
1261 funcs = plane->helper_private;
1263 if (funcs->prepare_fb) {
1264 ret = funcs->prepare_fb(plane, plane_state);
1273 for (i--; i >= 0; i--) {
1274 const struct drm_plane_helper_funcs *funcs;
1275 struct drm_plane *plane = state->planes[i];
1276 struct drm_plane_state *plane_state = state->plane_states[i];
1281 funcs = plane->helper_private;
1283 if (funcs->cleanup_fb)
1284 funcs->cleanup_fb(plane, plane_state);
1290 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1292 bool plane_crtc_active(struct drm_plane_state *state)
1294 return state->crtc && state->crtc->state->active;
1298 * drm_atomic_helper_commit_planes - commit plane state
1300 * @old_state: atomic state object with old state structures
1301 * @active_only: Only commit on active CRTC if set
1303 * This function commits the new plane state using the plane and atomic helper
1304 * functions for planes and crtcs. It assumes that the atomic state has already
1305 * been pushed into the relevant object state pointers, since this step can no
1308 * It still requires the global state object @old_state to know which planes and
1309 * crtcs need to be updated though.
1311 * Note that this function does all plane updates across all CRTCs in one step.
1312 * If the hardware can't support this approach look at
1313 * drm_atomic_helper_commit_planes_on_crtc() instead.
1315 * Plane parameters can be updated by applications while the associated CRTC is
1316 * disabled. The DRM/KMS core will store the parameters in the plane state,
1317 * which will be available to the driver when the CRTC is turned on. As a result
1318 * most drivers don't need to be immediately notified of plane updates for a
1321 * Unless otherwise needed, drivers are advised to set the @active_only
1322 * parameters to true in order not to receive plane update notifications related
1323 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1324 * driver code when the driver and/or hardware can't or just don't need to deal
1325 * with updates on disabled CRTCs, for example when supporting runtime PM.
1327 * The drm_atomic_helper_commit() default implementation only sets @active_only
1328 * to false to most closely match the behaviour of the legacy helpers. This should
1329 * not be copied blindly by drivers.
1331 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1332 struct drm_atomic_state *old_state,
1335 struct drm_crtc *crtc;
1336 struct drm_crtc_state *old_crtc_state;
1337 struct drm_plane *plane;
1338 struct drm_plane_state *old_plane_state;
1341 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1342 const struct drm_crtc_helper_funcs *funcs;
1344 funcs = crtc->helper_private;
1346 if (!funcs || !funcs->atomic_begin)
1349 if (active_only && !crtc->state->active)
1352 funcs->atomic_begin(crtc, old_crtc_state);
1355 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1356 const struct drm_plane_helper_funcs *funcs;
1359 funcs = plane->helper_private;
1364 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1368 * Skip planes related to inactive CRTCs. If the plane
1369 * is enabled use the state of the current CRTC. If the
1370 * plane is being disabled use the state of the old
1371 * CRTC to avoid skipping planes being disabled on an
1374 if (!disabling && !plane_crtc_active(plane->state))
1376 if (disabling && !plane_crtc_active(old_plane_state))
1381 * Special-case disabling the plane if drivers support it.
1383 if (disabling && funcs->atomic_disable)
1384 funcs->atomic_disable(plane, old_plane_state);
1385 else if (plane->state->crtc || disabling)
1386 funcs->atomic_update(plane, old_plane_state);
1389 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1390 const struct drm_crtc_helper_funcs *funcs;
1392 funcs = crtc->helper_private;
1394 if (!funcs || !funcs->atomic_flush)
1397 if (active_only && !crtc->state->active)
1400 funcs->atomic_flush(crtc, old_crtc_state);
1403 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1406 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1407 * @old_crtc_state: atomic state object with the old crtc state
1409 * This function commits the new plane state using the plane and atomic helper
1410 * functions for planes on the specific crtc. It assumes that the atomic state
1411 * has already been pushed into the relevant object state pointers, since this
1412 * step can no longer fail.
1414 * This function is useful when plane updates should be done crtc-by-crtc
1415 * instead of one global step like drm_atomic_helper_commit_planes() does.
1417 * This function can only be savely used when planes are not allowed to move
1418 * between different CRTCs because this function doesn't handle inter-CRTC
1419 * depencies. Callers need to ensure that either no such depencies exist,
1420 * resolve them through ordering of commit calls or through some other means.
1423 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1425 const struct drm_crtc_helper_funcs *crtc_funcs;
1426 struct drm_crtc *crtc = old_crtc_state->crtc;
1427 struct drm_atomic_state *old_state = old_crtc_state->state;
1428 struct drm_plane *plane;
1429 unsigned plane_mask;
1431 plane_mask = old_crtc_state->plane_mask;
1432 plane_mask |= crtc->state->plane_mask;
1434 crtc_funcs = crtc->helper_private;
1435 if (crtc_funcs && crtc_funcs->atomic_begin)
1436 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1438 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1439 struct drm_plane_state *old_plane_state =
1440 drm_atomic_get_existing_plane_state(old_state, plane);
1441 const struct drm_plane_helper_funcs *plane_funcs;
1443 plane_funcs = plane->helper_private;
1445 if (!old_plane_state || !plane_funcs)
1448 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1450 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1451 plane_funcs->atomic_disable)
1452 plane_funcs->atomic_disable(plane, old_plane_state);
1453 else if (plane->state->crtc ||
1454 drm_atomic_plane_disabling(plane, old_plane_state))
1455 plane_funcs->atomic_update(plane, old_plane_state);
1458 if (crtc_funcs && crtc_funcs->atomic_flush)
1459 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1461 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1464 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1466 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1468 * Disables all planes associated with the given CRTC. This can be
1469 * used for instance in the CRTC helper disable callback to disable
1470 * all planes before shutting down the display pipeline.
1472 * If the atomic-parameter is set the function calls the CRTC's
1473 * atomic_begin hook before and atomic_flush hook after disabling the
1476 * It is a bug to call this function without having implemented the
1477 * ->atomic_disable() plane hook.
1479 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1482 const struct drm_crtc_helper_funcs *crtc_funcs =
1483 crtc->helper_private;
1484 struct drm_plane *plane;
1486 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1487 crtc_funcs->atomic_begin(crtc, NULL);
1489 drm_for_each_plane(plane, crtc->dev) {
1490 const struct drm_plane_helper_funcs *plane_funcs =
1491 plane->helper_private;
1493 if (plane->state->crtc != crtc || !plane_funcs)
1496 WARN_ON(!plane_funcs->atomic_disable);
1497 if (plane_funcs->atomic_disable)
1498 plane_funcs->atomic_disable(plane, NULL);
1501 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1502 crtc_funcs->atomic_flush(crtc, NULL);
1504 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1507 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1509 * @old_state: atomic state object with old state structures
1511 * This function cleans up plane state, specifically framebuffers, from the old
1512 * configuration. Hence the old configuration must be perserved in @old_state to
1513 * be able to call this function.
1515 * This function must also be called on the new state when the atomic update
1516 * fails at any point after calling drm_atomic_helper_prepare_planes().
1518 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1519 struct drm_atomic_state *old_state)
1521 struct drm_plane *plane;
1522 struct drm_plane_state *plane_state;
1525 for_each_plane_in_state(old_state, plane, plane_state, i) {
1526 const struct drm_plane_helper_funcs *funcs;
1528 funcs = plane->helper_private;
1530 if (funcs->cleanup_fb)
1531 funcs->cleanup_fb(plane, plane_state);
1534 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1537 * drm_atomic_helper_swap_state - store atomic state into current sw state
1539 * @state: atomic state
1541 * This function stores the atomic state into the current state pointers in all
1542 * driver objects. It should be called after all failing steps have been done
1543 * and succeeded, but before the actual hardware state is committed.
1545 * For cleanup and error recovery the current state for all changed objects will
1546 * be swaped into @state.
1548 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1550 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1552 * 2. Do any other steps that might fail.
1554 * 3. Put the staged state into the current state pointers with this function.
1556 * 4. Actually commit the hardware state.
1558 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1559 * contains the old state. Also do any other cleanup required with that state.
1561 void drm_atomic_helper_swap_state(struct drm_device *dev,
1562 struct drm_atomic_state *state)
1566 for (i = 0; i < state->num_connector; i++) {
1567 struct drm_connector *connector = state->connectors[i];
1572 connector->state->state = state;
1573 swap(state->connector_states[i], connector->state);
1574 connector->state->state = NULL;
1577 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1578 struct drm_crtc *crtc = state->crtcs[i];
1583 crtc->state->state = state;
1584 swap(state->crtc_states[i], crtc->state);
1585 crtc->state->state = NULL;
1588 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1589 struct drm_plane *plane = state->planes[i];
1594 plane->state->state = state;
1595 swap(state->plane_states[i], plane->state);
1596 plane->state->state = NULL;
1599 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1602 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1603 * @plane: plane object to update
1604 * @crtc: owning CRTC of owning plane
1605 * @fb: framebuffer to flip onto plane
1606 * @crtc_x: x offset of primary plane on crtc
1607 * @crtc_y: y offset of primary plane on crtc
1608 * @crtc_w: width of primary plane rectangle on crtc
1609 * @crtc_h: height of primary plane rectangle on crtc
1610 * @src_x: x offset of @fb for panning
1611 * @src_y: y offset of @fb for panning
1612 * @src_w: width of source rectangle in @fb
1613 * @src_h: height of source rectangle in @fb
1615 * Provides a default plane update handler using the atomic driver interface.
1618 * Zero on success, error code on failure
1620 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1621 struct drm_crtc *crtc,
1622 struct drm_framebuffer *fb,
1623 int crtc_x, int crtc_y,
1624 unsigned int crtc_w, unsigned int crtc_h,
1625 uint32_t src_x, uint32_t src_y,
1626 uint32_t src_w, uint32_t src_h)
1628 struct drm_atomic_state *state;
1629 struct drm_plane_state *plane_state;
1632 state = drm_atomic_state_alloc(plane->dev);
1636 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1638 plane_state = drm_atomic_get_plane_state(state, plane);
1639 if (IS_ERR(plane_state)) {
1640 ret = PTR_ERR(plane_state);
1644 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1647 drm_atomic_set_fb_for_plane(plane_state, fb);
1648 plane_state->crtc_x = crtc_x;
1649 plane_state->crtc_y = crtc_y;
1650 plane_state->crtc_w = crtc_w;
1651 plane_state->crtc_h = crtc_h;
1652 plane_state->src_x = src_x;
1653 plane_state->src_y = src_y;
1654 plane_state->src_w = src_w;
1655 plane_state->src_h = src_h;
1657 if (plane == crtc->cursor)
1658 state->legacy_cursor_update = true;
1660 ret = drm_atomic_commit(state);
1664 /* Driver takes ownership of state on successful commit. */
1667 if (ret == -EDEADLK)
1670 drm_atomic_state_free(state);
1674 drm_atomic_state_clear(state);
1675 drm_atomic_legacy_backoff(state);
1678 * Someone might have exchanged the framebuffer while we dropped locks
1679 * in the backoff code. We need to fix up the fb refcount tracking the
1682 plane->old_fb = plane->fb;
1686 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1689 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1690 * @plane: plane to disable
1692 * Provides a default plane disable handler using the atomic driver interface.
1695 * Zero on success, error code on failure
1697 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1699 struct drm_atomic_state *state;
1700 struct drm_plane_state *plane_state;
1704 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1705 * acquire context. The real fix will be to wire the acquire ctx through
1706 * everywhere we need it, but meanwhile prevent chaos by just skipping
1707 * this noop. The critical case is the cursor ioctls which a) only grab
1708 * crtc/cursor-plane locks (so we need the crtc to get at the right
1709 * acquire context) and b) can try to disable the plane multiple times.
1714 state = drm_atomic_state_alloc(plane->dev);
1718 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1720 plane_state = drm_atomic_get_plane_state(state, plane);
1721 if (IS_ERR(plane_state)) {
1722 ret = PTR_ERR(plane_state);
1726 if (plane_state->crtc && (plane == plane->crtc->cursor))
1727 plane_state->state->legacy_cursor_update = true;
1729 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1733 ret = drm_atomic_commit(state);
1737 /* Driver takes ownership of state on successful commit. */
1740 if (ret == -EDEADLK)
1743 drm_atomic_state_free(state);
1747 drm_atomic_state_clear(state);
1748 drm_atomic_legacy_backoff(state);
1751 * Someone might have exchanged the framebuffer while we dropped locks
1752 * in the backoff code. We need to fix up the fb refcount tracking the
1755 plane->old_fb = plane->fb;
1759 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1761 /* just used from fb-helper and atomic-helper: */
1762 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1763 struct drm_plane_state *plane_state)
1767 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1771 drm_atomic_set_fb_for_plane(plane_state, NULL);
1772 plane_state->crtc_x = 0;
1773 plane_state->crtc_y = 0;
1774 plane_state->crtc_w = 0;
1775 plane_state->crtc_h = 0;
1776 plane_state->src_x = 0;
1777 plane_state->src_y = 0;
1778 plane_state->src_w = 0;
1779 plane_state->src_h = 0;
1784 static int update_output_state(struct drm_atomic_state *state,
1785 struct drm_mode_set *set)
1787 struct drm_device *dev = set->crtc->dev;
1788 struct drm_crtc *crtc;
1789 struct drm_crtc_state *crtc_state;
1790 struct drm_connector *connector;
1791 struct drm_connector_state *conn_state;
1794 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1795 state->acquire_ctx);
1799 /* First disable all connectors on the target crtc. */
1800 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1804 for_each_connector_in_state(state, connector, conn_state, i) {
1805 if (conn_state->crtc == set->crtc) {
1806 ret = drm_atomic_set_crtc_for_connector(conn_state,
1813 /* Then set all connectors from set->connectors on the target crtc */
1814 for (i = 0; i < set->num_connectors; i++) {
1815 conn_state = drm_atomic_get_connector_state(state,
1816 set->connectors[i]);
1817 if (IS_ERR(conn_state))
1818 return PTR_ERR(conn_state);
1820 ret = drm_atomic_set_crtc_for_connector(conn_state,
1826 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1827 /* Don't update ->enable for the CRTC in the set_config request,
1828 * since a mismatch would indicate a bug in the upper layers.
1829 * The actual modeset code later on will catch any
1830 * inconsistencies here. */
1831 if (crtc == set->crtc)
1834 if (!crtc_state->connector_mask) {
1835 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1840 crtc_state->active = false;
1848 * drm_atomic_helper_set_config - set a new config from userspace
1849 * @set: mode set configuration
1851 * Provides a default crtc set_config handler using the atomic driver interface.
1854 * Returns 0 on success, negative errno numbers on failure.
1856 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1858 struct drm_atomic_state *state;
1859 struct drm_crtc *crtc = set->crtc;
1862 state = drm_atomic_state_alloc(crtc->dev);
1866 state->legacy_set_config = true;
1867 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1869 ret = __drm_atomic_helper_set_config(set, state);
1873 ret = drm_atomic_commit(state);
1877 /* Driver takes ownership of state on successful commit. */
1880 if (ret == -EDEADLK)
1883 drm_atomic_state_free(state);
1887 drm_atomic_state_clear(state);
1888 drm_atomic_legacy_backoff(state);
1891 * Someone might have exchanged the framebuffer while we dropped locks
1892 * in the backoff code. We need to fix up the fb refcount tracking the
1895 crtc->primary->old_fb = crtc->primary->fb;
1899 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1901 /* just used from fb-helper and atomic-helper: */
1902 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1903 struct drm_atomic_state *state)
1905 struct drm_crtc_state *crtc_state;
1906 struct drm_plane_state *primary_state;
1907 struct drm_crtc *crtc = set->crtc;
1908 int hdisplay, vdisplay;
1911 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1912 if (IS_ERR(crtc_state))
1913 return PTR_ERR(crtc_state);
1915 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1916 if (IS_ERR(primary_state))
1917 return PTR_ERR(primary_state);
1921 WARN_ON(set->num_connectors);
1923 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1927 crtc_state->active = false;
1929 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1933 drm_atomic_set_fb_for_plane(primary_state, NULL);
1939 WARN_ON(!set->num_connectors);
1941 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1945 crtc_state->active = true;
1947 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1951 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1953 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1954 primary_state->crtc_x = 0;
1955 primary_state->crtc_y = 0;
1956 primary_state->crtc_w = hdisplay;
1957 primary_state->crtc_h = vdisplay;
1958 primary_state->src_x = set->x << 16;
1959 primary_state->src_y = set->y << 16;
1960 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1961 primary_state->src_w = vdisplay << 16;
1962 primary_state->src_h = hdisplay << 16;
1964 primary_state->src_w = hdisplay << 16;
1965 primary_state->src_h = vdisplay << 16;
1969 ret = update_output_state(state, set);
1977 * drm_atomic_helper_disable_all - disable all currently active outputs
1979 * @ctx: lock acquisition context
1981 * Loops through all connectors, finding those that aren't turned off and then
1982 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1983 * that they are connected to.
1985 * This is used for example in suspend/resume to disable all currently active
1986 * functions when suspending.
1988 * Note that if callers haven't already acquired all modeset locks this might
1989 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1992 * 0 on success or a negative error code on failure.
1995 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1997 int drm_atomic_helper_disable_all(struct drm_device *dev,
1998 struct drm_modeset_acquire_ctx *ctx)
2000 struct drm_atomic_state *state;
2001 struct drm_connector *conn;
2004 state = drm_atomic_state_alloc(dev);
2008 state->acquire_ctx = ctx;
2010 drm_for_each_connector(conn, dev) {
2011 struct drm_crtc *crtc = conn->state->crtc;
2012 struct drm_crtc_state *crtc_state;
2014 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2017 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2018 if (IS_ERR(crtc_state)) {
2019 err = PTR_ERR(crtc_state);
2023 crtc_state->active = false;
2026 err = drm_atomic_commit(state);
2030 drm_atomic_state_free(state);
2034 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2037 * drm_atomic_helper_suspend - subsystem-level suspend helper
2040 * Duplicates the current atomic state, disables all active outputs and then
2041 * returns a pointer to the original atomic state to the caller. Drivers can
2042 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2043 * restore the output configuration that was active at the time the system
2046 * Note that it is potentially unsafe to use this. The atomic state object
2047 * returned by this function is assumed to be persistent. Drivers must ensure
2048 * that this holds true. Before calling this function, drivers must make sure
2049 * to suspend fbdev emulation so that nothing can be using the device.
2052 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2053 * encoded error code on failure. Drivers should store the returned atomic
2054 * state object and pass it to the drm_atomic_helper_resume() helper upon
2058 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2059 * drm_atomic_helper_resume()
2061 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2063 struct drm_modeset_acquire_ctx ctx;
2064 struct drm_atomic_state *state;
2067 drm_modeset_acquire_init(&ctx, 0);
2070 err = drm_modeset_lock_all_ctx(dev, &ctx);
2072 state = ERR_PTR(err);
2076 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2080 err = drm_atomic_helper_disable_all(dev, &ctx);
2082 drm_atomic_state_free(state);
2083 state = ERR_PTR(err);
2088 if (PTR_ERR(state) == -EDEADLK) {
2089 drm_modeset_backoff(&ctx);
2093 drm_modeset_drop_locks(&ctx);
2094 drm_modeset_acquire_fini(&ctx);
2097 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2100 * drm_atomic_helper_resume - subsystem-level resume helper
2102 * @state: atomic state to resume to
2104 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2105 * grabs all modeset locks and commits the atomic state object. This can be
2106 * used in conjunction with the drm_atomic_helper_suspend() helper to
2107 * implement suspend/resume for drivers that support atomic mode-setting.
2110 * 0 on success or a negative error code on failure.
2113 * drm_atomic_helper_suspend()
2115 int drm_atomic_helper_resume(struct drm_device *dev,
2116 struct drm_atomic_state *state)
2118 struct drm_mode_config *config = &dev->mode_config;
2121 drm_mode_config_reset(dev);
2122 drm_modeset_lock_all(dev);
2123 state->acquire_ctx = config->acquire_ctx;
2124 err = drm_atomic_commit(state);
2125 drm_modeset_unlock_all(dev);
2129 EXPORT_SYMBOL(drm_atomic_helper_resume);
2132 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2134 * @property: DRM property
2135 * @val: value of property
2137 * Provides a default crtc set_property handler using the atomic driver
2141 * Zero on success, error code on failure
2144 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2145 struct drm_property *property,
2148 struct drm_atomic_state *state;
2149 struct drm_crtc_state *crtc_state;
2152 state = drm_atomic_state_alloc(crtc->dev);
2156 /* ->set_property is always called with all locks held. */
2157 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2159 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2160 if (IS_ERR(crtc_state)) {
2161 ret = PTR_ERR(crtc_state);
2165 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2170 ret = drm_atomic_commit(state);
2174 /* Driver takes ownership of state on successful commit. */
2177 if (ret == -EDEADLK)
2180 drm_atomic_state_free(state);
2184 drm_atomic_state_clear(state);
2185 drm_atomic_legacy_backoff(state);
2189 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2192 * drm_atomic_helper_plane_set_property - helper for plane properties
2194 * @property: DRM property
2195 * @val: value of property
2197 * Provides a default plane set_property handler using the atomic driver
2201 * Zero on success, error code on failure
2204 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2205 struct drm_property *property,
2208 struct drm_atomic_state *state;
2209 struct drm_plane_state *plane_state;
2212 state = drm_atomic_state_alloc(plane->dev);
2216 /* ->set_property is always called with all locks held. */
2217 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2219 plane_state = drm_atomic_get_plane_state(state, plane);
2220 if (IS_ERR(plane_state)) {
2221 ret = PTR_ERR(plane_state);
2225 ret = drm_atomic_plane_set_property(plane, plane_state,
2230 ret = drm_atomic_commit(state);
2234 /* Driver takes ownership of state on successful commit. */
2237 if (ret == -EDEADLK)
2240 drm_atomic_state_free(state);
2244 drm_atomic_state_clear(state);
2245 drm_atomic_legacy_backoff(state);
2249 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2252 * drm_atomic_helper_connector_set_property - helper for connector properties
2253 * @connector: DRM connector
2254 * @property: DRM property
2255 * @val: value of property
2257 * Provides a default connector set_property handler using the atomic driver
2261 * Zero on success, error code on failure
2264 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2265 struct drm_property *property,
2268 struct drm_atomic_state *state;
2269 struct drm_connector_state *connector_state;
2272 state = drm_atomic_state_alloc(connector->dev);
2276 /* ->set_property is always called with all locks held. */
2277 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2279 connector_state = drm_atomic_get_connector_state(state, connector);
2280 if (IS_ERR(connector_state)) {
2281 ret = PTR_ERR(connector_state);
2285 ret = drm_atomic_connector_set_property(connector, connector_state,
2290 ret = drm_atomic_commit(state);
2294 /* Driver takes ownership of state on successful commit. */
2297 if (ret == -EDEADLK)
2300 drm_atomic_state_free(state);
2304 drm_atomic_state_clear(state);
2305 drm_atomic_legacy_backoff(state);
2309 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2312 * drm_atomic_helper_page_flip - execute a legacy page flip
2314 * @fb: DRM framebuffer
2315 * @event: optional DRM event to signal upon completion
2316 * @flags: flip flags for non-vblank sync'ed updates
2318 * Provides a default page flip implementation using the atomic driver interface.
2320 * Note that for now so called async page flips (i.e. updates which are not
2321 * synchronized to vblank) are not supported, since the atomic interfaces have
2322 * no provisions for this yet.
2325 * Returns 0 on success, negative errno numbers on failure.
2327 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2328 struct drm_framebuffer *fb,
2329 struct drm_pending_vblank_event *event,
2332 struct drm_plane *plane = crtc->primary;
2333 struct drm_atomic_state *state;
2334 struct drm_plane_state *plane_state;
2335 struct drm_crtc_state *crtc_state;
2338 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2341 state = drm_atomic_state_alloc(plane->dev);
2345 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2347 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2348 if (IS_ERR(crtc_state)) {
2349 ret = PTR_ERR(crtc_state);
2352 crtc_state->event = event;
2354 plane_state = drm_atomic_get_plane_state(state, plane);
2355 if (IS_ERR(plane_state)) {
2356 ret = PTR_ERR(plane_state);
2360 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2363 drm_atomic_set_fb_for_plane(plane_state, fb);
2365 /* Make sure we don't accidentally do a full modeset. */
2366 state->allow_modeset = false;
2367 if (!crtc_state->active) {
2368 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2374 ret = drm_atomic_nonblocking_commit(state);
2378 /* Driver takes ownership of state on successful commit. */
2381 if (ret == -EDEADLK)
2384 drm_atomic_state_free(state);
2388 drm_atomic_state_clear(state);
2389 drm_atomic_legacy_backoff(state);
2392 * Someone might have exchanged the framebuffer while we dropped locks
2393 * in the backoff code. We need to fix up the fb refcount tracking the
2396 plane->old_fb = plane->fb;
2400 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2403 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2404 * @connector: affected connector
2407 * This is the main helper function provided by the atomic helper framework for
2408 * implementing the legacy DPMS connector interface. It computes the new desired
2409 * ->active state for the corresponding CRTC (if the connector is enabled) and
2413 * Returns 0 on success, negative errno numbers on failure.
2415 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2418 struct drm_mode_config *config = &connector->dev->mode_config;
2419 struct drm_atomic_state *state;
2420 struct drm_crtc_state *crtc_state;
2421 struct drm_crtc *crtc;
2422 struct drm_connector *tmp_connector;
2424 bool active = false;
2425 int old_mode = connector->dpms;
2427 if (mode != DRM_MODE_DPMS_ON)
2428 mode = DRM_MODE_DPMS_OFF;
2430 connector->dpms = mode;
2431 crtc = connector->state->crtc;
2436 state = drm_atomic_state_alloc(connector->dev);
2440 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2442 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2443 if (IS_ERR(crtc_state)) {
2444 ret = PTR_ERR(crtc_state);
2448 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2450 drm_for_each_connector(tmp_connector, connector->dev) {
2451 if (tmp_connector->state->crtc != crtc)
2454 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2459 crtc_state->active = active;
2461 ret = drm_atomic_commit(state);
2465 /* Driver takes ownership of state on successful commit. */
2468 if (ret == -EDEADLK)
2471 connector->dpms = old_mode;
2472 drm_atomic_state_free(state);
2476 drm_atomic_state_clear(state);
2477 drm_atomic_legacy_backoff(state);
2481 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2484 * DOC: atomic state reset and initialization
2486 * Both the drm core and the atomic helpers assume that there is always the full
2487 * and correct atomic software state for all connectors, CRTCs and planes
2488 * available. Which is a bit a problem on driver load and also after system
2489 * suspend. One way to solve this is to have a hardware state read-out
2490 * infrastructure which reconstructs the full software state (e.g. the i915
2493 * The simpler solution is to just reset the software state to everything off,
2494 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2495 * the atomic helpers provide default reset implementations for all hooks.
2497 * On the upside the precise state tracking of atomic simplifies system suspend
2498 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2499 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2500 * For other drivers the building blocks are split out, see the documentation
2501 * for these functions.
2505 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2508 * Resets the atomic state for @crtc by freeing the state pointer (which might
2509 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2511 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2514 __drm_atomic_helper_crtc_destroy_state(crtc, crtc->state);
2517 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2520 crtc->state->crtc = crtc;
2522 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2525 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2526 * @crtc: CRTC object
2527 * @state: atomic CRTC state
2529 * Copies atomic state from a CRTC's current state and resets inferred values.
2530 * This is useful for drivers that subclass the CRTC state.
2532 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2533 struct drm_crtc_state *state)
2535 memcpy(state, crtc->state, sizeof(*state));
2537 if (state->mode_blob)
2538 drm_property_reference_blob(state->mode_blob);
2539 if (state->degamma_lut)
2540 drm_property_reference_blob(state->degamma_lut);
2542 drm_property_reference_blob(state->ctm);
2543 if (state->gamma_lut)
2544 drm_property_reference_blob(state->gamma_lut);
2545 state->mode_changed = false;
2546 state->active_changed = false;
2547 state->planes_changed = false;
2548 state->connectors_changed = false;
2549 state->color_mgmt_changed = false;
2550 state->event = NULL;
2552 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2555 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2558 * Default CRTC state duplicate hook for drivers which don't have their own
2559 * subclassed CRTC state structure.
2561 struct drm_crtc_state *
2562 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2564 struct drm_crtc_state *state;
2566 if (WARN_ON(!crtc->state))
2569 state = kmalloc(sizeof(*state), GFP_KERNEL);
2571 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2575 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2578 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2579 * @crtc: CRTC object
2580 * @state: CRTC state object to release
2582 * Releases all resources stored in the CRTC state without actually freeing
2583 * the memory of the CRTC state. This is useful for drivers that subclass the
2586 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2587 struct drm_crtc_state *state)
2589 drm_property_unreference_blob(state->mode_blob);
2590 drm_property_unreference_blob(state->degamma_lut);
2591 drm_property_unreference_blob(state->ctm);
2592 drm_property_unreference_blob(state->gamma_lut);
2594 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2597 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2599 * @state: CRTC state object to release
2601 * Default CRTC state destroy hook for drivers which don't have their own
2602 * subclassed CRTC state structure.
2604 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2605 struct drm_crtc_state *state)
2607 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2610 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2613 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2616 * Resets the atomic state for @plane by freeing the state pointer (which might
2617 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2619 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2622 __drm_atomic_helper_plane_destroy_state(plane, plane->state);
2624 kfree(plane->state);
2625 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2628 plane->state->plane = plane;
2629 plane->state->rotation = BIT(DRM_ROTATE_0);
2632 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2635 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2636 * @plane: plane object
2637 * @state: atomic plane state
2639 * Copies atomic state from a plane's current state. This is useful for
2640 * drivers that subclass the plane state.
2642 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2643 struct drm_plane_state *state)
2645 memcpy(state, plane->state, sizeof(*state));
2648 drm_framebuffer_reference(state->fb);
2650 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2653 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2656 * Default plane state duplicate hook for drivers which don't have their own
2657 * subclassed plane state structure.
2659 struct drm_plane_state *
2660 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2662 struct drm_plane_state *state;
2664 if (WARN_ON(!plane->state))
2667 state = kmalloc(sizeof(*state), GFP_KERNEL);
2669 __drm_atomic_helper_plane_duplicate_state(plane, state);
2673 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2676 * __drm_atomic_helper_plane_destroy_state - release plane state
2677 * @plane: plane object
2678 * @state: plane state object to release
2680 * Releases all resources stored in the plane state without actually freeing
2681 * the memory of the plane state. This is useful for drivers that subclass the
2684 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2685 struct drm_plane_state *state)
2688 drm_framebuffer_unreference(state->fb);
2690 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2693 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2695 * @state: plane state object to release
2697 * Default plane state destroy hook for drivers which don't have their own
2698 * subclassed plane state structure.
2700 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2701 struct drm_plane_state *state)
2703 __drm_atomic_helper_plane_destroy_state(plane, state);
2706 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2709 * __drm_atomic_helper_connector_reset - reset state on connector
2710 * @connector: drm connector
2711 * @conn_state: connector state to assign
2713 * Initializes the newly allocated @conn_state and assigns it to
2714 * #connector ->state, usually required when initializing the drivers
2715 * or when called from the ->reset hook.
2717 * This is useful for drivers that subclass the connector state.
2720 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2721 struct drm_connector_state *conn_state)
2724 conn_state->connector = connector;
2726 connector->state = conn_state;
2728 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2731 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2732 * @connector: drm connector
2734 * Resets the atomic state for @connector by freeing the state pointer (which
2735 * might be NULL, e.g. at driver load time) and allocating a new empty state
2738 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2740 struct drm_connector_state *conn_state =
2741 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2743 if (connector->state)
2744 __drm_atomic_helper_connector_destroy_state(connector,
2747 kfree(connector->state);
2748 __drm_atomic_helper_connector_reset(connector, conn_state);
2750 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2753 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2754 * @connector: connector object
2755 * @state: atomic connector state
2757 * Copies atomic state from a connector's current state. This is useful for
2758 * drivers that subclass the connector state.
2761 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2762 struct drm_connector_state *state)
2764 memcpy(state, connector->state, sizeof(*state));
2766 drm_connector_reference(connector);
2768 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2771 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2772 * @connector: drm connector
2774 * Default connector state duplicate hook for drivers which don't have their own
2775 * subclassed connector state structure.
2777 struct drm_connector_state *
2778 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2780 struct drm_connector_state *state;
2782 if (WARN_ON(!connector->state))
2785 state = kmalloc(sizeof(*state), GFP_KERNEL);
2787 __drm_atomic_helper_connector_duplicate_state(connector, state);
2791 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2794 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2796 * @ctx: lock acquisition context
2798 * Makes a copy of the current atomic state by looping over all objects and
2799 * duplicating their respective states. This is used for example by suspend/
2800 * resume support code to save the state prior to suspend such that it can
2801 * be restored upon resume.
2803 * Note that this treats atomic state as persistent between save and restore.
2804 * Drivers must make sure that this is possible and won't result in confusion
2805 * or erroneous behaviour.
2807 * Note that if callers haven't already acquired all modeset locks this might
2808 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2811 * A pointer to the copy of the atomic state object on success or an
2812 * ERR_PTR()-encoded error code on failure.
2815 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2817 struct drm_atomic_state *
2818 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2819 struct drm_modeset_acquire_ctx *ctx)
2821 struct drm_atomic_state *state;
2822 struct drm_connector *conn;
2823 struct drm_plane *plane;
2824 struct drm_crtc *crtc;
2827 state = drm_atomic_state_alloc(dev);
2829 return ERR_PTR(-ENOMEM);
2831 state->acquire_ctx = ctx;
2833 drm_for_each_crtc(crtc, dev) {
2834 struct drm_crtc_state *crtc_state;
2836 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2837 if (IS_ERR(crtc_state)) {
2838 err = PTR_ERR(crtc_state);
2843 drm_for_each_plane(plane, dev) {
2844 struct drm_plane_state *plane_state;
2846 plane_state = drm_atomic_get_plane_state(state, plane);
2847 if (IS_ERR(plane_state)) {
2848 err = PTR_ERR(plane_state);
2853 drm_for_each_connector(conn, dev) {
2854 struct drm_connector_state *conn_state;
2856 conn_state = drm_atomic_get_connector_state(state, conn);
2857 if (IS_ERR(conn_state)) {
2858 err = PTR_ERR(conn_state);
2863 /* clear the acquire context so that it isn't accidentally reused */
2864 state->acquire_ctx = NULL;
2868 drm_atomic_state_free(state);
2869 state = ERR_PTR(err);
2874 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2877 * __drm_atomic_helper_connector_destroy_state - release connector state
2878 * @connector: connector object
2879 * @state: connector state object to release
2881 * Releases all resources stored in the connector state without actually
2882 * freeing the memory of the connector state. This is useful for drivers that
2883 * subclass the connector state.
2886 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2887 struct drm_connector_state *state)
2890 * This is currently a placeholder so that drivers that subclass the
2891 * state will automatically do the right thing if code is ever added
2895 drm_connector_unreference(state->connector);
2897 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2900 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2901 * @connector: drm connector
2902 * @state: connector state object to release
2904 * Default connector state destroy hook for drivers which don't have their own
2905 * subclassed connector state structure.
2907 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2908 struct drm_connector_state *state)
2910 __drm_atomic_helper_connector_destroy_state(connector, state);
2913 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2916 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2917 * @crtc: CRTC object
2918 * @red: red correction table
2919 * @green: green correction table
2920 * @blue: green correction table
2922 * @size: size of the tables
2924 * Implements support for legacy gamma correction table for drivers
2925 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2928 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2929 u16 *red, u16 *green, u16 *blue,
2930 uint32_t start, uint32_t size)
2932 struct drm_device *dev = crtc->dev;
2933 struct drm_mode_config *config = &dev->mode_config;
2934 struct drm_atomic_state *state;
2935 struct drm_crtc_state *crtc_state;
2936 struct drm_property_blob *blob = NULL;
2937 struct drm_color_lut *blob_data;
2940 state = drm_atomic_state_alloc(crtc->dev);
2944 blob = drm_property_create_blob(dev,
2945 sizeof(struct drm_color_lut) * size,
2948 ret = PTR_ERR(blob);
2953 /* Prepare GAMMA_LUT with the legacy values. */
2954 blob_data = (struct drm_color_lut *) blob->data;
2955 for (i = 0; i < size; i++) {
2956 blob_data[i].red = red[i];
2957 blob_data[i].green = green[i];
2958 blob_data[i].blue = blue[i];
2961 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2963 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2964 if (IS_ERR(crtc_state)) {
2965 ret = PTR_ERR(crtc_state);
2969 /* Reset DEGAMMA_LUT and CTM properties. */
2970 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2971 config->degamma_lut_property, 0);
2975 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2976 config->ctm_property, 0);
2980 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2981 config->gamma_lut_property, blob->base.id);
2985 ret = drm_atomic_commit(state);
2989 /* Driver takes ownership of state on successful commit. */
2991 drm_property_unreference_blob(blob);
2995 if (ret == -EDEADLK)
2998 drm_atomic_state_free(state);
2999 drm_property_unreference_blob(blob);
3003 drm_atomic_state_clear(state);
3004 drm_atomic_legacy_backoff(state);
3008 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);