MdeModulePkg: Minor update to the Data parameter for PEI GetVariable()

PI 1.5 spec has minor update to the Data parameter for PEI
GetVariable(), and no real functional behavior change.

The modifier of Data parameter:
OUT VOID *Data
->
OUT VOID *Data OPTIONAL

The comments of Data parameter:
Data    Points to the buffer which will hold the returned variable value.
->
Data    Points to the buffer which will hold the returned variable value.
        May be NULL with a zero DataSize in order to determine the size of the buffer needed.

The patch is to follow the spec to update the implementation.

Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Star Zeng 2017-06-21 17:31:35 +08:00
parent bca08c489c
commit 9977995e68
2 changed files with 7 additions and 5 deletions

View File

@ -947,9 +947,10 @@ FindVariable (
@param DataSize On entry, points to the size in bytes of the Data buffer. @param DataSize On entry, points to the size in bytes of the Data buffer.
On return, points to the size of the data returned in Data. On return, points to the size of the data returned in Data.
@param Data Points to the buffer which will hold the returned variable value. @param Data Points to the buffer which will hold the returned variable value.
May be NULL with a zero DataSize in order to determine the size of the buffer needed.
@retval EFI_SUCCESS The variable was read successfully. @retval EFI_SUCCESS The variable was read successfully.
@retval EFI_NOT_FOUND The variable could not be found. @retval EFI_NOT_FOUND The variable was be found.
@retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.
DataSize is updated with the size required for DataSize is updated with the size required for
the specified variable. the specified variable.
@ -965,7 +966,7 @@ PeiGetVariable (
IN CONST EFI_GUID *VariableGuid, IN CONST EFI_GUID *VariableGuid,
OUT UINT32 *Attributes, OUT UINT32 *Attributes,
IN OUT UINTN *DataSize, IN OUT UINTN *DataSize,
OUT VOID *Data OUT VOID *Data OPTIONAL
) )
{ {
VARIABLE_POINTER_TRACK Variable; VARIABLE_POINTER_TRACK Variable;

View File

@ -2,7 +2,7 @@
The internal header file includes the common header files, defines The internal header file includes the common header files, defines
internal structure and functions used by PeiVariable module. internal structure and functions used by PeiVariable module.
Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR> Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at which accompanies this distribution. The full text of the license may be found at
@ -87,9 +87,10 @@ PeimInitializeVariableServices (
@param DataSize On entry, points to the size in bytes of the Data buffer. @param DataSize On entry, points to the size in bytes of the Data buffer.
On return, points to the size of the data returned in Data. On return, points to the size of the data returned in Data.
@param Data Points to the buffer which will hold the returned variable value. @param Data Points to the buffer which will hold the returned variable value.
May be NULL with a zero DataSize in order to determine the size of the buffer needed.
@retval EFI_SUCCESS The variable was read successfully. @retval EFI_SUCCESS The variable was read successfully.
@retval EFI_NOT_FOUND The variable could not be found. @retval EFI_NOT_FOUND The variable was not found.
@retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.
DataSize is updated with the size required for DataSize is updated with the size required for
the specified variable. the specified variable.
@ -105,7 +106,7 @@ PeiGetVariable (
IN CONST EFI_GUID *VariableGuid, IN CONST EFI_GUID *VariableGuid,
OUT UINT32 *Attributes, OUT UINT32 *Attributes,
IN OUT UINTN *DataSize, IN OUT UINTN *DataSize,
OUT VOID *Data OUT VOID *Data OPTIONAL
); );
/** /**