Updated MSA by putting Specification element at the end of the header section

[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
// Build Tool will generate PEI_PCD_DB_INIT_VALUE in Autogen.h\r
//\r
/* PEI_PCD_DATABASE_INIT\r
gPEIPcdDbInit = {\r
  PEI_PCD_DB_INIT_VALUE\r
};\r
*/\r
\r
\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_LOCAL_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, &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
  // declare a local for STP.\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 0: //Change to a MACRO 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