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