[PATCH v8 14/25] efi: Mention that efi_info_get() is only used in the stub

[Heinrich Schuchardt]

On 12/29/21 19:57, Simon Glass wrote:
> This provides access to EFI tables after U-Boot has exited boot services.
> It is not needed in the app since boot services remain alive and we can
> just call them whenever needed.
>
> Add a comment to explain this.
>
> Signed-off-by: Simon Glass <sjg at chromium.org>
> ---
>
> (no changes since v6)
>
> Changes in v6:
> - Fix 'stuff' typo in comment
> - Update to 'This function' in comment
>
> Changes in v2:
> - Fix 'as' typo
>
>   include/efi.h | 4 ++++
>   1 file changed, 4 insertions(+)
>
> diff --git a/include/efi.h b/include/efi.h
> index 2a84223d235..dbf4ffaaf02 100644
> --- a/include/efi.h
> +++ b/include/efi.h
> @@ -578,6 +578,10 @@ void efi_putc(struct efi_priv *priv, const char ch);
>   /**
>    * efi_info_get() - get an entry from an EFI table
>    *
> + * This function is called from U-Boot proper to read information set up by the
> + * EFI stub. It can only be used when running from the EFI stub, not when U-Boot
> + * is running as an app.
> + *

Please have a look at the rest of the description:

>    * @type:	Entry type to search for
>    * @datap:	Returns pointer to entry data
>    * @sizep:	Returns pointer to entry size

An integer is returned, not a pointer.
Please, use Return: instead of @return:

Reviewed-by: Heinrich Schuchardt <xypron.glpk at gmx.de>