2 * Copyright (c) 2008-2010 Rui Paulo
3 * Copyright (c) 2006 Marcel Moolenaar
6 * Redistribution and use in source and binary forms, with or without
7 * 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 ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/reboot.h>
46 #include <bootstrap.h>
55 #include "loader_efi.h"
57 extern char bootprog_info[];
59 struct arch_switch archsw; /* MI/MD interface boundary */
61 EFI_GUID acpi = ACPI_TABLE_GUID;
62 EFI_GUID acpi20 = ACPI_20_TABLE_GUID;
63 EFI_GUID devid = DEVICE_PATH_PROTOCOL;
64 EFI_GUID imgid = LOADED_IMAGE_PROTOCOL;
65 EFI_GUID mps = MPS_TABLE_GUID;
66 EFI_GUID netid = EFI_SIMPLE_NETWORK_PROTOCOL;
67 EFI_GUID smbios = SMBIOS_TABLE_GUID;
68 EFI_GUID smbios3 = SMBIOS3_TABLE_GUID;
69 EFI_GUID dxe = DXE_SERVICES_TABLE_GUID;
70 EFI_GUID hoblist = HOB_LIST_TABLE_GUID;
71 EFI_GUID lzmadecomp = LZMA_DECOMPRESSION_GUID;
72 EFI_GUID mpcore = ARM_MP_CORE_INFO_TABLE_GUID;
73 EFI_GUID esrt = ESRT_TABLE_GUID;
74 EFI_GUID memtype = MEMORY_TYPE_INFORMATION_TABLE_GUID;
75 EFI_GUID debugimg = DEBUG_IMAGE_INFO_TABLE_GUID;
76 EFI_GUID fdtdtb = FDT_TABLE_GUID;
77 EFI_GUID inputid = SIMPLE_TEXT_INPUT_PROTOCOL;
79 static EFI_LOADED_IMAGE *img;
83 efi_zfs_is_preferred(EFI_HANDLE *h)
85 return (h == img->DeviceHandle);
93 EFI_DEVICE_PATH *path;
94 EFI_HANDLE *hin, *hin_end, *walker;
99 * Find all the handles that support the SIMPLE_TEXT_INPUT_PROTOCOL and
100 * do the typical dance to get the right sized buffer.
104 status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz, 0);
105 if (status == EFI_BUFFER_TOO_SMALL) {
106 hin = (EFI_HANDLE *)malloc(sz);
107 status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz,
109 if (EFI_ERROR(status))
112 if (EFI_ERROR(status))
116 * Look at each of the handles. If it supports the device path protocol,
117 * use it to get the device path for this handle. Then see if that
118 * device path matches either the USB device path for keyboards or the
119 * legacy device path for keyboards.
121 hin_end = &hin[sz / sizeof(*hin)];
122 for (walker = hin; walker < hin_end; walker++) {
123 status = BS->HandleProtocol(*walker, &devid, (VOID **)&path);
124 if (EFI_ERROR(status))
127 while (!IsDevicePathEnd(path)) {
129 * Check for the ACPI keyboard node. All PNP3xx nodes
130 * are keyboards of different flavors. Note: It is
131 * unclear of there's always a keyboard node when
132 * there's a keyboard controller, or if there's only one
133 * when a keyboard is detected at boot.
135 if (DevicePathType(path) == ACPI_DEVICE_PATH &&
136 (DevicePathSubType(path) == ACPI_DP ||
137 DevicePathSubType(path) == ACPI_EXTENDED_DP)) {
138 ACPI_HID_DEVICE_PATH *acpi;
140 acpi = (ACPI_HID_DEVICE_PATH *)(void *)path;
141 if ((EISA_ID_TO_NUM(acpi->HID) & 0xff00) == 0x300 &&
142 (acpi->HID & 0xffff) == PNP_EISA_ID_CONST) {
147 * Check for USB keyboard node, if present. Unlike a
148 * PS/2 keyboard, these definitely only appear when
149 * connected to the system.
151 } else if (DevicePathType(path) == MESSAGING_DEVICE_PATH &&
152 DevicePathSubType(path) == MSG_USB_CLASS_DP) {
153 USB_CLASS_DEVICE_PATH *usb;
155 usb = (USB_CLASS_DEVICE_PATH *)(void *)path;
156 if (usb->DeviceClass == 3 && /* HID */
157 usb->DeviceSubClass == 1 && /* Boot devices */
158 usb->DeviceProtocol == 1) { /* Boot keyboards */
163 path = NextDevicePathNode(path);
172 set_devdesc_currdev(struct devsw *dev, int unit)
174 struct devdesc currdev;
178 currdev.d_type = currdev.d_dev->dv_type;
179 currdev.d_unit = unit;
180 currdev.d_opendata = NULL;
181 devname = efi_fmtdev(&currdev);
183 env_setenv("currdev", EV_VOLATILE, devname, efi_setcurrdev,
185 env_setenv("loaddev", EV_VOLATILE, devname, env_noset, env_nounset);
189 find_currdev(EFI_LOADED_IMAGE *img)
191 pdinfo_list_t *pdi_list;
193 EFI_DEVICE_PATH *devpath, *copy;
201 /* Did efi_zfs_probe() detect the boot pool? */
202 if (pool_guid != 0) {
203 struct zfs_devdesc currdev;
205 currdev.d_dev = &zfs_dev;
207 currdev.d_type = currdev.d_dev->dv_type;
208 currdev.d_opendata = NULL;
209 currdev.pool_guid = pool_guid;
210 currdev.root_guid = 0;
211 devname = efi_fmtdev(&currdev);
213 env_setenv("currdev", EV_VOLATILE, devname, efi_setcurrdev,
215 env_setenv("loaddev", EV_VOLATILE, devname, env_noset,
217 init_zfs_bootenv(devname);
220 #endif /* EFI_ZFS_BOOT */
222 /* We have device lists for hd, cd, fd, walk them all. */
223 pdi_list = efiblk_get_pdinfo_list(&efipart_hddev);
224 STAILQ_FOREACH(dp, pdi_list, pd_link) {
225 struct disk_devdesc currdev;
227 currdev.d_dev = &efipart_hddev;
228 currdev.d_type = currdev.d_dev->dv_type;
229 currdev.d_unit = dp->pd_unit;
230 currdev.d_opendata = NULL;
231 currdev.d_slice = -1;
232 currdev.d_partition = -1;
234 if (dp->pd_handle == img->DeviceHandle) {
235 devname = efi_fmtdev(&currdev);
237 env_setenv("currdev", EV_VOLATILE, devname,
238 efi_setcurrdev, env_nounset);
239 env_setenv("loaddev", EV_VOLATILE, devname,
240 env_noset, env_nounset);
243 /* Assuming GPT partitioning. */
244 STAILQ_FOREACH(pp, &dp->pd_part, pd_link) {
245 if (pp->pd_handle == img->DeviceHandle) {
246 currdev.d_slice = pp->pd_unit;
247 currdev.d_partition = 255;
248 devname = efi_fmtdev(&currdev);
250 env_setenv("currdev", EV_VOLATILE, devname,
251 efi_setcurrdev, env_nounset);
252 env_setenv("loaddev", EV_VOLATILE, devname,
253 env_noset, env_nounset);
259 pdi_list = efiblk_get_pdinfo_list(&efipart_cddev);
260 STAILQ_FOREACH(dp, pdi_list, pd_link) {
261 if (dp->pd_handle == img->DeviceHandle ||
262 dp->pd_alias == img->DeviceHandle) {
263 set_devdesc_currdev(&efipart_cddev, dp->pd_unit);
268 pdi_list = efiblk_get_pdinfo_list(&efipart_fddev);
269 STAILQ_FOREACH(dp, pdi_list, pd_link) {
270 if (dp->pd_handle == img->DeviceHandle) {
271 set_devdesc_currdev(&efipart_fddev, dp->pd_unit);
277 * Try the device handle from our loaded image first. If that
278 * fails, use the device path from the loaded image and see if
279 * any of the nodes in that path match one of the enumerated
282 if (efi_handle_lookup(img->DeviceHandle, &dev, &unit, &extra) == 0) {
283 set_devdesc_currdev(dev, unit);
288 devpath = efi_lookup_image_devpath(IH);
289 while (devpath != NULL) {
290 h = efi_devpath_handle(devpath);
297 if (efi_handle_lookup(h, &dev, &unit, &extra) == 0) {
298 set_devdesc_currdev(dev, unit);
302 devpath = efi_lookup_devpath(h);
303 if (devpath != NULL) {
304 copy = efi_devpath_trim(devpath);
314 main(int argc, CHAR16 *argv[])
318 int i, j, vargood, howto;
321 #if !defined(__arm__)
325 archsw.arch_autoload = efi_autoload;
326 archsw.arch_getdev = efi_getdev;
327 archsw.arch_copyin = efi_copyin;
328 archsw.arch_copyout = efi_copyout;
329 archsw.arch_readin = efi_readin;
331 /* Note this needs to be set before ZFS init. */
332 archsw.arch_zfs_probe = efi_zfs_probe;
335 /* Get our loaded image protocol interface structure. */
336 BS->HandleProtocol(IH, &imgid, (VOID**)&img);
338 /* Init the time source */
341 has_kbd = has_keyboard();
344 * XXX Chicken-and-egg problem; we want to have console output
345 * early, but some console attributes may depend on reading from
346 * eg. the boot device, which we can't do yet. We can use
347 * printf() etc. once this is done.
352 * Initialise the block cache. Set the upper limit.
354 bcache_init(32768, 512);
357 * Parse the args to set the console settings, etc
358 * boot1.efi passes these in, if it can read /boot.config or /boot/config
359 * or iPXE may be setup to pass these in.
361 * Loop through the args, and for each one that contains an '=' that is
362 * not the first character, add it to the environment. This allows
363 * loader and kernel env vars to be passed on the command line. Convert
364 * args from UCS-2 to ASCII (16 to 8 bit) as they are copied.
367 for (i = 1; i < argc; i++) {
368 if (argv[i][0] == '-') {
369 for (j = 1; argv[i][j] != 0; j++) {
381 howto |= RB_MULTIPLE;
394 howto |= RB_SERIAL | RB_MULTIPLE;
397 howto |= RB_DFLTROOT;
403 if (argv[i][j + 1] == 0) {
405 setenv("comconsole_speed", "115200", 1);
407 cpy16to8(&argv[i + 1][0], var,
409 setenv("comconsole_speed", var, 1);
414 cpy16to8(&argv[i][j + 1], var,
416 setenv("comconsole_speed", var, 1);
426 for (j = 0; argv[i][j] != 0; j++) {
427 if (j == sizeof(var)) {
431 if (j > 0 && argv[i][j] == '=')
433 var[j] = (char)argv[i][j];
441 for (i = 0; howto_names[i].ev != NULL; i++)
442 if (howto & howto_names[i].mask)
443 setenv(howto_names[i].ev, "YES", 1);
444 if (howto & RB_MULTIPLE) {
445 if (howto & RB_SERIAL)
446 setenv("console", "comconsole efi" , 1);
448 setenv("console", "efi comconsole" , 1);
449 } else if (howto & RB_SERIAL) {
450 setenv("console", "comconsole" , 1);
453 if (efi_copy_init()) {
454 printf("failed to allocate staging area\n");
455 return (EFI_BUFFER_TOO_SMALL);
459 * Scan the BLOCK IO MEDIA handles then
460 * march through the device switch probing for things.
462 if ((i = efipart_inithandles()) == 0) {
463 for (i = 0; devsw[i] != NULL; i++)
464 if (devsw[i]->dv_init != NULL)
465 (devsw[i]->dv_init)();
467 printf("efipart_inithandles failed %d, expect failures", i);
469 printf("Command line arguments:");
470 for (i = 0; i < argc; i++)
471 printf(" %S", argv[i]);
474 printf("Image base: 0x%lx\n", (u_long)img->ImageBase);
475 printf("EFI version: %d.%02d\n", ST->Hdr.Revision >> 16,
476 ST->Hdr.Revision & 0xffff);
477 printf("EFI Firmware: %S (rev %d.%02d)\n", ST->FirmwareVendor,
478 ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
480 printf("\n%s", bootprog_info);
483 * Disable the watchdog timer. By default the boot manager sets
484 * the timer to 5 minutes before invoking a boot option. If we
485 * want to return to the boot manager, we have to disable the
486 * watchdog timer and since we're an interactive program, we don't
487 * want to wait until the user types "quit". The timer may have
488 * fired by then. We don't care if this fails. It does not prevent
489 * normal functioning in any way...
491 BS->SetWatchdogTimer(0, 0, 0, NULL);
493 if (find_currdev(img) != 0)
494 return (EFI_NOT_FOUND);
496 efi_init_environment();
497 setenv("LINES", "24", 1); /* optional */
499 for (k = 0; k < ST->NumberOfTableEntries; k++) {
500 guid = &ST->ConfigurationTable[k].VendorGuid;
501 #if !defined(__arm__)
502 if (!memcmp(guid, &smbios, sizeof(EFI_GUID))) {
503 snprintf(buf, sizeof(buf), "%p",
504 ST->ConfigurationTable[k].VendorTable);
505 setenv("hint.smbios.0.mem", buf, 1);
506 smbios_detect(ST->ConfigurationTable[k].VendorTable);
512 interact(); /* doesn't return */
514 return (EFI_SUCCESS); /* keep compiler happy */
517 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
520 command_reboot(int argc, char *argv[])
524 for (i = 0; devsw[i] != NULL; ++i)
525 if (devsw[i]->dv_cleanup != NULL)
526 (devsw[i]->dv_cleanup)();
528 RS->ResetSystem(EfiResetCold, EFI_SUCCESS, 0, NULL);
534 COMMAND_SET(quit, "quit", "exit the loader", command_quit);
537 command_quit(int argc, char *argv[])
543 COMMAND_SET(memmap, "memmap", "print memory map", command_memmap);
546 command_memmap(int argc, char *argv[])
549 EFI_MEMORY_DESCRIPTOR *map, *p;
555 static char *types[] = {
561 "RuntimeServicesCode",
562 "RuntimeServicesData",
563 "ConventionalMemory",
568 "MemoryMappedIOPortSpace",
573 status = BS->GetMemoryMap(&sz, 0, &key, &dsz, &dver);
574 if (status != EFI_BUFFER_TOO_SMALL) {
575 printf("Can't determine memory map size\n");
579 status = BS->GetMemoryMap(&sz, map, &key, &dsz, &dver);
580 if (EFI_ERROR(status)) {
581 printf("Can't read memory map\n");
586 snprintf(line, sizeof(line), "%23s %12s %12s %8s %4s\n",
587 "Type", "Physical", "Virtual", "#Pages", "Attr");
589 if (pager_output(line)) {
594 for (i = 0, p = map; i < ndesc;
595 i++, p = NextMemoryDescriptor(p, dsz)) {
596 printf("%23s %012jx %012jx %08jx ", types[p->Type],
597 (uintmax_t)p->PhysicalStart, (uintmax_t)p->VirtualStart,
598 (uintmax_t)p->NumberOfPages);
599 if (p->Attribute & EFI_MEMORY_UC)
601 if (p->Attribute & EFI_MEMORY_WC)
603 if (p->Attribute & EFI_MEMORY_WT)
605 if (p->Attribute & EFI_MEMORY_WB)
607 if (p->Attribute & EFI_MEMORY_UCE)
609 if (p->Attribute & EFI_MEMORY_WP)
611 if (p->Attribute & EFI_MEMORY_RP)
613 if (p->Attribute & EFI_MEMORY_XP)
615 if (pager_output("\n"))
623 COMMAND_SET(configuration, "configuration", "print configuration tables",
624 command_configuration);
627 guid_to_string(EFI_GUID *guid)
631 sprintf(buf, "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
632 guid->Data1, guid->Data2, guid->Data3, guid->Data4[0],
633 guid->Data4[1], guid->Data4[2], guid->Data4[3], guid->Data4[4],
634 guid->Data4[5], guid->Data4[6], guid->Data4[7]);
639 command_configuration(int argc, char *argv[])
644 snprintf(line, sizeof(line), "NumberOfTableEntries=%lu\n",
645 (unsigned long)ST->NumberOfTableEntries);
647 if (pager_output(line)) {
652 for (i = 0; i < ST->NumberOfTableEntries; i++) {
656 guid = &ST->ConfigurationTable[i].VendorGuid;
657 if (!memcmp(guid, &mps, sizeof(EFI_GUID)))
659 else if (!memcmp(guid, &acpi, sizeof(EFI_GUID)))
660 printf("ACPI Table");
661 else if (!memcmp(guid, &acpi20, sizeof(EFI_GUID)))
662 printf("ACPI 2.0 Table");
663 else if (!memcmp(guid, &smbios, sizeof(EFI_GUID)))
664 printf("SMBIOS Table %p",
665 ST->ConfigurationTable[i].VendorTable);
666 else if (!memcmp(guid, &smbios3, sizeof(EFI_GUID)))
667 printf("SMBIOS3 Table");
668 else if (!memcmp(guid, &dxe, sizeof(EFI_GUID)))
670 else if (!memcmp(guid, &hoblist, sizeof(EFI_GUID)))
671 printf("HOB List Table");
672 else if (!memcmp(guid, &lzmadecomp, sizeof(EFI_GUID)))
673 printf("LZMA Compression");
674 else if (!memcmp(guid, &mpcore, sizeof(EFI_GUID)))
675 printf("ARM MpCore Information Table");
676 else if (!memcmp(guid, &esrt, sizeof(EFI_GUID)))
677 printf("ESRT Table");
678 else if (!memcmp(guid, &memtype, sizeof(EFI_GUID)))
679 printf("Memory Type Information Table");
680 else if (!memcmp(guid, &debugimg, sizeof(EFI_GUID)))
681 printf("Debug Image Info Table");
682 else if (!memcmp(guid, &fdtdtb, sizeof(EFI_GUID)))
685 printf("Unknown Table (%s)", guid_to_string(guid));
686 snprintf(line, sizeof(line), " at %p\n",
687 ST->ConfigurationTable[i].VendorTable);
688 if (pager_output(line))
697 COMMAND_SET(mode, "mode", "change or display EFI text modes", command_mode);
700 command_mode(int argc, char *argv[])
708 SIMPLE_TEXT_OUTPUT_INTERFACE *conout;
709 extern void HO(void);
714 mode = strtol(argv[1], &cp, 0);
716 printf("Invalid mode\n");
719 status = conout->QueryMode(conout, mode, &cols, &rows);
720 if (EFI_ERROR(status)) {
721 printf("invalid mode %d\n", mode);
724 status = conout->SetMode(conout, mode);
725 if (EFI_ERROR(status)) {
726 printf("couldn't set mode %d\n", mode);
729 sprintf(rowenv, "%u", (unsigned)rows);
730 setenv("LINES", rowenv, 1);
731 HO(); /* set cursor */
735 printf("Current mode: %d\n", conout->Mode->Mode);
736 for (i = 0; i <= conout->Mode->MaxMode; i++) {
737 status = conout->QueryMode(conout, i, &cols, &rows);
738 if (EFI_ERROR(status))
740 printf("Mode %d: %u columns, %u rows\n", i, (unsigned)cols,
745 printf("Select a mode with the command \"mode <number>\"\n");
750 #ifdef LOADER_FDT_SUPPORT
751 extern int command_fdt_internal(int argc, char *argv[]);
754 * Since proper fdt command handling function is defined in fdt_loader_cmd.c,
755 * and declaring it as extern is in contradiction with COMMAND_SET() macro
756 * (which uses static pointer), we're defining wrapper function, which
757 * calls the proper fdt handling routine.
760 command_fdt(int argc, char *argv[])
763 return (command_fdt_internal(argc, argv));
766 COMMAND_SET(fdt, "fdt", "flattened device tree handling", command_fdt);
770 * Chain load another efi loader.
773 command_chain(int argc, char *argv[])
775 EFI_GUID LoadedImageGUID = LOADED_IMAGE_PROTOCOL;
776 EFI_HANDLE loaderhandle;
777 EFI_LOADED_IMAGE *loaded_image;
786 command_errmsg = "wrong number of arguments";
792 if ((fd = open(name, O_RDONLY)) < 0) {
793 command_errmsg = "no such file";
797 if (fstat(fd, &st) < -1) {
798 command_errmsg = "stat failed";
803 status = BS->AllocatePool(EfiLoaderCode, (UINTN)st.st_size, &buf);
804 if (status != EFI_SUCCESS) {
805 command_errmsg = "failed to allocate buffer";
809 if (read(fd, buf, st.st_size) != st.st_size) {
810 command_errmsg = "error while reading the file";
811 (void)BS->FreePool(buf);
816 status = BS->LoadImage(FALSE, IH, NULL, buf, st.st_size, &loaderhandle);
817 (void)BS->FreePool(buf);
818 if (status != EFI_SUCCESS) {
819 command_errmsg = "LoadImage failed";
822 status = BS->HandleProtocol(loaderhandle, &LoadedImageGUID,
823 (void **)&loaded_image);
829 for (i = 2; i < argc; i++)
830 len += strlen(argv[i]) + 1;
832 len *= sizeof (*argp);
833 loaded_image->LoadOptions = argp = malloc (len);
834 loaded_image->LoadOptionsSize = len;
835 for (i = 2; i < argc; i++) {
838 *(argp++) = *(ptr++);
844 if (efi_getdev((void **)&dev, name, (const char **)&path) == 0) {
846 struct zfs_devdesc *z_dev;
848 struct disk_devdesc *d_dev;
851 switch (dev->d_type) {
854 z_dev = (struct zfs_devdesc *)dev;
855 loaded_image->DeviceHandle =
856 efizfs_get_handle_by_guid(z_dev->pool_guid);
860 loaded_image->DeviceHandle =
861 efi_find_handle(dev->d_dev, dev->d_unit);
864 hd = efiblk_get_pdinfo(dev);
865 if (STAILQ_EMPTY(&hd->pd_part)) {
866 loaded_image->DeviceHandle = hd->pd_handle;
869 d_dev = (struct disk_devdesc *)dev;
870 STAILQ_FOREACH(pd, &hd->pd_part, pd_link) {
872 * d_partition should be 255
874 if (pd->pd_unit == (uint32_t)d_dev->d_slice) {
875 loaded_image->DeviceHandle =
885 status = BS->StartImage(loaderhandle, NULL, NULL);
886 if (status != EFI_SUCCESS) {
887 command_errmsg = "StartImage failed";
888 free(loaded_image->LoadOptions);
889 loaded_image->LoadOptions = NULL;
890 status = BS->UnloadImage(loaded_image);
894 return (CMD_ERROR); /* not reached */
897 COMMAND_SET(chain, "chain", "chain load file", command_chain);