]> git.proxmox.com Git - mirror_edk2.git/blobdiff - BaseTools/Source/Python/AutoGen/GenC.py
BaseTools: AutoGen - refactor function to remove extra variables
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenC.py
index 26f6aca0e63ffbc5fc5eb94f1d9f2d5a1f7064a1..d06258888269b241b1d04ea38bcac8971658cf16 100644 (file)
@@ -28,8 +28,8 @@ from IdfClassObject import *
 \r
 ## PCD type string\r
 gItemTypeStringDatabase  = {\r
-    TAB_PCDS_FEATURE_FLAG       :   'FixedAtBuild',\r
-    TAB_PCDS_FIXED_AT_BUILD     :   'FixedAtBuild',\r
+    TAB_PCDS_FEATURE_FLAG       :   TAB_PCDS_FIXED_AT_BUILD,\r
+    TAB_PCDS_FIXED_AT_BUILD     :   TAB_PCDS_FIXED_AT_BUILD,\r
     TAB_PCDS_PATCHABLE_IN_MODULE:   'BinaryPatch',\r
     TAB_PCDS_DYNAMIC            :   '',\r
     TAB_PCDS_DYNAMIC_DEFAULT    :   '',\r
@@ -41,11 +41,6 @@ gItemTypeStringDatabase  = {
     TAB_PCDS_DYNAMIC_EX_HII     :   '',\r
 }\r
 \r
-## Dynamic PCD types\r
-gDynamicPcd = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]\r
-\r
-## Dynamic-ex PCD types\r
-gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
 \r
 ## Datum size\r
 gDatumSizeStringDatabase = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'BOOLEAN',TAB_VOID:'8'}\r
@@ -802,7 +797,7 @@ def DynExPcdTokenNumberMapping(Info, AutoGenH):
     # Even it is the Library, the PCD is saved in the ModulePcdList\r
     PcdList = Info.ModulePcdList\r
     for Pcd in PcdList:\r
-        if Pcd.Type in gDynamicExPcd:\r
+        if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
             ExTokenCNameList.append(Pcd.TokenCName)\r
             PcdExList.append(Pcd)\r
     if len(ExTokenCNameList) == 0:\r
@@ -848,7 +843,7 @@ def DynExPcdTokenNumberMapping(Info, AutoGenH):
                 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
                     RealTokenCName = PcdItem[0]\r
                     break\r
-            if Pcd.Type in gDynamicExPcd and Pcd.TokenCName == TokenCName:\r
+            if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == TokenCName:\r
                 Index = Index + 1\r
                 if Index == 1:\r
                     AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr)  (' % (RealTokenCName))\r
@@ -868,31 +863,6 @@ def DynExPcdTokenNumberMapping(Info, AutoGenH):
                                     % (RealTokenCName, RealTokenCName, RealTokenCName, RealTokenCName))\r
                 TokenCNameList.add(TokenCName)\r
 \r
-def GetPcdSize(Pcd):\r
-    if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r
-        Value = Pcd.DefaultValue\r
-        if Value in [None, '']:\r
-            return 1\r
-        elif Value[0] == 'L':\r
-            return (len(Value) - 2) * 2\r
-        elif Value[0] == '{':\r
-            return len(Value.split(','))\r
-        else:\r
-            return len(Value) - 1\r
-    if Pcd.DatumType == TAB_UINT64:\r
-        return 8\r
-    if Pcd.DatumType == TAB_UINT32:\r
-        return 4\r
-    if Pcd.DatumType == TAB_UINT16:\r
-        return 2\r
-    if Pcd.DatumType == TAB_UINT8:\r
-        return 1\r
-    if Pcd.DatumType == 'BOOLEAN':\r
-        return 1\r
-    else:\r
-        return Pcd.MaxDatumSize\r
-\r
-\r
 ## Create code for module PCDs\r
 #\r
 #   @param      Info        The ModuleAutoGen object\r
@@ -921,7 +891,7 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
     if Pcd.PcdValueFromComm:\r
         Pcd.DefaultValue = Pcd.PcdValueFromComm\r
     \r
-    if Pcd.Type in gDynamicExPcd:\r
+    if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
         TokenNumber = int(Pcd.TokenValue, 0)\r
         # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with \r
         # different Guids but same TokenCName\r
@@ -937,7 +907,7 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
             # will not be added into the Database unless it is used by other modules that are \r
             # included in the FDF file. \r
             # In this case, just assign an invalid token number to make it pass build.\r
