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/fence.h>
38 * This helper library provides implementations of check and commit functions on
39 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
40 * also provides convenience implementations for the atomic state handling
41 * callbacks for drivers which don't need to subclass the drm core structures to
42 * add their own additional internal state.
44 * This library also provides default implementations for the check callback in
45 * drm_atomic_helper_check() and for the commit callback with
46 * drm_atomic_helper_commit(). But the individual stages and callbacks are
47 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
48 * together with a driver private modeset implementation.
50 * This library also provides implementations for all the legacy driver
51 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
52 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
56 * The atomic helper uses the same function table structures as all other
57 * modesetting helpers. See the documentation for struct &drm_crtc_helper_funcs,
58 * struct &drm_encoder_helper_funcs and struct &drm_connector_helper_funcs. It
59 * also shares the struct &drm_plane_helper_funcs function table with the plane
63 drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
64 struct drm_plane_state *plane_state,
65 struct drm_plane *plane)
67 struct drm_crtc_state *crtc_state;
69 if (plane->state->crtc) {
70 crtc_state = drm_atomic_get_existing_crtc_state(state,
73 if (WARN_ON(!crtc_state))
76 crtc_state->planes_changed = true;
79 if (plane_state->crtc) {
80 crtc_state = drm_atomic_get_existing_crtc_state(state,
83 if (WARN_ON(!crtc_state))
86 crtc_state->planes_changed = true;
90 static int handle_conflicting_encoders(struct drm_atomic_state *state,
91 bool disable_conflicting_encoders)
93 struct drm_connector_state *conn_state;
94 struct drm_connector *connector;
95 struct drm_encoder *encoder;
96 unsigned encoder_mask = 0;
100 * First loop, find all newly assigned encoders from the connectors
101 * part of the state. If the same encoder is assigned to multiple
102 * connectors bail out.
104 for_each_connector_in_state(state, connector, conn_state, i) {
105 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
106 struct drm_encoder *new_encoder;
108 if (!conn_state->crtc)
111 if (funcs->atomic_best_encoder)
112 new_encoder = funcs->atomic_best_encoder(connector, conn_state);
113 else if (funcs->best_encoder)
114 new_encoder = funcs->best_encoder(connector);
116 new_encoder = drm_atomic_helper_best_encoder(connector);
119 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
120 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
121 new_encoder->base.id, new_encoder->name,
122 connector->base.id, connector->name);
127 encoder_mask |= 1 << drm_encoder_index(new_encoder);
135 * Second loop, iterate over all connectors not part of the state.
137 * If a conflicting encoder is found and disable_conflicting_encoders
138 * is not set, an error is returned. Userspace can provide a solution
139 * through the atomic ioctl.
141 * If the flag is set conflicting connectors are removed from the crtc
142 * and the crtc is disabled if no encoder is left. This preserves
143 * compatibility with the legacy set_config behavior.
145 drm_for_each_connector(connector, state->dev) {
146 struct drm_crtc_state *crtc_state;
148 if (drm_atomic_get_existing_connector_state(state, connector))
151 encoder = connector->state->best_encoder;
152 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
155 if (!disable_conflicting_encoders) {
156 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
157 encoder->base.id, encoder->name,
158 connector->state->crtc->base.id,
159 connector->state->crtc->name,
160 connector->base.id, connector->name);
164 conn_state = drm_atomic_get_connector_state(state, connector);
165 if (IS_ERR(conn_state))
166 return PTR_ERR(conn_state);
168 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
169 encoder->base.id, encoder->name,
170 conn_state->crtc->base.id, conn_state->crtc->name,
171 connector->base.id, connector->name);
173 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
175 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
179 if (!crtc_state->connector_mask) {
180 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
185 crtc_state->active = false;
193 set_best_encoder(struct drm_atomic_state *state,
194 struct drm_connector_state *conn_state,
195 struct drm_encoder *encoder)
197 struct drm_crtc_state *crtc_state;
198 struct drm_crtc *crtc;
200 if (conn_state->best_encoder) {
201 /* Unset the encoder_mask in the old crtc state. */
202 crtc = conn_state->connector->state->crtc;
204 /* A NULL crtc is an error here because we should have
205 * duplicated a NULL best_encoder when crtc was NULL.
206 * As an exception restoring duplicated atomic state
207 * during resume is allowed, so don't warn when
208 * best_encoder is equal to encoder we intend to set.
210 WARN_ON(!crtc && encoder != conn_state->best_encoder);
212 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
214 crtc_state->encoder_mask &=
215 ~(1 << drm_encoder_index(conn_state->best_encoder));
220 crtc = conn_state->crtc;
223 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
225 crtc_state->encoder_mask |=
226 1 << drm_encoder_index(encoder);
230 conn_state->best_encoder = encoder;
234 steal_encoder(struct drm_atomic_state *state,
235 struct drm_encoder *encoder)
237 struct drm_crtc_state *crtc_state;
238 struct drm_connector *connector;
239 struct drm_connector_state *connector_state;
242 for_each_connector_in_state(state, connector, connector_state, i) {
243 struct drm_crtc *encoder_crtc;
245 if (connector_state->best_encoder != encoder)
248 encoder_crtc = connector->state->crtc;
250 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
251 encoder->base.id, encoder->name,
252 encoder_crtc->base.id, encoder_crtc->name);
254 set_best_encoder(state, connector_state, NULL);
256 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
257 crtc_state->connectors_changed = true;
264 update_connector_routing(struct drm_atomic_state *state,
265 struct drm_connector *connector,
266 struct drm_connector_state *connector_state)
268 const struct drm_connector_helper_funcs *funcs;
269 struct drm_encoder *new_encoder;
270 struct drm_crtc_state *crtc_state;
272 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
276 if (connector->state->crtc != connector_state->crtc) {
277 if (connector->state->crtc) {
278 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
279 crtc_state->connectors_changed = true;
282 if (connector_state->crtc) {
283 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
284 crtc_state->connectors_changed = true;
288 if (!connector_state->crtc) {
289 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
293 set_best_encoder(state, connector_state, NULL);
298 funcs = connector->helper_private;
300 if (funcs->atomic_best_encoder)
301 new_encoder = funcs->atomic_best_encoder(connector,
303 else if (funcs->best_encoder)
304 new_encoder = funcs->best_encoder(connector);
306 new_encoder = drm_atomic_helper_best_encoder(connector);
309 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
315 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
316 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
317 new_encoder->base.id,
319 connector_state->crtc->base.id);
323 if (new_encoder == connector_state->best_encoder) {
324 set_best_encoder(state, connector_state, new_encoder);
326 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
329 new_encoder->base.id,
331 connector_state->crtc->base.id,
332 connector_state->crtc->name);
337 steal_encoder(state, new_encoder);
339 set_best_encoder(state, connector_state, new_encoder);
341 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
342 crtc_state->connectors_changed = true;
344 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
347 new_encoder->base.id,
349 connector_state->crtc->base.id,
350 connector_state->crtc->name);
356 mode_fixup(struct drm_atomic_state *state)
358 struct drm_crtc *crtc;
359 struct drm_crtc_state *crtc_state;
360 struct drm_connector *connector;
361 struct drm_connector_state *conn_state;
365 for_each_crtc_in_state(state, crtc, crtc_state, i) {
366 if (!crtc_state->mode_changed &&
367 !crtc_state->connectors_changed)
370 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
373 for_each_connector_in_state(state, connector, conn_state, i) {
374 const struct drm_encoder_helper_funcs *funcs;
375 struct drm_encoder *encoder;
377 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
379 if (!conn_state->crtc || !conn_state->best_encoder)
382 crtc_state = drm_atomic_get_existing_crtc_state(state,
386 * Each encoder has at most one connector (since we always steal
387 * it away), so we won't call ->mode_fixup twice.
389 encoder = conn_state->best_encoder;
390 funcs = encoder->helper_private;
392 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
393 &crtc_state->adjusted_mode);
395 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
399 if (funcs && funcs->atomic_check) {
400 ret = funcs->atomic_check(encoder, crtc_state,
403 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
404 encoder->base.id, encoder->name);
407 } else if (funcs && funcs->mode_fixup) {
408 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
409 &crtc_state->adjusted_mode);
411 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
412 encoder->base.id, encoder->name);
418 for_each_crtc_in_state(state, crtc, crtc_state, i) {
419 const struct drm_crtc_helper_funcs *funcs;
421 if (!crtc_state->enable)
424 if (!crtc_state->mode_changed &&
425 !crtc_state->connectors_changed)
428 funcs = crtc->helper_private;
429 if (!funcs->mode_fixup)
432 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
433 &crtc_state->adjusted_mode);
435 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
436 crtc->base.id, crtc->name);
445 * drm_atomic_helper_check_modeset - validate state object for modeset changes
447 * @state: the driver state object
449 * Check the state object to see if the requested state is physically possible.
450 * This does all the crtc and connector related computations for an atomic
451 * update and adds any additional connectors needed for full modesets and calls
452 * down into ->mode_fixup functions of the driver backend.
454 * crtc_state->mode_changed is set when the input mode is changed.
455 * crtc_state->connectors_changed is set when a connector is added or
456 * removed from the crtc.
457 * crtc_state->active_changed is set when crtc_state->active changes,
458 * which is used for dpms.
462 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
463 * plane update can't be done without a full modeset) _must_ call this function
464 * afterwards after that change. It is permitted to call this function multiple
465 * times for the same update, e.g. when the ->atomic_check functions depend upon
466 * the adjusted dotclock for fifo space allocation and watermark computation.
469 * Zero for success or -errno
472 drm_atomic_helper_check_modeset(struct drm_device *dev,
473 struct drm_atomic_state *state)
475 struct drm_crtc *crtc;
476 struct drm_crtc_state *crtc_state;
477 struct drm_connector *connector;
478 struct drm_connector_state *connector_state;
481 for_each_crtc_in_state(state, crtc, crtc_state, i) {
482 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
483 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
484 crtc->base.id, crtc->name);
485 crtc_state->mode_changed = true;
488 if (crtc->state->enable != crtc_state->enable) {
489 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
490 crtc->base.id, crtc->name);
493 * For clarity this assignment is done here, but
494 * enable == 0 is only true when there are no
495 * connectors and a NULL mode.
497 * The other way around is true as well. enable != 0
498 * iff connectors are attached and a mode is set.
500 crtc_state->mode_changed = true;
501 crtc_state->connectors_changed = true;
505 ret = handle_conflicting_encoders(state, state->legacy_set_config);
509 for_each_connector_in_state(state, connector, connector_state, i) {
511 * This only sets crtc->mode_changed for routing changes,
512 * drivers must set crtc->mode_changed themselves when connector
513 * properties need to be updated.
515 ret = update_connector_routing(state, connector,
522 * After all the routing has been prepared we need to add in any
523 * connector which is itself unchanged, but who's crtc changes it's
524 * configuration. This must be done before calling mode_fixup in case a
525 * crtc only changed its mode but has the same set of connectors.
527 for_each_crtc_in_state(state, crtc, crtc_state, i) {
528 bool has_connectors =
529 !!crtc_state->connector_mask;
532 * We must set ->active_changed after walking connectors for
533 * otherwise an update that only changes active would result in
534 * a full modeset because update_connector_routing force that.
536 if (crtc->state->active != crtc_state->active) {
537 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
538 crtc->base.id, crtc->name);
539 crtc_state->active_changed = true;
542 if (!drm_atomic_crtc_needs_modeset(crtc_state))
545 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
546 crtc->base.id, crtc->name,
547 crtc_state->enable ? 'y' : 'n',
548 crtc_state->active ? 'y' : 'n');
550 ret = drm_atomic_add_affected_connectors(state, crtc);
554 ret = drm_atomic_add_affected_planes(state, crtc);
558 if (crtc_state->enable != has_connectors) {
559 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
560 crtc->base.id, crtc->name);
566 return mode_fixup(state);
568 EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
571 * drm_atomic_helper_check_planes - validate state object for planes changes
573 * @state: the driver state object
575 * Check the state object to see if the requested state is physically possible.
576 * This does all the plane update related checks using by calling into the
577 * ->atomic_check hooks provided by the driver.
579 * It also sets crtc_state->planes_changed to indicate that a crtc has
583 * Zero for success or -errno
586 drm_atomic_helper_check_planes(struct drm_device *dev,
587 struct drm_atomic_state *state)
589 struct drm_crtc *crtc;
590 struct drm_crtc_state *crtc_state;
591 struct drm_plane *plane;
592 struct drm_plane_state *plane_state;
595 for_each_plane_in_state(state, plane, plane_state, i) {
596 const struct drm_plane_helper_funcs *funcs;
598 funcs = plane->helper_private;
600 drm_atomic_helper_plane_changed(state, plane_state, plane);
602 if (!funcs || !funcs->atomic_check)
605 ret = funcs->atomic_check(plane, plane_state);
607 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
608 plane->base.id, plane->name);
613 for_each_crtc_in_state(state, crtc, crtc_state, i) {
614 const struct drm_crtc_helper_funcs *funcs;
616 funcs = crtc->helper_private;
618 if (!funcs || !funcs->atomic_check)
621 ret = funcs->atomic_check(crtc, crtc_state);
623 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
624 crtc->base.id, crtc->name);
631 EXPORT_SYMBOL(drm_atomic_helper_check_planes);
634 * drm_atomic_helper_check - validate state object
636 * @state: the driver state object
638 * Check the state object to see if the requested state is physically possible.
639 * Only crtcs and planes have check callbacks, so for any additional (global)
640 * checking that a driver needs it can simply wrap that around this function.
641 * Drivers without such needs can directly use this as their ->atomic_check()
644 * This just wraps the two parts of the state checking for planes and modeset
645 * state in the default order: First it calls drm_atomic_helper_check_modeset()
646 * and then drm_atomic_helper_check_planes(). The assumption is that the
647 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
648 * e.g. properly compute watermarks.
651 * Zero for success or -errno
653 int drm_atomic_helper_check(struct drm_device *dev,
654 struct drm_atomic_state *state)
658 ret = drm_atomic_helper_check_modeset(dev, state);
662 ret = drm_atomic_helper_check_planes(dev, state);
668 EXPORT_SYMBOL(drm_atomic_helper_check);
671 disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
673 struct drm_connector *connector;
674 struct drm_connector_state *old_conn_state;
675 struct drm_crtc *crtc;
676 struct drm_crtc_state *old_crtc_state;
679 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
680 const struct drm_encoder_helper_funcs *funcs;
681 struct drm_encoder *encoder;
683 /* Shut down everything that's in the changeset and currently
684 * still on. So need to check the old, saved state. */
685 if (!old_conn_state->crtc)
688 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
689 old_conn_state->crtc);
691 if (!old_crtc_state->active ||
692 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
695 encoder = old_conn_state->best_encoder;
697 /* We shouldn't get this far if we didn't previously have
698 * an encoder.. but WARN_ON() rather than explode.
700 if (WARN_ON(!encoder))
703 funcs = encoder->helper_private;
705 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
706 encoder->base.id, encoder->name);
709 * Each encoder has at most one connector (since we always steal
710 * it away), so we won't call disable hooks twice.
712 drm_bridge_disable(encoder->bridge);
714 /* Right function depends upon target state. */
716 if (connector->state->crtc && funcs->prepare)
717 funcs->prepare(encoder);
718 else if (funcs->disable)
719 funcs->disable(encoder);
720 else if (funcs->dpms)
721 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
724 drm_bridge_post_disable(encoder->bridge);
727 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
728 const struct drm_crtc_helper_funcs *funcs;
730 /* Shut down everything that needs a full modeset. */
731 if (!drm_atomic_crtc_needs_modeset(crtc->state))
734 if (!old_crtc_state->active)
737 funcs = crtc->helper_private;
739 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
740 crtc->base.id, crtc->name);
743 /* Right function depends upon target state. */
744 if (crtc->state->enable && funcs->prepare)
745 funcs->prepare(crtc);
746 else if (funcs->disable)
747 funcs->disable(crtc);
749 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
754 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
756 * @old_state: atomic state object with old state structures
758 * This function updates all the various legacy modeset state pointers in
759 * connectors, encoders and crtcs. It also updates the timestamping constants
760 * used for precise vblank timestamps by calling
761 * drm_calc_timestamping_constants().
763 * Drivers can use this for building their own atomic commit if they don't have
764 * a pure helper-based modeset implementation.
767 drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
768 struct drm_atomic_state *old_state)
770 struct drm_connector *connector;
771 struct drm_connector_state *old_conn_state;
772 struct drm_crtc *crtc;
773 struct drm_crtc_state *old_crtc_state;
776 /* clear out existing links and update dpms */
777 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
778 if (connector->encoder) {
779 WARN_ON(!connector->encoder->crtc);
781 connector->encoder->crtc = NULL;
782 connector->encoder = NULL;
785 crtc = connector->state->crtc;
786 if ((!crtc && old_conn_state->crtc) ||
787 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
788 struct drm_property *dpms_prop =
789 dev->mode_config.dpms_property;
790 int mode = DRM_MODE_DPMS_OFF;
792 if (crtc && crtc->state->active)
793 mode = DRM_MODE_DPMS_ON;
795 connector->dpms = mode;
796 drm_object_property_set_value(&connector->base,
802 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
803 if (!connector->state->crtc)
806 if (WARN_ON(!connector->state->best_encoder))
809 connector->encoder = connector->state->best_encoder;
810 connector->encoder->crtc = connector->state->crtc;
813 /* set legacy state in the crtc structure */
814 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
815 struct drm_plane *primary = crtc->primary;
817 crtc->mode = crtc->state->mode;
818 crtc->enabled = crtc->state->enable;
820 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
821 primary->state->crtc == crtc) {
822 crtc->x = primary->state->src_x >> 16;
823 crtc->y = primary->state->src_y >> 16;
826 if (crtc->state->enable)
827 drm_calc_timestamping_constants(crtc,
828 &crtc->state->adjusted_mode);
831 EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
834 crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
836 struct drm_crtc *crtc;
837 struct drm_crtc_state *old_crtc_state;
838 struct drm_connector *connector;
839 struct drm_connector_state *old_conn_state;
842 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
843 const struct drm_crtc_helper_funcs *funcs;
845 if (!crtc->state->mode_changed)
848 funcs = crtc->helper_private;
850 if (crtc->state->enable && funcs->mode_set_nofb) {
851 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
852 crtc->base.id, crtc->name);
854 funcs->mode_set_nofb(crtc);
858 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
859 const struct drm_encoder_helper_funcs *funcs;
860 struct drm_crtc_state *new_crtc_state;
861 struct drm_encoder *encoder;
862 struct drm_display_mode *mode, *adjusted_mode;
864 if (!connector->state->best_encoder)
867 encoder = connector->state->best_encoder;
868 funcs = encoder->helper_private;
869 new_crtc_state = connector->state->crtc->state;
870 mode = &new_crtc_state->mode;
871 adjusted_mode = &new_crtc_state->adjusted_mode;
873 if (!new_crtc_state->mode_changed)
876 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
877 encoder->base.id, encoder->name);
880 * Each encoder has at most one connector (since we always steal
881 * it away), so we won't call mode_set hooks twice.
883 if (funcs && funcs->mode_set)
884 funcs->mode_set(encoder, mode, adjusted_mode);
886 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
891 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
893 * @old_state: atomic state object with old state structures
895 * This function shuts down all the outputs that need to be shut down and
896 * prepares them (if required) with the new mode.
898 * For compatibility with legacy crtc helpers this should be called before
899 * drm_atomic_helper_commit_planes(), which is what the default commit function
900 * does. But drivers with different needs can group the modeset commits together
901 * and do the plane commits at the end. This is useful for drivers doing runtime
902 * PM since planes updates then only happen when the CRTC is actually enabled.
904 void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
905 struct drm_atomic_state *old_state)
907 disable_outputs(dev, old_state);
909 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
911 crtc_set_mode(dev, old_state);
913 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
916 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
918 * @old_state: atomic state object with old state structures
920 * This function enables all the outputs with the new configuration which had to
921 * be turned off for the update.
923 * For compatibility with legacy crtc helpers this should be called after
924 * drm_atomic_helper_commit_planes(), which is what the default commit function
925 * does. But drivers with different needs can group the modeset commits together
926 * and do the plane commits at the end. This is useful for drivers doing runtime
927 * PM since planes updates then only happen when the CRTC is actually enabled.
929 void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
930 struct drm_atomic_state *old_state)
932 struct drm_crtc *crtc;
933 struct drm_crtc_state *old_crtc_state;
934 struct drm_connector *connector;
935 struct drm_connector_state *old_conn_state;
938 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
939 const struct drm_crtc_helper_funcs *funcs;
941 /* Need to filter out CRTCs where only planes change. */
942 if (!drm_atomic_crtc_needs_modeset(crtc->state))
945 if (!crtc->state->active)
948 funcs = crtc->helper_private;
950 if (crtc->state->enable) {
951 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
952 crtc->base.id, crtc->name);
961 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
962 const struct drm_encoder_helper_funcs *funcs;
963 struct drm_encoder *encoder;
965 if (!connector->state->best_encoder)
968 if (!connector->state->crtc->state->active ||
969 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
972 encoder = connector->state->best_encoder;
973 funcs = encoder->helper_private;
975 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
976 encoder->base.id, encoder->name);
979 * Each encoder has at most one connector (since we always steal
980 * it away), so we won't call enable hooks twice.
982 drm_bridge_pre_enable(encoder->bridge);
986 funcs->enable(encoder);
987 else if (funcs->commit)
988 funcs->commit(encoder);
991 drm_bridge_enable(encoder->bridge);
994 EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
997 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
999 * @state: atomic state object with old state structures
1001 * For implicit sync, driver should fish the exclusive fence out from the
1002 * incoming fb's and stash it in the drm_plane_state. This is called after
1003 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1004 * just uses the atomic state to find the changed planes)
1006 void drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1007 struct drm_atomic_state *state)
1009 struct drm_plane *plane;
1010 struct drm_plane_state *plane_state;
1013 for_each_plane_in_state(state, plane, plane_state, i) {
1014 if (!plane->state->fence)
1017 WARN_ON(!plane->state->fb);
1019 fence_wait(plane->state->fence, false);
1020 fence_put(plane->state->fence);
1021 plane->state->fence = NULL;
1024 EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1027 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1029 * @old_state: atomic state object with old state structures
1032 * Checks whether the framebuffer used for this CRTC changes as a result of
1033 * the atomic update. This is useful for drivers which cannot use
1034 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1038 * true if the framebuffer changed.
1040 bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1041 struct drm_atomic_state *old_state,
1042 struct drm_crtc *crtc)
1044 struct drm_plane *plane;
1045 struct drm_plane_state *old_plane_state;
1048 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1049 if (plane->state->crtc != crtc &&
1050 old_plane_state->crtc != crtc)
1053 if (plane->state->fb != old_plane_state->fb)
1059 EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1062 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1064 * @old_state: atomic state object with old state structures
1066 * Helper to, after atomic commit, wait for vblanks on all effected
1067 * crtcs (ie. before cleaning up old framebuffers using
1068 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1069 * framebuffers have actually changed to optimize for the legacy cursor and
1070 * plane update use-case.
1073 drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1074 struct drm_atomic_state *old_state)
1076 struct drm_crtc *crtc;
1077 struct drm_crtc_state *old_crtc_state;
1080 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1081 /* No one cares about the old state, so abuse it for tracking
1082 * and store whether we hold a vblank reference (and should do a
1083 * vblank wait) in the ->enable boolean. */
1084 old_crtc_state->enable = false;
1086 if (!crtc->state->enable)
1089 /* Legacy cursor ioctls are completely unsynced, and userspace
1090 * relies on that (by doing tons of cursor updates). */
1091 if (old_state->legacy_cursor_update)
1094 if (!drm_atomic_helper_framebuffer_changed(dev,
1098 ret = drm_crtc_vblank_get(crtc);
1102 old_crtc_state->enable = true;
1103 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1106 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1107 if (!old_crtc_state->enable)
1110 ret = wait_event_timeout(dev->vblank[i].queue,
1111 old_crtc_state->last_vblank_count !=
1112 drm_crtc_vblank_count(crtc),
1113 msecs_to_jiffies(50));
1115 WARN(!ret, "[CRTC:%d] vblank wait timed out\n", crtc->base.id);
1117 drm_crtc_vblank_put(crtc);
1120 EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1123 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1124 * @state: new modeset state to be committed
1126 * This is the default implemenation for the ->atomic_commit_tail() hook of the
1127 * &drm_mode_config_helper_funcs vtable.
1129 * Note that the default ordering of how the various stages are called is to
1130 * match the legacy modeset helper library closest. One peculiarity of that is
1131 * that it doesn't mesh well with runtime PM at all.
1133 * For drivers supporting runtime PM the recommended sequence is instead ::
1135 * drm_atomic_helper_commit_modeset_disables(dev, state);
1137 * drm_atomic_helper_commit_modeset_enables(dev, state);
1139 * drm_atomic_helper_commit_planes(dev, state, true);
1141 * for committing the atomic update to hardware. See the kerneldoc entries for
1142 * these three functions for more details.
1144 void drm_atomic_helper_commit_tail(struct drm_atomic_state *state)
1146 struct drm_device *dev = state->dev;
1148 drm_atomic_helper_commit_modeset_disables(dev, state);
1150 drm_atomic_helper_commit_planes(dev, state, false);
1152 drm_atomic_helper_commit_modeset_enables(dev, state);
1154 drm_atomic_helper_commit_hw_done(state);
1156 drm_atomic_helper_wait_for_vblanks(dev, state);
1158 drm_atomic_helper_cleanup_planes(dev, state);
1160 EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1162 static void commit_tail(struct drm_atomic_state *state)
1164 struct drm_device *dev = state->dev;
1165 struct drm_mode_config_helper_funcs *funcs;
1167 funcs = dev->mode_config.helper_private;
1169 drm_atomic_helper_wait_for_fences(dev, state);
1171 drm_atomic_helper_wait_for_dependencies(state);
1173 if (funcs && funcs->atomic_commit_tail)
1174 funcs->atomic_commit_tail(state);
1176 drm_atomic_helper_commit_tail(state);
1178 drm_atomic_helper_commit_cleanup_done(state);
1180 drm_atomic_state_free(state);
1183 static void commit_work(struct work_struct *work)
1185 struct drm_atomic_state *state = container_of(work,
1186 struct drm_atomic_state,
1192 * drm_atomic_helper_commit - commit validated state object
1194 * @state: the driver state object
1195 * @nonblock: whether nonblocking behavior is requested.
1197 * This function commits a with drm_atomic_helper_check() pre-validated state
1198 * object. This can still fail when e.g. the framebuffer reservation fails. This
1199 * function implements nonblocking commits, using
1200 * drm_atomic_helper_setup_commit() and related functions.
1202 * Note that right now this function does not support nonblocking commits, hence
1203 * driver writers must implement their own version for now.
1205 * Committing the actual hardware state is done through the
1206 * ->atomic_commit_tail() callback of the &drm_mode_config_helper_funcs vtable,
1207 * or it's default implementation drm_atomic_helper_commit_tail().
1210 * Zero for success or -errno.
1212 int drm_atomic_helper_commit(struct drm_device *dev,
1213 struct drm_atomic_state *state,
1218 ret = drm_atomic_helper_setup_commit(state, nonblock);
1222 INIT_WORK(&state->commit_work, commit_work);
1224 ret = drm_atomic_helper_prepare_planes(dev, state);
1229 * This is the point of no return - everything below never fails except
1230 * when the hw goes bonghits. Which means we can commit the new state on
1231 * the software side now.
1234 drm_atomic_helper_swap_state(state, true);
1237 * Everything below can be run asynchronously without the need to grab
1238 * any modeset locks at all under one condition: It must be guaranteed
1239 * that the asynchronous work has either been cancelled (if the driver
1240 * supports it, which at least requires that the framebuffers get
1241 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1242 * before the new state gets committed on the software side with
1243 * drm_atomic_helper_swap_state().
1245 * This scheme allows new atomic state updates to be prepared and
1246 * checked in parallel to the asynchronous completion of the previous
1247 * update. Which is important since compositors need to figure out the
1248 * composition of the next frame right after having submitted the
1251 * NOTE: Commit work has multiple phases, first hardware commit, then
1252 * cleanup. We want them to overlap, hence need system_unbound_wq to
1253 * make sure work items don't artifically stall on each another.
1257 queue_work(system_unbound_wq, &state->commit_work);
1263 EXPORT_SYMBOL(drm_atomic_helper_commit);
1266 * DOC: implementing nonblocking commit
1268 * Nonblocking atomic commits have to be implemented in the following sequence:
1270 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1271 * which commit needs to call which can fail, so we want to run it first and
1274 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1275 * might be affected the new state update. This can be done by either cancelling
1276 * or flushing the work items, depending upon whether the driver can deal with
1277 * cancelled updates. Note that it is important to ensure that the framebuffer
1278 * cleanup is still done when cancelling.
1280 * Asynchronous workers need to have sufficient parallelism to be able to run
1281 * different atomic commits on different CRTCs in parallel. The simplest way to
1282 * achive this is by running them on the &system_unbound_wq work queue. Note
1283 * that drivers are not required to split up atomic commits and run an
1284 * individual commit in parallel - userspace is supposed to do that if it cares.
1285 * But it might be beneficial to do that for modesets, since those necessarily
1286 * must be done as one global operation, and enabling or disabling a CRTC can
1287 * take a long time. But even that is not required.
1289 * 3. The software state is updated synchronously with
1290 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1291 * locks means concurrent callers never see inconsistent state. And doing this
1292 * while it's guaranteed that no relevant nonblocking worker runs means that
1293 * nonblocking workers do not need grab any locks. Actually they must not grab
1294 * locks, for otherwise the work flushing will deadlock.
1296 * 4. Schedule a work item to do all subsequent steps, using the split-out
1297 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1298 * then cleaning up the framebuffers after the old framebuffer is no longer
1301 * The above scheme is implemented in the atomic helper libraries in
1302 * drm_atomic_helper_commit() using a bunch of helper functions. See
1303 * drm_atomic_helper_setup_commit() for a starting point.
1306 static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1308 struct drm_crtc_commit *commit, *stall_commit = NULL;
1309 bool completed = true;
1313 spin_lock(&crtc->commit_lock);
1315 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1317 completed = try_wait_for_completion(&commit->flip_done);
1318 /* Userspace is not allowed to get ahead of the previous
1319 * commit with nonblocking ones. */
1320 if (!completed && nonblock) {
1321 spin_unlock(&crtc->commit_lock);
1324 } else if (i == 1) {
1325 stall_commit = commit;
1326 drm_crtc_commit_get(stall_commit);
1332 spin_unlock(&crtc->commit_lock);
1337 /* We don't want to let commits get ahead of cleanup work too much,
1338 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1340 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1343 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1344 crtc->base.id, crtc->name);
1346 drm_crtc_commit_put(stall_commit);
1348 return ret < 0 ? ret : 0;
1352 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1353 * @state: new modeset state to be committed
1354 * @nonblock: whether nonblocking behavior is requested.
1356 * This function prepares @state to be used by the atomic helper's support for
1357 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1358 * should always call this function from their ->atomic_commit hook.
1360 * To be able to use this support drivers need to use a few more helper
1361 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1362 * actually committing the hardware state, and for nonblocking commits this call
1363 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1364 * and it's stall parameter, for when a driver's commit hooks look at the
1365 * ->state pointers of struct &drm_crtc, &drm_plane or &drm_connector directly.
1367 * Completion of the hardware commit step must be signalled using
1368 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1369 * to read or change any permanent software or hardware modeset state. The only
1370 * exception is state protected by other means than &drm_modeset_lock locks.
1371 * Only the free standing @state with pointers to the old state structures can
1372 * be inspected, e.g. to clean up old buffers using
1373 * drm_atomic_helper_cleanup_planes().
1375 * At the very end, before cleaning up @state drivers must call
1376 * drm_atomic_helper_commit_cleanup_done().
1378 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1379 * complete and esay-to-use default implementation of the atomic_commit() hook.
1381 * The tracking of asynchronously executed and still pending commits is done
1382 * using the core structure &drm_crtc_commit.
1384 * By default there's no need to clean up resources allocated by this function
1385 * explicitly: drm_atomic_state_default_clear() will take care of that
1390 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1391 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1393 int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1396 struct drm_crtc *crtc;
1397 struct drm_crtc_state *crtc_state;
1398 struct drm_crtc_commit *commit;
1401 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1402 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1406 init_completion(&commit->flip_done);
1407 init_completion(&commit->hw_done);
1408 init_completion(&commit->cleanup_done);
1409 INIT_LIST_HEAD(&commit->commit_entry);
1410 kref_init(&commit->ref);
1411 commit->crtc = crtc;
1413 state->crtcs[i].commit = commit;
1415 ret = stall_checks(crtc, nonblock);
1419 /* Drivers only send out events when at least either current or
1420 * new CRTC state is active. Complete right away if everything
1422 if (!crtc->state->active && !crtc_state->active) {
1423 complete_all(&commit->flip_done);
1427 /* Legacy cursor updates are fully unsynced. */
1428 if (state->legacy_cursor_update) {
1429 complete_all(&commit->flip_done);
1433 if (!crtc_state->event) {
1434 commit->event = kzalloc(sizeof(*commit->event),
1439 crtc_state->event = commit->event;
1442 crtc_state->event->base.completion = &commit->flip_done;
1447 EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1450 static struct drm_crtc_commit *preceeding_commit(struct drm_crtc *crtc)
1452 struct drm_crtc_commit *commit;
1455 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1456 /* skip the first entry, that's the current commit */
1466 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1467 * @state: new modeset state to be committed
1469 * This function waits for all preceeding commits that touch the same CRTC as
1470 * @state to both be committed to the hardware (as signalled by
1471 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1472 * by calling drm_crtc_vblank_send_event on the event member of
1475 * This is part of the atomic helper support for nonblocking commits, see
1476 * drm_atomic_helper_setup_commit() for an overview.
1478 void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *state)
1480 struct drm_crtc *crtc;
1481 struct drm_crtc_state *crtc_state;
1482 struct drm_crtc_commit *commit;
1486 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1487 spin_lock(&crtc->commit_lock);
1488 commit = preceeding_commit(crtc);
1490 drm_crtc_commit_get(commit);
1491 spin_unlock(&crtc->commit_lock);
1496 ret = wait_for_completion_timeout(&commit->hw_done,
1499 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1500 crtc->base.id, crtc->name);
1502 /* Currently no support for overwriting flips, hence
1503 * stall for previous one to execute completely. */
1504 ret = wait_for_completion_timeout(&commit->flip_done,
1507 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1508 crtc->base.id, crtc->name);
1510 drm_crtc_commit_put(commit);
1513 EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
1516 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
1517 * @state: new modeset state to be committed
1519 * This function is used to signal completion of the hardware commit step. After
1520 * this step the driver is not allowed to read or change any permanent software
1521 * or hardware modeset state. The only exception is state protected by other
1522 * means than &drm_modeset_lock locks.
1524 * Drivers should try to postpone any expensive or delayed cleanup work after
1525 * this function is called.
1527 * This is part of the atomic helper support for nonblocking commits, see
1528 * drm_atomic_helper_setup_commit() for an overview.
1530 void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *state)
1532 struct drm_crtc *crtc;
1533 struct drm_crtc_state *crtc_state;
1534 struct drm_crtc_commit *commit;
1537 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1538 commit = state->crtcs[i].commit;
1542 /* backend must have consumed any event by now */
1543 WARN_ON(crtc->state->event);
1544 spin_lock(&crtc->commit_lock);
1545 complete_all(&commit->hw_done);
1546 spin_unlock(&crtc->commit_lock);
1549 EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
1552 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
1553 * @state: new modeset state to be committed
1555 * This signals completion of the atomic update @state, including any cleanup
1556 * work. If used, it must be called right before calling
1557 * drm_atomic_state_free().
1559 * This is part of the atomic helper support for nonblocking commits, see
1560 * drm_atomic_helper_setup_commit() for an overview.
1562 void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *state)
1564 struct drm_crtc *crtc;
1565 struct drm_crtc_state *crtc_state;
1566 struct drm_crtc_commit *commit;
1570 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1571 commit = state->crtcs[i].commit;
1572 if (WARN_ON(!commit))
1575 spin_lock(&crtc->commit_lock);
1576 complete_all(&commit->cleanup_done);
1577 WARN_ON(!try_wait_for_completion(&commit->hw_done));
1579 /* commit_list borrows our reference, need to remove before we
1580 * clean up our drm_atomic_state. But only after it actually
1581 * completed, otherwise subsequent commits won't stall properly. */
1582 if (try_wait_for_completion(&commit->flip_done))
1585 spin_unlock(&crtc->commit_lock);
1587 /* We must wait for the vblank event to signal our completion
1588 * before releasing our reference, since the vblank work does
1589 * not hold a reference of its own. */
1590 ret = wait_for_completion_timeout(&commit->flip_done,
1593 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1594 crtc->base.id, crtc->name);
1596 spin_lock(&crtc->commit_lock);
1598 list_del(&commit->commit_entry);
1599 spin_unlock(&crtc->commit_lock);
1602 EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
1605 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1607 * @state: atomic state object with new state structures
1609 * This function prepares plane state, specifically framebuffers, for the new
1610 * configuration. If any failure is encountered this function will call
1611 * ->cleanup_fb on any already successfully prepared framebuffer.
1614 * 0 on success, negative error code on failure.
1616 int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1617 struct drm_atomic_state *state)
1619 struct drm_plane *plane;
1620 struct drm_plane_state *plane_state;
1623 for_each_plane_in_state(state, plane, plane_state, i) {
1624 const struct drm_plane_helper_funcs *funcs;
1626 funcs = plane->helper_private;
1628 if (funcs->prepare_fb) {
1629 ret = funcs->prepare_fb(plane, plane_state);
1638 for_each_plane_in_state(state, plane, plane_state, j) {
1639 const struct drm_plane_helper_funcs *funcs;
1644 funcs = plane->helper_private;
1646 if (funcs->cleanup_fb)
1647 funcs->cleanup_fb(plane, plane_state);
1653 EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1655 bool plane_crtc_active(struct drm_plane_state *state)
1657 return state->crtc && state->crtc->state->active;
1661 * drm_atomic_helper_commit_planes - commit plane state
1663 * @old_state: atomic state object with old state structures
1664 * @active_only: Only commit on active CRTC if set
1666 * This function commits the new plane state using the plane and atomic helper
1667 * functions for planes and crtcs. It assumes that the atomic state has already
1668 * been pushed into the relevant object state pointers, since this step can no
1671 * It still requires the global state object @old_state to know which planes and
1672 * crtcs need to be updated though.
1674 * Note that this function does all plane updates across all CRTCs in one step.
1675 * If the hardware can't support this approach look at
1676 * drm_atomic_helper_commit_planes_on_crtc() instead.
1678 * Plane parameters can be updated by applications while the associated CRTC is
1679 * disabled. The DRM/KMS core will store the parameters in the plane state,
1680 * which will be available to the driver when the CRTC is turned on. As a result
1681 * most drivers don't need to be immediately notified of plane updates for a
1684 * Unless otherwise needed, drivers are advised to set the @active_only
1685 * parameters to true in order not to receive plane update notifications related
1686 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1687 * driver code when the driver and/or hardware can't or just don't need to deal
1688 * with updates on disabled CRTCs, for example when supporting runtime PM.
1690 * The drm_atomic_helper_commit() default implementation only sets @active_only
1691 * to false to most closely match the behaviour of the legacy helpers. This should
1692 * not be copied blindly by drivers.
1694 void drm_atomic_helper_commit_planes(struct drm_device *dev,
1695 struct drm_atomic_state *old_state,
1698 struct drm_crtc *crtc;
1699 struct drm_crtc_state *old_crtc_state;
1700 struct drm_plane *plane;
1701 struct drm_plane_state *old_plane_state;
1704 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1705 const struct drm_crtc_helper_funcs *funcs;
1707 funcs = crtc->helper_private;
1709 if (!funcs || !funcs->atomic_begin)
1712 if (active_only && !crtc->state->active)
1715 funcs->atomic_begin(crtc, old_crtc_state);
1718 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1719 const struct drm_plane_helper_funcs *funcs;
1722 funcs = plane->helper_private;
1727 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1731 * Skip planes related to inactive CRTCs. If the plane
1732 * is enabled use the state of the current CRTC. If the
1733 * plane is being disabled use the state of the old
1734 * CRTC to avoid skipping planes being disabled on an
1737 if (!disabling && !plane_crtc_active(plane->state))
1739 if (disabling && !plane_crtc_active(old_plane_state))
1744 * Special-case disabling the plane if drivers support it.
1746 if (disabling && funcs->atomic_disable)
1747 funcs->atomic_disable(plane, old_plane_state);
1748 else if (plane->state->crtc || disabling)
1749 funcs->atomic_update(plane, old_plane_state);
1752 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1753 const struct drm_crtc_helper_funcs *funcs;
1755 funcs = crtc->helper_private;
1757 if (!funcs || !funcs->atomic_flush)
1760 if (active_only && !crtc->state->active)
1763 funcs->atomic_flush(crtc, old_crtc_state);
1766 EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1769 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1770 * @old_crtc_state: atomic state object with the old crtc state
1772 * This function commits the new plane state using the plane and atomic helper
1773 * functions for planes on the specific crtc. It assumes that the atomic state
1774 * has already been pushed into the relevant object state pointers, since this
1775 * step can no longer fail.
1777 * This function is useful when plane updates should be done crtc-by-crtc
1778 * instead of one global step like drm_atomic_helper_commit_planes() does.
1780 * This function can only be savely used when planes are not allowed to move
1781 * between different CRTCs because this function doesn't handle inter-CRTC
1782 * depencies. Callers need to ensure that either no such depencies exist,
1783 * resolve them through ordering of commit calls or through some other means.
1786 drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1788 const struct drm_crtc_helper_funcs *crtc_funcs;
1789 struct drm_crtc *crtc = old_crtc_state->crtc;
1790 struct drm_atomic_state *old_state = old_crtc_state->state;
1791 struct drm_plane *plane;
1792 unsigned plane_mask;
1794 plane_mask = old_crtc_state->plane_mask;
1795 plane_mask |= crtc->state->plane_mask;
1797 crtc_funcs = crtc->helper_private;
1798 if (crtc_funcs && crtc_funcs->atomic_begin)
1799 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1801 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1802 struct drm_plane_state *old_plane_state =
1803 drm_atomic_get_existing_plane_state(old_state, plane);
1804 const struct drm_plane_helper_funcs *plane_funcs;
1806 plane_funcs = plane->helper_private;
1808 if (!old_plane_state || !plane_funcs)
1811 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1813 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1814 plane_funcs->atomic_disable)
1815 plane_funcs->atomic_disable(plane, old_plane_state);
1816 else if (plane->state->crtc ||
1817 drm_atomic_plane_disabling(plane, old_plane_state))
1818 plane_funcs->atomic_update(plane, old_plane_state);
1821 if (crtc_funcs && crtc_funcs->atomic_flush)
1822 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1824 EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1827 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1829 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1831 * Disables all planes associated with the given CRTC. This can be
1832 * used for instance in the CRTC helper disable callback to disable
1833 * all planes before shutting down the display pipeline.
1835 * If the atomic-parameter is set the function calls the CRTC's
1836 * atomic_begin hook before and atomic_flush hook after disabling the
1839 * It is a bug to call this function without having implemented the
1840 * ->atomic_disable() plane hook.
1842 void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1845 const struct drm_crtc_helper_funcs *crtc_funcs =
1846 crtc->helper_private;
1847 struct drm_plane *plane;
1849 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1850 crtc_funcs->atomic_begin(crtc, NULL);
1852 drm_for_each_plane(plane, crtc->dev) {
1853 const struct drm_plane_helper_funcs *plane_funcs =
1854 plane->helper_private;
1856 if (plane->state->crtc != crtc || !plane_funcs)
1859 WARN_ON(!plane_funcs->atomic_disable);
1860 if (plane_funcs->atomic_disable)
1861 plane_funcs->atomic_disable(plane, NULL);
1864 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1865 crtc_funcs->atomic_flush(crtc, NULL);
1867 EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1870 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1872 * @old_state: atomic state object with old state structures
1874 * This function cleans up plane state, specifically framebuffers, from the old
1875 * configuration. Hence the old configuration must be perserved in @old_state to
1876 * be able to call this function.
1878 * This function must also be called on the new state when the atomic update
1879 * fails at any point after calling drm_atomic_helper_prepare_planes().
1881 void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1882 struct drm_atomic_state *old_state)
1884 struct drm_plane *plane;
1885 struct drm_plane_state *plane_state;
1888 for_each_plane_in_state(old_state, plane, plane_state, i) {
1889 const struct drm_plane_helper_funcs *funcs;
1891 funcs = plane->helper_private;
1893 if (funcs->cleanup_fb)
1894 funcs->cleanup_fb(plane, plane_state);
1897 EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1900 * drm_atomic_helper_swap_state - store atomic state into current sw state
1901 * @state: atomic state
1902 * @stall: stall for proceeding commits
1904 * This function stores the atomic state into the current state pointers in all
1905 * driver objects. It should be called after all failing steps have been done
1906 * and succeeded, but before the actual hardware state is committed.
1908 * For cleanup and error recovery the current state for all changed objects will
1909 * be swaped into @state.
1911 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1913 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1915 * 2. Do any other steps that might fail.
1917 * 3. Put the staged state into the current state pointers with this function.
1919 * 4. Actually commit the hardware state.
1921 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1922 * contains the old state. Also do any other cleanup required with that state.
1924 * @stall must be set when nonblocking commits for this driver directly access
1925 * the ->state pointer of &drm_plane, &drm_crtc or &drm_connector. With the
1926 * current atomic helpers this is almost always the case, since the helpers
1927 * don't pass the right state structures to the callbacks.
1929 void drm_atomic_helper_swap_state(struct drm_atomic_state *state,
1934 struct drm_connector *connector;
1935 struct drm_connector_state *conn_state;
1936 struct drm_crtc *crtc;
1937 struct drm_crtc_state *crtc_state;
1938 struct drm_plane *plane;
1939 struct drm_plane_state *plane_state;
1940 struct drm_crtc_commit *commit;
1943 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1944 spin_lock(&crtc->commit_lock);
1945 commit = list_first_entry_or_null(&crtc->commit_list,
1946 struct drm_crtc_commit, commit_entry);
1948 drm_crtc_commit_get(commit);
1949 spin_unlock(&crtc->commit_lock);
1954 ret = wait_for_completion_timeout(&commit->hw_done,
1957 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1958 crtc->base.id, crtc->name);
1959 drm_crtc_commit_put(commit);
1963 for_each_connector_in_state(state, connector, conn_state, i) {
1964 connector->state->state = state;
1965 swap(state->connectors[i].state, connector->state);
1966 connector->state->state = NULL;
1969 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1970 crtc->state->state = state;
1971 swap(state->crtcs[i].state, crtc->state);
1972 crtc->state->state = NULL;
1974 if (state->crtcs[i].commit) {
1975 spin_lock(&crtc->commit_lock);
1976 list_add(&state->crtcs[i].commit->commit_entry,
1977 &crtc->commit_list);
1978 spin_unlock(&crtc->commit_lock);
1980 state->crtcs[i].commit->event = NULL;
1984 for_each_plane_in_state(state, plane, plane_state, i) {
1985 plane->state->state = state;
1986 swap(state->planes[i].state, plane->state);
1987 plane->state->state = NULL;
1990 EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1993 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1994 * @plane: plane object to update
1995 * @crtc: owning CRTC of owning plane
1996 * @fb: framebuffer to flip onto plane
1997 * @crtc_x: x offset of primary plane on crtc
1998 * @crtc_y: y offset of primary plane on crtc
1999 * @crtc_w: width of primary plane rectangle on crtc
2000 * @crtc_h: height of primary plane rectangle on crtc
2001 * @src_x: x offset of @fb for panning
2002 * @src_y: y offset of @fb for panning
2003 * @src_w: width of source rectangle in @fb
2004 * @src_h: height of source rectangle in @fb
2006 * Provides a default plane update handler using the atomic driver interface.
2009 * Zero on success, error code on failure
2011 int drm_atomic_helper_update_plane(struct drm_plane *plane,
2012 struct drm_crtc *crtc,
2013 struct drm_framebuffer *fb,
2014 int crtc_x, int crtc_y,
2015 unsigned int crtc_w, unsigned int crtc_h,
2016 uint32_t src_x, uint32_t src_y,
2017 uint32_t src_w, uint32_t src_h)
2019 struct drm_atomic_state *state;
2020 struct drm_plane_state *plane_state;
2023 state = drm_atomic_state_alloc(plane->dev);
2027 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2029 plane_state = drm_atomic_get_plane_state(state, plane);
2030 if (IS_ERR(plane_state)) {
2031 ret = PTR_ERR(plane_state);
2035 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2038 drm_atomic_set_fb_for_plane(plane_state, fb);
2039 plane_state->crtc_x = crtc_x;
2040 plane_state->crtc_y = crtc_y;
2041 plane_state->crtc_w = crtc_w;
2042 plane_state->crtc_h = crtc_h;
2043 plane_state->src_x = src_x;
2044 plane_state->src_y = src_y;
2045 plane_state->src_w = src_w;
2046 plane_state->src_h = src_h;
2048 if (plane == crtc->cursor)
2049 state->legacy_cursor_update = true;
2051 ret = drm_atomic_commit(state);
2055 /* Driver takes ownership of state on successful commit. */
2058 if (ret == -EDEADLK)
2061 drm_atomic_state_free(state);
2065 drm_atomic_state_clear(state);
2066 drm_atomic_legacy_backoff(state);
2069 * Someone might have exchanged the framebuffer while we dropped locks
2070 * in the backoff code. We need to fix up the fb refcount tracking the
2073 plane->old_fb = plane->fb;
2077 EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2080 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2081 * @plane: plane to disable
2083 * Provides a default plane disable handler using the atomic driver interface.
2086 * Zero on success, error code on failure
2088 int drm_atomic_helper_disable_plane(struct drm_plane *plane)
2090 struct drm_atomic_state *state;
2091 struct drm_plane_state *plane_state;
2095 * FIXME: Without plane->crtc set we can't get at the implicit legacy
2096 * acquire context. The real fix will be to wire the acquire ctx through
2097 * everywhere we need it, but meanwhile prevent chaos by just skipping
2098 * this noop. The critical case is the cursor ioctls which a) only grab
2099 * crtc/cursor-plane locks (so we need the crtc to get at the right
2100 * acquire context) and b) can try to disable the plane multiple times.
2105 state = drm_atomic_state_alloc(plane->dev);
2109 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
2111 plane_state = drm_atomic_get_plane_state(state, plane);
2112 if (IS_ERR(plane_state)) {
2113 ret = PTR_ERR(plane_state);
2117 if (plane_state->crtc && (plane == plane->crtc->cursor))
2118 plane_state->state->legacy_cursor_update = true;
2120 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2124 ret = drm_atomic_commit(state);
2128 /* Driver takes ownership of state on successful commit. */
2131 if (ret == -EDEADLK)
2134 drm_atomic_state_free(state);
2138 drm_atomic_state_clear(state);
2139 drm_atomic_legacy_backoff(state);
2142 * Someone might have exchanged the framebuffer while we dropped locks
2143 * in the backoff code. We need to fix up the fb refcount tracking the
2146 plane->old_fb = plane->fb;
2150 EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2152 /* just used from fb-helper and atomic-helper: */
2153 int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2154 struct drm_plane_state *plane_state)
2158 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2162 drm_atomic_set_fb_for_plane(plane_state, NULL);
2163 plane_state->crtc_x = 0;
2164 plane_state->crtc_y = 0;
2165 plane_state->crtc_w = 0;
2166 plane_state->crtc_h = 0;
2167 plane_state->src_x = 0;
2168 plane_state->src_y = 0;
2169 plane_state->src_w = 0;
2170 plane_state->src_h = 0;
2175 static int update_output_state(struct drm_atomic_state *state,
2176 struct drm_mode_set *set)
2178 struct drm_device *dev = set->crtc->dev;
2179 struct drm_crtc *crtc;
2180 struct drm_crtc_state *crtc_state;
2181 struct drm_connector *connector;
2182 struct drm_connector_state *conn_state;
2185 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2186 state->acquire_ctx);
2190 /* First disable all connectors on the target crtc. */
2191 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2195 for_each_connector_in_state(state, connector, conn_state, i) {
2196 if (conn_state->crtc == set->crtc) {
2197 ret = drm_atomic_set_crtc_for_connector(conn_state,
2204 /* Then set all connectors from set->connectors on the target crtc */
2205 for (i = 0; i < set->num_connectors; i++) {
2206 conn_state = drm_atomic_get_connector_state(state,
2207 set->connectors[i]);
2208 if (IS_ERR(conn_state))
2209 return PTR_ERR(conn_state);
2211 ret = drm_atomic_set_crtc_for_connector(conn_state,
2217 for_each_crtc_in_state(state, crtc, crtc_state, i) {
2218 /* Don't update ->enable for the CRTC in the set_config request,
2219 * since a mismatch would indicate a bug in the upper layers.
2220 * The actual modeset code later on will catch any
2221 * inconsistencies here. */
2222 if (crtc == set->crtc)
2225 if (!crtc_state->connector_mask) {
2226 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
2231 crtc_state->active = false;
2239 * drm_atomic_helper_set_config - set a new config from userspace
2240 * @set: mode set configuration
2242 * Provides a default crtc set_config handler using the atomic driver interface.
2245 * Returns 0 on success, negative errno numbers on failure.
2247 int drm_atomic_helper_set_config(struct drm_mode_set *set)
2249 struct drm_atomic_state *state;
2250 struct drm_crtc *crtc = set->crtc;
2253 state = drm_atomic_state_alloc(crtc->dev);
2257 state->legacy_set_config = true;
2258 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2260 ret = __drm_atomic_helper_set_config(set, state);
2264 ret = drm_atomic_commit(state);
2268 /* Driver takes ownership of state on successful commit. */
2271 if (ret == -EDEADLK)
2274 drm_atomic_state_free(state);
2278 drm_atomic_state_clear(state);
2279 drm_atomic_legacy_backoff(state);
2282 * Someone might have exchanged the framebuffer while we dropped locks
2283 * in the backoff code. We need to fix up the fb refcount tracking the
2286 crtc->primary->old_fb = crtc->primary->fb;
2290 EXPORT_SYMBOL(drm_atomic_helper_set_config);
2292 /* just used from fb-helper and atomic-helper: */
2293 int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2294 struct drm_atomic_state *state)
2296 struct drm_crtc_state *crtc_state;
2297 struct drm_plane_state *primary_state;
2298 struct drm_crtc *crtc = set->crtc;
2299 int hdisplay, vdisplay;
2302 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2303 if (IS_ERR(crtc_state))
2304 return PTR_ERR(crtc_state);
2306 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2307 if (IS_ERR(primary_state))
2308 return PTR_ERR(primary_state);
2312 WARN_ON(set->num_connectors);
2314 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2318 crtc_state->active = false;
2320 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2324 drm_atomic_set_fb_for_plane(primary_state, NULL);
2330 WARN_ON(!set->num_connectors);
2332 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2336 crtc_state->active = true;
2338 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2342 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2344 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2345 primary_state->crtc_x = 0;
2346 primary_state->crtc_y = 0;
2347 primary_state->crtc_w = hdisplay;
2348 primary_state->crtc_h = vdisplay;
2349 primary_state->src_x = set->x << 16;
2350 primary_state->src_y = set->y << 16;
2351 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
2352 primary_state->src_w = vdisplay << 16;
2353 primary_state->src_h = hdisplay << 16;
2355 primary_state->src_w = hdisplay << 16;
2356 primary_state->src_h = vdisplay << 16;
2360 ret = update_output_state(state, set);
2368 * drm_atomic_helper_disable_all - disable all currently active outputs
2370 * @ctx: lock acquisition context
2372 * Loops through all connectors, finding those that aren't turned off and then
2373 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2374 * that they are connected to.
2376 * This is used for example in suspend/resume to disable all currently active
2377 * functions when suspending.
2379 * Note that if callers haven't already acquired all modeset locks this might
2380 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2383 * 0 on success or a negative error code on failure.
2386 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2388 int drm_atomic_helper_disable_all(struct drm_device *dev,
2389 struct drm_modeset_acquire_ctx *ctx)
2391 struct drm_atomic_state *state;
2392 struct drm_connector *conn;
2395 state = drm_atomic_state_alloc(dev);
2399 state->acquire_ctx = ctx;
2401 drm_for_each_connector(conn, dev) {
2402 struct drm_crtc *crtc = conn->state->crtc;
2403 struct drm_crtc_state *crtc_state;
2405 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2408 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2409 if (IS_ERR(crtc_state)) {
2410 err = PTR_ERR(crtc_state);
2414 crtc_state->active = false;
2417 err = drm_atomic_commit(state);
2421 drm_atomic_state_free(state);
2425 EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2428 * drm_atomic_helper_suspend - subsystem-level suspend helper
2431 * Duplicates the current atomic state, disables all active outputs and then
2432 * returns a pointer to the original atomic state to the caller. Drivers can
2433 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2434 * restore the output configuration that was active at the time the system
2437 * Note that it is potentially unsafe to use this. The atomic state object
2438 * returned by this function is assumed to be persistent. Drivers must ensure
2439 * that this holds true. Before calling this function, drivers must make sure
2440 * to suspend fbdev emulation so that nothing can be using the device.
2443 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2444 * encoded error code on failure. Drivers should store the returned atomic
2445 * state object and pass it to the drm_atomic_helper_resume() helper upon
2449 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2450 * drm_atomic_helper_resume()
2452 struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2454 struct drm_modeset_acquire_ctx ctx;
2455 struct drm_atomic_state *state;
2458 drm_modeset_acquire_init(&ctx, 0);
2461 err = drm_modeset_lock_all_ctx(dev, &ctx);
2463 state = ERR_PTR(err);
2467 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2471 err = drm_atomic_helper_disable_all(dev, &ctx);
2473 drm_atomic_state_free(state);
2474 state = ERR_PTR(err);
2479 if (PTR_ERR(state) == -EDEADLK) {
2480 drm_modeset_backoff(&ctx);
2484 drm_modeset_drop_locks(&ctx);
2485 drm_modeset_acquire_fini(&ctx);
2488 EXPORT_SYMBOL(drm_atomic_helper_suspend);
2491 * drm_atomic_helper_resume - subsystem-level resume helper
2493 * @state: atomic state to resume to
2495 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2496 * grabs all modeset locks and commits the atomic state object. This can be
2497 * used in conjunction with the drm_atomic_helper_suspend() helper to
2498 * implement suspend/resume for drivers that support atomic mode-setting.
2501 * 0 on success or a negative error code on failure.
2504 * drm_atomic_helper_suspend()
2506 int drm_atomic_helper_resume(struct drm_device *dev,
2507 struct drm_atomic_state *state)
2509 struct drm_mode_config *config = &dev->mode_config;
2512 drm_mode_config_reset(dev);
2513 drm_modeset_lock_all(dev);
2514 state->acquire_ctx = config->acquire_ctx;
2515 err = drm_atomic_commit(state);
2516 drm_modeset_unlock_all(dev);
2520 EXPORT_SYMBOL(drm_atomic_helper_resume);
2523 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2525 * @property: DRM property
2526 * @val: value of property
2528 * Provides a default crtc set_property handler using the atomic driver
2532 * Zero on success, error code on failure
2535 drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2536 struct drm_property *property,
2539 struct drm_atomic_state *state;
2540 struct drm_crtc_state *crtc_state;
2543 state = drm_atomic_state_alloc(crtc->dev);
2547 /* ->set_property is always called with all locks held. */
2548 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2550 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2551 if (IS_ERR(crtc_state)) {
2552 ret = PTR_ERR(crtc_state);
2556 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2561 ret = drm_atomic_commit(state);
2565 /* Driver takes ownership of state on successful commit. */
2568 if (ret == -EDEADLK)
2571 drm_atomic_state_free(state);
2575 drm_atomic_state_clear(state);
2576 drm_atomic_legacy_backoff(state);
2580 EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2583 * drm_atomic_helper_plane_set_property - helper for plane properties
2585 * @property: DRM property
2586 * @val: value of property
2588 * Provides a default plane set_property handler using the atomic driver
2592 * Zero on success, error code on failure
2595 drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2596 struct drm_property *property,
2599 struct drm_atomic_state *state;
2600 struct drm_plane_state *plane_state;
2603 state = drm_atomic_state_alloc(plane->dev);
2607 /* ->set_property is always called with all locks held. */
2608 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2610 plane_state = drm_atomic_get_plane_state(state, plane);
2611 if (IS_ERR(plane_state)) {
2612 ret = PTR_ERR(plane_state);
2616 ret = drm_atomic_plane_set_property(plane, plane_state,
2621 ret = drm_atomic_commit(state);
2625 /* Driver takes ownership of state on successful commit. */
2628 if (ret == -EDEADLK)
2631 drm_atomic_state_free(state);
2635 drm_atomic_state_clear(state);
2636 drm_atomic_legacy_backoff(state);
2640 EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2643 * drm_atomic_helper_connector_set_property - helper for connector properties
2644 * @connector: DRM connector
2645 * @property: DRM property
2646 * @val: value of property
2648 * Provides a default connector set_property handler using the atomic driver
2652 * Zero on success, error code on failure
2655 drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2656 struct drm_property *property,
2659 struct drm_atomic_state *state;
2660 struct drm_connector_state *connector_state;
2663 state = drm_atomic_state_alloc(connector->dev);
2667 /* ->set_property is always called with all locks held. */
2668 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2670 connector_state = drm_atomic_get_connector_state(state, connector);
2671 if (IS_ERR(connector_state)) {
2672 ret = PTR_ERR(connector_state);
2676 ret = drm_atomic_connector_set_property(connector, connector_state,
2681 ret = drm_atomic_commit(state);
2685 /* Driver takes ownership of state on successful commit. */
2688 if (ret == -EDEADLK)
2691 drm_atomic_state_free(state);
2695 drm_atomic_state_clear(state);
2696 drm_atomic_legacy_backoff(state);
2700 EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2703 * drm_atomic_helper_page_flip - execute a legacy page flip
2705 * @fb: DRM framebuffer
2706 * @event: optional DRM event to signal upon completion
2707 * @flags: flip flags for non-vblank sync'ed updates
2709 * Provides a default page flip implementation using the atomic driver interface.
2711 * Note that for now so called async page flips (i.e. updates which are not
2712 * synchronized to vblank) are not supported, since the atomic interfaces have
2713 * no provisions for this yet.
2716 * Returns 0 on success, negative errno numbers on failure.
2718 int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2719 struct drm_framebuffer *fb,
2720 struct drm_pending_vblank_event *event,
2723 struct drm_plane *plane = crtc->primary;
2724 struct drm_atomic_state *state;
2725 struct drm_plane_state *plane_state;
2726 struct drm_crtc_state *crtc_state;
2729 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2732 state = drm_atomic_state_alloc(plane->dev);
2736 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2738 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2739 if (IS_ERR(crtc_state)) {
2740 ret = PTR_ERR(crtc_state);
2743 crtc_state->event = event;
2745 plane_state = drm_atomic_get_plane_state(state, plane);
2746 if (IS_ERR(plane_state)) {
2747 ret = PTR_ERR(plane_state);
2751 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2754 drm_atomic_set_fb_for_plane(plane_state, fb);
2756 /* Make sure we don't accidentally do a full modeset. */
2757 state->allow_modeset = false;
2758 if (!crtc_state->active) {
2759 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2765 ret = drm_atomic_nonblocking_commit(state);
2769 /* Driver takes ownership of state on successful commit. */
2772 if (ret == -EDEADLK)
2775 drm_atomic_state_free(state);
2779 drm_atomic_state_clear(state);
2780 drm_atomic_legacy_backoff(state);
2783 * Someone might have exchanged the framebuffer while we dropped locks
2784 * in the backoff code. We need to fix up the fb refcount tracking the
2787 plane->old_fb = plane->fb;
2791 EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2794 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2795 * @connector: affected connector
2798 * This is the main helper function provided by the atomic helper framework for
2799 * implementing the legacy DPMS connector interface. It computes the new desired
2800 * ->active state for the corresponding CRTC (if the connector is enabled) and
2804 * Returns 0 on success, negative errno numbers on failure.
2806 int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2809 struct drm_mode_config *config = &connector->dev->mode_config;
2810 struct drm_atomic_state *state;
2811 struct drm_crtc_state *crtc_state;
2812 struct drm_crtc *crtc;
2813 struct drm_connector *tmp_connector;
2815 bool active = false;
2816 int old_mode = connector->dpms;
2818 if (mode != DRM_MODE_DPMS_ON)
2819 mode = DRM_MODE_DPMS_OFF;
2821 connector->dpms = mode;
2822 crtc = connector->state->crtc;
2827 state = drm_atomic_state_alloc(connector->dev);
2831 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2833 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2834 if (IS_ERR(crtc_state)) {
2835 ret = PTR_ERR(crtc_state);
2839 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2841 drm_for_each_connector(tmp_connector, connector->dev) {
2842 if (tmp_connector->state->crtc != crtc)
2845 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2850 crtc_state->active = active;
2852 ret = drm_atomic_commit(state);
2856 /* Driver takes ownership of state on successful commit. */
2859 if (ret == -EDEADLK)
2862 connector->dpms = old_mode;
2863 drm_atomic_state_free(state);
2867 drm_atomic_state_clear(state);
2868 drm_atomic_legacy_backoff(state);
2872 EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2875 * drm_atomic_helper_best_encoder - Helper for &drm_connector_helper_funcs
2876 * ->best_encoder callback
2877 * @connector: Connector control structure
2879 * This is a &drm_connector_helper_funcs ->best_encoder callback helper for
2880 * connectors that support exactly 1 encoder, statically determined at driver
2883 struct drm_encoder *
2884 drm_atomic_helper_best_encoder(struct drm_connector *connector)
2886 WARN_ON(connector->encoder_ids[1]);
2887 return drm_encoder_find(connector->dev, connector->encoder_ids[0]);
2889 EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
2892 * DOC: atomic state reset and initialization
2894 * Both the drm core and the atomic helpers assume that there is always the full
2895 * and correct atomic software state for all connectors, CRTCs and planes
2896 * available. Which is a bit a problem on driver load and also after system
2897 * suspend. One way to solve this is to have a hardware state read-out
2898 * infrastructure which reconstructs the full software state (e.g. the i915
2901 * The simpler solution is to just reset the software state to everything off,
2902 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2903 * the atomic helpers provide default reset implementations for all hooks.
2905 * On the upside the precise state tracking of atomic simplifies system suspend
2906 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2907 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2908 * For other drivers the building blocks are split out, see the documentation
2909 * for these functions.
2913 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2916 * Resets the atomic state for @crtc by freeing the state pointer (which might
2917 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2919 void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2922 __drm_atomic_helper_crtc_destroy_state(crtc->state);
2925 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2928 crtc->state->crtc = crtc;
2930 EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2933 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2934 * @crtc: CRTC object
2935 * @state: atomic CRTC state
2937 * Copies atomic state from a CRTC's current state and resets inferred values.
2938 * This is useful for drivers that subclass the CRTC state.
2940 void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2941 struct drm_crtc_state *state)
2943 memcpy(state, crtc->state, sizeof(*state));
2945 if (state->mode_blob)
2946 drm_property_reference_blob(state->mode_blob);
2947 if (state->degamma_lut)
2948 drm_property_reference_blob(state->degamma_lut);
2950 drm_property_reference_blob(state->ctm);
2951 if (state->gamma_lut)
2952 drm_property_reference_blob(state->gamma_lut);
2953 state->mode_changed = false;
2954 state->active_changed = false;
2955 state->planes_changed = false;
2956 state->connectors_changed = false;
2957 state->color_mgmt_changed = false;
2958 state->event = NULL;
2960 EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2963 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2966 * Default CRTC state duplicate hook for drivers which don't have their own
2967 * subclassed CRTC state structure.
2969 struct drm_crtc_state *
2970 drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2972 struct drm_crtc_state *state;
2974 if (WARN_ON(!crtc->state))
2977 state = kmalloc(sizeof(*state), GFP_KERNEL);
2979 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2983 EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2986 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2987 * @state: CRTC state object to release
2989 * Releases all resources stored in the CRTC state without actually freeing
2990 * the memory of the CRTC state. This is useful for drivers that subclass the
2993 void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
2995 drm_property_unreference_blob(state->mode_blob);
2996 drm_property_unreference_blob(state->degamma_lut);
2997 drm_property_unreference_blob(state->ctm);
2998 drm_property_unreference_blob(state->gamma_lut);
3000 EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3003 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3005 * @state: CRTC state object to release
3007 * Default CRTC state destroy hook for drivers which don't have their own
3008 * subclassed CRTC state structure.
3010 void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3011 struct drm_crtc_state *state)
3013 __drm_atomic_helper_crtc_destroy_state(state);
3016 EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3019 * drm_atomic_helper_plane_reset - default ->reset hook for planes
3022 * Resets the atomic state for @plane by freeing the state pointer (which might
3023 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3025 void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3028 __drm_atomic_helper_plane_destroy_state(plane->state);
3030 kfree(plane->state);
3031 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3034 plane->state->plane = plane;
3035 plane->state->rotation = BIT(DRM_ROTATE_0);
3038 EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3041 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3042 * @plane: plane object
3043 * @state: atomic plane state
3045 * Copies atomic state from a plane's current state. This is useful for
3046 * drivers that subclass the plane state.
3048 void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3049 struct drm_plane_state *state)
3051 memcpy(state, plane->state, sizeof(*state));
3054 drm_framebuffer_reference(state->fb);
3056 EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3059 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3062 * Default plane state duplicate hook for drivers which don't have their own
3063 * subclassed plane state structure.
3065 struct drm_plane_state *
3066 drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3068 struct drm_plane_state *state;
3070 if (WARN_ON(!plane->state))
3073 state = kmalloc(sizeof(*state), GFP_KERNEL);
3075 __drm_atomic_helper_plane_duplicate_state(plane, state);
3079 EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3082 * __drm_atomic_helper_plane_destroy_state - release plane state
3083 * @state: plane state object to release
3085 * Releases all resources stored in the plane state without actually freeing
3086 * the memory of the plane state. This is useful for drivers that subclass the
3089 void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3092 drm_framebuffer_unreference(state->fb);
3094 EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3097 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3099 * @state: plane state object to release
3101 * Default plane state destroy hook for drivers which don't have their own
3102 * subclassed plane state structure.
3104 void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3105 struct drm_plane_state *state)
3107 __drm_atomic_helper_plane_destroy_state(state);
3110 EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3113 * __drm_atomic_helper_connector_reset - reset state on connector
3114 * @connector: drm connector
3115 * @conn_state: connector state to assign
3117 * Initializes the newly allocated @conn_state and assigns it to
3118 * #connector ->state, usually required when initializing the drivers
3119 * or when called from the ->reset hook.
3121 * This is useful for drivers that subclass the connector state.
3124 __drm_atomic_helper_connector_reset(struct drm_connector *connector,
3125 struct drm_connector_state *conn_state)
3128 conn_state->connector = connector;
3130 connector->state = conn_state;
3132 EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3135 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
3136 * @connector: drm connector
3138 * Resets the atomic state for @connector by freeing the state pointer (which
3139 * might be NULL, e.g. at driver load time) and allocating a new empty state
3142 void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3144 struct drm_connector_state *conn_state =
3145 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3147 if (connector->state)
3148 __drm_atomic_helper_connector_destroy_state(connector->state);
3150 kfree(connector->state);
3151 __drm_atomic_helper_connector_reset(connector, conn_state);
3153 EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3156 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3157 * @connector: connector object
3158 * @state: atomic connector state
3160 * Copies atomic state from a connector's current state. This is useful for
3161 * drivers that subclass the connector state.
3164 __drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3165 struct drm_connector_state *state)
3167 memcpy(state, connector->state, sizeof(*state));
3169 drm_connector_reference(connector);
3171 EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3174 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3175 * @connector: drm connector
3177 * Default connector state duplicate hook for drivers which don't have their own
3178 * subclassed connector state structure.
3180 struct drm_connector_state *
3181 drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3183 struct drm_connector_state *state;
3185 if (WARN_ON(!connector->state))
3188 state = kmalloc(sizeof(*state), GFP_KERNEL);
3190 __drm_atomic_helper_connector_duplicate_state(connector, state);
3194 EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3197 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3199 * @ctx: lock acquisition context
3201 * Makes a copy of the current atomic state by looping over all objects and
3202 * duplicating their respective states. This is used for example by suspend/
3203 * resume support code to save the state prior to suspend such that it can
3204 * be restored upon resume.
3206 * Note that this treats atomic state as persistent between save and restore.
3207 * Drivers must make sure that this is possible and won't result in confusion
3208 * or erroneous behaviour.
3210 * Note that if callers haven't already acquired all modeset locks this might
3211 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3214 * A pointer to the copy of the atomic state object on success or an
3215 * ERR_PTR()-encoded error code on failure.
3218 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3220 struct drm_atomic_state *
3221 drm_atomic_helper_duplicate_state(struct drm_device *dev,
3222 struct drm_modeset_acquire_ctx *ctx)
3224 struct drm_atomic_state *state;
3225 struct drm_connector *conn;
3226 struct drm_plane *plane;
3227 struct drm_crtc *crtc;
3230 state = drm_atomic_state_alloc(dev);
3232 return ERR_PTR(-ENOMEM);
3234 state->acquire_ctx = ctx;
3236 drm_for_each_crtc(crtc, dev) {
3237 struct drm_crtc_state *crtc_state;
3239 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3240 if (IS_ERR(crtc_state)) {
3241 err = PTR_ERR(crtc_state);
3246 drm_for_each_plane(plane, dev) {
3247 struct drm_plane_state *plane_state;
3249 plane_state = drm_atomic_get_plane_state(state, plane);
3250 if (IS_ERR(plane_state)) {
3251 err = PTR_ERR(plane_state);
3256 drm_for_each_connector(conn, dev) {
3257 struct drm_connector_state *conn_state;
3259 conn_state = drm_atomic_get_connector_state(state, conn);
3260 if (IS_ERR(conn_state)) {
3261 err = PTR_ERR(conn_state);
3266 /* clear the acquire context so that it isn't accidentally reused */
3267 state->acquire_ctx = NULL;
3271 drm_atomic_state_free(state);
3272 state = ERR_PTR(err);
3277 EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3280 * __drm_atomic_helper_connector_destroy_state - release connector state
3281 * @state: connector state object to release
3283 * Releases all resources stored in the connector state without actually
3284 * freeing the memory of the connector state. This is useful for drivers that
3285 * subclass the connector state.
3288 __drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3291 * This is currently a placeholder so that drivers that subclass the
3292 * state will automatically do the right thing if code is ever added
3296 drm_connector_unreference(state->connector);
3298 EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3301 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3302 * @connector: drm connector
3303 * @state: connector state object to release
3305 * Default connector state destroy hook for drivers which don't have their own
3306 * subclassed connector state structure.
3308 void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3309 struct drm_connector_state *state)
3311 __drm_atomic_helper_connector_destroy_state(state);
3314 EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3317 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3318 * @crtc: CRTC object
3319 * @red: red correction table
3320 * @green: green correction table
3321 * @blue: green correction table
3322 * @size: size of the tables
3324 * Implements support for legacy gamma correction table for drivers
3325 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3328 int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3329 u16 *red, u16 *green, u16 *blue,
3332 struct drm_device *dev = crtc->dev;
3333 struct drm_mode_config *config = &dev->mode_config;
3334 struct drm_atomic_state *state;
3335 struct drm_crtc_state *crtc_state;
3336 struct drm_property_blob *blob = NULL;
3337 struct drm_color_lut *blob_data;
3340 state = drm_atomic_state_alloc(crtc->dev);
3344 blob = drm_property_create_blob(dev,
3345 sizeof(struct drm_color_lut) * size,
3348 ret = PTR_ERR(blob);
3353 /* Prepare GAMMA_LUT with the legacy values. */
3354 blob_data = (struct drm_color_lut *) blob->data;
3355 for (i = 0; i < size; i++) {
3356 blob_data[i].red = red[i];
3357 blob_data[i].green = green[i];
3358 blob_data[i].blue = blue[i];
3361 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
3363 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3364 if (IS_ERR(crtc_state)) {
3365 ret = PTR_ERR(crtc_state);
3369 /* Reset DEGAMMA_LUT and CTM properties. */
3370 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3371 config->degamma_lut_property, 0);
3375 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3376 config->ctm_property, 0);
3380 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
3381 config->gamma_lut_property, blob->base.id);
3385 ret = drm_atomic_commit(state);
3389 /* Driver takes ownership of state on successful commit. */
3391 drm_property_unreference_blob(blob);
3395 if (ret == -EDEADLK)
3398 drm_atomic_state_free(state);
3399 drm_property_unreference_blob(blob);
3403 drm_atomic_state_clear(state);
3404 drm_atomic_legacy_backoff(state);
3408 EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);