2 * Copyright (c) 2008-2010 Rui Paulo
3 * Copyright (c) 2006 Marcel Moolenaar
6 * Copyright (c) 2016-2019 Netflix, Inc. written by M. Warner Losh
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/reboot.h>
40 #include <netinet/in.h>
41 #include <netinet/in_systm.h>
55 #include <bootstrap.h>
60 #include "loader_efi.h"
62 struct arch_switch archsw; /* MI/MD interface boundary */
64 EFI_GUID acpi = ACPI_TABLE_GUID;
65 EFI_GUID acpi20 = ACPI_20_TABLE_GUID;
66 EFI_GUID devid = DEVICE_PATH_PROTOCOL;
67 EFI_GUID imgid = LOADED_IMAGE_PROTOCOL;
68 EFI_GUID mps = MPS_TABLE_GUID;
69 EFI_GUID netid = EFI_SIMPLE_NETWORK_PROTOCOL;
70 EFI_GUID smbios = SMBIOS_TABLE_GUID;
71 EFI_GUID smbios3 = SMBIOS3_TABLE_GUID;
72 EFI_GUID dxe = DXE_SERVICES_TABLE_GUID;
73 EFI_GUID hoblist = HOB_LIST_TABLE_GUID;
74 EFI_GUID lzmadecomp = LZMA_DECOMPRESSION_GUID;
75 EFI_GUID mpcore = ARM_MP_CORE_INFO_TABLE_GUID;
76 EFI_GUID esrt = ESRT_TABLE_GUID;
77 EFI_GUID memtype = MEMORY_TYPE_INFORMATION_TABLE_GUID;
78 EFI_GUID debugimg = DEBUG_IMAGE_INFO_TABLE_GUID;
79 EFI_GUID fdtdtb = FDT_TABLE_GUID;
80 EFI_GUID inputid = SIMPLE_TEXT_INPUT_PROTOCOL;
83 * Number of seconds to wait for a keystroke before exiting with failure
84 * in the event no currdev is found. -2 means always break, -1 means
85 * never break, 0 means poll once and then reboot, > 0 means wait for
86 * that many seconds. "fail_timeout" can be set in the environment as
89 static int fail_timeout = 5;
92 * Current boot variable
97 * Image that we booted from.
99 EFI_LOADED_IMAGE *boot_img;
105 EFI_DEVICE_PATH *path;
106 EFI_HANDLE *hin, *hin_end, *walker;
111 * Find all the handles that support the SIMPLE_TEXT_INPUT_PROTOCOL and
112 * do the typical dance to get the right sized buffer.
116 status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz, 0);
117 if (status == EFI_BUFFER_TOO_SMALL) {
118 hin = (EFI_HANDLE *)malloc(sz);
119 status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz,
121 if (EFI_ERROR(status))
124 if (EFI_ERROR(status))
128 * Look at each of the handles. If it supports the device path protocol,
129 * use it to get the device path for this handle. Then see if that
130 * device path matches either the USB device path for keyboards or the
131 * legacy device path for keyboards.
133 hin_end = &hin[sz / sizeof(*hin)];
134 for (walker = hin; walker < hin_end; walker++) {
135 status = OpenProtocolByHandle(*walker, &devid, (void **)&path);
136 if (EFI_ERROR(status))
139 while (!IsDevicePathEnd(path)) {
141 * Check for the ACPI keyboard node. All PNP3xx nodes
142 * are keyboards of different flavors. Note: It is
143 * unclear of there's always a keyboard node when
144 * there's a keyboard controller, or if there's only one
145 * when a keyboard is detected at boot.
147 if (DevicePathType(path) == ACPI_DEVICE_PATH &&
148 (DevicePathSubType(path) == ACPI_DP ||
149 DevicePathSubType(path) == ACPI_EXTENDED_DP)) {
150 ACPI_HID_DEVICE_PATH *acpi;
152 acpi = (ACPI_HID_DEVICE_PATH *)(void *)path;
153 if ((EISA_ID_TO_NUM(acpi->HID) & 0xff00) == 0x300 &&
154 (acpi->HID & 0xffff) == PNP_EISA_ID_CONST) {
159 * Check for USB keyboard node, if present. Unlike a
160 * PS/2 keyboard, these definitely only appear when
161 * connected to the system.
163 } else if (DevicePathType(path) == MESSAGING_DEVICE_PATH &&
164 DevicePathSubType(path) == MSG_USB_CLASS_DP) {
165 USB_CLASS_DEVICE_PATH *usb;
167 usb = (USB_CLASS_DEVICE_PATH *)(void *)path;
168 if (usb->DeviceClass == 3 && /* HID */
169 usb->DeviceSubClass == 1 && /* Boot devices */
170 usb->DeviceProtocol == 1) { /* Boot keyboards */
175 path = NextDevicePathNode(path);
184 set_currdev(const char *devname)
188 * Don't execute hooks here; we may need to try setting these more than
189 * once here if we're probing for the ZFS pool we're supposed to boot.
190 * The currdev hook is intended to just validate user input anyways,
191 * while the loaddev hook makes it immutable once we've determined what
192 * the proper currdev is.
194 env_setenv("currdev", EV_VOLATILE | EV_NOHOOK, devname, efi_setcurrdev,
196 env_setenv("loaddev", EV_VOLATILE | EV_NOHOOK, devname, env_noset,
201 set_currdev_devdesc(struct devdesc *currdev)
205 devname = efi_fmtdev(currdev);
206 printf("Setting currdev to %s\n", devname);
207 set_currdev(devname);
211 set_currdev_devsw(struct devsw *dev, int unit)
213 struct devdesc currdev;
216 currdev.d_unit = unit;
218 set_currdev_devdesc(&currdev);
222 set_currdev_pdinfo(pdinfo_t *dp)
226 * Disks are special: they have partitions. if the parent
227 * pointer is non-null, we're a partition not a full disk
228 * and we need to adjust currdev appropriately.
230 if (dp->pd_devsw->dv_type == DEVT_DISK) {
231 struct disk_devdesc currdev;
233 currdev.dd.d_dev = dp->pd_devsw;
234 if (dp->pd_parent == NULL) {
235 currdev.dd.d_unit = dp->pd_unit;
236 currdev.d_slice = D_SLICENONE;
237 currdev.d_partition = D_PARTNONE;
239 currdev.dd.d_unit = dp->pd_parent->pd_unit;
240 currdev.d_slice = dp->pd_unit;
241 currdev.d_partition = D_PARTISGPT; /* XXX Assumes GPT */
243 set_currdev_devdesc((struct devdesc *)&currdev);
245 set_currdev_devsw(dp->pd_devsw, dp->pd_unit);
250 sanity_check_currdev(void)
254 return (stat(PATH_DEFAULTS_LOADER_CONF, &st) == 0 ||
255 #ifdef PATH_BOOTABLE_TOKEN
256 stat(PATH_BOOTABLE_TOKEN, &st) == 0 || /* non-standard layout */
258 stat(PATH_KERNEL, &st) == 0);
263 probe_zfs_currdev(uint64_t guid)
266 struct zfs_devdesc currdev;
270 currdev.dd.d_dev = &zfs_dev;
271 currdev.dd.d_unit = 0;
272 currdev.pool_guid = guid;
273 currdev.root_guid = 0;
274 set_currdev_devdesc((struct devdesc *)&currdev);
275 devname = efi_fmtdev(&currdev);
276 init_zfs_bootenv(devname);
278 rv = sanity_check_currdev();
280 buf = malloc(VDEV_PAD_SIZE);
282 if (zfs_nextboot(&currdev, buf, VDEV_PAD_SIZE) == 0) {
283 printf("zfs nextboot: %s\n", buf);
295 probe_md_currdev(void)
297 extern struct devsw md_dev;
300 set_currdev_devsw(&md_dev, 0);
301 rv = sanity_check_currdev();
303 printf("MD not present\n");
309 try_as_currdev(pdinfo_t *hd, pdinfo_t *pp)
315 * If there's a zpool on this device, try it as a ZFS
316 * filesystem, which has somewhat different setup than all
317 * other types of fs due to imperfect loader integration.
318 * This all stems from ZFS being both a device (zpool) and
319 * a filesystem, plus the boot env feature.
321 if (efizfs_get_guid_by_handle(pp->pd_handle, &guid))
322 return (probe_zfs_currdev(guid));
325 * All other filesystems just need the pdinfo
326 * initialized in the standard way.
328 set_currdev_pdinfo(pp);
329 return (sanity_check_currdev());
333 * Sometimes we get filenames that are all upper case
334 * and/or have backslashes in them. Filter all this out
335 * if it looks like we need to do so.
349 #define SIZE(dp, edp) (size_t)((intptr_t)(void *)edp - (intptr_t)(void *)dp)
351 enum { BOOT_INFO_OK = 0, BAD_CHOICE = 1, NOT_SPECIFIC = 2 };
353 match_boot_info(char *boot_info, size_t bisz)
359 EFI_DEVICE_PATH *dp, *edp, *first_dp, *last_dp;
363 FILEPATH_DEVICE_PATH *fp;
368 * FreeBSD encodes its boot loading path into the boot loader
369 * BootXXXX variable. We look for the last one in the path
370 * and use that to load the kernel. However, if we only find
371 * one DEVICE_PATH, then there's nothing specific and we should
374 * In an ideal world, we'd look at the image handle we were
375 * passed, match up with the loader we are and then return the
376 * next one in the path. This would be most flexible and cover
377 * many chain booting scenarios where you need to use this
378 * boot loader to get to the next boot loader. However, that
379 * doesn't work. We rarely have the path to the image booted
380 * (just the device) so we can't count on that. So, we do the
381 * next best thing: we look through the device path(s) passed
382 * in the BootXXXX variable. If there's only one, we return
383 * NOT_SPECIFIC. Otherwise, we look at the last one and try to
384 * load that. If we can, we return BOOT_INFO_OK. Otherwise we
385 * return BAD_CHOICE for the caller to sort out.
387 if (bisz < sizeof(attr) + sizeof(fplen) + sizeof(CHAR16))
391 memcpy(&attr, walker, sizeof(attr));
392 walker += sizeof(attr);
393 memcpy(&fplen, walker, sizeof(fplen));
394 walker += sizeof(fplen);
395 descr = (CHAR16 *)(intptr_t)walker;
396 len = ucs2len(descr);
397 walker += (len + 1) * sizeof(CHAR16);
398 last_dp = first_dp = dp = (EFI_DEVICE_PATH *)walker;
399 edp = (EFI_DEVICE_PATH *)(walker + fplen);
400 if ((char *)edp > ep)
402 while (dp < edp && SIZE(dp, edp) > sizeof(EFI_DEVICE_PATH)) {
403 text = efi_devpath_name(dp);
405 printf(" BootInfo Path: %S\n", text);
406 efi_free_devpath_name(text);
409 dp = (EFI_DEVICE_PATH *)((char *)dp + efi_devpath_length(dp));
413 * If there's only one item in the list, then nothing was
414 * specified. Or if the last path doesn't have a media
415 * path in it. Those show up as various VenHw() nodes
416 * which are basically opaque to us. Don't count those
417 * as something specifc.
419 if (last_dp == first_dp) {
420 printf("Ignoring Boot%04x: Only one DP found\n", boot_current);
423 if (efi_devpath_to_media_path(last_dp) == NULL) {
424 printf("Ignoring Boot%04x: No Media Path\n", boot_current);
429 * OK. At this point we either have a good path or a bad one.
432 pp = efiblk_get_pdinfo_by_device_path(last_dp);
434 printf("Ignoring Boot%04x: Device Path not found\n", boot_current);
437 set_currdev_pdinfo(pp);
438 if (!sanity_check_currdev()) {
439 printf("Ignoring Boot%04x: sanity check failed\n", boot_current);
444 * OK. We've found a device that matches, next we need to check the last
445 * component of the path. If it's a file, then we set the default kernel
446 * to that. Otherwise, just use this as the default root.
448 * Reminder: we're running very early, before we've parsed the defaults
449 * file, so we may need to have a hack override.
451 dp = efi_devpath_last_node(last_dp);
452 if (DevicePathType(dp) != MEDIA_DEVICE_PATH ||
453 DevicePathSubType(dp) != MEDIA_FILEPATH_DP) {
454 printf("Using Boot%04x for root partition\n", boot_current);
455 return (BOOT_INFO_OK); /* use currdir, default kernel */
457 fp = (FILEPATH_DEVICE_PATH *)dp;
458 ucs2_to_utf8(fp->PathName, &kernel);
459 if (kernel == NULL) {
460 printf("Not using Boot%04x: can't decode kernel\n", boot_current);
463 if (*kernel == '\\' || isupper(*kernel))
465 if (stat(kernel, &st) != 0) {
467 printf("Not using Boot%04x: can't find %s\n", boot_current,
471 setenv("kernel", kernel, 1);
473 text = efi_devpath_name(last_dp);
475 printf("Using Boot%04x %S + %s\n", boot_current, text,
477 efi_free_devpath_name(text);
480 return (BOOT_INFO_OK);
484 * Look at the passed-in boot_info, if any. If we find it then we need
485 * to see if we can find ourselves in the boot chain. If we can, and
486 * there's another specified thing to boot next, assume that the file
487 * is loaded from / and use that for the root filesystem. If can't
488 * find the specified thing, we must fail the boot. If we're last on
489 * the list, then we fallback to looking for the first available /
490 * candidate (ZFS, if there's a bootable zpool, otherwise a UFS
491 * partition that has either /boot/defaults/loader.conf on it or
492 * /boot/kernel/kernel (the default kernel) that we can use.
494 * We always fail if we can't find the right thing. However, as
495 * a concession to buggy UEFI implementations, like u-boot, if
496 * we have determined that the host is violating the UEFI boot
497 * manager protocol, we'll signal the rest of the program that
498 * a drop to the OK boot loader prompt is possible.
501 find_currdev(bool do_bootmgr, bool is_last,
502 char *boot_info, size_t boot_info_sz)
505 EFI_DEVICE_PATH *devpath, *copy;
515 * First choice: if rootdev is already set, use that, even if
518 rootdev = getenv("rootdev");
519 if (rootdev != NULL) {
520 printf(" Setting currdev to configured rootdev %s\n",
522 set_currdev(rootdev);
527 * Second choice: If uefi_rootdev is set, translate that UEFI device
528 * path to the loader's internal name and use that.
531 rootdev = getenv("uefi_rootdev");
534 devpath = efi_name_to_devpath(rootdev);
537 dp = efiblk_get_pdinfo_by_device_path(devpath);
538 efi_devpath_free(devpath);
541 printf(" Setting currdev to UEFI path %s\n",
543 set_currdev_pdinfo(dp);
548 * Third choice: If we can find out image boot_info, and there's
549 * a follow-on boot image in that boot_info, use that. In this
550 * case root will be the partition specified in that image and
551 * we'll load the kernel specified by the file path. Should there
552 * not be a filepath, we use the default. This filepath overrides
556 rv = match_boot_info(boot_info, boot_info_sz);
558 case BOOT_INFO_OK: /* We found it */
560 case BAD_CHOICE: /* specified file not found -> error */
561 /* XXX do we want to have an escape hatch for last in boot order? */
563 } /* Nothing specified, try normal match */
568 * Did efi_zfs_probe() detect the boot pool? If so, use the zpool
569 * it found, if it's sane. ZFS is the only thing that looks for
570 * disks and pools to boot. This may change in the future, however,
571 * if we allow specifying which pool to boot from via UEFI variables
572 * rather than the bootenv stuff that FreeBSD uses today.
574 if (pool_guid != 0) {
575 printf("Trying ZFS pool\n");
576 if (probe_zfs_currdev(pool_guid))
579 #endif /* EFI_ZFS_BOOT */
583 * If there is an embedded MD, try to use that.
585 printf("Trying MD\n");
586 if (probe_md_currdev())
588 #endif /* MD_IMAGE_SIZE */
591 * Try to find the block device by its handle based on the
592 * image we're booting. If we can't find a sane partition,
593 * search all the other partitions of the disk. We do not
594 * search other disks because it's a violation of the UEFI
595 * boot protocol to do so. We fail and let UEFI go on to
596 * the next candidate.
598 dp = efiblk_get_pdinfo_by_handle(boot_img->DeviceHandle);
600 text = efi_devpath_name(dp->pd_devpath);
602 printf("Trying ESP: %S\n", text);
603 efi_free_devpath_name(text);
605 set_currdev_pdinfo(dp);
606 if (sanity_check_currdev())
608 if (dp->pd_parent != NULL) {
609 pdinfo_t *espdp = dp;
611 STAILQ_FOREACH(pp, &dp->pd_part, pd_link) {
612 /* Already tried the ESP */
616 * Roll up the ZFS special case
617 * for those partitions that have
620 text = efi_devpath_name(pp->pd_devpath);
622 printf("Trying: %S\n", text);
623 efi_free_devpath_name(text);
625 if (try_as_currdev(dp, pp))
632 * Try the device handle from our loaded image first. If that
633 * fails, use the device path from the loaded image and see if
634 * any of the nodes in that path match one of the enumerated
635 * handles. Currently, this handle list is only for netboot.
637 if (efi_handle_lookup(boot_img->DeviceHandle, &dev, &unit, &extra) == 0) {
638 set_currdev_devsw(dev, unit);
639 if (sanity_check_currdev())
644 devpath = efi_lookup_image_devpath(IH);
645 while (devpath != NULL) {
646 h = efi_devpath_handle(devpath);
653 if (efi_handle_lookup(h, &dev, &unit, &extra) == 0) {
654 set_currdev_devsw(dev, unit);
655 if (sanity_check_currdev())
659 devpath = efi_lookup_devpath(h);
660 if (devpath != NULL) {
661 copy = efi_devpath_trim(devpath);
671 interactive_interrupt(const char *msg)
673 time_t now, then, last;
676 now = then = getsecs();
678 if (fail_timeout == -2) /* Always break to OK */
680 if (fail_timeout == -1) /* Never break to OK */
684 printf("press any key to interrupt reboot in %d seconds\r",
685 fail_timeout - (int)(now - then));
689 /* XXX no pause or timeout wait for char */
693 } while (now - then < fail_timeout);
698 parse_args(int argc, CHAR16 *argv[])
705 * Parse the args to set the console settings, etc
706 * boot1.efi passes these in, if it can read /boot.config or /boot/config
707 * or iPXE may be setup to pass these in. Or the optional argument in the
708 * boot environment was used to pass these arguments in (in which case
709 * neither /boot.config nor /boot/config are consulted).
711 * Loop through the args, and for each one that contains an '=' that is
712 * not the first character, add it to the environment. This allows
713 * loader and kernel env vars to be passed on the command line. Convert
714 * args from UCS-2 to ASCII (16 to 8 bit) as they are copied (though this
715 * method is flawed for non-ASCII characters).
718 for (i = 1; i < argc; i++) {
719 cpy16to8(argv[i], var, sizeof(var));
720 howto |= boot_parse_arg(var);
727 setenv_int(const char *key, int val)
731 snprintf(buf, sizeof(buf), "%d", val);
736 * Parse ConOut (the list of consoles active) and see if we can find a
737 * serial port and/or a video port. It would be nice to also walk the
738 * ACPI name space to map the UID for the serial port to a port. The
739 * latter is especially hard.
742 parse_uefi_con_out(void)
745 int vid_seen = 0, com_seen = 0, seen = 0;
748 EFI_DEVICE_PATH *node;
749 ACPI_HID_DEVICE_PATH *acpi;
750 UART_DEVICE_PATH *uart;
755 rv = efi_global_getenv("ConOut", buf, &sz);
756 if (rv != EFI_SUCCESS) {
757 /* If we don't have any ConOut default to serial */
762 node = (EFI_DEVICE_PATH *)buf;
763 while ((char *)node < ep) {
764 if (IsDevicePathEndType(node)) {
765 if (pci_pending && vid_seen == 0)
769 if (DevicePathType(node) == ACPI_DEVICE_PATH &&
770 DevicePathSubType(node) == ACPI_DP) {
771 /* Check for Serial node */
773 if (EISA_ID_TO_NUM(acpi->HID) == 0x501) {
774 setenv_int("efi_8250_uid", acpi->UID);
777 } else if (DevicePathType(node) == MESSAGING_DEVICE_PATH &&
778 DevicePathSubType(node) == MSG_UART_DP) {
781 setenv_int("efi_com_speed", uart->BaudRate);
782 } else if (DevicePathType(node) == ACPI_DEVICE_PATH &&
783 DevicePathSubType(node) == ACPI_ADR_DP) {
784 /* Check for AcpiAdr() Node for video */
786 } else if (DevicePathType(node) == HARDWARE_DEVICE_PATH &&
787 DevicePathSubType(node) == HW_PCI_DP) {
789 * Note, vmware fusion has a funky console device
790 * PciRoot(0x0)/Pci(0xf,0x0)
791 * which we can only detect at the end since we also
793 * PciRoot(0x0)/Pci(0x1f,0x0)/Serial(0x1)
794 * so only match it if it's last.
798 node = NextDevicePathNode(node);
802 * Truth table for RB_MULTIPLE | RB_SERIAL
804 * 0 Use only video console
805 * RB_SERIAL Use only serial console
806 * RB_MULTIPLE Use both video and serial console
807 * (but video is primary so gets rc messages)
808 * both Use both video and serial console
809 * (but serial is primary so gets rc messages)
811 * Try to honor this as best we can. If only one of serial / video
812 * found, then use that. Otherwise, use the first one we found.
813 * This also implies if we found nothing, default to video.
816 if (vid_seen && com_seen) {
818 if (com_seen < vid_seen)
827 parse_loader_efi_config(EFI_HANDLE h, const char *env_fn)
834 dp = efiblk_get_pdinfo_by_handle(h);
837 set_currdev_pdinfo(dp);
838 if (stat(env_fn, &st) != 0)
840 fd = open(env_fn, O_RDONLY);
843 env = malloc(st.st_size + 1);
846 if (read(fd, env, st.st_size) != st.st_size)
848 env[st.st_size] = '\0';
849 boot_parse_cmdline(env);
856 read_loader_env(const char *name, char *def_fn, bool once)
859 char *fn, *freeme = NULL;
863 if (efi_freebsd_getenv(name, NULL, &len) == EFI_BUFFER_TOO_SMALL) {
864 freeme = fn = malloc(len + 1);
866 if (efi_freebsd_getenv(name, fn, &len) != EFI_SUCCESS) {
870 "Can't fetch FreeBSD::%s we know is there\n", name);
873 * if tagged as 'once' delete the env variable so we
877 efi_freebsd_delenv(name);
879 * We malloced 1 more than len above, then redid the call.
880 * so now we have room at the end of the string to NUL terminate
881 * it here, even if the typical idium would have '- 1' here to
882 * not overflow. len should be the same on return both times.
888 "Can't allocate %d bytes to fetch FreeBSD::%s env var\n",
893 printf(" Reading loader env vars from %s\n", fn);
894 parse_loader_efi_config(boot_img->DeviceHandle, fn);
905 main(int argc, CHAR16 *argv[])
908 int howto, i, uhowto;
910 bool has_kbd, is_last;
912 EFI_DEVICE_PATH *imgpath;
915 size_t sz, bosz = 0, bisz = 0;
916 UINT16 boot_order[100];
917 char boot_info[4096];
921 archsw.arch_autoload = efi_autoload;
922 archsw.arch_getdev = efi_getdev;
923 archsw.arch_copyin = efi_copyin;
924 archsw.arch_copyout = efi_copyout;
926 archsw.arch_hypervisor = x86_hypervisor;
928 archsw.arch_readin = efi_readin;
929 archsw.arch_zfs_probe = efi_zfs_probe;
931 /* Get our loaded image protocol interface structure. */
932 (void) OpenProtocolByHandle(IH, &imgid, (void **)&boot_img);
935 * Chicken-and-egg problem; we want to have console output early, but
936 * some console attributes may depend on reading from eg. the boot
937 * device, which we can't do yet. We can use printf() etc. once this is
938 * done. So, we set it to the efi console, then call console init. This
939 * gets us printf early, but also primes the pump for all future console
940 * changes to take effect, regardless of where they come from.
942 setenv("console", "efi", 1);
945 /* Init the time source */
949 * Initialise the block cache. Set the upper limit.
951 bcache_init(32768, 512);
954 * Scan the BLOCK IO MEDIA handles then
955 * march through the device switch probing for things.
957 i = efipart_inithandles();
958 if (i != 0 && i != ENOENT) {
959 printf("efipart_inithandles failed with ERRNO %d, expect "
963 for (i = 0; devsw[i] != NULL; i++)
964 if (devsw[i]->dv_init != NULL)
965 (devsw[i]->dv_init)();
968 * Detect console settings two different ways: one via the command
969 * args (eg -h) or via the UEFI ConOut variable.
971 has_kbd = has_keyboard();
972 howto = parse_args(argc, argv);
973 if (!has_kbd && (howto & RB_PROBE))
974 howto |= RB_SERIAL | RB_MULTIPLE;
976 uhowto = parse_uefi_con_out();
979 * Read additional environment variables from the boot device's
980 * "LoaderEnv" file. Any boot loader environment variable may be set
981 * there, which are subtly different than loader.conf variables. Only
982 * the 'simple' ones may be set so things like foo_load="YES" won't work
983 * for two reasons. First, the parser is simplistic and doesn't grok
984 * quotes. Second, because the variables that cause an action to happen
985 * are parsed by the lua, 4th or whatever code that's not yet
986 * loaded. This is relative to the root directory when loader.efi is
987 * loaded off the UFS root drive (when chain booted), or from the ESP
988 * when directly loaded by the BIOS.
990 * We also read in NextLoaderEnv if it was specified. This allows next boot
991 * functionality to be implemented and to override anything in LoaderEnv.
993 read_loader_env("LoaderEnv", "/efi/freebsd/loader.env", false);
994 read_loader_env("NextLoaderEnv", NULL, true);
997 * We now have two notions of console. howto should be viewed as
998 * overrides. If console is already set, don't set it again.
1000 #define VIDEO_ONLY 0
1001 #define SERIAL_ONLY RB_SERIAL
1002 #define VID_SER_BOTH RB_MULTIPLE
1003 #define SER_VID_BOTH (RB_SERIAL | RB_MULTIPLE)
1004 #define CON_MASK (RB_SERIAL | RB_MULTIPLE)
1005 if (strcmp(getenv("console"), "efi") == 0) {
1006 if ((howto & CON_MASK) == 0) {
1007 /* No override, uhowto is controlling and efi cons is perfect */
1008 howto = howto | (uhowto & CON_MASK);
1009 } else if ((howto & CON_MASK) == (uhowto & CON_MASK)) {
1010 /* override matches what UEFI told us, efi console is perfect */
1011 } else if ((uhowto & (CON_MASK)) != 0) {
1013 * We detected a serial console on ConOut. All possible
1014 * overrides include serial. We can't really override what efi
1015 * gives us, so we use it knowing it's the best choice.
1020 * We detected some kind of serial in the override, but ConOut
1021 * has no serial, so we have to sort out which case it really is.
1023 switch (howto & CON_MASK) {
1025 setenv("console", "comconsole", 1);
1028 setenv("console", "efi comconsole", 1);
1031 setenv("console", "comconsole efi", 1);
1033 /* case VIDEO_ONLY can't happen -- it's the first if above */
1039 * howto is set now how we want to export the flags to the kernel, so
1040 * set the env based on it.
1042 boot_howto_to_env(howto);
1044 if (efi_copy_init()) {
1045 printf("failed to allocate staging area\n");
1046 return (EFI_BUFFER_TOO_SMALL);
1049 if ((s = getenv("fail_timeout")) != NULL)
1050 fail_timeout = strtol(s, NULL, 10);
1052 printf("%s\n", bootprog_info);
1053 printf(" Command line arguments:");
1054 for (i = 0; i < argc; i++)
1055 printf(" %S", argv[i]);
1058 printf(" Image base: 0x%lx\n", (unsigned long)boot_img->ImageBase);
1059 printf(" EFI version: %d.%02d\n", ST->Hdr.Revision >> 16,
1060 ST->Hdr.Revision & 0xffff);
1061 printf(" EFI Firmware: %S (rev %d.%02d)\n", ST->FirmwareVendor,
1062 ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
1063 printf(" Console: %s (%#x)\n", getenv("console"), howto);
1065 /* Determine the devpath of our image so we can prefer it. */
1066 text = efi_devpath_name(boot_img->FilePath);
1068 printf(" Load Path: %S\n", text);
1069 efi_setenv_freebsd_wcs("LoaderPath", text);
1070 efi_free_devpath_name(text);
1073 rv = OpenProtocolByHandle(boot_img->DeviceHandle, &devid, (void **)&imgpath);
1074 if (rv == EFI_SUCCESS) {
1075 text = efi_devpath_name(imgpath);
1077 printf(" Load Device: %S\n", text);
1078 efi_setenv_freebsd_wcs("LoaderDev", text);
1079 efi_free_devpath_name(text);
1083 if (getenv("uefi_ignore_boot_mgr") != NULL) {
1084 printf(" Ignoring UEFI boot manager\n");
1085 uefi_boot_mgr = false;
1087 uefi_boot_mgr = true;
1089 sz = sizeof(boot_current);
1090 rv = efi_global_getenv("BootCurrent", &boot_current, &sz);
1091 if (rv == EFI_SUCCESS)
1092 printf(" BootCurrent: %04x\n", boot_current);
1094 boot_current = 0xffff;
1095 uefi_boot_mgr = false;
1098 sz = sizeof(boot_order);
1099 rv = efi_global_getenv("BootOrder", &boot_order, &sz);
1100 if (rv == EFI_SUCCESS) {
1101 printf(" BootOrder:");
1102 for (i = 0; i < sz / sizeof(boot_order[0]); i++)
1103 printf(" %04x%s", boot_order[i],
1104 boot_order[i] == boot_current ? "[*]" : "");
1106 is_last = boot_order[(sz / sizeof(boot_order[0])) - 1] == boot_current;
1108 } else if (uefi_boot_mgr) {
1110 * u-boot doesn't set BootOrder, but otherwise participates in the
1111 * boot manager protocol. So we fake it here and don't consider it
1114 bosz = sizeof(boot_order[0]);
1115 boot_order[0] = boot_current;
1121 * Next, find the boot info structure the UEFI boot manager is
1122 * supposed to setup. We need this so we can walk through it to
1123 * find where we are in the booting process and what to try to
1126 if (uefi_boot_mgr) {
1127 snprintf(buf, sizeof(buf), "Boot%04X", boot_current);
1128 sz = sizeof(boot_info);
1129 rv = efi_global_getenv(buf, &boot_info, &sz);
1130 if (rv == EFI_SUCCESS)
1133 uefi_boot_mgr = false;
1137 * Disable the watchdog timer. By default the boot manager sets
1138 * the timer to 5 minutes before invoking a boot option. If we
1139 * want to return to the boot manager, we have to disable the
1140 * watchdog timer and since we're an interactive program, we don't
1141 * want to wait until the user types "quit". The timer may have
1142 * fired by then. We don't care if this fails. It does not prevent
1143 * normal functioning in any way...
1145 BS->SetWatchdogTimer(0, 0, 0, NULL);
1148 * Initialize the trusted/forbidden certificates from UEFI.
1149 * They will be later used to verify the manifest(s),
1150 * which should contain hashes of verified files.
1151 * This needs to be initialized before any configuration files
1154 #ifdef EFI_SECUREBOOT
1159 * Try and find a good currdev based on the image that was booted.
1160 * It might be desirable here to have a short pause to allow falling
1161 * through to the boot loader instead of returning instantly to follow
1162 * the boot protocol and also allow an escape hatch for users wishing
1163 * to try something different.
1165 if (find_currdev(uefi_boot_mgr, is_last, boot_info, bisz) != 0)
1166 if (uefi_boot_mgr &&
1167 !interactive_interrupt("Failed to find bootable partition"))
1168 return (EFI_NOT_FOUND);
1170 efi_init_environment();
1172 #if !defined(__arm__)
1173 for (k = 0; k < ST->NumberOfTableEntries; k++) {
1174 guid = &ST->ConfigurationTable[k].VendorGuid;
1175 if (!memcmp(guid, &smbios, sizeof(EFI_GUID))) {
1178 snprintf(buf, sizeof(buf), "%p",
1179 ST->ConfigurationTable[k].VendorTable);
1180 setenv("hint.smbios.0.mem", buf, 1);
1181 smbios_detect(ST->ConfigurationTable[k].VendorTable);
1187 interact(); /* doesn't return */
1189 return (EFI_SUCCESS); /* keep compiler happy */
1192 COMMAND_SET(poweroff, "poweroff", "power off the system", command_poweroff);
1195 command_poweroff(int argc __unused, char *argv[] __unused)
1199 for (i = 0; devsw[i] != NULL; ++i)
1200 if (devsw[i]->dv_cleanup != NULL)
1201 (devsw[i]->dv_cleanup)();
1203 RS->ResetSystem(EfiResetShutdown, EFI_SUCCESS, 0, NULL);
1209 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
1212 command_reboot(int argc, char *argv[])
1216 for (i = 0; devsw[i] != NULL; ++i)
1217 if (devsw[i]->dv_cleanup != NULL)
1218 (devsw[i]->dv_cleanup)();
1220 RS->ResetSystem(EfiResetCold, EFI_SUCCESS, 0, NULL);
1226 COMMAND_SET(quit, "quit", "exit the loader", command_quit);
1229 command_quit(int argc, char *argv[])
1235 COMMAND_SET(memmap, "memmap", "print memory map", command_memmap);
1238 command_memmap(int argc __unused, char *argv[] __unused)
1241 EFI_MEMORY_DESCRIPTOR *map, *p;
1249 status = BS->GetMemoryMap(&sz, 0, &key, &dsz, &dver);
1250 if (status != EFI_BUFFER_TOO_SMALL) {
1251 printf("Can't determine memory map size\n");
1255 status = BS->GetMemoryMap(&sz, map, &key, &dsz, &dver);
1256 if (EFI_ERROR(status)) {
1257 printf("Can't read memory map\n");
1262 snprintf(line, sizeof(line), "%23s %12s %12s %8s %4s\n",
1263 "Type", "Physical", "Virtual", "#Pages", "Attr");
1265 if (pager_output(line)) {
1270 for (i = 0, p = map; i < ndesc;
1271 i++, p = NextMemoryDescriptor(p, dsz)) {
1272 snprintf(line, sizeof(line), "%23s %012jx %012jx %08jx ",
1273 efi_memory_type(p->Type), (uintmax_t)p->PhysicalStart,
1274 (uintmax_t)p->VirtualStart, (uintmax_t)p->NumberOfPages);
1275 if (pager_output(line))
1278 if (p->Attribute & EFI_MEMORY_UC)
1280 if (p->Attribute & EFI_MEMORY_WC)
1282 if (p->Attribute & EFI_MEMORY_WT)
1284 if (p->Attribute & EFI_MEMORY_WB)
1286 if (p->Attribute & EFI_MEMORY_UCE)
1288 if (p->Attribute & EFI_MEMORY_WP)
1290 if (p->Attribute & EFI_MEMORY_RP)
1292 if (p->Attribute & EFI_MEMORY_XP)
1294 if (p->Attribute & EFI_MEMORY_NV)
1296 if (p->Attribute & EFI_MEMORY_MORE_RELIABLE)
1298 if (p->Attribute & EFI_MEMORY_RO)
1300 if (pager_output("\n"))
1308 COMMAND_SET(configuration, "configuration", "print configuration tables",
1309 command_configuration);
1312 command_configuration(int argc, char *argv[])
1317 printf("NumberOfTableEntries=%lu\n",
1318 (unsigned long)ST->NumberOfTableEntries);
1320 for (i = 0; i < ST->NumberOfTableEntries; i++) {
1324 guid = &ST->ConfigurationTable[i].VendorGuid;
1326 if (efi_guid_to_name(guid, &name) == true) {
1330 printf("Error while translating UUID to name");
1332 printf(" at %p\n", ST->ConfigurationTable[i].VendorTable);
1339 COMMAND_SET(mode, "mode", "change or display EFI text modes", command_mode);
1342 command_mode(int argc, char *argv[])
1350 SIMPLE_TEXT_OUTPUT_INTERFACE *conout;
1351 extern void HO(void);
1353 conout = ST->ConOut;
1356 mode = strtol(argv[1], &cp, 0);
1357 if (cp[0] != '\0') {
1358 printf("Invalid mode\n");
1361 status = conout->QueryMode(conout, mode, &cols, &rows);
1362 if (EFI_ERROR(status)) {
1363 printf("invalid mode %d\n", mode);
1366 status = conout->SetMode(conout, mode);
1367 if (EFI_ERROR(status)) {
1368 printf("couldn't set mode %d\n", mode);
1371 sprintf(rowenv, "%u", (unsigned)rows);
1372 setenv("LINES", rowenv, 1);
1373 HO(); /* set cursor */
1377 printf("Current mode: %d\n", conout->Mode->Mode);
1378 for (i = 0; i <= conout->Mode->MaxMode; i++) {
1379 status = conout->QueryMode(conout, i, &cols, &rows);
1380 if (EFI_ERROR(status))
1382 printf("Mode %d: %u columns, %u rows\n", i, (unsigned)cols,
1387 printf("Select a mode with the command \"mode <number>\"\n");
1392 COMMAND_SET(lsefi, "lsefi", "list EFI handles", command_lsefi);
1395 command_lsefi(int argc __unused, char *argv[] __unused)
1398 EFI_HANDLE *buffer = NULL;
1400 UINTN bufsz = 0, i, j;
1404 status = BS->LocateHandle(AllHandles, NULL, NULL, &bufsz, buffer);
1405 if (status != EFI_BUFFER_TOO_SMALL) {
1406 snprintf(command_errbuf, sizeof (command_errbuf),
1407 "unexpected error: %lld", (long long)status);
1410 if ((buffer = malloc(bufsz)) == NULL) {
1411 sprintf(command_errbuf, "out of memory");
1415 status = BS->LocateHandle(AllHandles, NULL, NULL, &bufsz, buffer);
1416 if (EFI_ERROR(status)) {
1418 snprintf(command_errbuf, sizeof (command_errbuf),
1419 "LocateHandle() error: %lld", (long long)status);
1424 for (i = 0; i < (bufsz / sizeof (EFI_HANDLE)); i++) {
1426 EFI_GUID **protocols = NULL;
1429 printf("Handle %p", handle);
1430 if (pager_output("\n"))
1434 status = BS->ProtocolsPerHandle(handle, &protocols, &nproto);
1435 if (EFI_ERROR(status)) {
1436 snprintf(command_errbuf, sizeof (command_errbuf),
1437 "ProtocolsPerHandle() error: %lld",
1442 for (j = 0; j < nproto; j++) {
1443 if (efi_guid_to_name(protocols[j], &name) == true) {
1444 printf(" %s", name);
1447 printf("Error while translating UUID to name");
1449 if ((ret = pager_output("\n")) != 0)
1452 BS->FreePool(protocols);
1461 #ifdef LOADER_FDT_SUPPORT
1462 extern int command_fdt_internal(int argc, char *argv[]);
1465 * Since proper fdt command handling function is defined in fdt_loader_cmd.c,
1466 * and declaring it as extern is in contradiction with COMMAND_SET() macro
1467 * (which uses static pointer), we're defining wrapper function, which
1468 * calls the proper fdt handling routine.
1471 command_fdt(int argc, char *argv[])
1474 return (command_fdt_internal(argc, argv));
1477 COMMAND_SET(fdt, "fdt", "flattened device tree handling", command_fdt);
1481 * Chain load another efi loader.
1484 command_chain(int argc, char *argv[])
1486 EFI_GUID LoadedImageGUID = LOADED_IMAGE_PROTOCOL;
1487 EFI_HANDLE loaderhandle;
1488 EFI_LOADED_IMAGE *loaded_image;
1491 struct devdesc *dev;
1497 command_errmsg = "wrong number of arguments";
1503 if ((fd = open(name, O_RDONLY)) < 0) {
1504 command_errmsg = "no such file";
1508 #ifdef LOADER_VERIEXEC
1509 if (verify_file(fd, name, 0, VE_MUST, __func__) < 0) {
1510 sprintf(command_errbuf, "can't verify: %s", name);
1516 if (fstat(fd, &st) < -1) {
1517 command_errmsg = "stat failed";
1522 status = BS->AllocatePool(EfiLoaderCode, (UINTN)st.st_size, &buf);
1523 if (status != EFI_SUCCESS) {
1524 command_errmsg = "failed to allocate buffer";
1528 if (read(fd, buf, st.st_size) != st.st_size) {
1529 command_errmsg = "error while reading the file";
1530 (void)BS->FreePool(buf);
1535 status = BS->LoadImage(FALSE, IH, NULL, buf, st.st_size, &loaderhandle);
1536 (void)BS->FreePool(buf);
1537 if (status != EFI_SUCCESS) {
1538 command_errmsg = "LoadImage failed";
1541 status = OpenProtocolByHandle(loaderhandle, &LoadedImageGUID,
1542 (void **)&loaded_image);
1548 for (i = 2; i < argc; i++)
1549 len += strlen(argv[i]) + 1;
1551 len *= sizeof (*argp);
1552 loaded_image->LoadOptions = argp = malloc (len);
1553 loaded_image->LoadOptionsSize = len;
1554 for (i = 2; i < argc; i++) {
1555 char *ptr = argv[i];
1557 *(argp++) = *(ptr++);
1563 if (efi_getdev((void **)&dev, name, (const char **)&path) == 0) {
1565 struct zfs_devdesc *z_dev;
1567 struct disk_devdesc *d_dev;
1570 switch (dev->d_dev->dv_type) {
1573 z_dev = (struct zfs_devdesc *)dev;
1574 loaded_image->DeviceHandle =
1575 efizfs_get_handle_by_guid(z_dev->pool_guid);
1579 loaded_image->DeviceHandle =
1580 efi_find_handle(dev->d_dev, dev->d_unit);
1583 hd = efiblk_get_pdinfo(dev);
1584 if (STAILQ_EMPTY(&hd->pd_part)) {
1585 loaded_image->DeviceHandle = hd->pd_handle;
1588 d_dev = (struct disk_devdesc *)dev;
1589 STAILQ_FOREACH(pd, &hd->pd_part, pd_link) {
1591 * d_partition should be 255
1593 if (pd->pd_unit == (uint32_t)d_dev->d_slice) {
1594 loaded_image->DeviceHandle =
1604 status = BS->StartImage(loaderhandle, NULL, NULL);
1605 if (status != EFI_SUCCESS) {
1606 command_errmsg = "StartImage failed";
1607 free(loaded_image->LoadOptions);
1608 loaded_image->LoadOptions = NULL;
1609 status = BS->UnloadImage(loaded_image);
1613 return (CMD_ERROR); /* not reached */
1616 COMMAND_SET(chain, "chain", "chain load file", command_chain);
1618 extern struct in_addr servip;
1620 command_netserver(int argc, char *argv[])
1626 command_errmsg = "wrong number of arguments";
1630 proto = netproto == NET_TFTP ? "tftp://" : "nfs://";
1631 printf("Netserver URI: %s%s%s\n", proto, intoa(rootip.s_addr),
1636 strncpy(rootpath, argv[1], sizeof(rootpath));
1637 rootpath[sizeof(rootpath) -1] = '\0';
1638 if ((rootaddr = net_parse_rootpath()) != INADDR_NONE)
1639 servip.s_addr = rootip.s_addr = rootaddr;
1642 return (CMD_ERROR); /* not reached */
1646 COMMAND_SET(netserver, "netserver", "change or display netserver URI",