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_internal.h"
51 static bool drm_fbdev_emulation = true;
52 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
53 MODULE_PARM_DESC(fbdev_emulation,
54 "Enable legacy fbdev emulation [default=true]");
56 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
57 module_param(drm_fbdev_overalloc, int, 0444);
58 MODULE_PARM_DESC(drm_fbdev_overalloc,
59 "Overallocation of the fbdev buffer (%) [default="
60 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
63 * In order to keep user-space compatibility, we want in certain use-cases
64 * to keep leaking the fbdev physical address to the user-space program
65 * handling the fbdev buffer.
66 * This is a bad habit essentially kept into closed source opengl driver
67 * that should really be moved into open-source upstream projects instead
68 * of using legacy physical addresses in user space to communicate with
69 * other out-of-tree kernel modules.
71 * This module_param *should* be removed as soon as possible and be
72 * considered as a broken and legacy behaviour from a modern fbdev device.
74 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
75 static bool drm_leak_fbdev_smem = false;
76 module_param_unsafe(drm_leak_fbdev_smem, bool, 0600);
77 MODULE_PARM_DESC(drm_leak_fbdev_smem,
78 "Allow unsafe leaking fbdev physical smem address [default=false]");
81 static LIST_HEAD(kernel_fb_helper_list);
82 static DEFINE_MUTEX(kernel_fb_helper_lock);
87 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
88 * mode setting driver. They can be used mostly independently from the crtc
89 * helper functions used by many drivers to implement the kernel mode setting
92 * Drivers that support a dumb buffer with a virtual address and mmap support,
93 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
95 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
96 * down by calling drm_fb_helper_fbdev_teardown().
98 * At runtime drivers should restore the fbdev console by using
99 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
100 * They should also notify the fb helper code from updates to the output
101 * configuration by using drm_fb_helper_output_poll_changed() as their
102 * &drm_mode_config_funcs.output_poll_changed callback.
104 * For suspend/resume consider using drm_mode_config_helper_suspend() and
105 * drm_mode_config_helper_resume() which takes care of fbdev as well.
107 * All other functions exported by the fb helper library can be used to
108 * implement the fbdev driver interface by the driver.
110 * It is possible, though perhaps somewhat tricky, to implement race-free
111 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
112 * helper must be called first to initialize the minimum required to make
113 * hotplug detection work. Drivers also need to make sure to properly set up
114 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
115 * it is safe to enable interrupts and start processing hotplug events. At the
116 * same time, drivers should initialize all modeset objects such as CRTCs,
117 * encoders and connectors. To finish up the fbdev helper initialization, the
118 * drm_fb_helper_init() function is called. To probe for all attached displays
119 * and set up an initial configuration using the detected hardware, drivers
120 * should call drm_fb_helper_initial_config().
122 * If &drm_framebuffer_funcs.dirty is set, the
123 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
124 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
125 * away. This worker then calls the dirty() function ensuring that it will
126 * always run in process context since the fb_*() function could be running in
127 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
128 * callback it will also schedule dirty_work with the damage collected from the
129 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
130 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
133 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
135 uint16_t *r_base, *g_base, *b_base;
137 if (crtc->funcs->gamma_set == NULL)
140 r_base = crtc->gamma_store;
141 g_base = r_base + crtc->gamma_size;
142 b_base = g_base + crtc->gamma_size;
144 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
145 crtc->gamma_size, NULL);
149 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
150 * @info: fbdev registered by the helper
152 int drm_fb_helper_debug_enter(struct fb_info *info)
154 struct drm_fb_helper *helper = info->par;
155 const struct drm_crtc_helper_funcs *funcs;
156 struct drm_mode_set *mode_set;
158 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
159 mutex_lock(&helper->client.modeset_mutex);
160 drm_client_for_each_modeset(mode_set, &helper->client) {
161 if (!mode_set->crtc->enabled)
164 funcs = mode_set->crtc->helper_private;
165 if (funcs->mode_set_base_atomic == NULL)
168 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
171 funcs->mode_set_base_atomic(mode_set->crtc,
175 ENTER_ATOMIC_MODE_SET);
177 mutex_unlock(&helper->client.modeset_mutex);
182 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
185 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
186 * @info: fbdev registered by the helper
188 int drm_fb_helper_debug_leave(struct fb_info *info)
190 struct drm_fb_helper *helper = info->par;
191 struct drm_client_dev *client = &helper->client;
192 struct drm_crtc *crtc;
193 const struct drm_crtc_helper_funcs *funcs;
194 struct drm_mode_set *mode_set;
195 struct drm_framebuffer *fb;
197 mutex_lock(&client->modeset_mutex);
198 drm_client_for_each_modeset(mode_set, client) {
199 crtc = mode_set->crtc;
200 if (drm_drv_uses_atomic_modeset(crtc->dev))
203 funcs = crtc->helper_private;
204 fb = crtc->primary->fb;
210 DRM_ERROR("no fb to restore??\n");
214 if (funcs->mode_set_base_atomic == NULL)
217 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
218 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
219 crtc->y, LEAVE_ATOMIC_MODE_SET);
221 mutex_unlock(&client->modeset_mutex);
225 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
228 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
229 * @fb_helper: driver-allocated fbdev helper, can be NULL
231 * This should be called from driver's drm &drm_driver.lastclose callback
232 * when implementing an fbcon on top of kms using this helper. This ensures that
233 * the user isn't greeted with a black screen when e.g. X dies.
236 * Zero if everything went ok, negative error code otherwise.
238 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
243 if (!drm_fbdev_emulation || !fb_helper)
246 if (READ_ONCE(fb_helper->deferred_setup))
249 mutex_lock(&fb_helper->lock);
252 * We should bail out here if there is a master by dropping _force.
253 * Currently these igt tests fail if we do that:
254 * - kms_fbcon_fbt@psr
255 * - kms_fbcon_fbt@psr-suspend
257 * So first these tests need to be fixed so they drop master or don't
260 ret = drm_client_modeset_commit_force(&fb_helper->client);
262 do_delayed = fb_helper->delayed_hotplug;
264 fb_helper->delayed_hotplug = false;
265 mutex_unlock(&fb_helper->lock);
268 drm_fb_helper_hotplug_event(fb_helper);
272 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
274 #ifdef CONFIG_MAGIC_SYSRQ
276 * restore fbcon display for all kms driver's using this helper, used for sysrq
277 * and panic handling.
279 static bool drm_fb_helper_force_kernel_mode(void)
281 bool ret, error = false;
282 struct drm_fb_helper *helper;
284 if (list_empty(&kernel_fb_helper_list))
287 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
288 struct drm_device *dev = helper->dev;
290 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
293 mutex_lock(&helper->lock);
294 ret = drm_client_modeset_commit_force(&helper->client);
297 mutex_unlock(&helper->lock);
302 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
306 ret = drm_fb_helper_force_kernel_mode();
308 DRM_ERROR("Failed to restore crtc configuration\n");
310 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
312 static void drm_fb_helper_sysrq(int dummy1)
314 schedule_work(&drm_fb_helper_restore_work);
317 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
318 .handler = drm_fb_helper_sysrq,
319 .help_msg = "force-fb(V)",
320 .action_msg = "Restore framebuffer console",
323 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
326 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
328 struct drm_fb_helper *fb_helper = info->par;
330 mutex_lock(&fb_helper->lock);
331 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
332 mutex_unlock(&fb_helper->lock);
336 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
337 * @blank: desired blanking state
338 * @info: fbdev registered by the helper
340 int drm_fb_helper_blank(int blank, struct fb_info *info)
342 if (oops_in_progress)
346 /* Display: On; HSync: On, VSync: On */
347 case FB_BLANK_UNBLANK:
348 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
350 /* Display: Off; HSync: On, VSync: On */
351 case FB_BLANK_NORMAL:
352 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
354 /* Display: Off; HSync: Off, VSync: On */
355 case FB_BLANK_HSYNC_SUSPEND:
356 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
358 /* Display: Off; HSync: On, VSync: Off */
359 case FB_BLANK_VSYNC_SUSPEND:
360 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
362 /* Display: Off; HSync: Off, VSync: Off */
363 case FB_BLANK_POWERDOWN:
364 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
369 EXPORT_SYMBOL(drm_fb_helper_blank);
371 static void drm_fb_helper_resume_worker(struct work_struct *work)
373 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
377 fb_set_suspend(helper->fbdev, 0);
381 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper *fb_helper,
382 struct drm_clip_rect *clip)
384 struct drm_framebuffer *fb = fb_helper->fb;
385 unsigned int cpp = fb->format->cpp[0];
386 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
387 void *src = fb_helper->fbdev->screen_buffer + offset;
388 void *dst = fb_helper->buffer->vaddr + offset;
389 size_t len = (clip->x2 - clip->x1) * cpp;
392 for (y = clip->y1; y < clip->y2; y++) {
393 memcpy(dst, src, len);
394 src += fb->pitches[0];
395 dst += fb->pitches[0];
399 static void drm_fb_helper_dirty_work(struct work_struct *work)
401 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
403 struct drm_clip_rect *clip = &helper->dirty_clip;
404 struct drm_clip_rect clip_copy;
407 spin_lock_irqsave(&helper->dirty_lock, flags);
409 clip->x1 = clip->y1 = ~0;
410 clip->x2 = clip->y2 = 0;
411 spin_unlock_irqrestore(&helper->dirty_lock, flags);
413 /* call dirty callback only when it has been really touched */
414 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2) {
415 /* Generic fbdev uses a shadow buffer */
417 drm_fb_helper_dirty_blit_real(helper, &clip_copy);
418 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
423 * drm_fb_helper_prepare - setup a drm_fb_helper structure
425 * @helper: driver-allocated fbdev helper structure to set up
426 * @funcs: pointer to structure of functions associate with this helper
428 * Sets up the bare minimum to make the framebuffer helper usable. This is
429 * useful to implement race-free initialization of the polling helpers.
431 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
432 const struct drm_fb_helper_funcs *funcs)
434 INIT_LIST_HEAD(&helper->kernel_fb_list);
435 spin_lock_init(&helper->dirty_lock);
436 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
437 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
438 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
439 mutex_init(&helper->lock);
440 helper->funcs = funcs;
443 EXPORT_SYMBOL(drm_fb_helper_prepare);
446 * drm_fb_helper_init - initialize a &struct drm_fb_helper
448 * @fb_helper: driver-allocated fbdev helper structure to initialize
449 * @max_conn_count: max connector count (not used)
451 * This allocates the structures for the fbdev helper with the given limits.
452 * Note that this won't yet touch the hardware (through the driver interfaces)
453 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
454 * to allow driver writes more control over the exact init sequence.
456 * Drivers must call drm_fb_helper_prepare() before calling this function.
459 * Zero if everything went ok, nonzero otherwise.
461 int drm_fb_helper_init(struct drm_device *dev,
462 struct drm_fb_helper *fb_helper,
467 if (!drm_fbdev_emulation) {
468 dev->fb_helper = fb_helper;
473 * If this is not the generic fbdev client, initialize a drm_client
474 * without callbacks so we can use the modesets.
476 if (!fb_helper->client.funcs) {
477 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
482 dev->fb_helper = fb_helper;
486 EXPORT_SYMBOL(drm_fb_helper_init);
489 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
490 * @fb_helper: driver-allocated fbdev helper
492 * A helper to alloc fb_info and the members cmap and apertures. Called
493 * by the driver within the fb_probe fb_helper callback function. Drivers do not
494 * need to release the allocated fb_info structure themselves, this is
495 * automatically done when calling drm_fb_helper_fini().
498 * fb_info pointer if things went okay, pointer containing error code
501 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
503 struct device *dev = fb_helper->dev->dev;
504 struct fb_info *info;
507 info = framebuffer_alloc(0, dev);
509 return ERR_PTR(-ENOMEM);
511 ret = fb_alloc_cmap(&info->cmap, 256, 0);
515 info->apertures = alloc_apertures(1);
516 if (!info->apertures) {
521 fb_helper->fbdev = info;
522 info->skip_vt_switch = true;
527 fb_dealloc_cmap(&info->cmap);
529 framebuffer_release(info);
532 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
535 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
536 * @fb_helper: driver-allocated fbdev helper, can be NULL
538 * A wrapper around unregister_framebuffer, to release the fb_info
539 * framebuffer device. This must be called before releasing all resources for
540 * @fb_helper by calling drm_fb_helper_fini().
542 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
544 if (fb_helper && fb_helper->fbdev)
545 unregister_framebuffer(fb_helper->fbdev);
547 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
550 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
551 * @fb_helper: driver-allocated fbdev helper, can be NULL
553 * This cleans up all remaining resources associated with @fb_helper. Must be
554 * called after drm_fb_helper_unlink_fbi() was called.
556 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
558 struct fb_info *info;
563 fb_helper->dev->fb_helper = NULL;
565 if (!drm_fbdev_emulation)
568 cancel_work_sync(&fb_helper->resume_work);
569 cancel_work_sync(&fb_helper->dirty_work);
571 info = fb_helper->fbdev;
574 fb_dealloc_cmap(&info->cmap);
575 framebuffer_release(info);
577 fb_helper->fbdev = NULL;
579 mutex_lock(&kernel_fb_helper_lock);
580 if (!list_empty(&fb_helper->kernel_fb_list)) {
581 list_del(&fb_helper->kernel_fb_list);
582 if (list_empty(&kernel_fb_helper_list))
583 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
585 mutex_unlock(&kernel_fb_helper_lock);
587 mutex_destroy(&fb_helper->lock);
589 if (!fb_helper->client.funcs)
590 drm_client_release(&fb_helper->client);
592 EXPORT_SYMBOL(drm_fb_helper_fini);
595 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
596 * @fb_helper: driver-allocated fbdev helper, can be NULL
598 * A wrapper around unlink_framebuffer implemented by fbdev core
600 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
602 if (fb_helper && fb_helper->fbdev)
603 unlink_framebuffer(fb_helper->fbdev);
605 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
607 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
608 u32 width, u32 height)
610 struct drm_fb_helper *helper = info->par;
611 struct drm_clip_rect *clip = &helper->dirty_clip;
614 if (!helper->fb->funcs->dirty)
617 spin_lock_irqsave(&helper->dirty_lock, flags);
618 clip->x1 = min_t(u32, clip->x1, x);
619 clip->y1 = min_t(u32, clip->y1, y);
620 clip->x2 = max_t(u32, clip->x2, x + width);
621 clip->y2 = max_t(u32, clip->y2, y + height);
622 spin_unlock_irqrestore(&helper->dirty_lock, flags);
624 schedule_work(&helper->dirty_work);
628 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
629 * @info: fb_info struct pointer
630 * @pagelist: list of dirty mmap framebuffer pages
632 * This function is used as the &fb_deferred_io.deferred_io
633 * callback function for flushing the fbdev mmap writes.
635 void drm_fb_helper_deferred_io(struct fb_info *info,
636 struct list_head *pagelist)
638 unsigned long start, end, min, max;
644 list_for_each_entry(page, pagelist, lru) {
645 start = page->index << PAGE_SHIFT;
646 end = start + PAGE_SIZE - 1;
647 min = min(min, start);
652 y1 = min / info->fix.line_length;
653 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
655 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
658 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
661 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
662 * @fb_helper: driver-allocated fbdev helper
664 * This function allocates &fb_deferred_io, sets callback to
665 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
666 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
667 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
669 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
670 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
671 * affect other instances of that &fb_ops.
674 * 0 on success or a negative error code on failure.
676 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
678 struct fb_info *info = fb_helper->fbdev;
679 struct fb_deferred_io *fbdefio;
680 struct fb_ops *fbops;
682 fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
683 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
684 if (!fbdefio || !fbops) {
690 info->fbdefio = fbdefio;
691 fbdefio->delay = msecs_to_jiffies(50);
692 fbdefio->deferred_io = drm_fb_helper_deferred_io;
694 *fbops = *info->fbops;
697 fb_deferred_io_init(info);
701 EXPORT_SYMBOL(drm_fb_helper_defio_init);
704 * drm_fb_helper_sys_read - wrapper around fb_sys_read
705 * @info: fb_info struct pointer
706 * @buf: userspace buffer to read from framebuffer memory
707 * @count: number of bytes to read from framebuffer memory
708 * @ppos: read offset within framebuffer memory
710 * A wrapper around fb_sys_read implemented by fbdev core
712 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
713 size_t count, loff_t *ppos)
715 return fb_sys_read(info, buf, count, ppos);
717 EXPORT_SYMBOL(drm_fb_helper_sys_read);
720 * drm_fb_helper_sys_write - wrapper around fb_sys_write
721 * @info: fb_info struct pointer
722 * @buf: userspace buffer to write to framebuffer memory
723 * @count: number of bytes to write to framebuffer memory
724 * @ppos: write offset within framebuffer memory
726 * A wrapper around fb_sys_write implemented by fbdev core
728 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
729 size_t count, loff_t *ppos)
733 ret = fb_sys_write(info, buf, count, ppos);
735 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
740 EXPORT_SYMBOL(drm_fb_helper_sys_write);
743 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
744 * @info: fbdev registered by the helper
745 * @rect: info about rectangle to fill
747 * A wrapper around sys_fillrect implemented by fbdev core
749 void drm_fb_helper_sys_fillrect(struct fb_info *info,
750 const struct fb_fillrect *rect)
752 sys_fillrect(info, rect);
753 drm_fb_helper_dirty(info, rect->dx, rect->dy,
754 rect->width, rect->height);
756 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
759 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
760 * @info: fbdev registered by the helper
761 * @area: info about area to copy
763 * A wrapper around sys_copyarea implemented by fbdev core
765 void drm_fb_helper_sys_copyarea(struct fb_info *info,
766 const struct fb_copyarea *area)
768 sys_copyarea(info, area);
769 drm_fb_helper_dirty(info, area->dx, area->dy,
770 area->width, area->height);
772 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
775 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
776 * @info: fbdev registered by the helper
777 * @image: info about image to blit
779 * A wrapper around sys_imageblit implemented by fbdev core
781 void drm_fb_helper_sys_imageblit(struct fb_info *info,
782 const struct fb_image *image)
784 sys_imageblit(info, image);
785 drm_fb_helper_dirty(info, image->dx, image->dy,
786 image->width, image->height);
788 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
791 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
792 * @info: fbdev registered by the helper
793 * @rect: info about rectangle to fill
795 * A wrapper around cfb_fillrect implemented by fbdev core
797 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
798 const struct fb_fillrect *rect)
800 cfb_fillrect(info, rect);
801 drm_fb_helper_dirty(info, rect->dx, rect->dy,
802 rect->width, rect->height);
804 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
807 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
808 * @info: fbdev registered by the helper
809 * @area: info about area to copy
811 * A wrapper around cfb_copyarea implemented by fbdev core
813 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
814 const struct fb_copyarea *area)
816 cfb_copyarea(info, area);
817 drm_fb_helper_dirty(info, area->dx, area->dy,
818 area->width, area->height);
820 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
823 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
824 * @info: fbdev registered by the helper
825 * @image: info about image to blit
827 * A wrapper around cfb_imageblit implemented by fbdev core
829 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
830 const struct fb_image *image)
832 cfb_imageblit(info, image);
833 drm_fb_helper_dirty(info, image->dx, image->dy,
834 image->width, image->height);
836 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
839 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
840 * @fb_helper: driver-allocated fbdev helper, can be NULL
841 * @suspend: whether to suspend or resume
843 * A wrapper around fb_set_suspend implemented by fbdev core.
844 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
847 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
849 if (fb_helper && fb_helper->fbdev)
850 fb_set_suspend(fb_helper->fbdev, suspend);
852 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
855 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
856 * takes the console lock
857 * @fb_helper: driver-allocated fbdev helper, can be NULL
858 * @suspend: whether to suspend or resume
860 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
861 * isn't available on resume, a worker is tasked with waiting for the lock
862 * to become available. The console lock can be pretty contented on resume
863 * due to all the printk activity.
865 * This function can be called multiple times with the same state since
866 * &fb_info.state is checked to see if fbdev is running or not before locking.
868 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
870 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
873 if (!fb_helper || !fb_helper->fbdev)
876 /* make sure there's no pending/ongoing resume */
877 flush_work(&fb_helper->resume_work);
880 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
886 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
889 if (!console_trylock()) {
890 schedule_work(&fb_helper->resume_work);
895 fb_set_suspend(fb_helper->fbdev, suspend);
898 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
900 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
902 u32 *palette = (u32 *)info->pseudo_palette;
905 if (cmap->start + cmap->len > 16)
908 for (i = 0; i < cmap->len; ++i) {
909 u16 red = cmap->red[i];
910 u16 green = cmap->green[i];
911 u16 blue = cmap->blue[i];
914 red >>= 16 - info->var.red.length;
915 green >>= 16 - info->var.green.length;
916 blue >>= 16 - info->var.blue.length;
917 value = (red << info->var.red.offset) |
918 (green << info->var.green.offset) |
919 (blue << info->var.blue.offset);
920 if (info->var.transp.length > 0) {
921 u32 mask = (1 << info->var.transp.length) - 1;
923 mask <<= info->var.transp.offset;
926 palette[cmap->start + i] = value;
932 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
934 struct drm_fb_helper *fb_helper = info->par;
935 struct drm_mode_set *modeset;
936 struct drm_crtc *crtc;
940 drm_modeset_lock_all(fb_helper->dev);
941 drm_client_for_each_modeset(modeset, &fb_helper->client) {
942 crtc = modeset->crtc;
943 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
946 if (cmap->start + cmap->len > crtc->gamma_size)
949 r = crtc->gamma_store;
950 g = r + crtc->gamma_size;
951 b = g + crtc->gamma_size;
953 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
954 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
955 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
957 ret = crtc->funcs->gamma_set(crtc, r, g, b,
958 crtc->gamma_size, NULL);
962 drm_modeset_unlock_all(fb_helper->dev);
967 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
968 struct fb_cmap *cmap)
970 struct drm_device *dev = crtc->dev;
971 struct drm_property_blob *gamma_lut;
972 struct drm_color_lut *lut;
973 int size = crtc->gamma_size;
976 if (!size || cmap->start + cmap->len > size)
977 return ERR_PTR(-EINVAL);
979 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
980 if (IS_ERR(gamma_lut))
983 lut = gamma_lut->data;
984 if (cmap->start || cmap->len != size) {
985 u16 *r = crtc->gamma_store;
986 u16 *g = r + crtc->gamma_size;
987 u16 *b = g + crtc->gamma_size;
989 for (i = 0; i < cmap->start; i++) {
994 for (i = cmap->start + cmap->len; i < size; i++) {
1001 for (i = 0; i < cmap->len; i++) {
1002 lut[cmap->start + i].red = cmap->red[i];
1003 lut[cmap->start + i].green = cmap->green[i];
1004 lut[cmap->start + i].blue = cmap->blue[i];
1010 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1012 struct drm_fb_helper *fb_helper = info->par;
1013 struct drm_device *dev = fb_helper->dev;
1014 struct drm_property_blob *gamma_lut = NULL;
1015 struct drm_modeset_acquire_ctx ctx;
1016 struct drm_crtc_state *crtc_state;
1017 struct drm_atomic_state *state;
1018 struct drm_mode_set *modeset;
1019 struct drm_crtc *crtc;
1024 drm_modeset_acquire_init(&ctx, 0);
1026 state = drm_atomic_state_alloc(dev);
1032 state->acquire_ctx = &ctx;
1034 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1035 crtc = modeset->crtc;
1038 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1039 if (IS_ERR(gamma_lut)) {
1040 ret = PTR_ERR(gamma_lut);
1045 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1046 if (IS_ERR(crtc_state)) {
1047 ret = PTR_ERR(crtc_state);
1051 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1053 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1054 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1056 crtc_state->color_mgmt_changed |= replaced;
1059 ret = drm_atomic_commit(state);
1063 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1064 crtc = modeset->crtc;
1066 r = crtc->gamma_store;
1067 g = r + crtc->gamma_size;
1068 b = g + crtc->gamma_size;
1070 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1071 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1072 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1076 if (ret == -EDEADLK)
1079 drm_property_blob_put(gamma_lut);
1080 drm_atomic_state_put(state);
1082 drm_modeset_drop_locks(&ctx);
1083 drm_modeset_acquire_fini(&ctx);
1088 drm_atomic_state_clear(state);
1089 drm_modeset_backoff(&ctx);
1094 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1095 * @cmap: cmap to set
1096 * @info: fbdev registered by the helper
1098 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1100 struct drm_fb_helper *fb_helper = info->par;
1101 struct drm_device *dev = fb_helper->dev;
1104 if (oops_in_progress)
1107 mutex_lock(&fb_helper->lock);
1109 if (!drm_master_internal_acquire(dev)) {
1114 mutex_lock(&fb_helper->client.modeset_mutex);
1115 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1116 ret = setcmap_pseudo_palette(cmap, info);
1117 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1118 ret = setcmap_atomic(cmap, info);
1120 ret = setcmap_legacy(cmap, info);
1121 mutex_unlock(&fb_helper->client.modeset_mutex);
1123 drm_master_internal_release(dev);
1125 mutex_unlock(&fb_helper->lock);
1129 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1132 * drm_fb_helper_ioctl - legacy ioctl implementation
1133 * @info: fbdev registered by the helper
1134 * @cmd: ioctl command
1135 * @arg: ioctl argument
1137 * A helper to implement the standard fbdev ioctl. Only
1138 * FBIO_WAITFORVSYNC is implemented for now.
1140 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1143 struct drm_fb_helper *fb_helper = info->par;
1144 struct drm_device *dev = fb_helper->dev;
1145 struct drm_crtc *crtc;
1148 mutex_lock(&fb_helper->lock);
1149 if (!drm_master_internal_acquire(dev)) {
1155 case FBIO_WAITFORVSYNC:
1157 * Only consider the first CRTC.
1159 * This ioctl is supposed to take the CRTC number as
1160 * an argument, but in fbdev times, what that number
1161 * was supposed to be was quite unclear, different
1162 * drivers were passing that argument differently
1163 * (some by reference, some by value), and most of the
1164 * userspace applications were just hardcoding 0 as an
1167 * The first CRTC should be the integrated panel on
1168 * most drivers, so this is the best choice we can
1169 * make. If we're not smart enough here, one should
1170 * just consider switch the userspace to KMS.
1172 crtc = fb_helper->client.modesets[0].crtc;
1175 * Only wait for a vblank event if the CRTC is
1176 * enabled, otherwise just don't do anythintg,
1177 * not even report an error.
1179 ret = drm_crtc_vblank_get(crtc);
1181 drm_crtc_wait_one_vblank(crtc);
1182 drm_crtc_vblank_put(crtc);
1191 drm_master_internal_release(dev);
1193 mutex_unlock(&fb_helper->lock);
1196 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1198 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1199 const struct fb_var_screeninfo *var_2)
1201 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1202 var_1->grayscale == var_2->grayscale &&
1203 var_1->red.offset == var_2->red.offset &&
1204 var_1->red.length == var_2->red.length &&
1205 var_1->red.msb_right == var_2->red.msb_right &&
1206 var_1->green.offset == var_2->green.offset &&
1207 var_1->green.length == var_2->green.length &&
1208 var_1->green.msb_right == var_2->green.msb_right &&
1209 var_1->blue.offset == var_2->blue.offset &&
1210 var_1->blue.length == var_2->blue.length &&
1211 var_1->blue.msb_right == var_2->blue.msb_right &&
1212 var_1->transp.offset == var_2->transp.offset &&
1213 var_1->transp.length == var_2->transp.length &&
1214 var_1->transp.msb_right == var_2->transp.msb_right;
1217 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1222 var->red.offset = 0;
1223 var->green.offset = 0;
1224 var->blue.offset = 0;
1225 var->red.length = 8; /* 8bit DAC */
1226 var->green.length = 8;
1227 var->blue.length = 8;
1228 var->transp.offset = 0;
1229 var->transp.length = 0;
1232 var->red.offset = 10;
1233 var->green.offset = 5;
1234 var->blue.offset = 0;
1235 var->red.length = 5;
1236 var->green.length = 5;
1237 var->blue.length = 5;
1238 var->transp.offset = 15;
1239 var->transp.length = 1;
1242 var->red.offset = 11;
1243 var->green.offset = 5;
1244 var->blue.offset = 0;
1245 var->red.length = 5;
1246 var->green.length = 6;
1247 var->blue.length = 5;
1248 var->transp.offset = 0;
1251 var->red.offset = 16;
1252 var->green.offset = 8;
1253 var->blue.offset = 0;
1254 var->red.length = 8;
1255 var->green.length = 8;
1256 var->blue.length = 8;
1257 var->transp.offset = 0;
1258 var->transp.length = 0;
1261 var->red.offset = 16;
1262 var->green.offset = 8;
1263 var->blue.offset = 0;
1264 var->red.length = 8;
1265 var->green.length = 8;
1266 var->blue.length = 8;
1267 var->transp.offset = 24;
1268 var->transp.length = 8;
1276 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1277 * @var: screeninfo to check
1278 * @info: fbdev registered by the helper
1280 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1281 struct fb_info *info)
1283 struct drm_fb_helper *fb_helper = info->par;
1284 struct drm_framebuffer *fb = fb_helper->fb;
1286 if (in_dbg_master())
1289 if (var->pixclock != 0) {
1290 DRM_DEBUG("fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1294 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1295 (drm_format_info_block_height(fb->format, 0) > 1))
1299 * Changes struct fb_var_screeninfo are currently not pushed back
1300 * to KMS, hence fail if different settings are requested.
1302 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1303 var->xres > fb->width || var->yres > fb->height ||
1304 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1305 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1306 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1307 var->xres, var->yres, var->bits_per_pixel,
1308 var->xres_virtual, var->yres_virtual,
1309 fb->width, fb->height, fb->format->cpp[0] * 8);
1314 * Workaround for SDL 1.2, which is known to be setting all pixel format
1315 * fields values to zero in some cases. We treat this situation as a
1316 * kind of "use some reasonable autodetected values".
1318 if (!var->red.offset && !var->green.offset &&
1319 !var->blue.offset && !var->transp.offset &&
1320 !var->red.length && !var->green.length &&
1321 !var->blue.length && !var->transp.length &&
1322 !var->red.msb_right && !var->green.msb_right &&
1323 !var->blue.msb_right && !var->transp.msb_right) {
1324 drm_fb_helper_fill_pixel_fmt(var, fb->format->depth);
1328 * drm fbdev emulation doesn't support changing the pixel format at all,
1329 * so reject all pixel format changing requests.
1331 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1332 DRM_DEBUG("fbdev emulation doesn't support changing the pixel format\n");
1338 EXPORT_SYMBOL(drm_fb_helper_check_var);
1341 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1342 * @info: fbdev registered by the helper
1344 * This will let fbcon do the mode init and is called at initialization time by
1345 * the fbdev core when registering the driver, and later on through the hotplug
1348 int drm_fb_helper_set_par(struct fb_info *info)
1350 struct drm_fb_helper *fb_helper = info->par;
1351 struct fb_var_screeninfo *var = &info->var;
1353 if (oops_in_progress)
1356 if (var->pixclock != 0) {
1357 DRM_ERROR("PIXEL CLOCK SET\n");
1361 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1365 EXPORT_SYMBOL(drm_fb_helper_set_par);
1367 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1369 struct drm_mode_set *mode_set;
1371 mutex_lock(&fb_helper->client.modeset_mutex);
1372 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1376 mutex_unlock(&fb_helper->client.modeset_mutex);
1379 static int pan_display_atomic(struct fb_var_screeninfo *var,
1380 struct fb_info *info)
1382 struct drm_fb_helper *fb_helper = info->par;
1385 pan_set(fb_helper, var->xoffset, var->yoffset);
1387 ret = drm_client_modeset_commit_force(&fb_helper->client);
1389 info->var.xoffset = var->xoffset;
1390 info->var.yoffset = var->yoffset;
1392 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1397 static int pan_display_legacy(struct fb_var_screeninfo *var,
1398 struct fb_info *info)
1400 struct drm_fb_helper *fb_helper = info->par;
1401 struct drm_client_dev *client = &fb_helper->client;
1402 struct drm_mode_set *modeset;
1405 mutex_lock(&client->modeset_mutex);
1406 drm_modeset_lock_all(fb_helper->dev);
1407 drm_client_for_each_modeset(modeset, client) {
1408 modeset->x = var->xoffset;
1409 modeset->y = var->yoffset;
1411 if (modeset->num_connectors) {
1412 ret = drm_mode_set_config_internal(modeset);
1414 info->var.xoffset = var->xoffset;
1415 info->var.yoffset = var->yoffset;
1419 drm_modeset_unlock_all(fb_helper->dev);
1420 mutex_unlock(&client->modeset_mutex);
1426 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1427 * @var: updated screen information
1428 * @info: fbdev registered by the helper
1430 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1431 struct fb_info *info)
1433 struct drm_fb_helper *fb_helper = info->par;
1434 struct drm_device *dev = fb_helper->dev;
1437 if (oops_in_progress)
1440 mutex_lock(&fb_helper->lock);
1441 if (!drm_master_internal_acquire(dev)) {
1446 if (drm_drv_uses_atomic_modeset(dev))
1447 ret = pan_display_atomic(var, info);
1449 ret = pan_display_legacy(var, info);
1451 drm_master_internal_release(dev);
1453 mutex_unlock(&fb_helper->lock);
1457 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1460 * Allocates the backing storage and sets up the fbdev info structure through
1461 * the ->fb_probe callback.
1463 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1466 struct drm_client_dev *client = &fb_helper->client;
1469 struct drm_connector_list_iter conn_iter;
1470 struct drm_fb_helper_surface_size sizes;
1471 struct drm_connector *connector;
1472 struct drm_mode_set *mode_set;
1475 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1476 sizes.surface_depth = 24;
1477 sizes.surface_bpp = 32;
1478 sizes.fb_width = (u32)-1;
1479 sizes.fb_height = (u32)-1;
1482 * If driver picks 8 or 16 by default use that for both depth/bpp
1485 if (preferred_bpp != sizes.surface_bpp)
1486 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1488 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1489 drm_client_for_each_connector_iter(connector, &conn_iter) {
1490 struct drm_cmdline_mode *cmdline_mode;
1492 cmdline_mode = &connector->cmdline_mode;
1494 if (cmdline_mode->bpp_specified) {
1495 switch (cmdline_mode->bpp) {
1497 sizes.surface_depth = sizes.surface_bpp = 8;
1500 sizes.surface_depth = 15;
1501 sizes.surface_bpp = 16;
1504 sizes.surface_depth = sizes.surface_bpp = 16;
1507 sizes.surface_depth = sizes.surface_bpp = 24;
1510 sizes.surface_depth = 24;
1511 sizes.surface_bpp = 32;
1517 drm_connector_list_iter_end(&conn_iter);
1520 * If we run into a situation where, for example, the primary plane
1521 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1522 * 16) we need to scale down the depth of the sizes we request.
1524 mutex_lock(&client->modeset_mutex);
1525 drm_client_for_each_modeset(mode_set, client) {
1526 struct drm_crtc *crtc = mode_set->crtc;
1527 struct drm_plane *plane = crtc->primary;
1530 DRM_DEBUG("test CRTC %u primary plane\n", drm_crtc_index(crtc));
1532 for (j = 0; j < plane->format_count; j++) {
1533 const struct drm_format_info *fmt;
1535 fmt = drm_format_info(plane->format_types[j]);
1538 * Do not consider YUV or other complicated formats
1539 * for framebuffers. This means only legacy formats
1540 * are supported (fmt->depth is a legacy field) but
1541 * the framebuffer emulation can only deal with such
1542 * formats, specifically RGB/BGA formats.
1544 if (fmt->depth == 0)
1547 /* We found a perfect fit, great */
1548 if (fmt->depth == sizes.surface_depth) {
1549 best_depth = fmt->depth;
1553 /* Skip depths above what we're looking for */
1554 if (fmt->depth > sizes.surface_depth)
1557 /* Best depth found so far */
1558 if (fmt->depth > best_depth)
1559 best_depth = fmt->depth;
1562 if (sizes.surface_depth != best_depth && best_depth) {
1563 DRM_INFO("requested bpp %d, scaled depth down to %d",
1564 sizes.surface_bpp, best_depth);
1565 sizes.surface_depth = best_depth;
1568 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1570 drm_client_for_each_modeset(mode_set, client) {
1571 struct drm_display_mode *desired_mode;
1573 /* in case of tile group, are we the last tile vert or horiz?
1574 * If no tile group you are always the last one both vertically
1577 bool lastv = true, lasth = true;
1579 desired_mode = mode_set->mode;
1589 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1590 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1592 for (j = 0; j < mode_set->num_connectors; j++) {
1593 struct drm_connector *connector = mode_set->connectors[j];
1595 if (connector->has_tile) {
1596 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1597 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1598 /* cloning to multiple tiles is just crazy-talk, so: */
1604 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1606 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1608 mutex_unlock(&client->modeset_mutex);
1610 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1611 DRM_INFO("Cannot find any crtc or sizes\n");
1613 /* First time: disable all crtc's.. */
1614 if (!fb_helper->deferred_setup)
1615 drm_client_modeset_commit(client);
1619 /* Handle our overallocation */
1620 sizes.surface_height *= drm_fbdev_overalloc;
1621 sizes.surface_height /= 100;
1623 /* push down into drivers */
1624 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1628 strcpy(fb_helper->fb->comm, "[fbcon]");
1632 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1635 info->fix.type = FB_TYPE_PACKED_PIXELS;
1636 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1637 FB_VISUAL_TRUECOLOR;
1638 info->fix.mmio_start = 0;
1639 info->fix.mmio_len = 0;
1640 info->fix.type_aux = 0;
1641 info->fix.xpanstep = 1; /* doing it in hw */
1642 info->fix.ypanstep = 1; /* doing it in hw */
1643 info->fix.ywrapstep = 0;
1644 info->fix.accel = FB_ACCEL_NONE;
1646 info->fix.line_length = pitch;
1649 static void drm_fb_helper_fill_var(struct fb_info *info,
1650 struct drm_fb_helper *fb_helper,
1651 uint32_t fb_width, uint32_t fb_height)
1653 struct drm_framebuffer *fb = fb_helper->fb;
1655 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
1656 (drm_format_info_block_height(fb->format, 0) > 1));
1657 info->pseudo_palette = fb_helper->pseudo_palette;
1658 info->var.xres_virtual = fb->width;
1659 info->var.yres_virtual = fb->height;
1660 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1661 info->var.accel_flags = FB_ACCELF_TEXT;
1662 info->var.xoffset = 0;
1663 info->var.yoffset = 0;
1664 info->var.activate = FB_ACTIVATE_NOW;
1666 drm_fb_helper_fill_pixel_fmt(&info->var, fb->format->depth);
1668 info->var.xres = fb_width;
1669 info->var.yres = fb_height;
1673 * drm_fb_helper_fill_info - initializes fbdev information
1674 * @info: fbdev instance to set up
1675 * @fb_helper: fb helper instance to use as template
1676 * @sizes: describes fbdev size and scanout surface size
1678 * Sets up the variable and fixed fbdev metainformation from the given fb helper
1679 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
1681 * Drivers should call this (or their equivalent setup code) from their
1682 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1683 * backing storage framebuffer.
1685 void drm_fb_helper_fill_info(struct fb_info *info,
1686 struct drm_fb_helper *fb_helper,
1687 struct drm_fb_helper_surface_size *sizes)
1689 struct drm_framebuffer *fb = fb_helper->fb;
1691 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
1692 drm_fb_helper_fill_var(info, fb_helper,
1693 sizes->fb_width, sizes->fb_height);
1695 info->par = fb_helper;
1696 snprintf(info->fix.id, sizeof(info->fix.id), "%sdrmfb",
1697 fb_helper->dev->driver->name);
1700 EXPORT_SYMBOL(drm_fb_helper_fill_info);
1703 * This is a continuation of drm_setup_crtcs() that sets up anything related
1704 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
1705 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
1706 * So, any setup that touches those fields needs to be done here instead of in
1707 * drm_setup_crtcs().
1709 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
1711 struct drm_client_dev *client = &fb_helper->client;
1712 struct drm_connector_list_iter conn_iter;
1713 struct fb_info *info = fb_helper->fbdev;
1714 unsigned int rotation, sw_rotations = 0;
1715 struct drm_connector *connector;
1716 struct drm_mode_set *modeset;
1718 mutex_lock(&client->modeset_mutex);
1719 drm_client_for_each_modeset(modeset, client) {
1720 if (!modeset->num_connectors)
1723 modeset->fb = fb_helper->fb;
1725 if (drm_client_rotation(modeset, &rotation))
1726 /* Rotating in hardware, fbcon should not rotate */
1727 sw_rotations |= DRM_MODE_ROTATE_0;
1729 sw_rotations |= rotation;
1731 mutex_unlock(&client->modeset_mutex);
1733 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1734 drm_client_for_each_connector_iter(connector, &conn_iter) {
1736 /* use first connected connector for the physical dimensions */
1737 if (connector->status == connector_status_connected) {
1738 info->var.width = connector->display_info.width_mm;
1739 info->var.height = connector->display_info.height_mm;
1743 drm_connector_list_iter_end(&conn_iter);
1745 switch (sw_rotations) {
1746 case DRM_MODE_ROTATE_0:
1747 info->fbcon_rotate_hint = FB_ROTATE_UR;
1749 case DRM_MODE_ROTATE_90:
1750 info->fbcon_rotate_hint = FB_ROTATE_CCW;
1752 case DRM_MODE_ROTATE_180:
1753 info->fbcon_rotate_hint = FB_ROTATE_UD;
1755 case DRM_MODE_ROTATE_270:
1756 info->fbcon_rotate_hint = FB_ROTATE_CW;
1760 * Multiple bits are set / multiple rotations requested
1761 * fbcon cannot handle separate rotation settings per
1762 * output, so fallback to unrotated.
1764 info->fbcon_rotate_hint = FB_ROTATE_UR;
1768 /* Note: Drops fb_helper->lock before returning. */
1770 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
1773 struct drm_device *dev = fb_helper->dev;
1774 struct fb_info *info;
1775 unsigned int width, height;
1778 width = dev->mode_config.max_width;
1779 height = dev->mode_config.max_height;
1781 drm_client_modeset_probe(&fb_helper->client, width, height);
1782 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1784 if (ret == -EAGAIN) {
1785 fb_helper->preferred_bpp = bpp_sel;
1786 fb_helper->deferred_setup = true;
1789 mutex_unlock(&fb_helper->lock);
1793 drm_setup_crtcs_fb(fb_helper);
1795 fb_helper->deferred_setup = false;
1797 info = fb_helper->fbdev;
1798 info->var.pixclock = 0;
1799 /* Shamelessly allow physical address leaking to userspace */
1800 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1801 if (!drm_leak_fbdev_smem)
1803 /* don't leak any physical addresses to userspace */
1804 info->flags |= FBINFO_HIDE_SMEM_START;
1806 /* Need to drop locks to avoid recursive deadlock in
1807 * register_framebuffer. This is ok because the only thing left to do is
1808 * register the fbdev emulation instance in kernel_fb_helper_list. */
1809 mutex_unlock(&fb_helper->lock);
1811 ret = register_framebuffer(info);
1815 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
1816 info->node, info->fix.id);
1818 mutex_lock(&kernel_fb_helper_lock);
1819 if (list_empty(&kernel_fb_helper_list))
1820 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1822 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1823 mutex_unlock(&kernel_fb_helper_lock);
1829 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1830 * @fb_helper: fb_helper device struct
1831 * @bpp_sel: bpp value to use for the framebuffer configuration
1833 * Scans the CRTCs and connectors and tries to put together an initial setup.
1834 * At the moment, this is a cloned configuration across all heads with
1835 * a new framebuffer object as the backing store.
1837 * Note that this also registers the fbdev and so allows userspace to call into
1838 * the driver through the fbdev interfaces.
1840 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
1841 * to let the driver allocate and initialize the fbdev info structure and the
1842 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
1843 * as a helper to setup simple default values for the fbdev info structure.
1847 * When you have fbcon support built-in or already loaded, this function will do
1848 * a full modeset to setup the fbdev console. Due to locking misdesign in the
1849 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
1850 * console_lock. Until console_unlock is called no dmesg lines will be sent out
1851 * to consoles, not even serial console. This means when your driver crashes,
1852 * you will see absolutely nothing else but a system stuck in this function,
1853 * with no further output. Any kind of printk() you place within your own driver
1854 * or in the drm core modeset code will also never show up.
1856 * Standard debug practice is to run the fbcon setup without taking the
1857 * console_lock as a hack, to be able to see backtraces and crashes on the
1858 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
1861 * The other option is to just disable fbdev emulation since very likely the
1862 * first modeset from userspace will crash in the same way, and is even easier
1863 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
1864 * kernel cmdline option.
1867 * Zero if everything went ok, nonzero otherwise.
1869 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1873 if (!drm_fbdev_emulation)
1876 mutex_lock(&fb_helper->lock);
1877 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
1881 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1884 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1885 * probing all the outputs attached to the fb
1886 * @fb_helper: driver-allocated fbdev helper, can be NULL
1888 * Scan the connectors attached to the fb_helper and try to put together a
1889 * setup after notification of a change in output configuration.
1891 * Called at runtime, takes the mode config locks to be able to check/change the
1892 * modeset configuration. Must be run from process context (which usually means
1893 * either the output polling work or a work item launched from the driver's
1894 * hotplug interrupt).
1896 * Note that drivers may call this even before calling
1897 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
1898 * for a race-free fbcon setup and will make sure that the fbdev emulation will
1899 * not miss any hotplug events.
1902 * 0 on success and a non-zero error code otherwise.
1904 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1908 if (!drm_fbdev_emulation || !fb_helper)
1911 mutex_lock(&fb_helper->lock);
1912 if (fb_helper->deferred_setup) {
1913 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
1914 fb_helper->preferred_bpp);
1918 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
1919 fb_helper->delayed_hotplug = true;
1920 mutex_unlock(&fb_helper->lock);
1924 drm_master_internal_release(fb_helper->dev);
1926 DRM_DEBUG_KMS("\n");
1928 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
1929 drm_setup_crtcs_fb(fb_helper);
1930 mutex_unlock(&fb_helper->lock);
1932 drm_fb_helper_set_par(fb_helper->fbdev);
1936 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1939 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
1941 * @fb_helper: fbdev helper structure to set up
1942 * @funcs: fbdev helper functions
1943 * @preferred_bpp: Preferred bits per pixel for the device.
1944 * @dev->mode_config.preferred_depth is used if this is zero.
1945 * @max_conn_count: Maximum number of connectors (not used)
1947 * This function sets up fbdev emulation and registers fbdev for access by
1948 * userspace. If all connectors are disconnected, setup is deferred to the next
1949 * time drm_fb_helper_hotplug_event() is called.
1950 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
1953 * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev.
1955 * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup().
1958 * Zero on success or negative error code on failure.
1960 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
1961 struct drm_fb_helper *fb_helper,
1962 const struct drm_fb_helper_funcs *funcs,
1963 unsigned int preferred_bpp,
1964 unsigned int max_conn_count)
1969 preferred_bpp = dev->mode_config.preferred_depth;
1973 drm_fb_helper_prepare(dev, fb_helper, funcs);
1975 ret = drm_fb_helper_init(dev, fb_helper, 0);
1977 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to initialize (ret=%d)\n", ret);
1981 if (!drm_drv_uses_atomic_modeset(dev))
1982 drm_helper_disable_unused_functions(dev);
1984 ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
1986 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to set configuration (ret=%d)\n", ret);
1987 goto err_drm_fb_helper_fini;
1992 err_drm_fb_helper_fini:
1993 drm_fb_helper_fbdev_teardown(dev);
1997 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2000 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2003 * This function unregisters fbdev if not already done and cleans up the
2004 * associated resources including the &drm_framebuffer.
2005 * The driver is responsible for freeing the &drm_fb_helper structure which is
2006 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2007 * when this function returns.
2009 * In order to support device removal/unplug while file handles are still open,
2010 * drm_fb_helper_unregister_fbi() should be called on device removal and
2011 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2012 * file handles are closed.
2014 void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2016 struct drm_fb_helper *fb_helper = dev->fb_helper;
2017 struct fb_ops *fbops = NULL;
2022 /* Unregister if it hasn't been done already */
2023 if (fb_helper->fbdev && fb_helper->fbdev->dev)
2024 drm_fb_helper_unregister_fbi(fb_helper);
2026 if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2027 fb_deferred_io_cleanup(fb_helper->fbdev);
2028 kfree(fb_helper->fbdev->fbdefio);
2029 fbops = fb_helper->fbdev->fbops;
2032 drm_fb_helper_fini(fb_helper);
2036 drm_framebuffer_remove(fb_helper->fb);
2038 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2041 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2044 * This function can be used as the &drm_driver->lastclose callback for drivers
2045 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2047 void drm_fb_helper_lastclose(struct drm_device *dev)
2049 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2051 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2054 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2055 * helper for fbdev emulation
2058 * This function can be used as the
2059 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2060 * need to call drm_fb_helper_hotplug_event().
2062 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2064 drm_fb_helper_hotplug_event(dev->fb_helper);
2066 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2068 /* @user: 1=userspace, 0=fbcon */
2069 static int drm_fbdev_fb_open(struct fb_info *info, int user)
2071 struct drm_fb_helper *fb_helper = info->par;
2073 /* No need to take a ref for fbcon because it unbinds on unregister */
2074 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
2080 static int drm_fbdev_fb_release(struct fb_info *info, int user)
2082 struct drm_fb_helper *fb_helper = info->par;
2085 module_put(fb_helper->dev->driver->fops->owner);
2090 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
2092 struct fb_info *fbi = fb_helper->fbdev;
2093 struct fb_ops *fbops = NULL;
2094 void *shadow = NULL;
2096 if (!fb_helper->dev)
2099 if (fbi && fbi->fbdefio) {
2100 fb_deferred_io_cleanup(fbi);
2101 shadow = fbi->screen_buffer;
2105 drm_fb_helper_fini(fb_helper);
2112 drm_client_framebuffer_delete(fb_helper->buffer);
2115 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
2117 drm_fbdev_cleanup(fb_helper);
2118 drm_client_release(&fb_helper->client);
2123 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2124 * unregister_framebuffer() or fb_release().
2126 static void drm_fbdev_fb_destroy(struct fb_info *info)
2128 drm_fbdev_release(info->par);
2131 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
2133 struct drm_fb_helper *fb_helper = info->par;
2135 if (fb_helper->dev->driver->gem_prime_mmap)
2136 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2141 static struct fb_ops drm_fbdev_fb_ops = {
2142 .owner = THIS_MODULE,
2143 DRM_FB_HELPER_DEFAULT_OPS,
2144 .fb_open = drm_fbdev_fb_open,
2145 .fb_release = drm_fbdev_fb_release,
2146 .fb_destroy = drm_fbdev_fb_destroy,
2147 .fb_mmap = drm_fbdev_fb_mmap,
2148 .fb_read = drm_fb_helper_sys_read,
2149 .fb_write = drm_fb_helper_sys_write,
2150 .fb_fillrect = drm_fb_helper_sys_fillrect,
2151 .fb_copyarea = drm_fb_helper_sys_copyarea,
2152 .fb_imageblit = drm_fb_helper_sys_imageblit,
2155 static struct fb_deferred_io drm_fbdev_defio = {
2157 .deferred_io = drm_fb_helper_deferred_io,
2161 * drm_fb_helper_generic_probe - Generic fbdev emulation probe helper
2162 * @fb_helper: fbdev helper structure
2163 * @sizes: describes fbdev size and scanout surface size
2165 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2167 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2168 * fb_copyarea, fb_imageblit.
2171 * Zero on success or negative error code on failure.
2173 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2174 struct drm_fb_helper_surface_size *sizes)
2176 struct drm_client_dev *client = &fb_helper->client;
2177 struct drm_client_buffer *buffer;
2178 struct drm_framebuffer *fb;
2179 struct fb_info *fbi;
2182 DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
2183 sizes->surface_width, sizes->surface_height,
2184 sizes->surface_bpp);
2186 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2187 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2188 sizes->surface_height, format);
2190 return PTR_ERR(buffer);
2192 fb_helper->buffer = buffer;
2193 fb_helper->fb = buffer->fb;
2196 fbi = drm_fb_helper_alloc_fbi(fb_helper);
2198 return PTR_ERR(fbi);
2200 fbi->fbops = &drm_fbdev_fb_ops;
2201 fbi->screen_size = fb->height * fb->pitches[0];
2202 fbi->fix.smem_len = fbi->screen_size;
2203 fbi->screen_buffer = buffer->vaddr;
2204 /* Shamelessly leak the physical address to user-space */
2205 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2206 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0)
2207 fbi->fix.smem_start =
2208 page_to_phys(virt_to_page(fbi->screen_buffer));
2210 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2212 if (fb->funcs->dirty) {
2213 struct fb_ops *fbops;
2217 * fb_deferred_io_cleanup() clears &fbops->fb_mmap so a per
2218 * instance version is necessary.
2220 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
2221 shadow = vzalloc(fbi->screen_size);
2222 if (!fbops || !shadow) {
2228 *fbops = *fbi->fbops;
2230 fbi->screen_buffer = shadow;
2231 fbi->fbdefio = &drm_fbdev_defio;
2233 fb_deferred_io_init(fbi);
2238 EXPORT_SYMBOL(drm_fb_helper_generic_probe);
2240 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2241 .fb_probe = drm_fb_helper_generic_probe,
2244 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2246 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2248 if (fb_helper->fbdev)
2249 /* drm_fbdev_fb_destroy() takes care of cleanup */
2250 drm_fb_helper_unregister_fbi(fb_helper);
2252 drm_fbdev_release(fb_helper);
2255 static int drm_fbdev_client_restore(struct drm_client_dev *client)
2257 drm_fb_helper_lastclose(client->dev);
2262 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2264 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2265 struct drm_device *dev = client->dev;
2268 /* Setup is not retried if it has failed */
2269 if (!fb_helper->dev && fb_helper->funcs)
2273 return drm_fb_helper_hotplug_event(dev->fb_helper);
2275 if (!dev->mode_config.num_connector) {
2276 DRM_DEV_DEBUG(dev->dev, "No connectors found, will not create framebuffer!\n");
2280 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2282 ret = drm_fb_helper_init(dev, fb_helper, 0);
2286 if (!drm_drv_uses_atomic_modeset(dev))
2287 drm_helper_disable_unused_functions(dev);
2289 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2296 drm_fbdev_cleanup(fb_helper);
2298 fb_helper->dev = NULL;
2299 fb_helper->fbdev = NULL;
2301 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2306 static const struct drm_client_funcs drm_fbdev_client_funcs = {
2307 .owner = THIS_MODULE,
2308 .unregister = drm_fbdev_client_unregister,
2309 .restore = drm_fbdev_client_restore,
2310 .hotplug = drm_fbdev_client_hotplug,
2314 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2316 * @preferred_bpp: Preferred bits per pixel for the device.
2317 * @dev->mode_config.preferred_depth is used if this is zero.
2319 * This function sets up generic fbdev emulation for drivers that supports
2320 * dumb buffers with a virtual address and that can be mmap'ed. If the driver
2321 * does not support these functions, it could use drm_fb_helper_fbdev_setup().
2323 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2324 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2325 * Simple drivers might use drm_mode_config_helper_suspend().
2327 * Drivers that set the dirty callback on their framebuffer will get a shadow
2328 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2329 * make deferred I/O work with all kinds of buffers.
2331 * This function is safe to call even when there are no connectors present.
2332 * Setup will be retried on the next hotplug event.
2334 * The fbdev is destroyed by drm_dev_unregister().
2337 * Zero on success or negative error code on failure.
2339 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
2341 struct drm_fb_helper *fb_helper;
2344 WARN(dev->fb_helper, "fb_helper is already set!\n");
2346 if (!drm_fbdev_emulation)
2349 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2353 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2356 DRM_DEV_ERROR(dev->dev, "Failed to register client: %d\n", ret);
2361 preferred_bpp = dev->mode_config.preferred_depth;
2364 fb_helper->preferred_bpp = preferred_bpp;
2366 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2368 DRM_DEV_DEBUG(dev->dev, "client hotplug ret=%d\n", ret);
2370 drm_client_register(&fb_helper->client);
2374 EXPORT_SYMBOL(drm_fbdev_generic_setup);
2376 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2377 * but the module doesn't depend on any fb console symbols. At least
2378 * attempt to load fbcon to avoid leaving the system without a usable console.
2380 int __init drm_fb_helper_modinit(void)
2382 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2383 const char name[] = "fbcon";
2384 struct module *fbcon;
2386 mutex_lock(&module_mutex);
2387 fbcon = find_module(name);
2388 mutex_unlock(&module_mutex);
2391 request_module_nowait(name);
2395 EXPORT_SYMBOL(drm_fb_helper_modinit);