X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FPpi%2FReadOnlyVariable2.h;h=fc7bf8eec86157e23b0c164b222cb9f3c6bd50a1;hp=fb76ce29847cecfc86a72afc1f0a37696f8ebef4;hb=00edb2182b6203a037219c29317ab6362c78b422;hpb=00a8a5bfbb20efde3bedc3329a646209c2d1d6ac diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/MdePkg/Include/Ppi/ReadOnlyVariable2.h index fb76ce2984..fc7bf8eec8 100644 --- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h +++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h @@ -22,31 +22,31 @@ #define __PEI_READ_ONLY_VARIABLE2_PPI_H__ #define EFI_PEI_READ_ONLY_VARIABLE2_PPI_GUID \ - { 0x2ab86ef5, 0xecb5, 0x4134, { 0xb5, 0x56, 0x38, 0x54, 0xca, 0x1f, 0xe1, 0xb4 } } + { 0x2ab86ef5, 0xecb5, 0x4134, { 0xb5, 0x56, 0x38, 0x54, 0xca, 0x1f, 0xe1, 0xb4 } } typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI; /** Read the specified variable from the UEFI variable store. If the Data - buffer is too small to hold the contents of the variable, - the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the - required buffer size to obtain the data. + buffer is too small to hold the contents of the variable, + the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the + required buffer size to obtain the data. - @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. + @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. - @param VariableName A pointer to a null-terminated string that is the variable¡¯s name. + @param VariableName A pointer to a null-terminated string that is the variable¡¯s name. - @param VendorGuid A pointer to an EFI_GUID that is the variable¡¯s GUID. The combination of - VariableGuid and VariableName must be unique. + @param VendorGuid A pointer to an EFI_GUID that is the variable¡¯s GUID. The combination of + VariableGuid and VariableName must be unique. - @param Attributes If non-NULL, on return, points to the variable¡¯s attributes. See ¡°Related Definitons¡± - below for possible attribute values. + @param Attributes If non-NULL, on return, points to the variable¡¯s attributes. See ¡°Related Definitons¡± + below for possible attribute values. - @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. + @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. - @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. @retval EFI_SUCCESS The function completed successfully. @@ -54,8 +54,8 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI @retval EFI_NOT_FOUND The variable was not found. @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. - DataSize is updated with the size required for - the specified variable. + DataSize is updated with the size required for + the specified variable. @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL. @@ -65,32 +65,32 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI EFI_PEI_READ_ONLY_VARIABLE2_PPI typedef EFI_STATUS (EFIAPI *EFI_PEI_GET_VARIABLE2)( - IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, - IN CONST CHAR16 *VariableName, - IN CONST EFI_GUID *VariableGuid, - OUT UINT32 *Attributes, - IN OUT UINTN *DataSize, - OUT VOID *Data + IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, + IN CONST CHAR16 *VariableName, + IN CONST EFI_GUID *VariableGuid, + OUT UINT32 *Attributes, + IN OUT UINTN *DataSize, + OUT VOID *Data ); /** This function is called multiple times to retrieve the VariableName - and VariableGuid of all variables currently available in the system. - On each call, the previous results are passed into the interface, - and, on return, the interface returns the data for the next - interface. When the entire variable list has been returned, - EFI_NOT_FOUND is returned. + and VariableGuid of all variables currently available in the system. + On each call, the previous results are passed into the interface, + and, on return, the interface returns the data for the next + interface. When the entire variable list has been returned, + EFI_NOT_FOUND is returned. - @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. + @param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI. - @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName. + @param VariableNameSize On entry, points to the size of the buffer pointed to by VariableName. - @param VariableName On entry, a pointer to a null-terminated string that is the variable¡¯s name. - On return, points to the next variable¡¯s null-terminated name string. + @param VariableName On entry, a pointer to a null-terminated string that is the variable¡¯s name. + On return, points to the next variable¡¯s null-terminated name string. - @param VendorGuid On entry, a pointer to an UEFI _GUID that is the variable¡¯s GUID. - On return, a pointer to the next variable¡¯s GUID. + @param VendorGuid On entry, a pointer to an UEFI _GUID that is the variable¡¯s GUID. + On return, a pointer to the next variable¡¯s GUID. @retval EFI_SUCCESS The variable was read successfully. @@ -98,11 +98,11 @@ EFI_STATUS @retval EFI_NOT_FOUND The variable could not be found. @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the resulting - data. VariableNameSize is updated with the size - required for the specified variable. + data. VariableNameSize is updated with the size + required for the specified variable. @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or - VariableNameSize is NULL. + VariableNameSize is NULL. @retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error. @@ -110,10 +110,10 @@ EFI_STATUS typedef EFI_STATUS (EFIAPI *EFI_PEI_NEXT_VARIABLE_NAME2) ( - IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, - IN OUT UINTN *VariableNameSize, - IN OUT CHAR16 *VariableName, - IN OUT EFI_GUID *VariableGuid + IN CONST EFI_PEI_READ_ONLY_VARIABLE2_PPI *This, + IN OUT UINTN *VariableNameSize, + IN OUT CHAR16 *VariableName, + IN OUT EFI_GUID *VariableGuid ); /** @@ -128,8 +128,8 @@ EFI_STATUS **/ struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI { - EFI_PEI_GET_VARIABLE2 GetVariable; - EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName; + EFI_PEI_GET_VARIABLE2 GetVariable; + EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName; }; extern EFI_GUID gEfiPeiReadOnlyVariable2PpiGuid;