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
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_EFI_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} EFI_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
],
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
]
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 ValueNumber
= int (Value
, 0)
1015 EdkLogger
.error("build", AUTOGEN_ERROR
,
1016 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1017 ExtraData
="[%s]" % str(Info
))
1019 EdkLogger
.error("build", AUTOGEN_ERROR
,
1020 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1021 ExtraData
="[%s]" % str(Info
))
1022 elif ValueNumber
> MAX_VAL_TYPE
[Pcd
.DatumType
]:
1023 EdkLogger
.error("build", AUTOGEN_ERROR
,
1024 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1025 ExtraData
="[%s]" % str(Info
))
1026 if Pcd
.DatumType
== TAB_UINT64
and not Value
.endswith('ULL'):
1028 elif Pcd
.DatumType
!= TAB_UINT64
and not Value
.endswith('U'):
1031 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1032 if not Pcd
.MaxDatumSize
:
1033 EdkLogger
.error("build", AUTOGEN_ERROR
,
1034 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1035 ExtraData
="[%s]" % str(Info
))
1037 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
1040 ValueSize
= len(Value
.split(','))
1044 Value
= Value
.lstrip('L') #.strip('"')
1045 Value
= eval(Value
) # translate escape character
1046 ValueSize
= len(Value
) + 1
1048 for Index
in range(0, len(Value
)):
1050 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
1052 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
1054 ArraySize
= ArraySize
/ 2
1055 Value
= NewValue
+ '0 }'
1056 if ArraySize
< ValueSize
:
1057 if Pcd
.MaxSizeUserSet
:
1058 EdkLogger
.error("build", AUTOGEN_ERROR
,
1059 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1060 ExtraData
="[%s]" % str(Info
))
1062 ArraySize
= Pcd
.GetPcdSize()
1064 ArraySize
= ArraySize
/ 2
1065 Array
= '[%d]' % ArraySize
1067 # skip casting for fixed at build since it breaks ARM assembly.
1068 # Long term we need PCD macros that work in assembly
1070 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
and Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES_VOID
:
1071 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1073 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1074 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + TokenCName
1076 PcdValueName
= '_PCD_VALUE_' + TokenCName
1078 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1080 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1082 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1084 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1085 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1087 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1088 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1089 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1091 PcdDataSize
= Pcd
.GetPcdSize()
1092 if Pcd
.Type
== TAB_PCDS_FIXED_AT_BUILD
:
1093 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1094 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1095 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName
, PcdDataSize
))
1096 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1097 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, Pcd
.MaxDatumSize
))
1098 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1099 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1100 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1101 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable
, Pcd
.MaxDatumSize
))
1102 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1103 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1104 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1105 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1106 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1108 PcdDataSize
= Pcd
.GetPcdSize()
1109 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1111 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1112 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1113 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1115 PcdDataSize
= Pcd
.GetPcdSize()
1116 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1117 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1119 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1120 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1121 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1122 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1124 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1125 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1126 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
))
1127 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
))
1129 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1130 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
1132 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1134 ## Create code for library module PCDs
1136 # @param Info The ModuleAutoGen object
1137 # @param AutoGenC The TemplateString object for C code
1138 # @param AutoGenH The TemplateString object for header file
1139 # @param Pcd The PCD object
1141 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1142 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1143 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1144 TokenCName
= Pcd
.TokenCName
1145 for PcdItem
in GlobalData
.MixedPcd
:
1146 if (TokenCName
, TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1147 TokenCName
= PcdItem
[0]
1149 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1150 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
1151 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
1152 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
1153 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
1154 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
1156 if Pcd
.PcdValueFromComm
:
1157 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
1158 elif Pcd
.PcdValueFromFdf
:
1159 Pcd
.DefaultValue
= Pcd
.PcdValueFromFdf
1163 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1164 TokenNumber
= int(Pcd
.TokenValue
, 0)
1166 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1167 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1168 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1169 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1170 # report warning message notify the PI that they are attempting to build a module
1171 # that must be included in a flash image in order to be functional. These Dynamic PCD
1172 # will not be added into the Database unless it is used by other modules that are
1173 # included in the FDF file.
1174 # In this case, just assign an invalid token number to make it pass build.
1175 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1178 EdkLogger
.error("build", AUTOGEN_ERROR
,
1179 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1180 ExtraData
="[%s]" % str(Info
))
1182 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1184 if Pcd
.Type
not in gItemTypeStringDatabase
:
1185 EdkLogger
.error("build", AUTOGEN_ERROR
,
1186 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1187 ExtraData
="[%s]" % str(Info
))
1189 DatumType
= Pcd
.DatumType
1190 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
1191 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
1192 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1193 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1194 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
1195 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
1199 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1200 if Pcd
.DefaultValue
[0]== '{':
1203 PcdItemType
= Pcd
.Type
1204 if PcdItemType
in PCD_DYNAMIC_EX_TYPE_SET
:
1205 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + TokenCName
1206 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1209 PcdList
= Info
.LibraryPcdList
1211 PcdList
= Info
.ModulePcdList
1213 for PcdModule
in PcdList
:
1214 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
1216 # get out early once we found > 1...
1217 if PcdExCNameTest
> 1:
1219 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1220 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1221 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1222 if PcdExCNameTest
> 1:
1223 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')
1224 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1225 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1226 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1227 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1228 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1229 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1231 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1232 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1234 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1235 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1236 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1237 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1238 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1239 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1241 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1242 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1244 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1245 if PcdItemType
in PCD_DYNAMIC_TYPE_SET
:
1248 PcdList
.extend(Info
.LibraryPcdList
)
1249 PcdList
.extend(Info
.ModulePcdList
)
1250 for PcdModule
in PcdList
:
1251 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
:
1252 PcdCNameList
.append(PcdModule
.TokenCName
)
1253 if PcdCNameList
.count(Pcd
.TokenCName
) > 1:
1254 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
))
1256 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1257 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
1258 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1259 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1260 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1262 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1263 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1264 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1265 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1266 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1267 if DatumType
== TAB_VOID
and Array
== '[]':
1268 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1270 DatumType
= TAB_UINT8
1271 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1273 AutoGenH
.Append('extern volatile %s %s%s;\n' % (DatumType
, PcdVariableName
, Array
))
1274 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1275 PcdDataSize
= Pcd
.GetPcdSize()
1276 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1277 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1278 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1279 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PatchPcdMaxSizeVariable
))
1280 AutoGenH
.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable
)
1282 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1283 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1284 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1286 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1287 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1289 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1290 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1291 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
1292 if DatumType
== TAB_VOID
and Array
== '[]':
1293 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1294 if DatumType
not in TAB_PCD_NUMERIC_TYPES_VOID
:
1295 DatumType
= TAB_UINT8
1296 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1297 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1298 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1300 ConstFixedPcd
= False
1301 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and (key
in Info
.ConstPcd
or (Info
.IsLibrary
and not Info
.ReferenceModules
)):
1302 ConstFixedPcd
= True
1303 if key
in Info
.ConstPcd
:
1304 Pcd
.DefaultValue
= Info
.ConstPcd
[key
]
1305 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1306 AutoGenH
.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName
, Type
, PcdVariableName
))
1308 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1309 PcdDataSize
= Pcd
.GetPcdSize()
1310 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
:
1311 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1313 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1314 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1316 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixedPcdSizeVariableName
))
1317 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, FixedPcdSizeVariableName
))
1318 AutoGenH
.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName
)
1320 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1321 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1323 ## Create code for library constructor
1325 # @param Info The ModuleAutoGen object
1326 # @param AutoGenC The TemplateString object for C code
1327 # @param AutoGenH The TemplateString object for header file
1329 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1331 # Library Constructors
1333 ConstructorPrototypeString
= TemplateString()
1334 ConstructorCallingString
= TemplateString()
1336 DependentLibraryList
= [Info
.Module
]
1338 DependentLibraryList
= Info
.DependentLibraryList
1339 for Lib
in DependentLibraryList
:
1340 if len(Lib
.ConstructorList
) <= 0:
1342 Dict
= {'Function':Lib
.ConstructorList
}
1343 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1344 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1345 ConstructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1346 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1347 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1348 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1349 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1350 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1351 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1352 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1353 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1354 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1355 ConstructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1357 if str(ConstructorPrototypeString
) == '':
1358 ConstructorPrototypeList
= []
1360 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1361 if str(ConstructorCallingString
) == '':
1362 ConstructorCallingList
= []
1364 ConstructorCallingList
= [str(ConstructorCallingString
)]
1367 'Type' : 'Constructor',
1368 'FunctionPrototype' : ConstructorPrototypeList
,
1369 'FunctionCall' : ConstructorCallingList
1372 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1374 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1375 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1376 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1377 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1378 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1379 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1380 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1381 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1382 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1384 ## Create code for library destructor
1386 # @param Info The ModuleAutoGen object
1387 # @param AutoGenC The TemplateString object for C code
1388 # @param AutoGenH The TemplateString object for header file
1390 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1392 # Library Destructors
1394 DestructorPrototypeString
= TemplateString()
1395 DestructorCallingString
= TemplateString()
1397 DependentLibraryList
= [Info
.Module
]
1399 DependentLibraryList
= Info
.DependentLibraryList
1400 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1401 Lib
= DependentLibraryList
[Index
]
1402 if len(Lib
.DestructorList
) <= 0:
1404 Dict
= {'Function':Lib
.DestructorList
}
1405 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1406 DestructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1407 DestructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1408 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1409 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1410 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1411 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1412 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1413 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1414 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1415 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1416 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1417 DestructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1419 if str(DestructorPrototypeString
) == '':
1420 DestructorPrototypeList
= []
1422 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1423 if str(DestructorCallingString
) == '':
1424 DestructorCallingList
= []
1426 DestructorCallingList
= [str(DestructorCallingString
)]
1429 'Type' : 'Destructor',
1430 'FunctionPrototype' : DestructorPrototypeList
,
1431 'FunctionCall' : DestructorCallingList
1434 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1436 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1437 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1438 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1439 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1440 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1441 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1442 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1443 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1444 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1447 ## Create code for ModuleEntryPoint
1449 # @param Info The ModuleAutoGen object
1450 # @param AutoGenC The TemplateString object for C code
1451 # @param AutoGenH The TemplateString object for header file
1453 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1454 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1457 # Module Entry Points
1459 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1460 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1461 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1463 PiSpecVersion
= '0x00000000'
1464 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1465 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1467 UefiSpecVersion
= '0x00000000'
1469 'Function' : Info
.Module
.ModuleEntryPointList
,
1470 'PiSpecVersion' : PiSpecVersion
+ 'U',
1471 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1474 if Info
.ModuleType
in [SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1475 if Info
.SourceFileList
:
1476 if NumEntryPoints
!= 1:
1480 '%s must have exactly one entry point' % Info
.ModuleType
,
1482 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1484 if Info
.ModuleType
== SUP_MODULE_PEI_CORE
:
1485 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1486 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1487 elif Info
.ModuleType
== SUP_MODULE_DXE_CORE
:
1488 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1489 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1490 elif Info
.ModuleType
== SUP_MODULE_SMM_CORE
:
1491 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1492 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1493 elif Info
.ModuleType
== SUP_MODULE_MM_CORE_STANDALONE
:
1494 AutoGenC
.Append(gMmCoreStandaloneEntryPointString
.Replace(Dict
))
1495 AutoGenH
.Append(gMmCoreStandaloneEntryPointPrototype
.Replace(Dict
))
1496 elif Info
.ModuleType
== SUP_MODULE_PEIM
:
1497 if NumEntryPoints
< 2:
1498 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1500 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1501 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1502 elif Info
.ModuleType
in [SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
1503 if NumEntryPoints
< 2:
1504 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1506 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1507 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1508 elif Info
.ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
1509 if NumEntryPoints
== 0:
1510 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1512 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1513 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1514 elif Info
.ModuleType
== SUP_MODULE_MM_STANDALONE
:
1515 if NumEntryPoints
< 2:
1516 AutoGenC
.Append(gMmStandaloneEntryPointString
[NumEntryPoints
].Replace(Dict
))
1518 AutoGenC
.Append(gMmStandaloneEntryPointString
[2].Replace(Dict
))
1519 AutoGenH
.Append(gMmStandaloneEntryPointPrototype
.Replace(Dict
))
1520 elif Info
.ModuleType
== SUP_MODULE_UEFI_APPLICATION
:
1521 if NumEntryPoints
< 2:
1522 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1524 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1525 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1527 ## Create code for ModuleUnloadImage
1529 # @param Info The ModuleAutoGen object
1530 # @param AutoGenC The TemplateString object for C code
1531 # @param AutoGenH The TemplateString object for header file
1533 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1534 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1537 # Unload Image Handlers
1539 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1540 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1541 if NumUnloadImage
< 2:
1542 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1544 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1545 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1547 ## Create code for GUID
1549 # @param Info The ModuleAutoGen object
1550 # @param AutoGenC The TemplateString object for C code
1551 # @param AutoGenH The TemplateString object for header file
1553 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1554 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1557 GuidType
= "EFI_GUID"
1560 if not Info
.IsLibrary
:
1561 AutoGenC
.Append("\n// Guids\n")
1562 AutoGenH
.Append("\n// Guids\n")
1566 for Key
in Info
.GuidList
:
1567 if not Info
.IsLibrary
:
1568 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1569 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1571 ## Create code for protocol
1573 # @param Info The ModuleAutoGen object
1574 # @param AutoGenC The TemplateString object for C code
1575 # @param AutoGenH The TemplateString object for header file
1577 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1578 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1581 GuidType
= "EFI_GUID"
1583 if Info
.ProtocolList
:
1584 if not Info
.IsLibrary
:
1585 AutoGenC
.Append("\n// Protocols\n")
1586 AutoGenH
.Append("\n// Protocols\n")
1590 for Key
in Info
.ProtocolList
:
1591 if not Info
.IsLibrary
:
1592 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1593 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1595 ## Create code for PPI
1597 # @param Info The ModuleAutoGen object
1598 # @param AutoGenC The TemplateString object for C code
1599 # @param AutoGenH The TemplateString object for header file
1601 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1602 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1605 GuidType
= "EFI_GUID"
1608 if not Info
.IsLibrary
:
1609 AutoGenC
.Append("\n// PPIs\n")
1610 AutoGenH
.Append("\n// PPIs\n")
1614 for Key
in Info
.PpiList
:
1615 if not Info
.IsLibrary
:
1616 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1617 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1619 ## Create code for PCD
1621 # @param Info The ModuleAutoGen object
1622 # @param AutoGenC The TemplateString object for C code
1623 # @param AutoGenH The TemplateString object for header file
1625 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1627 # Collect Token Space GUIDs used by DynamicEc PCDs
1629 for Pcd
in Info
.ModulePcdList
:
1630 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1631 TokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
1633 SkuMgr
= Info
.Workspace
.Platform
.SkuIdMgr
1634 AutoGenH
.Append("\n// Definition of SkuId Array\n")
1635 AutoGenH
.Append("extern UINT64 _gPcd_SkuId_Array[];\n")
1636 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1638 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1639 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1642 GuidType
= "EFI_GUID"
1643 for Item
in TokenSpaceList
:
1644 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1647 if Info
.ModulePcdList
:
1648 AutoGenH
.Append("\n// PCD definitions\n")
1649 for Pcd
in Info
.ModulePcdList
:
1650 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1651 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1653 AutoGenC
.Append("\n// Definition of SkuId Array\n")
1654 AutoGenC
.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr
.DumpSkuIdArrary())
1655 if Info
.ModulePcdList
:
1656 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1657 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1658 for Pcd
in Info
.ModulePcdList
:
1659 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1660 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1661 if Info
.LibraryPcdList
:
1662 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1663 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1664 for Pcd
in Info
.LibraryPcdList
:
1665 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1666 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1668 ## Create code for unicode string definition
1670 # @param Info The ModuleAutoGen object
1671 # @param AutoGenC The TemplateString object for C code
1672 # @param AutoGenH The TemplateString object for header file
1673 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1674 # @param UniGenBinBuffer Buffer to store uni string package data
1676 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1677 WorkingDir
= os
.getcwd()
1678 os
.chdir(Info
.WorkspaceDir
)
1680 IncList
= [Info
.MetaFile
.Dir
]
1681 # Get all files under [Sources] section in inf file for EDK-II module
1683 SrcList
= [F
for F
in Info
.SourceFileList
]
1684 if Info
.AutoGenVersion
< 0x00010005:
1686 # Get all files under the module directory for EDK-I module
1688 os
.chdir(Info
.MetaFile
.Dir
)
1689 for Root
, Dirs
, Files
in os
.walk("."):
1695 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1698 SrcList
.append(File
)
1701 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1702 CompatibleMode
= True
1704 CompatibleMode
= False
1707 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1709 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1711 EdkLogger
.error("build", AUTOGEN_ERROR
,
1712 "-c and -s build options should be used exclusively",
1713 ExtraData
="[%s]" % str(Info
))
1718 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1720 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1722 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1723 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1724 if CompatibleMode
or UniGenCFlag
:
1725 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1726 AutoGenC
.Append(Code
)
1727 AutoGenC
.Append("\n")
1728 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1729 AutoGenH
.Append(Header
)
1730 if CompatibleMode
or UniGenCFlag
:
1731 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1732 os
.chdir(WorkingDir
)
1734 def CreateIdfFileCode(Info
, AutoGenC
, StringH
, IdfGenCFlag
, IdfGenBinBuffer
):
1735 if len(Info
.IdfFileList
) > 0:
1736 ImageFiles
= IdfFileClassObject(sorted (Info
.IdfFileList
))
1737 if ImageFiles
.ImageFilesDict
:
1740 IncList
= [Info
.MetaFile
.Dir
]
1741 SrcList
= [F
for F
in Info
.SourceFileList
]
1742 SkipList
= ['.jpg', '.png', '.bmp', '.inf', '.idf']
1743 FileList
= GetFileList(SrcList
, IncList
, SkipList
)
1745 StringH
.Append("\n//\n//Image ID\n//\n")
1747 PaletteInfoOffset
= 0
1748 ImageBuffer
= pack('x')
1749 PaletteBuffer
= pack('x')
1753 for Idf
in ImageFiles
.ImageFilesDict
:
1754 if ImageFiles
.ImageFilesDict
[Idf
]:
1755 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1756 for sourcefile
in Info
.SourceFileList
:
1757 if FileObj
.FileName
== sourcefile
.File
:
1758 if not sourcefile
.Ext
.upper() in ['.PNG', '.BMP', '.JPG']:
1759 EdkLogger
.error("build", AUTOGEN_ERROR
, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj
.FileName
), ExtraData
="[%s]" % str(Info
))
1760 FileObj
.File
= sourcefile
1763 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
))
1765 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1766 ID
= FileObj
.ImageID
1768 if not os
.path
.exists(File
.Path
) or not os
.path
.isfile(File
.Path
):
1769 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=File
.Path
)
1770 SearchImageID (FileObj
, FileList
)
1771 if FileObj
.Referenced
:
1772 if (ValueStartPtr
- len(DEFINE_STR
+ ID
)) <= 0:
1773 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' + DecToHexStr(Index
, 4) + '\n'
1775 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' * (ValueStartPtr
- len(DEFINE_STR
+ ID
)) + DecToHexStr(Index
, 4) + '\n'
1777 if File
not in FileDict
:
1778 FileDict
[File
] = Index
1780 DuplicateBlock
= pack('B', EFI_HII_IIBT_DUPLICATE
)
1781 DuplicateBlock
+= pack('H', FileDict
[File
])
1782 ImageBuffer
+= DuplicateBlock
1783 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1784 TempBufferList
= AscToHexList(DuplicateBlock
)
1785 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1786 StringH
.Append(Line
)
1790 TmpFile
= open(File
.Path
, 'rb')
1791 Buffer
= TmpFile
.read()
1793 if File
.Ext
.upper() == '.PNG':
1794 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_PNG
)
1795 TempBuffer
+= pack('I', len(Buffer
))
1796 TempBuffer
+= Buffer
1797 elif File
.Ext
.upper() == '.JPG':
1798 ImageType
, = struct
.unpack('4s', Buffer
[6:10])
1799 if ImageType
!= 'JFIF':
1800 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard JPG file." % File
.Path
)
1801 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_JPEG
)
1802 TempBuffer
+= pack('I', len(Buffer
))
1803 TempBuffer
+= Buffer
1804 elif File
.Ext
.upper() == '.BMP':
1805 TempBuffer
, TempPalette
= BmpImageDecoder(File
, Buffer
, PaletteIndex
, FileObj
.TransParent
)
1806 if len(TempPalette
) > 1:
1808 NewPalette
= pack('H', len(TempPalette
))
1809 NewPalette
+= TempPalette
1810 PaletteBuffer
+= NewPalette
1811 PaletteStr
= WriteLine(PaletteStr
, '// %s: %s: %s' % (DecToHexStr(PaletteIndex
- 1, 4), ID
, DecToHexStr(PaletteIndex
- 1, 4)))
1812 TempPaletteList
= AscToHexList(NewPalette
)
1813 PaletteStr
= WriteLine(PaletteStr
, CreateArrayItem(TempPaletteList
, 16) + '\n')
1814 ImageBuffer
+= TempBuffer
1815 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1816 TempBufferList
= AscToHexList(TempBuffer
)
1817 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1819 StringH
.Append(Line
)
1822 BufferStr
= WriteLine(BufferStr
, '// End of the Image Info')
1823 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END
, 2)) + '\n')
1824 ImageEnd
= pack('B', EFI_HII_IIBT_END
)
1825 ImageBuffer
+= ImageEnd
1827 if len(ImageBuffer
) > 1:
1828 ImageInfoOffset
= 12
1829 if len(PaletteBuffer
) > 1:
1830 PaletteInfoOffset
= 12 + len(ImageBuffer
) - 1 # -1 is for the first empty pad byte of ImageBuffer
1832 IMAGE_PACKAGE_HDR
= pack('=II', ImageInfoOffset
, PaletteInfoOffset
)
1833 # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length
1834 if len(PaletteBuffer
) > 1:
1835 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1 + 2 + len(PaletteBuffer
) - 1
1837 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1
1838 if PaletteIndex
> 1:
1839 PALETTE_INFO_HEADER
= pack('H', PaletteIndex
- 1)
1840 # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF
1841 Hex_Length
= '%06X' % PACKAGE_HEADER_Length
1842 if PACKAGE_HEADER_Length
> 0xFFFFFF:
1843 EdkLogger
.error("build", AUTOGEN_ERROR
, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData
="[%s]" % str(Info
))
1844 PACKAGE_HEADER
= pack('=HBB', int('0x' + Hex_Length
[2:], 16), int('0x' + Hex_Length
[0:2], 16), EFI_HII_PACKAGE_IMAGES
)
1846 IdfGenBinBuffer
.write(PACKAGE_HEADER
)
1847 IdfGenBinBuffer
.write(IMAGE_PACKAGE_HDR
)
1848 if len(ImageBuffer
) > 1 :
1849 IdfGenBinBuffer
.write(ImageBuffer
[1:])
1850 if PaletteIndex
> 1:
1851 IdfGenBinBuffer
.write(PALETTE_INFO_HEADER
)
1852 if len(PaletteBuffer
) > 1:
1853 IdfGenBinBuffer
.write(PaletteBuffer
[1:])
1856 TotalLength
= EFI_HII_ARRAY_SIZE_LENGTH
+ PACKAGE_HEADER_Length
1857 AutoGenC
.Append("\n//\n//Image Pack Definition\n//\n")
1858 AllStr
= WriteLine('', CHAR_ARRAY_DEFIN
+ ' ' + Info
.Module
.BaseName
+ 'Images' + '[] = {\n')
1859 AllStr
= WriteLine(AllStr
, '// STRGATHER_OUTPUT_HEADER')
1860 AllStr
= WriteLine(AllStr
, CreateArrayItem(DecToHexList(TotalLength
)) + '\n')
1861 AllStr
= WriteLine(AllStr
, '// Image PACKAGE HEADER\n')
1862 IMAGE_PACKAGE_HDR_List
= AscToHexList(PACKAGE_HEADER
)
1863 IMAGE_PACKAGE_HDR_List
+= AscToHexList(IMAGE_PACKAGE_HDR
)
1864 AllStr
= WriteLine(AllStr
, CreateArrayItem(IMAGE_PACKAGE_HDR_List
, 16) + '\n')
1865 AllStr
= WriteLine(AllStr
, '// Image DATA\n')
1867 AllStr
= WriteLine(AllStr
, BufferStr
)
1869 AllStr
= WriteLine(AllStr
, '// Palette Header\n')
1870 PALETTE_INFO_HEADER_List
= AscToHexList(PALETTE_INFO_HEADER
)
1871 AllStr
= WriteLine(AllStr
, CreateArrayItem(PALETTE_INFO_HEADER_List
, 16) + '\n')
1872 AllStr
= WriteLine(AllStr
, '// Palette Data\n')
1873 AllStr
= WriteLine(AllStr
, PaletteStr
)
1874 AllStr
= WriteLine(AllStr
, '};')
1875 AutoGenC
.Append(AllStr
)
1876 AutoGenC
.Append("\n")
1877 StringH
.Append('\nextern unsigned char ' + Info
.Module
.BaseName
+ 'Images[];\n')
1878 StringH
.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info
.Module
.BaseName
)
1880 # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {
1881 # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES
1882 # UINT32 ImageInfoOffset;
1883 # UINT32 PaletteInfoOffset;
1884 # } EFI_HII_IMAGE_PACKAGE_HDR;
1890 # } EFI_HII_PACKAGE_HEADER;
1892 # typedef struct _EFI_HII_IMAGE_BLOCK {
1894 # UINT8 BlockBody[];
1895 # } EFI_HII_IMAGE_BLOCK;
1897 def BmpImageDecoder(File
, Buffer
, PaletteIndex
, TransParent
):
1898 ImageType
, = struct
.unpack('2s', Buffer
[0:2])
1899 if ImageType
!= 'BM': # BMP file type is 'BM'
1900 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard BMP file." % File
.Path
)
1901 BMP_IMAGE_HEADER
= collections
.namedtuple('BMP_IMAGE_HEADER', ['bfSize', 'bfReserved1', 'bfReserved2', 'bfOffBits', 'biSize', 'biWidth', 'biHeight', 'biPlanes', 'biBitCount', 'biCompression', 'biSizeImage', 'biXPelsPerMeter', 'biYPelsPerMeter', 'biClrUsed', 'biClrImportant'])
1902 BMP_IMAGE_HEADER_STRUCT
= struct
.Struct('IHHIIIIHHIIIIII')
1903 BmpHeader
= BMP_IMAGE_HEADER
._make
(BMP_IMAGE_HEADER_STRUCT
.unpack_from(Buffer
[2:]))
1905 # Doesn't support compress.
1907 if BmpHeader
.biCompression
!= 0:
1908 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The compress BMP file %s is not support." % File
.Path
)
1910 # The Width and Height is UINT16 type in Image Package
1911 if BmpHeader
.biWidth
> 0xFFFF:
1912 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Width is exceed 0xFFFF." % File
.Path
)
1913 if BmpHeader
.biHeight
> 0xFFFF:
1914 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Height is exceed 0xFFFF." % File
.Path
)
1916 PaletteBuffer
= pack('x')
1917 if BmpHeader
.biBitCount
== 1:
1919 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS
)
1921 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT
)
1922 ImageBuffer
+= pack('B', PaletteIndex
)
1923 Width
= (BmpHeader
.biWidth
+ 7)/8
1924 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1925 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1926 elif BmpHeader
.biBitCount
== 4:
1928 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS
)
1930 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT
)
1931 ImageBuffer
+= pack('B', PaletteIndex
)
1932 Width
= (BmpHeader
.biWidth
+ 1)/2
1933 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1934 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1935 elif BmpHeader
.biBitCount
== 8:
1937 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS
)
1939 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT
)
1940 ImageBuffer
+= pack('B', PaletteIndex
)
1941 Width
= BmpHeader
.biWidth
1942 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1943 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1944 elif BmpHeader
.biBitCount
== 24:
1946 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS
)
1948 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT
)
1949 Width
= BmpHeader
.biWidth
* 3
1951 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData
="[%s]" % str(File
.Path
))
1953 ImageBuffer
+= pack('H', BmpHeader
.biWidth
)
1954 ImageBuffer
+= pack('H', BmpHeader
.biHeight
)
1955 Start
= BmpHeader
.bfOffBits
1956 End
= BmpHeader
.bfSize
- 1
1957 for Height
in range(0, BmpHeader
.biHeight
):
1959 Start
= End
+ (Width
% 4) - 4 - Width
1962 ImageBuffer
+= Buffer
[Start
+ 1 : Start
+ Width
+ 1]
1965 # 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
1966 if PaletteBuffer
and len(PaletteBuffer
) > 1:
1967 PaletteTemp
= pack('x')
1968 for Index
in range(0, len(PaletteBuffer
)):
1971 PaletteTemp
+= PaletteBuffer
[Index
]
1972 PaletteBuffer
= PaletteTemp
[1:]
1973 return ImageBuffer
, PaletteBuffer
1975 ## Create common code
1977 # @param Info The ModuleAutoGen object
1978 # @param AutoGenC The TemplateString object for C code
1979 # @param AutoGenH The TemplateString object for header file
1981 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1983 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1984 # header file Prologue
1985 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-', '_')}))
1986 AutoGenH
.Append(gAutoGenHCppPrologueString
)
1987 if Info
.AutoGenVersion
>= 0x00010005:
1988 # header files includes
1989 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1990 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1992 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
1993 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
1995 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
1996 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
1998 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
1999 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
2004 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
2009 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
2010 if Info
.AutoGenVersion
>= 0x00010005:
2011 # C file header files includes
2012 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2013 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
2014 AutoGenC
.Append("#include <%s>\n" % Inc
)
2016 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
2019 # Publish the CallerId Guid
2021 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
2022 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
2024 ## Create common code for header file
2026 # @param Info The ModuleAutoGen object
2027 # @param AutoGenC The TemplateString object for C code
2028 # @param AutoGenH The TemplateString object for header file
2030 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
2031 AutoGenH
.Append(gAutoGenHEpilogueString
)
2033 ## Create code for a module
2035 # @param Info The ModuleAutoGen object
2036 # @param AutoGenC The TemplateString object for C code
2037 # @param AutoGenH The TemplateString object for header file
2038 # @param StringH The TemplateString object for header file
2039 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
2040 # @param UniGenBinBuffer Buffer to store uni string package data
2041 # @param StringIdf The TemplateString object for header file
2042 # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True
2043 # @param IdfGenBinBuffer Buffer to store Idf string package data
2045 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
):
2046 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
2048 if Info
.AutoGenVersion
>= 0x00010005:
2049 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2050 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2051 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2052 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
2053 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
2054 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
2055 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
2056 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
2058 if Info
.UnicodeFileList
:
2059 FileName
= "%sStrDefs.h" % Info
.Name
2060 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2061 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2062 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
2065 for Guid
in Info
.Module
.Guids
:
2066 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
2068 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
2069 for Guid
, Value
in Info
.Module
.Protocols
.items() + Info
.Module
.Ppis
.items():
2070 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
2071 # supports FixedAtBuild and FeaturePcd usage in VFR file
2072 if Info
.VfrFileList
and Info
.ModulePcdList
:
2073 GuidMacros
.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))
2074 GuidMacros
.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))
2075 GuidMacros
.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))
2076 GuidMacros
.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))
2077 GuidMacros
.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))
2078 GuidMacros
.append('#define %s %s' % ('FeaturePcdGet(TokenName)', '_PCD_VALUE_##TokenName'))
2079 for Pcd
in Info
.ModulePcdList
:
2080 if Pcd
.Type
in [TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_FEATURE_FLAG
]:
2081 TokenCName
= Pcd
.TokenCName
2082 Value
= Pcd
.DefaultValue
2083 if Pcd
.DatumType
== 'BOOLEAN':
2084 BoolValue
= Value
.upper()
2085 if BoolValue
== 'TRUE':
2087 elif BoolValue
== 'FALSE':
2089 for PcdItem
in GlobalData
.MixedPcd
:
2090 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2091 TokenCName
= PcdItem
[0]
2093 GuidMacros
.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName
, Value
))
2095 if Info
.IdfFileList
:
2096 GuidMacros
.append('#include "%sImgDefs.h"' % Info
.Name
)
2099 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
2101 StringH
.Append("\n#endif\n")
2102 AutoGenH
.Append('#include "%s"\n' % FileName
)
2104 if Info
.IdfFileList
:
2105 FileName
= "%sImgDefs.h" % Info
.Name
2106 StringIdf
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2107 StringIdf
.Append(gAutoGenHPrologueString
.Replace({'File':'IMAGEDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2108 CreateIdfFileCode(Info
, AutoGenC
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
)
2110 StringIdf
.Append("\n#endif\n")
2111 AutoGenH
.Append('#include "%s"\n' % FileName
)
2113 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
2115 # no generation of AutoGen.c for Edk modules without unicode file
2116 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
2117 AutoGenC
.String
= ''
2119 ## Create the code file
2121 # @param FilePath The path of code file
2122 # @param Content The content of code file
2123 # @param IsBinaryFile The flag indicating if the file is binary file or not
2125 # @retval True If file content is changed or file doesn't exist
2126 # @retval False If the file exists and the content is not changed
2128 def Generate(FilePath
, Content
, IsBinaryFile
):
2129 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)