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_plane_helper.h>
31 #include <drm/drm_crtc_helper.h>
32 #include <drm/drm_atomic_helper.h>
33 #include <linux/dma-fence.h>
35 #include "drm_crtc_helper_internal.h"
36 #include "drm_crtc_internal.h"
41 * This helper library provides implementations of check and commit functions on
42 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
43 * also provides convenience implementations for the atomic state handling
44 * callbacks for drivers which don't need to subclass the drm core structures to
45 * add their own additional internal state.
47 * This library also provides default implementations for the check callback in
48 * drm_atomic_helper_check() and for the commit callback with
49 * drm_atomic_helper_commit(). But the individual stages and callbacks are
50 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
51 * together with a driver private modeset implementation.
53 * This library also provides implementations for all the legacy driver
54 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
55 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
56 * various functions to implement set_property callbacks. New drivers must not
57 * implement these functions themselves but must use the provided helpers.
59 * The atomic helper uses the same function table structures as all other
60 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
61 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
62 * also shares the &struct drm_plane_helper_funcs function table with the plane
66 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
67 struct drm_plane_state *old_plane_state,
68 struct drm_plane_state *plane_state,
69 struct drm_plane *plane)
71 struct drm_crtc_state *crtc_state;
73 if (old_plane_state->crtc) {
74 crtc_state = drm_atomic_get_new_crtc_state(state,
75 old_plane_state->crtc);
77 if (WARN_ON(!crtc_state))
80 crtc_state->planes_changed = true;
83 if (plane_state->crtc) {
84 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
86 if (WARN_ON(!crtc_state))
89 crtc_state->planes_changed = true;
93 static int handle_conflicting_encoders(struct drm_atomic_state *state,
94 bool disable_conflicting_encoders)
96 struct drm_connector_state *new_conn_state;
97 struct drm_connector *connector;
98 struct drm_connector_list_iter conn_iter;
99 struct drm_encoder *encoder;
100 unsigned encoder_mask = 0;
104 * First loop, find all newly assigned encoders from the connectors
105 * part of the state. If the same encoder is assigned to multiple
106 * connectors bail out.
108 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
109 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
110 struct drm_encoder *new_encoder;
112 if (!new_conn_state->crtc)
115 if (funcs->atomic_best_encoder)
116 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
117 else if (funcs->best_encoder)
118 new_encoder = funcs->best_encoder(connector);
120 new_encoder = drm_atomic_helper_best_encoder(connector);
123 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
124 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
125 new_encoder->base.id, new_encoder->name,
126 connector->base.id, connector->name);
131 encoder_mask |= 1 << drm_encoder_index(new_encoder);
139 * Second loop, iterate over all connectors not part of the state.
141 * If a conflicting encoder is found and disable_conflicting_encoders
142 * is not set, an error is returned. Userspace can provide a solution
143 * through the atomic ioctl.
145 * If the flag is set conflicting connectors are removed from the crtc
146 * and the crtc is disabled if no encoder is left. This preserves
147 * compatibility with the legacy set_config behavior.
149 drm_connector_list_iter_begin(state->dev, &conn_iter);
150 drm_for_each_connector_iter(connector, &conn_iter) {
151 struct drm_crtc_state *crtc_state;
153 if (drm_atomic_get_new_connector_state(state, connector))
156 encoder = connector->state->best_encoder;
157 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
160 if (!disable_conflicting_encoders) {
161 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
162 encoder->base.id, encoder->name,
163 connector->state->crtc->base.id,
164 connector->state->crtc->name,
165 connector->base.id, connector->name);
170 new_conn_state = drm_atomic_get_connector_state(state, connector);
171 if (IS_ERR(new_conn_state)) {
172 ret = PTR_ERR(new_conn_state);
176 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
177 encoder->base.id, encoder->name,
178 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
179 connector->base.id, connector->name);
181 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
183 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
187 if (!crtc_state->connector_mask) {
188 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
193 crtc_state->active = false;
197 drm_connector_list_iter_end(&conn_iter);
203 set_best_encoder(struct drm_atomic_state *state,
204 struct drm_connector_state *conn_state,
205 struct drm_encoder *encoder)
207 struct drm_crtc_state *crtc_state;
208 struct drm_crtc *crtc;
210 if (conn_state->best_encoder) {
211 /* Unset the encoder_mask in the old crtc state. */
212 crtc = conn_state->connector->state->crtc;
214 /* A NULL crtc is an error here because we should have
215 * duplicated a NULL best_encoder when crtc was NULL.
216 * As an exception restoring duplicated atomic state
217 * during resume is allowed, so don't warn when
218 * best_encoder is equal to encoder we intend to set.
220 WARN_ON(!crtc && encoder != conn_state->best_encoder);
222 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
224 crtc_state->encoder_mask &=
225 ~(1 << drm_encoder_index(conn_state->best_encoder));
230 crtc = conn_state->crtc;
233 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
235 crtc_state->encoder_mask |=
236 1 << drm_encoder_index(encoder);
240 conn_state->best_encoder = encoder;
244 steal_encoder(struct drm_atomic_state *state,
245 struct drm_encoder *encoder)
247 struct drm_crtc_state *crtc_state;
248 struct drm_connector *connector;
249 struct drm_connector_state *old_connector_state, *new_connector_state;
252 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
253 struct drm_crtc *encoder_crtc;
255 if (new_connector_state->best_encoder != encoder)
258 encoder_crtc = old_connector_state->crtc;
260 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
261 encoder->base.id, encoder->name,
262 encoder_crtc->base.id, encoder_crtc->name);
264 set_best_encoder(state, new_connector_state, NULL);
266 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
267 crtc_state->connectors_changed = true;
274 update_connector_routing(struct drm_atomic_state *state,
275 struct drm_connector *connector,
276 struct drm_connector_state *old_connector_state,
277 struct drm_connector_state *new_connector_state)
279 const struct drm_connector_helper_funcs *funcs;
280 struct drm_encoder *new_encoder;
281 struct drm_crtc_state *crtc_state;
283 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
287 if (old_connector_state->crtc != new_connector_state->crtc) {
288 if (old_connector_state->crtc) {
289 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
290 crtc_state->connectors_changed = true;
293 if (new_connector_state->crtc) {
294 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
295 crtc_state->connectors_changed = true;
299 if (!new_connector_state->crtc) {
300 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
304 set_best_encoder(state, new_connector_state, NULL);
309 funcs = connector->helper_private;
311 if (funcs->atomic_best_encoder)
312 new_encoder = funcs->atomic_best_encoder(connector,
313 new_connector_state);
314 else if (funcs->best_encoder)
315 new_encoder = funcs->best_encoder(connector);
317 new_encoder = drm_atomic_helper_best_encoder(connector);
320 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
326 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
327 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
328 new_encoder->base.id,
330 new_connector_state->crtc->base.id,
331 new_connector_state->crtc->name);
335 if (new_encoder == new_connector_state->best_encoder) {
336 set_best_encoder(state, new_connector_state, new_encoder);
338 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
341 new_encoder->base.id,
343 new_connector_state->crtc->base.id,
344 new_connector_state->crtc->name);
349 steal_encoder(state, new_encoder);
351 set_best_encoder(state, new_connector_state, new_encoder);
353 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
354 crtc_state->connectors_changed = true;
356 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
359 new_encoder->base.id,
361 new_connector_state->crtc->base.id,
362 new_connector_state->crtc->name);
368 mode_fixup(struct drm_atomic_state *state)
370 struct drm_crtc *crtc;
371 struct drm_crtc_state *new_crtc_state;
372 struct drm_connector *connector;
373 struct drm_connector_state *new_conn_state;
377 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
378 if (!new_crtc_state->mode_changed &&
379 !new_crtc_state->connectors_changed)
382 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
385 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
386 const struct drm_encoder_helper_funcs *funcs;
387 struct drm_encoder *encoder;
389 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
391 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
395 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
398 * Each encoder has at most one connector (since we always steal
399 * it away), so we won't call ->mode_fixup twice.
401 encoder = new_conn_state->best_encoder;
402 funcs = encoder->helper_private;
404 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
405 &new_crtc_state->adjusted_mode);
407 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
411 if (funcs && funcs->atomic_check) {
412 ret = funcs->atomic_check(encoder, new_crtc_state,
415 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
416 encoder->base.id, encoder->name);
419 } else if (funcs && funcs->mode_fixup) {
420 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
421 &new_crtc_state->adjusted_mode);
423 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
424 encoder->base.id, encoder->name);
430 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
431 const struct drm_crtc_helper_funcs *funcs;
433 if (!new_crtc_state->enable)
436 if (!new_crtc_state->mode_changed &&
437 !new_crtc_state->connectors_changed)
440 funcs = crtc->helper_private;
441 if (!funcs->mode_fixup)
444 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
445 &new_crtc_state->adjusted_mode);
447 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
448 crtc->base.id, crtc->name);
456 static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
457 struct drm_encoder *encoder,
458 struct drm_crtc *crtc,
459 struct drm_display_mode *mode)
461 enum drm_mode_status ret;
463 ret = drm_encoder_mode_valid(encoder, mode);
464 if (ret != MODE_OK) {
465 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
466 encoder->base.id, encoder->name);
470 ret = drm_bridge_mode_valid(encoder->bridge, mode);
471 if (ret != MODE_OK) {
472 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
476 ret = drm_crtc_mode_valid(crtc, mode);
477 if (ret != MODE_OK) {
478 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
479 crtc->base.id, crtc->name);
487 mode_valid(struct drm_atomic_state *state)
489 struct drm_connector_state *conn_state;
490 struct drm_connector *connector;
493 for_each_new_connector_in_state(state, connector, conn_state, i) {
494 struct drm_encoder *encoder = conn_state->best_encoder;
495 struct drm_crtc *crtc = conn_state->crtc;
496 struct drm_crtc_state *crtc_state;
497 enum drm_mode_status mode_status;
498 struct drm_display_mode *mode;
500 if (!crtc || !encoder)
503 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
506 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
509 mode = &crtc_state->mode;
511 mode_status = mode_valid_path(connector, encoder, crtc, mode);
512 if (mode_status != MODE_OK)
520 * drm_atomic_helper_check_modeset - validate state object for modeset changes
522 * @state: the driver state object
524 * Check the state object to see if the requested state is physically possible.
525 * This does all the crtc and connector related computations for an atomic
526 * update and adds any additional connectors needed for full modesets. It calls
527 * the various per-object callbacks in the follow order:
529 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
530 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
531 * 3. If it's determined a modeset is needed then all connectors on the affected crtc
532 * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them.
533 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
534 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
535 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
536 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
537 * This function is only called when the encoder will be part of a configured crtc,
538 * it must not be used for implementing connector property validation.
539 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
541 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints.
543 * &drm_crtc_state.mode_changed is set when the input mode is changed.
544 * &drm_crtc_state.connectors_changed is set when a connector is added or
545 * removed from the crtc. &drm_crtc_state.active_changed is set when
546 * &drm_crtc_state.active changes, which is used for DPMS.
547 * See also: drm_atomic_crtc_needs_modeset()
551 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
552 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
553 * without a full modeset) _must_ call this function afterwards after that
554 * change. It is permitted to call this function multiple times for the same
555 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
556 * upon the adjusted dotclock for fifo space allocation and watermark
560 * Zero for success or -errno
563 drm_atomic_helper_check_modeset(struct drm_device *dev,
564 struct drm_atomic_state *state)
566 struct drm_crtc *crtc;
567 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
568 struct drm_connector *connector;
569 struct drm_connector_state *old_connector_state, *new_connector_state;
571 unsigned connectors_mask = 0;
573 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
574 bool has_connectors =
575 !!new_crtc_state->connector_mask;
577 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
579 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
580 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
581 crtc->base.id, crtc->name);
582 new_crtc_state->mode_changed = true;
585 if (old_crtc_state->enable != new_crtc_state->enable) {
586 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
587 crtc->base.id, crtc->name);
590 * For clarity this assignment is done here, but
591 * enable == 0 is only true when there are no
592 * connectors and a NULL mode.
594 * The other way around is true as well. enable != 0
595 * iff connectors are attached and a mode is set.
597 new_crtc_state->mode_changed = true;
598 new_crtc_state->connectors_changed = true;
601 if (old_crtc_state->active != new_crtc_state->active) {
602 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
603 crtc->base.id, crtc->name);
604 new_crtc_state->active_changed = true;
607 if (new_crtc_state->enable != has_connectors) {
608 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
609 crtc->base.id, crtc->name);
615 ret = handle_conflicting_encoders(state, false);
619 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
620 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
622 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
625 * This only sets crtc->connectors_changed for routing changes,
626 * drivers must set crtc->connectors_changed themselves when
627 * connector properties need to be updated.
629 ret = update_connector_routing(state, connector,
631 new_connector_state);
634 if (old_connector_state->crtc) {
635 new_crtc_state = drm_atomic_get_new_crtc_state(state,
636 old_connector_state->crtc);
637 if (old_connector_state->link_status !=
638 new_connector_state->link_status)
639 new_crtc_state->connectors_changed = true;
642 if (funcs->atomic_check)
643 ret = funcs->atomic_check(connector, new_connector_state);
647 connectors_mask += BIT(i);
651 * After all the routing has been prepared we need to add in any
652 * connector which is itself unchanged, but who's crtc changes it's
653 * configuration. This must be done before calling mode_fixup in case a
654 * crtc only changed its mode but has the same set of connectors.
656 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
657 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
660 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
661 crtc->base.id, crtc->name,
662 new_crtc_state->enable ? 'y' : 'n',
663 new_crtc_state->active ? 'y' : 'n');
665 ret = drm_atomic_add_affected_connectors(state, crtc);
669 ret = drm_atomic_add_affected_planes(state, crtc);
675 * Iterate over all connectors again, to make sure atomic_check()
676 * has been called on them when a modeset is forced.
678 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
679 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
681 if (connectors_mask & BIT(i))
684 if (funcs->atomic_check)
685 ret = funcs->atomic_check(connector, new_connector_state);
690 ret = mode_valid(state);
694 return mode_fixup(state);
696 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
699 * drm_atomic_helper_check_plane_state() - Check plane state for validity
700 * @plane_state: plane state to check
701 * @crtc_state: crtc state to check
702 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
703 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
704 * @can_position: is it legal to position the plane such that it
705 * doesn't cover the entire crtc? This will generally
706 * only be false for primary planes.
707 * @can_update_disabled: can the plane be updated while the crtc
710 * Checks that a desired plane update is valid, and updates various
711 * bits of derived state (clipped coordinates etc.). Drivers that provide
712 * their own plane handling rather than helper-provided implementations may
713 * still wish to call this function to avoid duplication of error checking
717 * Zero if update appears valid, error code on failure
719 int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
720 const struct drm_crtc_state *crtc_state,
724 bool can_update_disabled)
726 struct drm_framebuffer *fb = plane_state->fb;
727 struct drm_rect *src = &plane_state->src;
728 struct drm_rect *dst = &plane_state->dst;
729 unsigned int rotation = plane_state->rotation;
730 struct drm_rect clip = {};
733 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
735 *src = drm_plane_state_src(plane_state);
736 *dst = drm_plane_state_dest(plane_state);
739 plane_state->visible = false;
743 /* crtc should only be NULL when disabling (i.e., !fb) */
744 if (WARN_ON(!plane_state->crtc)) {
745 plane_state->visible = false;
749 if (!crtc_state->enable && !can_update_disabled) {
750 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
754 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
757 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
758 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
759 if (hscale < 0 || vscale < 0) {
760 DRM_DEBUG_KMS("Invalid scaling of plane\n");
761 drm_rect_debug_print("src: ", &plane_state->src, true);
762 drm_rect_debug_print("dst: ", &plane_state->dst, false);
766 if (crtc_state->enable)
767 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
769 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip);
771 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
773 if (!plane_state->visible)
775 * Plane isn't visible; some drivers can handle this
776 * so we just return success here. Drivers that can't
777 * (including those that use the primary plane helper's
778 * update function) will return an error from their
779 * update_plane handler.
783 if (!can_position && !drm_rect_equals(dst, &clip)) {
784 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
785 drm_rect_debug_print("dst: ", dst, false);
786 drm_rect_debug_print("clip: ", &clip, false);
792 EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
795 * drm_atomic_helper_check_planes - validate state object for planes changes
797 * @state: the driver state object
799 * Check the state object to see if the requested state is physically possible.
800 * This does all the plane update related checks using by calling into the
801 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
802 * hooks provided by the driver.
804 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
808 * Zero for success or -errno
811 drm_atomic_helper_check_planes(struct drm_device *dev,
812 struct drm_atomic_state *state)
814 struct drm_crtc *crtc;
815 struct drm_crtc_state *new_crtc_state;
816 struct drm_plane *plane;
817 struct drm_plane_state *new_plane_state, *old_plane_state;
820 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
821 const struct drm_plane_helper_funcs *funcs;
823 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
825 funcs = plane->helper_private;
827 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
829 if (!funcs || !funcs->atomic_check)
832 ret = funcs->atomic_check(plane, new_plane_state);
834 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
835 plane->base.id, plane->name);
840 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
841 const struct drm_crtc_helper_funcs *funcs;
843 funcs = crtc->helper_private;
845 if (!funcs || !funcs->atomic_check)
848 ret = funcs->atomic_check(crtc, new_crtc_state);
850 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
851 crtc->base.id, crtc->name);
858 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
861 * drm_atomic_helper_check - validate state object
863 * @state: the driver state object
865 * Check the state object to see if the requested state is physically possible.
866 * Only crtcs and planes have check callbacks, so for any additional (global)
867 * checking that a driver needs it can simply wrap that around this function.
868 * Drivers without such needs can directly use this as their
869 * &drm_mode_config_funcs.atomic_check callback.
871 * This just wraps the two parts of the state checking for planes and modeset
872 * state in the default order: First it calls drm_atomic_helper_check_modeset()
873 * and then drm_atomic_helper_check_planes(). The assumption is that the
874 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
875 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
878 * Note that zpos normalization will add all enable planes to the state which
879 * might not desired for some drivers.
880 * For example enable/disable of a cursor plane which have fixed zpos value
881 * would trigger all other enabled planes to be forced to the state change.
884 * Zero for success or -errno
886 int drm_atomic_helper_check(struct drm_device *dev,
887 struct drm_atomic_state *state)
891 ret = drm_atomic_helper_check_modeset(dev, state);
895 if (dev->mode_config.normalize_zpos) {
896 ret = drm_atomic_normalize_zpos(dev, state);
901 ret = drm_atomic_helper_check_planes(dev, state);
905 if (state->legacy_cursor_update)
906 state->async_update = !drm_atomic_helper_async_check(dev, state);
910 EXPORT_SYMBOL(drm_atomic_helper_check);
913 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
915 struct drm_connector *connector;
916 struct drm_connector_state *old_conn_state, *new_conn_state;
917 struct drm_crtc *crtc;
918 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
921 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
922 const struct drm_encoder_helper_funcs *funcs;
923 struct drm_encoder *encoder;
925 /* Shut down everything that's in the changeset and currently
926 * still on. So need to check the old, saved state. */
927 if (!old_conn_state->crtc)
930 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
932 if (!old_crtc_state->active ||
933 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
936 encoder = old_conn_state->best_encoder;
938 /* We shouldn't get this far if we didn't previously have
939 * an encoder.. but WARN_ON() rather than explode.
941 if (WARN_ON(!encoder))
944 funcs = encoder->helper_private;
946 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
947 encoder->base.id, encoder->name);
950 * Each encoder has at most one connector (since we always steal
951 * it away), so we won't call disable hooks twice.
953 drm_bridge_disable(encoder->bridge);
955 /* Right function depends upon target state. */
957 if (new_conn_state->crtc && funcs->prepare)
958 funcs->prepare(encoder);
959 else if (funcs->disable)
960 funcs->disable(encoder);
961 else if (funcs->dpms)
962 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
965 drm_bridge_post_disable(encoder->bridge);
968 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
969 const struct drm_crtc_helper_funcs *funcs;
972 /* Shut down everything that needs a full modeset. */
973 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
976 if (!old_crtc_state->active)
979 funcs = crtc->helper_private;
981 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
982 crtc->base.id, crtc->name);
985 /* Right function depends upon target state. */
986 if (new_crtc_state->enable && funcs->prepare)
987 funcs->prepare(crtc);
988 else if (funcs->atomic_disable)
989 funcs->atomic_disable(crtc, old_crtc_state);
990 else if (funcs->disable)
991 funcs->disable(crtc);
993 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
995 if (!(dev->irq_enabled && dev->num_crtcs))
998 ret = drm_crtc_vblank_get(crtc);
999 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
1001 drm_crtc_vblank_put(crtc);
1006 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
1008 * @old_state: atomic state object with old state structures
1010 * This function updates all the various legacy modeset state pointers in
1011 * connectors, encoders and crtcs. It also updates the timestamping constants
1012 * used for precise vblank timestamps by calling
1013 * drm_calc_timestamping_constants().
1015 * Drivers can use this for building their own atomic commit if they don't have
1016 * a pure helper-based modeset implementation.
1018 * Since these updates are not synchronized with lockings, only code paths
1019 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1020 * legacy state filled out by this helper. Defacto this means this helper and
1021 * the legacy state pointers are only really useful for transitioning an
1022 * existing driver to the atomic world.
1025 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1026 struct drm_atomic_state *old_state)
1028 struct drm_connector *connector;
1029 struct drm_connector_state *old_conn_state, *new_conn_state;
1030 struct drm_crtc *crtc;
1031 struct drm_crtc_state *new_crtc_state;
1034 /* clear out existing links and update dpms */
1035 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1036 if (connector->encoder) {
1037 WARN_ON(!connector->encoder->crtc);
1039 connector->encoder->crtc = NULL;
1040 connector->encoder = NULL;
1043 crtc = new_conn_state->crtc;
1044 if ((!crtc && old_conn_state->crtc) ||
1045 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1046 int mode = DRM_MODE_DPMS_OFF;
1048 if (crtc && crtc->state->active)
1049 mode = DRM_MODE_DPMS_ON;
1051 connector->dpms = mode;
1056 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1057 if (!new_conn_state->crtc)
1060 if (WARN_ON(!new_conn_state->best_encoder))
1063 connector->encoder = new_conn_state->best_encoder;
1064 connector->encoder->crtc = new_conn_state->crtc;
1067 /* set legacy state in the crtc structure */
1068 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1069 struct drm_plane *primary = crtc->primary;
1070 struct drm_plane_state *new_plane_state;
1072 crtc->mode = new_crtc_state->mode;
1073 crtc->enabled = new_crtc_state->enable;
1076 drm_atomic_get_new_plane_state(old_state, primary);
1078 if (new_plane_state && new_plane_state->crtc == crtc) {
1079 crtc->x = new_plane_state->src_x >> 16;
1080 crtc->y = new_plane_state->src_y >> 16;
1083 if (new_crtc_state->enable)
1084 drm_calc_timestamping_constants(crtc,
1085 &new_crtc_state->adjusted_mode);
1088 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1091 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1093 struct drm_crtc *crtc;
1094 struct drm_crtc_state *new_crtc_state;
1095 struct drm_connector *connector;
1096 struct drm_connector_state *new_conn_state;
1099 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1100 const struct drm_crtc_helper_funcs *funcs;
1102 if (!new_crtc_state->mode_changed)
1105 funcs = crtc->helper_private;
1107 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1108 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1109 crtc->base.id, crtc->name);
1111 funcs->mode_set_nofb(crtc);
1115 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1116 const struct drm_encoder_helper_funcs *funcs;
1117 struct drm_encoder *encoder;
1118 struct drm_display_mode *mode, *adjusted_mode;
1120 if (!new_conn_state->best_encoder)
1123 encoder = new_conn_state->best_encoder;
1124 funcs = encoder->helper_private;
1125 new_crtc_state = new_conn_state->crtc->state;
1126 mode = &new_crtc_state->mode;
1127 adjusted_mode = &new_crtc_state->adjusted_mode;
1129 if (!new_crtc_state->mode_changed)
1132 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1133 encoder->base.id, encoder->name);
1136 * Each encoder has at most one connector (since we always steal
1137 * it away), so we won't call mode_set hooks twice.
1139 if (funcs && funcs->atomic_mode_set) {
1140 funcs->atomic_mode_set(encoder, new_crtc_state,
1142 } else if (funcs && funcs->mode_set) {
1143 funcs->mode_set(encoder, mode, adjusted_mode);
1146 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
1151 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1153 * @old_state: atomic state object with old state structures
1155 * This function shuts down all the outputs that need to be shut down and
1156 * prepares them (if required) with the new mode.
1158 * For compatibility with legacy crtc helpers this should be called before
1159 * drm_atomic_helper_commit_planes(), which is what the default commit function
1160 * does. But drivers with different needs can group the modeset commits together
1161 * and do the plane commits at the end. This is useful for drivers doing runtime
1162 * PM since planes updates then only happen when the CRTC is actually enabled.
1164 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1165 struct drm_atomic_state *old_state)
1167 disable_outputs(dev, old_state);
1169 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1171 crtc_set_mode(dev, old_state);
1173 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1176 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1178 * @old_state: atomic state object with old state structures
1180 * This function enables all the outputs with the new configuration which had to
1181 * be turned off for the update.
1183 * For compatibility with legacy crtc helpers this should be called after
1184 * drm_atomic_helper_commit_planes(), which is what the default commit function
1185 * does. But drivers with different needs can group the modeset commits together
1186 * and do the plane commits at the end. This is useful for drivers doing runtime
1187 * PM since planes updates then only happen when the CRTC is actually enabled.
1189 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1190 struct drm_atomic_state *old_state)
1192 struct drm_crtc *crtc;
1193 struct drm_crtc_state *old_crtc_state;
1194 struct drm_crtc_state *new_crtc_state;
1195 struct drm_connector *connector;
1196 struct drm_connector_state *new_conn_state;
1199 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1200 const struct drm_crtc_helper_funcs *funcs;
1202 /* Need to filter out CRTCs where only planes change. */
1203 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1206 if (!new_crtc_state->active)
1209 funcs = crtc->helper_private;
1211 if (new_crtc_state->enable) {
1212 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1213 crtc->base.id, crtc->name);
1215 if (funcs->atomic_enable)
1216 funcs->atomic_enable(crtc, old_crtc_state);
1218 funcs->commit(crtc);
1222 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1223 const struct drm_encoder_helper_funcs *funcs;
1224 struct drm_encoder *encoder;
1226 if (!new_conn_state->best_encoder)
1229 if (!new_conn_state->crtc->state->active ||
1230 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1233 encoder = new_conn_state->best_encoder;
1234 funcs = encoder->helper_private;
1236 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1237 encoder->base.id, encoder->name);
1240 * Each encoder has at most one connector (since we always steal
1241 * it away), so we won't call enable hooks twice.
1243 drm_bridge_pre_enable(encoder->bridge);
1247 funcs->enable(encoder);
1248 else if (funcs->commit)
1249 funcs->commit(encoder);
1252 drm_bridge_enable(encoder->bridge);
1255 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1258 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1260 * @state: atomic state object with old state structures
1261 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1262 * Otherwise @state is the old state.
1264 * For implicit sync, driver should fish the exclusive fence out from the
1265 * incoming fb's and stash it in the drm_plane_state. This is called after
1266 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1267 * just uses the atomic state to find the changed planes)
1269 * Note that @pre_swap is needed since the point where we block for fences moves
1270 * around depending upon whether an atomic commit is blocking or
1271 * non-blocking. For non-blocking commit all waiting needs to happen after
1272 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1273 * to wait **before** we do anything that can't be easily rolled back. That is
1274 * before we call drm_atomic_helper_swap_state().
1276 * Returns zero if success or < 0 if dma_fence_wait() fails.
1278 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1279 struct drm_atomic_state *state,
1282 struct drm_plane *plane;
1283 struct drm_plane_state *new_plane_state;
1286 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1287 if (!new_plane_state->fence)
1290 WARN_ON(!new_plane_state->fb);
1293 * If waiting for fences pre-swap (ie: nonblock), userspace can
1294 * still interrupt the operation. Instead of blocking until the
1295 * timer expires, make the wait interruptible.
1297 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1301 dma_fence_put(new_plane_state->fence);
1302 new_plane_state->fence = NULL;
1307 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1310 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1312 * @old_state: atomic state object with old state structures
1314 * Helper to, after atomic commit, wait for vblanks on all effected
1315 * crtcs (ie. before cleaning up old framebuffers using
1316 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1317 * framebuffers have actually changed to optimize for the legacy cursor and
1318 * plane update use-case.
1320 * Drivers using the nonblocking commit tracking support initialized by calling
1321 * drm_atomic_helper_setup_commit() should look at
1322 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1325 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1326 struct drm_atomic_state *old_state)
1328 struct drm_crtc *crtc;
1329 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1331 unsigned crtc_mask = 0;
1334 * Legacy cursor ioctls are completely unsynced, and userspace
1335 * relies on that (by doing tons of cursor updates).
1337 if (old_state->legacy_cursor_update)
1340 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1341 if (!new_crtc_state->active)
1344 ret = drm_crtc_vblank_get(crtc);
1348 crtc_mask |= drm_crtc_mask(crtc);
1349 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1352 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1353 if (!(crtc_mask & drm_crtc_mask(crtc)))
1356 ret = wait_event_timeout(dev->vblank[i].queue,
1357 old_state->crtcs[i].last_vblank_count !=
1358 drm_crtc_vblank_count(crtc),
1359 msecs_to_jiffies(50));
1361 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1362 crtc->base.id, crtc->name);
1364 drm_crtc_vblank_put(crtc);
1367 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1370 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1372 * @old_state: atomic state object with old state structures
1374 * Helper to, after atomic commit, wait for page flips on all effected
1375 * crtcs (ie. before cleaning up old framebuffers using
1376 * drm_atomic_helper_cleanup_planes()). Compared to
1377 * drm_atomic_helper_wait_for_vblanks() this waits for the completion of on all
1378 * CRTCs, assuming that cursors-only updates are signalling their completion
1379 * immediately (or using a different path).
1381 * This requires that drivers use the nonblocking commit tracking support
1382 * initialized using drm_atomic_helper_setup_commit().
1384 void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1385 struct drm_atomic_state *old_state)
1387 struct drm_crtc_state *new_crtc_state;
1388 struct drm_crtc *crtc;
1391 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1392 struct drm_crtc_commit *commit = new_crtc_state->commit;
1398 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1400 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1401 crtc->base.id, crtc->name);
1404 EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1407 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1408 * @old_state: atomic state object with old state structures
1410 * This is the default implementation for the
1411 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1412 * that do not support runtime_pm or do not need the CRTC to be
1413 * enabled to perform a commit. Otherwise, see
1414 * drm_atomic_helper_commit_tail_rpm().
1416 * Note that the default ordering of how the various stages are called is to
1417 * match the legacy modeset helper library closest.
1419 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1421 struct drm_device *dev = old_state->dev;
1423 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1425 drm_atomic_helper_commit_planes(dev, old_state, 0);
1427 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1429 drm_atomic_helper_commit_hw_done(old_state);
1431 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1433 drm_atomic_helper_cleanup_planes(dev, old_state);
1435 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1438 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1439 * @old_state: new modeset state to be committed
1441 * This is an alternative implementation for the
1442 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1443 * that support runtime_pm or need the CRTC to be enabled to perform a
1444 * commit. Otherwise, one should use the default implementation
1445 * drm_atomic_helper_commit_tail().
1447 void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1449 struct drm_device *dev = old_state->dev;
1451 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1453 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1455 drm_atomic_helper_commit_planes(dev, old_state,
1456 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1458 drm_atomic_helper_commit_hw_done(old_state);
1460 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1462 drm_atomic_helper_cleanup_planes(dev, old_state);
1464 EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1466 static void commit_tail(struct drm_atomic_state *old_state)
1468 struct drm_device *dev = old_state->dev;
1469 const struct drm_mode_config_helper_funcs *funcs;
1471 funcs = dev->mode_config.helper_private;
1473 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1475 drm_atomic_helper_wait_for_dependencies(old_state);
1477 if (funcs && funcs->atomic_commit_tail)
1478 funcs->atomic_commit_tail(old_state);
1480 drm_atomic_helper_commit_tail(old_state);
1482 drm_atomic_helper_commit_cleanup_done(old_state);
1484 drm_atomic_state_put(old_state);
1487 static void commit_work(struct work_struct *work)
1489 struct drm_atomic_state *state = container_of(work,
1490 struct drm_atomic_state,
1496 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1498 * @state: the driver state object
1500 * This helper will check if it is possible to commit the state asynchronously.
1501 * Async commits are not supposed to swap the states like normal sync commits
1502 * but just do in-place changes on the current state.
1504 * It will return 0 if the commit can happen in an asynchronous fashion or error
1505 * if not. Note that error just mean it can't be commited asynchronously, if it
1506 * fails the commit should be treated like a normal synchronous commit.
1508 int drm_atomic_helper_async_check(struct drm_device *dev,
1509 struct drm_atomic_state *state)
1511 struct drm_crtc *crtc;
1512 struct drm_crtc_state *crtc_state;
1513 struct drm_plane *plane = NULL;
1514 struct drm_plane_state *old_plane_state = NULL;
1515 struct drm_plane_state *new_plane_state = NULL;
1516 const struct drm_plane_helper_funcs *funcs;
1517 int i, n_planes = 0;
1519 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1520 if (drm_atomic_crtc_needs_modeset(crtc_state))
1524 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1527 /* FIXME: we support only single plane updates for now */
1531 if (!new_plane_state->crtc ||
1532 old_plane_state->crtc != new_plane_state->crtc)
1535 funcs = plane->helper_private;
1536 if (!funcs->atomic_async_update)
1539 if (new_plane_state->fence)
1543 * Don't do an async update if there is an outstanding commit modifying
1544 * the plane. This prevents our async update's changes from getting
1545 * overridden by a previous synchronous update's state.
1547 if (old_plane_state->commit &&
1548 !try_wait_for_completion(&old_plane_state->commit->hw_done))
1551 return funcs->atomic_async_check(plane, new_plane_state);
1553 EXPORT_SYMBOL(drm_atomic_helper_async_check);
1556 * drm_atomic_helper_async_commit - commit state asynchronously
1558 * @state: the driver state object
1560 * This function commits a state asynchronously, i.e., not vblank
1561 * synchronized. It should be used on a state only when
1562 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1563 * the states like normal sync commits, but just do in-place changes on the
1566 void drm_atomic_helper_async_commit(struct drm_device *dev,
1567 struct drm_atomic_state *state)
1569 struct drm_plane *plane;
1570 struct drm_plane_state *plane_state;
1571 const struct drm_plane_helper_funcs *funcs;
1574 for_each_new_plane_in_state(state, plane, plane_state, i) {
1575 funcs = plane->helper_private;
1576 funcs->atomic_async_update(plane, plane_state);
1579 * ->atomic_async_update() is supposed to update the
1580 * plane->state in-place, make sure at least common
1581 * properties have been properly updated.
1583 WARN_ON_ONCE(plane->state->fb != plane_state->fb);
1584 WARN_ON_ONCE(plane->state->crtc_x != plane_state->crtc_x);
1585 WARN_ON_ONCE(plane->state->crtc_y != plane_state->crtc_y);
1586 WARN_ON_ONCE(plane->state->src_x != plane_state->src_x);
1587 WARN_ON_ONCE(plane->state->src_y != plane_state->src_y);
1590 EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1593 * drm_atomic_helper_commit - commit validated state object
1595 * @state: the driver state object
1596 * @nonblock: whether nonblocking behavior is requested.
1598 * This function commits a with drm_atomic_helper_check() pre-validated state
1599 * object. This can still fail when e.g. the framebuffer reservation fails. This
1600 * function implements nonblocking commits, using
1601 * drm_atomic_helper_setup_commit() and related functions.
1603 * Committing the actual hardware state is done through the
1604 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default
1605 * implementation drm_atomic_helper_commit_tail().
1608 * Zero for success or -errno.
1610 int drm_atomic_helper_commit(struct drm_device *dev,
1611 struct drm_atomic_state *state,
1616 if (state->async_update) {
1617 ret = drm_atomic_helper_prepare_planes(dev, state);
1621 drm_atomic_helper_async_commit(dev, state);
1622 drm_atomic_helper_cleanup_planes(dev, state);
1627 ret = drm_atomic_helper_setup_commit(state, nonblock);
1631 INIT_WORK(&state->commit_work, commit_work);
1633 ret = drm_atomic_helper_prepare_planes(dev, state);
1638 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1644 * This is the point of no return - everything below never fails except
1645 * when the hw goes bonghits. Which means we can commit the new state on
1646 * the software side now.
1649 ret = drm_atomic_helper_swap_state(state, true);
1654 * Everything below can be run asynchronously without the need to grab
1655 * any modeset locks at all under one condition: It must be guaranteed
1656 * that the asynchronous work has either been cancelled (if the driver
1657 * supports it, which at least requires that the framebuffers get
1658 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1659 * before the new state gets committed on the software side with
1660 * drm_atomic_helper_swap_state().
1662 * This scheme allows new atomic state updates to be prepared and
1663 * checked in parallel to the asynchronous completion of the previous
1664 * update. Which is important since compositors need to figure out the
1665 * composition of the next frame right after having submitted the
1668 * NOTE: Commit work has multiple phases, first hardware commit, then
1669 * cleanup. We want them to overlap, hence need system_unbound_wq to
1670 * make sure work items don't artifically stall on each another.
1673 drm_atomic_state_get(state);
1675 queue_work(system_unbound_wq, &state->commit_work);
1682 drm_atomic_helper_cleanup_planes(dev, state);
1685 EXPORT_SYMBOL(drm_atomic_helper_commit);
1688 * DOC: implementing nonblocking commit
1690 * Nonblocking atomic commits have to be implemented in the following sequence:
1692 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1693 * which commit needs to call which can fail, so we want to run it first and
1696 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1697 * might be affected the new state update. This can be done by either cancelling
1698 * or flushing the work items, depending upon whether the driver can deal with
1699 * cancelled updates. Note that it is important to ensure that the framebuffer
1700 * cleanup is still done when cancelling.
1702 * Asynchronous workers need to have sufficient parallelism to be able to run
1703 * different atomic commits on different CRTCs in parallel. The simplest way to
1704 * achive this is by running them on the &system_unbound_wq work queue. Note
1705 * that drivers are not required to split up atomic commits and run an
1706 * individual commit in parallel - userspace is supposed to do that if it cares.
1707 * But it might be beneficial to do that for modesets, since those necessarily
1708 * must be done as one global operation, and enabling or disabling a CRTC can
1709 * take a long time. But even that is not required.
1711 * 3. The software state is updated synchronously with
1712 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1713 * locks means concurrent callers never see inconsistent state. And doing this
1714 * while it's guaranteed that no relevant nonblocking worker runs means that
1715 * nonblocking workers do not need grab any locks. Actually they must not grab
1716 * locks, for otherwise the work flushing will deadlock.
1718 * 4. Schedule a work item to do all subsequent steps, using the split-out
1719 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1720 * then cleaning up the framebuffers after the old framebuffer is no longer
1723 * The above scheme is implemented in the atomic helper libraries in
1724 * drm_atomic_helper_commit() using a bunch of helper functions. See
1725 * drm_atomic_helper_setup_commit() for a starting point.
1728 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1730 struct drm_crtc_commit *commit, *stall_commit = NULL;
1731 bool completed = true;
1735 spin_lock(&crtc->commit_lock);
1737 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1739 completed = try_wait_for_completion(&commit->flip_done);
1740 /* Userspace is not allowed to get ahead of the previous
1741 * commit with nonblocking ones. */
1742 if (!completed && nonblock) {
1743 spin_unlock(&crtc->commit_lock);
1746 } else if (i == 1) {
1747 stall_commit = drm_crtc_commit_get(commit);
1753 spin_unlock(&crtc->commit_lock);
1758 /* We don't want to let commits get ahead of cleanup work too much,
1759 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1761 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1764 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1765 crtc->base.id, crtc->name);
1767 drm_crtc_commit_put(stall_commit);
1769 return ret < 0 ? ret : 0;
1772 static void release_crtc_commit(struct completion *completion)
1774 struct drm_crtc_commit *commit = container_of(completion,
1778 drm_crtc_commit_put(commit);
1781 static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
1783 init_completion(&commit->flip_done);
1784 init_completion(&commit->hw_done);
1785 init_completion(&commit->cleanup_done);
1786 INIT_LIST_HEAD(&commit->commit_entry);
1787 kref_init(&commit->ref);
1788 commit->crtc = crtc;
1791 static struct drm_crtc_commit *
1792 crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
1795 struct drm_crtc_state *new_crtc_state;
1797 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
1799 return new_crtc_state->commit;
1802 if (!state->fake_commit) {
1803 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
1804 if (!state->fake_commit)
1807 init_commit(state->fake_commit, NULL);
1810 return state->fake_commit;
1814 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1815 * @state: new modeset state to be committed
1816 * @nonblock: whether nonblocking behavior is requested.
1818 * This function prepares @state to be used by the atomic helper's support for
1819 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1820 * should always call this function from their
1821 * &drm_mode_config_funcs.atomic_commit hook.
1823 * To be able to use this support drivers need to use a few more helper
1824 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1825 * actually committing the hardware state, and for nonblocking commits this call
1826 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1827 * and it's stall parameter, for when a driver's commit hooks look at the
1828 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1830 * Completion of the hardware commit step must be signalled using
1831 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1832 * to read or change any permanent software or hardware modeset state. The only
1833 * exception is state protected by other means than &drm_modeset_lock locks.
1834 * Only the free standing @state with pointers to the old state structures can
1835 * be inspected, e.g. to clean up old buffers using
1836 * drm_atomic_helper_cleanup_planes().
1838 * At the very end, before cleaning up @state drivers must call
1839 * drm_atomic_helper_commit_cleanup_done().
1841 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1842 * complete and easy-to-use default implementation of the atomic_commit() hook.
1844 * The tracking of asynchronously executed and still pending commits is done
1845 * using the core structure &drm_crtc_commit.
1847 * By default there's no need to clean up resources allocated by this function
1848 * explicitly: drm_atomic_state_default_clear() will take care of that
1853 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1854 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1856 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1859 struct drm_crtc *crtc;
1860 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1861 struct drm_connector *conn;
1862 struct drm_connector_state *old_conn_state, *new_conn_state;
1863 struct drm_plane *plane;
1864 struct drm_plane_state *old_plane_state, *new_plane_state;
1865 struct drm_crtc_commit *commit;
1868 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1869 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1873 init_commit(commit, crtc);
1875 new_crtc_state->commit = commit;
1877 ret = stall_checks(crtc, nonblock);
1881 /* Drivers only send out events when at least either current or
1882 * new CRTC state is active. Complete right away if everything
1884 if (!old_crtc_state->active && !new_crtc_state->active) {
1885 complete_all(&commit->flip_done);
1889 /* Legacy cursor updates are fully unsynced. */
1890 if (state->legacy_cursor_update) {
1891 complete_all(&commit->flip_done);
1895 if (!new_crtc_state->event) {
1896 commit->event = kzalloc(sizeof(*commit->event),
1901 new_crtc_state->event = commit->event;
1904 new_crtc_state->event->base.completion = &commit->flip_done;
1905 new_crtc_state->event->base.completion_release = release_crtc_commit;
1906 drm_crtc_commit_get(commit);
1908 commit->abort_completion = true;
1911 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
1912 /* Userspace is not allowed to get ahead of the previous
1913 * commit with nonblocking ones. */
1914 if (nonblock && old_conn_state->commit &&
1915 !try_wait_for_completion(&old_conn_state->commit->flip_done))
1918 /* Always track connectors explicitly for e.g. link retraining. */
1919 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
1923 new_conn_state->commit = drm_crtc_commit_get(commit);
1926 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
1927 /* Userspace is not allowed to get ahead of the previous
1928 * commit with nonblocking ones. */
1929 if (nonblock && old_plane_state->commit &&
1930 !try_wait_for_completion(&old_plane_state->commit->flip_done))
1933 /* Always track planes explicitly for async pageflip support. */
1934 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
1938 new_plane_state->commit = drm_crtc_commit_get(commit);
1943 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1946 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1947 * @old_state: atomic state object with old state structures
1949 * This function waits for all preceeding commits that touch the same CRTC as
1950 * @old_state to both be committed to the hardware (as signalled by
1951 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1952 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
1954 * This is part of the atomic helper support for nonblocking commits, see
1955 * drm_atomic_helper_setup_commit() for an overview.
1957 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
1959 struct drm_crtc *crtc;
1960 struct drm_crtc_state *old_crtc_state;
1961 struct drm_plane *plane;
1962 struct drm_plane_state *old_plane_state;
1963 struct drm_connector *conn;
1964 struct drm_connector_state *old_conn_state;
1965 struct drm_crtc_commit *commit;
1969 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1970 commit = old_crtc_state->commit;
1975 ret = wait_for_completion_timeout(&commit->hw_done,
1978 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1979 crtc->base.id, crtc->name);
1981 /* Currently no support for overwriting flips, hence
1982 * stall for previous one to execute completely. */
1983 ret = wait_for_completion_timeout(&commit->flip_done,
1986 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1987 crtc->base.id, crtc->name);
1990 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
1991 commit = old_conn_state->commit;
1996 ret = wait_for_completion_timeout(&commit->hw_done,
1999 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
2000 conn->base.id, conn->name);
2002 /* Currently no support for overwriting flips, hence
2003 * stall for previous one to execute completely. */
2004 ret = wait_for_completion_timeout(&commit->flip_done,
2007 DRM_ERROR("[CONNECTOR:%d:%s] flip_done timed out\n",
2008 conn->base.id, conn->name);
2011 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
2012 commit = old_plane_state->commit;
2017 ret = wait_for_completion_timeout(&commit->hw_done,
2020 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
2021 plane->base.id, plane->name);
2023 /* Currently no support for overwriting flips, hence
2024 * stall for previous one to execute completely. */
2025 ret = wait_for_completion_timeout(&commit->flip_done,
2028 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2029 plane->base.id, plane->name);
2032 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2035 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2036 * @old_state: atomic state object with old state structures
2038 * This function is used to signal completion of the hardware commit step. After
2039 * this step the driver is not allowed to read or change any permanent software
2040 * or hardware modeset state. The only exception is state protected by other
2041 * means than &drm_modeset_lock locks.
2043 * Drivers should try to postpone any expensive or delayed cleanup work after
2044 * this function is called.
2046 * This is part of the atomic helper support for nonblocking commits, see
2047 * drm_atomic_helper_setup_commit() for an overview.
2049 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2051 struct drm_crtc *crtc;
2052 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2053 struct drm_crtc_commit *commit;
2056 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2057 commit = new_crtc_state->commit;
2062 * copy new_crtc_state->commit to old_crtc_state->commit,
2063 * it's unsafe to touch new_crtc_state after hw_done,
2064 * but we still need to do so in cleanup_done().
2066 if (old_crtc_state->commit)
2067 drm_crtc_commit_put(old_crtc_state->commit);
2069 old_crtc_state->commit = drm_crtc_commit_get(commit);
2071 /* backend must have consumed any event by now */
2072 WARN_ON(new_crtc_state->event);
2073 complete_all(&commit->hw_done);
2076 if (old_state->fake_commit) {
2077 complete_all(&old_state->fake_commit->hw_done);
2078 complete_all(&old_state->fake_commit->flip_done);
2081 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2084 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2085 * @old_state: atomic state object with old state structures
2087 * This signals completion of the atomic update @old_state, including any
2088 * cleanup work. If used, it must be called right before calling
2089 * drm_atomic_state_put().
2091 * This is part of the atomic helper support for nonblocking commits, see
2092 * drm_atomic_helper_setup_commit() for an overview.
2094 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2096 struct drm_crtc *crtc;
2097 struct drm_crtc_state *old_crtc_state;
2098 struct drm_crtc_commit *commit;
2101 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2102 commit = old_crtc_state->commit;
2103 if (WARN_ON(!commit))
2106 complete_all(&commit->cleanup_done);
2107 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2109 spin_lock(&crtc->commit_lock);
2110 list_del(&commit->commit_entry);
2111 spin_unlock(&crtc->commit_lock);
2114 if (old_state->fake_commit)
2115 complete_all(&old_state->fake_commit->cleanup_done);
2117 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2120 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2122 * @state: atomic state object with new state structures
2124 * This function prepares plane state, specifically framebuffers, for the new
2125 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2126 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2127 * any already successfully prepared framebuffer.
2130 * 0 on success, negative error code on failure.
2132 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2133 struct drm_atomic_state *state)
2135 struct drm_plane *plane;
2136 struct drm_plane_state *new_plane_state;
2139 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2140 const struct drm_plane_helper_funcs *funcs;
2142 funcs = plane->helper_private;
2144 if (funcs->prepare_fb) {
2145 ret = funcs->prepare_fb(plane, new_plane_state);
2154 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2155 const struct drm_plane_helper_funcs *funcs;
2160 funcs = plane->helper_private;
2162 if (funcs->cleanup_fb)
2163 funcs->cleanup_fb(plane, new_plane_state);
2168 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2170 static bool plane_crtc_active(const struct drm_plane_state *state)
2172 return state->crtc && state->crtc->state->active;
2176 * drm_atomic_helper_commit_planes - commit plane state
2178 * @old_state: atomic state object with old state structures
2179 * @flags: flags for committing plane state
2181 * This function commits the new plane state using the plane and atomic helper
2182 * functions for planes and crtcs. It assumes that the atomic state has already
2183 * been pushed into the relevant object state pointers, since this step can no
2186 * It still requires the global state object @old_state to know which planes and
2187 * crtcs need to be updated though.
2189 * Note that this function does all plane updates across all CRTCs in one step.
2190 * If the hardware can't support this approach look at
2191 * drm_atomic_helper_commit_planes_on_crtc() instead.
2193 * Plane parameters can be updated by applications while the associated CRTC is
2194 * disabled. The DRM/KMS core will store the parameters in the plane state,
2195 * which will be available to the driver when the CRTC is turned on. As a result
2196 * most drivers don't need to be immediately notified of plane updates for a
2199 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2200 * @flags in order not to receive plane update notifications related to a
2201 * disabled CRTC. This avoids the need to manually ignore plane updates in
2202 * driver code when the driver and/or hardware can't or just don't need to deal
2203 * with updates on disabled CRTCs, for example when supporting runtime PM.
2205 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2206 * display controllers require to disable a CRTC's planes when the CRTC is
2207 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2208 * call for a plane if the CRTC of the old plane state needs a modesetting
2209 * operation. Of course, the drivers need to disable the planes in their CRTC
2210 * disable callbacks since no one else would do that.
2212 * The drm_atomic_helper_commit() default implementation doesn't set the
2213 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2214 * This should not be copied blindly by drivers.
2216 void drm_atomic_helper_commit_planes(struct drm_device *dev,
2217 struct drm_atomic_state *old_state,
2220 struct drm_crtc *crtc;
2221 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2222 struct drm_plane *plane;
2223 struct drm_plane_state *old_plane_state, *new_plane_state;
2225 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2226 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2228 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2229 const struct drm_crtc_helper_funcs *funcs;
2231 funcs = crtc->helper_private;
2233 if (!funcs || !funcs->atomic_begin)
2236 if (active_only && !new_crtc_state->active)
2239 funcs->atomic_begin(crtc, old_crtc_state);
2242 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2243 const struct drm_plane_helper_funcs *funcs;
2246 funcs = plane->helper_private;
2251 disabling = drm_atomic_plane_disabling(old_plane_state,
2256 * Skip planes related to inactive CRTCs. If the plane
2257 * is enabled use the state of the current CRTC. If the
2258 * plane is being disabled use the state of the old
2259 * CRTC to avoid skipping planes being disabled on an
2262 if (!disabling && !plane_crtc_active(new_plane_state))
2264 if (disabling && !plane_crtc_active(old_plane_state))
2269 * Special-case disabling the plane if drivers support it.
2271 if (disabling && funcs->atomic_disable) {
2272 struct drm_crtc_state *crtc_state;
2274 crtc_state = old_plane_state->crtc->state;
2276 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2280 funcs->atomic_disable(plane, old_plane_state);
2281 } else if (new_plane_state->crtc || disabling) {
2282 funcs->atomic_update(plane, old_plane_state);
2286 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2287 const struct drm_crtc_helper_funcs *funcs;
2289 funcs = crtc->helper_private;
2291 if (!funcs || !funcs->atomic_flush)
2294 if (active_only && !new_crtc_state->active)
2297 funcs->atomic_flush(crtc, old_crtc_state);
2300 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2303 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
2304 * @old_crtc_state: atomic state object with the old crtc state
2306 * This function commits the new plane state using the plane and atomic helper
2307 * functions for planes on the specific crtc. It assumes that the atomic state
2308 * has already been pushed into the relevant object state pointers, since this
2309 * step can no longer fail.
2311 * This function is useful when plane updates should be done crtc-by-crtc
2312 * instead of one global step like drm_atomic_helper_commit_planes() does.
2314 * This function can only be savely used when planes are not allowed to move
2315 * between different CRTCs because this function doesn't handle inter-CRTC
2316 * depencies. Callers need to ensure that either no such depencies exist,
2317 * resolve them through ordering of commit calls or through some other means.
2320 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2322 const struct drm_crtc_helper_funcs *crtc_funcs;
2323 struct drm_crtc *crtc = old_crtc_state->crtc;
2324 struct drm_atomic_state *old_state = old_crtc_state->state;
2325 struct drm_plane *plane;
2326 unsigned plane_mask;
2328 plane_mask = old_crtc_state->plane_mask;
2329 plane_mask |= crtc->state->plane_mask;
2331 crtc_funcs = crtc->helper_private;
2332 if (crtc_funcs && crtc_funcs->atomic_begin)
2333 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2335 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2336 struct drm_plane_state *old_plane_state =
2337 drm_atomic_get_old_plane_state(old_state, plane);
2338 const struct drm_plane_helper_funcs *plane_funcs;
2340 plane_funcs = plane->helper_private;
2342 if (!old_plane_state || !plane_funcs)
2345 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
2347 if (drm_atomic_plane_disabling(old_plane_state, plane->state) &&
2348 plane_funcs->atomic_disable)
2349 plane_funcs->atomic_disable(plane, old_plane_state);
2350 else if (plane->state->crtc ||
2351 drm_atomic_plane_disabling(old_plane_state, plane->state))
2352 plane_funcs->atomic_update(plane, old_plane_state);
2355 if (crtc_funcs && crtc_funcs->atomic_flush)
2356 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2358 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2361 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2362 * @old_crtc_state: atomic state object with the old CRTC state
2363 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2365 * Disables all planes associated with the given CRTC. This can be
2366 * used for instance in the CRTC helper atomic_disable callback to disable
2369 * If the atomic-parameter is set the function calls the CRTC's
2370 * atomic_begin hook before and atomic_flush hook after disabling the
2373 * It is a bug to call this function without having implemented the
2374 * &drm_plane_helper_funcs.atomic_disable plane hook.
2377 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2380 struct drm_crtc *crtc = old_crtc_state->crtc;
2381 const struct drm_crtc_helper_funcs *crtc_funcs =
2382 crtc->helper_private;
2383 struct drm_plane *plane;
2385 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2386 crtc_funcs->atomic_begin(crtc, NULL);
2388 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2389 const struct drm_plane_helper_funcs *plane_funcs =
2390 plane->helper_private;
2395 WARN_ON(!plane_funcs->atomic_disable);
2396 if (plane_funcs->atomic_disable)
2397 plane_funcs->atomic_disable(plane, NULL);
2400 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2401 crtc_funcs->atomic_flush(crtc, NULL);
2403 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2406 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2408 * @old_state: atomic state object with old state structures
2410 * This function cleans up plane state, specifically framebuffers, from the old
2411 * configuration. Hence the old configuration must be perserved in @old_state to
2412 * be able to call this function.
2414 * This function must also be called on the new state when the atomic update
2415 * fails at any point after calling drm_atomic_helper_prepare_planes().
2417 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2418 struct drm_atomic_state *old_state)
2420 struct drm_plane *plane;
2421 struct drm_plane_state *old_plane_state, *new_plane_state;
2424 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2425 const struct drm_plane_helper_funcs *funcs;
2426 struct drm_plane_state *plane_state;
2429 * This might be called before swapping when commit is aborted,
2430 * in which case we have to cleanup the new state.
2432 if (old_plane_state == plane->state)
2433 plane_state = new_plane_state;
2435 plane_state = old_plane_state;
2437 funcs = plane->helper_private;
2439 if (funcs->cleanup_fb)
2440 funcs->cleanup_fb(plane, plane_state);
2443 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2446 * drm_atomic_helper_swap_state - store atomic state into current sw state
2447 * @state: atomic state
2448 * @stall: stall for preceeding commits
2450 * This function stores the atomic state into the current state pointers in all
2451 * driver objects. It should be called after all failing steps have been done
2452 * and succeeded, but before the actual hardware state is committed.
2454 * For cleanup and error recovery the current state for all changed objects will
2455 * be swapped into @state.
2457 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2459 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2461 * 2. Do any other steps that might fail.
2463 * 3. Put the staged state into the current state pointers with this function.
2465 * 4. Actually commit the hardware state.
2467 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2468 * contains the old state. Also do any other cleanup required with that state.
2470 * @stall must be set when nonblocking commits for this driver directly access
2471 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2472 * the current atomic helpers this is almost always the case, since the helpers
2473 * don't pass the right state structures to the callbacks.
2477 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2478 * waiting for the previous commits has been interrupted.
2480 int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2484 struct drm_connector *connector;
2485 struct drm_connector_state *old_conn_state, *new_conn_state;
2486 struct drm_crtc *crtc;
2487 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2488 struct drm_plane *plane;
2489 struct drm_plane_state *old_plane_state, *new_plane_state;
2490 struct drm_crtc_commit *commit;
2491 struct drm_private_obj *obj;
2492 struct drm_private_state *old_obj_state, *new_obj_state;
2496 * We have to stall for hw_done here before
2497 * drm_atomic_helper_wait_for_dependencies() because flip
2498 * depth > 1 is not yet supported by all drivers. As long as
2499 * obj->state is directly dereferenced anywhere in the drivers
2500 * atomic_commit_tail function, then it's unsafe to swap state
2501 * before drm_atomic_helper_commit_hw_done() is called.
2504 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2505 commit = old_crtc_state->commit;
2510 ret = wait_for_completion_interruptible(&commit->hw_done);
2515 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2516 commit = old_conn_state->commit;
2521 ret = wait_for_completion_interruptible(&commit->hw_done);
2526 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2527 commit = old_plane_state->commit;
2532 ret = wait_for_completion_interruptible(&commit->hw_done);
2538 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2539 WARN_ON(connector->state != old_conn_state);
2541 old_conn_state->state = state;
2542 new_conn_state->state = NULL;
2544 state->connectors[i].state = old_conn_state;
2545 connector->state = new_conn_state;
2548 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2549 WARN_ON(crtc->state != old_crtc_state);
2551 old_crtc_state->state = state;
2552 new_crtc_state->state = NULL;
2554 state->crtcs[i].state = old_crtc_state;
2555 crtc->state = new_crtc_state;
2557 if (new_crtc_state->commit) {
2558 spin_lock(&crtc->commit_lock);
2559 list_add(&new_crtc_state->commit->commit_entry,
2560 &crtc->commit_list);
2561 spin_unlock(&crtc->commit_lock);
2563 new_crtc_state->commit->event = NULL;
2567 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2568 WARN_ON(plane->state != old_plane_state);
2570 old_plane_state->state = state;
2571 new_plane_state->state = NULL;
2573 state->planes[i].state = old_plane_state;
2574 plane->state = new_plane_state;
2577 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2578 WARN_ON(obj->state != old_obj_state);
2580 old_obj_state->state = state;
2581 new_obj_state->state = NULL;
2583 state->private_objs[i].state = old_obj_state;
2584 obj->state = new_obj_state;
2589 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2592 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2593 * @plane: plane object to update
2594 * @crtc: owning CRTC of owning plane
2595 * @fb: framebuffer to flip onto plane
2596 * @crtc_x: x offset of primary plane on crtc
2597 * @crtc_y: y offset of primary plane on crtc
2598 * @crtc_w: width of primary plane rectangle on crtc
2599 * @crtc_h: height of primary plane rectangle on crtc
2600 * @src_x: x offset of @fb for panning
2601 * @src_y: y offset of @fb for panning
2602 * @src_w: width of source rectangle in @fb
2603 * @src_h: height of source rectangle in @fb
2604 * @ctx: lock acquire context
2606 * Provides a default plane update handler using the atomic driver interface.
2609 * Zero on success, error code on failure
2611 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2612 struct drm_crtc *crtc,
2613 struct drm_framebuffer *fb,
2614 int crtc_x, int crtc_y,
2615 unsigned int crtc_w, unsigned int crtc_h,
2616 uint32_t src_x, uint32_t src_y,
2617 uint32_t src_w, uint32_t src_h,
2618 struct drm_modeset_acquire_ctx *ctx)
2620 struct drm_atomic_state *state;
2621 struct drm_plane_state *plane_state;
2624 state = drm_atomic_state_alloc(plane->dev);
2628 state->acquire_ctx = ctx;
2629 plane_state = drm_atomic_get_plane_state(state, plane);
2630 if (IS_ERR(plane_state)) {
2631 ret = PTR_ERR(plane_state);
2635 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2638 drm_atomic_set_fb_for_plane(plane_state, fb);
2639 plane_state->crtc_x = crtc_x;
2640 plane_state->crtc_y = crtc_y;
2641 plane_state->crtc_w = crtc_w;
2642 plane_state->crtc_h = crtc_h;
2643 plane_state->src_x = src_x;
2644 plane_state->src_y = src_y;
2645 plane_state->src_w = src_w;
2646 plane_state->src_h = src_h;
2648 if (plane == crtc->cursor)
2649 state->legacy_cursor_update = true;
2651 ret = drm_atomic_commit(state);
2653 drm_atomic_state_put(state);
2656 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2659 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2660 * @plane: plane to disable
2661 * @ctx: lock acquire context
2663 * Provides a default plane disable handler using the atomic driver interface.
2666 * Zero on success, error code on failure
2668 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2669 struct drm_modeset_acquire_ctx *ctx)
2671 struct drm_atomic_state *state;
2672 struct drm_plane_state *plane_state;
2675 state = drm_atomic_state_alloc(plane->dev);
2679 state->acquire_ctx = ctx;
2680 plane_state = drm_atomic_get_plane_state(state, plane);
2681 if (IS_ERR(plane_state)) {
2682 ret = PTR_ERR(plane_state);
2686 if (plane_state->crtc && plane_state->crtc->cursor == plane)
2687 plane_state->state->legacy_cursor_update = true;
2689 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2693 ret = drm_atomic_commit(state);
2695 drm_atomic_state_put(state);
2698 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2700 /* just used from fb-helper and atomic-helper: */
2701 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2702 struct drm_plane_state *plane_state)
2706 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2710 drm_atomic_set_fb_for_plane(plane_state, NULL);
2711 plane_state->crtc_x = 0;
2712 plane_state->crtc_y = 0;
2713 plane_state->crtc_w = 0;
2714 plane_state->crtc_h = 0;
2715 plane_state->src_x = 0;
2716 plane_state->src_y = 0;
2717 plane_state->src_w = 0;
2718 plane_state->src_h = 0;
2723 static int update_output_state(struct drm_atomic_state *state,
2724 struct drm_mode_set *set)
2726 struct drm_device *dev = set->crtc->dev;
2727 struct drm_crtc *crtc;
2728 struct drm_crtc_state *new_crtc_state;
2729 struct drm_connector *connector;
2730 struct drm_connector_state *new_conn_state;
2733 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2734 state->acquire_ctx);
2738 /* First disable all connectors on the target crtc. */
2739 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2743 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2744 if (new_conn_state->crtc == set->crtc) {
2745 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2750 /* Make sure legacy setCrtc always re-trains */
2751 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2755 /* Then set all connectors from set->connectors on the target crtc */
2756 for (i = 0; i < set->num_connectors; i++) {
2757 new_conn_state = drm_atomic_get_connector_state(state,
2758 set->connectors[i]);
2759 if (IS_ERR(new_conn_state))
2760 return PTR_ERR(new_conn_state);
2762 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2768 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2769 /* Don't update ->enable for the CRTC in the set_config request,
2770 * since a mismatch would indicate a bug in the upper layers.
2771 * The actual modeset code later on will catch any
2772 * inconsistencies here. */
2773 if (crtc == set->crtc)
2776 if (!new_crtc_state->connector_mask) {
2777 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2782 new_crtc_state->active = false;
2790 * drm_atomic_helper_set_config - set a new config from userspace
2791 * @set: mode set configuration
2792 * @ctx: lock acquisition context
2794 * Provides a default crtc set_config handler using the atomic driver interface.
2796 * NOTE: For backwards compatibility with old userspace this automatically
2797 * resets the "link-status" property to GOOD, to force any link
2798 * re-training. The SETCRTC ioctl does not define whether an update does
2799 * need a full modeset or just a plane update, hence we're allowed to do
2800 * that. See also drm_mode_connector_set_link_status_property().
2803 * Returns 0 on success, negative errno numbers on failure.
2805 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2806 struct drm_modeset_acquire_ctx *ctx)
2808 struct drm_atomic_state *state;
2809 struct drm_crtc *crtc = set->crtc;
2812 state = drm_atomic_state_alloc(crtc->dev);
2816 state->acquire_ctx = ctx;
2817 ret = __drm_atomic_helper_set_config(set, state);
2821 ret = handle_conflicting_encoders(state, true);
2825 ret = drm_atomic_commit(state);
2828 drm_atomic_state_put(state);
2831 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2833 /* just used from fb-helper and atomic-helper: */
2834 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2835 struct drm_atomic_state *state)
2837 struct drm_crtc_state *crtc_state;
2838 struct drm_plane_state *primary_state;
2839 struct drm_crtc *crtc = set->crtc;
2840 int hdisplay, vdisplay;
2843 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2844 if (IS_ERR(crtc_state))
2845 return PTR_ERR(crtc_state);
2847 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2848 if (IS_ERR(primary_state))
2849 return PTR_ERR(primary_state);
2853 WARN_ON(set->num_connectors);
2855 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2859 crtc_state->active = false;
2861 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2865 drm_atomic_set_fb_for_plane(primary_state, NULL);
2871 WARN_ON(!set->num_connectors);
2873 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2877 crtc_state->active = true;
2879 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2883 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2885 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2886 primary_state->crtc_x = 0;
2887 primary_state->crtc_y = 0;
2888 primary_state->crtc_w = hdisplay;
2889 primary_state->crtc_h = vdisplay;
2890 primary_state->src_x = set->x << 16;
2891 primary_state->src_y = set->y << 16;
2892 if (drm_rotation_90_or_270(primary_state->rotation)) {
2893 primary_state->src_w = vdisplay << 16;
2894 primary_state->src_h = hdisplay << 16;
2896 primary_state->src_w = hdisplay << 16;
2897 primary_state->src_h = vdisplay << 16;
2901 ret = update_output_state(state, set);
2908 static int __drm_atomic_helper_disable_all(struct drm_device *dev,
2909 struct drm_modeset_acquire_ctx *ctx,
2912 struct drm_atomic_state *state;
2913 struct drm_connector_state *conn_state;
2914 struct drm_connector *conn;
2915 struct drm_plane_state *plane_state;
2916 struct drm_plane *plane;
2917 struct drm_crtc_state *crtc_state;
2918 struct drm_crtc *crtc;
2919 unsigned plane_mask = 0;
2922 state = drm_atomic_state_alloc(dev);
2926 state->acquire_ctx = ctx;
2928 drm_for_each_crtc(crtc, dev) {
2929 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2930 if (IS_ERR(crtc_state)) {
2931 ret = PTR_ERR(crtc_state);
2935 crtc_state->active = false;
2937 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
2941 ret = drm_atomic_add_affected_planes(state, crtc);
2945 ret = drm_atomic_add_affected_connectors(state, crtc);
2950 for_each_new_connector_in_state(state, conn, conn_state, i) {
2951 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
2956 for_each_new_plane_in_state(state, plane, plane_state, i) {
2957 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2961 drm_atomic_set_fb_for_plane(plane_state, NULL);
2963 if (clean_old_fbs) {
2964 plane->old_fb = plane->fb;
2965 plane_mask |= BIT(drm_plane_index(plane));
2969 ret = drm_atomic_commit(state);
2972 drm_atomic_clean_old_fb(dev, plane_mask, ret);
2973 drm_atomic_state_put(state);
2978 * drm_atomic_helper_disable_all - disable all currently active outputs
2980 * @ctx: lock acquisition context
2982 * Loops through all connectors, finding those that aren't turned off and then
2983 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2984 * that they are connected to.
2986 * This is used for example in suspend/resume to disable all currently active
2987 * functions when suspending. If you just want to shut down everything at e.g.
2988 * driver unload, look at drm_atomic_helper_shutdown().
2990 * Note that if callers haven't already acquired all modeset locks this might
2991 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2994 * 0 on success or a negative error code on failure.
2997 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
2998 * drm_atomic_helper_shutdown().
3000 int drm_atomic_helper_disable_all(struct drm_device *dev,
3001 struct drm_modeset_acquire_ctx *ctx)
3003 return __drm_atomic_helper_disable_all(dev, ctx, false);
3005 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
3008 * drm_atomic_helper_shutdown - shutdown all CRTC
3011 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
3012 * suspend should instead be handled with drm_atomic_helper_suspend(), since
3013 * that also takes a snapshot of the modeset state to be restored on resume.
3015 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
3016 * and it is the atomic version of drm_crtc_force_disable_all().
3018 void drm_atomic_helper_shutdown(struct drm_device *dev)
3020 struct drm_modeset_acquire_ctx ctx;
3023 drm_modeset_acquire_init(&ctx, 0);
3025 ret = drm_modeset_lock_all_ctx(dev, &ctx);
3027 ret = __drm_atomic_helper_disable_all(dev, &ctx, true);
3029 if (ret != -EDEADLK)
3032 drm_modeset_backoff(&ctx);
3036 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3038 drm_modeset_drop_locks(&ctx);
3039 drm_modeset_acquire_fini(&ctx);
3041 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3044 * drm_atomic_helper_suspend - subsystem-level suspend helper
3047 * Duplicates the current atomic state, disables all active outputs and then
3048 * returns a pointer to the original atomic state to the caller. Drivers can
3049 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3050 * restore the output configuration that was active at the time the system
3053 * Note that it is potentially unsafe to use this. The atomic state object
3054 * returned by this function is assumed to be persistent. Drivers must ensure
3055 * that this holds true. Before calling this function, drivers must make sure
3056 * to suspend fbdev emulation so that nothing can be using the device.
3059 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3060 * encoded error code on failure. Drivers should store the returned atomic
3061 * state object and pass it to the drm_atomic_helper_resume() helper upon
3065 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3066 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3068 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3070 struct drm_modeset_acquire_ctx ctx;
3071 struct drm_atomic_state *state;
3074 drm_modeset_acquire_init(&ctx, 0);
3077 err = drm_modeset_lock_all_ctx(dev, &ctx);
3079 state = ERR_PTR(err);
3083 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3087 err = drm_atomic_helper_disable_all(dev, &ctx);
3089 drm_atomic_state_put(state);
3090 state = ERR_PTR(err);
3095 if (PTR_ERR(state) == -EDEADLK) {
3096 drm_modeset_backoff(&ctx);
3100 drm_modeset_drop_locks(&ctx);
3101 drm_modeset_acquire_fini(&ctx);
3104 EXPORT_SYMBOL(drm_atomic_helper_suspend);
3107 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3108 * @state: duplicated atomic state to commit
3109 * @ctx: pointer to acquire_ctx to use for commit.
3111 * The state returned by drm_atomic_helper_duplicate_state() and
3112 * drm_atomic_helper_suspend() is partially invalid, and needs to
3113 * be fixed up before commit.
3116 * 0 on success or a negative error code on failure.
3119 * drm_atomic_helper_suspend()
3121 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3122 struct drm_modeset_acquire_ctx *ctx)
3125 struct drm_plane *plane;
3126 struct drm_plane_state *new_plane_state;
3127 struct drm_connector *connector;
3128 struct drm_connector_state *new_conn_state;
3129 struct drm_crtc *crtc;
3130 struct drm_crtc_state *new_crtc_state;
3132 state->acquire_ctx = ctx;
3134 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
3135 WARN_ON(plane->crtc != new_plane_state->crtc);
3136 WARN_ON(plane->fb != new_plane_state->fb);
3137 WARN_ON(plane->old_fb);
3139 state->planes[i].old_state = plane->state;
3142 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3143 state->crtcs[i].old_state = crtc->state;
3145 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3146 state->connectors[i].old_state = connector->state;
3148 return drm_atomic_commit(state);
3150 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3153 * drm_atomic_helper_resume - subsystem-level resume helper
3155 * @state: atomic state to resume to
3157 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3158 * grabs all modeset locks and commits the atomic state object. This can be
3159 * used in conjunction with the drm_atomic_helper_suspend() helper to
3160 * implement suspend/resume for drivers that support atomic mode-setting.
3163 * 0 on success or a negative error code on failure.
3166 * drm_atomic_helper_suspend()
3168 int drm_atomic_helper_resume(struct drm_device *dev,
3169 struct drm_atomic_state *state)
3171 struct drm_modeset_acquire_ctx ctx;
3174 drm_mode_config_reset(dev);
3176 drm_modeset_acquire_init(&ctx, 0);
3178 err = drm_modeset_lock_all_ctx(dev, &ctx);
3182 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3184 if (err != -EDEADLK)
3187 drm_modeset_backoff(&ctx);
3190 drm_atomic_state_put(state);
3191 drm_modeset_drop_locks(&ctx);
3192 drm_modeset_acquire_fini(&ctx);
3196 EXPORT_SYMBOL(drm_atomic_helper_resume);
3198 static int page_flip_common(struct drm_atomic_state *state,
3199 struct drm_crtc *crtc,
3200 struct drm_framebuffer *fb,
3201 struct drm_pending_vblank_event *event,
3204 struct drm_plane *plane = crtc->primary;
3205 struct drm_plane_state *plane_state;
3206 struct drm_crtc_state *crtc_state;
3209 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3210 if (IS_ERR(crtc_state))
3211 return PTR_ERR(crtc_state);
3213 crtc_state->event = event;
3214 crtc_state->pageflip_flags = flags;
3216 plane_state = drm_atomic_get_plane_state(state, plane);
3217 if (IS_ERR(plane_state))
3218 return PTR_ERR(plane_state);
3220 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3223 drm_atomic_set_fb_for_plane(plane_state, fb);
3225 /* Make sure we don't accidentally do a full modeset. */
3226 state->allow_modeset = false;
3227 if (!crtc_state->active) {
3228 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3229 crtc->base.id, crtc->name);
3237 * drm_atomic_helper_page_flip - execute a legacy page flip
3239 * @fb: DRM framebuffer
3240 * @event: optional DRM event to signal upon completion
3241 * @flags: flip flags for non-vblank sync'ed updates
3242 * @ctx: lock acquisition context
3244 * Provides a default &drm_crtc_funcs.page_flip implementation
3245 * using the atomic driver interface.
3248 * Returns 0 on success, negative errno numbers on failure.
3251 * drm_atomic_helper_page_flip_target()
3253 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3254 struct drm_framebuffer *fb,
3255 struct drm_pending_vblank_event *event,
3257 struct drm_modeset_acquire_ctx *ctx)
3259 struct drm_plane *plane = crtc->primary;
3260 struct drm_atomic_state *state;
3263 state = drm_atomic_state_alloc(plane->dev);
3267 state->acquire_ctx = ctx;
3269 ret = page_flip_common(state, crtc, fb, event, flags);
3273 ret = drm_atomic_nonblocking_commit(state);
3275 drm_atomic_state_put(state);
3278 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3281 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3283 * @fb: DRM framebuffer
3284 * @event: optional DRM event to signal upon completion
3285 * @flags: flip flags for non-vblank sync'ed updates
3286 * @target: specifying the target vblank period when the flip to take effect
3287 * @ctx: lock acquisition context
3289 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3290 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3291 * target vblank period to flip.
3294 * Returns 0 on success, negative errno numbers on failure.
3296 int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3297 struct drm_framebuffer *fb,
3298 struct drm_pending_vblank_event *event,
3301 struct drm_modeset_acquire_ctx *ctx)
3303 struct drm_plane *plane = crtc->primary;
3304 struct drm_atomic_state *state;
3305 struct drm_crtc_state *crtc_state;
3308 state = drm_atomic_state_alloc(plane->dev);
3312 state->acquire_ctx = ctx;
3314 ret = page_flip_common(state, crtc, fb, event, flags);
3318 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3319 if (WARN_ON(!crtc_state)) {
3323 crtc_state->target_vblank = target;
3325 ret = drm_atomic_nonblocking_commit(state);
3327 drm_atomic_state_put(state);
3330 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3333 * drm_atomic_helper_best_encoder - Helper for
3334 * &drm_connector_helper_funcs.best_encoder callback
3335 * @connector: Connector control structure
3337 * This is a &drm_connector_helper_funcs.best_encoder callback helper for
3338 * connectors that support exactly 1 encoder, statically determined at driver
3341 struct drm_encoder *
3342 drm_atomic_helper_best_encoder(struct drm_connector *connector)
3344 WARN_ON(connector->encoder_ids[1]);
3345 return drm_encoder_find(connector->dev, NULL, connector->encoder_ids[0]);
3347 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
3350 * DOC: atomic state reset and initialization
3352 * Both the drm core and the atomic helpers assume that there is always the full
3353 * and correct atomic software state for all connectors, CRTCs and planes
3354 * available. Which is a bit a problem on driver load and also after system
3355 * suspend. One way to solve this is to have a hardware state read-out
3356 * infrastructure which reconstructs the full software state (e.g. the i915
3359 * The simpler solution is to just reset the software state to everything off,
3360 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
3361 * the atomic helpers provide default reset implementations for all hooks.
3363 * On the upside the precise state tracking of atomic simplifies system suspend
3364 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
3365 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
3366 * For other drivers the building blocks are split out, see the documentation
3367 * for these functions.
3371 * drm_atomic_helper_crtc_reset - default &drm_crtc_funcs.reset hook for CRTCs
3374 * Resets the atomic state for @crtc by freeing the state pointer (which might
3375 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3377 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
3380 __drm_atomic_helper_crtc_destroy_state(crtc->state);
3383 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
3386 crtc->state->crtc = crtc;
3388 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
3391 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
3392 * @crtc: CRTC object
3393 * @state: atomic CRTC state
3395 * Copies atomic state from a CRTC's current state and resets inferred values.
3396 * This is useful for drivers that subclass the CRTC state.
3398 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
3399 struct drm_crtc_state *state)
3401 memcpy(state, crtc->state, sizeof(*state));
3403 if (state->mode_blob)
3404 drm_property_blob_get(state->mode_blob);
3405 if (state->degamma_lut)
3406 drm_property_blob_get(state->degamma_lut);
3408 drm_property_blob_get(state->ctm);
3409 if (state->gamma_lut)
3410 drm_property_blob_get(state->gamma_lut);
3411 state->mode_changed = false;
3412 state->active_changed = false;
3413 state->planes_changed = false;
3414 state->connectors_changed = false;
3415 state->color_mgmt_changed = false;
3416 state->zpos_changed = false;
3417 state->commit = NULL;
3418 state->event = NULL;
3419 state->pageflip_flags = 0;
3421 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
3424 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3427 * Default CRTC state duplicate hook for drivers which don't have their own
3428 * subclassed CRTC state structure.
3430 struct drm_crtc_state *
3431 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
3433 struct drm_crtc_state *state;
3435 if (WARN_ON(!crtc->state))
3438 state = kmalloc(sizeof(*state), GFP_KERNEL);
3440 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
3444 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
3447 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3448 * @state: CRTC state object to release
3450 * Releases all resources stored in the CRTC state without actually freeing
3451 * the memory of the CRTC state. This is useful for drivers that subclass the
3454 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
3456 if (state->commit) {
3458 * In the event that a non-blocking commit returns
3459 * -ERESTARTSYS before the commit_tail work is queued, we will
3460 * have an extra reference to the commit object. Release it, if
3461 * the event has not been consumed by the worker.
3463 * state->event may be freed, so we can't directly look at
3464 * state->event->base.completion.
3466 if (state->event && state->commit->abort_completion)
3467 drm_crtc_commit_put(state->commit);
3469 kfree(state->commit->event);
3470 state->commit->event = NULL;
3472 drm_crtc_commit_put(state->commit);
3475 drm_property_blob_put(state->mode_blob);
3476 drm_property_blob_put(state->degamma_lut);
3477 drm_property_blob_put(state->ctm);
3478 drm_property_blob_put(state->gamma_lut);
3480 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3483 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3485 * @state: CRTC state object to release
3487 * Default CRTC state destroy hook for drivers which don't have their own
3488 * subclassed CRTC state structure.
3490 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3491 struct drm_crtc_state *state)
3493 __drm_atomic_helper_crtc_destroy_state(state);
3496 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3499 * drm_atomic_helper_plane_reset - default &drm_plane_funcs.reset hook for planes
3502 * Resets the atomic state for @plane by freeing the state pointer (which might
3503 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3505 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3508 __drm_atomic_helper_plane_destroy_state(plane->state);
3510 kfree(plane->state);
3511 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3514 plane->state->plane = plane;
3515 plane->state->rotation = DRM_MODE_ROTATE_0;
3517 /* Reset the alpha value to fully opaque if it matters */
3518 if (plane->alpha_property)
3519 plane->state->alpha = plane->alpha_property->values[1];
3522 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3525 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3526 * @plane: plane object
3527 * @state: atomic plane state
3529 * Copies atomic state from a plane's current state. This is useful for
3530 * drivers that subclass the plane state.
3532 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3533 struct drm_plane_state *state)
3535 memcpy(state, plane->state, sizeof(*state));
3538 drm_framebuffer_get(state->fb);
3540 state->fence = NULL;
3541 state->commit = NULL;
3543 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3546 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3549 * Default plane state duplicate hook for drivers which don't have their own
3550 * subclassed plane state structure.
3552 struct drm_plane_state *
3553 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3555 struct drm_plane_state *state;
3557 if (WARN_ON(!plane->state))
3560 state = kmalloc(sizeof(*state), GFP_KERNEL);
3562 __drm_atomic_helper_plane_duplicate_state(plane, state);
3566 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3569 * __drm_atomic_helper_plane_destroy_state - release plane state
3570 * @state: plane state object to release
3572 * Releases all resources stored in the plane state without actually freeing
3573 * the memory of the plane state. This is useful for drivers that subclass the
3576 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3579 drm_framebuffer_put(state->fb);
3582 dma_fence_put(state->fence);
3585 drm_crtc_commit_put(state->commit);
3587 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3590 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3592 * @state: plane state object to release
3594 * Default plane state destroy hook for drivers which don't have their own
3595 * subclassed plane state structure.
3597 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3598 struct drm_plane_state *state)
3600 __drm_atomic_helper_plane_destroy_state(state);
3603 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3606 * __drm_atomic_helper_connector_reset - reset state on connector
3607 * @connector: drm connector
3608 * @conn_state: connector state to assign
3610 * Initializes the newly allocated @conn_state and assigns it to
3611 * the &drm_conector->state pointer of @connector, usually required when
3612 * initializing the drivers or when called from the &drm_connector_funcs.reset
3615 * This is useful for drivers that subclass the connector state.
3618 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
3619 struct drm_connector_state *conn_state)
3622 conn_state->connector = connector;
3624 connector->state = conn_state;
3626 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3629 * drm_atomic_helper_connector_reset - default &drm_connector_funcs.reset hook for connectors
3630 * @connector: drm connector
3632 * Resets the atomic state for @connector by freeing the state pointer (which
3633 * might be NULL, e.g. at driver load time) and allocating a new empty state
3636 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3638 struct drm_connector_state *conn_state =
3639 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3641 if (connector->state)
3642 __drm_atomic_helper_connector_destroy_state(connector->state);
3644 kfree(connector->state);
3645 __drm_atomic_helper_connector_reset(connector, conn_state);
3647 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3650 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3651 * @connector: connector object
3652 * @state: atomic connector state
3654 * Copies atomic state from a connector's current state. This is useful for
3655 * drivers that subclass the connector state.
3658 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3659 struct drm_connector_state *state)
3661 memcpy(state, connector->state, sizeof(*state));
3663 drm_connector_get(connector);
3664 state->commit = NULL;
3666 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3669 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3670 * @connector: drm connector
3672 * Default connector state duplicate hook for drivers which don't have their own
3673 * subclassed connector state structure.
3675 struct drm_connector_state *
3676 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3678 struct drm_connector_state *state;
3680 if (WARN_ON(!connector->state))
3683 state = kmalloc(sizeof(*state), GFP_KERNEL);
3685 __drm_atomic_helper_connector_duplicate_state(connector, state);
3689 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3692 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3694 * @ctx: lock acquisition context
3696 * Makes a copy of the current atomic state by looping over all objects and
3697 * duplicating their respective states. This is used for example by suspend/
3698 * resume support code to save the state prior to suspend such that it can
3699 * be restored upon resume.
3701 * Note that this treats atomic state as persistent between save and restore.
3702 * Drivers must make sure that this is possible and won't result in confusion
3703 * or erroneous behaviour.
3705 * Note that if callers haven't already acquired all modeset locks this might
3706 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3709 * A pointer to the copy of the atomic state object on success or an
3710 * ERR_PTR()-encoded error code on failure.
3713 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3715 struct drm_atomic_state *
3716 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3717 struct drm_modeset_acquire_ctx *ctx)
3719 struct drm_atomic_state *state;
3720 struct drm_connector *conn;
3721 struct drm_connector_list_iter conn_iter;
3722 struct drm_plane *plane;
3723 struct drm_crtc *crtc;
3726 state = drm_atomic_state_alloc(dev);
3728 return ERR_PTR(-ENOMEM);
3730 state->acquire_ctx = ctx;
3732 drm_for_each_crtc(crtc, dev) {
3733 struct drm_crtc_state *crtc_state;
3735 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3736 if (IS_ERR(crtc_state)) {
3737 err = PTR_ERR(crtc_state);
3742 drm_for_each_plane(plane, dev) {
3743 struct drm_plane_state *plane_state;
3745 plane_state = drm_atomic_get_plane_state(state, plane);
3746 if (IS_ERR(plane_state)) {
3747 err = PTR_ERR(plane_state);
3752 drm_connector_list_iter_begin(dev, &conn_iter);
3753 drm_for_each_connector_iter(conn, &conn_iter) {
3754 struct drm_connector_state *conn_state;
3756 conn_state = drm_atomic_get_connector_state(state, conn);
3757 if (IS_ERR(conn_state)) {
3758 err = PTR_ERR(conn_state);
3759 drm_connector_list_iter_end(&conn_iter);
3763 drm_connector_list_iter_end(&conn_iter);
3765 /* clear the acquire context so that it isn't accidentally reused */
3766 state->acquire_ctx = NULL;
3770 drm_atomic_state_put(state);
3771 state = ERR_PTR(err);
3776 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3779 * __drm_atomic_helper_connector_destroy_state - release connector state
3780 * @state: connector state object to release
3782 * Releases all resources stored in the connector state without actually
3783 * freeing the memory of the connector state. This is useful for drivers that
3784 * subclass the connector state.
3787 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3790 drm_connector_put(state->connector);
3793 drm_crtc_commit_put(state->commit);
3795 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3798 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3799 * @connector: drm connector
3800 * @state: connector state object to release
3802 * Default connector state destroy hook for drivers which don't have their own
3803 * subclassed connector state structure.
3805 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3806 struct drm_connector_state *state)
3808 __drm_atomic_helper_connector_destroy_state(state);
3811 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3814 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3815 * @crtc: CRTC object
3816 * @red: red correction table
3817 * @green: green correction table
3818 * @blue: green correction table
3819 * @size: size of the tables
3820 * @ctx: lock acquire context
3822 * Implements support for legacy gamma correction table for drivers
3823 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3824 * properties. See drm_crtc_enable_color_mgmt() and the containing chapter for
3825 * how the atomic color management and gamma tables work.
3827 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3828 u16 *red, u16 *green, u16 *blue,
3830 struct drm_modeset_acquire_ctx *ctx)
3832 struct drm_device *dev = crtc->dev;
3833 struct drm_atomic_state *state;
3834 struct drm_crtc_state *crtc_state;
3835 struct drm_property_blob *blob = NULL;
3836 struct drm_color_lut *blob_data;
3840 state = drm_atomic_state_alloc(crtc->dev);
3844 blob = drm_property_create_blob(dev,
3845 sizeof(struct drm_color_lut) * size,
3848 ret = PTR_ERR(blob);
3853 /* Prepare GAMMA_LUT with the legacy values. */
3854 blob_data = blob->data;
3855 for (i = 0; i < size; i++) {
3856 blob_data[i].red = red[i];
3857 blob_data[i].green = green[i];
3858 blob_data[i].blue = blue[i];
3861 state->acquire_ctx = ctx;
3862 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3863 if (IS_ERR(crtc_state)) {
3864 ret = PTR_ERR(crtc_state);
3868 /* Reset DEGAMMA_LUT and CTM properties. */
3869 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, NULL);
3870 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
3871 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, blob);
3872 crtc_state->color_mgmt_changed |= replaced;
3874 ret = drm_atomic_commit(state);
3877 drm_atomic_state_put(state);
3878 drm_property_blob_put(blob);
3881 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);
3884 * __drm_atomic_helper_private_duplicate_state - copy atomic private state
3886 * @state: new private object state
3888 * Copies atomic state from a private objects's current state and resets inferred values.
3889 * This is useful for drivers that subclass the private state.
3891 void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
3892 struct drm_private_state *state)
3894 memcpy(state, obj->state, sizeof(*state));
3896 EXPORT_SYMBOL(__drm_atomic_helper_private_obj_duplicate_state);