From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Sun, 12 May 2019 18:16:25 +0000 (+0200)
Subject: efi_loader: comments for efi_install_fdt()
X-Git-Tag: v2019.07-rc2~3^2
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e2d82f8b2a91fb3fa78345f935a93a6db575effa;p=oweals%2Fu-boot.git

efi_loader: comments for efi_install_fdt()

Describe that efi_install_fdt() defaults to using the device tree
indicated by environment variable fdtcontroladdr.

ACPI tables and device trees are mutually exclusive.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---

diff --git a/cmd/bootefi.c b/cmd/bootefi.c
index 0b3c5cdb90..c19256e00d 100644
--- a/cmd/bootefi.c
+++ b/cmd/bootefi.c
@@ -196,11 +196,16 @@ static void *get_config_table(const efi_guid_t *guid)
 
 /**
  * efi_install_fdt() - install fdt passed by a command argument
+ *
+ * If fdt_opt is available, the device tree located at that memory address will
+ * will be installed as configuration table, otherwise the device tree located
+ * at the address indicated by environment variable fdtcontroladdr will be used.
+ *
+ * On architectures (x86) using ACPI tables device trees shall not be installed
+ * as configuration table.
+ *
  * @fdt_opt:	pointer to argument
  * Return:	status code
- *
- * If specified, fdt will be installed as configuration table,
- * otherwise no fdt will be passed.
  */
 static efi_status_t efi_install_fdt(const char *fdt_opt)
 {