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)
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)
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)
799 for (i = 0; i < old_state->num_connector; i++) {
800 struct drm_connector *connector;
801 struct drm_encoder_helper_funcs *funcs;
802 struct drm_encoder *encoder;
804 connector = old_state->connectors[i];
806 if (!connector || !connector->state->best_encoder)
809 if (!connector->state->crtc->state->active)
812 encoder = connector->state->best_encoder;
813 funcs = encoder->helper_private;
816 * Each encoder has at most one connector (since we always steal
817 * it away), so we won't call call enable hooks twice.
820 encoder->bridge->funcs->pre_enable(encoder->bridge);
822 funcs->commit(encoder);
825 encoder->bridge->funcs->enable(encoder->bridge);
828 EXPORT_SYMBOL(drm_atomic_helper_commit_post_planes);
830 static void wait_for_fences(struct drm_device *dev,
831 struct drm_atomic_state *state)
833 int nplanes = dev->mode_config.num_total_plane;
836 for (i = 0; i < nplanes; i++) {
837 struct drm_plane *plane = state->planes[i];
839 if (!plane || !plane->state->fence)
842 WARN_ON(!plane->state->fb);
844 fence_wait(plane->state->fence, false);
845 fence_put(plane->state->fence);
846 plane->state->fence = NULL;
850 static bool framebuffer_changed(struct drm_device *dev,
851 struct drm_atomic_state *old_state,
852 struct drm_crtc *crtc)
854 struct drm_plane *plane;
855 struct drm_plane_state *old_plane_state;
856 int nplanes = old_state->dev->mode_config.num_total_plane;
859 for (i = 0; i < nplanes; i++) {
860 plane = old_state->planes[i];
861 old_plane_state = old_state->plane_states[i];
866 if (plane->state->crtc != crtc &&
867 old_plane_state->crtc != crtc)
870 if (plane->state->fb != old_plane_state->fb)
878 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
880 * @old_state: atomic state object with old state structures
882 * Helper to, after atomic commit, wait for vblanks on all effected
883 * crtcs (ie. before cleaning up old framebuffers using
884 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
885 * framebuffers have actually changed to optimize for the legacy cursor and
886 * plane update use-case.
889 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
890 struct drm_atomic_state *old_state)
892 struct drm_crtc *crtc;
893 struct drm_crtc_state *old_crtc_state;
894 int ncrtcs = old_state->dev->mode_config.num_crtc;
897 for (i = 0; i < ncrtcs; i++) {
898 crtc = old_state->crtcs[i];
899 old_crtc_state = old_state->crtc_states[i];
904 /* No one cares about the old state, so abuse it for tracking
905 * and store whether we hold a vblank reference (and should do a
906 * vblank wait) in the ->enable boolean. */
907 old_crtc_state->enable = false;
909 if (!crtc->state->enable)
912 if (!framebuffer_changed(dev, old_state, crtc))
915 ret = drm_crtc_vblank_get(crtc);
919 old_crtc_state->enable = true;
920 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
923 for (i = 0; i < ncrtcs; i++) {
924 crtc = old_state->crtcs[i];
925 old_crtc_state = old_state->crtc_states[i];
927 if (!crtc || !old_crtc_state->enable)
930 ret = wait_event_timeout(dev->vblank[i].queue,
931 old_crtc_state->last_vblank_count !=
932 drm_vblank_count(dev, i),
933 msecs_to_jiffies(50));
935 drm_crtc_vblank_put(crtc);
938 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
941 * drm_atomic_helper_commit - commit validated state object
943 * @state: the driver state object
944 * @async: asynchronous commit
946 * This function commits a with drm_atomic_helper_check() pre-validated state
947 * object. This can still fail when e.g. the framebuffer reservation fails. For
948 * now this doesn't implement asynchronous commits.
951 * Zero for success or -errno.
953 int drm_atomic_helper_commit(struct drm_device *dev,
954 struct drm_atomic_state *state,
962 ret = drm_atomic_helper_prepare_planes(dev, state);
967 * This is the point of no return - everything below never fails except
968 * when the hw goes bonghits. Which means we can commit the new state on
969 * the software side now.
972 drm_atomic_helper_swap_state(dev, state);
975 * Everything below can be run asynchronously without the need to grab
976 * any modeset locks at all under one conditions: It must be guaranteed
977 * that the asynchronous work has either been cancelled (if the driver
978 * supports it, which at least requires that the framebuffers get
979 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
980 * before the new state gets committed on the software side with
981 * drm_atomic_helper_swap_state().
983 * This scheme allows new atomic state updates to be prepared and
984 * checked in parallel to the asynchronous completion of the previous
985 * update. Which is important since compositors need to figure out the
986 * composition of the next frame right after having submitted the
990 wait_for_fences(dev, state);
992 drm_atomic_helper_commit_pre_planes(dev, state);
994 drm_atomic_helper_commit_planes(dev, state);
996 drm_atomic_helper_commit_post_planes(dev, state);
998 drm_atomic_helper_wait_for_vblanks(dev, state);
1000 drm_atomic_helper_cleanup_planes(dev, state);
1002 drm_atomic_state_free(state);
1006 EXPORT_SYMBOL(drm_atomic_helper_commit);
1009 * DOC: implementing async commit
1011 * For now the atomic helpers don't support async commit directly. If there is
1012 * real need it could be added though, using the dma-buf fence infrastructure
1013 * for generic synchronization with outstanding rendering.
1015 * For now drivers have to implement async commit themselves, with the following
1016 * sequence being the recommended one:
1018 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1019 * which commit needs to call which can fail, so we want to run it first and
1022 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1023 * might be affected the new state update. This can be done by either cancelling
1024 * or flushing the work items, depending upon whether the driver can deal with
1025 * cancelled updates. Note that it is important to ensure that the framebuffer
1026 * cleanup is still done when cancelling.
1028 * For sufficient parallelism it is recommended to have a work item per crtc
1029 * (for updates which don't touch global state) and a global one. Then we only
1030 * need to synchronize with the crtc work items for changed crtcs and the global
1031 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1033 * 3. The software state is updated synchronously with
1034 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1035 * locks means concurrent callers never see inconsistent state. And doing this
1036 * while it's guaranteed that no relevant async worker runs means that async
1037 * workers do not need grab any locks. Actually they must not grab locks, for
1038 * otherwise the work flushing will deadlock.
1040 * 4. Schedule a work item to do all subsequent steps, using the split-out
1041 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1042 * then cleaning up the framebuffers after the old framebuffer is no longer
1047 * drm_atomic_helper_prepare_planes - prepare plane resources after commit
1049 * @state: atomic state object with old state structures
1051 * This function prepares plane state, specifically framebuffers, for the new
1052 * configuration. If any failure is encountered this function will call
1053 * ->cleanup_fb on any already successfully prepared framebuffer.
1056 * 0 on success, negative error code on failure.
1058 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1059 struct drm_atomic_state *state)
1061 int nplanes = dev->mode_config.num_total_plane;
1064 for (i = 0; i < nplanes; i++) {
1065 struct drm_plane_helper_funcs *funcs;
1066 struct drm_plane *plane = state->planes[i];
1067 struct drm_framebuffer *fb;
1072 funcs = plane->helper_private;
1074 fb = state->plane_states[i]->fb;
1076 if (fb && funcs->prepare_fb) {
1077 ret = funcs->prepare_fb(plane, fb);
1086 for (i--; i >= 0; i--) {
1087 struct drm_plane_helper_funcs *funcs;
1088 struct drm_plane *plane = state->planes[i];
1089 struct drm_framebuffer *fb;
1094 funcs = plane->helper_private;
1096 fb = state->plane_states[i]->fb;
1098 if (fb && funcs->cleanup_fb)
1099 funcs->cleanup_fb(plane, fb);
1105 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1108 * drm_atomic_helper_commit_planes - commit plane state
1110 * @old_state: atomic state object with old state structures
1112 * This function commits the new plane state using the plane and atomic helper
1113 * functions for planes and crtcs. It assumes that the atomic state has already
1114 * been pushed into the relevant object state pointers, since this step can no
1117 * It still requires the global state object @old_state to know which planes and
1118 * crtcs need to be updated though.
1120 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1121 struct drm_atomic_state *old_state)
1123 int nplanes = dev->mode_config.num_total_plane;
1124 int ncrtcs = dev->mode_config.num_crtc;
1127 for (i = 0; i < ncrtcs; i++) {
1128 struct drm_crtc_helper_funcs *funcs;
1129 struct drm_crtc *crtc = old_state->crtcs[i];
1134 funcs = crtc->helper_private;
1136 if (!funcs || !funcs->atomic_begin)
1139 funcs->atomic_begin(crtc);
1142 for (i = 0; i < nplanes; i++) {
1143 struct drm_plane_helper_funcs *funcs;
1144 struct drm_plane *plane = old_state->planes[i];
1145 struct drm_plane_state *old_plane_state;
1150 funcs = plane->helper_private;
1152 if (!funcs || !funcs->atomic_update)
1155 old_plane_state = old_state->plane_states[i];
1157 funcs->atomic_update(plane, old_plane_state);
1160 for (i = 0; i < ncrtcs; i++) {
1161 struct drm_crtc_helper_funcs *funcs;
1162 struct drm_crtc *crtc = old_state->crtcs[i];
1167 funcs = crtc->helper_private;
1169 if (!funcs || !funcs->atomic_flush)
1172 funcs->atomic_flush(crtc);
1175 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1178 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1180 * @old_state: atomic state object with old state structures
1182 * This function cleans up plane state, specifically framebuffers, from the old
1183 * configuration. Hence the old configuration must be perserved in @old_state to
1184 * be able to call this function.
1186 * This function must also be called on the new state when the atomic update
1187 * fails at any point after calling drm_atomic_helper_prepare_planes().
1189 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1190 struct drm_atomic_state *old_state)
1192 int nplanes = dev->mode_config.num_total_plane;
1195 for (i = 0; i < nplanes; i++) {
1196 struct drm_plane_helper_funcs *funcs;
1197 struct drm_plane *plane = old_state->planes[i];
1198 struct drm_framebuffer *old_fb;
1203 funcs = plane->helper_private;
1205 old_fb = old_state->plane_states[i]->fb;
1207 if (old_fb && funcs->cleanup_fb)
1208 funcs->cleanup_fb(plane, old_fb);
1211 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1214 * drm_atomic_helper_swap_state - store atomic state into current sw state
1216 * @state: atomic state
1218 * This function stores the atomic state into the current state pointers in all
1219 * driver objects. It should be called after all failing steps have been done
1220 * and succeeded, but before the actual hardware state is committed.
1222 * For cleanup and error recovery the current state for all changed objects will
1223 * be swaped into @state.
1225 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1227 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1229 * 2. Do any other steps that might fail.
1231 * 3. Put the staged state into the current state pointers with this function.
1233 * 4. Actually commit the hardware state.
1235 * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3
1236 * contains the old state. Also do any other cleanup required with that state.
1238 void drm_atomic_helper_swap_state(struct drm_device *dev,
1239 struct drm_atomic_state *state)
1243 for (i = 0; i < dev->mode_config.num_connector; i++) {
1244 struct drm_connector *connector = state->connectors[i];
1249 connector->state->state = state;
1250 swap(state->connector_states[i], connector->state);
1251 connector->state->state = NULL;
1254 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1255 struct drm_crtc *crtc = state->crtcs[i];
1260 crtc->state->state = state;
1261 swap(state->crtc_states[i], crtc->state);
1262 crtc->state->state = NULL;
1265 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1266 struct drm_plane *plane = state->planes[i];
1271 plane->state->state = state;
1272 swap(state->plane_states[i], plane->state);
1273 plane->state->state = NULL;
1276 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1279 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1280 * @plane: plane object to update
1281 * @crtc: owning CRTC of owning plane
1282 * @fb: framebuffer to flip onto plane
1283 * @crtc_x: x offset of primary plane on crtc
1284 * @crtc_y: y offset of primary plane on crtc
1285 * @crtc_w: width of primary plane rectangle on crtc
1286 * @crtc_h: height of primary plane rectangle on crtc
1287 * @src_x: x offset of @fb for panning
1288 * @src_y: y offset of @fb for panning
1289 * @src_w: width of source rectangle in @fb
1290 * @src_h: height of source rectangle in @fb
1292 * Provides a default plane update handler using the atomic driver interface.
1295 * Zero on success, error code on failure
1297 int drm_atomic_helper_update_plane(struct drm_plane *plane,
1298 struct drm_crtc *crtc,
1299 struct drm_framebuffer *fb,
1300 int crtc_x, int crtc_y,
1301 unsigned int crtc_w, unsigned int crtc_h,
1302 uint32_t src_x, uint32_t src_y,
1303 uint32_t src_w, uint32_t src_h)
1305 struct drm_atomic_state *state;
1306 struct drm_plane_state *plane_state;
1309 state = drm_atomic_state_alloc(plane->dev);
1313 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1315 plane_state = drm_atomic_get_plane_state(state, plane);
1316 if (IS_ERR(plane_state)) {
1317 ret = PTR_ERR(plane_state);
1321 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1324 drm_atomic_set_fb_for_plane(plane_state, fb);
1325 plane_state->crtc_x = crtc_x;
1326 plane_state->crtc_y = crtc_y;
1327 plane_state->crtc_h = crtc_h;
1328 plane_state->crtc_w = crtc_w;
1329 plane_state->src_x = src_x;
1330 plane_state->src_y = src_y;
1331 plane_state->src_h = src_h;
1332 plane_state->src_w = src_w;
1334 ret = drm_atomic_commit(state);
1338 /* Driver takes ownership of state on successful commit. */
1341 if (ret == -EDEADLK)
1344 drm_atomic_state_free(state);
1348 drm_atomic_state_clear(state);
1349 drm_atomic_legacy_backoff(state);
1352 * Someone might have exchanged the framebuffer while we dropped locks
1353 * in the backoff code. We need to fix up the fb refcount tracking the
1356 plane->old_fb = plane->fb;
1360 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1363 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1364 * @plane: plane to disable
1366 * Provides a default plane disable handler using the atomic driver interface.
1369 * Zero on success, error code on failure
1371 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1373 struct drm_atomic_state *state;
1374 struct drm_plane_state *plane_state;
1378 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1379 * acquire context. The real fix will be to wire the acquire ctx through
1380 * everywhere we need it, but meanwhile prevent chaos by just skipping
1381 * this noop. The critical case is the cursor ioctls which a) only grab
1382 * crtc/cursor-plane locks (so we need the crtc to get at the right
1383 * acquire context) and b) can try to disable the plane multiple times.
1388 state = drm_atomic_state_alloc(plane->dev);
1392 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1394 plane_state = drm_atomic_get_plane_state(state, plane);
1395 if (IS_ERR(plane_state)) {
1396 ret = PTR_ERR(plane_state);
1400 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1403 drm_atomic_set_fb_for_plane(plane_state, NULL);
1404 plane_state->crtc_x = 0;
1405 plane_state->crtc_y = 0;
1406 plane_state->crtc_h = 0;
1407 plane_state->crtc_w = 0;
1408 plane_state->src_x = 0;
1409 plane_state->src_y = 0;
1410 plane_state->src_h = 0;
1411 plane_state->src_w = 0;
1413 ret = drm_atomic_commit(state);
1417 /* Driver takes ownership of state on successful commit. */
1420 if (ret == -EDEADLK)
1423 drm_atomic_state_free(state);
1427 drm_atomic_state_clear(state);
1428 drm_atomic_legacy_backoff(state);
1431 * Someone might have exchanged the framebuffer while we dropped locks
1432 * in the backoff code. We need to fix up the fb refcount tracking the
1435 plane->old_fb = plane->fb;
1439 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1441 static int update_output_state(struct drm_atomic_state *state,
1442 struct drm_mode_set *set)
1444 struct drm_device *dev = set->crtc->dev;
1445 struct drm_connector_state *conn_state;
1446 int ncrtcs = state->dev->mode_config.num_crtc;
1449 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1450 state->acquire_ctx);
1454 /* First grab all affected connector/crtc states. */
1455 for (i = 0; i < set->num_connectors; i++) {
1456 conn_state = drm_atomic_get_connector_state(state,
1457 set->connectors[i]);
1458 if (IS_ERR(conn_state))
1459 return PTR_ERR(conn_state);
1462 for (i = 0; i < ncrtcs; i++) {
1463 struct drm_crtc *crtc = state->crtcs[i];
1468 ret = drm_atomic_add_affected_connectors(state, crtc);
1473 /* Then recompute connector->crtc links and crtc enabling state. */
1474 for (i = 0; i < state->num_connector; i++) {
1475 struct drm_connector *connector;
1477 connector = state->connectors[i];
1478 conn_state = state->connector_states[i];
1483 if (conn_state->crtc == set->crtc) {
1484 ret = drm_atomic_set_crtc_for_connector(conn_state,
1490 for (j = 0; j < set->num_connectors; j++) {
1491 if (set->connectors[j] == connector) {
1492 ret = drm_atomic_set_crtc_for_connector(conn_state,
1501 for (i = 0; i < ncrtcs; i++) {
1502 struct drm_crtc *crtc = state->crtcs[i];
1503 struct drm_crtc_state *crtc_state = state->crtc_states[i];
1508 /* Don't update ->enable for the CRTC in the set_config request,
1509 * since a mismatch would indicate a bug in the upper layers.
1510 * The actual modeset code later on will catch any
1511 * inconsistencies here. */
1512 if (crtc == set->crtc)
1515 crtc_state->enable =
1516 drm_atomic_connectors_for_crtc(state, crtc);
1523 * drm_atomic_helper_set_config - set a new config from userspace
1524 * @set: mode set configuration
1526 * Provides a default crtc set_config handler using the atomic driver interface.
1529 * Returns 0 on success, negative errno numbers on failure.
1531 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1533 struct drm_atomic_state *state;
1534 struct drm_crtc *crtc = set->crtc;
1535 struct drm_crtc_state *crtc_state;
1536 struct drm_plane_state *primary_state;
1539 state = drm_atomic_state_alloc(crtc->dev);
1543 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1545 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1546 if (IS_ERR(crtc_state)) {
1547 ret = PTR_ERR(crtc_state);
1551 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1552 if (IS_ERR(primary_state)) {
1553 ret = PTR_ERR(primary_state);
1559 WARN_ON(set->num_connectors);
1561 crtc_state->enable = false;
1562 crtc_state->active = false;
1564 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1568 drm_atomic_set_fb_for_plane(primary_state, NULL);
1574 WARN_ON(!set->num_connectors);
1576 crtc_state->enable = true;
1577 crtc_state->active = true;
1578 drm_mode_copy(&crtc_state->mode, set->mode);
1580 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1583 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1584 primary_state->crtc_x = 0;
1585 primary_state->crtc_y = 0;
1586 primary_state->crtc_h = set->mode->vdisplay;
1587 primary_state->crtc_w = set->mode->hdisplay;
1588 primary_state->src_x = set->x << 16;
1589 primary_state->src_y = set->y << 16;
1590 primary_state->src_h = set->mode->vdisplay << 16;
1591 primary_state->src_w = set->mode->hdisplay << 16;
1594 ret = update_output_state(state, set);
1598 ret = drm_atomic_commit(state);
1602 /* Driver takes ownership of state on successful commit. */
1605 if (ret == -EDEADLK)
1608 drm_atomic_state_free(state);
1612 drm_atomic_state_clear(state);
1613 drm_atomic_legacy_backoff(state);
1616 * Someone might have exchanged the framebuffer while we dropped locks
1617 * in the backoff code. We need to fix up the fb refcount tracking the
1620 crtc->primary->old_fb = crtc->primary->fb;
1624 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1627 * drm_atomic_helper_crtc_set_property - helper for crtc prorties
1629 * @property: DRM property
1630 * @val: value of property
1632 * Provides a default plane disablle handler using the atomic driver interface.
1635 * Zero on success, error code on failure
1638 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1639 struct drm_property *property,
1642 struct drm_atomic_state *state;
1643 struct drm_crtc_state *crtc_state;
1646 state = drm_atomic_state_alloc(crtc->dev);
1650 /* ->set_property is always called with all locks held. */
1651 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1653 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1654 if (IS_ERR(crtc_state)) {
1655 ret = PTR_ERR(crtc_state);
1659 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1664 ret = drm_atomic_commit(state);
1668 /* Driver takes ownership of state on successful commit. */
1671 if (ret == -EDEADLK)
1674 drm_atomic_state_free(state);
1678 drm_atomic_state_clear(state);
1679 drm_atomic_legacy_backoff(state);
1683 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1686 * drm_atomic_helper_plane_set_property - helper for plane prorties
1688 * @property: DRM property
1689 * @val: value of property
1691 * Provides a default plane disable handler using the atomic driver interface.
1694 * Zero on success, error code on failure
1697 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1698 struct drm_property *property,
1701 struct drm_atomic_state *state;
1702 struct drm_plane_state *plane_state;
1705 state = drm_atomic_state_alloc(plane->dev);
1709 /* ->set_property is always called with all locks held. */
1710 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1712 plane_state = drm_atomic_get_plane_state(state, plane);
1713 if (IS_ERR(plane_state)) {
1714 ret = PTR_ERR(plane_state);
1718 ret = drm_atomic_plane_set_property(plane, plane_state,
1723 ret = drm_atomic_commit(state);
1727 /* Driver takes ownership of state on successful commit. */
1730 if (ret == -EDEADLK)
1733 drm_atomic_state_free(state);
1737 drm_atomic_state_clear(state);
1738 drm_atomic_legacy_backoff(state);
1742 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1745 * drm_atomic_helper_connector_set_property - helper for connector prorties
1746 * @connector: DRM connector
1747 * @property: DRM property
1748 * @val: value of property
1750 * Provides a default plane disablle handler using the atomic driver interface.
1753 * Zero on success, error code on failure
1756 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1757 struct drm_property *property,
1760 struct drm_atomic_state *state;
1761 struct drm_connector_state *connector_state;
1764 state = drm_atomic_state_alloc(connector->dev);
1768 /* ->set_property is always called with all locks held. */
1769 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1771 connector_state = drm_atomic_get_connector_state(state, connector);
1772 if (IS_ERR(connector_state)) {
1773 ret = PTR_ERR(connector_state);
1777 ret = drm_atomic_connector_set_property(connector, connector_state,
1782 ret = drm_atomic_commit(state);
1786 /* Driver takes ownership of state on successful commit. */
1789 if (ret == -EDEADLK)
1792 drm_atomic_state_free(state);
1796 drm_atomic_state_clear(state);
1797 drm_atomic_legacy_backoff(state);
1801 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1804 * drm_atomic_helper_page_flip - execute a legacy page flip
1806 * @fb: DRM framebuffer
1807 * @event: optional DRM event to signal upon completion
1808 * @flags: flip flags for non-vblank sync'ed updates
1810 * Provides a default page flip implementation using the atomic driver interface.
1812 * Note that for now so called async page flips (i.e. updates which are not
1813 * synchronized to vblank) are not supported, since the atomic interfaces have
1814 * no provisions for this yet.
1817 * Returns 0 on success, negative errno numbers on failure.
1819 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1820 struct drm_framebuffer *fb,
1821 struct drm_pending_vblank_event *event,
1824 struct drm_plane *plane = crtc->primary;
1825 struct drm_atomic_state *state;
1826 struct drm_plane_state *plane_state;
1827 struct drm_crtc_state *crtc_state;
1830 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1833 state = drm_atomic_state_alloc(plane->dev);
1837 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1839 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1840 if (IS_ERR(crtc_state)) {
1841 ret = PTR_ERR(crtc_state);
1844 crtc_state->event = event;
1846 plane_state = drm_atomic_get_plane_state(state, plane);
1847 if (IS_ERR(plane_state)) {
1848 ret = PTR_ERR(plane_state);
1852 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1855 drm_atomic_set_fb_for_plane(plane_state, fb);
1857 ret = drm_atomic_async_commit(state);
1861 /* TODO: ->page_flip is the only driver callback where the core
1862 * doesn't update plane->fb. For now patch it up here. */
1863 plane->fb = plane->state->fb;
1865 /* Driver takes ownership of state on successful async commit. */
1868 if (ret == -EDEADLK)
1871 drm_atomic_state_free(state);
1875 drm_atomic_state_clear(state);
1876 drm_atomic_legacy_backoff(state);
1879 * Someone might have exchanged the framebuffer while we dropped locks
1880 * in the backoff code. We need to fix up the fb refcount tracking the
1883 plane->old_fb = plane->fb;
1887 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1890 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1891 * @connector: affected connector
1894 * This is the main helper function provided by the atomic helper framework for
1895 * implementing the legacy DPMS connector interface. It computes the new desired
1896 * ->active state for the corresponding CRTC (if the connector is enabled) and
1899 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1902 struct drm_mode_config *config = &connector->dev->mode_config;
1903 struct drm_atomic_state *state;
1904 struct drm_crtc_state *crtc_state;
1905 struct drm_crtc *crtc;
1906 struct drm_connector *tmp_connector;
1908 bool active = false;
1910 if (mode != DRM_MODE_DPMS_ON)
1911 mode = DRM_MODE_DPMS_OFF;
1913 connector->dpms = mode;
1914 crtc = connector->state->crtc;
1919 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1920 state = drm_atomic_state_alloc(connector->dev);
1924 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1926 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1927 if (IS_ERR(crtc_state))
1930 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1932 list_for_each_entry(tmp_connector, &config->connector_list, head) {
1933 if (connector->state->crtc != crtc)
1936 if (connector->dpms == DRM_MODE_DPMS_ON) {
1941 crtc_state->active = active;
1943 ret = drm_atomic_commit(state);
1947 /* Driver takes ownership of state on successful async commit. */
1950 if (ret == -EDEADLK)
1953 drm_atomic_state_free(state);
1955 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
1959 drm_atomic_state_clear(state);
1960 drm_atomic_legacy_backoff(state);
1964 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
1967 * DOC: atomic state reset and initialization
1969 * Both the drm core and the atomic helpers assume that there is always the full
1970 * and correct atomic software state for all connectors, CRTCs and planes
1971 * available. Which is a bit a problem on driver load and also after system
1972 * suspend. One way to solve this is to have a hardware state read-out
1973 * infrastructure which reconstructs the full software state (e.g. the i915
1976 * The simpler solution is to just reset the software state to everything off,
1977 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
1978 * the atomic helpers provide default reset implementations for all hooks.
1982 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
1985 * Resets the atomic state for @crtc by freeing the state pointer (which might
1986 * be NULL, e.g. at driver load time) and allocating a new empty state object.
1988 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
1991 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
1994 crtc->state->crtc = crtc;
1996 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
1999 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2002 * Default CRTC state duplicate hook for drivers which don't have their own
2003 * subclassed CRTC state structure.
2005 struct drm_crtc_state *
2006 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2008 struct drm_crtc_state *state;
2010 if (WARN_ON(!crtc->state))
2013 state = kmemdup(crtc->state, sizeof(*crtc->state), GFP_KERNEL);
2016 state->mode_changed = false;
2017 state->active_changed = false;
2018 state->planes_changed = false;
2019 state->event = NULL;
2024 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2027 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2029 * @state: CRTC state object to release
2031 * Default CRTC state destroy hook for drivers which don't have their own
2032 * subclassed CRTC state structure.
2034 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2035 struct drm_crtc_state *state)
2039 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2042 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2045 * Resets the atomic state for @plane by freeing the state pointer (which might
2046 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2048 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2050 if (plane->state && plane->state->fb)
2051 drm_framebuffer_unreference(plane->state->fb);
2053 kfree(plane->state);
2054 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2057 plane->state->plane = plane;
2059 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2062 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2065 * Default plane state duplicate hook for drivers which don't have their own
2066 * subclassed plane state structure.
2068 struct drm_plane_state *
2069 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2071 struct drm_plane_state *state;
2073 if (WARN_ON(!plane->state))
2076 state = kmemdup(plane->state, sizeof(*plane->state), GFP_KERNEL);
2078 if (state && state->fb)
2079 drm_framebuffer_reference(state->fb);
2083 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2086 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2088 * @state: plane state object to release
2090 * Default plane state destroy hook for drivers which don't have their own
2091 * subclassed plane state structure.
2093 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2094 struct drm_plane_state *state)
2097 drm_framebuffer_unreference(state->fb);
2101 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2104 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2105 * @connector: drm connector
2107 * Resets the atomic state for @connector by freeing the state pointer (which
2108 * might be NULL, e.g. at driver load time) and allocating a new empty state
2111 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2113 kfree(connector->state);
2114 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2116 if (connector->state)
2117 connector->state->connector = connector;
2119 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2122 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2123 * @connector: drm connector
2125 * Default connector state duplicate hook for drivers which don't have their own
2126 * subclassed connector state structure.
2128 struct drm_connector_state *
2129 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2131 if (WARN_ON(!connector->state))
2134 return kmemdup(connector->state, sizeof(*connector->state), GFP_KERNEL);
2136 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2139 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2140 * @connector: drm connector
2141 * @state: connector state object to release
2143 * Default connector state destroy hook for drivers which don't have their own
2144 * subclassed connector state structure.
2146 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2147 struct drm_connector_state *state)
2151 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);