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_framebuffer.h>
47 #include <drm/drm_print.h>
48 #include <drm/drm_vblank.h>
50 #include "drm_crtc_helper_internal.h"
51 #include "drm_internal.h"
53 static bool drm_fbdev_emulation = true;
54 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
55 MODULE_PARM_DESC(fbdev_emulation,
56 "Enable legacy fbdev emulation [default=true]");
58 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
59 module_param(drm_fbdev_overalloc, int, 0444);
60 MODULE_PARM_DESC(drm_fbdev_overalloc,
61 "Overallocation of the fbdev buffer (%) [default="
62 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
65 * In order to keep user-space compatibility, we want in certain use-cases
66 * to keep leaking the fbdev physical address to the user-space program
67 * handling the fbdev buffer.
68 * This is a bad habit essentially kept into closed source opengl driver
69 * that should really be moved into open-source upstream projects instead
70 * of using legacy physical addresses in user space to communicate with
71 * other out-of-tree kernel modules.
73 * This module_param *should* be removed as soon as possible and be
74 * considered as a broken and legacy behaviour from a modern fbdev device.
76 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
77 static bool drm_leak_fbdev_smem;
78 module_param_unsafe(drm_leak_fbdev_smem, bool, 0600);
79 MODULE_PARM_DESC(drm_leak_fbdev_smem,
80 "Allow unsafe leaking fbdev physical smem address [default=false]");
83 static LIST_HEAD(kernel_fb_helper_list);
84 static DEFINE_MUTEX(kernel_fb_helper_lock);
89 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
90 * mode setting driver. They can be used mostly independently from the crtc
91 * helper functions used by many drivers to implement the kernel mode setting
94 * Drivers that support a dumb buffer with a virtual address and mmap support,
95 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
96 * It will automatically set up deferred I/O if the driver requires a shadow
99 * At runtime drivers should restore the fbdev console by using
100 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
101 * They should also notify the fb helper code from updates to the output
102 * configuration by using drm_fb_helper_output_poll_changed() as their
103 * &drm_mode_config_funcs.output_poll_changed callback.
105 * For suspend/resume consider using drm_mode_config_helper_suspend() and
106 * drm_mode_config_helper_resume() which takes care of fbdev as well.
108 * All other functions exported by the fb helper library can be used to
109 * implement the fbdev driver interface by the driver.
111 * It is possible, though perhaps somewhat tricky, to implement race-free
112 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
113 * helper must be called first to initialize the minimum required to make
114 * hotplug detection work. Drivers also need to make sure to properly set up
115 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
116 * it is safe to enable interrupts and start processing hotplug events. At the
117 * same time, drivers should initialize all modeset objects such as CRTCs,
118 * encoders and connectors. To finish up the fbdev helper initialization, the
119 * drm_fb_helper_init() function is called. To probe for all attached displays
120 * and set up an initial configuration using the detected hardware, drivers
121 * should call drm_fb_helper_initial_config().
123 * If &drm_framebuffer_funcs.dirty is set, the
124 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
125 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
126 * away. This worker then calls the dirty() function ensuring that it will
127 * always run in process context since the fb_*() function could be running in
128 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
129 * callback it will also schedule dirty_work with the damage collected from the
132 * Deferred I/O is not compatible with SHMEM. Such drivers should request an
133 * fbdev shadow buffer and call drm_fbdev_generic_setup() instead.
136 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
138 uint16_t *r_base, *g_base, *b_base;
140 if (crtc->funcs->gamma_set == NULL)
143 r_base = crtc->gamma_store;
144 g_base = r_base + crtc->gamma_size;
145 b_base = g_base + crtc->gamma_size;
147 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
148 crtc->gamma_size, NULL);
152 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
153 * @info: fbdev registered by the helper
155 int drm_fb_helper_debug_enter(struct fb_info *info)
157 struct drm_fb_helper *helper = info->par;
158 const struct drm_crtc_helper_funcs *funcs;
159 struct drm_mode_set *mode_set;
161 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
162 mutex_lock(&helper->client.modeset_mutex);
163 drm_client_for_each_modeset(mode_set, &helper->client) {
164 if (!mode_set->crtc->enabled)
167 funcs = mode_set->crtc->helper_private;
168 if (funcs->mode_set_base_atomic == NULL)
171 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
174 funcs->mode_set_base_atomic(mode_set->crtc,
178 ENTER_ATOMIC_MODE_SET);
180 mutex_unlock(&helper->client.modeset_mutex);
185 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
188 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
189 * @info: fbdev registered by the helper
191 int drm_fb_helper_debug_leave(struct fb_info *info)
193 struct drm_fb_helper *helper = info->par;
194 struct drm_client_dev *client = &helper->client;
195 struct drm_device *dev = helper->dev;
196 struct drm_crtc *crtc;
197 const struct drm_crtc_helper_funcs *funcs;
198 struct drm_mode_set *mode_set;
199 struct drm_framebuffer *fb;
201 mutex_lock(&client->modeset_mutex);
202 drm_client_for_each_modeset(mode_set, client) {
203 crtc = mode_set->crtc;
204 if (drm_drv_uses_atomic_modeset(crtc->dev))
207 funcs = crtc->helper_private;
208 fb = crtc->primary->fb;
214 drm_err(dev, "no fb to restore?\n");
218 if (funcs->mode_set_base_atomic == NULL)
221 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
222 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
223 crtc->y, LEAVE_ATOMIC_MODE_SET);
225 mutex_unlock(&client->modeset_mutex);
229 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
232 __drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper,
238 if (!drm_fbdev_emulation || !fb_helper)
241 if (READ_ONCE(fb_helper->deferred_setup))
244 mutex_lock(&fb_helper->lock);
247 * Yes this is the _locked version which expects the master lock
248 * to be held. But for forced restores we're intentionally
249 * racing here, see drm_fb_helper_set_par().
251 ret = drm_client_modeset_commit_locked(&fb_helper->client);
253 ret = drm_client_modeset_commit(&fb_helper->client);
256 do_delayed = fb_helper->delayed_hotplug;
258 fb_helper->delayed_hotplug = false;
259 mutex_unlock(&fb_helper->lock);
262 drm_fb_helper_hotplug_event(fb_helper);
268 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
269 * @fb_helper: driver-allocated fbdev helper, can be NULL
271 * This should be called from driver's drm &drm_driver.lastclose callback
272 * when implementing an fbcon on top of kms using this helper. This ensures that
273 * the user isn't greeted with a black screen when e.g. X dies.
276 * Zero if everything went ok, negative error code otherwise.
278 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
280 return __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, false);
282 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
284 #ifdef CONFIG_MAGIC_SYSRQ
285 /* emergency restore, don't bother with error reporting */
286 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
288 struct drm_fb_helper *helper;
290 mutex_lock(&kernel_fb_helper_lock);
291 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
292 struct drm_device *dev = helper->dev;
294 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
297 mutex_lock(&helper->lock);
298 drm_client_modeset_commit_locked(&helper->client);
299 mutex_unlock(&helper->lock);
301 mutex_unlock(&kernel_fb_helper_lock);
304 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
306 static void drm_fb_helper_sysrq(int dummy1)
308 schedule_work(&drm_fb_helper_restore_work);
311 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
312 .handler = drm_fb_helper_sysrq,
313 .help_msg = "force-fb(v)",
314 .action_msg = "Restore framebuffer console",
317 static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
320 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
322 struct drm_fb_helper *fb_helper = info->par;
324 mutex_lock(&fb_helper->lock);
325 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
326 mutex_unlock(&fb_helper->lock);
330 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
331 * @blank: desired blanking state
332 * @info: fbdev registered by the helper
334 int drm_fb_helper_blank(int blank, struct fb_info *info)
336 if (oops_in_progress)
340 /* Display: On; HSync: On, VSync: On */
341 case FB_BLANK_UNBLANK:
342 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
344 /* Display: Off; HSync: On, VSync: On */
345 case FB_BLANK_NORMAL:
346 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
348 /* Display: Off; HSync: Off, VSync: On */
349 case FB_BLANK_HSYNC_SUSPEND:
350 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
352 /* Display: Off; HSync: On, VSync: Off */
353 case FB_BLANK_VSYNC_SUSPEND:
354 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
356 /* Display: Off; HSync: Off, VSync: Off */
357 case FB_BLANK_POWERDOWN:
358 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
363 EXPORT_SYMBOL(drm_fb_helper_blank);
365 static void drm_fb_helper_resume_worker(struct work_struct *work)
367 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
371 fb_set_suspend(helper->info, 0);
375 static void drm_fb_helper_damage_blit_real(struct drm_fb_helper *fb_helper,
376 struct drm_clip_rect *clip,
377 struct iosys_map *dst)
379 struct drm_framebuffer *fb = fb_helper->fb;
380 size_t offset = clip->y1 * fb->pitches[0];
381 size_t len = clip->x2 - clip->x1;
385 switch (drm_format_info_bpp(fb->format, 0)) {
387 offset += clip->x1 / 8;
388 len = DIV_ROUND_UP(len + clip->x1 % 8, 8);
391 offset += clip->x1 / 4;
392 len = DIV_ROUND_UP(len + clip->x1 % 4, 4);
395 offset += clip->x1 / 2;
396 len = DIV_ROUND_UP(len + clip->x1 % 2, 2);
399 offset += clip->x1 * fb->format->cpp[0];
400 len *= fb->format->cpp[0];
404 src = fb_helper->info->screen_buffer + offset;
405 iosys_map_incr(dst, offset); /* go to first pixel within clip rect */
407 for (y = clip->y1; y < clip->y2; y++) {
408 iosys_map_memcpy_to(dst, 0, src, len);
409 iosys_map_incr(dst, fb->pitches[0]);
410 src += fb->pitches[0];
414 static int drm_fb_helper_damage_blit(struct drm_fb_helper *fb_helper,
415 struct drm_clip_rect *clip)
417 struct drm_client_buffer *buffer = fb_helper->buffer;
418 struct iosys_map map, dst;
422 * We have to pin the client buffer to its current location while
423 * flushing the shadow buffer. In the general case, concurrent
424 * modesetting operations could try to move the buffer and would
425 * fail. The modeset has to be serialized by acquiring the reservation
426 * object of the underlying BO here.
428 * For fbdev emulation, we only have to protect against fbdev modeset
429 * operations. Nothing else will involve the client buffer's BO. So it
430 * is sufficient to acquire struct drm_fb_helper.lock here.
432 mutex_lock(&fb_helper->lock);
434 ret = drm_client_buffer_vmap(buffer, &map);
439 drm_fb_helper_damage_blit_real(fb_helper, clip, &dst);
441 drm_client_buffer_vunmap(buffer);
444 mutex_unlock(&fb_helper->lock);
449 static void drm_fb_helper_damage_work(struct work_struct *work)
451 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper, damage_work);
452 struct drm_device *dev = helper->dev;
453 struct drm_clip_rect *clip = &helper->damage_clip;
454 struct drm_clip_rect clip_copy;
458 if (drm_WARN_ON_ONCE(dev, !helper->funcs->fb_dirty))
461 spin_lock_irqsave(&helper->damage_lock, flags);
463 clip->x1 = clip->y1 = ~0;
464 clip->x2 = clip->y2 = 0;
465 spin_unlock_irqrestore(&helper->damage_lock, flags);
467 ret = helper->funcs->fb_dirty(helper, &clip_copy);
475 * Restore damage clip rectangle on errors. The next run
476 * of the damage worker will perform the update.
478 spin_lock_irqsave(&helper->damage_lock, flags);
479 clip->x1 = min_t(u32, clip->x1, clip_copy.x1);
480 clip->y1 = min_t(u32, clip->y1, clip_copy.y1);
481 clip->x2 = max_t(u32, clip->x2, clip_copy.x2);
482 clip->y2 = max_t(u32, clip->y2, clip_copy.y2);
483 spin_unlock_irqrestore(&helper->damage_lock, flags);
487 * drm_fb_helper_prepare - setup a drm_fb_helper structure
489 * @helper: driver-allocated fbdev helper structure to set up
490 * @funcs: pointer to structure of functions associate with this helper
492 * Sets up the bare minimum to make the framebuffer helper usable. This is
493 * useful to implement race-free initialization of the polling helpers.
495 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
496 const struct drm_fb_helper_funcs *funcs)
498 INIT_LIST_HEAD(&helper->kernel_fb_list);
499 spin_lock_init(&helper->damage_lock);
500 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
501 INIT_WORK(&helper->damage_work, drm_fb_helper_damage_work);
502 helper->damage_clip.x1 = helper->damage_clip.y1 = ~0;
503 mutex_init(&helper->lock);
504 helper->funcs = funcs;
507 EXPORT_SYMBOL(drm_fb_helper_prepare);
510 * drm_fb_helper_init - initialize a &struct drm_fb_helper
512 * @fb_helper: driver-allocated fbdev helper structure to initialize
514 * This allocates the structures for the fbdev helper with the given limits.
515 * Note that this won't yet touch the hardware (through the driver interfaces)
516 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
517 * to allow driver writes more control over the exact init sequence.
519 * Drivers must call drm_fb_helper_prepare() before calling this function.
522 * Zero if everything went ok, nonzero otherwise.
524 int drm_fb_helper_init(struct drm_device *dev,
525 struct drm_fb_helper *fb_helper)
530 * If this is not the generic fbdev client, initialize a drm_client
531 * without callbacks so we can use the modesets.
533 if (!fb_helper->client.funcs) {
534 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
539 dev->fb_helper = fb_helper;
543 EXPORT_SYMBOL(drm_fb_helper_init);
546 * drm_fb_helper_alloc_info - allocate fb_info and some of its members
547 * @fb_helper: driver-allocated fbdev helper
549 * A helper to alloc fb_info and the members cmap and apertures. Called
550 * by the driver within the fb_probe fb_helper callback function. Drivers do not
551 * need to release the allocated fb_info structure themselves, this is
552 * automatically done when calling drm_fb_helper_fini().
555 * fb_info pointer if things went okay, pointer containing error code
558 struct fb_info *drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper)
560 struct device *dev = fb_helper->dev->dev;
561 struct fb_info *info;
564 info = framebuffer_alloc(0, dev);
566 return ERR_PTR(-ENOMEM);
568 ret = fb_alloc_cmap(&info->cmap, 256, 0);
573 * TODO: We really should be smarter here and alloc an aperture
574 * for each IORESOURCE_MEM resource helper->dev->dev has and also
575 * init the ranges of the appertures based on the resources.
576 * Note some drivers currently count on there being only 1 empty
577 * aperture and fill this themselves, these will need to be dealt
578 * with somehow when fixing this.
580 info->apertures = alloc_apertures(1);
581 if (!info->apertures) {
586 fb_helper->info = info;
587 info->skip_vt_switch = true;
592 fb_dealloc_cmap(&info->cmap);
594 framebuffer_release(info);
597 EXPORT_SYMBOL(drm_fb_helper_alloc_info);
600 * drm_fb_helper_unregister_info - unregister fb_info framebuffer device
601 * @fb_helper: driver-allocated fbdev helper, can be NULL
603 * A wrapper around unregister_framebuffer, to release the fb_info
604 * framebuffer device. This must be called before releasing all resources for
605 * @fb_helper by calling drm_fb_helper_fini().
607 void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper)
609 if (fb_helper && fb_helper->info)
610 unregister_framebuffer(fb_helper->info);
612 EXPORT_SYMBOL(drm_fb_helper_unregister_info);
615 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
616 * @fb_helper: driver-allocated fbdev helper, can be NULL
618 * This cleans up all remaining resources associated with @fb_helper.
620 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
622 struct fb_info *info;
627 fb_helper->dev->fb_helper = NULL;
629 if (!drm_fbdev_emulation)
632 cancel_work_sync(&fb_helper->resume_work);
633 cancel_work_sync(&fb_helper->damage_work);
635 info = fb_helper->info;
638 fb_dealloc_cmap(&info->cmap);
639 framebuffer_release(info);
641 fb_helper->info = NULL;
643 mutex_lock(&kernel_fb_helper_lock);
644 if (!list_empty(&fb_helper->kernel_fb_list)) {
645 list_del(&fb_helper->kernel_fb_list);
646 if (list_empty(&kernel_fb_helper_list))
647 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
649 mutex_unlock(&kernel_fb_helper_lock);
651 mutex_destroy(&fb_helper->lock);
653 if (!fb_helper->client.funcs)
654 drm_client_release(&fb_helper->client);
656 EXPORT_SYMBOL(drm_fb_helper_fini);
658 static void drm_fb_helper_damage(struct drm_fb_helper *helper, u32 x, u32 y,
659 u32 width, u32 height)
661 struct drm_clip_rect *clip = &helper->damage_clip;
664 spin_lock_irqsave(&helper->damage_lock, flags);
665 clip->x1 = min_t(u32, clip->x1, x);
666 clip->y1 = min_t(u32, clip->y1, y);
667 clip->x2 = max_t(u32, clip->x2, x + width);
668 clip->y2 = max_t(u32, clip->y2, y + height);
669 spin_unlock_irqrestore(&helper->damage_lock, flags);
671 schedule_work(&helper->damage_work);
675 * Convert memory region into area of scanlines and pixels per
676 * scanline. The parameters off and len must not reach beyond
677 * the end of the framebuffer.
679 static void drm_fb_helper_memory_range_to_clip(struct fb_info *info, off_t off, size_t len,
680 struct drm_rect *clip)
682 off_t end = off + len;
684 u32 y1 = off / info->fix.line_length;
685 u32 x2 = info->var.xres;
686 u32 y2 = DIV_ROUND_UP(end, info->fix.line_length);
688 if ((y2 - y1) == 1) {
690 * We've only written to a single scanline. Try to reduce
691 * the number of horizontal pixels that need an update.
693 off_t bit_off = (off % info->fix.line_length) * 8;
694 off_t bit_end = (end % info->fix.line_length) * 8;
696 x1 = bit_off / info->var.bits_per_pixel;
697 x2 = DIV_ROUND_UP(bit_end, info->var.bits_per_pixel);
700 drm_rect_init(clip, x1, y1, x2 - x1, y2 - y1);
704 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
705 * @info: fb_info struct pointer
706 * @pagereflist: list of mmap framebuffer pages that have to be flushed
708 * This function is used as the &fb_deferred_io.deferred_io
709 * callback function for flushing the fbdev mmap writes.
711 void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist)
713 struct drm_fb_helper *helper = info->par;
714 unsigned long start, end, min_off, max_off;
715 struct fb_deferred_io_pageref *pageref;
716 struct drm_rect damage_area;
720 list_for_each_entry(pageref, pagereflist, list) {
721 start = pageref->offset;
722 end = start + PAGE_SIZE;
723 min_off = min(min_off, start);
724 max_off = max(max_off, end);
726 if (min_off >= max_off)
729 if (helper->funcs->fb_dirty) {
731 * As we can only track pages, we might reach beyond the end
732 * of the screen and account for non-existing scanlines. Hence,
733 * keep the covered memory area within the screen buffer.
735 max_off = min(max_off, info->screen_size);
737 drm_fb_helper_memory_range_to_clip(info, min_off, max_off - min_off, &damage_area);
738 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1,
739 drm_rect_width(&damage_area),
740 drm_rect_height(&damage_area));
743 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
745 typedef ssize_t (*drm_fb_helper_read_screen)(struct fb_info *info, char __user *buf,
746 size_t count, loff_t pos);
748 static ssize_t __drm_fb_helper_read(struct fb_info *info, char __user *buf, size_t count,
749 loff_t *ppos, drm_fb_helper_read_screen read_screen)
755 if (info->screen_size)
756 total_size = info->screen_size;
758 total_size = info->fix.smem_len;
760 if (pos >= total_size)
762 if (count >= total_size)
764 if (total_size - count < pos)
765 count = total_size - pos;
767 if (info->fbops->fb_sync)
768 info->fbops->fb_sync(info);
770 ret = read_screen(info, buf, count, pos);
777 typedef ssize_t (*drm_fb_helper_write_screen)(struct fb_info *info, const char __user *buf,
778 size_t count, loff_t pos);
780 static ssize_t __drm_fb_helper_write(struct fb_info *info, const char __user *buf, size_t count,
781 loff_t *ppos, drm_fb_helper_write_screen write_screen)
788 if (info->screen_size)
789 total_size = info->screen_size;
791 total_size = info->fix.smem_len;
793 if (pos > total_size)
795 if (count > total_size) {
799 if (total_size - count < pos) {
802 count = total_size - pos;
805 if (info->fbops->fb_sync)
806 info->fbops->fb_sync(info);
809 * Copy to framebuffer even if we already logged an error. Emulates
810 * the behavior of the original fbdev implementation.
812 ret = write_screen(info, buf, count, pos);
814 return ret; /* return last error, if any */
816 return err; /* return previous error, if any */
823 static ssize_t drm_fb_helper_read_screen_buffer(struct fb_info *info, char __user *buf,
824 size_t count, loff_t pos)
826 const char *src = info->screen_buffer + pos;
828 if (copy_to_user(buf, src, count))
835 * drm_fb_helper_sys_read - Implements struct &fb_ops.fb_read for system memory
836 * @info: fb_info struct pointer
837 * @buf: userspace buffer to read from framebuffer memory
838 * @count: number of bytes to read from framebuffer memory
839 * @ppos: read offset within framebuffer memory
842 * The number of bytes read on success, or an error code otherwise.
844 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
845 size_t count, loff_t *ppos)
847 return __drm_fb_helper_read(info, buf, count, ppos, drm_fb_helper_read_screen_buffer);
849 EXPORT_SYMBOL(drm_fb_helper_sys_read);
851 static ssize_t drm_fb_helper_write_screen_buffer(struct fb_info *info, const char __user *buf,
852 size_t count, loff_t pos)
854 char *dst = info->screen_buffer + pos;
856 if (copy_from_user(dst, buf, count))
863 * drm_fb_helper_sys_write - Implements struct &fb_ops.fb_write for system memory
864 * @info: fb_info struct pointer
865 * @buf: userspace buffer to write to framebuffer memory
866 * @count: number of bytes to write to framebuffer memory
867 * @ppos: write offset within framebuffer memory
870 * The number of bytes written on success, or an error code otherwise.
872 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
873 size_t count, loff_t *ppos)
875 struct drm_fb_helper *helper = info->par;
878 struct drm_rect damage_area;
880 ret = __drm_fb_helper_write(info, buf, count, ppos, drm_fb_helper_write_screen_buffer);
884 if (helper->funcs->fb_dirty) {
885 drm_fb_helper_memory_range_to_clip(info, pos, ret, &damage_area);
886 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1,
887 drm_rect_width(&damage_area),
888 drm_rect_height(&damage_area));
893 EXPORT_SYMBOL(drm_fb_helper_sys_write);
896 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
897 * @info: fbdev registered by the helper
898 * @rect: info about rectangle to fill
900 * A wrapper around sys_fillrect implemented by fbdev core
902 void drm_fb_helper_sys_fillrect(struct fb_info *info,
903 const struct fb_fillrect *rect)
905 struct drm_fb_helper *helper = info->par;
907 sys_fillrect(info, rect);
909 if (helper->funcs->fb_dirty)
910 drm_fb_helper_damage(helper, rect->dx, rect->dy, rect->width, rect->height);
912 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
915 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
916 * @info: fbdev registered by the helper
917 * @area: info about area to copy
919 * A wrapper around sys_copyarea implemented by fbdev core
921 void drm_fb_helper_sys_copyarea(struct fb_info *info,
922 const struct fb_copyarea *area)
924 struct drm_fb_helper *helper = info->par;
926 sys_copyarea(info, area);
928 if (helper->funcs->fb_dirty)
929 drm_fb_helper_damage(helper, area->dx, area->dy, area->width, area->height);
931 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
934 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
935 * @info: fbdev registered by the helper
936 * @image: info about image to blit
938 * A wrapper around sys_imageblit implemented by fbdev core
940 void drm_fb_helper_sys_imageblit(struct fb_info *info,
941 const struct fb_image *image)
943 struct drm_fb_helper *helper = info->par;
945 sys_imageblit(info, image);
947 if (helper->funcs->fb_dirty)
948 drm_fb_helper_damage(helper, image->dx, image->dy, image->width, image->height);
950 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
952 static ssize_t fb_read_screen_base(struct fb_info *info, char __user *buf, size_t count,
955 const char __iomem *src = info->screen_base + pos;
956 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
961 tmp = kmalloc(alloc_size, GFP_KERNEL);
966 size_t c = min_t(size_t, count, alloc_size);
968 memcpy_fromio(tmp, src, c);
969 if (copy_to_user(buf, tmp, c)) {
982 return ret ? ret : err;
986 * drm_fb_helper_cfb_read - Implements struct &fb_ops.fb_read for I/O memory
987 * @info: fb_info struct pointer
988 * @buf: userspace buffer to read from framebuffer memory
989 * @count: number of bytes to read from framebuffer memory
990 * @ppos: read offset within framebuffer memory
993 * The number of bytes read on success, or an error code otherwise.
995 ssize_t drm_fb_helper_cfb_read(struct fb_info *info, char __user *buf,
996 size_t count, loff_t *ppos)
998 return __drm_fb_helper_read(info, buf, count, ppos, fb_read_screen_base);
1000 EXPORT_SYMBOL(drm_fb_helper_cfb_read);
1002 static ssize_t fb_write_screen_base(struct fb_info *info, const char __user *buf, size_t count,
1005 char __iomem *dst = info->screen_base + pos;
1006 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
1011 tmp = kmalloc(alloc_size, GFP_KERNEL);
1016 size_t c = min_t(size_t, count, alloc_size);
1018 if (copy_from_user(tmp, buf, c)) {
1022 memcpy_toio(dst, tmp, c);
1032 return ret ? ret : err;
1036 * drm_fb_helper_cfb_write - Implements struct &fb_ops.fb_write for I/O memory
1037 * @info: fb_info struct pointer
1038 * @buf: userspace buffer to write to framebuffer memory
1039 * @count: number of bytes to write to framebuffer memory
1040 * @ppos: write offset within framebuffer memory
1043 * The number of bytes written on success, or an error code otherwise.
1045 ssize_t drm_fb_helper_cfb_write(struct fb_info *info, const char __user *buf,
1046 size_t count, loff_t *ppos)
1048 struct drm_fb_helper *helper = info->par;
1051 struct drm_rect damage_area;
1053 ret = __drm_fb_helper_write(info, buf, count, ppos, fb_write_screen_base);
1057 if (helper->funcs->fb_dirty) {
1058 drm_fb_helper_memory_range_to_clip(info, pos, ret, &damage_area);
1059 drm_fb_helper_damage(helper, damage_area.x1, damage_area.y1,
1060 drm_rect_width(&damage_area),
1061 drm_rect_height(&damage_area));
1066 EXPORT_SYMBOL(drm_fb_helper_cfb_write);
1069 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1070 * @info: fbdev registered by the helper
1071 * @rect: info about rectangle to fill
1073 * A wrapper around cfb_fillrect implemented by fbdev core
1075 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1076 const struct fb_fillrect *rect)
1078 struct drm_fb_helper *helper = info->par;
1080 cfb_fillrect(info, rect);
1082 if (helper->funcs->fb_dirty)
1083 drm_fb_helper_damage(helper, rect->dx, rect->dy, rect->width, rect->height);
1085 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1088 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1089 * @info: fbdev registered by the helper
1090 * @area: info about area to copy
1092 * A wrapper around cfb_copyarea implemented by fbdev core
1094 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1095 const struct fb_copyarea *area)
1097 struct drm_fb_helper *helper = info->par;
1099 cfb_copyarea(info, area);
1101 if (helper->funcs->fb_dirty)
1102 drm_fb_helper_damage(helper, area->dx, area->dy, area->width, area->height);
1104 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1107 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1108 * @info: fbdev registered by the helper
1109 * @image: info about image to blit
1111 * A wrapper around cfb_imageblit implemented by fbdev core
1113 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1114 const struct fb_image *image)
1116 struct drm_fb_helper *helper = info->par;
1118 cfb_imageblit(info, image);
1120 if (helper->funcs->fb_dirty)
1121 drm_fb_helper_damage(helper, image->dx, image->dy, image->width, image->height);
1123 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1126 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1127 * @fb_helper: driver-allocated fbdev helper, can be NULL
1128 * @suspend: whether to suspend or resume
1130 * A wrapper around fb_set_suspend implemented by fbdev core.
1131 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1134 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1136 if (fb_helper && fb_helper->info)
1137 fb_set_suspend(fb_helper->info, suspend);
1139 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1142 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1143 * takes the console lock
1144 * @fb_helper: driver-allocated fbdev helper, can be NULL
1145 * @suspend: whether to suspend or resume
1147 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1148 * isn't available on resume, a worker is tasked with waiting for the lock
1149 * to become available. The console lock can be pretty contented on resume
1150 * due to all the printk activity.
1152 * This function can be called multiple times with the same state since
1153 * &fb_info.state is checked to see if fbdev is running or not before locking.
1155 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1157 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1160 if (!fb_helper || !fb_helper->info)
1163 /* make sure there's no pending/ongoing resume */
1164 flush_work(&fb_helper->resume_work);
1167 if (fb_helper->info->state != FBINFO_STATE_RUNNING)
1173 if (fb_helper->info->state == FBINFO_STATE_RUNNING)
1176 if (!console_trylock()) {
1177 schedule_work(&fb_helper->resume_work);
1182 fb_set_suspend(fb_helper->info, suspend);
1185 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1187 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
1189 u32 *palette = (u32 *)info->pseudo_palette;
1192 if (cmap->start + cmap->len > 16)
1195 for (i = 0; i < cmap->len; ++i) {
1196 u16 red = cmap->red[i];
1197 u16 green = cmap->green[i];
1198 u16 blue = cmap->blue[i];
1201 red >>= 16 - info->var.red.length;
1202 green >>= 16 - info->var.green.length;
1203 blue >>= 16 - info->var.blue.length;
1204 value = (red << info->var.red.offset) |
1205 (green << info->var.green.offset) |
1206 (blue << info->var.blue.offset);
1207 if (info->var.transp.length > 0) {
1208 u32 mask = (1 << info->var.transp.length) - 1;
1210 mask <<= info->var.transp.offset;
1213 palette[cmap->start + i] = value;
1219 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
1221 struct drm_fb_helper *fb_helper = info->par;
1222 struct drm_mode_set *modeset;
1223 struct drm_crtc *crtc;
1227 drm_modeset_lock_all(fb_helper->dev);
1228 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1229 crtc = modeset->crtc;
1230 if (!crtc->funcs->gamma_set || !crtc->gamma_size) {
1235 if (cmap->start + cmap->len > crtc->gamma_size) {
1240 r = crtc->gamma_store;
1241 g = r + crtc->gamma_size;
1242 b = g + crtc->gamma_size;
1244 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1245 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1246 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1248 ret = crtc->funcs->gamma_set(crtc, r, g, b,
1249 crtc->gamma_size, NULL);
1254 drm_modeset_unlock_all(fb_helper->dev);
1259 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
1260 struct fb_cmap *cmap)
1262 struct drm_device *dev = crtc->dev;
1263 struct drm_property_blob *gamma_lut;
1264 struct drm_color_lut *lut;
1265 int size = crtc->gamma_size;
1268 if (!size || cmap->start + cmap->len > size)
1269 return ERR_PTR(-EINVAL);
1271 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1272 if (IS_ERR(gamma_lut))
1275 lut = gamma_lut->data;
1276 if (cmap->start || cmap->len != size) {
1277 u16 *r = crtc->gamma_store;
1278 u16 *g = r + crtc->gamma_size;
1279 u16 *b = g + crtc->gamma_size;
1281 for (i = 0; i < cmap->start; i++) {
1283 lut[i].green = g[i];
1286 for (i = cmap->start + cmap->len; i < size; i++) {
1288 lut[i].green = g[i];
1293 for (i = 0; i < cmap->len; i++) {
1294 lut[cmap->start + i].red = cmap->red[i];
1295 lut[cmap->start + i].green = cmap->green[i];
1296 lut[cmap->start + i].blue = cmap->blue[i];
1302 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1304 struct drm_fb_helper *fb_helper = info->par;
1305 struct drm_device *dev = fb_helper->dev;
1306 struct drm_property_blob *gamma_lut = NULL;
1307 struct drm_modeset_acquire_ctx ctx;
1308 struct drm_crtc_state *crtc_state;
1309 struct drm_atomic_state *state;
1310 struct drm_mode_set *modeset;
1311 struct drm_crtc *crtc;
1316 drm_modeset_acquire_init(&ctx, 0);
1318 state = drm_atomic_state_alloc(dev);
1324 state->acquire_ctx = &ctx;
1326 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1327 crtc = modeset->crtc;
1330 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1331 if (IS_ERR(gamma_lut)) {
1332 ret = PTR_ERR(gamma_lut);
1337 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1338 if (IS_ERR(crtc_state)) {
1339 ret = PTR_ERR(crtc_state);
1344 * FIXME: This always uses gamma_lut. Some HW have only
1345 * degamma_lut, in which case we should reset gamma_lut and set
1346 * degamma_lut. See drm_crtc_legacy_gamma_set().
1348 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1350 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1351 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1353 crtc_state->color_mgmt_changed |= replaced;
1356 ret = drm_atomic_commit(state);
1360 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1361 crtc = modeset->crtc;
1363 r = crtc->gamma_store;
1364 g = r + crtc->gamma_size;
1365 b = g + crtc->gamma_size;
1367 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1368 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1369 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1373 if (ret == -EDEADLK)
1376 drm_property_blob_put(gamma_lut);
1377 drm_atomic_state_put(state);
1379 drm_modeset_drop_locks(&ctx);
1380 drm_modeset_acquire_fini(&ctx);
1385 drm_atomic_state_clear(state);
1386 drm_modeset_backoff(&ctx);
1391 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1392 * @cmap: cmap to set
1393 * @info: fbdev registered by the helper
1395 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1397 struct drm_fb_helper *fb_helper = info->par;
1398 struct drm_device *dev = fb_helper->dev;
1401 if (oops_in_progress)
1404 mutex_lock(&fb_helper->lock);
1406 if (!drm_master_internal_acquire(dev)) {
1411 mutex_lock(&fb_helper->client.modeset_mutex);
1412 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1413 ret = setcmap_pseudo_palette(cmap, info);
1414 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1415 ret = setcmap_atomic(cmap, info);
1417 ret = setcmap_legacy(cmap, info);
1418 mutex_unlock(&fb_helper->client.modeset_mutex);
1420 drm_master_internal_release(dev);
1422 mutex_unlock(&fb_helper->lock);
1426 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1429 * drm_fb_helper_ioctl - legacy ioctl implementation
1430 * @info: fbdev registered by the helper
1431 * @cmd: ioctl command
1432 * @arg: ioctl argument
1434 * A helper to implement the standard fbdev ioctl. Only
1435 * FBIO_WAITFORVSYNC is implemented for now.
1437 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1440 struct drm_fb_helper *fb_helper = info->par;
1441 struct drm_device *dev = fb_helper->dev;
1442 struct drm_crtc *crtc;
1445 mutex_lock(&fb_helper->lock);
1446 if (!drm_master_internal_acquire(dev)) {
1452 case FBIO_WAITFORVSYNC:
1454 * Only consider the first CRTC.
1456 * This ioctl is supposed to take the CRTC number as
1457 * an argument, but in fbdev times, what that number
1458 * was supposed to be was quite unclear, different
1459 * drivers were passing that argument differently
1460 * (some by reference, some by value), and most of the
1461 * userspace applications were just hardcoding 0 as an
1464 * The first CRTC should be the integrated panel on
1465 * most drivers, so this is the best choice we can
1466 * make. If we're not smart enough here, one should
1467 * just consider switch the userspace to KMS.
1469 crtc = fb_helper->client.modesets[0].crtc;
1472 * Only wait for a vblank event if the CRTC is
1473 * enabled, otherwise just don't do anythintg,
1474 * not even report an error.
1476 ret = drm_crtc_vblank_get(crtc);
1478 drm_crtc_wait_one_vblank(crtc);
1479 drm_crtc_vblank_put(crtc);
1488 drm_master_internal_release(dev);
1490 mutex_unlock(&fb_helper->lock);
1493 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1495 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1496 const struct fb_var_screeninfo *var_2)
1498 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1499 var_1->grayscale == var_2->grayscale &&
1500 var_1->red.offset == var_2->red.offset &&
1501 var_1->red.length == var_2->red.length &&
1502 var_1->red.msb_right == var_2->red.msb_right &&
1503 var_1->green.offset == var_2->green.offset &&
1504 var_1->green.length == var_2->green.length &&
1505 var_1->green.msb_right == var_2->green.msb_right &&
1506 var_1->blue.offset == var_2->blue.offset &&
1507 var_1->blue.length == var_2->blue.length &&
1508 var_1->blue.msb_right == var_2->blue.msb_right &&
1509 var_1->transp.offset == var_2->transp.offset &&
1510 var_1->transp.length == var_2->transp.length &&
1511 var_1->transp.msb_right == var_2->transp.msb_right;
1514 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1515 const struct drm_format_info *format)
1517 u8 depth = format->depth;
1519 if (format->is_color_indexed) {
1520 var->red.offset = 0;
1521 var->green.offset = 0;
1522 var->blue.offset = 0;
1523 var->red.length = depth;
1524 var->green.length = depth;
1525 var->blue.length = depth;
1526 var->transp.offset = 0;
1527 var->transp.length = 0;
1533 var->red.offset = 10;
1534 var->green.offset = 5;
1535 var->blue.offset = 0;
1536 var->red.length = 5;
1537 var->green.length = 5;
1538 var->blue.length = 5;
1539 var->transp.offset = 15;
1540 var->transp.length = 1;
1543 var->red.offset = 11;
1544 var->green.offset = 5;
1545 var->blue.offset = 0;
1546 var->red.length = 5;
1547 var->green.length = 6;
1548 var->blue.length = 5;
1549 var->transp.offset = 0;
1552 var->red.offset = 16;
1553 var->green.offset = 8;
1554 var->blue.offset = 0;
1555 var->red.length = 8;
1556 var->green.length = 8;
1557 var->blue.length = 8;
1558 var->transp.offset = 0;
1559 var->transp.length = 0;
1562 var->red.offset = 16;
1563 var->green.offset = 8;
1564 var->blue.offset = 0;
1565 var->red.length = 8;
1566 var->green.length = 8;
1567 var->blue.length = 8;
1568 var->transp.offset = 24;
1569 var->transp.length = 8;
1577 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1578 * @var: screeninfo to check
1579 * @info: fbdev registered by the helper
1581 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1582 struct fb_info *info)
1584 struct drm_fb_helper *fb_helper = info->par;
1585 struct drm_framebuffer *fb = fb_helper->fb;
1586 const struct drm_format_info *format = fb->format;
1587 struct drm_device *dev = fb_helper->dev;
1590 if (in_dbg_master())
1593 if (var->pixclock != 0) {
1594 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1598 switch (format->format) {
1602 /* supported format with sub-byte pixels */
1606 if ((drm_format_info_block_width(format, 0) > 1) ||
1607 (drm_format_info_block_height(format, 0) > 1))
1613 * Changes struct fb_var_screeninfo are currently not pushed back
1614 * to KMS, hence fail if different settings are requested.
1616 bpp = drm_format_info_bpp(format, 0);
1617 if (var->bits_per_pixel > bpp ||
1618 var->xres > fb->width || var->yres > fb->height ||
1619 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1620 drm_dbg_kms(dev, "fb requested width/height/bpp can't fit in current fb "
1621 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1622 var->xres, var->yres, var->bits_per_pixel,
1623 var->xres_virtual, var->yres_virtual,
1624 fb->width, fb->height, bpp);
1629 * Workaround for SDL 1.2, which is known to be setting all pixel format
1630 * fields values to zero in some cases. We treat this situation as a
1631 * kind of "use some reasonable autodetected values".
1633 if (!var->red.offset && !var->green.offset &&
1634 !var->blue.offset && !var->transp.offset &&
1635 !var->red.length && !var->green.length &&
1636 !var->blue.length && !var->transp.length &&
1637 !var->red.msb_right && !var->green.msb_right &&
1638 !var->blue.msb_right && !var->transp.msb_right) {
1639 drm_fb_helper_fill_pixel_fmt(var, format);
1643 * Likewise, bits_per_pixel should be rounded up to a supported value.
1645 var->bits_per_pixel = bpp;
1648 * drm fbdev emulation doesn't support changing the pixel format at all,
1649 * so reject all pixel format changing requests.
1651 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1652 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel format\n");
1658 EXPORT_SYMBOL(drm_fb_helper_check_var);
1661 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1662 * @info: fbdev registered by the helper
1664 * This will let fbcon do the mode init and is called at initialization time by
1665 * the fbdev core when registering the driver, and later on through the hotplug
1668 int drm_fb_helper_set_par(struct fb_info *info)
1670 struct drm_fb_helper *fb_helper = info->par;
1671 struct fb_var_screeninfo *var = &info->var;
1674 if (oops_in_progress)
1677 if (var->pixclock != 0) {
1678 drm_err(fb_helper->dev, "PIXEL CLOCK SET\n");
1683 * Normally we want to make sure that a kms master takes precedence over
1684 * fbdev, to avoid fbdev flickering and occasionally stealing the
1685 * display status. But Xorg first sets the vt back to text mode using
1686 * the KDSET IOCTL with KD_TEXT, and only after that drops the master
1687 * status when exiting.
1689 * In the past this was caught by drm_fb_helper_lastclose(), but on
1690 * modern systems where logind always keeps a drm fd open to orchestrate
1691 * the vt switching, this doesn't work.
1693 * To not break the userspace ABI we have this special case here, which
1694 * is only used for the above case. Everything else uses the normal
1695 * commit function, which ensures that we never steal the display from
1696 * an active drm master.
1698 force = var->activate & FB_ACTIVATE_KD_TEXT;
1700 __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, force);
1704 EXPORT_SYMBOL(drm_fb_helper_set_par);
1706 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1708 struct drm_mode_set *mode_set;
1710 mutex_lock(&fb_helper->client.modeset_mutex);
1711 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1715 mutex_unlock(&fb_helper->client.modeset_mutex);
1718 static int pan_display_atomic(struct fb_var_screeninfo *var,
1719 struct fb_info *info)
1721 struct drm_fb_helper *fb_helper = info->par;
1724 pan_set(fb_helper, var->xoffset, var->yoffset);
1726 ret = drm_client_modeset_commit_locked(&fb_helper->client);
1728 info->var.xoffset = var->xoffset;
1729 info->var.yoffset = var->yoffset;
1731 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1736 static int pan_display_legacy(struct fb_var_screeninfo *var,
1737 struct fb_info *info)
1739 struct drm_fb_helper *fb_helper = info->par;
1740 struct drm_client_dev *client = &fb_helper->client;
1741 struct drm_mode_set *modeset;
1744 mutex_lock(&client->modeset_mutex);
1745 drm_modeset_lock_all(fb_helper->dev);
1746 drm_client_for_each_modeset(modeset, client) {
1747 modeset->x = var->xoffset;
1748 modeset->y = var->yoffset;
1750 if (modeset->num_connectors) {
1751 ret = drm_mode_set_config_internal(modeset);
1753 info->var.xoffset = var->xoffset;
1754 info->var.yoffset = var->yoffset;
1758 drm_modeset_unlock_all(fb_helper->dev);
1759 mutex_unlock(&client->modeset_mutex);
1765 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1766 * @var: updated screen information
1767 * @info: fbdev registered by the helper
1769 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1770 struct fb_info *info)
1772 struct drm_fb_helper *fb_helper = info->par;
1773 struct drm_device *dev = fb_helper->dev;
1776 if (oops_in_progress)
1779 mutex_lock(&fb_helper->lock);
1780 if (!drm_master_internal_acquire(dev)) {
1785 if (drm_drv_uses_atomic_modeset(dev))
1786 ret = pan_display_atomic(var, info);
1788 ret = pan_display_legacy(var, info);
1790 drm_master_internal_release(dev);
1792 mutex_unlock(&fb_helper->lock);
1796 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1799 * Allocates the backing storage and sets up the fbdev info structure through
1800 * the ->fb_probe callback.
1802 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1805 struct drm_client_dev *client = &fb_helper->client;
1806 struct drm_device *dev = fb_helper->dev;
1807 struct drm_mode_config *config = &dev->mode_config;
1810 struct drm_connector_list_iter conn_iter;
1811 struct drm_fb_helper_surface_size sizes;
1812 struct drm_connector *connector;
1813 struct drm_mode_set *mode_set;
1816 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1817 sizes.surface_depth = 24;
1818 sizes.surface_bpp = 32;
1819 sizes.fb_width = (u32)-1;
1820 sizes.fb_height = (u32)-1;
1823 * If driver picks 8 or 16 by default use that for both depth/bpp
1826 if (preferred_bpp != sizes.surface_bpp)
1827 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1829 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1830 drm_client_for_each_connector_iter(connector, &conn_iter) {
1831 struct drm_cmdline_mode *cmdline_mode;
1833 cmdline_mode = &connector->cmdline_mode;
1835 if (cmdline_mode->bpp_specified) {
1836 switch (cmdline_mode->bpp) {
1838 sizes.surface_depth = sizes.surface_bpp = 8;
1841 sizes.surface_depth = 15;
1842 sizes.surface_bpp = 16;
1845 sizes.surface_depth = sizes.surface_bpp = 16;
1848 sizes.surface_depth = sizes.surface_bpp = 24;
1851 sizes.surface_depth = 24;
1852 sizes.surface_bpp = 32;
1858 drm_connector_list_iter_end(&conn_iter);
1861 * If we run into a situation where, for example, the primary plane
1862 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1863 * 16) we need to scale down the depth of the sizes we request.
1865 mutex_lock(&client->modeset_mutex);
1866 drm_client_for_each_modeset(mode_set, client) {
1867 struct drm_crtc *crtc = mode_set->crtc;
1868 struct drm_plane *plane = crtc->primary;
1871 drm_dbg_kms(dev, "test CRTC %u primary plane\n", drm_crtc_index(crtc));
1873 for (j = 0; j < plane->format_count; j++) {
1874 const struct drm_format_info *fmt;
1876 fmt = drm_format_info(plane->format_types[j]);
1879 * Do not consider YUV or other complicated formats
1880 * for framebuffers. This means only legacy formats
1881 * are supported (fmt->depth is a legacy field) but
1882 * the framebuffer emulation can only deal with such
1883 * formats, specifically RGB/BGA formats.
1885 if (fmt->depth == 0)
1888 /* We found a perfect fit, great */
1889 if (fmt->depth == sizes.surface_depth) {
1890 best_depth = fmt->depth;
1894 /* Skip depths above what we're looking for */
1895 if (fmt->depth > sizes.surface_depth)
1898 /* Best depth found so far */
1899 if (fmt->depth > best_depth)
1900 best_depth = fmt->depth;
1903 if (sizes.surface_depth != best_depth && best_depth) {
1904 drm_info(dev, "requested bpp %d, scaled depth down to %d",
1905 sizes.surface_bpp, best_depth);
1906 sizes.surface_depth = best_depth;
1909 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1911 drm_client_for_each_modeset(mode_set, client) {
1912 struct drm_display_mode *desired_mode;
1914 /* in case of tile group, are we the last tile vert or horiz?
1915 * If no tile group you are always the last one both vertically
1918 bool lastv = true, lasth = true;
1920 desired_mode = mode_set->mode;
1930 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1931 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1933 for (j = 0; j < mode_set->num_connectors; j++) {
1934 struct drm_connector *connector = mode_set->connectors[j];
1936 if (connector->has_tile &&
1937 desired_mode->hdisplay == connector->tile_h_size &&
1938 desired_mode->vdisplay == connector->tile_v_size) {
1939 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1940 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1941 /* cloning to multiple tiles is just crazy-talk, so: */
1947 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1949 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1951 mutex_unlock(&client->modeset_mutex);
1953 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1954 drm_info(dev, "Cannot find any crtc or sizes\n");
1956 /* First time: disable all crtc's.. */
1957 if (!fb_helper->deferred_setup)
1958 drm_client_modeset_commit(client);
1962 /* Handle our overallocation */
1963 sizes.surface_height *= drm_fbdev_overalloc;
1964 sizes.surface_height /= 100;
1965 if (sizes.surface_height > config->max_height) {
1966 drm_dbg_kms(dev, "Fbdev over-allocation too large; clamping height to %d\n",
1967 config->max_height);
1968 sizes.surface_height = config->max_height;
1971 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1972 fb_helper->hint_leak_smem_start = drm_leak_fbdev_smem;
1975 /* push down into drivers */
1976 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1980 strcpy(fb_helper->fb->comm, "[fbcon]");
1984 static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1985 bool is_color_indexed)
1987 info->fix.type = FB_TYPE_PACKED_PIXELS;
1988 info->fix.visual = is_color_indexed ? FB_VISUAL_PSEUDOCOLOR
1989 : FB_VISUAL_TRUECOLOR;
1990 info->fix.mmio_start = 0;
1991 info->fix.mmio_len = 0;
1992 info->fix.type_aux = 0;
1993 info->fix.xpanstep = 1; /* doing it in hw */
1994 info->fix.ypanstep = 1; /* doing it in hw */
1995 info->fix.ywrapstep = 0;
1996 info->fix.accel = FB_ACCEL_NONE;
1998 info->fix.line_length = pitch;
2001 static void drm_fb_helper_fill_var(struct fb_info *info,
2002 struct drm_fb_helper *fb_helper,
2003 uint32_t fb_width, uint32_t fb_height)
2005 struct drm_framebuffer *fb = fb_helper->fb;
2006 const struct drm_format_info *format = fb->format;
2008 switch (format->format) {
2012 /* supported format with sub-byte pixels */
2016 WARN_ON((drm_format_info_block_width(format, 0) > 1) ||
2017 (drm_format_info_block_height(format, 0) > 1));
2021 info->pseudo_palette = fb_helper->pseudo_palette;
2022 info->var.xres_virtual = fb->width;
2023 info->var.yres_virtual = fb->height;
2024 info->var.bits_per_pixel = drm_format_info_bpp(format, 0);
2025 info->var.accel_flags = FB_ACCELF_TEXT;
2026 info->var.xoffset = 0;
2027 info->var.yoffset = 0;
2028 info->var.activate = FB_ACTIVATE_NOW;
2030 drm_fb_helper_fill_pixel_fmt(&info->var, format);
2032 info->var.xres = fb_width;
2033 info->var.yres = fb_height;
2037 * drm_fb_helper_fill_info - initializes fbdev information
2038 * @info: fbdev instance to set up
2039 * @fb_helper: fb helper instance to use as template
2040 * @sizes: describes fbdev size and scanout surface size
2042 * Sets up the variable and fixed fbdev metainformation from the given fb helper
2043 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
2045 * Drivers should call this (or their equivalent setup code) from their
2046 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
2047 * backing storage framebuffer.
2049 void drm_fb_helper_fill_info(struct fb_info *info,
2050 struct drm_fb_helper *fb_helper,
2051 struct drm_fb_helper_surface_size *sizes)
2053 struct drm_framebuffer *fb = fb_helper->fb;
2055 drm_fb_helper_fill_fix(info, fb->pitches[0],
2056 fb->format->is_color_indexed);
2057 drm_fb_helper_fill_var(info, fb_helper,
2058 sizes->fb_width, sizes->fb_height);
2060 info->par = fb_helper;
2062 * The DRM drivers fbdev emulation device name can be confusing if the
2063 * driver name also has a "drm" suffix on it. Leading to names such as
2064 * "simpledrmdrmfb" in /proc/fb. Unfortunately, it's an uAPI and can't
2065 * be changed due user-space tools (e.g: pm-utils) matching against it.
2067 snprintf(info->fix.id, sizeof(info->fix.id), "%sdrmfb",
2068 fb_helper->dev->driver->name);
2071 EXPORT_SYMBOL(drm_fb_helper_fill_info);
2074 * This is a continuation of drm_setup_crtcs() that sets up anything related
2075 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2076 * the framebuffer has been allocated (fb_helper->fb and fb_helper->info).
2077 * So, any setup that touches those fields needs to be done here instead of in
2078 * drm_setup_crtcs().
2080 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
2082 struct drm_client_dev *client = &fb_helper->client;
2083 struct drm_connector_list_iter conn_iter;
2084 struct fb_info *info = fb_helper->info;
2085 unsigned int rotation, sw_rotations = 0;
2086 struct drm_connector *connector;
2087 struct drm_mode_set *modeset;
2089 mutex_lock(&client->modeset_mutex);
2090 drm_client_for_each_modeset(modeset, client) {
2091 if (!modeset->num_connectors)
2094 modeset->fb = fb_helper->fb;
2096 if (drm_client_rotation(modeset, &rotation))
2097 /* Rotating in hardware, fbcon should not rotate */
2098 sw_rotations |= DRM_MODE_ROTATE_0;
2100 sw_rotations |= rotation;
2102 mutex_unlock(&client->modeset_mutex);
2104 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
2105 drm_client_for_each_connector_iter(connector, &conn_iter) {
2107 /* use first connected connector for the physical dimensions */
2108 if (connector->status == connector_status_connected) {
2109 info->var.width = connector->display_info.width_mm;
2110 info->var.height = connector->display_info.height_mm;
2114 drm_connector_list_iter_end(&conn_iter);
2116 switch (sw_rotations) {
2117 case DRM_MODE_ROTATE_0:
2118 info->fbcon_rotate_hint = FB_ROTATE_UR;
2120 case DRM_MODE_ROTATE_90:
2121 info->fbcon_rotate_hint = FB_ROTATE_CCW;
2123 case DRM_MODE_ROTATE_180:
2124 info->fbcon_rotate_hint = FB_ROTATE_UD;
2126 case DRM_MODE_ROTATE_270:
2127 info->fbcon_rotate_hint = FB_ROTATE_CW;
2131 * Multiple bits are set / multiple rotations requested
2132 * fbcon cannot handle separate rotation settings per
2133 * output, so fallback to unrotated.
2135 info->fbcon_rotate_hint = FB_ROTATE_UR;
2139 /* Note: Drops fb_helper->lock before returning. */
2141 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
2144 struct drm_device *dev = fb_helper->dev;
2145 struct fb_info *info;
2146 unsigned int width, height;
2149 width = dev->mode_config.max_width;
2150 height = dev->mode_config.max_height;
2152 drm_client_modeset_probe(&fb_helper->client, width, height);
2153 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2155 if (ret == -EAGAIN) {
2156 fb_helper->preferred_bpp = bpp_sel;
2157 fb_helper->deferred_setup = true;
2160 mutex_unlock(&fb_helper->lock);
2164 drm_setup_crtcs_fb(fb_helper);
2166 fb_helper->deferred_setup = false;
2168 info = fb_helper->info;
2169 info->var.pixclock = 0;
2170 /* Shamelessly allow physical address leaking to userspace */
2171 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2172 if (!fb_helper->hint_leak_smem_start)
2174 /* don't leak any physical addresses to userspace */
2175 info->flags |= FBINFO_HIDE_SMEM_START;
2177 /* Need to drop locks to avoid recursive deadlock in
2178 * register_framebuffer. This is ok because the only thing left to do is
2179 * register the fbdev emulation instance in kernel_fb_helper_list. */
2180 mutex_unlock(&fb_helper->lock);
2182 ret = register_framebuffer(info);
2186 drm_info(dev, "fb%d: %s frame buffer device\n",
2187 info->node, info->fix.id);
2189 mutex_lock(&kernel_fb_helper_lock);
2190 if (list_empty(&kernel_fb_helper_list))
2191 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2193 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2194 mutex_unlock(&kernel_fb_helper_lock);
2200 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2201 * @fb_helper: fb_helper device struct
2202 * @bpp_sel: bpp value to use for the framebuffer configuration
2204 * Scans the CRTCs and connectors and tries to put together an initial setup.
2205 * At the moment, this is a cloned configuration across all heads with
2206 * a new framebuffer object as the backing store.
2208 * Note that this also registers the fbdev and so allows userspace to call into
2209 * the driver through the fbdev interfaces.
2211 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2212 * to let the driver allocate and initialize the fbdev info structure and the
2213 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
2214 * as a helper to setup simple default values for the fbdev info structure.
2218 * When you have fbcon support built-in or already loaded, this function will do
2219 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2220 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2221 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2222 * to consoles, not even serial console. This means when your driver crashes,
2223 * you will see absolutely nothing else but a system stuck in this function,
2224 * with no further output. Any kind of printk() you place within your own driver
2225 * or in the drm core modeset code will also never show up.
2227 * Standard debug practice is to run the fbcon setup without taking the
2228 * console_lock as a hack, to be able to see backtraces and crashes on the
2229 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2232 * The other option is to just disable fbdev emulation since very likely the
2233 * first modeset from userspace will crash in the same way, and is even easier
2234 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2235 * kernel cmdline option.
2238 * Zero if everything went ok, nonzero otherwise.
2240 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2244 if (!drm_fbdev_emulation)
2247 mutex_lock(&fb_helper->lock);
2248 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
2252 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2255 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2256 * probing all the outputs attached to the fb
2257 * @fb_helper: driver-allocated fbdev helper, can be NULL
2259 * Scan the connectors attached to the fb_helper and try to put together a
2260 * setup after notification of a change in output configuration.
2262 * Called at runtime, takes the mode config locks to be able to check/change the
2263 * modeset configuration. Must be run from process context (which usually means
2264 * either the output polling work or a work item launched from the driver's
2265 * hotplug interrupt).
2267 * Note that drivers may call this even before calling
2268 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2269 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2270 * not miss any hotplug events.
2273 * 0 on success and a non-zero error code otherwise.
2275 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2279 if (!drm_fbdev_emulation || !fb_helper)
2282 mutex_lock(&fb_helper->lock);
2283 if (fb_helper->deferred_setup) {
2284 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
2285 fb_helper->preferred_bpp);
2289 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
2290 fb_helper->delayed_hotplug = true;
2291 mutex_unlock(&fb_helper->lock);
2295 drm_master_internal_release(fb_helper->dev);
2297 drm_dbg_kms(fb_helper->dev, "\n");
2299 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
2300 drm_setup_crtcs_fb(fb_helper);
2301 mutex_unlock(&fb_helper->lock);
2303 drm_fb_helper_set_par(fb_helper->info);
2307 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2310 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2313 * This function can be used as the &drm_driver->lastclose callback for drivers
2314 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2316 void drm_fb_helper_lastclose(struct drm_device *dev)
2318 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2320 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2323 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2324 * helper for fbdev emulation
2327 * This function can be used as the
2328 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2329 * need to call drm_fb_helper_hotplug_event().
2331 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2333 drm_fb_helper_hotplug_event(dev->fb_helper);
2335 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2337 static bool drm_fbdev_use_shadow_fb(struct drm_fb_helper *fb_helper)
2339 struct drm_device *dev = fb_helper->dev;
2340 struct drm_framebuffer *fb = fb_helper->fb;
2342 return dev->mode_config.prefer_shadow_fbdev ||
2343 dev->mode_config.prefer_shadow ||
2347 /* @user: 1=userspace, 0=fbcon */
2348 static int drm_fbdev_fb_open(struct fb_info *info, int user)
2350 struct drm_fb_helper *fb_helper = info->par;
2352 /* No need to take a ref for fbcon because it unbinds on unregister */
2353 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
2359 static int drm_fbdev_fb_release(struct fb_info *info, int user)
2361 struct drm_fb_helper *fb_helper = info->par;
2364 module_put(fb_helper->dev->driver->fops->owner);
2369 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
2371 struct fb_info *fbi = fb_helper->info;
2372 void *shadow = NULL;
2374 if (!fb_helper->dev)
2379 fb_deferred_io_cleanup(fbi);
2380 if (drm_fbdev_use_shadow_fb(fb_helper))
2381 shadow = fbi->screen_buffer;
2384 drm_fb_helper_fini(fb_helper);
2388 else if (fb_helper->buffer)
2389 drm_client_buffer_vunmap(fb_helper->buffer);
2391 drm_client_framebuffer_delete(fb_helper->buffer);
2394 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
2396 drm_fbdev_cleanup(fb_helper);
2397 drm_client_release(&fb_helper->client);
2402 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2403 * unregister_framebuffer() or fb_release().
2405 static void drm_fbdev_fb_destroy(struct fb_info *info)
2407 drm_fbdev_release(info->par);
2410 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
2412 struct drm_fb_helper *fb_helper = info->par;
2414 if (drm_fbdev_use_shadow_fb(fb_helper))
2415 return fb_deferred_io_mmap(info, vma);
2416 else if (fb_helper->dev->driver->gem_prime_mmap)
2417 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2422 static bool drm_fbdev_use_iomem(struct fb_info *info)
2424 struct drm_fb_helper *fb_helper = info->par;
2425 struct drm_client_buffer *buffer = fb_helper->buffer;
2427 return !drm_fbdev_use_shadow_fb(fb_helper) && buffer->map.is_iomem;
2430 static ssize_t drm_fbdev_fb_read(struct fb_info *info, char __user *buf,
2431 size_t count, loff_t *ppos)
2435 if (drm_fbdev_use_iomem(info))
2436 ret = drm_fb_helper_cfb_read(info, buf, count, ppos);
2438 ret = drm_fb_helper_sys_read(info, buf, count, ppos);
2443 static ssize_t drm_fbdev_fb_write(struct fb_info *info, const char __user *buf,
2444 size_t count, loff_t *ppos)
2448 if (drm_fbdev_use_iomem(info))
2449 ret = drm_fb_helper_cfb_write(info, buf, count, ppos);
2451 ret = drm_fb_helper_sys_write(info, buf, count, ppos);
2456 static void drm_fbdev_fb_fillrect(struct fb_info *info,
2457 const struct fb_fillrect *rect)
2459 if (drm_fbdev_use_iomem(info))
2460 drm_fb_helper_cfb_fillrect(info, rect);
2462 drm_fb_helper_sys_fillrect(info, rect);
2465 static void drm_fbdev_fb_copyarea(struct fb_info *info,
2466 const struct fb_copyarea *area)
2468 if (drm_fbdev_use_iomem(info))
2469 drm_fb_helper_cfb_copyarea(info, area);
2471 drm_fb_helper_sys_copyarea(info, area);
2474 static void drm_fbdev_fb_imageblit(struct fb_info *info,
2475 const struct fb_image *image)
2477 if (drm_fbdev_use_iomem(info))
2478 drm_fb_helper_cfb_imageblit(info, image);
2480 drm_fb_helper_sys_imageblit(info, image);
2483 static const struct fb_ops drm_fbdev_fb_ops = {
2484 .owner = THIS_MODULE,
2485 DRM_FB_HELPER_DEFAULT_OPS,
2486 .fb_open = drm_fbdev_fb_open,
2487 .fb_release = drm_fbdev_fb_release,
2488 .fb_destroy = drm_fbdev_fb_destroy,
2489 .fb_mmap = drm_fbdev_fb_mmap,
2490 .fb_read = drm_fbdev_fb_read,
2491 .fb_write = drm_fbdev_fb_write,
2492 .fb_fillrect = drm_fbdev_fb_fillrect,
2493 .fb_copyarea = drm_fbdev_fb_copyarea,
2494 .fb_imageblit = drm_fbdev_fb_imageblit,
2497 static struct fb_deferred_io drm_fbdev_defio = {
2499 .deferred_io = drm_fb_helper_deferred_io,
2503 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2505 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2506 * fb_copyarea, fb_imageblit.
2508 static int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2509 struct drm_fb_helper_surface_size *sizes)
2511 struct drm_client_dev *client = &fb_helper->client;
2512 struct drm_device *dev = fb_helper->dev;
2513 struct drm_client_buffer *buffer;
2514 struct drm_framebuffer *fb;
2515 struct fb_info *fbi;
2517 struct iosys_map map;
2520 drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n",
2521 sizes->surface_width, sizes->surface_height,
2522 sizes->surface_bpp);
2524 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2525 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2526 sizes->surface_height, format);
2528 return PTR_ERR(buffer);
2530 fb_helper->buffer = buffer;
2531 fb_helper->fb = buffer->fb;
2534 fbi = drm_fb_helper_alloc_info(fb_helper);
2536 return PTR_ERR(fbi);
2538 fbi->fbops = &drm_fbdev_fb_ops;
2539 fbi->screen_size = sizes->surface_height * fb->pitches[0];
2540 fbi->fix.smem_len = fbi->screen_size;
2541 fbi->flags = FBINFO_DEFAULT;
2543 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2545 if (drm_fbdev_use_shadow_fb(fb_helper)) {
2546 fbi->screen_buffer = vzalloc(fbi->screen_size);
2547 if (!fbi->screen_buffer)
2549 fbi->flags |= FBINFO_VIRTFB | FBINFO_READS_FAST;
2551 fbi->fbdefio = &drm_fbdev_defio;
2552 fb_deferred_io_init(fbi);
2554 /* buffer is mapped for HW framebuffer */
2555 ret = drm_client_buffer_vmap(fb_helper->buffer, &map);
2559 fbi->screen_base = map.vaddr_iomem;
2561 fbi->screen_buffer = map.vaddr;
2562 fbi->flags |= FBINFO_VIRTFB;
2566 * Shamelessly leak the physical address to user-space. As
2567 * page_to_phys() is undefined for I/O memory, warn in this
2570 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2571 if (fb_helper->hint_leak_smem_start && fbi->fix.smem_start == 0 &&
2572 !drm_WARN_ON_ONCE(dev, map.is_iomem))
2573 fbi->fix.smem_start =
2574 page_to_phys(virt_to_page(fbi->screen_buffer));
2581 static int drm_fbdev_fb_dirty(struct drm_fb_helper *helper, struct drm_clip_rect *clip)
2583 struct drm_device *dev = helper->dev;
2586 if (!drm_fbdev_use_shadow_fb(helper))
2589 /* Call damage handlers only if necessary */
2590 if (!(clip->x1 < clip->x2 && clip->y1 < clip->y2))
2593 if (helper->buffer) {
2594 ret = drm_fb_helper_damage_blit(helper, clip);
2595 if (drm_WARN_ONCE(dev, ret, "Damage blitter failed: ret=%d\n", ret))
2599 if (helper->fb->funcs->dirty) {
2600 ret = helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, clip, 1);
2601 if (drm_WARN_ONCE(dev, ret, "Dirty helper failed: ret=%d\n", ret))
2608 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2609 .fb_probe = drm_fb_helper_generic_probe,
2610 .fb_dirty = drm_fbdev_fb_dirty,
2613 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2615 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2617 if (fb_helper->info)
2618 /* drm_fbdev_fb_destroy() takes care of cleanup */
2619 drm_fb_helper_unregister_info(fb_helper);
2621 drm_fbdev_release(fb_helper);
2624 static int drm_fbdev_client_restore(struct drm_client_dev *client)
2626 drm_fb_helper_lastclose(client->dev);
2631 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2633 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2634 struct drm_device *dev = client->dev;
2637 /* Setup is not retried if it has failed */
2638 if (!fb_helper->dev && fb_helper->funcs)
2642 return drm_fb_helper_hotplug_event(dev->fb_helper);
2644 if (!dev->mode_config.num_connector) {
2645 drm_dbg_kms(dev, "No connectors found, will not create framebuffer!\n");
2649 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2651 ret = drm_fb_helper_init(dev, fb_helper);
2655 if (!drm_drv_uses_atomic_modeset(dev))
2656 drm_helper_disable_unused_functions(dev);
2658 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2665 drm_fbdev_cleanup(fb_helper);
2667 fb_helper->dev = NULL;
2668 fb_helper->info = NULL;
2670 drm_err(dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2675 static const struct drm_client_funcs drm_fbdev_client_funcs = {
2676 .owner = THIS_MODULE,
2677 .unregister = drm_fbdev_client_unregister,
2678 .restore = drm_fbdev_client_restore,
2679 .hotplug = drm_fbdev_client_hotplug,
2683 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2685 * @preferred_bpp: Preferred bits per pixel for the device.
2686 * @dev->mode_config.preferred_depth is used if this is zero.
2688 * This function sets up generic fbdev emulation for drivers that supports
2689 * dumb buffers with a virtual address and that can be mmap'ed.
2690 * drm_fbdev_generic_setup() shall be called after the DRM driver registered
2691 * the new DRM device with drm_dev_register().
2693 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2694 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2695 * Simple drivers might use drm_mode_config_helper_suspend().
2697 * Drivers that set the dirty callback on their framebuffer will get a shadow
2698 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2699 * make deferred I/O work with all kinds of buffers. A shadow buffer can be
2700 * requested explicitly by setting struct drm_mode_config.prefer_shadow or
2701 * struct drm_mode_config.prefer_shadow_fbdev to true beforehand. This is
2702 * required to use generic fbdev emulation with SHMEM helpers.
2704 * This function is safe to call even when there are no connectors present.
2705 * Setup will be retried on the next hotplug event.
2707 * The fbdev is destroyed by drm_dev_unregister().
2709 void drm_fbdev_generic_setup(struct drm_device *dev,
2710 unsigned int preferred_bpp)
2712 struct drm_fb_helper *fb_helper;
2715 drm_WARN(dev, !dev->registered, "Device has not been registered.\n");
2716 drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n");
2718 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2720 drm_err(dev, "Failed to allocate fb_helper\n");
2724 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2727 drm_err(dev, "Failed to register client: %d\n", ret);
2732 * FIXME: This mixes up depth with bpp, which results in a glorious
2733 * mess, resulting in some drivers picking wrong fbdev defaults and
2734 * others wrong preferred_depth defaults.
2737 preferred_bpp = dev->mode_config.preferred_depth;
2740 fb_helper->preferred_bpp = preferred_bpp;
2742 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2744 drm_dbg_kms(dev, "client hotplug ret=%d\n", ret);
2746 drm_client_register(&fb_helper->client);
2748 EXPORT_SYMBOL(drm_fbdev_generic_setup);