xref: /openbmc/linux/drivers/gpu/drm/drm_fb_helper.c (revision 8e694cd2)
1 /*
2  * Copyright (c) 2006-2009 Red Hat Inc.
3  * Copyright (c) 2006-2008 Intel Corporation
4  * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5  *
6  * DRM framebuffer helper functions
7  *
8  * Permission to use, copy, modify, distribute, and sell this software and its
9  * documentation for any purpose is hereby granted without fee, provided that
10  * the above copyright notice appear in all copies and that both that copyright
11  * notice and this permission notice appear in supporting documentation, and
12  * that the name of the copyright holders not be used in advertising or
13  * publicity pertaining to distribution of the software without specific,
14  * written prior permission.  The copyright holders make no representations
15  * about the suitability of this software for any purpose.  It is provided "as
16  * is" without express or implied warranty.
17  *
18  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24  * OF THIS SOFTWARE.
25  *
26  * Authors:
27  *      Dave Airlie <airlied@linux.ie>
28  *      Jesse Barnes <jesse.barnes@intel.com>
29  */
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31 
32 #include <linux/kernel.h>
33 #include <linux/sysrq.h>
34 #include <linux/slab.h>
35 #include <linux/fb.h>
36 #include <linux/module.h>
37 #include <drm/drmP.h>
38 #include <drm/drm_crtc.h>
39 #include <drm/drm_fb_helper.h>
40 #include <drm/drm_crtc_helper.h>
41 #include <drm/drm_atomic.h>
42 #include <drm/drm_atomic_helper.h>
43 
44 static bool drm_fbdev_emulation = true;
45 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
46 MODULE_PARM_DESC(fbdev_emulation,
47 		 "Enable legacy fbdev emulation [default=true]");
48 
49 static LIST_HEAD(kernel_fb_helper_list);
50 
51 /**
52  * DOC: fbdev helpers
53  *
54  * The fb helper functions are useful to provide an fbdev on top of a drm kernel
55  * mode setting driver. They can be used mostly independently from the crtc
56  * helper functions used by many drivers to implement the kernel mode setting
57  * interfaces.
58  *
59  * Initialization is done as a four-step process with drm_fb_helper_prepare(),
60  * drm_fb_helper_init(), drm_fb_helper_single_add_all_connectors() and
61  * drm_fb_helper_initial_config(). Drivers with fancier requirements than the
62  * default behaviour can override the third step with their own code.
63  * Teardown is done with drm_fb_helper_fini().
64  *
65  * At runtime drivers should restore the fbdev console by calling
66  * drm_fb_helper_restore_fbdev_mode_unlocked() from their ->lastclose callback.
67  * They should also notify the fb helper code from updates to the output
68  * configuration by calling drm_fb_helper_hotplug_event(). For easier
69  * integration with the output polling code in drm_crtc_helper.c the modeset
70  * code provides a ->output_poll_changed callback.
71  *
72  * All other functions exported by the fb helper library can be used to
73  * implement the fbdev driver interface by the driver.
74  *
75  * It is possible, though perhaps somewhat tricky, to implement race-free
76  * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
77  * helper must be called first to initialize the minimum required to make
78  * hotplug detection work. Drivers also need to make sure to properly set up
79  * the dev->mode_config.funcs member. After calling drm_kms_helper_poll_init()
80  * it is safe to enable interrupts and start processing hotplug events. At the
81  * same time, drivers should initialize all modeset objects such as CRTCs,
82  * encoders and connectors. To finish up the fbdev helper initialization, the
83  * drm_fb_helper_init() function is called. To probe for all attached displays
84  * and set up an initial configuration using the detected hardware, drivers
85  * should call drm_fb_helper_single_add_all_connectors() followed by
86  * drm_fb_helper_initial_config().
87  *
88  * If &drm_framebuffer_funcs ->dirty is set, the
89  * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
90  * accumulate changes and schedule &drm_fb_helper ->dirty_work to run right
91  * away. This worker then calls the dirty() function ensuring that it will
92  * always run in process context since the fb_*() function could be running in
93  * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
94  * callback it will also schedule dirty_work with the damage collected from the
95  * mmap page writes.
96  */
97 
98 /**
99  * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
100  * 					       emulation helper
101  * @fb_helper: fbdev initialized with drm_fb_helper_init
102  *
103  * This functions adds all the available connectors for use with the given
104  * fb_helper. This is a separate step to allow drivers to freely assign
105  * connectors to the fbdev, e.g. if some are reserved for special purposes or
106  * not adequate to be used for the fbcon.
107  *
108  * This function is protected against concurrent connector hotadds/removals
109  * using drm_fb_helper_add_one_connector() and
110  * drm_fb_helper_remove_one_connector().
111  */
112 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
113 {
114 	struct drm_device *dev = fb_helper->dev;
115 	struct drm_connector *connector;
116 	int i, ret;
117 
118 	if (!drm_fbdev_emulation)
119 		return 0;
120 
121 	mutex_lock(&dev->mode_config.mutex);
122 	drm_for_each_connector(connector, dev) {
123 		ret = drm_fb_helper_add_one_connector(fb_helper, connector);
124 
125 		if (ret)
126 			goto fail;
127 	}
128 	mutex_unlock(&dev->mode_config.mutex);
129 	return 0;
130 fail:
131 	for (i = 0; i < fb_helper->connector_count; i++) {
132 		kfree(fb_helper->connector_info[i]);
133 		fb_helper->connector_info[i] = NULL;
134 	}
135 	fb_helper->connector_count = 0;
136 	mutex_unlock(&dev->mode_config.mutex);
137 
138 	return ret;
139 }
140 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
141 
142 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
143 {
144 	struct drm_fb_helper_connector **temp;
145 	struct drm_fb_helper_connector *fb_helper_connector;
146 
147 	if (!drm_fbdev_emulation)
148 		return 0;
149 
150 	WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
151 	if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
152 		temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
153 		if (!temp)
154 			return -ENOMEM;
155 
156 		fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
157 		fb_helper->connector_info = temp;
158 	}
159 
160 
161 	fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
162 	if (!fb_helper_connector)
163 		return -ENOMEM;
164 
165 	drm_connector_reference(connector);
166 	fb_helper_connector->connector = connector;
167 	fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
168 	return 0;
169 }
170 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
171 
172 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
173 				       struct drm_connector *connector)
174 {
175 	struct drm_fb_helper_connector *fb_helper_connector;
176 	int i, j;
177 
178 	if (!drm_fbdev_emulation)
179 		return 0;
180 
181 	WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
182 
183 	for (i = 0; i < fb_helper->connector_count; i++) {
184 		if (fb_helper->connector_info[i]->connector == connector)
185 			break;
186 	}
187 
188 	if (i == fb_helper->connector_count)
189 		return -EINVAL;
190 	fb_helper_connector = fb_helper->connector_info[i];
191 	drm_connector_unreference(fb_helper_connector->connector);
192 
193 	for (j = i + 1; j < fb_helper->connector_count; j++) {
194 		fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
195 	}
196 	fb_helper->connector_count--;
197 	kfree(fb_helper_connector);
198 
199 	return 0;
200 }
201 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
202 
203 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
204 {
205 	uint16_t *r_base, *g_base, *b_base;
206 	int i;
207 
208 	if (helper->funcs->gamma_get == NULL)
209 		return;
210 
211 	r_base = crtc->gamma_store;
212 	g_base = r_base + crtc->gamma_size;
213 	b_base = g_base + crtc->gamma_size;
214 
215 	for (i = 0; i < crtc->gamma_size; i++)
216 		helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
217 }
218 
219 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
220 {
221 	uint16_t *r_base, *g_base, *b_base;
222 
223 	if (crtc->funcs->gamma_set == NULL)
224 		return;
225 
226 	r_base = crtc->gamma_store;
227 	g_base = r_base + crtc->gamma_size;
228 	b_base = g_base + crtc->gamma_size;
229 
230 	crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
231 }
232 
233 /**
234  * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
235  * @info: fbdev registered by the helper
236  */
237 int drm_fb_helper_debug_enter(struct fb_info *info)
238 {
239 	struct drm_fb_helper *helper = info->par;
240 	const struct drm_crtc_helper_funcs *funcs;
241 	int i;
242 
243 	list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
244 		for (i = 0; i < helper->crtc_count; i++) {
245 			struct drm_mode_set *mode_set =
246 				&helper->crtc_info[i].mode_set;
247 
248 			if (!mode_set->crtc->enabled)
249 				continue;
250 
251 			funcs =	mode_set->crtc->helper_private;
252 			drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
253 			funcs->mode_set_base_atomic(mode_set->crtc,
254 						    mode_set->fb,
255 						    mode_set->x,
256 						    mode_set->y,
257 						    ENTER_ATOMIC_MODE_SET);
258 		}
259 	}
260 
261 	return 0;
262 }
263 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
264 
265 /* Find the real fb for a given fb helper CRTC */
266 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
267 {
268 	struct drm_device *dev = crtc->dev;
269 	struct drm_crtc *c;
270 
271 	drm_for_each_crtc(c, dev) {
272 		if (crtc->base.id == c->base.id)
273 			return c->primary->fb;
274 	}
275 
276 	return NULL;
277 }
278 
279 /**
280  * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
281  * @info: fbdev registered by the helper
282  */
283 int drm_fb_helper_debug_leave(struct fb_info *info)
284 {
285 	struct drm_fb_helper *helper = info->par;
286 	struct drm_crtc *crtc;
287 	const struct drm_crtc_helper_funcs *funcs;
288 	struct drm_framebuffer *fb;
289 	int i;
290 
291 	for (i = 0; i < helper->crtc_count; i++) {
292 		struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
293 		crtc = mode_set->crtc;
294 		funcs = crtc->helper_private;
295 		fb = drm_mode_config_fb(crtc);
296 
297 		if (!crtc->enabled)
298 			continue;
299 
300 		if (!fb) {
301 			DRM_ERROR("no fb to restore??\n");
302 			continue;
303 		}
304 
305 		drm_fb_helper_restore_lut_atomic(mode_set->crtc);
306 		funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
307 					    crtc->y, LEAVE_ATOMIC_MODE_SET);
308 	}
309 
310 	return 0;
311 }
312 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
313 
314 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper)
315 {
316 	struct drm_device *dev = fb_helper->dev;
317 	struct drm_plane *plane;
318 	struct drm_atomic_state *state;
319 	int i, ret;
320 	unsigned plane_mask;
321 
322 	state = drm_atomic_state_alloc(dev);
323 	if (!state)
324 		return -ENOMEM;
325 
326 	state->acquire_ctx = dev->mode_config.acquire_ctx;
327 retry:
328 	plane_mask = 0;
329 	drm_for_each_plane(plane, dev) {
330 		struct drm_plane_state *plane_state;
331 
332 		plane_state = drm_atomic_get_plane_state(state, plane);
333 		if (IS_ERR(plane_state)) {
334 			ret = PTR_ERR(plane_state);
335 			goto fail;
336 		}
337 
338 		plane_state->rotation = BIT(DRM_ROTATE_0);
339 
340 		plane->old_fb = plane->fb;
341 		plane_mask |= 1 << drm_plane_index(plane);
342 
343 		/* disable non-primary: */
344 		if (plane->type == DRM_PLANE_TYPE_PRIMARY)
345 			continue;
346 
347 		ret = __drm_atomic_helper_disable_plane(plane, plane_state);
348 		if (ret != 0)
349 			goto fail;
350 	}
351 
352 	for(i = 0; i < fb_helper->crtc_count; i++) {
353 		struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
354 
355 		ret = __drm_atomic_helper_set_config(mode_set, state);
356 		if (ret != 0)
357 			goto fail;
358 	}
359 
360 	ret = drm_atomic_commit(state);
361 
362 fail:
363 	drm_atomic_clean_old_fb(dev, plane_mask, ret);
364 
365 	if (ret == -EDEADLK)
366 		goto backoff;
367 
368 	if (ret != 0)
369 		drm_atomic_state_free(state);
370 
371 	return ret;
372 
373 backoff:
374 	drm_atomic_state_clear(state);
375 	drm_atomic_legacy_backoff(state);
376 
377 	goto retry;
378 }
379 
380 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
381 {
382 	struct drm_device *dev = fb_helper->dev;
383 	struct drm_plane *plane;
384 	int i;
385 
386 	drm_warn_on_modeset_not_all_locked(dev);
387 
388 	if (fb_helper->atomic)
389 		return restore_fbdev_mode_atomic(fb_helper);
390 
391 	drm_for_each_plane(plane, dev) {
392 		if (plane->type != DRM_PLANE_TYPE_PRIMARY)
393 			drm_plane_force_disable(plane);
394 
395 		if (dev->mode_config.rotation_property) {
396 			drm_mode_plane_set_obj_prop(plane,
397 						    dev->mode_config.rotation_property,
398 						    BIT(DRM_ROTATE_0));
399 		}
400 	}
401 
402 	for (i = 0; i < fb_helper->crtc_count; i++) {
403 		struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
404 		struct drm_crtc *crtc = mode_set->crtc;
405 		int ret;
406 
407 		if (crtc->funcs->cursor_set2) {
408 			ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
409 			if (ret)
410 				return ret;
411 		} else if (crtc->funcs->cursor_set) {
412 			ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
413 			if (ret)
414 				return ret;
415 		}
416 
417 		ret = drm_mode_set_config_internal(mode_set);
418 		if (ret)
419 			return ret;
420 	}
421 
422 	return 0;
423 }
424 
425 /**
426  * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
427  * @fb_helper: fbcon to restore
428  *
429  * This should be called from driver's drm ->lastclose callback
430  * when implementing an fbcon on top of kms using this helper. This ensures that
431  * the user isn't greeted with a black screen when e.g. X dies.
432  *
433  * RETURNS:
434  * Zero if everything went ok, negative error code otherwise.
435  */
436 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
437 {
438 	struct drm_device *dev = fb_helper->dev;
439 	bool do_delayed;
440 	int ret;
441 
442 	if (!drm_fbdev_emulation)
443 		return -ENODEV;
444 
445 	drm_modeset_lock_all(dev);
446 	ret = restore_fbdev_mode(fb_helper);
447 
448 	do_delayed = fb_helper->delayed_hotplug;
449 	if (do_delayed)
450 		fb_helper->delayed_hotplug = false;
451 	drm_modeset_unlock_all(dev);
452 
453 	if (do_delayed)
454 		drm_fb_helper_hotplug_event(fb_helper);
455 	return ret;
456 }
457 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
458 
459 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
460 {
461 	struct drm_device *dev = fb_helper->dev;
462 	struct drm_crtc *crtc;
463 	int bound = 0, crtcs_bound = 0;
464 
465 	/* Sometimes user space wants everything disabled, so don't steal the
466 	 * display if there's a master. */
467 	if (dev->primary->master)
468 		return false;
469 
470 	drm_for_each_crtc(crtc, dev) {
471 		if (crtc->primary->fb)
472 			crtcs_bound++;
473 		if (crtc->primary->fb == fb_helper->fb)
474 			bound++;
475 	}
476 
477 	if (bound < crtcs_bound)
478 		return false;
479 
480 	return true;
481 }
482 
483 #ifdef CONFIG_MAGIC_SYSRQ
484 /*
485  * restore fbcon display for all kms driver's using this helper, used for sysrq
486  * and panic handling.
487  */
488 static bool drm_fb_helper_force_kernel_mode(void)
489 {
490 	bool ret, error = false;
491 	struct drm_fb_helper *helper;
492 
493 	if (list_empty(&kernel_fb_helper_list))
494 		return false;
495 
496 	list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
497 		struct drm_device *dev = helper->dev;
498 
499 		if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
500 			continue;
501 
502 		drm_modeset_lock_all(dev);
503 		ret = restore_fbdev_mode(helper);
504 		if (ret)
505 			error = true;
506 		drm_modeset_unlock_all(dev);
507 	}
508 	return error;
509 }
510 
511 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
512 {
513 	bool ret;
514 	ret = drm_fb_helper_force_kernel_mode();
515 	if (ret == true)
516 		DRM_ERROR("Failed to restore crtc configuration\n");
517 }
518 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
519 
520 static void drm_fb_helper_sysrq(int dummy1)
521 {
522 	schedule_work(&drm_fb_helper_restore_work);
523 }
524 
525 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
526 	.handler = drm_fb_helper_sysrq,
527 	.help_msg = "force-fb(V)",
528 	.action_msg = "Restore framebuffer console",
529 };
530 #else
531 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
532 #endif
533 
534 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
535 {
536 	struct drm_fb_helper *fb_helper = info->par;
537 	struct drm_device *dev = fb_helper->dev;
538 	struct drm_crtc *crtc;
539 	struct drm_connector *connector;
540 	int i, j;
541 
542 	/*
543 	 * For each CRTC in this fb, turn the connectors on/off.
544 	 */
545 	drm_modeset_lock_all(dev);
546 	if (!drm_fb_helper_is_bound(fb_helper)) {
547 		drm_modeset_unlock_all(dev);
548 		return;
549 	}
550 
551 	for (i = 0; i < fb_helper->crtc_count; i++) {
552 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
553 
554 		if (!crtc->enabled)
555 			continue;
556 
557 		/* Walk the connectors & encoders on this fb turning them on/off */
558 		for (j = 0; j < fb_helper->connector_count; j++) {
559 			connector = fb_helper->connector_info[j]->connector;
560 			connector->funcs->dpms(connector, dpms_mode);
561 			drm_object_property_set_value(&connector->base,
562 				dev->mode_config.dpms_property, dpms_mode);
563 		}
564 	}
565 	drm_modeset_unlock_all(dev);
566 }
567 
568 /**
569  * drm_fb_helper_blank - implementation for ->fb_blank
570  * @blank: desired blanking state
571  * @info: fbdev registered by the helper
572  */
573 int drm_fb_helper_blank(int blank, struct fb_info *info)
574 {
575 	if (oops_in_progress)
576 		return -EBUSY;
577 
578 	switch (blank) {
579 	/* Display: On; HSync: On, VSync: On */
580 	case FB_BLANK_UNBLANK:
581 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
582 		break;
583 	/* Display: Off; HSync: On, VSync: On */
584 	case FB_BLANK_NORMAL:
585 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
586 		break;
587 	/* Display: Off; HSync: Off, VSync: On */
588 	case FB_BLANK_HSYNC_SUSPEND:
589 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
590 		break;
591 	/* Display: Off; HSync: On, VSync: Off */
592 	case FB_BLANK_VSYNC_SUSPEND:
593 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
594 		break;
595 	/* Display: Off; HSync: Off, VSync: Off */
596 	case FB_BLANK_POWERDOWN:
597 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
598 		break;
599 	}
600 	return 0;
601 }
602 EXPORT_SYMBOL(drm_fb_helper_blank);
603 
604 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
605 {
606 	int i;
607 
608 	for (i = 0; i < helper->connector_count; i++) {
609 		drm_connector_unreference(helper->connector_info[i]->connector);
610 		kfree(helper->connector_info[i]);
611 	}
612 	kfree(helper->connector_info);
613 	for (i = 0; i < helper->crtc_count; i++) {
614 		kfree(helper->crtc_info[i].mode_set.connectors);
615 		if (helper->crtc_info[i].mode_set.mode)
616 			drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
617 	}
618 	kfree(helper->crtc_info);
619 }
620 
621 static void drm_fb_helper_dirty_work(struct work_struct *work)
622 {
623 	struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
624 						    dirty_work);
625 	struct drm_clip_rect *clip = &helper->dirty_clip;
626 	struct drm_clip_rect clip_copy;
627 	unsigned long flags;
628 
629 	spin_lock_irqsave(&helper->dirty_lock, flags);
630 	clip_copy = *clip;
631 	clip->x1 = clip->y1 = ~0;
632 	clip->x2 = clip->y2 = 0;
633 	spin_unlock_irqrestore(&helper->dirty_lock, flags);
634 
635 	helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
636 }
637 
638 /**
639  * drm_fb_helper_prepare - setup a drm_fb_helper structure
640  * @dev: DRM device
641  * @helper: driver-allocated fbdev helper structure to set up
642  * @funcs: pointer to structure of functions associate with this helper
643  *
644  * Sets up the bare minimum to make the framebuffer helper usable. This is
645  * useful to implement race-free initialization of the polling helpers.
646  */
647 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
648 			   const struct drm_fb_helper_funcs *funcs)
649 {
650 	INIT_LIST_HEAD(&helper->kernel_fb_list);
651 	spin_lock_init(&helper->dirty_lock);
652 	INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
653 	helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
654 	helper->funcs = funcs;
655 	helper->dev = dev;
656 }
657 EXPORT_SYMBOL(drm_fb_helper_prepare);
658 
659 /**
660  * drm_fb_helper_init - initialize a drm_fb_helper structure
661  * @dev: drm device
662  * @fb_helper: driver-allocated fbdev helper structure to initialize
663  * @crtc_count: maximum number of crtcs to support in this fbdev emulation
664  * @max_conn_count: max connector count
665  *
666  * This allocates the structures for the fbdev helper with the given limits.
667  * Note that this won't yet touch the hardware (through the driver interfaces)
668  * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
669  * to allow driver writes more control over the exact init sequence.
670  *
671  * Drivers must call drm_fb_helper_prepare() before calling this function.
672  *
673  * RETURNS:
674  * Zero if everything went ok, nonzero otherwise.
675  */
676 int drm_fb_helper_init(struct drm_device *dev,
677 		       struct drm_fb_helper *fb_helper,
678 		       int crtc_count, int max_conn_count)
679 {
680 	struct drm_crtc *crtc;
681 	int i;
682 
683 	if (!drm_fbdev_emulation)
684 		return 0;
685 
686 	if (!max_conn_count)
687 		return -EINVAL;
688 
689 	fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
690 	if (!fb_helper->crtc_info)
691 		return -ENOMEM;
692 
693 	fb_helper->crtc_count = crtc_count;
694 	fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
695 	if (!fb_helper->connector_info) {
696 		kfree(fb_helper->crtc_info);
697 		return -ENOMEM;
698 	}
699 	fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
700 	fb_helper->connector_count = 0;
701 
702 	for (i = 0; i < crtc_count; i++) {
703 		fb_helper->crtc_info[i].mode_set.connectors =
704 			kcalloc(max_conn_count,
705 				sizeof(struct drm_connector *),
706 				GFP_KERNEL);
707 
708 		if (!fb_helper->crtc_info[i].mode_set.connectors)
709 			goto out_free;
710 		fb_helper->crtc_info[i].mode_set.num_connectors = 0;
711 	}
712 
713 	i = 0;
714 	drm_for_each_crtc(crtc, dev) {
715 		fb_helper->crtc_info[i].mode_set.crtc = crtc;
716 		i++;
717 	}
718 
719 	fb_helper->atomic = !!drm_core_check_feature(dev, DRIVER_ATOMIC);
720 
721 	return 0;
722 out_free:
723 	drm_fb_helper_crtc_free(fb_helper);
724 	return -ENOMEM;
725 }
726 EXPORT_SYMBOL(drm_fb_helper_init);
727 
728 /**
729  * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
730  * @fb_helper: driver-allocated fbdev helper
731  *
732  * A helper to alloc fb_info and the members cmap and apertures. Called
733  * by the driver within the fb_probe fb_helper callback function.
734  *
735  * RETURNS:
736  * fb_info pointer if things went okay, pointer containing error code
737  * otherwise
738  */
739 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
740 {
741 	struct device *dev = fb_helper->dev->dev;
742 	struct fb_info *info;
743 	int ret;
744 
745 	info = framebuffer_alloc(0, dev);
746 	if (!info)
747 		return ERR_PTR(-ENOMEM);
748 
749 	ret = fb_alloc_cmap(&info->cmap, 256, 0);
750 	if (ret)
751 		goto err_release;
752 
753 	info->apertures = alloc_apertures(1);
754 	if (!info->apertures) {
755 		ret = -ENOMEM;
756 		goto err_free_cmap;
757 	}
758 
759 	fb_helper->fbdev = info;
760 
761 	return info;
762 
763 err_free_cmap:
764 	fb_dealloc_cmap(&info->cmap);
765 err_release:
766 	framebuffer_release(info);
767 	return ERR_PTR(ret);
768 }
769 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
770 
771 /**
772  * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
773  * @fb_helper: driver-allocated fbdev helper
774  *
775  * A wrapper around unregister_framebuffer, to release the fb_info
776  * framebuffer device
777  */
778 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
779 {
780 	if (fb_helper && fb_helper->fbdev)
781 		unregister_framebuffer(fb_helper->fbdev);
782 }
783 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
784 
785 /**
786  * drm_fb_helper_release_fbi - dealloc fb_info and its members
787  * @fb_helper: driver-allocated fbdev helper
788  *
789  * A helper to free memory taken by fb_info and the members cmap and
790  * apertures
791  */
792 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
793 {
794 	if (fb_helper) {
795 		struct fb_info *info = fb_helper->fbdev;
796 
797 		if (info) {
798 			if (info->cmap.len)
799 				fb_dealloc_cmap(&info->cmap);
800 			framebuffer_release(info);
801 		}
802 
803 		fb_helper->fbdev = NULL;
804 	}
805 }
806 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
807 
808 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
809 {
810 	if (!drm_fbdev_emulation)
811 		return;
812 
813 	if (!list_empty(&fb_helper->kernel_fb_list)) {
814 		list_del(&fb_helper->kernel_fb_list);
815 		if (list_empty(&kernel_fb_helper_list)) {
816 			unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
817 		}
818 	}
819 
820 	drm_fb_helper_crtc_free(fb_helper);
821 
822 }
823 EXPORT_SYMBOL(drm_fb_helper_fini);
824 
825 /**
826  * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
827  * @fb_helper: driver-allocated fbdev helper
828  *
829  * A wrapper around unlink_framebuffer implemented by fbdev core
830  */
831 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
832 {
833 	if (fb_helper && fb_helper->fbdev)
834 		unlink_framebuffer(fb_helper->fbdev);
835 }
836 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
837 
838 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
839 				u32 width, u32 height)
840 {
841 	struct drm_fb_helper *helper = info->par;
842 	struct drm_clip_rect *clip = &helper->dirty_clip;
843 	unsigned long flags;
844 
845 	if (!helper->fb->funcs->dirty)
846 		return;
847 
848 	spin_lock_irqsave(&helper->dirty_lock, flags);
849 	clip->x1 = min_t(u32, clip->x1, x);
850 	clip->y1 = min_t(u32, clip->y1, y);
851 	clip->x2 = max_t(u32, clip->x2, x + width);
852 	clip->y2 = max_t(u32, clip->y2, y + height);
853 	spin_unlock_irqrestore(&helper->dirty_lock, flags);
854 
855 	schedule_work(&helper->dirty_work);
856 }
857 
858 /**
859  * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
860  * @info: fb_info struct pointer
861  * @pagelist: list of dirty mmap framebuffer pages
862  *
863  * This function is used as the &fb_deferred_io ->deferred_io
864  * callback function for flushing the fbdev mmap writes.
865  */
866 void drm_fb_helper_deferred_io(struct fb_info *info,
867 			       struct list_head *pagelist)
868 {
869 	unsigned long start, end, min, max;
870 	struct page *page;
871 	u32 y1, y2;
872 
873 	min = ULONG_MAX;
874 	max = 0;
875 	list_for_each_entry(page, pagelist, lru) {
876 		start = page->index << PAGE_SHIFT;
877 		end = start + PAGE_SIZE - 1;
878 		min = min(min, start);
879 		max = max(max, end);
880 	}
881 
882 	if (min < max) {
883 		y1 = min / info->fix.line_length;
884 		y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
885 			   info->var.yres);
886 		drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
887 	}
888 }
889 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
890 
891 /**
892  * drm_fb_helper_sys_read - wrapper around fb_sys_read
893  * @info: fb_info struct pointer
894  * @buf: userspace buffer to read from framebuffer memory
895  * @count: number of bytes to read from framebuffer memory
896  * @ppos: read offset within framebuffer memory
897  *
898  * A wrapper around fb_sys_read implemented by fbdev core
899  */
900 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
901 			       size_t count, loff_t *ppos)
902 {
903 	return fb_sys_read(info, buf, count, ppos);
904 }
905 EXPORT_SYMBOL(drm_fb_helper_sys_read);
906 
907 /**
908  * drm_fb_helper_sys_write - wrapper around fb_sys_write
909  * @info: fb_info struct pointer
910  * @buf: userspace buffer to write to framebuffer memory
911  * @count: number of bytes to write to framebuffer memory
912  * @ppos: write offset within framebuffer memory
913  *
914  * A wrapper around fb_sys_write implemented by fbdev core
915  */
916 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
917 				size_t count, loff_t *ppos)
918 {
919 	ssize_t ret;
920 
921 	ret = fb_sys_write(info, buf, count, ppos);
922 	if (ret > 0)
923 		drm_fb_helper_dirty(info, 0, 0, info->var.xres,
924 				    info->var.yres);
925 
926 	return ret;
927 }
928 EXPORT_SYMBOL(drm_fb_helper_sys_write);
929 
930 /**
931  * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
932  * @info: fbdev registered by the helper
933  * @rect: info about rectangle to fill
934  *
935  * A wrapper around sys_fillrect implemented by fbdev core
936  */
937 void drm_fb_helper_sys_fillrect(struct fb_info *info,
938 				const struct fb_fillrect *rect)
939 {
940 	sys_fillrect(info, rect);
941 	drm_fb_helper_dirty(info, rect->dx, rect->dy,
942 			    rect->width, rect->height);
943 }
944 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
945 
946 /**
947  * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
948  * @info: fbdev registered by the helper
949  * @area: info about area to copy
950  *
951  * A wrapper around sys_copyarea implemented by fbdev core
952  */
953 void drm_fb_helper_sys_copyarea(struct fb_info *info,
954 				const struct fb_copyarea *area)
955 {
956 	sys_copyarea(info, area);
957 	drm_fb_helper_dirty(info, area->dx, area->dy,
958 			    area->width, area->height);
959 }
960 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
961 
962 /**
963  * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
964  * @info: fbdev registered by the helper
965  * @image: info about image to blit
966  *
967  * A wrapper around sys_imageblit implemented by fbdev core
968  */
969 void drm_fb_helper_sys_imageblit(struct fb_info *info,
970 				 const struct fb_image *image)
971 {
972 	sys_imageblit(info, image);
973 	drm_fb_helper_dirty(info, image->dx, image->dy,
974 			    image->width, image->height);
975 }
976 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
977 
978 /**
979  * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
980  * @info: fbdev registered by the helper
981  * @rect: info about rectangle to fill
982  *
983  * A wrapper around cfb_imageblit implemented by fbdev core
984  */
985 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
986 				const struct fb_fillrect *rect)
987 {
988 	cfb_fillrect(info, rect);
989 	drm_fb_helper_dirty(info, rect->dx, rect->dy,
990 			    rect->width, rect->height);
991 }
992 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
993 
994 /**
995  * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
996  * @info: fbdev registered by the helper
997  * @area: info about area to copy
998  *
999  * A wrapper around cfb_copyarea implemented by fbdev core
1000  */
1001 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1002 				const struct fb_copyarea *area)
1003 {
1004 	cfb_copyarea(info, area);
1005 	drm_fb_helper_dirty(info, area->dx, area->dy,
1006 			    area->width, area->height);
1007 }
1008 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1009 
1010 /**
1011  * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1012  * @info: fbdev registered by the helper
1013  * @image: info about image to blit
1014  *
1015  * A wrapper around cfb_imageblit implemented by fbdev core
1016  */
1017 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1018 				 const struct fb_image *image)
1019 {
1020 	cfb_imageblit(info, image);
1021 	drm_fb_helper_dirty(info, image->dx, image->dy,
1022 			    image->width, image->height);
1023 }
1024 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1025 
1026 /**
1027  * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1028  * @fb_helper: driver-allocated fbdev helper
1029  * @state: desired state, zero to resume, non-zero to suspend
1030  *
1031  * A wrapper around fb_set_suspend implemented by fbdev core
1032  */
1033 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state)
1034 {
1035 	if (fb_helper && fb_helper->fbdev)
1036 		fb_set_suspend(fb_helper->fbdev, state);
1037 }
1038 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1039 
1040 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1041 		     u16 blue, u16 regno, struct fb_info *info)
1042 {
1043 	struct drm_fb_helper *fb_helper = info->par;
1044 	struct drm_framebuffer *fb = fb_helper->fb;
1045 	int pindex;
1046 
1047 	if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1048 		u32 *palette;
1049 		u32 value;
1050 		/* place color in psuedopalette */
1051 		if (regno > 16)
1052 			return -EINVAL;
1053 		palette = (u32 *)info->pseudo_palette;
1054 		red >>= (16 - info->var.red.length);
1055 		green >>= (16 - info->var.green.length);
1056 		blue >>= (16 - info->var.blue.length);
1057 		value = (red << info->var.red.offset) |
1058 			(green << info->var.green.offset) |
1059 			(blue << info->var.blue.offset);
1060 		if (info->var.transp.length > 0) {
1061 			u32 mask = (1 << info->var.transp.length) - 1;
1062 			mask <<= info->var.transp.offset;
1063 			value |= mask;
1064 		}
1065 		palette[regno] = value;
1066 		return 0;
1067 	}
1068 
1069 	/*
1070 	 * The driver really shouldn't advertise pseudo/directcolor
1071 	 * visuals if it can't deal with the palette.
1072 	 */
1073 	if (WARN_ON(!fb_helper->funcs->gamma_set ||
1074 		    !fb_helper->funcs->gamma_get))
1075 		return -EINVAL;
1076 
1077 	pindex = regno;
1078 
1079 	if (fb->bits_per_pixel == 16) {
1080 		pindex = regno << 3;
1081 
1082 		if (fb->depth == 16 && regno > 63)
1083 			return -EINVAL;
1084 		if (fb->depth == 15 && regno > 31)
1085 			return -EINVAL;
1086 
1087 		if (fb->depth == 16) {
1088 			u16 r, g, b;
1089 			int i;
1090 			if (regno < 32) {
1091 				for (i = 0; i < 8; i++)
1092 					fb_helper->funcs->gamma_set(crtc, red,
1093 						green, blue, pindex + i);
1094 			}
1095 
1096 			fb_helper->funcs->gamma_get(crtc, &r,
1097 						    &g, &b,
1098 						    pindex >> 1);
1099 
1100 			for (i = 0; i < 4; i++)
1101 				fb_helper->funcs->gamma_set(crtc, r,
1102 							    green, b,
1103 							    (pindex >> 1) + i);
1104 		}
1105 	}
1106 
1107 	if (fb->depth != 16)
1108 		fb_helper->funcs->gamma_set(crtc, red, green, blue, pindex);
1109 	return 0;
1110 }
1111 
1112 /**
1113  * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1114  * @cmap: cmap to set
1115  * @info: fbdev registered by the helper
1116  */
1117 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1118 {
1119 	struct drm_fb_helper *fb_helper = info->par;
1120 	struct drm_device *dev = fb_helper->dev;
1121 	const struct drm_crtc_helper_funcs *crtc_funcs;
1122 	u16 *red, *green, *blue, *transp;
1123 	struct drm_crtc *crtc;
1124 	int i, j, rc = 0;
1125 	int start;
1126 
1127 	if (oops_in_progress)
1128 		return -EBUSY;
1129 
1130 	drm_modeset_lock_all(dev);
1131 	if (!drm_fb_helper_is_bound(fb_helper)) {
1132 		drm_modeset_unlock_all(dev);
1133 		return -EBUSY;
1134 	}
1135 
1136 	for (i = 0; i < fb_helper->crtc_count; i++) {
1137 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
1138 		crtc_funcs = crtc->helper_private;
1139 
1140 		red = cmap->red;
1141 		green = cmap->green;
1142 		blue = cmap->blue;
1143 		transp = cmap->transp;
1144 		start = cmap->start;
1145 
1146 		for (j = 0; j < cmap->len; j++) {
1147 			u16 hred, hgreen, hblue, htransp = 0xffff;
1148 
1149 			hred = *red++;
1150 			hgreen = *green++;
1151 			hblue = *blue++;
1152 
1153 			if (transp)
1154 				htransp = *transp++;
1155 
1156 			rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1157 			if (rc)
1158 				goto out;
1159 		}
1160 		if (crtc_funcs->load_lut)
1161 			crtc_funcs->load_lut(crtc);
1162 	}
1163  out:
1164 	drm_modeset_unlock_all(dev);
1165 	return rc;
1166 }
1167 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1168 
1169 /**
1170  * drm_fb_helper_check_var - implementation for ->fb_check_var
1171  * @var: screeninfo to check
1172  * @info: fbdev registered by the helper
1173  */
1174 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1175 			    struct fb_info *info)
1176 {
1177 	struct drm_fb_helper *fb_helper = info->par;
1178 	struct drm_framebuffer *fb = fb_helper->fb;
1179 	int depth;
1180 
1181 	if (var->pixclock != 0 || in_dbg_master())
1182 		return -EINVAL;
1183 
1184 	/* Need to resize the fb object !!! */
1185 	if (var->bits_per_pixel > fb->bits_per_pixel ||
1186 	    var->xres > fb->width || var->yres > fb->height ||
1187 	    var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1188 		DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
1189 			  "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1190 			  var->xres, var->yres, var->bits_per_pixel,
1191 			  var->xres_virtual, var->yres_virtual,
1192 			  fb->width, fb->height, fb->bits_per_pixel);
1193 		return -EINVAL;
1194 	}
1195 
1196 	switch (var->bits_per_pixel) {
1197 	case 16:
1198 		depth = (var->green.length == 6) ? 16 : 15;
1199 		break;
1200 	case 32:
1201 		depth = (var->transp.length > 0) ? 32 : 24;
1202 		break;
1203 	default:
1204 		depth = var->bits_per_pixel;
1205 		break;
1206 	}
1207 
1208 	switch (depth) {
1209 	case 8:
1210 		var->red.offset = 0;
1211 		var->green.offset = 0;
1212 		var->blue.offset = 0;
1213 		var->red.length = 8;
1214 		var->green.length = 8;
1215 		var->blue.length = 8;
1216 		var->transp.length = 0;
1217 		var->transp.offset = 0;
1218 		break;
1219 	case 15:
1220 		var->red.offset = 10;
1221 		var->green.offset = 5;
1222 		var->blue.offset = 0;
1223 		var->red.length = 5;
1224 		var->green.length = 5;
1225 		var->blue.length = 5;
1226 		var->transp.length = 1;
1227 		var->transp.offset = 15;
1228 		break;
1229 	case 16:
1230 		var->red.offset = 11;
1231 		var->green.offset = 5;
1232 		var->blue.offset = 0;
1233 		var->red.length = 5;
1234 		var->green.length = 6;
1235 		var->blue.length = 5;
1236 		var->transp.length = 0;
1237 		var->transp.offset = 0;
1238 		break;
1239 	case 24:
1240 		var->red.offset = 16;
1241 		var->green.offset = 8;
1242 		var->blue.offset = 0;
1243 		var->red.length = 8;
1244 		var->green.length = 8;
1245 		var->blue.length = 8;
1246 		var->transp.length = 0;
1247 		var->transp.offset = 0;
1248 		break;
1249 	case 32:
1250 		var->red.offset = 16;
1251 		var->green.offset = 8;
1252 		var->blue.offset = 0;
1253 		var->red.length = 8;
1254 		var->green.length = 8;
1255 		var->blue.length = 8;
1256 		var->transp.length = 8;
1257 		var->transp.offset = 24;
1258 		break;
1259 	default:
1260 		return -EINVAL;
1261 	}
1262 	return 0;
1263 }
1264 EXPORT_SYMBOL(drm_fb_helper_check_var);
1265 
1266 /**
1267  * drm_fb_helper_set_par - implementation for ->fb_set_par
1268  * @info: fbdev registered by the helper
1269  *
1270  * This will let fbcon do the mode init and is called at initialization time by
1271  * the fbdev core when registering the driver, and later on through the hotplug
1272  * callback.
1273  */
1274 int drm_fb_helper_set_par(struct fb_info *info)
1275 {
1276 	struct drm_fb_helper *fb_helper = info->par;
1277 	struct fb_var_screeninfo *var = &info->var;
1278 
1279 	if (oops_in_progress)
1280 		return -EBUSY;
1281 
1282 	if (var->pixclock != 0) {
1283 		DRM_ERROR("PIXEL CLOCK SET\n");
1284 		return -EINVAL;
1285 	}
1286 
1287 	drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1288 
1289 	return 0;
1290 }
1291 EXPORT_SYMBOL(drm_fb_helper_set_par);
1292 
1293 static int pan_display_atomic(struct fb_var_screeninfo *var,
1294 			      struct fb_info *info)
1295 {
1296 	struct drm_fb_helper *fb_helper = info->par;
1297 	struct drm_device *dev = fb_helper->dev;
1298 	struct drm_atomic_state *state;
1299 	struct drm_plane *plane;
1300 	int i, ret;
1301 	unsigned plane_mask;
1302 
1303 	state = drm_atomic_state_alloc(dev);
1304 	if (!state)
1305 		return -ENOMEM;
1306 
1307 	state->acquire_ctx = dev->mode_config.acquire_ctx;
1308 retry:
1309 	plane_mask = 0;
1310 	for(i = 0; i < fb_helper->crtc_count; i++) {
1311 		struct drm_mode_set *mode_set;
1312 
1313 		mode_set = &fb_helper->crtc_info[i].mode_set;
1314 
1315 		mode_set->x = var->xoffset;
1316 		mode_set->y = var->yoffset;
1317 
1318 		ret = __drm_atomic_helper_set_config(mode_set, state);
1319 		if (ret != 0)
1320 			goto fail;
1321 
1322 		plane = mode_set->crtc->primary;
1323 		plane_mask |= (1 << drm_plane_index(plane));
1324 		plane->old_fb = plane->fb;
1325 	}
1326 
1327 	ret = drm_atomic_commit(state);
1328 	if (ret != 0)
1329 		goto fail;
1330 
1331 	info->var.xoffset = var->xoffset;
1332 	info->var.yoffset = var->yoffset;
1333 
1334 
1335 fail:
1336 	drm_atomic_clean_old_fb(dev, plane_mask, ret);
1337 
1338 	if (ret == -EDEADLK)
1339 		goto backoff;
1340 
1341 	if (ret != 0)
1342 		drm_atomic_state_free(state);
1343 
1344 	return ret;
1345 
1346 backoff:
1347 	drm_atomic_state_clear(state);
1348 	drm_atomic_legacy_backoff(state);
1349 
1350 	goto retry;
1351 }
1352 
1353 /**
1354  * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1355  * @var: updated screen information
1356  * @info: fbdev registered by the helper
1357  */
1358 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1359 			      struct fb_info *info)
1360 {
1361 	struct drm_fb_helper *fb_helper = info->par;
1362 	struct drm_device *dev = fb_helper->dev;
1363 	struct drm_mode_set *modeset;
1364 	int ret = 0;
1365 	int i;
1366 
1367 	if (oops_in_progress)
1368 		return -EBUSY;
1369 
1370 	drm_modeset_lock_all(dev);
1371 	if (!drm_fb_helper_is_bound(fb_helper)) {
1372 		drm_modeset_unlock_all(dev);
1373 		return -EBUSY;
1374 	}
1375 
1376 	if (fb_helper->atomic) {
1377 		ret = pan_display_atomic(var, info);
1378 		goto unlock;
1379 	}
1380 
1381 	for (i = 0; i < fb_helper->crtc_count; i++) {
1382 		modeset = &fb_helper->crtc_info[i].mode_set;
1383 
1384 		modeset->x = var->xoffset;
1385 		modeset->y = var->yoffset;
1386 
1387 		if (modeset->num_connectors) {
1388 			ret = drm_mode_set_config_internal(modeset);
1389 			if (!ret) {
1390 				info->var.xoffset = var->xoffset;
1391 				info->var.yoffset = var->yoffset;
1392 			}
1393 		}
1394 	}
1395 unlock:
1396 	drm_modeset_unlock_all(dev);
1397 	return ret;
1398 }
1399 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1400 
1401 /*
1402  * Allocates the backing storage and sets up the fbdev info structure through
1403  * the ->fb_probe callback and then registers the fbdev and sets up the panic
1404  * notifier.
1405  */
1406 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1407 					 int preferred_bpp)
1408 {
1409 	int ret = 0;
1410 	int crtc_count = 0;
1411 	int i;
1412 	struct fb_info *info;
1413 	struct drm_fb_helper_surface_size sizes;
1414 	int gamma_size = 0;
1415 
1416 	memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1417 	sizes.surface_depth = 24;
1418 	sizes.surface_bpp = 32;
1419 	sizes.fb_width = (unsigned)-1;
1420 	sizes.fb_height = (unsigned)-1;
1421 
1422 	/* if driver picks 8 or 16 by default use that
1423 	   for both depth/bpp */
1424 	if (preferred_bpp != sizes.surface_bpp)
1425 		sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1426 
1427 	/* first up get a count of crtcs now in use and new min/maxes width/heights */
1428 	for (i = 0; i < fb_helper->connector_count; i++) {
1429 		struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1430 		struct drm_cmdline_mode *cmdline_mode;
1431 
1432 		cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1433 
1434 		if (cmdline_mode->bpp_specified) {
1435 			switch (cmdline_mode->bpp) {
1436 			case 8:
1437 				sizes.surface_depth = sizes.surface_bpp = 8;
1438 				break;
1439 			case 15:
1440 				sizes.surface_depth = 15;
1441 				sizes.surface_bpp = 16;
1442 				break;
1443 			case 16:
1444 				sizes.surface_depth = sizes.surface_bpp = 16;
1445 				break;
1446 			case 24:
1447 				sizes.surface_depth = sizes.surface_bpp = 24;
1448 				break;
1449 			case 32:
1450 				sizes.surface_depth = 24;
1451 				sizes.surface_bpp = 32;
1452 				break;
1453 			}
1454 			break;
1455 		}
1456 	}
1457 
1458 	crtc_count = 0;
1459 	for (i = 0; i < fb_helper->crtc_count; i++) {
1460 		struct drm_display_mode *desired_mode;
1461 		struct drm_mode_set *mode_set;
1462 		int x, y, j;
1463 		/* in case of tile group, are we the last tile vert or horiz?
1464 		 * If no tile group you are always the last one both vertically
1465 		 * and horizontally
1466 		 */
1467 		bool lastv = true, lasth = true;
1468 
1469 		desired_mode = fb_helper->crtc_info[i].desired_mode;
1470 		mode_set = &fb_helper->crtc_info[i].mode_set;
1471 
1472 		if (!desired_mode)
1473 			continue;
1474 
1475 		crtc_count++;
1476 
1477 		x = fb_helper->crtc_info[i].x;
1478 		y = fb_helper->crtc_info[i].y;
1479 
1480 		if (gamma_size == 0)
1481 			gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1482 
1483 		sizes.surface_width  = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1484 		sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1485 
1486 		for (j = 0; j < mode_set->num_connectors; j++) {
1487 			struct drm_connector *connector = mode_set->connectors[j];
1488 			if (connector->has_tile) {
1489 				lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1490 				lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1491 				/* cloning to multiple tiles is just crazy-talk, so: */
1492 				break;
1493 			}
1494 		}
1495 
1496 		if (lasth)
1497 			sizes.fb_width  = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1498 		if (lastv)
1499 			sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1500 	}
1501 
1502 	if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1503 		/* hmm everyone went away - assume VGA cable just fell out
1504 		   and will come back later. */
1505 		DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1506 		sizes.fb_width = sizes.surface_width = 1024;
1507 		sizes.fb_height = sizes.surface_height = 768;
1508 	}
1509 
1510 	/* push down into drivers */
1511 	ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1512 	if (ret < 0)
1513 		return ret;
1514 
1515 	info = fb_helper->fbdev;
1516 
1517 	/*
1518 	 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1519 	 * events, but at init time drm_setup_crtcs needs to be called before
1520 	 * the fb is allocated (since we need to figure out the desired size of
1521 	 * the fb before we can allocate it ...). Hence we need to fix things up
1522 	 * here again.
1523 	 */
1524 	for (i = 0; i < fb_helper->crtc_count; i++)
1525 		if (fb_helper->crtc_info[i].mode_set.num_connectors)
1526 			fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1527 
1528 
1529 	info->var.pixclock = 0;
1530 	if (register_framebuffer(info) < 0)
1531 		return -EINVAL;
1532 
1533 	dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1534 			info->node, info->fix.id);
1535 
1536 	if (list_empty(&kernel_fb_helper_list)) {
1537 		register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1538 	}
1539 
1540 	list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1541 
1542 	return 0;
1543 }
1544 
1545 /**
1546  * drm_fb_helper_fill_fix - initializes fixed fbdev information
1547  * @info: fbdev registered by the helper
1548  * @pitch: desired pitch
1549  * @depth: desired depth
1550  *
1551  * Helper to fill in the fixed fbdev information useful for a non-accelerated
1552  * fbdev emulations. Drivers which support acceleration methods which impose
1553  * additional constraints need to set up their own limits.
1554  *
1555  * Drivers should call this (or their equivalent setup code) from their
1556  * ->fb_probe callback.
1557  */
1558 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1559 			    uint32_t depth)
1560 {
1561 	info->fix.type = FB_TYPE_PACKED_PIXELS;
1562 	info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1563 		FB_VISUAL_TRUECOLOR;
1564 	info->fix.mmio_start = 0;
1565 	info->fix.mmio_len = 0;
1566 	info->fix.type_aux = 0;
1567 	info->fix.xpanstep = 1; /* doing it in hw */
1568 	info->fix.ypanstep = 1; /* doing it in hw */
1569 	info->fix.ywrapstep = 0;
1570 	info->fix.accel = FB_ACCEL_NONE;
1571 
1572 	info->fix.line_length = pitch;
1573 	return;
1574 }
1575 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1576 
1577 /**
1578  * drm_fb_helper_fill_var - initalizes variable fbdev information
1579  * @info: fbdev instance to set up
1580  * @fb_helper: fb helper instance to use as template
1581  * @fb_width: desired fb width
1582  * @fb_height: desired fb height
1583  *
1584  * Sets up the variable fbdev metainformation from the given fb helper instance
1585  * and the drm framebuffer allocated in fb_helper->fb.
1586  *
1587  * Drivers should call this (or their equivalent setup code) from their
1588  * ->fb_probe callback after having allocated the fbdev backing
1589  * storage framebuffer.
1590  */
1591 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1592 			    uint32_t fb_width, uint32_t fb_height)
1593 {
1594 	struct drm_framebuffer *fb = fb_helper->fb;
1595 	info->pseudo_palette = fb_helper->pseudo_palette;
1596 	info->var.xres_virtual = fb->width;
1597 	info->var.yres_virtual = fb->height;
1598 	info->var.bits_per_pixel = fb->bits_per_pixel;
1599 	info->var.accel_flags = FB_ACCELF_TEXT;
1600 	info->var.xoffset = 0;
1601 	info->var.yoffset = 0;
1602 	info->var.activate = FB_ACTIVATE_NOW;
1603 	info->var.height = -1;
1604 	info->var.width = -1;
1605 
1606 	switch (fb->depth) {
1607 	case 8:
1608 		info->var.red.offset = 0;
1609 		info->var.green.offset = 0;
1610 		info->var.blue.offset = 0;
1611 		info->var.red.length = 8; /* 8bit DAC */
1612 		info->var.green.length = 8;
1613 		info->var.blue.length = 8;
1614 		info->var.transp.offset = 0;
1615 		info->var.transp.length = 0;
1616 		break;
1617 	case 15:
1618 		info->var.red.offset = 10;
1619 		info->var.green.offset = 5;
1620 		info->var.blue.offset = 0;
1621 		info->var.red.length = 5;
1622 		info->var.green.length = 5;
1623 		info->var.blue.length = 5;
1624 		info->var.transp.offset = 15;
1625 		info->var.transp.length = 1;
1626 		break;
1627 	case 16:
1628 		info->var.red.offset = 11;
1629 		info->var.green.offset = 5;
1630 		info->var.blue.offset = 0;
1631 		info->var.red.length = 5;
1632 		info->var.green.length = 6;
1633 		info->var.blue.length = 5;
1634 		info->var.transp.offset = 0;
1635 		break;
1636 	case 24:
1637 		info->var.red.offset = 16;
1638 		info->var.green.offset = 8;
1639 		info->var.blue.offset = 0;
1640 		info->var.red.length = 8;
1641 		info->var.green.length = 8;
1642 		info->var.blue.length = 8;
1643 		info->var.transp.offset = 0;
1644 		info->var.transp.length = 0;
1645 		break;
1646 	case 32:
1647 		info->var.red.offset = 16;
1648 		info->var.green.offset = 8;
1649 		info->var.blue.offset = 0;
1650 		info->var.red.length = 8;
1651 		info->var.green.length = 8;
1652 		info->var.blue.length = 8;
1653 		info->var.transp.offset = 24;
1654 		info->var.transp.length = 8;
1655 		break;
1656 	default:
1657 		break;
1658 	}
1659 
1660 	info->var.xres = fb_width;
1661 	info->var.yres = fb_height;
1662 }
1663 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1664 
1665 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1666 					       uint32_t maxX,
1667 					       uint32_t maxY)
1668 {
1669 	struct drm_connector *connector;
1670 	int count = 0;
1671 	int i;
1672 
1673 	for (i = 0; i < fb_helper->connector_count; i++) {
1674 		connector = fb_helper->connector_info[i]->connector;
1675 		count += connector->funcs->fill_modes(connector, maxX, maxY);
1676 	}
1677 
1678 	return count;
1679 }
1680 
1681 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1682 {
1683 	struct drm_display_mode *mode;
1684 
1685 	list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1686 		if (mode->hdisplay > width ||
1687 		    mode->vdisplay > height)
1688 			continue;
1689 		if (mode->type & DRM_MODE_TYPE_PREFERRED)
1690 			return mode;
1691 	}
1692 	return NULL;
1693 }
1694 EXPORT_SYMBOL(drm_has_preferred_mode);
1695 
1696 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1697 {
1698 	return fb_connector->connector->cmdline_mode.specified;
1699 }
1700 
1701 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1702 						      int width, int height)
1703 {
1704 	struct drm_cmdline_mode *cmdline_mode;
1705 	struct drm_display_mode *mode;
1706 	bool prefer_non_interlace;
1707 
1708 	cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1709 	if (cmdline_mode->specified == false)
1710 		return NULL;
1711 
1712 	/* attempt to find a matching mode in the list of modes
1713 	 *  we have gotten so far, if not add a CVT mode that conforms
1714 	 */
1715 	if (cmdline_mode->rb || cmdline_mode->margins)
1716 		goto create_mode;
1717 
1718 	prefer_non_interlace = !cmdline_mode->interlace;
1719 again:
1720 	list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1721 		/* check width/height */
1722 		if (mode->hdisplay != cmdline_mode->xres ||
1723 		    mode->vdisplay != cmdline_mode->yres)
1724 			continue;
1725 
1726 		if (cmdline_mode->refresh_specified) {
1727 			if (mode->vrefresh != cmdline_mode->refresh)
1728 				continue;
1729 		}
1730 
1731 		if (cmdline_mode->interlace) {
1732 			if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1733 				continue;
1734 		} else if (prefer_non_interlace) {
1735 			if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1736 				continue;
1737 		}
1738 		return mode;
1739 	}
1740 
1741 	if (prefer_non_interlace) {
1742 		prefer_non_interlace = false;
1743 		goto again;
1744 	}
1745 
1746 create_mode:
1747 	mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1748 						 cmdline_mode);
1749 	list_add(&mode->head, &fb_helper_conn->connector->modes);
1750 	return mode;
1751 }
1752 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1753 
1754 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1755 {
1756 	bool enable;
1757 
1758 	if (strict)
1759 		enable = connector->status == connector_status_connected;
1760 	else
1761 		enable = connector->status != connector_status_disconnected;
1762 
1763 	return enable;
1764 }
1765 
1766 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1767 				  bool *enabled)
1768 {
1769 	bool any_enabled = false;
1770 	struct drm_connector *connector;
1771 	int i = 0;
1772 
1773 	for (i = 0; i < fb_helper->connector_count; i++) {
1774 		connector = fb_helper->connector_info[i]->connector;
1775 		enabled[i] = drm_connector_enabled(connector, true);
1776 		DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1777 			  enabled[i] ? "yes" : "no");
1778 		any_enabled |= enabled[i];
1779 	}
1780 
1781 	if (any_enabled)
1782 		return;
1783 
1784 	for (i = 0; i < fb_helper->connector_count; i++) {
1785 		connector = fb_helper->connector_info[i]->connector;
1786 		enabled[i] = drm_connector_enabled(connector, false);
1787 	}
1788 }
1789 
1790 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1791 			      struct drm_display_mode **modes,
1792 			      struct drm_fb_offset *offsets,
1793 			      bool *enabled, int width, int height)
1794 {
1795 	int count, i, j;
1796 	bool can_clone = false;
1797 	struct drm_fb_helper_connector *fb_helper_conn;
1798 	struct drm_display_mode *dmt_mode, *mode;
1799 
1800 	/* only contemplate cloning in the single crtc case */
1801 	if (fb_helper->crtc_count > 1)
1802 		return false;
1803 
1804 	count = 0;
1805 	for (i = 0; i < fb_helper->connector_count; i++) {
1806 		if (enabled[i])
1807 			count++;
1808 	}
1809 
1810 	/* only contemplate cloning if more than one connector is enabled */
1811 	if (count <= 1)
1812 		return false;
1813 
1814 	/* check the command line or if nothing common pick 1024x768 */
1815 	can_clone = true;
1816 	for (i = 0; i < fb_helper->connector_count; i++) {
1817 		if (!enabled[i])
1818 			continue;
1819 		fb_helper_conn = fb_helper->connector_info[i];
1820 		modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1821 		if (!modes[i]) {
1822 			can_clone = false;
1823 			break;
1824 		}
1825 		for (j = 0; j < i; j++) {
1826 			if (!enabled[j])
1827 				continue;
1828 			if (!drm_mode_equal(modes[j], modes[i]))
1829 				can_clone = false;
1830 		}
1831 	}
1832 
1833 	if (can_clone) {
1834 		DRM_DEBUG_KMS("can clone using command line\n");
1835 		return true;
1836 	}
1837 
1838 	/* try and find a 1024x768 mode on each connector */
1839 	can_clone = true;
1840 	dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1841 
1842 	for (i = 0; i < fb_helper->connector_count; i++) {
1843 
1844 		if (!enabled[i])
1845 			continue;
1846 
1847 		fb_helper_conn = fb_helper->connector_info[i];
1848 		list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1849 			if (drm_mode_equal(mode, dmt_mode))
1850 				modes[i] = mode;
1851 		}
1852 		if (!modes[i])
1853 			can_clone = false;
1854 	}
1855 
1856 	if (can_clone) {
1857 		DRM_DEBUG_KMS("can clone using 1024x768\n");
1858 		return true;
1859 	}
1860 	DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1861 	return false;
1862 }
1863 
1864 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1865 				struct drm_display_mode **modes,
1866 				struct drm_fb_offset *offsets,
1867 				int idx,
1868 				int h_idx, int v_idx)
1869 {
1870 	struct drm_fb_helper_connector *fb_helper_conn;
1871 	int i;
1872 	int hoffset = 0, voffset = 0;
1873 
1874 	for (i = 0; i < fb_helper->connector_count; i++) {
1875 		fb_helper_conn = fb_helper->connector_info[i];
1876 		if (!fb_helper_conn->connector->has_tile)
1877 			continue;
1878 
1879 		if (!modes[i] && (h_idx || v_idx)) {
1880 			DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1881 				      fb_helper_conn->connector->base.id);
1882 			continue;
1883 		}
1884 		if (fb_helper_conn->connector->tile_h_loc < h_idx)
1885 			hoffset += modes[i]->hdisplay;
1886 
1887 		if (fb_helper_conn->connector->tile_v_loc < v_idx)
1888 			voffset += modes[i]->vdisplay;
1889 	}
1890 	offsets[idx].x = hoffset;
1891 	offsets[idx].y = voffset;
1892 	DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1893 	return 0;
1894 }
1895 
1896 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1897 				 struct drm_display_mode **modes,
1898 				 struct drm_fb_offset *offsets,
1899 				 bool *enabled, int width, int height)
1900 {
1901 	struct drm_fb_helper_connector *fb_helper_conn;
1902 	int i;
1903 	uint64_t conn_configured = 0, mask;
1904 	int tile_pass = 0;
1905 	mask = (1 << fb_helper->connector_count) - 1;
1906 retry:
1907 	for (i = 0; i < fb_helper->connector_count; i++) {
1908 		fb_helper_conn = fb_helper->connector_info[i];
1909 
1910 		if (conn_configured & (1 << i))
1911 			continue;
1912 
1913 		if (enabled[i] == false) {
1914 			conn_configured |= (1 << i);
1915 			continue;
1916 		}
1917 
1918 		/* first pass over all the untiled connectors */
1919 		if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1920 			continue;
1921 
1922 		if (tile_pass == 1) {
1923 			if (fb_helper_conn->connector->tile_h_loc != 0 ||
1924 			    fb_helper_conn->connector->tile_v_loc != 0)
1925 				continue;
1926 
1927 		} else {
1928 			if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1929 			    fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1930 			/* if this tile_pass doesn't cover any of the tiles - keep going */
1931 				continue;
1932 
1933 			/* find the tile offsets for this pass - need
1934 			   to find all tiles left and above */
1935 			drm_get_tile_offsets(fb_helper, modes, offsets,
1936 					     i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1937 		}
1938 		DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1939 			      fb_helper_conn->connector->base.id);
1940 
1941 		/* got for command line mode first */
1942 		modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1943 		if (!modes[i]) {
1944 			DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1945 				      fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1946 			modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1947 		}
1948 		/* No preferred modes, pick one off the list */
1949 		if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1950 			list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1951 				break;
1952 		}
1953 		DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1954 			  "none");
1955 		conn_configured |= (1 << i);
1956 	}
1957 
1958 	if ((conn_configured & mask) != mask) {
1959 		tile_pass++;
1960 		goto retry;
1961 	}
1962 	return true;
1963 }
1964 
1965 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1966 			  struct drm_fb_helper_crtc **best_crtcs,
1967 			  struct drm_display_mode **modes,
1968 			  int n, int width, int height)
1969 {
1970 	int c, o;
1971 	struct drm_connector *connector;
1972 	const struct drm_connector_helper_funcs *connector_funcs;
1973 	struct drm_encoder *encoder;
1974 	int my_score, best_score, score;
1975 	struct drm_fb_helper_crtc **crtcs, *crtc;
1976 	struct drm_fb_helper_connector *fb_helper_conn;
1977 
1978 	if (n == fb_helper->connector_count)
1979 		return 0;
1980 
1981 	fb_helper_conn = fb_helper->connector_info[n];
1982 	connector = fb_helper_conn->connector;
1983 
1984 	best_crtcs[n] = NULL;
1985 	best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1986 	if (modes[n] == NULL)
1987 		return best_score;
1988 
1989 	crtcs = kzalloc(fb_helper->connector_count *
1990 			sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1991 	if (!crtcs)
1992 		return best_score;
1993 
1994 	my_score = 1;
1995 	if (connector->status == connector_status_connected)
1996 		my_score++;
1997 	if (drm_has_cmdline_mode(fb_helper_conn))
1998 		my_score++;
1999 	if (drm_has_preferred_mode(fb_helper_conn, width, height))
2000 		my_score++;
2001 
2002 	connector_funcs = connector->helper_private;
2003 	encoder = connector_funcs->best_encoder(connector);
2004 	if (!encoder)
2005 		goto out;
2006 
2007 	/* select a crtc for this connector and then attempt to configure
2008 	   remaining connectors */
2009 	for (c = 0; c < fb_helper->crtc_count; c++) {
2010 		crtc = &fb_helper->crtc_info[c];
2011 
2012 		if ((encoder->possible_crtcs & (1 << c)) == 0)
2013 			continue;
2014 
2015 		for (o = 0; o < n; o++)
2016 			if (best_crtcs[o] == crtc)
2017 				break;
2018 
2019 		if (o < n) {
2020 			/* ignore cloning unless only a single crtc */
2021 			if (fb_helper->crtc_count > 1)
2022 				continue;
2023 
2024 			if (!drm_mode_equal(modes[o], modes[n]))
2025 				continue;
2026 		}
2027 
2028 		crtcs[n] = crtc;
2029 		memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2030 		score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2031 						  width, height);
2032 		if (score > best_score) {
2033 			best_score = score;
2034 			memcpy(best_crtcs, crtcs,
2035 			       fb_helper->connector_count *
2036 			       sizeof(struct drm_fb_helper_crtc *));
2037 		}
2038 	}
2039 out:
2040 	kfree(crtcs);
2041 	return best_score;
2042 }
2043 
2044 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2045 {
2046 	struct drm_device *dev = fb_helper->dev;
2047 	struct drm_fb_helper_crtc **crtcs;
2048 	struct drm_display_mode **modes;
2049 	struct drm_fb_offset *offsets;
2050 	struct drm_mode_set *modeset;
2051 	bool *enabled;
2052 	int width, height;
2053 	int i;
2054 
2055 	DRM_DEBUG_KMS("\n");
2056 
2057 	width = dev->mode_config.max_width;
2058 	height = dev->mode_config.max_height;
2059 
2060 	crtcs = kcalloc(fb_helper->connector_count,
2061 			sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2062 	modes = kcalloc(fb_helper->connector_count,
2063 			sizeof(struct drm_display_mode *), GFP_KERNEL);
2064 	offsets = kcalloc(fb_helper->connector_count,
2065 			  sizeof(struct drm_fb_offset), GFP_KERNEL);
2066 	enabled = kcalloc(fb_helper->connector_count,
2067 			  sizeof(bool), GFP_KERNEL);
2068 	if (!crtcs || !modes || !enabled || !offsets) {
2069 		DRM_ERROR("Memory allocation failed\n");
2070 		goto out;
2071 	}
2072 
2073 
2074 	drm_enable_connectors(fb_helper, enabled);
2075 
2076 	if (!(fb_helper->funcs->initial_config &&
2077 	      fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2078 					       offsets,
2079 					       enabled, width, height))) {
2080 		memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2081 		memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2082 		memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2083 
2084 		if (!drm_target_cloned(fb_helper, modes, offsets,
2085 				       enabled, width, height) &&
2086 		    !drm_target_preferred(fb_helper, modes, offsets,
2087 					  enabled, width, height))
2088 			DRM_ERROR("Unable to find initial modes\n");
2089 
2090 		DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2091 			      width, height);
2092 
2093 		drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2094 	}
2095 
2096 	/* need to set the modesets up here for use later */
2097 	/* fill out the connector<->crtc mappings into the modesets */
2098 	for (i = 0; i < fb_helper->crtc_count; i++) {
2099 		modeset = &fb_helper->crtc_info[i].mode_set;
2100 		modeset->num_connectors = 0;
2101 		modeset->fb = NULL;
2102 	}
2103 
2104 	for (i = 0; i < fb_helper->connector_count; i++) {
2105 		struct drm_display_mode *mode = modes[i];
2106 		struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2107 		struct drm_fb_offset *offset = &offsets[i];
2108 		modeset = &fb_crtc->mode_set;
2109 
2110 		if (mode && fb_crtc) {
2111 			DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2112 				      mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2113 			fb_crtc->desired_mode = mode;
2114 			fb_crtc->x = offset->x;
2115 			fb_crtc->y = offset->y;
2116 			if (modeset->mode)
2117 				drm_mode_destroy(dev, modeset->mode);
2118 			modeset->mode = drm_mode_duplicate(dev,
2119 							   fb_crtc->desired_mode);
2120 			modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2121 			modeset->fb = fb_helper->fb;
2122 			modeset->x = offset->x;
2123 			modeset->y = offset->y;
2124 		}
2125 	}
2126 
2127 	/* Clear out any old modes if there are no more connected outputs. */
2128 	for (i = 0; i < fb_helper->crtc_count; i++) {
2129 		modeset = &fb_helper->crtc_info[i].mode_set;
2130 		if (modeset->num_connectors == 0) {
2131 			BUG_ON(modeset->fb);
2132 			if (modeset->mode)
2133 				drm_mode_destroy(dev, modeset->mode);
2134 			modeset->mode = NULL;
2135 		}
2136 	}
2137 out:
2138 	kfree(crtcs);
2139 	kfree(modes);
2140 	kfree(offsets);
2141 	kfree(enabled);
2142 }
2143 
2144 /**
2145  * drm_fb_helper_initial_config - setup a sane initial connector configuration
2146  * @fb_helper: fb_helper device struct
2147  * @bpp_sel: bpp value to use for the framebuffer configuration
2148  *
2149  * Scans the CRTCs and connectors and tries to put together an initial setup.
2150  * At the moment, this is a cloned configuration across all heads with
2151  * a new framebuffer object as the backing store.
2152  *
2153  * Note that this also registers the fbdev and so allows userspace to call into
2154  * the driver through the fbdev interfaces.
2155  *
2156  * This function will call down into the ->fb_probe callback to let
2157  * the driver allocate and initialize the fbdev info structure and the drm
2158  * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2159  * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2160  * values for the fbdev info structure.
2161  *
2162  * HANG DEBUGGING:
2163  *
2164  * When you have fbcon support built-in or already loaded, this function will do
2165  * a full modeset to setup the fbdev console. Due to locking misdesign in the
2166  * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2167  * console_lock. Until console_unlock is called no dmesg lines will be sent out
2168  * to consoles, not even serial console. This means when your driver crashes,
2169  * you will see absolutely nothing else but a system stuck in this function,
2170  * with no further output. Any kind of printk() you place within your own driver
2171  * or in the drm core modeset code will also never show up.
2172  *
2173  * Standard debug practice is to run the fbcon setup without taking the
2174  * console_lock as a hack, to be able to see backtraces and crashes on the
2175  * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2176  * cmdline option.
2177  *
2178  * The other option is to just disable fbdev emulation since very likely the
2179  * first modeset from userspace will crash in the same way, and is even easier
2180  * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2181  * kernel cmdline option.
2182  *
2183  * RETURNS:
2184  * Zero if everything went ok, nonzero otherwise.
2185  */
2186 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2187 {
2188 	struct drm_device *dev = fb_helper->dev;
2189 	int count = 0;
2190 
2191 	if (!drm_fbdev_emulation)
2192 		return 0;
2193 
2194 	mutex_lock(&dev->mode_config.mutex);
2195 	count = drm_fb_helper_probe_connector_modes(fb_helper,
2196 						    dev->mode_config.max_width,
2197 						    dev->mode_config.max_height);
2198 	mutex_unlock(&dev->mode_config.mutex);
2199 	/*
2200 	 * we shouldn't end up with no modes here.
2201 	 */
2202 	if (count == 0)
2203 		dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2204 
2205 	drm_setup_crtcs(fb_helper);
2206 
2207 	return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2208 }
2209 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2210 
2211 /**
2212  * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2213  *                               probing all the outputs attached to the fb
2214  * @fb_helper: the drm_fb_helper
2215  *
2216  * Scan the connectors attached to the fb_helper and try to put together a
2217  * setup after *notification of a change in output configuration.
2218  *
2219  * Called at runtime, takes the mode config locks to be able to check/change the
2220  * modeset configuration. Must be run from process context (which usually means
2221  * either the output polling work or a work item launched from the driver's
2222  * hotplug interrupt).
2223  *
2224  * Note that drivers may call this even before calling
2225  * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2226  * for a race-free fbcon setup and will make sure that the fbdev emulation will
2227  * not miss any hotplug events.
2228  *
2229  * RETURNS:
2230  * 0 on success and a non-zero error code otherwise.
2231  */
2232 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2233 {
2234 	struct drm_device *dev = fb_helper->dev;
2235 	u32 max_width, max_height;
2236 
2237 	if (!drm_fbdev_emulation)
2238 		return 0;
2239 
2240 	mutex_lock(&fb_helper->dev->mode_config.mutex);
2241 	if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2242 		fb_helper->delayed_hotplug = true;
2243 		mutex_unlock(&fb_helper->dev->mode_config.mutex);
2244 		return 0;
2245 	}
2246 	DRM_DEBUG_KMS("\n");
2247 
2248 	max_width = fb_helper->fb->width;
2249 	max_height = fb_helper->fb->height;
2250 
2251 	drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2252 	mutex_unlock(&fb_helper->dev->mode_config.mutex);
2253 
2254 	drm_modeset_lock_all(dev);
2255 	drm_setup_crtcs(fb_helper);
2256 	drm_modeset_unlock_all(dev);
2257 	drm_fb_helper_set_par(fb_helper->fbdev);
2258 
2259 	return 0;
2260 }
2261 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2262 
2263 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2264  * but the module doesn't depend on any fb console symbols.  At least
2265  * attempt to load fbcon to avoid leaving the system without a usable console.
2266  */
2267 int __init drm_fb_helper_modinit(void)
2268 {
2269 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2270 	const char *name = "fbcon";
2271 	struct module *fbcon;
2272 
2273 	mutex_lock(&module_mutex);
2274 	fbcon = find_module(name);
2275 	mutex_unlock(&module_mutex);
2276 
2277 	if (!fbcon)
2278 		request_module_nowait(name);
2279 #endif
2280 	return 0;
2281 }
2282 EXPORT_SYMBOL(drm_fb_helper_modinit);
2283