]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/PCD/Dxe/Service.c
Add function header and pass ECC tools
[mirror_edk2.git] / MdeModulePkg / Universal / PCD / Dxe / Service.c
index 4403e6ea52e03d764bcb15d9729201eb17fd1515..42177917d83b49b31ad857319a93a14928f5c3d9 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-Private functions used by PCD DXE driver.\r
+    Help functions used by PCD DXE driver.\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -10,22 +10,32 @@ http://opensource.org/licenses/bsd-license.php
 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
 \r
 #include "Service.h"\r
 \r
-\r
 PCD_DATABASE * mPcdDatabase;\r
 \r
 LIST_ENTRY *mCallbackFnTable;\r
 \r
+/**\r
+  Get the PCD entry pointer in PCD database.\r
+  \r
+  This routine will visit PCD database to find the PCD entry according to given\r
+  token number. The given token number is autogened by build tools and it will be \r
+  translated to local token number. Local token number contains PCD's type and \r
+  offset of PCD entry in PCD database.\r
+\r
+  @param TokenNumber     Token's number, it is autogened by build tools\r
+  @param GetSize         The size of token's value\r
+\r
+  @return PCD entry pointer in PCD database\r
+\r
+**/\r
 VOID *\r
 GetWorker (\r
-  UINTN             TokenNumber,\r
-  UINTN             GetSize\r
+  IN UINTN             TokenNumber,\r
+  IN UINTN             GetSize\r
   )\r
 {\r
   UINT32              *LocalTokenNumberTable;\r
@@ -163,12 +173,24 @@ GetWorker (
   \r
 }\r
 \r
+/**\r
+  Register the callback function for a PCD entry.\r
+\r
+  This routine will register a callback function to a PCD entry by given token number\r
+  and token space guid.\r
+  \r
+  @param TokenNumber        PCD token's number, it is autogened by build tools.\r
+  @param Guid               PCD token space's guid, \r
+                            if not NULL, this PCD is dynamicEx type PCD.\r
+  @param CallBackFunction   Callback function pointer\r
 \r
+  @return EFI_SUCCESS Always success for registering callback function.\r
 \r
+**/\r
 EFI_STATUS\r
 DxeRegisterCallBackWorker (\r
   IN  UINTN                   TokenNumber,\r
-  IN  CONST GUID              *Guid, OPTIONAL\r
+  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
 )\r
 {\r
@@ -212,13 +234,24 @@ DxeRegisterCallBackWorker (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  UnRegister the callback function for a PCD entry.\r
 \r
+  This routine will unregister a callback function to a PCD entry by given token number\r
+  and token space guid.\r
 \r
+  @param TokenNumber        PCD token's number, it is autogened by build tools.\r
+  @param Guid               PCD token space's guid.\r
+                            if not NULL, this PCD is dynamicEx type PCD.\r
+  @param CallBackFunction   Callback function pointer\r
 \r
+  @retval EFI_SUCCESS               Callback function is success to be unregister.\r
+  @retval EFI_INVALID_PARAMETER     Can not find the PCD entry by given token number.\r
+**/\r
 EFI_STATUS\r
 DxeUnRegisterCallBackWorker (\r
   IN  UINTN                   TokenNumber,\r
-  IN  CONST GUID              *Guid, OPTIONAL\r
+  IN  CONST EFI_GUID          *Guid, OPTIONAL\r
   IN  PCD_PROTOCOL_CALLBACK   CallBackFunction\r
 )\r
 {\r
@@ -260,8 +293,31 @@ DxeUnRegisterCallBackWorker (
   return EFI_INVALID_PARAMETER;\r
 }\r
 \r
+/**\r
+  Get next token number in given token space.\r
+  \r
+  This routine is used for dynamicEx type PCD. It will firstly scan token space\r
+  table to get token space according to given token space guid. Then scan given \r
+  token number in found token space, if found, then return next token number in \r
+  this token space.\r
+\r
+  @param Guid            Token space guid. Next token number will be scaned in \r
+                         this token space.\r
+  @param TokenNumber     Token number. \r
+                         If PCD_INVALID_TOKEN_NUMBER, return first token number in \r
+                         token space table.\r
+                         If not PCD_INVALID_TOKEN_NUMBER, return next token number\r
+                         in token space table.\r
+  @param GuidTable       Token space guid table. It will be used for scan token space\r
+                         by given token space guid.\r
+  @param SizeOfGuidTable The size of guid table.\r
+  @param ExMapTable      DynamicEx token number mapping table.\r
+  @param SizeOfExMapTable The size of dynamicEx token number mapping table.\r
+\r
+  @retval EFI_NOT_FOUND  Can not given token space or token number.\r
+  @retval EFI_SUCCESS    Success to get next token number.\r
 \r
-\r
+**/\r
 EFI_STATUS\r
 ExGetNextTokeNumber (\r
   IN      CONST EFI_GUID         *Guid,\r
@@ -273,44 +329,54 @@ ExGetNextTokeNumber (
   )\r
 {\r
   EFI_GUID         *MatchGuid;\r
-  UINTN            Idx;\r
+  UINTN            Index;\r
   UINTN            GuidTableIdx;\r
   BOOLEAN          Found;\r
 \r
+  //\r
+  // Scan token space guid \r
+  // \r
   MatchGuid = ScanGuid (GuidTable, SizeOfGuidTable, Guid);\r
   if (MatchGuid == NULL) {\r
     return EFI_NOT_FOUND;\r
   }\r
 \r
+  //\r
+  // Find the token space table in dynamicEx mapping table.\r
+  //\r
   Found = FALSE;\r
   GuidTableIdx = MatchGuid - GuidTable;\r
-  for (Idx = 0; Idx < SizeOfExMapTable; Idx++) {\r
-    if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+  for (Index = 0; Index < SizeOfExMapTable; Index++) {\r
+    if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {\r
       Found = TRUE;\r
       break;\r
     }\r
   }\r
 \r
   if (Found) {\r
+    //\r
+    // If given token number is PCD_INVALID_TOKEN_NUMBER, then return the first\r
+    // token number in found token space.\r
+    //\r
     if (*TokenNumber == PCD_INVALID_TOKEN_NUMBER) {\r
-      *TokenNumber = ExMapTable[Idx].ExTokenNumber;\r
+      *TokenNumber = ExMapTable[Index].ExTokenNumber;\r
       return EFI_SUCCESS;\r
     }\r
 \r
-    for ( ; Idx < SizeOfExMapTable; Idx++) {\r
-      if (ExMapTable[Idx].ExTokenNumber == *TokenNumber) {\r
-        Idx++;\r
-        if (Idx == SizeOfExMapTable) {\r
+    for ( ; Index < SizeOfExMapTable; Index++) {\r
+      if (ExMapTable[Index].ExTokenNumber == *TokenNumber) {\r
+        Index ++;\r
+        if (Index == SizeOfExMapTable) {\r
           //\r
           // Exceed the length of ExMap Table\r
           //\r
           *TokenNumber = PCD_INVALID_TOKEN_NUMBER;\r
           return EFI_SUCCESS;\r
-        } else if (ExMapTable[Idx].ExGuidIndex == GuidTableIdx) {\r
+        } else if (ExMapTable[Index].ExGuidIndex == GuidTableIdx) {\r
           //\r
           // Found the next match\r
           //\r
-          *TokenNumber = ExMapTable[Idx].ExTokenNumber;\r
+          *TokenNumber = ExMapTable[Index].ExTokenNumber;\r
           return EFI_SUCCESS;\r
         } else {\r
           //\r
@@ -326,10 +392,15 @@ ExGetNextTokeNumber (
   \r
   return EFI_NOT_FOUND;\r
 }\r
-  \r
 \r
 \r
+/**\r
+  Initialize the PCD database in DXE phase.\r
+  \r
+  PCD database in DXE phase also contains PCD database in PEI phase which is copied\r
+  from GUID Hob.\r
 \r
+**/\r
 VOID\r
 BuildPcdDxeDataBase (\r
   VOID\r
@@ -337,7 +408,7 @@ BuildPcdDxeDataBase (
 {\r
   PEI_PCD_DATABASE    *PeiDatabase;\r
   EFI_HOB_GUID_TYPE   *GuidHob;\r
-  UINTN               Idx;\r
+  UINTN               Index;\r
 \r
   mPcdDatabase = AllocateZeroPool (sizeof(PCD_DATABASE));\r
   ASSERT (mPcdDatabase != NULL);\r
@@ -376,15 +447,21 @@ BuildPcdDxeDataBase (
   // 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
-  for (Idx = 0; Idx + 1 < PCD_TOTAL_TOKEN_NUMBER + 1; Idx++) {\r
-    InitializeListHead (&mCallbackFnTable[Idx]);\r
+  for (Index = 0; Index + 1 < PCD_TOTAL_TOKEN_NUMBER + 1; Index++) {\r
+    InitializeListHead (&mCallbackFnTable[Index]);\r
   }\r
-    \r
-  return;\r
 }\r
 \r
+/**\r
+  Get Variable which contains HII type PCD entry.\r
 \r
+  @param VariableGuid    Variable's guid\r
+  @param VariableName    Variable's unicode name string\r
+  @param VariableData    Variable's data pointer, \r
+  @param VariableSize    Variable's size.\r
 \r
+  @return the status of gRT->GetVariable\r
+**/\r
 EFI_STATUS\r
 GetHiiVariable (\r
   IN  EFI_GUID      *VariableGuid,\r
@@ -400,6 +477,9 @@ GetHiiVariable (
   Size = 0;\r
   Buffer = NULL;\r
   \r
+  //\r
+  // Firstly get the real size of HII variable\r
+  //\r
   Status = gRT->GetVariable (\r
     (UINT16 *)VariableName,\r
     VariableGuid,\r
@@ -408,6 +488,9 @@ GetHiiVariable (
     Buffer\r
     );\r
   \r
+  //\r
+  // Allocate buffer to hold whole variable data according to variable size.\r
+  //\r
   if (Status == EFI_BUFFER_TOO_SMALL) {\r
     Buffer = (UINT8 *) AllocatePool (Size);\r
 \r
@@ -429,7 +512,17 @@ GetHiiVariable (
   return Status;\r
 }\r
 \r
+/**\r
+  Find the local token number according to system SKU ID.\r
+\r
+  @param LocalTokenNumber PCD token number\r
+  @param Size             The size of PCD entry.\r
+  @param IsPeiDb          If TRUE, the PCD entry is initialized in PEI phase.\r
+                          If False, the PCD entry is initialized in DXE phase.\r
+\r
+  @return Token number according to system SKU ID.\r
 \r
+**/\r
 UINT32\r
 GetSkuEnabledTokenNumber (\r
   UINT32    LocalTokenNumber,\r
@@ -439,7 +532,7 @@ GetSkuEnabledTokenNumber (
 {\r
   SKU_HEAD              *SkuHead;\r
   SKU_ID                *SkuIdTable;\r
-  INTN                  i;\r
+  INTN                  Index;\r
   UINT8                 *Value;\r
   SKU_ID                *PhaseSkuIdTable;\r
   UINT8                 *PcdDb;\r
@@ -456,28 +549,31 @@ GetSkuEnabledTokenNumber (
                               \r
   SkuIdTable  = &PhaseSkuIdTable[SkuHead->SkuIdTableOffset];\r
         \r
-  for (i = 0; i < SkuIdTable[0]; i++) {\r
-    if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[i + 1]) {\r
+  //\r
+  // Find the current system's SKU ID entry in SKU ID table.\r
+  //\r
+  for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+    if (mPcdDatabase->PeiDb.Init.SystemSkuId == SkuIdTable[Index + 1]) {\r
       break;\r
     }\r
   }\r
-  ASSERT (i < SkuIdTable[0]);\r
+  ASSERT (Index < SkuIdTable[0]);\r
 \r
   switch (LocalTokenNumber & PCD_TYPE_ALL_SET) {\r
     case PCD_TYPE_VPD:\r
-      Value = (UINT8 *) &(((VPD_HEAD *) Value)[i]);\r
+      Value = (UINT8 *) &(((VPD_HEAD *) Value)[Index]);\r
       return (UINT32) ((Value - PcdDb) | PCD_TYPE_VPD);\r
 \r
     case PCD_TYPE_HII:\r
-      Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[i]);\r
+      Value = (UINT8 *) &(((VARIABLE_HEAD *) Value)[Index]);\r
       return (UINT32) ((Value - PcdDb) | PCD_TYPE_HII);\r
 \r
     case PCD_TYPE_STRING:\r
-      Value = (UINT8 *) &(((STRING_HEAD *) Value)[i]);\r
+      Value = (UINT8 *) &(((STRING_HEAD *) Value)[Index]);\r
       return (UINT32) ((Value - PcdDb) | PCD_TYPE_STRING);\r
       \r
     case PCD_TYPE_DATA:\r
-      Value += Size * i;\r
+      Value += Size * Index;\r
       return (UINT32) (Value - PcdDb);\r
 \r
     default:\r
@@ -490,10 +586,19 @@ GetSkuEnabledTokenNumber (
   \r
 }\r
 \r
+/**\r
+  Invoke the callback function when dynamic PCD entry was set, if this PCD entry \r
+  has registered callback function.\r
 \r
+  @param ExTokenNumber   DynamicEx PCD's token number, if this PCD entry is dyanmicEx\r
+                         type PCD.\r
+  @param Guid            DynamicEx PCD's guid, if this PCD entry is dynamicEx type\r
+                         PCD.\r
+  @param TokenNumber     PCD token number generated by build tools.\r
+  @param Data            Value want to be set for this PCD entry\r
+  @param Size            The size of value\r
 \r
-\r
-STATIC\r
+**/\r
 VOID\r
 InvokeCallbackOnSet (\r
   UINT32            ExTokenNumber,\r
@@ -532,6 +637,16 @@ InvokeCallbackOnSet (
 }\r
 \r
 \r
+/**\r
+  Wrapper function for setting non-pointer type value for a PCD entry.\r
+\r
+  @param TokenNumber     Pcd token number autogenerated by build tools.\r
+  @param Data            Value want to be set for PCD entry\r
+  @param Size            Size of value.\r
+\r
+  @return status of SetWorker.\r
+\r
+**/\r
 EFI_STATUS\r
 SetValueWorker (\r
   IN UINTN                   TokenNumber,\r
@@ -543,6 +658,21 @@ SetValueWorker (
 }\r
 \r
 \r
+/**\r
+  Set value for an PCD entry\r
+\r
+  @param TokenNumber     Pcd token number autogenerated by build tools.\r
+  @param Data            Value want to be set for PCD entry\r
+  @param Size            Size of value.\r
+  @param PtrType         If TRUE, the type of PCD entry's value is Pointer.\r
+                         If False, the type of PCD entry's value is not Pointer.\r
+\r
+  @retval EFI_INVALID_PARAMETER  If this PCD type is VPD, VPD PCD can not be set.\r
+  @retval EFI_INVALID_PARAMETER  If Size can not be set to size table.\r
+  @retval EFI_NOT_FOUND          If value type of PCD entry is intergrate, but not in\r
+                                 range of UINT8, UINT16, UINT32, UINT64\r
+  @retval EFI_NOT_FOUND          Can not find the PCD type according to token number.                                \r
+**/\r
 EFI_STATUS\r
 SetWorker (\r
   IN          UINTN                   TokenNumber,\r
@@ -581,27 +711,32 @@ SetWorker (
 \r
   TmpTokenNumber = TokenNumber;\r
   \r
+  //\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
-\r
+  //\r
   ASSERT (TokenNumber + 1 < PCD_TOTAL_TOKEN_NUMBER + 1);\r
 \r
   if (!PtrType) {\r
     ASSERT (*Size == DxePcdGetSize (TokenNumber + 1));\r
   }\r
   \r
+  //\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
+  //\r
   IsPeiDb = (BOOLEAN) ((TokenNumber + 1 < PEI_LOCAL_TOKEN_NUMBER + 1) ? TRUE : FALSE);\r
 \r
   LocalTokenNumberTable  = IsPeiDb ? mPcdDatabase->PeiDb.Init.LocalTokenNumberTable : \r
                                      mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
 \r
+  //\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
+  //\r
   if ((TokenNumber + 1 < PEI_NEX_TOKEN_NUMBER + 1) ||\r
       (TokenNumber + 1 >= PEI_LOCAL_TOKEN_NUMBER + 1 || TokenNumber + 1 < (PEI_LOCAL_TOKEN_NUMBER + DXE_NEX_TOKEN_NUMBER + 1))) {\r
     InvokeCallbackOnSet (0, NULL, TokenNumber + 1, Data, *Size);\r
@@ -717,10 +852,16 @@ SetWorker (
   return Status;\r
 }\r
 \r
+/**\r
+  Wrapper function for get PCD value for dynamic-ex PCD.\r
 \r
+  @param Guid            Token space guid for dynamic-ex PCD.\r
+  @param ExTokenNumber   Token number for dyanmic-ex PCD.\r
+  @param GetSize         The size of dynamic-ex PCD value.\r
 \r
+  @return PCD entry in PCD database.\r
 \r
-\r
+**/\r
 VOID *\r
 ExGetWorker (\r
   IN CONST EFI_GUID         *Guid,\r
@@ -731,9 +872,17 @@ ExGetWorker (
   return GetWorker(GetExPcdTokenNumber (Guid, (UINT32) ExTokenNumber), GetSize);\r
 }\r
 \r
+/**\r
+  Wrapper function for set PCD value for non-Pointer type dynamic-ex PCD.\r
 \r
+  @param ExTokenNumber   Token number for dynamic-ex PCD.\r
+  @param Guid            Token space guid for dynamic-ex PCD.\r
+  @param Data            Value want to be set.\r
+  @param SetSize         The size of value.\r
 \r
+  @return status of ExSetWorker().\r
 \r
+**/\r
 EFI_STATUS\r
 ExSetValueWorker (\r
   IN          UINTN                ExTokenNumber,\r
@@ -745,7 +894,24 @@ ExSetValueWorker (
   return ExSetWorker (ExTokenNumber, Guid, Data, &SetSize, FALSE);\r
 }\r
 \r
+/**\r
+  Set value for a dynamic PCD entry.\r
+  \r
+  This routine find the local token number according to dynamic-ex PCD's token \r
+  space guid and token number firstly, and invoke callback function if this PCD\r
+  entry registered callback function. Finally, invoken general SetWorker to set\r
+  PCD value.\r
+  \r
+  @param ExTokenNumber   Dynamic-ex PCD token number.\r
+  @param Guid            Token space guid for dynamic-ex PCD.\r
+  @param Data            PCD value want to be set\r
+  @param SetSize         Size of value.\r
+  @param PtrType         If TRUE, this PCD entry is pointer type.\r
+                         If FALSE, this PCD entry is not pointer type.\r
+\r
+  @return status of SetWorker().\r
 \r
+**/\r
 EFI_STATUS\r
 ExSetWorker (\r
   IN          UINTN                ExTokenNumber,\r
@@ -765,9 +931,21 @@ ExSetWorker (
 \r
 }\r
 \r
+/**\r
+  Set value for HII-type PCD.\r
 \r
+  A HII-type PCD's value is stored in a variable. Setting/Getting the value of \r
+  HII-type PCD is to visit this variable.\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 Data            Value want to be set.\r
+  @param DataSize        Size of value\r
+  @param Offset          Value offset of HII-type PCD in variable.\r
 \r
+  @return status of GetVariable()/SetVariable().\r
 \r
+**/\r
 EFI_STATUS\r
 SetHiiVariable (\r
   IN  EFI_GUID     *VariableGuid,\r
@@ -831,17 +1009,26 @@ SetHiiVariable (
   return Status;\r
 }\r
 \r
+/**\r
+  Get local token number according to dynamic-ex PCD's {token space guid:token number}\r
 \r
+  A dynamic-ex type PCD, developer must provide pair of token space guid: token number\r
+  in DEC file. PCD database maintain a mapping table that translate pair of {token\r
+  space guid: token number} to local token number.\r
+  \r
+  @param Guid            Token space guid for dynamic-ex PCD entry.\r
+  @param ExTokenNumber   EDES_TODO: Add parameter description\r
 \r
+  @return local token number for dynamic-ex PCD.\r
 \r
-\r
+**/\r
 UINTN           \r
 GetExPcdTokenNumber (\r
   IN CONST EFI_GUID             *Guid,\r
   IN UINT32                     ExTokenNumber\r
   )\r
 {\r
-  UINT32              i;\r
+  UINT32              Index;\r
   DYNAMICEX_MAPPING   *ExMap;\r
   EFI_GUID            *GuidTable;\r
   EFI_GUID            *MatchGuid;\r
@@ -857,10 +1044,10 @@ GetExPcdTokenNumber (
 \r
       MatchGuidIdx = MatchGuid - GuidTable;\r
       \r
-      for (i = 0; i < PEI_EXMAPPING_TABLE_SIZE; i++) {\r
-        if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
-            (MatchGuidIdx == ExMap[i].ExGuidIndex)) {\r
-            return ExMap[i].LocalTokenNumber;\r
+      for (Index = 0; Index < PEI_EXMAPPING_TABLE_SIZE; Index++) {\r
+        if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
+            (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
+            return ExMap[Index].LocalTokenNumber;\r
 \r
         }\r
       }\r
@@ -879,10 +1066,10 @@ GetExPcdTokenNumber (
 \r
   MatchGuidIdx = MatchGuid - GuidTable;\r
   \r
-  for (i = 0; i < DXE_EXMAPPING_TABLE_SIZE; i++) {\r
-    if ((ExTokenNumber == ExMap[i].ExTokenNumber) &&\r
-         (MatchGuidIdx == ExMap[i].ExGuidIndex)) {\r
-        return ExMap[i].LocalTokenNumber;\r
+  for (Index = 0; Index < DXE_EXMAPPING_TABLE_SIZE; Index++) {\r
+    if ((ExTokenNumber == ExMap[Index].ExTokenNumber) &&\r
+         (MatchGuidIdx == ExMap[Index].ExGuidIndex)) {\r
+        return ExMap[Index].LocalTokenNumber;\r
     }\r
   }\r
 \r
@@ -891,8 +1078,15 @@ GetExPcdTokenNumber (
   return 0;\r
 }\r
 \r
+/**\r
+  Get SKU ID tabble from PCD database.\r
+\r
+  @param LocalTokenNumberTableIdx Index of local token number in token number table.\r
+  @param IsPeiPcd                 If TRUE, \r
 \r
-STATIC\r
+  @return Pointer to SKU ID array table\r
+\r
+**/\r
 SKU_ID *\r
 GetSkuIdArray (\r
   IN    UINTN             LocalTokenNumberTableIdx,\r
@@ -920,7 +1114,17 @@ GetSkuIdArray (
 }\r
 \r
 \r
-STATIC\r
+/**\r
+  Get index of PCD entry in size table.\r
+\r
+  @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r
+  @param LocalTokenNumberTable    Pointer to local token number table in PCD database.\r
+  @param IsPeiDb                  If TRUE, the pcd entry is initialized in PEI phase,\r
+                                  If FALSE, the pcd entry is initialized in DXE phase.\r
+\r
+  @return index of PCD entry in size table.\r
+\r
+**/\r
 UINTN\r
 GetSizeTableIndexA (\r
   IN UINTN        LocalTokenNumberTableIdx,\r
@@ -928,22 +1132,22 @@ GetSizeTableIndexA (
   IN BOOLEAN      IsPeiDb\r
   )\r
 {\r
-  UINTN       i;\r
+  UINTN       Index;\r
   UINTN       SizeTableIdx;\r
   UINTN       LocalTokenNumber;\r
   SKU_ID      *SkuIdTable;\r
   \r
   SizeTableIdx = 0;\r
 \r
-  for (i=0; i<LocalTokenNumberTableIdx; i++) {\r
-    LocalTokenNumber = LocalTokenNumberTable[i];\r
+  for (Index=0; Index<LocalTokenNumberTableIdx; Index++) {\r
+    LocalTokenNumber = LocalTokenNumberTable[Index];\r
 \r
     if ((LocalTokenNumber & PCD_DATUM_TYPE_ALL_SET) == PCD_DATUM_TYPE_POINTER) {\r
       //\r
       // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
       // PCD entry.\r
       //\r
-      if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+      if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
           //\r
           // We have only one entry for VPD enabled PCD entry:\r
           // 1) MAX Size.\r
@@ -964,7 +1168,7 @@ GetSizeTableIndexA (
           // 1) MAX SIZE\r
           // 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
           //\r
-          SkuIdTable = GetSkuIdArray (i, IsPeiDb);\r
+          SkuIdTable = GetSkuIdArray (Index, IsPeiDb);\r
           SizeTableIdx += (UINTN)*SkuIdTable + 1;\r
         }\r
       }\r
@@ -977,7 +1181,15 @@ GetSizeTableIndexA (
 \r
 \r
 \r
-STATIC\r
+/**\r
+  Wrapper function of getting index of PCD entry in size table.\r
+  \r
+  @param LocalTokenNumberTableIdx Index of this PCD in local token number table.\r
+  @param IsPeiDb                  If TRUE, the pcd entry is initialized in PEI phase,\r
+                                  If FALSE, the pcd entry is initialized in DXE phase.\r
+\r
+  @return index of PCD entry in size table.\r
+**/\r
 UINTN\r
 GetSizeTableIndex (\r
   IN    UINTN             LocalTokenNumberTableIdx,\r
@@ -992,12 +1204,19 @@ GetSizeTableIndex (
     LocalTokenNumberTable = mPcdDatabase->DxeDb.Init.LocalTokenNumberTable;\r
   }\r
   return GetSizeTableIndexA (LocalTokenNumberTableIdx, \r
-                              LocalTokenNumberTable,\r
-                              IsPeiDb);\r
+                             LocalTokenNumberTable,\r
+                             IsPeiDb);\r
 }\r
 \r
+/**\r
+  Get size of POINTER type PCD value.\r
+\r
+  @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
+  @param MaxSize                  Maxmium size of POINTER type PCD value.\r
 \r
+  @return size of POINTER type PCD value.\r
 \r
+**/\r
 UINTN\r
 GetPtrTypeSize (\r
   IN    UINTN             LocalTokenNumberTableIdx,\r
@@ -1008,7 +1227,7 @@ GetPtrTypeSize (
   UINTN       LocalTokenNumber;\r
   SKU_ID      *SkuIdTable;\r
   SIZE_INFO   *SizeTable;\r
-  UINTN       i;\r
+  UINTN       Index;\r
   BOOLEAN     IsPeiDb;\r
   UINT32      *LocalTokenNumberTable;\r
 \r
@@ -1038,7 +1257,7 @@ GetPtrTypeSize (
   // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
   // PCD entry.\r
   //\r
-  if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+  if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
       //\r
       // We have only one entry for VPD enabled PCD entry:\r
       // 1) MAX Size.\r
@@ -1060,9 +1279,9 @@ GetPtrTypeSize (
       // 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
       //\r
       SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
-      for (i = 0; i < SkuIdTable[0]; i++) {\r
-        if (SkuIdTable[1 + i] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
-          return SizeTable[SizeTableIdx + 1 + i];\r
+      for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+        if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
+          return SizeTable[SizeTableIdx + 1 + Index];\r
         }\r
       }\r
       return SizeTable[SizeTableIdx + 1];\r
@@ -1070,8 +1289,16 @@ GetPtrTypeSize (
   }\r
 }\r
 \r
+/**\r
+  Set size of POINTER type PCD value. The size should not exceed the maxmium size\r
+  of this PCD value.\r
 \r
+  @param LocalTokenNumberTableIdx Index of local token number in local token number table.\r
+  @param CurrentSize              Size of POINTER type PCD value.\r
 \r
+  @retval TRUE  Success to set size of PCD value.\r
+  @retval FALSE Fail to set size of PCD value.\r
+**/\r
 BOOLEAN\r
 SetPtrTypeSize (\r
   IN          UINTN             LocalTokenNumberTableIdx,\r
@@ -1082,14 +1309,16 @@ SetPtrTypeSize (
   UINTN       LocalTokenNumber;\r
   SKU_ID      *SkuIdTable;\r
   SIZE_INFO   *SizeTable;\r
-  UINTN       i;\r
+  UINTN       Index;\r
   UINTN       MaxSize;\r
   BOOLEAN     IsPeiDb;\r
   UINT32      *LocalTokenNumberTable;\r
 \r
+  //\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
+  //\r
   IsPeiDb = (BOOLEAN) (LocalTokenNumberTableIdx + 1 < PEI_LOCAL_TOKEN_NUMBER + 1);\r
 \r
   if (IsPeiDb) {\r
@@ -1112,7 +1341,7 @@ SetPtrTypeSize (
   // SizeTable only contain record for PCD_DATUM_TYPE_POINTER type \r
   // PCD entry.\r
   //\r
-  if (LocalTokenNumber & PCD_TYPE_VPD) {\r
+  if ((LocalTokenNumber & PCD_TYPE_VPD) != 0) {\r
       //\r
       // We shouldn't come here as we don't support SET for VPD\r
       //\r
@@ -1140,9 +1369,9 @@ SetPtrTypeSize (
       // 2) Current Size for each SKU_ID (It is equal to MaxSku).\r
       //\r
       SkuIdTable = GetSkuIdArray (LocalTokenNumberTableIdx, IsPeiDb);\r
-      for (i = 0; i < SkuIdTable[0]; i++) {\r
-        if (SkuIdTable[1 + i] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
-          SizeTable[SizeTableIdx + 1 + i] = (SIZE_INFO) *CurrentSize;\r
+      for (Index = 0; Index < SkuIdTable[0]; Index++) {\r
+        if (SkuIdTable[1 + Index] == mPcdDatabase->PeiDb.Init.SystemSkuId) {\r
+          SizeTable[SizeTableIdx + 1 + Index] = (SIZE_INFO) *CurrentSize;\r
           return TRUE;\r
         }\r
       }\r
@@ -1151,4 +1380,3 @@ SetPtrTypeSize (
     }\r
   }\r
 }\r
-\r