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>
50 #include "bootstrap.h"
53 #if defined(__amd64__)
54 #include <machine/specialreg.h>
58 #include "loader_efi.h"
62 #if defined(LOADER_FDT_SUPPORT)
63 #include <fdt_platform.h>
66 #ifdef LOADER_GELI_SUPPORT
70 int bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp,
74 bi_getboothowto(char *kargs)
85 howto = boot_parse_cmdline(kargs);
86 howto |= boot_env_to_howto();
88 console = getenv("console");
89 if (console != NULL) {
90 if (strcmp(console, "comconsole") == 0)
92 if (strcmp(console, "nullconsole") == 0)
95 #if defined(__i386__) || defined(__amd64__)
96 if (strcmp(console, "efi") == 0 &&
97 getenv("efi_8250_uid") != NULL &&
98 getenv("hw.uart.console") == NULL) {
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
113 * But if someone specifically setup hw.uart.console,
114 * don't override that.
118 tmp = getenv("efi_com_speed");
120 speed = strtol(tmp, NULL, 0);
121 tmp = getenv("efi_com_port");
123 tmp = getenv("comconsole_port");
125 port = strtol(tmp, NULL, 0);
126 if (speed != -1 && port != -1) {
127 snprintf(buf, sizeof(buf), "io:%d,br:%d", port,
129 env_setenv("hw.uart.console", EV_VOLATILE, buf,
142 efi_do_vmap(EFI_MEMORY_DESCRIPTOR *mm, UINTN sz, UINTN mmsz, UINT32 mmver)
144 EFI_MEMORY_DESCRIPTOR *desc, *viter, *vmap;
146 int curr, ndesc, nset;
153 /* This isn't really an EFI error case, but pretend it is */
154 return (EFI_OUT_OF_RESOURCES);
156 for (curr = 0; curr < ndesc;
157 curr++, desc = NextMemoryDescriptor(desc, mmsz)) {
158 if ((desc->Attribute & EFI_MEMORY_RUNTIME) != 0) {
160 desc->VirtualStart = desc->PhysicalStart;
162 viter = NextMemoryDescriptor(viter, mmsz);
165 ret = RS->SetVirtualAddressMap(nset * mmsz, mmsz, mmver, vmap);
171 bi_load_efi_data(struct preloaded_file *kfp, bool exit_bs)
173 EFI_MEMORY_DESCRIPTOR *mm;
174 EFI_PHYSICAL_ADDRESS addr = 0;
176 const char *efi_novmap;
179 UINTN dsz, pages, retry, sz;
181 struct efi_map_header *efihdr;
184 #if defined(__amd64__) || defined(__aarch64__)
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;
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);
208 file_addmetadata(kfp, MODINFOMD_EFI_FB, sizeof(efifb), &efifb);
213 efi_novmap = getenv("efi_disable_vmap");
214 if (efi_novmap != NULL)
215 do_vmap = strcasecmp(efi_novmap, "YES") != 0;
217 efisz = (sizeof(struct efi_map_header) + 0xf) & ~0xf;
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)
224 dsz = sizeof(EFI_MEMORY_DESCRIPTOR);
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
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.
246 for (retry = 2; retry > 0; retry--) {
248 status = BS->GetMemoryMap(&sz, mm, &efi_mapkey, &dsz, &mmver);
249 if (!EFI_ERROR(status))
252 if (status != EFI_BUFFER_TOO_SMALL) {
253 printf("%s: GetMemoryMap error %lu\n", __func__,
254 EFI_ERROR_CODE(status));
259 BS->FreePages(addr, pages);
261 /* Add 10 descriptors to the size to allow for
262 * fragmentation caused by calling AllocatePages */
264 pages = EFI_SIZE_TO_PAGES(sz + efisz);
265 status = BS->AllocatePages(AllocateAnyPages, EfiLoaderData,
267 if (EFI_ERROR(status)) {
268 printf("%s: AllocatePages error %lu\n", __func__,
269 EFI_ERROR_CODE(status));
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
278 efihdr = (struct efi_map_header *)(uintptr_t)addr;
279 mm = (void *)((uint8_t *)efihdr + efisz);
280 sz = (EFI_PAGE_SIZE * pages) - efisz;
285 status = efi_exit_boot_services(efi_mapkey);
286 if (!EFI_ERROR(status))
291 BS->FreePages(addr, pages);
292 printf("ExitBootServices error %lu\n", EFI_ERROR_CODE(status));
297 * This may be disabled by setting efi_disable_vmap in
298 * loader.conf(5). By default we will setup the virtual
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,
315 * Load the information expected by an amd64 kernel.
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.
324 bi_load(char *args, vm_offset_t *modulep, vm_offset_t *kernendp, bool exit_bs)
326 struct preloaded_file *xp, *kfp;
327 struct devdesc *rootdev;
328 struct file_metadata *md;
330 uint64_t kernend, module;
335 bool is64 = sizeof(long) == 8;
336 #if defined(LOADER_FDT_SUPPORT)
344 * These metadata addreses must be converted for kernel after
348 MODINFOMD_SSYM, MODINFOMD_ESYM, MODINFOMD_KERNEND,
349 MODINFOMD_ENVP, MODINFOMD_FONT,
350 #if defined(LOADER_FDT_SUPPORT)
355 howto = bi_getboothowto(args);
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.
362 rootdevname = getenv("rootdev");
363 archsw.arch_getdev((void**)(&rootdev), rootdevname, NULL);
364 if (rootdev == NULL) {
365 printf("Can't determine root device.\n");
369 /* Try reading the /etc/fstab file to select the root device */
370 getrootmount(devformat(rootdev));
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;
378 /* Pad to a page boundary. */
379 addr = roundup(addr, PAGE_SIZE);
381 addr = build_font_module(addr);
383 /* Pad to a page boundary. */
384 addr = roundup(addr, PAGE_SIZE);
386 /* Copy our environment. */
388 addr = md_copyenv(addr);
390 /* Pad to a page boundary. */
391 addr = roundup(addr, PAGE_SIZE);
393 #if defined(LOADER_FDT_SUPPORT)
394 /* Handle device tree blob */
396 dtb_size = fdt_copy(addr);
398 /* Pad to a page boundary */
400 addr += roundup(dtb_size, PAGE_SIZE);
403 kfp = file_findfile(NULL, "elf kernel");
405 kfp = file_findfile(NULL, "elf64 kernel");
407 panic("can't find kernel file");
408 kernend = 0; /* fill it in later */
410 /* Figure out the size and location of the metadata. */
411 module = *modulep = addr;
413 file_addmetadata(kfp, MODINFOMD_HOWTO, sizeof(howto), &howto);
414 file_addmetadata(kfp, MODINFOMD_ENVP, sizeof(envp), &envp);
415 #if defined(LOADER_FDT_SUPPORT)
417 file_addmetadata(kfp, MODINFOMD_DTBP, sizeof(dtbp), &dtbp);
419 printf("WARNING! Trying to fire up the kernel, but no "
420 "device tree blob found!\n");
422 file_addmetadata(kfp, MODINFOMD_KERNEND, sizeof(kernend), &kernend);
423 #ifdef MODINFOMD_MODULEP
424 file_addmetadata(kfp, MODINFOMD_MODULEP, sizeof(module), &module);
427 file_addmetadata(kfp, MODINFOMD_FW_HANDLE, sizeof(ST), &ST);
429 #ifdef LOADER_GELI_SUPPORT
430 geli_export_key_metadata(kfp);
433 bi_load_efi_data(kfp, exit_bs);
438 size = md_copymodules(0, is64); /* Find the size of the modules */
439 kernend = roundup(addr + size, PAGE_SIZE);
442 /* patch MODINFOMD_KERNEND */
443 md = file_findmetadata(kfp, MODINFOMD_KERNEND);
444 bcopy(&kernend, md->md_data, sizeof kernend);
447 *modulep -= __elfN(relocation_offset);
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]);
454 bcopy(md->md_data, &vaddr, sizeof vaddr);
455 vaddr -= __elfN(relocation_offset);
456 bcopy(&vaddr, md->md_data, sizeof vaddr);
462 /* Copy module list and metadata. */
463 (void)md_copymodules(addr, is64);