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
)
125 static const int default_resolutions
[][2] = {
132 for (i
= 0; i
< ARRAY_SIZE(default_resolutions
); i
++) {
133 if (default_resolutions
[i
][0] == si
->lfb_width
&&
134 default_resolutions
[i
][1] == si
->lfb_height
)
137 /* If not a default resolution used for textmode, this should be fine */
138 if (i
>= ARRAY_SIZE(default_resolutions
))
141 /* If the right margin is 5 times smaller then the left one, reject */
142 right_margin
= si
->lfb_width
- (bgrt_tab
.image_offset_x
+ bmp_width
);
143 if (right_margin
< (bgrt_tab
.image_offset_x
/ 5))
149 static bool efifb_bgrt_sanity_check(struct screen_info
*si
, u32 bmp_width
)
155 static void efifb_show_boot_graphics(struct fb_info
*info
)
157 u32 bmp_width
, bmp_height
, bmp_pitch
, screen_pitch
, dst_x
, y
, src_y
;
158 struct screen_info
*si
= &screen_info
;
159 struct bmp_file_header
*file_header
;
160 struct bmp_dib_header
*dib_header
;
161 void *bgrt_image
= NULL
;
162 u8
*dst
= info
->screen_base
;
167 if (!bgrt_tab
.image_address
) {
168 pr_info("efifb: No BGRT, not showing boot graphics\n");
172 /* Avoid flashing the logo if we're going to print std probe messages */
173 if (console_loglevel
> CONSOLE_LOGLEVEL_QUIET
)
176 /* bgrt_tab.status is unreliable, so we don't check it */
178 if (si
->lfb_depth
!= 32) {
179 pr_info("efifb: not 32 bits, not showing boot graphics\n");
183 bgrt_image
= memremap(bgrt_tab
.image_address
, bgrt_image_size
,
186 pr_warn("efifb: Ignoring BGRT: failed to map image memory\n");
190 if (bgrt_image_size
< (sizeof(*file_header
) + sizeof(*dib_header
)))
193 file_header
= bgrt_image
;
194 if (file_header
->id
!= 0x4d42 || file_header
->reserved
!= 0)
197 dib_header
= bgrt_image
+ sizeof(*file_header
);
198 if (dib_header
->dib_header_size
!= 40 || dib_header
->width
< 0 ||
199 dib_header
->planes
!= 1 || dib_header
->bpp
!= 24 ||
200 dib_header
->compression
!= 0)
203 bmp_width
= dib_header
->width
;
204 bmp_height
= abs(dib_header
->height
);
205 bmp_pitch
= round_up(3 * bmp_width
, 4);
206 screen_pitch
= si
->lfb_linelength
;
208 if ((file_header
->bitmap_offset
+ bmp_pitch
* bmp_height
) >
212 if ((bgrt_tab
.image_offset_x
+ bmp_width
) > si
->lfb_width
||
213 (bgrt_tab
.image_offset_y
+ bmp_height
) > si
->lfb_height
)
216 if (!efifb_bgrt_sanity_check(si
, bmp_width
))
219 pr_info("efifb: showing boot graphics\n");
221 for (y
= 0; y
< si
->lfb_height
; y
++, dst
+= si
->lfb_linelength
) {
222 /* Only background? */
223 if (y
< bgrt_tab
.image_offset_y
||
224 y
>= (bgrt_tab
.image_offset_y
+ bmp_height
)) {
225 memset(dst
, 0, 4 * si
->lfb_width
);
229 src_y
= y
- bgrt_tab
.image_offset_y
;
230 /* Positive header height means upside down row order */
231 if (dib_header
->height
> 0)
232 src_y
= (bmp_height
- 1) - src_y
;
234 memset(dst
, 0, bgrt_tab
.image_offset_x
* 4);
235 dst_x
= bgrt_tab
.image_offset_x
;
236 efifb_copy_bmp(bgrt_image
+ file_header
->bitmap_offset
+
238 (u32
*)dst
+ dst_x
, bmp_width
, si
);
240 memset((u32
*)dst
+ dst_x
, 0, (si
->lfb_width
- dst_x
) * 4);
243 memunmap(bgrt_image
);
247 memunmap(bgrt_image
);
248 pr_warn("efifb: Ignoring BGRT: unexpected or invalid BMP data\n");
251 static inline void efifb_show_boot_graphics(struct fb_info
*info
) {}
254 static void efifb_destroy(struct fb_info
*info
)
256 if (info
->screen_base
) {
257 if (mem_flags
& (EFI_MEMORY_UC
| EFI_MEMORY_WC
))
258 iounmap(info
->screen_base
);
260 memunmap(info
->screen_base
);
262 if (request_mem_succeeded
)
263 release_mem_region(info
->apertures
->ranges
[0].base
,
264 info
->apertures
->ranges
[0].size
);
265 fb_dealloc_cmap(&info
->cmap
);
268 static struct fb_ops efifb_ops
= {
269 .owner
= THIS_MODULE
,
270 .fb_destroy
= efifb_destroy
,
271 .fb_setcolreg
= efifb_setcolreg
,
272 .fb_fillrect
= cfb_fillrect
,
273 .fb_copyarea
= cfb_copyarea
,
274 .fb_imageblit
= cfb_imageblit
,
277 static int efifb_setup(char *options
)
281 if (options
&& *options
) {
282 while ((this_opt
= strsep(&options
, ",")) != NULL
) {
283 if (!*this_opt
) continue;
285 efifb_setup_from_dmi(&screen_info
, this_opt
);
287 if (!strncmp(this_opt
, "base:", 5))
288 screen_info
.lfb_base
= simple_strtoul(this_opt
+5, NULL
, 0);
289 else if (!strncmp(this_opt
, "stride:", 7))
290 screen_info
.lfb_linelength
= simple_strtoul(this_opt
+7, NULL
, 0) * 4;
291 else if (!strncmp(this_opt
, "height:", 7))
292 screen_info
.lfb_height
= simple_strtoul(this_opt
+7, NULL
, 0);
293 else if (!strncmp(this_opt
, "width:", 6))
294 screen_info
.lfb_width
= simple_strtoul(this_opt
+6, NULL
, 0);
295 else if (!strcmp(this_opt
, "nowc"))
296 mem_flags
&= ~EFI_MEMORY_WC
;
297 else if (!strcmp(this_opt
, "nobgrt"))
305 static inline bool fb_base_is_valid(void)
307 if (screen_info
.lfb_base
)
310 if (!(screen_info
.capabilities
& VIDEO_CAPABILITY_64BIT_BASE
))
313 if (screen_info
.ext_lfb_base
)
319 #define efifb_attr_decl(name, fmt) \
320 static ssize_t name##_show(struct device *dev, \
321 struct device_attribute *attr, \
324 return sprintf(buf, fmt "\n", (screen_info.lfb_##name)); \
326 static DEVICE_ATTR_RO(name)
328 efifb_attr_decl(base
, "0x%x");
329 efifb_attr_decl(linelength
, "%u");
330 efifb_attr_decl(height
, "%u");
331 efifb_attr_decl(width
, "%u");
332 efifb_attr_decl(depth
, "%u");
334 static struct attribute
*efifb_attrs
[] = {
336 &dev_attr_linelength
.attr
,
337 &dev_attr_width
.attr
,
338 &dev_attr_height
.attr
,
339 &dev_attr_depth
.attr
,
342 ATTRIBUTE_GROUPS(efifb
);
344 static bool pci_dev_disabled
; /* FB base matches BAR of a disabled device */
346 static struct pci_dev
*efifb_pci_dev
; /* dev with BAR covering the efifb */
347 static struct resource
*bar_resource
;
348 static u64 bar_offset
;
350 static int efifb_probe(struct platform_device
*dev
)
352 struct fb_info
*info
;
353 int err
, orientation
;
354 unsigned int size_vmode
;
355 unsigned int size_remap
;
356 unsigned int size_total
;
358 efi_memory_desc_t md
;
360 if (screen_info
.orig_video_isVGA
!= VIDEO_TYPE_EFI
|| pci_dev_disabled
)
363 if (fb_get_options("efifb", &option
))
367 /* We don't get linelength from UGA Draw Protocol, only from
368 * EFI Graphics Protocol. So if it's not in DMI, and it's not
369 * passed in from the user, we really can't use the framebuffer.
371 if (!screen_info
.lfb_linelength
)
374 if (!screen_info
.lfb_depth
)
375 screen_info
.lfb_depth
= 32;
376 if (!screen_info
.pages
)
377 screen_info
.pages
= 1;
378 if (!fb_base_is_valid()) {
379 printk(KERN_DEBUG
"efifb: invalid framebuffer address\n");
382 printk(KERN_INFO
"efifb: probing for efifb\n");
384 /* just assume they're all unset if any are */
385 if (!screen_info
.blue_size
) {
386 screen_info
.blue_size
= 8;
387 screen_info
.blue_pos
= 0;
388 screen_info
.green_size
= 8;
389 screen_info
.green_pos
= 8;
390 screen_info
.red_size
= 8;
391 screen_info
.red_pos
= 16;
392 screen_info
.rsvd_size
= 8;
393 screen_info
.rsvd_pos
= 24;
396 efifb_fix
.smem_start
= screen_info
.lfb_base
;
398 if (screen_info
.capabilities
& VIDEO_CAPABILITY_64BIT_BASE
) {
401 ext_lfb_base
= (u64
)(unsigned long)screen_info
.ext_lfb_base
<< 32;
402 efifb_fix
.smem_start
|= ext_lfb_base
;
406 bar_resource
->start
+ bar_offset
!= efifb_fix
.smem_start
) {
407 dev_info(&efifb_pci_dev
->dev
,
408 "BAR has moved, updating efifb address\n");
409 efifb_fix
.smem_start
= bar_resource
->start
+ bar_offset
;
412 efifb_defined
.bits_per_pixel
= screen_info
.lfb_depth
;
413 efifb_defined
.xres
= screen_info
.lfb_width
;
414 efifb_defined
.yres
= screen_info
.lfb_height
;
415 efifb_fix
.line_length
= screen_info
.lfb_linelength
;
417 /* size_vmode -- that is the amount of memory needed for the
418 * used video mode, i.e. the minimum amount of
420 size_vmode
= efifb_defined
.yres
* efifb_fix
.line_length
;
422 /* size_total -- all video memory we have. Used for
423 * entries, ressource allocation and bounds
425 size_total
= screen_info
.lfb_size
;
426 if (size_total
< size_vmode
)
427 size_total
= size_vmode
;
429 /* size_remap -- the amount of video memory we are going to
430 * use for efifb. With modern cards it is no
431 * option to simply use size_total as that
432 * wastes plenty of kernel address space. */
433 size_remap
= size_vmode
* 2;
434 if (size_remap
> size_total
)
435 size_remap
= size_total
;
436 if (size_remap
% PAGE_SIZE
)
437 size_remap
+= PAGE_SIZE
- (size_remap
% PAGE_SIZE
);
438 efifb_fix
.smem_len
= size_remap
;
440 if (request_mem_region(efifb_fix
.smem_start
, size_remap
, "efifb")) {
441 request_mem_succeeded
= true;
443 /* We cannot make this fatal. Sometimes this comes from magic
444 spaces our resource handlers simply don't know about */
445 pr_warn("efifb: cannot reserve video memory at 0x%lx\n",
446 efifb_fix
.smem_start
);
449 info
= framebuffer_alloc(sizeof(u32
) * 16, &dev
->dev
);
451 pr_err("efifb: cannot allocate framebuffer\n");
453 goto err_release_mem
;
455 platform_set_drvdata(dev
, info
);
456 info
->pseudo_palette
= info
->par
;
459 info
->apertures
= alloc_apertures(1);
460 if (!info
->apertures
) {
464 info
->apertures
->ranges
[0].base
= efifb_fix
.smem_start
;
465 info
->apertures
->ranges
[0].size
= size_remap
;
467 if (!efi_mem_desc_lookup(efifb_fix
.smem_start
, &md
)) {
468 if ((efifb_fix
.smem_start
+ efifb_fix
.smem_len
) >
469 (md
.phys_addr
+ (md
.num_pages
<< EFI_PAGE_SHIFT
))) {
470 pr_err("efifb: video memory @ 0x%lx spans multiple EFI memory regions\n",
471 efifb_fix
.smem_start
);
476 * If the UEFI memory map covers the efifb region, we may only
477 * remap it using the attributes the memory map prescribes.
479 mem_flags
|= EFI_MEMORY_WT
| EFI_MEMORY_WB
;
480 mem_flags
&= md
.attribute
;
482 if (mem_flags
& EFI_MEMORY_WC
)
483 info
->screen_base
= ioremap_wc(efifb_fix
.smem_start
,
485 else if (mem_flags
& EFI_MEMORY_UC
)
486 info
->screen_base
= ioremap(efifb_fix
.smem_start
,
488 else if (mem_flags
& EFI_MEMORY_WT
)
489 info
->screen_base
= memremap(efifb_fix
.smem_start
,
490 efifb_fix
.smem_len
, MEMREMAP_WT
);
491 else if (mem_flags
& EFI_MEMORY_WB
)
492 info
->screen_base
= memremap(efifb_fix
.smem_start
,
493 efifb_fix
.smem_len
, MEMREMAP_WB
);
494 if (!info
->screen_base
) {
495 pr_err("efifb: abort, cannot remap video memory 0x%x @ 0x%lx\n",
496 efifb_fix
.smem_len
, efifb_fix
.smem_start
);
501 efifb_show_boot_graphics(info
);
503 pr_info("efifb: framebuffer at 0x%lx, using %dk, total %dk\n",
504 efifb_fix
.smem_start
, size_remap
/1024, size_total
/1024);
505 pr_info("efifb: mode is %dx%dx%d, linelength=%d, pages=%d\n",
506 efifb_defined
.xres
, efifb_defined
.yres
,
507 efifb_defined
.bits_per_pixel
, efifb_fix
.line_length
,
510 efifb_defined
.xres_virtual
= efifb_defined
.xres
;
511 efifb_defined
.yres_virtual
= efifb_fix
.smem_len
/
512 efifb_fix
.line_length
;
513 pr_info("efifb: scrolling: redraw\n");
514 efifb_defined
.yres_virtual
= efifb_defined
.yres
;
516 /* some dummy values for timing to make fbset happy */
517 efifb_defined
.pixclock
= 10000000 / efifb_defined
.xres
*
518 1000 / efifb_defined
.yres
;
519 efifb_defined
.left_margin
= (efifb_defined
.xres
/ 8) & 0xf8;
520 efifb_defined
.hsync_len
= (efifb_defined
.xres
/ 8) & 0xf8;
522 efifb_defined
.red
.offset
= screen_info
.red_pos
;
523 efifb_defined
.red
.length
= screen_info
.red_size
;
524 efifb_defined
.green
.offset
= screen_info
.green_pos
;
525 efifb_defined
.green
.length
= screen_info
.green_size
;
526 efifb_defined
.blue
.offset
= screen_info
.blue_pos
;
527 efifb_defined
.blue
.length
= screen_info
.blue_size
;
528 efifb_defined
.transp
.offset
= screen_info
.rsvd_pos
;
529 efifb_defined
.transp
.length
= screen_info
.rsvd_size
;
531 pr_info("efifb: %s: "
532 "size=%d:%d:%d:%d, shift=%d:%d:%d:%d\n",
534 screen_info
.rsvd_size
,
535 screen_info
.red_size
,
536 screen_info
.green_size
,
537 screen_info
.blue_size
,
538 screen_info
.rsvd_pos
,
540 screen_info
.green_pos
,
541 screen_info
.blue_pos
);
543 efifb_fix
.ypanstep
= 0;
544 efifb_fix
.ywrapstep
= 0;
546 info
->fbops
= &efifb_ops
;
547 info
->var
= efifb_defined
;
548 info
->fix
= efifb_fix
;
549 info
->flags
= FBINFO_FLAG_DEFAULT
| FBINFO_MISC_FIRMWARE
;
551 orientation
= drm_get_panel_orientation_quirk(efifb_defined
.xres
,
553 switch (orientation
) {
555 info
->fbcon_rotate_hint
= FB_ROTATE_UR
;
557 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP
:
558 info
->fbcon_rotate_hint
= FB_ROTATE_UD
;
560 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP
:
561 info
->fbcon_rotate_hint
= FB_ROTATE_CCW
;
563 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP
:
564 info
->fbcon_rotate_hint
= FB_ROTATE_CW
;
568 err
= sysfs_create_groups(&dev
->dev
.kobj
, efifb_groups
);
570 pr_err("efifb: cannot add sysfs attrs\n");
573 err
= fb_alloc_cmap(&info
->cmap
, 256, 0);
575 pr_err("efifb: cannot allocate colormap\n");
578 err
= register_framebuffer(info
);
580 pr_err("efifb: cannot register framebuffer\n");
583 fb_info(info
, "%s frame buffer device\n", info
->fix
.id
);
587 fb_dealloc_cmap(&info
->cmap
);
589 sysfs_remove_groups(&dev
->dev
.kobj
, efifb_groups
);
591 if (mem_flags
& (EFI_MEMORY_UC
| EFI_MEMORY_WC
))
592 iounmap(info
->screen_base
);
594 memunmap(info
->screen_base
);
596 framebuffer_release(info
);
598 if (request_mem_succeeded
)
599 release_mem_region(efifb_fix
.smem_start
, size_total
);
603 static int efifb_remove(struct platform_device
*pdev
)
605 struct fb_info
*info
= platform_get_drvdata(pdev
);
607 unregister_framebuffer(info
);
608 sysfs_remove_groups(&pdev
->dev
.kobj
, efifb_groups
);
609 framebuffer_release(info
);
614 static struct platform_driver efifb_driver
= {
616 .name
= "efi-framebuffer",
618 .probe
= efifb_probe
,
619 .remove
= efifb_remove
,
622 builtin_platform_driver(efifb_driver
);
624 #if defined(CONFIG_PCI)
626 static void record_efifb_bar_resource(struct pci_dev
*dev
, int idx
, u64 offset
)
632 pci_read_config_word(dev
, PCI_COMMAND
, &word
);
633 if (!(word
& PCI_COMMAND_MEMORY
)) {
634 pci_dev_disabled
= true;
636 "BAR %d: assigned to efifb but device is disabled!\n",
641 bar_resource
= &dev
->resource
[idx
];
644 dev_info(&dev
->dev
, "BAR %d: assigned to efifb\n", idx
);
647 static void efifb_fixup_resources(struct pci_dev
*dev
)
649 u64 base
= screen_info
.lfb_base
;
650 u64 size
= screen_info
.lfb_size
;
653 if (efifb_pci_dev
|| screen_info
.orig_video_isVGA
!= VIDEO_TYPE_EFI
)
656 if (screen_info
.capabilities
& VIDEO_CAPABILITY_64BIT_BASE
)
657 base
|= (u64
)screen_info
.ext_lfb_base
<< 32;
662 for (i
= 0; i
<= PCI_STD_RESOURCE_END
; i
++) {
663 struct resource
*res
= &dev
->resource
[i
];
665 if (!(res
->flags
& IORESOURCE_MEM
))
668 if (res
->start
<= base
&& res
->end
>= base
+ size
- 1) {
669 record_efifb_bar_resource(dev
, i
, base
- res
->start
);
674 DECLARE_PCI_FIXUP_CLASS_HEADER(PCI_ANY_ID
, PCI_ANY_ID
, PCI_BASE_CLASS_DISPLAY
,
675 16, efifb_fixup_resources
);