]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/GenBuild/org/tianocore/build/pcd/entity/UsageInstance.java
1. UINTN & INTN issue for EBC architecture:
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / entity / UsageInstance.java
CommitLineData
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
8Copyright (c) 2006, Intel Corporation\r
9All rights reserved. This program and the accompanying materials\r
10are licensed and made available under the terms and conditions of the BSD License\r
11which accompanies this distribution. The full text of the license may be found at\r
12http://opensource.org/licenses/bsd-license.php\r
13 \r
14THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
15WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
16\r
17**/ \r
18package org.tianocore.build.pcd.entity;\r
19\r
20\r
8840ad58 21import java.util.UUID;\r
878ddf1f 22\r
23import org.tianocore.build.autogen.CommonDefinition;\r
8840ad58 24import org.tianocore.build.pcd.action.ActionMessage;\r
25import org.tianocore.build.pcd.exception.EntityException;\r
878ddf1f 26\r
27/**\r
28 This class indicate an usage instance for a PCD token. This instance maybe a module\r
29 or platform setting. When a module produce or cosume a PCD token, then this module\r
30 is an usage instance for this PCD token.\r
31**/\r
32public class UsageInstance {\r
38ee8d9e 33 ///\r
34 /// The module type of usage instance.\r
35 /// \r
36 public enum MODULE_TYPE {SEC, PEI_CORE, PEIM, DXE_CORE, DXE_DRIVERS, OTHER_COMPONENTS}\r
37\r
38 ///\r
39 /// This parent that this usage instance belongs to.\r
40 ///\r
41 public Token parentToken;\r
42\r
43 ///\r
44 /// The name of the module who contains this PCD.\r
45 ///\r
46 public String moduleName;\r
47\r
48 ///\r
49 /// The GUID of the module who contains this PCD. \r
50 /// \r
51 public UUID moduleGUID;\r
52\r
53 ///\r
54 /// The name of the package whose module contains this PCD.\r
55 ///\r
56 public String packageName;\r
57\r
58 ///\r
59 /// The GUID of the package whose module contains this PCD.\r
60 /// \r
61 public UUID packageGUID;\r
62\r
63 ///\r
64 /// The PCD type defined for module \r
65 /// \r
66 public Token.PCD_TYPE modulePcdType;\r
67\r
68 ///\r
69 /// The arch string of module contains this PCD\r
70 ///\r
71 public String arch;\r
72\r
73 ///\r
74 /// The version of module contains this PCD\r
75 /// \r
76 public String version;\r
77\r
78 ///\r
79 /// The module type for this usage instance.\r
80 ///\r
81 public MODULE_TYPE moduleType;\r
82\r
83 ///\r
84 /// The value of the PCD in this usage instance. \r
85 /// \r
86 public String datum;\r
87\r
88 ///\r
89 /// The maxDatumSize could be different for same PCD in different module\r
90 /// But this case is allow for FeatureFlag, FixedAtBuild, PatchableInModule\r
91 /// type.\r
92 /// \r
93 public int maxDatumSize;\r
94\r
95 ///\r
96 /// Autogen string for header file.\r
97 ///\r
98 public String hAutogenStr;\r
99\r
100 ///\r
101 /// Auotgen string for C code file.\r
102 /// \r
103 public String cAutogenStr;\r
104\r
105 /**\r
106 Constructure function\r
107 \r
108 @param parentToken Member variable.\r
109 @param moduleName Member variable.\r
110 @param moduleGUID Member variable.\r
111 @param packageName Member variable.\r
112 @param packageGUID Member variable.\r
113 @param moduleType Member variable.\r
114 @param modulePcdType Member variable.\r
115 @param arch Member variable.\r
116 @param version Member variable.\r
117 @param value Member variable.\r
118 @param maxDatumSize Member variable.\r
119 */\r
120 public UsageInstance (Token parentToken,\r
121 String moduleName,\r
122 UUID moduleGUID,\r
123 String packageName,\r
124 UUID packageGUID,\r
125 MODULE_TYPE moduleType,\r
126 Token.PCD_TYPE modulePcdType,\r
127 String arch,\r
128 String version,\r
129 String value,\r
130 int maxDatumSize) {\r
131 this.parentToken = parentToken;\r
132 this.moduleName = moduleName;\r
133 this.moduleGUID = moduleGUID;\r
134 this.packageName = packageName;\r
135 this.packageGUID = packageGUID;\r
136 this.moduleType = moduleType;\r
137 this.modulePcdType = modulePcdType;\r
138 this.arch = arch;\r
139 this.version = version;\r
140 this.datum = value;\r
141 this.maxDatumSize = maxDatumSize;\r
142 }\r
143\r
144 /**\r
145 Get the primary key for usage instance array for every token.\r
146 \r
147 @param moduleName the name of module\r
148 @param moduleGUID the GUID name of module\r
149 @param packageName the name of package who contains this module\r
150 @param packageGUID the GUID name of package\r
151 @param arch the archtecture string\r
152 @param version the version of this module\r
153 \r
154 @return String primary key\r
155 */\r
156 public static String getPrimaryKey(String moduleName, \r
157 UUID moduleGUID, \r
158 String packageName, \r
159 UUID packageGUID,\r
160 String arch,\r
161 String version) {\r
162 //\r
163 // Because currently transition schema not require write moduleGuid, package Name, Packge GUID in\r
164 // <ModuleSA> section, So currently no expect all paramter must be valid.\r
165 return(moduleName + "_" +\r
166 ((moduleGUID != null) ? moduleGUID.toString() : "NullModuleGuid") + "_" +\r
167 ((packageName != null) ? packageName : "NullPackageName") + "_" +\r
168 ((packageGUID != null) ? packageGUID.toString() : "NullPackageGuid") + "_" +\r
169 ((arch != null) ? arch : "NullArch") + "_" +\r
170 ((version != null) ? version : "NullVersion"));\r
171 }\r
172\r
173 /**\r
174 Get primary key string for this usage instance\r
175 \r
176 @return String primary key string\r
177 **/\r
178 public String getPrimaryKey() {\r
179 return UsageInstance.getPrimaryKey(moduleName, moduleGUID, packageName, packageGUID, arch, version);\r
180 }\r
181\r
182 /**\r
183 Judget whether current module is PEI driver\r
184 \r
185 @return boolean\r
186 */\r
187 public boolean isPeiPhaseComponent() {\r
188 if ((moduleType == MODULE_TYPE.PEI_CORE) ||\r
189 (moduleType == MODULE_TYPE.PEIM)) {\r
190 return true;\r
191 }\r
192 return false;\r
193 }\r
194\r
195 /**\r
196 Generate autogen string for header file and C code file.\r
197 \r
198 @throws EntityException Fail to generate.\r
199 \r
200 @param isBuildUsedLibrary whether the autogen is for library.\r
201 */\r
202 public void generateAutoGen(boolean isBuildUsedLibrary) \r
a49b34c0 203 throws EntityException {\r
11e7b0f6 204 String guidStringCName = null;\r
2435723a 205 boolean isByteArray = false;\r
1cf9cdcc 206 String printDatum = null;\r
38ee8d9e 207\r
208 hAutogenStr = "";\r
209 cAutogenStr = "";\r
210\r
211 if (this.modulePcdType == Token.PCD_TYPE.DYNAMIC_EX) {\r
38ee8d9e 212 hAutogenStr += String.format("#define _PCD_TOKEN_%s 0x%016x\r\n", \r
213 parentToken.cName, parentToken.dynamicExTokenNumber);\r
214 } else {\r
215 hAutogenStr += String.format("#define _PCD_TOKEN_%s 0x%016x\r\n", \r
216 parentToken.cName, parentToken.tokenNumber);\r
217 }\r
218\r
2435723a 219 if (!isBuildUsedLibrary && !parentToken.isDynamicPCD) {\r
220 if (datum.trim().charAt(0) == '{') {\r
221 isByteArray = true;\r
222 }\r
223 }\r
224\r
1cf9cdcc 225 if (parentToken.datumType == Token.DATUM_TYPE.UINT64) {\r
226 printDatum = this.datum + "ULL";\r
227 } else {\r
228 printDatum = this.datum;\r
229 }\r
230\r
38ee8d9e 231 switch (modulePcdType) {\r
232 case FEATURE_FLAG:\r
233 if (isBuildUsedLibrary) {\r
234 hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
235 parentToken.cName);\r
236 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",\r
237 parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
238 parentToken.cName,\r
239 parentToken.cName);\r
240 } else {\r
241 hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
242 parentToken.cName, \r
1cf9cdcc 243 printDatum);\r
38ee8d9e 244 hAutogenStr += String.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n", \r
245 parentToken.cName);\r
246 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
247 parentToken.cName,\r
248 parentToken.cName);\r
249 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",\r
250 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
251 parentToken.cName,\r
252 parentToken.cName);\r
253 }\r
254 break;\r
255 case FIXED_AT_BUILD:\r
256 if (isBuildUsedLibrary) {\r
257 hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
258 Token.getAutogendatumTypeString(parentToken.datumType),\r
259 parentToken.cName);\r
260 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",\r
261 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
262 parentToken.cName,\r
263 parentToken.cName);\r
264 } else {\r
265 hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
266 parentToken.cName, \r
1cf9cdcc 267 printDatum);\r
2435723a 268 if (isByteArray) {\r
269 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = _PCD_VALUE_%s;\r\n",\r
270 parentToken.cName,\r
271 parentToken.cName);\r
272 hAutogenStr += String.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",\r
273 parentToken.cName);\r
274 hAutogenStr += String.format("#define _PCD_MODE_%s_%s &_gPcd_FixedAtBuild_%s\r\n",\r
275 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
276 parentToken.cName,\r
277 parentToken.cName);\r
278 } else {\r
279 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",\r
280 Token.getAutogendatumTypeString(parentToken.datumType),\r
281 parentToken.cName,\r
282 parentToken.cName);\r
283 hAutogenStr += String.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",\r
284 Token.getAutogendatumTypeString(parentToken.datumType),\r
285 parentToken.cName);\r
286 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",\r
287 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
288 parentToken.cName,\r
289 parentToken.cName);\r
290 }\r
38ee8d9e 291 }\r
292 break;\r
293 case PATCHABLE_IN_MODULE:\r
294 if (isBuildUsedLibrary) {\r
295 hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",\r
296 Token.getAutogendatumTypeString(parentToken.datumType),\r
297 parentToken.cName);\r
298 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",\r
299 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
300 parentToken.cName,\r
301 parentToken.cName);\r
302 } else {\r
303 hAutogenStr += String.format("#define _PCD_VALUE_%s %s\r\n", \r
304 parentToken.cName, \r
1cf9cdcc 305 printDatum);\r
2435723a 306 if (isByteArray) {\r
307 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",\r
308 parentToken.cName,\r
309 parentToken.cName);\r
310 hAutogenStr += String.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",\r
311 parentToken.cName);\r
312 hAutogenStr += String.format("#define _PCD_MODE_%s_%s &_gPcd_BinaryPatch_%s\r\n",\r
313 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
314 parentToken.cName,\r
315 parentToken.cName); \r
316 } else {\r
317 cAutogenStr += String.format("GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",\r
318 Token.getAutogendatumTypeString(parentToken.datumType),\r
319 parentToken.cName,\r
320 parentToken.cName);\r
321 hAutogenStr += String.format("extern %s _gPcd_BinaryPatch_%s;\r\n",\r
322 Token.getAutogendatumTypeString(parentToken.datumType),\r
323 parentToken.cName);\r
324 hAutogenStr += String.format("#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",\r
325 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
326 parentToken.cName,\r
327 parentToken.cName); \r
328 }\r
38ee8d9e 329 }\r
330\r
331 break;\r
332 case DYNAMIC:\r
333 hAutogenStr += String.format("#define _PCD_MODE_%s_%s LibPcdGet%s(_PCD_TOKEN_%s)\r\n",\r
334 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
335 parentToken.cName,\r
336 Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
337 parentToken.cName);\r
338 break;\r
339 case DYNAMIC_EX:\r
11e7b0f6 340 guidStringCName = "_gPcd_TokenSpaceGuid_" +\r
341 parentToken.tokenSpaceName.toString().replaceAll("-", "_");\r
38ee8d9e 342 \r
a49b34c0 343 hAutogenStr += String.format("#define _PCD_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",\r
38ee8d9e 344 Token.GetAutogenDefinedatumTypeString(parentToken.datumType),\r
345 parentToken.cName,\r
346 Token.getAutogenLibrarydatumTypeString(parentToken.datumType),\r
a49b34c0 347 guidStringCName,\r
38ee8d9e 348 parentToken.cName);\r
349\r
38ee8d9e 350 break;\r
351 }\r
352 }\r
353\r
354 /**\r
355 Get the autogen string for header file.\r
356 \r
357 @return The string of header file.\r
358 **/\r
359 public String getHAutogenStr() {\r
360 return hAutogenStr;\r
361 }\r
878ddf1f 362\r
38ee8d9e 363 /**\r
364 Get the autogen string for C code file.\r
365 \r
366 @return The string of C Code file.\r
367 **/\r
368 public String getCAutogenStr() {\r
369 return cAutogenStr;\r
878ddf1f 370 }\r
878ddf1f 371}\r
372\r