2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21 * OTHER DEALINGS IN THE SOFTWARE.
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
29 #include <drm/drm_atomic.h>
30 #include <drm/drm_atomic_uapi.h>
31 #include <drm/drm_plane_helper.h>
32 #include <drm/drm_crtc_helper.h>
33 #include <drm/drm_atomic_helper.h>
34 #include <drm/drm_writeback.h>
35 #include <linux/dma-fence.h>
37 #include "drm_crtc_helper_internal.h"
38 #include "drm_crtc_internal.h"
43 * This helper library provides implementations of check and commit functions on
44 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
45 * also provides convenience implementations for the atomic state handling
46 * callbacks for drivers which don't need to subclass the drm core structures to
47 * add their own additional internal state.
49 * This library also provides default implementations for the check callback in
50 * drm_atomic_helper_check() and for the commit callback with
51 * drm_atomic_helper_commit(). But the individual stages and callbacks are
52 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
53 * together with a driver private modeset implementation.
55 * This library also provides implementations for all the legacy driver
56 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
57 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
58 * various functions to implement set_property callbacks. New drivers must not
59 * implement these functions themselves but must use the provided helpers.
61 * The atomic helper uses the same function table structures as all other
62 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
63 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
64 * also shares the &struct drm_plane_helper_funcs function table with the plane
68 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
69 struct drm_plane_state *old_plane_state,
70 struct drm_plane_state *plane_state,
71 struct drm_plane *plane)
73 struct drm_crtc_state *crtc_state;
75 if (old_plane_state->crtc) {
76 crtc_state = drm_atomic_get_new_crtc_state(state,
77 old_plane_state->crtc);
79 if (WARN_ON(!crtc_state))
82 crtc_state->planes_changed = true;
85 if (plane_state->crtc) {
86 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
88 if (WARN_ON(!crtc_state))
91 crtc_state->planes_changed = true;
96 * For connectors that support multiple encoders, either the
97 * .atomic_best_encoder() or .best_encoder() operation must be implemented.
99 static struct drm_encoder *
100 pick_single_encoder_for_connector(struct drm_connector *connector)
102 WARN_ON(connector->encoder_ids[1]);
103 return drm_encoder_find(connector->dev, NULL, connector->encoder_ids[0]);
106 static int handle_conflicting_encoders(struct drm_atomic_state *state,
107 bool disable_conflicting_encoders)
109 struct drm_connector_state *new_conn_state;
110 struct drm_connector *connector;
111 struct drm_connector_list_iter conn_iter;
112 struct drm_encoder *encoder;
113 unsigned encoder_mask = 0;
117 * First loop, find all newly assigned encoders from the connectors
118 * part of the state. If the same encoder is assigned to multiple
119 * connectors bail out.
121 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
122 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
123 struct drm_encoder *new_encoder;
125 if (!new_conn_state->crtc)
128 if (funcs->atomic_best_encoder)
129 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
130 else if (funcs->best_encoder)
131 new_encoder = funcs->best_encoder(connector);
133 new_encoder = pick_single_encoder_for_connector(connector);
136 if (encoder_mask & drm_encoder_mask(new_encoder)) {
137 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
138 new_encoder->base.id, new_encoder->name,
139 connector->base.id, connector->name);
144 encoder_mask |= drm_encoder_mask(new_encoder);
152 * Second loop, iterate over all connectors not part of the state.
154 * If a conflicting encoder is found and disable_conflicting_encoders
155 * is not set, an error is returned. Userspace can provide a solution
156 * through the atomic ioctl.
158 * If the flag is set conflicting connectors are removed from the crtc
159 * and the crtc is disabled if no encoder is left. This preserves
160 * compatibility with the legacy set_config behavior.
162 drm_connector_list_iter_begin(state->dev, &conn_iter);
163 drm_for_each_connector_iter(connector, &conn_iter) {
164 struct drm_crtc_state *crtc_state;
166 if (drm_atomic_get_new_connector_state(state, connector))
169 encoder = connector->state->best_encoder;
170 if (!encoder || !(encoder_mask & drm_encoder_mask(encoder)))
173 if (!disable_conflicting_encoders) {
174 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
175 encoder->base.id, encoder->name,
176 connector->state->crtc->base.id,
177 connector->state->crtc->name,
178 connector->base.id, connector->name);
183 new_conn_state = drm_atomic_get_connector_state(state, connector);
184 if (IS_ERR(new_conn_state)) {
185 ret = PTR_ERR(new_conn_state);
189 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
190 encoder->base.id, encoder->name,
191 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
192 connector->base.id, connector->name);
194 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
196 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
200 if (!crtc_state->connector_mask) {
201 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
206 crtc_state->active = false;
210 drm_connector_list_iter_end(&conn_iter);
216 set_best_encoder(struct drm_atomic_state *state,
217 struct drm_connector_state *conn_state,
218 struct drm_encoder *encoder)
220 struct drm_crtc_state *crtc_state;
221 struct drm_crtc *crtc;
223 if (conn_state->best_encoder) {
224 /* Unset the encoder_mask in the old crtc state. */
225 crtc = conn_state->connector->state->crtc;
227 /* A NULL crtc is an error here because we should have
228 * duplicated a NULL best_encoder when crtc was NULL.
229 * As an exception restoring duplicated atomic state
230 * during resume is allowed, so don't warn when
231 * best_encoder is equal to encoder we intend to set.
233 WARN_ON(!crtc && encoder != conn_state->best_encoder);
235 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
237 crtc_state->encoder_mask &=
238 ~drm_encoder_mask(conn_state->best_encoder);
243 crtc = conn_state->crtc;
246 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
248 crtc_state->encoder_mask |=
249 drm_encoder_mask(encoder);
253 conn_state->best_encoder = encoder;
257 steal_encoder(struct drm_atomic_state *state,
258 struct drm_encoder *encoder)
260 struct drm_crtc_state *crtc_state;
261 struct drm_connector *connector;
262 struct drm_connector_state *old_connector_state, *new_connector_state;
265 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
266 struct drm_crtc *encoder_crtc;
268 if (new_connector_state->best_encoder != encoder)
271 encoder_crtc = old_connector_state->crtc;
273 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
274 encoder->base.id, encoder->name,
275 encoder_crtc->base.id, encoder_crtc->name);
277 set_best_encoder(state, new_connector_state, NULL);
279 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
280 crtc_state->connectors_changed = true;
287 update_connector_routing(struct drm_atomic_state *state,
288 struct drm_connector *connector,
289 struct drm_connector_state *old_connector_state,
290 struct drm_connector_state *new_connector_state)
292 const struct drm_connector_helper_funcs *funcs;
293 struct drm_encoder *new_encoder;
294 struct drm_crtc_state *crtc_state;
296 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
300 if (old_connector_state->crtc != new_connector_state->crtc) {
301 if (old_connector_state->crtc) {
302 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
303 crtc_state->connectors_changed = true;
306 if (new_connector_state->crtc) {
307 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
308 crtc_state->connectors_changed = true;
312 if (!new_connector_state->crtc) {
313 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
317 set_best_encoder(state, new_connector_state, NULL);
322 crtc_state = drm_atomic_get_new_crtc_state(state,
323 new_connector_state->crtc);
325 * For compatibility with legacy users, we want to make sure that
326 * we allow DPMS On->Off modesets on unregistered connectors. Modesets
327 * which would result in anything else must be considered invalid, to
328 * avoid turning on new displays on dead connectors.
330 * Since the connector can be unregistered at any point during an
331 * atomic check or commit, this is racy. But that's OK: all we care
332 * about is ensuring that userspace can't do anything but shut off the
333 * display on a connector that was destroyed after its been notified,
336 if (drm_connector_is_unregistered(connector) && crtc_state->active) {
337 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
338 connector->base.id, connector->name);
342 funcs = connector->helper_private;
344 if (funcs->atomic_best_encoder)
345 new_encoder = funcs->atomic_best_encoder(connector,
346 new_connector_state);
347 else if (funcs->best_encoder)
348 new_encoder = funcs->best_encoder(connector);
350 new_encoder = pick_single_encoder_for_connector(connector);
353 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
359 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
360 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
361 new_encoder->base.id,
363 new_connector_state->crtc->base.id,
364 new_connector_state->crtc->name);
368 if (new_encoder == new_connector_state->best_encoder) {
369 set_best_encoder(state, new_connector_state, new_encoder);
371 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
374 new_encoder->base.id,
376 new_connector_state->crtc->base.id,
377 new_connector_state->crtc->name);
382 steal_encoder(state, new_encoder);
384 set_best_encoder(state, new_connector_state, new_encoder);
386 crtc_state->connectors_changed = true;
388 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
391 new_encoder->base.id,
393 new_connector_state->crtc->base.id,
394 new_connector_state->crtc->name);
400 mode_fixup(struct drm_atomic_state *state)
402 struct drm_crtc *crtc;
403 struct drm_crtc_state *new_crtc_state;
404 struct drm_connector *connector;
405 struct drm_connector_state *new_conn_state;
409 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
410 if (!new_crtc_state->mode_changed &&
411 !new_crtc_state->connectors_changed)
414 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
417 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
418 const struct drm_encoder_helper_funcs *funcs;
419 struct drm_encoder *encoder;
421 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
423 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
427 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
430 * Each encoder has at most one connector (since we always steal
431 * it away), so we won't call ->mode_fixup twice.
433 encoder = new_conn_state->best_encoder;
434 funcs = encoder->helper_private;
436 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
437 &new_crtc_state->adjusted_mode);
439 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
443 if (funcs && funcs->atomic_check) {
444 ret = funcs->atomic_check(encoder, new_crtc_state,
447 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
448 encoder->base.id, encoder->name);
451 } else if (funcs && funcs->mode_fixup) {
452 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
453 &new_crtc_state->adjusted_mode);
455 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
456 encoder->base.id, encoder->name);
462 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
463 const struct drm_crtc_helper_funcs *funcs;
465 if (!new_crtc_state->enable)
468 if (!new_crtc_state->mode_changed &&
469 !new_crtc_state->connectors_changed)
472 funcs = crtc->helper_private;
473 if (!funcs->mode_fixup)
476 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
477 &new_crtc_state->adjusted_mode);
479 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
480 crtc->base.id, crtc->name);
488 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
489 struct drm_encoder *encoder,
490 struct drm_crtc *crtc,
491 struct drm_display_mode *mode)
493 enum drm_mode_status ret;
495 ret = drm_encoder_mode_valid(encoder, mode);
496 if (ret != MODE_OK) {
497 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
498 encoder->base.id, encoder->name);
502 ret = drm_bridge_mode_valid(encoder->bridge, mode);
503 if (ret != MODE_OK) {
504 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
508 ret = drm_crtc_mode_valid(crtc, mode);
509 if (ret != MODE_OK) {
510 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
511 crtc->base.id, crtc->name);
519 mode_valid(struct drm_atomic_state *state)
521 struct drm_connector_state *conn_state;
522 struct drm_connector *connector;
525 for_each_new_connector_in_state(state, connector, conn_state, i) {
526 struct drm_encoder *encoder = conn_state->best_encoder;
527 struct drm_crtc *crtc = conn_state->crtc;
528 struct drm_crtc_state *crtc_state;
529 enum drm_mode_status mode_status;
530 struct drm_display_mode *mode;
532 if (!crtc || !encoder)
535 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
538 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
541 mode = &crtc_state->mode;
543 mode_status = mode_valid_path(connector, encoder, crtc, mode);
544 if (mode_status != MODE_OK)
552 * drm_atomic_helper_check_modeset - validate state object for modeset changes
554 * @state: the driver state object
556 * Check the state object to see if the requested state is physically possible.
557 * This does all the crtc and connector related computations for an atomic
558 * update and adds any additional connectors needed for full modesets. It calls
559 * the various per-object callbacks in the follow order:
561 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
562 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
563 * 3. If it's determined a modeset is needed then all connectors on the affected crtc
564 * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them.
565 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
566 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
567 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
568 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
569 * This function is only called when the encoder will be part of a configured crtc,
570 * it must not be used for implementing connector property validation.
571 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
573 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints.
575 * &drm_crtc_state.mode_changed is set when the input mode is changed.
576 * &drm_crtc_state.connectors_changed is set when a connector is added or
577 * removed from the crtc. &drm_crtc_state.active_changed is set when
578 * &drm_crtc_state.active changes, which is used for DPMS.
579 * See also: drm_atomic_crtc_needs_modeset()
583 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
584 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
585 * without a full modeset) _must_ call this function afterwards after that
586 * change. It is permitted to call this function multiple times for the same
587 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
588 * upon the adjusted dotclock for fifo space allocation and watermark
592 * Zero for success or -errno
595 drm_atomic_helper_check_modeset(struct drm_device *dev,
596 struct drm_atomic_state *state)
598 struct drm_crtc *crtc;
599 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
600 struct drm_connector *connector;
601 struct drm_connector_state *old_connector_state, *new_connector_state;
603 unsigned connectors_mask = 0;
605 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
606 bool has_connectors =
607 !!new_crtc_state->connector_mask;
609 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
611 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
612 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
613 crtc->base.id, crtc->name);
614 new_crtc_state->mode_changed = true;
617 if (old_crtc_state->enable != new_crtc_state->enable) {
618 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
619 crtc->base.id, crtc->name);
622 * For clarity this assignment is done here, but
623 * enable == 0 is only true when there are no
624 * connectors and a NULL mode.
626 * The other way around is true as well. enable != 0
627 * iff connectors are attached and a mode is set.
629 new_crtc_state->mode_changed = true;
630 new_crtc_state->connectors_changed = true;
633 if (old_crtc_state->active != new_crtc_state->active) {
634 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
635 crtc->base.id, crtc->name);
636 new_crtc_state->active_changed = true;
639 if (new_crtc_state->enable != has_connectors) {
640 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
641 crtc->base.id, crtc->name);
647 ret = handle_conflicting_encoders(state, false);
651 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
652 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
654 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
657 * This only sets crtc->connectors_changed for routing changes,
658 * drivers must set crtc->connectors_changed themselves when
659 * connector properties need to be updated.
661 ret = update_connector_routing(state, connector,
663 new_connector_state);
666 if (old_connector_state->crtc) {
667 new_crtc_state = drm_atomic_get_new_crtc_state(state,
668 old_connector_state->crtc);
669 if (old_connector_state->link_status !=
670 new_connector_state->link_status)
671 new_crtc_state->connectors_changed = true;
673 if (old_connector_state->max_requested_bpc !=
674 new_connector_state->max_requested_bpc)
675 new_crtc_state->connectors_changed = true;
678 if (funcs->atomic_check)
679 ret = funcs->atomic_check(connector, new_connector_state);
683 connectors_mask |= BIT(i);
687 * After all the routing has been prepared we need to add in any
688 * connector which is itself unchanged, but who's crtc changes it's
689 * configuration. This must be done before calling mode_fixup in case a
690 * crtc only changed its mode but has the same set of connectors.
692 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
693 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
696 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
697 crtc->base.id, crtc->name,
698 new_crtc_state->enable ? 'y' : 'n',
699 new_crtc_state->active ? 'y' : 'n');
701 ret = drm_atomic_add_affected_connectors(state, crtc);
705 ret = drm_atomic_add_affected_planes(state, crtc);
711 * Iterate over all connectors again, to make sure atomic_check()
712 * has been called on them when a modeset is forced.
714 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
715 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
717 if (connectors_mask & BIT(i))
720 if (funcs->atomic_check)
721 ret = funcs->atomic_check(connector, new_connector_state);
726 ret = mode_valid(state);
730 return mode_fixup(state);
732 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
735 * drm_atomic_helper_check_plane_state() - Check plane state for validity
736 * @plane_state: plane state to check
737 * @crtc_state: crtc state to check
738 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
739 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
740 * @can_position: is it legal to position the plane such that it
741 * doesn't cover the entire crtc? This will generally
742 * only be false for primary planes.
743 * @can_update_disabled: can the plane be updated while the crtc
746 * Checks that a desired plane update is valid, and updates various
747 * bits of derived state (clipped coordinates etc.). Drivers that provide
748 * their own plane handling rather than helper-provided implementations may
749 * still wish to call this function to avoid duplication of error checking
753 * Zero if update appears valid, error code on failure
755 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
756 const struct drm_crtc_state *crtc_state,
760 bool can_update_disabled)
762 struct drm_framebuffer *fb = plane_state->fb;
763 struct drm_rect *src = &plane_state->src;
764 struct drm_rect *dst = &plane_state->dst;
765 unsigned int rotation = plane_state->rotation;
766 struct drm_rect clip = {};
769 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
771 *src = drm_plane_state_src(plane_state);
772 *dst = drm_plane_state_dest(plane_state);
775 plane_state->visible = false;
779 /* crtc should only be NULL when disabling (i.e., !fb) */
780 if (WARN_ON(!plane_state->crtc)) {
781 plane_state->visible = false;
785 if (!crtc_state->enable && !can_update_disabled) {
786 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
790 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
793 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
794 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
795 if (hscale < 0 || vscale < 0) {
796 DRM_DEBUG_KMS("Invalid scaling of plane\n");
797 drm_rect_debug_print("src: ", &plane_state->src, true);
798 drm_rect_debug_print("dst: ", &plane_state->dst, false);
802 if (crtc_state->enable)
803 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
805 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
807 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
809 if (!plane_state->visible)
811 * Plane isn't visible; some drivers can handle this
812 * so we just return success here. Drivers that can't
813 * (including those that use the primary plane helper's
814 * update function) will return an error from their
815 * update_plane handler.
819 if (!can_position && !drm_rect_equals(dst, &clip)) {
820 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
821 drm_rect_debug_print("dst: ", dst, false);
822 drm_rect_debug_print("clip: ", &clip, false);
828 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
831 * drm_atomic_helper_check_planes - validate state object for planes changes
833 * @state: the driver state object
835 * Check the state object to see if the requested state is physically possible.
836 * This does all the plane update related checks using by calling into the
837 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
838 * hooks provided by the driver.
840 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
844 * Zero for success or -errno
847 drm_atomic_helper_check_planes(struct drm_device *dev,
848 struct drm_atomic_state *state)
850 struct drm_crtc *crtc;
851 struct drm_crtc_state *new_crtc_state;
852 struct drm_plane *plane;
853 struct drm_plane_state *new_plane_state, *old_plane_state;
856 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
857 const struct drm_plane_helper_funcs *funcs;
859 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
861 funcs = plane->helper_private;
863 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
865 if (!funcs || !funcs->atomic_check)
868 ret = funcs->atomic_check(plane, new_plane_state);
870 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
871 plane->base.id, plane->name);
876 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
877 const struct drm_crtc_helper_funcs *funcs;
879 funcs = crtc->helper_private;
881 if (!funcs || !funcs->atomic_check)
884 ret = funcs->atomic_check(crtc, new_crtc_state);
886 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
887 crtc->base.id, crtc->name);
894 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
897 * drm_atomic_helper_check - validate state object
899 * @state: the driver state object
901 * Check the state object to see if the requested state is physically possible.
902 * Only crtcs and planes have check callbacks, so for any additional (global)
903 * checking that a driver needs it can simply wrap that around this function.
904 * Drivers without such needs can directly use this as their
905 * &drm_mode_config_funcs.atomic_check callback.
907 * This just wraps the two parts of the state checking for planes and modeset
908 * state in the default order: First it calls drm_atomic_helper_check_modeset()
909 * and then drm_atomic_helper_check_planes(). The assumption is that the
910 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
911 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
914 * Note that zpos normalization will add all enable planes to the state which
915 * might not desired for some drivers.
916 * For example enable/disable of a cursor plane which have fixed zpos value
917 * would trigger all other enabled planes to be forced to the state change.
920 * Zero for success or -errno
922 int drm_atomic_helper_check(struct drm_device *dev,
923 struct drm_atomic_state *state)
927 ret = drm_atomic_helper_check_modeset(dev, state);
931 if (dev->mode_config.normalize_zpos) {
932 ret = drm_atomic_normalize_zpos(dev, state);
937 ret = drm_atomic_helper_check_planes(dev, state);
941 if (state->legacy_cursor_update)
942 state->async_update = !drm_atomic_helper_async_check(dev, state);
946 EXPORT_SYMBOL(drm_atomic_helper_check);
949 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
951 struct drm_connector *connector;
952 struct drm_connector_state *old_conn_state, *new_conn_state;
953 struct drm_crtc *crtc;
954 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
957 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
958 const struct drm_encoder_helper_funcs *funcs;
959 struct drm_encoder *encoder;
961 /* Shut down everything that's in the changeset and currently
962 * still on. So need to check the old, saved state. */
963 if (!old_conn_state->crtc)
966 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
968 if (!old_crtc_state->active ||
969 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
972 encoder = old_conn_state->best_encoder;
974 /* We shouldn't get this far if we didn't previously have
975 * an encoder.. but WARN_ON() rather than explode.
977 if (WARN_ON(!encoder))
980 funcs = encoder->helper_private;
982 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
983 encoder->base.id, encoder->name);
986 * Each encoder has at most one connector (since we always steal
987 * it away), so we won't call disable hooks twice.
989 drm_bridge_disable(encoder->bridge);
991 /* Right function depends upon target state. */
993 if (new_conn_state->crtc && funcs->prepare)
994 funcs->prepare(encoder);
995 else if (funcs->disable)
996 funcs->disable(encoder);
997 else if (funcs->dpms)
998 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1001 drm_bridge_post_disable(encoder->bridge);
1004 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1005 const struct drm_crtc_helper_funcs *funcs;
1008 /* Shut down everything that needs a full modeset. */
1009 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1012 if (!old_crtc_state->active)
1015 funcs = crtc->helper_private;
1017 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1018 crtc->base.id, crtc->name);
1021 /* Right function depends upon target state. */
1022 if (new_crtc_state->enable && funcs->prepare)
1023 funcs->prepare(crtc);
1024 else if (funcs->atomic_disable)
1025 funcs->atomic_disable(crtc, old_crtc_state);
1026 else if (funcs->disable)
1027 funcs->disable(crtc);
1029 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1031 if (!(dev->irq_enabled && dev->num_crtcs))
1034 ret = drm_crtc_vblank_get(crtc);
1035 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1037 drm_crtc_vblank_put(crtc);
1042 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1044 * @old_state: atomic state object with old state structures
1046 * This function updates all the various legacy modeset state pointers in
1047 * connectors, encoders and crtcs. It also updates the timestamping constants
1048 * used for precise vblank timestamps by calling
1049 * drm_calc_timestamping_constants().
1051 * Drivers can use this for building their own atomic commit if they don't have
1052 * a pure helper-based modeset implementation.
1054 * Since these updates are not synchronized with lockings, only code paths
1055 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1056 * legacy state filled out by this helper. Defacto this means this helper and
1057 * the legacy state pointers are only really useful for transitioning an
1058 * existing driver to the atomic world.
1061 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1062 struct drm_atomic_state *old_state)
1064 struct drm_connector *connector;
1065 struct drm_connector_state *old_conn_state, *new_conn_state;
1066 struct drm_crtc *crtc;
1067 struct drm_crtc_state *new_crtc_state;
1070 /* clear out existing links and update dpms */
1071 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1072 if (connector->encoder) {
1073 WARN_ON(!connector->encoder->crtc);
1075 connector->encoder->crtc = NULL;
1076 connector->encoder = NULL;
1079 crtc = new_conn_state->crtc;
1080 if ((!crtc && old_conn_state->crtc) ||
1081 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1082 int mode = DRM_MODE_DPMS_OFF;
1084 if (crtc && crtc->state->active)
1085 mode = DRM_MODE_DPMS_ON;
1087 connector->dpms = mode;
1092 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1093 if (!new_conn_state->crtc)
1096 if (WARN_ON(!new_conn_state->best_encoder))
1099 connector->encoder = new_conn_state->best_encoder;
1100 connector->encoder->crtc = new_conn_state->crtc;
1103 /* set legacy state in the crtc structure */
1104 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1105 struct drm_plane *primary = crtc->primary;
1106 struct drm_plane_state *new_plane_state;
1108 crtc->mode = new_crtc_state->mode;
1109 crtc->enabled = new_crtc_state->enable;
1112 drm_atomic_get_new_plane_state(old_state, primary);
1114 if (new_plane_state && new_plane_state->crtc == crtc) {
1115 crtc->x = new_plane_state->src_x >> 16;
1116 crtc->y = new_plane_state->src_y >> 16;
1119 if (new_crtc_state->enable)
1120 drm_calc_timestamping_constants(crtc,
1121 &new_crtc_state->adjusted_mode);
1124 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1127 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1129 struct drm_crtc *crtc;
1130 struct drm_crtc_state *new_crtc_state;
1131 struct drm_connector *connector;
1132 struct drm_connector_state *new_conn_state;
1135 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1136 const struct drm_crtc_helper_funcs *funcs;
1138 if (!new_crtc_state->mode_changed)
1141 funcs = crtc->helper_private;
1143 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1144 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1145 crtc->base.id, crtc->name);
1147 funcs->mode_set_nofb(crtc);
1151 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1152 const struct drm_encoder_helper_funcs *funcs;
1153 struct drm_encoder *encoder;
1154 struct drm_display_mode *mode, *adjusted_mode;
1156 if (!new_conn_state->best_encoder)
1159 encoder = new_conn_state->best_encoder;
1160 funcs = encoder->helper_private;
1161 new_crtc_state = new_conn_state->crtc->state;
1162 mode = &new_crtc_state->mode;
1163 adjusted_mode = &new_crtc_state->adjusted_mode;
1165 if (!new_crtc_state->mode_changed)
1168 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1169 encoder->base.id, encoder->name);
1172 * Each encoder has at most one connector (since we always steal
1173 * it away), so we won't call mode_set hooks twice.
1175 if (funcs && funcs->atomic_mode_set) {
1176 funcs->atomic_mode_set(encoder, new_crtc_state,
1178 } else if (funcs && funcs->mode_set) {
1179 funcs->mode_set(encoder, mode, adjusted_mode);
1182 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
1187 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1189 * @old_state: atomic state object with old state structures
1191 * This function shuts down all the outputs that need to be shut down and
1192 * prepares them (if required) with the new mode.
1194 * For compatibility with legacy crtc helpers this should be called before
1195 * drm_atomic_helper_commit_planes(), which is what the default commit function
1196 * does. But drivers with different needs can group the modeset commits together
1197 * and do the plane commits at the end. This is useful for drivers doing runtime
1198 * PM since planes updates then only happen when the CRTC is actually enabled.
1200 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1201 struct drm_atomic_state *old_state)
1203 disable_outputs(dev, old_state);
1205 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1207 crtc_set_mode(dev, old_state);
1209 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1211 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1212 struct drm_atomic_state *old_state)
1214 struct drm_connector *connector;
1215 struct drm_connector_state *new_conn_state;
1218 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1219 const struct drm_connector_helper_funcs *funcs;
1221 funcs = connector->helper_private;
1222 if (!funcs->atomic_commit)
1225 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1226 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1227 funcs->atomic_commit(connector, new_conn_state);
1233 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1235 * @old_state: atomic state object with old state structures
1237 * This function enables all the outputs with the new configuration which had to
1238 * be turned off for the update.
1240 * For compatibility with legacy crtc helpers this should be called after
1241 * drm_atomic_helper_commit_planes(), which is what the default commit function
1242 * does. But drivers with different needs can group the modeset commits together
1243 * and do the plane commits at the end. This is useful for drivers doing runtime
1244 * PM since planes updates then only happen when the CRTC is actually enabled.
1246 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1247 struct drm_atomic_state *old_state)
1249 struct drm_crtc *crtc;
1250 struct drm_crtc_state *old_crtc_state;
1251 struct drm_crtc_state *new_crtc_state;
1252 struct drm_connector *connector;
1253 struct drm_connector_state *new_conn_state;
1256 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1257 const struct drm_crtc_helper_funcs *funcs;
1259 /* Need to filter out CRTCs where only planes change. */
1260 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1263 if (!new_crtc_state->active)
1266 funcs = crtc->helper_private;
1268 if (new_crtc_state->enable) {
1269 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1270 crtc->base.id, crtc->name);
1272 if (funcs->atomic_enable)
1273 funcs->atomic_enable(crtc, old_crtc_state);
1275 funcs->commit(crtc);
1279 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1280 const struct drm_encoder_helper_funcs *funcs;
1281 struct drm_encoder *encoder;
1283 if (!new_conn_state->best_encoder)
1286 if (!new_conn_state->crtc->state->active ||
1287 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1290 encoder = new_conn_state->best_encoder;
1291 funcs = encoder->helper_private;
1293 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1294 encoder->base.id, encoder->name);
1297 * Each encoder has at most one connector (since we always steal
1298 * it away), so we won't call enable hooks twice.
1300 drm_bridge_pre_enable(encoder->bridge);
1304 funcs->enable(encoder);
1305 else if (funcs->commit)
1306 funcs->commit(encoder);
1309 drm_bridge_enable(encoder->bridge);
1312 drm_atomic_helper_commit_writebacks(dev, old_state);
1314 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1317 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1319 * @state: atomic state object with old state structures
1320 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1321 * Otherwise @state is the old state.
1323 * For implicit sync, driver should fish the exclusive fence out from the
1324 * incoming fb's and stash it in the drm_plane_state. This is called after
1325 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1326 * just uses the atomic state to find the changed planes)
1328 * Note that @pre_swap is needed since the point where we block for fences moves
1329 * around depending upon whether an atomic commit is blocking or
1330 * non-blocking. For non-blocking commit all waiting needs to happen after
1331 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1332 * to wait **before** we do anything that can't be easily rolled back. That is
1333 * before we call drm_atomic_helper_swap_state().
1335 * Returns zero if success or < 0 if dma_fence_wait() fails.
1337 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1338 struct drm_atomic_state *state,
1341 struct drm_plane *plane;
1342 struct drm_plane_state *new_plane_state;
1345 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1346 if (!new_plane_state->fence)
1349 WARN_ON(!new_plane_state->fb);
1352 * If waiting for fences pre-swap (ie: nonblock), userspace can
1353 * still interrupt the operation. Instead of blocking until the
1354 * timer expires, make the wait interruptible.
1356 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1360 dma_fence_put(new_plane_state->fence);
1361 new_plane_state->fence = NULL;
1366 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1369 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1371 * @old_state: atomic state object with old state structures
1373 * Helper to, after atomic commit, wait for vblanks on all effected
1374 * crtcs (ie. before cleaning up old framebuffers using
1375 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1376 * framebuffers have actually changed to optimize for the legacy cursor and
1377 * plane update use-case.
1379 * Drivers using the nonblocking commit tracking support initialized by calling
1380 * drm_atomic_helper_setup_commit() should look at
1381 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1384 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1385 struct drm_atomic_state *old_state)
1387 struct drm_crtc *crtc;
1388 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1390 unsigned crtc_mask = 0;
1393 * Legacy cursor ioctls are completely unsynced, and userspace
1394 * relies on that (by doing tons of cursor updates).
1396 if (old_state->legacy_cursor_update)
1399 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1400 if (!new_crtc_state->active)
1403 ret = drm_crtc_vblank_get(crtc);
1407 crtc_mask |= drm_crtc_mask(crtc);
1408 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1411 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1412 if (!(crtc_mask & drm_crtc_mask(crtc)))
1415 ret = wait_event_timeout(dev->vblank[i].queue,
1416 old_state->crtcs[i].last_vblank_count !=
1417 drm_crtc_vblank_count(crtc),
1418 msecs_to_jiffies(50));
1420 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1421 crtc->base.id, crtc->name);
1423 drm_crtc_vblank_put(crtc);
1426 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1429 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1431 * @old_state: atomic state object with old state structures
1433 * Helper to, after atomic commit, wait for page flips on all effected
1434 * crtcs (ie. before cleaning up old framebuffers using
1435 * drm_atomic_helper_cleanup_planes()). Compared to
1436 * drm_atomic_helper_wait_for_vblanks() this waits for the completion of on all
1437 * CRTCs, assuming that cursors-only updates are signalling their completion
1438 * immediately (or using a different path).
1440 * This requires that drivers use the nonblocking commit tracking support
1441 * initialized using drm_atomic_helper_setup_commit().
1443 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1444 struct drm_atomic_state *old_state)
1446 struct drm_crtc *crtc;
1449 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1450 struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1453 crtc = old_state->crtcs[i].ptr;
1455 if (!crtc || !commit)
1458 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1460 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1461 crtc->base.id, crtc->name);
1464 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1467 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1468 * @old_state: atomic state object with old state structures
1470 * This is the default implementation for the
1471 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1472 * that do not support runtime_pm or do not need the CRTC to be
1473 * enabled to perform a commit. Otherwise, see
1474 * drm_atomic_helper_commit_tail_rpm().
1476 * Note that the default ordering of how the various stages are called is to
1477 * match the legacy modeset helper library closest.
1479 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1481 struct drm_device *dev = old_state->dev;
1483 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1485 drm_atomic_helper_commit_planes(dev, old_state, 0);
1487 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1489 drm_atomic_helper_fake_vblank(old_state);
1491 drm_atomic_helper_commit_hw_done(old_state);
1493 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1495 drm_atomic_helper_cleanup_planes(dev, old_state);
1497 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1500 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1501 * @old_state: new modeset state to be committed
1503 * This is an alternative implementation for the
1504 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1505 * that support runtime_pm or need the CRTC to be enabled to perform a
1506 * commit. Otherwise, one should use the default implementation
1507 * drm_atomic_helper_commit_tail().
1509 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1511 struct drm_device *dev = old_state->dev;
1513 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1515 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1517 drm_atomic_helper_commit_planes(dev, old_state,
1518 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1520 drm_atomic_helper_fake_vblank(old_state);
1522 drm_atomic_helper_commit_hw_done(old_state);
1524 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1526 drm_atomic_helper_cleanup_planes(dev, old_state);
1528 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1530 static void commit_tail(struct drm_atomic_state *old_state)
1532 struct drm_device *dev = old_state->dev;
1533 const struct drm_mode_config_helper_funcs *funcs;
1535 funcs = dev->mode_config.helper_private;
1537 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1539 drm_atomic_helper_wait_for_dependencies(old_state);
1541 if (funcs && funcs->atomic_commit_tail)
1542 funcs->atomic_commit_tail(old_state);
1544 drm_atomic_helper_commit_tail(old_state);
1546 drm_atomic_helper_commit_cleanup_done(old_state);
1548 drm_atomic_state_put(old_state);
1551 static void commit_work(struct work_struct *work)
1553 struct drm_atomic_state *state = container_of(work,
1554 struct drm_atomic_state,
1560 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1562 * @state: the driver state object
1564 * This helper will check if it is possible to commit the state asynchronously.
1565 * Async commits are not supposed to swap the states like normal sync commits
1566 * but just do in-place changes on the current state.
1568 * It will return 0 if the commit can happen in an asynchronous fashion or error
1569 * if not. Note that error just mean it can't be commited asynchronously, if it
1570 * fails the commit should be treated like a normal synchronous commit.
1572 int drm_atomic_helper_async_check(struct drm_device *dev,
1573 struct drm_atomic_state *state)
1575 struct drm_crtc *crtc;
1576 struct drm_crtc_state *crtc_state;
1577 struct drm_plane *plane = NULL;
1578 struct drm_plane_state *old_plane_state = NULL;
1579 struct drm_plane_state *new_plane_state = NULL;
1580 const struct drm_plane_helper_funcs *funcs;
1581 int i, n_planes = 0;
1583 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1584 if (drm_atomic_crtc_needs_modeset(crtc_state))
1588 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1591 /* FIXME: we support only single plane updates for now */
1595 if (!new_plane_state->crtc ||
1596 old_plane_state->crtc != new_plane_state->crtc)
1599 funcs = plane->helper_private;
1600 if (!funcs->atomic_async_update)
1603 if (new_plane_state->fence)
1607 * Don't do an async update if there is an outstanding commit modifying
1608 * the plane. This prevents our async update's changes from getting
1609 * overridden by a previous synchronous update's state.
1611 if (old_plane_state->commit &&
1612 !try_wait_for_completion(&old_plane_state->commit->hw_done))
1615 return funcs->atomic_async_check(plane, new_plane_state);
1617 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1620 * drm_atomic_helper_async_commit - commit state asynchronously
1622 * @state: the driver state object
1624 * This function commits a state asynchronously, i.e., not vblank
1625 * synchronized. It should be used on a state only when
1626 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1627 * the states like normal sync commits, but just do in-place changes on the
1630 void drm_atomic_helper_async_commit(struct drm_device *dev,
1631 struct drm_atomic_state *state)
1633 struct drm_plane *plane;
1634 struct drm_plane_state *plane_state;
1635 const struct drm_plane_helper_funcs *funcs;
1638 for_each_new_plane_in_state(state, plane, plane_state, i) {
1639 funcs = plane->helper_private;
1640 funcs->atomic_async_update(plane, plane_state);
1643 * ->atomic_async_update() is supposed to update the
1644 * plane->state in-place, make sure at least common
1645 * properties have been properly updated.
1647 WARN_ON_ONCE(plane->state->fb != plane_state->fb);
1648 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1649 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1650 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1651 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1654 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1657 * drm_atomic_helper_commit - commit validated state object
1659 * @state: the driver state object
1660 * @nonblock: whether nonblocking behavior is requested.
1662 * This function commits a with drm_atomic_helper_check() pre-validated state
1663 * object. This can still fail when e.g. the framebuffer reservation fails. This
1664 * function implements nonblocking commits, using
1665 * drm_atomic_helper_setup_commit() and related functions.
1667 * Committing the actual hardware state is done through the
1668 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default
1669 * implementation drm_atomic_helper_commit_tail().
1672 * Zero for success or -errno.
1674 int drm_atomic_helper_commit(struct drm_device *dev,
1675 struct drm_atomic_state *state,
1680 if (state->async_update) {
1681 ret = drm_atomic_helper_prepare_planes(dev, state);
1685 drm_atomic_helper_async_commit(dev, state);
1686 drm_atomic_helper_cleanup_planes(dev, state);
1691 ret = drm_atomic_helper_setup_commit(state, nonblock);
1695 INIT_WORK(&state->commit_work, commit_work);
1697 ret = drm_atomic_helper_prepare_planes(dev, state);
1702 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1708 * This is the point of no return - everything below never fails except
1709 * when the hw goes bonghits. Which means we can commit the new state on
1710 * the software side now.
1713 ret = drm_atomic_helper_swap_state(state, true);
1718 * Everything below can be run asynchronously without the need to grab
1719 * any modeset locks at all under one condition: It must be guaranteed
1720 * that the asynchronous work has either been cancelled (if the driver
1721 * supports it, which at least requires that the framebuffers get
1722 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1723 * before the new state gets committed on the software side with
1724 * drm_atomic_helper_swap_state().
1726 * This scheme allows new atomic state updates to be prepared and
1727 * checked in parallel to the asynchronous completion of the previous
1728 * update. Which is important since compositors need to figure out the
1729 * composition of the next frame right after having submitted the
1732 * NOTE: Commit work has multiple phases, first hardware commit, then
1733 * cleanup. We want them to overlap, hence need system_unbound_wq to
1734 * make sure work items don't artifically stall on each another.
1737 drm_atomic_state_get(state);
1739 queue_work(system_unbound_wq, &state->commit_work);
1746 drm_atomic_helper_cleanup_planes(dev, state);
1749 EXPORT_SYMBOL(drm_atomic_helper_commit);
1752 * DOC: implementing nonblocking commit
1754 * Nonblocking atomic commits have to be implemented in the following sequence:
1756 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1757 * which commit needs to call which can fail, so we want to run it first and
1760 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1761 * might be affected the new state update. This can be done by either cancelling
1762 * or flushing the work items, depending upon whether the driver can deal with
1763 * cancelled updates. Note that it is important to ensure that the framebuffer
1764 * cleanup is still done when cancelling.
1766 * Asynchronous workers need to have sufficient parallelism to be able to run
1767 * different atomic commits on different CRTCs in parallel. The simplest way to
1768 * achive this is by running them on the &system_unbound_wq work queue. Note
1769 * that drivers are not required to split up atomic commits and run an
1770 * individual commit in parallel - userspace is supposed to do that if it cares.
1771 * But it might be beneficial to do that for modesets, since those necessarily
1772 * must be done as one global operation, and enabling or disabling a CRTC can
1773 * take a long time. But even that is not required.
1775 * 3. The software state is updated synchronously with
1776 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1777 * locks means concurrent callers never see inconsistent state. And doing this
1778 * while it's guaranteed that no relevant nonblocking worker runs means that
1779 * nonblocking workers do not need grab any locks. Actually they must not grab
1780 * locks, for otherwise the work flushing will deadlock.
1782 * 4. Schedule a work item to do all subsequent steps, using the split-out
1783 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1784 * then cleaning up the framebuffers after the old framebuffer is no longer
1787 * The above scheme is implemented in the atomic helper libraries in
1788 * drm_atomic_helper_commit() using a bunch of helper functions. See
1789 * drm_atomic_helper_setup_commit() for a starting point.
1792 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1794 struct drm_crtc_commit *commit, *stall_commit = NULL;
1795 bool completed = true;
1799 spin_lock(&crtc->commit_lock);
1801 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1803 completed = try_wait_for_completion(&commit->flip_done);
1804 /* Userspace is not allowed to get ahead of the previous
1805 * commit with nonblocking ones. */
1806 if (!completed && nonblock) {
1807 spin_unlock(&crtc->commit_lock);
1810 } else if (i == 1) {
1811 stall_commit = drm_crtc_commit_get(commit);
1817 spin_unlock(&crtc->commit_lock);
1822 /* We don't want to let commits get ahead of cleanup work too much,
1823 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1825 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1828 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1829 crtc->base.id, crtc->name);
1831 drm_crtc_commit_put(stall_commit);
1833 return ret < 0 ? ret : 0;
1836 static void release_crtc_commit(struct completion *completion)
1838 struct drm_crtc_commit *commit = container_of(completion,
1842 drm_crtc_commit_put(commit);
1845 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
1847 init_completion(&commit->flip_done);
1848 init_completion(&commit->hw_done);
1849 init_completion(&commit->cleanup_done);
1850 INIT_LIST_HEAD(&commit->commit_entry);
1851 kref_init(&commit->ref);
1852 commit->crtc = crtc;
1855 static struct drm_crtc_commit *
1856 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
1859 struct drm_crtc_state *new_crtc_state;
1861 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
1863 return new_crtc_state->commit;
1866 if (!state->fake_commit) {
1867 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
1868 if (!state->fake_commit)
1871 init_commit(state->fake_commit, NULL);
1874 return state->fake_commit;
1878 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1879 * @state: new modeset state to be committed
1880 * @nonblock: whether nonblocking behavior is requested.
1882 * This function prepares @state to be used by the atomic helper's support for
1883 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1884 * should always call this function from their
1885 * &drm_mode_config_funcs.atomic_commit hook.
1887 * To be able to use this support drivers need to use a few more helper
1888 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1889 * actually committing the hardware state, and for nonblocking commits this call
1890 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1891 * and it's stall parameter, for when a driver's commit hooks look at the
1892 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1894 * Completion of the hardware commit step must be signalled using
1895 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1896 * to read or change any permanent software or hardware modeset state. The only
1897 * exception is state protected by other means than &drm_modeset_lock locks.
1898 * Only the free standing @state with pointers to the old state structures can
1899 * be inspected, e.g. to clean up old buffers using
1900 * drm_atomic_helper_cleanup_planes().
1902 * At the very end, before cleaning up @state drivers must call
1903 * drm_atomic_helper_commit_cleanup_done().
1905 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1906 * complete and easy-to-use default implementation of the atomic_commit() hook.
1908 * The tracking of asynchronously executed and still pending commits is done
1909 * using the core structure &drm_crtc_commit.
1911 * By default there's no need to clean up resources allocated by this function
1912 * explicitly: drm_atomic_state_default_clear() will take care of that
1917 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1918 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1920 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1923 struct drm_crtc *crtc;
1924 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1925 struct drm_connector *conn;
1926 struct drm_connector_state *old_conn_state, *new_conn_state;
1927 struct drm_plane *plane;
1928 struct drm_plane_state *old_plane_state, *new_plane_state;
1929 struct drm_crtc_commit *commit;
1932 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1933 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1937 init_commit(commit, crtc);
1939 new_crtc_state->commit = commit;
1941 ret = stall_checks(crtc, nonblock);
1945 /* Drivers only send out events when at least either current or
1946 * new CRTC state is active. Complete right away if everything
1948 if (!old_crtc_state->active && !new_crtc_state->active) {
1949 complete_all(&commit->flip_done);
1953 /* Legacy cursor updates are fully unsynced. */
1954 if (state->legacy_cursor_update) {
1955 complete_all(&commit->flip_done);
1959 if (!new_crtc_state->event) {
1960 commit->event = kzalloc(sizeof(*commit->event),
1965 new_crtc_state->event = commit->event;
1968 new_crtc_state->event->base.completion = &commit->flip_done;
1969 new_crtc_state->event->base.completion_release = release_crtc_commit;
1970 drm_crtc_commit_get(commit);
1972 commit->abort_completion = true;
1974 state->crtcs[i].commit = commit;
1975 drm_crtc_commit_get(commit);
1978 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
1979 /* Userspace is not allowed to get ahead of the previous
1980 * commit with nonblocking ones. */
1981 if (nonblock && old_conn_state->commit &&
1982 !try_wait_for_completion(&old_conn_state->commit->flip_done))
1985 /* Always track connectors explicitly for e.g. link retraining. */
1986 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
1990 new_conn_state->commit = drm_crtc_commit_get(commit);
1993 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
1994 /* Userspace is not allowed to get ahead of the previous
1995 * commit with nonblocking ones. */
1996 if (nonblock && old_plane_state->commit &&
1997 !try_wait_for_completion(&old_plane_state->commit->flip_done))
2000 /* Always track planes explicitly for async pageflip support. */
2001 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2005 new_plane_state->commit = drm_crtc_commit_get(commit);
2010 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2013 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2014 * @old_state: atomic state object with old state structures
2016 * This function waits for all preceeding commits that touch the same CRTC as
2017 * @old_state to both be committed to the hardware (as signalled by
2018 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
2019 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2021 * This is part of the atomic helper support for nonblocking commits, see
2022 * drm_atomic_helper_setup_commit() for an overview.
2024 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2026 struct drm_crtc *crtc;
2027 struct drm_crtc_state *old_crtc_state;
2028 struct drm_plane *plane;
2029 struct drm_plane_state *old_plane_state;
2030 struct drm_connector *conn;
2031 struct drm_connector_state *old_conn_state;
2032 struct drm_crtc_commit *commit;
2036 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2037 commit = old_crtc_state->commit;
2042 ret = wait_for_completion_timeout(&commit->hw_done,
2045 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2046 crtc->base.id, crtc->name);
2048 /* Currently no support for overwriting flips, hence
2049 * stall for previous one to execute completely. */
2050 ret = wait_for_completion_timeout(&commit->flip_done,
2053 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
2054 crtc->base.id, crtc->name);
2057 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2058 commit = old_conn_state->commit;
2063 ret = wait_for_completion_timeout(&commit->hw_done,
2066 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
2067 conn->base.id, conn->name);
2069 /* Currently no support for overwriting flips, hence
2070 * stall for previous one to execute completely. */
2071 ret = wait_for_completion_timeout(&commit->flip_done,
2074 DRM_ERROR("[CONNECTOR:%d:%s] flip_done timed out\n",
2075 conn->base.id, conn->name);
2078 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2079 commit = old_plane_state->commit;
2084 ret = wait_for_completion_timeout(&commit->hw_done,
2087 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
2088 plane->base.id, plane->name);
2090 /* Currently no support for overwriting flips, hence
2091 * stall for previous one to execute completely. */
2092 ret = wait_for_completion_timeout(&commit->flip_done,
2095 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2096 plane->base.id, plane->name);
2099 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2102 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2103 * @old_state: atomic state object with old state structures
2105 * This function walks all CRTCs and fake VBLANK events on those with
2106 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2107 * The primary use of this function is writeback connectors working in oneshot
2108 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2109 * when a job is queued, and any change to the pipeline that does not touch the
2110 * connector is leading to timeouts when calling
2111 * drm_atomic_helper_wait_for_vblanks() or
2112 * drm_atomic_helper_wait_for_flip_done().
2114 * This is part of the atomic helper support for nonblocking commits, see
2115 * drm_atomic_helper_setup_commit() for an overview.
2117 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2119 struct drm_crtc_state *new_crtc_state;
2120 struct drm_crtc *crtc;
2123 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2124 unsigned long flags;
2126 if (!new_crtc_state->no_vblank)
2129 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2130 if (new_crtc_state->event) {
2131 drm_crtc_send_vblank_event(crtc,
2132 new_crtc_state->event);
2133 new_crtc_state->event = NULL;
2135 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2138 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2141 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2142 * @old_state: atomic state object with old state structures
2144 * This function is used to signal completion of the hardware commit step. After
2145 * this step the driver is not allowed to read or change any permanent software
2146 * or hardware modeset state. The only exception is state protected by other
2147 * means than &drm_modeset_lock locks.
2149 * Drivers should try to postpone any expensive or delayed cleanup work after
2150 * this function is called.
2152 * This is part of the atomic helper support for nonblocking commits, see
2153 * drm_atomic_helper_setup_commit() for an overview.
2155 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2157 struct drm_crtc *crtc;
2158 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2159 struct drm_crtc_commit *commit;
2162 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2163 commit = new_crtc_state->commit;
2168 * copy new_crtc_state->commit to old_crtc_state->commit,
2169 * it's unsafe to touch new_crtc_state after hw_done,
2170 * but we still need to do so in cleanup_done().
2172 if (old_crtc_state->commit)
2173 drm_crtc_commit_put(old_crtc_state->commit);
2175 old_crtc_state->commit = drm_crtc_commit_get(commit);
2177 /* backend must have consumed any event by now */
2178 WARN_ON(new_crtc_state->event);
2179 complete_all(&commit->hw_done);
2182 if (old_state->fake_commit) {
2183 complete_all(&old_state->fake_commit->hw_done);
2184 complete_all(&old_state->fake_commit->flip_done);
2187 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2190 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2191 * @old_state: atomic state object with old state structures
2193 * This signals completion of the atomic update @old_state, including any
2194 * cleanup work. If used, it must be called right before calling
2195 * drm_atomic_state_put().
2197 * This is part of the atomic helper support for nonblocking commits, see
2198 * drm_atomic_helper_setup_commit() for an overview.
2200 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2202 struct drm_crtc *crtc;
2203 struct drm_crtc_state *old_crtc_state;
2204 struct drm_crtc_commit *commit;
2207 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2208 commit = old_crtc_state->commit;
2209 if (WARN_ON(!commit))
2212 complete_all(&commit->cleanup_done);
2213 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2215 spin_lock(&crtc->commit_lock);
2216 list_del(&commit->commit_entry);
2217 spin_unlock(&crtc->commit_lock);
2220 if (old_state->fake_commit)
2221 complete_all(&old_state->fake_commit->cleanup_done);
2223 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2226 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2228 * @state: atomic state object with new state structures
2230 * This function prepares plane state, specifically framebuffers, for the new
2231 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2232 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2233 * any already successfully prepared framebuffer.
2236 * 0 on success, negative error code on failure.
2238 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2239 struct drm_atomic_state *state)
2241 struct drm_plane *plane;
2242 struct drm_plane_state *new_plane_state;
2245 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2246 const struct drm_plane_helper_funcs *funcs;
2248 funcs = plane->helper_private;
2250 if (funcs->prepare_fb) {
2251 ret = funcs->prepare_fb(plane, new_plane_state);
2260 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2261 const struct drm_plane_helper_funcs *funcs;
2266 funcs = plane->helper_private;
2268 if (funcs->cleanup_fb)
2269 funcs->cleanup_fb(plane, new_plane_state);
2274 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2276 static bool plane_crtc_active(const struct drm_plane_state *state)
2278 return state->crtc && state->crtc->state->active;
2282 * drm_atomic_helper_commit_planes - commit plane state
2284 * @old_state: atomic state object with old state structures
2285 * @flags: flags for committing plane state
2287 * This function commits the new plane state using the plane and atomic helper
2288 * functions for planes and crtcs. It assumes that the atomic state has already
2289 * been pushed into the relevant object state pointers, since this step can no
2292 * It still requires the global state object @old_state to know which planes and
2293 * crtcs need to be updated though.
2295 * Note that this function does all plane updates across all CRTCs in one step.
2296 * If the hardware can't support this approach look at
2297 * drm_atomic_helper_commit_planes_on_crtc() instead.
2299 * Plane parameters can be updated by applications while the associated CRTC is
2300 * disabled. The DRM/KMS core will store the parameters in the plane state,
2301 * which will be available to the driver when the CRTC is turned on. As a result
2302 * most drivers don't need to be immediately notified of plane updates for a
2305 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2306 * @flags in order not to receive plane update notifications related to a
2307 * disabled CRTC. This avoids the need to manually ignore plane updates in
2308 * driver code when the driver and/or hardware can't or just don't need to deal
2309 * with updates on disabled CRTCs, for example when supporting runtime PM.
2311 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2312 * display controllers require to disable a CRTC's planes when the CRTC is
2313 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2314 * call for a plane if the CRTC of the old plane state needs a modesetting
2315 * operation. Of course, the drivers need to disable the planes in their CRTC
2316 * disable callbacks since no one else would do that.
2318 * The drm_atomic_helper_commit() default implementation doesn't set the
2319 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2320 * This should not be copied blindly by drivers.
2322 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2323 struct drm_atomic_state *old_state,
2326 struct drm_crtc *crtc;
2327 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2328 struct drm_plane *plane;
2329 struct drm_plane_state *old_plane_state, *new_plane_state;
2331 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2332 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2334 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2335 const struct drm_crtc_helper_funcs *funcs;
2337 funcs = crtc->helper_private;
2339 if (!funcs || !funcs->atomic_begin)
2342 if (active_only && !new_crtc_state->active)
2345 funcs->atomic_begin(crtc, old_crtc_state);
2348 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2349 const struct drm_plane_helper_funcs *funcs;
2352 funcs = plane->helper_private;
2357 disabling = drm_atomic_plane_disabling(old_plane_state,
2362 * Skip planes related to inactive CRTCs. If the plane
2363 * is enabled use the state of the current CRTC. If the
2364 * plane is being disabled use the state of the old
2365 * CRTC to avoid skipping planes being disabled on an
2368 if (!disabling && !plane_crtc_active(new_plane_state))
2370 if (disabling && !plane_crtc_active(old_plane_state))
2375 * Special-case disabling the plane if drivers support it.
2377 if (disabling && funcs->atomic_disable) {
2378 struct drm_crtc_state *crtc_state;
2380 crtc_state = old_plane_state->crtc->state;
2382 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2386 funcs->atomic_disable(plane, old_plane_state);
2387 } else if (new_plane_state->crtc || disabling) {
2388 funcs->atomic_update(plane, old_plane_state);
2392 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2393 const struct drm_crtc_helper_funcs *funcs;
2395 funcs = crtc->helper_private;
2397 if (!funcs || !funcs->atomic_flush)
2400 if (active_only && !new_crtc_state->active)
2403 funcs->atomic_flush(crtc, old_crtc_state);
2406 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2409 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
2410 * @old_crtc_state: atomic state object with the old crtc state
2412 * This function commits the new plane state using the plane and atomic helper
2413 * functions for planes on the specific crtc. It assumes that the atomic state
2414 * has already been pushed into the relevant object state pointers, since this
2415 * step can no longer fail.
2417 * This function is useful when plane updates should be done crtc-by-crtc
2418 * instead of one global step like drm_atomic_helper_commit_planes() does.
2420 * This function can only be savely used when planes are not allowed to move
2421 * between different CRTCs because this function doesn't handle inter-CRTC
2422 * depencies. Callers need to ensure that either no such depencies exist,
2423 * resolve them through ordering of commit calls or through some other means.
2426 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2428 const struct drm_crtc_helper_funcs *crtc_funcs;
2429 struct drm_crtc *crtc = old_crtc_state->crtc;
2430 struct drm_atomic_state *old_state = old_crtc_state->state;
2431 struct drm_crtc_state *new_crtc_state =
2432 drm_atomic_get_new_crtc_state(old_state, crtc);
2433 struct drm_plane *plane;
2434 unsigned plane_mask;
2436 plane_mask = old_crtc_state->plane_mask;
2437 plane_mask |= new_crtc_state->plane_mask;
2439 crtc_funcs = crtc->helper_private;
2440 if (crtc_funcs && crtc_funcs->atomic_begin)
2441 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2443 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2444 struct drm_plane_state *old_plane_state =
2445 drm_atomic_get_old_plane_state(old_state, plane);
2446 struct drm_plane_state *new_plane_state =
2447 drm_atomic_get_new_plane_state(old_state, plane);
2448 const struct drm_plane_helper_funcs *plane_funcs;
2450 plane_funcs = plane->helper_private;
2452 if (!old_plane_state || !plane_funcs)
2455 WARN_ON(new_plane_state->crtc &&
2456 new_plane_state->crtc != crtc);
2458 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2459 plane_funcs->atomic_disable)
2460 plane_funcs->atomic_disable(plane, old_plane_state);
2461 else if (new_plane_state->crtc ||
2462 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2463 plane_funcs->atomic_update(plane, old_plane_state);
2466 if (crtc_funcs && crtc_funcs->atomic_flush)
2467 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2469 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2472 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2473 * @old_crtc_state: atomic state object with the old CRTC state
2474 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2476 * Disables all planes associated with the given CRTC. This can be
2477 * used for instance in the CRTC helper atomic_disable callback to disable
2480 * If the atomic-parameter is set the function calls the CRTC's
2481 * atomic_begin hook before and atomic_flush hook after disabling the
2484 * It is a bug to call this function without having implemented the
2485 * &drm_plane_helper_funcs.atomic_disable plane hook.
2488 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2491 struct drm_crtc *crtc = old_crtc_state->crtc;
2492 const struct drm_crtc_helper_funcs *crtc_funcs =
2493 crtc->helper_private;
2494 struct drm_plane *plane;
2496 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2497 crtc_funcs->atomic_begin(crtc, NULL);
2499 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2500 const struct drm_plane_helper_funcs *plane_funcs =
2501 plane->helper_private;
2506 WARN_ON(!plane_funcs->atomic_disable);
2507 if (plane_funcs->atomic_disable)
2508 plane_funcs->atomic_disable(plane, NULL);
2511 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2512 crtc_funcs->atomic_flush(crtc, NULL);
2514 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2517 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2519 * @old_state: atomic state object with old state structures
2521 * This function cleans up plane state, specifically framebuffers, from the old
2522 * configuration. Hence the old configuration must be perserved in @old_state to
2523 * be able to call this function.
2525 * This function must also be called on the new state when the atomic update
2526 * fails at any point after calling drm_atomic_helper_prepare_planes().
2528 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2529 struct drm_atomic_state *old_state)
2531 struct drm_plane *plane;
2532 struct drm_plane_state *old_plane_state, *new_plane_state;
2535 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2536 const struct drm_plane_helper_funcs *funcs;
2537 struct drm_plane_state *plane_state;
2540 * This might be called before swapping when commit is aborted,
2541 * in which case we have to cleanup the new state.
2543 if (old_plane_state == plane->state)
2544 plane_state = new_plane_state;
2546 plane_state = old_plane_state;
2548 funcs = plane->helper_private;
2550 if (funcs->cleanup_fb)
2551 funcs->cleanup_fb(plane, plane_state);
2554 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2557 * drm_atomic_helper_swap_state - store atomic state into current sw state
2558 * @state: atomic state
2559 * @stall: stall for preceeding commits
2561 * This function stores the atomic state into the current state pointers in all
2562 * driver objects. It should be called after all failing steps have been done
2563 * and succeeded, but before the actual hardware state is committed.
2565 * For cleanup and error recovery the current state for all changed objects will
2566 * be swapped into @state.
2568 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2570 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2572 * 2. Do any other steps that might fail.
2574 * 3. Put the staged state into the current state pointers with this function.
2576 * 4. Actually commit the hardware state.
2578 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2579 * contains the old state. Also do any other cleanup required with that state.
2581 * @stall must be set when nonblocking commits for this driver directly access
2582 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2583 * the current atomic helpers this is almost always the case, since the helpers
2584 * don't pass the right state structures to the callbacks.
2588 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2589 * waiting for the previous commits has been interrupted.
2591 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2595 struct drm_connector *connector;
2596 struct drm_connector_state *old_conn_state, *new_conn_state;
2597 struct drm_crtc *crtc;
2598 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2599 struct drm_plane *plane;
2600 struct drm_plane_state *old_plane_state, *new_plane_state;
2601 struct drm_crtc_commit *commit;
2602 struct drm_private_obj *obj;
2603 struct drm_private_state *old_obj_state, *new_obj_state;
2607 * We have to stall for hw_done here before
2608 * drm_atomic_helper_wait_for_dependencies() because flip
2609 * depth > 1 is not yet supported by all drivers. As long as
2610 * obj->state is directly dereferenced anywhere in the drivers
2611 * atomic_commit_tail function, then it's unsafe to swap state
2612 * before drm_atomic_helper_commit_hw_done() is called.
2615 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2616 commit = old_crtc_state->commit;
2621 ret = wait_for_completion_interruptible(&commit->hw_done);
2626 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2627 commit = old_conn_state->commit;
2632 ret = wait_for_completion_interruptible(&commit->hw_done);
2637 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2638 commit = old_plane_state->commit;
2643 ret = wait_for_completion_interruptible(&commit->hw_done);
2649 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2650 WARN_ON(connector->state != old_conn_state);
2652 old_conn_state->state = state;
2653 new_conn_state->state = NULL;
2655 state->connectors[i].state = old_conn_state;
2656 connector->state = new_conn_state;
2659 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2660 WARN_ON(crtc->state != old_crtc_state);
2662 old_crtc_state->state = state;
2663 new_crtc_state->state = NULL;
2665 state->crtcs[i].state = old_crtc_state;
2666 crtc->state = new_crtc_state;
2668 if (new_crtc_state->commit) {
2669 spin_lock(&crtc->commit_lock);
2670 list_add(&new_crtc_state->commit->commit_entry,
2671 &crtc->commit_list);
2672 spin_unlock(&crtc->commit_lock);
2674 new_crtc_state->commit->event = NULL;
2678 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2679 WARN_ON(plane->state != old_plane_state);
2681 old_plane_state->state = state;
2682 new_plane_state->state = NULL;
2684 state->planes[i].state = old_plane_state;
2685 plane->state = new_plane_state;
2688 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2689 WARN_ON(obj->state != old_obj_state);
2691 old_obj_state->state = state;
2692 new_obj_state->state = NULL;
2694 state->private_objs[i].state = old_obj_state;
2695 obj->state = new_obj_state;
2700 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2703 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2704 * @plane: plane object to update
2705 * @crtc: owning CRTC of owning plane
2706 * @fb: framebuffer to flip onto plane
2707 * @crtc_x: x offset of primary plane on crtc
2708 * @crtc_y: y offset of primary plane on crtc
2709 * @crtc_w: width of primary plane rectangle on crtc
2710 * @crtc_h: height of primary plane rectangle on crtc
2711 * @src_x: x offset of @fb for panning
2712 * @src_y: y offset of @fb for panning
2713 * @src_w: width of source rectangle in @fb
2714 * @src_h: height of source rectangle in @fb
2715 * @ctx: lock acquire context
2717 * Provides a default plane update handler using the atomic driver interface.
2720 * Zero on success, error code on failure
2722 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2723 struct drm_crtc *crtc,
2724 struct drm_framebuffer *fb,
2725 int crtc_x, int crtc_y,
2726 unsigned int crtc_w, unsigned int crtc_h,
2727 uint32_t src_x, uint32_t src_y,
2728 uint32_t src_w, uint32_t src_h,
2729 struct drm_modeset_acquire_ctx *ctx)
2731 struct drm_atomic_state *state;
2732 struct drm_plane_state *plane_state;
2735 state = drm_atomic_state_alloc(plane->dev);
2739 state->acquire_ctx = ctx;
2740 plane_state = drm_atomic_get_plane_state(state, plane);
2741 if (IS_ERR(plane_state)) {
2742 ret = PTR_ERR(plane_state);
2746 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2749 drm_atomic_set_fb_for_plane(plane_state, fb);
2750 plane_state->crtc_x = crtc_x;
2751 plane_state->crtc_y = crtc_y;
2752 plane_state->crtc_w = crtc_w;
2753 plane_state->crtc_h = crtc_h;
2754 plane_state->src_x = src_x;
2755 plane_state->src_y = src_y;
2756 plane_state->src_w = src_w;
2757 plane_state->src_h = src_h;
2759 if (plane == crtc->cursor)
2760 state->legacy_cursor_update = true;
2762 ret = drm_atomic_commit(state);
2764 drm_atomic_state_put(state);
2767 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2770 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2771 * @plane: plane to disable
2772 * @ctx: lock acquire context
2774 * Provides a default plane disable handler using the atomic driver interface.
2777 * Zero on success, error code on failure
2779 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2780 struct drm_modeset_acquire_ctx *ctx)
2782 struct drm_atomic_state *state;
2783 struct drm_plane_state *plane_state;
2786 state = drm_atomic_state_alloc(plane->dev);
2790 state->acquire_ctx = ctx;
2791 plane_state = drm_atomic_get_plane_state(state, plane);
2792 if (IS_ERR(plane_state)) {
2793 ret = PTR_ERR(plane_state);
2797 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2798 plane_state->state->legacy_cursor_update = true;
2800 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2804 ret = drm_atomic_commit(state);
2806 drm_atomic_state_put(state);
2809 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2811 /* just used from fb-helper and atomic-helper: */
2812 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2813 struct drm_plane_state *plane_state)
2817 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2821 drm_atomic_set_fb_for_plane(plane_state, NULL);
2822 plane_state->crtc_x = 0;
2823 plane_state->crtc_y = 0;
2824 plane_state->crtc_w = 0;
2825 plane_state->crtc_h = 0;
2826 plane_state->src_x = 0;
2827 plane_state->src_y = 0;
2828 plane_state->src_w = 0;
2829 plane_state->src_h = 0;
2834 static int update_output_state(struct drm_atomic_state *state,
2835 struct drm_mode_set *set)
2837 struct drm_device *dev = set->crtc->dev;
2838 struct drm_crtc *crtc;
2839 struct drm_crtc_state *new_crtc_state;
2840 struct drm_connector *connector;
2841 struct drm_connector_state *new_conn_state;
2844 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2845 state->acquire_ctx);
2849 /* First disable all connectors on the target crtc. */
2850 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2854 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2855 if (new_conn_state->crtc == set->crtc) {
2856 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2861 /* Make sure legacy setCrtc always re-trains */
2862 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2866 /* Then set all connectors from set->connectors on the target crtc */
2867 for (i = 0; i < set->num_connectors; i++) {
2868 new_conn_state = drm_atomic_get_connector_state(state,
2869 set->connectors[i]);
2870 if (IS_ERR(new_conn_state))
2871 return PTR_ERR(new_conn_state);
2873 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2879 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2880 /* Don't update ->enable for the CRTC in the set_config request,
2881 * since a mismatch would indicate a bug in the upper layers.
2882 * The actual modeset code later on will catch any
2883 * inconsistencies here. */
2884 if (crtc == set->crtc)
2887 if (!new_crtc_state->connector_mask) {
2888 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2893 new_crtc_state->active = false;
2901 * drm_atomic_helper_set_config - set a new config from userspace
2902 * @set: mode set configuration
2903 * @ctx: lock acquisition context
2905 * Provides a default crtc set_config handler using the atomic driver interface.
2907 * NOTE: For backwards compatibility with old userspace this automatically
2908 * resets the "link-status" property to GOOD, to force any link
2909 * re-training. The SETCRTC ioctl does not define whether an update does
2910 * need a full modeset or just a plane update, hence we're allowed to do
2911 * that. See also drm_connector_set_link_status_property().
2914 * Returns 0 on success, negative errno numbers on failure.
2916 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2917 struct drm_modeset_acquire_ctx *ctx)
2919 struct drm_atomic_state *state;
2920 struct drm_crtc *crtc = set->crtc;
2923 state = drm_atomic_state_alloc(crtc->dev);
2927 state->acquire_ctx = ctx;
2928 ret = __drm_atomic_helper_set_config(set, state);
2932 ret = handle_conflicting_encoders(state, true);
2936 ret = drm_atomic_commit(state);
2939 drm_atomic_state_put(state);
2942 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2944 /* just used from fb-helper and atomic-helper: */
2945 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2946 struct drm_atomic_state *state)
2948 struct drm_crtc_state *crtc_state;
2949 struct drm_plane_state *primary_state;
2950 struct drm_crtc *crtc = set->crtc;
2951 int hdisplay, vdisplay;
2954 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2955 if (IS_ERR(crtc_state))
2956 return PTR_ERR(crtc_state);
2958 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2959 if (IS_ERR(primary_state))
2960 return PTR_ERR(primary_state);
2964 WARN_ON(set->num_connectors);
2966 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2970 crtc_state->active = false;
2972 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2976 drm_atomic_set_fb_for_plane(primary_state, NULL);
2982 WARN_ON(!set->num_connectors);
2984 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2988 crtc_state->active = true;
2990 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2994 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2996 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2997 primary_state->crtc_x = 0;
2998 primary_state->crtc_y = 0;
2999 primary_state->crtc_w = hdisplay;
3000 primary_state->crtc_h = vdisplay;
3001 primary_state->src_x = set->x << 16;
3002 primary_state->src_y = set->y << 16;
3003 if (drm_rotation_90_or_270(primary_state->rotation)) {
3004 primary_state->src_w = vdisplay << 16;
3005 primary_state->src_h = hdisplay << 16;
3007 primary_state->src_w = hdisplay << 16;
3008 primary_state->src_h = vdisplay << 16;
3012 ret = update_output_state(state, set);
3019 static int __drm_atomic_helper_disable_all(struct drm_device *dev,
3020 struct drm_modeset_acquire_ctx *ctx,
3023 struct drm_atomic_state *state;
3024 struct drm_connector_state *conn_state;
3025 struct drm_connector *conn;
3026 struct drm_plane_state *plane_state;
3027 struct drm_plane *plane;
3028 struct drm_crtc_state *crtc_state;
3029 struct drm_crtc *crtc;
3032 state = drm_atomic_state_alloc(dev);
3036 state->acquire_ctx = ctx;
3038 drm_for_each_crtc(crtc, dev) {
3039 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3040 if (IS_ERR(crtc_state)) {
3041 ret = PTR_ERR(crtc_state);
3045 crtc_state->active = false;
3047 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3051 ret = drm_atomic_add_affected_planes(state, crtc);
3055 ret = drm_atomic_add_affected_connectors(state, crtc);
3060 for_each_new_connector_in_state(state, conn, conn_state, i) {
3061 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3066 for_each_new_plane_in_state(state, plane, plane_state, i) {
3067 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3071 drm_atomic_set_fb_for_plane(plane_state, NULL);
3074 ret = drm_atomic_commit(state);
3076 drm_atomic_state_put(state);
3081 * drm_atomic_helper_disable_all - disable all currently active outputs
3083 * @ctx: lock acquisition context
3085 * Loops through all connectors, finding those that aren't turned off and then
3086 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3087 * that they are connected to.
3089 * This is used for example in suspend/resume to disable all currently active
3090 * functions when suspending. If you just want to shut down everything at e.g.
3091 * driver unload, look at drm_atomic_helper_shutdown().
3093 * Note that if callers haven't already acquired all modeset locks this might
3094 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3097 * 0 on success or a negative error code on failure.
3100 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3101 * drm_atomic_helper_shutdown().
3103 int drm_atomic_helper_disable_all(struct drm_device *dev,
3104 struct drm_modeset_acquire_ctx *ctx)
3106 return __drm_atomic_helper_disable_all(dev, ctx, false);
3108 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3111 * drm_atomic_helper_shutdown - shutdown all CRTC
3114 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3115 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3116 * that also takes a snapshot of the modeset state to be restored on resume.
3118 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3119 * and it is the atomic version of drm_crtc_force_disable_all().
3121 void drm_atomic_helper_shutdown(struct drm_device *dev)
3123 struct drm_modeset_acquire_ctx ctx;
3126 drm_modeset_acquire_init(&ctx, 0);
3128 ret = drm_modeset_lock_all_ctx(dev, &ctx);
3130 ret = __drm_atomic_helper_disable_all(dev, &ctx, true);
3132 if (ret != -EDEADLK)
3135 drm_modeset_backoff(&ctx);
3139 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3141 drm_modeset_drop_locks(&ctx);
3142 drm_modeset_acquire_fini(&ctx);
3144 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3147 * drm_atomic_helper_suspend - subsystem-level suspend helper
3150 * Duplicates the current atomic state, disables all active outputs and then
3151 * returns a pointer to the original atomic state to the caller. Drivers can
3152 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3153 * restore the output configuration that was active at the time the system
3156 * Note that it is potentially unsafe to use this. The atomic state object
3157 * returned by this function is assumed to be persistent. Drivers must ensure
3158 * that this holds true. Before calling this function, drivers must make sure
3159 * to suspend fbdev emulation so that nothing can be using the device.
3162 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3163 * encoded error code on failure. Drivers should store the returned atomic
3164 * state object and pass it to the drm_atomic_helper_resume() helper upon
3168 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3169 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3171 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3173 struct drm_modeset_acquire_ctx ctx;
3174 struct drm_atomic_state *state;
3177 drm_modeset_acquire_init(&ctx, 0);
3180 err = drm_modeset_lock_all_ctx(dev, &ctx);
3182 state = ERR_PTR(err);
3186 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3190 err = drm_atomic_helper_disable_all(dev, &ctx);
3192 drm_atomic_state_put(state);
3193 state = ERR_PTR(err);
3198 if (PTR_ERR(state) == -EDEADLK) {
3199 drm_modeset_backoff(&ctx);
3203 drm_modeset_drop_locks(&ctx);
3204 drm_modeset_acquire_fini(&ctx);
3207 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3210 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3211 * @state: duplicated atomic state to commit
3212 * @ctx: pointer to acquire_ctx to use for commit.
3214 * The state returned by drm_atomic_helper_duplicate_state() and
3215 * drm_atomic_helper_suspend() is partially invalid, and needs to
3216 * be fixed up before commit.
3219 * 0 on success or a negative error code on failure.
3222 * drm_atomic_helper_suspend()
3224 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3225 struct drm_modeset_acquire_ctx *ctx)
3228 struct drm_plane *plane;
3229 struct drm_plane_state *new_plane_state;
3230 struct drm_connector *connector;
3231 struct drm_connector_state *new_conn_state;
3232 struct drm_crtc *crtc;
3233 struct drm_crtc_state *new_crtc_state;
3235 state->acquire_ctx = ctx;
3237 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3238 state->planes[i].old_state = plane->state;
3240 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3241 state->crtcs[i].old_state = crtc->state;
3243 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3244 state->connectors[i].old_state = connector->state;
3246 return drm_atomic_commit(state);
3248 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3251 * drm_atomic_helper_resume - subsystem-level resume helper
3253 * @state: atomic state to resume to
3255 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3256 * grabs all modeset locks and commits the atomic state object. This can be
3257 * used in conjunction with the drm_atomic_helper_suspend() helper to
3258 * implement suspend/resume for drivers that support atomic mode-setting.
3261 * 0 on success or a negative error code on failure.
3264 * drm_atomic_helper_suspend()
3266 int drm_atomic_helper_resume(struct drm_device *dev,
3267 struct drm_atomic_state *state)
3269 struct drm_modeset_acquire_ctx ctx;
3272 drm_mode_config_reset(dev);
3274 drm_modeset_acquire_init(&ctx, 0);
3276 err = drm_modeset_lock_all_ctx(dev, &ctx);
3280 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3282 if (err != -EDEADLK)
3285 drm_modeset_backoff(&ctx);
3288 drm_atomic_state_put(state);
3289 drm_modeset_drop_locks(&ctx);
3290 drm_modeset_acquire_fini(&ctx);
3294 EXPORT_SYMBOL(drm_atomic_helper_resume);
3296 static int page_flip_common(struct drm_atomic_state *state,
3297 struct drm_crtc *crtc,
3298 struct drm_framebuffer *fb,
3299 struct drm_pending_vblank_event *event,
3302 struct drm_plane *plane = crtc->primary;
3303 struct drm_plane_state *plane_state;
3304 struct drm_crtc_state *crtc_state;
3307 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3308 if (IS_ERR(crtc_state))
3309 return PTR_ERR(crtc_state);
3311 crtc_state->event = event;
3312 crtc_state->pageflip_flags = flags;
3314 plane_state = drm_atomic_get_plane_state(state, plane);
3315 if (IS_ERR(plane_state))
3316 return PTR_ERR(plane_state);
3318 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3321 drm_atomic_set_fb_for_plane(plane_state, fb);
3323 /* Make sure we don't accidentally do a full modeset. */
3324 state->allow_modeset = false;
3325 if (!crtc_state->active) {
3326 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3327 crtc->base.id, crtc->name);
3335 * drm_atomic_helper_page_flip - execute a legacy page flip
3337 * @fb: DRM framebuffer
3338 * @event: optional DRM event to signal upon completion
3339 * @flags: flip flags for non-vblank sync'ed updates
3340 * @ctx: lock acquisition context
3342 * Provides a default &drm_crtc_funcs.page_flip implementation
3343 * using the atomic driver interface.
3346 * Returns 0 on success, negative errno numbers on failure.
3349 * drm_atomic_helper_page_flip_target()
3351 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3352 struct drm_framebuffer *fb,
3353 struct drm_pending_vblank_event *event,
3355 struct drm_modeset_acquire_ctx *ctx)
3357 struct drm_plane *plane = crtc->primary;
3358 struct drm_atomic_state *state;
3361 state = drm_atomic_state_alloc(plane->dev);
3365 state->acquire_ctx = ctx;
3367 ret = page_flip_common(state, crtc, fb, event, flags);
3371 ret = drm_atomic_nonblocking_commit(state);
3373 drm_atomic_state_put(state);
3376 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3379 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3381 * @fb: DRM framebuffer
3382 * @event: optional DRM event to signal upon completion
3383 * @flags: flip flags for non-vblank sync'ed updates
3384 * @target: specifying the target vblank period when the flip to take effect
3385 * @ctx: lock acquisition context
3387 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3388 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3389 * target vblank period to flip.
3392 * Returns 0 on success, negative errno numbers on failure.
3394 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3395 struct drm_framebuffer *fb,
3396 struct drm_pending_vblank_event *event,
3399 struct drm_modeset_acquire_ctx *ctx)
3401 struct drm_plane *plane = crtc->primary;
3402 struct drm_atomic_state *state;
3403 struct drm_crtc_state *crtc_state;
3406 state = drm_atomic_state_alloc(plane->dev);
3410 state->acquire_ctx = ctx;
3412 ret = page_flip_common(state, crtc, fb, event, flags);
3416 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3417 if (WARN_ON(!crtc_state)) {
3421 crtc_state->target_vblank = target;
3423 ret = drm_atomic_nonblocking_commit(state);
3425 drm_atomic_state_put(state);
3428 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);