xref: /freebsd/share/man/man8/uefi.8 (revision b9f654b163bce26de79705e77b872427c9f2afa1)
1.\" Copyright (c) 2014 The FreeBSD Foundation
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd December 14, 2018
28.Dt UEFI 8
29.Os
30.Sh NAME
31.Nm UEFI
32.Nd Unified Extensible Firmware Interface bootstrapping procedures
33.Sh DESCRIPTION
34The
35.Nm
36Unified Extensible Firmware Interface provides boot- and run-time services
37to operating systems.
38.Nm
39is a replacement for the legacy BIOS on the i386 and amd64 CPU architectures,
40and is also used on arm, arm64 and ia64.
41.Pp
42The UEFI specification is the successor to the Extensible Firmware Interface
43(EFI) specification.
44The terms are often used interchangeably.
45.Pp
46The
47.Nm
48boot process loads system bootstrap code located in an EFI System Partition
49(ESP).
50The ESP is a GPT or MBR partition with a specific identifier that contains an
51.Xr msdosfs 5
52FAT file system with a specified file hierarchy.
53.Bl -column -offset indent ".Sy Partition Scheme" ".Sy ESP Identifier"
54.It Sy "Partition Scheme" Ta Sy "ESP Identifier"
55.It GPT Ta C12A7328-F81F-11D2-BA4B-00A0C93EC93B
56.It MBR Ta 0xEF
57.El
58.Pp
59The
60.Nm
61boot process proceeds as follows:
62.Bl -enum -offset indent -compact
63.It
64.Nm
65firmware runs at power up and searches for an OS loader in the EFI system
66partition.
67The path to the loader may be set by an EFI environment variable.
68If not set, an architecture-specific default is used.
69.Bl -column -offset indent "Architecture" "Default Path"
70.It Sy Architecture Ta Sy Default Path
71.It amd64 Ta Pa /EFI/BOOT/BOOTX64.EFI
72.It arm64 Ta Pa /EFI/BOOT/BOOTAA64.EFI
73.El
74.Pp
75The default
76.Nm
77boot configuration for
78.Fx
79installs
80.Pa loader.efi
81in the default path.
82.It
83.Pa loader.efi
84reads boot configuration from
85.Pa /boot.config
86or
87.Pa /boot/config .
88.It
89.Pa loader.efi
90searches partitions of type
91.Li freebsd-ufs
92and
93.Li freebsd-zfs
94for
95.Pa loader.efi .
96The search begins with partitions on the device from which
97.Pa loader.efi
98was loaded, and continues with other available partitions.
99If both
100.Li freebsd-ufs
101and
102.Li freebsd-zfs
103partitions exist on the same device the
104.Li freebsd-zfs
105partition is preferred.
106.It
107.Pa loader.efi
108loads and boots the kernel, as described in
109.Xr loader 8 .
110.El
111.Pp
112The
113.Xr vt 4
114system console is automatically selected when booting via
115.Nm .
116.Sh FILES
117.Bl -tag -width /boot/loader -compact
118.Nm
119bootstrap
120.It Pa /boot/loader.efi
121Final stage bootstrap
122.It Pa /boot/kernel/kernel
123default kernel
124.It Pa /boot/kernel.old/kernel
125typical non-default kernel (optional)
126.El
127.Sh SEE ALSO
128.Xr vt 4 ,
129.Xr boot.config 5 ,
130.Xr msdosfs 5 ,
131.Xr boot 8 ,
132.Xr efibootmgr 8 ,
133.Xr efidp 8 ,
134.Xr efivar 8 ,
135.Xr gpart 8 ,
136.Xr uefisign 8
137.Sh HISTORY
138EFI boot support for the ia64 architecture first appeared in
139.Fx 5.0 .
140.Nm
141boot support for amd64 first appeared in
142.Fx 10.1
143and for arm64 in
144.Fx 11.0 .
145.Sh CAVEATS
146EFI environment variables are not supported by
147.Xr loader 8
148or the kernel.
149