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>
28 #include <linux/dma-fence.h>
29 #include <linux/ktime.h>
31 #include <drm/drm_atomic.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <drm/drm_atomic_uapi.h>
34 #include <drm/drm_bridge.h>
35 #include <drm/drm_damage_helper.h>
36 #include <drm/drm_device.h>
37 #include <drm/drm_drv.h>
38 #include <drm/drm_gem_atomic_helper.h>
39 #include <drm/drm_plane_helper.h>
40 #include <drm/drm_print.h>
41 #include <drm/drm_self_refresh_helper.h>
42 #include <drm/drm_vblank.h>
43 #include <drm/drm_writeback.h>
45 #include "drm_crtc_helper_internal.h"
46 #include "drm_crtc_internal.h"
51 * This helper library provides implementations of check and commit functions on
52 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
53 * also provides convenience implementations for the atomic state handling
54 * callbacks for drivers which don't need to subclass the drm core structures to
55 * add their own additional internal state.
57 * This library also provides default implementations for the check callback in
58 * drm_atomic_helper_check() and for the commit callback with
59 * drm_atomic_helper_commit(). But the individual stages and callbacks are
60 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
61 * together with a driver private modeset implementation.
63 * This library also provides implementations for all the legacy driver
64 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
65 * drm_atomic_helper_disable_plane(), and the various functions to implement
66 * set_property callbacks. New drivers must not implement these functions
67 * themselves but must use the provided helpers.
69 * The atomic helper uses the same function table structures as all other
70 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
71 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
72 * also shares the &struct drm_plane_helper_funcs function table with the plane
76 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
77 struct drm_plane_state *old_plane_state,
78 struct drm_plane_state *plane_state,
79 struct drm_plane *plane)
81 struct drm_crtc_state *crtc_state;
83 if (old_plane_state->crtc) {
84 crtc_state = drm_atomic_get_new_crtc_state(state,
85 old_plane_state->crtc);
87 if (WARN_ON(!crtc_state))
90 crtc_state->planes_changed = true;
93 if (plane_state->crtc) {
94 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
96 if (WARN_ON(!crtc_state))
99 crtc_state->planes_changed = true;
103 static int handle_conflicting_encoders(struct drm_atomic_state *state,
104 bool disable_conflicting_encoders)
106 struct drm_connector_state *new_conn_state;
107 struct drm_connector *connector;
108 struct drm_connector_list_iter conn_iter;
109 struct drm_encoder *encoder;
110 unsigned int encoder_mask = 0;
114 * First loop, find all newly assigned encoders from the connectors
115 * part of the state. If the same encoder is assigned to multiple
116 * connectors bail out.
118 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
119 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
120 struct drm_encoder *new_encoder;
122 if (!new_conn_state->crtc)
125 if (funcs->atomic_best_encoder)
126 new_encoder = funcs->atomic_best_encoder(connector,
128 else if (funcs->best_encoder)
129 new_encoder = funcs->best_encoder(connector);
131 new_encoder = drm_connector_get_single_encoder(connector);
134 if (encoder_mask & drm_encoder_mask(new_encoder)) {
135 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
136 new_encoder->base.id, new_encoder->name,
137 connector->base.id, connector->name);
142 encoder_mask |= drm_encoder_mask(new_encoder);
150 * Second loop, iterate over all connectors not part of the state.
152 * If a conflicting encoder is found and disable_conflicting_encoders
153 * is not set, an error is returned. Userspace can provide a solution
154 * through the atomic ioctl.
156 * If the flag is set conflicting connectors are removed from the CRTC
157 * and the CRTC is disabled if no encoder is left. This preserves
158 * compatibility with the legacy set_config behavior.
160 drm_connector_list_iter_begin(state->dev, &conn_iter);
161 drm_for_each_connector_iter(connector, &conn_iter) {
162 struct drm_crtc_state *crtc_state;
164 if (drm_atomic_get_new_connector_state(state, connector))
167 encoder = connector->state->best_encoder;
168 if (!encoder || !(encoder_mask & drm_encoder_mask(encoder)))
171 if (!disable_conflicting_encoders) {
172 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
173 encoder->base.id, encoder->name,
174 connector->state->crtc->base.id,
175 connector->state->crtc->name,
176 connector->base.id, connector->name);
181 new_conn_state = drm_atomic_get_connector_state(state, connector);
182 if (IS_ERR(new_conn_state)) {
183 ret = PTR_ERR(new_conn_state);
187 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
188 encoder->base.id, encoder->name,
189 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
190 connector->base.id, connector->name);
192 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
194 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
198 if (!crtc_state->connector_mask) {
199 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
204 crtc_state->active = false;
208 drm_connector_list_iter_end(&conn_iter);
214 set_best_encoder(struct drm_atomic_state *state,
215 struct drm_connector_state *conn_state,
216 struct drm_encoder *encoder)
218 struct drm_crtc_state *crtc_state;
219 struct drm_crtc *crtc;
221 if (conn_state->best_encoder) {
222 /* Unset the encoder_mask in the old crtc state. */
223 crtc = conn_state->connector->state->crtc;
225 /* A NULL crtc is an error here because we should have
226 * duplicated a NULL best_encoder when crtc was NULL.
227 * As an exception restoring duplicated atomic state
228 * during resume is allowed, so don't warn when
229 * best_encoder is equal to encoder we intend to set.
231 WARN_ON(!crtc && encoder != conn_state->best_encoder);
233 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
235 crtc_state->encoder_mask &=
236 ~drm_encoder_mask(conn_state->best_encoder);
241 crtc = conn_state->crtc;
244 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
246 crtc_state->encoder_mask |=
247 drm_encoder_mask(encoder);
251 conn_state->best_encoder = encoder;
255 steal_encoder(struct drm_atomic_state *state,
256 struct drm_encoder *encoder)
258 struct drm_crtc_state *crtc_state;
259 struct drm_connector *connector;
260 struct drm_connector_state *old_connector_state, *new_connector_state;
263 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
264 struct drm_crtc *encoder_crtc;
266 if (new_connector_state->best_encoder != encoder)
269 encoder_crtc = old_connector_state->crtc;
271 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
272 encoder->base.id, encoder->name,
273 encoder_crtc->base.id, encoder_crtc->name);
275 set_best_encoder(state, new_connector_state, NULL);
277 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
278 crtc_state->connectors_changed = true;
285 update_connector_routing(struct drm_atomic_state *state,
286 struct drm_connector *connector,
287 struct drm_connector_state *old_connector_state,
288 struct drm_connector_state *new_connector_state)
290 const struct drm_connector_helper_funcs *funcs;
291 struct drm_encoder *new_encoder;
292 struct drm_crtc_state *crtc_state;
294 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
298 if (old_connector_state->crtc != new_connector_state->crtc) {
299 if (old_connector_state->crtc) {
300 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
301 crtc_state->connectors_changed = true;
304 if (new_connector_state->crtc) {
305 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
306 crtc_state->connectors_changed = true;
310 if (!new_connector_state->crtc) {
311 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
315 set_best_encoder(state, new_connector_state, NULL);
320 crtc_state = drm_atomic_get_new_crtc_state(state,
321 new_connector_state->crtc);
323 * For compatibility with legacy users, we want to make sure that
324 * we allow DPMS On->Off modesets on unregistered connectors. Modesets
325 * which would result in anything else must be considered invalid, to
326 * avoid turning on new displays on dead connectors.
328 * Since the connector can be unregistered at any point during an
329 * atomic check or commit, this is racy. But that's OK: all we care
330 * about is ensuring that userspace can't do anything but shut off the
331 * display on a connector that was destroyed after it's been notified,
334 * Additionally, we also want to ignore connector registration when
335 * we're trying to restore an atomic state during system resume since
336 * there's a chance the connector may have been destroyed during the
337 * process, but it's better to ignore that then cause
338 * drm_atomic_helper_resume() to fail.
340 if (!state->duplicated && drm_connector_is_unregistered(connector) &&
341 crtc_state->active) {
342 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
343 connector->base.id, connector->name);
347 funcs = connector->helper_private;
349 if (funcs->atomic_best_encoder)
350 new_encoder = funcs->atomic_best_encoder(connector, state);
351 else if (funcs->best_encoder)
352 new_encoder = funcs->best_encoder(connector);
354 new_encoder = drm_connector_get_single_encoder(connector);
357 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
363 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
364 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
365 new_encoder->base.id,
367 new_connector_state->crtc->base.id,
368 new_connector_state->crtc->name);
372 if (new_encoder == new_connector_state->best_encoder) {
373 set_best_encoder(state, new_connector_state, new_encoder);
375 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
378 new_encoder->base.id,
380 new_connector_state->crtc->base.id,
381 new_connector_state->crtc->name);
386 steal_encoder(state, new_encoder);
388 set_best_encoder(state, new_connector_state, new_encoder);
390 crtc_state->connectors_changed = true;
392 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
395 new_encoder->base.id,
397 new_connector_state->crtc->base.id,
398 new_connector_state->crtc->name);
404 mode_fixup(struct drm_atomic_state *state)
406 struct drm_crtc *crtc;
407 struct drm_crtc_state *new_crtc_state;
408 struct drm_connector *connector;
409 struct drm_connector_state *new_conn_state;
413 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
414 if (!new_crtc_state->mode_changed &&
415 !new_crtc_state->connectors_changed)
418 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
421 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
422 const struct drm_encoder_helper_funcs *funcs;
423 struct drm_encoder *encoder;
424 struct drm_bridge *bridge;
426 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
428 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
432 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
435 * Each encoder has at most one connector (since we always steal
436 * it away), so we won't call ->mode_fixup twice.
438 encoder = new_conn_state->best_encoder;
439 funcs = encoder->helper_private;
441 bridge = drm_bridge_chain_get_first_bridge(encoder);
442 ret = drm_atomic_bridge_chain_check(bridge,
446 DRM_DEBUG_ATOMIC("Bridge atomic check failed\n");
450 if (funcs && funcs->atomic_check) {
451 ret = funcs->atomic_check(encoder, new_crtc_state,
454 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
455 encoder->base.id, encoder->name);
458 } else if (funcs && funcs->mode_fixup) {
459 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
460 &new_crtc_state->adjusted_mode);
462 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
463 encoder->base.id, encoder->name);
469 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
470 const struct drm_crtc_helper_funcs *funcs;
472 if (!new_crtc_state->enable)
475 if (!new_crtc_state->mode_changed &&
476 !new_crtc_state->connectors_changed)
479 funcs = crtc->helper_private;
480 if (!funcs || !funcs->mode_fixup)
483 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
484 &new_crtc_state->adjusted_mode);
486 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
487 crtc->base.id, crtc->name);
495 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
496 struct drm_encoder *encoder,
497 struct drm_crtc *crtc,
498 const struct drm_display_mode *mode)
500 struct drm_bridge *bridge;
501 enum drm_mode_status ret;
503 ret = drm_encoder_mode_valid(encoder, mode);
504 if (ret != MODE_OK) {
505 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
506 encoder->base.id, encoder->name);
510 bridge = drm_bridge_chain_get_first_bridge(encoder);
511 ret = drm_bridge_chain_mode_valid(bridge, &connector->display_info,
513 if (ret != MODE_OK) {
514 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
518 ret = drm_crtc_mode_valid(crtc, mode);
519 if (ret != MODE_OK) {
520 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
521 crtc->base.id, crtc->name);
529 mode_valid(struct drm_atomic_state *state)
531 struct drm_connector_state *conn_state;
532 struct drm_connector *connector;
535 for_each_new_connector_in_state(state, connector, conn_state, i) {
536 struct drm_encoder *encoder = conn_state->best_encoder;
537 struct drm_crtc *crtc = conn_state->crtc;
538 struct drm_crtc_state *crtc_state;
539 enum drm_mode_status mode_status;
540 const struct drm_display_mode *mode;
542 if (!crtc || !encoder)
545 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
548 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
551 mode = &crtc_state->mode;
553 mode_status = mode_valid_path(connector, encoder, crtc, mode);
554 if (mode_status != MODE_OK)
562 * drm_atomic_helper_check_modeset - validate state object for modeset changes
564 * @state: the driver state object
566 * Check the state object to see if the requested state is physically possible.
567 * This does all the CRTC and connector related computations for an atomic
568 * update and adds any additional connectors needed for full modesets. It calls
569 * the various per-object callbacks in the follow order:
571 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
572 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
573 * 3. If it's determined a modeset is needed then all connectors on the affected
574 * CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them.
575 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
576 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
577 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
578 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
579 * This function is only called when the encoder will be part of a configured CRTC,
580 * it must not be used for implementing connector property validation.
581 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
583 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints.
585 * &drm_crtc_state.mode_changed is set when the input mode is changed.
586 * &drm_crtc_state.connectors_changed is set when a connector is added or
587 * removed from the CRTC. &drm_crtc_state.active_changed is set when
588 * &drm_crtc_state.active changes, which is used for DPMS.
589 * &drm_crtc_state.no_vblank is set from the result of drm_dev_has_vblank().
590 * See also: drm_atomic_crtc_needs_modeset()
594 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
595 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
596 * without a full modeset) _must_ call this function after that change. It is
597 * permitted to call this function multiple times for the same update, e.g.
598 * when the &drm_crtc_helper_funcs.atomic_check functions depend upon the
599 * adjusted dotclock for fifo space allocation and watermark computation.
602 * Zero for success or -errno
605 drm_atomic_helper_check_modeset(struct drm_device *dev,
606 struct drm_atomic_state *state)
608 struct drm_crtc *crtc;
609 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
610 struct drm_connector *connector;
611 struct drm_connector_state *old_connector_state, *new_connector_state;
613 unsigned int connectors_mask = 0;
615 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
616 bool has_connectors =
617 !!new_crtc_state->connector_mask;
619 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
621 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
622 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
623 crtc->base.id, crtc->name);
624 new_crtc_state->mode_changed = true;
627 if (old_crtc_state->enable != new_crtc_state->enable) {
628 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
629 crtc->base.id, crtc->name);
632 * For clarity this assignment is done here, but
633 * enable == 0 is only true when there are no
634 * connectors and a NULL mode.
636 * The other way around is true as well. enable != 0
637 * implies that connectors are attached and a mode is set.
639 new_crtc_state->mode_changed = true;
640 new_crtc_state->connectors_changed = true;
643 if (old_crtc_state->active != new_crtc_state->active) {
644 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
645 crtc->base.id, crtc->name);
646 new_crtc_state->active_changed = true;
649 if (new_crtc_state->enable != has_connectors) {
650 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
651 crtc->base.id, crtc->name);
656 if (drm_dev_has_vblank(dev))
657 new_crtc_state->no_vblank = false;
659 new_crtc_state->no_vblank = true;
662 ret = handle_conflicting_encoders(state, false);
666 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
667 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
669 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
672 * This only sets crtc->connectors_changed for routing changes,
673 * drivers must set crtc->connectors_changed themselves when
674 * connector properties need to be updated.
676 ret = update_connector_routing(state, connector,
678 new_connector_state);
681 if (old_connector_state->crtc) {
682 new_crtc_state = drm_atomic_get_new_crtc_state(state,
683 old_connector_state->crtc);
684 if (old_connector_state->link_status !=
685 new_connector_state->link_status)
686 new_crtc_state->connectors_changed = true;
688 if (old_connector_state->max_requested_bpc !=
689 new_connector_state->max_requested_bpc)
690 new_crtc_state->connectors_changed = true;
693 if (funcs->atomic_check)
694 ret = funcs->atomic_check(connector, state);
698 connectors_mask |= BIT(i);
702 * After all the routing has been prepared we need to add in any
703 * connector which is itself unchanged, but whose CRTC changes its
704 * configuration. This must be done before calling mode_fixup in case a
705 * crtc only changed its mode but has the same set of connectors.
707 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
708 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
711 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
712 crtc->base.id, crtc->name,
713 new_crtc_state->enable ? 'y' : 'n',
714 new_crtc_state->active ? 'y' : 'n');
716 ret = drm_atomic_add_affected_connectors(state, crtc);
720 ret = drm_atomic_add_affected_planes(state, crtc);
726 * Iterate over all connectors again, to make sure atomic_check()
727 * has been called on them when a modeset is forced.
729 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
730 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
732 if (connectors_mask & BIT(i))
735 if (funcs->atomic_check)
736 ret = funcs->atomic_check(connector, state);
742 * Iterate over all connectors again, and add all affected bridges to
745 for_each_oldnew_connector_in_state(state, connector,
747 new_connector_state, i) {
748 struct drm_encoder *encoder;
750 encoder = old_connector_state->best_encoder;
751 ret = drm_atomic_add_encoder_bridges(state, encoder);
755 encoder = new_connector_state->best_encoder;
756 ret = drm_atomic_add_encoder_bridges(state, encoder);
761 ret = mode_valid(state);
765 return mode_fixup(state);
767 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
770 * drm_atomic_helper_check_plane_state() - Check plane state for validity
771 * @plane_state: plane state to check
772 * @crtc_state: CRTC state to check
773 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
774 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
775 * @can_position: is it legal to position the plane such that it
776 * doesn't cover the entire CRTC? This will generally
777 * only be false for primary planes.
778 * @can_update_disabled: can the plane be updated while the CRTC
781 * Checks that a desired plane update is valid, and updates various
782 * bits of derived state (clipped coordinates etc.). Drivers that provide
783 * their own plane handling rather than helper-provided implementations may
784 * still wish to call this function to avoid duplication of error checking
788 * Zero if update appears valid, error code on failure
790 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
791 const struct drm_crtc_state *crtc_state,
795 bool can_update_disabled)
797 struct drm_framebuffer *fb = plane_state->fb;
798 struct drm_rect *src = &plane_state->src;
799 struct drm_rect *dst = &plane_state->dst;
800 unsigned int rotation = plane_state->rotation;
801 struct drm_rect clip = {};
804 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
806 *src = drm_plane_state_src(plane_state);
807 *dst = drm_plane_state_dest(plane_state);
810 plane_state->visible = false;
814 /* crtc should only be NULL when disabling (i.e., !fb) */
815 if (WARN_ON(!plane_state->crtc)) {
816 plane_state->visible = false;
820 if (!crtc_state->enable && !can_update_disabled) {
821 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
825 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
828 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
829 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
830 if (hscale < 0 || vscale < 0) {
831 DRM_DEBUG_KMS("Invalid scaling of plane\n");
832 drm_rect_debug_print("src: ", &plane_state->src, true);
833 drm_rect_debug_print("dst: ", &plane_state->dst, false);
837 if (crtc_state->enable)
838 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
840 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
842 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
844 if (!plane_state->visible)
846 * Plane isn't visible; some drivers can handle this
847 * so we just return success here. Drivers that can't
848 * (including those that use the primary plane helper's
849 * update function) will return an error from their
850 * update_plane handler.
854 if (!can_position && !drm_rect_equals(dst, &clip)) {
855 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
856 drm_rect_debug_print("dst: ", dst, false);
857 drm_rect_debug_print("clip: ", &clip, false);
863 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
866 * drm_atomic_helper_check_planes - validate state object for planes changes
868 * @state: the driver state object
870 * Check the state object to see if the requested state is physically possible.
871 * This does all the plane update related checks using by calling into the
872 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
873 * hooks provided by the driver.
875 * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has
879 * Zero for success or -errno
882 drm_atomic_helper_check_planes(struct drm_device *dev,
883 struct drm_atomic_state *state)
885 struct drm_crtc *crtc;
886 struct drm_crtc_state *new_crtc_state;
887 struct drm_plane *plane;
888 struct drm_plane_state *new_plane_state, *old_plane_state;
891 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
892 const struct drm_plane_helper_funcs *funcs;
894 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
896 funcs = plane->helper_private;
898 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
900 drm_atomic_helper_check_plane_damage(state, new_plane_state);
902 if (!funcs || !funcs->atomic_check)
905 ret = funcs->atomic_check(plane, state);
907 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
908 plane->base.id, plane->name);
913 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
914 const struct drm_crtc_helper_funcs *funcs;
916 funcs = crtc->helper_private;
918 if (!funcs || !funcs->atomic_check)
921 ret = funcs->atomic_check(crtc, state);
923 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
924 crtc->base.id, crtc->name);
931 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
934 * drm_atomic_helper_check - validate state object
936 * @state: the driver state object
938 * Check the state object to see if the requested state is physically possible.
939 * Only CRTCs and planes have check callbacks, so for any additional (global)
940 * checking that a driver needs it can simply wrap that around this function.
941 * Drivers without such needs can directly use this as their
942 * &drm_mode_config_funcs.atomic_check callback.
944 * This just wraps the two parts of the state checking for planes and modeset
945 * state in the default order: First it calls drm_atomic_helper_check_modeset()
946 * and then drm_atomic_helper_check_planes(). The assumption is that the
947 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
948 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
951 * Note that zpos normalization will add all enable planes to the state which
952 * might not desired for some drivers.
953 * For example enable/disable of a cursor plane which have fixed zpos value
954 * would trigger all other enabled planes to be forced to the state change.
957 * Zero for success or -errno
959 int drm_atomic_helper_check(struct drm_device *dev,
960 struct drm_atomic_state *state)
964 ret = drm_atomic_helper_check_modeset(dev, state);
968 if (dev->mode_config.normalize_zpos) {
969 ret = drm_atomic_normalize_zpos(dev, state);
974 ret = drm_atomic_helper_check_planes(dev, state);
978 if (state->legacy_cursor_update)
979 state->async_update = !drm_atomic_helper_async_check(dev, state);
981 drm_self_refresh_helper_alter_state(state);
985 EXPORT_SYMBOL(drm_atomic_helper_check);
988 crtc_needs_disable(struct drm_crtc_state *old_state,
989 struct drm_crtc_state *new_state)
992 * No new_state means the CRTC is off, so the only criteria is whether
993 * it's currently active or in self refresh mode.
996 return drm_atomic_crtc_effectively_active(old_state);
999 * We need to disable bridge(s) and CRTC if we're transitioning out of
1000 * self-refresh and changing CRTCs at the same time, because the
1001 * bridge tracks self-refresh status via CRTC state.
1003 if (old_state->self_refresh_active &&
1004 old_state->crtc != new_state->crtc)
1008 * We also need to run through the crtc_funcs->disable() function if
1009 * the CRTC is currently on, if it's transitioning to self refresh
1010 * mode, or if it's in self refresh mode and needs to be fully
1013 return old_state->active ||
1014 (old_state->self_refresh_active && !new_state->active) ||
1015 new_state->self_refresh_active;
1019 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
1021 struct drm_connector *connector;
1022 struct drm_connector_state *old_conn_state, *new_conn_state;
1023 struct drm_crtc *crtc;
1024 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1027 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1028 const struct drm_encoder_helper_funcs *funcs;
1029 struct drm_encoder *encoder;
1030 struct drm_bridge *bridge;
1033 * Shut down everything that's in the changeset and currently
1034 * still on. So need to check the old, saved state.
1036 if (!old_conn_state->crtc)
1039 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
1041 if (new_conn_state->crtc)
1042 new_crtc_state = drm_atomic_get_new_crtc_state(
1044 new_conn_state->crtc);
1046 new_crtc_state = NULL;
1048 if (!crtc_needs_disable(old_crtc_state, new_crtc_state) ||
1049 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
1052 encoder = old_conn_state->best_encoder;
1054 /* We shouldn't get this far if we didn't previously have
1055 * an encoder.. but WARN_ON() rather than explode.
1057 if (WARN_ON(!encoder))
1060 funcs = encoder->helper_private;
1062 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
1063 encoder->base.id, encoder->name);
1066 * Each encoder has at most one connector (since we always steal
1067 * it away), so we won't call disable hooks twice.
1069 bridge = drm_bridge_chain_get_first_bridge(encoder);
1070 drm_atomic_bridge_chain_disable(bridge, old_state);
1072 /* Right function depends upon target state. */
1074 if (funcs->atomic_disable)
1075 funcs->atomic_disable(encoder, old_state);
1076 else if (new_conn_state->crtc && funcs->prepare)
1077 funcs->prepare(encoder);
1078 else if (funcs->disable)
1079 funcs->disable(encoder);
1080 else if (funcs->dpms)
1081 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1084 drm_atomic_bridge_chain_post_disable(bridge, old_state);
1087 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1088 const struct drm_crtc_helper_funcs *funcs;
1091 /* Shut down everything that needs a full modeset. */
1092 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1095 if (!crtc_needs_disable(old_crtc_state, new_crtc_state))
1098 funcs = crtc->helper_private;
1100 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1101 crtc->base.id, crtc->name);
1104 /* Right function depends upon target state. */
1105 if (new_crtc_state->enable && funcs->prepare)
1106 funcs->prepare(crtc);
1107 else if (funcs->atomic_disable)
1108 funcs->atomic_disable(crtc, old_state);
1109 else if (funcs->disable)
1110 funcs->disable(crtc);
1111 else if (funcs->dpms)
1112 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1114 if (!drm_dev_has_vblank(dev))
1117 ret = drm_crtc_vblank_get(crtc);
1118 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1120 drm_crtc_vblank_put(crtc);
1125 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1127 * @old_state: atomic state object with old state structures
1129 * This function updates all the various legacy modeset state pointers in
1130 * connectors, encoders and CRTCs.
1132 * Drivers can use this for building their own atomic commit if they don't have
1133 * a pure helper-based modeset implementation.
1135 * Since these updates are not synchronized with lockings, only code paths
1136 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1137 * legacy state filled out by this helper. Defacto this means this helper and
1138 * the legacy state pointers are only really useful for transitioning an
1139 * existing driver to the atomic world.
1142 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1143 struct drm_atomic_state *old_state)
1145 struct drm_connector *connector;
1146 struct drm_connector_state *old_conn_state, *new_conn_state;
1147 struct drm_crtc *crtc;
1148 struct drm_crtc_state *new_crtc_state;
1151 /* clear out existing links and update dpms */
1152 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1153 if (connector->encoder) {
1154 WARN_ON(!connector->encoder->crtc);
1156 connector->encoder->crtc = NULL;
1157 connector->encoder = NULL;
1160 crtc = new_conn_state->crtc;
1161 if ((!crtc && old_conn_state->crtc) ||
1162 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1163 int mode = DRM_MODE_DPMS_OFF;
1165 if (crtc && crtc->state->active)
1166 mode = DRM_MODE_DPMS_ON;
1168 connector->dpms = mode;
1173 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1174 if (!new_conn_state->crtc)
1177 if (WARN_ON(!new_conn_state->best_encoder))
1180 connector->encoder = new_conn_state->best_encoder;
1181 connector->encoder->crtc = new_conn_state->crtc;
1184 /* set legacy state in the crtc structure */
1185 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1186 struct drm_plane *primary = crtc->primary;
1187 struct drm_plane_state *new_plane_state;
1189 crtc->mode = new_crtc_state->mode;
1190 crtc->enabled = new_crtc_state->enable;
1193 drm_atomic_get_new_plane_state(old_state, primary);
1195 if (new_plane_state && new_plane_state->crtc == crtc) {
1196 crtc->x = new_plane_state->src_x >> 16;
1197 crtc->y = new_plane_state->src_y >> 16;
1201 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1204 * drm_atomic_helper_calc_timestamping_constants - update vblank timestamping constants
1205 * @state: atomic state object
1207 * Updates the timestamping constants used for precise vblank timestamps
1208 * by calling drm_calc_timestamping_constants() for all enabled crtcs in @state.
1210 void drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state)
1212 struct drm_crtc_state *new_crtc_state;
1213 struct drm_crtc *crtc;
1216 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1217 if (new_crtc_state->enable)
1218 drm_calc_timestamping_constants(crtc,
1219 &new_crtc_state->adjusted_mode);
1222 EXPORT_SYMBOL(drm_atomic_helper_calc_timestamping_constants);
1225 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1227 struct drm_crtc *crtc;
1228 struct drm_crtc_state *new_crtc_state;
1229 struct drm_connector *connector;
1230 struct drm_connector_state *new_conn_state;
1233 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1234 const struct drm_crtc_helper_funcs *funcs;
1236 if (!new_crtc_state->mode_changed)
1239 funcs = crtc->helper_private;
1241 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1242 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1243 crtc->base.id, crtc->name);
1245 funcs->mode_set_nofb(crtc);
1249 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1250 const struct drm_encoder_helper_funcs *funcs;
1251 struct drm_encoder *encoder;
1252 struct drm_display_mode *mode, *adjusted_mode;
1253 struct drm_bridge *bridge;
1255 if (!new_conn_state->best_encoder)
1258 encoder = new_conn_state->best_encoder;
1259 funcs = encoder->helper_private;
1260 new_crtc_state = new_conn_state->crtc->state;
1261 mode = &new_crtc_state->mode;
1262 adjusted_mode = &new_crtc_state->adjusted_mode;
1264 if (!new_crtc_state->mode_changed)
1267 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1268 encoder->base.id, encoder->name);
1271 * Each encoder has at most one connector (since we always steal
1272 * it away), so we won't call mode_set hooks twice.
1274 if (funcs && funcs->atomic_mode_set) {
1275 funcs->atomic_mode_set(encoder, new_crtc_state,
1277 } else if (funcs && funcs->mode_set) {
1278 funcs->mode_set(encoder, mode, adjusted_mode);
1281 bridge = drm_bridge_chain_get_first_bridge(encoder);
1282 drm_bridge_chain_mode_set(bridge, mode, adjusted_mode);
1287 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1289 * @old_state: atomic state object with old state structures
1291 * This function shuts down all the outputs that need to be shut down and
1292 * prepares them (if required) with the new mode.
1294 * For compatibility with legacy CRTC helpers this should be called before
1295 * drm_atomic_helper_commit_planes(), which is what the default commit function
1296 * does. But drivers with different needs can group the modeset commits together
1297 * and do the plane commits at the end. This is useful for drivers doing runtime
1298 * PM since planes updates then only happen when the CRTC is actually enabled.
1300 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1301 struct drm_atomic_state *old_state)
1303 disable_outputs(dev, old_state);
1305 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1306 drm_atomic_helper_calc_timestamping_constants(old_state);
1308 crtc_set_mode(dev, old_state);
1310 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1312 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1313 struct drm_atomic_state *old_state)
1315 struct drm_connector *connector;
1316 struct drm_connector_state *new_conn_state;
1319 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1320 const struct drm_connector_helper_funcs *funcs;
1322 funcs = connector->helper_private;
1323 if (!funcs->atomic_commit)
1326 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1327 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1328 funcs->atomic_commit(connector, old_state);
1334 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1336 * @old_state: atomic state object with old state structures
1338 * This function enables all the outputs with the new configuration which had to
1339 * be turned off for the update.
1341 * For compatibility with legacy CRTC helpers this should be called after
1342 * drm_atomic_helper_commit_planes(), which is what the default commit function
1343 * does. But drivers with different needs can group the modeset commits together
1344 * and do the plane commits at the end. This is useful for drivers doing runtime
1345 * PM since planes updates then only happen when the CRTC is actually enabled.
1347 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1348 struct drm_atomic_state *old_state)
1350 struct drm_crtc *crtc;
1351 struct drm_crtc_state *old_crtc_state;
1352 struct drm_crtc_state *new_crtc_state;
1353 struct drm_connector *connector;
1354 struct drm_connector_state *new_conn_state;
1357 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1358 const struct drm_crtc_helper_funcs *funcs;
1360 /* Need to filter out CRTCs where only planes change. */
1361 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1364 if (!new_crtc_state->active)
1367 funcs = crtc->helper_private;
1369 if (new_crtc_state->enable) {
1370 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1371 crtc->base.id, crtc->name);
1372 if (funcs->atomic_enable)
1373 funcs->atomic_enable(crtc, old_state);
1374 else if (funcs->commit)
1375 funcs->commit(crtc);
1379 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1380 const struct drm_encoder_helper_funcs *funcs;
1381 struct drm_encoder *encoder;
1382 struct drm_bridge *bridge;
1384 if (!new_conn_state->best_encoder)
1387 if (!new_conn_state->crtc->state->active ||
1388 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1391 encoder = new_conn_state->best_encoder;
1392 funcs = encoder->helper_private;
1394 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1395 encoder->base.id, encoder->name);
1398 * Each encoder has at most one connector (since we always steal
1399 * it away), so we won't call enable hooks twice.
1401 bridge = drm_bridge_chain_get_first_bridge(encoder);
1402 drm_atomic_bridge_chain_pre_enable(bridge, old_state);
1405 if (funcs->atomic_enable)
1406 funcs->atomic_enable(encoder, old_state);
1407 else if (funcs->enable)
1408 funcs->enable(encoder);
1409 else if (funcs->commit)
1410 funcs->commit(encoder);
1413 drm_atomic_bridge_chain_enable(bridge, old_state);
1416 drm_atomic_helper_commit_writebacks(dev, old_state);
1418 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1421 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1423 * @state: atomic state object with old state structures
1424 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1425 * Otherwise @state is the old state.
1427 * For implicit sync, driver should fish the exclusive fence out from the
1428 * incoming fb's and stash it in the drm_plane_state. This is called after
1429 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1430 * just uses the atomic state to find the changed planes)
1432 * Note that @pre_swap is needed since the point where we block for fences moves
1433 * around depending upon whether an atomic commit is blocking or
1434 * non-blocking. For non-blocking commit all waiting needs to happen after
1435 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1436 * to wait **before** we do anything that can't be easily rolled back. That is
1437 * before we call drm_atomic_helper_swap_state().
1439 * Returns zero if success or < 0 if dma_fence_wait() fails.
1441 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1442 struct drm_atomic_state *state,
1445 struct drm_plane *plane;
1446 struct drm_plane_state *new_plane_state;
1449 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1450 if (!new_plane_state->fence)
1453 WARN_ON(!new_plane_state->fb);
1456 * If waiting for fences pre-swap (ie: nonblock), userspace can
1457 * still interrupt the operation. Instead of blocking until the
1458 * timer expires, make the wait interruptible.
1460 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1464 dma_fence_put(new_plane_state->fence);
1465 new_plane_state->fence = NULL;
1470 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1473 * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs
1475 * @old_state: atomic state object with old state structures
1477 * Helper to, after atomic commit, wait for vblanks on all affected
1478 * CRTCs (ie. before cleaning up old framebuffers using
1479 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1480 * framebuffers have actually changed to optimize for the legacy cursor and
1481 * plane update use-case.
1483 * Drivers using the nonblocking commit tracking support initialized by calling
1484 * drm_atomic_helper_setup_commit() should look at
1485 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1488 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1489 struct drm_atomic_state *old_state)
1491 struct drm_crtc *crtc;
1492 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1494 unsigned int crtc_mask = 0;
1497 * Legacy cursor ioctls are completely unsynced, and userspace
1498 * relies on that (by doing tons of cursor updates).
1500 if (old_state->legacy_cursor_update)
1503 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1504 if (!new_crtc_state->active)
1507 ret = drm_crtc_vblank_get(crtc);
1511 crtc_mask |= drm_crtc_mask(crtc);
1512 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1515 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1516 if (!(crtc_mask & drm_crtc_mask(crtc)))
1519 ret = wait_event_timeout(dev->vblank[i].queue,
1520 old_state->crtcs[i].last_vblank_count !=
1521 drm_crtc_vblank_count(crtc),
1522 msecs_to_jiffies(100));
1524 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1525 crtc->base.id, crtc->name);
1527 drm_crtc_vblank_put(crtc);
1530 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1533 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1535 * @old_state: atomic state object with old state structures
1537 * Helper to, after atomic commit, wait for page flips on all affected
1538 * crtcs (ie. before cleaning up old framebuffers using
1539 * drm_atomic_helper_cleanup_planes()). Compared to
1540 * drm_atomic_helper_wait_for_vblanks() this waits for the completion on all
1541 * CRTCs, assuming that cursors-only updates are signalling their completion
1542 * immediately (or using a different path).
1544 * This requires that drivers use the nonblocking commit tracking support
1545 * initialized using drm_atomic_helper_setup_commit().
1547 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1548 struct drm_atomic_state *old_state)
1550 struct drm_crtc *crtc;
1553 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1554 struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1557 crtc = old_state->crtcs[i].ptr;
1559 if (!crtc || !commit)
1562 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1564 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1565 crtc->base.id, crtc->name);
1568 if (old_state->fake_commit)
1569 complete_all(&old_state->fake_commit->flip_done);
1571 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1574 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1575 * @old_state: atomic state object with old state structures
1577 * This is the default implementation for the
1578 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1579 * that do not support runtime_pm or do not need the CRTC to be
1580 * enabled to perform a commit. Otherwise, see
1581 * drm_atomic_helper_commit_tail_rpm().
1583 * Note that the default ordering of how the various stages are called is to
1584 * match the legacy modeset helper library closest.
1586 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1588 struct drm_device *dev = old_state->dev;
1590 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1592 drm_atomic_helper_commit_planes(dev, old_state, 0);
1594 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1596 drm_atomic_helper_fake_vblank(old_state);
1598 drm_atomic_helper_commit_hw_done(old_state);
1600 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1602 drm_atomic_helper_cleanup_planes(dev, old_state);
1604 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1607 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1608 * @old_state: new modeset state to be committed
1610 * This is an alternative implementation for the
1611 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1612 * that support runtime_pm or need the CRTC to be enabled to perform a
1613 * commit. Otherwise, one should use the default implementation
1614 * drm_atomic_helper_commit_tail().
1616 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1618 struct drm_device *dev = old_state->dev;
1620 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1622 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1624 drm_atomic_helper_commit_planes(dev, old_state,
1625 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1627 drm_atomic_helper_fake_vblank(old_state);
1629 drm_atomic_helper_commit_hw_done(old_state);
1631 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1633 drm_atomic_helper_cleanup_planes(dev, old_state);
1635 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1637 static void commit_tail(struct drm_atomic_state *old_state)
1639 struct drm_device *dev = old_state->dev;
1640 const struct drm_mode_config_helper_funcs *funcs;
1641 struct drm_crtc_state *new_crtc_state;
1642 struct drm_crtc *crtc;
1645 unsigned int i, new_self_refresh_mask = 0;
1647 funcs = dev->mode_config.helper_private;
1650 * We're measuring the _entire_ commit, so the time will vary depending
1651 * on how many fences and objects are involved. For the purposes of self
1652 * refresh, this is desirable since it'll give us an idea of how
1653 * congested things are. This will inform our decision on how often we
1654 * should enter self refresh after idle.
1656 * These times will be averaged out in the self refresh helpers to avoid
1657 * overreacting over one outlier frame
1659 start = ktime_get();
1661 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1663 drm_atomic_helper_wait_for_dependencies(old_state);
1666 * We cannot safely access new_crtc_state after
1667 * drm_atomic_helper_commit_hw_done() so figure out which crtc's have
1668 * self-refresh active beforehand:
1670 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i)
1671 if (new_crtc_state->self_refresh_active)
1672 new_self_refresh_mask |= BIT(i);
1674 if (funcs && funcs->atomic_commit_tail)
1675 funcs->atomic_commit_tail(old_state);
1677 drm_atomic_helper_commit_tail(old_state);
1679 commit_time_ms = ktime_ms_delta(ktime_get(), start);
1680 if (commit_time_ms > 0)
1681 drm_self_refresh_helper_update_avg_times(old_state,
1682 (unsigned long)commit_time_ms,
1683 new_self_refresh_mask);
1685 drm_atomic_helper_commit_cleanup_done(old_state);
1687 drm_atomic_state_put(old_state);
1690 static void commit_work(struct work_struct *work)
1692 struct drm_atomic_state *state = container_of(work,
1693 struct drm_atomic_state,
1699 * drm_atomic_helper_async_check - check if state can be committed asynchronously
1701 * @state: the driver state object
1703 * This helper will check if it is possible to commit the state asynchronously.
1704 * Async commits are not supposed to swap the states like normal sync commits
1705 * but just do in-place changes on the current state.
1707 * It will return 0 if the commit can happen in an asynchronous fashion or error
1708 * if not. Note that error just mean it can't be committed asynchronously, if it
1709 * fails the commit should be treated like a normal synchronous commit.
1711 int drm_atomic_helper_async_check(struct drm_device *dev,
1712 struct drm_atomic_state *state)
1714 struct drm_crtc *crtc;
1715 struct drm_crtc_state *crtc_state;
1716 struct drm_plane *plane = NULL;
1717 struct drm_plane_state *old_plane_state = NULL;
1718 struct drm_plane_state *new_plane_state = NULL;
1719 const struct drm_plane_helper_funcs *funcs;
1720 int i, n_planes = 0;
1722 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1723 if (drm_atomic_crtc_needs_modeset(crtc_state))
1727 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1730 /* FIXME: we support only single plane updates for now */
1734 if (!new_plane_state->crtc ||
1735 old_plane_state->crtc != new_plane_state->crtc)
1738 funcs = plane->helper_private;
1739 if (!funcs->atomic_async_update)
1742 if (new_plane_state->fence)
1746 * Don't do an async update if there is an outstanding commit modifying
1747 * the plane. This prevents our async update's changes from getting
1748 * overridden by a previous synchronous update's state.
1750 if (old_plane_state->commit &&
1751 !try_wait_for_completion(&old_plane_state->commit->hw_done)) {
1752 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] inflight previous commit preventing async commit\n",
1753 plane->base.id, plane->name);
1757 return funcs->atomic_async_check(plane, state);
1759 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1762 * drm_atomic_helper_async_commit - commit state asynchronously
1764 * @state: the driver state object
1766 * This function commits a state asynchronously, i.e., not vblank
1767 * synchronized. It should be used on a state only when
1768 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1769 * the states like normal sync commits, but just do in-place changes on the
1772 * TODO: Implement full swap instead of doing in-place changes.
1774 void drm_atomic_helper_async_commit(struct drm_device *dev,
1775 struct drm_atomic_state *state)
1777 struct drm_plane *plane;
1778 struct drm_plane_state *plane_state;
1779 const struct drm_plane_helper_funcs *funcs;
1782 for_each_new_plane_in_state(state, plane, plane_state, i) {
1783 struct drm_framebuffer *new_fb = plane_state->fb;
1784 struct drm_framebuffer *old_fb = plane->state->fb;
1786 funcs = plane->helper_private;
1787 funcs->atomic_async_update(plane, state);
1790 * ->atomic_async_update() is supposed to update the
1791 * plane->state in-place, make sure at least common
1792 * properties have been properly updated.
1794 WARN_ON_ONCE(plane->state->fb != new_fb);
1795 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1796 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1797 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1798 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1801 * Make sure the FBs have been swapped so that cleanups in the
1802 * new_state performs a cleanup in the old FB.
1804 WARN_ON_ONCE(plane_state->fb != old_fb);
1807 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1810 * drm_atomic_helper_commit - commit validated state object
1812 * @state: the driver state object
1813 * @nonblock: whether nonblocking behavior is requested.
1815 * This function commits a with drm_atomic_helper_check() pre-validated state
1816 * object. This can still fail when e.g. the framebuffer reservation fails. This
1817 * function implements nonblocking commits, using
1818 * drm_atomic_helper_setup_commit() and related functions.
1820 * Committing the actual hardware state is done through the
1821 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1822 * implementation drm_atomic_helper_commit_tail().
1825 * Zero for success or -errno.
1827 int drm_atomic_helper_commit(struct drm_device *dev,
1828 struct drm_atomic_state *state,
1833 if (state->async_update) {
1834 ret = drm_atomic_helper_prepare_planes(dev, state);
1838 drm_atomic_helper_async_commit(dev, state);
1839 drm_atomic_helper_cleanup_planes(dev, state);
1844 ret = drm_atomic_helper_setup_commit(state, nonblock);
1848 INIT_WORK(&state->commit_work, commit_work);
1850 ret = drm_atomic_helper_prepare_planes(dev, state);
1855 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1861 * This is the point of no return - everything below never fails except
1862 * when the hw goes bonghits. Which means we can commit the new state on
1863 * the software side now.
1866 ret = drm_atomic_helper_swap_state(state, true);
1871 * Everything below can be run asynchronously without the need to grab
1872 * any modeset locks at all under one condition: It must be guaranteed
1873 * that the asynchronous work has either been cancelled (if the driver
1874 * supports it, which at least requires that the framebuffers get
1875 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1876 * before the new state gets committed on the software side with
1877 * drm_atomic_helper_swap_state().
1879 * This scheme allows new atomic state updates to be prepared and
1880 * checked in parallel to the asynchronous completion of the previous
1881 * update. Which is important since compositors need to figure out the
1882 * composition of the next frame right after having submitted the
1885 * NOTE: Commit work has multiple phases, first hardware commit, then
1886 * cleanup. We want them to overlap, hence need system_unbound_wq to
1887 * make sure work items don't artificially stall on each another.
1890 drm_atomic_state_get(state);
1892 queue_work(system_unbound_wq, &state->commit_work);
1899 drm_atomic_helper_cleanup_planes(dev, state);
1902 EXPORT_SYMBOL(drm_atomic_helper_commit);
1905 * DOC: implementing nonblocking commit
1907 * Nonblocking atomic commits should use struct &drm_crtc_commit to sequence
1908 * different operations against each another. Locks, especially struct
1909 * &drm_modeset_lock, should not be held in worker threads or any other
1910 * asynchronous context used to commit the hardware state.
1912 * drm_atomic_helper_commit() implements the recommended sequence for
1913 * nonblocking commits, using drm_atomic_helper_setup_commit() internally:
1915 * 1. Run drm_atomic_helper_prepare_planes(). Since this can fail and we
1916 * need to propagate out of memory/VRAM errors to userspace, it must be called
1919 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1920 * might be affected by the new state update. This is handled by
1921 * drm_atomic_helper_setup_commit().
1923 * Asynchronous workers need to have sufficient parallelism to be able to run
1924 * different atomic commits on different CRTCs in parallel. The simplest way to
1925 * achieve this is by running them on the &system_unbound_wq work queue. Note
1926 * that drivers are not required to split up atomic commits and run an
1927 * individual commit in parallel - userspace is supposed to do that if it cares.
1928 * But it might be beneficial to do that for modesets, since those necessarily
1929 * must be done as one global operation, and enabling or disabling a CRTC can
1930 * take a long time. But even that is not required.
1932 * IMPORTANT: A &drm_atomic_state update for multiple CRTCs is sequenced
1933 * against all CRTCs therein. Therefore for atomic state updates which only flip
1934 * planes the driver must not get the struct &drm_crtc_state of unrelated CRTCs
1935 * in its atomic check code: This would prevent committing of atomic updates to
1936 * multiple CRTCs in parallel. In general, adding additional state structures
1937 * should be avoided as much as possible, because this reduces parallelism in
1938 * (nonblocking) commits, both due to locking and due to commit sequencing
1941 * 3. The software state is updated synchronously with
1942 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1943 * locks means concurrent callers never see inconsistent state. Note that commit
1944 * workers do not hold any locks; their access is only coordinated through
1945 * ordering. If workers would access state only through the pointers in the
1946 * free-standing state objects (currently not the case for any driver) then even
1947 * multiple pending commits could be in-flight at the same time.
1949 * 4. Schedule a work item to do all subsequent steps, using the split-out
1950 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1951 * then cleaning up the framebuffers after the old framebuffer is no longer
1952 * being displayed. The scheduled work should synchronize against other workers
1953 * using the &drm_crtc_commit infrastructure as needed. See
1954 * drm_atomic_helper_setup_commit() for more details.
1957 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1959 struct drm_crtc_commit *commit, *stall_commit = NULL;
1960 bool completed = true;
1964 spin_lock(&crtc->commit_lock);
1966 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1968 completed = try_wait_for_completion(&commit->flip_done);
1970 * Userspace is not allowed to get ahead of the previous
1971 * commit with nonblocking ones.
1973 if (!completed && nonblock) {
1974 spin_unlock(&crtc->commit_lock);
1975 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] busy with a previous commit\n",
1976 crtc->base.id, crtc->name);
1980 } else if (i == 1) {
1981 stall_commit = drm_crtc_commit_get(commit);
1987 spin_unlock(&crtc->commit_lock);
1992 /* We don't want to let commits get ahead of cleanup work too much,
1993 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1995 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1998 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1999 crtc->base.id, crtc->name);
2001 drm_crtc_commit_put(stall_commit);
2003 return ret < 0 ? ret : 0;
2006 static void release_crtc_commit(struct completion *completion)
2008 struct drm_crtc_commit *commit = container_of(completion,
2012 drm_crtc_commit_put(commit);
2015 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
2017 init_completion(&commit->flip_done);
2018 init_completion(&commit->hw_done);
2019 init_completion(&commit->cleanup_done);
2020 INIT_LIST_HEAD(&commit->commit_entry);
2021 kref_init(&commit->ref);
2022 commit->crtc = crtc;
2025 static struct drm_crtc_commit *
2026 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
2029 struct drm_crtc_state *new_crtc_state;
2031 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2033 return new_crtc_state->commit;
2036 if (!state->fake_commit) {
2037 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
2038 if (!state->fake_commit)
2041 init_commit(state->fake_commit, NULL);
2044 return state->fake_commit;
2048 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
2049 * @state: new modeset state to be committed
2050 * @nonblock: whether nonblocking behavior is requested.
2052 * This function prepares @state to be used by the atomic helper's support for
2053 * nonblocking commits. Drivers using the nonblocking commit infrastructure
2054 * should always call this function from their
2055 * &drm_mode_config_funcs.atomic_commit hook.
2057 * Drivers that need to extend the commit setup to private objects can use the
2058 * &drm_mode_config_helper_funcs.atomic_commit_setup hook.
2060 * To be able to use this support drivers need to use a few more helper
2061 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
2062 * actually committing the hardware state, and for nonblocking commits this call
2063 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
2064 * and its stall parameter, for when a driver's commit hooks look at the
2065 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
2067 * Completion of the hardware commit step must be signalled using
2068 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
2069 * to read or change any permanent software or hardware modeset state. The only
2070 * exception is state protected by other means than &drm_modeset_lock locks.
2071 * Only the free standing @state with pointers to the old state structures can
2072 * be inspected, e.g. to clean up old buffers using
2073 * drm_atomic_helper_cleanup_planes().
2075 * At the very end, before cleaning up @state drivers must call
2076 * drm_atomic_helper_commit_cleanup_done().
2078 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
2079 * complete and easy-to-use default implementation of the atomic_commit() hook.
2081 * The tracking of asynchronously executed and still pending commits is done
2082 * using the core structure &drm_crtc_commit.
2084 * By default there's no need to clean up resources allocated by this function
2085 * explicitly: drm_atomic_state_default_clear() will take care of that
2090 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
2091 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
2093 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
2096 struct drm_crtc *crtc;
2097 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2098 struct drm_connector *conn;
2099 struct drm_connector_state *old_conn_state, *new_conn_state;
2100 struct drm_plane *plane;
2101 struct drm_plane_state *old_plane_state, *new_plane_state;
2102 struct drm_crtc_commit *commit;
2103 const struct drm_mode_config_helper_funcs *funcs;
2106 funcs = state->dev->mode_config.helper_private;
2108 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2109 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
2113 init_commit(commit, crtc);
2115 new_crtc_state->commit = commit;
2117 ret = stall_checks(crtc, nonblock);
2122 * Drivers only send out events when at least either current or
2123 * new CRTC state is active. Complete right away if everything
2126 if (!old_crtc_state->active && !new_crtc_state->active) {
2127 complete_all(&commit->flip_done);
2131 /* Legacy cursor updates are fully unsynced. */
2132 if (state->legacy_cursor_update) {
2133 complete_all(&commit->flip_done);
2137 if (!new_crtc_state->event) {
2138 commit->event = kzalloc(sizeof(*commit->event),
2143 new_crtc_state->event = commit->event;
2146 new_crtc_state->event->base.completion = &commit->flip_done;
2147 new_crtc_state->event->base.completion_release = release_crtc_commit;
2148 drm_crtc_commit_get(commit);
2150 commit->abort_completion = true;
2152 state->crtcs[i].commit = commit;
2153 drm_crtc_commit_get(commit);
2156 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2158 * Userspace is not allowed to get ahead of the previous
2159 * commit with nonblocking ones.
2161 if (nonblock && old_conn_state->commit &&
2162 !try_wait_for_completion(&old_conn_state->commit->flip_done)) {
2163 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] busy with a previous commit\n",
2164 conn->base.id, conn->name);
2169 /* Always track connectors explicitly for e.g. link retraining. */
2170 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2174 new_conn_state->commit = drm_crtc_commit_get(commit);
2177 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2179 * Userspace is not allowed to get ahead of the previous
2180 * commit with nonblocking ones.
2182 if (nonblock && old_plane_state->commit &&
2183 !try_wait_for_completion(&old_plane_state->commit->flip_done)) {
2184 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] busy with a previous commit\n",
2185 plane->base.id, plane->name);
2190 /* Always track planes explicitly for async pageflip support. */
2191 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2195 new_plane_state->commit = drm_crtc_commit_get(commit);
2198 if (funcs && funcs->atomic_commit_setup)
2199 return funcs->atomic_commit_setup(state);
2203 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2206 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2207 * @old_state: atomic state object with old state structures
2209 * This function waits for all preceeding commits that touch the same CRTC as
2210 * @old_state to both be committed to the hardware (as signalled by
2211 * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
2212 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2214 * This is part of the atomic helper support for nonblocking commits, see
2215 * drm_atomic_helper_setup_commit() for an overview.
2217 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2219 struct drm_crtc *crtc;
2220 struct drm_crtc_state *old_crtc_state;
2221 struct drm_plane *plane;
2222 struct drm_plane_state *old_plane_state;
2223 struct drm_connector *conn;
2224 struct drm_connector_state *old_conn_state;
2228 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2229 ret = drm_crtc_commit_wait(old_crtc_state->commit);
2231 DRM_ERROR("[CRTC:%d:%s] commit wait timed out\n",
2232 crtc->base.id, crtc->name);
2235 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2236 ret = drm_crtc_commit_wait(old_conn_state->commit);
2238 DRM_ERROR("[CONNECTOR:%d:%s] commit wait timed out\n",
2239 conn->base.id, conn->name);
2242 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2243 ret = drm_crtc_commit_wait(old_plane_state->commit);
2245 DRM_ERROR("[PLANE:%d:%s] commit wait timed out\n",
2246 plane->base.id, plane->name);
2249 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2252 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2253 * @old_state: atomic state object with old state structures
2255 * This function walks all CRTCs and fakes VBLANK events on those with
2256 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2257 * The primary use of this function is writeback connectors working in oneshot
2258 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2259 * when a job is queued, and any change to the pipeline that does not touch the
2260 * connector is leading to timeouts when calling
2261 * drm_atomic_helper_wait_for_vblanks() or
2262 * drm_atomic_helper_wait_for_flip_done(). In addition to writeback
2263 * connectors, this function can also fake VBLANK events for CRTCs without
2266 * This is part of the atomic helper support for nonblocking commits, see
2267 * drm_atomic_helper_setup_commit() for an overview.
2269 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2271 struct drm_crtc_state *new_crtc_state;
2272 struct drm_crtc *crtc;
2275 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2276 unsigned long flags;
2278 if (!new_crtc_state->no_vblank)
2281 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2282 if (new_crtc_state->event) {
2283 drm_crtc_send_vblank_event(crtc,
2284 new_crtc_state->event);
2285 new_crtc_state->event = NULL;
2287 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2290 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2293 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2294 * @old_state: atomic state object with old state structures
2296 * This function is used to signal completion of the hardware commit step. After
2297 * this step the driver is not allowed to read or change any permanent software
2298 * or hardware modeset state. The only exception is state protected by other
2299 * means than &drm_modeset_lock locks.
2301 * Drivers should try to postpone any expensive or delayed cleanup work after
2302 * this function is called.
2304 * This is part of the atomic helper support for nonblocking commits, see
2305 * drm_atomic_helper_setup_commit() for an overview.
2307 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2309 struct drm_crtc *crtc;
2310 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2311 struct drm_crtc_commit *commit;
2314 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2315 commit = new_crtc_state->commit;
2320 * copy new_crtc_state->commit to old_crtc_state->commit,
2321 * it's unsafe to touch new_crtc_state after hw_done,
2322 * but we still need to do so in cleanup_done().
2324 if (old_crtc_state->commit)
2325 drm_crtc_commit_put(old_crtc_state->commit);
2327 old_crtc_state->commit = drm_crtc_commit_get(commit);
2329 /* backend must have consumed any event by now */
2330 WARN_ON(new_crtc_state->event);
2331 complete_all(&commit->hw_done);
2334 if (old_state->fake_commit) {
2335 complete_all(&old_state->fake_commit->hw_done);
2336 complete_all(&old_state->fake_commit->flip_done);
2339 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2342 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2343 * @old_state: atomic state object with old state structures
2345 * This signals completion of the atomic update @old_state, including any
2346 * cleanup work. If used, it must be called right before calling
2347 * drm_atomic_state_put().
2349 * This is part of the atomic helper support for nonblocking commits, see
2350 * drm_atomic_helper_setup_commit() for an overview.
2352 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2354 struct drm_crtc *crtc;
2355 struct drm_crtc_state *old_crtc_state;
2356 struct drm_crtc_commit *commit;
2359 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2360 commit = old_crtc_state->commit;
2361 if (WARN_ON(!commit))
2364 complete_all(&commit->cleanup_done);
2365 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2367 spin_lock(&crtc->commit_lock);
2368 list_del(&commit->commit_entry);
2369 spin_unlock(&crtc->commit_lock);
2372 if (old_state->fake_commit) {
2373 complete_all(&old_state->fake_commit->cleanup_done);
2374 WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2377 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2380 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2382 * @state: atomic state object with new state structures
2384 * This function prepares plane state, specifically framebuffers, for the new
2385 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2386 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2387 * any already successfully prepared framebuffer.
2390 * 0 on success, negative error code on failure.
2392 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2393 struct drm_atomic_state *state)
2395 struct drm_connector *connector;
2396 struct drm_connector_state *new_conn_state;
2397 struct drm_plane *plane;
2398 struct drm_plane_state *new_plane_state;
2401 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2402 if (!new_conn_state->writeback_job)
2405 ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2410 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2411 const struct drm_plane_helper_funcs *funcs;
2413 funcs = plane->helper_private;
2415 if (funcs->prepare_fb) {
2416 ret = funcs->prepare_fb(plane, new_plane_state);
2420 WARN_ON_ONCE(funcs->cleanup_fb);
2422 if (!drm_core_check_feature(dev, DRIVER_GEM))
2425 ret = drm_gem_plane_helper_prepare_fb(plane, new_plane_state);
2434 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2435 const struct drm_plane_helper_funcs *funcs;
2440 funcs = plane->helper_private;
2442 if (funcs->cleanup_fb)
2443 funcs->cleanup_fb(plane, new_plane_state);
2448 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2450 static bool plane_crtc_active(const struct drm_plane_state *state)
2452 return state->crtc && state->crtc->state->active;
2456 * drm_atomic_helper_commit_planes - commit plane state
2458 * @old_state: atomic state object with old state structures
2459 * @flags: flags for committing plane state
2461 * This function commits the new plane state using the plane and atomic helper
2462 * functions for planes and CRTCs. It assumes that the atomic state has already
2463 * been pushed into the relevant object state pointers, since this step can no
2466 * It still requires the global state object @old_state to know which planes and
2467 * crtcs need to be updated though.
2469 * Note that this function does all plane updates across all CRTCs in one step.
2470 * If the hardware can't support this approach look at
2471 * drm_atomic_helper_commit_planes_on_crtc() instead.
2473 * Plane parameters can be updated by applications while the associated CRTC is
2474 * disabled. The DRM/KMS core will store the parameters in the plane state,
2475 * which will be available to the driver when the CRTC is turned on. As a result
2476 * most drivers don't need to be immediately notified of plane updates for a
2479 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2480 * @flags in order not to receive plane update notifications related to a
2481 * disabled CRTC. This avoids the need to manually ignore plane updates in
2482 * driver code when the driver and/or hardware can't or just don't need to deal
2483 * with updates on disabled CRTCs, for example when supporting runtime PM.
2485 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2486 * display controllers require to disable a CRTC's planes when the CRTC is
2487 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2488 * call for a plane if the CRTC of the old plane state needs a modesetting
2489 * operation. Of course, the drivers need to disable the planes in their CRTC
2490 * disable callbacks since no one else would do that.
2492 * The drm_atomic_helper_commit() default implementation doesn't set the
2493 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2494 * This should not be copied blindly by drivers.
2496 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2497 struct drm_atomic_state *old_state,
2500 struct drm_crtc *crtc;
2501 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2502 struct drm_plane *plane;
2503 struct drm_plane_state *old_plane_state, *new_plane_state;
2505 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2506 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2508 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2509 const struct drm_crtc_helper_funcs *funcs;
2511 funcs = crtc->helper_private;
2513 if (!funcs || !funcs->atomic_begin)
2516 if (active_only && !new_crtc_state->active)
2519 funcs->atomic_begin(crtc, old_state);
2522 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2523 const struct drm_plane_helper_funcs *funcs;
2526 funcs = plane->helper_private;
2531 disabling = drm_atomic_plane_disabling(old_plane_state,
2536 * Skip planes related to inactive CRTCs. If the plane
2537 * is enabled use the state of the current CRTC. If the
2538 * plane is being disabled use the state of the old
2539 * CRTC to avoid skipping planes being disabled on an
2542 if (!disabling && !plane_crtc_active(new_plane_state))
2544 if (disabling && !plane_crtc_active(old_plane_state))
2549 * Special-case disabling the plane if drivers support it.
2551 if (disabling && funcs->atomic_disable) {
2552 struct drm_crtc_state *crtc_state;
2554 crtc_state = old_plane_state->crtc->state;
2556 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2560 funcs->atomic_disable(plane, old_state);
2561 } else if (new_plane_state->crtc || disabling) {
2562 funcs->atomic_update(plane, old_state);
2566 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2567 const struct drm_crtc_helper_funcs *funcs;
2569 funcs = crtc->helper_private;
2571 if (!funcs || !funcs->atomic_flush)
2574 if (active_only && !new_crtc_state->active)
2577 funcs->atomic_flush(crtc, old_state);
2580 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2583 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC
2584 * @old_crtc_state: atomic state object with the old CRTC state
2586 * This function commits the new plane state using the plane and atomic helper
2587 * functions for planes on the specific CRTC. It assumes that the atomic state
2588 * has already been pushed into the relevant object state pointers, since this
2589 * step can no longer fail.
2591 * This function is useful when plane updates should be done CRTC-by-CRTC
2592 * instead of one global step like drm_atomic_helper_commit_planes() does.
2594 * This function can only be savely used when planes are not allowed to move
2595 * between different CRTCs because this function doesn't handle inter-CRTC
2596 * dependencies. Callers need to ensure that either no such dependencies exist,
2597 * resolve them through ordering of commit calls or through some other means.
2600 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2602 const struct drm_crtc_helper_funcs *crtc_funcs;
2603 struct drm_crtc *crtc = old_crtc_state->crtc;
2604 struct drm_atomic_state *old_state = old_crtc_state->state;
2605 struct drm_crtc_state *new_crtc_state =
2606 drm_atomic_get_new_crtc_state(old_state, crtc);
2607 struct drm_plane *plane;
2608 unsigned int plane_mask;
2610 plane_mask = old_crtc_state->plane_mask;
2611 plane_mask |= new_crtc_state->plane_mask;
2613 crtc_funcs = crtc->helper_private;
2614 if (crtc_funcs && crtc_funcs->atomic_begin)
2615 crtc_funcs->atomic_begin(crtc, old_state);
2617 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2618 struct drm_plane_state *old_plane_state =
2619 drm_atomic_get_old_plane_state(old_state, plane);
2620 struct drm_plane_state *new_plane_state =
2621 drm_atomic_get_new_plane_state(old_state, plane);
2622 const struct drm_plane_helper_funcs *plane_funcs;
2624 plane_funcs = plane->helper_private;
2626 if (!old_plane_state || !plane_funcs)
2629 WARN_ON(new_plane_state->crtc &&
2630 new_plane_state->crtc != crtc);
2632 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2633 plane_funcs->atomic_disable)
2634 plane_funcs->atomic_disable(plane, old_state);
2635 else if (new_plane_state->crtc ||
2636 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2637 plane_funcs->atomic_update(plane, old_state);
2640 if (crtc_funcs && crtc_funcs->atomic_flush)
2641 crtc_funcs->atomic_flush(crtc, old_state);
2643 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2646 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2647 * @old_crtc_state: atomic state object with the old CRTC state
2648 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2650 * Disables all planes associated with the given CRTC. This can be
2651 * used for instance in the CRTC helper atomic_disable callback to disable
2654 * If the atomic-parameter is set the function calls the CRTC's
2655 * atomic_begin hook before and atomic_flush hook after disabling the
2658 * It is a bug to call this function without having implemented the
2659 * &drm_plane_helper_funcs.atomic_disable plane hook.
2662 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2665 struct drm_crtc *crtc = old_crtc_state->crtc;
2666 const struct drm_crtc_helper_funcs *crtc_funcs =
2667 crtc->helper_private;
2668 struct drm_plane *plane;
2670 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2671 crtc_funcs->atomic_begin(crtc, NULL);
2673 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2674 const struct drm_plane_helper_funcs *plane_funcs =
2675 plane->helper_private;
2680 WARN_ON(!plane_funcs->atomic_disable);
2681 if (plane_funcs->atomic_disable)
2682 plane_funcs->atomic_disable(plane, NULL);
2685 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2686 crtc_funcs->atomic_flush(crtc, NULL);
2688 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2691 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2693 * @old_state: atomic state object with old state structures
2695 * This function cleans up plane state, specifically framebuffers, from the old
2696 * configuration. Hence the old configuration must be perserved in @old_state to
2697 * be able to call this function.
2699 * This function must also be called on the new state when the atomic update
2700 * fails at any point after calling drm_atomic_helper_prepare_planes().
2702 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2703 struct drm_atomic_state *old_state)
2705 struct drm_plane *plane;
2706 struct drm_plane_state *old_plane_state, *new_plane_state;
2709 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2710 const struct drm_plane_helper_funcs *funcs;
2711 struct drm_plane_state *plane_state;
2714 * This might be called before swapping when commit is aborted,
2715 * in which case we have to cleanup the new state.
2717 if (old_plane_state == plane->state)
2718 plane_state = new_plane_state;
2720 plane_state = old_plane_state;
2722 funcs = plane->helper_private;
2724 if (funcs->cleanup_fb)
2725 funcs->cleanup_fb(plane, plane_state);
2728 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2731 * drm_atomic_helper_swap_state - store atomic state into current sw state
2732 * @state: atomic state
2733 * @stall: stall for preceding commits
2735 * This function stores the atomic state into the current state pointers in all
2736 * driver objects. It should be called after all failing steps have been done
2737 * and succeeded, but before the actual hardware state is committed.
2739 * For cleanup and error recovery the current state for all changed objects will
2740 * be swapped into @state.
2742 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2744 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2746 * 2. Do any other steps that might fail.
2748 * 3. Put the staged state into the current state pointers with this function.
2750 * 4. Actually commit the hardware state.
2752 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2753 * contains the old state. Also do any other cleanup required with that state.
2755 * @stall must be set when nonblocking commits for this driver directly access
2756 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2757 * the current atomic helpers this is almost always the case, since the helpers
2758 * don't pass the right state structures to the callbacks.
2762 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2763 * waiting for the previous commits has been interrupted.
2765 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2769 struct drm_connector *connector;
2770 struct drm_connector_state *old_conn_state, *new_conn_state;
2771 struct drm_crtc *crtc;
2772 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2773 struct drm_plane *plane;
2774 struct drm_plane_state *old_plane_state, *new_plane_state;
2775 struct drm_crtc_commit *commit;
2776 struct drm_private_obj *obj;
2777 struct drm_private_state *old_obj_state, *new_obj_state;
2781 * We have to stall for hw_done here before
2782 * drm_atomic_helper_wait_for_dependencies() because flip
2783 * depth > 1 is not yet supported by all drivers. As long as
2784 * obj->state is directly dereferenced anywhere in the drivers
2785 * atomic_commit_tail function, then it's unsafe to swap state
2786 * before drm_atomic_helper_commit_hw_done() is called.
2789 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2790 commit = old_crtc_state->commit;
2795 ret = wait_for_completion_interruptible(&commit->hw_done);
2800 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2801 commit = old_conn_state->commit;
2806 ret = wait_for_completion_interruptible(&commit->hw_done);
2811 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2812 commit = old_plane_state->commit;
2817 ret = wait_for_completion_interruptible(&commit->hw_done);
2823 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2824 WARN_ON(connector->state != old_conn_state);
2826 old_conn_state->state = state;
2827 new_conn_state->state = NULL;
2829 state->connectors[i].state = old_conn_state;
2830 connector->state = new_conn_state;
2833 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2834 WARN_ON(crtc->state != old_crtc_state);
2836 old_crtc_state->state = state;
2837 new_crtc_state->state = NULL;
2839 state->crtcs[i].state = old_crtc_state;
2840 crtc->state = new_crtc_state;
2842 if (new_crtc_state->commit) {
2843 spin_lock(&crtc->commit_lock);
2844 list_add(&new_crtc_state->commit->commit_entry,
2845 &crtc->commit_list);
2846 spin_unlock(&crtc->commit_lock);
2848 new_crtc_state->commit->event = NULL;
2852 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2853 WARN_ON(plane->state != old_plane_state);
2855 old_plane_state->state = state;
2856 new_plane_state->state = NULL;
2858 state->planes[i].state = old_plane_state;
2859 plane->state = new_plane_state;
2862 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2863 WARN_ON(obj->state != old_obj_state);
2865 old_obj_state->state = state;
2866 new_obj_state->state = NULL;
2868 state->private_objs[i].state = old_obj_state;
2869 obj->state = new_obj_state;
2874 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2877 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2878 * @plane: plane object to update
2879 * @crtc: owning CRTC of owning plane
2880 * @fb: framebuffer to flip onto plane
2881 * @crtc_x: x offset of primary plane on @crtc
2882 * @crtc_y: y offset of primary plane on @crtc
2883 * @crtc_w: width of primary plane rectangle on @crtc
2884 * @crtc_h: height of primary plane rectangle on @crtc
2885 * @src_x: x offset of @fb for panning
2886 * @src_y: y offset of @fb for panning
2887 * @src_w: width of source rectangle in @fb
2888 * @src_h: height of source rectangle in @fb
2889 * @ctx: lock acquire context
2891 * Provides a default plane update handler using the atomic driver interface.
2894 * Zero on success, error code on failure
2896 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2897 struct drm_crtc *crtc,
2898 struct drm_framebuffer *fb,
2899 int crtc_x, int crtc_y,
2900 unsigned int crtc_w, unsigned int crtc_h,
2901 uint32_t src_x, uint32_t src_y,
2902 uint32_t src_w, uint32_t src_h,
2903 struct drm_modeset_acquire_ctx *ctx)
2905 struct drm_atomic_state *state;
2906 struct drm_plane_state *plane_state;
2909 state = drm_atomic_state_alloc(plane->dev);
2913 state->acquire_ctx = ctx;
2914 plane_state = drm_atomic_get_plane_state(state, plane);
2915 if (IS_ERR(plane_state)) {
2916 ret = PTR_ERR(plane_state);
2920 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2923 drm_atomic_set_fb_for_plane(plane_state, fb);
2924 plane_state->crtc_x = crtc_x;
2925 plane_state->crtc_y = crtc_y;
2926 plane_state->crtc_w = crtc_w;
2927 plane_state->crtc_h = crtc_h;
2928 plane_state->src_x = src_x;
2929 plane_state->src_y = src_y;
2930 plane_state->src_w = src_w;
2931 plane_state->src_h = src_h;
2933 if (plane == crtc->cursor)
2934 state->legacy_cursor_update = true;
2936 ret = drm_atomic_commit(state);
2938 drm_atomic_state_put(state);
2941 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2944 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2945 * @plane: plane to disable
2946 * @ctx: lock acquire context
2948 * Provides a default plane disable handler using the atomic driver interface.
2951 * Zero on success, error code on failure
2953 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2954 struct drm_modeset_acquire_ctx *ctx)
2956 struct drm_atomic_state *state;
2957 struct drm_plane_state *plane_state;
2960 state = drm_atomic_state_alloc(plane->dev);
2964 state->acquire_ctx = ctx;
2965 plane_state = drm_atomic_get_plane_state(state, plane);
2966 if (IS_ERR(plane_state)) {
2967 ret = PTR_ERR(plane_state);
2971 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2972 plane_state->state->legacy_cursor_update = true;
2974 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2978 ret = drm_atomic_commit(state);
2980 drm_atomic_state_put(state);
2983 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2986 * drm_atomic_helper_set_config - set a new config from userspace
2987 * @set: mode set configuration
2988 * @ctx: lock acquisition context
2990 * Provides a default CRTC set_config handler using the atomic driver interface.
2992 * NOTE: For backwards compatibility with old userspace this automatically
2993 * resets the "link-status" property to GOOD, to force any link
2994 * re-training. The SETCRTC ioctl does not define whether an update does
2995 * need a full modeset or just a plane update, hence we're allowed to do
2996 * that. See also drm_connector_set_link_status_property().
2999 * Returns 0 on success, negative errno numbers on failure.
3001 int drm_atomic_helper_set_config(struct drm_mode_set *set,
3002 struct drm_modeset_acquire_ctx *ctx)
3004 struct drm_atomic_state *state;
3005 struct drm_crtc *crtc = set->crtc;
3008 state = drm_atomic_state_alloc(crtc->dev);
3012 state->acquire_ctx = ctx;
3013 ret = __drm_atomic_helper_set_config(set, state);
3017 ret = handle_conflicting_encoders(state, true);
3021 ret = drm_atomic_commit(state);
3024 drm_atomic_state_put(state);
3027 EXPORT_SYMBOL(drm_atomic_helper_set_config);
3030 * drm_atomic_helper_disable_all - disable all currently active outputs
3032 * @ctx: lock acquisition context
3034 * Loops through all connectors, finding those that aren't turned off and then
3035 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3036 * that they are connected to.
3038 * This is used for example in suspend/resume to disable all currently active
3039 * functions when suspending. If you just want to shut down everything at e.g.
3040 * driver unload, look at drm_atomic_helper_shutdown().
3042 * Note that if callers haven't already acquired all modeset locks this might
3043 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3046 * 0 on success or a negative error code on failure.
3049 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3050 * drm_atomic_helper_shutdown().
3052 int drm_atomic_helper_disable_all(struct drm_device *dev,
3053 struct drm_modeset_acquire_ctx *ctx)
3055 struct drm_atomic_state *state;
3056 struct drm_connector_state *conn_state;
3057 struct drm_connector *conn;
3058 struct drm_plane_state *plane_state;
3059 struct drm_plane *plane;
3060 struct drm_crtc_state *crtc_state;
3061 struct drm_crtc *crtc;
3064 state = drm_atomic_state_alloc(dev);
3068 state->acquire_ctx = ctx;
3070 drm_for_each_crtc(crtc, dev) {
3071 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3072 if (IS_ERR(crtc_state)) {
3073 ret = PTR_ERR(crtc_state);
3077 crtc_state->active = false;
3079 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3083 ret = drm_atomic_add_affected_planes(state, crtc);
3087 ret = drm_atomic_add_affected_connectors(state, crtc);
3092 for_each_new_connector_in_state(state, conn, conn_state, i) {
3093 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3098 for_each_new_plane_in_state(state, plane, plane_state, i) {
3099 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3103 drm_atomic_set_fb_for_plane(plane_state, NULL);
3106 ret = drm_atomic_commit(state);
3108 drm_atomic_state_put(state);
3111 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3114 * drm_atomic_helper_shutdown - shutdown all CRTC
3117 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3118 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3119 * that also takes a snapshot of the modeset state to be restored on resume.
3121 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3122 * and it is the atomic version of drm_crtc_force_disable_all().
3124 void drm_atomic_helper_shutdown(struct drm_device *dev)
3126 struct drm_modeset_acquire_ctx ctx;
3129 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3131 ret = drm_atomic_helper_disable_all(dev, &ctx);
3133 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3135 DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
3137 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3140 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3142 * @ctx: lock acquisition context
3144 * Makes a copy of the current atomic state by looping over all objects and
3145 * duplicating their respective states. This is used for example by suspend/
3146 * resume support code to save the state prior to suspend such that it can
3147 * be restored upon resume.
3149 * Note that this treats atomic state as persistent between save and restore.
3150 * Drivers must make sure that this is possible and won't result in confusion
3151 * or erroneous behaviour.
3153 * Note that if callers haven't already acquired all modeset locks this might
3154 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3157 * A pointer to the copy of the atomic state object on success or an
3158 * ERR_PTR()-encoded error code on failure.
3161 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3163 struct drm_atomic_state *
3164 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3165 struct drm_modeset_acquire_ctx *ctx)
3167 struct drm_atomic_state *state;
3168 struct drm_connector *conn;
3169 struct drm_connector_list_iter conn_iter;
3170 struct drm_plane *plane;
3171 struct drm_crtc *crtc;
3174 state = drm_atomic_state_alloc(dev);
3176 return ERR_PTR(-ENOMEM);
3178 state->acquire_ctx = ctx;
3179 state->duplicated = true;
3181 drm_for_each_crtc(crtc, dev) {
3182 struct drm_crtc_state *crtc_state;
3184 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3185 if (IS_ERR(crtc_state)) {
3186 err = PTR_ERR(crtc_state);
3191 drm_for_each_plane(plane, dev) {
3192 struct drm_plane_state *plane_state;
3194 plane_state = drm_atomic_get_plane_state(state, plane);
3195 if (IS_ERR(plane_state)) {
3196 err = PTR_ERR(plane_state);
3201 drm_connector_list_iter_begin(dev, &conn_iter);
3202 drm_for_each_connector_iter(conn, &conn_iter) {
3203 struct drm_connector_state *conn_state;
3205 conn_state = drm_atomic_get_connector_state(state, conn);
3206 if (IS_ERR(conn_state)) {
3207 err = PTR_ERR(conn_state);
3208 drm_connector_list_iter_end(&conn_iter);
3212 drm_connector_list_iter_end(&conn_iter);
3214 /* clear the acquire context so that it isn't accidentally reused */
3215 state->acquire_ctx = NULL;
3219 drm_atomic_state_put(state);
3220 state = ERR_PTR(err);
3225 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3228 * drm_atomic_helper_suspend - subsystem-level suspend helper
3231 * Duplicates the current atomic state, disables all active outputs and then
3232 * returns a pointer to the original atomic state to the caller. Drivers can
3233 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3234 * restore the output configuration that was active at the time the system
3237 * Note that it is potentially unsafe to use this. The atomic state object
3238 * returned by this function is assumed to be persistent. Drivers must ensure
3239 * that this holds true. Before calling this function, drivers must make sure
3240 * to suspend fbdev emulation so that nothing can be using the device.
3243 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3244 * encoded error code on failure. Drivers should store the returned atomic
3245 * state object and pass it to the drm_atomic_helper_resume() helper upon
3249 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3250 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3252 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3254 struct drm_modeset_acquire_ctx ctx;
3255 struct drm_atomic_state *state;
3258 /* This can never be returned, but it makes the compiler happy */
3259 state = ERR_PTR(-EINVAL);
3261 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3263 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3267 err = drm_atomic_helper_disable_all(dev, &ctx);
3269 drm_atomic_state_put(state);
3270 state = ERR_PTR(err);
3275 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3277 return ERR_PTR(err);
3281 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3284 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3285 * @state: duplicated atomic state to commit
3286 * @ctx: pointer to acquire_ctx to use for commit.
3288 * The state returned by drm_atomic_helper_duplicate_state() and
3289 * drm_atomic_helper_suspend() is partially invalid, and needs to
3290 * be fixed up before commit.
3293 * 0 on success or a negative error code on failure.
3296 * drm_atomic_helper_suspend()
3298 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3299 struct drm_modeset_acquire_ctx *ctx)
3302 struct drm_plane *plane;
3303 struct drm_plane_state *new_plane_state;
3304 struct drm_connector *connector;
3305 struct drm_connector_state *new_conn_state;
3306 struct drm_crtc *crtc;
3307 struct drm_crtc_state *new_crtc_state;
3309 state->acquire_ctx = ctx;
3311 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3312 state->planes[i].old_state = plane->state;
3314 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3315 state->crtcs[i].old_state = crtc->state;
3317 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3318 state->connectors[i].old_state = connector->state;
3320 ret = drm_atomic_commit(state);
3322 state->acquire_ctx = NULL;
3326 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3329 * drm_atomic_helper_resume - subsystem-level resume helper
3331 * @state: atomic state to resume to
3333 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3334 * grabs all modeset locks and commits the atomic state object. This can be
3335 * used in conjunction with the drm_atomic_helper_suspend() helper to
3336 * implement suspend/resume for drivers that support atomic mode-setting.
3339 * 0 on success or a negative error code on failure.
3342 * drm_atomic_helper_suspend()
3344 int drm_atomic_helper_resume(struct drm_device *dev,
3345 struct drm_atomic_state *state)
3347 struct drm_modeset_acquire_ctx ctx;
3350 drm_mode_config_reset(dev);
3352 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3354 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3356 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3357 drm_atomic_state_put(state);
3361 EXPORT_SYMBOL(drm_atomic_helper_resume);
3363 static int page_flip_common(struct drm_atomic_state *state,
3364 struct drm_crtc *crtc,
3365 struct drm_framebuffer *fb,
3366 struct drm_pending_vblank_event *event,
3369 struct drm_plane *plane = crtc->primary;
3370 struct drm_plane_state *plane_state;
3371 struct drm_crtc_state *crtc_state;
3374 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3375 if (IS_ERR(crtc_state))
3376 return PTR_ERR(crtc_state);
3378 crtc_state->event = event;
3379 crtc_state->async_flip = flags & DRM_MODE_PAGE_FLIP_ASYNC;
3381 plane_state = drm_atomic_get_plane_state(state, plane);
3382 if (IS_ERR(plane_state))
3383 return PTR_ERR(plane_state);
3385 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3388 drm_atomic_set_fb_for_plane(plane_state, fb);
3390 /* Make sure we don't accidentally do a full modeset. */
3391 state->allow_modeset = false;
3392 if (!crtc_state->active) {
3393 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3394 crtc->base.id, crtc->name);
3402 * drm_atomic_helper_page_flip - execute a legacy page flip
3404 * @fb: DRM framebuffer
3405 * @event: optional DRM event to signal upon completion
3406 * @flags: flip flags for non-vblank sync'ed updates
3407 * @ctx: lock acquisition context
3409 * Provides a default &drm_crtc_funcs.page_flip implementation
3410 * using the atomic driver interface.
3413 * Returns 0 on success, negative errno numbers on failure.
3416 * drm_atomic_helper_page_flip_target()
3418 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3419 struct drm_framebuffer *fb,
3420 struct drm_pending_vblank_event *event,
3422 struct drm_modeset_acquire_ctx *ctx)
3424 struct drm_plane *plane = crtc->primary;
3425 struct drm_atomic_state *state;
3428 state = drm_atomic_state_alloc(plane->dev);
3432 state->acquire_ctx = ctx;
3434 ret = page_flip_common(state, crtc, fb, event, flags);
3438 ret = drm_atomic_nonblocking_commit(state);
3440 drm_atomic_state_put(state);
3443 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3446 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3448 * @fb: DRM framebuffer
3449 * @event: optional DRM event to signal upon completion
3450 * @flags: flip flags for non-vblank sync'ed updates
3451 * @target: specifying the target vblank period when the flip to take effect
3452 * @ctx: lock acquisition context
3454 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3455 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3456 * target vblank period to flip.
3459 * Returns 0 on success, negative errno numbers on failure.
3461 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3462 struct drm_framebuffer *fb,
3463 struct drm_pending_vblank_event *event,
3466 struct drm_modeset_acquire_ctx *ctx)
3468 struct drm_plane *plane = crtc->primary;
3469 struct drm_atomic_state *state;
3470 struct drm_crtc_state *crtc_state;
3473 state = drm_atomic_state_alloc(plane->dev);
3477 state->acquire_ctx = ctx;
3479 ret = page_flip_common(state, crtc, fb, event, flags);
3483 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3484 if (WARN_ON(!crtc_state)) {
3488 crtc_state->target_vblank = target;
3490 ret = drm_atomic_nonblocking_commit(state);
3492 drm_atomic_state_put(state);
3495 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3498 * drm_atomic_helper_bridge_propagate_bus_fmt() - Propagate output format to
3499 * the input end of a bridge
3500 * @bridge: bridge control structure
3501 * @bridge_state: new bridge state
3502 * @crtc_state: new CRTC state
3503 * @conn_state: new connector state
3504 * @output_fmt: tested output bus format
3505 * @num_input_fmts: will contain the size of the returned array
3507 * This helper is a pluggable implementation of the
3508 * &drm_bridge_funcs.atomic_get_input_bus_fmts operation for bridges that don't
3509 * modify the bus configuration between their input and their output. It
3510 * returns an array of input formats with a single element set to @output_fmt.
3513 * a valid format array of size @num_input_fmts, or NULL if the allocation
3517 drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
3518 struct drm_bridge_state *bridge_state,
3519 struct drm_crtc_state *crtc_state,
3520 struct drm_connector_state *conn_state,
3522 unsigned int *num_input_fmts)
3526 input_fmts = kzalloc(sizeof(*input_fmts), GFP_KERNEL);
3528 *num_input_fmts = 0;
3532 *num_input_fmts = 1;
3533 input_fmts[0] = output_fmt;
3536 EXPORT_SYMBOL(drm_atomic_helper_bridge_propagate_bus_fmt);