linux-kernel - [PATCH RESEND] efi_stub: update documentation on dtb= parameter

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20180906182927.22318-1-grant.likely@arm.com>
Date:   Thu,  6 Sep 2018 19:29:27 +0100
From:   Grant Likely <grant.likely@....com>
To:     linux-efi@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-arm-kernel@...ts.infradead.org
Cc:     olof@...om.net, scott.branden@...adcom.com,
        catalin.marinas@....com, will.deacon@....com, arnd@...db.de,
        leif.lindholm@...aro.org, agraf@...e.de, nd@....com,
        Grant Likely <grant.likely@....com>,
        Ard Biesheuvel <ard.biesheuvel@...aro.org>,
        Jonathan Corbet <corbet@....net>
Subject: [PATCH RESEND] efi_stub: update documentation on dtb= parameter

The dtb= parameter is no longer the primary mechanism for providing a
devicetree to the kernel. Now either firmware or the boot selector (ex.
Grub) should provide the devicetree and dtb= should only be used for
debug or when using firmware that doesn't understand DT.
Update the EFI stub documentation to reflect the current usage.

Signed-off-by: Grant Likely <grant.likely@....com>
Reviewed-by: Alexander Graf <agraf@...e.de>
Acked-by: Leif Lindholm <leif.lindholm@...aro.org>
Acked-by: Olof Johansson <olof@...om.net>
Cc: Ard Biesheuvel <ard.biesheuvel@...aro.org>
Cc: Jonathan Corbet <corbet@....net>
---

Resending because original post included Arm corporate disclaimer.

 Documentation/efi-stub.txt | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/Documentation/efi-stub.txt b/Documentation/efi-stub.txt
index 41df801f9a50..833edb0d0bc4 100644
--- a/Documentation/efi-stub.txt
+++ b/Documentation/efi-stub.txt
@@ -83,7 +83,18 @@ is passed to bzImage.efi.
 The "dtb=" option
 -----------------
 
-For the ARM and arm64 architectures, we also need to be able to provide a
-device tree to the kernel. This is done with the "dtb=" command line option,
-and is processed in the same manner as the "initrd=" option that is
+For the ARM and arm64 architectures, a device tree must be provided to
+the kernel. Normally firmware shall supply the device tree via the
+EFI CONFIGURATION TABLE. However, the "dtb=" command line option can
+be used to override the firmware supplied device tree, or to supply
+one when firmware is unable to.
+
+Please note: Firmware adds runtime configuration information to the
+device tree before booting the kernel. If dtb= is used to override
+the device tree, then any runtime data provided by firmware will be
+lost. The dtb= option should only be used either as a debug tool, or
+as a last resort when a device tree is not provided in the EFI
+CONFIGURATION TABLE.
+
+"dtb=" is processed in the same manner as the "initrd=" option that is
 described above.
-- 
2.11.0