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