From: Heinrich Schuchardt <xypron.glpk@gmx.de>
Date: Sat, 15 Aug 2020 21:10:22 +0000 (+0200)
Subject: efi_loader: document parameters of do_bootefi_exec()
X-Git-Tag: v2020.10~50^2~10
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=72e1fcacff273f1aa5faa02a75ab5a737f6c698f;p=platform%2Fkernel%2Fu-boot.git

efi_loader: document parameters of do_bootefi_exec()

Add the missing description of the load_options parameter.

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

diff --git a/cmd/bootefi.c b/cmd/bootefi.c
index fbfed54..06563d2 100644
--- a/cmd/bootefi.c
+++ b/cmd/bootefi.c
@@ -304,7 +304,11 @@ efi_status_t efi_install_fdt(void *fdt)
 /**
  * do_bootefi_exec() - execute EFI binary
  *
+ * The image indicated by @handle is started. When it returns the allocated
+ * memory for the @load_options is freed.
+ *
  * @handle:		handle of loaded image
+ * @load_options:	load options
  * Return:		status code
  *
  * Load the EFI binary into a newly assigned memory unwinding the relocation