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