[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / entity / UsageInstance.java

/** @file\r
  UsageInstance class.\r
\r
  This class indicate an usage instance for a PCD token. This instance maybe a module\r
  or platform setting. When a module produce or cosume a PCD token, then this module\r
  is an usage instance for this PCD token.\r
 \r
Copyright (c) 2006, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
 \r
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
package org.tianocore.build.pcd.entity;\r
\r
\r
import java.util.UUID;\r
\r
import org.tianocore.ModuleTypeDef;\r
import org.tianocore.build.autogen.CommonDefinition;\r
import org.tianocore.build.id.ModuleIdentification;\r
import org.tianocore.build.pcd.exception.EntityException;\r
\r
/**\r
  This class indicate an usage instance for a PCD token. This instance maybe a module\r
  or platform setting. When a module produce or cosume a PCD token, then this module\r
  is an usage instance for this PCD token.\r
**/\r
public class UsageInstance {\r
    ///\r
    /// This parent that this usage instance belongs to.\r
    ///\r
    public Token                parentToken;\r
\r
    ///\r
    /// ModuleIdentification for Usage Instance\r
    /// \r
    public ModuleIdentification moduleId;\r
\r
    ///\r
    /// Arch also is a key for a UsageInstance\r
    /// \r
    public String               arch;\r
\r
    ///\r
    /// The PCD type defined for module \r
    /// \r
    public Token.PCD_TYPE       modulePcdType;\r
\r
    ///\r
    /// The value of the PCD in this usage instance. \r
    /// \r
    public String               datum;\r
\r
    ///\r
    /// The maxDatumSize could be different for same PCD in different module\r
    /// But this case is allow for FeatureFlag, FixedAtBuild, PatchableInModule\r
    /// type.\r
    /// \r
    public int                  maxDatumSize;\r
\r
    ///\r
    /// Autogen string for header file.\r
    ///\r
    public String               hAutogenStr;\r
\r
    ///\r
    /// Auotgen string for C code file.\r
    /// \r
    public String               cAutogenStr;\r
\r
    /**\r
       Constructure function for UsageInstance\r
       \r
       @param parentToken         The token instance for this usgaInstance\r
       @param id                  The identification for usage instance\r
       @param modulePcdType       The PCD type for this usage instance\r
       @param value               The value of this PCD in this usage instance\r
       @param maxDatumSize        The max datum size of this PCD in this usage\r
                                  instance.\r
    **/\r
    public UsageInstance(Token                 parentToken,\r
                         ModuleIdentification  moduleId,\r
                         Token.PCD_TYPE        modulePcdType,\r
                         String                arch,\r
                         String                value,\r
                         int                   maxDatumSize) {\r
        this.parentToken      = parentToken;\r
        this.moduleId         = moduleId;\r
        this.modulePcdType    = modulePcdType;\r
        this.arch             = arch;\r
        this.datum            = value;\r
        this.maxDatumSize     = maxDatumSize;\r
    }\r
\r
    /**\r
       Get the primary key for usage instance array for every token.\r
       \r
       @param   moduleId      The module Identification for generating primary key\r
       @param   arch          Arch string\r
       \r
       @retval  String        The primary key for this usage instance\r
    **/\r
    public static String getPrimaryKey(ModuleIdentification moduleId,\r
                                       String               arch) {\r
        String moduleName   = moduleId.getName();\r
        String moduleGuid   = moduleId.getGuid();\r
        String packageName  = moduleId.getPackage().getName();\r
        String packageGuid  = moduleId.getPackage().getGuid();\r
        String version      = moduleId.getVersion();\r
\r
        //\r
        // Because currently transition schema not require write moduleGuid, package Name, Packge GUID in\r
        // <ModuleSA> section, So currently no expect all paramter must be valid.\r
        // BUGBUG: Because currently we can not get version from MSA, So ignore verison.\r
        // \r
        return(moduleName                                                                + "_" +\r
               ((moduleGuid  != null) ? moduleGuid.toLowerCase()    : "NullModuleGuid")  + "_" +\r
               ((packageName != null) ? packageName                 : "NullPackageName") + "_" +\r
               ((packageGuid != null) ? packageGuid.toLowerCase()   : "NullPackageGuid") + "_" +\r
               ((arch        != null) ? arch                        : "NullArch")        + "_" +\r
               "NullVersion");\r
    }\r
\r
    /**\r
       Get primary key string for this usage instance\r
       \r
       @return String primary key string\r
    **/\r
    public String getPrimaryKey() {\r
        return UsageInstance.getPrimaryKey(moduleId, arch);\r
    }\r
\r
    /**\r
       Judget whether current module is PEI driver\r
       \r
       @return boolean whether current module is PEI driver\r
    **/\r
    public boolean isPeiPhaseComponent() {\r
        int moduleType = CommonDefinition.getModuleType(moduleId.getModuleType());\r
\r
        if ((moduleType == CommonDefinition.ModuleTypePeiCore) ||\r
            (moduleType == CommonDefinition.ModuleTypePeim)) {\r
            return true;\r
        }\r
        return false;\r
    }\r
\r
    /**\r
       Judge whether current module is DXE driver.\r
       \r
       @return boolean whether current module is DXE driver\r
    **/\r
    public boolean isDxePhaseComponent() {\r
        int moduleType = CommonDefinition.getModuleType(moduleId.getModuleType());\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
       \r
       @param isBuildUsedLibrary  whether the autogen is for library.\r
    **/\r
    public void generateAutoGen(boolean isBuildUsedLibrary) {\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
            //\r
            // For DYNAMIC_EX type PCD, use original token number in SPD or FPD to generate autogen\r
            // \r
            tokenNumberString =  Long.toString(parentToken.dynamicExTokenNumber, 16);\r
        } else {\r
            //\r
            // For Others type PCD, use autogenerated token number to generate autogen\r
            // \r
            tokenNumberString = Long.toString(parentToken.tokenNumber, 16);\r
        }\r
\r
        hAutogenStr += String.format("#define _PCD_TOKEN_%s  0x%s\r\n", parentToken.cName, tokenNumberString);\r
\r
        //\r
        // Judge the value of this PCD is byte array type\r
        // \r
        if (!isBuildUsedLibrary && !parentToken.isDynamicPCD) {\r
            if (datum.trim().charAt(0) == '{') {\r
                isByteArray = true;\r
            }\r
        }\r
\r
        //\r
        // "ULL" should be added to value's tail for UINT64 value\r
        // \r
        if (parentToken.datumType == Token.DATUM_TYPE.UINT64) {\r
            printDatum = this.datum + "ULL";\r
        } else {\r
            printDatum = this.datum;\r
        }\r
\r
        switch (modulePcdType) {\r
        case FEATURE_FLAG:\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
                cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
                                             parentToken.cName,\r
                                             parentToken.cName);\r
            }\r
            break;\r
        case FIXED_AT_BUILD:\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_GET_MODE_%s_%s  _gPcd_FixedAtBuild_%s\r\n", \r
                                             Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
                                             parentToken.cName,\r
                                             parentToken.cName);\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
                if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
                    if (isByteArray) {\r
                        hAutogenStr += String.format("#define _PCD_VALUE_%s   (VOID*)_gPcd_FixedAtBuild_%s\r\n", \r
                                                     parentToken.cName, \r
                                                     parentToken.cName);\r
                        cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = %s;\r\n",\r
                                                     parentToken.cName,\r
                                                     printDatum);\r
                    } else {\r
                        hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", \r
                                                     parentToken.cName, \r
                                                     printDatum);\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
                    }\r
                } else {\r
                    hAutogenStr += String.format("#define _PCD_VALUE_%s   %s\r\n", \r
                                                 parentToken.cName, \r
                                                 printDatum);\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
                }\r
            }\r
            break;\r
        case PATCHABLE_IN_MODULE:\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_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
                if (isByteArray) {\r
                    cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",\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
                }\r
            }\r
