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

/** @file\r
  Token class.\r
\r
  This module contains all classes releted to 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
import java.util.ArrayList;\r
import java.util.List;\r
import java.util.UUID;\r
import java.util.Map;\r
import java.util.HashMap;\r
\r
import org.tianocore.build.pcd.action.ActionMessage;\r
import org.tianocore.build.pcd.exception.EntityException;\r
\r
/** This class is to descript a PCD token object. The information of a token mainly \r
    comes from MSA, SPD and setting produced by platform developer. \r
**/\r
public class Token {\r
    ///\r
    /// Enumeration macro defintion for PCD type.\r
    /// BUGBUG: Not use upcase charater is to facility for reading. It may be changed\r
    ///         in coding review.\r
    public enum             PCD_TYPE {FEATURE_FLAG, FIXED_AT_BUILD, PATCHABLE_IN_MODULE, DYNAMIC, \r
                                      DYNAMIC_EX, UNKNOWN}\r
\r
    ///\r
    /// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.\r
    /// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in \r
    /// prompt dialog.\r
    ///\r
    public enum             DATUM_TYPE {UINT8, UINT16, UINT32, UINT64, BOOLEAN, POINTER, UNKNOWN}\r
\r
    ///\r
    /// Enumeration macor defintion for usage of PCD\r
    ///\r
    public enum             PCD_USAGE {ALWAYS_PRODUCED, ALWAYS_CONSUMED, SOMETIMES_PRODUCED,\r
                                       SOMETIMES_CONSUMED, UNKNOWN}\r
\r
    ///\r
    /// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.\r
    /// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.\r
    ///\r
    public String           cName;\r
\r
    ///\r
    /// Token space name is the guid defined by token itself in package or module level. This\r
    /// name mainly for DynamicEx type. For other PCD type token, his token space name is the \r
    /// assignedtokenSpaceName as follows.\r
    /// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.\r
    ///\r
    public UUID             tokenSpaceName;\r
\r
    ///\r
    /// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in\r
    /// platform token space.\r
    /// tokenNumber is defined in SPD, FPD.\r
    ///\r
    public int              tokenNumber;\r
\r
    ///\r
    /// pcdType is the PCD item type defined by platform developer.\r
    ///\r
    public PCD_TYPE         pcdType;\r
\r
    ///\r
    /// datumSize is to descript the fix size or max size for this token. \r
    /// datumSize is defined in SPD.\r
    ///\r
    public int              datumSize;\r
\r
    ///\r
    /// datum type is to descript what type can be expressed by a PCD token.\r
    /// datumType is defined in SPD.\r
    ///\r
    public DATUM_TYPE       datumType;\r
\r
    ///\r
    /// hiiEnabled is to indicate whether the token support Hii functionality.\r
    /// hiiEnabled is defined in FPD.\r
    ///\r
    public boolean          hiiEnabled;\r
\r
    ///\r
    /// variableName is valid only when this token support Hii functionality. variableName\r
    /// indicates the value of token is associated with what variable.\r
    /// variableName is defined in FPD.\r
    ///\r
    public String           variableName;\r
\r
    ///\r
    /// variableGuid is the GUID this token associated with.\r
    /// variableGuid is defined in FPD.\r
    ///\r
    public UUID             variableGuid;\r
\r
    ///\r
    /// Variable offset indicate the associated variable's offset in NV storage.\r
    /// variableOffset is defined in FPD.\r
    ///\r
    public int              variableOffset;\r
\r
    ///\r
    /// skuEnabled is to indicate whether the token support Sku functionality.\r
    /// skuEnabled is defined in FPD.\r
    ///\r
    public boolean          skuEnabled;\r
\r
    ///\r
    /// skuData contains all value for SkuNumber of token.\r
    /// skuData is defined in FPD.\r
    ///\r
    public List<SkuInstance> skuData;\r
\r
    ///\r
    /// maxSkuCount indicate the max count of sku data.\r
    /// maxSkuCount is defined in FPD.\r
    ///\r
    public int              maxSkuCount;\r
\r
    ///\r
    /// SkuId is the id of current selected SKU.\r
    /// SkuId is defined in FPD.\r
    ///\r
    public int              skuId;\r
\r
    ///\r
    /// datum is the value set by platform developer.\r
    /// datum is defined in FPD.\r
    ///\r
    public Object           datum;\r
\r
    ///\r
    /// BUGBUG: fix comment\r
    /// vpdEnabled is defined in FPD.\r
    ///\r
    public boolean          vpdEnabled;\r
\r
    ///\r
    /// BUGBUG: fix comment\r
    /// vpdOffset is defined in FPD.\r
    ///\r
    public long             vpdOffset;\r
\r
    ///\r
    /// consumers array record all module private information who consume this PCD token.\r
    ///\r
    public Map<String, UsageInstance>  consumers;\r
\r
    public Token(String cName, UUID tokenSpaceName) {\r
        UUID    nullUUID = new UUID(0, 0);\r
\r
        this.cName                  = cName;\r
        this.tokenSpaceName         = (tokenSpaceName == null) ? nullUUID : tokenSpaceName;\r
        this.tokenNumber            = 0;\r
        this.pcdType                = PCD_TYPE.UNKNOWN;\r
        this.datumType              = DATUM_TYPE.UNKNOWN;\r
        this.datumSize              = -1;\r
        this.datum                  = null;\r
        this.hiiEnabled             = false;\r
        this.variableGuid           = null;\r
        this.variableName           = "";\r
        this.variableOffset         = -1;\r
        this.skuEnabled             = false;\r
        this.skuId                  = -1;\r
        this.maxSkuCount            = -1;\r
        this.skuData                = new ArrayList<SkuInstance>();\r
        this.vpdEnabled             = false;\r
        this.vpdOffset              = -1;\r
\r
        this.consumers              = new HashMap<String, UsageInstance>();\r
    }\r
\r
    /**\r
      Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database\r
      \r
      @param   cName                     Token name.\r
      @param   tokenSpaceName            The token space guid defined in MSA or SPD\r
      @param   platformtokenSpaceName    The token space guid for current platform token space,\r
      \r
      @return  primary key for this token in token database.\r
    **/\r
    public static String getPrimaryKeyString(String cName, UUID tokenSpaceName) {\r
        UUID  nullUUID = new UUID(0, 0);\r
\r
        if (tokenSpaceName == null) {\r
            return cName + "_" + nullUUID.toString().replace('-', '_');\r
        } else {\r
            return cName + "_" + tokenSpaceName.toString().replace('-', '_');\r
        }\r
    }\r
\r
    /**\r
       Get the token primary key in token database.\r
       \r
       @return String\r
     */\r
    public String getPrimaryKeyString () {\r
        return Token.getPrimaryKeyString(cName, tokenSpaceName);\r
    }\r
\r
    /**\r
      Judge datumType is valid\r
      \r
      @param type  The datumType want to be judged.\r
      \r
      @retval TRUE  - The type is valid.\r
      @retval FALSE - The type is invalid.\r
    **/\r
    public static boolean isValiddatumType(DATUM_TYPE type) {\r
        if ((type.ordinal() < DATUM_TYPE.UINT8.ordinal() ) || \r
            (type.ordinal() > DATUM_TYPE.POINTER.ordinal())) {\r
            return false;\r
        }\r
        return true;\r
    }\r
\r
    /**\r
      Judge pcdType is valid\r
      \r
      @param  type The PCdType want to be judged.\r
      \r
      @retval TRUE  - The type is valid.\r
      @retval FALSE - The type is invalid.\r
    **/\r
    public static boolean isValidpcdType(PCD_TYPE  type) {\r
        if ((type.ordinal() < PCD_TYPE.FEATURE_FLAG.ordinal() ) || \r
            (type.ordinal() > PCD_TYPE.DYNAMIC_EX.ordinal())) {\r
            return false;\r
        }\r
        return true;\r
    }\r
\r
    /**\r
      Add an usage instance for token\r
      \r
      @param usageInstance   The usage instance\r
     \r
      @retval TRUE  - Success to add usage instance.\r
      @retval FALSE - Fail to add usage instance\r
    **/\r
    public boolean addUsageInstance(UsageInstance usageInstance) \r
        throws EntityException {\r
        String exceptionStr;\r
\r
        if (isUsageInstanceExist(usageInstance.moduleName,\r
                                 usageInstance.moduleGUID,\r
                                 usageInstance.packageName,\r
                                 usageInstance.packageGUID,\r
                                 usageInstance.arch,\r
                                 usageInstance.version)) {\r
            exceptionStr = String.format("PCD %s for module %s has already exist in database, Please check all PCD build entries "+\r
                                         "in modules PcdPeim in <ModuleSA> to make sure no duplicated definitions!",\r
                                         usageInstance.parentToken.cName,\r
                                         usageInstance.moduleName);\r
            throw new EntityException(exceptionStr);\r
        }\r
\r
        consumers.put(usageInstance.getPrimaryKey(), usageInstance);\r
        return true;\r
    }\r
\r
    /**\r
       Judge whether exist an usage instance for this token\r
       \r
       @param moduleName    the name of module\r
       @param moduleGuid    the GUID name of modules\r
       @param packageName   the name of package contains this module\r
       @param packageGuid   the GUID name of package contains this module\r
       @param arch          the architecture string\r
       @param version       the version string\r
       \r
       @return boolean      whether exist an usage instance for this token.\r
     */\r
    public boolean isUsageInstanceExist(String moduleName,\r
                                        UUID   moduleGuid,\r
                                        String packageName,\r
                                        UUID   packageGuid,\r
                                        String arch,\r
                                        String version) {\r
        String keyStr = UsageInstance.getPrimaryKey(moduleName, \r
                                                    moduleGuid, \r
                                                    packageName, \r
                                                    packageGuid, \r
                                                    arch, \r
                                                    version);\r
        return (consumers.get(keyStr) != null);\r
    }\r
\r
    /**\r
      Get the PCD_TYPE according to the string of PCD_TYPE\r
      \r
      @param pcdTypeStr    The string of PCD_TYPE\r
      \r
      @return PCD_TYPE\r
    **/\r
    public static PCD_TYPE getpcdTypeFromString(String pcdTypeStr) {\r
        if (pcdTypeStr == null) {\r
            return PCD_TYPE.UNKNOWN;\r
        }\r
\r
        if (pcdTypeStr.equalsIgnoreCase("FEATURE_FLAG")) {\r
            return PCD_TYPE.FEATURE_FLAG;\r
        } else if (pcdTypeStr.equalsIgnoreCase("FIXED_AT_BUILD")) {\r
            return PCD_TYPE.FIXED_AT_BUILD;\r
        } else if (pcdTypeStr.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {\r
            return PCD_TYPE.PATCHABLE_IN_MODULE;\r
        } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC")) {\r
            return PCD_TYPE.DYNAMIC;\r
        } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC_EX")) {\r
            return PCD_TYPE.DYNAMIC_EX;\r
        } else {\r
            return PCD_TYPE.UNKNOWN;\r
        }\r
    }\r
