/** @file\r
Help functions used by PCD DXE driver.\r
\r
-Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2014, Hewlett-Packard Development Company, L.P.<BR>\r
+Copyright (c) 2006 - 2016, 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
IN UINTN TokenNumber\r
)\r
{\r
+ UINTN TmpTokenNumber;\r
UINT32 *LocalTokenNumberTable;\r
UINT32 LocalTokenNumber;\r
UINTN Size;\r
//\r
TokenNumber--;\r
\r
+ //\r
+ // Backup the TokenNumber passed in as GetPtrTypeSize need the original TokenNumber\r
+ // \r
+ TmpTokenNumber = TokenNumber;\r
+\r
LocalTokenNumberTable = IsPeiDb ? (UINT32 *)((UINT8 *)mPcdDatabase.PeiDb + mPcdDatabase.PeiDb->LocalTokenNumberTableOffset) : \r
(UINT32 *)((UINT8 *)mPcdDatabase.DxeDb + mPcdDatabase.DxeDb->LocalTokenNumberTableOffset);\r
TokenNumber = IsPeiDb ? TokenNumber : TokenNumber - mPeiLocalTokenCount;\r
\r
if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
if (Size == 0) {\r
- GetPtrTypeSize (TokenNumber, &MaxSize);\r
+ GetPtrTypeSize (TmpTokenNumber, &MaxSize);\r
} else {\r
MaxSize = Size;\r
}\r
{\r
PCD_DATABASE_INIT *Database;\r
UINT8 *StringTable;\r
+ UINTN NameSize;\r
PCD_NAME_INDEX *PcdNameIndex;\r
CHAR8 *TokenSpaceName;\r
CHAR8 *PcdName;\r
CHAR8 *Name;\r
\r
+ //\r
+ // Return NULL when PCD name table is absent. \r
+ //\r
+ if (IsPeiDb) {\r
+ if (mPcdDatabase.PeiDb->PcdNameTableOffset == 0) {\r
+ return NULL;\r
+ }\r
+ } else {\r
+ if (mPcdDatabase.DxeDb->PcdNameTableOffset == 0) {\r
+ return NULL;\r
+ }\r
+ }\r
+\r
//\r
// TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
// We have to decrement TokenNumber by 1 to make it usable\r
//\r
// Need to get the full PCD name.\r
//\r
- Name = AllocateZeroPool (AsciiStrSize (TokenSpaceName) + AsciiStrSize (PcdName));\r
+ NameSize = AsciiStrSize (TokenSpaceName) + AsciiStrSize (PcdName);\r
+ Name = AllocateZeroPool (NameSize);\r
ASSERT (Name != NULL);\r
//\r
// Catenate TokenSpaceCName and PcdCName with a '.' to form the full PCD name.\r
//\r
- AsciiStrCat (Name, TokenSpaceName);\r
+ AsciiStrCatS (Name, NameSize, TokenSpaceName);\r
Name[AsciiStrSize (TokenSpaceName) - sizeof (CHAR8)] = '.';\r
- AsciiStrCat (Name, PcdName); \r
+ AsciiStrCatS (Name, NameSize, PcdName); \r
}\r
\r
return Name;\r
// string array in string table.\r
//\r
StringTableIdx = *(STRING_HEAD*)((UINT8 *) PcdDb + VariableHead->DefaultValueOffset); \r
- VaraiableDefaultBuffer = (VOID *) (StringTable + StringTableIdx); \r
+ VaraiableDefaultBuffer = (UINT8 *) (StringTable + StringTableIdx); \r
} else {\r
VaraiableDefaultBuffer = (UINT8 *) PcdDb + VariableHead->DefaultValueOffset;\r
}\r
Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r
if (Status == EFI_SUCCESS) {\r
- if (GetSize == 0) {\r
+ if (DataSize >= (VariableHead->Offset + GetSize)) {\r
+ if (GetSize == 0) {\r
+ //\r
+ // It is a pointer type. So get the MaxSize reserved for\r
+ // this PCD entry.\r
+ //\r
+ GetPtrTypeSize (TmpTokenNumber, &GetSize);\r
+ if (GetSize > (DataSize - VariableHead->Offset)) {\r
+ //\r
+ // Use actual valid size.\r
+ //\r
+ GetSize = DataSize - VariableHead->Offset;\r
+ }\r
+ }\r
//\r
- // It is a pointer type. So get the MaxSize reserved for\r
- // this PCD entry.\r
+ // If the operation is successful, we copy the data\r
+ // to the default value buffer in the PCD Database.\r
+ // So that we can free the Data allocated in GetHiiVariable.\r
//\r
- GetPtrTypeSize (TmpTokenNumber, &GetSize);\r
+ CopyMem (VaraiableDefaultBuffer, Data + VariableHead->Offset, GetSize);\r
}\r
- //\r
- // If the operation is successful, we copy the data\r
- // to the default value buffer in the PCD Database.\r
- // So that we can free the Data allocated in GetHiiVariable.\r
- //\r
- CopyMem (VaraiableDefaultBuffer, Data + VariableHead->Offset, GetSize);\r
FreePool (Data);\r
}\r
RetPtr = (VOID *) VaraiableDefaultBuffer;\r
UINT32 PcdDxeDbLen;\r
VOID *PcdDxeDb;\r
\r
+ //\r
+ // Assign PCD Entries with default value to PCD DATABASE\r
+ //\r
+ mPcdDatabase.DxeDb = LocateExPcdBinary ();\r
+ ASSERT(mPcdDatabase.DxeDb != NULL);\r
+ PcdDxeDbLen = mPcdDatabase.DxeDb->Length + mPcdDatabase.DxeDb->UninitDataBaseSize;\r
+ PcdDxeDb = AllocateZeroPool (PcdDxeDbLen);\r
+ ASSERT (PcdDxeDb != NULL);\r
+ CopyMem (PcdDxeDb, mPcdDatabase.DxeDb, mPcdDatabase.DxeDb->Length);\r
+ FreePool (mPcdDatabase.DxeDb);\r
+ mPcdDatabase.DxeDb = PcdDxeDb;\r
+\r
GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r
if (GuidHob != NULL) {\r
\r
// Assign PCD Entries refereneced in PEI phase to PCD DATABASE\r
//\r
mPcdDatabase.PeiDb = PeiDatabase;\r
+ //\r
+ // Inherit the SystemSkuId from PEI phase.\r
+ //\r
+ mPcdDatabase.DxeDb->SystemSkuId = mPcdDatabase.PeiDb->SystemSkuId;\r
+ } else {\r
+ mPcdDatabase.PeiDb = AllocateZeroPool (sizeof (PEI_PCD_DATABASE));\r
+ ASSERT(mPcdDatabase.PeiDb != NULL);\r
}\r
\r
- //\r
- // Assign PCD Entries with default value to PCD DATABASE\r
- //\r
- mPcdDatabase.DxeDb = LocateExPcdBinary ();\r
- ASSERT(mPcdDatabase.DxeDb != NULL);\r
- PcdDxeDbLen = mPcdDatabase.DxeDb->Length + mPcdDatabase.DxeDb->UninitDataBaseSize;\r
- PcdDxeDb = AllocateZeroPool (PcdDxeDbLen);\r
- ASSERT (PcdDxeDb != NULL);\r
- CopyMem (PcdDxeDb, mPcdDatabase.DxeDb, mPcdDatabase.DxeDb->Length);\r
- FreePool (mPcdDatabase.DxeDb);\r
- mPcdDatabase.DxeDb = PcdDxeDb;\r
-\r
//\r
// Initialized the external PCD database local variables\r
//\r
{\r
SKU_HEAD *SkuHead;\r
SKU_ID *SkuIdTable;\r
- INTN Index;\r
+ UINTN Index;\r
UINT8 *Value;\r
UINT8 *PcdDb;\r
BOOLEAN FoundSku;\r
//\r
FoundSku = FALSE;\r
for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
- if (mPcdDatabase.PeiDb->SystemSkuId == SkuIdTable[Index + 1]) {\r
+ if (mPcdDatabase.DxeDb->SystemSkuId == SkuIdTable[Index + 1]) {\r
FoundSku = TRUE;\r
break;\r
}\r
EFI_GUID *Guid;\r
UINT16 *Name;\r
UINTN VariableOffset;\r
+ UINT32 Attributes;\r
VOID *InternalData;\r
VARIABLE_HEAD *VariableHead;\r
UINTN Offset;\r
Guid = GuidTable + VariableHead->GuidTableIndex;\r
Name = (UINT16*) (StringTable + VariableHead->StringIndex);\r
VariableOffset = VariableHead->Offset;\r
- Status = SetHiiVariable (Guid, Name, Data, *Size, VariableOffset);\r
-\r
- if (EFI_NOT_FOUND == Status) {\r
- if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {\r
- CopyMem (\r
- StringTable + *(STRING_HEAD *)(PcdDb + VariableHead->DefaultValueOffset),\r
- Data,\r
- *Size\r
- );\r
- } else {\r
- CopyMem (PcdDb + VariableHead->DefaultValueOffset, Data, *Size);\r
- } \r
- Status = EFI_SUCCESS;\r
- }\r
+ Attributes = VariableHead->Attributes;\r
+ Status = SetHiiVariable (Guid, Name, Attributes, Data, *Size, VariableOffset);\r
break;\r
\r
case PCD_TYPE_DATA:\r
\r
}\r
\r
+/**\r
+ Get variable size and data from HII-type PCDs.\r
+\r
+ @param[in] VariableGuid Guid of variable which stored value of a HII-type PCD.\r
+ @param[in] VariableName Unicode name of variable which stored value of a HII-type PCD.\r
+ @param[out] VariableSize Pointer to variable size got from HII-type PCDs.\r
+ @param[out] VariableData Pointer to variable data got from HII-type PCDs.\r
+\r
+**/\r
+VOID\r
+GetVariableSizeAndDataFromHiiPcd (\r
+ IN EFI_GUID *VariableGuid,\r
+ IN UINT16 *VariableName,\r
+ OUT UINTN *VariableSize,\r
+ OUT VOID *VariableData OPTIONAL\r
+ )\r
+{\r
+ BOOLEAN IsPeiDb;\r
+ PCD_DATABASE_INIT *Database;\r
+ UINTN TokenNumber;\r
+ UINT32 LocalTokenNumber;\r
+ UINTN Offset;\r
+ EFI_GUID *GuidTable;\r
+ UINT8 *StringTable;\r
+ VARIABLE_HEAD *VariableHead;\r
+ EFI_GUID *Guid;\r
+ UINT16 *Name;\r
+ UINTN PcdDataSize;\r
+ UINTN Size;\r
+ UINT8 *VaraiableDefaultBuffer;\r
+ STRING_HEAD StringTableIdx;\r
+\r
+ *VariableSize = 0;\r
+\r
+ //\r
+ // Go through PCD database to find out DynamicHii PCDs.\r
+ //\r
+ for (TokenNumber = 1; TokenNumber <= mPcdTotalTokenCount; TokenNumber++) {\r
+ IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < mPeiLocalTokenCount + 1) ? TRUE : FALSE);\r
+ Database = IsPeiDb ? mPcdDatabase.PeiDb: mPcdDatabase.DxeDb;\r
+ LocalTokenNumber = GetLocalTokenNumber (IsPeiDb, TokenNumber);\r
+ if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {\r
+ //\r
+ // Get the Variable Guid and Name pointer.\r
+ //\r
+ Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
+ VariableHead = (VARIABLE_HEAD *) ((UINT8 *) Database + Offset);\r
+ StringTable = (UINT8 *) ((UINT8 *) Database + Database->StringTableOffset);\r
+ GuidTable = (EFI_GUID *) ((UINT8 *) Database + Database->GuidTableOffset);\r
+ Guid = GuidTable + VariableHead->GuidTableIndex;\r
+ Name = (UINT16*) (StringTable + VariableHead->StringIndex);\r
+ if (CompareGuid (VariableGuid, Guid) && (StrCmp (VariableName, Name) == 0)) {\r
+ //\r
+ // It is the matched DynamicHii PCD.\r
+ //\r
+ PcdDataSize = DxePcdGetSize (TokenNumber);\r
+ Size = VariableHead->Offset + PcdDataSize;\r
+ if (Size > *VariableSize) {\r
+ *VariableSize = Size;\r
+ }\r
+ if (VariableData != NULL) {\r
+ if ((LocalTokenNumber & PCD_TYPE_ALL_SET) == (PCD_TYPE_HII|PCD_TYPE_STRING)) {\r
+ //\r
+ // If a HII type PCD's datum type is VOID*, the DefaultValueOffset is the index of\r
+ // string array in string table.\r
+ //\r
+ StringTableIdx = *(STRING_HEAD *) ((UINT8 *) Database + VariableHead->DefaultValueOffset);\r
+ VaraiableDefaultBuffer = (UINT8 *) (StringTable + StringTableIdx);\r
+ } else {\r
+ VaraiableDefaultBuffer = (UINT8 *) Database + VariableHead->DefaultValueOffset;\r
+ }\r
+ CopyMem ((UINT8 *) VariableData + VariableHead->Offset, VaraiableDefaultBuffer, PcdDataSize);\r
+ }\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
/**\r
Set value for HII-type PCD.\r
\r
\r
@param VariableGuid Guid of variable which stored value of a HII-type PCD.\r
@param VariableName Unicode name of variable which stored value of a HII-type PCD.\r
+ @param SetAttributes Attributes bitmask to set for the variable.\r
@param Data Value want to be set.\r
@param DataSize Size of value\r
@param Offset Value offset of HII-type PCD in variable.\r
SetHiiVariable (\r
IN EFI_GUID *VariableGuid,\r
IN UINT16 *VariableName,\r
+ IN UINT32 SetAttributes,\r
IN CONST VOID *Data,\r
IN UINTN DataSize,\r
IN UINTN Offset\r
//\r
// Patch new PCD's value to offset in given HII variable.\r
//\r
- if (Size >= (DataSize + Offset)) {\r
+ if (Size >= (DataSize + Offset)) {\r
SetSize = Size;\r
} else {\r
SetSize = DataSize + Offset;\r
\r
CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);\r
\r
+ if (SetAttributes == 0) {\r
+ SetAttributes = Attribute;\r
+ }\r
+\r
Status = gRT->SetVariable (\r
VariableName,\r
VariableGuid,\r
- Attribute,\r
+ SetAttributes,\r
SetSize,\r
Buffer\r
);\r
//\r
// If variable does not exist, a new variable need to be created.\r
//\r
- \r
- Size = Offset + DataSize;\r
- \r
+\r
+ //\r
+ // Get size, allocate buffer and get data.\r
+ //\r
+ GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, NULL);\r
Buffer = AllocateZeroPool (Size);\r
ASSERT (Buffer != NULL);\r
- \r
+ GetVariableSizeAndDataFromHiiPcd (VariableGuid, VariableName, &Size, Buffer);\r
+\r
+ //\r
+ // Update buffer.\r
+ //\r
CopyMem ((UINT8 *)Buffer + Offset, Data, DataSize);\r
- \r
+\r
+ if (SetAttributes == 0) {\r
+ SetAttributes = EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE;\r
+ }\r
+\r
Status = gRT->SetVariable (\r
VariableName,\r
VariableGuid,\r
- EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
+ SetAttributes,\r
Size,\r
Buffer\r
);\r
}\r
\r
//\r
- // If we drop to here, the value is failed to be written in to variable area\r
- // So, we will save the data in the PCD Database's volatile area.\r
+ // If we drop to here, the value is failed to be written in to variable area.\r
//\r
return Status;\r
}\r
\r
MatchGuidIdx = MatchGuid - GuidTable;\r
\r
- for (Index = 0; Index < mPeiExMapppingTableSize; Index++) {\r
+ for (Index = 0; Index < mPcdDatabase.PeiDb->ExTokenCount; Index++) {\r
if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
(MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
return ExMap[Index].TokenNumber;\r
\r
MatchGuidIdx = MatchGuid - GuidTable;\r
\r
- for (Index = 0; Index < mDxeExMapppingTableSize; Index++) {\r
+ for (Index = 0; Index < mPcdDatabase.DxeDb->ExTokenCount; Index++) {\r
if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
(MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
return ExMap[Index].TokenNumber;\r
//\r
SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
- if (SkuIdTable[1 + Index] == mPcdDatabase.PeiDb->SystemSkuId) {\r
+ if (SkuIdTable[1 + Index] == mPcdDatabase.DxeDb->SystemSkuId) {\r
return SizeTable[SizeTableIdx + 1 + Index];\r
}\r
}\r
//\r
SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
- if (SkuIdTable[1 + Index] == mPcdDatabase.PeiDb->SystemSkuId) {\r
+ if (SkuIdTable[1 + Index] == mPcdDatabase.DxeDb->SystemSkuId) {\r
SizeTable[SizeTableIdx + 1 + Index] = (SIZE_INFO) *CurrentSize;\r
return TRUE;\r
}\r
}\r
}\r
}\r
+\r
+/**\r
+ VariableLock DynamicHiiPcd.\r
+\r
+ @param[in] IsPeiDb If TRUE, the pcd entry is initialized in PEI phase,\r
+ If FALSE, the pcd entry is initialized in DXE phase.\r
+ @param[in] VariableLock Pointer to VariableLockProtocol.\r
+\r
+**/\r
+VOID\r
+VariableLockDynamicHiiPcd (\r
+ IN BOOLEAN IsPeiDb,\r
+ IN EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ PCD_DATABASE_INIT *Database;\r
+ UINT32 LocalTokenCount; \r
+ UINTN TokenNumber;\r
+ UINT32 LocalTokenNumber;\r
+ UINTN Offset;\r
+ EFI_GUID *GuidTable;\r
+ UINT8 *StringTable;\r
+ VARIABLE_HEAD *VariableHead;\r
+ EFI_GUID *Guid;\r
+ UINT16 *Name;\r
+\r
+ Database = IsPeiDb ? mPcdDatabase.PeiDb: mPcdDatabase.DxeDb;\r
+ LocalTokenCount = IsPeiDb ? mPeiLocalTokenCount: mDxeLocalTokenCount;\r
+\r
+ //\r
+ // Go through PCD database to find out DynamicHii PCDs.\r
+ //\r
+ for (TokenNumber = 1; TokenNumber <= LocalTokenCount; TokenNumber++) {\r
+ if (IsPeiDb) {\r
+ LocalTokenNumber = GetLocalTokenNumber (TRUE, TokenNumber);\r
+ } else {\r
+ LocalTokenNumber = GetLocalTokenNumber (FALSE, TokenNumber + mPeiLocalTokenCount);\r
+ }\r
+ if ((LocalTokenNumber & PCD_TYPE_HII) != 0) {\r
+ Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
+ VariableHead = (VARIABLE_HEAD *) ((UINT8 *) Database + Offset);\r
+ //\r
+ // Why not to set property by VarCheckProtocol with Attributes and Property directly here?\r
+ // It is because that set property by VarCheckProtocol will indicate the variable to\r
+ // be a system variable, but the unknown max size of the variable is dangerous to\r
+ // the system variable region.\r
+ //\r
+ if ((VariableHead->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0) {\r
+ //\r
+ // DynamicHii PCD with RO property set in *.dsc.\r
+ //\r
+ StringTable = (UINT8 *) ((UINT8 *) Database + Database->StringTableOffset);\r
+ GuidTable = (EFI_GUID *) ((UINT8 *) Database + Database->GuidTableOffset);\r
+ Guid = GuidTable + VariableHead->GuidTableIndex;\r
+ Name = (UINT16*) (StringTable + VariableHead->StringIndex);\r
+ Status = VariableLock->RequestToLock (VariableLock, Name, Guid);\r
+ ASSERT_EFI_ERROR (Status);\r
+ }\r
+ }\r
+ }\r
+}\r
+\r
+/**\r
+ VariableLockProtocol callback\r
+ to lock the variables referenced by DynamicHii PCDs with RO property set in *.dsc.\r
+\r
+ @param[in] Event Event whose notification function is being invoked.\r
+ @param[in] Context Pointer to the notification function's context.\r
+\r
+**/\r
+VOID\r
+EFIAPI\r
+VariableLockCallBack (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ EDKII_VARIABLE_LOCK_PROTOCOL *VariableLock;\r
+\r
+ Status = gBS->LocateProtocol (&gEdkiiVariableLockProtocolGuid, NULL, (VOID **) &VariableLock);\r
+ if (!EFI_ERROR (Status)) {\r
+ VariableLockDynamicHiiPcd (TRUE, VariableLock);\r
+ VariableLockDynamicHiiPcd (FALSE, VariableLock);\r
+ }\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff