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