\r
            break;\r
        case DYNAMIC:\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_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
\r
    /**\r
      Get the autogen string for header file.\r
      \r
      @return The string of header file.\r
    **/\r
    public String getHAutogenStr() {\r
        return hAutogenStr;\r
    }\r
\r
    /**\r
      Get the autogen string for C code file.\r
      \r
      @return The string of C Code file.\r
    **/\r
    public String getCAutogenStr() {\r
        return cAutogenStr;\r
    }\r
}\r
\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	UsageInstance class.\r
	3	\r
	4	This class indicate an usage instance for a PCD token. This instance maybe a module\r
	5	or platform setting. When a module produce or cosume a PCD token, then this module\r
	6	is an usage instance for this PCD token.\r
	7	\r
	8	Copyright (c) 2006, Intel Corporation\r
	9	All rights reserved. This program and the accompanying materials\r
	10	are licensed and made available under the terms and conditions of the BSD License\r
	11	which accompanies this distribution. The full text of the license may be found at\r
	12	http://opensource.org/licenses/bsd-license.php\r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	15	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	\r
	17	**/ \r
	18	package org.tianocore.build.pcd.entity;\r
	19	\r
	20	\r
8840ad58	21	import java.util.UUID;\r
eece174a	22	\r
03b1a72d	23	import org.tianocore.ModuleTypeDef;\r
136adffc	24	import org.tianocore.build.autogen.CommonDefinition;\r
eece174a	25	import org.tianocore.build.id.ModuleIdentification;\r
8840ad58	26	import org.tianocore.build.pcd.exception.EntityException;\r
878ddf1f	27	\r
	28	/**\r
	29	This class indicate an usage instance for a PCD token. This instance maybe a module\r
	30	or platform setting. When a module produce or cosume a PCD token, then this module\r
	31	is an usage instance for this PCD token.\r
	32	**/\r
	33	public class UsageInstance {\r
38ee8d9e	34	///\r
	35	/// This parent that this usage instance belongs to.\r
	36	///\r
eece174a	37	public Token parentToken;\r
38ee8d9e	38	\r
38ee8d9e	39	///\r
eece174a	40	/// ModuleIdentification for Usage Instance\r
38ee8d9e	41	/// \r
eece174a	42	public ModuleIdentification moduleId;\r
38ee8d9e	43	\r
38ee8d9e	44	///\r
eece174a	45	/// Arch also is a key for a UsageInstance\r
38ee8d9e	46	/// \r
eece174a	47	public String arch;\r
38ee8d9e	48	\r
	49	///\r
	50	/// The PCD type defined for module \r
	51	/// \r
eece174a	52	public Token.PCD_TYPE modulePcdType;\r
38ee8d9e	53	\r
	54	///\r
	55	/// The value of the PCD in this usage instance. \r
	56	/// \r
eece174a	57	public String datum;\r
38ee8d9e	58	\r
	59	///\r
	60	/// The maxDatumSize could be different for same PCD in different module\r
	61	/// But this case is allow for FeatureFlag, FixedAtBuild, PatchableInModule\r
	62	/// type.\r
	63	/// \r
eece174a	64	public int maxDatumSize;\r
38ee8d9e	65	\r
	66	///\r
	67	/// Autogen string for header file.\r
	68	///\r
eece174a	69	public String hAutogenStr;\r
38ee8d9e	70	\r
	71	///\r
	72	/// Auotgen string for C code file.\r
	73	/// \r
eece174a	74	public String cAutogenStr;\r
38ee8d9e	75	\r
38ee8d9e	76	/**\r
eece174a	77	Constructure function for UsageInstance\r
38ee8d9e	78	\r
eece174a	79	@param parentToken The token instance for this usgaInstance\r
	80	@param id The identification for usage instance\r
	81	@param modulePcdType The PCD type for this usage instance\r
	82	@param value The value of this PCD in this usage instance\r
	83	@param maxDatumSize The max datum size of this PCD in this usage\r
	84	instance.\r
	85	**/\r
	86	public UsageInstance(Token parentToken,\r
	87	ModuleIdentification moduleId,\r
	88	Token.PCD_TYPE modulePcdType,\r
	89	String arch,\r
	90	String value,\r
	91	int maxDatumSize) {\r
38ee8d9e	92	this.parentToken = parentToken;\r
eece174a	93	this.moduleId = moduleId;\r
38ee8d9e	94	this.modulePcdType = modulePcdType;\r
38ee8d9e	95	this.arch = arch;\r
38ee8d9e	96	this.datum = value;\r
	97	this.maxDatumSize = maxDatumSize;\r
	98	}\r
	99	\r
	100	/**\r
	101	Get the primary key for usage instance array for every token.\r
	102	\r
eece174a	103	@param moduleId The module Identification for generating primary key\r
eece174a	104	@param arch Arch string\r
38ee8d9e	105	\r
eece174a	106	@retval String The primary key for this usage instance\r
	107	**/\r
	108	public static String getPrimaryKey(ModuleIdentification moduleId,\r
	109	String arch) {\r
	110	String moduleName = moduleId.getName();\r
	111	String moduleGuid = moduleId.getGuid();\r
	112	String packageName = moduleId.getPackage().getName();\r
	113	String packageGuid = moduleId.getPackage().getGuid();\r
	114	String version = moduleId.getVersion();\r
	115	\r
38ee8d9e	116	//\r
	117	// Because currently transition schema not require write moduleGuid, package Name, Packge GUID in\r
	118	// <ModuleSA> section, So currently no expect all paramter must be valid.\r
eece174a	119	// BUGBUG: Because currently we can not get version from MSA, So ignore verison.\r
	120	// \r
	121	return(moduleName + "_" +\r
	122	((moduleGuid != null) ? moduleGuid.toLowerCase() : "NullModuleGuid") + "_" +\r
	123	((packageName != null) ? packageName : "NullPackageName") + "_" +\r
	124	((packageGuid != null) ? packageGuid.toLowerCase() : "NullPackageGuid") + "_" +\r
	125	((arch != null) ? arch : "NullArch") + "_" +\r
	126	"NullVersion");\r
38ee8d9e	127	}\r
	128	\r
	129	/**\r
	130	Get primary key string for this usage instance\r
	131	\r
	132	@return String primary key string\r
	133	**/\r
	134	public String getPrimaryKey() {\r
eece174a	135	return UsageInstance.getPrimaryKey(moduleId, arch);\r
38ee8d9e	136	}\r
	137	\r
	138	/**\r
	139	Judget whether current module is PEI driver\r
	140	\r
eece174a	141	@return boolean whether current module is PEI driver\r
eece174a	142	**/\r
38ee8d9e	143	public boolean isPeiPhaseComponent() {\r
eece174a	144	int moduleType = CommonDefinition.getModuleType(moduleId.getModuleType());\r
eece174a	145	\r
136adffc	146	if ((moduleType == CommonDefinition.ModuleTypePeiCore) \|\|\r
136adffc	147	(moduleType == CommonDefinition.ModuleTypePeim)) {\r
38ee8d9e	148	return true;\r
	149	}\r
	150	return false;\r
	151	}\r
	152	\r
	153	/**\r
eece174a	154	Judge whether current module is DXE driver.\r
38ee8d9e	155	\r
eece174a	156	@return boolean whether current module is DXE driver\r
	157	**/\r
	158	public boolean isDxePhaseComponent() {\r
	159	int moduleType = CommonDefinition.getModuleType(moduleId.getModuleType());\r
	160	\r
	161	if ((moduleType == CommonDefinition.ModuleTypeDxeDriver) \|\|\r
	162	(moduleType == CommonDefinition.ModuleTypeDxeRuntimeDriver) \|\|\r
	163	(moduleType == CommonDefinition.ModuleTypeDxeSalDriver) \|\|\r
	164	(moduleType == CommonDefinition.ModuleTypeDxeSmmDriver) \|\|\r
	165	(moduleType == CommonDefinition.ModuleTypeUefiDriver) \|\|\r
	166	(moduleType == CommonDefinition.ModuleTypeUefiApplication)\r
	167	) {\r
	168	return true;\r
	169	}\r
	170	return false;\r
	171	}\r
	172	\r
	173	/**\r
	174	Generate autogen string for header file and C code file.\r
38ee8d9e	175	\r
38ee8d9e	176	@param isBuildUsedLibrary whether the autogen is for library.\r
eece174a	177	**/\r
eece174a	178	public void generateAutoGen(boolean isBuildUsedLibrary) {\r
51da9e80	179	String guidStringCName = null;\r
	180	boolean isByteArray = false;\r
	181	String printDatum = null;\r
	182	String tokenNumberString = null;\r
38ee8d9e	183	\r
	184	hAutogenStr = "";\r
	185	cAutogenStr = "";\r
	186	\r
	187	if (this.modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {\r
eece174a	188	//\r
	189	// For DYNAMIC_EX type PCD, use original token number in SPD or FPD to generate autogen\r
	190	// \r
51da9e80	191	tokenNumberString = Long.toString(parentToken.dynamicExTokenNumber, 16);\r
38ee8d9e	192	} else {\r
eece174a	193	//\r
	194	// For Others type PCD, use autogenerated token number to generate autogen\r
	195	// \r
51da9e80	196	tokenNumberString = Long.toString(parentToken.tokenNumber, 16);\r
38ee8d9e	197	}\r
38ee8d9e	198	\r
eece174a	199	hAutogenStr += String.format("#define _PCD_TOKEN_%s 0x%s\r\n", parentToken.cName, tokenNumberString);\r
	200	\r
	201	//\r
	202	// Judge the value of this PCD is byte array type\r
	203	// \r
2435723a	204	if (!isBuildUsedLibrary && !parentToken.isDynamicPCD) {\r
	205	if (datum.trim().charAt(0) == '{') {\r
	206	isByteArray = true;\r
	207	}\r
	208	}\r
	209	\r
eece174a	210	//\r
	211	// "ULL" should be added to value's tail for UINT64 value\r
	212	// \r
1cf9cdcc	213	if (parentToken.datumType == Token.DATUM_TYPE.UINT64) {\r
	214	printDatum = this.datum + "ULL";\r
	215	} else {\r
	216	printDatum = this.datum;\r
	217	}\r
	218	\r
38ee8d9e	219	switch (modulePcdType) {\r
38ee8d9e	220	case FEATURE_FLAG:\r
16d3e132	221	hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
16d3e132	222	parentToken.cName);\r
57a38e69	223	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",\r
16d3e132	224	parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	225	parentToken.cName,\r
	226	parentToken.cName);\r
57a38e69	227	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
	228	parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	229	parentToken.cName);\r
16d3e132	230	\r
16d3e132	231	if (!isBuildUsedLibrary) {\r
38ee8d9e	232	hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
38ee8d9e	233	parentToken.cName, \r
1cf9cdcc	234	printDatum);\r
38ee8d9e	235	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
	236	parentToken.cName,\r
	237	parentToken.cName);\r