-            if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
+            if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
                 TokenNumber = 0\r
             else:\r
                 EdkLogger.error("build", AUTOGEN_ERROR,\r
@@ -960,14 +930,14 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
     SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_S_' + TokenCName\r
     GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r
     \r
-    if Pcd.Type in gDynamicExPcd:\r
+    if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
         if Info.IsLibrary:\r
             PcdList = Info.LibraryPcdList\r
         else:\r
             PcdList = Info.ModulePcdList\r
         PcdExCNameTest = 0\r
         for PcdModule in PcdList:\r
-            if PcdModule.Type in gDynamicExPcd and Pcd.TokenCName == PcdModule.TokenCName:\r
+            if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r
                 PcdExCNameTest += 1\r
             # get out early once we found > 1...\r
             if PcdExCNameTest > 1:\r
@@ -996,10 +966,10 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
             else:\r
                 AutoGenH.Append('#define %s(Value)  LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                 AutoGenH.Append('#define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
-    elif Pcd.Type in gDynamicPcd:\r
+    elif Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
         PcdCNameTest = 0\r
         for PcdModule in Info.LibraryPcdList + Info.ModulePcdList:\r
-            if PcdModule.Type in gDynamicPcd and Pcd.TokenCName == PcdModule.TokenCName:\r
+            if PcdModule.Type in PCD_DYNAMIC_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r
                 PcdCNameTest += 1\r
             # get out early once we found > 1...\r
             if PcdCNameTest > 1:\r
@@ -1115,7 +1085,7 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
                                     "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                     ExtraData="[%s]" % str(Info))\r
                     else:\r
-                        ArraySize = GetPcdSize(Pcd)\r
+                        ArraySize = Pcd.GetPcdSize()\r
                         if Unicode:\r
                             ArraySize = ArraySize / 2\r
                 Value = NewValue + '0 }'\r
@@ -1155,7 +1125,7 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
                 AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r
             AutoGenH.Append('#define %s  %s%s\n' %(GetModeName, Type, PcdVariableName))\r
                 \r
-            PcdDataSize = GetPcdSize(Pcd)\r
+            PcdDataSize = Pcd.GetPcdSize()\r
             if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r
                 AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
                 AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
@@ -1172,14 +1142,14 @@ def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
             AutoGenH.Append('extern volatile %s  %s  %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
             AutoGenH.Append('#define %s  %s%s\n' % (GetModeName, Type, PcdVariableName))\r
             \r
-            PcdDataSize = GetPcdSize(Pcd)\r
+            PcdDataSize = Pcd.GetPcdSize()\r
             AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r
             \r
             AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
             AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
             AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r
         else:\r
-            PcdDataSize = GetPcdSize(Pcd)\r
+            PcdDataSize = Pcd.GetPcdSize()\r
             AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
             AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
             \r
@@ -1225,7 +1195,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
     #\r
     # Write PCDs\r
     #\r
-    if Pcd.Type in gDynamicExPcd:\r
+    if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r
         TokenNumber = int(Pcd.TokenValue, 0)\r
     else:\r
         if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
@@ -1237,7 +1207,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
             # will not be added into the Database unless it is used by other modules that are \r
             # included in the FDF file. \r
             # In this case, just assign an invalid token number to make it pass build.\r
-            if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
+            if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r
                 TokenNumber = 0\r
             else:\r
                 EdkLogger.error("build", AUTOGEN_ERROR,\r
@@ -1266,7 +1236,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
             Type = '(VOID *)'\r
         Array = '[]'\r
     PcdItemType = Pcd.Type\r
-    if PcdItemType in gDynamicExPcd:\r
+    if PcdItemType in PCD_DYNAMIC_EX_TYPE_SET:\r
         PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + TokenCName\r
         AutoGenH.Append('\n#define %s  %dU\n' % (PcdExTokenName, TokenNumber))\r
         \r
@@ -1276,7 +1246,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
             PcdList = Info.ModulePcdList\r
         PcdExCNameTest = 0\r
         for PcdModule in PcdList:\r
-            if PcdModule.Type in gDynamicExPcd and Pcd.TokenCName == PcdModule.TokenCName:\r
+            if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r
                 PcdExCNameTest += 1\r
             # get out early once we found > 1...\r
             if PcdExCNameTest > 1:\r
@@ -1307,13 +1277,13 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
                 AutoGenH.Append('#define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
     else:\r
         AutoGenH.Append('#define _PCD_TOKEN_%s  %dU\n' % (TokenCName, TokenNumber))\r
-    if PcdItemType in gDynamicPcd:\r
+    if PcdItemType in PCD_DYNAMIC_TYPE_SET:\r
         PcdList = []\r
         PcdCNameList = []\r
         PcdList.extend(Info.LibraryPcdList)\r
         PcdList.extend(Info.ModulePcdList)\r
         for PcdModule in PcdList:\r
-            if PcdModule.Type in gDynamicPcd:\r
+            if PcdModule.Type in PCD_DYNAMIC_TYPE_SET:\r
                 PcdCNameList.append(PcdModule.TokenCName)\r
         if PcdCNameList.count(Pcd.TokenCName) > 1:\r
             EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r
@@ -1338,7 +1308,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
         else:\r
             AutoGenH.Append('extern volatile  %s  %s%s;\n' % (DatumType, PcdVariableName, Array))\r
         AutoGenH.Append('#define %s  %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
-        PcdDataSize = GetPcdSize(Pcd)\r
+        PcdDataSize = Pcd.GetPcdSize()\r
         if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r
             AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r
             AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r
@@ -1372,7 +1342,7 @@ def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
                 AutoGenH.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName, Type, PcdVariableName))\r
             else:\r
                 AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
-        PcdDataSize = GetPcdSize(Pcd)\r
+        PcdDataSize = Pcd.GetPcdSize()\r
         if PcdItemType == TAB_PCDS_FIXED_AT_BUILD:\r
             if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r
                 if ConstFixedPcd:\r
@@ -1409,7 +1379,7 @@ def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):
         if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
             ConstructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r
             ConstructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r
-        elif Lib.ModuleType in [SUP_MODULE_PEI_CORE,SUP_MODULE_PEIM]:\r
+        elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r
             ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
             ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
         elif Lib.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r
@@ -1439,7 +1409,7 @@ def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):
     else:\r
         if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
             AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r
-        elif Info.ModuleType in [SUP_MODULE_PEI_CORE,SUP_MODULE_PEIM]:\r
+        elif Info.ModuleType in SUP_MODULE_SET_PEI:\r
             AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
         elif Info.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r
                                  SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION,SUP_MODULE_SMM_CORE]:\r
@@ -1471,7 +1441,7 @@ def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):
         if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
             DestructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r
             DestructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r
