\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
///\r
/// This parent that this usage instance belongs to.\r
///\r
- public Token parentToken;\r
-\r
- ///\r
- /// The name of the module who contains this PCD.\r
- ///\r
- public String moduleName;\r
+ public Token parentToken;\r
\r
///\r
- /// The GUID of the module who contains this PCD. \r
+ /// ModuleIdentification for Usage Instance\r
/// \r
- public UUID moduleGUID;\r
+ public ModuleIdentification moduleId;\r
\r
///\r
- /// The name of the package whose module contains this PCD.\r
- ///\r
- public String packageName;\r
-\r
- ///\r
- /// The GUID of the package whose module contains this PCD.\r
+ /// Arch also is a key for a UsageInstance\r
/// \r
- public UUID packageGUID;\r
+ public String arch;\r
\r
///\r
/// The PCD type defined for module \r
/// \r
- public Token.PCD_TYPE modulePcdType;\r
-\r
- ///\r
- /// The arch string of module contains this PCD\r
- ///\r
- public String arch;\r
-\r
- ///\r
- /// The version of module contains this PCD\r
- /// \r
- public String version;\r
-\r
- ///\r
- /// The module type for this usage instance.\r
- ///\r
- public ModuleTypeDef.Enum moduleType;\r
+ public Token.PCD_TYPE modulePcdType;\r
\r
///\r
/// The value of the PCD in this usage instance. \r
/// \r
- public String datum;\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
+ public int maxDatumSize;\r
\r
///\r
/// Autogen string for header file.\r
///\r
- public String hAutogenStr;\r
+ public String hAutogenStr;\r
\r
///\r
/// Auotgen string for C code file.\r
/// \r
- public String cAutogenStr;\r
+ public String cAutogenStr;\r
\r
/**\r
- Constructure function\r
+ Constructure function for UsageInstance\r
\r
- @param parentToken Member variable.\r
- @param moduleName Member variable.\r
- @param moduleGUID Member variable.\r
- @param packageName Member variable.\r
- @param packageGUID Member variable.\r
- @param moduleType Member variable.\r
- @param modulePcdType Member variable.\r
- @param arch Member variable.\r
- @param version Member variable.\r
- @param value Member variable.\r
- @param maxDatumSize Member variable.\r
- */\r
- public UsageInstance (Token parentToken,\r
- String moduleName,\r
- UUID moduleGUID,\r
- String packageName,\r
- UUID packageGUID,\r
- ModuleTypeDef.Enum moduleType,\r
- Token.PCD_TYPE modulePcdType,\r
- String arch,\r
- String version,\r
- String value,\r
- int maxDatumSize) {\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.moduleName = moduleName;\r
- this.moduleGUID = moduleGUID;\r
- this.packageName = packageName;\r
- this.packageGUID = packageGUID;\r
- this.moduleType = moduleType;\r
+ this.moduleId = moduleId;\r
this.modulePcdType = modulePcdType;\r
this.arch = arch;\r
- this.version = version;\r
this.datum = value;\r
this.maxDatumSize = maxDatumSize;\r
}\r
/**\r
Get the primary key for usage instance array for every token.\r
\r
- @param moduleName the name of module\r
- @param moduleGUID the GUID name of module\r
- @param packageName the name of package who contains this module\r
- @param packageGUID the GUID name of package\r
- @param arch the archtecture string\r
- @param version the version of this module\r
+ @param moduleId The module Identification for generating primary key\r
+ @param arch Arch string\r
\r
- @return String primary key\r
- */\r
- public static String getPrimaryKey(String moduleName, \r
- UUID moduleGUID, \r
- String packageName, \r
- UUID packageGUID,\r
- String arch,\r
- String version) {\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
- return(moduleName + "_" +\r
- ((moduleGUID != null) ? moduleGUID.toString() : "NullModuleGuid") + "_" +\r
- ((packageName != null) ? packageName : "NullPackageName") + "_" +\r
- ((packageGUID != null) ? packageGUID.toString() : "NullPackageGuid") + "_" +\r
- ((arch != null) ? arch : "NullArch") + "_" +\r
- ((version != null) ? version : "NullVersion"));\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
@return String primary key string\r
**/\r
public String getPrimaryKey() {\r
- return UsageInstance.getPrimaryKey(moduleName, moduleGUID, packageName, packageGUID, arch, version);\r
+ return UsageInstance.getPrimaryKey(moduleId, arch);\r
}\r
\r
/**\r
Judget whether current module is PEI driver\r
\r
- @return boolean\r
- */\r
+ @return boolean whether current module is PEI driver\r
+ **/\r
public boolean isPeiPhaseComponent() {\r
- if ((moduleType == ModuleTypeDef.PEI_CORE) ||\r
- (moduleType == ModuleTypeDef.PEIM)) {\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
- 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 == ModuleTypeDef.DXE_DRIVER) ||\r
- (moduleType == ModuleTypeDef.DXE_RUNTIME_DRIVER) ||\r
- (moduleType == ModuleTypeDef.DXE_SAL_DRIVER) ||\r
- (moduleType == ModuleTypeDef.DXE_SMM_DRIVER) ||\r
- (moduleType == ModuleTypeDef.UEFI_DRIVER) ||\r
- (moduleType == ModuleTypeDef.UEFI_APPLICATION)\r
- ) {\r
- return true;\r
- }\r
- return false;\r
- }\r
\r
/**\r
- Generate autogen string for header file and C code file.\r
+ Judge whether current module is DXE driver.\r
\r
- @throws EntityException Fail to generate.\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
- throws EntityException {\r
+ **/\r
+ public void generateAutoGen(boolean isBuildUsedLibrary) {\r
String guidStringCName = null;\r
boolean isByteArray = false;\r
String printDatum = null;\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", \r
- parentToken.cName, tokenNumberString);\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
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
- if (isByteArray) {\r
- cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = _PCD_VALUE_%s;\r\n",\r
- parentToken.cName,\r
- parentToken.cName);\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