From nobody Fri Mar 18 08:55:38 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4AE321A35695; Fri, 18 Mar 2022 08:55:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KKdBz1T9Lz3LVS; Fri, 18 Mar 2022 08:55:39 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1647593739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dg93Q7SoYdJqEOEMdqMdlcuolf5+Nx9N3BfQYRo6ujA=; b=XS4vR0EZknYWJPxhE2r6kwl2ODmR32ifGw5SAQF8+YPM27gdN2A9An1cLXNadfG2GAABhT LWRGFKndEgnuOJjr4dA1gyhMKLExKmWn+nlug6e+4hftzer4saNUtQZoGbvd/WQcwVP0Mz fDM5hjHGLr24hdWYi8P5HratooGtwFe33pLUgr9XfOf0V7FebhAPQMzRkMZUQvQwlr65Iz guatHMQVplyLyknY7GWEAfN8mvhJ3ho0csdP3P/W4AGkgKcY4bsFttP1Tbt+VMhGiGubz6 yC0A+IGL8ZsNVGsUFmnP6XqiV1wmJnJVAjMj3ru0WiPox1sSxHoyjbL+6TWYTg== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 0EDC81C094; Fri, 18 Mar 2022 08:55:39 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 22I8tcTI038789; Fri, 18 Mar 2022 08:55:38 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 22I8tc4q038788; Fri, 18 Mar 2022 08:55:38 GMT (envelope-from git) Date: Fri, 18 Mar 2022 08:55:38 GMT Message-Id: <202203180855.22I8tc4q038788@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 9ecf6e0f9f25 - main - loader.efi: Improve the manual page List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 9ecf6e0f9f257279bb3a7762bc26efb72471c6ea Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1647593739; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dg93Q7SoYdJqEOEMdqMdlcuolf5+Nx9N3BfQYRo6ujA=; b=Y1nkxKe/IrpeNxruikD0p4kedMHybZ1XGn2Q149RZzQeMX9naPjT3uNqSUTKRmBnZMV4WG DgPsAliXy/BjzokXHreuPtgluZxgoic0S42tu/cTHvYvNEsZKaK70m8fp4Or2FvuJo2YT3 KlmyLwXZI4+dK47L4LArZyTKevRk5af3o5GvqOgxbvk0a9RnGvhOjEc4UUEJJbNvZ9wCjw DPgu6ngHX+sc/4bpO9olrnAGoNm8VrzhYgpqZVTBUlDD6vWIRab3sP2k6hXY3Jr0W1GlPD ZlekTgx7k17OTbPpKojvUmIFDsPsJ8sl0xO4w/6VrV45wtiqjUqF6tL/MkkeMQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1647593739; a=rsa-sha256; cv=none; b=LLlzo0jjZv6bA/pu2wEekp0YKdlm36C3VYb6aTif5tZ0pLtoEw4ovM9sEfGjmcpT7aQ+Kf KZMfPDBYhX27DCwdmeSOpC+EtGwjVPaBVXLJie5DO4kxqFzJ4FEWHYhMET7nNOaAGy8B8M NtVBtvq7CxNpekTv30YoCboS78auuUVB+Lzc9vT87+ZIzyFNki7lKWCh6yl03e1fp4Y73E poRTA93ePw8EGzuQX3ZYmEhAmvHisxQvjLsP5FEPLd074YxMnySx3xuN+n+7ERJKpYDUEb NwCNZafV2t3/I0/AnQQ0dr7DD+E8WonbnvMF7m8cPeQJC5L2UtzRJBp/AuVmtg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=9ecf6e0f9f257279bb3a7762bc26efb72471c6ea commit 9ecf6e0f9f257279bb3a7762bc26efb72471c6ea Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-03-18 08:54:23 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-03-18 08:55:13 +0000 loader.efi: Improve the manual page - 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 Reviewed by: Jose Luis Duran MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D34592 --- stand/man/loader.efi.8 | 73 ++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 62 insertions(+), 11 deletions(-) diff --git a/stand/man/loader.efi.8 b/stand/man/loader.efi.8 index de5a6b4e51d3..2a19271017fa 100644 --- a/stand/man/loader.efi.8 +++ b/stand/man/loader.efi.8 @@ -1,5 +1,8 @@ .\" +.\" 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 @@ -24,7 +27,7 @@ .\" .\" $FreeBSD$ .\" -.Dd September 1, 2020 +.Dd March 18, 2022 .Dt LOADER.EFI 8 .Os .Sh NAME @@ -34,17 +37,65 @@ On UEFI systems, .Nm loads the kernel. -It is installed into the ESP (EFI System Partition), either in the -default location of -.Pa /efi/boot/bootXXX.efi -within the ESP, in the -.Fx -reserved area as -.Pa /efi/freebsd/loader.efi -within the ESP, -or within the system as -.Pa /boot/loader.efi . +.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