1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2014 The FreeBSD Foundation 5 * 6 * This software was developed by Aleksandr Rybalko under sponsorship from the 7 * FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 #include <sys/param.h> 32 #include <sys/systm.h> 33 #include <sys/kernel.h> 34 #include <sys/fbio.h> 35 #include <sys/linker.h> 36 37 #include "opt_platform.h" 38 39 #include <machine/metadata.h> 40 #include <machine/vmparam.h> 41 #include <vm/vm.h> 42 #include <vm/pmap.h> 43 44 #include <dev/vt/vt.h> 45 #include <dev/vt/hw/fb/vt_fb.h> 46 #include <dev/vt/colors/vt_termcolors.h> 47 48 static vd_init_t vt_efifb_init; 49 static vd_fini_t vt_efifb_fini; 50 static vd_probe_t vt_efifb_probe; 51 52 static struct vt_driver vt_efifb_driver = { 53 .vd_name = "efifb", 54 .vd_probe = vt_efifb_probe, 55 .vd_init = vt_efifb_init, 56 .vd_fini = vt_efifb_fini, 57 .vd_blank = vt_fb_blank, 58 .vd_bitblt_text = vt_fb_bitblt_text, 59 .vd_invalidate_text = vt_fb_invalidate_text, 60 .vd_bitblt_bmp = vt_fb_bitblt_bitmap, 61 .vd_bitblt_argb = vt_fb_bitblt_argb, 62 .vd_drawrect = vt_fb_drawrect, 63 .vd_setpixel = vt_fb_setpixel, 64 .vd_fb_ioctl = vt_fb_ioctl, 65 .vd_fb_mmap = vt_fb_mmap, 66 .vd_suspend = vt_suspend, 67 .vd_resume = vt_resume, 68 /* Better than VGA, but still generic driver. */ 69 .vd_priority = VD_PRIORITY_GENERIC + 1, 70 }; 71 72 static struct fb_info local_info; 73 VT_DRIVER_DECLARE(vt_efifb, vt_efifb_driver); 74 75 static int 76 vt_efifb_probe(struct vt_device *vd) 77 { 78 int disabled; 79 struct efi_fb *efifb; 80 caddr_t kmdp; 81 82 disabled = 0; 83 TUNABLE_INT_FETCH("hw.syscons.disable", &disabled); 84 if (disabled != 0) 85 return (CN_DEAD); 86 87 kmdp = preload_search_by_type("elf kernel"); 88 if (kmdp == NULL) 89 kmdp = preload_search_by_type("elf64 kernel"); 90 efifb = (struct efi_fb *)preload_search_info(kmdp, 91 MODINFO_METADATA | MODINFOMD_EFI_FB); 92 if (efifb == NULL) 93 return (CN_DEAD); 94 95 return (CN_INTERNAL); 96 } 97 98 static int 99 vt_efifb_init(struct vt_device *vd) 100 { 101 struct fb_info *info; 102 struct efi_fb *efifb; 103 caddr_t kmdp; 104 int memattr; 105 int roff, goff, boff; 106 char attr[16]; 107 108 /* 109 * XXX TODO: I think there's more nuance here than we're acknowledging, 110 * and we should look into it. It may be that the framebuffer lives in 111 * a segment of memory that doesn't support one or both of these. We 112 * should likely be consulting the memory map for any applicable 113 * cacheability attributes before making a final decision. 114 */ 115 memattr = VM_MEMATTR_WRITE_COMBINING; 116 if (TUNABLE_STR_FETCH("hw.efifb.cache_attr", attr, sizeof(attr))) { 117 /* 118 * We'll allow WC but it's currently the default, UC is the only 119 * other tested one at this time. 120 */ 121 if (strcasecmp(attr, "wc") != 0 && 122 strcasecmp(attr, "uc") != 0) { 123 printf("efifb: unsupported cache attr specified: %s\n", 124 attr); 125 printf("efifb: expected \"wc\" or \"uc\"\n"); 126 } else if (strcasecmp(attr, "uc") == 0) { 127 memattr = VM_MEMATTR_UNCACHEABLE; 128 } 129 } 130 131 info = vd->vd_softc; 132 if (info == NULL) 133 info = vd->vd_softc = (void *)&local_info; 134 135 kmdp = preload_search_by_type("elf kernel"); 136 if (kmdp == NULL) 137 kmdp = preload_search_by_type("elf64 kernel"); 138 efifb = (struct efi_fb *)preload_search_info(kmdp, 139 MODINFO_METADATA | MODINFOMD_EFI_FB); 140 if (efifb == NULL) 141 return (CN_DEAD); 142 143 info->fb_type = FBTYPE_EFIFB; 144 info->fb_height = efifb->fb_height; 145 info->fb_width = efifb->fb_width; 146 147 info->fb_depth = fls(efifb->fb_mask_red | efifb->fb_mask_green | 148 efifb->fb_mask_blue | efifb->fb_mask_reserved); 149 /* Round to a multiple of the bits in a byte. */ 150 info->fb_bpp = roundup2(info->fb_depth, NBBY); 151 152 /* Stride in bytes, not pixels */ 153 info->fb_stride = efifb->fb_stride * (info->fb_bpp / NBBY); 154 155 roff = ffs(efifb->fb_mask_red) - 1; 156 goff = ffs(efifb->fb_mask_green) - 1; 157 boff = ffs(efifb->fb_mask_blue) - 1; 158 vt_config_cons_colors(info, COLOR_FORMAT_RGB, 159 efifb->fb_mask_red >> roff, roff, 160 efifb->fb_mask_green >> goff, goff, 161 efifb->fb_mask_blue >> boff, boff); 162 info->fb_cmsize = NCOLORS; 163 164 info->fb_size = info->fb_height * info->fb_stride; 165 info->fb_pbase = efifb->fb_addr; 166 info->fb_vbase = (intptr_t)pmap_mapdev_attr(info->fb_pbase, 167 info->fb_size, memattr); 168 169 vt_fb_init(vd); 170 171 return (CN_INTERNAL); 172 } 173 174 static void 175 vt_efifb_fini(struct vt_device *vd, void *softc) 176 { 177 struct fb_info *info = softc; 178 179 vt_fb_fini(vd, softc); 180 pmap_unmapdev((void *)info->fb_vbase, info->fb_size); 181 } 182