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 expose
47 * 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;
114 * We can only steal an encoder coming from a connector, which means we
115 * must already hold the connection_mutex.
117 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
119 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
120 encoder->base.id, encoder->name,
121 encoder_crtc->base.id);
123 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
124 if (IS_ERR(crtc_state))
125 return PTR_ERR(crtc_state);
127 crtc_state->connectors_changed = true;
129 list_for_each_entry(connector, &config->connector_list, head) {
130 if (connector->state->best_encoder != encoder)
133 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
137 connector_state = drm_atomic_get_connector_state(state,
139 if (IS_ERR(connector_state))
140 return PTR_ERR(connector_state);
142 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
145 connector_state->best_encoder = NULL;
152 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
154 const struct drm_connector_helper_funcs *funcs;
155 struct drm_encoder *new_encoder;
156 struct drm_crtc *encoder_crtc;
157 struct drm_connector *connector;
158 struct drm_connector_state *connector_state;
159 struct drm_crtc_state *crtc_state;
162 connector = state->connectors[conn_idx];
163 connector_state = state->connector_states[conn_idx];
168 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
172 if (connector->state->crtc != connector_state->crtc) {
173 if (connector->state->crtc) {
174 idx = drm_crtc_index(connector->state->crtc);
176 crtc_state = state->crtc_states[idx];
177 crtc_state->connectors_changed = true;
180 if (connector_state->crtc) {
181 idx = drm_crtc_index(connector_state->crtc);
183 crtc_state = state->crtc_states[idx];
184 crtc_state->connectors_changed = true;
188 if (!connector_state->crtc) {
189 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
193 connector_state->best_encoder = NULL;
198 funcs = connector->helper_private;
199 new_encoder = funcs->best_encoder(connector);
202 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
208 if (new_encoder == connector_state->best_encoder) {
209 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
212 new_encoder->base.id,
214 connector_state->crtc->base.id);
219 encoder_crtc = get_current_crtc_for_encoder(state->dev,
223 ret = steal_encoder(state, new_encoder, encoder_crtc);
225 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
232 connector_state->best_encoder = new_encoder;
233 idx = drm_crtc_index(connector_state->crtc);
235 crtc_state = state->crtc_states[idx];
236 crtc_state->connectors_changed = true;
238 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
241 new_encoder->base.id,
243 connector_state->crtc->base.id);
249 mode_fixup(struct drm_atomic_state *state)
251 struct drm_crtc *crtc;
252 struct drm_crtc_state *crtc_state;
253 struct drm_connector *connector;
254 struct drm_connector_state *conn_state;
258 for_each_crtc_in_state(state, crtc, crtc_state, i) {
259 if (!crtc_state->mode_changed &&
260 !crtc_state->connectors_changed)
263 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
266 for_each_connector_in_state(state, connector, conn_state, i) {
267 const struct drm_encoder_helper_funcs *funcs;
268 struct drm_encoder *encoder;
270 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
272 if (!conn_state->crtc || !conn_state->best_encoder)
276 state->crtc_states[drm_crtc_index(conn_state->crtc)];
279 * Each encoder has at most one connector (since we always steal
280 * it away), so we won't call ->mode_fixup twice.
282 encoder = conn_state->best_encoder;
283 funcs = encoder->helper_private;
287 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
288 &crtc_state->adjusted_mode);
290 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
294 if (funcs->atomic_check) {
295 ret = funcs->atomic_check(encoder, crtc_state,
298 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
299 encoder->base.id, encoder->name);
303 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
304 &crtc_state->adjusted_mode);
306 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
307 encoder->base.id, encoder->name);
313 for_each_crtc_in_state(state, crtc, crtc_state, i) {
314 const struct drm_crtc_helper_funcs *funcs;
316 if (!crtc_state->mode_changed &&
317 !crtc_state->connectors_changed)
320 funcs = crtc->helper_private;
321 if (!funcs->mode_fixup)
324 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
325 &crtc_state->adjusted_mode);
327 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
337 * drm_atomic_helper_check_modeset - validate state object for modeset changes
339 * @state: the driver state object
341 * Check the state object to see if the requested state is physically possible.
342 * This does all the crtc and connector related computations for an atomic
343 * update and adds any additional connectors needed for full modesets and calls
344 * down into ->mode_fixup functions of the driver backend.
346 * crtc_state->mode_changed is set when the input mode is changed.
347 * crtc_state->connectors_changed is set when a connector is added or
348 * removed from the crtc.
349 * crtc_state->active_changed is set when crtc_state->active changes,
350 * which is used for dpms.
354 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
355 * plane update can't be done without a full modeset) _must_ call this function
356 * afterwards after that change. It is permitted to call this function multiple
357 * times for the same update, e.g. when the ->atomic_check functions depend upon
358 * the adjusted dotclock for fifo space allocation and watermark computation.
361 * Zero for success or -errno
364 drm_atomic_helper_check_modeset(struct drm_device *dev,
365 struct drm_atomic_state *state)
367 struct drm_crtc *crtc;
368 struct drm_crtc_state *crtc_state;
369 struct drm_connector *connector;
370 struct drm_connector_state *connector_state;
373 for_each_crtc_in_state(state, crtc, crtc_state, i) {
374 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
375 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
377 crtc_state->mode_changed = true;
380 if (crtc->state->enable != crtc_state->enable) {
381 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
385 * For clarity this assignment is done here, but
386 * enable == 0 is only true when there are no
387 * connectors and a NULL mode.
389 * The other way around is true as well. enable != 0
390 * iff connectors are attached and a mode is set.
392 crtc_state->mode_changed = true;
393 crtc_state->connectors_changed = true;
397 for_each_connector_in_state(state, connector, connector_state, i) {
399 * This only sets crtc->mode_changed for routing changes,
400 * drivers must set crtc->mode_changed themselves when connector
401 * properties need to be updated.
403 ret = update_connector_routing(state, i);
409 * After all the routing has been prepared we need to add in any
410 * connector which is itself unchanged, but who's crtc changes it's
411 * configuration. This must be done before calling mode_fixup in case a
412 * crtc only changed its mode but has the same set of connectors.
414 for_each_crtc_in_state(state, crtc, crtc_state, i) {
418 * We must set ->active_changed after walking connectors for
419 * otherwise an update that only changes active would result in
420 * a full modeset because update_connector_routing force that.
422 if (crtc->state->active != crtc_state->active) {
423 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
425 crtc_state->active_changed = true;
428 if (!drm_atomic_crtc_needs_modeset(crtc_state))
431 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
433 crtc_state->enable ? 'y' : 'n',
434 crtc_state->active ? 'y' : 'n');
436 ret = drm_atomic_add_affected_connectors(state, crtc);
440 ret = drm_atomic_add_affected_planes(state, crtc);
444 num_connectors = drm_atomic_connectors_for_crtc(state,
447 if (crtc_state->enable != !!num_connectors) {
448 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
455 return mode_fixup(state);
457 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
460 * drm_atomic_helper_check_planes - validate state object for planes changes
462 * @state: the driver state object
464 * Check the state object to see if the requested state is physically possible.
465 * This does all the plane update related checks using by calling into the
466 * ->atomic_check hooks provided by the driver.
468 * It also sets crtc_state->planes_changed to indicate that a crtc has
472 * Zero for success or -errno
475 drm_atomic_helper_check_planes(struct drm_device *dev,
476 struct drm_atomic_state *state)
478 struct drm_crtc *crtc;
479 struct drm_crtc_state *crtc_state;
480 struct drm_plane *plane;
481 struct drm_plane_state *plane_state;
484 for_each_plane_in_state(state, plane, plane_state, i) {
485 const struct drm_plane_helper_funcs *funcs;
487 funcs = plane->helper_private;
489 drm_atomic_helper_plane_changed(state, plane_state, plane);
491 if (!funcs || !funcs->atomic_check)
494 ret = funcs->atomic_check(plane, plane_state);
496 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
502 for_each_crtc_in_state(state, crtc, crtc_state, i) {
503 const struct drm_crtc_helper_funcs *funcs;
505 funcs = crtc->helper_private;
507 if (!funcs || !funcs->atomic_check)
510 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
512 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
520 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
523 * drm_atomic_helper_check - validate state object
525 * @state: the driver state object
527 * Check the state object to see if the requested state is physically possible.
528 * Only crtcs and planes have check callbacks, so for any additional (global)
529 * checking that a driver needs it can simply wrap that around this function.
530 * Drivers without such needs can directly use this as their ->atomic_check()
533 * This just wraps the two parts of the state checking for planes and modeset
534 * state in the default order: First it calls drm_atomic_helper_check_modeset()
535 * and then drm_atomic_helper_check_planes(). The assumption is that the
536 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
537 * e.g. properly compute watermarks.
540 * Zero for success or -errno
542 int drm_atomic_helper_check(struct drm_device *dev,
543 struct drm_atomic_state *state)
547 ret = drm_atomic_helper_check_modeset(dev, state);
551 ret = drm_atomic_helper_check_planes(dev, state);
557 EXPORT_SYMBOL(drm_atomic_helper_check);
560 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
562 struct drm_connector *connector;
563 struct drm_connector_state *old_conn_state;
564 struct drm_crtc *crtc;
565 struct drm_crtc_state *old_crtc_state;
568 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
569 const struct drm_encoder_helper_funcs *funcs;
570 struct drm_encoder *encoder;
571 struct drm_crtc_state *old_crtc_state;
573 /* Shut down everything that's in the changeset and currently
574 * still on. So need to check the old, saved state. */
575 if (!old_conn_state->crtc)
578 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
580 if (!old_crtc_state->active ||
581 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
584 encoder = old_conn_state->best_encoder;
586 /* We shouldn't get this far if we didn't previously have
587 * an encoder.. but WARN_ON() rather than explode.
589 if (WARN_ON(!encoder))
592 funcs = encoder->helper_private;
594 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
595 encoder->base.id, encoder->name);
598 * Each encoder has at most one connector (since we always steal
599 * it away), so we won't call disable hooks twice.
601 drm_bridge_disable(encoder->bridge);
603 /* Right function depends upon target state. */
604 if (connector->state->crtc && funcs->prepare)
605 funcs->prepare(encoder);
606 else if (funcs->disable)
607 funcs->disable(encoder);
609 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
611 drm_bridge_post_disable(encoder->bridge);
614 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
615 const struct drm_crtc_helper_funcs *funcs;
617 /* Shut down everything that needs a full modeset. */
618 if (!drm_atomic_crtc_needs_modeset(crtc->state))
621 if (!old_crtc_state->active)
624 funcs = crtc->helper_private;
626 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
630 /* Right function depends upon target state. */
631 if (crtc->state->enable && funcs->prepare)
632 funcs->prepare(crtc);
633 else if (funcs->disable)
634 funcs->disable(crtc);
636 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
641 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
643 * @old_state: atomic state object with old state structures
645 * This function updates all the various legacy modeset state pointers in
646 * connectors, encoders and crtcs. It also updates the timestamping constants
647 * used for precise vblank timestamps by calling
648 * drm_calc_timestamping_constants().
650 * Drivers can use this for building their own atomic commit if they don't have
651 * a pure helper-based modeset implementation.
654 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
655 struct drm_atomic_state *old_state)
657 struct drm_connector *connector;
658 struct drm_connector_state *old_conn_state;
659 struct drm_crtc *crtc;
660 struct drm_crtc_state *old_crtc_state;
663 /* clear out existing links */
664 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
665 if (!connector->encoder)
668 WARN_ON(!connector->encoder->crtc);
670 connector->encoder->crtc = NULL;
671 connector->encoder = NULL;
675 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
676 if (!connector->state->crtc)
679 if (WARN_ON(!connector->state->best_encoder))
682 connector->encoder = connector->state->best_encoder;
683 connector->encoder->crtc = connector->state->crtc;
686 /* set legacy state in the crtc structure */
687 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
688 struct drm_plane *primary = crtc->primary;
690 crtc->mode = crtc->state->mode;
691 crtc->enabled = crtc->state->enable;
693 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
694 primary->state->crtc == crtc) {
695 crtc->x = primary->state->src_x >> 16;
696 crtc->y = primary->state->src_y >> 16;
699 if (crtc->state->enable)
700 drm_calc_timestamping_constants(crtc,
701 &crtc->state->adjusted_mode);
704 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
707 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
709 struct drm_crtc *crtc;
710 struct drm_crtc_state *old_crtc_state;
711 struct drm_connector *connector;
712 struct drm_connector_state *old_conn_state;
715 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
716 const struct drm_crtc_helper_funcs *funcs;
718 if (!crtc->state->mode_changed)
721 funcs = crtc->helper_private;
723 if (crtc->state->enable && funcs->mode_set_nofb) {
724 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
727 funcs->mode_set_nofb(crtc);
731 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
732 const struct drm_encoder_helper_funcs *funcs;
733 struct drm_crtc_state *new_crtc_state;
734 struct drm_encoder *encoder;
735 struct drm_display_mode *mode, *adjusted_mode;
737 if (!connector->state->best_encoder)
740 encoder = connector->state->best_encoder;
741 funcs = encoder->helper_private;
742 new_crtc_state = connector->state->crtc->state;
743 mode = &new_crtc_state->mode;
744 adjusted_mode = &new_crtc_state->adjusted_mode;
746 if (!new_crtc_state->mode_changed)
749 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
750 encoder->base.id, encoder->name);
753 * Each encoder has at most one connector (since we always steal
754 * it away), so we won't call mode_set hooks twice.
757 funcs->mode_set(encoder, mode, adjusted_mode);
759 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
764 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
766 * @old_state: atomic state object with old state structures
768 * This function shuts down all the outputs that need to be shut down and
769 * prepares them (if required) with the new mode.
771 * For compatability with legacy crtc helpers this should be called before
772 * drm_atomic_helper_commit_planes(), which is what the default commit function
773 * does. But drivers with different needs can group the modeset commits together
774 * and do the plane commits at the end. This is useful for drivers doing runtime
775 * PM since planes updates then only happen when the CRTC is actually enabled.
777 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
778 struct drm_atomic_state *old_state)
780 disable_outputs(dev, old_state);
782 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
784 crtc_set_mode(dev, old_state);
786 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
789 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
791 * @old_state: atomic state object with old state structures
793 * This function enables all the outputs with the new configuration which had to
794 * be turned off for the update.
796 * For compatability with legacy crtc helpers this should be called after
797 * drm_atomic_helper_commit_planes(), which is what the default commit function
798 * does. But drivers with different needs can group the modeset commits together
799 * and do the plane commits at the end. This is useful for drivers doing runtime
800 * PM since planes updates then only happen when the CRTC is actually enabled.
802 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
803 struct drm_atomic_state *old_state)
805 struct drm_crtc *crtc;
806 struct drm_crtc_state *old_crtc_state;
807 struct drm_connector *connector;
808 struct drm_connector_state *old_conn_state;
811 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
812 const struct drm_crtc_helper_funcs *funcs;
814 /* Need to filter out CRTCs where only planes change. */
815 if (!drm_atomic_crtc_needs_modeset(crtc->state))
818 if (!crtc->state->active)
821 funcs = crtc->helper_private;
823 if (crtc->state->enable) {
824 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
834 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
835 const struct drm_encoder_helper_funcs *funcs;
836 struct drm_encoder *encoder;
838 if (!connector->state->best_encoder)
841 if (!connector->state->crtc->state->active ||
842 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
845 encoder = connector->state->best_encoder;
846 funcs = encoder->helper_private;
848 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
849 encoder->base.id, encoder->name);
852 * Each encoder has at most one connector (since we always steal
853 * it away), so we won't call enable hooks twice.
855 drm_bridge_pre_enable(encoder->bridge);
858 funcs->enable(encoder);
860 funcs->commit(encoder);
862 drm_bridge_enable(encoder->bridge);
865 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
867 static void wait_for_fences(struct drm_device *dev,
868 struct drm_atomic_state *state)
870 struct drm_plane *plane;
871 struct drm_plane_state *plane_state;
874 for_each_plane_in_state(state, plane, plane_state, i) {
875 if (!plane->state->fence)
878 WARN_ON(!plane->state->fb);
880 fence_wait(plane->state->fence, false);
881 fence_put(plane->state->fence);
882 plane->state->fence = NULL;
886 static bool framebuffer_changed(struct drm_device *dev,
887 struct drm_atomic_state *old_state,
888 struct drm_crtc *crtc)
890 struct drm_plane *plane;
891 struct drm_plane_state *old_plane_state;
894 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
895 if (plane->state->crtc != crtc &&
896 old_plane_state->crtc != crtc)
899 if (plane->state->fb != old_plane_state->fb)
907 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
909 * @old_state: atomic state object with old state structures
911 * Helper to, after atomic commit, wait for vblanks on all effected
912 * crtcs (ie. before cleaning up old framebuffers using
913 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
914 * framebuffers have actually changed to optimize for the legacy cursor and
915 * plane update use-case.
918 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
919 struct drm_atomic_state *old_state)
921 struct drm_crtc *crtc;
922 struct drm_crtc_state *old_crtc_state;
925 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
926 /* No one cares about the old state, so abuse it for tracking
927 * and store whether we hold a vblank reference (and should do a
928 * vblank wait) in the ->enable boolean. */
929 old_crtc_state->enable = false;
931 if (!crtc->state->enable)
934 /* Legacy cursor ioctls are completely unsynced, and userspace
935 * relies on that (by doing tons of cursor updates). */
936 if (old_state->legacy_cursor_update)
939 if (!framebuffer_changed(dev, old_state, crtc))
942 ret = drm_crtc_vblank_get(crtc);
946 old_crtc_state->enable = true;
947 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
950 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
951 if (!old_crtc_state->enable)
954 ret = wait_event_timeout(dev->vblank[i].queue,
955 old_crtc_state->last_vblank_count !=
956 drm_vblank_count(dev, i),
957 msecs_to_jiffies(50));
959 drm_crtc_vblank_put(crtc);
962 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
965 * drm_atomic_helper_commit - commit validated state object
967 * @state: the driver state object
968 * @async: asynchronous commit
970 * This function commits a with drm_atomic_helper_check() pre-validated state
971 * object. This can still fail when e.g. the framebuffer reservation fails. For
972 * now this doesn't implement asynchronous commits.
975 * Zero for success or -errno.
977 int drm_atomic_helper_commit(struct drm_device *dev,
978 struct drm_atomic_state *state,
986 ret = drm_atomic_helper_prepare_planes(dev, state);
991 * This is the point of no return - everything below never fails except
992 * when the hw goes bonghits. Which means we can commit the new state on
993 * the software side now.
996 drm_atomic_helper_swap_state(dev, state);
999 * Everything below can be run asynchronously without the need to grab
1000 * any modeset locks at all under one condition: It must be guaranteed
1001 * that the asynchronous work has either been cancelled (if the driver
1002 * supports it, which at least requires that the framebuffers get
1003 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1004 * before the new state gets committed on the software side with
1005 * drm_atomic_helper_swap_state().
1007 * This scheme allows new atomic state updates to be prepared and
1008 * checked in parallel to the asynchronous completion of the previous
1009 * update. Which is important since compositors need to figure out the
1010 * composition of the next frame right after having submitted the
1014 wait_for_fences(dev, state);
1016 drm_atomic_helper_commit_modeset_disables(dev, state);
1018 drm_atomic_helper_commit_planes(dev, state);
1020 drm_atomic_helper_commit_modeset_enables(dev, state);
1022 drm_atomic_helper_wait_for_vblanks(dev, state);
1024 drm_atomic_helper_cleanup_planes(dev, state);
1026 drm_atomic_state_free(state);
1030 EXPORT_SYMBOL(drm_atomic_helper_commit);
1033 * DOC: implementing async commit
1035 * For now the atomic helpers don't support async commit directly. If there is
1036 * real need it could be added though, using the dma-buf fence infrastructure
1037 * for generic synchronization with outstanding rendering.
1039 * For now drivers have to implement async commit themselves, with the following
1040 * sequence being the recommended one:
1042 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1043 * which commit needs to call which can fail, so we want to run it first and
1046 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1047 * might be affected the new state update. This can be done by either cancelling
1048 * or flushing the work items, depending upon whether the driver can deal with
1049 * cancelled updates. Note that it is important to ensure that the framebuffer
1050 * cleanup is still done when cancelling.
1052 * For sufficient parallelism it is recommended to have a work item per crtc
1053 * (for updates which don't touch global state) and a global one. Then we only
1054 * need to synchronize with the crtc work items for changed crtcs and the global
1055 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1057 * 3. The software state is updated synchronously with
1058 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1059 * locks means concurrent callers never see inconsistent state. And doing this
1060 * while it's guaranteed that no relevant async worker runs means that async
1061 * workers do not need grab any locks. Actually they must not grab locks, for
1062 * otherwise the work flushing will deadlock.
1064 * 4. Schedule a work item to do all subsequent steps, using the split-out
1065 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1066 * then cleaning up the framebuffers after the old framebuffer is no longer
1071 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1073 * @state: atomic state object with new state structures
1075 * This function prepares plane state, specifically framebuffers, for the new
1076 * configuration. If any failure is encountered this function will call
1077 * ->cleanup_fb on any already successfully prepared framebuffer.
1080 * 0 on success, negative error code on failure.
1082 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1083 struct drm_atomic_state *state)
1085 int nplanes = dev->mode_config.num_total_plane;
1088 for (i = 0; i < nplanes; i++) {
1089 const struct drm_plane_helper_funcs *funcs;
1090 struct drm_plane *plane = state->planes[i];
1091 struct drm_plane_state *plane_state = state->plane_states[i];
1092 struct drm_framebuffer *fb;
1097 funcs = plane->helper_private;
1099 fb = plane_state->fb;
1101 if (fb && funcs->prepare_fb) {
1102 ret = funcs->prepare_fb(plane, fb, plane_state);
1111 for (i--; i >= 0; i--) {
1112 const struct drm_plane_helper_funcs *funcs;
1113 struct drm_plane *plane = state->planes[i];
1114 struct drm_plane_state *plane_state = state->plane_states[i];
1115 struct drm_framebuffer *fb;
1120 funcs = plane->helper_private;
1122 fb = state->plane_states[i]->fb;
1124 if (fb && funcs->cleanup_fb)
1125 funcs->cleanup_fb(plane, fb, plane_state);
1131 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1134 * drm_atomic_helper_commit_planes - commit plane state
1136 * @old_state: atomic state object with old state structures
1138 * This function commits the new plane state using the plane and atomic helper
1139 * functions for planes and crtcs. It assumes that the atomic state has already
1140 * been pushed into the relevant object state pointers, since this step can no
1143 * It still requires the global state object @old_state to know which planes and
1144 * crtcs need to be updated though.
1146 * Note that this function does all plane updates across all CRTCs in one step.
1147 * If the hardware can't support this approach look at
1148 * drm_atomic_helper_commit_planes_on_crtc() instead.
1150 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1151 struct drm_atomic_state *old_state)
1153 struct drm_crtc *crtc;
1154 struct drm_crtc_state *old_crtc_state;
1155 struct drm_plane *plane;
1156 struct drm_plane_state *old_plane_state;
1159 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1160 const struct drm_crtc_helper_funcs *funcs;
1162 funcs = crtc->helper_private;
1164 if (!funcs || !funcs->atomic_begin)
1167 funcs->atomic_begin(crtc, old_crtc_state);
1170 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1171 const struct drm_plane_helper_funcs *funcs;
1173 funcs = plane->helper_private;
1179 * Special-case disabling the plane if drivers support it.
1181 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1182 funcs->atomic_disable)
1183 funcs->atomic_disable(plane, old_plane_state);
1184 else if (plane->state->crtc ||
1185 drm_atomic_plane_disabling(plane, old_plane_state))
1186 funcs->atomic_update(plane, old_plane_state);
1189 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1190 const struct drm_crtc_helper_funcs *funcs;
1192 funcs = crtc->helper_private;
1194 if (!funcs || !funcs->atomic_flush)
1197 funcs->atomic_flush(crtc, old_crtc_state);
1200 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1203 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1204 * @old_crtc_state: atomic state object with the old crtc state
1206 * This function commits the new plane state using the plane and atomic helper
1207 * functions for planes on the specific crtc. It assumes that the atomic state
1208 * has already been pushed into the relevant object state pointers, since this
1209 * step can no longer fail.
1211 * This function is useful when plane updates should be done crtc-by-crtc
1212 * instead of one global step like drm_atomic_helper_commit_planes() does.
1214 * This function can only be savely used when planes are not allowed to move
1215 * between different CRTCs because this function doesn't handle inter-CRTC
1216 * depencies. Callers need to ensure that either no such depencies exist,
1217 * resolve them through ordering of commit calls or through some other means.
1220 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1222 const struct drm_crtc_helper_funcs *crtc_funcs;
1223 struct drm_crtc *crtc = old_crtc_state->crtc;
1224 struct drm_atomic_state *old_state = old_crtc_state->state;
1225 struct drm_plane *plane;
1226 unsigned plane_mask;
1228 plane_mask = old_crtc_state->plane_mask;
1229 plane_mask |= crtc->state->plane_mask;
1231 crtc_funcs = crtc->helper_private;
1232 if (crtc_funcs && crtc_funcs->atomic_begin)
1233 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1235 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1236 struct drm_plane_state *old_plane_state =
1237 drm_atomic_get_existing_plane_state(old_state, plane);
1238 const struct drm_plane_helper_funcs *plane_funcs;
1240 plane_funcs = plane->helper_private;
1242 if (!old_plane_state || !plane_funcs)
1245 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1247 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1248 plane_funcs->atomic_disable)
1249 plane_funcs->atomic_disable(plane, old_plane_state);
1250 else if (plane->state->crtc ||
1251 drm_atomic_plane_disabling(plane, old_plane_state))
1252 plane_funcs->atomic_update(plane, old_plane_state);
1255 if (crtc_funcs && crtc_funcs->atomic_flush)
1256 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1258 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1261 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1263 * @old_state: atomic state object with old state structures
1265 * This function cleans up plane state, specifically framebuffers, from the old
1266 * configuration. Hence the old configuration must be perserved in @old_state to
1267 * be able to call this function.
1269 * This function must also be called on the new state when the atomic update
1270 * fails at any point after calling drm_atomic_helper_prepare_planes().
1272 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1273 struct drm_atomic_state *old_state)
1275 struct drm_plane *plane;
1276 struct drm_plane_state *plane_state;
1279 for_each_plane_in_state(old_state, plane, plane_state, i) {
1280 const struct drm_plane_helper_funcs *funcs;
1281 struct drm_framebuffer *old_fb;
1283 funcs = plane->helper_private;
1285 old_fb = plane_state->fb;
1287 if (old_fb && funcs->cleanup_fb)
1288 funcs->cleanup_fb(plane, old_fb, plane_state);
1291 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1294 * drm_atomic_helper_swap_state - store atomic state into current sw state
1296 * @state: atomic state
1298 * This function stores the atomic state into the current state pointers in all
1299 * driver objects. It should be called after all failing steps have been done
1300 * and succeeded, but before the actual hardware state is committed.
1302 * For cleanup and error recovery the current state for all changed objects will
1303 * be swaped into @state.
1305 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1307 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1309 * 2. Do any other steps that might fail.
1311 * 3. Put the staged state into the current state pointers with this function.
1313 * 4. Actually commit the hardware state.
1315 * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1316 * contains the old state. Also do any other cleanup required with that state.
1318 void drm_atomic_helper_swap_state(struct drm_device *dev,
1319 struct drm_atomic_state *state)
1323 for (i = 0; i < dev->mode_config.num_connector; i++) {
1324 struct drm_connector *connector = state->connectors[i];
1329 connector->state->state = state;
1330 swap(state->connector_states[i], connector->state);
1331 connector->state->state = NULL;
1334 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1335 struct drm_crtc *crtc = state->crtcs[i];
1340 crtc->state->state = state;
1341 swap(state->crtc_states[i], crtc->state);
1342 crtc->state->state = NULL;
1345 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1346 struct drm_plane *plane = state->planes[i];
1351 plane->state->state = state;
1352 swap(state->plane_states[i], plane->state);
1353 plane->state->state = NULL;
1356 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1359 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1360 * @plane: plane object to update
1361 * @crtc: owning CRTC of owning plane
1362 * @fb: framebuffer to flip onto plane
1363 * @crtc_x: x offset of primary plane on crtc
1364 * @crtc_y: y offset of primary plane on crtc
1365 * @crtc_w: width of primary plane rectangle on crtc
1366 * @crtc_h: height of primary plane rectangle on crtc
1367 * @src_x: x offset of @fb for panning
1368 * @src_y: y offset of @fb for panning
1369 * @src_w: width of source rectangle in @fb
1370 * @src_h: height of source rectangle in @fb
1372 * Provides a default plane update handler using the atomic driver interface.
1375 * Zero on success, error code on failure
1377 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1378 struct drm_crtc *crtc,
1379 struct drm_framebuffer *fb,
1380 int crtc_x, int crtc_y,
1381 unsigned int crtc_w, unsigned int crtc_h,
1382 uint32_t src_x, uint32_t src_y,
1383 uint32_t src_w, uint32_t src_h)
1385 struct drm_atomic_state *state;
1386 struct drm_plane_state *plane_state;
1389 state = drm_atomic_state_alloc(plane->dev);
1393 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1395 plane_state = drm_atomic_get_plane_state(state, plane);
1396 if (IS_ERR(plane_state)) {
1397 ret = PTR_ERR(plane_state);
1401 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1404 drm_atomic_set_fb_for_plane(plane_state, fb);
1405 plane_state->crtc_x = crtc_x;
1406 plane_state->crtc_y = crtc_y;
1407 plane_state->crtc_h = crtc_h;
1408 plane_state->crtc_w = crtc_w;
1409 plane_state->src_x = src_x;
1410 plane_state->src_y = src_y;
1411 plane_state->src_h = src_h;
1412 plane_state->src_w = src_w;
1414 if (plane == crtc->cursor)
1415 state->legacy_cursor_update = true;
1417 ret = drm_atomic_commit(state);
1421 /* Driver takes ownership of state on successful commit. */
1424 if (ret == -EDEADLK)
1427 drm_atomic_state_free(state);
1431 drm_atomic_state_clear(state);
1432 drm_atomic_legacy_backoff(state);
1435 * Someone might have exchanged the framebuffer while we dropped locks
1436 * in the backoff code. We need to fix up the fb refcount tracking the
1439 plane->old_fb = plane->fb;
1443 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1446 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1447 * @plane: plane to disable
1449 * Provides a default plane disable handler using the atomic driver interface.
1452 * Zero on success, error code on failure
1454 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1456 struct drm_atomic_state *state;
1457 struct drm_plane_state *plane_state;
1461 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1462 * acquire context. The real fix will be to wire the acquire ctx through
1463 * everywhere we need it, but meanwhile prevent chaos by just skipping
1464 * this noop. The critical case is the cursor ioctls which a) only grab
1465 * crtc/cursor-plane locks (so we need the crtc to get at the right
1466 * acquire context) and b) can try to disable the plane multiple times.
1471 state = drm_atomic_state_alloc(plane->dev);
1475 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1477 plane_state = drm_atomic_get_plane_state(state, plane);
1478 if (IS_ERR(plane_state)) {
1479 ret = PTR_ERR(plane_state);
1483 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1486 drm_atomic_set_fb_for_plane(plane_state, NULL);
1487 plane_state->crtc_x = 0;
1488 plane_state->crtc_y = 0;
1489 plane_state->crtc_h = 0;
1490 plane_state->crtc_w = 0;
1491 plane_state->src_x = 0;
1492 plane_state->src_y = 0;
1493 plane_state->src_h = 0;
1494 plane_state->src_w = 0;
1496 if (plane == plane->crtc->cursor)
1497 state->legacy_cursor_update = true;
1499 ret = drm_atomic_commit(state);
1503 /* Driver takes ownership of state on successful commit. */
1506 if (ret == -EDEADLK)
1509 drm_atomic_state_free(state);
1513 drm_atomic_state_clear(state);
1514 drm_atomic_legacy_backoff(state);
1517 * Someone might have exchanged the framebuffer while we dropped locks
1518 * in the backoff code. We need to fix up the fb refcount tracking the
1521 plane->old_fb = plane->fb;
1525 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1527 static int update_output_state(struct drm_atomic_state *state,
1528 struct drm_mode_set *set)
1530 struct drm_device *dev = set->crtc->dev;
1531 struct drm_crtc *crtc;
1532 struct drm_crtc_state *crtc_state;
1533 struct drm_connector *connector;
1534 struct drm_connector_state *conn_state;
1537 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1538 state->acquire_ctx);
1542 /* First grab all affected connector/crtc states. */
1543 for (i = 0; i < set->num_connectors; i++) {
1544 conn_state = drm_atomic_get_connector_state(state,
1545 set->connectors[i]);
1546 if (IS_ERR(conn_state))
1547 return PTR_ERR(conn_state);
1550 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1551 ret = drm_atomic_add_affected_connectors(state, crtc);
1556 /* Then recompute connector->crtc links and crtc enabling state. */
1557 for_each_connector_in_state(state, connector, conn_state, i) {
1558 if (conn_state->crtc == set->crtc) {
1559 ret = drm_atomic_set_crtc_for_connector(conn_state,
1565 for (j = 0; j < set->num_connectors; j++) {
1566 if (set->connectors[j] == connector) {
1567 ret = drm_atomic_set_crtc_for_connector(conn_state,
1576 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1577 /* Don't update ->enable for the CRTC in the set_config request,
1578 * since a mismatch would indicate a bug in the upper layers.
1579 * The actual modeset code later on will catch any
1580 * inconsistencies here. */
1581 if (crtc == set->crtc)
1584 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1585 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1590 crtc_state->active = false;
1598 * drm_atomic_helper_set_config - set a new config from userspace
1599 * @set: mode set configuration
1601 * Provides a default crtc set_config handler using the atomic driver interface.
1604 * Returns 0 on success, negative errno numbers on failure.
1606 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1608 struct drm_atomic_state *state;
1609 struct drm_crtc *crtc = set->crtc;
1610 struct drm_crtc_state *crtc_state;
1611 struct drm_plane_state *primary_state;
1614 state = drm_atomic_state_alloc(crtc->dev);
1618 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1620 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1621 if (IS_ERR(crtc_state)) {
1622 ret = PTR_ERR(crtc_state);
1626 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1627 if (IS_ERR(primary_state)) {
1628 ret = PTR_ERR(primary_state);
1634 WARN_ON(set->num_connectors);
1636 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1640 crtc_state->active = false;
1642 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1646 drm_atomic_set_fb_for_plane(primary_state, NULL);
1652 WARN_ON(!set->num_connectors);
1654 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1658 crtc_state->active = true;
1660 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1663 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1664 primary_state->crtc_x = 0;
1665 primary_state->crtc_y = 0;
1666 primary_state->crtc_h = set->mode->vdisplay;
1667 primary_state->crtc_w = set->mode->hdisplay;
1668 primary_state->src_x = set->x << 16;
1669 primary_state->src_y = set->y << 16;
1670 primary_state->src_h = set->mode->vdisplay << 16;
1671 primary_state->src_w = set->mode->hdisplay << 16;
1674 ret = update_output_state(state, set);
1678 ret = drm_atomic_commit(state);
1682 /* Driver takes ownership of state on successful commit. */
1685 if (ret == -EDEADLK)
1688 drm_atomic_state_free(state);
1692 drm_atomic_state_clear(state);
1693 drm_atomic_legacy_backoff(state);
1696 * Someone might have exchanged the framebuffer while we dropped locks
1697 * in the backoff code. We need to fix up the fb refcount tracking the
1700 crtc->primary->old_fb = crtc->primary->fb;
1704 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1707 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1709 * @property: DRM property
1710 * @val: value of property
1712 * Provides a default crtc set_property handler using the atomic driver
1716 * Zero on success, error code on failure
1719 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1720 struct drm_property *property,
1723 struct drm_atomic_state *state;
1724 struct drm_crtc_state *crtc_state;
1727 state = drm_atomic_state_alloc(crtc->dev);
1731 /* ->set_property is always called with all locks held. */
1732 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1734 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1735 if (IS_ERR(crtc_state)) {
1736 ret = PTR_ERR(crtc_state);
1740 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1745 ret = drm_atomic_commit(state);
1749 /* Driver takes ownership of state on successful commit. */
1752 if (ret == -EDEADLK)
1755 drm_atomic_state_free(state);
1759 drm_atomic_state_clear(state);
1760 drm_atomic_legacy_backoff(state);
1764 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1767 * drm_atomic_helper_plane_set_property - helper for plane properties
1769 * @property: DRM property
1770 * @val: value of property
1772 * Provides a default plane set_property handler using the atomic driver
1776 * Zero on success, error code on failure
1779 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1780 struct drm_property *property,
1783 struct drm_atomic_state *state;
1784 struct drm_plane_state *plane_state;
1787 state = drm_atomic_state_alloc(plane->dev);
1791 /* ->set_property is always called with all locks held. */
1792 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1794 plane_state = drm_atomic_get_plane_state(state, plane);
1795 if (IS_ERR(plane_state)) {
1796 ret = PTR_ERR(plane_state);
1800 ret = drm_atomic_plane_set_property(plane, plane_state,
1805 ret = drm_atomic_commit(state);
1809 /* Driver takes ownership of state on successful commit. */
1812 if (ret == -EDEADLK)
1815 drm_atomic_state_free(state);
1819 drm_atomic_state_clear(state);
1820 drm_atomic_legacy_backoff(state);
1824 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1827 * drm_atomic_helper_connector_set_property - helper for connector properties
1828 * @connector: DRM connector
1829 * @property: DRM property
1830 * @val: value of property
1832 * Provides a default connector set_property handler using the atomic driver
1836 * Zero on success, error code on failure
1839 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1840 struct drm_property *property,
1843 struct drm_atomic_state *state;
1844 struct drm_connector_state *connector_state;
1847 state = drm_atomic_state_alloc(connector->dev);
1851 /* ->set_property is always called with all locks held. */
1852 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1854 connector_state = drm_atomic_get_connector_state(state, connector);
1855 if (IS_ERR(connector_state)) {
1856 ret = PTR_ERR(connector_state);
1860 ret = drm_atomic_connector_set_property(connector, connector_state,
1865 ret = drm_atomic_commit(state);
1869 /* Driver takes ownership of state on successful commit. */
1872 if (ret == -EDEADLK)
1875 drm_atomic_state_free(state);
1879 drm_atomic_state_clear(state);
1880 drm_atomic_legacy_backoff(state);
1884 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1887 * drm_atomic_helper_page_flip - execute a legacy page flip
1889 * @fb: DRM framebuffer
1890 * @event: optional DRM event to signal upon completion
1891 * @flags: flip flags for non-vblank sync'ed updates
1893 * Provides a default page flip implementation using the atomic driver interface.
1895 * Note that for now so called async page flips (i.e. updates which are not
1896 * synchronized to vblank) are not supported, since the atomic interfaces have
1897 * no provisions for this yet.
1900 * Returns 0 on success, negative errno numbers on failure.
1902 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1903 struct drm_framebuffer *fb,
1904 struct drm_pending_vblank_event *event,
1907 struct drm_plane *plane = crtc->primary;
1908 struct drm_atomic_state *state;
1909 struct drm_plane_state *plane_state;
1910 struct drm_crtc_state *crtc_state;
1913 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1916 state = drm_atomic_state_alloc(plane->dev);
1920 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1922 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1923 if (IS_ERR(crtc_state)) {
1924 ret = PTR_ERR(crtc_state);
1927 crtc_state->event = event;
1929 plane_state = drm_atomic_get_plane_state(state, plane);
1930 if (IS_ERR(plane_state)) {
1931 ret = PTR_ERR(plane_state);
1935 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1938 drm_atomic_set_fb_for_plane(plane_state, fb);
1940 ret = drm_atomic_async_commit(state);
1944 /* Driver takes ownership of state on successful async commit. */
1947 if (ret == -EDEADLK)
1950 drm_atomic_state_free(state);
1954 drm_atomic_state_clear(state);
1955 drm_atomic_legacy_backoff(state);
1958 * Someone might have exchanged the framebuffer while we dropped locks
1959 * in the backoff code. We need to fix up the fb refcount tracking the
1962 plane->old_fb = plane->fb;
1966 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1969 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1970 * @connector: affected connector
1973 * This is the main helper function provided by the atomic helper framework for
1974 * implementing the legacy DPMS connector interface. It computes the new desired
1975 * ->active state for the corresponding CRTC (if the connector is enabled) and
1978 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1981 struct drm_mode_config *config = &connector->dev->mode_config;
1982 struct drm_atomic_state *state;
1983 struct drm_crtc_state *crtc_state;
1984 struct drm_crtc *crtc;
1985 struct drm_connector *tmp_connector;
1987 bool active = false;
1989 if (mode != DRM_MODE_DPMS_ON)
1990 mode = DRM_MODE_DPMS_OFF;
1992 connector->dpms = mode;
1993 crtc = connector->state->crtc;
1998 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1999 state = drm_atomic_state_alloc(connector->dev);
2003 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2005 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2006 if (IS_ERR(crtc_state))
2009 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2011 drm_for_each_connector(tmp_connector, connector->dev) {
2012 if (tmp_connector->state->crtc != crtc)
2015 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2020 crtc_state->active = active;
2022 ret = drm_atomic_commit(state);
2026 /* Driver takes ownership of state on successful async commit. */
2029 if (ret == -EDEADLK)
2032 drm_atomic_state_free(state);
2034 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
2038 drm_atomic_state_clear(state);
2039 drm_atomic_legacy_backoff(state);
2043 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2046 * DOC: atomic state reset and initialization
2048 * Both the drm core and the atomic helpers assume that there is always the full
2049 * and correct atomic software state for all connectors, CRTCs and planes
2050 * available. Which is a bit a problem on driver load and also after system
2051 * suspend. One way to solve this is to have a hardware state read-out
2052 * infrastructure which reconstructs the full software state (e.g. the i915
2055 * The simpler solution is to just reset the software state to everything off,
2056 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2057 * the atomic helpers provide default reset implementations for all hooks.
2061 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2064 * Resets the atomic state for @crtc by freeing the state pointer (which might
2065 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2067 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2069 if (crtc->state && crtc->state->mode_blob)
2070 drm_property_unreference_blob(crtc->state->mode_blob);
2072 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2075 crtc->state->crtc = crtc;
2077 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2080 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2081 * @crtc: CRTC object
2082 * @state: atomic CRTC state
2084 * Copies atomic state from a CRTC's current state and resets inferred values.
2085 * This is useful for drivers that subclass the CRTC state.
2087 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2088 struct drm_crtc_state *state)
2090 memcpy(state, crtc->state, sizeof(*state));
2092 if (state->mode_blob)
2093 drm_property_reference_blob(state->mode_blob);
2094 state->mode_changed = false;
2095 state->active_changed = false;
2096 state->planes_changed = false;
2097 state->connectors_changed = false;
2098 state->event = NULL;
2100 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2103 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2106 * Default CRTC state duplicate hook for drivers which don't have their own
2107 * subclassed CRTC state structure.
2109 struct drm_crtc_state *
2110 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2112 struct drm_crtc_state *state;
2114 if (WARN_ON(!crtc->state))
2117 state = kmalloc(sizeof(*state), GFP_KERNEL);
2119 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2123 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2126 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2127 * @crtc: CRTC object
2128 * @state: CRTC state object to release
2130 * Releases all resources stored in the CRTC state without actually freeing
2131 * the memory of the CRTC state. This is useful for drivers that subclass the
2134 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2135 struct drm_crtc_state *state)
2137 if (state->mode_blob)
2138 drm_property_unreference_blob(state->mode_blob);
2140 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2143 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2145 * @state: CRTC state object to release
2147 * Default CRTC state destroy hook for drivers which don't have their own
2148 * subclassed CRTC state structure.
2150 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2151 struct drm_crtc_state *state)
2153 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2156 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2159 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2162 * Resets the atomic state for @plane by freeing the state pointer (which might
2163 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2165 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2167 if (plane->state && plane->state->fb)
2168 drm_framebuffer_unreference(plane->state->fb);
2170 kfree(plane->state);
2171 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2174 plane->state->plane = plane;
2176 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2179 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2180 * @plane: plane object
2181 * @state: atomic plane state
2183 * Copies atomic state from a plane's current state. This is useful for
2184 * drivers that subclass the plane state.
2186 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2187 struct drm_plane_state *state)
2189 memcpy(state, plane->state, sizeof(*state));
2192 drm_framebuffer_reference(state->fb);
2194 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2197 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2200 * Default plane state duplicate hook for drivers which don't have their own
2201 * subclassed plane state structure.
2203 struct drm_plane_state *
2204 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2206 struct drm_plane_state *state;
2208 if (WARN_ON(!plane->state))
2211 state = kmalloc(sizeof(*state), GFP_KERNEL);
2213 __drm_atomic_helper_plane_duplicate_state(plane, state);
2217 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2220 * __drm_atomic_helper_plane_destroy_state - release plane state
2221 * @plane: plane object
2222 * @state: plane state object to release
2224 * Releases all resources stored in the plane state without actually freeing
2225 * the memory of the plane state. This is useful for drivers that subclass the
2228 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2229 struct drm_plane_state *state)
2232 drm_framebuffer_unreference(state->fb);
2234 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2237 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2239 * @state: plane state object to release
2241 * Default plane state destroy hook for drivers which don't have their own
2242 * subclassed plane state structure.
2244 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2245 struct drm_plane_state *state)
2247 __drm_atomic_helper_plane_destroy_state(plane, state);
2250 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2253 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2254 * @connector: drm connector
2256 * Resets the atomic state for @connector by freeing the state pointer (which
2257 * might be NULL, e.g. at driver load time) and allocating a new empty state
2260 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2262 kfree(connector->state);
2263 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2265 if (connector->state)
2266 connector->state->connector = connector;
2268 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2271 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2272 * @connector: connector object
2273 * @state: atomic connector state
2275 * Copies atomic state from a connector's current state. This is useful for
2276 * drivers that subclass the connector state.
2279 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2280 struct drm_connector_state *state)
2282 memcpy(state, connector->state, sizeof(*state));
2284 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2287 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2288 * @connector: drm connector
2290 * Default connector state duplicate hook for drivers which don't have their own
2291 * subclassed connector state structure.
2293 struct drm_connector_state *
2294 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2296 struct drm_connector_state *state;
2298 if (WARN_ON(!connector->state))
2301 state = kmalloc(sizeof(*state), GFP_KERNEL);
2303 __drm_atomic_helper_connector_duplicate_state(connector, state);
2307 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2310 * __drm_atomic_helper_connector_destroy_state - release connector state
2311 * @connector: connector object
2312 * @state: connector state object to release
2314 * Releases all resources stored in the connector state without actually
2315 * freeing the memory of the connector state. This is useful for drivers that
2316 * subclass the connector state.
2319 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2320 struct drm_connector_state *state)
2323 * This is currently a placeholder so that drivers that subclass the
2324 * state will automatically do the right thing if code is ever added
2328 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2331 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2332 * @connector: drm connector
2333 * @state: connector state object to release
2335 * Default connector state destroy hook for drivers which don't have their own
2336 * subclassed connector state structure.
2338 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2339 struct drm_connector_state *state)
2341 __drm_atomic_helper_connector_destroy_state(connector, state);
2344 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);