2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * Copyright (c) 2004, 2006 Marcel Moolenaar
4 * Copyright (c) 2014 The FreeBSD Foundation
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/linker.h>
36 #include <sys/reboot.h>
38 #include <machine/cpufunc.h>
39 #include <machine/elf.h>
40 #include <machine/metadata.h>
41 #include <machine/psl.h>
46 #include "bootstrap.h"
47 #include "loader_efi.h"
49 #if defined(__amd64__)
50 #include <machine/specialreg.h>
55 #if defined(LOADER_FDT_SUPPORT)
56 #include <fdt_platform.h>
59 #ifdef LOADER_GELI_SUPPORT
63 int bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp,
66 extern EFI_SYSTEM_TABLE *ST;
68 int boot_services_gone;
71 bi_getboothowto(char *kargs)
76 int howto, speed, port;
79 howto = boot_parse_cmdline(kargs);
80 howto |= boot_env_to_howto();
82 console = getenv("console");
83 if (console != NULL) {
84 if (strcmp(console, "comconsole") == 0)
86 if (strcmp(console, "nullconsole") == 0)
88 #if defined(__i386__) || defined(__amd64__)
89 if (strcmp(console, "efi") == 0 &&
90 getenv("efi_8250_uid") != NULL &&
91 getenv("hw.uart.console") == NULL) {
93 * If we found a 8250 com port and com speed, we need to
94 * tell the kernel where the serial port is, and how
95 * fast. Ideally, we'd get the port from ACPI, but that
96 * isn't running in the loader. Do the next best thing
97 * by allowing it to be set by a loader.conf variable,
98 * either a EFI specific one, or the compatible
99 * comconsole_port if not. PCI support is needed, but
100 * for that we'd ideally refactor the
101 * libi386/comconsole.c code to have identical behavior.
102 * We only try to set the port for cases where we saw
103 * the Serial(x) node when parsing, otherwise
104 * specialized hardware that has Uart nodes will have a
106 * But if someone specifically setup hw.uart.console,
107 * don't override that.
111 tmp = getenv("efi_com_speed");
113 speed = strtol(tmp, NULL, 0);
114 tmp = getenv("efi_com_port");
116 tmp = getenv("comconsole_port");
118 port = strtol(tmp, NULL, 0);
119 if (speed != -1 && port != -1) {
120 snprintf(buf, sizeof(buf), "io:%d,br:%d", port,
122 env_setenv("hw.uart.console", EV_VOLATILE, buf,
133 * Copy the environment into the load area starting at (addr).
134 * Each variable is formatted as <name>=<value>, with a single nul
135 * separating each variable, and a double nul terminating the environment.
138 bi_copyenv(vm_offset_t start)
141 vm_offset_t addr, last;
146 /* Traverse the environment. */
147 for (ep = environ; ep != NULL; ep = ep->ev_next) {
148 len = strlen(ep->ev_name);
149 if ((size_t)archsw.arch_copyin(ep->ev_name, addr, len) != len)
152 if (archsw.arch_copyin("=", addr, 1) != 1)
155 if (ep->ev_value != NULL) {
156 len = strlen(ep->ev_value);
157 if ((size_t)archsw.arch_copyin(ep->ev_value, addr, len) != len)
161 if (archsw.arch_copyin("", addr, 1) != 1)
166 if (archsw.arch_copyin("", last++, 1) != 1)
172 * Copy module-related data into the load area, where it can be
173 * used as a directory for loaded modules.
175 * Module data is presented in a self-describing format. Each datum
176 * is preceded by a 32-bit identifier and a 32-bit size field.
178 * Currently, the following data are saved:
180 * MOD_NAME (variable) module name (string)
181 * MOD_TYPE (variable) module type (string)
182 * MOD_ARGS (variable) module parameters (string)
183 * MOD_ADDR sizeof(vm_offset_t) module load address
184 * MOD_SIZE sizeof(size_t) module size
185 * MOD_METADATA (variable) type-specific metadata
187 #define COPY32(v, a, c) { \
190 archsw.arch_copyin(&x, a, sizeof(x)); \
194 #define MOD_STR(t, a, s, c) { \
196 COPY32(strlen(s) + 1, a, c); \
198 archsw.arch_copyin(s, a, strlen(s) + 1); \
199 a += roundup(strlen(s) + 1, sizeof(u_long)); \
202 #define MOD_NAME(a, s, c) MOD_STR(MODINFO_NAME, a, s, c)
203 #define MOD_TYPE(a, s, c) MOD_STR(MODINFO_TYPE, a, s, c)
204 #define MOD_ARGS(a, s, c) MOD_STR(MODINFO_ARGS, a, s, c)
206 #define MOD_VAR(t, a, s, c) { \
208 COPY32(sizeof(s), a, c); \
210 archsw.arch_copyin(&s, a, sizeof(s)); \
211 a += roundup(sizeof(s), sizeof(u_long)); \
214 #define MOD_ADDR(a, s, c) MOD_VAR(MODINFO_ADDR, a, s, c)
215 #define MOD_SIZE(a, s, c) MOD_VAR(MODINFO_SIZE, a, s, c)
217 #define MOD_METADATA(a, mm, c) { \
218 COPY32(MODINFO_METADATA | mm->md_type, a, c); \
219 COPY32(mm->md_size, a, c); \
221 archsw.arch_copyin(mm->md_data, a, mm->md_size); \
222 a += roundup(mm->md_size, sizeof(u_long)); \
225 #define MOD_END(a, c) { \
226 COPY32(MODINFO_END, a, c); \
231 bi_copymodules(vm_offset_t addr)
233 struct preloaded_file *fp;
234 struct file_metadata *md;
239 /* Start with the first module on the list, should be the kernel. */
240 for (fp = file_findfile(NULL, NULL); fp != NULL; fp = fp->f_next) {
241 MOD_NAME(addr, fp->f_name, c); /* This must come first. */
242 MOD_TYPE(addr, fp->f_type, c);
244 MOD_ARGS(addr, fp->f_args, c);
247 v -= __elfN(relocation_offset);
249 MOD_ADDR(addr, v, c);
251 MOD_SIZE(addr, v, c);
252 for (md = fp->f_metadata; md != NULL; md = md->md_next)
253 if (!(md->md_type & MODINFOMD_NOCOPY))
254 MOD_METADATA(addr, md, c);
261 efi_do_vmap(EFI_MEMORY_DESCRIPTOR *mm, UINTN sz, UINTN mmsz, UINT32 mmver)
263 EFI_MEMORY_DESCRIPTOR *desc, *viter, *vmap;
265 int curr, ndesc, nset;
272 /* This isn't really an EFI error case, but pretend it is */
273 return (EFI_OUT_OF_RESOURCES);
275 for (curr = 0; curr < ndesc;
276 curr++, desc = NextMemoryDescriptor(desc, mmsz)) {
277 if ((desc->Attribute & EFI_MEMORY_RUNTIME) != 0) {
279 desc->VirtualStart = desc->PhysicalStart;
281 viter = NextMemoryDescriptor(viter, mmsz);
284 ret = RS->SetVirtualAddressMap(nset * mmsz, mmsz, mmver, vmap);
290 bi_load_efi_data(struct preloaded_file *kfp, bool exit_bs)
292 EFI_MEMORY_DESCRIPTOR *mm;
293 EFI_PHYSICAL_ADDRESS addr = 0;
295 const char *efi_novmap;
298 UINTN dsz, pages, retry, sz;
300 struct efi_map_header *efihdr;
303 #if defined(__amd64__) || defined(__aarch64__)
306 efifb.fb_addr = gfx_state.tg_fb.fb_addr;
307 efifb.fb_size = gfx_state.tg_fb.fb_size;
308 efifb.fb_height = gfx_state.tg_fb.fb_height;
309 efifb.fb_width = gfx_state.tg_fb.fb_width;
310 efifb.fb_stride = gfx_state.tg_fb.fb_stride;
311 efifb.fb_mask_red = gfx_state.tg_fb.fb_mask_red;
312 efifb.fb_mask_green = gfx_state.tg_fb.fb_mask_green;
313 efifb.fb_mask_blue = gfx_state.tg_fb.fb_mask_blue;
314 efifb.fb_mask_reserved = gfx_state.tg_fb.fb_mask_reserved;
316 printf("EFI framebuffer information:\n");
317 printf("addr, size 0x%jx, 0x%jx\n", efifb.fb_addr, efifb.fb_size);
318 printf("dimensions %d x %d\n", efifb.fb_width, efifb.fb_height);
319 printf("stride %d\n", efifb.fb_stride);
320 printf("masks 0x%08x, 0x%08x, 0x%08x, 0x%08x\n",
321 efifb.fb_mask_red, efifb.fb_mask_green, efifb.fb_mask_blue,
322 efifb.fb_mask_reserved);
324 if (efifb.fb_addr != 0)
325 file_addmetadata(kfp, MODINFOMD_EFI_FB, sizeof(efifb), &efifb);
329 efi_novmap = getenv("efi_disable_vmap");
330 if (efi_novmap != NULL)
331 do_vmap = strcasecmp(efi_novmap, "YES") != 0;
333 efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf;
336 * Assign size of EFI_MEMORY_DESCRIPTOR to keep compatible with
337 * u-boot which doesn't fill this value when buffer for memory
338 * descriptors is too small (eg. 0 to obtain memory map size)
340 dsz = sizeof(EFI_MEMORY_DESCRIPTOR);
343 * Allocate enough pages to hold the bootinfo block and the
344 * memory map EFI will return to us. The memory map has an
345 * unknown size, so we have to determine that first. Note that
346 * the AllocatePages call can itself modify the memory map, so
347 * we have to take that into account as well. The changes to
348 * the memory map are caused by splitting a range of free
349 * memory into two, so that one is marked as being loader
356 * Matthew Garrett has observed at least one system changing the
357 * memory map when calling ExitBootServices, causing it to return an
358 * error, probably because callbacks are allocating memory.
359 * So we need to retry calling it at least once.
361 for (retry = 2; retry > 0; retry--) {
363 status = BS->GetMemoryMap(&sz, mm, &efi_mapkey, &dsz, &mmver);
364 if (!EFI_ERROR(status))
367 if (status != EFI_BUFFER_TOO_SMALL) {
368 printf("%s: GetMemoryMap error %lu\n", __func__,
369 EFI_ERROR_CODE(status));
374 BS->FreePages(addr, pages);
376 /* Add 10 descriptors to the size to allow for
377 * fragmentation caused by calling AllocatePages */
379 pages = EFI_SIZE_TO_PAGES(sz + efisz);
380 status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
382 if (EFI_ERROR(status)) {
383 printf("%s: AllocatePages error %lu\n", __func__,
384 EFI_ERROR_CODE(status));
389 * Read the memory map and stash it after bootinfo. Align the
390 * memory map on a 16-byte boundary (the bootinfo block is page
393 efihdr = (struct efi_map_header *)(uintptr_t)addr;
394 mm = (void *)((uint8_t *)efihdr + efisz);
395 sz = (EFI_PAGE_SIZE * pages) - efisz;
400 status = BS->ExitBootServices(IH, efi_mapkey);
401 if (!EFI_ERROR(status)) {
402 boot_services_gone = 1;
408 BS->FreePages(addr, pages);
409 printf("ExitBootServices error %lu\n", EFI_ERROR_CODE(status));
414 * This may be disabled by setting efi_disable_vmap in
415 * loader.conf(5). By default we will setup the virtual
420 efi_do_vmap(mm, sz, dsz, mmver);
421 efihdr->memory_size = sz;
422 efihdr->descriptor_size = dsz;
423 efihdr->descriptor_version = mmver;
424 file_addmetadata(kfp, MODINFOMD_EFI_MAP, efisz + sz,
431 * Load the information expected by an amd64 kernel.
433 * - The 'boothowto' argument is constructed.
434 * - The 'bootdev' argument is constructed.
435 * - The 'bootinfo' struct is constructed, and copied into the kernel space.
436 * - The kernel environment is copied into kernel space.
437 * - Module metadata are formatted and placed in kernel space.
440 bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp, bool exit_bs)
442 struct preloaded_file *xp, *kfp;
443 struct devdesc *rootdev;
444 struct file_metadata *md;
446 uint64_t kernend, module;
451 #if defined(LOADER_FDT_SUPPORT)
459 * These metadata addreses must be converted for kernel after
463 MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND,
464 MODINFOMD_ENVP, MODINFOMD_FONT,
465 #if defined(LOADER_FDT_SUPPORT)
471 howto = bi_getboothowto(args);
474 * Allow the environment variable 'rootdev' to override the supplied
475 * device. This should perhaps go to MI code and/or have $rootdev
476 * tested/set by MI code before launching the kernel.
478 rootdevname = getenv("rootdev");
479 archsw.arch_getdev((void**)(&rootdev), rootdevname, NULL);
480 if (rootdev == NULL) {
481 printf("Can't determine root device.\n");
485 /* Try reading the /etc/fstab file to select the root device */
486 getrootmount(efi_fmtdev((void *)rootdev));
489 for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
490 if (addr < (xp->f_addr + xp->f_size))
491 addr = xp->f_addr + xp->f_size;
494 /* Pad to a page boundary. */
495 addr = roundup(addr, PAGE_SIZE);
497 addr = build_font_module(addr);
499 /* Pad to a page boundary. */
500 addr = roundup(addr, PAGE_SIZE);
502 /* Copy our environment. */
504 addr = bi_copyenv(addr);
506 /* Pad to a page boundary. */
507 addr = roundup(addr, PAGE_SIZE);
509 #if defined(LOADER_FDT_SUPPORT)
510 /* Handle device tree blob */
512 dtb_size = fdt_copy(addr);
514 /* Pad to a page boundary */
516 addr += roundup(dtb_size, PAGE_SIZE);
519 kfp = file_findfile(NULL, "elf kernel");
521 kfp = file_findfile(NULL, "elf64 kernel");
523 panic("can't find kernel file");
524 kernend = 0; /* fill it in later */
526 /* Figure out the size and location of the metadata. */
527 module = *modulep = addr;
529 file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof(howto), &howto);
530 file_addmetadata(kfp, MODINFOMD_ENVP, sizeof(envp), &envp);
531 #if defined(LOADER_FDT_SUPPORT)
533 file_addmetadata(kfp, MODINFOMD_DTBP, sizeof(dtbp), &dtbp);
535 printf("WARNING! Trying to fire up the kernel, but no "
536 "device tree blob found!\n");
538 file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof(kernend), &kernend);
539 #ifdef MODINFOMD_MODULEP
540 file_addmetadata(kfp, MODINFOMD_MODULEP, sizeof(module), &module);
542 file_addmetadata(kfp, MODINFOMD_FW_HANDLE, sizeof(ST), &ST);
543 #ifdef LOADER_GELI_SUPPORT
544 geli_export_key_metadata(kfp);
546 bi_load_efi_data(kfp, exit_bs);
548 size = bi_copymodules(0);
549 kernend = roundup(addr + size, PAGE_SIZE);
552 /* patch MODINFOMD_KERNEND */
553 md = file_findmetadata(kfp, MODINFOMD_KERNEND);
554 bcopy(&kernend, md->md_data, sizeof kernend);
557 *modulep -= __elfN(relocation_offset);
559 /* Do relocation fixup on metadata of each module. */
560 for (xp = file_findfile(NULL, NULL); xp != NULL; xp = xp->f_next) {
561 for (i = 0; i < nitems(mdt); i++) {
562 md = file_findmetadata(xp, mdt[i]);
564 bcopy(md->md_data, &vaddr, sizeof vaddr);
565 vaddr -= __elfN(relocation_offset);
566 bcopy(&vaddr, md->md_data, sizeof vaddr);
572 /* Copy module list and metadata. */
573 (void)bi_copymodules(addr);