[mirror_edk2.git] / EdkModulePkg / Universal / PCD / Pei / Service.c

/** @file\r
Private functions used by PCD PEIM.\r
\r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. 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
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
Module Name: Service.c\r
\r
**/\r
#include "Service.h"\r
\r
\r
/**\r
  The function registers the CallBackOnSet fucntion\r
  according to TokenNumber and EFI_GUID space.\r
\r
  @param[in]  TokenNumber       The token number.\r
  @param[in]  Guid              The GUID space.\r
  @param[in]  CallBackFunction  The Callback function to be registered.\r
\r
  @retval EFI_SUCCESS If the Callback function is registered.\r
  @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r
--*/\r
EFI_STATUS\r
PeiRegisterCallBackWorker (\r
  IN  UINTN                       ExTokenNumber,\r
  IN  CONST EFI_GUID              *Guid, OPTIONAL\r
  IN  PCD_PPI_CALLBACK            CallBackFunction,\r
  IN  BOOLEAN                     Register\r
)\r
{\r
  EFI_HOB_GUID_TYPE       *GuidHob;\r
  PCD_PPI_CALLBACK        *CallbackTable;\r
  PCD_PPI_CALLBACK        Compare;\r
  PCD_PPI_CALLBACK        Assign;\r
  UINT32                  LocalTokenNumber;\r
  UINTN                   TokenNumber;\r
  UINTN                   Idx;\r
  EX_PCD_ENTRY_ATTRIBUTE  Attr;\r
\r
  if (Guid == NULL) {\r
    TokenNumber = ExTokenNumber;\r
    ASSERT (TokenNumber < PEI_NEX_TOKEN_NUMBER);\r
    LocalTokenNumber = GetPcdDatabase()->Init.LocalTokenNumberTable[TokenNumber];\r
  } else {\r
    GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
    TokenNumber = Attr.TokenNumber;\r
    LocalTokenNumber = Attr.LocalTokenNumberAlias;\r
  }\r
\r
  ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);\r
  ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);\r
\r
  GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
  ASSERT (GuidHob != NULL);\r
  \r
  CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
\r
  Compare = Register? NULL: CallBackFunction;\r
  Assign  = Register? CallBackFunction: NULL;\r
\r
  for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
    if (CallbackTable[Idx] == Compare) {\r
      CallbackTable[Idx] = Assign;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
\r
  return Register? EFI_OUT_OF_RESOURCES : EFI_NOT_FOUND;\r
\r
}\r
\r
\r
\r
\r
/**\r
  The function builds the PCD database based on the\r
  PCD_IMAGE on the flash.\r
\r
  @param[in] PcdImageOnFlash  The PCD image on flash.\r
\r
  @retval VOID\r
--*/\r
VOID\r
BuildPcdDatabase (\r
  VOID\r
  )\r
{\r
  PEI_PCD_DATABASE  *Database;\r
  VOID              *CallbackFnTable;\r
  UINTN             SizeOfCallbackFnTable;\r
  \r
  Database = BuildGuidHob (&gPcdDataBaseHobGuid, sizeof (PEI_PCD_DATABASE));\r
\r
  ZeroMem (Database, sizeof (PEI_PCD_DATABASE));\r
\r
  //\r
  // gPEIPcdDbInit is smaller than PEI_PCD_DATABASE\r
  //\r
  \r
  CopyMem (&Database->Init, &gPEIPcdDbInit, sizeof (gPEIPcdDbInit));\r
\r
  SizeOfCallbackFnTable = PEI_LOCAL_TOKEN_NUMBER * sizeof (PCD_PPI_CALLBACK) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry);\r
