4 This class indicate an usage instance for a PCD token. This instance maybe a module
5 or platform setting. When a module produce or cosume a PCD token, then this module
6 is an usage instance for this PCD token.
8 Copyright (c) 2006, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 package org
.tianocore
.pcd
.entity
;
20 import org
.tianocore
.pcd
.entity
.CommonDefinition
;
21 import org
.tianocore
.pcd
.entity
.UsageIdentification
;
24 This class indicate an usage instance for a PCD token. This instance maybe a module
25 or platform setting. When a module produce or cosume a PCD token, then this module
26 is an usage instance for this PCD token.
28 public class UsageInstance
{
30 /// This parent that this usage instance belongs to.
32 public Token parentToken
;
35 /// ModuleIdentification for Usage Instance
37 public UsageIdentification usageId
;
40 /// Arch also is a key for a UsageInstance
45 /// The PCD type defined for module
47 public Token
.PCD_TYPE modulePcdType
;
50 /// The value of the PCD in this usage instance.
55 /// The maxDatumSize could be different for same PCD in different module
56 /// But this case is allow for FeatureFlag, FixedAtBuild, PatchableInModule
59 public int maxDatumSize
;
62 /// Autogen string for header file.
64 public String hAutogenStr
;
67 /// Auotgen string for C code file.
69 public String cAutogenStr
;
72 Constructure function for UsageInstance
74 @param parentToken The token instance for this usgaInstance
75 @param id The identification for usage instance
76 @param modulePcdType The PCD type for this usage instance
77 @param value The value of this PCD in this usage instance
78 @param maxDatumSize The max datum size of this PCD in this usage
81 public UsageInstance(Token parentToken
,
82 UsageIdentification usageId
,
83 Token
.PCD_TYPE modulePcdType
,
86 this.parentToken
= parentToken
;
87 this.usageId
= usageId
;
88 this.modulePcdType
= modulePcdType
;
90 this.maxDatumSize
= maxDatumSize
;
94 Get the primary key for usage instance array for every token.
96 @param usageId The identification of UsageInstance
98 @retval String The primary key for this usage instance
100 public static String
getPrimaryKey(UsageIdentification usageId
) {
101 return usageId
.toString();
105 Get primary key string for this usage instance
107 @return String primary key string
109 public String
getPrimaryKey() {
110 return UsageInstance
.getPrimaryKey(usageId
);
114 Judget whether current module is PEI driver
116 @return boolean whether current module is PEI driver
118 public boolean isPeiPhaseComponent() {
119 int moduleType
= CommonDefinition
.getModuleType(usageId
.moduleType
);
121 if ((moduleType
== CommonDefinition
.ModuleTypePeiCore
) ||
122 (moduleType
== CommonDefinition
.ModuleTypePeim
)) {
129 Judge whether current module is DXE driver.
131 @return boolean whether current module is DXE driver
133 public boolean isDxePhaseComponent() {
134 int moduleType
= CommonDefinition
.getModuleType(usageId
.moduleType
);
136 if ((moduleType
== CommonDefinition
.ModuleTypeDxeDriver
) ||
137 (moduleType
== CommonDefinition
.ModuleTypeDxeRuntimeDriver
) ||
138 (moduleType
== CommonDefinition
.ModuleTypeDxeSalDriver
) ||
139 (moduleType
== CommonDefinition
.ModuleTypeDxeSmmDriver
) ||
140 (moduleType
== CommonDefinition
.ModuleTypeUefiDriver
) ||
141 (moduleType
== CommonDefinition
.ModuleTypeUefiApplication
)
149 Generate autogen string for header file and C code file.
151 @param isBuildUsedLibrary whether the autogen is for library.
153 public void generateAutoGen(boolean isBuildUsedLibrary
) {
154 String guidStringCName
= null;
155 boolean isByteArray
= false;
156 String printDatum
= null;
157 String tokenNumberString
= null;
162 if (this.modulePcdType
== Token
.PCD_TYPE
.DYNAMIC_EX
) {
164 // For DYNAMIC_EX type PCD, use original token number in SPD or FPD to generate autogen
166 tokenNumberString
= Long
.toString(parentToken
.dynamicExTokenNumber
, 16);
169 // For Others type PCD, use autogenerated token number to generate autogen
171 tokenNumberString
= Long
.toString(parentToken
.tokenNumber
, 16);
174 hAutogenStr
+= String
.format("#define _PCD_TOKEN_%s 0x%s\r\n", parentToken
.cName
, tokenNumberString
);
177 // Judge the value of this PCD is byte array type
179 if (!isBuildUsedLibrary
&& !parentToken
.isDynamicPCD
) {
180 if (datum
.trim().charAt(0) == '{') {
186 // "ULL" should be added to value's tail for UINT64 value
188 if (parentToken
.datumType
== Token
.DATUM_TYPE
.UINT64
) {
189 printDatum
= this.datum
+ "ULL";
191 printDatum
= this.datum
;
194 switch (modulePcdType
) {
196 hAutogenStr
+= String
.format("extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
198 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
199 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
202 hAutogenStr
+= String
.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) If is not allowed to set value for a FEATURE_FLAG PCD\r\n",
203 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
206 if (!isBuildUsedLibrary
) {
207 hAutogenStr
+= String
.format("#define _PCD_VALUE_%s %s\r\n",
210 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
217 hAutogenStr
+= String
.format("extern const UINT8 _gPcd_FixedAtBuild_%s[];\r\n",
219 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s (VOID*)_gPcd_FixedAtBuild_%s\r\n",
220 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
224 hAutogenStr
+= String
.format("extern const %s _gPcd_FixedAtBuild_%s;\r\n",
225 Token
.getAutogendatumTypeString(parentToken
.datumType
),
227 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
228 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
233 hAutogenStr
+= String
.format("//#define _PCD_SET_MODE_%s_%s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\r\n",
234 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
236 if (!isBuildUsedLibrary
) {
237 if (parentToken
.datumType
== Token
.DATUM_TYPE
.POINTER
) {
239 hAutogenStr
+= String
.format("#define _PCD_VALUE_%s (VOID*)_gPcd_FixedAtBuild_%s\r\n",
242 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gPcd_FixedAtBuild_%s[] = %s;\r\n",
246 hAutogenStr
+= String
.format("#define _PCD_VALUE_%s %s\r\n",
249 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
250 Token
.getAutogendatumTypeString(parentToken
.datumType
),
255 hAutogenStr
+= String
.format("#define _PCD_VALUE_%s %s\r\n",
258 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
259 Token
.getAutogendatumTypeString(parentToken
.datumType
),
265 case PATCHABLE_IN_MODULE
:
267 hAutogenStr
+= String
.format("extern UINT8 _gPcd_BinaryPatch_%s[];\r\n",
269 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s (VOID*)_gPcd_BinaryPatch_%s\r\n",
270 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
274 hAutogenStr
+= String
.format("extern %s _gPcd_BinaryPatch_%s;\r\n",
275 Token
.getAutogendatumTypeString(parentToken
.datumType
),
277 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",
278 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
284 // Generate _PCD_SET_MODE_xx macro for using set BinaryPatch value via PcdSet macro
286 if (parentToken
.datumType
== Token
.DATUM_TYPE
.POINTER
) {
287 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) CopyMem (_gPcd_BinaryPatch_%s, (Buffer), (SizeOfBuffer))\r\n",
288 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
292 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(Value) (_gPcd_BinaryPatch_%s = (Value))\r\n",
293 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
298 if (!isBuildUsedLibrary
) {
299 hAutogenStr
+= String
.format("#define _PCD_VALUE_%s %s\r\n",
303 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED UINT8 _gPcd_BinaryPatch_%s[] = _PCD_VALUE_%s;\r\n",
307 cAutogenStr
+= String
.format("GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",
308 Token
.getAutogendatumTypeString(parentToken
.datumType
),
316 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s LibPcdGet%s(_PCD_TOKEN_%s)\r\n",
317 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
319 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
321 if (parentToken
.datumType
== Token
.DATUM_TYPE
.POINTER
) {
322 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSet%s(_PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",
323 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
325 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
328 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSet%s(_PCD_TOKEN_%s, (Value))\r\n",
329 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
331 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
336 guidStringCName
= "_gPcd_TokenSpaceGuid_" +
337 parentToken
.tokenSpaceName
.toString().replaceAll("-", "_");
339 hAutogenStr
+= String
.format("#define _PCD_GET_MODE_%s_%s LibPcdGetEx%s(&%s, _PCD_TOKEN_%s)\r\n",
340 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
342 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
346 if (parentToken
.datumType
== Token
.DATUM_TYPE
.POINTER
) {
347 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (SizeOfBuffer), (Buffer))\r\n",
348 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
350 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
354 hAutogenStr
+= String
.format("#define _PCD_SET_MODE_%s_%s(Value) LibPcdSetEx%s(&%s, _PCD_TOKEN_%s, (Value))\r\n",
355 Token
.GetAutogenDefinedatumTypeString(parentToken
.datumType
),
357 Token
.getAutogenLibrarydatumTypeString(parentToken
.datumType
),
367 Get the autogen string for header file.
369 @return The string of header file.
371 public String
getHAutogenStr() {
376 Get the autogen string for C code file.
378 @return The string of C Code file.
380 public String
getCAutogenStr() {