2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic.h>
30 #include <drm/drm_plane_helper.h>
31 #include <drm/drm_crtc_helper.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <linux/fence.h>
38 * This helper library provides implementations of check and commit functions on
39 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
40 * also provides convenience implementations for the atomic state handling
41 * callbacks for drivers which don't need to subclass the drm core structures to
42 * add their own additional internal state.
44 * This library also provides default implementations for the check callback in
45 * drm_atomic_helper_check() and for the commit callback with
46 * drm_atomic_helper_commit(). But the individual stages and callbacks are
47 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
48 * together with a driver private modeset implementation.
50 * This library also provides implementations for all the legacy driver
51 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
52 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
56 * The atomic helper uses the same function table structures as all other
57 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
58 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
59 * also shares the struct &drm_plane_helper_funcs function table with the plane
63 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
64 struct drm_plane_state *plane_state,
65 struct drm_plane *plane)
67 struct drm_crtc_state *crtc_state;
69 if (plane->state->crtc) {
70 crtc_state = drm_atomic_get_existing_crtc_state(state,
73 if (WARN_ON(!crtc_state))
76 crtc_state->planes_changed = true;
79 if (plane_state->crtc) {
80 crtc_state = drm_atomic_get_existing_crtc_state(state,
83 if (WARN_ON(!crtc_state))
86 crtc_state->planes_changed = true;
90 static int handle_conflicting_encoders(struct drm_atomic_state *state,
91 bool disable_conflicting_encoders)
93 struct drm_connector_state *conn_state;
94 struct drm_connector *connector;
95 struct drm_encoder *encoder;
96 unsigned encoder_mask = 0;
100 * First loop, find all newly assigned encoders from the connectors
101 * part of the state. If the same encoder is assigned to multiple
102 * connectors bail out.
104 for_each_connector_in_state(state, connector, conn_state, i) {
105 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
106 struct drm_encoder *new_encoder;
108 if (!conn_state->crtc)
111 if (funcs->atomic_best_encoder)
112 new_encoder = funcs->atomic_best_encoder(connector, conn_state);
114 new_encoder = funcs->best_encoder(connector);
117 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
118 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
119 new_encoder->base.id, new_encoder->name,
120 connector->base.id, connector->name);
125 encoder_mask |= 1 << drm_encoder_index(new_encoder);
133 * Second loop, iterate over all connectors not part of the state.
135 * If a conflicting encoder is found and disable_conflicting_encoders
136 * is not set, an error is returned. Userspace can provide a solution
137 * through the atomic ioctl.
139 * If the flag is set conflicting connectors are removed from the crtc
140 * and the crtc is disabled if no encoder is left. This preserves
141 * compatibility with the legacy set_config behavior.
143 drm_for_each_connector(connector, state->dev) {
144 struct drm_crtc_state *crtc_state;
146 if (drm_atomic_get_existing_connector_state(state, connector))
149 encoder = connector->state->best_encoder;
150 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
153 if (!disable_conflicting_encoders) {
154 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
155 encoder->base.id, encoder->name,
156 connector->state->crtc->base.id,
157 connector->state->crtc->name,
158 connector->base.id, connector->name);
162 conn_state = drm_atomic_get_connector_state(state, connector);
163 if (IS_ERR(conn_state))
164 return PTR_ERR(conn_state);
166 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
167 encoder->base.id, encoder->name,
168 conn_state->crtc->base.id, conn_state->crtc->name,
169 connector->base.id, connector->name);
171 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
173 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
177 if (!crtc_state->connector_mask) {
178 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
183 crtc_state->active = false;
191 set_best_encoder(struct drm_atomic_state *state,
192 struct drm_connector_state *conn_state,
193 struct drm_encoder *encoder)
195 struct drm_crtc_state *crtc_state;
196 struct drm_crtc *crtc;
198 if (conn_state->best_encoder) {
199 /* Unset the encoder_mask in the old crtc state. */
200 crtc = conn_state->connector->state->crtc;
202 /* A NULL crtc is an error here because we should have
203 * duplicated a NULL best_encoder when crtc was NULL.
204 * As an exception restoring duplicated atomic state
205 * during resume is allowed, so don't warn when
206 * best_encoder is equal to encoder we intend to set.
208 WARN_ON(!crtc && encoder != conn_state->best_encoder);
210 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
212 crtc_state->encoder_mask &=
213 ~(1 << drm_encoder_index(conn_state->best_encoder));
218 crtc = conn_state->crtc;
221 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
223 crtc_state->encoder_mask |=
224 1 << drm_encoder_index(encoder);
228 conn_state->best_encoder = encoder;
232 steal_encoder(struct drm_atomic_state *state,
233 struct drm_encoder *encoder)
235 struct drm_crtc_state *crtc_state;
236 struct drm_connector *connector;
237 struct drm_connector_state *connector_state;
240 for_each_connector_in_state(state, connector, connector_state, i) {
241 struct drm_crtc *encoder_crtc;
243 if (connector_state->best_encoder != encoder)
246 encoder_crtc = connector->state->crtc;
248 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
249 encoder->base.id, encoder->name,
250 encoder_crtc->base.id, encoder_crtc->name);
252 set_best_encoder(state, connector_state, NULL);
254 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
255 crtc_state->connectors_changed = true;
262 update_connector_routing(struct drm_atomic_state *state,
263 struct drm_connector *connector,
264 struct drm_connector_state *connector_state)
266 const struct drm_connector_helper_funcs *funcs;
267 struct drm_encoder *new_encoder;
268 struct drm_crtc_state *crtc_state;
270 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
274 if (connector->state->crtc != connector_state->crtc) {
275 if (connector->state->crtc) {
276 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
277 crtc_state->connectors_changed = true;
280 if (connector_state->crtc) {
281 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
282 crtc_state->connectors_changed = true;
286 if (!connector_state->crtc) {
287 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
291 set_best_encoder(state, connector_state, NULL);
296 funcs = connector->helper_private;
298 if (funcs->atomic_best_encoder)
299 new_encoder = funcs->atomic_best_encoder(connector,
302 new_encoder = funcs->best_encoder(connector);
305 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
311 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
312 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
313 new_encoder->base.id,
315 connector_state->crtc->base.id);
319 if (new_encoder == connector_state->best_encoder) {
320 set_best_encoder(state, connector_state, new_encoder);
322 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
325 new_encoder->base.id,
327 connector_state->crtc->base.id,
328 connector_state->crtc->name);
333 steal_encoder(state, new_encoder);
335 set_best_encoder(state, connector_state, new_encoder);
337 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
338 crtc_state->connectors_changed = true;
340 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
343 new_encoder->base.id,
345 connector_state->crtc->base.id,
346 connector_state->crtc->name);
352 mode_fixup(struct drm_atomic_state *state)
354 struct drm_crtc *crtc;
355 struct drm_crtc_state *crtc_state;
356 struct drm_connector *connector;
357 struct drm_connector_state *conn_state;
361 for_each_crtc_in_state(state, crtc, crtc_state, i) {
362 if (!crtc_state->mode_changed &&
363 !crtc_state->connectors_changed)
366 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
369 for_each_connector_in_state(state, connector, conn_state, i) {
370 const struct drm_encoder_helper_funcs *funcs;
371 struct drm_encoder *encoder;
373 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
375 if (!conn_state->crtc || !conn_state->best_encoder)
378 crtc_state = drm_atomic_get_existing_crtc_state(state,
382 * Each encoder has at most one connector (since we always steal
383 * it away), so we won't call ->mode_fixup twice.
385 encoder = conn_state->best_encoder;
386 funcs = encoder->helper_private;
390 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
391 &crtc_state->adjusted_mode);
393 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
397 if (funcs->atomic_check) {
398 ret = funcs->atomic_check(encoder, crtc_state,
401 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
402 encoder->base.id, encoder->name);
405 } else if (funcs->mode_fixup) {
406 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
407 &crtc_state->adjusted_mode);
409 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
410 encoder->base.id, encoder->name);
416 for_each_crtc_in_state(state, crtc, crtc_state, i) {
417 const struct drm_crtc_helper_funcs *funcs;
419 if (!crtc_state->mode_changed &&
420 !crtc_state->connectors_changed)
423 funcs = crtc->helper_private;
424 if (!funcs->mode_fixup)
427 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
428 &crtc_state->adjusted_mode);
430 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
431 crtc->base.id, crtc->name);
440 * drm_atomic_helper_check_modeset - validate state object for modeset changes
442 * @state: the driver state object
444 * Check the state object to see if the requested state is physically possible.
445 * This does all the crtc and connector related computations for an atomic
446 * update and adds any additional connectors needed for full modesets and calls
447 * down into ->mode_fixup functions of the driver backend.
449 * crtc_state->mode_changed is set when the input mode is changed.
450 * crtc_state->connectors_changed is set when a connector is added or
451 * removed from the crtc.
452 * crtc_state->active_changed is set when crtc_state->active changes,
453 * which is used for dpms.
457 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
458 * plane update can't be done without a full modeset) _must_ call this function
459 * afterwards after that change. It is permitted to call this function multiple
460 * times for the same update, e.g. when the ->atomic_check functions depend upon
461 * the adjusted dotclock for fifo space allocation and watermark computation.
464 * Zero for success or -errno
467 drm_atomic_helper_check_modeset(struct drm_device *dev,
468 struct drm_atomic_state *state)
470 struct drm_crtc *crtc;
471 struct drm_crtc_state *crtc_state;
472 struct drm_connector *connector;
473 struct drm_connector_state *connector_state;
476 for_each_crtc_in_state(state, crtc, crtc_state, i) {
477 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
478 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
479 crtc->base.id, crtc->name);
480 crtc_state->mode_changed = true;
483 if (crtc->state->enable != crtc_state->enable) {
484 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
485 crtc->base.id, crtc->name);
488 * For clarity this assignment is done here, but
489 * enable == 0 is only true when there are no
490 * connectors and a NULL mode.
492 * The other way around is true as well. enable != 0
493 * iff connectors are attached and a mode is set.
495 crtc_state->mode_changed = true;
496 crtc_state->connectors_changed = true;
500 ret = handle_conflicting_encoders(state, state->legacy_set_config);
504 for_each_connector_in_state(state, connector, connector_state, i) {
506 * This only sets crtc->mode_changed for routing changes,
507 * drivers must set crtc->mode_changed themselves when connector
508 * properties need to be updated.
510 ret = update_connector_routing(state, connector,
517 * After all the routing has been prepared we need to add in any
518 * connector which is itself unchanged, but who's crtc changes it's
519 * configuration. This must be done before calling mode_fixup in case a
520 * crtc only changed its mode but has the same set of connectors.
522 for_each_crtc_in_state(state, crtc, crtc_state, i) {
523 bool has_connectors =
524 !!crtc_state->connector_mask;
527 * We must set ->active_changed after walking connectors for
528 * otherwise an update that only changes active would result in
529 * a full modeset because update_connector_routing force that.
531 if (crtc->state->active != crtc_state->active) {
532 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
533 crtc->base.id, crtc->name);
534 crtc_state->active_changed = true;
537 if (!drm_atomic_crtc_needs_modeset(crtc_state))
540 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
541 crtc->base.id, crtc->name,
542 crtc_state->enable ? 'y' : 'n',
543 crtc_state->active ? 'y' : 'n');
545 ret = drm_atomic_add_affected_connectors(state, crtc);
549 ret = drm_atomic_add_affected_planes(state, crtc);
553 if (crtc_state->enable != has_connectors) {
554 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
555 crtc->base.id, crtc->name);
561 return mode_fixup(state);
563 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
566 * drm_atomic_helper_check_planes - validate state object for planes changes
568 * @state: the driver state object
570 * Check the state object to see if the requested state is physically possible.
571 * This does all the plane update related checks using by calling into the
572 * ->atomic_check hooks provided by the driver.
574 * It also sets crtc_state->planes_changed to indicate that a crtc has
578 * Zero for success or -errno
581 drm_atomic_helper_check_planes(struct drm_device *dev,
582 struct drm_atomic_state *state)
584 struct drm_crtc *crtc;
585 struct drm_crtc_state *crtc_state;
586 struct drm_plane *plane;
587 struct drm_plane_state *plane_state;
590 for_each_plane_in_state(state, plane, plane_state, i) {
591 const struct drm_plane_helper_funcs *funcs;
593 funcs = plane->helper_private;
595 drm_atomic_helper_plane_changed(state, plane_state, plane);
597 if (!funcs || !funcs->atomic_check)
600 ret = funcs->atomic_check(plane, plane_state);
602 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
603 plane->base.id, plane->name);
608 for_each_crtc_in_state(state, crtc, crtc_state, i) {
609 const struct drm_crtc_helper_funcs *funcs;
611 funcs = crtc->helper_private;
613 if (!funcs || !funcs->atomic_check)
616 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
618 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
619 crtc->base.id, crtc->name);
626 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
629 * drm_atomic_helper_check - validate state object
631 * @state: the driver state object
633 * Check the state object to see if the requested state is physically possible.
634 * Only crtcs and planes have check callbacks, so for any additional (global)
635 * checking that a driver needs it can simply wrap that around this function.
636 * Drivers without such needs can directly use this as their ->atomic_check()
639 * This just wraps the two parts of the state checking for planes and modeset
640 * state in the default order: First it calls drm_atomic_helper_check_modeset()
641 * and then drm_atomic_helper_check_planes(). The assumption is that the
642 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
643 * e.g. properly compute watermarks.
646 * Zero for success or -errno
648 int drm_atomic_helper_check(struct drm_device *dev,
649 struct drm_atomic_state *state)
653 ret = drm_atomic_helper_check_modeset(dev, state);
657 ret = drm_atomic_helper_check_planes(dev, state);
663 EXPORT_SYMBOL(drm_atomic_helper_check);
666 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
668 struct drm_connector *connector;
669 struct drm_connector_state *old_conn_state;
670 struct drm_crtc *crtc;
671 struct drm_crtc_state *old_crtc_state;
674 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
675 const struct drm_encoder_helper_funcs *funcs;
676 struct drm_encoder *encoder;
678 /* Shut down everything that's in the changeset and currently
679 * still on. So need to check the old, saved state. */
680 if (!old_conn_state->crtc)
683 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
684 old_conn_state->crtc);
686 if (!old_crtc_state->active ||
687 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
690 encoder = old_conn_state->best_encoder;
692 /* We shouldn't get this far if we didn't previously have
693 * an encoder.. but WARN_ON() rather than explode.
695 if (WARN_ON(!encoder))
698 funcs = encoder->helper_private;
702 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
703 encoder->base.id, encoder->name);
706 * Each encoder has at most one connector (since we always steal
707 * it away), so we won't call disable hooks twice.
709 drm_bridge_disable(encoder->bridge);
711 /* Right function depends upon target state. */
712 if (connector->state->crtc && funcs->prepare)
713 funcs->prepare(encoder);
714 else if (funcs->disable)
715 funcs->disable(encoder);
716 else if (funcs->dpms)
717 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
719 drm_bridge_post_disable(encoder->bridge);
722 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
723 const struct drm_crtc_helper_funcs *funcs;
725 /* Shut down everything that needs a full modeset. */
726 if (!drm_atomic_crtc_needs_modeset(crtc->state))
729 if (!old_crtc_state->active)
732 funcs = crtc->helper_private;
734 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
735 crtc->base.id, crtc->name);
738 /* Right function depends upon target state. */
739 if (crtc->state->enable && funcs->prepare)
740 funcs->prepare(crtc);
741 else if (funcs->disable)
742 funcs->disable(crtc);
744 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
749 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
751 * @old_state: atomic state object with old state structures
753 * This function updates all the various legacy modeset state pointers in
754 * connectors, encoders and crtcs. It also updates the timestamping constants
755 * used for precise vblank timestamps by calling
756 * drm_calc_timestamping_constants().
758 * Drivers can use this for building their own atomic commit if they don't have
759 * a pure helper-based modeset implementation.
762 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
763 struct drm_atomic_state *old_state)
765 struct drm_connector *connector;
766 struct drm_connector_state *old_conn_state;
767 struct drm_crtc *crtc;
768 struct drm_crtc_state *old_crtc_state;
771 /* clear out existing links and update dpms */
772 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
773 if (connector->encoder) {
774 WARN_ON(!connector->encoder->crtc);
776 connector->encoder->crtc = NULL;
777 connector->encoder = NULL;
780 crtc = connector->state->crtc;
781 if ((!crtc && old_conn_state->crtc) ||
782 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
783 struct drm_property *dpms_prop =
784 dev->mode_config.dpms_property;
785 int mode = DRM_MODE_DPMS_OFF;
787 if (crtc && crtc->state->active)
788 mode = DRM_MODE_DPMS_ON;
790 connector->dpms = mode;
791 drm_object_property_set_value(&connector->base,
797 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
798 if (!connector->state->crtc)
801 if (WARN_ON(!connector->state->best_encoder))
804 connector->encoder = connector->state->best_encoder;
805 connector->encoder->crtc = connector->state->crtc;
808 /* set legacy state in the crtc structure */
809 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
810 struct drm_plane *primary = crtc->primary;
812 crtc->mode = crtc->state->mode;
813 crtc->enabled = crtc->state->enable;
815 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
816 primary->state->crtc == crtc) {
817 crtc->x = primary->state->src_x >> 16;
818 crtc->y = primary->state->src_y >> 16;
821 if (crtc->state->enable)
822 drm_calc_timestamping_constants(crtc,
823 &crtc->state->adjusted_mode);
826 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
829 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
831 struct drm_crtc *crtc;
832 struct drm_crtc_state *old_crtc_state;
833 struct drm_connector *connector;
834 struct drm_connector_state *old_conn_state;
837 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
838 const struct drm_crtc_helper_funcs *funcs;
840 if (!crtc->state->mode_changed)
843 funcs = crtc->helper_private;
845 if (crtc->state->enable && funcs->mode_set_nofb) {
846 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
847 crtc->base.id, crtc->name);
849 funcs->mode_set_nofb(crtc);
853 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
854 const struct drm_encoder_helper_funcs *funcs;
855 struct drm_crtc_state *new_crtc_state;
856 struct drm_encoder *encoder;
857 struct drm_display_mode *mode, *adjusted_mode;
859 if (!connector->state->best_encoder)
862 encoder = connector->state->best_encoder;
863 funcs = encoder->helper_private;
867 new_crtc_state = connector->state->crtc->state;
868 mode = &new_crtc_state->mode;
869 adjusted_mode = &new_crtc_state->adjusted_mode;
871 if (!new_crtc_state->mode_changed)
874 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
875 encoder->base.id, encoder->name);
878 * Each encoder has at most one connector (since we always steal
879 * it away), so we won't call mode_set hooks twice.
882 funcs->mode_set(encoder, mode, adjusted_mode);
884 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
889 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
891 * @old_state: atomic state object with old state structures
893 * This function shuts down all the outputs that need to be shut down and
894 * prepares them (if required) with the new mode.
896 * For compatibility with legacy crtc helpers this should be called before
897 * drm_atomic_helper_commit_planes(), which is what the default commit function
898 * does. But drivers with different needs can group the modeset commits together
899 * and do the plane commits at the end. This is useful for drivers doing runtime
900 * PM since planes updates then only happen when the CRTC is actually enabled.
902 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
903 struct drm_atomic_state *old_state)
905 disable_outputs(dev, old_state);
907 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
909 crtc_set_mode(dev, old_state);
911 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
914 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
916 * @old_state: atomic state object with old state structures
918 * This function enables all the outputs with the new configuration which had to
919 * be turned off for the update.
921 * For compatibility with legacy crtc helpers this should be called after
922 * drm_atomic_helper_commit_planes(), which is what the default commit function
923 * does. But drivers with different needs can group the modeset commits together
924 * and do the plane commits at the end. This is useful for drivers doing runtime
925 * PM since planes updates then only happen when the CRTC is actually enabled.
927 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
928 struct drm_atomic_state *old_state)
930 struct drm_crtc *crtc;
931 struct drm_crtc_state *old_crtc_state;
932 struct drm_connector *connector;
933 struct drm_connector_state *old_conn_state;
936 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
937 const struct drm_crtc_helper_funcs *funcs;
939 /* Need to filter out CRTCs where only planes change. */
940 if (!drm_atomic_crtc_needs_modeset(crtc->state))
943 if (!crtc->state->active)
946 funcs = crtc->helper_private;
948 if (crtc->state->enable) {
949 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
950 crtc->base.id, crtc->name);
959 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
960 const struct drm_encoder_helper_funcs *funcs;
961 struct drm_encoder *encoder;
963 if (!connector->state->best_encoder)
966 if (!connector->state->crtc->state->active ||
967 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
970 encoder = connector->state->best_encoder;
971 funcs = encoder->helper_private;
975 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
976 encoder->base.id, encoder->name);
979 * Each encoder has at most one connector (since we always steal
980 * it away), so we won't call enable hooks twice.
982 drm_bridge_pre_enable(encoder->bridge);
985 funcs->enable(encoder);
986 else if (funcs->commit)
987 funcs->commit(encoder);
989 drm_bridge_enable(encoder->bridge);
992 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
995 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
997 * @state: atomic state object with old state structures
999 * For implicit sync, driver should fish the exclusive fence out from the
1000 * incoming fb's and stash it in the drm_plane_state. This is called after
1001 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1002 * just uses the atomic state to find the changed planes)
1004 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1005 struct drm_atomic_state *state)
1007 struct drm_plane *plane;
1008 struct drm_plane_state *plane_state;
1011 for_each_plane_in_state(state, plane, plane_state, i) {
1012 if (!plane->state->fence)
1015 WARN_ON(!plane->state->fb);
1017 fence_wait(plane->state->fence, false);
1018 fence_put(plane->state->fence);
1019 plane->state->fence = NULL;
1022 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1025 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1027 * @old_state: atomic state object with old state structures
1030 * Checks whether the framebuffer used for this CRTC changes as a result of
1031 * the atomic update. This is useful for drivers which cannot use
1032 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1036 * true if the framebuffer changed.
1038 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1039 struct drm_atomic_state *old_state,
1040 struct drm_crtc *crtc)
1042 struct drm_plane *plane;
1043 struct drm_plane_state *old_plane_state;
1046 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1047 if (plane->state->crtc != crtc &&
1048 old_plane_state->crtc != crtc)
1051 if (plane->state->fb != old_plane_state->fb)
1057 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1060 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1062 * @old_state: atomic state object with old state structures
1064 * Helper to, after atomic commit, wait for vblanks on all effected
1065 * crtcs (ie. before cleaning up old framebuffers using
1066 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1067 * framebuffers have actually changed to optimize for the legacy cursor and
1068 * plane update use-case.
1071 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1072 struct drm_atomic_state *old_state)
1074 struct drm_crtc *crtc;
1075 struct drm_crtc_state *old_crtc_state;
1078 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1079 /* No one cares about the old state, so abuse it for tracking
1080 * and store whether we hold a vblank reference (and should do a
1081 * vblank wait) in the ->enable boolean. */
1082 old_crtc_state->enable = false;
1084 if (!crtc->state->enable)
1087 /* Legacy cursor ioctls are completely unsynced, and userspace
1088 * relies on that (by doing tons of cursor updates). */
1089 if (old_state->legacy_cursor_update)
1092 if (!drm_atomic_helper_framebuffer_changed(dev,
1096 ret = drm_crtc_vblank_get(crtc);
1100 old_crtc_state->enable = true;
1101 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1104 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1105 if (!old_crtc_state->enable)
1108 ret = wait_event_timeout(dev->vblank[i].queue,
1109 old_crtc_state->last_vblank_count !=
1110 drm_crtc_vblank_count(crtc),
1111 msecs_to_jiffies(50));
1113 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1115 drm_crtc_vblank_put(crtc);
1118 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1121 * drm_atomic_helper_commit - commit validated state object
1123 * @state: the driver state object
1124 * @nonblocking: whether nonblocking behavior is requested.
1126 * This function commits a with drm_atomic_helper_check() pre-validated state
1127 * object. This can still fail when e.g. the framebuffer reservation fails. For
1128 * now this doesn't implement nonblocking commits.
1130 * Note that right now this function does not support nonblocking commits, hence
1131 * driver writers must implement their own version for now. Also note that the
1132 * default ordering of how the various stages are called is to match the legacy
1133 * modeset helper library closest. One peculiarity of that is that it doesn't
1134 * mesh well with runtime PM at all.
1136 * For drivers supporting runtime PM the recommended sequence is
1138 * drm_atomic_helper_commit_modeset_disables(dev, state);
1140 * drm_atomic_helper_commit_modeset_enables(dev, state);
1142 * drm_atomic_helper_commit_planes(dev, state, true);
1144 * See the kerneldoc entries for these three functions for more details.
1147 * Zero for success or -errno.
1149 int drm_atomic_helper_commit(struct drm_device *dev,
1150 struct drm_atomic_state *state,
1158 ret = drm_atomic_helper_prepare_planes(dev, state);
1163 * This is the point of no return - everything below never fails except
1164 * when the hw goes bonghits. Which means we can commit the new state on
1165 * the software side now.
1168 drm_atomic_helper_swap_state(dev, state);
1171 * Everything below can be run asynchronously without the need to grab
1172 * any modeset locks at all under one condition: It must be guaranteed
1173 * that the asynchronous work has either been cancelled (if the driver
1174 * supports it, which at least requires that the framebuffers get
1175 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1176 * before the new state gets committed on the software side with
1177 * drm_atomic_helper_swap_state().
1179 * This scheme allows new atomic state updates to be prepared and
1180 * checked in parallel to the asynchronous completion of the previous
1181 * update. Which is important since compositors need to figure out the
1182 * composition of the next frame right after having submitted the
1186 drm_atomic_helper_wait_for_fences(dev, state);
1188 drm_atomic_helper_commit_modeset_disables(dev, state);
1190 drm_atomic_helper_commit_planes(dev, state, false);
1192 drm_atomic_helper_commit_modeset_enables(dev, state);
1194 drm_atomic_helper_wait_for_vblanks(dev, state);
1196 drm_atomic_helper_cleanup_planes(dev, state);
1198 drm_atomic_state_free(state);
1202 EXPORT_SYMBOL(drm_atomic_helper_commit);
1205 * DOC: implementing nonblocking commit
1207 * For now the atomic helpers don't support nonblocking commit directly. If
1208 * there is real need it could be added though, using the dma-buf fence
1209 * infrastructure for generic synchronization with outstanding rendering.
1211 * For now drivers have to implement nonblocking commit themselves, with the
1212 * following sequence being the recommended one:
1214 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1215 * which commit needs to call which can fail, so we want to run it first and
1218 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1219 * might be affected the new state update. This can be done by either cancelling
1220 * or flushing the work items, depending upon whether the driver can deal with
1221 * cancelled updates. Note that it is important to ensure that the framebuffer
1222 * cleanup is still done when cancelling.
1224 * For sufficient parallelism it is recommended to have a work item per crtc
1225 * (for updates which don't touch global state) and a global one. Then we only
1226 * need to synchronize with the crtc work items for changed crtcs and the global
1227 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1229 * 3. The software state is updated synchronously with
1230 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1231 * locks means concurrent callers never see inconsistent state. And doing this
1232 * while it's guaranteed that no relevant nonblocking worker runs means that
1233 * nonblocking workers do not need grab any locks. Actually they must not grab
1234 * locks, for otherwise the work flushing will deadlock.
1236 * 4. Schedule a work item to do all subsequent steps, using the split-out
1237 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1238 * then cleaning up the framebuffers after the old framebuffer is no longer
1243 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1245 * @state: atomic state object with new state structures
1247 * This function prepares plane state, specifically framebuffers, for the new
1248 * configuration. If any failure is encountered this function will call
1249 * ->cleanup_fb on any already successfully prepared framebuffer.
1252 * 0 on success, negative error code on failure.
1254 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1255 struct drm_atomic_state *state)
1257 int nplanes = dev->mode_config.num_total_plane;
1260 for (i = 0; i < nplanes; i++) {
1261 const struct drm_plane_helper_funcs *funcs;
1262 struct drm_plane *plane = state->planes[i];
1263 struct drm_plane_state *plane_state = state->plane_states[i];
1268 funcs = plane->helper_private;
1270 if (funcs->prepare_fb) {
1271 ret = funcs->prepare_fb(plane, plane_state);
1280 for (i--; i >= 0; i--) {
1281 const struct drm_plane_helper_funcs *funcs;
1282 struct drm_plane *plane = state->planes[i];
1283 struct drm_plane_state *plane_state = state->plane_states[i];
1288 funcs = plane->helper_private;
1290 if (funcs->cleanup_fb)
1291 funcs->cleanup_fb(plane, plane_state);
1297 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1299 bool plane_crtc_active(struct drm_plane_state *state)
1301 return state->crtc && state->crtc->state->active;
1305 * drm_atomic_helper_commit_planes - commit plane state
1307 * @old_state: atomic state object with old state structures
1308 * @active_only: Only commit on active CRTC if set
1310 * This function commits the new plane state using the plane and atomic helper
1311 * functions for planes and crtcs. It assumes that the atomic state has already
1312 * been pushed into the relevant object state pointers, since this step can no
1315 * It still requires the global state object @old_state to know which planes and
1316 * crtcs need to be updated though.
1318 * Note that this function does all plane updates across all CRTCs in one step.
1319 * If the hardware can't support this approach look at
1320 * drm_atomic_helper_commit_planes_on_crtc() instead.
1322 * Plane parameters can be updated by applications while the associated CRTC is
1323 * disabled. The DRM/KMS core will store the parameters in the plane state,
1324 * which will be available to the driver when the CRTC is turned on. As a result
1325 * most drivers don't need to be immediately notified of plane updates for a
1328 * Unless otherwise needed, drivers are advised to set the @active_only
1329 * parameters to true in order not to receive plane update notifications related
1330 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1331 * driver code when the driver and/or hardware can't or just don't need to deal
1332 * with updates on disabled CRTCs, for example when supporting runtime PM.
1334 * The drm_atomic_helper_commit() default implementation only sets @active_only
1335 * to false to most closely match the behaviour of the legacy helpers. This should
1336 * not be copied blindly by drivers.
1338 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1339 struct drm_atomic_state *old_state,
1342 struct drm_crtc *crtc;
1343 struct drm_crtc_state *old_crtc_state;
1344 struct drm_plane *plane;
1345 struct drm_plane_state *old_plane_state;
1348 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1349 const struct drm_crtc_helper_funcs *funcs;
1351 funcs = crtc->helper_private;
1353 if (!funcs || !funcs->atomic_begin)
1356 if (active_only && !crtc->state->active)
1359 funcs->atomic_begin(crtc, old_crtc_state);
1362 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1363 const struct drm_plane_helper_funcs *funcs;
1366 funcs = plane->helper_private;
1371 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1375 * Skip planes related to inactive CRTCs. If the plane
1376 * is enabled use the state of the current CRTC. If the
1377 * plane is being disabled use the state of the old
1378 * CRTC to avoid skipping planes being disabled on an
1381 if (!disabling && !plane_crtc_active(plane->state))
1383 if (disabling && !plane_crtc_active(old_plane_state))
1388 * Special-case disabling the plane if drivers support it.
1390 if (disabling && funcs->atomic_disable)
1391 funcs->atomic_disable(plane, old_plane_state);
1392 else if (plane->state->crtc || disabling)
1393 funcs->atomic_update(plane, old_plane_state);
1396 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1397 const struct drm_crtc_helper_funcs *funcs;
1399 funcs = crtc->helper_private;
1401 if (!funcs || !funcs->atomic_flush)
1404 if (active_only && !crtc->state->active)
1407 funcs->atomic_flush(crtc, old_crtc_state);
1410 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1413 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1414 * @old_crtc_state: atomic state object with the old crtc state
1416 * This function commits the new plane state using the plane and atomic helper
1417 * functions for planes on the specific crtc. It assumes that the atomic state
1418 * has already been pushed into the relevant object state pointers, since this
1419 * step can no longer fail.
1421 * This function is useful when plane updates should be done crtc-by-crtc
1422 * instead of one global step like drm_atomic_helper_commit_planes() does.
1424 * This function can only be savely used when planes are not allowed to move
1425 * between different CRTCs because this function doesn't handle inter-CRTC
1426 * depencies. Callers need to ensure that either no such depencies exist,
1427 * resolve them through ordering of commit calls or through some other means.
1430 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1432 const struct drm_crtc_helper_funcs *crtc_funcs;
1433 struct drm_crtc *crtc = old_crtc_state->crtc;
1434 struct drm_atomic_state *old_state = old_crtc_state->state;
1435 struct drm_plane *plane;
1436 unsigned plane_mask;
1438 plane_mask = old_crtc_state->plane_mask;
1439 plane_mask |= crtc->state->plane_mask;
1441 crtc_funcs = crtc->helper_private;
1442 if (crtc_funcs && crtc_funcs->atomic_begin)
1443 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1445 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1446 struct drm_plane_state *old_plane_state =
1447 drm_atomic_get_existing_plane_state(old_state, plane);
1448 const struct drm_plane_helper_funcs *plane_funcs;
1450 plane_funcs = plane->helper_private;
1452 if (!old_plane_state || !plane_funcs)
1455 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1457 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1458 plane_funcs->atomic_disable)
1459 plane_funcs->atomic_disable(plane, old_plane_state);
1460 else if (plane->state->crtc ||
1461 drm_atomic_plane_disabling(plane, old_plane_state))
1462 plane_funcs->atomic_update(plane, old_plane_state);
1465 if (crtc_funcs && crtc_funcs->atomic_flush)
1466 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1468 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1471 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1473 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1475 * Disables all planes associated with the given CRTC. This can be
1476 * used for instance in the CRTC helper disable callback to disable
1477 * all planes before shutting down the display pipeline.
1479 * If the atomic-parameter is set the function calls the CRTC's
1480 * atomic_begin hook before and atomic_flush hook after disabling the
1483 * It is a bug to call this function without having implemented the
1484 * ->atomic_disable() plane hook.
1486 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1489 const struct drm_crtc_helper_funcs *crtc_funcs =
1490 crtc->helper_private;
1491 struct drm_plane *plane;
1493 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1494 crtc_funcs->atomic_begin(crtc, NULL);
1496 drm_for_each_plane(plane, crtc->dev) {
1497 const struct drm_plane_helper_funcs *plane_funcs =
1498 plane->helper_private;
1500 if (plane->state->crtc != crtc || !plane_funcs)
1503 WARN_ON(!plane_funcs->atomic_disable);
1504 if (plane_funcs->atomic_disable)
1505 plane_funcs->atomic_disable(plane, NULL);
1508 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1509 crtc_funcs->atomic_flush(crtc, NULL);
1511 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1514 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1516 * @old_state: atomic state object with old state structures
1518 * This function cleans up plane state, specifically framebuffers, from the old
1519 * configuration. Hence the old configuration must be perserved in @old_state to
1520 * be able to call this function.
1522 * This function must also be called on the new state when the atomic update
1523 * fails at any point after calling drm_atomic_helper_prepare_planes().
1525 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1526 struct drm_atomic_state *old_state)
1528 struct drm_plane *plane;
1529 struct drm_plane_state *plane_state;
1532 for_each_plane_in_state(old_state, plane, plane_state, i) {
1533 const struct drm_plane_helper_funcs *funcs;
1535 funcs = plane->helper_private;
1537 if (funcs->cleanup_fb)
1538 funcs->cleanup_fb(plane, plane_state);
1541 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1544 * drm_atomic_helper_swap_state - store atomic state into current sw state
1546 * @state: atomic state
1548 * This function stores the atomic state into the current state pointers in all
1549 * driver objects. It should be called after all failing steps have been done
1550 * and succeeded, but before the actual hardware state is committed.
1552 * For cleanup and error recovery the current state for all changed objects will
1553 * be swaped into @state.
1555 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1557 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1559 * 2. Do any other steps that might fail.
1561 * 3. Put the staged state into the current state pointers with this function.
1563 * 4. Actually commit the hardware state.
1565 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1566 * contains the old state. Also do any other cleanup required with that state.
1568 void drm_atomic_helper_swap_state(struct drm_device *dev,
1569 struct drm_atomic_state *state)
1573 for (i = 0; i < state->num_connector; i++) {
1574 struct drm_connector *connector = state->connectors[i];
1579 connector->state->state = state;
1580 swap(state->connector_states[i], connector->state);
1581 connector->state->state = NULL;
1584 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1585 struct drm_crtc *crtc = state->crtcs[i];
1590 crtc->state->state = state;
1591 swap(state->crtc_states[i], crtc->state);
1592 crtc->state->state = NULL;
1595 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1596 struct drm_plane *plane = state->planes[i];
1601 plane->state->state = state;
1602 swap(state->plane_states[i], plane->state);
1603 plane->state->state = NULL;
1606 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1609 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1610 * @plane: plane object to update
1611 * @crtc: owning CRTC of owning plane
1612 * @fb: framebuffer to flip onto plane
1613 * @crtc_x: x offset of primary plane on crtc
1614 * @crtc_y: y offset of primary plane on crtc
1615 * @crtc_w: width of primary plane rectangle on crtc
1616 * @crtc_h: height of primary plane rectangle on crtc
1617 * @src_x: x offset of @fb for panning
1618 * @src_y: y offset of @fb for panning
1619 * @src_w: width of source rectangle in @fb
1620 * @src_h: height of source rectangle in @fb
1622 * Provides a default plane update handler using the atomic driver interface.
1625 * Zero on success, error code on failure
1627 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1628 struct drm_crtc *crtc,
1629 struct drm_framebuffer *fb,
1630 int crtc_x, int crtc_y,
1631 unsigned int crtc_w, unsigned int crtc_h,
1632 uint32_t src_x, uint32_t src_y,
1633 uint32_t src_w, uint32_t src_h)
1635 struct drm_atomic_state *state;
1636 struct drm_plane_state *plane_state;
1639 state = drm_atomic_state_alloc(plane->dev);
1643 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1645 plane_state = drm_atomic_get_plane_state(state, plane);
1646 if (IS_ERR(plane_state)) {
1647 ret = PTR_ERR(plane_state);
1651 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1654 drm_atomic_set_fb_for_plane(plane_state, fb);
1655 plane_state->crtc_x = crtc_x;
1656 plane_state->crtc_y = crtc_y;
1657 plane_state->crtc_w = crtc_w;
1658 plane_state->crtc_h = crtc_h;
1659 plane_state->src_x = src_x;
1660 plane_state->src_y = src_y;
1661 plane_state->src_w = src_w;
1662 plane_state->src_h = src_h;
1664 if (plane == crtc->cursor)
1665 state->legacy_cursor_update = true;
1667 ret = drm_atomic_commit(state);
1671 /* Driver takes ownership of state on successful commit. */
1674 if (ret == -EDEADLK)
1677 drm_atomic_state_free(state);
1681 drm_atomic_state_clear(state);
1682 drm_atomic_legacy_backoff(state);
1685 * Someone might have exchanged the framebuffer while we dropped locks
1686 * in the backoff code. We need to fix up the fb refcount tracking the
1689 plane->old_fb = plane->fb;
1693 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1696 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1697 * @plane: plane to disable
1699 * Provides a default plane disable handler using the atomic driver interface.
1702 * Zero on success, error code on failure
1704 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1706 struct drm_atomic_state *state;
1707 struct drm_plane_state *plane_state;
1711 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1712 * acquire context. The real fix will be to wire the acquire ctx through
1713 * everywhere we need it, but meanwhile prevent chaos by just skipping
1714 * this noop. The critical case is the cursor ioctls which a) only grab
1715 * crtc/cursor-plane locks (so we need the crtc to get at the right
1716 * acquire context) and b) can try to disable the plane multiple times.
1721 state = drm_atomic_state_alloc(plane->dev);
1725 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1727 plane_state = drm_atomic_get_plane_state(state, plane);
1728 if (IS_ERR(plane_state)) {
1729 ret = PTR_ERR(plane_state);
1733 if (plane_state->crtc && (plane == plane->crtc->cursor))
1734 plane_state->state->legacy_cursor_update = true;
1736 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1740 ret = drm_atomic_commit(state);
1744 /* Driver takes ownership of state on successful commit. */
1747 if (ret == -EDEADLK)
1750 drm_atomic_state_free(state);
1754 drm_atomic_state_clear(state);
1755 drm_atomic_legacy_backoff(state);
1758 * Someone might have exchanged the framebuffer while we dropped locks
1759 * in the backoff code. We need to fix up the fb refcount tracking the
1762 plane->old_fb = plane->fb;
1766 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1768 /* just used from fb-helper and atomic-helper: */
1769 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1770 struct drm_plane_state *plane_state)
1774 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1778 drm_atomic_set_fb_for_plane(plane_state, NULL);
1779 plane_state->crtc_x = 0;
1780 plane_state->crtc_y = 0;
1781 plane_state->crtc_w = 0;
1782 plane_state->crtc_h = 0;
1783 plane_state->src_x = 0;
1784 plane_state->src_y = 0;
1785 plane_state->src_w = 0;
1786 plane_state->src_h = 0;
1791 static int update_output_state(struct drm_atomic_state *state,
1792 struct drm_mode_set *set)
1794 struct drm_device *dev = set->crtc->dev;
1795 struct drm_crtc *crtc;
1796 struct drm_crtc_state *crtc_state;
1797 struct drm_connector *connector;
1798 struct drm_connector_state *conn_state;
1801 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1802 state->acquire_ctx);
1806 /* First disable all connectors on the target crtc. */
1807 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1811 for_each_connector_in_state(state, connector, conn_state, i) {
1812 if (conn_state->crtc == set->crtc) {
1813 ret = drm_atomic_set_crtc_for_connector(conn_state,
1820 /* Then set all connectors from set->connectors on the target crtc */
1821 for (i = 0; i < set->num_connectors; i++) {
1822 conn_state = drm_atomic_get_connector_state(state,
1823 set->connectors[i]);
1824 if (IS_ERR(conn_state))
1825 return PTR_ERR(conn_state);
1827 ret = drm_atomic_set_crtc_for_connector(conn_state,
1833 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1834 /* Don't update ->enable for the CRTC in the set_config request,
1835 * since a mismatch would indicate a bug in the upper layers.
1836 * The actual modeset code later on will catch any
1837 * inconsistencies here. */
1838 if (crtc == set->crtc)
1841 if (!crtc_state->connector_mask) {
1842 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1847 crtc_state->active = false;
1855 * drm_atomic_helper_set_config - set a new config from userspace
1856 * @set: mode set configuration
1858 * Provides a default crtc set_config handler using the atomic driver interface.
1861 * Returns 0 on success, negative errno numbers on failure.
1863 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1865 struct drm_atomic_state *state;
1866 struct drm_crtc *crtc = set->crtc;
1869 state = drm_atomic_state_alloc(crtc->dev);
1873 state->legacy_set_config = true;
1874 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1876 ret = __drm_atomic_helper_set_config(set, state);
1880 ret = drm_atomic_commit(state);
1884 /* Driver takes ownership of state on successful commit. */
1887 if (ret == -EDEADLK)
1890 drm_atomic_state_free(state);
1894 drm_atomic_state_clear(state);
1895 drm_atomic_legacy_backoff(state);
1898 * Someone might have exchanged the framebuffer while we dropped locks
1899 * in the backoff code. We need to fix up the fb refcount tracking the
1902 crtc->primary->old_fb = crtc->primary->fb;
1906 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1908 /* just used from fb-helper and atomic-helper: */
1909 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1910 struct drm_atomic_state *state)
1912 struct drm_crtc_state *crtc_state;
1913 struct drm_plane_state *primary_state;
1914 struct drm_crtc *crtc = set->crtc;
1915 int hdisplay, vdisplay;
1918 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1919 if (IS_ERR(crtc_state))
1920 return PTR_ERR(crtc_state);
1922 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1923 if (IS_ERR(primary_state))
1924 return PTR_ERR(primary_state);
1928 WARN_ON(set->num_connectors);
1930 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1934 crtc_state->active = false;
1936 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1940 drm_atomic_set_fb_for_plane(primary_state, NULL);
1946 WARN_ON(!set->num_connectors);
1948 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1952 crtc_state->active = true;
1954 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1958 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1960 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1961 primary_state->crtc_x = 0;
1962 primary_state->crtc_y = 0;
1963 primary_state->crtc_w = hdisplay;
1964 primary_state->crtc_h = vdisplay;
1965 primary_state->src_x = set->x << 16;
1966 primary_state->src_y = set->y << 16;
1967 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1968 primary_state->src_w = vdisplay << 16;
1969 primary_state->src_h = hdisplay << 16;
1971 primary_state->src_w = hdisplay << 16;
1972 primary_state->src_h = vdisplay << 16;
1976 ret = update_output_state(state, set);
1984 * drm_atomic_helper_disable_all - disable all currently active outputs
1986 * @ctx: lock acquisition context
1988 * Loops through all connectors, finding those that aren't turned off and then
1989 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1990 * that they are connected to.
1992 * This is used for example in suspend/resume to disable all currently active
1993 * functions when suspending.
1995 * Note that if callers haven't already acquired all modeset locks this might
1996 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1999 * 0 on success or a negative error code on failure.
2002 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2004 int drm_atomic_helper_disable_all(struct drm_device *dev,
2005 struct drm_modeset_acquire_ctx *ctx)
2007 struct drm_atomic_state *state;
2008 struct drm_connector *conn;
2011 state = drm_atomic_state_alloc(dev);
2015 state->acquire_ctx = ctx;
2017 drm_for_each_connector(conn, dev) {
2018 struct drm_crtc *crtc = conn->state->crtc;
2019 struct drm_crtc_state *crtc_state;
2021 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2024 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2025 if (IS_ERR(crtc_state)) {
2026 err = PTR_ERR(crtc_state);
2030 crtc_state->active = false;
2033 err = drm_atomic_commit(state);
2037 drm_atomic_state_free(state);
2041 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2044 * drm_atomic_helper_suspend - subsystem-level suspend helper
2047 * Duplicates the current atomic state, disables all active outputs and then
2048 * returns a pointer to the original atomic state to the caller. Drivers can
2049 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2050 * restore the output configuration that was active at the time the system
2053 * Note that it is potentially unsafe to use this. The atomic state object
2054 * returned by this function is assumed to be persistent. Drivers must ensure
2055 * that this holds true. Before calling this function, drivers must make sure
2056 * to suspend fbdev emulation so that nothing can be using the device.
2059 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2060 * encoded error code on failure. Drivers should store the returned atomic
2061 * state object and pass it to the drm_atomic_helper_resume() helper upon
2065 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2066 * drm_atomic_helper_resume()
2068 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2070 struct drm_modeset_acquire_ctx ctx;
2071 struct drm_atomic_state *state;
2074 drm_modeset_acquire_init(&ctx, 0);
2077 err = drm_modeset_lock_all_ctx(dev, &ctx);
2079 state = ERR_PTR(err);
2083 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2087 err = drm_atomic_helper_disable_all(dev, &ctx);
2089 drm_atomic_state_free(state);
2090 state = ERR_PTR(err);
2095 if (PTR_ERR(state) == -EDEADLK) {
2096 drm_modeset_backoff(&ctx);
2100 drm_modeset_drop_locks(&ctx);
2101 drm_modeset_acquire_fini(&ctx);
2104 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2107 * drm_atomic_helper_resume - subsystem-level resume helper
2109 * @state: atomic state to resume to
2111 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2112 * grabs all modeset locks and commits the atomic state object. This can be
2113 * used in conjunction with the drm_atomic_helper_suspend() helper to
2114 * implement suspend/resume for drivers that support atomic mode-setting.
2117 * 0 on success or a negative error code on failure.
2120 * drm_atomic_helper_suspend()
2122 int drm_atomic_helper_resume(struct drm_device *dev,
2123 struct drm_atomic_state *state)
2125 struct drm_mode_config *config = &dev->mode_config;
2128 drm_mode_config_reset(dev);
2129 drm_modeset_lock_all(dev);
2130 state->acquire_ctx = config->acquire_ctx;
2131 err = drm_atomic_commit(state);
2132 drm_modeset_unlock_all(dev);
2136 EXPORT_SYMBOL(drm_atomic_helper_resume);
2139 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2141 * @property: DRM property
2142 * @val: value of property
2144 * Provides a default crtc set_property handler using the atomic driver
2148 * Zero on success, error code on failure
2151 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2152 struct drm_property *property,
2155 struct drm_atomic_state *state;
2156 struct drm_crtc_state *crtc_state;
2159 state = drm_atomic_state_alloc(crtc->dev);
2163 /* ->set_property is always called with all locks held. */
2164 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2166 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2167 if (IS_ERR(crtc_state)) {
2168 ret = PTR_ERR(crtc_state);
2172 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2177 ret = drm_atomic_commit(state);
2181 /* Driver takes ownership of state on successful commit. */
2184 if (ret == -EDEADLK)
2187 drm_atomic_state_free(state);
2191 drm_atomic_state_clear(state);
2192 drm_atomic_legacy_backoff(state);
2196 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2199 * drm_atomic_helper_plane_set_property - helper for plane properties
2201 * @property: DRM property
2202 * @val: value of property
2204 * Provides a default plane set_property handler using the atomic driver
2208 * Zero on success, error code on failure
2211 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2212 struct drm_property *property,
2215 struct drm_atomic_state *state;
2216 struct drm_plane_state *plane_state;
2219 state = drm_atomic_state_alloc(plane->dev);
2223 /* ->set_property is always called with all locks held. */
2224 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2226 plane_state = drm_atomic_get_plane_state(state, plane);
2227 if (IS_ERR(plane_state)) {
2228 ret = PTR_ERR(plane_state);
2232 ret = drm_atomic_plane_set_property(plane, plane_state,
2237 ret = drm_atomic_commit(state);
2241 /* Driver takes ownership of state on successful commit. */
2244 if (ret == -EDEADLK)
2247 drm_atomic_state_free(state);
2251 drm_atomic_state_clear(state);
2252 drm_atomic_legacy_backoff(state);
2256 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2259 * drm_atomic_helper_connector_set_property - helper for connector properties
2260 * @connector: DRM connector
2261 * @property: DRM property
2262 * @val: value of property
2264 * Provides a default connector set_property handler using the atomic driver
2268 * Zero on success, error code on failure
2271 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2272 struct drm_property *property,
2275 struct drm_atomic_state *state;
2276 struct drm_connector_state *connector_state;
2279 state = drm_atomic_state_alloc(connector->dev);
2283 /* ->set_property is always called with all locks held. */
2284 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2286 connector_state = drm_atomic_get_connector_state(state, connector);
2287 if (IS_ERR(connector_state)) {
2288 ret = PTR_ERR(connector_state);
2292 ret = drm_atomic_connector_set_property(connector, connector_state,
2297 ret = drm_atomic_commit(state);
2301 /* Driver takes ownership of state on successful commit. */
2304 if (ret == -EDEADLK)
2307 drm_atomic_state_free(state);
2311 drm_atomic_state_clear(state);
2312 drm_atomic_legacy_backoff(state);
2316 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2319 * drm_atomic_helper_page_flip - execute a legacy page flip
2321 * @fb: DRM framebuffer
2322 * @event: optional DRM event to signal upon completion
2323 * @flags: flip flags for non-vblank sync'ed updates
2325 * Provides a default page flip implementation using the atomic driver interface.
2327 * Note that for now so called async page flips (i.e. updates which are not
2328 * synchronized to vblank) are not supported, since the atomic interfaces have
2329 * no provisions for this yet.
2332 * Returns 0 on success, negative errno numbers on failure.
2334 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2335 struct drm_framebuffer *fb,
2336 struct drm_pending_vblank_event *event,
2339 struct drm_plane *plane = crtc->primary;
2340 struct drm_atomic_state *state;
2341 struct drm_plane_state *plane_state;
2342 struct drm_crtc_state *crtc_state;
2345 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2348 state = drm_atomic_state_alloc(plane->dev);
2352 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2354 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2355 if (IS_ERR(crtc_state)) {
2356 ret = PTR_ERR(crtc_state);
2359 crtc_state->event = event;
2361 plane_state = drm_atomic_get_plane_state(state, plane);
2362 if (IS_ERR(plane_state)) {
2363 ret = PTR_ERR(plane_state);
2367 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2370 drm_atomic_set_fb_for_plane(plane_state, fb);
2372 /* Make sure we don't accidentally do a full modeset. */
2373 state->allow_modeset = false;
2374 if (!crtc_state->active) {
2375 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2381 ret = drm_atomic_nonblocking_commit(state);
2385 /* Driver takes ownership of state on successful commit. */
2388 if (ret == -EDEADLK)
2391 drm_atomic_state_free(state);
2395 drm_atomic_state_clear(state);
2396 drm_atomic_legacy_backoff(state);
2399 * Someone might have exchanged the framebuffer while we dropped locks
2400 * in the backoff code. We need to fix up the fb refcount tracking the
2403 plane->old_fb = plane->fb;
2407 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2410 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2411 * @connector: affected connector
2414 * This is the main helper function provided by the atomic helper framework for
2415 * implementing the legacy DPMS connector interface. It computes the new desired
2416 * ->active state for the corresponding CRTC (if the connector is enabled) and
2420 * Returns 0 on success, negative errno numbers on failure.
2422 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2425 struct drm_mode_config *config = &connector->dev->mode_config;
2426 struct drm_atomic_state *state;
2427 struct drm_crtc_state *crtc_state;
2428 struct drm_crtc *crtc;
2429 struct drm_connector *tmp_connector;
2431 bool active = false;
2432 int old_mode = connector->dpms;
2434 if (mode != DRM_MODE_DPMS_ON)
2435 mode = DRM_MODE_DPMS_OFF;
2437 connector->dpms = mode;
2438 crtc = connector->state->crtc;
2443 state = drm_atomic_state_alloc(connector->dev);
2447 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2449 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2450 if (IS_ERR(crtc_state)) {
2451 ret = PTR_ERR(crtc_state);
2455 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2457 drm_for_each_connector(tmp_connector, connector->dev) {
2458 if (tmp_connector->state->crtc != crtc)
2461 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2466 crtc_state->active = active;
2468 ret = drm_atomic_commit(state);
2472 /* Driver takes ownership of state on successful commit. */
2475 if (ret == -EDEADLK)
2478 connector->dpms = old_mode;
2479 drm_atomic_state_free(state);
2483 drm_atomic_state_clear(state);
2484 drm_atomic_legacy_backoff(state);
2488 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2491 * DOC: atomic state reset and initialization
2493 * Both the drm core and the atomic helpers assume that there is always the full
2494 * and correct atomic software state for all connectors, CRTCs and planes
2495 * available. Which is a bit a problem on driver load and also after system
2496 * suspend. One way to solve this is to have a hardware state read-out
2497 * infrastructure which reconstructs the full software state (e.g. the i915
2500 * The simpler solution is to just reset the software state to everything off,
2501 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2502 * the atomic helpers provide default reset implementations for all hooks.
2504 * On the upside the precise state tracking of atomic simplifies system suspend
2505 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2506 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2507 * For other drivers the building blocks are split out, see the documentation
2508 * for these functions.
2512 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2515 * Resets the atomic state for @crtc by freeing the state pointer (which might
2516 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2518 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2521 __drm_atomic_helper_crtc_destroy_state(crtc, crtc->state);
2524 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2527 crtc->state->crtc = crtc;
2529 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2532 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2533 * @crtc: CRTC object
2534 * @state: atomic CRTC state
2536 * Copies atomic state from a CRTC's current state and resets inferred values.
2537 * This is useful for drivers that subclass the CRTC state.
2539 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2540 struct drm_crtc_state *state)
2542 memcpy(state, crtc->state, sizeof(*state));
2544 if (state->mode_blob)
2545 drm_property_reference_blob(state->mode_blob);
2546 if (state->degamma_lut)
2547 drm_property_reference_blob(state->degamma_lut);
2549 drm_property_reference_blob(state->ctm);
2550 if (state->gamma_lut)
2551 drm_property_reference_blob(state->gamma_lut);
2552 state->mode_changed = false;
2553 state->active_changed = false;
2554 state->planes_changed = false;
2555 state->connectors_changed = false;
2556 state->color_mgmt_changed = false;
2557 state->event = NULL;
2559 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2562 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2565 * Default CRTC state duplicate hook for drivers which don't have their own
2566 * subclassed CRTC state structure.
2568 struct drm_crtc_state *
2569 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2571 struct drm_crtc_state *state;
2573 if (WARN_ON(!crtc->state))
2576 state = kmalloc(sizeof(*state), GFP_KERNEL);
2578 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2582 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2585 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2586 * @crtc: CRTC object
2587 * @state: CRTC state object to release
2589 * Releases all resources stored in the CRTC state without actually freeing
2590 * the memory of the CRTC state. This is useful for drivers that subclass the
2593 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2594 struct drm_crtc_state *state)
2596 drm_property_unreference_blob(state->mode_blob);
2597 drm_property_unreference_blob(state->degamma_lut);
2598 drm_property_unreference_blob(state->ctm);
2599 drm_property_unreference_blob(state->gamma_lut);
2601 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2604 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2606 * @state: CRTC state object to release
2608 * Default CRTC state destroy hook for drivers which don't have their own
2609 * subclassed CRTC state structure.
2611 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2612 struct drm_crtc_state *state)
2614 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2617 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2620 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2623 * Resets the atomic state for @plane by freeing the state pointer (which might
2624 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2626 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2629 __drm_atomic_helper_plane_destroy_state(plane, plane->state);
2631 kfree(plane->state);
2632 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2635 plane->state->plane = plane;
2636 plane->state->rotation = BIT(DRM_ROTATE_0);
2639 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2642 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2643 * @plane: plane object
2644 * @state: atomic plane state
2646 * Copies atomic state from a plane's current state. This is useful for
2647 * drivers that subclass the plane state.
2649 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2650 struct drm_plane_state *state)
2652 memcpy(state, plane->state, sizeof(*state));
2655 drm_framebuffer_reference(state->fb);
2657 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2660 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2663 * Default plane state duplicate hook for drivers which don't have their own
2664 * subclassed plane state structure.
2666 struct drm_plane_state *
2667 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2669 struct drm_plane_state *state;
2671 if (WARN_ON(!plane->state))
2674 state = kmalloc(sizeof(*state), GFP_KERNEL);
2676 __drm_atomic_helper_plane_duplicate_state(plane, state);
2680 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2683 * __drm_atomic_helper_plane_destroy_state - release plane state
2684 * @plane: plane object
2685 * @state: plane state object to release
2687 * Releases all resources stored in the plane state without actually freeing
2688 * the memory of the plane state. This is useful for drivers that subclass the
2691 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2692 struct drm_plane_state *state)
2695 drm_framebuffer_unreference(state->fb);
2697 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2700 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2702 * @state: plane state object to release
2704 * Default plane state destroy hook for drivers which don't have their own
2705 * subclassed plane state structure.
2707 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2708 struct drm_plane_state *state)
2710 __drm_atomic_helper_plane_destroy_state(plane, state);
2713 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2716 * __drm_atomic_helper_connector_reset - reset state on connector
2717 * @connector: drm connector
2718 * @conn_state: connector state to assign
2720 * Initializes the newly allocated @conn_state and assigns it to
2721 * #connector ->state, usually required when initializing the drivers
2722 * or when called from the ->reset hook.
2724 * This is useful for drivers that subclass the connector state.
2727 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
2728 struct drm_connector_state *conn_state)
2731 conn_state->connector = connector;
2733 connector->state = conn_state;
2735 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2738 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2739 * @connector: drm connector
2741 * Resets the atomic state for @connector by freeing the state pointer (which
2742 * might be NULL, e.g. at driver load time) and allocating a new empty state
2745 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2747 struct drm_connector_state *conn_state =
2748 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2750 if (connector->state)
2751 __drm_atomic_helper_connector_destroy_state(connector,
2754 kfree(connector->state);
2755 __drm_atomic_helper_connector_reset(connector, conn_state);
2757 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2760 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2761 * @connector: connector object
2762 * @state: atomic connector state
2764 * Copies atomic state from a connector's current state. This is useful for
2765 * drivers that subclass the connector state.
2768 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2769 struct drm_connector_state *state)
2771 memcpy(state, connector->state, sizeof(*state));
2773 drm_connector_reference(connector);
2775 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2778 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2779 * @connector: drm connector
2781 * Default connector state duplicate hook for drivers which don't have their own
2782 * subclassed connector state structure.
2784 struct drm_connector_state *
2785 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2787 struct drm_connector_state *state;
2789 if (WARN_ON(!connector->state))
2792 state = kmalloc(sizeof(*state), GFP_KERNEL);
2794 __drm_atomic_helper_connector_duplicate_state(connector, state);
2798 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2801 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2803 * @ctx: lock acquisition context
2805 * Makes a copy of the current atomic state by looping over all objects and
2806 * duplicating their respective states. This is used for example by suspend/
2807 * resume support code to save the state prior to suspend such that it can
2808 * be restored upon resume.
2810 * Note that this treats atomic state as persistent between save and restore.
2811 * Drivers must make sure that this is possible and won't result in confusion
2812 * or erroneous behaviour.
2814 * Note that if callers haven't already acquired all modeset locks this might
2815 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2818 * A pointer to the copy of the atomic state object on success or an
2819 * ERR_PTR()-encoded error code on failure.
2822 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2824 struct drm_atomic_state *
2825 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2826 struct drm_modeset_acquire_ctx *ctx)
2828 struct drm_atomic_state *state;
2829 struct drm_connector *conn;
2830 struct drm_plane *plane;
2831 struct drm_crtc *crtc;
2834 state = drm_atomic_state_alloc(dev);
2836 return ERR_PTR(-ENOMEM);
2838 state->acquire_ctx = ctx;
2840 drm_for_each_crtc(crtc, dev) {
2841 struct drm_crtc_state *crtc_state;
2843 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2844 if (IS_ERR(crtc_state)) {
2845 err = PTR_ERR(crtc_state);
2850 drm_for_each_plane(plane, dev) {
2851 struct drm_plane_state *plane_state;
2853 plane_state = drm_atomic_get_plane_state(state, plane);
2854 if (IS_ERR(plane_state)) {
2855 err = PTR_ERR(plane_state);
2860 drm_for_each_connector(conn, dev) {
2861 struct drm_connector_state *conn_state;
2863 conn_state = drm_atomic_get_connector_state(state, conn);
2864 if (IS_ERR(conn_state)) {
2865 err = PTR_ERR(conn_state);
2870 /* clear the acquire context so that it isn't accidentally reused */
2871 state->acquire_ctx = NULL;
2875 drm_atomic_state_free(state);
2876 state = ERR_PTR(err);
2881 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2884 * __drm_atomic_helper_connector_destroy_state - release connector state
2885 * @connector: connector object
2886 * @state: connector state object to release
2888 * Releases all resources stored in the connector state without actually
2889 * freeing the memory of the connector state. This is useful for drivers that
2890 * subclass the connector state.
2893 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2894 struct drm_connector_state *state)
2897 * This is currently a placeholder so that drivers that subclass the
2898 * state will automatically do the right thing if code is ever added
2902 drm_connector_unreference(state->connector);
2904 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2907 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2908 * @connector: drm connector
2909 * @state: connector state object to release
2911 * Default connector state destroy hook for drivers which don't have their own
2912 * subclassed connector state structure.
2914 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2915 struct drm_connector_state *state)
2917 __drm_atomic_helper_connector_destroy_state(connector, state);
2920 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2923 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2924 * @crtc: CRTC object
2925 * @red: red correction table
2926 * @green: green correction table
2927 * @blue: green correction table
2929 * @size: size of the tables
2931 * Implements support for legacy gamma correction table for drivers
2932 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2935 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2936 u16 *red, u16 *green, u16 *blue,
2937 uint32_t start, uint32_t size)
2939 struct drm_device *dev = crtc->dev;
2940 struct drm_mode_config *config = &dev->mode_config;
2941 struct drm_atomic_state *state;
2942 struct drm_crtc_state *crtc_state;
2943 struct drm_property_blob *blob = NULL;
2944 struct drm_color_lut *blob_data;
2947 state = drm_atomic_state_alloc(crtc->dev);
2951 blob = drm_property_create_blob(dev,
2952 sizeof(struct drm_color_lut) * size,
2955 ret = PTR_ERR(blob);
2960 /* Prepare GAMMA_LUT with the legacy values. */
2961 blob_data = (struct drm_color_lut *) blob->data;
2962 for (i = 0; i < size; i++) {
2963 blob_data[i].red = red[i];
2964 blob_data[i].green = green[i];
2965 blob_data[i].blue = blue[i];
2968 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2970 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2971 if (IS_ERR(crtc_state)) {
2972 ret = PTR_ERR(crtc_state);
2976 /* Reset DEGAMMA_LUT and CTM properties. */
2977 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2978 config->degamma_lut_property, 0);
2982 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2983 config->ctm_property, 0);
2987 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2988 config->gamma_lut_property, blob->base.id);
2992 ret = drm_atomic_commit(state);
2996 /* Driver takes ownership of state on successful commit. */
2998 drm_property_unreference_blob(blob);
3002 if (ret == -EDEADLK)
3005 drm_atomic_state_free(state);
3006 drm_property_unreference_blob(blob);
3010 drm_atomic_state_clear(state);
3011 drm_atomic_legacy_backoff(state);
3015 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);