\r
  CallbackFnTable = BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid, SizeOfCallbackFnTable);\r
  \r
  ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);\r
  \r
  return;\r
}\r
\r
\r
\r
/**\r
  The function is provided by PCD PEIM and PCD DXE driver to\r
  do the work of reading a HII variable from variable service.\r
\r
  @param[in] VariableGuid     The Variable GUID.\r
  @param[in] VariableName     The Variable Name.\r
  @param[out] VariableData    The output data.\r
  @param[out] VariableSize    The size of the variable.\r
\r
  @retval EFI_SUCCESS         Operation successful.\r
  @retval EFI_SUCCESS         Variablel not found.\r
--*/\r
EFI_STATUS\r
GetHiiVariable (\r
  IN  CONST EFI_GUID      *VariableGuid,\r
  IN  UINT16              *VariableName,\r
  OUT VOID                **VariableData,\r
  OUT UINTN               *VariableSize\r
  )\r
{\r
  UINTN      Size;\r
  EFI_STATUS Status;\r
  VOID       *Buffer;\r
  EFI_PEI_READ_ONLY_VARIABLE_PPI *VariablePpi;\r
\r
  Status = PeiCoreLocatePpi (&gEfiPeiReadOnlyVariablePpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Size = 0;\r
\r
  Status = VariablePpi->PeiGetVariable (\r
                          GetPeiServicesTablePointer (),\r
                          VariableName,\r
                          (EFI_GUID *) VariableGuid,\r
                          NULL,\r
                          &Size,\r
                          NULL\r
                            );\r
  ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
\r
  Status = PeiCoreAllocatePool (Size, &Buffer);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  Status = VariablePpi->PeiGetVariable (\r
                            GetPeiServicesTablePointer (),\r
                            (UINT16 *) VariableName,\r
                            (EFI_GUID *) VariableGuid,\r
                            NULL,\r
                            &Size,\r
                            Buffer\r
                            );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  *VariableSize = Size;\r
  *VariableData = Buffer;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
\r
UINT32\r
GetSkuEnabledTokenNumber (\r
  UINT32 LocalTokenNumber,\r
  UINTN  Size\r
  ) \r
{\r
  PEI_PCD_DATABASE      *PeiPcdDb;\r
  SKU_HEAD              *SkuHead;\r
  SKU_ID                *SkuIdTable;\r
  INTN                  i;\r
  UINT8                 *Value;\r
\r
  PeiPcdDb = GetPcdDatabase ();\r
\r
  ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r
\r
  SkuHead     = (SKU_HEAD *) ((UINT8 *)PeiPcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
  Value       = (UINT8 *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuDataStartOffset));\r
  SkuIdTable  = (SKU_ID *) ((UINT8 *)PeiPcdDb + (SkuHead->SkuIdTableOffset));\r
        \r
  for (i = 0; i < SkuIdTable[0]; i++) {\r
    if (PeiPcdDb->Init.SystemSkuId == SkuIdTable[i + 1]) {\r
      break;\r
    }\r
  }\r
\r
  switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
    case PCD_TYPE_VPD:\r
      Value += sizeof(VPD_HEAD) * i;\r
      return ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_VPD);\r
\r
    case PCD_TYPE_HII:\r
      Value += sizeof(VARIABLE_HEAD) * i;\r
      return ((Value - (UINT8 *) PeiPcdDb) | PCD_TYPE_HII);\r
      \r
    case PCD_TYPE_DATA:\r
      Value += Size * i;\r
      return (Value - (UINT8 *) PeiPcdDb);\r
      \r
    default:\r
      ASSERT (FALSE);\r
  }\r
\r
  ASSERT (FALSE);\r
\r
  return 0;\r
  \r
}\r
\r
\r
\r
\r
VOID\r
InvokeCallbackOnSet (\r
  UINT32            ExTokenNumber,\r
  CONST EFI_GUID    *Guid, OPTIONAL\r
  UINTN             TokenNumber,\r
  VOID              *Data,\r
  UINTN             Size\r
  )\r
{\r
  EFI_HOB_GUID_TYPE   *GuidHob;\r
  PCD_PPI_CALLBACK    *CallbackTable;\r
  UINTN               Idx;\r
\r
  if (Guid == NULL)\r
    ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
\r
  GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
  ASSERT (GuidHob != NULL);\r
  \r
  CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
\r
  CallbackTable += (TokenNumber * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
\r
  for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
    if (CallbackTable[Idx] != NULL) {\r
      CallbackTable[Idx] (Guid,\r
                          (Guid == NULL)? TokenNumber: ExTokenNumber,\r
                          Data,\r
                          Size\r
                          );\r
    }\r
  }\r
  \r
}\r
\r
EFI_STATUS\r
SetWorker (\r
  UINTN         TokenNumber,\r
  VOID          *Data,\r
  UINTN         Size,\r
  BOOLEAN       PtrType\r
  )\r
{\r
  UINT32              LocalTokenNumber;\r
  PEI_PCD_DATABASE    *PeiPcdDb;\r
\r
  ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
    \r
  PeiPcdDb = GetPcdDatabase ();\r
\r
  LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
\r
  if (PtrType) {\r
    ASSERT (PeiPcdDb->Init.SizeTable[TokenNumber] >= Size);\r
  } else {\r
    ASSERT (PeiPcdDb->Init.SizeTable[TokenNumber] == Size);\r
  }\r
\r
  InvokeCallbackOnSet (0, NULL, TokenNumber, Data, Size);\r
\r
  return SetWorkerByLocalTokenNumber (LocalTokenNumber, Data, Size, PtrType);\r
\r
}\r
\r
\r
\r
\r
EFI_STATUS\r
ExSetWorker (\r
  IN UINT32               ExTokenNumber,\r
  IN CONST EFI_GUID       *Guid,\r
  VOID                    *Data,\r
  UINTN                   Size,\r
  BOOLEAN                 PtrType\r
  )\r
{\r
  PEI_PCD_DATABASE          *PeiPcdDb;\r
  EX_PCD_ENTRY_ATTRIBUTE    Attr;\r
\r
\r
  PeiPcdDb = GetPcdDatabase ();\r
\r
  GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
\r
  ASSERT (!PtrType && Attr.Size);\r
\r
  ASSERT (PtrType && Attr.Size >= Size);\r
\r
  InvokeCallbackOnSet (ExTokenNumber, Guid, Attr.TokenNumber, Data, Size);\r
\r
  SetWorkerByLocalTokenNumber (Attr.LocalTokenNumberAlias, Data, Size, PtrType);\r
\r
  return EFI_SUCCESS;\r
  \r
}\r
\r
\r
\r
\r
EFI_STATUS\r
SetWorkerByLocalTokenNumber (\r
  UINT32        LocalTokenNumber,\r
  VOID          *Data,\r
  UINTN         Size,\r
  BOOLEAN       PtrType\r
  )\r
{\r
  PEI_PCD_DATABASE      *PeiPcdDb;\r
  UINT8                 *PeiPcdDbRaw;\r
  UINT16                StringTableIdx;\r
  UINTN                 Offset;\r
  VOID                  *InternalData;\r
 \r
\r
  PeiPcdDb    =    GetPcdDatabase ();\r
  PeiPcdDbRaw =    (UINT8 *) PeiPcdDb;\r
  \r
  if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
    LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, Size);\r
  }\r
