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