diff mbox series

[13/13] x86: zboot: Tidy up the comment for zboot_run()

Message ID 20231203172933.13.Ie349ceed16b88ecd28511cd4678c867fbeb0d8bc@changeid
State Accepted
Commit 8d24535e84856f9a881a9cd11d07842a42bc68a3
Delegated to: Tom Rini
Headers show
Series Complete decoupling of zboot logic from commands | expand

Commit Message

Simon Glass Dec. 4, 2023, 12:29 a.m. UTC 
The current use case (ChromeOS) is the uncommon case. Document how this
function is more normally used, where base is 0 and cmdline is NULL

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 include/bootm.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/include/bootm.h b/include/bootm.h
index c815c40e3c4d..1800ca32c264 100644
--- a/include/bootm.h
+++ b/include/bootm.h
@@ -248,11 +248,14 @@  int bootm_process_cmdline_env(int flags);
  *
  * @addr: Address where the bzImage is moved before booting, either
  *	BZIMAGE_LOAD_ADDR or ZIMAGE_LOAD_ADDR
- * @base: Pointer to the boot parameters, typically at address
- *	DEFAULT_SETUP_BASE
+ * @size: Size of bzImage, or 0 to detect this
  * @initrd: Address of the initial ramdisk, or 0 if none
  * @initrd_size: Size of the initial ramdisk, or 0 if none
- * @cmdline: Command line to use for booting
+ * @base_addr: If non-zero, this indicates that the boot parameters have already
+ *	been loaded by the caller to this address, so the load_zimage() call
+ *	in zboot_load() will be skipped when booting
+ * @cmdline: If non-NULL, the environment variable containing the command line
+ *	to use for booting
  * Return: -EFAULT on error (normally it does not return)
  */
 int zboot_run(ulong addr, ulong size, ulong initrd, ulong initrd_size,