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 (GuidPtr == NULL) ? 0:')
721 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
722 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
724 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
725 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
727 AutoGenH
.Append('0 \\\n )\n')
728 # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.
729 # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler
730 # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().
731 # COMPAREGUID() will only be used if the Guid passed in is local to the module.
732 AutoGenH
.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'
733 % (Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
734 TokenCNameList
.append(TokenCName
)
737 if Pcd
.DatumType
== 'VOID*':
738 Value
= Pcd
.DefaultValue
739 if Value
in [None, '']:
741 elif Value
[0] == 'L':
742 return (len(Value
) - 2) * 2
743 elif Value
[0] == '{':
744 return len(Value
.split(','))
746 return len(Value
) - 1
747 if Pcd
.DatumType
== 'UINT64':
749 if Pcd
.DatumType
== 'UINT32':
751 if Pcd
.DatumType
== 'UINT16':
753 if Pcd
.DatumType
== 'UINT8':
755 if Pcd
.DatumType
== 'BOOLEAN':
759 ## Create code for module PCDs
761 # @param Info The ModuleAutoGen object
762 # @param AutoGenC The TemplateString object for C code
763 # @param AutoGenH The TemplateString object for header file
764 # @param Pcd The PCD object
766 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
767 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
768 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
772 PcdTokenName
= '_PCD_TOKEN_' + Pcd
.TokenCName
773 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + Pcd
.TokenCName
+'_SIZE'
774 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + Pcd
.TokenCName
775 FixPcdSizeTokenName
= '_PCD_SIZE_' + Pcd
.TokenCName
777 if Pcd
.Type
in gDynamicExPcd
:
778 TokenNumber
= int(Pcd
.TokenValue
, 0)
779 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
780 # different Guids but same TokenCName
781 PcdExTokenName
= '_PCD_TOKEN_' + Pcd
.TokenSpaceGuidCName
+ '_' + Pcd
.TokenCName
782 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
784 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
785 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
786 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
787 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
788 # report warning message notify the PI that they are attempting to build a module
789 # that must be included in a flash image in order to be functional. These Dynamic PCD
790 # will not be added into the Database unless it is used by other modules that are
791 # included in the FDF file.
792 # In this case, just assign an invalid token number to make it pass build.
793 if Pcd
.Type
in PCD_DYNAMIC_TYPE_LIST
:
796 EdkLogger
.error("build", AUTOGEN_ERROR
,
797 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
798 ExtraData
="[%s]" % str(Info
))
800 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
801 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
803 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + Pcd
.TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
804 if Pcd
.Type
not in gItemTypeStringDatabase
:
805 EdkLogger
.error("build", AUTOGEN_ERROR
,
806 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
807 ExtraData
="[%s]" % str(Info
))
808 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
809 EdkLogger
.error("build", AUTOGEN_ERROR
,
810 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
811 ExtraData
="[%s]" % str(Info
))
813 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
]
814 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
]
815 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
816 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
817 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + Pcd
.TokenCName
818 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + Pcd
.TokenCName
821 if Pcd
.Type
in gDynamicExPcd
:
823 PcdList
= Info
.LibraryPcdList
825 PcdList
= Info
.ModulePcdList
826 for PcdModule
in PcdList
:
827 if PcdModule
.Type
in gDynamicExPcd
:
828 PcdExCNameList
.append(PcdModule
.TokenCName
)
829 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
830 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
831 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
832 if PcdExCNameList
.count(Pcd
.TokenCName
) > 1:
833 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')
834 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
835 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
836 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
,Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
837 if Pcd
.DatumType
== 'VOID*':
838 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
839 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
841 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
842 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
844 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
845 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
846 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
,Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
847 if Pcd
.DatumType
== 'VOID*':
848 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
849 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
851 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
852 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
853 elif Pcd
.Type
in gDynamicPcd
:
854 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
855 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
856 if Pcd
.DatumType
== 'VOID*':
857 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
858 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
860 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
861 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
863 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + Pcd
.TokenCName
865 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
869 Value
= Pcd
.DefaultValue
873 if Pcd
.DatumType
== 'BOOLEAN':
874 BoolValue
= Value
.upper()
875 if BoolValue
== 'TRUE' or BoolValue
== '1':
877 elif BoolValue
== 'FALSE' or BoolValue
== '0':
880 if Pcd
.DatumType
in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:
882 if Value
.upper().startswith('0X'):
883 ValueNumber
= int (Value
, 16)
885 ValueNumber
= int (Value
)
887 EdkLogger
.error("build", AUTOGEN_ERROR
,
888 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
889 ExtraData
="[%s]" % str(Info
))
890 if Pcd
.DatumType
== 'UINT64':
892 EdkLogger
.error("build", AUTOGEN_ERROR
,
893 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
894 ExtraData
="[%s]" % str(Info
))
895 elif ValueNumber
>= 0x10000000000000000:
896 EdkLogger
.error("build", AUTOGEN_ERROR
,
897 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
898 ExtraData
="[%s]" % str(Info
))
899 if not Value
.endswith('ULL'):
901 elif Pcd
.DatumType
== 'UINT32':
903 EdkLogger
.error("build", AUTOGEN_ERROR
,
904 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
905 ExtraData
="[%s]" % str(Info
))
906 elif ValueNumber
>= 0x100000000:
907 EdkLogger
.error("build", AUTOGEN_ERROR
,
908 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
909 ExtraData
="[%s]" % str(Info
))
910 if not Value
.endswith('U'):
912 elif Pcd
.DatumType
== 'UINT16':
914 EdkLogger
.error("build", AUTOGEN_ERROR
,
915 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
916 ExtraData
="[%s]" % str(Info
))
917 elif ValueNumber
>= 0x10000:
918 EdkLogger
.error("build", AUTOGEN_ERROR
,
919 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
920 ExtraData
="[%s]" % str(Info
))
921 if not Value
.endswith('U'):
923 elif Pcd
.DatumType
== 'UINT8':
925 EdkLogger
.error("build", AUTOGEN_ERROR
,
926 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
927 ExtraData
="[%s]" % str(Info
))
928 elif ValueNumber
>= 0x100:
929 EdkLogger
.error("build", AUTOGEN_ERROR
,
930 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
931 ExtraData
="[%s]" % str(Info
))
932 if not Value
.endswith('U'):
934 if Pcd
.DatumType
== 'VOID*':
935 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
936 EdkLogger
.error("build", AUTOGEN_ERROR
,
937 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
938 ExtraData
="[%s]" % str(Info
))
940 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
946 Value
= Value
.lstrip('L') #.strip('"')
947 Value
= eval(Value
) # translate escape character
949 for Index
in range(0,len(Value
)):
951 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
953 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
955 ArraySize
= ArraySize
/ 2;
957 if ArraySize
< (len(Value
) + 1):
958 EdkLogger
.error("build", AUTOGEN_ERROR
,
959 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
960 ExtraData
="[%s]" % str(Info
))
961 Value
= NewValue
+ '0 }'
962 Array
= '[%d]' % ArraySize
964 # skip casting for fixed at build since it breaks ARM assembly.
965 # Long term we need PCD macros that work in assembly
967 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
968 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
970 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
971 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + Pcd
.TokenCName
973 PcdValueName
= '_PCD_VALUE_' + Pcd
.TokenCName
975 if Pcd
.DatumType
== 'VOID*':
977 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
980 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
981 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
982 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
983 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
985 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
986 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
987 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
988 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
990 PcdDataSize
= GetPcdSize(Pcd
)
991 if Pcd
.Type
== TAB_PCDS_FIXED_AT_BUILD
:
992 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
993 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
,FixPcdSizeTokenName
))
995 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
996 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, Pcd
.MaxDatumSize
))
997 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
,PatchPcdSizeVariableName
))
998 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
999 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
,PcdDataSize
))
1000 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1001 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1002 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1003 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1004 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1006 PcdDataSize
= GetPcdSize(Pcd
)
1007 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1009 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
,PatchPcdSizeVariableName
))
1010 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1011 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
,PcdDataSize
))
1013 PcdDataSize
= GetPcdSize(Pcd
)
1014 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1015 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
,FixPcdSizeTokenName
))
1017 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1018 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1019 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1020 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1022 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1023 if Pcd
.DatumType
== 'VOID*':
1024 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr((VOID *)_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1025 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrS((VOID *)_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1027 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1028 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
1030 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1032 ## Create code for library module PCDs
1034 # @param Info The ModuleAutoGen object
1035 # @param AutoGenC The TemplateString object for C code
1036 # @param AutoGenH The TemplateString object for header file
1037 # @param Pcd The PCD object
1039 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1040 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1041 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1042 TokenCName
= Pcd
.TokenCName
1043 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1044 FixPcdSizeTokenName
= '_PCD_SIZE_' + Pcd
.TokenCName
1045 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + Pcd
.TokenCName
+'_SIZE'
1046 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + Pcd
.TokenCName
1051 if Pcd
.Type
in gDynamicExPcd
:
1052 TokenNumber
= int(Pcd
.TokenValue
, 0)
1054 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1055 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1056 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1057 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1058 # report warning message notify the PI that they are attempting to build a module
1059 # that must be included in a flash image in order to be functional. These Dynamic PCD
1060 # will not be added into the Database unless it is used by other modules that are
1061 # included in the FDF file.
1062 # In this case, just assign an invalid token number to make it pass build.
1063 if Pcd
.Type
in PCD_DYNAMIC_TYPE_LIST
:
1066 EdkLogger
.error("build", AUTOGEN_ERROR
,
1067 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1068 ExtraData
="[%s]" % str(Info
))
1070 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1072 if Pcd
.Type
not in gItemTypeStringDatabase
:
1073 EdkLogger
.error("build", AUTOGEN_ERROR
,
1074 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1075 ExtraData
="[%s]" % str(Info
))
1076 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1077 EdkLogger
.error("build", AUTOGEN_ERROR
,
1078 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1079 ExtraData
="[%s]" % str(Info
))
1081 DatumType
= Pcd
.DatumType
1082 DatumSize
= gDatumSizeStringDatabaseH
[DatumType
]
1083 DatumSizeLib
= gDatumSizeStringDatabaseLib
[DatumType
]
1084 GetModeName
= '_PCD_GET_MODE_' + DatumSize
+ '_' + TokenCName
1085 SetModeName
= '_PCD_SET_MODE_' + DatumSize
+ '_' + TokenCName
1086 SetModeStatusName
= '_PCD_SET_MODE_' + DatumSize
+ '_S_' + TokenCName
1087 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + Pcd
.TokenCName
1091 if Pcd
.DatumType
== 'VOID*':
1094 PcdItemType
= Pcd
.Type
1096 if PcdItemType
in gDynamicExPcd
:
1097 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + Pcd
.TokenCName
1098 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1101 PcdList
= Info
.LibraryPcdList
1103 PcdList
= Info
.ModulePcdList
1104 for PcdModule
in PcdList
:
1105 if PcdModule
.Type
in gDynamicExPcd
:
1106 PcdExCNameList
.append(PcdModule
.TokenCName
)
1107 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1108 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1109 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1110 if PcdExCNameList
.count(Pcd
.TokenCName
) > 1:
1111 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')
1112 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1113 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1114 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s \n' % (GetModeSizeName
,Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1115 if Pcd
.DatumType
== 'VOID*':
1116 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1117 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1119 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1120 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1122 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1123 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1124 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
,Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1125 if Pcd
.DatumType
== 'VOID*':
1126 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1127 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1129 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1130 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1132 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1133 if PcdItemType
in gDynamicPcd
:
1134 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1135 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
1136 if DatumType
== 'VOID*':
1137 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1138 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1140 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1141 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1142 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1143 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1144 AutoGenH
.Append('extern volatile %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
) )
1145 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1146 if Pcd
.DatumType
== 'VOID*':
1147 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr((VOID *)_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1148 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrS((VOID *)_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1150 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1151 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1153 PcdDataSize
= GetPcdSize(Pcd
)
1154 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1155 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
,PatchPcdSizeVariableName
))
1156 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1158 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1159 key
= ".".join((Pcd
.TokenSpaceGuidCName
,Pcd
.TokenCName
))
1161 if DatumType
== 'VOID*' and Array
== '[]':
1162 DatumType
= ['UINT8', 'UINT16'][Pcd
.DefaultValue
[0] == 'L']
1163 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1164 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1165 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1167 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and key
in Info
.ConstPcd
:
1168 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1170 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
:
1171 PcdDataSize
= GetPcdSize(Pcd
)
1172 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1173 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
,FixPcdSizeTokenName
))
1175 ## Create code for library constructor
1177 # @param Info The ModuleAutoGen object
1178 # @param AutoGenC The TemplateString object for C code
1179 # @param AutoGenH The TemplateString object for header file
1181 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1183 # Library Constructors
1185 ConstructorPrototypeString
= TemplateString()
1186 ConstructorCallingString
= TemplateString()
1188 DependentLibraryList
= [Info
.Module
]
1190 DependentLibraryList
= Info
.DependentLibraryList
1191 for Lib
in DependentLibraryList
:
1192 if len(Lib
.ConstructorList
) <= 0:
1194 Dict
= {'Function':Lib
.ConstructorList
}
1195 if Lib
.ModuleType
in ['BASE', 'SEC']:
1196 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1197 ConstructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1198 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1199 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1200 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1201 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1202 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1203 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1204 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1206 if str(ConstructorPrototypeString
) == '':
1207 ConstructorPrototypeList
= []
1209 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1210 if str(ConstructorCallingString
) == '':
1211 ConstructorCallingList
= []
1213 ConstructorCallingList
= [str(ConstructorCallingString
)]
1216 'Type' : 'Constructor',
1217 'FunctionPrototype' : ConstructorPrototypeList
,
1218 'FunctionCall' : ConstructorCallingList
1221 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1223 if Info
.ModuleType
in ['BASE', 'SEC']:
1224 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1225 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1226 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1227 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1228 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1229 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1231 ## Create code for library destructor
1233 # @param Info The ModuleAutoGen object
1234 # @param AutoGenC The TemplateString object for C code
1235 # @param AutoGenH The TemplateString object for header file
1237 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1239 # Library Destructors
1241 DestructorPrototypeString
= TemplateString()
1242 DestructorCallingString
= TemplateString()
1244 DependentLibraryList
= [Info
.Module
]
1246 DependentLibraryList
= Info
.DependentLibraryList
1247 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1248 Lib
= DependentLibraryList
[Index
]
1249 if len(Lib
.DestructorList
) <= 0:
1251 Dict
= {'Function':Lib
.DestructorList
}
1252 if Lib
.ModuleType
in ['BASE', 'SEC']:
1253 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1254 DestructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1255 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1256 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1257 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1258 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1259 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:
1260 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1261 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1263 if str(DestructorPrototypeString
) == '':
1264 DestructorPrototypeList
= []
1266 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1267 if str(DestructorCallingString
) == '':
1268 DestructorCallingList
= []
1270 DestructorCallingList
= [str(DestructorCallingString
)]
1273 'Type' : 'Destructor',
1274 'FunctionPrototype' : DestructorPrototypeList
,
1275 'FunctionCall' : DestructorCallingList
1278 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1280 if Info
.ModuleType
in ['BASE', 'SEC']:
1281 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1282 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1283 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1284 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1285 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1286 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1289 ## Create code for ModuleEntryPoint
1291 # @param Info The ModuleAutoGen object
1292 # @param AutoGenC The TemplateString object for C code
1293 # @param AutoGenH The TemplateString object for header file
1295 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1296 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1299 # Module Entry Points
1301 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1302 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1303 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1305 PiSpecVersion
= '0x00000000'
1306 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1307 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1309 UefiSpecVersion
= '0x00000000'
1311 'Function' : Info
.Module
.ModuleEntryPointList
,
1312 'PiSpecVersion' : PiSpecVersion
+ 'U',
1313 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1316 if Info
.ModuleType
in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:
1317 if Info
.SourceFileList
<> None and Info
.SourceFileList
<> []:
1318 if NumEntryPoints
!= 1:
1322 '%s must have exactly one entry point' % Info
.ModuleType
,
1324 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1326 if Info
.ModuleType
== 'PEI_CORE':
1327 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1328 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1329 elif Info
.ModuleType
== 'DXE_CORE':
1330 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1331 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1332 elif Info
.ModuleType
== 'SMM_CORE':
1333 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1334 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1335 elif Info
.ModuleType
== 'PEIM':
1336 if NumEntryPoints
< 2:
1337 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1339 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1340 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1341 elif Info
.ModuleType
in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
1342 if NumEntryPoints
< 2:
1343 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1345 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1346 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1347 elif Info
.ModuleType
== 'DXE_SMM_DRIVER':
1348 if NumEntryPoints
== 0:
1349 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1351 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1352 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1353 elif Info
.ModuleType
== 'UEFI_APPLICATION':
1354 if NumEntryPoints
< 2:
1355 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1357 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1358 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1360 ## Create code for ModuleUnloadImage
1362 # @param Info The ModuleAutoGen object
1363 # @param AutoGenC The TemplateString object for C code
1364 # @param AutoGenH The TemplateString object for header file
1366 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1367 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1370 # Unload Image Handlers
1372 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1373 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1374 if NumUnloadImage
< 2:
1375 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1377 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1378 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1380 ## Create code for GUID
1382 # @param Info The ModuleAutoGen object
1383 # @param AutoGenC The TemplateString object for C code
1384 # @param AutoGenH The TemplateString object for header file
1386 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1390 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1393 GuidType
= "EFI_GUID"
1396 AutoGenC
.Append("\n// Guids\n")
1397 AutoGenH
.Append("\n// Guids\n")
1401 for Key
in Info
.GuidList
:
1402 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1403 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1405 ## Create code for protocol
1407 # @param Info The ModuleAutoGen object
1408 # @param AutoGenC The TemplateString object for C code
1409 # @param AutoGenH The TemplateString object for header file
1411 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1415 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1418 GuidType
= "EFI_GUID"
1420 if Info
.ProtocolList
:
1421 AutoGenC
.Append("\n// Protocols\n")
1422 AutoGenH
.Append("\n// Protocols\n")
1426 for Key
in Info
.ProtocolList
:
1427 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1428 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1430 ## Create code for PPI
1432 # @param Info The ModuleAutoGen object
1433 # @param AutoGenC The TemplateString object for C code
1434 # @param AutoGenH The TemplateString object for header file
1436 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1440 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1443 GuidType
= "EFI_GUID"
1446 AutoGenC
.Append("\n// PPIs\n")
1447 AutoGenH
.Append("\n// PPIs\n")
1451 for Key
in Info
.PpiList
:
1452 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1453 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1455 ## Create code for PCD
1457 # @param Info The ModuleAutoGen object
1458 # @param AutoGenC The TemplateString object for C code
1459 # @param AutoGenH The TemplateString object for header file
1461 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1463 # Collect Token Space GUIDs used by DynamicEc PCDs
1465 for Pcd
in Info
.ModulePcdList
:
1466 if Pcd
.Type
in gDynamicExPcd
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1467 TokenSpaceList
+= [Pcd
.TokenSpaceGuidCName
]
1469 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1470 if TokenSpaceList
<> []:
1471 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1472 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1475 GuidType
= "EFI_GUID"
1476 for Item
in TokenSpaceList
:
1477 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1480 if Info
.ModulePcdList
:
1481 AutoGenH
.Append("\n// PCD definitions\n")
1482 for Pcd
in Info
.ModulePcdList
:
1483 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1484 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1486 if Info
.ModulePcdList
:
1487 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1488 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1489 for Pcd
in Info
.ModulePcdList
:
1490 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1491 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1492 if Info
.LibraryPcdList
:
1493 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1494 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1495 for Pcd
in Info
.LibraryPcdList
:
1496 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1497 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1499 ## Create code for unicode string definition
1501 # @param Info The ModuleAutoGen object
1502 # @param AutoGenC The TemplateString object for C code
1503 # @param AutoGenH The TemplateString object for header file
1504 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1505 # @param UniGenBinBuffer Buffer to store uni string package data
1507 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1508 WorkingDir
= os
.getcwd()
1509 os
.chdir(Info
.WorkspaceDir
)
1511 IncList
= [Info
.MetaFile
.Dir
]
1512 # Get all files under [Sources] section in inf file for EDK-II module
1514 SrcList
= [F
for F
in Info
.SourceFileList
]
1515 if Info
.AutoGenVersion
< 0x00010005:
1517 # Get all files under the module directory for EDK-I module
1519 os
.chdir(Info
.MetaFile
.Dir
)
1520 for Root
, Dirs
, Files
in os
.walk("."):
1526 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1529 SrcList
.append(File
)
1532 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1533 CompatibleMode
= True
1535 CompatibleMode
= False
1538 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1540 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1542 EdkLogger
.error("build", AUTOGEN_ERROR
,
1543 "-c and -s build options should be used exclusively",
1544 ExtraData
="[%s]" % str(Info
))
1549 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1551 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1553 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1554 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1555 if CompatibleMode
or UniGenCFlag
:
1556 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1557 AutoGenC
.Append(Code
)
1558 AutoGenC
.Append("\n")
1559 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1560 AutoGenH
.Append(Header
)
1561 if CompatibleMode
or UniGenCFlag
:
1562 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1563 os
.chdir(WorkingDir
)
1565 ## Create common code
1567 # @param Info The ModuleAutoGen object
1568 # @param AutoGenC The TemplateString object for C code
1569 # @param AutoGenH The TemplateString object for header file
1571 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1573 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1574 # header file Prologue
1575 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-','_')}))
1576 AutoGenH
.Append(gAutoGenHCppPrologueString
)
1577 if Info
.AutoGenVersion
>= 0x00010005:
1578 # header files includes
1579 AutoGenH
.Append("#include <%s>\n" % gBasicHeaderFile
)
1580 if Info
.ModuleType
in gModuleTypeHeaderFile \
1581 and gModuleTypeHeaderFile
[Info
.ModuleType
][0] != gBasicHeaderFile
:
1582 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1584 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
1585 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
1587 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
1588 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
1590 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
1591 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
1596 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
1601 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
1602 if Info
.AutoGenVersion
>= 0x00010005:
1603 # C file header files includes
1604 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1605 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
1606 AutoGenC
.Append("#include <%s>\n" % Inc
)
1608 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
1611 # Publish the CallerId Guid
1613 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
1614 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
1616 ## Create common code for header file
1618 # @param Info The ModuleAutoGen object
1619 # @param AutoGenC The TemplateString object for C code
1620 # @param AutoGenH The TemplateString object for header file
1622 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
1623 AutoGenH
.Append(gAutoGenHEpilogueString
)
1625 ## Create code for a module
1627 # @param Info The ModuleAutoGen object
1628 # @param AutoGenC The TemplateString object for C code
1629 # @param AutoGenH The TemplateString object for header file
1630 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1631 # @param UniGenBinBuffer Buffer to store uni string package data
1633 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
):
1634 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
1636 if Info
.AutoGenVersion
>= 0x00010005:
1637 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1638 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1639 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1640 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
1641 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
1642 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
1643 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
1644 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
1646 if Info
.UnicodeFileList
:
1647 FileName
= "%sStrDefs.h" % Info
.Name
1648 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
1649 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-','_')}))
1650 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
1653 for Guid
in Info
.Module
.Guids
:
1654 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
1656 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
1657 for Guid
, Value
in Info
.Module
.Protocols
.items() + Info
.Module
.Ppis
.items():
1658 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
1660 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
1662 StringH
.Append("\n#endif\n")
1663 AutoGenH
.Append('#include "%s"\n' % FileName
)
1665 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
1667 # no generation of AutoGen.c for Edk modules without unicode file
1668 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
1669 AutoGenC
.String
= ''
1671 ## Create the code file
1673 # @param FilePath The path of code file
1674 # @param Content The content of code file
1675 # @param IsBinaryFile The flag indicating if the file is binary file or not
1677 # @retval True If file content is changed or file doesn't exist
1678 # @retval False If the file exists and the content is not changed
1680 def Generate(FilePath
, Content
, IsBinaryFile
):
1681 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)