38ee8d9e	238	}\r
	239	break;\r
	240	case FIXED_AT_BUILD:\r
16d3e132	241	if (isByteArray) {\r
	242	hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",\r
	243	parentToken.cName);\r
57a38e69	244	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s (VOID*)_gPcd_FixedAtBuild_%s\r\n", \r
16d3e132	245	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	246	parentToken.cName,\r
	247	parentToken.cName);\r
	248	} else {\r
38ee8d9e	249	hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
	250	Token.getAutogendatumTypeString(parentToken.datumType),\r
	251	parentToken.cName);\r
57a38e69	252	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n", \r
38ee8d9e	253	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	254	parentToken.cName,\r
	255	parentToken.cName);\r
16d3e132	256	}\r
16d3e132	257	\r
57a38e69	258	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
	259	parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	260	parentToken.cName);\r
16d3e132	261	if (!isBuildUsedLibrary) {\r
9efa2da0	262	if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
	263	if (isByteArray) {\r
	264	hAutogenStr += String.format("#define _PCD_VALUE_%s (VOID*)_gPcd_FixedAtBuild_%s\r\n", \r
	265	parentToken.cName, \r
	266	parentToken.cName);\r
	267	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = %s;\r\n",\r
	268	parentToken.cName,\r
	269	printDatum);\r
	270	} else {\r
	271	hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
	272	parentToken.cName, \r
	273	printDatum);\r
	274	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
	275	Token.getAutogendatumTypeString(parentToken.datumType),\r
	276	parentToken.cName,\r
	277	parentToken.cName);\r
	278	}\r
