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