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);
434 if (!new_crtc_state->mode_changed &&
435 !new_crtc_state->connectors_changed) {
440 * Each encoder has at most one connector (since we always steal
441 * it away), so we won't call ->mode_fixup twice.
443 encoder = new_conn_state->best_encoder;
444 funcs = encoder->helper_private;
446 bridge = drm_bridge_chain_get_first_bridge(encoder);
447 ret = drm_atomic_bridge_chain_check(bridge,
451 DRM_DEBUG_ATOMIC("Bridge atomic check failed\n");
455 if (funcs && funcs->atomic_check) {
456 ret = funcs->atomic_check(encoder, new_crtc_state,
459 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
460 encoder->base.id, encoder->name);
463 } else if (funcs && funcs->mode_fixup) {
464 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
465 &new_crtc_state->adjusted_mode);
467 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
468 encoder->base.id, encoder->name);
474 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
475 const struct drm_crtc_helper_funcs *funcs;
477 if (!new_crtc_state->enable)
480 if (!new_crtc_state->mode_changed &&
481 !new_crtc_state->connectors_changed)
484 funcs = crtc->helper_private;
485 if (!funcs || !funcs->mode_fixup)
488 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
489 &new_crtc_state->adjusted_mode);
491 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
492 crtc->base.id, crtc->name);
500 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
501 struct drm_encoder *encoder,
502 struct drm_crtc *crtc,
503 const struct drm_display_mode *mode)
505 struct drm_bridge *bridge;
506 enum drm_mode_status ret;
508 ret = drm_encoder_mode_valid(encoder, mode);
509 if (ret != MODE_OK) {
510 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
511 encoder->base.id, encoder->name);
515 bridge = drm_bridge_chain_get_first_bridge(encoder);
516 ret = drm_bridge_chain_mode_valid(bridge, &connector->display_info,
518 if (ret != MODE_OK) {
519 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
523 ret = drm_crtc_mode_valid(crtc, mode);
524 if (ret != MODE_OK) {
525 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
526 crtc->base.id, crtc->name);
534 mode_valid(struct drm_atomic_state *state)
536 struct drm_connector_state *conn_state;
537 struct drm_connector *connector;
540 for_each_new_connector_in_state(state, connector, conn_state, i) {
541 struct drm_encoder *encoder = conn_state->best_encoder;
542 struct drm_crtc *crtc = conn_state->crtc;
543 struct drm_crtc_state *crtc_state;
544 enum drm_mode_status mode_status;
545 const struct drm_display_mode *mode;
547 if (!crtc || !encoder)
550 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
553 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
556 mode = &crtc_state->mode;
558 mode_status = mode_valid_path(connector, encoder, crtc, mode);
559 if (mode_status != MODE_OK)
567 * drm_atomic_helper_check_modeset - validate state object for modeset changes
569 * @state: the driver state object
571 * Check the state object to see if the requested state is physically possible.
572 * This does all the CRTC and connector related computations for an atomic
573 * update and adds any additional connectors needed for full modesets. It calls
574 * the various per-object callbacks in the follow order:
576 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
577 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
578 * 3. If it's determined a modeset is needed then all connectors on the affected
579 * CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them.
580 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
581 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
582 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
583 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
584 * This function is only called when the encoder will be part of a configured CRTC,
585 * it must not be used for implementing connector property validation.
586 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
588 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints.
590 * &drm_crtc_state.mode_changed is set when the input mode is changed.
591 * &drm_crtc_state.connectors_changed is set when a connector is added or
592 * removed from the CRTC. &drm_crtc_state.active_changed is set when
593 * &drm_crtc_state.active changes, which is used for DPMS.
594 * &drm_crtc_state.no_vblank is set from the result of drm_dev_has_vblank().
595 * See also: drm_atomic_crtc_needs_modeset()
599 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
600 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
601 * without a full modeset) _must_ call this function after that change. It is
602 * permitted to call this function multiple times for the same update, e.g.
603 * when the &drm_crtc_helper_funcs.atomic_check functions depend upon the
604 * adjusted dotclock for fifo space allocation and watermark computation.
607 * Zero for success or -errno
610 drm_atomic_helper_check_modeset(struct drm_device *dev,
611 struct drm_atomic_state *state)
613 struct drm_crtc *crtc;
614 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
615 struct drm_connector *connector;
616 struct drm_connector_state *old_connector_state, *new_connector_state;
618 unsigned int connectors_mask = 0;
620 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
621 bool has_connectors =
622 !!new_crtc_state->connector_mask;
624 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
626 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
627 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
628 crtc->base.id, crtc->name);
629 new_crtc_state->mode_changed = true;
632 if (old_crtc_state->enable != new_crtc_state->enable) {
633 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
634 crtc->base.id, crtc->name);
637 * For clarity this assignment is done here, but
638 * enable == 0 is only true when there are no
639 * connectors and a NULL mode.
641 * The other way around is true as well. enable != 0
642 * implies that connectors are attached and a mode is set.
644 new_crtc_state->mode_changed = true;
645 new_crtc_state->connectors_changed = true;
648 if (old_crtc_state->active != new_crtc_state->active) {
649 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
650 crtc->base.id, crtc->name);
651 new_crtc_state->active_changed = true;
654 if (new_crtc_state->enable != has_connectors) {
655 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
656 crtc->base.id, crtc->name);
661 if (drm_dev_has_vblank(dev))
662 new_crtc_state->no_vblank = false;
664 new_crtc_state->no_vblank = true;
667 ret = handle_conflicting_encoders(state, false);
671 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
672 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
674 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
677 * This only sets crtc->connectors_changed for routing changes,
678 * drivers must set crtc->connectors_changed themselves when
679 * connector properties need to be updated.
681 ret = update_connector_routing(state, connector,
683 new_connector_state);
686 if (old_connector_state->crtc) {
687 new_crtc_state = drm_atomic_get_new_crtc_state(state,
688 old_connector_state->crtc);
689 if (old_connector_state->link_status !=
690 new_connector_state->link_status)
691 new_crtc_state->connectors_changed = true;
693 if (old_connector_state->max_requested_bpc !=
694 new_connector_state->max_requested_bpc)
695 new_crtc_state->connectors_changed = true;
698 if (funcs->atomic_check)
699 ret = funcs->atomic_check(connector, state);
703 connectors_mask |= BIT(i);
707 * After all the routing has been prepared we need to add in any
708 * connector which is itself unchanged, but whose CRTC changes its
709 * configuration. This must be done before calling mode_fixup in case a
710 * crtc only changed its mode but has the same set of connectors.
712 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
713 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
716 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
717 crtc->base.id, crtc->name,
718 new_crtc_state->enable ? 'y' : 'n',
719 new_crtc_state->active ? 'y' : 'n');
721 ret = drm_atomic_add_affected_connectors(state, crtc);
725 ret = drm_atomic_add_affected_planes(state, crtc);
731 * Iterate over all connectors again, to make sure atomic_check()
732 * has been called on them when a modeset is forced.
734 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
735 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
737 if (connectors_mask & BIT(i))
740 if (funcs->atomic_check)
741 ret = funcs->atomic_check(connector, state);
747 * Iterate over all connectors again, and add all affected bridges to
750 for_each_oldnew_connector_in_state(state, connector,
752 new_connector_state, i) {
753 struct drm_encoder *encoder;
755 encoder = old_connector_state->best_encoder;
756 ret = drm_atomic_add_encoder_bridges(state, encoder);
760 encoder = new_connector_state->best_encoder;
761 ret = drm_atomic_add_encoder_bridges(state, encoder);
766 ret = mode_valid(state);
770 return mode_fixup(state);
772 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
775 * drm_atomic_helper_check_plane_state() - Check plane state for validity
776 * @plane_state: plane state to check
777 * @crtc_state: CRTC state to check
778 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
779 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
780 * @can_position: is it legal to position the plane such that it
781 * doesn't cover the entire CRTC? This will generally
782 * only be false for primary planes.
783 * @can_update_disabled: can the plane be updated while the CRTC
786 * Checks that a desired plane update is valid, and updates various
787 * bits of derived state (clipped coordinates etc.). Drivers that provide
788 * their own plane handling rather than helper-provided implementations may
789 * still wish to call this function to avoid duplication of error checking
793 * Zero if update appears valid, error code on failure
795 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
796 const struct drm_crtc_state *crtc_state,
800 bool can_update_disabled)
802 struct drm_framebuffer *fb = plane_state->fb;
803 struct drm_rect *src = &plane_state->src;
804 struct drm_rect *dst = &plane_state->dst;
805 unsigned int rotation = plane_state->rotation;
806 struct drm_rect clip = {};
809 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
811 *src = drm_plane_state_src(plane_state);
812 *dst = drm_plane_state_dest(plane_state);
815 plane_state->visible = false;
819 /* crtc should only be NULL when disabling (i.e., !fb) */
820 if (WARN_ON(!plane_state->crtc)) {
821 plane_state->visible = false;
825 if (!crtc_state->enable && !can_update_disabled) {
826 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
830 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
833 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
834 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
835 if (hscale < 0 || vscale < 0) {
836 DRM_DEBUG_KMS("Invalid scaling of plane\n");
837 drm_rect_debug_print("src: ", &plane_state->src, true);
838 drm_rect_debug_print("dst: ", &plane_state->dst, false);
842 if (crtc_state->enable)
843 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
845 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
847 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
849 if (!plane_state->visible)
851 * Plane isn't visible; some drivers can handle this
852 * so we just return success here. Drivers that can't
853 * (including those that use the primary plane helper's
854 * update function) will return an error from their
855 * update_plane handler.
859 if (!can_position && !drm_rect_equals(dst, &clip)) {
860 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
861 drm_rect_debug_print("dst: ", dst, false);
862 drm_rect_debug_print("clip: ", &clip, false);
868 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
871 * drm_atomic_helper_check_planes - validate state object for planes changes
873 * @state: the driver state object
875 * Check the state object to see if the requested state is physically possible.
876 * This does all the plane update related checks using by calling into the
877 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
878 * hooks provided by the driver.
880 * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has
884 * Zero for success or -errno
887 drm_atomic_helper_check_planes(struct drm_device *dev,
888 struct drm_atomic_state *state)
890 struct drm_crtc *crtc;
891 struct drm_crtc_state *new_crtc_state;
892 struct drm_plane *plane;
893 struct drm_plane_state *new_plane_state, *old_plane_state;
896 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
897 const struct drm_plane_helper_funcs *funcs;
899 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
901 funcs = plane->helper_private;
903 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
905 drm_atomic_helper_check_plane_damage(state, new_plane_state);
907 if (!funcs || !funcs->atomic_check)
910 ret = funcs->atomic_check(plane, state);
912 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
913 plane->base.id, plane->name);
918 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
919 const struct drm_crtc_helper_funcs *funcs;
921 funcs = crtc->helper_private;
923 if (!funcs || !funcs->atomic_check)
926 ret = funcs->atomic_check(crtc, state);
928 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
929 crtc->base.id, crtc->name);
936 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
939 * drm_atomic_helper_check - validate state object
941 * @state: the driver state object
943 * Check the state object to see if the requested state is physically possible.
944 * Only CRTCs and planes have check callbacks, so for any additional (global)
945 * checking that a driver needs it can simply wrap that around this function.
946 * Drivers without such needs can directly use this as their
947 * &drm_mode_config_funcs.atomic_check callback.
949 * This just wraps the two parts of the state checking for planes and modeset
950 * state in the default order: First it calls drm_atomic_helper_check_modeset()
951 * and then drm_atomic_helper_check_planes(). The assumption is that the
952 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
953 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
956 * Note that zpos normalization will add all enable planes to the state which
957 * might not desired for some drivers.
958 * For example enable/disable of a cursor plane which have fixed zpos value
959 * would trigger all other enabled planes to be forced to the state change.
962 * Zero for success or -errno
964 int drm_atomic_helper_check(struct drm_device *dev,
965 struct drm_atomic_state *state)
969 ret = drm_atomic_helper_check_modeset(dev, state);
973 if (dev->mode_config.normalize_zpos) {
974 ret = drm_atomic_normalize_zpos(dev, state);
979 ret = drm_atomic_helper_check_planes(dev, state);
983 if (state->legacy_cursor_update)
984 state->async_update = !drm_atomic_helper_async_check(dev, state);
986 drm_self_refresh_helper_alter_state(state);
990 EXPORT_SYMBOL(drm_atomic_helper_check);
993 crtc_needs_disable(struct drm_crtc_state *old_state,
994 struct drm_crtc_state *new_state)
997 * No new_state means the CRTC is off, so the only criteria is whether
998 * it's currently active or in self refresh mode.
1001 return drm_atomic_crtc_effectively_active(old_state);
1004 * We need to disable bridge(s) and CRTC if we're transitioning out of
1005 * self-refresh and changing CRTCs at the same time, because the
1006 * bridge tracks self-refresh status via CRTC state.
1008 if (old_state->self_refresh_active &&
1009 old_state->crtc != new_state->crtc)
1013 * We also need to run through the crtc_funcs->disable() function if
1014 * the CRTC is currently on, if it's transitioning to self refresh
1015 * mode, or if it's in self refresh mode and needs to be fully
1018 return old_state->active ||
1019 (old_state->self_refresh_active && !new_state->active) ||
1020 new_state->self_refresh_active;
1024 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
1026 struct drm_connector *connector;
1027 struct drm_connector_state *old_conn_state, *new_conn_state;
1028 struct drm_crtc *crtc;
1029 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1032 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1033 const struct drm_encoder_helper_funcs *funcs;
1034 struct drm_encoder *encoder;
1035 struct drm_bridge *bridge;
1038 * Shut down everything that's in the changeset and currently
1039 * still on. So need to check the old, saved state.
1041 if (!old_conn_state->crtc)
1044 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
1046 if (new_conn_state->crtc)
1047 new_crtc_state = drm_atomic_get_new_crtc_state(
1049 new_conn_state->crtc);
1051 new_crtc_state = NULL;
1053 if (!crtc_needs_disable(old_crtc_state, new_crtc_state) ||
1054 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
1057 encoder = old_conn_state->best_encoder;
1059 /* We shouldn't get this far if we didn't previously have
1060 * an encoder.. but WARN_ON() rather than explode.
1062 if (WARN_ON(!encoder))
1065 funcs = encoder->helper_private;
1067 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
1068 encoder->base.id, encoder->name);
1071 * Each encoder has at most one connector (since we always steal
1072 * it away), so we won't call disable hooks twice.
1074 bridge = drm_bridge_chain_get_first_bridge(encoder);
1075 drm_atomic_bridge_chain_disable(bridge, old_state);
1077 /* Right function depends upon target state. */
1079 if (funcs->atomic_disable)
1080 funcs->atomic_disable(encoder, old_state);
1081 else if (new_conn_state->crtc && funcs->prepare)
1082 funcs->prepare(encoder);
1083 else if (funcs->disable)
1084 funcs->disable(encoder);
1085 else if (funcs->dpms)
1086 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1089 drm_atomic_bridge_chain_post_disable(bridge, old_state);
1092 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1093 const struct drm_crtc_helper_funcs *funcs;
1096 /* Shut down everything that needs a full modeset. */
1097 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1100 if (!crtc_needs_disable(old_crtc_state, new_crtc_state))
1103 funcs = crtc->helper_private;
1105 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1106 crtc->base.id, crtc->name);
1109 /* Right function depends upon target state. */
1110 if (new_crtc_state->enable && funcs->prepare)
1111 funcs->prepare(crtc);
1112 else if (funcs->atomic_disable)
1113 funcs->atomic_disable(crtc, old_state);
1114 else if (funcs->disable)
1115 funcs->disable(crtc);
1116 else if (funcs->dpms)
1117 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1119 if (!drm_dev_has_vblank(dev))
1122 ret = drm_crtc_vblank_get(crtc);
1123 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1125 drm_crtc_vblank_put(crtc);
1130 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1132 * @old_state: atomic state object with old state structures
1134 * This function updates all the various legacy modeset state pointers in
1135 * connectors, encoders and CRTCs.
1137 * Drivers can use this for building their own atomic commit if they don't have
1138 * a pure helper-based modeset implementation.
1140 * Since these updates are not synchronized with lockings, only code paths
1141 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1142 * legacy state filled out by this helper. Defacto this means this helper and
1143 * the legacy state pointers are only really useful for transitioning an
1144 * existing driver to the atomic world.
1147 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1148 struct drm_atomic_state *old_state)
1150 struct drm_connector *connector;
1151 struct drm_connector_state *old_conn_state, *new_conn_state;
1152 struct drm_crtc *crtc;
1153 struct drm_crtc_state *new_crtc_state;
1156 /* clear out existing links and update dpms */
1157 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1158 if (connector->encoder) {
1159 WARN_ON(!connector->encoder->crtc);
1161 connector->encoder->crtc = NULL;
1162 connector->encoder = NULL;
1165 crtc = new_conn_state->crtc;
1166 if ((!crtc && old_conn_state->crtc) ||
1167 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1168 int mode = DRM_MODE_DPMS_OFF;
1170 if (crtc && crtc->state->active)
1171 mode = DRM_MODE_DPMS_ON;
1173 connector->dpms = mode;
1178 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1179 if (!new_conn_state->crtc)
1182 if (WARN_ON(!new_conn_state->best_encoder))
1185 connector->encoder = new_conn_state->best_encoder;
1186 connector->encoder->crtc = new_conn_state->crtc;
1189 /* set legacy state in the crtc structure */
1190 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1191 struct drm_plane *primary = crtc->primary;
1192 struct drm_plane_state *new_plane_state;
1194 crtc->mode = new_crtc_state->mode;
1195 crtc->enabled = new_crtc_state->enable;
1198 drm_atomic_get_new_plane_state(old_state, primary);
1200 if (new_plane_state && new_plane_state->crtc == crtc) {
1201 crtc->x = new_plane_state->src_x >> 16;
1202 crtc->y = new_plane_state->src_y >> 16;
1206 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1209 * drm_atomic_helper_calc_timestamping_constants - update vblank timestamping constants
1210 * @state: atomic state object
1212 * Updates the timestamping constants used for precise vblank timestamps
1213 * by calling drm_calc_timestamping_constants() for all enabled crtcs in @state.
1215 void drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state)
1217 struct drm_crtc_state *new_crtc_state;
1218 struct drm_crtc *crtc;
1221 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1222 if (new_crtc_state->enable)
1223 drm_calc_timestamping_constants(crtc,
1224 &new_crtc_state->adjusted_mode);
1227 EXPORT_SYMBOL(drm_atomic_helper_calc_timestamping_constants);
1230 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1232 struct drm_crtc *crtc;
1233 struct drm_crtc_state *new_crtc_state;
1234 struct drm_connector *connector;
1235 struct drm_connector_state *new_conn_state;
1238 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1239 const struct drm_crtc_helper_funcs *funcs;
1241 if (!new_crtc_state->mode_changed)
1244 funcs = crtc->helper_private;
1246 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1247 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1248 crtc->base.id, crtc->name);
1250 funcs->mode_set_nofb(crtc);
1254 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1255 const struct drm_encoder_helper_funcs *funcs;
1256 struct drm_encoder *encoder;
1257 struct drm_display_mode *mode, *adjusted_mode;
1258 struct drm_bridge *bridge;
1260 if (!new_conn_state->best_encoder)
1263 encoder = new_conn_state->best_encoder;
1264 funcs = encoder->helper_private;
1265 new_crtc_state = new_conn_state->crtc->state;
1266 mode = &new_crtc_state->mode;
1267 adjusted_mode = &new_crtc_state->adjusted_mode;
1269 if (!new_crtc_state->mode_changed)
1272 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1273 encoder->base.id, encoder->name);
1276 * Each encoder has at most one connector (since we always steal
1277 * it away), so we won't call mode_set hooks twice.
1279 if (funcs && funcs->atomic_mode_set) {
1280 funcs->atomic_mode_set(encoder, new_crtc_state,
1282 } else if (funcs && funcs->mode_set) {
1283 funcs->mode_set(encoder, mode, adjusted_mode);
1286 bridge = drm_bridge_chain_get_first_bridge(encoder);
1287 drm_bridge_chain_mode_set(bridge, mode, adjusted_mode);
1292 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1294 * @old_state: atomic state object with old state structures
1296 * This function shuts down all the outputs that need to be shut down and
1297 * prepares them (if required) with the new mode.
1299 * For compatibility with legacy CRTC helpers this should be called before
1300 * drm_atomic_helper_commit_planes(), which is what the default commit function
1301 * does. But drivers with different needs can group the modeset commits together
1302 * and do the plane commits at the end. This is useful for drivers doing runtime
1303 * PM since planes updates then only happen when the CRTC is actually enabled.
1305 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1306 struct drm_atomic_state *old_state)
1308 disable_outputs(dev, old_state);
1310 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1311 drm_atomic_helper_calc_timestamping_constants(old_state);
1313 crtc_set_mode(dev, old_state);
1315 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1317 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1318 struct drm_atomic_state *old_state)
1320 struct drm_connector *connector;
1321 struct drm_connector_state *new_conn_state;
1324 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1325 const struct drm_connector_helper_funcs *funcs;
1327 funcs = connector->helper_private;
1328 if (!funcs->atomic_commit)
1331 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1332 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1333 funcs->atomic_commit(connector, old_state);
1339 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1341 * @old_state: atomic state object with old state structures
1343 * This function enables all the outputs with the new configuration which had to
1344 * be turned off for the update.
1346 * For compatibility with legacy CRTC helpers this should be called after
1347 * drm_atomic_helper_commit_planes(), which is what the default commit function
1348 * does. But drivers with different needs can group the modeset commits together
1349 * and do the plane commits at the end. This is useful for drivers doing runtime
1350 * PM since planes updates then only happen when the CRTC is actually enabled.
1352 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1353 struct drm_atomic_state *old_state)
1355 struct drm_crtc *crtc;
1356 struct drm_crtc_state *old_crtc_state;
1357 struct drm_crtc_state *new_crtc_state;
1358 struct drm_connector *connector;
1359 struct drm_connector_state *new_conn_state;
1362 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1363 const struct drm_crtc_helper_funcs *funcs;
1365 /* Need to filter out CRTCs where only planes change. */
1366 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1369 if (!new_crtc_state->active)
1372 funcs = crtc->helper_private;
1374 if (new_crtc_state->enable) {
1375 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1376 crtc->base.id, crtc->name);
1377 if (funcs->atomic_enable)
1378 funcs->atomic_enable(crtc, old_state);
1379 else if (funcs->commit)
1380 funcs->commit(crtc);
1384 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1385 const struct drm_encoder_helper_funcs *funcs;
1386 struct drm_encoder *encoder;
1387 struct drm_bridge *bridge;
1389 if (!new_conn_state->best_encoder)
1392 if (!new_conn_state->crtc->state->active ||
1393 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1396 encoder = new_conn_state->best_encoder;
1397 funcs = encoder->helper_private;
1399 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1400 encoder->base.id, encoder->name);
1403 * Each encoder has at most one connector (since we always steal
1404 * it away), so we won't call enable hooks twice.
1406 bridge = drm_bridge_chain_get_first_bridge(encoder);
1407 drm_atomic_bridge_chain_pre_enable(bridge, old_state);
1410 if (funcs->atomic_enable)
1411 funcs->atomic_enable(encoder, old_state);
1412 else if (funcs->enable)
1413 funcs->enable(encoder);
1414 else if (funcs->commit)
1415 funcs->commit(encoder);
1418 drm_atomic_bridge_chain_enable(bridge, old_state);
1421 drm_atomic_helper_commit_writebacks(dev, old_state);
1423 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1426 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1428 * @state: atomic state object with old state structures
1429 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1430 * Otherwise @state is the old state.
1432 * For implicit sync, driver should fish the exclusive fence out from the
1433 * incoming fb's and stash it in the drm_plane_state. This is called after
1434 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1435 * just uses the atomic state to find the changed planes)
1437 * Note that @pre_swap is needed since the point where we block for fences moves
1438 * around depending upon whether an atomic commit is blocking or
1439 * non-blocking. For non-blocking commit all waiting needs to happen after
1440 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1441 * to wait **before** we do anything that can't be easily rolled back. That is
1442 * before we call drm_atomic_helper_swap_state().
1444 * Returns zero if success or < 0 if dma_fence_wait() fails.
1446 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1447 struct drm_atomic_state *state,
1450 struct drm_plane *plane;
1451 struct drm_plane_state *new_plane_state;
1454 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1455 if (!new_plane_state->fence)
1458 WARN_ON(!new_plane_state->fb);
1461 * If waiting for fences pre-swap (ie: nonblock), userspace can
1462 * still interrupt the operation. Instead of blocking until the
1463 * timer expires, make the wait interruptible.
1465 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1469 dma_fence_put(new_plane_state->fence);
1470 new_plane_state->fence = NULL;
1475 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1478 * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs
1480 * @old_state: atomic state object with old state structures
1482 * Helper to, after atomic commit, wait for vblanks on all affected
1483 * CRTCs (ie. before cleaning up old framebuffers using
1484 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1485 * framebuffers have actually changed to optimize for the legacy cursor and
1486 * plane update use-case.
1488 * Drivers using the nonblocking commit tracking support initialized by calling
1489 * drm_atomic_helper_setup_commit() should look at
1490 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1493 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1494 struct drm_atomic_state *old_state)
1496 struct drm_crtc *crtc;
1497 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1499 unsigned int crtc_mask = 0;
1501 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1502 if (!new_crtc_state->active)
1505 ret = drm_crtc_vblank_get(crtc);
1509 crtc_mask |= drm_crtc_mask(crtc);
1510 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1513 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1514 if (!(crtc_mask & drm_crtc_mask(crtc)))
1517 ret = wait_event_timeout(dev->vblank[i].queue,
1518 old_state->crtcs[i].last_vblank_count !=
1519 drm_crtc_vblank_count(crtc),
1520 msecs_to_jiffies(100));
1522 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1523 crtc->base.id, crtc->name);
1525 drm_crtc_vblank_put(crtc);
1528 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1531 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1533 * @old_state: atomic state object with old state structures
1535 * Helper to, after atomic commit, wait for page flips on all affected
1536 * crtcs (ie. before cleaning up old framebuffers using
1537 * drm_atomic_helper_cleanup_planes()). Compared to
1538 * drm_atomic_helper_wait_for_vblanks() this waits for the completion on all
1539 * CRTCs, assuming that cursors-only updates are signalling their completion
1540 * immediately (or using a different path).
1542 * This requires that drivers use the nonblocking commit tracking support
1543 * initialized using drm_atomic_helper_setup_commit().
1545 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1546 struct drm_atomic_state *old_state)
1548 struct drm_crtc *crtc;
1551 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1552 struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1555 crtc = old_state->crtcs[i].ptr;
1557 if (!crtc || !commit)
1560 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1562 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1563 crtc->base.id, crtc->name);
1566 if (old_state->fake_commit)
1567 complete_all(&old_state->fake_commit->flip_done);
1569 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1572 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1573 * @old_state: atomic state object with old state structures
1575 * This is the default implementation for the
1576 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1577 * that do not support runtime_pm or do not need the CRTC to be
1578 * enabled to perform a commit. Otherwise, see
1579 * drm_atomic_helper_commit_tail_rpm().
1581 * Note that the default ordering of how the various stages are called is to
1582 * match the legacy modeset helper library closest.
1584 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1586 struct drm_device *dev = old_state->dev;
1588 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1590 drm_atomic_helper_commit_planes(dev, old_state, 0);
1592 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1594 drm_atomic_helper_fake_vblank(old_state);
1596 drm_atomic_helper_commit_hw_done(old_state);
1598 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1600 drm_atomic_helper_cleanup_planes(dev, old_state);
1602 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1605 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1606 * @old_state: new modeset state to be committed
1608 * This is an alternative implementation for the
1609 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1610 * that support runtime_pm or need the CRTC to be enabled to perform a
1611 * commit. Otherwise, one should use the default implementation
1612 * drm_atomic_helper_commit_tail().
1614 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1616 struct drm_device *dev = old_state->dev;
1618 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1620 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1622 drm_atomic_helper_commit_planes(dev, old_state,
1623 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1625 drm_atomic_helper_fake_vblank(old_state);
1627 drm_atomic_helper_commit_hw_done(old_state);
1629 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1631 drm_atomic_helper_cleanup_planes(dev, old_state);
1633 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1635 static void commit_tail(struct drm_atomic_state *old_state)
1637 struct drm_device *dev = old_state->dev;
1638 const struct drm_mode_config_helper_funcs *funcs;
1639 struct drm_crtc_state *new_crtc_state;
1640 struct drm_crtc *crtc;
1643 unsigned int i, new_self_refresh_mask = 0;
1645 funcs = dev->mode_config.helper_private;
1648 * We're measuring the _entire_ commit, so the time will vary depending
1649 * on how many fences and objects are involved. For the purposes of self
1650 * refresh, this is desirable since it'll give us an idea of how
1651 * congested things are. This will inform our decision on how often we
1652 * should enter self refresh after idle.
1654 * These times will be averaged out in the self refresh helpers to avoid
1655 * overreacting over one outlier frame
1657 start = ktime_get();
1659 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1661 drm_atomic_helper_wait_for_dependencies(old_state);
1664 * We cannot safely access new_crtc_state after
1665 * drm_atomic_helper_commit_hw_done() so figure out which crtc's have
1666 * self-refresh active beforehand:
1668 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i)
1669 if (new_crtc_state->self_refresh_active)
1670 new_self_refresh_mask |= BIT(i);
1672 if (funcs && funcs->atomic_commit_tail)
1673 funcs->atomic_commit_tail(old_state);
1675 drm_atomic_helper_commit_tail(old_state);
1677 commit_time_ms = ktime_ms_delta(ktime_get(), start);
1678 if (commit_time_ms > 0)
1679 drm_self_refresh_helper_update_avg_times(old_state,
1680 (unsigned long)commit_time_ms,
1681 new_self_refresh_mask);
1683 drm_atomic_helper_commit_cleanup_done(old_state);
1685 drm_atomic_state_put(old_state);
1688 static void commit_work(struct work_struct *work)
1690 struct drm_atomic_state *state = container_of(work,
1691 struct drm_atomic_state,
1697 * drm_atomic_helper_async_check - check if state can be committed asynchronously
1699 * @state: the driver state object
1701 * This helper will check if it is possible to commit the state asynchronously.
1702 * Async commits are not supposed to swap the states like normal sync commits
1703 * but just do in-place changes on the current state.
1705 * It will return 0 if the commit can happen in an asynchronous fashion or error
1706 * if not. Note that error just mean it can't be committed asynchronously, if it
1707 * fails the commit should be treated like a normal synchronous commit.
1709 int drm_atomic_helper_async_check(struct drm_device *dev,
1710 struct drm_atomic_state *state)
1712 struct drm_crtc *crtc;
1713 struct drm_crtc_state *crtc_state;
1714 struct drm_plane *plane = NULL;
1715 struct drm_plane_state *old_plane_state = NULL;
1716 struct drm_plane_state *new_plane_state = NULL;
1717 const struct drm_plane_helper_funcs *funcs;
1718 int i, n_planes = 0;
1720 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1721 if (drm_atomic_crtc_needs_modeset(crtc_state))
1725 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1728 /* FIXME: we support only single plane updates for now */
1732 if (!new_plane_state->crtc ||
1733 old_plane_state->crtc != new_plane_state->crtc)
1736 funcs = plane->helper_private;
1737 if (!funcs->atomic_async_update)
1740 if (new_plane_state->fence)
1744 * Don't do an async update if there is an outstanding commit modifying
1745 * the plane. This prevents our async update's changes from getting
1746 * overridden by a previous synchronous update's state.
1748 if (old_plane_state->commit &&
1749 !try_wait_for_completion(&old_plane_state->commit->hw_done)) {
1750 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] inflight previous commit preventing async commit\n",
1751 plane->base.id, plane->name);
1755 return funcs->atomic_async_check(plane, state);
1757 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1760 * drm_atomic_helper_async_commit - commit state asynchronously
1762 * @state: the driver state object
1764 * This function commits a state asynchronously, i.e., not vblank
1765 * synchronized. It should be used on a state only when
1766 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1767 * the states like normal sync commits, but just do in-place changes on the
1770 * TODO: Implement full swap instead of doing in-place changes.
1772 void drm_atomic_helper_async_commit(struct drm_device *dev,
1773 struct drm_atomic_state *state)
1775 struct drm_plane *plane;
1776 struct drm_plane_state *plane_state;
1777 const struct drm_plane_helper_funcs *funcs;
1780 for_each_new_plane_in_state(state, plane, plane_state, i) {
1781 struct drm_framebuffer *new_fb = plane_state->fb;
1782 struct drm_framebuffer *old_fb = plane->state->fb;
1784 funcs = plane->helper_private;
1785 funcs->atomic_async_update(plane, state);
1788 * ->atomic_async_update() is supposed to update the
1789 * plane->state in-place, make sure at least common
1790 * properties have been properly updated.
1792 WARN_ON_ONCE(plane->state->fb != new_fb);
1793 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1794 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1795 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1796 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1799 * Make sure the FBs have been swapped so that cleanups in the
1800 * new_state performs a cleanup in the old FB.
1802 WARN_ON_ONCE(plane_state->fb != old_fb);
1805 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1808 * drm_atomic_helper_commit - commit validated state object
1810 * @state: the driver state object
1811 * @nonblock: whether nonblocking behavior is requested.
1813 * This function commits a with drm_atomic_helper_check() pre-validated state
1814 * object. This can still fail when e.g. the framebuffer reservation fails. This
1815 * function implements nonblocking commits, using
1816 * drm_atomic_helper_setup_commit() and related functions.
1818 * Committing the actual hardware state is done through the
1819 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1820 * implementation drm_atomic_helper_commit_tail().
1823 * Zero for success or -errno.
1825 int drm_atomic_helper_commit(struct drm_device *dev,
1826 struct drm_atomic_state *state,
1831 if (state->async_update) {
1832 ret = drm_atomic_helper_prepare_planes(dev, state);
1836 drm_atomic_helper_async_commit(dev, state);
1837 drm_atomic_helper_cleanup_planes(dev, state);
1842 ret = drm_atomic_helper_setup_commit(state, nonblock);
1846 INIT_WORK(&state->commit_work, commit_work);
1848 ret = drm_atomic_helper_prepare_planes(dev, state);
1853 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1859 * This is the point of no return - everything below never fails except
1860 * when the hw goes bonghits. Which means we can commit the new state on
1861 * the software side now.
1864 ret = drm_atomic_helper_swap_state(state, true);
1869 * Everything below can be run asynchronously without the need to grab
1870 * any modeset locks at all under one condition: It must be guaranteed
1871 * that the asynchronous work has either been cancelled (if the driver
1872 * supports it, which at least requires that the framebuffers get
1873 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1874 * before the new state gets committed on the software side with
1875 * drm_atomic_helper_swap_state().
1877 * This scheme allows new atomic state updates to be prepared and
1878 * checked in parallel to the asynchronous completion of the previous
1879 * update. Which is important since compositors need to figure out the
1880 * composition of the next frame right after having submitted the
1883 * NOTE: Commit work has multiple phases, first hardware commit, then
1884 * cleanup. We want them to overlap, hence need system_unbound_wq to
1885 * make sure work items don't artificially stall on each another.
1888 drm_atomic_state_get(state);
1890 queue_work(system_unbound_wq, &state->commit_work);
1897 drm_atomic_helper_cleanup_planes(dev, state);
1900 EXPORT_SYMBOL(drm_atomic_helper_commit);
1903 * DOC: implementing nonblocking commit
1905 * Nonblocking atomic commits should use struct &drm_crtc_commit to sequence
1906 * different operations against each another. Locks, especially struct
1907 * &drm_modeset_lock, should not be held in worker threads or any other
1908 * asynchronous context used to commit the hardware state.
1910 * drm_atomic_helper_commit() implements the recommended sequence for
1911 * nonblocking commits, using drm_atomic_helper_setup_commit() internally:
1913 * 1. Run drm_atomic_helper_prepare_planes(). Since this can fail and we
1914 * need to propagate out of memory/VRAM errors to userspace, it must be called
1917 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1918 * might be affected by the new state update. This is handled by
1919 * drm_atomic_helper_setup_commit().
1921 * Asynchronous workers need to have sufficient parallelism to be able to run
1922 * different atomic commits on different CRTCs in parallel. The simplest way to
1923 * achieve this is by running them on the &system_unbound_wq work queue. Note
1924 * that drivers are not required to split up atomic commits and run an
1925 * individual commit in parallel - userspace is supposed to do that if it cares.
1926 * But it might be beneficial to do that for modesets, since those necessarily
1927 * must be done as one global operation, and enabling or disabling a CRTC can
1928 * take a long time. But even that is not required.
1930 * IMPORTANT: A &drm_atomic_state update for multiple CRTCs is sequenced
1931 * against all CRTCs therein. Therefore for atomic state updates which only flip
1932 * planes the driver must not get the struct &drm_crtc_state of unrelated CRTCs
1933 * in its atomic check code: This would prevent committing of atomic updates to
1934 * multiple CRTCs in parallel. In general, adding additional state structures
1935 * should be avoided as much as possible, because this reduces parallelism in
1936 * (nonblocking) commits, both due to locking and due to commit sequencing
1939 * 3. The software state is updated synchronously with
1940 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1941 * locks means concurrent callers never see inconsistent state. Note that commit
1942 * workers do not hold any locks; their access is only coordinated through
1943 * ordering. If workers would access state only through the pointers in the
1944 * free-standing state objects (currently not the case for any driver) then even
1945 * multiple pending commits could be in-flight at the same time.
1947 * 4. Schedule a work item to do all subsequent steps, using the split-out
1948 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1949 * then cleaning up the framebuffers after the old framebuffer is no longer
1950 * being displayed. The scheduled work should synchronize against other workers
1951 * using the &drm_crtc_commit infrastructure as needed. See
1952 * drm_atomic_helper_setup_commit() for more details.
1955 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1957 struct drm_crtc_commit *commit, *stall_commit = NULL;
1958 bool completed = true;
1962 spin_lock(&crtc->commit_lock);
1964 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1966 completed = try_wait_for_completion(&commit->flip_done);
1968 * Userspace is not allowed to get ahead of the previous
1969 * commit with nonblocking ones.
1971 if (!completed && nonblock) {
1972 spin_unlock(&crtc->commit_lock);
1973 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] busy with a previous commit\n",
1974 crtc->base.id, crtc->name);
1978 } else if (i == 1) {
1979 stall_commit = drm_crtc_commit_get(commit);
1985 spin_unlock(&crtc->commit_lock);
1990 /* We don't want to let commits get ahead of cleanup work too much,
1991 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1993 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1996 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1997 crtc->base.id, crtc->name);
1999 drm_crtc_commit_put(stall_commit);
2001 return ret < 0 ? ret : 0;
2004 static void release_crtc_commit(struct completion *completion)
2006 struct drm_crtc_commit *commit = container_of(completion,
2010 drm_crtc_commit_put(commit);
2013 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
2015 init_completion(&commit->flip_done);
2016 init_completion(&commit->hw_done);
2017 init_completion(&commit->cleanup_done);
2018 INIT_LIST_HEAD(&commit->commit_entry);
2019 kref_init(&commit->ref);
2020 commit->crtc = crtc;
2023 static struct drm_crtc_commit *
2024 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
2027 struct drm_crtc_state *new_crtc_state;
2029 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2031 return new_crtc_state->commit;
2034 if (!state->fake_commit) {
2035 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
2036 if (!state->fake_commit)
2039 init_commit(state->fake_commit, NULL);
2042 return state->fake_commit;
2046 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
2047 * @state: new modeset state to be committed
2048 * @nonblock: whether nonblocking behavior is requested.
2050 * This function prepares @state to be used by the atomic helper's support for
2051 * nonblocking commits. Drivers using the nonblocking commit infrastructure
2052 * should always call this function from their
2053 * &drm_mode_config_funcs.atomic_commit hook.
2055 * Drivers that need to extend the commit setup to private objects can use the
2056 * &drm_mode_config_helper_funcs.atomic_commit_setup hook.
2058 * To be able to use this support drivers need to use a few more helper
2059 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
2060 * actually committing the hardware state, and for nonblocking commits this call
2061 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
2062 * and its stall parameter, for when a driver's commit hooks look at the
2063 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
2065 * Completion of the hardware commit step must be signalled using
2066 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
2067 * to read or change any permanent software or hardware modeset state. The only
2068 * exception is state protected by other means than &drm_modeset_lock locks.
2069 * Only the free standing @state with pointers to the old state structures can
2070 * be inspected, e.g. to clean up old buffers using
2071 * drm_atomic_helper_cleanup_planes().
2073 * At the very end, before cleaning up @state drivers must call
2074 * drm_atomic_helper_commit_cleanup_done().
2076 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
2077 * complete and easy-to-use default implementation of the atomic_commit() hook.
2079 * The tracking of asynchronously executed and still pending commits is done
2080 * using the core structure &drm_crtc_commit.
2082 * By default there's no need to clean up resources allocated by this function
2083 * explicitly: drm_atomic_state_default_clear() will take care of that
2088 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
2089 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
2091 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
2094 struct drm_crtc *crtc;
2095 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2096 struct drm_connector *conn;
2097 struct drm_connector_state *old_conn_state, *new_conn_state;
2098 struct drm_plane *plane;
2099 struct drm_plane_state *old_plane_state, *new_plane_state;
2100 struct drm_crtc_commit *commit;
2101 const struct drm_mode_config_helper_funcs *funcs;
2104 funcs = state->dev->mode_config.helper_private;
2106 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2107 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
2111 init_commit(commit, crtc);
2113 new_crtc_state->commit = commit;
2115 ret = stall_checks(crtc, nonblock);
2120 * Drivers only send out events when at least either current or
2121 * new CRTC state is active. Complete right away if everything
2124 if (!old_crtc_state->active && !new_crtc_state->active) {
2125 complete_all(&commit->flip_done);
2129 if (!new_crtc_state->event) {
2130 commit->event = kzalloc(sizeof(*commit->event),
2135 new_crtc_state->event = commit->event;
2138 new_crtc_state->event->base.completion = &commit->flip_done;
2139 new_crtc_state->event->base.completion_release = release_crtc_commit;
2140 drm_crtc_commit_get(commit);
2142 commit->abort_completion = true;
2144 state->crtcs[i].commit = commit;
2145 drm_crtc_commit_get(commit);
2148 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2150 * Userspace is not allowed to get ahead of the previous
2151 * commit with nonblocking ones.
2153 if (nonblock && old_conn_state->commit &&
2154 !try_wait_for_completion(&old_conn_state->commit->flip_done)) {
2155 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] busy with a previous commit\n",
2156 conn->base.id, conn->name);
2161 /* Always track connectors explicitly for e.g. link retraining. */
2162 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2166 new_conn_state->commit = drm_crtc_commit_get(commit);
2169 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2171 * Userspace is not allowed to get ahead of the previous
2172 * commit with nonblocking ones.
2174 if (nonblock && old_plane_state->commit &&
2175 !try_wait_for_completion(&old_plane_state->commit->flip_done)) {
2176 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] busy with a previous commit\n",
2177 plane->base.id, plane->name);
2182 /* Always track planes explicitly for async pageflip support. */
2183 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2187 new_plane_state->commit = drm_crtc_commit_get(commit);
2190 if (funcs && funcs->atomic_commit_setup)
2191 return funcs->atomic_commit_setup(state);
2195 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2198 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2199 * @old_state: atomic state object with old state structures
2201 * This function waits for all preceeding commits that touch the same CRTC as
2202 * @old_state to both be committed to the hardware (as signalled by
2203 * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
2204 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2206 * This is part of the atomic helper support for nonblocking commits, see
2207 * drm_atomic_helper_setup_commit() for an overview.
2209 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2211 struct drm_crtc *crtc;
2212 struct drm_crtc_state *old_crtc_state;
2213 struct drm_plane *plane;
2214 struct drm_plane_state *old_plane_state;
2215 struct drm_connector *conn;
2216 struct drm_connector_state *old_conn_state;
2220 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2221 ret = drm_crtc_commit_wait(old_crtc_state->commit);
2223 DRM_ERROR("[CRTC:%d:%s] commit wait timed out\n",
2224 crtc->base.id, crtc->name);
2227 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2228 ret = drm_crtc_commit_wait(old_conn_state->commit);
2230 DRM_ERROR("[CONNECTOR:%d:%s] commit wait timed out\n",
2231 conn->base.id, conn->name);
2234 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2235 ret = drm_crtc_commit_wait(old_plane_state->commit);
2237 DRM_ERROR("[PLANE:%d:%s] commit wait timed out\n",
2238 plane->base.id, plane->name);
2241 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2244 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2245 * @old_state: atomic state object with old state structures
2247 * This function walks all CRTCs and fakes VBLANK events on those with
2248 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2249 * The primary use of this function is writeback connectors working in oneshot
2250 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2251 * when a job is queued, and any change to the pipeline that does not touch the
2252 * connector is leading to timeouts when calling
2253 * drm_atomic_helper_wait_for_vblanks() or
2254 * drm_atomic_helper_wait_for_flip_done(). In addition to writeback
2255 * connectors, this function can also fake VBLANK events for CRTCs without
2258 * This is part of the atomic helper support for nonblocking commits, see
2259 * drm_atomic_helper_setup_commit() for an overview.
2261 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2263 struct drm_crtc_state *new_crtc_state;
2264 struct drm_crtc *crtc;
2267 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2268 unsigned long flags;
2270 if (!new_crtc_state->no_vblank)
2273 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2274 if (new_crtc_state->event) {
2275 drm_crtc_send_vblank_event(crtc,
2276 new_crtc_state->event);
2277 new_crtc_state->event = NULL;
2279 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2282 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2285 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2286 * @old_state: atomic state object with old state structures
2288 * This function is used to signal completion of the hardware commit step. After
2289 * this step the driver is not allowed to read or change any permanent software
2290 * or hardware modeset state. The only exception is state protected by other
2291 * means than &drm_modeset_lock locks.
2293 * Drivers should try to postpone any expensive or delayed cleanup work after
2294 * this function is called.
2296 * This is part of the atomic helper support for nonblocking commits, see
2297 * drm_atomic_helper_setup_commit() for an overview.
2299 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2301 struct drm_crtc *crtc;
2302 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2303 struct drm_crtc_commit *commit;
2306 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2307 commit = new_crtc_state->commit;
2312 * copy new_crtc_state->commit to old_crtc_state->commit,
2313 * it's unsafe to touch new_crtc_state after hw_done,
2314 * but we still need to do so in cleanup_done().
2316 if (old_crtc_state->commit)
2317 drm_crtc_commit_put(old_crtc_state->commit);
2319 old_crtc_state->commit = drm_crtc_commit_get(commit);
2321 /* backend must have consumed any event by now */
2322 WARN_ON(new_crtc_state->event);
2323 complete_all(&commit->hw_done);
2326 if (old_state->fake_commit) {
2327 complete_all(&old_state->fake_commit->hw_done);
2328 complete_all(&old_state->fake_commit->flip_done);
2331 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2334 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2335 * @old_state: atomic state object with old state structures
2337 * This signals completion of the atomic update @old_state, including any
2338 * cleanup work. If used, it must be called right before calling
2339 * drm_atomic_state_put().
2341 * This is part of the atomic helper support for nonblocking commits, see
2342 * drm_atomic_helper_setup_commit() for an overview.
2344 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2346 struct drm_crtc *crtc;
2347 struct drm_crtc_state *old_crtc_state;
2348 struct drm_crtc_commit *commit;
2351 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2352 commit = old_crtc_state->commit;
2353 if (WARN_ON(!commit))
2356 complete_all(&commit->cleanup_done);
2357 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2359 spin_lock(&crtc->commit_lock);
2360 list_del(&commit->commit_entry);
2361 spin_unlock(&crtc->commit_lock);
2364 if (old_state->fake_commit) {
2365 complete_all(&old_state->fake_commit->cleanup_done);
2366 WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2369 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2372 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2374 * @state: atomic state object with new state structures
2376 * This function prepares plane state, specifically framebuffers, for the new
2377 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2378 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2379 * any already successfully prepared framebuffer.
2382 * 0 on success, negative error code on failure.
2384 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2385 struct drm_atomic_state *state)
2387 struct drm_connector *connector;
2388 struct drm_connector_state *new_conn_state;
2389 struct drm_plane *plane;
2390 struct drm_plane_state *new_plane_state;
2393 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2394 if (!new_conn_state->writeback_job)
2397 ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2402 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2403 const struct drm_plane_helper_funcs *funcs;
2405 funcs = plane->helper_private;
2407 if (funcs->prepare_fb) {
2408 ret = funcs->prepare_fb(plane, new_plane_state);
2412 WARN_ON_ONCE(funcs->cleanup_fb);
2414 if (!drm_core_check_feature(dev, DRIVER_GEM))
2417 ret = drm_gem_plane_helper_prepare_fb(plane, new_plane_state);
2426 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2427 const struct drm_plane_helper_funcs *funcs;
2432 funcs = plane->helper_private;
2434 if (funcs->cleanup_fb)
2435 funcs->cleanup_fb(plane, new_plane_state);
2440 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2442 static bool plane_crtc_active(const struct drm_plane_state *state)
2444 return state->crtc && state->crtc->state->active;
2448 * drm_atomic_helper_commit_planes - commit plane state
2450 * @old_state: atomic state object with old state structures
2451 * @flags: flags for committing plane state
2453 * This function commits the new plane state using the plane and atomic helper
2454 * functions for planes and CRTCs. It assumes that the atomic state has already
2455 * been pushed into the relevant object state pointers, since this step can no
2458 * It still requires the global state object @old_state to know which planes and
2459 * crtcs need to be updated though.
2461 * Note that this function does all plane updates across all CRTCs in one step.
2462 * If the hardware can't support this approach look at
2463 * drm_atomic_helper_commit_planes_on_crtc() instead.
2465 * Plane parameters can be updated by applications while the associated CRTC is
2466 * disabled. The DRM/KMS core will store the parameters in the plane state,
2467 * which will be available to the driver when the CRTC is turned on. As a result
2468 * most drivers don't need to be immediately notified of plane updates for a
2471 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2472 * @flags in order not to receive plane update notifications related to a
2473 * disabled CRTC. This avoids the need to manually ignore plane updates in
2474 * driver code when the driver and/or hardware can't or just don't need to deal
2475 * with updates on disabled CRTCs, for example when supporting runtime PM.
2477 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2478 * display controllers require to disable a CRTC's planes when the CRTC is
2479 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2480 * call for a plane if the CRTC of the old plane state needs a modesetting
2481 * operation. Of course, the drivers need to disable the planes in their CRTC
2482 * disable callbacks since no one else would do that.
2484 * The drm_atomic_helper_commit() default implementation doesn't set the
2485 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2486 * This should not be copied blindly by drivers.
2488 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2489 struct drm_atomic_state *old_state,
2492 struct drm_crtc *crtc;
2493 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2494 struct drm_plane *plane;
2495 struct drm_plane_state *old_plane_state, *new_plane_state;
2497 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2498 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2500 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2501 const struct drm_crtc_helper_funcs *funcs;
2503 funcs = crtc->helper_private;
2505 if (!funcs || !funcs->atomic_begin)
2508 if (active_only && !new_crtc_state->active)
2511 funcs->atomic_begin(crtc, old_state);
2514 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2515 const struct drm_plane_helper_funcs *funcs;
2518 funcs = plane->helper_private;
2523 disabling = drm_atomic_plane_disabling(old_plane_state,
2528 * Skip planes related to inactive CRTCs. If the plane
2529 * is enabled use the state of the current CRTC. If the
2530 * plane is being disabled use the state of the old
2531 * CRTC to avoid skipping planes being disabled on an
2534 if (!disabling && !plane_crtc_active(new_plane_state))
2536 if (disabling && !plane_crtc_active(old_plane_state))
2541 * Special-case disabling the plane if drivers support it.
2543 if (disabling && funcs->atomic_disable) {
2544 struct drm_crtc_state *crtc_state;
2546 crtc_state = old_plane_state->crtc->state;
2548 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2552 funcs->atomic_disable(plane, old_state);
2553 } else if (new_plane_state->crtc || disabling) {
2554 funcs->atomic_update(plane, old_state);
2558 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2559 const struct drm_crtc_helper_funcs *funcs;
2561 funcs = crtc->helper_private;
2563 if (!funcs || !funcs->atomic_flush)
2566 if (active_only && !new_crtc_state->active)
2569 funcs->atomic_flush(crtc, old_state);
2572 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2575 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC
2576 * @old_crtc_state: atomic state object with the old CRTC state
2578 * This function commits the new plane state using the plane and atomic helper
2579 * functions for planes on the specific CRTC. It assumes that the atomic state
2580 * has already been pushed into the relevant object state pointers, since this
2581 * step can no longer fail.
2583 * This function is useful when plane updates should be done CRTC-by-CRTC
2584 * instead of one global step like drm_atomic_helper_commit_planes() does.
2586 * This function can only be savely used when planes are not allowed to move
2587 * between different CRTCs because this function doesn't handle inter-CRTC
2588 * dependencies. Callers need to ensure that either no such dependencies exist,
2589 * resolve them through ordering of commit calls or through some other means.
2592 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2594 const struct drm_crtc_helper_funcs *crtc_funcs;
2595 struct drm_crtc *crtc = old_crtc_state->crtc;
2596 struct drm_atomic_state *old_state = old_crtc_state->state;
2597 struct drm_crtc_state *new_crtc_state =
2598 drm_atomic_get_new_crtc_state(old_state, crtc);
2599 struct drm_plane *plane;
2600 unsigned int plane_mask;
2602 plane_mask = old_crtc_state->plane_mask;
2603 plane_mask |= new_crtc_state->plane_mask;
2605 crtc_funcs = crtc->helper_private;
2606 if (crtc_funcs && crtc_funcs->atomic_begin)
2607 crtc_funcs->atomic_begin(crtc, old_state);
2609 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2610 struct drm_plane_state *old_plane_state =
2611 drm_atomic_get_old_plane_state(old_state, plane);
2612 struct drm_plane_state *new_plane_state =
2613 drm_atomic_get_new_plane_state(old_state, plane);
2614 const struct drm_plane_helper_funcs *plane_funcs;
2616 plane_funcs = plane->helper_private;
2618 if (!old_plane_state || !plane_funcs)
2621 WARN_ON(new_plane_state->crtc &&
2622 new_plane_state->crtc != crtc);
2624 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2625 plane_funcs->atomic_disable)
2626 plane_funcs->atomic_disable(plane, old_state);
2627 else if (new_plane_state->crtc ||
2628 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2629 plane_funcs->atomic_update(plane, old_state);
2632 if (crtc_funcs && crtc_funcs->atomic_flush)
2633 crtc_funcs->atomic_flush(crtc, old_state);
2635 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2638 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2639 * @old_crtc_state: atomic state object with the old CRTC state
2640 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2642 * Disables all planes associated with the given CRTC. This can be
2643 * used for instance in the CRTC helper atomic_disable callback to disable
2646 * If the atomic-parameter is set the function calls the CRTC's
2647 * atomic_begin hook before and atomic_flush hook after disabling the
2650 * It is a bug to call this function without having implemented the
2651 * &drm_plane_helper_funcs.atomic_disable plane hook.
2654 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2657 struct drm_crtc *crtc = old_crtc_state->crtc;
2658 const struct drm_crtc_helper_funcs *crtc_funcs =
2659 crtc->helper_private;
2660 struct drm_plane *plane;
2662 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2663 crtc_funcs->atomic_begin(crtc, NULL);
2665 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2666 const struct drm_plane_helper_funcs *plane_funcs =
2667 plane->helper_private;
2672 WARN_ON(!plane_funcs->atomic_disable);
2673 if (plane_funcs->atomic_disable)
2674 plane_funcs->atomic_disable(plane, NULL);
2677 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2678 crtc_funcs->atomic_flush(crtc, NULL);
2680 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2683 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2685 * @old_state: atomic state object with old state structures
2687 * This function cleans up plane state, specifically framebuffers, from the old
2688 * configuration. Hence the old configuration must be perserved in @old_state to
2689 * be able to call this function.
2691 * This function must also be called on the new state when the atomic update
2692 * fails at any point after calling drm_atomic_helper_prepare_planes().
2694 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2695 struct drm_atomic_state *old_state)
2697 struct drm_plane *plane;
2698 struct drm_plane_state *old_plane_state, *new_plane_state;
2701 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2702 const struct drm_plane_helper_funcs *funcs;
2703 struct drm_plane_state *plane_state;
2706 * This might be called before swapping when commit is aborted,
2707 * in which case we have to cleanup the new state.
2709 if (old_plane_state == plane->state)
2710 plane_state = new_plane_state;
2712 plane_state = old_plane_state;
2714 funcs = plane->helper_private;
2716 if (funcs->cleanup_fb)
2717 funcs->cleanup_fb(plane, plane_state);
2720 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2723 * drm_atomic_helper_swap_state - store atomic state into current sw state
2724 * @state: atomic state
2725 * @stall: stall for preceding commits
2727 * This function stores the atomic state into the current state pointers in all
2728 * driver objects. It should be called after all failing steps have been done
2729 * and succeeded, but before the actual hardware state is committed.
2731 * For cleanup and error recovery the current state for all changed objects will
2732 * be swapped into @state.
2734 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2736 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2738 * 2. Do any other steps that might fail.
2740 * 3. Put the staged state into the current state pointers with this function.
2742 * 4. Actually commit the hardware state.
2744 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2745 * contains the old state. Also do any other cleanup required with that state.
2747 * @stall must be set when nonblocking commits for this driver directly access
2748 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2749 * the current atomic helpers this is almost always the case, since the helpers
2750 * don't pass the right state structures to the callbacks.
2754 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2755 * waiting for the previous commits has been interrupted.
2757 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2761 struct drm_connector *connector;
2762 struct drm_connector_state *old_conn_state, *new_conn_state;
2763 struct drm_crtc *crtc;
2764 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2765 struct drm_plane *plane;
2766 struct drm_plane_state *old_plane_state, *new_plane_state;
2767 struct drm_crtc_commit *commit;
2768 struct drm_private_obj *obj;
2769 struct drm_private_state *old_obj_state, *new_obj_state;
2773 * We have to stall for hw_done here before
2774 * drm_atomic_helper_wait_for_dependencies() because flip
2775 * depth > 1 is not yet supported by all drivers. As long as
2776 * obj->state is directly dereferenced anywhere in the drivers
2777 * atomic_commit_tail function, then it's unsafe to swap state
2778 * before drm_atomic_helper_commit_hw_done() is called.
2781 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2782 commit = old_crtc_state->commit;
2787 ret = wait_for_completion_interruptible(&commit->hw_done);
2792 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2793 commit = old_conn_state->commit;
2798 ret = wait_for_completion_interruptible(&commit->hw_done);
2803 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2804 commit = old_plane_state->commit;
2809 ret = wait_for_completion_interruptible(&commit->hw_done);
2815 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2816 WARN_ON(connector->state != old_conn_state);
2818 old_conn_state->state = state;
2819 new_conn_state->state = NULL;
2821 state->connectors[i].state = old_conn_state;
2822 connector->state = new_conn_state;
2825 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2826 WARN_ON(crtc->state != old_crtc_state);
2828 old_crtc_state->state = state;
2829 new_crtc_state->state = NULL;
2831 state->crtcs[i].state = old_crtc_state;
2832 crtc->state = new_crtc_state;
2834 if (new_crtc_state->commit) {
2835 spin_lock(&crtc->commit_lock);
2836 list_add(&new_crtc_state->commit->commit_entry,
2837 &crtc->commit_list);
2838 spin_unlock(&crtc->commit_lock);
2840 new_crtc_state->commit->event = NULL;
2844 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2845 WARN_ON(plane->state != old_plane_state);
2847 old_plane_state->state = state;
2848 new_plane_state->state = NULL;
2850 state->planes[i].state = old_plane_state;
2851 plane->state = new_plane_state;
2854 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2855 WARN_ON(obj->state != old_obj_state);
2857 old_obj_state->state = state;
2858 new_obj_state->state = NULL;
2860 state->private_objs[i].state = old_obj_state;
2861 obj->state = new_obj_state;
2866 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2869 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2870 * @plane: plane object to update
2871 * @crtc: owning CRTC of owning plane
2872 * @fb: framebuffer to flip onto plane
2873 * @crtc_x: x offset of primary plane on @crtc
2874 * @crtc_y: y offset of primary plane on @crtc
2875 * @crtc_w: width of primary plane rectangle on @crtc
2876 * @crtc_h: height of primary plane rectangle on @crtc
2877 * @src_x: x offset of @fb for panning
2878 * @src_y: y offset of @fb for panning
2879 * @src_w: width of source rectangle in @fb
2880 * @src_h: height of source rectangle in @fb
2881 * @ctx: lock acquire context
2883 * Provides a default plane update handler using the atomic driver interface.
2886 * Zero on success, error code on failure
2888 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2889 struct drm_crtc *crtc,
2890 struct drm_framebuffer *fb,
2891 int crtc_x, int crtc_y,
2892 unsigned int crtc_w, unsigned int crtc_h,
2893 uint32_t src_x, uint32_t src_y,
2894 uint32_t src_w, uint32_t src_h,
2895 struct drm_modeset_acquire_ctx *ctx)
2897 struct drm_atomic_state *state;
2898 struct drm_plane_state *plane_state;
2901 state = drm_atomic_state_alloc(plane->dev);
2905 state->acquire_ctx = ctx;
2906 plane_state = drm_atomic_get_plane_state(state, plane);
2907 if (IS_ERR(plane_state)) {
2908 ret = PTR_ERR(plane_state);
2912 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2915 drm_atomic_set_fb_for_plane(plane_state, fb);
2916 plane_state->crtc_x = crtc_x;
2917 plane_state->crtc_y = crtc_y;
2918 plane_state->crtc_w = crtc_w;
2919 plane_state->crtc_h = crtc_h;
2920 plane_state->src_x = src_x;
2921 plane_state->src_y = src_y;
2922 plane_state->src_w = src_w;
2923 plane_state->src_h = src_h;
2925 if (plane == crtc->cursor)
2926 state->legacy_cursor_update = true;
2928 ret = drm_atomic_commit(state);
2930 drm_atomic_state_put(state);
2933 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2936 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2937 * @plane: plane to disable
2938 * @ctx: lock acquire context
2940 * Provides a default plane disable handler using the atomic driver interface.
2943 * Zero on success, error code on failure
2945 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2946 struct drm_modeset_acquire_ctx *ctx)
2948 struct drm_atomic_state *state;
2949 struct drm_plane_state *plane_state;
2952 state = drm_atomic_state_alloc(plane->dev);
2956 state->acquire_ctx = ctx;
2957 plane_state = drm_atomic_get_plane_state(state, plane);
2958 if (IS_ERR(plane_state)) {
2959 ret = PTR_ERR(plane_state);
2963 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2964 plane_state->state->legacy_cursor_update = true;
2966 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2970 ret = drm_atomic_commit(state);
2972 drm_atomic_state_put(state);
2975 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2978 * drm_atomic_helper_set_config - set a new config from userspace
2979 * @set: mode set configuration
2980 * @ctx: lock acquisition context
2982 * Provides a default CRTC set_config handler using the atomic driver interface.
2984 * NOTE: For backwards compatibility with old userspace this automatically
2985 * resets the "link-status" property to GOOD, to force any link
2986 * re-training. The SETCRTC ioctl does not define whether an update does
2987 * need a full modeset or just a plane update, hence we're allowed to do
2988 * that. See also drm_connector_set_link_status_property().
2991 * Returns 0 on success, negative errno numbers on failure.
2993 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2994 struct drm_modeset_acquire_ctx *ctx)
2996 struct drm_atomic_state *state;
2997 struct drm_crtc *crtc = set->crtc;
3000 state = drm_atomic_state_alloc(crtc->dev);
3004 state->acquire_ctx = ctx;
3005 ret = __drm_atomic_helper_set_config(set, state);
3009 ret = handle_conflicting_encoders(state, true);
3013 ret = drm_atomic_commit(state);
3016 drm_atomic_state_put(state);
3019 EXPORT_SYMBOL(drm_atomic_helper_set_config);
3022 * drm_atomic_helper_disable_all - disable all currently active outputs
3024 * @ctx: lock acquisition context
3026 * Loops through all connectors, finding those that aren't turned off and then
3027 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3028 * that they are connected to.
3030 * This is used for example in suspend/resume to disable all currently active
3031 * functions when suspending. If you just want to shut down everything at e.g.
3032 * driver unload, look at drm_atomic_helper_shutdown().
3034 * Note that if callers haven't already acquired all modeset locks this might
3035 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3038 * 0 on success or a negative error code on failure.
3041 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3042 * drm_atomic_helper_shutdown().
3044 int drm_atomic_helper_disable_all(struct drm_device *dev,
3045 struct drm_modeset_acquire_ctx *ctx)
3047 struct drm_atomic_state *state;
3048 struct drm_connector_state *conn_state;
3049 struct drm_connector *conn;
3050 struct drm_plane_state *plane_state;
3051 struct drm_plane *plane;
3052 struct drm_crtc_state *crtc_state;
3053 struct drm_crtc *crtc;
3056 state = drm_atomic_state_alloc(dev);
3060 state->acquire_ctx = ctx;
3062 drm_for_each_crtc(crtc, dev) {
3063 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3064 if (IS_ERR(crtc_state)) {
3065 ret = PTR_ERR(crtc_state);
3069 crtc_state->active = false;
3071 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3075 ret = drm_atomic_add_affected_planes(state, crtc);
3079 ret = drm_atomic_add_affected_connectors(state, crtc);
3084 for_each_new_connector_in_state(state, conn, conn_state, i) {
3085 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3090 for_each_new_plane_in_state(state, plane, plane_state, i) {
3091 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3095 drm_atomic_set_fb_for_plane(plane_state, NULL);
3098 ret = drm_atomic_commit(state);
3100 drm_atomic_state_put(state);
3103 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3106 * drm_atomic_helper_shutdown - shutdown all CRTC
3109 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3110 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3111 * that also takes a snapshot of the modeset state to be restored on resume.
3113 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3114 * and it is the atomic version of drm_crtc_force_disable_all().
3116 void drm_atomic_helper_shutdown(struct drm_device *dev)
3118 struct drm_modeset_acquire_ctx ctx;
3121 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3123 ret = drm_atomic_helper_disable_all(dev, &ctx);
3125 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3127 DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
3129 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3132 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3134 * @ctx: lock acquisition context
3136 * Makes a copy of the current atomic state by looping over all objects and
3137 * duplicating their respective states. This is used for example by suspend/
3138 * resume support code to save the state prior to suspend such that it can
3139 * be restored upon resume.
3141 * Note that this treats atomic state as persistent between save and restore.
3142 * Drivers must make sure that this is possible and won't result in confusion
3143 * or erroneous behaviour.
3145 * Note that if callers haven't already acquired all modeset locks this might
3146 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3149 * A pointer to the copy of the atomic state object on success or an
3150 * ERR_PTR()-encoded error code on failure.
3153 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3155 struct drm_atomic_state *
3156 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3157 struct drm_modeset_acquire_ctx *ctx)
3159 struct drm_atomic_state *state;
3160 struct drm_connector *conn;
3161 struct drm_connector_list_iter conn_iter;
3162 struct drm_plane *plane;
3163 struct drm_crtc *crtc;
3166 state = drm_atomic_state_alloc(dev);
3168 return ERR_PTR(-ENOMEM);
3170 state->acquire_ctx = ctx;
3171 state->duplicated = true;
3173 drm_for_each_crtc(crtc, dev) {
3174 struct drm_crtc_state *crtc_state;
3176 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3177 if (IS_ERR(crtc_state)) {
3178 err = PTR_ERR(crtc_state);
3183 drm_for_each_plane(plane, dev) {
3184 struct drm_plane_state *plane_state;
3186 plane_state = drm_atomic_get_plane_state(state, plane);
3187 if (IS_ERR(plane_state)) {
3188 err = PTR_ERR(plane_state);
3193 drm_connector_list_iter_begin(dev, &conn_iter);
3194 drm_for_each_connector_iter(conn, &conn_iter) {
3195 struct drm_connector_state *conn_state;
3197 conn_state = drm_atomic_get_connector_state(state, conn);
3198 if (IS_ERR(conn_state)) {
3199 err = PTR_ERR(conn_state);
3200 drm_connector_list_iter_end(&conn_iter);
3204 drm_connector_list_iter_end(&conn_iter);
3206 /* clear the acquire context so that it isn't accidentally reused */
3207 state->acquire_ctx = NULL;
3211 drm_atomic_state_put(state);
3212 state = ERR_PTR(err);
3217 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3220 * drm_atomic_helper_suspend - subsystem-level suspend helper
3223 * Duplicates the current atomic state, disables all active outputs and then
3224 * returns a pointer to the original atomic state to the caller. Drivers can
3225 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3226 * restore the output configuration that was active at the time the system
3229 * Note that it is potentially unsafe to use this. The atomic state object
3230 * returned by this function is assumed to be persistent. Drivers must ensure
3231 * that this holds true. Before calling this function, drivers must make sure
3232 * to suspend fbdev emulation so that nothing can be using the device.
3235 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3236 * encoded error code on failure. Drivers should store the returned atomic
3237 * state object and pass it to the drm_atomic_helper_resume() helper upon
3241 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3242 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3244 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3246 struct drm_modeset_acquire_ctx ctx;
3247 struct drm_atomic_state *state;
3250 /* This can never be returned, but it makes the compiler happy */
3251 state = ERR_PTR(-EINVAL);
3253 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3255 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3259 err = drm_atomic_helper_disable_all(dev, &ctx);
3261 drm_atomic_state_put(state);
3262 state = ERR_PTR(err);
3267 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3269 return ERR_PTR(err);
3273 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3276 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3277 * @state: duplicated atomic state to commit
3278 * @ctx: pointer to acquire_ctx to use for commit.
3280 * The state returned by drm_atomic_helper_duplicate_state() and
3281 * drm_atomic_helper_suspend() is partially invalid, and needs to
3282 * be fixed up before commit.
3285 * 0 on success or a negative error code on failure.
3288 * drm_atomic_helper_suspend()
3290 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3291 struct drm_modeset_acquire_ctx *ctx)
3294 struct drm_plane *plane;
3295 struct drm_plane_state *new_plane_state;
3296 struct drm_connector *connector;
3297 struct drm_connector_state *new_conn_state;
3298 struct drm_crtc *crtc;
3299 struct drm_crtc_state *new_crtc_state;
3301 state->acquire_ctx = ctx;
3303 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3304 state->planes[i].old_state = plane->state;
3306 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3307 state->crtcs[i].old_state = crtc->state;
3309 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3310 state->connectors[i].old_state = connector->state;
3312 ret = drm_atomic_commit(state);
3314 state->acquire_ctx = NULL;
3318 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3321 * drm_atomic_helper_resume - subsystem-level resume helper
3323 * @state: atomic state to resume to
3325 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3326 * grabs all modeset locks and commits the atomic state object. This can be
3327 * used in conjunction with the drm_atomic_helper_suspend() helper to
3328 * implement suspend/resume for drivers that support atomic mode-setting.
3331 * 0 on success or a negative error code on failure.
3334 * drm_atomic_helper_suspend()
3336 int drm_atomic_helper_resume(struct drm_device *dev,
3337 struct drm_atomic_state *state)
3339 struct drm_modeset_acquire_ctx ctx;
3342 drm_mode_config_reset(dev);
3344 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3346 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3348 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3349 drm_atomic_state_put(state);
3353 EXPORT_SYMBOL(drm_atomic_helper_resume);
3355 static int page_flip_common(struct drm_atomic_state *state,
3356 struct drm_crtc *crtc,
3357 struct drm_framebuffer *fb,
3358 struct drm_pending_vblank_event *event,
3361 struct drm_plane *plane = crtc->primary;
3362 struct drm_plane_state *plane_state;
3363 struct drm_crtc_state *crtc_state;
3366 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3367 if (IS_ERR(crtc_state))
3368 return PTR_ERR(crtc_state);
3370 crtc_state->event = event;
3371 crtc_state->async_flip = flags & DRM_MODE_PAGE_FLIP_ASYNC;
3373 plane_state = drm_atomic_get_plane_state(state, plane);
3374 if (IS_ERR(plane_state))
3375 return PTR_ERR(plane_state);
3377 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3380 drm_atomic_set_fb_for_plane(plane_state, fb);
3382 /* Make sure we don't accidentally do a full modeset. */
3383 state->allow_modeset = false;
3384 if (!crtc_state->active) {
3385 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3386 crtc->base.id, crtc->name);
3394 * drm_atomic_helper_page_flip - execute a legacy page flip
3396 * @fb: DRM framebuffer
3397 * @event: optional DRM event to signal upon completion
3398 * @flags: flip flags for non-vblank sync'ed updates
3399 * @ctx: lock acquisition context
3401 * Provides a default &drm_crtc_funcs.page_flip implementation
3402 * using the atomic driver interface.
3405 * Returns 0 on success, negative errno numbers on failure.
3408 * drm_atomic_helper_page_flip_target()
3410 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3411 struct drm_framebuffer *fb,
3412 struct drm_pending_vblank_event *event,
3414 struct drm_modeset_acquire_ctx *ctx)
3416 struct drm_plane *plane = crtc->primary;
3417 struct drm_atomic_state *state;
3420 state = drm_atomic_state_alloc(plane->dev);
3424 state->acquire_ctx = ctx;
3426 ret = page_flip_common(state, crtc, fb, event, flags);
3430 ret = drm_atomic_nonblocking_commit(state);
3432 drm_atomic_state_put(state);
3435 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3438 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3440 * @fb: DRM framebuffer
3441 * @event: optional DRM event to signal upon completion
3442 * @flags: flip flags for non-vblank sync'ed updates
3443 * @target: specifying the target vblank period when the flip to take effect
3444 * @ctx: lock acquisition context
3446 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3447 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3448 * target vblank period to flip.
3451 * Returns 0 on success, negative errno numbers on failure.
3453 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3454 struct drm_framebuffer *fb,
3455 struct drm_pending_vblank_event *event,
3458 struct drm_modeset_acquire_ctx *ctx)
3460 struct drm_plane *plane = crtc->primary;
3461 struct drm_atomic_state *state;
3462 struct drm_crtc_state *crtc_state;
3465 state = drm_atomic_state_alloc(plane->dev);
3469 state->acquire_ctx = ctx;
3471 ret = page_flip_common(state, crtc, fb, event, flags);
3475 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3476 if (WARN_ON(!crtc_state)) {
3480 crtc_state->target_vblank = target;
3482 ret = drm_atomic_nonblocking_commit(state);
3484 drm_atomic_state_put(state);
3487 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3490 * drm_atomic_helper_bridge_propagate_bus_fmt() - Propagate output format to
3491 * the input end of a bridge
3492 * @bridge: bridge control structure
3493 * @bridge_state: new bridge state
3494 * @crtc_state: new CRTC state
3495 * @conn_state: new connector state
3496 * @output_fmt: tested output bus format
3497 * @num_input_fmts: will contain the size of the returned array
3499 * This helper is a pluggable implementation of the
3500 * &drm_bridge_funcs.atomic_get_input_bus_fmts operation for bridges that don't
3501 * modify the bus configuration between their input and their output. It
3502 * returns an array of input formats with a single element set to @output_fmt.
3505 * a valid format array of size @num_input_fmts, or NULL if the allocation
3509 drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
3510 struct drm_bridge_state *bridge_state,
3511 struct drm_crtc_state *crtc_state,
3512 struct drm_connector_state *conn_state,
3514 unsigned int *num_input_fmts)
3518 input_fmts = kzalloc(sizeof(*input_fmts), GFP_KERNEL);
3520 *num_input_fmts = 0;
3524 *num_input_fmts = 1;
3525 input_fmts[0] = output_fmt;
3528 EXPORT_SYMBOL(drm_atomic_helper_bridge_propagate_bus_fmt);