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