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().
95 * It will automatically set up deferred I/O if the driver requires a shadow
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
131 * Deferred I/O is not compatible with SHMEM. Such drivers should request an
132 * fbdev shadow buffer and call drm_fbdev_generic_setup() instead.
135 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
137 uint16_t *r_base, *g_base, *b_base;
139 if (crtc->funcs->gamma_set == NULL)
142 r_base = crtc->gamma_store;
143 g_base = r_base + crtc->gamma_size;
144 b_base = g_base + crtc->gamma_size;
146 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
147 crtc->gamma_size, NULL);
151 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
152 * @info: fbdev registered by the helper
154 int drm_fb_helper_debug_enter(struct fb_info *info)
156 struct drm_fb_helper *helper = info->par;
157 const struct drm_crtc_helper_funcs *funcs;
158 struct drm_mode_set *mode_set;
160 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
161 mutex_lock(&helper->client.modeset_mutex);
162 drm_client_for_each_modeset(mode_set, &helper->client) {
163 if (!mode_set->crtc->enabled)
166 funcs = mode_set->crtc->helper_private;
167 if (funcs->mode_set_base_atomic == NULL)
170 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
173 funcs->mode_set_base_atomic(mode_set->crtc,
177 ENTER_ATOMIC_MODE_SET);
179 mutex_unlock(&helper->client.modeset_mutex);
184 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
187 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
188 * @info: fbdev registered by the helper
190 int drm_fb_helper_debug_leave(struct fb_info *info)
192 struct drm_fb_helper *helper = info->par;
193 struct drm_client_dev *client = &helper->client;
194 struct drm_device *dev = helper->dev;
195 struct drm_crtc *crtc;
196 const struct drm_crtc_helper_funcs *funcs;
197 struct drm_mode_set *mode_set;
198 struct drm_framebuffer *fb;
200 mutex_lock(&client->modeset_mutex);
201 drm_client_for_each_modeset(mode_set, client) {
202 crtc = mode_set->crtc;
203 if (drm_drv_uses_atomic_modeset(crtc->dev))
206 funcs = crtc->helper_private;
207 fb = crtc->primary->fb;
213 drm_err(dev, "no fb to restore?\n");
217 if (funcs->mode_set_base_atomic == NULL)
220 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
221 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
222 crtc->y, LEAVE_ATOMIC_MODE_SET);
224 mutex_unlock(&client->modeset_mutex);
228 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
231 __drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper,
237 if (!drm_fbdev_emulation || !fb_helper)
240 if (READ_ONCE(fb_helper->deferred_setup))
243 mutex_lock(&fb_helper->lock);
246 * Yes this is the _locked version which expects the master lock
247 * to be held. But for forced restores we're intentionally
248 * racing here, see drm_fb_helper_set_par().
250 ret = drm_client_modeset_commit_locked(&fb_helper->client);
252 ret = drm_client_modeset_commit(&fb_helper->client);
255 do_delayed = fb_helper->delayed_hotplug;
257 fb_helper->delayed_hotplug = false;
258 mutex_unlock(&fb_helper->lock);
261 drm_fb_helper_hotplug_event(fb_helper);
267 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
268 * @fb_helper: driver-allocated fbdev helper, can be NULL
270 * This should be called from driver's drm &drm_driver.lastclose callback
271 * when implementing an fbcon on top of kms using this helper. This ensures that
272 * the user isn't greeted with a black screen when e.g. X dies.
275 * Zero if everything went ok, negative error code otherwise.
277 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
279 return __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, false);
281 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
283 #ifdef CONFIG_MAGIC_SYSRQ
284 /* emergency restore, don't bother with error reporting */
285 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
287 struct drm_fb_helper *helper;
289 mutex_lock(&kernel_fb_helper_lock);
290 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
291 struct drm_device *dev = helper->dev;
293 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
296 mutex_lock(&helper->lock);
297 drm_client_modeset_commit_locked(&helper->client);
298 mutex_unlock(&helper->lock);
300 mutex_unlock(&kernel_fb_helper_lock);
303 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
305 static void drm_fb_helper_sysrq(int dummy1)
307 schedule_work(&drm_fb_helper_restore_work);
310 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
311 .handler = drm_fb_helper_sysrq,
312 .help_msg = "force-fb(v)",
313 .action_msg = "Restore framebuffer console",
316 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
319 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
321 struct drm_fb_helper *fb_helper = info->par;
323 mutex_lock(&fb_helper->lock);
324 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
325 mutex_unlock(&fb_helper->lock);
329 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
330 * @blank: desired blanking state
331 * @info: fbdev registered by the helper
333 int drm_fb_helper_blank(int blank, struct fb_info *info)
335 if (oops_in_progress)
339 /* Display: On; HSync: On, VSync: On */
340 case FB_BLANK_UNBLANK:
341 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
343 /* Display: Off; HSync: On, VSync: On */
344 case FB_BLANK_NORMAL:
345 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
347 /* Display: Off; HSync: Off, VSync: On */
348 case FB_BLANK_HSYNC_SUSPEND:
349 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
351 /* Display: Off; HSync: On, VSync: Off */
352 case FB_BLANK_VSYNC_SUSPEND:
353 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
355 /* Display: Off; HSync: Off, VSync: Off */
356 case FB_BLANK_POWERDOWN:
357 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
362 EXPORT_SYMBOL(drm_fb_helper_blank);
364 static void drm_fb_helper_resume_worker(struct work_struct *work)
366 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
370 fb_set_suspend(helper->fbdev, 0);
374 static void drm_fb_helper_damage_blit_real(struct drm_fb_helper *fb_helper,
375 struct drm_clip_rect *clip,
376 struct dma_buf_map *dst)
378 struct drm_framebuffer *fb = fb_helper->fb;
379 unsigned int cpp = fb->format->cpp[0];
380 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
381 void *src = fb_helper->fbdev->screen_buffer + offset;
382 size_t len = (clip->x2 - clip->x1) * cpp;
385 dma_buf_map_incr(dst, offset); /* go to first pixel within clip rect */
387 for (y = clip->y1; y < clip->y2; y++) {
388 dma_buf_map_memcpy_to(dst, src, len);
389 dma_buf_map_incr(dst, fb->pitches[0]);
390 src += fb->pitches[0];
394 static int drm_fb_helper_damage_blit(struct drm_fb_helper *fb_helper,
395 struct drm_clip_rect *clip)
397 struct drm_client_buffer *buffer = fb_helper->buffer;
398 struct dma_buf_map map, dst;
402 * We have to pin the client buffer to its current location while
403 * flushing the shadow buffer. In the general case, concurrent
404 * modesetting operations could try to move the buffer and would
405 * fail. The modeset has to be serialized by acquiring the reservation
406 * object of the underlying BO here.
408 * For fbdev emulation, we only have to protect against fbdev modeset
409 * operations. Nothing else will involve the client buffer's BO. So it
410 * is sufficient to acquire struct drm_fb_helper.lock here.
412 mutex_lock(&fb_helper->lock);
414 ret = drm_client_buffer_vmap(buffer, &map);
419 drm_fb_helper_damage_blit_real(fb_helper, clip, &dst);
421 drm_client_buffer_vunmap(buffer);
424 mutex_unlock(&fb_helper->lock);
429 static void drm_fb_helper_damage_work(struct work_struct *work)
431 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
433 struct drm_device *dev = helper->dev;
434 struct drm_clip_rect *clip = &helper->damage_clip;
435 struct drm_clip_rect clip_copy;
439 spin_lock_irqsave(&helper->damage_lock, flags);
441 clip->x1 = clip->y1 = ~0;
442 clip->x2 = clip->y2 = 0;
443 spin_unlock_irqrestore(&helper->damage_lock, flags);
445 /* Call damage handlers only if necessary */
446 if (!(clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2))
449 if (helper->buffer) {
450 ret = drm_fb_helper_damage_blit(helper, &clip_copy);
451 if (drm_WARN_ONCE(dev, ret, "Damage blitter failed: ret=%d\n", ret))
455 if (helper->fb->funcs->dirty) {
456 ret = helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
457 if (drm_WARN_ONCE(dev, ret, "Dirty helper failed: ret=%d\n", ret))
465 * Restore damage clip rectangle on errors. The next run
466 * of the damage worker will perform the update.
468 spin_lock_irqsave(&helper->damage_lock, flags);
469 clip->x1 = min_t(u32, clip->x1, clip_copy.x1);
470 clip->y1 = min_t(u32, clip->y1, clip_copy.y1);
471 clip->x2 = max_t(u32, clip->x2, clip_copy.x2);
472 clip->y2 = max_t(u32, clip->y2, clip_copy.y2);
473 spin_unlock_irqrestore(&helper->damage_lock, flags);
477 * drm_fb_helper_prepare - setup a drm_fb_helper structure
479 * @helper: driver-allocated fbdev helper structure to set up
480 * @funcs: pointer to structure of functions associate with this helper
482 * Sets up the bare minimum to make the framebuffer helper usable. This is
483 * useful to implement race-free initialization of the polling helpers.
485 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
486 const struct drm_fb_helper_funcs *funcs)
488 INIT_LIST_HEAD(&helper->kernel_fb_list);
489 spin_lock_init(&helper->damage_lock);
490 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
491 INIT_WORK(&helper->damage_work, drm_fb_helper_damage_work);
492 helper->damage_clip.x1 = helper->damage_clip.y1 = ~0;
493 mutex_init(&helper->lock);
494 helper->funcs = funcs;
497 EXPORT_SYMBOL(drm_fb_helper_prepare);
500 * drm_fb_helper_init - initialize a &struct drm_fb_helper
502 * @fb_helper: driver-allocated fbdev helper structure to initialize
504 * This allocates the structures for the fbdev helper with the given limits.
505 * Note that this won't yet touch the hardware (through the driver interfaces)
506 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
507 * to allow driver writes more control over the exact init sequence.
509 * Drivers must call drm_fb_helper_prepare() before calling this function.
512 * Zero if everything went ok, nonzero otherwise.
514 int drm_fb_helper_init(struct drm_device *dev,
515 struct drm_fb_helper *fb_helper)
519 if (!drm_fbdev_emulation) {
520 dev->fb_helper = fb_helper;
525 * If this is not the generic fbdev client, initialize a drm_client
526 * without callbacks so we can use the modesets.
528 if (!fb_helper->client.funcs) {
529 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
534 dev->fb_helper = fb_helper;
538 EXPORT_SYMBOL(drm_fb_helper_init);
541 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
542 * @fb_helper: driver-allocated fbdev helper
544 * A helper to alloc fb_info and the members cmap and apertures. Called
545 * by the driver within the fb_probe fb_helper callback function. Drivers do not
546 * need to release the allocated fb_info structure themselves, this is
547 * automatically done when calling drm_fb_helper_fini().
550 * fb_info pointer if things went okay, pointer containing error code
553 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
555 struct device *dev = fb_helper->dev->dev;
556 struct fb_info *info;
559 info = framebuffer_alloc(0, dev);
561 return ERR_PTR(-ENOMEM);
563 ret = fb_alloc_cmap(&info->cmap, 256, 0);
568 * TODO: We really should be smarter here and alloc an aperture
569 * for each IORESOURCE_MEM resource helper->dev->dev has and also
570 * init the ranges of the appertures based on the resources.
571 * Note some drivers currently count on there being only 1 empty
572 * aperture and fill this themselves, these will need to be dealt
573 * with somehow when fixing this.
575 info->apertures = alloc_apertures(1);
576 if (!info->apertures) {
581 fb_helper->fbdev = info;
582 info->skip_vt_switch = true;
587 fb_dealloc_cmap(&info->cmap);
589 framebuffer_release(info);
592 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
595 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
596 * @fb_helper: driver-allocated fbdev helper, can be NULL
598 * A wrapper around unregister_framebuffer, to release the fb_info
599 * framebuffer device. This must be called before releasing all resources for
600 * @fb_helper by calling drm_fb_helper_fini().
602 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
604 if (fb_helper && fb_helper->fbdev)
605 unregister_framebuffer(fb_helper->fbdev);
607 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
610 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
611 * @fb_helper: driver-allocated fbdev helper, can be NULL
613 * This cleans up all remaining resources associated with @fb_helper.
615 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
617 struct fb_info *info;
622 fb_helper->dev->fb_helper = NULL;
624 if (!drm_fbdev_emulation)
627 cancel_work_sync(&fb_helper->resume_work);
628 cancel_work_sync(&fb_helper->damage_work);
630 info = fb_helper->fbdev;
633 fb_dealloc_cmap(&info->cmap);
634 framebuffer_release(info);
636 fb_helper->fbdev = NULL;
638 mutex_lock(&kernel_fb_helper_lock);
639 if (!list_empty(&fb_helper->kernel_fb_list)) {
640 list_del(&fb_helper->kernel_fb_list);
641 if (list_empty(&kernel_fb_helper_list))
642 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
644 mutex_unlock(&kernel_fb_helper_lock);
646 mutex_destroy(&fb_helper->lock);
648 if (!fb_helper->client.funcs)
649 drm_client_release(&fb_helper->client);
651 EXPORT_SYMBOL(drm_fb_helper_fini);
653 static bool drm_fbdev_use_shadow_fb(struct drm_fb_helper *fb_helper)
655 struct drm_device *dev = fb_helper->dev;
656 struct drm_framebuffer *fb = fb_helper->fb;
658 return dev->mode_config.prefer_shadow_fbdev ||
659 dev->mode_config.prefer_shadow ||
663 static void drm_fb_helper_damage(struct fb_info *info, u32 x, u32 y,
664 u32 width, u32 height)
666 struct drm_fb_helper *helper = info->par;
667 struct drm_clip_rect *clip = &helper->damage_clip;
670 if (!drm_fbdev_use_shadow_fb(helper))
673 spin_lock_irqsave(&helper->damage_lock, flags);
674 clip->x1 = min_t(u32, clip->x1, x);
675 clip->y1 = min_t(u32, clip->y1, y);
676 clip->x2 = max_t(u32, clip->x2, x + width);
677 clip->y2 = max_t(u32, clip->y2, y + height);
678 spin_unlock_irqrestore(&helper->damage_lock, flags);
680 schedule_work(&helper->damage_work);
684 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
685 * @info: fb_info struct pointer
686 * @pagelist: list of mmap framebuffer pages that have to be flushed
688 * This function is used as the &fb_deferred_io.deferred_io
689 * callback function for flushing the fbdev mmap writes.
691 void drm_fb_helper_deferred_io(struct fb_info *info,
692 struct list_head *pagelist)
694 unsigned long start, end, min, max;
700 list_for_each_entry(page, pagelist, lru) {
701 start = page->index << PAGE_SHIFT;
702 end = start + PAGE_SIZE - 1;
703 min = min(min, start);
708 y1 = min / info->fix.line_length;
709 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
711 drm_fb_helper_damage(info, 0, y1, info->var.xres, y2 - y1);
714 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
717 * drm_fb_helper_sys_read - wrapper around fb_sys_read
718 * @info: fb_info struct pointer
719 * @buf: userspace buffer to read from framebuffer memory
720 * @count: number of bytes to read from framebuffer memory
721 * @ppos: read offset within framebuffer memory
723 * A wrapper around fb_sys_read implemented by fbdev core
725 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
726 size_t count, loff_t *ppos)
728 return fb_sys_read(info, buf, count, ppos);
730 EXPORT_SYMBOL(drm_fb_helper_sys_read);
733 * drm_fb_helper_sys_write - wrapper around fb_sys_write
734 * @info: fb_info struct pointer
735 * @buf: userspace buffer to write to framebuffer memory
736 * @count: number of bytes to write to framebuffer memory
737 * @ppos: write offset within framebuffer memory
739 * A wrapper around fb_sys_write implemented by fbdev core
741 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
742 size_t count, loff_t *ppos)
746 ret = fb_sys_write(info, buf, count, ppos);
748 drm_fb_helper_damage(info, 0, 0, info->var.xres, info->var.yres);
752 EXPORT_SYMBOL(drm_fb_helper_sys_write);
755 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
756 * @info: fbdev registered by the helper
757 * @rect: info about rectangle to fill
759 * A wrapper around sys_fillrect implemented by fbdev core
761 void drm_fb_helper_sys_fillrect(struct fb_info *info,
762 const struct fb_fillrect *rect)
764 sys_fillrect(info, rect);
765 drm_fb_helper_damage(info, rect->dx, rect->dy, rect->width, rect->height);
767 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
770 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
771 * @info: fbdev registered by the helper
772 * @area: info about area to copy
774 * A wrapper around sys_copyarea implemented by fbdev core
776 void drm_fb_helper_sys_copyarea(struct fb_info *info,
777 const struct fb_copyarea *area)
779 sys_copyarea(info, area);
780 drm_fb_helper_damage(info, area->dx, area->dy, area->width, area->height);
782 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
785 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
786 * @info: fbdev registered by the helper
787 * @image: info about image to blit
789 * A wrapper around sys_imageblit implemented by fbdev core
791 void drm_fb_helper_sys_imageblit(struct fb_info *info,
792 const struct fb_image *image)
794 sys_imageblit(info, image);
795 drm_fb_helper_damage(info, image->dx, image->dy, image->width, image->height);
797 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
800 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
801 * @info: fbdev registered by the helper
802 * @rect: info about rectangle to fill
804 * A wrapper around cfb_fillrect implemented by fbdev core
806 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
807 const struct fb_fillrect *rect)
809 cfb_fillrect(info, rect);
810 drm_fb_helper_damage(info, rect->dx, rect->dy, rect->width, rect->height);
812 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
815 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
816 * @info: fbdev registered by the helper
817 * @area: info about area to copy
819 * A wrapper around cfb_copyarea implemented by fbdev core
821 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
822 const struct fb_copyarea *area)
824 cfb_copyarea(info, area);
825 drm_fb_helper_damage(info, area->dx, area->dy, area->width, area->height);
827 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
830 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
831 * @info: fbdev registered by the helper
832 * @image: info about image to blit
834 * A wrapper around cfb_imageblit implemented by fbdev core
836 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
837 const struct fb_image *image)
839 cfb_imageblit(info, image);
840 drm_fb_helper_damage(info, image->dx, image->dy, image->width, image->height);
842 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
845 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
846 * @fb_helper: driver-allocated fbdev helper, can be NULL
847 * @suspend: whether to suspend or resume
849 * A wrapper around fb_set_suspend implemented by fbdev core.
850 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
853 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
855 if (fb_helper && fb_helper->fbdev)
856 fb_set_suspend(fb_helper->fbdev, suspend);
858 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
861 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
862 * takes the console lock
863 * @fb_helper: driver-allocated fbdev helper, can be NULL
864 * @suspend: whether to suspend or resume
866 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
867 * isn't available on resume, a worker is tasked with waiting for the lock
868 * to become available. The console lock can be pretty contented on resume
869 * due to all the printk activity.
871 * This function can be called multiple times with the same state since
872 * &fb_info.state is checked to see if fbdev is running or not before locking.
874 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
876 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
879 if (!fb_helper || !fb_helper->fbdev)
882 /* make sure there's no pending/ongoing resume */
883 flush_work(&fb_helper->resume_work);
886 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
892 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
895 if (!console_trylock()) {
896 schedule_work(&fb_helper->resume_work);
901 fb_set_suspend(fb_helper->fbdev, suspend);
904 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
906 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
908 u32 *palette = (u32 *)info->pseudo_palette;
911 if (cmap->start + cmap->len > 16)
914 for (i = 0; i < cmap->len; ++i) {
915 u16 red = cmap->red[i];
916 u16 green = cmap->green[i];
917 u16 blue = cmap->blue[i];
920 red >>= 16 - info->var.red.length;
921 green >>= 16 - info->var.green.length;
922 blue >>= 16 - info->var.blue.length;
923 value = (red << info->var.red.offset) |
924 (green << info->var.green.offset) |
925 (blue << info->var.blue.offset);
926 if (info->var.transp.length > 0) {
927 u32 mask = (1 << info->var.transp.length) - 1;
929 mask <<= info->var.transp.offset;
932 palette[cmap->start + i] = value;
938 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
940 struct drm_fb_helper *fb_helper = info->par;
941 struct drm_mode_set *modeset;
942 struct drm_crtc *crtc;
946 drm_modeset_lock_all(fb_helper->dev);
947 drm_client_for_each_modeset(modeset, &fb_helper->client) {
948 crtc = modeset->crtc;
949 if (!crtc->funcs->gamma_set || !crtc->gamma_size) {
954 if (cmap->start + cmap->len > crtc->gamma_size) {
959 r = crtc->gamma_store;
960 g = r + crtc->gamma_size;
961 b = g + crtc->gamma_size;
963 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
964 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
965 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
967 ret = crtc->funcs->gamma_set(crtc, r, g, b,
968 crtc->gamma_size, NULL);
973 drm_modeset_unlock_all(fb_helper->dev);
978 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
979 struct fb_cmap *cmap)
981 struct drm_device *dev = crtc->dev;
982 struct drm_property_blob *gamma_lut;
983 struct drm_color_lut *lut;
984 int size = crtc->gamma_size;
987 if (!size || cmap->start + cmap->len > size)
988 return ERR_PTR(-EINVAL);
990 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
991 if (IS_ERR(gamma_lut))
994 lut = gamma_lut->data;
995 if (cmap->start || cmap->len != size) {
996 u16 *r = crtc->gamma_store;
997 u16 *g = r + crtc->gamma_size;
998 u16 *b = g + crtc->gamma_size;
1000 for (i = 0; i < cmap->start; i++) {
1002 lut[i].green = g[i];
1005 for (i = cmap->start + cmap->len; i < size; i++) {
1007 lut[i].green = g[i];
1012 for (i = 0; i < cmap->len; i++) {
1013 lut[cmap->start + i].red = cmap->red[i];
1014 lut[cmap->start + i].green = cmap->green[i];
1015 lut[cmap->start + i].blue = cmap->blue[i];
1021 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1023 struct drm_fb_helper *fb_helper = info->par;
1024 struct drm_device *dev = fb_helper->dev;
1025 struct drm_property_blob *gamma_lut = NULL;
1026 struct drm_modeset_acquire_ctx ctx;
1027 struct drm_crtc_state *crtc_state;
1028 struct drm_atomic_state *state;
1029 struct drm_mode_set *modeset;
1030 struct drm_crtc *crtc;
1035 drm_modeset_acquire_init(&ctx, 0);
1037 state = drm_atomic_state_alloc(dev);
1043 state->acquire_ctx = &ctx;
1045 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1046 crtc = modeset->crtc;
1049 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1050 if (IS_ERR(gamma_lut)) {
1051 ret = PTR_ERR(gamma_lut);
1056 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1057 if (IS_ERR(crtc_state)) {
1058 ret = PTR_ERR(crtc_state);
1063 * FIXME: This always uses gamma_lut. Some HW have only
1064 * degamma_lut, in which case we should reset gamma_lut and set
1065 * degamma_lut. See drm_crtc_legacy_gamma_set().
1067 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1069 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1070 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1072 crtc_state->color_mgmt_changed |= replaced;
1075 ret = drm_atomic_commit(state);
1079 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1080 crtc = modeset->crtc;
1082 r = crtc->gamma_store;
1083 g = r + crtc->gamma_size;
1084 b = g + crtc->gamma_size;
1086 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1087 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1088 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1092 if (ret == -EDEADLK)
1095 drm_property_blob_put(gamma_lut);
1096 drm_atomic_state_put(state);
1098 drm_modeset_drop_locks(&ctx);
1099 drm_modeset_acquire_fini(&ctx);
1104 drm_atomic_state_clear(state);
1105 drm_modeset_backoff(&ctx);
1110 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1111 * @cmap: cmap to set
1112 * @info: fbdev registered by the helper
1114 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1116 struct drm_fb_helper *fb_helper = info->par;
1117 struct drm_device *dev = fb_helper->dev;
1120 if (oops_in_progress)
1123 mutex_lock(&fb_helper->lock);
1125 if (!drm_master_internal_acquire(dev)) {
1130 mutex_lock(&fb_helper->client.modeset_mutex);
1131 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1132 ret = setcmap_pseudo_palette(cmap, info);
1133 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1134 ret = setcmap_atomic(cmap, info);
1136 ret = setcmap_legacy(cmap, info);
1137 mutex_unlock(&fb_helper->client.modeset_mutex);
1139 drm_master_internal_release(dev);
1141 mutex_unlock(&fb_helper->lock);
1145 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1148 * drm_fb_helper_ioctl - legacy ioctl implementation
1149 * @info: fbdev registered by the helper
1150 * @cmd: ioctl command
1151 * @arg: ioctl argument
1153 * A helper to implement the standard fbdev ioctl. Only
1154 * FBIO_WAITFORVSYNC is implemented for now.
1156 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1159 struct drm_fb_helper *fb_helper = info->par;
1160 struct drm_device *dev = fb_helper->dev;
1161 struct drm_crtc *crtc;
1164 mutex_lock(&fb_helper->lock);
1165 if (!drm_master_internal_acquire(dev)) {
1171 case FBIO_WAITFORVSYNC:
1173 * Only consider the first CRTC.
1175 * This ioctl is supposed to take the CRTC number as
1176 * an argument, but in fbdev times, what that number
1177 * was supposed to be was quite unclear, different
1178 * drivers were passing that argument differently
1179 * (some by reference, some by value), and most of the
1180 * userspace applications were just hardcoding 0 as an
1183 * The first CRTC should be the integrated panel on
1184 * most drivers, so this is the best choice we can
1185 * make. If we're not smart enough here, one should
1186 * just consider switch the userspace to KMS.
1188 crtc = fb_helper->client.modesets[0].crtc;
1191 * Only wait for a vblank event if the CRTC is
1192 * enabled, otherwise just don't do anythintg,
1193 * not even report an error.
1195 ret = drm_crtc_vblank_get(crtc);
1197 drm_crtc_wait_one_vblank(crtc);
1198 drm_crtc_vblank_put(crtc);
1207 drm_master_internal_release(dev);
1209 mutex_unlock(&fb_helper->lock);
1212 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1214 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1215 const struct fb_var_screeninfo *var_2)
1217 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1218 var_1->grayscale == var_2->grayscale &&
1219 var_1->red.offset == var_2->red.offset &&
1220 var_1->red.length == var_2->red.length &&
1221 var_1->red.msb_right == var_2->red.msb_right &&
1222 var_1->green.offset == var_2->green.offset &&
1223 var_1->green.length == var_2->green.length &&
1224 var_1->green.msb_right == var_2->green.msb_right &&
1225 var_1->blue.offset == var_2->blue.offset &&
1226 var_1->blue.length == var_2->blue.length &&
1227 var_1->blue.msb_right == var_2->blue.msb_right &&
1228 var_1->transp.offset == var_2->transp.offset &&
1229 var_1->transp.length == var_2->transp.length &&
1230 var_1->transp.msb_right == var_2->transp.msb_right;
1233 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1238 var->red.offset = 0;
1239 var->green.offset = 0;
1240 var->blue.offset = 0;
1241 var->red.length = 8; /* 8bit DAC */
1242 var->green.length = 8;
1243 var->blue.length = 8;
1244 var->transp.offset = 0;
1245 var->transp.length = 0;
1248 var->red.offset = 10;
1249 var->green.offset = 5;
1250 var->blue.offset = 0;
1251 var->red.length = 5;
1252 var->green.length = 5;
1253 var->blue.length = 5;
1254 var->transp.offset = 15;
1255 var->transp.length = 1;
1258 var->red.offset = 11;
1259 var->green.offset = 5;
1260 var->blue.offset = 0;
1261 var->red.length = 5;
1262 var->green.length = 6;
1263 var->blue.length = 5;
1264 var->transp.offset = 0;
1267 var->red.offset = 16;
1268 var->green.offset = 8;
1269 var->blue.offset = 0;
1270 var->red.length = 8;
1271 var->green.length = 8;
1272 var->blue.length = 8;
1273 var->transp.offset = 0;
1274 var->transp.length = 0;
1277 var->red.offset = 16;
1278 var->green.offset = 8;
1279 var->blue.offset = 0;
1280 var->red.length = 8;
1281 var->green.length = 8;
1282 var->blue.length = 8;
1283 var->transp.offset = 24;
1284 var->transp.length = 8;
1292 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1293 * @var: screeninfo to check
1294 * @info: fbdev registered by the helper
1296 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1297 struct fb_info *info)
1299 struct drm_fb_helper *fb_helper = info->par;
1300 struct drm_framebuffer *fb = fb_helper->fb;
1301 struct drm_device *dev = fb_helper->dev;
1303 if (in_dbg_master())
1306 if (var->pixclock != 0) {
1307 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1311 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1312 (drm_format_info_block_height(fb->format, 0) > 1))
1316 * Changes struct fb_var_screeninfo are currently not pushed back
1317 * to KMS, hence fail if different settings are requested.
1319 if (var->bits_per_pixel > fb->format->cpp[0] * 8 ||
1320 var->xres > fb->width || var->yres > fb->height ||
1321 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1322 drm_dbg_kms(dev, "fb requested width/height/bpp can't fit in current fb "
1323 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1324 var->xres, var->yres, var->bits_per_pixel,
1325 var->xres_virtual, var->yres_virtual,
1326 fb->width, fb->height, fb->format->cpp[0] * 8);
1331 * Workaround for SDL 1.2, which is known to be setting all pixel format
1332 * fields values to zero in some cases. We treat this situation as a
1333 * kind of "use some reasonable autodetected values".
1335 if (!var->red.offset && !var->green.offset &&
1336 !var->blue.offset && !var->transp.offset &&
1337 !var->red.length && !var->green.length &&
1338 !var->blue.length && !var->transp.length &&
1339 !var->red.msb_right && !var->green.msb_right &&
1340 !var->blue.msb_right && !var->transp.msb_right) {
1341 drm_fb_helper_fill_pixel_fmt(var, fb->format->depth);
1345 * Likewise, bits_per_pixel should be rounded up to a supported value.
1347 var->bits_per_pixel = fb->format->cpp[0] * 8;
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_dbg_kms(dev, "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;
1376 if (oops_in_progress)
1379 if (var->pixclock != 0) {
1380 drm_err(fb_helper->dev, "PIXEL CLOCK SET\n");
1385 * Normally we want to make sure that a kms master takes precedence over
1386 * fbdev, to avoid fbdev flickering and occasionally stealing the
1387 * display status. But Xorg first sets the vt back to text mode using
1388 * the KDSET IOCTL with KD_TEXT, and only after that drops the master
1389 * status when exiting.
1391 * In the past this was caught by drm_fb_helper_lastclose(), but on
1392 * modern systems where logind always keeps a drm fd open to orchestrate
1393 * the vt switching, this doesn't work.
1395 * To not break the userspace ABI we have this special case here, which
1396 * is only used for the above case. Everything else uses the normal
1397 * commit function, which ensures that we never steal the display from
1398 * an active drm master.
1400 force = var->activate & FB_ACTIVATE_KD_TEXT;
1402 __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, force);
1406 EXPORT_SYMBOL(drm_fb_helper_set_par);
1408 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1410 struct drm_mode_set *mode_set;
1412 mutex_lock(&fb_helper->client.modeset_mutex);
1413 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1417 mutex_unlock(&fb_helper->client.modeset_mutex);
1420 static int pan_display_atomic(struct fb_var_screeninfo *var,
1421 struct fb_info *info)
1423 struct drm_fb_helper *fb_helper = info->par;
1426 pan_set(fb_helper, var->xoffset, var->yoffset);
1428 ret = drm_client_modeset_commit_locked(&fb_helper->client);
1430 info->var.xoffset = var->xoffset;
1431 info->var.yoffset = var->yoffset;
1433 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1438 static int pan_display_legacy(struct fb_var_screeninfo *var,
1439 struct fb_info *info)
1441 struct drm_fb_helper *fb_helper = info->par;
1442 struct drm_client_dev *client = &fb_helper->client;
1443 struct drm_mode_set *modeset;
1446 mutex_lock(&client->modeset_mutex);
1447 drm_modeset_lock_all(fb_helper->dev);
1448 drm_client_for_each_modeset(modeset, client) {
1449 modeset->x = var->xoffset;
1450 modeset->y = var->yoffset;
1452 if (modeset->num_connectors) {
1453 ret = drm_mode_set_config_internal(modeset);
1455 info->var.xoffset = var->xoffset;
1456 info->var.yoffset = var->yoffset;
1460 drm_modeset_unlock_all(fb_helper->dev);
1461 mutex_unlock(&client->modeset_mutex);
1467 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1468 * @var: updated screen information
1469 * @info: fbdev registered by the helper
1471 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1472 struct fb_info *info)
1474 struct drm_fb_helper *fb_helper = info->par;
1475 struct drm_device *dev = fb_helper->dev;
1478 if (oops_in_progress)
1481 mutex_lock(&fb_helper->lock);
1482 if (!drm_master_internal_acquire(dev)) {
1487 if (drm_drv_uses_atomic_modeset(dev))
1488 ret = pan_display_atomic(var, info);
1490 ret = pan_display_legacy(var, info);
1492 drm_master_internal_release(dev);
1494 mutex_unlock(&fb_helper->lock);
1498 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1501 * Allocates the backing storage and sets up the fbdev info structure through
1502 * the ->fb_probe callback.
1504 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1507 struct drm_client_dev *client = &fb_helper->client;
1508 struct drm_device *dev = fb_helper->dev;
1509 struct drm_mode_config *config = &dev->mode_config;
1512 struct drm_connector_list_iter conn_iter;
1513 struct drm_fb_helper_surface_size sizes;
1514 struct drm_connector *connector;
1515 struct drm_mode_set *mode_set;
1518 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1519 sizes.surface_depth = 24;
1520 sizes.surface_bpp = 32;
1521 sizes.fb_width = (u32)-1;
1522 sizes.fb_height = (u32)-1;
1525 * If driver picks 8 or 16 by default use that for both depth/bpp
1528 if (preferred_bpp != sizes.surface_bpp)
1529 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1531 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1532 drm_client_for_each_connector_iter(connector, &conn_iter) {
1533 struct drm_cmdline_mode *cmdline_mode;
1535 cmdline_mode = &connector->cmdline_mode;
1537 if (cmdline_mode->bpp_specified) {
1538 switch (cmdline_mode->bpp) {
1540 sizes.surface_depth = sizes.surface_bpp = 8;
1543 sizes.surface_depth = 15;
1544 sizes.surface_bpp = 16;
1547 sizes.surface_depth = sizes.surface_bpp = 16;
1550 sizes.surface_depth = sizes.surface_bpp = 24;
1553 sizes.surface_depth = 24;
1554 sizes.surface_bpp = 32;
1560 drm_connector_list_iter_end(&conn_iter);
1563 * If we run into a situation where, for example, the primary plane
1564 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1565 * 16) we need to scale down the depth of the sizes we request.
1567 mutex_lock(&client->modeset_mutex);
1568 drm_client_for_each_modeset(mode_set, client) {
1569 struct drm_crtc *crtc = mode_set->crtc;
1570 struct drm_plane *plane = crtc->primary;
1573 drm_dbg_kms(dev, "test CRTC %u primary plane\n", drm_crtc_index(crtc));
1575 for (j = 0; j < plane->format_count; j++) {
1576 const struct drm_format_info *fmt;
1578 fmt = drm_format_info(plane->format_types[j]);
1581 * Do not consider YUV or other complicated formats
1582 * for framebuffers. This means only legacy formats
1583 * are supported (fmt->depth is a legacy field) but
1584 * the framebuffer emulation can only deal with such
1585 * formats, specifically RGB/BGA formats.
1587 if (fmt->depth == 0)
1590 /* We found a perfect fit, great */
1591 if (fmt->depth == sizes.surface_depth) {
1592 best_depth = fmt->depth;
1596 /* Skip depths above what we're looking for */
1597 if (fmt->depth > sizes.surface_depth)
1600 /* Best depth found so far */
1601 if (fmt->depth > best_depth)
1602 best_depth = fmt->depth;
1605 if (sizes.surface_depth != best_depth && best_depth) {
1606 drm_info(dev, "requested bpp %d, scaled depth down to %d",
1607 sizes.surface_bpp, best_depth);
1608 sizes.surface_depth = best_depth;
1611 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1613 drm_client_for_each_modeset(mode_set, client) {
1614 struct drm_display_mode *desired_mode;
1616 /* in case of tile group, are we the last tile vert or horiz?
1617 * If no tile group you are always the last one both vertically
1620 bool lastv = true, lasth = true;
1622 desired_mode = mode_set->mode;
1632 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1633 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1635 for (j = 0; j < mode_set->num_connectors; j++) {
1636 struct drm_connector *connector = mode_set->connectors[j];
1638 if (connector->has_tile &&
1639 desired_mode->hdisplay == connector->tile_h_size &&
1640 desired_mode->vdisplay == connector->tile_v_size) {
1641 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1642 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1643 /* cloning to multiple tiles is just crazy-talk, so: */
1649 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1651 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1653 mutex_unlock(&client->modeset_mutex);
1655 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1656 drm_info(dev, "Cannot find any crtc or sizes\n");
1658 /* First time: disable all crtc's.. */
1659 if (!fb_helper->deferred_setup)
1660 drm_client_modeset_commit(client);
1664 /* Handle our overallocation */
1665 sizes.surface_height *= drm_fbdev_overalloc;
1666 sizes.surface_height /= 100;
1667 if (sizes.surface_height > config->max_height) {
1668 drm_dbg_kms(dev, "Fbdev over-allocation too large; clamping height to %d\n",
1669 config->max_height);
1670 sizes.surface_height = config->max_height;
1673 /* push down into drivers */
1674 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1678 strcpy(fb_helper->fb->comm, "[fbcon]");
1682 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1685 info->fix.type = FB_TYPE_PACKED_PIXELS;
1686 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1687 FB_VISUAL_TRUECOLOR;
1688 info->fix.mmio_start = 0;
1689 info->fix.mmio_len = 0;
1690 info->fix.type_aux = 0;
1691 info->fix.xpanstep = 1; /* doing it in hw */
1692 info->fix.ypanstep = 1; /* doing it in hw */
1693 info->fix.ywrapstep = 0;
1694 info->fix.accel = FB_ACCEL_NONE;
1696 info->fix.line_length = pitch;
1699 static void drm_fb_helper_fill_var(struct fb_info *info,
1700 struct drm_fb_helper *fb_helper,
1701 uint32_t fb_width, uint32_t fb_height)
1703 struct drm_framebuffer *fb = fb_helper->fb;
1705 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
1706 (drm_format_info_block_height(fb->format, 0) > 1));
1707 info->pseudo_palette = fb_helper->pseudo_palette;
1708 info->var.xres_virtual = fb->width;
1709 info->var.yres_virtual = fb->height;
1710 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1711 info->var.accel_flags = FB_ACCELF_TEXT;
1712 info->var.xoffset = 0;
1713 info->var.yoffset = 0;
1714 info->var.activate = FB_ACTIVATE_NOW;
1716 drm_fb_helper_fill_pixel_fmt(&info->var, fb->format->depth);
1718 info->var.xres = fb_width;
1719 info->var.yres = fb_height;
1723 * drm_fb_helper_fill_info - initializes fbdev information
1724 * @info: fbdev instance to set up
1725 * @fb_helper: fb helper instance to use as template
1726 * @sizes: describes fbdev size and scanout surface size
1728 * Sets up the variable and fixed fbdev metainformation from the given fb helper
1729 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
1731 * Drivers should call this (or their equivalent setup code) from their
1732 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1733 * backing storage framebuffer.
1735 void drm_fb_helper_fill_info(struct fb_info *info,
1736 struct drm_fb_helper *fb_helper,
1737 struct drm_fb_helper_surface_size *sizes)
1739 struct drm_framebuffer *fb = fb_helper->fb;
1741 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
1742 drm_fb_helper_fill_var(info, fb_helper,
1743 sizes->fb_width, sizes->fb_height);
1745 info->par = fb_helper;
1746 snprintf(info->fix.id, sizeof(info->fix.id), "%s",
1747 fb_helper->dev->driver->name);
1750 EXPORT_SYMBOL(drm_fb_helper_fill_info);
1753 * This is a continuation of drm_setup_crtcs() that sets up anything related
1754 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
1755 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
1756 * So, any setup that touches those fields needs to be done here instead of in
1757 * drm_setup_crtcs().
1759 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
1761 struct drm_client_dev *client = &fb_helper->client;
1762 struct drm_connector_list_iter conn_iter;
1763 struct fb_info *info = fb_helper->fbdev;
1764 unsigned int rotation, sw_rotations = 0;
1765 struct drm_connector *connector;
1766 struct drm_mode_set *modeset;
1768 mutex_lock(&client->modeset_mutex);
1769 drm_client_for_each_modeset(modeset, client) {
1770 if (!modeset->num_connectors)
1773 modeset->fb = fb_helper->fb;
1775 if (drm_client_rotation(modeset, &rotation))
1776 /* Rotating in hardware, fbcon should not rotate */
1777 sw_rotations |= DRM_MODE_ROTATE_0;
1779 sw_rotations |= rotation;
1781 mutex_unlock(&client->modeset_mutex);
1783 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1784 drm_client_for_each_connector_iter(connector, &conn_iter) {
1786 /* use first connected connector for the physical dimensions */
1787 if (connector->status == connector_status_connected) {
1788 info->var.width = connector->display_info.width_mm;
1789 info->var.height = connector->display_info.height_mm;
1793 drm_connector_list_iter_end(&conn_iter);
1795 switch (sw_rotations) {
1796 case DRM_MODE_ROTATE_0:
1797 info->fbcon_rotate_hint = FB_ROTATE_UR;
1799 case DRM_MODE_ROTATE_90:
1800 info->fbcon_rotate_hint = FB_ROTATE_CCW;
1802 case DRM_MODE_ROTATE_180:
1803 info->fbcon_rotate_hint = FB_ROTATE_UD;
1805 case DRM_MODE_ROTATE_270:
1806 info->fbcon_rotate_hint = FB_ROTATE_CW;
1810 * Multiple bits are set / multiple rotations requested
1811 * fbcon cannot handle separate rotation settings per
1812 * output, so fallback to unrotated.
1814 info->fbcon_rotate_hint = FB_ROTATE_UR;
1818 /* Note: Drops fb_helper->lock before returning. */
1820 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
1823 struct drm_device *dev = fb_helper->dev;
1824 struct fb_info *info;
1825 unsigned int width, height;
1828 width = dev->mode_config.max_width;
1829 height = dev->mode_config.max_height;
1831 drm_client_modeset_probe(&fb_helper->client, width, height);
1832 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1834 if (ret == -EAGAIN) {
1835 fb_helper->preferred_bpp = bpp_sel;
1836 fb_helper->deferred_setup = true;
1839 mutex_unlock(&fb_helper->lock);
1843 drm_setup_crtcs_fb(fb_helper);
1845 fb_helper->deferred_setup = false;
1847 info = fb_helper->fbdev;
1848 info->var.pixclock = 0;
1849 /* Shamelessly allow physical address leaking to userspace */
1850 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1851 if (!drm_leak_fbdev_smem)
1853 /* don't leak any physical addresses to userspace */
1854 info->flags |= FBINFO_HIDE_SMEM_START;
1856 /* Need to drop locks to avoid recursive deadlock in
1857 * register_framebuffer. This is ok because the only thing left to do is
1858 * register the fbdev emulation instance in kernel_fb_helper_list. */
1859 mutex_unlock(&fb_helper->lock);
1861 ret = register_framebuffer(info);
1865 drm_info(dev, "fb%d: %s frame buffer device\n",
1866 info->node, info->fix.id);
1868 mutex_lock(&kernel_fb_helper_lock);
1869 if (list_empty(&kernel_fb_helper_list))
1870 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1872 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1873 mutex_unlock(&kernel_fb_helper_lock);
1879 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1880 * @fb_helper: fb_helper device struct
1881 * @bpp_sel: bpp value to use for the framebuffer configuration
1883 * Scans the CRTCs and connectors and tries to put together an initial setup.
1884 * At the moment, this is a cloned configuration across all heads with
1885 * a new framebuffer object as the backing store.
1887 * Note that this also registers the fbdev and so allows userspace to call into
1888 * the driver through the fbdev interfaces.
1890 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
1891 * to let the driver allocate and initialize the fbdev info structure and the
1892 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
1893 * as a helper to setup simple default values for the fbdev info structure.
1897 * When you have fbcon support built-in or already loaded, this function will do
1898 * a full modeset to setup the fbdev console. Due to locking misdesign in the
1899 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
1900 * console_lock. Until console_unlock is called no dmesg lines will be sent out
1901 * to consoles, not even serial console. This means when your driver crashes,
1902 * you will see absolutely nothing else but a system stuck in this function,
1903 * with no further output. Any kind of printk() you place within your own driver
1904 * or in the drm core modeset code will also never show up.
1906 * Standard debug practice is to run the fbcon setup without taking the
1907 * console_lock as a hack, to be able to see backtraces and crashes on the
1908 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
1911 * The other option is to just disable fbdev emulation since very likely the
1912 * first modeset from userspace will crash in the same way, and is even easier
1913 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
1914 * kernel cmdline option.
1917 * Zero if everything went ok, nonzero otherwise.
1919 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1923 if (!drm_fbdev_emulation)
1926 mutex_lock(&fb_helper->lock);
1927 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
1931 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1934 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1935 * probing all the outputs attached to the fb
1936 * @fb_helper: driver-allocated fbdev helper, can be NULL
1938 * Scan the connectors attached to the fb_helper and try to put together a
1939 * setup after notification of a change in output configuration.
1941 * Called at runtime, takes the mode config locks to be able to check/change the
1942 * modeset configuration. Must be run from process context (which usually means
1943 * either the output polling work or a work item launched from the driver's
1944 * hotplug interrupt).
1946 * Note that drivers may call this even before calling
1947 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
1948 * for a race-free fbcon setup and will make sure that the fbdev emulation will
1949 * not miss any hotplug events.
1952 * 0 on success and a non-zero error code otherwise.
1954 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1958 if (!drm_fbdev_emulation || !fb_helper)
1961 mutex_lock(&fb_helper->lock);
1962 if (fb_helper->deferred_setup) {
1963 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
1964 fb_helper->preferred_bpp);
1968 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
1969 fb_helper->delayed_hotplug = true;
1970 mutex_unlock(&fb_helper->lock);
1974 drm_master_internal_release(fb_helper->dev);
1976 drm_dbg_kms(fb_helper->dev, "\n");
1978 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
1979 drm_setup_crtcs_fb(fb_helper);
1980 mutex_unlock(&fb_helper->lock);
1982 drm_fb_helper_set_par(fb_helper->fbdev);
1986 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1989 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
1992 * This function can be used as the &drm_driver->lastclose callback for drivers
1993 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
1995 void drm_fb_helper_lastclose(struct drm_device *dev)
1997 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
1999 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2002 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2003 * helper for fbdev emulation
2006 * This function can be used as the
2007 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2008 * need to call drm_fb_helper_hotplug_event().
2010 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2012 drm_fb_helper_hotplug_event(dev->fb_helper);
2014 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2016 /* @user: 1=userspace, 0=fbcon */
2017 static int drm_fbdev_fb_open(struct fb_info *info, int user)
2019 struct drm_fb_helper *fb_helper = info->par;
2021 /* No need to take a ref for fbcon because it unbinds on unregister */
2022 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
2028 static int drm_fbdev_fb_release(struct fb_info *info, int user)
2030 struct drm_fb_helper *fb_helper = info->par;
2033 module_put(fb_helper->dev->driver->fops->owner);
2038 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
2040 struct fb_info *fbi = fb_helper->fbdev;
2041 void *shadow = NULL;
2043 if (!fb_helper->dev)
2048 fb_deferred_io_cleanup(fbi);
2049 if (drm_fbdev_use_shadow_fb(fb_helper))
2050 shadow = fbi->screen_buffer;
2053 drm_fb_helper_fini(fb_helper);
2057 else if (fb_helper->buffer)
2058 drm_client_buffer_vunmap(fb_helper->buffer);
2060 drm_client_framebuffer_delete(fb_helper->buffer);
2063 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
2065 drm_fbdev_cleanup(fb_helper);
2066 drm_client_release(&fb_helper->client);
2071 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2072 * unregister_framebuffer() or fb_release().
2074 static void drm_fbdev_fb_destroy(struct fb_info *info)
2076 drm_fbdev_release(info->par);
2079 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
2081 struct drm_fb_helper *fb_helper = info->par;
2083 if (fb_helper->dev->driver->gem_prime_mmap)
2084 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2089 static bool drm_fbdev_use_iomem(struct fb_info *info)
2091 struct drm_fb_helper *fb_helper = info->par;
2092 struct drm_client_buffer *buffer = fb_helper->buffer;
2094 return !drm_fbdev_use_shadow_fb(fb_helper) && buffer->map.is_iomem;
2097 static ssize_t fb_read_screen_base(struct fb_info *info, char __user *buf, size_t count,
2100 const char __iomem *src = info->screen_base + pos;
2101 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
2106 tmp = kmalloc(alloc_size, GFP_KERNEL);
2111 size_t c = min_t(size_t, count, alloc_size);
2113 memcpy_fromio(tmp, src, c);
2114 if (copy_to_user(buf, tmp, c)) {
2127 return ret ? ret : err;
2130 static ssize_t fb_read_screen_buffer(struct fb_info *info, char __user *buf, size_t count,
2133 const char *src = info->screen_buffer + pos;
2135 if (copy_to_user(buf, src, count))
2141 static ssize_t drm_fbdev_fb_read(struct fb_info *info, char __user *buf,
2142 size_t count, loff_t *ppos)
2148 if (info->screen_size)
2149 total_size = info->screen_size;
2151 total_size = info->fix.smem_len;
2153 if (pos >= total_size)
2155 if (count >= total_size)
2157 if (total_size - count < pos)
2158 count = total_size - pos;
2160 if (drm_fbdev_use_iomem(info))
2161 ret = fb_read_screen_base(info, buf, count, pos);
2163 ret = fb_read_screen_buffer(info, buf, count, pos);
2171 static ssize_t fb_write_screen_base(struct fb_info *info, const char __user *buf, size_t count,
2174 char __iomem *dst = info->screen_base + pos;
2175 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
2180 tmp = kmalloc(alloc_size, GFP_KERNEL);
2185 size_t c = min_t(size_t, count, alloc_size);
2187 if (copy_from_user(tmp, buf, c)) {
2191 memcpy_toio(dst, tmp, c);
2201 return ret ? ret : err;
2204 static ssize_t fb_write_screen_buffer(struct fb_info *info, const char __user *buf, size_t count,
2207 char *dst = info->screen_buffer + pos;
2209 if (copy_from_user(dst, buf, count))
2215 static ssize_t drm_fbdev_fb_write(struct fb_info *info, const char __user *buf,
2216 size_t count, loff_t *ppos)
2223 if (info->screen_size)
2224 total_size = info->screen_size;
2226 total_size = info->fix.smem_len;
2228 if (pos > total_size)
2230 if (count > total_size) {
2234 if (total_size - count < pos) {
2237 count = total_size - pos;
2241 * Copy to framebuffer even if we already logged an error. Emulates
2242 * the behavior of the original fbdev implementation.
2244 if (drm_fbdev_use_iomem(info))
2245 ret = fb_write_screen_base(info, buf, count, pos);
2247 ret = fb_write_screen_buffer(info, buf, count, pos);
2253 drm_fb_helper_damage(info, 0, 0, info->var.xres_virtual, info->var.yres_virtual);
2255 return ret ? ret : err;
2258 static void drm_fbdev_fb_fillrect(struct fb_info *info,
2259 const struct fb_fillrect *rect)
2261 if (drm_fbdev_use_iomem(info))
2262 drm_fb_helper_cfb_fillrect(info, rect);
2264 drm_fb_helper_sys_fillrect(info, rect);
2267 static void drm_fbdev_fb_copyarea(struct fb_info *info,
2268 const struct fb_copyarea *area)
2270 if (drm_fbdev_use_iomem(info))
2271 drm_fb_helper_cfb_copyarea(info, area);
2273 drm_fb_helper_sys_copyarea(info, area);
2276 static void drm_fbdev_fb_imageblit(struct fb_info *info,
2277 const struct fb_image *image)
2279 if (drm_fbdev_use_iomem(info))
2280 drm_fb_helper_cfb_imageblit(info, image);
2282 drm_fb_helper_sys_imageblit(info, image);
2285 static const struct fb_ops drm_fbdev_fb_ops = {
2286 .owner = THIS_MODULE,
2287 DRM_FB_HELPER_DEFAULT_OPS,
2288 .fb_open = drm_fbdev_fb_open,
2289 .fb_release = drm_fbdev_fb_release,
2290 .fb_destroy = drm_fbdev_fb_destroy,
2291 .fb_mmap = drm_fbdev_fb_mmap,
2292 .fb_read = drm_fbdev_fb_read,
2293 .fb_write = drm_fbdev_fb_write,
2294 .fb_fillrect = drm_fbdev_fb_fillrect,
2295 .fb_copyarea = drm_fbdev_fb_copyarea,
2296 .fb_imageblit = drm_fbdev_fb_imageblit,
2299 static struct fb_deferred_io drm_fbdev_defio = {
2301 .deferred_io = drm_fb_helper_deferred_io,
2305 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2307 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2308 * fb_copyarea, fb_imageblit.
2310 static int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2311 struct drm_fb_helper_surface_size *sizes)
2313 struct drm_client_dev *client = &fb_helper->client;
2314 struct drm_device *dev = fb_helper->dev;
2315 struct drm_client_buffer *buffer;
2316 struct drm_framebuffer *fb;
2317 struct fb_info *fbi;
2319 struct dma_buf_map map;
2322 drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n",
2323 sizes->surface_width, sizes->surface_height,
2324 sizes->surface_bpp);
2326 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2327 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2328 sizes->surface_height, format);
2330 return PTR_ERR(buffer);
2332 fb_helper->buffer = buffer;
2333 fb_helper->fb = buffer->fb;
2336 fbi = drm_fb_helper_alloc_fbi(fb_helper);
2338 return PTR_ERR(fbi);
2340 fbi->fbops = &drm_fbdev_fb_ops;
2341 fbi->screen_size = fb->height * fb->pitches[0];
2342 fbi->fix.smem_len = fbi->screen_size;
2344 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2346 if (drm_fbdev_use_shadow_fb(fb_helper)) {
2347 fbi->screen_buffer = vzalloc(fbi->screen_size);
2348 if (!fbi->screen_buffer)
2351 fbi->fbdefio = &drm_fbdev_defio;
2353 fb_deferred_io_init(fbi);
2355 /* buffer is mapped for HW framebuffer */
2356 ret = drm_client_buffer_vmap(fb_helper->buffer, &map);
2360 fbi->screen_base = map.vaddr_iomem;
2362 fbi->screen_buffer = map.vaddr;
2365 * Shamelessly leak the physical address to user-space. As
2366 * page_to_phys() is undefined for I/O memory, warn in this
2369 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2370 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0 &&
2371 !drm_WARN_ON_ONCE(dev, map.is_iomem))
2372 fbi->fix.smem_start =
2373 page_to_phys(virt_to_page(fbi->screen_buffer));
2380 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2381 .fb_probe = drm_fb_helper_generic_probe,
2384 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2386 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2388 if (fb_helper->fbdev)
2389 /* drm_fbdev_fb_destroy() takes care of cleanup */
2390 drm_fb_helper_unregister_fbi(fb_helper);
2392 drm_fbdev_release(fb_helper);
2395 static int drm_fbdev_client_restore(struct drm_client_dev *client)
2397 drm_fb_helper_lastclose(client->dev);
2402 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2404 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2405 struct drm_device *dev = client->dev;
2408 /* Setup is not retried if it has failed */
2409 if (!fb_helper->dev && fb_helper->funcs)
2413 return drm_fb_helper_hotplug_event(dev->fb_helper);
2415 if (!dev->mode_config.num_connector) {
2416 drm_dbg_kms(dev, "No connectors found, will not create framebuffer!\n");
2420 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2422 ret = drm_fb_helper_init(dev, fb_helper);
2426 if (!drm_drv_uses_atomic_modeset(dev))
2427 drm_helper_disable_unused_functions(dev);
2429 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2436 drm_fbdev_cleanup(fb_helper);
2438 fb_helper->dev = NULL;
2439 fb_helper->fbdev = NULL;
2441 drm_err(dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2446 static const struct drm_client_funcs drm_fbdev_client_funcs = {
2447 .owner = THIS_MODULE,
2448 .unregister = drm_fbdev_client_unregister,
2449 .restore = drm_fbdev_client_restore,
2450 .hotplug = drm_fbdev_client_hotplug,
2454 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2456 * @preferred_bpp: Preferred bits per pixel for the device.
2457 * @dev->mode_config.preferred_depth is used if this is zero.
2459 * This function sets up generic fbdev emulation for drivers that supports
2460 * dumb buffers with a virtual address and that can be mmap'ed.
2461 * drm_fbdev_generic_setup() shall be called after the DRM driver registered
2462 * the new DRM device with drm_dev_register().
2464 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2465 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2466 * Simple drivers might use drm_mode_config_helper_suspend().
2468 * Drivers that set the dirty callback on their framebuffer will get a shadow
2469 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2470 * make deferred I/O work with all kinds of buffers. A shadow buffer can be
2471 * requested explicitly by setting struct drm_mode_config.prefer_shadow or
2472 * struct drm_mode_config.prefer_shadow_fbdev to true beforehand. This is
2473 * required to use generic fbdev emulation with SHMEM helpers.
2475 * This function is safe to call even when there are no connectors present.
2476 * Setup will be retried on the next hotplug event.
2478 * The fbdev is destroyed by drm_dev_unregister().
2480 void drm_fbdev_generic_setup(struct drm_device *dev,
2481 unsigned int preferred_bpp)
2483 struct drm_fb_helper *fb_helper;
2486 drm_WARN(dev, !dev->registered, "Device has not been registered.\n");
2487 drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n");
2489 if (!drm_fbdev_emulation)
2492 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2494 drm_err(dev, "Failed to allocate fb_helper\n");
2498 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2501 drm_err(dev, "Failed to register client: %d\n", ret);
2506 * FIXME: This mixes up depth with bpp, which results in a glorious
2507 * mess, resulting in some drivers picking wrong fbdev defaults and
2508 * others wrong preferred_depth defaults.
2511 preferred_bpp = dev->mode_config.preferred_depth;
2514 fb_helper->preferred_bpp = preferred_bpp;
2516 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2518 drm_dbg_kms(dev, "client hotplug ret=%d\n", ret);
2520 drm_client_register(&fb_helper->client);
2522 EXPORT_SYMBOL(drm_fbdev_generic_setup);