\r
  Offset          = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
  InternalData    = (VOID *) (PeiPcdDbRaw + Offset);\r
  \r
  switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
    case PCD_TYPE_VPD:\r
    case PCD_TYPE_HII:\r
    {\r
      ASSERT (FALSE);\r
      return EFI_INVALID_PARAMETER;\r
    }\r
\r
    case PCD_TYPE_STRING:\r
      StringTableIdx = *((UINT16 *)InternalData);\r
      CopyMem (&PeiPcdDb->Init.StringTable[StringTableIdx], Data, Size);\r
      break;\r
\r
    case PCD_TYPE_DATA:\r
    {\r
      \r
      if (PtrType) {\r
        CopyMem (InternalData, Data, Size);\r
        return EFI_SUCCESS;\r
      }\r
\r
      switch (Size) {\r
        case sizeof(UINT8):\r
          *((UINT8 *) InternalData) = *((UINT8 *) Data);\r
          return EFI_SUCCESS;\r
\r
        case sizeof(UINT16):\r
          *((UINT16 *) InternalData) = *((UINT16 *) Data);\r
          return EFI_SUCCESS;\r
\r
        case sizeof(UINT32):\r
          *((UINT32 *) InternalData) = *((UINT32 *) Data);\r
          return EFI_SUCCESS;\r
\r
        case sizeof(UINT64):\r
          *((UINT64 *) InternalData) = *((UINT64 *) Data);\r
          return EFI_SUCCESS;\r
\r
        default:\r
          ASSERT (FALSE);\r
          return EFI_NOT_FOUND;\r
      }\r
    }\r
      \r
  }\r
\r
  ASSERT (FALSE);\r
  return EFI_NOT_FOUND;\r
}\r
\r
\r
VOID *\r
GetWorkerByLocalTokenNumber (\r
  PEI_PCD_DATABASE    *PeiPcdDb,\r
  UINT32              LocalTokenNumber,\r
  UINTN               Size\r
  )\r
{\r
  UINT32              Offset;\r
  EFI_GUID            *Guid;\r
  UINT16              *Name;\r
  VARIABLE_HEAD       *VariableHead;\r
  EFI_STATUS          Status;\r
  UINTN               DataSize;\r
  VOID                *Data;\r
  UINT16              *StringTable;\r
  UINT16              StringTableIdx;\r
      \r
  PeiPcdDb        = GetPcdDatabase ();\r
\r
  if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
    LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, Size);\r
  }\r
\r
  Offset      = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
  StringTable = PeiPcdDb->Init.StringTable;\r
  \r
  switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
    case PCD_TYPE_VPD:\r
    {\r
      VPD_HEAD *VpdHead;\r
      VpdHead = (VPD_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
      return (VOID *) (FixedPcdGet32(PcdVpdBaseAddress) + VpdHead->Offset);\r
    }\r
      \r
    case PCD_TYPE_HII:\r
    {\r
      VariableHead = (VARIABLE_HEAD *) ((UINT8 *)PeiPcdDb + Offset);\r
      \r
      Guid = &(PeiPcdDb->Init.GuidTable[VariableHead->GuidTableIndex]);\r
      Name = &StringTable[VariableHead->StringIndex];\r
\r
      Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r
      ASSERT_EFI_ERROR (Status);\r
      ASSERT (DataSize >= (UINTN) (VariableHead->Offset + Size));\r
\r
      return (VOID *) ((UINT8 *) Data + VariableHead->Offset);\r
    }\r
\r
    case PCD_TYPE_DATA:\r
      return (VOID *) ((UINT8 *)PeiPcdDb + Offset);\r
      break;\r
\r
    case PCD_TYPE_STRING:\r
      StringTableIdx = (UINT16) *((UINT8 *) PeiPcdDb + Offset);\r
      return (VOID *) (&StringTable[StringTableIdx]);\r
\r
    default:\r
      ASSERT (FALSE);\r
      break;\r
      \r
  }\r
