[PATCH v2 11/21] bootm: Move do_bootm_states() comment to header file

[Mattijs Korpershoek]

Hi Simon,

Thank you for the patch.

On jeu., déc. 14, 2023 at 09:50, Simon Glass <sjg at chromium.org> wrote:

> This is an exported function, so move the function comment to the
> bootm.h header file.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>

Reviewed-by: Mattijs Korpershoek <mkorpershoek at baylibre.com>

> ---
>
> Changes in v2:
> - Split out patch to move do_bootm_states() comment to header
>
>  boot/bootm.c    | 25 -------------------------
>  include/bootm.h | 25 +++++++++++++++++++++++++
>  2 files changed, 25 insertions(+), 25 deletions(-)
>
> diff --git a/boot/bootm.c b/boot/bootm.c
> index 9e42fa5117d0..875f8a1c2a56 100644
> --- a/boot/bootm.c
> +++ b/boot/bootm.c
> @@ -990,31 +990,6 @@ unmap_image:
>  	return ret;
>  }
>  
> -/**
> - * 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)
> diff --git a/include/bootm.h b/include/bootm.h
> index c9ab55f18d39..950ce5181f1d 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);
> -- 
> 2.43.0.472.g3155946c3a-goog