Add in support for GetNextTokenNumber API.
[mirror_edk2.git] / EdkModulePkg / Universal / PCD / Dxe / Service.c
index 52097ade7e877d0baef83fd08a6c4362db1becee..53d9621e8cd0809b5641f5d4d6579dd7ed72e19d 100644 (file)
@@ -22,13 +22,9 @@ Module Name: Service.c
 // Compression Algorithm will take care of the size optimization.\r
 //\r
 \r
-/*\r
-DXE_PCD_DATABASE_INIT gDXEPcdDbInit = {\r
-  DXE_PCD_DB_INIT_VALUE\r
-};\r
-*/\r
+PCD_DATABASE * mPcdDatabase;\r
 \r
-PCD_DATABASE * gPcdDatabase;\r
+LIST_ENTRY mCallbackFnTable[PCD_TOTAL_TOKEN_NUMBER];\r
 \r
 VOID *\r
 GetWorkerByLocalTokenNumber (\r
@@ -54,9 +50,9 @@ GetWorkerByLocalTokenNumber (
     LocalTokenNumber = GetSkuEnabledTokenNumber (LocalTokenNumber & ~PCD_TYPE_SKU_ENABLED, Size, IsPeiDb);\r
   }\r
 \r
-  PcdDb = IsPeiDb ? ((UINT8 *) &gPcdDatabase->PeiDb) : ((UINT8 *) &gPcdDatabase->DxeDb);\r
-  StringTable = IsPeiDb ? gPcdDatabase->PeiDb.Init.StringTable :\r
-                          gPcdDatabase->DxeDb.Init.StringTable;\r
+  PcdDb = IsPeiDb ? ((UINT8 *) &mPcdDatabase->PeiDb) : ((UINT8 *) &mPcdDatabase->DxeDb);\r
+  StringTable = IsPeiDb ? mPcdDatabase->PeiDb.Init.StringTable :\r
+                          mPcdDatabase->DxeDb.Init.StringTable;\r
   \r
   Offset     = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
   \r
@@ -66,8 +62,8 @@ GetWorkerByLocalTokenNumber (
       return (VOID *) (FixedPcdGet32(PcdVpdBaseAddress) + VpdHead->Offset);\r
       \r
     case PCD_TYPE_HII:\r
-      GuidTable   = IsPeiDb ? gPcdDatabase->PeiDb.Init.GuidTable :\r
-                              gPcdDatabase->DxeDb.Init.GuidTable;\r
+      GuidTable   = IsPeiDb ? mPcdDatabase->PeiDb.Init.GuidTable :\r
+                              mPcdDatabase->DxeDb.Init.GuidTable;\r
                               \r
       VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);\r
       \r
@@ -112,11 +108,11 @@ GetWorker (
   \r
   IsPeiDb = (TokenNumber <= PEI_LOCAL_TOKEN_NUMBER) ? TRUE : FALSE;\r
 \r
-  LocalTokenNumberTable  = IsPeiDb ? gPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
-                                     gPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
+  LocalTokenNumberTable  = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
+                                     mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
 \r
-  SizeTable              = IsPeiDb ? gPcdDatabase->PeiDb.Init.SizeTable: \r
-                                     gPcdDatabase->DxeDb.Init.SizeTable;\r
+  SizeTable              = IsPeiDb ? mPcdDatabase->PeiDb.Init.SizeTable: \r
+                                     mPcdDatabase->DxeDb.Init.SizeTable;\r
 \r
   TokenNumber            = IsPeiDb ? TokenNumber :\r
                                      TokenNumber - PEI_LOCAL_TOKEN_NUMBER;\r
@@ -129,23 +125,150 @@ EFI_STATUS
 DxeRegisterCallBackWorker (\r
   IN  UINTN                   TokenNumber,\r
   IN  CONST GUID              *Guid, OPTIONAL\r
-  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction,\r
-  IN  BOOLEAN                 Register\r
+  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
 )\r
 {\r
+  CALLBACK_FN_ENTRY       *FnTableEntry;\r
+  EX_PCD_ENTRY_ATTRIBUTE  ExAttr;\r
+  LIST_ENTRY              *ListHead;\r
+  LIST_ENTRY              *ListNode;\r
+\r
+  if (Guid != NULL) {\r
+    GetExPcdTokenAttributes (Guid, TokenNumber, &ExAttr);\r
+    TokenNumber = ExAttr.LocalTokenNumberAlias;\r
+  }\r
+\r
+  ListHead = &mCallbackFnTable[TokenNumber];\r
+  ListNode = GetFirstNode (ListHead);\r
+\r
+  while (ListNode != ListHead) {\r
+    FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);\r
+\r
+    if (FnTableEntry->CallbackFn == CallBackFunction) {\r
+      //\r
+      // We only allow a Callback function to be register once\r
+      // for a TokenNumber. So just return EFI_SUCCESS\r
+      //\r
+      return EFI_SUCCESS;\r
+    }\r
+    ListNode = GetNextNode (ListHead, ListNode);\r
+  }\r
+\r
+  FnTableEntry = AllocatePool (sizeof(CALLBACK_FN_ENTRY));\r
+  ASSERT (FnTableEntry != NULL);\r
+\r
+  FnTableEntry->CallbackFn = CallBackFunction;\r
+  InsertTailList (ListHead, &FnTableEntry->Node);\r
   \r
   return EFI_SUCCESS;\r
 }\r
 \r
 \r
+\r
+\r
 EFI_STATUS\r
-DxeGetNextTokenWorker (\r
-  IN OUT UINTN            *TokenNumber,\r
-  IN CONST GUID           *Guid     OPTIONAL\r
+DxeUnRegisterCallBackWorker (\r
+  IN  UINTN                   TokenNumber,\r
+  IN  CONST GUID              *Guid, OPTIONAL\r
+  IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
+)\r
+{\r
+  CALLBACK_FN_ENTRY       *FnTableEntry;\r
+  EX_PCD_ENTRY_ATTRIBUTE  ExAttr;\r
+  LIST_ENTRY              *ListHead;\r
+  LIST_ENTRY              *ListNode;\r
+\r
+  if (Guid != NULL) {\r
+    GetExPcdTokenAttributes (Guid, TokenNumber, &ExAttr);\r
+    TokenNumber = ExAttr.LocalTokenNumberAlias;\r
+  }\r
+\r
+  ListHead = &mCallbackFnTable[TokenNumber];\r
+  ListNode = GetFirstNode (ListHead);\r
+\r
+  while (ListNode != ListHead) {\r
+    FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);\r
+\r
+    if (FnTableEntry->CallbackFn == CallBackFunction) {\r
+      //\r
+      // We only allow a Callback function to be register once\r
+      // for a TokenNumber. So we can safely remove the Node from\r
+      // the Link List and return EFI_SUCCESS.\r
+      //\r
+      RemoveEntryList (ListNode);\r
+      FreePool (FnTableEntry);\r
+      \r
+      return EFI_SUCCESS;\r
+    }\r
+    ListNode = GetNextNode (ListHead, ListNode);\r
+  }\r
+\r
+  return EFI_INVALID_PARAMETER;\r
+}\r
+\r
+\r
+\r
+PCD_TOKEN_NUMBER\r
+ExGetNextTokeNumber (\r
+  IN CONST EFI_GUID         *Guid,\r
+  IN PCD_TOKEN_NUMBER       TokenNumber,\r
+  IN EFI_GUID               *GuidTable,\r
+  IN UINTN                  SizeOfGuidTable,\r
+  IN DYNAMICEX_MAPPING      *ExMapTable,\r
+  IN UINTN                  SizeOfExMapTable\r
   )\r
 {\r
-  return EFI_SUCCESS;\r
+  EFI_GUID         *MatchGuid;\r
+  UINTN            Idx;\r
+  UINTN            GuidTableIdx;\r
+  BOOLEAN          Found;\r
+\r
+  MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);\r
+  if (MatchGuid == NULL) {\r
+    return PCD_INVALID_TOKEN_NUMBER;\r
+  }\r
+\r
+  Found = FALSE;\r
+  GuidTableIdx = MatchGuid - GuidTable;\r
+  for (Idx = 0; Idx < SizeOfExMapTable; Idx++) {\r
+    if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+      Found = TRUE;\r
+      break;\r
+    }\r
+  }\r
+\r
+  if (Found) {\r
+    if (TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r
+      return ExMapTable[Idx].ExTokenNumber;\r
+    }\r
+    \r
+    for ( ; Idx < SizeOfExMapTable; Idx++) {\r
+      if (ExMapTable[Idx].ExTokenNumber == TokenNumber) {\r
+        Idx++;\r
+        if (Idx == SizeOfExMapTable) {\r
+          //\r
+          // Exceed the length of ExMap Table\r
+          //\r
+          return PCD_INVALID_TOKEN_NUMBER;\r
+        } else if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+          //\r
+          // Found the next match\r
+          //\r
+          return ExMapTable[Idx].ExTokenNumber;\r
+        } else {\r
+          //\r
+          // Guid has been changed. It is the next Token Space Guid.\r
+          // We should flag no more TokenNumber.\r
+          //\r
+          return PCD_INVALID_TOKEN_NUMBER;\r
+        }\r
+      }\r
+    }\r
+  }\r
+  \r
+  return PCD_INVALID_TOKEN_NUMBER;\r
 }\r
