Loading...
1/*
2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
26 */
27
28#include <drm/drmP.h>
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>
34
35/**
36 * DOC: overview
37 *
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.
43 *
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.
49 *
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.
55 *
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
60 * helpers.
61 */
62static void
63drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
64 struct drm_plane_state *plane_state,
65 struct drm_plane *plane)
66{
67 struct drm_crtc_state *crtc_state;
68
69 if (plane->state->crtc) {
70 crtc_state = drm_atomic_get_existing_crtc_state(state,
71 plane->state->crtc);
72
73 if (WARN_ON(!crtc_state))
74 return;
75
76 crtc_state->planes_changed = true;
77 }
78
79 if (plane_state->crtc) {
80 crtc_state = drm_atomic_get_existing_crtc_state(state,
81 plane_state->crtc);
82
83 if (WARN_ON(!crtc_state))
84 return;
85
86 crtc_state->planes_changed = true;
87 }
88}
89
90static int handle_conflicting_encoders(struct drm_atomic_state *state,
91 bool disable_conflicting_encoders)
92{
93 struct drm_connector_state *conn_state;
94 struct drm_connector *connector;
95 struct drm_encoder *encoder;
96 unsigned encoder_mask = 0;
97 int i, ret;
98
99 /*
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.
103 */
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;
107
108 if (!conn_state->crtc)
109 continue;
110
111 if (funcs->atomic_best_encoder)
112 new_encoder = funcs->atomic_best_encoder(connector, conn_state);
113 else
114 new_encoder = funcs->best_encoder(connector);
115
116 if (new_encoder) {
117 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
118 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
119 new_encoder->base.id, new_encoder->name,
120 connector->base.id, connector->name);
121
122 return -EINVAL;
123 }
124
125 encoder_mask |= 1 << drm_encoder_index(new_encoder);
126 }
127 }
128
129 if (!encoder_mask)
130 return 0;
131
132 /*
133 * Second loop, iterate over all connectors not part of the state.
134 *
135 * If a conflicting encoder is found and disable_conflicting_encoders
136 * is not set, an error is returned. Userspace can provide a solution
137 * through the atomic ioctl.
138 *
139 * If the flag is set conflicting connectors are removed from the crtc
140 * and the crtc is disabled if no encoder is left. This preserves
141 * compatibility with the legacy set_config behavior.
142 */
143 drm_for_each_connector(connector, state->dev) {
144 struct drm_crtc_state *crtc_state;
145
146 if (drm_atomic_get_existing_connector_state(state, connector))
147 continue;
148
149 encoder = connector->state->best_encoder;
150 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
151 continue;
152
153 if (!disable_conflicting_encoders) {
154 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
155 encoder->base.id, encoder->name,
156 connector->state->crtc->base.id,
157 connector->state->crtc->name,
158 connector->base.id, connector->name);
159 return -EINVAL;
160 }
161
162 conn_state = drm_atomic_get_connector_state(state, connector);
163 if (IS_ERR(conn_state))
164 return PTR_ERR(conn_state);
165
166 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
167 encoder->base.id, encoder->name,
168 conn_state->crtc->base.id, conn_state->crtc->name,
169 connector->base.id, connector->name);
170
171 crtc_state = drm_atomic_get_existing_crtc_state(state, conn_state->crtc);
172
173 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
174 if (ret)
175 return ret;
176
177 if (!crtc_state->connector_mask) {
178 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
179 NULL);
180 if (ret < 0)
181 return ret;
182
183 crtc_state->active = false;
184 }
185 }
186
187 return 0;
188}
189
190static void
191set_best_encoder(struct drm_atomic_state *state,
192 struct drm_connector_state *conn_state,
193 struct drm_encoder *encoder)
194{
195 struct drm_crtc_state *crtc_state;
196 struct drm_crtc *crtc;
197
198 if (conn_state->best_encoder) {
199 /* Unset the encoder_mask in the old crtc state. */
200 crtc = conn_state->connector->state->crtc;
201
202 /* A NULL crtc is an error here because we should have
203 * duplicated a NULL best_encoder when crtc was NULL.
204 * As an exception restoring duplicated atomic state
205 * during resume is allowed, so don't warn when
206 * best_encoder is equal to encoder we intend to set.
207 */
208 WARN_ON(!crtc && encoder != conn_state->best_encoder);
209 if (crtc) {
210 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
211
212 crtc_state->encoder_mask &=
213 ~(1 << drm_encoder_index(conn_state->best_encoder));
214 }
215 }
216
217 if (encoder) {
218 crtc = conn_state->crtc;
219 WARN_ON(!crtc);
220 if (crtc) {
221 crtc_state = drm_atomic_get_existing_crtc_state(state, crtc);
222
223 crtc_state->encoder_mask |=
224 1 << drm_encoder_index(encoder);
225 }
226 }
227
228 conn_state->best_encoder = encoder;
229}
230
231static void
232steal_encoder(struct drm_atomic_state *state,
233 struct drm_encoder *encoder)
234{
235 struct drm_crtc_state *crtc_state;
236 struct drm_connector *connector;
237 struct drm_connector_state *connector_state;
238 int i;
239
240 for_each_connector_in_state(state, connector, connector_state, i) {
241 struct drm_crtc *encoder_crtc;
242
243 if (connector_state->best_encoder != encoder)
244 continue;
245
246 encoder_crtc = connector->state->crtc;
247
248 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
249 encoder->base.id, encoder->name,
250 encoder_crtc->base.id, encoder_crtc->name);
251
252 set_best_encoder(state, connector_state, NULL);
253
254 crtc_state = drm_atomic_get_existing_crtc_state(state, encoder_crtc);
255 crtc_state->connectors_changed = true;
256
257 return;
258 }
259}
260
261static int
262update_connector_routing(struct drm_atomic_state *state,
263 struct drm_connector *connector,
264 struct drm_connector_state *connector_state)
265{
266 const struct drm_connector_helper_funcs *funcs;
267 struct drm_encoder *new_encoder;
268 struct drm_crtc_state *crtc_state;
269
270 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
271 connector->base.id,
272 connector->name);
273
274 if (connector->state->crtc != connector_state->crtc) {
275 if (connector->state->crtc) {
276 crtc_state = drm_atomic_get_existing_crtc_state(state, connector->state->crtc);
277 crtc_state->connectors_changed = true;
278 }
279
280 if (connector_state->crtc) {
281 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
282 crtc_state->connectors_changed = true;
283 }
284 }
285
286 if (!connector_state->crtc) {
287 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
288 connector->base.id,
289 connector->name);
290
291 set_best_encoder(state, connector_state, NULL);
292
293 return 0;
294 }
295
296 funcs = connector->helper_private;
297
298 if (funcs->atomic_best_encoder)
299 new_encoder = funcs->atomic_best_encoder(connector,
300 connector_state);
301 else
302 new_encoder = funcs->best_encoder(connector);
303
304 if (!new_encoder) {
305 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
306 connector->base.id,
307 connector->name);
308 return -EINVAL;
309 }
310
311 if (!drm_encoder_crtc_ok(new_encoder, connector_state->crtc)) {
312 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d]\n",
313 new_encoder->base.id,
314 new_encoder->name,
315 connector_state->crtc->base.id);
316 return -EINVAL;
317 }
318
319 if (new_encoder == connector_state->best_encoder) {
320 set_best_encoder(state, connector_state, new_encoder);
321
322 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
323 connector->base.id,
324 connector->name,
325 new_encoder->base.id,
326 new_encoder->name,
327 connector_state->crtc->base.id,
328 connector_state->crtc->name);
329
330 return 0;
331 }
332
333 steal_encoder(state, new_encoder);
334
335 set_best_encoder(state, connector_state, new_encoder);
336
337 crtc_state = drm_atomic_get_existing_crtc_state(state, connector_state->crtc);
338 crtc_state->connectors_changed = true;
339
340 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
341 connector->base.id,
342 connector->name,
343 new_encoder->base.id,
344 new_encoder->name,
345 connector_state->crtc->base.id,
346 connector_state->crtc->name);
347
348 return 0;
349}
350
351static int
352mode_fixup(struct drm_atomic_state *state)
353{
354 struct drm_crtc *crtc;
355 struct drm_crtc_state *crtc_state;
356 struct drm_connector *connector;
357 struct drm_connector_state *conn_state;
358 int i;
359 bool ret;
360
361 for_each_crtc_in_state(state, crtc, crtc_state, i) {
362 if (!crtc_state->mode_changed &&
363 !crtc_state->connectors_changed)
364 continue;
365
366 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
367 }
368
369 for_each_connector_in_state(state, connector, conn_state, i) {
370 const struct drm_encoder_helper_funcs *funcs;
371 struct drm_encoder *encoder;
372
373 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
374
375 if (!conn_state->crtc || !conn_state->best_encoder)
376 continue;
377
378 crtc_state = drm_atomic_get_existing_crtc_state(state,
379 conn_state->crtc);
380
381 /*
382 * Each encoder has at most one connector (since we always steal
383 * it away), so we won't call ->mode_fixup twice.
384 */
385 encoder = conn_state->best_encoder;
386 funcs = encoder->helper_private;
387 if (!funcs)
388 continue;
389
390 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
391 &crtc_state->adjusted_mode);
392 if (!ret) {
393 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
394 return -EINVAL;
395 }
396
397 if (funcs->atomic_check) {
398 ret = funcs->atomic_check(encoder, crtc_state,
399 conn_state);
400 if (ret) {
401 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
402 encoder->base.id, encoder->name);
403 return ret;
404 }
405 } else if (funcs->mode_fixup) {
406 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
407 &crtc_state->adjusted_mode);
408 if (!ret) {
409 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
410 encoder->base.id, encoder->name);
411 return -EINVAL;
412 }
413 }
414 }
415
416 for_each_crtc_in_state(state, crtc, crtc_state, i) {
417 const struct drm_crtc_helper_funcs *funcs;
418
419 if (!crtc_state->mode_changed &&
420 !crtc_state->connectors_changed)
421 continue;
422
423 funcs = crtc->helper_private;
424 if (!funcs->mode_fixup)
425 continue;
426
427 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
428 &crtc_state->adjusted_mode);
429 if (!ret) {
430 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
431 crtc->base.id, crtc->name);
432 return -EINVAL;
433 }
434 }
435
436 return 0;
437}
438
439/**
440 * drm_atomic_helper_check_modeset - validate state object for modeset changes
441 * @dev: DRM device
442 * @state: the driver state object
443 *
444 * Check the state object to see if the requested state is physically possible.
445 * This does all the crtc and connector related computations for an atomic
446 * update and adds any additional connectors needed for full modesets and calls
447 * down into ->mode_fixup functions of the driver backend.
448 *
449 * crtc_state->mode_changed is set when the input mode is changed.
450 * crtc_state->connectors_changed is set when a connector is added or
451 * removed from the crtc.
452 * crtc_state->active_changed is set when crtc_state->active changes,
453 * which is used for dpms.
454 *
455 * IMPORTANT:
456 *
457 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
458 * plane update can't be done without a full modeset) _must_ call this function
459 * afterwards after that change. It is permitted to call this function multiple
460 * times for the same update, e.g. when the ->atomic_check functions depend upon
461 * the adjusted dotclock for fifo space allocation and watermark computation.
462 *
463 * RETURNS
464 * Zero for success or -errno
465 */
466int
467drm_atomic_helper_check_modeset(struct drm_device *dev,
468 struct drm_atomic_state *state)
469{
470 struct drm_crtc *crtc;
471 struct drm_crtc_state *crtc_state;
472 struct drm_connector *connector;
473 struct drm_connector_state *connector_state;
474 int i, ret;
475
476 for_each_crtc_in_state(state, crtc, crtc_state, i) {
477 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
478 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
479 crtc->base.id, crtc->name);
480 crtc_state->mode_changed = true;
481 }
482
483 if (crtc->state->enable != crtc_state->enable) {
484 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
485 crtc->base.id, crtc->name);
486
487 /*
488 * For clarity this assignment is done here, but
489 * enable == 0 is only true when there are no
490 * connectors and a NULL mode.
491 *
492 * The other way around is true as well. enable != 0
493 * iff connectors are attached and a mode is set.
494 */
495 crtc_state->mode_changed = true;
496 crtc_state->connectors_changed = true;
497 }
498 }
499
500 ret = handle_conflicting_encoders(state, state->legacy_set_config);
501 if (ret)
502 return ret;
503
504 for_each_connector_in_state(state, connector, connector_state, i) {
505 /*
506 * This only sets crtc->mode_changed for routing changes,
507 * drivers must set crtc->mode_changed themselves when connector
508 * properties need to be updated.
509 */
510 ret = update_connector_routing(state, connector,
511 connector_state);
512 if (ret)
513 return ret;
514 }
515
516 /*
517 * After all the routing has been prepared we need to add in any
518 * connector which is itself unchanged, but who's crtc changes it's
519 * configuration. This must be done before calling mode_fixup in case a
520 * crtc only changed its mode but has the same set of connectors.
521 */
522 for_each_crtc_in_state(state, crtc, crtc_state, i) {
523 bool has_connectors =
524 !!crtc_state->connector_mask;
525
526 /*
527 * We must set ->active_changed after walking connectors for
528 * otherwise an update that only changes active would result in
529 * a full modeset because update_connector_routing force that.
530 */
531 if (crtc->state->active != crtc_state->active) {
532 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
533 crtc->base.id, crtc->name);
534 crtc_state->active_changed = true;
535 }
536
537 if (!drm_atomic_crtc_needs_modeset(crtc_state))
538 continue;
539
540 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
541 crtc->base.id, crtc->name,
542 crtc_state->enable ? 'y' : 'n',
543 crtc_state->active ? 'y' : 'n');
544
545 ret = drm_atomic_add_affected_connectors(state, crtc);
546 if (ret != 0)
547 return ret;
548
549 ret = drm_atomic_add_affected_planes(state, crtc);
550 if (ret != 0)
551 return ret;
552
553 if (crtc_state->enable != has_connectors) {
554 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
555 crtc->base.id, crtc->name);
556
557 return -EINVAL;
558 }
559 }
560
561 return mode_fixup(state);
562}
563EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
564
565/**
566 * drm_atomic_helper_check_planes - validate state object for planes changes
567 * @dev: DRM device
568 * @state: the driver state object
569 *
570 * Check the state object to see if the requested state is physically possible.
571 * This does all the plane update related checks using by calling into the
572 * ->atomic_check hooks provided by the driver.
573 *
574 * It also sets crtc_state->planes_changed to indicate that a crtc has
575 * updated planes.
576 *
577 * RETURNS
578 * Zero for success or -errno
579 */
580int
581drm_atomic_helper_check_planes(struct drm_device *dev,
582 struct drm_atomic_state *state)
583{
584 struct drm_crtc *crtc;
585 struct drm_crtc_state *crtc_state;
586 struct drm_plane *plane;
587 struct drm_plane_state *plane_state;
588 int i, ret = 0;
589
590 for_each_plane_in_state(state, plane, plane_state, i) {
591 const struct drm_plane_helper_funcs *funcs;
592
593 funcs = plane->helper_private;
594
595 drm_atomic_helper_plane_changed(state, plane_state, plane);
596
597 if (!funcs || !funcs->atomic_check)
598 continue;
599
600 ret = funcs->atomic_check(plane, plane_state);
601 if (ret) {
602 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
603 plane->base.id, plane->name);
604 return ret;
605 }
606 }
607
608 for_each_crtc_in_state(state, crtc, crtc_state, i) {
609 const struct drm_crtc_helper_funcs *funcs;
610
611 funcs = crtc->helper_private;
612
613 if (!funcs || !funcs->atomic_check)
614 continue;
615
616 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
617 if (ret) {
618 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
619 crtc->base.id, crtc->name);
620 return ret;
621 }
622 }
623
624 return ret;
625}
626EXPORT_SYMBOL(drm_atomic_helper_check_planes);
627
628/**
629 * drm_atomic_helper_check - validate state object
630 * @dev: DRM device
631 * @state: the driver state object
632 *
633 * Check the state object to see if the requested state is physically possible.
634 * Only crtcs and planes have check callbacks, so for any additional (global)
635 * checking that a driver needs it can simply wrap that around this function.
636 * Drivers without such needs can directly use this as their ->atomic_check()
637 * callback.
638 *
639 * This just wraps the two parts of the state checking for planes and modeset
640 * state in the default order: First it calls drm_atomic_helper_check_modeset()
641 * and then drm_atomic_helper_check_planes(). The assumption is that the
642 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
643 * e.g. properly compute watermarks.
644 *
645 * RETURNS
646 * Zero for success or -errno
647 */
648int drm_atomic_helper_check(struct drm_device *dev,
649 struct drm_atomic_state *state)
650{
651 int ret;
652
653 ret = drm_atomic_helper_check_modeset(dev, state);
654 if (ret)
655 return ret;
656
657 ret = drm_atomic_helper_check_planes(dev, state);
658 if (ret)
659 return ret;
660
661 return ret;
662}
663EXPORT_SYMBOL(drm_atomic_helper_check);
664
665static void
666disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
667{
668 struct drm_connector *connector;
669 struct drm_connector_state *old_conn_state;
670 struct drm_crtc *crtc;
671 struct drm_crtc_state *old_crtc_state;
672 int i;
673
674 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
675 const struct drm_encoder_helper_funcs *funcs;
676 struct drm_encoder *encoder;
677
678 /* Shut down everything that's in the changeset and currently
679 * still on. So need to check the old, saved state. */
680 if (!old_conn_state->crtc)
681 continue;
682
683 old_crtc_state = drm_atomic_get_existing_crtc_state(old_state,
684 old_conn_state->crtc);
685
686 if (!old_crtc_state->active ||
687 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
688 continue;
689
690 encoder = old_conn_state->best_encoder;
691
692 /* We shouldn't get this far if we didn't previously have
693 * an encoder.. but WARN_ON() rather than explode.
694 */
695 if (WARN_ON(!encoder))
696 continue;
697
698 funcs = encoder->helper_private;
699
700 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
701 encoder->base.id, encoder->name);
702
703 /*
704 * Each encoder has at most one connector (since we always steal
705 * it away), so we won't call disable hooks twice.
706 */
707 drm_bridge_disable(encoder->bridge);
708
709 /* Right function depends upon target state. */
710 if (connector->state->crtc && funcs->prepare)
711 funcs->prepare(encoder);
712 else if (funcs->disable)
713 funcs->disable(encoder);
714 else
715 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
716
717 drm_bridge_post_disable(encoder->bridge);
718 }
719
720 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
721 const struct drm_crtc_helper_funcs *funcs;
722
723 /* Shut down everything that needs a full modeset. */
724 if (!drm_atomic_crtc_needs_modeset(crtc->state))
725 continue;
726
727 if (!old_crtc_state->active)
728 continue;
729
730 funcs = crtc->helper_private;
731
732 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
733 crtc->base.id, crtc->name);
734
735
736 /* Right function depends upon target state. */
737 if (crtc->state->enable && funcs->prepare)
738 funcs->prepare(crtc);
739 else if (funcs->disable)
740 funcs->disable(crtc);
741 else
742 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
743 }
744}
745
746/**
747 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
748 * @dev: DRM device
749 * @old_state: atomic state object with old state structures
750 *
751 * This function updates all the various legacy modeset state pointers in
752 * connectors, encoders and crtcs. It also updates the timestamping constants
753 * used for precise vblank timestamps by calling
754 * drm_calc_timestamping_constants().
755 *
756 * Drivers can use this for building their own atomic commit if they don't have
757 * a pure helper-based modeset implementation.
758 */
759void
760drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
761 struct drm_atomic_state *old_state)
762{
763 struct drm_connector *connector;
764 struct drm_connector_state *old_conn_state;
765 struct drm_crtc *crtc;
766 struct drm_crtc_state *old_crtc_state;
767 int i;
768
769 /* clear out existing links and update dpms */
770 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
771 if (connector->encoder) {
772 WARN_ON(!connector->encoder->crtc);
773
774 connector->encoder->crtc = NULL;
775 connector->encoder = NULL;
776 }
777
778 crtc = connector->state->crtc;
779 if ((!crtc && old_conn_state->crtc) ||
780 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
781 struct drm_property *dpms_prop =
782 dev->mode_config.dpms_property;
783 int mode = DRM_MODE_DPMS_OFF;
784
785 if (crtc && crtc->state->active)
786 mode = DRM_MODE_DPMS_ON;
787
788 connector->dpms = mode;
789 drm_object_property_set_value(&connector->base,
790 dpms_prop, mode);
791 }
792 }
793
794 /* set new links */
795 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
796 if (!connector->state->crtc)
797 continue;
798
799 if (WARN_ON(!connector->state->best_encoder))
800 continue;
801
802 connector->encoder = connector->state->best_encoder;
803 connector->encoder->crtc = connector->state->crtc;
804 }
805
806 /* set legacy state in the crtc structure */
807 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
808 struct drm_plane *primary = crtc->primary;
809
810 crtc->mode = crtc->state->mode;
811 crtc->enabled = crtc->state->enable;
812
813 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
814 primary->state->crtc == crtc) {
815 crtc->x = primary->state->src_x >> 16;
816 crtc->y = primary->state->src_y >> 16;
817 }
818
819 if (crtc->state->enable)
820 drm_calc_timestamping_constants(crtc,
821 &crtc->state->adjusted_mode);
822 }
823}
824EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
825
826static void
827crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
828{
829 struct drm_crtc *crtc;
830 struct drm_crtc_state *old_crtc_state;
831 struct drm_connector *connector;
832 struct drm_connector_state *old_conn_state;
833 int i;
834
835 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
836 const struct drm_crtc_helper_funcs *funcs;
837
838 if (!crtc->state->mode_changed)
839 continue;
840
841 funcs = crtc->helper_private;
842
843 if (crtc->state->enable && funcs->mode_set_nofb) {
844 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
845 crtc->base.id, crtc->name);
846
847 funcs->mode_set_nofb(crtc);
848 }
849 }
850
851 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
852 const struct drm_encoder_helper_funcs *funcs;
853 struct drm_crtc_state *new_crtc_state;
854 struct drm_encoder *encoder;
855 struct drm_display_mode *mode, *adjusted_mode;
856
857 if (!connector->state->best_encoder)
858 continue;
859
860 encoder = connector->state->best_encoder;
861 funcs = encoder->helper_private;
862 new_crtc_state = connector->state->crtc->state;
863 mode = &new_crtc_state->mode;
864 adjusted_mode = &new_crtc_state->adjusted_mode;
865
866 if (!new_crtc_state->mode_changed)
867 continue;
868
869 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
870 encoder->base.id, encoder->name);
871
872 /*
873 * Each encoder has at most one connector (since we always steal
874 * it away), so we won't call mode_set hooks twice.
875 */
876 if (funcs->mode_set)
877 funcs->mode_set(encoder, mode, adjusted_mode);
878
879 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
880 }
881}
882
883/**
884 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
885 * @dev: DRM device
886 * @old_state: atomic state object with old state structures
887 *
888 * This function shuts down all the outputs that need to be shut down and
889 * prepares them (if required) with the new mode.
890 *
891 * For compatibility with legacy crtc helpers this should be called before
892 * drm_atomic_helper_commit_planes(), which is what the default commit function
893 * does. But drivers with different needs can group the modeset commits together
894 * and do the plane commits at the end. This is useful for drivers doing runtime
895 * PM since planes updates then only happen when the CRTC is actually enabled.
896 */
897void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
898 struct drm_atomic_state *old_state)
899{
900 disable_outputs(dev, old_state);
901
902 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
903
904 crtc_set_mode(dev, old_state);
905}
906EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
907
908/**
909 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
910 * @dev: DRM device
911 * @old_state: atomic state object with old state structures
912 *
913 * This function enables all the outputs with the new configuration which had to
914 * be turned off for the update.
915 *
916 * For compatibility with legacy crtc helpers this should be called after
917 * drm_atomic_helper_commit_planes(), which is what the default commit function
918 * does. But drivers with different needs can group the modeset commits together
919 * and do the plane commits at the end. This is useful for drivers doing runtime
920 * PM since planes updates then only happen when the CRTC is actually enabled.
921 */
922void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
923 struct drm_atomic_state *old_state)
924{
925 struct drm_crtc *crtc;
926 struct drm_crtc_state *old_crtc_state;
927 struct drm_connector *connector;
928 struct drm_connector_state *old_conn_state;
929 int i;
930
931 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
932 const struct drm_crtc_helper_funcs *funcs;
933
934 /* Need to filter out CRTCs where only planes change. */
935 if (!drm_atomic_crtc_needs_modeset(crtc->state))
936 continue;
937
938 if (!crtc->state->active)
939 continue;
940
941 funcs = crtc->helper_private;
942
943 if (crtc->state->enable) {
944 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
945 crtc->base.id, crtc->name);
946
947 if (funcs->enable)
948 funcs->enable(crtc);
949 else
950 funcs->commit(crtc);
951 }
952 }
953
954 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
955 const struct drm_encoder_helper_funcs *funcs;
956 struct drm_encoder *encoder;
957
958 if (!connector->state->best_encoder)
959 continue;
960
961 if (!connector->state->crtc->state->active ||
962 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
963 continue;
964
965 encoder = connector->state->best_encoder;
966 funcs = encoder->helper_private;
967
968 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
969 encoder->base.id, encoder->name);
970
971 /*
972 * Each encoder has at most one connector (since we always steal
973 * it away), so we won't call enable hooks twice.
974 */
975 drm_bridge_pre_enable(encoder->bridge);
976
977 if (funcs->enable)
978 funcs->enable(encoder);
979 else
980 funcs->commit(encoder);
981
982 drm_bridge_enable(encoder->bridge);
983 }
984}
985EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
986
987static void wait_for_fences(struct drm_device *dev,
988 struct drm_atomic_state *state)
989{
990 struct drm_plane *plane;
991 struct drm_plane_state *plane_state;
992 int i;
993
994 for_each_plane_in_state(state, plane, plane_state, i) {
995 if (!plane->state->fence)
996 continue;
997
998 WARN_ON(!plane->state->fb);
999
1000 fence_wait(plane->state->fence, false);
1001 fence_put(plane->state->fence);
1002 plane->state->fence = NULL;
1003 }
1004}
1005
1006/**
1007 * drm_atomic_helper_framebuffer_changed - check if framebuffer has changed
1008 * @dev: DRM device
1009 * @old_state: atomic state object with old state structures
1010 * @crtc: DRM crtc
1011 *
1012 * Checks whether the framebuffer used for this CRTC changes as a result of
1013 * the atomic update. This is useful for drivers which cannot use
1014 * drm_atomic_helper_wait_for_vblanks() and need to reimplement its
1015 * functionality.
1016 *
1017 * Returns:
1018 * true if the framebuffer changed.
1019 */
1020bool drm_atomic_helper_framebuffer_changed(struct drm_device *dev,
1021 struct drm_atomic_state *old_state,
1022 struct drm_crtc *crtc)
1023{
1024 struct drm_plane *plane;
1025 struct drm_plane_state *old_plane_state;
1026 int i;
1027
1028 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1029 if (plane->state->crtc != crtc &&
1030 old_plane_state->crtc != crtc)
1031 continue;
1032
1033 if (plane->state->fb != old_plane_state->fb)
1034 return true;
1035 }
1036
1037 return false;
1038}
1039EXPORT_SYMBOL(drm_atomic_helper_framebuffer_changed);
1040
1041/**
1042 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1043 * @dev: DRM device
1044 * @old_state: atomic state object with old state structures
1045 *
1046 * Helper to, after atomic commit, wait for vblanks on all effected
1047 * crtcs (ie. before cleaning up old framebuffers using
1048 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
1049 * framebuffers have actually changed to optimize for the legacy cursor and
1050 * plane update use-case.
1051 */
1052void
1053drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1054 struct drm_atomic_state *old_state)
1055{
1056 struct drm_crtc *crtc;
1057 struct drm_crtc_state *old_crtc_state;
1058 int i, ret;
1059
1060 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1061 /* No one cares about the old state, so abuse it for tracking
1062 * and store whether we hold a vblank reference (and should do a
1063 * vblank wait) in the ->enable boolean. */
1064 old_crtc_state->enable = false;
1065
1066 if (!crtc->state->enable)
1067 continue;
1068
1069 /* Legacy cursor ioctls are completely unsynced, and userspace
1070 * relies on that (by doing tons of cursor updates). */
1071 if (old_state->legacy_cursor_update)
1072 continue;
1073
1074 if (!drm_atomic_helper_framebuffer_changed(dev,
1075 old_state, crtc))
1076 continue;
1077
1078 ret = drm_crtc_vblank_get(crtc);
1079 if (ret != 0)
1080 continue;
1081
1082 old_crtc_state->enable = true;
1083 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
1084 }
1085
1086 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1087 if (!old_crtc_state->enable)
1088 continue;
1089
1090 ret = wait_event_timeout(dev->vblank[i].queue,
1091 old_crtc_state->last_vblank_count !=
1092 drm_crtc_vblank_count(crtc),
1093 msecs_to_jiffies(50));
1094
1095 drm_crtc_vblank_put(crtc);
1096 }
1097}
1098EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1099
1100/**
1101 * drm_atomic_helper_commit - commit validated state object
1102 * @dev: DRM device
1103 * @state: the driver state object
1104 * @async: asynchronous commit
1105 *
1106 * This function commits a with drm_atomic_helper_check() pre-validated state
1107 * object. This can still fail when e.g. the framebuffer reservation fails. For
1108 * now this doesn't implement asynchronous commits.
1109 *
1110 * Note that right now this function does not support async commits, and hence
1111 * driver writers must implement their own version for now. Also note that the
1112 * default ordering of how the various stages are called is to match the legacy
1113 * modeset helper library closest. One peculiarity of that is that it doesn't
1114 * mesh well with runtime PM at all.
1115 *
1116 * For drivers supporting runtime PM the recommended sequence is
1117 *
1118 * drm_atomic_helper_commit_modeset_disables(dev, state);
1119 *
1120 * drm_atomic_helper_commit_modeset_enables(dev, state);
1121 *
1122 * drm_atomic_helper_commit_planes(dev, state, true);
1123 *
1124 * See the kerneldoc entries for these three functions for more details.
1125 *
1126 * RETURNS
1127 * Zero for success or -errno.
1128 */
1129int drm_atomic_helper_commit(struct drm_device *dev,
1130 struct drm_atomic_state *state,
1131 bool async)
1132{
1133 int ret;
1134
1135 if (async)
1136 return -EBUSY;
1137
1138 ret = drm_atomic_helper_prepare_planes(dev, state);
1139 if (ret)
1140 return ret;
1141
1142 /*
1143 * This is the point of no return - everything below never fails except
1144 * when the hw goes bonghits. Which means we can commit the new state on
1145 * the software side now.
1146 */
1147
1148 drm_atomic_helper_swap_state(dev, state);
1149
1150 /*
1151 * Everything below can be run asynchronously without the need to grab
1152 * any modeset locks at all under one condition: It must be guaranteed
1153 * that the asynchronous work has either been cancelled (if the driver
1154 * supports it, which at least requires that the framebuffers get
1155 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1156 * before the new state gets committed on the software side with
1157 * drm_atomic_helper_swap_state().
1158 *
1159 * This scheme allows new atomic state updates to be prepared and
1160 * checked in parallel to the asynchronous completion of the previous
1161 * update. Which is important since compositors need to figure out the
1162 * composition of the next frame right after having submitted the
1163 * current layout.
1164 */
1165
1166 wait_for_fences(dev, state);
1167
1168 drm_atomic_helper_commit_modeset_disables(dev, state);
1169
1170 drm_atomic_helper_commit_planes(dev, state, false);
1171
1172 drm_atomic_helper_commit_modeset_enables(dev, state);
1173
1174 drm_atomic_helper_wait_for_vblanks(dev, state);
1175
1176 drm_atomic_helper_cleanup_planes(dev, state);
1177
1178 drm_atomic_state_free(state);
1179
1180 return 0;
1181}
1182EXPORT_SYMBOL(drm_atomic_helper_commit);
1183
1184/**
1185 * DOC: implementing async commit
1186 *
1187 * For now the atomic helpers don't support async commit directly. If there is
1188 * real need it could be added though, using the dma-buf fence infrastructure
1189 * for generic synchronization with outstanding rendering.
1190 *
1191 * For now drivers have to implement async commit themselves, with the following
1192 * sequence being the recommended one:
1193 *
1194 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1195 * which commit needs to call which can fail, so we want to run it first and
1196 * synchronously.
1197 *
1198 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1199 * might be affected the new state update. This can be done by either cancelling
1200 * or flushing the work items, depending upon whether the driver can deal with
1201 * cancelled updates. Note that it is important to ensure that the framebuffer
1202 * cleanup is still done when cancelling.
1203 *
1204 * For sufficient parallelism it is recommended to have a work item per crtc
1205 * (for updates which don't touch global state) and a global one. Then we only
1206 * need to synchronize with the crtc work items for changed crtcs and the global
1207 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1208 *
1209 * 3. The software state is updated synchronously with
1210 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1211 * locks means concurrent callers never see inconsistent state. And doing this
1212 * while it's guaranteed that no relevant async worker runs means that async
1213 * workers do not need grab any locks. Actually they must not grab locks, for
1214 * otherwise the work flushing will deadlock.
1215 *
1216 * 4. Schedule a work item to do all subsequent steps, using the split-out
1217 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1218 * then cleaning up the framebuffers after the old framebuffer is no longer
1219 * being displayed.
1220 */
1221
1222/**
1223 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
1224 * @dev: DRM device
1225 * @state: atomic state object with new state structures
1226 *
1227 * This function prepares plane state, specifically framebuffers, for the new
1228 * configuration. If any failure is encountered this function will call
1229 * ->cleanup_fb on any already successfully prepared framebuffer.
1230 *
1231 * Returns:
1232 * 0 on success, negative error code on failure.
1233 */
1234int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1235 struct drm_atomic_state *state)
1236{
1237 int nplanes = dev->mode_config.num_total_plane;
1238 int ret, i;
1239
1240 for (i = 0; i < nplanes; i++) {
1241 const struct drm_plane_helper_funcs *funcs;
1242 struct drm_plane *plane = state->planes[i];
1243 struct drm_plane_state *plane_state = state->plane_states[i];
1244
1245 if (!plane)
1246 continue;
1247
1248 funcs = plane->helper_private;
1249
1250 if (funcs->prepare_fb) {
1251 ret = funcs->prepare_fb(plane, plane_state);
1252 if (ret)
1253 goto fail;
1254 }
1255 }
1256
1257 return 0;
1258
1259fail:
1260 for (i--; i >= 0; i--) {
1261 const struct drm_plane_helper_funcs *funcs;
1262 struct drm_plane *plane = state->planes[i];
1263 struct drm_plane_state *plane_state = state->plane_states[i];
1264
1265 if (!plane)
1266 continue;
1267
1268 funcs = plane->helper_private;
1269
1270 if (funcs->cleanup_fb)
1271 funcs->cleanup_fb(plane, plane_state);
1272
1273 }
1274
1275 return ret;
1276}
1277EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1278
1279bool plane_crtc_active(struct drm_plane_state *state)
1280{
1281 return state->crtc && state->crtc->state->active;
1282}
1283
1284/**
1285 * drm_atomic_helper_commit_planes - commit plane state
1286 * @dev: DRM device
1287 * @old_state: atomic state object with old state structures
1288 * @active_only: Only commit on active CRTC if set
1289 *
1290 * This function commits the new plane state using the plane and atomic helper
1291 * functions for planes and crtcs. It assumes that the atomic state has already
1292 * been pushed into the relevant object state pointers, since this step can no
1293 * longer fail.
1294 *
1295 * It still requires the global state object @old_state to know which planes and
1296 * crtcs need to be updated though.
1297 *
1298 * Note that this function does all plane updates across all CRTCs in one step.
1299 * If the hardware can't support this approach look at
1300 * drm_atomic_helper_commit_planes_on_crtc() instead.
1301 *
1302 * Plane parameters can be updated by applications while the associated CRTC is
1303 * disabled. The DRM/KMS core will store the parameters in the plane state,
1304 * which will be available to the driver when the CRTC is turned on. As a result
1305 * most drivers don't need to be immediately notified of plane updates for a
1306 * disabled CRTC.
1307 *
1308 * Unless otherwise needed, drivers are advised to set the @active_only
1309 * parameters to true in order not to receive plane update notifications related
1310 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1311 * driver code when the driver and/or hardware can't or just don't need to deal
1312 * with updates on disabled CRTCs, for example when supporting runtime PM.
1313 *
1314 * The drm_atomic_helper_commit() default implementation only sets @active_only
1315 * to false to most closely match the behaviour of the legacy helpers. This should
1316 * not be copied blindly by drivers.
1317 */
1318void drm_atomic_helper_commit_planes(struct drm_device *dev,
1319 struct drm_atomic_state *old_state,
1320 bool active_only)
1321{
1322 struct drm_crtc *crtc;
1323 struct drm_crtc_state *old_crtc_state;
1324 struct drm_plane *plane;
1325 struct drm_plane_state *old_plane_state;
1326 int i;
1327
1328 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1329 const struct drm_crtc_helper_funcs *funcs;
1330
1331 funcs = crtc->helper_private;
1332
1333 if (!funcs || !funcs->atomic_begin)
1334 continue;
1335
1336 if (active_only && !crtc->state->active)
1337 continue;
1338
1339 funcs->atomic_begin(crtc, old_crtc_state);
1340 }
1341
1342 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
1343 const struct drm_plane_helper_funcs *funcs;
1344 bool disabling;
1345
1346 funcs = plane->helper_private;
1347
1348 if (!funcs)
1349 continue;
1350
1351 disabling = drm_atomic_plane_disabling(plane, old_plane_state);
1352
1353 if (active_only) {
1354 /*
1355 * Skip planes related to inactive CRTCs. If the plane
1356 * is enabled use the state of the current CRTC. If the
1357 * plane is being disabled use the state of the old
1358 * CRTC to avoid skipping planes being disabled on an
1359 * active CRTC.
1360 */
1361 if (!disabling && !plane_crtc_active(plane->state))
1362 continue;
1363 if (disabling && !plane_crtc_active(old_plane_state))
1364 continue;
1365 }
1366
1367 /*
1368 * Special-case disabling the plane if drivers support it.
1369 */
1370 if (disabling && funcs->atomic_disable)
1371 funcs->atomic_disable(plane, old_plane_state);
1372 else if (plane->state->crtc || disabling)
1373 funcs->atomic_update(plane, old_plane_state);
1374 }
1375
1376 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1377 const struct drm_crtc_helper_funcs *funcs;
1378
1379 funcs = crtc->helper_private;
1380
1381 if (!funcs || !funcs->atomic_flush)
1382 continue;
1383
1384 if (active_only && !crtc->state->active)
1385 continue;
1386
1387 funcs->atomic_flush(crtc, old_crtc_state);
1388 }
1389}
1390EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1391
1392/**
1393 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1394 * @old_crtc_state: atomic state object with the old crtc state
1395 *
1396 * This function commits the new plane state using the plane and atomic helper
1397 * functions for planes on the specific crtc. It assumes that the atomic state
1398 * has already been pushed into the relevant object state pointers, since this
1399 * step can no longer fail.
1400 *
1401 * This function is useful when plane updates should be done crtc-by-crtc
1402 * instead of one global step like drm_atomic_helper_commit_planes() does.
1403 *
1404 * This function can only be savely used when planes are not allowed to move
1405 * between different CRTCs because this function doesn't handle inter-CRTC
1406 * depencies. Callers need to ensure that either no such depencies exist,
1407 * resolve them through ordering of commit calls or through some other means.
1408 */
1409void
1410drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1411{
1412 const struct drm_crtc_helper_funcs *crtc_funcs;
1413 struct drm_crtc *crtc = old_crtc_state->crtc;
1414 struct drm_atomic_state *old_state = old_crtc_state->state;
1415 struct drm_plane *plane;
1416 unsigned plane_mask;
1417
1418 plane_mask = old_crtc_state->plane_mask;
1419 plane_mask |= crtc->state->plane_mask;
1420
1421 crtc_funcs = crtc->helper_private;
1422 if (crtc_funcs && crtc_funcs->atomic_begin)
1423 crtc_funcs->atomic_begin(crtc, old_crtc_state);
1424
1425 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1426 struct drm_plane_state *old_plane_state =
1427 drm_atomic_get_existing_plane_state(old_state, plane);
1428 const struct drm_plane_helper_funcs *plane_funcs;
1429
1430 plane_funcs = plane->helper_private;
1431
1432 if (!old_plane_state || !plane_funcs)
1433 continue;
1434
1435 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1436
1437 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1438 plane_funcs->atomic_disable)
1439 plane_funcs->atomic_disable(plane, old_plane_state);
1440 else if (plane->state->crtc ||
1441 drm_atomic_plane_disabling(plane, old_plane_state))
1442 plane_funcs->atomic_update(plane, old_plane_state);
1443 }
1444
1445 if (crtc_funcs && crtc_funcs->atomic_flush)
1446 crtc_funcs->atomic_flush(crtc, old_crtc_state);
1447}
1448EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1449
1450/**
1451 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
1452 * @crtc: CRTC
1453 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
1454 *
1455 * Disables all planes associated with the given CRTC. This can be
1456 * used for instance in the CRTC helper disable callback to disable
1457 * all planes before shutting down the display pipeline.
1458 *
1459 * If the atomic-parameter is set the function calls the CRTC's
1460 * atomic_begin hook before and atomic_flush hook after disabling the
1461 * planes.
1462 *
1463 * It is a bug to call this function without having implemented the
1464 * ->atomic_disable() plane hook.
1465 */
1466void drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc *crtc,
1467 bool atomic)
1468{
1469 const struct drm_crtc_helper_funcs *crtc_funcs =
1470 crtc->helper_private;
1471 struct drm_plane *plane;
1472
1473 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
1474 crtc_funcs->atomic_begin(crtc, NULL);
1475
1476 drm_for_each_plane(plane, crtc->dev) {
1477 const struct drm_plane_helper_funcs *plane_funcs =
1478 plane->helper_private;
1479
1480 if (plane->state->crtc != crtc || !plane_funcs)
1481 continue;
1482
1483 WARN_ON(!plane_funcs->atomic_disable);
1484 if (plane_funcs->atomic_disable)
1485 plane_funcs->atomic_disable(plane, NULL);
1486 }
1487
1488 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
1489 crtc_funcs->atomic_flush(crtc, NULL);
1490}
1491EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
1492
1493/**
1494 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1495 * @dev: DRM device
1496 * @old_state: atomic state object with old state structures
1497 *
1498 * This function cleans up plane state, specifically framebuffers, from the old
1499 * configuration. Hence the old configuration must be perserved in @old_state to
1500 * be able to call this function.
1501 *
1502 * This function must also be called on the new state when the atomic update
1503 * fails at any point after calling drm_atomic_helper_prepare_planes().
1504 */
1505void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1506 struct drm_atomic_state *old_state)
1507{
1508 struct drm_plane *plane;
1509 struct drm_plane_state *plane_state;
1510 int i;
1511
1512 for_each_plane_in_state(old_state, plane, plane_state, i) {
1513 const struct drm_plane_helper_funcs *funcs;
1514
1515 funcs = plane->helper_private;
1516
1517 if (funcs->cleanup_fb)
1518 funcs->cleanup_fb(plane, plane_state);
1519 }
1520}
1521EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1522
1523/**
1524 * drm_atomic_helper_swap_state - store atomic state into current sw state
1525 * @dev: DRM device
1526 * @state: atomic state
1527 *
1528 * This function stores the atomic state into the current state pointers in all
1529 * driver objects. It should be called after all failing steps have been done
1530 * and succeeded, but before the actual hardware state is committed.
1531 *
1532 * For cleanup and error recovery the current state for all changed objects will
1533 * be swaped into @state.
1534 *
1535 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1536 *
1537 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1538 *
1539 * 2. Do any other steps that might fail.
1540 *
1541 * 3. Put the staged state into the current state pointers with this function.
1542 *
1543 * 4. Actually commit the hardware state.
1544 *
1545 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
1546 * contains the old state. Also do any other cleanup required with that state.
1547 */
1548void drm_atomic_helper_swap_state(struct drm_device *dev,
1549 struct drm_atomic_state *state)
1550{
1551 int i;
1552
1553 for (i = 0; i < state->num_connector; i++) {
1554 struct drm_connector *connector = state->connectors[i];
1555
1556 if (!connector)
1557 continue;
1558
1559 connector->state->state = state;
1560 swap(state->connector_states[i], connector->state);
1561 connector->state->state = NULL;
1562 }
1563
1564 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1565 struct drm_crtc *crtc = state->crtcs[i];
1566
1567 if (!crtc)
1568 continue;
1569
1570 crtc->state->state = state;
1571 swap(state->crtc_states[i], crtc->state);
1572 crtc->state->state = NULL;
1573 }
1574
1575 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1576 struct drm_plane *plane = state->planes[i];
1577
1578 if (!plane)
1579 continue;
1580
1581 plane->state->state = state;
1582 swap(state->plane_states[i], plane->state);
1583 plane->state->state = NULL;
1584 }
1585}
1586EXPORT_SYMBOL(drm_atomic_helper_swap_state);
1587
1588/**
1589 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1590 * @plane: plane object to update
1591 * @crtc: owning CRTC of owning plane
1592 * @fb: framebuffer to flip onto plane
1593 * @crtc_x: x offset of primary plane on crtc
1594 * @crtc_y: y offset of primary plane on crtc
1595 * @crtc_w: width of primary plane rectangle on crtc
1596 * @crtc_h: height of primary plane rectangle on crtc
1597 * @src_x: x offset of @fb for panning
1598 * @src_y: y offset of @fb for panning
1599 * @src_w: width of source rectangle in @fb
1600 * @src_h: height of source rectangle in @fb
1601 *
1602 * Provides a default plane update handler using the atomic driver interface.
1603 *
1604 * RETURNS:
1605 * Zero on success, error code on failure
1606 */
1607int drm_atomic_helper_update_plane(struct drm_plane *plane,
1608 struct drm_crtc *crtc,
1609 struct drm_framebuffer *fb,
1610 int crtc_x, int crtc_y,
1611 unsigned int crtc_w, unsigned int crtc_h,
1612 uint32_t src_x, uint32_t src_y,
1613 uint32_t src_w, uint32_t src_h)
1614{
1615 struct drm_atomic_state *state;
1616 struct drm_plane_state *plane_state;
1617 int ret = 0;
1618
1619 state = drm_atomic_state_alloc(plane->dev);
1620 if (!state)
1621 return -ENOMEM;
1622
1623 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1624retry:
1625 plane_state = drm_atomic_get_plane_state(state, plane);
1626 if (IS_ERR(plane_state)) {
1627 ret = PTR_ERR(plane_state);
1628 goto fail;
1629 }
1630
1631 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
1632 if (ret != 0)
1633 goto fail;
1634 drm_atomic_set_fb_for_plane(plane_state, fb);
1635 plane_state->crtc_x = crtc_x;
1636 plane_state->crtc_y = crtc_y;
1637 plane_state->crtc_w = crtc_w;
1638 plane_state->crtc_h = crtc_h;
1639 plane_state->src_x = src_x;
1640 plane_state->src_y = src_y;
1641 plane_state->src_w = src_w;
1642 plane_state->src_h = src_h;
1643
1644 if (plane == crtc->cursor)
1645 state->legacy_cursor_update = true;
1646
1647 ret = drm_atomic_commit(state);
1648 if (ret != 0)
1649 goto fail;
1650
1651 /* Driver takes ownership of state on successful commit. */
1652 return 0;
1653fail:
1654 if (ret == -EDEADLK)
1655 goto backoff;
1656
1657 drm_atomic_state_free(state);
1658
1659 return ret;
1660backoff:
1661 drm_atomic_state_clear(state);
1662 drm_atomic_legacy_backoff(state);
1663
1664 /*
1665 * Someone might have exchanged the framebuffer while we dropped locks
1666 * in the backoff code. We need to fix up the fb refcount tracking the
1667 * core does for us.
1668 */
1669 plane->old_fb = plane->fb;
1670
1671 goto retry;
1672}
1673EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1674
1675/**
1676 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1677 * @plane: plane to disable
1678 *
1679 * Provides a default plane disable handler using the atomic driver interface.
1680 *
1681 * RETURNS:
1682 * Zero on success, error code on failure
1683 */
1684int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1685{
1686 struct drm_atomic_state *state;
1687 struct drm_plane_state *plane_state;
1688 int ret = 0;
1689
1690 /*
1691 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1692 * acquire context. The real fix will be to wire the acquire ctx through
1693 * everywhere we need it, but meanwhile prevent chaos by just skipping
1694 * this noop. The critical case is the cursor ioctls which a) only grab
1695 * crtc/cursor-plane locks (so we need the crtc to get at the right
1696 * acquire context) and b) can try to disable the plane multiple times.
1697 */
1698 if (!plane->crtc)
1699 return 0;
1700
1701 state = drm_atomic_state_alloc(plane->dev);
1702 if (!state)
1703 return -ENOMEM;
1704
1705 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1706retry:
1707 plane_state = drm_atomic_get_plane_state(state, plane);
1708 if (IS_ERR(plane_state)) {
1709 ret = PTR_ERR(plane_state);
1710 goto fail;
1711 }
1712
1713 if (plane_state->crtc && (plane == plane->crtc->cursor))
1714 plane_state->state->legacy_cursor_update = true;
1715
1716 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
1717 if (ret != 0)
1718 goto fail;
1719
1720 ret = drm_atomic_commit(state);
1721 if (ret != 0)
1722 goto fail;
1723
1724 /* Driver takes ownership of state on successful commit. */
1725 return 0;
1726fail:
1727 if (ret == -EDEADLK)
1728 goto backoff;
1729
1730 drm_atomic_state_free(state);
1731
1732 return ret;
1733backoff:
1734 drm_atomic_state_clear(state);
1735 drm_atomic_legacy_backoff(state);
1736
1737 /*
1738 * Someone might have exchanged the framebuffer while we dropped locks
1739 * in the backoff code. We need to fix up the fb refcount tracking the
1740 * core does for us.
1741 */
1742 plane->old_fb = plane->fb;
1743
1744 goto retry;
1745}
1746EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1747
1748/* just used from fb-helper and atomic-helper: */
1749int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
1750 struct drm_plane_state *plane_state)
1751{
1752 int ret;
1753
1754 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
1755 if (ret != 0)
1756 return ret;
1757
1758 drm_atomic_set_fb_for_plane(plane_state, NULL);
1759 plane_state->crtc_x = 0;
1760 plane_state->crtc_y = 0;
1761 plane_state->crtc_w = 0;
1762 plane_state->crtc_h = 0;
1763 plane_state->src_x = 0;
1764 plane_state->src_y = 0;
1765 plane_state->src_w = 0;
1766 plane_state->src_h = 0;
1767
1768 return 0;
1769}
1770
1771static int update_output_state(struct drm_atomic_state *state,
1772 struct drm_mode_set *set)
1773{
1774 struct drm_device *dev = set->crtc->dev;
1775 struct drm_crtc *crtc;
1776 struct drm_crtc_state *crtc_state;
1777 struct drm_connector *connector;
1778 struct drm_connector_state *conn_state;
1779 int ret, i;
1780
1781 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1782 state->acquire_ctx);
1783 if (ret)
1784 return ret;
1785
1786 /* First disable all connectors on the target crtc. */
1787 ret = drm_atomic_add_affected_connectors(state, set->crtc);
1788 if (ret)
1789 return ret;
1790
1791 for_each_connector_in_state(state, connector, conn_state, i) {
1792 if (conn_state->crtc == set->crtc) {
1793 ret = drm_atomic_set_crtc_for_connector(conn_state,
1794 NULL);
1795 if (ret)
1796 return ret;
1797 }
1798 }
1799
1800 /* Then set all connectors from set->connectors on the target crtc */
1801 for (i = 0; i < set->num_connectors; i++) {
1802 conn_state = drm_atomic_get_connector_state(state,
1803 set->connectors[i]);
1804 if (IS_ERR(conn_state))
1805 return PTR_ERR(conn_state);
1806
1807 ret = drm_atomic_set_crtc_for_connector(conn_state,
1808 set->crtc);
1809 if (ret)
1810 return ret;
1811 }
1812
1813 for_each_crtc_in_state(state, crtc, crtc_state, i) {
1814 /* Don't update ->enable for the CRTC in the set_config request,
1815 * since a mismatch would indicate a bug in the upper layers.
1816 * The actual modeset code later on will catch any
1817 * inconsistencies here. */
1818 if (crtc == set->crtc)
1819 continue;
1820
1821 if (!crtc_state->connector_mask) {
1822 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1823 NULL);
1824 if (ret < 0)
1825 return ret;
1826
1827 crtc_state->active = false;
1828 }
1829 }
1830
1831 return 0;
1832}
1833
1834/**
1835 * drm_atomic_helper_set_config - set a new config from userspace
1836 * @set: mode set configuration
1837 *
1838 * Provides a default crtc set_config handler using the atomic driver interface.
1839 *
1840 * Returns:
1841 * Returns 0 on success, negative errno numbers on failure.
1842 */
1843int drm_atomic_helper_set_config(struct drm_mode_set *set)
1844{
1845 struct drm_atomic_state *state;
1846 struct drm_crtc *crtc = set->crtc;
1847 int ret = 0;
1848
1849 state = drm_atomic_state_alloc(crtc->dev);
1850 if (!state)
1851 return -ENOMEM;
1852
1853 state->legacy_set_config = true;
1854 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1855retry:
1856 ret = __drm_atomic_helper_set_config(set, state);
1857 if (ret != 0)
1858 goto fail;
1859
1860 ret = drm_atomic_commit(state);
1861 if (ret != 0)
1862 goto fail;
1863
1864 /* Driver takes ownership of state on successful commit. */
1865 return 0;
1866fail:
1867 if (ret == -EDEADLK)
1868 goto backoff;
1869
1870 drm_atomic_state_free(state);
1871
1872 return ret;
1873backoff:
1874 drm_atomic_state_clear(state);
1875 drm_atomic_legacy_backoff(state);
1876
1877 /*
1878 * Someone might have exchanged the framebuffer while we dropped locks
1879 * in the backoff code. We need to fix up the fb refcount tracking the
1880 * core does for us.
1881 */
1882 crtc->primary->old_fb = crtc->primary->fb;
1883
1884 goto retry;
1885}
1886EXPORT_SYMBOL(drm_atomic_helper_set_config);
1887
1888/* just used from fb-helper and atomic-helper: */
1889int __drm_atomic_helper_set_config(struct drm_mode_set *set,
1890 struct drm_atomic_state *state)
1891{
1892 struct drm_crtc_state *crtc_state;
1893 struct drm_plane_state *primary_state;
1894 struct drm_crtc *crtc = set->crtc;
1895 int hdisplay, vdisplay;
1896 int ret;
1897
1898 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1899 if (IS_ERR(crtc_state))
1900 return PTR_ERR(crtc_state);
1901
1902 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1903 if (IS_ERR(primary_state))
1904 return PTR_ERR(primary_state);
1905
1906 if (!set->mode) {
1907 WARN_ON(set->fb);
1908 WARN_ON(set->num_connectors);
1909
1910 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1911 if (ret != 0)
1912 return ret;
1913
1914 crtc_state->active = false;
1915
1916 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
1917 if (ret != 0)
1918 return ret;
1919
1920 drm_atomic_set_fb_for_plane(primary_state, NULL);
1921
1922 goto commit;
1923 }
1924
1925 WARN_ON(!set->fb);
1926 WARN_ON(!set->num_connectors);
1927
1928 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1929 if (ret != 0)
1930 return ret;
1931
1932 crtc_state->active = true;
1933
1934 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
1935 if (ret != 0)
1936 return ret;
1937
1938 drm_crtc_get_hv_timing(set->mode, &hdisplay, &vdisplay);
1939
1940 drm_atomic_set_fb_for_plane(primary_state, set->fb);
1941 primary_state->crtc_x = 0;
1942 primary_state->crtc_y = 0;
1943 primary_state->crtc_w = hdisplay;
1944 primary_state->crtc_h = vdisplay;
1945 primary_state->src_x = set->x << 16;
1946 primary_state->src_y = set->y << 16;
1947 if (primary_state->rotation & (BIT(DRM_ROTATE_90) | BIT(DRM_ROTATE_270))) {
1948 primary_state->src_w = vdisplay << 16;
1949 primary_state->src_h = hdisplay << 16;
1950 } else {
1951 primary_state->src_w = hdisplay << 16;
1952 primary_state->src_h = vdisplay << 16;
1953 }
1954
1955commit:
1956 ret = update_output_state(state, set);
1957 if (ret)
1958 return ret;
1959
1960 return 0;
1961}
1962
1963/**
1964 * drm_atomic_helper_disable_all - disable all currently active outputs
1965 * @dev: DRM device
1966 * @ctx: lock acquisition context
1967 *
1968 * Loops through all connectors, finding those that aren't turned off and then
1969 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
1970 * that they are connected to.
1971 *
1972 * This is used for example in suspend/resume to disable all currently active
1973 * functions when suspending.
1974 *
1975 * Note that if callers haven't already acquired all modeset locks this might
1976 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
1977 *
1978 * Returns:
1979 * 0 on success or a negative error code on failure.
1980 *
1981 * See also:
1982 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
1983 */
1984int drm_atomic_helper_disable_all(struct drm_device *dev,
1985 struct drm_modeset_acquire_ctx *ctx)
1986{
1987 struct drm_atomic_state *state;
1988 struct drm_connector *conn;
1989 int err;
1990
1991 state = drm_atomic_state_alloc(dev);
1992 if (!state)
1993 return -ENOMEM;
1994
1995 state->acquire_ctx = ctx;
1996
1997 drm_for_each_connector(conn, dev) {
1998 struct drm_crtc *crtc = conn->state->crtc;
1999 struct drm_crtc_state *crtc_state;
2000
2001 if (!crtc || conn->dpms != DRM_MODE_DPMS_ON)
2002 continue;
2003
2004 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2005 if (IS_ERR(crtc_state)) {
2006 err = PTR_ERR(crtc_state);
2007 goto free;
2008 }
2009
2010 crtc_state->active = false;
2011 }
2012
2013 err = drm_atomic_commit(state);
2014
2015free:
2016 if (err < 0)
2017 drm_atomic_state_free(state);
2018
2019 return err;
2020}
2021EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2022
2023/**
2024 * drm_atomic_helper_suspend - subsystem-level suspend helper
2025 * @dev: DRM device
2026 *
2027 * Duplicates the current atomic state, disables all active outputs and then
2028 * returns a pointer to the original atomic state to the caller. Drivers can
2029 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
2030 * restore the output configuration that was active at the time the system
2031 * entered suspend.
2032 *
2033 * Note that it is potentially unsafe to use this. The atomic state object
2034 * returned by this function is assumed to be persistent. Drivers must ensure
2035 * that this holds true. Before calling this function, drivers must make sure
2036 * to suspend fbdev emulation so that nothing can be using the device.
2037 *
2038 * Returns:
2039 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
2040 * encoded error code on failure. Drivers should store the returned atomic
2041 * state object and pass it to the drm_atomic_helper_resume() helper upon
2042 * resume.
2043 *
2044 * See also:
2045 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
2046 * drm_atomic_helper_resume()
2047 */
2048struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
2049{
2050 struct drm_modeset_acquire_ctx ctx;
2051 struct drm_atomic_state *state;
2052 int err;
2053
2054 drm_modeset_acquire_init(&ctx, 0);
2055
2056retry:
2057 err = drm_modeset_lock_all_ctx(dev, &ctx);
2058 if (err < 0) {
2059 state = ERR_PTR(err);
2060 goto unlock;
2061 }
2062
2063 state = drm_atomic_helper_duplicate_state(dev, &ctx);
2064 if (IS_ERR(state))
2065 goto unlock;
2066
2067 err = drm_atomic_helper_disable_all(dev, &ctx);
2068 if (err < 0) {
2069 drm_atomic_state_free(state);
2070 state = ERR_PTR(err);
2071 goto unlock;
2072 }
2073
2074unlock:
2075 if (PTR_ERR(state) == -EDEADLK) {
2076 drm_modeset_backoff(&ctx);
2077 goto retry;
2078 }
2079
2080 drm_modeset_drop_locks(&ctx);
2081 drm_modeset_acquire_fini(&ctx);
2082 return state;
2083}
2084EXPORT_SYMBOL(drm_atomic_helper_suspend);
2085
2086/**
2087 * drm_atomic_helper_resume - subsystem-level resume helper
2088 * @dev: DRM device
2089 * @state: atomic state to resume to
2090 *
2091 * Calls drm_mode_config_reset() to synchronize hardware and software states,
2092 * grabs all modeset locks and commits the atomic state object. This can be
2093 * used in conjunction with the drm_atomic_helper_suspend() helper to
2094 * implement suspend/resume for drivers that support atomic mode-setting.
2095 *
2096 * Returns:
2097 * 0 on success or a negative error code on failure.
2098 *
2099 * See also:
2100 * drm_atomic_helper_suspend()
2101 */
2102int drm_atomic_helper_resume(struct drm_device *dev,
2103 struct drm_atomic_state *state)
2104{
2105 struct drm_mode_config *config = &dev->mode_config;
2106 int err;
2107
2108 drm_mode_config_reset(dev);
2109 drm_modeset_lock_all(dev);
2110 state->acquire_ctx = config->acquire_ctx;
2111 err = drm_atomic_commit(state);
2112 drm_modeset_unlock_all(dev);
2113
2114 return err;
2115}
2116EXPORT_SYMBOL(drm_atomic_helper_resume);
2117
2118/**
2119 * drm_atomic_helper_crtc_set_property - helper for crtc properties
2120 * @crtc: DRM crtc
2121 * @property: DRM property
2122 * @val: value of property
2123 *
2124 * Provides a default crtc set_property handler using the atomic driver
2125 * interface.
2126 *
2127 * RETURNS:
2128 * Zero on success, error code on failure
2129 */
2130int
2131drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
2132 struct drm_property *property,
2133 uint64_t val)
2134{
2135 struct drm_atomic_state *state;
2136 struct drm_crtc_state *crtc_state;
2137 int ret = 0;
2138
2139 state = drm_atomic_state_alloc(crtc->dev);
2140 if (!state)
2141 return -ENOMEM;
2142
2143 /* ->set_property is always called with all locks held. */
2144 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2145retry:
2146 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2147 if (IS_ERR(crtc_state)) {
2148 ret = PTR_ERR(crtc_state);
2149 goto fail;
2150 }
2151
2152 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2153 property, val);
2154 if (ret)
2155 goto fail;
2156
2157 ret = drm_atomic_commit(state);
2158 if (ret != 0)
2159 goto fail;
2160
2161 /* Driver takes ownership of state on successful commit. */
2162 return 0;
2163fail:
2164 if (ret == -EDEADLK)
2165 goto backoff;
2166
2167 drm_atomic_state_free(state);
2168
2169 return ret;
2170backoff:
2171 drm_atomic_state_clear(state);
2172 drm_atomic_legacy_backoff(state);
2173
2174 goto retry;
2175}
2176EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
2177
2178/**
2179 * drm_atomic_helper_plane_set_property - helper for plane properties
2180 * @plane: DRM plane
2181 * @property: DRM property
2182 * @val: value of property
2183 *
2184 * Provides a default plane set_property handler using the atomic driver
2185 * interface.
2186 *
2187 * RETURNS:
2188 * Zero on success, error code on failure
2189 */
2190int
2191drm_atomic_helper_plane_set_property(struct drm_plane *plane,
2192 struct drm_property *property,
2193 uint64_t val)
2194{
2195 struct drm_atomic_state *state;
2196 struct drm_plane_state *plane_state;
2197 int ret = 0;
2198
2199 state = drm_atomic_state_alloc(plane->dev);
2200 if (!state)
2201 return -ENOMEM;
2202
2203 /* ->set_property is always called with all locks held. */
2204 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
2205retry:
2206 plane_state = drm_atomic_get_plane_state(state, plane);
2207 if (IS_ERR(plane_state)) {
2208 ret = PTR_ERR(plane_state);
2209 goto fail;
2210 }
2211
2212 ret = drm_atomic_plane_set_property(plane, plane_state,
2213 property, val);
2214 if (ret)
2215 goto fail;
2216
2217 ret = drm_atomic_commit(state);
2218 if (ret != 0)
2219 goto fail;
2220
2221 /* Driver takes ownership of state on successful commit. */
2222 return 0;
2223fail:
2224 if (ret == -EDEADLK)
2225 goto backoff;
2226
2227 drm_atomic_state_free(state);
2228
2229 return ret;
2230backoff:
2231 drm_atomic_state_clear(state);
2232 drm_atomic_legacy_backoff(state);
2233
2234 goto retry;
2235}
2236EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
2237
2238/**
2239 * drm_atomic_helper_connector_set_property - helper for connector properties
2240 * @connector: DRM connector
2241 * @property: DRM property
2242 * @val: value of property
2243 *
2244 * Provides a default connector set_property handler using the atomic driver
2245 * interface.
2246 *
2247 * RETURNS:
2248 * Zero on success, error code on failure
2249 */
2250int
2251drm_atomic_helper_connector_set_property(struct drm_connector *connector,
2252 struct drm_property *property,
2253 uint64_t val)
2254{
2255 struct drm_atomic_state *state;
2256 struct drm_connector_state *connector_state;
2257 int ret = 0;
2258
2259 state = drm_atomic_state_alloc(connector->dev);
2260 if (!state)
2261 return -ENOMEM;
2262
2263 /* ->set_property is always called with all locks held. */
2264 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
2265retry:
2266 connector_state = drm_atomic_get_connector_state(state, connector);
2267 if (IS_ERR(connector_state)) {
2268 ret = PTR_ERR(connector_state);
2269 goto fail;
2270 }
2271
2272 ret = drm_atomic_connector_set_property(connector, connector_state,
2273 property, val);
2274 if (ret)
2275 goto fail;
2276
2277 ret = drm_atomic_commit(state);
2278 if (ret != 0)
2279 goto fail;
2280
2281 /* Driver takes ownership of state on successful commit. */
2282 return 0;
2283fail:
2284 if (ret == -EDEADLK)
2285 goto backoff;
2286
2287 drm_atomic_state_free(state);
2288
2289 return ret;
2290backoff:
2291 drm_atomic_state_clear(state);
2292 drm_atomic_legacy_backoff(state);
2293
2294 goto retry;
2295}
2296EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
2297
2298/**
2299 * drm_atomic_helper_page_flip - execute a legacy page flip
2300 * @crtc: DRM crtc
2301 * @fb: DRM framebuffer
2302 * @event: optional DRM event to signal upon completion
2303 * @flags: flip flags for non-vblank sync'ed updates
2304 *
2305 * Provides a default page flip implementation using the atomic driver interface.
2306 *
2307 * Note that for now so called async page flips (i.e. updates which are not
2308 * synchronized to vblank) are not supported, since the atomic interfaces have
2309 * no provisions for this yet.
2310 *
2311 * Returns:
2312 * Returns 0 on success, negative errno numbers on failure.
2313 */
2314int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
2315 struct drm_framebuffer *fb,
2316 struct drm_pending_vblank_event *event,
2317 uint32_t flags)
2318{
2319 struct drm_plane *plane = crtc->primary;
2320 struct drm_atomic_state *state;
2321 struct drm_plane_state *plane_state;
2322 struct drm_crtc_state *crtc_state;
2323 int ret = 0;
2324
2325 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
2326 return -EINVAL;
2327
2328 state = drm_atomic_state_alloc(plane->dev);
2329 if (!state)
2330 return -ENOMEM;
2331
2332 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2333retry:
2334 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2335 if (IS_ERR(crtc_state)) {
2336 ret = PTR_ERR(crtc_state);
2337 goto fail;
2338 }
2339 crtc_state->event = event;
2340
2341 plane_state = drm_atomic_get_plane_state(state, plane);
2342 if (IS_ERR(plane_state)) {
2343 ret = PTR_ERR(plane_state);
2344 goto fail;
2345 }
2346
2347 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2348 if (ret != 0)
2349 goto fail;
2350 drm_atomic_set_fb_for_plane(plane_state, fb);
2351
2352 /* Make sure we don't accidentally do a full modeset. */
2353 state->allow_modeset = false;
2354 if (!crtc_state->active) {
2355 DRM_DEBUG_ATOMIC("[CRTC:%d] disabled, rejecting legacy flip\n",
2356 crtc->base.id);
2357 ret = -EINVAL;
2358 goto fail;
2359 }
2360
2361 ret = drm_atomic_async_commit(state);
2362 if (ret != 0)
2363 goto fail;
2364
2365 /* Driver takes ownership of state on successful async commit. */
2366 return 0;
2367fail:
2368 if (ret == -EDEADLK)
2369 goto backoff;
2370
2371 drm_atomic_state_free(state);
2372
2373 return ret;
2374backoff:
2375 drm_atomic_state_clear(state);
2376 drm_atomic_legacy_backoff(state);
2377
2378 /*
2379 * Someone might have exchanged the framebuffer while we dropped locks
2380 * in the backoff code. We need to fix up the fb refcount tracking the
2381 * core does for us.
2382 */
2383 plane->old_fb = plane->fb;
2384
2385 goto retry;
2386}
2387EXPORT_SYMBOL(drm_atomic_helper_page_flip);
2388
2389/**
2390 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2391 * @connector: affected connector
2392 * @mode: DPMS mode
2393 *
2394 * This is the main helper function provided by the atomic helper framework for
2395 * implementing the legacy DPMS connector interface. It computes the new desired
2396 * ->active state for the corresponding CRTC (if the connector is enabled) and
2397 * updates it.
2398 *
2399 * Returns:
2400 * Returns 0 on success, negative errno numbers on failure.
2401 */
2402int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2403 int mode)
2404{
2405 struct drm_mode_config *config = &connector->dev->mode_config;
2406 struct drm_atomic_state *state;
2407 struct drm_crtc_state *crtc_state;
2408 struct drm_crtc *crtc;
2409 struct drm_connector *tmp_connector;
2410 int ret;
2411 bool active = false;
2412 int old_mode = connector->dpms;
2413
2414 if (mode != DRM_MODE_DPMS_ON)
2415 mode = DRM_MODE_DPMS_OFF;
2416
2417 connector->dpms = mode;
2418 crtc = connector->state->crtc;
2419
2420 if (!crtc)
2421 return 0;
2422
2423 state = drm_atomic_state_alloc(connector->dev);
2424 if (!state)
2425 return -ENOMEM;
2426
2427 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2428retry:
2429 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2430 if (IS_ERR(crtc_state)) {
2431 ret = PTR_ERR(crtc_state);
2432 goto fail;
2433 }
2434
2435 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2436
2437 drm_for_each_connector(tmp_connector, connector->dev) {
2438 if (tmp_connector->state->crtc != crtc)
2439 continue;
2440
2441 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
2442 active = true;
2443 break;
2444 }
2445 }
2446 crtc_state->active = active;
2447
2448 ret = drm_atomic_commit(state);
2449 if (ret != 0)
2450 goto fail;
2451
2452 /* Driver takes ownership of state on successful commit. */
2453 return 0;
2454fail:
2455 if (ret == -EDEADLK)
2456 goto backoff;
2457
2458 connector->dpms = old_mode;
2459 drm_atomic_state_free(state);
2460
2461 return ret;
2462backoff:
2463 drm_atomic_state_clear(state);
2464 drm_atomic_legacy_backoff(state);
2465
2466 goto retry;
2467}
2468EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2469
2470/**
2471 * DOC: atomic state reset and initialization
2472 *
2473 * Both the drm core and the atomic helpers assume that there is always the full
2474 * and correct atomic software state for all connectors, CRTCs and planes
2475 * available. Which is a bit a problem on driver load and also after system
2476 * suspend. One way to solve this is to have a hardware state read-out
2477 * infrastructure which reconstructs the full software state (e.g. the i915
2478 * driver).
2479 *
2480 * The simpler solution is to just reset the software state to everything off,
2481 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2482 * the atomic helpers provide default reset implementations for all hooks.
2483 *
2484 * On the upside the precise state tracking of atomic simplifies system suspend
2485 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
2486 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
2487 * For other drivers the building blocks are split out, see the documentation
2488 * for these functions.
2489 */
2490
2491/**
2492 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2493 * @crtc: drm CRTC
2494 *
2495 * Resets the atomic state for @crtc by freeing the state pointer (which might
2496 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2497 */
2498void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2499{
2500 if (crtc->state) {
2501 drm_property_unreference_blob(crtc->state->mode_blob);
2502 drm_property_unreference_blob(crtc->state->degamma_lut);
2503 drm_property_unreference_blob(crtc->state->ctm);
2504 drm_property_unreference_blob(crtc->state->gamma_lut);
2505 }
2506 kfree(crtc->state);
2507 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
2508
2509 if (crtc->state)
2510 crtc->state->crtc = crtc;
2511}
2512EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2513
2514/**
2515 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2516 * @crtc: CRTC object
2517 * @state: atomic CRTC state
2518 *
2519 * Copies atomic state from a CRTC's current state and resets inferred values.
2520 * This is useful for drivers that subclass the CRTC state.
2521 */
2522void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2523 struct drm_crtc_state *state)
2524{
2525 memcpy(state, crtc->state, sizeof(*state));
2526
2527 if (state->mode_blob)
2528 drm_property_reference_blob(state->mode_blob);
2529 if (state->degamma_lut)
2530 drm_property_reference_blob(state->degamma_lut);
2531 if (state->ctm)
2532 drm_property_reference_blob(state->ctm);
2533 if (state->gamma_lut)
2534 drm_property_reference_blob(state->gamma_lut);
2535 state->mode_changed = false;
2536 state->active_changed = false;
2537 state->planes_changed = false;
2538 state->connectors_changed = false;
2539 state->color_mgmt_changed = false;
2540 state->event = NULL;
2541}
2542EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2543
2544/**
2545 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2546 * @crtc: drm CRTC
2547 *
2548 * Default CRTC state duplicate hook for drivers which don't have their own
2549 * subclassed CRTC state structure.
2550 */
2551struct drm_crtc_state *
2552drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2553{
2554 struct drm_crtc_state *state;
2555
2556 if (WARN_ON(!crtc->state))
2557 return NULL;
2558
2559 state = kmalloc(sizeof(*state), GFP_KERNEL);
2560 if (state)
2561 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
2562
2563 return state;
2564}
2565EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2566
2567/**
2568 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2569 * @crtc: CRTC object
2570 * @state: CRTC state object to release
2571 *
2572 * Releases all resources stored in the CRTC state without actually freeing
2573 * the memory of the CRTC state. This is useful for drivers that subclass the
2574 * CRTC state.
2575 */
2576void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2577 struct drm_crtc_state *state)
2578{
2579 drm_property_unreference_blob(state->mode_blob);
2580 drm_property_unreference_blob(state->degamma_lut);
2581 drm_property_unreference_blob(state->ctm);
2582 drm_property_unreference_blob(state->gamma_lut);
2583}
2584EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2585
2586/**
2587 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2588 * @crtc: drm CRTC
2589 * @state: CRTC state object to release
2590 *
2591 * Default CRTC state destroy hook for drivers which don't have their own
2592 * subclassed CRTC state structure.
2593 */
2594void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2595 struct drm_crtc_state *state)
2596{
2597 __drm_atomic_helper_crtc_destroy_state(crtc, state);
2598 kfree(state);
2599}
2600EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2601
2602/**
2603 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2604 * @plane: drm plane
2605 *
2606 * Resets the atomic state for @plane by freeing the state pointer (which might
2607 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2608 */
2609void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2610{
2611 if (plane->state && plane->state->fb)
2612 drm_framebuffer_unreference(plane->state->fb);
2613
2614 kfree(plane->state);
2615 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
2616
2617 if (plane->state) {
2618 plane->state->plane = plane;
2619 plane->state->rotation = BIT(DRM_ROTATE_0);
2620 }
2621}
2622EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2623
2624/**
2625 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2626 * @plane: plane object
2627 * @state: atomic plane state
2628 *
2629 * Copies atomic state from a plane's current state. This is useful for
2630 * drivers that subclass the plane state.
2631 */
2632void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2633 struct drm_plane_state *state)
2634{
2635 memcpy(state, plane->state, sizeof(*state));
2636
2637 if (state->fb)
2638 drm_framebuffer_reference(state->fb);
2639}
2640EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2641
2642/**
2643 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2644 * @plane: drm plane
2645 *
2646 * Default plane state duplicate hook for drivers which don't have their own
2647 * subclassed plane state structure.
2648 */
2649struct drm_plane_state *
2650drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2651{
2652 struct drm_plane_state *state;
2653
2654 if (WARN_ON(!plane->state))
2655 return NULL;
2656
2657 state = kmalloc(sizeof(*state), GFP_KERNEL);
2658 if (state)
2659 __drm_atomic_helper_plane_duplicate_state(plane, state);
2660
2661 return state;
2662}
2663EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2664
2665/**
2666 * __drm_atomic_helper_plane_destroy_state - release plane state
2667 * @plane: plane object
2668 * @state: plane state object to release
2669 *
2670 * Releases all resources stored in the plane state without actually freeing
2671 * the memory of the plane state. This is useful for drivers that subclass the
2672 * plane state.
2673 */
2674void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2675 struct drm_plane_state *state)
2676{
2677 if (state->fb)
2678 drm_framebuffer_unreference(state->fb);
2679}
2680EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2681
2682/**
2683 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2684 * @plane: drm plane
2685 * @state: plane state object to release
2686 *
2687 * Default plane state destroy hook for drivers which don't have their own
2688 * subclassed plane state structure.
2689 */
2690void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2691 struct drm_plane_state *state)
2692{
2693 __drm_atomic_helper_plane_destroy_state(plane, state);
2694 kfree(state);
2695}
2696EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2697
2698/**
2699 * __drm_atomic_helper_connector_reset - reset state on connector
2700 * @connector: drm connector
2701 * @conn_state: connector state to assign
2702 *
2703 * Initializes the newly allocated @conn_state and assigns it to
2704 * #connector ->state, usually required when initializing the drivers
2705 * or when called from the ->reset hook.
2706 *
2707 * This is useful for drivers that subclass the connector state.
2708 */
2709void
2710__drm_atomic_helper_connector_reset(struct drm_connector *connector,
2711 struct drm_connector_state *conn_state)
2712{
2713 if (conn_state)
2714 conn_state->connector = connector;
2715
2716 connector->state = conn_state;
2717}
2718EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
2719
2720/**
2721 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2722 * @connector: drm connector
2723 *
2724 * Resets the atomic state for @connector by freeing the state pointer (which
2725 * might be NULL, e.g. at driver load time) and allocating a new empty state
2726 * object.
2727 */
2728void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2729{
2730 struct drm_connector_state *conn_state =
2731 kzalloc(sizeof(*conn_state), GFP_KERNEL);
2732
2733 kfree(connector->state);
2734 __drm_atomic_helper_connector_reset(connector, conn_state);
2735}
2736EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2737
2738/**
2739 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2740 * @connector: connector object
2741 * @state: atomic connector state
2742 *
2743 * Copies atomic state from a connector's current state. This is useful for
2744 * drivers that subclass the connector state.
2745 */
2746void
2747__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2748 struct drm_connector_state *state)
2749{
2750 memcpy(state, connector->state, sizeof(*state));
2751}
2752EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2753
2754/**
2755 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2756 * @connector: drm connector
2757 *
2758 * Default connector state duplicate hook for drivers which don't have their own
2759 * subclassed connector state structure.
2760 */
2761struct drm_connector_state *
2762drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2763{
2764 struct drm_connector_state *state;
2765
2766 if (WARN_ON(!connector->state))
2767 return NULL;
2768
2769 state = kmalloc(sizeof(*state), GFP_KERNEL);
2770 if (state)
2771 __drm_atomic_helper_connector_duplicate_state(connector, state);
2772
2773 return state;
2774}
2775EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2776
2777/**
2778 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
2779 * @dev: DRM device
2780 * @ctx: lock acquisition context
2781 *
2782 * Makes a copy of the current atomic state by looping over all objects and
2783 * duplicating their respective states. This is used for example by suspend/
2784 * resume support code to save the state prior to suspend such that it can
2785 * be restored upon resume.
2786 *
2787 * Note that this treats atomic state as persistent between save and restore.
2788 * Drivers must make sure that this is possible and won't result in confusion
2789 * or erroneous behaviour.
2790 *
2791 * Note that if callers haven't already acquired all modeset locks this might
2792 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2793 *
2794 * Returns:
2795 * A pointer to the copy of the atomic state object on success or an
2796 * ERR_PTR()-encoded error code on failure.
2797 *
2798 * See also:
2799 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
2800 */
2801struct drm_atomic_state *
2802drm_atomic_helper_duplicate_state(struct drm_device *dev,
2803 struct drm_modeset_acquire_ctx *ctx)
2804{
2805 struct drm_atomic_state *state;
2806 struct drm_connector *conn;
2807 struct drm_plane *plane;
2808 struct drm_crtc *crtc;
2809 int err = 0;
2810
2811 state = drm_atomic_state_alloc(dev);
2812 if (!state)
2813 return ERR_PTR(-ENOMEM);
2814
2815 state->acquire_ctx = ctx;
2816
2817 drm_for_each_crtc(crtc, dev) {
2818 struct drm_crtc_state *crtc_state;
2819
2820 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2821 if (IS_ERR(crtc_state)) {
2822 err = PTR_ERR(crtc_state);
2823 goto free;
2824 }
2825 }
2826
2827 drm_for_each_plane(plane, dev) {
2828 struct drm_plane_state *plane_state;
2829
2830 plane_state = drm_atomic_get_plane_state(state, plane);
2831 if (IS_ERR(plane_state)) {
2832 err = PTR_ERR(plane_state);
2833 goto free;
2834 }
2835 }
2836
2837 drm_for_each_connector(conn, dev) {
2838 struct drm_connector_state *conn_state;
2839
2840 conn_state = drm_atomic_get_connector_state(state, conn);
2841 if (IS_ERR(conn_state)) {
2842 err = PTR_ERR(conn_state);
2843 goto free;
2844 }
2845 }
2846
2847 /* clear the acquire context so that it isn't accidentally reused */
2848 state->acquire_ctx = NULL;
2849
2850free:
2851 if (err < 0) {
2852 drm_atomic_state_free(state);
2853 state = ERR_PTR(err);
2854 }
2855
2856 return state;
2857}
2858EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
2859
2860/**
2861 * __drm_atomic_helper_connector_destroy_state - release connector state
2862 * @connector: connector object
2863 * @state: connector state object to release
2864 *
2865 * Releases all resources stored in the connector state without actually
2866 * freeing the memory of the connector state. This is useful for drivers that
2867 * subclass the connector state.
2868 */
2869void
2870__drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2871 struct drm_connector_state *state)
2872{
2873 /*
2874 * This is currently a placeholder so that drivers that subclass the
2875 * state will automatically do the right thing if code is ever added
2876 * to this function.
2877 */
2878}
2879EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2880
2881/**
2882 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2883 * @connector: drm connector
2884 * @state: connector state object to release
2885 *
2886 * Default connector state destroy hook for drivers which don't have their own
2887 * subclassed connector state structure.
2888 */
2889void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2890 struct drm_connector_state *state)
2891{
2892 __drm_atomic_helper_connector_destroy_state(connector, state);
2893 kfree(state);
2894}
2895EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
2896
2897/**
2898 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
2899 * @crtc: CRTC object
2900 * @red: red correction table
2901 * @green: green correction table
2902 * @blue: green correction table
2903 * @start:
2904 * @size: size of the tables
2905 *
2906 * Implements support for legacy gamma correction table for drivers
2907 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
2908 * properties.
2909 */
2910void drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
2911 u16 *red, u16 *green, u16 *blue,
2912 uint32_t start, uint32_t size)
2913{
2914 struct drm_device *dev = crtc->dev;
2915 struct drm_mode_config *config = &dev->mode_config;
2916 struct drm_atomic_state *state;
2917 struct drm_crtc_state *crtc_state;
2918 struct drm_property_blob *blob = NULL;
2919 struct drm_color_lut *blob_data;
2920 int i, ret = 0;
2921
2922 state = drm_atomic_state_alloc(crtc->dev);
2923 if (!state)
2924 return;
2925
2926 blob = drm_property_create_blob(dev,
2927 sizeof(struct drm_color_lut) * size,
2928 NULL);
2929 if (IS_ERR(blob)) {
2930 ret = PTR_ERR(blob);
2931 blob = NULL;
2932 goto fail;
2933 }
2934
2935 /* Prepare GAMMA_LUT with the legacy values. */
2936 blob_data = (struct drm_color_lut *) blob->data;
2937 for (i = 0; i < size; i++) {
2938 blob_data[i].red = red[i];
2939 blob_data[i].green = green[i];
2940 blob_data[i].blue = blue[i];
2941 }
2942
2943 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
2944retry:
2945 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2946 if (IS_ERR(crtc_state)) {
2947 ret = PTR_ERR(crtc_state);
2948 goto fail;
2949 }
2950
2951 /* Reset DEGAMMA_LUT and CTM properties. */
2952 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2953 config->degamma_lut_property, 0);
2954 if (ret)
2955 goto fail;
2956
2957 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2958 config->ctm_property, 0);
2959 if (ret)
2960 goto fail;
2961
2962 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
2963 config->gamma_lut_property, blob->base.id);
2964 if (ret)
2965 goto fail;
2966
2967 ret = drm_atomic_commit(state);
2968 if (ret)
2969 goto fail;
2970
2971 /* Driver takes ownership of state on successful commit. */
2972
2973 drm_property_unreference_blob(blob);
2974
2975 return;
2976fail:
2977 if (ret == -EDEADLK)
2978 goto backoff;
2979
2980 drm_atomic_state_free(state);
2981 drm_property_unreference_blob(blob);
2982
2983 return;
2984backoff:
2985 drm_atomic_state_clear(state);
2986 drm_atomic_legacy_backoff(state);
2987
2988 goto retry;
2989}
2990EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);
1/*
2 * Copyright (C) 2014 Red Hat
3 * Copyright (C) 2014 Intel Corp.
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Rob Clark <robdclark@gmail.com>
25 * Daniel Vetter <daniel.vetter@ffwll.ch>
26 */
27
28#include <drm/drmP.h>
29#include <drm/drm_atomic.h>
30#include <drm/drm_plane_helper.h>
31#include <drm/drm_crtc_helper.h>
32#include <drm/drm_atomic_helper.h>
33#include <linux/dma-fence.h>
34
35#include "drm_crtc_helper_internal.h"
36#include "drm_crtc_internal.h"
37
38/**
39 * DOC: overview
40 *
41 * This helper library provides implementations of check and commit functions on
42 * top of the CRTC modeset helper callbacks and the plane helper callbacks. It
43 * also provides convenience implementations for the atomic state handling
44 * callbacks for drivers which don't need to subclass the drm core structures to
45 * add their own additional internal state.
46 *
47 * This library also provides default implementations for the check callback in
48 * drm_atomic_helper_check() and for the commit callback with
49 * drm_atomic_helper_commit(). But the individual stages and callbacks are
50 * exposed to allow drivers to mix and match and e.g. use the plane helpers only
51 * together with a driver private modeset implementation.
52 *
53 * This library also provides implementations for all the legacy driver
54 * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(),
55 * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the
56 * various functions to implement set_property callbacks. New drivers must not
57 * implement these functions themselves but must use the provided helpers.
58 *
59 * The atomic helper uses the same function table structures as all other
60 * modesetting helpers. See the documentation for &struct drm_crtc_helper_funcs,
61 * struct &drm_encoder_helper_funcs and &struct drm_connector_helper_funcs. It
62 * also shares the &struct drm_plane_helper_funcs function table with the plane
63 * helpers.
64 */
65static void
66drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
67 struct drm_plane_state *old_plane_state,
68 struct drm_plane_state *plane_state,
69 struct drm_plane *plane)
70{
71 struct drm_crtc_state *crtc_state;
72
73 if (old_plane_state->crtc) {
74 crtc_state = drm_atomic_get_new_crtc_state(state,
75 old_plane_state->crtc);
76
77 if (WARN_ON(!crtc_state))
78 return;
79
80 crtc_state->planes_changed = true;
81 }
82
83 if (plane_state->crtc) {
84 crtc_state = drm_atomic_get_new_crtc_state(state, plane_state->crtc);
85
86 if (WARN_ON(!crtc_state))
87 return;
88
89 crtc_state->planes_changed = true;
90 }
91}
92
93static int handle_conflicting_encoders(struct drm_atomic_state *state,
94 bool disable_conflicting_encoders)
95{
96 struct drm_connector_state *new_conn_state;
97 struct drm_connector *connector;
98 struct drm_connector_list_iter conn_iter;
99 struct drm_encoder *encoder;
100 unsigned encoder_mask = 0;
101 int i, ret = 0;
102
103 /*
104 * First loop, find all newly assigned encoders from the connectors
105 * part of the state. If the same encoder is assigned to multiple
106 * connectors bail out.
107 */
108 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
109 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
110 struct drm_encoder *new_encoder;
111
112 if (!new_conn_state->crtc)
113 continue;
114
115 if (funcs->atomic_best_encoder)
116 new_encoder = funcs->atomic_best_encoder(connector, new_conn_state);
117 else if (funcs->best_encoder)
118 new_encoder = funcs->best_encoder(connector);
119 else
120 new_encoder = drm_atomic_helper_best_encoder(connector);
121
122 if (new_encoder) {
123 if (encoder_mask & (1 << drm_encoder_index(new_encoder))) {
124 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] on [CONNECTOR:%d:%s] already assigned\n",
125 new_encoder->base.id, new_encoder->name,
126 connector->base.id, connector->name);
127
128 return -EINVAL;
129 }
130
131 encoder_mask |= 1 << drm_encoder_index(new_encoder);
132 }
133 }
134
135 if (!encoder_mask)
136 return 0;
137
138 /*
139 * Second loop, iterate over all connectors not part of the state.
140 *
141 * If a conflicting encoder is found and disable_conflicting_encoders
142 * is not set, an error is returned. Userspace can provide a solution
143 * through the atomic ioctl.
144 *
145 * If the flag is set conflicting connectors are removed from the crtc
146 * and the crtc is disabled if no encoder is left. This preserves
147 * compatibility with the legacy set_config behavior.
148 */
149 drm_connector_list_iter_begin(state->dev, &conn_iter);
150 drm_for_each_connector_iter(connector, &conn_iter) {
151 struct drm_crtc_state *crtc_state;
152
153 if (drm_atomic_get_new_connector_state(state, connector))
154 continue;
155
156 encoder = connector->state->best_encoder;
157 if (!encoder || !(encoder_mask & (1 << drm_encoder_index(encoder))))
158 continue;
159
160 if (!disable_conflicting_encoders) {
161 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s] by [CONNECTOR:%d:%s]\n",
162 encoder->base.id, encoder->name,
163 connector->state->crtc->base.id,
164 connector->state->crtc->name,
165 connector->base.id, connector->name);
166 ret = -EINVAL;
167 goto out;
168 }
169
170 new_conn_state = drm_atomic_get_connector_state(state, connector);
171 if (IS_ERR(new_conn_state)) {
172 ret = PTR_ERR(new_conn_state);
173 goto out;
174 }
175
176 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], disabling [CONNECTOR:%d:%s]\n",
177 encoder->base.id, encoder->name,
178 new_conn_state->crtc->base.id, new_conn_state->crtc->name,
179 connector->base.id, connector->name);
180
181 crtc_state = drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
182
183 ret = drm_atomic_set_crtc_for_connector(new_conn_state, NULL);
184 if (ret)
185 goto out;
186
187 if (!crtc_state->connector_mask) {
188 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
189 NULL);
190 if (ret < 0)
191 goto out;
192
193 crtc_state->active = false;
194 }
195 }
196out:
197 drm_connector_list_iter_end(&conn_iter);
198
199 return ret;
200}
201
202static void
203set_best_encoder(struct drm_atomic_state *state,
204 struct drm_connector_state *conn_state,
205 struct drm_encoder *encoder)
206{
207 struct drm_crtc_state *crtc_state;
208 struct drm_crtc *crtc;
209
210 if (conn_state->best_encoder) {
211 /* Unset the encoder_mask in the old crtc state. */
212 crtc = conn_state->connector->state->crtc;
213
214 /* A NULL crtc is an error here because we should have
215 * duplicated a NULL best_encoder when crtc was NULL.
216 * As an exception restoring duplicated atomic state
217 * during resume is allowed, so don't warn when
218 * best_encoder is equal to encoder we intend to set.
219 */
220 WARN_ON(!crtc && encoder != conn_state->best_encoder);
221 if (crtc) {
222 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
223
224 crtc_state->encoder_mask &=
225 ~(1 << drm_encoder_index(conn_state->best_encoder));
226 }
227 }
228
229 if (encoder) {
230 crtc = conn_state->crtc;
231 WARN_ON(!crtc);
232 if (crtc) {
233 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
234
235 crtc_state->encoder_mask |=
236 1 << drm_encoder_index(encoder);
237 }
238 }
239
240 conn_state->best_encoder = encoder;
241}
242
243static void
244steal_encoder(struct drm_atomic_state *state,
245 struct drm_encoder *encoder)
246{
247 struct drm_crtc_state *crtc_state;
248 struct drm_connector *connector;
249 struct drm_connector_state *old_connector_state, *new_connector_state;
250 int i;
251
252 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
253 struct drm_crtc *encoder_crtc;
254
255 if (new_connector_state->best_encoder != encoder)
256 continue;
257
258 encoder_crtc = old_connector_state->crtc;
259
260 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d:%s], stealing it\n",
261 encoder->base.id, encoder->name,
262 encoder_crtc->base.id, encoder_crtc->name);
263
264 set_best_encoder(state, new_connector_state, NULL);
265
266 crtc_state = drm_atomic_get_new_crtc_state(state, encoder_crtc);
267 crtc_state->connectors_changed = true;
268
269 return;
270 }
271}
272
273static int
274update_connector_routing(struct drm_atomic_state *state,
275 struct drm_connector *connector,
276 struct drm_connector_state *old_connector_state,
277 struct drm_connector_state *new_connector_state)
278{
279 const struct drm_connector_helper_funcs *funcs;
280 struct drm_encoder *new_encoder;
281 struct drm_crtc_state *crtc_state;
282
283 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
284 connector->base.id,
285 connector->name);
286
287 if (old_connector_state->crtc != new_connector_state->crtc) {
288 if (old_connector_state->crtc) {
289 crtc_state = drm_atomic_get_new_crtc_state(state, old_connector_state->crtc);
290 crtc_state->connectors_changed = true;
291 }
292
293 if (new_connector_state->crtc) {
294 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
295 crtc_state->connectors_changed = true;
296 }
297 }
298
299 if (!new_connector_state->crtc) {
300 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
301 connector->base.id,
302 connector->name);
303
304 set_best_encoder(state, new_connector_state, NULL);
305
306 return 0;
307 }
308
309 funcs = connector->helper_private;
310
311 if (funcs->atomic_best_encoder)
312 new_encoder = funcs->atomic_best_encoder(connector,
313 new_connector_state);
314 else if (funcs->best_encoder)
315 new_encoder = funcs->best_encoder(connector);
316 else
317 new_encoder = drm_atomic_helper_best_encoder(connector);
318
319 if (!new_encoder) {
320 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
321 connector->base.id,
322 connector->name);
323 return -EINVAL;
324 }
325
326 if (!drm_encoder_crtc_ok(new_encoder, new_connector_state->crtc)) {
327 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] incompatible with [CRTC:%d:%s]\n",
328 new_encoder->base.id,
329 new_encoder->name,
330 new_connector_state->crtc->base.id,
331 new_connector_state->crtc->name);
332 return -EINVAL;
333 }
334
335 if (new_encoder == new_connector_state->best_encoder) {
336 set_best_encoder(state, new_connector_state, new_encoder);
337
338 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d:%s]\n",
339 connector->base.id,
340 connector->name,
341 new_encoder->base.id,
342 new_encoder->name,
343 new_connector_state->crtc->base.id,
344 new_connector_state->crtc->name);
345
346 return 0;
347 }
348
349 steal_encoder(state, new_encoder);
350
351 set_best_encoder(state, new_connector_state, new_encoder);
352
353 crtc_state = drm_atomic_get_new_crtc_state(state, new_connector_state->crtc);
354 crtc_state->connectors_changed = true;
355
356 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d:%s]\n",
357 connector->base.id,
358 connector->name,
359 new_encoder->base.id,
360 new_encoder->name,
361 new_connector_state->crtc->base.id,
362 new_connector_state->crtc->name);
363
364 return 0;
365}
366
367static int
368mode_fixup(struct drm_atomic_state *state)
369{
370 struct drm_crtc *crtc;
371 struct drm_crtc_state *new_crtc_state;
372 struct drm_connector *connector;
373 struct drm_connector_state *new_conn_state;
374 int i;
375 int ret;
376
377 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
378 if (!new_crtc_state->mode_changed &&
379 !new_crtc_state->connectors_changed)
380 continue;
381
382 drm_mode_copy(&new_crtc_state->adjusted_mode, &new_crtc_state->mode);
383 }
384
385 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
386 const struct drm_encoder_helper_funcs *funcs;
387 struct drm_encoder *encoder;
388
389 WARN_ON(!!new_conn_state->best_encoder != !!new_conn_state->crtc);
390
391 if (!new_conn_state->crtc || !new_conn_state->best_encoder)
392 continue;
393
394 new_crtc_state =
395 drm_atomic_get_new_crtc_state(state, new_conn_state->crtc);
396
397 /*
398 * Each encoder has at most one connector (since we always steal
399 * it away), so we won't call ->mode_fixup twice.
400 */
401 encoder = new_conn_state->best_encoder;
402 funcs = encoder->helper_private;
403
404 ret = drm_bridge_mode_fixup(encoder->bridge, &new_crtc_state->mode,
405 &new_crtc_state->adjusted_mode);
406 if (!ret) {
407 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
408 return -EINVAL;
409 }
410
411 if (funcs && funcs->atomic_check) {
412 ret = funcs->atomic_check(encoder, new_crtc_state,
413 new_conn_state);
414 if (ret) {
415 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
416 encoder->base.id, encoder->name);
417 return ret;
418 }
419 } else if (funcs && funcs->mode_fixup) {
420 ret = funcs->mode_fixup(encoder, &new_crtc_state->mode,
421 &new_crtc_state->adjusted_mode);
422 if (!ret) {
423 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
424 encoder->base.id, encoder->name);
425 return -EINVAL;
426 }
427 }
428 }
429
430 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
431 const struct drm_crtc_helper_funcs *funcs;
432
433 if (!new_crtc_state->enable)
434 continue;
435
436 if (!new_crtc_state->mode_changed &&
437 !new_crtc_state->connectors_changed)
438 continue;
439
440 funcs = crtc->helper_private;
441 if (!funcs->mode_fixup)
442 continue;
443
444 ret = funcs->mode_fixup(crtc, &new_crtc_state->mode,
445 &new_crtc_state->adjusted_mode);
446 if (!ret) {
447 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] fixup failed\n",
448 crtc->base.id, crtc->name);
449 return -EINVAL;
450 }
451 }
452
453 return 0;
454}
455
456static enum drm_mode_status mode_valid_path(struct drm_connector *connector,
457 struct drm_encoder *encoder,
458 struct drm_crtc *crtc,
459 struct drm_display_mode *mode)
460{
461 enum drm_mode_status ret;
462
463 ret = drm_encoder_mode_valid(encoder, mode);
464 if (ret != MODE_OK) {
465 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] mode_valid() failed\n",
466 encoder->base.id, encoder->name);
467 return ret;
468 }
469
470 ret = drm_bridge_mode_valid(encoder->bridge, mode);
471 if (ret != MODE_OK) {
472 DRM_DEBUG_ATOMIC("[BRIDGE] mode_valid() failed\n");
473 return ret;
474 }
475
476 ret = drm_crtc_mode_valid(crtc, mode);
477 if (ret != MODE_OK) {
478 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode_valid() failed\n",
479 crtc->base.id, crtc->name);
480 return ret;
481 }
482
483 return ret;
484}
485
486static int
487mode_valid(struct drm_atomic_state *state)
488{
489 struct drm_connector_state *conn_state;
490 struct drm_connector *connector;
491 int i;
492
493 for_each_new_connector_in_state(state, connector, conn_state, i) {
494 struct drm_encoder *encoder = conn_state->best_encoder;
495 struct drm_crtc *crtc = conn_state->crtc;
496 struct drm_crtc_state *crtc_state;
497 enum drm_mode_status mode_status;
498 struct drm_display_mode *mode;
499
500 if (!crtc || !encoder)
501 continue;
502
503 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
504 if (!crtc_state)
505 continue;
506 if (!crtc_state->mode_changed && !crtc_state->connectors_changed)
507 continue;
508
509 mode = &crtc_state->mode;
510
511 mode_status = mode_valid_path(connector, encoder, crtc, mode);
512 if (mode_status != MODE_OK)
513 return -EINVAL;
514 }
515
516 return 0;
517}
518
519/**
520 * drm_atomic_helper_check_modeset - validate state object for modeset changes
521 * @dev: DRM device
522 * @state: the driver state object
523 *
524 * Check the state object to see if the requested state is physically possible.
525 * This does all the crtc and connector related computations for an atomic
526 * update and adds any additional connectors needed for full modesets. It calls
527 * the various per-object callbacks in the follow order:
528 *
529 * 1. &drm_connector_helper_funcs.atomic_best_encoder for determining the new encoder.
530 * 2. &drm_connector_helper_funcs.atomic_check to validate the connector state.
531 * 3. If it's determined a modeset is needed then all connectors on the affected crtc
532 * crtc are added and &drm_connector_helper_funcs.atomic_check is run on them.
533 * 4. &drm_encoder_helper_funcs.mode_valid, &drm_bridge_funcs.mode_valid and
534 * &drm_crtc_helper_funcs.mode_valid are called on the affected components.
535 * 5. &drm_bridge_funcs.mode_fixup is called on all encoder bridges.
536 * 6. &drm_encoder_helper_funcs.atomic_check is called to validate any encoder state.
537 * This function is only called when the encoder will be part of a configured crtc,
538 * it must not be used for implementing connector property validation.
539 * If this function is NULL, &drm_atomic_encoder_helper_funcs.mode_fixup is called
540 * instead.
541 * 7. &drm_crtc_helper_funcs.mode_fixup is called last, to fix up the mode with crtc constraints.
542 *
543 * &drm_crtc_state.mode_changed is set when the input mode is changed.
544 * &drm_crtc_state.connectors_changed is set when a connector is added or
545 * removed from the crtc. &drm_crtc_state.active_changed is set when
546 * &drm_crtc_state.active changes, which is used for DPMS.
547 * See also: drm_atomic_crtc_needs_modeset()
548 *
549 * IMPORTANT:
550 *
551 * Drivers which set &drm_crtc_state.mode_changed (e.g. in their
552 * &drm_plane_helper_funcs.atomic_check hooks if a plane update can't be done
553 * without a full modeset) _must_ call this function afterwards after that
554 * change. It is permitted to call this function multiple times for the same
555 * update, e.g. when the &drm_crtc_helper_funcs.atomic_check functions depend
556 * upon the adjusted dotclock for fifo space allocation and watermark
557 * computation.
558 *
559 * RETURNS:
560 * Zero for success or -errno
561 */
562int
563drm_atomic_helper_check_modeset(struct drm_device *dev,
564 struct drm_atomic_state *state)
565{
566 struct drm_crtc *crtc;
567 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
568 struct drm_connector *connector;
569 struct drm_connector_state *old_connector_state, *new_connector_state;
570 int i, ret;
571 unsigned connectors_mask = 0;
572
573 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
574 bool has_connectors =
575 !!new_crtc_state->connector_mask;
576
577 WARN_ON(!drm_modeset_is_locked(&crtc->mutex));
578
579 if (!drm_mode_equal(&old_crtc_state->mode, &new_crtc_state->mode)) {
580 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] mode changed\n",
581 crtc->base.id, crtc->name);
582 new_crtc_state->mode_changed = true;
583 }
584
585 if (old_crtc_state->enable != new_crtc_state->enable) {
586 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enable changed\n",
587 crtc->base.id, crtc->name);
588
589 /*
590 * For clarity this assignment is done here, but
591 * enable == 0 is only true when there are no
592 * connectors and a NULL mode.
593 *
594 * The other way around is true as well. enable != 0
595 * iff connectors are attached and a mode is set.
596 */
597 new_crtc_state->mode_changed = true;
598 new_crtc_state->connectors_changed = true;
599 }
600
601 if (old_crtc_state->active != new_crtc_state->active) {
602 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] active changed\n",
603 crtc->base.id, crtc->name);
604 new_crtc_state->active_changed = true;
605 }
606
607 if (new_crtc_state->enable != has_connectors) {
608 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] enabled/connectors mismatch\n",
609 crtc->base.id, crtc->name);
610
611 return -EINVAL;
612 }
613 }
614
615 ret = handle_conflicting_encoders(state, false);
616 if (ret)
617 return ret;
618
619 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
620 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
621
622 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
623
624 /*
625 * This only sets crtc->connectors_changed for routing changes,
626 * drivers must set crtc->connectors_changed themselves when
627 * connector properties need to be updated.
628 */
629 ret = update_connector_routing(state, connector,
630 old_connector_state,
631 new_connector_state);
632 if (ret)
633 return ret;
634 if (old_connector_state->crtc) {
635 new_crtc_state = drm_atomic_get_new_crtc_state(state,
636 old_connector_state->crtc);
637 if (old_connector_state->link_status !=
638 new_connector_state->link_status)
639 new_crtc_state->connectors_changed = true;
640 }
641
642 if (funcs->atomic_check)
643 ret = funcs->atomic_check(connector, new_connector_state);
644 if (ret)
645 return ret;
646
647 connectors_mask += BIT(i);
648 }
649
650 /*
651 * After all the routing has been prepared we need to add in any
652 * connector which is itself unchanged, but who's crtc changes it's
653 * configuration. This must be done before calling mode_fixup in case a
654 * crtc only changed its mode but has the same set of connectors.
655 */
656 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
657 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
658 continue;
659
660 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] needs all connectors, enable: %c, active: %c\n",
661 crtc->base.id, crtc->name,
662 new_crtc_state->enable ? 'y' : 'n',
663 new_crtc_state->active ? 'y' : 'n');
664
665 ret = drm_atomic_add_affected_connectors(state, crtc);
666 if (ret != 0)
667 return ret;
668
669 ret = drm_atomic_add_affected_planes(state, crtc);
670 if (ret != 0)
671 return ret;
672 }
673
674 /*
675 * Iterate over all connectors again, to make sure atomic_check()
676 * has been called on them when a modeset is forced.
677 */
678 for_each_oldnew_connector_in_state(state, connector, old_connector_state, new_connector_state, i) {
679 const struct drm_connector_helper_funcs *funcs = connector->helper_private;
680
681 if (connectors_mask & BIT(i))
682 continue;
683
684 if (funcs->atomic_check)
685 ret = funcs->atomic_check(connector, new_connector_state);
686 if (ret)
687 return ret;
688 }
689
690 ret = mode_valid(state);
691 if (ret)
692 return ret;
693
694 return mode_fixup(state);
695}
696EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
697
698/**
699 * drm_atomic_helper_check_plane_state() - Check plane state for validity
700 * @plane_state: plane state to check
701 * @crtc_state: crtc state to check
702 * @min_scale: minimum @src:@dest scaling factor in 16.16 fixed point
703 * @max_scale: maximum @src:@dest scaling factor in 16.16 fixed point
704 * @can_position: is it legal to position the plane such that it
705 * doesn't cover the entire crtc? This will generally
706 * only be false for primary planes.
707 * @can_update_disabled: can the plane be updated while the crtc
708 * is disabled?
709 *
710 * Checks that a desired plane update is valid, and updates various
711 * bits of derived state (clipped coordinates etc.). Drivers that provide
712 * their own plane handling rather than helper-provided implementations may
713 * still wish to call this function to avoid duplication of error checking
714 * code.
715 *
716 * RETURNS:
717 * Zero if update appears valid, error code on failure
718 */
719int drm_atomic_helper_check_plane_state(struct drm_plane_state *plane_state,
720 const struct drm_crtc_state *crtc_state,
721 int min_scale,
722 int max_scale,
723 bool can_position,
724 bool can_update_disabled)
725{
726 struct drm_framebuffer *fb = plane_state->fb;
727 struct drm_rect *src = &plane_state->src;
728 struct drm_rect *dst = &plane_state->dst;
729 unsigned int rotation = plane_state->rotation;
730 struct drm_rect clip = {};
731 int hscale, vscale;
732
733 WARN_ON(plane_state->crtc && plane_state->crtc != crtc_state->crtc);
734
735 *src = drm_plane_state_src(plane_state);
736 *dst = drm_plane_state_dest(plane_state);
737
738 if (!fb) {
739 plane_state->visible = false;
740 return 0;
741 }
742
743 /* crtc should only be NULL when disabling (i.e., !fb) */
744 if (WARN_ON(!plane_state->crtc)) {
745 plane_state->visible = false;
746 return 0;
747 }
748
749 if (!crtc_state->enable && !can_update_disabled) {
750 DRM_DEBUG_KMS("Cannot update plane of a disabled CRTC.\n");
751 return -EINVAL;
752 }
753
754 drm_rect_rotate(src, fb->width << 16, fb->height << 16, rotation);
755
756 /* Check scaling */
757 hscale = drm_rect_calc_hscale(src, dst, min_scale, max_scale);
758 vscale = drm_rect_calc_vscale(src, dst, min_scale, max_scale);
759 if (hscale < 0 || vscale < 0) {
760 DRM_DEBUG_KMS("Invalid scaling of plane\n");
761 drm_rect_debug_print("src: ", &plane_state->src, true);
762 drm_rect_debug_print("dst: ", &plane_state->dst, false);
763 return -ERANGE;
764 }
765
766 if (crtc_state->enable)
767 drm_mode_get_hv_timing(&crtc_state->mode, &clip.x2, &clip.y2);
768
769 plane_state->visible = drm_rect_clip_scaled(src, dst, &clip, hscale, vscale);
770
771 drm_rect_rotate_inv(src, fb->width << 16, fb->height << 16, rotation);
772
773 if (!plane_state->visible)
774 /*
775 * Plane isn't visible; some drivers can handle this
776 * so we just return success here. Drivers that can't
777 * (including those that use the primary plane helper's
778 * update function) will return an error from their
779 * update_plane handler.
780 */
781 return 0;
782
783 if (!can_position && !drm_rect_equals(dst, &clip)) {
784 DRM_DEBUG_KMS("Plane must cover entire CRTC\n");
785 drm_rect_debug_print("dst: ", dst, false);
786 drm_rect_debug_print("clip: ", &clip, false);
787 return -EINVAL;
788 }
789
790 return 0;
791}
792EXPORT_SYMBOL(drm_atomic_helper_check_plane_state);
793
794/**
795 * drm_atomic_helper_check_planes - validate state object for planes changes
796 * @dev: DRM device
797 * @state: the driver state object
798 *
799 * Check the state object to see if the requested state is physically possible.
800 * This does all the plane update related checks using by calling into the
801 * &drm_crtc_helper_funcs.atomic_check and &drm_plane_helper_funcs.atomic_check
802 * hooks provided by the driver.
803 *
804 * It also sets &drm_crtc_state.planes_changed to indicate that a crtc has
805 * updated planes.
806 *
807 * RETURNS:
808 * Zero for success or -errno
809 */
810int
811drm_atomic_helper_check_planes(struct drm_device *dev,
812 struct drm_atomic_state *state)
813{
814 struct drm_crtc *crtc;
815 struct drm_crtc_state *new_crtc_state;
816 struct drm_plane *plane;
817 struct drm_plane_state *new_plane_state, *old_plane_state;
818 int i, ret = 0;
819
820 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
821 const struct drm_plane_helper_funcs *funcs;
822
823 WARN_ON(!drm_modeset_is_locked(&plane->mutex));
824
825 funcs = plane->helper_private;
826
827 drm_atomic_helper_plane_changed(state, old_plane_state, new_plane_state, plane);
828
829 if (!funcs || !funcs->atomic_check)
830 continue;
831
832 ret = funcs->atomic_check(plane, new_plane_state);
833 if (ret) {
834 DRM_DEBUG_ATOMIC("[PLANE:%d:%s] atomic driver check failed\n",
835 plane->base.id, plane->name);
836 return ret;
837 }
838 }
839
840 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
841 const struct drm_crtc_helper_funcs *funcs;
842
843 funcs = crtc->helper_private;
844
845 if (!funcs || !funcs->atomic_check)
846 continue;
847
848 ret = funcs->atomic_check(crtc, new_crtc_state);
849 if (ret) {
850 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] atomic driver check failed\n",
851 crtc->base.id, crtc->name);
852 return ret;
853 }
854 }
855
856 return ret;
857}
858EXPORT_SYMBOL(drm_atomic_helper_check_planes);
859
860/**
861 * drm_atomic_helper_check - validate state object
862 * @dev: DRM device
863 * @state: the driver state object
864 *
865 * Check the state object to see if the requested state is physically possible.
866 * Only crtcs and planes have check callbacks, so for any additional (global)
867 * checking that a driver needs it can simply wrap that around this function.
868 * Drivers without such needs can directly use this as their
869 * &drm_mode_config_funcs.atomic_check callback.
870 *
871 * This just wraps the two parts of the state checking for planes and modeset
872 * state in the default order: First it calls drm_atomic_helper_check_modeset()
873 * and then drm_atomic_helper_check_planes(). The assumption is that the
874 * @drm_plane_helper_funcs.atomic_check and @drm_crtc_helper_funcs.atomic_check
875 * functions depend upon an updated adjusted_mode.clock to e.g. properly compute
876 * watermarks.
877 *
878 * RETURNS:
879 * Zero for success or -errno
880 */
881int drm_atomic_helper_check(struct drm_device *dev,
882 struct drm_atomic_state *state)
883{
884 int ret;
885
886 ret = drm_atomic_helper_check_modeset(dev, state);
887 if (ret)
888 return ret;
889
890 ret = drm_atomic_helper_check_planes(dev, state);
891 if (ret)
892 return ret;
893
894 if (state->legacy_cursor_update)
895 state->async_update = !drm_atomic_helper_async_check(dev, state);
896
897 return ret;
898}
899EXPORT_SYMBOL(drm_atomic_helper_check);
900
901static void
902disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
903{
904 struct drm_connector *connector;
905 struct drm_connector_state *old_conn_state, *new_conn_state;
906 struct drm_crtc *crtc;
907 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
908 int i;
909
910 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
911 const struct drm_encoder_helper_funcs *funcs;
912 struct drm_encoder *encoder;
913
914 /* Shut down everything that's in the changeset and currently
915 * still on. So need to check the old, saved state. */
916 if (!old_conn_state->crtc)
917 continue;
918
919 old_crtc_state = drm_atomic_get_old_crtc_state(old_state, old_conn_state->crtc);
920
921 if (!old_crtc_state->active ||
922 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
923 continue;
924
925 encoder = old_conn_state->best_encoder;
926
927 /* We shouldn't get this far if we didn't previously have
928 * an encoder.. but WARN_ON() rather than explode.
929 */
930 if (WARN_ON(!encoder))
931 continue;
932
933 funcs = encoder->helper_private;
934
935 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
936 encoder->base.id, encoder->name);
937
938 /*
939 * Each encoder has at most one connector (since we always steal
940 * it away), so we won't call disable hooks twice.
941 */
942 drm_bridge_disable(encoder->bridge);
943
944 /* Right function depends upon target state. */
945 if (funcs) {
946 if (new_conn_state->crtc && funcs->prepare)
947 funcs->prepare(encoder);
948 else if (funcs->disable)
949 funcs->disable(encoder);
950 else if (funcs->dpms)
951 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
952 }
953
954 drm_bridge_post_disable(encoder->bridge);
955 }
956
957 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
958 const struct drm_crtc_helper_funcs *funcs;
959 int ret;
960
961 /* Shut down everything that needs a full modeset. */
962 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
963 continue;
964
965 if (!old_crtc_state->active)
966 continue;
967
968 funcs = crtc->helper_private;
969
970 DRM_DEBUG_ATOMIC("disabling [CRTC:%d:%s]\n",
971 crtc->base.id, crtc->name);
972
973
974 /* Right function depends upon target state. */
975 if (new_crtc_state->enable && funcs->prepare)
976 funcs->prepare(crtc);
977 else if (funcs->atomic_disable)
978 funcs->atomic_disable(crtc, old_crtc_state);
979 else if (funcs->disable)
980 funcs->disable(crtc);
981 else
982 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
983
984 if (!(dev->irq_enabled && dev->num_crtcs))
985 continue;
986
987 ret = drm_crtc_vblank_get(crtc);
988 WARN_ONCE(ret != -EINVAL, "driver forgot to call drm_crtc_vblank_off()\n");
989 if (ret == 0)
990 drm_crtc_vblank_put(crtc);
991 }
992}
993
994/**
995 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
996 * @dev: DRM device
997 * @old_state: atomic state object with old state structures
998 *
999 * This function updates all the various legacy modeset state pointers in
1000 * connectors, encoders and crtcs. It also updates the timestamping constants
1001 * used for precise vblank timestamps by calling
1002 * drm_calc_timestamping_constants().
1003 *
1004 * Drivers can use this for building their own atomic commit if they don't have
1005 * a pure helper-based modeset implementation.
1006 *
1007 * Since these updates are not synchronized with lockings, only code paths
1008 * called from &drm_mode_config_helper_funcs.atomic_commit_tail can look at the
1009 * legacy state filled out by this helper. Defacto this means this helper and
1010 * the legacy state pointers are only really useful for transitioning an
1011 * existing driver to the atomic world.
1012 */
1013void
1014drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
1015 struct drm_atomic_state *old_state)
1016{
1017 struct drm_connector *connector;
1018 struct drm_connector_state *old_conn_state, *new_conn_state;
1019 struct drm_crtc *crtc;
1020 struct drm_crtc_state *new_crtc_state;
1021 int i;
1022
1023 /* clear out existing links and update dpms */
1024 for_each_oldnew_connector_in_state(old_state, connector, old_conn_state, new_conn_state, i) {
1025 if (connector->encoder) {
1026 WARN_ON(!connector->encoder->crtc);
1027
1028 connector->encoder->crtc = NULL;
1029 connector->encoder = NULL;
1030 }
1031
1032 crtc = new_conn_state->crtc;
1033 if ((!crtc && old_conn_state->crtc) ||
1034 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
1035 int mode = DRM_MODE_DPMS_OFF;
1036
1037 if (crtc && crtc->state->active)
1038 mode = DRM_MODE_DPMS_ON;
1039
1040 connector->dpms = mode;
1041 }
1042 }
1043
1044 /* set new links */
1045 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1046 if (!new_conn_state->crtc)
1047 continue;
1048
1049 if (WARN_ON(!new_conn_state->best_encoder))
1050 continue;
1051
1052 connector->encoder = new_conn_state->best_encoder;
1053 connector->encoder->crtc = new_conn_state->crtc;
1054 }
1055
1056 /* set legacy state in the crtc structure */
1057 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1058 struct drm_plane *primary = crtc->primary;
1059 struct drm_plane_state *new_plane_state;
1060
1061 crtc->mode = new_crtc_state->mode;
1062 crtc->enabled = new_crtc_state->enable;
1063
1064 new_plane_state =
1065 drm_atomic_get_new_plane_state(old_state, primary);
1066
1067 if (new_plane_state && new_plane_state->crtc == crtc) {
1068 crtc->x = new_plane_state->src_x >> 16;
1069 crtc->y = new_plane_state->src_y >> 16;
1070 }
1071
1072 if (new_crtc_state->enable)
1073 drm_calc_timestamping_constants(crtc,
1074 &new_crtc_state->adjusted_mode);
1075 }
1076}
1077EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
1078
1079static void
1080crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
1081{
1082 struct drm_crtc *crtc;
1083 struct drm_crtc_state *new_crtc_state;
1084 struct drm_connector *connector;
1085 struct drm_connector_state *new_conn_state;
1086 int i;
1087
1088 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1089 const struct drm_crtc_helper_funcs *funcs;
1090
1091 if (!new_crtc_state->mode_changed)
1092 continue;
1093
1094 funcs = crtc->helper_private;
1095
1096 if (new_crtc_state->enable && funcs->mode_set_nofb) {
1097 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d:%s]\n",
1098 crtc->base.id, crtc->name);
1099
1100 funcs->mode_set_nofb(crtc);
1101 }
1102 }
1103
1104 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1105 const struct drm_encoder_helper_funcs *funcs;
1106 struct drm_encoder *encoder;
1107 struct drm_display_mode *mode, *adjusted_mode;
1108
1109 if (!new_conn_state->best_encoder)
1110 continue;
1111
1112 encoder = new_conn_state->best_encoder;
1113 funcs = encoder->helper_private;
1114 new_crtc_state = new_conn_state->crtc->state;
1115 mode = &new_crtc_state->mode;
1116 adjusted_mode = &new_crtc_state->adjusted_mode;
1117
1118 if (!new_crtc_state->mode_changed)
1119 continue;
1120
1121 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
1122 encoder->base.id, encoder->name);
1123
1124 /*
1125 * Each encoder has at most one connector (since we always steal
1126 * it away), so we won't call mode_set hooks twice.
1127 */
1128 if (funcs && funcs->atomic_mode_set) {
1129 funcs->atomic_mode_set(encoder, new_crtc_state,
1130 new_conn_state);
1131 } else if (funcs && funcs->mode_set) {
1132 funcs->mode_set(encoder, mode, adjusted_mode);
1133 }
1134
1135 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
1136 }
1137}
1138
1139/**
1140 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
1141 * @dev: DRM device
1142 * @old_state: atomic state object with old state structures
1143 *
1144 * This function shuts down all the outputs that need to be shut down and
1145 * prepares them (if required) with the new mode.
1146 *
1147 * For compatibility with legacy crtc helpers this should be called before
1148 * drm_atomic_helper_commit_planes(), which is what the default commit function
1149 * does. But drivers with different needs can group the modeset commits together
1150 * and do the plane commits at the end. This is useful for drivers doing runtime
1151 * PM since planes updates then only happen when the CRTC is actually enabled.
1152 */
1153void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
1154 struct drm_atomic_state *old_state)
1155{
1156 disable_outputs(dev, old_state);
1157
1158 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
1159
1160 crtc_set_mode(dev, old_state);
1161}
1162EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
1163
1164/**
1165 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
1166 * @dev: DRM device
1167 * @old_state: atomic state object with old state structures
1168 *
1169 * This function enables all the outputs with the new configuration which had to
1170 * be turned off for the update.
1171 *
1172 * For compatibility with legacy crtc helpers this should be called after
1173 * drm_atomic_helper_commit_planes(), which is what the default commit function
1174 * does. But drivers with different needs can group the modeset commits together
1175 * and do the plane commits at the end. This is useful for drivers doing runtime
1176 * PM since planes updates then only happen when the CRTC is actually enabled.
1177 */
1178void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
1179 struct drm_atomic_state *old_state)
1180{
1181 struct drm_crtc *crtc;
1182 struct drm_crtc_state *old_crtc_state;
1183 struct drm_crtc_state *new_crtc_state;
1184 struct drm_connector *connector;
1185 struct drm_connector_state *new_conn_state;
1186 int i;
1187
1188 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1189 const struct drm_crtc_helper_funcs *funcs;
1190
1191 /* Need to filter out CRTCs where only planes change. */
1192 if (!drm_atomic_crtc_needs_modeset(new_crtc_state))
1193 continue;
1194
1195 if (!new_crtc_state->active)
1196 continue;
1197
1198 funcs = crtc->helper_private;
1199
1200 if (new_crtc_state->enable) {
1201 DRM_DEBUG_ATOMIC("enabling [CRTC:%d:%s]\n",
1202 crtc->base.id, crtc->name);
1203
1204 if (funcs->atomic_enable)
1205 funcs->atomic_enable(crtc, old_crtc_state);
1206 else
1207 funcs->commit(crtc);
1208 }
1209 }
1210
1211 for_each_new_connector_in_state(old_state, connector, new_conn_state, i) {
1212 const struct drm_encoder_helper_funcs *funcs;
1213 struct drm_encoder *encoder;
1214
1215 if (!new_conn_state->best_encoder)
1216 continue;
1217
1218 if (!new_conn_state->crtc->state->active ||
1219 !drm_atomic_crtc_needs_modeset(new_conn_state->crtc->state))
1220 continue;
1221
1222 encoder = new_conn_state->best_encoder;
1223 funcs = encoder->helper_private;
1224
1225 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
1226 encoder->base.id, encoder->name);
1227
1228 /*
1229 * Each encoder has at most one connector (since we always steal
1230 * it away), so we won't call enable hooks twice.
1231 */
1232 drm_bridge_pre_enable(encoder->bridge);
1233
1234 if (funcs) {
1235 if (funcs->enable)
1236 funcs->enable(encoder);
1237 else if (funcs->commit)
1238 funcs->commit(encoder);
1239 }
1240
1241 drm_bridge_enable(encoder->bridge);
1242 }
1243}
1244EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
1245
1246/**
1247 * drm_atomic_helper_wait_for_fences - wait for fences stashed in plane state
1248 * @dev: DRM device
1249 * @state: atomic state object with old state structures
1250 * @pre_swap: If true, do an interruptible wait, and @state is the new state.
1251 * Otherwise @state is the old state.
1252 *
1253 * For implicit sync, driver should fish the exclusive fence out from the
1254 * incoming fb's and stash it in the drm_plane_state. This is called after
1255 * drm_atomic_helper_swap_state() so it uses the current plane state (and
1256 * just uses the atomic state to find the changed planes)
1257 *
1258 * Note that @pre_swap is needed since the point where we block for fences moves
1259 * around depending upon whether an atomic commit is blocking or
1260 * non-blocking. For non-blocking commit all waiting needs to happen after
1261 * drm_atomic_helper_swap_state() is called, but for blocking commits we want
1262 * to wait **before** we do anything that can't be easily rolled back. That is
1263 * before we call drm_atomic_helper_swap_state().
1264 *
1265 * Returns zero if success or < 0 if dma_fence_wait() fails.
1266 */
1267int drm_atomic_helper_wait_for_fences(struct drm_device *dev,
1268 struct drm_atomic_state *state,
1269 bool pre_swap)
1270{
1271 struct drm_plane *plane;
1272 struct drm_plane_state *new_plane_state;
1273 int i, ret;
1274
1275 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
1276 if (!new_plane_state->fence)
1277 continue;
1278
1279 WARN_ON(!new_plane_state->fb);
1280
1281 /*
1282 * If waiting for fences pre-swap (ie: nonblock), userspace can
1283 * still interrupt the operation. Instead of blocking until the
1284 * timer expires, make the wait interruptible.
1285 */
1286 ret = dma_fence_wait(new_plane_state->fence, pre_swap);
1287 if (ret)
1288 return ret;
1289
1290 dma_fence_put(new_plane_state->fence);
1291 new_plane_state->fence = NULL;
1292 }
1293
1294 return 0;
1295}
1296EXPORT_SYMBOL(drm_atomic_helper_wait_for_fences);
1297
1298/**
1299 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
1300 * @dev: DRM device
1301 * @old_state: atomic state object with old state structures
1302 *
1303 * Helper to, after atomic commit, wait for vblanks on all effected
1304 * crtcs (ie. before cleaning up old framebuffers using
1305 * drm_atomic_helper_cleanup_planes()). It will only wait on CRTCs where the
1306 * framebuffers have actually changed to optimize for the legacy cursor and
1307 * plane update use-case.
1308 *
1309 * Drivers using the nonblocking commit tracking support initialized by calling
1310 * drm_atomic_helper_setup_commit() should look at
1311 * drm_atomic_helper_wait_for_flip_done() as an alternative.
1312 */
1313void
1314drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
1315 struct drm_atomic_state *old_state)
1316{
1317 struct drm_crtc *crtc;
1318 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1319 int i, ret;
1320 unsigned crtc_mask = 0;
1321
1322 /*
1323 * Legacy cursor ioctls are completely unsynced, and userspace
1324 * relies on that (by doing tons of cursor updates).
1325 */
1326 if (old_state->legacy_cursor_update)
1327 return;
1328
1329 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
1330 if (!new_crtc_state->active)
1331 continue;
1332
1333 ret = drm_crtc_vblank_get(crtc);
1334 if (ret != 0)
1335 continue;
1336
1337 crtc_mask |= drm_crtc_mask(crtc);
1338 old_state->crtcs[i].last_vblank_count = drm_crtc_vblank_count(crtc);
1339 }
1340
1341 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1342 if (!(crtc_mask & drm_crtc_mask(crtc)))
1343 continue;
1344
1345 ret = wait_event_timeout(dev->vblank[i].queue,
1346 old_state->crtcs[i].last_vblank_count !=
1347 drm_crtc_vblank_count(crtc),
1348 msecs_to_jiffies(50));
1349
1350 WARN(!ret, "[CRTC:%d:%s] vblank wait timed out\n",
1351 crtc->base.id, crtc->name);
1352
1353 drm_crtc_vblank_put(crtc);
1354 }
1355}
1356EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
1357
1358/**
1359 * drm_atomic_helper_wait_for_flip_done - wait for all page flips to be done
1360 * @dev: DRM device
1361 * @old_state: atomic state object with old state structures
1362 *
1363 * Helper to, after atomic commit, wait for page flips on all effected
1364 * crtcs (ie. before cleaning up old framebuffers using
1365 * drm_atomic_helper_cleanup_planes()). Compared to
1366 * drm_atomic_helper_wait_for_vblanks() this waits for the completion of on all
1367 * CRTCs, assuming that cursors-only updates are signalling their completion
1368 * immediately (or using a different path).
1369 *
1370 * This requires that drivers use the nonblocking commit tracking support
1371 * initialized using drm_atomic_helper_setup_commit().
1372 */
1373void drm_atomic_helper_wait_for_flip_done(struct drm_device *dev,
1374 struct drm_atomic_state *old_state)
1375{
1376 struct drm_crtc_state *new_crtc_state;
1377 struct drm_crtc *crtc;
1378 int i;
1379
1380 for_each_new_crtc_in_state(old_state, crtc, new_crtc_state, i) {
1381 struct drm_crtc_commit *commit = new_crtc_state->commit;
1382 int ret;
1383
1384 if (!commit)
1385 continue;
1386
1387 ret = wait_for_completion_timeout(&commit->flip_done, 10 * HZ);
1388 if (ret == 0)
1389 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1390 crtc->base.id, crtc->name);
1391 }
1392}
1393EXPORT_SYMBOL(drm_atomic_helper_wait_for_flip_done);
1394
1395/**
1396 * drm_atomic_helper_commit_tail - commit atomic update to hardware
1397 * @old_state: atomic state object with old state structures
1398 *
1399 * This is the default implementation for the
1400 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1401 * that do not support runtime_pm or do not need the CRTC to be
1402 * enabled to perform a commit. Otherwise, see
1403 * drm_atomic_helper_commit_tail_rpm().
1404 *
1405 * Note that the default ordering of how the various stages are called is to
1406 * match the legacy modeset helper library closest.
1407 */
1408void drm_atomic_helper_commit_tail(struct drm_atomic_state *old_state)
1409{
1410 struct drm_device *dev = old_state->dev;
1411
1412 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1413
1414 drm_atomic_helper_commit_planes(dev, old_state, 0);
1415
1416 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1417
1418 drm_atomic_helper_commit_hw_done(old_state);
1419
1420 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1421
1422 drm_atomic_helper_cleanup_planes(dev, old_state);
1423}
1424EXPORT_SYMBOL(drm_atomic_helper_commit_tail);
1425
1426/**
1427 * drm_atomic_helper_commit_tail_rpm - commit atomic update to hardware
1428 * @old_state: new modeset state to be committed
1429 *
1430 * This is an alternative implementation for the
1431 * &drm_mode_config_helper_funcs.atomic_commit_tail hook, for drivers
1432 * that support runtime_pm or need the CRTC to be enabled to perform a
1433 * commit. Otherwise, one should use the default implementation
1434 * drm_atomic_helper_commit_tail().
1435 */
1436void drm_atomic_helper_commit_tail_rpm(struct drm_atomic_state *old_state)
1437{
1438 struct drm_device *dev = old_state->dev;
1439
1440 drm_atomic_helper_commit_modeset_disables(dev, old_state);
1441
1442 drm_atomic_helper_commit_modeset_enables(dev, old_state);
1443
1444 drm_atomic_helper_commit_planes(dev, old_state,
1445 DRM_PLANE_COMMIT_ACTIVE_ONLY);
1446
1447 drm_atomic_helper_commit_hw_done(old_state);
1448
1449 drm_atomic_helper_wait_for_vblanks(dev, old_state);
1450
1451 drm_atomic_helper_cleanup_planes(dev, old_state);
1452}
1453EXPORT_SYMBOL(drm_atomic_helper_commit_tail_rpm);
1454
1455static void commit_tail(struct drm_atomic_state *old_state)
1456{
1457 struct drm_device *dev = old_state->dev;
1458 const struct drm_mode_config_helper_funcs *funcs;
1459
1460 funcs = dev->mode_config.helper_private;
1461
1462 drm_atomic_helper_wait_for_fences(dev, old_state, false);
1463
1464 drm_atomic_helper_wait_for_dependencies(old_state);
1465
1466 if (funcs && funcs->atomic_commit_tail)
1467 funcs->atomic_commit_tail(old_state);
1468 else
1469 drm_atomic_helper_commit_tail(old_state);
1470
1471 drm_atomic_helper_commit_cleanup_done(old_state);
1472
1473 drm_atomic_state_put(old_state);
1474}
1475
1476static void commit_work(struct work_struct *work)
1477{
1478 struct drm_atomic_state *state = container_of(work,
1479 struct drm_atomic_state,
1480 commit_work);
1481 commit_tail(state);
1482}
1483
1484/**
1485 * drm_atomic_helper_async_check - check if state can be commited asynchronously
1486 * @dev: DRM device
1487 * @state: the driver state object
1488 *
1489 * This helper will check if it is possible to commit the state asynchronously.
1490 * Async commits are not supposed to swap the states like normal sync commits
1491 * but just do in-place changes on the current state.
1492 *
1493 * It will return 0 if the commit can happen in an asynchronous fashion or error
1494 * if not. Note that error just mean it can't be commited asynchronously, if it
1495 * fails the commit should be treated like a normal synchronous commit.
1496 */
1497int drm_atomic_helper_async_check(struct drm_device *dev,
1498 struct drm_atomic_state *state)
1499{
1500 struct drm_crtc *crtc;
1501 struct drm_crtc_state *crtc_state;
1502 struct drm_plane *plane;
1503 struct drm_plane_state *old_plane_state, *new_plane_state;
1504 const struct drm_plane_helper_funcs *funcs;
1505 int i, n_planes = 0;
1506
1507 for_each_new_crtc_in_state(state, crtc, crtc_state, i) {
1508 if (drm_atomic_crtc_needs_modeset(crtc_state))
1509 return -EINVAL;
1510 }
1511
1512 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i)
1513 n_planes++;
1514
1515 /* FIXME: we support only single plane updates for now */
1516 if (n_planes != 1)
1517 return -EINVAL;
1518
1519 if (!new_plane_state->crtc)
1520 return -EINVAL;
1521
1522 funcs = plane->helper_private;
1523 if (!funcs->atomic_async_update)
1524 return -EINVAL;
1525
1526 if (new_plane_state->fence)
1527 return -EINVAL;
1528
1529 /*
1530 * Don't do an async update if there is an outstanding commit modifying
1531 * the plane. This prevents our async update's changes from getting
1532 * overridden by a previous synchronous update's state.
1533 */
1534 if (old_plane_state->commit &&
1535 !try_wait_for_completion(&old_plane_state->commit->hw_done))
1536 return -EBUSY;
1537
1538 return funcs->atomic_async_check(plane, new_plane_state);
1539}
1540EXPORT_SYMBOL(drm_atomic_helper_async_check);
1541
1542/**
1543 * drm_atomic_helper_async_commit - commit state asynchronously
1544 * @dev: DRM device
1545 * @state: the driver state object
1546 *
1547 * This function commits a state asynchronously, i.e., not vblank
1548 * synchronized. It should be used on a state only when
1549 * drm_atomic_async_check() succeeds. Async commits are not supposed to swap
1550 * the states like normal sync commits, but just do in-place changes on the
1551 * current state.
1552 */
1553void drm_atomic_helper_async_commit(struct drm_device *dev,
1554 struct drm_atomic_state *state)
1555{
1556 struct drm_plane *plane;
1557 struct drm_plane_state *plane_state;
1558 const struct drm_plane_helper_funcs *funcs;
1559 int i;
1560
1561 for_each_new_plane_in_state(state, plane, plane_state, i) {
1562 funcs = plane->helper_private;
1563 funcs->atomic_async_update(plane, plane_state);
1564 }
1565}
1566EXPORT_SYMBOL(drm_atomic_helper_async_commit);
1567
1568/**
1569 * drm_atomic_helper_commit - commit validated state object
1570 * @dev: DRM device
1571 * @state: the driver state object
1572 * @nonblock: whether nonblocking behavior is requested.
1573 *
1574 * This function commits a with drm_atomic_helper_check() pre-validated state
1575 * object. This can still fail when e.g. the framebuffer reservation fails. This
1576 * function implements nonblocking commits, using
1577 * drm_atomic_helper_setup_commit() and related functions.
1578 *
1579 * Committing the actual hardware state is done through the
1580 * &drm_mode_config_helper_funcs.atomic_commit_tail callback, or it's default
1581 * implementation drm_atomic_helper_commit_tail().
1582 *
1583 * RETURNS:
1584 * Zero for success or -errno.
1585 */
1586int drm_atomic_helper_commit(struct drm_device *dev,
1587 struct drm_atomic_state *state,
1588 bool nonblock)
1589{
1590 int ret;
1591
1592 if (state->async_update) {
1593 ret = drm_atomic_helper_prepare_planes(dev, state);
1594 if (ret)
1595 return ret;
1596
1597 drm_atomic_helper_async_commit(dev, state);
1598 drm_atomic_helper_cleanup_planes(dev, state);
1599
1600 return 0;
1601 }
1602
1603 ret = drm_atomic_helper_setup_commit(state, nonblock);
1604 if (ret)
1605 return ret;
1606
1607 INIT_WORK(&state->commit_work, commit_work);
1608
1609 ret = drm_atomic_helper_prepare_planes(dev, state);
1610 if (ret)
1611 return ret;
1612
1613 if (!nonblock) {
1614 ret = drm_atomic_helper_wait_for_fences(dev, state, true);
1615 if (ret)
1616 goto err;
1617 }
1618
1619 /*
1620 * This is the point of no return - everything below never fails except
1621 * when the hw goes bonghits. Which means we can commit the new state on
1622 * the software side now.
1623 */
1624
1625 ret = drm_atomic_helper_swap_state(state, true);
1626 if (ret)
1627 goto err;
1628
1629 /*
1630 * Everything below can be run asynchronously without the need to grab
1631 * any modeset locks at all under one condition: It must be guaranteed
1632 * that the asynchronous work has either been cancelled (if the driver
1633 * supports it, which at least requires that the framebuffers get
1634 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1635 * before the new state gets committed on the software side with
1636 * drm_atomic_helper_swap_state().
1637 *
1638 * This scheme allows new atomic state updates to be prepared and
1639 * checked in parallel to the asynchronous completion of the previous
1640 * update. Which is important since compositors need to figure out the
1641 * composition of the next frame right after having submitted the
1642 * current layout.
1643 *
1644 * NOTE: Commit work has multiple phases, first hardware commit, then
1645 * cleanup. We want them to overlap, hence need system_unbound_wq to
1646 * make sure work items don't artifically stall on each another.
1647 */
1648
1649 drm_atomic_state_get(state);
1650 if (nonblock)
1651 queue_work(system_unbound_wq, &state->commit_work);
1652 else
1653 commit_tail(state);
1654
1655 return 0;
1656
1657err:
1658 drm_atomic_helper_cleanup_planes(dev, state);
1659 return ret;
1660}
1661EXPORT_SYMBOL(drm_atomic_helper_commit);
1662
1663/**
1664 * DOC: implementing nonblocking commit
1665 *
1666 * Nonblocking atomic commits have to be implemented in the following sequence:
1667 *
1668 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1669 * which commit needs to call which can fail, so we want to run it first and
1670 * synchronously.
1671 *
1672 * 2. Synchronize with any outstanding nonblocking commit worker threads which
1673 * might be affected the new state update. This can be done by either cancelling
1674 * or flushing the work items, depending upon whether the driver can deal with
1675 * cancelled updates. Note that it is important to ensure that the framebuffer
1676 * cleanup is still done when cancelling.
1677 *
1678 * Asynchronous workers need to have sufficient parallelism to be able to run
1679 * different atomic commits on different CRTCs in parallel. The simplest way to
1680 * achive this is by running them on the &system_unbound_wq work queue. Note
1681 * that drivers are not required to split up atomic commits and run an
1682 * individual commit in parallel - userspace is supposed to do that if it cares.
1683 * But it might be beneficial to do that for modesets, since those necessarily
1684 * must be done as one global operation, and enabling or disabling a CRTC can
1685 * take a long time. But even that is not required.
1686 *
1687 * 3. The software state is updated synchronously with
1688 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
1689 * locks means concurrent callers never see inconsistent state. And doing this
1690 * while it's guaranteed that no relevant nonblocking worker runs means that
1691 * nonblocking workers do not need grab any locks. Actually they must not grab
1692 * locks, for otherwise the work flushing will deadlock.
1693 *
1694 * 4. Schedule a work item to do all subsequent steps, using the split-out
1695 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1696 * then cleaning up the framebuffers after the old framebuffer is no longer
1697 * being displayed.
1698 *
1699 * The above scheme is implemented in the atomic helper libraries in
1700 * drm_atomic_helper_commit() using a bunch of helper functions. See
1701 * drm_atomic_helper_setup_commit() for a starting point.
1702 */
1703
1704static int stall_checks(struct drm_crtc *crtc, bool nonblock)
1705{
1706 struct drm_crtc_commit *commit, *stall_commit = NULL;
1707 bool completed = true;
1708 int i;
1709 long ret = 0;
1710
1711 spin_lock(&crtc->commit_lock);
1712 i = 0;
1713 list_for_each_entry(commit, &crtc->commit_list, commit_entry) {
1714 if (i == 0) {
1715 completed = try_wait_for_completion(&commit->flip_done);
1716 /* Userspace is not allowed to get ahead of the previous
1717 * commit with nonblocking ones. */
1718 if (!completed && nonblock) {
1719 spin_unlock(&crtc->commit_lock);
1720 return -EBUSY;
1721 }
1722 } else if (i == 1) {
1723 stall_commit = drm_crtc_commit_get(commit);
1724 break;
1725 }
1726
1727 i++;
1728 }
1729 spin_unlock(&crtc->commit_lock);
1730
1731 if (!stall_commit)
1732 return 0;
1733
1734 /* We don't want to let commits get ahead of cleanup work too much,
1735 * stalling on 2nd previous commit means triple-buffer won't ever stall.
1736 */
1737 ret = wait_for_completion_interruptible_timeout(&stall_commit->cleanup_done,
1738 10*HZ);
1739 if (ret == 0)
1740 DRM_ERROR("[CRTC:%d:%s] cleanup_done timed out\n",
1741 crtc->base.id, crtc->name);
1742
1743 drm_crtc_commit_put(stall_commit);
1744
1745 return ret < 0 ? ret : 0;
1746}
1747
1748static void release_crtc_commit(struct completion *completion)
1749{
1750 struct drm_crtc_commit *commit = container_of(completion,
1751 typeof(*commit),
1752 flip_done);
1753
1754 drm_crtc_commit_put(commit);
1755}
1756
1757static void init_commit(struct drm_crtc_commit *commit, struct drm_crtc *crtc)
1758{
1759 init_completion(&commit->flip_done);
1760 init_completion(&commit->hw_done);
1761 init_completion(&commit->cleanup_done);
1762 INIT_LIST_HEAD(&commit->commit_entry);
1763 kref_init(&commit->ref);
1764 commit->crtc = crtc;
1765}
1766
1767static struct drm_crtc_commit *
1768crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
1769{
1770 if (crtc) {
1771 struct drm_crtc_state *new_crtc_state;
1772
1773 new_crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
1774
1775 return new_crtc_state->commit;
1776 }
1777
1778 if (!state->fake_commit) {
1779 state->fake_commit = kzalloc(sizeof(*state->fake_commit), GFP_KERNEL);
1780 if (!state->fake_commit)
1781 return NULL;
1782
1783 init_commit(state->fake_commit, NULL);
1784 }
1785
1786 return state->fake_commit;
1787}
1788
1789/**
1790 * drm_atomic_helper_setup_commit - setup possibly nonblocking commit
1791 * @state: new modeset state to be committed
1792 * @nonblock: whether nonblocking behavior is requested.
1793 *
1794 * This function prepares @state to be used by the atomic helper's support for
1795 * nonblocking commits. Drivers using the nonblocking commit infrastructure
1796 * should always call this function from their
1797 * &drm_mode_config_funcs.atomic_commit hook.
1798 *
1799 * To be able to use this support drivers need to use a few more helper
1800 * functions. drm_atomic_helper_wait_for_dependencies() must be called before
1801 * actually committing the hardware state, and for nonblocking commits this call
1802 * must be placed in the async worker. See also drm_atomic_helper_swap_state()
1803 * and it's stall parameter, for when a driver's commit hooks look at the
1804 * &drm_crtc.state, &drm_plane.state or &drm_connector.state pointer directly.
1805 *
1806 * Completion of the hardware commit step must be signalled using
1807 * drm_atomic_helper_commit_hw_done(). After this step the driver is not allowed
1808 * to read or change any permanent software or hardware modeset state. The only
1809 * exception is state protected by other means than &drm_modeset_lock locks.
1810 * Only the free standing @state with pointers to the old state structures can
1811 * be inspected, e.g. to clean up old buffers using
1812 * drm_atomic_helper_cleanup_planes().
1813 *
1814 * At the very end, before cleaning up @state drivers must call
1815 * drm_atomic_helper_commit_cleanup_done().
1816 *
1817 * This is all implemented by in drm_atomic_helper_commit(), giving drivers a
1818 * complete and easy-to-use default implementation of the atomic_commit() hook.
1819 *
1820 * The tracking of asynchronously executed and still pending commits is done
1821 * using the core structure &drm_crtc_commit.
1822 *
1823 * By default there's no need to clean up resources allocated by this function
1824 * explicitly: drm_atomic_state_default_clear() will take care of that
1825 * automatically.
1826 *
1827 * Returns:
1828 *
1829 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
1830 * -ENOMEM on allocation failures and -EINTR when a signal is pending.
1831 */
1832int drm_atomic_helper_setup_commit(struct drm_atomic_state *state,
1833 bool nonblock)
1834{
1835 struct drm_crtc *crtc;
1836 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
1837 struct drm_connector *conn;
1838 struct drm_connector_state *old_conn_state, *new_conn_state;
1839 struct drm_plane *plane;
1840 struct drm_plane_state *old_plane_state, *new_plane_state;
1841 struct drm_crtc_commit *commit;
1842 int i, ret;
1843
1844 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
1845 commit = kzalloc(sizeof(*commit), GFP_KERNEL);
1846 if (!commit)
1847 return -ENOMEM;
1848
1849 init_commit(commit, crtc);
1850
1851 new_crtc_state->commit = commit;
1852
1853 ret = stall_checks(crtc, nonblock);
1854 if (ret)
1855 return ret;
1856
1857 /* Drivers only send out events when at least either current or
1858 * new CRTC state is active. Complete right away if everything
1859 * stays off. */
1860 if (!old_crtc_state->active && !new_crtc_state->active) {
1861 complete_all(&commit->flip_done);
1862 continue;
1863 }
1864
1865 /* Legacy cursor updates are fully unsynced. */
1866 if (state->legacy_cursor_update) {
1867 complete_all(&commit->flip_done);
1868 continue;
1869 }
1870
1871 if (!new_crtc_state->event) {
1872 commit->event = kzalloc(sizeof(*commit->event),
1873 GFP_KERNEL);
1874 if (!commit->event)
1875 return -ENOMEM;
1876
1877 new_crtc_state->event = commit->event;
1878 }
1879
1880 new_crtc_state->event->base.completion = &commit->flip_done;
1881 new_crtc_state->event->base.completion_release = release_crtc_commit;
1882 drm_crtc_commit_get(commit);
1883
1884 commit->abort_completion = true;
1885 }
1886
1887 for_each_oldnew_connector_in_state(state, conn, old_conn_state, new_conn_state, i) {
1888 /* Userspace is not allowed to get ahead of the previous
1889 * commit with nonblocking ones. */
1890 if (nonblock && old_conn_state->commit &&
1891 !try_wait_for_completion(&old_conn_state->commit->flip_done))
1892 return -EBUSY;
1893
1894 /* Always track connectors explicitly for e.g. link retraining. */
1895 commit = crtc_or_fake_commit(state, new_conn_state->crtc ?: old_conn_state->crtc);
1896 if (!commit)
1897 return -ENOMEM;
1898
1899 new_conn_state->commit = drm_crtc_commit_get(commit);
1900 }
1901
1902 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
1903 /* Userspace is not allowed to get ahead of the previous
1904 * commit with nonblocking ones. */
1905 if (nonblock && old_plane_state->commit &&
1906 !try_wait_for_completion(&old_plane_state->commit->flip_done))
1907 return -EBUSY;
1908
1909 /* Always track planes explicitly for async pageflip support. */
1910 commit = crtc_or_fake_commit(state, new_plane_state->crtc ?: old_plane_state->crtc);
1911 if (!commit)
1912 return -ENOMEM;
1913
1914 new_plane_state->commit = drm_crtc_commit_get(commit);
1915 }
1916
1917 return 0;
1918}
1919EXPORT_SYMBOL(drm_atomic_helper_setup_commit);
1920
1921/**
1922 * drm_atomic_helper_wait_for_dependencies - wait for required preceeding commits
1923 * @old_state: atomic state object with old state structures
1924 *
1925 * This function waits for all preceeding commits that touch the same CRTC as
1926 * @old_state to both be committed to the hardware (as signalled by
1927 * drm_atomic_helper_commit_hw_done) and executed by the hardware (as signalled
1928 * by calling drm_crtc_send_vblank_event() on the &drm_crtc_state.event).
1929 *
1930 * This is part of the atomic helper support for nonblocking commits, see
1931 * drm_atomic_helper_setup_commit() for an overview.
1932 */
1933void drm_atomic_helper_wait_for_dependencies(struct drm_atomic_state *old_state)
1934{
1935 struct drm_crtc *crtc;
1936 struct drm_crtc_state *old_crtc_state;
1937 struct drm_plane *plane;
1938 struct drm_plane_state *old_plane_state;
1939 struct drm_connector *conn;
1940 struct drm_connector_state *old_conn_state;
1941 struct drm_crtc_commit *commit;
1942 int i;
1943 long ret;
1944
1945 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
1946 commit = old_crtc_state->commit;
1947
1948 if (!commit)
1949 continue;
1950
1951 ret = wait_for_completion_timeout(&commit->hw_done,
1952 10*HZ);
1953 if (ret == 0)
1954 DRM_ERROR("[CRTC:%d:%s] hw_done timed out\n",
1955 crtc->base.id, crtc->name);
1956
1957 /* Currently no support for overwriting flips, hence
1958 * stall for previous one to execute completely. */
1959 ret = wait_for_completion_timeout(&commit->flip_done,
1960 10*HZ);
1961 if (ret == 0)
1962 DRM_ERROR("[CRTC:%d:%s] flip_done timed out\n",
1963 crtc->base.id, crtc->name);
1964 }
1965
1966 for_each_old_connector_in_state(old_state, conn, old_conn_state, i) {
1967 commit = old_conn_state->commit;
1968
1969 if (!commit)
1970 continue;
1971
1972 ret = wait_for_completion_timeout(&commit->hw_done,
1973 10*HZ);
1974 if (ret == 0)
1975 DRM_ERROR("[CONNECTOR:%d:%s] hw_done timed out\n",
1976 conn->base.id, conn->name);
1977
1978 /* Currently no support for overwriting flips, hence
1979 * stall for previous one to execute completely. */
1980 ret = wait_for_completion_timeout(&commit->flip_done,
1981 10*HZ);
1982 if (ret == 0)
1983 DRM_ERROR("[CONNECTOR:%d:%s] flip_done timed out\n",
1984 conn->base.id, conn->name);
1985 }
1986
1987 for_each_old_plane_in_state(old_state, plane, old_plane_state, i) {
1988 commit = old_plane_state->commit;
1989
1990 if (!commit)
1991 continue;
1992
1993 ret = wait_for_completion_timeout(&commit->hw_done,
1994 10*HZ);
1995 if (ret == 0)
1996 DRM_ERROR("[PLANE:%d:%s] hw_done timed out\n",
1997 plane->base.id, plane->name);
1998
1999 /* Currently no support for overwriting flips, hence
2000 * stall for previous one to execute completely. */
2001 ret = wait_for_completion_timeout(&commit->flip_done,
2002 10*HZ);
2003 if (ret == 0)
2004 DRM_ERROR("[PLANE:%d:%s] flip_done timed out\n",
2005 plane->base.id, plane->name);
2006 }
2007}
2008EXPORT_SYMBOL(drm_atomic_helper_wait_for_dependencies);
2009
2010/**
2011 * drm_atomic_helper_commit_hw_done - setup possible nonblocking commit
2012 * @old_state: atomic state object with old state structures
2013 *
2014 * This function is used to signal completion of the hardware commit step. After
2015 * this step the driver is not allowed to read or change any permanent software
2016 * or hardware modeset state. The only exception is state protected by other
2017 * means than &drm_modeset_lock locks.
2018 *
2019 * Drivers should try to postpone any expensive or delayed cleanup work after
2020 * this function is called.
2021 *
2022 * This is part of the atomic helper support for nonblocking commits, see
2023 * drm_atomic_helper_setup_commit() for an overview.
2024 */
2025void drm_atomic_helper_commit_hw_done(struct drm_atomic_state *old_state)
2026{
2027 struct drm_crtc *crtc;
2028 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2029 struct drm_crtc_commit *commit;
2030 int i;
2031
2032 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2033 commit = new_crtc_state->commit;
2034 if (!commit)
2035 continue;
2036
2037 /*
2038 * copy new_crtc_state->commit to old_crtc_state->commit,
2039 * it's unsafe to touch new_crtc_state after hw_done,
2040 * but we still need to do so in cleanup_done().
2041 */
2042 if (old_crtc_state->commit)
2043 drm_crtc_commit_put(old_crtc_state->commit);
2044
2045 old_crtc_state->commit = drm_crtc_commit_get(commit);
2046
2047 /* backend must have consumed any event by now */
2048 WARN_ON(new_crtc_state->event);
2049 complete_all(&commit->hw_done);
2050 }
2051
2052 if (old_state->fake_commit) {
2053 complete_all(&old_state->fake_commit->hw_done);
2054 complete_all(&old_state->fake_commit->flip_done);
2055 }
2056}
2057EXPORT_SYMBOL(drm_atomic_helper_commit_hw_done);
2058
2059/**
2060 * drm_atomic_helper_commit_cleanup_done - signal completion of commit
2061 * @old_state: atomic state object with old state structures
2062 *
2063 * This signals completion of the atomic update @old_state, including any
2064 * cleanup work. If used, it must be called right before calling
2065 * drm_atomic_state_put().
2066 *
2067 * This is part of the atomic helper support for nonblocking commits, see
2068 * drm_atomic_helper_setup_commit() for an overview.
2069 */
2070void drm_atomic_helper_commit_cleanup_done(struct drm_atomic_state *old_state)
2071{
2072 struct drm_crtc *crtc;
2073 struct drm_crtc_state *old_crtc_state;
2074 struct drm_crtc_commit *commit;
2075 int i;
2076
2077 for_each_old_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2078 commit = old_crtc_state->commit;
2079 if (WARN_ON(!commit))
2080 continue;
2081
2082 complete_all(&commit->cleanup_done);
2083 WARN_ON(!try_wait_for_completion(&commit->hw_done));
2084
2085 spin_lock(&crtc->commit_lock);
2086 list_del(&commit->commit_entry);
2087 spin_unlock(&crtc->commit_lock);
2088 }
2089
2090 if (old_state->fake_commit)
2091 complete_all(&old_state->fake_commit->cleanup_done);
2092}
2093EXPORT_SYMBOL(drm_atomic_helper_commit_cleanup_done);
2094
2095/**
2096 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
2097 * @dev: DRM device
2098 * @state: atomic state object with new state structures
2099 *
2100 * This function prepares plane state, specifically framebuffers, for the new
2101 * configuration, by calling &drm_plane_helper_funcs.prepare_fb. If any failure
2102 * is encountered this function will call &drm_plane_helper_funcs.cleanup_fb on
2103 * any already successfully prepared framebuffer.
2104 *
2105 * Returns:
2106 * 0 on success, negative error code on failure.
2107 */
2108int drm_atomic_helper_prepare_planes(struct drm_device *dev,
2109 struct drm_atomic_state *state)
2110{
2111 struct drm_plane *plane;
2112 struct drm_plane_state *new_plane_state;
2113 int ret, i, j;
2114
2115 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
2116 const struct drm_plane_helper_funcs *funcs;
2117
2118 funcs = plane->helper_private;
2119
2120 if (funcs->prepare_fb) {
2121 ret = funcs->prepare_fb(plane, new_plane_state);
2122 if (ret)
2123 goto fail;
2124 }
2125 }
2126
2127 return 0;
2128
2129fail:
2130 for_each_new_plane_in_state(state, plane, new_plane_state, j) {
2131 const struct drm_plane_helper_funcs *funcs;
2132
2133 if (j >= i)
2134 continue;
2135
2136 funcs = plane->helper_private;
2137
2138 if (funcs->cleanup_fb)
2139 funcs->cleanup_fb(plane, new_plane_state);
2140 }
2141
2142 return ret;
2143}
2144EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
2145
2146static bool plane_crtc_active(const struct drm_plane_state *state)
2147{
2148 return state->crtc && state->crtc->state->active;
2149}
2150
2151/**
2152 * drm_atomic_helper_commit_planes - commit plane state
2153 * @dev: DRM device
2154 * @old_state: atomic state object with old state structures
2155 * @flags: flags for committing plane state
2156 *
2157 * This function commits the new plane state using the plane and atomic helper
2158 * functions for planes and crtcs. It assumes that the atomic state has already
2159 * been pushed into the relevant object state pointers, since this step can no
2160 * longer fail.
2161 *
2162 * It still requires the global state object @old_state to know which planes and
2163 * crtcs need to be updated though.
2164 *
2165 * Note that this function does all plane updates across all CRTCs in one step.
2166 * If the hardware can't support this approach look at
2167 * drm_atomic_helper_commit_planes_on_crtc() instead.
2168 *
2169 * Plane parameters can be updated by applications while the associated CRTC is
2170 * disabled. The DRM/KMS core will store the parameters in the plane state,
2171 * which will be available to the driver when the CRTC is turned on. As a result
2172 * most drivers don't need to be immediately notified of plane updates for a
2173 * disabled CRTC.
2174 *
2175 * Unless otherwise needed, drivers are advised to set the ACTIVE_ONLY flag in
2176 * @flags in order not to receive plane update notifications related to a
2177 * disabled CRTC. This avoids the need to manually ignore plane updates in
2178 * driver code when the driver and/or hardware can't or just don't need to deal
2179 * with updates on disabled CRTCs, for example when supporting runtime PM.
2180 *
2181 * Drivers may set the NO_DISABLE_AFTER_MODESET flag in @flags if the relevant
2182 * display controllers require to disable a CRTC's planes when the CRTC is
2183 * disabled. This function would skip the &drm_plane_helper_funcs.atomic_disable
2184 * call for a plane if the CRTC of the old plane state needs a modesetting
2185 * operation. Of course, the drivers need to disable the planes in their CRTC
2186 * disable callbacks since no one else would do that.
2187 *
2188 * The drm_atomic_helper_commit() default implementation doesn't set the
2189 * ACTIVE_ONLY flag to most closely match the behaviour of the legacy helpers.
2190 * This should not be copied blindly by drivers.
2191 */
2192void drm_atomic_helper_commit_planes(struct drm_device *dev,
2193 struct drm_atomic_state *old_state,
2194 uint32_t flags)
2195{
2196 struct drm_crtc *crtc;
2197 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2198 struct drm_plane *plane;
2199 struct drm_plane_state *old_plane_state, *new_plane_state;
2200 int i;
2201 bool active_only = flags & DRM_PLANE_COMMIT_ACTIVE_ONLY;
2202 bool no_disable = flags & DRM_PLANE_COMMIT_NO_DISABLE_AFTER_MODESET;
2203
2204 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2205 const struct drm_crtc_helper_funcs *funcs;
2206
2207 funcs = crtc->helper_private;
2208
2209 if (!funcs || !funcs->atomic_begin)
2210 continue;
2211
2212 if (active_only && !new_crtc_state->active)
2213 continue;
2214
2215 funcs->atomic_begin(crtc, old_crtc_state);
2216 }
2217
2218 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2219 const struct drm_plane_helper_funcs *funcs;
2220 bool disabling;
2221
2222 funcs = plane->helper_private;
2223
2224 if (!funcs)
2225 continue;
2226
2227 disabling = drm_atomic_plane_disabling(old_plane_state,
2228 new_plane_state);
2229
2230 if (active_only) {
2231 /*
2232 * Skip planes related to inactive CRTCs. If the plane
2233 * is enabled use the state of the current CRTC. If the
2234 * plane is being disabled use the state of the old
2235 * CRTC to avoid skipping planes being disabled on an
2236 * active CRTC.
2237 */
2238 if (!disabling && !plane_crtc_active(new_plane_state))
2239 continue;
2240 if (disabling && !plane_crtc_active(old_plane_state))
2241 continue;
2242 }
2243
2244 /*
2245 * Special-case disabling the plane if drivers support it.
2246 */
2247 if (disabling && funcs->atomic_disable) {
2248 struct drm_crtc_state *crtc_state;
2249
2250 crtc_state = old_plane_state->crtc->state;
2251
2252 if (drm_atomic_crtc_needs_modeset(crtc_state) &&
2253 no_disable)
2254 continue;
2255
2256 funcs->atomic_disable(plane, old_plane_state);
2257 } else if (new_plane_state->crtc || disabling) {
2258 funcs->atomic_update(plane, old_plane_state);
2259 }
2260 }
2261
2262 for_each_oldnew_crtc_in_state(old_state, crtc, old_crtc_state, new_crtc_state, i) {
2263 const struct drm_crtc_helper_funcs *funcs;
2264
2265 funcs = crtc->helper_private;
2266
2267 if (!funcs || !funcs->atomic_flush)
2268 continue;
2269
2270 if (active_only && !new_crtc_state->active)
2271 continue;
2272
2273 funcs->atomic_flush(crtc, old_crtc_state);
2274 }
2275}
2276EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
2277
2278/**
2279 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
2280 * @old_crtc_state: atomic state object with the old crtc state
2281 *
2282 * This function commits the new plane state using the plane and atomic helper
2283 * functions for planes on the specific crtc. It assumes that the atomic state
2284 * has already been pushed into the relevant object state pointers, since this
2285 * step can no longer fail.
2286 *
2287 * This function is useful when plane updates should be done crtc-by-crtc
2288 * instead of one global step like drm_atomic_helper_commit_planes() does.
2289 *
2290 * This function can only be savely used when planes are not allowed to move
2291 * between different CRTCs because this function doesn't handle inter-CRTC
2292 * depencies. Callers need to ensure that either no such depencies exist,
2293 * resolve them through ordering of commit calls or through some other means.
2294 */
2295void
2296drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
2297{
2298 const struct drm_crtc_helper_funcs *crtc_funcs;
2299 struct drm_crtc *crtc = old_crtc_state->crtc;
2300 struct drm_atomic_state *old_state = old_crtc_state->state;
2301 struct drm_plane *plane;
2302 unsigned plane_mask;
2303
2304 plane_mask = old_crtc_state->plane_mask;
2305 plane_mask |= crtc->state->plane_mask;
2306
2307 crtc_funcs = crtc->helper_private;
2308 if (crtc_funcs && crtc_funcs->atomic_begin)
2309 crtc_funcs->atomic_begin(crtc, old_crtc_state);
2310
2311 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
2312 struct drm_plane_state *old_plane_state =
2313 drm_atomic_get_old_plane_state(old_state, plane);
2314 const struct drm_plane_helper_funcs *plane_funcs;
2315
2316 plane_funcs = plane->helper_private;
2317
2318 if (!old_plane_state || !plane_funcs)
2319 continue;
2320
2321 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
2322
2323 if (drm_atomic_plane_disabling(old_plane_state, plane->state) &&
2324 plane_funcs->atomic_disable)
2325 plane_funcs->atomic_disable(plane, old_plane_state);
2326 else if (plane->state->crtc ||
2327 drm_atomic_plane_disabling(old_plane_state, plane->state))
2328 plane_funcs->atomic_update(plane, old_plane_state);
2329 }
2330
2331 if (crtc_funcs && crtc_funcs->atomic_flush)
2332 crtc_funcs->atomic_flush(crtc, old_crtc_state);
2333}
2334EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
2335
2336/**
2337 * drm_atomic_helper_disable_planes_on_crtc - helper to disable CRTC's planes
2338 * @old_crtc_state: atomic state object with the old CRTC state
2339 * @atomic: if set, synchronize with CRTC's atomic_begin/flush hooks
2340 *
2341 * Disables all planes associated with the given CRTC. This can be
2342 * used for instance in the CRTC helper atomic_disable callback to disable
2343 * all planes.
2344 *
2345 * If the atomic-parameter is set the function calls the CRTC's
2346 * atomic_begin hook before and atomic_flush hook after disabling the
2347 * planes.
2348 *
2349 * It is a bug to call this function without having implemented the
2350 * &drm_plane_helper_funcs.atomic_disable plane hook.
2351 */
2352void
2353drm_atomic_helper_disable_planes_on_crtc(struct drm_crtc_state *old_crtc_state,
2354 bool atomic)
2355{
2356 struct drm_crtc *crtc = old_crtc_state->crtc;
2357 const struct drm_crtc_helper_funcs *crtc_funcs =
2358 crtc->helper_private;
2359 struct drm_plane *plane;
2360
2361 if (atomic && crtc_funcs && crtc_funcs->atomic_begin)
2362 crtc_funcs->atomic_begin(crtc, NULL);
2363
2364 drm_atomic_crtc_state_for_each_plane(plane, old_crtc_state) {
2365 const struct drm_plane_helper_funcs *plane_funcs =
2366 plane->helper_private;
2367
2368 if (!plane_funcs)
2369 continue;
2370
2371 WARN_ON(!plane_funcs->atomic_disable);
2372 if (plane_funcs->atomic_disable)
2373 plane_funcs->atomic_disable(plane, NULL);
2374 }
2375
2376 if (atomic && crtc_funcs && crtc_funcs->atomic_flush)
2377 crtc_funcs->atomic_flush(crtc, NULL);
2378}
2379EXPORT_SYMBOL(drm_atomic_helper_disable_planes_on_crtc);
2380
2381/**
2382 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
2383 * @dev: DRM device
2384 * @old_state: atomic state object with old state structures
2385 *
2386 * This function cleans up plane state, specifically framebuffers, from the old
2387 * configuration. Hence the old configuration must be perserved in @old_state to
2388 * be able to call this function.
2389 *
2390 * This function must also be called on the new state when the atomic update
2391 * fails at any point after calling drm_atomic_helper_prepare_planes().
2392 */
2393void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
2394 struct drm_atomic_state *old_state)
2395{
2396 struct drm_plane *plane;
2397 struct drm_plane_state *old_plane_state, *new_plane_state;
2398 int i;
2399
2400 for_each_oldnew_plane_in_state(old_state, plane, old_plane_state, new_plane_state, i) {
2401 const struct drm_plane_helper_funcs *funcs;
2402 struct drm_plane_state *plane_state;
2403
2404 /*
2405 * This might be called before swapping when commit is aborted,
2406 * in which case we have to cleanup the new state.
2407 */
2408 if (old_plane_state == plane->state)
2409 plane_state = new_plane_state;
2410 else
2411 plane_state = old_plane_state;
2412
2413 funcs = plane->helper_private;
2414
2415 if (funcs->cleanup_fb)
2416 funcs->cleanup_fb(plane, plane_state);
2417 }
2418}
2419EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
2420
2421/**
2422 * drm_atomic_helper_swap_state - store atomic state into current sw state
2423 * @state: atomic state
2424 * @stall: stall for preceeding commits
2425 *
2426 * This function stores the atomic state into the current state pointers in all
2427 * driver objects. It should be called after all failing steps have been done
2428 * and succeeded, but before the actual hardware state is committed.
2429 *
2430 * For cleanup and error recovery the current state for all changed objects will
2431 * be swapped into @state.
2432 *
2433 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
2434 *
2435 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
2436 *
2437 * 2. Do any other steps that might fail.
2438 *
2439 * 3. Put the staged state into the current state pointers with this function.
2440 *
2441 * 4. Actually commit the hardware state.
2442 *
2443 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
2444 * contains the old state. Also do any other cleanup required with that state.
2445 *
2446 * @stall must be set when nonblocking commits for this driver directly access
2447 * the &drm_plane.state, &drm_crtc.state or &drm_connector.state pointer. With
2448 * the current atomic helpers this is almost always the case, since the helpers
2449 * don't pass the right state structures to the callbacks.
2450 *
2451 * Returns:
2452 *
2453 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
2454 * waiting for the previous commits has been interrupted.
2455 */
2456int drm_atomic_helper_swap_state(struct drm_atomic_state *state,
2457 bool stall)
2458{
2459 int i, ret;
2460 struct drm_connector *connector;
2461 struct drm_connector_state *old_conn_state, *new_conn_state;
2462 struct drm_crtc *crtc;
2463 struct drm_crtc_state *old_crtc_state, *new_crtc_state;
2464 struct drm_plane *plane;
2465 struct drm_plane_state *old_plane_state, *new_plane_state;
2466 struct drm_crtc_commit *commit;
2467 struct drm_private_obj *obj;
2468 struct drm_private_state *old_obj_state, *new_obj_state;
2469
2470 if (stall) {
2471 /*
2472 * We have to stall for hw_done here before
2473 * drm_atomic_helper_wait_for_dependencies() because flip
2474 * depth > 1 is not yet supported by all drivers. As long as
2475 * obj->state is directly dereferenced anywhere in the drivers
2476 * atomic_commit_tail function, then it's unsafe to swap state
2477 * before drm_atomic_helper_commit_hw_done() is called.
2478 */
2479
2480 for_each_old_crtc_in_state(state, crtc, old_crtc_state, i) {
2481 commit = old_crtc_state->commit;
2482
2483 if (!commit)
2484 continue;
2485
2486 ret = wait_for_completion_interruptible(&commit->hw_done);
2487 if (ret)
2488 return ret;
2489 }
2490
2491 for_each_old_connector_in_state(state, connector, old_conn_state, i) {
2492 commit = old_conn_state->commit;
2493
2494 if (!commit)
2495 continue;
2496
2497 ret = wait_for_completion_interruptible(&commit->hw_done);
2498 if (ret)
2499 return ret;
2500 }
2501
2502 for_each_old_plane_in_state(state, plane, old_plane_state, i) {
2503 commit = old_plane_state->commit;
2504
2505 if (!commit)
2506 continue;
2507
2508 ret = wait_for_completion_interruptible(&commit->hw_done);
2509 if (ret)
2510 return ret;
2511 }
2512 }
2513
2514 for_each_oldnew_connector_in_state(state, connector, old_conn_state, new_conn_state, i) {
2515 WARN_ON(connector->state != old_conn_state);
2516
2517 old_conn_state->state = state;
2518 new_conn_state->state = NULL;
2519
2520 state->connectors[i].state = old_conn_state;
2521 connector->state = new_conn_state;
2522 }
2523
2524 for_each_oldnew_crtc_in_state(state, crtc, old_crtc_state, new_crtc_state, i) {
2525 WARN_ON(crtc->state != old_crtc_state);
2526
2527 old_crtc_state->state = state;
2528 new_crtc_state->state = NULL;
2529
2530 state->crtcs[i].state = old_crtc_state;
2531 crtc->state = new_crtc_state;
2532
2533 if (new_crtc_state->commit) {
2534 spin_lock(&crtc->commit_lock);
2535 list_add(&new_crtc_state->commit->commit_entry,
2536 &crtc->commit_list);
2537 spin_unlock(&crtc->commit_lock);
2538
2539 new_crtc_state->commit->event = NULL;
2540 }
2541 }
2542
2543 for_each_oldnew_plane_in_state(state, plane, old_plane_state, new_plane_state, i) {
2544 WARN_ON(plane->state != old_plane_state);
2545
2546 old_plane_state->state = state;
2547 new_plane_state->state = NULL;
2548
2549 state->planes[i].state = old_plane_state;
2550 plane->state = new_plane_state;
2551 }
2552
2553 for_each_oldnew_private_obj_in_state(state, obj, old_obj_state, new_obj_state, i) {
2554 WARN_ON(obj->state != old_obj_state);
2555
2556 old_obj_state->state = state;
2557 new_obj_state->state = NULL;
2558
2559 state->private_objs[i].state = old_obj_state;
2560 obj->state = new_obj_state;
2561 }
2562
2563 return 0;
2564}
2565EXPORT_SYMBOL(drm_atomic_helper_swap_state);
2566
2567/**
2568 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
2569 * @plane: plane object to update
2570 * @crtc: owning CRTC of owning plane
2571 * @fb: framebuffer to flip onto plane
2572 * @crtc_x: x offset of primary plane on crtc
2573 * @crtc_y: y offset of primary plane on crtc
2574 * @crtc_w: width of primary plane rectangle on crtc
2575 * @crtc_h: height of primary plane rectangle on crtc
2576 * @src_x: x offset of @fb for panning
2577 * @src_y: y offset of @fb for panning
2578 * @src_w: width of source rectangle in @fb
2579 * @src_h: height of source rectangle in @fb
2580 * @ctx: lock acquire context
2581 *
2582 * Provides a default plane update handler using the atomic driver interface.
2583 *
2584 * RETURNS:
2585 * Zero on success, error code on failure
2586 */
2587int drm_atomic_helper_update_plane(struct drm_plane *plane,
2588 struct drm_crtc *crtc,
2589 struct drm_framebuffer *fb,
2590 int crtc_x, int crtc_y,
2591 unsigned int crtc_w, unsigned int crtc_h,
2592 uint32_t src_x, uint32_t src_y,
2593 uint32_t src_w, uint32_t src_h,
2594 struct drm_modeset_acquire_ctx *ctx)
2595{
2596 struct drm_atomic_state *state;
2597 struct drm_plane_state *plane_state;
2598 int ret = 0;
2599
2600 state = drm_atomic_state_alloc(plane->dev);
2601 if (!state)
2602 return -ENOMEM;
2603
2604 state->acquire_ctx = ctx;
2605 plane_state = drm_atomic_get_plane_state(state, plane);
2606 if (IS_ERR(plane_state)) {
2607 ret = PTR_ERR(plane_state);
2608 goto fail;
2609 }
2610
2611 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
2612 if (ret != 0)
2613 goto fail;
2614 drm_atomic_set_fb_for_plane(plane_state, fb);
2615 plane_state->crtc_x = crtc_x;
2616 plane_state->crtc_y = crtc_y;
2617 plane_state->crtc_w = crtc_w;
2618 plane_state->crtc_h = crtc_h;
2619 plane_state->src_x = src_x;
2620 plane_state->src_y = src_y;
2621 plane_state->src_w = src_w;
2622 plane_state->src_h = src_h;
2623
2624 if (plane == crtc->cursor)
2625 state->legacy_cursor_update = true;
2626
2627 ret = drm_atomic_commit(state);
2628fail:
2629 drm_atomic_state_put(state);
2630 return ret;
2631}
2632EXPORT_SYMBOL(drm_atomic_helper_update_plane);
2633
2634/**
2635 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
2636 * @plane: plane to disable
2637 * @ctx: lock acquire context
2638 *
2639 * Provides a default plane disable handler using the atomic driver interface.
2640 *
2641 * RETURNS:
2642 * Zero on success, error code on failure
2643 */
2644int drm_atomic_helper_disable_plane(struct drm_plane *plane,
2645 struct drm_modeset_acquire_ctx *ctx)
2646{
2647 struct drm_atomic_state *state;
2648 struct drm_plane_state *plane_state;
2649 int ret = 0;
2650
2651 state = drm_atomic_state_alloc(plane->dev);
2652 if (!state)
2653 return -ENOMEM;
2654
2655 state->acquire_ctx = ctx;
2656 plane_state = drm_atomic_get_plane_state(state, plane);
2657 if (IS_ERR(plane_state)) {
2658 ret = PTR_ERR(plane_state);
2659 goto fail;
2660 }
2661
2662 if (plane_state->crtc && (plane == plane->crtc->cursor))
2663 plane_state->state->legacy_cursor_update = true;
2664
2665 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
2666 if (ret != 0)
2667 goto fail;
2668
2669 ret = drm_atomic_commit(state);
2670fail:
2671 drm_atomic_state_put(state);
2672 return ret;
2673}
2674EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
2675
2676/* just used from fb-helper and atomic-helper: */
2677int __drm_atomic_helper_disable_plane(struct drm_plane *plane,
2678 struct drm_plane_state *plane_state)
2679{
2680 int ret;
2681
2682 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2683 if (ret != 0)
2684 return ret;
2685
2686 drm_atomic_set_fb_for_plane(plane_state, NULL);
2687 plane_state->crtc_x = 0;
2688 plane_state->crtc_y = 0;
2689 plane_state->crtc_w = 0;
2690 plane_state->crtc_h = 0;
2691 plane_state->src_x = 0;
2692 plane_state->src_y = 0;
2693 plane_state->src_w = 0;
2694 plane_state->src_h = 0;
2695
2696 return 0;
2697}
2698
2699static int update_output_state(struct drm_atomic_state *state,
2700 struct drm_mode_set *set)
2701{
2702 struct drm_device *dev = set->crtc->dev;
2703 struct drm_crtc *crtc;
2704 struct drm_crtc_state *new_crtc_state;
2705 struct drm_connector *connector;
2706 struct drm_connector_state *new_conn_state;
2707 int ret, i;
2708
2709 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
2710 state->acquire_ctx);
2711 if (ret)
2712 return ret;
2713
2714 /* First disable all connectors on the target crtc. */
2715 ret = drm_atomic_add_affected_connectors(state, set->crtc);
2716 if (ret)
2717 return ret;
2718
2719 for_each_new_connector_in_state(state, connector, new_conn_state, i) {
2720 if (new_conn_state->crtc == set->crtc) {
2721 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2722 NULL);
2723 if (ret)
2724 return ret;
2725
2726 /* Make sure legacy setCrtc always re-trains */
2727 new_conn_state->link_status = DRM_LINK_STATUS_GOOD;
2728 }
2729 }
2730
2731 /* Then set all connectors from set->connectors on the target crtc */
2732 for (i = 0; i < set->num_connectors; i++) {
2733 new_conn_state = drm_atomic_get_connector_state(state,
2734 set->connectors[i]);
2735 if (IS_ERR(new_conn_state))
2736 return PTR_ERR(new_conn_state);
2737
2738 ret = drm_atomic_set_crtc_for_connector(new_conn_state,
2739 set->crtc);
2740 if (ret)
2741 return ret;
2742 }
2743
2744 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i) {
2745 /* Don't update ->enable for the CRTC in the set_config request,
2746 * since a mismatch would indicate a bug in the upper layers.
2747 * The actual modeset code later on will catch any
2748 * inconsistencies here. */
2749 if (crtc == set->crtc)
2750 continue;
2751
2752 if (!new_crtc_state->connector_mask) {
2753 ret = drm_atomic_set_mode_prop_for_crtc(new_crtc_state,
2754 NULL);
2755 if (ret < 0)
2756 return ret;
2757
2758 new_crtc_state->active = false;
2759 }
2760 }
2761
2762 return 0;
2763}
2764
2765/**
2766 * drm_atomic_helper_set_config - set a new config from userspace
2767 * @set: mode set configuration
2768 * @ctx: lock acquisition context
2769 *
2770 * Provides a default crtc set_config handler using the atomic driver interface.
2771 *
2772 * NOTE: For backwards compatibility with old userspace this automatically
2773 * resets the "link-status" property to GOOD, to force any link
2774 * re-training. The SETCRTC ioctl does not define whether an update does
2775 * need a full modeset or just a plane update, hence we're allowed to do
2776 * that. See also drm_mode_connector_set_link_status_property().
2777 *
2778 * Returns:
2779 * Returns 0 on success, negative errno numbers on failure.
2780 */
2781int drm_atomic_helper_set_config(struct drm_mode_set *set,
2782 struct drm_modeset_acquire_ctx *ctx)
2783{
2784 struct drm_atomic_state *state;
2785 struct drm_crtc *crtc = set->crtc;
2786 int ret = 0;
2787
2788 state = drm_atomic_state_alloc(crtc->dev);
2789 if (!state)
2790 return -ENOMEM;
2791
2792 state->acquire_ctx = ctx;
2793 ret = __drm_atomic_helper_set_config(set, state);
2794 if (ret != 0)
2795 goto fail;
2796
2797 ret = handle_conflicting_encoders(state, true);
2798 if (ret)
2799 return ret;
2800
2801 ret = drm_atomic_commit(state);
2802
2803fail:
2804 drm_atomic_state_put(state);
2805 return ret;
2806}
2807EXPORT_SYMBOL(drm_atomic_helper_set_config);
2808
2809/* just used from fb-helper and atomic-helper: */
2810int __drm_atomic_helper_set_config(struct drm_mode_set *set,
2811 struct drm_atomic_state *state)
2812{
2813 struct drm_crtc_state *crtc_state;
2814 struct drm_plane_state *primary_state;
2815 struct drm_crtc *crtc = set->crtc;
2816 int hdisplay, vdisplay;
2817 int ret;
2818
2819 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2820 if (IS_ERR(crtc_state))
2821 return PTR_ERR(crtc_state);
2822
2823 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
2824 if (IS_ERR(primary_state))
2825 return PTR_ERR(primary_state);
2826
2827 if (!set->mode) {
2828 WARN_ON(set->fb);
2829 WARN_ON(set->num_connectors);
2830
2831 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
2832 if (ret != 0)
2833 return ret;
2834
2835 crtc_state->active = false;
2836
2837 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
2838 if (ret != 0)
2839 return ret;
2840
2841 drm_atomic_set_fb_for_plane(primary_state, NULL);
2842
2843 goto commit;
2844 }
2845
2846 WARN_ON(!set->fb);
2847 WARN_ON(!set->num_connectors);
2848
2849 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
2850 if (ret != 0)
2851 return ret;
2852
2853 crtc_state->active = true;
2854
2855 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
2856 if (ret != 0)
2857 return ret;
2858
2859 drm_mode_get_hv_timing(set->mode, &hdisplay, &vdisplay);
2860
2861 drm_atomic_set_fb_for_plane(primary_state, set->fb);
2862 primary_state->crtc_x = 0;
2863 primary_state->crtc_y = 0;
2864 primary_state->crtc_w = hdisplay;
2865 primary_state->crtc_h = vdisplay;
2866 primary_state->src_x = set->x << 16;
2867 primary_state->src_y = set->y << 16;
2868 if (drm_rotation_90_or_270(primary_state->rotation)) {
2869 primary_state->src_w = vdisplay << 16;
2870 primary_state->src_h = hdisplay << 16;
2871 } else {
2872 primary_state->src_w = hdisplay << 16;
2873 primary_state->src_h = vdisplay << 16;
2874 }
2875
2876commit:
2877 ret = update_output_state(state, set);
2878 if (ret)
2879 return ret;
2880
2881 return 0;
2882}
2883
2884/**
2885 * drm_atomic_helper_disable_all - disable all currently active outputs
2886 * @dev: DRM device
2887 * @ctx: lock acquisition context
2888 *
2889 * Loops through all connectors, finding those that aren't turned off and then
2890 * turns them off by setting their DPMS mode to OFF and deactivating the CRTC
2891 * that they are connected to.
2892 *
2893 * This is used for example in suspend/resume to disable all currently active
2894 * functions when suspending. If you just want to shut down everything at e.g.
2895 * driver unload, look at drm_atomic_helper_shutdown().
2896 *
2897 * Note that if callers haven't already acquired all modeset locks this might
2898 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
2899 *
2900 * Returns:
2901 * 0 on success or a negative error code on failure.
2902 *
2903 * See also:
2904 * drm_atomic_helper_suspend(), drm_atomic_helper_resume() and
2905 * drm_atomic_helper_shutdown().
2906 */
2907int drm_atomic_helper_disable_all(struct drm_device *dev,
2908 struct drm_modeset_acquire_ctx *ctx)
2909{
2910 struct drm_atomic_state *state;
2911 struct drm_connector_state *conn_state;
2912 struct drm_connector *conn;
2913 struct drm_plane_state *plane_state;
2914 struct drm_plane *plane;
2915 struct drm_crtc_state *crtc_state;
2916 struct drm_crtc *crtc;
2917 unsigned plane_mask = 0;
2918 int ret, i;
2919
2920 state = drm_atomic_state_alloc(dev);
2921 if (!state)
2922 return -ENOMEM;
2923
2924 state->acquire_ctx = ctx;
2925
2926 drm_for_each_crtc(crtc, dev) {
2927 crtc_state = drm_atomic_get_crtc_state(state, crtc);
2928 if (IS_ERR(crtc_state)) {
2929 ret = PTR_ERR(crtc_state);
2930 goto free;
2931 }
2932
2933 crtc_state->active = false;
2934
2935 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state, NULL);
2936 if (ret < 0)
2937 goto free;
2938
2939 ret = drm_atomic_add_affected_planes(state, crtc);
2940 if (ret < 0)
2941 goto free;
2942
2943 ret = drm_atomic_add_affected_connectors(state, crtc);
2944 if (ret < 0)
2945 goto free;
2946 }
2947
2948 for_each_new_connector_in_state(state, conn, conn_state, i) {
2949 ret = drm_atomic_set_crtc_for_connector(conn_state, NULL);
2950 if (ret < 0)
2951 goto free;
2952 }
2953
2954 for_each_new_plane_in_state(state, plane, plane_state, i) {
2955 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
2956 if (ret < 0)
2957 goto free;
2958
2959 drm_atomic_set_fb_for_plane(plane_state, NULL);
2960 plane_mask |= BIT(drm_plane_index(plane));
2961 plane->old_fb = plane->fb;
2962 }
2963
2964 ret = drm_atomic_commit(state);
2965free:
2966 if (plane_mask)
2967 drm_atomic_clean_old_fb(dev, plane_mask, ret);
2968 drm_atomic_state_put(state);
2969 return ret;
2970}
2971
2972EXPORT_SYMBOL(drm_atomic_helper_disable_all);
2973
2974/**
2975 * drm_atomic_helper_shutdown - shutdown all CRTC
2976 * @dev: DRM device
2977 *
2978 * This shuts down all CRTC, which is useful for driver unloading. Shutdown on
2979 * suspend should instead be handled with drm_atomic_helper_suspend(), since
2980 * that also takes a snapshot of the modeset state to be restored on resume.
2981 *
2982 * This is just a convenience wrapper around drm_atomic_helper_disable_all(),
2983 * and it is the atomic version of drm_crtc_force_disable_all().
2984 */
2985void drm_atomic_helper_shutdown(struct drm_device *dev)
2986{
2987 struct drm_modeset_acquire_ctx ctx;
2988 int ret;
2989
2990 drm_modeset_acquire_init(&ctx, 0);
2991 while (1) {
2992 ret = drm_modeset_lock_all_ctx(dev, &ctx);
2993 if (!ret)
2994 ret = drm_atomic_helper_disable_all(dev, &ctx);
2995
2996 if (ret != -EDEADLK)
2997 break;
2998
2999 drm_modeset_backoff(&ctx);
3000 }
3001
3002 if (ret)
3003 DRM_ERROR("Disabling all crtc's during unload failed with %i\n", ret);
3004
3005 drm_modeset_drop_locks(&ctx);
3006 drm_modeset_acquire_fini(&ctx);
3007}
3008EXPORT_SYMBOL(drm_atomic_helper_shutdown);
3009
3010/**
3011 * drm_atomic_helper_suspend - subsystem-level suspend helper
3012 * @dev: DRM device
3013 *
3014 * Duplicates the current atomic state, disables all active outputs and then
3015 * returns a pointer to the original atomic state to the caller. Drivers can
3016 * pass this pointer to the drm_atomic_helper_resume() helper upon resume to
3017 * restore the output configuration that was active at the time the system
3018 * entered suspend.
3019 *
3020 * Note that it is potentially unsafe to use this. The atomic state object
3021 * returned by this function is assumed to be persistent. Drivers must ensure
3022 * that this holds true. Before calling this function, drivers must make sure
3023 * to suspend fbdev emulation so that nothing can be using the device.
3024 *
3025 * Returns:
3026 * A pointer to a copy of the state before suspend on success or an ERR_PTR()-
3027 * encoded error code on failure. Drivers should store the returned atomic
3028 * state object and pass it to the drm_atomic_helper_resume() helper upon
3029 * resume.
3030 *
3031 * See also:
3032 * drm_atomic_helper_duplicate_state(), drm_atomic_helper_disable_all(),
3033 * drm_atomic_helper_resume(), drm_atomic_helper_commit_duplicated_state()
3034 */
3035struct drm_atomic_state *drm_atomic_helper_suspend(struct drm_device *dev)
3036{
3037 struct drm_modeset_acquire_ctx ctx;
3038 struct drm_atomic_state *state;
3039 int err;
3040
3041 drm_modeset_acquire_init(&ctx, 0);
3042
3043retry:
3044 err = drm_modeset_lock_all_ctx(dev, &ctx);
3045 if (err < 0) {
3046 state = ERR_PTR(err);
3047 goto unlock;
3048 }
3049
3050 state = drm_atomic_helper_duplicate_state(dev, &ctx);
3051 if (IS_ERR(state))
3052 goto unlock;
3053
3054 err = drm_atomic_helper_disable_all(dev, &ctx);
3055 if (err < 0) {
3056 drm_atomic_state_put(state);
3057 state = ERR_PTR(err);
3058 goto unlock;
3059 }
3060
3061unlock:
3062 if (PTR_ERR(state) == -EDEADLK) {
3063 drm_modeset_backoff(&ctx);
3064 goto retry;
3065 }
3066
3067 drm_modeset_drop_locks(&ctx);
3068 drm_modeset_acquire_fini(&ctx);
3069 return state;
3070}
3071EXPORT_SYMBOL(drm_atomic_helper_suspend);
3072
3073/**
3074 * drm_atomic_helper_commit_duplicated_state - commit duplicated state
3075 * @state: duplicated atomic state to commit
3076 * @ctx: pointer to acquire_ctx to use for commit.
3077 *
3078 * The state returned by drm_atomic_helper_duplicate_state() and
3079 * drm_atomic_helper_suspend() is partially invalid, and needs to
3080 * be fixed up before commit.
3081 *
3082 * Returns:
3083 * 0 on success or a negative error code on failure.
3084 *
3085 * See also:
3086 * drm_atomic_helper_suspend()
3087 */
3088int drm_atomic_helper_commit_duplicated_state(struct drm_atomic_state *state,
3089 struct drm_modeset_acquire_ctx *ctx)
3090{
3091 int i;
3092 struct drm_plane *plane;
3093 struct drm_plane_state *new_plane_state;
3094 struct drm_connector *connector;
3095 struct drm_connector_state *new_conn_state;
3096 struct drm_crtc *crtc;
3097 struct drm_crtc_state *new_crtc_state;
3098 unsigned plane_mask = 0;
3099 struct drm_device *dev = state->dev;
3100 int ret;
3101
3102 state->acquire_ctx = ctx;
3103
3104 for_each_new_plane_in_state(state, plane, new_plane_state, i) {
3105 plane_mask |= BIT(drm_plane_index(plane));
3106 state->planes[i].old_state = plane->state;
3107 }
3108
3109 for_each_new_crtc_in_state(state, crtc, new_crtc_state, i)
3110 state->crtcs[i].old_state = crtc->state;
3111
3112 for_each_new_connector_in_state(state, connector, new_conn_state, i)
3113 state->connectors[i].old_state = connector->state;
3114
3115 ret = drm_atomic_commit(state);
3116 if (plane_mask)
3117 drm_atomic_clean_old_fb(dev, plane_mask, ret);
3118
3119 return ret;
3120}
3121EXPORT_SYMBOL(drm_atomic_helper_commit_duplicated_state);
3122
3123/**
3124 * drm_atomic_helper_resume - subsystem-level resume helper
3125 * @dev: DRM device
3126 * @state: atomic state to resume to
3127 *
3128 * Calls drm_mode_config_reset() to synchronize hardware and software states,
3129 * grabs all modeset locks and commits the atomic state object. This can be
3130 * used in conjunction with the drm_atomic_helper_suspend() helper to
3131 * implement suspend/resume for drivers that support atomic mode-setting.
3132 *
3133 * Returns:
3134 * 0 on success or a negative error code on failure.
3135 *
3136 * See also:
3137 * drm_atomic_helper_suspend()
3138 */
3139int drm_atomic_helper_resume(struct drm_device *dev,
3140 struct drm_atomic_state *state)
3141{
3142 struct drm_modeset_acquire_ctx ctx;
3143 int err;
3144
3145 drm_mode_config_reset(dev);
3146
3147 drm_modeset_acquire_init(&ctx, 0);
3148 while (1) {
3149 err = drm_modeset_lock_all_ctx(dev, &ctx);
3150 if (err)
3151 goto out;
3152
3153 err = drm_atomic_helper_commit_duplicated_state(state, &ctx);
3154out:
3155 if (err != -EDEADLK)
3156 break;
3157
3158 drm_modeset_backoff(&ctx);
3159 }
3160
3161 drm_atomic_state_put(state);
3162 drm_modeset_drop_locks(&ctx);
3163 drm_modeset_acquire_fini(&ctx);
3164
3165 return err;
3166}
3167EXPORT_SYMBOL(drm_atomic_helper_resume);
3168
3169static int page_flip_common(struct drm_atomic_state *state,
3170 struct drm_crtc *crtc,
3171 struct drm_framebuffer *fb,
3172 struct drm_pending_vblank_event *event,
3173 uint32_t flags)
3174{
3175 struct drm_plane *plane = crtc->primary;
3176 struct drm_plane_state *plane_state;
3177 struct drm_crtc_state *crtc_state;
3178 int ret = 0;
3179
3180 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3181 if (IS_ERR(crtc_state))
3182 return PTR_ERR(crtc_state);
3183
3184 crtc_state->event = event;
3185 crtc_state->pageflip_flags = flags;
3186
3187 plane_state = drm_atomic_get_plane_state(state, plane);
3188 if (IS_ERR(plane_state))
3189 return PTR_ERR(plane_state);
3190
3191 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
3192 if (ret != 0)
3193 return ret;
3194 drm_atomic_set_fb_for_plane(plane_state, fb);
3195
3196 /* Make sure we don't accidentally do a full modeset. */
3197 state->allow_modeset = false;
3198 if (!crtc_state->active) {
3199 DRM_DEBUG_ATOMIC("[CRTC:%d:%s] disabled, rejecting legacy flip\n",
3200 crtc->base.id, crtc->name);
3201 return -EINVAL;
3202 }
3203
3204 return ret;
3205}
3206
3207/**
3208 * drm_atomic_helper_page_flip - execute a legacy page flip
3209 * @crtc: DRM crtc
3210 * @fb: DRM framebuffer
3211 * @event: optional DRM event to signal upon completion
3212 * @flags: flip flags for non-vblank sync'ed updates
3213 * @ctx: lock acquisition context
3214 *
3215 * Provides a default &drm_crtc_funcs.page_flip implementation
3216 * using the atomic driver interface.
3217 *
3218 * Returns:
3219 * Returns 0 on success, negative errno numbers on failure.
3220 *
3221 * See also:
3222 * drm_atomic_helper_page_flip_target()
3223 */
3224int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
3225 struct drm_framebuffer *fb,
3226 struct drm_pending_vblank_event *event,
3227 uint32_t flags,
3228 struct drm_modeset_acquire_ctx *ctx)
3229{
3230 struct drm_plane *plane = crtc->primary;
3231 struct drm_atomic_state *state;
3232 int ret = 0;
3233
3234 state = drm_atomic_state_alloc(plane->dev);
3235 if (!state)
3236 return -ENOMEM;
3237
3238 state->acquire_ctx = ctx;
3239
3240 ret = page_flip_common(state, crtc, fb, event, flags);
3241 if (ret != 0)
3242 goto fail;
3243
3244 ret = drm_atomic_nonblocking_commit(state);
3245fail:
3246 drm_atomic_state_put(state);
3247 return ret;
3248}
3249EXPORT_SYMBOL(drm_atomic_helper_page_flip);
3250
3251/**
3252 * drm_atomic_helper_page_flip_target - do page flip on target vblank period.
3253 * @crtc: DRM crtc
3254 * @fb: DRM framebuffer
3255 * @event: optional DRM event to signal upon completion
3256 * @flags: flip flags for non-vblank sync'ed updates
3257 * @target: specifying the target vblank period when the flip to take effect
3258 * @ctx: lock acquisition context
3259 *
3260 * Provides a default &drm_crtc_funcs.page_flip_target implementation.
3261 * Similar to drm_atomic_helper_page_flip() with extra parameter to specify
3262 * target vblank period to flip.
3263 *
3264 * Returns:
3265 * Returns 0 on success, negative errno numbers on failure.
3266 */
3267int drm_atomic_helper_page_flip_target(struct drm_crtc *crtc,
3268 struct drm_framebuffer *fb,
3269 struct drm_pending_vblank_event *event,
3270 uint32_t flags,
3271 uint32_t target,
3272 struct drm_modeset_acquire_ctx *ctx)
3273{
3274 struct drm_plane *plane = crtc->primary;
3275 struct drm_atomic_state *state;
3276 struct drm_crtc_state *crtc_state;
3277 int ret = 0;
3278
3279 state = drm_atomic_state_alloc(plane->dev);
3280 if (!state)
3281 return -ENOMEM;
3282
3283 state->acquire_ctx = ctx;
3284
3285 ret = page_flip_common(state, crtc, fb, event, flags);
3286 if (ret != 0)
3287 goto fail;
3288
3289 crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
3290 if (WARN_ON(!crtc_state)) {
3291 ret = -EINVAL;
3292 goto fail;
3293 }
3294 crtc_state->target_vblank = target;
3295
3296 ret = drm_atomic_nonblocking_commit(state);
3297fail:
3298 drm_atomic_state_put(state);
3299 return ret;
3300}
3301EXPORT_SYMBOL(drm_atomic_helper_page_flip_target);
3302
3303/**
3304 * drm_atomic_helper_best_encoder - Helper for
3305 * &drm_connector_helper_funcs.best_encoder callback
3306 * @connector: Connector control structure
3307 *
3308 * This is a &drm_connector_helper_funcs.best_encoder callback helper for
3309 * connectors that support exactly 1 encoder, statically determined at driver
3310 * init time.
3311 */
3312struct drm_encoder *
3313drm_atomic_helper_best_encoder(struct drm_connector *connector)
3314{
3315 WARN_ON(connector->encoder_ids[1]);
3316 return drm_encoder_find(connector->dev, NULL, connector->encoder_ids[0]);
3317}
3318EXPORT_SYMBOL(drm_atomic_helper_best_encoder);
3319
3320/**
3321 * DOC: atomic state reset and initialization
3322 *
3323 * Both the drm core and the atomic helpers assume that there is always the full
3324 * and correct atomic software state for all connectors, CRTCs and planes
3325 * available. Which is a bit a problem on driver load and also after system
3326 * suspend. One way to solve this is to have a hardware state read-out
3327 * infrastructure which reconstructs the full software state (e.g. the i915
3328 * driver).
3329 *
3330 * The simpler solution is to just reset the software state to everything off,
3331 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
3332 * the atomic helpers provide default reset implementations for all hooks.
3333 *
3334 * On the upside the precise state tracking of atomic simplifies system suspend
3335 * and resume a lot. For drivers using drm_mode_config_reset() a complete recipe
3336 * is implemented in drm_atomic_helper_suspend() and drm_atomic_helper_resume().
3337 * For other drivers the building blocks are split out, see the documentation
3338 * for these functions.
3339 */
3340
3341/**
3342 * drm_atomic_helper_crtc_reset - default &drm_crtc_funcs.reset hook for CRTCs
3343 * @crtc: drm CRTC
3344 *
3345 * Resets the atomic state for @crtc by freeing the state pointer (which might
3346 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3347 */
3348void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
3349{
3350 if (crtc->state)
3351 __drm_atomic_helper_crtc_destroy_state(crtc->state);
3352
3353 kfree(crtc->state);
3354 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
3355
3356 if (crtc->state)
3357 crtc->state->crtc = crtc;
3358}
3359EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
3360
3361/**
3362 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
3363 * @crtc: CRTC object
3364 * @state: atomic CRTC state
3365 *
3366 * Copies atomic state from a CRTC's current state and resets inferred values.
3367 * This is useful for drivers that subclass the CRTC state.
3368 */
3369void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
3370 struct drm_crtc_state *state)
3371{
3372 memcpy(state, crtc->state, sizeof(*state));
3373
3374 if (state->mode_blob)
3375 drm_property_blob_get(state->mode_blob);
3376 if (state->degamma_lut)
3377 drm_property_blob_get(state->degamma_lut);
3378 if (state->ctm)
3379 drm_property_blob_get(state->ctm);
3380 if (state->gamma_lut)
3381 drm_property_blob_get(state->gamma_lut);
3382 state->mode_changed = false;
3383 state->active_changed = false;
3384 state->planes_changed = false;
3385 state->connectors_changed = false;
3386 state->color_mgmt_changed = false;
3387 state->zpos_changed = false;
3388 state->commit = NULL;
3389 state->event = NULL;
3390 state->pageflip_flags = 0;
3391}
3392EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
3393
3394/**
3395 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
3396 * @crtc: drm CRTC
3397 *
3398 * Default CRTC state duplicate hook for drivers which don't have their own
3399 * subclassed CRTC state structure.
3400 */
3401struct drm_crtc_state *
3402drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
3403{
3404 struct drm_crtc_state *state;
3405
3406 if (WARN_ON(!crtc->state))
3407 return NULL;
3408
3409 state = kmalloc(sizeof(*state), GFP_KERNEL);
3410 if (state)
3411 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
3412
3413 return state;
3414}
3415EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
3416
3417/**
3418 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
3419 * @state: CRTC state object to release
3420 *
3421 * Releases all resources stored in the CRTC state without actually freeing
3422 * the memory of the CRTC state. This is useful for drivers that subclass the
3423 * CRTC state.
3424 */
3425void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc_state *state)
3426{
3427 if (state->commit) {
3428 /*
3429 * In the event that a non-blocking commit returns
3430 * -ERESTARTSYS before the commit_tail work is queued, we will
3431 * have an extra reference to the commit object. Release it, if
3432 * the event has not been consumed by the worker.
3433 *
3434 * state->event may be freed, so we can't directly look at
3435 * state->event->base.completion.
3436 */
3437 if (state->event && state->commit->abort_completion)
3438 drm_crtc_commit_put(state->commit);
3439
3440 kfree(state->commit->event);
3441 state->commit->event = NULL;
3442
3443 drm_crtc_commit_put(state->commit);
3444 }
3445
3446 drm_property_blob_put(state->mode_blob);
3447 drm_property_blob_put(state->degamma_lut);
3448 drm_property_blob_put(state->ctm);
3449 drm_property_blob_put(state->gamma_lut);
3450}
3451EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
3452
3453/**
3454 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
3455 * @crtc: drm CRTC
3456 * @state: CRTC state object to release
3457 *
3458 * Default CRTC state destroy hook for drivers which don't have their own
3459 * subclassed CRTC state structure.
3460 */
3461void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
3462 struct drm_crtc_state *state)
3463{
3464 __drm_atomic_helper_crtc_destroy_state(state);
3465 kfree(state);
3466}
3467EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
3468
3469/**
3470 * drm_atomic_helper_plane_reset - default &drm_plane_funcs.reset hook for planes
3471 * @plane: drm plane
3472 *
3473 * Resets the atomic state for @plane by freeing the state pointer (which might
3474 * be NULL, e.g. at driver load time) and allocating a new empty state object.
3475 */
3476void drm_atomic_helper_plane_reset(struct drm_plane *plane)
3477{
3478 if (plane->state)
3479 __drm_atomic_helper_plane_destroy_state(plane->state);
3480
3481 kfree(plane->state);
3482 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
3483
3484 if (plane->state) {
3485 plane->state->plane = plane;
3486 plane->state->rotation = DRM_MODE_ROTATE_0;
3487 }
3488}
3489EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
3490
3491/**
3492 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
3493 * @plane: plane object
3494 * @state: atomic plane state
3495 *
3496 * Copies atomic state from a plane's current state. This is useful for
3497 * drivers that subclass the plane state.
3498 */
3499void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
3500 struct drm_plane_state *state)
3501{
3502 memcpy(state, plane->state, sizeof(*state));
3503
3504 if (state->fb)
3505 drm_framebuffer_get(state->fb);
3506
3507 state->fence = NULL;
3508 state->commit = NULL;
3509}
3510EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
3511
3512/**
3513 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
3514 * @plane: drm plane
3515 *
3516 * Default plane state duplicate hook for drivers which don't have their own
3517 * subclassed plane state structure.
3518 */
3519struct drm_plane_state *
3520drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
3521{
3522 struct drm_plane_state *state;
3523
3524 if (WARN_ON(!plane->state))
3525 return NULL;
3526
3527 state = kmalloc(sizeof(*state), GFP_KERNEL);
3528 if (state)
3529 __drm_atomic_helper_plane_duplicate_state(plane, state);
3530
3531 return state;
3532}
3533EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
3534
3535/**
3536 * __drm_atomic_helper_plane_destroy_state - release plane state
3537 * @state: plane state object to release
3538 *
3539 * Releases all resources stored in the plane state without actually freeing
3540 * the memory of the plane state. This is useful for drivers that subclass the
3541 * plane state.
3542 */
3543void __drm_atomic_helper_plane_destroy_state(struct drm_plane_state *state)
3544{
3545 if (state->fb)
3546 drm_framebuffer_put(state->fb);
3547
3548 if (state->fence)
3549 dma_fence_put(state->fence);
3550
3551 if (state->commit)
3552 drm_crtc_commit_put(state->commit);
3553}
3554EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
3555
3556/**
3557 * drm_atomic_helper_plane_destroy_state - default state destroy hook
3558 * @plane: drm plane
3559 * @state: plane state object to release
3560 *
3561 * Default plane state destroy hook for drivers which don't have their own
3562 * subclassed plane state structure.
3563 */
3564void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
3565 struct drm_plane_state *state)
3566{
3567 __drm_atomic_helper_plane_destroy_state(state);
3568 kfree(state);
3569}
3570EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
3571
3572/**
3573 * __drm_atomic_helper_connector_reset - reset state on connector
3574 * @connector: drm connector
3575 * @conn_state: connector state to assign
3576 *
3577 * Initializes the newly allocated @conn_state and assigns it to
3578 * the &drm_conector->state pointer of @connector, usually required when
3579 * initializing the drivers or when called from the &drm_connector_funcs.reset
3580 * hook.
3581 *
3582 * This is useful for drivers that subclass the connector state.
3583 */
3584void
3585__drm_atomic_helper_connector_reset(struct drm_connector *connector,
3586 struct drm_connector_state *conn_state)
3587{
3588 if (conn_state)
3589 conn_state->connector = connector;
3590
3591 connector->state = conn_state;
3592}
3593EXPORT_SYMBOL(__drm_atomic_helper_connector_reset);
3594
3595/**
3596 * drm_atomic_helper_connector_reset - default &drm_connector_funcs.reset hook for connectors
3597 * @connector: drm connector
3598 *
3599 * Resets the atomic state for @connector by freeing the state pointer (which
3600 * might be NULL, e.g. at driver load time) and allocating a new empty state
3601 * object.
3602 */
3603void drm_atomic_helper_connector_reset(struct drm_connector *connector)
3604{
3605 struct drm_connector_state *conn_state =
3606 kzalloc(sizeof(*conn_state), GFP_KERNEL);
3607
3608 if (connector->state)
3609 __drm_atomic_helper_connector_destroy_state(connector->state);
3610
3611 kfree(connector->state);
3612 __drm_atomic_helper_connector_reset(connector, conn_state);
3613}
3614EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
3615
3616/**
3617 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
3618 * @connector: connector object
3619 * @state: atomic connector state
3620 *
3621 * Copies atomic state from a connector's current state. This is useful for
3622 * drivers that subclass the connector state.
3623 */
3624void
3625__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
3626 struct drm_connector_state *state)
3627{
3628 memcpy(state, connector->state, sizeof(*state));
3629 if (state->crtc)
3630 drm_connector_get(connector);
3631 state->commit = NULL;
3632}
3633EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
3634
3635/**
3636 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
3637 * @connector: drm connector
3638 *
3639 * Default connector state duplicate hook for drivers which don't have their own
3640 * subclassed connector state structure.
3641 */
3642struct drm_connector_state *
3643drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
3644{
3645 struct drm_connector_state *state;
3646
3647 if (WARN_ON(!connector->state))
3648 return NULL;
3649
3650 state = kmalloc(sizeof(*state), GFP_KERNEL);
3651 if (state)
3652 __drm_atomic_helper_connector_duplicate_state(connector, state);
3653
3654 return state;
3655}
3656EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
3657
3658/**
3659 * drm_atomic_helper_duplicate_state - duplicate an atomic state object
3660 * @dev: DRM device
3661 * @ctx: lock acquisition context
3662 *
3663 * Makes a copy of the current atomic state by looping over all objects and
3664 * duplicating their respective states. This is used for example by suspend/
3665 * resume support code to save the state prior to suspend such that it can
3666 * be restored upon resume.
3667 *
3668 * Note that this treats atomic state as persistent between save and restore.
3669 * Drivers must make sure that this is possible and won't result in confusion
3670 * or erroneous behaviour.
3671 *
3672 * Note that if callers haven't already acquired all modeset locks this might
3673 * return -EDEADLK, which must be handled by calling drm_modeset_backoff().
3674 *
3675 * Returns:
3676 * A pointer to the copy of the atomic state object on success or an
3677 * ERR_PTR()-encoded error code on failure.
3678 *
3679 * See also:
3680 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
3681 */
3682struct drm_atomic_state *
3683drm_atomic_helper_duplicate_state(struct drm_device *dev,
3684 struct drm_modeset_acquire_ctx *ctx)
3685{
3686 struct drm_atomic_state *state;
3687 struct drm_connector *conn;
3688 struct drm_connector_list_iter conn_iter;
3689 struct drm_plane *plane;
3690 struct drm_crtc *crtc;
3691 int err = 0;
3692
3693 state = drm_atomic_state_alloc(dev);
3694 if (!state)
3695 return ERR_PTR(-ENOMEM);
3696
3697 state->acquire_ctx = ctx;
3698
3699 drm_for_each_crtc(crtc, dev) {
3700 struct drm_crtc_state *crtc_state;
3701
3702 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3703 if (IS_ERR(crtc_state)) {
3704 err = PTR_ERR(crtc_state);
3705 goto free;
3706 }
3707 }
3708
3709 drm_for_each_plane(plane, dev) {
3710 struct drm_plane_state *plane_state;
3711
3712 plane_state = drm_atomic_get_plane_state(state, plane);
3713 if (IS_ERR(plane_state)) {
3714 err = PTR_ERR(plane_state);
3715 goto free;
3716 }
3717 }
3718
3719 drm_connector_list_iter_begin(dev, &conn_iter);
3720 drm_for_each_connector_iter(conn, &conn_iter) {
3721 struct drm_connector_state *conn_state;
3722
3723 conn_state = drm_atomic_get_connector_state(state, conn);
3724 if (IS_ERR(conn_state)) {
3725 err = PTR_ERR(conn_state);
3726 drm_connector_list_iter_end(&conn_iter);
3727 goto free;
3728 }
3729 }
3730 drm_connector_list_iter_end(&conn_iter);
3731
3732 /* clear the acquire context so that it isn't accidentally reused */
3733 state->acquire_ctx = NULL;
3734
3735free:
3736 if (err < 0) {
3737 drm_atomic_state_put(state);
3738 state = ERR_PTR(err);
3739 }
3740
3741 return state;
3742}
3743EXPORT_SYMBOL(drm_atomic_helper_duplicate_state);
3744
3745/**
3746 * __drm_atomic_helper_connector_destroy_state - release connector state
3747 * @state: connector state object to release
3748 *
3749 * Releases all resources stored in the connector state without actually
3750 * freeing the memory of the connector state. This is useful for drivers that
3751 * subclass the connector state.
3752 */
3753void
3754__drm_atomic_helper_connector_destroy_state(struct drm_connector_state *state)
3755{
3756 if (state->crtc)
3757 drm_connector_put(state->connector);
3758
3759 if (state->commit)
3760 drm_crtc_commit_put(state->commit);
3761}
3762EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
3763
3764/**
3765 * drm_atomic_helper_connector_destroy_state - default state destroy hook
3766 * @connector: drm connector
3767 * @state: connector state object to release
3768 *
3769 * Default connector state destroy hook for drivers which don't have their own
3770 * subclassed connector state structure.
3771 */
3772void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
3773 struct drm_connector_state *state)
3774{
3775 __drm_atomic_helper_connector_destroy_state(state);
3776 kfree(state);
3777}
3778EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);
3779
3780/**
3781 * drm_atomic_helper_legacy_gamma_set - set the legacy gamma correction table
3782 * @crtc: CRTC object
3783 * @red: red correction table
3784 * @green: green correction table
3785 * @blue: green correction table
3786 * @size: size of the tables
3787 * @ctx: lock acquire context
3788 *
3789 * Implements support for legacy gamma correction table for drivers
3790 * that support color management through the DEGAMMA_LUT/GAMMA_LUT
3791 * properties. See drm_crtc_enable_color_mgmt() and the containing chapter for
3792 * how the atomic color management and gamma tables work.
3793 */
3794int drm_atomic_helper_legacy_gamma_set(struct drm_crtc *crtc,
3795 u16 *red, u16 *green, u16 *blue,
3796 uint32_t size,
3797 struct drm_modeset_acquire_ctx *ctx)
3798{
3799 struct drm_device *dev = crtc->dev;
3800 struct drm_atomic_state *state;
3801 struct drm_crtc_state *crtc_state;
3802 struct drm_property_blob *blob = NULL;
3803 struct drm_color_lut *blob_data;
3804 int i, ret = 0;
3805 bool replaced;
3806
3807 state = drm_atomic_state_alloc(crtc->dev);
3808 if (!state)
3809 return -ENOMEM;
3810
3811 blob = drm_property_create_blob(dev,
3812 sizeof(struct drm_color_lut) * size,
3813 NULL);
3814 if (IS_ERR(blob)) {
3815 ret = PTR_ERR(blob);
3816 blob = NULL;
3817 goto fail;
3818 }
3819
3820 /* Prepare GAMMA_LUT with the legacy values. */
3821 blob_data = blob->data;
3822 for (i = 0; i < size; i++) {
3823 blob_data[i].red = red[i];
3824 blob_data[i].green = green[i];
3825 blob_data[i].blue = blue[i];
3826 }
3827
3828 state->acquire_ctx = ctx;
3829 crtc_state = drm_atomic_get_crtc_state(state, crtc);
3830 if (IS_ERR(crtc_state)) {
3831 ret = PTR_ERR(crtc_state);
3832 goto fail;
3833 }
3834
3835 /* Reset DEGAMMA_LUT and CTM properties. */
3836 replaced = drm_property_replace_blob(&crtc_state->degamma_lut, NULL);
3837 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
3838 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut, blob);
3839 crtc_state->color_mgmt_changed |= replaced;
3840
3841 ret = drm_atomic_commit(state);
3842
3843fail:
3844 drm_atomic_state_put(state);
3845 drm_property_blob_put(blob);
3846 return ret;
3847}
3848EXPORT_SYMBOL(drm_atomic_helper_legacy_gamma_set);
3849
3850/**
3851 * __drm_atomic_helper_private_duplicate_state - copy atomic private state
3852 * @obj: CRTC object
3853 * @state: new private object state
3854 *
3855 * Copies atomic state from a private objects's current state and resets inferred values.
3856 * This is useful for drivers that subclass the private state.
3857 */
3858void __drm_atomic_helper_private_obj_duplicate_state(struct drm_private_obj *obj,
3859 struct drm_private_state *state)
3860{
3861 memcpy(state, obj->state, sizeof(*state));
3862}
3863EXPORT_SYMBOL(__drm_atomic_helper_private_obj_duplicate_state);