]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - stand/efi/loader/main.c
MFV r361280:
[FreeBSD/FreeBSD.git] / stand / efi / loader / main.c
1 /*-
2  * Copyright (c) 2008-2010 Rui Paulo
3  * Copyright (c) 2006 Marcel Moolenaar
4  * All rights reserved.
5  *
6  * Copyright (c) 2016-2019 Netflix, Inc. written by M. Warner Losh
7  * 
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
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.
17  *
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.
28  */
29
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32
33 #include <stand.h>
34
35 #include <sys/disk.h>
36 #include <sys/param.h>
37 #include <sys/reboot.h>
38 #include <sys/boot.h>
39 #include <paths.h>
40 #include <stdint.h>
41 #include <string.h>
42 #include <setjmp.h>
43 #include <disk.h>
44
45 #include <efi.h>
46 #include <efilib.h>
47 #include <efichar.h>
48
49 #include <uuid.h>
50
51 #include <bootstrap.h>
52 #include <smbios.h>
53
54 #include "efizfs.h"
55
56 #include "loader_efi.h"
57
58 struct arch_switch archsw;      /* MI/MD interface boundary */
59
60 EFI_GUID acpi = ACPI_TABLE_GUID;
61 EFI_GUID acpi20 = ACPI_20_TABLE_GUID;
62 EFI_GUID devid = DEVICE_PATH_PROTOCOL;
63 EFI_GUID imgid = LOADED_IMAGE_PROTOCOL;
64 EFI_GUID mps = MPS_TABLE_GUID;
65 EFI_GUID netid = EFI_SIMPLE_NETWORK_PROTOCOL;
66 EFI_GUID smbios = SMBIOS_TABLE_GUID;
67 EFI_GUID smbios3 = SMBIOS3_TABLE_GUID;
68 EFI_GUID dxe = DXE_SERVICES_TABLE_GUID;
69 EFI_GUID hoblist = HOB_LIST_TABLE_GUID;
70 EFI_GUID lzmadecomp = LZMA_DECOMPRESSION_GUID;
71 EFI_GUID mpcore = ARM_MP_CORE_INFO_TABLE_GUID;
72 EFI_GUID esrt = ESRT_TABLE_GUID;
73 EFI_GUID memtype = MEMORY_TYPE_INFORMATION_TABLE_GUID;
74 EFI_GUID debugimg = DEBUG_IMAGE_INFO_TABLE_GUID;
75 EFI_GUID fdtdtb = FDT_TABLE_GUID;
76 EFI_GUID inputid = SIMPLE_TEXT_INPUT_PROTOCOL;
77
78 /*
79  * Number of seconds to wait for a keystroke before exiting with failure
80  * in the event no currdev is found. -2 means always break, -1 means
81  * never break, 0 means poll once and then reboot, > 0 means wait for
82  * that many seconds. "fail_timeout" can be set in the environment as
83  * well.
84  */
85 static int fail_timeout = 5;
86
87 /*
88  * Current boot variable
89  */
90 UINT16 boot_current;
91
92 /*
93  * Image that we booted from.
94  */
95 EFI_LOADED_IMAGE *boot_img;
96
97 static bool
98 has_keyboard(void)
99 {
100         EFI_STATUS status;
101         EFI_DEVICE_PATH *path;
102         EFI_HANDLE *hin, *hin_end, *walker;
103         UINTN sz;
104         bool retval = false;
105
106         /*
107          * Find all the handles that support the SIMPLE_TEXT_INPUT_PROTOCOL and
108          * do the typical dance to get the right sized buffer.
109          */
110         sz = 0;
111         hin = NULL;
112         status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz, 0);
113         if (status == EFI_BUFFER_TOO_SMALL) {
114                 hin = (EFI_HANDLE *)malloc(sz);
115                 status = BS->LocateHandle(ByProtocol, &inputid, 0, &sz,
116                     hin);
117                 if (EFI_ERROR(status))
118                         free(hin);
119         }
120         if (EFI_ERROR(status))
121                 return retval;
122
123         /*
124          * Look at each of the handles. If it supports the device path protocol,
125          * use it to get the device path for this handle. Then see if that
126          * device path matches either the USB device path for keyboards or the
127          * legacy device path for keyboards.
128          */
129         hin_end = &hin[sz / sizeof(*hin)];
130         for (walker = hin; walker < hin_end; walker++) {
131                 status = OpenProtocolByHandle(*walker, &devid, (void **)&path);
132                 if (EFI_ERROR(status))
133                         continue;
134
135                 while (!IsDevicePathEnd(path)) {
136                         /*
137                          * Check for the ACPI keyboard node. All PNP3xx nodes
138                          * are keyboards of different flavors. Note: It is
139                          * unclear of there's always a keyboard node when
140                          * there's a keyboard controller, or if there's only one
141                          * when a keyboard is detected at boot.
142                          */
143                         if (DevicePathType(path) == ACPI_DEVICE_PATH &&
144                             (DevicePathSubType(path) == ACPI_DP ||
145                                 DevicePathSubType(path) == ACPI_EXTENDED_DP)) {
146                                 ACPI_HID_DEVICE_PATH  *acpi;
147
148                                 acpi = (ACPI_HID_DEVICE_PATH *)(void *)path;
149                                 if ((EISA_ID_TO_NUM(acpi->HID) & 0xff00) == 0x300 &&
150                                     (acpi->HID & 0xffff) == PNP_EISA_ID_CONST) {
151                                         retval = true;
152                                         goto out;
153                                 }
154                         /*
155                          * Check for USB keyboard node, if present. Unlike a
156                          * PS/2 keyboard, these definitely only appear when
157                          * connected to the system.
158                          */
159                         } else if (DevicePathType(path) == MESSAGING_DEVICE_PATH &&
160                             DevicePathSubType(path) == MSG_USB_CLASS_DP) {
161                                 USB_CLASS_DEVICE_PATH *usb;
162
163                                 usb = (USB_CLASS_DEVICE_PATH *)(void *)path;
164                                 if (usb->DeviceClass == 3 && /* HID */
165                                     usb->DeviceSubClass == 1 && /* Boot devices */
166                                     usb->DeviceProtocol == 1) { /* Boot keyboards */
167                                         retval = true;
168                                         goto out;
169                                 }
170                         }
171                         path = NextDevicePathNode(path);
172                 }
173         }
174 out:
175         free(hin);
176         return retval;
177 }
178
179 static void
180 set_currdev(const char *devname)
181 {
182
183         /*
184          * Don't execute hooks here; we may need to try setting these more than
185          * once here if we're probing for the ZFS pool we're supposed to boot.
186          * The currdev hook is intended to just validate user input anyways,
187          * while the loaddev hook makes it immutable once we've determined what
188          * the proper currdev is.
189          */
190         env_setenv("currdev", EV_VOLATILE | EV_NOHOOK, devname, efi_setcurrdev,
191             env_nounset);
192         env_setenv("loaddev", EV_VOLATILE | EV_NOHOOK, devname, env_noset,
193             env_nounset);
194 }
195
196 static void
197 set_currdev_devdesc(struct devdesc *currdev)
198 {
199         const char *devname;
200
201         devname = efi_fmtdev(currdev);
202         printf("Setting currdev to %s\n", devname);
203         set_currdev(devname);
204 }
205
206 static void
207 set_currdev_devsw(struct devsw *dev, int unit)
208 {
209         struct devdesc currdev;
210
211         currdev.d_dev = dev;
212         currdev.d_unit = unit;
213
214         set_currdev_devdesc(&currdev);
215 }
216
217 static void
218 set_currdev_pdinfo(pdinfo_t *dp)
219 {
220
221         /*
222          * Disks are special: they have partitions. if the parent
223          * pointer is non-null, we're a partition not a full disk
224          * and we need to adjust currdev appropriately.
225          */
226         if (dp->pd_devsw->dv_type == DEVT_DISK) {
227                 struct disk_devdesc currdev;
228
229                 currdev.dd.d_dev = dp->pd_devsw;
230                 if (dp->pd_parent == NULL) {
231                         currdev.dd.d_unit = dp->pd_unit;
232                         currdev.d_slice = D_SLICENONE;
233                         currdev.d_partition = D_PARTNONE;
234                 } else {
235                         currdev.dd.d_unit = dp->pd_parent->pd_unit;
236                         currdev.d_slice = dp->pd_unit;
237                         currdev.d_partition = D_PARTISGPT; /* XXX Assumes GPT */
238                 }
239                 set_currdev_devdesc((struct devdesc *)&currdev);
240         } else {
241                 set_currdev_devsw(dp->pd_devsw, dp->pd_unit);
242         }
243 }
244
245 static bool
246 sanity_check_currdev(void)
247 {
248         struct stat st;
249
250         return (stat(PATH_DEFAULTS_LOADER_CONF, &st) == 0 ||
251 #ifdef PATH_BOOTABLE_TOKEN
252             stat(PATH_BOOTABLE_TOKEN, &st) == 0 || /* non-standard layout */
253 #endif
254             stat(PATH_KERNEL, &st) == 0);
255 }
256
257 #ifdef EFI_ZFS_BOOT
258 static bool
259 probe_zfs_currdev(uint64_t guid)
260 {
261         char *devname;
262         struct zfs_devdesc currdev;
263
264         currdev.dd.d_dev = &zfs_dev;
265         currdev.dd.d_unit = 0;
266         currdev.pool_guid = guid;
267         currdev.root_guid = 0;
268         set_currdev_devdesc((struct devdesc *)&currdev);
269         devname = efi_fmtdev(&currdev);
270         init_zfs_bootenv(devname);
271
272         return (sanity_check_currdev());
273 }
274 #endif
275
276 static bool
277 try_as_currdev(pdinfo_t *hd, pdinfo_t *pp)
278 {
279         uint64_t guid;
280
281 #ifdef EFI_ZFS_BOOT
282         /*
283          * If there's a zpool on this device, try it as a ZFS
284          * filesystem, which has somewhat different setup than all
285          * other types of fs due to imperfect loader integration.
286          * This all stems from ZFS being both a device (zpool) and
287          * a filesystem, plus the boot env feature.
288          */
289         if (efizfs_get_guid_by_handle(pp->pd_handle, &guid))
290                 return (probe_zfs_currdev(guid));
291 #endif
292         /*
293          * All other filesystems just need the pdinfo
294          * initialized in the standard way.
295          */
296         set_currdev_pdinfo(pp);
297         return (sanity_check_currdev());
298 }
299
300 /*
301  * Sometimes we get filenames that are all upper case
302  * and/or have backslashes in them. Filter all this out
303  * if it looks like we need to do so.
304  */
305 static void
306 fix_dosisms(char *p)
307 {
308         while (*p) {
309                 if (isupper(*p))
310                         *p = tolower(*p);
311                 else if (*p == '\\')
312                         *p = '/';
313                 p++;
314         }
315 }
316
317 #define SIZE(dp, edp) (size_t)((intptr_t)(void *)edp - (intptr_t)(void *)dp)
318
319 enum { BOOT_INFO_OK = 0, BAD_CHOICE = 1, NOT_SPECIFIC = 2  };
320 static int
321 match_boot_info(char *boot_info, size_t bisz)
322 {
323         uint32_t attr;
324         uint16_t fplen;
325         size_t len;
326         char *walker, *ep;
327         EFI_DEVICE_PATH *dp, *edp, *first_dp, *last_dp;
328         pdinfo_t *pp;
329         CHAR16 *descr;
330         char *kernel = NULL;
331         FILEPATH_DEVICE_PATH  *fp;
332         struct stat st;
333         CHAR16 *text;
334
335         /*
336          * FreeBSD encodes it's boot loading path into the boot loader
337          * BootXXXX variable. We look for the last one in the path
338          * and use that to load the kernel. However, if we only fine
339          * one DEVICE_PATH, then there's nothing specific and we should
340          * fall back.
341          *
342          * In an ideal world, we'd look at the image handle we were
343          * passed, match up with the loader we are and then return the
344          * next one in the path. This would be most flexible and cover
345          * many chain booting scenarios where you need to use this
346          * boot loader to get to the next boot loader. However, that
347          * doesn't work. We rarely have the path to the image booted
348          * (just the device) so we can't count on that. So, we do the
349          * enxt best thing, we look through the device path(s) passed
350          * in the BootXXXX varaible. If there's only one, we return
351          * NOT_SPECIFIC. Otherwise, we look at the last one and try to
352          * load that. If we can, we return BOOT_INFO_OK. Otherwise we
353          * return BAD_CHOICE for the caller to sort out.
354          */
355         if (bisz < sizeof(attr) + sizeof(fplen) + sizeof(CHAR16))
356                 return NOT_SPECIFIC;
357         walker = boot_info;
358         ep = walker + bisz;
359         memcpy(&attr, walker, sizeof(attr));
360         walker += sizeof(attr);
361         memcpy(&fplen, walker, sizeof(fplen));
362         walker += sizeof(fplen);
363         descr = (CHAR16 *)(intptr_t)walker;
364         len = ucs2len(descr);
365         walker += (len + 1) * sizeof(CHAR16);
366         last_dp = first_dp = dp = (EFI_DEVICE_PATH *)walker;
367         edp = (EFI_DEVICE_PATH *)(walker + fplen);
368         if ((char *)edp > ep)
369                 return NOT_SPECIFIC;
370         while (dp < edp && SIZE(dp, edp) > sizeof(EFI_DEVICE_PATH)) {
371                 text = efi_devpath_name(dp);
372                 if (text != NULL) {
373                         printf("   BootInfo Path: %S\n", text);
374                         efi_free_devpath_name(text);
375                 }
376                 last_dp = dp;
377                 dp = (EFI_DEVICE_PATH *)((char *)dp + efi_devpath_length(dp));
378         }
379
380         /*
381          * If there's only one item in the list, then nothing was
382          * specified. Or if the last path doesn't have a media
383          * path in it. Those show up as various VenHw() nodes
384          * which are basically opaque to us. Don't count those
385          * as something specifc.
386          */
387         if (last_dp == first_dp) {
388                 printf("Ignoring Boot%04x: Only one DP found\n", boot_current);
389                 return NOT_SPECIFIC;
390         }
391         if (efi_devpath_to_media_path(last_dp) == NULL) {
392                 printf("Ignoring Boot%04x: No Media Path\n", boot_current);
393                 return NOT_SPECIFIC;
394         }
395
396         /*
397          * OK. At this point we either have a good path or a bad one.
398          * Let's check.
399          */
400         pp = efiblk_get_pdinfo_by_device_path(last_dp);
401         if (pp == NULL) {
402                 printf("Ignoring Boot%04x: Device Path not found\n", boot_current);
403                 return BAD_CHOICE;
404         }
405         set_currdev_pdinfo(pp);
406         if (!sanity_check_currdev()) {
407                 printf("Ignoring Boot%04x: sanity check failed\n", boot_current);
408                 return BAD_CHOICE;
409         }
410
411         /*
412          * OK. We've found a device that matches, next we need to check the last
413          * component of the path. If it's a file, then we set the default kernel
414          * to that. Otherwise, just use this as the default root.
415          *
416          * Reminder: we're running very early, before we've parsed the defaults
417          * file, so we may need to have a hack override.
418          */
419         dp = efi_devpath_last_node(last_dp);
420         if (DevicePathType(dp) !=  MEDIA_DEVICE_PATH ||
421             DevicePathSubType(dp) != MEDIA_FILEPATH_DP) {
422                 printf("Using Boot%04x for root partition\n", boot_current);
423                 return (BOOT_INFO_OK);          /* use currdir, default kernel */
424         }
425         fp = (FILEPATH_DEVICE_PATH *)dp;
426         ucs2_to_utf8(fp->PathName, &kernel);
427         if (kernel == NULL) {
428                 printf("Not using Boot%04x: can't decode kernel\n", boot_current);
429                 return (BAD_CHOICE);
430         }
431         if (*kernel == '\\' || isupper(*kernel))
432                 fix_dosisms(kernel);
433         if (stat(kernel, &st) != 0) {
434                 free(kernel);
435                 printf("Not using Boot%04x: can't find %s\n", boot_current,
436                     kernel);
437                 return (BAD_CHOICE);
438         }
439         setenv("kernel", kernel, 1);
440         free(kernel);
441         text = efi_devpath_name(last_dp);
442         if (text) {
443                 printf("Using Boot%04x %S + %s\n", boot_current, text,
444                     kernel);
445                 efi_free_devpath_name(text);
446         }
447
448         return (BOOT_INFO_OK);
449 }
450
451 /*
452  * Look at the passed-in boot_info, if any. If we find it then we need
453  * to see if we can find ourselves in the boot chain. If we can, and
454  * there's another specified thing to boot next, assume that the file
455  * is loaded from / and use that for the root filesystem. If can't
456  * find the specified thing, we must fail the boot. If we're last on
457  * the list, then we fallback to looking for the first available /
458  * candidate (ZFS, if there's a bootable zpool, otherwise a UFS
459  * partition that has either /boot/defaults/loader.conf on it or
460  * /boot/kernel/kernel (the default kernel) that we can use.
461  *
462  * We always fail if we can't find the right thing. However, as
463  * a concession to buggy UEFI implementations, like u-boot, if
464  * we have determined that the host is violating the UEFI boot
465  * manager protocol, we'll signal the rest of the program that
466  * a drop to the OK boot loader prompt is possible.
467  */
468 static int
469 find_currdev(bool do_bootmgr, bool is_last,
470     char *boot_info, size_t boot_info_sz)
471 {
472         pdinfo_t *dp, *pp;
473         EFI_DEVICE_PATH *devpath, *copy;
474         EFI_HANDLE h;
475         CHAR16 *text;
476         struct devsw *dev;
477         int unit;
478         uint64_t extra;
479         int rv;
480         char *rootdev;
481
482         /*
483          * First choice: if rootdev is already set, use that, even if
484          * it's wrong.
485          */
486         rootdev = getenv("rootdev");
487         if (rootdev != NULL) {
488                 printf("    Setting currdev to configured rootdev %s\n",
489                     rootdev);
490                 set_currdev(rootdev);
491                 return (0);
492         }
493
494         /*
495          * Second choice: If uefi_rootdev is set, translate that UEFI device
496          * path to the loader's internal name and use that.
497          */
498         do {
499                 rootdev = getenv("uefi_rootdev");
500                 if (rootdev == NULL)
501                         break;
502                 devpath = efi_name_to_devpath(rootdev);
503                 if (devpath == NULL)
504                         break;
505                 dp = efiblk_get_pdinfo_by_device_path(devpath);
506                 efi_devpath_free(devpath);
507                 if (dp == NULL)
508                         break;
509                 printf("    Setting currdev to UEFI path %s\n",
510                     rootdev);
511                 set_currdev_pdinfo(dp);
512                 return (0);
513         } while (0);
514
515         /*
516          * Third choice: If we can find out image boot_info, and there's
517          * a follow-on boot image in that boot_info, use that. In this
518          * case root will be the partition specified in that image and
519          * we'll load the kernel specified by the file path. Should there
520          * not be a filepath, we use the default. This filepath overrides
521          * loader.conf.
522          */
523         if (do_bootmgr) {
524                 rv = match_boot_info(boot_info, boot_info_sz);
525                 switch (rv) {
526                 case BOOT_INFO_OK:      /* We found it */
527                         return (0);
528                 case BAD_CHOICE:        /* specified file not found -> error */
529                         /* XXX do we want to have an escape hatch for last in boot order? */
530                         return (ENOENT);
531                 } /* Nothing specified, try normal match */
532         }
533
534 #ifdef EFI_ZFS_BOOT
535         /*
536          * Did efi_zfs_probe() detect the boot pool? If so, use the zpool
537          * it found, if it's sane. ZFS is the only thing that looks for
538          * disks and pools to boot. This may change in the future, however,
539          * if we allow specifying which pool to boot from via UEFI variables
540          * rather than the bootenv stuff that FreeBSD uses today.
541          */
542         if (pool_guid != 0) {
543                 printf("Trying ZFS pool\n");
544                 if (probe_zfs_currdev(pool_guid))
545                         return (0);
546         }
547 #endif /* EFI_ZFS_BOOT */
548
549         /*
550          * Try to find the block device by its handle based on the
551          * image we're booting. If we can't find a sane partition,
552          * search all the other partitions of the disk. We do not
553          * search other disks because it's a violation of the UEFI
554          * boot protocol to do so. We fail and let UEFI go on to
555          * the next candidate.
556          */
557         dp = efiblk_get_pdinfo_by_handle(boot_img->DeviceHandle);
558         if (dp != NULL) {
559                 text = efi_devpath_name(dp->pd_devpath);
560                 if (text != NULL) {
561                         printf("Trying ESP: %S\n", text);
562                         efi_free_devpath_name(text);
563                 }
564                 set_currdev_pdinfo(dp);
565                 if (sanity_check_currdev())
566                         return (0);
567                 if (dp->pd_parent != NULL) {
568                         pdinfo_t *espdp = dp;
569                         dp = dp->pd_parent;
570                         STAILQ_FOREACH(pp, &dp->pd_part, pd_link) {
571                                 /* Already tried the ESP */
572                                 if (espdp == pp)
573                                         continue;
574                                 /*
575                                  * Roll up the ZFS special case
576                                  * for those partitions that have
577                                  * zpools on them.
578                                  */
579                                 text = efi_devpath_name(pp->pd_devpath);
580                                 if (text != NULL) {
581                                         printf("Trying: %S\n", text);
582                                         efi_free_devpath_name(text);
583                                 }
584                                 if (try_as_currdev(dp, pp))
585                                         return (0);
586                         }
587                 }
588         }
589
590         /*
591          * Try the device handle from our loaded image first.  If that
592          * fails, use the device path from the loaded image and see if
593          * any of the nodes in that path match one of the enumerated
594          * handles. Currently, this handle list is only for netboot.
595          */
596         if (efi_handle_lookup(boot_img->DeviceHandle, &dev, &unit, &extra) == 0) {
597                 set_currdev_devsw(dev, unit);
598                 if (sanity_check_currdev())
599                         return (0);
600         }
601
602         copy = NULL;
603         devpath = efi_lookup_image_devpath(IH);
604         while (devpath != NULL) {
605                 h = efi_devpath_handle(devpath);
606                 if (h == NULL)
607                         break;
608
609                 free(copy);
610                 copy = NULL;
611
612                 if (efi_handle_lookup(h, &dev, &unit, &extra) == 0) {
613                         set_currdev_devsw(dev, unit);
614                         if (sanity_check_currdev())
615                                 return (0);
616                 }
617
618                 devpath = efi_lookup_devpath(h);
619                 if (devpath != NULL) {
620                         copy = efi_devpath_trim(devpath);
621                         devpath = copy;
622                 }
623         }
624         free(copy);
625
626         return (ENOENT);
627 }
628
629 static bool
630 interactive_interrupt(const char *msg)
631 {
632         time_t now, then, last;
633
634         last = 0;
635         now = then = getsecs();
636         printf("%s\n", msg);
637         if (fail_timeout == -2)         /* Always break to OK */
638                 return (true);
639         if (fail_timeout == -1)         /* Never break to OK */
640                 return (false);
641         do {
642                 if (last != now) {
643                         printf("press any key to interrupt reboot in %d seconds\r",
644                             fail_timeout - (int)(now - then));
645                         last = now;
646                 }
647
648                 /* XXX no pause or timeout wait for char */
649                 if (ischar())
650                         return (true);
651                 now = getsecs();
652         } while (now - then < fail_timeout);
653         return (false);
654 }
655
656 static int
657 parse_args(int argc, CHAR16 *argv[])
658 {
659         int i, j, howto;
660         bool vargood;
661         char var[128];
662
663         /*
664          * Parse the args to set the console settings, etc
665          * boot1.efi passes these in, if it can read /boot.config or /boot/config
666          * or iPXE may be setup to pass these in. Or the optional argument in the
667          * boot environment was used to pass these arguments in (in which case
668          * neither /boot.config nor /boot/config are consulted).
669          *
670          * Loop through the args, and for each one that contains an '=' that is
671          * not the first character, add it to the environment.  This allows
672          * loader and kernel env vars to be passed on the command line.  Convert
673          * args from UCS-2 to ASCII (16 to 8 bit) as they are copied (though this
674          * method is flawed for non-ASCII characters).
675          */
676         howto = 0;
677         for (i = 1; i < argc; i++) {
678                 cpy16to8(argv[i], var, sizeof(var));
679                 howto |= boot_parse_arg(var);
680         }
681
682         return (howto);
683 }
684
685 static void
686 setenv_int(const char *key, int val)
687 {
688         char buf[20];
689
690         snprintf(buf, sizeof(buf), "%d", val);
691         setenv(key, buf, 1);
692 }
693
694 /*
695  * Parse ConOut (the list of consoles active) and see if we can find a
696  * serial port and/or a video port. It would be nice to also walk the
697  * ACPI name space to map the UID for the serial port to a port. The
698  * latter is especially hard.
699  */
700 int
701 parse_uefi_con_out(void)
702 {
703         int how, rv;
704         int vid_seen = 0, com_seen = 0, seen = 0;
705         size_t sz;
706         char buf[4096], *ep;
707         EFI_DEVICE_PATH *node;
708         ACPI_HID_DEVICE_PATH  *acpi;
709         UART_DEVICE_PATH  *uart;
710         bool pci_pending;
711
712         how = 0;
713         sz = sizeof(buf);
714         rv = efi_global_getenv("ConOut", buf, &sz);
715         if (rv != EFI_SUCCESS) {
716                 /* If we don't have any ConOut default to serial */
717                 how = RB_SERIAL;
718                 goto out;
719         }
720         ep = buf + sz;
721         node = (EFI_DEVICE_PATH *)buf;
722         while ((char *)node < ep) {
723                 pci_pending = false;
724                 if (DevicePathType(node) == ACPI_DEVICE_PATH &&
725                     (DevicePathSubType(node) == ACPI_DP ||
726                     DevicePathSubType(node) == ACPI_EXTENDED_DP)) {
727                         /* Check for Serial node */
728                         acpi = (void *)node;
729                         if (EISA_ID_TO_NUM(acpi->HID) == 0x501) {
730                                 setenv_int("efi_8250_uid", acpi->UID);
731                                 com_seen = ++seen;
732                         }
733                 } else if (DevicePathType(node) == MESSAGING_DEVICE_PATH &&
734                     DevicePathSubType(node) == MSG_UART_DP) {
735                         com_seen = ++seen;
736                         uart = (void *)node;
737                         setenv_int("efi_com_speed", uart->BaudRate);
738                 } else if (DevicePathType(node) == ACPI_DEVICE_PATH &&
739                     DevicePathSubType(node) == ACPI_ADR_DP) {
740                         /* Check for AcpiAdr() Node for video */
741                         vid_seen = ++seen;
742                 } else if (DevicePathType(node) == HARDWARE_DEVICE_PATH &&
743                     DevicePathSubType(node) == HW_PCI_DP) {
744                         /*
745                          * Note, vmware fusion has a funky console device
746                          *      PciRoot(0x0)/Pci(0xf,0x0)
747                          * which we can only detect at the end since we also
748                          * have to cope with:
749                          *      PciRoot(0x0)/Pci(0x1f,0x0)/Serial(0x1)
750                          * so only match it if it's last.
751                          */
752                         pci_pending = true;
753                 }
754                 node = NextDevicePathNode(node);
755         }
756         if (pci_pending && vid_seen == 0)
757                 vid_seen = ++seen;
758
759         /*
760          * Truth table for RB_MULTIPLE | RB_SERIAL
761          * Value                Result
762          * 0                    Use only video console
763          * RB_SERIAL            Use only serial console
764          * RB_MULTIPLE          Use both video and serial console
765          *                      (but video is primary so gets rc messages)
766          * both                 Use both video and serial console
767          *                      (but serial is primary so gets rc messages)
768          *
769          * Try to honor this as best we can. If only one of serial / video
770          * found, then use that. Otherwise, use the first one we found.
771          * This also implies if we found nothing, default to video.
772          */
773         how = 0;
774         if (vid_seen && com_seen) {
775                 how |= RB_MULTIPLE;
776                 if (com_seen < vid_seen)
777                         how |= RB_SERIAL;
778         } else if (com_seen)
779                 how |= RB_SERIAL;
780 out:
781         return (how);
782 }
783
784 void
785 parse_loader_efi_config(EFI_HANDLE h, const char *env_fn)
786 {
787         pdinfo_t *dp;
788         struct stat st;
789         int fd = -1;
790         char *env = NULL;
791
792         dp = efiblk_get_pdinfo_by_handle(h);
793         if (dp == NULL)
794                 return;
795         set_currdev_pdinfo(dp);
796         if (stat(env_fn, &st) != 0)
797                 return;
798         fd = open(env_fn, O_RDONLY);
799         if (fd == -1)
800                 return;
801         env = malloc(st.st_size + 1);
802         if (env == NULL)
803                 goto out;
804         if (read(fd, env, st.st_size) != st.st_size)
805                 goto out;
806         env[st.st_size] = '\0';
807         boot_parse_cmdline(env);
808 out:
809         free(env);
810         close(fd);
811 }
812
813 static void
814 read_loader_env(const char *name, char *def_fn, bool once)
815 {
816         UINTN len;
817         char *fn, *freeme = NULL;
818
819         len = 0;
820         fn = def_fn;
821         if (efi_freebsd_getenv(name, NULL, &len) == EFI_BUFFER_TOO_SMALL) {
822                 freeme = fn = malloc(len + 1);
823                 if (fn != NULL) {
824                         if (efi_freebsd_getenv(name, fn, &len) != EFI_SUCCESS) {
825                                 free(fn);
826                                 fn = NULL;
827                                 printf(
828                             "Can't fetch FreeBSD::%s we know is there\n", name);
829                         } else {
830                                 /*
831                                  * if tagged as 'once' delete the env variable so we
832                                  * only use it once.
833                                  */
834                                 if (once)
835                                         efi_freebsd_delenv(name);
836                                 /*
837                                  * We malloced 1 more than len above, then redid the call.
838                                  * so now we have room at the end of the string to NUL terminate
839                                  * it here, even if the typical idium would have '- 1' here to
840                                  * not overflow. len should be the same on return both times.
841                                  */
842                                 fn[len] = '\0';
843                         }
844                 } else {
845                         printf(
846                     "Can't allocate %d bytes to fetch FreeBSD::%s env var\n",
847                             len, name);
848                 }
849         }
850         if (fn) {
851                 printf("    Reading loader env vars from %s\n", fn);
852                 parse_loader_efi_config(boot_img->DeviceHandle, fn);
853         }
854 }
855
856 caddr_t
857 ptov(uintptr_t x)
858 {
859         return ((caddr_t)x);
860 }
861
862 EFI_STATUS
863 main(int argc, CHAR16 *argv[])
864 {
865         EFI_GUID *guid;
866         int howto, i, uhowto;
867         UINTN k;
868         bool has_kbd, is_last;
869         char *s;
870         EFI_DEVICE_PATH *imgpath;
871         CHAR16 *text;
872         EFI_STATUS rv;
873         size_t sz, bosz = 0, bisz = 0;
874         UINT16 boot_order[100];
875         char boot_info[4096];
876         char buf[32];
877         bool uefi_boot_mgr;
878
879         archsw.arch_autoload = efi_autoload;
880         archsw.arch_getdev = efi_getdev;
881         archsw.arch_copyin = efi_copyin;
882         archsw.arch_copyout = efi_copyout;
883 #ifdef __amd64__
884         archsw.arch_hypervisor = x86_hypervisor;
885 #endif
886         archsw.arch_readin = efi_readin;
887         archsw.arch_zfs_probe = efi_zfs_probe;
888
889         /* Get our loaded image protocol interface structure. */
890         (void) OpenProtocolByHandle(IH, &imgid, (void **)&boot_img);
891
892         /*
893          * Chicken-and-egg problem; we want to have console output early, but
894          * some console attributes may depend on reading from eg. the boot
895          * device, which we can't do yet.  We can use printf() etc. once this is
896          * done. So, we set it to the efi console, then call console init. This
897          * gets us printf early, but also primes the pump for all future console
898          * changes to take effect, regardless of where they come from.
899          */
900         setenv("console", "efi", 1);
901         uhowto = parse_uefi_con_out();
902 #if defined(__aarch64__) || defined(__arm__)
903         if ((uhowto & RB_SERIAL) != 0)
904                 setenv("console", "comconsole", 1);
905 #endif
906         cons_probe();
907
908         /* Init the time source */
909         efi_time_init();
910
911         /*
912          * Initialise the block cache. Set the upper limit.
913          */
914         bcache_init(32768, 512);
915
916         /*
917          * Scan the BLOCK IO MEDIA handles then
918          * march through the device switch probing for things.
919          */
920         i = efipart_inithandles();
921         if (i != 0 && i != ENOENT) {
922                 printf("efipart_inithandles failed with ERRNO %d, expect "
923                     "failures\n", i);
924         }
925
926         for (i = 0; devsw[i] != NULL; i++)
927                 if (devsw[i]->dv_init != NULL)
928                         (devsw[i]->dv_init)();
929
930         /*
931          * Detect console settings two different ways: one via the command
932          * args (eg -h) or via the UEFI ConOut variable.
933          */
934         has_kbd = has_keyboard();
935         howto = parse_args(argc, argv);
936         if (!has_kbd && (howto & RB_PROBE))
937                 howto |= RB_SERIAL | RB_MULTIPLE;
938         howto &= ~RB_PROBE;
939
940         /*
941          * Read additional environment variables from the boot device's
942          * "LoaderEnv" file. Any boot loader environment variable may be set
943          * there, which are subtly different than loader.conf variables. Only
944          * the 'simple' ones may be set so things like foo_load="YES" won't work
945          * for two reasons.  First, the parser is simplistic and doesn't grok
946          * quotes.  Second, because the variables that cause an action to happen
947          * are parsed by the lua, 4th or whatever code that's not yet
948          * loaded. This is relative to the root directory when loader.efi is
949          * loaded off the UFS root drive (when chain booted), or from the ESP
950          * when directly loaded by the BIOS.
951          *
952          * We also read in NextLoaderEnv if it was specified. This allows next boot
953          * functionality to be implemented and to override anything in LoaderEnv.
954          */
955         read_loader_env("LoaderEnv", "/efi/freebsd/loader.env", false);
956         read_loader_env("NextLoaderEnv", NULL, true);
957
958         /*
959          * We now have two notions of console. howto should be viewed as
960          * overrides. If console is already set, don't set it again.
961          */
962 #define VIDEO_ONLY      0
963 #define SERIAL_ONLY     RB_SERIAL
964 #define VID_SER_BOTH    RB_MULTIPLE
965 #define SER_VID_BOTH    (RB_SERIAL | RB_MULTIPLE)
966 #define CON_MASK        (RB_SERIAL | RB_MULTIPLE)
967         if (strcmp(getenv("console"), "efi") == 0) {
968                 if ((howto & CON_MASK) == 0) {
969                         /* No override, uhowto is controlling and efi cons is perfect */
970                         howto = howto | (uhowto & CON_MASK);
971                 } else if ((howto & CON_MASK) == (uhowto & CON_MASK)) {
972                         /* override matches what UEFI told us, efi console is perfect */
973                 } else if ((uhowto & (CON_MASK)) != 0) {
974                         /*
975                          * We detected a serial console on ConOut. All possible
976                          * overrides include serial. We can't really override what efi
977                          * gives us, so we use it knowing it's the best choice.
978                          */
979                         /* Do nothing */
980                 } else {
981                         /*
982                          * We detected some kind of serial in the override, but ConOut
983                          * has no serial, so we have to sort out which case it really is.
984                          */
985                         switch (howto & CON_MASK) {
986                         case SERIAL_ONLY:
987                                 setenv("console", "comconsole", 1);
988                                 break;
989                         case VID_SER_BOTH:
990                                 setenv("console", "efi comconsole", 1);
991                                 break;
992                         case SER_VID_BOTH:
993                                 setenv("console", "comconsole efi", 1);
994                                 break;
995                                 /* case VIDEO_ONLY can't happen -- it's the first if above */
996                         }
997                 }
998         }
999
1000         /*
1001          * howto is set now how we want to export the flags to the kernel, so
1002          * set the env based on it.
1003          */
1004         boot_howto_to_env(howto);
1005
1006         if (efi_copy_init()) {
1007                 printf("failed to allocate staging area\n");
1008                 return (EFI_BUFFER_TOO_SMALL);
1009         }
1010
1011         if ((s = getenv("fail_timeout")) != NULL)
1012                 fail_timeout = strtol(s, NULL, 10);
1013
1014         printf("%s\n", bootprog_info);
1015         printf("   Command line arguments:");
1016         for (i = 0; i < argc; i++)
1017                 printf(" %S", argv[i]);
1018         printf("\n");
1019
1020         printf("   Image base: 0x%lx\n", (unsigned long)boot_img->ImageBase);
1021         printf("   EFI version: %d.%02d\n", ST->Hdr.Revision >> 16,
1022             ST->Hdr.Revision & 0xffff);
1023         printf("   EFI Firmware: %S (rev %d.%02d)\n", ST->FirmwareVendor,
1024             ST->FirmwareRevision >> 16, ST->FirmwareRevision & 0xffff);
1025         printf("   Console: %s (%#x)\n", getenv("console"), howto);
1026
1027         /* Determine the devpath of our image so we can prefer it. */
1028         text = efi_devpath_name(boot_img->FilePath);
1029         if (text != NULL) {
1030                 printf("   Load Path: %S\n", text);
1031                 efi_setenv_freebsd_wcs("LoaderPath", text);
1032                 efi_free_devpath_name(text);
1033         }
1034
1035         rv = OpenProtocolByHandle(boot_img->DeviceHandle, &devid,
1036             (void **)&imgpath);
1037         if (rv == EFI_SUCCESS) {
1038                 text = efi_devpath_name(imgpath);
1039                 if (text != NULL) {
1040                         printf("   Load Device: %S\n", text);
1041                         efi_setenv_freebsd_wcs("LoaderDev", text);
1042                         efi_free_devpath_name(text);
1043                 }
1044         }
1045
1046         if (getenv("uefi_ignore_boot_mgr") != NULL) {
1047                 printf("    Ignoring UEFI boot manager\n");
1048                 uefi_boot_mgr = false;
1049         } else {
1050                 uefi_boot_mgr = true;
1051                 boot_current = 0;
1052                 sz = sizeof(boot_current);
1053                 rv = efi_global_getenv("BootCurrent", &boot_current, &sz);
1054                 if (rv == EFI_SUCCESS)
1055                         printf("   BootCurrent: %04x\n", boot_current);
1056                 else {
1057                         boot_current = 0xffff;
1058                         uefi_boot_mgr = false;
1059                 }
1060
1061                 sz = sizeof(boot_order);
1062                 rv = efi_global_getenv("BootOrder", &boot_order, &sz);
1063                 if (rv == EFI_SUCCESS) {
1064                         printf("   BootOrder:");
1065                         for (i = 0; i < sz / sizeof(boot_order[0]); i++)
1066                                 printf(" %04x%s", boot_order[i],
1067                                     boot_order[i] == boot_current ? "[*]" : "");
1068                         printf("\n");
1069                         is_last = boot_order[(sz / sizeof(boot_order[0])) - 1] == boot_current;
1070                         bosz = sz;
1071                 } else if (uefi_boot_mgr) {
1072                         /*
1073                          * u-boot doesn't set BootOrder, but otherwise participates in the
1074                          * boot manager protocol. So we fake it here and don't consider it
1075                          * a failure.
1076                          */
1077                         bosz = sizeof(boot_order[0]);
1078                         boot_order[0] = boot_current;
1079                         is_last = true;
1080                 }
1081         }
1082
1083         /*
1084          * Next, find the boot info structure the UEFI boot manager is
1085          * supposed to setup. We need this so we can walk through it to
1086          * find where we are in the booting process and what to try to
1087          * boot next.
1088          */
1089         if (uefi_boot_mgr) {
1090                 snprintf(buf, sizeof(buf), "Boot%04X", boot_current);
1091                 sz = sizeof(boot_info);
1092                 rv = efi_global_getenv(buf, &boot_info, &sz);
1093                 if (rv == EFI_SUCCESS)
1094                         bisz = sz;
1095                 else
1096                         uefi_boot_mgr = false;
1097         }
1098
1099         /*
1100          * Disable the watchdog timer. By default the boot manager sets
1101          * the timer to 5 minutes before invoking a boot option. If we
1102          * want to return to the boot manager, we have to disable the
1103          * watchdog timer and since we're an interactive program, we don't
1104          * want to wait until the user types "quit". The timer may have
1105          * fired by then. We don't care if this fails. It does not prevent
1106          * normal functioning in any way...
1107          */
1108         BS->SetWatchdogTimer(0, 0, 0, NULL);
1109
1110         /*
1111          * Initialize the trusted/forbidden certificates from UEFI.
1112          * They will be later used to verify the manifest(s),
1113          * which should contain hashes of verified files.
1114          * This needs to be initialized before any configuration files
1115          * are loaded.
1116          */
1117 #ifdef EFI_SECUREBOOT
1118         ve_efi_init();
1119 #endif
1120
1121         /*
1122          * Try and find a good currdev based on the image that was booted.
1123          * It might be desirable here to have a short pause to allow falling
1124          * through to the boot loader instead of returning instantly to follow
1125          * the boot protocol and also allow an escape hatch for users wishing
1126          * to try something different.
1127          */
1128         if (find_currdev(uefi_boot_mgr, is_last, boot_info, bisz) != 0)
1129                 if (uefi_boot_mgr &&
1130                     !interactive_interrupt("Failed to find bootable partition"))
1131                         return (EFI_NOT_FOUND);
1132
1133         efi_init_environment();
1134
1135 #if !defined(__arm__)
1136         for (k = 0; k < ST->NumberOfTableEntries; k++) {
1137                 guid = &ST->ConfigurationTable[k].VendorGuid;
1138                 if (!memcmp(guid, &smbios, sizeof(EFI_GUID))) {
1139                         char buf[40];
1140
1141                         snprintf(buf, sizeof(buf), "%p",
1142                             ST->ConfigurationTable[k].VendorTable);
1143                         setenv("hint.smbios.0.mem", buf, 1);
1144                         smbios_detect(ST->ConfigurationTable[k].VendorTable);
1145                         break;
1146                 }
1147         }
1148 #endif
1149
1150         interact();                     /* doesn't return */
1151
1152         return (EFI_SUCCESS);           /* keep compiler happy */
1153 }
1154
1155 COMMAND_SET(poweroff, "poweroff", "power off the system", command_poweroff);
1156
1157 static int
1158 command_poweroff(int argc __unused, char *argv[] __unused)
1159 {
1160         int i;
1161
1162         for (i = 0; devsw[i] != NULL; ++i)
1163                 if (devsw[i]->dv_cleanup != NULL)
1164                         (devsw[i]->dv_cleanup)();
1165
1166         RS->ResetSystem(EfiResetShutdown, EFI_SUCCESS, 0, NULL);
1167
1168         /* NOTREACHED */
1169         return (CMD_ERROR);
1170 }
1171
1172 COMMAND_SET(reboot, "reboot", "reboot the system", command_reboot);
1173
1174 static int
1175 command_reboot(int argc, char *argv[])
1176 {
1177         int i;
1178
1179         for (i = 0; devsw[i] != NULL; ++i)
1180                 if (devsw[i]->dv_cleanup != NULL)
1181                         (devsw[i]->dv_cleanup)();
1182
1183         RS->ResetSystem(EfiResetCold, EFI_SUCCESS, 0, NULL);
1184
1185         /* NOTREACHED */
1186         return (CMD_ERROR);
1187 }
1188
1189 COMMAND_SET(quit, "quit", "exit the loader", command_quit);
1190
1191 static int
1192 command_quit(int argc, char *argv[])
1193 {
1194         exit(0);
1195         return (CMD_OK);
1196 }
1197
1198 COMMAND_SET(memmap, "memmap", "print memory map", command_memmap);
1199
1200 static int
1201 command_memmap(int argc __unused, char *argv[] __unused)
1202 {
1203         UINTN sz;
1204         EFI_MEMORY_DESCRIPTOR *map, *p;
1205         UINTN key, dsz;
1206         UINT32 dver;
1207         EFI_STATUS status;
1208         int i, ndesc;
1209         char line[80];
1210
1211         sz = 0;
1212         status = BS->GetMemoryMap(&sz, 0, &key, &dsz, &dver);
1213         if (status != EFI_BUFFER_TOO_SMALL) {
1214                 printf("Can't determine memory map size\n");
1215                 return (CMD_ERROR);
1216         }
1217         map = malloc(sz);
1218         status = BS->GetMemoryMap(&sz, map, &key, &dsz, &dver);
1219         if (EFI_ERROR(status)) {
1220                 printf("Can't read memory map\n");
1221                 return (CMD_ERROR);
1222         }
1223
1224         ndesc = sz / dsz;
1225         snprintf(line, sizeof(line), "%23s %12s %12s %8s %4s\n",
1226             "Type", "Physical", "Virtual", "#Pages", "Attr");
1227         pager_open();
1228         if (pager_output(line)) {
1229                 pager_close();
1230                 return (CMD_OK);
1231         }
1232
1233         for (i = 0, p = map; i < ndesc;
1234              i++, p = NextMemoryDescriptor(p, dsz)) {
1235                 snprintf(line, sizeof(line), "%23s %012jx %012jx %08jx ",
1236                     efi_memory_type(p->Type), (uintmax_t)p->PhysicalStart,
1237                     (uintmax_t)p->VirtualStart, (uintmax_t)p->NumberOfPages);
1238                 if (pager_output(line))
1239                         break;
1240
1241                 if (p->Attribute & EFI_MEMORY_UC)
1242                         printf("UC ");
1243                 if (p->Attribute & EFI_MEMORY_WC)
1244                         printf("WC ");
1245                 if (p->Attribute & EFI_MEMORY_WT)
1246                         printf("WT ");
1247                 if (p->Attribute & EFI_MEMORY_WB)
1248                         printf("WB ");
1249                 if (p->Attribute & EFI_MEMORY_UCE)
1250                         printf("UCE ");
1251                 if (p->Attribute & EFI_MEMORY_WP)
1252                         printf("WP ");
1253                 if (p->Attribute & EFI_MEMORY_RP)
1254                         printf("RP ");
1255                 if (p->Attribute & EFI_MEMORY_XP)
1256                         printf("XP ");
1257                 if (p->Attribute & EFI_MEMORY_NV)
1258                         printf("NV ");
1259                 if (p->Attribute & EFI_MEMORY_MORE_RELIABLE)
1260                         printf("MR ");
1261                 if (p->Attribute & EFI_MEMORY_RO)
1262                         printf("RO ");
1263                 if (pager_output("\n"))
1264                         break;
1265         }
1266
1267         pager_close();
1268         return (CMD_OK);
1269 }
1270
1271 COMMAND_SET(configuration, "configuration", "print configuration tables",
1272     command_configuration);
1273
1274 static int
1275 command_configuration(int argc, char *argv[])
1276 {
1277         UINTN i;
1278         char *name;
1279
1280         printf("NumberOfTableEntries=%lu\n",
1281                 (unsigned long)ST->NumberOfTableEntries);
1282
1283         for (i = 0; i < ST->NumberOfTableEntries; i++) {
1284                 EFI_GUID *guid;
1285
1286                 printf("  ");
1287                 guid = &ST->ConfigurationTable[i].VendorGuid;
1288
1289                 if (efi_guid_to_name(guid, &name) == true) {
1290                         printf(name);
1291                         free(name);
1292                 } else {
1293                         printf("Error while translating UUID to name");
1294                 }
1295                 printf(" at %p\n", ST->ConfigurationTable[i].VendorTable);
1296         }
1297
1298         return (CMD_OK);
1299 }
1300
1301
1302 COMMAND_SET(mode, "mode", "change or display EFI text modes", command_mode);
1303
1304 static int
1305 command_mode(int argc, char *argv[])
1306 {
1307         UINTN cols, rows;
1308         unsigned int mode;
1309         int i;
1310         char *cp;
1311         EFI_STATUS status;
1312         SIMPLE_TEXT_OUTPUT_INTERFACE *conout;
1313
1314         conout = ST->ConOut;
1315
1316         if (argc > 1) {
1317                 mode = strtol(argv[1], &cp, 0);
1318                 if (cp[0] != '\0') {
1319                         printf("Invalid mode\n");
1320                         return (CMD_ERROR);
1321                 }
1322                 status = conout->QueryMode(conout, mode, &cols, &rows);
1323                 if (EFI_ERROR(status)) {
1324                         printf("invalid mode %d\n", mode);
1325                         return (CMD_ERROR);
1326                 }
1327                 status = conout->SetMode(conout, mode);
1328                 if (EFI_ERROR(status)) {
1329                         printf("couldn't set mode %d\n", mode);
1330                         return (CMD_ERROR);
1331                 }
1332                 (void) efi_cons_update_mode();
1333                 return (CMD_OK);
1334         }
1335
1336         printf("Current mode: %d\n", conout->Mode->Mode);
1337         for (i = 0; i <= conout->Mode->MaxMode; i++) {
1338                 status = conout->QueryMode(conout, i, &cols, &rows);
1339                 if (EFI_ERROR(status))
1340                         continue;
1341                 printf("Mode %d: %u columns, %u rows\n", i, (unsigned)cols,
1342                     (unsigned)rows);
1343         }
1344
1345         if (i != 0)
1346                 printf("Select a mode with the command \"mode <number>\"\n");
1347
1348         return (CMD_OK);
1349 }
1350
1351 COMMAND_SET(lsefi, "lsefi", "list EFI handles", command_lsefi);
1352
1353 static int
1354 command_lsefi(int argc __unused, char *argv[] __unused)
1355 {
1356         char *name;
1357         EFI_HANDLE *buffer = NULL;
1358         EFI_HANDLE handle;
1359         UINTN bufsz = 0, i, j;
1360         EFI_STATUS status;
1361         int ret = 0;
1362
1363         status = BS->LocateHandle(AllHandles, NULL, NULL, &bufsz, buffer);
1364         if (status != EFI_BUFFER_TOO_SMALL) {
1365                 snprintf(command_errbuf, sizeof (command_errbuf),
1366                     "unexpected error: %lld", (long long)status);
1367                 return (CMD_ERROR);
1368         }
1369         if ((buffer = malloc(bufsz)) == NULL) {
1370                 sprintf(command_errbuf, "out of memory");
1371                 return (CMD_ERROR);
1372         }
1373
1374         status = BS->LocateHandle(AllHandles, NULL, NULL, &bufsz, buffer);
1375         if (EFI_ERROR(status)) {
1376                 free(buffer);
1377                 snprintf(command_errbuf, sizeof (command_errbuf),
1378                     "LocateHandle() error: %lld", (long long)status);
1379                 return (CMD_ERROR);
1380         }
1381
1382         pager_open();
1383         for (i = 0; i < (bufsz / sizeof (EFI_HANDLE)); i++) {
1384                 UINTN nproto = 0;
1385                 EFI_GUID **protocols = NULL;
1386
1387                 handle = buffer[i];
1388                 printf("Handle %p", handle);
1389                 if (pager_output("\n"))
1390                         break;
1391                 /* device path */
1392
1393                 status = BS->ProtocolsPerHandle(handle, &protocols, &nproto);
1394                 if (EFI_ERROR(status)) {
1395                         snprintf(command_errbuf, sizeof (command_errbuf),
1396                             "ProtocolsPerHandle() error: %lld",
1397                             (long long)status);
1398                         continue;
1399                 }
1400
1401                 for (j = 0; j < nproto; j++) {
1402                         if (efi_guid_to_name(protocols[j], &name) == true) {
1403                                 printf("  %s", name);
1404                                 free(name);
1405                         } else {
1406                                 printf("Error while translating UUID to name");
1407                         }
1408                         if ((ret = pager_output("\n")) != 0)
1409                                 break;
1410                 }
1411                 BS->FreePool(protocols);
1412                 if (ret != 0)
1413                         break;
1414         }
1415         pager_close();
1416         free(buffer);
1417         return (CMD_OK);
1418 }
1419
1420 #ifdef LOADER_FDT_SUPPORT
1421 extern int command_fdt_internal(int argc, char *argv[]);
1422
1423 /*
1424  * Since proper fdt command handling function is defined in fdt_loader_cmd.c,
1425  * and declaring it as extern is in contradiction with COMMAND_SET() macro
1426  * (which uses static pointer), we're defining wrapper function, which
1427  * calls the proper fdt handling routine.
1428  */
1429 static int
1430 command_fdt(int argc, char *argv[])
1431 {
1432
1433         return (command_fdt_internal(argc, argv));
1434 }
1435
1436 COMMAND_SET(fdt, "fdt", "flattened device tree handling", command_fdt);
1437 #endif
1438
1439 /*
1440  * Chain load another efi loader.
1441  */
1442 static int
1443 command_chain(int argc, char *argv[])
1444 {
1445         EFI_GUID LoadedImageGUID = LOADED_IMAGE_PROTOCOL;
1446         EFI_HANDLE loaderhandle;
1447         EFI_LOADED_IMAGE *loaded_image;
1448         EFI_STATUS status;
1449         struct stat st;
1450         struct devdesc *dev;
1451         char *name, *path;
1452         void *buf;
1453         int fd;
1454
1455         if (argc < 2) {
1456                 command_errmsg = "wrong number of arguments";
1457                 return (CMD_ERROR);
1458         }
1459
1460         name = argv[1];
1461
1462         if ((fd = open(name, O_RDONLY)) < 0) {
1463                 command_errmsg = "no such file";
1464                 return (CMD_ERROR);
1465         }
1466
1467 #ifdef LOADER_VERIEXEC
1468         if (verify_file(fd, name, 0, VE_MUST, __func__) < 0) {
1469                 sprintf(command_errbuf, "can't verify: %s", name);
1470                 close(fd);
1471                 return (CMD_ERROR);
1472         }
1473 #endif
1474
1475         if (fstat(fd, &st) < -1) {
1476                 command_errmsg = "stat failed";
1477                 close(fd);
1478                 return (CMD_ERROR);
1479         }
1480
1481         status = BS->AllocatePool(EfiLoaderCode, (UINTN)st.st_size, &buf);
1482         if (status != EFI_SUCCESS) {
1483                 command_errmsg = "failed to allocate buffer";
1484                 close(fd);
1485                 return (CMD_ERROR);
1486         }
1487         if (read(fd, buf, st.st_size) != st.st_size) {
1488                 command_errmsg = "error while reading the file";
1489                 (void)BS->FreePool(buf);
1490                 close(fd);
1491                 return (CMD_ERROR);
1492         }
1493         close(fd);
1494         status = BS->LoadImage(FALSE, IH, NULL, buf, st.st_size, &loaderhandle);
1495         (void)BS->FreePool(buf);
1496         if (status != EFI_SUCCESS) {
1497                 command_errmsg = "LoadImage failed";
1498                 return (CMD_ERROR);
1499         }
1500         status = OpenProtocolByHandle(loaderhandle, &LoadedImageGUID,
1501             (void **)&loaded_image);
1502
1503         if (argc > 2) {
1504                 int i, len = 0;
1505                 CHAR16 *argp;
1506
1507                 for (i = 2; i < argc; i++)
1508                         len += strlen(argv[i]) + 1;
1509
1510                 len *= sizeof (*argp);
1511                 loaded_image->LoadOptions = argp = malloc (len);
1512                 loaded_image->LoadOptionsSize = len;
1513                 for (i = 2; i < argc; i++) {
1514                         char *ptr = argv[i];
1515                         while (*ptr)
1516                                 *(argp++) = *(ptr++);
1517                         *(argp++) = ' ';
1518                 }
1519                 *(--argv) = 0;
1520         }
1521
1522         if (efi_getdev((void **)&dev, name, (const char **)&path) == 0) {
1523 #ifdef EFI_ZFS_BOOT
1524                 struct zfs_devdesc *z_dev;
1525 #endif
1526                 struct disk_devdesc *d_dev;
1527                 pdinfo_t *hd, *pd;
1528
1529                 switch (dev->d_dev->dv_type) {
1530 #ifdef EFI_ZFS_BOOT
1531                 case DEVT_ZFS:
1532                         z_dev = (struct zfs_devdesc *)dev;
1533                         loaded_image->DeviceHandle =
1534                             efizfs_get_handle_by_guid(z_dev->pool_guid);
1535                         break;
1536 #endif
1537                 case DEVT_NET:
1538                         loaded_image->DeviceHandle =
1539                             efi_find_handle(dev->d_dev, dev->d_unit);
1540                         break;
1541                 default:
1542                         hd = efiblk_get_pdinfo(dev);
1543                         if (STAILQ_EMPTY(&hd->pd_part)) {
1544                                 loaded_image->DeviceHandle = hd->pd_handle;
1545                                 break;
1546                         }
1547                         d_dev = (struct disk_devdesc *)dev;
1548                         STAILQ_FOREACH(pd, &hd->pd_part, pd_link) {
1549                                 /*
1550                                  * d_partition should be 255
1551                                  */
1552                                 if (pd->pd_unit == (uint32_t)d_dev->d_slice) {
1553                                         loaded_image->DeviceHandle =
1554                                             pd->pd_handle;
1555                                         break;
1556                                 }
1557                         }
1558                         break;
1559                 }
1560         }
1561
1562         dev_cleanup();
1563         status = BS->StartImage(loaderhandle, NULL, NULL);
1564         if (status != EFI_SUCCESS) {
1565                 command_errmsg = "StartImage failed";
1566                 free(loaded_image->LoadOptions);
1567                 loaded_image->LoadOptions = NULL;
1568                 status = BS->UnloadImage(loaded_image);
1569                 return (CMD_ERROR);
1570         }
1571
1572         return (CMD_ERROR);     /* not reached */
1573 }
1574
1575 COMMAND_SET(chain, "chain", "chain load file", command_chain);