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