share/man/man8/uefi.8

   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 May 9, 2020
  28 .Dt UEFI 8
  29 .Os
  30 .Sh NAME
  31 .Nm UEFI
  32 .Nd Unified Extensible Firmware Interface bootstrapping procedures
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 Unified Extensible Firmware Interface provides boot- and run-time services
  37 to operating systems.
  38 .Nm
  39 is a replacement for the legacy BIOS on the i386 and amd64 CPU architectures,
  40 and is also used on arm, arm64 and ia64.
  41 .Pp
  42 The UEFI specification is the successor to the Extensible Firmware Interface
  43 (EFI) specification.
  44 The terms are often used interchangeably.
  45 .Pp
  46 The
  47 .Nm
  48 boot process loads system bootstrap code located in an EFI System Partition
  49 (ESP).
  50 The ESP is a GPT or MBR partition with a specific identifier that contains an
  51 .Xr msdosfs 5
  52 FAT 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
  59 The
  60 .Nm
  61 boot process proceeds as follows:
  62 .Bl -enum -offset indent -compact
  63 .It
  64 .Nm
  65 firmware runs at power up and searches for an OS loader in the EFI system
  66 partition.
  67 The path to the loader may be set by an EFI environment variable.
  68 If 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 arm Ta Pa /EFI/BOOT/BOOTARM.EFI
  73 .It arm64 Ta Pa /EFI/BOOT/BOOTAA64.EFI
  74 .El
  75 .Pp
  76 The default
  77 .Nm
  78 boot configuration for
  79 .Fx
  80 installs
  81 .Pa loader.efi
  82 in the default path.
  83 .It
  84 .Pa loader.efi
  85 reads boot configuration from
  86 .Pa /boot.config
  87 or
  88 .Pa /boot/config .
  89 .It
  90 .Pa loader.efi
  91 searches partitions of type
  92 .Li freebsd-ufs
  93 and
  94 .Li freebsd-zfs
  95 for
  96 .Pa loader.efi .
  97 The search begins with partitions on the device from which
  98 .Pa loader.efi
  99 was loaded, and continues with other available partitions.
 100 If both
 101 .Li freebsd-ufs
 102 and
 103 .Li freebsd-zfs
 104 partitions exist on the same device the
 105 .Li freebsd-zfs
 106 partition is preferred.
 107 .It
 108 .Pa loader.efi
 109 loads and boots the kernel, as described in
 110 .Xr loader 8 .
 111 .El
 112 .Pp
 113 The
 114 .Xr vt 4
 115 system console is automatically selected when booting via
 116 .Nm .
 117 .Sh FILES
 118 .Bl -tag -width /boot/loader -compact
 119 .Nm
 120 bootstrap
 121 .It Pa /boot/loader.efi
 122 Final stage bootstrap
 123 .It Pa /boot/kernel/kernel
 124 default kernel
 125 .It Pa /boot/kernel.old/kernel
 126 typical non-default kernel (optional)
 127 .El
 128 .Sh SEE ALSO
 129 .Xr vt 4 ,
 130 .Xr boot.config 5 ,
 131 .Xr msdosfs 5 ,
 132 .Xr boot 8 ,
 133 .Xr efibootmgr 8 ,
 134 .Xr efidp 8 ,
 135 .Xr efivar 8 ,
 136 .Xr gpart 8 ,
 137 .Xr uefisign 8
 138 .Sh HISTORY
 139 EFI boot support for the ia64 architecture first appeared in
 140 .Fx 5.0 .
 141 .Nm
 142 boot support for amd64 first appeared in
 143 .Fx 10.1
 144 and for arm64 in
 145 .Fx 11.0 .
 146 .Sh CAVEATS
 147 EFI environment variables are not supported by
 148 .Xr loader 8
 149 or the kernel.