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 list_for_each_entry(connector, &config->connector_list, head) {
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_KMS("[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->mode_changed = true;
129 list_for_each_entry(connector, &config->connector_list, head) {
130 if (connector->state->best_encoder != encoder)
133 DRM_DEBUG_KMS("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 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_KMS("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->mode_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->mode_changed = true;
188 if (!connector_state->crtc) {
189 DRM_DEBUG_KMS("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_KMS("No suitable encoder found for [CONNECTOR:%d:%s]\n",
208 if (new_encoder == connector_state->best_encoder) {
209 DRM_DEBUG_KMS("[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_KMS("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->mode_changed = true;
238 DRM_DEBUG_KMS("[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 int ncrtcs = state->dev->mode_config.num_crtc;
252 struct drm_crtc_state *crtc_state;
253 struct drm_connector_state *conn_state;
257 for (i = 0; i < ncrtcs; i++) {
258 crtc_state = state->crtc_states[i];
260 if (!crtc_state || !crtc_state->mode_changed)
263 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
266 for (i = 0; i < state->num_connector; i++) {
267 struct drm_encoder_helper_funcs *funcs;
268 struct drm_encoder *encoder;
270 conn_state = state->connector_states[i];
275 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
277 if (!conn_state->crtc || !conn_state->best_encoder)
281 state->crtc_states[drm_crtc_index(conn_state->crtc)];
284 * Each encoder has at most one connector (since we always steal
285 * it away), so we won't call ->mode_fixup twice.
287 encoder = conn_state->best_encoder;
288 funcs = encoder->helper_private;
290 if (encoder->bridge && encoder->bridge->funcs->mode_fixup) {
291 ret = encoder->bridge->funcs->mode_fixup(
292 encoder->bridge, &crtc_state->mode,
293 &crtc_state->adjusted_mode);
295 DRM_DEBUG_KMS("Bridge fixup failed\n");
301 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
302 &crtc_state->adjusted_mode);
304 DRM_DEBUG_KMS("[ENCODER:%d:%s] fixup failed\n",
305 encoder->base.id, encoder->name);
310 for (i = 0; i < ncrtcs; i++) {
311 struct drm_crtc_helper_funcs *funcs;
312 struct drm_crtc *crtc;
314 crtc_state = state->crtc_states[i];
315 crtc = state->crtcs[i];
317 if (!crtc_state || !crtc_state->mode_changed)
320 funcs = crtc->helper_private;
321 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
322 &crtc_state->adjusted_mode);
324 DRM_DEBUG_KMS("[CRTC:%d] fixup failed\n",
334 needs_modeset(struct drm_crtc_state *state)
336 return state->mode_changed || state->active_changed;
340 * drm_atomic_helper_check - validate state object for modeset changes
342 * @state: the driver state object
344 * Check the state object to see if the requested state is physically possible.
345 * This does all the crtc and connector related computations for an atomic
346 * update. It computes and updates crtc_state->mode_changed, adds any additional
347 * connectors needed for full modesets and calls down into ->mode_fixup
348 * functions of the driver backend.
352 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
353 * plane update can't be done without a full modeset) _must_ call this function
354 * afterwards after that change. It is permitted to call this function multiple
355 * times for the same update, e.g. when the ->atomic_check functions depend upon
356 * the adjusted dotclock for fifo space allocation and watermark computation.
359 * Zero for success or -errno
362 drm_atomic_helper_check_modeset(struct drm_device *dev,
363 struct drm_atomic_state *state)
365 int ncrtcs = dev->mode_config.num_crtc;
366 struct drm_crtc *crtc;
367 struct drm_crtc_state *crtc_state;
370 for (i = 0; i < ncrtcs; i++) {
371 crtc = state->crtcs[i];
372 crtc_state = state->crtc_states[i];
377 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
378 DRM_DEBUG_KMS("[CRTC:%d] mode changed\n",
380 crtc_state->mode_changed = true;
383 if (crtc->state->enable != crtc_state->enable) {
384 DRM_DEBUG_KMS("[CRTC:%d] enable changed\n",
386 crtc_state->mode_changed = true;
390 for (i = 0; i < state->num_connector; i++) {
392 * This only sets crtc->mode_changed for routing changes,
393 * drivers must set crtc->mode_changed themselves when connector
394 * properties need to be updated.
396 ret = update_connector_routing(state, i);
402 * After all the routing has been prepared we need to add in any
403 * connector which is itself unchanged, but who's crtc changes it's
404 * configuration. This must be done before calling mode_fixup in case a
405 * crtc only changed its mode but has the same set of connectors.
407 for (i = 0; i < ncrtcs; i++) {
410 crtc = state->crtcs[i];
411 crtc_state = state->crtc_states[i];
417 * We must set ->active_changed after walking connectors for
418 * otherwise an update that only changes active would result in
419 * a full modeset because update_connector_routing force that.
421 if (crtc->state->active != crtc_state->active) {
422 DRM_DEBUG_KMS("[CRTC:%d] active changed\n",
424 crtc_state->active_changed = true;
427 if (!needs_modeset(crtc_state))
430 DRM_DEBUG_KMS("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
432 crtc_state->enable ? 'y' : 'n',
433 crtc_state->active ? 'y' : 'n');
435 ret = drm_atomic_add_affected_connectors(state, crtc);
439 num_connectors = drm_atomic_connectors_for_crtc(state,
442 if (crtc_state->enable != !!num_connectors) {
443 DRM_DEBUG_KMS("[CRTC:%d] enabled/connectors mismatch\n",
450 return mode_fixup(state);
452 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
455 * drm_atomic_helper_check - validate state object for modeset changes
457 * @state: the driver state object
459 * Check the state object to see if the requested state is physically possible.
460 * This does all the plane update related checks using by calling into the
461 * ->atomic_check hooks provided by the driver.
464 * Zero for success or -errno
467 drm_atomic_helper_check_planes(struct drm_device *dev,
468 struct drm_atomic_state *state)
470 int nplanes = dev->mode_config.num_total_plane;
471 int ncrtcs = dev->mode_config.num_crtc;
474 for (i = 0; i < nplanes; i++) {
475 struct drm_plane_helper_funcs *funcs;
476 struct drm_plane *plane = state->planes[i];
477 struct drm_plane_state *plane_state = state->plane_states[i];
482 funcs = plane->helper_private;
484 drm_atomic_helper_plane_changed(state, plane_state, plane);
486 if (!funcs || !funcs->atomic_check)
489 ret = funcs->atomic_check(plane, plane_state);
491 DRM_DEBUG_KMS("[PLANE:%d] atomic driver check failed\n",
497 for (i = 0; i < ncrtcs; i++) {
498 struct drm_crtc_helper_funcs *funcs;
499 struct drm_crtc *crtc = state->crtcs[i];
504 funcs = crtc->helper_private;
506 if (!funcs || !funcs->atomic_check)
509 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
511 DRM_DEBUG_KMS("[CRTC:%d] atomic driver check failed\n",
519 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
522 * drm_atomic_helper_check - validate state object
524 * @state: the driver state object
526 * Check the state object to see if the requested state is physically possible.
527 * Only crtcs and planes have check callbacks, so for any additional (global)
528 * checking that a driver needs it can simply wrap that around this function.
529 * Drivers without such needs can directly use this as their ->atomic_check()
532 * This just wraps the two parts of the state checking for planes and modeset
533 * state in the default order: First it calls drm_atomic_helper_check_modeset()
534 * and then drm_atomic_helper_check_planes(). The assumption is that the
535 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
536 * e.g. properly compute watermarks.
539 * Zero for success or -errno
541 int drm_atomic_helper_check(struct drm_device *dev,
542 struct drm_atomic_state *state)
546 ret = drm_atomic_helper_check_modeset(dev, state);
550 ret = drm_atomic_helper_check_planes(dev, state);
556 EXPORT_SYMBOL(drm_atomic_helper_check);
559 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
561 int ncrtcs = old_state->dev->mode_config.num_crtc;
564 for (i = 0; i < old_state->num_connector; i++) {
565 struct drm_connector_state *old_conn_state;
566 struct drm_connector *connector;
567 struct drm_encoder_helper_funcs *funcs;
568 struct drm_encoder *encoder;
569 struct drm_crtc_state *old_crtc_state;
571 old_conn_state = old_state->connector_states[i];
572 connector = old_state->connectors[i];
574 /* Shut down everything that's in the changeset and currently
575 * still on. So need to check the old, saved state. */
576 if (!old_conn_state || !old_conn_state->crtc)
579 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
581 if (!old_crtc_state->active)
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;
595 * Each encoder has at most one connector (since we always steal
596 * it away), so we won't call call disable hooks twice.
599 encoder->bridge->funcs->disable(encoder->bridge);
601 /* Right function depends upon target state. */
602 if (connector->state->crtc && funcs->prepare)
603 funcs->prepare(encoder);
604 else if (funcs->disable)
605 funcs->disable(encoder);
607 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
610 encoder->bridge->funcs->post_disable(encoder->bridge);
613 for (i = 0; i < ncrtcs; i++) {
614 struct drm_crtc_helper_funcs *funcs;
615 struct drm_crtc *crtc;
616 struct drm_crtc_state *old_crtc_state;
618 crtc = old_state->crtcs[i];
619 old_crtc_state = old_state->crtc_states[i];
621 /* Shut down everything that needs a full modeset. */
622 if (!crtc || !needs_modeset(crtc->state))
625 if (!old_crtc_state->active)
628 funcs = crtc->helper_private;
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 set_routing_links(struct drm_device *dev, struct drm_atomic_state *old_state)
643 int ncrtcs = old_state->dev->mode_config.num_crtc;
646 /* clear out existing links */
647 for (i = 0; i < old_state->num_connector; i++) {
648 struct drm_connector *connector;
650 connector = old_state->connectors[i];
652 if (!connector || !connector->encoder)
655 WARN_ON(!connector->encoder->crtc);
657 connector->encoder->crtc = NULL;
658 connector->encoder = NULL;
662 for (i = 0; i < old_state->num_connector; i++) {
663 struct drm_connector *connector;
665 connector = old_state->connectors[i];
667 if (!connector || !connector->state->crtc)
670 if (WARN_ON(!connector->state->best_encoder))
673 connector->encoder = connector->state->best_encoder;
674 connector->encoder->crtc = connector->state->crtc;
677 /* set legacy state in the crtc structure */
678 for (i = 0; i < ncrtcs; i++) {
679 struct drm_crtc *crtc;
681 crtc = old_state->crtcs[i];
686 crtc->mode = crtc->state->mode;
687 crtc->enabled = crtc->state->enable;
688 crtc->x = crtc->primary->state->src_x >> 16;
689 crtc->y = crtc->primary->state->src_y >> 16;
694 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
696 int ncrtcs = old_state->dev->mode_config.num_crtc;
699 for (i = 0; i < ncrtcs; i++) {
700 struct drm_crtc_helper_funcs *funcs;
701 struct drm_crtc *crtc;
703 crtc = old_state->crtcs[i];
705 if (!crtc || !crtc->state->mode_changed)
708 funcs = crtc->helper_private;
710 if (crtc->state->enable)
711 funcs->mode_set_nofb(crtc);
714 for (i = 0; i < old_state->num_connector; i++) {
715 struct drm_connector *connector;
716 struct drm_crtc_state *new_crtc_state;
717 struct drm_encoder_helper_funcs *funcs;
718 struct drm_encoder *encoder;
719 struct drm_display_mode *mode, *adjusted_mode;
721 connector = old_state->connectors[i];
723 if (!connector || !connector->state->best_encoder)
726 encoder = connector->state->best_encoder;
727 funcs = encoder->helper_private;
728 new_crtc_state = connector->state->crtc->state;
729 mode = &new_crtc_state->mode;
730 adjusted_mode = &new_crtc_state->adjusted_mode;
732 if (!new_crtc_state->mode_changed)
736 * Each encoder has at most one connector (since we always steal
737 * it away), so we won't call call mode_set hooks twice.
739 funcs->mode_set(encoder, mode, adjusted_mode);
741 if (encoder->bridge && encoder->bridge->funcs->mode_set)
742 encoder->bridge->funcs->mode_set(encoder->bridge,
743 mode, adjusted_mode);
748 * drm_atomic_helper_commit_pre_planes - modeset commit before plane updates
750 * @state: atomic state
752 * This function commits the modeset changes that need to be committed before
753 * updating planes. It shuts down all the outputs that need to be shut down and
754 * prepares them (if required) with the new mode.
756 void drm_atomic_helper_commit_pre_planes(struct drm_device *dev,
757 struct drm_atomic_state *state)
759 disable_outputs(dev, state);
760 set_routing_links(dev, state);
761 crtc_set_mode(dev, state);
763 EXPORT_SYMBOL(drm_atomic_helper_commit_pre_planes);
766 * drm_atomic_helper_commit_post_planes - modeset commit after plane updates
768 * @old_state: atomic state object with old state structures
770 * This function commits the modeset changes that need to be committed after
771 * updating planes: It enables all the outputs with the new configuration which
772 * had to be turned off for the update.
774 void drm_atomic_helper_commit_post_planes(struct drm_device *dev,
775 struct drm_atomic_state *old_state)
777 int ncrtcs = old_state->dev->mode_config.num_crtc;
780 for (i = 0; i < ncrtcs; i++) {
781 struct drm_crtc_helper_funcs *funcs;
782 struct drm_crtc *crtc;
784 crtc = old_state->crtcs[i];
786 /* Need to filter out CRTCs where only planes change. */
787 if (!crtc || !needs_modeset(crtc->state))
790 if (!crtc->state->active)
793 funcs = crtc->helper_private;
795 if (crtc->state->enable) {
803 for (i = 0; i < old_state->num_connector; i++) {
804 struct drm_connector *connector;
805 struct drm_encoder_helper_funcs *funcs;
806 struct drm_encoder *encoder;
808 connector = old_state->connectors[i];
810 if (!connector || !connector->state->best_encoder)
813 if (!connector->state->crtc->state->active)
816 encoder = connector->state->best_encoder;
817 funcs = encoder->helper_private;
820 * Each encoder has at most one connector (since we always steal
821 * it away), so we won't call call enable hooks twice.
824 encoder->bridge->funcs->pre_enable(encoder->bridge);
827 funcs->enable(encoder);
829 funcs->commit(encoder);
832 encoder->bridge->funcs->enable(encoder->bridge);
835 EXPORT_SYMBOL(drm_atomic_helper_commit_post_planes);
837 static void wait_for_fences(struct drm_device *dev,
838 struct drm_atomic_state *state)
840 int nplanes = dev->mode_config.num_total_plane;
843 for (i = 0; i < nplanes; i++) {
844 struct drm_plane *plane = state->planes[i];
846 if (!plane || !plane->state->fence)
849 WARN_ON(!plane->state->fb);
851 fence_wait(plane->state->fence, false);
852 fence_put(plane->state->fence);
853 plane->state->fence = NULL;
857 static bool framebuffer_changed(struct drm_device *dev,
858 struct drm_atomic_state *old_state,
859 struct drm_crtc *crtc)
861 struct drm_plane *plane;
862 struct drm_plane_state *old_plane_state;
863 int nplanes = old_state->dev->mode_config.num_total_plane;
866 for (i = 0; i < nplanes; i++) {
867 plane = old_state->planes[i];
868 old_plane_state = old_state->plane_states[i];
873 if (plane->state->crtc != crtc &&
874 old_plane_state->crtc != crtc)
877 if (plane->state->fb != old_plane_state->fb)
885 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
887 * @old_state: atomic state object with old state structures
889 * Helper to, after atomic commit, wait for vblanks on all effected
890 * crtcs (ie. before cleaning up old framebuffers using
891 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
892 * framebuffers have actually changed to optimize for the legacy cursor and
893 * plane update use-case.
896 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
897 struct drm_atomic_state *old_state)
899 struct drm_crtc *crtc;
900 struct drm_crtc_state *old_crtc_state;
901 int ncrtcs = old_state->dev->mode_config.num_crtc;
904 for (i = 0; i < ncrtcs; i++) {
905 crtc = old_state->crtcs[i];
906 old_crtc_state = old_state->crtc_states[i];
911 /* No one cares about the old state, so abuse it for tracking
912 * and store whether we hold a vblank reference (and should do a
913 * vblank wait) in the ->enable boolean. */
914 old_crtc_state->enable = false;
916 if (!crtc->state->enable)
919 /* Legacy cursor ioctls are completely unsynced, and userspace
920 * relies on that (by doing tons of cursor updates). */
921 if (old_state->legacy_cursor_update)
924 if (!framebuffer_changed(dev, old_state, crtc))
927 ret = drm_crtc_vblank_get(crtc);
931 old_crtc_state->enable = true;
932 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
935 for (i = 0; i < ncrtcs; i++) {
936 crtc = old_state->crtcs[i];
937 old_crtc_state = old_state->crtc_states[i];
939 if (!crtc || !old_crtc_state->enable)
942 ret = wait_event_timeout(dev->vblank[i].queue,
943 old_crtc_state->last_vblank_count !=
944 drm_vblank_count(dev, i),
945 msecs_to_jiffies(50));
947 drm_crtc_vblank_put(crtc);
950 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
953 * drm_atomic_helper_commit - commit validated state object
955 * @state: the driver state object
956 * @async: asynchronous commit
958 * This function commits a with drm_atomic_helper_check() pre-validated state
959 * object. This can still fail when e.g. the framebuffer reservation fails. For
960 * now this doesn't implement asynchronous commits.
963 * Zero for success or -errno.
965 int drm_atomic_helper_commit(struct drm_device *dev,
966 struct drm_atomic_state *state,
974 ret = drm_atomic_helper_prepare_planes(dev, state);
979 * This is the point of no return - everything below never fails except
980 * when the hw goes bonghits. Which means we can commit the new state on
981 * the software side now.
984 drm_atomic_helper_swap_state(dev, state);
987 * Everything below can be run asynchronously without the need to grab
988 * any modeset locks at all under one conditions: It must be guaranteed
989 * that the asynchronous work has either been cancelled (if the driver
990 * supports it, which at least requires that the framebuffers get
991 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
992 * before the new state gets committed on the software side with
993 * drm_atomic_helper_swap_state().
995 * This scheme allows new atomic state updates to be prepared and
996 * checked in parallel to the asynchronous completion of the previous
997 * update. Which is important since compositors need to figure out the
998 * composition of the next frame right after having submitted the
1002 wait_for_fences(dev, state);
1004 drm_atomic_helper_commit_pre_planes(dev, state);
1006 drm_atomic_helper_commit_planes(dev, state);
1008 drm_atomic_helper_commit_post_planes(dev, state);
1010 drm_atomic_helper_wait_for_vblanks(dev, state);
1012 drm_atomic_helper_cleanup_planes(dev, state);
1014 drm_atomic_state_free(state);
1018 EXPORT_SYMBOL(drm_atomic_helper_commit);
1021 * DOC: implementing async commit
1023 * For now the atomic helpers don't support async commit directly. If there is
1024 * real need it could be added though, using the dma-buf fence infrastructure
1025 * for generic synchronization with outstanding rendering.
1027 * For now drivers have to implement async commit themselves, with the following
1028 * sequence being the recommended one:
1030 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1031 * which commit needs to call which can fail, so we want to run it first and
1034 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1035 * might be affected the new state update. This can be done by either cancelling
1036 * or flushing the work items, depending upon whether the driver can deal with
1037 * cancelled updates. Note that it is important to ensure that the framebuffer
1038 * cleanup is still done when cancelling.
1040 * For sufficient parallelism it is recommended to have a work item per crtc
1041 * (for updates which don't touch global state) and a global one. Then we only
1042 * need to synchronize with the crtc work items for changed crtcs and the global
1043 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1045 * 3. The software state is updated synchronously with
1046 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1047 * locks means concurrent callers never see inconsistent state. And doing this
1048 * while it's guaranteed that no relevant async worker runs means that async
1049 * workers do not need grab any locks. Actually they must not grab locks, for
1050 * otherwise the work flushing will deadlock.
1052 * 4. Schedule a work item to do all subsequent steps, using the split-out
1053 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1054 * then cleaning up the framebuffers after the old framebuffer is no longer
1059 * drm_atomic_helper_prepare_planes - prepare plane resources after commit
1061 * @state: atomic state object with old state structures
1063 * This function prepares plane state, specifically framebuffers, for the new
1064 * configuration. If any failure is encountered this function will call
1065 * ->cleanup_fb on any already successfully prepared framebuffer.
1068 * 0 on success, negative error code on failure.
1070 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1071 struct drm_atomic_state *state)
1073 int nplanes = dev->mode_config.num_total_plane;
1076 for (i = 0; i < nplanes; i++) {
1077 struct drm_plane_helper_funcs *funcs;
1078 struct drm_plane *plane = state->planes[i];
1079 struct drm_framebuffer *fb;
1084 funcs = plane->helper_private;
1086 fb = state->plane_states[i]->fb;
1088 if (fb && funcs->prepare_fb) {
1089 ret = funcs->prepare_fb(plane, fb);
1098 for (i--; i >= 0; i--) {
1099 struct drm_plane_helper_funcs *funcs;
1100 struct drm_plane *plane = state->planes[i];
1101 struct drm_framebuffer *fb;
1106 funcs = plane->helper_private;
1108 fb = state->plane_states[i]->fb;
1110 if (fb && funcs->cleanup_fb)
1111 funcs->cleanup_fb(plane, fb);
1117 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1120 * drm_atomic_helper_commit_planes - commit plane state
1122 * @old_state: atomic state object with old state structures
1124 * This function commits the new plane state using the plane and atomic helper
1125 * functions for planes and crtcs. It assumes that the atomic state has already
1126 * been pushed into the relevant object state pointers, since this step can no
1129 * It still requires the global state object @old_state to know which planes and
1130 * crtcs need to be updated though.
1132 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1133 struct drm_atomic_state *old_state)
1135 int nplanes = dev->mode_config.num_total_plane;
1136 int ncrtcs = dev->mode_config.num_crtc;
1139 for (i = 0; i < ncrtcs; i++) {
1140 struct drm_crtc_helper_funcs *funcs;
1141 struct drm_crtc *crtc = old_state->crtcs[i];
1146 funcs = crtc->helper_private;
1148 if (!funcs || !funcs->atomic_begin)
1151 funcs->atomic_begin(crtc);
1154 for (i = 0; i < nplanes; i++) {
1155 struct drm_plane_helper_funcs *funcs;
1156 struct drm_plane *plane = old_state->planes[i];
1157 struct drm_plane_state *old_plane_state;
1162 funcs = plane->helper_private;
1164 if (!funcs || !funcs->atomic_update)
1167 old_plane_state = old_state->plane_states[i];
1169 funcs->atomic_update(plane, old_plane_state);
1172 for (i = 0; i < ncrtcs; i++) {
1173 struct drm_crtc_helper_funcs *funcs;
1174 struct drm_crtc *crtc = old_state->crtcs[i];
1179 funcs = crtc->helper_private;
1181 if (!funcs || !funcs->atomic_flush)
1184 funcs->atomic_flush(crtc);
1187 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1190 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1192 * @old_state: atomic state object with old state structures
1194 * This function cleans up plane state, specifically framebuffers, from the old
1195 * configuration. Hence the old configuration must be perserved in @old_state to
1196 * be able to call this function.
1198 * This function must also be called on the new state when the atomic update
1199 * fails at any point after calling drm_atomic_helper_prepare_planes().
1201 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1202 struct drm_atomic_state *old_state)
1204 int nplanes = dev->mode_config.num_total_plane;
1207 for (i = 0; i < nplanes; i++) {
1208 struct drm_plane_helper_funcs *funcs;
1209 struct drm_plane *plane = old_state->planes[i];
1210 struct drm_framebuffer *old_fb;
1215 funcs = plane->helper_private;
1217 old_fb = old_state->plane_states[i]->fb;
1219 if (old_fb && funcs->cleanup_fb)
1220 funcs->cleanup_fb(plane, old_fb);
1223 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1226 * drm_atomic_helper_swap_state - store atomic state into current sw state
1228 * @state: atomic state
1230 * This function stores the atomic state into the current state pointers in all
1231 * driver objects. It should be called after all failing steps have been done
1232 * and succeeded, but before the actual hardware state is committed.
1234 * For cleanup and error recovery the current state for all changed objects will
1235 * be swaped into @state.
1237 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1239 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1241 * 2. Do any other steps that might fail.
1243 * 3. Put the staged state into the current state pointers with this function.
1245 * 4. Actually commit the hardware state.
1247 * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1248 * contains the old state. Also do any other cleanup required with that state.
1250 void drm_atomic_helper_swap_state(struct drm_device *dev,
1251 struct drm_atomic_state *state)
1255 for (i = 0; i < dev->mode_config.num_connector; i++) {
1256 struct drm_connector *connector = state->connectors[i];
1261 connector->state->state = state;
1262 swap(state->connector_states[i], connector->state);
1263 connector->state->state = NULL;
1266 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1267 struct drm_crtc *crtc = state->crtcs[i];
1272 crtc->state->state = state;
1273 swap(state->crtc_states[i], crtc->state);
1274 crtc->state->state = NULL;
1277 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1278 struct drm_plane *plane = state->planes[i];
1283 plane->state->state = state;
1284 swap(state->plane_states[i], plane->state);
1285 plane->state->state = NULL;
1288 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1291 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1292 * @plane: plane object to update
1293 * @crtc: owning CRTC of owning plane
1294 * @fb: framebuffer to flip onto plane
1295 * @crtc_x: x offset of primary plane on crtc
1296 * @crtc_y: y offset of primary plane on crtc
1297 * @crtc_w: width of primary plane rectangle on crtc
1298 * @crtc_h: height of primary plane rectangle on crtc
1299 * @src_x: x offset of @fb for panning
1300 * @src_y: y offset of @fb for panning
1301 * @src_w: width of source rectangle in @fb
1302 * @src_h: height of source rectangle in @fb
1304 * Provides a default plane update handler using the atomic driver interface.
1307 * Zero on success, error code on failure
1309 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1310 struct drm_crtc *crtc,
1311 struct drm_framebuffer *fb,
1312 int crtc_x, int crtc_y,
1313 unsigned int crtc_w, unsigned int crtc_h,
1314 uint32_t src_x, uint32_t src_y,
1315 uint32_t src_w, uint32_t src_h)
1317 struct drm_atomic_state *state;
1318 struct drm_plane_state *plane_state;
1321 state = drm_atomic_state_alloc(plane->dev);
1325 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1327 plane_state = drm_atomic_get_plane_state(state, plane);
1328 if (IS_ERR(plane_state)) {
1329 ret = PTR_ERR(plane_state);
1333 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1336 drm_atomic_set_fb_for_plane(plane_state, fb);
1337 plane_state->crtc_x = crtc_x;
1338 plane_state->crtc_y = crtc_y;
1339 plane_state->crtc_h = crtc_h;
1340 plane_state->crtc_w = crtc_w;
1341 plane_state->src_x = src_x;
1342 plane_state->src_y = src_y;
1343 plane_state->src_h = src_h;
1344 plane_state->src_w = src_w;
1346 ret = drm_atomic_commit(state);
1350 if (plane == crtc->cursor)
1351 state->legacy_cursor_update = true;
1353 /* Driver takes ownership of state on successful commit. */
1356 if (ret == -EDEADLK)
1359 drm_atomic_state_free(state);
1363 drm_atomic_state_clear(state);
1364 drm_atomic_legacy_backoff(state);
1367 * Someone might have exchanged the framebuffer while we dropped locks
1368 * in the backoff code. We need to fix up the fb refcount tracking the
1371 plane->old_fb = plane->fb;
1375 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1378 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1379 * @plane: plane to disable
1381 * Provides a default plane disable handler using the atomic driver interface.
1384 * Zero on success, error code on failure
1386 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1388 struct drm_atomic_state *state;
1389 struct drm_plane_state *plane_state;
1393 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1394 * acquire context. The real fix will be to wire the acquire ctx through
1395 * everywhere we need it, but meanwhile prevent chaos by just skipping
1396 * this noop. The critical case is the cursor ioctls which a) only grab
1397 * crtc/cursor-plane locks (so we need the crtc to get at the right
1398 * acquire context) and b) can try to disable the plane multiple times.
1403 state = drm_atomic_state_alloc(plane->dev);
1407 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1409 plane_state = drm_atomic_get_plane_state(state, plane);
1410 if (IS_ERR(plane_state)) {
1411 ret = PTR_ERR(plane_state);
1415 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1418 drm_atomic_set_fb_for_plane(plane_state, NULL);
1419 plane_state->crtc_x = 0;
1420 plane_state->crtc_y = 0;
1421 plane_state->crtc_h = 0;
1422 plane_state->crtc_w = 0;
1423 plane_state->src_x = 0;
1424 plane_state->src_y = 0;
1425 plane_state->src_h = 0;
1426 plane_state->src_w = 0;
1428 if (plane == plane->crtc->cursor)
1429 state->legacy_cursor_update = true;
1431 ret = drm_atomic_commit(state);
1435 /* Driver takes ownership of state on successful commit. */
1438 if (ret == -EDEADLK)
1441 drm_atomic_state_free(state);
1445 drm_atomic_state_clear(state);
1446 drm_atomic_legacy_backoff(state);
1449 * Someone might have exchanged the framebuffer while we dropped locks
1450 * in the backoff code. We need to fix up the fb refcount tracking the
1453 plane->old_fb = plane->fb;
1457 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1459 static int update_output_state(struct drm_atomic_state *state,
1460 struct drm_mode_set *set)
1462 struct drm_device *dev = set->crtc->dev;
1463 struct drm_connector_state *conn_state;
1464 int ncrtcs = state->dev->mode_config.num_crtc;
1467 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1468 state->acquire_ctx);
1472 /* First grab all affected connector/crtc states. */
1473 for (i = 0; i < set->num_connectors; i++) {
1474 conn_state = drm_atomic_get_connector_state(state,
1475 set->connectors[i]);
1476 if (IS_ERR(conn_state))
1477 return PTR_ERR(conn_state);
1480 for (i = 0; i < ncrtcs; i++) {
1481 struct drm_crtc *crtc = state->crtcs[i];
1486 ret = drm_atomic_add_affected_connectors(state, crtc);
1491 /* Then recompute connector->crtc links and crtc enabling state. */
1492 for (i = 0; i < state->num_connector; i++) {
1493 struct drm_connector *connector;
1495 connector = state->connectors[i];
1496 conn_state = state->connector_states[i];
1501 if (conn_state->crtc == set->crtc) {
1502 ret = drm_atomic_set_crtc_for_connector(conn_state,
1508 for (j = 0; j < set->num_connectors; j++) {
1509 if (set->connectors[j] == connector) {
1510 ret = drm_atomic_set_crtc_for_connector(conn_state,
1519 for (i = 0; i < ncrtcs; i++) {
1520 struct drm_crtc *crtc = state->crtcs[i];
1521 struct drm_crtc_state *crtc_state = state->crtc_states[i];
1526 /* Don't update ->enable for the CRTC in the set_config request,
1527 * since a mismatch would indicate a bug in the upper layers.
1528 * The actual modeset code later on will catch any
1529 * inconsistencies here. */
1530 if (crtc == set->crtc)
1533 crtc_state->enable =
1534 drm_atomic_connectors_for_crtc(state, crtc);
1541 * drm_atomic_helper_set_config - set a new config from userspace
1542 * @set: mode set configuration
1544 * Provides a default crtc set_config handler using the atomic driver interface.
1547 * Returns 0 on success, negative errno numbers on failure.
1549 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1551 struct drm_atomic_state *state;
1552 struct drm_crtc *crtc = set->crtc;
1553 struct drm_crtc_state *crtc_state;
1554 struct drm_plane_state *primary_state;
1557 state = drm_atomic_state_alloc(crtc->dev);
1561 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1563 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1564 if (IS_ERR(crtc_state)) {
1565 ret = PTR_ERR(crtc_state);
1569 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1570 if (IS_ERR(primary_state)) {
1571 ret = PTR_ERR(primary_state);
1577 WARN_ON(set->num_connectors);
1579 crtc_state->enable = false;
1580 crtc_state->active = false;
1582 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1586 drm_atomic_set_fb_for_plane(primary_state, NULL);
1592 WARN_ON(!set->num_connectors);
1594 crtc_state->enable = true;
1595 crtc_state->active = true;
1596 drm_mode_copy(&crtc_state->mode, set->mode);
1598 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1601 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1602 primary_state->crtc_x = 0;
1603 primary_state->crtc_y = 0;
1604 primary_state->crtc_h = set->mode->vdisplay;
1605 primary_state->crtc_w = set->mode->hdisplay;
1606 primary_state->src_x = set->x << 16;
1607 primary_state->src_y = set->y << 16;
1608 primary_state->src_h = set->mode->vdisplay << 16;
1609 primary_state->src_w = set->mode->hdisplay << 16;
1612 ret = update_output_state(state, set);
1616 ret = drm_atomic_commit(state);
1620 /* Driver takes ownership of state on successful commit. */
1623 if (ret == -EDEADLK)
1626 drm_atomic_state_free(state);
1630 drm_atomic_state_clear(state);
1631 drm_atomic_legacy_backoff(state);
1634 * Someone might have exchanged the framebuffer while we dropped locks
1635 * in the backoff code. We need to fix up the fb refcount tracking the
1638 crtc->primary->old_fb = crtc->primary->fb;
1642 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1645 * drm_atomic_helper_crtc_set_property - helper for crtc prorties
1647 * @property: DRM property
1648 * @val: value of property
1650 * Provides a default plane disablle handler using the atomic driver interface.
1653 * Zero on success, error code on failure
1656 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1657 struct drm_property *property,
1660 struct drm_atomic_state *state;
1661 struct drm_crtc_state *crtc_state;
1664 state = drm_atomic_state_alloc(crtc->dev);
1668 /* ->set_property is always called with all locks held. */
1669 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1671 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1672 if (IS_ERR(crtc_state)) {
1673 ret = PTR_ERR(crtc_state);
1677 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1682 ret = drm_atomic_commit(state);
1686 /* Driver takes ownership of state on successful commit. */
1689 if (ret == -EDEADLK)
1692 drm_atomic_state_free(state);
1696 drm_atomic_state_clear(state);
1697 drm_atomic_legacy_backoff(state);
1701 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1704 * drm_atomic_helper_plane_set_property - helper for plane prorties
1706 * @property: DRM property
1707 * @val: value of property
1709 * Provides a default plane disable handler using the atomic driver interface.
1712 * Zero on success, error code on failure
1715 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1716 struct drm_property *property,
1719 struct drm_atomic_state *state;
1720 struct drm_plane_state *plane_state;
1723 state = drm_atomic_state_alloc(plane->dev);
1727 /* ->set_property is always called with all locks held. */
1728 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1730 plane_state = drm_atomic_get_plane_state(state, plane);
1731 if (IS_ERR(plane_state)) {
1732 ret = PTR_ERR(plane_state);
1736 ret = drm_atomic_plane_set_property(plane, plane_state,
1741 ret = drm_atomic_commit(state);
1745 /* Driver takes ownership of state on successful commit. */
1748 if (ret == -EDEADLK)
1751 drm_atomic_state_free(state);
1755 drm_atomic_state_clear(state);
1756 drm_atomic_legacy_backoff(state);
1760 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1763 * drm_atomic_helper_connector_set_property - helper for connector prorties
1764 * @connector: DRM connector
1765 * @property: DRM property
1766 * @val: value of property
1768 * Provides a default plane disablle handler using the atomic driver interface.
1771 * Zero on success, error code on failure
1774 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1775 struct drm_property *property,
1778 struct drm_atomic_state *state;
1779 struct drm_connector_state *connector_state;
1782 state = drm_atomic_state_alloc(connector->dev);
1786 /* ->set_property is always called with all locks held. */
1787 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1789 connector_state = drm_atomic_get_connector_state(state, connector);
1790 if (IS_ERR(connector_state)) {
1791 ret = PTR_ERR(connector_state);
1795 ret = drm_atomic_connector_set_property(connector, connector_state,
1800 ret = drm_atomic_commit(state);
1804 /* Driver takes ownership of state on successful commit. */
1807 if (ret == -EDEADLK)
1810 drm_atomic_state_free(state);
1814 drm_atomic_state_clear(state);
1815 drm_atomic_legacy_backoff(state);
1819 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1822 * drm_atomic_helper_page_flip - execute a legacy page flip
1824 * @fb: DRM framebuffer
1825 * @event: optional DRM event to signal upon completion
1826 * @flags: flip flags for non-vblank sync'ed updates
1828 * Provides a default page flip implementation using the atomic driver interface.
1830 * Note that for now so called async page flips (i.e. updates which are not
1831 * synchronized to vblank) are not supported, since the atomic interfaces have
1832 * no provisions for this yet.
1835 * Returns 0 on success, negative errno numbers on failure.
1837 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1838 struct drm_framebuffer *fb,
1839 struct drm_pending_vblank_event *event,
1842 struct drm_plane *plane = crtc->primary;
1843 struct drm_atomic_state *state;
1844 struct drm_plane_state *plane_state;
1845 struct drm_crtc_state *crtc_state;
1848 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1851 state = drm_atomic_state_alloc(plane->dev);
1855 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1857 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1858 if (IS_ERR(crtc_state)) {
1859 ret = PTR_ERR(crtc_state);
1862 crtc_state->event = event;
1864 plane_state = drm_atomic_get_plane_state(state, plane);
1865 if (IS_ERR(plane_state)) {
1866 ret = PTR_ERR(plane_state);
1870 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1873 drm_atomic_set_fb_for_plane(plane_state, fb);
1875 ret = drm_atomic_async_commit(state);
1879 /* TODO: ->page_flip is the only driver callback where the core
1880 * doesn't update plane->fb. For now patch it up here. */
1881 plane->fb = plane->state->fb;
1883 /* Driver takes ownership of state on successful async commit. */
1886 if (ret == -EDEADLK)
1889 drm_atomic_state_free(state);
1893 drm_atomic_state_clear(state);
1894 drm_atomic_legacy_backoff(state);
1897 * Someone might have exchanged the framebuffer while we dropped locks
1898 * in the backoff code. We need to fix up the fb refcount tracking the
1901 plane->old_fb = plane->fb;
1905 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1908 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1909 * @connector: affected connector
1912 * This is the main helper function provided by the atomic helper framework for
1913 * implementing the legacy DPMS connector interface. It computes the new desired
1914 * ->active state for the corresponding CRTC (if the connector is enabled) and
1917 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1920 struct drm_mode_config *config = &connector->dev->mode_config;
1921 struct drm_atomic_state *state;
1922 struct drm_crtc_state *crtc_state;
1923 struct drm_crtc *crtc;
1924 struct drm_connector *tmp_connector;
1926 bool active = false;
1928 if (mode != DRM_MODE_DPMS_ON)
1929 mode = DRM_MODE_DPMS_OFF;
1931 connector->dpms = mode;
1932 crtc = connector->state->crtc;
1937 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1938 state = drm_atomic_state_alloc(connector->dev);
1942 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1944 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1945 if (IS_ERR(crtc_state))
1948 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1950 list_for_each_entry(tmp_connector, &config->connector_list, head) {
1951 if (connector->state->crtc != crtc)
1954 if (connector->dpms == DRM_MODE_DPMS_ON) {
1959 crtc_state->active = active;
1961 ret = drm_atomic_commit(state);
1965 /* Driver takes ownership of state on successful async commit. */
1968 if (ret == -EDEADLK)
1971 drm_atomic_state_free(state);
1973 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
1977 drm_atomic_state_clear(state);
1978 drm_atomic_legacy_backoff(state);
1982 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
1985 * DOC: atomic state reset and initialization
1987 * Both the drm core and the atomic helpers assume that there is always the full
1988 * and correct atomic software state for all connectors, CRTCs and planes
1989 * available. Which is a bit a problem on driver load and also after system
1990 * suspend. One way to solve this is to have a hardware state read-out
1991 * infrastructure which reconstructs the full software state (e.g. the i915
1994 * The simpler solution is to just reset the software state to everything off,
1995 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
1996 * the atomic helpers provide default reset implementations for all hooks.
2000 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2003 * Resets the atomic state for @crtc by freeing the state pointer (which might
2004 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2006 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2009 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2012 crtc->state->crtc = crtc;
2014 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2017 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2020 * Default CRTC state duplicate hook for drivers which don't have their own
2021 * subclassed CRTC state structure.
2023 struct drm_crtc_state *
2024 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2026 struct drm_crtc_state *state;
2028 if (WARN_ON(!crtc->state))
2031 state = kmemdup(crtc->state, sizeof(*crtc->state), GFP_KERNEL);
2034 state->mode_changed = false;
2035 state->active_changed = false;
2036 state->planes_changed = false;
2037 state->event = NULL;
2042 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2045 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2047 * @state: CRTC state object to release
2049 * Default CRTC state destroy hook for drivers which don't have their own
2050 * subclassed CRTC state structure.
2052 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2053 struct drm_crtc_state *state)
2057 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2060 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2063 * Resets the atomic state for @plane by freeing the state pointer (which might
2064 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2066 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2068 if (plane->state && plane->state->fb)
2069 drm_framebuffer_unreference(plane->state->fb);
2071 kfree(plane->state);
2072 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2075 plane->state->plane = plane;
2077 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2080 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2083 * Default plane state duplicate hook for drivers which don't have their own
2084 * subclassed plane state structure.
2086 struct drm_plane_state *
2087 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2089 struct drm_plane_state *state;
2091 if (WARN_ON(!plane->state))
2094 state = kmemdup(plane->state, sizeof(*plane->state), GFP_KERNEL);
2096 if (state && state->fb)
2097 drm_framebuffer_reference(state->fb);
2101 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2104 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2106 * @state: plane state object to release
2108 * Default plane state destroy hook for drivers which don't have their own
2109 * subclassed plane state structure.
2111 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2112 struct drm_plane_state *state)
2115 drm_framebuffer_unreference(state->fb);
2119 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2122 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2123 * @connector: drm connector
2125 * Resets the atomic state for @connector by freeing the state pointer (which
2126 * might be NULL, e.g. at driver load time) and allocating a new empty state
2129 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2131 kfree(connector->state);
2132 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2134 if (connector->state)
2135 connector->state->connector = connector;
2137 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2140 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2141 * @connector: drm connector
2143 * Default connector state duplicate hook for drivers which don't have their own
2144 * subclassed connector state structure.
2146 struct drm_connector_state *
2147 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2149 if (WARN_ON(!connector->state))
2152 return kmemdup(connector->state, sizeof(*connector->state), GFP_KERNEL);
2154 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2157 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2158 * @connector: drm connector
2159 * @state: connector state object to release
2161 * Default connector state destroy hook for drivers which don't have their own
2162 * subclassed connector state structure.
2164 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2165 struct drm_connector_state *state)
2169 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);