drm/atomic-helper: Pimp docs with recommendations for rpm drivers
[linux-2.6-block.git] / drivers / gpu / drm / drm_atomic_helper.c
CommitLineData
c2fcd274
DV
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>
623369e5 32#include <drm/drm_atomic_helper.h>
e2330f07 33#include <linux/fence.h>
c2fcd274 34
3150c7d0
DV
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
26196f7e
DV
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
3150c7d0
DV
48 * together with a driver private modeset implementation.
49 *
50 * This library also provides implementations for all the legacy driver
26196f7e
DV
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
3150c7d0
DV
53 * various functions to implement set_property callbacks. New drivers must not
54 * implement these functions themselves but must use the provided helpers.
55 */
c2fcd274
DV
56static void
57drm_atomic_helper_plane_changed(struct drm_atomic_state *state,
58 struct drm_plane_state *plane_state,
59 struct drm_plane *plane)
60{
61 struct drm_crtc_state *crtc_state;
62
63 if (plane->state->crtc) {
4b08eae5 64 crtc_state = state->crtc_states[drm_crtc_index(plane->state->crtc)];
c2fcd274
DV
65
66 if (WARN_ON(!crtc_state))
67 return;
68
69 crtc_state->planes_changed = true;
70 }
71
72 if (plane_state->crtc) {
73 crtc_state =
74 state->crtc_states[drm_crtc_index(plane_state->crtc)];
75
76 if (WARN_ON(!crtc_state))
77 return;
78
79 crtc_state->planes_changed = true;
80 }
81}
82
623369e5
DV
83static struct drm_crtc *
84get_current_crtc_for_encoder(struct drm_device *dev,
85 struct drm_encoder *encoder)
86{
87 struct drm_mode_config *config = &dev->mode_config;
88 struct drm_connector *connector;
89
90 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
91
9a9f5ce8 92 drm_for_each_connector(connector, dev) {
623369e5
DV
93 if (connector->state->best_encoder != encoder)
94 continue;
95
96 return connector->state->crtc;
97 }
98
99 return NULL;
100}
101
102static int
103steal_encoder(struct drm_atomic_state *state,
104 struct drm_encoder *encoder,
105 struct drm_crtc *encoder_crtc)
106{
107 struct drm_mode_config *config = &state->dev->mode_config;
108 struct drm_crtc_state *crtc_state;
109 struct drm_connector *connector;
110 struct drm_connector_state *connector_state;
042652ed 111 int ret;
623369e5
DV
112
113 /*
114 * We can only steal an encoder coming from a connector, which means we
115 * must already hold the connection_mutex.
116 */
117 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
118
17a38d9c
DV
119 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] in use on [CRTC:%d], stealing it\n",
120 encoder->base.id, encoder->name,
121 encoder_crtc->base.id);
623369e5
DV
122
123 crtc_state = drm_atomic_get_crtc_state(state, encoder_crtc);
124 if (IS_ERR(crtc_state))
125 return PTR_ERR(crtc_state);
126
fc596660 127 crtc_state->connectors_changed = true;
623369e5
DV
128
129 list_for_each_entry(connector, &config->connector_list, head) {
130 if (connector->state->best_encoder != encoder)
131 continue;
132
17a38d9c
DV
133 DRM_DEBUG_ATOMIC("Stealing encoder from [CONNECTOR:%d:%s]\n",
134 connector->base.id,
135 connector->name);
623369e5
DV
136
137 connector_state = drm_atomic_get_connector_state(state,
138 connector);
139 if (IS_ERR(connector_state))
140 return PTR_ERR(connector_state);
141
042652ed
DV
142 ret = drm_atomic_set_crtc_for_connector(connector_state, NULL);
143 if (ret)
144 return ret;
623369e5
DV
145 connector_state->best_encoder = NULL;
146 }
147
148 return 0;
149}
150
151static int
152update_connector_routing(struct drm_atomic_state *state, int conn_idx)
153{
b5ceff20 154 const struct drm_connector_helper_funcs *funcs;
623369e5
DV
155 struct drm_encoder *new_encoder;
156 struct drm_crtc *encoder_crtc;
157 struct drm_connector *connector;
158 struct drm_connector_state *connector_state;
159 struct drm_crtc_state *crtc_state;
160 int idx, ret;
161
162 connector = state->connectors[conn_idx];
163 connector_state = state->connector_states[conn_idx];
164
165 if (!connector)
166 return 0;
167
17a38d9c
DV
168 DRM_DEBUG_ATOMIC("Updating routing for [CONNECTOR:%d:%s]\n",
169 connector->base.id,
170 connector->name);
623369e5
DV
171
172 if (connector->state->crtc != connector_state->crtc) {
173 if (connector->state->crtc) {
174 idx = drm_crtc_index(connector->state->crtc);
175
176 crtc_state = state->crtc_states[idx];
fc596660 177 crtc_state->connectors_changed = true;
623369e5
DV
178 }
179
180 if (connector_state->crtc) {
181 idx = drm_crtc_index(connector_state->crtc);
182
183 crtc_state = state->crtc_states[idx];
fc596660 184 crtc_state->connectors_changed = true;
623369e5
DV
185 }
186 }
187
188 if (!connector_state->crtc) {
17a38d9c 189 DRM_DEBUG_ATOMIC("Disabling [CONNECTOR:%d:%s]\n",
623369e5
DV
190 connector->base.id,
191 connector->name);
192
193 connector_state->best_encoder = NULL;
194
195 return 0;
196 }
197
198 funcs = connector->helper_private;
3b8a684b
DV
199
200 if (funcs->atomic_best_encoder)
201 new_encoder = funcs->atomic_best_encoder(connector,
202 connector_state);
203 else
204 new_encoder = funcs->best_encoder(connector);
623369e5
DV
205
206 if (!new_encoder) {
17a38d9c
DV
207 DRM_DEBUG_ATOMIC("No suitable encoder found for [CONNECTOR:%d:%s]\n",
208 connector->base.id,
209 connector->name);
623369e5
DV
210 return -EINVAL;
211 }
212
213 if (new_encoder == connector_state->best_encoder) {
17a38d9c
DV
214 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] keeps [ENCODER:%d:%s], now on [CRTC:%d]\n",
215 connector->base.id,
216 connector->name,
217 new_encoder->base.id,
218 new_encoder->name,
219 connector_state->crtc->base.id);
623369e5
DV
220
221 return 0;
222 }
223
224 encoder_crtc = get_current_crtc_for_encoder(state->dev,
225 new_encoder);
226
227 if (encoder_crtc) {
228 ret = steal_encoder(state, new_encoder, encoder_crtc);
229 if (ret) {
17a38d9c
DV
230 DRM_DEBUG_ATOMIC("Encoder stealing failed for [CONNECTOR:%d:%s]\n",
231 connector->base.id,
232 connector->name);
623369e5
DV
233 return ret;
234 }
235 }
236
6ea76f3c
DV
237 if (WARN_ON(!connector_state->crtc))
238 return -EINVAL;
239
623369e5
DV
240 connector_state->best_encoder = new_encoder;
241 idx = drm_crtc_index(connector_state->crtc);
242
243 crtc_state = state->crtc_states[idx];
fc596660 244 crtc_state->connectors_changed = true;
623369e5 245
17a38d9c
DV
246 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] using [ENCODER:%d:%s] on [CRTC:%d]\n",
247 connector->base.id,
248 connector->name,
249 new_encoder->base.id,
250 new_encoder->name,
251 connector_state->crtc->base.id);
623369e5
DV
252
253 return 0;
254}
255
256static int
257mode_fixup(struct drm_atomic_state *state)
258{
df63b999 259 struct drm_crtc *crtc;
623369e5 260 struct drm_crtc_state *crtc_state;
df63b999 261 struct drm_connector *connector;
623369e5
DV
262 struct drm_connector_state *conn_state;
263 int i;
264 bool ret;
265
df63b999 266 for_each_crtc_in_state(state, crtc, crtc_state, i) {
fc596660
ML
267 if (!crtc_state->mode_changed &&
268 !crtc_state->connectors_changed)
623369e5
DV
269 continue;
270
271 drm_mode_copy(&crtc_state->adjusted_mode, &crtc_state->mode);
272 }
273
df63b999 274 for_each_connector_in_state(state, connector, conn_state, i) {
b5ceff20 275 const struct drm_encoder_helper_funcs *funcs;
623369e5
DV
276 struct drm_encoder *encoder;
277
623369e5
DV
278 WARN_ON(!!conn_state->best_encoder != !!conn_state->crtc);
279
280 if (!conn_state->crtc || !conn_state->best_encoder)
281 continue;
282
283 crtc_state =
284 state->crtc_states[drm_crtc_index(conn_state->crtc)];
285
286 /*
287 * Each encoder has at most one connector (since we always steal
288 * it away), so we won't call ->mode_fixup twice.
289 */
290 encoder = conn_state->best_encoder;
291 funcs = encoder->helper_private;
840bfe95
ACO
292 if (!funcs)
293 continue;
623369e5 294
862e686c
AT
295 ret = drm_bridge_mode_fixup(encoder->bridge, &crtc_state->mode,
296 &crtc_state->adjusted_mode);
297 if (!ret) {
298 DRM_DEBUG_ATOMIC("Bridge fixup failed\n");
299 return -EINVAL;
623369e5
DV
300 }
301
4cd4df80
TR
302 if (funcs->atomic_check) {
303 ret = funcs->atomic_check(encoder, crtc_state,
304 conn_state);
305 if (ret) {
17a38d9c
DV
306 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] check failed\n",
307 encoder->base.id, encoder->name);
4cd4df80
TR
308 return ret;
309 }
84524917 310 } else if (funcs->mode_fixup) {
4cd4df80
TR
311 ret = funcs->mode_fixup(encoder, &crtc_state->mode,
312 &crtc_state->adjusted_mode);
313 if (!ret) {
17a38d9c
DV
314 DRM_DEBUG_ATOMIC("[ENCODER:%d:%s] fixup failed\n",
315 encoder->base.id, encoder->name);
4cd4df80
TR
316 return -EINVAL;
317 }
623369e5
DV
318 }
319 }
320
df63b999 321 for_each_crtc_in_state(state, crtc, crtc_state, i) {
b5ceff20 322 const struct drm_crtc_helper_funcs *funcs;
623369e5 323
fc596660
ML
324 if (!crtc_state->mode_changed &&
325 !crtc_state->connectors_changed)
623369e5
DV
326 continue;
327
328 funcs = crtc->helper_private;
840bfe95
ACO
329 if (!funcs->mode_fixup)
330 continue;
331
623369e5
DV
332 ret = funcs->mode_fixup(crtc, &crtc_state->mode,
333 &crtc_state->adjusted_mode);
334 if (!ret) {
17a38d9c
DV
335 DRM_DEBUG_ATOMIC("[CRTC:%d] fixup failed\n",
336 crtc->base.id);
623369e5
DV
337 return -EINVAL;
338 }
339 }
340
341 return 0;
342}
343
d9b13620 344/**
f98bd3ef 345 * drm_atomic_helper_check_modeset - validate state object for modeset changes
d9b13620
DV
346 * @dev: DRM device
347 * @state: the driver state object
348 *
349 * Check the state object to see if the requested state is physically possible.
350 * This does all the crtc and connector related computations for an atomic
fc596660
ML
351 * update and adds any additional connectors needed for full modesets and calls
352 * down into ->mode_fixup functions of the driver backend.
353 *
354 * crtc_state->mode_changed is set when the input mode is changed.
355 * crtc_state->connectors_changed is set when a connector is added or
356 * removed from the crtc.
357 * crtc_state->active_changed is set when crtc_state->active changes,
358 * which is used for dpms.
d9b13620
DV
359 *
360 * IMPORTANT:
361 *
362 * Drivers which update ->mode_changed (e.g. in their ->atomic_check hooks if a
363 * plane update can't be done without a full modeset) _must_ call this function
364 * afterwards after that change. It is permitted to call this function multiple
365 * times for the same update, e.g. when the ->atomic_check functions depend upon
366 * the adjusted dotclock for fifo space allocation and watermark computation.
367 *
368 * RETURNS
369 * Zero for success or -errno
370 */
371int
934ce1c2 372drm_atomic_helper_check_modeset(struct drm_device *dev,
623369e5
DV
373 struct drm_atomic_state *state)
374{
623369e5
DV
375 struct drm_crtc *crtc;
376 struct drm_crtc_state *crtc_state;
df63b999
ACO
377 struct drm_connector *connector;
378 struct drm_connector_state *connector_state;
623369e5
DV
379 int i, ret;
380
df63b999 381 for_each_crtc_in_state(state, crtc, crtc_state, i) {
623369e5 382 if (!drm_mode_equal(&crtc->state->mode, &crtc_state->mode)) {
17a38d9c
DV
383 DRM_DEBUG_ATOMIC("[CRTC:%d] mode changed\n",
384 crtc->base.id);
623369e5
DV
385 crtc_state->mode_changed = true;
386 }
387
388 if (crtc->state->enable != crtc_state->enable) {
17a38d9c
DV
389 DRM_DEBUG_ATOMIC("[CRTC:%d] enable changed\n",
390 crtc->base.id);
fc596660
ML
391
392 /*
393 * For clarity this assignment is done here, but
394 * enable == 0 is only true when there are no
395 * connectors and a NULL mode.
396 *
397 * The other way around is true as well. enable != 0
398 * iff connectors are attached and a mode is set.
399 */
623369e5 400 crtc_state->mode_changed = true;
fc596660 401 crtc_state->connectors_changed = true;
623369e5
DV
402 }
403 }
404
df63b999 405 for_each_connector_in_state(state, connector, connector_state, i) {
623369e5
DV
406 /*
407 * This only sets crtc->mode_changed for routing changes,
408 * drivers must set crtc->mode_changed themselves when connector
409 * properties need to be updated.
410 */
411 ret = update_connector_routing(state, i);
412 if (ret)
413 return ret;
414 }
415
416 /*
417 * After all the routing has been prepared we need to add in any
418 * connector which is itself unchanged, but who's crtc changes it's
419 * configuration. This must be done before calling mode_fixup in case a
420 * crtc only changed its mode but has the same set of connectors.
421 */
df63b999 422 for_each_crtc_in_state(state, crtc, crtc_state, i) {
623369e5
DV
423 int num_connectors;
424
eab3bbef
DV
425 /*
426 * We must set ->active_changed after walking connectors for
427 * otherwise an update that only changes active would result in
428 * a full modeset because update_connector_routing force that.
429 */
430 if (crtc->state->active != crtc_state->active) {
17a38d9c
DV
431 DRM_DEBUG_ATOMIC("[CRTC:%d] active changed\n",
432 crtc->base.id);
eab3bbef
DV
433 crtc_state->active_changed = true;
434 }
435
2465ff62 436 if (!drm_atomic_crtc_needs_modeset(crtc_state))
623369e5
DV
437 continue;
438
17a38d9c
DV
439 DRM_DEBUG_ATOMIC("[CRTC:%d] needs all connectors, enable: %c, active: %c\n",
440 crtc->base.id,
441 crtc_state->enable ? 'y' : 'n',
eab3bbef 442 crtc_state->active ? 'y' : 'n');
623369e5
DV
443
444 ret = drm_atomic_add_affected_connectors(state, crtc);
445 if (ret != 0)
446 return ret;
447
57744aa7
ML
448 ret = drm_atomic_add_affected_planes(state, crtc);
449 if (ret != 0)
450 return ret;
451
623369e5
DV
452 num_connectors = drm_atomic_connectors_for_crtc(state,
453 crtc);
454
455 if (crtc_state->enable != !!num_connectors) {
17a38d9c
DV
456 DRM_DEBUG_ATOMIC("[CRTC:%d] enabled/connectors mismatch\n",
457 crtc->base.id);
623369e5
DV
458
459 return -EINVAL;
460 }
461 }
462
463 return mode_fixup(state);
464}
d9b13620 465EXPORT_SYMBOL(drm_atomic_helper_check_modeset);
623369e5 466
c2fcd274 467/**
f98bd3ef 468 * drm_atomic_helper_check_planes - validate state object for planes changes
c2fcd274
DV
469 * @dev: DRM device
470 * @state: the driver state object
471 *
472 * Check the state object to see if the requested state is physically possible.
d9b13620
DV
473 * This does all the plane update related checks using by calling into the
474 * ->atomic_check hooks provided by the driver.
c2fcd274 475 *
fc596660
ML
476 * It also sets crtc_state->planes_changed to indicate that a crtc has
477 * updated planes.
478 *
c2fcd274
DV
479 * RETURNS
480 * Zero for success or -errno
481 */
d9b13620
DV
482int
483drm_atomic_helper_check_planes(struct drm_device *dev,
484 struct drm_atomic_state *state)
c2fcd274 485{
df63b999
ACO
486 struct drm_crtc *crtc;
487 struct drm_crtc_state *crtc_state;
488 struct drm_plane *plane;
489 struct drm_plane_state *plane_state;
c2fcd274
DV
490 int i, ret = 0;
491
df63b999 492 for_each_plane_in_state(state, plane, plane_state, i) {
b5ceff20 493 const struct drm_plane_helper_funcs *funcs;
c2fcd274
DV
494
495 funcs = plane->helper_private;
496
497 drm_atomic_helper_plane_changed(state, plane_state, plane);
498
499 if (!funcs || !funcs->atomic_check)
500 continue;
501
502 ret = funcs->atomic_check(plane, plane_state);
503 if (ret) {
17a38d9c
DV
504 DRM_DEBUG_ATOMIC("[PLANE:%d] atomic driver check failed\n",
505 plane->base.id);
c2fcd274
DV
506 return ret;
507 }
508 }
509
df63b999 510 for_each_crtc_in_state(state, crtc, crtc_state, i) {
b5ceff20 511 const struct drm_crtc_helper_funcs *funcs;
c2fcd274
DV
512
513 funcs = crtc->helper_private;
514
515 if (!funcs || !funcs->atomic_check)
516 continue;
517
518 ret = funcs->atomic_check(crtc, state->crtc_states[i]);
519 if (ret) {
17a38d9c
DV
520 DRM_DEBUG_ATOMIC("[CRTC:%d] atomic driver check failed\n",
521 crtc->base.id);
c2fcd274
DV
522 return ret;
523 }
524 }
525
d9b13620
DV
526 return ret;
527}
528EXPORT_SYMBOL(drm_atomic_helper_check_planes);
529
530/**
531 * drm_atomic_helper_check - validate state object
532 * @dev: DRM device
533 * @state: the driver state object
534 *
535 * Check the state object to see if the requested state is physically possible.
536 * Only crtcs and planes have check callbacks, so for any additional (global)
537 * checking that a driver needs it can simply wrap that around this function.
538 * Drivers without such needs can directly use this as their ->atomic_check()
539 * callback.
540 *
b4274fbe
DV
541 * This just wraps the two parts of the state checking for planes and modeset
542 * state in the default order: First it calls drm_atomic_helper_check_modeset()
543 * and then drm_atomic_helper_check_planes(). The assumption is that the
544 * ->atomic_check functions depend upon an updated adjusted_mode.clock to
545 * e.g. properly compute watermarks.
546 *
d9b13620
DV
547 * RETURNS
548 * Zero for success or -errno
549 */
550int drm_atomic_helper_check(struct drm_device *dev,
551 struct drm_atomic_state *state)
552{
553 int ret;
554
b4274fbe 555 ret = drm_atomic_helper_check_modeset(dev, state);
d9b13620
DV
556 if (ret)
557 return ret;
558
b4274fbe 559 ret = drm_atomic_helper_check_planes(dev, state);
934ce1c2
RC
560 if (ret)
561 return ret;
562
c2fcd274
DV
563 return ret;
564}
565EXPORT_SYMBOL(drm_atomic_helper_check);
566
623369e5
DV
567static void
568disable_outputs(struct drm_device *dev, struct drm_atomic_state *old_state)
569{
df63b999
ACO
570 struct drm_connector *connector;
571 struct drm_connector_state *old_conn_state;
572 struct drm_crtc *crtc;
573 struct drm_crtc_state *old_crtc_state;
623369e5
DV
574 int i;
575
df63b999 576 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
b5ceff20 577 const struct drm_encoder_helper_funcs *funcs;
623369e5 578 struct drm_encoder *encoder;
eab3bbef 579 struct drm_crtc_state *old_crtc_state;
623369e5 580
623369e5
DV
581 /* Shut down everything that's in the changeset and currently
582 * still on. So need to check the old, saved state. */
df63b999 583 if (!old_conn_state->crtc)
623369e5
DV
584 continue;
585
eab3bbef
DV
586 old_crtc_state = old_state->crtc_states[drm_crtc_index(old_conn_state->crtc)];
587
4218a32f 588 if (!old_crtc_state->active ||
2465ff62 589 !drm_atomic_crtc_needs_modeset(old_conn_state->crtc->state))
eab3bbef
DV
590 continue;
591
46df9adb 592 encoder = old_conn_state->best_encoder;
623369e5 593
46df9adb
RC
594 /* We shouldn't get this far if we didn't previously have
595 * an encoder.. but WARN_ON() rather than explode.
596 */
597 if (WARN_ON(!encoder))
623369e5
DV
598 continue;
599
600 funcs = encoder->helper_private;
601
17a38d9c
DV
602 DRM_DEBUG_ATOMIC("disabling [ENCODER:%d:%s]\n",
603 encoder->base.id, encoder->name);
95d6eb3b 604
623369e5
DV
605 /*
606 * Each encoder has at most one connector (since we always steal
f98bd3ef 607 * it away), so we won't call disable hooks twice.
623369e5 608 */
862e686c 609 drm_bridge_disable(encoder->bridge);
623369e5
DV
610
611 /* Right function depends upon target state. */
ee0a89cf 612 if (connector->state->crtc && funcs->prepare)
623369e5
DV
613 funcs->prepare(encoder);
614 else if (funcs->disable)
615 funcs->disable(encoder);
616 else
617 funcs->dpms(encoder, DRM_MODE_DPMS_OFF);
618
862e686c 619 drm_bridge_post_disable(encoder->bridge);
623369e5
DV
620 }
621
df63b999 622 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
b5ceff20 623 const struct drm_crtc_helper_funcs *funcs;
623369e5
DV
624
625 /* Shut down everything that needs a full modeset. */
2465ff62 626 if (!drm_atomic_crtc_needs_modeset(crtc->state))
eab3bbef
DV
627 continue;
628
629 if (!old_crtc_state->active)
623369e5
DV
630 continue;
631
632 funcs = crtc->helper_private;
633
17a38d9c
DV
634 DRM_DEBUG_ATOMIC("disabling [CRTC:%d]\n",
635 crtc->base.id);
95d6eb3b
DV
636
637
623369e5 638 /* Right function depends upon target state. */
ee0a89cf 639 if (crtc->state->enable && funcs->prepare)
623369e5
DV
640 funcs->prepare(crtc);
641 else if (funcs->disable)
642 funcs->disable(crtc);
643 else
644 funcs->dpms(crtc, DRM_MODE_DPMS_OFF);
645 }
646}
647
4c18d301
DV
648/**
649 * drm_atomic_helper_update_legacy_modeset_state - update legacy modeset state
650 * @dev: DRM device
651 * @old_state: atomic state object with old state structures
652 *
653 * This function updates all the various legacy modeset state pointers in
654 * connectors, encoders and crtcs. It also updates the timestamping constants
655 * used for precise vblank timestamps by calling
656 * drm_calc_timestamping_constants().
657 *
658 * Drivers can use this for building their own atomic commit if they don't have
659 * a pure helper-based modeset implementation.
660 */
661void
662drm_atomic_helper_update_legacy_modeset_state(struct drm_device *dev,
663 struct drm_atomic_state *old_state)
623369e5 664{
df63b999
ACO
665 struct drm_connector *connector;
666 struct drm_connector_state *old_conn_state;
667 struct drm_crtc *crtc;
668 struct drm_crtc_state *old_crtc_state;
623369e5
DV
669 int i;
670
8c10342c 671 /* clear out existing links and update dpms */
df63b999 672 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
8c10342c
ML
673 if (connector->encoder) {
674 WARN_ON(!connector->encoder->crtc);
675
676 connector->encoder->crtc = NULL;
677 connector->encoder = NULL;
678 }
623369e5 679
8c10342c
ML
680 crtc = connector->state->crtc;
681 if ((!crtc && old_conn_state->crtc) ||
682 (crtc && drm_atomic_crtc_needs_modeset(crtc->state))) {
683 struct drm_property *dpms_prop =
684 dev->mode_config.dpms_property;
685 int mode = DRM_MODE_DPMS_OFF;
623369e5 686
8c10342c
ML
687 if (crtc && crtc->state->active)
688 mode = DRM_MODE_DPMS_ON;
689
690 connector->dpms = mode;
691 drm_object_property_set_value(&connector->base,
692 dpms_prop, mode);
693 }
623369e5
DV
694 }
695
696 /* set new links */
df63b999
ACO
697 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
698 if (!connector->state->crtc)
623369e5
DV
699 continue;
700
701 if (WARN_ON(!connector->state->best_encoder))
702 continue;
703
704 connector->encoder = connector->state->best_encoder;
705 connector->encoder->crtc = connector->state->crtc;
706 }
707
708 /* set legacy state in the crtc structure */
df63b999 709 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
2660801f
ML
710 struct drm_plane *primary = crtc->primary;
711
623369e5
DV
712 crtc->mode = crtc->state->mode;
713 crtc->enabled = crtc->state->enable;
2660801f
ML
714
715 if (drm_atomic_get_existing_plane_state(old_state, primary) &&
716 primary->state->crtc == crtc) {
717 crtc->x = primary->state->src_x >> 16;
718 crtc->y = primary->state->src_y >> 16;
719 }
3d51d2d2
DV
720
721 if (crtc->state->enable)
722 drm_calc_timestamping_constants(crtc,
723 &crtc->state->adjusted_mode);
623369e5
DV
724 }
725}
4c18d301 726EXPORT_SYMBOL(drm_atomic_helper_update_legacy_modeset_state);
623369e5
DV
727
728static void
729crtc_set_mode(struct drm_device *dev, struct drm_atomic_state *old_state)
730{
df63b999
ACO
731 struct drm_crtc *crtc;
732 struct drm_crtc_state *old_crtc_state;
733 struct drm_connector *connector;
734 struct drm_connector_state *old_conn_state;
623369e5
DV
735 int i;
736
df63b999 737 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
b5ceff20 738 const struct drm_crtc_helper_funcs *funcs;
623369e5 739
df63b999 740 if (!crtc->state->mode_changed)
623369e5
DV
741 continue;
742
743 funcs = crtc->helper_private;
744
c982bd90 745 if (crtc->state->enable && funcs->mode_set_nofb) {
17a38d9c
DV
746 DRM_DEBUG_ATOMIC("modeset on [CRTC:%d]\n",
747 crtc->base.id);
95d6eb3b 748
623369e5 749 funcs->mode_set_nofb(crtc);
95d6eb3b 750 }
623369e5
DV
751 }
752
df63b999 753 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
b5ceff20 754 const struct drm_encoder_helper_funcs *funcs;
623369e5 755 struct drm_crtc_state *new_crtc_state;
623369e5
DV
756 struct drm_encoder *encoder;
757 struct drm_display_mode *mode, *adjusted_mode;
758
df63b999 759 if (!connector->state->best_encoder)
623369e5
DV
760 continue;
761
762 encoder = connector->state->best_encoder;
763 funcs = encoder->helper_private;
764 new_crtc_state = connector->state->crtc->state;
765 mode = &new_crtc_state->mode;
766 adjusted_mode = &new_crtc_state->adjusted_mode;
767
eab3bbef
DV
768 if (!new_crtc_state->mode_changed)
769 continue;
770
17a38d9c
DV
771 DRM_DEBUG_ATOMIC("modeset on [ENCODER:%d:%s]\n",
772 encoder->base.id, encoder->name);
95d6eb3b 773
623369e5
DV
774 /*
775 * Each encoder has at most one connector (since we always steal
f98bd3ef 776 * it away), so we won't call mode_set hooks twice.
623369e5 777 */
c982bd90
DV
778 if (funcs->mode_set)
779 funcs->mode_set(encoder, mode, adjusted_mode);
623369e5 780
862e686c 781 drm_bridge_mode_set(encoder->bridge, mode, adjusted_mode);
623369e5
DV
782 }
783}
784
785/**
1af434a9 786 * drm_atomic_helper_commit_modeset_disables - modeset commit to disable outputs
623369e5 787 * @dev: DRM device
a072f809 788 * @old_state: atomic state object with old state structures
623369e5 789 *
1af434a9 790 * This function shuts down all the outputs that need to be shut down and
623369e5 791 * prepares them (if required) with the new mode.
1af434a9
DV
792 *
793 * For compatability with legacy crtc helpers this should be called before
794 * drm_atomic_helper_commit_planes(), which is what the default commit function
795 * does. But drivers with different needs can group the modeset commits together
796 * and do the plane commits at the end. This is useful for drivers doing runtime
797 * PM since planes updates then only happen when the CRTC is actually enabled.
623369e5 798 */
1af434a9
DV
799void drm_atomic_helper_commit_modeset_disables(struct drm_device *dev,
800 struct drm_atomic_state *old_state)
623369e5 801{
a072f809 802 disable_outputs(dev, old_state);
4c18d301
DV
803
804 drm_atomic_helper_update_legacy_modeset_state(dev, old_state);
805
a072f809 806 crtc_set_mode(dev, old_state);
623369e5 807}
1af434a9 808EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_disables);
623369e5
DV
809
810/**
1af434a9 811 * drm_atomic_helper_commit_modeset_enables - modeset commit to enable outputs
623369e5
DV
812 * @dev: DRM device
813 * @old_state: atomic state object with old state structures
814 *
1af434a9
DV
815 * This function enables all the outputs with the new configuration which had to
816 * be turned off for the update.
817 *
818 * For compatability with legacy crtc helpers this should be called after
819 * drm_atomic_helper_commit_planes(), which is what the default commit function
820 * does. But drivers with different needs can group the modeset commits together
821 * and do the plane commits at the end. This is useful for drivers doing runtime
822 * PM since planes updates then only happen when the CRTC is actually enabled.
623369e5 823 */
1af434a9
DV
824void drm_atomic_helper_commit_modeset_enables(struct drm_device *dev,
825 struct drm_atomic_state *old_state)
623369e5 826{
df63b999
ACO
827 struct drm_crtc *crtc;
828 struct drm_crtc_state *old_crtc_state;
829 struct drm_connector *connector;
830 struct drm_connector_state *old_conn_state;
623369e5
DV
831 int i;
832
df63b999 833 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
b5ceff20 834 const struct drm_crtc_helper_funcs *funcs;
623369e5
DV
835
836 /* Need to filter out CRTCs where only planes change. */
2465ff62 837 if (!drm_atomic_crtc_needs_modeset(crtc->state))
eab3bbef
DV
838 continue;
839
840 if (!crtc->state->active)
623369e5
DV
841 continue;
842
843 funcs = crtc->helper_private;
844
ee0a89cf 845 if (crtc->state->enable) {
17a38d9c
DV
846 DRM_DEBUG_ATOMIC("enabling [CRTC:%d]\n",
847 crtc->base.id);
95d6eb3b 848
ee0a89cf
DV
849 if (funcs->enable)
850 funcs->enable(crtc);
851 else
852 funcs->commit(crtc);
853 }
623369e5
DV
854 }
855
df63b999 856 for_each_connector_in_state(old_state, connector, old_conn_state, i) {
b5ceff20 857 const struct drm_encoder_helper_funcs *funcs;
623369e5
DV
858 struct drm_encoder *encoder;
859
df63b999 860 if (!connector->state->best_encoder)
623369e5
DV
861 continue;
862
4218a32f 863 if (!connector->state->crtc->state->active ||
2465ff62 864 !drm_atomic_crtc_needs_modeset(connector->state->crtc->state))
eab3bbef
DV
865 continue;
866
623369e5
DV
867 encoder = connector->state->best_encoder;
868 funcs = encoder->helper_private;
869
17a38d9c
DV
870 DRM_DEBUG_ATOMIC("enabling [ENCODER:%d:%s]\n",
871 encoder->base.id, encoder->name);
95d6eb3b 872
623369e5
DV
873 /*
874 * Each encoder has at most one connector (since we always steal
f98bd3ef 875 * it away), so we won't call enable hooks twice.
623369e5 876 */
862e686c 877 drm_bridge_pre_enable(encoder->bridge);
623369e5 878
ee0a89cf
DV
879 if (funcs->enable)
880 funcs->enable(encoder);
881 else
882 funcs->commit(encoder);
623369e5 883
862e686c 884 drm_bridge_enable(encoder->bridge);
623369e5
DV
885 }
886}
1af434a9 887EXPORT_SYMBOL(drm_atomic_helper_commit_modeset_enables);
623369e5 888
e2330f07
DV
889static void wait_for_fences(struct drm_device *dev,
890 struct drm_atomic_state *state)
891{
df63b999
ACO
892 struct drm_plane *plane;
893 struct drm_plane_state *plane_state;
e2330f07
DV
894 int i;
895
df63b999
ACO
896 for_each_plane_in_state(state, plane, plane_state, i) {
897 if (!plane->state->fence)
e2330f07
DV
898 continue;
899
900 WARN_ON(!plane->state->fb);
901
902 fence_wait(plane->state->fence, false);
903 fence_put(plane->state->fence);
904 plane->state->fence = NULL;
905 }
906}
907
ab58e338
DV
908static bool framebuffer_changed(struct drm_device *dev,
909 struct drm_atomic_state *old_state,
910 struct drm_crtc *crtc)
911{
912 struct drm_plane *plane;
913 struct drm_plane_state *old_plane_state;
ab58e338
DV
914 int i;
915
df63b999 916 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
ab58e338
DV
917 if (plane->state->crtc != crtc &&
918 old_plane_state->crtc != crtc)
919 continue;
920
921 if (plane->state->fb != old_plane_state->fb)
922 return true;
923 }
924
925 return false;
926}
927
5ee3229c
RC
928/**
929 * drm_atomic_helper_wait_for_vblanks - wait for vblank on crtcs
930 * @dev: DRM device
931 * @old_state: atomic state object with old state structures
932 *
933 * Helper to, after atomic commit, wait for vblanks on all effected
934 * crtcs (ie. before cleaning up old framebuffers using
ab58e338
DV
935 * drm_atomic_helper_cleanup_planes()). It will only wait on crtcs where the
936 * framebuffers have actually changed to optimize for the legacy cursor and
937 * plane update use-case.
5ee3229c
RC
938 */
939void
940drm_atomic_helper_wait_for_vblanks(struct drm_device *dev,
941 struct drm_atomic_state *old_state)
623369e5
DV
942{
943 struct drm_crtc *crtc;
944 struct drm_crtc_state *old_crtc_state;
623369e5
DV
945 int i, ret;
946
df63b999 947 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
623369e5
DV
948 /* No one cares about the old state, so abuse it for tracking
949 * and store whether we hold a vblank reference (and should do a
950 * vblank wait) in the ->enable boolean. */
951 old_crtc_state->enable = false;
952
953 if (!crtc->state->enable)
954 continue;
955
f02ad907
DV
956 /* Legacy cursor ioctls are completely unsynced, and userspace
957 * relies on that (by doing tons of cursor updates). */
958 if (old_state->legacy_cursor_update)
959 continue;
960
ab58e338
DV
961 if (!framebuffer_changed(dev, old_state, crtc))
962 continue;
963
623369e5
DV
964 ret = drm_crtc_vblank_get(crtc);
965 if (ret != 0)
966 continue;
967
968 old_crtc_state->enable = true;
d4853630 969 old_crtc_state->last_vblank_count = drm_crtc_vblank_count(crtc);
623369e5
DV
970 }
971
df63b999
ACO
972 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
973 if (!old_crtc_state->enable)
623369e5
DV
974 continue;
975
976 ret = wait_event_timeout(dev->vblank[i].queue,
977 old_crtc_state->last_vblank_count !=
d4853630 978 drm_crtc_vblank_count(crtc),
623369e5
DV
979 msecs_to_jiffies(50));
980
981 drm_crtc_vblank_put(crtc);
982 }
983}
5ee3229c 984EXPORT_SYMBOL(drm_atomic_helper_wait_for_vblanks);
623369e5
DV
985
986/**
987 * drm_atomic_helper_commit - commit validated state object
988 * @dev: DRM device
989 * @state: the driver state object
990 * @async: asynchronous commit
991 *
992 * This function commits a with drm_atomic_helper_check() pre-validated state
993 * object. This can still fail when e.g. the framebuffer reservation fails. For
994 * now this doesn't implement asynchronous commits.
995 *
6e48ae32
DV
996 * Note that right now this function does not support async commits, and hence
997 * driver writers must implement their own version for now. Also note that the
998 * default ordering of how the various stages are called is to match the legacy
999 * modeset helper library closest. One peculiarity of that is that it doesn't
1000 * mesh well with runtime PM at all.
1001 *
1002 * For drivers supporting runtime PM the recommended sequence is
1003 *
1004 * drm_atomic_helper_commit_modeset_disables(dev, state);
1005 *
1006 * drm_atomic_helper_commit_modeset_enables(dev, state);
1007 *
1008 * drm_atomic_helper_commit_planes(dev, state, true);
1009 *
1010 * See the kerneldoc entries for these three functions for more details.
1011 *
623369e5
DV
1012 * RETURNS
1013 * Zero for success or -errno.
1014 */
1015int drm_atomic_helper_commit(struct drm_device *dev,
1016 struct drm_atomic_state *state,
1017 bool async)
1018{
1019 int ret;
1020
1021 if (async)
1022 return -EBUSY;
1023
1024 ret = drm_atomic_helper_prepare_planes(dev, state);
1025 if (ret)
1026 return ret;
1027
1028 /*
1029 * This is the point of no return - everything below never fails except
1030 * when the hw goes bonghits. Which means we can commit the new state on
1031 * the software side now.
1032 */
1033
1034 drm_atomic_helper_swap_state(dev, state);
1035
1036 /*
1037 * Everything below can be run asynchronously without the need to grab
f98bd3ef 1038 * any modeset locks at all under one condition: It must be guaranteed
623369e5
DV
1039 * that the asynchronous work has either been cancelled (if the driver
1040 * supports it, which at least requires that the framebuffers get
1041 * cleaned up with drm_atomic_helper_cleanup_planes()) or completed
1042 * before the new state gets committed on the software side with
1043 * drm_atomic_helper_swap_state().
1044 *
1045 * This scheme allows new atomic state updates to be prepared and
1046 * checked in parallel to the asynchronous completion of the previous
1047 * update. Which is important since compositors need to figure out the
1048 * composition of the next frame right after having submitted the
1049 * current layout.
1050 */
1051
e2330f07
DV
1052 wait_for_fences(dev, state);
1053
1af434a9 1054 drm_atomic_helper_commit_modeset_disables(dev, state);
623369e5 1055
aef9dbb8 1056 drm_atomic_helper_commit_planes(dev, state, false);
623369e5 1057
1af434a9 1058 drm_atomic_helper_commit_modeset_enables(dev, state);
623369e5 1059
5ee3229c 1060 drm_atomic_helper_wait_for_vblanks(dev, state);
623369e5
DV
1061
1062 drm_atomic_helper_cleanup_planes(dev, state);
1063
1064 drm_atomic_state_free(state);
1065
1066 return 0;
1067}
1068EXPORT_SYMBOL(drm_atomic_helper_commit);
1069
e8c833a7
DV
1070/**
1071 * DOC: implementing async commit
1072 *
1073 * For now the atomic helpers don't support async commit directly. If there is
1074 * real need it could be added though, using the dma-buf fence infrastructure
1075 * for generic synchronization with outstanding rendering.
1076 *
1077 * For now drivers have to implement async commit themselves, with the following
1078 * sequence being the recommended one:
1079 *
1080 * 1. Run drm_atomic_helper_prepare_planes() first. This is the only function
1081 * which commit needs to call which can fail, so we want to run it first and
1082 * synchronously.
1083 *
1084 * 2. Synchronize with any outstanding asynchronous commit worker threads which
1085 * might be affected the new state update. This can be done by either cancelling
1086 * or flushing the work items, depending upon whether the driver can deal with
1087 * cancelled updates. Note that it is important to ensure that the framebuffer
1088 * cleanup is still done when cancelling.
1089 *
1090 * For sufficient parallelism it is recommended to have a work item per crtc
1091 * (for updates which don't touch global state) and a global one. Then we only
1092 * need to synchronize with the crtc work items for changed crtcs and the global
1093 * work item, which allows nice concurrent updates on disjoint sets of crtcs.
1094 *
1095 * 3. The software state is updated synchronously with
26196f7e 1096 * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset
e8c833a7
DV
1097 * locks means concurrent callers never see inconsistent state. And doing this
1098 * while it's guaranteed that no relevant async worker runs means that async
1099 * workers do not need grab any locks. Actually they must not grab locks, for
1100 * otherwise the work flushing will deadlock.
1101 *
1102 * 4. Schedule a work item to do all subsequent steps, using the split-out
1103 * commit helpers: a) pre-plane commit b) plane commit c) post-plane commit and
1104 * then cleaning up the framebuffers after the old framebuffer is no longer
1105 * being displayed.
1106 */
1107
c2fcd274 1108/**
2e3afd47 1109 * drm_atomic_helper_prepare_planes - prepare plane resources before commit
c2fcd274 1110 * @dev: DRM device
2e3afd47 1111 * @state: atomic state object with new state structures
c2fcd274
DV
1112 *
1113 * This function prepares plane state, specifically framebuffers, for the new
1114 * configuration. If any failure is encountered this function will call
1115 * ->cleanup_fb on any already successfully prepared framebuffer.
1116 *
1117 * Returns:
1118 * 0 on success, negative error code on failure.
1119 */
1120int drm_atomic_helper_prepare_planes(struct drm_device *dev,
1121 struct drm_atomic_state *state)
1122{
1123 int nplanes = dev->mode_config.num_total_plane;
1124 int ret, i;
1125
1126 for (i = 0; i < nplanes; i++) {
b5ceff20 1127 const struct drm_plane_helper_funcs *funcs;
c2fcd274 1128 struct drm_plane *plane = state->planes[i];
d136dfee 1129 struct drm_plane_state *plane_state = state->plane_states[i];
c2fcd274
DV
1130
1131 if (!plane)
1132 continue;
1133
1134 funcs = plane->helper_private;
1135
844f9111
ML
1136 if (funcs->prepare_fb) {
1137 ret = funcs->prepare_fb(plane, plane_state);
c2fcd274
DV
1138 if (ret)
1139 goto fail;
1140 }
1141 }
1142
1143 return 0;
1144
1145fail:
1146 for (i--; i >= 0; i--) {
b5ceff20 1147 const struct drm_plane_helper_funcs *funcs;
c2fcd274 1148 struct drm_plane *plane = state->planes[i];
d136dfee 1149 struct drm_plane_state *plane_state = state->plane_states[i];
c2fcd274
DV
1150
1151 if (!plane)
1152 continue;
1153
1154 funcs = plane->helper_private;
1155
844f9111
ML
1156 if (funcs->cleanup_fb)
1157 funcs->cleanup_fb(plane, plane_state);
c2fcd274
DV
1158
1159 }
1160
1161 return ret;
1162}
1163EXPORT_SYMBOL(drm_atomic_helper_prepare_planes);
1164
aef9dbb8
DV
1165bool plane_crtc_active(struct drm_plane_state *state)
1166{
1167 return state->crtc && state->crtc->state->active;
1168}
1169
c2fcd274
DV
1170/**
1171 * drm_atomic_helper_commit_planes - commit plane state
1172 * @dev: DRM device
b0fcfc89 1173 * @old_state: atomic state object with old state structures
aef9dbb8 1174 * @active_only: Only commit on active CRTC if set
c2fcd274
DV
1175 *
1176 * This function commits the new plane state using the plane and atomic helper
1177 * functions for planes and crtcs. It assumes that the atomic state has already
1178 * been pushed into the relevant object state pointers, since this step can no
1179 * longer fail.
1180 *
b0fcfc89 1181 * It still requires the global state object @old_state to know which planes and
c2fcd274 1182 * crtcs need to be updated though.
de28d021
ML
1183 *
1184 * Note that this function does all plane updates across all CRTCs in one step.
1185 * If the hardware can't support this approach look at
1186 * drm_atomic_helper_commit_planes_on_crtc() instead.
6e48ae32
DV
1187 *
1188 * Plane parameters can be updated by applications while the associated CRTC is
1189 * disabled. The DRM/KMS core will store the parameters in the plane state,
1190 * which will be available to the driver when the CRTC is turned on. As a result
1191 * most drivers don't need to be immediately notified of plane updates for a
1192 * disabled CRTC.
1193 *
1194 * Unless otherwise needed, drivers are advised to set the @active_only
1195 * parameters to true in order not to receive plane update notifications related
1196 * to a disabled CRTC. This avoids the need to manually ignore plane updates in
1197 * driver code when the driver and/or hardware can't or just don't need to deal
1198 * with updates on disabled CRTCs, for example when supporting runtime PM.
1199 *
1200 * The drm_atomic_helper_commit() default implementation only sets @active_only
1201 * to false to most closely match the behaviour of the legacy helpers. This should
1202 * not be copied blindly by drivers.
c2fcd274
DV
1203 */
1204void drm_atomic_helper_commit_planes(struct drm_device *dev,
aef9dbb8
DV
1205 struct drm_atomic_state *old_state,
1206 bool active_only)
c2fcd274 1207{
df63b999
ACO
1208 struct drm_crtc *crtc;
1209 struct drm_crtc_state *old_crtc_state;
1210 struct drm_plane *plane;
1211 struct drm_plane_state *old_plane_state;
c2fcd274
DV
1212 int i;
1213
df63b999 1214 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
b5ceff20 1215 const struct drm_crtc_helper_funcs *funcs;
c2fcd274
DV
1216
1217 funcs = crtc->helper_private;
1218
1219 if (!funcs || !funcs->atomic_begin)
1220 continue;
1221
aef9dbb8
DV
1222 if (active_only && !crtc->state->active)
1223 continue;
1224
613d2b27 1225 funcs->atomic_begin(crtc, old_crtc_state);
c2fcd274
DV
1226 }
1227
df63b999 1228 for_each_plane_in_state(old_state, plane, old_plane_state, i) {
b5ceff20 1229 const struct drm_plane_helper_funcs *funcs;
c2fcd274
DV
1230
1231 funcs = plane->helper_private;
1232
3cad4b68 1233 if (!funcs)
c2fcd274
DV
1234 continue;
1235
aef9dbb8
DV
1236 if (active_only && !plane_crtc_active(plane->state))
1237 continue;
1238
407b8bd9
TR
1239 /*
1240 * Special-case disabling the plane if drivers support it.
1241 */
1242 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1243 funcs->atomic_disable)
1244 funcs->atomic_disable(plane, old_plane_state);
475d231b
DV
1245 else if (plane->state->crtc ||
1246 drm_atomic_plane_disabling(plane, old_plane_state))
407b8bd9 1247 funcs->atomic_update(plane, old_plane_state);
c2fcd274
DV
1248 }
1249
df63b999 1250 for_each_crtc_in_state(old_state, crtc, old_crtc_state, i) {
b5ceff20 1251 const struct drm_crtc_helper_funcs *funcs;
c2fcd274
DV
1252
1253 funcs = crtc->helper_private;
1254
1255 if (!funcs || !funcs->atomic_flush)
1256 continue;
1257
aef9dbb8
DV
1258 if (active_only && !crtc->state->active)
1259 continue;
1260
613d2b27 1261 funcs->atomic_flush(crtc, old_crtc_state);
c2fcd274
DV
1262 }
1263}
1264EXPORT_SYMBOL(drm_atomic_helper_commit_planes);
1265
de28d021
ML
1266/**
1267 * drm_atomic_helper_commit_planes_on_crtc - commit plane state for a crtc
1268 * @old_crtc_state: atomic state object with the old crtc state
1269 *
1270 * This function commits the new plane state using the plane and atomic helper
1271 * functions for planes on the specific crtc. It assumes that the atomic state
1272 * has already been pushed into the relevant object state pointers, since this
1273 * step can no longer fail.
1274 *
1275 * This function is useful when plane updates should be done crtc-by-crtc
1276 * instead of one global step like drm_atomic_helper_commit_planes() does.
1277 *
1278 * This function can only be savely used when planes are not allowed to move
1279 * between different CRTCs because this function doesn't handle inter-CRTC
1280 * depencies. Callers need to ensure that either no such depencies exist,
1281 * resolve them through ordering of commit calls or through some other means.
1282 */
1283void
1284drm_atomic_helper_commit_planes_on_crtc(struct drm_crtc_state *old_crtc_state)
1285{
1286 const struct drm_crtc_helper_funcs *crtc_funcs;
1287 struct drm_crtc *crtc = old_crtc_state->crtc;
1288 struct drm_atomic_state *old_state = old_crtc_state->state;
1289 struct drm_plane *plane;
1290 unsigned plane_mask;
1291
1292 plane_mask = old_crtc_state->plane_mask;
1293 plane_mask |= crtc->state->plane_mask;
1294
1295 crtc_funcs = crtc->helper_private;
1296 if (crtc_funcs && crtc_funcs->atomic_begin)
613d2b27 1297 crtc_funcs->atomic_begin(crtc, old_crtc_state);
de28d021
ML
1298
1299 drm_for_each_plane_mask(plane, crtc->dev, plane_mask) {
1300 struct drm_plane_state *old_plane_state =
1301 drm_atomic_get_existing_plane_state(old_state, plane);
1302 const struct drm_plane_helper_funcs *plane_funcs;
1303
1304 plane_funcs = plane->helper_private;
1305
1306 if (!old_plane_state || !plane_funcs)
1307 continue;
1308
1309 WARN_ON(plane->state->crtc && plane->state->crtc != crtc);
1310
1311 if (drm_atomic_plane_disabling(plane, old_plane_state) &&
1312 plane_funcs->atomic_disable)
1313 plane_funcs->atomic_disable(plane, old_plane_state);
1314 else if (plane->state->crtc ||
1315 drm_atomic_plane_disabling(plane, old_plane_state))
1316 plane_funcs->atomic_update(plane, old_plane_state);
1317 }
1318
1319 if (crtc_funcs && crtc_funcs->atomic_flush)
613d2b27 1320 crtc_funcs->atomic_flush(crtc, old_crtc_state);
de28d021
ML
1321}
1322EXPORT_SYMBOL(drm_atomic_helper_commit_planes_on_crtc);
1323
c2fcd274
DV
1324/**
1325 * drm_atomic_helper_cleanup_planes - cleanup plane resources after commit
1326 * @dev: DRM device
1327 * @old_state: atomic state object with old state structures
1328 *
1329 * This function cleans up plane state, specifically framebuffers, from the old
1330 * configuration. Hence the old configuration must be perserved in @old_state to
1331 * be able to call this function.
1332 *
1333 * This function must also be called on the new state when the atomic update
1334 * fails at any point after calling drm_atomic_helper_prepare_planes().
1335 */
1336void drm_atomic_helper_cleanup_planes(struct drm_device *dev,
1337 struct drm_atomic_state *old_state)
1338{
df63b999
ACO
1339 struct drm_plane *plane;
1340 struct drm_plane_state *plane_state;
c2fcd274
DV
1341 int i;
1342
df63b999 1343 for_each_plane_in_state(old_state, plane, plane_state, i) {
b5ceff20 1344 const struct drm_plane_helper_funcs *funcs;
c2fcd274 1345
c2fcd274
DV
1346 funcs = plane->helper_private;
1347
844f9111
ML
1348 if (funcs->cleanup_fb)
1349 funcs->cleanup_fb(plane, plane_state);
c2fcd274
DV
1350 }
1351}
1352EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
1353
1354/**
1355 * drm_atomic_helper_swap_state - store atomic state into current sw state
1356 * @dev: DRM device
1357 * @state: atomic state
1358 *
1359 * This function stores the atomic state into the current state pointers in all
1360 * driver objects. It should be called after all failing steps have been done
1361 * and succeeded, but before the actual hardware state is committed.
1362 *
1363 * For cleanup and error recovery the current state for all changed objects will
1364 * be swaped into @state.
1365 *
1366 * With that sequence it fits perfectly into the plane prepare/cleanup sequence:
1367 *
1368 * 1. Call drm_atomic_helper_prepare_planes() with the staged atomic state.
1369 *
1370 * 2. Do any other steps that might fail.
1371 *
1372 * 3. Put the staged state into the current state pointers with this function.
1373 *
1374 * 4. Actually commit the hardware state.
1375 *
26196f7e 1376 * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3
c2fcd274
DV
1377 * contains the old state. Also do any other cleanup required with that state.
1378 */
1379void drm_atomic_helper_swap_state(struct drm_device *dev,
1380 struct drm_atomic_state *state)
1381{
1382 int i;
1383
1384 for (i = 0; i < dev->mode_config.num_connector; i++) {
1385 struct drm_connector *connector = state->connectors[i];
1386
1387 if (!connector)
1388 continue;
1389
1390 connector->state->state = state;
1391 swap(state->connector_states[i], connector->state);
1392 connector->state->state = NULL;
1393 }
1394
1395 for (i = 0; i < dev->mode_config.num_crtc; i++) {
1396 struct drm_crtc *crtc = state->crtcs[i];
1397
1398 if (!crtc)
1399 continue;
1400
1401 crtc->state->state = state;
1402 swap(state->crtc_states[i], crtc->state);
1403 crtc->state->state = NULL;
1404 }
1405
1406 for (i = 0; i < dev->mode_config.num_total_plane; i++) {
1407 struct drm_plane *plane = state->planes[i];
1408
1409 if (!plane)
1410 continue;
1411
1412 plane->state->state = state;
1413 swap(state->plane_states[i], plane->state);
1414 plane->state->state = NULL;
1415 }
1416}
1417EXPORT_SYMBOL(drm_atomic_helper_swap_state);
042652ed
DV
1418
1419/**
1420 * drm_atomic_helper_update_plane - Helper for primary plane update using atomic
1421 * @plane: plane object to update
1422 * @crtc: owning CRTC of owning plane
1423 * @fb: framebuffer to flip onto plane
1424 * @crtc_x: x offset of primary plane on crtc
1425 * @crtc_y: y offset of primary plane on crtc
1426 * @crtc_w: width of primary plane rectangle on crtc
1427 * @crtc_h: height of primary plane rectangle on crtc
1428 * @src_x: x offset of @fb for panning
1429 * @src_y: y offset of @fb for panning
1430 * @src_w: width of source rectangle in @fb
1431 * @src_h: height of source rectangle in @fb
1432 *
1433 * Provides a default plane update handler using the atomic driver interface.
1434 *
1435 * RETURNS:
1436 * Zero on success, error code on failure
1437 */
1438int drm_atomic_helper_update_plane(struct drm_plane *plane,
1439 struct drm_crtc *crtc,
1440 struct drm_framebuffer *fb,
1441 int crtc_x, int crtc_y,
1442 unsigned int crtc_w, unsigned int crtc_h,
1443 uint32_t src_x, uint32_t src_y,
1444 uint32_t src_w, uint32_t src_h)
1445{
1446 struct drm_atomic_state *state;
1447 struct drm_plane_state *plane_state;
1448 int ret = 0;
1449
1450 state = drm_atomic_state_alloc(plane->dev);
1451 if (!state)
1452 return -ENOMEM;
1453
1454 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1455retry:
1456 plane_state = drm_atomic_get_plane_state(state, plane);
1457 if (IS_ERR(plane_state)) {
1458 ret = PTR_ERR(plane_state);
1459 goto fail;
1460 }
1461
07cc0ef6 1462 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
042652ed
DV
1463 if (ret != 0)
1464 goto fail;
321ebf04 1465 drm_atomic_set_fb_for_plane(plane_state, fb);
042652ed
DV
1466 plane_state->crtc_x = crtc_x;
1467 plane_state->crtc_y = crtc_y;
1468 plane_state->crtc_h = crtc_h;
1469 plane_state->crtc_w = crtc_w;
1470 plane_state->src_x = src_x;
1471 plane_state->src_y = src_y;
1472 plane_state->src_h = src_h;
1473 plane_state->src_w = src_w;
1474
3671c580
DV
1475 if (plane == crtc->cursor)
1476 state->legacy_cursor_update = true;
1477
042652ed
DV
1478 ret = drm_atomic_commit(state);
1479 if (ret != 0)
1480 goto fail;
1481
1482 /* Driver takes ownership of state on successful commit. */
1483 return 0;
1484fail:
1485 if (ret == -EDEADLK)
1486 goto backoff;
1487
1488 drm_atomic_state_free(state);
1489
1490 return ret;
1491backoff:
042652ed 1492 drm_atomic_state_clear(state);
6f75cea6 1493 drm_atomic_legacy_backoff(state);
042652ed
DV
1494
1495 /*
1496 * Someone might have exchanged the framebuffer while we dropped locks
1497 * in the backoff code. We need to fix up the fb refcount tracking the
1498 * core does for us.
1499 */
1500 plane->old_fb = plane->fb;
1501
1502 goto retry;
1503}
1504EXPORT_SYMBOL(drm_atomic_helper_update_plane);
1505
1506/**
1507 * drm_atomic_helper_disable_plane - Helper for primary plane disable using * atomic
1508 * @plane: plane to disable
1509 *
1510 * Provides a default plane disable handler using the atomic driver interface.
1511 *
1512 * RETURNS:
1513 * Zero on success, error code on failure
1514 */
1515int drm_atomic_helper_disable_plane(struct drm_plane *plane)
1516{
1517 struct drm_atomic_state *state;
1518 struct drm_plane_state *plane_state;
1519 int ret = 0;
1520
aa54e2ee
JSP
1521 /*
1522 * FIXME: Without plane->crtc set we can't get at the implicit legacy
1523 * acquire context. The real fix will be to wire the acquire ctx through
1524 * everywhere we need it, but meanwhile prevent chaos by just skipping
1525 * this noop. The critical case is the cursor ioctls which a) only grab
1526 * crtc/cursor-plane locks (so we need the crtc to get at the right
1527 * acquire context) and b) can try to disable the plane multiple times.
1528 */
1529 if (!plane->crtc)
1530 return 0;
1531
042652ed
DV
1532 state = drm_atomic_state_alloc(plane->dev);
1533 if (!state)
1534 return -ENOMEM;
1535
1536 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(plane->crtc);
1537retry:
1538 plane_state = drm_atomic_get_plane_state(state, plane);
1539 if (IS_ERR(plane_state)) {
1540 ret = PTR_ERR(plane_state);
1541 goto fail;
1542 }
1543
07cc0ef6 1544 ret = drm_atomic_set_crtc_for_plane(plane_state, NULL);
042652ed
DV
1545 if (ret != 0)
1546 goto fail;
321ebf04 1547 drm_atomic_set_fb_for_plane(plane_state, NULL);
042652ed
DV
1548 plane_state->crtc_x = 0;
1549 plane_state->crtc_y = 0;
1550 plane_state->crtc_h = 0;
1551 plane_state->crtc_w = 0;
1552 plane_state->src_x = 0;
1553 plane_state->src_y = 0;
1554 plane_state->src_h = 0;
1555 plane_state->src_w = 0;
1556
f02ad907
DV
1557 if (plane == plane->crtc->cursor)
1558 state->legacy_cursor_update = true;
1559
042652ed
DV
1560 ret = drm_atomic_commit(state);
1561 if (ret != 0)
1562 goto fail;
1563
1564 /* Driver takes ownership of state on successful commit. */
1565 return 0;
1566fail:
1567 if (ret == -EDEADLK)
1568 goto backoff;
1569
1570 drm_atomic_state_free(state);
1571
1572 return ret;
1573backoff:
042652ed 1574 drm_atomic_state_clear(state);
6f75cea6 1575 drm_atomic_legacy_backoff(state);
042652ed
DV
1576
1577 /*
1578 * Someone might have exchanged the framebuffer while we dropped locks
1579 * in the backoff code. We need to fix up the fb refcount tracking the
1580 * core does for us.
1581 */
1582 plane->old_fb = plane->fb;
1583
1584 goto retry;
1585}
1586EXPORT_SYMBOL(drm_atomic_helper_disable_plane);
1587
1588static int update_output_state(struct drm_atomic_state *state,
1589 struct drm_mode_set *set)
1590{
1591 struct drm_device *dev = set->crtc->dev;
df63b999
ACO
1592 struct drm_crtc *crtc;
1593 struct drm_crtc_state *crtc_state;
1594 struct drm_connector *connector;
042652ed 1595 struct drm_connector_state *conn_state;
042652ed
DV
1596 int ret, i, j;
1597
1598 ret = drm_modeset_lock(&dev->mode_config.connection_mutex,
1599 state->acquire_ctx);
1600 if (ret)
1601 return ret;
1602
1603 /* First grab all affected connector/crtc states. */
1604 for (i = 0; i < set->num_connectors; i++) {
1605 conn_state = drm_atomic_get_connector_state(state,
1606 set->connectors[i]);
1607 if (IS_ERR(conn_state))
1608 return PTR_ERR(conn_state);
1609 }
1610
df63b999 1611 for_each_crtc_in_state(state, crtc, crtc_state, i) {
042652ed
DV
1612 ret = drm_atomic_add_affected_connectors(state, crtc);
1613 if (ret)
1614 return ret;
1615 }
1616
1617 /* Then recompute connector->crtc links and crtc enabling state. */
df63b999 1618 for_each_connector_in_state(state, connector, conn_state, i) {
042652ed
DV
1619 if (conn_state->crtc == set->crtc) {
1620 ret = drm_atomic_set_crtc_for_connector(conn_state,
1621 NULL);
1622 if (ret)
1623 return ret;
1624 }
1625
1626 for (j = 0; j < set->num_connectors; j++) {
1627 if (set->connectors[j] == connector) {
1628 ret = drm_atomic_set_crtc_for_connector(conn_state,
1629 set->crtc);
1630 if (ret)
1631 return ret;
1632 break;
1633 }
1634 }
1635 }
1636
df63b999 1637 for_each_crtc_in_state(state, crtc, crtc_state, i) {
042652ed
DV
1638 /* Don't update ->enable for the CRTC in the set_config request,
1639 * since a mismatch would indicate a bug in the upper layers.
1640 * The actual modeset code later on will catch any
1641 * inconsistencies here. */
1642 if (crtc == set->crtc)
1643 continue;
1644
c30f55a7
LP
1645 if (!drm_atomic_connectors_for_crtc(state, crtc)) {
1646 ret = drm_atomic_set_mode_prop_for_crtc(crtc_state,
1647 NULL);
1648 if (ret < 0)
1649 return ret;
1650
9b5edbf7 1651 crtc_state->active = false;
c30f55a7 1652 }
042652ed
DV
1653 }
1654
1655 return 0;
1656}
1657
1658/**
1659 * drm_atomic_helper_set_config - set a new config from userspace
1660 * @set: mode set configuration
1661 *
1662 * Provides a default crtc set_config handler using the atomic driver interface.
1663 *
1664 * Returns:
1665 * Returns 0 on success, negative errno numbers on failure.
1666 */
1667int drm_atomic_helper_set_config(struct drm_mode_set *set)
1668{
1669 struct drm_atomic_state *state;
1670 struct drm_crtc *crtc = set->crtc;
1671 struct drm_crtc_state *crtc_state;
1672 struct drm_plane_state *primary_state;
1673 int ret = 0;
1674
1675 state = drm_atomic_state_alloc(crtc->dev);
1676 if (!state)
1677 return -ENOMEM;
1678
1679 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1680retry:
1681 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1682 if (IS_ERR(crtc_state)) {
1683 ret = PTR_ERR(crtc_state);
1684 goto fail;
1685 }
1686
e5b5341c
RC
1687 primary_state = drm_atomic_get_plane_state(state, crtc->primary);
1688 if (IS_ERR(primary_state)) {
1689 ret = PTR_ERR(primary_state);
1690 goto fail;
1691 }
1692
042652ed
DV
1693 if (!set->mode) {
1694 WARN_ON(set->fb);
1695 WARN_ON(set->num_connectors);
1696
819364da
DS
1697 ret = drm_atomic_set_mode_for_crtc(crtc_state, NULL);
1698 if (ret != 0)
1699 goto fail;
1700
eab3bbef 1701 crtc_state->active = false;
e5b5341c 1702
07cc0ef6 1703 ret = drm_atomic_set_crtc_for_plane(primary_state, NULL);
e5b5341c
RC
1704 if (ret != 0)
1705 goto fail;
1706
1707 drm_atomic_set_fb_for_plane(primary_state, NULL);
1708
042652ed
DV
1709 goto commit;
1710 }
1711
1712 WARN_ON(!set->fb);
1713 WARN_ON(!set->num_connectors);
1714
819364da
DS
1715 ret = drm_atomic_set_mode_for_crtc(crtc_state, set->mode);
1716 if (ret != 0)
1717 goto fail;
1718
eab3bbef 1719 crtc_state->active = true;
042652ed 1720
07cc0ef6 1721 ret = drm_atomic_set_crtc_for_plane(primary_state, crtc);
042652ed
DV
1722 if (ret != 0)
1723 goto fail;
321ebf04 1724 drm_atomic_set_fb_for_plane(primary_state, set->fb);
042652ed
DV
1725 primary_state->crtc_x = 0;
1726 primary_state->crtc_y = 0;
1727 primary_state->crtc_h = set->mode->vdisplay;
1728 primary_state->crtc_w = set->mode->hdisplay;
1729 primary_state->src_x = set->x << 16;
1730 primary_state->src_y = set->y << 16;
1731 primary_state->src_h = set->mode->vdisplay << 16;
1732 primary_state->src_w = set->mode->hdisplay << 16;
1733
1734commit:
1735 ret = update_output_state(state, set);
1736 if (ret)
1737 goto fail;
1738
1739 ret = drm_atomic_commit(state);
1740 if (ret != 0)
1741 goto fail;
1742
1743 /* Driver takes ownership of state on successful commit. */
1744 return 0;
1745fail:
1746 if (ret == -EDEADLK)
1747 goto backoff;
1748
1749 drm_atomic_state_free(state);
1750
1751 return ret;
1752backoff:
042652ed 1753 drm_atomic_state_clear(state);
6f75cea6 1754 drm_atomic_legacy_backoff(state);
042652ed
DV
1755
1756 /*
1757 * Someone might have exchanged the framebuffer while we dropped locks
1758 * in the backoff code. We need to fix up the fb refcount tracking the
1759 * core does for us.
1760 */
1761 crtc->primary->old_fb = crtc->primary->fb;
1762
1763 goto retry;
1764}
1765EXPORT_SYMBOL(drm_atomic_helper_set_config);
1766
1767/**
7f50002f 1768 * drm_atomic_helper_crtc_set_property - helper for crtc properties
042652ed
DV
1769 * @crtc: DRM crtc
1770 * @property: DRM property
1771 * @val: value of property
1772 *
7f50002f
LP
1773 * Provides a default crtc set_property handler using the atomic driver
1774 * interface.
042652ed
DV
1775 *
1776 * RETURNS:
1777 * Zero on success, error code on failure
1778 */
1779int
1780drm_atomic_helper_crtc_set_property(struct drm_crtc *crtc,
1781 struct drm_property *property,
1782 uint64_t val)
1783{
1784 struct drm_atomic_state *state;
1785 struct drm_crtc_state *crtc_state;
1786 int ret = 0;
1787
1788 state = drm_atomic_state_alloc(crtc->dev);
1789 if (!state)
1790 return -ENOMEM;
1791
1792 /* ->set_property is always called with all locks held. */
1793 state->acquire_ctx = crtc->dev->mode_config.acquire_ctx;
1794retry:
1795 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1796 if (IS_ERR(crtc_state)) {
1797 ret = PTR_ERR(crtc_state);
1798 goto fail;
1799 }
1800
40ecc694
RC
1801 ret = drm_atomic_crtc_set_property(crtc, crtc_state,
1802 property, val);
042652ed
DV
1803 if (ret)
1804 goto fail;
1805
1806 ret = drm_atomic_commit(state);
1807 if (ret != 0)
1808 goto fail;
1809
1810 /* Driver takes ownership of state on successful commit. */
1811 return 0;
1812fail:
1813 if (ret == -EDEADLK)
1814 goto backoff;
1815
1816 drm_atomic_state_free(state);
1817
1818 return ret;
1819backoff:
042652ed 1820 drm_atomic_state_clear(state);
6f75cea6 1821 drm_atomic_legacy_backoff(state);
042652ed
DV
1822
1823 goto retry;
1824}
1825EXPORT_SYMBOL(drm_atomic_helper_crtc_set_property);
1826
1827/**
7f50002f 1828 * drm_atomic_helper_plane_set_property - helper for plane properties
042652ed
DV
1829 * @plane: DRM plane
1830 * @property: DRM property
1831 * @val: value of property
1832 *
7f50002f
LP
1833 * Provides a default plane set_property handler using the atomic driver
1834 * interface.
042652ed
DV
1835 *
1836 * RETURNS:
1837 * Zero on success, error code on failure
1838 */
1839int
1840drm_atomic_helper_plane_set_property(struct drm_plane *plane,
1841 struct drm_property *property,
1842 uint64_t val)
1843{
1844 struct drm_atomic_state *state;
1845 struct drm_plane_state *plane_state;
1846 int ret = 0;
1847
1848 state = drm_atomic_state_alloc(plane->dev);
1849 if (!state)
1850 return -ENOMEM;
1851
1852 /* ->set_property is always called with all locks held. */
1853 state->acquire_ctx = plane->dev->mode_config.acquire_ctx;
1854retry:
1855 plane_state = drm_atomic_get_plane_state(state, plane);
1856 if (IS_ERR(plane_state)) {
1857 ret = PTR_ERR(plane_state);
1858 goto fail;
1859 }
1860
40ecc694
RC
1861 ret = drm_atomic_plane_set_property(plane, plane_state,
1862 property, val);
042652ed
DV
1863 if (ret)
1864 goto fail;
1865
1866 ret = drm_atomic_commit(state);
1867 if (ret != 0)
1868 goto fail;
1869
1870 /* Driver takes ownership of state on successful commit. */
1871 return 0;
1872fail:
1873 if (ret == -EDEADLK)
1874 goto backoff;
1875
1876 drm_atomic_state_free(state);
1877
1878 return ret;
1879backoff:
042652ed 1880 drm_atomic_state_clear(state);
6f75cea6 1881 drm_atomic_legacy_backoff(state);
042652ed
DV
1882
1883 goto retry;
1884}
1885EXPORT_SYMBOL(drm_atomic_helper_plane_set_property);
1886
1887/**
7f50002f 1888 * drm_atomic_helper_connector_set_property - helper for connector properties
042652ed
DV
1889 * @connector: DRM connector
1890 * @property: DRM property
1891 * @val: value of property
1892 *
7f50002f
LP
1893 * Provides a default connector set_property handler using the atomic driver
1894 * interface.
042652ed
DV
1895 *
1896 * RETURNS:
1897 * Zero on success, error code on failure
1898 */
1899int
1900drm_atomic_helper_connector_set_property(struct drm_connector *connector,
1901 struct drm_property *property,
1902 uint64_t val)
1903{
1904 struct drm_atomic_state *state;
1905 struct drm_connector_state *connector_state;
1906 int ret = 0;
1907
1908 state = drm_atomic_state_alloc(connector->dev);
1909 if (!state)
1910 return -ENOMEM;
1911
1912 /* ->set_property is always called with all locks held. */
1913 state->acquire_ctx = connector->dev->mode_config.acquire_ctx;
1914retry:
1915 connector_state = drm_atomic_get_connector_state(state, connector);
1916 if (IS_ERR(connector_state)) {
1917 ret = PTR_ERR(connector_state);
1918 goto fail;
1919 }
1920
40ecc694
RC
1921 ret = drm_atomic_connector_set_property(connector, connector_state,
1922 property, val);
042652ed
DV
1923 if (ret)
1924 goto fail;
1925
1926 ret = drm_atomic_commit(state);
1927 if (ret != 0)
1928 goto fail;
1929
1930 /* Driver takes ownership of state on successful commit. */
1931 return 0;
1932fail:
1933 if (ret == -EDEADLK)
1934 goto backoff;
1935
1936 drm_atomic_state_free(state);
1937
1938 return ret;
1939backoff:
042652ed 1940 drm_atomic_state_clear(state);
6f75cea6 1941 drm_atomic_legacy_backoff(state);
042652ed
DV
1942
1943 goto retry;
1944}
1945EXPORT_SYMBOL(drm_atomic_helper_connector_set_property);
8bc0f312
DV
1946
1947/**
1948 * drm_atomic_helper_page_flip - execute a legacy page flip
1949 * @crtc: DRM crtc
1950 * @fb: DRM framebuffer
1951 * @event: optional DRM event to signal upon completion
1952 * @flags: flip flags for non-vblank sync'ed updates
1953 *
1954 * Provides a default page flip implementation using the atomic driver interface.
1955 *
1956 * Note that for now so called async page flips (i.e. updates which are not
1957 * synchronized to vblank) are not supported, since the atomic interfaces have
1958 * no provisions for this yet.
1959 *
1960 * Returns:
1961 * Returns 0 on success, negative errno numbers on failure.
1962 */
1963int drm_atomic_helper_page_flip(struct drm_crtc *crtc,
1964 struct drm_framebuffer *fb,
1965 struct drm_pending_vblank_event *event,
1966 uint32_t flags)
1967{
1968 struct drm_plane *plane = crtc->primary;
1969 struct drm_atomic_state *state;
1970 struct drm_plane_state *plane_state;
1971 struct drm_crtc_state *crtc_state;
1972 int ret = 0;
1973
1974 if (flags & DRM_MODE_PAGE_FLIP_ASYNC)
1975 return -EINVAL;
1976
1977 state = drm_atomic_state_alloc(plane->dev);
1978 if (!state)
1979 return -ENOMEM;
1980
1981 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
1982retry:
1983 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1984 if (IS_ERR(crtc_state)) {
1985 ret = PTR_ERR(crtc_state);
1986 goto fail;
1987 }
1988 crtc_state->event = event;
1989
1990 plane_state = drm_atomic_get_plane_state(state, plane);
1991 if (IS_ERR(plane_state)) {
1992 ret = PTR_ERR(plane_state);
1993 goto fail;
1994 }
1995
07cc0ef6 1996 ret = drm_atomic_set_crtc_for_plane(plane_state, crtc);
8bc0f312
DV
1997 if (ret != 0)
1998 goto fail;
321ebf04 1999 drm_atomic_set_fb_for_plane(plane_state, fb);
8bc0f312
DV
2000
2001 ret = drm_atomic_async_commit(state);
2002 if (ret != 0)
2003 goto fail;
2004
8bc0f312
DV
2005 /* Driver takes ownership of state on successful async commit. */
2006 return 0;
2007fail:
2008 if (ret == -EDEADLK)
2009 goto backoff;
2010
2011 drm_atomic_state_free(state);
2012
2013 return ret;
2014backoff:
8bc0f312 2015 drm_atomic_state_clear(state);
6f75cea6 2016 drm_atomic_legacy_backoff(state);
8bc0f312
DV
2017
2018 /*
2019 * Someone might have exchanged the framebuffer while we dropped locks
2020 * in the backoff code. We need to fix up the fb refcount tracking the
2021 * core does for us.
2022 */
2023 plane->old_fb = plane->fb;
2024
2025 goto retry;
2026}
2027EXPORT_SYMBOL(drm_atomic_helper_page_flip);
d461701c 2028
b486e0e6
DV
2029/**
2030 * drm_atomic_helper_connector_dpms() - connector dpms helper implementation
2031 * @connector: affected connector
2032 * @mode: DPMS mode
2033 *
2034 * This is the main helper function provided by the atomic helper framework for
2035 * implementing the legacy DPMS connector interface. It computes the new desired
2036 * ->active state for the corresponding CRTC (if the connector is enabled) and
2037 * updates it.
9a69a9ac
ML
2038 *
2039 * Returns:
2040 * Returns 0 on success, negative errno numbers on failure.
b486e0e6 2041 */
9a69a9ac
ML
2042int drm_atomic_helper_connector_dpms(struct drm_connector *connector,
2043 int mode)
b486e0e6
DV
2044{
2045 struct drm_mode_config *config = &connector->dev->mode_config;
2046 struct drm_atomic_state *state;
2047 struct drm_crtc_state *crtc_state;
2048 struct drm_crtc *crtc;
2049 struct drm_connector *tmp_connector;
2050 int ret;
2051 bool active = false;
9a69a9ac 2052 int old_mode = connector->dpms;
b486e0e6
DV
2053
2054 if (mode != DRM_MODE_DPMS_ON)
2055 mode = DRM_MODE_DPMS_OFF;
2056
2057 connector->dpms = mode;
2058 crtc = connector->state->crtc;
2059
2060 if (!crtc)
9a69a9ac 2061 return 0;
b486e0e6 2062
b486e0e6
DV
2063 state = drm_atomic_state_alloc(connector->dev);
2064 if (!state)
9a69a9ac 2065 return -ENOMEM;
b486e0e6
DV
2066
2067 state->acquire_ctx = drm_modeset_legacy_acquire_ctx(crtc);
2068retry:
2069 crtc_state = drm_atomic_get_crtc_state(state, crtc);
9a69a9ac
ML
2070 if (IS_ERR(crtc_state)) {
2071 ret = PTR_ERR(crtc_state);
2072 goto fail;
2073 }
b486e0e6
DV
2074
2075 WARN_ON(!drm_modeset_is_locked(&config->connection_mutex));
2076
9a9f5ce8 2077 drm_for_each_connector(tmp_connector, connector->dev) {
0388df05 2078 if (tmp_connector->state->crtc != crtc)
b486e0e6
DV
2079 continue;
2080
0388df05 2081 if (tmp_connector->dpms == DRM_MODE_DPMS_ON) {
b486e0e6
DV
2082 active = true;
2083 break;
2084 }
2085 }
2086 crtc_state->active = active;
2087
2088 ret = drm_atomic_commit(state);
2089 if (ret != 0)
2090 goto fail;
2091
9a69a9ac
ML
2092 /* Driver takes ownership of state on successful commit. */
2093 return 0;
b486e0e6
DV
2094fail:
2095 if (ret == -EDEADLK)
2096 goto backoff;
2097
9a69a9ac 2098 connector->dpms = old_mode;
b486e0e6
DV
2099 drm_atomic_state_free(state);
2100
9a69a9ac 2101 return ret;
b486e0e6
DV
2102backoff:
2103 drm_atomic_state_clear(state);
2104 drm_atomic_legacy_backoff(state);
2105
2106 goto retry;
2107}
2108EXPORT_SYMBOL(drm_atomic_helper_connector_dpms);
2109
3150c7d0
DV
2110/**
2111 * DOC: atomic state reset and initialization
2112 *
2113 * Both the drm core and the atomic helpers assume that there is always the full
2114 * and correct atomic software state for all connectors, CRTCs and planes
2115 * available. Which is a bit a problem on driver load and also after system
2116 * suspend. One way to solve this is to have a hardware state read-out
2117 * infrastructure which reconstructs the full software state (e.g. the i915
2118 * driver).
2119 *
2120 * The simpler solution is to just reset the software state to everything off,
2121 * which is easiest to do by calling drm_mode_config_reset(). To facilitate this
2122 * the atomic helpers provide default reset implementations for all hooks.
2123 */
2124
d461701c
DV
2125/**
2126 * drm_atomic_helper_crtc_reset - default ->reset hook for CRTCs
2127 * @crtc: drm CRTC
2128 *
2129 * Resets the atomic state for @crtc by freeing the state pointer (which might
2130 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2131 */
2132void drm_atomic_helper_crtc_reset(struct drm_crtc *crtc)
2133{
99cf4a29
DS
2134 if (crtc->state && crtc->state->mode_blob)
2135 drm_property_unreference_blob(crtc->state->mode_blob);
d461701c
DV
2136 kfree(crtc->state);
2137 crtc->state = kzalloc(sizeof(*crtc->state), GFP_KERNEL);
07cc0ef6
DV
2138
2139 if (crtc->state)
2140 crtc->state->crtc = crtc;
d461701c
DV
2141}
2142EXPORT_SYMBOL(drm_atomic_helper_crtc_reset);
2143
f5e7840b
TR
2144/**
2145 * __drm_atomic_helper_crtc_duplicate_state - copy atomic CRTC state
2146 * @crtc: CRTC object
2147 * @state: atomic CRTC state
2148 *
2149 * Copies atomic state from a CRTC's current state and resets inferred values.
2150 * This is useful for drivers that subclass the CRTC state.
2151 */
2152void __drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc,
2153 struct drm_crtc_state *state)
2154{
2155 memcpy(state, crtc->state, sizeof(*state));
2156
99cf4a29
DS
2157 if (state->mode_blob)
2158 drm_property_reference_blob(state->mode_blob);
f5e7840b
TR
2159 state->mode_changed = false;
2160 state->active_changed = false;
2161 state->planes_changed = false;
fc596660 2162 state->connectors_changed = false;
f5e7840b
TR
2163 state->event = NULL;
2164}
2165EXPORT_SYMBOL(__drm_atomic_helper_crtc_duplicate_state);
2166
d461701c
DV
2167/**
2168 * drm_atomic_helper_crtc_duplicate_state - default state duplicate hook
2169 * @crtc: drm CRTC
2170 *
2171 * Default CRTC state duplicate hook for drivers which don't have their own
2172 * subclassed CRTC state structure.
2173 */
2174struct drm_crtc_state *
2175drm_atomic_helper_crtc_duplicate_state(struct drm_crtc *crtc)
2176{
2177 struct drm_crtc_state *state;
2178
2179 if (WARN_ON(!crtc->state))
2180 return NULL;
2181
f5e7840b
TR
2182 state = kmalloc(sizeof(*state), GFP_KERNEL);
2183 if (state)
2184 __drm_atomic_helper_crtc_duplicate_state(crtc, state);
d461701c
DV
2185
2186 return state;
2187}
2188EXPORT_SYMBOL(drm_atomic_helper_crtc_duplicate_state);
2189
f5e7840b
TR
2190/**
2191 * __drm_atomic_helper_crtc_destroy_state - release CRTC state
2192 * @crtc: CRTC object
2193 * @state: CRTC state object to release
2194 *
2195 * Releases all resources stored in the CRTC state without actually freeing
2196 * the memory of the CRTC state. This is useful for drivers that subclass the
2197 * CRTC state.
2198 */
2199void __drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2200 struct drm_crtc_state *state)
2201{
99cf4a29
DS
2202 if (state->mode_blob)
2203 drm_property_unreference_blob(state->mode_blob);
f5e7840b
TR
2204}
2205EXPORT_SYMBOL(__drm_atomic_helper_crtc_destroy_state);
2206
d461701c
DV
2207/**
2208 * drm_atomic_helper_crtc_destroy_state - default state destroy hook
2209 * @crtc: drm CRTC
2210 * @state: CRTC state object to release
2211 *
2212 * Default CRTC state destroy hook for drivers which don't have their own
2213 * subclassed CRTC state structure.
2214 */
2215void drm_atomic_helper_crtc_destroy_state(struct drm_crtc *crtc,
2216 struct drm_crtc_state *state)
2217{
f5e7840b 2218 __drm_atomic_helper_crtc_destroy_state(crtc, state);
d461701c
DV
2219 kfree(state);
2220}
2221EXPORT_SYMBOL(drm_atomic_helper_crtc_destroy_state);
2222
2223/**
2224 * drm_atomic_helper_plane_reset - default ->reset hook for planes
2225 * @plane: drm plane
2226 *
2227 * Resets the atomic state for @plane by freeing the state pointer (which might
2228 * be NULL, e.g. at driver load time) and allocating a new empty state object.
2229 */
2230void drm_atomic_helper_plane_reset(struct drm_plane *plane)
2231{
321ebf04
DV
2232 if (plane->state && plane->state->fb)
2233 drm_framebuffer_unreference(plane->state->fb);
2234
d461701c
DV
2235 kfree(plane->state);
2236 plane->state = kzalloc(sizeof(*plane->state), GFP_KERNEL);
07cc0ef6
DV
2237
2238 if (plane->state)
2239 plane->state->plane = plane;
d461701c
DV
2240}
2241EXPORT_SYMBOL(drm_atomic_helper_plane_reset);
2242
f5e7840b
TR
2243/**
2244 * __drm_atomic_helper_plane_duplicate_state - copy atomic plane state
2245 * @plane: plane object
2246 * @state: atomic plane state
2247 *
2248 * Copies atomic state from a plane's current state. This is useful for
2249 * drivers that subclass the plane state.
2250 */
2251void __drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane,
2252 struct drm_plane_state *state)
2253{
2254 memcpy(state, plane->state, sizeof(*state));
2255
2256 if (state->fb)
2257 drm_framebuffer_reference(state->fb);
2258}
2259EXPORT_SYMBOL(__drm_atomic_helper_plane_duplicate_state);
2260
d461701c
DV
2261/**
2262 * drm_atomic_helper_plane_duplicate_state - default state duplicate hook
2263 * @plane: drm plane
2264 *
2265 * Default plane state duplicate hook for drivers which don't have their own
2266 * subclassed plane state structure.
2267 */
2268struct drm_plane_state *
2269drm_atomic_helper_plane_duplicate_state(struct drm_plane *plane)
2270{
321ebf04
DV
2271 struct drm_plane_state *state;
2272
d461701c
DV
2273 if (WARN_ON(!plane->state))
2274 return NULL;
2275
f5e7840b
TR
2276 state = kmalloc(sizeof(*state), GFP_KERNEL);
2277 if (state)
2278 __drm_atomic_helper_plane_duplicate_state(plane, state);
321ebf04
DV
2279
2280 return state;
d461701c
DV
2281}
2282EXPORT_SYMBOL(drm_atomic_helper_plane_duplicate_state);
2283
f5e7840b
TR
2284/**
2285 * __drm_atomic_helper_plane_destroy_state - release plane state
2286 * @plane: plane object
2287 * @state: plane state object to release
2288 *
2289 * Releases all resources stored in the plane state without actually freeing
2290 * the memory of the plane state. This is useful for drivers that subclass the
2291 * plane state.
2292 */
2293void __drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
2294 struct drm_plane_state *state)
2295{
2296 if (state->fb)
2297 drm_framebuffer_unreference(state->fb);
2298}
2299EXPORT_SYMBOL(__drm_atomic_helper_plane_destroy_state);
2300
d461701c
DV
2301/**
2302 * drm_atomic_helper_plane_destroy_state - default state destroy hook
2303 * @plane: drm plane
2304 * @state: plane state object to release
2305 *
2306 * Default plane state destroy hook for drivers which don't have their own
2307 * subclassed plane state structure.
2308 */
2309void drm_atomic_helper_plane_destroy_state(struct drm_plane *plane,
321ebf04 2310 struct drm_plane_state *state)
d461701c 2311{
f5e7840b 2312 __drm_atomic_helper_plane_destroy_state(plane, state);
d461701c
DV
2313 kfree(state);
2314}
2315EXPORT_SYMBOL(drm_atomic_helper_plane_destroy_state);
2316
2317/**
2318 * drm_atomic_helper_connector_reset - default ->reset hook for connectors
2319 * @connector: drm connector
2320 *
2321 * Resets the atomic state for @connector by freeing the state pointer (which
2322 * might be NULL, e.g. at driver load time) and allocating a new empty state
2323 * object.
2324 */
2325void drm_atomic_helper_connector_reset(struct drm_connector *connector)
2326{
2327 kfree(connector->state);
2328 connector->state = kzalloc(sizeof(*connector->state), GFP_KERNEL);
07cc0ef6
DV
2329
2330 if (connector->state)
2331 connector->state->connector = connector;
d461701c
DV
2332}
2333EXPORT_SYMBOL(drm_atomic_helper_connector_reset);
2334
f5e7840b
TR
2335/**
2336 * __drm_atomic_helper_connector_duplicate_state - copy atomic connector state
2337 * @connector: connector object
2338 * @state: atomic connector state
2339 *
2340 * Copies atomic state from a connector's current state. This is useful for
2341 * drivers that subclass the connector state.
2342 */
2343void
2344__drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector,
2345 struct drm_connector_state *state)
2346{
2347 memcpy(state, connector->state, sizeof(*state));
2348}
2349EXPORT_SYMBOL(__drm_atomic_helper_connector_duplicate_state);
2350
d461701c
DV
2351/**
2352 * drm_atomic_helper_connector_duplicate_state - default state duplicate hook
2353 * @connector: drm connector
2354 *
2355 * Default connector state duplicate hook for drivers which don't have their own
2356 * subclassed connector state structure.
2357 */
2358struct drm_connector_state *
2359drm_atomic_helper_connector_duplicate_state(struct drm_connector *connector)
2360{
f5e7840b
TR
2361 struct drm_connector_state *state;
2362
d461701c
DV
2363 if (WARN_ON(!connector->state))
2364 return NULL;
2365
f5e7840b
TR
2366 state = kmalloc(sizeof(*state), GFP_KERNEL);
2367 if (state)
2368 __drm_atomic_helper_connector_duplicate_state(connector, state);
2369
2370 return state;
d461701c
DV
2371}
2372EXPORT_SYMBOL(drm_atomic_helper_connector_duplicate_state);
2373
f5e7840b
TR
2374/**
2375 * __drm_atomic_helper_connector_destroy_state - release connector state
2376 * @connector: connector object
2377 * @state: connector state object to release
2378 *
2379 * Releases all resources stored in the connector state without actually
2380 * freeing the memory of the connector state. This is useful for drivers that
2381 * subclass the connector state.
2382 */
2383void
2384__drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2385 struct drm_connector_state *state)
2386{
2387 /*
2388 * This is currently a placeholder so that drivers that subclass the
2389 * state will automatically do the right thing if code is ever added
2390 * to this function.
2391 */
2392}
2393EXPORT_SYMBOL(__drm_atomic_helper_connector_destroy_state);
2394
d461701c
DV
2395/**
2396 * drm_atomic_helper_connector_destroy_state - default state destroy hook
2397 * @connector: drm connector
2398 * @state: connector state object to release
2399 *
2400 * Default connector state destroy hook for drivers which don't have their own
2401 * subclassed connector state structure.
2402 */
2403void drm_atomic_helper_connector_destroy_state(struct drm_connector *connector,
2404 struct drm_connector_state *state)
2405{
f5e7840b 2406 __drm_atomic_helper_connector_destroy_state(connector, state);
d461701c
DV
2407 kfree(state);
2408}
2409EXPORT_SYMBOL(drm_atomic_helper_connector_destroy_state);