2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
6 * DRM framebuffer helper functions
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.
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
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/console.h>
33 #include <linux/dma-buf.h>
34 #include <linux/kernel.h>
35 #include <linux/module.h>
36 #include <linux/slab.h>
37 #include <linux/sysrq.h>
38 #include <linux/vmalloc.h>
40 #include <drm/drm_atomic.h>
41 #include <drm/drm_crtc.h>
42 #include <drm/drm_crtc_helper.h>
43 #include <drm/drm_drv.h>
44 #include <drm/drm_fb_helper.h>
45 #include <drm/drm_fourcc.h>
46 #include <drm/drm_print.h>
47 #include <drm/drm_vblank.h>
49 #include "drm_crtc_helper_internal.h"
50 #include "drm_internal.h"
52 static bool drm_fbdev_emulation = true;
53 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
54 MODULE_PARM_DESC(fbdev_emulation,
55 "Enable legacy fbdev emulation [default=true]");
57 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
58 module_param(drm_fbdev_overalloc, int, 0444);
59 MODULE_PARM_DESC(drm_fbdev_overalloc,
60 "Overallocation of the fbdev buffer (%) [default="
61 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
64 * In order to keep user-space compatibility, we want in certain use-cases
65 * to keep leaking the fbdev physical address to the user-space program
66 * handling the fbdev buffer.
67 * This is a bad habit essentially kept into closed source opengl driver
68 * that should really be moved into open-source upstream projects instead
69 * of using legacy physical addresses in user space to communicate with
70 * other out-of-tree kernel modules.
72 * This module_param *should* be removed as soon as possible and be
73 * considered as a broken and legacy behaviour from a modern fbdev device.
75 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
76 static bool drm_leak_fbdev_smem = false;
77 module_param_unsafe(drm_leak_fbdev_smem, bool, 0600);
78 MODULE_PARM_DESC(drm_leak_fbdev_smem,
79 "Allow unsafe leaking fbdev physical smem address [default=false]");
82 static LIST_HEAD(kernel_fb_helper_list);
83 static DEFINE_MUTEX(kernel_fb_helper_lock);
88 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
89 * mode setting driver. They can be used mostly independently from the crtc
90 * helper functions used by many drivers to implement the kernel mode setting
93 * Drivers that support a dumb buffer with a virtual address and mmap support,
94 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
96 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
97 * down by calling drm_fb_helper_fbdev_teardown().
99 * At runtime drivers should restore the fbdev console by using
100 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
101 * They should also notify the fb helper code from updates to the output
102 * configuration by using drm_fb_helper_output_poll_changed() as their
103 * &drm_mode_config_funcs.output_poll_changed callback.
105 * For suspend/resume consider using drm_mode_config_helper_suspend() and
106 * drm_mode_config_helper_resume() which takes care of fbdev as well.
108 * All other functions exported by the fb helper library can be used to
109 * implement the fbdev driver interface by the driver.
111 * It is possible, though perhaps somewhat tricky, to implement race-free
112 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
113 * helper must be called first to initialize the minimum required to make
114 * hotplug detection work. Drivers also need to make sure to properly set up
115 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
116 * it is safe to enable interrupts and start processing hotplug events. At the
117 * same time, drivers should initialize all modeset objects such as CRTCs,
118 * encoders and connectors. To finish up the fbdev helper initialization, the
119 * drm_fb_helper_init() function is called. To probe for all attached displays
120 * and set up an initial configuration using the detected hardware, drivers
121 * should call drm_fb_helper_initial_config().
123 * If &drm_framebuffer_funcs.dirty is set, the
124 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
125 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
126 * away. This worker then calls the dirty() function ensuring that it will
127 * always run in process context since the fb_*() function could be running in
128 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
129 * callback it will also schedule dirty_work with the damage collected from the
130 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
131 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
134 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
136 uint16_t *r_base, *g_base, *b_base;
138 if (crtc->funcs->gamma_set == NULL)
141 r_base = crtc->gamma_store;
142 g_base = r_base + crtc->gamma_size;
143 b_base = g_base + crtc->gamma_size;
145 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
146 crtc->gamma_size, NULL);
150 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
151 * @info: fbdev registered by the helper
153 int drm_fb_helper_debug_enter(struct fb_info *info)
155 struct drm_fb_helper *helper = info->par;
156 const struct drm_crtc_helper_funcs *funcs;
157 struct drm_mode_set *mode_set;
159 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
160 mutex_lock(&helper->client.modeset_mutex);
161 drm_client_for_each_modeset(mode_set, &helper->client) {
162 if (!mode_set->crtc->enabled)
165 funcs = mode_set->crtc->helper_private;
166 if (funcs->mode_set_base_atomic == NULL)
169 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
172 funcs->mode_set_base_atomic(mode_set->crtc,
176 ENTER_ATOMIC_MODE_SET);
178 mutex_unlock(&helper->client.modeset_mutex);
183 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
186 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
187 * @info: fbdev registered by the helper
189 int drm_fb_helper_debug_leave(struct fb_info *info)
191 struct drm_fb_helper *helper = info->par;
192 struct drm_client_dev *client = &helper->client;
193 struct drm_crtc *crtc;
194 const struct drm_crtc_helper_funcs *funcs;
195 struct drm_mode_set *mode_set;
196 struct drm_framebuffer *fb;
198 mutex_lock(&client->modeset_mutex);
199 drm_client_for_each_modeset(mode_set, client) {
200 crtc = mode_set->crtc;
201 if (drm_drv_uses_atomic_modeset(crtc->dev))
204 funcs = crtc->helper_private;
205 fb = crtc->primary->fb;
211 DRM_ERROR("no fb to restore??\n");
215 if (funcs->mode_set_base_atomic == NULL)
218 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
219 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
220 crtc->y, LEAVE_ATOMIC_MODE_SET);
222 mutex_unlock(&client->modeset_mutex);
226 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
229 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
230 * @fb_helper: driver-allocated fbdev helper, can be NULL
232 * This should be called from driver's drm &drm_driver.lastclose callback
233 * when implementing an fbcon on top of kms using this helper. This ensures that
234 * the user isn't greeted with a black screen when e.g. X dies.
237 * Zero if everything went ok, negative error code otherwise.
239 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
244 if (!drm_fbdev_emulation || !fb_helper)
247 if (READ_ONCE(fb_helper->deferred_setup))
250 mutex_lock(&fb_helper->lock);
253 * We should bail out here if there is a master by dropping _force.
254 * Currently these igt tests fail if we do that:
255 * - kms_fbcon_fbt@psr
256 * - kms_fbcon_fbt@psr-suspend
258 * So first these tests need to be fixed so they drop master or don't
261 ret = drm_client_modeset_commit_force(&fb_helper->client);
263 do_delayed = fb_helper->delayed_hotplug;
265 fb_helper->delayed_hotplug = false;
266 mutex_unlock(&fb_helper->lock);
269 drm_fb_helper_hotplug_event(fb_helper);
273 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
275 #ifdef CONFIG_MAGIC_SYSRQ
277 * restore fbcon display for all kms driver's using this helper, used for sysrq
278 * and panic handling.
280 static bool drm_fb_helper_force_kernel_mode(void)
282 bool ret, error = false;
283 struct drm_fb_helper *helper;
285 if (list_empty(&kernel_fb_helper_list))
288 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
289 struct drm_device *dev = helper->dev;
291 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
294 mutex_lock(&helper->lock);
295 ret = drm_client_modeset_commit_force(&helper->client);
298 mutex_unlock(&helper->lock);
303 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
307 ret = drm_fb_helper_force_kernel_mode();
309 DRM_ERROR("Failed to restore crtc configuration\n");
311 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
313 static void drm_fb_helper_sysrq(int dummy1)
315 schedule_work(&drm_fb_helper_restore_work);
318 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
319 .handler = drm_fb_helper_sysrq,
320 .help_msg = "force-fb(V)",
321 .action_msg = "Restore framebuffer console",
324 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
327 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
329 struct drm_fb_helper *fb_helper = info->par;
331 mutex_lock(&fb_helper->lock);
332 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
333 mutex_unlock(&fb_helper->lock);
337 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
338 * @blank: desired blanking state
339 * @info: fbdev registered by the helper
341 int drm_fb_helper_blank(int blank, struct fb_info *info)
343 if (oops_in_progress)
347 /* Display: On; HSync: On, VSync: On */
348 case FB_BLANK_UNBLANK:
349 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
351 /* Display: Off; HSync: On, VSync: On */
352 case FB_BLANK_NORMAL:
353 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
355 /* Display: Off; HSync: Off, VSync: On */
356 case FB_BLANK_HSYNC_SUSPEND:
357 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
359 /* Display: Off; HSync: On, VSync: Off */
360 case FB_BLANK_VSYNC_SUSPEND:
361 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
363 /* Display: Off; HSync: Off, VSync: Off */
364 case FB_BLANK_POWERDOWN:
365 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
370 EXPORT_SYMBOL(drm_fb_helper_blank);
372 static void drm_fb_helper_resume_worker(struct work_struct *work)
374 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
378 fb_set_suspend(helper->fbdev, 0);
382 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper *fb_helper,
383 struct drm_clip_rect *clip)
385 struct drm_framebuffer *fb = fb_helper->fb;
386 unsigned int cpp = fb->format->cpp[0];
387 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
388 void *src = fb_helper->fbdev->screen_buffer + offset;
389 void *dst = fb_helper->buffer->vaddr + offset;
390 size_t len = (clip->x2 - clip->x1) * cpp;
393 for (y = clip->y1; y < clip->y2; y++) {
394 memcpy(dst, src, len);
395 src += fb->pitches[0];
396 dst += fb->pitches[0];
400 static void drm_fb_helper_dirty_work(struct work_struct *work)
402 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
404 struct drm_clip_rect *clip = &helper->dirty_clip;
405 struct drm_clip_rect clip_copy;
409 spin_lock_irqsave(&helper->dirty_lock, flags);
411 clip->x1 = clip->y1 = ~0;
412 clip->x2 = clip->y2 = 0;
413 spin_unlock_irqrestore(&helper->dirty_lock, flags);
415 /* call dirty callback only when it has been really touched */
416 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2) {
418 /* Generic fbdev uses a shadow buffer */
419 if (helper->buffer) {
420 vaddr = drm_client_buffer_vmap(helper->buffer);
423 drm_fb_helper_dirty_blit_real(helper, &clip_copy);
425 if (helper->fb->funcs->dirty)
426 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0,
430 drm_client_buffer_vunmap(helper->buffer);
435 * drm_fb_helper_prepare - setup a drm_fb_helper structure
437 * @helper: driver-allocated fbdev helper structure to set up
438 * @funcs: pointer to structure of functions associate with this helper
440 * Sets up the bare minimum to make the framebuffer helper usable. This is
441 * useful to implement race-free initialization of the polling helpers.
443 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
444 const struct drm_fb_helper_funcs *funcs)
446 INIT_LIST_HEAD(&helper->kernel_fb_list);
447 spin_lock_init(&helper->dirty_lock);
448 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
449 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
450 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
451 mutex_init(&helper->lock);
452 helper->funcs = funcs;
455 EXPORT_SYMBOL(drm_fb_helper_prepare);
458 * drm_fb_helper_init - initialize a &struct drm_fb_helper
460 * @fb_helper: driver-allocated fbdev helper structure to initialize
461 * @max_conn_count: max connector count (not used)
463 * This allocates the structures for the fbdev helper with the given limits.
464 * Note that this won't yet touch the hardware (through the driver interfaces)
465 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
466 * to allow driver writes more control over the exact init sequence.
468 * Drivers must call drm_fb_helper_prepare() before calling this function.
471 * Zero if everything went ok, nonzero otherwise.
473 int drm_fb_helper_init(struct drm_device *dev,
474 struct drm_fb_helper *fb_helper,
479 if (!drm_fbdev_emulation) {
480 dev->fb_helper = fb_helper;
485 * If this is not the generic fbdev client, initialize a drm_client
486 * without callbacks so we can use the modesets.
488 if (!fb_helper->client.funcs) {
489 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
494 dev->fb_helper = fb_helper;
498 EXPORT_SYMBOL(drm_fb_helper_init);
501 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
502 * @fb_helper: driver-allocated fbdev helper
504 * A helper to alloc fb_info and the members cmap and apertures. Called
505 * by the driver within the fb_probe fb_helper callback function. Drivers do not
506 * need to release the allocated fb_info structure themselves, this is
507 * automatically done when calling drm_fb_helper_fini().
510 * fb_info pointer if things went okay, pointer containing error code
513 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
515 struct device *dev = fb_helper->dev->dev;
516 struct fb_info *info;
519 info = framebuffer_alloc(0, dev);
521 return ERR_PTR(-ENOMEM);
523 ret = fb_alloc_cmap(&info->cmap, 256, 0);
527 info->apertures = alloc_apertures(1);
528 if (!info->apertures) {
533 fb_helper->fbdev = info;
534 info->skip_vt_switch = true;
539 fb_dealloc_cmap(&info->cmap);
541 framebuffer_release(info);
544 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
547 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
548 * @fb_helper: driver-allocated fbdev helper, can be NULL
550 * A wrapper around unregister_framebuffer, to release the fb_info
551 * framebuffer device. This must be called before releasing all resources for
552 * @fb_helper by calling drm_fb_helper_fini().
554 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
556 if (fb_helper && fb_helper->fbdev)
557 unregister_framebuffer(fb_helper->fbdev);
559 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
562 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
563 * @fb_helper: driver-allocated fbdev helper, can be NULL
565 * This cleans up all remaining resources associated with @fb_helper. Must be
566 * called after drm_fb_helper_unlink_fbi() was called.
568 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
570 struct fb_info *info;
575 fb_helper->dev->fb_helper = NULL;
577 if (!drm_fbdev_emulation)
580 cancel_work_sync(&fb_helper->resume_work);
581 cancel_work_sync(&fb_helper->dirty_work);
583 info = fb_helper->fbdev;
586 fb_dealloc_cmap(&info->cmap);
587 framebuffer_release(info);
589 fb_helper->fbdev = NULL;
591 mutex_lock(&kernel_fb_helper_lock);
592 if (!list_empty(&fb_helper->kernel_fb_list)) {
593 list_del(&fb_helper->kernel_fb_list);
594 if (list_empty(&kernel_fb_helper_list))
595 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
597 mutex_unlock(&kernel_fb_helper_lock);
599 mutex_destroy(&fb_helper->lock);
601 if (!fb_helper->client.funcs)
602 drm_client_release(&fb_helper->client);
604 EXPORT_SYMBOL(drm_fb_helper_fini);
607 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
608 * @fb_helper: driver-allocated fbdev helper, can be NULL
610 * A wrapper around unlink_framebuffer implemented by fbdev core
612 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
614 if (fb_helper && fb_helper->fbdev)
615 unlink_framebuffer(fb_helper->fbdev);
617 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
619 static bool drm_fbdev_use_shadow_fb(struct drm_fb_helper *fb_helper)
621 struct drm_device *dev = fb_helper->dev;
622 struct drm_framebuffer *fb = fb_helper->fb;
624 return dev->mode_config.prefer_shadow_fbdev ||
625 dev->mode_config.prefer_shadow ||
629 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
630 u32 width, u32 height)
632 struct drm_fb_helper *helper = info->par;
633 struct drm_clip_rect *clip = &helper->dirty_clip;
636 if (!drm_fbdev_use_shadow_fb(helper))
639 spin_lock_irqsave(&helper->dirty_lock, flags);
640 clip->x1 = min_t(u32, clip->x1, x);
641 clip->y1 = min_t(u32, clip->y1, y);
642 clip->x2 = max_t(u32, clip->x2, x + width);
643 clip->y2 = max_t(u32, clip->y2, y + height);
644 spin_unlock_irqrestore(&helper->dirty_lock, flags);
646 schedule_work(&helper->dirty_work);
650 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
651 * @info: fb_info struct pointer
652 * @pagelist: list of dirty mmap framebuffer pages
654 * This function is used as the &fb_deferred_io.deferred_io
655 * callback function for flushing the fbdev mmap writes.
657 void drm_fb_helper_deferred_io(struct fb_info *info,
658 struct list_head *pagelist)
660 unsigned long start, end, min, max;
666 list_for_each_entry(page, pagelist, lru) {
667 start = page->index << PAGE_SHIFT;
668 end = start + PAGE_SIZE - 1;
669 min = min(min, start);
674 y1 = min / info->fix.line_length;
675 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
677 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
680 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
683 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
684 * @fb_helper: driver-allocated fbdev helper
686 * This function allocates &fb_deferred_io, sets callback to
687 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
688 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
689 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
691 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
692 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
693 * affect other instances of that &fb_ops.
696 * 0 on success or a negative error code on failure.
698 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
700 struct fb_info *info = fb_helper->fbdev;
701 struct fb_deferred_io *fbdefio;
702 struct fb_ops *fbops;
704 fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
705 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
706 if (!fbdefio || !fbops) {
712 info->fbdefio = fbdefio;
713 fbdefio->delay = msecs_to_jiffies(50);
714 fbdefio->deferred_io = drm_fb_helper_deferred_io;
716 *fbops = *info->fbops;
719 fb_deferred_io_init(info);
723 EXPORT_SYMBOL(drm_fb_helper_defio_init);
726 * drm_fb_helper_sys_read - wrapper around fb_sys_read
727 * @info: fb_info struct pointer
728 * @buf: userspace buffer to read from framebuffer memory
729 * @count: number of bytes to read from framebuffer memory
730 * @ppos: read offset within framebuffer memory
732 * A wrapper around fb_sys_read implemented by fbdev core
734 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
735 size_t count, loff_t *ppos)
737 return fb_sys_read(info, buf, count, ppos);
739 EXPORT_SYMBOL(drm_fb_helper_sys_read);
742 * drm_fb_helper_sys_write - wrapper around fb_sys_write
743 * @info: fb_info struct pointer
744 * @buf: userspace buffer to write to framebuffer memory
745 * @count: number of bytes to write to framebuffer memory
746 * @ppos: write offset within framebuffer memory
748 * A wrapper around fb_sys_write implemented by fbdev core
750 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
751 size_t count, loff_t *ppos)
755 ret = fb_sys_write(info, buf, count, ppos);
757 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
762 EXPORT_SYMBOL(drm_fb_helper_sys_write);
765 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
766 * @info: fbdev registered by the helper
767 * @rect: info about rectangle to fill
769 * A wrapper around sys_fillrect implemented by fbdev core
771 void drm_fb_helper_sys_fillrect(struct fb_info *info,
772 const struct fb_fillrect *rect)
774 sys_fillrect(info, rect);
775 drm_fb_helper_dirty(info, rect->dx, rect->dy,
776 rect->width, rect->height);
778 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
781 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
782 * @info: fbdev registered by the helper
783 * @area: info about area to copy
785 * A wrapper around sys_copyarea implemented by fbdev core
787 void drm_fb_helper_sys_copyarea(struct fb_info *info,
788 const struct fb_copyarea *area)
790 sys_copyarea(info, area);
791 drm_fb_helper_dirty(info, area->dx, area->dy,
792 area->width, area->height);
794 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
797 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
798 * @info: fbdev registered by the helper
799 * @image: info about image to blit
801 * A wrapper around sys_imageblit implemented by fbdev core
803 void drm_fb_helper_sys_imageblit(struct fb_info *info,
804 const struct fb_image *image)
806 sys_imageblit(info, image);
807 drm_fb_helper_dirty(info, image->dx, image->dy,
808 image->width, image->height);
810 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
813 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
814 * @info: fbdev registered by the helper
815 * @rect: info about rectangle to fill
817 * A wrapper around cfb_fillrect implemented by fbdev core
819 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
820 const struct fb_fillrect *rect)
822 cfb_fillrect(info, rect);
823 drm_fb_helper_dirty(info, rect->dx, rect->dy,
824 rect->width, rect->height);
826 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
829 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
830 * @info: fbdev registered by the helper
831 * @area: info about area to copy
833 * A wrapper around cfb_copyarea implemented by fbdev core
835 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
836 const struct fb_copyarea *area)
838 cfb_copyarea(info, area);
839 drm_fb_helper_dirty(info, area->dx, area->dy,
840 area->width, area->height);
842 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
845 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
846 * @info: fbdev registered by the helper
847 * @image: info about image to blit
849 * A wrapper around cfb_imageblit implemented by fbdev core
851 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
852 const struct fb_image *image)
854 cfb_imageblit(info, image);
855 drm_fb_helper_dirty(info, image->dx, image->dy,
856 image->width, image->height);
858 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
861 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
862 * @fb_helper: driver-allocated fbdev helper, can be NULL
863 * @suspend: whether to suspend or resume
865 * A wrapper around fb_set_suspend implemented by fbdev core.
866 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
869 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
871 if (fb_helper && fb_helper->fbdev)
872 fb_set_suspend(fb_helper->fbdev, suspend);
874 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
877 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
878 * takes the console lock
879 * @fb_helper: driver-allocated fbdev helper, can be NULL
880 * @suspend: whether to suspend or resume
882 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
883 * isn't available on resume, a worker is tasked with waiting for the lock
884 * to become available. The console lock can be pretty contented on resume
885 * due to all the printk activity.
887 * This function can be called multiple times with the same state since
888 * &fb_info.state is checked to see if fbdev is running or not before locking.
890 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
892 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
895 if (!fb_helper || !fb_helper->fbdev)
898 /* make sure there's no pending/ongoing resume */
899 flush_work(&fb_helper->resume_work);
902 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
908 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
911 if (!console_trylock()) {
912 schedule_work(&fb_helper->resume_work);
917 fb_set_suspend(fb_helper->fbdev, suspend);
920 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
922 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
924 u32 *palette = (u32 *)info->pseudo_palette;
927 if (cmap->start + cmap->len > 16)
930 for (i = 0; i < cmap->len; ++i) {
931 u16 red = cmap->red[i];
932 u16 green = cmap->green[i];
933 u16 blue = cmap->blue[i];
936 red >>= 16 - info->var.red.length;
937 green >>= 16 - info->var.green.length;
938 blue >>= 16 - info->var.blue.length;
939 value = (red << info->var.red.offset) |
940 (green << info->var.green.offset) |
941 (blue << info->var.blue.offset);
942 if (info->var.transp.length > 0) {
943 u32 mask = (1 << info->var.transp.length) - 1;
945 mask <<= info->var.transp.offset;
948 palette[cmap->start + i] = value;
954 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
956 struct drm_fb_helper *fb_helper = info->par;
957 struct drm_mode_set *modeset;
958 struct drm_crtc *crtc;
962 drm_modeset_lock_all(fb_helper->dev);
963 drm_client_for_each_modeset(modeset, &fb_helper->client) {
964 crtc = modeset->crtc;
965 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
968 if (cmap->start + cmap->len > crtc->gamma_size)
971 r = crtc->gamma_store;
972 g = r + crtc->gamma_size;
973 b = g + crtc->gamma_size;
975 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
976 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
977 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
979 ret = crtc->funcs->gamma_set(crtc, r, g, b,
980 crtc->gamma_size, NULL);
984 drm_modeset_unlock_all(fb_helper->dev);
989 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
990 struct fb_cmap *cmap)
992 struct drm_device *dev = crtc->dev;
993 struct drm_property_blob *gamma_lut;
994 struct drm_color_lut *lut;
995 int size = crtc->gamma_size;
998 if (!size || cmap->start + cmap->len > size)
999 return ERR_PTR(-EINVAL);
1001 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1002 if (IS_ERR(gamma_lut))
1005 lut = gamma_lut->data;
1006 if (cmap->start || cmap->len != size) {
1007 u16 *r = crtc->gamma_store;
1008 u16 *g = r + crtc->gamma_size;
1009 u16 *b = g + crtc->gamma_size;
1011 for (i = 0; i < cmap->start; i++) {
1013 lut[i].green = g[i];
1016 for (i = cmap->start + cmap->len; i < size; i++) {
1018 lut[i].green = g[i];
1023 for (i = 0; i < cmap->len; i++) {
1024 lut[cmap->start + i].red = cmap->red[i];
1025 lut[cmap->start + i].green = cmap->green[i];
1026 lut[cmap->start + i].blue = cmap->blue[i];
1032 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1034 struct drm_fb_helper *fb_helper = info->par;
1035 struct drm_device *dev = fb_helper->dev;
1036 struct drm_property_blob *gamma_lut = NULL;
1037 struct drm_modeset_acquire_ctx ctx;
1038 struct drm_crtc_state *crtc_state;
1039 struct drm_atomic_state *state;
1040 struct drm_mode_set *modeset;
1041 struct drm_crtc *crtc;
1046 drm_modeset_acquire_init(&ctx, 0);
1048 state = drm_atomic_state_alloc(dev);
1054 state->acquire_ctx = &ctx;
1056 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1057 crtc = modeset->crtc;
1060 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1061 if (IS_ERR(gamma_lut)) {
1062 ret = PTR_ERR(gamma_lut);
1067 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1068 if (IS_ERR(crtc_state)) {
1069 ret = PTR_ERR(crtc_state);
1073 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1075 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1076 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1078 crtc_state->color_mgmt_changed |= replaced;
1081 ret = drm_atomic_commit(state);
1085 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1086 crtc = modeset->crtc;
1088 r = crtc->gamma_store;
1089 g = r + crtc->gamma_size;
1090 b = g + crtc->gamma_size;
1092 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1093 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1094 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1098 if (ret == -EDEADLK)
1101 drm_property_blob_put(gamma_lut);
1102 drm_atomic_state_put(state);
1104 drm_modeset_drop_locks(&ctx);
1105 drm_modeset_acquire_fini(&ctx);
1110 drm_atomic_state_clear(state);
1111 drm_modeset_backoff(&ctx);
1116 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1117 * @cmap: cmap to set
1118 * @info: fbdev registered by the helper
1120 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1122 struct drm_fb_helper *fb_helper = info->par;
1123 struct drm_device *dev = fb_helper->dev;
1126 if (oops_in_progress)
1129 mutex_lock(&fb_helper->lock);
1131 if (!drm_master_internal_acquire(dev)) {
1136 mutex_lock(&fb_helper->client.modeset_mutex);
1137 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1138 ret = setcmap_pseudo_palette(cmap, info);
1139 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1140 ret = setcmap_atomic(cmap, info);
1142 ret = setcmap_legacy(cmap, info);
1143 mutex_unlock(&fb_helper->client.modeset_mutex);
1145 drm_master_internal_release(dev);
1147 mutex_unlock(&fb_helper->lock);
1151 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1154 * drm_fb_helper_ioctl - legacy ioctl implementation
1155 * @info: fbdev registered by the helper
1156 * @cmd: ioctl command
1157 * @arg: ioctl argument
1159 * A helper to implement the standard fbdev ioctl. Only
1160 * FBIO_WAITFORVSYNC is implemented for now.
1162 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1165 struct drm_fb_helper *fb_helper = info->par;
1166 struct drm_device *dev = fb_helper->dev;
1167 struct drm_crtc *crtc;
1170 mutex_lock(&fb_helper->lock);
1171 if (!drm_master_internal_acquire(dev)) {
1177 case FBIO_WAITFORVSYNC:
1179 * Only consider the first CRTC.
1181 * This ioctl is supposed to take the CRTC number as
1182 * an argument, but in fbdev times, what that number
1183 * was supposed to be was quite unclear, different
1184 * drivers were passing that argument differently
1185 * (some by reference, some by value), and most of the
1186 * userspace applications were just hardcoding 0 as an
1189 * The first CRTC should be the integrated panel on
1190 * most drivers, so this is the best choice we can
1191 * make. If we're not smart enough here, one should
1192 * just consider switch the userspace to KMS.
1194 crtc = fb_helper->client.modesets[0].crtc;
1197 * Only wait for a vblank event if the CRTC is
1198 * enabled, otherwise just don't do anythintg,
1199 * not even report an error.
1201 ret = drm_crtc_vblank_get(crtc);
1203 drm_crtc_wait_one_vblank(crtc);
1204 drm_crtc_vblank_put(crtc);
1213 drm_master_internal_release(dev);
1215 mutex_unlock(&fb_helper->lock);
1218 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1220 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1221 const struct fb_var_screeninfo *var_2)
1223 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1224 var_1->grayscale == var_2->grayscale &&
1225 var_1->red.offset == var_2->red.offset &&
1226 var_1->red.length == var_2->red.length &&
1227 var_1->red.msb_right == var_2->red.msb_right &&
1228 var_1->green.offset == var_2->green.offset &&
1229 var_1->green.length == var_2->green.length &&
1230 var_1->green.msb_right == var_2->green.msb_right &&
1231 var_1->blue.offset == var_2->blue.offset &&
1232 var_1->blue.length == var_2->blue.length &&
1233 var_1->blue.msb_right == var_2->blue.msb_right &&
1234 var_1->transp.offset == var_2->transp.offset &&
1235 var_1->transp.length == var_2->transp.length &&
1236 var_1->transp.msb_right == var_2->transp.msb_right;
1239 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1244 var->red.offset = 0;
1245 var->green.offset = 0;
1246 var->blue.offset = 0;
1247 var->red.length = 8; /* 8bit DAC */
1248 var->green.length = 8;
1249 var->blue.length = 8;
1250 var->transp.offset = 0;
1251 var->transp.length = 0;
1254 var->red.offset = 10;
1255 var->green.offset = 5;
1256 var->blue.offset = 0;
1257 var->red.length = 5;
1258 var->green.length = 5;
1259 var->blue.length = 5;
1260 var->transp.offset = 15;
1261 var->transp.length = 1;
1264 var->red.offset = 11;
1265 var->green.offset = 5;
1266 var->blue.offset = 0;
1267 var->red.length = 5;
1268 var->green.length = 6;
1269 var->blue.length = 5;
1270 var->transp.offset = 0;
1273 var->red.offset = 16;
1274 var->green.offset = 8;
1275 var->blue.offset = 0;
1276 var->red.length = 8;
1277 var->green.length = 8;
1278 var->blue.length = 8;
1279 var->transp.offset = 0;
1280 var->transp.length = 0;
1283 var->red.offset = 16;
1284 var->green.offset = 8;
1285 var->blue.offset = 0;
1286 var->red.length = 8;
1287 var->green.length = 8;
1288 var->blue.length = 8;
1289 var->transp.offset = 24;
1290 var->transp.length = 8;
1298 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1299 * @var: screeninfo to check
1300 * @info: fbdev registered by the helper
1302 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1303 struct fb_info *info)
1305 struct drm_fb_helper *fb_helper = info->par;
1306 struct drm_framebuffer *fb = fb_helper->fb;
1308 if (in_dbg_master())
1311 if (var->pixclock != 0) {
1312 DRM_DEBUG("fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1316 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1317 (drm_format_info_block_height(fb->format, 0) > 1))
1321 * Changes struct fb_var_screeninfo are currently not pushed back
1322 * to KMS, hence fail if different settings are requested.
1324 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1325 var->xres > fb->width || var->yres > fb->height ||
1326 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1327 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1328 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1329 var->xres, var->yres, var->bits_per_pixel,
1330 var->xres_virtual, var->yres_virtual,
1331 fb->width, fb->height, fb->format->cpp[0] * 8);
1336 * Workaround for SDL 1.2, which is known to be setting all pixel format
1337 * fields values to zero in some cases. We treat this situation as a
1338 * kind of "use some reasonable autodetected values".
1340 if (!var->red.offset && !var->green.offset &&
1341 !var->blue.offset && !var->transp.offset &&
1342 !var->red.length && !var->green.length &&
1343 !var->blue.length && !var->transp.length &&
1344 !var->red.msb_right && !var->green.msb_right &&
1345 !var->blue.msb_right && !var->transp.msb_right) {
1346 drm_fb_helper_fill_pixel_fmt(var, fb->format->depth);
1350 * drm fbdev emulation doesn't support changing the pixel format at all,
1351 * so reject all pixel format changing requests.
1353 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1354 DRM_DEBUG("fbdev emulation doesn't support changing the pixel format\n");
1360 EXPORT_SYMBOL(drm_fb_helper_check_var);
1363 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1364 * @info: fbdev registered by the helper
1366 * This will let fbcon do the mode init and is called at initialization time by
1367 * the fbdev core when registering the driver, and later on through the hotplug
1370 int drm_fb_helper_set_par(struct fb_info *info)
1372 struct drm_fb_helper *fb_helper = info->par;
1373 struct fb_var_screeninfo *var = &info->var;
1375 if (oops_in_progress)
1378 if (var->pixclock != 0) {
1379 DRM_ERROR("PIXEL CLOCK SET\n");
1383 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1387 EXPORT_SYMBOL(drm_fb_helper_set_par);
1389 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1391 struct drm_mode_set *mode_set;
1393 mutex_lock(&fb_helper->client.modeset_mutex);
1394 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1398 mutex_unlock(&fb_helper->client.modeset_mutex);
1401 static int pan_display_atomic(struct fb_var_screeninfo *var,
1402 struct fb_info *info)
1404 struct drm_fb_helper *fb_helper = info->par;
1407 pan_set(fb_helper, var->xoffset, var->yoffset);
1409 ret = drm_client_modeset_commit_force(&fb_helper->client);
1411 info->var.xoffset = var->xoffset;
1412 info->var.yoffset = var->yoffset;
1414 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1419 static int pan_display_legacy(struct fb_var_screeninfo *var,
1420 struct fb_info *info)
1422 struct drm_fb_helper *fb_helper = info->par;
1423 struct drm_client_dev *client = &fb_helper->client;
1424 struct drm_mode_set *modeset;
1427 mutex_lock(&client->modeset_mutex);
1428 drm_modeset_lock_all(fb_helper->dev);
1429 drm_client_for_each_modeset(modeset, client) {
1430 modeset->x = var->xoffset;
1431 modeset->y = var->yoffset;
1433 if (modeset->num_connectors) {
1434 ret = drm_mode_set_config_internal(modeset);
1436 info->var.xoffset = var->xoffset;
1437 info->var.yoffset = var->yoffset;
1441 drm_modeset_unlock_all(fb_helper->dev);
1442 mutex_unlock(&client->modeset_mutex);
1448 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1449 * @var: updated screen information
1450 * @info: fbdev registered by the helper
1452 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1453 struct fb_info *info)
1455 struct drm_fb_helper *fb_helper = info->par;
1456 struct drm_device *dev = fb_helper->dev;
1459 if (oops_in_progress)
1462 mutex_lock(&fb_helper->lock);
1463 if (!drm_master_internal_acquire(dev)) {
1468 if (drm_drv_uses_atomic_modeset(dev))
1469 ret = pan_display_atomic(var, info);
1471 ret = pan_display_legacy(var, info);
1473 drm_master_internal_release(dev);
1475 mutex_unlock(&fb_helper->lock);
1479 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1482 * Allocates the backing storage and sets up the fbdev info structure through
1483 * the ->fb_probe callback.
1485 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1488 struct drm_client_dev *client = &fb_helper->client;
1491 struct drm_connector_list_iter conn_iter;
1492 struct drm_fb_helper_surface_size sizes;
1493 struct drm_connector *connector;
1494 struct drm_mode_set *mode_set;
1497 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1498 sizes.surface_depth = 24;
1499 sizes.surface_bpp = 32;
1500 sizes.fb_width = (u32)-1;
1501 sizes.fb_height = (u32)-1;
1504 * If driver picks 8 or 16 by default use that for both depth/bpp
1507 if (preferred_bpp != sizes.surface_bpp)
1508 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1510 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1511 drm_client_for_each_connector_iter(connector, &conn_iter) {
1512 struct drm_cmdline_mode *cmdline_mode;
1514 cmdline_mode = &connector->cmdline_mode;
1516 if (cmdline_mode->bpp_specified) {
1517 switch (cmdline_mode->bpp) {
1519 sizes.surface_depth = sizes.surface_bpp = 8;
1522 sizes.surface_depth = 15;
1523 sizes.surface_bpp = 16;
1526 sizes.surface_depth = sizes.surface_bpp = 16;
1529 sizes.surface_depth = sizes.surface_bpp = 24;
1532 sizes.surface_depth = 24;
1533 sizes.surface_bpp = 32;
1539 drm_connector_list_iter_end(&conn_iter);
1542 * If we run into a situation where, for example, the primary plane
1543 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1544 * 16) we need to scale down the depth of the sizes we request.
1546 mutex_lock(&client->modeset_mutex);
1547 drm_client_for_each_modeset(mode_set, client) {
1548 struct drm_crtc *crtc = mode_set->crtc;
1549 struct drm_plane *plane = crtc->primary;
1552 DRM_DEBUG("test CRTC %u primary plane\n", drm_crtc_index(crtc));
1554 for (j = 0; j < plane->format_count; j++) {
1555 const struct drm_format_info *fmt;
1557 fmt = drm_format_info(plane->format_types[j]);
1560 * Do not consider YUV or other complicated formats
1561 * for framebuffers. This means only legacy formats
1562 * are supported (fmt->depth is a legacy field) but
1563 * the framebuffer emulation can only deal with such
1564 * formats, specifically RGB/BGA formats.
1566 if (fmt->depth == 0)
1569 /* We found a perfect fit, great */
1570 if (fmt->depth == sizes.surface_depth) {
1571 best_depth = fmt->depth;
1575 /* Skip depths above what we're looking for */
1576 if (fmt->depth > sizes.surface_depth)
1579 /* Best depth found so far */
1580 if (fmt->depth > best_depth)
1581 best_depth = fmt->depth;
1584 if (sizes.surface_depth != best_depth && best_depth) {
1585 DRM_INFO("requested bpp %d, scaled depth down to %d",
1586 sizes.surface_bpp, best_depth);
1587 sizes.surface_depth = best_depth;
1590 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1592 drm_client_for_each_modeset(mode_set, client) {
1593 struct drm_display_mode *desired_mode;
1595 /* in case of tile group, are we the last tile vert or horiz?
1596 * If no tile group you are always the last one both vertically
1599 bool lastv = true, lasth = true;
1601 desired_mode = mode_set->mode;
1611 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1612 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1614 for (j = 0; j < mode_set->num_connectors; j++) {
1615 struct drm_connector *connector = mode_set->connectors[j];
1617 if (connector->has_tile) {
1618 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1619 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1620 /* cloning to multiple tiles is just crazy-talk, so: */
1626 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1628 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1630 mutex_unlock(&client->modeset_mutex);
1632 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1633 DRM_INFO("Cannot find any crtc or sizes\n");
1635 /* First time: disable all crtc's.. */
1636 if (!fb_helper->deferred_setup)
1637 drm_client_modeset_commit(client);
1641 /* Handle our overallocation */
1642 sizes.surface_height *= drm_fbdev_overalloc;
1643 sizes.surface_height /= 100;
1645 /* push down into drivers */
1646 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1650 strcpy(fb_helper->fb->comm, "[fbcon]");
1654 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1657 info->fix.type = FB_TYPE_PACKED_PIXELS;
1658 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1659 FB_VISUAL_TRUECOLOR;
1660 info->fix.mmio_start = 0;
1661 info->fix.mmio_len = 0;
1662 info->fix.type_aux = 0;
1663 info->fix.xpanstep = 1; /* doing it in hw */
1664 info->fix.ypanstep = 1; /* doing it in hw */
1665 info->fix.ywrapstep = 0;
1666 info->fix.accel = FB_ACCEL_NONE;
1668 info->fix.line_length = pitch;
1671 static void drm_fb_helper_fill_var(struct fb_info *info,
1672 struct drm_fb_helper *fb_helper,
1673 uint32_t fb_width, uint32_t fb_height)
1675 struct drm_framebuffer *fb = fb_helper->fb;
1677 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
1678 (drm_format_info_block_height(fb->format, 0) > 1));
1679 info->pseudo_palette = fb_helper->pseudo_palette;
1680 info->var.xres_virtual = fb->width;
1681 info->var.yres_virtual = fb->height;
1682 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1683 info->var.accel_flags = FB_ACCELF_TEXT;
1684 info->var.xoffset = 0;
1685 info->var.yoffset = 0;
1686 info->var.activate = FB_ACTIVATE_NOW;
1688 drm_fb_helper_fill_pixel_fmt(&info->var, fb->format->depth);
1690 info->var.xres = fb_width;
1691 info->var.yres = fb_height;
1695 * drm_fb_helper_fill_info - initializes fbdev information
1696 * @info: fbdev instance to set up
1697 * @fb_helper: fb helper instance to use as template
1698 * @sizes: describes fbdev size and scanout surface size
1700 * Sets up the variable and fixed fbdev metainformation from the given fb helper
1701 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
1703 * Drivers should call this (or their equivalent setup code) from their
1704 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1705 * backing storage framebuffer.
1707 void drm_fb_helper_fill_info(struct fb_info *info,
1708 struct drm_fb_helper *fb_helper,
1709 struct drm_fb_helper_surface_size *sizes)
1711 struct drm_framebuffer *fb = fb_helper->fb;
1713 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
1714 drm_fb_helper_fill_var(info, fb_helper,
1715 sizes->fb_width, sizes->fb_height);
1717 info->par = fb_helper;
1718 snprintf(info->fix.id, sizeof(info->fix.id), "%sdrmfb",
1719 fb_helper->dev->driver->name);
1722 EXPORT_SYMBOL(drm_fb_helper_fill_info);
1725 * This is a continuation of drm_setup_crtcs() that sets up anything related
1726 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
1727 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
1728 * So, any setup that touches those fields needs to be done here instead of in
1729 * drm_setup_crtcs().
1731 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
1733 struct drm_client_dev *client = &fb_helper->client;
1734 struct drm_connector_list_iter conn_iter;
1735 struct fb_info *info = fb_helper->fbdev;
1736 unsigned int rotation, sw_rotations = 0;
1737 struct drm_connector *connector;
1738 struct drm_mode_set *modeset;
1740 mutex_lock(&client->modeset_mutex);
1741 drm_client_for_each_modeset(modeset, client) {
1742 if (!modeset->num_connectors)
1745 modeset->fb = fb_helper->fb;
1747 if (drm_client_rotation(modeset, &rotation))
1748 /* Rotating in hardware, fbcon should not rotate */
1749 sw_rotations |= DRM_MODE_ROTATE_0;
1751 sw_rotations |= rotation;
1753 mutex_unlock(&client->modeset_mutex);
1755 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1756 drm_client_for_each_connector_iter(connector, &conn_iter) {
1758 /* use first connected connector for the physical dimensions */
1759 if (connector->status == connector_status_connected) {
1760 info->var.width = connector->display_info.width_mm;
1761 info->var.height = connector->display_info.height_mm;
1765 drm_connector_list_iter_end(&conn_iter);
1767 switch (sw_rotations) {
1768 case DRM_MODE_ROTATE_0:
1769 info->fbcon_rotate_hint = FB_ROTATE_UR;
1771 case DRM_MODE_ROTATE_90:
1772 info->fbcon_rotate_hint = FB_ROTATE_CCW;
1774 case DRM_MODE_ROTATE_180:
1775 info->fbcon_rotate_hint = FB_ROTATE_UD;
1777 case DRM_MODE_ROTATE_270:
1778 info->fbcon_rotate_hint = FB_ROTATE_CW;
1782 * Multiple bits are set / multiple rotations requested
1783 * fbcon cannot handle separate rotation settings per
1784 * output, so fallback to unrotated.
1786 info->fbcon_rotate_hint = FB_ROTATE_UR;
1790 /* Note: Drops fb_helper->lock before returning. */
1792 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
1795 struct drm_device *dev = fb_helper->dev;
1796 struct fb_info *info;
1797 unsigned int width, height;
1800 width = dev->mode_config.max_width;
1801 height = dev->mode_config.max_height;
1803 drm_client_modeset_probe(&fb_helper->client, width, height);
1804 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1806 if (ret == -EAGAIN) {
1807 fb_helper->preferred_bpp = bpp_sel;
1808 fb_helper->deferred_setup = true;
1811 mutex_unlock(&fb_helper->lock);
1815 drm_setup_crtcs_fb(fb_helper);
1817 fb_helper->deferred_setup = false;
1819 info = fb_helper->fbdev;
1820 info->var.pixclock = 0;
1821 /* Shamelessly allow physical address leaking to userspace */
1822 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1823 if (!drm_leak_fbdev_smem)
1825 /* don't leak any physical addresses to userspace */
1826 info->flags |= FBINFO_HIDE_SMEM_START;
1828 /* Need to drop locks to avoid recursive deadlock in
1829 * register_framebuffer. This is ok because the only thing left to do is
1830 * register the fbdev emulation instance in kernel_fb_helper_list. */
1831 mutex_unlock(&fb_helper->lock);
1833 ret = register_framebuffer(info);
1837 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
1838 info->node, info->fix.id);
1840 mutex_lock(&kernel_fb_helper_lock);
1841 if (list_empty(&kernel_fb_helper_list))
1842 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1844 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1845 mutex_unlock(&kernel_fb_helper_lock);
1851 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1852 * @fb_helper: fb_helper device struct
1853 * @bpp_sel: bpp value to use for the framebuffer configuration
1855 * Scans the CRTCs and connectors and tries to put together an initial setup.
1856 * At the moment, this is a cloned configuration across all heads with
1857 * a new framebuffer object as the backing store.
1859 * Note that this also registers the fbdev and so allows userspace to call into
1860 * the driver through the fbdev interfaces.
1862 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
1863 * to let the driver allocate and initialize the fbdev info structure and the
1864 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
1865 * as a helper to setup simple default values for the fbdev info structure.
1869 * When you have fbcon support built-in or already loaded, this function will do
1870 * a full modeset to setup the fbdev console. Due to locking misdesign in the
1871 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
1872 * console_lock. Until console_unlock is called no dmesg lines will be sent out
1873 * to consoles, not even serial console. This means when your driver crashes,
1874 * you will see absolutely nothing else but a system stuck in this function,
1875 * with no further output. Any kind of printk() you place within your own driver
1876 * or in the drm core modeset code will also never show up.
1878 * Standard debug practice is to run the fbcon setup without taking the
1879 * console_lock as a hack, to be able to see backtraces and crashes on the
1880 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
1883 * The other option is to just disable fbdev emulation since very likely the
1884 * first modeset from userspace will crash in the same way, and is even easier
1885 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
1886 * kernel cmdline option.
1889 * Zero if everything went ok, nonzero otherwise.
1891 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1895 if (!drm_fbdev_emulation)
1898 mutex_lock(&fb_helper->lock);
1899 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
1903 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1906 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1907 * probing all the outputs attached to the fb
1908 * @fb_helper: driver-allocated fbdev helper, can be NULL
1910 * Scan the connectors attached to the fb_helper and try to put together a
1911 * setup after notification of a change in output configuration.
1913 * Called at runtime, takes the mode config locks to be able to check/change the
1914 * modeset configuration. Must be run from process context (which usually means
1915 * either the output polling work or a work item launched from the driver's
1916 * hotplug interrupt).
1918 * Note that drivers may call this even before calling
1919 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
1920 * for a race-free fbcon setup and will make sure that the fbdev emulation will
1921 * not miss any hotplug events.
1924 * 0 on success and a non-zero error code otherwise.
1926 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1930 if (!drm_fbdev_emulation || !fb_helper)
1933 mutex_lock(&fb_helper->lock);
1934 if (fb_helper->deferred_setup) {
1935 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
1936 fb_helper->preferred_bpp);
1940 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
1941 fb_helper->delayed_hotplug = true;
1942 mutex_unlock(&fb_helper->lock);
1946 drm_master_internal_release(fb_helper->dev);
1948 DRM_DEBUG_KMS("\n");
1950 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
1951 drm_setup_crtcs_fb(fb_helper);
1952 mutex_unlock(&fb_helper->lock);
1954 drm_fb_helper_set_par(fb_helper->fbdev);
1958 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1961 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
1963 * @fb_helper: fbdev helper structure to set up
1964 * @funcs: fbdev helper functions
1965 * @preferred_bpp: Preferred bits per pixel for the device.
1966 * @dev->mode_config.preferred_depth is used if this is zero.
1967 * @max_conn_count: Maximum number of connectors (not used)
1969 * This function sets up fbdev emulation and registers fbdev for access by
1970 * userspace. If all connectors are disconnected, setup is deferred to the next
1971 * time drm_fb_helper_hotplug_event() is called.
1972 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
1975 * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev.
1977 * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup().
1980 * Zero on success or negative error code on failure.
1982 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
1983 struct drm_fb_helper *fb_helper,
1984 const struct drm_fb_helper_funcs *funcs,
1985 unsigned int preferred_bpp,
1986 unsigned int max_conn_count)
1991 preferred_bpp = dev->mode_config.preferred_depth;
1995 drm_fb_helper_prepare(dev, fb_helper, funcs);
1997 ret = drm_fb_helper_init(dev, fb_helper, 0);
1999 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to initialize (ret=%d)\n", ret);
2003 if (!drm_drv_uses_atomic_modeset(dev))
2004 drm_helper_disable_unused_functions(dev);
2006 ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
2008 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to set configuration (ret=%d)\n", ret);
2009 goto err_drm_fb_helper_fini;
2014 err_drm_fb_helper_fini:
2015 drm_fb_helper_fbdev_teardown(dev);
2019 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2022 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2025 * This function unregisters fbdev if not already done and cleans up the
2026 * associated resources including the &drm_framebuffer.
2027 * The driver is responsible for freeing the &drm_fb_helper structure which is
2028 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2029 * when this function returns.
2031 * In order to support device removal/unplug while file handles are still open,
2032 * drm_fb_helper_unregister_fbi() should be called on device removal and
2033 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2034 * file handles are closed.
2036 void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2038 struct drm_fb_helper *fb_helper = dev->fb_helper;
2039 struct fb_ops *fbops = NULL;
2044 /* Unregister if it hasn't been done already */
2045 if (fb_helper->fbdev && fb_helper->fbdev->dev)
2046 drm_fb_helper_unregister_fbi(fb_helper);
2048 if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2049 fb_deferred_io_cleanup(fb_helper->fbdev);
2050 kfree(fb_helper->fbdev->fbdefio);
2051 fbops = fb_helper->fbdev->fbops;
2054 drm_fb_helper_fini(fb_helper);
2058 drm_framebuffer_remove(fb_helper->fb);
2060 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2063 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2066 * This function can be used as the &drm_driver->lastclose callback for drivers
2067 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2069 void drm_fb_helper_lastclose(struct drm_device *dev)
2071 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2073 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2076 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2077 * helper for fbdev emulation
2080 * This function can be used as the
2081 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2082 * need to call drm_fb_helper_hotplug_event().
2084 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2086 drm_fb_helper_hotplug_event(dev->fb_helper);
2088 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2090 /* @user: 1=userspace, 0=fbcon */
2091 static int drm_fbdev_fb_open(struct fb_info *info, int user)
2093 struct drm_fb_helper *fb_helper = info->par;
2095 /* No need to take a ref for fbcon because it unbinds on unregister */
2096 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
2102 static int drm_fbdev_fb_release(struct fb_info *info, int user)
2104 struct drm_fb_helper *fb_helper = info->par;
2107 module_put(fb_helper->dev->driver->fops->owner);
2112 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
2114 struct fb_info *fbi = fb_helper->fbdev;
2115 struct fb_ops *fbops = NULL;
2116 void *shadow = NULL;
2118 if (!fb_helper->dev)
2121 if (fbi && fbi->fbdefio) {
2122 fb_deferred_io_cleanup(fbi);
2123 shadow = fbi->screen_buffer;
2127 drm_fb_helper_fini(fb_helper);
2134 drm_client_framebuffer_delete(fb_helper->buffer);
2137 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
2139 drm_fbdev_cleanup(fb_helper);
2140 drm_client_release(&fb_helper->client);
2145 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2146 * unregister_framebuffer() or fb_release().
2148 static void drm_fbdev_fb_destroy(struct fb_info *info)
2150 drm_fbdev_release(info->par);
2153 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
2155 struct drm_fb_helper *fb_helper = info->par;
2157 if (fb_helper->dev->driver->gem_prime_mmap)
2158 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2163 static struct fb_ops drm_fbdev_fb_ops = {
2164 .owner = THIS_MODULE,
2165 DRM_FB_HELPER_DEFAULT_OPS,
2166 .fb_open = drm_fbdev_fb_open,
2167 .fb_release = drm_fbdev_fb_release,
2168 .fb_destroy = drm_fbdev_fb_destroy,
2169 .fb_mmap = drm_fbdev_fb_mmap,
2170 .fb_read = drm_fb_helper_sys_read,
2171 .fb_write = drm_fb_helper_sys_write,
2172 .fb_fillrect = drm_fb_helper_sys_fillrect,
2173 .fb_copyarea = drm_fb_helper_sys_copyarea,
2174 .fb_imageblit = drm_fb_helper_sys_imageblit,
2177 static struct fb_deferred_io drm_fbdev_defio = {
2179 .deferred_io = drm_fb_helper_deferred_io,
2183 * drm_fb_helper_generic_probe - Generic fbdev emulation probe helper
2184 * @fb_helper: fbdev helper structure
2185 * @sizes: describes fbdev size and scanout surface size
2187 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2189 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2190 * fb_copyarea, fb_imageblit.
2193 * Zero on success or negative error code on failure.
2195 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2196 struct drm_fb_helper_surface_size *sizes)
2198 struct drm_client_dev *client = &fb_helper->client;
2199 struct drm_client_buffer *buffer;
2200 struct drm_framebuffer *fb;
2201 struct fb_info *fbi;
2205 DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
2206 sizes->surface_width, sizes->surface_height,
2207 sizes->surface_bpp);
2209 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2210 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2211 sizes->surface_height, format);
2213 return PTR_ERR(buffer);
2215 fb_helper->buffer = buffer;
2216 fb_helper->fb = buffer->fb;
2219 fbi = drm_fb_helper_alloc_fbi(fb_helper);
2221 return PTR_ERR(fbi);
2223 fbi->fbops = &drm_fbdev_fb_ops;
2224 fbi->screen_size = fb->height * fb->pitches[0];
2225 fbi->fix.smem_len = fbi->screen_size;
2227 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2229 if (drm_fbdev_use_shadow_fb(fb_helper)) {
2230 struct fb_ops *fbops;
2234 * fb_deferred_io_cleanup() clears &fbops->fb_mmap so a per
2235 * instance version is necessary.
2237 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
2238 shadow = vzalloc(fbi->screen_size);
2239 if (!fbops || !shadow) {
2245 *fbops = *fbi->fbops;
2247 fbi->screen_buffer = shadow;
2248 fbi->fbdefio = &drm_fbdev_defio;
2250 fb_deferred_io_init(fbi);
2252 /* buffer is mapped for HW framebuffer */
2253 vaddr = drm_client_buffer_vmap(fb_helper->buffer);
2255 return PTR_ERR(vaddr);
2257 fbi->screen_buffer = vaddr;
2258 /* Shamelessly leak the physical address to user-space */
2259 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2260 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0)
2261 fbi->fix.smem_start =
2262 page_to_phys(virt_to_page(fbi->screen_buffer));
2268 EXPORT_SYMBOL(drm_fb_helper_generic_probe);
2270 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2271 .fb_probe = drm_fb_helper_generic_probe,
2274 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2276 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2278 if (fb_helper->fbdev)
2279 /* drm_fbdev_fb_destroy() takes care of cleanup */
2280 drm_fb_helper_unregister_fbi(fb_helper);
2282 drm_fbdev_release(fb_helper);
2285 static int drm_fbdev_client_restore(struct drm_client_dev *client)
2287 drm_fb_helper_lastclose(client->dev);
2292 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2294 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2295 struct drm_device *dev = client->dev;
2298 /* Setup is not retried if it has failed */
2299 if (!fb_helper->dev && fb_helper->funcs)
2303 return drm_fb_helper_hotplug_event(dev->fb_helper);
2305 if (!dev->mode_config.num_connector) {
2306 DRM_DEV_DEBUG(dev->dev, "No connectors found, will not create framebuffer!\n");
2310 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2312 ret = drm_fb_helper_init(dev, fb_helper, 0);
2316 if (!drm_drv_uses_atomic_modeset(dev))
2317 drm_helper_disable_unused_functions(dev);
2319 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2326 drm_fbdev_cleanup(fb_helper);
2328 fb_helper->dev = NULL;
2329 fb_helper->fbdev = NULL;
2331 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2336 static const struct drm_client_funcs drm_fbdev_client_funcs = {
2337 .owner = THIS_MODULE,
2338 .unregister = drm_fbdev_client_unregister,
2339 .restore = drm_fbdev_client_restore,
2340 .hotplug = drm_fbdev_client_hotplug,
2344 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2346 * @preferred_bpp: Preferred bits per pixel for the device.
2347 * @dev->mode_config.preferred_depth is used if this is zero.
2349 * This function sets up generic fbdev emulation for drivers that supports
2350 * dumb buffers with a virtual address and that can be mmap'ed. If the driver
2351 * does not support these functions, it could use drm_fb_helper_fbdev_setup().
2353 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2354 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2355 * Simple drivers might use drm_mode_config_helper_suspend().
2357 * Drivers that set the dirty callback on their framebuffer will get a shadow
2358 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2359 * make deferred I/O work with all kinds of buffers.
2361 * This function is safe to call even when there are no connectors present.
2362 * Setup will be retried on the next hotplug event.
2364 * The fbdev is destroyed by drm_dev_unregister().
2367 * Zero on success or negative error code on failure.
2369 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
2371 struct drm_fb_helper *fb_helper;
2374 WARN(dev->fb_helper, "fb_helper is already set!\n");
2376 if (!drm_fbdev_emulation)
2379 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2383 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2386 DRM_DEV_ERROR(dev->dev, "Failed to register client: %d\n", ret);
2391 preferred_bpp = dev->mode_config.preferred_depth;
2394 fb_helper->preferred_bpp = preferred_bpp;
2396 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2398 DRM_DEV_DEBUG(dev->dev, "client hotplug ret=%d\n", ret);
2400 drm_client_register(&fb_helper->client);
2404 EXPORT_SYMBOL(drm_fbdev_generic_setup);
2406 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2407 * but the module doesn't depend on any fb console symbols. At least
2408 * attempt to load fbcon to avoid leaving the system without a usable console.
2410 int __init drm_fb_helper_modinit(void)
2412 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2413 const char name[] = "fbcon";
2414 struct module *fbcon;
2416 mutex_lock(&module_mutex);
2417 fbcon = find_module(name);
2418 mutex_unlock(&module_mutex);
2421 request_module_nowait(name);
2425 EXPORT_SYMBOL(drm_fb_helper_modinit);