efi: Mention that efi_info_get() is only used in the stub

This provides access to EFI tables after U-Boot has exited boot services.
It is not needed in the app since boot services remain alive and we can
just call them whenever needed.

Add a comment to explain this.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>

diff --git a/include/efi.h b/include/efi.h
index 8c3f33246839321b5abd38eee9d8ce61cef6bb8d..877a2e5a8d319268a4ef9e9ceeeeb519156a62ee 100644 (file)
--- a/include/efi.h
+++ b/include/efi.h
@@ -566,6 +566,10 @@ void efi_putc(struct efi_priv *priv, const char ch);
 /**
  * efi_info_get() - get an entry from an EFI table
  *
+ * This function is called from U-Boot proper to read information set up by the
+ * EFI stub. It can only be used when running from the EFI stub, not when U-Boot
+ * is running as an app.
+ *
  * @type:      Entry type to search for
  * @datap:     Returns pointer to entry data
  * @sizep:     Returns pointer to entry size