xref: /openbmc/linux/drivers/gpu/drm/drm_fb_helper.c (revision e3b9f1e8)
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_internal.h"
45 #include "drm_crtc_helper_internal.h"
46 
47 static bool drm_fbdev_emulation = true;
48 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
49 MODULE_PARM_DESC(fbdev_emulation,
50 		 "Enable legacy fbdev emulation [default=true]");
51 
52 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
53 module_param(drm_fbdev_overalloc, int, 0444);
54 MODULE_PARM_DESC(drm_fbdev_overalloc,
55 		 "Overallocation of the fbdev buffer (%) [default="
56 		 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
57 
58 static LIST_HEAD(kernel_fb_helper_list);
59 static DEFINE_MUTEX(kernel_fb_helper_lock);
60 
61 /**
62  * DOC: fbdev helpers
63  *
64  * The fb helper functions are useful to provide an fbdev on top of a drm kernel
65  * mode setting driver. They can be used mostly independently from the crtc
66  * helper functions used by many drivers to implement the kernel mode setting
67  * interfaces.
68  *
69  * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
70  * down by calling drm_fb_helper_fbdev_teardown().
71  *
72  * Drivers that need to handle connector hotplugging (e.g. dp mst) can't use
73  * the setup helper and will need to do the whole four-step setup process with
74  * drm_fb_helper_prepare(), drm_fb_helper_init(),
75  * drm_fb_helper_single_add_all_connectors(), enable hotplugging and
76  * drm_fb_helper_initial_config() to avoid a possible race window.
77  *
78  * At runtime drivers should restore the fbdev console by using
79  * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
80  * They should also notify the fb helper code from updates to the output
81  * configuration by using drm_fb_helper_output_poll_changed() as their
82  * &drm_mode_config_funcs.output_poll_changed callback.
83  *
84  * For suspend/resume consider using drm_mode_config_helper_suspend() and
85  * drm_mode_config_helper_resume() which takes care of fbdev as well.
86  *
87  * All other functions exported by the fb helper library can be used to
88  * implement the fbdev driver interface by the driver.
89  *
90  * It is possible, though perhaps somewhat tricky, to implement race-free
91  * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
92  * helper must be called first to initialize the minimum required to make
93  * hotplug detection work. Drivers also need to make sure to properly set up
94  * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
95  * it is safe to enable interrupts and start processing hotplug events. At the
96  * same time, drivers should initialize all modeset objects such as CRTCs,
97  * encoders and connectors. To finish up the fbdev helper initialization, the
98  * drm_fb_helper_init() function is called. To probe for all attached displays
99  * and set up an initial configuration using the detected hardware, drivers
100  * should call drm_fb_helper_single_add_all_connectors() followed by
101  * drm_fb_helper_initial_config().
102  *
103  * If &drm_framebuffer_funcs.dirty is set, the
104  * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
105  * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
106  * away. This worker then calls the dirty() function ensuring that it will
107  * always run in process context since the fb_*() function could be running in
108  * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
109  * callback it will also schedule dirty_work with the damage collected from the
110  * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
111  * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
112  */
113 
114 #define drm_fb_helper_for_each_connector(fbh, i__) \
115 	for (({ lockdep_assert_held(&(fbh)->lock); }), \
116 	     i__ = 0; i__ < (fbh)->connector_count; i__++)
117 
118 static int __drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
119 					     struct drm_connector *connector)
120 {
121 	struct drm_fb_helper_connector *fb_conn;
122 	struct drm_fb_helper_connector **temp;
123 	unsigned int count;
124 
125 	if (!drm_fbdev_emulation)
126 		return 0;
127 
128 	lockdep_assert_held(&fb_helper->lock);
129 
130 	count = fb_helper->connector_count + 1;
131 
132 	if (count > fb_helper->connector_info_alloc_count) {
133 		size_t size = count * sizeof(fb_conn);
134 
135 		temp = krealloc(fb_helper->connector_info, size, GFP_KERNEL);
136 		if (!temp)
137 			return -ENOMEM;
138 
139 		fb_helper->connector_info_alloc_count = count;
140 		fb_helper->connector_info = temp;
141 	}
142 
143 	fb_conn = kzalloc(sizeof(*fb_conn), GFP_KERNEL);
144 	if (!fb_conn)
145 		return -ENOMEM;
146 
147 	drm_connector_get(connector);
148 	fb_conn->connector = connector;
149 	fb_helper->connector_info[fb_helper->connector_count++] = fb_conn;
150 
151 	return 0;
152 }
153 
154 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
155 				    struct drm_connector *connector)
156 {
157 	int err;
158 
159 	if (!fb_helper)
160 		return 0;
161 
162 	mutex_lock(&fb_helper->lock);
163 	err = __drm_fb_helper_add_one_connector(fb_helper, connector);
164 	mutex_unlock(&fb_helper->lock);
165 
166 	return err;
167 }
168 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
169 
170 /**
171  * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
172  * 					       emulation helper
173  * @fb_helper: fbdev initialized with drm_fb_helper_init, can be NULL
174  *
175  * This functions adds all the available connectors for use with the given
176  * fb_helper. This is a separate step to allow drivers to freely assign
177  * connectors to the fbdev, e.g. if some are reserved for special purposes or
178  * not adequate to be used for the fbcon.
179  *
180  * This function is protected against concurrent connector hotadds/removals
181  * using drm_fb_helper_add_one_connector() and
182  * drm_fb_helper_remove_one_connector().
183  */
184 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
185 {
186 	struct drm_device *dev;
187 	struct drm_connector *connector;
188 	struct drm_connector_list_iter conn_iter;
189 	int i, ret = 0;
190 
191 	if (!drm_fbdev_emulation || !fb_helper)
192 		return 0;
193 
194 	dev = fb_helper->dev;
195 
196 	mutex_lock(&fb_helper->lock);
197 	drm_connector_list_iter_begin(dev, &conn_iter);
198 	drm_for_each_connector_iter(connector, &conn_iter) {
199 		ret = __drm_fb_helper_add_one_connector(fb_helper, connector);
200 		if (ret)
201 			goto fail;
202 	}
203 	goto out;
204 
205 fail:
206 	drm_fb_helper_for_each_connector(fb_helper, i) {
207 		struct drm_fb_helper_connector *fb_helper_connector =
208 			fb_helper->connector_info[i];
209 
210 		drm_connector_put(fb_helper_connector->connector);
211 
212 		kfree(fb_helper_connector);
213 		fb_helper->connector_info[i] = NULL;
214 	}
215 	fb_helper->connector_count = 0;
216 out:
217 	drm_connector_list_iter_end(&conn_iter);
218 	mutex_unlock(&fb_helper->lock);
219 
220 	return ret;
221 }
222 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
223 
224 static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
225 						struct drm_connector *connector)
226 {
227 	struct drm_fb_helper_connector *fb_helper_connector;
228 	int i, j;
229 
230 	if (!drm_fbdev_emulation)
231 		return 0;
232 
233 	lockdep_assert_held(&fb_helper->lock);
234 
235 	drm_fb_helper_for_each_connector(fb_helper, i) {
236 		if (fb_helper->connector_info[i]->connector == connector)
237 			break;
238 	}
239 
240 	if (i == fb_helper->connector_count)
241 		return -EINVAL;
242 	fb_helper_connector = fb_helper->connector_info[i];
243 	drm_connector_put(fb_helper_connector->connector);
244 
245 	for (j = i + 1; j < fb_helper->connector_count; j++)
246 		fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
247 
248 	fb_helper->connector_count--;
249 	kfree(fb_helper_connector);
250 
251 	return 0;
252 }
253 
254 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
255 				       struct drm_connector *connector)
256 {
257 	int err;
258 
259 	if (!fb_helper)
260 		return 0;
261 
262 	mutex_lock(&fb_helper->lock);
263 	err = __drm_fb_helper_remove_one_connector(fb_helper, connector);
264 	mutex_unlock(&fb_helper->lock);
265 
266 	return err;
267 }
268 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
269 
270 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
271 {
272 	uint16_t *r_base, *g_base, *b_base;
273 
274 	if (crtc->funcs->gamma_set == NULL)
275 		return;
276 
277 	r_base = crtc->gamma_store;
278 	g_base = r_base + crtc->gamma_size;
279 	b_base = g_base + crtc->gamma_size;
280 
281 	crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
282 			       crtc->gamma_size, NULL);
283 }
284 
285 /**
286  * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
287  * @info: fbdev registered by the helper
288  */
289 int drm_fb_helper_debug_enter(struct fb_info *info)
290 {
291 	struct drm_fb_helper *helper = info->par;
292 	const struct drm_crtc_helper_funcs *funcs;
293 	int i;
294 
295 	list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
296 		for (i = 0; i < helper->crtc_count; i++) {
297 			struct drm_mode_set *mode_set =
298 				&helper->crtc_info[i].mode_set;
299 
300 			if (!mode_set->crtc->enabled)
301 				continue;
302 
303 			funcs =	mode_set->crtc->helper_private;
304 			if (funcs->mode_set_base_atomic == NULL)
305 				continue;
306 
307 			if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
308 				continue;
309 
310 			funcs->mode_set_base_atomic(mode_set->crtc,
311 						    mode_set->fb,
312 						    mode_set->x,
313 						    mode_set->y,
314 						    ENTER_ATOMIC_MODE_SET);
315 		}
316 	}
317 
318 	return 0;
319 }
320 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
321 
322 /**
323  * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
324  * @info: fbdev registered by the helper
325  */
326 int drm_fb_helper_debug_leave(struct fb_info *info)
327 {
328 	struct drm_fb_helper *helper = info->par;
329 	struct drm_crtc *crtc;
330 	const struct drm_crtc_helper_funcs *funcs;
331 	struct drm_framebuffer *fb;
332 	int i;
333 
334 	for (i = 0; i < helper->crtc_count; i++) {
335 		struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
336 
337 		crtc = mode_set->crtc;
338 		if (drm_drv_uses_atomic_modeset(crtc->dev))
339 			continue;
340 
341 		funcs = crtc->helper_private;
342 		fb = crtc->primary->fb;
343 
344 		if (!crtc->enabled)
345 			continue;
346 
347 		if (!fb) {
348 			DRM_ERROR("no fb to restore??\n");
349 			continue;
350 		}
351 
352 		if (funcs->mode_set_base_atomic == NULL)
353 			continue;
354 
355 		drm_fb_helper_restore_lut_atomic(mode_set->crtc);
356 		funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
357 					    crtc->y, LEAVE_ATOMIC_MODE_SET);
358 	}
359 
360 	return 0;
361 }
362 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
363 
364 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper, bool active)
365 {
366 	struct drm_device *dev = fb_helper->dev;
367 	struct drm_plane_state *plane_state;
368 	struct drm_plane *plane;
369 	struct drm_atomic_state *state;
370 	int i, ret;
371 	unsigned int plane_mask;
372 	struct drm_modeset_acquire_ctx ctx;
373 
374 	drm_modeset_acquire_init(&ctx, 0);
375 
376 	state = drm_atomic_state_alloc(dev);
377 	if (!state) {
378 		ret = -ENOMEM;
379 		goto out_ctx;
380 	}
381 
382 	state->acquire_ctx = &ctx;
383 retry:
384 	plane_mask = 0;
385 	drm_for_each_plane(plane, dev) {
386 		plane_state = drm_atomic_get_plane_state(state, plane);
387 		if (IS_ERR(plane_state)) {
388 			ret = PTR_ERR(plane_state);
389 			goto out_state;
390 		}
391 
392 		plane_state->rotation = DRM_MODE_ROTATE_0;
393 
394 		plane->old_fb = plane->fb;
395 		plane_mask |= 1 << drm_plane_index(plane);
396 
397 		/* disable non-primary: */
398 		if (plane->type == DRM_PLANE_TYPE_PRIMARY)
399 			continue;
400 
401 		ret = __drm_atomic_helper_disable_plane(plane, plane_state);
402 		if (ret != 0)
403 			goto out_state;
404 	}
405 
406 	for (i = 0; i < fb_helper->crtc_count; i++) {
407 		struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
408 		struct drm_plane *primary = mode_set->crtc->primary;
409 
410 		/* Cannot fail as we've already gotten the plane state above */
411 		plane_state = drm_atomic_get_new_plane_state(state, primary);
412 		plane_state->rotation = fb_helper->crtc_info[i].rotation;
413 
414 		ret = __drm_atomic_helper_set_config(mode_set, state);
415 		if (ret != 0)
416 			goto out_state;
417 
418 		/*
419 		 * __drm_atomic_helper_set_config() sets active when a
420 		 * mode is set, unconditionally clear it if we force DPMS off
421 		 */
422 		if (!active) {
423 			struct drm_crtc *crtc = mode_set->crtc;
424 			struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
425 
426 			crtc_state->active = false;
427 		}
428 	}
429 
430 	ret = drm_atomic_commit(state);
431 
432 out_state:
433 	drm_atomic_clean_old_fb(dev, plane_mask, ret);
434 
435 	if (ret == -EDEADLK)
436 		goto backoff;
437 
438 	drm_atomic_state_put(state);
439 out_ctx:
440 	drm_modeset_drop_locks(&ctx);
441 	drm_modeset_acquire_fini(&ctx);
442 
443 	return ret;
444 
445 backoff:
446 	drm_atomic_state_clear(state);
447 	drm_modeset_backoff(&ctx);
448 
449 	goto retry;
450 }
451 
452 static int restore_fbdev_mode_legacy(struct drm_fb_helper *fb_helper)
453 {
454 	struct drm_device *dev = fb_helper->dev;
455 	struct drm_plane *plane;
456 	int i, ret = 0;
457 
458 	drm_modeset_lock_all(fb_helper->dev);
459 	drm_for_each_plane(plane, dev) {
460 		if (plane->type != DRM_PLANE_TYPE_PRIMARY)
461 			drm_plane_force_disable(plane);
462 
463 		if (plane->rotation_property)
464 			drm_mode_plane_set_obj_prop(plane,
465 						    plane->rotation_property,
466 						    DRM_MODE_ROTATE_0);
467 	}
468 
469 	for (i = 0; i < fb_helper->crtc_count; i++) {
470 		struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
471 		struct drm_crtc *crtc = mode_set->crtc;
472 
473 		if (crtc->funcs->cursor_set2) {
474 			ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
475 			if (ret)
476 				goto out;
477 		} else if (crtc->funcs->cursor_set) {
478 			ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
479 			if (ret)
480 				goto out;
481 		}
482 
483 		ret = drm_mode_set_config_internal(mode_set);
484 		if (ret)
485 			goto out;
486 	}
487 out:
488 	drm_modeset_unlock_all(fb_helper->dev);
489 
490 	return ret;
491 }
492 
493 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
494 {
495 	struct drm_device *dev = fb_helper->dev;
496 
497 	if (drm_drv_uses_atomic_modeset(dev))
498 		return restore_fbdev_mode_atomic(fb_helper, true);
499 	else
500 		return restore_fbdev_mode_legacy(fb_helper);
501 }
502 
503 /**
504  * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
505  * @fb_helper: driver-allocated fbdev helper, can be NULL
506  *
507  * This should be called from driver's drm &drm_driver.lastclose callback
508  * when implementing an fbcon on top of kms using this helper. This ensures that
509  * the user isn't greeted with a black screen when e.g. X dies.
510  *
511  * RETURNS:
512  * Zero if everything went ok, negative error code otherwise.
513  */
514 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
515 {
516 	bool do_delayed;
517 	int ret;
518 
519 	if (!drm_fbdev_emulation || !fb_helper)
520 		return -ENODEV;
521 
522 	if (READ_ONCE(fb_helper->deferred_setup))
523 		return 0;
524 
525 	mutex_lock(&fb_helper->lock);
526 	ret = restore_fbdev_mode(fb_helper);
527 
528 	do_delayed = fb_helper->delayed_hotplug;
529 	if (do_delayed)
530 		fb_helper->delayed_hotplug = false;
531 	mutex_unlock(&fb_helper->lock);
532 
533 	if (do_delayed)
534 		drm_fb_helper_hotplug_event(fb_helper);
535 
536 	return ret;
537 }
538 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
539 
540 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
541 {
542 	struct drm_device *dev = fb_helper->dev;
543 	struct drm_crtc *crtc;
544 	int bound = 0, crtcs_bound = 0;
545 
546 	/*
547 	 * Sometimes user space wants everything disabled, so don't steal the
548 	 * display if there's a master.
549 	 */
550 	if (READ_ONCE(dev->master))
551 		return false;
552 
553 	drm_for_each_crtc(crtc, dev) {
554 		drm_modeset_lock(&crtc->mutex, NULL);
555 		if (crtc->primary->fb)
556 			crtcs_bound++;
557 		if (crtc->primary->fb == fb_helper->fb)
558 			bound++;
559 		drm_modeset_unlock(&crtc->mutex);
560 	}
561 
562 	if (bound < crtcs_bound)
563 		return false;
564 
565 	return true;
566 }
567 
568 #ifdef CONFIG_MAGIC_SYSRQ
569 /*
570  * restore fbcon display for all kms driver's using this helper, used for sysrq
571  * and panic handling.
572  */
573 static bool drm_fb_helper_force_kernel_mode(void)
574 {
575 	bool ret, error = false;
576 	struct drm_fb_helper *helper;
577 
578 	if (list_empty(&kernel_fb_helper_list))
579 		return false;
580 
581 	list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
582 		struct drm_device *dev = helper->dev;
583 
584 		if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
585 			continue;
586 
587 		mutex_lock(&helper->lock);
588 		ret = restore_fbdev_mode(helper);
589 		if (ret)
590 			error = true;
591 		mutex_unlock(&helper->lock);
592 	}
593 	return error;
594 }
595 
596 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
597 {
598 	bool ret;
599 
600 	ret = drm_fb_helper_force_kernel_mode();
601 	if (ret == true)
602 		DRM_ERROR("Failed to restore crtc configuration\n");
603 }
604 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
605 
606 static void drm_fb_helper_sysrq(int dummy1)
607 {
608 	schedule_work(&drm_fb_helper_restore_work);
609 }
610 
611 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
612 	.handler = drm_fb_helper_sysrq,
613 	.help_msg = "force-fb(V)",
614 	.action_msg = "Restore framebuffer console",
615 };
616 #else
617 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
618 #endif
619 
620 static void dpms_legacy(struct drm_fb_helper *fb_helper, int dpms_mode)
621 {
622 	struct drm_device *dev = fb_helper->dev;
623 	struct drm_crtc *crtc;
624 	struct drm_connector *connector;
625 	int i, j;
626 
627 	drm_modeset_lock_all(dev);
628 	for (i = 0; i < fb_helper->crtc_count; i++) {
629 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
630 
631 		if (!crtc->enabled)
632 			continue;
633 
634 		/* Walk the connectors & encoders on this fb turning them on/off */
635 		drm_fb_helper_for_each_connector(fb_helper, j) {
636 			connector = fb_helper->connector_info[j]->connector;
637 			connector->funcs->dpms(connector, dpms_mode);
638 			drm_object_property_set_value(&connector->base,
639 				dev->mode_config.dpms_property, dpms_mode);
640 		}
641 	}
642 	drm_modeset_unlock_all(dev);
643 }
644 
645 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
646 {
647 	struct drm_fb_helper *fb_helper = info->par;
648 
649 	/*
650 	 * For each CRTC in this fb, turn the connectors on/off.
651 	 */
652 	mutex_lock(&fb_helper->lock);
653 	if (!drm_fb_helper_is_bound(fb_helper)) {
654 		mutex_unlock(&fb_helper->lock);
655 		return;
656 	}
657 
658 	if (drm_drv_uses_atomic_modeset(fb_helper->dev))
659 		restore_fbdev_mode_atomic(fb_helper, dpms_mode == DRM_MODE_DPMS_ON);
660 	else
661 		dpms_legacy(fb_helper, dpms_mode);
662 	mutex_unlock(&fb_helper->lock);
663 }
664 
665 /**
666  * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
667  * @blank: desired blanking state
668  * @info: fbdev registered by the helper
669  */
670 int drm_fb_helper_blank(int blank, struct fb_info *info)
671 {
672 	if (oops_in_progress)
673 		return -EBUSY;
674 
675 	switch (blank) {
676 	/* Display: On; HSync: On, VSync: On */
677 	case FB_BLANK_UNBLANK:
678 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
679 		break;
680 	/* Display: Off; HSync: On, VSync: On */
681 	case FB_BLANK_NORMAL:
682 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
683 		break;
684 	/* Display: Off; HSync: Off, VSync: On */
685 	case FB_BLANK_HSYNC_SUSPEND:
686 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
687 		break;
688 	/* Display: Off; HSync: On, VSync: Off */
689 	case FB_BLANK_VSYNC_SUSPEND:
690 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
691 		break;
692 	/* Display: Off; HSync: Off, VSync: Off */
693 	case FB_BLANK_POWERDOWN:
694 		drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
695 		break;
696 	}
697 	return 0;
698 }
699 EXPORT_SYMBOL(drm_fb_helper_blank);
700 
701 static void drm_fb_helper_modeset_release(struct drm_fb_helper *helper,
702 					  struct drm_mode_set *modeset)
703 {
704 	int i;
705 
706 	for (i = 0; i < modeset->num_connectors; i++) {
707 		drm_connector_put(modeset->connectors[i]);
708 		modeset->connectors[i] = NULL;
709 	}
710 	modeset->num_connectors = 0;
711 
712 	drm_mode_destroy(helper->dev, modeset->mode);
713 	modeset->mode = NULL;
714 
715 	/* FIXME should hold a ref? */
716 	modeset->fb = NULL;
717 }
718 
719 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
720 {
721 	int i;
722 
723 	for (i = 0; i < helper->connector_count; i++) {
724 		drm_connector_put(helper->connector_info[i]->connector);
725 		kfree(helper->connector_info[i]);
726 	}
727 	kfree(helper->connector_info);
728 
729 	for (i = 0; i < helper->crtc_count; i++) {
730 		struct drm_mode_set *modeset = &helper->crtc_info[i].mode_set;
731 
732 		drm_fb_helper_modeset_release(helper, modeset);
733 		kfree(modeset->connectors);
734 	}
735 	kfree(helper->crtc_info);
736 }
737 
738 static void drm_fb_helper_resume_worker(struct work_struct *work)
739 {
740 	struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
741 						    resume_work);
742 
743 	console_lock();
744 	fb_set_suspend(helper->fbdev, 0);
745 	console_unlock();
746 }
747 
748 static void drm_fb_helper_dirty_work(struct work_struct *work)
749 {
750 	struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
751 						    dirty_work);
752 	struct drm_clip_rect *clip = &helper->dirty_clip;
753 	struct drm_clip_rect clip_copy;
754 	unsigned long flags;
755 
756 	spin_lock_irqsave(&helper->dirty_lock, flags);
757 	clip_copy = *clip;
758 	clip->x1 = clip->y1 = ~0;
759 	clip->x2 = clip->y2 = 0;
760 	spin_unlock_irqrestore(&helper->dirty_lock, flags);
761 
762 	/* call dirty callback only when it has been really touched */
763 	if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2)
764 		helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
765 }
766 
767 /**
768  * drm_fb_helper_prepare - setup a drm_fb_helper structure
769  * @dev: DRM device
770  * @helper: driver-allocated fbdev helper structure to set up
771  * @funcs: pointer to structure of functions associate with this helper
772  *
773  * Sets up the bare minimum to make the framebuffer helper usable. This is
774  * useful to implement race-free initialization of the polling helpers.
775  */
776 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
777 			   const struct drm_fb_helper_funcs *funcs)
778 {
779 	INIT_LIST_HEAD(&helper->kernel_fb_list);
780 	spin_lock_init(&helper->dirty_lock);
781 	INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
782 	INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
783 	helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
784 	mutex_init(&helper->lock);
785 	helper->funcs = funcs;
786 	helper->dev = dev;
787 }
788 EXPORT_SYMBOL(drm_fb_helper_prepare);
789 
790 /**
791  * drm_fb_helper_init - initialize a &struct drm_fb_helper
792  * @dev: drm device
793  * @fb_helper: driver-allocated fbdev helper structure to initialize
794  * @max_conn_count: max connector count
795  *
796  * This allocates the structures for the fbdev helper with the given limits.
797  * Note that this won't yet touch the hardware (through the driver interfaces)
798  * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
799  * to allow driver writes more control over the exact init sequence.
800  *
801  * Drivers must call drm_fb_helper_prepare() before calling this function.
802  *
803  * RETURNS:
804  * Zero if everything went ok, nonzero otherwise.
805  */
806 int drm_fb_helper_init(struct drm_device *dev,
807 		       struct drm_fb_helper *fb_helper,
808 		       int max_conn_count)
809 {
810 	struct drm_crtc *crtc;
811 	struct drm_mode_config *config = &dev->mode_config;
812 	int i;
813 
814 	if (!drm_fbdev_emulation) {
815 		dev->fb_helper = fb_helper;
816 		return 0;
817 	}
818 
819 	if (!max_conn_count)
820 		return -EINVAL;
821 
822 	fb_helper->crtc_info = kcalloc(config->num_crtc, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
823 	if (!fb_helper->crtc_info)
824 		return -ENOMEM;
825 
826 	fb_helper->crtc_count = config->num_crtc;
827 	fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
828 	if (!fb_helper->connector_info) {
829 		kfree(fb_helper->crtc_info);
830 		return -ENOMEM;
831 	}
832 	fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
833 	fb_helper->connector_count = 0;
834 
835 	for (i = 0; i < fb_helper->crtc_count; i++) {
836 		fb_helper->crtc_info[i].mode_set.connectors =
837 			kcalloc(max_conn_count,
838 				sizeof(struct drm_connector *),
839 				GFP_KERNEL);
840 
841 		if (!fb_helper->crtc_info[i].mode_set.connectors)
842 			goto out_free;
843 		fb_helper->crtc_info[i].mode_set.num_connectors = 0;
844 		fb_helper->crtc_info[i].rotation = DRM_MODE_ROTATE_0;
845 	}
846 
847 	i = 0;
848 	drm_for_each_crtc(crtc, dev) {
849 		fb_helper->crtc_info[i].mode_set.crtc = crtc;
850 		i++;
851 	}
852 
853 	dev->fb_helper = fb_helper;
854 
855 	return 0;
856 out_free:
857 	drm_fb_helper_crtc_free(fb_helper);
858 	return -ENOMEM;
859 }
860 EXPORT_SYMBOL(drm_fb_helper_init);
861 
862 /**
863  * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
864  * @fb_helper: driver-allocated fbdev helper
865  *
866  * A helper to alloc fb_info and the members cmap and apertures. Called
867  * by the driver within the fb_probe fb_helper callback function. Drivers do not
868  * need to release the allocated fb_info structure themselves, this is
869  * automatically done when calling drm_fb_helper_fini().
870  *
871  * RETURNS:
872  * fb_info pointer if things went okay, pointer containing error code
873  * otherwise
874  */
875 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
876 {
877 	struct device *dev = fb_helper->dev->dev;
878 	struct fb_info *info;
879 	int ret;
880 
881 	info = framebuffer_alloc(0, dev);
882 	if (!info)
883 		return ERR_PTR(-ENOMEM);
884 
885 	ret = fb_alloc_cmap(&info->cmap, 256, 0);
886 	if (ret)
887 		goto err_release;
888 
889 	info->apertures = alloc_apertures(1);
890 	if (!info->apertures) {
891 		ret = -ENOMEM;
892 		goto err_free_cmap;
893 	}
894 
895 	fb_helper->fbdev = info;
896 
897 	return info;
898 
899 err_free_cmap:
900 	fb_dealloc_cmap(&info->cmap);
901 err_release:
902 	framebuffer_release(info);
903 	return ERR_PTR(ret);
904 }
905 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
906 
907 /**
908  * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
909  * @fb_helper: driver-allocated fbdev helper, can be NULL
910  *
911  * A wrapper around unregister_framebuffer, to release the fb_info
912  * framebuffer device. This must be called before releasing all resources for
913  * @fb_helper by calling drm_fb_helper_fini().
914  */
915 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
916 {
917 	if (fb_helper && fb_helper->fbdev)
918 		unregister_framebuffer(fb_helper->fbdev);
919 }
920 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
921 
922 /**
923  * drm_fb_helper_fini - finialize a &struct drm_fb_helper
924  * @fb_helper: driver-allocated fbdev helper, can be NULL
925  *
926  * This cleans up all remaining resources associated with @fb_helper. Must be
927  * called after drm_fb_helper_unlink_fbi() was called.
928  */
929 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
930 {
931 	struct fb_info *info;
932 
933 	if (!fb_helper)
934 		return;
935 
936 	fb_helper->dev->fb_helper = NULL;
937 
938 	if (!drm_fbdev_emulation)
939 		return;
940 
941 	cancel_work_sync(&fb_helper->resume_work);
942 	cancel_work_sync(&fb_helper->dirty_work);
943 
944 	info = fb_helper->fbdev;
945 	if (info) {
946 		if (info->cmap.len)
947 			fb_dealloc_cmap(&info->cmap);
948 		framebuffer_release(info);
949 	}
950 	fb_helper->fbdev = NULL;
951 
952 	mutex_lock(&kernel_fb_helper_lock);
953 	if (!list_empty(&fb_helper->kernel_fb_list)) {
954 		list_del(&fb_helper->kernel_fb_list);
955 		if (list_empty(&kernel_fb_helper_list))
956 			unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
957 	}
958 	mutex_unlock(&kernel_fb_helper_lock);
959 
960 	mutex_destroy(&fb_helper->lock);
961 	drm_fb_helper_crtc_free(fb_helper);
962 
963 }
964 EXPORT_SYMBOL(drm_fb_helper_fini);
965 
966 /**
967  * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
968  * @fb_helper: driver-allocated fbdev helper, can be NULL
969  *
970  * A wrapper around unlink_framebuffer implemented by fbdev core
971  */
972 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
973 {
974 	if (fb_helper && fb_helper->fbdev)
975 		unlink_framebuffer(fb_helper->fbdev);
976 }
977 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
978 
979 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
980 				u32 width, u32 height)
981 {
982 	struct drm_fb_helper *helper = info->par;
983 	struct drm_clip_rect *clip = &helper->dirty_clip;
984 	unsigned long flags;
985 
986 	if (!helper->fb->funcs->dirty)
987 		return;
988 
989 	spin_lock_irqsave(&helper->dirty_lock, flags);
990 	clip->x1 = min_t(u32, clip->x1, x);
991 	clip->y1 = min_t(u32, clip->y1, y);
992 	clip->x2 = max_t(u32, clip->x2, x + width);
993 	clip->y2 = max_t(u32, clip->y2, y + height);
994 	spin_unlock_irqrestore(&helper->dirty_lock, flags);
995 
996 	schedule_work(&helper->dirty_work);
997 }
998 
999 /**
1000  * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1001  * @info: fb_info struct pointer
1002  * @pagelist: list of dirty mmap framebuffer pages
1003  *
1004  * This function is used as the &fb_deferred_io.deferred_io
1005  * callback function for flushing the fbdev mmap writes.
1006  */
1007 void drm_fb_helper_deferred_io(struct fb_info *info,
1008 			       struct list_head *pagelist)
1009 {
1010 	unsigned long start, end, min, max;
1011 	struct page *page;
1012 	u32 y1, y2;
1013 
1014 	min = ULONG_MAX;
1015 	max = 0;
1016 	list_for_each_entry(page, pagelist, lru) {
1017 		start = page->index << PAGE_SHIFT;
1018 		end = start + PAGE_SIZE - 1;
1019 		min = min(min, start);
1020 		max = max(max, end);
1021 	}
1022 
1023 	if (min < max) {
1024 		y1 = min / info->fix.line_length;
1025 		y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
1026 			   info->var.yres);
1027 		drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
1028 	}
1029 }
1030 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
1031 
1032 /**
1033  * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1034  * @fb_helper: driver-allocated fbdev helper
1035  *
1036  * This function allocates &fb_deferred_io, sets callback to
1037  * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1038  * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1039  * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1040  *
1041  * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1042  * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1043  * affect other instances of that &fb_ops.
1044  *
1045  * Returns:
1046  * 0 on success or a negative error code on failure.
1047  */
1048 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
1049 {
1050 	struct fb_info *info = fb_helper->fbdev;
1051 	struct fb_deferred_io *fbdefio;
1052 	struct fb_ops *fbops;
1053 
1054 	fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
1055 	fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
1056 	if (!fbdefio || !fbops) {
1057 		kfree(fbdefio);
1058 		kfree(fbops);
1059 		return -ENOMEM;
1060 	}
1061 
1062 	info->fbdefio = fbdefio;
1063 	fbdefio->delay = msecs_to_jiffies(50);
1064 	fbdefio->deferred_io = drm_fb_helper_deferred_io;
1065 
1066 	*fbops = *info->fbops;
1067 	info->fbops = fbops;
1068 
1069 	fb_deferred_io_init(info);
1070 
1071 	return 0;
1072 }
1073 EXPORT_SYMBOL(drm_fb_helper_defio_init);
1074 
1075 /**
1076  * drm_fb_helper_sys_read - wrapper around fb_sys_read
1077  * @info: fb_info struct pointer
1078  * @buf: userspace buffer to read from framebuffer memory
1079  * @count: number of bytes to read from framebuffer memory
1080  * @ppos: read offset within framebuffer memory
1081  *
1082  * A wrapper around fb_sys_read implemented by fbdev core
1083  */
1084 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
1085 			       size_t count, loff_t *ppos)
1086 {
1087 	return fb_sys_read(info, buf, count, ppos);
1088 }
1089 EXPORT_SYMBOL(drm_fb_helper_sys_read);
1090 
1091 /**
1092  * drm_fb_helper_sys_write - wrapper around fb_sys_write
1093  * @info: fb_info struct pointer
1094  * @buf: userspace buffer to write to framebuffer memory
1095  * @count: number of bytes to write to framebuffer memory
1096  * @ppos: write offset within framebuffer memory
1097  *
1098  * A wrapper around fb_sys_write implemented by fbdev core
1099  */
1100 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
1101 				size_t count, loff_t *ppos)
1102 {
1103 	ssize_t ret;
1104 
1105 	ret = fb_sys_write(info, buf, count, ppos);
1106 	if (ret > 0)
1107 		drm_fb_helper_dirty(info, 0, 0, info->var.xres,
1108 				    info->var.yres);
1109 
1110 	return ret;
1111 }
1112 EXPORT_SYMBOL(drm_fb_helper_sys_write);
1113 
1114 /**
1115  * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1116  * @info: fbdev registered by the helper
1117  * @rect: info about rectangle to fill
1118  *
1119  * A wrapper around sys_fillrect implemented by fbdev core
1120  */
1121 void drm_fb_helper_sys_fillrect(struct fb_info *info,
1122 				const struct fb_fillrect *rect)
1123 {
1124 	sys_fillrect(info, rect);
1125 	drm_fb_helper_dirty(info, rect->dx, rect->dy,
1126 			    rect->width, rect->height);
1127 }
1128 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
1129 
1130 /**
1131  * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1132  * @info: fbdev registered by the helper
1133  * @area: info about area to copy
1134  *
1135  * A wrapper around sys_copyarea implemented by fbdev core
1136  */
1137 void drm_fb_helper_sys_copyarea(struct fb_info *info,
1138 				const struct fb_copyarea *area)
1139 {
1140 	sys_copyarea(info, area);
1141 	drm_fb_helper_dirty(info, area->dx, area->dy,
1142 			    area->width, area->height);
1143 }
1144 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
1145 
1146 /**
1147  * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1148  * @info: fbdev registered by the helper
1149  * @image: info about image to blit
1150  *
1151  * A wrapper around sys_imageblit implemented by fbdev core
1152  */
1153 void drm_fb_helper_sys_imageblit(struct fb_info *info,
1154 				 const struct fb_image *image)
1155 {
1156 	sys_imageblit(info, image);
1157 	drm_fb_helper_dirty(info, image->dx, image->dy,
1158 			    image->width, image->height);
1159 }
1160 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
1161 
1162 /**
1163  * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1164  * @info: fbdev registered by the helper
1165  * @rect: info about rectangle to fill
1166  *
1167  * A wrapper around cfb_imageblit implemented by fbdev core
1168  */
1169 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1170 				const struct fb_fillrect *rect)
1171 {
1172 	cfb_fillrect(info, rect);
1173 	drm_fb_helper_dirty(info, rect->dx, rect->dy,
1174 			    rect->width, rect->height);
1175 }
1176 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1177 
1178 /**
1179  * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1180  * @info: fbdev registered by the helper
1181  * @area: info about area to copy
1182  *
1183  * A wrapper around cfb_copyarea implemented by fbdev core
1184  */
1185 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1186 				const struct fb_copyarea *area)
1187 {
1188 	cfb_copyarea(info, area);
1189 	drm_fb_helper_dirty(info, area->dx, area->dy,
1190 			    area->width, area->height);
1191 }
1192 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1193 
1194 /**
1195  * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1196  * @info: fbdev registered by the helper
1197  * @image: info about image to blit
1198  *
1199  * A wrapper around cfb_imageblit implemented by fbdev core
1200  */
1201 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1202 				 const struct fb_image *image)
1203 {
1204 	cfb_imageblit(info, image);
1205 	drm_fb_helper_dirty(info, image->dx, image->dy,
1206 			    image->width, image->height);
1207 }
1208 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1209 
1210 /**
1211  * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1212  * @fb_helper: driver-allocated fbdev helper, can be NULL
1213  * @suspend: whether to suspend or resume
1214  *
1215  * A wrapper around fb_set_suspend implemented by fbdev core.
1216  * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1217  * the lock yourself
1218  */
1219 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1220 {
1221 	if (fb_helper && fb_helper->fbdev)
1222 		fb_set_suspend(fb_helper->fbdev, suspend);
1223 }
1224 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1225 
1226 /**
1227  * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1228  *                                      takes the console lock
1229  * @fb_helper: driver-allocated fbdev helper, can be NULL
1230  * @suspend: whether to suspend or resume
1231  *
1232  * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1233  * isn't available on resume, a worker is tasked with waiting for the lock
1234  * to become available. The console lock can be pretty contented on resume
1235  * due to all the printk activity.
1236  *
1237  * This function can be called multiple times with the same state since
1238  * &fb_info.state is checked to see if fbdev is running or not before locking.
1239  *
1240  * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1241  */
1242 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1243 					bool suspend)
1244 {
1245 	if (!fb_helper || !fb_helper->fbdev)
1246 		return;
1247 
1248 	/* make sure there's no pending/ongoing resume */
1249 	flush_work(&fb_helper->resume_work);
1250 
1251 	if (suspend) {
1252 		if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1253 			return;
1254 
1255 		console_lock();
1256 
1257 	} else {
1258 		if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1259 			return;
1260 
1261 		if (!console_trylock()) {
1262 			schedule_work(&fb_helper->resume_work);
1263 			return;
1264 		}
1265 	}
1266 
1267 	fb_set_suspend(fb_helper->fbdev, suspend);
1268 	console_unlock();
1269 }
1270 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1271 
1272 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
1273 {
1274 	u32 *palette = (u32 *)info->pseudo_palette;
1275 	int i;
1276 
1277 	if (cmap->start + cmap->len > 16)
1278 		return -EINVAL;
1279 
1280 	for (i = 0; i < cmap->len; ++i) {
1281 		u16 red = cmap->red[i];
1282 		u16 green = cmap->green[i];
1283 		u16 blue = cmap->blue[i];
1284 		u32 value;
1285 
1286 		red >>= 16 - info->var.red.length;
1287 		green >>= 16 - info->var.green.length;
1288 		blue >>= 16 - info->var.blue.length;
1289 		value = (red << info->var.red.offset) |
1290 			(green << info->var.green.offset) |
1291 			(blue << info->var.blue.offset);
1292 		if (info->var.transp.length > 0) {
1293 			u32 mask = (1 << info->var.transp.length) - 1;
1294 
1295 			mask <<= info->var.transp.offset;
1296 			value |= mask;
1297 		}
1298 		palette[cmap->start + i] = value;
1299 	}
1300 
1301 	return 0;
1302 }
1303 
1304 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
1305 {
1306 	struct drm_fb_helper *fb_helper = info->par;
1307 	struct drm_crtc *crtc;
1308 	u16 *r, *g, *b;
1309 	int i, ret = 0;
1310 
1311 	drm_modeset_lock_all(fb_helper->dev);
1312 	for (i = 0; i < fb_helper->crtc_count; i++) {
1313 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
1314 		if (!crtc->funcs->gamma_set || !crtc->gamma_size)
1315 			return -EINVAL;
1316 
1317 		if (cmap->start + cmap->len > crtc->gamma_size)
1318 			return -EINVAL;
1319 
1320 		r = crtc->gamma_store;
1321 		g = r + crtc->gamma_size;
1322 		b = g + crtc->gamma_size;
1323 
1324 		memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1325 		memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1326 		memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1327 
1328 		ret = crtc->funcs->gamma_set(crtc, r, g, b,
1329 					     crtc->gamma_size, NULL);
1330 		if (ret)
1331 			return ret;
1332 	}
1333 	drm_modeset_unlock_all(fb_helper->dev);
1334 
1335 	return ret;
1336 }
1337 
1338 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
1339 						       struct fb_cmap *cmap)
1340 {
1341 	struct drm_device *dev = crtc->dev;
1342 	struct drm_property_blob *gamma_lut;
1343 	struct drm_color_lut *lut;
1344 	int size = crtc->gamma_size;
1345 	int i;
1346 
1347 	if (!size || cmap->start + cmap->len > size)
1348 		return ERR_PTR(-EINVAL);
1349 
1350 	gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1351 	if (IS_ERR(gamma_lut))
1352 		return gamma_lut;
1353 
1354 	lut = (struct drm_color_lut *)gamma_lut->data;
1355 	if (cmap->start || cmap->len != size) {
1356 		u16 *r = crtc->gamma_store;
1357 		u16 *g = r + crtc->gamma_size;
1358 		u16 *b = g + crtc->gamma_size;
1359 
1360 		for (i = 0; i < cmap->start; i++) {
1361 			lut[i].red = r[i];
1362 			lut[i].green = g[i];
1363 			lut[i].blue = b[i];
1364 		}
1365 		for (i = cmap->start + cmap->len; i < size; i++) {
1366 			lut[i].red = r[i];
1367 			lut[i].green = g[i];
1368 			lut[i].blue = b[i];
1369 		}
1370 	}
1371 
1372 	for (i = 0; i < cmap->len; i++) {
1373 		lut[cmap->start + i].red = cmap->red[i];
1374 		lut[cmap->start + i].green = cmap->green[i];
1375 		lut[cmap->start + i].blue = cmap->blue[i];
1376 	}
1377 
1378 	return gamma_lut;
1379 }
1380 
1381 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1382 {
1383 	struct drm_fb_helper *fb_helper = info->par;
1384 	struct drm_device *dev = fb_helper->dev;
1385 	struct drm_property_blob *gamma_lut = NULL;
1386 	struct drm_modeset_acquire_ctx ctx;
1387 	struct drm_crtc_state *crtc_state;
1388 	struct drm_atomic_state *state;
1389 	struct drm_crtc *crtc;
1390 	u16 *r, *g, *b;
1391 	int i, ret = 0;
1392 	bool replaced;
1393 
1394 	drm_modeset_acquire_init(&ctx, 0);
1395 
1396 	state = drm_atomic_state_alloc(dev);
1397 	if (!state) {
1398 		ret = -ENOMEM;
1399 		goto out_ctx;
1400 	}
1401 
1402 	state->acquire_ctx = &ctx;
1403 retry:
1404 	for (i = 0; i < fb_helper->crtc_count; i++) {
1405 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
1406 
1407 		if (!gamma_lut)
1408 			gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1409 		if (IS_ERR(gamma_lut)) {
1410 			ret = PTR_ERR(gamma_lut);
1411 			gamma_lut = NULL;
1412 			goto out_state;
1413 		}
1414 
1415 		crtc_state = drm_atomic_get_crtc_state(state, crtc);
1416 		if (IS_ERR(crtc_state)) {
1417 			ret = PTR_ERR(crtc_state);
1418 			goto out_state;
1419 		}
1420 
1421 		replaced  = drm_property_replace_blob(&crtc_state->degamma_lut,
1422 						      NULL);
1423 		replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1424 		replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1425 						      gamma_lut);
1426 		crtc_state->color_mgmt_changed |= replaced;
1427 	}
1428 
1429 	ret = drm_atomic_commit(state);
1430 	if (ret)
1431 		goto out_state;
1432 
1433 	for (i = 0; i < fb_helper->crtc_count; i++) {
1434 		crtc = fb_helper->crtc_info[i].mode_set.crtc;
1435 
1436 		r = crtc->gamma_store;
1437 		g = r + crtc->gamma_size;
1438 		b = g + crtc->gamma_size;
1439 
1440 		memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1441 		memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1442 		memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1443 	}
1444 
1445 out_state:
1446 	if (ret == -EDEADLK)
1447 		goto backoff;
1448 
1449 	drm_property_blob_put(gamma_lut);
1450 	drm_atomic_state_put(state);
1451 out_ctx:
1452 	drm_modeset_drop_locks(&ctx);
1453 	drm_modeset_acquire_fini(&ctx);
1454 
1455 	return ret;
1456 
1457 backoff:
1458 	drm_atomic_state_clear(state);
1459 	drm_modeset_backoff(&ctx);
1460 	goto retry;
1461 }
1462 
1463 /**
1464  * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1465  * @cmap: cmap to set
1466  * @info: fbdev registered by the helper
1467  */
1468 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1469 {
1470 	struct drm_fb_helper *fb_helper = info->par;
1471 	int ret;
1472 
1473 	if (oops_in_progress)
1474 		return -EBUSY;
1475 
1476 	mutex_lock(&fb_helper->lock);
1477 
1478 	if (!drm_fb_helper_is_bound(fb_helper)) {
1479 		ret = -EBUSY;
1480 		goto out;
1481 	}
1482 
1483 	if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1484 		ret = setcmap_pseudo_palette(cmap, info);
1485 	else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1486 		ret = setcmap_atomic(cmap, info);
1487 	else
1488 		ret = setcmap_legacy(cmap, info);
1489 
1490 out:
1491 	mutex_unlock(&fb_helper->lock);
1492 
1493 	return ret;
1494 }
1495 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1496 
1497 /**
1498  * drm_fb_helper_ioctl - legacy ioctl implementation
1499  * @info: fbdev registered by the helper
1500  * @cmd: ioctl command
1501  * @arg: ioctl argument
1502  *
1503  * A helper to implement the standard fbdev ioctl. Only
1504  * FBIO_WAITFORVSYNC is implemented for now.
1505  */
1506 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1507 			unsigned long arg)
1508 {
1509 	struct drm_fb_helper *fb_helper = info->par;
1510 	struct drm_mode_set *mode_set;
1511 	struct drm_crtc *crtc;
1512 	int ret = 0;
1513 
1514 	mutex_lock(&fb_helper->lock);
1515 	if (!drm_fb_helper_is_bound(fb_helper)) {
1516 		ret = -EBUSY;
1517 		goto unlock;
1518 	}
1519 
1520 	switch (cmd) {
1521 	case FBIO_WAITFORVSYNC:
1522 		/*
1523 		 * Only consider the first CRTC.
1524 		 *
1525 		 * This ioctl is supposed to take the CRTC number as
1526 		 * an argument, but in fbdev times, what that number
1527 		 * was supposed to be was quite unclear, different
1528 		 * drivers were passing that argument differently
1529 		 * (some by reference, some by value), and most of the
1530 		 * userspace applications were just hardcoding 0 as an
1531 		 * argument.
1532 		 *
1533 		 * The first CRTC should be the integrated panel on
1534 		 * most drivers, so this is the best choice we can
1535 		 * make. If we're not smart enough here, one should
1536 		 * just consider switch the userspace to KMS.
1537 		 */
1538 		mode_set = &fb_helper->crtc_info[0].mode_set;
1539 		crtc = mode_set->crtc;
1540 
1541 		/*
1542 		 * Only wait for a vblank event if the CRTC is
1543 		 * enabled, otherwise just don't do anythintg,
1544 		 * not even report an error.
1545 		 */
1546 		ret = drm_crtc_vblank_get(crtc);
1547 		if (!ret) {
1548 			drm_crtc_wait_one_vblank(crtc);
1549 			drm_crtc_vblank_put(crtc);
1550 		}
1551 
1552 		ret = 0;
1553 		goto unlock;
1554 	default:
1555 		ret = -ENOTTY;
1556 	}
1557 
1558 unlock:
1559 	mutex_unlock(&fb_helper->lock);
1560 	return ret;
1561 }
1562 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1563 
1564 /**
1565  * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1566  * @var: screeninfo to check
1567  * @info: fbdev registered by the helper
1568  */
1569 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1570 			    struct fb_info *info)
1571 {
1572 	struct drm_fb_helper *fb_helper = info->par;
1573 	struct drm_framebuffer *fb = fb_helper->fb;
1574 	int depth;
1575 
1576 	if (var->pixclock != 0 || in_dbg_master())
1577 		return -EINVAL;
1578 
1579 	/*
1580 	 * Changes struct fb_var_screeninfo are currently not pushed back
1581 	 * to KMS, hence fail if different settings are requested.
1582 	 */
1583 	if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1584 	    var->xres > fb->width || var->yres > fb->height ||
1585 	    var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1586 		DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1587 			  "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1588 			  var->xres, var->yres, var->bits_per_pixel,
1589 			  var->xres_virtual, var->yres_virtual,
1590 			  fb->width, fb->height, fb->format->cpp[0] * 8);
1591 		return -EINVAL;
1592 	}
1593 
1594 	switch (var->bits_per_pixel) {
1595 	case 16:
1596 		depth = (var->green.length == 6) ? 16 : 15;
1597 		break;
1598 	case 32:
1599 		depth = (var->transp.length > 0) ? 32 : 24;
1600 		break;
1601 	default:
1602 		depth = var->bits_per_pixel;
1603 		break;
1604 	}
1605 
1606 	switch (depth) {
1607 	case 8:
1608 		var->red.offset = 0;
1609 		var->green.offset = 0;
1610 		var->blue.offset = 0;
1611 		var->red.length = 8;
1612 		var->green.length = 8;
1613 		var->blue.length = 8;
1614 		var->transp.length = 0;
1615 		var->transp.offset = 0;
1616 		break;
1617 	case 15:
1618 		var->red.offset = 10;
1619 		var->green.offset = 5;
1620 		var->blue.offset = 0;
1621 		var->red.length = 5;
1622 		var->green.length = 5;
1623 		var->blue.length = 5;
1624 		var->transp.length = 1;
1625 		var->transp.offset = 15;
1626 		break;
1627 	case 16:
1628 		var->red.offset = 11;
1629 		var->green.offset = 5;
1630 		var->blue.offset = 0;
1631 		var->red.length = 5;
1632 		var->green.length = 6;
1633 		var->blue.length = 5;
1634 		var->transp.length = 0;
1635 		var->transp.offset = 0;
1636 		break;
1637 	case 24:
1638 		var->red.offset = 16;
1639 		var->green.offset = 8;
1640 		var->blue.offset = 0;
1641 		var->red.length = 8;
1642 		var->green.length = 8;
1643 		var->blue.length = 8;
1644 		var->transp.length = 0;
1645 		var->transp.offset = 0;
1646 		break;
1647 	case 32:
1648 		var->red.offset = 16;
1649 		var->green.offset = 8;
1650 		var->blue.offset = 0;
1651 		var->red.length = 8;
1652 		var->green.length = 8;
1653 		var->blue.length = 8;
1654 		var->transp.length = 8;
1655 		var->transp.offset = 24;
1656 		break;
1657 	default:
1658 		return -EINVAL;
1659 	}
1660 	return 0;
1661 }
1662 EXPORT_SYMBOL(drm_fb_helper_check_var);
1663 
1664 /**
1665  * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1666  * @info: fbdev registered by the helper
1667  *
1668  * This will let fbcon do the mode init and is called at initialization time by
1669  * the fbdev core when registering the driver, and later on through the hotplug
1670  * callback.
1671  */
1672 int drm_fb_helper_set_par(struct fb_info *info)
1673 {
1674 	struct drm_fb_helper *fb_helper = info->par;
1675 	struct fb_var_screeninfo *var = &info->var;
1676 
1677 	if (oops_in_progress)
1678 		return -EBUSY;
1679 
1680 	if (var->pixclock != 0) {
1681 		DRM_ERROR("PIXEL CLOCK SET\n");
1682 		return -EINVAL;
1683 	}
1684 
1685 	drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1686 
1687 	return 0;
1688 }
1689 EXPORT_SYMBOL(drm_fb_helper_set_par);
1690 
1691 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1692 {
1693 	int i;
1694 
1695 	for (i = 0; i < fb_helper->crtc_count; i++) {
1696 		struct drm_mode_set *mode_set;
1697 
1698 		mode_set = &fb_helper->crtc_info[i].mode_set;
1699 
1700 		mode_set->x = x;
1701 		mode_set->y = y;
1702 	}
1703 }
1704 
1705 static int pan_display_atomic(struct fb_var_screeninfo *var,
1706 			      struct fb_info *info)
1707 {
1708 	struct drm_fb_helper *fb_helper = info->par;
1709 	int ret;
1710 
1711 	pan_set(fb_helper, var->xoffset, var->yoffset);
1712 
1713 	ret = restore_fbdev_mode_atomic(fb_helper, true);
1714 	if (!ret) {
1715 		info->var.xoffset = var->xoffset;
1716 		info->var.yoffset = var->yoffset;
1717 	} else
1718 		pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1719 
1720 	return ret;
1721 }
1722 
1723 static int pan_display_legacy(struct fb_var_screeninfo *var,
1724 			      struct fb_info *info)
1725 {
1726 	struct drm_fb_helper *fb_helper = info->par;
1727 	struct drm_mode_set *modeset;
1728 	int ret = 0;
1729 	int i;
1730 
1731 	drm_modeset_lock_all(fb_helper->dev);
1732 	for (i = 0; i < fb_helper->crtc_count; i++) {
1733 		modeset = &fb_helper->crtc_info[i].mode_set;
1734 
1735 		modeset->x = var->xoffset;
1736 		modeset->y = var->yoffset;
1737 
1738 		if (modeset->num_connectors) {
1739 			ret = drm_mode_set_config_internal(modeset);
1740 			if (!ret) {
1741 				info->var.xoffset = var->xoffset;
1742 				info->var.yoffset = var->yoffset;
1743 			}
1744 		}
1745 	}
1746 	drm_modeset_unlock_all(fb_helper->dev);
1747 
1748 	return ret;
1749 }
1750 
1751 /**
1752  * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1753  * @var: updated screen information
1754  * @info: fbdev registered by the helper
1755  */
1756 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1757 			      struct fb_info *info)
1758 {
1759 	struct drm_fb_helper *fb_helper = info->par;
1760 	struct drm_device *dev = fb_helper->dev;
1761 	int ret;
1762 
1763 	if (oops_in_progress)
1764 		return -EBUSY;
1765 
1766 	mutex_lock(&fb_helper->lock);
1767 	if (!drm_fb_helper_is_bound(fb_helper)) {
1768 		mutex_unlock(&fb_helper->lock);
1769 		return -EBUSY;
1770 	}
1771 
1772 	if (drm_drv_uses_atomic_modeset(dev))
1773 		ret = pan_display_atomic(var, info);
1774 	else
1775 		ret = pan_display_legacy(var, info);
1776 	mutex_unlock(&fb_helper->lock);
1777 
1778 	return ret;
1779 }
1780 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1781 
1782 /*
1783  * Allocates the backing storage and sets up the fbdev info structure through
1784  * the ->fb_probe callback.
1785  */
1786 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1787 					 int preferred_bpp)
1788 {
1789 	int ret = 0;
1790 	int crtc_count = 0;
1791 	int i;
1792 	struct drm_fb_helper_surface_size sizes;
1793 	int gamma_size = 0;
1794 
1795 	memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1796 	sizes.surface_depth = 24;
1797 	sizes.surface_bpp = 32;
1798 	sizes.fb_width = (u32)-1;
1799 	sizes.fb_height = (u32)-1;
1800 
1801 	/* if driver picks 8 or 16 by default use that for both depth/bpp */
1802 	if (preferred_bpp != sizes.surface_bpp)
1803 		sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1804 
1805 	/* first up get a count of crtcs now in use and new min/maxes width/heights */
1806 	drm_fb_helper_for_each_connector(fb_helper, i) {
1807 		struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1808 		struct drm_cmdline_mode *cmdline_mode;
1809 
1810 		cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1811 
1812 		if (cmdline_mode->bpp_specified) {
1813 			switch (cmdline_mode->bpp) {
1814 			case 8:
1815 				sizes.surface_depth = sizes.surface_bpp = 8;
1816 				break;
1817 			case 15:
1818 				sizes.surface_depth = 15;
1819 				sizes.surface_bpp = 16;
1820 				break;
1821 			case 16:
1822 				sizes.surface_depth = sizes.surface_bpp = 16;
1823 				break;
1824 			case 24:
1825 				sizes.surface_depth = sizes.surface_bpp = 24;
1826 				break;
1827 			case 32:
1828 				sizes.surface_depth = 24;
1829 				sizes.surface_bpp = 32;
1830 				break;
1831 			}
1832 			break;
1833 		}
1834 	}
1835 
1836 	crtc_count = 0;
1837 	for (i = 0; i < fb_helper->crtc_count; i++) {
1838 		struct drm_display_mode *desired_mode;
1839 		struct drm_mode_set *mode_set;
1840 		int x, y, j;
1841 		/* in case of tile group, are we the last tile vert or horiz?
1842 		 * If no tile group you are always the last one both vertically
1843 		 * and horizontally
1844 		 */
1845 		bool lastv = true, lasth = true;
1846 
1847 		desired_mode = fb_helper->crtc_info[i].desired_mode;
1848 		mode_set = &fb_helper->crtc_info[i].mode_set;
1849 
1850 		if (!desired_mode)
1851 			continue;
1852 
1853 		crtc_count++;
1854 
1855 		x = fb_helper->crtc_info[i].x;
1856 		y = fb_helper->crtc_info[i].y;
1857 
1858 		if (gamma_size == 0)
1859 			gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1860 
1861 		sizes.surface_width  = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1862 		sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1863 
1864 		for (j = 0; j < mode_set->num_connectors; j++) {
1865 			struct drm_connector *connector = mode_set->connectors[j];
1866 
1867 			if (connector->has_tile) {
1868 				lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1869 				lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1870 				/* cloning to multiple tiles is just crazy-talk, so: */
1871 				break;
1872 			}
1873 		}
1874 
1875 		if (lasth)
1876 			sizes.fb_width  = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1877 		if (lastv)
1878 			sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1879 	}
1880 
1881 	if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1882 		DRM_INFO("Cannot find any crtc or sizes\n");
1883 
1884 		/* First time: disable all crtc's.. */
1885 		if (!fb_helper->deferred_setup && !READ_ONCE(fb_helper->dev->master))
1886 			restore_fbdev_mode(fb_helper);
1887 		return -EAGAIN;
1888 	}
1889 
1890 	/* Handle our overallocation */
1891 	sizes.surface_height *= drm_fbdev_overalloc;
1892 	sizes.surface_height /= 100;
1893 
1894 	/* push down into drivers */
1895 	ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1896 	if (ret < 0)
1897 		return ret;
1898 
1899 	strcpy(fb_helper->fb->comm, "[fbcon]");
1900 	return 0;
1901 }
1902 
1903 /**
1904  * drm_fb_helper_fill_fix - initializes fixed fbdev information
1905  * @info: fbdev registered by the helper
1906  * @pitch: desired pitch
1907  * @depth: desired depth
1908  *
1909  * Helper to fill in the fixed fbdev information useful for a non-accelerated
1910  * fbdev emulations. Drivers which support acceleration methods which impose
1911  * additional constraints need to set up their own limits.
1912  *
1913  * Drivers should call this (or their equivalent setup code) from their
1914  * &drm_fb_helper_funcs.fb_probe callback.
1915  */
1916 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1917 			    uint32_t depth)
1918 {
1919 	info->fix.type = FB_TYPE_PACKED_PIXELS;
1920 	info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1921 		FB_VISUAL_TRUECOLOR;
1922 	info->fix.mmio_start = 0;
1923 	info->fix.mmio_len = 0;
1924 	info->fix.type_aux = 0;
1925 	info->fix.xpanstep = 1; /* doing it in hw */
1926 	info->fix.ypanstep = 1; /* doing it in hw */
1927 	info->fix.ywrapstep = 0;
1928 	info->fix.accel = FB_ACCEL_NONE;
1929 
1930 	info->fix.line_length = pitch;
1931 }
1932 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1933 
1934 /**
1935  * drm_fb_helper_fill_var - initalizes variable fbdev information
1936  * @info: fbdev instance to set up
1937  * @fb_helper: fb helper instance to use as template
1938  * @fb_width: desired fb width
1939  * @fb_height: desired fb height
1940  *
1941  * Sets up the variable fbdev metainformation from the given fb helper instance
1942  * and the drm framebuffer allocated in &drm_fb_helper.fb.
1943  *
1944  * Drivers should call this (or their equivalent setup code) from their
1945  * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1946  * backing storage framebuffer.
1947  */
1948 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1949 			    uint32_t fb_width, uint32_t fb_height)
1950 {
1951 	struct drm_framebuffer *fb = fb_helper->fb;
1952 
1953 	info->pseudo_palette = fb_helper->pseudo_palette;
1954 	info->var.xres_virtual = fb->width;
1955 	info->var.yres_virtual = fb->height;
1956 	info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1957 	info->var.accel_flags = FB_ACCELF_TEXT;
1958 	info->var.xoffset = 0;
1959 	info->var.yoffset = 0;
1960 	info->var.activate = FB_ACTIVATE_NOW;
1961 
1962 	switch (fb->format->depth) {
1963 	case 8:
1964 		info->var.red.offset = 0;
1965 		info->var.green.offset = 0;
1966 		info->var.blue.offset = 0;
1967 		info->var.red.length = 8; /* 8bit DAC */
1968 		info->var.green.length = 8;
1969 		info->var.blue.length = 8;
1970 		info->var.transp.offset = 0;
1971 		info->var.transp.length = 0;
1972 		break;
1973 	case 15:
1974 		info->var.red.offset = 10;
1975 		info->var.green.offset = 5;
1976 		info->var.blue.offset = 0;
1977 		info->var.red.length = 5;
1978 		info->var.green.length = 5;
1979 		info->var.blue.length = 5;
1980 		info->var.transp.offset = 15;
1981 		info->var.transp.length = 1;
1982 		break;
1983 	case 16:
1984 		info->var.red.offset = 11;
1985 		info->var.green.offset = 5;
1986 		info->var.blue.offset = 0;
1987 		info->var.red.length = 5;
1988 		info->var.green.length = 6;
1989 		info->var.blue.length = 5;
1990 		info->var.transp.offset = 0;
1991 		break;
1992 	case 24:
1993 		info->var.red.offset = 16;
1994 		info->var.green.offset = 8;
1995 		info->var.blue.offset = 0;
1996 		info->var.red.length = 8;
1997 		info->var.green.length = 8;
1998 		info->var.blue.length = 8;
1999 		info->var.transp.offset = 0;
2000 		info->var.transp.length = 0;
2001 		break;
2002 	case 32:
2003 		info->var.red.offset = 16;
2004 		info->var.green.offset = 8;
2005 		info->var.blue.offset = 0;
2006 		info->var.red.length = 8;
2007 		info->var.green.length = 8;
2008 		info->var.blue.length = 8;
2009 		info->var.transp.offset = 24;
2010 		info->var.transp.length = 8;
2011 		break;
2012 	default:
2013 		break;
2014 	}
2015 
2016 	info->var.xres = fb_width;
2017 	info->var.yres = fb_height;
2018 }
2019 EXPORT_SYMBOL(drm_fb_helper_fill_var);
2020 
2021 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
2022 						uint32_t maxX,
2023 						uint32_t maxY)
2024 {
2025 	struct drm_connector *connector;
2026 	int i, count = 0;
2027 
2028 	drm_fb_helper_for_each_connector(fb_helper, i) {
2029 		connector = fb_helper->connector_info[i]->connector;
2030 		count += connector->funcs->fill_modes(connector, maxX, maxY);
2031 	}
2032 
2033 	return count;
2034 }
2035 
2036 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
2037 {
2038 	struct drm_display_mode *mode;
2039 
2040 	list_for_each_entry(mode, &fb_connector->connector->modes, head) {
2041 		if (mode->hdisplay > width ||
2042 		    mode->vdisplay > height)
2043 			continue;
2044 		if (mode->type & DRM_MODE_TYPE_PREFERRED)
2045 			return mode;
2046 	}
2047 	return NULL;
2048 }
2049 EXPORT_SYMBOL(drm_has_preferred_mode);
2050 
2051 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
2052 {
2053 	return fb_connector->connector->cmdline_mode.specified;
2054 }
2055 
2056 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn)
2057 {
2058 	struct drm_cmdline_mode *cmdline_mode;
2059 	struct drm_display_mode *mode;
2060 	bool prefer_non_interlace;
2061 
2062 	cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
2063 	if (cmdline_mode->specified == false)
2064 		return NULL;
2065 
2066 	/* attempt to find a matching mode in the list of modes
2067 	 *  we have gotten so far, if not add a CVT mode that conforms
2068 	 */
2069 	if (cmdline_mode->rb || cmdline_mode->margins)
2070 		goto create_mode;
2071 
2072 	prefer_non_interlace = !cmdline_mode->interlace;
2073 again:
2074 	list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2075 		/* check width/height */
2076 		if (mode->hdisplay != cmdline_mode->xres ||
2077 		    mode->vdisplay != cmdline_mode->yres)
2078 			continue;
2079 
2080 		if (cmdline_mode->refresh_specified) {
2081 			if (mode->vrefresh != cmdline_mode->refresh)
2082 				continue;
2083 		}
2084 
2085 		if (cmdline_mode->interlace) {
2086 			if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
2087 				continue;
2088 		} else if (prefer_non_interlace) {
2089 			if (mode->flags & DRM_MODE_FLAG_INTERLACE)
2090 				continue;
2091 		}
2092 		return mode;
2093 	}
2094 
2095 	if (prefer_non_interlace) {
2096 		prefer_non_interlace = false;
2097 		goto again;
2098 	}
2099 
2100 create_mode:
2101 	mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
2102 						 cmdline_mode);
2103 	list_add(&mode->head, &fb_helper_conn->connector->modes);
2104 	return mode;
2105 }
2106 EXPORT_SYMBOL(drm_pick_cmdline_mode);
2107 
2108 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
2109 {
2110 	bool enable;
2111 
2112 	if (connector->display_info.non_desktop)
2113 		return false;
2114 
2115 	if (strict)
2116 		enable = connector->status == connector_status_connected;
2117 	else
2118 		enable = connector->status != connector_status_disconnected;
2119 
2120 	return enable;
2121 }
2122 
2123 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
2124 				  bool *enabled)
2125 {
2126 	bool any_enabled = false;
2127 	struct drm_connector *connector;
2128 	int i = 0;
2129 
2130 	drm_fb_helper_for_each_connector(fb_helper, i) {
2131 		connector = fb_helper->connector_info[i]->connector;
2132 		enabled[i] = drm_connector_enabled(connector, true);
2133 		DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
2134 			      connector->display_info.non_desktop ? "non desktop" : enabled[i] ? "yes" : "no");
2135 
2136 		any_enabled |= enabled[i];
2137 	}
2138 
2139 	if (any_enabled)
2140 		return;
2141 
2142 	drm_fb_helper_for_each_connector(fb_helper, i) {
2143 		connector = fb_helper->connector_info[i]->connector;
2144 		enabled[i] = drm_connector_enabled(connector, false);
2145 	}
2146 }
2147 
2148 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
2149 			      struct drm_display_mode **modes,
2150 			      struct drm_fb_offset *offsets,
2151 			      bool *enabled, int width, int height)
2152 {
2153 	int count, i, j;
2154 	bool can_clone = false;
2155 	struct drm_fb_helper_connector *fb_helper_conn;
2156 	struct drm_display_mode *dmt_mode, *mode;
2157 
2158 	/* only contemplate cloning in the single crtc case */
2159 	if (fb_helper->crtc_count > 1)
2160 		return false;
2161 
2162 	count = 0;
2163 	drm_fb_helper_for_each_connector(fb_helper, i) {
2164 		if (enabled[i])
2165 			count++;
2166 	}
2167 
2168 	/* only contemplate cloning if more than one connector is enabled */
2169 	if (count <= 1)
2170 		return false;
2171 
2172 	/* check the command line or if nothing common pick 1024x768 */
2173 	can_clone = true;
2174 	drm_fb_helper_for_each_connector(fb_helper, i) {
2175 		if (!enabled[i])
2176 			continue;
2177 		fb_helper_conn = fb_helper->connector_info[i];
2178 		modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2179 		if (!modes[i]) {
2180 			can_clone = false;
2181 			break;
2182 		}
2183 		for (j = 0; j < i; j++) {
2184 			if (!enabled[j])
2185 				continue;
2186 			if (!drm_mode_equal(modes[j], modes[i]))
2187 				can_clone = false;
2188 		}
2189 	}
2190 
2191 	if (can_clone) {
2192 		DRM_DEBUG_KMS("can clone using command line\n");
2193 		return true;
2194 	}
2195 
2196 	/* try and find a 1024x768 mode on each connector */
2197 	can_clone = true;
2198 	dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
2199 
2200 	drm_fb_helper_for_each_connector(fb_helper, i) {
2201 		if (!enabled[i])
2202 			continue;
2203 
2204 		fb_helper_conn = fb_helper->connector_info[i];
2205 		list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2206 			if (drm_mode_equal(mode, dmt_mode))
2207 				modes[i] = mode;
2208 		}
2209 		if (!modes[i])
2210 			can_clone = false;
2211 	}
2212 
2213 	if (can_clone) {
2214 		DRM_DEBUG_KMS("can clone using 1024x768\n");
2215 		return true;
2216 	}
2217 	DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2218 	return false;
2219 }
2220 
2221 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
2222 				struct drm_display_mode **modes,
2223 				struct drm_fb_offset *offsets,
2224 				int idx,
2225 				int h_idx, int v_idx)
2226 {
2227 	struct drm_fb_helper_connector *fb_helper_conn;
2228 	int i;
2229 	int hoffset = 0, voffset = 0;
2230 
2231 	drm_fb_helper_for_each_connector(fb_helper, i) {
2232 		fb_helper_conn = fb_helper->connector_info[i];
2233 		if (!fb_helper_conn->connector->has_tile)
2234 			continue;
2235 
2236 		if (!modes[i] && (h_idx || v_idx)) {
2237 			DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
2238 				      fb_helper_conn->connector->base.id);
2239 			continue;
2240 		}
2241 		if (fb_helper_conn->connector->tile_h_loc < h_idx)
2242 			hoffset += modes[i]->hdisplay;
2243 
2244 		if (fb_helper_conn->connector->tile_v_loc < v_idx)
2245 			voffset += modes[i]->vdisplay;
2246 	}
2247 	offsets[idx].x = hoffset;
2248 	offsets[idx].y = voffset;
2249 	DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
2250 	return 0;
2251 }
2252 
2253 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
2254 				 struct drm_display_mode **modes,
2255 				 struct drm_fb_offset *offsets,
2256 				 bool *enabled, int width, int height)
2257 {
2258 	struct drm_fb_helper_connector *fb_helper_conn;
2259 	const u64 mask = BIT_ULL(fb_helper->connector_count) - 1;
2260 	u64 conn_configured = 0;
2261 	int tile_pass = 0;
2262 	int i;
2263 
2264 retry:
2265 	drm_fb_helper_for_each_connector(fb_helper, i) {
2266 		fb_helper_conn = fb_helper->connector_info[i];
2267 
2268 		if (conn_configured & BIT_ULL(i))
2269 			continue;
2270 
2271 		if (enabled[i] == false) {
2272 			conn_configured |= BIT_ULL(i);
2273 			continue;
2274 		}
2275 
2276 		/* first pass over all the untiled connectors */
2277 		if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
2278 			continue;
2279 
2280 		if (tile_pass == 1) {
2281 			if (fb_helper_conn->connector->tile_h_loc != 0 ||
2282 			    fb_helper_conn->connector->tile_v_loc != 0)
2283 				continue;
2284 
2285 		} else {
2286 			if (fb_helper_conn->connector->tile_h_loc != tile_pass - 1 &&
2287 			    fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
2288 			/* if this tile_pass doesn't cover any of the tiles - keep going */
2289 				continue;
2290 
2291 			/*
2292 			 * find the tile offsets for this pass - need to find
2293 			 * all tiles left and above
2294 			 */
2295 			drm_get_tile_offsets(fb_helper, modes, offsets,
2296 					     i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
2297 		}
2298 		DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2299 			      fb_helper_conn->connector->base.id);
2300 
2301 		/* got for command line mode first */
2302 		modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2303 		if (!modes[i]) {
2304 			DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2305 				      fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
2306 			modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
2307 		}
2308 		/* No preferred modes, pick one off the list */
2309 		if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
2310 			list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
2311 				break;
2312 		}
2313 		DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
2314 			  "none");
2315 		conn_configured |= BIT_ULL(i);
2316 	}
2317 
2318 	if ((conn_configured & mask) != mask) {
2319 		tile_pass++;
2320 		goto retry;
2321 	}
2322 	return true;
2323 }
2324 
2325 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
2326 			  struct drm_fb_helper_crtc **best_crtcs,
2327 			  struct drm_display_mode **modes,
2328 			  int n, int width, int height)
2329 {
2330 	int c, o;
2331 	struct drm_connector *connector;
2332 	const struct drm_connector_helper_funcs *connector_funcs;
2333 	struct drm_encoder *encoder;
2334 	int my_score, best_score, score;
2335 	struct drm_fb_helper_crtc **crtcs, *crtc;
2336 	struct drm_fb_helper_connector *fb_helper_conn;
2337 
2338 	if (n == fb_helper->connector_count)
2339 		return 0;
2340 
2341 	fb_helper_conn = fb_helper->connector_info[n];
2342 	connector = fb_helper_conn->connector;
2343 
2344 	best_crtcs[n] = NULL;
2345 	best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2346 	if (modes[n] == NULL)
2347 		return best_score;
2348 
2349 	crtcs = kcalloc(fb_helper->connector_count,
2350 			sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2351 	if (!crtcs)
2352 		return best_score;
2353 
2354 	my_score = 1;
2355 	if (connector->status == connector_status_connected)
2356 		my_score++;
2357 	if (drm_has_cmdline_mode(fb_helper_conn))
2358 		my_score++;
2359 	if (drm_has_preferred_mode(fb_helper_conn, width, height))
2360 		my_score++;
2361 
2362 	connector_funcs = connector->helper_private;
2363 
2364 	/*
2365 	 * If the DRM device implements atomic hooks and ->best_encoder() is
2366 	 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2367 	 * helper.
2368 	 */
2369 	if (drm_drv_uses_atomic_modeset(fb_helper->dev) &&
2370 	    !connector_funcs->best_encoder)
2371 		encoder = drm_atomic_helper_best_encoder(connector);
2372 	else
2373 		encoder = connector_funcs->best_encoder(connector);
2374 
2375 	if (!encoder)
2376 		goto out;
2377 
2378 	/*
2379 	 * select a crtc for this connector and then attempt to configure
2380 	 * remaining connectors
2381 	 */
2382 	for (c = 0; c < fb_helper->crtc_count; c++) {
2383 		crtc = &fb_helper->crtc_info[c];
2384 
2385 		if ((encoder->possible_crtcs & (1 << c)) == 0)
2386 			continue;
2387 
2388 		for (o = 0; o < n; o++)
2389 			if (best_crtcs[o] == crtc)
2390 				break;
2391 
2392 		if (o < n) {
2393 			/* ignore cloning unless only a single crtc */
2394 			if (fb_helper->crtc_count > 1)
2395 				continue;
2396 
2397 			if (!drm_mode_equal(modes[o], modes[n]))
2398 				continue;
2399 		}
2400 
2401 		crtcs[n] = crtc;
2402 		memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2403 		score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2404 						  width, height);
2405 		if (score > best_score) {
2406 			best_score = score;
2407 			memcpy(best_crtcs, crtcs,
2408 			       fb_helper->connector_count *
2409 			       sizeof(struct drm_fb_helper_crtc *));
2410 		}
2411 	}
2412 out:
2413 	kfree(crtcs);
2414 	return best_score;
2415 }
2416 
2417 /*
2418  * This function checks if rotation is necessary because of panel orientation
2419  * and if it is, if it is supported.
2420  * If rotation is necessary and supported, its gets set in fb_crtc.rotation.
2421  * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2422  * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2423  * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2424  * the unsupported rotation.
2425  */
2426 static void drm_setup_crtc_rotation(struct drm_fb_helper *fb_helper,
2427 				    struct drm_fb_helper_crtc *fb_crtc,
2428 				    struct drm_connector *connector)
2429 {
2430 	struct drm_plane *plane = fb_crtc->mode_set.crtc->primary;
2431 	uint64_t valid_mask = 0;
2432 	int i, rotation;
2433 
2434 	fb_crtc->rotation = DRM_MODE_ROTATE_0;
2435 
2436 	switch (connector->display_info.panel_orientation) {
2437 	case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP:
2438 		rotation = DRM_MODE_ROTATE_180;
2439 		break;
2440 	case DRM_MODE_PANEL_ORIENTATION_LEFT_UP:
2441 		rotation = DRM_MODE_ROTATE_90;
2442 		break;
2443 	case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP:
2444 		rotation = DRM_MODE_ROTATE_270;
2445 		break;
2446 	default:
2447 		rotation = DRM_MODE_ROTATE_0;
2448 	}
2449 
2450 	/*
2451 	 * TODO: support 90 / 270 degree hardware rotation,
2452 	 * depending on the hardware this may require the framebuffer
2453 	 * to be in a specific tiling format.
2454 	 */
2455 	if (rotation != DRM_MODE_ROTATE_180 || !plane->rotation_property) {
2456 		fb_helper->sw_rotations |= rotation;
2457 		return;
2458 	}
2459 
2460 	for (i = 0; i < plane->rotation_property->num_values; i++)
2461 		valid_mask |= (1ULL << plane->rotation_property->values[i]);
2462 
2463 	if (!(rotation & valid_mask)) {
2464 		fb_helper->sw_rotations |= rotation;
2465 		return;
2466 	}
2467 
2468 	fb_crtc->rotation = rotation;
2469 	/* Rotating in hardware, fbcon should not rotate */
2470 	fb_helper->sw_rotations |= DRM_MODE_ROTATE_0;
2471 }
2472 
2473 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper,
2474 			    u32 width, u32 height)
2475 {
2476 	struct drm_device *dev = fb_helper->dev;
2477 	struct drm_fb_helper_crtc **crtcs;
2478 	struct drm_display_mode **modes;
2479 	struct drm_fb_offset *offsets;
2480 	bool *enabled;
2481 	int i;
2482 
2483 	DRM_DEBUG_KMS("\n");
2484 	/* prevent concurrent modification of connector_count by hotplug */
2485 	lockdep_assert_held(&fb_helper->lock);
2486 
2487 	crtcs = kcalloc(fb_helper->connector_count,
2488 			sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2489 	modes = kcalloc(fb_helper->connector_count,
2490 			sizeof(struct drm_display_mode *), GFP_KERNEL);
2491 	offsets = kcalloc(fb_helper->connector_count,
2492 			  sizeof(struct drm_fb_offset), GFP_KERNEL);
2493 	enabled = kcalloc(fb_helper->connector_count,
2494 			  sizeof(bool), GFP_KERNEL);
2495 	if (!crtcs || !modes || !enabled || !offsets) {
2496 		DRM_ERROR("Memory allocation failed\n");
2497 		goto out;
2498 	}
2499 
2500 	mutex_lock(&fb_helper->dev->mode_config.mutex);
2501 	if (drm_fb_helper_probe_connector_modes(fb_helper, width, height) == 0)
2502 		DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2503 	drm_enable_connectors(fb_helper, enabled);
2504 
2505 	if (!(fb_helper->funcs->initial_config &&
2506 	      fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2507 					       offsets,
2508 					       enabled, width, height))) {
2509 		memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2510 		memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2511 		memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2512 
2513 		if (!drm_target_cloned(fb_helper, modes, offsets,
2514 				       enabled, width, height) &&
2515 		    !drm_target_preferred(fb_helper, modes, offsets,
2516 					  enabled, width, height))
2517 			DRM_ERROR("Unable to find initial modes\n");
2518 
2519 		DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2520 			      width, height);
2521 
2522 		drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2523 	}
2524 	mutex_unlock(&fb_helper->dev->mode_config.mutex);
2525 
2526 	/* need to set the modesets up here for use later */
2527 	/* fill out the connector<->crtc mappings into the modesets */
2528 	for (i = 0; i < fb_helper->crtc_count; i++)
2529 		drm_fb_helper_modeset_release(fb_helper,
2530 					      &fb_helper->crtc_info[i].mode_set);
2531 
2532 	fb_helper->sw_rotations = 0;
2533 	drm_fb_helper_for_each_connector(fb_helper, i) {
2534 		struct drm_display_mode *mode = modes[i];
2535 		struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2536 		struct drm_fb_offset *offset = &offsets[i];
2537 
2538 		if (mode && fb_crtc) {
2539 			struct drm_mode_set *modeset = &fb_crtc->mode_set;
2540 			struct drm_connector *connector =
2541 				fb_helper->connector_info[i]->connector;
2542 
2543 			DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2544 				      mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2545 
2546 			fb_crtc->desired_mode = mode;
2547 			fb_crtc->x = offset->x;
2548 			fb_crtc->y = offset->y;
2549 			modeset->mode = drm_mode_duplicate(dev,
2550 							   fb_crtc->desired_mode);
2551 			drm_connector_get(connector);
2552 			drm_setup_crtc_rotation(fb_helper, fb_crtc, connector);
2553 			modeset->connectors[modeset->num_connectors++] = connector;
2554 			modeset->x = offset->x;
2555 			modeset->y = offset->y;
2556 		}
2557 	}
2558 out:
2559 	kfree(crtcs);
2560 	kfree(modes);
2561 	kfree(offsets);
2562 	kfree(enabled);
2563 }
2564 
2565 /*
2566  * This is a continuation of drm_setup_crtcs() that sets up anything related
2567  * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2568  * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2569  * So, any setup that touches those fields needs to be done here instead of in
2570  * drm_setup_crtcs().
2571  */
2572 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
2573 {
2574 	struct fb_info *info = fb_helper->fbdev;
2575 	int i;
2576 
2577 	for (i = 0; i < fb_helper->crtc_count; i++)
2578 		if (fb_helper->crtc_info[i].mode_set.num_connectors)
2579 			fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
2580 
2581 	mutex_lock(&fb_helper->dev->mode_config.mutex);
2582 	drm_fb_helper_for_each_connector(fb_helper, i) {
2583 		struct drm_connector *connector =
2584 					fb_helper->connector_info[i]->connector;
2585 
2586 		/* use first connected connector for the physical dimensions */
2587 		if (connector->status == connector_status_connected) {
2588 			info->var.width = connector->display_info.width_mm;
2589 			info->var.height = connector->display_info.height_mm;
2590 			break;
2591 		}
2592 	}
2593 	mutex_unlock(&fb_helper->dev->mode_config.mutex);
2594 
2595 	switch (fb_helper->sw_rotations) {
2596 	case DRM_MODE_ROTATE_0:
2597 		info->fbcon_rotate_hint = FB_ROTATE_UR;
2598 		break;
2599 	case DRM_MODE_ROTATE_90:
2600 		info->fbcon_rotate_hint = FB_ROTATE_CCW;
2601 		break;
2602 	case DRM_MODE_ROTATE_180:
2603 		info->fbcon_rotate_hint = FB_ROTATE_UD;
2604 		break;
2605 	case DRM_MODE_ROTATE_270:
2606 		info->fbcon_rotate_hint = FB_ROTATE_CW;
2607 		break;
2608 	default:
2609 		/*
2610 		 * Multiple bits are set / multiple rotations requested
2611 		 * fbcon cannot handle separate rotation settings per
2612 		 * output, so fallback to unrotated.
2613 		 */
2614 		info->fbcon_rotate_hint = FB_ROTATE_UR;
2615 	}
2616 }
2617 
2618 /* Note: Drops fb_helper->lock before returning. */
2619 static int
2620 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
2621 					  int bpp_sel)
2622 {
2623 	struct drm_device *dev = fb_helper->dev;
2624 	struct fb_info *info;
2625 	unsigned int width, height;
2626 	int ret;
2627 
2628 	width = dev->mode_config.max_width;
2629 	height = dev->mode_config.max_height;
2630 
2631 	drm_setup_crtcs(fb_helper, width, height);
2632 	ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2633 	if (ret < 0) {
2634 		if (ret == -EAGAIN) {
2635 			fb_helper->preferred_bpp = bpp_sel;
2636 			fb_helper->deferred_setup = true;
2637 			ret = 0;
2638 		}
2639 		mutex_unlock(&fb_helper->lock);
2640 
2641 		return ret;
2642 	}
2643 	drm_setup_crtcs_fb(fb_helper);
2644 
2645 	fb_helper->deferred_setup = false;
2646 
2647 	info = fb_helper->fbdev;
2648 	info->var.pixclock = 0;
2649 
2650 	/* Need to drop locks to avoid recursive deadlock in
2651 	 * register_framebuffer. This is ok because the only thing left to do is
2652 	 * register the fbdev emulation instance in kernel_fb_helper_list. */
2653 	mutex_unlock(&fb_helper->lock);
2654 
2655 	ret = register_framebuffer(info);
2656 	if (ret < 0)
2657 		return ret;
2658 
2659 	dev_info(dev->dev, "fb%d: %s frame buffer device\n",
2660 		 info->node, info->fix.id);
2661 
2662 	mutex_lock(&kernel_fb_helper_lock);
2663 	if (list_empty(&kernel_fb_helper_list))
2664 		register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2665 
2666 	list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2667 	mutex_unlock(&kernel_fb_helper_lock);
2668 
2669 	return 0;
2670 }
2671 
2672 /**
2673  * drm_fb_helper_initial_config - setup a sane initial connector configuration
2674  * @fb_helper: fb_helper device struct
2675  * @bpp_sel: bpp value to use for the framebuffer configuration
2676  *
2677  * Scans the CRTCs and connectors and tries to put together an initial setup.
2678  * At the moment, this is a cloned configuration across all heads with
2679  * a new framebuffer object as the backing store.
2680  *
2681  * Note that this also registers the fbdev and so allows userspace to call into
2682  * the driver through the fbdev interfaces.
2683  *
2684  * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2685  * to let the driver allocate and initialize the fbdev info structure and the
2686  * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2687  * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2688  * values for the fbdev info structure.
2689  *
2690  * HANG DEBUGGING:
2691  *
2692  * When you have fbcon support built-in or already loaded, this function will do
2693  * a full modeset to setup the fbdev console. Due to locking misdesign in the
2694  * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2695  * console_lock. Until console_unlock is called no dmesg lines will be sent out
2696  * to consoles, not even serial console. This means when your driver crashes,
2697  * you will see absolutely nothing else but a system stuck in this function,
2698  * with no further output. Any kind of printk() you place within your own driver
2699  * or in the drm core modeset code will also never show up.
2700  *
2701  * Standard debug practice is to run the fbcon setup without taking the
2702  * console_lock as a hack, to be able to see backtraces and crashes on the
2703  * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2704  * cmdline option.
2705  *
2706  * The other option is to just disable fbdev emulation since very likely the
2707  * first modeset from userspace will crash in the same way, and is even easier
2708  * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2709  * kernel cmdline option.
2710  *
2711  * RETURNS:
2712  * Zero if everything went ok, nonzero otherwise.
2713  */
2714 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2715 {
2716 	int ret;
2717 
2718 	if (!drm_fbdev_emulation)
2719 		return 0;
2720 
2721 	mutex_lock(&fb_helper->lock);
2722 	ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
2723 
2724 	return ret;
2725 }
2726 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2727 
2728 /**
2729  * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2730  *                               probing all the outputs attached to the fb
2731  * @fb_helper: driver-allocated fbdev helper, can be NULL
2732  *
2733  * Scan the connectors attached to the fb_helper and try to put together a
2734  * setup after notification of a change in output configuration.
2735  *
2736  * Called at runtime, takes the mode config locks to be able to check/change the
2737  * modeset configuration. Must be run from process context (which usually means
2738  * either the output polling work or a work item launched from the driver's
2739  * hotplug interrupt).
2740  *
2741  * Note that drivers may call this even before calling
2742  * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2743  * for a race-free fbcon setup and will make sure that the fbdev emulation will
2744  * not miss any hotplug events.
2745  *
2746  * RETURNS:
2747  * 0 on success and a non-zero error code otherwise.
2748  */
2749 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2750 {
2751 	int err = 0;
2752 
2753 	if (!drm_fbdev_emulation || !fb_helper)
2754 		return 0;
2755 
2756 	mutex_lock(&fb_helper->lock);
2757 	if (fb_helper->deferred_setup) {
2758 		err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
2759 				fb_helper->preferred_bpp);
2760 		return err;
2761 	}
2762 
2763 	if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2764 		fb_helper->delayed_hotplug = true;
2765 		mutex_unlock(&fb_helper->lock);
2766 		return err;
2767 	}
2768 
2769 	DRM_DEBUG_KMS("\n");
2770 
2771 	drm_setup_crtcs(fb_helper, fb_helper->fb->width, fb_helper->fb->height);
2772 	drm_setup_crtcs_fb(fb_helper);
2773 	mutex_unlock(&fb_helper->lock);
2774 
2775 	drm_fb_helper_set_par(fb_helper->fbdev);
2776 
2777 	return 0;
2778 }
2779 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2780 
2781 /**
2782  * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2783  * @dev: DRM device
2784  * @fb_helper: fbdev helper structure to set up
2785  * @funcs: fbdev helper functions
2786  * @preferred_bpp: Preferred bits per pixel for the device.
2787  *                 @dev->mode_config.preferred_depth is used if this is zero.
2788  * @max_conn_count: Maximum number of connectors.
2789  *                  @dev->mode_config.num_connector is used if this is zero.
2790  *
2791  * This function sets up fbdev emulation and registers fbdev for access by
2792  * userspace. If all connectors are disconnected, setup is deferred to the next
2793  * time drm_fb_helper_hotplug_event() is called.
2794  * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2795  * function.
2796  *
2797  * See also: drm_fb_helper_initial_config()
2798  *
2799  * Returns:
2800  * Zero on success or negative error code on failure.
2801  */
2802 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
2803 			      struct drm_fb_helper *fb_helper,
2804 			      const struct drm_fb_helper_funcs *funcs,
2805 			      unsigned int preferred_bpp,
2806 			      unsigned int max_conn_count)
2807 {
2808 	int ret;
2809 
2810 	if (!preferred_bpp)
2811 		preferred_bpp = dev->mode_config.preferred_depth;
2812 	if (!preferred_bpp)
2813 		preferred_bpp = 32;
2814 
2815 	if (!max_conn_count)
2816 		max_conn_count = dev->mode_config.num_connector;
2817 	if (!max_conn_count) {
2818 		DRM_DEV_ERROR(dev->dev, "No connectors\n");
2819 		return -EINVAL;
2820 	}
2821 
2822 	drm_fb_helper_prepare(dev, fb_helper, funcs);
2823 
2824 	ret = drm_fb_helper_init(dev, fb_helper, max_conn_count);
2825 	if (ret < 0) {
2826 		DRM_DEV_ERROR(dev->dev, "Failed to initialize fbdev helper\n");
2827 		return ret;
2828 	}
2829 
2830 	ret = drm_fb_helper_single_add_all_connectors(fb_helper);
2831 	if (ret < 0) {
2832 		DRM_DEV_ERROR(dev->dev, "Failed to add connectors\n");
2833 		goto err_drm_fb_helper_fini;
2834 	}
2835 
2836 	if (!drm_drv_uses_atomic_modeset(dev))
2837 		drm_helper_disable_unused_functions(dev);
2838 
2839 	ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
2840 	if (ret < 0) {
2841 		DRM_DEV_ERROR(dev->dev, "Failed to set fbdev configuration\n");
2842 		goto err_drm_fb_helper_fini;
2843 	}
2844 
2845 	return 0;
2846 
2847 err_drm_fb_helper_fini:
2848 	drm_fb_helper_fini(fb_helper);
2849 
2850 	return ret;
2851 }
2852 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2853 
2854 /**
2855  * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2856  * @dev: DRM device
2857  *
2858  * This function unregisters fbdev if not already done and cleans up the
2859  * associated resources including the &drm_framebuffer.
2860  * The driver is responsible for freeing the &drm_fb_helper structure which is
2861  * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2862  * when this function returns.
2863  *
2864  * In order to support device removal/unplug while file handles are still open,
2865  * drm_fb_helper_unregister_fbi() should be called on device removal and
2866  * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2867  * file handles are closed.
2868  */
2869 void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2870 {
2871 	struct drm_fb_helper *fb_helper = dev->fb_helper;
2872 	struct fb_ops *fbops = NULL;
2873 
2874 	if (!fb_helper)
2875 		return;
2876 
2877 	/* Unregister if it hasn't been done already */
2878 	if (fb_helper->fbdev && fb_helper->fbdev->dev)
2879 		drm_fb_helper_unregister_fbi(fb_helper);
2880 
2881 	if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2882 		fb_deferred_io_cleanup(fb_helper->fbdev);
2883 		kfree(fb_helper->fbdev->fbdefio);
2884 		fbops = fb_helper->fbdev->fbops;
2885 	}
2886 
2887 	drm_fb_helper_fini(fb_helper);
2888 	kfree(fbops);
2889 
2890 	if (fb_helper->fb)
2891 		drm_framebuffer_remove(fb_helper->fb);
2892 }
2893 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2894 
2895 /**
2896  * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2897  * @dev: DRM device
2898  *
2899  * This function can be used as the &drm_driver->lastclose callback for drivers
2900  * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2901  */
2902 void drm_fb_helper_lastclose(struct drm_device *dev)
2903 {
2904 	drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2905 }
2906 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2907 
2908 /**
2909  * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2910  *                                     helper for fbdev emulation
2911  * @dev: DRM device
2912  *
2913  * This function can be used as the
2914  * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2915  * need to call drm_fb_helper_hotplug_event().
2916  */
2917 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2918 {
2919 	drm_fb_helper_hotplug_event(dev->fb_helper);
2920 }
2921 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2922 
2923 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2924  * but the module doesn't depend on any fb console symbols.  At least
2925  * attempt to load fbcon to avoid leaving the system without a usable console.
2926  */
2927 int __init drm_fb_helper_modinit(void)
2928 {
2929 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2930 	const char name[] = "fbcon";
2931 	struct module *fbcon;
2932 
2933 	mutex_lock(&module_mutex);
2934 	fbcon = find_module(name);
2935 	mutex_unlock(&module_mutex);
2936 
2937 	if (!fbcon)
2938 		request_module_nowait(name);
2939 #endif
2940 	return 0;
2941 }
2942 EXPORT_SYMBOL(drm_fb_helper_modinit);
2943