]> git.proxmox.com Git - mirror_edk2.git/blame - Tools/Source/GenBuild/org/tianocore/build/pcd/entity/Token.java
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
1, Fix EDKT141
[mirror_edk2.git] / Tools / Source / GenBuild / org / tianocore / build / pcd / entity / Token.java
CommitLineData
878ddf1f 1/** @file\r
2 Token class.\r
3\r
4 This module contains all classes releted to PCD token.\r
5 \r
6Copyright (c) 2006, Intel Corporation\r
7All rights reserved. This program and the accompanying materials\r
8are licensed and made available under the terms and conditions of the BSD License\r
9which accompanies this distribution. The full text of the license may be found at\r
10http://opensource.org/licenses/bsd-license.php\r
11 \r
12THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14\r
15**/ \r
16package org.tianocore.build.pcd.entity;\r
17\r
6f7e61a0 18import java.math.BigInteger;\r
878ddf1f 19import java.util.ArrayList;\r
6f7e61a0 20import java.util.HashMap;\r
878ddf1f 21import java.util.List;\r
8840ad58 22import java.util.Map;\r
6f7e61a0 23import java.util.UUID;\r
878ddf1f 24\r
eece174a 25import org.tianocore.build.id.ModuleIdentification;\r
8840ad58 26import org.tianocore.build.pcd.exception.EntityException;\r
878ddf1f 27\r
28/** This class is to descript a PCD token object. The information of a token mainly \r
29 comes from MSA, SPD and setting produced by platform developer. \r
30**/\r
31public class Token {\r
32 ///\r
33 /// Enumeration macro defintion for PCD type.\r
34 /// BUGBUG: Not use upcase charater is to facility for reading. It may be changed\r
35 /// in coding review.\r
36 public enum PCD_TYPE {FEATURE_FLAG, FIXED_AT_BUILD, PATCHABLE_IN_MODULE, DYNAMIC, \r
37 DYNAMIC_EX, UNKNOWN}\r
38\r
39 ///\r
40 /// Enumeration macro definition for datum type. All type mainly comes from ProcessBind.h.\r
41 /// Wizard maybe expand this type as "int, unsigned int, short, unsigned short etc" in \r
42 /// prompt dialog.\r
43 ///\r
44 public enum DATUM_TYPE {UINT8, UINT16, UINT32, UINT64, BOOLEAN, POINTER, UNKNOWN}\r
45\r
46 ///\r
47 /// Enumeration macor defintion for usage of PCD\r
48 ///\r
49 public enum PCD_USAGE {ALWAYS_PRODUCED, ALWAYS_CONSUMED, SOMETIMES_PRODUCED,\r
50 SOMETIMES_CONSUMED, UNKNOWN}\r
51\r
52 ///\r
53 /// cName is to identify a PCD entry and will be used for generating autogen.h/autogen.c.\r
54 /// cName will be defined in MSA, SPD and FPD, can be regarded as primary key with token space guid.\r
55 ///\r
56 public String cName;\r
57\r
58 ///\r
59 /// Token space name is the guid defined by token itself in package or module level. This\r
60 /// name mainly for DynamicEx type. For other PCD type token, his token space name is the \r
61 /// assignedtokenSpaceName as follows.\r
62 /// tokenSpaceName is defined in MSA, SPD, FPD, can be regarded as primary key with cName.\r
63 ///\r
eece174a 64 public String tokenSpaceName;\r
878ddf1f 65\r
66 ///\r
67 /// tokenNumber is allocated by platform. tokenNumber indicate an index for this token in\r
38ee8d9e 68 /// platform token space. For Dynamic, dynamicEx type, this number will be re-adjust by\r
69 /// PCD run-time database autogen tools.\r
878ddf1f 70 ///\r
eece174a 71 public long tokenNumber;\r
878ddf1f 72\r
38ee8d9e 73 ///\r
74 /// This token number is retrieved from FPD file for DynamicEx type. \r
75 /// \r
eece174a 76 public long dynamicExTokenNumber;\r
38ee8d9e 77\r
878ddf1f 78 ///\r
6ff7a41c 79 /// All supported PCD type, this value can be retrieved from SPD\r
80 /// Currently, only record all PCD type for this token in FPD file.\r
81 /// \r
82 public List<PCD_TYPE> supportedPcdType;\r
83\r
878ddf1f 84 ///\r
6ff7a41c 85 /// If the token's item type is Dynamic or DynamicEx type, isDynamicPCD\r
86 /// is true.\r
87 /// \r
88 public boolean isDynamicPCD;\r
878ddf1f 89\r
878ddf1f 90 ///\r
91 /// datumSize is to descript the fix size or max size for this token. \r
92 /// datumSize is defined in SPD.\r
93 ///\r
94 public int datumSize;\r
95\r
96 ///\r
97 /// datum type is to descript what type can be expressed by a PCD token.\r
6ff7a41c 98 /// For same PCD used in different module, the datum type should be unique.\r
99 /// So it belong memeber to Token class.\r
878ddf1f 100 ///\r
101 public DATUM_TYPE datumType;\r
102\r
878ddf1f 103 ///\r
104 /// skuData contains all value for SkuNumber of token.\r
6ff7a41c 105 /// This field is for Dynamic or DynamicEx type PCD, \r
878ddf1f 106 ///\r
107 public List<SkuInstance> skuData;\r
108\r
878ddf1f 109 ///\r
110 /// consumers array record all module private information who consume this PCD token.\r
111 ///\r
8840ad58 112 public Map<String, UsageInstance> consumers;\r
878ddf1f 113\r
eece174a 114 /**\r
115 Constructure function for Token class\r
116 \r
117 @param cName The name of token\r
118 @param tokenSpaceName The name of token space, it is a guid string\r
119 **/\r
120 public Token(String cName, String tokenSpaceName) {\r
878ddf1f 121 UUID nullUUID = new UUID(0, 0);\r
122\r
123 this.cName = cName;\r
eece174a 124 this.tokenSpaceName = tokenSpaceName;\r
878ddf1f 125 this.tokenNumber = 0;\r
878ddf1f 126 this.datumType = DATUM_TYPE.UNKNOWN;\r
127 this.datumSize = -1;\r
878ddf1f 128 this.skuData = new ArrayList<SkuInstance>();\r
878ddf1f 129\r
8840ad58 130 this.consumers = new HashMap<String, UsageInstance>();\r
6ff7a41c 131 this.supportedPcdType = new ArrayList<PCD_TYPE>();\r
132 }\r
133\r
134 /**\r
135 updateSupportPcdType\r
136 \r
137 SupportPcdType should be gotten from SPD file actually, but now it just\r
138 record all PCD type for this token in FPD file.\r
139 \r
140 @param pcdType new PCD type found in FPD file for this token.\r
141 **/\r
142 public void updateSupportPcdType(PCD_TYPE pcdType) {\r
eece174a 143 for (int index = 0; index < this.supportedPcdType.size(); index ++) {\r
144 if (supportedPcdType.get(index) == pcdType) {\r
145 return;\r
6ff7a41c 146 }\r
147 }\r
eece174a 148\r
149 //\r
150 // If not found, add the pcd type to member variable supportedPcdType\r
151 // \r
152 supportedPcdType.add(pcdType);\r
6ff7a41c 153 }\r
154\r
155 /**\r
156 Judge whether pcdType is belong to dynamic type. Dynamic type includes\r
157 DYNAMIC and DYNAMIC_EX.\r
158 \r
eece174a 159 @param pcdType the judged pcd type\r
6ff7a41c 160 \r
161 @return boolean\r
162 */\r
163 public static boolean isDynamic(PCD_TYPE pcdType) {\r
164 if ((pcdType == PCD_TYPE.DYNAMIC ) ||\r
165 (pcdType == PCD_TYPE.DYNAMIC_EX)) {\r
166 return true;\r
167 }\r
168\r
169 return false;\r
878ddf1f 170 }\r
171\r
58f1099f 172 public boolean isDynamicEx() {\r
58f1099f 173 for (int i = 0; i < supportedPcdType.size(); i++) {\r
174 if (supportedPcdType.get(i) == PCD_TYPE.DYNAMIC_EX) {\r
175 return true;\r
176 }\r
177 }\r
178 \r
179 return false;\r
180 }\r
181\r
878ddf1f 182 /**\r
183 Use "TokencName + "-" + SpaceTokenName" as primary key when adding token into database\r
184 \r
185 @param cName Token name.\r
eece174a 186 @param tokenSpaceName The token space guid string defined in MSA or SPD\r
878ddf1f 187 \r
eece174a 188 @retval primary key for this token in token database.\r
878ddf1f 189 **/\r
eece174a 190 public static String getPrimaryKeyString(String cName, String tokenSpaceName) {\r
8840ad58 191 if (tokenSpaceName == null) {\r
eece174a 192 return cName + "_nullTokenSpaceGuid";\r
878ddf1f 193 } else {\r
8840ad58 194 return cName + "_" + tokenSpaceName.toString().replace('-', '_');\r
878ddf1f 195 }\r
196 }\r
197\r
6ff7a41c 198 /**\r
199 If skudata list contains more than one data, then Sku mechanism is enable.\r
200 \r
eece174a 201 @retval boolean if the number of sku data exceed to 1\r
6ff7a41c 202 */\r
203 public boolean isSkuEnable() {\r
204 if (this.skuData.size() > 1) {\r
205 return true;\r
206 }\r
207 return false;\r
208 }\r
eece174a 209\r
210 /**\r
211 If Hii type for value of token\r
212 \r
213 @return boolean\r
214 **/\r
58f1099f 215 public boolean isHiiEnable() {\r
216 if (getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.HII_TYPE) {\r
217 return true;\r
218 }\r
219 return false;\r
220 }\r
221\r
eece174a 222 /**\r
223 If Vpd type for value of token\r
224 \r
225 @return boolean\r
226 **/\r
58f1099f 227 public boolean isVpdEnable() {\r
228 if (getDefaultSku().type == DynamicTokenValue.VALUE_TYPE.VPD_TYPE) {\r
229 return true;\r
230 }\r
231 return false;\r
232 }\r
6ff7a41c 233\r
8840ad58 234 /**\r
235 Get the token primary key in token database.\r
236 \r
237 @return String\r
238 */\r
32648c62 239 public String getPrimaryKeyString () {\r
8840ad58 240 return Token.getPrimaryKeyString(cName, tokenSpaceName);\r
32648c62 241 }\r
99d2c3c4 242\r
878ddf1f 243 /**\r
244 Judge datumType is valid\r
245 \r
246 @param type The datumType want to be judged.\r
247 \r
248 @retval TRUE - The type is valid.\r
249 @retval FALSE - The type is invalid.\r
250 **/\r
251 public static boolean isValiddatumType(DATUM_TYPE type) {\r
252 if ((type.ordinal() < DATUM_TYPE.UINT8.ordinal() ) || \r
253 (type.ordinal() > DATUM_TYPE.POINTER.ordinal())) {\r
254 return false;\r
255 }\r
256 return true;\r
257 }\r
258\r
259 /**\r
260 Judge pcdType is valid\r
261 \r
262 @param type The PCdType want to be judged.\r
263 \r
264 @retval TRUE - The type is valid.\r
265 @retval FALSE - The type is invalid.\r
266 **/\r
267 public static boolean isValidpcdType(PCD_TYPE type) {\r
268 if ((type.ordinal() < PCD_TYPE.FEATURE_FLAG.ordinal() ) || \r
269 (type.ordinal() > PCD_TYPE.DYNAMIC_EX.ordinal())) {\r
270 return false;\r
271 }\r
272 return true;\r
273 }\r
274\r
275 /**\r
276 Add an usage instance for token\r
277 \r
278 @param usageInstance The usage instance\r
279 \r
280 @retval TRUE - Success to add usage instance.\r
281 @retval FALSE - Fail to add usage instance\r
282 **/\r
eece174a 283 public boolean addUsageInstance(UsageInstance usageInstance) throws EntityException {\r
8840ad58 284 String exceptionStr;\r
285\r
eece174a 286 if (isUsageInstanceExist(usageInstance.moduleId, usageInstance.arch)) {\r
287 exceptionStr = String.format("[PCD Collection Tool Exception] PCD %s for module %s has already exist in database, Please check all PCD build entries "+\r
288 "in modules %s in <ModuleSA> to make sure no duplicated definitions in FPD file!",\r
8840ad58 289 usageInstance.parentToken.cName,\r
eece174a 290 usageInstance.moduleId.getName(),\r
291 usageInstance.moduleId.getName());\r
8840ad58 292 throw new EntityException(exceptionStr);\r
878ddf1f 293 }\r
294\r
eece174a 295 //\r
296 // Put usage instance into usage instance database of this PCD token.\r
297 // \r
8840ad58 298 consumers.put(usageInstance.getPrimaryKey(), usageInstance);\r
eece174a 299\r
878ddf1f 300 return true;\r
301 }\r
302\r
303 /**\r
8840ad58 304 Judge whether exist an usage instance for this token\r
305 \r
eece174a 306 @param moduleId The module identification for usage instance\r
8840ad58 307 @param arch the architecture string\r
8840ad58 308 \r
309 @return boolean whether exist an usage instance for this token.\r
310 */\r
eece174a 311 public boolean isUsageInstanceExist(ModuleIdentification moduleId,\r
312 String arch) {\r
313 String keyStr = UsageInstance.getPrimaryKey(moduleId, arch);\r
314\r
8840ad58 315 return (consumers.get(keyStr) != null);\r
878ddf1f 316 }\r
317\r
318 /**\r
319 Get the PCD_TYPE according to the string of PCD_TYPE\r
320 \r
321 @param pcdTypeStr The string of PCD_TYPE\r
322 \r
323 @return PCD_TYPE\r
324 **/\r
325 public static PCD_TYPE getpcdTypeFromString(String pcdTypeStr) {\r
326 if (pcdTypeStr == null) {\r
327 return PCD_TYPE.UNKNOWN;\r
328 }\r
329\r
330 if (pcdTypeStr.equalsIgnoreCase("FEATURE_FLAG")) {\r
331 return PCD_TYPE.FEATURE_FLAG;\r
332 } else if (pcdTypeStr.equalsIgnoreCase("FIXED_AT_BUILD")) {\r
333 return PCD_TYPE.FIXED_AT_BUILD;\r
334 } else if (pcdTypeStr.equalsIgnoreCase("PATCHABLE_IN_MODULE")) {\r
335 return PCD_TYPE.PATCHABLE_IN_MODULE;\r
336 } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC")) {\r
337 return PCD_TYPE.DYNAMIC;\r
338 } else if (pcdTypeStr.equalsIgnoreCase("DYNAMIC_EX")) {\r
339 return PCD_TYPE.DYNAMIC_EX;\r
340 } else {\r
341 return PCD_TYPE.UNKNOWN;\r
342 }\r
343 }\r
344\r
345 /**\r
346 Get the string of given datumType. This string will be used for generating autogen files\r
347 \r
348 @param datumType Given datumType\r
349 \r
350 @return The string of datum type.\r
351 **/\r
352 public static String getStringOfdatumType(DATUM_TYPE datumType) {\r
353 switch (datumType) {\r
354 case UINT8:\r
355 return "UINT8";\r
356 case UINT16:\r
357 return "UINT16";\r
358 case UINT32:\r
359 return "UINT32";\r
360 case UINT64:\r
361 return "UINT64";\r
362 case POINTER:\r
363 return "POINTER";\r
364 case BOOLEAN:\r
365 return "BOOLEAN";\r
366 }\r
367 return "UNKNOWN";\r
368 }\r
369\r
370 /**\r
371 Get the datumType according to a string.\r
372 \r
373 @param datumTypeStr The string of datumType\r
374 \r
375 @return DATUM_TYPE\r
376 **/\r
377 public static DATUM_TYPE getdatumTypeFromString(String datumTypeStr) {\r
378 if (datumTypeStr.equalsIgnoreCase("UINT8")) {\r
379 return DATUM_TYPE.UINT8;\r
380 } else if (datumTypeStr.equalsIgnoreCase("UINT16")) {\r
381 return DATUM_TYPE.UINT16;\r
382 } else if (datumTypeStr.equalsIgnoreCase("UINT32")) {\r
383 return DATUM_TYPE.UINT32;\r
384 } else if (datumTypeStr.equalsIgnoreCase("UINT64")) {\r
385 return DATUM_TYPE.UINT64;\r
386 } else if (datumTypeStr.equalsIgnoreCase("VOID*")) {\r
387 return DATUM_TYPE.POINTER;\r
388 } else if (datumTypeStr.equalsIgnoreCase("BOOLEAN")) {\r
389 return DATUM_TYPE.BOOLEAN;\r
390 }\r
391 return DATUM_TYPE.UNKNOWN;\r
392 }\r
393\r
394 /**\r
395 Get string of given pcdType\r
396 \r
397 @param pcdType The given PcdType\r
398 \r
399 @return The string of PCD_TYPE.\r
400 **/\r
401 public static String getStringOfpcdType(PCD_TYPE pcdType) {\r
402 switch (pcdType) {\r
403 case FEATURE_FLAG:\r
404 return "FEATURE_FLAG";\r
405 case FIXED_AT_BUILD:\r
406 return "FIXED_AT_BUILD";\r
407 case PATCHABLE_IN_MODULE:\r
408 return "PATCHABLE_IN_MODULE";\r
409 case DYNAMIC:\r
410 return "DYNAMIC";\r
411 case DYNAMIC_EX:\r
412 return "DYNAMIC_EX";\r
413 }\r
414 return "UNKNOWN";\r
415 }\r
416\r
417 /**\r
418 Get the PCD_USAGE according to a string\r
419 \r
420 @param usageStr The string of PCD_USAGE\r
421 \r
422 @return The PCD_USAGE\r
423 **/\r
424 public static PCD_USAGE getUsageFromString(String usageStr) {\r
425 if (usageStr == null) {\r
426 return PCD_USAGE.UNKNOWN;\r
427 }\r
428\r
429 if (usageStr.equalsIgnoreCase("ALWAYS_PRODUCED")) {\r
430 return PCD_USAGE.ALWAYS_PRODUCED;\r
431 } else if (usageStr.equalsIgnoreCase("SOMETIMES_PRODUCED")) {\r
432 return PCD_USAGE.SOMETIMES_PRODUCED;\r
433 } else if (usageStr.equalsIgnoreCase("ALWAYS_CONSUMED")) {\r
434 return PCD_USAGE.ALWAYS_CONSUMED;\r
435 } else if (usageStr.equalsIgnoreCase("SOMETIMES_CONSUMED")) {\r
436 return PCD_USAGE.SOMETIMES_CONSUMED;\r
437 }\r
438\r
439 return PCD_USAGE.UNKNOWN;\r
440 }\r
441\r
442 /**\r
443 Get the string of given PCD_USAGE\r
444 \r
445 @param usage The given PCD_USAGE\r
446 \r
447 @return The string of PDC_USAGE.\r
448 **/\r
449 public static String getStringOfUsage(PCD_USAGE usage) {\r
450 switch (usage) {\r
451 case ALWAYS_PRODUCED:\r
452 return "ALWAYS_PRODUCED";\r
453 case ALWAYS_CONSUMED:\r
454 return "ALWAYS_CONSUMED";\r
455 case SOMETIMES_PRODUCED:\r
456 return "SOMETIMES_PRODUCED";\r
457 case SOMETIMES_CONSUMED:\r
458 return "SOMETIMES_CONSUMED";\r
459 }\r
460 return "UNKNOWN";\r
461 }\r
462\r
463 /**\r
464 Get the Defined datumType string for autogen. The string is for generating some MACROs in Autogen.h\r
465 \r
466 @param datumType The given datumType\r
467\r
468 @return string of datum type for autogen.\r
469 **/\r
470 public static String GetAutogenDefinedatumTypeString(DATUM_TYPE datumType) {\r
471 switch (datumType) {\r
472 \r
473 case UINT8:\r
474 return "8";\r
475 case UINT16:\r
476 return "16";\r
477 case BOOLEAN:\r
478 return "BOOL";\r
479 case POINTER:\r
480 return "PTR";\r
481 case UINT32:\r
482 return "32";\r
483 case UINT64:\r
484 return "64";\r
485 default:\r
486 return null;\r
487 }\r
488 }\r
489\r
490 /**\r
491 Get the datumType String for Autogen. This string will be used for generating defintions of PCD token in autogen\r
492 \r
493 @param datumType The given datumType\r
494\r
495 @return string of datum type.\r
496 **/\r
58f1099f 497\r
878ddf1f 498 public static String getAutogendatumTypeString(DATUM_TYPE datumType) {\r
499 switch (datumType) {\r
500 case UINT8:\r
501 return "UINT8";\r
502 case UINT16:\r
503 return "UINT16";\r
504 case UINT32:\r
505 return "UINT32";\r
506 case UINT64:\r
507 return "UINT64";\r
508 case POINTER:\r
509 return "VOID*";\r
510 case BOOLEAN:\r
511 return "BOOLEAN";\r
512 }\r
513 return null;\r
514 }\r
515\r
516 /**\r
517 Get the datumType string for generating some MACROs in autogen file of Library\r
518 \r
519 @param datumType The given datumType\r
520\r
521 @return String of datum for genrating bit charater.\r
522 **/\r
523 public static String getAutogenLibrarydatumTypeString(DATUM_TYPE datumType) {\r
524 switch (datumType) {\r
525 case UINT8:\r
526 return "8";\r
527 case UINT16:\r
528 return "16";\r
529 case BOOLEAN:\r
530 return "Bool";\r
531 case POINTER:\r
532 return "Ptr";\r
533 case UINT32:\r
534 return "32";\r
535 case UINT64:\r
536 return "64";\r
537 default:\r
538 return null;\r
539 }\r
540 }\r
541\r
542 /**\r
eece174a 543 Get the sku data who id is 0.\r
544 \r
545 @retval DynamicTokenValue the value of this dyanmic token.\r
878ddf1f 546 **/\r
6ff7a41c 547 public DynamicTokenValue getDefaultSku() {\r
548 DynamicTokenValue dynamicData;\r
549 int index;\r
eece174a 550\r
6ff7a41c 551 for (index = 0; index < this.skuData.size(); index ++) {\r
552 if (skuData.get(index).id == 0) {\r
553 return skuData.get(index).value;\r
554 }\r
555 }\r
556\r
557 return null;\r
558 }\r
eece174a 559\r
560 /**\r
561 Get the number of Sku data for this token\r
562 \r
563 @retval int the number of sku data\r
564 **/\r
58f1099f 565 public int getSkuIdCount () {\r
566 return this.skuData.size();\r
567 }\r
1de04b4f 568\r
eece174a 569 /**\r
570 Get the size of PCD value, this PCD is POINTER type.\r
571 \r
572 @param str the string of the value\r
573 @param al \r
574 **/\r
1de04b4f 575 private void getCurrentSizeFromDefaultValue (String str, ArrayList<Integer> al) {\r
576 if (isValidNullValue(str)) {\r
577 al.add(new Integer(0));\r
578 } else {\r
579 //\r
580 // isValidNullValue has already make sure that str here\r
581 // always contain a valid default value of the following 3\r
582 // cases:\r
583 // 1) "Hello world" //Assci string\r
584 // 2) L"Hello" //Unicode string\r
585 // 3) {0x01, 0x02, 0x03} //Byte stream\r
586 //\r
587 if (str.startsWith("\"")) {\r
588 al.add(new Integer(str.length() - 2));\r
589 } else if (str.startsWith("L\"")){\r
590 //\r
591 // Unicode is 2 bytes each.\r
592 //\r
593 al.add(new Integer((str.length() - 3) * 2));\r
594 } else if (str.startsWith("{")) {\r
595 //\r
596 // We count the number of "," in the string.\r
597 // The number of byte is one plus the number of \r
598 // comma.\r
599 //\r
600 String str2 = str;\r
601 \r
602 int cnt = 0;\r
603 int pos = 0;\r
604 pos = str2.indexOf(",", 0);\r
605 while (pos != -1) {\r
606 cnt++;\r
607 pos++;\r
608 pos = str2.indexOf(",", pos);\r
609 }\r
610 cnt++;\r
611 al.add(new Integer(cnt));\r
612 }\r
613 }\r
614 }\r
eece174a 615\r
616 /**\r
617 This method can be used to get the MAX and current size\r
618 for pointer type dynamic(ex) PCD entry\r
619 **/ \r
1de04b4f 620 public ArrayList<Integer> getPointerTypeSize () {\r
621 ArrayList<Integer> al = new ArrayList<Integer>();\r
622 \r
623 //\r
624 // For VPD_enabled and HII_enabled, we can only return the MAX size.\r
625 // For the default DATA type dynamic PCD entry, we will return\r
626 // the MAX size and current size for each SKU_ID.\r
627 //\r
628 al.add(new Integer(this.datumSize));\r
629 \r
630 if (!this.isVpdEnable()) {\r
631 int idx;\r
632 if (this.isHiiEnable()){\r
633 for (idx = 0; idx < this.skuData.size(); idx++) {\r
634 String str = this.skuData.get(idx).value.hiiDefaultValue;\r
635 getCurrentSizeFromDefaultValue(str, al);\r
636 }\r
637 } else {\r
638 for (idx = 0; idx < this.skuData.size(); idx++) {\r
639 String str = this.skuData.get(idx).value.value;\r
640 getCurrentSizeFromDefaultValue(str, al);\r
641 }\r
642 }\r
643 }\r
644 \r
645 return al;\r
646 }\r
f63ef4b2 647\r
648 /**\r
649 Get default value for a token, For HII type, HiiDefaultValue of default\r
650 SKU 0 will be returned; For Default type, the defaultvalue of default SKU\r
651 0 will be returned.\r
652 \r
653 @return String\r
654 */\r
655 public String getDynamicDefaultValue() {\r
656 DynamicTokenValue dynamicData = getDefaultSku();\r
657 if (hasDefaultValue()) {\r
658 switch (dynamicData.type) {\r
f63ef4b2 659 case DEFAULT_TYPE:\r
660 return dynamicData.value;\r
661 }\r
662 }\r
663\r
664 return null;\r
665 }\r
666\r
99d2c3c4 667 //\r
668 // BugBug: We need change this algorithm accordingly when schema is updated\r
669 // to support no default value.\r
670 //\r
671 public boolean hasDefaultValue () {\r
6ff7a41c 672 int value = 0;\r
673 boolean isInteger = true;\r
674 DynamicTokenValue dynamicValue = null;\r
675\r
58f1099f 676 if (isSkuEnable()) {\r
677 return true;\r
678 }\r
679 \r
6ff7a41c 680 if (this.isDynamicPCD) {\r
681 dynamicValue = getDefaultSku();\r
682 switch (dynamicValue.type) {\r
683 case HII_TYPE:\r
58f1099f 684 return true;\r
6ff7a41c 685 case VPD_TYPE:\r
58f1099f 686 return true;\r
6ff7a41c 687 case DEFAULT_TYPE:\r
6f7e61a0 688 return !isValidNullValue(dynamicValue.value);\r
689 }\r
690 }\r
691\r
692 return false;\r
693 }\r
6ff7a41c 694\r
eece174a 695 /**\r
696 Judge the value is NULL value. NULL value means the value is uninitialized value\r
697 \r
698 @param judgedValue\r
699 \r
700 @return boolean\r
701 */\r
6f7e61a0 702 public boolean isValidNullValue(String judgedValue) {\r
e59cdca8 703 String subStr;\r
6f7e61a0 704 BigInteger bigIntValue;\r
705\r
706 switch (datumType) {\r
707 case UINT8:\r
708 case UINT16:\r
709 case UINT32:\r
e59cdca8 710 if (judgedValue.length() > 2) {\r
711 if ((judgedValue.charAt(0) == '0') && \r
712 ((judgedValue.charAt(1) == 'x') || (judgedValue.charAt(1) == 'X'))){\r
713 subStr = judgedValue.substring(2, judgedValue.length());\r
714 bigIntValue = new BigInteger(subStr, 16);\r
715 } else {\r
716 bigIntValue = new BigInteger(judgedValue);\r
717 }\r
718 } else {\r
719 bigIntValue = new BigInteger(judgedValue);\r
720 }\r
721 if (bigIntValue.bitCount() == 0) {\r
6f7e61a0 722 return true;\r
723 }\r
724 break;\r
725 case UINT64:\r
726 if (judgedValue.length() > 2){\r
727 if ((judgedValue.charAt(0) == '0') && \r
728 ((judgedValue.charAt(1) == 'x') ||\r
729 (judgedValue.charAt(1) == 'X'))) {\r
730 bigIntValue = new BigInteger(judgedValue.substring(2, judgedValue.length()), 16);\r
731 if (bigIntValue.bitCount() == 0) {\r
732 return true;\r
733 }\r
6ff7a41c 734 } else {\r
6f7e61a0 735 bigIntValue = new BigInteger(judgedValue);\r
736 if (bigIntValue.bitCount() == 0) {\r
737 return true;\r
738 }\r
739 }\r
740 } else {\r
741 bigIntValue = new BigInteger(judgedValue);\r
742 if (bigIntValue.bitCount() == 0) {\r
6ff7a41c 743 return true;\r
744 }\r
6f7e61a0 745 }\r
746 break;\r
747 case BOOLEAN:\r
748 if (judgedValue.equalsIgnoreCase("false")) {\r
749 return true;\r
750 }\r
751 break;\r
752 case POINTER:\r
753 if (judgedValue.equalsIgnoreCase("") ||\r
754 judgedValue.equalsIgnoreCase("\"\"") ||\r
755 judgedValue.equalsIgnoreCase("L\"\"") ||\r
756 (judgedValue.length() == 0) ||\r
ddb87685 757 judgedValue.equalsIgnoreCase("{0}")) {\r
6f7e61a0 758 return true;\r
6ff7a41c 759 }\r
32648c62 760 }\r
6ff7a41c 761 return false;\r
99d2c3c4 762 }\r
eece174a 763\r
764 /**\r
765 Is the string value in Unicode\r
766 \r
767 @return boolean\r
768 **/\r
bb5545b6 769 public boolean isHiiDefaultValueUnicodeStringType() {\r
770 DynamicTokenValue dynamicData = getDefaultSku();\r
771 \r
772 if (dynamicData == null)\r
773 return false;\r
774 \r
775 return dynamicData.hiiDefaultValue.startsWith("L\"")\r
776 && dynamicData.hiiDefaultValue.endsWith("\"");\r
777 }\r
eece174a 778\r
779 /**\r
780 Is the string value in ANSCI\r
781 \r
782 @return boolean\r
783 **/\r
bb5545b6 784 public boolean isHiiDefaultValueASCIIStringType() {\r
785 DynamicTokenValue dynamicData = getDefaultSku();\r
786 \r
787 if (dynamicData == null)\r
788 return false;\r
789 \r
790 return dynamicData.hiiDefaultValue.startsWith("\"")\r
791 && dynamicData.hiiDefaultValue.endsWith("\"");\r
792 }\r
793 \r
f63ef4b2 794 /**\r
795 Judege whether current value is UNICODE string type.\r
796 @return boolean\r
797 */\r
798 public boolean isUnicodeStringType () {\r
799 String str = getDynamicDefaultValue();\r
800\r
801 if (str == null) {\r
802 return false;\r
803 }\r
99d2c3c4 804\r
f63ef4b2 805 if (datumType == Token.DATUM_TYPE.POINTER &&\r
806 str.startsWith("L\"") && \r
807 str.endsWith("\"")) {\r
32648c62 808 return true;\r
809 }\r
99d2c3c4 810\r
32648c62 811 return false;\r
812 }\r
4276d5da 813 \r
3534cbb7 814 public boolean isASCIIStringType () {\r
815 String str = getDynamicDefaultValue();\r
816\r
817 if (str == null) {\r
818 return false;\r
819 }\r
820\r
821 if (datumType == Token.DATUM_TYPE.POINTER &&\r
822 str.startsWith("\"") && \r
823 str.endsWith("\"")) {\r
824 return true;\r
825 }\r
826\r
827 return false;\r
828 }\r
829\r
4276d5da 830 public boolean isByteStreamType () {\r
831 String str = getDynamicDefaultValue();\r
832\r
833 if (str == null) {\r
834 return false;\r
835 }\r
836\r
837 if (datumType == Token.DATUM_TYPE.POINTER &&\r
838 str.startsWith("{") && \r
839 str.endsWith("}")) {\r
840 return true;\r
841 }\r
842\r
843 return false;\r
844 \r
845 }\r
99d2c3c4 846\r
32648c62 847 public String getStringTypeString () { \r
6ff7a41c 848 return getDefaultSku().value.substring(2, getDefaultSku().value.length() - 1);\r
32648c62 849 }\r
878ddf1f 850}\r
851\r
852\r
853\r
854\r
EFI Development Kit II mirror for PVE