xref: /freebsd/stand/man/boot1.efi.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1a855700aSWarner Losh.\"
2a855700aSWarner Losh.\" Copyright (c) 2020 Netflix, Inc
3a855700aSWarner Losh.\"
4a855700aSWarner Losh.\" Redistribution and use in source and binary forms, with or without
5a855700aSWarner Losh.\" modification, are permitted provided that the following conditions
6a855700aSWarner Losh.\" are met:
7a855700aSWarner Losh.\" 1. Redistributions of source code must retain the above copyright
8a855700aSWarner Losh.\"    notice, this list of conditions and the following disclaimer.
9a855700aSWarner Losh.\" 2. Redistributions in binary form must reproduce the above copyright
10a855700aSWarner Losh.\"    notice, this list of conditions and the following disclaimer in the
11a855700aSWarner Losh.\"    documentation and/or other materials provided with the distribution.
12a855700aSWarner Losh.\"
13a855700aSWarner Losh.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14a855700aSWarner Losh.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15a855700aSWarner Losh.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16a855700aSWarner Losh.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17a855700aSWarner Losh.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18a855700aSWarner Losh.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19a855700aSWarner Losh.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20a855700aSWarner Losh.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21a855700aSWarner Losh.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22a855700aSWarner Losh.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23a855700aSWarner Losh.\" SUCH DAMAGE.
24a855700aSWarner Losh.\"
25*42cd37dfSWarner Losh.Dd April 6, 2021
26a855700aSWarner Losh.Dt BOOT1.EFI 8
27a855700aSWarner Losh.Os
28a855700aSWarner Losh.Sh NAME
29a855700aSWarner Losh.Nm boot1.efi
30a855700aSWarner Losh.Nd UEFI chain loader
31a855700aSWarner Losh.Sh DESCRIPTION
32a855700aSWarner Losh.Nm
33a855700aSWarner Loshhas been deprecated and will be removed from a future release.
34*42cd37dfSWarner Losh.Xr loader.efi 8
35*42cd37dfSWarner Loshhandles all its former use cases with more flexibility.
36a855700aSWarner Losh.Pp
37a855700aSWarner LoshOn UEFI systems,
38a855700aSWarner Losh.Nm
39a855700aSWarner Loshloads
40a855700aSWarner Losh.Pa /boot/loader.efi
41a855700aSWarner Loshfrom the default root file system and transfers execution there.
42*42cd37dfSWarner LoshSome systems may need to use
43*42cd37dfSWarner Losh.Xr gptboot.efi 8
44*42cd37dfSWarner Loshwhen
45*42cd37dfSWarner Losh.Xr loader.efi 8
46*42cd37dfSWarner Loshcannot be used directly on the ESP (EFI System Partition).
47a855700aSWarner Losh.Ss Initialization
48a855700aSWarner LoshBefore looking for the boot device,
49a855700aSWarner Losh.Nm
50a855700aSWarner Loshdoes the following initialization
51a855700aSWarner Losh.Bl -bullet
52a855700aSWarner Losh.It
53a855700aSWarner LoshSets up the console using the default UEFI console routines.
54a855700aSWarner Losh.It
55a855700aSWarner LoshDiscovers all possible block devices on the system.
56a855700aSWarner Losh.It
57a855700aSWarner LoshInitializes all file system modules to read files from those devices
58a855700aSWarner Losh.El
59a855700aSWarner Losh.Ss Boot Device Selection
60a855700aSWarner Losh.Nm
61a855700aSWarner Loshuses the following sequence to determine the root file system for
62a855700aSWarner Loshbooting:
63a855700aSWarner Losh.Bl -bullet
64a855700aSWarner Losh.It
65a855700aSWarner LoshIf ZFS is configured,
66a855700aSWarner Losh.Nm
67a855700aSWarner Loshwill search the for zpools that are bootable, preferring the zpool on
68a855700aSWarner Loshthe boot device over the others.
69a855700aSWarner Losh.It
70a855700aSWarner LoshIf UFS is configured,
71a855700aSWarner Losh.Nm
72a855700aSWarner Loshwill search all UFS partitions for a bootable partition.
73a855700aSWarner LoshIt will prefer the lowest numbered bootable partition on the boot
74a855700aSWarner Loshdevice over all other choices.
75a855700aSWarner LoshIt will fall back to partitions on other devices if none are found.
76a855700aSWarner Losh.El
77a855700aSWarner Losh.Pp
78a855700aSWarner LoshA partition is considered bootable if it can load
79a855700aSWarner Losh.Pa /boot/loader.efi
80a855700aSWarner Loshfrom it.
81a855700aSWarner LoshCommand line arguments to the next boot stage are
82a855700aSWarner Loshread from the first existing file of
83a855700aSWarner Losh.Pa /boot.config
84a855700aSWarner Loshor
85a855700aSWarner Losh.Pa /boot/config
86a855700aSWarner Loshin that order.
87a855700aSWarner Losh.Ss Caveats
88a855700aSWarner Losh.Bl -bullet
89a855700aSWarner Losh.It
90a855700aSWarner LoshThe order in which file systems are tried is undefined.
91a855700aSWarner Losh.It
92a855700aSWarner LoshNo encryption support is available.
93a855700aSWarner Losh.It
94a855700aSWarner LoshThere's no way to interrupt the boot process to select booting from some
95a855700aSWarner Loshother location.
96a855700aSWarner Losh.It
97a855700aSWarner LoshWhen configuring a serial console for FreeBSD, but not for UEFI, no output
98a855700aSWarner Loshwill show up on the serial console from boot1.efi.
99a855700aSWarner Losh.It
100a855700aSWarner LoshThere's no support for marking partitions as the preferred one.
101*42cd37dfSWarner LoshSee
102*42cd37dfSWarner Losh.Xr gptboot.efi 8 .
103a855700aSWarner Losh.It
104a855700aSWarner LoshThere's no support for boot-once functionality.
105*42cd37dfSWarner LoshSee
106*42cd37dfSWarner Losh.Xr gptboot.efi 8 .
107a855700aSWarner Losh.El
108