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_internal.h"
40 * This helper library provides implementations of check and commit functions on
41 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
42 * also provides convenience implementations for the atomic state handling
43 * callbacks for drivers which don't need to subclass the drm core structures to
44 * add their own additional internal state.
46 * This library also provides default implementations for the check callback in
47 * drm_atomic_helper_check() and for the commit callback with
48 * drm_atomic_helper_commit(). But the individual stages and callbacks are
49 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
50 * together with a driver private modeset implementation.
52 * This library also provides implementations for all the legacy driver
53 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
54 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
55 * various functions to implement set_property callbacks. New drivers must not
56 * implement these functions themselves but must use the provided helpers.
58 * The atomic helper uses the same function table structures as all other
59 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
60 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
61 * also shares the &struct drm_plane_helper_funcs function table with the plane
65 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
66 struct drm_plane_state *old_plane_state,
67 struct drm_plane_state *plane_state,
68 struct drm_plane *plane)
70 struct drm_crtc_state *crtc_state;
72 if (old_plane_state->crtc) {
73 crtc_state = drm_atomic_get_new_crtc_state(state,
74 old_plane_state->crtc);
76 if (WARN_ON(!crtc_state))
79 crtc_state->planes_changed = true;
82 if (plane_state->crtc) {
83 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
85 if (WARN_ON(!crtc_state))
88 crtc_state->planes_changed = true;
92 static int handle_conflicting_encoders(struct drm_atomic_state *state,
93 bool disable_conflicting_encoders)
95 struct drm_connector_state *new_conn_state;
96 struct drm_connector *connector;
97 struct drm_connector_list_iter conn_iter;
98 struct drm_encoder *encoder;
99 unsigned encoder_mask = 0;
103 * First loop, find all newly assigned encoders from the connectors
104 * part of the state. If the same encoder is assigned to multiple
105 * connectors bail out.
107 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
108 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
109 struct drm_encoder *new_encoder;
111 if (!new_conn_state->crtc)
114 if (funcs->atomic_best_encoder)
115 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
116 else if (funcs->best_encoder)
117 new_encoder = funcs->best_encoder(connector);
119 new_encoder = drm_atomic_helper_best_encoder(connector);
122 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
123 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
124 new_encoder->base.id, new_encoder->name,
125 connector->base.id, connector->name);
130 encoder_mask |= 1 << drm_encoder_index(new_encoder);
138 * Second loop, iterate over all connectors not part of the state.
140 * If a conflicting encoder is found and disable_conflicting_encoders
141 * is not set, an error is returned. Userspace can provide a solution
142 * through the atomic ioctl.
144 * If the flag is set conflicting connectors are removed from the crtc
145 * and the crtc is disabled if no encoder is left. This preserves
146 * compatibility with the legacy set_config behavior.
148 drm_connector_list_iter_begin(state->dev, &conn_iter);
149 drm_for_each_connector_iter(connector, &conn_iter) {
150 struct drm_crtc_state *crtc_state;
152 if (drm_atomic_get_new_connector_state(state, connector))
155 encoder = connector->state->best_encoder;
156 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
159 if (!disable_conflicting_encoders) {
160 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
161 encoder->base.id, encoder->name,
162 connector->state->crtc->base.id,
163 connector->state->crtc->name,
164 connector->base.id, connector->name);
169 new_conn_state = drm_atomic_get_connector_state(state, connector);
170 if (IS_ERR(new_conn_state)) {
171 ret = PTR_ERR(new_conn_state);
175 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
176 encoder->base.id, encoder->name,
177 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
178 connector->base.id, connector->name);
180 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
182 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
186 if (!crtc_state->connector_mask) {
187 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
192 crtc_state->active = false;
196 drm_connector_list_iter_end(&conn_iter);
202 set_best_encoder(struct drm_atomic_state *state,
203 struct drm_connector_state *conn_state,
204 struct drm_encoder *encoder)
206 struct drm_crtc_state *crtc_state;
207 struct drm_crtc *crtc;
209 if (conn_state->best_encoder) {
210 /* Unset the encoder_mask in the old crtc state. */
211 crtc = conn_state->connector->state->crtc;
213 /* A NULL crtc is an error here because we should have
214 * duplicated a NULL best_encoder when crtc was NULL.
215 * As an exception restoring duplicated atomic state
216 * during resume is allowed, so don't warn when
217 * best_encoder is equal to encoder we intend to set.
219 WARN_ON(!crtc && encoder != conn_state->best_encoder);
221 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
223 crtc_state->encoder_mask &=
224 ~(1 << drm_encoder_index(conn_state->best_encoder));
229 crtc = conn_state->crtc;
232 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
234 crtc_state->encoder_mask |=
235 1 << drm_encoder_index(encoder);
239 conn_state->best_encoder = encoder;
243 steal_encoder(struct drm_atomic_state *state,
244 struct drm_encoder *encoder)
246 struct drm_crtc_state *crtc_state;
247 struct drm_connector *connector;
248 struct drm_connector_state *old_connector_state, *new_connector_state;
251 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
252 struct drm_crtc *encoder_crtc;
254 if (new_connector_state->best_encoder != encoder)
257 encoder_crtc = old_connector_state->crtc;
259 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
260 encoder->base.id, encoder->name,
261 encoder_crtc->base.id, encoder_crtc->name);
263 set_best_encoder(state, new_connector_state, NULL);
265 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
266 crtc_state->connectors_changed = true;
273 update_connector_routing(struct drm_atomic_state *state,
274 struct drm_connector *connector,
275 struct drm_connector_state *old_connector_state,
276 struct drm_connector_state *new_connector_state)
278 const struct drm_connector_helper_funcs *funcs;
279 struct drm_encoder *new_encoder;
280 struct drm_crtc_state *crtc_state;
282 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
286 if (old_connector_state->crtc != new_connector_state->crtc) {
287 if (old_connector_state->crtc) {
288 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
289 crtc_state->connectors_changed = true;
292 if (new_connector_state->crtc) {
293 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
294 crtc_state->connectors_changed = true;
298 if (!new_connector_state->crtc) {
299 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
303 set_best_encoder(state, new_connector_state, NULL);
308 funcs = connector->helper_private;
310 if (funcs->atomic_best_encoder)
311 new_encoder = funcs->atomic_best_encoder(connector,
312 new_connector_state);
313 else if (funcs->best_encoder)
314 new_encoder = funcs->best_encoder(connector);
316 new_encoder = drm_atomic_helper_best_encoder(connector);
319 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
325 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
326 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
327 new_encoder->base.id,
329 new_connector_state->crtc->base.id,
330 new_connector_state->crtc->name);
334 if (new_encoder == new_connector_state->best_encoder) {
335 set_best_encoder(state, new_connector_state, new_encoder);
337 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
340 new_encoder->base.id,
342 new_connector_state->crtc->base.id,
343 new_connector_state->crtc->name);
348 steal_encoder(state, new_encoder);
350 set_best_encoder(state, new_connector_state, new_encoder);
352 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
353 crtc_state->connectors_changed = true;
355 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
358 new_encoder->base.id,
360 new_connector_state->crtc->base.id,
361 new_connector_state->crtc->name);
367 mode_fixup(struct drm_atomic_state *state)
369 struct drm_crtc *crtc;
370 struct drm_crtc_state *new_crtc_state;
371 struct drm_connector *connector;
372 struct drm_connector_state *new_conn_state;
376 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
377 if (!new_crtc_state->mode_changed &&
378 !new_crtc_state->connectors_changed)
381 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
384 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
385 const struct drm_encoder_helper_funcs *funcs;
386 struct drm_encoder *encoder;
388 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
390 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
394 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
397 * Each encoder has at most one connector (since we always steal
398 * it away), so we won't call ->mode_fixup twice.
400 encoder = new_conn_state->best_encoder;
401 funcs = encoder->helper_private;
403 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
404 &new_crtc_state->adjusted_mode);
406 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
410 if (funcs && funcs->atomic_check) {
411 ret = funcs->atomic_check(encoder, new_crtc_state,
414 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
415 encoder->base.id, encoder->name);
418 } else if (funcs && funcs->mode_fixup) {
419 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
420 &new_crtc_state->adjusted_mode);
422 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
423 encoder->base.id, encoder->name);
429 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
430 const struct drm_crtc_helper_funcs *funcs;
432 if (!new_crtc_state->enable)
435 if (!new_crtc_state->mode_changed &&
436 !new_crtc_state->connectors_changed)
439 funcs = crtc->helper_private;
440 if (!funcs->mode_fixup)
443 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
444 &new_crtc_state->adjusted_mode);
446 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
447 crtc->base.id, crtc->name);
456 * drm_atomic_helper_check_modeset - validate state object for modeset changes
458 * @state: the driver state object
460 * Check the state object to see if the requested state is physically possible.
461 * This does all the crtc and connector related computations for an atomic
462 * update and adds any additional connectors needed for full modesets. It calls
463 * the various per-object callbacks in the follow order:
465 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
466 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
467 * 3. If it's determined a modeset is needed then all connectors on the affected crtc
468 * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them.
469 * 4. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
470 * 5. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
471 * This function is only called when the encoder will be part of a configured crtc,
472 * it must not be used for implementing connector property validation.
473 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
475 * 6. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints.
477 * &drm_crtc_state.mode_changed is set when the input mode is changed.
478 * &drm_crtc_state.connectors_changed is set when a connector is added or
479 * removed from the crtc. &drm_crtc_state.active_changed is set when
480 * &drm_crtc_state.active changes, which is used for DPMS.
481 * See also: drm_atomic_crtc_needs_modeset()
485 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
486 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
487 * without a full modeset) _must_ call this function afterwards after that
488 * change. It is permitted to call this function multiple times for the same
489 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
490 * upon the adjusted dotclock for fifo space allocation and watermark
494 * Zero for success or -errno
497 drm_atomic_helper_check_modeset(struct drm_device *dev,
498 struct drm_atomic_state *state)
500 struct drm_crtc *crtc;
501 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
502 struct drm_connector *connector;
503 struct drm_connector_state *old_connector_state, *new_connector_state;
505 unsigned connectors_mask = 0;
507 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
508 bool has_connectors =
509 !!new_crtc_state->connector_mask;
511 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
512 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
513 crtc->base.id, crtc->name);
514 new_crtc_state->mode_changed = true;
517 if (old_crtc_state->enable != new_crtc_state->enable) {
518 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
519 crtc->base.id, crtc->name);
522 * For clarity this assignment is done here, but
523 * enable == 0 is only true when there are no
524 * connectors and a NULL mode.
526 * The other way around is true as well. enable != 0
527 * iff connectors are attached and a mode is set.
529 new_crtc_state->mode_changed = true;
530 new_crtc_state->connectors_changed = true;
533 if (old_crtc_state->active != new_crtc_state->active) {
534 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
535 crtc->base.id, crtc->name);
536 new_crtc_state->active_changed = true;
539 if (new_crtc_state->enable != has_connectors) {
540 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
541 crtc->base.id, crtc->name);
547 ret = handle_conflicting_encoders(state, false);
551 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
552 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
555 * This only sets crtc->connectors_changed for routing changes,
556 * drivers must set crtc->connectors_changed themselves when
557 * connector properties need to be updated.
559 ret = update_connector_routing(state, connector,
561 new_connector_state);
564 if (old_connector_state->crtc) {
565 new_crtc_state = drm_atomic_get_new_crtc_state(state,
566 old_connector_state->crtc);
567 if (old_connector_state->link_status !=
568 new_connector_state->link_status)
569 new_crtc_state->connectors_changed = true;
572 if (funcs->atomic_check)
573 ret = funcs->atomic_check(connector, new_connector_state);
577 connectors_mask += BIT(i);
581 * After all the routing has been prepared we need to add in any
582 * connector which is itself unchanged, but who's crtc changes it's
583 * configuration. This must be done before calling mode_fixup in case a
584 * crtc only changed its mode but has the same set of connectors.
586 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
587 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
590 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
591 crtc->base.id, crtc->name,
592 new_crtc_state->enable ? 'y' : 'n',
593 new_crtc_state->active ? 'y' : 'n');
595 ret = drm_atomic_add_affected_connectors(state, crtc);
599 ret = drm_atomic_add_affected_planes(state, crtc);
605 * Iterate over all connectors again, to make sure atomic_check()
606 * has been called on them when a modeset is forced.
608 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
609 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
611 if (connectors_mask & BIT(i))
614 if (funcs->atomic_check)
615 ret = funcs->atomic_check(connector, new_connector_state);
620 return mode_fixup(state);
622 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
625 * drm_atomic_helper_check_planes - validate state object for planes changes
627 * @state: the driver state object
629 * Check the state object to see if the requested state is physically possible.
630 * This does all the plane update related checks using by calling into the
631 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
632 * hooks provided by the driver.
634 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
638 * Zero for success or -errno
641 drm_atomic_helper_check_planes(struct drm_device *dev,
642 struct drm_atomic_state *state)
644 struct drm_crtc *crtc;
645 struct drm_crtc_state *new_crtc_state;
646 struct drm_plane *plane;
647 struct drm_plane_state *new_plane_state, *old_plane_state;
650 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
651 const struct drm_plane_helper_funcs *funcs;
653 funcs = plane->helper_private;
655 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
657 if (!funcs || !funcs->atomic_check)
660 ret = funcs->atomic_check(plane, new_plane_state);
662 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
663 plane->base.id, plane->name);
668 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
669 const struct drm_crtc_helper_funcs *funcs;
671 funcs = crtc->helper_private;
673 if (!funcs || !funcs->atomic_check)
676 ret = funcs->atomic_check(crtc, new_crtc_state);
678 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
679 crtc->base.id, crtc->name);
686 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
689 * drm_atomic_helper_check - validate state object
691 * @state: the driver state object
693 * Check the state object to see if the requested state is physically possible.
694 * Only crtcs and planes have check callbacks, so for any additional (global)
695 * checking that a driver needs it can simply wrap that around this function.
696 * Drivers without such needs can directly use this as their
697 * &drm_mode_config_funcs.atomic_check callback.
699 * This just wraps the two parts of the state checking for planes and modeset
700 * state in the default order: First it calls drm_atomic_helper_check_modeset()
701 * and then drm_atomic_helper_check_planes(). The assumption is that the
702 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
703 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
707 * Zero for success or -errno
709 int drm_atomic_helper_check(struct drm_device *dev,
710 struct drm_atomic_state *state)
714 ret = drm_atomic_helper_check_modeset(dev, state);
718 ret = drm_atomic_helper_check_planes(dev, state);
724 EXPORT_SYMBOL(drm_atomic_helper_check);
727 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
729 struct drm_connector *connector;
730 struct drm_connector_state *old_conn_state, *new_conn_state;
731 struct drm_crtc *crtc;
732 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
735 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
736 const struct drm_encoder_helper_funcs *funcs;
737 struct drm_encoder *encoder;
739 /* Shut down everything that's in the changeset and currently
740 * still on. So need to check the old, saved state. */
741 if (!old_conn_state->crtc)
744 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
746 if (!old_crtc_state->active ||
747 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
750 encoder = old_conn_state->best_encoder;
752 /* We shouldn't get this far if we didn't previously have
753 * an encoder.. but WARN_ON() rather than explode.
755 if (WARN_ON(!encoder))
758 funcs = encoder->helper_private;
760 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
761 encoder->base.id, encoder->name);
764 * Each encoder has at most one connector (since we always steal
765 * it away), so we won't call disable hooks twice.
767 drm_bridge_disable(encoder->bridge);
769 /* Right function depends upon target state. */
771 if (new_conn_state->crtc && funcs->prepare)
772 funcs->prepare(encoder);
773 else if (funcs->disable)
774 funcs->disable(encoder);
775 else if (funcs->dpms)
776 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
779 drm_bridge_post_disable(encoder->bridge);
782 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
783 const struct drm_crtc_helper_funcs *funcs;
785 /* Shut down everything that needs a full modeset. */
786 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
789 if (!old_crtc_state->active)
792 funcs = crtc->helper_private;
794 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
795 crtc->base.id, crtc->name);
798 /* Right function depends upon target state. */
799 if (new_crtc_state->enable && funcs->prepare)
800 funcs->prepare(crtc);
801 else if (funcs->atomic_disable)
802 funcs->atomic_disable(crtc, old_crtc_state);
803 else if (funcs->disable)
804 funcs->disable(crtc);
806 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
811 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
813 * @old_state: atomic state object with old state structures
815 * This function updates all the various legacy modeset state pointers in
816 * connectors, encoders and crtcs. It also updates the timestamping constants
817 * used for precise vblank timestamps by calling
818 * drm_calc_timestamping_constants().
820 * Drivers can use this for building their own atomic commit if they don't have
821 * a pure helper-based modeset implementation.
824 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
825 struct drm_atomic_state *old_state)
827 struct drm_connector *connector;
828 struct drm_connector_state *old_conn_state, *new_conn_state;
829 struct drm_crtc *crtc;
830 struct drm_crtc_state *new_crtc_state;
833 /* clear out existing links and update dpms */
834 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
835 if (connector->encoder) {
836 WARN_ON(!connector->encoder->crtc);
838 connector->encoder->crtc = NULL;
839 connector->encoder = NULL;
842 crtc = new_conn_state->crtc;
843 if ((!crtc && old_conn_state->crtc) ||
844 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
845 struct drm_property *dpms_prop =
846 dev->mode_config.dpms_property;
847 int mode = DRM_MODE_DPMS_OFF;
849 if (crtc && crtc->state->active)
850 mode = DRM_MODE_DPMS_ON;
852 connector->dpms = mode;
853 drm_object_property_set_value(&connector->base,
859 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
860 if (!new_conn_state->crtc)
863 if (WARN_ON(!new_conn_state->best_encoder))
866 connector->encoder = new_conn_state->best_encoder;
867 connector->encoder->crtc = new_conn_state->crtc;
870 /* set legacy state in the crtc structure */
871 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
872 struct drm_plane *primary = crtc->primary;
873 struct drm_plane_state *new_plane_state;
875 crtc->mode = new_crtc_state->mode;
876 crtc->enabled = new_crtc_state->enable;
879 drm_atomic_get_new_plane_state(old_state, primary);
881 if (new_plane_state && new_plane_state->crtc == crtc) {
882 crtc->x = new_plane_state->src_x >> 16;
883 crtc->y = new_plane_state->src_y >> 16;
886 if (new_crtc_state->enable)
887 drm_calc_timestamping_constants(crtc,
888 &new_crtc_state->adjusted_mode);
891 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
894 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
896 struct drm_crtc *crtc;
897 struct drm_crtc_state *new_crtc_state;
898 struct drm_connector *connector;
899 struct drm_connector_state *new_conn_state;
902 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
903 const struct drm_crtc_helper_funcs *funcs;
905 if (!new_crtc_state->mode_changed)
908 funcs = crtc->helper_private;
910 if (new_crtc_state->enable && funcs->mode_set_nofb) {
911 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
912 crtc->base.id, crtc->name);
914 funcs->mode_set_nofb(crtc);
918 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
919 const struct drm_encoder_helper_funcs *funcs;
920 struct drm_encoder *encoder;
921 struct drm_display_mode *mode, *adjusted_mode;
923 if (!new_conn_state->best_encoder)
926 encoder = new_conn_state->best_encoder;
927 funcs = encoder->helper_private;
928 new_crtc_state = new_conn_state->crtc->state;
929 mode = &new_crtc_state->mode;
930 adjusted_mode = &new_crtc_state->adjusted_mode;
932 if (!new_crtc_state->mode_changed)
935 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
936 encoder->base.id, encoder->name);
939 * Each encoder has at most one connector (since we always steal
940 * it away), so we won't call mode_set hooks twice.
942 if (funcs && funcs->atomic_mode_set) {
943 funcs->atomic_mode_set(encoder, new_crtc_state,
945 } else if (funcs && funcs->mode_set) {
946 funcs->mode_set(encoder, mode, adjusted_mode);
949 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
954 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
956 * @old_state: atomic state object with old state structures
958 * This function shuts down all the outputs that need to be shut down and
959 * prepares them (if required) with the new mode.
961 * For compatibility with legacy crtc helpers this should be called before
962 * drm_atomic_helper_commit_planes(), which is what the default commit function
963 * does. But drivers with different needs can group the modeset commits together
964 * and do the plane commits at the end. This is useful for drivers doing runtime
965 * PM since planes updates then only happen when the CRTC is actually enabled.
967 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
968 struct drm_atomic_state *old_state)
970 disable_outputs(dev, old_state);
972 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
974 crtc_set_mode(dev, old_state);
976 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
979 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
981 * @old_state: atomic state object with old state structures
983 * This function enables all the outputs with the new configuration which had to
984 * be turned off for the update.
986 * For compatibility with legacy crtc helpers this should be called after
987 * drm_atomic_helper_commit_planes(), which is what the default commit function
988 * does. But drivers with different needs can group the modeset commits together
989 * and do the plane commits at the end. This is useful for drivers doing runtime
990 * PM since planes updates then only happen when the CRTC is actually enabled.
992 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
993 struct drm_atomic_state *old_state)
995 struct drm_crtc *crtc;
996 struct drm_crtc_state *new_crtc_state;
997 struct drm_connector *connector;
998 struct drm_connector_state *new_conn_state;
1001 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1002 const struct drm_crtc_helper_funcs *funcs;
1004 /* Need to filter out CRTCs where only planes change. */
1005 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1008 if (!new_crtc_state->active)
1011 funcs = crtc->helper_private;
1013 if (new_crtc_state->enable) {
1014 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1015 crtc->base.id, crtc->name);
1018 funcs->enable(crtc);
1020 funcs->commit(crtc);
1024 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1025 const struct drm_encoder_helper_funcs *funcs;
1026 struct drm_encoder *encoder;
1028 if (!new_conn_state->best_encoder)
1031 if (!new_conn_state->crtc->state->active ||
1032 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1035 encoder = new_conn_state->best_encoder;
1036 funcs = encoder->helper_private;
1038 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1039 encoder->base.id, encoder->name);
1042 * Each encoder has at most one connector (since we always steal
1043 * it away), so we won't call enable hooks twice.
1045 drm_bridge_pre_enable(encoder->bridge);
1049 funcs->enable(encoder);
1050 else if (funcs->commit)
1051 funcs->commit(encoder);
1054 drm_bridge_enable(encoder->bridge);
1057 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1060 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1062 * @state: atomic state object with old state structures
1063 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1064 * Otherwise @state is the old state.
1066 * For implicit sync, driver should fish the exclusive fence out from the
1067 * incoming fb's and stash it in the drm_plane_state. This is called after
1068 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1069 * just uses the atomic state to find the changed planes)
1071 * Note that @pre_swap is needed since the point where we block for fences moves
1072 * around depending upon whether an atomic commit is blocking or
1073 * non-blocking. For async commit all waiting needs to happen after
1074 * drm_atomic_helper_swap_state() is called, but for synchronous commits we want
1075 * to wait **before** we do anything that can't be easily rolled back. That is
1076 * before we call drm_atomic_helper_swap_state().
1078 * Returns zero if success or < 0 if dma_fence_wait() fails.
1080 int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1081 struct drm_atomic_state *state,
1084 struct drm_plane *plane;
1085 struct drm_plane_state *new_plane_state;
1088 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1089 if (!new_plane_state->fence)
1092 WARN_ON(!new_plane_state->fb);
1095 * If waiting for fences pre-swap (ie: nonblock), userspace can
1096 * still interrupt the operation. Instead of blocking until the
1097 * timer expires, make the wait interruptible.
1099 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1103 dma_fence_put(new_plane_state->fence);
1104 new_plane_state->fence = NULL;
1109 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1112 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1114 * @old_state: atomic state object with old state structures
1116 * Helper to, after atomic commit, wait for vblanks on all effected
1117 * crtcs (ie. before cleaning up old framebuffers using
1118 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1119 * framebuffers have actually changed to optimize for the legacy cursor and
1120 * plane update use-case.
1123 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1124 struct drm_atomic_state *old_state)
1126 struct drm_crtc *crtc;
1127 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1129 unsigned crtc_mask = 0;
1132 * Legacy cursor ioctls are completely unsynced, and userspace
1133 * relies on that (by doing tons of cursor updates).
1135 if (old_state->legacy_cursor_update)
1138 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1139 if (!new_crtc_state->active || !new_crtc_state->planes_changed)
1142 ret = drm_crtc_vblank_get(crtc);
1146 crtc_mask |= drm_crtc_mask(crtc);
1147 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1150 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1151 if (!(crtc_mask & drm_crtc_mask(crtc)))
1154 ret = wait_event_timeout(dev->vblank[i].queue,
1155 old_state->crtcs[i].last_vblank_count !=
1156 drm_crtc_vblank_count(crtc),
1157 msecs_to_jiffies(50));
1159 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1160 crtc->base.id, crtc->name);
1162 drm_crtc_vblank_put(crtc);
1165 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1168 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1169 * @old_state: atomic state object with old state structures
1171 * This is the default implementation for the
1172 * &drm_mode_config_helper_funcs.atomic_commit_tail hook.
1174 * Note that the default ordering of how the various stages are called is to
1175 * match the legacy modeset helper library closest. One peculiarity of that is
1176 * that it doesn't mesh well with runtime PM at all.
1178 * For drivers supporting runtime PM the recommended sequence is instead ::
1180 * drm_atomic_helper_commit_modeset_disables(dev, old_state);
1182 * drm_atomic_helper_commit_modeset_enables(dev, old_state);
1184 * drm_atomic_helper_commit_planes(dev, old_state,
1185 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
1187 * for committing the atomic update to hardware. See the kerneldoc entries for
1188 * these three functions for more details.
1190 void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1192 struct drm_device *dev = old_state->dev;
1194 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1196 drm_atomic_helper_commit_planes(dev, old_state, 0);
1198 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1200 drm_atomic_helper_commit_hw_done(old_state);
1202 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1204 drm_atomic_helper_cleanup_planes(dev, old_state);
1206 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1208 static void commit_tail(struct drm_atomic_state *old_state)
1210 struct drm_device *dev = old_state->dev;
1211 const struct drm_mode_config_helper_funcs *funcs;
1213 funcs = dev->mode_config.helper_private;
1215 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1217 drm_atomic_helper_wait_for_dependencies(old_state);
1219 if (funcs && funcs->atomic_commit_tail)
1220 funcs->atomic_commit_tail(old_state);
1222 drm_atomic_helper_commit_tail(old_state);
1224 drm_atomic_helper_commit_cleanup_done(old_state);
1226 drm_atomic_state_put(old_state);
1229 static void commit_work(struct work_struct *work)
1231 struct drm_atomic_state *state = container_of(work,
1232 struct drm_atomic_state,
1238 * drm_atomic_helper_commit - commit validated state object
1240 * @state: the driver state object
1241 * @nonblock: whether nonblocking behavior is requested.
1243 * This function commits a with drm_atomic_helper_check() pre-validated state
1244 * object. This can still fail when e.g. the framebuffer reservation fails. This
1245 * function implements nonblocking commits, using
1246 * drm_atomic_helper_setup_commit() and related functions.
1248 * Committing the actual hardware state is done through the
1249 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default
1250 * implementation drm_atomic_helper_commit_tail().
1253 * Zero for success or -errno.
1255 int drm_atomic_helper_commit(struct drm_device *dev,
1256 struct drm_atomic_state *state,
1261 ret = drm_atomic_helper_setup_commit(state, nonblock);
1265 INIT_WORK(&state->commit_work, commit_work);
1267 ret = drm_atomic_helper_prepare_planes(dev, state);
1272 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1274 drm_atomic_helper_cleanup_planes(dev, state);
1280 * This is the point of no return - everything below never fails except
1281 * when the hw goes bonghits. Which means we can commit the new state on
1282 * the software side now.
1285 drm_atomic_helper_swap_state(state, true);
1288 * Everything below can be run asynchronously without the need to grab
1289 * any modeset locks at all under one condition: It must be guaranteed
1290 * that the asynchronous work has either been cancelled (if the driver
1291 * supports it, which at least requires that the framebuffers get
1292 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1293 * before the new state gets committed on the software side with
1294 * drm_atomic_helper_swap_state().
1296 * This scheme allows new atomic state updates to be prepared and
1297 * checked in parallel to the asynchronous completion of the previous
1298 * update. Which is important since compositors need to figure out the
1299 * composition of the next frame right after having submitted the
1302 * NOTE: Commit work has multiple phases, first hardware commit, then
1303 * cleanup. We want them to overlap, hence need system_unbound_wq to
1304 * make sure work items don't artifically stall on each another.
1307 drm_atomic_state_get(state);
1309 queue_work(system_unbound_wq, &state->commit_work);
1315 EXPORT_SYMBOL(drm_atomic_helper_commit);
1318 * DOC: implementing nonblocking commit
1320 * Nonblocking atomic commits have to be implemented in the following sequence:
1322 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1323 * which commit needs to call which can fail, so we want to run it first and
1326 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1327 * might be affected the new state update. This can be done by either cancelling
1328 * or flushing the work items, depending upon whether the driver can deal with
1329 * cancelled updates. Note that it is important to ensure that the framebuffer
1330 * cleanup is still done when cancelling.
1332 * Asynchronous workers need to have sufficient parallelism to be able to run
1333 * different atomic commits on different CRTCs in parallel. The simplest way to
1334 * achive this is by running them on the &system_unbound_wq work queue. Note
1335 * that drivers are not required to split up atomic commits and run an
1336 * individual commit in parallel - userspace is supposed to do that if it cares.
1337 * But it might be beneficial to do that for modesets, since those necessarily
1338 * must be done as one global operation, and enabling or disabling a CRTC can
1339 * take a long time. But even that is not required.
1341 * 3. The software state is updated synchronously with
1342 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1343 * locks means concurrent callers never see inconsistent state. And doing this
1344 * while it's guaranteed that no relevant nonblocking worker runs means that
1345 * nonblocking workers do not need grab any locks. Actually they must not grab
1346 * locks, for otherwise the work flushing will deadlock.
1348 * 4. Schedule a work item to do all subsequent steps, using the split-out
1349 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1350 * then cleaning up the framebuffers after the old framebuffer is no longer
1353 * The above scheme is implemented in the atomic helper libraries in
1354 * drm_atomic_helper_commit() using a bunch of helper functions. See
1355 * drm_atomic_helper_setup_commit() for a starting point.
1358 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1360 struct drm_crtc_commit *commit, *stall_commit = NULL;
1361 bool completed = true;
1365 spin_lock(&crtc->commit_lock);
1367 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1369 completed = try_wait_for_completion(&commit->flip_done);
1370 /* Userspace is not allowed to get ahead of the previous
1371 * commit with nonblocking ones. */
1372 if (!completed && nonblock) {
1373 spin_unlock(&crtc->commit_lock);
1376 } else if (i == 1) {
1377 stall_commit = commit;
1378 drm_crtc_commit_get(stall_commit);
1384 spin_unlock(&crtc->commit_lock);
1389 /* We don't want to let commits get ahead of cleanup work too much,
1390 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1392 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1395 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1396 crtc->base.id, crtc->name);
1398 drm_crtc_commit_put(stall_commit);
1400 return ret < 0 ? ret : 0;
1403 static void release_crtc_commit(struct completion *completion)
1405 struct drm_crtc_commit *commit = container_of(completion,
1409 drm_crtc_commit_put(commit);
1413 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1414 * @state: new modeset state to be committed
1415 * @nonblock: whether nonblocking behavior is requested.
1417 * This function prepares @state to be used by the atomic helper's support for
1418 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1419 * should always call this function from their
1420 * &drm_mode_config_funcs.atomic_commit hook.
1422 * To be able to use this support drivers need to use a few more helper
1423 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1424 * actually committing the hardware state, and for nonblocking commits this call
1425 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1426 * and it's stall parameter, for when a driver's commit hooks look at the
1427 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1429 * Completion of the hardware commit step must be signalled using
1430 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1431 * to read or change any permanent software or hardware modeset state. The only
1432 * exception is state protected by other means than &drm_modeset_lock locks.
1433 * Only the free standing @state with pointers to the old state structures can
1434 * be inspected, e.g. to clean up old buffers using
1435 * drm_atomic_helper_cleanup_planes().
1437 * At the very end, before cleaning up @state drivers must call
1438 * drm_atomic_helper_commit_cleanup_done().
1440 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1441 * complete and esay-to-use default implementation of the atomic_commit() hook.
1443 * The tracking of asynchronously executed and still pending commits is done
1444 * using the core structure &drm_crtc_commit.
1446 * By default there's no need to clean up resources allocated by this function
1447 * explicitly: drm_atomic_state_default_clear() will take care of that
1452 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1453 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1455 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1458 struct drm_crtc *crtc;
1459 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1460 struct drm_crtc_commit *commit;
1463 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1464 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1468 init_completion(&commit->flip_done);
1469 init_completion(&commit->hw_done);
1470 init_completion(&commit->cleanup_done);
1471 INIT_LIST_HEAD(&commit->commit_entry);
1472 kref_init(&commit->ref);
1473 commit->crtc = crtc;
1475 state->crtcs[i].commit = commit;
1477 ret = stall_checks(crtc, nonblock);
1481 /* Drivers only send out events when at least either current or
1482 * new CRTC state is active. Complete right away if everything
1484 if (!old_crtc_state->active && !new_crtc_state->active) {
1485 complete_all(&commit->flip_done);
1489 /* Legacy cursor updates are fully unsynced. */
1490 if (state->legacy_cursor_update) {
1491 complete_all(&commit->flip_done);
1495 if (!new_crtc_state->event) {
1496 commit->event = kzalloc(sizeof(*commit->event),
1501 new_crtc_state->event = commit->event;
1504 new_crtc_state->event->base.completion = &commit->flip_done;
1505 new_crtc_state->event->base.completion_release = release_crtc_commit;
1506 drm_crtc_commit_get(commit);
1511 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1514 static struct drm_crtc_commit *preceeding_commit(struct drm_crtc *crtc)
1516 struct drm_crtc_commit *commit;
1519 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1520 /* skip the first entry, that's the current commit */
1530 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1531 * @old_state: atomic state object with old state structures
1533 * This function waits for all preceeding commits that touch the same CRTC as
1534 * @old_state to both be committed to the hardware (as signalled by
1535 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1536 * by calling drm_crtc_vblank_send_event() on the &drm_crtc_state.event).
1538 * This is part of the atomic helper support for nonblocking commits, see
1539 * drm_atomic_helper_setup_commit() for an overview.
1541 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
1543 struct drm_crtc *crtc;
1544 struct drm_crtc_state *new_crtc_state;
1545 struct drm_crtc_commit *commit;
1549 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1550 spin_lock(&crtc->commit_lock);
1551 commit = preceeding_commit(crtc);
1553 drm_crtc_commit_get(commit);
1554 spin_unlock(&crtc->commit_lock);
1559 ret = wait_for_completion_timeout(&commit->hw_done,
1562 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1563 crtc->base.id, crtc->name);
1565 /* Currently no support for overwriting flips, hence
1566 * stall for previous one to execute completely. */
1567 ret = wait_for_completion_timeout(&commit->flip_done,
1570 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1571 crtc->base.id, crtc->name);
1573 drm_crtc_commit_put(commit);
1576 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
1579 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1580 * @old_state: atomic state object with old state structures
1582 * This function is used to signal completion of the hardware commit step. After
1583 * this step the driver is not allowed to read or change any permanent software
1584 * or hardware modeset state. The only exception is state protected by other
1585 * means than &drm_modeset_lock locks.
1587 * Drivers should try to postpone any expensive or delayed cleanup work after
1588 * this function is called.
1590 * This is part of the atomic helper support for nonblocking commits, see
1591 * drm_atomic_helper_setup_commit() for an overview.
1593 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
1595 struct drm_crtc *crtc;
1596 struct drm_crtc_state *new_crtc_state;
1597 struct drm_crtc_commit *commit;
1600 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1601 commit = old_state->crtcs[i].commit;
1605 /* backend must have consumed any event by now */
1606 WARN_ON(new_crtc_state->event);
1607 spin_lock(&crtc->commit_lock);
1608 complete_all(&commit->hw_done);
1609 spin_unlock(&crtc->commit_lock);
1612 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
1615 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1616 * @old_state: atomic state object with old state structures
1618 * This signals completion of the atomic update @old_state, including any
1619 * cleanup work. If used, it must be called right before calling
1620 * drm_atomic_state_put().
1622 * This is part of the atomic helper support for nonblocking commits, see
1623 * drm_atomic_helper_setup_commit() for an overview.
1625 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
1627 struct drm_crtc *crtc;
1628 struct drm_crtc_state *new_crtc_state;
1629 struct drm_crtc_commit *commit;
1633 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1634 commit = old_state->crtcs[i].commit;
1635 if (WARN_ON(!commit))
1638 spin_lock(&crtc->commit_lock);
1639 complete_all(&commit->cleanup_done);
1640 WARN_ON(!try_wait_for_completion(&commit->hw_done));
1642 /* commit_list borrows our reference, need to remove before we
1643 * clean up our drm_atomic_state. But only after it actually
1644 * completed, otherwise subsequent commits won't stall properly. */
1645 if (try_wait_for_completion(&commit->flip_done))
1648 spin_unlock(&crtc->commit_lock);
1650 /* We must wait for the vblank event to signal our completion
1651 * before releasing our reference, since the vblank work does
1652 * not hold a reference of its own. */
1653 ret = wait_for_completion_timeout(&commit->flip_done,
1656 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1657 crtc->base.id, crtc->name);
1659 spin_lock(&crtc->commit_lock);
1661 list_del(&commit->commit_entry);
1662 spin_unlock(&crtc->commit_lock);
1665 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
1668 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1670 * @state: atomic state object with new state structures
1672 * This function prepares plane state, specifically framebuffers, for the new
1673 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
1674 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
1675 * any already successfully prepared framebuffer.
1678 * 0 on success, negative error code on failure.
1680 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1681 struct drm_atomic_state *state)
1683 struct drm_plane *plane;
1684 struct drm_plane_state *new_plane_state;
1687 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1688 const struct drm_plane_helper_funcs *funcs;
1690 funcs = plane->helper_private;
1692 if (funcs->prepare_fb) {
1693 ret = funcs->prepare_fb(plane, new_plane_state);
1702 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
1703 const struct drm_plane_helper_funcs *funcs;
1708 funcs = plane->helper_private;
1710 if (funcs->cleanup_fb)
1711 funcs->cleanup_fb(plane, new_plane_state);
1716 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1718 static bool plane_crtc_active(const struct drm_plane_state *state)
1720 return state->crtc && state->crtc->state->active;
1724 * drm_atomic_helper_commit_planes - commit plane state
1726 * @old_state: atomic state object with old state structures
1727 * @flags: flags for committing plane state
1729 * This function commits the new plane state using the plane and atomic helper
1730 * functions for planes and crtcs. It assumes that the atomic state has already
1731 * been pushed into the relevant object state pointers, since this step can no
1734 * It still requires the global state object @old_state to know which planes and
1735 * crtcs need to be updated though.
1737 * Note that this function does all plane updates across all CRTCs in one step.
1738 * If the hardware can't support this approach look at
1739 * drm_atomic_helper_commit_planes_on_crtc() instead.
1741 * Plane parameters can be updated by applications while the associated CRTC is
1742 * disabled. The DRM/KMS core will store the parameters in the plane state,
1743 * which will be available to the driver when the CRTC is turned on. As a result
1744 * most drivers don't need to be immediately notified of plane updates for a
1747 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
1748 * @flags in order not to receive plane update notifications related to a
1749 * disabled CRTC. This avoids the need to manually ignore plane updates in
1750 * driver code when the driver and/or hardware can't or just don't need to deal
1751 * with updates on disabled CRTCs, for example when supporting runtime PM.
1753 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
1754 * display controllers require to disable a CRTC's planes when the CRTC is
1755 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
1756 * call for a plane if the CRTC of the old plane state needs a modesetting
1757 * operation. Of course, the drivers need to disable the planes in their CRTC
1758 * disable callbacks since no one else would do that.
1760 * The drm_atomic_helper_commit() default implementation doesn't set the
1761 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
1762 * This should not be copied blindly by drivers.
1764 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1765 struct drm_atomic_state *old_state,
1768 struct drm_crtc *crtc;
1769 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1770 struct drm_plane *plane;
1771 struct drm_plane_state *old_plane_state, *new_plane_state;
1773 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
1774 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
1776 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1777 const struct drm_crtc_helper_funcs *funcs;
1779 funcs = crtc->helper_private;
1781 if (!funcs || !funcs->atomic_begin)
1784 if (active_only && !new_crtc_state->active)
1787 funcs->atomic_begin(crtc, old_crtc_state);
1790 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
1791 const struct drm_plane_helper_funcs *funcs;
1794 funcs = plane->helper_private;
1799 disabling = drm_atomic_plane_disabling(old_plane_state,
1804 * Skip planes related to inactive CRTCs. If the plane
1805 * is enabled use the state of the current CRTC. If the
1806 * plane is being disabled use the state of the old
1807 * CRTC to avoid skipping planes being disabled on an
1810 if (!disabling && !plane_crtc_active(new_plane_state))
1812 if (disabling && !plane_crtc_active(old_plane_state))
1817 * Special-case disabling the plane if drivers support it.
1819 if (disabling && funcs->atomic_disable) {
1820 struct drm_crtc_state *crtc_state;
1822 crtc_state = old_plane_state->crtc->state;
1824 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
1828 funcs->atomic_disable(plane, old_plane_state);
1829 } else if (new_plane_state->crtc || disabling) {
1830 funcs->atomic_update(plane, old_plane_state);
1834 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1835 const struct drm_crtc_helper_funcs *funcs;
1837 funcs = crtc->helper_private;
1839 if (!funcs || !funcs->atomic_flush)
1842 if (active_only && !new_crtc_state->active)
1845 funcs->atomic_flush(crtc, old_crtc_state);
1848 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1851 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1852 * @old_crtc_state: atomic state object with the old crtc state
1854 * This function commits the new plane state using the plane and atomic helper
1855 * functions for planes on the specific crtc. It assumes that the atomic state
1856 * has already been pushed into the relevant object state pointers, since this
1857 * step can no longer fail.
1859 * This function is useful when plane updates should be done crtc-by-crtc
1860 * instead of one global step like drm_atomic_helper_commit_planes() does.
1862 * This function can only be savely used when planes are not allowed to move
1863 * between different CRTCs because this function doesn't handle inter-CRTC
1864 * depencies. Callers need to ensure that either no such depencies exist,
1865 * resolve them through ordering of commit calls or through some other means.
1868 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1870 const struct drm_crtc_helper_funcs *crtc_funcs;
1871 struct drm_crtc *crtc = old_crtc_state->crtc;
1872 struct drm_atomic_state *old_state = old_crtc_state->state;
1873 struct drm_plane *plane;
1874 unsigned plane_mask;
1876 plane_mask = old_crtc_state->plane_mask;
1877 plane_mask |= crtc->state->plane_mask;
1879 crtc_funcs = crtc->helper_private;
1880 if (crtc_funcs && crtc_funcs->atomic_begin)
1881 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1883 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1884 struct drm_plane_state *old_plane_state =
1885 drm_atomic_get_old_plane_state(old_state, plane);
1886 const struct drm_plane_helper_funcs *plane_funcs;
1888 plane_funcs = plane->helper_private;
1890 if (!old_plane_state || !plane_funcs)
1893 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1895 if (drm_atomic_plane_disabling(old_plane_state, plane->state) &&
1896 plane_funcs->atomic_disable)
1897 plane_funcs->atomic_disable(plane, old_plane_state);
1898 else if (plane->state->crtc ||
1899 drm_atomic_plane_disabling(old_plane_state, plane->state))
1900 plane_funcs->atomic_update(plane, old_plane_state);
1903 if (crtc_funcs && crtc_funcs->atomic_flush)
1904 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1906 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1909 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1910 * @old_crtc_state: atomic state object with the old CRTC state
1911 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1913 * Disables all planes associated with the given CRTC. This can be
1914 * used for instance in the CRTC helper atomic_disable callback to disable
1917 * If the atomic-parameter is set the function calls the CRTC's
1918 * atomic_begin hook before and atomic_flush hook after disabling the
1921 * It is a bug to call this function without having implemented the
1922 * &drm_plane_helper_funcs.atomic_disable plane hook.
1925 drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
1928 struct drm_crtc *crtc = old_crtc_state->crtc;
1929 const struct drm_crtc_helper_funcs *crtc_funcs =
1930 crtc->helper_private;
1931 struct drm_plane *plane;
1933 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1934 crtc_funcs->atomic_begin(crtc, NULL);
1936 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
1937 const struct drm_plane_helper_funcs *plane_funcs =
1938 plane->helper_private;
1943 WARN_ON(!plane_funcs->atomic_disable);
1944 if (plane_funcs->atomic_disable)
1945 plane_funcs->atomic_disable(plane, NULL);
1948 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1949 crtc_funcs->atomic_flush(crtc, NULL);
1951 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1954 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1956 * @old_state: atomic state object with old state structures
1958 * This function cleans up plane state, specifically framebuffers, from the old
1959 * configuration. Hence the old configuration must be perserved in @old_state to
1960 * be able to call this function.
1962 * This function must also be called on the new state when the atomic update
1963 * fails at any point after calling drm_atomic_helper_prepare_planes().
1965 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1966 struct drm_atomic_state *old_state)
1968 struct drm_plane *plane;
1969 struct drm_plane_state *old_plane_state, *new_plane_state;
1972 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
1973 const struct drm_plane_helper_funcs *funcs;
1974 struct drm_plane_state *plane_state;
1977 * This might be called before swapping when commit is aborted,
1978 * in which case we have to cleanup the new state.
1980 if (old_plane_state == plane->state)
1981 plane_state = new_plane_state;
1983 plane_state = old_plane_state;
1985 funcs = plane->helper_private;
1987 if (funcs->cleanup_fb)
1988 funcs->cleanup_fb(plane, plane_state);
1991 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1994 * drm_atomic_helper_swap_state - store atomic state into current sw state
1995 * @state: atomic state
1996 * @stall: stall for proceeding commits
1998 * This function stores the atomic state into the current state pointers in all
1999 * driver objects. It should be called after all failing steps have been done
2000 * and succeeded, but before the actual hardware state is committed.
2002 * For cleanup and error recovery the current state for all changed objects will
2003 * be swaped into @state.
2005 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2007 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2009 * 2. Do any other steps that might fail.
2011 * 3. Put the staged state into the current state pointers with this function.
2013 * 4. Actually commit the hardware state.
2015 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2016 * contains the old state. Also do any other cleanup required with that state.
2018 * @stall must be set when nonblocking commits for this driver directly access
2019 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2020 * the current atomic helpers this is almost always the case, since the helpers
2021 * don't pass the right state structures to the callbacks.
2023 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2028 struct drm_connector *connector;
2029 struct drm_connector_state *old_conn_state, *new_conn_state;
2030 struct drm_crtc *crtc;
2031 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2032 struct drm_plane *plane;
2033 struct drm_plane_state *old_plane_state, *new_plane_state;
2034 struct drm_crtc_commit *commit;
2037 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2038 spin_lock(&crtc->commit_lock);
2039 commit = list_first_entry_or_null(&crtc->commit_list,
2040 struct drm_crtc_commit, commit_entry);
2042 drm_crtc_commit_get(commit);
2043 spin_unlock(&crtc->commit_lock);
2048 ret = wait_for_completion_timeout(&commit->hw_done,
2051 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
2052 crtc->base.id, crtc->name);
2053 drm_crtc_commit_put(commit);
2057 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2058 WARN_ON(connector->state != old_conn_state);
2060 old_conn_state->state = state;
2061 new_conn_state->state = NULL;
2063 state->connectors[i].state = old_conn_state;
2064 connector->state = new_conn_state;
2067 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2068 WARN_ON(crtc->state != old_crtc_state);
2070 old_crtc_state->state = state;
2071 new_crtc_state->state = NULL;
2073 state->crtcs[i].state = old_crtc_state;
2074 crtc->state = new_crtc_state;
2076 if (state->crtcs[i].commit) {
2077 spin_lock(&crtc->commit_lock);
2078 list_add(&state->crtcs[i].commit->commit_entry,
2079 &crtc->commit_list);
2080 spin_unlock(&crtc->commit_lock);
2082 state->crtcs[i].commit->event = NULL;
2086 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2087 WARN_ON(plane->state != old_plane_state);
2089 old_plane_state->state = state;
2090 new_plane_state->state = NULL;
2092 state->planes[i].state = old_plane_state;
2093 plane->state = new_plane_state;
2096 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2099 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2100 * @plane: plane object to update
2101 * @crtc: owning CRTC of owning plane
2102 * @fb: framebuffer to flip onto plane
2103 * @crtc_x: x offset of primary plane on crtc
2104 * @crtc_y: y offset of primary plane on crtc
2105 * @crtc_w: width of primary plane rectangle on crtc
2106 * @crtc_h: height of primary plane rectangle on crtc
2107 * @src_x: x offset of @fb for panning
2108 * @src_y: y offset of @fb for panning
2109 * @src_w: width of source rectangle in @fb
2110 * @src_h: height of source rectangle in @fb
2111 * @ctx: lock acquire context
2113 * Provides a default plane update handler using the atomic driver interface.
2116 * Zero on success, error code on failure
2118 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2119 struct drm_crtc *crtc,
2120 struct drm_framebuffer *fb,
2121 int crtc_x, int crtc_y,
2122 unsigned int crtc_w, unsigned int crtc_h,
2123 uint32_t src_x, uint32_t src_y,
2124 uint32_t src_w, uint32_t src_h,
2125 struct drm_modeset_acquire_ctx *ctx)
2127 struct drm_atomic_state *state;
2128 struct drm_plane_state *plane_state;
2131 state = drm_atomic_state_alloc(plane->dev);
2135 state->acquire_ctx = ctx;
2136 plane_state = drm_atomic_get_plane_state(state, plane);
2137 if (IS_ERR(plane_state)) {
2138 ret = PTR_ERR(plane_state);
2142 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2145 drm_atomic_set_fb_for_plane(plane_state, fb);
2146 plane_state->crtc_x = crtc_x;
2147 plane_state->crtc_y = crtc_y;
2148 plane_state->crtc_w = crtc_w;
2149 plane_state->crtc_h = crtc_h;
2150 plane_state->src_x = src_x;
2151 plane_state->src_y = src_y;
2152 plane_state->src_w = src_w;
2153 plane_state->src_h = src_h;
2155 if (plane == crtc->cursor)
2156 state->legacy_cursor_update = true;
2158 ret = drm_atomic_commit(state);
2160 drm_atomic_state_put(state);
2163 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2166 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2167 * @plane: plane to disable
2168 * @ctx: lock acquire context
2170 * Provides a default plane disable handler using the atomic driver interface.
2173 * Zero on success, error code on failure
2175 int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2176 struct drm_modeset_acquire_ctx *ctx)
2178 struct drm_atomic_state *state;
2179 struct drm_plane_state *plane_state;
2182 state = drm_atomic_state_alloc(plane->dev);
2186 state->acquire_ctx = ctx;
2187 plane_state = drm_atomic_get_plane_state(state, plane);
2188 if (IS_ERR(plane_state)) {
2189 ret = PTR_ERR(plane_state);
2193 if (plane_state->crtc && (plane == plane->crtc->cursor))
2194 plane_state->state->legacy_cursor_update = true;
2196 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2200 ret = drm_atomic_commit(state);
2202 drm_atomic_state_put(state);
2205 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2207 /* just used from fb-helper and atomic-helper: */
2208 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2209 struct drm_plane_state *plane_state)
2213 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2217 drm_atomic_set_fb_for_plane(plane_state, NULL);
2218 plane_state->crtc_x = 0;
2219 plane_state->crtc_y = 0;
2220 plane_state->crtc_w = 0;
2221 plane_state->crtc_h = 0;
2222 plane_state->src_x = 0;
2223 plane_state->src_y = 0;
2224 plane_state->src_w = 0;
2225 plane_state->src_h = 0;
2230 static int update_output_state(struct drm_atomic_state *state,
2231 struct drm_mode_set *set)
2233 struct drm_device *dev = set->crtc->dev;
2234 struct drm_crtc *crtc;
2235 struct drm_crtc_state *new_crtc_state;
2236 struct drm_connector *connector;
2237 struct drm_connector_state *new_conn_state;
2240 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2241 state->acquire_ctx);
2245 /* First disable all connectors on the target crtc. */
2246 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2250 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2251 if (new_conn_state->crtc == set->crtc) {
2252 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2257 /* Make sure legacy setCrtc always re-trains */
2258 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2262 /* Then set all connectors from set->connectors on the target crtc */
2263 for (i = 0; i < set->num_connectors; i++) {
2264 new_conn_state = drm_atomic_get_connector_state(state,
2265 set->connectors[i]);
2266 if (IS_ERR(new_conn_state))
2267 return PTR_ERR(new_conn_state);
2269 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2275 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2276 /* Don't update ->enable for the CRTC in the set_config request,
2277 * since a mismatch would indicate a bug in the upper layers.
2278 * The actual modeset code later on will catch any
2279 * inconsistencies here. */
2280 if (crtc == set->crtc)
2283 if (!new_crtc_state->connector_mask) {
2284 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2289 new_crtc_state->active = false;
2297 * drm_atomic_helper_set_config - set a new config from userspace
2298 * @set: mode set configuration
2299 * @ctx: lock acquisition context
2301 * Provides a default crtc set_config handler using the atomic driver interface.
2303 * NOTE: For backwards compatibility with old userspace this automatically
2304 * resets the "link-status" property to GOOD, to force any link
2305 * re-training. The SETCRTC ioctl does not define whether an update does
2306 * need a full modeset or just a plane update, hence we're allowed to do
2307 * that. See also drm_mode_connector_set_link_status_property().
2310 * Returns 0 on success, negative errno numbers on failure.
2312 int drm_atomic_helper_set_config(struct drm_mode_set *set,
2313 struct drm_modeset_acquire_ctx *ctx)
2315 struct drm_atomic_state *state;
2316 struct drm_crtc *crtc = set->crtc;
2319 state = drm_atomic_state_alloc(crtc->dev);
2323 state->acquire_ctx = ctx;
2324 ret = __drm_atomic_helper_set_config(set, state);
2328 ret = handle_conflicting_encoders(state, true);
2332 ret = drm_atomic_commit(state);
2335 drm_atomic_state_put(state);
2338 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2340 /* just used from fb-helper and atomic-helper: */
2341 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2342 struct drm_atomic_state *state)
2344 struct drm_crtc_state *crtc_state;
2345 struct drm_plane_state *primary_state;
2346 struct drm_crtc *crtc = set->crtc;
2347 int hdisplay, vdisplay;
2350 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2351 if (IS_ERR(crtc_state))
2352 return PTR_ERR(crtc_state);
2354 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2355 if (IS_ERR(primary_state))
2356 return PTR_ERR(primary_state);
2360 WARN_ON(set->num_connectors);
2362 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2366 crtc_state->active = false;
2368 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2372 drm_atomic_set_fb_for_plane(primary_state, NULL);
2378 WARN_ON(!set->num_connectors);
2380 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2384 crtc_state->active = true;
2386 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2390 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2392 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2393 primary_state->crtc_x = 0;
2394 primary_state->crtc_y = 0;
2395 primary_state->crtc_w = hdisplay;
2396 primary_state->crtc_h = vdisplay;
2397 primary_state->src_x = set->x << 16;
2398 primary_state->src_y = set->y << 16;
2399 if (drm_rotation_90_or_270(primary_state->rotation)) {
2400 primary_state->src_w = vdisplay << 16;
2401 primary_state->src_h = hdisplay << 16;
2403 primary_state->src_w = hdisplay << 16;
2404 primary_state->src_h = vdisplay << 16;
2408 ret = update_output_state(state, set);
2416 * drm_atomic_helper_disable_all - disable all currently active outputs
2418 * @ctx: lock acquisition context
2420 * Loops through all connectors, finding those that aren't turned off and then
2421 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2422 * that they are connected to.
2424 * This is used for example in suspend/resume to disable all currently active
2425 * functions when suspending. If you just want to shut down everything at e.g.
2426 * driver unload, look at drm_atomic_helper_shutdown().
2428 * Note that if callers haven't already acquired all modeset locks this might
2429 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2432 * 0 on success or a negative error code on failure.
2435 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
2436 * drm_atomic_helper_shutdown().
2438 int drm_atomic_helper_disable_all(struct drm_device *dev,
2439 struct drm_modeset_acquire_ctx *ctx)
2441 struct drm_atomic_state *state;
2442 struct drm_connector_state *conn_state;
2443 struct drm_connector *conn;
2444 struct drm_plane_state *plane_state;
2445 struct drm_plane *plane;
2446 struct drm_crtc_state *crtc_state;
2447 struct drm_crtc *crtc;
2450 state = drm_atomic_state_alloc(dev);
2454 state->acquire_ctx = ctx;
2456 drm_for_each_crtc(crtc, dev) {
2457 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2458 if (IS_ERR(crtc_state)) {
2459 ret = PTR_ERR(crtc_state);
2463 crtc_state->active = false;
2465 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
2469 ret = drm_atomic_add_affected_planes(state, crtc);
2473 ret = drm_atomic_add_affected_connectors(state, crtc);
2478 for_each_connector_in_state(state, conn, conn_state, i) {
2479 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
2484 for_each_plane_in_state(state, plane, plane_state, i) {
2485 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2489 drm_atomic_set_fb_for_plane(plane_state, NULL);
2492 ret = drm_atomic_commit(state);
2494 drm_atomic_state_put(state);
2498 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2501 * drm_atomic_helper_shutdown - shutdown all CRTC
2504 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
2505 * suspend should instead be handled with drm_atomic_helper_suspend(), since
2506 * that also takes a snapshot of the modeset state to be restored on resume.
2508 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
2509 * and it is the atomic version of drm_crtc_force_disable_all().
2511 void drm_atomic_helper_shutdown(struct drm_device *dev)
2513 struct drm_modeset_acquire_ctx ctx;
2516 drm_modeset_acquire_init(&ctx, 0);
2518 ret = drm_modeset_lock_all_ctx(dev, &ctx);
2520 ret = drm_atomic_helper_disable_all(dev, &ctx);
2522 if (ret != -EDEADLK)
2525 drm_modeset_backoff(&ctx);
2529 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
2531 drm_modeset_drop_locks(&ctx);
2532 drm_modeset_acquire_fini(&ctx);
2534 EXPORT_SYMBOL(drm_atomic_helper_shutdown);
2537 * drm_atomic_helper_suspend - subsystem-level suspend helper
2540 * Duplicates the current atomic state, disables all active outputs and then
2541 * returns a pointer to the original atomic state to the caller. Drivers can
2542 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2543 * restore the output configuration that was active at the time the system
2546 * Note that it is potentially unsafe to use this. The atomic state object
2547 * returned by this function is assumed to be persistent. Drivers must ensure
2548 * that this holds true. Before calling this function, drivers must make sure
2549 * to suspend fbdev emulation so that nothing can be using the device.
2552 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2553 * encoded error code on failure. Drivers should store the returned atomic
2554 * state object and pass it to the drm_atomic_helper_resume() helper upon
2558 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2559 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
2561 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2563 struct drm_modeset_acquire_ctx ctx;
2564 struct drm_atomic_state *state;
2567 drm_modeset_acquire_init(&ctx, 0);
2570 err = drm_modeset_lock_all_ctx(dev, &ctx);
2572 state = ERR_PTR(err);
2576 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2580 err = drm_atomic_helper_disable_all(dev, &ctx);
2582 drm_atomic_state_put(state);
2583 state = ERR_PTR(err);
2588 if (PTR_ERR(state) == -EDEADLK) {
2589 drm_modeset_backoff(&ctx);
2593 drm_modeset_drop_locks(&ctx);
2594 drm_modeset_acquire_fini(&ctx);
2597 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2600 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
2601 * @state: duplicated atomic state to commit
2602 * @ctx: pointer to acquire_ctx to use for commit.
2604 * The state returned by drm_atomic_helper_duplicate_state() and
2605 * drm_atomic_helper_suspend() is partially invalid, and needs to
2606 * be fixed up before commit.
2609 * 0 on success or a negative error code on failure.
2612 * drm_atomic_helper_suspend()
2614 int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
2615 struct drm_modeset_acquire_ctx *ctx)
2618 struct drm_plane *plane;
2619 struct drm_plane_state *new_plane_state;
2620 struct drm_connector *connector;
2621 struct drm_connector_state *new_conn_state;
2622 struct drm_crtc *crtc;
2623 struct drm_crtc_state *new_crtc_state;
2625 state->acquire_ctx = ctx;
2627 for_each_new_plane_in_state(state, plane, new_plane_state, i)
2628 state->planes[i].old_state = plane->state;
2630 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
2631 state->crtcs[i].old_state = crtc->state;
2633 for_each_new_connector_in_state(state, connector, new_conn_state, i)
2634 state->connectors[i].old_state = connector->state;
2636 return drm_atomic_commit(state);
2638 EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
2641 * drm_atomic_helper_resume - subsystem-level resume helper
2643 * @state: atomic state to resume to
2645 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2646 * grabs all modeset locks and commits the atomic state object. This can be
2647 * used in conjunction with the drm_atomic_helper_suspend() helper to
2648 * implement suspend/resume for drivers that support atomic mode-setting.
2651 * 0 on success or a negative error code on failure.
2654 * drm_atomic_helper_suspend()
2656 int drm_atomic_helper_resume(struct drm_device *dev,
2657 struct drm_atomic_state *state)
2659 struct drm_modeset_acquire_ctx ctx;
2662 drm_mode_config_reset(dev);
2664 drm_modeset_acquire_init(&ctx, 0);
2666 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
2667 if (err != -EDEADLK)
2670 drm_modeset_backoff(&ctx);
2673 drm_modeset_drop_locks(&ctx);
2674 drm_modeset_acquire_fini(&ctx);
2678 EXPORT_SYMBOL(drm_atomic_helper_resume);
2681 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2683 * @property: DRM property
2684 * @val: value of property
2686 * Provides a default crtc set_property handler using the atomic driver
2690 * Zero on success, error code on failure
2693 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2694 struct drm_property *property,
2697 struct drm_atomic_state *state;
2698 struct drm_crtc_state *crtc_state;
2701 state = drm_atomic_state_alloc(crtc->dev);
2705 /* ->set_property is always called with all locks held. */
2706 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2708 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2709 if (IS_ERR(crtc_state)) {
2710 ret = PTR_ERR(crtc_state);
2714 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2719 ret = drm_atomic_commit(state);
2721 if (ret == -EDEADLK)
2724 drm_atomic_state_put(state);
2728 drm_atomic_state_clear(state);
2729 drm_atomic_legacy_backoff(state);
2733 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2736 * drm_atomic_helper_plane_set_property - helper for plane properties
2738 * @property: DRM property
2739 * @val: value of property
2741 * Provides a default plane set_property handler using the atomic driver
2745 * Zero on success, error code on failure
2748 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2749 struct drm_property *property,
2752 struct drm_atomic_state *state;
2753 struct drm_plane_state *plane_state;
2756 state = drm_atomic_state_alloc(plane->dev);
2760 /* ->set_property is always called with all locks held. */
2761 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2763 plane_state = drm_atomic_get_plane_state(state, plane);
2764 if (IS_ERR(plane_state)) {
2765 ret = PTR_ERR(plane_state);
2769 ret = drm_atomic_plane_set_property(plane, plane_state,
2774 ret = drm_atomic_commit(state);
2776 if (ret == -EDEADLK)
2779 drm_atomic_state_put(state);
2783 drm_atomic_state_clear(state);
2784 drm_atomic_legacy_backoff(state);
2788 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2791 * drm_atomic_helper_connector_set_property - helper for connector properties
2792 * @connector: DRM connector
2793 * @property: DRM property
2794 * @val: value of property
2796 * Provides a default connector set_property handler using the atomic driver
2800 * Zero on success, error code on failure
2803 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2804 struct drm_property *property,
2807 struct drm_atomic_state *state;
2808 struct drm_connector_state *connector_state;
2811 state = drm_atomic_state_alloc(connector->dev);
2815 /* ->set_property is always called with all locks held. */
2816 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2818 connector_state = drm_atomic_get_connector_state(state, connector);
2819 if (IS_ERR(connector_state)) {
2820 ret = PTR_ERR(connector_state);
2824 ret = drm_atomic_connector_set_property(connector, connector_state,
2829 ret = drm_atomic_commit(state);
2831 if (ret == -EDEADLK)
2834 drm_atomic_state_put(state);
2838 drm_atomic_state_clear(state);
2839 drm_atomic_legacy_backoff(state);
2843 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2845 static int page_flip_common(
2846 struct drm_atomic_state *state,
2847 struct drm_crtc *crtc,
2848 struct drm_framebuffer *fb,
2849 struct drm_pending_vblank_event *event,
2852 struct drm_plane *plane = crtc->primary;
2853 struct drm_plane_state *plane_state;
2854 struct drm_crtc_state *crtc_state;
2857 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2858 if (IS_ERR(crtc_state))
2859 return PTR_ERR(crtc_state);
2861 crtc_state->event = event;
2862 crtc_state->pageflip_flags = flags;
2864 plane_state = drm_atomic_get_plane_state(state, plane);
2865 if (IS_ERR(plane_state))
2866 return PTR_ERR(plane_state);
2868 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2871 drm_atomic_set_fb_for_plane(plane_state, fb);
2873 /* Make sure we don't accidentally do a full modeset. */
2874 state->allow_modeset = false;
2875 if (!crtc_state->active) {
2876 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
2877 crtc->base.id, crtc->name);
2885 * drm_atomic_helper_page_flip - execute a legacy page flip
2887 * @fb: DRM framebuffer
2888 * @event: optional DRM event to signal upon completion
2889 * @flags: flip flags for non-vblank sync'ed updates
2890 * @ctx: lock acquisition context
2892 * Provides a default &drm_crtc_funcs.page_flip implementation
2893 * using the atomic driver interface.
2896 * Returns 0 on success, negative errno numbers on failure.
2899 * drm_atomic_helper_page_flip_target()
2901 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2902 struct drm_framebuffer *fb,
2903 struct drm_pending_vblank_event *event,
2905 struct drm_modeset_acquire_ctx *ctx)
2907 struct drm_plane *plane = crtc->primary;
2908 struct drm_atomic_state *state;
2911 state = drm_atomic_state_alloc(plane->dev);
2915 state->acquire_ctx = ctx;
2917 ret = page_flip_common(state, crtc, fb, event, flags);
2921 ret = drm_atomic_nonblocking_commit(state);
2923 drm_atomic_state_put(state);
2926 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2929 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
2931 * @fb: DRM framebuffer
2932 * @event: optional DRM event to signal upon completion
2933 * @flags: flip flags for non-vblank sync'ed updates
2934 * @target: specifying the target vblank period when the flip to take effect
2935 * @ctx: lock acquisition context
2937 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
2938 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
2939 * target vblank period to flip.
2942 * Returns 0 on success, negative errno numbers on failure.
2944 int drm_atomic_helper_page_flip_target(
2945 struct drm_crtc *crtc,
2946 struct drm_framebuffer *fb,
2947 struct drm_pending_vblank_event *event,
2950 struct drm_modeset_acquire_ctx *ctx)
2952 struct drm_plane *plane = crtc->primary;
2953 struct drm_atomic_state *state;
2954 struct drm_crtc_state *crtc_state;
2957 state = drm_atomic_state_alloc(plane->dev);
2961 state->acquire_ctx = ctx;
2963 ret = page_flip_common(state, crtc, fb, event, flags);
2967 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
2968 if (WARN_ON(!crtc_state)) {
2972 crtc_state->target_vblank = target;
2974 ret = drm_atomic_nonblocking_commit(state);
2976 drm_atomic_state_put(state);
2979 EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
2982 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2983 * @connector: affected connector
2986 * This is the main helper function provided by the atomic helper framework for
2987 * implementing the legacy DPMS connector interface. It computes the new desired
2988 * &drm_crtc_state.active state for the corresponding CRTC (if the connector is
2989 * enabled) and updates it.
2992 * Returns 0 on success, negative errno numbers on failure.
2994 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2997 struct drm_mode_config *config = &connector->dev->mode_config;
2998 struct drm_atomic_state *state;
2999 struct drm_crtc_state *crtc_state;
3000 struct drm_crtc *crtc;
3001 struct drm_connector *tmp_connector;
3002 struct drm_connector_list_iter conn_iter;
3004 bool active = false;
3005 int old_mode = connector->dpms;
3007 if (mode != DRM_MODE_DPMS_ON)
3008 mode = DRM_MODE_DPMS_OFF;
3010 connector->dpms = mode;
3011 crtc = connector->state->crtc;
3016 state = drm_atomic_state_alloc(connector->dev);
3020 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
3022 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3023 if (IS_ERR(crtc_state)) {
3024 ret = PTR_ERR(crtc_state);
3028 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
3030 drm_connector_list_iter_begin(connector->dev, &conn_iter);
3031 drm_for_each_connector_iter(tmp_connector, &conn_iter) {
3032 if (tmp_connector->state->crtc != crtc)
3035 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
3040 drm_connector_list_iter_end(&conn_iter);
3041 crtc_state->active = active;
3043 ret = drm_atomic_commit(state);
3045 if (ret == -EDEADLK)
3048 connector->dpms = old_mode;
3049 drm_atomic_state_put(state);
3053 drm_atomic_state_clear(state);
3054 drm_atomic_legacy_backoff(state);
3058 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
3061 * drm_atomic_helper_best_encoder - Helper for
3062 * &drm_connector_helper_funcs.best_encoder callback
3063 * @connector: Connector control structure
3065 * This is a &drm_connector_helper_funcs.best_encoder callback helper for
3066 * connectors that support exactly 1 encoder, statically determined at driver
3069 struct drm_encoder *
3070 drm_atomic_helper_best_encoder(struct drm_connector *connector)
3072 WARN_ON(connector->encoder_ids[1]);
3073 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
3075 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
3078 * DOC: atomic state reset and initialization
3080 * Both the drm core and the atomic helpers assume that there is always the full
3081 * and correct atomic software state for all connectors, CRTCs and planes
3082 * available. Which is a bit a problem on driver load and also after system
3083 * suspend. One way to solve this is to have a hardware state read-out
3084 * infrastructure which reconstructs the full software state (e.g. the i915
3087 * The simpler solution is to just reset the software state to everything off,
3088 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
3089 * the atomic helpers provide default reset implementations for all hooks.
3091 * On the upside the precise state tracking of atomic simplifies system suspend
3092 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
3093 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
3094 * For other drivers the building blocks are split out, see the documentation
3095 * for these functions.
3099 * drm_atomic_helper_crtc_reset - default &drm_crtc_funcs.reset hook for CRTCs
3102 * Resets the atomic state for @crtc by freeing the state pointer (which might
3103 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3105 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
3108 __drm_atomic_helper_crtc_destroy_state(crtc->state);
3111 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
3114 crtc->state->crtc = crtc;
3116 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
3119 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
3120 * @crtc: CRTC object
3121 * @state: atomic CRTC state
3123 * Copies atomic state from a CRTC's current state and resets inferred values.
3124 * This is useful for drivers that subclass the CRTC state.
3126 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
3127 struct drm_crtc_state *state)
3129 memcpy(state, crtc->state, sizeof(*state));
3131 if (state->mode_blob)
3132 drm_property_blob_get(state->mode_blob);
3133 if (state->degamma_lut)
3134 drm_property_blob_get(state->degamma_lut);
3136 drm_property_blob_get(state->ctm);
3137 if (state->gamma_lut)
3138 drm_property_blob_get(state->gamma_lut);
3139 state->mode_changed = false;
3140 state->active_changed = false;
3141 state->planes_changed = false;
3142 state->connectors_changed = false;
3143 state->color_mgmt_changed = false;
3144 state->zpos_changed = false;
3145 state->event = NULL;
3146 state->pageflip_flags = 0;
3148 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
3151 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3154 * Default CRTC state duplicate hook for drivers which don't have their own
3155 * subclassed CRTC state structure.
3157 struct drm_crtc_state *
3158 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
3160 struct drm_crtc_state *state;
3162 if (WARN_ON(!crtc->state))
3165 state = kmalloc(sizeof(*state), GFP_KERNEL);
3167 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
3171 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
3174 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3175 * @state: CRTC state object to release
3177 * Releases all resources stored in the CRTC state without actually freeing
3178 * the memory of the CRTC state. This is useful for drivers that subclass the
3181 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
3183 drm_property_blob_put(state->mode_blob);
3184 drm_property_blob_put(state->degamma_lut);
3185 drm_property_blob_put(state->ctm);
3186 drm_property_blob_put(state->gamma_lut);
3188 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3191 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3193 * @state: CRTC state object to release
3195 * Default CRTC state destroy hook for drivers which don't have their own
3196 * subclassed CRTC state structure.
3198 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3199 struct drm_crtc_state *state)
3201 __drm_atomic_helper_crtc_destroy_state(state);
3204 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3207 * drm_atomic_helper_plane_reset - default &drm_plane_funcs.reset hook for planes
3210 * Resets the atomic state for @plane by freeing the state pointer (which might
3211 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3213 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3216 __drm_atomic_helper_plane_destroy_state(plane->state);
3218 kfree(plane->state);
3219 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3222 plane->state->plane = plane;
3223 plane->state->rotation = DRM_ROTATE_0;
3226 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3229 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3230 * @plane: plane object
3231 * @state: atomic plane state
3233 * Copies atomic state from a plane's current state. This is useful for
3234 * drivers that subclass the plane state.
3236 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3237 struct drm_plane_state *state)
3239 memcpy(state, plane->state, sizeof(*state));
3242 drm_framebuffer_get(state->fb);
3244 state->fence = NULL;
3246 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3249 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3252 * Default plane state duplicate hook for drivers which don't have their own
3253 * subclassed plane state structure.
3255 struct drm_plane_state *
3256 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3258 struct drm_plane_state *state;
3260 if (WARN_ON(!plane->state))
3263 state = kmalloc(sizeof(*state), GFP_KERNEL);
3265 __drm_atomic_helper_plane_duplicate_state(plane, state);
3269 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3272 * __drm_atomic_helper_plane_destroy_state - release plane state
3273 * @state: plane state object to release
3275 * Releases all resources stored in the plane state without actually freeing
3276 * the memory of the plane state. This is useful for drivers that subclass the
3279 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3282 drm_framebuffer_put(state->fb);
3285 dma_fence_put(state->fence);
3287 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3290 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3292 * @state: plane state object to release
3294 * Default plane state destroy hook for drivers which don't have their own
3295 * subclassed plane state structure.
3297 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3298 struct drm_plane_state *state)
3300 __drm_atomic_helper_plane_destroy_state(state);
3303 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3306 * __drm_atomic_helper_connector_reset - reset state on connector
3307 * @connector: drm connector
3308 * @conn_state: connector state to assign
3310 * Initializes the newly allocated @conn_state and assigns it to
3311 * the &drm_conector->state pointer of @connector, usually required when
3312 * initializing the drivers or when called from the &drm_connector_funcs.reset
3315 * This is useful for drivers that subclass the connector state.
3318 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
3319 struct drm_connector_state *conn_state)
3322 conn_state->connector = connector;
3324 connector->state = conn_state;
3326 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3329 * drm_atomic_helper_connector_reset - default &drm_connector_funcs.reset hook for connectors
3330 * @connector: drm connector
3332 * Resets the atomic state for @connector by freeing the state pointer (which
3333 * might be NULL, e.g. at driver load time) and allocating a new empty state
3336 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3338 struct drm_connector_state *conn_state =
3339 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3341 if (connector->state)
3342 __drm_atomic_helper_connector_destroy_state(connector->state);
3344 kfree(connector->state);
3345 __drm_atomic_helper_connector_reset(connector, conn_state);
3347 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3350 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3351 * @connector: connector object
3352 * @state: atomic connector state
3354 * Copies atomic state from a connector's current state. This is useful for
3355 * drivers that subclass the connector state.
3358 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3359 struct drm_connector_state *state)
3361 memcpy(state, connector->state, sizeof(*state));
3363 drm_connector_get(connector);
3365 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3368 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3369 * @connector: drm connector
3371 * Default connector state duplicate hook for drivers which don't have their own
3372 * subclassed connector state structure.
3374 struct drm_connector_state *
3375 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3377 struct drm_connector_state *state;
3379 if (WARN_ON(!connector->state))
3382 state = kmalloc(sizeof(*state), GFP_KERNEL);
3384 __drm_atomic_helper_connector_duplicate_state(connector, state);
3388 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3391 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3393 * @ctx: lock acquisition context
3395 * Makes a copy of the current atomic state by looping over all objects and
3396 * duplicating their respective states. This is used for example by suspend/
3397 * resume support code to save the state prior to suspend such that it can
3398 * be restored upon resume.
3400 * Note that this treats atomic state as persistent between save and restore.
3401 * Drivers must make sure that this is possible and won't result in confusion
3402 * or erroneous behaviour.
3404 * Note that if callers haven't already acquired all modeset locks this might
3405 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3408 * A pointer to the copy of the atomic state object on success or an
3409 * ERR_PTR()-encoded error code on failure.
3412 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3414 struct drm_atomic_state *
3415 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3416 struct drm_modeset_acquire_ctx *ctx)
3418 struct drm_atomic_state *state;
3419 struct drm_connector *conn;
3420 struct drm_connector_list_iter conn_iter;
3421 struct drm_plane *plane;
3422 struct drm_crtc *crtc;
3425 state = drm_atomic_state_alloc(dev);
3427 return ERR_PTR(-ENOMEM);
3429 state->acquire_ctx = ctx;
3431 drm_for_each_crtc(crtc, dev) {
3432 struct drm_crtc_state *crtc_state;
3434 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3435 if (IS_ERR(crtc_state)) {
3436 err = PTR_ERR(crtc_state);
3441 drm_for_each_plane(plane, dev) {
3442 struct drm_plane_state *plane_state;
3444 plane_state = drm_atomic_get_plane_state(state, plane);
3445 if (IS_ERR(plane_state)) {
3446 err = PTR_ERR(plane_state);
3451 drm_connector_list_iter_begin(dev, &conn_iter);
3452 drm_for_each_connector_iter(conn, &conn_iter) {
3453 struct drm_connector_state *conn_state;
3455 conn_state = drm_atomic_get_connector_state(state, conn);
3456 if (IS_ERR(conn_state)) {
3457 err = PTR_ERR(conn_state);
3458 drm_connector_list_iter_end(&conn_iter);
3462 drm_connector_list_iter_end(&conn_iter);
3464 /* clear the acquire context so that it isn't accidentally reused */
3465 state->acquire_ctx = NULL;
3469 drm_atomic_state_put(state);
3470 state = ERR_PTR(err);
3475 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3478 * __drm_atomic_helper_connector_destroy_state - release connector state
3479 * @state: connector state object to release
3481 * Releases all resources stored in the connector state without actually
3482 * freeing the memory of the connector state. This is useful for drivers that
3483 * subclass the connector state.
3486 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3489 drm_connector_put(state->connector);
3491 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3494 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3495 * @connector: drm connector
3496 * @state: connector state object to release
3498 * Default connector state destroy hook for drivers which don't have their own
3499 * subclassed connector state structure.
3501 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3502 struct drm_connector_state *state)
3504 __drm_atomic_helper_connector_destroy_state(state);
3507 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3510 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3511 * @crtc: CRTC object
3512 * @red: red correction table
3513 * @green: green correction table
3514 * @blue: green correction table
3515 * @size: size of the tables
3516 * @ctx: lock acquire context
3518 * Implements support for legacy gamma correction table for drivers
3519 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3522 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3523 u16 *red, u16 *green, u16 *blue,
3525 struct drm_modeset_acquire_ctx *ctx)
3527 struct drm_device *dev = crtc->dev;
3528 struct drm_mode_config *config = &dev->mode_config;
3529 struct drm_atomic_state *state;
3530 struct drm_crtc_state *crtc_state;
3531 struct drm_property_blob *blob = NULL;
3532 struct drm_color_lut *blob_data;
3535 state = drm_atomic_state_alloc(crtc->dev);
3539 blob = drm_property_create_blob(dev,
3540 sizeof(struct drm_color_lut) * size,
3543 ret = PTR_ERR(blob);
3548 /* Prepare GAMMA_LUT with the legacy values. */
3549 blob_data = (struct drm_color_lut *) blob->data;
3550 for (i = 0; i < size; i++) {
3551 blob_data[i].red = red[i];
3552 blob_data[i].green = green[i];
3553 blob_data[i].blue = blue[i];
3556 state->acquire_ctx = ctx;
3557 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3558 if (IS_ERR(crtc_state)) {
3559 ret = PTR_ERR(crtc_state);
3563 /* Reset DEGAMMA_LUT and CTM properties. */
3564 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3565 config->degamma_lut_property, 0);
3569 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3570 config->ctm_property, 0);
3574 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3575 config->gamma_lut_property, blob->base.id);
3579 ret = drm_atomic_commit(state);
3582 drm_atomic_state_put(state);
3583 drm_property_blob_put(blob);
3586 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);