]>
Commit | Line | Data |
---|---|---|
f51461c8 LG |
1 | ## @file\r |
2 | # Routines for generating AutoGen.h and AutoGen.c\r | |
3 | #\r | |
eca980c0 | 4 | # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r |
f51461c8 LG |
5 | # This program and the accompanying materials\r |
6 | # are licensed and made available under the terms and conditions of the BSD License\r | |
7 | # which accompanies this distribution. The full text of the license may be found at\r | |
8 | # http://opensource.org/licenses/bsd-license.php\r | |
9 | #\r | |
10 | # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | #\r | |
13 | \r | |
14 | ## Import Modules\r | |
15 | #\r | |
16 | import string\r | |
333ba578 YZ |
17 | import collections\r |
18 | import struct\r | |
f51461c8 LG |
19 | from Common import EdkLogger\r |
20 | \r | |
21 | from Common.BuildToolError import *\r | |
22 | from Common.DataType import *\r | |
23 | from Common.Misc import *\r | |
24 | from Common.String import StringToArray\r | |
25 | from StrGather import *\r | |
26 | from GenPcdDb import CreatePcdDatabaseCode\r | |
333ba578 | 27 | from IdfClassObject import *\r |
f51461c8 LG |
28 | \r |
29 | ## PCD type string\r | |
30 | gItemTypeStringDatabase = {\r | |
be409b67 CJ |
31 | TAB_PCDS_FEATURE_FLAG : TAB_PCDS_FIXED_AT_BUILD,\r |
32 | TAB_PCDS_FIXED_AT_BUILD : TAB_PCDS_FIXED_AT_BUILD,\r | |
f51461c8 LG |
33 | TAB_PCDS_PATCHABLE_IN_MODULE: 'BinaryPatch',\r |
34 | TAB_PCDS_DYNAMIC : '',\r | |
35 | TAB_PCDS_DYNAMIC_DEFAULT : '',\r | |
36 | TAB_PCDS_DYNAMIC_VPD : '',\r | |
37 | TAB_PCDS_DYNAMIC_HII : '',\r | |
38 | TAB_PCDS_DYNAMIC_EX : '',\r | |
39 | TAB_PCDS_DYNAMIC_EX_DEFAULT : '',\r | |
40 | TAB_PCDS_DYNAMIC_EX_VPD : '',\r | |
41 | TAB_PCDS_DYNAMIC_EX_HII : '',\r | |
42 | }\r | |
43 | \r | |
f51461c8 LG |
44 | \r |
45 | ## Datum size\r | |
656d2539 CJ |
46 | gDatumSizeStringDatabase = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'BOOLEAN',TAB_VOID:'8'}\r |
47 | gDatumSizeStringDatabaseH = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'BOOL',TAB_VOID:'PTR'}\r | |
48 | gDatumSizeStringDatabaseLib = {TAB_UINT8:'8',TAB_UINT16:'16',TAB_UINT32:'32',TAB_UINT64:'64','BOOLEAN':'Bool',TAB_VOID:'Ptr'}\r | |
f51461c8 LG |
49 | \r |
50 | ## AutoGen File Header Templates\r | |
51 | gAutoGenHeaderString = TemplateString("""\\r | |
52 | /**\r | |
53 | DO NOT EDIT\r | |
54 | FILE auto-generated\r | |
55 | Module name:\r | |
56 | ${FileName}\r | |
57 | Abstract: Auto-generated ${FileName} for building module or library.\r | |
58 | **/\r | |
59 | """)\r | |
60 | \r | |
61 | gAutoGenHPrologueString = TemplateString("""\r | |
62 | #ifndef _${File}_${Guid}\r | |
63 | #define _${File}_${Guid}\r | |
64 | \r | |
65 | """)\r | |
66 | \r | |
67 | gAutoGenHCppPrologueString = """\\r | |
68 | #ifdef __cplusplus\r | |
69 | extern "C" {\r | |
70 | #endif\r | |
71 | \r | |
72 | """\r | |
73 | \r | |
74 | gAutoGenHEpilogueString = """\r | |
75 | \r | |
76 | #ifdef __cplusplus\r | |
77 | }\r | |
78 | #endif\r | |
79 | \r | |
80 | #endif\r | |
81 | """\r | |
82 | \r | |
83 | ## PEI Core Entry Point Templates\r | |
84 | gPeiCoreEntryPointPrototype = TemplateString("""\r | |
85 | ${BEGIN}\r | |
86 | VOID\r | |
87 | EFIAPI\r | |
88 | ${Function} (\r | |
89 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
90 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
91 | IN VOID *Context\r | |
92 | );\r | |
93 | ${END}\r | |
94 | """)\r | |
95 | \r | |
96 | gPeiCoreEntryPointString = TemplateString("""\r | |
97 | ${BEGIN}\r | |
98 | VOID\r | |
99 | EFIAPI\r | |
100 | ProcessModuleEntryPointList (\r | |
101 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r | |
102 | IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r | |
103 | IN VOID *Context\r | |
104 | )\r | |
105 | \r | |
106 | {\r | |
107 | ${Function} (SecCoreData, PpiList, Context);\r | |
108 | }\r | |
109 | ${END}\r | |
110 | """)\r | |
111 | \r | |
112 | \r | |
113 | ## DXE Core Entry Point Templates\r | |
114 | gDxeCoreEntryPointPrototype = TemplateString("""\r | |
115 | ${BEGIN}\r | |
116 | VOID\r | |
117 | EFIAPI\r | |
118 | ${Function} (\r | |
119 | IN VOID *HobStart\r | |
120 | );\r | |
121 | ${END}\r | |
122 | """)\r | |
123 | \r | |
124 | gDxeCoreEntryPointString = TemplateString("""\r | |
125 | ${BEGIN}\r | |
126 | VOID\r | |
127 | EFIAPI\r | |
128 | ProcessModuleEntryPointList (\r | |
129 | IN VOID *HobStart\r | |
130 | )\r | |
131 | \r | |
132 | {\r | |
133 | ${Function} (HobStart);\r | |
134 | }\r | |
135 | ${END}\r | |
136 | """)\r | |
137 | \r | |
138 | ## PEIM Entry Point Templates\r | |
139 | gPeimEntryPointPrototype = TemplateString("""\r | |
140 | ${BEGIN}\r | |
141 | EFI_STATUS\r | |
142 | EFIAPI\r | |
143 | ${Function} (\r | |
144 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
145 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
146 | );\r | |
147 | ${END}\r | |
148 | """)\r | |
149 | \r | |
150 | gPeimEntryPointString = [\r | |
151 | TemplateString("""\r | |
152 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
153 | \r | |
154 | EFI_STATUS\r | |
155 | EFIAPI\r | |
156 | ProcessModuleEntryPointList (\r | |
157 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
158 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
159 | )\r | |
160 | \r | |
161 | {\r | |
162 | return EFI_SUCCESS;\r | |
163 | }\r | |
164 | """),\r | |
165 | TemplateString("""\r | |
166 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
167 | ${BEGIN}\r | |
168 | EFI_STATUS\r | |
169 | EFIAPI\r | |
170 | ProcessModuleEntryPointList (\r | |
171 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
172 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
173 | )\r | |
174 | \r | |
175 | {\r | |
176 | return ${Function} (FileHandle, PeiServices);\r | |
177 | }\r | |
178 | ${END}\r | |
179 | """),\r | |
180 | TemplateString("""\r | |
181 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r | |
182 | \r | |
183 | EFI_STATUS\r | |
184 | EFIAPI\r | |
185 | ProcessModuleEntryPointList (\r | |
186 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
187 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
188 | )\r | |
189 | \r | |
190 | {\r | |
191 | EFI_STATUS Status;\r | |
192 | EFI_STATUS CombinedStatus;\r | |
193 | \r | |
194 | CombinedStatus = EFI_LOAD_ERROR;\r | |
195 | ${BEGIN}\r | |
196 | Status = ${Function} (FileHandle, PeiServices);\r | |
197 | if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r | |
198 | CombinedStatus = Status;\r | |
199 | }\r | |
200 | ${END}\r | |
201 | return CombinedStatus;\r | |
202 | }\r | |
203 | """)\r | |
204 | ]\r | |
205 | \r | |
206 | ## SMM_CORE Entry Point Templates\r | |
207 | gSmmCoreEntryPointPrototype = TemplateString("""\r | |
208 | ${BEGIN}\r | |
209 | EFI_STATUS\r | |
210 | EFIAPI\r | |
211 | ${Function} (\r | |
212 | IN EFI_HANDLE ImageHandle,\r | |
213 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
214 | );\r | |
215 | ${END}\r | |
216 | """)\r | |
217 | \r | |
218 | gSmmCoreEntryPointString = TemplateString("""\r | |
219 | ${BEGIN}\r | |
220 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
221 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
222 | \r | |
223 | EFI_STATUS\r | |
224 | EFIAPI\r | |
225 | ProcessModuleEntryPointList (\r | |
226 | IN EFI_HANDLE ImageHandle,\r | |
227 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
228 | )\r | |
229 | {\r | |
230 | return ${Function} (ImageHandle, SystemTable);\r | |
231 | }\r | |
232 | ${END}\r | |
233 | """)\r | |
234 | \r | |
5a9c3e3e SV |
235 | ## MM_CORE_STANDALONE Entry Point Templates\r |
236 | gMmCoreStandaloneEntryPointPrototype = TemplateString("""\r | |
237 | ${BEGIN}\r | |
238 | EFI_STATUS\r | |
239 | EFIAPI\r | |
240 | ${Function} (\r | |
241 | IN VOID *HobStart\r | |
242 | );\r | |
243 | ${END}\r | |
244 | """)\r | |
245 | \r | |
246 | gMmCoreStandaloneEntryPointString = TemplateString("""\r | |
247 | ${BEGIN}\r | |
248 | const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
249 | \r | |
250 | VOID\r | |
251 | EFIAPI\r | |
252 | ProcessModuleEntryPointList (\r | |
253 | IN VOID *HobStart\r | |
254 | )\r | |
255 | {\r | |
256 | ${Function} (HobStart);\r | |
257 | }\r | |
258 | ${END}\r | |
259 | """)\r | |
260 | \r | |
261 | ## MM_STANDALONE Entry Point Templates\r | |
262 | gMmStandaloneEntryPointPrototype = TemplateString("""\r | |
263 | ${BEGIN}\r | |
264 | EFI_STATUS\r | |
265 | EFIAPI\r | |
266 | ${Function} (\r | |
267 | IN EFI_HANDLE ImageHandle,\r | |
268 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
269 | );\r | |
270 | ${END}\r | |
271 | """)\r | |
272 | \r | |
273 | gMmStandaloneEntryPointString = [\r | |
274 | TemplateString("""\r | |
275 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
276 | \r | |
277 | EFI_STATUS\r | |
278 | EFIAPI\r | |
279 | ProcessModuleEntryPointList (\r | |
280 | IN EFI_HANDLE ImageHandle,\r | |
281 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
282 | )\r | |
283 | \r | |
284 | {\r | |
285 | return EFI_SUCCESS;\r | |
286 | }\r | |
287 | """),\r | |
288 | TemplateString("""\r | |
289 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
290 | ${BEGIN}\r | |
291 | EFI_STATUS\r | |
292 | EFIAPI\r | |
293 | ProcessModuleEntryPointList (\r | |
294 | IN EFI_HANDLE ImageHandle,\r | |
295 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
296 | )\r | |
297 | \r | |
298 | {\r | |
299 | return ${Function} (ImageHandle, MmSystemTable);\r | |
300 | }\r | |
301 | ${END}\r | |
302 | """),\r | |
303 | TemplateString("""\r | |
304 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r | |
305 | \r | |
306 | EFI_STATUS\r | |
307 | EFIAPI\r | |
308 | ProcessModuleEntryPointList (\r | |
309 | IN EFI_HANDLE ImageHandle,\r | |
310 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
311 | )\r | |
312 | \r | |
313 | {\r | |
314 | EFI_STATUS Status;\r | |
315 | EFI_STATUS CombinedStatus;\r | |
316 | \r | |
317 | CombinedStatus = EFI_LOAD_ERROR;\r | |
318 | ${BEGIN}\r | |
319 | Status = ${Function} (ImageHandle, MmSystemTable);\r | |
320 | if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r | |
321 | CombinedStatus = Status;\r | |
322 | }\r | |
323 | ${END}\r | |
324 | return CombinedStatus;\r | |
325 | }\r | |
326 | """)\r | |
327 | ]\r | |
328 | \r | |
f51461c8 LG |
329 | ## DXE SMM Entry Point Templates\r |
330 | gDxeSmmEntryPointPrototype = TemplateString("""\r | |
331 | ${BEGIN}\r | |
332 | EFI_STATUS\r | |
333 | EFIAPI\r | |
334 | ${Function} (\r | |
335 | IN EFI_HANDLE ImageHandle,\r | |
336 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
337 | );\r | |
338 | ${END}\r | |
339 | """)\r | |
340 | \r | |
341 | gDxeSmmEntryPointString = [\r | |
342 | TemplateString("""\r | |
343 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
344 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
345 | \r | |
346 | EFI_STATUS\r | |
347 | EFIAPI\r | |
348 | ProcessModuleEntryPointList (\r | |
349 | IN EFI_HANDLE ImageHandle,\r | |
350 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
351 | )\r | |
352 | \r | |
353 | {\r | |
354 | return EFI_SUCCESS;\r | |
355 | }\r | |
356 | """),\r | |
357 | TemplateString("""\r | |
358 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
359 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
360 | \r | |
361 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
362 | static EFI_STATUS mDriverEntryPointStatus;\r | |
363 | \r | |
364 | VOID\r | |
365 | EFIAPI\r | |
366 | ExitDriver (\r | |
367 | IN EFI_STATUS Status\r | |
368 | )\r | |
369 | {\r | |
370 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
371 | mDriverEntryPointStatus = Status;\r | |
372 | }\r | |
373 | LongJump (&mJumpContext, (UINTN)-1);\r | |
374 | ASSERT (FALSE);\r | |
375 | }\r | |
376 | \r | |
377 | EFI_STATUS\r | |
378 | EFIAPI\r | |
379 | ProcessModuleEntryPointList (\r | |
380 | IN EFI_HANDLE ImageHandle,\r | |
381 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
382 | )\r | |
383 | {\r | |
384 | mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
385 | \r | |
386 | ${BEGIN}\r | |
387 | if (SetJump (&mJumpContext) == 0) {\r | |
388 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
389 | ASSERT (FALSE);\r | |
390 | }\r | |
391 | ${END}\r | |
392 | \r | |
393 | return mDriverEntryPointStatus;\r | |
394 | }\r | |
395 | """)\r | |
396 | ]\r | |
397 | \r | |
398 | ## UEFI Driver Entry Point Templates\r | |
399 | gUefiDriverEntryPointPrototype = TemplateString("""\r | |
400 | ${BEGIN}\r | |
401 | EFI_STATUS\r | |
402 | EFIAPI\r | |
403 | ${Function} (\r | |
404 | IN EFI_HANDLE ImageHandle,\r | |
405 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
406 | );\r | |
407 | ${END}\r | |
408 | """)\r | |
409 | \r | |
410 | gUefiDriverEntryPointString = [\r | |
411 | TemplateString("""\r | |
412 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
413 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
414 | \r | |
415 | EFI_STATUS\r | |
416 | EFIAPI\r | |
417 | ProcessModuleEntryPointList (\r | |
418 | IN EFI_HANDLE ImageHandle,\r | |
419 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
420 | )\r | |
421 | {\r | |
422 | return EFI_SUCCESS;\r | |
423 | }\r | |
424 | """),\r | |
425 | TemplateString("""\r | |
426 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
427 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
428 | \r | |
429 | ${BEGIN}\r | |
430 | EFI_STATUS\r | |
431 | EFIAPI\r | |
432 | ProcessModuleEntryPointList (\r | |
433 | IN EFI_HANDLE ImageHandle,\r | |
434 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
435 | )\r | |
436 | \r | |
437 | {\r | |
438 | return ${Function} (ImageHandle, SystemTable);\r | |
439 | }\r | |
440 | ${END}\r | |
441 | VOID\r | |
442 | EFIAPI\r | |
443 | ExitDriver (\r | |
444 | IN EFI_STATUS Status\r | |
445 | )\r | |
446 | {\r | |
447 | if (EFI_ERROR (Status)) {\r | |
448 | ProcessLibraryDestructorList (gImageHandle, gST);\r | |
449 | }\r | |
450 | gBS->Exit (gImageHandle, Status, 0, NULL);\r | |
451 | }\r | |
452 | """),\r | |
453 | TemplateString("""\r | |
454 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
455 | const UINT32 _gDxeRevision = ${PiSpecVersion};\r | |
456 | \r | |
457 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
458 | static EFI_STATUS mDriverEntryPointStatus;\r | |
459 | \r | |
460 | EFI_STATUS\r | |
461 | EFIAPI\r | |
462 | ProcessModuleEntryPointList (\r | |
463 | IN EFI_HANDLE ImageHandle,\r | |
464 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
465 | )\r | |
466 | {\r | |
467 | mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
468 | ${BEGIN}\r | |
469 | if (SetJump (&mJumpContext) == 0) {\r | |
470 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
471 | ASSERT (FALSE);\r | |
472 | }\r | |
473 | ${END}\r | |
474 | return mDriverEntryPointStatus;\r | |
475 | }\r | |
476 | \r | |
477 | VOID\r | |
478 | EFIAPI\r | |
479 | ExitDriver (\r | |
480 | IN EFI_STATUS Status\r | |
481 | )\r | |
482 | {\r | |
483 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
484 | mDriverEntryPointStatus = Status;\r | |
485 | }\r | |
486 | LongJump (&mJumpContext, (UINTN)-1);\r | |
487 | ASSERT (FALSE);\r | |
488 | }\r | |
489 | """)\r | |
490 | ]\r | |
491 | \r | |
492 | \r | |
493 | ## UEFI Application Entry Point Templates\r | |
494 | gUefiApplicationEntryPointPrototype = TemplateString("""\r | |
495 | ${BEGIN}\r | |
496 | EFI_STATUS\r | |
497 | EFIAPI\r | |
498 | ${Function} (\r | |
499 | IN EFI_HANDLE ImageHandle,\r | |
500 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
501 | );\r | |
502 | ${END}\r | |
503 | """)\r | |
504 | \r | |
505 | gUefiApplicationEntryPointString = [\r | |
506 | TemplateString("""\r | |
507 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
508 | \r | |
509 | EFI_STATUS\r | |
510 | EFIAPI\r | |
511 | ProcessModuleEntryPointList (\r | |
512 | IN EFI_HANDLE ImageHandle,\r | |
513 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
514 | )\r | |
515 | {\r | |
516 | return EFI_SUCCESS;\r | |
517 | }\r | |
518 | """),\r | |
519 | TemplateString("""\r | |
520 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
521 | \r | |
522 | ${BEGIN}\r | |
523 | EFI_STATUS\r | |
524 | EFIAPI\r | |
525 | ProcessModuleEntryPointList (\r | |
526 | IN EFI_HANDLE ImageHandle,\r | |
527 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
528 | )\r | |
529 | \r | |
530 | {\r | |
531 | return ${Function} (ImageHandle, SystemTable);\r | |
532 | }\r | |
533 | ${END}\r | |
534 | VOID\r | |
535 | EFIAPI\r | |
536 | ExitDriver (\r | |
537 | IN EFI_STATUS Status\r | |
538 | )\r | |
539 | {\r | |
540 | if (EFI_ERROR (Status)) {\r | |
541 | ProcessLibraryDestructorList (gImageHandle, gST);\r | |
542 | }\r | |
543 | gBS->Exit (gImageHandle, Status, 0, NULL);\r | |
544 | }\r | |
545 | """),\r | |
546 | TemplateString("""\r | |
547 | const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r | |
548 | \r | |
549 | EFI_STATUS\r | |
550 | EFIAPI\r | |
551 | ProcessModuleEntryPointList (\r | |
552 | IN EFI_HANDLE ImageHandle,\r | |
553 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
554 | )\r | |
555 | \r | |
556 | {\r | |
557 | ${BEGIN}\r | |
558 | if (SetJump (&mJumpContext) == 0) {\r | |
559 | ExitDriver (${Function} (ImageHandle, SystemTable));\r | |
560 | ASSERT (FALSE);\r | |
561 | }\r | |
562 | ${END}\r | |
563 | return mDriverEntryPointStatus;\r | |
564 | }\r | |
565 | \r | |
566 | static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r | |
567 | static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r | |
568 | \r | |
569 | VOID\r | |
570 | EFIAPI\r | |
571 | ExitDriver (\r | |
572 | IN EFI_STATUS Status\r | |
573 | )\r | |
574 | {\r | |
575 | if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r | |
576 | mDriverEntryPointStatus = Status;\r | |
577 | }\r | |
578 | LongJump (&mJumpContext, (UINTN)-1);\r | |
579 | ASSERT (FALSE);\r | |
580 | }\r | |
581 | """)\r | |
582 | ]\r | |
583 | \r | |
584 | ## UEFI Unload Image Templates\r | |
585 | gUefiUnloadImagePrototype = TemplateString("""\r | |
586 | ${BEGIN}\r | |
587 | EFI_STATUS\r | |
588 | EFIAPI\r | |
589 | ${Function} (\r | |
590 | IN EFI_HANDLE ImageHandle\r | |
591 | );\r | |
592 | ${END}\r | |
593 | """)\r | |
594 | \r | |
595 | gUefiUnloadImageString = [\r | |
596 | TemplateString("""\r | |
597 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
598 | \r | |
599 | EFI_STATUS\r | |
600 | EFIAPI\r | |
601 | ProcessModuleUnloadList (\r | |
602 | IN EFI_HANDLE ImageHandle\r | |
603 | )\r | |
604 | {\r | |
605 | return EFI_SUCCESS;\r | |
606 | }\r | |
607 | """),\r | |
608 | TemplateString("""\r | |
609 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
610 | \r | |
611 | ${BEGIN}\r | |
612 | EFI_STATUS\r | |
613 | EFIAPI\r | |
614 | ProcessModuleUnloadList (\r | |
615 | IN EFI_HANDLE ImageHandle\r | |
616 | )\r | |
617 | {\r | |
618 | return ${Function} (ImageHandle);\r | |
619 | }\r | |
620 | ${END}\r | |
621 | """),\r | |
622 | TemplateString("""\r | |
623 | GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r | |
624 | \r | |
625 | EFI_STATUS\r | |
626 | EFIAPI\r | |
627 | ProcessModuleUnloadList (\r | |
628 | IN EFI_HANDLE ImageHandle\r | |
629 | )\r | |
630 | {\r | |
631 | EFI_STATUS Status;\r | |
632 | \r | |
633 | Status = EFI_SUCCESS;\r | |
634 | ${BEGIN}\r | |
635 | if (EFI_ERROR (Status)) {\r | |
636 | ${Function} (ImageHandle);\r | |
637 | } else {\r | |
638 | Status = ${Function} (ImageHandle);\r | |
639 | }\r | |
640 | ${END}\r | |
641 | return Status;\r | |
642 | }\r | |
643 | """)\r | |
644 | ]\r | |
645 | \r | |
646 | gLibraryStructorPrototype = {\r | |
8bb63e37 | 647 | SUP_MODULE_BASE : TemplateString("""${BEGIN}\r |
f51461c8 LG |
648 | RETURN_STATUS\r |
649 | EFIAPI\r | |
650 | ${Function} (\r | |
651 | VOID\r | |
652 | );${END}\r | |
653 | """),\r | |
654 | \r | |
655 | 'PEI' : TemplateString("""${BEGIN}\r | |
656 | EFI_STATUS\r | |
657 | EFIAPI\r | |
658 | ${Function} (\r | |
659 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
660 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
661 | );${END}\r | |
662 | """),\r | |
663 | \r | |
664 | 'DXE' : TemplateString("""${BEGIN}\r | |
665 | EFI_STATUS\r | |
666 | EFIAPI\r | |
667 | ${Function} (\r | |
668 | IN EFI_HANDLE ImageHandle,\r | |
669 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
670 | );${END}\r | |
671 | """),\r | |
5a9c3e3e SV |
672 | \r |
673 | 'MM' : TemplateString("""${BEGIN}\r | |
674 | EFI_STATUS\r | |
675 | EFIAPI\r | |
676 | ${Function} (\r | |
677 | IN EFI_HANDLE ImageHandle,\r | |
678 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
679 | );${END}\r | |
680 | """),\r | |
f51461c8 LG |
681 | }\r |
682 | \r | |
683 | gLibraryStructorCall = {\r | |
8bb63e37 | 684 | SUP_MODULE_BASE : TemplateString("""${BEGIN}\r |
f51461c8 LG |
685 | Status = ${Function} ();\r |
686 | ASSERT_EFI_ERROR (Status);${END}\r | |
687 | """),\r | |
688 | \r | |
689 | 'PEI' : TemplateString("""${BEGIN}\r | |
690 | Status = ${Function} (FileHandle, PeiServices);\r | |
691 | ASSERT_EFI_ERROR (Status);${END}\r | |
692 | """),\r | |
693 | \r | |
694 | 'DXE' : TemplateString("""${BEGIN}\r | |
695 | Status = ${Function} (ImageHandle, SystemTable);\r | |
696 | ASSERT_EFI_ERROR (Status);${END}\r | |
697 | """),\r | |
5a9c3e3e SV |
698 | \r |
699 | 'MM' : TemplateString("""${BEGIN}\r | |
700 | Status = ${Function} (ImageHandle, MmSystemTable);\r | |
701 | ASSERT_EFI_ERROR (Status);${END}\r | |
702 | """),\r | |
f51461c8 LG |
703 | }\r |
704 | \r | |
705 | ## Library Constructor and Destructor Templates\r | |
706 | gLibraryString = {\r | |
8bb63e37 | 707 | SUP_MODULE_BASE : TemplateString("""\r |
f51461c8 LG |
708 | ${BEGIN}${FunctionPrototype}${END}\r |
709 | \r | |
710 | VOID\r | |
711 | EFIAPI\r | |
712 | ProcessLibrary${Type}List (\r | |
713 | VOID\r | |
714 | )\r | |
715 | {\r | |
716 | ${BEGIN} EFI_STATUS Status;\r | |
717 | ${FunctionCall}${END}\r | |
718 | }\r | |
719 | """),\r | |
720 | \r | |
721 | 'PEI' : TemplateString("""\r | |
722 | ${BEGIN}${FunctionPrototype}${END}\r | |
723 | \r | |
724 | VOID\r | |
725 | EFIAPI\r | |
726 | ProcessLibrary${Type}List (\r | |
727 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
728 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
729 | )\r | |
730 | {\r | |
731 | ${BEGIN} EFI_STATUS Status;\r | |
732 | ${FunctionCall}${END}\r | |
733 | }\r | |
734 | """),\r | |
735 | \r | |
736 | 'DXE' : TemplateString("""\r | |
737 | ${BEGIN}${FunctionPrototype}${END}\r | |
738 | \r | |
739 | VOID\r | |
740 | EFIAPI\r | |
741 | ProcessLibrary${Type}List (\r | |
742 | IN EFI_HANDLE ImageHandle,\r | |
743 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
744 | )\r | |
745 | {\r | |
746 | ${BEGIN} EFI_STATUS Status;\r | |
747 | ${FunctionCall}${END}\r | |
748 | }\r | |
749 | """),\r | |
5a9c3e3e SV |
750 | \r |
751 | 'MM' : TemplateString("""\r | |
752 | ${BEGIN}${FunctionPrototype}${END}\r | |
753 | \r | |
754 | VOID\r | |
755 | EFIAPI\r | |
756 | ProcessLibrary${Type}List (\r | |
757 | IN EFI_HANDLE ImageHandle,\r | |
758 | IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r | |
759 | )\r | |
760 | {\r | |
761 | ${BEGIN} EFI_STATUS Status;\r | |
762 | ${FunctionCall}${END}\r | |
763 | }\r | |
764 | """),\r | |
f51461c8 LG |
765 | }\r |
766 | \r | |
767 | gBasicHeaderFile = "Base.h"\r | |
768 | \r | |
769 | gModuleTypeHeaderFile = {\r | |
8bb63e37 CJ |
770 | SUP_MODULE_BASE : [gBasicHeaderFile],\r |
771 | SUP_MODULE_SEC : ["PiPei.h", "Library/DebugLib.h"],\r | |
772 | SUP_MODULE_PEI_CORE : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],\r | |
773 | SUP_MODULE_PEIM : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],\r | |
774 | SUP_MODULE_DXE_CORE : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],\r | |
775 | SUP_MODULE_DXE_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
776 | SUP_MODULE_DXE_SMM_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
777 | SUP_MODULE_DXE_RUNTIME_DRIVER: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
778 | SUP_MODULE_DXE_SAL_DRIVER : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
779 | SUP_MODULE_UEFI_DRIVER : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
780 | SUP_MODULE_UEFI_APPLICATION : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],\r | |
781 | SUP_MODULE_SMM_CORE : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],\r | |
782 | SUP_MODULE_MM_STANDALONE : ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmDriverStandaloneEntryPoint.h"],\r | |
783 | SUP_MODULE_MM_CORE_STANDALONE : ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmCoreStandaloneEntryPoint.h"],\r | |
784 | SUP_MODULE_USER_DEFINED : [gBasicHeaderFile]\r | |
f51461c8 LG |
785 | }\r |
786 | \r | |
787 | ## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName \r | |
788 | # the TokenName and Guid comparison to avoid define name collisions.\r | |
789 | #\r | |
790 | # @param Info The ModuleAutoGen object\r | |
791 | # @param AutoGenH The TemplateString object for header file\r | |
792 | #\r | |
793 | #\r | |
794 | def DynExPcdTokenNumberMapping(Info, AutoGenH):\r | |
795 | ExTokenCNameList = []\r | |
796 | PcdExList = []\r | |
d590cce5 YZ |
797 | # Even it is the Library, the PCD is saved in the ModulePcdList\r |
798 | PcdList = Info.ModulePcdList\r | |
f51461c8 | 799 | for Pcd in PcdList:\r |
eece4292 | 800 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
801 | ExTokenCNameList.append(Pcd.TokenCName)\r |
802 | PcdExList.append(Pcd)\r | |
803 | if len(ExTokenCNameList) == 0:\r | |
804 | return\r | |
805 | AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')\r | |
806 | # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.\r | |
807 | # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter. \r | |
808 | # Use the Guid pointer to see if it matches any of the token space GUIDs.\r | |
72fbe88d | 809 | TokenCNameList = set()\r |
f51461c8 LG |
810 | for TokenCName in ExTokenCNameList:\r |
811 | if TokenCName in TokenCNameList:\r | |
812 | continue\r | |
813 | Index = 0\r | |
814 | Count = ExTokenCNameList.count(TokenCName)\r | |
815 | for Pcd in PcdExList:\r | |
2a29017e YZ |
816 | RealTokenCName = Pcd.TokenCName\r |
817 | for PcdItem in GlobalData.MixedPcd:\r | |
818 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
819 | RealTokenCName = PcdItem[0]\r | |
820 | break\r | |
f51461c8 LG |
821 | if Pcd.TokenCName == TokenCName:\r |
822 | Index = Index + 1\r | |
823 | if Index == 1:\r | |
2a29017e | 824 | AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (RealTokenCName))\r |
f51461c8 | 825 | AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r |
2a29017e | 826 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
827 | else:\r |
828 | AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r | |
2a29017e | 829 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
830 | if Index == Count:\r |
831 | AutoGenH.Append('0 \\\n )\n')\r | |
72fbe88d | 832 | TokenCNameList.add(TokenCName)\r |
f51461c8 | 833 | \r |
72fbe88d | 834 | TokenCNameList = set()\r |
f51461c8 LG |
835 | for TokenCName in ExTokenCNameList:\r |
836 | if TokenCName in TokenCNameList:\r | |
837 | continue\r | |
838 | Index = 0\r | |
839 | Count = ExTokenCNameList.count(TokenCName)\r | |
840 | for Pcd in PcdExList:\r | |
2a29017e YZ |
841 | RealTokenCName = Pcd.TokenCName\r |
842 | for PcdItem in GlobalData.MixedPcd:\r | |
843 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
844 | RealTokenCName = PcdItem[0]\r | |
845 | break\r | |
eece4292 | 846 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == TokenCName:\r |
f51461c8 LG |
847 | Index = Index + 1\r |
848 | if Index == 1:\r | |
2a29017e | 849 | AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (RealTokenCName))\r |
9023704f | 850 | AutoGenH.Append('\\\n (GuidPtr == NULL) ? 0:')\r |
f51461c8 | 851 | AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r |
2a29017e | 852 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
853 | else:\r |
854 | AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r | |
2a29017e | 855 | % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r |
f51461c8 LG |
856 | if Index == Count:\r |
857 | AutoGenH.Append('0 \\\n )\n')\r | |
858 | # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID. \r | |
859 | # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler\r | |
860 | # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().\r | |
861 | # COMPAREGUID() will only be used if the Guid passed in is local to the module.\r | |
862 | AutoGenH.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'\r | |
2a29017e | 863 | % (RealTokenCName, RealTokenCName, RealTokenCName, RealTokenCName))\r |
72fbe88d | 864 | TokenCNameList.add(TokenCName)\r |
f51461c8 LG |
865 | \r |
866 | ## Create code for module PCDs\r | |
867 | #\r | |
868 | # @param Info The ModuleAutoGen object\r | |
869 | # @param AutoGenC The TemplateString object for C code\r | |
870 | # @param AutoGenH The TemplateString object for header file\r | |
871 | # @param Pcd The PCD object\r | |
872 | #\r | |
873 | def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):\r | |
874 | TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[Pcd.TokenSpaceGuidCName]\r | |
875 | PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r | |
2a29017e YZ |
876 | #\r |
877 | # Write PCDs\r | |
878 | #\r | |
879 | TokenCName = Pcd.TokenCName\r | |
880 | for PcdItem in GlobalData.MixedPcd:\r | |
881 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
882 | TokenCName = PcdItem[0]\r | |
883 | break\r | |
884 | PcdTokenName = '_PCD_TOKEN_' + TokenCName\r | |
885 | PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r | |
886 | PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r | |
f7b31aa5 | 887 | PatchPcdMaxSizeVariable = '_gPcd_BinaryPatch_MaxSize_' + TokenCName\r |
2a29017e | 888 | FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r |
1bfcf64f | 889 | FixedPcdSizeVariableName = '_gPcd_FixedAtBuild_Size_' + TokenCName\r |
763e8edf | 890 | \r |
0f228f19 B |
891 | if Pcd.PcdValueFromComm:\r |
892 | Pcd.DefaultValue = Pcd.PcdValueFromComm\r | |
2f5acc3b | 893 | \r |
eece4292 | 894 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
895 | TokenNumber = int(Pcd.TokenValue, 0)\r |
896 | # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with \r | |
897 | # different Guids but same TokenCName\r | |
2a29017e | 898 | PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + TokenCName\r |
f51461c8 LG |
899 | AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r |
900 | else:\r | |
901 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r | |
902 | # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r | |
903 | # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r | |
904 | # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r | |
905 | # report warning message notify the PI that they are attempting to build a module \r | |
906 | # that must be included in a flash image in order to be functional. These Dynamic PCD \r | |
907 | # will not be added into the Database unless it is used by other modules that are \r | |
908 | # included in the FDF file. \r | |
909 | # In this case, just assign an invalid token number to make it pass build.\r | |
eece4292 | 910 | if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
f51461c8 LG |
911 | TokenNumber = 0\r |
912 | else:\r | |
913 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 914 | "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
915 | ExtraData="[%s]" % str(Info))\r |
916 | else:\r | |
917 | TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r | |
918 | AutoGenH.Append('\n#define %s %dU\n' % (PcdTokenName, TokenNumber))\r | |
919 | \r | |
2a29017e | 920 | EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + TokenCName + "." + Pcd.TokenSpaceGuidCName)\r |
f51461c8 LG |
921 | if Pcd.Type not in gItemTypeStringDatabase:\r |
922 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 923 | "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 924 | ExtraData="[%s]" % str(Info))\r |
f51461c8 | 925 | \r |
656d2539 CJ |
926 | DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase[TAB_VOID]\r |
927 | DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib[TAB_VOID]\r | |
928 | GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
929 | SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
930 | SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_S_' + TokenCName\r | |
2a29017e | 931 | GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r |
2f5acc3b | 932 | \r |
eece4292 | 933 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
934 | if Info.IsLibrary:\r |
935 | PcdList = Info.LibraryPcdList\r | |
936 | else:\r | |
937 | PcdList = Info.ModulePcdList\r | |
72fbe88d | 938 | PcdExCNameTest = 0\r |
f51461c8 | 939 | for PcdModule in PcdList:\r |
eece4292 | 940 | if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
941 | PcdExCNameTest += 1\r |
942 | # get out early once we found > 1...\r | |
943 | if PcdExCNameTest > 1:\r | |
944 | break\r | |
f51461c8 LG |
945 | # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r |
946 | # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r | |
947 | # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r | |
72fbe88d | 948 | if PcdExCNameTest > 1:\r |
f51461c8 LG |
949 | AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r |
950 | AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
951 | AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
38b986e3 | 952 | AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 953 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 954 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 955 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
956 | else:\r |
957 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 958 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
959 | else:\r |
960 | AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
961 | AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
2f5acc3b | 962 | AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 963 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 964 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 965 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
966 | else:\r |
967 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 968 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
eece4292 | 969 | elif Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
72fbe88d CJ |
970 | PcdCNameTest = 0\r |
971 | for PcdModule in Info.LibraryPcdList + Info.ModulePcdList:\r | |
eece4292 | 972 | if PcdModule.Type in PCD_DYNAMIC_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
973 | PcdCNameTest += 1\r |
974 | # get out early once we found > 1...\r | |
975 | if PcdCNameTest > 1:\r | |
976 | break\r | |
977 | if PcdCNameTest > 1:\r | |
2a29017e | 978 | EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName. They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r |
f51461c8 | 979 | else:\r |
38b986e3 YZ |
980 | AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r |
981 | AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r | |
656d2539 | 982 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
38b986e3 YZ |
983 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r |
984 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
985 | else:\r | |
986 | AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r | |
987 | AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
f51461c8 | 988 | else:\r |
2a29017e | 989 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r |
f51461c8 LG |
990 | Const = 'const'\r |
991 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
992 | Const = ''\r | |
993 | Type = ''\r | |
994 | Array = ''\r | |
995 | Value = Pcd.DefaultValue\r | |
996 | Unicode = False\r | |
997 | ValueNumber = 0\r | |
998 | \r | |
999 | if Pcd.DatumType == 'BOOLEAN':\r | |
1000 | BoolValue = Value.upper()\r | |
1001 | if BoolValue == 'TRUE' or BoolValue == '1':\r | |
1002 | Value = '1U'\r | |
1003 | elif BoolValue == 'FALSE' or BoolValue == '0':\r | |
1004 | Value = '0U'\r | |
1005 | \r | |
656d2539 | 1006 | if Pcd.DatumType in TAB_PCD_CLEAN_NUMERIC_TYPES:\r |
f51461c8 | 1007 | try:\r |
726c501c YZ |
1008 | if Value.upper().endswith('L'):\r |
1009 | Value = Value[:-1]\r | |
0944818a | 1010 | ValueNumber = int (Value, 0)\r |
f51461c8 LG |
1011 | except:\r |
1012 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1013 | "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 1014 | ExtraData="[%s]" % str(Info))\r |
656d2539 | 1015 | if Pcd.DatumType == TAB_UINT64:\r |
f51461c8 LG |
1016 | if ValueNumber < 0:\r |
1017 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1018 | "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1019 | ExtraData="[%s]" % str(Info))\r |
1020 | elif ValueNumber >= 0x10000000000000000:\r | |
1021 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1022 | "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1023 | ExtraData="[%s]" % str(Info))\r |
1024 | if not Value.endswith('ULL'):\r | |
1025 | Value += 'ULL'\r | |
656d2539 | 1026 | elif Pcd.DatumType == TAB_UINT32:\r |
f51461c8 LG |
1027 | if ValueNumber < 0:\r |
1028 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1029 | "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1030 | ExtraData="[%s]" % str(Info))\r |
1031 | elif ValueNumber >= 0x100000000:\r | |
1032 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1033 | "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1034 | ExtraData="[%s]" % str(Info))\r |
1035 | if not Value.endswith('U'):\r | |
1036 | Value += 'U'\r | |
656d2539 | 1037 | elif Pcd.DatumType == TAB_UINT16:\r |
f51461c8 LG |
1038 | if ValueNumber < 0:\r |
1039 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1040 | "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1041 | ExtraData="[%s]" % str(Info))\r |
1042 | elif ValueNumber >= 0x10000:\r | |
1043 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1044 | "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1045 | ExtraData="[%s]" % str(Info))\r |
1046 | if not Value.endswith('U'):\r | |
1047 | Value += 'U' \r | |
656d2539 | 1048 | elif Pcd.DatumType == TAB_UINT8:\r |
f51461c8 LG |
1049 | if ValueNumber < 0:\r |
1050 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1051 | "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1052 | ExtraData="[%s]" % str(Info))\r |
1053 | elif ValueNumber >= 0x100:\r | |
1054 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1055 | "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1056 | ExtraData="[%s]" % str(Info))\r |
1057 | if not Value.endswith('U'):\r | |
1058 | Value += 'U'\r | |
656d2539 | 1059 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
6b285ca3 | 1060 | if not Pcd.MaxDatumSize:\r |
f51461c8 | 1061 | EdkLogger.error("build", AUTOGEN_ERROR,\r |
2a29017e | 1062 | "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1063 | ExtraData="[%s]" % str(Info))\r |
1064 | \r | |
1065 | ArraySize = int(Pcd.MaxDatumSize, 0)\r | |
1066 | if Value[0] == '{':\r | |
1067 | Type = '(VOID *)'\r | |
6b285ca3 | 1068 | ValueSize = len(Value.split(','))\r |
f51461c8 LG |
1069 | else:\r |
1070 | if Value[0] == 'L':\r | |
1071 | Unicode = True\r | |
1072 | Value = Value.lstrip('L') #.strip('"')\r | |
1073 | Value = eval(Value) # translate escape character\r | |
6b285ca3 | 1074 | ValueSize = len(Value) + 1\r |
f51461c8 LG |
1075 | NewValue = '{'\r |
1076 | for Index in range(0,len(Value)):\r | |
1077 | if Unicode:\r | |
1078 | NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r | |
1079 | else:\r | |
1080 | NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r | |
1081 | if Unicode:\r | |
6b285ca3 | 1082 | ArraySize = ArraySize / 2\r |
f51461c8 | 1083 | Value = NewValue + '0 }'\r |
6b285ca3 YF |
1084 | if ArraySize < ValueSize:\r |
1085 | if Pcd.MaxSizeUserSet:\r | |
1086 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1087 | "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName),\r | |
1088 | ExtraData="[%s]" % str(Info))\r | |
1089 | else:\r | |
1090 | ArraySize = Pcd.GetPcdSize()\r | |
1091 | if Unicode:\r | |
1092 | ArraySize = ArraySize / 2\r | |
f51461c8 LG |
1093 | Array = '[%d]' % ArraySize\r |
1094 | #\r | |
1095 | # skip casting for fixed at build since it breaks ARM assembly.\r | |
1096 | # Long term we need PCD macros that work in assembly\r | |
1097 | #\r | |
656d2539 | 1098 | elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD and Pcd.DatumType in TAB_PCD_NUMERIC_TYPES_VOID:\r |
f51461c8 LG |
1099 | Value = "((%s)%s)" % (Pcd.DatumType, Value)\r |
1100 | \r | |
1101 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
2a29017e | 1102 | PcdValueName = '_PCD_PATCHABLE_VALUE_' + TokenCName\r |
f51461c8 | 1103 | else:\r |
2a29017e | 1104 | PcdValueName = '_PCD_VALUE_' + TokenCName\r |
f51461c8 | 1105 | \r |
656d2539 | 1106 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 LG |
1107 | #\r |
1108 | # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r | |
1109 | #\r | |
674e2014 | 1110 | AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r |
f51461c8 | 1111 | if Unicode:\r |
f51461c8 LG |
1112 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r |
1113 | AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))\r | |
f51461c8 | 1114 | else:\r |
f51461c8 LG |
1115 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r |
1116 | AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r | |
674e2014 | 1117 | AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r |
2f5acc3b | 1118 | \r |
5565a8c4 | 1119 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b BF |
1120 | if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r |
1121 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
1122 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r | |
1bfcf64f | 1123 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName,PcdDataSize))\r |
2f5acc3b BF |
1124 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
1125 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, Pcd.MaxDatumSize))\r | |
1126 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r | |
1127 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r | |
1128 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r | |
f7b31aa5 | 1129 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable,Pcd.MaxDatumSize))\r |
f51461c8 LG |
1130 | elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
1131 | AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r | |
1132 | AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r | |
1133 | AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r | |
1134 | AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r | |
2f5acc3b | 1135 | \r |
5565a8c4 | 1136 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b BF |
1137 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r |
1138 | \r | |
1139 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r | |
1140 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r | |
1141 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r | |
f51461c8 | 1142 | else:\r |
5565a8c4 | 1143 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b BF |
1144 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r |
1145 | AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r | |
1146 | \r | |
f51461c8 LG |
1147 | AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r |
1148 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r | |
1149 | AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r | |
1150 | AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r | |
1151 | \r | |
1152 | if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r | |
656d2539 | 1153 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
e70504cd LG |
1154 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r |
1155 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r | |
f51461c8 LG |
1156 | else:\r |
1157 | AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r | |
82a6a960 | 1158 | AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName, PcdVariableName))\r |
f51461c8 LG |
1159 | else:\r |
1160 | AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r | |
1161 | \r | |
1162 | ## Create code for library module PCDs\r | |
1163 | #\r | |
1164 | # @param Info The ModuleAutoGen object\r | |
1165 | # @param AutoGenC The TemplateString object for C code\r | |
1166 | # @param AutoGenH The TemplateString object for header file\r | |
1167 | # @param Pcd The PCD object\r | |
1168 | #\r | |
1169 | def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r | |
1170 | PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r | |
1171 | TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r | |
1172 | TokenCName = Pcd.TokenCName\r | |
2a29017e YZ |
1173 | for PcdItem in GlobalData.MixedPcd:\r |
1174 | if (TokenCName, TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
1175 | TokenCName = PcdItem[0]\r | |
1176 | break\r | |
f51461c8 | 1177 | PcdTokenName = '_PCD_TOKEN_' + TokenCName\r |
2a29017e YZ |
1178 | FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r |
1179 | PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r | |
1180 | PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r | |
f7b31aa5 | 1181 | PatchPcdMaxSizeVariable = '_gPcd_BinaryPatch_MaxSize_' + TokenCName\r |
1bfcf64f | 1182 | FixedPcdSizeVariableName = '_gPcd_FixedAtBuild_Size_' + TokenCName\r |
763e8edf | 1183 | \r |
0f228f19 B |
1184 | if Pcd.PcdValueFromComm:\r |
1185 | Pcd.DefaultValue = Pcd.PcdValueFromComm\r | |
f51461c8 LG |
1186 | #\r |
1187 | # Write PCDs\r | |
1188 | #\r | |
eece4292 | 1189 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET:\r |
f51461c8 LG |
1190 | TokenNumber = int(Pcd.TokenValue, 0)\r |
1191 | else:\r | |
1192 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r | |
1193 | # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r | |
1194 | # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r | |
1195 | # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r | |
1196 | # report warning message notify the PI that they are attempting to build a module \r | |
1197 | # that must be included in a flash image in order to be functional. These Dynamic PCD \r | |
1198 | # will not be added into the Database unless it is used by other modules that are \r | |
1199 | # included in the FDF file. \r | |
1200 | # In this case, just assign an invalid token number to make it pass build.\r | |
eece4292 | 1201 | if Pcd.Type in PCD_DYNAMIC_TYPE_SET:\r |
f51461c8 LG |
1202 | TokenNumber = 0\r |
1203 | else:\r | |
1204 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1205 | "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 LG |
1206 | ExtraData="[%s]" % str(Info))\r |
1207 | else:\r | |
1208 | TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r | |
1209 | \r | |
1210 | if Pcd.Type not in gItemTypeStringDatabase:\r | |
1211 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
2a29017e | 1212 | "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r |
f51461c8 | 1213 | ExtraData="[%s]" % str(Info))\r |
f51461c8 LG |
1214 | \r |
1215 | DatumType = Pcd.DatumType\r | |
656d2539 CJ |
1216 | DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase[TAB_VOID]\r |
1217 | DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib[TAB_VOID]\r | |
1218 | GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
1219 | SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_' + TokenCName\r | |
1220 | SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[TAB_VOID] + '_S_' + TokenCName\r | |
2a29017e | 1221 | GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r |
f51461c8 LG |
1222 | \r |
1223 | Type = ''\r | |
1224 | Array = ''\r | |
656d2539 | 1225 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
d66670f9 YZ |
1226 | if Pcd.DefaultValue[0]== '{':\r |
1227 | Type = '(VOID *)'\r | |
f51461c8 LG |
1228 | Array = '[]'\r |
1229 | PcdItemType = Pcd.Type\r | |
eece4292 | 1230 | if PcdItemType in PCD_DYNAMIC_EX_TYPE_SET:\r |
2a29017e | 1231 | PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + TokenCName\r |
f51461c8 LG |
1232 | AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r |
1233 | \r | |
1234 | if Info.IsLibrary:\r | |
1235 | PcdList = Info.LibraryPcdList\r | |
1236 | else:\r | |
1237 | PcdList = Info.ModulePcdList\r | |
72fbe88d | 1238 | PcdExCNameTest = 0\r |
f51461c8 | 1239 | for PcdModule in PcdList:\r |
eece4292 | 1240 | if PcdModule.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenCName == PcdModule.TokenCName:\r |
72fbe88d CJ |
1241 | PcdExCNameTest += 1\r |
1242 | # get out early once we found > 1...\r | |
1243 | if PcdExCNameTest > 1:\r | |
1244 | break\r | |
f51461c8 LG |
1245 | # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r |
1246 | # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r | |
1247 | # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r | |
72fbe88d | 1248 | if PcdExCNameTest > 1:\r |
f51461c8 LG |
1249 | AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r |
1250 | AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
1251 | AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
d590cce5 | 1252 | AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 1253 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 1254 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 1255 | AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1256 | else:\r |
1257 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 1258 | AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1259 | else:\r |
1260 | AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r | |
1261 | AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
2f5acc3b | 1262 | AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
656d2539 | 1263 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f51461c8 | 1264 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
82a6a960 | 1265 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1266 | else:\r |
1267 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r | |
82a6a960 | 1268 | AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r |
f51461c8 LG |
1269 | else:\r |
1270 | AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r | |
eece4292 | 1271 | if PcdItemType in PCD_DYNAMIC_TYPE_SET:\r |
38b986e3 YZ |
1272 | PcdList = []\r |
1273 | PcdCNameList = []\r | |
1274 | PcdList.extend(Info.LibraryPcdList)\r | |
1275 | PcdList.extend(Info.ModulePcdList)\r | |
1276 | for PcdModule in PcdList:\r | |
eece4292 | 1277 | if PcdModule.Type in PCD_DYNAMIC_TYPE_SET:\r |
38b986e3 YZ |
1278 | PcdCNameList.append(PcdModule.TokenCName)\r |
1279 | if PcdCNameList.count(Pcd.TokenCName) > 1:\r | |
2a29017e | 1280 | EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r |
f51461c8 | 1281 | else:\r |
38b986e3 YZ |
1282 | AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r |
1283 | AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r | |
656d2539 | 1284 | if DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
38b986e3 YZ |
1285 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r |
1286 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
1287 | else:\r | |
1288 | AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r | |
1289 | AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r | |
f51461c8 | 1290 | if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r |
f7b31aa5 | 1291 | GetModeMaxSizeName = '_PCD_GET_MODE_MAXSIZE' + '_' + TokenCName\r |
f51461c8 | 1292 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r |
656d2539 CJ |
1293 | if DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
1294 | if DatumType == TAB_VOID and Array == '[]':\r | |
1295 | DatumType = [TAB_UINT8, TAB_UINT16][Pcd.DefaultValue[0] == 'L']\r | |
f7b31aa5 | 1296 | else:\r |
656d2539 | 1297 | DatumType = TAB_UINT8\r |
d66670f9 YZ |
1298 | AutoGenH.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array))\r |
1299 | else:\r | |
1300 | AutoGenH.Append('extern volatile %s %s%s;\n' % (DatumType, PcdVariableName, Array))\r | |
f51461c8 | 1301 | AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r |
5565a8c4 | 1302 | PcdDataSize = Pcd.GetPcdSize()\r |
656d2539 | 1303 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
f7b31aa5 YZ |
1304 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r |
1305 | AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, TokenCName, PatchPcdSizeVariableName, PatchPcdMaxSizeVariable))\r | |
1306 | AutoGenH.Append('#define %s %s\n' % (GetModeMaxSizeName, PatchPcdMaxSizeVariable))\r | |
1307 | AutoGenH.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable)\r | |
27187d24 LG |
1308 | else:\r |
1309 | AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r | |
1310 | AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName, PcdVariableName))\r | |
a6c31c6d YZ |
1311 | AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r |
1312 | \r | |
2f5acc3b BF |
1313 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,PatchPcdSizeVariableName))\r |
1314 | AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r | |
1315 | \r | |
f51461c8 LG |
1316 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r |
1317 | key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r | |
7256bd55 | 1318 | PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r |
656d2539 CJ |
1319 | if DatumType == TAB_VOID and Array == '[]':\r |
1320 | DatumType = [TAB_UINT8, TAB_UINT16][Pcd.DefaultValue[0] == 'L']\r | |
1321 | if DatumType not in TAB_PCD_NUMERIC_TYPES_VOID:\r | |
1322 | DatumType = TAB_UINT8\r | |
f51461c8 LG |
1323 | AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r |
1324 | AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r | |
1325 | AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r | |
1326 | \r | |
1bfcf64f | 1327 | ConstFixedPcd = False\r |
c9da41b2 | 1328 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and (key in Info.ConstPcd or (Info.IsLibrary and not Info._ReferenceModules)):\r |
1bfcf64f | 1329 | ConstFixedPcd = True\r |
eca980c0 YZ |
1330 | if key in Info.ConstPcd:\r |
1331 | Pcd.DefaultValue = Info.ConstPcd[key]\r | |
656d2539 | 1332 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
7256bd55 YZ |
1333 | AutoGenH.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName, Type, PcdVariableName))\r |
1334 | else:\r | |
1335 | AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r | |
5565a8c4 | 1336 | PcdDataSize = Pcd.GetPcdSize()\r |
2f5acc3b | 1337 | if PcdItemType == TAB_PCDS_FIXED_AT_BUILD:\r |
656d2539 | 1338 | if Pcd.DatumType not in TAB_PCD_NUMERIC_TYPES:\r |
1bfcf64f YZ |
1339 | if ConstFixedPcd:\r |
1340 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
1341 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,FixPcdSizeTokenName))\r | |
1342 | else:\r | |
1343 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,FixedPcdSizeVariableName))\r | |
1344 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName,FixedPcdSizeVariableName))\r | |
1345 | AutoGenH.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName)\r | |
1346 | else:\r | |
1347 | AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r | |
1348 | AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,FixPcdSizeTokenName))\r | |
f51461c8 LG |
1349 | \r |
1350 | ## Create code for library constructor\r | |
1351 | #\r | |
1352 | # @param Info The ModuleAutoGen object\r | |
1353 | # @param AutoGenC The TemplateString object for C code\r | |
1354 | # @param AutoGenH The TemplateString object for header file\r | |
1355 | #\r | |
1356 | def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r | |
1357 | #\r | |
1358 | # Library Constructors\r | |
1359 | #\r | |
1360 | ConstructorPrototypeString = TemplateString()\r | |
1361 | ConstructorCallingString = TemplateString()\r | |
1362 | if Info.IsLibrary:\r | |
1363 | DependentLibraryList = [Info.Module]\r | |
1364 | else:\r | |
1365 | DependentLibraryList = Info.DependentLibraryList\r | |
1366 | for Lib in DependentLibraryList:\r | |
1367 | if len(Lib.ConstructorList) <= 0:\r | |
1368 | continue\r | |
1369 | Dict = {'Function':Lib.ConstructorList}\r | |
8bb63e37 CJ |
1370 | if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1371 | ConstructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r | |
1372 | ConstructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1373 | elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 LG |
1374 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r |
1375 | ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r | |
8bb63e37 CJ |
1376 | elif Lib.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1377 | SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION,SUP_MODULE_SMM_CORE]:\r | |
f51461c8 LG |
1378 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r |
1379 | ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r | |
8bb63e37 | 1380 | elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE,SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e SV |
1381 | ConstructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r |
1382 | ConstructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r | |
f51461c8 LG |
1383 | \r |
1384 | if str(ConstructorPrototypeString) == '':\r | |
1385 | ConstructorPrototypeList = []\r | |
1386 | else:\r | |
1387 | ConstructorPrototypeList = [str(ConstructorPrototypeString)]\r | |
1388 | if str(ConstructorCallingString) == '':\r | |
1389 | ConstructorCallingList = []\r | |
1390 | else:\r | |
1391 | ConstructorCallingList = [str(ConstructorCallingString)]\r | |
1392 | \r | |
1393 | Dict = {\r | |
1394 | 'Type' : 'Constructor',\r | |
1395 | 'FunctionPrototype' : ConstructorPrototypeList,\r | |
1396 | 'FunctionCall' : ConstructorCallingList\r | |
1397 | }\r | |
1398 | if Info.IsLibrary:\r | |
1399 | AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r | |
1400 | else:\r | |
8bb63e37 CJ |
1401 | if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1402 | AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1403 | elif Info.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 | 1404 | AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r |
8bb63e37 CJ |
1405 | elif Info.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1406 | SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION,SUP_MODULE_SMM_CORE]:\r | |
f51461c8 | 1407 | AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r |
8bb63e37 | 1408 | elif Info.ModuleType in [SUP_MODULE_MM_STANDALONE,SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e | 1409 | AutoGenC.Append(gLibraryString['MM'].Replace(Dict))\r |
f51461c8 LG |
1410 | \r |
1411 | ## Create code for library destructor\r | |
1412 | #\r | |
1413 | # @param Info The ModuleAutoGen object\r | |
1414 | # @param AutoGenC The TemplateString object for C code\r | |
1415 | # @param AutoGenH The TemplateString object for header file\r | |
1416 | #\r | |
1417 | def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):\r | |
1418 | #\r | |
1419 | # Library Destructors\r | |
1420 | #\r | |
1421 | DestructorPrototypeString = TemplateString()\r | |
1422 | DestructorCallingString = TemplateString()\r | |
1423 | if Info.IsLibrary:\r | |
1424 | DependentLibraryList = [Info.Module]\r | |
1425 | else:\r | |
1426 | DependentLibraryList = Info.DependentLibraryList\r | |
1427 | for Index in range(len(DependentLibraryList)-1, -1, -1):\r | |
1428 | Lib = DependentLibraryList[Index]\r | |
1429 | if len(Lib.DestructorList) <= 0:\r | |
1430 | continue\r | |
1431 | Dict = {'Function':Lib.DestructorList}\r | |
8bb63e37 CJ |
1432 | if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1433 | DestructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r | |
1434 | DestructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1435 | elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 LG |
1436 | DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r |
1437 | DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r | |
8bb63e37 CJ |
1438 | elif Lib.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1439 | SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r | |
f51461c8 LG |
1440 | DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r |
1441 | DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r | |
8bb63e37 | 1442 | elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE,SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e SV |
1443 | DestructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r |
1444 | DestructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r | |
f51461c8 LG |
1445 | \r |
1446 | if str(DestructorPrototypeString) == '':\r | |
1447 | DestructorPrototypeList = []\r | |
1448 | else:\r | |
1449 | DestructorPrototypeList = [str(DestructorPrototypeString)]\r | |
1450 | if str(DestructorCallingString) == '':\r | |
1451 | DestructorCallingList = []\r | |
1452 | else:\r | |
1453 | DestructorCallingList = [str(DestructorCallingString)]\r | |
1454 | \r | |
1455 | Dict = {\r | |
1456 | 'Type' : 'Destructor',\r | |
1457 | 'FunctionPrototype' : DestructorPrototypeList,\r | |
1458 | 'FunctionCall' : DestructorCallingList\r | |
1459 | }\r | |
1460 | if Info.IsLibrary:\r | |
1461 | AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r | |
1462 | else:\r | |
8bb63e37 CJ |
1463 | if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r |
1464 | AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r | |
88c6c1b6 | 1465 | elif Info.ModuleType in SUP_MODULE_SET_PEI:\r |
f51461c8 | 1466 | AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r |
8bb63e37 CJ |
1467 | elif Info.ModuleType in [SUP_MODULE_DXE_CORE,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SMM_DRIVER,SUP_MODULE_DXE_RUNTIME_DRIVER,\r |
1468 | SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER,SUP_MODULE_UEFI_APPLICATION,SUP_MODULE_SMM_CORE]:\r | |
f51461c8 | 1469 | AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r |
8bb63e37 | 1470 | elif Info.ModuleType in [SUP_MODULE_MM_STANDALONE,SUP_MODULE_MM_CORE_STANDALONE]:\r |
5a9c3e3e | 1471 | AutoGenC.Append(gLibraryString['MM'].Replace(Dict))\r |
f51461c8 LG |
1472 | \r |
1473 | \r | |
1474 | ## Create code for ModuleEntryPoint\r | |
1475 | #\r | |
1476 | # @param Info The ModuleAutoGen object\r | |
1477 | # @param AutoGenC The TemplateString object for C code\r | |
1478 | # @param AutoGenH The TemplateString object for header file\r | |
1479 | #\r | |
1480 | def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1481 | if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_SEC]:\r |
f51461c8 LG |
1482 | return\r |
1483 | #\r | |
1484 | # Module Entry Points\r | |
1485 | #\r | |
1486 | NumEntryPoints = len(Info.Module.ModuleEntryPointList)\r | |
1487 | if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:\r | |
1488 | PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']\r | |
1489 | else:\r | |
1490 | PiSpecVersion = '0x00000000'\r | |
1491 | if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:\r | |
1492 | UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']\r | |
1493 | else:\r | |
1494 | UefiSpecVersion = '0x00000000'\r | |
1495 | Dict = {\r | |
1496 | 'Function' : Info.Module.ModuleEntryPointList,\r | |
1497 | 'PiSpecVersion' : PiSpecVersion + 'U',\r | |
1498 | 'UefiSpecVersion': UefiSpecVersion + 'U'\r | |
1499 | }\r | |
1500 | \r | |
8bb63e37 | 1501 | if Info.ModuleType in [SUP_MODULE_PEI_CORE, SUP_MODULE_DXE_CORE, SUP_MODULE_SMM_CORE, SUP_MODULE_MM_CORE_STANDALONE]:\r |
128d435f | 1502 | if Info.SourceFileList:\r |
f51461c8 LG |
1503 | if NumEntryPoints != 1:\r |
1504 | EdkLogger.error(\r | |
1505 | "build",\r | |
1506 | AUTOGEN_ERROR,\r | |
1507 | '%s must have exactly one entry point' % Info.ModuleType,\r | |
1508 | File=str(Info),\r | |
1509 | ExtraData= ", ".join(Info.Module.ModuleEntryPointList)\r | |
1510 | )\r | |
8bb63e37 | 1511 | if Info.ModuleType == SUP_MODULE_PEI_CORE:\r |
f51461c8 LG |
1512 | AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))\r |
1513 | AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1514 | elif Info.ModuleType == SUP_MODULE_DXE_CORE:\r |
f51461c8 LG |
1515 | AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))\r |
1516 | AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1517 | elif Info.ModuleType == SUP_MODULE_SMM_CORE:\r |
f51461c8 LG |
1518 | AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))\r |
1519 | AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1520 | elif Info.ModuleType == SUP_MODULE_MM_CORE_STANDALONE:\r |
5a9c3e3e SV |
1521 | AutoGenC.Append(gMmCoreStandaloneEntryPointString.Replace(Dict))\r |
1522 | AutoGenH.Append(gMmCoreStandaloneEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1523 | elif Info.ModuleType == SUP_MODULE_PEIM:\r |
f51461c8 LG |
1524 | if NumEntryPoints < 2:\r |
1525 | AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1526 | else:\r | |
1527 | AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))\r | |
1528 | AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1529 | elif Info.ModuleType in [SUP_MODULE_DXE_RUNTIME_DRIVER,SUP_MODULE_DXE_DRIVER,SUP_MODULE_DXE_SAL_DRIVER,SUP_MODULE_UEFI_DRIVER]:\r |
f51461c8 LG |
1530 | if NumEntryPoints < 2:\r |
1531 | AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1532 | else:\r | |
1533 | AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))\r | |
1534 | AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1535 | elif Info.ModuleType == SUP_MODULE_DXE_SMM_DRIVER:\r |
f51461c8 LG |
1536 | if NumEntryPoints == 0:\r |
1537 | AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))\r | |
1538 | else:\r | |
1539 | AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))\r | |
5a9c3e3e | 1540 | AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict))\r |
8bb63e37 | 1541 | elif Info.ModuleType == SUP_MODULE_MM_STANDALONE:\r |
5a9c3e3e SV |
1542 | if NumEntryPoints < 2:\r |
1543 | AutoGenC.Append(gMmStandaloneEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1544 | else:\r | |
1545 | AutoGenC.Append(gMmStandaloneEntryPointString[2].Replace(Dict))\r | |
1546 | AutoGenH.Append(gMmStandaloneEntryPointPrototype.Replace(Dict))\r | |
8bb63e37 | 1547 | elif Info.ModuleType == SUP_MODULE_UEFI_APPLICATION:\r |
f51461c8 LG |
1548 | if NumEntryPoints < 2:\r |
1549 | AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r | |
1550 | else:\r | |
1551 | AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r | |
1552 | AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r | |
1553 | \r | |
1554 | ## Create code for ModuleUnloadImage\r | |
1555 | #\r | |
1556 | # @param Info The ModuleAutoGen object\r | |
1557 | # @param AutoGenC The TemplateString object for C code\r | |
1558 | # @param AutoGenH The TemplateString object for header file\r | |
1559 | #\r | |
1560 | def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1561 | if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_SEC]:\r |
f51461c8 LG |
1562 | return\r |
1563 | #\r | |
1564 | # Unload Image Handlers\r | |
1565 | #\r | |
1566 | NumUnloadImage = len(Info.Module.ModuleUnloadImageList)\r | |
1567 | Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}\r | |
1568 | if NumUnloadImage < 2:\r | |
1569 | AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r | |
1570 | else:\r | |
1571 | AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r | |
1572 | AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r | |
1573 | \r | |
1574 | ## Create code for GUID\r | |
1575 | #\r | |
1576 | # @param Info The ModuleAutoGen object\r | |
1577 | # @param AutoGenC The TemplateString object for C code\r | |
1578 | # @param AutoGenH The TemplateString object for header file\r | |
1579 | #\r | |
1580 | def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1581 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1582 | GuidType = TAB_GUID\r |
f51461c8 LG |
1583 | else:\r |
1584 | GuidType = "EFI_GUID"\r | |
1585 | \r | |
1586 | if Info.GuidList:\r | |
7beed8a3 YZ |
1587 | if not Info.IsLibrary:\r |
1588 | AutoGenC.Append("\n// Guids\n")\r | |
8262037f | 1589 | AutoGenH.Append("\n// Guids\n")\r |
f51461c8 LG |
1590 | #\r |
1591 | # GUIDs\r | |
1592 | #\r | |
1593 | for Key in Info.GuidList:\r | |
7beed8a3 YZ |
1594 | if not Info.IsLibrary:\r |
1595 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r | |
8262037f | 1596 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1597 | \r |
1598 | ## Create code for protocol\r | |
1599 | #\r | |
1600 | # @param Info The ModuleAutoGen object\r | |
1601 | # @param AutoGenC The TemplateString object for C code\r | |
1602 | # @param AutoGenH The TemplateString object for header file\r | |
1603 | #\r | |
1604 | def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1605 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1606 | GuidType = TAB_GUID\r |
f51461c8 LG |
1607 | else:\r |
1608 | GuidType = "EFI_GUID"\r | |
1609 | \r | |
1610 | if Info.ProtocolList:\r | |
7beed8a3 YZ |
1611 | if not Info.IsLibrary:\r |
1612 | AutoGenC.Append("\n// Protocols\n")\r | |
8262037f | 1613 | AutoGenH.Append("\n// Protocols\n")\r |
f51461c8 LG |
1614 | #\r |
1615 | # Protocol GUIDs\r | |
1616 | #\r | |
1617 | for Key in Info.ProtocolList:\r | |
7beed8a3 YZ |
1618 | if not Info.IsLibrary:\r |
1619 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r | |
8262037f | 1620 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1621 | \r |
1622 | ## Create code for PPI\r | |
1623 | #\r | |
1624 | # @param Info The ModuleAutoGen object\r | |
1625 | # @param AutoGenC The TemplateString object for C code\r | |
1626 | # @param AutoGenH The TemplateString object for header file\r | |
1627 | #\r | |
1628 | def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r | |
8bb63e37 | 1629 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1630 | GuidType = TAB_GUID\r |
f51461c8 LG |
1631 | else:\r |
1632 | GuidType = "EFI_GUID"\r | |
1633 | \r | |
1634 | if Info.PpiList:\r | |
7beed8a3 YZ |
1635 | if not Info.IsLibrary:\r |
1636 | AutoGenC.Append("\n// PPIs\n")\r | |
8262037f | 1637 | AutoGenH.Append("\n// PPIs\n")\r |
f51461c8 LG |
1638 | #\r |
1639 | # PPI GUIDs\r | |
1640 | #\r | |
1641 | for Key in Info.PpiList:\r | |
7beed8a3 YZ |
1642 | if not Info.IsLibrary:\r |
1643 | AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r | |
8262037f | 1644 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r |
f51461c8 LG |
1645 | \r |
1646 | ## Create code for PCD\r | |
1647 | #\r | |
1648 | # @param Info The ModuleAutoGen object\r | |
1649 | # @param AutoGenC The TemplateString object for C code\r | |
1650 | # @param AutoGenH The TemplateString object for header file\r | |
1651 | #\r | |
1652 | def CreatePcdCode(Info, AutoGenC, AutoGenH):\r | |
1653 | \r | |
1654 | # Collect Token Space GUIDs used by DynamicEc PCDs\r | |
1655 | TokenSpaceList = []\r | |
1656 | for Pcd in Info.ModulePcdList:\r | |
eece4292 | 1657 | if Pcd.Type in PCD_DYNAMIC_EX_TYPE_SET and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r |
f51461c8 LG |
1658 | TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r |
1659 | \r | |
8518bf0b LG |
1660 | SkuMgr = Info.Workspace.Platform.SkuIdMgr\r |
1661 | AutoGenH.Append("\n// Definition of SkuId Array\n")\r | |
1662 | AutoGenH.Append("extern UINT64 _gPcd_SkuId_Array[];\n")\r | |
f51461c8 | 1663 | # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found\r |
72fbe88d | 1664 | if TokenSpaceList:\r |
f51461c8 | 1665 | AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r |
8bb63e37 | 1666 | if Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE]:\r |
91fa33ee | 1667 | GuidType = TAB_GUID\r |
f51461c8 LG |
1668 | else:\r |
1669 | GuidType = "EFI_GUID" \r | |
1670 | for Item in TokenSpaceList:\r | |
1671 | AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))\r | |
1672 | \r | |
1673 | if Info.IsLibrary:\r | |
1674 | if Info.ModulePcdList:\r | |
1675 | AutoGenH.Append("\n// PCD definitions\n")\r | |
1676 | for Pcd in Info.ModulePcdList:\r | |
1677 | CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)\r | |
1678 | DynExPcdTokenNumberMapping (Info, AutoGenH)\r | |
1679 | else:\r | |
8518bf0b LG |
1680 | AutoGenC.Append("\n// Definition of SkuId Array\n")\r |
1681 | AutoGenC.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr.DumpSkuIdArrary())\r | |
f51461c8 LG |
1682 | if Info.ModulePcdList:\r |
1683 | AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r | |
1684 | AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r | |
1685 | for Pcd in Info.ModulePcdList:\r | |
1686 | CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r | |
1687 | DynExPcdTokenNumberMapping (Info, AutoGenH)\r | |
1688 | if Info.LibraryPcdList:\r | |
1689 | AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r | |
1690 | AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r | |
1691 | for Pcd in Info.LibraryPcdList:\r | |
1692 | CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r | |
1693 | CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r | |
1694 | \r | |
1695 | ## Create code for unicode string definition\r | |
1696 | #\r | |
1697 | # @param Info The ModuleAutoGen object\r | |
1698 | # @param AutoGenC The TemplateString object for C code\r | |
1699 | # @param AutoGenH The TemplateString object for header file\r | |
1700 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r | |
1701 | # @param UniGenBinBuffer Buffer to store uni string package data\r | |
1702 | #\r | |
1703 | def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r | |
1704 | WorkingDir = os.getcwd()\r | |
1705 | os.chdir(Info.WorkspaceDir)\r | |
1706 | \r | |
1707 | IncList = [Info.MetaFile.Dir]\r | |
1708 | # Get all files under [Sources] section in inf file for EDK-II module\r | |
1709 | EDK2Module = True\r | |
1710 | SrcList = [F for F in Info.SourceFileList]\r | |
1711 | if Info.AutoGenVersion < 0x00010005:\r | |
1712 | EDK2Module = False\r | |
1713 | # Get all files under the module directory for EDK-I module\r | |
1714 | Cwd = os.getcwd()\r | |
1715 | os.chdir(Info.MetaFile.Dir)\r | |
1716 | for Root, Dirs, Files in os.walk("."):\r | |
1717 | if 'CVS' in Dirs:\r | |
1718 | Dirs.remove('CVS')\r | |
1719 | if '.svn' in Dirs:\r | |
1720 | Dirs.remove('.svn')\r | |
1721 | for File in Files:\r | |
1722 | File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)\r | |
1723 | if File in SrcList:\r | |
1724 | continue\r | |
1725 | SrcList.append(File)\r | |
1726 | os.chdir(Cwd)\r | |
1727 | \r | |
1728 | if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r | |
1729 | CompatibleMode = True\r | |
1730 | else:\r | |
1731 | CompatibleMode = False\r | |
1732 | \r | |
1733 | #\r | |
1734 | # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r | |
1735 | #\r | |
1736 | if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r | |
1737 | if CompatibleMode:\r | |
1738 | EdkLogger.error("build", AUTOGEN_ERROR,\r | |
1739 | "-c and -s build options should be used exclusively",\r | |
1740 | ExtraData="[%s]" % str(Info))\r | |
1741 | ShellMode = True\r | |
1742 | else:\r | |
1743 | ShellMode = False\r | |
1744 | \r | |
1745 | #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r | |
1746 | if EDK2Module:\r | |
1747 | FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r | |
1748 | else:\r | |
1749 | FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r | |
1750 | Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r | |
1751 | if CompatibleMode or UniGenCFlag:\r | |
1752 | AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r | |
1753 | AutoGenC.Append(Code)\r | |
1754 | AutoGenC.Append("\n")\r | |
1755 | AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r | |
1756 | AutoGenH.Append(Header)\r | |
1757 | if CompatibleMode or UniGenCFlag:\r | |
1758 | AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r | |
1759 | os.chdir(WorkingDir)\r | |
1760 | \r | |
333ba578 YZ |
1761 | def CreateIdfFileCode(Info, AutoGenC, StringH, IdfGenCFlag, IdfGenBinBuffer):\r |
1762 | if len(Info.IdfFileList) > 0:\r | |
1763 | ImageFiles = IdfFileClassObject(sorted (Info.IdfFileList))\r | |
1764 | if ImageFiles.ImageFilesDict:\r | |
1765 | Index = 1\r | |
1766 | PaletteIndex = 1\r | |
1767 | IncList = [Info.MetaFile.Dir]\r | |
1768 | SrcList = [F for F in Info.SourceFileList]\r | |
1769 | SkipList = ['.jpg', '.png', '.bmp', '.inf', '.idf']\r | |
1770 | FileList = GetFileList(SrcList, IncList, SkipList)\r | |
1771 | ValueStartPtr = 60\r | |
1772 | StringH.Append("\n//\n//Image ID\n//\n")\r | |
1773 | ImageInfoOffset = 0\r | |
1774 | PaletteInfoOffset = 0\r | |
1775 | ImageBuffer = pack('x')\r | |
1776 | PaletteBuffer = pack('x')\r | |
1777 | BufferStr = ''\r | |
1778 | PaletteStr = ''\r | |
6d034a2a | 1779 | FileDict = {}\r |
333ba578 YZ |
1780 | for Idf in ImageFiles.ImageFilesDict:\r |
1781 | if ImageFiles.ImageFilesDict[Idf]:\r | |
1782 | for FileObj in ImageFiles.ImageFilesDict[Idf]:\r | |
1783 | for sourcefile in Info.SourceFileList:\r | |
1784 | if FileObj.FileName == sourcefile.File:\r | |
1785 | if not sourcefile.Ext.upper() in ['.PNG', '.BMP', '.JPG']:\r | |
1786 | EdkLogger.error("build", AUTOGEN_ERROR, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj.FileName), ExtraData="[%s]" % str(Info))\r | |
1787 | FileObj.File = sourcefile\r | |
1788 | break\r | |
1789 | else:\r | |
1790 | EdkLogger.error("build", AUTOGEN_ERROR, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj.FileName, Idf), ExtraData="[%s]" % str(Info))\r | |
1791 | \r | |
1792 | for FileObj in ImageFiles.ImageFilesDict[Idf]:\r | |
1793 | ID = FileObj.ImageID\r | |
1794 | File = FileObj.File\r | |
1795 | if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r | |
1796 | EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=File.Path)\r | |
1797 | SearchImageID (FileObj, FileList)\r | |
1798 | if FileObj.Referenced:\r | |
1799 | if (ValueStartPtr - len(DEFINE_STR + ID)) <= 0:\r | |
1800 | Line = DEFINE_STR + ' ' + ID + ' ' + DecToHexStr(Index, 4) + '\n'\r | |
1801 | else:\r | |
1802 | Line = DEFINE_STR + ' ' + ID + ' ' * (ValueStartPtr - len(DEFINE_STR + ID)) + DecToHexStr(Index, 4) + '\n'\r | |
1803 | \r | |
6d034a2a YZ |
1804 | if File not in FileDict:\r |
1805 | FileDict[File] = Index\r | |
1806 | else:\r | |
1807 | DuplicateBlock = pack('B', EFI_HII_IIBT_DUPLICATE)\r | |
1808 | DuplicateBlock += pack('H', FileDict[File])\r | |
1809 | ImageBuffer += DuplicateBlock\r | |
1810 | BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r | |
1811 | TempBufferList = AscToHexList(DuplicateBlock)\r | |
1812 | BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r | |
1813 | StringH.Append(Line)\r | |
1814 | Index += 1\r | |
1815 | continue\r | |
1816 | \r | |
333ba578 YZ |
1817 | TmpFile = open(File.Path, 'rb')\r |
1818 | Buffer = TmpFile.read()\r | |
1819 | TmpFile.close()\r | |
1820 | if File.Ext.upper() == '.PNG':\r | |
1821 | TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_PNG)\r | |
1822 | TempBuffer += pack('I', len(Buffer))\r | |
1823 | TempBuffer += Buffer\r | |
1824 | elif File.Ext.upper() == '.JPG':\r | |
1825 | ImageType, = struct.unpack('4s', Buffer[6:10])\r | |
1826 | if ImageType != 'JFIF':\r | |
1827 | EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard JPG file." % File.Path)\r | |
1828 | TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_JPEG)\r | |
1829 | TempBuffer += pack('I', len(Buffer))\r | |
1830 | TempBuffer += Buffer\r | |
1831 | elif File.Ext.upper() == '.BMP':\r | |
1832 | TempBuffer, TempPalette = BmpImageDecoder(File, Buffer, PaletteIndex, FileObj.TransParent)\r | |
1833 | if len(TempPalette) > 1:\r | |
1834 | PaletteIndex += 1\r | |
e148e6e9 YZ |
1835 | NewPalette = pack('H', len(TempPalette))\r |
1836 | NewPalette += TempPalette\r | |
1837 | PaletteBuffer += NewPalette\r | |
333ba578 | 1838 | PaletteStr = WriteLine(PaletteStr, '// %s: %s: %s' % (DecToHexStr(PaletteIndex - 1, 4), ID, DecToHexStr(PaletteIndex - 1, 4)))\r |
e148e6e9 | 1839 | TempPaletteList = AscToHexList(NewPalette)\r |
333ba578 YZ |
1840 | PaletteStr = WriteLine(PaletteStr, CreateArrayItem(TempPaletteList, 16) + '\n')\r |
1841 | ImageBuffer += TempBuffer\r | |
1842 | BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r | |
1843 | TempBufferList = AscToHexList(TempBuffer)\r | |
1844 | BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r | |
1845 | \r | |
1846 | StringH.Append(Line)\r | |
1847 | Index += 1\r | |
1848 | \r | |
1849 | BufferStr = WriteLine(BufferStr, '// End of the Image Info')\r | |
1850 | BufferStr = WriteLine(BufferStr, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END, 2)) + '\n')\r | |
1851 | ImageEnd = pack('B', EFI_HII_IIBT_END)\r | |
1852 | ImageBuffer += ImageEnd\r | |
1853 | \r | |
1854 | if len(ImageBuffer) > 1:\r | |
1855 | ImageInfoOffset = 12\r | |
1856 | if len(PaletteBuffer) > 1:\r | |
1857 | PaletteInfoOffset = 12 + len(ImageBuffer) - 1 # -1 is for the first empty pad byte of ImageBuffer\r | |
1858 | \r | |
1859 | IMAGE_PACKAGE_HDR = pack('=II', ImageInfoOffset, PaletteInfoOffset)\r | |
1860 | # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length\r | |
1861 | if len(PaletteBuffer) > 1:\r | |
1862 | PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1 + 2 + len(PaletteBuffer) - 1\r | |
1863 | else:\r | |
1864 | PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1\r | |
1865 | if PaletteIndex > 1:\r | |
1866 | PALETTE_INFO_HEADER = pack('H', PaletteIndex - 1)\r | |
1867 | # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF\r | |
1868 | Hex_Length = '%06X' % PACKAGE_HEADER_Length\r | |
1869 | if PACKAGE_HEADER_Length > 0xFFFFFF:\r | |
1870 | EdkLogger.error("build", AUTOGEN_ERROR, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData="[%s]" % str(Info))\r | |
1871 | PACKAGE_HEADER = pack('=HBB', int('0x' + Hex_Length[2:], 16), int('0x' + Hex_Length[0:2], 16), EFI_HII_PACKAGE_IMAGES)\r | |
1872 | \r | |
1873 | IdfGenBinBuffer.write(PACKAGE_HEADER)\r | |
1874 | IdfGenBinBuffer.write(IMAGE_PACKAGE_HDR)\r | |
1875 | if len(ImageBuffer) > 1 :\r | |
1876 | IdfGenBinBuffer.write(ImageBuffer[1:])\r | |
1877 | if PaletteIndex > 1:\r | |
1878 | IdfGenBinBuffer.write(PALETTE_INFO_HEADER)\r | |
1879 | if len(PaletteBuffer) > 1:\r | |
1880 | IdfGenBinBuffer.write(PaletteBuffer[1:])\r | |
1881 | \r | |
1882 | if IdfGenCFlag:\r | |
1883 | TotalLength = EFI_HII_ARRAY_SIZE_LENGTH + PACKAGE_HEADER_Length\r | |
1884 | AutoGenC.Append("\n//\n//Image Pack Definition\n//\n")\r | |
1885 | AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + Info.Module.BaseName + 'Images' + '[] = {\n')\r | |
1886 | AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r | |
1887 | AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r | |
1888 | AllStr = WriteLine(AllStr, '// Image PACKAGE HEADER\n')\r | |
1889 | IMAGE_PACKAGE_HDR_List = AscToHexList(PACKAGE_HEADER)\r | |
1890 | IMAGE_PACKAGE_HDR_List += AscToHexList(IMAGE_PACKAGE_HDR)\r | |
1891 | AllStr = WriteLine(AllStr, CreateArrayItem(IMAGE_PACKAGE_HDR_List, 16) + '\n')\r | |
1892 | AllStr = WriteLine(AllStr, '// Image DATA\n')\r | |
1893 | if BufferStr:\r | |
1894 | AllStr = WriteLine(AllStr, BufferStr)\r | |
1895 | if PaletteStr:\r | |
1896 | AllStr = WriteLine(AllStr, '// Palette Header\n')\r | |
1897 | PALETTE_INFO_HEADER_List = AscToHexList(PALETTE_INFO_HEADER)\r | |
1898 | AllStr = WriteLine(AllStr, CreateArrayItem(PALETTE_INFO_HEADER_List, 16) + '\n')\r | |
1899 | AllStr = WriteLine(AllStr, '// Palette Data\n')\r | |
1900 | AllStr = WriteLine(AllStr, PaletteStr)\r | |
1901 | AllStr = WriteLine(AllStr, '};')\r | |
1902 | AutoGenC.Append(AllStr)\r | |
1903 | AutoGenC.Append("\n")\r | |
1904 | StringH.Append('\nextern unsigned char ' + Info.Module.BaseName + 'Images[];\n')\r | |
1905 | StringH.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info.Module.BaseName)\r | |
1906 | \r | |
1907 | # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r | |
1908 | # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES\r | |
1909 | # UINT32 ImageInfoOffset;\r | |
1910 | # UINT32 PaletteInfoOffset;\r | |
1911 | # } EFI_HII_IMAGE_PACKAGE_HDR;\r | |
1912 | \r | |
1913 | # typedef struct {\r | |
1914 | # UINT32 Length:24;\r | |
1915 | # UINT32 Type:8;\r | |
1916 | # UINT8 Data[];\r | |
1917 | # } EFI_HII_PACKAGE_HEADER;\r | |
1918 | \r | |
1919 | # typedef struct _EFI_HII_IMAGE_BLOCK {\r | |
1920 | # UINT8 BlockType;\r | |
1921 | # UINT8 BlockBody[];\r | |
1922 | # } EFI_HII_IMAGE_BLOCK;\r | |
1923 | \r | |
1924 | def BmpImageDecoder(File, Buffer, PaletteIndex, TransParent):\r | |
1925 | ImageType, = struct.unpack('2s', Buffer[0:2])\r | |
1926 | if ImageType!= 'BM': # BMP file type is 'BM'\r | |
1927 | EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard BMP file." % File.Path)\r | |
1928 | BMP_IMAGE_HEADER = collections.namedtuple('BMP_IMAGE_HEADER', ['bfSize','bfReserved1','bfReserved2','bfOffBits','biSize','biWidth','biHeight','biPlanes','biBitCount', 'biCompression', 'biSizeImage','biXPelsPerMeter','biYPelsPerMeter','biClrUsed','biClrImportant'])\r | |
1929 | BMP_IMAGE_HEADER_STRUCT = struct.Struct('IHHIIIIHHIIIIII')\r | |
1930 | BmpHeader = BMP_IMAGE_HEADER._make(BMP_IMAGE_HEADER_STRUCT.unpack_from(Buffer[2:]))\r | |
1931 | #\r | |
1932 | # Doesn't support compress.\r | |
1933 | #\r | |
1934 | if BmpHeader.biCompression != 0:\r | |
1935 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The compress BMP file %s is not support." % File.Path)\r | |
1936 | \r | |
1937 | # The Width and Height is UINT16 type in Image Package\r | |
1938 | if BmpHeader.biWidth > 0xFFFF:\r | |
1939 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Width is exceed 0xFFFF." % File.Path)\r | |
1940 | if BmpHeader.biHeight > 0xFFFF:\r | |
1941 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Height is exceed 0xFFFF." % File.Path)\r | |
1942 | \r | |
1943 | PaletteBuffer = pack('x')\r | |
1944 | if BmpHeader.biBitCount == 1:\r | |
1945 | if TransParent:\r | |
1946 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS)\r | |
1947 | else:\r | |
1948 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r | |
1949 | ImageBuffer += pack('B', PaletteIndex)\r | |
1950 | Width = (BmpHeader.biWidth + 7)/8\r | |
1951 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r | |
1952 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1953 | elif BmpHeader.biBitCount == 4:\r | |
1954 | if TransParent:\r | |
1955 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS)\r | |
1956 | else:\r | |
1957 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r | |
1958 | ImageBuffer += pack('B', PaletteIndex)\r | |
1959 | Width = (BmpHeader.biWidth + 1)/2\r | |
1960 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r | |
1961 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1962 | elif BmpHeader.biBitCount == 8:\r | |
1963 | if TransParent:\r | |
1964 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS)\r | |
1965 | else:\r | |
1966 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT)\r | |
1967 | ImageBuffer += pack('B', PaletteIndex)\r | |
1968 | Width = BmpHeader.biWidth\r | |
1969 | if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r | |
1970 | PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r | |
1971 | elif BmpHeader.biBitCount == 24:\r | |
1972 | if TransParent:\r | |
1973 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS)\r | |
1974 | else:\r | |
1975 | ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT)\r | |
1976 | Width = BmpHeader.biWidth * 3\r | |
1977 | else:\r | |
1978 | EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData="[%s]" % str(File.Path))\r | |
1979 | \r | |
1980 | ImageBuffer += pack('H', BmpHeader.biWidth)\r | |
1981 | ImageBuffer += pack('H', BmpHeader.biHeight)\r | |
1982 | Start = BmpHeader.bfOffBits\r | |
1983 | End = BmpHeader.bfSize - 1\r | |
1984 | for Height in range(0, BmpHeader.biHeight):\r | |
1985 | if Width % 4 != 0:\r | |
1986 | Start = End + (Width % 4) - 4 - Width\r | |
1987 | else:\r | |
1988 | Start = End - Width\r | |
1989 | ImageBuffer += Buffer[Start + 1 : Start + Width + 1]\r | |
1990 | End = Start\r | |
1991 | \r | |
1992 | # handle the Palette info, BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info\r | |
1993 | if PaletteBuffer and len(PaletteBuffer) > 1:\r | |
1994 | PaletteTemp = pack('x')\r | |
1995 | for Index in range(0, len(PaletteBuffer)):\r | |
1996 | if Index % 4 == 3:\r | |
1997 | continue\r | |
1998 | PaletteTemp += PaletteBuffer[Index]\r | |
1999 | PaletteBuffer = PaletteTemp[1:]\r | |
2000 | return ImageBuffer, PaletteBuffer\r | |
2001 | \r | |
f51461c8 LG |
2002 | ## Create common code\r |
2003 | #\r | |
2004 | # @param Info The ModuleAutoGen object\r | |
2005 | # @param AutoGenC The TemplateString object for C code\r | |
2006 | # @param AutoGenH The TemplateString object for header file\r | |
2007 | #\r | |
2008 | def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r | |
2009 | # file header\r | |
2010 | AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r | |
2011 | # header file Prologue\r | |
2012 | AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))\r | |
2013 | AutoGenH.Append(gAutoGenHCppPrologueString)\r | |
2014 | if Info.AutoGenVersion >= 0x00010005:\r | |
2015 | # header files includes\r | |
2016 | AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)\r | |
2017 | if Info.ModuleType in gModuleTypeHeaderFile \\r | |
2018 | and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:\r | |
2019 | AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r | |
2020 | #\r | |
2021 | # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h \r | |
2022 | # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r | |
2023 | #\r | |
2024 | if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r | |
2025 | AutoGenH.Append("#include <Library/PcdLib.h>\n")\r | |
2026 | \r | |
2027 | AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r | |
2028 | AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r | |
2029 | \r | |
2030 | if Info.IsLibrary:\r | |
2031 | return\r | |
2032 | \r | |
2033 | AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\r | |
2034 | \r | |
2035 | if Info.IsLibrary:\r | |
2036 | return\r | |
2037 | # C file header\r | |
2038 | AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r | |
2039 | if Info.AutoGenVersion >= 0x00010005:\r | |
2040 | # C file header files includes\r | |
2041 | if Info.ModuleType in gModuleTypeHeaderFile:\r | |
2042 | for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r | |
2043 | AutoGenC.Append("#include <%s>\n" % Inc)\r | |
2044 | else:\r | |
2045 | AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r | |
2046 | \r | |
2047 | #\r | |
2048 | # Publish the CallerId Guid\r | |
2049 | #\r | |
2050 | AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r | |
2051 | AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r | |
2052 | \r | |
2053 | ## Create common code for header file\r | |
2054 | #\r | |
2055 | # @param Info The ModuleAutoGen object\r | |
2056 | # @param AutoGenC The TemplateString object for C code\r | |
2057 | # @param AutoGenH The TemplateString object for header file\r | |
2058 | #\r | |
2059 | def CreateFooterCode(Info, AutoGenC, AutoGenH):\r | |
2060 | AutoGenH.Append(gAutoGenHEpilogueString)\r | |
2061 | \r | |
2062 | ## Create code for a module\r | |
2063 | #\r | |
2064 | # @param Info The ModuleAutoGen object\r | |
2065 | # @param AutoGenC The TemplateString object for C code\r | |
2066 | # @param AutoGenH The TemplateString object for header file\r | |
333ba578 | 2067 | # @param StringH The TemplateString object for header file\r |
f51461c8 LG |
2068 | # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r |
2069 | # @param UniGenBinBuffer Buffer to store uni string package data\r | |
333ba578 YZ |
2070 | # @param StringIdf The TemplateString object for header file\r |
2071 | # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True\r | |
2072 | # @param IdfGenBinBuffer Buffer to store Idf string package data\r | |
f51461c8 | 2073 | #\r |
333ba578 | 2074 | def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer, StringIdf, IdfGenCFlag, IdfGenBinBuffer):\r |
f51461c8 LG |
2075 | CreateHeaderCode(Info, AutoGenC, AutoGenH)\r |
2076 | \r | |
2077 | if Info.AutoGenVersion >= 0x00010005:\r | |
2078 | CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r | |
2079 | CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r | |
2080 | CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r | |
2081 | CreatePcdCode(Info, AutoGenC, AutoGenH)\r | |
2082 | CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r | |
2083 | CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r | |
2084 | CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r | |
2085 | CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r | |
2086 | \r | |
2087 | if Info.UnicodeFileList:\r | |
2088 | FileName = "%sStrDefs.h" % Info.Name\r | |
2089 | StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r | |
2090 | StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))\r | |
2091 | CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r | |
8200fcfe YL |
2092 | \r |
2093 | GuidMacros = []\r | |
2094 | for Guid in Info.Module.Guids:\r | |
2095 | if Guid in Info.Module.GetGuidsUsedByPcd():\r | |
2096 | continue\r | |
2097 | GuidMacros.append('#define %s %s' % (Guid, Info.Module.Guids[Guid]))\r | |
2098 | for Guid, Value in Info.Module.Protocols.items() + Info.Module.Ppis.items():\r | |
2099 | GuidMacros.append('#define %s %s' % (Guid, Value))\r | |
5b97eb4c YZ |
2100 | # supports FixedAtBuild usage in VFR file\r |
2101 | if Info.VfrFileList and Info.ModulePcdList:\r | |
2102 | GuidMacros.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2103 | GuidMacros.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2104 | GuidMacros.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2105 | GuidMacros.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2106 | GuidMacros.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))\r | |
2107 | for Pcd in Info.ModulePcdList:\r | |
2108 | if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r | |
2109 | TokenCName = Pcd.TokenCName\r | |
2110 | Value = Pcd.DefaultValue\r | |
2111 | if Pcd.DatumType == 'BOOLEAN':\r | |
2112 | BoolValue = Value.upper()\r | |
2113 | if BoolValue == 'TRUE':\r | |
2114 | Value = '1'\r | |
2115 | elif BoolValue == 'FALSE':\r | |
2116 | Value = '0'\r | |
2117 | for PcdItem in GlobalData.MixedPcd:\r | |
2118 | if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r | |
2119 | TokenCName = PcdItem[0]\r | |
2120 | break\r | |
2121 | GuidMacros.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName, Value))\r | |
2122 | \r | |
bc7d95c0 YZ |
2123 | if Info.IdfFileList:\r |
2124 | GuidMacros.append('#include "%sImgDefs.h"' % Info.Name)\r | |
2125 | \r | |
8200fcfe YL |
2126 | if GuidMacros:\r |
2127 | StringH.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros))\r | |
2128 | \r | |
f51461c8 LG |
2129 | StringH.Append("\n#endif\n")\r |
2130 | AutoGenH.Append('#include "%s"\n' % FileName)\r | |
2131 | \r | |
333ba578 YZ |
2132 | if Info.IdfFileList:\r |
2133 | FileName = "%sImgDefs.h" % Info.Name\r | |
2134 | StringIdf.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r | |
2135 | StringIdf.Append(gAutoGenHPrologueString.Replace({'File':'IMAGEDEFS', 'Guid':Info.Guid.replace('-','_')}))\r | |
2136 | CreateIdfFileCode(Info, AutoGenC, StringIdf, IdfGenCFlag, IdfGenBinBuffer)\r | |
2137 | \r | |
2138 | StringIdf.Append("\n#endif\n")\r | |
2139 | AutoGenH.Append('#include "%s"\n' % FileName)\r | |
2140 | \r | |
f51461c8 LG |
2141 | CreateFooterCode(Info, AutoGenC, AutoGenH)\r |
2142 | \r | |
2143 | # no generation of AutoGen.c for Edk modules without unicode file\r | |
2144 | if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:\r | |
2145 | AutoGenC.String = ''\r | |
2146 | \r | |
2147 | ## Create the code file\r | |
2148 | #\r | |
2149 | # @param FilePath The path of code file\r | |
2150 | # @param Content The content of code file\r | |
2151 | # @param IsBinaryFile The flag indicating if the file is binary file or not\r | |
2152 | #\r | |
2153 | # @retval True If file content is changed or file doesn't exist\r | |
2154 | # @retval False If the file exists and the content is not changed\r | |
2155 | #\r | |
2156 | def Generate(FilePath, Content, IsBinaryFile):\r | |
2157 | return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r | |
2158 | \r |