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_atomic_helper.h>
33 #include <drm/drm_writeback.h>
34 #include <drm/drm_damage_helper.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 it's been notified,
336 * Additionally, we also want to ignore connector registration when
337 * we're trying to restore an atomic state during system resume since
338 * there's a chance the connector may have been destroyed during the
339 * process, but it's better to ignore that then cause
340 * drm_atomic_helper_resume() to fail.
342 if (!state->duplicated && drm_connector_is_unregistered(connector) &&
343 crtc_state->active) {
344 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] is not registered\n",
345 connector->base.id, connector->name);
349 funcs = connector->helper_private;
351 if (funcs->atomic_best_encoder)
352 new_encoder = funcs->atomic_best_encoder(connector,
353 new_connector_state);
354 else if (funcs->best_encoder)
355 new_encoder = funcs->best_encoder(connector);
357 new_encoder = pick_single_encoder_for_connector(connector);
360 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
366 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
367 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
368 new_encoder->base.id,
370 new_connector_state->crtc->base.id,
371 new_connector_state->crtc->name);
375 if (new_encoder == new_connector_state->best_encoder) {
376 set_best_encoder(state, new_connector_state, new_encoder);
378 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
381 new_encoder->base.id,
383 new_connector_state->crtc->base.id,
384 new_connector_state->crtc->name);
389 steal_encoder(state, new_encoder);
391 set_best_encoder(state, new_connector_state, new_encoder);
393 crtc_state->connectors_changed = true;
395 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
398 new_encoder->base.id,
400 new_connector_state->crtc->base.id,
401 new_connector_state->crtc->name);
407 mode_fixup(struct drm_atomic_state *state)
409 struct drm_crtc *crtc;
410 struct drm_crtc_state *new_crtc_state;
411 struct drm_connector *connector;
412 struct drm_connector_state *new_conn_state;
416 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
417 if (!new_crtc_state->mode_changed &&
418 !new_crtc_state->connectors_changed)
421 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
424 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
425 const struct drm_encoder_helper_funcs *funcs;
426 struct drm_encoder *encoder;
428 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
430 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
434 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
437 * Each encoder has at most one connector (since we always steal
438 * it away), so we won't call ->mode_fixup twice.
440 encoder = new_conn_state->best_encoder;
441 funcs = encoder->helper_private;
443 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
444 &new_crtc_state->adjusted_mode);
446 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
450 if (funcs && funcs->atomic_check) {
451 ret = funcs->atomic_check(encoder, new_crtc_state,
454 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
455 encoder->base.id, encoder->name);
458 } else if (funcs && funcs->mode_fixup) {
459 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
460 &new_crtc_state->adjusted_mode);
462 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
463 encoder->base.id, encoder->name);
469 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
470 const struct drm_crtc_helper_funcs *funcs;
472 if (!new_crtc_state->enable)
475 if (!new_crtc_state->mode_changed &&
476 !new_crtc_state->connectors_changed)
479 funcs = crtc->helper_private;
480 if (!funcs->mode_fixup)
483 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
484 &new_crtc_state->adjusted_mode);
486 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
487 crtc->base.id, crtc->name);
495 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
496 struct drm_encoder *encoder,
497 struct drm_crtc *crtc,
498 struct drm_display_mode *mode)
500 enum drm_mode_status ret;
502 ret = drm_encoder_mode_valid(encoder, mode);
503 if (ret != MODE_OK) {
504 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
505 encoder->base.id, encoder->name);
509 ret = drm_bridge_mode_valid(encoder->bridge, mode);
510 if (ret != MODE_OK) {
511 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
515 ret = drm_crtc_mode_valid(crtc, mode);
516 if (ret != MODE_OK) {
517 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
518 crtc->base.id, crtc->name);
526 mode_valid(struct drm_atomic_state *state)
528 struct drm_connector_state *conn_state;
529 struct drm_connector *connector;
532 for_each_new_connector_in_state(state, connector, conn_state, i) {
533 struct drm_encoder *encoder = conn_state->best_encoder;
534 struct drm_crtc *crtc = conn_state->crtc;
535 struct drm_crtc_state *crtc_state;
536 enum drm_mode_status mode_status;
537 struct drm_display_mode *mode;
539 if (!crtc || !encoder)
542 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
545 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
548 mode = &crtc_state->mode;
550 mode_status = mode_valid_path(connector, encoder, crtc, mode);
551 if (mode_status != MODE_OK)
559 * drm_atomic_helper_check_modeset - validate state object for modeset changes
561 * @state: the driver state object
563 * Check the state object to see if the requested state is physically possible.
564 * This does all the crtc and connector related computations for an atomic
565 * update and adds any additional connectors needed for full modesets. It calls
566 * the various per-object callbacks in the follow order:
568 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
569 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
570 * 3. If it's determined a modeset is needed then all connectors on the affected crtc
571 * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them.
572 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
573 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
574 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
575 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
576 * This function is only called when the encoder will be part of a configured crtc,
577 * it must not be used for implementing connector property validation.
578 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
580 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints.
582 * &drm_crtc_state.mode_changed is set when the input mode is changed.
583 * &drm_crtc_state.connectors_changed is set when a connector is added or
584 * removed from the crtc. &drm_crtc_state.active_changed is set when
585 * &drm_crtc_state.active changes, which is used for DPMS.
586 * See also: drm_atomic_crtc_needs_modeset()
590 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
591 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
592 * without a full modeset) _must_ call this function afterwards after that
593 * change. It is permitted to call this function multiple times for the same
594 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
595 * upon the adjusted dotclock for fifo space allocation and watermark
599 * Zero for success or -errno
602 drm_atomic_helper_check_modeset(struct drm_device *dev,
603 struct drm_atomic_state *state)
605 struct drm_crtc *crtc;
606 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
607 struct drm_connector *connector;
608 struct drm_connector_state *old_connector_state, *new_connector_state;
610 unsigned connectors_mask = 0;
612 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
613 bool has_connectors =
614 !!new_crtc_state->connector_mask;
616 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
618 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
619 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
620 crtc->base.id, crtc->name);
621 new_crtc_state->mode_changed = true;
624 if (old_crtc_state->enable != new_crtc_state->enable) {
625 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
626 crtc->base.id, crtc->name);
629 * For clarity this assignment is done here, but
630 * enable == 0 is only true when there are no
631 * connectors and a NULL mode.
633 * The other way around is true as well. enable != 0
634 * iff connectors are attached and a mode is set.
636 new_crtc_state->mode_changed = true;
637 new_crtc_state->connectors_changed = true;
640 if (old_crtc_state->active != new_crtc_state->active) {
641 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
642 crtc->base.id, crtc->name);
643 new_crtc_state->active_changed = true;
646 if (new_crtc_state->enable != has_connectors) {
647 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
648 crtc->base.id, crtc->name);
654 ret = handle_conflicting_encoders(state, false);
658 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
659 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
661 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
664 * This only sets crtc->connectors_changed for routing changes,
665 * drivers must set crtc->connectors_changed themselves when
666 * connector properties need to be updated.
668 ret = update_connector_routing(state, connector,
670 new_connector_state);
673 if (old_connector_state->crtc) {
674 new_crtc_state = drm_atomic_get_new_crtc_state(state,
675 old_connector_state->crtc);
676 if (old_connector_state->link_status !=
677 new_connector_state->link_status)
678 new_crtc_state->connectors_changed = true;
680 if (old_connector_state->max_requested_bpc !=
681 new_connector_state->max_requested_bpc)
682 new_crtc_state->connectors_changed = true;
685 if (funcs->atomic_check)
686 ret = funcs->atomic_check(connector, new_connector_state);
690 connectors_mask |= BIT(i);
694 * After all the routing has been prepared we need to add in any
695 * connector which is itself unchanged, but whose crtc changes its
696 * configuration. This must be done before calling mode_fixup in case a
697 * crtc only changed its mode but has the same set of connectors.
699 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
700 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
703 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
704 crtc->base.id, crtc->name,
705 new_crtc_state->enable ? 'y' : 'n',
706 new_crtc_state->active ? 'y' : 'n');
708 ret = drm_atomic_add_affected_connectors(state, crtc);
712 ret = drm_atomic_add_affected_planes(state, crtc);
718 * Iterate over all connectors again, to make sure atomic_check()
719 * has been called on them when a modeset is forced.
721 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
722 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
724 if (connectors_mask & BIT(i))
727 if (funcs->atomic_check)
728 ret = funcs->atomic_check(connector, new_connector_state);
733 ret = mode_valid(state);
737 return mode_fixup(state);
739 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
742 * drm_atomic_helper_check_plane_state() - Check plane state for validity
743 * @plane_state: plane state to check
744 * @crtc_state: crtc state to check
745 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
746 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
747 * @can_position: is it legal to position the plane such that it
748 * doesn't cover the entire crtc? This will generally
749 * only be false for primary planes.
750 * @can_update_disabled: can the plane be updated while the crtc
753 * Checks that a desired plane update is valid, and updates various
754 * bits of derived state (clipped coordinates etc.). Drivers that provide
755 * their own plane handling rather than helper-provided implementations may
756 * still wish to call this function to avoid duplication of error checking
760 * Zero if update appears valid, error code on failure
762 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
763 const struct drm_crtc_state *crtc_state,
767 bool can_update_disabled)
769 struct drm_framebuffer *fb = plane_state->fb;
770 struct drm_rect *src = &plane_state->src;
771 struct drm_rect *dst = &plane_state->dst;
772 unsigned int rotation = plane_state->rotation;
773 struct drm_rect clip = {};
776 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
778 *src = drm_plane_state_src(plane_state);
779 *dst = drm_plane_state_dest(plane_state);
782 plane_state->visible = false;
786 /* crtc should only be NULL when disabling (i.e., !fb) */
787 if (WARN_ON(!plane_state->crtc)) {
788 plane_state->visible = false;
792 if (!crtc_state->enable && !can_update_disabled) {
793 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
797 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
800 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
801 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
802 if (hscale < 0 || vscale < 0) {
803 DRM_DEBUG_KMS("Invalid scaling of plane\n");
804 drm_rect_debug_print("src: ", &plane_state->src, true);
805 drm_rect_debug_print("dst: ", &plane_state->dst, false);
809 if (crtc_state->enable)
810 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
812 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
814 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
816 if (!plane_state->visible)
818 * Plane isn't visible; some drivers can handle this
819 * so we just return success here. Drivers that can't
820 * (including those that use the primary plane helper's
821 * update function) will return an error from their
822 * update_plane handler.
826 if (!can_position && !drm_rect_equals(dst, &clip)) {
827 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
828 drm_rect_debug_print("dst: ", dst, false);
829 drm_rect_debug_print("clip: ", &clip, false);
835 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
838 * drm_atomic_helper_check_planes - validate state object for planes changes
840 * @state: the driver state object
842 * Check the state object to see if the requested state is physically possible.
843 * This does all the plane update related checks using by calling into the
844 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
845 * hooks provided by the driver.
847 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
851 * Zero for success or -errno
854 drm_atomic_helper_check_planes(struct drm_device *dev,
855 struct drm_atomic_state *state)
857 struct drm_crtc *crtc;
858 struct drm_crtc_state *new_crtc_state;
859 struct drm_plane *plane;
860 struct drm_plane_state *new_plane_state, *old_plane_state;
863 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
864 const struct drm_plane_helper_funcs *funcs;
866 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
868 funcs = plane->helper_private;
870 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
872 drm_atomic_helper_check_plane_damage(state, new_plane_state);
874 if (!funcs || !funcs->atomic_check)
877 ret = funcs->atomic_check(plane, new_plane_state);
879 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
880 plane->base.id, plane->name);
885 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
886 const struct drm_crtc_helper_funcs *funcs;
888 funcs = crtc->helper_private;
890 if (!funcs || !funcs->atomic_check)
893 ret = funcs->atomic_check(crtc, new_crtc_state);
895 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
896 crtc->base.id, crtc->name);
903 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
906 * drm_atomic_helper_check - validate state object
908 * @state: the driver state object
910 * Check the state object to see if the requested state is physically possible.
911 * Only crtcs and planes have check callbacks, so for any additional (global)
912 * checking that a driver needs it can simply wrap that around this function.
913 * Drivers without such needs can directly use this as their
914 * &drm_mode_config_funcs.atomic_check callback.
916 * This just wraps the two parts of the state checking for planes and modeset
917 * state in the default order: First it calls drm_atomic_helper_check_modeset()
918 * and then drm_atomic_helper_check_planes(). The assumption is that the
919 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
920 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
923 * Note that zpos normalization will add all enable planes to the state which
924 * might not desired for some drivers.
925 * For example enable/disable of a cursor plane which have fixed zpos value
926 * would trigger all other enabled planes to be forced to the state change.
929 * Zero for success or -errno
931 int drm_atomic_helper_check(struct drm_device *dev,
932 struct drm_atomic_state *state)
936 ret = drm_atomic_helper_check_modeset(dev, state);
940 if (dev->mode_config.normalize_zpos) {
941 ret = drm_atomic_normalize_zpos(dev, state);
946 ret = drm_atomic_helper_check_planes(dev, state);
950 if (state->legacy_cursor_update)
951 state->async_update = !drm_atomic_helper_async_check(dev, state);
955 EXPORT_SYMBOL(drm_atomic_helper_check);
958 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
960 struct drm_connector *connector;
961 struct drm_connector_state *old_conn_state, *new_conn_state;
962 struct drm_crtc *crtc;
963 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
966 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
967 const struct drm_encoder_helper_funcs *funcs;
968 struct drm_encoder *encoder;
970 /* Shut down everything that's in the changeset and currently
971 * still on. So need to check the old, saved state. */
972 if (!old_conn_state->crtc)
975 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
977 if (!old_crtc_state->active ||
978 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
981 encoder = old_conn_state->best_encoder;
983 /* We shouldn't get this far if we didn't previously have
984 * an encoder.. but WARN_ON() rather than explode.
986 if (WARN_ON(!encoder))
989 funcs = encoder->helper_private;
991 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
992 encoder->base.id, encoder->name);
995 * Each encoder has at most one connector (since we always steal
996 * it away), so we won't call disable hooks twice.
998 drm_bridge_disable(encoder->bridge);
1000 /* Right function depends upon target state. */
1002 if (new_conn_state->crtc && funcs->prepare)
1003 funcs->prepare(encoder);
1004 else if (funcs->disable)
1005 funcs->disable(encoder);
1006 else if (funcs->dpms)
1007 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
1010 drm_bridge_post_disable(encoder->bridge);
1013 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1014 const struct drm_crtc_helper_funcs *funcs;
1017 /* Shut down everything that needs a full modeset. */
1018 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1021 if (!old_crtc_state->active)
1024 funcs = crtc->helper_private;
1026 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
1027 crtc->base.id, crtc->name);
1030 /* Right function depends upon target state. */
1031 if (new_crtc_state->enable && funcs->prepare)
1032 funcs->prepare(crtc);
1033 else if (funcs->atomic_disable)
1034 funcs->atomic_disable(crtc, old_crtc_state);
1035 else if (funcs->disable)
1036 funcs->disable(crtc);
1038 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
1040 if (!(dev->irq_enabled && dev->num_crtcs))
1043 ret = drm_crtc_vblank_get(crtc);
1044 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1046 drm_crtc_vblank_put(crtc);
1051 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1053 * @old_state: atomic state object with old state structures
1055 * This function updates all the various legacy modeset state pointers in
1056 * connectors, encoders and crtcs. It also updates the timestamping constants
1057 * used for precise vblank timestamps by calling
1058 * drm_calc_timestamping_constants().
1060 * Drivers can use this for building their own atomic commit if they don't have
1061 * a pure helper-based modeset implementation.
1063 * Since these updates are not synchronized with lockings, only code paths
1064 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1065 * legacy state filled out by this helper. Defacto this means this helper and
1066 * the legacy state pointers are only really useful for transitioning an
1067 * existing driver to the atomic world.
1070 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1071 struct drm_atomic_state *old_state)
1073 struct drm_connector *connector;
1074 struct drm_connector_state *old_conn_state, *new_conn_state;
1075 struct drm_crtc *crtc;
1076 struct drm_crtc_state *new_crtc_state;
1079 /* clear out existing links and update dpms */
1080 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1081 if (connector->encoder) {
1082 WARN_ON(!connector->encoder->crtc);
1084 connector->encoder->crtc = NULL;
1085 connector->encoder = NULL;
1088 crtc = new_conn_state->crtc;
1089 if ((!crtc && old_conn_state->crtc) ||
1090 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1091 int mode = DRM_MODE_DPMS_OFF;
1093 if (crtc && crtc->state->active)
1094 mode = DRM_MODE_DPMS_ON;
1096 connector->dpms = mode;
1101 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1102 if (!new_conn_state->crtc)
1105 if (WARN_ON(!new_conn_state->best_encoder))
1108 connector->encoder = new_conn_state->best_encoder;
1109 connector->encoder->crtc = new_conn_state->crtc;
1112 /* set legacy state in the crtc structure */
1113 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1114 struct drm_plane *primary = crtc->primary;
1115 struct drm_plane_state *new_plane_state;
1117 crtc->mode = new_crtc_state->mode;
1118 crtc->enabled = new_crtc_state->enable;
1121 drm_atomic_get_new_plane_state(old_state, primary);
1123 if (new_plane_state && new_plane_state->crtc == crtc) {
1124 crtc->x = new_plane_state->src_x >> 16;
1125 crtc->y = new_plane_state->src_y >> 16;
1128 if (new_crtc_state->enable)
1129 drm_calc_timestamping_constants(crtc,
1130 &new_crtc_state->adjusted_mode);
1133 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1136 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1138 struct drm_crtc *crtc;
1139 struct drm_crtc_state *new_crtc_state;
1140 struct drm_connector *connector;
1141 struct drm_connector_state *new_conn_state;
1144 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1145 const struct drm_crtc_helper_funcs *funcs;
1147 if (!new_crtc_state->mode_changed)
1150 funcs = crtc->helper_private;
1152 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1153 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1154 crtc->base.id, crtc->name);
1156 funcs->mode_set_nofb(crtc);
1160 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1161 const struct drm_encoder_helper_funcs *funcs;
1162 struct drm_encoder *encoder;
1163 struct drm_display_mode *mode, *adjusted_mode;
1165 if (!new_conn_state->best_encoder)
1168 encoder = new_conn_state->best_encoder;
1169 funcs = encoder->helper_private;
1170 new_crtc_state = new_conn_state->crtc->state;
1171 mode = &new_crtc_state->mode;
1172 adjusted_mode = &new_crtc_state->adjusted_mode;
1174 if (!new_crtc_state->mode_changed)
1177 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1178 encoder->base.id, encoder->name);
1181 * Each encoder has at most one connector (since we always steal
1182 * it away), so we won't call mode_set hooks twice.
1184 if (funcs && funcs->atomic_mode_set) {
1185 funcs->atomic_mode_set(encoder, new_crtc_state,
1187 } else if (funcs && funcs->mode_set) {
1188 funcs->mode_set(encoder, mode, adjusted_mode);
1191 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
1196 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1198 * @old_state: atomic state object with old state structures
1200 * This function shuts down all the outputs that need to be shut down and
1201 * prepares them (if required) with the new mode.
1203 * For compatibility with legacy crtc helpers this should be called before
1204 * drm_atomic_helper_commit_planes(), which is what the default commit function
1205 * does. But drivers with different needs can group the modeset commits together
1206 * and do the plane commits at the end. This is useful for drivers doing runtime
1207 * PM since planes updates then only happen when the CRTC is actually enabled.
1209 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1210 struct drm_atomic_state *old_state)
1212 disable_outputs(dev, old_state);
1214 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1216 crtc_set_mode(dev, old_state);
1218 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1220 static void drm_atomic_helper_commit_writebacks(struct drm_device *dev,
1221 struct drm_atomic_state *old_state)
1223 struct drm_connector *connector;
1224 struct drm_connector_state *new_conn_state;
1227 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1228 const struct drm_connector_helper_funcs *funcs;
1230 funcs = connector->helper_private;
1231 if (!funcs->atomic_commit)
1234 if (new_conn_state->writeback_job && new_conn_state->writeback_job->fb) {
1235 WARN_ON(connector->connector_type != DRM_MODE_CONNECTOR_WRITEBACK);
1236 funcs->atomic_commit(connector, new_conn_state);
1242 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1244 * @old_state: atomic state object with old state structures
1246 * This function enables all the outputs with the new configuration which had to
1247 * be turned off for the update.
1249 * For compatibility with legacy crtc helpers this should be called after
1250 * drm_atomic_helper_commit_planes(), which is what the default commit function
1251 * does. But drivers with different needs can group the modeset commits together
1252 * and do the plane commits at the end. This is useful for drivers doing runtime
1253 * PM since planes updates then only happen when the CRTC is actually enabled.
1255 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1256 struct drm_atomic_state *old_state)
1258 struct drm_crtc *crtc;
1259 struct drm_crtc_state *old_crtc_state;
1260 struct drm_crtc_state *new_crtc_state;
1261 struct drm_connector *connector;
1262 struct drm_connector_state *new_conn_state;
1265 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1266 const struct drm_crtc_helper_funcs *funcs;
1268 /* Need to filter out CRTCs where only planes change. */
1269 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1272 if (!new_crtc_state->active)
1275 funcs = crtc->helper_private;
1277 if (new_crtc_state->enable) {
1278 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1279 crtc->base.id, crtc->name);
1281 if (funcs->atomic_enable)
1282 funcs->atomic_enable(crtc, old_crtc_state);
1284 funcs->commit(crtc);
1288 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1289 const struct drm_encoder_helper_funcs *funcs;
1290 struct drm_encoder *encoder;
1292 if (!new_conn_state->best_encoder)
1295 if (!new_conn_state->crtc->state->active ||
1296 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1299 encoder = new_conn_state->best_encoder;
1300 funcs = encoder->helper_private;
1302 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1303 encoder->base.id, encoder->name);
1306 * Each encoder has at most one connector (since we always steal
1307 * it away), so we won't call enable hooks twice.
1309 drm_bridge_pre_enable(encoder->bridge);
1313 funcs->enable(encoder);
1314 else if (funcs->commit)
1315 funcs->commit(encoder);
1318 drm_bridge_enable(encoder->bridge);
1321 drm_atomic_helper_commit_writebacks(dev, old_state);
1323 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1326 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1328 * @state: atomic state object with old state structures
1329 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1330 * Otherwise @state is the old state.
1332 * For implicit sync, driver should fish the exclusive fence out from the
1333 * incoming fb's and stash it in the drm_plane_state. This is called after
1334 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1335 * just uses the atomic state to find the changed planes)
1337 * Note that @pre_swap is needed since the point where we block for fences moves
1338 * around depending upon whether an atomic commit is blocking or
1339 * non-blocking. For non-blocking commit all waiting needs to happen after
1340 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1341 * to wait **before** we do anything that can't be easily rolled back. That is
1342 * before we call drm_atomic_helper_swap_state().
1344 * Returns zero if success or < 0 if dma_fence_wait() fails.
1346 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1347 struct drm_atomic_state *state,
1350 struct drm_plane *plane;
1351 struct drm_plane_state *new_plane_state;
1354 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1355 if (!new_plane_state->fence)
1358 WARN_ON(!new_plane_state->fb);
1361 * If waiting for fences pre-swap (ie: nonblock), userspace can
1362 * still interrupt the operation. Instead of blocking until the
1363 * timer expires, make the wait interruptible.
1365 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1369 dma_fence_put(new_plane_state->fence);
1370 new_plane_state->fence = NULL;
1375 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1378 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1380 * @old_state: atomic state object with old state structures
1382 * Helper to, after atomic commit, wait for vblanks on all effected
1383 * crtcs (ie. before cleaning up old framebuffers using
1384 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1385 * framebuffers have actually changed to optimize for the legacy cursor and
1386 * plane update use-case.
1388 * Drivers using the nonblocking commit tracking support initialized by calling
1389 * drm_atomic_helper_setup_commit() should look at
1390 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1393 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1394 struct drm_atomic_state *old_state)
1396 struct drm_crtc *crtc;
1397 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1399 unsigned crtc_mask = 0;
1402 * Legacy cursor ioctls are completely unsynced, and userspace
1403 * relies on that (by doing tons of cursor updates).
1405 if (old_state->legacy_cursor_update)
1408 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1409 if (!new_crtc_state->active)
1412 ret = drm_crtc_vblank_get(crtc);
1416 crtc_mask |= drm_crtc_mask(crtc);
1417 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1420 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1421 if (!(crtc_mask & drm_crtc_mask(crtc)))
1424 ret = wait_event_timeout(dev->vblank[i].queue,
1425 old_state->crtcs[i].last_vblank_count !=
1426 drm_crtc_vblank_count(crtc),
1427 msecs_to_jiffies(50));
1429 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1430 crtc->base.id, crtc->name);
1432 drm_crtc_vblank_put(crtc);
1435 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1438 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1440 * @old_state: atomic state object with old state structures
1442 * Helper to, after atomic commit, wait for page flips on all effected
1443 * crtcs (ie. before cleaning up old framebuffers using
1444 * drm_atomic_helper_cleanup_planes()). Compared to
1445 * drm_atomic_helper_wait_for_vblanks() this waits for the completion of on all
1446 * CRTCs, assuming that cursors-only updates are signalling their completion
1447 * immediately (or using a different path).
1449 * This requires that drivers use the nonblocking commit tracking support
1450 * initialized using drm_atomic_helper_setup_commit().
1452 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1453 struct drm_atomic_state *old_state)
1455 struct drm_crtc *crtc;
1458 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1459 struct drm_crtc_commit *commit = old_state->crtcs[i].commit;
1462 crtc = old_state->crtcs[i].ptr;
1464 if (!crtc || !commit)
1467 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1469 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1470 crtc->base.id, crtc->name);
1473 if (old_state->fake_commit)
1474 complete_all(&old_state->fake_commit->flip_done);
1476 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1479 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1480 * @old_state: atomic state object with old state structures
1482 * This is the default implementation for the
1483 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1484 * that do not support runtime_pm or do not need the CRTC to be
1485 * enabled to perform a commit. Otherwise, see
1486 * drm_atomic_helper_commit_tail_rpm().
1488 * Note that the default ordering of how the various stages are called is to
1489 * match the legacy modeset helper library closest.
1491 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1493 struct drm_device *dev = old_state->dev;
1495 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1497 drm_atomic_helper_commit_planes(dev, old_state, 0);
1499 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1501 drm_atomic_helper_fake_vblank(old_state);
1503 drm_atomic_helper_commit_hw_done(old_state);
1505 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1507 drm_atomic_helper_cleanup_planes(dev, old_state);
1509 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1512 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1513 * @old_state: new modeset state to be committed
1515 * This is an alternative implementation for the
1516 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1517 * that support runtime_pm or need the CRTC to be enabled to perform a
1518 * commit. Otherwise, one should use the default implementation
1519 * drm_atomic_helper_commit_tail().
1521 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1523 struct drm_device *dev = old_state->dev;
1525 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1527 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1529 drm_atomic_helper_commit_planes(dev, old_state,
1530 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1532 drm_atomic_helper_fake_vblank(old_state);
1534 drm_atomic_helper_commit_hw_done(old_state);
1536 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1538 drm_atomic_helper_cleanup_planes(dev, old_state);
1540 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1542 static void commit_tail(struct drm_atomic_state *old_state)
1544 struct drm_device *dev = old_state->dev;
1545 const struct drm_mode_config_helper_funcs *funcs;
1547 funcs = dev->mode_config.helper_private;
1549 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1551 drm_atomic_helper_wait_for_dependencies(old_state);
1553 if (funcs && funcs->atomic_commit_tail)
1554 funcs->atomic_commit_tail(old_state);
1556 drm_atomic_helper_commit_tail(old_state);
1558 drm_atomic_helper_commit_cleanup_done(old_state);
1560 drm_atomic_state_put(old_state);
1563 static void commit_work(struct work_struct *work)
1565 struct drm_atomic_state *state = container_of(work,
1566 struct drm_atomic_state,
1572 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1574 * @state: the driver state object
1576 * This helper will check if it is possible to commit the state asynchronously.
1577 * Async commits are not supposed to swap the states like normal sync commits
1578 * but just do in-place changes on the current state.
1580 * It will return 0 if the commit can happen in an asynchronous fashion or error
1581 * if not. Note that error just mean it can't be commited asynchronously, if it
1582 * fails the commit should be treated like a normal synchronous commit.
1584 int drm_atomic_helper_async_check(struct drm_device *dev,
1585 struct drm_atomic_state *state)
1587 struct drm_crtc *crtc;
1588 struct drm_crtc_state *crtc_state;
1589 struct drm_plane *plane = NULL;
1590 struct drm_plane_state *old_plane_state = NULL;
1591 struct drm_plane_state *new_plane_state = NULL;
1592 const struct drm_plane_helper_funcs *funcs;
1593 int i, n_planes = 0;
1595 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1596 if (drm_atomic_crtc_needs_modeset(crtc_state))
1600 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1603 /* FIXME: we support only single plane updates for now */
1607 if (!new_plane_state->crtc ||
1608 old_plane_state->crtc != new_plane_state->crtc)
1612 * FIXME: Since prepare_fb and cleanup_fb are always called on
1613 * the new_plane_state for async updates we need to block framebuffer
1614 * changes. This prevents use of a fb that's been cleaned up and
1615 * double cleanups from occuring.
1617 if (old_plane_state->fb != new_plane_state->fb)
1620 funcs = plane->helper_private;
1621 if (!funcs->atomic_async_update)
1624 if (new_plane_state->fence)
1628 * Don't do an async update if there is an outstanding commit modifying
1629 * the plane. This prevents our async update's changes from getting
1630 * overridden by a previous synchronous update's state.
1632 if (old_plane_state->commit &&
1633 !try_wait_for_completion(&old_plane_state->commit->hw_done))
1636 return funcs->atomic_async_check(plane, new_plane_state);
1638 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1641 * drm_atomic_helper_async_commit - commit state asynchronously
1643 * @state: the driver state object
1645 * This function commits a state asynchronously, i.e., not vblank
1646 * synchronized. It should be used on a state only when
1647 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1648 * the states like normal sync commits, but just do in-place changes on the
1651 void drm_atomic_helper_async_commit(struct drm_device *dev,
1652 struct drm_atomic_state *state)
1654 struct drm_plane *plane;
1655 struct drm_plane_state *plane_state;
1656 const struct drm_plane_helper_funcs *funcs;
1659 for_each_new_plane_in_state(state, plane, plane_state, i) {
1660 funcs = plane->helper_private;
1661 funcs->atomic_async_update(plane, plane_state);
1664 * ->atomic_async_update() is supposed to update the
1665 * plane->state in-place, make sure at least common
1666 * properties have been properly updated.
1668 WARN_ON_ONCE(plane->state->fb != plane_state->fb);
1669 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1670 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1671 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1672 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1675 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1678 * drm_atomic_helper_commit - commit validated state object
1680 * @state: the driver state object
1681 * @nonblock: whether nonblocking behavior is requested.
1683 * This function commits a with drm_atomic_helper_check() pre-validated state
1684 * object. This can still fail when e.g. the framebuffer reservation fails. This
1685 * function implements nonblocking commits, using
1686 * drm_atomic_helper_setup_commit() and related functions.
1688 * Committing the actual hardware state is done through the
1689 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or its default
1690 * implementation drm_atomic_helper_commit_tail().
1693 * Zero for success or -errno.
1695 int drm_atomic_helper_commit(struct drm_device *dev,
1696 struct drm_atomic_state *state,
1701 if (state->async_update) {
1702 ret = drm_atomic_helper_prepare_planes(dev, state);
1706 drm_atomic_helper_async_commit(dev, state);
1707 drm_atomic_helper_cleanup_planes(dev, state);
1712 ret = drm_atomic_helper_setup_commit(state, nonblock);
1716 INIT_WORK(&state->commit_work, commit_work);
1718 ret = drm_atomic_helper_prepare_planes(dev, state);
1723 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1729 * This is the point of no return - everything below never fails except
1730 * when the hw goes bonghits. Which means we can commit the new state on
1731 * the software side now.
1734 ret = drm_atomic_helper_swap_state(state, true);
1739 * Everything below can be run asynchronously without the need to grab
1740 * any modeset locks at all under one condition: It must be guaranteed
1741 * that the asynchronous work has either been cancelled (if the driver
1742 * supports it, which at least requires that the framebuffers get
1743 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1744 * before the new state gets committed on the software side with
1745 * drm_atomic_helper_swap_state().
1747 * This scheme allows new atomic state updates to be prepared and
1748 * checked in parallel to the asynchronous completion of the previous
1749 * update. Which is important since compositors need to figure out the
1750 * composition of the next frame right after having submitted the
1753 * NOTE: Commit work has multiple phases, first hardware commit, then
1754 * cleanup. We want them to overlap, hence need system_unbound_wq to
1755 * make sure work items don't artifically stall on each another.
1758 drm_atomic_state_get(state);
1760 queue_work(system_unbound_wq, &state->commit_work);
1767 drm_atomic_helper_cleanup_planes(dev, state);
1770 EXPORT_SYMBOL(drm_atomic_helper_commit);
1773 * DOC: implementing nonblocking commit
1775 * Nonblocking atomic commits have to be implemented in the following sequence:
1777 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1778 * which commit needs to call which can fail, so we want to run it first and
1781 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1782 * might be affected the new state update. This can be done by either cancelling
1783 * or flushing the work items, depending upon whether the driver can deal with
1784 * cancelled updates. Note that it is important to ensure that the framebuffer
1785 * cleanup is still done when cancelling.
1787 * Asynchronous workers need to have sufficient parallelism to be able to run
1788 * different atomic commits on different CRTCs in parallel. The simplest way to
1789 * achive this is by running them on the &system_unbound_wq work queue. Note
1790 * that drivers are not required to split up atomic commits and run an
1791 * individual commit in parallel - userspace is supposed to do that if it cares.
1792 * But it might be beneficial to do that for modesets, since those necessarily
1793 * must be done as one global operation, and enabling or disabling a CRTC can
1794 * take a long time. But even that is not required.
1796 * 3. The software state is updated synchronously with
1797 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1798 * locks means concurrent callers never see inconsistent state. And doing this
1799 * while it's guaranteed that no relevant nonblocking worker runs means that
1800 * nonblocking workers do not need grab any locks. Actually they must not grab
1801 * locks, for otherwise the work flushing will deadlock.
1803 * 4. Schedule a work item to do all subsequent steps, using the split-out
1804 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1805 * then cleaning up the framebuffers after the old framebuffer is no longer
1808 * The above scheme is implemented in the atomic helper libraries in
1809 * drm_atomic_helper_commit() using a bunch of helper functions. See
1810 * drm_atomic_helper_setup_commit() for a starting point.
1813 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1815 struct drm_crtc_commit *commit, *stall_commit = NULL;
1816 bool completed = true;
1820 spin_lock(&crtc->commit_lock);
1822 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1824 completed = try_wait_for_completion(&commit->flip_done);
1825 /* Userspace is not allowed to get ahead of the previous
1826 * commit with nonblocking ones. */
1827 if (!completed && nonblock) {
1828 spin_unlock(&crtc->commit_lock);
1831 } else if (i == 1) {
1832 stall_commit = drm_crtc_commit_get(commit);
1838 spin_unlock(&crtc->commit_lock);
1843 /* We don't want to let commits get ahead of cleanup work too much,
1844 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1846 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1849 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1850 crtc->base.id, crtc->name);
1852 drm_crtc_commit_put(stall_commit);
1854 return ret < 0 ? ret : 0;
1857 static void release_crtc_commit(struct completion *completion)
1859 struct drm_crtc_commit *commit = container_of(completion,
1863 drm_crtc_commit_put(commit);
1866 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
1868 init_completion(&commit->flip_done);
1869 init_completion(&commit->hw_done);
1870 init_completion(&commit->cleanup_done);
1871 INIT_LIST_HEAD(&commit->commit_entry);
1872 kref_init(&commit->ref);
1873 commit->crtc = crtc;
1876 static struct drm_crtc_commit *
1877 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
1880 struct drm_crtc_state *new_crtc_state;
1882 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
1884 return new_crtc_state->commit;
1887 if (!state->fake_commit) {
1888 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
1889 if (!state->fake_commit)
1892 init_commit(state->fake_commit, NULL);
1895 return state->fake_commit;
1899 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1900 * @state: new modeset state to be committed
1901 * @nonblock: whether nonblocking behavior is requested.
1903 * This function prepares @state to be used by the atomic helper's support for
1904 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1905 * should always call this function from their
1906 * &drm_mode_config_funcs.atomic_commit hook.
1908 * To be able to use this support drivers need to use a few more helper
1909 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1910 * actually committing the hardware state, and for nonblocking commits this call
1911 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1912 * and its stall parameter, for when a driver's commit hooks look at the
1913 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1915 * Completion of the hardware commit step must be signalled using
1916 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1917 * to read or change any permanent software or hardware modeset state. The only
1918 * exception is state protected by other means than &drm_modeset_lock locks.
1919 * Only the free standing @state with pointers to the old state structures can
1920 * be inspected, e.g. to clean up old buffers using
1921 * drm_atomic_helper_cleanup_planes().
1923 * At the very end, before cleaning up @state drivers must call
1924 * drm_atomic_helper_commit_cleanup_done().
1926 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1927 * complete and easy-to-use default implementation of the atomic_commit() hook.
1929 * The tracking of asynchronously executed and still pending commits is done
1930 * using the core structure &drm_crtc_commit.
1932 * By default there's no need to clean up resources allocated by this function
1933 * explicitly: drm_atomic_state_default_clear() will take care of that
1938 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1939 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1941 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1944 struct drm_crtc *crtc;
1945 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1946 struct drm_connector *conn;
1947 struct drm_connector_state *old_conn_state, *new_conn_state;
1948 struct drm_plane *plane;
1949 struct drm_plane_state *old_plane_state, *new_plane_state;
1950 struct drm_crtc_commit *commit;
1953 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1954 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1958 init_commit(commit, crtc);
1960 new_crtc_state->commit = commit;
1962 ret = stall_checks(crtc, nonblock);
1966 /* Drivers only send out events when at least either current or
1967 * new CRTC state is active. Complete right away if everything
1969 if (!old_crtc_state->active && !new_crtc_state->active) {
1970 complete_all(&commit->flip_done);
1974 /* Legacy cursor updates are fully unsynced. */
1975 if (state->legacy_cursor_update) {
1976 complete_all(&commit->flip_done);
1980 if (!new_crtc_state->event) {
1981 commit->event = kzalloc(sizeof(*commit->event),
1986 new_crtc_state->event = commit->event;
1989 new_crtc_state->event->base.completion = &commit->flip_done;
1990 new_crtc_state->event->base.completion_release = release_crtc_commit;
1991 drm_crtc_commit_get(commit);
1993 commit->abort_completion = true;
1995 state->crtcs[i].commit = commit;
1996 drm_crtc_commit_get(commit);
1999 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
2000 /* Userspace is not allowed to get ahead of the previous
2001 * commit with nonblocking ones. */
2002 if (nonblock && old_conn_state->commit &&
2003 !try_wait_for_completion(&old_conn_state->commit->flip_done))
2006 /* Always track connectors explicitly for e.g. link retraining. */
2007 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
2011 new_conn_state->commit = drm_crtc_commit_get(commit);
2014 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2015 /* Userspace is not allowed to get ahead of the previous
2016 * commit with nonblocking ones. */
2017 if (nonblock && old_plane_state->commit &&
2018 !try_wait_for_completion(&old_plane_state->commit->flip_done))
2021 /* Always track planes explicitly for async pageflip support. */
2022 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
2026 new_plane_state->commit = drm_crtc_commit_get(commit);
2031 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
2034 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
2035 * @old_state: atomic state object with old state structures
2037 * This function waits for all preceeding commits that touch the same CRTC as
2038 * @old_state to both be committed to the hardware (as signalled by
2039 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
2040 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
2042 * This is part of the atomic helper support for nonblocking commits, see
2043 * drm_atomic_helper_setup_commit() for an overview.
2045 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
2047 struct drm_crtc *crtc;
2048 struct drm_crtc_state *old_crtc_state;
2049 struct drm_plane *plane;
2050 struct drm_plane_state *old_plane_state;
2051 struct drm_connector *conn;
2052 struct drm_connector_state *old_conn_state;
2053 struct drm_crtc_commit *commit;
2057 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2058 commit = old_crtc_state->commit;
2063 ret = wait_for_completion_timeout(&commit->hw_done,
2066 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2067 crtc->base.id, crtc->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("[CRTC:%d:%s] flip_done timed out\n",
2075 crtc->base.id, crtc->name);
2078 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
2079 commit = old_conn_state->commit;
2084 ret = wait_for_completion_timeout(&commit->hw_done,
2087 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
2088 conn->base.id, conn->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("[CONNECTOR:%d:%s] flip_done timed out\n",
2096 conn->base.id, conn->name);
2099 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2100 commit = old_plane_state->commit;
2105 ret = wait_for_completion_timeout(&commit->hw_done,
2108 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
2109 plane->base.id, plane->name);
2111 /* Currently no support for overwriting flips, hence
2112 * stall for previous one to execute completely. */
2113 ret = wait_for_completion_timeout(&commit->flip_done,
2116 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2117 plane->base.id, plane->name);
2120 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2123 * drm_atomic_helper_fake_vblank - fake VBLANK events if needed
2124 * @old_state: atomic state object with old state structures
2126 * This function walks all CRTCs and fake VBLANK events on those with
2127 * &drm_crtc_state.no_vblank set to true and &drm_crtc_state.event != NULL.
2128 * The primary use of this function is writeback connectors working in oneshot
2129 * mode and faking VBLANK events. In this case they only fake the VBLANK event
2130 * when a job is queued, and any change to the pipeline that does not touch the
2131 * connector is leading to timeouts when calling
2132 * drm_atomic_helper_wait_for_vblanks() or
2133 * drm_atomic_helper_wait_for_flip_done().
2135 * This is part of the atomic helper support for nonblocking commits, see
2136 * drm_atomic_helper_setup_commit() for an overview.
2138 void drm_atomic_helper_fake_vblank(struct drm_atomic_state *old_state)
2140 struct drm_crtc_state *new_crtc_state;
2141 struct drm_crtc *crtc;
2144 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
2145 unsigned long flags;
2147 if (!new_crtc_state->no_vblank)
2150 spin_lock_irqsave(&old_state->dev->event_lock, flags);
2151 if (new_crtc_state->event) {
2152 drm_crtc_send_vblank_event(crtc,
2153 new_crtc_state->event);
2154 new_crtc_state->event = NULL;
2156 spin_unlock_irqrestore(&old_state->dev->event_lock, flags);
2159 EXPORT_SYMBOL(drm_atomic_helper_fake_vblank);
2162 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2163 * @old_state: atomic state object with old state structures
2165 * This function is used to signal completion of the hardware commit step. After
2166 * this step the driver is not allowed to read or change any permanent software
2167 * or hardware modeset state. The only exception is state protected by other
2168 * means than &drm_modeset_lock locks.
2170 * Drivers should try to postpone any expensive or delayed cleanup work after
2171 * this function is called.
2173 * This is part of the atomic helper support for nonblocking commits, see
2174 * drm_atomic_helper_setup_commit() for an overview.
2176 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2178 struct drm_crtc *crtc;
2179 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2180 struct drm_crtc_commit *commit;
2183 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2184 commit = new_crtc_state->commit;
2189 * copy new_crtc_state->commit to old_crtc_state->commit,
2190 * it's unsafe to touch new_crtc_state after hw_done,
2191 * but we still need to do so in cleanup_done().
2193 if (old_crtc_state->commit)
2194 drm_crtc_commit_put(old_crtc_state->commit);
2196 old_crtc_state->commit = drm_crtc_commit_get(commit);
2198 /* backend must have consumed any event by now */
2199 WARN_ON(new_crtc_state->event);
2200 complete_all(&commit->hw_done);
2203 if (old_state->fake_commit) {
2204 complete_all(&old_state->fake_commit->hw_done);
2205 complete_all(&old_state->fake_commit->flip_done);
2208 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2211 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2212 * @old_state: atomic state object with old state structures
2214 * This signals completion of the atomic update @old_state, including any
2215 * cleanup work. If used, it must be called right before calling
2216 * drm_atomic_state_put().
2218 * This is part of the atomic helper support for nonblocking commits, see
2219 * drm_atomic_helper_setup_commit() for an overview.
2221 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2223 struct drm_crtc *crtc;
2224 struct drm_crtc_state *old_crtc_state;
2225 struct drm_crtc_commit *commit;
2228 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2229 commit = old_crtc_state->commit;
2230 if (WARN_ON(!commit))
2233 complete_all(&commit->cleanup_done);
2234 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2236 spin_lock(&crtc->commit_lock);
2237 list_del(&commit->commit_entry);
2238 spin_unlock(&crtc->commit_lock);
2241 if (old_state->fake_commit) {
2242 complete_all(&old_state->fake_commit->cleanup_done);
2243 WARN_ON(!try_wait_for_completion(&old_state->fake_commit->hw_done));
2246 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2249 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2251 * @state: atomic state object with new state structures
2253 * This function prepares plane state, specifically framebuffers, for the new
2254 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2255 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2256 * any already successfully prepared framebuffer.
2259 * 0 on success, negative error code on failure.
2261 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2262 struct drm_atomic_state *state)
2264 struct drm_connector *connector;
2265 struct drm_connector_state *new_conn_state;
2266 struct drm_plane *plane;
2267 struct drm_plane_state *new_plane_state;
2270 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2271 if (!new_conn_state->writeback_job)
2274 ret = drm_writeback_prepare_job(new_conn_state->writeback_job);
2279 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2280 const struct drm_plane_helper_funcs *funcs;
2282 funcs = plane->helper_private;
2284 if (funcs->prepare_fb) {
2285 ret = funcs->prepare_fb(plane, new_plane_state);
2294 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2295 const struct drm_plane_helper_funcs *funcs;
2300 funcs = plane->helper_private;
2302 if (funcs->cleanup_fb)
2303 funcs->cleanup_fb(plane, new_plane_state);
2308 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2310 static bool plane_crtc_active(const struct drm_plane_state *state)
2312 return state->crtc && state->crtc->state->active;
2316 * drm_atomic_helper_commit_planes - commit plane state
2318 * @old_state: atomic state object with old state structures
2319 * @flags: flags for committing plane state
2321 * This function commits the new plane state using the plane and atomic helper
2322 * functions for planes and crtcs. It assumes that the atomic state has already
2323 * been pushed into the relevant object state pointers, since this step can no
2326 * It still requires the global state object @old_state to know which planes and
2327 * crtcs need to be updated though.
2329 * Note that this function does all plane updates across all CRTCs in one step.
2330 * If the hardware can't support this approach look at
2331 * drm_atomic_helper_commit_planes_on_crtc() instead.
2333 * Plane parameters can be updated by applications while the associated CRTC is
2334 * disabled. The DRM/KMS core will store the parameters in the plane state,
2335 * which will be available to the driver when the CRTC is turned on. As a result
2336 * most drivers don't need to be immediately notified of plane updates for a
2339 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2340 * @flags in order not to receive plane update notifications related to a
2341 * disabled CRTC. This avoids the need to manually ignore plane updates in
2342 * driver code when the driver and/or hardware can't or just don't need to deal
2343 * with updates on disabled CRTCs, for example when supporting runtime PM.
2345 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2346 * display controllers require to disable a CRTC's planes when the CRTC is
2347 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2348 * call for a plane if the CRTC of the old plane state needs a modesetting
2349 * operation. Of course, the drivers need to disable the planes in their CRTC
2350 * disable callbacks since no one else would do that.
2352 * The drm_atomic_helper_commit() default implementation doesn't set the
2353 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2354 * This should not be copied blindly by drivers.
2356 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2357 struct drm_atomic_state *old_state,
2360 struct drm_crtc *crtc;
2361 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2362 struct drm_plane *plane;
2363 struct drm_plane_state *old_plane_state, *new_plane_state;
2365 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2366 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2368 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2369 const struct drm_crtc_helper_funcs *funcs;
2371 funcs = crtc->helper_private;
2373 if (!funcs || !funcs->atomic_begin)
2376 if (active_only && !new_crtc_state->active)
2379 funcs->atomic_begin(crtc, old_crtc_state);
2382 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2383 const struct drm_plane_helper_funcs *funcs;
2386 funcs = plane->helper_private;
2391 disabling = drm_atomic_plane_disabling(old_plane_state,
2396 * Skip planes related to inactive CRTCs. If the plane
2397 * is enabled use the state of the current CRTC. If the
2398 * plane is being disabled use the state of the old
2399 * CRTC to avoid skipping planes being disabled on an
2402 if (!disabling && !plane_crtc_active(new_plane_state))
2404 if (disabling && !plane_crtc_active(old_plane_state))
2409 * Special-case disabling the plane if drivers support it.
2411 if (disabling && funcs->atomic_disable) {
2412 struct drm_crtc_state *crtc_state;
2414 crtc_state = old_plane_state->crtc->state;
2416 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2420 funcs->atomic_disable(plane, old_plane_state);
2421 } else if (new_plane_state->crtc || disabling) {
2422 funcs->atomic_update(plane, old_plane_state);
2426 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2427 const struct drm_crtc_helper_funcs *funcs;
2429 funcs = crtc->helper_private;
2431 if (!funcs || !funcs->atomic_flush)
2434 if (active_only && !new_crtc_state->active)
2437 funcs->atomic_flush(crtc, old_crtc_state);
2440 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2443 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
2444 * @old_crtc_state: atomic state object with the old crtc state
2446 * This function commits the new plane state using the plane and atomic helper
2447 * functions for planes on the specific crtc. It assumes that the atomic state
2448 * has already been pushed into the relevant object state pointers, since this
2449 * step can no longer fail.
2451 * This function is useful when plane updates should be done crtc-by-crtc
2452 * instead of one global step like drm_atomic_helper_commit_planes() does.
2454 * This function can only be savely used when planes are not allowed to move
2455 * between different CRTCs because this function doesn't handle inter-CRTC
2456 * depencies. Callers need to ensure that either no such depencies exist,
2457 * resolve them through ordering of commit calls or through some other means.
2460 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2462 const struct drm_crtc_helper_funcs *crtc_funcs;
2463 struct drm_crtc *crtc = old_crtc_state->crtc;
2464 struct drm_atomic_state *old_state = old_crtc_state->state;
2465 struct drm_crtc_state *new_crtc_state =
2466 drm_atomic_get_new_crtc_state(old_state, crtc);
2467 struct drm_plane *plane;
2468 unsigned plane_mask;
2470 plane_mask = old_crtc_state->plane_mask;
2471 plane_mask |= new_crtc_state->plane_mask;
2473 crtc_funcs = crtc->helper_private;
2474 if (crtc_funcs && crtc_funcs->atomic_begin)
2475 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2477 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2478 struct drm_plane_state *old_plane_state =
2479 drm_atomic_get_old_plane_state(old_state, plane);
2480 struct drm_plane_state *new_plane_state =
2481 drm_atomic_get_new_plane_state(old_state, plane);
2482 const struct drm_plane_helper_funcs *plane_funcs;
2484 plane_funcs = plane->helper_private;
2486 if (!old_plane_state || !plane_funcs)
2489 WARN_ON(new_plane_state->crtc &&
2490 new_plane_state->crtc != crtc);
2492 if (drm_atomic_plane_disabling(old_plane_state, new_plane_state) &&
2493 plane_funcs->atomic_disable)
2494 plane_funcs->atomic_disable(plane, old_plane_state);
2495 else if (new_plane_state->crtc ||
2496 drm_atomic_plane_disabling(old_plane_state, new_plane_state))
2497 plane_funcs->atomic_update(plane, old_plane_state);
2500 if (crtc_funcs && crtc_funcs->atomic_flush)
2501 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2503 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2506 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2507 * @old_crtc_state: atomic state object with the old CRTC state
2508 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2510 * Disables all planes associated with the given CRTC. This can be
2511 * used for instance in the CRTC helper atomic_disable callback to disable
2514 * If the atomic-parameter is set the function calls the CRTC's
2515 * atomic_begin hook before and atomic_flush hook after disabling the
2518 * It is a bug to call this function without having implemented the
2519 * &drm_plane_helper_funcs.atomic_disable plane hook.
2522 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2525 struct drm_crtc *crtc = old_crtc_state->crtc;
2526 const struct drm_crtc_helper_funcs *crtc_funcs =
2527 crtc->helper_private;
2528 struct drm_plane *plane;
2530 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2531 crtc_funcs->atomic_begin(crtc, NULL);
2533 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2534 const struct drm_plane_helper_funcs *plane_funcs =
2535 plane->helper_private;
2540 WARN_ON(!plane_funcs->atomic_disable);
2541 if (plane_funcs->atomic_disable)
2542 plane_funcs->atomic_disable(plane, NULL);
2545 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2546 crtc_funcs->atomic_flush(crtc, NULL);
2548 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2551 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2553 * @old_state: atomic state object with old state structures
2555 * This function cleans up plane state, specifically framebuffers, from the old
2556 * configuration. Hence the old configuration must be perserved in @old_state to
2557 * be able to call this function.
2559 * This function must also be called on the new state when the atomic update
2560 * fails at any point after calling drm_atomic_helper_prepare_planes().
2562 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2563 struct drm_atomic_state *old_state)
2565 struct drm_plane *plane;
2566 struct drm_plane_state *old_plane_state, *new_plane_state;
2569 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2570 const struct drm_plane_helper_funcs *funcs;
2571 struct drm_plane_state *plane_state;
2574 * This might be called before swapping when commit is aborted,
2575 * in which case we have to cleanup the new state.
2577 if (old_plane_state == plane->state)
2578 plane_state = new_plane_state;
2580 plane_state = old_plane_state;
2582 funcs = plane->helper_private;
2584 if (funcs->cleanup_fb)
2585 funcs->cleanup_fb(plane, plane_state);
2588 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2591 * drm_atomic_helper_swap_state - store atomic state into current sw state
2592 * @state: atomic state
2593 * @stall: stall for preceeding commits
2595 * This function stores the atomic state into the current state pointers in all
2596 * driver objects. It should be called after all failing steps have been done
2597 * and succeeded, but before the actual hardware state is committed.
2599 * For cleanup and error recovery the current state for all changed objects will
2600 * be swapped into @state.
2602 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2604 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2606 * 2. Do any other steps that might fail.
2608 * 3. Put the staged state into the current state pointers with this function.
2610 * 4. Actually commit the hardware state.
2612 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2613 * contains the old state. Also do any other cleanup required with that state.
2615 * @stall must be set when nonblocking commits for this driver directly access
2616 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2617 * the current atomic helpers this is almost always the case, since the helpers
2618 * don't pass the right state structures to the callbacks.
2622 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2623 * waiting for the previous commits has been interrupted.
2625 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2629 struct drm_connector *connector;
2630 struct drm_connector_state *old_conn_state, *new_conn_state;
2631 struct drm_crtc *crtc;
2632 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2633 struct drm_plane *plane;
2634 struct drm_plane_state *old_plane_state, *new_plane_state;
2635 struct drm_crtc_commit *commit;
2636 struct drm_private_obj *obj;
2637 struct drm_private_state *old_obj_state, *new_obj_state;
2641 * We have to stall for hw_done here before
2642 * drm_atomic_helper_wait_for_dependencies() because flip
2643 * depth > 1 is not yet supported by all drivers. As long as
2644 * obj->state is directly dereferenced anywhere in the drivers
2645 * atomic_commit_tail function, then it's unsafe to swap state
2646 * before drm_atomic_helper_commit_hw_done() is called.
2649 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2650 commit = old_crtc_state->commit;
2655 ret = wait_for_completion_interruptible(&commit->hw_done);
2660 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2661 commit = old_conn_state->commit;
2666 ret = wait_for_completion_interruptible(&commit->hw_done);
2671 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2672 commit = old_plane_state->commit;
2677 ret = wait_for_completion_interruptible(&commit->hw_done);
2683 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2684 WARN_ON(connector->state != old_conn_state);
2686 old_conn_state->state = state;
2687 new_conn_state->state = NULL;
2689 state->connectors[i].state = old_conn_state;
2690 connector->state = new_conn_state;
2693 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2694 WARN_ON(crtc->state != old_crtc_state);
2696 old_crtc_state->state = state;
2697 new_crtc_state->state = NULL;
2699 state->crtcs[i].state = old_crtc_state;
2700 crtc->state = new_crtc_state;
2702 if (new_crtc_state->commit) {
2703 spin_lock(&crtc->commit_lock);
2704 list_add(&new_crtc_state->commit->commit_entry,
2705 &crtc->commit_list);
2706 spin_unlock(&crtc->commit_lock);
2708 new_crtc_state->commit->event = NULL;
2712 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2713 WARN_ON(plane->state != old_plane_state);
2715 old_plane_state->state = state;
2716 new_plane_state->state = NULL;
2718 state->planes[i].state = old_plane_state;
2719 plane->state = new_plane_state;
2722 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2723 WARN_ON(obj->state != old_obj_state);
2725 old_obj_state->state = state;
2726 new_obj_state->state = NULL;
2728 state->private_objs[i].state = old_obj_state;
2729 obj->state = new_obj_state;
2734 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2737 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2738 * @plane: plane object to update
2739 * @crtc: owning CRTC of owning plane
2740 * @fb: framebuffer to flip onto plane
2741 * @crtc_x: x offset of primary plane on crtc
2742 * @crtc_y: y offset of primary plane on crtc
2743 * @crtc_w: width of primary plane rectangle on crtc
2744 * @crtc_h: height of primary plane rectangle on crtc
2745 * @src_x: x offset of @fb for panning
2746 * @src_y: y offset of @fb for panning
2747 * @src_w: width of source rectangle in @fb
2748 * @src_h: height of source rectangle in @fb
2749 * @ctx: lock acquire context
2751 * Provides a default plane update handler using the atomic driver interface.
2754 * Zero on success, error code on failure
2756 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2757 struct drm_crtc *crtc,
2758 struct drm_framebuffer *fb,
2759 int crtc_x, int crtc_y,
2760 unsigned int crtc_w, unsigned int crtc_h,
2761 uint32_t src_x, uint32_t src_y,
2762 uint32_t src_w, uint32_t src_h,
2763 struct drm_modeset_acquire_ctx *ctx)
2765 struct drm_atomic_state *state;
2766 struct drm_plane_state *plane_state;
2769 state = drm_atomic_state_alloc(plane->dev);
2773 state->acquire_ctx = ctx;
2774 plane_state = drm_atomic_get_plane_state(state, plane);
2775 if (IS_ERR(plane_state)) {
2776 ret = PTR_ERR(plane_state);
2780 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2783 drm_atomic_set_fb_for_plane(plane_state, fb);
2784 plane_state->crtc_x = crtc_x;
2785 plane_state->crtc_y = crtc_y;
2786 plane_state->crtc_w = crtc_w;
2787 plane_state->crtc_h = crtc_h;
2788 plane_state->src_x = src_x;
2789 plane_state->src_y = src_y;
2790 plane_state->src_w = src_w;
2791 plane_state->src_h = src_h;
2793 if (plane == crtc->cursor)
2794 state->legacy_cursor_update = true;
2796 ret = drm_atomic_commit(state);
2798 drm_atomic_state_put(state);
2801 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2804 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2805 * @plane: plane to disable
2806 * @ctx: lock acquire context
2808 * Provides a default plane disable handler using the atomic driver interface.
2811 * Zero on success, error code on failure
2813 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2814 struct drm_modeset_acquire_ctx *ctx)
2816 struct drm_atomic_state *state;
2817 struct drm_plane_state *plane_state;
2820 state = drm_atomic_state_alloc(plane->dev);
2824 state->acquire_ctx = ctx;
2825 plane_state = drm_atomic_get_plane_state(state, plane);
2826 if (IS_ERR(plane_state)) {
2827 ret = PTR_ERR(plane_state);
2831 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2832 plane_state->state->legacy_cursor_update = true;
2834 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2838 ret = drm_atomic_commit(state);
2840 drm_atomic_state_put(state);
2843 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2845 /* just used from fb-helper and atomic-helper: */
2846 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2847 struct drm_plane_state *plane_state)
2851 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2855 drm_atomic_set_fb_for_plane(plane_state, NULL);
2856 plane_state->crtc_x = 0;
2857 plane_state->crtc_y = 0;
2858 plane_state->crtc_w = 0;
2859 plane_state->crtc_h = 0;
2860 plane_state->src_x = 0;
2861 plane_state->src_y = 0;
2862 plane_state->src_w = 0;
2863 plane_state->src_h = 0;
2868 static int update_output_state(struct drm_atomic_state *state,
2869 struct drm_mode_set *set)
2871 struct drm_device *dev = set->crtc->dev;
2872 struct drm_crtc *crtc;
2873 struct drm_crtc_state *new_crtc_state;
2874 struct drm_connector *connector;
2875 struct drm_connector_state *new_conn_state;
2878 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2879 state->acquire_ctx);
2883 /* First disable all connectors on the target crtc. */
2884 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2888 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2889 if (new_conn_state->crtc == set->crtc) {
2890 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2895 /* Make sure legacy setCrtc always re-trains */
2896 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2900 /* Then set all connectors from set->connectors on the target crtc */
2901 for (i = 0; i < set->num_connectors; i++) {
2902 new_conn_state = drm_atomic_get_connector_state(state,
2903 set->connectors[i]);
2904 if (IS_ERR(new_conn_state))
2905 return PTR_ERR(new_conn_state);
2907 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2913 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2914 /* Don't update ->enable for the CRTC in the set_config request,
2915 * since a mismatch would indicate a bug in the upper layers.
2916 * The actual modeset code later on will catch any
2917 * inconsistencies here. */
2918 if (crtc == set->crtc)
2921 if (!new_crtc_state->connector_mask) {
2922 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2927 new_crtc_state->active = false;
2935 * drm_atomic_helper_set_config - set a new config from userspace
2936 * @set: mode set configuration
2937 * @ctx: lock acquisition context
2939 * Provides a default crtc set_config handler using the atomic driver interface.
2941 * NOTE: For backwards compatibility with old userspace this automatically
2942 * resets the "link-status" property to GOOD, to force any link
2943 * re-training. The SETCRTC ioctl does not define whether an update does
2944 * need a full modeset or just a plane update, hence we're allowed to do
2945 * that. See also drm_connector_set_link_status_property().
2948 * Returns 0 on success, negative errno numbers on failure.
2950 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2951 struct drm_modeset_acquire_ctx *ctx)
2953 struct drm_atomic_state *state;
2954 struct drm_crtc *crtc = set->crtc;
2957 state = drm_atomic_state_alloc(crtc->dev);
2961 state->acquire_ctx = ctx;
2962 ret = __drm_atomic_helper_set_config(set, state);
2966 ret = handle_conflicting_encoders(state, true);
2970 ret = drm_atomic_commit(state);
2973 drm_atomic_state_put(state);
2976 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2978 /* just used from fb-helper and atomic-helper: */
2979 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2980 struct drm_atomic_state *state)
2982 struct drm_crtc_state *crtc_state;
2983 struct drm_plane_state *primary_state;
2984 struct drm_crtc *crtc = set->crtc;
2985 int hdisplay, vdisplay;
2988 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2989 if (IS_ERR(crtc_state))
2990 return PTR_ERR(crtc_state);
2992 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2993 if (IS_ERR(primary_state))
2994 return PTR_ERR(primary_state);
2998 WARN_ON(set->num_connectors);
3000 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
3004 crtc_state->active = false;
3006 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
3010 drm_atomic_set_fb_for_plane(primary_state, NULL);
3016 WARN_ON(!set->num_connectors);
3018 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
3022 crtc_state->active = true;
3024 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
3028 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
3030 drm_atomic_set_fb_for_plane(primary_state, set->fb);
3031 primary_state->crtc_x = 0;
3032 primary_state->crtc_y = 0;
3033 primary_state->crtc_w = hdisplay;
3034 primary_state->crtc_h = vdisplay;
3035 primary_state->src_x = set->x << 16;
3036 primary_state->src_y = set->y << 16;
3037 if (drm_rotation_90_or_270(primary_state->rotation)) {
3038 primary_state->src_w = vdisplay << 16;
3039 primary_state->src_h = hdisplay << 16;
3041 primary_state->src_w = hdisplay << 16;
3042 primary_state->src_h = vdisplay << 16;
3046 ret = update_output_state(state, set);
3054 * drm_atomic_helper_disable_all - disable all currently active outputs
3056 * @ctx: lock acquisition context
3058 * Loops through all connectors, finding those that aren't turned off and then
3059 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
3060 * that they are connected to.
3062 * This is used for example in suspend/resume to disable all currently active
3063 * functions when suspending. If you just want to shut down everything at e.g.
3064 * driver unload, look at drm_atomic_helper_shutdown().
3066 * Note that if callers haven't already acquired all modeset locks this might
3067 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3070 * 0 on success or a negative error code on failure.
3073 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
3074 * drm_atomic_helper_shutdown().
3076 int drm_atomic_helper_disable_all(struct drm_device *dev,
3077 struct drm_modeset_acquire_ctx *ctx)
3079 struct drm_atomic_state *state;
3080 struct drm_connector_state *conn_state;
3081 struct drm_connector *conn;
3082 struct drm_plane_state *plane_state;
3083 struct drm_plane *plane;
3084 struct drm_crtc_state *crtc_state;
3085 struct drm_crtc *crtc;
3088 state = drm_atomic_state_alloc(dev);
3092 state->acquire_ctx = ctx;
3094 drm_for_each_crtc(crtc, dev) {
3095 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3096 if (IS_ERR(crtc_state)) {
3097 ret = PTR_ERR(crtc_state);
3101 crtc_state->active = false;
3103 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
3107 ret = drm_atomic_add_affected_planes(state, crtc);
3111 ret = drm_atomic_add_affected_connectors(state, crtc);
3116 for_each_new_connector_in_state(state, conn, conn_state, i) {
3117 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
3122 for_each_new_plane_in_state(state, plane, plane_state, i) {
3123 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
3127 drm_atomic_set_fb_for_plane(plane_state, NULL);
3130 ret = drm_atomic_commit(state);
3132 drm_atomic_state_put(state);
3135 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3138 * drm_atomic_helper_shutdown - shutdown all CRTC
3141 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3142 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3143 * that also takes a snapshot of the modeset state to be restored on resume.
3145 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3146 * and it is the atomic version of drm_crtc_force_disable_all().
3148 void drm_atomic_helper_shutdown(struct drm_device *dev)
3150 struct drm_modeset_acquire_ctx ctx;
3153 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, ret);
3155 ret = drm_atomic_helper_disable_all(dev, &ctx);
3157 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3159 DRM_MODESET_LOCK_ALL_END(ctx, ret);
3161 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3164 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3166 * @ctx: lock acquisition context
3168 * Makes a copy of the current atomic state by looping over all objects and
3169 * duplicating their respective states. This is used for example by suspend/
3170 * resume support code to save the state prior to suspend such that it can
3171 * be restored upon resume.
3173 * Note that this treats atomic state as persistent between save and restore.
3174 * Drivers must make sure that this is possible and won't result in confusion
3175 * or erroneous behaviour.
3177 * Note that if callers haven't already acquired all modeset locks this might
3178 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3181 * A pointer to the copy of the atomic state object on success or an
3182 * ERR_PTR()-encoded error code on failure.
3185 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3187 struct drm_atomic_state *
3188 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3189 struct drm_modeset_acquire_ctx *ctx)
3191 struct drm_atomic_state *state;
3192 struct drm_connector *conn;
3193 struct drm_connector_list_iter conn_iter;
3194 struct drm_plane *plane;
3195 struct drm_crtc *crtc;
3198 state = drm_atomic_state_alloc(dev);
3200 return ERR_PTR(-ENOMEM);
3202 state->acquire_ctx = ctx;
3203 state->duplicated = true;
3205 drm_for_each_crtc(crtc, dev) {
3206 struct drm_crtc_state *crtc_state;
3208 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3209 if (IS_ERR(crtc_state)) {
3210 err = PTR_ERR(crtc_state);
3215 drm_for_each_plane(plane, dev) {
3216 struct drm_plane_state *plane_state;
3218 plane_state = drm_atomic_get_plane_state(state, plane);
3219 if (IS_ERR(plane_state)) {
3220 err = PTR_ERR(plane_state);
3225 drm_connector_list_iter_begin(dev, &conn_iter);
3226 drm_for_each_connector_iter(conn, &conn_iter) {
3227 struct drm_connector_state *conn_state;
3229 conn_state = drm_atomic_get_connector_state(state, conn);
3230 if (IS_ERR(conn_state)) {
3231 err = PTR_ERR(conn_state);
3232 drm_connector_list_iter_end(&conn_iter);
3236 drm_connector_list_iter_end(&conn_iter);
3238 /* clear the acquire context so that it isn't accidentally reused */
3239 state->acquire_ctx = NULL;
3243 drm_atomic_state_put(state);
3244 state = ERR_PTR(err);
3249 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3252 * drm_atomic_helper_suspend - subsystem-level suspend helper
3255 * Duplicates the current atomic state, disables all active outputs and then
3256 * returns a pointer to the original atomic state to the caller. Drivers can
3257 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3258 * restore the output configuration that was active at the time the system
3261 * Note that it is potentially unsafe to use this. The atomic state object
3262 * returned by this function is assumed to be persistent. Drivers must ensure
3263 * that this holds true. Before calling this function, drivers must make sure
3264 * to suspend fbdev emulation so that nothing can be using the device.
3267 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3268 * encoded error code on failure. Drivers should store the returned atomic
3269 * state object and pass it to the drm_atomic_helper_resume() helper upon
3273 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3274 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3276 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3278 struct drm_modeset_acquire_ctx ctx;
3279 struct drm_atomic_state *state;
3282 /* This can never be returned, but it makes the compiler happy */
3283 state = ERR_PTR(-EINVAL);
3285 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3287 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3291 err = drm_atomic_helper_disable_all(dev, &ctx);
3293 drm_atomic_state_put(state);
3294 state = ERR_PTR(err);
3299 DRM_MODESET_LOCK_ALL_END(ctx, err);
3301 return ERR_PTR(err);
3305 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3308 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3309 * @state: duplicated atomic state to commit
3310 * @ctx: pointer to acquire_ctx to use for commit.
3312 * The state returned by drm_atomic_helper_duplicate_state() and
3313 * drm_atomic_helper_suspend() is partially invalid, and needs to
3314 * be fixed up before commit.
3317 * 0 on success or a negative error code on failure.
3320 * drm_atomic_helper_suspend()
3322 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3323 struct drm_modeset_acquire_ctx *ctx)
3326 struct drm_plane *plane;
3327 struct drm_plane_state *new_plane_state;
3328 struct drm_connector *connector;
3329 struct drm_connector_state *new_conn_state;
3330 struct drm_crtc *crtc;
3331 struct drm_crtc_state *new_crtc_state;
3333 state->acquire_ctx = ctx;
3335 for_each_new_plane_in_state(state, plane, new_plane_state, i)
3336 state->planes[i].old_state = plane->state;
3338 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3339 state->crtcs[i].old_state = crtc->state;
3341 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3342 state->connectors[i].old_state = connector->state;
3344 ret = drm_atomic_commit(state);
3346 state->acquire_ctx = NULL;
3350 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3353 * drm_atomic_helper_resume - subsystem-level resume helper
3355 * @state: atomic state to resume to
3357 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3358 * grabs all modeset locks and commits the atomic state object. This can be
3359 * used in conjunction with the drm_atomic_helper_suspend() helper to
3360 * implement suspend/resume for drivers that support atomic mode-setting.
3363 * 0 on success or a negative error code on failure.
3366 * drm_atomic_helper_suspend()
3368 int drm_atomic_helper_resume(struct drm_device *dev,
3369 struct drm_atomic_state *state)
3371 struct drm_modeset_acquire_ctx ctx;
3374 drm_mode_config_reset(dev);
3376 DRM_MODESET_LOCK_ALL_BEGIN(dev, ctx, 0, err);
3378 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3380 DRM_MODESET_LOCK_ALL_END(ctx, err);
3381 drm_atomic_state_put(state);
3385 EXPORT_SYMBOL(drm_atomic_helper_resume);
3387 static int page_flip_common(struct drm_atomic_state *state,
3388 struct drm_crtc *crtc,
3389 struct drm_framebuffer *fb,
3390 struct drm_pending_vblank_event *event,
3393 struct drm_plane *plane = crtc->primary;
3394 struct drm_plane_state *plane_state;
3395 struct drm_crtc_state *crtc_state;
3398 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3399 if (IS_ERR(crtc_state))
3400 return PTR_ERR(crtc_state);
3402 crtc_state->event = event;
3403 crtc_state->pageflip_flags = flags;
3405 plane_state = drm_atomic_get_plane_state(state, plane);
3406 if (IS_ERR(plane_state))
3407 return PTR_ERR(plane_state);
3409 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3412 drm_atomic_set_fb_for_plane(plane_state, fb);
3414 /* Make sure we don't accidentally do a full modeset. */
3415 state->allow_modeset = false;
3416 if (!crtc_state->active) {
3417 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3418 crtc->base.id, crtc->name);
3426 * drm_atomic_helper_page_flip - execute a legacy page flip
3428 * @fb: DRM framebuffer
3429 * @event: optional DRM event to signal upon completion
3430 * @flags: flip flags for non-vblank sync'ed updates
3431 * @ctx: lock acquisition context
3433 * Provides a default &drm_crtc_funcs.page_flip implementation
3434 * using the atomic driver interface.
3437 * Returns 0 on success, negative errno numbers on failure.
3440 * drm_atomic_helper_page_flip_target()
3442 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3443 struct drm_framebuffer *fb,
3444 struct drm_pending_vblank_event *event,
3446 struct drm_modeset_acquire_ctx *ctx)
3448 struct drm_plane *plane = crtc->primary;
3449 struct drm_atomic_state *state;
3452 state = drm_atomic_state_alloc(plane->dev);
3456 state->acquire_ctx = ctx;
3458 ret = page_flip_common(state, crtc, fb, event, flags);
3462 ret = drm_atomic_nonblocking_commit(state);
3464 drm_atomic_state_put(state);
3467 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3470 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3472 * @fb: DRM framebuffer
3473 * @event: optional DRM event to signal upon completion
3474 * @flags: flip flags for non-vblank sync'ed updates
3475 * @target: specifying the target vblank period when the flip to take effect
3476 * @ctx: lock acquisition context
3478 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3479 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3480 * target vblank period to flip.
3483 * Returns 0 on success, negative errno numbers on failure.
3485 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3486 struct drm_framebuffer *fb,
3487 struct drm_pending_vblank_event *event,
3490 struct drm_modeset_acquire_ctx *ctx)
3492 struct drm_plane *plane = crtc->primary;
3493 struct drm_atomic_state *state;
3494 struct drm_crtc_state *crtc_state;
3497 state = drm_atomic_state_alloc(plane->dev);
3501 state->acquire_ctx = ctx;
3503 ret = page_flip_common(state, crtc, fb, event, flags);
3507 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3508 if (WARN_ON(!crtc_state)) {
3512 crtc_state->target_vblank = target;
3514 ret = drm_atomic_nonblocking_commit(state);
3516 drm_atomic_state_put(state);
3519 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3522 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3523 * @crtc: CRTC object
3524 * @red: red correction table
3525 * @green: green correction table
3526 * @blue: green correction table
3527 * @size: size of the tables
3528 * @ctx: lock acquire context
3530 * Implements support for legacy gamma correction table for drivers
3531 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3532 * properties. See drm_crtc_enable_color_mgmt() and the containing chapter for
3533 * how the atomic color management and gamma tables work.
3535 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3536 u16 *red, u16 *green, u16 *blue,
3538 struct drm_modeset_acquire_ctx *ctx)
3540 struct drm_device *dev = crtc->dev;
3541 struct drm_atomic_state *state;
3542 struct drm_crtc_state *crtc_state;
3543 struct drm_property_blob *blob = NULL;
3544 struct drm_color_lut *blob_data;
3548 state = drm_atomic_state_alloc(crtc->dev);
3552 blob = drm_property_create_blob(dev,
3553 sizeof(struct drm_color_lut) * size,
3556 ret = PTR_ERR(blob);
3561 /* Prepare GAMMA_LUT with the legacy values. */
3562 blob_data = blob->data;
3563 for (i = 0; i < size; i++) {
3564 blob_data[i].red = red[i];
3565 blob_data[i].green = green[i];
3566 blob_data[i].blue = blue[i];
3569 state->acquire_ctx = ctx;
3570 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3571 if (IS_ERR(crtc_state)) {
3572 ret = PTR_ERR(crtc_state);
3576 /* Reset DEGAMMA_LUT and CTM properties. */
3577 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, NULL);
3578 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
3579 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, blob);
3580 crtc_state->color_mgmt_changed |= replaced;
3582 ret = drm_atomic_commit(state);
3585 drm_atomic_state_put(state);
3586 drm_property_blob_put(blob);
3589 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);