diff options
author | Simon Glass | 2023-12-15 20:14:15 -0700 |
---|---|---|
committer | Tom Rini | 2023-12-21 16:07:52 -0500 |
commit | e370e3df108800ecfc3b3fe3a7f6ba37498e0289 (patch) | |
tree | 6ca4e50c5e78cd24f346030d238287037138f8ee /include/bootm.h | |
parent | c2211ff65136c39d8d2aefa76803b5da737daf8c (diff) |
bootm: Move do_bootm_states() comment to header file
This is an exported function, so move the function comment to the
bootm.h header file.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
Reviewed-by: Tom Rini <trini@konsulko.com>
Diffstat (limited to 'include/bootm.h')
-rw-r--r-- | include/bootm.h | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/include/bootm.h b/include/bootm.h index 7cfaa0a7d05..81f2514f1b7 100644 --- a/include/bootm.h +++ b/include/bootm.h @@ -131,6 +131,31 @@ int bootm_find_images(ulong img_addr, const char *conf_ramdisk, */ int bootm_measure(struct bootm_headers *images); +/** + * Execute selected states of the bootm command. + * + * Note the arguments to this state must be the first argument, Any 'bootm' + * or sub-command arguments must have already been taken. + * + * Note that if states contains more than one flag it MUST contain + * BOOTM_STATE_START, since this handles and consumes the command line args. + * + * Also note that aside from boot_os_fn functions and bootm_load_os no other + * functions we store the return value of in 'ret' may use a negative return + * value, without special handling. + * + * @param cmdtp Pointer to bootm command table entry + * @param flag Command flags (CMD_FLAG_...) + * @param argc Number of subcommand arguments (0 = no arguments) + * @param argv Arguments + * @param states Mask containing states to run (BOOTM_STATE_...) + * @param images Image header information + * @param boot_progress 1 to show boot progress, 0 to not do this + * Return: 0 if ok, something else on error. Some errors will cause this + * function to perform a reboot! If states contains BOOTM_STATE_OS_GO + * then the intent is to boot an OS, so this function will not return + * unless the image type is standalone. + */ int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[], int states, struct bootm_headers *images, int boot_progress); |