2435723a	279	} else {\r
9efa2da0	280	hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
	281	parentToken.cName, \r
	282	printDatum);\r
2435723a	283	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
	284	Token.getAutogendatumTypeString(parentToken.datumType),\r
	285	parentToken.cName,\r
	286	parentToken.cName);\r
2435723a	287	}\r
38ee8d9e	288	}\r
	289	break;\r
	290	case PATCHABLE_IN_MODULE:\r
16d3e132	291	if (isByteArray) {\r
	292	hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",\r
	293	parentToken.cName);\r
57a38e69	294	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s (VOID*)_gPcd_BinaryPatch_%s\r\n",\r
16d3e132	295	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	296	parentToken.cName,\r
	297	parentToken.cName); \r
	298	} else {\r
38ee8d9e	299	hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",\r
	300	Token.getAutogendatumTypeString(parentToken.datumType),\r
	301	parentToken.cName);\r
57a38e69	302	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",\r
38ee8d9e	303	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
38ee8d9e	304	parentToken.cName,\r
16d3e132	305	parentToken.cName); \r
	306	}\r
	307	\r
57a38e69	308	//\r
	309	// Generate _PCD_SET_MODE_xx macro for using set BinaryPatch value via PcdSet macro\r
	310	// \r
	311	if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
	312	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) CopyMem (_gPcd_BinaryPatch_%s, (Buffer), (SizeOfBuffer))\r\n",\r
	313	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	314	parentToken.cName,\r
	315	parentToken.cName);\r
	316	} else {\r
	317	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) (_gPcd_BinaryPatch_%s = (Value))\r\n",\r
	318	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	319	parentToken.cName,\r
	320	parentToken.cName);\r
	321	}\r
	322	\r