\r
  ASSERT (FALSE);\r
      \r
  return NULL;\r
  \r
}\r
\r
\r
VOID *\r
ExGetWorker (\r
  IN CONST  EFI_GUID  *Guid,\r
  IN UINT32           ExTokenNumber,\r
  IN UINTN            GetSize\r
  )\r
{\r
  EX_PCD_ENTRY_ATTRIBUTE      Attr;\r
\r
  GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
  \r
  ASSERT ((GetSize == Attr.Size) || (GetSize == 0));\r
\r
  return GetWorkerByLocalTokenNumber (GetPcdDatabase(),\r
                                      Attr.LocalTokenNumberAlias,\r
                                      Attr.Size\r
                                      );\r
}\r
\r
VOID *\r
GetWorker (\r
  UINTN  TokenNumber,\r
  UINTN   GetSize\r
  )\r
{\r
  PEI_PCD_DATABASE      *PeiPcdDb;\r
\r
  ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
\r
  ASSERT (GetSize == PeiPcdGetSize (TokenNumber) || GetSize == 0);\r
\r
  PeiPcdDb = GetPcdDatabase ();\r
  \r
  return  GetWorkerByLocalTokenNumber (PeiPcdDb, PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber], GetSize);\r
}\r
\r
\r
VOID\r
GetExPcdTokenAttributes (\r
  IN CONST EFI_GUID             *Guid,\r
  IN UINT32                     ExTokenNumber,\r
  OUT EX_PCD_ENTRY_ATTRIBUTE    *ExAttr\r
  )\r
{\r
  UINT32              i;\r
  DYNAMICEX_MAPPING   *ExMap;\r
  EFI_GUID            *GuidTable;\r
  PEI_PCD_DATABASE    *PeiPcdDb;\r
\r
  PeiPcdDb    = GetPcdDatabase();\r
  \r
  ExMap       = PeiPcdDb->Init.ExMapTable;\r
  GuidTable   = PeiPcdDb->Init.GuidTable;\r
  \r
  for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
    if ((ExTokenNumber == ExMap[i].ExTokenNumber) && \r
        CompareGuid (Guid, (CONST EFI_GUID *) &GuidTable[ExMap[i].ExGuidIndex])) {\r
      ExAttr->TokenNumber               = i + PEI_NEX_TOKEN_NUMBER;\r
      ExAttr->Size                      = PeiPcdDb->Init.SizeTable[i + PEI_NEX_TOKEN_NUMBER];\r
      ExAttr->LocalTokenNumberAlias     = ExMap[i].LocalTokenNumber;\r
    }\r
  }\r
  \r
  ASSERT (FALSE);\r
  \r
  return;\r
}\r
\r
\r
\r
PEI_PCD_DATABASE *\r
GetPcdDatabase (\r
  VOID\r
  )\r
{\r
  EFI_HOB_GUID_TYPE *GuidHob;\r
\r
  GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r
  ASSERT (GuidHob != NULL);\r
  \r
  return (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);\r
}\r
\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	Private functions used by PCD PEIM.\r
	3	\r
	4	Copyright (c) 2006, Intel Corporation\r
	5	All rights reserved. This program and the accompanying materials\r
	6	are licensed and made available under the terms and conditions of the BSD License\r
	7	which accompanies this distribution. The full text of the license may be found at\r
	8	http://opensource.org/licenses/bsd-license.php\r
	9	\r
	10	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	\r
	13	\r
	14	Module Name: Service.c\r
	15	\r
	16	**/\r
878ddf1f	17	#include "Service.h"\r
	18	\r
	19	\r
878ddf1f	20	/**\r
52e1905d	21	The function registers the CallBackOnSet fucntion\r
52e1905d	22	according to TokenNumber and EFI_GUID space.\r
878ddf1f	23	\r
52e1905d	24	@param[in] TokenNumber The token number.\r
	25	@param[in] Guid The GUID space.\r
	26	@param[in] CallBackFunction The Callback function to be registered.\r
878ddf1f	27	\r
52e1905d	28	@retval EFI_SUCCESS If the Callback function is registered.\r
52e1905d	29	@retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r
878ddf1f	30	--*/\r
52e1905d	31	EFI_STATUS\r
	32	PeiRegisterCallBackWorker (\r
	33	IN UINTN ExTokenNumber,\r
	34	IN CONST EFI_GUID *Guid, OPTIONAL\r
	35	IN PCD_PPI_CALLBACK CallBackFunction,\r
	36	IN BOOLEAN Register\r
878ddf1f	37	)\r
878ddf1f	38	{\r
52e1905d	39	EFI_HOB_GUID_TYPE *GuidHob;\r
	40	PCD_PPI_CALLBACK *CallbackTable;\r
	41	PCD_PPI_CALLBACK Compare;\r
	42	PCD_PPI_CALLBACK Assign;\r
	43	UINT32 LocalTokenNumber;\r
	44	UINTN TokenNumber;\r
	45	UINTN Idx;\r
	46	EX_PCD_ENTRY_ATTRIBUTE Attr;\r
878ddf1f	47	\r
52e1905d	48	if (Guid == NULL) {\r
52e1905d	49	TokenNumber = ExTokenNumber;\r
00b7af13	50	ASSERT (TokenNumber < PEI_NEX_TOKEN_NUMBER);\r
52e1905d	51	LocalTokenNumber = GetPcdDatabase()->Init.LocalTokenNumberTable[TokenNumber];\r
	52	} else {\r
	53	GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
	54	TokenNumber = Attr.TokenNumber;\r
	55	LocalTokenNumber = Attr.LocalTokenNumberAlias;\r
	56	}\r
878ddf1f	57	\r
52e1905d	58	ASSERT ((LocalTokenNumber & PCD_TYPE_HII) == 0);\r
52e1905d	59	ASSERT ((LocalTokenNumber & PCD_TYPE_VPD) == 0);\r
878ddf1f	60	\r
52e1905d	61	GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
878ddf1f	62	ASSERT (GuidHob != NULL);\r
52e1905d	63	\r
52e1905d	64	CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
878ddf1f	65	\r
52e1905d	66	Compare = Register? NULL: CallBackFunction;\r
52e1905d	67	Assign = Register? CallBackFunction: NULL;\r
878ddf1f	68	\r
52e1905d	69	for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
	70	if (CallbackTable[Idx] == Compare) {\r
	71	CallbackTable[Idx] = Assign;\r
	72	return EFI_SUCCESS;\r
	73	}\r
	74	}\r
878ddf1f	75	\r
52e1905d	76	return Register? EFI_OUT_OF_RESOURCES : EFI_NOT_FOUND;\r
878ddf1f	77	\r
878ddf1f	78	}\r
	79	\r
	80	\r
