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.
19 from Common
import EdkLogger
21 from Common
.BuildToolError
import *
22 from Common
.DataType
import *
23 from Common
.Misc
import *
24 from Common
.StringUtils
import StringToArray
25 from .StrGather
import *
26 from .GenPcdDb
import CreatePcdDatabaseCode
27 from .IdfClassObject
import *
30 gItemTypeStringDatabase
= {
31 TAB_PCDS_FEATURE_FLAG
: TAB_PCDS_FIXED_AT_BUILD
,
32 TAB_PCDS_FIXED_AT_BUILD
: TAB_PCDS_FIXED_AT_BUILD
,
33 TAB_PCDS_PATCHABLE_IN_MODULE
: 'BinaryPatch',
34 TAB_PCDS_DYNAMIC
: '',
35 TAB_PCDS_DYNAMIC_DEFAULT
: '',
36 TAB_PCDS_DYNAMIC_VPD
: '',
37 TAB_PCDS_DYNAMIC_HII
: '',
38 TAB_PCDS_DYNAMIC_EX
: '',
39 TAB_PCDS_DYNAMIC_EX_DEFAULT
: '',
40 TAB_PCDS_DYNAMIC_EX_VPD
: '',
41 TAB_PCDS_DYNAMIC_EX_HII
: '',
46 gDatumSizeStringDatabase
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'BOOLEAN',TAB_VOID
:'8'}
47 gDatumSizeStringDatabaseH
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'BOOL',TAB_VOID
:'PTR'}
48 gDatumSizeStringDatabaseLib
= {TAB_UINT8
:'8',TAB_UINT16
:'16',TAB_UINT32
:'32',TAB_UINT64
:'64','BOOLEAN':'Bool',TAB_VOID
:'Ptr'}
50 ## AutoGen File Header Templates
51 gAutoGenHeaderString
= TemplateString("""\
57 Abstract: Auto-generated ${FileName} for building module or library.
61 gAutoGenHPrologueString
= TemplateString("""
62 #ifndef _${File}_${Guid}
63 #define _${File}_${Guid}
67 gAutoGenHCppPrologueString
= """\
74 gAutoGenHEpilogueString
= """
83 ## PEI Core Entry Point Templates
84 gPeiCoreEntryPointPrototype
= TemplateString("""
89 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
90 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
96 gPeiCoreEntryPointString
= TemplateString("""
100 ProcessModuleEntryPointList (
101 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
102 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
107 ${Function} (SecCoreData, PpiList, Context);
113 ## DXE Core Entry Point Templates
114 gDxeCoreEntryPointPrototype
= TemplateString("""
124 gDxeCoreEntryPointString
= TemplateString("""
128 ProcessModuleEntryPointList (
133 ${Function} (HobStart);
138 ## PEIM Entry Point Templates
139 gPeimEntryPointPrototype
= TemplateString("""
144 IN EFI_PEI_FILE_HANDLE FileHandle,
145 IN CONST EFI_PEI_SERVICES **PeiServices
150 gPeimEntryPointString
= [
152 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
156 ProcessModuleEntryPointList (
157 IN EFI_PEI_FILE_HANDLE FileHandle,
158 IN CONST EFI_PEI_SERVICES **PeiServices
166 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
170 ProcessModuleEntryPointList (
171 IN EFI_PEI_FILE_HANDLE FileHandle,
172 IN CONST EFI_PEI_SERVICES **PeiServices
176 return ${Function} (FileHandle, PeiServices);
181 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
185 ProcessModuleEntryPointList (
186 IN EFI_PEI_FILE_HANDLE FileHandle,
187 IN CONST EFI_PEI_SERVICES **PeiServices
192 EFI_STATUS CombinedStatus;
194 CombinedStatus = EFI_LOAD_ERROR;
196 Status = ${Function} (FileHandle, PeiServices);
197 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
198 CombinedStatus = Status;
201 return CombinedStatus;
206 ## SMM_CORE Entry Point Templates
207 gSmmCoreEntryPointPrototype
= TemplateString("""
212 IN EFI_HANDLE ImageHandle,
213 IN EFI_SYSTEM_TABLE *SystemTable
218 gSmmCoreEntryPointString
= TemplateString("""
220 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
221 const UINT32 _gDxeRevision = ${PiSpecVersion};
225 ProcessModuleEntryPointList (
226 IN EFI_HANDLE ImageHandle,
227 IN EFI_SYSTEM_TABLE *SystemTable
230 return ${Function} (ImageHandle, SystemTable);
235 ## MM_CORE_STANDALONE Entry Point Templates
236 gMmCoreStandaloneEntryPointPrototype
= TemplateString("""
246 gMmCoreStandaloneEntryPointString
= TemplateString("""
248 const UINT32 _gMmRevision = ${PiSpecVersion};
252 ProcessModuleEntryPointList (
256 ${Function} (HobStart);
261 ## MM_STANDALONE Entry Point Templates
262 gMmStandaloneEntryPointPrototype
= TemplateString("""
267 IN EFI_HANDLE ImageHandle,
268 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
273 gMmStandaloneEntryPointString
= [
275 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
279 ProcessModuleEntryPointList (
280 IN EFI_HANDLE ImageHandle,
281 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
289 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
293 ProcessModuleEntryPointList (
294 IN EFI_HANDLE ImageHandle,
295 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
299 return ${Function} (ImageHandle, MmSystemTable);
304 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
308 ProcessModuleEntryPointList (
309 IN EFI_HANDLE ImageHandle,
310 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
315 EFI_STATUS CombinedStatus;
317 CombinedStatus = EFI_LOAD_ERROR;
319 Status = ${Function} (ImageHandle, MmSystemTable);
320 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
321 CombinedStatus = Status;
324 return CombinedStatus;
329 ## DXE SMM Entry Point Templates
330 gDxeSmmEntryPointPrototype
= TemplateString("""
335 IN EFI_HANDLE ImageHandle,
336 IN EFI_SYSTEM_TABLE *SystemTable
341 gDxeSmmEntryPointString
= [
343 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
344 const UINT32 _gDxeRevision = ${PiSpecVersion};
348 ProcessModuleEntryPointList (
349 IN EFI_HANDLE ImageHandle,
350 IN EFI_SYSTEM_TABLE *SystemTable
358 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
359 const UINT32 _gDxeRevision = ${PiSpecVersion};
361 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
362 static EFI_STATUS mDriverEntryPointStatus;
370 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
371 mDriverEntryPointStatus = Status;
373 LongJump (&mJumpContext, (UINTN)-1);
379 ProcessModuleEntryPointList (
380 IN EFI_HANDLE ImageHandle,
381 IN EFI_SYSTEM_TABLE *SystemTable
384 mDriverEntryPointStatus = EFI_LOAD_ERROR;
387 if (SetJump (&mJumpContext) == 0) {
388 ExitDriver (${Function} (ImageHandle, SystemTable));
393 return mDriverEntryPointStatus;
398 ## UEFI Driver Entry Point Templates
399 gUefiDriverEntryPointPrototype
= TemplateString("""
404 IN EFI_HANDLE ImageHandle,
405 IN EFI_SYSTEM_TABLE *SystemTable
410 gUefiDriverEntryPointString
= [
412 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
413 const UINT32 _gDxeRevision = ${PiSpecVersion};
417 ProcessModuleEntryPointList (
418 IN EFI_HANDLE ImageHandle,
419 IN EFI_SYSTEM_TABLE *SystemTable
426 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
427 const UINT32 _gDxeRevision = ${PiSpecVersion};
432 ProcessModuleEntryPointList (
433 IN EFI_HANDLE ImageHandle,
434 IN EFI_SYSTEM_TABLE *SystemTable
438 return ${Function} (ImageHandle, SystemTable);
447 if (EFI_ERROR (Status)) {
448 ProcessLibraryDestructorList (gImageHandle, gST);
450 gBS->Exit (gImageHandle, Status, 0, NULL);
454 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
455 const UINT32 _gDxeRevision = ${PiSpecVersion};
457 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
458 static EFI_STATUS mDriverEntryPointStatus;
462 ProcessModuleEntryPointList (
463 IN EFI_HANDLE ImageHandle,
464 IN EFI_SYSTEM_TABLE *SystemTable
467 mDriverEntryPointStatus = EFI_LOAD_ERROR;
469 if (SetJump (&mJumpContext) == 0) {
470 ExitDriver (${Function} (ImageHandle, SystemTable));
474 return mDriverEntryPointStatus;
483 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
484 mDriverEntryPointStatus = Status;
486 LongJump (&mJumpContext, (UINTN)-1);
493 ## UEFI Application Entry Point Templates
494 gUefiApplicationEntryPointPrototype
= TemplateString("""
499 IN EFI_HANDLE ImageHandle,
500 IN EFI_SYSTEM_TABLE *SystemTable
505 gUefiApplicationEntryPointString
= [
507 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
511 ProcessModuleEntryPointList (
512 IN EFI_HANDLE ImageHandle,
513 IN EFI_SYSTEM_TABLE *SystemTable
520 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
525 ProcessModuleEntryPointList (
526 IN EFI_HANDLE ImageHandle,
527 IN EFI_SYSTEM_TABLE *SystemTable
531 return ${Function} (ImageHandle, SystemTable);
540 if (EFI_ERROR (Status)) {
541 ProcessLibraryDestructorList (gImageHandle, gST);
543 gBS->Exit (gImageHandle, Status, 0, NULL);
547 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
551 ProcessModuleEntryPointList (
552 IN EFI_HANDLE ImageHandle,
553 IN EFI_SYSTEM_TABLE *SystemTable
558 if (SetJump (&mJumpContext) == 0) {
559 ExitDriver (${Function} (ImageHandle, SystemTable));
563 return mDriverEntryPointStatus;
566 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
567 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
575 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
576 mDriverEntryPointStatus = Status;
578 LongJump (&mJumpContext, (UINTN)-1);
584 ## UEFI Unload Image Templates
585 gUefiUnloadImagePrototype
= TemplateString("""
590 IN EFI_HANDLE ImageHandle
595 gUefiUnloadImageString
= [
597 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
601 ProcessModuleUnloadList (
602 IN EFI_HANDLE ImageHandle
609 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
614 ProcessModuleUnloadList (
615 IN EFI_HANDLE ImageHandle
618 return ${Function} (ImageHandle);
623 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
627 ProcessModuleUnloadList (
628 IN EFI_HANDLE ImageHandle
633 Status = EFI_SUCCESS;
635 if (EFI_ERROR (Status)) {
636 ${Function} (ImageHandle);
638 Status = ${Function} (ImageHandle);
646 gLibraryStructorPrototype
= {
647 SUP_MODULE_BASE
: TemplateString("""${BEGIN}
655 'PEI' : TemplateString("""${BEGIN}
659 IN EFI_PEI_FILE_HANDLE FileHandle,
660 IN CONST EFI_PEI_SERVICES **PeiServices
664 'DXE' : TemplateString("""${BEGIN}
668 IN EFI_HANDLE ImageHandle,
669 IN EFI_SYSTEM_TABLE *SystemTable
673 'MM' : TemplateString("""${BEGIN}
677 IN EFI_HANDLE ImageHandle,
678 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
683 gLibraryStructorCall
= {
684 SUP_MODULE_BASE
: TemplateString("""${BEGIN}
685 Status = ${Function} ();
686 ASSERT_EFI_ERROR (Status);${END}
689 'PEI' : TemplateString("""${BEGIN}
690 Status = ${Function} (FileHandle, PeiServices);
691 ASSERT_EFI_ERROR (Status);${END}
694 'DXE' : TemplateString("""${BEGIN}
695 Status = ${Function} (ImageHandle, SystemTable);
696 ASSERT_EFI_ERROR (Status);${END}
699 'MM' : TemplateString("""${BEGIN}
700 Status = ${Function} (ImageHandle, MmSystemTable);
701 ASSERT_EFI_ERROR (Status);${END}
705 ## Library Constructor and Destructor Templates
707 SUP_MODULE_BASE
: TemplateString("""
708 ${BEGIN}${FunctionPrototype}${END}
712 ProcessLibrary${Type}List (
716 ${BEGIN} EFI_STATUS Status;
717 ${FunctionCall}${END}
721 'PEI' : TemplateString("""
722 ${BEGIN}${FunctionPrototype}${END}
726 ProcessLibrary${Type}List (
727 IN EFI_PEI_FILE_HANDLE FileHandle,
728 IN CONST EFI_PEI_SERVICES **PeiServices
731 ${BEGIN} EFI_STATUS Status;
732 ${FunctionCall}${END}
736 'DXE' : TemplateString("""
737 ${BEGIN}${FunctionPrototype}${END}
741 ProcessLibrary${Type}List (
742 IN EFI_HANDLE ImageHandle,
743 IN EFI_SYSTEM_TABLE *SystemTable
746 ${BEGIN} EFI_STATUS Status;
747 ${FunctionCall}${END}
751 'MM' : TemplateString("""
752 ${BEGIN}${FunctionPrototype}${END}
756 ProcessLibrary${Type}List (
757 IN EFI_HANDLE ImageHandle,
758 IN EFI_MM_SYSTEM_TABLE *MmSystemTable
761 ${BEGIN} EFI_STATUS Status;
762 ${FunctionCall}${END}
767 gBasicHeaderFile
= "Base.h"
769 gModuleTypeHeaderFile
= {
770 SUP_MODULE_BASE
: [gBasicHeaderFile
],
771 SUP_MODULE_SEC
: ["PiPei.h", "Library/DebugLib.h"],
772 SUP_MODULE_PEI_CORE
: ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
773 SUP_MODULE_PEIM
: ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
774 SUP_MODULE_DXE_CORE
: ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
775 SUP_MODULE_DXE_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
776 SUP_MODULE_DXE_SMM_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
777 SUP_MODULE_DXE_RUNTIME_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
778 SUP_MODULE_DXE_SAL_DRIVER
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
779 SUP_MODULE_UEFI_DRIVER
: ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
780 SUP_MODULE_UEFI_APPLICATION
: ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
781 SUP_MODULE_SMM_CORE
: ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
782 SUP_MODULE_MM_STANDALONE
: ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmDriverEntryPoint.h"],
783 SUP_MODULE_MM_CORE_STANDALONE
: ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmCoreEntryPoint.h"],
784 SUP_MODULE_USER_DEFINED
: [gBasicHeaderFile
]
787 ## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName
788 # the TokenName and Guid comparison to avoid define name collisions.
790 # @param Info The ModuleAutoGen object
791 # @param AutoGenH The TemplateString object for header file
794 def DynExPcdTokenNumberMapping(Info
, AutoGenH
):
795 ExTokenCNameList
= []
797 # Even it is the Library, the PCD is saved in the ModulePcdList
798 PcdList
= Info
.ModulePcdList
800 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
801 ExTokenCNameList
.append(Pcd
.TokenCName
)
802 PcdExList
.append(Pcd
)
803 if len(ExTokenCNameList
) == 0:
805 AutoGenH
.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')
806 # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.
807 # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.
808 # Use the Guid pointer to see if it matches any of the token space GUIDs.
809 TokenCNameList
= set()
810 for TokenCName
in ExTokenCNameList
:
811 if TokenCName
in TokenCNameList
:
814 Count
= ExTokenCNameList
.count(TokenCName
)
815 for Pcd
in PcdExList
:
816 RealTokenCName
= Pcd
.TokenCName
817 for PcdItem
in GlobalData
.MixedPcd
:
818 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
819 RealTokenCName
= PcdItem
[0]
821 if Pcd
.TokenCName
== TokenCName
:
824 AutoGenH
.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (RealTokenCName
))
825 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
826 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
828 AutoGenH
.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
829 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
831 AutoGenH
.Append('0 \\\n )\n')
832 TokenCNameList
.add(TokenCName
)
834 TokenCNameList
= set()
835 for TokenCName
in ExTokenCNameList
:
836 if TokenCName
in TokenCNameList
:
839 Count
= ExTokenCNameList
.count(TokenCName
)
840 for Pcd
in PcdExList
:
841 RealTokenCName
= Pcd
.TokenCName
842 for PcdItem
in GlobalData
.MixedPcd
:
843 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
844 RealTokenCName
= PcdItem
[0]
846 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== TokenCName
:
849 AutoGenH
.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (RealTokenCName
))
850 AutoGenH
.Append('\\\n (GuidPtr == NULL) ? 0:')
851 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
852 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
854 AutoGenH
.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
855 % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenSpaceGuidCName
, RealTokenCName
))
857 AutoGenH
.Append('0 \\\n )\n')
858 # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.
859 # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler
860 # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().
861 # COMPAREGUID() will only be used if the Guid passed in is local to the module.
862 AutoGenH
.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'
863 % (RealTokenCName
, RealTokenCName
, RealTokenCName
, RealTokenCName
))
864 TokenCNameList
.add(TokenCName
)
866 ## Create code for module PCDs
868 # @param Info The ModuleAutoGen object
869 # @param AutoGenC The TemplateString object for C code
870 # @param AutoGenH The TemplateString object for header file
871 # @param Pcd The PCD object
873 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
874 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
875 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
879 TokenCName
= Pcd
.TokenCName
880 for PcdItem
in GlobalData
.MixedPcd
:
881 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
882 TokenCName
= PcdItem
[0]
884 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
885 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
886 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
887 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
888 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
889 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
891 if Pcd
.PcdValueFromComm
:
892 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
893 elif Pcd
.PcdValueFromFdf
:
894 Pcd
.DefaultValue
= Pcd
.PcdValueFromFdf
896 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
897 TokenNumber
= int(Pcd
.TokenValue
, 0)
898 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
899 # different Guids but same TokenCName
900 PcdExTokenName
= '_PCD_TOKEN_' + Pcd
.TokenSpaceGuidCName
+ '_' + TokenCName
901 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
903 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
904 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
905 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
906 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
907 # report warning message notify the PI that they are attempting to build a module
908 # that must be included in a flash image in order to be functional. These Dynamic PCD
909 # will not be added into the Database unless it is used by other modules that are
910 # included in the FDF file.
911 # In this case, just assign an invalid token number to make it pass build.
912 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
915 EdkLogger
.error("build", AUTOGEN_ERROR
,
916 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
917 ExtraData
="[%s]" % str(Info
))
919 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
920 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
922 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
923 if Pcd
.Type
not in gItemTypeStringDatabase
:
924 EdkLogger
.error("build", AUTOGEN_ERROR
,
925 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
926 ExtraData
="[%s]" % str(Info
))
928 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
929 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
930 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
931 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
932 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
933 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
935 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
937 PcdList
= Info
.LibraryPcdList
939 PcdList
= list(Info
.ModulePcdList
) + list(Info
.LibraryPcdList
)
941 for PcdModule
in PcdList
:
942 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
944 # get out early once we found > 1...
945 if PcdExCNameTest
> 1:
947 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
948 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
949 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
950 if PcdExCNameTest
> 1:
951 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')
952 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
953 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
954 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
955 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
956 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
957 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
959 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
960 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
962 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
963 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
964 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
965 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
966 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
967 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
969 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
970 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
971 elif Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
973 for PcdModule
in list(Info
.LibraryPcdList
) + list(Info
.ModulePcdList
):
974 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
976 # get out early once we found > 1...
980 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
))
982 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
983 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
984 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
985 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
986 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
988 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
989 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
991 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
993 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
997 Value
= Pcd
.DefaultValue
1001 if Pcd
.DatumType
== 'BOOLEAN':
1002 BoolValue
= Value
.upper()
1003 if BoolValue
== 'TRUE' or BoolValue
== '1':
1005 elif BoolValue
== 'FALSE' or BoolValue
== '0':
1008 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1010 if Value
.upper().endswith('L'):
1012 ValueNumber
= int (Value
, 0)
1014 EdkLogger
.error("build", AUTOGEN_ERROR
,
1015 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1016 ExtraData
="[%s]" % str(Info
))
1018 EdkLogger
.error("build", AUTOGEN_ERROR
,
1019 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1020 ExtraData
="[%s]" % str(Info
))
1021 elif ValueNumber
> MAX_VAL_TYPE
[Pcd
.DatumType
]:
1022 EdkLogger
.error("build", AUTOGEN_ERROR
,
1023 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1024 ExtraData
="[%s]" % str(Info
))
1025 if Pcd
.DatumType
== TAB_UINT64
and not Value
.endswith('ULL'):
1027 elif Pcd
.DatumType
!= TAB_UINT64
and not Value
.endswith('U'):
1030 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1031 if not Pcd
.MaxDatumSize
:
1032 EdkLogger
.error("build", AUTOGEN_ERROR
,
1033 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1034 ExtraData
="[%s]" % str(Info
))
1036 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
1039 ValueSize
= len(Value
.split(','))
1043 Value
= Value
.lstrip('L') #.strip('"')
1044 Value
= eval(Value
) # translate escape character
1045 ValueSize
= len(Value
) + 1
1047 for Index
in range(0, len(Value
)):
1049 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
1051 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
1053 ArraySize
= ArraySize
/ 2
1054 Value
= NewValue
+ '0 }'
1055 if ArraySize
< ValueSize
:
1056 if Pcd
.MaxSizeUserSet
:
1057 EdkLogger
.error("build", AUTOGEN_ERROR
,
1058 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1059 ExtraData
="[%s]" % str(Info
))
1061 ArraySize
= Pcd
.GetPcdSize()
1063 ArraySize
= ArraySize
/ 2
1064 Array
= '[%d]' % ArraySize
1066 # skip casting for fixed at build since it breaks ARM assembly.
1067 # Long term we need PCD macros that work in assembly
1069 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
and Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES_VOID
:
1070 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1072 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1073 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + TokenCName
1075 PcdValueName
= '_PCD_VALUE_' + TokenCName
1077 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1079 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1081 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1083 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1084 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1086 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1087 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1088 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1090 PcdDataSize
= Pcd
.GetPcdSize()
1091 if Pcd
.Type
== TAB_PCDS_FIXED_AT_BUILD
:
1092 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1093 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1094 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName
, PcdDataSize
))
1095 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1096 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, Pcd
.MaxDatumSize
))
1097 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1098 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1099 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1100 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable
, Pcd
.MaxDatumSize
))
1101 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1102 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1103 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1104 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1105 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1107 PcdDataSize
= Pcd
.GetPcdSize()
1108 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1110 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1111 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1112 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1114 PcdDataSize
= Pcd
.GetPcdSize()
1115 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1116 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1118 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1119 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1120 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1121 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1123 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1124 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1125 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
))
1126 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
))
1128 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1129 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
1131 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1133 ## Create code for library module PCDs
1135 # @param Info The ModuleAutoGen object
1136 # @param AutoGenC The TemplateString object for C code
1137 # @param AutoGenH The TemplateString object for header file
1138 # @param Pcd The PCD object
1140 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1141 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1142 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1143 TokenCName
= Pcd
.TokenCName
1144 for PcdItem
in GlobalData
.MixedPcd
:
1145 if (TokenCName
, TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1146 TokenCName
= PcdItem
[0]
1148 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1149 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
1150 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
1151 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
1152 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
1153 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
1155 if Pcd
.PcdValueFromComm
:
1156 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
1157 elif Pcd
.PcdValueFromFdf
:
1158 Pcd
.DefaultValue
= Pcd
.PcdValueFromFdf
1162 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1163 TokenNumber
= int(Pcd
.TokenValue
, 0)
1165 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1166 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1167 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1168 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1169 # report warning message notify the PI that they are attempting to build a module
1170 # that must be included in a flash image in order to be functional. These Dynamic PCD
1171 # will not be added into the Database unless it is used by other modules that are
1172 # included in the FDF file.
1173 # In this case, just assign an invalid token number to make it pass build.
1174 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1177 EdkLogger
.error("build", AUTOGEN_ERROR
,
1178 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1179 ExtraData
="[%s]" % str(Info
))
1181 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1183 if Pcd
.Type
not in gItemTypeStringDatabase
:
1184 EdkLogger
.error("build", AUTOGEN_ERROR
,
1185 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1186 ExtraData
="[%s]" % str(Info
))
1188 DatumType
= Pcd
.DatumType
1189 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
1190 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
1191 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1192 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1193 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
1194 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
1198 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1199 if Pcd
.DefaultValue
[0]== '{':
1202 PcdItemType
= Pcd
.Type
1203 if PcdItemType
in PCD_DYNAMIC_EX_TYPE_SET
:
1204 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + TokenCName
1205 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1208 PcdList
= Info
.LibraryPcdList
1210 PcdList
= Info
.ModulePcdList
1212 for PcdModule
in PcdList
:
1213 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
1215 # get out early once we found > 1...
1216 if PcdExCNameTest
> 1:
1218 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1219 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1220 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1221 if PcdExCNameTest
> 1:
1222 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')
1223 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1224 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1225 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1226 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1227 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1228 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1230 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1231 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1233 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1234 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1235 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1236 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1237 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1238 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1240 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1241 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1243 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1244 if PcdItemType
in PCD_DYNAMIC_TYPE_SET
:
1247 PcdList
.extend(Info
.LibraryPcdList
)
1248 PcdList
.extend(Info
.ModulePcdList
)
1249 for PcdModule
in PcdList
:
1250 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
:
1251 PcdCNameList
.append(PcdModule
.TokenCName
)
1252 if PcdCNameList
.count(Pcd
.TokenCName
) > 1:
1253 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
))
1255 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1256 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
1257 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1258 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1259 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1261 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1262 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1263 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1264 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1265 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1266 if DatumType
== TAB_VOID
and Array
== '[]':
1267 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1269 DatumType
= TAB_UINT8
1270 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1272 AutoGenH
.Append('extern volatile %s %s%s;\n' % (DatumType
, PcdVariableName
, Array
))
1273 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1274 PcdDataSize
= Pcd
.GetPcdSize()
1275 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1276 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1277 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1278 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PatchPcdMaxSizeVariable
))
1279 AutoGenH
.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable
)
1281 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1282 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1283 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1285 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1286 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1288 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1289 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1290 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
1291 if DatumType
== TAB_VOID
and Array
== '[]':
1292 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1293 if DatumType
not in TAB_PCD_NUMERIC_TYPES_VOID
:
1294 DatumType
= TAB_UINT8
1295 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1296 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1297 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1299 ConstFixedPcd
= False
1300 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and (key
in Info
.ConstPcd
or (Info
.IsLibrary
and not Info
.ReferenceModules
)):
1301 ConstFixedPcd
= True
1302 if key
in Info
.ConstPcd
:
1303 Pcd
.DefaultValue
= Info
.ConstPcd
[key
]
1304 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1305 AutoGenH
.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName
, Type
, PcdVariableName
))
1307 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1308 PcdDataSize
= Pcd
.GetPcdSize()
1309 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
:
1310 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1312 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1313 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1315 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixedPcdSizeVariableName
))
1316 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, FixedPcdSizeVariableName
))
1317 AutoGenH
.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName
)
1319 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1320 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1322 ## Create code for library constructor
1324 # @param Info The ModuleAutoGen object
1325 # @param AutoGenC The TemplateString object for C code
1326 # @param AutoGenH The TemplateString object for header file
1328 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1330 # Library Constructors
1332 ConstructorPrototypeString
= TemplateString()
1333 ConstructorCallingString
= TemplateString()
1335 DependentLibraryList
= [Info
.Module
]
1337 DependentLibraryList
= Info
.DependentLibraryList
1338 for Lib
in DependentLibraryList
:
1339 if len(Lib
.ConstructorList
) <= 0:
1341 Dict
= {'Function':Lib
.ConstructorList
}
1342 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1343 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1344 ConstructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1345 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1346 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1347 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1348 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1349 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1350 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1351 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1352 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1353 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1354 ConstructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1356 if str(ConstructorPrototypeString
) == '':
1357 ConstructorPrototypeList
= []
1359 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1360 if str(ConstructorCallingString
) == '':
1361 ConstructorCallingList
= []
1363 ConstructorCallingList
= [str(ConstructorCallingString
)]
1366 'Type' : 'Constructor',
1367 'FunctionPrototype' : ConstructorPrototypeList
,
1368 'FunctionCall' : ConstructorCallingList
1371 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1373 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1374 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1375 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1376 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1377 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1378 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1379 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1380 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1381 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1383 ## Create code for library destructor
1385 # @param Info The ModuleAutoGen object
1386 # @param AutoGenC The TemplateString object for C code
1387 # @param AutoGenH The TemplateString object for header file
1389 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1391 # Library Destructors
1393 DestructorPrototypeString
= TemplateString()
1394 DestructorCallingString
= TemplateString()
1396 DependentLibraryList
= [Info
.Module
]
1398 DependentLibraryList
= Info
.DependentLibraryList
1399 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1400 Lib
= DependentLibraryList
[Index
]
1401 if len(Lib
.DestructorList
) <= 0:
1403 Dict
= {'Function':Lib
.DestructorList
}
1404 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1405 DestructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1406 DestructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1407 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1408 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1409 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1410 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1411 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1412 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1413 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1414 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1415 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1416 DestructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1418 if str(DestructorPrototypeString
) == '':
1419 DestructorPrototypeList
= []
1421 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1422 if str(DestructorCallingString
) == '':
1423 DestructorCallingList
= []
1425 DestructorCallingList
= [str(DestructorCallingString
)]
1428 'Type' : 'Destructor',
1429 'FunctionPrototype' : DestructorPrototypeList
,
1430 'FunctionCall' : DestructorCallingList
1433 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1435 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1436 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1437 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1438 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1439 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1440 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1441 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1442 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1443 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1446 ## Create code for ModuleEntryPoint
1448 # @param Info The ModuleAutoGen object
1449 # @param AutoGenC The TemplateString object for C code
1450 # @param AutoGenH The TemplateString object for header file
1452 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1453 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1456 # Module Entry Points
1458 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1459 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1460 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1462 PiSpecVersion
= '0x00000000'
1463 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1464 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1466 UefiSpecVersion
= '0x00000000'
1468 'Function' : Info
.Module
.ModuleEntryPointList
,
1469 'PiSpecVersion' : PiSpecVersion
+ 'U',
1470 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1473 if Info
.ModuleType
in [SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1474 if Info
.SourceFileList
:
1475 if NumEntryPoints
!= 1:
1479 '%s must have exactly one entry point' % Info
.ModuleType
,
1481 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1483 if Info
.ModuleType
== SUP_MODULE_PEI_CORE
:
1484 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1485 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1486 elif Info
.ModuleType
== SUP_MODULE_DXE_CORE
:
1487 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1488 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1489 elif Info
.ModuleType
== SUP_MODULE_SMM_CORE
:
1490 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1491 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1492 elif Info
.ModuleType
== SUP_MODULE_MM_CORE_STANDALONE
:
1493 AutoGenC
.Append(gMmCoreStandaloneEntryPointString
.Replace(Dict
))
1494 AutoGenH
.Append(gMmCoreStandaloneEntryPointPrototype
.Replace(Dict
))
1495 elif Info
.ModuleType
== SUP_MODULE_PEIM
:
1496 if NumEntryPoints
< 2:
1497 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1499 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1500 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1501 elif Info
.ModuleType
in [SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
1502 if NumEntryPoints
< 2:
1503 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1505 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1506 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1507 elif Info
.ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
1508 if NumEntryPoints
== 0:
1509 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1511 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1512 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1513 elif Info
.ModuleType
== SUP_MODULE_MM_STANDALONE
:
1514 if NumEntryPoints
< 2:
1515 AutoGenC
.Append(gMmStandaloneEntryPointString
[NumEntryPoints
].Replace(Dict
))
1517 AutoGenC
.Append(gMmStandaloneEntryPointString
[2].Replace(Dict
))
1518 AutoGenH
.Append(gMmStandaloneEntryPointPrototype
.Replace(Dict
))
1519 elif Info
.ModuleType
== SUP_MODULE_UEFI_APPLICATION
:
1520 if NumEntryPoints
< 2:
1521 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1523 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1524 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1526 ## Create code for ModuleUnloadImage
1528 # @param Info The ModuleAutoGen object
1529 # @param AutoGenC The TemplateString object for C code
1530 # @param AutoGenH The TemplateString object for header file
1532 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1533 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1536 # Unload Image Handlers
1538 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1539 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1540 if NumUnloadImage
< 2:
1541 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1543 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1544 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1546 ## Create code for GUID
1548 # @param Info The ModuleAutoGen object
1549 # @param AutoGenC The TemplateString object for C code
1550 # @param AutoGenH The TemplateString object for header file
1552 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1553 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1556 GuidType
= "EFI_GUID"
1559 if not Info
.IsLibrary
:
1560 AutoGenC
.Append("\n// Guids\n")
1561 AutoGenH
.Append("\n// Guids\n")
1565 for Key
in Info
.GuidList
:
1566 if not Info
.IsLibrary
:
1567 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1568 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1570 ## Create code for protocol
1572 # @param Info The ModuleAutoGen object
1573 # @param AutoGenC The TemplateString object for C code
1574 # @param AutoGenH The TemplateString object for header file
1576 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1577 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1580 GuidType
= "EFI_GUID"
1582 if Info
.ProtocolList
:
1583 if not Info
.IsLibrary
:
1584 AutoGenC
.Append("\n// Protocols\n")
1585 AutoGenH
.Append("\n// Protocols\n")
1589 for Key
in Info
.ProtocolList
:
1590 if not Info
.IsLibrary
:
1591 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1592 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1594 ## Create code for PPI
1596 # @param Info The ModuleAutoGen object
1597 # @param AutoGenC The TemplateString object for C code
1598 # @param AutoGenH The TemplateString object for header file
1600 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1601 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1604 GuidType
= "EFI_GUID"
1607 if not Info
.IsLibrary
:
1608 AutoGenC
.Append("\n// PPIs\n")
1609 AutoGenH
.Append("\n// PPIs\n")
1613 for Key
in Info
.PpiList
:
1614 if not Info
.IsLibrary
:
1615 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1616 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1618 ## Create code for PCD
1620 # @param Info The ModuleAutoGen object
1621 # @param AutoGenC The TemplateString object for C code
1622 # @param AutoGenH The TemplateString object for header file
1624 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1626 # Collect Token Space GUIDs used by DynamicEc PCDs
1628 for Pcd
in Info
.ModulePcdList
:
1629 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1630 TokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
1632 SkuMgr
= Info
.Workspace
.Platform
.SkuIdMgr
1633 AutoGenH
.Append("\n// Definition of SkuId Array\n")
1634 AutoGenH
.Append("extern UINT64 _gPcd_SkuId_Array[];\n")
1635 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1637 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1638 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1641 GuidType
= "EFI_GUID"
1642 for Item
in TokenSpaceList
:
1643 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1646 if Info
.ModulePcdList
:
1647 AutoGenH
.Append("\n// PCD definitions\n")
1648 for Pcd
in Info
.ModulePcdList
:
1649 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1650 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1652 AutoGenC
.Append("\n// Definition of SkuId Array\n")
1653 AutoGenC
.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr
.DumpSkuIdArrary())
1654 if Info
.ModulePcdList
:
1655 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1656 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1657 for Pcd
in Info
.ModulePcdList
:
1658 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1659 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1660 if Info
.LibraryPcdList
:
1661 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1662 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1663 for Pcd
in Info
.LibraryPcdList
:
1664 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1665 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1667 ## Create code for unicode string definition
1669 # @param Info The ModuleAutoGen object
1670 # @param AutoGenC The TemplateString object for C code
1671 # @param AutoGenH The TemplateString object for header file
1672 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1673 # @param UniGenBinBuffer Buffer to store uni string package data
1675 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1676 WorkingDir
= os
.getcwd()
1677 os
.chdir(Info
.WorkspaceDir
)
1679 IncList
= [Info
.MetaFile
.Dir
]
1680 # Get all files under [Sources] section in inf file for EDK-II module
1682 SrcList
= [F
for F
in Info
.SourceFileList
]
1683 if Info
.AutoGenVersion
< 0x00010005:
1685 # Get all files under the module directory for EDK-I module
1687 os
.chdir(Info
.MetaFile
.Dir
)
1688 for Root
, Dirs
, Files
in os
.walk("."):
1694 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1697 SrcList
.append(File
)
1700 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1701 CompatibleMode
= True
1703 CompatibleMode
= False
1706 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1708 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1710 EdkLogger
.error("build", AUTOGEN_ERROR
,
1711 "-c and -s build options should be used exclusively",
1712 ExtraData
="[%s]" % str(Info
))
1717 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1719 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1721 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1722 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1723 if CompatibleMode
or UniGenCFlag
:
1724 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1725 AutoGenC
.Append(Code
)
1726 AutoGenC
.Append("\n")
1727 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1728 AutoGenH
.Append(Header
)
1729 if CompatibleMode
or UniGenCFlag
:
1730 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1731 os
.chdir(WorkingDir
)
1733 def CreateIdfFileCode(Info
, AutoGenC
, StringH
, IdfGenCFlag
, IdfGenBinBuffer
):
1734 if len(Info
.IdfFileList
) > 0:
1735 ImageFiles
= IdfFileClassObject(sorted (Info
.IdfFileList
))
1736 if ImageFiles
.ImageFilesDict
:
1739 IncList
= [Info
.MetaFile
.Dir
]
1740 SrcList
= [F
for F
in Info
.SourceFileList
]
1741 SkipList
= ['.jpg', '.png', '.bmp', '.inf', '.idf']
1742 FileList
= GetFileList(SrcList
, IncList
, SkipList
)
1744 StringH
.Append("\n//\n//Image ID\n//\n")
1746 PaletteInfoOffset
= 0
1747 ImageBuffer
= pack('x')
1748 PaletteBuffer
= pack('x')
1752 for Idf
in ImageFiles
.ImageFilesDict
:
1753 if ImageFiles
.ImageFilesDict
[Idf
]:
1754 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1755 for sourcefile
in Info
.SourceFileList
:
1756 if FileObj
.FileName
== sourcefile
.File
:
1757 if not sourcefile
.Ext
.upper() in ['.PNG', '.BMP', '.JPG']:
1758 EdkLogger
.error("build", AUTOGEN_ERROR
, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj
.FileName
), ExtraData
="[%s]" % str(Info
))
1759 FileObj
.File
= sourcefile
1762 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
))
1764 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1765 ID
= FileObj
.ImageID
1767 if not os
.path
.exists(File
.Path
) or not os
.path
.isfile(File
.Path
):
1768 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=File
.Path
)
1769 SearchImageID (FileObj
, FileList
)
1770 if FileObj
.Referenced
:
1771 if (ValueStartPtr
- len(DEFINE_STR
+ ID
)) <= 0:
1772 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' + DecToHexStr(Index
, 4) + '\n'
1774 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' * (ValueStartPtr
- len(DEFINE_STR
+ ID
)) + DecToHexStr(Index
, 4) + '\n'
1776 if File
not in FileDict
:
1777 FileDict
[File
] = Index
1779 DuplicateBlock
= pack('B', EFI_HII_IIBT_DUPLICATE
)
1780 DuplicateBlock
+= pack('H', FileDict
[File
])
1781 ImageBuffer
+= DuplicateBlock
1782 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1783 TempBufferList
= AscToHexList(DuplicateBlock
)
1784 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1785 StringH
.Append(Line
)
1789 TmpFile
= open(File
.Path
, 'rb')
1790 Buffer
= TmpFile
.read()
1792 if File
.Ext
.upper() == '.PNG':
1793 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_PNG
)
1794 TempBuffer
+= pack('I', len(Buffer
))
1795 TempBuffer
+= Buffer
1796 elif File
.Ext
.upper() == '.JPG':
1797 ImageType
, = struct
.unpack('4s', Buffer
[6:10])
1798 if ImageType
!= b
'JFIF':
1799 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard JPG file." % File
.Path
)
1800 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_JPEG
)
1801 TempBuffer
+= pack('I', len(Buffer
))
1802 TempBuffer
+= Buffer
1803 elif File
.Ext
.upper() == '.BMP':
1804 TempBuffer
, TempPalette
= BmpImageDecoder(File
, Buffer
, PaletteIndex
, FileObj
.TransParent
)
1805 if len(TempPalette
) > 1:
1807 NewPalette
= pack('H', len(TempPalette
))
1808 NewPalette
+= TempPalette
1809 PaletteBuffer
+= NewPalette
1810 PaletteStr
= WriteLine(PaletteStr
, '// %s: %s: %s' % (DecToHexStr(PaletteIndex
- 1, 4), ID
, DecToHexStr(PaletteIndex
- 1, 4)))
1811 TempPaletteList
= AscToHexList(NewPalette
)
1812 PaletteStr
= WriteLine(PaletteStr
, CreateArrayItem(TempPaletteList
, 16) + '\n')
1813 ImageBuffer
+= TempBuffer
1814 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1815 TempBufferList
= AscToHexList(TempBuffer
)
1816 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1818 StringH
.Append(Line
)
1821 BufferStr
= WriteLine(BufferStr
, '// End of the Image Info')
1822 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END
, 2)) + '\n')
1823 ImageEnd
= pack('B', EFI_HII_IIBT_END
)
1824 ImageBuffer
+= ImageEnd
1826 if len(ImageBuffer
) > 1:
1827 ImageInfoOffset
= 12
1828 if len(PaletteBuffer
) > 1:
1829 PaletteInfoOffset
= 12 + len(ImageBuffer
) - 1 # -1 is for the first empty pad byte of ImageBuffer
1831 IMAGE_PACKAGE_HDR
= pack('=II', ImageInfoOffset
, PaletteInfoOffset
)
1832 # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length
1833 if len(PaletteBuffer
) > 1:
1834 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1 + 2 + len(PaletteBuffer
) - 1
1836 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1
1837 if PaletteIndex
> 1:
1838 PALETTE_INFO_HEADER
= pack('H', PaletteIndex
- 1)
1839 # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF
1840 Hex_Length
= '%06X' % PACKAGE_HEADER_Length
1841 if PACKAGE_HEADER_Length
> 0xFFFFFF:
1842 EdkLogger
.error("build", AUTOGEN_ERROR
, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData
="[%s]" % str(Info
))
1843 PACKAGE_HEADER
= pack('=HBB', int('0x' + Hex_Length
[2:], 16), int('0x' + Hex_Length
[0:2], 16), EFI_HII_PACKAGE_IMAGES
)
1845 IdfGenBinBuffer
.write(PACKAGE_HEADER
)
1846 IdfGenBinBuffer
.write(IMAGE_PACKAGE_HDR
)
1847 if len(ImageBuffer
) > 1 :
1848 IdfGenBinBuffer
.write(ImageBuffer
[1:])
1849 if PaletteIndex
> 1:
1850 IdfGenBinBuffer
.write(PALETTE_INFO_HEADER
)
1851 if len(PaletteBuffer
) > 1:
1852 IdfGenBinBuffer
.write(PaletteBuffer
[1:])
1855 TotalLength
= EFI_HII_ARRAY_SIZE_LENGTH
+ PACKAGE_HEADER_Length
1856 AutoGenC
.Append("\n//\n//Image Pack Definition\n//\n")
1857 AllStr
= WriteLine('', CHAR_ARRAY_DEFIN
+ ' ' + Info
.Module
.BaseName
+ 'Images' + '[] = {\n')
1858 AllStr
= WriteLine(AllStr
, '// STRGATHER_OUTPUT_HEADER')
1859 AllStr
= WriteLine(AllStr
, CreateArrayItem(DecToHexList(TotalLength
)) + '\n')
1860 AllStr
= WriteLine(AllStr
, '// Image PACKAGE HEADER\n')
1861 IMAGE_PACKAGE_HDR_List
= AscToHexList(PACKAGE_HEADER
)
1862 IMAGE_PACKAGE_HDR_List
+= AscToHexList(IMAGE_PACKAGE_HDR
)
1863 AllStr
= WriteLine(AllStr
, CreateArrayItem(IMAGE_PACKAGE_HDR_List
, 16) + '\n')
1864 AllStr
= WriteLine(AllStr
, '// Image DATA\n')
1866 AllStr
= WriteLine(AllStr
, BufferStr
)
1868 AllStr
= WriteLine(AllStr
, '// Palette Header\n')
1869 PALETTE_INFO_HEADER_List
= AscToHexList(PALETTE_INFO_HEADER
)
1870 AllStr
= WriteLine(AllStr
, CreateArrayItem(PALETTE_INFO_HEADER_List
, 16) + '\n')
1871 AllStr
= WriteLine(AllStr
, '// Palette Data\n')
1872 AllStr
= WriteLine(AllStr
, PaletteStr
)
1873 AllStr
= WriteLine(AllStr
, '};')
1874 AutoGenC
.Append(AllStr
)
1875 AutoGenC
.Append("\n")
1876 StringH
.Append('\nextern unsigned char ' + Info
.Module
.BaseName
+ 'Images[];\n')
1877 StringH
.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info
.Module
.BaseName
)
1879 # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {
1880 # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES
1881 # UINT32 ImageInfoOffset;
1882 # UINT32 PaletteInfoOffset;
1883 # } EFI_HII_IMAGE_PACKAGE_HDR;
1889 # } EFI_HII_PACKAGE_HEADER;
1891 # typedef struct _EFI_HII_IMAGE_BLOCK {
1893 # UINT8 BlockBody[];
1894 # } EFI_HII_IMAGE_BLOCK;
1896 def BmpImageDecoder(File
, Buffer
, PaletteIndex
, TransParent
):
1897 ImageType
, = struct
.unpack('2s', Buffer
[0:2])
1898 if ImageType
!= b
'BM': # BMP file type is 'BM'
1899 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard BMP file." % File
.Path
)
1900 BMP_IMAGE_HEADER
= collections
.namedtuple('BMP_IMAGE_HEADER', ['bfSize', 'bfReserved1', 'bfReserved2', 'bfOffBits', 'biSize', 'biWidth', 'biHeight', 'biPlanes', 'biBitCount', 'biCompression', 'biSizeImage', 'biXPelsPerMeter', 'biYPelsPerMeter', 'biClrUsed', 'biClrImportant'])
1901 BMP_IMAGE_HEADER_STRUCT
= struct
.Struct('IHHIIIIHHIIIIII')
1902 BmpHeader
= BMP_IMAGE_HEADER
._make
(BMP_IMAGE_HEADER_STRUCT
.unpack_from(Buffer
[2:]))
1904 # Doesn't support compress.
1906 if BmpHeader
.biCompression
!= 0:
1907 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The compress BMP file %s is not support." % File
.Path
)
1909 # The Width and Height is UINT16 type in Image Package
1910 if BmpHeader
.biWidth
> 0xFFFF:
1911 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Width is exceed 0xFFFF." % File
.Path
)
1912 if BmpHeader
.biHeight
> 0xFFFF:
1913 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Height is exceed 0xFFFF." % File
.Path
)
1915 PaletteBuffer
= pack('x')
1916 if BmpHeader
.biBitCount
== 1:
1918 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS
)
1920 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT
)
1921 ImageBuffer
+= pack('B', PaletteIndex
)
1922 Width
= (BmpHeader
.biWidth
+ 7)/8
1923 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1924 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1925 elif BmpHeader
.biBitCount
== 4:
1927 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS
)
1929 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT
)
1930 ImageBuffer
+= pack('B', PaletteIndex
)
1931 Width
= (BmpHeader
.biWidth
+ 1)/2
1932 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1933 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1934 elif BmpHeader
.biBitCount
== 8:
1936 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS
)
1938 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT
)
1939 ImageBuffer
+= pack('B', PaletteIndex
)
1940 Width
= BmpHeader
.biWidth
1941 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1942 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1943 elif BmpHeader
.biBitCount
== 24:
1945 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS
)
1947 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT
)
1948 Width
= BmpHeader
.biWidth
* 3
1950 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData
="[%s]" % str(File
.Path
))
1952 ImageBuffer
+= pack('H', BmpHeader
.biWidth
)
1953 ImageBuffer
+= pack('H', BmpHeader
.biHeight
)
1954 Start
= BmpHeader
.bfOffBits
1955 End
= BmpHeader
.bfSize
- 1
1956 for Height
in range(0, BmpHeader
.biHeight
):
1958 Start
= End
+ (Width
% 4) - 4 - Width
1961 ImageBuffer
+= Buffer
[Start
+ 1 : Start
+ Width
+ 1]
1964 # 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
1965 if PaletteBuffer
and len(PaletteBuffer
) > 1:
1966 PaletteTemp
= pack('x')
1967 for Index
in range(0, len(PaletteBuffer
)):
1970 PaletteTemp
+= bytes([PaletteBuffer
[Index
]])
1971 PaletteBuffer
= PaletteTemp
[1:]
1972 return ImageBuffer
, PaletteBuffer
1974 ## Create common code
1976 # @param Info The ModuleAutoGen object
1977 # @param AutoGenC The TemplateString object for C code
1978 # @param AutoGenH The TemplateString object for header file
1980 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1982 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1983 # header file Prologue
1984 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-', '_')}))
1985 AutoGenH
.Append(gAutoGenHCppPrologueString
)
1986 if Info
.AutoGenVersion
>= 0x00010005:
1987 # header files includes
1988 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1989 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1991 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
1992 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
1994 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
1995 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
1997 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
1998 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
2003 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
2008 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
2009 if Info
.AutoGenVersion
>= 0x00010005:
2010 # C file header files includes
2011 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2012 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
2013 AutoGenC
.Append("#include <%s>\n" % Inc
)
2015 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
2018 # Publish the CallerId Guid
2020 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
2021 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
2023 ## Create common code for header file
2025 # @param Info The ModuleAutoGen object
2026 # @param AutoGenC The TemplateString object for C code
2027 # @param AutoGenH The TemplateString object for header file
2029 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
2030 AutoGenH
.Append(gAutoGenHEpilogueString
)
2032 ## Create code for a module
2034 # @param Info The ModuleAutoGen object
2035 # @param AutoGenC The TemplateString object for C code
2036 # @param AutoGenH The TemplateString object for header file
2037 # @param StringH The TemplateString object for header file
2038 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
2039 # @param UniGenBinBuffer Buffer to store uni string package data
2040 # @param StringIdf The TemplateString object for header file
2041 # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True
2042 # @param IdfGenBinBuffer Buffer to store Idf string package data
2044 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
):
2045 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
2047 if Info
.AutoGenVersion
>= 0x00010005:
2048 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2049 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2050 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2051 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
2052 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
2053 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
2054 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
2055 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
2057 if Info
.UnicodeFileList
:
2058 FileName
= "%sStrDefs.h" % Info
.Name
2059 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2060 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2061 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
2064 for Guid
in Info
.Module
.Guids
:
2065 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
2067 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
2068 for Guid
, Value
in list(Info
.Module
.Protocols
.items()) + list(Info
.Module
.Ppis
.items()):
2069 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
2070 # supports FixedAtBuild and FeaturePcd usage in VFR file
2071 if Info
.VfrFileList
and Info
.ModulePcdList
:
2072 GuidMacros
.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))
2073 GuidMacros
.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))
2074 GuidMacros
.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))
2075 GuidMacros
.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))
2076 GuidMacros
.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))
2077 GuidMacros
.append('#define %s %s' % ('FeaturePcdGet(TokenName)', '_PCD_VALUE_##TokenName'))
2078 for Pcd
in Info
.ModulePcdList
:
2079 if Pcd
.Type
in [TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_FEATURE_FLAG
]:
2080 TokenCName
= Pcd
.TokenCName
2081 Value
= Pcd
.DefaultValue
2082 if Pcd
.DatumType
== 'BOOLEAN':
2083 BoolValue
= Value
.upper()
2084 if BoolValue
== 'TRUE':
2086 elif BoolValue
== 'FALSE':
2088 for PcdItem
in GlobalData
.MixedPcd
:
2089 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2090 TokenCName
= PcdItem
[0]
2092 GuidMacros
.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName
, Value
))
2094 if Info
.IdfFileList
:
2095 GuidMacros
.append('#include "%sImgDefs.h"' % Info
.Name
)
2098 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
2100 StringH
.Append("\n#endif\n")
2101 AutoGenH
.Append('#include "%s"\n' % FileName
)
2103 if Info
.IdfFileList
:
2104 FileName
= "%sImgDefs.h" % Info
.Name
2105 StringIdf
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2106 StringIdf
.Append(gAutoGenHPrologueString
.Replace({'File':'IMAGEDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2107 CreateIdfFileCode(Info
, AutoGenC
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
)
2109 StringIdf
.Append("\n#endif\n")
2110 AutoGenH
.Append('#include "%s"\n' % FileName
)
2112 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
2114 # no generation of AutoGen.c for Edk modules without unicode file
2115 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
2116 AutoGenC
.String
= ''
2118 ## Create the code file
2120 # @param FilePath The path of code file
2121 # @param Content The content of code file
2122 # @param IsBinaryFile The flag indicating if the file is binary file or not
2124 # @retval True If file content is changed or file doesn't exist
2125 # @retval False If the file exists and the content is not changed
2127 def Generate(FilePath
, Content
, IsBinaryFile
):
2128 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)