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.
57 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
58 struct drm_plane_state *plane_state,
59 struct drm_plane *plane)
61 struct drm_crtc_state *crtc_state;
63 if (plane->state->crtc) {
64 crtc_state = state->crtc_states[drm_crtc_index(plane->state->crtc)];
66 if (WARN_ON(!crtc_state))
69 crtc_state->planes_changed = true;
72 if (plane_state->crtc) {
74 state->crtc_states[drm_crtc_index(plane_state->crtc)];
76 if (WARN_ON(!crtc_state))
79 crtc_state->planes_changed = true;
83 static struct drm_crtc *
84 get_current_crtc_for_encoder(struct drm_device *dev,
85 struct drm_encoder *encoder)
87 struct drm_mode_config *config = &dev->mode_config;
88 struct drm_connector *connector;
90 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
92 drm_for_each_connector(connector, dev) {
93 if (connector->state->best_encoder != encoder)
96 return connector->state->crtc;
103 steal_encoder(struct drm_atomic_state *state,
104 struct drm_encoder *encoder,
105 struct drm_crtc *encoder_crtc)
107 struct drm_mode_config *config = &state->dev->mode_config;
108 struct drm_crtc_state *crtc_state;
109 struct drm_connector *connector;
110 struct drm_connector_state *connector_state;
113 * We can only steal an encoder coming from a connector, which means we
114 * must already hold the connection_mutex.
116 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
118 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
119 encoder->base.id, encoder->name,
120 encoder_crtc->base.id);
122 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
123 if (IS_ERR(crtc_state))
124 return PTR_ERR(crtc_state);
126 crtc_state->connectors_changed = true;
128 list_for_each_entry(connector, &config->connector_list, head) {
129 if (connector->state->best_encoder != encoder)
132 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
136 connector_state = drm_atomic_get_connector_state(state,
138 if (IS_ERR(connector_state))
139 return PTR_ERR(connector_state);
141 connector_state->best_encoder = NULL;
148 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
150 const struct drm_connector_helper_funcs *funcs;
151 struct drm_encoder *new_encoder;
152 struct drm_crtc *encoder_crtc;
153 struct drm_connector *connector;
154 struct drm_connector_state *connector_state;
155 struct drm_crtc_state *crtc_state;
158 connector = state->connectors[conn_idx];
159 connector_state = state->connector_states[conn_idx];
164 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
168 if (connector->state->crtc != connector_state->crtc) {
169 if (connector->state->crtc) {
170 idx = drm_crtc_index(connector->state->crtc);
172 crtc_state = state->crtc_states[idx];
173 crtc_state->connectors_changed = true;
176 if (connector_state->crtc) {
177 idx = drm_crtc_index(connector_state->crtc);
179 crtc_state = state->crtc_states[idx];
180 crtc_state->connectors_changed = true;
184 if (!connector_state->crtc) {
185 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
189 connector_state->best_encoder = NULL;
194 funcs = connector->helper_private;
196 if (funcs->atomic_best_encoder)
197 new_encoder = funcs->atomic_best_encoder(connector,
200 new_encoder = funcs->best_encoder(connector);
203 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
209 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
210 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
211 new_encoder->base.id,
213 connector_state->crtc->base.id);
217 if (new_encoder == connector_state->best_encoder) {
218 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
221 new_encoder->base.id,
223 connector_state->crtc->base.id);
228 encoder_crtc = get_current_crtc_for_encoder(state->dev,
232 ret = steal_encoder(state, new_encoder, encoder_crtc);
234 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
241 if (WARN_ON(!connector_state->crtc))
244 connector_state->best_encoder = new_encoder;
245 idx = drm_crtc_index(connector_state->crtc);
247 crtc_state = state->crtc_states[idx];
248 crtc_state->connectors_changed = true;
250 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
253 new_encoder->base.id,
255 connector_state->crtc->base.id);
261 mode_fixup(struct drm_atomic_state *state)
263 struct drm_crtc *crtc;
264 struct drm_crtc_state *crtc_state;
265 struct drm_connector *connector;
266 struct drm_connector_state *conn_state;
270 for_each_crtc_in_state(state, crtc, crtc_state, i) {
271 if (!crtc_state->mode_changed &&
272 !crtc_state->connectors_changed)
275 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
278 for_each_connector_in_state(state, connector, conn_state, i) {
279 const struct drm_encoder_helper_funcs *funcs;
280 struct drm_encoder *encoder;
282 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
284 if (!conn_state->crtc || !conn_state->best_encoder)
288 state->crtc_states[drm_crtc_index(conn_state->crtc)];
291 * Each encoder has at most one connector (since we always steal
292 * it away), so we won't call ->mode_fixup twice.
294 encoder = conn_state->best_encoder;
295 funcs = encoder->helper_private;
299 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
300 &crtc_state->adjusted_mode);
302 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
306 if (funcs->atomic_check) {
307 ret = funcs->atomic_check(encoder, crtc_state,
310 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
311 encoder->base.id, encoder->name);
314 } else if (funcs->mode_fixup) {
315 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
316 &crtc_state->adjusted_mode);
318 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
319 encoder->base.id, encoder->name);
325 for_each_crtc_in_state(state, crtc, crtc_state, i) {
326 const struct drm_crtc_helper_funcs *funcs;
328 if (!crtc_state->mode_changed &&
329 !crtc_state->connectors_changed)
332 funcs = crtc->helper_private;
333 if (!funcs->mode_fixup)
336 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
337 &crtc_state->adjusted_mode);
339 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
349 * drm_atomic_helper_check_modeset - validate state object for modeset changes
351 * @state: the driver state object
353 * Check the state object to see if the requested state is physically possible.
354 * This does all the crtc and connector related computations for an atomic
355 * update and adds any additional connectors needed for full modesets and calls
356 * down into ->mode_fixup functions of the driver backend.
358 * crtc_state->mode_changed is set when the input mode is changed.
359 * crtc_state->connectors_changed is set when a connector is added or
360 * removed from the crtc.
361 * crtc_state->active_changed is set when crtc_state->active changes,
362 * which is used for dpms.
366 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
367 * plane update can't be done without a full modeset) _must_ call this function
368 * afterwards after that change. It is permitted to call this function multiple
369 * times for the same update, e.g. when the ->atomic_check functions depend upon
370 * the adjusted dotclock for fifo space allocation and watermark computation.
373 * Zero for success or -errno
376 drm_atomic_helper_check_modeset(struct drm_device *dev,
377 struct drm_atomic_state *state)
379 struct drm_crtc *crtc;
380 struct drm_crtc_state *crtc_state;
381 struct drm_connector *connector;
382 struct drm_connector_state *connector_state;
385 for_each_crtc_in_state(state, crtc, crtc_state, i) {
386 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
387 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
389 crtc_state->mode_changed = true;
392 if (crtc->state->enable != crtc_state->enable) {
393 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
397 * For clarity this assignment is done here, but
398 * enable == 0 is only true when there are no
399 * connectors and a NULL mode.
401 * The other way around is true as well. enable != 0
402 * iff connectors are attached and a mode is set.
404 crtc_state->mode_changed = true;
405 crtc_state->connectors_changed = true;
409 for_each_connector_in_state(state, connector, connector_state, i) {
411 * This only sets crtc->mode_changed for routing changes,
412 * drivers must set crtc->mode_changed themselves when connector
413 * properties need to be updated.
415 ret = update_connector_routing(state, i);
421 * After all the routing has been prepared we need to add in any
422 * connector which is itself unchanged, but who's crtc changes it's
423 * configuration. This must be done before calling mode_fixup in case a
424 * crtc only changed its mode but has the same set of connectors.
426 for_each_crtc_in_state(state, crtc, crtc_state, i) {
430 * We must set ->active_changed after walking connectors for
431 * otherwise an update that only changes active would result in
432 * a full modeset because update_connector_routing force that.
434 if (crtc->state->active != crtc_state->active) {
435 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
437 crtc_state->active_changed = true;
440 if (!drm_atomic_crtc_needs_modeset(crtc_state))
443 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
445 crtc_state->enable ? 'y' : 'n',
446 crtc_state->active ? 'y' : 'n');
448 ret = drm_atomic_add_affected_connectors(state, crtc);
452 ret = drm_atomic_add_affected_planes(state, crtc);
456 num_connectors = drm_atomic_connectors_for_crtc(state,
459 if (crtc_state->enable != !!num_connectors) {
460 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
467 return mode_fixup(state);
469 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
472 * drm_atomic_helper_check_planes - validate state object for planes changes
474 * @state: the driver state object
476 * Check the state object to see if the requested state is physically possible.
477 * This does all the plane update related checks using by calling into the
478 * ->atomic_check hooks provided by the driver.
480 * It also sets crtc_state->planes_changed to indicate that a crtc has
484 * Zero for success or -errno
487 drm_atomic_helper_check_planes(struct drm_device *dev,
488 struct drm_atomic_state *state)
490 struct drm_crtc *crtc;
491 struct drm_crtc_state *crtc_state;
492 struct drm_plane *plane;
493 struct drm_plane_state *plane_state;
496 for_each_plane_in_state(state, plane, plane_state, i) {
497 const struct drm_plane_helper_funcs *funcs;
499 funcs = plane->helper_private;
501 drm_atomic_helper_plane_changed(state, plane_state, plane);
503 if (!funcs || !funcs->atomic_check)
506 ret = funcs->atomic_check(plane, plane_state);
508 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
514 for_each_crtc_in_state(state, crtc, crtc_state, i) {
515 const struct drm_crtc_helper_funcs *funcs;
517 funcs = crtc->helper_private;
519 if (!funcs || !funcs->atomic_check)
522 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
524 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
532 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
535 * drm_atomic_helper_check - validate state object
537 * @state: the driver state object
539 * Check the state object to see if the requested state is physically possible.
540 * Only crtcs and planes have check callbacks, so for any additional (global)
541 * checking that a driver needs it can simply wrap that around this function.
542 * Drivers without such needs can directly use this as their ->atomic_check()
545 * This just wraps the two parts of the state checking for planes and modeset
546 * state in the default order: First it calls drm_atomic_helper_check_modeset()
547 * and then drm_atomic_helper_check_planes(). The assumption is that the
548 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
549 * e.g. properly compute watermarks.
552 * Zero for success or -errno
554 int drm_atomic_helper_check(struct drm_device *dev,
555 struct drm_atomic_state *state)
559 ret = drm_atomic_helper_check_modeset(dev, state);
563 ret = drm_atomic_helper_check_planes(dev, state);
569 EXPORT_SYMBOL(drm_atomic_helper_check);
572 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
574 struct drm_connector *connector;
575 struct drm_connector_state *old_conn_state;
576 struct drm_crtc *crtc;
577 struct drm_crtc_state *old_crtc_state;
580 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
581 const struct drm_encoder_helper_funcs *funcs;
582 const struct drm_connector_helper_funcs *conn_funcs;
583 struct drm_encoder *encoder;
584 struct drm_crtc_state *old_crtc_state;
586 /* Shut down everything that's in the changeset and currently
587 * still on. So need to check the old, saved state. */
588 if (!old_conn_state->crtc)
591 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
593 if (!old_crtc_state->active ||
594 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
597 encoder = old_conn_state->best_encoder;
599 /* We shouldn't get this far if we didn't previously have
600 * an encoder.. but WARN_ON() rather than explode.
602 if (WARN_ON(!encoder))
605 funcs = encoder->helper_private;
607 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
608 encoder->base.id, encoder->name);
610 conn_funcs = connector->helper_private;
611 if (connector->loader_protect) {
612 drm_bridge_pre_enable(encoder->bridge);
615 funcs->enable(encoder);
617 funcs->commit(encoder);
619 drm_bridge_enable(encoder->bridge);
621 if (conn_funcs->loader_protect)
622 conn_funcs->loader_protect(connector, false);
623 connector->loader_protect = false;
626 * Each encoder has at most one connector (since we always steal
627 * it away), so we won't call disable hooks twice.
629 drm_bridge_disable(encoder->bridge);
631 if (encoder->loader_protect) {
632 if (funcs->loader_protect)
633 funcs->loader_protect(encoder, false);
634 encoder->loader_protect = false;
636 /* Right function depends upon target state. */
637 if (connector->state->crtc && funcs->prepare)
638 funcs->prepare(encoder);
639 else if (funcs->disable)
640 funcs->disable(encoder);
642 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
644 drm_bridge_post_disable(encoder->bridge);
647 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
648 const struct drm_crtc_helper_funcs *funcs;
650 /* Shut down everything that needs a full modeset. */
651 if (!drm_atomic_crtc_needs_modeset(crtc->state))
654 if (!old_crtc_state->active)
657 funcs = crtc->helper_private;
659 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
663 /* Right function depends upon target state. */
664 if (crtc->state->enable && funcs->prepare)
665 funcs->prepare(crtc);
666 else if (funcs->disable)
667 funcs->disable(crtc);
669 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
674 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
676 * @old_state: atomic state object with old state structures
678 * This function updates all the various legacy modeset state pointers in
679 * connectors, encoders and crtcs. It also updates the timestamping constants
680 * used for precise vblank timestamps by calling
681 * drm_calc_timestamping_constants().
683 * Drivers can use this for building their own atomic commit if they don't have
684 * a pure helper-based modeset implementation.
687 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
688 struct drm_atomic_state *old_state)
690 struct drm_connector *connector;
691 struct drm_connector_state *old_conn_state;
692 struct drm_crtc *crtc;
693 struct drm_crtc_state *old_crtc_state;
696 /* clear out existing links and update dpms */
697 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
698 if (connector->encoder) {
699 WARN_ON(!connector->encoder->crtc);
701 connector->encoder->crtc = NULL;
702 connector->encoder = NULL;
705 crtc = connector->state->crtc;
706 if ((!crtc && old_conn_state->crtc) ||
707 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
708 struct drm_property *dpms_prop =
709 dev->mode_config.dpms_property;
710 int mode = DRM_MODE_DPMS_OFF;
712 if (crtc && crtc->state->active)
713 mode = DRM_MODE_DPMS_ON;
715 connector->dpms = mode;
716 drm_object_property_set_value(&connector->base,
722 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
723 if (!connector->state->crtc)
726 if (WARN_ON(!connector->state->best_encoder))
729 connector->encoder = connector->state->best_encoder;
730 connector->encoder->crtc = connector->state->crtc;
733 /* set legacy state in the crtc structure */
734 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
735 struct drm_plane *primary = crtc->primary;
737 crtc->mode = crtc->state->mode;
738 crtc->enabled = crtc->state->enable;
740 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
741 primary->state->crtc == crtc) {
742 crtc->x = primary->state->src_x >> 16;
743 crtc->y = primary->state->src_y >> 16;
746 if (crtc->state->enable)
747 drm_calc_timestamping_constants(crtc,
748 &crtc->state->adjusted_mode);
751 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
754 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
756 struct drm_crtc *crtc;
757 struct drm_crtc_state *old_crtc_state;
758 struct drm_connector *connector;
759 struct drm_connector_state *old_conn_state;
762 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
763 const struct drm_crtc_helper_funcs *funcs;
765 if (!crtc->state->mode_changed)
768 funcs = crtc->helper_private;
770 if (crtc->state->enable && funcs->mode_set_nofb) {
771 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
774 funcs->mode_set_nofb(crtc);
778 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
779 const struct drm_encoder_helper_funcs *funcs;
780 struct drm_crtc_state *new_crtc_state;
781 struct drm_encoder *encoder;
782 struct drm_display_mode *mode, *adjusted_mode;
784 if (!connector->state->best_encoder)
787 encoder = connector->state->best_encoder;
788 funcs = encoder->helper_private;
789 new_crtc_state = connector->state->crtc->state;
790 mode = &new_crtc_state->mode;
791 adjusted_mode = &new_crtc_state->adjusted_mode;
793 if (!new_crtc_state->mode_changed)
796 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
797 encoder->base.id, encoder->name);
800 * Each encoder has at most one connector (since we always steal
801 * it away), so we won't call mode_set hooks twice.
804 funcs->mode_set(encoder, mode, adjusted_mode);
806 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
811 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
813 * @old_state: atomic state object with old state structures
815 * This function shuts down all the outputs that need to be shut down and
816 * prepares them (if required) with the new mode.
818 * For compatibility with legacy crtc helpers this should be called before
819 * drm_atomic_helper_commit_planes(), which is what the default commit function
820 * does. But drivers with different needs can group the modeset commits together
821 * and do the plane commits at the end. This is useful for drivers doing runtime
822 * PM since planes updates then only happen when the CRTC is actually enabled.
824 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
825 struct drm_atomic_state *old_state)
827 disable_outputs(dev, old_state);
829 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
831 crtc_set_mode(dev, old_state);
833 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
836 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
838 * @old_state: atomic state object with old state structures
840 * This function enables all the outputs with the new configuration which had to
841 * be turned off for the update.
843 * For compatibility with legacy crtc helpers this should be called after
844 * drm_atomic_helper_commit_planes(), which is what the default commit function
845 * does. But drivers with different needs can group the modeset commits together
846 * and do the plane commits at the end. This is useful for drivers doing runtime
847 * PM since planes updates then only happen when the CRTC is actually enabled.
849 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
850 struct drm_atomic_state *old_state)
852 struct drm_crtc *crtc;
853 struct drm_crtc_state *old_crtc_state;
854 struct drm_connector *connector;
855 struct drm_connector_state *old_conn_state;
858 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
859 const struct drm_crtc_helper_funcs *funcs;
861 /* Need to filter out CRTCs where only planes change. */
862 if (!drm_atomic_crtc_needs_modeset(crtc->state))
865 if (!crtc->state->active)
868 funcs = crtc->helper_private;
870 if (crtc->state->enable) {
871 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
881 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
882 const struct drm_encoder_helper_funcs *funcs;
883 struct drm_encoder *encoder;
885 if (!connector->state->best_encoder)
888 if (!connector->state->crtc->state->active ||
889 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
892 encoder = connector->state->best_encoder;
893 funcs = encoder->helper_private;
895 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
896 encoder->base.id, encoder->name);
899 * Each encoder has at most one connector (since we always steal
900 * it away), so we won't call enable hooks twice.
902 drm_bridge_pre_enable(encoder->bridge);
905 funcs->enable(encoder);
907 funcs->commit(encoder);
909 drm_bridge_enable(encoder->bridge);
912 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
914 static void wait_for_fences(struct drm_device *dev,
915 struct drm_atomic_state *state)
917 struct drm_plane *plane;
918 struct drm_plane_state *plane_state;
921 for_each_plane_in_state(state, plane, plane_state, i) {
922 if (!plane->state->fence)
925 WARN_ON(!plane->state->fb);
927 fence_wait(plane->state->fence, false);
928 fence_put(plane->state->fence);
929 plane->state->fence = NULL;
934 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
936 * @old_state: atomic state object with old state structures
939 * Checks whether the framebuffer used for this CRTC changes as a result of
940 * the atomic update. This is useful for drivers which cannot use
941 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
945 * true if the framebuffer changed.
947 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
948 struct drm_atomic_state *old_state,
949 struct drm_crtc *crtc)
951 struct drm_plane *plane;
952 struct drm_plane_state *old_plane_state;
955 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
956 if (plane->state->crtc != crtc &&
957 old_plane_state->crtc != crtc)
960 if (plane->state->fb != old_plane_state->fb)
966 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
969 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
971 * @old_state: atomic state object with old state structures
973 * Helper to, after atomic commit, wait for vblanks on all effected
974 * crtcs (ie. before cleaning up old framebuffers using
975 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
976 * framebuffers have actually changed to optimize for the legacy cursor and
977 * plane update use-case.
980 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
981 struct drm_atomic_state *old_state)
983 struct drm_crtc *crtc;
984 struct drm_crtc_state *old_crtc_state;
987 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
988 /* No one cares about the old state, so abuse it for tracking
989 * and store whether we hold a vblank reference (and should do a
990 * vblank wait) in the ->enable boolean. */
991 old_crtc_state->enable = false;
993 if (!crtc->state->enable)
996 /* Legacy cursor ioctls are completely unsynced, and userspace
997 * relies on that (by doing tons of cursor updates). */
998 if (old_state->legacy_cursor_update)
1001 if (!drm_atomic_helper_framebuffer_changed(dev,
1005 ret = drm_crtc_vblank_get(crtc);
1009 old_crtc_state->enable = true;
1010 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1013 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1014 if (!old_crtc_state->enable)
1017 ret = wait_event_timeout(dev->vblank[i].queue,
1018 old_crtc_state->last_vblank_count !=
1019 drm_crtc_vblank_count(crtc),
1020 msecs_to_jiffies(50));
1022 drm_crtc_vblank_put(crtc);
1025 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1028 * drm_atomic_helper_commit - commit validated state object
1030 * @state: the driver state object
1031 * @async: asynchronous commit
1033 * This function commits a with drm_atomic_helper_check() pre-validated state
1034 * object. This can still fail when e.g. the framebuffer reservation fails. For
1035 * now this doesn't implement asynchronous commits.
1037 * Note that right now this function does not support async commits, and hence
1038 * driver writers must implement their own version for now. Also note that the
1039 * default ordering of how the various stages are called is to match the legacy
1040 * modeset helper library closest. One peculiarity of that is that it doesn't
1041 * mesh well with runtime PM at all.
1043 * For drivers supporting runtime PM the recommended sequence is
1045 * drm_atomic_helper_commit_modeset_disables(dev, state);
1047 * drm_atomic_helper_commit_modeset_enables(dev, state);
1049 * drm_atomic_helper_commit_planes(dev, state, true);
1051 * See the kerneldoc entries for these three functions for more details.
1054 * Zero for success or -errno.
1056 int drm_atomic_helper_commit(struct drm_device *dev,
1057 struct drm_atomic_state *state,
1065 ret = drm_atomic_helper_prepare_planes(dev, state);
1070 * This is the point of no return - everything below never fails except
1071 * when the hw goes bonghits. Which means we can commit the new state on
1072 * the software side now.
1075 drm_atomic_helper_swap_state(dev, state);
1078 * Everything below can be run asynchronously without the need to grab
1079 * any modeset locks at all under one condition: It must be guaranteed
1080 * that the asynchronous work has either been cancelled (if the driver
1081 * supports it, which at least requires that the framebuffers get
1082 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1083 * before the new state gets committed on the software side with
1084 * drm_atomic_helper_swap_state().
1086 * This scheme allows new atomic state updates to be prepared and
1087 * checked in parallel to the asynchronous completion of the previous
1088 * update. Which is important since compositors need to figure out the
1089 * composition of the next frame right after having submitted the
1093 wait_for_fences(dev, state);
1095 drm_atomic_helper_commit_modeset_disables(dev, state);
1097 drm_atomic_helper_commit_planes(dev, state, false);
1099 drm_atomic_helper_commit_modeset_enables(dev, state);
1101 drm_atomic_helper_wait_for_vblanks(dev, state);
1103 drm_atomic_helper_cleanup_planes(dev, state);
1105 drm_atomic_state_free(state);
1109 EXPORT_SYMBOL(drm_atomic_helper_commit);
1112 * DOC: implementing async commit
1114 * For now the atomic helpers don't support async commit directly. If there is
1115 * real need it could be added though, using the dma-buf fence infrastructure
1116 * for generic synchronization with outstanding rendering.
1118 * For now drivers have to implement async commit themselves, with the following
1119 * sequence being the recommended one:
1121 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1122 * which commit needs to call which can fail, so we want to run it first and
1125 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1126 * might be affected the new state update. This can be done by either cancelling
1127 * or flushing the work items, depending upon whether the driver can deal with
1128 * cancelled updates. Note that it is important to ensure that the framebuffer
1129 * cleanup is still done when cancelling.
1131 * For sufficient parallelism it is recommended to have a work item per crtc
1132 * (for updates which don't touch global state) and a global one. Then we only
1133 * need to synchronize with the crtc work items for changed crtcs and the global
1134 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1136 * 3. The software state is updated synchronously with
1137 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1138 * locks means concurrent callers never see inconsistent state. And doing this
1139 * while it's guaranteed that no relevant async worker runs means that async
1140 * workers do not need grab any locks. Actually they must not grab locks, for
1141 * otherwise the work flushing will deadlock.
1143 * 4. Schedule a work item to do all subsequent steps, using the split-out
1144 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1145 * then cleaning up the framebuffers after the old framebuffer is no longer
1150 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1152 * @state: atomic state object with new state structures
1154 * This function prepares plane state, specifically framebuffers, for the new
1155 * configuration. If any failure is encountered this function will call
1156 * ->cleanup_fb on any already successfully prepared framebuffer.
1159 * 0 on success, negative error code on failure.
1161 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1162 struct drm_atomic_state *state)
1164 int nplanes = dev->mode_config.num_total_plane;
1167 for (i = 0; i < nplanes; i++) {
1168 const struct drm_plane_helper_funcs *funcs;
1169 struct drm_plane *plane = state->planes[i];
1170 struct drm_plane_state *plane_state = state->plane_states[i];
1175 funcs = plane->helper_private;
1177 if (funcs->prepare_fb) {
1178 ret = funcs->prepare_fb(plane, plane_state);
1187 for (i--; i >= 0; i--) {
1188 const struct drm_plane_helper_funcs *funcs;
1189 struct drm_plane *plane = state->planes[i];
1190 struct drm_plane_state *plane_state = state->plane_states[i];
1195 funcs = plane->helper_private;
1197 if (funcs->cleanup_fb)
1198 funcs->cleanup_fb(plane, plane_state);
1204 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1206 bool plane_crtc_active(struct drm_plane_state *state)
1208 return state->crtc && state->crtc->state->active;
1212 * drm_atomic_helper_commit_planes - commit plane state
1214 * @old_state: atomic state object with old state structures
1215 * @active_only: Only commit on active CRTC if set
1217 * This function commits the new plane state using the plane and atomic helper
1218 * functions for planes and crtcs. It assumes that the atomic state has already
1219 * been pushed into the relevant object state pointers, since this step can no
1222 * It still requires the global state object @old_state to know which planes and
1223 * crtcs need to be updated though.
1225 * Note that this function does all plane updates across all CRTCs in one step.
1226 * If the hardware can't support this approach look at
1227 * drm_atomic_helper_commit_planes_on_crtc() instead.
1229 * Plane parameters can be updated by applications while the associated CRTC is
1230 * disabled. The DRM/KMS core will store the parameters in the plane state,
1231 * which will be available to the driver when the CRTC is turned on. As a result
1232 * most drivers don't need to be immediately notified of plane updates for a
1235 * Unless otherwise needed, drivers are advised to set the @active_only
1236 * parameters to true in order not to receive plane update notifications related
1237 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1238 * driver code when the driver and/or hardware can't or just don't need to deal
1239 * with updates on disabled CRTCs, for example when supporting runtime PM.
1241 * The drm_atomic_helper_commit() default implementation only sets @active_only
1242 * to false to most closely match the behaviour of the legacy helpers. This should
1243 * not be copied blindly by drivers.
1245 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1246 struct drm_atomic_state *old_state,
1249 struct drm_crtc *crtc;
1250 struct drm_crtc_state *old_crtc_state;
1251 struct drm_plane *plane;
1252 struct drm_plane_state *old_plane_state;
1255 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1256 const struct drm_crtc_helper_funcs *funcs;
1258 funcs = crtc->helper_private;
1260 if (!funcs || !funcs->atomic_begin)
1263 if (active_only && !crtc->state->active)
1266 funcs->atomic_begin(crtc, old_crtc_state);
1269 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1270 const struct drm_plane_helper_funcs *funcs;
1273 funcs = plane->helper_private;
1278 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1282 * Skip planes related to inactive CRTCs. If the plane
1283 * is enabled use the state of the current CRTC. If the
1284 * plane is being disabled use the state of the old
1285 * CRTC to avoid skipping planes being disabled on an
1288 if (!disabling && !plane_crtc_active(plane->state))
1290 if (disabling && !plane_crtc_active(old_plane_state))
1295 * Special-case disabling the plane if drivers support it.
1297 if (disabling && funcs->atomic_disable)
1298 funcs->atomic_disable(plane, old_plane_state);
1299 else if (plane->state->crtc || disabling)
1300 funcs->atomic_update(plane, old_plane_state);
1303 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1304 const struct drm_crtc_helper_funcs *funcs;
1306 funcs = crtc->helper_private;
1308 if (!funcs || !funcs->atomic_flush)
1311 if (active_only && !crtc->state->active)
1314 funcs->atomic_flush(crtc, old_crtc_state);
1317 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1320 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1321 * @old_crtc_state: atomic state object with the old crtc state
1323 * This function commits the new plane state using the plane and atomic helper
1324 * functions for planes on the specific crtc. It assumes that the atomic state
1325 * has already been pushed into the relevant object state pointers, since this
1326 * step can no longer fail.
1328 * This function is useful when plane updates should be done crtc-by-crtc
1329 * instead of one global step like drm_atomic_helper_commit_planes() does.
1331 * This function can only be savely used when planes are not allowed to move
1332 * between different CRTCs because this function doesn't handle inter-CRTC
1333 * depencies. Callers need to ensure that either no such depencies exist,
1334 * resolve them through ordering of commit calls or through some other means.
1337 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1339 const struct drm_crtc_helper_funcs *crtc_funcs;
1340 struct drm_crtc *crtc = old_crtc_state->crtc;
1341 struct drm_atomic_state *old_state = old_crtc_state->state;
1342 struct drm_plane *plane;
1343 unsigned plane_mask;
1345 plane_mask = old_crtc_state->plane_mask;
1346 plane_mask |= crtc->state->plane_mask;
1348 crtc_funcs = crtc->helper_private;
1349 if (crtc_funcs && crtc_funcs->atomic_begin)
1350 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1352 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1353 struct drm_plane_state *old_plane_state =
1354 drm_atomic_get_existing_plane_state(old_state, plane);
1355 const struct drm_plane_helper_funcs *plane_funcs;
1357 plane_funcs = plane->helper_private;
1359 if (!old_plane_state || !plane_funcs)
1362 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1364 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1365 plane_funcs->atomic_disable)
1366 plane_funcs->atomic_disable(plane, old_plane_state);
1367 else if (plane->state->crtc ||
1368 drm_atomic_plane_disabling(plane, old_plane_state))
1369 plane_funcs->atomic_update(plane, old_plane_state);
1372 if (crtc_funcs && crtc_funcs->atomic_flush)
1373 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1375 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1378 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1380 * @old_state: atomic state object with old state structures
1382 * This function cleans up plane state, specifically framebuffers, from the old
1383 * configuration. Hence the old configuration must be perserved in @old_state to
1384 * be able to call this function.
1386 * This function must also be called on the new state when the atomic update
1387 * fails at any point after calling drm_atomic_helper_prepare_planes().
1389 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1390 struct drm_atomic_state *old_state)
1392 struct drm_plane *plane;
1393 struct drm_plane_state *plane_state;
1396 for_each_plane_in_state(old_state, plane, plane_state, i) {
1397 const struct drm_plane_helper_funcs *funcs;
1399 funcs = plane->helper_private;
1401 if (funcs->cleanup_fb)
1402 funcs->cleanup_fb(plane, plane_state);
1405 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1408 * drm_atomic_helper_swap_state - store atomic state into current sw state
1410 * @state: atomic state
1412 * This function stores the atomic state into the current state pointers in all
1413 * driver objects. It should be called after all failing steps have been done
1414 * and succeeded, but before the actual hardware state is committed.
1416 * For cleanup and error recovery the current state for all changed objects will
1417 * be swaped into @state.
1419 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1421 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1423 * 2. Do any other steps that might fail.
1425 * 3. Put the staged state into the current state pointers with this function.
1427 * 4. Actually commit the hardware state.
1429 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1430 * contains the old state. Also do any other cleanup required with that state.
1432 void drm_atomic_helper_swap_state(struct drm_device *dev,
1433 struct drm_atomic_state *state)
1437 for (i = 0; i < dev->mode_config.num_connector; i++) {
1438 struct drm_connector *connector = state->connectors[i];
1443 connector->state->state = state;
1444 swap(state->connector_states[i], connector->state);
1445 connector->state->state = NULL;
1448 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1449 struct drm_crtc *crtc = state->crtcs[i];
1454 crtc->state->state = state;
1455 swap(state->crtc_states[i], crtc->state);
1456 crtc->state->state = NULL;
1459 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1460 struct drm_plane *plane = state->planes[i];
1465 plane->state->state = state;
1466 swap(state->plane_states[i], plane->state);
1467 plane->state->state = NULL;
1470 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1473 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1474 * @plane: plane object to update
1475 * @crtc: owning CRTC of owning plane
1476 * @fb: framebuffer to flip onto plane
1477 * @crtc_x: x offset of primary plane on crtc
1478 * @crtc_y: y offset of primary plane on crtc
1479 * @crtc_w: width of primary plane rectangle on crtc
1480 * @crtc_h: height of primary plane rectangle on crtc
1481 * @src_x: x offset of @fb for panning
1482 * @src_y: y offset of @fb for panning
1483 * @src_w: width of source rectangle in @fb
1484 * @src_h: height of source rectangle in @fb
1486 * Provides a default plane update handler using the atomic driver interface.
1489 * Zero on success, error code on failure
1491 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1492 struct drm_crtc *crtc,
1493 struct drm_framebuffer *fb,
1494 int crtc_x, int crtc_y,
1495 unsigned int crtc_w, unsigned int crtc_h,
1496 uint32_t src_x, uint32_t src_y,
1497 uint32_t src_w, uint32_t src_h)
1499 struct drm_atomic_state *state;
1500 struct drm_plane_state *plane_state;
1503 state = drm_atomic_state_alloc(plane->dev);
1507 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1509 plane_state = drm_atomic_get_plane_state(state, plane);
1510 if (IS_ERR(plane_state)) {
1511 ret = PTR_ERR(plane_state);
1515 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1518 drm_atomic_set_fb_for_plane(plane_state, fb);
1519 plane_state->crtc_x = crtc_x;
1520 plane_state->crtc_y = crtc_y;
1521 plane_state->crtc_h = crtc_h;
1522 plane_state->crtc_w = crtc_w;
1523 plane_state->src_x = src_x;
1524 plane_state->src_y = src_y;
1525 plane_state->src_h = src_h;
1526 plane_state->src_w = src_w;
1528 state->legacy_cursor_update = true;
1530 ret = drm_atomic_commit(state);
1534 /* Driver takes ownership of state on successful commit. */
1537 if (ret == -EDEADLK)
1540 drm_atomic_state_free(state);
1544 drm_atomic_state_clear(state);
1545 drm_atomic_legacy_backoff(state);
1548 * Someone might have exchanged the framebuffer while we dropped locks
1549 * in the backoff code. We need to fix up the fb refcount tracking the
1552 plane->old_fb = plane->fb;
1556 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1559 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1560 * @plane: plane to disable
1562 * Provides a default plane disable handler using the atomic driver interface.
1565 * Zero on success, error code on failure
1567 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1569 struct drm_atomic_state *state;
1570 struct drm_plane_state *plane_state;
1574 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1575 * acquire context. The real fix will be to wire the acquire ctx through
1576 * everywhere we need it, but meanwhile prevent chaos by just skipping
1577 * this noop. The critical case is the cursor ioctls which a) only grab
1578 * crtc/cursor-plane locks (so we need the crtc to get at the right
1579 * acquire context) and b) can try to disable the plane multiple times.
1584 state = drm_atomic_state_alloc(plane->dev);
1588 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1590 plane_state = drm_atomic_get_plane_state(state, plane);
1591 if (IS_ERR(plane_state)) {
1592 ret = PTR_ERR(plane_state);
1596 plane_state->state->legacy_cursor_update = true;
1598 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1602 ret = drm_atomic_commit(state);
1606 /* Driver takes ownership of state on successful commit. */
1609 if (ret == -EDEADLK)
1612 drm_atomic_state_free(state);
1616 drm_atomic_state_clear(state);
1617 drm_atomic_legacy_backoff(state);
1620 * Someone might have exchanged the framebuffer while we dropped locks
1621 * in the backoff code. We need to fix up the fb refcount tracking the
1624 plane->old_fb = plane->fb;
1628 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1630 /* just used from fb-helper and atomic-helper: */
1631 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1632 struct drm_plane_state *plane_state)
1636 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1640 drm_atomic_set_fb_for_plane(plane_state, NULL);
1641 plane_state->crtc_x = 0;
1642 plane_state->crtc_y = 0;
1643 plane_state->crtc_h = 0;
1644 plane_state->crtc_w = 0;
1645 plane_state->src_x = 0;
1646 plane_state->src_y = 0;
1647 plane_state->src_h = 0;
1648 plane_state->src_w = 0;
1653 static int update_output_state(struct drm_atomic_state *state,
1654 struct drm_mode_set *set)
1656 struct drm_device *dev = set->crtc->dev;
1657 struct drm_crtc *crtc;
1658 struct drm_crtc_state *crtc_state;
1659 struct drm_connector *connector;
1660 struct drm_connector_state *conn_state;
1663 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1664 state->acquire_ctx);
1668 /* First grab all affected connector/crtc states. */
1669 for (i = 0; i < set->num_connectors; i++) {
1670 conn_state = drm_atomic_get_connector_state(state,
1671 set->connectors[i]);
1672 if (IS_ERR(conn_state))
1673 return PTR_ERR(conn_state);
1676 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1677 ret = drm_atomic_add_affected_connectors(state, crtc);
1682 /* Then recompute connector->crtc links and crtc enabling state. */
1683 for_each_connector_in_state(state, connector, conn_state, i) {
1684 if (conn_state->crtc == set->crtc) {
1685 ret = drm_atomic_set_crtc_for_connector(conn_state,
1691 for (j = 0; j < set->num_connectors; j++) {
1692 if (set->connectors[j] == connector) {
1693 ret = drm_atomic_set_crtc_for_connector(conn_state,
1702 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1703 /* Don't update ->enable for the CRTC in the set_config request,
1704 * since a mismatch would indicate a bug in the upper layers.
1705 * The actual modeset code later on will catch any
1706 * inconsistencies here. */
1707 if (crtc == set->crtc)
1710 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1711 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1716 crtc_state->active = false;
1724 * drm_atomic_helper_set_config - set a new config from userspace
1725 * @set: mode set configuration
1727 * Provides a default crtc set_config handler using the atomic driver interface.
1730 * Returns 0 on success, negative errno numbers on failure.
1732 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1734 struct drm_atomic_state *state;
1735 struct drm_crtc *crtc = set->crtc;
1738 state = drm_atomic_state_alloc(crtc->dev);
1742 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1744 ret = __drm_atomic_helper_set_config(set, state);
1748 ret = drm_atomic_commit(state);
1752 /* Driver takes ownership of state on successful commit. */
1755 if (ret == -EDEADLK)
1758 drm_atomic_state_free(state);
1762 drm_atomic_state_clear(state);
1763 drm_atomic_legacy_backoff(state);
1766 * Someone might have exchanged the framebuffer while we dropped locks
1767 * in the backoff code. We need to fix up the fb refcount tracking the
1770 crtc->primary->old_fb = crtc->primary->fb;
1774 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1776 /* just used from fb-helper and atomic-helper: */
1777 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1778 struct drm_atomic_state *state)
1780 struct drm_crtc_state *crtc_state;
1781 struct drm_plane_state *primary_state;
1782 struct drm_crtc *crtc = set->crtc;
1783 int hdisplay, vdisplay;
1786 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1787 if (IS_ERR(crtc_state))
1788 return PTR_ERR(crtc_state);
1790 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1791 if (IS_ERR(primary_state))
1792 return PTR_ERR(primary_state);
1796 WARN_ON(set->num_connectors);
1798 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1802 crtc_state->active = false;
1804 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1808 drm_atomic_set_fb_for_plane(primary_state, NULL);
1814 WARN_ON(!set->num_connectors);
1816 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1820 crtc_state->active = true;
1822 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1826 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1828 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1829 primary_state->crtc_x = 0;
1830 primary_state->crtc_y = 0;
1831 primary_state->crtc_h = vdisplay;
1832 primary_state->crtc_w = hdisplay;
1833 primary_state->src_x = set->x << 16;
1834 primary_state->src_y = set->y << 16;
1835 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1836 primary_state->src_h = hdisplay << 16;
1837 primary_state->src_w = vdisplay << 16;
1839 primary_state->src_h = vdisplay << 16;
1840 primary_state->src_w = hdisplay << 16;
1844 ret = update_output_state(state, set);
1852 * drm_atomic_helper_disable_all - disable all currently active outputs
1854 * @ctx: lock acquisition context
1856 * Loops through all connectors, finding those that aren't turned off and then
1857 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1858 * that they are connected to.
1860 * This is used for example in suspend/resume to disable all currently active
1861 * functions when suspending.
1863 * Note that if callers haven't already acquired all modeset locks this might
1864 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1867 * 0 on success or a negative error code on failure.
1870 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1872 int drm_atomic_helper_disable_all(struct drm_device *dev,
1873 struct drm_modeset_acquire_ctx *ctx)
1875 struct drm_atomic_state *state;
1876 struct drm_connector *conn;
1879 state = drm_atomic_state_alloc(dev);
1883 state->acquire_ctx = ctx;
1885 drm_for_each_connector(conn, dev) {
1886 struct drm_crtc *crtc = conn->state->crtc;
1887 struct drm_crtc_state *crtc_state;
1889 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
1892 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1893 if (IS_ERR(crtc_state)) {
1894 err = PTR_ERR(crtc_state);
1898 crtc_state->active = false;
1901 err = drm_atomic_commit(state);
1905 drm_atomic_state_free(state);
1909 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
1912 * drm_atomic_helper_suspend - subsystem-level suspend helper
1915 * Duplicates the current atomic state, disables all active outputs and then
1916 * returns a pointer to the original atomic state to the caller. Drivers can
1917 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
1918 * restore the output configuration that was active at the time the system
1921 * Note that it is potentially unsafe to use this. The atomic state object
1922 * returned by this function is assumed to be persistent. Drivers must ensure
1923 * that this holds true. Before calling this function, drivers must make sure
1924 * to suspend fbdev emulation so that nothing can be using the device.
1927 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
1928 * encoded error code on failure. Drivers should store the returned atomic
1929 * state object and pass it to the drm_atomic_helper_resume() helper upon
1933 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
1934 * drm_atomic_helper_resume()
1936 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
1938 struct drm_modeset_acquire_ctx ctx;
1939 struct drm_atomic_state *state;
1942 drm_modeset_acquire_init(&ctx, 0);
1945 err = drm_modeset_lock_all_ctx(dev, &ctx);
1947 state = ERR_PTR(err);
1951 state = drm_atomic_helper_duplicate_state(dev, &ctx);
1955 err = drm_atomic_helper_disable_all(dev, &ctx);
1957 drm_atomic_state_free(state);
1958 state = ERR_PTR(err);
1963 if (PTR_ERR(state) == -EDEADLK) {
1964 drm_modeset_backoff(&ctx);
1968 drm_modeset_drop_locks(&ctx);
1969 drm_modeset_acquire_fini(&ctx);
1972 EXPORT_SYMBOL(drm_atomic_helper_suspend);
1975 * drm_atomic_helper_resume - subsystem-level resume helper
1977 * @state: atomic state to resume to
1979 * Calls drm_mode_config_reset() to synchronize hardware and software states,
1980 * grabs all modeset locks and commits the atomic state object. This can be
1981 * used in conjunction with the drm_atomic_helper_suspend() helper to
1982 * implement suspend/resume for drivers that support atomic mode-setting.
1985 * 0 on success or a negative error code on failure.
1988 * drm_atomic_helper_suspend()
1990 int drm_atomic_helper_resume(struct drm_device *dev,
1991 struct drm_atomic_state *state)
1993 struct drm_mode_config *config = &dev->mode_config;
1996 drm_mode_config_reset(dev);
1997 drm_modeset_lock_all(dev);
1998 state->acquire_ctx = config->acquire_ctx;
1999 err = drm_atomic_commit(state);
2000 drm_modeset_unlock_all(dev);
2004 EXPORT_SYMBOL(drm_atomic_helper_resume);
2007 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2009 * @property: DRM property
2010 * @val: value of property
2012 * Provides a default crtc set_property handler using the atomic driver
2016 * Zero on success, error code on failure
2019 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2020 struct drm_property *property,
2023 struct drm_atomic_state *state;
2024 struct drm_crtc_state *crtc_state;
2027 state = drm_atomic_state_alloc(crtc->dev);
2031 /* ->set_property is always called with all locks held. */
2032 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2034 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2035 if (IS_ERR(crtc_state)) {
2036 ret = PTR_ERR(crtc_state);
2040 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2045 ret = drm_atomic_commit(state);
2049 /* Driver takes ownership of state on successful commit. */
2052 if (ret == -EDEADLK)
2055 drm_atomic_state_free(state);
2059 drm_atomic_state_clear(state);
2060 drm_atomic_legacy_backoff(state);
2064 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2067 * drm_atomic_helper_plane_set_property - helper for plane properties
2069 * @property: DRM property
2070 * @val: value of property
2072 * Provides a default plane set_property handler using the atomic driver
2076 * Zero on success, error code on failure
2079 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2080 struct drm_property *property,
2083 struct drm_atomic_state *state;
2084 struct drm_plane_state *plane_state;
2087 state = drm_atomic_state_alloc(plane->dev);
2091 /* ->set_property is always called with all locks held. */
2092 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2094 plane_state = drm_atomic_get_plane_state(state, plane);
2095 if (IS_ERR(plane_state)) {
2096 ret = PTR_ERR(plane_state);
2100 ret = drm_atomic_plane_set_property(plane, plane_state,
2105 ret = drm_atomic_commit(state);
2109 /* Driver takes ownership of state on successful commit. */
2112 if (ret == -EDEADLK)
2115 drm_atomic_state_free(state);
2119 drm_atomic_state_clear(state);
2120 drm_atomic_legacy_backoff(state);
2124 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2127 * drm_atomic_helper_connector_set_property - helper for connector properties
2128 * @connector: DRM connector
2129 * @property: DRM property
2130 * @val: value of property
2132 * Provides a default connector set_property handler using the atomic driver
2136 * Zero on success, error code on failure
2139 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2140 struct drm_property *property,
2143 struct drm_atomic_state *state;
2144 struct drm_connector_state *connector_state;
2147 state = drm_atomic_state_alloc(connector->dev);
2151 /* ->set_property is always called with all locks held. */
2152 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2154 connector_state = drm_atomic_get_connector_state(state, connector);
2155 if (IS_ERR(connector_state)) {
2156 ret = PTR_ERR(connector_state);
2160 ret = drm_atomic_connector_set_property(connector, connector_state,
2165 ret = drm_atomic_commit(state);
2169 /* Driver takes ownership of state on successful commit. */
2172 if (ret == -EDEADLK)
2175 drm_atomic_state_free(state);
2179 drm_atomic_state_clear(state);
2180 drm_atomic_legacy_backoff(state);
2184 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2187 * drm_atomic_helper_page_flip - execute a legacy page flip
2189 * @fb: DRM framebuffer
2190 * @event: optional DRM event to signal upon completion
2191 * @flags: flip flags for non-vblank sync'ed updates
2193 * Provides a default page flip implementation using the atomic driver interface.
2195 * Note that for now so called async page flips (i.e. updates which are not
2196 * synchronized to vblank) are not supported, since the atomic interfaces have
2197 * no provisions for this yet.
2200 * Returns 0 on success, negative errno numbers on failure.
2202 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2203 struct drm_framebuffer *fb,
2204 struct drm_pending_vblank_event *event,
2207 struct drm_plane *plane = crtc->primary;
2208 struct drm_atomic_state *state;
2209 struct drm_plane_state *plane_state;
2210 struct drm_crtc_state *crtc_state;
2213 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2216 state = drm_atomic_state_alloc(plane->dev);
2220 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2222 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2223 if (IS_ERR(crtc_state)) {
2224 ret = PTR_ERR(crtc_state);
2227 crtc_state->event = event;
2229 plane_state = drm_atomic_get_plane_state(state, plane);
2230 if (IS_ERR(plane_state)) {
2231 ret = PTR_ERR(plane_state);
2235 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2238 drm_atomic_set_fb_for_plane(plane_state, fb);
2240 ret = drm_atomic_async_commit(state);
2244 /* Driver takes ownership of state on successful async commit. */
2247 if (ret == -EDEADLK)
2250 drm_atomic_state_free(state);
2254 drm_atomic_state_clear(state);
2255 drm_atomic_legacy_backoff(state);
2258 * Someone might have exchanged the framebuffer while we dropped locks
2259 * in the backoff code. We need to fix up the fb refcount tracking the
2262 plane->old_fb = plane->fb;
2266 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2269 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2270 * @connector: affected connector
2273 * This is the main helper function provided by the atomic helper framework for
2274 * implementing the legacy DPMS connector interface. It computes the new desired
2275 * ->active state for the corresponding CRTC (if the connector is enabled) and
2279 * Returns 0 on success, negative errno numbers on failure.
2281 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2284 struct drm_mode_config *config = &connector->dev->mode_config;
2285 struct drm_atomic_state *state;
2286 struct drm_crtc_state *crtc_state;
2287 struct drm_crtc *crtc;
2288 struct drm_connector *tmp_connector;
2290 bool active = false;
2291 int old_mode = connector->dpms;
2293 if (mode != DRM_MODE_DPMS_ON)
2294 mode = DRM_MODE_DPMS_OFF;
2296 connector->dpms = mode;
2297 crtc = connector->state->crtc;
2302 state = drm_atomic_state_alloc(connector->dev);
2306 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2308 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2309 if (IS_ERR(crtc_state)) {
2310 ret = PTR_ERR(crtc_state);
2314 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2316 drm_for_each_connector(tmp_connector, connector->dev) {
2317 if (tmp_connector->state->crtc != crtc)
2320 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2325 crtc_state->active = active;
2327 ret = drm_atomic_commit(state);
2331 /* Driver takes ownership of state on successful commit. */
2334 if (ret == -EDEADLK)
2337 connector->dpms = old_mode;
2338 drm_atomic_state_free(state);
2342 drm_atomic_state_clear(state);
2343 drm_atomic_legacy_backoff(state);
2347 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2350 * DOC: atomic state reset and initialization
2352 * Both the drm core and the atomic helpers assume that there is always the full
2353 * and correct atomic software state for all connectors, CRTCs and planes
2354 * available. Which is a bit a problem on driver load and also after system
2355 * suspend. One way to solve this is to have a hardware state read-out
2356 * infrastructure which reconstructs the full software state (e.g. the i915
2359 * The simpler solution is to just reset the software state to everything off,
2360 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2361 * the atomic helpers provide default reset implementations for all hooks.
2365 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2368 * Resets the atomic state for @crtc by freeing the state pointer (which might
2369 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2371 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2374 drm_property_unreference_blob(crtc->state->mode_blob);
2375 drm_property_unreference_blob(crtc->state->degamma_lut);
2376 drm_property_unreference_blob(crtc->state->ctm);
2377 drm_property_unreference_blob(crtc->state->gamma_lut);
2380 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2383 crtc->state->crtc = crtc;
2385 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2388 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2389 * @crtc: CRTC object
2390 * @state: atomic CRTC state
2392 * Copies atomic state from a CRTC's current state and resets inferred values.
2393 * This is useful for drivers that subclass the CRTC state.
2395 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2396 struct drm_crtc_state *state)
2398 memcpy(state, crtc->state, sizeof(*state));
2400 if (state->mode_blob)
2401 drm_property_reference_blob(state->mode_blob);
2402 if (state->degamma_lut)
2403 drm_property_reference_blob(state->degamma_lut);
2405 drm_property_reference_blob(state->ctm);
2406 if (state->gamma_lut)
2407 drm_property_reference_blob(state->gamma_lut);
2408 state->mode_changed = false;
2409 state->active_changed = false;
2410 state->planes_changed = false;
2411 state->connectors_changed = false;
2412 state->color_mgmt_changed = false;
2413 state->event = NULL;
2415 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2418 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2421 * Default CRTC state duplicate hook for drivers which don't have their own
2422 * subclassed CRTC state structure.
2424 struct drm_crtc_state *
2425 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2427 struct drm_crtc_state *state;
2429 if (WARN_ON(!crtc->state))
2432 state = kmalloc(sizeof(*state), GFP_KERNEL);
2434 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2438 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2441 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2442 * @crtc: CRTC object
2443 * @state: CRTC state object to release
2445 * Releases all resources stored in the CRTC state without actually freeing
2446 * the memory of the CRTC state. This is useful for drivers that subclass the
2449 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2450 struct drm_crtc_state *state)
2452 drm_property_unreference_blob(state->mode_blob);
2453 drm_property_unreference_blob(state->degamma_lut);
2454 drm_property_unreference_blob(state->ctm);
2455 drm_property_unreference_blob(state->gamma_lut);
2457 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2460 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2462 * @state: CRTC state object to release
2464 * Default CRTC state destroy hook for drivers which don't have their own
2465 * subclassed CRTC state structure.
2467 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2468 struct drm_crtc_state *state)
2470 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2473 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2476 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2479 * Resets the atomic state for @plane by freeing the state pointer (which might
2480 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2482 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2484 if (plane->state && plane->state->fb)
2485 drm_framebuffer_unreference(plane->state->fb);
2487 kfree(plane->state);
2488 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2491 plane->state->plane = plane;
2493 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2496 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2497 * @plane: plane object
2498 * @state: atomic plane state
2500 * Copies atomic state from a plane's current state. This is useful for
2501 * drivers that subclass the plane state.
2503 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2504 struct drm_plane_state *state)
2506 memcpy(state, plane->state, sizeof(*state));
2509 drm_framebuffer_reference(state->fb);
2511 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2514 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2517 * Default plane state duplicate hook for drivers which don't have their own
2518 * subclassed plane state structure.
2520 struct drm_plane_state *
2521 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2523 struct drm_plane_state *state;
2525 if (WARN_ON(!plane->state))
2528 state = kmalloc(sizeof(*state), GFP_KERNEL);
2530 __drm_atomic_helper_plane_duplicate_state(plane, state);
2534 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2537 * __drm_atomic_helper_plane_destroy_state - release plane state
2538 * @plane: plane object
2539 * @state: plane state object to release
2541 * Releases all resources stored in the plane state without actually freeing
2542 * the memory of the plane state. This is useful for drivers that subclass the
2545 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2546 struct drm_plane_state *state)
2549 drm_framebuffer_unreference(state->fb);
2551 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2554 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2556 * @state: plane state object to release
2558 * Default plane state destroy hook for drivers which don't have their own
2559 * subclassed plane state structure.
2561 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2562 struct drm_plane_state *state)
2564 __drm_atomic_helper_plane_destroy_state(plane, state);
2567 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2570 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2571 * @connector: drm connector
2573 * Resets the atomic state for @connector by freeing the state pointer (which
2574 * might be NULL, e.g. at driver load time) and allocating a new empty state
2577 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2579 kfree(connector->state);
2580 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2582 if (connector->state)
2583 connector->state->connector = connector;
2585 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2588 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2589 * @connector: connector object
2590 * @state: atomic connector state
2592 * Copies atomic state from a connector's current state. This is useful for
2593 * drivers that subclass the connector state.
2596 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2597 struct drm_connector_state *state)
2599 memcpy(state, connector->state, sizeof(*state));
2601 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2604 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2605 * @connector: drm connector
2607 * Default connector state duplicate hook for drivers which don't have their own
2608 * subclassed connector state structure.
2610 struct drm_connector_state *
2611 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2613 struct drm_connector_state *state;
2615 if (WARN_ON(!connector->state))
2618 state = kmalloc(sizeof(*state), GFP_KERNEL);
2620 __drm_atomic_helper_connector_duplicate_state(connector, state);
2624 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2627 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2629 * @ctx: lock acquisition context
2631 * Makes a copy of the current atomic state by looping over all objects and
2632 * duplicating their respective states. This is used for example by suspend/
2633 * resume support code to save the state prior to suspend such that it can
2634 * be restored upon resume.
2636 * Note that this treats atomic state as persistent between save and restore.
2637 * Drivers must make sure that this is possible and won't result in confusion
2638 * or erroneous behaviour.
2640 * Note that if callers haven't already acquired all modeset locks this might
2641 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2644 * A pointer to the copy of the atomic state object on success or an
2645 * ERR_PTR()-encoded error code on failure.
2648 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2650 struct drm_atomic_state *
2651 drm_atomic_helper_duplicate_state(struct drm_device *dev,
2652 struct drm_modeset_acquire_ctx *ctx)
2654 struct drm_atomic_state *state;
2655 struct drm_connector *conn;
2656 struct drm_plane *plane;
2657 struct drm_crtc *crtc;
2660 state = drm_atomic_state_alloc(dev);
2662 return ERR_PTR(-ENOMEM);
2664 state->acquire_ctx = ctx;
2666 drm_for_each_crtc(crtc, dev) {
2667 struct drm_crtc_state *crtc_state;
2669 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2670 if (IS_ERR(crtc_state)) {
2671 err = PTR_ERR(crtc_state);
2676 drm_for_each_plane(plane, dev) {
2677 struct drm_plane_state *plane_state;
2679 plane_state = drm_atomic_get_plane_state(state, plane);
2680 if (IS_ERR(plane_state)) {
2681 err = PTR_ERR(plane_state);
2686 drm_for_each_connector(conn, dev) {
2687 struct drm_connector_state *conn_state;
2689 conn_state = drm_atomic_get_connector_state(state, conn);
2690 if (IS_ERR(conn_state)) {
2691 err = PTR_ERR(conn_state);
2696 /* clear the acquire context so that it isn't accidentally reused */
2697 state->acquire_ctx = NULL;
2701 drm_atomic_state_free(state);
2702 state = ERR_PTR(err);
2707 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2710 * __drm_atomic_helper_connector_destroy_state - release connector state
2711 * @connector: connector object
2712 * @state: connector state object to release
2714 * Releases all resources stored in the connector state without actually
2715 * freeing the memory of the connector state. This is useful for drivers that
2716 * subclass the connector state.
2719 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2720 struct drm_connector_state *state)
2723 * This is currently a placeholder so that drivers that subclass the
2724 * state will automatically do the right thing if code is ever added
2728 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2731 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2732 * @connector: drm connector
2733 * @state: connector state object to release
2735 * Default connector state destroy hook for drivers which don't have their own
2736 * subclassed connector state structure.
2738 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2739 struct drm_connector_state *state)
2741 __drm_atomic_helper_connector_destroy_state(connector, state);
2744 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2747 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2748 * @crtc: CRTC object
2749 * @red: red correction table
2750 * @green: green correction table
2751 * @blue: green correction table
2753 * @size: size of the tables
2755 * Implements support for legacy gamma correction table for drivers
2756 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2759 void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2760 u16 *red, u16 *green, u16 *blue,
2761 uint32_t start, uint32_t size)
2763 struct drm_device *dev = crtc->dev;
2764 struct drm_mode_config *config = &dev->mode_config;
2765 struct drm_atomic_state *state;
2766 struct drm_crtc_state *crtc_state;
2767 struct drm_property_blob *blob = NULL;
2768 struct drm_color_lut *blob_data;
2771 state = drm_atomic_state_alloc(crtc->dev);
2775 blob = drm_property_create_blob(dev,
2776 sizeof(struct drm_color_lut) * size,
2783 /* Prepare GAMMA_LUT with the legacy values. */
2784 blob_data = (struct drm_color_lut *) blob->data;
2785 for (i = 0; i < size; i++) {
2786 blob_data[i].red = red[i];
2787 blob_data[i].green = green[i];
2788 blob_data[i].blue = blue[i];
2791 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2793 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2794 if (IS_ERR(crtc_state)) {
2795 ret = PTR_ERR(crtc_state);
2799 /* Reset DEGAMMA_LUT and CTM properties. */
2800 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2801 config->degamma_lut_property, 0);
2805 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2806 config->ctm_property, 0);
2810 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2811 config->gamma_lut_property, blob->base.id);
2815 ret = drm_atomic_commit(state);
2819 /* Driver takes ownership of state on successful commit. */
2821 drm_property_unreference_blob(blob);
2825 if (ret == -EDEADLK)
2828 drm_atomic_state_free(state);
2829 drm_property_unreference_blob(blob);
2833 drm_atomic_state_clear(state);
2834 drm_atomic_legacy_backoff(state);
2838 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);