878ddf1f	81	\r
878ddf1f	82	\r
52e1905d	83	/**\r
	84	The function builds the PCD database based on the\r
	85	PCD_IMAGE on the flash.\r
878ddf1f	86	\r
52e1905d	87	@param[in] PcdImageOnFlash The PCD image on flash.\r
878ddf1f	88	\r
52e1905d	89	@retval VOID\r
878ddf1f	90	--*/\r
52e1905d	91	VOID\r
	92	BuildPcdDatabase (\r
	93	VOID\r
878ddf1f	94	)\r
878ddf1f	95	{\r
52e1905d	96	PEI_PCD_DATABASE *Database;\r
	97	VOID *CallbackFnTable;\r
	98	UINTN SizeOfCallbackFnTable;\r
	99	\r
	100	Database = BuildGuidHob (&gPcdDataBaseHobGuid, sizeof (PEI_PCD_DATABASE));\r
878ddf1f	101	\r
52e1905d	102	ZeroMem (Database, sizeof (PEI_PCD_DATABASE));\r
878ddf1f	103	\r
878ddf1f	104	//\r
52e1905d	105	// gPEIPcdDbInit is smaller than PEI_PCD_DATABASE\r
878ddf1f	106	//\r
878ddf1f	107	\r
52e1905d	108	CopyMem (&Database->Init, &gPEIPcdDbInit, sizeof (gPEIPcdDbInit));\r
878ddf1f	109	\r
52e1905d	110	SizeOfCallbackFnTable = PEI_LOCAL_TOKEN_NUMBER * sizeof (PCD_PPI_CALLBACK) * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry);\r
878ddf1f	111	\r
52e1905d	112	CallbackFnTable = BuildGuidHob (&gPcdPeiCallbackFnTableHobGuid, SizeOfCallbackFnTable);\r
	113	\r
	114	ZeroMem (CallbackFnTable, SizeOfCallbackFnTable);\r
	115	\r
	116	return;\r
878ddf1f	117	}\r
	118	\r
	119	\r
	120	\r
	121	/**\r
52e1905d	122	The function is provided by PCD PEIM and PCD DXE driver to\r
52e1905d	123	do the work of reading a HII variable from variable service.\r
878ddf1f	124	\r
52e1905d	125	@param[in] VariableGuid The Variable GUID.\r
	126	@param[in] VariableName The Variable Name.\r
	127	@param[out] VariableData The output data.\r
	128	@param[out] VariableSize The size of the variable.\r
878ddf1f	129	\r
52e1905d	130	@retval EFI_SUCCESS Operation successful.\r
52e1905d	131	@retval EFI_SUCCESS Variablel not found.\r
878ddf1f	132	--*/\r
878ddf1f	133	EFI_STATUS\r
52e1905d	134	GetHiiVariable (\r
	135	IN CONST EFI_GUID *VariableGuid,\r
	136	IN UINT16 *VariableName,\r
	137	OUT VOID **VariableData,\r
	138	OUT UINTN *VariableSize\r
878ddf1f	139	)\r
878ddf1f	140	{\r
52e1905d	141	UINTN Size;\r
	142	EFI_STATUS Status;\r
	143	VOID *Buffer;\r
	144	EFI_PEI_READ_ONLY_VARIABLE_PPI *VariablePpi;\r
878ddf1f	145	\r
b560bb65	146	Status = PeiCoreLocatePpi (&gEfiPeiReadOnlyVariablePpiGuid, 0, NULL, (VOID **) &VariablePpi);\r
52e1905d	147	ASSERT_EFI_ERROR (Status);\r
878ddf1f	148	\r
52e1905d	149	Size = 0;\r
878ddf1f	150	\r
52e1905d	151	Status = VariablePpi->PeiGetVariable (\r
	152	GetPeiServicesTablePointer (),\r
	153	VariableName,\r
	154	(EFI_GUID *) VariableGuid,\r
	155	NULL,\r
	156	&Size,\r
	157	NULL\r
	158	);\r
	159	ASSERT (Status == EFI_BUFFER_TOO_SMALL);\r
	160	\r
	161	Status = PeiCoreAllocatePool (Size, &Buffer);\r
	162	ASSERT_EFI_ERROR (Status);\r
	163	\r
52e1905d	164	Status = VariablePpi->PeiGetVariable (\r
	165	GetPeiServicesTablePointer (),\r
	166	(UINT16 *) VariableName,\r
	167	(EFI_GUID *) VariableGuid,\r
	168	NULL,\r
	169	&Size,\r
	170	Buffer\r
	171	);\r
	172	ASSERT_EFI_ERROR (Status);\r
	173	\r
	174	*VariableSize = Size;\r
	175	*VariableData = Buffer;\r
878ddf1f	176	\r
	177	return EFI_SUCCESS;\r
	178	}\r
	179	\r
	180	\r
52e1905d	181	UINT32\r
	182	GetSkuEnabledTokenNumber (\r
	183	UINT32 LocalTokenNumber,\r
	184	UINTN Size\r
	185	) \r
