9ecf6e0f9f
- Add SPDX tag - Add a files section describing different locations related to the loader - Add an example explaining how to install a new loader.efi to ESP - Reference uefi(8) Reviewed by: tsoome Reviewed by: Pau Amma <pauamma@gundo.com> Reviewed by: Jose Luis Duran <jlduran@gmail.com> MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D34592
102 lines
2.9 KiB
Groff
102 lines
2.9 KiB
Groff
.\"
|
|
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
.\"
|
|
.\" Copyright (c) 2019 Netflix, Inc
|
|
.\" Copyright (c) 2022 Mateusz Piotrowski <0mp@FreeBSD.org>
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd March 18, 2022
|
|
.Dt LOADER.EFI 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm loader.efi
|
|
.Nd UEFI kernel loader
|
|
.Sh DESCRIPTION
|
|
On UEFI systems,
|
|
.Nm
|
|
loads the kernel.
|
|
.Pp
|
|
.Xr boot1.efi 8
|
|
is used to load
|
|
.Nm
|
|
when it is placed within the system.
|
|
.Sh FILES
|
|
.Bl -tag -width "/boot/loader.efi"
|
|
.It Pa /boot/loader.efi
|
|
The location of the UEFI kernel loader within the system.
|
|
.El
|
|
.Ss EFI System Partition
|
|
.Nm
|
|
is installed on ESP (EFI System Partition) in one of the following locations:
|
|
.Bl -tag -width "efi/freebsd/loader.efi"
|
|
.It Pa efi/boot/bootXXX.efi
|
|
The default location for any EFI loader
|
|
.Po see
|
|
.Xr uefi 8
|
|
for values to replace
|
|
.Ql XXX
|
|
with
|
|
.Pc .
|
|
.It Pa efi/freebsd/loader.efi
|
|
The location reserved specifically for the
|
|
.Fx
|
|
EFI loader.
|
|
.El
|
|
.Pp
|
|
The default location for the ESP mount point is documented in
|
|
.Xr hier 7 .
|
|
.Sh EXAMPLES
|
|
.Ss Updating loader.efi on ESP
|
|
The following examples shows how to install a new
|
|
.Nm
|
|
on ESP.
|
|
.Pp
|
|
First, find the partition of type
|
|
.Dq efi :
|
|
.Bd -literal -offset indent
|
|
# gpart list | grep -Ew '(Name|efi)'
|
|
1. Name: nvd0p1
|
|
type: efi
|
|
2. Name: nvd0p2
|
|
3. Name: nvd0p3
|
|
4. Name: nvd0p4
|
|
1. Name: nvd0
|
|
.Ed
|
|
.Pp
|
|
The name of ESP on this system is
|
|
.Pa nvd0p1 .
|
|
.Pp
|
|
Second, let's mount ESP, copy
|
|
.Nm
|
|
to the special location reserved for
|
|
.Fx
|
|
EFI loaders, and unmount once finished:
|
|
.Bd -literal -offset indent
|
|
# mount_msdosfs /dev/nvd0p1 /boot/efi
|
|
# cp /boot/loader.efi /boot/efi/efi/freebsd/loader.efi
|
|
# umount /boot/efi
|
|
.Sh SEE ALSO
|
|
.Xr uefi 8
|