]> git.proxmox.com Git - mirror_edk2.git/blobdiff - Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java
New tool.
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / entity / UsageInstance.java
index 2769d497f70d75e0e9831b64857fa38e3d571210..20a58ba5f5b6763673db3d6400a59d4000f0dff3 100644 (file)
@@ -19,9 +19,8 @@ package org.tianocore.build.pcd.entity;
 \r
 \r
 import java.util.UUID;\r
-\r
+import org.tianocore.ModuleTypeDef;\r
 import org.tianocore.build.autogen.CommonDefinition;\r
-import org.tianocore.build.pcd.action.ActionMessage;\r
 import org.tianocore.build.pcd.exception.EntityException;\r
 \r
 /**\r
@@ -30,11 +29,6 @@ import org.tianocore.build.pcd.exception.EntityException;
   is an usage instance for this PCD token.\r
 **/\r
 public class UsageInstance {\r
-    ///\r
-    /// The module type of usage instance.\r
-    /// \r
-    public enum MODULE_TYPE {SEC, PEI_CORE, PEIM, DXE_CORE, DXE_DRIVERS, OTHER_COMPONENTS}\r
-\r
     ///\r
     /// This parent that this usage instance belongs to.\r
     ///\r
@@ -78,7 +72,7 @@ public class UsageInstance {
     ///\r
     /// The module type for this usage instance.\r
     ///\r
-    public MODULE_TYPE      moduleType;\r
+    public int              moduleType;\r
 \r
     ///\r
     /// The value of the PCD in this usage instance. \r
@@ -122,7 +116,7 @@ public class UsageInstance {
                           UUID              moduleGUID,\r
                           String            packageName,\r
                           UUID              packageGUID,\r
-                          MODULE_TYPE       moduleType,\r
+                          int               moduleType,\r
                           Token.PCD_TYPE    modulePcdType,\r
                           String            arch,\r
                           String            version,\r
@@ -185,12 +179,29 @@ public class UsageInstance {
        @return boolean\r
      */\r
     public boolean isPeiPhaseComponent() {\r
-        if ((moduleType == MODULE_TYPE.PEI_CORE) ||\r
-            (moduleType == MODULE_TYPE.PEIM)) {\r
+        if ((moduleType == CommonDefinition.ModuleTypePeiCore) ||\r
+            (moduleType == CommonDefinition.ModuleTypePeim)) {\r
             return true;\r
         }\r
         return false;\r
     }\r
+  \r
+  public boolean isDxePhaseComponent() {\r
+      //\r
+      // BugBug: May need confirmation on which type of module can\r
+      //         make use of Dynamic(EX) PCD entry.\r
+      //\r
+      if ((moduleType == CommonDefinition.ModuleTypeDxeDriver) ||\r
+          (moduleType == CommonDefinition.ModuleTypeDxeRuntimeDriver) ||\r
+          (moduleType == CommonDefinition.ModuleTypeDxeSalDriver) ||\r
+          (moduleType == CommonDefinition.ModuleTypeDxeSmmDriver) ||\r
+          (moduleType == CommonDefinition.ModuleTypeUefiDriver) ||\r
+          (moduleType == CommonDefinition.ModuleTypeUefiApplication)\r
+          ) {\r
+          return true;\r
+      }\r
+      return false;\r
+  }\r
 \r
     /**\r
        Generate autogen string for header file and C code file.\r
@@ -201,21 +212,23 @@ public class UsageInstance {
      */\r
     public void generateAutoGen(boolean isBuildUsedLibrary) \r
         throws EntityException {\r
-        String  guidStringCName  = null;\r
-        boolean isByteArray      = false;\r
-        String  printDatum       = null;\r
+        String  guidStringCName     = null;\r
+        boolean isByteArray         = false;\r
+        String  printDatum          = null;\r
+        String  tokenNumberString   = null;\r
 \r
         hAutogenStr = "";\r
         cAutogenStr = "";\r
 \r
         if (this.modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {\r
-            hAutogenStr += String.format("#define _PCD_TOKEN_%s   0x%016x\r\n", \r
-                                         parentToken.cName, parentToken.dynamicExTokenNumber);\r
+            tokenNumberString =  Long.toString(parentToken.dynamicExTokenNumber, 16);\r
         } else {\r
-            hAutogenStr += String.format("#define _PCD_TOKEN_%s   0x%016x\r\n", \r
-                                         parentToken.cName, parentToken.tokenNumber);\r
+            tokenNumberString = Long.toString(parentToken.tokenNumber, 16);\r
         }\r
 \r
+        hAutogenStr += String.format("#define _PCD_TOKEN_%s  0x%s\r\n", \r
+                                     parentToken.cName, tokenNumberString);\r
+        \r
         if (!isBuildUsedLibrary && !parentToken.isDynamicPCD) {\r
             if (datum.trim().charAt(0) == '{') {\r
                 isByteArray = true;\r
@@ -230,38 +243,47 @@ public class UsageInstance {
 \r
         switch (modulePcdType) {\r
         case FEATURE_FLAG:\r
-            if (isBuildUsedLibrary) {\r
-                hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
-                                             parentToken.cName);\r
-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",\r
-                                             parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                             parentToken.cName,\r
-                                             parentToken.cName);\r
-            } else {\r
+            hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
+                                         parentToken.cName);\r
+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",\r
+                                         parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                         parentToken.cName,\r
+                                         parentToken.cName);\r
+            hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) If is not allowed to set value for a FEATURE_FLAG PCD\r\n",\r
+                                         parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                         parentToken.cName);\r
+\r
+            if (!isBuildUsedLibrary) {\r
                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", \r
                                              parentToken.cName, \r
                                              printDatum);\r
-                hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
-                                             parentToken.cName);\r
                 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
                                              parentToken.cName,\r
                                              parentToken.cName);\r
-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _PCD_VALUE_%s\r\n",\r
-                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                             parentToken.cName,\r
-                                             parentToken.cName);\r
             }\r
             break;\r
         case FIXED_AT_BUILD:\r
-            if (isBuildUsedLibrary) {\r
+            if (isByteArray) {\r
+                hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",\r
+                                             parentToken.cName);\r
+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_FixedAtBuild_%s\r\n", \r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             parentToken.cName);\r
+            } else {\r
                 hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
                                              Token.getAutogendatumTypeString(parentToken.datumType),\r
                                              parentToken.cName);\r
-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n",\r
+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n", \r
                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
                                              parentToken.cName,\r
                                              parentToken.cName);\r
-            } else {\r
+            }\r
+\r
+            hAutogenStr += String.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\r\n",\r
+                                         parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                         parentToken.cName);\r
+            if (!isBuildUsedLibrary) {\r
                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", \r
                                              parentToken.cName, \r
                                              printDatum);\r
