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