Merge tag 'for-linus-5.11-rc5-tag' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / drivers / gpu / drm / drm_crtc_helper.c
CommitLineData
f453ba04
DA
1/*
2 * Copyright (c) 2006-2008 Intel Corporation
3 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
4 *
5 * DRM core CRTC related functions
6 *
7 * Permission to use, copy, modify, distribute, and sell this software and its
8 * documentation for any purpose is hereby granted without fee, provided that
9 * the above copyright notice appear in all copies and that both that copyright
10 * notice and this permission notice appear in supporting documentation, and
11 * that the name of the copyright holders not be used in advertising or
12 * publicity pertaining to distribution of the software without specific,
13 * written prior permission. The copyright holders make no representations
14 * about the suitability of this software for any purpose. It is provided "as
15 * is" without express or implied warranty.
16 *
17 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
19 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
20 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
21 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
22 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
23 * OF THIS SOFTWARE.
24 *
25 * Authors:
26 * Keith Packard
27 * Eric Anholt <eric@anholt.net>
28 * Dave Airlie <airlied@linux.ie>
29 * Jesse Barnes <jesse.barnes@intel.com>
30 */
31
2d1a8a48 32#include <linux/export.h>
0500c04e 33#include <linux/kernel.h>
0603ba14 34#include <linux/moduleparam.h>
2d1a8a48 35
321ebf04 36#include <drm/drm_atomic.h>
0500c04e 37#include <drm/drm_atomic_helper.h>
72fdb40c 38#include <drm/drm_atomic_uapi.h>
ee68c743 39#include <drm/drm_bridge.h>
760285e7 40#include <drm/drm_crtc.h>
760285e7 41#include <drm/drm_crtc_helper.h>
0500c04e
SR
42#include <drm/drm_drv.h>
43#include <drm/drm_edid.h>
44#include <drm/drm_encoder.h>
760285e7 45#include <drm/drm_fb_helper.h>
0500c04e 46#include <drm/drm_fourcc.h>
2f324b42 47#include <drm/drm_plane_helper.h>
0500c04e
SR
48#include <drm/drm_print.h>
49#include <drm/drm_vblank.h>
f453ba04 50
8dc056ef
BG
51#include "drm_crtc_helper_internal.h"
52
3150c7d0
DV
53/**
54 * DOC: overview
55 *
56 * The CRTC modeset helper library provides a default set_config implementation
57 * in drm_crtc_helper_set_config(). Plus a few other convenience functions using
58 * the same callbacks which drivers can use to e.g. restore the modeset
59 * configuration on resume with drm_helper_resume_force_mode().
60 *
2be94971 61 * Note that this helper library doesn't track the current power state of CRTCs
6806cdf9
DV
62 * and encoders. It can call callbacks like &drm_encoder_helper_funcs.dpms even
63 * though the hardware is already in the desired state. This deficiency has been
64 * fixed in the atomic helpers.
2be94971 65 *
3150c7d0
DV
66 * The driver callbacks are mostly compatible with the atomic modeset helpers,
67 * except for the handling of the primary plane: Atomic helpers require that the
68 * primary plane is implemented as a real standalone plane and not directly tied
69 * to the CRTC state. For easier transition this library provides functions to
70 * implement the old semantics required by the CRTC helpers using the new plane
71 * and atomic helper callbacks.
72 *
73 * Drivers are strongly urged to convert to the atomic helpers (by way of first
74 * converting to the plane helpers). New drivers must not use these functions
75 * but need to implement the atomic interface instead, potentially using the
76 * atomic helpers for that.
092d01da
DV
77 *
78 * These legacy modeset helpers use the same function table structures as
79 * all other modesetting helpers. See the documentation for struct
ea0dd85a 80 * &drm_crtc_helper_funcs, &struct drm_encoder_helper_funcs and struct
092d01da 81 * &drm_connector_helper_funcs.
3150c7d0 82 */
92b6f89f 83
c9fb15f6
KP
84/**
85 * drm_helper_encoder_in_use - check if a given encoder is in use
86 * @encoder: encoder to check
87 *
3fcc42e0
DV
88 * Checks whether @encoder is with the current mode setting output configuration
89 * in use by any connector. This doesn't mean that it is actually enabled since
90 * the DPMS state is tracked separately.
c9fb15f6 91 *
3fcc42e0
DV
92 * Returns:
93 * True if @encoder is used, false otherwise.
c9fb15f6
KP
94 */
95bool drm_helper_encoder_in_use(struct drm_encoder *encoder)
96{
97 struct drm_connector *connector;
c36a3254 98 struct drm_connector_list_iter conn_iter;
c9fb15f6 99 struct drm_device *dev = encoder->dev;
62ff94a5 100
2b5ab0ee
DV
101 WARN_ON(drm_drv_uses_atomic_modeset(dev));
102
ba6f5826
SA
103 /*
104 * We can expect this mutex to be locked if we are not panicking.
105 * Locking is currently fubar in the panic handler.
106 */
8d4ad9d4 107 if (!oops_in_progress) {
ba6f5826 108 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
8d4ad9d4
DA
109 WARN_ON(!drm_modeset_is_locked(&dev->mode_config.connection_mutex));
110 }
ba6f5826 111
c36a3254 112
b982dab1 113 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254
DV
114 drm_for_each_connector_iter(connector, &conn_iter) {
115 if (connector->encoder == encoder) {
b982dab1 116 drm_connector_list_iter_end(&conn_iter);
c9fb15f6 117 return true;
c36a3254
DV
118 }
119 }
b982dab1 120 drm_connector_list_iter_end(&conn_iter);
c9fb15f6
KP
121 return false;
122}
123EXPORT_SYMBOL(drm_helper_encoder_in_use);
124
f453ba04
DA
125/**
126 * drm_helper_crtc_in_use - check if a given CRTC is in a mode_config
127 * @crtc: CRTC to check
128 *
3fcc42e0
DV
129 * Checks whether @crtc is with the current mode setting output configuration
130 * in use by any connector. This doesn't mean that it is actually enabled since
131 * the DPMS state is tracked separately.
f453ba04 132 *
3fcc42e0
DV
133 * Returns:
134 * True if @crtc is used, false otherwise.
f453ba04
DA
135 */
136bool drm_helper_crtc_in_use(struct drm_crtc *crtc)
137{
138 struct drm_encoder *encoder;
139 struct drm_device *dev = crtc->dev;
62ff94a5 140
2b5ab0ee
DV
141 WARN_ON(drm_drv_uses_atomic_modeset(dev));
142
ba6f5826
SA
143 /*
144 * We can expect this mutex to be locked if we are not panicking.
145 * Locking is currently fubar in the panic handler.
146 */
147 if (!oops_in_progress)
148 WARN_ON(!mutex_is_locked(&dev->mode_config.mutex));
149
e4f62546 150 drm_for_each_encoder(encoder, dev)
c9fb15f6 151 if (encoder->crtc == crtc && drm_helper_encoder_in_use(encoder))
f453ba04
DA
152 return true;
153 return false;
154}
155EXPORT_SYMBOL(drm_helper_crtc_in_use);
156
86a1b9d1
BS
157static void
158drm_encoder_disable(struct drm_encoder *encoder)
159{
be26a66d 160 const struct drm_encoder_helper_funcs *encoder_funcs = encoder->helper_private;
86a1b9d1 161
75229eca
NT
162 if (!encoder_funcs)
163 return;
164
86a1b9d1
BS
165 if (encoder_funcs->disable)
166 (*encoder_funcs->disable)(encoder);
75229eca 167 else if (encoder_funcs->dpms)
86a1b9d1
BS
168 (*encoder_funcs->dpms)(encoder, DRM_MODE_DPMS_OFF);
169}
170
b182cc59 171static void __drm_helper_disable_unused_functions(struct drm_device *dev)
f453ba04
DA
172{
173 struct drm_encoder *encoder;
f453ba04
DA
174 struct drm_crtc *crtc;
175
62ff94a5
DV
176 drm_warn_on_modeset_not_all_locked(dev);
177
6295d607 178 drm_for_each_encoder(encoder, dev) {
92971021 179 if (!drm_helper_encoder_in_use(encoder)) {
86a1b9d1 180 drm_encoder_disable(encoder);
b5e6c1da 181 /* disconnect encoder from any connector */
9c552dd7 182 encoder->crtc = NULL;
a3a0544b 183 }
f453ba04
DA
184 }
185
6295d607 186 drm_for_each_crtc(crtc, dev) {
be26a66d 187 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
948de842 188
f453ba04
DA
189 crtc->enabled = drm_helper_crtc_in_use(crtc);
190 if (!crtc->enabled) {
5c8d7171
AD
191 if (crtc_funcs->disable)
192 (*crtc_funcs->disable)(crtc);
193 else
194 (*crtc_funcs->dpms)(crtc, DRM_MODE_DPMS_OFF);
f4510a27 195 crtc->primary->fb = NULL;
f453ba04
DA
196 }
197 }
198}
b182cc59
DV
199
200/**
201 * drm_helper_disable_unused_functions - disable unused objects
202 * @dev: DRM device
203 *
204 * This function walks through the entire mode setting configuration of @dev. It
2be94971
DV
205 * will remove any CRTC links of unused encoders and encoder links of
206 * disconnected connectors. Then it will disable all unused encoders and CRTCs
b182cc59
DV
207 * either by calling their disable callback if available or by calling their
208 * dpms callback with DRM_MODE_DPMS_OFF.
09859d2a
DV
209 *
210 * NOTE:
211 *
212 * This function is part of the legacy modeset helper library and will cause
213 * major confusion with atomic drivers. This is because atomic helpers guarantee
214 * to never call ->disable() hooks on a disabled function, or ->enable() hooks
215 * on an enabled functions. drm_helper_disable_unused_functions() on the other
216 * hand throws such guarantees into the wind and calls disable hooks
217 * unconditionally on unused functions.
b182cc59
DV
218 */
219void drm_helper_disable_unused_functions(struct drm_device *dev)
220{
2b5ab0ee 221 WARN_ON(drm_drv_uses_atomic_modeset(dev));
6605ca0f 222
b182cc59
DV
223 drm_modeset_lock_all(dev);
224 __drm_helper_disable_unused_functions(dev);
225 drm_modeset_unlock_all(dev);
226}
f453ba04
DA
227EXPORT_SYMBOL(drm_helper_disable_unused_functions);
228
7bec756c
JB
229/*
230 * Check the CRTC we're going to map each output to vs. its current
231 * CRTC. If they don't match, we have to disable the output and the CRTC
232 * since the driver will have to re-route things.
233 */
234static void
235drm_crtc_prepare_encoders(struct drm_device *dev)
236{
be26a66d 237 const struct drm_encoder_helper_funcs *encoder_funcs;
7bec756c
JB
238 struct drm_encoder *encoder;
239
6295d607 240 drm_for_each_encoder(encoder, dev) {
7bec756c 241 encoder_funcs = encoder->helper_private;
75229eca
NT
242 if (!encoder_funcs)
243 continue;
244
7bec756c
JB
245 /* Disable unused encoders */
246 if (encoder->crtc == NULL)
86a1b9d1 247 drm_encoder_disable(encoder);
7bec756c
JB
248 }
249}
250
f453ba04 251/**
0d4ed4c8 252 * drm_crtc_helper_set_mode - internal helper to set a mode
f453ba04
DA
253 * @crtc: CRTC to program
254 * @mode: mode to use
4c9287c6
AD
255 * @x: horizontal offset into the surface
256 * @y: vertical offset into the surface
0d4ed4c8 257 * @old_fb: old framebuffer, for cleanup
f453ba04 258 *
f453ba04 259 * Try to set @mode on @crtc. Give @crtc and its associated connectors a chance
0d4ed4c8
DV
260 * to fixup or reject the mode prior to trying to set it. This is an internal
261 * helper that drivers could e.g. use to update properties that require the
262 * entire output pipe to be disabled and re-enabled in a new configuration. For
263 * example for changing whether audio is enabled on a hdmi link or for changing
264 * panel fitter or dither attributes. It is also called by the
265 * drm_crtc_helper_set_config() helper function to drive the mode setting
266 * sequence.
f453ba04 267 *
3fcc42e0
DV
268 * Returns:
269 * True if the mode was set successfully, false otherwise.
f453ba04
DA
270 */
271bool drm_crtc_helper_set_mode(struct drm_crtc *crtc,
272 struct drm_display_mode *mode,
3c4fdcfb
KH
273 int x, int y,
274 struct drm_framebuffer *old_fb)
f453ba04
DA
275{
276 struct drm_device *dev = crtc->dev;
5a27528a 277 struct drm_display_mode *adjusted_mode, saved_mode, saved_hwmode;
be26a66d
JN
278 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
279 const struct drm_encoder_helper_funcs *encoder_funcs;
f453ba04 280 int saved_x, saved_y;
7e99acdc 281 bool saved_enabled;
f453ba04
DA
282 struct drm_encoder *encoder;
283 bool ret = true;
284
2b5ab0ee
DV
285 WARN_ON(drm_drv_uses_atomic_modeset(dev));
286
62ff94a5
DV
287 drm_warn_on_modeset_not_all_locked(dev);
288
7e99acdc 289 saved_enabled = crtc->enabled;
f453ba04 290 crtc->enabled = drm_helper_crtc_in_use(crtc);
f453ba04
DA
291 if (!crtc->enabled)
292 return true;
293
021a8455 294 adjusted_mode = drm_mode_duplicate(dev, mode);
7e99acdc
IH
295 if (!adjusted_mode) {
296 crtc->enabled = saved_enabled;
6bfc56aa 297 return false;
7e99acdc 298 }
021a8455 299
f453ba04 300 saved_mode = crtc->mode;
5a27528a 301 saved_hwmode = crtc->hwmode;
f453ba04
DA
302 saved_x = crtc->x;
303 saved_y = crtc->y;
304
305 /* Update crtc values up front so the driver can rely on them for mode
306 * setting.
307 */
308 crtc->mode = *mode;
309 crtc->x = x;
310 crtc->y = y;
311
f453ba04
DA
312 /* Pass our mode to the connectors and the CRTC to give them a chance to
313 * adjust it according to limitations or connector properties, and also
314 * a chance to reject the mode entirely.
315 */
6295d607 316 drm_for_each_encoder(encoder, dev) {
f453ba04
DA
317
318 if (encoder->crtc != crtc)
319 continue;
3b336ec4 320
75229eca
NT
321 encoder_funcs = encoder->helper_private;
322 if (!encoder_funcs)
323 continue;
324
f453ba04 325 encoder_funcs = encoder->helper_private;
3c5b2673
CP
326 if (encoder_funcs->mode_fixup) {
327 if (!(ret = encoder_funcs->mode_fixup(encoder, mode,
328 adjusted_mode))) {
329 DRM_DEBUG_KMS("Encoder fixup failed\n");
330 goto done;
331 }
f453ba04
DA
332 }
333 }
334
49f718c5
CP
335 if (crtc_funcs->mode_fixup) {
336 if (!(ret = crtc_funcs->mode_fixup(crtc, mode,
337 adjusted_mode))) {
338 DRM_DEBUG_KMS("CRTC fixup failed\n");
339 goto done;
340 }
f453ba04 341 }
fa3ab4c2 342 DRM_DEBUG_KMS("[CRTC:%d:%s]\n", crtc->base.id, crtc->name);
f453ba04 343
5a27528a
DS
344 crtc->hwmode = *adjusted_mode;
345
f453ba04 346 /* Prepare the encoders and CRTCs before setting the mode. */
6295d607 347 drm_for_each_encoder(encoder, dev) {
f453ba04
DA
348
349 if (encoder->crtc != crtc)
350 continue;
3b336ec4 351
75229eca
NT
352 encoder_funcs = encoder->helper_private;
353 if (!encoder_funcs)
354 continue;
355
f453ba04 356 /* Disable the encoders as the first thing we do. */
75229eca
NT
357 if (encoder_funcs->prepare)
358 encoder_funcs->prepare(encoder);
f453ba04
DA
359 }
360
7bec756c
JB
361 drm_crtc_prepare_encoders(dev);
362
f453ba04
DA
363 crtc_funcs->prepare(crtc);
364
365 /* Set up the DPLL and any encoders state that needs to adjust or depend
366 * on the DPLL.
367 */
5c3b82e2
CW
368 ret = !crtc_funcs->mode_set(crtc, mode, adjusted_mode, x, y, old_fb);
369 if (!ret)
370 goto done;
f453ba04 371
6295d607 372 drm_for_each_encoder(encoder, dev) {
f453ba04
DA
373
374 if (encoder->crtc != crtc)
375 continue;
376
75229eca
NT
377 encoder_funcs = encoder->helper_private;
378 if (!encoder_funcs)
379 continue;
380
0e691bc7
SM
381 DRM_DEBUG_KMS("[ENCODER:%d:%s] set [MODE:%s]\n",
382 encoder->base.id, encoder->name, mode->name);
75229eca
NT
383 if (encoder_funcs->mode_set)
384 encoder_funcs->mode_set(encoder, mode, adjusted_mode);
f453ba04
DA
385 }
386
387 /* Now enable the clocks, plane, pipe, and connectors that we set up. */
388 crtc_funcs->commit(crtc);
389
6295d607 390 drm_for_each_encoder(encoder, dev) {
f453ba04
DA
391
392 if (encoder->crtc != crtc)
393 continue;
394
75229eca
NT
395 encoder_funcs = encoder->helper_private;
396 if (!encoder_funcs)
397 continue;
398
75229eca
NT
399 if (encoder_funcs->commit)
400 encoder_funcs->commit(encoder);
f453ba04
DA
401 }
402
27641c3f
MK
403 /* Calculate and store various constants which
404 * are later needed by vblank and swap-completion
405 * timestamping. They are derived from true hwmode.
406 */
545cdd55 407 drm_calc_timestamping_constants(crtc, &crtc->hwmode);
27641c3f 408
f453ba04
DA
409 /* FIXME: add subpixel order */
410done:
021a8455 411 drm_mode_destroy(dev, adjusted_mode);
f453ba04 412 if (!ret) {
7e99acdc 413 crtc->enabled = saved_enabled;
f453ba04 414 crtc->mode = saved_mode;
5a27528a 415 crtc->hwmode = saved_hwmode;
f453ba04
DA
416 crtc->x = saved_x;
417 crtc->y = saved_y;
418 }
419
420 return ret;
421}
422EXPORT_SYMBOL(drm_crtc_helper_set_mode);
423
a74591d7 424static void
6eebd6bb
CW
425drm_crtc_helper_disable(struct drm_crtc *crtc)
426{
427 struct drm_device *dev = crtc->dev;
428 struct drm_connector *connector;
429 struct drm_encoder *encoder;
430
431 /* Decouple all encoders and their attached connectors from this crtc */
6295d607 432 drm_for_each_encoder(encoder, dev) {
c36a3254
DV
433 struct drm_connector_list_iter conn_iter;
434
6eebd6bb
CW
435 if (encoder->crtc != crtc)
436 continue;
437
b982dab1 438 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 439 drm_for_each_connector_iter(connector, &conn_iter) {
6eebd6bb
CW
440 if (connector->encoder != encoder)
441 continue;
442
443 connector->encoder = NULL;
a6ad6230
TR
444
445 /*
446 * drm_helper_disable_unused_functions() ought to be
447 * doing this, but since we've decoupled the encoder
448 * from the connector above, the required connection
449 * between them is henceforth no longer available.
450 */
451 connector->dpms = DRM_MODE_DPMS_OFF;
0955c125
DA
452
453 /* we keep a reference while the encoder is bound */
ad093607 454 drm_connector_put(connector);
6eebd6bb 455 }
b982dab1 456 drm_connector_list_iter_end(&conn_iter);
6eebd6bb
CW
457 }
458
b182cc59 459 __drm_helper_disable_unused_functions(dev);
6eebd6bb
CW
460}
461
a92462d6
JRS
462/*
463 * For connectors that support multiple encoders, either the
464 * .atomic_best_encoder() or .best_encoder() operation must be implemented.
465 */
466struct drm_encoder *
467drm_connector_get_single_encoder(struct drm_connector *connector)
468{
62afb4ad
JRS
469 struct drm_encoder *encoder;
470
471 WARN_ON(hweight32(connector->possible_encoders) > 1);
472 drm_connector_for_each_possible_encoder(connector, encoder)
473 return encoder;
474
475 return NULL;
a92462d6
JRS
476}
477
f453ba04
DA
478/**
479 * drm_crtc_helper_set_config - set a new config from userspace
0d4ed4c8 480 * @set: mode set configuration
a4eff9aa 481 * @ctx: lock acquire context, not used here
f453ba04 482 *
6806cdf9
DV
483 * The drm_crtc_helper_set_config() helper function implements the of
484 * &drm_crtc_funcs.set_config callback for drivers using the legacy CRTC
485 * helpers.
2be94971
DV
486 *
487 * It first tries to locate the best encoder for each connector by calling the
6806cdf9 488 * connector @drm_connector_helper_funcs.best_encoder helper operation.
2be94971
DV
489 *
490 * After locating the appropriate encoders, the helper function will call the
491 * mode_fixup encoder and CRTC helper operations to adjust the requested mode,
492 * or reject it completely in which case an error will be returned to the
493 * application. If the new configuration after mode adjustment is identical to
494 * the current configuration the helper function will return without performing
495 * any other operation.
496 *
497 * If the adjusted mode is identical to the current mode but changes to the
498 * frame buffer need to be applied, the drm_crtc_helper_set_config() function
6806cdf9 499 * will call the CRTC &drm_crtc_helper_funcs.mode_set_base helper operation.
2be94971
DV
500 *
501 * If the adjusted mode differs from the current mode, or if the
502 * ->mode_set_base() helper operation is not provided, the helper function
503 * performs a full mode set sequence by calling the ->prepare(), ->mode_set()
504 * and ->commit() CRTC and encoder helper operations, in that order.
505 * Alternatively it can also use the dpms and disable helper operations. For
ea0dd85a 506 * details see &struct drm_crtc_helper_funcs and struct
2be94971
DV
507 * &drm_encoder_helper_funcs.
508 *
509 * This function is deprecated. New drivers must implement atomic modeset
510 * support, for which this function is unsuitable. Instead drivers should use
511 * drm_atomic_helper_set_config().
f453ba04 512 *
3fcc42e0
DV
513 * Returns:
514 * Returns 0 on success, negative errno numbers on failure.
f453ba04 515 */
a4eff9aa
DV
516int drm_crtc_helper_set_config(struct drm_mode_set *set,
517 struct drm_modeset_acquire_ctx *ctx)
f453ba04
DA
518{
519 struct drm_device *dev;
93f55972
PZ
520 struct drm_crtc **save_encoder_crtcs, *new_crtc;
521 struct drm_encoder **save_connector_encoders, *new_encoder, *encoder;
4cb72b17
JB
522 bool mode_changed = false; /* if true do a full mode set */
523 bool fb_changed = false; /* if true and !mode_changed just do a flip */
93f55972 524 struct drm_connector *connector;
c36a3254 525 struct drm_connector_list_iter conn_iter;
f453ba04 526 int count = 0, ro, fail = 0;
be26a66d 527 const struct drm_crtc_helper_funcs *crtc_funcs;
c5006cfe 528 struct drm_mode_set save_set;
4a1b0714 529 int ret;
bf9dc102 530 int i;
f453ba04 531
58367ed6 532 DRM_DEBUG_KMS("\n");
f453ba04 533
e58de880
DV
534 BUG_ON(!set);
535 BUG_ON(!set->crtc);
536 BUG_ON(!set->crtc->helper_private);
f453ba04 537
e58de880
DV
538 /* Enforce sane interface api - has been abused by the fb helper. */
539 BUG_ON(!set->mode && set->fb);
540 BUG_ON(set->fb && set->num_connectors == 0);
f453ba04
DA
541
542 crtc_funcs = set->crtc->helper_private;
543
2b5ab0ee
DV
544 dev = set->crtc->dev;
545 WARN_ON(drm_drv_uses_atomic_modeset(dev));
546
ede3ff52
CW
547 if (!set->mode)
548 set->fb = NULL;
549
9440106b 550 if (set->fb) {
fa3ab4c2
VS
551 DRM_DEBUG_KMS("[CRTC:%d:%s] [FB:%d] #connectors=%d (x y) (%i %i)\n",
552 set->crtc->base.id, set->crtc->name,
553 set->fb->base.id,
554 (int)set->num_connectors, set->x, set->y);
9440106b 555 } else {
fa3ab4c2
VS
556 DRM_DEBUG_KMS("[CRTC:%d:%s] [NOFB]\n",
557 set->crtc->base.id, set->crtc->name);
a74591d7
TR
558 drm_crtc_helper_disable(set->crtc);
559 return 0;
9440106b 560 }
f453ba04 561
62ff94a5
DV
562 drm_warn_on_modeset_not_all_locked(dev);
563
02ee4e94
IH
564 /*
565 * Allocate space for the backup of all (non-pointer) encoder and
566 * connector data.
567 */
4b947b1c 568 save_encoder_crtcs = kcalloc(dev->mode_config.num_encoder,
93f55972
PZ
569 sizeof(struct drm_crtc *), GFP_KERNEL);
570 if (!save_encoder_crtcs)
f453ba04 571 return -ENOMEM;
f453ba04 572
4b947b1c 573 save_connector_encoders = kcalloc(dev->mode_config.num_connector,
93f55972
PZ
574 sizeof(struct drm_encoder *), GFP_KERNEL);
575 if (!save_connector_encoders) {
576 kfree(save_encoder_crtcs);
e67aae79
MM
577 return -ENOMEM;
578 }
579
02ee4e94
IH
580 /*
581 * Copy data. Note that driver private data is not affected.
e67aae79
MM
582 * Should anything bad happen only the expected state is
583 * restored, not the drivers personal bookkeeping.
584 */
e67aae79 585 count = 0;
6295d607 586 drm_for_each_encoder(encoder, dev) {
93f55972 587 save_encoder_crtcs[count++] = encoder->crtc;
e67aae79
MM
588 }
589
590 count = 0;
b982dab1 591 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 592 drm_for_each_connector_iter(connector, &conn_iter)
93f55972 593 save_connector_encoders[count++] = connector->encoder;
b982dab1 594 drm_connector_list_iter_end(&conn_iter);
e67aae79 595
c5006cfe
JB
596 save_set.crtc = set->crtc;
597 save_set.mode = &set->crtc->mode;
598 save_set.x = set->crtc->x;
599 save_set.y = set->crtc->y;
f4510a27 600 save_set.fb = set->crtc->primary->fb;
c5006cfe 601
f453ba04
DA
602 /* We should be able to check here if the fb has the same properties
603 * and then just flip_or_move it */
f4510a27 604 if (set->crtc->primary->fb != set->fb) {
712531bf 605 /* If we have no fb then treat it as a full mode set */
f4510a27 606 if (set->crtc->primary->fb == NULL) {
58367ed6 607 DRM_DEBUG_KMS("crtc has no fb, full mode set\n");
712531bf 608 mode_changed = true;
dbd4d576 609 } else if (set->fb->format != set->crtc->primary->fb->format) {
ce83adf7 610 mode_changed = true;
8dff4742 611 } else
712531bf 612 fb_changed = true;
f453ba04
DA
613 }
614
615 if (set->x != set->crtc->x || set->y != set->crtc->y)
712531bf 616 fb_changed = true;
f453ba04 617
2deafc7e 618 if (!drm_mode_equal(set->mode, &set->crtc->mode)) {
58367ed6 619 DRM_DEBUG_KMS("modes are different, full mode set\n");
f453ba04
DA
620 drm_mode_debug_printmodeline(&set->crtc->mode);
621 drm_mode_debug_printmodeline(set->mode);
712531bf 622 mode_changed = true;
f453ba04
DA
623 }
624
fffc5f59
PZ
625 /* take a reference on all unbound connectors in set, reuse the
626 * already taken reference for bound connectors
627 */
0955c125 628 for (ro = 0; ro < set->num_connectors; ro++) {
fffc5f59
PZ
629 if (set->connectors[ro]->encoder)
630 continue;
ad093607 631 drm_connector_get(set->connectors[ro]);
0955c125
DA
632 }
633
f453ba04
DA
634 /* a) traverse passed in connector list and get encoders for them */
635 count = 0;
b982dab1 636 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 637 drm_for_each_connector_iter(connector, &conn_iter) {
be26a66d 638 const struct drm_connector_helper_funcs *connector_funcs =
f453ba04 639 connector->helper_private;
f453ba04
DA
640 new_encoder = connector->encoder;
641 for (ro = 0; ro < set->num_connectors; ro++) {
642 if (set->connectors[ro] == connector) {
a92462d6
JRS
643 if (connector_funcs->best_encoder)
644 new_encoder = connector_funcs->best_encoder(connector);
645 else
646 new_encoder = drm_connector_get_single_encoder(connector);
647
f453ba04
DA
648 /* if we can't get an encoder for a connector
649 we are setting now - then fail */
650 if (new_encoder == NULL)
651 /* don't break so fail path works correct */
652 fail = 1;
25f397a4
DV
653
654 if (connector->dpms != DRM_MODE_DPMS_ON) {
655 DRM_DEBUG_KMS("connector dpms not on, full mode switch\n");
656 mode_changed = true;
657 }
177cf92d
DV
658
659 break;
f453ba04
DA
660 }
661 }
662
663 if (new_encoder != connector->encoder) {
58367ed6 664 DRM_DEBUG_KMS("encoder changed, full mode switch\n");
712531bf 665 mode_changed = true;
ff846ab7
MM
666 /* If the encoder is reused for another connector, then
667 * the appropriate crtc will be set later.
668 */
ff6fdbed
MM
669 if (connector->encoder)
670 connector->encoder->crtc = NULL;
f453ba04
DA
671 connector->encoder = new_encoder;
672 }
673 }
b982dab1 674 drm_connector_list_iter_end(&conn_iter);
f453ba04
DA
675
676 if (fail) {
677 ret = -EINVAL;
e67aae79 678 goto fail;
f453ba04
DA
679 }
680
681 count = 0;
b982dab1 682 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 683 drm_for_each_connector_iter(connector, &conn_iter) {
f453ba04
DA
684 if (!connector->encoder)
685 continue;
686
f453ba04
DA
687 if (connector->encoder->crtc == set->crtc)
688 new_crtc = NULL;
689 else
690 new_crtc = connector->encoder->crtc;
691
692 for (ro = 0; ro < set->num_connectors; ro++) {
693 if (set->connectors[ro] == connector)
694 new_crtc = set->crtc;
695 }
7bec756c
JB
696
697 /* Make sure the new CRTC will work with the encoder */
698 if (new_crtc &&
699 !drm_encoder_crtc_ok(connector->encoder, new_crtc)) {
700 ret = -EINVAL;
b982dab1 701 drm_connector_list_iter_end(&conn_iter);
e67aae79 702 goto fail;
7bec756c 703 }
f453ba04 704 if (new_crtc != connector->encoder->crtc) {
58367ed6 705 DRM_DEBUG_KMS("crtc changed, full mode switch\n");
712531bf 706 mode_changed = true;
f453ba04
DA
707 connector->encoder->crtc = new_crtc;
708 }
9440106b 709 if (new_crtc) {
fa3ab4c2
VS
710 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [CRTC:%d:%s]\n",
711 connector->base.id, connector->name,
712 new_crtc->base.id, new_crtc->name);
9440106b
JG
713 } else {
714 DRM_DEBUG_KMS("[CONNECTOR:%d:%s] to [NOCRTC]\n",
fa3ab4c2 715 connector->base.id, connector->name);
9440106b 716 }
f453ba04 717 }
b982dab1 718 drm_connector_list_iter_end(&conn_iter);
f453ba04
DA
719
720 /* mode_set_base is not a required function */
712531bf
JB
721 if (fb_changed && !crtc_funcs->mode_set_base)
722 mode_changed = true;
f453ba04 723
712531bf 724 if (mode_changed) {
48b1f5dd 725 if (drm_helper_crtc_in_use(set->crtc)) {
58367ed6
ZY
726 DRM_DEBUG_KMS("attempting to set mode from"
727 " userspace\n");
f453ba04 728 drm_mode_debug_printmodeline(set->mode);
f4510a27 729 set->crtc->primary->fb = set->fb;
f453ba04 730 if (!drm_crtc_helper_set_mode(set->crtc, set->mode,
3c4fdcfb 731 set->x, set->y,
bec2eac3 732 save_set.fb)) {
fa3ab4c2
VS
733 DRM_ERROR("failed to set mode on [CRTC:%d:%s]\n",
734 set->crtc->base.id, set->crtc->name);
f4510a27 735 set->crtc->primary->fb = save_set.fb;
f453ba04 736 ret = -EINVAL;
e67aae79 737 goto fail;
f453ba04 738 }
25f397a4
DV
739 DRM_DEBUG_KMS("Setting connector DPMS state to on\n");
740 for (i = 0; i < set->num_connectors; i++) {
741 DRM_DEBUG_KMS("\t[CONNECTOR:%d:%s] set DPMS on\n", set->connectors[i]->base.id,
25933820 742 set->connectors[i]->name);
25f397a4
DV
743 set->connectors[i]->funcs->dpms(set->connectors[i], DRM_MODE_DPMS_ON);
744 }
f453ba04 745 }
b182cc59 746 __drm_helper_disable_unused_functions(dev);
712531bf 747 } else if (fb_changed) {
9b1596af
BS
748 set->crtc->x = set->x;
749 set->crtc->y = set->y;
f4510a27 750 set->crtc->primary->fb = set->fb;
5c3b82e2 751 ret = crtc_funcs->mode_set_base(set->crtc,
bec2eac3 752 set->x, set->y, save_set.fb);
0ba41e44 753 if (ret != 0) {
fbce4064
IH
754 set->crtc->x = save_set.x;
755 set->crtc->y = save_set.y;
f4510a27 756 set->crtc->primary->fb = save_set.fb;
e67aae79 757 goto fail;
0ba41e44 758 }
f453ba04
DA
759 }
760
93f55972
PZ
761 kfree(save_connector_encoders);
762 kfree(save_encoder_crtcs);
f453ba04
DA
763 return 0;
764
e67aae79
MM
765fail:
766 /* Restore all previous data. */
e67aae79 767 count = 0;
6295d607 768 drm_for_each_encoder(encoder, dev) {
93f55972 769 encoder->crtc = save_encoder_crtcs[count++];
e62fb64e 770 }
e67aae79 771
f453ba04 772 count = 0;
b982dab1 773 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 774 drm_for_each_connector_iter(connector, &conn_iter)
93f55972 775 connector->encoder = save_connector_encoders[count++];
b982dab1 776 drm_connector_list_iter_end(&conn_iter);
e67aae79 777
fffc5f59
PZ
778 /* after fail drop reference on all unbound connectors in set, let
779 * bound connectors keep their reference
780 */
0955c125 781 for (ro = 0; ro < set->num_connectors; ro++) {
fffc5f59
PZ
782 if (set->connectors[ro]->encoder)
783 continue;
ad093607 784 drm_connector_put(set->connectors[ro]);
0955c125
DA
785 }
786
c5006cfe
JB
787 /* Try to restore the config */
788 if (mode_changed &&
789 !drm_crtc_helper_set_mode(save_set.crtc, save_set.mode, save_set.x,
790 save_set.y, save_set.fb))
791 DRM_ERROR("failed to restore config after modeset failure\n");
792
93f55972
PZ
793 kfree(save_connector_encoders);
794 kfree(save_encoder_crtcs);
f453ba04
DA
795 return ret;
796}
797EXPORT_SYMBOL(drm_crtc_helper_set_config);
798
c9fb15f6
KP
799static int drm_helper_choose_encoder_dpms(struct drm_encoder *encoder)
800{
801 int dpms = DRM_MODE_DPMS_OFF;
802 struct drm_connector *connector;
c36a3254 803 struct drm_connector_list_iter conn_iter;
c9fb15f6
KP
804 struct drm_device *dev = encoder->dev;
805
b982dab1 806 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 807 drm_for_each_connector_iter(connector, &conn_iter)
c9fb15f6
KP
808 if (connector->encoder == encoder)
809 if (connector->dpms < dpms)
810 dpms = connector->dpms;
b982dab1 811 drm_connector_list_iter_end(&conn_iter);
c36a3254 812
c9fb15f6
KP
813 return dpms;
814}
815
3b336ec4
SP
816/* Helper which handles bridge ordering around encoder dpms */
817static void drm_helper_encoder_dpms(struct drm_encoder *encoder, int mode)
818{
be26a66d 819 const struct drm_encoder_helper_funcs *encoder_funcs;
3b336ec4 820
75229eca
NT
821 encoder_funcs = encoder->helper_private;
822 if (!encoder_funcs)
823 return;
824
3b336ec4
SP
825 if (encoder_funcs->dpms)
826 encoder_funcs->dpms(encoder, mode);
3b336ec4
SP
827}
828
c9fb15f6
KP
829static int drm_helper_choose_crtc_dpms(struct drm_crtc *crtc)
830{
831 int dpms = DRM_MODE_DPMS_OFF;
832 struct drm_connector *connector;
c36a3254 833 struct drm_connector_list_iter conn_iter;
c9fb15f6
KP
834 struct drm_device *dev = crtc->dev;
835
b982dab1 836 drm_connector_list_iter_begin(dev, &conn_iter);
c36a3254 837 drm_for_each_connector_iter(connector, &conn_iter)
c9fb15f6
KP
838 if (connector->encoder && connector->encoder->crtc == crtc)
839 if (connector->dpms < dpms)
840 dpms = connector->dpms;
b982dab1 841 drm_connector_list_iter_end(&conn_iter);
c36a3254 842
c9fb15f6
KP
843 return dpms;
844}
845
846/**
0d4ed4c8
DV
847 * drm_helper_connector_dpms() - connector dpms helper implementation
848 * @connector: affected connector
849 * @mode: DPMS mode
c9fb15f6 850 *
6806cdf9
DV
851 * The drm_helper_connector_dpms() helper function implements the
852 * &drm_connector_funcs.dpms callback for drivers using the legacy CRTC
853 * helpers.
2be94971
DV
854 *
855 * This is the main helper function provided by the CRTC helper framework for
0d4ed4c8 856 * implementing the DPMS connector attribute. It computes the new desired DPMS
6806cdf9
DV
857 * state for all encoders and CRTCs in the output mesh and calls the
858 * &drm_crtc_helper_funcs.dpms and &drm_encoder_helper_funcs.dpms callbacks
859 * provided by the driver.
2be94971
DV
860 *
861 * This function is deprecated. New drivers must implement atomic modeset
144a7999 862 * support, where DPMS is handled in the DRM core.
9a69a9ac
ML
863 *
864 * Returns:
865 * Always returns 0.
c9fb15f6 866 */
9a69a9ac 867int drm_helper_connector_dpms(struct drm_connector *connector, int mode)
c9fb15f6
KP
868{
869 struct drm_encoder *encoder = connector->encoder;
870 struct drm_crtc *crtc = encoder ? encoder->crtc : NULL;
3b336ec4 871 int old_dpms, encoder_dpms = DRM_MODE_DPMS_OFF;
c9fb15f6 872
2b5ab0ee
DV
873 WARN_ON(drm_drv_uses_atomic_modeset(connector->dev));
874
c9fb15f6 875 if (mode == connector->dpms)
9a69a9ac 876 return 0;
c9fb15f6
KP
877
878 old_dpms = connector->dpms;
879 connector->dpms = mode;
880
3b336ec4
SP
881 if (encoder)
882 encoder_dpms = drm_helper_choose_encoder_dpms(encoder);
883
c9fb15f6
KP
884 /* from off to on, do crtc then encoder */
885 if (mode < old_dpms) {
886 if (crtc) {
be26a66d 887 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
948de842 888
c9fb15f6
KP
889 if (crtc_funcs->dpms)
890 (*crtc_funcs->dpms) (crtc,
891 drm_helper_choose_crtc_dpms(crtc));
892 }
3b336ec4
SP
893 if (encoder)
894 drm_helper_encoder_dpms(encoder, encoder_dpms);
c9fb15f6
KP
895 }
896
897 /* from on to off, do encoder then crtc */
898 if (mode > old_dpms) {
3b336ec4
SP
899 if (encoder)
900 drm_helper_encoder_dpms(encoder, encoder_dpms);
c9fb15f6 901 if (crtc) {
be26a66d 902 const struct drm_crtc_helper_funcs *crtc_funcs = crtc->helper_private;
948de842 903
c9fb15f6
KP
904 if (crtc_funcs->dpms)
905 (*crtc_funcs->dpms) (crtc,
906 drm_helper_choose_crtc_dpms(crtc));
907 }
908 }
909
9a69a9ac 910 return 0;
c9fb15f6
KP
911}
912EXPORT_SYMBOL(drm_helper_connector_dpms);
913
aa4cd910
DV
914/**
915 * drm_helper_resume_force_mode - force-restore mode setting configuration
916 * @dev: drm_device which should be restored
917 *
918 * Drivers which use the mode setting helpers can use this function to
919 * force-restore the mode setting configuration e.g. on resume or when something
920 * else might have trampled over the hw state (like some overzealous old BIOSen
921 * tended to do).
00d762cb
DV
922 *
923 * This helper doesn't provide a error return value since restoring the old
924 * config should never fail due to resource allocation issues since the driver
925 * has successfully set the restored configuration already. Hence this should
926 * boil down to the equivalent of a few dpms on calls, which also don't provide
927 * an error code.
928 *
929 * Drivers where simply restoring an old configuration again might fail (e.g.
930 * due to slight differences in allocating shared resources when the
931 * configuration is restored in a different order than when userspace set it up)
932 * need to use their own restore logic.
14942760
TR
933 *
934 * This function is deprecated. New drivers should implement atomic mode-
935 * setting and use the atomic suspend/resume helpers.
936 *
937 * See also:
938 * drm_atomic_helper_suspend(), drm_atomic_helper_resume()
aa4cd910 939 */
00d762cb 940void drm_helper_resume_force_mode(struct drm_device *dev)
f453ba04
DA
941{
942 struct drm_crtc *crtc;
89347bb8 943 struct drm_encoder *encoder;
be26a66d 944 const struct drm_crtc_helper_funcs *crtc_funcs;
00d762cb
DV
945 int encoder_dpms;
946 bool ret;
f453ba04 947
2b5ab0ee
DV
948 WARN_ON(drm_drv_uses_atomic_modeset(dev));
949
3ea87855 950 drm_modeset_lock_all(dev);
6295d607 951 drm_for_each_crtc(crtc, dev) {
f453ba04
DA
952
953 if (!crtc->enabled)
954 continue;
955
3c4fdcfb 956 ret = drm_crtc_helper_set_mode(crtc, &crtc->mode,
f4510a27 957 crtc->x, crtc->y, crtc->primary->fb);
f453ba04 958
00d762cb 959 /* Restoring the old config should never fail! */
f453ba04
DA
960 if (ret == false)
961 DRM_ERROR("failed to set mode on crtc %p\n", crtc);
89347bb8
DJ
962
963 /* Turn off outputs that were already powered off */
964 if (drm_helper_choose_crtc_dpms(crtc)) {
6295d607 965 drm_for_each_encoder(encoder, dev) {
89347bb8
DJ
966
967 if(encoder->crtc != crtc)
968 continue;
969
3b336ec4
SP
970 encoder_dpms = drm_helper_choose_encoder_dpms(
971 encoder);
972
973 drm_helper_encoder_dpms(encoder, encoder_dpms);
89347bb8 974 }
817e631e
CW
975
976 crtc_funcs = crtc->helper_private;
977 if (crtc_funcs->dpms)
978 (*crtc_funcs->dpms) (crtc,
979 drm_helper_choose_crtc_dpms(crtc));
89347bb8 980 }
f453ba04 981 }
00d762cb 982
af4fcb57 983 /* disable the unused connectors while restoring the modesetting */
b182cc59 984 __drm_helper_disable_unused_functions(dev);
3ea87855 985 drm_modeset_unlock_all(dev);
f453ba04
DA
986}
987EXPORT_SYMBOL(drm_helper_resume_force_mode);
c2d88e06
DV
988
989/**
990 * drm_helper_force_disable_all - Forcibly turn off all enabled CRTCs
991 * @dev: DRM device whose CRTCs to turn off
992 *
993 * Drivers may want to call this on unload to ensure that all displays are
994 * unlit and the GPU is in a consistent, low power state. Takes modeset locks.
995 *
996 * Note: This should only be used by non-atomic legacy drivers. For an atomic
997 * version look at drm_atomic_helper_shutdown().
998 *
999 * Returns:
1000 * Zero on success, error code on failure.
1001 */
1002int drm_helper_force_disable_all(struct drm_device *dev)
1003{
1004 struct drm_crtc *crtc;
1005 int ret = 0;
1006
1007 drm_modeset_lock_all(dev);
1008 drm_for_each_crtc(crtc, dev)
1009 if (crtc->enabled) {
1010 struct drm_mode_set set = {
1011 .crtc = crtc,
1012 };
1013
1014 ret = drm_mode_set_config_internal(&set);
1015 if (ret)
1016 goto out;
1017 }
1018out:
1019 drm_modeset_unlock_all(dev);
1020 return ret;
1021}
1022EXPORT_SYMBOL(drm_helper_force_disable_all);