Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-05-08 19:11:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

efi_loader: fix comments for variable services

Browse source 
Add missing parameter descriptions.
Remove an invalid link.
Correct the formatting of a function comment.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2019-07-14 12:11:16 +02:00
parent 3f33f30bba
commit e5b4462ded
1 changed files with 23 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

27
lib/efi_loader/efi_variable.c
View file

@ -263,8 +263,8 @@ static char *efi_cur_variable;
* is the size of variable name including NULL. * is the size of variable name including NULL.
* *
* Return: EFI_SUCCESS if parsing is OK, EFI_NOT_FOUND when * Return: EFI_SUCCESS if parsing is OK, EFI_NOT_FOUND when
the entire variable list has been returned, * the entire variable list has been returned,
otherwise non-zero status code * otherwise non-zero status code
*/ */
static efi_status_t parse_uboot_variable(char *variable, static efi_status_t parse_uboot_variable(char *variable,
efi_uintn_t *variable_name_size, efi_uintn_t *variable_name_size,
@ -315,6 +315,7 @@ static efi_status_t parse_uboot_variable(char *variable,
/** /**
* efi_get_next_variable_name() - enumerate the current variable names * efi_get_next_variable_name() - enumerate the current variable names
*
* @variable_name_size: size of variable_name buffer in byte * @variable_name_size: size of variable_name buffer in byte
* @variable_name: name of uefi variable's name in u16 * @variable_name: name of uefi variable's name in u16
* @vendor: vendor's guid * @vendor: vendor's guid
@ -322,8 +323,7 @@ static efi_status_t parse_uboot_variable(char *variable,
* This function implements the GetNextVariableName service. * This function implements the GetNextVariableName service.
* *
* See the Unified Extensible Firmware Interface (UEFI) specification for * See the Unified Extensible Firmware Interface (UEFI) specification for
* details: http://wiki.phoenix.com/wiki/index.php/ * details.
* EFI_RUNTIME_SERVICES#GetNextVariableName.28.29
* *
* Return: status code * Return: status code
*/ */
@ -550,6 +550,13 @@ efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
/** /**
* efi_get_variable_runtime() - runtime implementation of GetVariable() * efi_get_variable_runtime() - runtime implementation of GetVariable()
*
* @variable_name: name of the variable
* @vendor: vendor GUID
* @attributes: attributes of the variable
* @data_size: size of the buffer to which the variable value is copied
* @data: buffer to which the variable value is copied
* Return: status code
*/ */
static efi_status_t __efi_runtime EFIAPI static efi_status_t __efi_runtime EFIAPI
efi_get_variable_runtime(u16 *variable_name, const efi_guid_t *vendor, efi_get_variable_runtime(u16 *variable_name, const efi_guid_t *vendor,
@ -561,6 +568,11 @@ efi_get_variable_runtime(u16 *variable_name, const efi_guid_t *vendor,
/** /**
* efi_get_next_variable_name_runtime() - runtime implementation of * efi_get_next_variable_name_runtime() - runtime implementation of
* GetNextVariable() * GetNextVariable()
*
* @variable_name_size: size of variable_name buffer in byte
* @variable_name: name of uefi variable's name in u16
* @vendor: vendor's guid
* Return: status code
*/ */
static efi_status_t __efi_runtime EFIAPI static efi_status_t __efi_runtime EFIAPI
efi_get_next_variable_name_runtime(efi_uintn_t *variable_name_size, efi_get_next_variable_name_runtime(efi_uintn_t *variable_name_size,
@ -571,6 +583,13 @@ efi_get_next_variable_name_runtime(efi_uintn_t *variable_name_size,
/** /**
* efi_set_variable_runtime() - runtime implementation of SetVariable() * efi_set_variable_runtime() - runtime implementation of SetVariable()
*
* @variable_name: name of the variable
* @vendor: vendor GUID
* @attributes: attributes of the variable
* @data_size: size of the buffer with the variable value
* @data: buffer with the variable value
* Return: status code
*/ */
static efi_status_t __efi_runtime EFIAPI static efi_status_t __efi_runtime EFIAPI
efi_set_variable_runtime(u16 *variable_name, const efi_guid_t *vendor, efi_set_variable_runtime(u16 *variable_name, const efi_guid_t *vendor,