878ddf1f	186	{\r
52e1905d	187	PEI_PCD_DATABASE *PeiPcdDb;\r
	188	SKU_HEAD *SkuHead;\r
	189	SKU_ID *SkuIdTable;\r
	190	INTN i;\r
	191	UINT8 *Value;\r
	192	\r
	193	PeiPcdDb = GetPcdDatabase ();\r
	194	\r
	195	ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r
	196	\r
	197	SkuHead = (SKU_HEAD ) ((UINT8 )PeiPcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
	198	Value = (UINT8 ) ((UINT8 )PeiPcdDb + (SkuHead->SkuDataStartOffset));\r
	199	SkuIdTable = (SKU_ID ) ((UINT8 )PeiPcdDb + (SkuHead->SkuIdTableOffset));\r
	200	\r
	201	for (i = 0; i < SkuIdTable[0]; i++) {\r
	202	if (PeiPcdDb->Init.SystemSkuId == SkuIdTable[i + 1]) {\r
	203	break;\r
	204	}\r
	205	}\r
878ddf1f	206	\r
52e1905d	207	switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
	208	case PCD_TYPE_VPD:\r
	209	Value += sizeof(VPD_HEAD) * i;\r
	210	return ((Value - (UINT8 *) PeiPcdDb) \| PCD_TYPE_VPD);\r
	211	\r
	212	case PCD_TYPE_HII:\r
	213	Value += sizeof(VARIABLE_HEAD) * i;\r
	214	return ((Value - (UINT8 *) PeiPcdDb) \| PCD_TYPE_HII);\r
	215	\r
00b7af13	216	case PCD_TYPE_DATA:\r
52e1905d	217	Value += Size * i;\r
	218	return (Value - (UINT8 *) PeiPcdDb);\r
	219	\r
	220	default:\r
	221	ASSERT (FALSE);\r
	222	}\r
878ddf1f	223	\r
52e1905d	224	ASSERT (FALSE);\r
878ddf1f	225	\r
52e1905d	226	return 0;\r
52e1905d	227	\r
878ddf1f	228	}\r
	229	\r
	230	\r
	231	\r
878ddf1f	232	\r
52e1905d	233	VOID\r
	234	InvokeCallbackOnSet (\r
	235	UINT32 ExTokenNumber,\r
	236	CONST EFI_GUID *Guid, OPTIONAL\r
	237	UINTN TokenNumber,\r
	238	VOID *Data,\r
	239	UINTN Size\r
	240	)\r
878ddf1f	241	{\r
878ddf1f	242	EFI_HOB_GUID_TYPE *GuidHob;\r
878ddf1f	243	PCD_PPI_CALLBACK *CallbackTable;\r
52e1905d	244	UINTN Idx;\r
878ddf1f	245	\r
52e1905d	246	if (Guid == NULL)\r
	247	ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
	248	\r
	249	GuidHob = GetFirstGuidHob (&gPcdPeiCallbackFnTableHobGuid);\r
878ddf1f	250	ASSERT (GuidHob != NULL);\r
878ddf1f	251	\r
52e1905d	252	CallbackTable = GET_GUID_HOB_DATA (GuidHob);\r
878ddf1f	253	\r
52e1905d	254	CallbackTable += (TokenNumber * FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry));\r
878ddf1f	255	\r
52e1905d	256	for (Idx = 0; Idx < FixedPcdGet32(PcdMaxPeiPcdCallBackNumberPerPcdEntry); Idx++) {\r
	257	if (CallbackTable[Idx] != NULL) {\r
	258	CallbackTable[Idx] (Guid,\r
	259	(Guid == NULL)? TokenNumber: ExTokenNumber,\r
	260	Data,\r
	261	Size\r
	262	);\r
878ddf1f	263	}\r
878ddf1f	264	}\r
52e1905d	265	\r
878ddf1f	266	}\r
878ddf1f	267	\r
878ddf1f	268	EFI_STATUS\r
52e1905d	269	SetWorker (\r
	270	UINTN TokenNumber,\r
	271	VOID *Data,\r
	272	UINTN Size,\r
	273	BOOLEAN PtrType\r
878ddf1f	274	)\r
878ddf1f	275	{\r
52e1905d	276	UINT32 LocalTokenNumber;\r
52e1905d	277	PEI_PCD_DATABASE *PeiPcdDb;\r
878ddf1f	278	\r
52e1905d	279	ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
	280	\r
	281	PeiPcdDb = GetPcdDatabase ();\r
878ddf1f	282	\r
52e1905d	283	LocalTokenNumber = PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber];\r
878ddf1f	284	\r
52e1905d	285	if (PtrType) {\r
	286	ASSERT (PeiPcdDb->Init.SizeTable[TokenNumber] >= Size);\r
	287	} else {\r
	288	ASSERT (PeiPcdDb->Init.SizeTable[TokenNumber] == Size);\r
	289	}\r
878ddf1f	290	\r
52e1905d	291	InvokeCallbackOnSet (0, NULL, TokenNumber, Data, Size);\r
878ddf1f	292	\r
52e1905d	293	return SetWorkerByLocalTokenNumber (LocalTokenNumber, Data, Size, PtrType);\r
878ddf1f	294	\r
878ddf1f	295	}\r
	296	\r
	297	\r
	298	\r
878ddf1f	299	\r
52e1905d	300	EFI_STATUS\r
	301	ExSetWorker (\r
	302	IN UINT32 ExTokenNumber,\r
	303	IN CONST EFI_GUID *Guid,\r
	304	VOID *Data,\r
	305	UINTN Size,\r
	306	BOOLEAN PtrType\r
878ddf1f	307	)\r
878ddf1f	308	{\r
52e1905d	309	PEI_PCD_DATABASE *PeiPcdDb;\r
52e1905d	310	EX_PCD_ENTRY_ATTRIBUTE Attr;\r
878ddf1f	311	\r
878ddf1f	312	\r
52e1905d	313	PeiPcdDb = GetPcdDatabase ();\r
878ddf1f	314	\r
52e1905d	315	GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
878ddf1f	316	\r
52e1905d	317	ASSERT (!PtrType && Attr.Size);\r
878ddf1f	318	\r
52e1905d	319	ASSERT (PtrType && Attr.Size >= Size);\r
878ddf1f	320	\r
52e1905d	321	InvokeCallbackOnSet (ExTokenNumber, Guid, Attr.TokenNumber, Data, Size);\r
878ddf1f	322	\r
52e1905d	323	SetWorkerByLocalTokenNumber (Attr.LocalTokenNumberAlias, Data, Size, PtrType);\r
878ddf1f	324	\r
52e1905d	325	return EFI_SUCCESS;\r
52e1905d	326	\r
878ddf1f	327	}\r
	328	\r
	329	\r
