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_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
120 encoder->base.id, encoder->name,
121 encoder_crtc->base.id);
123 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
124 if (IS_ERR(crtc_state))
125 return PTR_ERR(crtc_state);
127 crtc_state->mode_changed = true;
129 list_for_each_entry(connector, &config->connector_list, head) {
130 if (connector->state->best_encoder != encoder)
133 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
137 connector_state = drm_atomic_get_connector_state(state,
139 if (IS_ERR(connector_state))
140 return PTR_ERR(connector_state);
142 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
145 connector_state->best_encoder = NULL;
152 update_connector_routing(struct drm_atomic_state *state, int conn_idx)
154 const struct drm_connector_helper_funcs *funcs;
155 struct drm_encoder *new_encoder;
156 struct drm_crtc *encoder_crtc;
157 struct drm_connector *connector;
158 struct drm_connector_state *connector_state;
159 struct drm_crtc_state *crtc_state;
162 connector = state->connectors[conn_idx];
163 connector_state = state->connector_states[conn_idx];
168 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
172 if (connector->state->crtc != connector_state->crtc) {
173 if (connector->state->crtc) {
174 idx = drm_crtc_index(connector->state->crtc);
176 crtc_state = state->crtc_states[idx];
177 crtc_state->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_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
193 connector_state->best_encoder = NULL;
198 funcs = connector->helper_private;
199 new_encoder = funcs->best_encoder(connector);
202 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
208 if (new_encoder == connector_state->best_encoder) {
209 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
212 new_encoder->base.id,
214 connector_state->crtc->base.id);
219 encoder_crtc = get_current_crtc_for_encoder(state->dev,
223 ret = steal_encoder(state, new_encoder, encoder_crtc);
225 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
232 connector_state->best_encoder = new_encoder;
233 idx = drm_crtc_index(connector_state->crtc);
235 crtc_state = state->crtc_states[idx];
236 crtc_state->mode_changed = true;
238 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
241 new_encoder->base.id,
243 connector_state->crtc->base.id);
249 mode_fixup(struct drm_atomic_state *state)
251 struct drm_crtc *crtc;
252 struct drm_crtc_state *crtc_state;
253 struct drm_connector *connector;
254 struct drm_connector_state *conn_state;
258 for_each_crtc_in_state(state, crtc, crtc_state, i) {
259 if (!crtc_state->mode_changed)
262 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
265 for_each_connector_in_state(state, connector, conn_state, i) {
266 const struct drm_encoder_helper_funcs *funcs;
267 struct drm_encoder *encoder;
269 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
271 if (!conn_state->crtc || !conn_state->best_encoder)
275 state->crtc_states[drm_crtc_index(conn_state->crtc)];
278 * Each encoder has at most one connector (since we always steal
279 * it away), so we won't call ->mode_fixup twice.
281 encoder = conn_state->best_encoder;
282 funcs = encoder->helper_private;
284 if (encoder->bridge && encoder->bridge->funcs->mode_fixup) {
285 ret = encoder->bridge->funcs->mode_fixup(
286 encoder->bridge, &crtc_state->mode,
287 &crtc_state->adjusted_mode);
289 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
294 if (funcs->atomic_check) {
295 ret = funcs->atomic_check(encoder, crtc_state,
298 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
299 encoder->base.id, encoder->name);
303 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
304 &crtc_state->adjusted_mode);
306 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
307 encoder->base.id, encoder->name);
313 for_each_crtc_in_state(state, crtc, crtc_state, i) {
314 const struct drm_crtc_helper_funcs *funcs;
316 if (!crtc_state->mode_changed)
319 funcs = crtc->helper_private;
320 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
321 &crtc_state->adjusted_mode);
323 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
333 needs_modeset(struct drm_crtc_state *state)
335 return state->mode_changed || state->active_changed;
339 * drm_atomic_helper_check_modeset - validate state object for modeset changes
341 * @state: the driver state object
343 * Check the state object to see if the requested state is physically possible.
344 * This does all the crtc and connector related computations for an atomic
345 * update. It computes and updates crtc_state->mode_changed, adds any additional
346 * connectors needed for full modesets and calls down into ->mode_fixup
347 * functions of the driver backend.
351 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
352 * plane update can't be done without a full modeset) _must_ call this function
353 * afterwards after that change. It is permitted to call this function multiple
354 * times for the same update, e.g. when the ->atomic_check functions depend upon
355 * the adjusted dotclock for fifo space allocation and watermark computation.
358 * Zero for success or -errno
361 drm_atomic_helper_check_modeset(struct drm_device *dev,
362 struct drm_atomic_state *state)
364 struct drm_crtc *crtc;
365 struct drm_crtc_state *crtc_state;
366 struct drm_connector *connector;
367 struct drm_connector_state *connector_state;
370 for_each_crtc_in_state(state, crtc, crtc_state, i) {
371 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
372 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
374 crtc_state->mode_changed = true;
377 if (crtc->state->enable != crtc_state->enable) {
378 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
380 crtc_state->mode_changed = true;
384 for_each_connector_in_state(state, connector, connector_state, i) {
386 * This only sets crtc->mode_changed for routing changes,
387 * drivers must set crtc->mode_changed themselves when connector
388 * properties need to be updated.
390 ret = update_connector_routing(state, i);
396 * After all the routing has been prepared we need to add in any
397 * connector which is itself unchanged, but who's crtc changes it's
398 * configuration. This must be done before calling mode_fixup in case a
399 * crtc only changed its mode but has the same set of connectors.
401 for_each_crtc_in_state(state, crtc, crtc_state, i) {
405 * We must set ->active_changed after walking connectors for
406 * otherwise an update that only changes active would result in
407 * a full modeset because update_connector_routing force that.
409 if (crtc->state->active != crtc_state->active) {
410 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
412 crtc_state->active_changed = true;
415 if (!needs_modeset(crtc_state))
418 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
420 crtc_state->enable ? 'y' : 'n',
421 crtc_state->active ? 'y' : 'n');
423 ret = drm_atomic_add_affected_connectors(state, crtc);
427 num_connectors = drm_atomic_connectors_for_crtc(state,
430 if (crtc_state->enable != !!num_connectors) {
431 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
438 return mode_fixup(state);
440 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
443 * drm_atomic_helper_check_planes - validate state object for planes changes
445 * @state: the driver state object
447 * Check the state object to see if the requested state is physically possible.
448 * This does all the plane update related checks using by calling into the
449 * ->atomic_check hooks provided by the driver.
452 * Zero for success or -errno
455 drm_atomic_helper_check_planes(struct drm_device *dev,
456 struct drm_atomic_state *state)
458 struct drm_crtc *crtc;
459 struct drm_crtc_state *crtc_state;
460 struct drm_plane *plane;
461 struct drm_plane_state *plane_state;
464 for_each_plane_in_state(state, plane, plane_state, i) {
465 const struct drm_plane_helper_funcs *funcs;
467 funcs = plane->helper_private;
469 drm_atomic_helper_plane_changed(state, plane_state, plane);
471 if (!funcs || !funcs->atomic_check)
474 ret = funcs->atomic_check(plane, plane_state);
476 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
482 for_each_crtc_in_state(state, crtc, crtc_state, i) {
483 const struct drm_crtc_helper_funcs *funcs;
485 funcs = crtc->helper_private;
487 if (!funcs || !funcs->atomic_check)
490 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
492 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
500 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
503 * drm_atomic_helper_check - validate state object
505 * @state: the driver state object
507 * Check the state object to see if the requested state is physically possible.
508 * Only crtcs and planes have check callbacks, so for any additional (global)
509 * checking that a driver needs it can simply wrap that around this function.
510 * Drivers without such needs can directly use this as their ->atomic_check()
513 * This just wraps the two parts of the state checking for planes and modeset
514 * state in the default order: First it calls drm_atomic_helper_check_modeset()
515 * and then drm_atomic_helper_check_planes(). The assumption is that the
516 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
517 * e.g. properly compute watermarks.
520 * Zero for success or -errno
522 int drm_atomic_helper_check(struct drm_device *dev,
523 struct drm_atomic_state *state)
527 ret = drm_atomic_helper_check_modeset(dev, state);
531 ret = drm_atomic_helper_check_planes(dev, state);
537 EXPORT_SYMBOL(drm_atomic_helper_check);
540 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
542 struct drm_connector *connector;
543 struct drm_connector_state *old_conn_state;
544 struct drm_crtc *crtc;
545 struct drm_crtc_state *old_crtc_state;
548 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
549 const struct drm_encoder_helper_funcs *funcs;
550 struct drm_encoder *encoder;
551 struct drm_crtc_state *old_crtc_state;
553 /* Shut down everything that's in the changeset and currently
554 * still on. So need to check the old, saved state. */
555 if (!old_conn_state->crtc)
558 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
560 if (!old_crtc_state->active ||
561 !needs_modeset(old_conn_state->crtc->state))
564 encoder = old_conn_state->best_encoder;
566 /* We shouldn't get this far if we didn't previously have
567 * an encoder.. but WARN_ON() rather than explode.
569 if (WARN_ON(!encoder))
572 funcs = encoder->helper_private;
574 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
575 encoder->base.id, encoder->name);
578 * Each encoder has at most one connector (since we always steal
579 * it away), so we won't call disable hooks twice.
582 encoder->bridge->funcs->disable(encoder->bridge);
584 /* Right function depends upon target state. */
585 if (connector->state->crtc && funcs->prepare)
586 funcs->prepare(encoder);
587 else if (funcs->disable)
588 funcs->disable(encoder);
590 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
593 encoder->bridge->funcs->post_disable(encoder->bridge);
596 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
597 const struct drm_crtc_helper_funcs *funcs;
599 /* Shut down everything that needs a full modeset. */
600 if (!needs_modeset(crtc->state))
603 if (!old_crtc_state->active)
606 funcs = crtc->helper_private;
608 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
612 /* Right function depends upon target state. */
613 if (crtc->state->enable && funcs->prepare)
614 funcs->prepare(crtc);
615 else if (funcs->disable)
616 funcs->disable(crtc);
618 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
623 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
625 * @old_state: atomic state object with old state structures
627 * This function updates all the various legacy modeset state pointers in
628 * connectors, encoders and crtcs. It also updates the timestamping constants
629 * used for precise vblank timestamps by calling
630 * drm_calc_timestamping_constants().
632 * Drivers can use this for building their own atomic commit if they don't have
633 * a pure helper-based modeset implementation.
636 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
637 struct drm_atomic_state *old_state)
639 struct drm_connector *connector;
640 struct drm_connector_state *old_conn_state;
641 struct drm_crtc *crtc;
642 struct drm_crtc_state *old_crtc_state;
645 /* clear out existing links */
646 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
647 if (!connector->encoder)
650 WARN_ON(!connector->encoder->crtc);
652 connector->encoder->crtc = NULL;
653 connector->encoder = NULL;
657 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
658 if (!connector->state->crtc)
661 if (WARN_ON(!connector->state->best_encoder))
664 connector->encoder = connector->state->best_encoder;
665 connector->encoder->crtc = connector->state->crtc;
668 /* set legacy state in the crtc structure */
669 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
670 crtc->mode = crtc->state->mode;
671 crtc->enabled = crtc->state->enable;
672 crtc->x = crtc->primary->state->src_x >> 16;
673 crtc->y = crtc->primary->state->src_y >> 16;
675 if (crtc->state->enable)
676 drm_calc_timestamping_constants(crtc,
677 &crtc->state->adjusted_mode);
680 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
683 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
685 struct drm_crtc *crtc;
686 struct drm_crtc_state *old_crtc_state;
687 struct drm_connector *connector;
688 struct drm_connector_state *old_conn_state;
691 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
692 const struct drm_crtc_helper_funcs *funcs;
694 if (!crtc->state->mode_changed)
697 funcs = crtc->helper_private;
699 if (crtc->state->enable && funcs->mode_set_nofb) {
700 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
703 funcs->mode_set_nofb(crtc);
707 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
708 const struct drm_encoder_helper_funcs *funcs;
709 struct drm_crtc_state *new_crtc_state;
710 struct drm_encoder *encoder;
711 struct drm_display_mode *mode, *adjusted_mode;
713 if (!connector->state->best_encoder)
716 encoder = connector->state->best_encoder;
717 funcs = encoder->helper_private;
718 new_crtc_state = connector->state->crtc->state;
719 mode = &new_crtc_state->mode;
720 adjusted_mode = &new_crtc_state->adjusted_mode;
722 if (!new_crtc_state->mode_changed)
725 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
726 encoder->base.id, encoder->name);
729 * Each encoder has at most one connector (since we always steal
730 * it away), so we won't call mode_set hooks twice.
733 funcs->mode_set(encoder, mode, adjusted_mode);
735 if (encoder->bridge && encoder->bridge->funcs->mode_set)
736 encoder->bridge->funcs->mode_set(encoder->bridge,
737 mode, adjusted_mode);
742 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
744 * @old_state: atomic state object with old state structures
746 * This function shuts down all the outputs that need to be shut down and
747 * prepares them (if required) with the new mode.
749 * For compatability with legacy crtc helpers this should be called before
750 * drm_atomic_helper_commit_planes(), which is what the default commit function
751 * does. But drivers with different needs can group the modeset commits together
752 * and do the plane commits at the end. This is useful for drivers doing runtime
753 * PM since planes updates then only happen when the CRTC is actually enabled.
755 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
756 struct drm_atomic_state *old_state)
758 disable_outputs(dev, old_state);
760 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
762 crtc_set_mode(dev, old_state);
764 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
767 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
769 * @old_state: atomic state object with old state structures
771 * This function enables all the outputs with the new configuration which had to
772 * be turned off for the update.
774 * For compatability with legacy crtc helpers this should be called after
775 * drm_atomic_helper_commit_planes(), which is what the default commit function
776 * does. But drivers with different needs can group the modeset commits together
777 * and do the plane commits at the end. This is useful for drivers doing runtime
778 * PM since planes updates then only happen when the CRTC is actually enabled.
780 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
781 struct drm_atomic_state *old_state)
783 struct drm_crtc *crtc;
784 struct drm_crtc_state *old_crtc_state;
785 struct drm_connector *connector;
786 struct drm_connector_state *old_conn_state;
789 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
790 const struct drm_crtc_helper_funcs *funcs;
792 /* Need to filter out CRTCs where only planes change. */
793 if (!needs_modeset(crtc->state))
796 if (!crtc->state->active)
799 funcs = crtc->helper_private;
801 if (crtc->state->enable) {
802 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
812 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
813 const struct drm_encoder_helper_funcs *funcs;
814 struct drm_encoder *encoder;
816 if (!connector->state->best_encoder)
819 if (!connector->state->crtc->state->active ||
820 !needs_modeset(connector->state->crtc->state))
823 encoder = connector->state->best_encoder;
824 funcs = encoder->helper_private;
826 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
827 encoder->base.id, encoder->name);
830 * Each encoder has at most one connector (since we always steal
831 * it away), so we won't call enable hooks twice.
834 encoder->bridge->funcs->pre_enable(encoder->bridge);
837 funcs->enable(encoder);
839 funcs->commit(encoder);
842 encoder->bridge->funcs->enable(encoder->bridge);
845 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
847 static void wait_for_fences(struct drm_device *dev,
848 struct drm_atomic_state *state)
850 struct drm_plane *plane;
851 struct drm_plane_state *plane_state;
854 for_each_plane_in_state(state, plane, plane_state, i) {
855 if (!plane->state->fence)
858 WARN_ON(!plane->state->fb);
860 fence_wait(plane->state->fence, false);
861 fence_put(plane->state->fence);
862 plane->state->fence = NULL;
866 static bool framebuffer_changed(struct drm_device *dev,
867 struct drm_atomic_state *old_state,
868 struct drm_crtc *crtc)
870 struct drm_plane *plane;
871 struct drm_plane_state *old_plane_state;
874 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
875 if (plane->state->crtc != crtc &&
876 old_plane_state->crtc != crtc)
879 if (plane->state->fb != old_plane_state->fb)
887 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
889 * @old_state: atomic state object with old state structures
891 * Helper to, after atomic commit, wait for vblanks on all effected
892 * crtcs (ie. before cleaning up old framebuffers using
893 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
894 * framebuffers have actually changed to optimize for the legacy cursor and
895 * plane update use-case.
898 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
899 struct drm_atomic_state *old_state)
901 struct drm_crtc *crtc;
902 struct drm_crtc_state *old_crtc_state;
905 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
906 /* No one cares about the old state, so abuse it for tracking
907 * and store whether we hold a vblank reference (and should do a
908 * vblank wait) in the ->enable boolean. */
909 old_crtc_state->enable = false;
911 if (!crtc->state->enable)
914 /* Legacy cursor ioctls are completely unsynced, and userspace
915 * relies on that (by doing tons of cursor updates). */
916 if (old_state->legacy_cursor_update)
919 if (!framebuffer_changed(dev, old_state, crtc))
922 ret = drm_crtc_vblank_get(crtc);
926 old_crtc_state->enable = true;
927 old_crtc_state->last_vblank_count = drm_vblank_count(dev, i);
930 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
931 if (!old_crtc_state->enable)
934 ret = wait_event_timeout(dev->vblank[i].queue,
935 old_crtc_state->last_vblank_count !=
936 drm_vblank_count(dev, i),
937 msecs_to_jiffies(50));
939 drm_crtc_vblank_put(crtc);
942 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
945 * drm_atomic_helper_commit - commit validated state object
947 * @state: the driver state object
948 * @async: asynchronous commit
950 * This function commits a with drm_atomic_helper_check() pre-validated state
951 * object. This can still fail when e.g. the framebuffer reservation fails. For
952 * now this doesn't implement asynchronous commits.
955 * Zero for success or -errno.
957 int drm_atomic_helper_commit(struct drm_device *dev,
958 struct drm_atomic_state *state,
966 ret = drm_atomic_helper_prepare_planes(dev, state);
971 * This is the point of no return - everything below never fails except
972 * when the hw goes bonghits. Which means we can commit the new state on
973 * the software side now.
976 drm_atomic_helper_swap_state(dev, state);
979 * Everything below can be run asynchronously without the need to grab
980 * any modeset locks at all under one condition: It must be guaranteed
981 * that the asynchronous work has either been cancelled (if the driver
982 * supports it, which at least requires that the framebuffers get
983 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
984 * before the new state gets committed on the software side with
985 * drm_atomic_helper_swap_state().
987 * This scheme allows new atomic state updates to be prepared and
988 * checked in parallel to the asynchronous completion of the previous
989 * update. Which is important since compositors need to figure out the
990 * composition of the next frame right after having submitted the
994 wait_for_fences(dev, state);
996 drm_atomic_helper_commit_modeset_disables(dev, state);
998 drm_atomic_helper_commit_planes(dev, state);
1000 drm_atomic_helper_commit_modeset_enables(dev, state);
1002 drm_atomic_helper_wait_for_vblanks(dev, state);
1004 drm_atomic_helper_cleanup_planes(dev, state);
1006 drm_atomic_state_free(state);
1010 EXPORT_SYMBOL(drm_atomic_helper_commit);
1013 * DOC: implementing async commit
1015 * For now the atomic helpers don't support async commit directly. If there is
1016 * real need it could be added though, using the dma-buf fence infrastructure
1017 * for generic synchronization with outstanding rendering.
1019 * For now drivers have to implement async commit themselves, with the following
1020 * sequence being the recommended one:
1022 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1023 * which commit needs to call which can fail, so we want to run it first and
1026 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1027 * might be affected the new state update. This can be done by either cancelling
1028 * or flushing the work items, depending upon whether the driver can deal with
1029 * cancelled updates. Note that it is important to ensure that the framebuffer
1030 * cleanup is still done when cancelling.
1032 * For sufficient parallelism it is recommended to have a work item per crtc
1033 * (for updates which don't touch global state) and a global one. Then we only
1034 * need to synchronize with the crtc work items for changed crtcs and the global
1035 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1037 * 3. The software state is updated synchronously with
1038 * drm_atomic_helper_swap_state. Doing this under the protection of all modeset
1039 * locks means concurrent callers never see inconsistent state. And doing this
1040 * while it's guaranteed that no relevant async worker runs means that async
1041 * workers do not need grab any locks. Actually they must not grab locks, for
1042 * otherwise the work flushing will deadlock.
1044 * 4. Schedule a work item to do all subsequent steps, using the split-out
1045 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1046 * then cleaning up the framebuffers after the old framebuffer is no longer
1051 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1053 * @state: atomic state object with new state structures
1055 * This function prepares plane state, specifically framebuffers, for the new
1056 * configuration. If any failure is encountered this function will call
1057 * ->cleanup_fb on any already successfully prepared framebuffer.
1060 * 0 on success, negative error code on failure.
1062 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1063 struct drm_atomic_state *state)
1065 int nplanes = dev->mode_config.num_total_plane;
1068 for (i = 0; i < nplanes; i++) {
1069 const struct drm_plane_helper_funcs *funcs;
1070 struct drm_plane *plane = state->planes[i];
1071 struct drm_plane_state *plane_state = state->plane_states[i];
1072 struct drm_framebuffer *fb;
1077 funcs = plane->helper_private;
1079 fb = plane_state->fb;
1081 if (fb && funcs->prepare_fb) {
1082 ret = funcs->prepare_fb(plane, fb, plane_state);
1091 for (i--; i >= 0; i--) {
1092 const struct drm_plane_helper_funcs *funcs;
1093 struct drm_plane *plane = state->planes[i];
1094 struct drm_plane_state *plane_state = state->plane_states[i];
1095 struct drm_framebuffer *fb;
1100 funcs = plane->helper_private;
1102 fb = state->plane_states[i]->fb;
1104 if (fb && funcs->cleanup_fb)
1105 funcs->cleanup_fb(plane, fb, plane_state);
1111 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1114 * drm_atomic_helper_commit_planes - commit plane state
1116 * @old_state: atomic state object with old state structures
1118 * This function commits the new plane state using the plane and atomic helper
1119 * functions for planes and crtcs. It assumes that the atomic state has already
1120 * been pushed into the relevant object state pointers, since this step can no
1123 * It still requires the global state object @old_state to know which planes and
1124 * crtcs need to be updated though.
1126 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1127 struct drm_atomic_state *old_state)
1129 struct drm_crtc *crtc;
1130 struct drm_crtc_state *old_crtc_state;
1131 struct drm_plane *plane;
1132 struct drm_plane_state *old_plane_state;
1135 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1136 const struct drm_crtc_helper_funcs *funcs;
1138 funcs = crtc->helper_private;
1140 if (!funcs || !funcs->atomic_begin)
1143 funcs->atomic_begin(crtc);
1146 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1147 const struct drm_plane_helper_funcs *funcs;
1149 funcs = plane->helper_private;
1154 old_plane_state = old_state->plane_states[i];
1157 * Special-case disabling the plane if drivers support it.
1159 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1160 funcs->atomic_disable)
1161 funcs->atomic_disable(plane, old_plane_state);
1162 else if (plane->state->crtc ||
1163 drm_atomic_plane_disabling(plane, old_plane_state))
1164 funcs->atomic_update(plane, old_plane_state);
1167 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1168 const struct drm_crtc_helper_funcs *funcs;
1170 funcs = crtc->helper_private;
1172 if (!funcs || !funcs->atomic_flush)
1175 funcs->atomic_flush(crtc);
1178 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1181 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1183 * @old_state: atomic state object with old state structures
1185 * This function cleans up plane state, specifically framebuffers, from the old
1186 * configuration. Hence the old configuration must be perserved in @old_state to
1187 * be able to call this function.
1189 * This function must also be called on the new state when the atomic update
1190 * fails at any point after calling drm_atomic_helper_prepare_planes().
1192 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1193 struct drm_atomic_state *old_state)
1195 struct drm_plane *plane;
1196 struct drm_plane_state *plane_state;
1199 for_each_plane_in_state(old_state, plane, plane_state, i) {
1200 const struct drm_plane_helper_funcs *funcs;
1201 struct drm_framebuffer *old_fb;
1203 funcs = plane->helper_private;
1205 old_fb = plane_state->fb;
1207 if (old_fb && funcs->cleanup_fb)
1208 funcs->cleanup_fb(plane, old_fb, plane_state);
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 if (plane == crtc->cursor)
1335 state->legacy_cursor_update = true;
1337 ret = drm_atomic_commit(state);
1341 /* Driver takes ownership of state on successful commit. */
1344 if (ret == -EDEADLK)
1347 drm_atomic_state_free(state);
1351 drm_atomic_state_clear(state);
1352 drm_atomic_legacy_backoff(state);
1355 * Someone might have exchanged the framebuffer while we dropped locks
1356 * in the backoff code. We need to fix up the fb refcount tracking the
1359 plane->old_fb = plane->fb;
1363 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1366 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1367 * @plane: plane to disable
1369 * Provides a default plane disable handler using the atomic driver interface.
1372 * Zero on success, error code on failure
1374 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1376 struct drm_atomic_state *state;
1377 struct drm_plane_state *plane_state;
1381 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1382 * acquire context. The real fix will be to wire the acquire ctx through
1383 * everywhere we need it, but meanwhile prevent chaos by just skipping
1384 * this noop. The critical case is the cursor ioctls which a) only grab
1385 * crtc/cursor-plane locks (so we need the crtc to get at the right
1386 * acquire context) and b) can try to disable the plane multiple times.
1391 state = drm_atomic_state_alloc(plane->dev);
1395 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1397 plane_state = drm_atomic_get_plane_state(state, plane);
1398 if (IS_ERR(plane_state)) {
1399 ret = PTR_ERR(plane_state);
1403 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1406 drm_atomic_set_fb_for_plane(plane_state, NULL);
1407 plane_state->crtc_x = 0;
1408 plane_state->crtc_y = 0;
1409 plane_state->crtc_h = 0;
1410 plane_state->crtc_w = 0;
1411 plane_state->src_x = 0;
1412 plane_state->src_y = 0;
1413 plane_state->src_h = 0;
1414 plane_state->src_w = 0;
1416 if (plane == plane->crtc->cursor)
1417 state->legacy_cursor_update = true;
1419 ret = drm_atomic_commit(state);
1423 /* Driver takes ownership of state on successful commit. */
1426 if (ret == -EDEADLK)
1429 drm_atomic_state_free(state);
1433 drm_atomic_state_clear(state);
1434 drm_atomic_legacy_backoff(state);
1437 * Someone might have exchanged the framebuffer while we dropped locks
1438 * in the backoff code. We need to fix up the fb refcount tracking the
1441 plane->old_fb = plane->fb;
1445 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1447 static int update_output_state(struct drm_atomic_state *state,
1448 struct drm_mode_set *set)
1450 struct drm_device *dev = set->crtc->dev;
1451 struct drm_crtc *crtc;
1452 struct drm_crtc_state *crtc_state;
1453 struct drm_connector *connector;
1454 struct drm_connector_state *conn_state;
1457 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1458 state->acquire_ctx);
1462 /* First grab all affected connector/crtc states. */
1463 for (i = 0; i < set->num_connectors; i++) {
1464 conn_state = drm_atomic_get_connector_state(state,
1465 set->connectors[i]);
1466 if (IS_ERR(conn_state))
1467 return PTR_ERR(conn_state);
1470 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1471 ret = drm_atomic_add_affected_connectors(state, crtc);
1476 /* Then recompute connector->crtc links and crtc enabling state. */
1477 for_each_connector_in_state(state, connector, conn_state, i) {
1478 if (conn_state->crtc == set->crtc) {
1479 ret = drm_atomic_set_crtc_for_connector(conn_state,
1485 for (j = 0; j < set->num_connectors; j++) {
1486 if (set->connectors[j] == connector) {
1487 ret = drm_atomic_set_crtc_for_connector(conn_state,
1496 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1497 /* Don't update ->enable for the CRTC in the set_config request,
1498 * since a mismatch would indicate a bug in the upper layers.
1499 * The actual modeset code later on will catch any
1500 * inconsistencies here. */
1501 if (crtc == set->crtc)
1504 crtc_state->enable =
1505 drm_atomic_connectors_for_crtc(state, crtc);
1512 * drm_atomic_helper_set_config - set a new config from userspace
1513 * @set: mode set configuration
1515 * Provides a default crtc set_config handler using the atomic driver interface.
1518 * Returns 0 on success, negative errno numbers on failure.
1520 int drm_atomic_helper_set_config(struct drm_mode_set *set)
1522 struct drm_atomic_state *state;
1523 struct drm_crtc *crtc = set->crtc;
1524 struct drm_crtc_state *crtc_state;
1525 struct drm_plane_state *primary_state;
1528 state = drm_atomic_state_alloc(crtc->dev);
1532 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1534 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1535 if (IS_ERR(crtc_state)) {
1536 ret = PTR_ERR(crtc_state);
1540 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1541 if (IS_ERR(primary_state)) {
1542 ret = PTR_ERR(primary_state);
1548 WARN_ON(set->num_connectors);
1550 crtc_state->enable = false;
1551 crtc_state->active = false;
1553 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1557 drm_atomic_set_fb_for_plane(primary_state, NULL);
1563 WARN_ON(!set->num_connectors);
1565 crtc_state->enable = true;
1566 crtc_state->active = true;
1567 drm_mode_copy(&crtc_state->mode, set->mode);
1569 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1572 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1573 primary_state->crtc_x = 0;
1574 primary_state->crtc_y = 0;
1575 primary_state->crtc_h = set->mode->vdisplay;
1576 primary_state->crtc_w = set->mode->hdisplay;
1577 primary_state->src_x = set->x << 16;
1578 primary_state->src_y = set->y << 16;
1579 primary_state->src_h = set->mode->vdisplay << 16;
1580 primary_state->src_w = set->mode->hdisplay << 16;
1583 ret = update_output_state(state, set);
1587 ret = drm_atomic_commit(state);
1591 /* Driver takes ownership of state on successful commit. */
1594 if (ret == -EDEADLK)
1597 drm_atomic_state_free(state);
1601 drm_atomic_state_clear(state);
1602 drm_atomic_legacy_backoff(state);
1605 * Someone might have exchanged the framebuffer while we dropped locks
1606 * in the backoff code. We need to fix up the fb refcount tracking the
1609 crtc->primary->old_fb = crtc->primary->fb;
1613 EXPORT_SYMBOL(drm_atomic_helper_set_config);
1616 * drm_atomic_helper_crtc_set_property - helper for crtc properties
1618 * @property: DRM property
1619 * @val: value of property
1621 * Provides a default crtc set_property handler using the atomic driver
1625 * Zero on success, error code on failure
1628 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1629 struct drm_property *property,
1632 struct drm_atomic_state *state;
1633 struct drm_crtc_state *crtc_state;
1636 state = drm_atomic_state_alloc(crtc->dev);
1640 /* ->set_property is always called with all locks held. */
1641 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1643 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1644 if (IS_ERR(crtc_state)) {
1645 ret = PTR_ERR(crtc_state);
1649 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1654 ret = drm_atomic_commit(state);
1658 /* Driver takes ownership of state on successful commit. */
1661 if (ret == -EDEADLK)
1664 drm_atomic_state_free(state);
1668 drm_atomic_state_clear(state);
1669 drm_atomic_legacy_backoff(state);
1673 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1676 * drm_atomic_helper_plane_set_property - helper for plane properties
1678 * @property: DRM property
1679 * @val: value of property
1681 * Provides a default plane set_property handler using the atomic driver
1685 * Zero on success, error code on failure
1688 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1689 struct drm_property *property,
1692 struct drm_atomic_state *state;
1693 struct drm_plane_state *plane_state;
1696 state = drm_atomic_state_alloc(plane->dev);
1700 /* ->set_property is always called with all locks held. */
1701 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1703 plane_state = drm_atomic_get_plane_state(state, plane);
1704 if (IS_ERR(plane_state)) {
1705 ret = PTR_ERR(plane_state);
1709 ret = drm_atomic_plane_set_property(plane, plane_state,
1714 ret = drm_atomic_commit(state);
1718 /* Driver takes ownership of state on successful commit. */
1721 if (ret == -EDEADLK)
1724 drm_atomic_state_free(state);
1728 drm_atomic_state_clear(state);
1729 drm_atomic_legacy_backoff(state);
1733 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1736 * drm_atomic_helper_connector_set_property - helper for connector properties
1737 * @connector: DRM connector
1738 * @property: DRM property
1739 * @val: value of property
1741 * Provides a default connector set_property handler using the atomic driver
1745 * Zero on success, error code on failure
1748 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1749 struct drm_property *property,
1752 struct drm_atomic_state *state;
1753 struct drm_connector_state *connector_state;
1756 state = drm_atomic_state_alloc(connector->dev);
1760 /* ->set_property is always called with all locks held. */
1761 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1763 connector_state = drm_atomic_get_connector_state(state, connector);
1764 if (IS_ERR(connector_state)) {
1765 ret = PTR_ERR(connector_state);
1769 ret = drm_atomic_connector_set_property(connector, connector_state,
1774 ret = drm_atomic_commit(state);
1778 /* Driver takes ownership of state on successful commit. */
1781 if (ret == -EDEADLK)
1784 drm_atomic_state_free(state);
1788 drm_atomic_state_clear(state);
1789 drm_atomic_legacy_backoff(state);
1793 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
1796 * drm_atomic_helper_page_flip - execute a legacy page flip
1798 * @fb: DRM framebuffer
1799 * @event: optional DRM event to signal upon completion
1800 * @flags: flip flags for non-vblank sync'ed updates
1802 * Provides a default page flip implementation using the atomic driver interface.
1804 * Note that for now so called async page flips (i.e. updates which are not
1805 * synchronized to vblank) are not supported, since the atomic interfaces have
1806 * no provisions for this yet.
1809 * Returns 0 on success, negative errno numbers on failure.
1811 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1812 struct drm_framebuffer *fb,
1813 struct drm_pending_vblank_event *event,
1816 struct drm_plane *plane = crtc->primary;
1817 struct drm_atomic_state *state;
1818 struct drm_plane_state *plane_state;
1819 struct drm_crtc_state *crtc_state;
1822 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1825 state = drm_atomic_state_alloc(plane->dev);
1829 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1831 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1832 if (IS_ERR(crtc_state)) {
1833 ret = PTR_ERR(crtc_state);
1836 crtc_state->event = event;
1838 plane_state = drm_atomic_get_plane_state(state, plane);
1839 if (IS_ERR(plane_state)) {
1840 ret = PTR_ERR(plane_state);
1844 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1847 drm_atomic_set_fb_for_plane(plane_state, fb);
1849 ret = drm_atomic_async_commit(state);
1853 /* TODO: ->page_flip is the only driver callback where the core
1854 * doesn't update plane->fb. For now patch it up here. */
1855 plane->fb = plane->state->fb;
1857 /* Driver takes ownership of state on successful async commit. */
1860 if (ret == -EDEADLK)
1863 drm_atomic_state_free(state);
1867 drm_atomic_state_clear(state);
1868 drm_atomic_legacy_backoff(state);
1871 * Someone might have exchanged the framebuffer while we dropped locks
1872 * in the backoff code. We need to fix up the fb refcount tracking the
1875 plane->old_fb = plane->fb;
1879 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
1882 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
1883 * @connector: affected connector
1886 * This is the main helper function provided by the atomic helper framework for
1887 * implementing the legacy DPMS connector interface. It computes the new desired
1888 * ->active state for the corresponding CRTC (if the connector is enabled) and
1891 void drm_atomic_helper_connector_dpms(struct drm_connector *connector,
1894 struct drm_mode_config *config = &connector->dev->mode_config;
1895 struct drm_atomic_state *state;
1896 struct drm_crtc_state *crtc_state;
1897 struct drm_crtc *crtc;
1898 struct drm_connector *tmp_connector;
1900 bool active = false;
1902 if (mode != DRM_MODE_DPMS_ON)
1903 mode = DRM_MODE_DPMS_OFF;
1905 connector->dpms = mode;
1906 crtc = connector->state->crtc;
1911 /* FIXME: ->dpms has no return value so can't forward the -ENOMEM. */
1912 state = drm_atomic_state_alloc(connector->dev);
1916 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1918 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1919 if (IS_ERR(crtc_state))
1922 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
1924 list_for_each_entry(tmp_connector, &config->connector_list, head) {
1925 if (tmp_connector->state->crtc != crtc)
1928 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
1933 crtc_state->active = active;
1935 ret = drm_atomic_commit(state);
1939 /* Driver takes ownership of state on successful async commit. */
1942 if (ret == -EDEADLK)
1945 drm_atomic_state_free(state);
1947 WARN(1, "Driver bug: Changing ->active failed with ret=%i\n", ret);
1951 drm_atomic_state_clear(state);
1952 drm_atomic_legacy_backoff(state);
1956 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
1959 * DOC: atomic state reset and initialization
1961 * Both the drm core and the atomic helpers assume that there is always the full
1962 * and correct atomic software state for all connectors, CRTCs and planes
1963 * available. Which is a bit a problem on driver load and also after system
1964 * suspend. One way to solve this is to have a hardware state read-out
1965 * infrastructure which reconstructs the full software state (e.g. the i915
1968 * The simpler solution is to just reset the software state to everything off,
1969 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
1970 * the atomic helpers provide default reset implementations for all hooks.
1974 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
1977 * Resets the atomic state for @crtc by freeing the state pointer (which might
1978 * be NULL, e.g. at driver load time) and allocating a new empty state object.
1980 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
1983 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
1986 crtc->state->crtc = crtc;
1988 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
1991 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
1992 * @crtc: CRTC object
1993 * @state: atomic CRTC state
1995 * Copies atomic state from a CRTC's current state and resets inferred values.
1996 * This is useful for drivers that subclass the CRTC state.
1998 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
1999 struct drm_crtc_state *state)
2001 memcpy(state, crtc->state, sizeof(*state));
2003 state->mode_changed = false;
2004 state->active_changed = false;
2005 state->planes_changed = false;
2006 state->event = NULL;
2008 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2011 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2014 * Default CRTC state duplicate hook for drivers which don't have their own
2015 * subclassed CRTC state structure.
2017 struct drm_crtc_state *
2018 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2020 struct drm_crtc_state *state;
2022 if (WARN_ON(!crtc->state))
2025 state = kmalloc(sizeof(*state), GFP_KERNEL);
2027 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2031 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2034 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2035 * @crtc: CRTC object
2036 * @state: CRTC state object to release
2038 * Releases all resources stored in the CRTC state without actually freeing
2039 * the memory of the CRTC state. This is useful for drivers that subclass the
2042 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2043 struct drm_crtc_state *state)
2046 * This is currently a placeholder so that drivers that subclass the
2047 * state will automatically do the right thing if code is ever added
2051 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2054 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2056 * @state: CRTC state object to release
2058 * Default CRTC state destroy hook for drivers which don't have their own
2059 * subclassed CRTC state structure.
2061 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2062 struct drm_crtc_state *state)
2064 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2067 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2070 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2073 * Resets the atomic state for @plane by freeing the state pointer (which might
2074 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2076 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2078 if (plane->state && plane->state->fb)
2079 drm_framebuffer_unreference(plane->state->fb);
2081 kfree(plane->state);
2082 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2085 plane->state->plane = plane;
2087 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2090 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2091 * @plane: plane object
2092 * @state: atomic plane state
2094 * Copies atomic state from a plane's current state. This is useful for
2095 * drivers that subclass the plane state.
2097 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2098 struct drm_plane_state *state)
2100 memcpy(state, plane->state, sizeof(*state));
2103 drm_framebuffer_reference(state->fb);
2105 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2108 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2111 * Default plane state duplicate hook for drivers which don't have their own
2112 * subclassed plane state structure.
2114 struct drm_plane_state *
2115 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2117 struct drm_plane_state *state;
2119 if (WARN_ON(!plane->state))
2122 state = kmalloc(sizeof(*state), GFP_KERNEL);
2124 __drm_atomic_helper_plane_duplicate_state(plane, state);
2128 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2131 * __drm_atomic_helper_plane_destroy_state - release plane state
2132 * @plane: plane object
2133 * @state: plane state object to release
2135 * Releases all resources stored in the plane state without actually freeing
2136 * the memory of the plane state. This is useful for drivers that subclass the
2139 void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2140 struct drm_plane_state *state)
2143 drm_framebuffer_unreference(state->fb);
2145 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2148 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2150 * @state: plane state object to release
2152 * Default plane state destroy hook for drivers which don't have their own
2153 * subclassed plane state structure.
2155 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2156 struct drm_plane_state *state)
2158 __drm_atomic_helper_plane_destroy_state(plane, state);
2161 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2164 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2165 * @connector: drm connector
2167 * Resets the atomic state for @connector by freeing the state pointer (which
2168 * might be NULL, e.g. at driver load time) and allocating a new empty state
2171 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2173 kfree(connector->state);
2174 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
2176 if (connector->state)
2177 connector->state->connector = connector;
2179 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2182 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2183 * @connector: connector object
2184 * @state: atomic connector state
2186 * Copies atomic state from a connector's current state. This is useful for
2187 * drivers that subclass the connector state.
2190 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2191 struct drm_connector_state *state)
2193 memcpy(state, connector->state, sizeof(*state));
2195 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2198 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2199 * @connector: drm connector
2201 * Default connector state duplicate hook for drivers which don't have their own
2202 * subclassed connector state structure.
2204 struct drm_connector_state *
2205 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2207 struct drm_connector_state *state;
2209 if (WARN_ON(!connector->state))
2212 state = kmalloc(sizeof(*state), GFP_KERNEL);
2214 __drm_atomic_helper_connector_duplicate_state(connector, state);
2218 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2221 * __drm_atomic_helper_connector_destroy_state - release connector state
2222 * @connector: connector object
2223 * @state: connector state object to release
2225 * Releases all resources stored in the connector state without actually
2226 * freeing the memory of the connector state. This is useful for drivers that
2227 * subclass the connector state.
2230 __drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2231 struct drm_connector_state *state)
2234 * This is currently a placeholder so that drivers that subclass the
2235 * state will automatically do the right thing if code is ever added
2239 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2242 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2243 * @connector: drm connector
2244 * @state: connector state object to release
2246 * Default connector state destroy hook for drivers which don't have their own
2247 * subclassed connector state structure.
2249 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2250 struct drm_connector_state *state)
2252 __drm_atomic_helper_connector_destroy_state(connector, state);
2255 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);