\r
    /**\r
      Get the string of given datumType. This string will be used for generating autogen files\r
     \r
      @param datumType   Given datumType\r
     \r
      @return The string of datum type.\r
    **/\r
    public static String getStringOfdatumType(DATUM_TYPE  datumType) {\r
        switch (datumType) {\r
        case UINT8:\r
            return "UINT8";\r
        case UINT16:\r
            return "UINT16";\r
        case UINT32:\r
            return "UINT32";\r
        case UINT64:\r
            return "UINT64";\r
        case POINTER:\r
            return "POINTER";\r
        case BOOLEAN:\r
            return "BOOLEAN";\r
        }\r
        return "UNKNOWN";\r
    }\r
\r
    /**\r
      Get the datumType according to a string.\r
      \r
      @param datumTypeStr    The string of datumType\r
     \r
      @return DATUM_TYPE\r
    **/\r
    public static DATUM_TYPE getdatumTypeFromString(String datumTypeStr) {\r
        if (datumTypeStr.equalsIgnoreCase("UINT8")) {\r
            return DATUM_TYPE.UINT8;\r
        } else if (datumTypeStr.equalsIgnoreCase("UINT16")) {\r
            return DATUM_TYPE.UINT16;\r
        } else if (datumTypeStr.equalsIgnoreCase("UINT32")) {\r
            return DATUM_TYPE.UINT32;\r
        } else if (datumTypeStr.equalsIgnoreCase("UINT64")) {\r
            return DATUM_TYPE.UINT64;\r
        } else if (datumTypeStr.equalsIgnoreCase("VOID*")) {\r
            return DATUM_TYPE.POINTER;\r
        } else if (datumTypeStr.equalsIgnoreCase("BOOLEAN")) {\r
            return DATUM_TYPE.BOOLEAN;\r
        }\r
        return DATUM_TYPE.UNKNOWN;\r
    }\r
