]> git.proxmox.com Git - mirror_edk2.git/blame - BaseTools/Source/Python/AutoGen/GenC.py
MdeModulePkg: Add old IPv4_DEVICE_PATH support for new IScsiDxe
[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
82a6a960 4# Copyright (c) 2007 - 2015, 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
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
82a6a960 789 SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + Pcd.TokenCName\r
f51461c8
LG
790\r
791 PcdExCNameList = []\r
792 if Pcd.Type in gDynamicExPcd:\r
793 if Info.IsLibrary:\r
794 PcdList = Info.LibraryPcdList\r
795 else:\r
796 PcdList = Info.ModulePcdList\r
797 for PcdModule in PcdList:\r
798 if PcdModule.Type in gDynamicExPcd:\r
799 PcdExCNameList.append(PcdModule.TokenCName)\r
800 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r
801 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
802 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
803 if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
804 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
805 AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
806 AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
807 if Pcd.DatumType == 'VOID*':\r
808 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 809 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
810 else:\r
811 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 812 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
813 else:\r
814 AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
815 AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
816 if Pcd.DatumType == 'VOID*':\r
817 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 818 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
819 else:\r
820 AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 821 AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
822 elif Pcd.Type in gDynamicPcd:\r
823 AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
824 if Pcd.DatumType == 'VOID*':\r
825 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
82a6a960 826 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
f51461c8
LG
827 else:\r
828 AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
82a6a960 829 AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
f51461c8
LG
830 else:\r
831 PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + Pcd.TokenCName\r
832 Const = 'const'\r
833 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
834 Const = ''\r
835 Type = ''\r
836 Array = ''\r
837 Value = Pcd.DefaultValue\r
838 Unicode = False\r
839 ValueNumber = 0\r
840\r
841 if Pcd.DatumType == 'BOOLEAN':\r
842 BoolValue = Value.upper()\r
843 if BoolValue == 'TRUE' or BoolValue == '1':\r
844 Value = '1U'\r
845 elif BoolValue == 'FALSE' or BoolValue == '0':\r
846 Value = '0U'\r
847\r
848 if Pcd.DatumType in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:\r
849 try:\r
850 if Value.upper().startswith('0X'):\r
851 ValueNumber = int (Value, 16)\r
852 else:\r
853 ValueNumber = int (Value)\r
854 except:\r
855 EdkLogger.error("build", AUTOGEN_ERROR,\r
856 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
857 ExtraData="[%s]" % str(Info))\r
858 if Pcd.DatumType == 'UINT64':\r
859 if ValueNumber < 0:\r
860 EdkLogger.error("build", AUTOGEN_ERROR,\r
861 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
862 ExtraData="[%s]" % str(Info))\r
863 elif ValueNumber >= 0x10000000000000000:\r
864 EdkLogger.error("build", AUTOGEN_ERROR,\r
865 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
866 ExtraData="[%s]" % str(Info))\r
867 if not Value.endswith('ULL'):\r
868 Value += 'ULL'\r
869 elif Pcd.DatumType == 'UINT32':\r
870 if ValueNumber < 0:\r
871 EdkLogger.error("build", AUTOGEN_ERROR,\r
872 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
873 ExtraData="[%s]" % str(Info))\r
874 elif ValueNumber >= 0x100000000:\r
875 EdkLogger.error("build", AUTOGEN_ERROR,\r
876 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
877 ExtraData="[%s]" % str(Info))\r
878 if not Value.endswith('U'):\r
879 Value += 'U'\r
880 elif Pcd.DatumType == 'UINT16':\r
881 if ValueNumber < 0:\r
882 EdkLogger.error("build", AUTOGEN_ERROR,\r
883 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
884 ExtraData="[%s]" % str(Info))\r
885 elif ValueNumber >= 0x10000:\r
886 EdkLogger.error("build", AUTOGEN_ERROR,\r
887 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
888 ExtraData="[%s]" % str(Info))\r
889 if not Value.endswith('U'):\r
890 Value += 'U' \r
891 elif Pcd.DatumType == 'UINT8':\r
892 if ValueNumber < 0:\r
893 EdkLogger.error("build", AUTOGEN_ERROR,\r
894 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
895 ExtraData="[%s]" % str(Info))\r
896 elif ValueNumber >= 0x100:\r
897 EdkLogger.error("build", AUTOGEN_ERROR,\r
898 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
899 ExtraData="[%s]" % str(Info))\r
900 if not Value.endswith('U'):\r
901 Value += 'U'\r
902 if Pcd.DatumType == 'VOID*':\r
903 if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':\r
904 EdkLogger.error("build", AUTOGEN_ERROR,\r
905 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
906 ExtraData="[%s]" % str(Info))\r
907\r
908 ArraySize = int(Pcd.MaxDatumSize, 0)\r
909 if Value[0] == '{':\r
910 Type = '(VOID *)'\r
911 else:\r
912 if Value[0] == 'L':\r
913 Unicode = True\r
914 Value = Value.lstrip('L') #.strip('"')\r
915 Value = eval(Value) # translate escape character\r
916 NewValue = '{'\r
917 for Index in range(0,len(Value)):\r
918 if Unicode:\r
919 NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r
920 else:\r
921 NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r
922 if Unicode:\r
923 ArraySize = ArraySize / 2;\r
924\r
925 if ArraySize < (len(Value) + 1):\r
926 EdkLogger.error("build", AUTOGEN_ERROR,\r
927 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
928 ExtraData="[%s]" % str(Info))\r
929 Value = NewValue + '0 }'\r
930 Array = '[%d]' % ArraySize\r
931 #\r
932 # skip casting for fixed at build since it breaks ARM assembly.\r
933 # Long term we need PCD macros that work in assembly\r
934 #\r
935 elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
936 Value = "((%s)%s)" % (Pcd.DatumType, Value)\r
937\r
938 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
939 PcdValueName = '_PCD_PATCHABLE_VALUE_' + Pcd.TokenCName\r
940 else:\r
941 PcdValueName = '_PCD_VALUE_' + Pcd.TokenCName\r
942 \r
943 if Pcd.DatumType == 'VOID*':\r
944 #\r
945 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r
946 #\r
947 if Unicode:\r
948 AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\r
949 AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
950 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
951 AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))\r
952 AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
953 else:\r
954 AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\r
955 AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
956 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
957 AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r
958 AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
959 elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
960 AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
961 AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
962 AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
963 AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
964 else:\r
965 AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
966 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
967 AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
968 AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
969\r
970 if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
971 if Pcd.DatumType == 'VOID*':\r
972 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName))\r
82a6a960 973 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrS(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, Pcd.TokenCName, Pcd.TokenCName))\r
f51461c8
LG
974 else:\r
975 AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
82a6a960 976 AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName, PcdVariableName))\r
f51461c8
LG
977 else:\r
978 AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
979\r
980## Create code for library module PCDs\r
981#\r
982# @param Info The ModuleAutoGen object\r
983# @param AutoGenC The TemplateString object for C code\r
984# @param AutoGenH The TemplateString object for header file\r
985# @param Pcd The PCD object\r
986#\r
987def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
988 PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
989 TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r
990 TokenCName = Pcd.TokenCName\r
991 PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
992 #\r
993 # Write PCDs\r
994 #\r
995 if Pcd.Type in gDynamicExPcd:\r
996 TokenNumber = int(Pcd.TokenValue, 0)\r
997 else:\r
998 if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
999 # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
1000 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
1001 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
1002 # report warning message notify the PI that they are attempting to build a module \r
1003 # that must be included in a flash image in order to be functional. These Dynamic PCD \r
1004 # will not be added into the Database unless it is used by other modules that are \r
1005 # included in the FDF file. \r
1006 # In this case, just assign an invalid token number to make it pass build.\r
1007 if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
1008 TokenNumber = 0\r
1009 else:\r
1010 EdkLogger.error("build", AUTOGEN_ERROR,\r
1011 "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1012 ExtraData="[%s]" % str(Info))\r
1013 else:\r
1014 TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
1015\r
1016 if Pcd.Type not in gItemTypeStringDatabase:\r
1017 EdkLogger.error("build", AUTOGEN_ERROR,\r
1018 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1019 ExtraData="[%s]" % str(Info))\r
1020 if Pcd.DatumType not in gDatumSizeStringDatabase:\r
1021 EdkLogger.error("build", AUTOGEN_ERROR,\r
1022 "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),\r
1023 ExtraData="[%s]" % str(Info))\r
1024\r
1025 DatumType = Pcd.DatumType\r
1026 DatumSize = gDatumSizeStringDatabaseH[DatumType]\r
1027 DatumSizeLib= gDatumSizeStringDatabaseLib[DatumType]\r
1028 GetModeName = '_PCD_GET_MODE_' + DatumSize + '_' + TokenCName\r
1029 SetModeName = '_PCD_SET_MODE_' + DatumSize + '_' + TokenCName\r
82a6a960 1030 SetModeStatusName = '_PCD_SET_MODE_' + DatumSize + '_S_' + TokenCName\r
f51461c8
LG
1031\r
1032 Type = ''\r
1033 Array = ''\r
1034 if Pcd.DatumType == 'VOID*':\r
1035 Type = '(VOID *)'\r
1036 Array = '[]'\r
1037 PcdItemType = Pcd.Type\r
1038 PcdExCNameList = []\r
1039 if PcdItemType in gDynamicExPcd:\r
1040 PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + Pcd.TokenCName\r
1041 AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r
1042 \r
1043 if Info.IsLibrary:\r
1044 PcdList = Info.LibraryPcdList\r
1045 else:\r
1046 PcdList = Info.ModulePcdList\r
1047 for PcdModule in PcdList:\r
1048 if PcdModule.Type in gDynamicExPcd:\r
1049 PcdExCNameList.append(PcdModule.TokenCName)\r
1050 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r
1051 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
1052 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
1053 if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
1054 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
1055 AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
1056 AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1057 if Pcd.DatumType == 'VOID*':\r
1058 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 1059 AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
1060 else:\r
1061 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 1062 AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
1063 else:\r
1064 AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
1065 AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
1066 if Pcd.DatumType == 'VOID*':\r
1067 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 1068 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
1069 else:\r
1070 AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
82a6a960 1071 AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
f51461c8
LG
1072 else:\r
1073 AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r
1074 if PcdItemType in gDynamicPcd:\r
1075 AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
1076 if DatumType == 'VOID*':\r
1077 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
82a6a960 1078 AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
f51461c8
LG
1079 else:\r
1080 AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
82a6a960 1081 AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
f51461c8
LG
1082 if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r
1083 PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r
1084 AutoGenH.Append('extern volatile %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array) )\r
1085 AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
1086 AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
82a6a960 1087 AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName, PcdVariableName))\r
f51461c8
LG
1088 if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r
1089 key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
1090 \r
1091 AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r
1092 AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r
1093 AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
1094 \r
1095 if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and key in Info.ConstPcd:\r
1096 AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
1097 \r
1098\r
1099\r
1100## Create code for library constructor\r
1101#\r
1102# @param Info The ModuleAutoGen object\r
1103# @param AutoGenC The TemplateString object for C code\r
1104# @param AutoGenH The TemplateString object for header file\r
1105#\r
1106def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r
1107 #\r
1108 # Library Constructors\r
1109 #\r
1110 ConstructorPrototypeString = TemplateString()\r
1111 ConstructorCallingString = TemplateString()\r
1112 if Info.IsLibrary:\r
1113 DependentLibraryList = [Info.Module]\r
1114 else:\r
1115 DependentLibraryList = Info.DependentLibraryList\r
1116 for Lib in DependentLibraryList:\r
1117 if len(Lib.ConstructorList) <= 0:\r
1118 continue\r
1119 Dict = {'Function':Lib.ConstructorList}\r
1120 if Lib.ModuleType in ['BASE', 'SEC']:\r
1121 ConstructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
1122 ConstructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
1123 elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
1124 ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
1125 ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
1126 elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1127 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1128 ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
1129 ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
1130\r
1131 if str(ConstructorPrototypeString) == '':\r
1132 ConstructorPrototypeList = []\r
1133 else:\r
1134 ConstructorPrototypeList = [str(ConstructorPrototypeString)]\r
1135 if str(ConstructorCallingString) == '':\r
1136 ConstructorCallingList = []\r
1137 else:\r
1138 ConstructorCallingList = [str(ConstructorCallingString)]\r
1139\r
1140 Dict = {\r
1141 'Type' : 'Constructor',\r
1142 'FunctionPrototype' : ConstructorPrototypeList,\r
1143 'FunctionCall' : ConstructorCallingList\r
1144 }\r
1145 if Info.IsLibrary:\r
1146 AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
1147 else:\r
1148 if Info.ModuleType in ['BASE', 'SEC']:\r
1149 AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
1150 elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
1151 AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
1152 elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1153 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1154 AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
1155\r
1156## Create code for library destructor\r
1157#\r
1158# @param Info The ModuleAutoGen object\r
1159# @param AutoGenC The TemplateString object for C code\r
1160# @param AutoGenH The TemplateString object for header file\r
1161#\r
1162def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):\r
1163 #\r
1164 # Library Destructors\r
1165 #\r
1166 DestructorPrototypeString = TemplateString()\r
1167 DestructorCallingString = TemplateString()\r
1168 if Info.IsLibrary:\r
1169 DependentLibraryList = [Info.Module]\r
1170 else:\r
1171 DependentLibraryList = Info.DependentLibraryList\r
1172 for Index in range(len(DependentLibraryList)-1, -1, -1):\r
1173 Lib = DependentLibraryList[Index]\r
1174 if len(Lib.DestructorList) <= 0:\r
1175 continue\r
1176 Dict = {'Function':Lib.DestructorList}\r
1177 if Lib.ModuleType in ['BASE', 'SEC']:\r
1178 DestructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
1179 DestructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
1180 elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
1181 DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
1182 DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
1183 elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1184 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:\r
1185 DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
1186 DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
1187\r
1188 if str(DestructorPrototypeString) == '':\r
1189 DestructorPrototypeList = []\r
1190 else:\r
1191 DestructorPrototypeList = [str(DestructorPrototypeString)]\r
1192 if str(DestructorCallingString) == '':\r
1193 DestructorCallingList = []\r
1194 else:\r
1195 DestructorCallingList = [str(DestructorCallingString)]\r
1196\r
1197 Dict = {\r
1198 'Type' : 'Destructor',\r
1199 'FunctionPrototype' : DestructorPrototypeList,\r
1200 'FunctionCall' : DestructorCallingList\r
1201 }\r
1202 if Info.IsLibrary:\r
1203 AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
1204 else:\r
1205 if Info.ModuleType in ['BASE', 'SEC']:\r
1206 AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
1207 elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
1208 AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
1209 elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
1210 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
1211 AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
1212\r
1213\r
1214## Create code for ModuleEntryPoint\r
1215#\r
1216# @param Info The ModuleAutoGen object\r
1217# @param AutoGenC The TemplateString object for C code\r
1218# @param AutoGenH The TemplateString object for header file\r
1219#\r
1220def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):\r
1221 if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
1222 return\r
1223 #\r
1224 # Module Entry Points\r
1225 #\r
1226 NumEntryPoints = len(Info.Module.ModuleEntryPointList)\r
1227 if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
1228 PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']\r
1229 else:\r
1230 PiSpecVersion = '0x00000000'\r
1231 if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
1232 UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']\r
1233 else:\r
1234 UefiSpecVersion = '0x00000000'\r
1235 Dict = {\r
1236 'Function' : Info.Module.ModuleEntryPointList,\r
1237 'PiSpecVersion' : PiSpecVersion + 'U',\r
1238 'UefiSpecVersion': UefiSpecVersion + 'U'\r
1239 }\r
1240\r
1241 if Info.ModuleType in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:\r
1242 if Info.SourceFileList <> None and Info.SourceFileList <> []:\r
1243 if NumEntryPoints != 1:\r
1244 EdkLogger.error(\r
1245 "build",\r
1246 AUTOGEN_ERROR,\r
1247 '%s must have exactly one entry point' % Info.ModuleType,\r
1248 File=str(Info),\r
1249 ExtraData= ", ".join(Info.Module.ModuleEntryPointList)\r
1250 )\r
1251 if Info.ModuleType == 'PEI_CORE':\r
1252 AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))\r
1253 AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))\r
1254 elif Info.ModuleType == 'DXE_CORE':\r
1255 AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))\r
1256 AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))\r
1257 elif Info.ModuleType == 'SMM_CORE':\r
1258 AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))\r
1259 AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))\r
1260 elif Info.ModuleType == 'PEIM':\r
1261 if NumEntryPoints < 2:\r
1262 AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))\r
1263 else:\r
1264 AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))\r
1265 AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))\r
1266 elif Info.ModuleType in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:\r
1267 if NumEntryPoints < 2:\r
1268 AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))\r
1269 else:\r
1270 AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))\r
1271 AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))\r
1272 elif Info.ModuleType == 'DXE_SMM_DRIVER':\r
1273 if NumEntryPoints == 0:\r
1274 AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))\r
1275 else:\r
1276 AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))\r
1277 AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict)) \r
1278 elif Info.ModuleType == 'UEFI_APPLICATION':\r
1279 if NumEntryPoints < 2:\r
1280 AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r
1281 else:\r
1282 AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r
1283 AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r
1284\r
1285## Create code for ModuleUnloadImage\r
1286#\r
1287# @param Info The ModuleAutoGen object\r
1288# @param AutoGenC The TemplateString object for C code\r
1289# @param AutoGenH The TemplateString object for header file\r
1290#\r
1291def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r
1292 if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
1293 return\r
1294 #\r
1295 # Unload Image Handlers\r
1296 #\r
1297 NumUnloadImage = len(Info.Module.ModuleUnloadImageList)\r
1298 Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}\r
1299 if NumUnloadImage < 2:\r
1300 AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r
1301 else:\r
1302 AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r
1303 AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r
1304\r
1305## Create code for GUID\r
1306#\r
1307# @param Info The ModuleAutoGen object\r
1308# @param AutoGenC The TemplateString object for C code\r
1309# @param AutoGenH The TemplateString object for header file\r
1310#\r
1311def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r
1312 if Info.IsLibrary:\r
1313 return\r
1314\r
1315 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1316 GuidType = "GUID"\r
1317 else:\r
1318 GuidType = "EFI_GUID"\r
1319\r
1320 if Info.GuidList:\r
1321 AutoGenC.Append("\n// Guids\n")\r
8262037f 1322 AutoGenH.Append("\n// Guids\n")\r
f51461c8
LG
1323 #\r
1324 # GUIDs\r
1325 #\r
1326 for Key in Info.GuidList:\r
1327 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r
8262037f 1328 AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
f51461c8
LG
1329\r
1330## Create code for protocol\r
1331#\r
1332# @param Info The ModuleAutoGen object\r
1333# @param AutoGenC The TemplateString object for C code\r
1334# @param AutoGenH The TemplateString object for header file\r
1335#\r
1336def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r
1337 if Info.IsLibrary:\r
1338 return\r
1339\r
1340 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1341 GuidType = "GUID"\r
1342 else:\r
1343 GuidType = "EFI_GUID"\r
1344\r
1345 if Info.ProtocolList:\r
1346 AutoGenC.Append("\n// Protocols\n")\r
8262037f 1347 AutoGenH.Append("\n// Protocols\n")\r
f51461c8
LG
1348 #\r
1349 # Protocol GUIDs\r
1350 #\r
1351 for Key in Info.ProtocolList:\r
1352 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r
8262037f 1353 AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
f51461c8
LG
1354\r
1355## Create code for PPI\r
1356#\r
1357# @param Info The ModuleAutoGen object\r
1358# @param AutoGenC The TemplateString object for C code\r
1359# @param AutoGenH The TemplateString object for header file\r
1360#\r
1361def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r
1362 if Info.IsLibrary:\r
1363 return\r
1364\r
1365 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1366 GuidType = "GUID"\r
1367 else:\r
1368 GuidType = "EFI_GUID"\r
1369\r
1370 if Info.PpiList:\r
1371 AutoGenC.Append("\n// PPIs\n")\r
8262037f 1372 AutoGenH.Append("\n// PPIs\n")\r
f51461c8
LG
1373 #\r
1374 # PPI GUIDs\r
1375 #\r
1376 for Key in Info.PpiList:\r
1377 AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r
8262037f 1378 AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
f51461c8
LG
1379\r
1380## Create code for PCD\r
1381#\r
1382# @param Info The ModuleAutoGen object\r
1383# @param AutoGenC The TemplateString object for C code\r
1384# @param AutoGenH The TemplateString object for header file\r
1385#\r
1386def CreatePcdCode(Info, AutoGenC, AutoGenH):\r
1387\r
1388 # Collect Token Space GUIDs used by DynamicEc PCDs\r
1389 TokenSpaceList = []\r
1390 for Pcd in Info.ModulePcdList:\r
1391 if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
1392 TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r
1393 \r
1394 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found\r
1395 if TokenSpaceList <> []: \r
1396 AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r
1397 if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
1398 GuidType = "GUID"\r
1399 else:\r
1400 GuidType = "EFI_GUID" \r
1401 for Item in TokenSpaceList:\r
1402 AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))\r
1403\r
1404 if Info.IsLibrary:\r
1405 if Info.ModulePcdList:\r
1406 AutoGenH.Append("\n// PCD definitions\n")\r
1407 for Pcd in Info.ModulePcdList:\r
1408 CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
1409 DynExPcdTokenNumberMapping (Info, AutoGenH)\r
1410 else:\r
1411 if Info.ModulePcdList:\r
1412 AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r
1413 AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r
1414 for Pcd in Info.ModulePcdList:\r
1415 CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
1416 DynExPcdTokenNumberMapping (Info, AutoGenH)\r
1417 if Info.LibraryPcdList:\r
1418 AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r
1419 AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r
1420 for Pcd in Info.LibraryPcdList:\r
1421 CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r
1422 CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r
1423\r
1424## Create code for unicode string definition\r
1425#\r
1426# @param Info The ModuleAutoGen object\r
1427# @param AutoGenC The TemplateString object for C code\r
1428# @param AutoGenH The TemplateString object for header file\r
1429# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
1430# @param UniGenBinBuffer Buffer to store uni string package data\r
1431#\r
1432def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r
1433 WorkingDir = os.getcwd()\r
1434 os.chdir(Info.WorkspaceDir)\r
1435\r
1436 IncList = [Info.MetaFile.Dir]\r
1437 # Get all files under [Sources] section in inf file for EDK-II module\r
1438 EDK2Module = True\r
1439 SrcList = [F for F in Info.SourceFileList]\r
1440 if Info.AutoGenVersion < 0x00010005:\r
1441 EDK2Module = False\r
1442 # Get all files under the module directory for EDK-I module\r
1443 Cwd = os.getcwd()\r
1444 os.chdir(Info.MetaFile.Dir)\r
1445 for Root, Dirs, Files in os.walk("."):\r
1446 if 'CVS' in Dirs:\r
1447 Dirs.remove('CVS')\r
1448 if '.svn' in Dirs:\r
1449 Dirs.remove('.svn')\r
1450 for File in Files:\r
1451 File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)\r
1452 if File in SrcList:\r
1453 continue\r
1454 SrcList.append(File)\r
1455 os.chdir(Cwd)\r
1456\r
1457 if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r
1458 CompatibleMode = True\r
1459 else:\r
1460 CompatibleMode = False\r
1461\r
1462 #\r
1463 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r
1464 #\r
1465 if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r
1466 if CompatibleMode:\r
1467 EdkLogger.error("build", AUTOGEN_ERROR,\r
1468 "-c and -s build options should be used exclusively",\r
1469 ExtraData="[%s]" % str(Info))\r
1470 ShellMode = True\r
1471 else:\r
1472 ShellMode = False\r
1473\r
1474 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r
1475 if EDK2Module:\r
1476 FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r
1477 else:\r
1478 FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r
1479 Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r
1480 if CompatibleMode or UniGenCFlag:\r
1481 AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r
1482 AutoGenC.Append(Code)\r
1483 AutoGenC.Append("\n")\r
1484 AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r
1485 AutoGenH.Append(Header)\r
1486 if CompatibleMode or UniGenCFlag:\r
1487 AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r
1488 os.chdir(WorkingDir)\r
1489\r
1490## Create common code\r
1491#\r
1492# @param Info The ModuleAutoGen object\r
1493# @param AutoGenC The TemplateString object for C code\r
1494# @param AutoGenH The TemplateString object for header file\r
1495#\r
1496def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r
1497 # file header\r
1498 AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r
1499 # header file Prologue\r
1500 AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))\r
1501 AutoGenH.Append(gAutoGenHCppPrologueString)\r
1502 if Info.AutoGenVersion >= 0x00010005:\r
1503 # header files includes\r
1504 AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)\r
1505 if Info.ModuleType in gModuleTypeHeaderFile \\r
1506 and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:\r
1507 AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r
1508 #\r
1509 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h \r
1510 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r
1511 #\r
1512 if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r
1513 AutoGenH.Append("#include <Library/PcdLib.h>\n")\r
1514\r
1515 AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r
1516 AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r
1517\r
1518 if Info.IsLibrary:\r
1519 return\r
1520\r
1521 AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\r
1522\r
1523 if Info.IsLibrary:\r
1524 return\r
1525 # C file header\r
1526 AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r
1527 if Info.AutoGenVersion >= 0x00010005:\r
1528 # C file header files includes\r
1529 if Info.ModuleType in gModuleTypeHeaderFile:\r
1530 for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r
1531 AutoGenC.Append("#include <%s>\n" % Inc)\r
1532 else:\r
1533 AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r
1534\r
1535 #\r
1536 # Publish the CallerId Guid\r
1537 #\r
1538 AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r
1539 AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r
1540\r
1541## Create common code for header file\r
1542#\r
1543# @param Info The ModuleAutoGen object\r
1544# @param AutoGenC The TemplateString object for C code\r
1545# @param AutoGenH The TemplateString object for header file\r
1546#\r
1547def CreateFooterCode(Info, AutoGenC, AutoGenH):\r
1548 AutoGenH.Append(gAutoGenHEpilogueString)\r
1549\r
1550## Create code for a module\r
1551#\r
1552# @param Info The ModuleAutoGen object\r
1553# @param AutoGenC The TemplateString object for C code\r
1554# @param AutoGenH The TemplateString object for header file\r
1555# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
1556# @param UniGenBinBuffer Buffer to store uni string package data\r
1557#\r
1558def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):\r
1559 CreateHeaderCode(Info, AutoGenC, AutoGenH)\r
1560\r
1561 if Info.AutoGenVersion >= 0x00010005:\r
1562 CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r
1563 CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r
1564 CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r
1565 CreatePcdCode(Info, AutoGenC, AutoGenH)\r
1566 CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r
1567 CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r
1568 CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r
1569 CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r
1570\r
1571 if Info.UnicodeFileList:\r
1572 FileName = "%sStrDefs.h" % Info.Name\r
1573 StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
1574 StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
1575 CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r
8200fcfe
YL
1576\r
1577 GuidMacros = []\r
1578 for Guid in Info.Module.Guids:\r
1579 if Guid in Info.Module.GetGuidsUsedByPcd():\r
1580 continue\r
1581 GuidMacros.append('#define %s %s' % (Guid, Info.Module.Guids[Guid]))\r
1582 for Guid, Value in Info.Module.Protocols.items() + Info.Module.Ppis.items():\r
1583 GuidMacros.append('#define %s %s' % (Guid, Value))\r
1584 if GuidMacros:\r
1585 StringH.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros))\r
1586\r
f51461c8
LG
1587 StringH.Append("\n#endif\n")\r
1588 AutoGenH.Append('#include "%s"\n' % FileName)\r
1589\r
1590 CreateFooterCode(Info, AutoGenC, AutoGenH)\r
1591\r
1592 # no generation of AutoGen.c for Edk modules without unicode file\r
1593 if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:\r
1594 AutoGenC.String = ''\r
1595\r
1596## Create the code file\r
1597#\r
1598# @param FilePath The path of code file\r
1599# @param Content The content of code file\r
1600# @param IsBinaryFile The flag indicating if the file is binary file or not\r
1601#\r
1602# @retval True If file content is changed or file doesn't exist\r
1603# @retval False If the file exists and the content is not changed\r
1604#\r
1605def Generate(FilePath, Content, IsBinaryFile):\r
1606 return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r
1607\r