878ddf1f	330	\r
878ddf1f	331	\r
52e1905d	332	EFI_STATUS\r
	333	SetWorkerByLocalTokenNumber (\r
	334	UINT32 LocalTokenNumber,\r
	335	VOID *Data,\r
	336	UINTN Size,\r
	337	BOOLEAN PtrType\r
	338	)\r
878ddf1f	339	{\r
52e1905d	340	PEI_PCD_DATABASE *PeiPcdDb;\r
	341	UINT8 *PeiPcdDbRaw;\r
	342	UINT16 StringTableIdx;\r
	343	UINTN Offset;\r
	344	VOID *InternalData;\r
	345	\r
	346	\r
	347	PeiPcdDb = GetPcdDatabase ();\r
	348	PeiPcdDbRaw = (UINT8 *) PeiPcdDb;\r
878ddf1f	349	\r
52e1905d	350	if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
	351	LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, Size);\r
	352	}\r
878ddf1f	353	\r
52e1905d	354	Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
52e1905d	355	InternalData = (VOID *) (PeiPcdDbRaw + Offset);\r
878ddf1f	356	\r
52e1905d	357	switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
	358	case PCD_TYPE_VPD:\r
	359	case PCD_TYPE_HII:\r
	360	{\r
	361	ASSERT (FALSE);\r
	362	return EFI_INVALID_PARAMETER;\r
	363	}\r
878ddf1f	364	\r
52e1905d	365	case PCD_TYPE_STRING:\r
	366	StringTableIdx = ((UINT16 )InternalData);\r
	367	CopyMem (&PeiPcdDb->Init.StringTable[StringTableIdx], Data, Size);\r
	368	break;\r
878ddf1f	369	\r
52e1905d	370	case PCD_TYPE_DATA:\r
	371	{\r
	372	\r
	373	if (PtrType) {\r
	374	CopyMem (InternalData, Data, Size);\r
	375	return EFI_SUCCESS;\r
	376	}\r
878ddf1f	377	\r
52e1905d	378	switch (Size) {\r
	379	case sizeof(UINT8):\r
	380	((UINT8 ) InternalData) = ((UINT8 ) Data);\r
	381	return EFI_SUCCESS;\r
878ddf1f	382	\r
52e1905d	383	case sizeof(UINT16):\r
	384	((UINT16 ) InternalData) = ((UINT16 ) Data);\r
	385	return EFI_SUCCESS;\r
878ddf1f	386	\r
52e1905d	387	case sizeof(UINT32):\r
	388	((UINT32 ) InternalData) = ((UINT32 ) Data);\r
	389	return EFI_SUCCESS;\r
878ddf1f	390	\r
52e1905d	391	case sizeof(UINT64):\r
	392	((UINT64 ) InternalData) = ((UINT64 ) Data);\r
	393	return EFI_SUCCESS;\r
878ddf1f	394	\r
52e1905d	395	default:\r
	396	ASSERT (FALSE);\r
	397	return EFI_NOT_FOUND;\r
	398	}\r
	399	}\r
	400	\r
878ddf1f	401	}\r
878ddf1f	402	\r
52e1905d	403	ASSERT (FALSE);\r
52e1905d	404	return EFI_NOT_FOUND;\r
878ddf1f	405	}\r
	406	\r
	407	\r
52e1905d	408	VOID *\r
	409	GetWorkerByLocalTokenNumber (\r
	410	PEI_PCD_DATABASE *PeiPcdDb,\r
	411	UINT32 LocalTokenNumber,\r
	412	UINTN Size\r
878ddf1f	413	)\r
878ddf1f	414	{\r
52e1905d	415	UINT32 Offset;\r
	416	EFI_GUID *Guid;\r
	417	UINT16 *Name;\r
	418	VARIABLE_HEAD *VariableHead;\r
	419	EFI_STATUS Status;\r
	420	UINTN DataSize;\r
	421	VOID *Data;\r
	422	UINT16 *StringTable;\r
	423	UINT16 StringTableIdx;\r
	424	\r
	425	PeiPcdDb = GetPcdDatabase ();\r
	426	\r
	427	if ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == PCD_TYPE_SKU_ENABLED) {\r
	428	LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, Size);\r
	429	}\r