\r
    /**\r
      Get string of given pcdType\r
      \r
      @param pcdType  The given PcdType\r
      \r
      @return The string of PCD_TYPE.\r
    **/\r
    public static String getStringOfpcdType(PCD_TYPE pcdType) {\r
        switch (pcdType) {\r
        case FEATURE_FLAG:\r
            return "FEATURE_FLAG";\r
        case FIXED_AT_BUILD:\r
            return "FIXED_AT_BUILD";\r
        case PATCHABLE_IN_MODULE:\r
            return "PATCHABLE_IN_MODULE";\r
        case DYNAMIC:\r
            return "DYNAMIC";\r
        case DYNAMIC_EX:\r
            return "DYNAMIC_EX";\r
        }\r
        return "UNKNOWN";\r
    }\r
\r
    /**\r
      Get the PCD_USAGE according to a string\r
      \r
      @param usageStr  The string of PCD_USAGE\r
      \r
      @return The PCD_USAGE\r
    **/\r
    public static PCD_USAGE getUsageFromString(String usageStr) {\r
        if (usageStr == null) {\r
            return PCD_USAGE.UNKNOWN;\r
        }\r
\r
        if (usageStr.equalsIgnoreCase("ALWAYS_PRODUCED")) {\r
            return PCD_USAGE.ALWAYS_PRODUCED;\r
        } else if (usageStr.equalsIgnoreCase("SOMETIMES_PRODUCED")) {\r
            return PCD_USAGE.SOMETIMES_PRODUCED;\r
        } else if (usageStr.equalsIgnoreCase("ALWAYS_CONSUMED")) {\r
            return PCD_USAGE.ALWAYS_CONSUMED;\r
        } else if (usageStr.equalsIgnoreCase("SOMETIMES_CONSUMED")) {\r
            return PCD_USAGE.SOMETIMES_CONSUMED;\r
        }\r
\r
        return PCD_USAGE.UNKNOWN;\r
    }\r
\r
    /**\r
      Get the string of given PCD_USAGE\r
      \r
      @param   usage   The given PCD_USAGE\r
      \r
      @return The string of PDC_USAGE.\r
    **/\r
    public static String getStringOfUsage(PCD_USAGE usage) {\r
        switch (usage) {\r
        case ALWAYS_PRODUCED:\r
            return "ALWAYS_PRODUCED";\r
        case ALWAYS_CONSUMED:\r
            return "ALWAYS_CONSUMED";\r
        case SOMETIMES_PRODUCED:\r
            return "SOMETIMES_PRODUCED";\r
        case SOMETIMES_CONSUMED:\r
            return "SOMETIMES_CONSUMED";\r
        }\r
        return "UNKNOWN";\r
    }\r
