2 # Routines for generating AutoGen.h and AutoGen.c
4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
5 # This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
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.
16 from __future__
import absolute_import
20 from Common
import EdkLogger
21 from Common
import GlobalData
22 from Common
.BuildToolError
import *
23 from Common
.DataType
import *
24 from Common
.Misc
import *
25 from Common
.StringUtils
import StringToArray
26 from .StrGather
import *
27 from .GenPcdDb
import CreatePcdDatabaseCode
28 from .IdfClassObject
import *
31 gItemTypeStringDatabase
= {
32 TAB_PCDS_FEATURE_FLAG
: TAB_PCDS_FIXED_AT_BUILD
,
33 TAB_PCDS_FIXED_AT_BUILD
: TAB_PCDS_FIXED_AT_BUILD
,
34 TAB_PCDS_PATCHABLE_IN_MODULE
: 'BinaryPatch',
35 TAB_PCDS_DYNAMIC
: '',
36 TAB_PCDS_DYNAMIC_DEFAULT
: '',
37 TAB_PCDS_DYNAMIC_VPD
: '',
38 TAB_PCDS_DYNAMIC_HII
: '',
39 TAB_PCDS_DYNAMIC_EX
: '',
40 TAB_PCDS_DYNAMIC_EX_DEFAULT
: '',
41 TAB_PCDS_DYNAMIC_EX_VPD
: '',
42 TAB_PCDS_DYNAMIC_EX_HII
: '',
47 gDatumSizeStringDatabase
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'BOOLEAN',TAB_VOID
:'8'}
48 gDatumSizeStringDatabaseH
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'BOOL',TAB_VOID
:'PTR'}
49 gDatumSizeStringDatabaseLib
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'Bool',TAB_VOID
:'Ptr'}
51 ## AutoGen File Header Templates
52 gAutoGenHeaderString
= TemplateString("""\
58 Abstract: Auto-generated ${FileName} for building module or library.
62 gAutoGenHPrologueString
= TemplateString("""
63 #ifndef _${File}_${Guid}
64 #define _${File}_${Guid}
68 gAutoGenHCppPrologueString
= """\
75 gAutoGenHEpilogueString
= """
84 ## PEI Core Entry Point Templates
85 gPeiCoreEntryPointPrototype
= TemplateString("""
90 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
91 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
97 gPeiCoreEntryPointString
= TemplateString("""
101 ProcessModuleEntryPointList (
102 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
103 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
108 ${Function} (SecCoreData, PpiList, Context);
114 ## DXE Core Entry Point Templates
115 gDxeCoreEntryPointPrototype
= TemplateString("""
125 gDxeCoreEntryPointString
= TemplateString("""
129 ProcessModuleEntryPointList (
134 ${Function} (HobStart);
139 ## PEIM Entry Point Templates
140 gPeimEntryPointPrototype
= TemplateString("""
145 IN EFI_PEI_FILE_HANDLE FileHandle,
146 IN CONST EFI_PEI_SERVICES **PeiServices
151 gPeimEntryPointString
= [
153 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
157 ProcessModuleEntryPointList (
158 IN EFI_PEI_FILE_HANDLE FileHandle,
159 IN CONST EFI_PEI_SERVICES **PeiServices
167 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
171 ProcessModuleEntryPointList (
172 IN EFI_PEI_FILE_HANDLE FileHandle,
173 IN CONST EFI_PEI_SERVICES **PeiServices
177 return ${Function} (FileHandle, PeiServices);
182 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
186 ProcessModuleEntryPointList (
187 IN EFI_PEI_FILE_HANDLE FileHandle,
188 IN CONST EFI_PEI_SERVICES **PeiServices
193 EFI_STATUS CombinedStatus;
195 CombinedStatus = EFI_LOAD_ERROR;
197 Status = ${Function} (FileHandle, PeiServices);
198 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
199 CombinedStatus = Status;
202 return CombinedStatus;
207 ## SMM_CORE Entry Point Templates
208 gSmmCoreEntryPointPrototype
= TemplateString("""
213 IN EFI_HANDLE ImageHandle,
214 IN EFI_SYSTEM_TABLE *SystemTable
219 gSmmCoreEntryPointString
= TemplateString("""
221 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
222 const UINT32 _gDxeRevision = ${PiSpecVersion};
226 ProcessModuleEntryPointList (
227 IN EFI_HANDLE ImageHandle,
228 IN EFI_SYSTEM_TABLE *SystemTable
231 return ${Function} (ImageHandle, SystemTable);
236 ## MM_CORE_STANDALONE Entry Point Templates
237 gMmCoreStandaloneEntryPointPrototype
= TemplateString("""
247 gMmCoreStandaloneEntryPointString
= TemplateString("""
249 const UINT32 _gMmRevision = ${PiSpecVersion};
253 ProcessModuleEntryPointList (
257 ${Function} (HobStart);
262 ## MM_STANDALONE Entry Point Templates
263 gMmStandaloneEntryPointPrototype
= TemplateString("""
268 IN EFI_HANDLE ImageHandle,
269 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
274 gMmStandaloneEntryPointString
= [
276 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
280 ProcessModuleEntryPointList (
281 IN EFI_HANDLE ImageHandle,
282 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
290 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
294 ProcessModuleEntryPointList (
295 IN EFI_HANDLE ImageHandle,
296 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
300 return ${Function} (ImageHandle, MmSystemTable);
305 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
309 ProcessModuleEntryPointList (
310 IN EFI_HANDLE ImageHandle,
311 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
316 EFI_STATUS CombinedStatus;
318 CombinedStatus = EFI_LOAD_ERROR;
320 Status = ${Function} (ImageHandle, MmSystemTable);
321 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
322 CombinedStatus = Status;
325 return CombinedStatus;
330 ## DXE SMM Entry Point Templates
331 gDxeSmmEntryPointPrototype
= TemplateString("""
336 IN EFI_HANDLE ImageHandle,
337 IN EFI_SYSTEM_TABLE *SystemTable
342 gDxeSmmEntryPointString
= [
344 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
345 const UINT32 _gDxeRevision = ${PiSpecVersion};
349 ProcessModuleEntryPointList (
350 IN EFI_HANDLE ImageHandle,
351 IN EFI_SYSTEM_TABLE *SystemTable
359 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
360 const UINT32 _gDxeRevision = ${PiSpecVersion};
362 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
363 static EFI_STATUS mDriverEntryPointStatus;
371 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
372 mDriverEntryPointStatus = Status;
374 LongJump (&mJumpContext, (UINTN)-1);
380 ProcessModuleEntryPointList (
381 IN EFI_HANDLE ImageHandle,
382 IN EFI_SYSTEM_TABLE *SystemTable
385 mDriverEntryPointStatus = EFI_LOAD_ERROR;
388 if (SetJump (&mJumpContext) == 0) {
389 ExitDriver (${Function} (ImageHandle, SystemTable));
394 return mDriverEntryPointStatus;
399 ## UEFI Driver Entry Point Templates
400 gUefiDriverEntryPointPrototype
= TemplateString("""
405 IN EFI_HANDLE ImageHandle,
406 IN EFI_SYSTEM_TABLE *SystemTable
411 gUefiDriverEntryPointString
= [
413 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
414 const UINT32 _gDxeRevision = ${PiSpecVersion};
418 ProcessModuleEntryPointList (
419 IN EFI_HANDLE ImageHandle,
420 IN EFI_SYSTEM_TABLE *SystemTable
427 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
428 const UINT32 _gDxeRevision = ${PiSpecVersion};
433 ProcessModuleEntryPointList (
434 IN EFI_HANDLE ImageHandle,
435 IN EFI_SYSTEM_TABLE *SystemTable
439 return ${Function} (ImageHandle, SystemTable);
448 if (EFI_ERROR (Status)) {
449 ProcessLibraryDestructorList (gImageHandle, gST);
451 gBS->Exit (gImageHandle, Status, 0, NULL);
455 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
456 const UINT32 _gDxeRevision = ${PiSpecVersion};
458 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
459 static EFI_STATUS mDriverEntryPointStatus;
463 ProcessModuleEntryPointList (
464 IN EFI_HANDLE ImageHandle,
465 IN EFI_SYSTEM_TABLE *SystemTable
468 mDriverEntryPointStatus = EFI_LOAD_ERROR;
470 if (SetJump (&mJumpContext) == 0) {
471 ExitDriver (${Function} (ImageHandle, SystemTable));
475 return mDriverEntryPointStatus;
484 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
485 mDriverEntryPointStatus = Status;
487 LongJump (&mJumpContext, (UINTN)-1);
494 ## UEFI Application Entry Point Templates
495 gUefiApplicationEntryPointPrototype
= TemplateString("""
500 IN EFI_HANDLE ImageHandle,
501 IN EFI_SYSTEM_TABLE *SystemTable
506 gUefiApplicationEntryPointString
= [
508 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
512 ProcessModuleEntryPointList (
513 IN EFI_HANDLE ImageHandle,
514 IN EFI_SYSTEM_TABLE *SystemTable
521 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
526 ProcessModuleEntryPointList (
527 IN EFI_HANDLE ImageHandle,
528 IN EFI_SYSTEM_TABLE *SystemTable
532 return ${Function} (ImageHandle, SystemTable);
541 if (EFI_ERROR (Status)) {
542 ProcessLibraryDestructorList (gImageHandle, gST);
544 gBS->Exit (gImageHandle, Status, 0, NULL);
548 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
552 ProcessModuleEntryPointList (
553 IN EFI_HANDLE ImageHandle,
554 IN EFI_SYSTEM_TABLE *SystemTable
559 if (SetJump (&mJumpContext) == 0) {
560 ExitDriver (${Function} (ImageHandle, SystemTable));
564 return mDriverEntryPointStatus;
567 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
568 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
576 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
577 mDriverEntryPointStatus = Status;
579 LongJump (&mJumpContext, (UINTN)-1);
585 ## UEFI Unload Image Templates
586 gUefiUnloadImagePrototype
= TemplateString("""
591 IN EFI_HANDLE ImageHandle
596 gUefiUnloadImageString
= [
598 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
602 ProcessModuleUnloadList (
603 IN EFI_HANDLE ImageHandle
610 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
615 ProcessModuleUnloadList (
616 IN EFI_HANDLE ImageHandle
619 return ${Function} (ImageHandle);
624 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
628 ProcessModuleUnloadList (
629 IN EFI_HANDLE ImageHandle
634 Status = EFI_SUCCESS;
636 if (EFI_ERROR (Status)) {
637 ${Function} (ImageHandle);
639 Status = ${Function} (ImageHandle);
647 gLibraryStructorPrototype
= {
648 SUP_MODULE_BASE
: TemplateString("""${BEGIN}
656 'PEI' : TemplateString("""${BEGIN}
660 IN EFI_PEI_FILE_HANDLE FileHandle,
661 IN CONST EFI_PEI_SERVICES **PeiServices
665 'DXE' : TemplateString("""${BEGIN}
669 IN EFI_HANDLE ImageHandle,
670 IN EFI_SYSTEM_TABLE *SystemTable
674 'MM' : TemplateString("""${BEGIN}
678 IN EFI_HANDLE ImageHandle,
679 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
684 gLibraryStructorCall
= {
685 SUP_MODULE_BASE
: TemplateString("""${BEGIN}
686 Status = ${Function} ();
687 ASSERT_RETURN_ERROR (Status);${END}
690 'PEI' : TemplateString("""${BEGIN}
691 Status = ${Function} (FileHandle, PeiServices);
692 ASSERT_EFI_ERROR (Status);${END}
695 'DXE' : TemplateString("""${BEGIN}
696 Status = ${Function} (ImageHandle, SystemTable);
697 ASSERT_EFI_ERROR (Status);${END}
700 'MM' : TemplateString("""${BEGIN}
701 Status = ${Function} (ImageHandle, MmSystemTable);
702 ASSERT_EFI_ERROR (Status);${END}
706 ## Library Constructor and Destructor Templates
708 SUP_MODULE_BASE
: TemplateString("""
709 ${BEGIN}${FunctionPrototype}${END}
713 ProcessLibrary${Type}List (
717 ${BEGIN} RETURN_STATUS Status;
718 ${FunctionCall}${END}
722 'PEI' : TemplateString("""
723 ${BEGIN}${FunctionPrototype}${END}
727 ProcessLibrary${Type}List (
728 IN EFI_PEI_FILE_HANDLE FileHandle,
729 IN CONST EFI_PEI_SERVICES **PeiServices
732 ${BEGIN} EFI_STATUS Status;
733 ${FunctionCall}${END}
737 'DXE' : TemplateString("""
738 ${BEGIN}${FunctionPrototype}${END}
742 ProcessLibrary${Type}List (
743 IN EFI_HANDLE ImageHandle,
744 IN EFI_SYSTEM_TABLE *SystemTable
747 ${BEGIN} EFI_STATUS Status;
748 ${FunctionCall}${END}
752 'MM' : TemplateString("""
753 ${BEGIN}${FunctionPrototype}${END}
757 ProcessLibrary${Type}List (
758 IN EFI_HANDLE ImageHandle,
759 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
762 ${BEGIN} EFI_STATUS Status;
763 ${FunctionCall}${END}
768 gBasicHeaderFile
= "Base.h"
770 gModuleTypeHeaderFile
= {
771 SUP_MODULE_BASE
: [gBasicHeaderFile
, "Library/DebugLib.h"],
772 SUP_MODULE_SEC
: ["PiPei.h", "Library/DebugLib.h"],
773 SUP_MODULE_PEI_CORE
: ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
774 SUP_MODULE_PEIM
: ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
775 SUP_MODULE_DXE_CORE
: ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
776 SUP_MODULE_DXE_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
777 SUP_MODULE_DXE_SMM_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
778 SUP_MODULE_DXE_RUNTIME_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
779 SUP_MODULE_DXE_SAL_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
780 SUP_MODULE_UEFI_DRIVER
: ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
781 SUP_MODULE_UEFI_APPLICATION
: ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
782 SUP_MODULE_SMM_CORE
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
783 SUP_MODULE_MM_STANDALONE
: ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmDriverEntryPoint.h"],
784 SUP_MODULE_MM_CORE_STANDALONE
: ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmCoreEntryPoint.h"],
785 SUP_MODULE_USER_DEFINED
: [gBasicHeaderFile
, "Library/DebugLib.h"]
788 ## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName
789 # the TokenName and Guid comparison to avoid define name collisions.
791 # @param Info The ModuleAutoGen object
792 # @param AutoGenH The TemplateString object for header file
795 def DynExPcdTokenNumberMapping(Info
, AutoGenH
):
796 ExTokenCNameList
= []
798 # Even it is the Library, the PCD is saved in the ModulePcdList
799 PcdList
= Info
.ModulePcdList
801 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
802 ExTokenCNameList
.append(Pcd
.TokenCName
)
803 PcdExList
.append(Pcd
)
804 if len(ExTokenCNameList
) == 0:
806 AutoGenH
.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')
807 # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.
808 # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.
809 # Use the Guid pointer to see if it matches any of the token space GUIDs.
810 TokenCNameList
= set()
811 for TokenCName
in ExTokenCNameList
:
812 if TokenCName
in TokenCNameList
:
815 Count
= ExTokenCNameList
.count(TokenCName
)
816 for Pcd
in PcdExList
:
817 RealTokenCName
= Pcd
.TokenCName
818 for PcdItem
in GlobalData
.MixedPcd
:
819 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
820 RealTokenCName
= PcdItem
[0]
822 if Pcd
.TokenCName
== TokenCName
:
825 AutoGenH
.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (RealTokenCName
))
826 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
827 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
829 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
830 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
832 AutoGenH
.Append('0 \\\n )\n')
833 TokenCNameList
.add(TokenCName
)
835 TokenCNameList
= set()
836 for TokenCName
in ExTokenCNameList
:
837 if TokenCName
in TokenCNameList
:
840 Count
= ExTokenCNameList
.count(TokenCName
)
841 for Pcd
in PcdExList
:
842 RealTokenCName
= Pcd
.TokenCName
843 for PcdItem
in GlobalData
.MixedPcd
:
844 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
845 RealTokenCName
= PcdItem
[0]
847 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== TokenCName
:
850 AutoGenH
.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (RealTokenCName
))
851 AutoGenH
.Append('\\\n (GuidPtr == NULL) ? 0:')
852 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
853 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
855 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
856 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
858 AutoGenH
.Append('0 \\\n )\n')
859 # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.
860 # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler
861 # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().
862 # COMPAREGUID() will only be used if the Guid passed in is local to the module.
863 AutoGenH
.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'
864 % (RealTokenCName
, RealTokenCName
, RealTokenCName
, RealTokenCName
))
865 TokenCNameList
.add(TokenCName
)
867 ## Create code for module PCDs
869 # @param Info The ModuleAutoGen object
870 # @param AutoGenC The TemplateString object for C code
871 # @param AutoGenH The TemplateString object for header file
872 # @param Pcd The PCD object
874 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
875 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
876 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
880 TokenCName
= Pcd
.TokenCName
881 for PcdItem
in GlobalData
.MixedPcd
:
882 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
883 TokenCName
= PcdItem
[0]
885 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
886 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
887 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
888 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
889 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
890 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
892 if Pcd
.PcdValueFromComm
:
893 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
894 elif Pcd
.PcdValueFromFdf
:
895 Pcd
.DefaultValue
= Pcd
.PcdValueFromFdf
897 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
898 TokenNumber
= int(Pcd
.TokenValue
, 0)
899 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
900 # different Guids but same TokenCName
901 PcdExTokenName
= '_PCD_TOKEN_' + Pcd
.TokenSpaceGuidCName
+ '_' + TokenCName
902 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
904 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
905 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
906 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
907 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
908 # report warning message notify the PI that they are attempting to build a module
909 # that must be included in a flash image in order to be functional. These Dynamic PCD
910 # will not be added into the Database unless it is used by other modules that are
911 # included in the FDF file.
912 # In this case, just assign an invalid token number to make it pass build.
913 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
916 EdkLogger
.error("build", AUTOGEN_ERROR
,
917 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
918 ExtraData
="[%s]" % str(Info
))
920 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
921 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
923 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
924 if Pcd
.Type
not in gItemTypeStringDatabase
:
925 EdkLogger
.error("build", AUTOGEN_ERROR
,
926 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
927 ExtraData
="[%s]" % str(Info
))
929 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
930 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
931 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
932 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
933 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
934 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
936 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
938 PcdList
= Info
.LibraryPcdList
940 PcdList
= Info
.ModulePcdList
+ Info
.LibraryPcdList
942 for PcdModule
in PcdList
:
943 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
945 # get out early once we found > 1...
946 if PcdExCNameTest
> 1:
948 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
949 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
950 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
951 if PcdExCNameTest
> 1:
952 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')
953 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
954 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
955 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
956 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
957 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
958 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
960 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
961 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
963 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
964 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
965 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
966 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
967 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
968 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
970 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
971 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
972 elif Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
974 for PcdModule
in Info
.LibraryPcdList
+ Info
.ModulePcdList
:
975 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
977 # get out early once we found > 1...
981 EdkLogger
.error("build", AUTOGEN_ERROR
, "More than one Dynamic Pcds [%s] are different Guids but same CName. They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName
), ExtraData
="[%s]" % str(Info
.MetaFile
.Path
))
983 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
984 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
985 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
986 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
987 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
989 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
990 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
992 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
994 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
998 Value
= Pcd
.DefaultValue
1002 if Pcd
.DatumType
== 'BOOLEAN':
1003 BoolValue
= Value
.upper()
1004 if BoolValue
== 'TRUE' or BoolValue
== '1':
1006 elif BoolValue
== 'FALSE' or BoolValue
== '0':
1009 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1011 if Value
.upper().endswith('L'):
1013 if Value
.startswith('0') and not Value
.lower().startswith('0x') and len(Value
) > 1 and Value
.lstrip('0'):
1014 Value
= Value
.lstrip('0')
1015 ValueNumber
= int (Value
, 0)
1017 EdkLogger
.error("build", AUTOGEN_ERROR
,
1018 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1019 ExtraData
="[%s]" % str(Info
))
1021 EdkLogger
.error("build", AUTOGEN_ERROR
,
1022 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1023 ExtraData
="[%s]" % str(Info
))
1024 elif ValueNumber
> MAX_VAL_TYPE
[Pcd
.DatumType
]:
1025 EdkLogger
.error("build", AUTOGEN_ERROR
,
1026 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1027 ExtraData
="[%s]" % str(Info
))
1028 if Pcd
.DatumType
== TAB_UINT64
and not Value
.endswith('ULL'):
1030 elif Pcd
.DatumType
!= TAB_UINT64
and not Value
.endswith('U'):
1033 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1034 if not Pcd
.MaxDatumSize
:
1035 EdkLogger
.error("build", AUTOGEN_ERROR
,
1036 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1037 ExtraData
="[%s]" % str(Info
))
1039 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
1042 ValueSize
= len(Value
.split(','))
1046 Value
= Value
.lstrip('L') #.strip('"')
1047 Value
= eval(Value
) # translate escape character
1048 ValueSize
= len(Value
) + 1
1050 for Index
in range(0, len(Value
)):
1052 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
1054 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
1056 ArraySize
= ArraySize
// 2
1057 Value
= NewValue
+ '0 }'
1058 if ArraySize
< ValueSize
:
1059 if Pcd
.MaxSizeUserSet
:
1060 EdkLogger
.error("build", AUTOGEN_ERROR
,
1061 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1062 ExtraData
="[%s]" % str(Info
))
1064 ArraySize
= Pcd
.GetPcdSize()
1066 ArraySize
= ArraySize
// 2
1067 Array
= '[%d]' % ArraySize
1069 # skip casting for fixed at build since it breaks ARM assembly.
1070 # Long term we need PCD macros that work in assembly
1072 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
and Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES_VOID
:
1073 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1075 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1076 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + TokenCName
1078 PcdValueName
= '_PCD_VALUE_' + TokenCName
1080 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1082 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1084 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1086 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1087 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1089 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1090 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1091 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1093 PcdDataSize
= Pcd
.GetPcdSize()
1094 if Pcd
.Type
== TAB_PCDS_FIXED_AT_BUILD
:
1095 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1096 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1097 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName
, PcdDataSize
))
1098 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1099 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, Pcd
.MaxDatumSize
))
1100 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1101 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1102 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1103 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable
, Pcd
.MaxDatumSize
))
1104 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1105 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1106 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1107 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1108 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1110 PcdDataSize
= Pcd
.GetPcdSize()
1111 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1113 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1114 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1115 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1117 PcdDataSize
= Pcd
.GetPcdSize()
1118 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1119 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1121 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1122 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1123 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1124 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1126 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1127 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1128 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1129 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, Pcd
.TokenCName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1131 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1132 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
1134 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1136 ## Create code for library module PCDs
1138 # @param Info The ModuleAutoGen object
1139 # @param AutoGenC The TemplateString object for C code
1140 # @param AutoGenH The TemplateString object for header file
1141 # @param Pcd The PCD object
1143 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1144 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1145 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1146 TokenCName
= Pcd
.TokenCName
1147 for PcdItem
in GlobalData
.MixedPcd
:
1148 if (TokenCName
, TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1149 TokenCName
= PcdItem
[0]
1151 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1152 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
1153 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
1154 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
1155 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
1156 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
1158 if Pcd
.PcdValueFromComm
:
1159 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
1160 elif Pcd
.PcdValueFromFdf
:
1161 Pcd
.DefaultValue
= Pcd
.PcdValueFromFdf
1165 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1166 TokenNumber
= int(Pcd
.TokenValue
, 0)
1168 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1169 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1170 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1171 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1172 # report warning message notify the PI that they are attempting to build a module
1173 # that must be included in a flash image in order to be functional. These Dynamic PCD
1174 # will not be added into the Database unless it is used by other modules that are
1175 # included in the FDF file.
1176 # In this case, just assign an invalid token number to make it pass build.
1177 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1180 EdkLogger
.error("build", AUTOGEN_ERROR
,
1181 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1182 ExtraData
="[%s]" % str(Info
))
1184 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1186 if Pcd
.Type
not in gItemTypeStringDatabase
:
1187 EdkLogger
.error("build", AUTOGEN_ERROR
,
1188 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1189 ExtraData
="[%s]" % str(Info
))
1191 DatumType
= Pcd
.DatumType
1192 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
1193 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
1194 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1195 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1196 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
1197 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
1201 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1202 if Pcd
.DefaultValue
[0]== '{':
1205 PcdItemType
= Pcd
.Type
1206 if PcdItemType
in PCD_DYNAMIC_EX_TYPE_SET
:
1207 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + TokenCName
1208 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1211 PcdList
= Info
.LibraryPcdList
1213 PcdList
= Info
.ModulePcdList
1215 for PcdModule
in PcdList
:
1216 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
1218 # get out early once we found > 1...
1219 if PcdExCNameTest
> 1:
1221 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1222 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1223 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1224 if PcdExCNameTest
> 1:
1225 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')
1226 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1227 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1228 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1229 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1230 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1231 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1233 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1234 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1236 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1237 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1238 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1239 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1240 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1241 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1243 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1244 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1246 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1247 if PcdItemType
in PCD_DYNAMIC_TYPE_SET
:
1250 PcdList
.extend(Info
.LibraryPcdList
)
1251 PcdList
.extend(Info
.ModulePcdList
)
1252 for PcdModule
in PcdList
:
1253 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
:
1254 PcdCNameList
.append(PcdModule
.TokenCName
)
1255 if PcdCNameList
.count(Pcd
.TokenCName
) > 1:
1256 EdkLogger
.error("build", AUTOGEN_ERROR
, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName
), ExtraData
="[%s]" % str(Info
.MetaFile
.Path
))
1258 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1259 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
1260 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1261 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1262 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1264 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1265 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1266 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1267 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1268 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1269 if DatumType
== TAB_VOID
and Array
== '[]':
1270 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1272 DatumType
= TAB_UINT8
1273 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1275 AutoGenH
.Append('extern volatile %s %s%s;\n' % (DatumType
, PcdVariableName
, Array
))
1276 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1277 PcdDataSize
= Pcd
.GetPcdSize()
1278 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1279 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1280 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1281 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PatchPcdMaxSizeVariable
))
1282 AutoGenH
.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable
)
1284 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1285 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1286 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1288 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1289 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1291 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1292 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1293 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
1294 if DatumType
== TAB_VOID
and Array
== '[]':
1295 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1296 if DatumType
not in TAB_PCD_NUMERIC_TYPES_VOID
:
1297 DatumType
= TAB_UINT8
1298 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1299 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1300 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1302 ConstFixedPcd
= False
1303 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and (key
in Info
.ConstPcd
or (Info
.IsLibrary
and not Info
.ReferenceModules
)):
1304 ConstFixedPcd
= True
1305 if key
in Info
.ConstPcd
:
1306 Pcd
.DefaultValue
= Info
.ConstPcd
[key
]
1307 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1308 AutoGenH
.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName
, Type
, PcdVariableName
))
1310 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1311 PcdDataSize
= Pcd
.GetPcdSize()
1312 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
:
1313 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1315 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1316 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1318 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixedPcdSizeVariableName
))
1319 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, FixedPcdSizeVariableName
))
1320 AutoGenH
.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName
)
1322 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1323 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1325 ## Create code for library constructor
1327 # @param Info The ModuleAutoGen object
1328 # @param AutoGenC The TemplateString object for C code
1329 # @param AutoGenH The TemplateString object for header file
1331 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1333 # Library Constructors
1335 ConstructorPrototypeString
= TemplateString()
1336 ConstructorCallingString
= TemplateString()
1338 DependentLibraryList
= [Info
.Module
]
1340 DependentLibraryList
= Info
.DependentLibraryList
1341 for Lib
in DependentLibraryList
:
1342 if len(Lib
.ConstructorList
) <= 0:
1344 Dict
= {'Function':Lib
.ConstructorList
}
1345 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1346 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1347 ConstructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1348 if Info
.ModuleType
not in [SUP_MODULE_BASE
, SUP_MODULE_USER_DEFINED
]:
1349 if Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1350 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1351 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1352 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1353 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1354 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1355 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1356 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1357 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1358 ConstructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1360 if str(ConstructorPrototypeString
) == '':
1361 ConstructorPrototypeList
= []
1363 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1364 if str(ConstructorCallingString
) == '':
1365 ConstructorCallingList
= []
1367 ConstructorCallingList
= [str(ConstructorCallingString
)]
1370 'Type' : 'Constructor',
1371 'FunctionPrototype' : ConstructorPrototypeList
,
1372 'FunctionCall' : ConstructorCallingList
1375 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1377 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
, SUP_MODULE_USER_DEFINED
]:
1378 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1379 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1380 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1381 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1382 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1383 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1384 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1385 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1387 ## Create code for library destructor
1389 # @param Info The ModuleAutoGen object
1390 # @param AutoGenC The TemplateString object for C code
1391 # @param AutoGenH The TemplateString object for header file
1393 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1395 # Library Destructors
1397 DestructorPrototypeString
= TemplateString()
1398 DestructorCallingString
= TemplateString()
1400 DependentLibraryList
= [Info
.Module
]
1402 DependentLibraryList
= Info
.DependentLibraryList
1403 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1404 Lib
= DependentLibraryList
[Index
]
1405 if len(Lib
.DestructorList
) <= 0:
1407 Dict
= {'Function':Lib
.DestructorList
}
1408 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1409 DestructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1410 DestructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1411 if Info
.ModuleType
not in [SUP_MODULE_BASE
, SUP_MODULE_USER_DEFINED
]:
1412 if Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1413 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1414 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1415 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1416 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1417 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1418 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1419 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1420 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1421 DestructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1423 if str(DestructorPrototypeString
) == '':
1424 DestructorPrototypeList
= []
1426 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1427 if str(DestructorCallingString
) == '':
1428 DestructorCallingList
= []
1430 DestructorCallingList
= [str(DestructorCallingString
)]
1433 'Type' : 'Destructor',
1434 'FunctionPrototype' : DestructorPrototypeList
,
1435 'FunctionCall' : DestructorCallingList
1438 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1440 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
, SUP_MODULE_USER_DEFINED
]:
1441 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1442 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1443 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1444 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1445 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1446 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1447 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1448 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1451 ## Create code for ModuleEntryPoint
1453 # @param Info The ModuleAutoGen object
1454 # @param AutoGenC The TemplateString object for C code
1455 # @param AutoGenH The TemplateString object for header file
1457 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1458 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1461 # Module Entry Points
1463 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1464 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1465 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1467 PiSpecVersion
= '0x00000000'
1468 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1469 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1471 UefiSpecVersion
= '0x00000000'
1473 'Function' : Info
.Module
.ModuleEntryPointList
,
1474 'PiSpecVersion' : PiSpecVersion
+ 'U',
1475 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1478 if Info
.ModuleType
in [SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1479 if Info
.SourceFileList
:
1480 if NumEntryPoints
!= 1:
1484 '%s must have exactly one entry point' % Info
.ModuleType
,
1486 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1488 if Info
.ModuleType
== SUP_MODULE_PEI_CORE
:
1489 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1490 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1491 elif Info
.ModuleType
== SUP_MODULE_DXE_CORE
:
1492 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1493 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1494 elif Info
.ModuleType
== SUP_MODULE_SMM_CORE
:
1495 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1496 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1497 elif Info
.ModuleType
== SUP_MODULE_MM_CORE_STANDALONE
:
1498 AutoGenC
.Append(gMmCoreStandaloneEntryPointString
.Replace(Dict
))
1499 AutoGenH
.Append(gMmCoreStandaloneEntryPointPrototype
.Replace(Dict
))
1500 elif Info
.ModuleType
== SUP_MODULE_PEIM
:
1501 if NumEntryPoints
< 2:
1502 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1504 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1505 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1506 elif Info
.ModuleType
in [SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
1507 if NumEntryPoints
< 2:
1508 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1510 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1511 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1512 elif Info
.ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
1513 if NumEntryPoints
== 0:
1514 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1516 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1517 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1518 elif Info
.ModuleType
== SUP_MODULE_MM_STANDALONE
:
1519 if NumEntryPoints
< 2:
1520 AutoGenC
.Append(gMmStandaloneEntryPointString
[NumEntryPoints
].Replace(Dict
))
1522 AutoGenC
.Append(gMmStandaloneEntryPointString
[2].Replace(Dict
))
1523 AutoGenH
.Append(gMmStandaloneEntryPointPrototype
.Replace(Dict
))
1524 elif Info
.ModuleType
== SUP_MODULE_UEFI_APPLICATION
:
1525 if NumEntryPoints
< 2:
1526 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1528 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1529 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1531 ## Create code for ModuleUnloadImage
1533 # @param Info The ModuleAutoGen object
1534 # @param AutoGenC The TemplateString object for C code
1535 # @param AutoGenH The TemplateString object for header file
1537 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1538 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1541 # Unload Image Handlers
1543 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1544 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1545 if NumUnloadImage
< 2:
1546 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1548 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1549 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1551 ## Create code for GUID
1553 # @param Info The ModuleAutoGen object
1554 # @param AutoGenC The TemplateString object for C code
1555 # @param AutoGenH The TemplateString object for header file
1557 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1558 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1561 GuidType
= "EFI_GUID"
1564 if not Info
.IsLibrary
:
1565 AutoGenC
.Append("\n// Guids\n")
1566 AutoGenH
.Append("\n// Guids\n")
1570 for Key
in Info
.GuidList
:
1571 if not Info
.IsLibrary
:
1572 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1573 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1575 ## Create code for protocol
1577 # @param Info The ModuleAutoGen object
1578 # @param AutoGenC The TemplateString object for C code
1579 # @param AutoGenH The TemplateString object for header file
1581 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1582 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1585 GuidType
= "EFI_GUID"
1587 if Info
.ProtocolList
:
1588 if not Info
.IsLibrary
:
1589 AutoGenC
.Append("\n// Protocols\n")
1590 AutoGenH
.Append("\n// Protocols\n")
1594 for Key
in Info
.ProtocolList
:
1595 if not Info
.IsLibrary
:
1596 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1597 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1599 ## Create code for PPI
1601 # @param Info The ModuleAutoGen object
1602 # @param AutoGenC The TemplateString object for C code
1603 # @param AutoGenH The TemplateString object for header file
1605 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1606 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1609 GuidType
= "EFI_GUID"
1612 if not Info
.IsLibrary
:
1613 AutoGenC
.Append("\n// PPIs\n")
1614 AutoGenH
.Append("\n// PPIs\n")
1618 for Key
in Info
.PpiList
:
1619 if not Info
.IsLibrary
:
1620 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1621 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1623 ## Create code for PCD
1625 # @param Info The ModuleAutoGen object
1626 # @param AutoGenC The TemplateString object for C code
1627 # @param AutoGenH The TemplateString object for header file
1629 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1631 # Collect Token Space GUIDs used by DynamicEc PCDs
1633 for Pcd
in Info
.ModulePcdList
:
1634 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1635 TokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
1637 SkuMgr
= Info
.Workspace
.Platform
.SkuIdMgr
1638 AutoGenH
.Append("\n// Definition of SkuId Array\n")
1639 AutoGenH
.Append("extern UINT64 _gPcd_SkuId_Array[];\n")
1640 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1642 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1643 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1646 GuidType
= "EFI_GUID"
1647 for Item
in TokenSpaceList
:
1648 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1651 if Info
.ModulePcdList
:
1652 AutoGenH
.Append("\n// PCD definitions\n")
1653 for Pcd
in Info
.ModulePcdList
:
1654 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1655 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1657 AutoGenC
.Append("\n// Definition of SkuId Array\n")
1658 AutoGenC
.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr
.DumpSkuIdArrary())
1659 if Info
.ModulePcdList
:
1660 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1661 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1662 for Pcd
in Info
.ModulePcdList
:
1663 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1664 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1665 if Info
.LibraryPcdList
:
1666 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1667 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1668 for Pcd
in Info
.LibraryPcdList
:
1669 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1670 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1672 ## Create code for unicode string definition
1674 # @param Info The ModuleAutoGen object
1675 # @param AutoGenC The TemplateString object for C code
1676 # @param AutoGenH The TemplateString object for header file
1677 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1678 # @param UniGenBinBuffer Buffer to store uni string package data
1680 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1681 WorkingDir
= os
.getcwd()
1682 os
.chdir(Info
.WorkspaceDir
)
1684 IncList
= [Info
.MetaFile
.Dir
]
1685 # Get all files under [Sources] section in inf file for EDK-II module
1687 SrcList
= [F
for F
in Info
.SourceFileList
]
1689 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1690 CompatibleMode
= True
1692 CompatibleMode
= False
1695 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1697 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1699 EdkLogger
.error("build", AUTOGEN_ERROR
,
1700 "-c and -s build options should be used exclusively",
1701 ExtraData
="[%s]" % str(Info
))
1706 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1708 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1710 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1711 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1712 if CompatibleMode
or UniGenCFlag
:
1713 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1714 AutoGenC
.Append(Code
)
1715 AutoGenC
.Append("\n")
1716 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1717 AutoGenH
.Append(Header
)
1718 if CompatibleMode
or UniGenCFlag
:
1719 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1720 os
.chdir(WorkingDir
)
1722 def CreateIdfFileCode(Info
, AutoGenC
, StringH
, IdfGenCFlag
, IdfGenBinBuffer
):
1723 if len(Info
.IdfFileList
) > 0:
1724 ImageFiles
= IdfFileClassObject(sorted (Info
.IdfFileList
))
1725 if ImageFiles
.ImageFilesDict
:
1728 IncList
= [Info
.MetaFile
.Dir
]
1729 SrcList
= [F
for F
in Info
.SourceFileList
]
1730 SkipList
= ['.jpg', '.png', '.bmp', '.inf', '.idf']
1731 FileList
= GetFileList(SrcList
, IncList
, SkipList
)
1733 StringH
.Append("\n//\n//Image ID\n//\n")
1735 PaletteInfoOffset
= 0
1736 ImageBuffer
= pack('x')
1737 PaletteBuffer
= pack('x')
1741 for Idf
in ImageFiles
.ImageFilesDict
:
1742 if ImageFiles
.ImageFilesDict
[Idf
]:
1743 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1744 for sourcefile
in Info
.SourceFileList
:
1745 if FileObj
.FileName
== sourcefile
.File
:
1746 if not sourcefile
.Ext
.upper() in ['.PNG', '.BMP', '.JPG']:
1747 EdkLogger
.error("build", AUTOGEN_ERROR
, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj
.FileName
), ExtraData
="[%s]" % str(Info
))
1748 FileObj
.File
= sourcefile
1751 EdkLogger
.error("build", AUTOGEN_ERROR
, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj
.FileName
, Idf
), ExtraData
="[%s]" % str(Info
))
1753 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1754 ID
= FileObj
.ImageID
1756 if not os
.path
.exists(File
.Path
) or not os
.path
.isfile(File
.Path
):
1757 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=File
.Path
)
1758 SearchImageID (FileObj
, FileList
)
1759 if FileObj
.Referenced
:
1760 if (ValueStartPtr
- len(DEFINE_STR
+ ID
)) <= 0:
1761 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' + DecToHexStr(Index
, 4) + '\n'
1763 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' * (ValueStartPtr
- len(DEFINE_STR
+ ID
)) + DecToHexStr(Index
, 4) + '\n'
1765 if File
not in FileDict
:
1766 FileDict
[File
] = Index
1768 DuplicateBlock
= pack('B', EFI_HII_IIBT_DUPLICATE
)
1769 DuplicateBlock
+= pack('H', FileDict
[File
])
1770 ImageBuffer
+= DuplicateBlock
1771 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1772 TempBufferList
= AscToHexList(DuplicateBlock
)
1773 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1774 StringH
.Append(Line
)
1778 TmpFile
= open(File
.Path
, 'rb')
1779 Buffer
= TmpFile
.read()
1781 if File
.Ext
.upper() == '.PNG':
1782 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_PNG
)
1783 TempBuffer
+= pack('I', len(Buffer
))
1784 TempBuffer
+= Buffer
1785 elif File
.Ext
.upper() == '.JPG':
1786 ImageType
, = struct
.unpack('4s', Buffer
[6:10])
1787 if ImageType
!= b
'JFIF':
1788 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard JPG file." % File
.Path
)
1789 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_JPEG
)
1790 TempBuffer
+= pack('I', len(Buffer
))
1791 TempBuffer
+= Buffer
1792 elif File
.Ext
.upper() == '.BMP':
1793 TempBuffer
, TempPalette
= BmpImageDecoder(File
, Buffer
, PaletteIndex
, FileObj
.TransParent
)
1794 if len(TempPalette
) > 1:
1796 NewPalette
= pack('H', len(TempPalette
))
1797 NewPalette
+= TempPalette
1798 PaletteBuffer
+= NewPalette
1799 PaletteStr
= WriteLine(PaletteStr
, '// %s: %s: %s' % (DecToHexStr(PaletteIndex
- 1, 4), ID
, DecToHexStr(PaletteIndex
- 1, 4)))
1800 TempPaletteList
= AscToHexList(NewPalette
)
1801 PaletteStr
= WriteLine(PaletteStr
, CreateArrayItem(TempPaletteList
, 16) + '\n')
1802 ImageBuffer
+= TempBuffer
1803 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1804 TempBufferList
= AscToHexList(TempBuffer
)
1805 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1807 StringH
.Append(Line
)
1810 BufferStr
= WriteLine(BufferStr
, '// End of the Image Info')
1811 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END
, 2)) + '\n')
1812 ImageEnd
= pack('B', EFI_HII_IIBT_END
)
1813 ImageBuffer
+= ImageEnd
1815 if len(ImageBuffer
) > 1:
1816 ImageInfoOffset
= 12
1817 if len(PaletteBuffer
) > 1:
1818 PaletteInfoOffset
= 12 + len(ImageBuffer
) - 1 # -1 is for the first empty pad byte of ImageBuffer
1820 IMAGE_PACKAGE_HDR
= pack('=II', ImageInfoOffset
, PaletteInfoOffset
)
1821 # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length
1822 if len(PaletteBuffer
) > 1:
1823 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1 + 2 + len(PaletteBuffer
) - 1
1825 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1
1826 if PaletteIndex
> 1:
1827 PALETTE_INFO_HEADER
= pack('H', PaletteIndex
- 1)
1828 # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF
1829 Hex_Length
= '%06X' % PACKAGE_HEADER_Length
1830 if PACKAGE_HEADER_Length
> 0xFFFFFF:
1831 EdkLogger
.error("build", AUTOGEN_ERROR
, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData
="[%s]" % str(Info
))
1832 PACKAGE_HEADER
= pack('=HBB', int('0x' + Hex_Length
[2:], 16), int('0x' + Hex_Length
[0:2], 16), EFI_HII_PACKAGE_IMAGES
)
1834 IdfGenBinBuffer
.write(PACKAGE_HEADER
)
1835 IdfGenBinBuffer
.write(IMAGE_PACKAGE_HDR
)
1836 if len(ImageBuffer
) > 1 :
1837 IdfGenBinBuffer
.write(ImageBuffer
[1:])
1838 if PaletteIndex
> 1:
1839 IdfGenBinBuffer
.write(PALETTE_INFO_HEADER
)
1840 if len(PaletteBuffer
) > 1:
1841 IdfGenBinBuffer
.write(PaletteBuffer
[1:])
1844 TotalLength
= EFI_HII_ARRAY_SIZE_LENGTH
+ PACKAGE_HEADER_Length
1845 AutoGenC
.Append("\n//\n//Image Pack Definition\n//\n")
1846 AllStr
= WriteLine('', CHAR_ARRAY_DEFIN
+ ' ' + Info
.Module
.BaseName
+ 'Images' + '[] = {\n')
1847 AllStr
= WriteLine(AllStr
, '// STRGATHER_OUTPUT_HEADER')
1848 AllStr
= WriteLine(AllStr
, CreateArrayItem(DecToHexList(TotalLength
)) + '\n')
1849 AllStr
= WriteLine(AllStr
, '// Image PACKAGE HEADER\n')
1850 IMAGE_PACKAGE_HDR_List
= AscToHexList(PACKAGE_HEADER
)
1851 IMAGE_PACKAGE_HDR_List
+= AscToHexList(IMAGE_PACKAGE_HDR
)
1852 AllStr
= WriteLine(AllStr
, CreateArrayItem(IMAGE_PACKAGE_HDR_List
, 16) + '\n')
1853 AllStr
= WriteLine(AllStr
, '// Image DATA\n')
1855 AllStr
= WriteLine(AllStr
, BufferStr
)
1857 AllStr
= WriteLine(AllStr
, '// Palette Header\n')
1858 PALETTE_INFO_HEADER_List
= AscToHexList(PALETTE_INFO_HEADER
)
1859 AllStr
= WriteLine(AllStr
, CreateArrayItem(PALETTE_INFO_HEADER_List
, 16) + '\n')
1860 AllStr
= WriteLine(AllStr
, '// Palette Data\n')
1861 AllStr
= WriteLine(AllStr
, PaletteStr
)
1862 AllStr
= WriteLine(AllStr
, '};')
1863 AutoGenC
.Append(AllStr
)
1864 AutoGenC
.Append("\n")
1865 StringH
.Append('\nextern unsigned char ' + Info
.Module
.BaseName
+ 'Images[];\n')
1866 StringH
.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info
.Module
.BaseName
)
1868 # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {
1869 # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES
1870 # UINT32 ImageInfoOffset;
1871 # UINT32 PaletteInfoOffset;
1872 # } EFI_HII_IMAGE_PACKAGE_HDR;
1878 # } EFI_HII_PACKAGE_HEADER;
1880 # typedef struct _EFI_HII_IMAGE_BLOCK {
1882 # UINT8 BlockBody[];
1883 # } EFI_HII_IMAGE_BLOCK;
1885 def BmpImageDecoder(File
, Buffer
, PaletteIndex
, TransParent
):
1886 ImageType
, = struct
.unpack('2s', Buffer
[0:2])
1887 if ImageType
!= b
'BM': # BMP file type is 'BM'
1888 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard BMP file." % File
.Path
)
1889 BMP_IMAGE_HEADER
= collections
.namedtuple('BMP_IMAGE_HEADER', ['bfSize', 'bfReserved1', 'bfReserved2', 'bfOffBits', 'biSize', 'biWidth', 'biHeight', 'biPlanes', 'biBitCount', 'biCompression', 'biSizeImage', 'biXPelsPerMeter', 'biYPelsPerMeter', 'biClrUsed', 'biClrImportant'])
1890 BMP_IMAGE_HEADER_STRUCT
= struct
.Struct('IHHIIIIHHIIIIII')
1891 BmpHeader
= BMP_IMAGE_HEADER
._make
(BMP_IMAGE_HEADER_STRUCT
.unpack_from(Buffer
[2:]))
1893 # Doesn't support compress.
1895 if BmpHeader
.biCompression
!= 0:
1896 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The compress BMP file %s is not support." % File
.Path
)
1898 # The Width and Height is UINT16 type in Image Package
1899 if BmpHeader
.biWidth
> 0xFFFF:
1900 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Width is exceed 0xFFFF." % File
.Path
)
1901 if BmpHeader
.biHeight
> 0xFFFF:
1902 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Height is exceed 0xFFFF." % File
.Path
)
1904 PaletteBuffer
= pack('x')
1905 if BmpHeader
.biBitCount
== 1:
1907 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS
)
1909 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT
)
1910 ImageBuffer
+= pack('B', PaletteIndex
)
1911 Width
= (BmpHeader
.biWidth
+ 7)//8
1912 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1913 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1914 elif BmpHeader
.biBitCount
== 4:
1916 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS
)
1918 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT
)
1919 ImageBuffer
+= pack('B', PaletteIndex
)
1920 Width
= (BmpHeader
.biWidth
+ 1)//2
1921 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1922 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1923 elif BmpHeader
.biBitCount
== 8:
1925 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS
)
1927 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT
)
1928 ImageBuffer
+= pack('B', PaletteIndex
)
1929 Width
= BmpHeader
.biWidth
1930 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1931 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1932 elif BmpHeader
.biBitCount
== 24:
1934 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS
)
1936 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT
)
1937 Width
= BmpHeader
.biWidth
* 3
1939 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData
="[%s]" % str(File
.Path
))
1941 ImageBuffer
+= pack('H', BmpHeader
.biWidth
)
1942 ImageBuffer
+= pack('H', BmpHeader
.biHeight
)
1943 Start
= BmpHeader
.bfOffBits
1944 End
= BmpHeader
.bfSize
- 1
1945 for Height
in range(0, BmpHeader
.biHeight
):
1947 Start
= End
+ (Width
% 4) - 4 - Width
1950 ImageBuffer
+= Buffer
[Start
+ 1 : Start
+ Width
+ 1]
1953 # handle the Palette info, BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info
1954 if PaletteBuffer
and len(PaletteBuffer
) > 1:
1955 PaletteTemp
= pack('x')
1956 for Index
in range(0, len(PaletteBuffer
)):
1959 PaletteTemp
+= PaletteBuffer
[Index
:Index
+1]
1960 PaletteBuffer
= PaletteTemp
[1:]
1961 return ImageBuffer
, PaletteBuffer
1963 ## Create common code
1965 # @param Info The ModuleAutoGen object
1966 # @param AutoGenC The TemplateString object for C code
1967 # @param AutoGenH The TemplateString object for header file
1969 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1971 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1972 # header file Prologue
1973 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-', '_')}))
1974 AutoGenH
.Append(gAutoGenHCppPrologueString
)
1976 # header files includes
1977 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1978 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1980 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
1981 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
1983 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
1984 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
1986 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
1987 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
1992 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
1997 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
1998 # C file header files includes
1999 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2000 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
2001 AutoGenC
.Append("#include <%s>\n" % Inc
)
2003 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
2006 # Publish the CallerId Guid
2008 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
2009 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
2011 ## Create common code for header file
2013 # @param Info The ModuleAutoGen object
2014 # @param AutoGenC The TemplateString object for C code
2015 # @param AutoGenH The TemplateString object for header file
2017 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
2018 AutoGenH
.Append(gAutoGenHEpilogueString
)
2020 ## Create code for a module
2022 # @param Info The ModuleAutoGen object
2023 # @param AutoGenC The TemplateString object for C code
2024 # @param AutoGenH The TemplateString object for header file
2025 # @param StringH The TemplateString object for header file
2026 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
2027 # @param UniGenBinBuffer Buffer to store uni string package data
2028 # @param StringIdf The TemplateString object for header file
2029 # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True
2030 # @param IdfGenBinBuffer Buffer to store Idf string package data
2032 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
):
2033 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
2035 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2036 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2037 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2038 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
2039 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
2040 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
2041 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
2042 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
2044 if Info
.UnicodeFileList
:
2045 FileName
= "%sStrDefs.h" % Info
.Name
2046 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2047 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2048 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
2051 for Guid
in Info
.Module
.Guids
:
2052 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
2054 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
2055 for Guid
, Value
in list(Info
.Module
.Protocols
.items()) + list(Info
.Module
.Ppis
.items()):
2056 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
2057 # supports FixedAtBuild and FeaturePcd usage in VFR file
2058 if Info
.VfrFileList
and Info
.ModulePcdList
:
2059 GuidMacros
.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))
2060 GuidMacros
.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))
2061 GuidMacros
.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))
2062 GuidMacros
.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))
2063 GuidMacros
.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))
2064 GuidMacros
.append('#define %s %s' % ('FeaturePcdGet(TokenName)', '_PCD_VALUE_##TokenName'))
2065 for Pcd
in Info
.ModulePcdList
:
2066 if Pcd
.Type
in [TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_FEATURE_FLAG
]:
2067 TokenCName
= Pcd
.TokenCName
2068 Value
= Pcd
.DefaultValue
2069 if Pcd
.DatumType
== 'BOOLEAN':
2070 BoolValue
= Value
.upper()
2071 if BoolValue
== 'TRUE':
2073 elif BoolValue
== 'FALSE':
2075 for PcdItem
in GlobalData
.MixedPcd
:
2076 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2077 TokenCName
= PcdItem
[0]
2079 GuidMacros
.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName
, Value
))
2081 if Info
.IdfFileList
:
2082 GuidMacros
.append('#include "%sImgDefs.h"' % Info
.Name
)
2085 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
2087 StringH
.Append("\n#endif\n")
2088 AutoGenH
.Append('#include "%s"\n' % FileName
)
2090 if Info
.IdfFileList
:
2091 FileName
= "%sImgDefs.h" % Info
.Name
2092 StringIdf
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2093 StringIdf
.Append(gAutoGenHPrologueString
.Replace({'File':'IMAGEDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2094 CreateIdfFileCode(Info
, AutoGenC
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
)
2096 StringIdf
.Append("\n#endif\n")
2097 AutoGenH
.Append('#include "%s"\n' % FileName
)
2099 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
2101 ## Create the code file
2103 # @param FilePath The path of code file
2104 # @param Content The content of code file
2105 # @param IsBinaryFile The flag indicating if the file is binary file or not
2107 # @retval True If file content is changed or file doesn't exist
2108 # @retval False If the file exists and the content is not changed
2110 def Generate(FilePath
, Content
, IsBinaryFile
):
2111 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)