]>
Commit | Line | Data |
---|---|---|
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 | |
21 | \r | |
22 | import org.tianocore.build.pcd.action.ActionMessage;\r | |
23 | \r | |
24 | /** This class is to descript a PCD token object. The information of a token mainly \r | |
25 | comes from MSA, SPD and setting produced by platform developer. \r | |
26 | **/\r | |
27 | public class Token {\r | |
28 | ///\r | |
29 | /// Enumeration macro defintion for PCD type.\r | |
30 | /// BUGBUG: Not use upcase charater is to facility for reading. It may be changed\r | |
31 | /// in coding review.\r | |
32 | public enum PCD_TYPE {FEATURE_FLAG, FIXED_AT_BUILD, PATCHABLE_IN_MODULE, DYNAMIC, \r | |
33 | DYNAMIC_EX, UNKNOWN}\r | |
34 | \r | |
35 | ///\r | |
36 | /// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.\r | |
37 | /// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in \r | |
38 | /// prompt dialog.\r | |
39 | ///\r | |
40 | public enum DATUM_TYPE {UINT8, UINT16, UINT32, UINT64, BOOLEAN, POINTER, UNKNOWN}\r | |
41 | \r | |
42 | ///\r | |
43 | /// Enumeration macor defintion for usage of PCD\r | |
44 | ///\r | |
45 | public enum PCD_USAGE {ALWAYS_PRODUCED, ALWAYS_CONSUMED, SOMETIMES_PRODUCED,\r | |
46 | SOMETIMES_CONSUMED, UNKNOWN}\r | |
47 | \r | |
48 | ///\r | |
49 | /// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.\r | |
50 | /// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.\r | |
51 | ///\r | |
52 | public String cName;\r | |
53 | \r | |
54 | ///\r | |
55 | /// Token space name is the guid defined by token itself in package or module level. This\r | |
56 | /// name mainly for DynamicEx type. For other PCD type token, his token space name is the \r | |
57 | /// assignedtokenSpaceName as follows.\r | |
58 | /// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.\r | |
59 | ///\r | |
60 | public UUID tokenSpaceName;\r | |
61 | \r | |
62 | ///\r | |
63 | /// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in\r | |
64 | /// platform token space.\r | |
65 | /// tokenNumber is defined in SPD, FPD.\r | |
66 | ///\r | |
67 | public int tokenNumber;\r | |
68 | \r | |
69 | ///\r | |
70 | /// The token space name assigned by platform. For Non-DynamicEx driver this value is same.\r | |
71 | /// assignedtokenSpaceName is defined in FPD.\r | |
72 | ///\r | |
73 | public UUID assignedtokenSpaceName;\r | |
74 | \r | |
75 | ///\r | |
76 | /// The token number assigned by platform. The number indiect the offset of this token in platform\r | |
77 | /// token space.\r | |
78 | /// AssgiendtokenNumber is defined in FPD.\r | |
79 | ///\r | |
80 | public int assignedtokenNumber;\r | |
81 | \r | |
82 | ///\r | |
83 | /// pcdType is the PCD item type defined by platform developer.\r | |
84 | ///\r | |
85 | public PCD_TYPE pcdType;\r | |
86 | \r | |
87 | ///\r | |
88 | /// PCDtype is set by platform developer. It is final PCD type of this token.\r | |
89 | /// SupportedPcdType is defined in SPD.\r | |
90 | ///\r | |
91 | public PCD_TYPE[] supportedpcdType;\r | |
92 | \r | |
93 | ///\r | |
94 | /// datumSize is to descript the fix size or max size for this token. \r | |
95 | /// datumSize is defined in SPD.\r | |
96 | ///\r | |
97 | public int datumSize;\r | |
98 | \r | |
99 | ///\r | |
100 | /// datum type is to descript what type can be expressed by a PCD token.\r | |
101 | /// datumType is defined in SPD.\r | |
102 | ///\r | |
103 | public DATUM_TYPE datumType;\r | |
104 | \r | |
105 | ///\r | |
106 | /// Isplatform is to descript whether this token is defined in platform level.\r | |
107 | /// If token is belong to platform level. The value can be different for every\r | |
108 | /// module. All are determined by platform developer.\r | |
109 | ///\r | |
110 | public boolean isPlatform;\r | |
111 | \r | |
112 | ///\r | |
113 | /// hiiEnabled is to indicate whether the token support Hii functionality.\r | |
114 | /// hiiEnabled is defined in FPD.\r | |
115 | ///\r | |
116 | public boolean hiiEnabled;\r | |
117 | \r | |
118 | ///\r | |
119 | /// variableName is valid only when this token support Hii functionality. variableName\r | |
120 | /// indicates the value of token is associated with what variable.\r | |
121 | /// variableName is defined in FPD.\r | |
122 | ///\r | |
123 | public String variableName;\r | |
124 | \r | |
125 | ///\r | |
126 | /// variableGuid is the GUID this token associated with.\r | |
127 | /// variableGuid is defined in FPD.\r | |
128 | ///\r | |
129 | public UUID variableGuid;\r | |
130 | \r | |
131 | ///\r | |
132 | /// Variable offset indicate the associated variable's offset in NV storage.\r | |
133 | /// variableOffset is defined in FPD.\r | |
134 | ///\r | |
135 | public int variableOffset;\r | |
136 | \r | |
137 | ///\r | |
138 | /// skuEnabled is to indicate whether the token support Sku functionality.\r | |
139 | /// skuEnabled is defined in FPD.\r | |
140 | ///\r | |
141 | public boolean skuEnabled;\r | |
142 | \r | |
143 | ///\r | |
144 | /// skuDataArrayEnabled is to indicate wheter use the skuData array or default value.\r | |
145 | ///\r | |
146 | public boolean skuDataArrayEnabled;\r | |
147 | \r | |
148 | ///\r | |
149 | /// skuData contains all value for SkuNumber of token.\r | |
150 | /// skuData is defined in FPD.\r | |
151 | ///\r | |
152 | public List<SkuInstance> skuData;\r | |
153 | \r | |
154 | ///\r | |
155 | /// maxSkuCount indicate the max count of sku data.\r | |
156 | /// maxSkuCount is defined in FPD.\r | |
157 | ///\r | |
158 | public int maxSkuCount;\r | |
159 | \r | |
160 | ///\r | |
161 | /// SkuId is the id of current selected SKU.\r | |
162 | /// SkuId is defined in FPD.\r | |
163 | ///\r | |
164 | public int skuId;\r | |
165 | \r | |
166 | ///\r | |
167 | /// datum is the value set by platform developer.\r | |
168 | /// datum is defined in FPD.\r | |
169 | ///\r | |
170 | public Object datum;\r | |
171 | \r | |
172 | ///\r | |
173 | /// Default value of this token.\r | |
174 | /// This default value is defined in SPD level.\r | |
175 | ///\r | |
176 | public Object defaultValue;\r | |
177 | \r | |
178 | ///\r | |
179 | /// BUGBUG: fix comment\r | |
180 | /// vpdEnabled is defined in FPD.\r | |
181 | ///\r | |
182 | public boolean vpdEnabled;\r | |
183 | \r | |
184 | ///\r | |
185 | /// BUGBUG: fix comment\r | |
186 | /// vpdOffset is defined in FPD.\r | |
187 | ///\r | |
188 | public long vpdOffset;\r | |
189 | \r | |
190 | ///\r | |
191 | /// producers array record all module private information who produce this PCD token.\r | |
192 | ///\r | |
193 | public List<UsageInstance> producers;\r | |
194 | \r | |
195 | ///\r | |
196 | /// consumers array record all module private information who consume this PCD token.\r | |
197 | ///\r | |
198 | public List<UsageInstance> consumers;\r | |
199 | \r | |
200 | /**\r | |
201 | Constructure function.\r | |
202 | \r | |
203 | Initialize the value of token.\r | |
204 | \r | |
205 | @param cName The cName of this token\r | |
206 | @param tokenSpaceName The tokenSpaceName of this token, it is a GUID.\r | |
207 | @param assignedtokenSpaceName The assignedtokenSpaceName of this token, it is a GUID.\r | |
208 | \r | |
209 | **/ \r | |
210 | public Token(String cName, UUID tokenSpaceName, UUID assignedtokenSpaceName) {\r | |
211 | UUID nullUUID = new UUID(0, 0);\r | |
212 | \r | |
213 | this.cName = cName;\r | |
214 | this.tokenSpaceName =(tokenSpaceName == null) ? nullUUID : tokenSpaceName;\r | |
215 | this.assignedtokenSpaceName =(assignedtokenSpaceName == null) ? nullUUID : assignedtokenSpaceName;\r | |
216 | this.tokenNumber = 0;\r | |
217 | this.assignedtokenNumber = 0;\r | |
218 | this.pcdType = PCD_TYPE.UNKNOWN;\r | |
219 | this.supportedpcdType = null;\r | |
220 | this.isPlatform = false;\r | |
221 | this.datumType = DATUM_TYPE.UNKNOWN;\r | |
222 | this.datumSize = -1;\r | |
223 | this.defaultValue = null;\r | |
224 | this.datum = null;\r | |
225 | this.hiiEnabled = false;\r | |
226 | this.variableGuid = null;\r | |
227 | this.variableName = "";\r | |
228 | this.variableOffset = -1;\r | |
229 | this.skuEnabled = false;\r | |
230 | this.skuDataArrayEnabled = false;\r | |
231 | this.skuId = -1;\r | |
232 | this.maxSkuCount = -1;\r | |
233 | this.skuData = new ArrayList<SkuInstance>();\r | |
234 | this.vpdEnabled = false;\r | |
235 | this.vpdOffset = -1;\r | |
236 | \r | |
237 | this.producers = new ArrayList<UsageInstance>();\r | |
238 | this.consumers = new ArrayList<UsageInstance>();\r | |
239 | }\r | |
240 | \r | |
241 | /**\r | |
242 | Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database\r | |
243 | \r | |
244 | @param cName Token name.\r | |
245 | @param tokenSpaceName The token space guid defined in MSA or SPD\r | |
246 | @param platformtokenSpaceName The token space guid for current platform token space,\r | |
247 | \r | |
248 | @return primary key for this token in token database.\r | |
249 | **/\r | |
250 | public static String getPrimaryKeyString(String cName, UUID tokenSpaceName, \r | |
251 | UUID platformtokenSpaceName) {\r | |
252 | UUID nullUUID = new UUID(0, 0);\r | |
253 | \r | |
254 | if (platformtokenSpaceName == nullUUID) {\r | |
255 | return cName + "_" + tokenSpaceName.toString().replace('-', '_');\r | |
256 | } else {\r | |
257 | return cName + "_" + platformtokenSpaceName.toString().replace('-', '_');\r | |
258 | }\r | |
259 | }\r | |
260 | \r | |
261 | public String getPrimaryKeyString () {\r | |
262 | return cName + "_" + tokenSpaceName.toString().replace('-', '_');\r | |
263 | }\r | |
264 | \r | |
265 | /**\r | |
266 | Judge datumType is valid\r | |
267 | \r | |
268 | @param type The datumType want to be judged.\r | |
269 | \r | |
270 | @retval TRUE - The type is valid.\r | |
271 | @retval FALSE - The type is invalid.\r | |
272 | **/\r | |
273 | public static boolean isValiddatumType(DATUM_TYPE type) {\r | |
274 | if ((type.ordinal() < DATUM_TYPE.UINT8.ordinal() ) || \r | |
275 | (type.ordinal() > DATUM_TYPE.POINTER.ordinal())) {\r | |
276 | return false;\r | |
277 | }\r | |
278 | return true;\r | |
279 | }\r | |
280 | \r | |
281 | /**\r | |
282 | Judge pcdType is valid\r | |
283 | \r | |
284 | @param type The PCdType want to be judged.\r | |
285 | \r | |
286 | @retval TRUE - The type is valid.\r | |
287 | @retval FALSE - The type is invalid.\r | |
288 | **/\r | |
289 | public static boolean isValidpcdType(PCD_TYPE type) {\r | |
290 | if ((type.ordinal() < PCD_TYPE.FEATURE_FLAG.ordinal() ) || \r | |
291 | (type.ordinal() > PCD_TYPE.DYNAMIC_EX.ordinal())) {\r | |
292 | return false;\r | |
293 | }\r | |
294 | return true;\r | |
295 | }\r | |
296 | \r | |
297 | /**\r | |
298 | Add an usage instance for token\r | |
299 | \r | |
300 | @param usageInstance The usage instance\r | |
301 | \r | |
302 | @retval TRUE - Success to add usage instance.\r | |
303 | @retval FALSE - Fail to add usage instance\r | |
304 | **/\r | |
305 | public boolean addUsageInstance(UsageInstance usageInstance) {\r | |
306 | if (usageInstance.usage == PCD_USAGE.UNKNOWN) {\r | |
307 | return false;\r | |
308 | }\r | |
309 | \r | |
310 | if ((usageInstance.usage == PCD_USAGE.ALWAYS_PRODUCED) ||\r | |
311 | (usageInstance.usage == PCD_USAGE.SOMETIMES_PRODUCED)) {\r | |
312 | producers.add(usageInstance);\r | |
313 | } else {\r | |
314 | consumers.add(usageInstance);\r | |
315 | }\r | |
316 | return true;\r | |
317 | }\r | |
318 | \r | |
319 | /**\r | |
320 | Judge whether exist an usage instance for this token\r | |
321 | \r | |
322 | @param moduleName Use xmlFilePath as keyword to search the usage instance\r | |
323 | \r | |
324 | @retval PCD_USAGE - if UsageInstance exists.\r | |
325 | @retval UNKNOWN - if UsageInstance does not exist, return UNKONW.\r | |
326 | **/\r | |
327 | public PCD_USAGE isUsageInstanceExist(String moduleName) {\r | |
328 | int index;\r | |
329 | UsageInstance usageInstance;\r | |
330 | \r | |
331 | if (moduleName == null) {\r | |
332 | ActionMessage.warning(this, "Error parameter for isUsageInstanceExist() function!");\r | |
333 | return PCD_USAGE.UNKNOWN;\r | |
334 | }\r | |
335 | \r | |
336 | if (moduleName.length() == 0) {\r | |
337 | return PCD_USAGE.UNKNOWN;\r | |
338 | }\r | |
339 | \r | |
340 | //\r | |
341 | // Searching the usage instance in module's producer and consumer according to \r | |
342 | // module's name.\r | |
343 | //\r | |
344 | for (index = 0; index < producers.size(); index ++) {\r | |
345 | usageInstance =(UsageInstance)producers.get(index);\r | |
346 | if (usageInstance.moduleName.equalsIgnoreCase(moduleName)) {\r | |
347 | return usageInstance.usage;\r | |
348 | }\r | |
349 | }\r | |
350 | \r | |
351 | for (index = 0; index < consumers.size(); index ++) {\r | |
352 | usageInstance =(UsageInstance)consumers.get(index);\r | |
353 | if (usageInstance.moduleName.equalsIgnoreCase(moduleName)) {\r | |
354 | return usageInstance.usage;\r | |
355 | }\r | |
356 | }\r | |
357 | return PCD_USAGE.UNKNOWN;\r | |
358 | }\r | |
359 | \r | |
360 | /**\r | |
361 | Get usage instance according to a MSA file name\r | |
362 | \r | |
363 | @param moduleName The file path string of MSA file.\r | |
364 | \r | |
365 | @return usage instance object.\r | |
366 | **/\r | |
367 | public UsageInstance getUsageInstance(String moduleName) {\r | |
368 | int usageIndex;\r | |
369 | UsageInstance usageInstance;\r | |
370 | \r | |
371 | if (moduleName == null) {\r | |
372 | ActionMessage.warning(this, "Error parameter for isUsageInstanceExist() function!");\r | |
373 | return null;\r | |
374 | }\r | |
375 | \r | |
376 | if (moduleName.length() == 0) {\r | |
377 | return null;\r | |
378 | }\r | |
379 | \r | |
380 | if (producers.size() != 0) {\r | |
381 | for (usageIndex = 0; usageIndex < producers.size(); usageIndex ++) {\r | |
382 | usageInstance =(UsageInstance)producers.get(usageIndex);\r | |
383 | if (usageInstance.moduleName.equalsIgnoreCase(moduleName)) {\r | |
384 | return usageInstance;\r | |
385 | }\r | |
386 | }\r | |
387 | }\r | |
388 | \r | |
389 | if (consumers.size() != 0) {\r | |
390 | for (usageIndex = 0; usageIndex < consumers.size(); usageIndex ++) {\r | |
391 | usageInstance =(UsageInstance)consumers.get(usageIndex);\r | |
392 | if (usageInstance.moduleName.equalsIgnoreCase(moduleName)) {\r | |
393 | return usageInstance;\r | |
394 | }\r | |
395 | }\r | |
396 | }\r | |
397 | return null;\r | |
398 | }\r | |
399 | \r | |
400 | /**\r | |
401 | Get the PCD_TYPE according to the string of PCD_TYPE\r | |
402 | \r | |
403 | @param pcdTypeStr The string of PCD_TYPE\r | |
404 | \r | |
405 | @return PCD_TYPE\r | |
406 | **/\r | |
407 | public static PCD_TYPE getpcdTypeFromString(String pcdTypeStr) {\r | |
408 | if (pcdTypeStr == null) {\r | |
409 | return PCD_TYPE.UNKNOWN;\r | |
410 | }\r | |
411 | \r | |
412 | if (pcdTypeStr.equalsIgnoreCase("FEATURE_FLAG")) {\r | |
413 | return PCD_TYPE.FEATURE_FLAG;\r | |
414 | } else if (pcdTypeStr.equalsIgnoreCase("FIXED_AT_BUILD")) {\r | |
415 | return PCD_TYPE.FIXED_AT_BUILD;\r | |
416 | } else if (pcdTypeStr.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {\r | |
417 | return PCD_TYPE.PATCHABLE_IN_MODULE;\r | |
418 | } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC")) {\r | |
419 | return PCD_TYPE.DYNAMIC;\r | |
420 | } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC_EX")) {\r | |
421 | return PCD_TYPE.DYNAMIC_EX;\r | |
422 | } else {\r | |
423 | return PCD_TYPE.UNKNOWN;\r | |
424 | }\r | |
425 | }\r | |
426 | \r | |
427 | /**\r | |
428 | Get the string of given datumType. This string will be used for generating autogen files\r | |
429 | \r | |
430 | @param datumType Given datumType\r | |
431 | \r | |
432 | @return The string of datum type.\r | |
433 | **/\r | |
434 | public static String getStringOfdatumType(DATUM_TYPE datumType) {\r | |
435 | switch (datumType) {\r | |
436 | case UINT8:\r | |
437 | return "UINT8";\r | |
438 | case UINT16:\r | |
439 | return "UINT16";\r | |
440 | case UINT32:\r | |
441 | return "UINT32";\r | |
442 | case UINT64:\r | |
443 | return "UINT64";\r | |
444 | case POINTER:\r | |
445 | return "POINTER";\r | |
446 | case BOOLEAN:\r | |
447 | return "BOOLEAN";\r | |
448 | }\r | |
449 | return "UNKNOWN";\r | |
450 | }\r | |
451 | \r | |
452 | /**\r | |
453 | Get the datumType according to a string.\r | |
454 | \r | |
455 | @param datumTypeStr The string of datumType\r | |
456 | \r | |
457 | @return DATUM_TYPE\r | |
458 | **/\r | |
459 | public static DATUM_TYPE getdatumTypeFromString(String datumTypeStr) {\r | |
460 | if (datumTypeStr.equalsIgnoreCase("UINT8")) {\r | |
461 | return DATUM_TYPE.UINT8;\r | |
462 | } else if (datumTypeStr.equalsIgnoreCase("UINT16")) {\r | |
463 | return DATUM_TYPE.UINT16;\r | |
464 | } else if (datumTypeStr.equalsIgnoreCase("UINT32")) {\r | |
465 | return DATUM_TYPE.UINT32;\r | |
466 | } else if (datumTypeStr.equalsIgnoreCase("UINT64")) {\r | |
467 | return DATUM_TYPE.UINT64;\r | |
468 | } else if (datumTypeStr.equalsIgnoreCase("VOID*")) {\r | |
469 | return DATUM_TYPE.POINTER;\r | |
470 | } else if (datumTypeStr.equalsIgnoreCase("BOOLEAN")) {\r | |
471 | return DATUM_TYPE.BOOLEAN;\r | |
472 | }\r | |
473 | return DATUM_TYPE.UNKNOWN;\r | |
474 | }\r | |
475 | \r | |
476 | /**\r | |
477 | Get string of given pcdType\r | |
478 | \r | |
479 | @param pcdType The given PcdType\r | |
480 | \r | |
481 | @return The string of PCD_TYPE.\r | |
482 | **/\r | |
483 | public static String getStringOfpcdType(PCD_TYPE pcdType) {\r | |
484 | switch (pcdType) {\r | |
485 | case FEATURE_FLAG:\r | |
486 | return "FEATURE_FLAG";\r | |
487 | case FIXED_AT_BUILD:\r | |
488 | return "FIXED_AT_BUILD";\r | |
489 | case PATCHABLE_IN_MODULE:\r | |
490 | return "PATCHABLE_IN_MODULE";\r | |
491 | case DYNAMIC:\r | |
492 | return "DYNAMIC";\r | |
493 | case DYNAMIC_EX:\r | |
494 | return "DYNAMIC_EX";\r | |
495 | }\r | |
496 | return "UNKNOWN";\r | |
497 | }\r | |
498 | \r | |
499 | /**\r | |
500 | Get the PCD_USAGE according to a string\r | |
501 | \r | |
502 | @param usageStr The string of PCD_USAGE\r | |
503 | \r | |
504 | @return The PCD_USAGE\r | |
505 | **/\r | |
506 | public static PCD_USAGE getUsageFromString(String usageStr) {\r | |
507 | if (usageStr == null) {\r | |
508 | return PCD_USAGE.UNKNOWN;\r | |
509 | }\r | |
510 | \r | |
511 | if (usageStr.equalsIgnoreCase("ALWAYS_PRODUCED")) {\r | |
512 | return PCD_USAGE.ALWAYS_PRODUCED;\r | |
513 | } else if (usageStr.equalsIgnoreCase("SOMETIMES_PRODUCED")) {\r | |
514 | return PCD_USAGE.SOMETIMES_PRODUCED;\r | |
515 | } else if (usageStr.equalsIgnoreCase("ALWAYS_CONSUMED")) {\r | |
516 | return PCD_USAGE.ALWAYS_CONSUMED;\r | |
517 | } else if (usageStr.equalsIgnoreCase("SOMETIMES_CONSUMED")) {\r | |
518 | return PCD_USAGE.SOMETIMES_CONSUMED;\r | |
519 | }\r | |
520 | \r | |
521 | return PCD_USAGE.UNKNOWN;\r | |
522 | }\r | |
523 | \r | |
524 | /**\r | |
525 | Get the string of given PCD_USAGE\r | |
526 | \r | |
527 | @param usage The given PCD_USAGE\r | |
528 | \r | |
529 | @return The string of PDC_USAGE.\r | |
530 | **/\r | |
531 | public static String getStringOfUsage(PCD_USAGE usage) {\r | |
532 | switch (usage) {\r | |
533 | case ALWAYS_PRODUCED:\r | |
534 | return "ALWAYS_PRODUCED";\r | |
535 | case ALWAYS_CONSUMED:\r | |
536 | return "ALWAYS_CONSUMED";\r | |
537 | case SOMETIMES_PRODUCED:\r | |
538 | return "SOMETIMES_PRODUCED";\r | |
539 | case SOMETIMES_CONSUMED:\r | |
540 | return "SOMETIMES_CONSUMED";\r | |
541 | }\r | |
542 | return "UNKNOWN";\r | |
543 | }\r | |
544 | \r | |
545 | /**\r | |
546 | Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h\r | |
547 | \r | |
548 | @param datumType The given datumType\r | |
549 | \r | |
550 | @return string of datum type for autogen.\r | |
551 | **/\r | |
552 | public static String GetAutogenDefinedatumTypeString(DATUM_TYPE datumType) {\r | |
553 | switch (datumType) {\r | |
554 | \r | |
555 | case UINT8:\r | |
556 | return "8";\r | |
557 | case UINT16:\r | |
558 | return "16";\r | |
559 | case BOOLEAN:\r | |
560 | return "BOOL";\r | |
561 | case POINTER:\r | |
562 | return "PTR";\r | |
563 | case UINT32:\r | |
564 | return "32";\r | |
565 | case UINT64:\r | |
566 | return "64";\r | |
567 | default:\r | |
568 | return null;\r | |
569 | }\r | |
570 | }\r | |
571 | \r | |
572 | /**\r | |
573 | Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen\r | |
574 | \r | |
575 | @param datumType The given datumType\r | |
576 | \r | |
577 | @return string of datum type.\r | |
578 | **/\r | |
579 | public static String getAutogendatumTypeString(DATUM_TYPE datumType) {\r | |
580 | switch (datumType) {\r | |
581 | case UINT8:\r | |
582 | return "UINT8";\r | |
583 | case UINT16:\r | |
584 | return "UINT16";\r | |
585 | case UINT32:\r | |
586 | return "UINT32";\r | |
587 | case UINT64:\r | |
588 | return "UINT64";\r | |
589 | case POINTER:\r | |
590 | return "VOID*";\r | |
591 | case BOOLEAN:\r | |
592 | return "BOOLEAN";\r | |
593 | }\r | |
594 | return null;\r | |
595 | }\r | |
596 | \r | |
597 | /**\r | |
598 | Get the datumType string for generating some MACROs in autogen file of Library\r | |
599 | \r | |
600 | @param datumType The given datumType\r | |
601 | \r | |
602 | @return String of datum for genrating bit charater.\r | |
603 | **/\r | |
604 | public static String getAutogenLibrarydatumTypeString(DATUM_TYPE datumType) {\r | |
605 | switch (datumType) {\r | |
606 | case UINT8:\r | |
607 | return "8";\r | |
608 | case UINT16:\r | |
609 | return "16";\r | |
610 | case BOOLEAN:\r | |
611 | return "Bool";\r | |
612 | case POINTER:\r | |
613 | return "Ptr";\r | |
614 | case UINT32:\r | |
615 | return "32";\r | |
616 | case UINT64:\r | |
617 | return "64";\r | |
618 | default:\r | |
619 | return null;\r | |
620 | }\r | |
621 | }\r | |
622 | \r | |
623 | /**\r | |
624 | UUID defined in Schems is object, this function is to tranlate this object \r | |
625 | to UUID data.\r | |
626 | \r | |
627 | @param uuidObj The object comes from schema.\r | |
628 | \r | |
629 | @return The traslated UUID instance.\r | |
630 | **/\r | |
631 | public static UUID getGUIDFromSchemaObject(Object uuidObj) {\r | |
632 | UUID uuid;\r | |
633 | if (uuidObj.toString().equalsIgnoreCase("0")) {\r | |
634 | uuid = new UUID(0,0);\r | |
635 | } else {\r | |
636 | uuid = UUID.fromString(uuidObj.toString());\r | |
637 | }\r | |
638 | \r | |
639 | return uuid;\r | |
640 | }\r | |
641 | \r | |
642 | //\r | |
643 | // BugBug: We need change this algorithm accordingly when schema is updated\r | |
644 | // to support no default value.\r | |
645 | //\r | |
646 | public boolean hasDefaultValue () {\r | |
647 | \r | |
648 | if (hiiEnabled) {\r | |
649 | return true;\r | |
650 | }\r | |
651 | \r | |
652 | if (vpdEnabled) {\r | |
653 | return true;\r | |
654 | }\r | |
655 | \r | |
656 | if (datum.toString().compareTo("NoDefault") == 0) {\r | |
657 | return false;\r | |
658 | }\r | |
659 | \r | |
660 | return true;\r | |
661 | }\r | |
662 | \r | |
663 | public boolean isStringType () {\r | |
664 | String str = datum.toString();\r | |
665 | \r | |
666 | if (datumType == Token.DATUM_TYPE.POINTER &&\r | |
667 | str.startsWith("L\"") && \r | |
668 | str.endsWith("\"")) {\r | |
669 | return true;\r | |
670 | }\r | |
671 | \r | |
672 | return false;\r | |
673 | }\r | |
674 | \r | |
675 | public String getStringTypeString () { \r | |
676 | return datum.toString().substring(2, datum.toString().length() - 1);\r | |
677 | }\r | |
678 | }\r | |
679 | \r | |
680 | \r | |
681 | \r | |
682 | \r |