\r
    /**\r
      Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h\r
      \r
      @param datumType The given datumType\r
\r
      @return string of datum type for autogen.\r
    **/\r
    public static String GetAutogenDefinedatumTypeString(DATUM_TYPE datumType) {\r
        switch (datumType) {\r
        \r
        case UINT8:\r
            return "8";\r
        case UINT16:\r
            return "16";\r
        case BOOLEAN:\r
            return "BOOL";\r
        case POINTER:\r
            return "PTR";\r
        case UINT32:\r
            return "32";\r
        case UINT64:\r
            return "64";\r
        default:\r
            return null;\r
        }\r
    }\r
\r
    /**\r
      Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen\r
      \r
      @param datumType   The given datumType\r
\r
      @return string of datum type.\r
    **/\r
    public static String getAutogendatumTypeString(DATUM_TYPE datumType) {\r
        switch (datumType) {\r
        case UINT8:\r
            return "UINT8";\r
        case UINT16:\r
            return "UINT16";\r
        case UINT32:\r
            return "UINT32";\r
        case UINT64:\r
            return "UINT64";\r
        case POINTER:\r
            return "VOID*";\r
        case BOOLEAN:\r
            return "BOOLEAN";\r
        }\r
        return null;\r
    }\r
\r
    /**\r
      Get the datumType string for generating some MACROs in autogen file of Library\r
      \r
      @param   datumType  The given datumType\r
\r
      @return String of datum for genrating bit charater.\r
    **/\r
    public static String getAutogenLibrarydatumTypeString(DATUM_TYPE datumType) {\r
        switch (datumType) {\r
        case UINT8:\r
            return "8";\r
        case UINT16:\r
            return "16";\r
        case BOOLEAN:\r
            return "Bool";\r
        case POINTER:\r
            return "Ptr";\r
        case UINT32:\r
            return "32";\r
        case UINT64:\r
            return "64";\r
        default:\r
            return null;\r
        }\r
    }\r
\r
    /**\r
      UUID defined in Schems is object, this function is to tranlate this object \r
      to UUID data.\r
      \r
      @param uuidObj The object comes from schema.\r
      \r
      @return The traslated UUID instance.\r
    **/\r
    public static UUID getGUIDFromSchemaObject(Object uuidObj) {\r
        UUID uuid;\r
        if (uuidObj.toString().equalsIgnoreCase("0")) {\r
            uuid = new UUID(0,0);\r
        } else {\r
            uuid = UUID.fromString(uuidObj.toString());\r
        }\r
\r
        return uuid;\r
    }\r
\r
    //\r
    // BugBug: We need change this algorithm accordingly when schema is updated\r
    //          to support no default value.\r
    //\r
    public boolean hasDefaultValue () {\r
\r
        if (hiiEnabled) {\r
            return true;\r
        }\r
\r
        if (vpdEnabled) {\r
            return true;\r
        }\r
\r
        if (datum.toString().compareTo("NoDefault") == 0) {\r
            return false;\r
        }\r
\r
        return true;\r
    }\r
\r
    public boolean isStringType () {\r
        String str = datum.toString();\r
\r
        if (datumType == Token.DATUM_TYPE.POINTER &&\r
            str.startsWith("L\"") && \r
            str.endsWith("\"")) {\r
            return true;\r
        }\r
\r
        return false;\r
    }\r
\r
    public String getStringTypeString () {                       \r
        return datum.toString().substring(2, datum.toString().length() - 1);\r
    }\r
}\r
\r
\r
\r
\r
Commit	Line	Data
878ddf1f	1	/** @file\r
	2	Token class.\r
	3	\r
	4	This module contains all classes releted to PCD token.\r
	5	\r
	6	Copyright (c) 2006, Intel Corporation\r
	7	All rights reserved. This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
	15	**/ \r
	16	package org.tianocore.build.pcd.entity;\r
	17	\r
	18	import java.util.ArrayList;\r
	19	import java.util.List;\r
	20	import java.util.UUID;\r
