efi_stub: update documentation on dtb= parameter
Subsystems (2)
PATCH RESEND 1/1 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.
---
Resending because original post included Arm corporate disclaimer.
Documentation/efi-stub.txt | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)
Documentation/efi-stub.txt +14 -3
@@ -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.
Signature · 1 line
2.11.0
Quoted 6 lines · Grant Likely
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.
Quoted 6 lines
Signed-off-by Grant Likely <[email protected]>Reviewed-by Alexander Graf <[email protected]>Acked-by Leif Lindholm <[email protected]>Acked-by Olof Johansson <[email protected]>Cc Ard Biesheuvel <[email protected]>Cc Jonathan Corbet <[email protected]>
Quoted 36 lines
---
Resending because original post included Arm corporate disclaimer.
Documentation/efi-stub.txt | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-)Documentation/efi-stub.txt +14
-4@@ -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
Quoted 11 lines · On Thu, 6 Sep 2018 19:29:27 +0100 Grant Likely <[email protected]> wrote:
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 <[email protected]>Reviewed-by Alexander Graf <[email protected]>Acked-by Leif Lindholm <[email protected]>Acked-by Olof Johansson <[email protected]>Cc Ard Biesheuvel <[email protected]>
Applied, thanks.
jon