Add [in,out] in the @param for PCD header and c file.

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

diff --git a/EdkModulePkg/Universal/PCD/Pei/Pcd.c b/EdkModulePkg/Universal/PCD/Pei/Pcd.c
index 34af220f6686ded58515fd20fb4aa9c2b33ea5af..40013cf8b538aed32ba0ff7df184e7743d4e1da3 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Pei/Pcd.c
+++ b/EdkModulePkg/Universal/PCD/Pei/Pcd.c
@@ -52,7 +52,8 @@ PCD_PPI mPcdPpiInstance = {
 \r
   PeiRegisterCallBackOnSet,\r
   PcdUnRegisterCallBackOnSet,\r
-  PeiPcdGetNextToken\r
+  PeiPcdGetNextToken,\r
+  PeiPcdGetNextTokenSpace\r
 };\r
 \r
 \r
@@ -169,6 +170,11 @@ PeiPcdGetSize (
   IN UINTN             TokenNumber\r
   )\r
 {\r
+  PEI_PCD_DATABASE    *PeiPcdDb;\r
+  UINTN               Size;\r
+  UINTN               MaxSize;\r
+\r
+  PeiPcdDb = GetPcdDatabase ();\r
   //\r
   // TokenNumber Zero is reserved as PCD_INVALID_TOKEN_NUMBER.\r
   // We have to decrement TokenNumber by 1 to make it usable\r
@@ -176,9 +182,22 @@ PeiPcdGetSize (
   //\r
   TokenNumber--;\r
 \r
-  ASSERT (TokenNumber < PEI_LOCAL_TOKEN_NUMBER);\r
+  // EBC compiler is very choosy. It may report warning about comparison\r
+  // between UINTN and 0 . So we add 1 in each size of the \r
+  // comparison.\r
+  ASSERT (TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
+\r
+  Size = (PeiPcdDb->Init.LocalTokenNumberTable[TokenNumber] & PCD_DATUM_TYPE_ALL_SET) >> PCD_DATUM_TYPE_SHIFT;\r
+\r
+  if (Size == 0) {\r
+    //\r
+    // For pointer type, we need to scan the SIZE_TABLE to get the current size.\r
+    //\r
+    return GetPtrTypeSize (TokenNumber, &MaxSize, PeiPcdDb);\r
+  } else {\r
+    return Size;\r
+  }\r
 \r
-  return GetPcdDatabase()->Init.SizeTable[TokenNumber];\r
 }\r
 \r
 \r
@@ -271,10 +290,10 @@ EFI_STATUS
 EFIAPI\r
 PeiPcdSet8 (\r
   IN UINTN                        TokenNumber,\r
-  IN UINT8             Value\r
+  IN UINT8                        Value\r
   )\r
 {\r
-  return SetWorker (TokenNumber, &Value, sizeof (Value), FALSE);\r
+  return SetValueWorker (TokenNumber, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -282,11 +301,11 @@ PeiPcdSet8 (
 EFI_STATUS\r
 EFIAPI\r
 PeiPcdSet16 (\r
-  IN UINTN                         TokenNumber,\r
-  IN UINT16             Value\r
+  IN UINTN                          TokenNumber,\r
+  IN UINT16                         Value\r
   )\r
 {\r
-  return SetWorker (TokenNumber, &Value, sizeof (Value), FALSE);\r
+  return SetValueWorker (TokenNumber, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -294,11 +313,11 @@ PeiPcdSet16 (
 EFI_STATUS\r
 EFIAPI\r
 PeiPcdSet32 (\r
-  IN UINTN                         TokenNumber,\r
-  IN UINT32             Value\r
+  IN UINTN                          TokenNumber,\r
+  IN UINT32                         Value\r
   )\r
 {\r
-  return SetWorker (TokenNumber, &Value, sizeof (Value), FALSE);\r
+  return SetValueWorker (TokenNumber, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -306,20 +325,20 @@ PeiPcdSet32 (
 EFI_STATUS\r
 EFIAPI\r
 PeiPcdSet64 (\r
-  IN UINTN                         TokenNumber,\r
-  IN UINT64             Value\r
+  IN UINTN                          TokenNumber,\r
+  IN UINT64                         Value\r
   )\r
 {\r
-  return SetWorker (TokenNumber, &Value, sizeof (Value), FALSE);\r
+  return SetValueWorker (TokenNumber, &Value, sizeof (Value));\r
 }\r
 \r
 \r
 EFI_STATUS\r
 EFIAPI\r
 PeiPcdSetPtr (\r
-  IN UINTN                         TokenNumber,\r
-  IN UINTN                         SizeOfBuffer,\r
-  IN VOID                          *Buffer\r
+  IN      UINTN                         TokenNumber,\r
+  IN OUT  UINTN                         *SizeOfBuffer,\r
+  IN      VOID                          *Buffer\r
   )\r
 {\r
   return SetWorker (TokenNumber, Buffer, SizeOfBuffer, TRUE);\r
@@ -330,11 +349,11 @@ PeiPcdSetPtr (
 EFI_STATUS\r
 EFIAPI\r
 PeiPcdSetBool (\r
-  IN UINTN                         TokenNumber,\r
-  IN BOOLEAN            Value\r
+  IN UINTN                          TokenNumber,\r
+  IN BOOLEAN                        Value\r
   )\r
 {\r
-  return SetWorker (TokenNumber, &Value, sizeof (Value), FALSE);\r
+  return SetValueWorker (TokenNumber, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -347,13 +366,7 @@ PeiPcdSet8Ex (
   IN UINT8                  Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              &Value, \r
-                              sizeof (Value), \r
-                              FALSE\r
-                              );\r
+  return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -366,13 +379,7 @@ PeiPcdSet16Ex (
   IN UINT16                 Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              &Value, \r
-                              sizeof (Value), \r
-                              FALSE\r
-                              );\r
+  return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -385,13 +392,7 @@ PeiPcdSet32Ex (
   IN UINT32                 Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              &Value, \r
-                              sizeof (Value), \r
-                              FALSE\r
-                              );\r
+  return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -404,13 +405,7 @@ PeiPcdSet64Ex (
   IN UINT64                 Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              &Value, \r
-                              sizeof (Value), \r
-                              FALSE\r
-                              );\r
+  return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -420,17 +415,11 @@ EFIAPI
 PeiPcdSetPtrEx (\r
   IN CONST EFI_GUID         *Guid,\r
   IN UINTN                  ExTokenNumber,\r
-  IN UINTN                  SizeOfBuffer,\r
+  IN UINTN                  *SizeOfBuffer,\r
   IN VOID                   *Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              Value, \r
-                              SizeOfBuffer, \r
-                              TRUE\r
-                              );\r
+  return ExSetWorker (ExTokenNumber, Guid, Value, SizeOfBuffer, TRUE);\r
 }\r
 \r
 \r
@@ -443,13 +432,7 @@ PeiPcdSetBoolEx (
   IN BOOLEAN              Value\r
   )\r
 {\r
-  return          ExSetWorker(\r
-                              ExTokenNumber, \r
-                              Guid,\r
-                              &Value, \r
-                              sizeof (Value), \r
-                              FALSE\r
-                              );\r
+  return ExSetValueWorker (ExTokenNumber, Guid, &Value, sizeof (Value));\r
 }\r
 \r
 \r
@@ -458,8 +441,8 @@ PeiPcdSetBoolEx (
 EFI_STATUS\r
 EFIAPI\r
 PeiRegisterCallBackOnSet (\r
-  IN  UINTN                       ExTokenNumber,\r
   IN  CONST EFI_GUID              *Guid, OPTIONAL\r
+  IN  UINTN                       ExTokenNumber,\r
   IN  PCD_PPI_CALLBACK            CallBackFunction\r
   )\r
 {\r
@@ -473,8 +456,8 @@ PeiRegisterCallBackOnSet (
 EFI_STATUS\r
 EFIAPI\r
 PcdUnRegisterCallBackOnSet (\r
-  IN  UINTN                       ExTokenNumber,\r
   IN  CONST EFI_GUID              *Guid, OPTIONAL\r
+  IN  UINTN                       ExTokenNumber,\r
   IN  PCD_PPI_CALLBACK            CallBackFunction\r
   )\r
 {\r
@@ -499,18 +482,23 @@ PeiPcdGetNextToken (
   UINTN               i;\r
   BOOLEAN             Found;\r
     \r
+  if (!FeaturePcdGet (PcdPeiPcdDatabaseTraverseEnabled)) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+    \r
   if (Guid == NULL) {\r
+    if (*TokenNumber > PEI_NEX_TOKEN_NUMBER) {\r
+      return EFI_NOT_FOUND;\r
+    }\r
     (*TokenNumber)++;\r
-\r
-    if (*TokenNumber >= PEI_NEX_TOKEN_NUMBER) {\r
+    if (*TokenNumber > PEI_NEX_TOKEN_NUMBER) {\r
       *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
     }\r
-    \r
+    return EFI_SUCCESS;\r
   } else {\r
-\r
     if (PEI_EXMAP_TABLE_EMPTY) {\r
       *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
-      return EFI_NOT_FOUND;\r
+      return EFI_SUCCESS;\r
     }\r
     \r
     //\r
@@ -523,7 +511,7 @@ PeiPcdGetNextToken (
     MatchGuid = ScanGuid (PeiPcdDb->Init.GuidTable, sizeof(PeiPcdDb->Init.GuidTable), Guid);\r
 \r
     if (MatchGuid == NULL) {\r
-      *TokenNumber = (UINTN) PCD_INVALID_TOKEN_NUMBER;\r
+      *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
       return EFI_NOT_FOUND;\r
     }\r
 \r
@@ -532,6 +520,9 @@ PeiPcdGetNextToken (
     ExMapTable = PeiPcdDb->Init.ExMapTable;\r
 \r
     Found = FALSE;\r
+    //\r
+    // Locate the GUID in ExMapTable first.\r
+    //\r
     for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
       if (ExMapTable[i].ExGuidIndex == GuidTableIdx) {\r
         Found = TRUE;\r
@@ -544,31 +535,38 @@ PeiPcdGetNextToken (
         *TokenNumber = ExMapTable[i].ExTokenNumber;\r
          return EFI_SUCCESS;\r
       }\r
-      \r
-      for ( ; ExMapTable[i].ExGuidIndex == GuidTableIdx; i++) {\r
+\r
+      for ( ; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
         if (ExMapTable[i].ExTokenNumber == *TokenNumber) {\r
           i++;\r
+          if (i == PEI_EXMAPPING_TABLE_SIZE) {\r
+            //\r
+            // Exceed the length of ExMap Table\r
+            //\r
+            *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
+            return EFI_SUCCESS;\r
+          }\r
           if (ExMapTable[i].ExGuidIndex == GuidTableIdx) {\r
             *TokenNumber = ExMapTable[i].ExTokenNumber;\r
             return EFI_SUCCESS;\r
           } else {\r
-            *TokenNumber = (UINTN) PCD_INVALID_TOKEN_NUMBER;\r
+            *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
             return EFI_SUCCESS;\r
           }\r
         }\r
       }\r
-\r
       return EFI_NOT_FOUND;\r
     }\r
-    \r
   }\r
 \r
-  return EFI_SUCCESS;\r
+  return EFI_NOT_FOUND;\r
 }\r
 \r
+\r
+\r
 EFI_STATUS\r
 EFIAPI\r
-PeiPcdGetNextTokenSpaceGuid (\r
+PeiPcdGetNextTokenSpace (\r
   IN OUT CONST EFI_GUID               **Guid\r
   )\r
 {\r
@@ -579,17 +577,19 @@ PeiPcdGetNextTokenSpaceGuid (
   UINTN               i;\r
   BOOLEAN             Found;\r
 \r
-   if (*Guid == NULL) {\r
-    if (PEI_EXMAP_TABLE_EMPTY) {\r
-      return EFI_SUCCESS;\r
+  if (!FeaturePcdGet (PcdPeiPcdDatabaseTraverseEnabled)) {\r
+    return EFI_UNSUPPORTED;\r
+  }\r
+\r
+  ASSERT (Guid != NULL);\r
+\r
+  if (PEI_EXMAP_TABLE_EMPTY) {\r
+    if (*Guid != NULL) {\r
+      return EFI_NOT_FOUND;\r
     } else {\r
-      //\r
-      // return the first Token Space Guid.\r
-      //\r
-      *Guid = &PeiPcdDb->Init.GuidTable[ExMapTable[0].ExGuidIndex];\r
       return EFI_SUCCESS;\r
     }\r
-   }\r
+  }\r
 \r
   //\r
   // Assume PCD Database AutoGen tool is sorting the ExMap based on the following order\r
@@ -598,6 +598,16 @@ PeiPcdGetNextTokenSpaceGuid (
   //\r
   PeiPcdDb = GetPcdDatabase ();\r
 \r
+  ExMapTable = PeiPcdDb->Init.ExMapTable;\r
+\r
+  if (*Guid == NULL) {\r
+    //\r
+    // return the first Token Space Guid.\r
+    //\r
+    *Guid = &PeiPcdDb->Init.GuidTable[ExMapTable[0].ExGuidIndex];\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
   MatchGuid = ScanGuid (PeiPcdDb->Init.GuidTable, sizeof(PeiPcdDb->Init.GuidTable), *Guid);\r
 \r
   if (MatchGuid == NULL) {\r
@@ -606,8 +616,6 @@ PeiPcdGetNextTokenSpaceGuid (
   \r
   GuidTableIdx = MatchGuid - PeiPcdDb->Init.GuidTable;\r
 \r
-  ExMapTable = PeiPcdDb->Init.ExMapTable;\r
-\r
   Found = FALSE;\r
   for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
     if (ExMapTable[i].ExGuidIndex == GuidTableIdx) {\r
@@ -617,12 +625,15 @@ PeiPcdGetNextTokenSpaceGuid (
   }\r
 \r
   if (Found) {\r
+    i++;\r
     for ( ; i < PEI_EXMAPPING_TABLE_SIZE; i++ ) {\r
       if (ExMapTable[i].ExGuidIndex != GuidTableIdx ) {\r
         *Guid = &PeiPcdDb->Init.GuidTable[ExMapTable[i].ExGuidIndex];\r
         return EFI_SUCCESS;\r
       }\r
     }\r
+    *Guid = NULL;\r
+    return EFI_SUCCESS;\r
   }\r
 \r
   return EFI_NOT_FOUND;\r