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_plane_helper.h>
38 #include <drm/drm_print.h>
39 #include <drm/drm_self_refresh_helper.h>
40 #include <drm/drm_vblank.h>
41 #include <drm/drm_writeback.h>
43 #include "drm_crtc_helper_internal.h"
44 #include "drm_crtc_internal.h"
49 * This helper library provides implementations of check and commit functions on
50 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
51 * also provides convenience implementations for the atomic state handling
52 * callbacks for drivers which don't need to subclass the drm core structures to
53 * add their own additional internal state.
55 * This library also provides default implementations for the check callback in
56 * drm_atomic_helper_check() and for the commit callback with
57 * drm_atomic_helper_commit(). But the individual stages and callbacks are
58 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
59 * together with a driver private modeset implementation.
61 * This library also provides implementations for all the legacy driver
62 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
63 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
64 * various functions to implement set_property callbacks. New drivers must not
65 * implement these functions themselves but must use the provided helpers.
67 * The atomic helper uses the same function table structures as all other
68 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
69 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
70 * also shares the &struct drm_plane_helper_funcs function table with the plane
74 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
75 struct drm_plane_state *old_plane_state,
76 struct drm_plane_state *plane_state,
77 struct drm_plane *plane)
79 struct drm_crtc_state *crtc_state;
81 if (old_plane_state->crtc) {
82 crtc_state = drm_atomic_get_new_crtc_state(state,
83 old_plane_state->crtc);
85 if (WARN_ON(!crtc_state))
88 crtc_state->planes_changed = true;
91 if (plane_state->crtc) {
92 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
94 if (WARN_ON(!crtc_state))
97 crtc_state->planes_changed = true;
101 static int handle_conflicting_encoders(struct drm_atomic_state *state,
102 bool disable_conflicting_encoders)
104 struct drm_connector_state *new_conn_state;
105 struct drm_connector *connector;
106 struct drm_connector_list_iter conn_iter;
107 struct drm_encoder *encoder;
108 unsigned encoder_mask = 0;
112 * First loop, find all newly assigned encoders from the connectors
113 * part of the state. If the same encoder is assigned to multiple
114 * connectors bail out.
116 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
117 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
118 struct drm_encoder *new_encoder;
120 if (!new_conn_state->crtc)
123 if (funcs->atomic_best_encoder)
124 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
125 else if (funcs->best_encoder)
126 new_encoder = funcs->best_encoder(connector);
128 new_encoder = drm_connector_get_single_encoder(connector);
131 if (encoder_mask & drm_encoder_mask(new_encoder)) {
132 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
133 new_encoder->base.id, new_encoder->name,
134 connector->base.id, connector->name);
139 encoder_mask |= drm_encoder_mask(new_encoder);
147 * Second loop, iterate over all connectors not part of the state.
149 * If a conflicting encoder is found and disable_conflicting_encoders
150 * is not set, an error is returned. Userspace can provide a solution
151 * through the atomic ioctl.
153 * If the flag is set conflicting connectors are removed from the CRTC
154 * and the CRTC is disabled if no encoder is left. This preserves
155 * compatibility with the legacy set_config behavior.
157 drm_connector_list_iter_begin(state->dev, &conn_iter);
158 drm_for_each_connector_iter(connector, &conn_iter) {
159 struct drm_crtc_state *crtc_state;
161 if (drm_atomic_get_new_connector_state(state, connector))
164 encoder = connector->state->best_encoder;
165 if (!encoder || !(encoder_mask & drm_encoder_mask(encoder)))
168 if (!disable_conflicting_encoders) {
169 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
170 encoder->base.id, encoder->name,
171 connector->state->crtc->base.id,
172 connector->state->crtc->name,
173 connector->base.id, connector->name);
178 new_conn_state = drm_atomic_get_connector_state(state, connector);
179 if (IS_ERR(new_conn_state)) {
180 ret = PTR_ERR(new_conn_state);
184 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
185 encoder->base.id, encoder->name,
186 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
187 connector->base.id, connector->name);
189 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
191 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
195 if (!crtc_state->connector_mask) {
196 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
201 crtc_state->active = false;
205 drm_connector_list_iter_end(&conn_iter);
211 set_best_encoder(struct drm_atomic_state *state,
212 struct drm_connector_state *conn_state,
213 struct drm_encoder *encoder)
215 struct drm_crtc_state *crtc_state;
216 struct drm_crtc *crtc;
218 if (conn_state->best_encoder) {
219 /* Unset the encoder_mask in the old crtc state. */
220 crtc = conn_state->connector->state->crtc;
222 /* A NULL crtc is an error here because we should have
223 * duplicated a NULL best_encoder when crtc was NULL.
224 * As an exception restoring duplicated atomic state
225 * during resume is allowed, so don't warn when
226 * best_encoder is equal to encoder we intend to set.
228 WARN_ON(!crtc && encoder != conn_state->best_encoder);
230 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
232 crtc_state->encoder_mask &=
233 ~drm_encoder_mask(conn_state->best_encoder);
238 crtc = conn_state->crtc;
241 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
243 crtc_state->encoder_mask |=
244 drm_encoder_mask(encoder);
248 conn_state->best_encoder = encoder;
252 steal_encoder(struct drm_atomic_state *state,
253 struct drm_encoder *encoder)
255 struct drm_crtc_state *crtc_state;
256 struct drm_connector *connector;
257 struct drm_connector_state *old_connector_state, *new_connector_state;
260 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
261 struct drm_crtc *encoder_crtc;
263 if (new_connector_state->best_encoder != encoder)
266 encoder_crtc = old_connector_state->crtc;
268 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
269 encoder->base.id, encoder->name,
270 encoder_crtc->base.id, encoder_crtc->name);
272 set_best_encoder(state, new_connector_state, NULL);
274 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
275 crtc_state->connectors_changed = true;
282 update_connector_routing(struct drm_atomic_state *state,
283 struct drm_connector *connector,
284 struct drm_connector_state *old_connector_state,
285 struct drm_connector_state *new_connector_state)
287 const struct drm_connector_helper_funcs *funcs;
288 struct drm_encoder *new_encoder;
289 struct drm_crtc_state *crtc_state;
291 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
295 if (old_connector_state->crtc != new_connector_state->crtc) {
296 if (old_connector_state->crtc) {
297 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
298 crtc_state->connectors_changed = true;
301 if (new_connector_state->crtc) {
302 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
303 crtc_state->connectors_changed = true;
307 if (!new_connector_state->crtc) {
308 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
312 set_best_encoder(state, new_connector_state, NULL);
317 crtc_state = drm_atomic_get_new_crtc_state(state,
318 new_connector_state->crtc);
320 * For compatibility with legacy users, we want to make sure that
321 * we allow DPMS On->Off modesets on unregistered connectors. Modesets
322 * which would result in anything else must be considered invalid, to
323 * avoid turning on new displays on dead connectors.
325 * Since the connector can be unregistered at any point during an
326 * atomic check or commit, this is racy. But that's OK: all we care
327 * about is ensuring that userspace can't do anything but shut off the
328 * display on a connector that was destroyed after it's been notified,
331 * Additionally, we also want to ignore connector registration when
332 * we're trying to restore an atomic state during system resume since
333 * there's a chance the connector may have been destroyed during the
334 * process, but it's better to ignore that then cause
335 * drm_atomic_helper_resume() to fail.
337 if (!state->duplicated && drm_connector_is_unregistered(connector) &&
338 crtc_state->active) {
339 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
340 connector->base.id, connector->name);
344 funcs = connector->helper_private;
346 if (funcs->atomic_best_encoder)
347 new_encoder = funcs->atomic_best_encoder(connector,
348 new_connector_state);
349 else if (funcs->best_encoder)
350 new_encoder = funcs->best_encoder(connector);
352 new_encoder = drm_connector_get_single_encoder(connector);
355 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
361 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
362 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
363 new_encoder->base.id,
365 new_connector_state->crtc->base.id,
366 new_connector_state->crtc->name);
370 if (new_encoder == new_connector_state->best_encoder) {
371 set_best_encoder(state, new_connector_state, new_encoder);
373 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
376 new_encoder->base.id,
378 new_connector_state->crtc->base.id,
379 new_connector_state->crtc->name);
384 steal_encoder(state, new_encoder);
386 set_best_encoder(state, new_connector_state, new_encoder);
388 crtc_state->connectors_changed = true;
390 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
393 new_encoder->base.id,
395 new_connector_state->crtc->base.id,
396 new_connector_state->crtc->name);
402 mode_fixup(struct drm_atomic_state *state)
404 struct drm_crtc *crtc;
405 struct drm_crtc_state *new_crtc_state;
406 struct drm_connector *connector;
407 struct drm_connector_state *new_conn_state;
411 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
412 if (!new_crtc_state->mode_changed &&
413 !new_crtc_state->connectors_changed)
416 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
419 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
420 const struct drm_encoder_helper_funcs *funcs;
421 struct drm_encoder *encoder;
422 struct drm_bridge *bridge;
424 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
426 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
430 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
433 * Each encoder has at most one connector (since we always steal
434 * it away), so we won't call ->mode_fixup twice.
436 encoder = new_conn_state->best_encoder;
437 funcs = encoder->helper_private;
439 bridge = drm_bridge_chain_get_first_bridge(encoder);
440 ret = drm_atomic_bridge_chain_check(bridge,
444 DRM_DEBUG_ATOMIC("Bridge atomic check failed\n");
448 if (funcs && funcs->atomic_check) {
449 ret = funcs->atomic_check(encoder, new_crtc_state,
452 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
453 encoder->base.id, encoder->name);
456 } else if (funcs && funcs->mode_fixup) {
457 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
458 &new_crtc_state->adjusted_mode);
460 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
461 encoder->base.id, encoder->name);
467 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
468 const struct drm_crtc_helper_funcs *funcs;
470 if (!new_crtc_state->enable)
473 if (!new_crtc_state->mode_changed &&
474 !new_crtc_state->connectors_changed)
477 funcs = crtc->helper_private;
478 if (!funcs || !funcs->mode_fixup)
481 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
482 &new_crtc_state->adjusted_mode);
484 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
485 crtc->base.id, crtc->name);
493 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
494 struct drm_encoder *encoder,
495 struct drm_crtc *crtc,
496 const struct drm_display_mode *mode)
498 struct drm_bridge *bridge;
499 enum drm_mode_status ret;
501 ret = drm_encoder_mode_valid(encoder, mode);
502 if (ret != MODE_OK) {
503 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
504 encoder->base.id, encoder->name);
508 bridge = drm_bridge_chain_get_first_bridge(encoder);
509 ret = drm_bridge_chain_mode_valid(bridge, mode);
510 if (ret != MODE_OK) {
511 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
515 ret = drm_crtc_mode_valid(crtc, mode);
516 if (ret != MODE_OK) {
517 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
518 crtc->base.id, crtc->name);
526 mode_valid(struct drm_atomic_state *state)
528 struct drm_connector_state *conn_state;
529 struct drm_connector *connector;
532 for_each_new_connector_in_state(state, connector, conn_state, i) {
533 struct drm_encoder *encoder = conn_state->best_encoder;
534 struct drm_crtc *crtc = conn_state->crtc;
535 struct drm_crtc_state *crtc_state;
536 enum drm_mode_status mode_status;
537 const struct drm_display_mode *mode;
539 if (!crtc || !encoder)
542 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
545 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
548 mode = &crtc_state->mode;
550 mode_status = mode_valid_path(connector, encoder, crtc, mode);
551 if (mode_status != MODE_OK)
559 * drm_atomic_helper_check_modeset - validate state object for modeset changes
561 * @state: the driver state object
563 * Check the state object to see if the requested state is physically possible.
564 * This does all the CRTC and connector related computations for an atomic
565 * update and adds any additional connectors needed for full modesets. It calls
566 * the various per-object callbacks in the follow order:
568 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
569 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
570 * 3. If it's determined a modeset is needed then all connectors on the affected
571 * CRTC are added and &drm_connector_helper_funcs.atomic_check is run on them.
572 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
573 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
574 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
575 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
576 * This function is only called when the encoder will be part of a configured CRTC,
577 * it must not be used for implementing connector property validation.
578 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
580 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with CRTC constraints.
582 * &drm_crtc_state.mode_changed is set when the input mode is changed.
583 * &drm_crtc_state.connectors_changed is set when a connector is added or
584 * removed from the CRTC. &drm_crtc_state.active_changed is set when
585 * &drm_crtc_state.active changes, which is used for DPMS.
586 * See also: drm_atomic_crtc_needs_modeset()
590 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
591 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
592 * without a full modeset) _must_ call this function afterwards after that
593 * change. It is permitted to call this function multiple times for the same
594 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
595 * upon the adjusted dotclock for fifo space allocation and watermark
599 * Zero for success or -errno
602 drm_atomic_helper_check_modeset(struct drm_device *dev,
603 struct drm_atomic_state *state)
605 struct drm_crtc *crtc;
606 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
607 struct drm_connector *connector;
608 struct drm_connector_state *old_connector_state, *new_connector_state;
610 unsigned connectors_mask = 0;
612 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
613 bool has_connectors =
614 !!new_crtc_state->connector_mask;
616 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
618 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
619 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
620 crtc->base.id, crtc->name);
621 new_crtc_state->mode_changed = true;
624 if (old_crtc_state->enable != new_crtc_state->enable) {
625 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
626 crtc->base.id, crtc->name);
629 * For clarity this assignment is done here, but
630 * enable == 0 is only true when there are no
631 * connectors and a NULL mode.
633 * The other way around is true as well. enable != 0
634 * iff connectors are attached and a mode is set.
636 new_crtc_state->mode_changed = true;
637 new_crtc_state->connectors_changed = true;
640 if (old_crtc_state->active != new_crtc_state->active) {
641 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
642 crtc->base.id, crtc->name);
643 new_crtc_state->active_changed = true;
646 if (new_crtc_state->enable != has_connectors) {
647 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
648 crtc->base.id, crtc->name);
654 ret = handle_conflicting_encoders(state, false);
658 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
659 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
661 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
664 * This only sets crtc->connectors_changed for routing changes,
665 * drivers must set crtc->connectors_changed themselves when
666 * connector properties need to be updated.
668 ret = update_connector_routing(state, connector,
670 new_connector_state);
673 if (old_connector_state->crtc) {
674 new_crtc_state = drm_atomic_get_new_crtc_state(state,
675 old_connector_state->crtc);
676 if (old_connector_state->link_status !=
677 new_connector_state->link_status)
678 new_crtc_state->connectors_changed = true;
680 if (old_connector_state->max_requested_bpc !=
681 new_connector_state->max_requested_bpc)
682 new_crtc_state->connectors_changed = true;
685 if (funcs->atomic_check)
686 ret = funcs->atomic_check(connector, state);
690 connectors_mask |= BIT(i);
694 * After all the routing has been prepared we need to add in any
695 * connector which is itself unchanged, but whose CRTC changes its
696 * configuration. This must be done before calling mode_fixup in case a
697 * crtc only changed its mode but has the same set of connectors.
699 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
700 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
703 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
704 crtc->base.id, crtc->name,
705 new_crtc_state->enable ? 'y' : 'n',
706 new_crtc_state->active ? 'y' : 'n');
708 ret = drm_atomic_add_affected_connectors(state, crtc);
712 ret = drm_atomic_add_affected_planes(state, crtc);
718 * Iterate over all connectors again, to make sure atomic_check()
719 * has been called on them when a modeset is forced.
721 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
722 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
724 if (connectors_mask & BIT(i))
727 if (funcs->atomic_check)
728 ret = funcs->atomic_check(connector, state);
734 * Iterate over all connectors again, and add all affected bridges to
737 for_each_oldnew_connector_in_state(state, connector,
739 new_connector_state, i) {
740 struct drm_encoder *encoder;
742 encoder = old_connector_state->best_encoder;
743 ret = drm_atomic_add_encoder_bridges(state, encoder);
747 encoder = new_connector_state->best_encoder;
748 ret = drm_atomic_add_encoder_bridges(state, encoder);
753 ret = mode_valid(state);
757 return mode_fixup(state);
759 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
762 * drm_atomic_helper_check_plane_state() - Check plane state for validity
763 * @plane_state: plane state to check
764 * @crtc_state: CRTC state to check
765 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
766 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
767 * @can_position: is it legal to position the plane such that it
768 * doesn't cover the entire CRTC? This will generally
769 * only be false for primary planes.
770 * @can_update_disabled: can the plane be updated while the CRTC
773 * Checks that a desired plane update is valid, and updates various
774 * bits of derived state (clipped coordinates etc.). Drivers that provide
775 * their own plane handling rather than helper-provided implementations may
776 * still wish to call this function to avoid duplication of error checking
780 * Zero if update appears valid, error code on failure
782 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
783 const struct drm_crtc_state *crtc_state,
787 bool can_update_disabled)
789 struct drm_framebuffer *fb = plane_state->fb;
790 struct drm_rect *src = &plane_state->src;
791 struct drm_rect *dst = &plane_state->dst;
792 unsigned int rotation = plane_state->rotation;
793 struct drm_rect clip = {};
796 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
798 *src = drm_plane_state_src(plane_state);
799 *dst = drm_plane_state_dest(plane_state);
802 plane_state->visible = false;
806 /* crtc should only be NULL when disabling (i.e., !fb) */
807 if (WARN_ON(!plane_state->crtc)) {
808 plane_state->visible = false;
812 if (!crtc_state->enable && !can_update_disabled) {
813 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
817 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
820 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
821 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
822 if (hscale < 0 || vscale < 0) {
823 DRM_DEBUG_KMS("Invalid scaling of plane\n");
824 drm_rect_debug_print("src: ", &plane_state->src, true);
825 drm_rect_debug_print("dst: ", &plane_state->dst, false);
829 if (crtc_state->enable)
830 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
832 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
834 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
836 if (!plane_state->visible)
838 * Plane isn't visible; some drivers can handle this
839 * so we just return success here. Drivers that can't
840 * (including those that use the primary plane helper's
841 * update function) will return an error from their
842 * update_plane handler.
846 if (!can_position && !drm_rect_equals(dst, &clip)) {
847 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
848 drm_rect_debug_print("dst: ", dst, false);
849 drm_rect_debug_print("clip: ", &clip, false);
855 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
858 * drm_atomic_helper_check_planes - validate state object for planes changes
860 * @state: the driver state object
862 * Check the state object to see if the requested state is physically possible.
863 * This does all the plane update related checks using by calling into the
864 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
865 * hooks provided by the driver.
867 * It also sets &drm_crtc_state.planes_changed to indicate that a CRTC has
871 * Zero for success or -errno
874 drm_atomic_helper_check_planes(struct drm_device *dev,
875 struct drm_atomic_state *state)
877 struct drm_crtc *crtc;
878 struct drm_crtc_state *new_crtc_state;
879 struct drm_plane *plane;
880 struct drm_plane_state *new_plane_state, *old_plane_state;
883 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
884 const struct drm_plane_helper_funcs *funcs;
886 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
888 funcs = plane->helper_private;
890 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
892 drm_atomic_helper_check_plane_damage(state, new_plane_state);
894 if (!funcs || !funcs->atomic_check)
897 ret = funcs->atomic_check(plane, new_plane_state);
899 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
900 plane->base.id, plane->name);
905 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
906 const struct drm_crtc_helper_funcs *funcs;
908 funcs = crtc->helper_private;
910 if (!funcs || !funcs->atomic_check)
913 ret = funcs->atomic_check(crtc, new_crtc_state);
915 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
916 crtc->base.id, crtc->name);
923 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
926 * drm_atomic_helper_check - validate state object
928 * @state: the driver state object
930 * Check the state object to see if the requested state is physically possible.
931 * Only CRTCs and planes have check callbacks, so for any additional (global)
932 * checking that a driver needs it can simply wrap that around this function.
933 * Drivers without such needs can directly use this as their
934 * &drm_mode_config_funcs.atomic_check callback.
936 * This just wraps the two parts of the state checking for planes and modeset
937 * state in the default order: First it calls drm_atomic_helper_check_modeset()
938 * and then drm_atomic_helper_check_planes(). The assumption is that the
939 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
940 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
943 * Note that zpos normalization will add all enable planes to the state which
944 * might not desired for some drivers.
945 * For example enable/disable of a cursor plane which have fixed zpos value
946 * would trigger all other enabled planes to be forced to the state change.
949 * Zero for success or -errno
951 int drm_atomic_helper_check(struct drm_device *dev,
952 struct drm_atomic_state *state)
956 ret = drm_atomic_helper_check_modeset(dev, state);
960 if (dev->mode_config.normalize_zpos) {
961 ret = drm_atomic_normalize_zpos(dev, state);
966 ret = drm_atomic_helper_check_planes(dev, state);
970 if (state->legacy_cursor_update)
971 state->async_update = !drm_atomic_helper_async_check(dev, state);
973 drm_self_refresh_helper_alter_state(state);
977 EXPORT_SYMBOL(drm_atomic_helper_check);
980 crtc_needs_disable(struct drm_crtc_state *old_state,
981 struct drm_crtc_state *new_state)
984 * No new_state means the CRTC is off, so the only criteria is whether
985 * it's currently active or in self refresh mode.
988 return drm_atomic_crtc_effectively_active(old_state);
991 * We need to run through the crtc_funcs->disable() function if the CRTC
992 * is currently on, if it's transitioning to self refresh mode, or if
993 * it's in self refresh mode and needs to be fully disabled.
995 return old_state->active ||
996 (old_state->self_refresh_active && !new_state->enable) ||
997 new_state->self_refresh_active;
1001 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
1003 struct drm_connector *connector;
1004 struct drm_connector_state *old_conn_state, *new_conn_state;
1005 struct drm_crtc *crtc;
1006 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1009 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1010 const struct drm_encoder_helper_funcs *funcs;
1011 struct drm_encoder *encoder;
1012 struct drm_bridge *bridge;
1014 /* Shut down everything that's in the changeset and currently
1015 * still on. So need to check the old, saved state. */
1016 if (!old_conn_state->crtc)
1019 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
1021 if (new_conn_state->crtc)
1022 new_crtc_state = drm_atomic_get_new_crtc_state(
1024 new_conn_state->crtc);
1026 new_crtc_state = NULL;
1028 if (!crtc_needs_disable(old_crtc_state, new_crtc_state) ||
1029 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
1032 encoder = old_conn_state->best_encoder;
1034 /* We shouldn't get this far if we didn't previously have
1035 * an encoder.. but WARN_ON() rather than explode.
1037 if (WARN_ON(!encoder))
1040 funcs = encoder->helper_private;
1042 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
1043 encoder->base.id, encoder->name);
1046 * Each encoder has at most one connector (since we always steal
1047 * it away), so we won't call disable hooks twice.
1049 bridge = drm_bridge_chain_get_first_bridge(encoder);
1050 drm_atomic_bridge_chain_disable(bridge, old_state);
1052 /* Right function depends upon target state. */
1054 if (funcs->atomic_disable)
1055 funcs->atomic_disable(encoder, old_state);
1056 else if (new_conn_state->crtc && funcs->prepare)
1057 funcs->prepare(encoder);
1058 else if (funcs->disable)
1059 funcs->disable(encoder);
1060 else if (funcs->dpms)
1061 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1064 drm_atomic_bridge_chain_post_disable(bridge, old_state);
1067 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1068 const struct drm_crtc_helper_funcs *funcs;
1071 /* Shut down everything that needs a full modeset. */
1072 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1075 if (!crtc_needs_disable(old_crtc_state, new_crtc_state))
1078 funcs = crtc->helper_private;
1080 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1081 crtc->base.id, crtc->name);
1084 /* Right function depends upon target state. */
1085 if (new_crtc_state->enable && funcs->prepare)
1086 funcs->prepare(crtc);
1087 else if (funcs->atomic_disable)
1088 funcs->atomic_disable(crtc, old_crtc_state);
1089 else if (funcs->disable)
1090 funcs->disable(crtc);
1091 else if (funcs->dpms)
1092 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1094 if (!(dev->irq_enabled && dev->num_crtcs))
1097 ret = drm_crtc_vblank_get(crtc);
1098 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1100 drm_crtc_vblank_put(crtc);
1105 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1107 * @old_state: atomic state object with old state structures
1109 * This function updates all the various legacy modeset state pointers in
1110 * connectors, encoders and CRTCs. It also updates the timestamping constants
1111 * used for precise vblank timestamps by calling
1112 * drm_calc_timestamping_constants().
1114 * Drivers can use this for building their own atomic commit if they don't have
1115 * a pure helper-based modeset implementation.
1117 * Since these updates are not synchronized with lockings, only code paths
1118 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1119 * legacy state filled out by this helper. Defacto this means this helper and
1120 * the legacy state pointers are only really useful for transitioning an
1121 * existing driver to the atomic world.
1124 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1125 struct drm_atomic_state *old_state)
1127 struct drm_connector *connector;
1128 struct drm_connector_state *old_conn_state, *new_conn_state;
1129 struct drm_crtc *crtc;
1130 struct drm_crtc_state *new_crtc_state;
1133 /* clear out existing links and update dpms */
1134 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1135 if (connector->encoder) {
1136 WARN_ON(!connector->encoder->crtc);
1138 connector->encoder->crtc = NULL;
1139 connector->encoder = NULL;
1142 crtc = new_conn_state->crtc;
1143 if ((!crtc && old_conn_state->crtc) ||
1144 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1145 int mode = DRM_MODE_DPMS_OFF;
1147 if (crtc && crtc->state->active)
1148 mode = DRM_MODE_DPMS_ON;
1150 connector->dpms = mode;
1155 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1156 if (!new_conn_state->crtc)
1159 if (WARN_ON(!new_conn_state->best_encoder))
1162 connector->encoder = new_conn_state->best_encoder;
1163 connector->encoder->crtc = new_conn_state->crtc;
1166 /* set legacy state in the crtc structure */
1167 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1168 struct drm_plane *primary = crtc->primary;
1169 struct drm_plane_state *new_plane_state;
1171 crtc->mode = new_crtc_state->mode;
1172 crtc->enabled = new_crtc_state->enable;
1175 drm_atomic_get_new_plane_state(old_state, primary);
1177 if (new_plane_state && new_plane_state->crtc == crtc) {
1178 crtc->x = new_plane_state->src_x >> 16;
1179 crtc->y = new_plane_state->src_y >> 16;
1182 if (new_crtc_state->enable)
1183 drm_calc_timestamping_constants(crtc,
1184 &new_crtc_state->adjusted_mode);
1187 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1190 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1192 struct drm_crtc *crtc;
1193 struct drm_crtc_state *new_crtc_state;
1194 struct drm_connector *connector;
1195 struct drm_connector_state *new_conn_state;
1198 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1199 const struct drm_crtc_helper_funcs *funcs;
1201 if (!new_crtc_state->mode_changed)
1204 funcs = crtc->helper_private;
1206 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1207 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1208 crtc->base.id, crtc->name);
1210 funcs->mode_set_nofb(crtc);
1214 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1215 const struct drm_encoder_helper_funcs *funcs;
1216 struct drm_encoder *encoder;
1217 struct drm_display_mode *mode, *adjusted_mode;
1218 struct drm_bridge *bridge;
1220 if (!new_conn_state->best_encoder)
1223 encoder = new_conn_state->best_encoder;
1224 funcs = encoder->helper_private;
1225 new_crtc_state = new_conn_state->crtc->state;
1226 mode = &new_crtc_state->mode;
1227 adjusted_mode = &new_crtc_state->adjusted_mode;
1229 if (!new_crtc_state->mode_changed)
1232 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1233 encoder->base.id, encoder->name);
1236 * Each encoder has at most one connector (since we always steal
1237 * it away), so we won't call mode_set hooks twice.
1239 if (funcs && funcs->atomic_mode_set) {
1240 funcs->atomic_mode_set(encoder, new_crtc_state,
1242 } else if (funcs && funcs->mode_set) {
1243 funcs->mode_set(encoder, mode, adjusted_mode);
1246 bridge = drm_bridge_chain_get_first_bridge(encoder);
1247 drm_bridge_chain_mode_set(bridge, mode, adjusted_mode);
1252 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1254 * @old_state: atomic state object with old state structures
1256 * This function shuts down all the outputs that need to be shut down and
1257 * prepares them (if required) with the new mode.
1259 * For compatibility with legacy CRTC helpers this should be called before
1260 * drm_atomic_helper_commit_planes(), which is what the default commit function
1261 * does. But drivers with different needs can group the modeset commits together
1262 * and do the plane commits at the end. This is useful for drivers doing runtime
1263 * PM since planes updates then only happen when the CRTC is actually enabled.
1265 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1266 struct drm_atomic_state *old_state)
1268 disable_outputs(dev, old_state);
1270 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1272 crtc_set_mode(dev, old_state);
1274 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1276 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1277 struct drm_atomic_state *old_state)
1279 struct drm_connector *connector;
1280 struct drm_connector_state *new_conn_state;
1283 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1284 const struct drm_connector_helper_funcs *funcs;
1286 funcs = connector->helper_private;
1287 if (!funcs->atomic_commit)
1290 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1291 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1292 funcs->atomic_commit(connector, new_conn_state);
1298 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1300 * @old_state: atomic state object with old state structures
1302 * This function enables all the outputs with the new configuration which had to
1303 * be turned off for the update.
1305 * For compatibility with legacy CRTC helpers this should be called after
1306 * drm_atomic_helper_commit_planes(), which is what the default commit function
1307 * does. But drivers with different needs can group the modeset commits together
1308 * and do the plane commits at the end. This is useful for drivers doing runtime
1309 * PM since planes updates then only happen when the CRTC is actually enabled.
1311 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1312 struct drm_atomic_state *old_state)
1314 struct drm_crtc *crtc;
1315 struct drm_crtc_state *old_crtc_state;
1316 struct drm_crtc_state *new_crtc_state;
1317 struct drm_connector *connector;
1318 struct drm_connector_state *new_conn_state;
1321 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1322 const struct drm_crtc_helper_funcs *funcs;
1324 /* Need to filter out CRTCs where only planes change. */
1325 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1328 if (!new_crtc_state->active)
1331 funcs = crtc->helper_private;
1333 if (new_crtc_state->enable) {
1334 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1335 crtc->base.id, crtc->name);
1336 if (funcs->atomic_enable)
1337 funcs->atomic_enable(crtc, old_crtc_state);
1338 else if (funcs->commit)
1339 funcs->commit(crtc);
1343 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1344 const struct drm_encoder_helper_funcs *funcs;
1345 struct drm_encoder *encoder;
1346 struct drm_bridge *bridge;
1348 if (!new_conn_state->best_encoder)
1351 if (!new_conn_state->crtc->state->active ||
1352 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1355 encoder = new_conn_state->best_encoder;
1356 funcs = encoder->helper_private;
1358 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1359 encoder->base.id, encoder->name);
1362 * Each encoder has at most one connector (since we always steal
1363 * it away), so we won't call enable hooks twice.
1365 bridge = drm_bridge_chain_get_first_bridge(encoder);
1366 drm_atomic_bridge_chain_pre_enable(bridge, old_state);
1369 if (funcs->atomic_enable)
1370 funcs->atomic_enable(encoder, old_state);
1371 else if (funcs->enable)
1372 funcs->enable(encoder);
1373 else if (funcs->commit)
1374 funcs->commit(encoder);
1377 drm_atomic_bridge_chain_enable(bridge, old_state);
1380 drm_atomic_helper_commit_writebacks(dev, old_state);
1382 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1385 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1387 * @state: atomic state object with old state structures
1388 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1389 * Otherwise @state is the old state.
1391 * For implicit sync, driver should fish the exclusive fence out from the
1392 * incoming fb's and stash it in the drm_plane_state. This is called after
1393 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1394 * just uses the atomic state to find the changed planes)
1396 * Note that @pre_swap is needed since the point where we block for fences moves
1397 * around depending upon whether an atomic commit is blocking or
1398 * non-blocking. For non-blocking commit all waiting needs to happen after
1399 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1400 * to wait **before** we do anything that can't be easily rolled back. That is
1401 * before we call drm_atomic_helper_swap_state().
1403 * Returns zero if success or < 0 if dma_fence_wait() fails.
1405 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1406 struct drm_atomic_state *state,
1409 struct drm_plane *plane;
1410 struct drm_plane_state *new_plane_state;
1413 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1414 if (!new_plane_state->fence)
1417 WARN_ON(!new_plane_state->fb);
1420 * If waiting for fences pre-swap (ie: nonblock), userspace can
1421 * still interrupt the operation. Instead of blocking until the
1422 * timer expires, make the wait interruptible.
1424 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1428 dma_fence_put(new_plane_state->fence);
1429 new_plane_state->fence = NULL;
1434 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1437 * drm_atomic_helper_wait_for_vblanks - wait for vblank on CRTCs
1439 * @old_state: atomic state object with old state structures
1441 * Helper to, after atomic commit, wait for vblanks on all affected
1442 * CRTCs (ie. before cleaning up old framebuffers using
1443 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1444 * framebuffers have actually changed to optimize for the legacy cursor and
1445 * plane update use-case.
1447 * Drivers using the nonblocking commit tracking support initialized by calling
1448 * drm_atomic_helper_setup_commit() should look at
1449 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1452 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1453 struct drm_atomic_state *old_state)
1455 struct drm_crtc *crtc;
1456 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1458 unsigned crtc_mask = 0;
1461 * Legacy cursor ioctls are completely unsynced, and userspace
1462 * relies on that (by doing tons of cursor updates).
1464 if (old_state->legacy_cursor_update)
1467 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1468 if (!new_crtc_state->active)
1471 ret = drm_crtc_vblank_get(crtc);
1475 crtc_mask |= drm_crtc_mask(crtc);
1476 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1479 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1480 if (!(crtc_mask & drm_crtc_mask(crtc)))
1483 ret = wait_event_timeout(dev->vblank[i].queue,
1484 old_state->crtcs[i].last_vblank_count !=
1485 drm_crtc_vblank_count(crtc),
1486 msecs_to_jiffies(100));
1488 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1489 crtc->base.id, crtc->name);
1491 drm_crtc_vblank_put(crtc);
1494 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1497 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1499 * @old_state: atomic state object with old state structures
1501 * Helper to, after atomic commit, wait for page flips on all affected
1502 * crtcs (ie. before cleaning up old framebuffers using
1503 * drm_atomic_helper_cleanup_planes()). Compared to
1504 * drm_atomic_helper_wait_for_vblanks() this waits for the completion on all
1505 * CRTCs, assuming that cursors-only updates are signalling their completion
1506 * immediately (or using a different path).
1508 * This requires that drivers use the nonblocking commit tracking support
1509 * initialized using drm_atomic_helper_setup_commit().
1511 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1512 struct drm_atomic_state *old_state)
1514 struct drm_crtc *crtc;
1517 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1518 struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1521 crtc = old_state->crtcs[i].ptr;
1523 if (!crtc || !commit)
1526 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1528 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1529 crtc->base.id, crtc->name);
1532 if (old_state->fake_commit)
1533 complete_all(&old_state->fake_commit->flip_done);
1535 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1538 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1539 * @old_state: atomic state object with old state structures
1541 * This is the default implementation for the
1542 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1543 * that do not support runtime_pm or do not need the CRTC to be
1544 * enabled to perform a commit. Otherwise, see
1545 * drm_atomic_helper_commit_tail_rpm().
1547 * Note that the default ordering of how the various stages are called is to
1548 * match the legacy modeset helper library closest.
1550 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1552 struct drm_device *dev = old_state->dev;
1554 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1556 drm_atomic_helper_commit_planes(dev, old_state, 0);
1558 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1560 drm_atomic_helper_fake_vblank(old_state);
1562 drm_atomic_helper_commit_hw_done(old_state);
1564 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1566 drm_atomic_helper_cleanup_planes(dev, old_state);
1568 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1571 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1572 * @old_state: new modeset state to be committed
1574 * This is an alternative implementation for the
1575 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1576 * that support runtime_pm or need the CRTC to be enabled to perform a
1577 * commit. Otherwise, one should use the default implementation
1578 * drm_atomic_helper_commit_tail().
1580 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1582 struct drm_device *dev = old_state->dev;
1584 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1586 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1588 drm_atomic_helper_commit_planes(dev, old_state,
1589 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1591 drm_atomic_helper_fake_vblank(old_state);
1593 drm_atomic_helper_commit_hw_done(old_state);
1595 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1597 drm_atomic_helper_cleanup_planes(dev, old_state);
1599 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1601 static void commit_tail(struct drm_atomic_state *old_state)
1603 struct drm_device *dev = old_state->dev;
1604 const struct drm_mode_config_helper_funcs *funcs;
1605 struct drm_crtc_state *new_crtc_state;
1606 struct drm_crtc *crtc;
1609 unsigned int i, new_self_refresh_mask = 0;
1611 funcs = dev->mode_config.helper_private;
1614 * We're measuring the _entire_ commit, so the time will vary depending
1615 * on how many fences and objects are involved. For the purposes of self
1616 * refresh, this is desirable since it'll give us an idea of how
1617 * congested things are. This will inform our decision on how often we
1618 * should enter self refresh after idle.
1620 * These times will be averaged out in the self refresh helpers to avoid
1621 * overreacting over one outlier frame
1623 start = ktime_get();
1625 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1627 drm_atomic_helper_wait_for_dependencies(old_state);
1630 * We cannot safely access new_crtc_state after
1631 * drm_atomic_helper_commit_hw_done() so figure out which crtc's have
1632 * self-refresh active beforehand:
1634 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i)
1635 if (new_crtc_state->self_refresh_active)
1636 new_self_refresh_mask |= BIT(i);
1638 if (funcs && funcs->atomic_commit_tail)
1639 funcs->atomic_commit_tail(old_state);
1641 drm_atomic_helper_commit_tail(old_state);
1643 commit_time_ms = ktime_ms_delta(ktime_get(), start);
1644 if (commit_time_ms > 0)
1645 drm_self_refresh_helper_update_avg_times(old_state,
1646 (unsigned long)commit_time_ms,
1647 new_self_refresh_mask);
1649 drm_atomic_helper_commit_cleanup_done(old_state);
1651 drm_atomic_state_put(old_state);
1654 static void commit_work(struct work_struct *work)
1656 struct drm_atomic_state *state = container_of(work,
1657 struct drm_atomic_state,
1663 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1665 * @state: the driver state object
1667 * This helper will check if it is possible to commit the state asynchronously.
1668 * Async commits are not supposed to swap the states like normal sync commits
1669 * but just do in-place changes on the current state.
1671 * It will return 0 if the commit can happen in an asynchronous fashion or error
1672 * if not. Note that error just mean it can't be commited asynchronously, if it
1673 * fails the commit should be treated like a normal synchronous commit.
1675 int drm_atomic_helper_async_check(struct drm_device *dev,
1676 struct drm_atomic_state *state)
1678 struct drm_crtc *crtc;
1679 struct drm_crtc_state *crtc_state;
1680 struct drm_plane *plane = NULL;
1681 struct drm_plane_state *old_plane_state = NULL;
1682 struct drm_plane_state *new_plane_state = NULL;
1683 const struct drm_plane_helper_funcs *funcs;
1684 int i, n_planes = 0;
1686 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1687 if (drm_atomic_crtc_needs_modeset(crtc_state))
1691 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1694 /* FIXME: we support only single plane updates for now */
1698 if (!new_plane_state->crtc ||
1699 old_plane_state->crtc != new_plane_state->crtc)
1702 funcs = plane->helper_private;
1703 if (!funcs->atomic_async_update)
1706 if (new_plane_state->fence)
1710 * Don't do an async update if there is an outstanding commit modifying
1711 * the plane. This prevents our async update's changes from getting
1712 * overridden by a previous synchronous update's state.
1714 if (old_plane_state->commit &&
1715 !try_wait_for_completion(&old_plane_state->commit->hw_done))
1718 return funcs->atomic_async_check(plane, new_plane_state);
1720 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1723 * drm_atomic_helper_async_commit - commit state asynchronously
1725 * @state: the driver state object
1727 * This function commits a state asynchronously, i.e., not vblank
1728 * synchronized. It should be used on a state only when
1729 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1730 * the states like normal sync commits, but just do in-place changes on the
1733 * TODO: Implement full swap instead of doing in-place changes.
1735 void drm_atomic_helper_async_commit(struct drm_device *dev,
1736 struct drm_atomic_state *state)
1738 struct drm_plane *plane;
1739 struct drm_plane_state *plane_state;
1740 const struct drm_plane_helper_funcs *funcs;
1743 for_each_new_plane_in_state(state, plane, plane_state, i) {
1744 struct drm_framebuffer *new_fb = plane_state->fb;
1745 struct drm_framebuffer *old_fb = plane->state->fb;
1747 funcs = plane->helper_private;
1748 funcs->atomic_async_update(plane, plane_state);
1751 * ->atomic_async_update() is supposed to update the
1752 * plane->state in-place, make sure at least common
1753 * properties have been properly updated.
1755 WARN_ON_ONCE(plane->state->fb != new_fb);
1756 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1757 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1758 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1759 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1762 * Make sure the FBs have been swapped so that cleanups in the
1763 * new_state performs a cleanup in the old FB.
1765 WARN_ON_ONCE(plane_state->fb != old_fb);
1768 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1771 * drm_atomic_helper_commit - commit validated state object
1773 * @state: the driver state object
1774 * @nonblock: whether nonblocking behavior is requested.
1776 * This function commits a with drm_atomic_helper_check() pre-validated state
1777 * object. This can still fail when e.g. the framebuffer reservation fails. This
1778 * function implements nonblocking commits, using
1779 * drm_atomic_helper_setup_commit() and related functions.
1781 * Committing the actual hardware state is done through the
1782 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1783 * implementation drm_atomic_helper_commit_tail().
1786 * Zero for success or -errno.
1788 int drm_atomic_helper_commit(struct drm_device *dev,
1789 struct drm_atomic_state *state,
1794 if (state->async_update) {
1795 ret = drm_atomic_helper_prepare_planes(dev, state);
1799 drm_atomic_helper_async_commit(dev, state);
1800 drm_atomic_helper_cleanup_planes(dev, state);
1805 ret = drm_atomic_helper_setup_commit(state, nonblock);
1809 INIT_WORK(&state->commit_work, commit_work);
1811 ret = drm_atomic_helper_prepare_planes(dev, state);
1816 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1822 * This is the point of no return - everything below never fails except
1823 * when the hw goes bonghits. Which means we can commit the new state on
1824 * the software side now.
1827 ret = drm_atomic_helper_swap_state(state, true);
1832 * Everything below can be run asynchronously without the need to grab
1833 * any modeset locks at all under one condition: It must be guaranteed
1834 * that the asynchronous work has either been cancelled (if the driver
1835 * supports it, which at least requires that the framebuffers get
1836 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1837 * before the new state gets committed on the software side with
1838 * drm_atomic_helper_swap_state().
1840 * This scheme allows new atomic state updates to be prepared and
1841 * checked in parallel to the asynchronous completion of the previous
1842 * update. Which is important since compositors need to figure out the
1843 * composition of the next frame right after having submitted the
1846 * NOTE: Commit work has multiple phases, first hardware commit, then
1847 * cleanup. We want them to overlap, hence need system_unbound_wq to
1848 * make sure work items don't artificially stall on each another.
1851 drm_atomic_state_get(state);
1853 queue_work(system_unbound_wq, &state->commit_work);
1860 drm_atomic_helper_cleanup_planes(dev, state);
1863 EXPORT_SYMBOL(drm_atomic_helper_commit);
1866 * DOC: implementing nonblocking commit
1868 * Nonblocking atomic commits should use struct &drm_crtc_commit to sequence
1869 * different operations against each another. Locks, especially struct
1870 * &drm_modeset_lock, should not be held in worker threads or any other
1871 * asynchronous context used to commit the hardware state.
1873 * drm_atomic_helper_commit() implements the recommended sequence for
1874 * nonblocking commits, using drm_atomic_helper_setup_commit() internally:
1876 * 1. Run drm_atomic_helper_prepare_planes(). Since this can fail and we
1877 * need to propagate out of memory/VRAM errors to userspace, it must be called
1880 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1881 * might be affected by the new state update. This is handled by
1882 * drm_atomic_helper_setup_commit().
1884 * Asynchronous workers need to have sufficient parallelism to be able to run
1885 * different atomic commits on different CRTCs in parallel. The simplest way to
1886 * achieve this is by running them on the &system_unbound_wq work queue. Note
1887 * that drivers are not required to split up atomic commits and run an
1888 * individual commit in parallel - userspace is supposed to do that if it cares.
1889 * But it might be beneficial to do that for modesets, since those necessarily
1890 * must be done as one global operation, and enabling or disabling a CRTC can
1891 * take a long time. But even that is not required.
1893 * IMPORTANT: A &drm_atomic_state update for multiple CRTCs is sequenced
1894 * against all CRTCs therein. Therefore for atomic state updates which only flip
1895 * planes the driver must not get the struct &drm_crtc_state of unrelated CRTCs
1896 * in its atomic check code: This would prevent committing of atomic updates to
1897 * multiple CRTCs in parallel. In general, adding additional state structures
1898 * should be avoided as much as possible, because this reduces parallelism in
1899 * (nonblocking) commits, both due to locking and due to commit sequencing
1902 * 3. The software state is updated synchronously with
1903 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1904 * locks means concurrent callers never see inconsistent state. Note that commit
1905 * workers do not hold any locks; their access is only coordinated through
1906 * ordering. If workers would access state only through the pointers in the
1907 * free-standing state objects (currently not the case for any driver) then even
1908 * multiple pending commits could be in-flight at the same time.
1910 * 4. Schedule a work item to do all subsequent steps, using the split-out
1911 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1912 * then cleaning up the framebuffers after the old framebuffer is no longer
1913 * being displayed. The scheduled work should synchronize against other workers
1914 * using the &drm_crtc_commit infrastructure as needed. See
1915 * drm_atomic_helper_setup_commit() for more details.
1918 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1920 struct drm_crtc_commit *commit, *stall_commit = NULL;
1921 bool completed = true;
1925 spin_lock(&crtc->commit_lock);
1927 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1929 completed = try_wait_for_completion(&commit->flip_done);
1930 /* Userspace is not allowed to get ahead of the previous
1931 * commit with nonblocking ones. */
1932 if (!completed && nonblock) {
1933 spin_unlock(&crtc->commit_lock);
1936 } else if (i == 1) {
1937 stall_commit = drm_crtc_commit_get(commit);
1943 spin_unlock(&crtc->commit_lock);
1948 /* We don't want to let commits get ahead of cleanup work too much,
1949 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1951 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1954 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1955 crtc->base.id, crtc->name);
1957 drm_crtc_commit_put(stall_commit);
1959 return ret < 0 ? ret : 0;
1962 static void release_crtc_commit(struct completion *completion)
1964 struct drm_crtc_commit *commit = container_of(completion,
1968 drm_crtc_commit_put(commit);
1971 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
1973 init_completion(&commit->flip_done);
1974 init_completion(&commit->hw_done);
1975 init_completion(&commit->cleanup_done);
1976 INIT_LIST_HEAD(&commit->commit_entry);
1977 kref_init(&commit->ref);
1978 commit->crtc = crtc;
1981 static struct drm_crtc_commit *
1982 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
1985 struct drm_crtc_state *new_crtc_state;
1987 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
1989 return new_crtc_state->commit;
1992 if (!state->fake_commit) {
1993 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
1994 if (!state->fake_commit)
1997 init_commit(state->fake_commit, NULL);
2000 return state->fake_commit;
2004 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
2005 * @state: new modeset state to be committed
2006 * @nonblock: whether nonblocking behavior is requested.
2008 * This function prepares @state to be used by the atomic helper's support for
2009 * nonblocking commits. Drivers using the nonblocking commit infrastructure
2010 * should always call this function from their
2011 * &drm_mode_config_funcs.atomic_commit hook.
2013 * To be able to use this support drivers need to use a few more helper
2014 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
2015 * actually committing the hardware state, and for nonblocking commits this call
2016 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
2017 * and its stall parameter, for when a driver's commit hooks look at the
2018 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
2020 * Completion of the hardware commit step must be signalled using
2021 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
2022 * to read or change any permanent software or hardware modeset state. The only
2023 * exception is state protected by other means than &drm_modeset_lock locks.
2024 * Only the free standing @state with pointers to the old state structures can
2025 * be inspected, e.g. to clean up old buffers using
2026 * drm_atomic_helper_cleanup_planes().
2028 * At the very end, before cleaning up @state drivers must call
2029 * drm_atomic_helper_commit_cleanup_done().
2031 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
2032 * complete and easy-to-use default implementation of the atomic_commit() hook.
2034 * The tracking of asynchronously executed and still pending commits is done
2035 * using the core structure &drm_crtc_commit.
2037 * By default there's no need to clean up resources allocated by this function
2038 * explicitly: drm_atomic_state_default_clear() will take care of that
2043 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
2044 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
2046 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
2049 struct drm_crtc *crtc;
2050 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2051 struct drm_connector *conn;
2052 struct drm_connector_state *old_conn_state, *new_conn_state;
2053 struct drm_plane *plane;
2054 struct drm_plane_state *old_plane_state, *new_plane_state;
2055 struct drm_crtc_commit *commit;
2058 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2059 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
2063 init_commit(commit, crtc);
2065 new_crtc_state->commit = commit;
2067 ret = stall_checks(crtc, nonblock);
2071 /* Drivers only send out events when at least either current or
2072 * new CRTC state is active. Complete right away if everything
2074 if (!old_crtc_state->active && !new_crtc_state->active) {
2075 complete_all(&commit->flip_done);
2079 /* Legacy cursor updates are fully unsynced. */
2080 if (state->legacy_cursor_update) {
2081 complete_all(&commit->flip_done);
2085 if (!new_crtc_state->event) {
2086 commit->event = kzalloc(sizeof(*commit->event),
2091 new_crtc_state->event = commit->event;
2094 new_crtc_state->event->base.completion = &commit->flip_done;
2095 new_crtc_state->event->base.completion_release = release_crtc_commit;
2096 drm_crtc_commit_get(commit);
2098 commit->abort_completion = true;
2100 state->crtcs[i].commit = commit;
2101 drm_crtc_commit_get(commit);
2104 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2105 /* Userspace is not allowed to get ahead of the previous
2106 * commit with nonblocking ones. */
2107 if (nonblock && old_conn_state->commit &&
2108 !try_wait_for_completion(&old_conn_state->commit->flip_done))
2111 /* Always track connectors explicitly for e.g. link retraining. */
2112 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2116 new_conn_state->commit = drm_crtc_commit_get(commit);
2119 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2120 /* Userspace is not allowed to get ahead of the previous
2121 * commit with nonblocking ones. */
2122 if (nonblock && old_plane_state->commit &&
2123 !try_wait_for_completion(&old_plane_state->commit->flip_done))
2126 /* Always track planes explicitly for async pageflip support. */
2127 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2131 new_plane_state->commit = drm_crtc_commit_get(commit);
2136 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2139 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2140 * @old_state: atomic state object with old state structures
2142 * This function waits for all preceeding commits that touch the same CRTC as
2143 * @old_state to both be committed to the hardware (as signalled by
2144 * drm_atomic_helper_commit_hw_done()) and executed by the hardware (as signalled
2145 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2147 * This is part of the atomic helper support for nonblocking commits, see
2148 * drm_atomic_helper_setup_commit() for an overview.
2150 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2152 struct drm_crtc *crtc;
2153 struct drm_crtc_state *old_crtc_state;
2154 struct drm_plane *plane;
2155 struct drm_plane_state *old_plane_state;
2156 struct drm_connector *conn;
2157 struct drm_connector_state *old_conn_state;
2158 struct drm_crtc_commit *commit;
2162 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2163 commit = old_crtc_state->commit;
2168 ret = wait_for_completion_timeout(&commit->hw_done,
2171 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2172 crtc->base.id, crtc->name);
2174 /* Currently no support for overwriting flips, hence
2175 * stall for previous one to execute completely. */
2176 ret = wait_for_completion_timeout(&commit->flip_done,
2179 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
2180 crtc->base.id, crtc->name);
2183 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2184 commit = old_conn_state->commit;
2189 ret = wait_for_completion_timeout(&commit->hw_done,
2192 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
2193 conn->base.id, conn->name);
2195 /* Currently no support for overwriting flips, hence
2196 * stall for previous one to execute completely. */
2197 ret = wait_for_completion_timeout(&commit->flip_done,
2200 DRM_ERROR("[CONNECTOR:%d:%s] flip_done timed out\n",
2201 conn->base.id, conn->name);
2204 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2205 commit = old_plane_state->commit;
2210 ret = wait_for_completion_timeout(&commit->hw_done,
2213 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
2214 plane->base.id, plane->name);
2216 /* Currently no support for overwriting flips, hence
2217 * stall for previous one to execute completely. */
2218 ret = wait_for_completion_timeout(&commit->flip_done,
2221 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2222 plane->base.id, plane->name);
2225 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2228 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2229 * @old_state: atomic state object with old state structures
2231 * This function walks all CRTCs and fakes VBLANK events on those with
2232 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2233 * The primary use of this function is writeback connectors working in oneshot
2234 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2235 * when a job is queued, and any change to the pipeline that does not touch the
2236 * connector is leading to timeouts when calling
2237 * drm_atomic_helper_wait_for_vblanks() or
2238 * drm_atomic_helper_wait_for_flip_done().
2240 * This is part of the atomic helper support for nonblocking commits, see
2241 * drm_atomic_helper_setup_commit() for an overview.
2243 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2245 struct drm_crtc_state *new_crtc_state;
2246 struct drm_crtc *crtc;
2249 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2250 unsigned long flags;
2252 if (!new_crtc_state->no_vblank)
2255 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2256 if (new_crtc_state->event) {
2257 drm_crtc_send_vblank_event(crtc,
2258 new_crtc_state->event);
2259 new_crtc_state->event = NULL;
2261 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2264 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2267 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2268 * @old_state: atomic state object with old state structures
2270 * This function is used to signal completion of the hardware commit step. After
2271 * this step the driver is not allowed to read or change any permanent software
2272 * or hardware modeset state. The only exception is state protected by other
2273 * means than &drm_modeset_lock locks.
2275 * Drivers should try to postpone any expensive or delayed cleanup work after
2276 * this function is called.
2278 * This is part of the atomic helper support for nonblocking commits, see
2279 * drm_atomic_helper_setup_commit() for an overview.
2281 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2283 struct drm_crtc *crtc;
2284 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2285 struct drm_crtc_commit *commit;
2288 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2289 commit = new_crtc_state->commit;
2294 * copy new_crtc_state->commit to old_crtc_state->commit,
2295 * it's unsafe to touch new_crtc_state after hw_done,
2296 * but we still need to do so in cleanup_done().
2298 if (old_crtc_state->commit)
2299 drm_crtc_commit_put(old_crtc_state->commit);
2301 old_crtc_state->commit = drm_crtc_commit_get(commit);
2303 /* backend must have consumed any event by now */
2304 WARN_ON(new_crtc_state->event);
2305 complete_all(&commit->hw_done);
2308 if (old_state->fake_commit) {
2309 complete_all(&old_state->fake_commit->hw_done);
2310 complete_all(&old_state->fake_commit->flip_done);
2313 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2316 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2317 * @old_state: atomic state object with old state structures
2319 * This signals completion of the atomic update @old_state, including any
2320 * cleanup work. If used, it must be called right before calling
2321 * drm_atomic_state_put().
2323 * This is part of the atomic helper support for nonblocking commits, see
2324 * drm_atomic_helper_setup_commit() for an overview.
2326 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2328 struct drm_crtc *crtc;
2329 struct drm_crtc_state *old_crtc_state;
2330 struct drm_crtc_commit *commit;
2333 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2334 commit = old_crtc_state->commit;
2335 if (WARN_ON(!commit))
2338 complete_all(&commit->cleanup_done);
2339 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2341 spin_lock(&crtc->commit_lock);
2342 list_del(&commit->commit_entry);
2343 spin_unlock(&crtc->commit_lock);
2346 if (old_state->fake_commit) {
2347 complete_all(&old_state->fake_commit->cleanup_done);
2348 WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2351 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2354 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2356 * @state: atomic state object with new state structures
2358 * This function prepares plane state, specifically framebuffers, for the new
2359 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2360 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2361 * any already successfully prepared framebuffer.
2364 * 0 on success, negative error code on failure.
2366 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2367 struct drm_atomic_state *state)
2369 struct drm_connector *connector;
2370 struct drm_connector_state *new_conn_state;
2371 struct drm_plane *plane;
2372 struct drm_plane_state *new_plane_state;
2375 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2376 if (!new_conn_state->writeback_job)
2379 ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2384 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2385 const struct drm_plane_helper_funcs *funcs;
2387 funcs = plane->helper_private;
2389 if (funcs->prepare_fb) {
2390 ret = funcs->prepare_fb(plane, new_plane_state);
2399 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2400 const struct drm_plane_helper_funcs *funcs;
2405 funcs = plane->helper_private;
2407 if (funcs->cleanup_fb)
2408 funcs->cleanup_fb(plane, new_plane_state);
2413 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2415 static bool plane_crtc_active(const struct drm_plane_state *state)
2417 return state->crtc && state->crtc->state->active;
2421 * drm_atomic_helper_commit_planes - commit plane state
2423 * @old_state: atomic state object with old state structures
2424 * @flags: flags for committing plane state
2426 * This function commits the new plane state using the plane and atomic helper
2427 * functions for planes and CRTCs. It assumes that the atomic state has already
2428 * been pushed into the relevant object state pointers, since this step can no
2431 * It still requires the global state object @old_state to know which planes and
2432 * crtcs need to be updated though.
2434 * Note that this function does all plane updates across all CRTCs in one step.
2435 * If the hardware can't support this approach look at
2436 * drm_atomic_helper_commit_planes_on_crtc() instead.
2438 * Plane parameters can be updated by applications while the associated CRTC is
2439 * disabled. The DRM/KMS core will store the parameters in the plane state,
2440 * which will be available to the driver when the CRTC is turned on. As a result
2441 * most drivers don't need to be immediately notified of plane updates for a
2444 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2445 * @flags in order not to receive plane update notifications related to a
2446 * disabled CRTC. This avoids the need to manually ignore plane updates in
2447 * driver code when the driver and/or hardware can't or just don't need to deal
2448 * with updates on disabled CRTCs, for example when supporting runtime PM.
2450 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2451 * display controllers require to disable a CRTC's planes when the CRTC is
2452 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2453 * call for a plane if the CRTC of the old plane state needs a modesetting
2454 * operation. Of course, the drivers need to disable the planes in their CRTC
2455 * disable callbacks since no one else would do that.
2457 * The drm_atomic_helper_commit() default implementation doesn't set the
2458 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2459 * This should not be copied blindly by drivers.
2461 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2462 struct drm_atomic_state *old_state,
2465 struct drm_crtc *crtc;
2466 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2467 struct drm_plane *plane;
2468 struct drm_plane_state *old_plane_state, *new_plane_state;
2470 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2471 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2473 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2474 const struct drm_crtc_helper_funcs *funcs;
2476 funcs = crtc->helper_private;
2478 if (!funcs || !funcs->atomic_begin)
2481 if (active_only && !new_crtc_state->active)
2484 funcs->atomic_begin(crtc, old_crtc_state);
2487 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2488 const struct drm_plane_helper_funcs *funcs;
2491 funcs = plane->helper_private;
2496 disabling = drm_atomic_plane_disabling(old_plane_state,
2501 * Skip planes related to inactive CRTCs. If the plane
2502 * is enabled use the state of the current CRTC. If the
2503 * plane is being disabled use the state of the old
2504 * CRTC to avoid skipping planes being disabled on an
2507 if (!disabling && !plane_crtc_active(new_plane_state))
2509 if (disabling && !plane_crtc_active(old_plane_state))
2514 * Special-case disabling the plane if drivers support it.
2516 if (disabling && funcs->atomic_disable) {
2517 struct drm_crtc_state *crtc_state;
2519 crtc_state = old_plane_state->crtc->state;
2521 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2525 funcs->atomic_disable(plane, old_plane_state);
2526 } else if (new_plane_state->crtc || disabling) {
2527 funcs->atomic_update(plane, old_plane_state);
2531 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2532 const struct drm_crtc_helper_funcs *funcs;
2534 funcs = crtc->helper_private;
2536 if (!funcs || !funcs->atomic_flush)
2539 if (active_only && !new_crtc_state->active)
2542 funcs->atomic_flush(crtc, old_crtc_state);
2545 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2548 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a CRTC
2549 * @old_crtc_state: atomic state object with the old CRTC state
2551 * This function commits the new plane state using the plane and atomic helper
2552 * functions for planes on the specific CRTC. It assumes that the atomic state
2553 * has already been pushed into the relevant object state pointers, since this
2554 * step can no longer fail.
2556 * This function is useful when plane updates should be done CRTC-by-CRTC
2557 * instead of one global step like drm_atomic_helper_commit_planes() does.
2559 * This function can only be savely used when planes are not allowed to move
2560 * between different CRTCs because this function doesn't handle inter-CRTC
2561 * depencies. Callers need to ensure that either no such depencies exist,
2562 * resolve them through ordering of commit calls or through some other means.
2565 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2567 const struct drm_crtc_helper_funcs *crtc_funcs;
2568 struct drm_crtc *crtc = old_crtc_state->crtc;
2569 struct drm_atomic_state *old_state = old_crtc_state->state;
2570 struct drm_crtc_state *new_crtc_state =
2571 drm_atomic_get_new_crtc_state(old_state, crtc);
2572 struct drm_plane *plane;
2573 unsigned plane_mask;
2575 plane_mask = old_crtc_state->plane_mask;
2576 plane_mask |= new_crtc_state->plane_mask;
2578 crtc_funcs = crtc->helper_private;
2579 if (crtc_funcs && crtc_funcs->atomic_begin)
2580 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2582 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2583 struct drm_plane_state *old_plane_state =
2584 drm_atomic_get_old_plane_state(old_state, plane);
2585 struct drm_plane_state *new_plane_state =
2586 drm_atomic_get_new_plane_state(old_state, plane);
2587 const struct drm_plane_helper_funcs *plane_funcs;
2589 plane_funcs = plane->helper_private;
2591 if (!old_plane_state || !plane_funcs)
2594 WARN_ON(new_plane_state->crtc &&
2595 new_plane_state->crtc != crtc);
2597 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2598 plane_funcs->atomic_disable)
2599 plane_funcs->atomic_disable(plane, old_plane_state);
2600 else if (new_plane_state->crtc ||
2601 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2602 plane_funcs->atomic_update(plane, old_plane_state);
2605 if (crtc_funcs && crtc_funcs->atomic_flush)
2606 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2608 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2611 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2612 * @old_crtc_state: atomic state object with the old CRTC state
2613 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2615 * Disables all planes associated with the given CRTC. This can be
2616 * used for instance in the CRTC helper atomic_disable callback to disable
2619 * If the atomic-parameter is set the function calls the CRTC's
2620 * atomic_begin hook before and atomic_flush hook after disabling the
2623 * It is a bug to call this function without having implemented the
2624 * &drm_plane_helper_funcs.atomic_disable plane hook.
2627 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2630 struct drm_crtc *crtc = old_crtc_state->crtc;
2631 const struct drm_crtc_helper_funcs *crtc_funcs =
2632 crtc->helper_private;
2633 struct drm_plane *plane;
2635 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2636 crtc_funcs->atomic_begin(crtc, NULL);
2638 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2639 const struct drm_plane_helper_funcs *plane_funcs =
2640 plane->helper_private;
2645 WARN_ON(!plane_funcs->atomic_disable);
2646 if (plane_funcs->atomic_disable)
2647 plane_funcs->atomic_disable(plane, NULL);
2650 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2651 crtc_funcs->atomic_flush(crtc, NULL);
2653 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2656 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2658 * @old_state: atomic state object with old state structures
2660 * This function cleans up plane state, specifically framebuffers, from the old
2661 * configuration. Hence the old configuration must be perserved in @old_state to
2662 * be able to call this function.
2664 * This function must also be called on the new state when the atomic update
2665 * fails at any point after calling drm_atomic_helper_prepare_planes().
2667 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2668 struct drm_atomic_state *old_state)
2670 struct drm_plane *plane;
2671 struct drm_plane_state *old_plane_state, *new_plane_state;
2674 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2675 const struct drm_plane_helper_funcs *funcs;
2676 struct drm_plane_state *plane_state;
2679 * This might be called before swapping when commit is aborted,
2680 * in which case we have to cleanup the new state.
2682 if (old_plane_state == plane->state)
2683 plane_state = new_plane_state;
2685 plane_state = old_plane_state;
2687 funcs = plane->helper_private;
2689 if (funcs->cleanup_fb)
2690 funcs->cleanup_fb(plane, plane_state);
2693 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2696 * drm_atomic_helper_swap_state - store atomic state into current sw state
2697 * @state: atomic state
2698 * @stall: stall for preceeding commits
2700 * This function stores the atomic state into the current state pointers in all
2701 * driver objects. It should be called after all failing steps have been done
2702 * and succeeded, but before the actual hardware state is committed.
2704 * For cleanup and error recovery the current state for all changed objects will
2705 * be swapped into @state.
2707 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2709 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2711 * 2. Do any other steps that might fail.
2713 * 3. Put the staged state into the current state pointers with this function.
2715 * 4. Actually commit the hardware state.
2717 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2718 * contains the old state. Also do any other cleanup required with that state.
2720 * @stall must be set when nonblocking commits for this driver directly access
2721 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2722 * the current atomic helpers this is almost always the case, since the helpers
2723 * don't pass the right state structures to the callbacks.
2727 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2728 * waiting for the previous commits has been interrupted.
2730 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2734 struct drm_connector *connector;
2735 struct drm_connector_state *old_conn_state, *new_conn_state;
2736 struct drm_crtc *crtc;
2737 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2738 struct drm_plane *plane;
2739 struct drm_plane_state *old_plane_state, *new_plane_state;
2740 struct drm_crtc_commit *commit;
2741 struct drm_private_obj *obj;
2742 struct drm_private_state *old_obj_state, *new_obj_state;
2746 * We have to stall for hw_done here before
2747 * drm_atomic_helper_wait_for_dependencies() because flip
2748 * depth > 1 is not yet supported by all drivers. As long as
2749 * obj->state is directly dereferenced anywhere in the drivers
2750 * atomic_commit_tail function, then it's unsafe to swap state
2751 * before drm_atomic_helper_commit_hw_done() is called.
2754 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2755 commit = old_crtc_state->commit;
2760 ret = wait_for_completion_interruptible(&commit->hw_done);
2765 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2766 commit = old_conn_state->commit;
2771 ret = wait_for_completion_interruptible(&commit->hw_done);
2776 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2777 commit = old_plane_state->commit;
2782 ret = wait_for_completion_interruptible(&commit->hw_done);
2788 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2789 WARN_ON(connector->state != old_conn_state);
2791 old_conn_state->state = state;
2792 new_conn_state->state = NULL;
2794 state->connectors[i].state = old_conn_state;
2795 connector->state = new_conn_state;
2798 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2799 WARN_ON(crtc->state != old_crtc_state);
2801 old_crtc_state->state = state;
2802 new_crtc_state->state = NULL;
2804 state->crtcs[i].state = old_crtc_state;
2805 crtc->state = new_crtc_state;
2807 if (new_crtc_state->commit) {
2808 spin_lock(&crtc->commit_lock);
2809 list_add(&new_crtc_state->commit->commit_entry,
2810 &crtc->commit_list);
2811 spin_unlock(&crtc->commit_lock);
2813 new_crtc_state->commit->event = NULL;
2817 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2818 WARN_ON(plane->state != old_plane_state);
2820 old_plane_state->state = state;
2821 new_plane_state->state = NULL;
2823 state->planes[i].state = old_plane_state;
2824 plane->state = new_plane_state;
2827 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2828 WARN_ON(obj->state != old_obj_state);
2830 old_obj_state->state = state;
2831 new_obj_state->state = NULL;
2833 state->private_objs[i].state = old_obj_state;
2834 obj->state = new_obj_state;
2839 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2842 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2843 * @plane: plane object to update
2844 * @crtc: owning CRTC of owning plane
2845 * @fb: framebuffer to flip onto plane
2846 * @crtc_x: x offset of primary plane on @crtc
2847 * @crtc_y: y offset of primary plane on @crtc
2848 * @crtc_w: width of primary plane rectangle on @crtc
2849 * @crtc_h: height of primary plane rectangle on @crtc
2850 * @src_x: x offset of @fb for panning
2851 * @src_y: y offset of @fb for panning
2852 * @src_w: width of source rectangle in @fb
2853 * @src_h: height of source rectangle in @fb
2854 * @ctx: lock acquire context
2856 * Provides a default plane update handler using the atomic driver interface.
2859 * Zero on success, error code on failure
2861 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2862 struct drm_crtc *crtc,
2863 struct drm_framebuffer *fb,
2864 int crtc_x, int crtc_y,
2865 unsigned int crtc_w, unsigned int crtc_h,
2866 uint32_t src_x, uint32_t src_y,
2867 uint32_t src_w, uint32_t src_h,
2868 struct drm_modeset_acquire_ctx *ctx)
2870 struct drm_atomic_state *state;
2871 struct drm_plane_state *plane_state;
2874 state = drm_atomic_state_alloc(plane->dev);
2878 state->acquire_ctx = ctx;
2879 plane_state = drm_atomic_get_plane_state(state, plane);
2880 if (IS_ERR(plane_state)) {
2881 ret = PTR_ERR(plane_state);
2885 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2888 drm_atomic_set_fb_for_plane(plane_state, fb);
2889 plane_state->crtc_x = crtc_x;
2890 plane_state->crtc_y = crtc_y;
2891 plane_state->crtc_w = crtc_w;
2892 plane_state->crtc_h = crtc_h;
2893 plane_state->src_x = src_x;
2894 plane_state->src_y = src_y;
2895 plane_state->src_w = src_w;
2896 plane_state->src_h = src_h;
2898 if (plane == crtc->cursor)
2899 state->legacy_cursor_update = true;
2901 ret = drm_atomic_commit(state);
2903 drm_atomic_state_put(state);
2906 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2909 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2910 * @plane: plane to disable
2911 * @ctx: lock acquire context
2913 * Provides a default plane disable handler using the atomic driver interface.
2916 * Zero on success, error code on failure
2918 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2919 struct drm_modeset_acquire_ctx *ctx)
2921 struct drm_atomic_state *state;
2922 struct drm_plane_state *plane_state;
2925 state = drm_atomic_state_alloc(plane->dev);
2929 state->acquire_ctx = ctx;
2930 plane_state = drm_atomic_get_plane_state(state, plane);
2931 if (IS_ERR(plane_state)) {
2932 ret = PTR_ERR(plane_state);
2936 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2937 plane_state->state->legacy_cursor_update = true;
2939 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2943 ret = drm_atomic_commit(state);
2945 drm_atomic_state_put(state);
2948 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2951 * drm_atomic_helper_set_config - set a new config from userspace
2952 * @set: mode set configuration
2953 * @ctx: lock acquisition context
2955 * Provides a default CRTC set_config handler using the atomic driver interface.
2957 * NOTE: For backwards compatibility with old userspace this automatically
2958 * resets the "link-status" property to GOOD, to force any link
2959 * re-training. The SETCRTC ioctl does not define whether an update does
2960 * need a full modeset or just a plane update, hence we're allowed to do
2961 * that. See also drm_connector_set_link_status_property().
2964 * Returns 0 on success, negative errno numbers on failure.
2966 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2967 struct drm_modeset_acquire_ctx *ctx)
2969 struct drm_atomic_state *state;
2970 struct drm_crtc *crtc = set->crtc;
2973 state = drm_atomic_state_alloc(crtc->dev);
2977 state->acquire_ctx = ctx;
2978 ret = __drm_atomic_helper_set_config(set, state);
2982 ret = handle_conflicting_encoders(state, true);
2986 ret = drm_atomic_commit(state);
2989 drm_atomic_state_put(state);
2992 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2995 * drm_atomic_helper_disable_all - disable all currently active outputs
2997 * @ctx: lock acquisition context
2999 * Loops through all connectors, finding those that aren't turned off and then
3000 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3001 * that they are connected to.
3003 * This is used for example in suspend/resume to disable all currently active
3004 * functions when suspending. If you just want to shut down everything at e.g.
3005 * driver unload, look at drm_atomic_helper_shutdown().
3007 * Note that if callers haven't already acquired all modeset locks this might
3008 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3011 * 0 on success or a negative error code on failure.
3014 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3015 * drm_atomic_helper_shutdown().
3017 int drm_atomic_helper_disable_all(struct drm_device *dev,
3018 struct drm_modeset_acquire_ctx *ctx)
3020 struct drm_atomic_state *state;
3021 struct drm_connector_state *conn_state;
3022 struct drm_connector *conn;
3023 struct drm_plane_state *plane_state;
3024 struct drm_plane *plane;
3025 struct drm_crtc_state *crtc_state;
3026 struct drm_crtc *crtc;
3029 state = drm_atomic_state_alloc(dev);
3033 state->acquire_ctx = ctx;
3035 drm_for_each_crtc(crtc, dev) {
3036 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3037 if (IS_ERR(crtc_state)) {
3038 ret = PTR_ERR(crtc_state);
3042 crtc_state->active = false;
3044 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3048 ret = drm_atomic_add_affected_planes(state, crtc);
3052 ret = drm_atomic_add_affected_connectors(state, crtc);
3057 for_each_new_connector_in_state(state, conn, conn_state, i) {
3058 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3063 for_each_new_plane_in_state(state, plane, plane_state, i) {
3064 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3068 drm_atomic_set_fb_for_plane(plane_state, NULL);
3071 ret = drm_atomic_commit(state);
3073 drm_atomic_state_put(state);
3076 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3079 * drm_atomic_helper_shutdown - shutdown all CRTC
3082 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3083 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3084 * that also takes a snapshot of the modeset state to be restored on resume.
3086 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3087 * and it is the atomic version of drm_crtc_force_disable_all().
3089 void drm_atomic_helper_shutdown(struct drm_device *dev)
3091 struct drm_modeset_acquire_ctx ctx;
3094 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3096 ret = drm_atomic_helper_disable_all(dev, &ctx);
3098 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3100 DRM_MODESET_LOCK_ALL_END(ctx, ret);
3102 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3105 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3107 * @ctx: lock acquisition context
3109 * Makes a copy of the current atomic state by looping over all objects and
3110 * duplicating their respective states. This is used for example by suspend/
3111 * resume support code to save the state prior to suspend such that it can
3112 * be restored upon resume.
3114 * Note that this treats atomic state as persistent between save and restore.
3115 * Drivers must make sure that this is possible and won't result in confusion
3116 * or erroneous behaviour.
3118 * Note that if callers haven't already acquired all modeset locks this might
3119 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3122 * A pointer to the copy of the atomic state object on success or an
3123 * ERR_PTR()-encoded error code on failure.
3126 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3128 struct drm_atomic_state *
3129 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3130 struct drm_modeset_acquire_ctx *ctx)
3132 struct drm_atomic_state *state;
3133 struct drm_connector *conn;
3134 struct drm_connector_list_iter conn_iter;
3135 struct drm_plane *plane;
3136 struct drm_crtc *crtc;
3139 state = drm_atomic_state_alloc(dev);
3141 return ERR_PTR(-ENOMEM);
3143 state->acquire_ctx = ctx;
3144 state->duplicated = true;
3146 drm_for_each_crtc(crtc, dev) {
3147 struct drm_crtc_state *crtc_state;
3149 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3150 if (IS_ERR(crtc_state)) {
3151 err = PTR_ERR(crtc_state);
3156 drm_for_each_plane(plane, dev) {
3157 struct drm_plane_state *plane_state;
3159 plane_state = drm_atomic_get_plane_state(state, plane);
3160 if (IS_ERR(plane_state)) {
3161 err = PTR_ERR(plane_state);
3166 drm_connector_list_iter_begin(dev, &conn_iter);
3167 drm_for_each_connector_iter(conn, &conn_iter) {
3168 struct drm_connector_state *conn_state;
3170 conn_state = drm_atomic_get_connector_state(state, conn);
3171 if (IS_ERR(conn_state)) {
3172 err = PTR_ERR(conn_state);
3173 drm_connector_list_iter_end(&conn_iter);
3177 drm_connector_list_iter_end(&conn_iter);
3179 /* clear the acquire context so that it isn't accidentally reused */
3180 state->acquire_ctx = NULL;
3184 drm_atomic_state_put(state);
3185 state = ERR_PTR(err);
3190 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3193 * drm_atomic_helper_suspend - subsystem-level suspend helper
3196 * Duplicates the current atomic state, disables all active outputs and then
3197 * returns a pointer to the original atomic state to the caller. Drivers can
3198 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3199 * restore the output configuration that was active at the time the system
3202 * Note that it is potentially unsafe to use this. The atomic state object
3203 * returned by this function is assumed to be persistent. Drivers must ensure
3204 * that this holds true. Before calling this function, drivers must make sure
3205 * to suspend fbdev emulation so that nothing can be using the device.
3208 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3209 * encoded error code on failure. Drivers should store the returned atomic
3210 * state object and pass it to the drm_atomic_helper_resume() helper upon
3214 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3215 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3217 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3219 struct drm_modeset_acquire_ctx ctx;
3220 struct drm_atomic_state *state;
3223 /* This can never be returned, but it makes the compiler happy */
3224 state = ERR_PTR(-EINVAL);
3226 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3228 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3232 err = drm_atomic_helper_disable_all(dev, &ctx);
3234 drm_atomic_state_put(state);
3235 state = ERR_PTR(err);
3240 DRM_MODESET_LOCK_ALL_END(ctx, err);
3242 return ERR_PTR(err);
3246 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3249 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3250 * @state: duplicated atomic state to commit
3251 * @ctx: pointer to acquire_ctx to use for commit.
3253 * The state returned by drm_atomic_helper_duplicate_state() and
3254 * drm_atomic_helper_suspend() is partially invalid, and needs to
3255 * be fixed up before commit.
3258 * 0 on success or a negative error code on failure.
3261 * drm_atomic_helper_suspend()
3263 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3264 struct drm_modeset_acquire_ctx *ctx)
3267 struct drm_plane *plane;
3268 struct drm_plane_state *new_plane_state;
3269 struct drm_connector *connector;
3270 struct drm_connector_state *new_conn_state;
3271 struct drm_crtc *crtc;
3272 struct drm_crtc_state *new_crtc_state;
3274 state->acquire_ctx = ctx;
3276 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3277 state->planes[i].old_state = plane->state;
3279 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3280 state->crtcs[i].old_state = crtc->state;
3282 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3283 state->connectors[i].old_state = connector->state;
3285 ret = drm_atomic_commit(state);
3287 state->acquire_ctx = NULL;
3291 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3294 * drm_atomic_helper_resume - subsystem-level resume helper
3296 * @state: atomic state to resume to
3298 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3299 * grabs all modeset locks and commits the atomic state object. This can be
3300 * used in conjunction with the drm_atomic_helper_suspend() helper to
3301 * implement suspend/resume for drivers that support atomic mode-setting.
3304 * 0 on success or a negative error code on failure.
3307 * drm_atomic_helper_suspend()
3309 int drm_atomic_helper_resume(struct drm_device *dev,
3310 struct drm_atomic_state *state)
3312 struct drm_modeset_acquire_ctx ctx;
3315 drm_mode_config_reset(dev);
3317 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3319 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3321 DRM_MODESET_LOCK_ALL_END(ctx, err);
3322 drm_atomic_state_put(state);
3326 EXPORT_SYMBOL(drm_atomic_helper_resume);
3328 static int page_flip_common(struct drm_atomic_state *state,
3329 struct drm_crtc *crtc,
3330 struct drm_framebuffer *fb,
3331 struct drm_pending_vblank_event *event,
3334 struct drm_plane *plane = crtc->primary;
3335 struct drm_plane_state *plane_state;
3336 struct drm_crtc_state *crtc_state;
3339 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3340 if (IS_ERR(crtc_state))
3341 return PTR_ERR(crtc_state);
3343 crtc_state->event = event;
3344 crtc_state->async_flip = flags & DRM_MODE_PAGE_FLIP_ASYNC;
3346 plane_state = drm_atomic_get_plane_state(state, plane);
3347 if (IS_ERR(plane_state))
3348 return PTR_ERR(plane_state);
3350 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3353 drm_atomic_set_fb_for_plane(plane_state, fb);
3355 /* Make sure we don't accidentally do a full modeset. */
3356 state->allow_modeset = false;
3357 if (!crtc_state->active) {
3358 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3359 crtc->base.id, crtc->name);
3367 * drm_atomic_helper_page_flip - execute a legacy page flip
3369 * @fb: DRM framebuffer
3370 * @event: optional DRM event to signal upon completion
3371 * @flags: flip flags for non-vblank sync'ed updates
3372 * @ctx: lock acquisition context
3374 * Provides a default &drm_crtc_funcs.page_flip implementation
3375 * using the atomic driver interface.
3378 * Returns 0 on success, negative errno numbers on failure.
3381 * drm_atomic_helper_page_flip_target()
3383 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3384 struct drm_framebuffer *fb,
3385 struct drm_pending_vblank_event *event,
3387 struct drm_modeset_acquire_ctx *ctx)
3389 struct drm_plane *plane = crtc->primary;
3390 struct drm_atomic_state *state;
3393 state = drm_atomic_state_alloc(plane->dev);
3397 state->acquire_ctx = ctx;
3399 ret = page_flip_common(state, crtc, fb, event, flags);
3403 ret = drm_atomic_nonblocking_commit(state);
3405 drm_atomic_state_put(state);
3408 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3411 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3413 * @fb: DRM framebuffer
3414 * @event: optional DRM event to signal upon completion
3415 * @flags: flip flags for non-vblank sync'ed updates
3416 * @target: specifying the target vblank period when the flip to take effect
3417 * @ctx: lock acquisition context
3419 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3420 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3421 * target vblank period to flip.
3424 * Returns 0 on success, negative errno numbers on failure.
3426 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3427 struct drm_framebuffer *fb,
3428 struct drm_pending_vblank_event *event,
3431 struct drm_modeset_acquire_ctx *ctx)
3433 struct drm_plane *plane = crtc->primary;
3434 struct drm_atomic_state *state;
3435 struct drm_crtc_state *crtc_state;
3438 state = drm_atomic_state_alloc(plane->dev);
3442 state->acquire_ctx = ctx;
3444 ret = page_flip_common(state, crtc, fb, event, flags);
3448 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3449 if (WARN_ON(!crtc_state)) {
3453 crtc_state->target_vblank = target;
3455 ret = drm_atomic_nonblocking_commit(state);
3457 drm_atomic_state_put(state);
3460 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3463 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3464 * @crtc: CRTC object
3465 * @red: red correction table
3466 * @green: green correction table
3467 * @blue: green correction table
3468 * @size: size of the tables
3469 * @ctx: lock acquire context
3471 * Implements support for legacy gamma correction table for drivers
3472 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3473 * properties. See drm_crtc_enable_color_mgmt() and the containing chapter for
3474 * how the atomic color management and gamma tables work.
3476 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3477 u16 *red, u16 *green, u16 *blue,
3479 struct drm_modeset_acquire_ctx *ctx)
3481 struct drm_device *dev = crtc->dev;
3482 struct drm_atomic_state *state;
3483 struct drm_crtc_state *crtc_state;
3484 struct drm_property_blob *blob = NULL;
3485 struct drm_color_lut *blob_data;
3489 state = drm_atomic_state_alloc(crtc->dev);
3493 blob = drm_property_create_blob(dev,
3494 sizeof(struct drm_color_lut) * size,
3497 ret = PTR_ERR(blob);
3502 /* Prepare GAMMA_LUT with the legacy values. */
3503 blob_data = blob->data;
3504 for (i = 0; i < size; i++) {
3505 blob_data[i].red = red[i];
3506 blob_data[i].green = green[i];
3507 blob_data[i].blue = blue[i];
3510 state->acquire_ctx = ctx;
3511 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3512 if (IS_ERR(crtc_state)) {
3513 ret = PTR_ERR(crtc_state);
3517 /* Reset DEGAMMA_LUT and CTM properties. */
3518 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, NULL);
3519 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
3520 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, blob);
3521 crtc_state->color_mgmt_changed |= replaced;
3523 ret = drm_atomic_commit(state);
3526 drm_atomic_state_put(state);
3527 drm_property_blob_put(blob);
3530 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);