8840ad58	21	import java.util.Map;\r
8840ad58	22	import java.util.HashMap;\r
878ddf1f	23	\r
878ddf1f	24	import org.tianocore.build.pcd.action.ActionMessage;\r
8840ad58	25	import org.tianocore.build.pcd.exception.EntityException;\r
878ddf1f	26	\r
	27	/** This class is to descript a PCD token object. The information of a token mainly \r
	28	comes from MSA, SPD and setting produced by platform developer. \r
	29	**/\r
	30	public class Token {\r
	31	///\r
	32	/// Enumeration macro defintion for PCD type.\r
	33	/// BUGBUG: Not use upcase charater is to facility for reading. It may be changed\r
	34	/// in coding review.\r
	35	public enum PCD_TYPE {FEATURE_FLAG, FIXED_AT_BUILD, PATCHABLE_IN_MODULE, DYNAMIC, \r
	36	DYNAMIC_EX, UNKNOWN}\r
	37	\r
	38	///\r
	39	/// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.\r
	40	/// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in \r
	41	/// prompt dialog.\r
	42	///\r
	43	public enum DATUM_TYPE {UINT8, UINT16, UINT32, UINT64, BOOLEAN, POINTER, UNKNOWN}\r
	44	\r
	45	///\r
	46	/// Enumeration macor defintion for usage of PCD\r
	47	///\r
	48	public enum PCD_USAGE {ALWAYS_PRODUCED, ALWAYS_CONSUMED, SOMETIMES_PRODUCED,\r
	49	SOMETIMES_CONSUMED, UNKNOWN}\r
	50	\r
	51	///\r
	52	/// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.\r
	53	/// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.\r
	54	///\r
	55	public String cName;\r
	56	\r
	57	///\r
	58	/// Token space name is the guid defined by token itself in package or module level. This\r
	59	/// name mainly for DynamicEx type. For other PCD type token, his token space name is the \r
	60	/// assignedtokenSpaceName as follows.\r
	61	/// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.\r
	62	///\r
	63	public UUID tokenSpaceName;\r
	64	\r
	65	///\r
	66	/// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in\r
	67	/// platform token space.\r
	68	/// tokenNumber is defined in SPD, FPD.\r
	69	///\r
	70	public int tokenNumber;\r
	71	\r
878ddf1f	72	///\r
	73	/// pcdType is the PCD item type defined by platform developer.\r
	74	///\r
	75	public PCD_TYPE pcdType;\r
	76	\r
878ddf1f	77	///\r
	78	/// datumSize is to descript the fix size or max size for this token. \r
	79	/// datumSize is defined in SPD.\r
	80	///\r
	81	public int datumSize;\r
	82	\r
	83	///\r
	84	/// datum type is to descript what type can be expressed by a PCD token.\r
	85	/// datumType is defined in SPD.\r
	86	///\r
	87	public DATUM_TYPE datumType;\r
	88	\r
878ddf1f	89	///\r
	90	/// hiiEnabled is to indicate whether the token support Hii functionality.\r
	91	/// hiiEnabled is defined in FPD.\r
	92	///\r
	93	public boolean hiiEnabled;\r
	94	\r
	95	///\r
	96	/// variableName is valid only when this token support Hii functionality. variableName\r
	97	/// indicates the value of token is associated with what variable.\r
	98	/// variableName is defined in FPD.\r
	99	///\r
	100	public String variableName;\r
	101	\r
	102	///\r
	103	/// variableGuid is the GUID this token associated with.\r
	104	/// variableGuid is defined in FPD.\r
	105	///\r
	106	public UUID variableGuid;\r
	107	\r
	108	///\r
	109	/// Variable offset indicate the associated variable's offset in NV storage.\r
	110	/// variableOffset is defined in FPD.\r
	111	///\r
	112	public int variableOffset;\r
	113	\r
	114	///\r
	115	/// skuEnabled is to indicate whether the token support Sku functionality.\r
	116	/// skuEnabled is defined in FPD.\r
	117	///\r
	118	public boolean skuEnabled;\r
	119	\r
878ddf1f	120	///\r
	121	/// skuData contains all value for SkuNumber of token.\r
	122	/// skuData is defined in FPD.\r
	123	///\r
	124	public List<SkuInstance> skuData;\r
	125	\r
	126	///\r
	127	/// maxSkuCount indicate the max count of sku data.\r
	128	/// maxSkuCount is defined in FPD.\r
	129	///\r
	130	public int maxSkuCount;\r
	131	\r
	132	///\r
	133	/// SkuId is the id of current selected SKU.\r
	134	/// SkuId is defined in FPD.\r
	135	///\r
	136	public int skuId;\r
	137	\r
	138	///\r
	139	/// datum is the value set by platform developer.\r
	140	/// datum is defined in FPD.\r
	141	///\r
	142	public Object datum;\r
	143	\r
878ddf1f	144	///\r
	145	/// BUGBUG: fix comment\r
	146	/// vpdEnabled is defined in FPD.\r
	147	///\r
	148	public boolean vpdEnabled;\r
	149	\r
	150	///\r
	151	/// BUGBUG: fix comment\r
	152	/// vpdOffset is defined in FPD.\r
	153	///\r
	154	public long vpdOffset;\r
	155	\r
878ddf1f	156	///\r
	157	/// consumers array record all module private information who consume this PCD token.\r
	158	///\r
8840ad58	159	public Map<String, UsageInstance> consumers;\r
878ddf1f	160	\r
8840ad58	161	public Token(String cName, UUID tokenSpaceName) {\r
878ddf1f	162	UUID nullUUID = new UUID(0, 0);\r
	163	\r
	164	this.cName = cName;\r
8840ad58	165	this.tokenSpaceName = (tokenSpaceName == null) ? nullUUID : tokenSpaceName;\r
878ddf1f	166	this.tokenNumber = 0;\r
878ddf1f	167	this.pcdType = PCD_TYPE.UNKNOWN;\r
878ddf1f	168	this.datumType = DATUM_TYPE.UNKNOWN;\r
878ddf1f	169	this.datumSize = -1;\r
878ddf1f	170	this.datum = null;\r
	171	this.hiiEnabled = false;\r
	172	this.variableGuid = null;\r
	173	this.variableName = "";\r
	174	this.variableOffset = -1;\r
	175	this.skuEnabled = false;\r
878ddf1f	176	this.skuId = -1;\r
	177	this.maxSkuCount = -1;\r
	178	this.skuData = new ArrayList<SkuInstance>();\r
	179	this.vpdEnabled = false;\r
	180	this.vpdOffset = -1;\r
	181	\r
8840ad58	182	this.consumers = new HashMap<String, UsageInstance>();\r
878ddf1f	183	}\r
	184	\r
	185	/**\r
	186	Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database\r
	187	\r
	188	@param cName Token name.\r
	189	@param tokenSpaceName The token space guid defined in MSA or SPD\r
	190	@param platformtokenSpaceName The token space guid for current platform token space,\r
	191	\r
	192	@return primary key for this token in token database.\r
	193	**/\r
8840ad58	194	public static String getPrimaryKeyString(String cName, UUID tokenSpaceName) {\r
878ddf1f	195	UUID nullUUID = new UUID(0, 0);\r
878ddf1f	196	\r
8840ad58	197	if (tokenSpaceName == null) {\r
8840ad58	198	return cName + "_" + nullUUID.toString().replace('-', '_');\r
878ddf1f	199	} else {\r
8840ad58	200	return cName + "_" + tokenSpaceName.toString().replace('-', '_');\r
878ddf1f	201	}\r
	202	}\r
	203	\r
8840ad58	204	/**\r
	205	Get the token primary key in token database.\r
	206	\r
	207	@return String\r
	208	*/\r
32648c62	209	public String getPrimaryKeyString () {\r
8840ad58	210	return Token.getPrimaryKeyString(cName, tokenSpaceName);\r
32648c62	211	}\r
99d2c3c4	212	\r
878ddf1f	213	/**\r
	214	Judge datumType is valid\r
	215	\r
	216	@param type The datumType want to be judged.\r
	217	\r
	218	@retval TRUE - The type is valid.\r
	219	@retval FALSE - The type is invalid.\r
	220	**/\r
	221	public static boolean isValiddatumType(DATUM_TYPE type) {\r
	222	if ((type.ordinal() < DATUM_TYPE.UINT8.ordinal() ) \|\| \r
	223	(type.ordinal() > DATUM_TYPE.POINTER.ordinal())) {\r
	224	return false;\r
	225	}\r
	226	return true;\r
	227	}\r
	228	\r
	229	/**\r
	230	Judge pcdType is valid\r
	231	\r
	232	@param type The PCdType want to be judged.\r
	233	\r
	234	@retval TRUE - The type is valid.\r
	235	@retval FALSE - The type is invalid.\r
	236	**/\r
	237	public static boolean isValidpcdType(PCD_TYPE type) {\r
	238	if ((type.ordinal() < PCD_TYPE.FEATURE_FLAG.ordinal() ) \|\| \r
	239	(type.ordinal() > PCD_TYPE.DYNAMIC_EX.ordinal())) {\r
	240	return false;\r
	241	}\r
	242	return true;\r
	243	}\r
	244	\r
	245	/**\r
	246	Add an usage instance for token\r
	247	\r
	248	@param usageInstance The usage instance\r
	249	\r
	250	@retval TRUE - Success to add usage instance.\r
	251	@retval FALSE - Fail to add usage instance\r
	252	**/\r
8840ad58	253	public boolean addUsageInstance(UsageInstance usageInstance) \r
	254	throws EntityException {\r
	255	String exceptionStr;\r
	256	\r
	257	if (isUsageInstanceExist(usageInstance.moduleName,\r
	258	usageInstance.moduleGUID,\r
	259	usageInstance.packageName,\r
	260	usageInstance.packageGUID,\r
	261	usageInstance.arch,\r
	262	usageInstance.version)) {\r
	263	exceptionStr = String.format("PCD %s for module %s has already exist in database, Please check all PCD build entries "+\r
	264	"in modules PcdPeim in <ModuleSA> to make sure no duplicated definitions!",\r
	265	usageInstance.parentToken.cName,\r
	266	usageInstance.moduleName);\r
	267	throw new EntityException(exceptionStr);\r
878ddf1f	268	}\r
878ddf1f	269	\r
8840ad58	270	consumers.put(usageInstance.getPrimaryKey(), usageInstance);\r
878ddf1f	271	return true;\r
	272	}\r
	273	\r
	274	/**\r
8840ad58	275	Judge whether exist an usage instance for this token\r
	276	\r
	277	@param moduleName the name of module\r
	278	@param moduleGuid the GUID name of modules\r
	279	@param packageName the name of package contains this module\r
	280	@param packageGuid the GUID name of package contains this module\r
	281	@param arch the architecture string\r
	282	@param version the version string\r
	283	\r
	284	@return boolean whether exist an usage instance for this token.\r
	285	*/\r
	286	public boolean isUsageInstanceExist(String moduleName,\r
	287	UUID moduleGuid,\r
	288	String packageName,\r
	289	UUID packageGuid,\r
	290	String arch,\r
	291	String version) {\r
	292	String keyStr = UsageInstance.getPrimaryKey(moduleName, \r
	293	moduleGuid, \r
	294	packageName, \r
	295	packageGuid, \r
	296	arch, \r
	297	version);\r
	298	return (consumers.get(keyStr) != null);\r
878ddf1f	299	}\r
	300	\r
	301	/**\r
	302	Get the PCD_TYPE according to the string of PCD_TYPE\r
	303	\r
	304	@param pcdTypeStr The string of PCD_TYPE\r
	305	\r
	306	@return PCD_TYPE\r
	307	**/\r
	308	public static PCD_TYPE getpcdTypeFromString(String pcdTypeStr) {\r
	309	if (pcdTypeStr == null) {\r
	310	return PCD_TYPE.UNKNOWN;\r
	311	}\r
	312	\r
	313	if (pcdTypeStr.equalsIgnoreCase("FEATURE_FLAG")) {\r
	314	return PCD_TYPE.FEATURE_FLAG;\r
	315	} else if (pcdTypeStr.equalsIgnoreCase("FIXED_AT_BUILD")) {\r
	316	return PCD_TYPE.FIXED_AT_BUILD;\r
	317	} else if (pcdTypeStr.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {\r
	318	return PCD_TYPE.PATCHABLE_IN_MODULE;\r
	319	} else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC")) {\r
	320	return PCD_TYPE.DYNAMIC;\r
	321	} else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC_EX")) {\r
	322	return PCD_TYPE.DYNAMIC_EX;\r
	323	} else {\r
	324	return PCD_TYPE.UNKNOWN;\r
	325	}\r
	326	}\r
	327	\r
	328	/**\r
	329	Get the string of given datumType. This string will be used for generating autogen files\r
	330	\r
	331	@param datumType Given datumType\r
	332	\r
	333	@return The string of datum type.\r
	334	**/\r
	335	public static String getStringOfdatumType(DATUM_TYPE datumType) {\r
	336	switch (datumType) {\r
	337	case UINT8:\r
	338	return "UINT8";\r
	339	case UINT16:\r
	340	return "UINT16";\r
	341	case UINT32:\r
	342	return "UINT32";\r
	343	case UINT64:\r
	344	return "UINT64";\r
	345	case POINTER:\r
	346	return "POINTER";\r
	347	case BOOLEAN:\r
	348	return "BOOLEAN";\r
	349	}\r
	350	return "UNKNOWN";\r
	351	}\r
	352	\r
	353	/**\r
	354	Get the datumType according to a string.\r
	355	\r
	356	@param datumTypeStr The string of datumType\r
	357	\r
	358	@return DATUM_TYPE\r
	359	**/\r
	360	public static DATUM_TYPE getdatumTypeFromString(String datumTypeStr) {\r
	361	if (datumTypeStr.equalsIgnoreCase("UINT8")) {\r
	362	return DATUM_TYPE.UINT8;\r
363	} else if (datumTypeStr.equalsIgnoreCase("UINT16")) {\r
364	return DATUM_TYPE.UINT16;\r
365	} else if (datumTypeStr.equalsIgnoreCase("UINT32")) {\r
366	return DATUM_TYPE.UINT32;\r
367	} else if (datumTypeStr.equalsIgnoreCase("UINT64")) {\r
368	return DATUM_TYPE.UINT64;\r
369	} else if (datumTypeStr.equalsIgnoreCase("VOID*")) {\r
370	return DATUM_TYPE.POINTER;\r
371	} else if (datumTypeStr.equalsIgnoreCase("BOOLEAN")) {\r
372	return DATUM_TYPE.BOOLEAN;\r
373	}\r
374	return DATUM_TYPE.UNKNOWN;\r
375	}\r
376	\r
377	/**\r
378	Get string of given pcdType\r
379	\r
380	@param pcdType The given PcdType\r
381	\r
382	@return The string of PCD_TYPE.\r
383	**/\r
384	public static String getStringOfpcdType(PCD_TYPE pcdType) {\r
385	switch (pcdType) {\r
386	case FEATURE_FLAG:\r
387	return "FEATURE_FLAG";\r
388	case FIXED_AT_BUILD:\r
389	return "FIXED_AT_BUILD";\r
390	case PATCHABLE_IN_MODULE:\r
391	return "PATCHABLE_IN_MODULE";\r
392	case DYNAMIC:\r
393	return "DYNAMIC";\r
394	case DYNAMIC_EX:\r
395	return "DYNAMIC_EX";\r
396	}\r
397	return "UNKNOWN";\r
398	}\r
399	\r
400	/**\r
401	Get the PCD_USAGE according to a string\r
402	\r
403	@param usageStr The string of PCD_USAGE\r
404	\r
405	@return The PCD_USAGE\r
406	**/\r
407	public static PCD_USAGE getUsageFromString(String usageStr) {\r
408	if (usageStr == null) {\r
409	return PCD_USAGE.UNKNOWN;\r
410	}\r
411	\r
412	if (usageStr.equalsIgnoreCase("ALWAYS_PRODUCED")) {\r
413	return PCD_USAGE.ALWAYS_PRODUCED;\r
414	} else if (usageStr.equalsIgnoreCase("SOMETIMES_PRODUCED")) {\r
415	return PCD_USAGE.SOMETIMES_PRODUCED;\r
416	} else if (usageStr.equalsIgnoreCase("ALWAYS_CONSUMED")) {\r
417	return PCD_USAGE.ALWAYS_CONSUMED;\r
418	} else if (usageStr.equalsIgnoreCase("SOMETIMES_CONSUMED")) {\r
419	return PCD_USAGE.SOMETIMES_CONSUMED;\r
420	}\r
421	\r
422	return PCD_USAGE.UNKNOWN;\r
423	}\r
424	\r
425	/**\r
426	Get the string of given PCD_USAGE\r
427	\r
428	@param usage The given PCD_USAGE\r
429	\r
430	@return The string of PDC_USAGE.\r
431	**/\r
432	public static String getStringOfUsage(PCD_USAGE usage) {\r
433	switch (usage) {\r
434	case ALWAYS_PRODUCED:\r
435	return "ALWAYS_PRODUCED";\r
436	case ALWAYS_CONSUMED:\r
437	return "ALWAYS_CONSUMED";\r
438	case SOMETIMES_PRODUCED:\r
439	return "SOMETIMES_PRODUCED";\r
440	case SOMETIMES_CONSUMED:\r
441	return "SOMETIMES_CONSUMED";\r
442	}\r
443	return "UNKNOWN";\r
444	}\r
445	\r
446	/**\r
447	Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h\r
448	\r
449	@param datumType The given datumType\r
450	\r
451	@return string of datum type for autogen.\r
452	**/\r
453	public static String GetAutogenDefinedatumTypeString(DATUM_TYPE datumType) {\r
454	switch (datumType) {\r
455	\r
456	case UINT8:\r
457	return "8";\r
458	case UINT16:\r
459	return "16";\r
460	case BOOLEAN:\r
461	return "BOOL";\r
462	case POINTER:\r
463	return "PTR";\r
464	case UINT32:\r
465	return "32";\r
466	case UINT64:\r
467	return "64";\r
468	default:\r
469	return null;\r
470	}\r
471	}\r
472	\r
473	/**\r
474	Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen\r
475	\r
476	@param datumType The given datumType\r
477	\r
478	@return string of datum type.\r
479	**/\r
480	public static String getAutogendatumTypeString(DATUM_TYPE datumType) {\r
481	switch (datumType) {\r
482	case UINT8:\r
483	return "UINT8";\r
484	case UINT16:\r
485	return "UINT16";\r
486	case UINT32:\r
487	return "UINT32";\r
488	case UINT64:\r
489	return "UINT64";\r
490	case POINTER:\r
491	return "VOID*";\r
492	case BOOLEAN:\r
493	return "BOOLEAN";\r
494	}\r
495	return null;\r
496	}\r
497	\r
498	/**\r
499	Get the datumType string for generating some MACROs in autogen file of Library\r
500	\r
501	@param datumType The given datumType\r
502	\r
503	@return String of datum for genrating bit charater.\r
504	**/\r
505	public static String getAutogenLibrarydatumTypeString(DATUM_TYPE datumType) {\r
506	switch (datumType) {\r
507	case UINT8:\r
508	return "8";\r
509	case UINT16:\r
510	return "16";\r
511	case BOOLEAN:\r
512	return "Bool";\r
513	case POINTER:\r
514	return "Ptr";\r
515	case UINT32:\r
516	return "32";\r
517	case UINT64:\r
518	return "64";\r
519	default:\r
520	return null;\r
521	}\r
522	}\r
523	\r
524	/**\r
525	UUID defined in Schems is object, this function is to tranlate this object \r
526	to UUID data.\r
527	\r
528	@param uuidObj The object comes from schema.\r
529	\r
530	@return The traslated UUID instance.\r
531	**/\r
532	public static UUID getGUIDFromSchemaObject(Object uuidObj) {\r
533	UUID uuid;\r
534	if (uuidObj.toString().equalsIgnoreCase("0")) {\r
535	uuid = new UUID(0,0);\r
536	} else {\r
537	uuid = UUID.fromString(uuidObj.toString());\r
538	}\r
539	\r
540	return uuid;\r
541	}\r
99d2c3c4	542	\r
	543	//\r
	544	// BugBug: We need change this algorithm accordingly when schema is updated\r
	545	// to support no default value.\r
	546	//\r
	547	public boolean hasDefaultValue () {\r
	548	\r
32648c62	549	if (hiiEnabled) {\r
	550	return true;\r
	551	}\r
99d2c3c4	552	\r
32648c62	553	if (vpdEnabled) {\r
	554	return true;\r
	555	}\r
99d2c3c4	556	\r
	557	if (datum.toString().compareTo("NoDefault") == 0) {\r
	558	return false;\r
	559	}\r
	560	\r
	561	return true;\r
	562	}\r
	563	\r
32648c62	564	public boolean isStringType () {\r
32648c62	565	String str = datum.toString();\r
99d2c3c4	566	\r
32648c62	567	if (datumType == Token.DATUM_TYPE.POINTER &&\r
	568	str.startsWith("L\"") && \r
	569	str.endsWith("\"")) {\r
	570	return true;\r
	571	}\r
99d2c3c4	572	\r
32648c62	573	return false;\r
32648c62	574	}\r
99d2c3c4	575	\r
32648c62	576	public String getStringTypeString () { \r
	577	return datum.toString().substring(2, datum.toString().length() - 1);\r
	578	}\r
878ddf1f	579	}\r
	580	\r
	581	\r
	582	\r
	583	\r