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