1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
/** @file
UsageInstance class.
This class indicate an usage instance for a PCD token. This instance maybe a module
or platform setting. When a module produce or cosume a PCD token, then this module
is an usage instance for this PCD token.
Copyright (c) 2006, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
package org.tianocore.build.pcd.entity;
import org.tianocore.build.pcd.exception.EntityException;
import org.tianocore.build.pcd.action.ActionMessage;
import org.tianocore.build.autogen.CommonDefinition;
/**
This class indicate an usage instance for a PCD token. This instance maybe a module
or platform setting. When a module produce or cosume a PCD token, then this module
is an usage instance for this PCD token.
**/
public class UsageInstance {
///
/// This parent that this usage instance belongs to.
///
public Token parentToken;
///
/// The usage of this token for platform or module.
///
public Token.PCD_USAGE usage;
///
/// Whether this usage instance inherit from library
///
public boolean isInherit;
///
/// The pcd type of this token for module.
///
public Token.PCD_TYPE modulePcdType;
///
/// The name of the module who contains this PCD.
///
public String moduleName;
///
/// The name of the package whose module contains this PCD.
///
public String packageName;
///
/// The component type for this usage instance.
///
public int componentType;
///
/// The default value defined in MSA has high prior than defined in SPD.
///
public Object defaultValueInMSA;
///
/// The default value defined in SPD.
///
public Object defaultValueInSPD;
///
/// Help text in MSA
///
public String helpTextInMSA;
///
/// Help text in SPD
///
public String helpTextInSPD;
///
/// Autogen string for header file.
///
public String hAutogenStr;
/**
* Auotgen string for C code file.
*/
public String cAutogenStr;
/**
Constructure function
@param parentToken Member variable.
@param usage Member variable.
@param pcdType Member variable.
@param componentType Member variable.
@param defaultValueInMSA Member variable.
@param defaultValueInSPD Member variable.
@param helpTextInMSA Member variable.
@param helpTextInSPD Member variable.
@param moduleName Member variable.
@param packageName Member variable.
@param isInherit Member variable.
**/
public UsageInstance(
Token parentToken,
Token.PCD_USAGE usage,
Token.PCD_TYPE pcdType,
int componentType,
Object defaultValueInMSA,
Object defaultValueInSPD,
String helpTextInMSA,
String helpTextInSPD,
String moduleName,
String packageName,
boolean isInherit
)
{
this.parentToken = parentToken;
this.usage = usage;
this.modulePcdType = pcdType;
this.componentType = componentType;
this.defaultValueInMSA = defaultValueInMSA;
this.defaultValueInSPD = defaultValueInSPD;
this.helpTextInMSA = helpTextInMSA;
this.helpTextInSPD = helpTextInSPD;
this.moduleName = moduleName;
this.packageName = packageName;
this.isInherit = isInherit;
}
/**
Generate autogen string for header file and C code file.
@throws EntityException Fail to generate.
**/
public void generateAutoGen() throws EntityException {
Object value = null;
int tokenNumber = 0;
hAutogenStr = "";
cAutogenStr = "";
value = this.parentToken.datum;
//
// If this pcd token's PCD_TYPE is DYNAMIC_EX, use itself token space name
// otherwices use assgined token space name from tool automatically.
//
if(parentToken.pcdType == Token.PCD_TYPE.DYNAMIC_EX) {
tokenNumber = parentToken.tokenNumber;
} else {
tokenNumber = parentToken.assignedtokenNumber;
}
hAutogenStr += String.format("#define _PCD_TOKEN_%s 0x%016x\r\n",
parentToken.cName, tokenNumber);
switch(modulePcdType) {
case FEATURE_FLAG:
//
// BUGBUG: The judegement of module PCD type and platform PCD type should not be
// done here, but in wizard tools, But here is just following something
// PcdEmulation driver.
//
if(parentToken.pcdType.ordinal() > Token.PCD_TYPE.FEATURE_FLAG.ordinal()) {
throw new EntityException(
String.format(
"%s:Platform PCD Type %d is not compatible with Module PCD Type %d\r\n",
parentToken.cName,
parentToken.pcdType.name(),
modulePcdType.name()
)
);
}
if(CommonDefinition.isLibraryComponent(componentType)) {
hAutogenStr += String.format(
"extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
parentToken.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
} else {
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value.toString()
);
hAutogenStr += String.format(
"extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
parentToken.cName
);
cAutogenStr += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
}
break;
case FIXED_AT_BUILD:
//
// BUGBUG: The judegement of module PCD type and platform PCD type should not be
// done here, but in wizard tools, But here is just following something
// PcdEmulation driver.
//
if(parentToken.pcdType.ordinal() > Token.PCD_TYPE.FIXED_AT_BUILD.ordinal()) {
throw new EntityException(
String.format(
"%s:Platform PCD Type %d is not compatible with Module PCD Type %d\r\n",
parentToken.cName,
parentToken.pcdType.name(),
modulePcdType.name()
)
);
}
if(CommonDefinition.isLibraryComponent(componentType)) {
hAutogenStr += String.format(
"extern const %s _gPcd_FixedAtBuild_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
} else {
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value.toString()
);
hAutogenStr += String.format(
"extern const %s _gPcd_FixedAtBuild_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
cAutogenStr += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
}
break;
case PATCHABLE_IN_MODULE:
//
// BUGBUG: The judegement of module PCD type and platform PCD type should not be
// done here, but in wizard tools, But here is just following something
// PcdEmulation driver.
//
if(parentToken.pcdType.ordinal() > Token.PCD_TYPE.PATCHABLE_IN_MODULE.ordinal()) {
throw new EntityException(
String.format(
"%s:Platform PCD Type %d is not compatible with Module PCD Type %d\r\n",
parentToken.cName,
parentToken.pcdType.name(),
modulePcdType.name()
)
);
}
if(CommonDefinition.isLibraryComponent(componentType)) {
hAutogenStr += String.format(
"extern %s _gPcd_BinaryPatch_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
} else {
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value
);
hAutogenStr += String.format(
"extern %s _gPcd_BinaryPatch_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
cAutogenStr += String.format(
"GLOBAL_REMOVE_IF_UNREFERENCED %s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
}
break;
case DYNAMIC:
//
// BUGBUG: The judegement of module PCD type and platform PCD type should not be
// done here, but in wizard tools, But here is just following something
// PcdEmulation driver.
//
if(parentToken.pcdType.ordinal() > Token.PCD_TYPE.DYNAMIC.ordinal()) {
throw new EntityException(
String.format(
"%s:Platform PCD Type %d is not compatible with Module PCD Type %d\r\n",
parentToken.cName,
parentToken.pcdType.name(),
modulePcdType.name()
)
);
}
switch(parentToken.pcdType) {
case FEATURE_FLAG:
if(CommonDefinition.isLibraryComponent(componentType)) {
hAutogenStr += String.format(
"extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
} else {
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value
);
hAutogenStr += String.format(
"extern const BOOLEAN _gPcd_FixedAtBuild_%s;\r\n",
parentToken.cName
);
cAutogenStr += String.format(
"const BOOLEAN _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
}
break;
case FIXED_AT_BUILD:
if(CommonDefinition.isLibraryComponent(componentType)) {
hAutogenStr += String.format(
"extern const %s _gPcd_FixedAtBuild_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_FixedAtBuild_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
} else {
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value
);
hAutogenStr += String.format(
"extern const %s _gPcd_FixedAtBuild_%s\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName
);
cAutogenStr += String.format(
"const %s _gPcd_FixedAtBuild_%s = _PCD_VALUE_%s;\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _PCD_VALUE_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
}
break;
case PATCHABLE_IN_MODULE:
hAutogenStr += String.format(
"#define _PCD_VALUE_%s %s\r\n",
parentToken.cName,
value
);
hAutogenStr += String.format(
"extern %s _gPcd_BinaryPatch_%s;\r\n",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
cAutogenStr += String.format(
"%s _gPcd_BinaryPatch_%s = _PCD_VALUE_%s;",
Token.getAutogendatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s _gPcd_BinaryPatch_%s\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
parentToken.cName
);
break;
case DYNAMIC:
hAutogenStr += "\r\n";
hAutogenStr += String.format(
"#define _PCD_MODE_%s_%s LibPcdGet%s(_PCD_TOKEN_%s)\r\n",
Token.GetAutogenDefinedatumTypeString(parentToken.datumType),
parentToken.cName,
Token.getAutogenLibrarydatumTypeString(parentToken.datumType),
parentToken.cName
);
break;
default:
ActionMessage.log(
this,
"The PCD_TYPE setted by platform is unknown"
);
}
break;
case DYNAMIC_EX:
break;
}
}
/**
Get the autogen string for header file.
@return The string of header file.
**/
public String getHAutogenStr() {
return hAutogenStr;
}
/**
Get the autogen string for C code file.
@return The string of C Code file.
**/
public String getCAutogenStr() {
return cAutogenStr;
}
}
|