-        elif Lib.ModuleType in [SUP_MODULE_PEI_CORE,SUP_MODULE_PEIM]:\r
+        elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r
             DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
             DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
         elif Lib.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r
@@ -1501,7 +1471,7 @@ def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):
     else:\r
         if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
             AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r
-        elif Info.ModuleType in [SUP_MODULE_PEI_CORE,SUP_MODULE_PEIM]:\r
+        elif Info.ModuleType in SUP_MODULE_SET_PEI:\r
             AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
         elif Info.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r
                                  SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION,SUP_MODULE_SMM_CORE]:\r
@@ -1618,7 +1588,7 @@ def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):
 #\r
 def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r
     if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r
-        GuidType = "GUID"\r
+        GuidType = TAB_GUID\r
     else:\r
         GuidType = "EFI_GUID"\r
 \r
@@ -1642,7 +1612,7 @@ def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):
 #\r
 def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r
     if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r
-        GuidType = "GUID"\r
+        GuidType = TAB_GUID\r
     else:\r
         GuidType = "EFI_GUID"\r
 \r
@@ -1666,7 +1636,7 @@ def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):
 #\r
 def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r
     if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r
-        GuidType = "GUID"\r
+        GuidType = TAB_GUID\r
     else:\r
         GuidType = "EFI_GUID"\r
 \r
@@ -1693,7 +1663,7 @@ def CreatePcdCode(Info, AutoGenC, AutoGenH):
     # Collect Token Space GUIDs used by DynamicEc PCDs\r
     TokenSpaceList = []\r
     for Pcd in Info.ModulePcdList:\r
-        if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
+        if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
             TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r
             \r
     SkuMgr = Info.Workspace.Platform.SkuIdMgr\r
@@ -1703,7 +1673,7 @@ def CreatePcdCode(Info, AutoGenC, AutoGenH):
     if TokenSpaceList:\r
         AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r
         if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r
-            GuidType = "GUID"\r
+            GuidType = TAB_GUID\r
         else:\r
             GuidType = "EFI_GUID"              \r
         for Item in TokenSpaceList:\r