+  \r
 \r
 \r
 \r
@@ -156,9 +279,10 @@ BuildPcdDxeDataBase (
 {\r
   PEI_PCD_DATABASE    *PeiDatabase;\r
   EFI_HOB_GUID_TYPE   *GuidHob;\r
+  UINTN               Idx;\r
 \r
-  gPcdDatabase = AllocateZeroPool (sizeof(PCD_DATABASE));\r
-  ASSERT (gPcdDatabase != NULL);\r
+  mPcdDatabase = AllocateZeroPool (sizeof(PCD_DATABASE));\r
+  ASSERT (mPcdDatabase != NULL);\r
 \r
   GuidHob = GetFirstGuidHob (&gPcdDataBaseHobGuid);\r
   ASSERT (GuidHob != NULL);\r
@@ -167,12 +291,20 @@ BuildPcdDxeDataBase (
   //\r
   // Copy PCD Entries refereneced in PEI phase to PCD DATABASE\r
   //\r
-  CopyMem (&gPcdDatabase->PeiDb, PeiDatabase, sizeof (PEI_PCD_DATABASE));\r
+  CopyMem (&mPcdDatabase->PeiDb, PeiDatabase, sizeof (PEI_PCD_DATABASE));\r
 \r
   //\r
   // Copy PCD Entries with default value to PCD DATABASE\r
   //\r
-  CopyMem (&gPcdDatabase->DxeDb.Init, &gDXEPcdDbInit, sizeof(DXE_PCD_DATABASE_INIT));\r
+  CopyMem (&mPcdDatabase->DxeDb.Init, &gDXEPcdDbInit, sizeof(DXE_PCD_DATABASE_INIT));\r
+\r
+\r
+  //\r
+  // Initialized the Callback Function Table\r
+  //\r
+  for (Idx = 0; Idx < PCD_TOTAL_TOKEN_NUMBER; Idx++) {\r
+    InitializeListHead (&mCallbackFnTable[Idx]);\r
+  }\r
     \r
   return;\r
 }\r
@@ -233,18 +365,18 @@ GetSkuEnabledTokenNumber (
 \r
   ASSERT ((LocalTokenNumber & PCD_TYPE_SKU_ENABLED) == 0);\r
 \r
-  PcdDb = IsPeiDb ? (UINT8 *) &gPcdDatabase->PeiDb : (UINT8 *) &gPcdDatabase->DxeDb;\r
+  PcdDb = IsPeiDb ? (UINT8 *) &mPcdDatabase->PeiDb : (UINT8 *) &mPcdDatabase->DxeDb;\r
 \r
   SkuHead     = (SKU_HEAD *) (PcdDb + (LocalTokenNumber & PCD_DATABASE_OFFSET_MASK));\r
   Value       = (UINT8 *) (PcdDb + SkuHead->SkuDataStartOffset); \r
 \r
-  PhaseSkuIdTable = IsPeiDb ? gPcdDatabase->PeiDb.Init.SkuIdTable :\r
-                              gPcdDatabase->DxeDb.Init.SkuIdTable;\r
+  PhaseSkuIdTable = IsPeiDb ? mPcdDatabase->PeiDb.Init.SkuIdTable :\r
+                              mPcdDatabase->DxeDb.Init.SkuIdTable;\r
                               \r
   SkuIdTable  = &PhaseSkuIdTable[SkuHead->SkuIdTableOffset];\r
         \r
   for (i = 0; i < SkuIdTable[0]; i++) {\r
-    if (gPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[i + 1]) {\r
+    if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[i + 1]) {\r
       break;\r
     }\r
   }\r
@@ -286,6 +418,24 @@ InvokeCallbackOnSet (
   UINTN             Size\r
   )\r
 {\r
+  CALLBACK_FN_ENTRY       *FnTableEntry;\r
+  LIST_ENTRY              *ListHead;\r
+  LIST_ENTRY              *ListNode;\r
+\r
+  ListHead = &mCallbackFnTable[TokenNumber];\r
+  ListNode = GetFirstNode (ListHead);\r
+\r
+  while (ListNode != ListHead) {\r
+    FnTableEntry = CR_FNENTRY_FROM_LISTNODE(ListNode, CALLBACK_FN_ENTRY, Node);\r
+\r
+    FnTableEntry->CallbackFn(Guid, \r
+                    (Guid == NULL) ? TokenNumber : ExTokenNumber,\r
+                    Data,\r
+                    Size);\r
+    \r
+    ListNode = GetNextNode (ListHead, ListNode);\r
+  }\r
+  \r
   return;\r
 }\r
 \r
@@ -294,10 +444,10 @@ InvokeCallbackOnSet (
 \r
 EFI_STATUS\r
 SetWorker (\r
-  UINTN         TokenNumber,\r
-  VOID          *Data,\r
-  UINTN         Size,\r
-  BOOLEAN       PtrType\r
+  PCD_TOKEN_NUMBER        TokenNumber,\r
+  VOID                    *Data,\r
+  UINTN                   Size,\r
+  BOOLEAN                 PtrType\r
   )\r
 {\r
   UINT32              *LocalTokenNumberTable;\r
@@ -314,14 +464,14 @@ SetWorker (
   \r
   IsPeiDb = (TokenNumber <= PEI_LOCAL_TOKEN_NUMBER) ? TRUE : FALSE;\r
 \r
-  LocalTokenNumberTable  = IsPeiDb ? gPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
-                                     gPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
+  LocalTokenNumberTable  = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
+                                     mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
+\r
+  InvokeCallbackOnSet (0, NULL, TokenNumber, Data, Size);\r
 \r
   TokenNumber = IsPeiDb ? TokenNumber\r
                         : TokenNumber - PEI_LOCAL_TOKEN_NUMBER;\r
   \r
-  InvokeCallbackOnSet (0, NULL, TokenNumber, Data, Size);\r
-\r
   return SetWorkerByLocalTokenNumber (LocalTokenNumberTable[TokenNumber], Data, Size, PtrType, IsPeiDb);\r
 \r
 }\r
@@ -355,7 +505,7 @@ ExGetWorker (
 \r
 EFI_STATUS\r
 ExSetWorker (\r
-  IN UINT32               ExTokenNumber,\r
+  IN PCD_TOKEN_NUMBER     ExTokenNumber,\r
   IN CONST EFI_GUID       *Guid,\r
   VOID                    *Data,\r
   UINTN                   SetSize,\r
@@ -406,10 +556,10 @@ SetWorkerByLocalTokenNumber (
 \r
   Offset = LocalTokenNumber & PCD_DATABASE_OFFSET_MASK;\r
 \r
-  PcdDb = IsPeiDb ? ((UINT8 *) &gPcdDatabase->PeiDb) : ((UINT8 *) &gPcdDatabase->DxeDb);\r
+  PcdDb = IsPeiDb ? ((UINT8 *) &mPcdDatabase->PeiDb) : ((UINT8 *) &mPcdDatabase->DxeDb);\r
 \r
-  StringTable = IsPeiDb ? gPcdDatabase->PeiDb.Init.StringTable :\r
-                          gPcdDatabase->DxeDb.Init.StringTable;\r
+  StringTable = IsPeiDb ? mPcdDatabase->PeiDb.Init.StringTable :\r
+                          mPcdDatabase->DxeDb.Init.StringTable;\r
   \r
   InternalData = PcdDb + Offset;\r
 \r
@@ -426,8 +576,8 @@ SetWorkerByLocalTokenNumber (
       //\r
       // Bug Bug: Please implement this\r
       //\r
-      GuidTable   = IsPeiDb ? gPcdDatabase->PeiDb.Init.GuidTable :\r
-                              gPcdDatabase->DxeDb.Init.GuidTable;\r
+      GuidTable   = IsPeiDb ? mPcdDatabase->PeiDb.Init.GuidTable :\r
+                              mPcdDatabase->DxeDb.Init.GuidTable;\r
                               \r
       VariableHead = (VARIABLE_HEAD *) (PcdDb + Offset);\r
       \r
@@ -533,7 +683,7 @@ SetHiiVariable (
 VOID\r
 GetExPcdTokenAttributes (\r
   IN CONST EFI_GUID             *Guid,\r
-  IN UINT32                     ExTokenNumber,\r
+  IN PCD_TOKEN_NUMBER           ExTokenNumber,\r
   OUT EX_PCD_ENTRY_ATTRIBUTE    *ExAttr\r
   )\r
 {\r
@@ -542,9 +692,9 @@ GetExPcdTokenAttributes (
   EFI_GUID            *GuidTable;\r
   UINT16              *SizeTable;\r
 \r
-  ExMap       = gPcdDatabase->PeiDb.Init.ExMapTable;\r
-  GuidTable   = gPcdDatabase->PeiDb.Init.GuidTable;\r
-  SizeTable   = gPcdDatabase->PeiDb.Init.SizeTable;\r
+  ExMap       = mPcdDatabase->PeiDb.Init.ExMapTable;\r
+  GuidTable   = mPcdDatabase->PeiDb.Init.GuidTable;\r
+  SizeTable   = mPcdDatabase->PeiDb.Init.SizeTable;\r
   \r
   for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
     if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
@@ -560,9 +710,9 @@ GetExPcdTokenAttributes (
     }\r
   }\r
   \r
-  ExMap       = gPcdDatabase->DxeDb.Init.ExMapTable;\r
-  GuidTable   = gPcdDatabase->DxeDb.Init.GuidTable;\r
-  SizeTable   = gPcdDatabase->DxeDb.Init.SizeTable;\r
+  ExMap       = mPcdDatabase->DxeDb.Init.ExMapTable;\r
+  GuidTable   = mPcdDatabase->DxeDb.Init.GuidTable;\r
+  SizeTable   = mPcdDatabase->DxeDb.Init.SizeTable;\r
   \r
   for (i = 0; i < DXE_EXMAPPING_TABLE_SIZE; i++) {\r
     if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
@@ -571,7 +721,7 @@ GetExPcdTokenAttributes (
 \r
         ExAttr->IsPeiDb               = FALSE;\r
         ExAttr->Size                  = SizeTable[i + DXE_NEX_TOKEN_NUMBER];\r
-        ExAttr->TokenNumber           = i + DXE_NEX_TOKEN_NUMBER;\r
+        ExAttr->TokenNumber           = i + PEI_LOCAL_TOKEN_NUMBER;\r
         ExAttr->LocalTokenNumberAlias = ExMap[i].LocalTokenNumber;\r
         return;\r
 \r