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/dma-fence.h>
35 #include "drm_crtc_internal.h"
40 * This helper library provides implementations of check and commit functions on
41 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
42 * also provides convenience implementations for the atomic state handling
43 * callbacks for drivers which don't need to subclass the drm core structures to
44 * add their own additional internal state.
46 * This library also provides default implementations for the check callback in
47 * drm_atomic_helper_check() and for the commit callback with
48 * drm_atomic_helper_commit(). But the individual stages and callbacks are
49 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
50 * together with a driver private modeset implementation.
52 * This library also provides implementations for all the legacy driver
53 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
54 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
55 * various functions to implement set_property callbacks. New drivers must not
56 * implement these functions themselves but must use the provided helpers.
58 * The atomic helper uses the same function table structures as all other
59 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
60 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
61 * also shares the struct &drm_plane_helper_funcs function table with the plane
65 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
66 struct drm_plane_state *plane_state,
67 struct drm_plane *plane)
69 struct drm_crtc_state *crtc_state;
71 if (plane->state->crtc) {
72 crtc_state = drm_atomic_get_existing_crtc_state(state,
75 if (WARN_ON(!crtc_state))
78 crtc_state->planes_changed = true;
81 if (plane_state->crtc) {
82 crtc_state = drm_atomic_get_existing_crtc_state(state,
85 if (WARN_ON(!crtc_state))
88 crtc_state->planes_changed = true;
92 static int handle_conflicting_encoders(struct drm_atomic_state *state,
93 bool disable_conflicting_encoders)
95 struct drm_connector_state *conn_state;
96 struct drm_connector *connector;
97 struct drm_encoder *encoder;
98 unsigned encoder_mask = 0;
102 * First loop, find all newly assigned encoders from the connectors
103 * part of the state. If the same encoder is assigned to multiple
104 * connectors bail out.
106 for_each_connector_in_state(state, connector, conn_state, i) {
107 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
108 struct drm_encoder *new_encoder;
110 if (!conn_state->crtc)
113 if (funcs->atomic_best_encoder)
114 new_encoder = funcs->atomic_best_encoder(connector, conn_state);
115 else if (funcs->best_encoder)
116 new_encoder = funcs->best_encoder(connector);
118 new_encoder = drm_atomic_helper_best_encoder(connector);
121 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
122 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
123 new_encoder->base.id, new_encoder->name,
124 connector->base.id, connector->name);
129 encoder_mask |= 1 << drm_encoder_index(new_encoder);
137 * Second loop, iterate over all connectors not part of the state.
139 * If a conflicting encoder is found and disable_conflicting_encoders
140 * is not set, an error is returned. Userspace can provide a solution
141 * through the atomic ioctl.
143 * If the flag is set conflicting connectors are removed from the crtc
144 * and the crtc is disabled if no encoder is left. This preserves
145 * compatibility with the legacy set_config behavior.
147 drm_for_each_connector(connector, state->dev) {
148 struct drm_crtc_state *crtc_state;
150 if (drm_atomic_get_existing_connector_state(state, connector))
153 encoder = connector->state->best_encoder;
154 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
157 if (!disable_conflicting_encoders) {
158 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
159 encoder->base.id, encoder->name,
160 connector->state->crtc->base.id,
161 connector->state->crtc->name,
162 connector->base.id, connector->name);
166 conn_state = drm_atomic_get_connector_state(state, connector);
167 if (IS_ERR(conn_state))
168 return PTR_ERR(conn_state);
170 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
171 encoder->base.id, encoder->name,
172 conn_state->crtc->base.id, conn_state->crtc->name,
173 connector->base.id, connector->name);
175 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
177 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
181 if (!crtc_state->connector_mask) {
182 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
187 crtc_state->active = false;
195 set_best_encoder(struct drm_atomic_state *state,
196 struct drm_connector_state *conn_state,
197 struct drm_encoder *encoder)
199 struct drm_crtc_state *crtc_state;
200 struct drm_crtc *crtc;
202 if (conn_state->best_encoder) {
203 /* Unset the encoder_mask in the old crtc state. */
204 crtc = conn_state->connector->state->crtc;
206 /* A NULL crtc is an error here because we should have
207 * duplicated a NULL best_encoder when crtc was NULL.
208 * As an exception restoring duplicated atomic state
209 * during resume is allowed, so don't warn when
210 * best_encoder is equal to encoder we intend to set.
212 WARN_ON(!crtc && encoder != conn_state->best_encoder);
214 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
216 crtc_state->encoder_mask &=
217 ~(1 << drm_encoder_index(conn_state->best_encoder));
222 crtc = conn_state->crtc;
225 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
227 crtc_state->encoder_mask |=
228 1 << drm_encoder_index(encoder);
232 conn_state->best_encoder = encoder;
236 steal_encoder(struct drm_atomic_state *state,
237 struct drm_encoder *encoder)
239 struct drm_crtc_state *crtc_state;
240 struct drm_connector *connector;
241 struct drm_connector_state *connector_state;
244 for_each_connector_in_state(state, connector, connector_state, i) {
245 struct drm_crtc *encoder_crtc;
247 if (connector_state->best_encoder != encoder)
250 encoder_crtc = connector->state->crtc;
252 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
253 encoder->base.id, encoder->name,
254 encoder_crtc->base.id, encoder_crtc->name);
256 set_best_encoder(state, connector_state, NULL);
258 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
259 crtc_state->connectors_changed = true;
266 update_connector_routing(struct drm_atomic_state *state,
267 struct drm_connector *connector,
268 struct drm_connector_state *connector_state)
270 const struct drm_connector_helper_funcs *funcs;
271 struct drm_encoder *new_encoder;
272 struct drm_crtc_state *crtc_state;
274 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
278 if (connector->state->crtc != connector_state->crtc) {
279 if (connector->state->crtc) {
280 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
281 crtc_state->connectors_changed = true;
284 if (connector_state->crtc) {
285 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
286 crtc_state->connectors_changed = true;
290 if (!connector_state->crtc) {
291 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
295 set_best_encoder(state, connector_state, NULL);
300 funcs = connector->helper_private;
302 if (funcs->atomic_best_encoder)
303 new_encoder = funcs->atomic_best_encoder(connector,
305 else if (funcs->best_encoder)
306 new_encoder = funcs->best_encoder(connector);
308 new_encoder = drm_atomic_helper_best_encoder(connector);
311 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
317 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
318 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
319 new_encoder->base.id,
321 connector_state->crtc->base.id);
325 if (new_encoder == connector_state->best_encoder) {
326 set_best_encoder(state, connector_state, new_encoder);
328 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
331 new_encoder->base.id,
333 connector_state->crtc->base.id,
334 connector_state->crtc->name);
339 steal_encoder(state, new_encoder);
341 set_best_encoder(state, connector_state, new_encoder);
343 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
344 crtc_state->connectors_changed = true;
346 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
349 new_encoder->base.id,
351 connector_state->crtc->base.id,
352 connector_state->crtc->name);
358 mode_fixup(struct drm_atomic_state *state)
360 struct drm_crtc *crtc;
361 struct drm_crtc_state *crtc_state;
362 struct drm_connector *connector;
363 struct drm_connector_state *conn_state;
367 for_each_crtc_in_state(state, crtc, crtc_state, i) {
368 if (!crtc_state->mode_changed &&
369 !crtc_state->connectors_changed)
372 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
375 for_each_connector_in_state(state, connector, conn_state, i) {
376 const struct drm_encoder_helper_funcs *funcs;
377 struct drm_encoder *encoder;
379 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
381 if (!conn_state->crtc || !conn_state->best_encoder)
384 crtc_state = drm_atomic_get_existing_crtc_state(state,
388 * Each encoder has at most one connector (since we always steal
389 * it away), so we won't call ->mode_fixup twice.
391 encoder = conn_state->best_encoder;
392 funcs = encoder->helper_private;
394 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
395 &crtc_state->adjusted_mode);
397 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
401 if (funcs && funcs->atomic_check) {
402 ret = funcs->atomic_check(encoder, crtc_state,
405 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
406 encoder->base.id, encoder->name);
409 } else if (funcs && funcs->mode_fixup) {
410 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
411 &crtc_state->adjusted_mode);
413 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
414 encoder->base.id, encoder->name);
420 for_each_crtc_in_state(state, crtc, crtc_state, i) {
421 const struct drm_crtc_helper_funcs *funcs;
423 if (!crtc_state->enable)
426 if (!crtc_state->mode_changed &&
427 !crtc_state->connectors_changed)
430 funcs = crtc->helper_private;
431 if (!funcs->mode_fixup)
434 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
435 &crtc_state->adjusted_mode);
437 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
438 crtc->base.id, crtc->name);
447 * drm_atomic_helper_check_modeset - validate state object for modeset changes
449 * @state: the driver state object
451 * Check the state object to see if the requested state is physically possible.
452 * This does all the crtc and connector related computations for an atomic
453 * update and adds any additional connectors needed for full modesets and calls
454 * down into ->mode_fixup functions of the driver backend.
456 * crtc_state->mode_changed is set when the input mode is changed.
457 * crtc_state->connectors_changed is set when a connector is added or
458 * removed from the crtc.
459 * crtc_state->active_changed is set when crtc_state->active changes,
460 * which is used for dpms.
461 * See also: drm_atomic_crtc_needs_modeset()
465 * Drivers which set ->mode_changed (e.g. in their ->atomic_check hooks if a
466 * plane update can't be done without a full modeset) _must_ call this function
467 * afterwards after that change. It is permitted to call this function multiple
468 * times for the same update, e.g. when the ->atomic_check functions depend upon
469 * the adjusted dotclock for fifo space allocation and watermark computation.
472 * Zero for success or -errno
475 drm_atomic_helper_check_modeset(struct drm_device *dev,
476 struct drm_atomic_state *state)
478 struct drm_crtc *crtc;
479 struct drm_crtc_state *crtc_state;
480 struct drm_connector *connector;
481 struct drm_connector_state *connector_state;
484 for_each_crtc_in_state(state, crtc, crtc_state, i) {
485 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
486 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
487 crtc->base.id, crtc->name);
488 crtc_state->mode_changed = true;
491 if (crtc->state->enable != crtc_state->enable) {
492 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
493 crtc->base.id, crtc->name);
496 * For clarity this assignment is done here, but
497 * enable == 0 is only true when there are no
498 * connectors and a NULL mode.
500 * The other way around is true as well. enable != 0
501 * iff connectors are attached and a mode is set.
503 crtc_state->mode_changed = true;
504 crtc_state->connectors_changed = true;
508 ret = handle_conflicting_encoders(state, state->legacy_set_config);
512 for_each_connector_in_state(state, connector, connector_state, i) {
514 * This only sets crtc->connectors_changed for routing changes,
515 * drivers must set crtc->connectors_changed themselves when
516 * connector properties need to be updated.
518 ret = update_connector_routing(state, connector,
525 * After all the routing has been prepared we need to add in any
526 * connector which is itself unchanged, but who's crtc changes it's
527 * configuration. This must be done before calling mode_fixup in case a
528 * crtc only changed its mode but has the same set of connectors.
530 for_each_crtc_in_state(state, crtc, crtc_state, i) {
531 bool has_connectors =
532 !!crtc_state->connector_mask;
535 * We must set ->active_changed after walking connectors for
536 * otherwise an update that only changes active would result in
537 * a full modeset because update_connector_routing force that.
539 if (crtc->state->active != crtc_state->active) {
540 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
541 crtc->base.id, crtc->name);
542 crtc_state->active_changed = true;
545 if (!drm_atomic_crtc_needs_modeset(crtc_state))
548 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
549 crtc->base.id, crtc->name,
550 crtc_state->enable ? 'y' : 'n',
551 crtc_state->active ? 'y' : 'n');
553 ret = drm_atomic_add_affected_connectors(state, crtc);
557 ret = drm_atomic_add_affected_planes(state, crtc);
561 if (crtc_state->enable != has_connectors) {
562 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
563 crtc->base.id, crtc->name);
569 return mode_fixup(state);
571 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
574 * drm_atomic_helper_check_planes - validate state object for planes changes
576 * @state: the driver state object
578 * Check the state object to see if the requested state is physically possible.
579 * This does all the plane update related checks using by calling into the
580 * ->atomic_check hooks provided by the driver.
582 * It also sets crtc_state->planes_changed to indicate that a crtc has
586 * Zero for success or -errno
589 drm_atomic_helper_check_planes(struct drm_device *dev,
590 struct drm_atomic_state *state)
592 struct drm_crtc *crtc;
593 struct drm_crtc_state *crtc_state;
594 struct drm_plane *plane;
595 struct drm_plane_state *plane_state;
598 for_each_plane_in_state(state, plane, plane_state, i) {
599 const struct drm_plane_helper_funcs *funcs;
601 funcs = plane->helper_private;
603 drm_atomic_helper_plane_changed(state, plane_state, plane);
605 if (!funcs || !funcs->atomic_check)
608 ret = funcs->atomic_check(plane, plane_state);
610 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
611 plane->base.id, plane->name);
616 for_each_crtc_in_state(state, crtc, crtc_state, i) {
617 const struct drm_crtc_helper_funcs *funcs;
619 funcs = crtc->helper_private;
621 if (!funcs || !funcs->atomic_check)
624 ret = funcs->atomic_check(crtc, crtc_state);
626 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
627 crtc->base.id, crtc->name);
634 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
637 * drm_atomic_helper_check - validate state object
639 * @state: the driver state object
641 * Check the state object to see if the requested state is physically possible.
642 * Only crtcs and planes have check callbacks, so for any additional (global)
643 * checking that a driver needs it can simply wrap that around this function.
644 * Drivers without such needs can directly use this as their ->atomic_check()
647 * This just wraps the two parts of the state checking for planes and modeset
648 * state in the default order: First it calls drm_atomic_helper_check_modeset()
649 * and then drm_atomic_helper_check_planes(). The assumption is that the
650 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
651 * e.g. properly compute watermarks.
654 * Zero for success or -errno
656 int drm_atomic_helper_check(struct drm_device *dev,
657 struct drm_atomic_state *state)
661 ret = drm_atomic_helper_check_modeset(dev, state);
665 ret = drm_atomic_helper_check_planes(dev, state);
671 EXPORT_SYMBOL(drm_atomic_helper_check);
674 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
676 struct drm_connector *connector;
677 struct drm_connector_state *old_conn_state;
678 struct drm_crtc *crtc;
679 struct drm_crtc_state *old_crtc_state;
682 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
683 const struct drm_encoder_helper_funcs *funcs;
684 struct drm_encoder *encoder;
686 /* Shut down everything that's in the changeset and currently
687 * still on. So need to check the old, saved state. */
688 if (!old_conn_state->crtc)
691 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
692 old_conn_state->crtc);
694 if (!old_crtc_state->active ||
695 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
698 encoder = old_conn_state->best_encoder;
700 /* We shouldn't get this far if we didn't previously have
701 * an encoder.. but WARN_ON() rather than explode.
703 if (WARN_ON(!encoder))
706 funcs = encoder->helper_private;
708 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
709 encoder->base.id, encoder->name);
712 * Each encoder has at most one connector (since we always steal
713 * it away), so we won't call disable hooks twice.
715 drm_bridge_disable(encoder->bridge);
717 /* Right function depends upon target state. */
719 if (connector->state->crtc && funcs->prepare)
720 funcs->prepare(encoder);
721 else if (funcs->disable)
722 funcs->disable(encoder);
723 else if (funcs->dpms)
724 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
727 drm_bridge_post_disable(encoder->bridge);
730 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
731 const struct drm_crtc_helper_funcs *funcs;
733 /* Shut down everything that needs a full modeset. */
734 if (!drm_atomic_crtc_needs_modeset(crtc->state))
737 if (!old_crtc_state->active)
740 funcs = crtc->helper_private;
742 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
743 crtc->base.id, crtc->name);
746 /* Right function depends upon target state. */
747 if (crtc->state->enable && funcs->prepare)
748 funcs->prepare(crtc);
749 else if (funcs->atomic_disable)
750 funcs->atomic_disable(crtc, old_crtc_state);
751 else if (funcs->disable)
752 funcs->disable(crtc);
754 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
759 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
761 * @old_state: atomic state object with old state structures
763 * This function updates all the various legacy modeset state pointers in
764 * connectors, encoders and crtcs. It also updates the timestamping constants
765 * used for precise vblank timestamps by calling
766 * drm_calc_timestamping_constants().
768 * Drivers can use this for building their own atomic commit if they don't have
769 * a pure helper-based modeset implementation.
772 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
773 struct drm_atomic_state *old_state)
775 struct drm_connector *connector;
776 struct drm_connector_state *old_conn_state;
777 struct drm_crtc *crtc;
778 struct drm_crtc_state *old_crtc_state;
781 /* clear out existing links and update dpms */
782 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
783 if (connector->encoder) {
784 WARN_ON(!connector->encoder->crtc);
786 connector->encoder->crtc = NULL;
787 connector->encoder = NULL;
790 crtc = connector->state->crtc;
791 if ((!crtc && old_conn_state->crtc) ||
792 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
793 struct drm_property *dpms_prop =
794 dev->mode_config.dpms_property;
795 int mode = DRM_MODE_DPMS_OFF;
797 if (crtc && crtc->state->active)
798 mode = DRM_MODE_DPMS_ON;
800 connector->dpms = mode;
801 drm_object_property_set_value(&connector->base,
807 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
808 if (!connector->state->crtc)
811 if (WARN_ON(!connector->state->best_encoder))
814 connector->encoder = connector->state->best_encoder;
815 connector->encoder->crtc = connector->state->crtc;
818 /* set legacy state in the crtc structure */
819 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
820 struct drm_plane *primary = crtc->primary;
822 crtc->mode = crtc->state->mode;
823 crtc->enabled = crtc->state->enable;
825 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
826 primary->state->crtc == crtc) {
827 crtc->x = primary->state->src_x >> 16;
828 crtc->y = primary->state->src_y >> 16;
831 if (crtc->state->enable)
832 drm_calc_timestamping_constants(crtc,
833 &crtc->state->adjusted_mode);
836 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
839 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
841 struct drm_crtc *crtc;
842 struct drm_crtc_state *old_crtc_state;
843 struct drm_connector *connector;
844 struct drm_connector_state *old_conn_state;
847 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
848 const struct drm_crtc_helper_funcs *funcs;
850 if (!crtc->state->mode_changed)
853 funcs = crtc->helper_private;
855 if (crtc->state->enable && funcs->mode_set_nofb) {
856 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
857 crtc->base.id, crtc->name);
859 funcs->mode_set_nofb(crtc);
863 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
864 const struct drm_encoder_helper_funcs *funcs;
865 struct drm_crtc_state *new_crtc_state;
866 struct drm_encoder *encoder;
867 struct drm_display_mode *mode, *adjusted_mode;
869 if (!connector->state->best_encoder)
872 encoder = connector->state->best_encoder;
873 funcs = encoder->helper_private;
874 new_crtc_state = connector->state->crtc->state;
875 mode = &new_crtc_state->mode;
876 adjusted_mode = &new_crtc_state->adjusted_mode;
878 if (!new_crtc_state->mode_changed)
881 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
882 encoder->base.id, encoder->name);
885 * Each encoder has at most one connector (since we always steal
886 * it away), so we won't call mode_set hooks twice.
888 if (funcs && funcs->atomic_mode_set) {
889 funcs->atomic_mode_set(encoder, new_crtc_state,
891 } else if (funcs && funcs->mode_set) {
892 funcs->mode_set(encoder, mode, adjusted_mode);
895 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
900 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
902 * @old_state: atomic state object with old state structures
904 * This function shuts down all the outputs that need to be shut down and
905 * prepares them (if required) with the new mode.
907 * For compatibility with legacy crtc helpers this should be called before
908 * drm_atomic_helper_commit_planes(), which is what the default commit function
909 * does. But drivers with different needs can group the modeset commits together
910 * and do the plane commits at the end. This is useful for drivers doing runtime
911 * PM since planes updates then only happen when the CRTC is actually enabled.
913 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
914 struct drm_atomic_state *old_state)
916 disable_outputs(dev, old_state);
918 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
920 crtc_set_mode(dev, old_state);
922 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
925 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
927 * @old_state: atomic state object with old state structures
929 * This function enables all the outputs with the new configuration which had to
930 * be turned off for the update.
932 * For compatibility with legacy crtc helpers this should be called after
933 * drm_atomic_helper_commit_planes(), which is what the default commit function
934 * does. But drivers with different needs can group the modeset commits together
935 * and do the plane commits at the end. This is useful for drivers doing runtime
936 * PM since planes updates then only happen when the CRTC is actually enabled.
938 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
939 struct drm_atomic_state *old_state)
941 struct drm_crtc *crtc;
942 struct drm_crtc_state *old_crtc_state;
943 struct drm_connector *connector;
944 struct drm_connector_state *old_conn_state;
947 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
948 const struct drm_crtc_helper_funcs *funcs;
950 /* Need to filter out CRTCs where only planes change. */
951 if (!drm_atomic_crtc_needs_modeset(crtc->state))
954 if (!crtc->state->active)
957 funcs = crtc->helper_private;
959 if (crtc->state->enable) {
960 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
961 crtc->base.id, crtc->name);
970 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
971 const struct drm_encoder_helper_funcs *funcs;
972 struct drm_encoder *encoder;
974 if (!connector->state->best_encoder)
977 if (!connector->state->crtc->state->active ||
978 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
981 encoder = connector->state->best_encoder;
982 funcs = encoder->helper_private;
984 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
985 encoder->base.id, encoder->name);
988 * Each encoder has at most one connector (since we always steal
989 * it away), so we won't call enable hooks twice.
991 drm_bridge_pre_enable(encoder->bridge);
995 funcs->enable(encoder);
996 else if (funcs->commit)
997 funcs->commit(encoder);
1000 drm_bridge_enable(encoder->bridge);
1003 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1006 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1008 * @state: atomic state object with old state structures
1009 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1010 * Otherwise @state is the old state.
1012 * For implicit sync, driver should fish the exclusive fence out from the
1013 * incoming fb's and stash it in the drm_plane_state. This is called after
1014 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1015 * just uses the atomic state to find the changed planes)
1017 * Note that @pre_swap is needed since the point where we block for fences moves
1018 * around depending upon whether an atomic commit is blocking or
1019 * non-blocking. For async commit all waiting needs to happen after
1020 * drm_atomic_helper_swap_state() is called, but for synchronous commits we want
1021 * to wait **before** we do anything that can't be easily rolled back. That is
1022 * before we call drm_atomic_helper_swap_state().
1024 * Returns zero if success or < 0 if dma_fence_wait() fails.
1026 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1027 struct drm_atomic_state *state,
1030 struct drm_plane *plane;
1031 struct drm_plane_state *plane_state;
1034 for_each_plane_in_state(state, plane, plane_state, i) {
1036 plane_state = plane->state;
1038 if (!plane_state->fence)
1041 WARN_ON(!plane_state->fb);
1044 * If waiting for fences pre-swap (ie: nonblock), userspace can
1045 * still interrupt the operation. Instead of blocking until the
1046 * timer expires, make the wait interruptible.
1048 ret = dma_fence_wait(plane_state->fence, pre_swap);
1052 dma_fence_put(plane_state->fence);
1053 plane_state->fence = NULL;
1058 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1061 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1063 * @old_state: atomic state object with old state structures
1066 * Checks whether the framebuffer used for this CRTC changes as a result of
1067 * the atomic update. This is useful for drivers which cannot use
1068 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1072 * true if the framebuffer changed.
1074 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1075 struct drm_atomic_state *old_state,
1076 struct drm_crtc *crtc)
1078 struct drm_plane *plane;
1079 struct drm_plane_state *old_plane_state;
1082 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1083 if (plane->state->crtc != crtc &&
1084 old_plane_state->crtc != crtc)
1087 if (plane->state->fb != old_plane_state->fb)
1093 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1096 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1098 * @old_state: atomic state object with old state structures
1100 * Helper to, after atomic commit, wait for vblanks on all effected
1101 * crtcs (ie. before cleaning up old framebuffers using
1102 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1103 * framebuffers have actually changed to optimize for the legacy cursor and
1104 * plane update use-case.
1107 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1108 struct drm_atomic_state *old_state)
1110 struct drm_crtc *crtc;
1111 struct drm_crtc_state *old_crtc_state;
1114 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1115 /* No one cares about the old state, so abuse it for tracking
1116 * and store whether we hold a vblank reference (and should do a
1117 * vblank wait) in the ->enable boolean. */
1118 old_crtc_state->enable = false;
1120 if (!crtc->state->enable)
1123 /* Legacy cursor ioctls are completely unsynced, and userspace
1124 * relies on that (by doing tons of cursor updates). */
1125 if (old_state->legacy_cursor_update)
1128 if (!drm_atomic_helper_framebuffer_changed(dev,
1132 ret = drm_crtc_vblank_get(crtc);
1136 old_crtc_state->enable = true;
1137 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1140 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1141 if (!old_crtc_state->enable)
1144 ret = wait_event_timeout(dev->vblank[i].queue,
1145 old_crtc_state->last_vblank_count !=
1146 drm_crtc_vblank_count(crtc),
1147 msecs_to_jiffies(50));
1149 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1151 drm_crtc_vblank_put(crtc);
1154 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1157 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1158 * @old_state: atomic state object with old state structures
1160 * This is the default implemenation for the ->atomic_commit_tail() hook of the
1161 * &drm_mode_config_helper_funcs vtable.
1163 * Note that the default ordering of how the various stages are called is to
1164 * match the legacy modeset helper library closest. One peculiarity of that is
1165 * that it doesn't mesh well with runtime PM at all.
1167 * For drivers supporting runtime PM the recommended sequence is instead ::
1169 * drm_atomic_helper_commit_modeset_disables(dev, old_state);
1171 * drm_atomic_helper_commit_modeset_enables(dev, old_state);
1173 * drm_atomic_helper_commit_planes(dev, old_state,
1174 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
1176 * for committing the atomic update to hardware. See the kerneldoc entries for
1177 * these three functions for more details.
1179 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1181 struct drm_device *dev = old_state->dev;
1183 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1185 drm_atomic_helper_commit_planes(dev, old_state, 0);
1187 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1189 drm_atomic_helper_commit_hw_done(old_state);
1191 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1193 drm_atomic_helper_cleanup_planes(dev, old_state);
1195 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1197 static void commit_tail(struct drm_atomic_state *old_state)
1199 struct drm_device *dev = old_state->dev;
1200 struct drm_mode_config_helper_funcs *funcs;
1202 funcs = dev->mode_config.helper_private;
1204 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1206 drm_atomic_helper_wait_for_dependencies(old_state);
1208 if (funcs && funcs->atomic_commit_tail)
1209 funcs->atomic_commit_tail(old_state);
1211 drm_atomic_helper_commit_tail(old_state);
1213 drm_atomic_helper_commit_cleanup_done(old_state);
1215 drm_atomic_state_put(old_state);
1218 static void commit_work(struct work_struct *work)
1220 struct drm_atomic_state *state = container_of(work,
1221 struct drm_atomic_state,
1227 * drm_atomic_helper_commit - commit validated state object
1229 * @state: the driver state object
1230 * @nonblock: whether nonblocking behavior is requested.
1232 * This function commits a with drm_atomic_helper_check() pre-validated state
1233 * object. This can still fail when e.g. the framebuffer reservation fails. This
1234 * function implements nonblocking commits, using
1235 * drm_atomic_helper_setup_commit() and related functions.
1237 * Committing the actual hardware state is done through the
1238 * ->atomic_commit_tail() callback of the &drm_mode_config_helper_funcs vtable,
1239 * or it's default implementation drm_atomic_helper_commit_tail().
1242 * Zero for success or -errno.
1244 int drm_atomic_helper_commit(struct drm_device *dev,
1245 struct drm_atomic_state *state,
1250 ret = drm_atomic_helper_setup_commit(state, nonblock);
1254 INIT_WORK(&state->commit_work, commit_work);
1256 ret = drm_atomic_helper_prepare_planes(dev, state);
1261 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1267 * This is the point of no return - everything below never fails except
1268 * when the hw goes bonghits. Which means we can commit the new state on
1269 * the software side now.
1272 drm_atomic_helper_swap_state(state, true);
1275 * Everything below can be run asynchronously without the need to grab
1276 * any modeset locks at all under one condition: It must be guaranteed
1277 * that the asynchronous work has either been cancelled (if the driver
1278 * supports it, which at least requires that the framebuffers get
1279 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1280 * before the new state gets committed on the software side with
1281 * drm_atomic_helper_swap_state().
1283 * This scheme allows new atomic state updates to be prepared and
1284 * checked in parallel to the asynchronous completion of the previous
1285 * update. Which is important since compositors need to figure out the
1286 * composition of the next frame right after having submitted the
1289 * NOTE: Commit work has multiple phases, first hardware commit, then
1290 * cleanup. We want them to overlap, hence need system_unbound_wq to
1291 * make sure work items don't artifically stall on each another.
1294 drm_atomic_state_get(state);
1296 queue_work(system_unbound_wq, &state->commit_work);
1302 EXPORT_SYMBOL(drm_atomic_helper_commit);
1305 * DOC: implementing nonblocking commit
1307 * Nonblocking atomic commits have to be implemented in the following sequence:
1309 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1310 * which commit needs to call which can fail, so we want to run it first and
1313 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1314 * might be affected the new state update. This can be done by either cancelling
1315 * or flushing the work items, depending upon whether the driver can deal with
1316 * cancelled updates. Note that it is important to ensure that the framebuffer
1317 * cleanup is still done when cancelling.
1319 * Asynchronous workers need to have sufficient parallelism to be able to run
1320 * different atomic commits on different CRTCs in parallel. The simplest way to
1321 * achive this is by running them on the &system_unbound_wq work queue. Note
1322 * that drivers are not required to split up atomic commits and run an
1323 * individual commit in parallel - userspace is supposed to do that if it cares.
1324 * But it might be beneficial to do that for modesets, since those necessarily
1325 * must be done as one global operation, and enabling or disabling a CRTC can
1326 * take a long time. But even that is not required.
1328 * 3. The software state is updated synchronously with
1329 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1330 * locks means concurrent callers never see inconsistent state. And doing this
1331 * while it's guaranteed that no relevant nonblocking worker runs means that
1332 * nonblocking workers do not need grab any locks. Actually they must not grab
1333 * locks, for otherwise the work flushing will deadlock.
1335 * 4. Schedule a work item to do all subsequent steps, using the split-out
1336 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1337 * then cleaning up the framebuffers after the old framebuffer is no longer
1340 * The above scheme is implemented in the atomic helper libraries in
1341 * drm_atomic_helper_commit() using a bunch of helper functions. See
1342 * drm_atomic_helper_setup_commit() for a starting point.
1345 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1347 struct drm_crtc_commit *commit, *stall_commit = NULL;
1348 bool completed = true;
1352 spin_lock(&crtc->commit_lock);
1354 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1356 completed = try_wait_for_completion(&commit->flip_done);
1357 /* Userspace is not allowed to get ahead of the previous
1358 * commit with nonblocking ones. */
1359 if (!completed && nonblock) {
1360 spin_unlock(&crtc->commit_lock);
1363 } else if (i == 1) {
1364 stall_commit = commit;
1365 drm_crtc_commit_get(stall_commit);
1371 spin_unlock(&crtc->commit_lock);
1376 /* We don't want to let commits get ahead of cleanup work too much,
1377 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1379 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1382 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1383 crtc->base.id, crtc->name);
1385 drm_crtc_commit_put(stall_commit);
1387 return ret < 0 ? ret : 0;
1391 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1392 * @state: new modeset state to be committed
1393 * @nonblock: whether nonblocking behavior is requested.
1395 * This function prepares @state to be used by the atomic helper's support for
1396 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1397 * should always call this function from their ->atomic_commit hook.
1399 * To be able to use this support drivers need to use a few more helper
1400 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1401 * actually committing the hardware state, and for nonblocking commits this call
1402 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1403 * and it's stall parameter, for when a driver's commit hooks look at the
1404 * ->state pointers of struct &drm_crtc, &drm_plane or &drm_connector directly.
1406 * Completion of the hardware commit step must be signalled using
1407 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1408 * to read or change any permanent software or hardware modeset state. The only
1409 * exception is state protected by other means than &drm_modeset_lock locks.
1410 * Only the free standing @state with pointers to the old state structures can
1411 * be inspected, e.g. to clean up old buffers using
1412 * drm_atomic_helper_cleanup_planes().
1414 * At the very end, before cleaning up @state drivers must call
1415 * drm_atomic_helper_commit_cleanup_done().
1417 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1418 * complete and esay-to-use default implementation of the atomic_commit() hook.
1420 * The tracking of asynchronously executed and still pending commits is done
1421 * using the core structure &drm_crtc_commit.
1423 * By default there's no need to clean up resources allocated by this function
1424 * explicitly: drm_atomic_state_default_clear() will take care of that
1429 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1430 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1432 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1435 struct drm_crtc *crtc;
1436 struct drm_crtc_state *crtc_state;
1437 struct drm_crtc_commit *commit;
1440 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1441 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1445 init_completion(&commit->flip_done);
1446 init_completion(&commit->hw_done);
1447 init_completion(&commit->cleanup_done);
1448 INIT_LIST_HEAD(&commit->commit_entry);
1449 kref_init(&commit->ref);
1450 commit->crtc = crtc;
1452 state->crtcs[i].commit = commit;
1454 ret = stall_checks(crtc, nonblock);
1458 /* Drivers only send out events when at least either current or
1459 * new CRTC state is active. Complete right away if everything
1461 if (!crtc->state->active && !crtc_state->active) {
1462 complete_all(&commit->flip_done);
1466 /* Legacy cursor updates are fully unsynced. */
1467 if (state->legacy_cursor_update) {
1468 complete_all(&commit->flip_done);
1472 if (!crtc_state->event) {
1473 commit->event = kzalloc(sizeof(*commit->event),
1478 crtc_state->event = commit->event;
1481 crtc_state->event->base.completion = &commit->flip_done;
1486 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1489 static struct drm_crtc_commit *preceeding_commit(struct drm_crtc *crtc)
1491 struct drm_crtc_commit *commit;
1494 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1495 /* skip the first entry, that's the current commit */
1505 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1506 * @old_state: atomic state object with old state structures
1508 * This function waits for all preceeding commits that touch the same CRTC as
1509 * @old_state to both be committed to the hardware (as signalled by
1510 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1511 * by calling drm_crtc_vblank_send_event on the event member of
1514 * This is part of the atomic helper support for nonblocking commits, see
1515 * drm_atomic_helper_setup_commit() for an overview.
1517 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
1519 struct drm_crtc *crtc;
1520 struct drm_crtc_state *crtc_state;
1521 struct drm_crtc_commit *commit;
1525 for_each_crtc_in_state(old_state, crtc, crtc_state, i) {
1526 spin_lock(&crtc->commit_lock);
1527 commit = preceeding_commit(crtc);
1529 drm_crtc_commit_get(commit);
1530 spin_unlock(&crtc->commit_lock);
1535 ret = wait_for_completion_timeout(&commit->hw_done,
1538 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1539 crtc->base.id, crtc->name);
1541 /* Currently no support for overwriting flips, hence
1542 * stall for previous one to execute completely. */
1543 ret = wait_for_completion_timeout(&commit->flip_done,
1546 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1547 crtc->base.id, crtc->name);
1549 drm_crtc_commit_put(commit);
1552 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
1555 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1556 * @old_state: atomic state object with old state structures
1558 * This function is used to signal completion of the hardware commit step. After
1559 * this step the driver is not allowed to read or change any permanent software
1560 * or hardware modeset state. The only exception is state protected by other
1561 * means than &drm_modeset_lock locks.
1563 * Drivers should try to postpone any expensive or delayed cleanup work after
1564 * this function is called.
1566 * This is part of the atomic helper support for nonblocking commits, see
1567 * drm_atomic_helper_setup_commit() for an overview.
1569 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
1571 struct drm_crtc *crtc;
1572 struct drm_crtc_state *crtc_state;
1573 struct drm_crtc_commit *commit;
1576 for_each_crtc_in_state(old_state, crtc, crtc_state, i) {
1577 commit = old_state->crtcs[i].commit;
1581 /* backend must have consumed any event by now */
1582 WARN_ON(crtc->state->event);
1583 spin_lock(&crtc->commit_lock);
1584 complete_all(&commit->hw_done);
1585 spin_unlock(&crtc->commit_lock);
1588 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
1591 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1592 * @old_state: atomic state object with old state structures
1594 * This signals completion of the atomic update @old_state, including any
1595 * cleanup work. If used, it must be called right before calling
1596 * drm_atomic_state_put().
1598 * This is part of the atomic helper support for nonblocking commits, see
1599 * drm_atomic_helper_setup_commit() for an overview.
1601 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
1603 struct drm_crtc *crtc;
1604 struct drm_crtc_state *crtc_state;
1605 struct drm_crtc_commit *commit;
1609 for_each_crtc_in_state(old_state, crtc, crtc_state, i) {
1610 commit = old_state->crtcs[i].commit;
1611 if (WARN_ON(!commit))
1614 spin_lock(&crtc->commit_lock);
1615 complete_all(&commit->cleanup_done);
1616 WARN_ON(!try_wait_for_completion(&commit->hw_done));
1618 /* commit_list borrows our reference, need to remove before we
1619 * clean up our drm_atomic_state. But only after it actually
1620 * completed, otherwise subsequent commits won't stall properly. */
1621 if (try_wait_for_completion(&commit->flip_done))
1624 spin_unlock(&crtc->commit_lock);
1626 /* We must wait for the vblank event to signal our completion
1627 * before releasing our reference, since the vblank work does
1628 * not hold a reference of its own. */
1629 ret = wait_for_completion_timeout(&commit->flip_done,
1632 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1633 crtc->base.id, crtc->name);
1635 spin_lock(&crtc->commit_lock);
1637 list_del(&commit->commit_entry);
1638 spin_unlock(&crtc->commit_lock);
1641 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
1644 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1646 * @state: atomic state object with new state structures
1648 * This function prepares plane state, specifically framebuffers, for the new
1649 * configuration. If any failure is encountered this function will call
1650 * ->cleanup_fb on any already successfully prepared framebuffer.
1653 * 0 on success, negative error code on failure.
1655 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1656 struct drm_atomic_state *state)
1658 struct drm_plane *plane;
1659 struct drm_plane_state *plane_state;
1662 for_each_plane_in_state(state, plane, plane_state, i) {
1663 const struct drm_plane_helper_funcs *funcs;
1665 funcs = plane->helper_private;
1667 if (!drm_atomic_helper_framebuffer_changed(dev, state, plane_state->crtc))
1670 if (funcs->prepare_fb) {
1671 ret = funcs->prepare_fb(plane, plane_state);
1680 for_each_plane_in_state(state, plane, plane_state, j) {
1681 const struct drm_plane_helper_funcs *funcs;
1686 if (!drm_atomic_helper_framebuffer_changed(dev, state, plane_state->crtc))
1689 funcs = plane->helper_private;
1691 if (funcs->cleanup_fb)
1692 funcs->cleanup_fb(plane, plane_state);
1697 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1699 static bool plane_crtc_active(const struct drm_plane_state *state)
1701 return state->crtc && state->crtc->state->active;
1705 * drm_atomic_helper_commit_planes - commit plane state
1707 * @old_state: atomic state object with old state structures
1708 * @flags: flags for committing plane state
1710 * This function commits the new plane state using the plane and atomic helper
1711 * functions for planes and crtcs. It assumes that the atomic state has already
1712 * been pushed into the relevant object state pointers, since this step can no
1715 * It still requires the global state object @old_state to know which planes and
1716 * crtcs need to be updated though.
1718 * Note that this function does all plane updates across all CRTCs in one step.
1719 * If the hardware can't support this approach look at
1720 * drm_atomic_helper_commit_planes_on_crtc() instead.
1722 * Plane parameters can be updated by applications while the associated CRTC is
1723 * disabled. The DRM/KMS core will store the parameters in the plane state,
1724 * which will be available to the driver when the CRTC is turned on. As a result
1725 * most drivers don't need to be immediately notified of plane updates for a
1728 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
1729 * @flags in order not to receive plane update notifications related to a
1730 * disabled CRTC. This avoids the need to manually ignore plane updates in
1731 * driver code when the driver and/or hardware can't or just don't need to deal
1732 * with updates on disabled CRTCs, for example when supporting runtime PM.
1734 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
1735 * display controllers require to disable a CRTC's planes when the CRTC is
1736 * disabled. This function would skip the ->atomic_disable call for a plane if
1737 * the CRTC of the old plane state needs a modesetting operation. Of course,
1738 * the drivers need to disable the planes in their CRTC disable callbacks
1739 * since no one else would do that.
1741 * The drm_atomic_helper_commit() default implementation doesn't set the
1742 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
1743 * This should not be copied blindly by drivers.
1745 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1746 struct drm_atomic_state *old_state,
1749 struct drm_crtc *crtc;
1750 struct drm_crtc_state *old_crtc_state;
1751 struct drm_plane *plane;
1752 struct drm_plane_state *old_plane_state;
1754 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
1755 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
1757 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1758 const struct drm_crtc_helper_funcs *funcs;
1760 funcs = crtc->helper_private;
1762 if (!funcs || !funcs->atomic_begin)
1765 if (active_only && !crtc->state->active)
1768 funcs->atomic_begin(crtc, old_crtc_state);
1771 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1772 const struct drm_plane_helper_funcs *funcs;
1775 funcs = plane->helper_private;
1780 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1784 * Skip planes related to inactive CRTCs. If the plane
1785 * is enabled use the state of the current CRTC. If the
1786 * plane is being disabled use the state of the old
1787 * CRTC to avoid skipping planes being disabled on an
1790 if (!disabling && !plane_crtc_active(plane->state))
1792 if (disabling && !plane_crtc_active(old_plane_state))
1797 * Special-case disabling the plane if drivers support it.
1799 if (disabling && funcs->atomic_disable) {
1800 struct drm_crtc_state *crtc_state;
1802 crtc_state = old_plane_state->crtc->state;
1804 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
1808 funcs->atomic_disable(plane, old_plane_state);
1809 } else if (plane->state->crtc || disabling) {
1810 funcs->atomic_update(plane, old_plane_state);
1814 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1815 const struct drm_crtc_helper_funcs *funcs;
1817 funcs = crtc->helper_private;
1819 if (!funcs || !funcs->atomic_flush)
1822 if (active_only && !crtc->state->active)
1825 funcs->atomic_flush(crtc, old_crtc_state);
1828 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1831 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1832 * @old_crtc_state: atomic state object with the old crtc state
1834 * This function commits the new plane state using the plane and atomic helper
1835 * functions for planes on the specific crtc. It assumes that the atomic state
1836 * has already been pushed into the relevant object state pointers, since this
1837 * step can no longer fail.
1839 * This function is useful when plane updates should be done crtc-by-crtc
1840 * instead of one global step like drm_atomic_helper_commit_planes() does.
1842 * This function can only be savely used when planes are not allowed to move
1843 * between different CRTCs because this function doesn't handle inter-CRTC
1844 * depencies. Callers need to ensure that either no such depencies exist,
1845 * resolve them through ordering of commit calls or through some other means.
1848 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1850 const struct drm_crtc_helper_funcs *crtc_funcs;
1851 struct drm_crtc *crtc = old_crtc_state->crtc;
1852 struct drm_atomic_state *old_state = old_crtc_state->state;
1853 struct drm_plane *plane;
1854 unsigned plane_mask;
1856 plane_mask = old_crtc_state->plane_mask;
1857 plane_mask |= crtc->state->plane_mask;
1859 crtc_funcs = crtc->helper_private;
1860 if (crtc_funcs && crtc_funcs->atomic_begin)
1861 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1863 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1864 struct drm_plane_state *old_plane_state =
1865 drm_atomic_get_existing_plane_state(old_state, plane);
1866 const struct drm_plane_helper_funcs *plane_funcs;
1868 plane_funcs = plane->helper_private;
1870 if (!old_plane_state || !plane_funcs)
1873 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1875 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1876 plane_funcs->atomic_disable)
1877 plane_funcs->atomic_disable(plane, old_plane_state);
1878 else if (plane->state->crtc ||
1879 drm_atomic_plane_disabling(plane, old_plane_state))
1880 plane_funcs->atomic_update(plane, old_plane_state);
1883 if (crtc_funcs && crtc_funcs->atomic_flush)
1884 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1886 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1889 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1890 * @old_crtc_state: atomic state object with the old CRTC state
1891 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1893 * Disables all planes associated with the given CRTC. This can be
1894 * used for instance in the CRTC helper atomic_disable callback to disable
1897 * If the atomic-parameter is set the function calls the CRTC's
1898 * atomic_begin hook before and atomic_flush hook after disabling the
1901 * It is a bug to call this function without having implemented the
1902 * ->atomic_disable() plane hook.
1905 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
1908 struct drm_crtc *crtc = old_crtc_state->crtc;
1909 const struct drm_crtc_helper_funcs *crtc_funcs =
1910 crtc->helper_private;
1911 struct drm_plane *plane;
1913 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1914 crtc_funcs->atomic_begin(crtc, NULL);
1916 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
1917 const struct drm_plane_helper_funcs *plane_funcs =
1918 plane->helper_private;
1923 WARN_ON(!plane_funcs->atomic_disable);
1924 if (plane_funcs->atomic_disable)
1925 plane_funcs->atomic_disable(plane, NULL);
1928 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1929 crtc_funcs->atomic_flush(crtc, NULL);
1931 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1934 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1936 * @old_state: atomic state object with old state structures
1938 * This function cleans up plane state, specifically framebuffers, from the old
1939 * configuration. Hence the old configuration must be perserved in @old_state to
1940 * be able to call this function.
1942 * This function must also be called on the new state when the atomic update
1943 * fails at any point after calling drm_atomic_helper_prepare_planes().
1945 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1946 struct drm_atomic_state *old_state)
1948 struct drm_plane *plane;
1949 struct drm_plane_state *plane_state;
1952 for_each_plane_in_state(old_state, plane, plane_state, i) {
1953 const struct drm_plane_helper_funcs *funcs;
1955 if (!drm_atomic_helper_framebuffer_changed(dev, old_state, plane_state->crtc))
1958 funcs = plane->helper_private;
1960 if (funcs->cleanup_fb)
1961 funcs->cleanup_fb(plane, plane_state);
1964 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1967 * drm_atomic_helper_swap_state - store atomic state into current sw state
1968 * @state: atomic state
1969 * @stall: stall for proceeding commits
1971 * This function stores the atomic state into the current state pointers in all
1972 * driver objects. It should be called after all failing steps have been done
1973 * and succeeded, but before the actual hardware state is committed.
1975 * For cleanup and error recovery the current state for all changed objects will
1976 * be swaped into @state.
1978 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1980 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1982 * 2. Do any other steps that might fail.
1984 * 3. Put the staged state into the current state pointers with this function.
1986 * 4. Actually commit the hardware state.
1988 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1989 * contains the old state. Also do any other cleanup required with that state.
1991 * @stall must be set when nonblocking commits for this driver directly access
1992 * the ->state pointer of &drm_plane, &drm_crtc or &drm_connector. With the
1993 * current atomic helpers this is almost always the case, since the helpers
1994 * don't pass the right state structures to the callbacks.
1996 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2001 struct drm_connector *connector;
2002 struct drm_connector_state *conn_state;
2003 struct drm_crtc *crtc;
2004 struct drm_crtc_state *crtc_state;
2005 struct drm_plane *plane;
2006 struct drm_plane_state *plane_state;
2007 struct drm_crtc_commit *commit;
2010 for_each_crtc_in_state(state, crtc, crtc_state, i) {
2011 spin_lock(&crtc->commit_lock);
2012 commit = list_first_entry_or_null(&crtc->commit_list,
2013 struct drm_crtc_commit, commit_entry);
2015 drm_crtc_commit_get(commit);
2016 spin_unlock(&crtc->commit_lock);
2021 ret = wait_for_completion_timeout(&commit->hw_done,
2024 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2025 crtc->base.id, crtc->name);
2026 drm_crtc_commit_put(commit);
2030 for_each_connector_in_state(state, connector, conn_state, i) {
2031 connector->state->state = state;
2032 swap(state->connectors[i].state, connector->state);
2033 connector->state->state = NULL;
2036 for_each_crtc_in_state(state, crtc, crtc_state, i) {
2037 crtc->state->state = state;
2038 swap(state->crtcs[i].state, crtc->state);
2039 crtc->state->state = NULL;
2041 if (state->crtcs[i].commit) {
2042 spin_lock(&crtc->commit_lock);
2043 list_add(&state->crtcs[i].commit->commit_entry,
2044 &crtc->commit_list);
2045 spin_unlock(&crtc->commit_lock);
2047 state->crtcs[i].commit->event = NULL;
2051 for_each_plane_in_state(state, plane, plane_state, i) {
2052 plane->state->state = state;
2053 swap(state->planes[i].state, plane->state);
2054 plane->state->state = NULL;
2057 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2060 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2061 * @plane: plane object to update
2062 * @crtc: owning CRTC of owning plane
2063 * @fb: framebuffer to flip onto plane
2064 * @crtc_x: x offset of primary plane on crtc
2065 * @crtc_y: y offset of primary plane on crtc
2066 * @crtc_w: width of primary plane rectangle on crtc
2067 * @crtc_h: height of primary plane rectangle on crtc
2068 * @src_x: x offset of @fb for panning
2069 * @src_y: y offset of @fb for panning
2070 * @src_w: width of source rectangle in @fb
2071 * @src_h: height of source rectangle in @fb
2073 * Provides a default plane update handler using the atomic driver interface.
2076 * Zero on success, error code on failure
2078 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2079 struct drm_crtc *crtc,
2080 struct drm_framebuffer *fb,
2081 int crtc_x, int crtc_y,
2082 unsigned int crtc_w, unsigned int crtc_h,
2083 uint32_t src_x, uint32_t src_y,
2084 uint32_t src_w, uint32_t src_h)
2086 struct drm_atomic_state *state;
2087 struct drm_plane_state *plane_state;
2090 state = drm_atomic_state_alloc(plane->dev);
2094 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2096 plane_state = drm_atomic_get_plane_state(state, plane);
2097 if (IS_ERR(plane_state)) {
2098 ret = PTR_ERR(plane_state);
2102 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2105 drm_atomic_set_fb_for_plane(plane_state, fb);
2106 plane_state->crtc_x = crtc_x;
2107 plane_state->crtc_y = crtc_y;
2108 plane_state->crtc_w = crtc_w;
2109 plane_state->crtc_h = crtc_h;
2110 plane_state->src_x = src_x;
2111 plane_state->src_y = src_y;
2112 plane_state->src_w = src_w;
2113 plane_state->src_h = src_h;
2115 if (plane == crtc->cursor)
2116 state->legacy_cursor_update = true;
2118 ret = drm_atomic_commit(state);
2120 if (ret == -EDEADLK)
2123 drm_atomic_state_put(state);
2127 drm_atomic_state_clear(state);
2128 drm_atomic_legacy_backoff(state);
2131 * Someone might have exchanged the framebuffer while we dropped locks
2132 * in the backoff code. We need to fix up the fb refcount tracking the
2135 plane->old_fb = plane->fb;
2139 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2142 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2143 * @plane: plane to disable
2145 * Provides a default plane disable handler using the atomic driver interface.
2148 * Zero on success, error code on failure
2150 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
2152 struct drm_atomic_state *state;
2153 struct drm_plane_state *plane_state;
2157 * FIXME: Without plane->crtc set we can't get at the implicit legacy
2158 * acquire context. The real fix will be to wire the acquire ctx through
2159 * everywhere we need it, but meanwhile prevent chaos by just skipping
2160 * this noop. The critical case is the cursor ioctls which a) only grab
2161 * crtc/cursor-plane locks (so we need the crtc to get at the right
2162 * acquire context) and b) can try to disable the plane multiple times.
2167 state = drm_atomic_state_alloc(plane->dev);
2171 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
2173 plane_state = drm_atomic_get_plane_state(state, plane);
2174 if (IS_ERR(plane_state)) {
2175 ret = PTR_ERR(plane_state);
2179 if (plane_state->crtc && (plane == plane->crtc->cursor))
2180 plane_state->state->legacy_cursor_update = true;
2182 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2186 ret = drm_atomic_commit(state);
2188 if (ret == -EDEADLK)
2191 drm_atomic_state_put(state);
2195 drm_atomic_state_clear(state);
2196 drm_atomic_legacy_backoff(state);
2199 * Someone might have exchanged the framebuffer while we dropped locks
2200 * in the backoff code. We need to fix up the fb refcount tracking the
2203 plane->old_fb = plane->fb;
2207 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2209 /* just used from fb-helper and atomic-helper: */
2210 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2211 struct drm_plane_state *plane_state)
2215 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2219 drm_atomic_set_fb_for_plane(plane_state, NULL);
2220 plane_state->crtc_x = 0;
2221 plane_state->crtc_y = 0;
2222 plane_state->crtc_w = 0;
2223 plane_state->crtc_h = 0;
2224 plane_state->src_x = 0;
2225 plane_state->src_y = 0;
2226 plane_state->src_w = 0;
2227 plane_state->src_h = 0;
2232 static int update_output_state(struct drm_atomic_state *state,
2233 struct drm_mode_set *set)
2235 struct drm_device *dev = set->crtc->dev;
2236 struct drm_crtc *crtc;
2237 struct drm_crtc_state *crtc_state;
2238 struct drm_connector *connector;
2239 struct drm_connector_state *conn_state;
2242 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2243 state->acquire_ctx);
2247 /* First disable all connectors on the target crtc. */
2248 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2252 for_each_connector_in_state(state, connector, conn_state, i) {
2253 if (conn_state->crtc == set->crtc) {
2254 ret = drm_atomic_set_crtc_for_connector(conn_state,
2261 /* Then set all connectors from set->connectors on the target crtc */
2262 for (i = 0; i < set->num_connectors; i++) {
2263 conn_state = drm_atomic_get_connector_state(state,
2264 set->connectors[i]);
2265 if (IS_ERR(conn_state))
2266 return PTR_ERR(conn_state);
2268 ret = drm_atomic_set_crtc_for_connector(conn_state,
2274 for_each_crtc_in_state(state, crtc, crtc_state, i) {
2275 /* Don't update ->enable for the CRTC in the set_config request,
2276 * since a mismatch would indicate a bug in the upper layers.
2277 * The actual modeset code later on will catch any
2278 * inconsistencies here. */
2279 if (crtc == set->crtc)
2282 if (!crtc_state->connector_mask) {
2283 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
2288 crtc_state->active = false;
2296 * drm_atomic_helper_set_config - set a new config from userspace
2297 * @set: mode set configuration
2299 * Provides a default crtc set_config handler using the atomic driver interface.
2302 * Returns 0 on success, negative errno numbers on failure.
2304 int drm_atomic_helper_set_config(struct drm_mode_set *set)
2306 struct drm_atomic_state *state;
2307 struct drm_crtc *crtc = set->crtc;
2310 state = drm_atomic_state_alloc(crtc->dev);
2314 state->legacy_set_config = true;
2315 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2317 ret = __drm_atomic_helper_set_config(set, state);
2321 ret = drm_atomic_commit(state);
2323 if (ret == -EDEADLK)
2326 drm_atomic_state_put(state);
2330 drm_atomic_state_clear(state);
2331 drm_atomic_legacy_backoff(state);
2334 * Someone might have exchanged the framebuffer while we dropped locks
2335 * in the backoff code. We need to fix up the fb refcount tracking the
2338 crtc->primary->old_fb = crtc->primary->fb;
2342 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2344 /* just used from fb-helper and atomic-helper: */
2345 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2346 struct drm_atomic_state *state)
2348 struct drm_crtc_state *crtc_state;
2349 struct drm_plane_state *primary_state;
2350 struct drm_crtc *crtc = set->crtc;
2351 int hdisplay, vdisplay;
2354 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2355 if (IS_ERR(crtc_state))
2356 return PTR_ERR(crtc_state);
2358 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2359 if (IS_ERR(primary_state))
2360 return PTR_ERR(primary_state);
2364 WARN_ON(set->num_connectors);
2366 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2370 crtc_state->active = false;
2372 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2376 drm_atomic_set_fb_for_plane(primary_state, NULL);
2382 WARN_ON(!set->num_connectors);
2384 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2388 crtc_state->active = true;
2390 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2394 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2396 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2397 primary_state->crtc_x = 0;
2398 primary_state->crtc_y = 0;
2399 primary_state->crtc_w = hdisplay;
2400 primary_state->crtc_h = vdisplay;
2401 primary_state->src_x = set->x << 16;
2402 primary_state->src_y = set->y << 16;
2403 if (drm_rotation_90_or_270(primary_state->rotation)) {
2404 primary_state->src_w = vdisplay << 16;
2405 primary_state->src_h = hdisplay << 16;
2407 primary_state->src_w = hdisplay << 16;
2408 primary_state->src_h = vdisplay << 16;
2412 ret = update_output_state(state, set);
2420 * drm_atomic_helper_disable_all - disable all currently active outputs
2422 * @ctx: lock acquisition context
2424 * Loops through all connectors, finding those that aren't turned off and then
2425 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2426 * that they are connected to.
2428 * This is used for example in suspend/resume to disable all currently active
2429 * functions when suspending.
2431 * Note that if callers haven't already acquired all modeset locks this might
2432 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2435 * 0 on success or a negative error code on failure.
2438 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2440 int drm_atomic_helper_disable_all(struct drm_device *dev,
2441 struct drm_modeset_acquire_ctx *ctx)
2443 struct drm_atomic_state *state;
2444 struct drm_connector *conn;
2447 state = drm_atomic_state_alloc(dev);
2451 state->acquire_ctx = ctx;
2453 drm_for_each_connector(conn, dev) {
2454 struct drm_crtc *crtc = conn->state->crtc;
2455 struct drm_crtc_state *crtc_state;
2457 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2460 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2461 if (IS_ERR(crtc_state)) {
2462 err = PTR_ERR(crtc_state);
2466 crtc_state->active = false;
2469 err = drm_atomic_commit(state);
2471 drm_atomic_state_put(state);
2474 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2477 * drm_atomic_helper_suspend - subsystem-level suspend helper
2480 * Duplicates the current atomic state, disables all active outputs and then
2481 * returns a pointer to the original atomic state to the caller. Drivers can
2482 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2483 * restore the output configuration that was active at the time the system
2486 * Note that it is potentially unsafe to use this. The atomic state object
2487 * returned by this function is assumed to be persistent. Drivers must ensure
2488 * that this holds true. Before calling this function, drivers must make sure
2489 * to suspend fbdev emulation so that nothing can be using the device.
2492 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2493 * encoded error code on failure. Drivers should store the returned atomic
2494 * state object and pass it to the drm_atomic_helper_resume() helper upon
2498 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2499 * drm_atomic_helper_resume()
2501 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2503 struct drm_modeset_acquire_ctx ctx;
2504 struct drm_atomic_state *state;
2507 drm_modeset_acquire_init(&ctx, 0);
2510 err = drm_modeset_lock_all_ctx(dev, &ctx);
2512 state = ERR_PTR(err);
2516 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2520 err = drm_atomic_helper_disable_all(dev, &ctx);
2522 drm_atomic_state_put(state);
2523 state = ERR_PTR(err);
2528 if (PTR_ERR(state) == -EDEADLK) {
2529 drm_modeset_backoff(&ctx);
2533 drm_modeset_drop_locks(&ctx);
2534 drm_modeset_acquire_fini(&ctx);
2537 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2540 * drm_atomic_helper_resume - subsystem-level resume helper
2542 * @state: atomic state to resume to
2544 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2545 * grabs all modeset locks and commits the atomic state object. This can be
2546 * used in conjunction with the drm_atomic_helper_suspend() helper to
2547 * implement suspend/resume for drivers that support atomic mode-setting.
2550 * 0 on success or a negative error code on failure.
2553 * drm_atomic_helper_suspend()
2555 int drm_atomic_helper_resume(struct drm_device *dev,
2556 struct drm_atomic_state *state)
2558 struct drm_mode_config *config = &dev->mode_config;
2561 drm_mode_config_reset(dev);
2562 drm_modeset_lock_all(dev);
2563 state->acquire_ctx = config->acquire_ctx;
2564 err = drm_atomic_commit(state);
2565 drm_modeset_unlock_all(dev);
2569 EXPORT_SYMBOL(drm_atomic_helper_resume);
2572 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2574 * @property: DRM property
2575 * @val: value of property
2577 * Provides a default crtc set_property handler using the atomic driver
2581 * Zero on success, error code on failure
2584 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2585 struct drm_property *property,
2588 struct drm_atomic_state *state;
2589 struct drm_crtc_state *crtc_state;
2592 state = drm_atomic_state_alloc(crtc->dev);
2596 /* ->set_property is always called with all locks held. */
2597 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2599 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2600 if (IS_ERR(crtc_state)) {
2601 ret = PTR_ERR(crtc_state);
2605 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2610 ret = drm_atomic_commit(state);
2612 if (ret == -EDEADLK)
2615 drm_atomic_state_put(state);
2619 drm_atomic_state_clear(state);
2620 drm_atomic_legacy_backoff(state);
2624 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2627 * drm_atomic_helper_plane_set_property - helper for plane properties
2629 * @property: DRM property
2630 * @val: value of property
2632 * Provides a default plane set_property handler using the atomic driver
2636 * Zero on success, error code on failure
2639 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2640 struct drm_property *property,
2643 struct drm_atomic_state *state;
2644 struct drm_plane_state *plane_state;
2647 state = drm_atomic_state_alloc(plane->dev);
2651 /* ->set_property is always called with all locks held. */
2652 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2654 plane_state = drm_atomic_get_plane_state(state, plane);
2655 if (IS_ERR(plane_state)) {
2656 ret = PTR_ERR(plane_state);
2660 ret = drm_atomic_plane_set_property(plane, plane_state,
2665 ret = drm_atomic_commit(state);
2667 if (ret == -EDEADLK)
2670 drm_atomic_state_put(state);
2674 drm_atomic_state_clear(state);
2675 drm_atomic_legacy_backoff(state);
2679 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2682 * drm_atomic_helper_connector_set_property - helper for connector properties
2683 * @connector: DRM connector
2684 * @property: DRM property
2685 * @val: value of property
2687 * Provides a default connector set_property handler using the atomic driver
2691 * Zero on success, error code on failure
2694 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2695 struct drm_property *property,
2698 struct drm_atomic_state *state;
2699 struct drm_connector_state *connector_state;
2702 state = drm_atomic_state_alloc(connector->dev);
2706 /* ->set_property is always called with all locks held. */
2707 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2709 connector_state = drm_atomic_get_connector_state(state, connector);
2710 if (IS_ERR(connector_state)) {
2711 ret = PTR_ERR(connector_state);
2715 ret = drm_atomic_connector_set_property(connector, connector_state,
2720 ret = drm_atomic_commit(state);
2722 if (ret == -EDEADLK)
2725 drm_atomic_state_put(state);
2729 drm_atomic_state_clear(state);
2730 drm_atomic_legacy_backoff(state);
2734 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2737 * drm_atomic_helper_page_flip - execute a legacy page flip
2739 * @fb: DRM framebuffer
2740 * @event: optional DRM event to signal upon completion
2741 * @flags: flip flags for non-vblank sync'ed updates
2743 * Provides a default page flip implementation using the atomic driver interface.
2745 * Note that for now so called async page flips (i.e. updates which are not
2746 * synchronized to vblank) are not supported, since the atomic interfaces have
2747 * no provisions for this yet.
2750 * Returns 0 on success, negative errno numbers on failure.
2752 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2753 struct drm_framebuffer *fb,
2754 struct drm_pending_vblank_event *event,
2757 struct drm_plane *plane = crtc->primary;
2758 struct drm_atomic_state *state;
2759 struct drm_plane_state *plane_state;
2760 struct drm_crtc_state *crtc_state;
2763 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2766 state = drm_atomic_state_alloc(plane->dev);
2770 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2772 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2773 if (IS_ERR(crtc_state)) {
2774 ret = PTR_ERR(crtc_state);
2777 crtc_state->event = event;
2779 plane_state = drm_atomic_get_plane_state(state, plane);
2780 if (IS_ERR(plane_state)) {
2781 ret = PTR_ERR(plane_state);
2785 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2788 drm_atomic_set_fb_for_plane(plane_state, fb);
2790 /* Make sure we don't accidentally do a full modeset. */
2791 state->allow_modeset = false;
2792 if (!crtc_state->active) {
2793 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2799 ret = drm_atomic_nonblocking_commit(state);
2801 if (ret == -EDEADLK)
2804 drm_atomic_state_put(state);
2808 drm_atomic_state_clear(state);
2809 drm_atomic_legacy_backoff(state);
2812 * Someone might have exchanged the framebuffer while we dropped locks
2813 * in the backoff code. We need to fix up the fb refcount tracking the
2816 plane->old_fb = plane->fb;
2820 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2823 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2824 * @connector: affected connector
2827 * This is the main helper function provided by the atomic helper framework for
2828 * implementing the legacy DPMS connector interface. It computes the new desired
2829 * ->active state for the corresponding CRTC (if the connector is enabled) and
2833 * Returns 0 on success, negative errno numbers on failure.
2835 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2838 struct drm_mode_config *config = &connector->dev->mode_config;
2839 struct drm_atomic_state *state;
2840 struct drm_crtc_state *crtc_state;
2841 struct drm_crtc *crtc;
2842 struct drm_connector *tmp_connector;
2844 bool active = false;
2845 int old_mode = connector->dpms;
2847 if (mode != DRM_MODE_DPMS_ON)
2848 mode = DRM_MODE_DPMS_OFF;
2850 connector->dpms = mode;
2851 crtc = connector->state->crtc;
2856 state = drm_atomic_state_alloc(connector->dev);
2860 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2862 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2863 if (IS_ERR(crtc_state)) {
2864 ret = PTR_ERR(crtc_state);
2868 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2870 drm_for_each_connector(tmp_connector, connector->dev) {
2871 if (tmp_connector->state->crtc != crtc)
2874 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2879 crtc_state->active = active;
2881 ret = drm_atomic_commit(state);
2883 if (ret == -EDEADLK)
2886 connector->dpms = old_mode;
2887 drm_atomic_state_put(state);
2891 drm_atomic_state_clear(state);
2892 drm_atomic_legacy_backoff(state);
2896 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2899 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2900 * ->best_encoder callback
2901 * @connector: Connector control structure
2903 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2904 * connectors that support exactly 1 encoder, statically determined at driver
2907 struct drm_encoder *
2908 drm_atomic_helper_best_encoder(struct drm_connector *connector)
2910 WARN_ON(connector->encoder_ids[1]);
2911 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
2913 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
2916 * DOC: atomic state reset and initialization
2918 * Both the drm core and the atomic helpers assume that there is always the full
2919 * and correct atomic software state for all connectors, CRTCs and planes
2920 * available. Which is a bit a problem on driver load and also after system
2921 * suspend. One way to solve this is to have a hardware state read-out
2922 * infrastructure which reconstructs the full software state (e.g. the i915
2925 * The simpler solution is to just reset the software state to everything off,
2926 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2927 * the atomic helpers provide default reset implementations for all hooks.
2929 * On the upside the precise state tracking of atomic simplifies system suspend
2930 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2931 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2932 * For other drivers the building blocks are split out, see the documentation
2933 * for these functions.
2937 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2940 * Resets the atomic state for @crtc by freeing the state pointer (which might
2941 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2943 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2946 __drm_atomic_helper_crtc_destroy_state(crtc->state);
2949 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2952 crtc->state->crtc = crtc;
2954 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2957 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2958 * @crtc: CRTC object
2959 * @state: atomic CRTC state
2961 * Copies atomic state from a CRTC's current state and resets inferred values.
2962 * This is useful for drivers that subclass the CRTC state.
2964 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2965 struct drm_crtc_state *state)
2967 memcpy(state, crtc->state, sizeof(*state));
2969 if (state->mode_blob)
2970 drm_property_reference_blob(state->mode_blob);
2971 if (state->degamma_lut)
2972 drm_property_reference_blob(state->degamma_lut);
2974 drm_property_reference_blob(state->ctm);
2975 if (state->gamma_lut)
2976 drm_property_reference_blob(state->gamma_lut);
2977 state->mode_changed = false;
2978 state->active_changed = false;
2979 state->planes_changed = false;
2980 state->connectors_changed = false;
2981 state->color_mgmt_changed = false;
2982 state->zpos_changed = false;
2983 state->event = NULL;
2985 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2988 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2991 * Default CRTC state duplicate hook for drivers which don't have their own
2992 * subclassed CRTC state structure.
2994 struct drm_crtc_state *
2995 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2997 struct drm_crtc_state *state;
2999 if (WARN_ON(!crtc->state))
3002 state = kmalloc(sizeof(*state), GFP_KERNEL);
3004 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
3008 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
3011 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3012 * @state: CRTC state object to release
3014 * Releases all resources stored in the CRTC state without actually freeing
3015 * the memory of the CRTC state. This is useful for drivers that subclass the
3018 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
3020 drm_property_unreference_blob(state->mode_blob);
3021 drm_property_unreference_blob(state->degamma_lut);
3022 drm_property_unreference_blob(state->ctm);
3023 drm_property_unreference_blob(state->gamma_lut);
3025 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3028 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3030 * @state: CRTC state object to release
3032 * Default CRTC state destroy hook for drivers which don't have their own
3033 * subclassed CRTC state structure.
3035 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3036 struct drm_crtc_state *state)
3038 __drm_atomic_helper_crtc_destroy_state(state);
3041 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3044 * drm_atomic_helper_plane_reset - default ->reset hook for planes
3047 * Resets the atomic state for @plane by freeing the state pointer (which might
3048 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3050 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3053 __drm_atomic_helper_plane_destroy_state(plane->state);
3055 kfree(plane->state);
3056 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3059 plane->state->plane = plane;
3060 plane->state->rotation = DRM_ROTATE_0;
3063 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3066 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3067 * @plane: plane object
3068 * @state: atomic plane state
3070 * Copies atomic state from a plane's current state. This is useful for
3071 * drivers that subclass the plane state.
3073 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3074 struct drm_plane_state *state)
3076 memcpy(state, plane->state, sizeof(*state));
3079 drm_framebuffer_reference(state->fb);
3081 state->fence = NULL;
3083 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3086 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3089 * Default plane state duplicate hook for drivers which don't have their own
3090 * subclassed plane state structure.
3092 struct drm_plane_state *
3093 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3095 struct drm_plane_state *state;
3097 if (WARN_ON(!plane->state))
3100 state = kmalloc(sizeof(*state), GFP_KERNEL);
3102 __drm_atomic_helper_plane_duplicate_state(plane, state);
3106 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3109 * __drm_atomic_helper_plane_destroy_state - release plane state
3110 * @state: plane state object to release
3112 * Releases all resources stored in the plane state without actually freeing
3113 * the memory of the plane state. This is useful for drivers that subclass the
3116 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3119 drm_framebuffer_unreference(state->fb);
3122 dma_fence_put(state->fence);
3124 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3127 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3129 * @state: plane state object to release
3131 * Default plane state destroy hook for drivers which don't have their own
3132 * subclassed plane state structure.
3134 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3135 struct drm_plane_state *state)
3137 __drm_atomic_helper_plane_destroy_state(state);
3140 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3143 * __drm_atomic_helper_connector_reset - reset state on connector
3144 * @connector: drm connector
3145 * @conn_state: connector state to assign
3147 * Initializes the newly allocated @conn_state and assigns it to
3148 * #connector ->state, usually required when initializing the drivers
3149 * or when called from the ->reset hook.
3151 * This is useful for drivers that subclass the connector state.
3154 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
3155 struct drm_connector_state *conn_state)
3158 conn_state->connector = connector;
3160 connector->state = conn_state;
3162 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3165 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
3166 * @connector: drm connector
3168 * Resets the atomic state for @connector by freeing the state pointer (which
3169 * might be NULL, e.g. at driver load time) and allocating a new empty state
3172 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3174 struct drm_connector_state *conn_state =
3175 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3177 if (connector->state)
3178 __drm_atomic_helper_connector_destroy_state(connector->state);
3180 kfree(connector->state);
3181 __drm_atomic_helper_connector_reset(connector, conn_state);
3183 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3186 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3187 * @connector: connector object
3188 * @state: atomic connector state
3190 * Copies atomic state from a connector's current state. This is useful for
3191 * drivers that subclass the connector state.
3194 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3195 struct drm_connector_state *state)
3197 memcpy(state, connector->state, sizeof(*state));
3199 drm_connector_reference(connector);
3201 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3204 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3205 * @connector: drm connector
3207 * Default connector state duplicate hook for drivers which don't have their own
3208 * subclassed connector state structure.
3210 struct drm_connector_state *
3211 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3213 struct drm_connector_state *state;
3215 if (WARN_ON(!connector->state))
3218 state = kmalloc(sizeof(*state), GFP_KERNEL);
3220 __drm_atomic_helper_connector_duplicate_state(connector, state);
3224 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3227 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3229 * @ctx: lock acquisition context
3231 * Makes a copy of the current atomic state by looping over all objects and
3232 * duplicating their respective states. This is used for example by suspend/
3233 * resume support code to save the state prior to suspend such that it can
3234 * be restored upon resume.
3236 * Note that this treats atomic state as persistent between save and restore.
3237 * Drivers must make sure that this is possible and won't result in confusion
3238 * or erroneous behaviour.
3240 * Note that if callers haven't already acquired all modeset locks this might
3241 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3244 * A pointer to the copy of the atomic state object on success or an
3245 * ERR_PTR()-encoded error code on failure.
3248 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3250 struct drm_atomic_state *
3251 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3252 struct drm_modeset_acquire_ctx *ctx)
3254 struct drm_atomic_state *state;
3255 struct drm_connector *conn;
3256 struct drm_plane *plane;
3257 struct drm_crtc *crtc;
3260 state = drm_atomic_state_alloc(dev);
3262 return ERR_PTR(-ENOMEM);
3264 state->acquire_ctx = ctx;
3266 drm_for_each_crtc(crtc, dev) {
3267 struct drm_crtc_state *crtc_state;
3269 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3270 if (IS_ERR(crtc_state)) {
3271 err = PTR_ERR(crtc_state);
3276 drm_for_each_plane(plane, dev) {
3277 struct drm_plane_state *plane_state;
3279 plane_state = drm_atomic_get_plane_state(state, plane);
3280 if (IS_ERR(plane_state)) {
3281 err = PTR_ERR(plane_state);
3286 drm_for_each_connector(conn, dev) {
3287 struct drm_connector_state *conn_state;
3289 conn_state = drm_atomic_get_connector_state(state, conn);
3290 if (IS_ERR(conn_state)) {
3291 err = PTR_ERR(conn_state);
3296 /* clear the acquire context so that it isn't accidentally reused */
3297 state->acquire_ctx = NULL;
3301 drm_atomic_state_put(state);
3302 state = ERR_PTR(err);
3307 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3310 * __drm_atomic_helper_connector_destroy_state - release connector state
3311 * @state: connector state object to release
3313 * Releases all resources stored in the connector state without actually
3314 * freeing the memory of the connector state. This is useful for drivers that
3315 * subclass the connector state.
3318 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3321 * This is currently a placeholder so that drivers that subclass the
3322 * state will automatically do the right thing if code is ever added
3326 drm_connector_unreference(state->connector);
3328 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3331 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3332 * @connector: drm connector
3333 * @state: connector state object to release
3335 * Default connector state destroy hook for drivers which don't have their own
3336 * subclassed connector state structure.
3338 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3339 struct drm_connector_state *state)
3341 __drm_atomic_helper_connector_destroy_state(state);
3344 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3347 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3348 * @crtc: CRTC object
3349 * @red: red correction table
3350 * @green: green correction table
3351 * @blue: green correction table
3352 * @size: size of the tables
3354 * Implements support for legacy gamma correction table for drivers
3355 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3358 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3359 u16 *red, u16 *green, u16 *blue,
3362 struct drm_device *dev = crtc->dev;
3363 struct drm_mode_config *config = &dev->mode_config;
3364 struct drm_atomic_state *state;
3365 struct drm_crtc_state *crtc_state;
3366 struct drm_property_blob *blob = NULL;
3367 struct drm_color_lut *blob_data;
3370 state = drm_atomic_state_alloc(crtc->dev);
3374 blob = drm_property_create_blob(dev,
3375 sizeof(struct drm_color_lut) * size,
3378 ret = PTR_ERR(blob);
3383 /* Prepare GAMMA_LUT with the legacy values. */
3384 blob_data = (struct drm_color_lut *) blob->data;
3385 for (i = 0; i < size; i++) {
3386 blob_data[i].red = red[i];
3387 blob_data[i].green = green[i];
3388 blob_data[i].blue = blue[i];
3391 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
3393 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3394 if (IS_ERR(crtc_state)) {
3395 ret = PTR_ERR(crtc_state);
3399 /* Reset DEGAMMA_LUT and CTM properties. */
3400 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3401 config->degamma_lut_property, 0);
3405 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3406 config->ctm_property, 0);
3410 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3411 config->gamma_lut_property, blob->base.id);
3415 ret = drm_atomic_commit(state);
3417 if (ret == -EDEADLK)
3420 drm_atomic_state_put(state);
3421 drm_property_unreference_blob(blob);
3425 drm_atomic_state_clear(state);
3426 drm_atomic_legacy_backoff(state);
3430 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);