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