878ddf1f	430	\r
52e1905d	431	Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
	432	StringTable = PeiPcdDb->Init.StringTable;\r
	433	\r
	434	switch (LocalTokenNumber & ~PCD_DATABASE_OFFSET_MASK) {\r
	435	case PCD_TYPE_VPD:\r
	436	{\r
	437	VPD_HEAD *VpdHead;\r
	438	VpdHead = (VPD_HEAD ) ((UINT8 )PeiPcdDb + Offset);\r
	439	return (VOID *) (FixedPcdGet32(PcdVpdBaseAddress) + VpdHead->Offset);\r
	440	}\r
	441	\r
	442	case PCD_TYPE_HII:\r
	443	{\r
	444	VariableHead = (VARIABLE_HEAD ) ((UINT8 )PeiPcdDb + Offset);\r
	445	\r
	446	Guid = &(PeiPcdDb->Init.GuidTable[VariableHead->GuidTableIndex]);\r
	447	Name = &StringTable[VariableHead->StringIndex];\r
	448	\r
	449	Status = GetHiiVariable (Guid, Name, &Data, &DataSize);\r
	450	ASSERT_EFI_ERROR (Status);\r
	451	ASSERT (DataSize >= (UINTN) (VariableHead->Offset + Size));\r
	452	\r
	453	return (VOID ) ((UINT8 ) Data + VariableHead->Offset);\r
	454	}\r
878ddf1f	455	\r
52e1905d	456	case PCD_TYPE_DATA:\r
	457	return (VOID ) ((UINT8 )PeiPcdDb + Offset);\r
	458	break;\r
878ddf1f	459	\r
52e1905d	460	case PCD_TYPE_STRING:\r
	461	StringTableIdx = (UINT16) ((UINT8 ) PeiPcdDb + Offset);\r
	462	return (VOID *) (&StringTable[StringTableIdx]);\r
878ddf1f	463	\r
52e1905d	464	default:\r
	465	ASSERT (FALSE);\r
	466	break;\r
	467	\r
	468	}\r
878ddf1f	469	\r
52e1905d	470	ASSERT (FALSE);\r
	471	\r
	472	return NULL;\r
	473	\r
	474	}\r
878ddf1f	475	\r
878ddf1f	476	\r
52e1905d	477	VOID *\r
	478	ExGetWorker (\r
	479	IN CONST EFI_GUID *Guid,\r
	480	IN UINT32 ExTokenNumber,\r
	481	IN UINTN GetSize\r
878ddf1f	482	)\r
878ddf1f	483	{\r
52e1905d	484	EX_PCD_ENTRY_ATTRIBUTE Attr;\r
878ddf1f	485	\r
52e1905d	486	GetExPcdTokenAttributes (Guid, ExTokenNumber, &Attr);\r
878ddf1f	487	\r
52e1905d	488	ASSERT ((GetSize == Attr.Size) \|\| (GetSize == 0));\r
878ddf1f	489	\r
52e1905d	490	return GetWorkerByLocalTokenNumber (GetPcdDatabase(),\r
	491	Attr.LocalTokenNumberAlias,\r
	492	Attr.Size\r
	493	);\r
878ddf1f	494	}\r
878ddf1f	495	\r
52e1905d	496	VOID *\r
	497	GetWorker (\r
	498	UINTN TokenNumber,\r
	499	UINTN GetSize\r
878ddf1f	500	)\r
878ddf1f	501	{\r
52e1905d	502	PEI_PCD_DATABASE *PeiPcdDb;\r
878ddf1f	503	\r
52e1905d	504	ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
878ddf1f	505	\r
52e1905d	506	ASSERT (GetSize == PeiPcdGetSize (TokenNumber) \|\| GetSize == 0);\r
878ddf1f	507	\r
52e1905d	508	PeiPcdDb = GetPcdDatabase ();\r
	509	\r
	510	return GetWorkerByLocalTokenNumber (PeiPcdDb, PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber], GetSize);\r
	511	}\r
878ddf1f	512	\r
878ddf1f	513	\r
52e1905d	514	VOID\r
	515	GetExPcdTokenAttributes (\r
	516	IN CONST EFI_GUID *Guid,\r
	517	IN UINT32 ExTokenNumber,\r
	518	OUT EX_PCD_ENTRY_ATTRIBUTE *ExAttr\r
	519	)\r
	520	{\r
	521	UINT32 i;\r
	522	DYNAMICEX_MAPPING *ExMap;\r
	523	EFI_GUID *GuidTable;\r
	524	PEI_PCD_DATABASE *PeiPcdDb;\r
878ddf1f	525	\r
52e1905d	526	PeiPcdDb = GetPcdDatabase();\r
	527	\r
	528	ExMap = PeiPcdDb->Init.ExMapTable;\r
	529	GuidTable = PeiPcdDb->Init.GuidTable;\r
	530	\r
	531	for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
	532	if ((ExTokenNumber == ExMap[i].ExTokenNumber) && \r
	533	CompareGuid (Guid, (CONST EFI_GUID *) &GuidTable[ExMap[i].ExGuidIndex])) {\r
	534	ExAttr->TokenNumber = i + PEI_NEX_TOKEN_NUMBER;\r
	535	ExAttr->Size = PeiPcdDb->Init.SizeTable[i + PEI_NEX_TOKEN_NUMBER];\r
	536	ExAttr->LocalTokenNumberAlias = ExMap[i].LocalTokenNumber;\r
	537	}\r
	538	}\r
	539	\r
	540	ASSERT (FALSE);\r
	541	\r
	542	return;\r
878ddf1f	543	}\r
	544	\r
	545	\r
	546	\r
52e1905d	547	PEI_PCD_DATABASE *\r
	548	GetPcdDatabase (\r
	549	VOID\r
878ddf1f	550	)\r
878ddf1f	551	{\r
52e1905d	552	EFI_HOB_GUID_TYPE *GuidHob;\r
878ddf1f	553	\r
52e1905d	554	GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r
	555	ASSERT (GuidHob != NULL);\r
	556	\r
	557	return (PEI_PCD_DATABASE *) GET_GUID_HOB_DATA (GuidHob);\r
	558	}\r
878ddf1f	559	\r