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_plane_helper.h>
39 #include <drm/drm_print.h>
40 #include <drm/drm_self_refresh_helper.h>
41 #include <drm/drm_vblank.h>
42 #include <drm/drm_writeback.h>
44 #include "drm_crtc_helper_internal.h"
45 #include "drm_crtc_internal.h"
50 * This helper library provides implementations of check and commit functions on
51 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
52 * also provides convenience implementations for the atomic state handling
53 * callbacks for drivers which don't need to subclass the drm core structures to
54 * add their own additional internal state.
56 * This library also provides default implementations for the check callback in
57 * drm_atomic_helper_check() and for the commit callback with
58 * drm_atomic_helper_commit(). But the individual stages and callbacks are
59 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
60 * together with a driver private modeset implementation.
62 * This library also provides implementations for all the legacy driver
63 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
64 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
65 * various functions to implement set_property callbacks. New drivers must not
66 * implement these functions themselves but must use the provided helpers.
68 * The atomic helper uses the same function table structures as all other
69 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
70 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
71 * also shares the &struct drm_plane_helper_funcs function table with the plane
75 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
76 struct drm_plane_state *old_plane_state,
77 struct drm_plane_state *plane_state,
78 struct drm_plane *plane)
80 struct drm_crtc_state *crtc_state;
82 if (old_plane_state->crtc) {
83 crtc_state = drm_atomic_get_new_crtc_state(state,
84 old_plane_state->crtc);
86 if (WARN_ON(!crtc_state))
89 crtc_state->planes_changed = true;
92 if (plane_state->crtc) {
93 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
95 if (WARN_ON(!crtc_state))
98 crtc_state->planes_changed = true;
102 static int handle_conflicting_encoders(struct drm_atomic_state *state,
103 bool disable_conflicting_encoders)
105 struct drm_connector_state *new_conn_state;
106 struct drm_connector *connector;
107 struct drm_connector_list_iter conn_iter;
108 struct drm_encoder *encoder;
109 unsigned encoder_mask = 0;
113 * First loop, find all newly assigned encoders from the connectors
114 * part of the state. If the same encoder is assigned to multiple
115 * connectors bail out.
117 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
118 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
119 struct drm_encoder *new_encoder;
121 if (!new_conn_state->crtc)
124 if (funcs->atomic_best_encoder)
125 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
126 else if (funcs->best_encoder)
127 new_encoder = funcs->best_encoder(connector);
129 new_encoder = drm_connector_get_single_encoder(connector);
132 if (encoder_mask & drm_encoder_mask(new_encoder)) {
133 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
134 new_encoder->base.id, new_encoder->name,
135 connector->base.id, connector->name);
140 encoder_mask |= drm_encoder_mask(new_encoder);
148 * Second loop, iterate over all connectors not part of the state.
150 * If a conflicting encoder is found and disable_conflicting_encoders
151 * is not set, an error is returned. Userspace can provide a solution
152 * through the atomic ioctl.
154 * If the flag is set conflicting connectors are removed from the CRTC
155 * and the CRTC is disabled if no encoder is left. This preserves
156 * compatibility with the legacy set_config behavior.
158 drm_connector_list_iter_begin(state->dev, &conn_iter);
159 drm_for_each_connector_iter(connector, &conn_iter) {
160 struct drm_crtc_state *crtc_state;
162 if (drm_atomic_get_new_connector_state(state, connector))
165 encoder = connector->state->best_encoder;
166 if (!encoder || !(encoder_mask & drm_encoder_mask(encoder)))
169 if (!disable_conflicting_encoders) {
170 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
171 encoder->base.id, encoder->name,
172 connector->state->crtc->base.id,
173 connector->state->crtc->name,
174 connector->base.id, connector->name);
179 new_conn_state = drm_atomic_get_connector_state(state, connector);
180 if (IS_ERR(new_conn_state)) {
181 ret = PTR_ERR(new_conn_state);
185 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
186 encoder->base.id, encoder->name,
187 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
188 connector->base.id, connector->name);
190 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
192 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
196 if (!crtc_state->connector_mask) {
197 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
202 crtc_state->active = false;
206 drm_connector_list_iter_end(&conn_iter);
212 set_best_encoder(struct drm_atomic_state *state,
213 struct drm_connector_state *conn_state,
214 struct drm_encoder *encoder)
216 struct drm_crtc_state *crtc_state;
217 struct drm_crtc *crtc;
219 if (conn_state->best_encoder) {
220 /* Unset the encoder_mask in the old crtc state. */
221 crtc = conn_state->connector->state->crtc;
223 /* A NULL crtc is an error here because we should have
224 * duplicated a NULL best_encoder when crtc was NULL.
225 * As an exception restoring duplicated atomic state
226 * during resume is allowed, so don't warn when
227 * best_encoder is equal to encoder we intend to set.
229 WARN_ON(!crtc && encoder != conn_state->best_encoder);
231 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
233 crtc_state->encoder_mask &=
234 ~drm_encoder_mask(conn_state->best_encoder);
239 crtc = conn_state->crtc;
242 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
244 crtc_state->encoder_mask |=
245 drm_encoder_mask(encoder);
249 conn_state->best_encoder = encoder;
253 steal_encoder(struct drm_atomic_state *state,
254 struct drm_encoder *encoder)
256 struct drm_crtc_state *crtc_state;
257 struct drm_connector *connector;
258 struct drm_connector_state *old_connector_state, *new_connector_state;
261 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
262 struct drm_crtc *encoder_crtc;
264 if (new_connector_state->best_encoder != encoder)
267 encoder_crtc = old_connector_state->crtc;
269 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
270 encoder->base.id, encoder->name,
271 encoder_crtc->base.id, encoder_crtc->name);
273 set_best_encoder(state, new_connector_state, NULL);
275 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
276 crtc_state->connectors_changed = true;
283 update_connector_routing(struct drm_atomic_state *state,
284 struct drm_connector *connector,
285 struct drm_connector_state *old_connector_state,
286 struct drm_connector_state *new_connector_state)
288 const struct drm_connector_helper_funcs *funcs;
289 struct drm_encoder *new_encoder;
290 struct drm_crtc_state *crtc_state;
292 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
296 if (old_connector_state->crtc != new_connector_state->crtc) {
297 if (old_connector_state->crtc) {
298 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
299 crtc_state->connectors_changed = true;
302 if (new_connector_state->crtc) {
303 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
304 crtc_state->connectors_changed = true;
308 if (!new_connector_state->crtc) {
309 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
313 set_best_encoder(state, new_connector_state, NULL);
318 crtc_state = drm_atomic_get_new_crtc_state(state,
319 new_connector_state->crtc);
321 * For compatibility with legacy users, we want to make sure that
322 * we allow DPMS On->Off modesets on unregistered connectors. Modesets
323 * which would result in anything else must be considered invalid, to
324 * avoid turning on new displays on dead connectors.
326 * Since the connector can be unregistered at any point during an
327 * atomic check or commit, this is racy. But that's OK: all we care
328 * about is ensuring that userspace can't do anything but shut off the
329 * display on a connector that was destroyed after it's been notified,
332 * Additionally, we also want to ignore connector registration when
333 * we're trying to restore an atomic state during system resume since
334 * there's a chance the connector may have been destroyed during the
335 * process, but it's better to ignore that then cause
336 * drm_atomic_helper_resume() to fail.
338 if (!state->duplicated && drm_connector_is_unregistered(connector) &&
339 crtc_state->active) {
340 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
341 connector->base.id, connector->name);
345 funcs = connector->helper_private;
347 if (funcs->atomic_best_encoder)
348 new_encoder = funcs->atomic_best_encoder(connector,
349 new_connector_state);
350 else if (funcs->best_encoder)
351 new_encoder = funcs->best_encoder(connector);
353 new_encoder = drm_connector_get_single_encoder(connector);
356 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
362 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
363 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
364 new_encoder->base.id,
366 new_connector_state->crtc->base.id,
367 new_connector_state->crtc->name);
371 if (new_encoder == new_connector_state->best_encoder) {
372 set_best_encoder(state, new_connector_state, new_encoder);
374 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
377 new_encoder->base.id,
379 new_connector_state->crtc->base.id,
380 new_connector_state->crtc->name);
385 steal_encoder(state, new_encoder);
387 set_best_encoder(state, new_connector_state, new_encoder);
389 crtc_state->connectors_changed = true;
391 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
394 new_encoder->base.id,
396 new_connector_state->crtc->base.id,
397 new_connector_state->crtc->name);
403 mode_fixup(struct drm_atomic_state *state)
405 struct drm_crtc *crtc;
406 struct drm_crtc_state *new_crtc_state;
407 struct drm_connector *connector;
408 struct drm_connector_state *new_conn_state;
412 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
413 if (!new_crtc_state->mode_changed &&
414 !new_crtc_state->connectors_changed)
417 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
420 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
421 const struct drm_encoder_helper_funcs *funcs;
422 struct drm_encoder *encoder;
423 struct drm_bridge *bridge;
425 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
427 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
431 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
434 * Each encoder has at most one connector (since we always steal
435 * it away), so we won't call ->mode_fixup twice.
437 encoder = new_conn_state->best_encoder;
438 funcs = encoder->helper_private;
440 bridge = drm_bridge_chain_get_first_bridge(encoder);
441 ret = drm_atomic_bridge_chain_check(bridge,
445 DRM_DEBUG_ATOMIC("Bridge atomic check failed\n");
449 if (funcs && funcs->atomic_check) {
450 ret = funcs->atomic_check(encoder, new_crtc_state,
453 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
454 encoder->base.id, encoder->name);
457 } else if (funcs && funcs->mode_fixup) {
458 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
459 &new_crtc_state->adjusted_mode);
461 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
462 encoder->base.id, encoder->name);
468 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
469 const struct drm_crtc_helper_funcs *funcs;
471 if (!new_crtc_state->enable)
474 if (!new_crtc_state->mode_changed &&
475 !new_crtc_state->connectors_changed)
478 funcs = crtc->helper_private;
479 if (!funcs || !funcs->mode_fixup)
482 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
483 &new_crtc_state->adjusted_mode);
485 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
486 crtc->base.id, crtc->name);
494 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
495 struct drm_encoder *encoder,
496 struct drm_crtc *crtc,
497 const struct drm_display_mode *mode)
499 struct drm_bridge *bridge;
500 enum drm_mode_status ret;
502 ret = drm_encoder_mode_valid(encoder, mode);
503 if (ret != MODE_OK) {
504 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
505 encoder->base.id, encoder->name);
509 bridge = drm_bridge_chain_get_first_bridge(encoder);
510 ret = drm_bridge_chain_mode_valid(bridge, &connector->display_info,
512 if (ret != MODE_OK) {
513 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
517 ret = drm_crtc_mode_valid(crtc, mode);
518 if (ret != MODE_OK) {
519 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
520 crtc->base.id, crtc->name);
528 mode_valid(struct drm_atomic_state *state)
530 struct drm_connector_state *conn_state;
531 struct drm_connector *connector;
534 for_each_new_connector_in_state(state, connector, conn_state, i) {
535 struct drm_encoder *encoder = conn_state->best_encoder;
536 struct drm_crtc *crtc = conn_state->crtc;
537 struct drm_crtc_state *crtc_state;
538 enum drm_mode_status mode_status;
539 const struct drm_display_mode *mode;
541 if (!crtc || !encoder)
544 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
547 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
550 mode = &crtc_state->mode;
552 mode_status = mode_valid_path(connector, encoder, crtc, mode);
553 if (mode_status != MODE_OK)
561 * drm_atomic_helper_check_modeset - validate state object for modeset changes
563 * @state: the driver state object
565 * Check the state object to see if the requested state is physically possible.
566 * This does all the CRTC and connector related computations for an atomic
567 * update and adds any additional connectors needed for full modesets. It calls
568 * the various per-object callbacks in the follow order:
570 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
571 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
572 * 3. If it's determined a modeset is needed then all connectors on the affected
573 * CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them.
574 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
575 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
576 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
577 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
578 * This function is only called when the encoder will be part of a configured CRTC,
579 * it must not be used for implementing connector property validation.
580 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
582 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints.
584 * &drm_crtc_state.mode_changed is set when the input mode is changed.
585 * &drm_crtc_state.connectors_changed is set when a connector is added or
586 * removed from the CRTC. &drm_crtc_state.active_changed is set when
587 * &drm_crtc_state.active changes, which is used for DPMS.
588 * &drm_crtc_state.no_vblank is set from the result of drm_dev_has_vblank().
589 * See also: drm_atomic_crtc_needs_modeset()
593 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
594 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
595 * without a full modeset) _must_ call this function afterwards after that
596 * change. It is permitted to call this function multiple times for the same
597 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
598 * upon the adjusted dotclock for fifo space allocation and watermark
602 * Zero for success or -errno
605 drm_atomic_helper_check_modeset(struct drm_device *dev,
606 struct drm_atomic_state *state)
608 struct drm_crtc *crtc;
609 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
610 struct drm_connector *connector;
611 struct drm_connector_state *old_connector_state, *new_connector_state;
613 unsigned connectors_mask = 0;
615 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
616 bool has_connectors =
617 !!new_crtc_state->connector_mask;
619 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
621 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
622 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
623 crtc->base.id, crtc->name);
624 new_crtc_state->mode_changed = true;
627 if (old_crtc_state->enable != new_crtc_state->enable) {
628 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
629 crtc->base.id, crtc->name);
632 * For clarity this assignment is done here, but
633 * enable == 0 is only true when there are no
634 * connectors and a NULL mode.
636 * The other way around is true as well. enable != 0
637 * iff connectors are attached and a mode is set.
639 new_crtc_state->mode_changed = true;
640 new_crtc_state->connectors_changed = true;
643 if (old_crtc_state->active != new_crtc_state->active) {
644 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
645 crtc->base.id, crtc->name);
646 new_crtc_state->active_changed = true;
649 if (new_crtc_state->enable != has_connectors) {
650 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
651 crtc->base.id, crtc->name);
656 if (drm_dev_has_vblank(dev))
657 new_crtc_state->no_vblank = false;
659 new_crtc_state->no_vblank = true;
662 ret = handle_conflicting_encoders(state, false);
666 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
667 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
669 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
672 * This only sets crtc->connectors_changed for routing changes,
673 * drivers must set crtc->connectors_changed themselves when
674 * connector properties need to be updated.
676 ret = update_connector_routing(state, connector,
678 new_connector_state);
681 if (old_connector_state->crtc) {
682 new_crtc_state = drm_atomic_get_new_crtc_state(state,
683 old_connector_state->crtc);
684 if (old_connector_state->link_status !=
685 new_connector_state->link_status)
686 new_crtc_state->connectors_changed = true;
688 if (old_connector_state->max_requested_bpc !=
689 new_connector_state->max_requested_bpc)
690 new_crtc_state->connectors_changed = true;
693 if (funcs->atomic_check)
694 ret = funcs->atomic_check(connector, state);
698 connectors_mask |= BIT(i);
702 * After all the routing has been prepared we need to add in any
703 * connector which is itself unchanged, but whose CRTC changes its
704 * configuration. This must be done before calling mode_fixup in case a
705 * crtc only changed its mode but has the same set of connectors.
707 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
708 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
711 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
712 crtc->base.id, crtc->name,
713 new_crtc_state->enable ? 'y' : 'n',
714 new_crtc_state->active ? 'y' : 'n');
716 ret = drm_atomic_add_affected_connectors(state, crtc);
720 ret = drm_atomic_add_affected_planes(state, crtc);
726 * Iterate over all connectors again, to make sure atomic_check()
727 * has been called on them when a modeset is forced.
729 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
730 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
732 if (connectors_mask & BIT(i))
735 if (funcs->atomic_check)
736 ret = funcs->atomic_check(connector, state);
742 * Iterate over all connectors again, and add all affected bridges to
745 for_each_oldnew_connector_in_state(state, connector,
747 new_connector_state, i) {
748 struct drm_encoder *encoder;
750 encoder = old_connector_state->best_encoder;
751 ret = drm_atomic_add_encoder_bridges(state, encoder);
755 encoder = new_connector_state->best_encoder;
756 ret = drm_atomic_add_encoder_bridges(state, encoder);
761 ret = mode_valid(state);
765 return mode_fixup(state);
767 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
770 * drm_atomic_helper_check_plane_state() - Check plane state for validity
771 * @plane_state: plane state to check
772 * @crtc_state: CRTC state to check
773 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
774 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
775 * @can_position: is it legal to position the plane such that it
776 * doesn't cover the entire CRTC? This will generally
777 * only be false for primary planes.
778 * @can_update_disabled: can the plane be updated while the CRTC
781 * Checks that a desired plane update is valid, and updates various
782 * bits of derived state (clipped coordinates etc.). Drivers that provide
783 * their own plane handling rather than helper-provided implementations may
784 * still wish to call this function to avoid duplication of error checking
788 * Zero if update appears valid, error code on failure
790 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
791 const struct drm_crtc_state *crtc_state,
795 bool can_update_disabled)
797 struct drm_framebuffer *fb = plane_state->fb;
798 struct drm_rect *src = &plane_state->src;
799 struct drm_rect *dst = &plane_state->dst;
800 unsigned int rotation = plane_state->rotation;
801 struct drm_rect clip = {};
804 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
806 *src = drm_plane_state_src(plane_state);
807 *dst = drm_plane_state_dest(plane_state);
810 plane_state->visible = false;
814 /* crtc should only be NULL when disabling (i.e., !fb) */
815 if (WARN_ON(!plane_state->crtc)) {
816 plane_state->visible = false;
820 if (!crtc_state->enable && !can_update_disabled) {
821 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
825 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
828 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
829 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
830 if (hscale < 0 || vscale < 0) {
831 DRM_DEBUG_KMS("Invalid scaling of plane\n");
832 drm_rect_debug_print("src: ", &plane_state->src, true);
833 drm_rect_debug_print("dst: ", &plane_state->dst, false);
837 if (crtc_state->enable)
838 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
840 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
842 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
844 if (!plane_state->visible)
846 * Plane isn't visible; some drivers can handle this
847 * so we just return success here. Drivers that can't
848 * (including those that use the primary plane helper's
849 * update function) will return an error from their
850 * update_plane handler.
854 if (!can_position && !drm_rect_equals(dst, &clip)) {
855 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
856 drm_rect_debug_print("dst: ", dst, false);
857 drm_rect_debug_print("clip: ", &clip, false);
863 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
866 * drm_atomic_helper_check_planes - validate state object for planes changes
868 * @state: the driver state object
870 * Check the state object to see if the requested state is physically possible.
871 * This does all the plane update related checks using by calling into the
872 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
873 * hooks provided by the driver.
875 * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has
879 * Zero for success or -errno
882 drm_atomic_helper_check_planes(struct drm_device *dev,
883 struct drm_atomic_state *state)
885 struct drm_crtc *crtc;
886 struct drm_crtc_state *new_crtc_state;
887 struct drm_plane *plane;
888 struct drm_plane_state *new_plane_state, *old_plane_state;
891 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
892 const struct drm_plane_helper_funcs *funcs;
894 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
896 funcs = plane->helper_private;
898 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
900 drm_atomic_helper_check_plane_damage(state, new_plane_state);
902 if (!funcs || !funcs->atomic_check)
905 ret = funcs->atomic_check(plane, new_plane_state);
907 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
908 plane->base.id, plane->name);
913 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
914 const struct drm_crtc_helper_funcs *funcs;
916 funcs = crtc->helper_private;
918 if (!funcs || !funcs->atomic_check)
921 ret = funcs->atomic_check(crtc, new_crtc_state);
923 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
924 crtc->base.id, crtc->name);
931 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
934 * drm_atomic_helper_check - validate state object
936 * @state: the driver state object
938 * Check the state object to see if the requested state is physically possible.
939 * Only CRTCs and planes have check callbacks, so for any additional (global)
940 * checking that a driver needs it can simply wrap that around this function.
941 * Drivers without such needs can directly use this as their
942 * &drm_mode_config_funcs.atomic_check callback.
944 * This just wraps the two parts of the state checking for planes and modeset
945 * state in the default order: First it calls drm_atomic_helper_check_modeset()
946 * and then drm_atomic_helper_check_planes(). The assumption is that the
947 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
948 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
951 * Note that zpos normalization will add all enable planes to the state which
952 * might not desired for some drivers.
953 * For example enable/disable of a cursor plane which have fixed zpos value
954 * would trigger all other enabled planes to be forced to the state change.
957 * Zero for success or -errno
959 int drm_atomic_helper_check(struct drm_device *dev,
960 struct drm_atomic_state *state)
964 ret = drm_atomic_helper_check_modeset(dev, state);
968 if (dev->mode_config.normalize_zpos) {
969 ret = drm_atomic_normalize_zpos(dev, state);
974 ret = drm_atomic_helper_check_planes(dev, state);
978 if (state->legacy_cursor_update)
979 state->async_update = !drm_atomic_helper_async_check(dev, state);
981 drm_self_refresh_helper_alter_state(state);
985 EXPORT_SYMBOL(drm_atomic_helper_check);
988 crtc_needs_disable(struct drm_crtc_state *old_state,
989 struct drm_crtc_state *new_state)
992 * No new_state means the CRTC is off, so the only criteria is whether
993 * it's currently active or in self refresh mode.
996 return drm_atomic_crtc_effectively_active(old_state);
999 * We need to disable bridge(s) and CRTC if we're transitioning out of
1000 * self-refresh and changing CRTCs at the same time, because the
1001 * bridge tracks self-refresh status via CRTC state.
1003 if (old_state->self_refresh_active &&
1004 old_state->crtc != new_state->crtc)
1008 * We also need to run through the crtc_funcs->disable() function if
1009 * the CRTC is currently on, if it's transitioning to self refresh
1010 * mode, or if it's in self refresh mode and needs to be fully
1013 return old_state->active ||
1014 (old_state->self_refresh_active && !new_state->enable) ||
1015 new_state->self_refresh_active;
1019 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
1021 struct drm_connector *connector;
1022 struct drm_connector_state *old_conn_state, *new_conn_state;
1023 struct drm_crtc *crtc;
1024 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1027 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1028 const struct drm_encoder_helper_funcs *funcs;
1029 struct drm_encoder *encoder;
1030 struct drm_bridge *bridge;
1032 /* Shut down everything that's in the changeset and currently
1033 * still on. So need to check the old, saved state. */
1034 if (!old_conn_state->crtc)
1037 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
1039 if (new_conn_state->crtc)
1040 new_crtc_state = drm_atomic_get_new_crtc_state(
1042 new_conn_state->crtc);
1044 new_crtc_state = NULL;
1046 if (!crtc_needs_disable(old_crtc_state, new_crtc_state) ||
1047 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
1050 encoder = old_conn_state->best_encoder;
1052 /* We shouldn't get this far if we didn't previously have
1053 * an encoder.. but WARN_ON() rather than explode.
1055 if (WARN_ON(!encoder))
1058 funcs = encoder->helper_private;
1060 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
1061 encoder->base.id, encoder->name);
1064 * Each encoder has at most one connector (since we always steal
1065 * it away), so we won't call disable hooks twice.
1067 bridge = drm_bridge_chain_get_first_bridge(encoder);
1068 drm_atomic_bridge_chain_disable(bridge, old_state);
1070 /* Right function depends upon target state. */
1072 if (funcs->atomic_disable)
1073 funcs->atomic_disable(encoder, old_state);
1074 else if (new_conn_state->crtc && funcs->prepare)
1075 funcs->prepare(encoder);
1076 else if (funcs->disable)
1077 funcs->disable(encoder);
1078 else if (funcs->dpms)
1079 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1082 drm_atomic_bridge_chain_post_disable(bridge, old_state);
1085 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1086 const struct drm_crtc_helper_funcs *funcs;
1089 /* Shut down everything that needs a full modeset. */
1090 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1093 if (!crtc_needs_disable(old_crtc_state, new_crtc_state))
1096 funcs = crtc->helper_private;
1098 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1099 crtc->base.id, crtc->name);
1102 /* Right function depends upon target state. */
1103 if (new_crtc_state->enable && funcs->prepare)
1104 funcs->prepare(crtc);
1105 else if (funcs->atomic_disable)
1106 funcs->atomic_disable(crtc, old_crtc_state);
1107 else if (funcs->disable)
1108 funcs->disable(crtc);
1109 else if (funcs->dpms)
1110 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1112 if (!drm_dev_has_vblank(dev))
1115 ret = drm_crtc_vblank_get(crtc);
1116 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1118 drm_crtc_vblank_put(crtc);
1123 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1125 * @old_state: atomic state object with old state structures
1127 * This function updates all the various legacy modeset state pointers in
1128 * connectors, encoders and CRTCs.
1130 * Drivers can use this for building their own atomic commit if they don't have
1131 * a pure helper-based modeset implementation.
1133 * Since these updates are not synchronized with lockings, only code paths
1134 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1135 * legacy state filled out by this helper. Defacto this means this helper and
1136 * the legacy state pointers are only really useful for transitioning an
1137 * existing driver to the atomic world.
1140 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1141 struct drm_atomic_state *old_state)
1143 struct drm_connector *connector;
1144 struct drm_connector_state *old_conn_state, *new_conn_state;
1145 struct drm_crtc *crtc;
1146 struct drm_crtc_state *new_crtc_state;
1149 /* clear out existing links and update dpms */
1150 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1151 if (connector->encoder) {
1152 WARN_ON(!connector->encoder->crtc);
1154 connector->encoder->crtc = NULL;
1155 connector->encoder = NULL;
1158 crtc = new_conn_state->crtc;
1159 if ((!crtc && old_conn_state->crtc) ||
1160 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1161 int mode = DRM_MODE_DPMS_OFF;
1163 if (crtc && crtc->state->active)
1164 mode = DRM_MODE_DPMS_ON;
1166 connector->dpms = mode;
1171 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1172 if (!new_conn_state->crtc)
1175 if (WARN_ON(!new_conn_state->best_encoder))
1178 connector->encoder = new_conn_state->best_encoder;
1179 connector->encoder->crtc = new_conn_state->crtc;
1182 /* set legacy state in the crtc structure */
1183 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1184 struct drm_plane *primary = crtc->primary;
1185 struct drm_plane_state *new_plane_state;
1187 crtc->mode = new_crtc_state->mode;
1188 crtc->enabled = new_crtc_state->enable;
1191 drm_atomic_get_new_plane_state(old_state, primary);
1193 if (new_plane_state && new_plane_state->crtc == crtc) {
1194 crtc->x = new_plane_state->src_x >> 16;
1195 crtc->y = new_plane_state->src_y >> 16;
1199 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1202 * drm_atomic_helper_calc_timestamping_constants - update vblank timestamping constants
1203 * @state: atomic state object
1205 * Updates the timestamping constants used for precise vblank timestamps
1206 * by calling drm_calc_timestamping_constants() for all enabled crtcs in @state.
1208 void drm_atomic_helper_calc_timestamping_constants(struct drm_atomic_state *state)
1210 struct drm_crtc_state *new_crtc_state;
1211 struct drm_crtc *crtc;
1214 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
1215 if (new_crtc_state->enable)
1216 drm_calc_timestamping_constants(crtc,
1217 &new_crtc_state->adjusted_mode);
1220 EXPORT_SYMBOL(drm_atomic_helper_calc_timestamping_constants);
1223 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1225 struct drm_crtc *crtc;
1226 struct drm_crtc_state *new_crtc_state;
1227 struct drm_connector *connector;
1228 struct drm_connector_state *new_conn_state;
1231 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1232 const struct drm_crtc_helper_funcs *funcs;
1234 if (!new_crtc_state->mode_changed)
1237 funcs = crtc->helper_private;
1239 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1240 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1241 crtc->base.id, crtc->name);
1243 funcs->mode_set_nofb(crtc);
1247 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1248 const struct drm_encoder_helper_funcs *funcs;
1249 struct drm_encoder *encoder;
1250 struct drm_display_mode *mode, *adjusted_mode;
1251 struct drm_bridge *bridge;
1253 if (!new_conn_state->best_encoder)
1256 encoder = new_conn_state->best_encoder;
1257 funcs = encoder->helper_private;
1258 new_crtc_state = new_conn_state->crtc->state;
1259 mode = &new_crtc_state->mode;
1260 adjusted_mode = &new_crtc_state->adjusted_mode;
1262 if (!new_crtc_state->mode_changed)
1265 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1266 encoder->base.id, encoder->name);
1269 * Each encoder has at most one connector (since we always steal
1270 * it away), so we won't call mode_set hooks twice.
1272 if (funcs && funcs->atomic_mode_set) {
1273 funcs->atomic_mode_set(encoder, new_crtc_state,
1275 } else if (funcs && funcs->mode_set) {
1276 funcs->mode_set(encoder, mode, adjusted_mode);
1279 bridge = drm_bridge_chain_get_first_bridge(encoder);
1280 drm_bridge_chain_mode_set(bridge, mode, adjusted_mode);
1285 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1287 * @old_state: atomic state object with old state structures
1289 * This function shuts down all the outputs that need to be shut down and
1290 * prepares them (if required) with the new mode.
1292 * For compatibility with legacy CRTC helpers this should be called before
1293 * drm_atomic_helper_commit_planes(), which is what the default commit function
1294 * does. But drivers with different needs can group the modeset commits together
1295 * and do the plane commits at the end. This is useful for drivers doing runtime
1296 * PM since planes updates then only happen when the CRTC is actually enabled.
1298 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1299 struct drm_atomic_state *old_state)
1301 disable_outputs(dev, old_state);
1303 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1304 drm_atomic_helper_calc_timestamping_constants(old_state);
1306 crtc_set_mode(dev, old_state);
1308 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1310 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1311 struct drm_atomic_state *old_state)
1313 struct drm_connector *connector;
1314 struct drm_connector_state *new_conn_state;
1317 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1318 const struct drm_connector_helper_funcs *funcs;
1320 funcs = connector->helper_private;
1321 if (!funcs->atomic_commit)
1324 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1325 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1326 funcs->atomic_commit(connector, new_conn_state);
1332 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1334 * @old_state: atomic state object with old state structures
1336 * This function enables all the outputs with the new configuration which had to
1337 * be turned off for the update.
1339 * For compatibility with legacy CRTC helpers this should be called after
1340 * drm_atomic_helper_commit_planes(), which is what the default commit function
1341 * does. But drivers with different needs can group the modeset commits together
1342 * and do the plane commits at the end. This is useful for drivers doing runtime
1343 * PM since planes updates then only happen when the CRTC is actually enabled.
1345 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1346 struct drm_atomic_state *old_state)
1348 struct drm_crtc *crtc;
1349 struct drm_crtc_state *old_crtc_state;
1350 struct drm_crtc_state *new_crtc_state;
1351 struct drm_connector *connector;
1352 struct drm_connector_state *new_conn_state;
1355 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1356 const struct drm_crtc_helper_funcs *funcs;
1358 /* Need to filter out CRTCs where only planes change. */
1359 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1362 if (!new_crtc_state->active)
1365 funcs = crtc->helper_private;
1367 if (new_crtc_state->enable) {
1368 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1369 crtc->base.id, crtc->name);
1370 if (funcs->atomic_enable)
1371 funcs->atomic_enable(crtc, old_crtc_state);
1372 else if (funcs->commit)
1373 funcs->commit(crtc);
1377 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1378 const struct drm_encoder_helper_funcs *funcs;
1379 struct drm_encoder *encoder;
1380 struct drm_bridge *bridge;
1382 if (!new_conn_state->best_encoder)
1385 if (!new_conn_state->crtc->state->active ||
1386 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1389 encoder = new_conn_state->best_encoder;
1390 funcs = encoder->helper_private;
1392 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1393 encoder->base.id, encoder->name);
1396 * Each encoder has at most one connector (since we always steal
1397 * it away), so we won't call enable hooks twice.
1399 bridge = drm_bridge_chain_get_first_bridge(encoder);
1400 drm_atomic_bridge_chain_pre_enable(bridge, old_state);
1403 if (funcs->atomic_enable)
1404 funcs->atomic_enable(encoder, old_state);
1405 else if (funcs->enable)
1406 funcs->enable(encoder);
1407 else if (funcs->commit)
1408 funcs->commit(encoder);
1411 drm_atomic_bridge_chain_enable(bridge, old_state);
1414 drm_atomic_helper_commit_writebacks(dev, old_state);
1416 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1419 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1421 * @state: atomic state object with old state structures
1422 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1423 * Otherwise @state is the old state.
1425 * For implicit sync, driver should fish the exclusive fence out from the
1426 * incoming fb's and stash it in the drm_plane_state. This is called after
1427 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1428 * just uses the atomic state to find the changed planes)
1430 * Note that @pre_swap is needed since the point where we block for fences moves
1431 * around depending upon whether an atomic commit is blocking or
1432 * non-blocking. For non-blocking commit all waiting needs to happen after
1433 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1434 * to wait **before** we do anything that can't be easily rolled back. That is
1435 * before we call drm_atomic_helper_swap_state().
1437 * Returns zero if success or < 0 if dma_fence_wait() fails.
1439 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1440 struct drm_atomic_state *state,
1443 struct drm_plane *plane;
1444 struct drm_plane_state *new_plane_state;
1447 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1448 if (!new_plane_state->fence)
1451 WARN_ON(!new_plane_state->fb);
1454 * If waiting for fences pre-swap (ie: nonblock), userspace can
1455 * still interrupt the operation. Instead of blocking until the
1456 * timer expires, make the wait interruptible.
1458 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1462 dma_fence_put(new_plane_state->fence);
1463 new_plane_state->fence = NULL;
1468 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1471 * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs
1473 * @old_state: atomic state object with old state structures
1475 * Helper to, after atomic commit, wait for vblanks on all affected
1476 * CRTCs (ie. before cleaning up old framebuffers using
1477 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1478 * framebuffers have actually changed to optimize for the legacy cursor and
1479 * plane update use-case.
1481 * Drivers using the nonblocking commit tracking support initialized by calling
1482 * drm_atomic_helper_setup_commit() should look at
1483 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1486 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1487 struct drm_atomic_state *old_state)
1489 struct drm_crtc *crtc;
1490 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1492 unsigned crtc_mask = 0;
1495 * Legacy cursor ioctls are completely unsynced, and userspace
1496 * relies on that (by doing tons of cursor updates).
1498 if (old_state->legacy_cursor_update)
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 commited 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 commited 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))
1752 return funcs->atomic_async_check(plane, new_plane_state);
1754 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1757 * drm_atomic_helper_async_commit - commit state asynchronously
1759 * @state: the driver state object
1761 * This function commits a state asynchronously, i.e., not vblank
1762 * synchronized. It should be used on a state only when
1763 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1764 * the states like normal sync commits, but just do in-place changes on the
1767 * TODO: Implement full swap instead of doing in-place changes.
1769 void drm_atomic_helper_async_commit(struct drm_device *dev,
1770 struct drm_atomic_state *state)
1772 struct drm_plane *plane;
1773 struct drm_plane_state *plane_state;
1774 const struct drm_plane_helper_funcs *funcs;
1777 for_each_new_plane_in_state(state, plane, plane_state, i) {
1778 struct drm_framebuffer *new_fb = plane_state->fb;
1779 struct drm_framebuffer *old_fb = plane->state->fb;
1781 funcs = plane->helper_private;
1782 funcs->atomic_async_update(plane, plane_state);
1785 * ->atomic_async_update() is supposed to update the
1786 * plane->state in-place, make sure at least common
1787 * properties have been properly updated.
1789 WARN_ON_ONCE(plane->state->fb != new_fb);
1790 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1791 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1792 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1793 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1796 * Make sure the FBs have been swapped so that cleanups in the
1797 * new_state performs a cleanup in the old FB.
1799 WARN_ON_ONCE(plane_state->fb != old_fb);
1802 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1805 * drm_atomic_helper_commit - commit validated state object
1807 * @state: the driver state object
1808 * @nonblock: whether nonblocking behavior is requested.
1810 * This function commits a with drm_atomic_helper_check() pre-validated state
1811 * object. This can still fail when e.g. the framebuffer reservation fails. This
1812 * function implements nonblocking commits, using
1813 * drm_atomic_helper_setup_commit() and related functions.
1815 * Committing the actual hardware state is done through the
1816 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1817 * implementation drm_atomic_helper_commit_tail().
1820 * Zero for success or -errno.
1822 int drm_atomic_helper_commit(struct drm_device *dev,
1823 struct drm_atomic_state *state,
1828 if (state->async_update) {
1829 ret = drm_atomic_helper_prepare_planes(dev, state);
1833 drm_atomic_helper_async_commit(dev, state);
1834 drm_atomic_helper_cleanup_planes(dev, state);
1839 ret = drm_atomic_helper_setup_commit(state, nonblock);
1843 INIT_WORK(&state->commit_work, commit_work);
1845 ret = drm_atomic_helper_prepare_planes(dev, state);
1850 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1856 * This is the point of no return - everything below never fails except
1857 * when the hw goes bonghits. Which means we can commit the new state on
1858 * the software side now.
1861 ret = drm_atomic_helper_swap_state(state, true);
1866 * Everything below can be run asynchronously without the need to grab
1867 * any modeset locks at all under one condition: It must be guaranteed
1868 * that the asynchronous work has either been cancelled (if the driver
1869 * supports it, which at least requires that the framebuffers get
1870 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1871 * before the new state gets committed on the software side with
1872 * drm_atomic_helper_swap_state().
1874 * This scheme allows new atomic state updates to be prepared and
1875 * checked in parallel to the asynchronous completion of the previous
1876 * update. Which is important since compositors need to figure out the
1877 * composition of the next frame right after having submitted the
1880 * NOTE: Commit work has multiple phases, first hardware commit, then
1881 * cleanup. We want them to overlap, hence need system_unbound_wq to
1882 * make sure work items don't artificially stall on each another.
1885 drm_atomic_state_get(state);
1887 queue_work(system_unbound_wq, &state->commit_work);
1894 drm_atomic_helper_cleanup_planes(dev, state);
1897 EXPORT_SYMBOL(drm_atomic_helper_commit);
1900 * DOC: implementing nonblocking commit
1902 * Nonblocking atomic commits should use struct &drm_crtc_commit to sequence
1903 * different operations against each another. Locks, especially struct
1904 * &drm_modeset_lock, should not be held in worker threads or any other
1905 * asynchronous context used to commit the hardware state.
1907 * drm_atomic_helper_commit() implements the recommended sequence for
1908 * nonblocking commits, using drm_atomic_helper_setup_commit() internally:
1910 * 1. Run drm_atomic_helper_prepare_planes(). Since this can fail and we
1911 * need to propagate out of memory/VRAM errors to userspace, it must be called
1914 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1915 * might be affected by the new state update. This is handled by
1916 * drm_atomic_helper_setup_commit().
1918 * Asynchronous workers need to have sufficient parallelism to be able to run
1919 * different atomic commits on different CRTCs in parallel. The simplest way to
1920 * achieve this is by running them on the &system_unbound_wq work queue. Note
1921 * that drivers are not required to split up atomic commits and run an
1922 * individual commit in parallel - userspace is supposed to do that if it cares.
1923 * But it might be beneficial to do that for modesets, since those necessarily
1924 * must be done as one global operation, and enabling or disabling a CRTC can
1925 * take a long time. But even that is not required.
1927 * IMPORTANT: A &drm_atomic_state update for multiple CRTCs is sequenced
1928 * against all CRTCs therein. Therefore for atomic state updates which only flip
1929 * planes the driver must not get the struct &drm_crtc_state of unrelated CRTCs
1930 * in its atomic check code: This would prevent committing of atomic updates to
1931 * multiple CRTCs in parallel. In general, adding additional state structures
1932 * should be avoided as much as possible, because this reduces parallelism in
1933 * (nonblocking) commits, both due to locking and due to commit sequencing
1936 * 3. The software state is updated synchronously with
1937 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1938 * locks means concurrent callers never see inconsistent state. Note that commit
1939 * workers do not hold any locks; their access is only coordinated through
1940 * ordering. If workers would access state only through the pointers in the
1941 * free-standing state objects (currently not the case for any driver) then even
1942 * multiple pending commits could be in-flight at the same time.
1944 * 4. Schedule a work item to do all subsequent steps, using the split-out
1945 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1946 * then cleaning up the framebuffers after the old framebuffer is no longer
1947 * being displayed. The scheduled work should synchronize against other workers
1948 * using the &drm_crtc_commit infrastructure as needed. See
1949 * drm_atomic_helper_setup_commit() for more details.
1952 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1954 struct drm_crtc_commit *commit, *stall_commit = NULL;
1955 bool completed = true;
1959 spin_lock(&crtc->commit_lock);
1961 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1963 completed = try_wait_for_completion(&commit->flip_done);
1964 /* Userspace is not allowed to get ahead of the previous
1965 * commit with nonblocking ones. */
1966 if (!completed && nonblock) {
1967 spin_unlock(&crtc->commit_lock);
1970 } else if (i == 1) {
1971 stall_commit = drm_crtc_commit_get(commit);
1977 spin_unlock(&crtc->commit_lock);
1982 /* We don't want to let commits get ahead of cleanup work too much,
1983 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1985 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1988 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1989 crtc->base.id, crtc->name);
1991 drm_crtc_commit_put(stall_commit);
1993 return ret < 0 ? ret : 0;
1996 static void release_crtc_commit(struct completion *completion)
1998 struct drm_crtc_commit *commit = container_of(completion,
2002 drm_crtc_commit_put(commit);
2005 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
2007 init_completion(&commit->flip_done);
2008 init_completion(&commit->hw_done);
2009 init_completion(&commit->cleanup_done);
2010 INIT_LIST_HEAD(&commit->commit_entry);
2011 kref_init(&commit->ref);
2012 commit->crtc = crtc;
2015 static struct drm_crtc_commit *
2016 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
2019 struct drm_crtc_state *new_crtc_state;
2021 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2023 return new_crtc_state->commit;
2026 if (!state->fake_commit) {
2027 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
2028 if (!state->fake_commit)
2031 init_commit(state->fake_commit, NULL);
2034 return state->fake_commit;
2038 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
2039 * @state: new modeset state to be committed
2040 * @nonblock: whether nonblocking behavior is requested.
2042 * This function prepares @state to be used by the atomic helper's support for
2043 * nonblocking commits. Drivers using the nonblocking commit infrastructure
2044 * should always call this function from their
2045 * &drm_mode_config_funcs.atomic_commit hook.
2047 * To be able to use this support drivers need to use a few more helper
2048 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
2049 * actually committing the hardware state, and for nonblocking commits this call
2050 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
2051 * and its stall parameter, for when a driver's commit hooks look at the
2052 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
2054 * Completion of the hardware commit step must be signalled using
2055 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
2056 * to read or change any permanent software or hardware modeset state. The only
2057 * exception is state protected by other means than &drm_modeset_lock locks.
2058 * Only the free standing @state with pointers to the old state structures can
2059 * be inspected, e.g. to clean up old buffers using
2060 * drm_atomic_helper_cleanup_planes().
2062 * At the very end, before cleaning up @state drivers must call
2063 * drm_atomic_helper_commit_cleanup_done().
2065 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
2066 * complete and easy-to-use default implementation of the atomic_commit() hook.
2068 * The tracking of asynchronously executed and still pending commits is done
2069 * using the core structure &drm_crtc_commit.
2071 * By default there's no need to clean up resources allocated by this function
2072 * explicitly: drm_atomic_state_default_clear() will take care of that
2077 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
2078 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
2080 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
2083 struct drm_crtc *crtc;
2084 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2085 struct drm_connector *conn;
2086 struct drm_connector_state *old_conn_state, *new_conn_state;
2087 struct drm_plane *plane;
2088 struct drm_plane_state *old_plane_state, *new_plane_state;
2089 struct drm_crtc_commit *commit;
2092 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2093 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
2097 init_commit(commit, crtc);
2099 new_crtc_state->commit = commit;
2101 ret = stall_checks(crtc, nonblock);
2105 /* Drivers only send out events when at least either current or
2106 * new CRTC state is active. Complete right away if everything
2108 if (!old_crtc_state->active && !new_crtc_state->active) {
2109 complete_all(&commit->flip_done);
2113 /* Legacy cursor updates are fully unsynced. */
2114 if (state->legacy_cursor_update) {
2115 complete_all(&commit->flip_done);
2119 if (!new_crtc_state->event) {
2120 commit->event = kzalloc(sizeof(*commit->event),
2125 new_crtc_state->event = commit->event;
2128 new_crtc_state->event->base.completion = &commit->flip_done;
2129 new_crtc_state->event->base.completion_release = release_crtc_commit;
2130 drm_crtc_commit_get(commit);
2132 commit->abort_completion = true;
2134 state->crtcs[i].commit = commit;
2135 drm_crtc_commit_get(commit);
2138 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2139 /* Userspace is not allowed to get ahead of the previous
2140 * commit with nonblocking ones. */
2141 if (nonblock && old_conn_state->commit &&
2142 !try_wait_for_completion(&old_conn_state->commit->flip_done))
2145 /* Always track connectors explicitly for e.g. link retraining. */
2146 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2150 new_conn_state->commit = drm_crtc_commit_get(commit);
2153 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2154 /* Userspace is not allowed to get ahead of the previous
2155 * commit with nonblocking ones. */
2156 if (nonblock && old_plane_state->commit &&
2157 !try_wait_for_completion(&old_plane_state->commit->flip_done))
2160 /* Always track planes explicitly for async pageflip support. */
2161 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2165 new_plane_state->commit = drm_crtc_commit_get(commit);
2170 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2173 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2174 * @old_state: atomic state object with old state structures
2176 * This function waits for all preceeding commits that touch the same CRTC as
2177 * @old_state to both be committed to the hardware (as signalled by
2178 * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
2179 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2181 * This is part of the atomic helper support for nonblocking commits, see
2182 * drm_atomic_helper_setup_commit() for an overview.
2184 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2186 struct drm_crtc *crtc;
2187 struct drm_crtc_state *old_crtc_state;
2188 struct drm_plane *plane;
2189 struct drm_plane_state *old_plane_state;
2190 struct drm_connector *conn;
2191 struct drm_connector_state *old_conn_state;
2192 struct drm_crtc_commit *commit;
2196 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2197 commit = old_crtc_state->commit;
2202 ret = wait_for_completion_timeout(&commit->hw_done,
2205 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2206 crtc->base.id, crtc->name);
2208 /* Currently no support for overwriting flips, hence
2209 * stall for previous one to execute completely. */
2210 ret = wait_for_completion_timeout(&commit->flip_done,
2213 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
2214 crtc->base.id, crtc->name);
2217 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2218 commit = old_conn_state->commit;
2223 ret = wait_for_completion_timeout(&commit->hw_done,
2226 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
2227 conn->base.id, conn->name);
2229 /* Currently no support for overwriting flips, hence
2230 * stall for previous one to execute completely. */
2231 ret = wait_for_completion_timeout(&commit->flip_done,
2234 DRM_ERROR("[CONNECTOR:%d:%s] flip_done timed out\n",
2235 conn->base.id, conn->name);
2238 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2239 commit = old_plane_state->commit;
2244 ret = wait_for_completion_timeout(&commit->hw_done,
2247 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
2248 plane->base.id, plane->name);
2250 /* Currently no support for overwriting flips, hence
2251 * stall for previous one to execute completely. */
2252 ret = wait_for_completion_timeout(&commit->flip_done,
2255 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2256 plane->base.id, plane->name);
2259 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2262 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2263 * @old_state: atomic state object with old state structures
2265 * This function walks all CRTCs and fakes VBLANK events on those with
2266 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2267 * The primary use of this function is writeback connectors working in oneshot
2268 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2269 * when a job is queued, and any change to the pipeline that does not touch the
2270 * connector is leading to timeouts when calling
2271 * drm_atomic_helper_wait_for_vblanks() or
2272 * drm_atomic_helper_wait_for_flip_done(). In addition to writeback
2273 * connectors, this function can also fake VBLANK events for CRTCs without
2276 * This is part of the atomic helper support for nonblocking commits, see
2277 * drm_atomic_helper_setup_commit() for an overview.
2279 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2281 struct drm_crtc_state *new_crtc_state;
2282 struct drm_crtc *crtc;
2285 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2286 unsigned long flags;
2288 if (!new_crtc_state->no_vblank)
2291 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2292 if (new_crtc_state->event) {
2293 drm_crtc_send_vblank_event(crtc,
2294 new_crtc_state->event);
2295 new_crtc_state->event = NULL;
2297 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2300 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2303 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2304 * @old_state: atomic state object with old state structures
2306 * This function is used to signal completion of the hardware commit step. After
2307 * this step the driver is not allowed to read or change any permanent software
2308 * or hardware modeset state. The only exception is state protected by other
2309 * means than &drm_modeset_lock locks.
2311 * Drivers should try to postpone any expensive or delayed cleanup work after
2312 * this function is called.
2314 * This is part of the atomic helper support for nonblocking commits, see
2315 * drm_atomic_helper_setup_commit() for an overview.
2317 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2319 struct drm_crtc *crtc;
2320 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2321 struct drm_crtc_commit *commit;
2324 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2325 commit = new_crtc_state->commit;
2330 * copy new_crtc_state->commit to old_crtc_state->commit,
2331 * it's unsafe to touch new_crtc_state after hw_done,
2332 * but we still need to do so in cleanup_done().
2334 if (old_crtc_state->commit)
2335 drm_crtc_commit_put(old_crtc_state->commit);
2337 old_crtc_state->commit = drm_crtc_commit_get(commit);
2339 /* backend must have consumed any event by now */
2340 WARN_ON(new_crtc_state->event);
2341 complete_all(&commit->hw_done);
2344 if (old_state->fake_commit) {
2345 complete_all(&old_state->fake_commit->hw_done);
2346 complete_all(&old_state->fake_commit->flip_done);
2349 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2352 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2353 * @old_state: atomic state object with old state structures
2355 * This signals completion of the atomic update @old_state, including any
2356 * cleanup work. If used, it must be called right before calling
2357 * drm_atomic_state_put().
2359 * This is part of the atomic helper support for nonblocking commits, see
2360 * drm_atomic_helper_setup_commit() for an overview.
2362 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2364 struct drm_crtc *crtc;
2365 struct drm_crtc_state *old_crtc_state;
2366 struct drm_crtc_commit *commit;
2369 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2370 commit = old_crtc_state->commit;
2371 if (WARN_ON(!commit))
2374 complete_all(&commit->cleanup_done);
2375 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2377 spin_lock(&crtc->commit_lock);
2378 list_del(&commit->commit_entry);
2379 spin_unlock(&crtc->commit_lock);
2382 if (old_state->fake_commit) {
2383 complete_all(&old_state->fake_commit->cleanup_done);
2384 WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2387 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2390 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2392 * @state: atomic state object with new state structures
2394 * This function prepares plane state, specifically framebuffers, for the new
2395 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2396 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2397 * any already successfully prepared framebuffer.
2400 * 0 on success, negative error code on failure.
2402 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2403 struct drm_atomic_state *state)
2405 struct drm_connector *connector;
2406 struct drm_connector_state *new_conn_state;
2407 struct drm_plane *plane;
2408 struct drm_plane_state *new_plane_state;
2411 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2412 if (!new_conn_state->writeback_job)
2415 ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2420 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2421 const struct drm_plane_helper_funcs *funcs;
2423 funcs = plane->helper_private;
2425 if (funcs->prepare_fb) {
2426 ret = funcs->prepare_fb(plane, new_plane_state);
2435 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2436 const struct drm_plane_helper_funcs *funcs;
2441 funcs = plane->helper_private;
2443 if (funcs->cleanup_fb)
2444 funcs->cleanup_fb(plane, new_plane_state);
2449 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2451 static bool plane_crtc_active(const struct drm_plane_state *state)
2453 return state->crtc && state->crtc->state->active;
2457 * drm_atomic_helper_commit_planes - commit plane state
2459 * @old_state: atomic state object with old state structures
2460 * @flags: flags for committing plane state
2462 * This function commits the new plane state using the plane and atomic helper
2463 * functions for planes and CRTCs. It assumes that the atomic state has already
2464 * been pushed into the relevant object state pointers, since this step can no
2467 * It still requires the global state object @old_state to know which planes and
2468 * crtcs need to be updated though.
2470 * Note that this function does all plane updates across all CRTCs in one step.
2471 * If the hardware can't support this approach look at
2472 * drm_atomic_helper_commit_planes_on_crtc() instead.
2474 * Plane parameters can be updated by applications while the associated CRTC is
2475 * disabled. The DRM/KMS core will store the parameters in the plane state,
2476 * which will be available to the driver when the CRTC is turned on. As a result
2477 * most drivers don't need to be immediately notified of plane updates for a
2480 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2481 * @flags in order not to receive plane update notifications related to a
2482 * disabled CRTC. This avoids the need to manually ignore plane updates in
2483 * driver code when the driver and/or hardware can't or just don't need to deal
2484 * with updates on disabled CRTCs, for example when supporting runtime PM.
2486 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2487 * display controllers require to disable a CRTC's planes when the CRTC is
2488 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2489 * call for a plane if the CRTC of the old plane state needs a modesetting
2490 * operation. Of course, the drivers need to disable the planes in their CRTC
2491 * disable callbacks since no one else would do that.
2493 * The drm_atomic_helper_commit() default implementation doesn't set the
2494 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2495 * This should not be copied blindly by drivers.
2497 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2498 struct drm_atomic_state *old_state,
2501 struct drm_crtc *crtc;
2502 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2503 struct drm_plane *plane;
2504 struct drm_plane_state *old_plane_state, *new_plane_state;
2506 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2507 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2509 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2510 const struct drm_crtc_helper_funcs *funcs;
2512 funcs = crtc->helper_private;
2514 if (!funcs || !funcs->atomic_begin)
2517 if (active_only && !new_crtc_state->active)
2520 funcs->atomic_begin(crtc, old_crtc_state);
2523 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2524 const struct drm_plane_helper_funcs *funcs;
2527 funcs = plane->helper_private;
2532 disabling = drm_atomic_plane_disabling(old_plane_state,
2537 * Skip planes related to inactive CRTCs. If the plane
2538 * is enabled use the state of the current CRTC. If the
2539 * plane is being disabled use the state of the old
2540 * CRTC to avoid skipping planes being disabled on an
2543 if (!disabling && !plane_crtc_active(new_plane_state))
2545 if (disabling && !plane_crtc_active(old_plane_state))
2550 * Special-case disabling the plane if drivers support it.
2552 if (disabling && funcs->atomic_disable) {
2553 struct drm_crtc_state *crtc_state;
2555 crtc_state = old_plane_state->crtc->state;
2557 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2561 funcs->atomic_disable(plane, old_plane_state);
2562 } else if (new_plane_state->crtc || disabling) {
2563 funcs->atomic_update(plane, old_plane_state);
2567 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2568 const struct drm_crtc_helper_funcs *funcs;
2570 funcs = crtc->helper_private;
2572 if (!funcs || !funcs->atomic_flush)
2575 if (active_only && !new_crtc_state->active)
2578 funcs->atomic_flush(crtc, old_crtc_state);
2581 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2584 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC
2585 * @old_crtc_state: atomic state object with the old CRTC state
2587 * This function commits the new plane state using the plane and atomic helper
2588 * functions for planes on the specific CRTC. It assumes that the atomic state
2589 * has already been pushed into the relevant object state pointers, since this
2590 * step can no longer fail.
2592 * This function is useful when plane updates should be done CRTC-by-CRTC
2593 * instead of one global step like drm_atomic_helper_commit_planes() does.
2595 * This function can only be savely used when planes are not allowed to move
2596 * between different CRTCs because this function doesn't handle inter-CRTC
2597 * depencies. Callers need to ensure that either no such depencies exist,
2598 * resolve them through ordering of commit calls or through some other means.
2601 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2603 const struct drm_crtc_helper_funcs *crtc_funcs;
2604 struct drm_crtc *crtc = old_crtc_state->crtc;
2605 struct drm_atomic_state *old_state = old_crtc_state->state;
2606 struct drm_crtc_state *new_crtc_state =
2607 drm_atomic_get_new_crtc_state(old_state, crtc);
2608 struct drm_plane *plane;
2609 unsigned plane_mask;
2611 plane_mask = old_crtc_state->plane_mask;
2612 plane_mask |= new_crtc_state->plane_mask;
2614 crtc_funcs = crtc->helper_private;
2615 if (crtc_funcs && crtc_funcs->atomic_begin)
2616 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2618 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2619 struct drm_plane_state *old_plane_state =
2620 drm_atomic_get_old_plane_state(old_state, plane);
2621 struct drm_plane_state *new_plane_state =
2622 drm_atomic_get_new_plane_state(old_state, plane);
2623 const struct drm_plane_helper_funcs *plane_funcs;
2625 plane_funcs = plane->helper_private;
2627 if (!old_plane_state || !plane_funcs)
2630 WARN_ON(new_plane_state->crtc &&
2631 new_plane_state->crtc != crtc);
2633 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2634 plane_funcs->atomic_disable)
2635 plane_funcs->atomic_disable(plane, old_plane_state);
2636 else if (new_plane_state->crtc ||
2637 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2638 plane_funcs->atomic_update(plane, old_plane_state);
2641 if (crtc_funcs && crtc_funcs->atomic_flush)
2642 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2644 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2647 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2648 * @old_crtc_state: atomic state object with the old CRTC state
2649 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2651 * Disables all planes associated with the given CRTC. This can be
2652 * used for instance in the CRTC helper atomic_disable callback to disable
2655 * If the atomic-parameter is set the function calls the CRTC's
2656 * atomic_begin hook before and atomic_flush hook after disabling the
2659 * It is a bug to call this function without having implemented the
2660 * &drm_plane_helper_funcs.atomic_disable plane hook.
2663 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2666 struct drm_crtc *crtc = old_crtc_state->crtc;
2667 const struct drm_crtc_helper_funcs *crtc_funcs =
2668 crtc->helper_private;
2669 struct drm_plane *plane;
2671 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2672 crtc_funcs->atomic_begin(crtc, NULL);
2674 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2675 const struct drm_plane_helper_funcs *plane_funcs =
2676 plane->helper_private;
2681 WARN_ON(!plane_funcs->atomic_disable);
2682 if (plane_funcs->atomic_disable)
2683 plane_funcs->atomic_disable(plane, NULL);
2686 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2687 crtc_funcs->atomic_flush(crtc, NULL);
2689 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2692 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2694 * @old_state: atomic state object with old state structures
2696 * This function cleans up plane state, specifically framebuffers, from the old
2697 * configuration. Hence the old configuration must be perserved in @old_state to
2698 * be able to call this function.
2700 * This function must also be called on the new state when the atomic update
2701 * fails at any point after calling drm_atomic_helper_prepare_planes().
2703 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2704 struct drm_atomic_state *old_state)
2706 struct drm_plane *plane;
2707 struct drm_plane_state *old_plane_state, *new_plane_state;
2710 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2711 const struct drm_plane_helper_funcs *funcs;
2712 struct drm_plane_state *plane_state;
2715 * This might be called before swapping when commit is aborted,
2716 * in which case we have to cleanup the new state.
2718 if (old_plane_state == plane->state)
2719 plane_state = new_plane_state;
2721 plane_state = old_plane_state;
2723 funcs = plane->helper_private;
2725 if (funcs->cleanup_fb)
2726 funcs->cleanup_fb(plane, plane_state);
2729 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2732 * drm_atomic_helper_swap_state - store atomic state into current sw state
2733 * @state: atomic state
2734 * @stall: stall for preceeding commits
2736 * This function stores the atomic state into the current state pointers in all
2737 * driver objects. It should be called after all failing steps have been done
2738 * and succeeded, but before the actual hardware state is committed.
2740 * For cleanup and error recovery the current state for all changed objects will
2741 * be swapped into @state.
2743 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2745 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2747 * 2. Do any other steps that might fail.
2749 * 3. Put the staged state into the current state pointers with this function.
2751 * 4. Actually commit the hardware state.
2753 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2754 * contains the old state. Also do any other cleanup required with that state.
2756 * @stall must be set when nonblocking commits for this driver directly access
2757 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2758 * the current atomic helpers this is almost always the case, since the helpers
2759 * don't pass the right state structures to the callbacks.
2763 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2764 * waiting for the previous commits has been interrupted.
2766 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2770 struct drm_connector *connector;
2771 struct drm_connector_state *old_conn_state, *new_conn_state;
2772 struct drm_crtc *crtc;
2773 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2774 struct drm_plane *plane;
2775 struct drm_plane_state *old_plane_state, *new_plane_state;
2776 struct drm_crtc_commit *commit;
2777 struct drm_private_obj *obj;
2778 struct drm_private_state *old_obj_state, *new_obj_state;
2782 * We have to stall for hw_done here before
2783 * drm_atomic_helper_wait_for_dependencies() because flip
2784 * depth > 1 is not yet supported by all drivers. As long as
2785 * obj->state is directly dereferenced anywhere in the drivers
2786 * atomic_commit_tail function, then it's unsafe to swap state
2787 * before drm_atomic_helper_commit_hw_done() is called.
2790 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2791 commit = old_crtc_state->commit;
2796 ret = wait_for_completion_interruptible(&commit->hw_done);
2801 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2802 commit = old_conn_state->commit;
2807 ret = wait_for_completion_interruptible(&commit->hw_done);
2812 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2813 commit = old_plane_state->commit;
2818 ret = wait_for_completion_interruptible(&commit->hw_done);
2824 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2825 WARN_ON(connector->state != old_conn_state);
2827 old_conn_state->state = state;
2828 new_conn_state->state = NULL;
2830 state->connectors[i].state = old_conn_state;
2831 connector->state = new_conn_state;
2834 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2835 WARN_ON(crtc->state != old_crtc_state);
2837 old_crtc_state->state = state;
2838 new_crtc_state->state = NULL;
2840 state->crtcs[i].state = old_crtc_state;
2841 crtc->state = new_crtc_state;
2843 if (new_crtc_state->commit) {
2844 spin_lock(&crtc->commit_lock);
2845 list_add(&new_crtc_state->commit->commit_entry,
2846 &crtc->commit_list);
2847 spin_unlock(&crtc->commit_lock);
2849 new_crtc_state->commit->event = NULL;
2853 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2854 WARN_ON(plane->state != old_plane_state);
2856 old_plane_state->state = state;
2857 new_plane_state->state = NULL;
2859 state->planes[i].state = old_plane_state;
2860 plane->state = new_plane_state;
2863 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2864 WARN_ON(obj->state != old_obj_state);
2866 old_obj_state->state = state;
2867 new_obj_state->state = NULL;
2869 state->private_objs[i].state = old_obj_state;
2870 obj->state = new_obj_state;
2875 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2878 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2879 * @plane: plane object to update
2880 * @crtc: owning CRTC of owning plane
2881 * @fb: framebuffer to flip onto plane
2882 * @crtc_x: x offset of primary plane on @crtc
2883 * @crtc_y: y offset of primary plane on @crtc
2884 * @crtc_w: width of primary plane rectangle on @crtc
2885 * @crtc_h: height of primary plane rectangle on @crtc
2886 * @src_x: x offset of @fb for panning
2887 * @src_y: y offset of @fb for panning
2888 * @src_w: width of source rectangle in @fb
2889 * @src_h: height of source rectangle in @fb
2890 * @ctx: lock acquire context
2892 * Provides a default plane update handler using the atomic driver interface.
2895 * Zero on success, error code on failure
2897 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2898 struct drm_crtc *crtc,
2899 struct drm_framebuffer *fb,
2900 int crtc_x, int crtc_y,
2901 unsigned int crtc_w, unsigned int crtc_h,
2902 uint32_t src_x, uint32_t src_y,
2903 uint32_t src_w, uint32_t src_h,
2904 struct drm_modeset_acquire_ctx *ctx)
2906 struct drm_atomic_state *state;
2907 struct drm_plane_state *plane_state;
2910 state = drm_atomic_state_alloc(plane->dev);
2914 state->acquire_ctx = ctx;
2915 plane_state = drm_atomic_get_plane_state(state, plane);
2916 if (IS_ERR(plane_state)) {
2917 ret = PTR_ERR(plane_state);
2921 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2924 drm_atomic_set_fb_for_plane(plane_state, fb);
2925 plane_state->crtc_x = crtc_x;
2926 plane_state->crtc_y = crtc_y;
2927 plane_state->crtc_w = crtc_w;
2928 plane_state->crtc_h = crtc_h;
2929 plane_state->src_x = src_x;
2930 plane_state->src_y = src_y;
2931 plane_state->src_w = src_w;
2932 plane_state->src_h = src_h;
2934 if (plane == crtc->cursor)
2935 state->legacy_cursor_update = true;
2937 ret = drm_atomic_commit(state);
2939 drm_atomic_state_put(state);
2942 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2945 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2946 * @plane: plane to disable
2947 * @ctx: lock acquire context
2949 * Provides a default plane disable handler using the atomic driver interface.
2952 * Zero on success, error code on failure
2954 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2955 struct drm_modeset_acquire_ctx *ctx)
2957 struct drm_atomic_state *state;
2958 struct drm_plane_state *plane_state;
2961 state = drm_atomic_state_alloc(plane->dev);
2965 state->acquire_ctx = ctx;
2966 plane_state = drm_atomic_get_plane_state(state, plane);
2967 if (IS_ERR(plane_state)) {
2968 ret = PTR_ERR(plane_state);
2972 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2973 plane_state->state->legacy_cursor_update = true;
2975 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2979 ret = drm_atomic_commit(state);
2981 drm_atomic_state_put(state);
2984 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2987 * drm_atomic_helper_set_config - set a new config from userspace
2988 * @set: mode set configuration
2989 * @ctx: lock acquisition context
2991 * Provides a default CRTC set_config handler using the atomic driver interface.
2993 * NOTE: For backwards compatibility with old userspace this automatically
2994 * resets the "link-status" property to GOOD, to force any link
2995 * re-training. The SETCRTC ioctl does not define whether an update does
2996 * need a full modeset or just a plane update, hence we're allowed to do
2997 * that. See also drm_connector_set_link_status_property().
3000 * Returns 0 on success, negative errno numbers on failure.
3002 int drm_atomic_helper_set_config(struct drm_mode_set *set,
3003 struct drm_modeset_acquire_ctx *ctx)
3005 struct drm_atomic_state *state;
3006 struct drm_crtc *crtc = set->crtc;
3009 state = drm_atomic_state_alloc(crtc->dev);
3013 state->acquire_ctx = ctx;
3014 ret = __drm_atomic_helper_set_config(set, state);
3018 ret = handle_conflicting_encoders(state, true);
3022 ret = drm_atomic_commit(state);
3025 drm_atomic_state_put(state);
3028 EXPORT_SYMBOL(drm_atomic_helper_set_config);
3031 * drm_atomic_helper_disable_all - disable all currently active outputs
3033 * @ctx: lock acquisition context
3035 * Loops through all connectors, finding those that aren't turned off and then
3036 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3037 * that they are connected to.
3039 * This is used for example in suspend/resume to disable all currently active
3040 * functions when suspending. If you just want to shut down everything at e.g.
3041 * driver unload, look at drm_atomic_helper_shutdown().
3043 * Note that if callers haven't already acquired all modeset locks this might
3044 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3047 * 0 on success or a negative error code on failure.
3050 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3051 * drm_atomic_helper_shutdown().
3053 int drm_atomic_helper_disable_all(struct drm_device *dev,
3054 struct drm_modeset_acquire_ctx *ctx)
3056 struct drm_atomic_state *state;
3057 struct drm_connector_state *conn_state;
3058 struct drm_connector *conn;
3059 struct drm_plane_state *plane_state;
3060 struct drm_plane *plane;
3061 struct drm_crtc_state *crtc_state;
3062 struct drm_crtc *crtc;
3065 state = drm_atomic_state_alloc(dev);
3069 state->acquire_ctx = ctx;
3071 drm_for_each_crtc(crtc, dev) {
3072 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3073 if (IS_ERR(crtc_state)) {
3074 ret = PTR_ERR(crtc_state);
3078 crtc_state->active = false;
3080 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3084 ret = drm_atomic_add_affected_planes(state, crtc);
3088 ret = drm_atomic_add_affected_connectors(state, crtc);
3093 for_each_new_connector_in_state(state, conn, conn_state, i) {
3094 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3099 for_each_new_plane_in_state(state, plane, plane_state, i) {
3100 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3104 drm_atomic_set_fb_for_plane(plane_state, NULL);
3107 ret = drm_atomic_commit(state);
3109 drm_atomic_state_put(state);
3112 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3115 * drm_atomic_helper_shutdown - shutdown all CRTC
3118 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3119 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3120 * that also takes a snapshot of the modeset state to be restored on resume.
3122 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3123 * and it is the atomic version of drm_crtc_force_disable_all().
3125 void drm_atomic_helper_shutdown(struct drm_device *dev)
3127 struct drm_modeset_acquire_ctx ctx;
3130 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3132 ret = drm_atomic_helper_disable_all(dev, &ctx);
3134 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3136 DRM_MODESET_LOCK_ALL_END(dev, ctx, ret);
3138 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3141 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3143 * @ctx: lock acquisition context
3145 * Makes a copy of the current atomic state by looping over all objects and
3146 * duplicating their respective states. This is used for example by suspend/
3147 * resume support code to save the state prior to suspend such that it can
3148 * be restored upon resume.
3150 * Note that this treats atomic state as persistent between save and restore.
3151 * Drivers must make sure that this is possible and won't result in confusion
3152 * or erroneous behaviour.
3154 * Note that if callers haven't already acquired all modeset locks this might
3155 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3158 * A pointer to the copy of the atomic state object on success or an
3159 * ERR_PTR()-encoded error code on failure.
3162 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3164 struct drm_atomic_state *
3165 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3166 struct drm_modeset_acquire_ctx *ctx)
3168 struct drm_atomic_state *state;
3169 struct drm_connector *conn;
3170 struct drm_connector_list_iter conn_iter;
3171 struct drm_plane *plane;
3172 struct drm_crtc *crtc;
3175 state = drm_atomic_state_alloc(dev);
3177 return ERR_PTR(-ENOMEM);
3179 state->acquire_ctx = ctx;
3180 state->duplicated = true;
3182 drm_for_each_crtc(crtc, dev) {
3183 struct drm_crtc_state *crtc_state;
3185 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3186 if (IS_ERR(crtc_state)) {
3187 err = PTR_ERR(crtc_state);
3192 drm_for_each_plane(plane, dev) {
3193 struct drm_plane_state *plane_state;
3195 plane_state = drm_atomic_get_plane_state(state, plane);
3196 if (IS_ERR(plane_state)) {
3197 err = PTR_ERR(plane_state);
3202 drm_connector_list_iter_begin(dev, &conn_iter);
3203 drm_for_each_connector_iter(conn, &conn_iter) {
3204 struct drm_connector_state *conn_state;
3206 conn_state = drm_atomic_get_connector_state(state, conn);
3207 if (IS_ERR(conn_state)) {
3208 err = PTR_ERR(conn_state);
3209 drm_connector_list_iter_end(&conn_iter);
3213 drm_connector_list_iter_end(&conn_iter);
3215 /* clear the acquire context so that it isn't accidentally reused */
3216 state->acquire_ctx = NULL;
3220 drm_atomic_state_put(state);
3221 state = ERR_PTR(err);
3226 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3229 * drm_atomic_helper_suspend - subsystem-level suspend helper
3232 * Duplicates the current atomic state, disables all active outputs and then
3233 * returns a pointer to the original atomic state to the caller. Drivers can
3234 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3235 * restore the output configuration that was active at the time the system
3238 * Note that it is potentially unsafe to use this. The atomic state object
3239 * returned by this function is assumed to be persistent. Drivers must ensure
3240 * that this holds true. Before calling this function, drivers must make sure
3241 * to suspend fbdev emulation so that nothing can be using the device.
3244 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3245 * encoded error code on failure. Drivers should store the returned atomic
3246 * state object and pass it to the drm_atomic_helper_resume() helper upon
3250 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3251 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3253 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3255 struct drm_modeset_acquire_ctx ctx;
3256 struct drm_atomic_state *state;
3259 /* This can never be returned, but it makes the compiler happy */
3260 state = ERR_PTR(-EINVAL);
3262 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3264 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3268 err = drm_atomic_helper_disable_all(dev, &ctx);
3270 drm_atomic_state_put(state);
3271 state = ERR_PTR(err);
3276 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3278 return ERR_PTR(err);
3282 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3285 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3286 * @state: duplicated atomic state to commit
3287 * @ctx: pointer to acquire_ctx to use for commit.
3289 * The state returned by drm_atomic_helper_duplicate_state() and
3290 * drm_atomic_helper_suspend() is partially invalid, and needs to
3291 * be fixed up before commit.
3294 * 0 on success or a negative error code on failure.
3297 * drm_atomic_helper_suspend()
3299 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3300 struct drm_modeset_acquire_ctx *ctx)
3303 struct drm_plane *plane;
3304 struct drm_plane_state *new_plane_state;
3305 struct drm_connector *connector;
3306 struct drm_connector_state *new_conn_state;
3307 struct drm_crtc *crtc;
3308 struct drm_crtc_state *new_crtc_state;
3310 state->acquire_ctx = ctx;
3312 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3313 state->planes[i].old_state = plane->state;
3315 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3316 state->crtcs[i].old_state = crtc->state;
3318 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3319 state->connectors[i].old_state = connector->state;
3321 ret = drm_atomic_commit(state);
3323 state->acquire_ctx = NULL;
3327 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3330 * drm_atomic_helper_resume - subsystem-level resume helper
3332 * @state: atomic state to resume to
3334 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3335 * grabs all modeset locks and commits the atomic state object. This can be
3336 * used in conjunction with the drm_atomic_helper_suspend() helper to
3337 * implement suspend/resume for drivers that support atomic mode-setting.
3340 * 0 on success or a negative error code on failure.
3343 * drm_atomic_helper_suspend()
3345 int drm_atomic_helper_resume(struct drm_device *dev,
3346 struct drm_atomic_state *state)
3348 struct drm_modeset_acquire_ctx ctx;
3351 drm_mode_config_reset(dev);
3353 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3355 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3357 DRM_MODESET_LOCK_ALL_END(dev, ctx, err);
3358 drm_atomic_state_put(state);
3362 EXPORT_SYMBOL(drm_atomic_helper_resume);
3364 static int page_flip_common(struct drm_atomic_state *state,
3365 struct drm_crtc *crtc,
3366 struct drm_framebuffer *fb,
3367 struct drm_pending_vblank_event *event,
3370 struct drm_plane *plane = crtc->primary;
3371 struct drm_plane_state *plane_state;
3372 struct drm_crtc_state *crtc_state;
3375 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3376 if (IS_ERR(crtc_state))
3377 return PTR_ERR(crtc_state);
3379 crtc_state->event = event;
3380 crtc_state->async_flip = flags & DRM_MODE_PAGE_FLIP_ASYNC;
3382 plane_state = drm_atomic_get_plane_state(state, plane);
3383 if (IS_ERR(plane_state))
3384 return PTR_ERR(plane_state);
3386 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3389 drm_atomic_set_fb_for_plane(plane_state, fb);
3391 /* Make sure we don't accidentally do a full modeset. */
3392 state->allow_modeset = false;
3393 if (!crtc_state->active) {
3394 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3395 crtc->base.id, crtc->name);
3403 * drm_atomic_helper_page_flip - execute a legacy page flip
3405 * @fb: DRM framebuffer
3406 * @event: optional DRM event to signal upon completion
3407 * @flags: flip flags for non-vblank sync'ed updates
3408 * @ctx: lock acquisition context
3410 * Provides a default &drm_crtc_funcs.page_flip implementation
3411 * using the atomic driver interface.
3414 * Returns 0 on success, negative errno numbers on failure.
3417 * drm_atomic_helper_page_flip_target()
3419 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3420 struct drm_framebuffer *fb,
3421 struct drm_pending_vblank_event *event,
3423 struct drm_modeset_acquire_ctx *ctx)
3425 struct drm_plane *plane = crtc->primary;
3426 struct drm_atomic_state *state;
3429 state = drm_atomic_state_alloc(plane->dev);
3433 state->acquire_ctx = ctx;
3435 ret = page_flip_common(state, crtc, fb, event, flags);
3439 ret = drm_atomic_nonblocking_commit(state);
3441 drm_atomic_state_put(state);
3444 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3447 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3449 * @fb: DRM framebuffer
3450 * @event: optional DRM event to signal upon completion
3451 * @flags: flip flags for non-vblank sync'ed updates
3452 * @target: specifying the target vblank period when the flip to take effect
3453 * @ctx: lock acquisition context
3455 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3456 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3457 * target vblank period to flip.
3460 * Returns 0 on success, negative errno numbers on failure.
3462 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3463 struct drm_framebuffer *fb,
3464 struct drm_pending_vblank_event *event,
3467 struct drm_modeset_acquire_ctx *ctx)
3469 struct drm_plane *plane = crtc->primary;
3470 struct drm_atomic_state *state;
3471 struct drm_crtc_state *crtc_state;
3474 state = drm_atomic_state_alloc(plane->dev);
3478 state->acquire_ctx = ctx;
3480 ret = page_flip_common(state, crtc, fb, event, flags);
3484 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3485 if (WARN_ON(!crtc_state)) {
3489 crtc_state->target_vblank = target;
3491 ret = drm_atomic_nonblocking_commit(state);
3493 drm_atomic_state_put(state);
3496 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3499 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3500 * @crtc: CRTC object
3501 * @red: red correction table
3502 * @green: green correction table
3503 * @blue: green correction table
3504 * @size: size of the tables
3505 * @ctx: lock acquire context
3507 * Implements support for legacy gamma correction table for drivers
3508 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3509 * properties. See drm_crtc_enable_color_mgmt() and the containing chapter for
3510 * how the atomic color management and gamma tables work.
3512 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3513 u16 *red, u16 *green, u16 *blue,
3515 struct drm_modeset_acquire_ctx *ctx)
3517 struct drm_device *dev = crtc->dev;
3518 struct drm_atomic_state *state;
3519 struct drm_crtc_state *crtc_state;
3520 struct drm_property_blob *blob = NULL;
3521 struct drm_color_lut *blob_data;
3525 state = drm_atomic_state_alloc(crtc->dev);
3529 blob = drm_property_create_blob(dev,
3530 sizeof(struct drm_color_lut) * size,
3533 ret = PTR_ERR(blob);
3538 /* Prepare GAMMA_LUT with the legacy values. */
3539 blob_data = blob->data;
3540 for (i = 0; i < size; i++) {
3541 blob_data[i].red = red[i];
3542 blob_data[i].green = green[i];
3543 blob_data[i].blue = blue[i];
3546 state->acquire_ctx = ctx;
3547 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3548 if (IS_ERR(crtc_state)) {
3549 ret = PTR_ERR(crtc_state);
3553 /* Reset DEGAMMA_LUT and CTM properties. */
3554 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, NULL);
3555 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
3556 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, blob);
3557 crtc_state->color_mgmt_changed |= replaced;
3559 ret = drm_atomic_commit(state);
3562 drm_atomic_state_put(state);
3563 drm_property_blob_put(blob);
3566 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);
3569 * drm_atomic_helper_bridge_propagate_bus_fmt() - Propagate output format to
3570 * the input end of a bridge
3571 * @bridge: bridge control structure
3572 * @bridge_state: new bridge state
3573 * @crtc_state: new CRTC state
3574 * @conn_state: new connector state
3575 * @output_fmt: tested output bus format
3576 * @num_input_fmts: will contain the size of the returned array
3578 * This helper is a pluggable implementation of the
3579 * &drm_bridge_funcs.atomic_get_input_bus_fmts operation for bridges that don't
3580 * modify the bus configuration between their input and their output. It
3581 * returns an array of input formats with a single element set to @output_fmt.
3584 * a valid format array of size @num_input_fmts, or NULL if the allocation
3588 drm_atomic_helper_bridge_propagate_bus_fmt(struct drm_bridge *bridge,
3589 struct drm_bridge_state *bridge_state,
3590 struct drm_crtc_state *crtc_state,
3591 struct drm_connector_state *conn_state,
3593 unsigned int *num_input_fmts)
3597 input_fmts = kzalloc(sizeof(*input_fmts), GFP_KERNEL);
3599 *num_input_fmts = 0;
3603 *num_input_fmts = 1;
3604 input_fmts[0] = output_fmt;
3607 EXPORT_SYMBOL(drm_atomic_helper_bridge_propagate_bus_fmt);