16d3e132	323	if (!isBuildUsedLibrary) {\r
38ee8d9e	324	hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
38ee8d9e	325	parentToken.cName, \r
1cf9cdcc	326	printDatum);\r
2435723a	327	if (isByteArray) {\r
	328	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",\r
	329	parentToken.cName,\r
	330	parentToken.cName);\r
2435723a	331	} else {\r
	332	cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",\r
	333	Token.getAutogendatumTypeString(parentToken.datumType),\r
	334	parentToken.cName,\r
	335	parentToken.cName);\r
2435723a	336	}\r
38ee8d9e	337	}\r
	338	\r
	339	break;\r
	340	case DYNAMIC:\r
57a38e69	341	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s LibPcdGet%s(_PCD_TOKEN_%s)\r\n",\r
38ee8d9e	342	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	343	parentToken.cName,\r
	344	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
	345	parentToken.cName);\r
57a38e69	346	if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
	347	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSet%s(_PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",\r
	348	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	349	parentToken.cName,\r
	350	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
	351	parentToken.cName);\r
	352	} else {\r
	353	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSet%s(_PCD_TOKEN_%s, (Value))\r\n",\r
	354	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	355	parentToken.cName,\r
	356	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
	357	parentToken.cName);\r
	358	}\r
38ee8d9e	359	break;\r
38ee8d9e	360	case DYNAMIC_EX:\r
11e7b0f6	361	guidStringCName = "_gPcd_TokenSpaceGuid_" +\r
11e7b0f6	362	parentToken.tokenSpaceName.toString().replaceAll("-", "_");\r
57a38e69	363	\r
57a38e69	364	hAutogenStr += String.format("#define _PCD_GET_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",\r
38ee8d9e	365	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	366	parentToken.cName,\r
	367	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
a49b34c0	368	guidStringCName,\r
38ee8d9e	369	parentToken.cName);\r
38ee8d9e	370	\r
57a38e69	371	if (parentToken.datumType == Token.DATUM_TYPE.POINTER) {\r
	372	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",\r
	373	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	374	parentToken.cName,\r
	375	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
	376	guidStringCName,\r
	377	parentToken.cName);\r
	378	} else {\r
	379	hAutogenStr += String.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (Value))\r\n",\r
	380	Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
	381	parentToken.cName,\r
	382	Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
	383	guidStringCName,\r
	384	parentToken.cName);\r
	385	\r
	386	}\r
38ee8d9e	387	break;\r
	388	}\r
	389	}\r
	390	\r
	391	/**\r
	392	Get the autogen string for header file.\r
	393	\r
	394	@return The string of header file.\r
	395	**/\r
	396	public String getHAutogenStr() {\r
	397	return hAutogenStr;\r
	398	}\r
878ddf1f	399	\r
38ee8d9e	400	/**\r
	401	Get the autogen string for C code file.\r
	402	\r
	403	@return The string of C Code file.\r
	404	**/\r
	405	public String getCAutogenStr() {\r
	406	return cAutogenStr;\r
878ddf1f	407	}\r
878ddf1f	408	}\r
878ddf1f	409	\r