2 # Routines for generating AutoGen.h and AutoGen.c
4 # Copyright (c) 2007 - 2015, 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
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.
18 from Common
import EdkLogger
20 from Common
.BuildToolError
import *
21 from Common
.DataType
import *
22 from Common
.Misc
import *
23 from Common
.String
import StringToArray
24 from StrGather
import *
25 from GenPcdDb
import CreatePcdDatabaseCode
28 gItemTypeStringDatabase
= {
29 TAB_PCDS_FEATURE_FLAG
: 'FixedAtBuild',
30 TAB_PCDS_FIXED_AT_BUILD
: 'FixedAtBuild',
31 TAB_PCDS_PATCHABLE_IN_MODULE
: 'BinaryPatch',
32 TAB_PCDS_DYNAMIC
: '',
33 TAB_PCDS_DYNAMIC_DEFAULT
: '',
34 TAB_PCDS_DYNAMIC_VPD
: '',
35 TAB_PCDS_DYNAMIC_HII
: '',
36 TAB_PCDS_DYNAMIC_EX
: '',
37 TAB_PCDS_DYNAMIC_EX_DEFAULT
: '',
38 TAB_PCDS_DYNAMIC_EX_VPD
: '',
39 TAB_PCDS_DYNAMIC_EX_HII
: '',
43 gDynamicPcd
= [TAB_PCDS_DYNAMIC
, TAB_PCDS_DYNAMIC_DEFAULT
, TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_HII
]
45 ## Dynamic-ex PCD types
46 gDynamicExPcd
= [TAB_PCDS_DYNAMIC_EX
, TAB_PCDS_DYNAMIC_EX_DEFAULT
, TAB_PCDS_DYNAMIC_EX_VPD
, TAB_PCDS_DYNAMIC_EX_HII
]
49 gDatumSizeStringDatabase
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOLEAN','VOID*':'8'}
50 gDatumSizeStringDatabaseH
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOL','VOID*':'PTR'}
51 gDatumSizeStringDatabaseLib
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'Bool','VOID*':'Ptr'}
53 ## AutoGen File Header Templates
54 gAutoGenHeaderString
= TemplateString("""\
60 Abstract: Auto-generated ${FileName} for building module or library.
64 gAutoGenHPrologueString
= TemplateString("""
65 #ifndef _${File}_${Guid}
66 #define _${File}_${Guid}
70 gAutoGenHCppPrologueString
= """\
77 gAutoGenHEpilogueString
= """
86 ## PEI Core Entry Point Templates
87 gPeiCoreEntryPointPrototype
= TemplateString("""
92 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
93 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
99 gPeiCoreEntryPointString
= TemplateString("""
103 ProcessModuleEntryPointList (
104 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
105 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
110 ${Function} (SecCoreData, PpiList, Context);
116 ## DXE Core Entry Point Templates
117 gDxeCoreEntryPointPrototype
= TemplateString("""
127 gDxeCoreEntryPointString
= TemplateString("""
131 ProcessModuleEntryPointList (
136 ${Function} (HobStart);
141 ## PEIM Entry Point Templates
142 gPeimEntryPointPrototype
= TemplateString("""
147 IN EFI_PEI_FILE_HANDLE FileHandle,
148 IN CONST EFI_PEI_SERVICES **PeiServices
153 gPeimEntryPointString
= [
155 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
159 ProcessModuleEntryPointList (
160 IN EFI_PEI_FILE_HANDLE FileHandle,
161 IN CONST EFI_PEI_SERVICES **PeiServices
169 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
173 ProcessModuleEntryPointList (
174 IN EFI_PEI_FILE_HANDLE FileHandle,
175 IN CONST EFI_PEI_SERVICES **PeiServices
179 return ${Function} (FileHandle, PeiServices);
184 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
188 ProcessModuleEntryPointList (
189 IN EFI_PEI_FILE_HANDLE FileHandle,
190 IN CONST EFI_PEI_SERVICES **PeiServices
195 EFI_STATUS CombinedStatus;
197 CombinedStatus = EFI_LOAD_ERROR;
199 Status = ${Function} (FileHandle, PeiServices);
200 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
201 CombinedStatus = Status;
204 return CombinedStatus;
209 ## SMM_CORE Entry Point Templates
210 gSmmCoreEntryPointPrototype
= TemplateString("""
215 IN EFI_HANDLE ImageHandle,
216 IN EFI_SYSTEM_TABLE *SystemTable
221 gSmmCoreEntryPointString
= TemplateString("""
223 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
224 const UINT32 _gDxeRevision = ${PiSpecVersion};
228 ProcessModuleEntryPointList (
229 IN EFI_HANDLE ImageHandle,
230 IN EFI_SYSTEM_TABLE *SystemTable
233 return ${Function} (ImageHandle, SystemTable);
238 ## DXE SMM Entry Point Templates
239 gDxeSmmEntryPointPrototype
= TemplateString("""
244 IN EFI_HANDLE ImageHandle,
245 IN EFI_SYSTEM_TABLE *SystemTable
250 gDxeSmmEntryPointString
= [
252 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
253 const UINT32 _gDxeRevision = ${PiSpecVersion};
257 ProcessModuleEntryPointList (
258 IN EFI_HANDLE ImageHandle,
259 IN EFI_SYSTEM_TABLE *SystemTable
267 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
268 const UINT32 _gDxeRevision = ${PiSpecVersion};
270 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
271 static EFI_STATUS mDriverEntryPointStatus;
279 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
280 mDriverEntryPointStatus = Status;
282 LongJump (&mJumpContext, (UINTN)-1);
288 ProcessModuleEntryPointList (
289 IN EFI_HANDLE ImageHandle,
290 IN EFI_SYSTEM_TABLE *SystemTable
293 mDriverEntryPointStatus = EFI_LOAD_ERROR;
296 if (SetJump (&mJumpContext) == 0) {
297 ExitDriver (${Function} (ImageHandle, SystemTable));
302 return mDriverEntryPointStatus;
307 ## UEFI Driver Entry Point Templates
308 gUefiDriverEntryPointPrototype
= TemplateString("""
313 IN EFI_HANDLE ImageHandle,
314 IN EFI_SYSTEM_TABLE *SystemTable
319 gUefiDriverEntryPointString
= [
321 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
322 const UINT32 _gDxeRevision = ${PiSpecVersion};
326 ProcessModuleEntryPointList (
327 IN EFI_HANDLE ImageHandle,
328 IN EFI_SYSTEM_TABLE *SystemTable
335 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
336 const UINT32 _gDxeRevision = ${PiSpecVersion};
341 ProcessModuleEntryPointList (
342 IN EFI_HANDLE ImageHandle,
343 IN EFI_SYSTEM_TABLE *SystemTable
347 return ${Function} (ImageHandle, SystemTable);
356 if (EFI_ERROR (Status)) {
357 ProcessLibraryDestructorList (gImageHandle, gST);
359 gBS->Exit (gImageHandle, Status, 0, NULL);
363 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
364 const UINT32 _gDxeRevision = ${PiSpecVersion};
366 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
367 static EFI_STATUS mDriverEntryPointStatus;
371 ProcessModuleEntryPointList (
372 IN EFI_HANDLE ImageHandle,
373 IN EFI_SYSTEM_TABLE *SystemTable
376 mDriverEntryPointStatus = EFI_LOAD_ERROR;
378 if (SetJump (&mJumpContext) == 0) {
379 ExitDriver (${Function} (ImageHandle, SystemTable));
383 return mDriverEntryPointStatus;
392 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
393 mDriverEntryPointStatus = Status;
395 LongJump (&mJumpContext, (UINTN)-1);
402 ## UEFI Application Entry Point Templates
403 gUefiApplicationEntryPointPrototype
= TemplateString("""
408 IN EFI_HANDLE ImageHandle,
409 IN EFI_SYSTEM_TABLE *SystemTable
414 gUefiApplicationEntryPointString
= [
416 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
420 ProcessModuleEntryPointList (
421 IN EFI_HANDLE ImageHandle,
422 IN EFI_SYSTEM_TABLE *SystemTable
429 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
434 ProcessModuleEntryPointList (
435 IN EFI_HANDLE ImageHandle,
436 IN EFI_SYSTEM_TABLE *SystemTable
440 return ${Function} (ImageHandle, SystemTable);
449 if (EFI_ERROR (Status)) {
450 ProcessLibraryDestructorList (gImageHandle, gST);
452 gBS->Exit (gImageHandle, Status, 0, NULL);
456 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
460 ProcessModuleEntryPointList (
461 IN EFI_HANDLE ImageHandle,
462 IN EFI_SYSTEM_TABLE *SystemTable
467 if (SetJump (&mJumpContext) == 0) {
468 ExitDriver (${Function} (ImageHandle, SystemTable));
472 return mDriverEntryPointStatus;
475 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
476 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
484 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
485 mDriverEntryPointStatus = Status;
487 LongJump (&mJumpContext, (UINTN)-1);
493 ## UEFI Unload Image Templates
494 gUefiUnloadImagePrototype
= TemplateString("""
499 IN EFI_HANDLE ImageHandle
504 gUefiUnloadImageString
= [
506 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
510 ProcessModuleUnloadList (
511 IN EFI_HANDLE ImageHandle
518 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
523 ProcessModuleUnloadList (
524 IN EFI_HANDLE ImageHandle
527 return ${Function} (ImageHandle);
532 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
536 ProcessModuleUnloadList (
537 IN EFI_HANDLE ImageHandle
542 Status = EFI_SUCCESS;
544 if (EFI_ERROR (Status)) {
545 ${Function} (ImageHandle);
547 Status = ${Function} (ImageHandle);
555 gLibraryStructorPrototype
= {
556 'BASE' : TemplateString("""${BEGIN}
564 'PEI' : TemplateString("""${BEGIN}
568 IN EFI_PEI_FILE_HANDLE FileHandle,
569 IN CONST EFI_PEI_SERVICES **PeiServices
573 'DXE' : TemplateString("""${BEGIN}
577 IN EFI_HANDLE ImageHandle,
578 IN EFI_SYSTEM_TABLE *SystemTable
583 gLibraryStructorCall
= {
584 'BASE' : TemplateString("""${BEGIN}
585 Status = ${Function} ();
586 ASSERT_EFI_ERROR (Status);${END}
589 'PEI' : TemplateString("""${BEGIN}
590 Status = ${Function} (FileHandle, PeiServices);
591 ASSERT_EFI_ERROR (Status);${END}
594 'DXE' : TemplateString("""${BEGIN}
595 Status = ${Function} (ImageHandle, SystemTable);
596 ASSERT_EFI_ERROR (Status);${END}
600 ## Library Constructor and Destructor Templates
602 'BASE' : TemplateString("""
603 ${BEGIN}${FunctionPrototype}${END}
607 ProcessLibrary${Type}List (
611 ${BEGIN} EFI_STATUS Status;
612 ${FunctionCall}${END}
616 'PEI' : TemplateString("""
617 ${BEGIN}${FunctionPrototype}${END}
621 ProcessLibrary${Type}List (
622 IN EFI_PEI_FILE_HANDLE FileHandle,
623 IN CONST EFI_PEI_SERVICES **PeiServices
626 ${BEGIN} EFI_STATUS Status;
627 ${FunctionCall}${END}
631 'DXE' : TemplateString("""
632 ${BEGIN}${FunctionPrototype}${END}
636 ProcessLibrary${Type}List (
637 IN EFI_HANDLE ImageHandle,
638 IN EFI_SYSTEM_TABLE *SystemTable
641 ${BEGIN} EFI_STATUS Status;
642 ${FunctionCall}${END}
647 gBasicHeaderFile
= "Base.h"
649 gModuleTypeHeaderFile
= {
650 "BASE" : [gBasicHeaderFile
],
651 "SEC" : ["PiPei.h", "Library/DebugLib.h"],
652 "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
653 "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
654 "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
655 "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
656 "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
657 "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
658 "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
659 "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
660 "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
661 "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
662 "USER_DEFINED" : [gBasicHeaderFile
]
665 ## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName
666 # the TokenName and Guid comparison to avoid define name collisions.
668 # @param Info The ModuleAutoGen object
669 # @param AutoGenH The TemplateString object for header file
672 def DynExPcdTokenNumberMapping(Info
, AutoGenH
):
673 ExTokenCNameList
= []
676 PcdList
= Info
.LibraryPcdList
678 PcdList
= Info
.ModulePcdList
680 if Pcd
.Type
in gDynamicExPcd
:
681 ExTokenCNameList
.append(Pcd
.TokenCName
)
682 PcdExList
.append(Pcd
)
683 if len(ExTokenCNameList
) == 0:
685 AutoGenH
.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')
686 # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.
687 # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.
688 # Use the Guid pointer to see if it matches any of the token space GUIDs.
690 for TokenCName
in ExTokenCNameList
:
691 if TokenCName
in TokenCNameList
:
694 Count
= ExTokenCNameList
.count(TokenCName
)
695 for Pcd
in PcdExList
:
696 if Pcd
.TokenCName
== TokenCName
:
699 AutoGenH
.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (Pcd
.TokenCName
))
700 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
701 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
703 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
704 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
706 AutoGenH
.Append('0 \\\n )\n')
707 TokenCNameList
.append(TokenCName
)
710 for TokenCName
in ExTokenCNameList
:
711 if TokenCName
in TokenCNameList
:
714 Count
= ExTokenCNameList
.count(TokenCName
)
715 for Pcd
in PcdExList
:
716 if Pcd
.Type
in gDynamicExPcd
and Pcd
.TokenCName
== TokenCName
:
719 AutoGenH
.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (Pcd
.TokenCName
))
720 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
721 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
723 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
724 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
726 AutoGenH
.Append('0 \\\n )\n')
727 # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.
728 # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler
729 # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().
730 # COMPAREGUID() will only be used if the Guid passed in is local to the module.
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'
732 % (Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
733 TokenCNameList
.append(TokenCName
)
735 ## Create code for module PCDs
737 # @param Info The ModuleAutoGen object
738 # @param AutoGenC The TemplateString object for C code
739 # @param AutoGenH The TemplateString object for header file
740 # @param Pcd The PCD object
742 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
743 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
744 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
748 PcdTokenName
= '_PCD_TOKEN_' + Pcd
.TokenCName
749 if Pcd
.Type
in gDynamicExPcd
:
750 TokenNumber
= int(Pcd
.TokenValue
, 0)
751 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
752 # different Guids but same TokenCName
753 PcdExTokenName
= '_PCD_TOKEN_' + Pcd
.TokenSpaceGuidCName
+ '_' + Pcd
.TokenCName
754 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
756 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
757 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
758 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
759 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
760 # report warning message notify the PI that they are attempting to build a module
761 # that must be included in a flash image in order to be functional. These Dynamic PCD
762 # will not be added into the Database unless it is used by other modules that are
763 # included in the FDF file.
764 # In this case, just assign an invalid token number to make it pass build.
765 if Pcd
.Type
in PCD_DYNAMIC_TYPE_LIST
:
768 EdkLogger
.error("build", AUTOGEN_ERROR
,
769 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
770 ExtraData
="[%s]" % str(Info
))
772 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
773 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
775 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + Pcd
.TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
776 if Pcd
.Type
not in gItemTypeStringDatabase
:
777 EdkLogger
.error("build", AUTOGEN_ERROR
,
778 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
779 ExtraData
="[%s]" % str(Info
))
780 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
781 EdkLogger
.error("build", AUTOGEN_ERROR
,
782 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
783 ExtraData
="[%s]" % str(Info
))
785 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
]
786 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
]
787 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
788 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
789 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + Pcd
.TokenCName
792 if Pcd
.Type
in gDynamicExPcd
:
794 PcdList
= Info
.LibraryPcdList
796 PcdList
= Info
.ModulePcdList
797 for PcdModule
in PcdList
:
798 if PcdModule
.Type
in gDynamicExPcd
:
799 PcdExCNameList
.append(PcdModule
.TokenCName
)
800 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
801 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
802 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
803 if PcdExCNameList
.count(Pcd
.TokenCName
) > 1:
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')
805 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
806 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
807 if Pcd
.DatumType
== 'VOID*':
808 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
809 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
811 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
812 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
814 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
815 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
816 if Pcd
.DatumType
== 'VOID*':
817 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
818 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
820 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
821 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
822 elif Pcd
.Type
in gDynamicPcd
:
823 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
824 if Pcd
.DatumType
== 'VOID*':
825 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
826 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
828 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
829 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
831 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + Pcd
.TokenCName
833 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
837 Value
= Pcd
.DefaultValue
841 if Pcd
.DatumType
== 'BOOLEAN':
842 BoolValue
= Value
.upper()
843 if BoolValue
== 'TRUE' or BoolValue
== '1':
845 elif BoolValue
== 'FALSE' or BoolValue
== '0':
848 if Pcd
.DatumType
in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:
850 if Value
.upper().startswith('0X'):
851 ValueNumber
= int (Value
, 16)
853 ValueNumber
= int (Value
)
855 EdkLogger
.error("build", AUTOGEN_ERROR
,
856 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
857 ExtraData
="[%s]" % str(Info
))
858 if Pcd
.DatumType
== 'UINT64':
860 EdkLogger
.error("build", AUTOGEN_ERROR
,
861 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
862 ExtraData
="[%s]" % str(Info
))
863 elif ValueNumber
>= 0x10000000000000000:
864 EdkLogger
.error("build", AUTOGEN_ERROR
,
865 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
866 ExtraData
="[%s]" % str(Info
))
867 if not Value
.endswith('ULL'):
869 elif Pcd
.DatumType
== 'UINT32':
871 EdkLogger
.error("build", AUTOGEN_ERROR
,
872 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
873 ExtraData
="[%s]" % str(Info
))
874 elif ValueNumber
>= 0x100000000:
875 EdkLogger
.error("build", AUTOGEN_ERROR
,
876 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
877 ExtraData
="[%s]" % str(Info
))
878 if not Value
.endswith('U'):
880 elif Pcd
.DatumType
== 'UINT16':
882 EdkLogger
.error("build", AUTOGEN_ERROR
,
883 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
884 ExtraData
="[%s]" % str(Info
))
885 elif ValueNumber
>= 0x10000:
886 EdkLogger
.error("build", AUTOGEN_ERROR
,
887 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
888 ExtraData
="[%s]" % str(Info
))
889 if not Value
.endswith('U'):
891 elif Pcd
.DatumType
== 'UINT8':
893 EdkLogger
.error("build", AUTOGEN_ERROR
,
894 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
895 ExtraData
="[%s]" % str(Info
))
896 elif ValueNumber
>= 0x100:
897 EdkLogger
.error("build", AUTOGEN_ERROR
,
898 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
899 ExtraData
="[%s]" % str(Info
))
900 if not Value
.endswith('U'):
902 if Pcd
.DatumType
== 'VOID*':
903 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
904 EdkLogger
.error("build", AUTOGEN_ERROR
,
905 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
906 ExtraData
="[%s]" % str(Info
))
908 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
914 Value
= Value
.lstrip('L') #.strip('"')
915 Value
= eval(Value
) # translate escape character
917 for Index
in range(0,len(Value
)):
919 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
921 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
923 ArraySize
= ArraySize
/ 2;
925 if ArraySize
< (len(Value
) + 1):
926 EdkLogger
.error("build", AUTOGEN_ERROR
,
927 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
928 ExtraData
="[%s]" % str(Info
))
929 Value
= NewValue
+ '0 }'
930 Array
= '[%d]' % ArraySize
932 # skip casting for fixed at build since it breaks ARM assembly.
933 # Long term we need PCD macros that work in assembly
935 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
936 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
938 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
939 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + Pcd
.TokenCName
941 PcdValueName
= '_PCD_VALUE_' + Pcd
.TokenCName
943 if Pcd
.DatumType
== 'VOID*':
945 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
948 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
949 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
950 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
951 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
952 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
954 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
955 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
956 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
957 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
958 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
959 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
960 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
961 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
962 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
963 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
965 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
966 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
967 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
968 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
970 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
971 if Pcd
.DatumType
== 'VOID*':
972 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
973 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrS(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
975 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
976 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
978 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
980 ## Create code for library module PCDs
982 # @param Info The ModuleAutoGen object
983 # @param AutoGenC The TemplateString object for C code
984 # @param AutoGenH The TemplateString object for header file
985 # @param Pcd The PCD object
987 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
988 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
989 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
990 TokenCName
= Pcd
.TokenCName
991 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
995 if Pcd
.Type
in gDynamicExPcd
:
996 TokenNumber
= int(Pcd
.TokenValue
, 0)
998 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
999 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1000 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1001 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1002 # report warning message notify the PI that they are attempting to build a module
1003 # that must be included in a flash image in order to be functional. These Dynamic PCD
1004 # will not be added into the Database unless it is used by other modules that are
1005 # included in the FDF file.
1006 # In this case, just assign an invalid token number to make it pass build.
1007 if Pcd
.Type
in PCD_DYNAMIC_TYPE_LIST
:
1010 EdkLogger
.error("build", AUTOGEN_ERROR
,
1011 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1012 ExtraData
="[%s]" % str(Info
))
1014 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1016 if Pcd
.Type
not in gItemTypeStringDatabase
:
1017 EdkLogger
.error("build", AUTOGEN_ERROR
,
1018 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1019 ExtraData
="[%s]" % str(Info
))
1020 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1021 EdkLogger
.error("build", AUTOGEN_ERROR
,
1022 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1023 ExtraData
="[%s]" % str(Info
))
1025 DatumType
= Pcd
.DatumType
1026 DatumSize
= gDatumSizeStringDatabaseH
[DatumType
]
1027 DatumSizeLib
= gDatumSizeStringDatabaseLib
[DatumType
]
1028 GetModeName
= '_PCD_GET_MODE_' + DatumSize
+ '_' + TokenCName
1029 SetModeName
= '_PCD_SET_MODE_' + DatumSize
+ '_' + TokenCName
1030 SetModeStatusName
= '_PCD_SET_MODE_' + DatumSize
+ '_S_' + TokenCName
1034 if Pcd
.DatumType
== 'VOID*':
1037 PcdItemType
= Pcd
.Type
1039 if PcdItemType
in gDynamicExPcd
:
1040 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + Pcd
.TokenCName
1041 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1044 PcdList
= Info
.LibraryPcdList
1046 PcdList
= Info
.ModulePcdList
1047 for PcdModule
in PcdList
:
1048 if PcdModule
.Type
in gDynamicExPcd
:
1049 PcdExCNameList
.append(PcdModule
.TokenCName
)
1050 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1051 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1052 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1053 if PcdExCNameList
.count(Pcd
.TokenCName
) > 1:
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')
1055 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1056 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1057 if Pcd
.DatumType
== 'VOID*':
1058 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1059 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1061 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1062 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1064 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1065 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1066 if Pcd
.DatumType
== 'VOID*':
1067 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1068 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1070 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1071 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1073 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1074 if PcdItemType
in gDynamicPcd
:
1075 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1076 if DatumType
== 'VOID*':
1077 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1078 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1080 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1081 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1082 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1083 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1084 AutoGenH
.Append('extern volatile %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
) )
1085 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1086 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1087 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1088 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1089 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1091 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1092 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1093 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1095 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and key
in Info
.ConstPcd
:
1096 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1100 ## Create code for library constructor
1102 # @param Info The ModuleAutoGen object
1103 # @param AutoGenC The TemplateString object for C code
1104 # @param AutoGenH The TemplateString object for header file
1106 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1108 # Library Constructors
1110 ConstructorPrototypeString
= TemplateString()
1111 ConstructorCallingString
= TemplateString()
1113 DependentLibraryList
= [Info
.Module
]
1115 DependentLibraryList
= Info
.DependentLibraryList
1116 for Lib
in DependentLibraryList
:
1117 if len(Lib
.ConstructorList
) <= 0:
1119 Dict
= {'Function':Lib
.ConstructorList
}
1120 if Lib
.ModuleType
in ['BASE', 'SEC']:
1121 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1122 ConstructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1123 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1124 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1125 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1126 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1127 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1128 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1129 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1131 if str(ConstructorPrototypeString
) == '':
1132 ConstructorPrototypeList
= []
1134 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1135 if str(ConstructorCallingString
) == '':
1136 ConstructorCallingList
= []
1138 ConstructorCallingList
= [str(ConstructorCallingString
)]
1141 'Type' : 'Constructor',
1142 'FunctionPrototype' : ConstructorPrototypeList
,
1143 'FunctionCall' : ConstructorCallingList
1146 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1148 if Info
.ModuleType
in ['BASE', 'SEC']:
1149 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1150 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1151 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1152 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1153 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1154 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1156 ## Create code for library destructor
1158 # @param Info The ModuleAutoGen object
1159 # @param AutoGenC The TemplateString object for C code
1160 # @param AutoGenH The TemplateString object for header file
1162 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1164 # Library Destructors
1166 DestructorPrototypeString
= TemplateString()
1167 DestructorCallingString
= TemplateString()
1169 DependentLibraryList
= [Info
.Module
]
1171 DependentLibraryList
= Info
.DependentLibraryList
1172 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1173 Lib
= DependentLibraryList
[Index
]
1174 if len(Lib
.DestructorList
) <= 0:
1176 Dict
= {'Function':Lib
.DestructorList
}
1177 if Lib
.ModuleType
in ['BASE', 'SEC']:
1178 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1179 DestructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1180 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1181 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1182 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1183 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1184 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:
1185 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1186 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1188 if str(DestructorPrototypeString
) == '':
1189 DestructorPrototypeList
= []
1191 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1192 if str(DestructorCallingString
) == '':
1193 DestructorCallingList
= []
1195 DestructorCallingList
= [str(DestructorCallingString
)]
1198 'Type' : 'Destructor',
1199 'FunctionPrototype' : DestructorPrototypeList
,
1200 'FunctionCall' : DestructorCallingList
1203 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1205 if Info
.ModuleType
in ['BASE', 'SEC']:
1206 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1207 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1208 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1209 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1210 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1211 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1214 ## Create code for ModuleEntryPoint
1216 # @param Info The ModuleAutoGen object
1217 # @param AutoGenC The TemplateString object for C code
1218 # @param AutoGenH The TemplateString object for header file
1220 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1221 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1224 # Module Entry Points
1226 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1227 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1228 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1230 PiSpecVersion
= '0x00000000'
1231 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1232 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1234 UefiSpecVersion
= '0x00000000'
1236 'Function' : Info
.Module
.ModuleEntryPointList
,
1237 'PiSpecVersion' : PiSpecVersion
+ 'U',
1238 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1241 if Info
.ModuleType
in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:
1242 if Info
.SourceFileList
<> None and Info
.SourceFileList
<> []:
1243 if NumEntryPoints
!= 1:
1247 '%s must have exactly one entry point' % Info
.ModuleType
,
1249 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1251 if Info
.ModuleType
== 'PEI_CORE':
1252 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1253 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1254 elif Info
.ModuleType
== 'DXE_CORE':
1255 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1256 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1257 elif Info
.ModuleType
== 'SMM_CORE':
1258 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1259 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1260 elif Info
.ModuleType
== 'PEIM':
1261 if NumEntryPoints
< 2:
1262 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1264 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1265 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1266 elif Info
.ModuleType
in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
1267 if NumEntryPoints
< 2:
1268 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1270 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1271 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1272 elif Info
.ModuleType
== 'DXE_SMM_DRIVER':
1273 if NumEntryPoints
== 0:
1274 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1276 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1277 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1278 elif Info
.ModuleType
== 'UEFI_APPLICATION':
1279 if NumEntryPoints
< 2:
1280 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1282 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1283 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1285 ## Create code for ModuleUnloadImage
1287 # @param Info The ModuleAutoGen object
1288 # @param AutoGenC The TemplateString object for C code
1289 # @param AutoGenH The TemplateString object for header file
1291 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1292 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1295 # Unload Image Handlers
1297 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1298 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1299 if NumUnloadImage
< 2:
1300 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1302 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1303 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1305 ## Create code for GUID
1307 # @param Info The ModuleAutoGen object
1308 # @param AutoGenC The TemplateString object for C code
1309 # @param AutoGenH The TemplateString object for header file
1311 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1315 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1318 GuidType
= "EFI_GUID"
1321 AutoGenC
.Append("\n// Guids\n")
1325 for Key
in Info
.GuidList
:
1326 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1328 ## Create code for protocol
1330 # @param Info The ModuleAutoGen object
1331 # @param AutoGenC The TemplateString object for C code
1332 # @param AutoGenH The TemplateString object for header file
1334 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1338 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1341 GuidType
= "EFI_GUID"
1343 if Info
.ProtocolList
:
1344 AutoGenC
.Append("\n// Protocols\n")
1348 for Key
in Info
.ProtocolList
:
1349 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1351 ## Create code for PPI
1353 # @param Info The ModuleAutoGen object
1354 # @param AutoGenC The TemplateString object for C code
1355 # @param AutoGenH The TemplateString object for header file
1357 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1361 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1364 GuidType
= "EFI_GUID"
1367 AutoGenC
.Append("\n// PPIs\n")
1371 for Key
in Info
.PpiList
:
1372 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1374 ## Create code for PCD
1376 # @param Info The ModuleAutoGen object
1377 # @param AutoGenC The TemplateString object for C code
1378 # @param AutoGenH The TemplateString object for header file
1380 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1382 # Collect Token Space GUIDs used by DynamicEc PCDs
1384 for Pcd
in Info
.ModulePcdList
:
1385 if Pcd
.Type
in gDynamicExPcd
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1386 TokenSpaceList
+= [Pcd
.TokenSpaceGuidCName
]
1388 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1389 if TokenSpaceList
<> []:
1390 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1391 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1394 GuidType
= "EFI_GUID"
1395 for Item
in TokenSpaceList
:
1396 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1399 if Info
.ModulePcdList
:
1400 AutoGenH
.Append("\n// PCD definitions\n")
1401 for Pcd
in Info
.ModulePcdList
:
1402 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1403 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1405 if Info
.ModulePcdList
:
1406 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1407 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1408 for Pcd
in Info
.ModulePcdList
:
1409 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1410 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1411 if Info
.LibraryPcdList
:
1412 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1413 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1414 for Pcd
in Info
.LibraryPcdList
:
1415 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1416 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1418 ## Create code for unicode string definition
1420 # @param Info The ModuleAutoGen object
1421 # @param AutoGenC The TemplateString object for C code
1422 # @param AutoGenH The TemplateString object for header file
1423 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1424 # @param UniGenBinBuffer Buffer to store uni string package data
1426 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1427 WorkingDir
= os
.getcwd()
1428 os
.chdir(Info
.WorkspaceDir
)
1430 IncList
= [Info
.MetaFile
.Dir
]
1431 # Get all files under [Sources] section in inf file for EDK-II module
1433 SrcList
= [F
for F
in Info
.SourceFileList
]
1434 if Info
.AutoGenVersion
< 0x00010005:
1436 # Get all files under the module directory for EDK-I module
1438 os
.chdir(Info
.MetaFile
.Dir
)
1439 for Root
, Dirs
, Files
in os
.walk("."):
1445 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1448 SrcList
.append(File
)
1451 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1452 CompatibleMode
= True
1454 CompatibleMode
= False
1457 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1459 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1461 EdkLogger
.error("build", AUTOGEN_ERROR
,
1462 "-c and -s build options should be used exclusively",
1463 ExtraData
="[%s]" % str(Info
))
1468 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1470 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1472 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1473 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1474 if CompatibleMode
or UniGenCFlag
:
1475 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1476 AutoGenC
.Append(Code
)
1477 AutoGenC
.Append("\n")
1478 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1479 AutoGenH
.Append(Header
)
1480 if CompatibleMode
or UniGenCFlag
:
1481 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1482 os
.chdir(WorkingDir
)
1484 ## Create common code
1486 # @param Info The ModuleAutoGen object
1487 # @param AutoGenC The TemplateString object for C code
1488 # @param AutoGenH The TemplateString object for header file
1490 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1492 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1493 # header file Prologue
1494 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-','_')}))
1495 AutoGenH
.Append(gAutoGenHCppPrologueString
)
1496 if Info
.AutoGenVersion
>= 0x00010005:
1497 # header files includes
1498 AutoGenH
.Append("#include <%s>\n" % gBasicHeaderFile
)
1499 if Info
.ModuleType
in gModuleTypeHeaderFile \
1500 and gModuleTypeHeaderFile
[Info
.ModuleType
][0] != gBasicHeaderFile
:
1501 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1503 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
1504 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
1506 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
1507 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
1509 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
1510 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
1515 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
1520 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
1521 if Info
.AutoGenVersion
>= 0x00010005:
1522 # C file header files includes
1523 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1524 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
1525 AutoGenC
.Append("#include <%s>\n" % Inc
)
1527 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
1530 # Publish the CallerId Guid
1532 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
1533 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
1535 ## Create common code for header file
1537 # @param Info The ModuleAutoGen object
1538 # @param AutoGenC The TemplateString object for C code
1539 # @param AutoGenH The TemplateString object for header file
1541 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
1542 AutoGenH
.Append(gAutoGenHEpilogueString
)
1544 ## Create code for a module
1546 # @param Info The ModuleAutoGen object
1547 # @param AutoGenC The TemplateString object for C code
1548 # @param AutoGenH The TemplateString object for header file
1549 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1550 # @param UniGenBinBuffer Buffer to store uni string package data
1552 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
):
1553 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
1555 if Info
.AutoGenVersion
>= 0x00010005:
1556 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1557 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1558 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1559 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
1560 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
1561 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
1562 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
1563 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
1565 if Info
.UnicodeFileList
:
1566 FileName
= "%sStrDefs.h" % Info
.Name
1567 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
1568 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-','_')}))
1569 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
1572 for Guid
in Info
.Module
.Guids
:
1573 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
1575 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
1576 for Guid
, Value
in Info
.Module
.Protocols
.items() + Info
.Module
.Ppis
.items():
1577 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
1579 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
1581 StringH
.Append("\n#endif\n")
1582 AutoGenH
.Append('#include "%s"\n' % FileName
)
1584 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
1586 # no generation of AutoGen.c for Edk modules without unicode file
1587 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
1588 AutoGenC
.String
= ''
1590 ## Create the code file
1592 # @param FilePath The path of code file
1593 # @param Content The content of code file
1594 # @param IsBinaryFile The flag indicating if the file is binary file or not
1596 # @retval True If file content is changed or file doesn't exist
1597 # @retval False If the file exists and the content is not changed
1599 def Generate(FilePath
, Content
, IsBinaryFile
):
1600 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)