@@ -269,37 +291,48 @@ public class UsageInstance {
                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = _PCD_VALUE_%s;\r\n",\r
                                                  parentToken.cName,\r
                                                  parentToken.cName);\r
-                    hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",\r
-                                                 parentToken.cName);\r
-                    hAutogenStr += String.format("#define _PCD_MODE_%s_%s  &_gPcd_FixedAtBuild_%s\r\n",\r
-                                                 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName,\r
-                                                 parentToken.cName);\r
                 } else {\r
                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
                                                  Token.getAutogendatumTypeString(parentToken.datumType),\r
                                                  parentToken.cName,\r
                                                  parentToken.cName);\r
-                    hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
-                                                 Token.getAutogendatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName);\r
-                    hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _PCD_VALUE_%s\r\n",\r
-                                                 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName,\r
-                                                 parentToken.cName);\r
                 }\r
             }\r
             break;\r
         case PATCHABLE_IN_MODULE:\r
-            if (isBuildUsedLibrary) {\r
+            if (isByteArray) {\r
+                hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",\r
+                                             parentToken.cName);\r
+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  (VOID*)_gPcd_BinaryPatch_%s\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             parentToken.cName);  \r
+            } else {\r
                 hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",\r
                                              Token.getAutogendatumTypeString(parentToken.datumType),\r
                                              parentToken.cName);\r
-                hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",\r
+                hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             parentToken.cName);                \r
+            }\r
+\r
+            //\r
+            // Generate _PCD_SET_MODE_xx macro for using set BinaryPatch value via PcdSet macro\r
+            // \r
+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) CopyMem (_gPcd_BinaryPatch_%s, (Buffer), (SizeOfBuffer))\r\n",\r
                                              Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
                                              parentToken.cName,\r
                                              parentToken.cName);\r
             } else {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) (_gPcd_BinaryPatch_%s = (Value))\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             parentToken.cName);\r
+            }\r
+            \r
+            if (!isBuildUsedLibrary) {\r
                 hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", \r
                                              parentToken.cName, \r
                                              printDatum);\r
@@ -307,46 +340,62 @@ public class UsageInstance {
                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",\r
                                                  parentToken.cName,\r
                                                  parentToken.cName);\r
-                    hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",\r
-                                                 parentToken.cName);\r
-                    hAutogenStr += String.format("#define _PCD_MODE_%s_%s  &_gPcd_BinaryPatch_%s\r\n",\r
-                                                 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName,\r
-                                                 parentToken.cName);  \r
                 } else {\r
                     cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",\r
                                                  Token.getAutogendatumTypeString(parentToken.datumType),\r
                                                  parentToken.cName,\r
                                                  parentToken.cName);\r
-                    hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",\r
-                                                 Token.getAutogendatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName);\r
-                    hAutogenStr += String.format("#define _PCD_MODE_%s_%s  _gPcd_BinaryPatch_%s\r\n",\r
-                                                 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
-                                                 parentToken.cName,\r
-                                                 parentToken.cName);                \r
                 }\r
             }\r
 \r
             break;\r
         case DYNAMIC:\r
-            hAutogenStr += String.format("#define _PCD_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",\r
+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s  LibPcdGet%s(_PCD_TOKEN_%s)\r\n",\r
                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
                                          parentToken.cName,\r
                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
                                          parentToken.cName);\r
+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer)  LibPcdSet%s(_PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName);\r
+            } else {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value)  LibPcdSet%s(_PCD_TOKEN_%s, (Value))\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName);\r
+            }\r
             break;\r
         case DYNAMIC_EX:\r
             guidStringCName = "_gPcd_TokenSpaceGuid_" +\r
                               parentToken.tokenSpaceName.toString().replaceAll("-", "_");\r
-                                            \r
-            hAutogenStr += String.format("#define _PCD_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",\r
+\r
+            hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",\r
                                          Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
                                          parentToken.cName,\r
                                          Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
                                          guidStringCName,\r
                                          parentToken.cName);\r
 \r
+            if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
+                                             guidStringCName,\r
+                                             parentToken.cName);\r
+            } else {\r
+                hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (Value))\r\n",\r
+                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
+                                             parentToken.cName,\r
+                                             Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
+                                             guidStringCName,\r
+                                             parentToken.cName);\r
+\r
+            }\r
             break;\r
         }\r
     }\r