/** @file\r
-\r
Implement ReadOnly Variable Services required by PEIM and install\r
PEI ReadOnly Varaiable2 PPI. These services operates the non volatile storage space.\r
\r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
\r
/**\r
Provide the functionality of the variable services.\r
- \r
- @param FileHandle Handle of the file being invoked. \r
+\r
+ @param FileHandle Handle of the file being invoked.\r
Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
@param PeiServices General purpose services available to every PEIM.\r
\r
return TRUE;\r
}\r
\r
+/**\r
+ This code gets the size of variable header.\r
+\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return Size of variable header in bytes in type UINTN.\r
+\r
+**/\r
+UINTN\r
+GetVariableHeaderSize (\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ UINTN Value;\r
+\r
+ if (AuthFlag) {\r
+ Value = sizeof (AUTHENTICATED_VARIABLE_HEADER);\r
+ } else {\r
+ Value = sizeof (VARIABLE_HEADER);\r
+ }\r
+\r
+ return Value;\r
+}\r
\r
/**\r
This code gets the size of name of variable.\r
\r
@param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
@return Size of variable in bytes in type UINTN.\r
\r
**/\r
UINTN\r
NameSizeOfVariable (\r
- IN VARIABLE_HEADER *Variable\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
)\r
{\r
- if (Variable->State == (UINT8) (-1) ||\r
- Variable->DataSize == (UINT32) (-1) ||\r
- Variable->NameSize == (UINT32) (-1) ||\r
- Variable->Attributes == (UINT32) (-1)) {\r
- return 0;\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ if (AuthVariable->State == (UINT8) (-1) ||\r
+ AuthVariable->DataSize == (UINT32) (-1) ||\r
+ AuthVariable->NameSize == (UINT32) (-1) ||\r
+ AuthVariable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) AuthVariable->NameSize;\r
+ } else {\r
+ if (Variable->State == (UINT8) (-1) ||\r
+ Variable->DataSize == (UINT32) (-1) ||\r
+ Variable->NameSize == (UINT32) (-1) ||\r
+ Variable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) Variable->NameSize;\r
}\r
- return (UINTN) Variable->NameSize;\r
}\r
\r
\r
This code gets the size of data of variable.\r
\r
@param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
@return Size of variable in bytes in type UINTN.\r
\r
**/\r
UINTN\r
DataSizeOfVariable (\r
- IN VARIABLE_HEADER *Variable\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
)\r
{\r
- if (Variable->State == (UINT8) (-1) ||\r
- Variable->DataSize == (UINT32) (-1) ||\r
- Variable->NameSize == (UINT32) (-1) ||\r
- Variable->Attributes == (UINT32) (-1)) {\r
- return 0;\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ if (AuthVariable->State == (UINT8) (-1) ||\r
+ AuthVariable->DataSize == (UINT32) (-1) ||\r
+ AuthVariable->NameSize == (UINT32) (-1) ||\r
+ AuthVariable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) AuthVariable->DataSize;\r
+ } else {\r
+ if (Variable->State == (UINT8) (-1) ||\r
+ Variable->DataSize == (UINT32) (-1) ||\r
+ Variable->NameSize == (UINT32) (-1) ||\r
+ Variable->Attributes == (UINT32) (-1)) {\r
+ return 0;\r
+ }\r
+ return (UINTN) Variable->DataSize;\r
}\r
- return (UINTN) Variable->DataSize;\r
}\r
\r
/**\r
This code gets the pointer to the variable name.\r
\r
@param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
@return A CHAR16* pointer to Variable Name.\r
\r
**/\r
CHAR16 *\r
GetVariableNamePtr (\r
- IN VARIABLE_HEADER *Variable\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
)\r
{\r
- return (CHAR16 *) (Variable + 1);\r
+ return (CHAR16 *) ((UINTN) Variable + GetVariableHeaderSize (AuthFlag));\r
}\r
\r
+/**\r
+ This code gets the pointer to the variable guid.\r
+\r
+ @param Variable Pointer to the Variable Header.\r
+ @param AuthFlag Authenticated variable flag.\r
+\r
+ @return A EFI_GUID* pointer to Vendor Guid.\r
+\r
+**/\r
+EFI_GUID *\r
+GetVendorGuidPtr (\r
+ IN VARIABLE_HEADER *Variable,\r
+ IN BOOLEAN AuthFlag\r
+ )\r
+{\r
+ AUTHENTICATED_VARIABLE_HEADER *AuthVariable;\r
+\r
+ AuthVariable = (AUTHENTICATED_VARIABLE_HEADER *) Variable;\r
+ if (AuthFlag) {\r
+ return &AuthVariable->VendorGuid;\r
+ } else {\r
+ return &Variable->VendorGuid;\r
+ }\r
+}\r
\r
/**\r
This code gets the pointer to the variable data.\r
\r
@param Variable Pointer to the Variable Header.\r
@param VariableHeader Pointer to the Variable Header that has consecutive content.\r
+ @param AuthFlag Authenticated variable flag.\r
\r
@return A UINT8* pointer to Variable Data.\r
\r
UINT8 *\r
GetVariableDataPtr (\r
IN VARIABLE_HEADER *Variable,\r
- IN VARIABLE_HEADER *VariableHeader\r
+ IN VARIABLE_HEADER *VariableHeader,\r
+ IN BOOLEAN AuthFlag\r
)\r
{\r
UINTN Value;\r
- \r
+\r
//\r
// Be careful about pad size for alignment\r
//\r
- Value = (UINTN) GetVariableNamePtr (Variable);\r
- Value += NameSizeOfVariable (VariableHeader);\r
- Value += GET_PAD_SIZE (NameSizeOfVariable (VariableHeader));\r
+ Value = (UINTN) GetVariableNamePtr (Variable, AuthFlag);\r
+ Value += NameSizeOfVariable (VariableHeader, AuthFlag);\r
+ Value += GET_PAD_SIZE (NameSizeOfVariable (VariableHeader, AuthFlag));\r
\r
return (UINT8 *) Value;\r
}\r
EFI_PHYSICAL_ADDRESS SpareAddress;\r
UINTN Value;\r
\r
- Value = (UINTN) GetVariableDataPtr (Variable, VariableHeader);\r
- Value += DataSizeOfVariable (VariableHeader);\r
- Value += GET_PAD_SIZE (DataSizeOfVariable (VariableHeader));\r
+ Value = (UINTN) GetVariableDataPtr (Variable, VariableHeader, StoreInfo->AuthFlag);\r
+ Value += DataSizeOfVariable (VariableHeader, StoreInfo->AuthFlag);\r
+ Value += GET_PAD_SIZE (DataSizeOfVariable (VariableHeader, StoreInfo->AuthFlag));\r
//\r
// Be careful about pad size for alignment\r
//\r
IN VARIABLE_STORE_HEADER *VarStoreHeader\r
)\r
{\r
- if (CompareGuid (&VarStoreHeader->Signature, &gEfiVariableGuid) &&\r
+ if ((CompareGuid (&VarStoreHeader->Signature, &gEfiAuthenticatedVariableGuid) ||\r
+ CompareGuid (&VarStoreHeader->Signature, &gEfiVariableGuid)) &&\r
VarStoreHeader->Format == VARIABLE_STORE_FORMATTED &&\r
VarStoreHeader->State == VARIABLE_STORE_HEALTHY\r
) {\r
OUT VARIABLE_POINTER_TRACK *PtrTrack\r
)\r
{\r
- VOID *Point;\r
+ VOID *Point;\r
+ EFI_GUID *TempVendorGuid;\r
+\r
+ TempVendorGuid = GetVendorGuidPtr (VariableHeader, StoreInfo->AuthFlag);\r
\r
if (VariableName[0] == 0) {\r
PtrTrack->CurrPtr = Variable;\r
// Instead we compare the GUID a UINT32 at a time and branch\r
// on the first failed comparison.\r
//\r
- if ((((INT32 *) VendorGuid)[0] == ((INT32 *) &VariableHeader->VendorGuid)[0]) &&\r
- (((INT32 *) VendorGuid)[1] == ((INT32 *) &VariableHeader->VendorGuid)[1]) &&\r
- (((INT32 *) VendorGuid)[2] == ((INT32 *) &VariableHeader->VendorGuid)[2]) &&\r
- (((INT32 *) VendorGuid)[3] == ((INT32 *) &VariableHeader->VendorGuid)[3])\r
+ if ((((INT32 *) VendorGuid)[0] == ((INT32 *) TempVendorGuid)[0]) &&\r
+ (((INT32 *) VendorGuid)[1] == ((INT32 *) TempVendorGuid)[1]) &&\r
+ (((INT32 *) VendorGuid)[2] == ((INT32 *) TempVendorGuid)[2]) &&\r
+ (((INT32 *) VendorGuid)[3] == ((INT32 *) TempVendorGuid)[3])\r
) {\r
- ASSERT (NameSizeOfVariable (VariableHeader) != 0);\r
- Point = (VOID *) GetVariableNamePtr (Variable);\r
- if (CompareVariableName (StoreInfo, VariableName, Point, NameSizeOfVariable (VariableHeader))) {\r
+ ASSERT (NameSizeOfVariable (VariableHeader, StoreInfo->AuthFlag) != 0);\r
+ Point = (VOID *) GetVariableNamePtr (Variable, StoreInfo->AuthFlag);\r
+ if (CompareVariableName (StoreInfo, VariableName, Point, NameSizeOfVariable (VariableHeader, StoreInfo->AuthFlag))) {\r
PtrTrack->CurrPtr = Variable;\r
return EFI_SUCCESS;\r
}\r
return EFI_NOT_FOUND;\r
}\r
\r
+/**\r
+ Get HOB variable store.\r
+\r
+**/\r
+VOID\r
+GetHobVariableStore (\r
+ OUT VARIABLE_STORE_INFO *StoreInfo,\r
+ OUT VARIABLE_STORE_HEADER **VariableStoreHeader\r
+ )\r
+{\r
+ EFI_HOB_GUID_TYPE *GuidHob;\r
+\r
+ GuidHob = GetFirstGuidHob (&gEfiAuthenticatedVariableGuid);\r
+ if (GuidHob != NULL) {\r
+ *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
+ StoreInfo->AuthFlag = TRUE;\r
+ } else {\r
+ GuidHob = GetFirstGuidHob (&gEfiVariableGuid);\r
+ if (GuidHob != NULL) {\r
+ *VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
+ StoreInfo->AuthFlag = FALSE;\r
+ }\r
+ }\r
+}\r
+\r
/**\r
Return the variable store header and the store info based on the Index.\r
\r
\r
StoreInfo->IndexTable = NULL;\r
StoreInfo->FtwLastWriteData = NULL;\r
+ StoreInfo->AuthFlag = FALSE;\r
VariableStoreHeader = NULL;\r
switch (Type) {\r
case VariableStoreTypeHob:\r
- GuidHob = GetFirstGuidHob (&gEfiVariableGuid);\r
- if (GuidHob != NULL) {\r
- VariableStoreHeader = (VARIABLE_STORE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
- }\r
+ GetHobVariableStore (StoreInfo, &VariableStoreHeader);\r
+\r
break;\r
\r
case VariableStoreTypeNv:\r
//\r
\r
NvStorageSize = PcdGet32 (PcdFlashNvStorageVariableSize);\r
- NvStorageBase = (EFI_PHYSICAL_ADDRESS) (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ? \r
- PcdGet64 (PcdFlashNvStorageVariableBase64) : \r
+ NvStorageBase = (EFI_PHYSICAL_ADDRESS) (PcdGet64 (PcdFlashNvStorageVariableBase64) != 0 ?\r
+ PcdGet64 (PcdFlashNvStorageVariableBase64) :\r
PcdGet32 (PcdFlashNvStorageVariableBase)\r
);\r
//\r
\r
VariableStoreHeader = (VARIABLE_STORE_HEADER *) ((UINT8 *) FvHeader + FvHeader->HeaderLength);\r
\r
+ StoreInfo->AuthFlag = (BOOLEAN) (CompareGuid (&VariableStoreHeader->Signature, &gEfiAuthenticatedVariableGuid));\r
+\r
GuidHob = GetFirstGuidHob (&gEfiVariableIndexTableGuid);\r
if (GuidHob != NULL) {\r
StoreInfo->IndexTable = GET_GUID_HOB_DATA (GuidHob);\r
//\r
// If it's the first time to access variable region in flash, create a guid hob to record\r
// VAR_ADDED type variable info.\r
- // Note that as the resource of PEI phase is limited, only store the limited number of \r
+ // Note that as the resource of PEI phase is limited, only store the limited number of\r
// VAR_ADDED type variables to reduce access time.\r
//\r
StoreInfo->IndexTable = (VARIABLE_INDEX_TABLE *) BuildGuidHob (&gEfiVariableIndexTableGuid, sizeof (VARIABLE_INDEX_TABLE));\r
return FALSE;\r
}\r
\r
- //\r
- // First assume variable header pointed by Variable is consecutive.\r
- //\r
+ //\r
+ // First assume variable header pointed by Variable is consecutive.\r
+ //\r
*VariableHeader = Variable;\r
\r
if (StoreInfo->FtwLastWriteData != NULL) {\r
//\r
return FALSE;\r
}\r
- if (((UINTN) Variable < (UINTN) TargetAddress) && (((UINTN) Variable + sizeof (VARIABLE_HEADER)) > (UINTN) TargetAddress)) {\r
+ if (((UINTN) Variable < (UINTN) TargetAddress) && (((UINTN) Variable + GetVariableHeaderSize (StoreInfo->AuthFlag)) > (UINTN) TargetAddress)) {\r
//\r
// Variable header pointed by Variable is inconsecutive,\r
// create a guid hob to combine the two partial variable header content together.\r
if (GuidHob != NULL) {\r
*VariableHeader = (VARIABLE_HEADER *) GET_GUID_HOB_DATA (GuidHob);\r
} else {\r
- *VariableHeader = (VARIABLE_HEADER *) BuildGuidHob (&gEfiCallerIdGuid, sizeof (VARIABLE_HEADER));\r
+ *VariableHeader = (VARIABLE_HEADER *) BuildGuidHob (&gEfiCallerIdGuid, GetVariableHeaderSize (StoreInfo->AuthFlag));\r
PartialHeaderSize = (UINTN) TargetAddress - (UINTN) Variable;\r
//\r
// Partial content is in NV storage.\r
//\r
// Another partial content is in spare block.\r
//\r
- CopyMem ((UINT8 *) *VariableHeader + PartialHeaderSize, (UINT8 *) (UINTN) SpareAddress, sizeof (VARIABLE_HEADER) - PartialHeaderSize);\r
+ CopyMem ((UINT8 *) *VariableHeader + PartialHeaderSize, (UINT8 *) (UINTN) SpareAddress, GetVariableHeaderSize (StoreInfo->AuthFlag) - PartialHeaderSize);\r
}\r
}\r
} else {\r
EFI_PHYSICAL_ADDRESS TargetAddress;\r
EFI_PHYSICAL_ADDRESS SpareAddress;\r
UINTN PartialSize;\r
- \r
+\r
if (StoreInfo->FtwLastWriteData != NULL) {\r
TargetAddress = StoreInfo->FtwLastWriteData->TargetAddress;\r
SpareAddress = StoreInfo->FtwLastWriteData->SpareAddress;\r
Status = FindVariableEx (\r
StoreInfo,\r
VariableName,\r
- VendorGuid, \r
+ VendorGuid,\r
PtrTrack\r
);\r
if (!EFI_ERROR (Status)) {\r
/**\r
This service retrieves a variable's value using its name and GUID.\r
\r
- Read the specified variable from the UEFI variable store. If the Data \r
+ Read the specified variable from the UEFI variable store. If the Data\r
buffer is too small to hold the contents of the variable, the error\r
EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the required buffer\r
size to obtain the data.\r
@param DataSize On entry, points to the size in bytes of the Data buffer.\r
On return, points to the size of the data returned in Data.\r
@param Data Points to the buffer which will hold the returned variable value.\r
+ May be NULL with a zero DataSize in order to determine the size of the buffer needed.\r
\r
@retval EFI_SUCCESS The variable was read successfully.\r
- @retval EFI_NOT_FOUND The variable could not be found.\r
- @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data. \r
- DataSize is updated with the size required for \r
+ @retval EFI_NOT_FOUND The variable was be found.\r
+ @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the resulting data.\r
+ DataSize is updated with the size required for\r
the specified variable.\r
@retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.\r
@retval EFI_DEVICE_ERROR The variable could not be retrieved because of a device error.\r
IN CONST EFI_GUID *VariableGuid,\r
OUT UINT32 *Attributes,\r
IN OUT UINTN *DataSize,\r
- OUT VOID *Data\r
+ OUT VOID *Data OPTIONAL\r
)\r
{\r
VARIABLE_POINTER_TRACK Variable;\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
+ if (VariableName[0] == 0) {\r
+ return EFI_NOT_FOUND;\r
+ }\r
+\r
VariableHeader = NULL;\r
\r
//\r
//\r
// Get data size\r
//\r
- VarDataSize = DataSizeOfVariable (VariableHeader);\r
+ VarDataSize = DataSizeOfVariable (VariableHeader, StoreInfo.AuthFlag);\r
if (*DataSize >= VarDataSize) {\r
if (Data == NULL) {\r
return EFI_INVALID_PARAMETER;\r
}\r
\r
- GetVariableNameOrData (&StoreInfo, GetVariableDataPtr (Variable.CurrPtr, VariableHeader), VarDataSize, Data);\r
+ GetVariableNameOrData (&StoreInfo, GetVariableDataPtr (Variable.CurrPtr, VariableHeader, StoreInfo.AuthFlag), VarDataSize, Data);\r
\r
if (Attributes != NULL) {\r
*Attributes = VariableHeader->Attributes;\r
/**\r
Return the next variable name and GUID.\r
\r
- This function is called multiple times to retrieve the VariableName \r
- and VariableGuid of all variables currently available in the system. \r
- On each call, the previous results are passed into the interface, \r
- and, on return, the interface returns the data for the next \r
- interface. When the entire variable list has been returned, \r
+ This function is called multiple times to retrieve the VariableName\r
+ and VariableGuid of all variables currently available in the system.\r
+ On each call, the previous results are passed into the interface,\r
+ and, on return, the interface returns the data for the next\r
+ interface. When the entire variable list has been returned,\r
EFI_NOT_FOUND is returned.\r
\r
@param This A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.\r
On return, the size of the variable name buffer.\r
@param VariableName On entry, a pointer to a null-terminated string that is the variable's name.\r
On return, points to the next variable's null-terminated name string.\r
- @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID. \r
+ @param VariableGuid On entry, a pointer to an EFI_GUID that is the variable's GUID.\r
On return, a pointer to the next variable's GUID.\r
\r
@retval EFI_SUCCESS The variable was read successfully.\r
}\r
}\r
//\r
- // Capture the case that \r
+ // Capture the case that\r
// 1. current storage is the last one, or\r
// 2. no further storage\r
//\r
//\r
Status = FindVariableEx (\r
&StoreInfo,\r
- GetVariableNamePtr (Variable.CurrPtr),\r
- &VariableHeader->VendorGuid,\r
+ GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag),\r
+ GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag),\r
&VariablePtrTrack\r
);\r
if (!EFI_ERROR (Status) && VariablePtrTrack.CurrPtr != Variable.CurrPtr) {\r
) {\r
Status = FindVariableEx (\r
&StoreInfoForHob,\r
- GetVariableNamePtr (Variable.CurrPtr),\r
- &VariableHeader->VendorGuid, \r
+ GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag),\r
+ GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag),\r
&VariableInHob\r
);\r
if (!EFI_ERROR (Status)) {\r
}\r
}\r
\r
- VarNameSize = NameSizeOfVariable (VariableHeader);\r
+ VarNameSize = NameSizeOfVariable (VariableHeader, StoreInfo.AuthFlag);\r
ASSERT (VarNameSize != 0);\r
\r
if (VarNameSize <= *VariableNameSize) {\r
- GetVariableNameOrData (&StoreInfo, (UINT8 *) GetVariableNamePtr (Variable.CurrPtr), VarNameSize, (UINT8 *) VariableName);\r
+ GetVariableNameOrData (&StoreInfo, (UINT8 *) GetVariableNamePtr (Variable.CurrPtr, StoreInfo.AuthFlag), VarNameSize, (UINT8 *) VariableName);\r
\r
- CopyMem (VariableGuid, &VariableHeader->VendorGuid, sizeof (EFI_GUID));\r
+ CopyMem (VariableGuid, GetVendorGuidPtr (VariableHeader, StoreInfo.AuthFlag), sizeof (EFI_GUID));\r
\r
Status = EFI_SUCCESS;\r
} else {\r
projects / mirror_edk2.git / blobdiff