[PATCH v5 13/28] efi: Add a few comments to the stub

[Heinrich Schuchardt]

On 12/4/21 16:56, Simon Glass wrote:
> Comment some functions that need more information.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
>
> (no changes since v1)
>
>   lib/efi/efi_stub.c | 22 ++++++++++++++++++++++
>   1 file changed, 22 insertions(+)
>
> diff --git a/lib/efi/efi_stub.c b/lib/efi/efi_stub.c
> index b3393e47fae..156cbf0b928 100644
> --- a/lib/efi/efi_stub.c
> +++ b/lib/efi/efi_stub.c
> @@ -225,6 +225,22 @@ static int get_codeseg32(void)
>   	return cs32;
>   }
>
> +/**
> + * setup_info_table() - sets up a table containing information from EFI
> + *
> + * We must call exit_boot_services() before jumping out of the stub into U-Boot
> + * proper, so that U-Boot has full control of peripherals, memory, etc.
> + *
> + * Once we do this, we cannot call any boot-services functions so we must find
> + * out everything we need to before doing that.
> + *
> + * Set up a struct efi_info_hdr table which can hold various records (e.g.
> + * struct efi_entry_memmap) with information obtained from EFI.
> + *
> + * @priv: Pointer to our private information which contains the list
> + * @size: Size of the table to allocate
> + * @return 0 if OK, non-zero on error

%s/@return/Return:/

cf.
https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#function-documentation

Best regards

Heinrich

> + */
>   static int setup_info_table(struct efi_priv *priv, int size)
>   {
>   	struct efi_info_hdr *info;
> @@ -248,6 +264,12 @@ static int setup_info_table(struct efi_priv *priv, int size)
>   	return 0;
>   }
>
> +/**
> + * add_entry_addr() - Add a new entry to the efi_info list
> + *
> + * @priv: Pointer to our private information which contains the list
> + *
> + */
>   static void add_entry_addr(struct efi_priv *priv, enum efi_entry_t type,
>   			   void *ptr1, int size1, void *ptr2, int size2)
>   {
>