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 - restore fbdev configuration
232 * @fb_helper: driver-allocated fbdev helper, can be NULL
234 * This should be called from driver's drm &drm_driver.lastclose callback
235 * when implementing an fbcon on top of kms using this helper. This ensures that
236 * the user isn't greeted with a black screen when e.g. X dies.
239 * Zero if everything went ok, negative error code otherwise.
241 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
246 if (!drm_fbdev_emulation || !fb_helper)
249 if (READ_ONCE(fb_helper->deferred_setup))
252 mutex_lock(&fb_helper->lock);
255 * We should bail out here if there is a master by dropping _force.
256 * Currently these igt tests fail if we do that:
257 * - kms_fbcon_fbt@psr
258 * - kms_fbcon_fbt@psr-suspend
260 * So first these tests need to be fixed so they drop master or don't
263 ret = drm_client_modeset_commit_force(&fb_helper->client);
265 do_delayed = fb_helper->delayed_hotplug;
267 fb_helper->delayed_hotplug = false;
268 mutex_unlock(&fb_helper->lock);
271 drm_fb_helper_hotplug_event(fb_helper);
275 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
277 #ifdef CONFIG_MAGIC_SYSRQ
279 * restore fbcon display for all kms driver's using this helper, used for sysrq
280 * and panic handling.
282 static bool drm_fb_helper_force_kernel_mode(void)
284 bool ret, error = false;
285 struct drm_fb_helper *helper;
287 if (list_empty(&kernel_fb_helper_list))
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 ret = drm_client_modeset_commit_force(&helper->client);
300 mutex_unlock(&helper->lock);
305 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
309 ret = drm_fb_helper_force_kernel_mode();
311 DRM_ERROR("Failed to restore crtc configuration\n");
313 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
315 static void drm_fb_helper_sysrq(int dummy1)
317 schedule_work(&drm_fb_helper_restore_work);
320 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
321 .handler = drm_fb_helper_sysrq,
322 .help_msg = "force-fb(V)",
323 .action_msg = "Restore framebuffer console",
326 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
329 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
331 struct drm_fb_helper *fb_helper = info->par;
333 mutex_lock(&fb_helper->lock);
334 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
335 mutex_unlock(&fb_helper->lock);
339 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
340 * @blank: desired blanking state
341 * @info: fbdev registered by the helper
343 int drm_fb_helper_blank(int blank, struct fb_info *info)
345 if (oops_in_progress)
349 /* Display: On; HSync: On, VSync: On */
350 case FB_BLANK_UNBLANK:
351 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
353 /* Display: Off; HSync: On, VSync: On */
354 case FB_BLANK_NORMAL:
355 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
357 /* Display: Off; HSync: Off, VSync: On */
358 case FB_BLANK_HSYNC_SUSPEND:
359 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
361 /* Display: Off; HSync: On, VSync: Off */
362 case FB_BLANK_VSYNC_SUSPEND:
363 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
365 /* Display: Off; HSync: Off, VSync: Off */
366 case FB_BLANK_POWERDOWN:
367 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
372 EXPORT_SYMBOL(drm_fb_helper_blank);
374 static void drm_fb_helper_resume_worker(struct work_struct *work)
376 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
380 fb_set_suspend(helper->fbdev, 0);
384 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper *fb_helper,
385 struct drm_clip_rect *clip)
387 struct drm_framebuffer *fb = fb_helper->fb;
388 unsigned int cpp = fb->format->cpp[0];
389 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
390 void *src = fb_helper->fbdev->screen_buffer + offset;
391 void *dst = fb_helper->buffer->vaddr + offset;
392 size_t len = (clip->x2 - clip->x1) * cpp;
395 for (y = clip->y1; y < clip->y2; y++) {
396 memcpy(dst, src, len);
397 src += fb->pitches[0];
398 dst += fb->pitches[0];
402 static void drm_fb_helper_dirty_work(struct work_struct *work)
404 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
406 struct drm_clip_rect *clip = &helper->dirty_clip;
407 struct drm_clip_rect clip_copy;
411 spin_lock_irqsave(&helper->dirty_lock, flags);
413 clip->x1 = clip->y1 = ~0;
414 clip->x2 = clip->y2 = 0;
415 spin_unlock_irqrestore(&helper->dirty_lock, flags);
417 /* call dirty callback only when it has been really touched */
418 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2) {
420 /* Generic fbdev uses a shadow buffer */
421 if (helper->buffer) {
422 vaddr = drm_client_buffer_vmap(helper->buffer);
425 drm_fb_helper_dirty_blit_real(helper, &clip_copy);
427 if (helper->fb->funcs->dirty)
428 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0,
432 drm_client_buffer_vunmap(helper->buffer);
437 * drm_fb_helper_prepare - setup a drm_fb_helper structure
439 * @helper: driver-allocated fbdev helper structure to set up
440 * @funcs: pointer to structure of functions associate with this helper
442 * Sets up the bare minimum to make the framebuffer helper usable. This is
443 * useful to implement race-free initialization of the polling helpers.
445 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
446 const struct drm_fb_helper_funcs *funcs)
448 INIT_LIST_HEAD(&helper->kernel_fb_list);
449 spin_lock_init(&helper->dirty_lock);
450 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
451 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
452 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
453 mutex_init(&helper->lock);
454 helper->funcs = funcs;
457 EXPORT_SYMBOL(drm_fb_helper_prepare);
460 * drm_fb_helper_init - initialize a &struct drm_fb_helper
462 * @fb_helper: driver-allocated fbdev helper structure to initialize
463 * @max_conn_count: max connector count (not used)
465 * This allocates the structures for the fbdev helper with the given limits.
466 * Note that this won't yet touch the hardware (through the driver interfaces)
467 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
468 * to allow driver writes more control over the exact init sequence.
470 * Drivers must call drm_fb_helper_prepare() before calling this function.
473 * Zero if everything went ok, nonzero otherwise.
475 int drm_fb_helper_init(struct drm_device *dev,
476 struct drm_fb_helper *fb_helper,
481 if (!drm_fbdev_emulation) {
482 dev->fb_helper = fb_helper;
487 * If this is not the generic fbdev client, initialize a drm_client
488 * without callbacks so we can use the modesets.
490 if (!fb_helper->client.funcs) {
491 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
496 dev->fb_helper = fb_helper;
500 EXPORT_SYMBOL(drm_fb_helper_init);
503 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
504 * @fb_helper: driver-allocated fbdev helper
506 * A helper to alloc fb_info and the members cmap and apertures. Called
507 * by the driver within the fb_probe fb_helper callback function. Drivers do not
508 * need to release the allocated fb_info structure themselves, this is
509 * automatically done when calling drm_fb_helper_fini().
512 * fb_info pointer if things went okay, pointer containing error code
515 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
517 struct device *dev = fb_helper->dev->dev;
518 struct fb_info *info;
521 info = framebuffer_alloc(0, dev);
523 return ERR_PTR(-ENOMEM);
525 ret = fb_alloc_cmap(&info->cmap, 256, 0);
529 info->apertures = alloc_apertures(1);
530 if (!info->apertures) {
535 fb_helper->fbdev = info;
536 info->skip_vt_switch = true;
541 fb_dealloc_cmap(&info->cmap);
543 framebuffer_release(info);
546 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
549 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
550 * @fb_helper: driver-allocated fbdev helper, can be NULL
552 * A wrapper around unregister_framebuffer, to release the fb_info
553 * framebuffer device. This must be called before releasing all resources for
554 * @fb_helper by calling drm_fb_helper_fini().
556 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
558 if (fb_helper && fb_helper->fbdev)
559 unregister_framebuffer(fb_helper->fbdev);
561 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
564 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
565 * @fb_helper: driver-allocated fbdev helper, can be NULL
567 * This cleans up all remaining resources associated with @fb_helper.
569 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
571 struct fb_info *info;
576 fb_helper->dev->fb_helper = NULL;
578 if (!drm_fbdev_emulation)
581 cancel_work_sync(&fb_helper->resume_work);
582 cancel_work_sync(&fb_helper->dirty_work);
584 info = fb_helper->fbdev;
587 fb_dealloc_cmap(&info->cmap);
588 framebuffer_release(info);
590 fb_helper->fbdev = NULL;
592 mutex_lock(&kernel_fb_helper_lock);
593 if (!list_empty(&fb_helper->kernel_fb_list)) {
594 list_del(&fb_helper->kernel_fb_list);
595 if (list_empty(&kernel_fb_helper_list))
596 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
598 mutex_unlock(&kernel_fb_helper_lock);
600 mutex_destroy(&fb_helper->lock);
602 if (!fb_helper->client.funcs)
603 drm_client_release(&fb_helper->client);
605 EXPORT_SYMBOL(drm_fb_helper_fini);
607 static bool drm_fbdev_use_shadow_fb(struct drm_fb_helper *fb_helper)
609 struct drm_device *dev = fb_helper->dev;
610 struct drm_framebuffer *fb = fb_helper->fb;
612 return dev->mode_config.prefer_shadow_fbdev ||
613 dev->mode_config.prefer_shadow ||
617 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
618 u32 width, u32 height)
620 struct drm_fb_helper *helper = info->par;
621 struct drm_clip_rect *clip = &helper->dirty_clip;
624 if (!drm_fbdev_use_shadow_fb(helper))
627 spin_lock_irqsave(&helper->dirty_lock, flags);
628 clip->x1 = min_t(u32, clip->x1, x);
629 clip->y1 = min_t(u32, clip->y1, y);
630 clip->x2 = max_t(u32, clip->x2, x + width);
631 clip->y2 = max_t(u32, clip->y2, y + height);
632 spin_unlock_irqrestore(&helper->dirty_lock, flags);
634 schedule_work(&helper->dirty_work);
638 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
639 * @info: fb_info struct pointer
640 * @pagelist: list of dirty mmap framebuffer pages
642 * This function is used as the &fb_deferred_io.deferred_io
643 * callback function for flushing the fbdev mmap writes.
645 void drm_fb_helper_deferred_io(struct fb_info *info,
646 struct list_head *pagelist)
648 unsigned long start, end, min, max;
654 list_for_each_entry(page, pagelist, lru) {
655 start = page->index << PAGE_SHIFT;
656 end = start + PAGE_SIZE - 1;
657 min = min(min, start);
662 y1 = min / info->fix.line_length;
663 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
665 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
668 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
671 * drm_fb_helper_sys_read - wrapper around fb_sys_read
672 * @info: fb_info struct pointer
673 * @buf: userspace buffer to read from framebuffer memory
674 * @count: number of bytes to read from framebuffer memory
675 * @ppos: read offset within framebuffer memory
677 * A wrapper around fb_sys_read implemented by fbdev core
679 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
680 size_t count, loff_t *ppos)
682 return fb_sys_read(info, buf, count, ppos);
684 EXPORT_SYMBOL(drm_fb_helper_sys_read);
687 * drm_fb_helper_sys_write - wrapper around fb_sys_write
688 * @info: fb_info struct pointer
689 * @buf: userspace buffer to write to framebuffer memory
690 * @count: number of bytes to write to framebuffer memory
691 * @ppos: write offset within framebuffer memory
693 * A wrapper around fb_sys_write implemented by fbdev core
695 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
696 size_t count, loff_t *ppos)
700 ret = fb_sys_write(info, buf, count, ppos);
702 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
707 EXPORT_SYMBOL(drm_fb_helper_sys_write);
710 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
711 * @info: fbdev registered by the helper
712 * @rect: info about rectangle to fill
714 * A wrapper around sys_fillrect implemented by fbdev core
716 void drm_fb_helper_sys_fillrect(struct fb_info *info,
717 const struct fb_fillrect *rect)
719 sys_fillrect(info, rect);
720 drm_fb_helper_dirty(info, rect->dx, rect->dy,
721 rect->width, rect->height);
723 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
726 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
727 * @info: fbdev registered by the helper
728 * @area: info about area to copy
730 * A wrapper around sys_copyarea implemented by fbdev core
732 void drm_fb_helper_sys_copyarea(struct fb_info *info,
733 const struct fb_copyarea *area)
735 sys_copyarea(info, area);
736 drm_fb_helper_dirty(info, area->dx, area->dy,
737 area->width, area->height);
739 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
742 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
743 * @info: fbdev registered by the helper
744 * @image: info about image to blit
746 * A wrapper around sys_imageblit implemented by fbdev core
748 void drm_fb_helper_sys_imageblit(struct fb_info *info,
749 const struct fb_image *image)
751 sys_imageblit(info, image);
752 drm_fb_helper_dirty(info, image->dx, image->dy,
753 image->width, image->height);
755 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
758 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
759 * @info: fbdev registered by the helper
760 * @rect: info about rectangle to fill
762 * A wrapper around cfb_fillrect implemented by fbdev core
764 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
765 const struct fb_fillrect *rect)
767 cfb_fillrect(info, rect);
768 drm_fb_helper_dirty(info, rect->dx, rect->dy,
769 rect->width, rect->height);
771 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
774 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
775 * @info: fbdev registered by the helper
776 * @area: info about area to copy
778 * A wrapper around cfb_copyarea implemented by fbdev core
780 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
781 const struct fb_copyarea *area)
783 cfb_copyarea(info, area);
784 drm_fb_helper_dirty(info, area->dx, area->dy,
785 area->width, area->height);
787 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
790 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
791 * @info: fbdev registered by the helper
792 * @image: info about image to blit
794 * A wrapper around cfb_imageblit implemented by fbdev core
796 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
797 const struct fb_image *image)
799 cfb_imageblit(info, image);
800 drm_fb_helper_dirty(info, image->dx, image->dy,
801 image->width, image->height);
803 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
806 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
807 * @fb_helper: driver-allocated fbdev helper, can be NULL
808 * @suspend: whether to suspend or resume
810 * A wrapper around fb_set_suspend implemented by fbdev core.
811 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
814 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
816 if (fb_helper && fb_helper->fbdev)
817 fb_set_suspend(fb_helper->fbdev, suspend);
819 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
822 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
823 * takes the console lock
824 * @fb_helper: driver-allocated fbdev helper, can be NULL
825 * @suspend: whether to suspend or resume
827 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
828 * isn't available on resume, a worker is tasked with waiting for the lock
829 * to become available. The console lock can be pretty contented on resume
830 * due to all the printk activity.
832 * This function can be called multiple times with the same state since
833 * &fb_info.state is checked to see if fbdev is running or not before locking.
835 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
837 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
840 if (!fb_helper || !fb_helper->fbdev)
843 /* make sure there's no pending/ongoing resume */
844 flush_work(&fb_helper->resume_work);
847 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
853 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
856 if (!console_trylock()) {
857 schedule_work(&fb_helper->resume_work);
862 fb_set_suspend(fb_helper->fbdev, suspend);
865 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
867 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
869 u32 *palette = (u32 *)info->pseudo_palette;
872 if (cmap->start + cmap->len > 16)
875 for (i = 0; i < cmap->len; ++i) {
876 u16 red = cmap->red[i];
877 u16 green = cmap->green[i];
878 u16 blue = cmap->blue[i];
881 red >>= 16 - info->var.red.length;
882 green >>= 16 - info->var.green.length;
883 blue >>= 16 - info->var.blue.length;
884 value = (red << info->var.red.offset) |
885 (green << info->var.green.offset) |
886 (blue << info->var.blue.offset);
887 if (info->var.transp.length > 0) {
888 u32 mask = (1 << info->var.transp.length) - 1;
890 mask <<= info->var.transp.offset;
893 palette[cmap->start + i] = value;
899 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
901 struct drm_fb_helper *fb_helper = info->par;
902 struct drm_mode_set *modeset;
903 struct drm_crtc *crtc;
907 drm_modeset_lock_all(fb_helper->dev);
908 drm_client_for_each_modeset(modeset, &fb_helper->client) {
909 crtc = modeset->crtc;
910 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
913 if (cmap->start + cmap->len > crtc->gamma_size)
916 r = crtc->gamma_store;
917 g = r + crtc->gamma_size;
918 b = g + crtc->gamma_size;
920 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
921 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
922 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
924 ret = crtc->funcs->gamma_set(crtc, r, g, b,
925 crtc->gamma_size, NULL);
929 drm_modeset_unlock_all(fb_helper->dev);
934 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
935 struct fb_cmap *cmap)
937 struct drm_device *dev = crtc->dev;
938 struct drm_property_blob *gamma_lut;
939 struct drm_color_lut *lut;
940 int size = crtc->gamma_size;
943 if (!size || cmap->start + cmap->len > size)
944 return ERR_PTR(-EINVAL);
946 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
947 if (IS_ERR(gamma_lut))
950 lut = gamma_lut->data;
951 if (cmap->start || cmap->len != size) {
952 u16 *r = crtc->gamma_store;
953 u16 *g = r + crtc->gamma_size;
954 u16 *b = g + crtc->gamma_size;
956 for (i = 0; i < cmap->start; i++) {
961 for (i = cmap->start + cmap->len; i < size; i++) {
968 for (i = 0; i < cmap->len; i++) {
969 lut[cmap->start + i].red = cmap->red[i];
970 lut[cmap->start + i].green = cmap->green[i];
971 lut[cmap->start + i].blue = cmap->blue[i];
977 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
979 struct drm_fb_helper *fb_helper = info->par;
980 struct drm_device *dev = fb_helper->dev;
981 struct drm_property_blob *gamma_lut = NULL;
982 struct drm_modeset_acquire_ctx ctx;
983 struct drm_crtc_state *crtc_state;
984 struct drm_atomic_state *state;
985 struct drm_mode_set *modeset;
986 struct drm_crtc *crtc;
991 drm_modeset_acquire_init(&ctx, 0);
993 state = drm_atomic_state_alloc(dev);
999 state->acquire_ctx = &ctx;
1001 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1002 crtc = modeset->crtc;
1005 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1006 if (IS_ERR(gamma_lut)) {
1007 ret = PTR_ERR(gamma_lut);
1012 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1013 if (IS_ERR(crtc_state)) {
1014 ret = PTR_ERR(crtc_state);
1018 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1020 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1021 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1023 crtc_state->color_mgmt_changed |= replaced;
1026 ret = drm_atomic_commit(state);
1030 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1031 crtc = modeset->crtc;
1033 r = crtc->gamma_store;
1034 g = r + crtc->gamma_size;
1035 b = g + crtc->gamma_size;
1037 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1038 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1039 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1043 if (ret == -EDEADLK)
1046 drm_property_blob_put(gamma_lut);
1047 drm_atomic_state_put(state);
1049 drm_modeset_drop_locks(&ctx);
1050 drm_modeset_acquire_fini(&ctx);
1055 drm_atomic_state_clear(state);
1056 drm_modeset_backoff(&ctx);
1061 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1062 * @cmap: cmap to set
1063 * @info: fbdev registered by the helper
1065 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1067 struct drm_fb_helper *fb_helper = info->par;
1068 struct drm_device *dev = fb_helper->dev;
1071 if (oops_in_progress)
1074 mutex_lock(&fb_helper->lock);
1076 if (!drm_master_internal_acquire(dev)) {
1081 mutex_lock(&fb_helper->client.modeset_mutex);
1082 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1083 ret = setcmap_pseudo_palette(cmap, info);
1084 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1085 ret = setcmap_atomic(cmap, info);
1087 ret = setcmap_legacy(cmap, info);
1088 mutex_unlock(&fb_helper->client.modeset_mutex);
1090 drm_master_internal_release(dev);
1092 mutex_unlock(&fb_helper->lock);
1096 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1099 * drm_fb_helper_ioctl - legacy ioctl implementation
1100 * @info: fbdev registered by the helper
1101 * @cmd: ioctl command
1102 * @arg: ioctl argument
1104 * A helper to implement the standard fbdev ioctl. Only
1105 * FBIO_WAITFORVSYNC is implemented for now.
1107 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1110 struct drm_fb_helper *fb_helper = info->par;
1111 struct drm_device *dev = fb_helper->dev;
1112 struct drm_crtc *crtc;
1115 mutex_lock(&fb_helper->lock);
1116 if (!drm_master_internal_acquire(dev)) {
1122 case FBIO_WAITFORVSYNC:
1124 * Only consider the first CRTC.
1126 * This ioctl is supposed to take the CRTC number as
1127 * an argument, but in fbdev times, what that number
1128 * was supposed to be was quite unclear, different
1129 * drivers were passing that argument differently
1130 * (some by reference, some by value), and most of the
1131 * userspace applications were just hardcoding 0 as an
1134 * The first CRTC should be the integrated panel on
1135 * most drivers, so this is the best choice we can
1136 * make. If we're not smart enough here, one should
1137 * just consider switch the userspace to KMS.
1139 crtc = fb_helper->client.modesets[0].crtc;
1142 * Only wait for a vblank event if the CRTC is
1143 * enabled, otherwise just don't do anythintg,
1144 * not even report an error.
1146 ret = drm_crtc_vblank_get(crtc);
1148 drm_crtc_wait_one_vblank(crtc);
1149 drm_crtc_vblank_put(crtc);
1158 drm_master_internal_release(dev);
1160 mutex_unlock(&fb_helper->lock);
1163 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1165 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1166 const struct fb_var_screeninfo *var_2)
1168 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1169 var_1->grayscale == var_2->grayscale &&
1170 var_1->red.offset == var_2->red.offset &&
1171 var_1->red.length == var_2->red.length &&
1172 var_1->red.msb_right == var_2->red.msb_right &&
1173 var_1->green.offset == var_2->green.offset &&
1174 var_1->green.length == var_2->green.length &&
1175 var_1->green.msb_right == var_2->green.msb_right &&
1176 var_1->blue.offset == var_2->blue.offset &&
1177 var_1->blue.length == var_2->blue.length &&
1178 var_1->blue.msb_right == var_2->blue.msb_right &&
1179 var_1->transp.offset == var_2->transp.offset &&
1180 var_1->transp.length == var_2->transp.length &&
1181 var_1->transp.msb_right == var_2->transp.msb_right;
1184 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1189 var->red.offset = 0;
1190 var->green.offset = 0;
1191 var->blue.offset = 0;
1192 var->red.length = 8; /* 8bit DAC */
1193 var->green.length = 8;
1194 var->blue.length = 8;
1195 var->transp.offset = 0;
1196 var->transp.length = 0;
1199 var->red.offset = 10;
1200 var->green.offset = 5;
1201 var->blue.offset = 0;
1202 var->red.length = 5;
1203 var->green.length = 5;
1204 var->blue.length = 5;
1205 var->transp.offset = 15;
1206 var->transp.length = 1;
1209 var->red.offset = 11;
1210 var->green.offset = 5;
1211 var->blue.offset = 0;
1212 var->red.length = 5;
1213 var->green.length = 6;
1214 var->blue.length = 5;
1215 var->transp.offset = 0;
1218 var->red.offset = 16;
1219 var->green.offset = 8;
1220 var->blue.offset = 0;
1221 var->red.length = 8;
1222 var->green.length = 8;
1223 var->blue.length = 8;
1224 var->transp.offset = 0;
1225 var->transp.length = 0;
1228 var->red.offset = 16;
1229 var->green.offset = 8;
1230 var->blue.offset = 0;
1231 var->red.length = 8;
1232 var->green.length = 8;
1233 var->blue.length = 8;
1234 var->transp.offset = 24;
1235 var->transp.length = 8;
1243 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1244 * @var: screeninfo to check
1245 * @info: fbdev registered by the helper
1247 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1248 struct fb_info *info)
1250 struct drm_fb_helper *fb_helper = info->par;
1251 struct drm_framebuffer *fb = fb_helper->fb;
1252 struct drm_device *dev = fb_helper->dev;
1254 if (in_dbg_master())
1257 if (var->pixclock != 0) {
1258 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1262 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1263 (drm_format_info_block_height(fb->format, 0) > 1))
1267 * Changes struct fb_var_screeninfo are currently not pushed back
1268 * to KMS, hence fail if different settings are requested.
1270 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1271 var->xres > fb->width || var->yres > fb->height ||
1272 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1273 drm_dbg_kms(dev, "fb requested width/height/bpp can't fit in current fb "
1274 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1275 var->xres, var->yres, var->bits_per_pixel,
1276 var->xres_virtual, var->yres_virtual,
1277 fb->width, fb->height, fb->format->cpp[0] * 8);
1282 * Workaround for SDL 1.2, which is known to be setting all pixel format
1283 * fields values to zero in some cases. We treat this situation as a
1284 * kind of "use some reasonable autodetected values".
1286 if (!var->red.offset && !var->green.offset &&
1287 !var->blue.offset && !var->transp.offset &&
1288 !var->red.length && !var->green.length &&
1289 !var->blue.length && !var->transp.length &&
1290 !var->red.msb_right && !var->green.msb_right &&
1291 !var->blue.msb_right && !var->transp.msb_right) {
1292 drm_fb_helper_fill_pixel_fmt(var, fb->format->depth);
1296 * drm fbdev emulation doesn't support changing the pixel format at all,
1297 * so reject all pixel format changing requests.
1299 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1300 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel format\n");
1306 EXPORT_SYMBOL(drm_fb_helper_check_var);
1309 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1310 * @info: fbdev registered by the helper
1312 * This will let fbcon do the mode init and is called at initialization time by
1313 * the fbdev core when registering the driver, and later on through the hotplug
1316 int drm_fb_helper_set_par(struct fb_info *info)
1318 struct drm_fb_helper *fb_helper = info->par;
1319 struct fb_var_screeninfo *var = &info->var;
1321 if (oops_in_progress)
1324 if (var->pixclock != 0) {
1325 drm_err(fb_helper->dev, "PIXEL CLOCK SET\n");
1329 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1333 EXPORT_SYMBOL(drm_fb_helper_set_par);
1335 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1337 struct drm_mode_set *mode_set;
1339 mutex_lock(&fb_helper->client.modeset_mutex);
1340 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1344 mutex_unlock(&fb_helper->client.modeset_mutex);
1347 static int pan_display_atomic(struct fb_var_screeninfo *var,
1348 struct fb_info *info)
1350 struct drm_fb_helper *fb_helper = info->par;
1353 pan_set(fb_helper, var->xoffset, var->yoffset);
1355 ret = drm_client_modeset_commit_force(&fb_helper->client);
1357 info->var.xoffset = var->xoffset;
1358 info->var.yoffset = var->yoffset;
1360 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1365 static int pan_display_legacy(struct fb_var_screeninfo *var,
1366 struct fb_info *info)
1368 struct drm_fb_helper *fb_helper = info->par;
1369 struct drm_client_dev *client = &fb_helper->client;
1370 struct drm_mode_set *modeset;
1373 mutex_lock(&client->modeset_mutex);
1374 drm_modeset_lock_all(fb_helper->dev);
1375 drm_client_for_each_modeset(modeset, client) {
1376 modeset->x = var->xoffset;
1377 modeset->y = var->yoffset;
1379 if (modeset->num_connectors) {
1380 ret = drm_mode_set_config_internal(modeset);
1382 info->var.xoffset = var->xoffset;
1383 info->var.yoffset = var->yoffset;
1387 drm_modeset_unlock_all(fb_helper->dev);
1388 mutex_unlock(&client->modeset_mutex);
1394 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1395 * @var: updated screen information
1396 * @info: fbdev registered by the helper
1398 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1399 struct fb_info *info)
1401 struct drm_fb_helper *fb_helper = info->par;
1402 struct drm_device *dev = fb_helper->dev;
1405 if (oops_in_progress)
1408 mutex_lock(&fb_helper->lock);
1409 if (!drm_master_internal_acquire(dev)) {
1414 if (drm_drv_uses_atomic_modeset(dev))
1415 ret = pan_display_atomic(var, info);
1417 ret = pan_display_legacy(var, info);
1419 drm_master_internal_release(dev);
1421 mutex_unlock(&fb_helper->lock);
1425 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1428 * Allocates the backing storage and sets up the fbdev info structure through
1429 * the ->fb_probe callback.
1431 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1434 struct drm_client_dev *client = &fb_helper->client;
1435 struct drm_device *dev = fb_helper->dev;
1438 struct drm_connector_list_iter conn_iter;
1439 struct drm_fb_helper_surface_size sizes;
1440 struct drm_connector *connector;
1441 struct drm_mode_set *mode_set;
1444 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1445 sizes.surface_depth = 24;
1446 sizes.surface_bpp = 32;
1447 sizes.fb_width = (u32)-1;
1448 sizes.fb_height = (u32)-1;
1451 * If driver picks 8 or 16 by default use that for both depth/bpp
1454 if (preferred_bpp != sizes.surface_bpp)
1455 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1457 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1458 drm_client_for_each_connector_iter(connector, &conn_iter) {
1459 struct drm_cmdline_mode *cmdline_mode;
1461 cmdline_mode = &connector->cmdline_mode;
1463 if (cmdline_mode->bpp_specified) {
1464 switch (cmdline_mode->bpp) {
1466 sizes.surface_depth = sizes.surface_bpp = 8;
1469 sizes.surface_depth = 15;
1470 sizes.surface_bpp = 16;
1473 sizes.surface_depth = sizes.surface_bpp = 16;
1476 sizes.surface_depth = sizes.surface_bpp = 24;
1479 sizes.surface_depth = 24;
1480 sizes.surface_bpp = 32;
1486 drm_connector_list_iter_end(&conn_iter);
1489 * If we run into a situation where, for example, the primary plane
1490 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1491 * 16) we need to scale down the depth of the sizes we request.
1493 mutex_lock(&client->modeset_mutex);
1494 drm_client_for_each_modeset(mode_set, client) {
1495 struct drm_crtc *crtc = mode_set->crtc;
1496 struct drm_plane *plane = crtc->primary;
1499 drm_dbg_kms(dev, "test CRTC %u primary plane\n", drm_crtc_index(crtc));
1501 for (j = 0; j < plane->format_count; j++) {
1502 const struct drm_format_info *fmt;
1504 fmt = drm_format_info(plane->format_types[j]);
1507 * Do not consider YUV or other complicated formats
1508 * for framebuffers. This means only legacy formats
1509 * are supported (fmt->depth is a legacy field) but
1510 * the framebuffer emulation can only deal with such
1511 * formats, specifically RGB/BGA formats.
1513 if (fmt->depth == 0)
1516 /* We found a perfect fit, great */
1517 if (fmt->depth == sizes.surface_depth) {
1518 best_depth = fmt->depth;
1522 /* Skip depths above what we're looking for */
1523 if (fmt->depth > sizes.surface_depth)
1526 /* Best depth found so far */
1527 if (fmt->depth > best_depth)
1528 best_depth = fmt->depth;
1531 if (sizes.surface_depth != best_depth && best_depth) {
1532 drm_info(dev, "requested bpp %d, scaled depth down to %d",
1533 sizes.surface_bpp, best_depth);
1534 sizes.surface_depth = best_depth;
1537 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1539 drm_client_for_each_modeset(mode_set, client) {
1540 struct drm_display_mode *desired_mode;
1542 /* in case of tile group, are we the last tile vert or horiz?
1543 * If no tile group you are always the last one both vertically
1546 bool lastv = true, lasth = true;
1548 desired_mode = mode_set->mode;
1558 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1559 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1561 for (j = 0; j < mode_set->num_connectors; j++) {
1562 struct drm_connector *connector = mode_set->connectors[j];
1564 if (connector->has_tile) {
1565 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1566 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1567 /* cloning to multiple tiles is just crazy-talk, so: */
1573 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1575 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1577 mutex_unlock(&client->modeset_mutex);
1579 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1580 drm_info(dev, "Cannot find any crtc or sizes\n");
1582 /* First time: disable all crtc's.. */
1583 if (!fb_helper->deferred_setup)
1584 drm_client_modeset_commit(client);
1588 /* Handle our overallocation */
1589 sizes.surface_height *= drm_fbdev_overalloc;
1590 sizes.surface_height /= 100;
1592 /* push down into drivers */
1593 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1597 strcpy(fb_helper->fb->comm, "[fbcon]");
1601 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1604 info->fix.type = FB_TYPE_PACKED_PIXELS;
1605 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1606 FB_VISUAL_TRUECOLOR;
1607 info->fix.mmio_start = 0;
1608 info->fix.mmio_len = 0;
1609 info->fix.type_aux = 0;
1610 info->fix.xpanstep = 1; /* doing it in hw */
1611 info->fix.ypanstep = 1; /* doing it in hw */
1612 info->fix.ywrapstep = 0;
1613 info->fix.accel = FB_ACCEL_NONE;
1615 info->fix.line_length = pitch;
1618 static void drm_fb_helper_fill_var(struct fb_info *info,
1619 struct drm_fb_helper *fb_helper,
1620 uint32_t fb_width, uint32_t fb_height)
1622 struct drm_framebuffer *fb = fb_helper->fb;
1624 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
1625 (drm_format_info_block_height(fb->format, 0) > 1));
1626 info->pseudo_palette = fb_helper->pseudo_palette;
1627 info->var.xres_virtual = fb->width;
1628 info->var.yres_virtual = fb->height;
1629 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1630 info->var.accel_flags = FB_ACCELF_TEXT;
1631 info->var.xoffset = 0;
1632 info->var.yoffset = 0;
1633 info->var.activate = FB_ACTIVATE_NOW;
1635 drm_fb_helper_fill_pixel_fmt(&info->var, fb->format->depth);
1637 info->var.xres = fb_width;
1638 info->var.yres = fb_height;
1642 * drm_fb_helper_fill_info - initializes fbdev information
1643 * @info: fbdev instance to set up
1644 * @fb_helper: fb helper instance to use as template
1645 * @sizes: describes fbdev size and scanout surface size
1647 * Sets up the variable and fixed fbdev metainformation from the given fb helper
1648 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
1650 * Drivers should call this (or their equivalent setup code) from their
1651 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1652 * backing storage framebuffer.
1654 void drm_fb_helper_fill_info(struct fb_info *info,
1655 struct drm_fb_helper *fb_helper,
1656 struct drm_fb_helper_surface_size *sizes)
1658 struct drm_framebuffer *fb = fb_helper->fb;
1660 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
1661 drm_fb_helper_fill_var(info, fb_helper,
1662 sizes->fb_width, sizes->fb_height);
1664 info->par = fb_helper;
1665 snprintf(info->fix.id, sizeof(info->fix.id), "%sdrmfb",
1666 fb_helper->dev->driver->name);
1669 EXPORT_SYMBOL(drm_fb_helper_fill_info);
1672 * This is a continuation of drm_setup_crtcs() that sets up anything related
1673 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
1674 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
1675 * So, any setup that touches those fields needs to be done here instead of in
1676 * drm_setup_crtcs().
1678 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
1680 struct drm_client_dev *client = &fb_helper->client;
1681 struct drm_connector_list_iter conn_iter;
1682 struct fb_info *info = fb_helper->fbdev;
1683 unsigned int rotation, sw_rotations = 0;
1684 struct drm_connector *connector;
1685 struct drm_mode_set *modeset;
1687 mutex_lock(&client->modeset_mutex);
1688 drm_client_for_each_modeset(modeset, client) {
1689 if (!modeset->num_connectors)
1692 modeset->fb = fb_helper->fb;
1694 if (drm_client_rotation(modeset, &rotation))
1695 /* Rotating in hardware, fbcon should not rotate */
1696 sw_rotations |= DRM_MODE_ROTATE_0;
1698 sw_rotations |= rotation;
1700 mutex_unlock(&client->modeset_mutex);
1702 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1703 drm_client_for_each_connector_iter(connector, &conn_iter) {
1705 /* use first connected connector for the physical dimensions */
1706 if (connector->status == connector_status_connected) {
1707 info->var.width = connector->display_info.width_mm;
1708 info->var.height = connector->display_info.height_mm;
1712 drm_connector_list_iter_end(&conn_iter);
1714 switch (sw_rotations) {
1715 case DRM_MODE_ROTATE_0:
1716 info->fbcon_rotate_hint = FB_ROTATE_UR;
1718 case DRM_MODE_ROTATE_90:
1719 info->fbcon_rotate_hint = FB_ROTATE_CCW;
1721 case DRM_MODE_ROTATE_180:
1722 info->fbcon_rotate_hint = FB_ROTATE_UD;
1724 case DRM_MODE_ROTATE_270:
1725 info->fbcon_rotate_hint = FB_ROTATE_CW;
1729 * Multiple bits are set / multiple rotations requested
1730 * fbcon cannot handle separate rotation settings per
1731 * output, so fallback to unrotated.
1733 info->fbcon_rotate_hint = FB_ROTATE_UR;
1737 /* Note: Drops fb_helper->lock before returning. */
1739 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
1742 struct drm_device *dev = fb_helper->dev;
1743 struct fb_info *info;
1744 unsigned int width, height;
1747 width = dev->mode_config.max_width;
1748 height = dev->mode_config.max_height;
1750 drm_client_modeset_probe(&fb_helper->client, width, height);
1751 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1753 if (ret == -EAGAIN) {
1754 fb_helper->preferred_bpp = bpp_sel;
1755 fb_helper->deferred_setup = true;
1758 mutex_unlock(&fb_helper->lock);
1762 drm_setup_crtcs_fb(fb_helper);
1764 fb_helper->deferred_setup = false;
1766 info = fb_helper->fbdev;
1767 info->var.pixclock = 0;
1768 /* Shamelessly allow physical address leaking to userspace */
1769 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1770 if (!drm_leak_fbdev_smem)
1772 /* don't leak any physical addresses to userspace */
1773 info->flags |= FBINFO_HIDE_SMEM_START;
1775 /* Need to drop locks to avoid recursive deadlock in
1776 * register_framebuffer. This is ok because the only thing left to do is
1777 * register the fbdev emulation instance in kernel_fb_helper_list. */
1778 mutex_unlock(&fb_helper->lock);
1780 ret = register_framebuffer(info);
1784 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
1785 info->node, info->fix.id);
1787 mutex_lock(&kernel_fb_helper_lock);
1788 if (list_empty(&kernel_fb_helper_list))
1789 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1791 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1792 mutex_unlock(&kernel_fb_helper_lock);
1798 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1799 * @fb_helper: fb_helper device struct
1800 * @bpp_sel: bpp value to use for the framebuffer configuration
1802 * Scans the CRTCs and connectors and tries to put together an initial setup.
1803 * At the moment, this is a cloned configuration across all heads with
1804 * a new framebuffer object as the backing store.
1806 * Note that this also registers the fbdev and so allows userspace to call into
1807 * the driver through the fbdev interfaces.
1809 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
1810 * to let the driver allocate and initialize the fbdev info structure and the
1811 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
1812 * as a helper to setup simple default values for the fbdev info structure.
1816 * When you have fbcon support built-in or already loaded, this function will do
1817 * a full modeset to setup the fbdev console. Due to locking misdesign in the
1818 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
1819 * console_lock. Until console_unlock is called no dmesg lines will be sent out
1820 * to consoles, not even serial console. This means when your driver crashes,
1821 * you will see absolutely nothing else but a system stuck in this function,
1822 * with no further output. Any kind of printk() you place within your own driver
1823 * or in the drm core modeset code will also never show up.
1825 * Standard debug practice is to run the fbcon setup without taking the
1826 * console_lock as a hack, to be able to see backtraces and crashes on the
1827 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
1830 * The other option is to just disable fbdev emulation since very likely the
1831 * first modeset from userspace will crash in the same way, and is even easier
1832 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
1833 * kernel cmdline option.
1836 * Zero if everything went ok, nonzero otherwise.
1838 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1842 if (!drm_fbdev_emulation)
1845 mutex_lock(&fb_helper->lock);
1846 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
1850 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1853 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1854 * probing all the outputs attached to the fb
1855 * @fb_helper: driver-allocated fbdev helper, can be NULL
1857 * Scan the connectors attached to the fb_helper and try to put together a
1858 * setup after notification of a change in output configuration.
1860 * Called at runtime, takes the mode config locks to be able to check/change the
1861 * modeset configuration. Must be run from process context (which usually means
1862 * either the output polling work or a work item launched from the driver's
1863 * hotplug interrupt).
1865 * Note that drivers may call this even before calling
1866 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
1867 * for a race-free fbcon setup and will make sure that the fbdev emulation will
1868 * not miss any hotplug events.
1871 * 0 on success and a non-zero error code otherwise.
1873 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1877 if (!drm_fbdev_emulation || !fb_helper)
1880 mutex_lock(&fb_helper->lock);
1881 if (fb_helper->deferred_setup) {
1882 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
1883 fb_helper->preferred_bpp);
1887 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
1888 fb_helper->delayed_hotplug = true;
1889 mutex_unlock(&fb_helper->lock);
1893 drm_master_internal_release(fb_helper->dev);
1895 drm_dbg_kms(fb_helper->dev, "\n");
1897 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
1898 drm_setup_crtcs_fb(fb_helper);
1899 mutex_unlock(&fb_helper->lock);
1901 drm_fb_helper_set_par(fb_helper->fbdev);
1905 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1908 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
1911 * This function can be used as the &drm_driver->lastclose callback for drivers
1912 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
1914 void drm_fb_helper_lastclose(struct drm_device *dev)
1916 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
1918 EXPORT_SYMBOL(drm_fb_helper_lastclose);
1921 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
1922 * helper for fbdev emulation
1925 * This function can be used as the
1926 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
1927 * need to call drm_fb_helper_hotplug_event().
1929 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
1931 drm_fb_helper_hotplug_event(dev->fb_helper);
1933 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
1935 /* @user: 1=userspace, 0=fbcon */
1936 static int drm_fbdev_fb_open(struct fb_info *info, int user)
1938 struct drm_fb_helper *fb_helper = info->par;
1940 /* No need to take a ref for fbcon because it unbinds on unregister */
1941 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
1947 static int drm_fbdev_fb_release(struct fb_info *info, int user)
1949 struct drm_fb_helper *fb_helper = info->par;
1952 module_put(fb_helper->dev->driver->fops->owner);
1957 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
1959 struct fb_info *fbi = fb_helper->fbdev;
1960 void *shadow = NULL;
1962 if (!fb_helper->dev)
1965 if (fbi && fbi->fbdefio) {
1966 fb_deferred_io_cleanup(fbi);
1967 shadow = fbi->screen_buffer;
1970 drm_fb_helper_fini(fb_helper);
1974 drm_client_framebuffer_delete(fb_helper->buffer);
1977 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
1979 drm_fbdev_cleanup(fb_helper);
1980 drm_client_release(&fb_helper->client);
1985 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
1986 * unregister_framebuffer() or fb_release().
1988 static void drm_fbdev_fb_destroy(struct fb_info *info)
1990 drm_fbdev_release(info->par);
1993 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
1995 struct drm_fb_helper *fb_helper = info->par;
1997 if (fb_helper->dev->driver->gem_prime_mmap)
1998 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2003 static const struct fb_ops drm_fbdev_fb_ops = {
2004 .owner = THIS_MODULE,
2005 DRM_FB_HELPER_DEFAULT_OPS,
2006 .fb_open = drm_fbdev_fb_open,
2007 .fb_release = drm_fbdev_fb_release,
2008 .fb_destroy = drm_fbdev_fb_destroy,
2009 .fb_mmap = drm_fbdev_fb_mmap,
2010 .fb_read = drm_fb_helper_sys_read,
2011 .fb_write = drm_fb_helper_sys_write,
2012 .fb_fillrect = drm_fb_helper_sys_fillrect,
2013 .fb_copyarea = drm_fb_helper_sys_copyarea,
2014 .fb_imageblit = drm_fb_helper_sys_imageblit,
2017 static struct fb_deferred_io drm_fbdev_defio = {
2019 .deferred_io = drm_fb_helper_deferred_io,
2023 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2025 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2026 * fb_copyarea, fb_imageblit.
2028 static int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2029 struct drm_fb_helper_surface_size *sizes)
2031 struct drm_client_dev *client = &fb_helper->client;
2032 struct drm_device *dev = fb_helper->dev;
2033 struct drm_client_buffer *buffer;
2034 struct drm_framebuffer *fb;
2035 struct fb_info *fbi;
2039 drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n",
2040 sizes->surface_width, sizes->surface_height,
2041 sizes->surface_bpp);
2043 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2044 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2045 sizes->surface_height, format);
2047 return PTR_ERR(buffer);
2049 fb_helper->buffer = buffer;
2050 fb_helper->fb = buffer->fb;
2053 fbi = drm_fb_helper_alloc_fbi(fb_helper);
2055 return PTR_ERR(fbi);
2057 fbi->fbops = &drm_fbdev_fb_ops;
2058 fbi->screen_size = fb->height * fb->pitches[0];
2059 fbi->fix.smem_len = fbi->screen_size;
2061 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2063 if (drm_fbdev_use_shadow_fb(fb_helper)) {
2064 fbi->screen_buffer = vzalloc(fbi->screen_size);
2065 if (!fbi->screen_buffer)
2068 fbi->fbdefio = &drm_fbdev_defio;
2070 fb_deferred_io_init(fbi);
2072 /* buffer is mapped for HW framebuffer */
2073 vaddr = drm_client_buffer_vmap(fb_helper->buffer);
2075 return PTR_ERR(vaddr);
2077 fbi->screen_buffer = vaddr;
2078 /* Shamelessly leak the physical address to user-space */
2079 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2080 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0)
2081 fbi->fix.smem_start =
2082 page_to_phys(virt_to_page(fbi->screen_buffer));
2089 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2090 .fb_probe = drm_fb_helper_generic_probe,
2093 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2095 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2097 if (fb_helper->fbdev)
2098 /* drm_fbdev_fb_destroy() takes care of cleanup */
2099 drm_fb_helper_unregister_fbi(fb_helper);
2101 drm_fbdev_release(fb_helper);
2104 static int drm_fbdev_client_restore(struct drm_client_dev *client)
2106 drm_fb_helper_lastclose(client->dev);
2111 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2113 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2114 struct drm_device *dev = client->dev;
2117 /* Setup is not retried if it has failed */
2118 if (!fb_helper->dev && fb_helper->funcs)
2122 return drm_fb_helper_hotplug_event(dev->fb_helper);
2124 if (!dev->mode_config.num_connector) {
2125 drm_dbg_kms(dev, "No connectors found, will not create framebuffer!\n");
2129 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2131 ret = drm_fb_helper_init(dev, fb_helper, 0);
2135 if (!drm_drv_uses_atomic_modeset(dev))
2136 drm_helper_disable_unused_functions(dev);
2138 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2145 drm_fbdev_cleanup(fb_helper);
2147 fb_helper->dev = NULL;
2148 fb_helper->fbdev = NULL;
2150 drm_err(dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2155 static const struct drm_client_funcs drm_fbdev_client_funcs = {
2156 .owner = THIS_MODULE,
2157 .unregister = drm_fbdev_client_unregister,
2158 .restore = drm_fbdev_client_restore,
2159 .hotplug = drm_fbdev_client_hotplug,
2163 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2165 * @preferred_bpp: Preferred bits per pixel for the device.
2166 * @dev->mode_config.preferred_depth is used if this is zero.
2168 * This function sets up generic fbdev emulation for drivers that supports
2169 * dumb buffers with a virtual address and that can be mmap'ed.
2171 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2172 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2173 * Simple drivers might use drm_mode_config_helper_suspend().
2175 * Drivers that set the dirty callback on their framebuffer will get a shadow
2176 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2177 * make deferred I/O work with all kinds of buffers. A shadow buffer can be
2178 * requested explicitly by setting struct drm_mode_config.prefer_shadow or
2179 * struct drm_mode_config.prefer_shadow_fbdev to true beforehand. This is
2180 * required to use generic fbdev emulation with SHMEM helpers.
2182 * This function is safe to call even when there are no connectors present.
2183 * Setup will be retried on the next hotplug event.
2185 * The fbdev is destroyed by drm_dev_unregister().
2188 * Zero on success or negative error code on failure.
2190 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
2192 struct drm_fb_helper *fb_helper;
2195 WARN(dev->fb_helper, "fb_helper is already set!\n");
2197 if (!drm_fbdev_emulation)
2200 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2204 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2207 drm_err(dev, "Failed to register client: %d\n", ret);
2212 preferred_bpp = dev->mode_config.preferred_depth;
2215 fb_helper->preferred_bpp = preferred_bpp;
2217 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2219 drm_dbg_kms(dev, "client hotplug ret=%d\n", ret);
2221 drm_client_register(&fb_helper->client);
2225 EXPORT_SYMBOL(drm_fbdev_generic_setup);
2227 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2228 * but the module doesn't depend on any fb console symbols. At least
2229 * attempt to load fbcon to avoid leaving the system without a usable console.
2231 int __init drm_fb_helper_modinit(void)
2233 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2234 const char name[] = "fbcon";
2235 struct module *fbcon;
2237 mutex_lock(&module_mutex);
2238 fbcon = find_module(name);
2239 mutex_unlock(&module_mutex);
2242 request_module_nowait(name);
2246 EXPORT_SYMBOL(drm_fb_helper_modinit);