1 // SPDX-License-Identifier: GPL-2.0
3 * Framebuffer driver for EFI/UEFI based system
5 * (c) 2006 Edgar Hucek <gimli@dark-green.com>
6 * Original efi driver written by Gerd Knorr <kraxel@goldbach.in-berlin.de>
10 #include <linux/kernel.h>
11 #include <linux/efi.h>
12 #include <linux/efi-bgrt.h>
13 #include <linux/errno.h>
15 #include <linux/pci.h>
16 #include <linux/platform_device.h>
17 #include <linux/printk.h>
18 #include <linux/screen_info.h>
19 #include <video/vga.h>
21 #include <drm/drm_utils.h> /* For drm_get_panel_orientation_quirk */
22 #include <drm/drm_connector.h> /* For DRM_MODE_PANEL_ORIENTATION_* */
24 struct bmp_file_header {
31 struct bmp_dib_header {
45 static bool use_bgrt = true;
46 static bool request_mem_succeeded = false;
47 static u64 mem_flags = EFI_MEMORY_WC | EFI_MEMORY_UC;
49 static struct fb_var_screeninfo efifb_defined = {
50 .activate = FB_ACTIVATE_NOW,
57 .vmode = FB_VMODE_NONINTERLACED,
60 static struct fb_fix_screeninfo efifb_fix = {
62 .type = FB_TYPE_PACKED_PIXELS,
63 .accel = FB_ACCEL_NONE,
64 .visual = FB_VISUAL_TRUECOLOR,
67 static int efifb_setcolreg(unsigned regno, unsigned red, unsigned green,
68 unsigned blue, unsigned transp,
72 * Set a single color register. The values supplied are
73 * already rounded down to the hardware's capabilities
74 * (according to the entries in the `var' structure). Return
75 * != 0 for invalid regno.
78 if (regno >= info->cmap.len)
82 red >>= 16 - info->var.red.length;
83 green >>= 16 - info->var.green.length;
84 blue >>= 16 - info->var.blue.length;
85 ((u32 *)(info->pseudo_palette))[regno] =
86 (red << info->var.red.offset) |
87 (green << info->var.green.offset) |
88 (blue << info->var.blue.offset);
94 * If fbcon deffered console takeover is configured, the intent is for the
95 * framebuffer to show the boot graphics (e.g. vendor logo) until there is some
96 * (error) message to display. But the boot graphics may have been destroyed by
97 * e.g. option ROM output, detect this and restore the boot graphics.
99 #if defined CONFIG_FRAMEBUFFER_CONSOLE_DEFERRED_TAKEOVER && \
100 defined CONFIG_ACPI_BGRT
101 static void efifb_copy_bmp(u8 *src, u32 *dst, int width, struct screen_info *si)
109 *dst++ = (r << si->red_pos) |
110 (g << si->green_pos) |
117 * On x86 some firmwares use a low non native resolution for the display when
118 * they have shown some text messages. While keeping the bgrt filled with info
119 * for the native resolution. If the bgrt image intended for the native
120 * resolution still fits, it will be displayed very close to the right edge of
121 * the display looking quite bad. This function checks for this.
123 static bool efifb_bgrt_sanity_check(struct screen_info *si, u32 bmp_width)
126 * All x86 firmwares horizontally center the image (the yoffset
127 * calculations differ between boards, but xoffset is predictable).
129 u32 expected_xoffset = (si->lfb_width - bmp_width) / 2;
131 return bgrt_tab.image_offset_x == expected_xoffset;
134 static bool efifb_bgrt_sanity_check(struct screen_info *si, u32 bmp_width)
140 static void efifb_show_boot_graphics(struct fb_info *info)
142 u32 bmp_width, bmp_height, bmp_pitch, screen_pitch, dst_x, y, src_y;
143 struct screen_info *si = &screen_info;
144 struct bmp_file_header *file_header;
145 struct bmp_dib_header *dib_header;
146 void *bgrt_image = NULL;
147 u8 *dst = info->screen_base;
152 if (!bgrt_tab.image_address) {
153 pr_info("efifb: No BGRT, not showing boot graphics\n");
157 /* Avoid flashing the logo if we're going to print std probe messages */
158 if (console_loglevel > CONSOLE_LOGLEVEL_QUIET)
161 /* bgrt_tab.status is unreliable, so we don't check it */
163 if (si->lfb_depth != 32) {
164 pr_info("efifb: not 32 bits, not showing boot graphics\n");
168 bgrt_image = memremap(bgrt_tab.image_address, bgrt_image_size,
171 pr_warn("efifb: Ignoring BGRT: failed to map image memory\n");
175 if (bgrt_image_size < (sizeof(*file_header) + sizeof(*dib_header)))
178 file_header = bgrt_image;
179 if (file_header->id != 0x4d42 || file_header->reserved != 0)
182 dib_header = bgrt_image + sizeof(*file_header);
183 if (dib_header->dib_header_size != 40 || dib_header->width < 0 ||
184 dib_header->planes != 1 || dib_header->bpp != 24 ||
185 dib_header->compression != 0)
188 bmp_width = dib_header->width;
189 bmp_height = abs(dib_header->height);
190 bmp_pitch = round_up(3 * bmp_width, 4);
191 screen_pitch = si->lfb_linelength;
193 if ((file_header->bitmap_offset + bmp_pitch * bmp_height) >
197 if ((bgrt_tab.image_offset_x + bmp_width) > si->lfb_width ||
198 (bgrt_tab.image_offset_y + bmp_height) > si->lfb_height)
201 if (!efifb_bgrt_sanity_check(si, bmp_width))
204 pr_info("efifb: showing boot graphics\n");
206 for (y = 0; y < si->lfb_height; y++, dst += si->lfb_linelength) {
207 /* Only background? */
208 if (y < bgrt_tab.image_offset_y ||
209 y >= (bgrt_tab.image_offset_y + bmp_height)) {
210 memset(dst, 0, 4 * si->lfb_width);
214 src_y = y - bgrt_tab.image_offset_y;
215 /* Positive header height means upside down row order */
216 if (dib_header->height > 0)
217 src_y = (bmp_height - 1) - src_y;
219 memset(dst, 0, bgrt_tab.image_offset_x * 4);
220 dst_x = bgrt_tab.image_offset_x;
221 efifb_copy_bmp(bgrt_image + file_header->bitmap_offset +
223 (u32 *)dst + dst_x, bmp_width, si);
225 memset((u32 *)dst + dst_x, 0, (si->lfb_width - dst_x) * 4);
228 memunmap(bgrt_image);
232 memunmap(bgrt_image);
233 pr_warn("efifb: Ignoring BGRT: unexpected or invalid BMP data\n");
236 static inline void efifb_show_boot_graphics(struct fb_info *info) {}
239 static void efifb_destroy(struct fb_info *info)
241 if (info->screen_base) {
242 if (mem_flags & (EFI_MEMORY_UC | EFI_MEMORY_WC))
243 iounmap(info->screen_base);
245 memunmap(info->screen_base);
247 if (request_mem_succeeded)
248 release_mem_region(info->apertures->ranges[0].base,
249 info->apertures->ranges[0].size);
250 fb_dealloc_cmap(&info->cmap);
253 static struct fb_ops efifb_ops = {
254 .owner = THIS_MODULE,
255 .fb_destroy = efifb_destroy,
256 .fb_setcolreg = efifb_setcolreg,
257 .fb_fillrect = cfb_fillrect,
258 .fb_copyarea = cfb_copyarea,
259 .fb_imageblit = cfb_imageblit,
262 static int efifb_setup(char *options)
266 if (options && *options) {
267 while ((this_opt = strsep(&options, ",")) != NULL) {
268 if (!*this_opt) continue;
270 efifb_setup_from_dmi(&screen_info, this_opt);
272 if (!strncmp(this_opt, "base:", 5))
273 screen_info.lfb_base = simple_strtoul(this_opt+5, NULL, 0);
274 else if (!strncmp(this_opt, "stride:", 7))
275 screen_info.lfb_linelength = simple_strtoul(this_opt+7, NULL, 0) * 4;
276 else if (!strncmp(this_opt, "height:", 7))
277 screen_info.lfb_height = simple_strtoul(this_opt+7, NULL, 0);
278 else if (!strncmp(this_opt, "width:", 6))
279 screen_info.lfb_width = simple_strtoul(this_opt+6, NULL, 0);
280 else if (!strcmp(this_opt, "nowc"))
281 mem_flags &= ~EFI_MEMORY_WC;
282 else if (!strcmp(this_opt, "nobgrt"))
290 static inline bool fb_base_is_valid(void)
292 if (screen_info.lfb_base)
295 if (!(screen_info.capabilities & VIDEO_CAPABILITY_64BIT_BASE))
298 if (screen_info.ext_lfb_base)
304 #define efifb_attr_decl(name, fmt) \
305 static ssize_t name##_show(struct device *dev, \
306 struct device_attribute *attr, \
309 return sprintf(buf, fmt "\n", (screen_info.lfb_##name)); \
311 static DEVICE_ATTR_RO(name)
313 efifb_attr_decl(base, "0x%x");
314 efifb_attr_decl(linelength, "%u");
315 efifb_attr_decl(height, "%u");
316 efifb_attr_decl(width, "%u");
317 efifb_attr_decl(depth, "%u");
319 static struct attribute *efifb_attrs[] = {
321 &dev_attr_linelength.attr,
322 &dev_attr_width.attr,
323 &dev_attr_height.attr,
324 &dev_attr_depth.attr,
327 ATTRIBUTE_GROUPS(efifb);
329 static bool pci_dev_disabled; /* FB base matches BAR of a disabled device */
331 static struct pci_dev *efifb_pci_dev; /* dev with BAR covering the efifb */
332 static struct resource *bar_resource;
333 static u64 bar_offset;
335 static int efifb_probe(struct platform_device *dev)
337 struct fb_info *info;
338 int err, orientation;
339 unsigned int size_vmode;
340 unsigned int size_remap;
341 unsigned int size_total;
343 efi_memory_desc_t md;
345 if (screen_info.orig_video_isVGA != VIDEO_TYPE_EFI || pci_dev_disabled)
348 if (fb_get_options("efifb", &option))
352 /* We don't get linelength from UGA Draw Protocol, only from
353 * EFI Graphics Protocol. So if it's not in DMI, and it's not
354 * passed in from the user, we really can't use the framebuffer.
356 if (!screen_info.lfb_linelength)
359 if (!screen_info.lfb_depth)
360 screen_info.lfb_depth = 32;
361 if (!screen_info.pages)
362 screen_info.pages = 1;
363 if (!fb_base_is_valid()) {
364 printk(KERN_DEBUG "efifb: invalid framebuffer address\n");
367 printk(KERN_INFO "efifb: probing for efifb\n");
369 /* just assume they're all unset if any are */
370 if (!screen_info.blue_size) {
371 screen_info.blue_size = 8;
372 screen_info.blue_pos = 0;
373 screen_info.green_size = 8;
374 screen_info.green_pos = 8;
375 screen_info.red_size = 8;
376 screen_info.red_pos = 16;
377 screen_info.rsvd_size = 8;
378 screen_info.rsvd_pos = 24;
381 efifb_fix.smem_start = screen_info.lfb_base;
383 if (screen_info.capabilities & VIDEO_CAPABILITY_64BIT_BASE) {
386 ext_lfb_base = (u64)(unsigned long)screen_info.ext_lfb_base << 32;
387 efifb_fix.smem_start |= ext_lfb_base;
391 bar_resource->start + bar_offset != efifb_fix.smem_start) {
392 dev_info(&efifb_pci_dev->dev,
393 "BAR has moved, updating efifb address\n");
394 efifb_fix.smem_start = bar_resource->start + bar_offset;
397 efifb_defined.bits_per_pixel = screen_info.lfb_depth;
398 efifb_defined.xres = screen_info.lfb_width;
399 efifb_defined.yres = screen_info.lfb_height;
400 efifb_fix.line_length = screen_info.lfb_linelength;
402 /* size_vmode -- that is the amount of memory needed for the
403 * used video mode, i.e. the minimum amount of
405 size_vmode = efifb_defined.yres * efifb_fix.line_length;
407 /* size_total -- all video memory we have. Used for
408 * entries, ressource allocation and bounds
410 size_total = screen_info.lfb_size;
411 if (size_total < size_vmode)
412 size_total = size_vmode;
414 /* size_remap -- the amount of video memory we are going to
415 * use for efifb. With modern cards it is no
416 * option to simply use size_total as that
417 * wastes plenty of kernel address space. */
418 size_remap = size_vmode * 2;
419 if (size_remap > size_total)
420 size_remap = size_total;
421 if (size_remap % PAGE_SIZE)
422 size_remap += PAGE_SIZE - (size_remap % PAGE_SIZE);
423 efifb_fix.smem_len = size_remap;
425 if (request_mem_region(efifb_fix.smem_start, size_remap, "efifb")) {
426 request_mem_succeeded = true;
428 /* We cannot make this fatal. Sometimes this comes from magic
429 spaces our resource handlers simply don't know about */
430 pr_warn("efifb: cannot reserve video memory at 0x%lx\n",
431 efifb_fix.smem_start);
434 info = framebuffer_alloc(sizeof(u32) * 16, &dev->dev);
436 pr_err("efifb: cannot allocate framebuffer\n");
438 goto err_release_mem;
440 platform_set_drvdata(dev, info);
441 info->pseudo_palette = info->par;
444 info->apertures = alloc_apertures(1);
445 if (!info->apertures) {
449 info->apertures->ranges[0].base = efifb_fix.smem_start;
450 info->apertures->ranges[0].size = size_remap;
452 if (efi_enabled(EFI_MEMMAP) &&
453 !efi_mem_desc_lookup(efifb_fix.smem_start, &md)) {
454 if ((efifb_fix.smem_start + efifb_fix.smem_len) >
455 (md.phys_addr + (md.num_pages << EFI_PAGE_SHIFT))) {
456 pr_err("efifb: video memory @ 0x%lx spans multiple EFI memory regions\n",
457 efifb_fix.smem_start);
462 * If the UEFI memory map covers the efifb region, we may only
463 * remap it using the attributes the memory map prescribes.
465 md.attribute &= EFI_MEMORY_UC | EFI_MEMORY_WC |
466 EFI_MEMORY_WT | EFI_MEMORY_WB;
468 mem_flags |= EFI_MEMORY_WT | EFI_MEMORY_WB;
469 mem_flags &= md.attribute;
472 if (mem_flags & EFI_MEMORY_WC)
473 info->screen_base = ioremap_wc(efifb_fix.smem_start,
475 else if (mem_flags & EFI_MEMORY_UC)
476 info->screen_base = ioremap(efifb_fix.smem_start,
478 else if (mem_flags & EFI_MEMORY_WT)
479 info->screen_base = memremap(efifb_fix.smem_start,
480 efifb_fix.smem_len, MEMREMAP_WT);
481 else if (mem_flags & EFI_MEMORY_WB)
482 info->screen_base = memremap(efifb_fix.smem_start,
483 efifb_fix.smem_len, MEMREMAP_WB);
484 if (!info->screen_base) {
485 pr_err("efifb: abort, cannot remap video memory 0x%x @ 0x%lx\n",
486 efifb_fix.smem_len, efifb_fix.smem_start);
491 efifb_show_boot_graphics(info);
493 pr_info("efifb: framebuffer at 0x%lx, using %dk, total %dk\n",
494 efifb_fix.smem_start, size_remap/1024, size_total/1024);
495 pr_info("efifb: mode is %dx%dx%d, linelength=%d, pages=%d\n",
496 efifb_defined.xres, efifb_defined.yres,
497 efifb_defined.bits_per_pixel, efifb_fix.line_length,
500 efifb_defined.xres_virtual = efifb_defined.xres;
501 efifb_defined.yres_virtual = efifb_fix.smem_len /
502 efifb_fix.line_length;
503 pr_info("efifb: scrolling: redraw\n");
504 efifb_defined.yres_virtual = efifb_defined.yres;
506 /* some dummy values for timing to make fbset happy */
507 efifb_defined.pixclock = 10000000 / efifb_defined.xres *
508 1000 / efifb_defined.yres;
509 efifb_defined.left_margin = (efifb_defined.xres / 8) & 0xf8;
510 efifb_defined.hsync_len = (efifb_defined.xres / 8) & 0xf8;
512 efifb_defined.red.offset = screen_info.red_pos;
513 efifb_defined.red.length = screen_info.red_size;
514 efifb_defined.green.offset = screen_info.green_pos;
515 efifb_defined.green.length = screen_info.green_size;
516 efifb_defined.blue.offset = screen_info.blue_pos;
517 efifb_defined.blue.length = screen_info.blue_size;
518 efifb_defined.transp.offset = screen_info.rsvd_pos;
519 efifb_defined.transp.length = screen_info.rsvd_size;
521 pr_info("efifb: %s: "
522 "size=%d:%d:%d:%d, shift=%d:%d:%d:%d\n",
524 screen_info.rsvd_size,
525 screen_info.red_size,
526 screen_info.green_size,
527 screen_info.blue_size,
528 screen_info.rsvd_pos,
530 screen_info.green_pos,
531 screen_info.blue_pos);
533 efifb_fix.ypanstep = 0;
534 efifb_fix.ywrapstep = 0;
536 info->fbops = &efifb_ops;
537 info->var = efifb_defined;
538 info->fix = efifb_fix;
539 info->flags = FBINFO_FLAG_DEFAULT | FBINFO_MISC_FIRMWARE;
541 orientation = drm_get_panel_orientation_quirk(efifb_defined.xres,
543 switch (orientation) {
545 info->fbcon_rotate_hint = FB_ROTATE_UR;
547 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP:
548 info->fbcon_rotate_hint = FB_ROTATE_UD;
550 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP:
551 info->fbcon_rotate_hint = FB_ROTATE_CCW;
553 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP:
554 info->fbcon_rotate_hint = FB_ROTATE_CW;
558 err = sysfs_create_groups(&dev->dev.kobj, efifb_groups);
560 pr_err("efifb: cannot add sysfs attrs\n");
563 err = fb_alloc_cmap(&info->cmap, 256, 0);
565 pr_err("efifb: cannot allocate colormap\n");
568 err = register_framebuffer(info);
570 pr_err("efifb: cannot register framebuffer\n");
573 fb_info(info, "%s frame buffer device\n", info->fix.id);
577 fb_dealloc_cmap(&info->cmap);
579 sysfs_remove_groups(&dev->dev.kobj, efifb_groups);
581 if (mem_flags & (EFI_MEMORY_UC | EFI_MEMORY_WC))
582 iounmap(info->screen_base);
584 memunmap(info->screen_base);
586 framebuffer_release(info);
588 if (request_mem_succeeded)
589 release_mem_region(efifb_fix.smem_start, size_total);
593 static int efifb_remove(struct platform_device *pdev)
595 struct fb_info *info = platform_get_drvdata(pdev);
597 unregister_framebuffer(info);
598 sysfs_remove_groups(&pdev->dev.kobj, efifb_groups);
599 framebuffer_release(info);
604 static struct platform_driver efifb_driver = {
606 .name = "efi-framebuffer",
608 .probe = efifb_probe,
609 .remove = efifb_remove,
612 builtin_platform_driver(efifb_driver);
614 #if defined(CONFIG_PCI)
616 static void record_efifb_bar_resource(struct pci_dev *dev, int idx, u64 offset)
622 pci_read_config_word(dev, PCI_COMMAND, &word);
623 if (!(word & PCI_COMMAND_MEMORY)) {
624 pci_dev_disabled = true;
626 "BAR %d: assigned to efifb but device is disabled!\n",
631 bar_resource = &dev->resource[idx];
634 dev_info(&dev->dev, "BAR %d: assigned to efifb\n", idx);
637 static void efifb_fixup_resources(struct pci_dev *dev)
639 u64 base = screen_info.lfb_base;
640 u64 size = screen_info.lfb_size;
643 if (efifb_pci_dev || screen_info.orig_video_isVGA != VIDEO_TYPE_EFI)
646 if (screen_info.capabilities & VIDEO_CAPABILITY_64BIT_BASE)
647 base |= (u64)screen_info.ext_lfb_base << 32;
652 for (i = 0; i <= PCI_STD_RESOURCE_END; i++) {
653 struct resource *res = &dev->resource[i];
655 if (!(res->flags & IORESOURCE_MEM))
658 if (res->start <= base && res->end >= base + size - 1) {
659 record_efifb_bar_resource(dev, i, base - res->start);
664 DECLARE_PCI_FIXUP_CLASS_HEADER(PCI_ANY_ID, PCI_ANY_ID, PCI_BASE_CLASS_DISPLAY,
665 16, efifb_fixup_resources);