stand/efi/loader/bootinfo.c

   1 /*-
   2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
   3  * Copyright (c) 2004, 2006 Marcel Moolenaar
   4  * Copyright (c) 2014 The FreeBSD Foundation
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <stand.h>
  33 #include <string.h>
  34 #include <sys/param.h>
  35 #include <sys/linker.h>
  36 #include <sys/reboot.h>
  37 #include <sys/boot.h>
  38 #include <machine/cpufunc.h>
  39 #include <machine/elf.h>
  40 #include <machine/metadata.h>
  41 #include <machine/psl.h>
  42
  43 #ifdef EFI
  44 #include <efi.h>
  45 #include <efilib.h>
  46 #else
  47 #include "kboot.h"
  48 #endif
  49
  50 #include "bootstrap.h"
  51 #include "modinfo.h"
  52
  53 #if defined(__amd64__)
  54 #include <machine/specialreg.h>
  55 #endif
  56
  57 #ifdef EFI
  58 #include "loader_efi.h"
  59 #include "gfx_fb.h"
  60 #endif
  61
  62 #if defined(LOADER_FDT_SUPPORT)
  63 #include <fdt_platform.h>
  64 #endif
  65
  66 #ifdef LOADER_GELI_SUPPORT
  67 #include "geliboot.h"
  68 #endif
  69
  70 int bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp,
  71     bool exit_bs);
  72
  73 static int
  74 bi_getboothowto(char *kargs)
  75 {
  76 #ifdef EFI
  77         const char *sw, *tmp;
  78         char *opts;
  79         int speed, port;
  80         char buf[50];
  81 #endif
  82         char *console;
  83         int howto;
  84
  85         howto = boot_parse_cmdline(kargs);
  86         howto |= boot_env_to_howto();
  87
  88         console = getenv("console");
  89         if (console != NULL) {
  90                 if (strcmp(console, "comconsole") == 0)
  91                         howto |= RB_SERIAL;
  92                 if (strcmp(console, "nullconsole") == 0)
  93                         howto |= RB_MUTE;
  94 #ifdef EFI
  95 #if defined(__i386__) || defined(__amd64__)
  96                 if (strcmp(console, "efi") == 0 &&
  97                     getenv("efi_8250_uid") != NULL &&
  98                     getenv("hw.uart.console") == NULL) {
  99                         /*
 100                          * If we found a 8250 com port and com speed, we need to
 101                          * tell the kernel where the serial port is, and how
 102                          * fast. Ideally, we'd get the port from ACPI, but that
 103                          * isn't running in the loader. Do the next best thing
 104                          * by allowing it to be set by a loader.conf variable,
 105                          * either a EFI specific one, or the compatible
 106                          * comconsole_port if not. PCI support is needed, but
 107                          * for that we'd ideally refactor the
 108                          * libi386/comconsole.c code to have identical behavior.
 109                          * We only try to set the port for cases where we saw
 110                          * the Serial(x) node when parsing, otherwise
 111                          * specialized hardware that has Uart nodes will have a
 112                          * bogus address set.
 113                          * But if someone specifically setup hw.uart.console,
 114                          * don't override that.
 115                          */
 116                         speed = -1;
 117                         port = -1;
 118                         tmp = getenv("efi_com_speed");
 119                         if (tmp != NULL)
 120                                 speed = strtol(tmp, NULL, 0);
 121                         tmp = getenv("efi_com_port");
 122                         if (tmp == NULL)
 123                                 tmp = getenv("comconsole_port");
 124                         if (tmp != NULL)
 125                                 port = strtol(tmp, NULL, 0);
 126                         if (speed != -1 && port != -1) {
 127                                 snprintf(buf, sizeof(buf), "io:%d,br:%d", port,
 128                                     speed);
 129                                 env_setenv("hw.uart.console", EV_VOLATILE, buf,
 130                                     NULL, NULL);
 131                         }
 132                 }
 133 #endif
 134 #endif
 135         }
 136
 137         return (howto);
 138 }
 139
 140 #ifdef EFI
 141 static EFI_STATUS
 142 efi_do_vmap(EFI_MEMORY_DESCRIPTOR *mm, UINTN sz, UINTN mmsz, UINT32 mmver)
 143 {
 144         EFI_MEMORY_DESCRIPTOR *desc, *viter, *vmap;
 145         EFI_STATUS ret;
 146         int curr, ndesc, nset;
 147
 148         nset = 0;
 149         desc = mm;
 150         ndesc = sz / mmsz;
 151         vmap = malloc(sz);
 152         if (vmap == NULL)
 153                 /* This isn't really an EFI error case, but pretend it is */
 154                 return (EFI_OUT_OF_RESOURCES);
 155         viter = vmap;
 156         for (curr = 0; curr < ndesc;
 157             curr++, desc = NextMemoryDescriptor(desc, mmsz)) {
 158                 if ((desc->Attribute & EFI_MEMORY_RUNTIME) != 0) {
 159                         ++nset;
 160                         desc->VirtualStart = desc->PhysicalStart;
 161                         *viter = *desc;
 162                         viter = NextMemoryDescriptor(viter, mmsz);
 163                 }
 164         }
 165         ret = RS->SetVirtualAddressMap(nset * mmsz, mmsz, mmver, vmap);
 166         free(vmap);
 167         return (ret);
 168 }
 169
 170 static int
 171 bi_load_efi_data(struct preloaded_file *kfp, bool exit_bs)
 172 {
 173         EFI_MEMORY_DESCRIPTOR *mm;
 174         EFI_PHYSICAL_ADDRESS addr = 0;
 175         EFI_STATUS status;
 176         const char *efi_novmap;
 177         size_t efisz;
 178         UINTN efi_mapkey;
 179         UINTN dsz, pages, retry, sz;
 180         UINT32 mmver;
 181         struct efi_map_header *efihdr;
 182         bool do_vmap;
 183
 184 #if defined(__amd64__) || defined(__aarch64__)
 185         struct efi_fb efifb;
 186
 187         efifb.fb_addr = gfx_state.tg_fb.fb_addr;
 188         efifb.fb_size = gfx_state.tg_fb.fb_size;
 189         efifb.fb_height = gfx_state.tg_fb.fb_height;
 190         efifb.fb_width = gfx_state.tg_fb.fb_width;
 191         efifb.fb_stride = gfx_state.tg_fb.fb_stride;
 192         efifb.fb_mask_red = gfx_state.tg_fb.fb_mask_red;
 193         efifb.fb_mask_green = gfx_state.tg_fb.fb_mask_green;
 194         efifb.fb_mask_blue = gfx_state.tg_fb.fb_mask_blue;
 195         efifb.fb_mask_reserved = gfx_state.tg_fb.fb_mask_reserved;
 196
 197         if (efifb.fb_addr != 0) {
 198                 printf("EFI framebuffer information:\n");
 199                 printf("addr, size     0x%jx, 0x%jx\n",
 200                     efifb.fb_addr, efifb.fb_size);
 201                 printf("dimensions     %d x %d\n",
 202                     efifb.fb_width, efifb.fb_height);
 203                 printf("stride         %d\n", efifb.fb_stride);
 204                 printf("masks          0x%08x, 0x%08x, 0x%08x, 0x%08x\n",
 205                     efifb.fb_mask_red, efifb.fb_mask_green, efifb.fb_mask_blue,
 206                     efifb.fb_mask_reserved);
 207
 208                 file_addmetadata(kfp, MODINFOMD_EFI_FB, sizeof(efifb), &efifb);
 209         }
 210 #endif
 211
 212         do_vmap = true;
 213         efi_novmap = getenv("efi_disable_vmap");
 214         if (efi_novmap != NULL)
 215                 do_vmap = strcasecmp(efi_novmap, "YES") != 0;
 216
 217         efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf;
 218
 219         /*
 220          * Assign size of EFI_MEMORY_DESCRIPTOR to keep compatible with
 221          * u-boot which doesn't fill this value when buffer for memory
 222          * descriptors is too small (eg. 0 to obtain memory map size)
 223          */
 224         dsz = sizeof(EFI_MEMORY_DESCRIPTOR);
 225
 226         /*
 227          * Allocate enough pages to hold the bootinfo block and the
 228          * memory map EFI will return to us. The memory map has an
 229          * unknown size, so we have to determine that first. Note that
 230          * the AllocatePages call can itself modify the memory map, so
 231          * we have to take that into account as well. The changes to
 232          * the memory map are caused by splitting a range of free
 233          * memory into two, so that one is marked as being loader
 234          * data.
 235          */
 236
 237         sz = 0;
 238         mm = NULL;
 239
 240         /*
 241          * Matthew Garrett has observed at least one system changing the
 242          * memory map when calling ExitBootServices, causing it to return an
 243          * error, probably because callbacks are allocating memory.
 244          * So we need to retry calling it at least once.
 245          */
 246         for (retry = 2; retry > 0; retry--) {
 247                 for (;;) {
 248                         status = BS->GetMemoryMap(&sz, mm, &efi_mapkey, &dsz, &mmver);
 249                         if (!EFI_ERROR(status))
 250                                 break;
 251
 252                         if (status != EFI_BUFFER_TOO_SMALL) {
 253                                 printf("%s: GetMemoryMap error %lu\n", __func__,
 254                                    EFI_ERROR_CODE(status));
 255                                 return (EINVAL);
 256                         }
 257
 258                         if (addr != 0)
 259                                 BS->FreePages(addr, pages);
 260
 261                         /* Add 10 descriptors to the size to allow for
 262                          * fragmentation caused by calling AllocatePages */
 263                         sz += (10 * dsz);
 264                         pages = EFI_SIZE_TO_PAGES(sz + efisz);
 265                         status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
 266                                         pages, &addr);
 267                         if (EFI_ERROR(status)) {
 268                                 printf("%s: AllocatePages error %lu\n", __func__,
 269                                     EFI_ERROR_CODE(status));
 270                                 return (ENOMEM);
 271                         }
 272
 273                         /*
 274                          * Read the memory map and stash it after bootinfo. Align the
 275                          * memory map on a 16-byte boundary (the bootinfo block is page
 276                          * aligned).
 277                          */
 278                         efihdr = (struct efi_map_header *)(uintptr_t)addr;
 279                         mm = (void *)((uint8_t *)efihdr + efisz);
 280                         sz = (EFI_PAGE_SIZE * pages) - efisz;
 281                 }
 282
 283                 if (!exit_bs)
 284                         break;
 285                 status = efi_exit_boot_services(efi_mapkey);
 286                 if (!EFI_ERROR(status))
 287                         break;
 288         }
 289
 290         if (retry == 0) {
 291                 BS->FreePages(addr, pages);
 292                 printf("ExitBootServices error %lu\n", EFI_ERROR_CODE(status));
 293                 return (EINVAL);
 294         }
 295
 296         /*
 297          * This may be disabled by setting efi_disable_vmap in
 298          * loader.conf(5). By default we will setup the virtual
 299          * map entries.
 300          */
 301
 302         if (do_vmap)
 303                 efi_do_vmap(mm, sz, dsz, mmver);
 304         efihdr->memory_size = sz;
 305         efihdr->descriptor_size = dsz;
 306         efihdr->descriptor_version = mmver;
 307         file_addmetadata(kfp, MODINFOMD_EFI_MAP, efisz + sz,
 308             efihdr);
 309
 310         return (0);
 311 }
 312 #endif
 313
 314 /*
 315  * Load the information expected by an amd64 kernel.
 316  *
 317  * - The 'boothowto' argument is constructed.
 318  * - The 'bootdev' argument is constructed.
 319  * - The 'bootinfo' struct is constructed, and copied into the kernel space.
 320  * - The kernel environment is copied into kernel space.
 321  * - Module metadata are formatted and placed in kernel space.
 322  */
 323 int
 324 bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp, bool exit_bs)
 325 {
 326         struct preloaded_file *xp, *kfp;
 327         struct devdesc *rootdev;
 328         struct file_metadata *md;
 329         vm_offset_t addr;
 330         uint64_t kernend, module;
 331         uint64_t envp;
 332         vm_offset_t size;
 333         char *rootdevname;
 334         int howto;
 335         bool is64 = sizeof(long) == 8;
 336 #if defined(LOADER_FDT_SUPPORT)
 337         vm_offset_t dtbp;
 338         int dtb_size;
 339 #endif
 340 #if defined(__arm__)
 341         vm_offset_t vaddr;
 342         size_t i;
 343         /*
 344          * These metadata addreses must be converted for kernel after
 345          * relocation.
 346          */
 347         uint32_t                mdt[] = {
 348             MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND,
 349             MODINFOMD_ENVP, MODINFOMD_FONT,
 350 #if defined(LOADER_FDT_SUPPORT)
 351             MODINFOMD_DTBP
 352 #endif
 353         };
 354 #endif
 355         howto = bi_getboothowto(args);
 356
 357         /*
 358          * Allow the environment variable 'rootdev' to override the supplied
 359          * device. This should perhaps go to MI code and/or have $rootdev
 360          * tested/set by MI code before launching the kernel.
 361          */
 362         rootdevname = getenv("rootdev");
 363         archsw.arch_getdev((void**)(&rootdev), rootdevname, NULL);
 364         if (rootdev == NULL) {
 365                 printf("Can't determine root device.\n");
 366                 return(EINVAL);
 367         }
 368
 369         /* Try reading the /etc/fstab file to select the root device */
 370         getrootmount(devformat(rootdev));
 371
 372         addr = 0;
 373         for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
 374                 if (addr < xp->f_addr + xp->f_size)
 375                         addr = xp->f_addr + xp->f_size;
 376         }
 377
 378         /* Pad to a page boundary. */
 379         addr = roundup(addr, PAGE_SIZE);
 380
 381         addr = build_font_module(addr);
 382
 383         /* Pad to a page boundary. */
 384         addr = roundup(addr, PAGE_SIZE);
 385
 386         /* Copy our environment. */
 387         envp = addr;
 388         addr = md_copyenv(addr);
 389
 390         /* Pad to a page boundary. */
 391         addr = roundup(addr, PAGE_SIZE);
 392
 393 #if defined(LOADER_FDT_SUPPORT)
 394         /* Handle device tree blob */
 395         dtbp = addr;
 396         dtb_size = fdt_copy(addr);
 397
 398         /* Pad to a page boundary */
 399         if (dtb_size)
 400                 addr += roundup(dtb_size, PAGE_SIZE);
 401 #endif
 402
 403         kfp = file_findfile(NULL, "elf kernel");
 404         if (kfp == NULL)
 405                 kfp = file_findfile(NULL, "elf64 kernel");
 406         if (kfp == NULL)
 407                 panic("can't find kernel file");
 408         kernend = 0;    /* fill it in later */
 409
 410         /* Figure out the size and location of the metadata. */
 411         module = *modulep = addr;
 412
 413         file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof(howto), &howto);
 414         file_addmetadata(kfp, MODINFOMD_ENVP, sizeof(envp), &envp);
 415 #if defined(LOADER_FDT_SUPPORT)
 416         if (dtb_size)
 417                 file_addmetadata(kfp, MODINFOMD_DTBP, sizeof(dtbp), &dtbp);
 418         else
 419                 printf("WARNING! Trying to fire up the kernel, but no "
 420                     "device tree blob found!\n");
 421 #endif
 422         file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof(kernend), &kernend);
 423 #ifdef MODINFOMD_MODULEP
 424         file_addmetadata(kfp, MODINFOMD_MODULEP, sizeof(module), &module);
 425 #endif
 426 #ifdef EFI
 427         file_addmetadata(kfp, MODINFOMD_FW_HANDLE, sizeof(ST), &ST);
 428 #endif
 429 #ifdef LOADER_GELI_SUPPORT
 430         geli_export_key_metadata(kfp);
 431 #endif
 432 #ifdef EFI
 433         bi_load_efi_data(kfp, exit_bs);
 434 #else
 435         bi_loadsmap(kfp);
 436 #endif
 437
 438         size = md_copymodules(0, is64); /* Find the size of the modules */
 439         kernend = roundup(addr + size, PAGE_SIZE);
 440         *kernendp = kernend;
 441
 442         /* patch MODINFOMD_KERNEND */
 443         md = file_findmetadata(kfp, MODINFOMD_KERNEND);
 444         bcopy(&kernend, md->md_data, sizeof kernend);
 445
 446 #if defined(__arm__)
 447         *modulep -= __elfN(relocation_offset);
 448
 449         /* Do relocation fixup on metadata of each module. */
 450         for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
 451                 for (i = 0; i < nitems(mdt); i++) {
 452                         md = file_findmetadata(xp, mdt[i]);
 453                         if (md) {
 454                                 bcopy(md->md_data, &vaddr, sizeof vaddr);
 455                                 vaddr -= __elfN(relocation_offset);
 456                                 bcopy(&vaddr, md->md_data, sizeof vaddr);
 457                         }
 458                 }
 459         }
 460 #endif
 461
 462         /* Copy module list and metadata. */
 463         (void)md_copymodules(addr, is64);
 464
 465         return (0);
 466 }