]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenC.py
Sync BaseTool trunk (version r2649) into EDKII BaseTools.
[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenC.py
CommitLineData
f51461c8
LG
1## @file\r
2# Routines for generating AutoGen.h and AutoGen.c\r
3#\r
4# Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
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
16import string\r
17\r
18from Common import EdkLogger\r
19\r
20from Common.BuildToolError import *\r
21from Common.DataType import *\r
22from Common.Misc import *\r
23from Common.String import StringToArray\r
24from StrGather import *\r
25from GenPcdDb import CreatePcdDatabaseCode\r
26\r
27## PCD type string\r
28gItemTypeStringDatabase = {\r
29 TAB_PCDS_FEATURE_FLAG : 'FixedAtBuild',\r
30 TAB_PCDS_FIXED_AT_BUILD : 'FixedAtBuild',\r
31 TAB_PCDS_PATCHABLE_IN_MODULE: 'BinaryPatch',\r
32 TAB_PCDS_DYNAMIC : '',\r
33 TAB_PCDS_DYNAMIC_DEFAULT : '',\r
34 TAB_PCDS_DYNAMIC_VPD : '',\r
35 TAB_PCDS_DYNAMIC_HII : '',\r
36 TAB_PCDS_DYNAMIC_EX : '',\r
37 TAB_PCDS_DYNAMIC_EX_DEFAULT : '',\r
38 TAB_PCDS_DYNAMIC_EX_VPD : '',\r
39 TAB_PCDS_DYNAMIC_EX_HII : '',\r
40}\r
41\r
42## Dynamic PCD types\r
43gDynamicPcd = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]\r
44\r
45## Dynamic-ex PCD types\r
46gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
47\r
48## Datum size\r
49gDatumSizeStringDatabase = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOLEAN','VOID*':'8'}\r
50gDatumSizeStringDatabaseH = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOL','VOID*':'PTR'}\r
51gDatumSizeStringDatabaseLib = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'Bool','VOID*':'Ptr'}\r
52\r
53## AutoGen File Header Templates\r
54gAutoGenHeaderString = TemplateString("""\\r
55/**\r
56 DO NOT EDIT\r
57 FILE auto-generated\r
58 Module name:\r
59 ${FileName}\r
60 Abstract: Auto-generated ${FileName} for building module or library.\r
61**/\r
62""")\r
63\r
64gAutoGenHPrologueString = TemplateString("""\r
65#ifndef _${File}_${Guid}\r
66#define _${File}_${Guid}\r
67\r
68""")\r
69\r
70gAutoGenHCppPrologueString = """\\r
71#ifdef __cplusplus\r
72extern "C" {\r
73#endif\r
74\r
75"""\r
76\r
77gAutoGenHEpilogueString = """\r
78\r
79#ifdef __cplusplus\r
80}\r
81#endif\r
82\r
83#endif\r
84"""\r
85\r
86## PEI Core Entry Point Templates\r
87gPeiCoreEntryPointPrototype = TemplateString("""\r
88${BEGIN}\r
89VOID\r
90EFIAPI\r
91${Function} (\r
92 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
93 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
94 IN VOID *Context\r
95 );\r
96${END}\r
97""")\r
98\r
99gPeiCoreEntryPointString = TemplateString("""\r
100${BEGIN}\r
101VOID\r
102EFIAPI\r
103ProcessModuleEntryPointList (\r
104 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
105 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
106 IN VOID *Context\r
107 )\r
108\r
109{\r
110 ${Function} (SecCoreData, PpiList, Context);\r
111}\r
112${END}\r
113""")\r
114\r
115\r
116## DXE Core Entry Point Templates\r
117gDxeCoreEntryPointPrototype = TemplateString("""\r
118${BEGIN}\r
119VOID\r
120EFIAPI\r
121${Function} (\r
122 IN VOID *HobStart\r
123 );\r
124${END}\r
125""")\r
126\r
127gDxeCoreEntryPointString = TemplateString("""\r
128${BEGIN}\r
129VOID\r
130EFIAPI\r
131ProcessModuleEntryPointList (\r
132 IN VOID *HobStart\r
133 )\r
134\r
135{\r
136 ${Function} (HobStart);\r
137}\r
138${END}\r
139""")\r
140\r
141## PEIM Entry Point Templates\r
142gPeimEntryPointPrototype = TemplateString("""\r
143${BEGIN}\r
144EFI_STATUS\r
145EFIAPI\r
146${Function} (\r
147 IN EFI_PEI_FILE_HANDLE FileHandle,\r
148 IN CONST EFI_PEI_SERVICES **PeiServices\r
149 );\r
150${END}\r
151""")\r
152\r
153gPeimEntryPointString = [\r
154TemplateString("""\r
155GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
156\r
157EFI_STATUS\r
158EFIAPI\r
159ProcessModuleEntryPointList (\r
160 IN EFI_PEI_FILE_HANDLE FileHandle,\r
161 IN CONST EFI_PEI_SERVICES **PeiServices\r
162 )\r
163\r
164{\r
165 return EFI_SUCCESS;\r
166}\r
167"""),\r
168TemplateString("""\r
169GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
170${BEGIN}\r
171EFI_STATUS\r
172EFIAPI\r
173ProcessModuleEntryPointList (\r
174 IN EFI_PEI_FILE_HANDLE FileHandle,\r
175 IN CONST EFI_PEI_SERVICES **PeiServices\r
176 )\r
177\r
178{\r
179 return ${Function} (FileHandle, PeiServices);\r
180}\r
181${END}\r
182"""),\r
183TemplateString("""\r
184GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
185\r
186EFI_STATUS\r
187EFIAPI\r
188ProcessModuleEntryPointList (\r
189 IN EFI_PEI_FILE_HANDLE FileHandle,\r
190 IN CONST EFI_PEI_SERVICES **PeiServices\r
191 )\r
192\r
193{\r
194 EFI_STATUS Status;\r
195 EFI_STATUS CombinedStatus;\r
196\r
197 CombinedStatus = EFI_LOAD_ERROR;\r
198${BEGIN}\r
199 Status = ${Function} (FileHandle, PeiServices);\r
200 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r
201 CombinedStatus = Status;\r
202 }\r
203${END}\r
204 return CombinedStatus;\r
205}\r
206""")\r
207]\r
208\r
209## SMM_CORE Entry Point Templates\r
210gSmmCoreEntryPointPrototype = TemplateString("""\r
211${BEGIN}\r
212EFI_STATUS\r
213EFIAPI\r
214${Function} (\r
215 IN EFI_HANDLE ImageHandle,\r
216 IN EFI_SYSTEM_TABLE *SystemTable\r
217 );\r
218${END}\r
219""")\r
220\r
221gSmmCoreEntryPointString = TemplateString("""\r
222${BEGIN}\r
223const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
224const UINT32 _gDxeRevision = ${PiSpecVersion};\r
225\r
226EFI_STATUS\r
227EFIAPI\r
228ProcessModuleEntryPointList (\r
229 IN EFI_HANDLE ImageHandle,\r
230 IN EFI_SYSTEM_TABLE *SystemTable\r
231 )\r
232{\r
233 return ${Function} (ImageHandle, SystemTable);\r
234}\r
235${END}\r
236""")\r
237\r
238## DXE SMM Entry Point Templates\r
239gDxeSmmEntryPointPrototype = TemplateString("""\r
240${BEGIN}\r
241EFI_STATUS\r
242EFIAPI\r
243${Function} (\r
244 IN EFI_HANDLE ImageHandle,\r
245 IN EFI_SYSTEM_TABLE *SystemTable\r
246 );\r
247${END}\r
248""")\r
249\r
250gDxeSmmEntryPointString = [\r
251TemplateString("""\r
252const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
253const UINT32 _gDxeRevision = ${PiSpecVersion};\r
254\r
255EFI_STATUS\r
256EFIAPI\r
257ProcessModuleEntryPointList (\r
258 IN EFI_HANDLE ImageHandle,\r
259 IN EFI_SYSTEM_TABLE *SystemTable\r
260 )\r
261\r
262{\r
263 return EFI_SUCCESS;\r
264}\r
265"""),\r
266TemplateString("""\r
267const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
268const UINT32 _gDxeRevision = ${PiSpecVersion};\r
269\r
270static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
271static EFI_STATUS mDriverEntryPointStatus;\r
272\r
273VOID\r
274EFIAPI\r
275ExitDriver (\r
276 IN EFI_STATUS Status\r
277 )\r
278{\r
279 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
280 mDriverEntryPointStatus = Status;\r
281 }\r
282 LongJump (&mJumpContext, (UINTN)-1);\r
283 ASSERT (FALSE);\r
284}\r
285\r
286EFI_STATUS\r
287EFIAPI\r
288ProcessModuleEntryPointList (\r
289 IN EFI_HANDLE ImageHandle,\r
290 IN EFI_SYSTEM_TABLE *SystemTable\r
291 )\r
292{\r
293 mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
294\r
295${BEGIN}\r
296 if (SetJump (&mJumpContext) == 0) {\r
297 ExitDriver (${Function} (ImageHandle, SystemTable));\r
298 ASSERT (FALSE);\r
299 }\r
300${END}\r
301\r
302 return mDriverEntryPointStatus;\r
303}\r
304""")\r
305]\r
306\r
307## UEFI Driver Entry Point Templates\r
308gUefiDriverEntryPointPrototype = TemplateString("""\r
309${BEGIN}\r
310EFI_STATUS\r
311EFIAPI\r
312${Function} (\r
313 IN EFI_HANDLE ImageHandle,\r
314 IN EFI_SYSTEM_TABLE *SystemTable\r
315 );\r
316${END}\r
317""")\r
318\r
319gUefiDriverEntryPointString = [\r
320TemplateString("""\r
321const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
322const UINT32 _gDxeRevision = ${PiSpecVersion};\r
323\r
324EFI_STATUS\r
325EFIAPI\r
326ProcessModuleEntryPointList (\r
327 IN EFI_HANDLE ImageHandle,\r
328 IN EFI_SYSTEM_TABLE *SystemTable\r
329 )\r
330{\r
331 return EFI_SUCCESS;\r
332}\r
333"""),\r
334TemplateString("""\r
335const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
336const UINT32 _gDxeRevision = ${PiSpecVersion};\r
337\r
338${BEGIN}\r
339EFI_STATUS\r
340EFIAPI\r
341ProcessModuleEntryPointList (\r
342 IN EFI_HANDLE ImageHandle,\r
343 IN EFI_SYSTEM_TABLE *SystemTable\r
344 )\r
345\r
346{\r
347 return ${Function} (ImageHandle, SystemTable);\r
348}\r
349${END}\r
350VOID\r
351EFIAPI\r
352ExitDriver (\r
353 IN EFI_STATUS Status\r
354 )\r
355{\r
356 if (EFI_ERROR (Status)) {\r
357 ProcessLibraryDestructorList (gImageHandle, gST);\r
358 }\r
359 gBS->Exit (gImageHandle, Status, 0, NULL);\r
360}\r
361"""),\r
362TemplateString("""\r
363const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
364const UINT32 _gDxeRevision = ${PiSpecVersion};\r
365\r
366static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
367static EFI_STATUS mDriverEntryPointStatus;\r
368\r
369EFI_STATUS\r
370EFIAPI\r
371ProcessModuleEntryPointList (\r
372 IN EFI_HANDLE ImageHandle,\r
373 IN EFI_SYSTEM_TABLE *SystemTable\r
374 )\r
375{\r
376 mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
377 ${BEGIN}\r
378 if (SetJump (&mJumpContext) == 0) {\r
379 ExitDriver (${Function} (ImageHandle, SystemTable));\r
380 ASSERT (FALSE);\r
381 }\r
382 ${END}\r
383 return mDriverEntryPointStatus;\r
384}\r
385\r
386VOID\r
387EFIAPI\r
388ExitDriver (\r
389 IN EFI_STATUS Status\r
390 )\r
391{\r
392 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
393 mDriverEntryPointStatus = Status;\r
394 }\r
395 LongJump (&mJumpContext, (UINTN)-1);\r
396 ASSERT (FALSE);\r
397}\r
398""")\r
399]\r
400\r
401\r
402## UEFI Application Entry Point Templates\r
403gUefiApplicationEntryPointPrototype = TemplateString("""\r
404${BEGIN}\r
405EFI_STATUS\r
406EFIAPI\r
407${Function} (\r
408 IN EFI_HANDLE ImageHandle,\r
409 IN EFI_SYSTEM_TABLE *SystemTable\r
410 );\r
411${END}\r
412""")\r
413\r
414gUefiApplicationEntryPointString = [\r
415TemplateString("""\r
416const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
417\r
418EFI_STATUS\r
419EFIAPI\r
420ProcessModuleEntryPointList (\r
421 IN EFI_HANDLE ImageHandle,\r
422 IN EFI_SYSTEM_TABLE *SystemTable\r
423 )\r
424{\r
425 return EFI_SUCCESS;\r
426}\r
427"""),\r
428TemplateString("""\r
429const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
430\r
431${BEGIN}\r
432EFI_STATUS\r
433EFIAPI\r
434ProcessModuleEntryPointList (\r
435 IN EFI_HANDLE ImageHandle,\r
436 IN EFI_SYSTEM_TABLE *SystemTable\r
437 )\r
438\r
439{\r
440 return ${Function} (ImageHandle, SystemTable);\r
441}\r
442${END}\r
443VOID\r
444EFIAPI\r
445ExitDriver (\r
446 IN EFI_STATUS Status\r
447 )\r
448{\r
449 if (EFI_ERROR (Status)) {\r
450 ProcessLibraryDestructorList (gImageHandle, gST);\r
451 }\r
452 gBS->Exit (gImageHandle, Status, 0, NULL);\r
453}\r
454"""),\r
455TemplateString("""\r
456const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
457\r
458EFI_STATUS\r
459EFIAPI\r
460ProcessModuleEntryPointList (\r
461 IN EFI_HANDLE ImageHandle,\r
462 IN EFI_SYSTEM_TABLE *SystemTable\r
463 )\r
464\r
465{\r
466 ${BEGIN}\r
467 if (SetJump (&mJumpContext) == 0) {\r
468 ExitDriver (${Function} (ImageHandle, SystemTable));\r
469 ASSERT (FALSE);\r
470 }\r
471 ${END}\r
472 return mDriverEntryPointStatus;\r
473}\r
474\r
475static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
476static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
477\r
478VOID\r
479EFIAPI\r
480ExitDriver (\r
481 IN EFI_STATUS Status\r
482 )\r
483{\r
484 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
485 mDriverEntryPointStatus = Status;\r
486 }\r
487 LongJump (&mJumpContext, (UINTN)-1);\r
488 ASSERT (FALSE);\r
489}\r
490""")\r
491]\r
492\r
493## UEFI Unload Image Templates\r
494gUefiUnloadImagePrototype = TemplateString("""\r
495${BEGIN}\r
496EFI_STATUS\r
497EFIAPI\r
498${Function} (\r
499 IN EFI_HANDLE ImageHandle\r
500 );\r
501${END}\r
502""")\r
503\r
504gUefiUnloadImageString = [\r
505TemplateString("""\r
506GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
507\r
508EFI_STATUS\r
509EFIAPI\r
510ProcessModuleUnloadList (\r
511 IN EFI_HANDLE ImageHandle\r
512 )\r
513{\r
514 return EFI_SUCCESS;\r
515}\r
516"""),\r
517TemplateString("""\r
518GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
519\r
520${BEGIN}\r
521EFI_STATUS\r
522EFIAPI\r
523ProcessModuleUnloadList (\r
524 IN EFI_HANDLE ImageHandle\r
525 )\r
526{\r
527 return ${Function} (ImageHandle);\r
528}\r
529${END}\r
530"""),\r
531TemplateString("""\r
532GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
533\r
534EFI_STATUS\r
535EFIAPI\r
536ProcessModuleUnloadList (\r
537 IN EFI_HANDLE ImageHandle\r
538 )\r
539{\r
540 EFI_STATUS Status;\r
541\r
542 Status = EFI_SUCCESS;\r
543${BEGIN}\r
544 if (EFI_ERROR (Status)) {\r
545 ${Function} (ImageHandle);\r
546 } else {\r
547 Status = ${Function} (ImageHandle);\r
548 }\r
549${END}\r
550 return Status;\r
551}\r
552""")\r
553]\r
554\r
555gLibraryStructorPrototype = {\r
556'BASE' : TemplateString("""${BEGIN}\r
557RETURN_STATUS\r
558EFIAPI\r
559${Function} (\r
560 VOID\r
561 );${END}\r
562"""),\r
563\r
564'PEI' : TemplateString("""${BEGIN}\r
565EFI_STATUS\r
566EFIAPI\r
567${Function} (\r
568 IN EFI_PEI_FILE_HANDLE FileHandle,\r
569 IN CONST EFI_PEI_SERVICES **PeiServices\r
570 );${END}\r
571"""),\r
572\r
573'DXE' : TemplateString("""${BEGIN}\r
574EFI_STATUS\r
575EFIAPI\r
576${Function} (\r
577 IN EFI_HANDLE ImageHandle,\r
578 IN EFI_SYSTEM_TABLE *SystemTable\r
579 );${END}\r
580"""),\r
581}\r
582\r
583gLibraryStructorCall = {\r
584'BASE' : TemplateString("""${BEGIN}\r
585 Status = ${Function} ();\r
586 ASSERT_EFI_ERROR (Status);${END}\r
587"""),\r
588\r
589'PEI' : TemplateString("""${BEGIN}\r
590 Status = ${Function} (FileHandle, PeiServices);\r
591 ASSERT_EFI_ERROR (Status);${END}\r
592"""),\r
593\r
594'DXE' : TemplateString("""${BEGIN}\r
595 Status = ${Function} (ImageHandle, SystemTable);\r
596 ASSERT_EFI_ERROR (Status);${END}\r
597"""),\r
598}\r
599\r
600## Library Constructor and Destructor Templates\r
601gLibraryString = {\r
602'BASE' : TemplateString("""\r
603${BEGIN}${FunctionPrototype}${END}\r
604\r
605VOID\r
606EFIAPI\r
607ProcessLibrary${Type}List (\r
608 VOID\r
609 )\r
610{\r
611${BEGIN} EFI_STATUS Status;\r
612${FunctionCall}${END}\r
613}\r
614"""),\r
615\r
616'PEI' : TemplateString("""\r
617${BEGIN}${FunctionPrototype}${END}\r
618\r
619VOID\r
620EFIAPI\r
621ProcessLibrary${Type}List (\r
622 IN EFI_PEI_FILE_HANDLE FileHandle,\r
623 IN CONST EFI_PEI_SERVICES **PeiServices\r
624 )\r
625{\r
626${BEGIN} EFI_STATUS Status;\r
627${FunctionCall}${END}\r
628}\r
629"""),\r
630\r
631'DXE' : TemplateString("""\r
632${BEGIN}${FunctionPrototype}${END}\r
633\r
634VOID\r
635EFIAPI\r
636ProcessLibrary${Type}List (\r
637 IN EFI_HANDLE ImageHandle,\r
638 IN EFI_SYSTEM_TABLE *SystemTable\r
639 )\r
640{\r
641${BEGIN} EFI_STATUS Status;\r
642${FunctionCall}${END}\r
643}\r
644"""),\r
645}\r
646\r
647gBasicHeaderFile = "Base.h"\r
648\r
649gModuleTypeHeaderFile = {\r
650 "BASE" : [gBasicHeaderFile],\r
651 "SEC" : ["PiPei.h", "Library/DebugLib.h"],\r
652 "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],\r
653 "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],\r
654 "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],\r
655 "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
656 "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
657 "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
658 "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
659 "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
660 "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],\r
661 "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],\r
662 "USER_DEFINED" : [gBasicHeaderFile]\r
663}\r
664\r
665## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName \r
666# the TokenName and Guid comparison to avoid define name collisions.\r
667#\r
668# @param Info The ModuleAutoGen object\r
669# @param AutoGenH The TemplateString object for header file\r
670#\r
671#\r
672def DynExPcdTokenNumberMapping(Info, AutoGenH):\r
673 ExTokenCNameList = []\r
674 PcdExList = []\r
675 if Info.IsLibrary:\r
676 PcdList = Info.LibraryPcdList\r
677 else:\r
678 PcdList = Info.ModulePcdList\r
679 for Pcd in PcdList:\r
680 if Pcd.Type in gDynamicExPcd:\r
681 ExTokenCNameList.append(Pcd.TokenCName)\r
682 PcdExList.append(Pcd)\r
683 if len(ExTokenCNameList) == 0:\r
684 return\r
685 AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')\r
686 # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.\r
687 # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter. \r
688 # Use the Guid pointer to see if it matches any of the token space GUIDs.\r
689 TokenCNameList = []\r
690 for TokenCName in ExTokenCNameList:\r
691 if TokenCName in TokenCNameList:\r
692 continue\r
693 Index = 0\r
694 Count = ExTokenCNameList.count(TokenCName)\r
695 for Pcd in PcdExList:\r
696 if Pcd.TokenCName == TokenCName:\r
697 Index = Index + 1\r
698 if Index == 1:\r
699 AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (Pcd.TokenCName))\r
700 AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
701 % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
702 else:\r
703 AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
704 % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
705 if Index == Count:\r
706 AutoGenH.Append('0 \\\n )\n')\r
707 TokenCNameList.append(TokenCName)\r
708 \r
709 TokenCNameList = []\r
710 for TokenCName in ExTokenCNameList:\r
711 if TokenCName in TokenCNameList:\r
712 continue\r
713 Index = 0\r
714 Count = ExTokenCNameList.count(TokenCName)\r
715 for Pcd in PcdExList:\r
716 if Pcd.Type in gDynamicExPcd and Pcd.TokenCName == TokenCName:\r
717 Index = Index + 1\r
718 if Index == 1:\r
719 AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (Pcd.TokenCName))\r
720 AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
721 % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
722 else:\r
723 AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
724 % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
725 if Index == Count:\r
726 AutoGenH.Append('0 \\\n )\n')\r
727 # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID. \r
728 # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler\r
729 # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().\r
730 # COMPAREGUID() will only be used if the Guid passed in is local to the module.\r
731 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
732 % (Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
733 TokenCNameList.append(TokenCName)\r
734\r
735## Create code for module PCDs\r
736#\r
737# @param Info The ModuleAutoGen object\r
738# @param AutoGenC The TemplateString object for C code\r
739# @param AutoGenH The TemplateString object for header file\r
740# @param Pcd The PCD object\r
741#\r
742def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
743 TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[Pcd.TokenSpaceGuidCName]\r
744 PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
745 #\r
746 # Write PCDs\r
747 #\r
748 PcdTokenName = '_PCD_TOKEN_' + Pcd.TokenCName\r
749 if Pcd.Type in gDynamicExPcd:\r
750 TokenNumber = int(Pcd.TokenValue, 0)\r
751 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with \r
752 # different Guids but same TokenCName\r
753 PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + Pcd.TokenCName\r
754 AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r
755 else:\r
756 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
757 # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
758 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
759 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
760 # report warning message notify the PI that they are attempting to build a module \r
761 # that must be included in a flash image in order to be functional. These Dynamic PCD \r
762 # will not be added into the Database unless it is used by other modules that are \r
763 # included in the FDF file. \r
764 # In this case, just assign an invalid token number to make it pass build.\r
765 if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
766 TokenNumber = 0\r
767 else:\r
768 EdkLogger.error("build", AUTOGEN_ERROR,\r
769 "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
770 ExtraData="[%s]" % str(Info))\r
771 else:\r
772 TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
773 AutoGenH.Append('\n#define %s %dU\n' % (PcdTokenName, TokenNumber))\r
774\r
775 EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + Pcd.TokenCName + "." + Pcd.TokenSpaceGuidCName)\r
776 if Pcd.Type not in gItemTypeStringDatabase:\r
777 EdkLogger.error("build", AUTOGEN_ERROR,\r
778 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
779 ExtraData="[%s]" % str(Info))\r
780 if Pcd.DatumType not in gDatumSizeStringDatabase:\r
781 EdkLogger.error("build", AUTOGEN_ERROR,\r
782 "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
783 ExtraData="[%s]" % str(Info))\r
784\r
785 DatumSize = gDatumSizeStringDatabase[Pcd.DatumType]\r
786 DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType]\r
787 GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + Pcd.TokenCName\r
788 SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + Pcd.TokenCName\r
789\r
790 PcdExCNameList = []\r
791 if Pcd.Type in gDynamicExPcd:\r
792 if Info.IsLibrary:\r
793 PcdList = Info.LibraryPcdList\r
794 else:\r
795 PcdList = Info.ModulePcdList\r
796 for PcdModule in PcdList:\r
797 if PcdModule.Type in gDynamicExPcd:\r
798 PcdExCNameList.append(PcdModule.TokenCName)\r
799 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r
800 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
801 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
802 if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
803 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
804 AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
805 AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
806 if Pcd.DatumType == 'VOID*':\r
807 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
808 else:\r
809 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
810 else:\r
811 AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
812 AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
813 if Pcd.DatumType == 'VOID*':\r
814 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
815 else:\r
816 AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
817 elif Pcd.Type in gDynamicPcd:\r
818 AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
819 if Pcd.DatumType == 'VOID*':\r
820 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
821 else:\r
822 AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
823 else:\r
824 PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + Pcd.TokenCName\r
825 Const = 'const'\r
826 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
827 Const = ''\r
828 Type = ''\r
829 Array = ''\r
830 Value = Pcd.DefaultValue\r
831 Unicode = False\r
832 ValueNumber = 0\r
833\r
834 if Pcd.DatumType == 'BOOLEAN':\r
835 BoolValue = Value.upper()\r
836 if BoolValue == 'TRUE' or BoolValue == '1':\r
837 Value = '1U'\r
838 elif BoolValue == 'FALSE' or BoolValue == '0':\r
839 Value = '0U'\r
840\r
841 if Pcd.DatumType in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:\r
842 try:\r
843 if Value.upper().startswith('0X'):\r
844 ValueNumber = int (Value, 16)\r
845 else:\r
846 ValueNumber = int (Value)\r
847 except:\r
848 EdkLogger.error("build", AUTOGEN_ERROR,\r
849 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
850 ExtraData="[%s]" % str(Info))\r
851 if Pcd.DatumType == 'UINT64':\r
852 if ValueNumber < 0:\r
853 EdkLogger.error("build", AUTOGEN_ERROR,\r
854 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
855 ExtraData="[%s]" % str(Info))\r
856 elif ValueNumber >= 0x10000000000000000:\r
857 EdkLogger.error("build", AUTOGEN_ERROR,\r
858 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
859 ExtraData="[%s]" % str(Info))\r
860 if not Value.endswith('ULL'):\r
861 Value += 'ULL'\r
862 elif Pcd.DatumType == 'UINT32':\r
863 if ValueNumber < 0:\r
864 EdkLogger.error("build", AUTOGEN_ERROR,\r
865 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
866 ExtraData="[%s]" % str(Info))\r
867 elif ValueNumber >= 0x100000000:\r
868 EdkLogger.error("build", AUTOGEN_ERROR,\r
869 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
870 ExtraData="[%s]" % str(Info))\r
871 if not Value.endswith('U'):\r
872 Value += 'U'\r
873 elif Pcd.DatumType == 'UINT16':\r
874 if ValueNumber < 0:\r
875 EdkLogger.error("build", AUTOGEN_ERROR,\r
876 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
877 ExtraData="[%s]" % str(Info))\r
878 elif ValueNumber >= 0x10000:\r
879 EdkLogger.error("build", AUTOGEN_ERROR,\r
880 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
881 ExtraData="[%s]" % str(Info))\r
882 if not Value.endswith('U'):\r
883 Value += 'U' \r
884 elif Pcd.DatumType == 'UINT8':\r
885 if ValueNumber < 0:\r
886 EdkLogger.error("build", AUTOGEN_ERROR,\r
887 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
888 ExtraData="[%s]" % str(Info))\r
889 elif ValueNumber >= 0x100:\r
890 EdkLogger.error("build", AUTOGEN_ERROR,\r
891 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
892 ExtraData="[%s]" % str(Info))\r
893 if not Value.endswith('U'):\r
894 Value += 'U'\r
895 if Pcd.DatumType == 'VOID*':\r
896 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':\r
897 EdkLogger.error("build", AUTOGEN_ERROR,\r
898 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
899 ExtraData="[%s]" % str(Info))\r
900\r
901 ArraySize = int(Pcd.MaxDatumSize, 0)\r
902 if Value[0] == '{':\r
903 Type = '(VOID *)'\r
904 else:\r
905 if Value[0] == 'L':\r
906 Unicode = True\r
907 Value = Value.lstrip('L') #.strip('"')\r
908 Value = eval(Value) # translate escape character\r
909 NewValue = '{'\r
910 for Index in range(0,len(Value)):\r
911 if Unicode:\r
912 NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r
913 else:\r
914 NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r
915 if Unicode:\r
916 ArraySize = ArraySize / 2;\r
917\r
918 if ArraySize < (len(Value) + 1):\r
919 EdkLogger.error("build", AUTOGEN_ERROR,\r
920 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
921 ExtraData="[%s]" % str(Info))\r
922 Value = NewValue + '0 }'\r
923 Array = '[%d]' % ArraySize\r
924 #\r
925 # skip casting for fixed at build since it breaks ARM assembly.\r
926 # Long term we need PCD macros that work in assembly\r
927 #\r
928 elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
929 Value = "((%s)%s)" % (Pcd.DatumType, Value)\r
930\r
931 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
932 PcdValueName = '_PCD_PATCHABLE_VALUE_' + Pcd.TokenCName\r
933 else:\r
934 PcdValueName = '_PCD_VALUE_' + Pcd.TokenCName\r
935 \r
936 if Pcd.DatumType == 'VOID*':\r
937 #\r
938 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r
939 #\r
940 if Unicode:\r
941 AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\r
942 AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
943 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
944 AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))\r
945 AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
946 else:\r
947 AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\r
948 AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
949 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
950 AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r
951 AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
952 elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
953 AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
954 AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
955 AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
956 AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
957 else:\r
958 AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
959 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
960 AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
961 AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
962\r
963 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
964 if Pcd.DatumType == 'VOID*':\r
965 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName))\r
966 else:\r
967 AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
968 else:\r
969 AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
970\r
971## Create code for library module PCDs\r
972#\r
973# @param Info The ModuleAutoGen object\r
974# @param AutoGenC The TemplateString object for C code\r
975# @param AutoGenH The TemplateString object for header file\r
976# @param Pcd The PCD object\r
977#\r
978def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
979 PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
980 TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r
981 TokenCName = Pcd.TokenCName\r
982 PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
983 #\r
984 # Write PCDs\r
985 #\r
986 if Pcd.Type in gDynamicExPcd:\r
987 TokenNumber = int(Pcd.TokenValue, 0)\r
988 else:\r
989 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
990 # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
991 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
992 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
993 # report warning message notify the PI that they are attempting to build a module \r
994 # that must be included in a flash image in order to be functional. These Dynamic PCD \r
995 # will not be added into the Database unless it is used by other modules that are \r
996 # included in the FDF file. \r
997 # In this case, just assign an invalid token number to make it pass build.\r
998 if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
999 TokenNumber = 0\r
1000 else:\r
1001 EdkLogger.error("build", AUTOGEN_ERROR,\r
1002 "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1003 ExtraData="[%s]" % str(Info))\r
1004 else:\r
1005 TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
1006\r
1007 if Pcd.Type not in gItemTypeStringDatabase:\r
1008 EdkLogger.error("build", AUTOGEN_ERROR,\r
1009 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1010 ExtraData="[%s]" % str(Info))\r
1011 if Pcd.DatumType not in gDatumSizeStringDatabase:\r
1012 EdkLogger.error("build", AUTOGEN_ERROR,\r
1013 "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1014 ExtraData="[%s]" % str(Info))\r
1015\r
1016 DatumType = Pcd.DatumType\r
1017 DatumSize = gDatumSizeStringDatabaseH[DatumType]\r
1018 DatumSizeLib= gDatumSizeStringDatabaseLib[DatumType]\r
1019 GetModeName = '_PCD_GET_MODE_' + DatumSize + '_' + TokenCName\r
1020 SetModeName = '_PCD_SET_MODE_' + DatumSize + '_' + TokenCName\r
1021\r
1022 Type = ''\r
1023 Array = ''\r
1024 if Pcd.DatumType == 'VOID*':\r
1025 Type = '(VOID *)'\r
1026 Array = '[]'\r
1027 PcdItemType = Pcd.Type\r
1028 PcdExCNameList = []\r
1029 if PcdItemType in gDynamicExPcd:\r
1030 PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + Pcd.TokenCName\r
1031 AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r
1032 \r
1033 if Info.IsLibrary:\r
1034 PcdList = Info.LibraryPcdList\r
1035 else:\r
1036 PcdList = Info.ModulePcdList\r
1037 for PcdModule in PcdList:\r
1038 if PcdModule.Type in gDynamicExPcd:\r
1039 PcdExCNameList.append(PcdModule.TokenCName)\r
1040 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r
1041 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
1042 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
1043 if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
1044 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
1045 AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
1046 AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1047 if Pcd.DatumType == 'VOID*':\r
1048 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1049 else:\r
1050 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1051 else:\r
1052 AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
1053 AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1054 if Pcd.DatumType == 'VOID*':\r
1055 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1056 else:\r
1057 AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1058 else:\r
1059 AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r
1060 if PcdItemType in gDynamicPcd:\r
1061 AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
1062 if DatumType == 'VOID*':\r
1063 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
1064 else:\r
1065 AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
1066 if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r
1067 PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r
1068 AutoGenH.Append('extern volatile %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array) )\r
1069 AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
1070 AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
1071 if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r
1072 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1073 \r
1074 AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r
1075 AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r
1076 AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
1077 \r
1078 if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and key in Info.ConstPcd:\r
1079 AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
1080 \r
1081\r
1082\r
1083## Create code for library constructor\r
1084#\r
1085# @param Info The ModuleAutoGen object\r
1086# @param AutoGenC The TemplateString object for C code\r
1087# @param AutoGenH The TemplateString object for header file\r
1088#\r
1089def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r
1090 #\r
1091 # Library Constructors\r
1092 #\r
1093 ConstructorPrototypeString = TemplateString()\r
1094 ConstructorCallingString = TemplateString()\r
1095 if Info.IsLibrary:\r
1096 DependentLibraryList = [Info.Module]\r
1097 else:\r
1098 DependentLibraryList = Info.DependentLibraryList\r
1099 for Lib in DependentLibraryList:\r
1100 if len(Lib.ConstructorList) <= 0:\r
1101 continue\r
1102 Dict = {'Function':Lib.ConstructorList}\r
1103 if Lib.ModuleType in ['BASE', 'SEC']:\r
1104 ConstructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
1105 ConstructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
1106 elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
1107 ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
1108 ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
1109 elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1110 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1111 ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
1112 ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
1113\r
1114 if str(ConstructorPrototypeString) == '':\r
1115 ConstructorPrototypeList = []\r
1116 else:\r
1117 ConstructorPrototypeList = [str(ConstructorPrototypeString)]\r
1118 if str(ConstructorCallingString) == '':\r
1119 ConstructorCallingList = []\r
1120 else:\r
1121 ConstructorCallingList = [str(ConstructorCallingString)]\r
1122\r
1123 Dict = {\r
1124 'Type' : 'Constructor',\r
1125 'FunctionPrototype' : ConstructorPrototypeList,\r
1126 'FunctionCall' : ConstructorCallingList\r
1127 }\r
1128 if Info.IsLibrary:\r
1129 AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
1130 else:\r
1131 if Info.ModuleType in ['BASE', 'SEC']:\r
1132 AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
1133 elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
1134 AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
1135 elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1136 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1137 AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
1138\r
1139## Create code for library destructor\r
1140#\r
1141# @param Info The ModuleAutoGen object\r
1142# @param AutoGenC The TemplateString object for C code\r
1143# @param AutoGenH The TemplateString object for header file\r
1144#\r
1145def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):\r
1146 #\r
1147 # Library Destructors\r
1148 #\r
1149 DestructorPrototypeString = TemplateString()\r
1150 DestructorCallingString = TemplateString()\r
1151 if Info.IsLibrary:\r
1152 DependentLibraryList = [Info.Module]\r
1153 else:\r
1154 DependentLibraryList = Info.DependentLibraryList\r
1155 for Index in range(len(DependentLibraryList)-1, -1, -1):\r
1156 Lib = DependentLibraryList[Index]\r
1157 if len(Lib.DestructorList) <= 0:\r
1158 continue\r
1159 Dict = {'Function':Lib.DestructorList}\r
1160 if Lib.ModuleType in ['BASE', 'SEC']:\r
1161 DestructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
1162 DestructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
1163 elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
1164 DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
1165 DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
1166 elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1167 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:\r
1168 DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
1169 DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
1170\r
1171 if str(DestructorPrototypeString) == '':\r
1172 DestructorPrototypeList = []\r
1173 else:\r
1174 DestructorPrototypeList = [str(DestructorPrototypeString)]\r
1175 if str(DestructorCallingString) == '':\r
1176 DestructorCallingList = []\r
1177 else:\r
1178 DestructorCallingList = [str(DestructorCallingString)]\r
1179\r
1180 Dict = {\r
1181 'Type' : 'Destructor',\r
1182 'FunctionPrototype' : DestructorPrototypeList,\r
1183 'FunctionCall' : DestructorCallingList\r
1184 }\r
1185 if Info.IsLibrary:\r
1186 AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
1187 else:\r
1188 if Info.ModuleType in ['BASE', 'SEC']:\r
1189 AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
1190 elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
1191 AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
1192 elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1193 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1194 AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
1195\r
1196\r
1197## Create code for ModuleEntryPoint\r
1198#\r
1199# @param Info The ModuleAutoGen object\r
1200# @param AutoGenC The TemplateString object for C code\r
1201# @param AutoGenH The TemplateString object for header file\r
1202#\r
1203def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):\r
1204 if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
1205 return\r
1206 #\r
1207 # Module Entry Points\r
1208 #\r
1209 NumEntryPoints = len(Info.Module.ModuleEntryPointList)\r
1210 if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
1211 PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']\r
1212 else:\r
1213 PiSpecVersion = '0x00000000'\r
1214 if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
1215 UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']\r
1216 else:\r
1217 UefiSpecVersion = '0x00000000'\r
1218 Dict = {\r
1219 'Function' : Info.Module.ModuleEntryPointList,\r
1220 'PiSpecVersion' : PiSpecVersion + 'U',\r
1221 'UefiSpecVersion': UefiSpecVersion + 'U'\r
1222 }\r
1223\r
1224 if Info.ModuleType in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:\r
1225 if Info.SourceFileList <> None and Info.SourceFileList <> []:\r
1226 if NumEntryPoints != 1:\r
1227 EdkLogger.error(\r
1228 "build",\r
1229 AUTOGEN_ERROR,\r
1230 '%s must have exactly one entry point' % Info.ModuleType,\r
1231 File=str(Info),\r
1232 ExtraData= ", ".join(Info.Module.ModuleEntryPointList)\r
1233 )\r
1234 if Info.ModuleType == 'PEI_CORE':\r
1235 AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))\r
1236 AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))\r
1237 elif Info.ModuleType == 'DXE_CORE':\r
1238 AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))\r
1239 AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))\r
1240 elif Info.ModuleType == 'SMM_CORE':\r
1241 AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))\r
1242 AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))\r
1243 elif Info.ModuleType == 'PEIM':\r
1244 if NumEntryPoints < 2:\r
1245 AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))\r
1246 else:\r
1247 AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))\r
1248 AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))\r
1249 elif Info.ModuleType in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:\r
1250 if NumEntryPoints < 2:\r
1251 AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))\r
1252 else:\r
1253 AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))\r
1254 AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))\r
1255 elif Info.ModuleType == 'DXE_SMM_DRIVER':\r
1256 if NumEntryPoints == 0:\r
1257 AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))\r
1258 else:\r
1259 AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))\r
1260 AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict)) \r
1261 elif Info.ModuleType == 'UEFI_APPLICATION':\r
1262 if NumEntryPoints < 2:\r
1263 AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r
1264 else:\r
1265 AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r
1266 AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r
1267\r
1268## Create code for ModuleUnloadImage\r
1269#\r
1270# @param Info The ModuleAutoGen object\r
1271# @param AutoGenC The TemplateString object for C code\r
1272# @param AutoGenH The TemplateString object for header file\r
1273#\r
1274def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r
1275 if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
1276 return\r
1277 #\r
1278 # Unload Image Handlers\r
1279 #\r
1280 NumUnloadImage = len(Info.Module.ModuleUnloadImageList)\r
1281 Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}\r
1282 if NumUnloadImage < 2:\r
1283 AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r
1284 else:\r
1285 AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r
1286 AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r
1287\r
1288## Create code for GUID\r
1289#\r
1290# @param Info The ModuleAutoGen object\r
1291# @param AutoGenC The TemplateString object for C code\r
1292# @param AutoGenH The TemplateString object for header file\r
1293#\r
1294def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r
1295 if Info.IsLibrary:\r
1296 return\r
1297\r
1298 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1299 GuidType = "GUID"\r
1300 else:\r
1301 GuidType = "EFI_GUID"\r
1302\r
1303 if Info.GuidList:\r
1304 AutoGenC.Append("\n// Guids\n")\r
1305 #\r
1306 # GUIDs\r
1307 #\r
1308 for Key in Info.GuidList:\r
1309 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r
1310\r
1311## Create code for protocol\r
1312#\r
1313# @param Info The ModuleAutoGen object\r
1314# @param AutoGenC The TemplateString object for C code\r
1315# @param AutoGenH The TemplateString object for header file\r
1316#\r
1317def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r
1318 if Info.IsLibrary:\r
1319 return\r
1320\r
1321 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1322 GuidType = "GUID"\r
1323 else:\r
1324 GuidType = "EFI_GUID"\r
1325\r
1326 if Info.ProtocolList:\r
1327 AutoGenC.Append("\n// Protocols\n")\r
1328 #\r
1329 # Protocol GUIDs\r
1330 #\r
1331 for Key in Info.ProtocolList:\r
1332 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r
1333\r
1334## Create code for PPI\r
1335#\r
1336# @param Info The ModuleAutoGen object\r
1337# @param AutoGenC The TemplateString object for C code\r
1338# @param AutoGenH The TemplateString object for header file\r
1339#\r
1340def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r
1341 if Info.IsLibrary:\r
1342 return\r
1343\r
1344 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1345 GuidType = "GUID"\r
1346 else:\r
1347 GuidType = "EFI_GUID"\r
1348\r
1349 if Info.PpiList:\r
1350 AutoGenC.Append("\n// PPIs\n")\r
1351 #\r
1352 # PPI GUIDs\r
1353 #\r
1354 for Key in Info.PpiList:\r
1355 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r
1356\r
1357## Create code for PCD\r
1358#\r
1359# @param Info The ModuleAutoGen object\r
1360# @param AutoGenC The TemplateString object for C code\r
1361# @param AutoGenH The TemplateString object for header file\r
1362#\r
1363def CreatePcdCode(Info, AutoGenC, AutoGenH):\r
1364\r
1365 # Collect Token Space GUIDs used by DynamicEc PCDs\r
1366 TokenSpaceList = []\r
1367 for Pcd in Info.ModulePcdList:\r
1368 if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
1369 TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r
1370 \r
1371 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found\r
1372 if TokenSpaceList <> []: \r
1373 AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r
1374 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1375 GuidType = "GUID"\r
1376 else:\r
1377 GuidType = "EFI_GUID" \r
1378 for Item in TokenSpaceList:\r
1379 AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))\r
1380\r
1381 if Info.IsLibrary:\r
1382 if Info.ModulePcdList:\r
1383 AutoGenH.Append("\n// PCD definitions\n")\r
1384 for Pcd in Info.ModulePcdList:\r
1385 CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
1386 DynExPcdTokenNumberMapping (Info, AutoGenH)\r
1387 else:\r
1388 if Info.ModulePcdList:\r
1389 AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r
1390 AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r
1391 for Pcd in Info.ModulePcdList:\r
1392 CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
1393 DynExPcdTokenNumberMapping (Info, AutoGenH)\r
1394 if Info.LibraryPcdList:\r
1395 AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r
1396 AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r
1397 for Pcd in Info.LibraryPcdList:\r
1398 CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r
1399 CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r
1400\r
1401## Create code for unicode string definition\r
1402#\r
1403# @param Info The ModuleAutoGen object\r
1404# @param AutoGenC The TemplateString object for C code\r
1405# @param AutoGenH The TemplateString object for header file\r
1406# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
1407# @param UniGenBinBuffer Buffer to store uni string package data\r
1408#\r
1409def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r
1410 WorkingDir = os.getcwd()\r
1411 os.chdir(Info.WorkspaceDir)\r
1412\r
1413 IncList = [Info.MetaFile.Dir]\r
1414 # Get all files under [Sources] section in inf file for EDK-II module\r
1415 EDK2Module = True\r
1416 SrcList = [F for F in Info.SourceFileList]\r
1417 if Info.AutoGenVersion < 0x00010005:\r
1418 EDK2Module = False\r
1419 # Get all files under the module directory for EDK-I module\r
1420 Cwd = os.getcwd()\r
1421 os.chdir(Info.MetaFile.Dir)\r
1422 for Root, Dirs, Files in os.walk("."):\r
1423 if 'CVS' in Dirs:\r
1424 Dirs.remove('CVS')\r
1425 if '.svn' in Dirs:\r
1426 Dirs.remove('.svn')\r
1427 for File in Files:\r
1428 File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)\r
1429 if File in SrcList:\r
1430 continue\r
1431 SrcList.append(File)\r
1432 os.chdir(Cwd)\r
1433\r
1434 if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r
1435 CompatibleMode = True\r
1436 else:\r
1437 CompatibleMode = False\r
1438\r
1439 #\r
1440 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r
1441 #\r
1442 if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r
1443 if CompatibleMode:\r
1444 EdkLogger.error("build", AUTOGEN_ERROR,\r
1445 "-c and -s build options should be used exclusively",\r
1446 ExtraData="[%s]" % str(Info))\r
1447 ShellMode = True\r
1448 else:\r
1449 ShellMode = False\r
1450\r
1451 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r
1452 if EDK2Module:\r
1453 FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r
1454 else:\r
1455 FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r
1456 Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r
1457 if CompatibleMode or UniGenCFlag:\r
1458 AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r
1459 AutoGenC.Append(Code)\r
1460 AutoGenC.Append("\n")\r
1461 AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r
1462 AutoGenH.Append(Header)\r
1463 if CompatibleMode or UniGenCFlag:\r
1464 AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r
1465 os.chdir(WorkingDir)\r
1466\r
1467## Create common code\r
1468#\r
1469# @param Info The ModuleAutoGen object\r
1470# @param AutoGenC The TemplateString object for C code\r
1471# @param AutoGenH The TemplateString object for header file\r
1472#\r
1473def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r
1474 # file header\r
1475 AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r
1476 # header file Prologue\r
1477 AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))\r
1478 AutoGenH.Append(gAutoGenHCppPrologueString)\r
1479 if Info.AutoGenVersion >= 0x00010005:\r
1480 # header files includes\r
1481 AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)\r
1482 if Info.ModuleType in gModuleTypeHeaderFile \\r
1483 and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:\r
1484 AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r
1485 #\r
1486 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h \r
1487 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r
1488 #\r
1489 if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r
1490 AutoGenH.Append("#include <Library/PcdLib.h>\n")\r
1491\r
1492 AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r
1493 AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r
1494\r
1495 if Info.IsLibrary:\r
1496 return\r
1497\r
1498 AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\r
1499\r
1500 if Info.IsLibrary:\r
1501 return\r
1502 # C file header\r
1503 AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r
1504 if Info.AutoGenVersion >= 0x00010005:\r
1505 # C file header files includes\r
1506 if Info.ModuleType in gModuleTypeHeaderFile:\r
1507 for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r
1508 AutoGenC.Append("#include <%s>\n" % Inc)\r
1509 else:\r
1510 AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r
1511\r
1512 #\r
1513 # Publish the CallerId Guid\r
1514 #\r
1515 AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r
1516 AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r
1517\r
1518## Create common code for header file\r
1519#\r
1520# @param Info The ModuleAutoGen object\r
1521# @param AutoGenC The TemplateString object for C code\r
1522# @param AutoGenH The TemplateString object for header file\r
1523#\r
1524def CreateFooterCode(Info, AutoGenC, AutoGenH):\r
1525 AutoGenH.Append(gAutoGenHEpilogueString)\r
1526\r
1527## Create code for a module\r
1528#\r
1529# @param Info The ModuleAutoGen object\r
1530# @param AutoGenC The TemplateString object for C code\r
1531# @param AutoGenH The TemplateString object for header file\r
1532# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
1533# @param UniGenBinBuffer Buffer to store uni string package data\r
1534#\r
1535def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):\r
1536 CreateHeaderCode(Info, AutoGenC, AutoGenH)\r
1537\r
1538 if Info.AutoGenVersion >= 0x00010005:\r
1539 CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r
1540 CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r
1541 CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r
1542 CreatePcdCode(Info, AutoGenC, AutoGenH)\r
1543 CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r
1544 CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r
1545 CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r
1546 CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r
1547\r
1548 if Info.UnicodeFileList:\r
1549 FileName = "%sStrDefs.h" % Info.Name\r
1550 StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
1551 StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
1552 CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r
1553 StringH.Append("\n#endif\n")\r
1554 AutoGenH.Append('#include "%s"\n' % FileName)\r
1555\r
1556 CreateFooterCode(Info, AutoGenC, AutoGenH)\r
1557\r
1558 # no generation of AutoGen.c for Edk modules without unicode file\r
1559 if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:\r
1560 AutoGenC.String = ''\r
1561\r
1562## Create the code file\r
1563#\r
1564# @param FilePath The path of code file\r
1565# @param Content The content of code file\r
1566# @param IsBinaryFile The flag indicating if the file is binary file or not\r
1567#\r
1568# @retval True If file content is changed or file doesn't exist\r
1569# @retval False If the file exists and the content is not changed\r
1570#\r
1571def Generate(FilePath, Content, IsBinaryFile):\r
1572 return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r
1573\r