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_SMM_SYSTEM_TABLE2 *MmSystemTable
273 gMmStandaloneEntryPointString
= [
275 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
279 ProcessModuleEntryPointList (
280 IN EFI_HANDLE ImageHandle,
281 IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable
289 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};
293 ProcessModuleEntryPointList (
294 IN EFI_HANDLE ImageHandle,
295 IN EFI_SMM_SYSTEM_TABLE2 *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_SMM_SYSTEM_TABLE2 *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_SMM_SYSTEM_TABLE2 *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_SMM_SYSTEM_TABLE2 *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
: ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmDriverStandaloneEntryPoint.h"],
783 SUP_MODULE_MM_CORE_STANDALONE
: ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmCoreStandaloneEntryPoint.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
894 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
895 TokenNumber
= int(Pcd
.TokenValue
, 0)
896 # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
897 # different Guids but same TokenCName
898 PcdExTokenName
= '_PCD_TOKEN_' + Pcd
.TokenSpaceGuidCName
+ '_' + TokenCName
899 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
901 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
902 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
903 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
904 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
905 # report warning message notify the PI that they are attempting to build a module
906 # that must be included in a flash image in order to be functional. These Dynamic PCD
907 # will not be added into the Database unless it is used by other modules that are
908 # included in the FDF file.
909 # In this case, just assign an invalid token number to make it pass build.
910 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
913 EdkLogger
.error("build", AUTOGEN_ERROR
,
914 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
915 ExtraData
="[%s]" % str(Info
))
917 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
918 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
920 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
921 if Pcd
.Type
not in gItemTypeStringDatabase
:
922 EdkLogger
.error("build", AUTOGEN_ERROR
,
923 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
924 ExtraData
="[%s]" % str(Info
))
926 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
927 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
928 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
929 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
930 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
931 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
933 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
935 PcdList
= Info
.LibraryPcdList
937 PcdList
= Info
.ModulePcdList
939 for PcdModule
in PcdList
:
940 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
942 # get out early once we found > 1...
943 if PcdExCNameTest
> 1:
945 # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
946 # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
947 # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
948 if PcdExCNameTest
> 1:
949 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')
950 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
951 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
952 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
953 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
954 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
955 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
957 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
958 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
960 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
961 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
962 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
963 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
964 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
965 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
967 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
968 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
969 elif Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
971 for PcdModule
in Info
.LibraryPcdList
+ Info
.ModulePcdList
:
972 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
974 # get out early once we found > 1...
978 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
))
980 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
981 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
982 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
983 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
984 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
986 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
987 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
989 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
991 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
995 Value
= Pcd
.DefaultValue
999 if Pcd
.DatumType
== 'BOOLEAN':
1000 BoolValue
= Value
.upper()
1001 if BoolValue
== 'TRUE' or BoolValue
== '1':
1003 elif BoolValue
== 'FALSE' or BoolValue
== '0':
1006 if Pcd
.DatumType
in TAB_PCD_CLEAN_NUMERIC_TYPES
:
1008 if Value
.upper().endswith('L'):
1010 ValueNumber
= int (Value
, 0)
1012 EdkLogger
.error("build", AUTOGEN_ERROR
,
1013 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1014 ExtraData
="[%s]" % str(Info
))
1015 if Pcd
.DatumType
== TAB_UINT64
:
1017 EdkLogger
.error("build", AUTOGEN_ERROR
,
1018 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1019 ExtraData
="[%s]" % str(Info
))
1020 elif ValueNumber
>= 0x10000000000000000:
1021 EdkLogger
.error("build", AUTOGEN_ERROR
,
1022 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1023 ExtraData
="[%s]" % str(Info
))
1024 if not Value
.endswith('ULL'):
1026 elif Pcd
.DatumType
== TAB_UINT32
:
1028 EdkLogger
.error("build", AUTOGEN_ERROR
,
1029 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1030 ExtraData
="[%s]" % str(Info
))
1031 elif ValueNumber
>= 0x100000000:
1032 EdkLogger
.error("build", AUTOGEN_ERROR
,
1033 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1034 ExtraData
="[%s]" % str(Info
))
1035 if not Value
.endswith('U'):
1037 elif Pcd
.DatumType
== TAB_UINT16
:
1039 EdkLogger
.error("build", AUTOGEN_ERROR
,
1040 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1041 ExtraData
="[%s]" % str(Info
))
1042 elif ValueNumber
>= 0x10000:
1043 EdkLogger
.error("build", AUTOGEN_ERROR
,
1044 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1045 ExtraData
="[%s]" % str(Info
))
1046 if not Value
.endswith('U'):
1048 elif Pcd
.DatumType
== TAB_UINT8
:
1050 EdkLogger
.error("build", AUTOGEN_ERROR
,
1051 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1052 ExtraData
="[%s]" % str(Info
))
1053 elif ValueNumber
>= 0x100:
1054 EdkLogger
.error("build", AUTOGEN_ERROR
,
1055 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1056 ExtraData
="[%s]" % str(Info
))
1057 if not Value
.endswith('U'):
1059 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1060 if not Pcd
.MaxDatumSize
:
1061 EdkLogger
.error("build", AUTOGEN_ERROR
,
1062 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1063 ExtraData
="[%s]" % str(Info
))
1065 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
1068 ValueSize
= len(Value
.split(','))
1072 Value
= Value
.lstrip('L') #.strip('"')
1073 Value
= eval(Value
) # translate escape character
1074 ValueSize
= len(Value
) + 1
1076 for Index
in range(0, len(Value
)):
1078 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
1080 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
1082 ArraySize
= ArraySize
/ 2
1083 Value
= NewValue
+ '0 }'
1084 if ArraySize
< ValueSize
:
1085 if Pcd
.MaxSizeUserSet
:
1086 EdkLogger
.error("build", AUTOGEN_ERROR
,
1087 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1088 ExtraData
="[%s]" % str(Info
))
1090 ArraySize
= Pcd
.GetPcdSize()
1092 ArraySize
= ArraySize
/ 2
1093 Array
= '[%d]' % ArraySize
1095 # skip casting for fixed at build since it breaks ARM assembly.
1096 # Long term we need PCD macros that work in assembly
1098 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
and Pcd
.DatumType
in TAB_PCD_NUMERIC_TYPES_VOID
:
1099 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1101 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1102 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + TokenCName
1104 PcdValueName
= '_PCD_VALUE_' + TokenCName
1106 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1108 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1110 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1112 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1113 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1115 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1116 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1117 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1119 PcdDataSize
= Pcd
.GetPcdSize()
1120 if Pcd
.Type
== TAB_PCDS_FIXED_AT_BUILD
:
1121 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1122 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1123 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (FixedPcdSizeVariableName
, PcdDataSize
))
1124 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1125 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, Pcd
.MaxDatumSize
))
1126 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1127 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1128 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1129 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED const UINTN %s = %s;\n' % (PatchPcdMaxSizeVariable
, Pcd
.MaxDatumSize
))
1130 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1131 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1132 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1133 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1134 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1136 PcdDataSize
= Pcd
.GetPcdSize()
1137 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1139 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1140 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1141 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName
, PcdDataSize
))
1143 PcdDataSize
= Pcd
.GetPcdSize()
1144 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1145 AutoGenH
.Append('#define %s %s \n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1147 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1148 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1149 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1150 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1152 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1153 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1154 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
))
1155 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
))
1157 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1158 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName
, PcdVariableName
))
1160 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1162 ## Create code for library module PCDs
1164 # @param Info The ModuleAutoGen object
1165 # @param AutoGenC The TemplateString object for C code
1166 # @param AutoGenH The TemplateString object for header file
1167 # @param Pcd The PCD object
1169 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1170 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1171 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1172 TokenCName
= Pcd
.TokenCName
1173 for PcdItem
in GlobalData
.MixedPcd
:
1174 if (TokenCName
, TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
1175 TokenCName
= PcdItem
[0]
1177 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1178 FixPcdSizeTokenName
= '_PCD_SIZE_' + TokenCName
1179 PatchPcdSizeTokenName
= '_PCD_PATCHABLE_' + TokenCName
+'_SIZE'
1180 PatchPcdSizeVariableName
= '_gPcd_BinaryPatch_Size_' + TokenCName
1181 PatchPcdMaxSizeVariable
= '_gPcd_BinaryPatch_MaxSize_' + TokenCName
1182 FixedPcdSizeVariableName
= '_gPcd_FixedAtBuild_Size_' + TokenCName
1184 if Pcd
.PcdValueFromComm
:
1185 Pcd
.DefaultValue
= Pcd
.PcdValueFromComm
1189 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
:
1190 TokenNumber
= int(Pcd
.TokenValue
, 0)
1192 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1193 # If one of the Source built modules listed in the DSC is not listed in FDF modules,
1194 # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
1195 # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
1196 # report warning message notify the PI that they are attempting to build a module
1197 # that must be included in a flash image in order to be functional. These Dynamic PCD
1198 # will not be added into the Database unless it is used by other modules that are
1199 # included in the FDF file.
1200 # In this case, just assign an invalid token number to make it pass build.
1201 if Pcd
.Type
in PCD_DYNAMIC_TYPE_SET
:
1204 EdkLogger
.error("build", AUTOGEN_ERROR
,
1205 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, TokenCName
),
1206 ExtraData
="[%s]" % str(Info
))
1208 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
1210 if Pcd
.Type
not in gItemTypeStringDatabase
:
1211 EdkLogger
.error("build", AUTOGEN_ERROR
,
1212 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, TokenCName
),
1213 ExtraData
="[%s]" % str(Info
))
1215 DatumType
= Pcd
.DatumType
1216 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabase
else gDatumSizeStringDatabase
[TAB_VOID
]
1217 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
] if Pcd
.DatumType
in gDatumSizeStringDatabaseLib
else gDatumSizeStringDatabaseLib
[TAB_VOID
]
1218 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1219 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_' + TokenCName
1220 SetModeStatusName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_S_' + TokenCName
if Pcd
.DatumType
in gDatumSizeStringDatabaseH
else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[TAB_VOID
] + '_S_' + TokenCName
1221 GetModeSizeName
= '_PCD_GET_MODE_SIZE' + '_' + TokenCName
1225 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1226 if Pcd
.DefaultValue
[0]== '{':
1229 PcdItemType
= Pcd
.Type
1230 if PcdItemType
in PCD_DYNAMIC_EX_TYPE_SET
:
1231 PcdExTokenName
= '_PCD_TOKEN_' + TokenSpaceGuidCName
+ '_' + TokenCName
1232 AutoGenH
.Append('\n#define %s %dU\n' % (PcdExTokenName
, TokenNumber
))
1235 PcdList
= Info
.LibraryPcdList
1237 PcdList
= Info
.ModulePcdList
1239 for PcdModule
in PcdList
:
1240 if PcdModule
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenCName
== PcdModule
.TokenCName
:
1242 # get out early once we found > 1...
1243 if PcdExCNameTest
> 1:
1245 # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
1246 # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
1247 # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
1248 if PcdExCNameTest
> 1:
1249 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')
1250 AutoGenH
.Append('// #define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1251 AutoGenH
.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1252 AutoGenH
.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1253 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1254 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1255 AutoGenH
.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1257 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1258 AutoGenH
.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1260 AutoGenH
.Append('#define %s %s\n' % (PcdTokenName
, PcdExTokenName
))
1261 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1262 AutoGenH
.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1263 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1264 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1265 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1267 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1268 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
1270 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1271 if PcdItemType
in PCD_DYNAMIC_TYPE_SET
:
1274 PcdList
.extend(Info
.LibraryPcdList
)
1275 PcdList
.extend(Info
.ModulePcdList
)
1276 for PcdModule
in PcdList
:
1277 if PcdModule
.Type
in PCD_DYNAMIC_TYPE_SET
:
1278 PcdCNameList
.append(PcdModule
.TokenCName
)
1279 if PcdCNameList
.count(Pcd
.TokenCName
) > 1:
1280 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
))
1282 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1283 AutoGenH
.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName
, PcdTokenName
))
1284 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1285 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1286 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1288 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1289 AutoGenH
.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName
, DatumSizeLib
, PcdTokenName
))
1290 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1291 GetModeMaxSizeName
= '_PCD_GET_MODE_MAXSIZE' + '_' + TokenCName
1292 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1293 if DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1294 if DatumType
== TAB_VOID
and Array
== '[]':
1295 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1297 DatumType
= TAB_UINT8
1298 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1300 AutoGenH
.Append('extern volatile %s %s%s;\n' % (DatumType
, PcdVariableName
, Array
))
1301 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1302 PcdDataSize
= Pcd
.GetPcdSize()
1303 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1304 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1305 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName
, TokenCName
, PatchPcdSizeVariableName
, PatchPcdMaxSizeVariable
))
1306 AutoGenH
.Append('#define %s %s\n' % (GetModeMaxSizeName
, PatchPcdMaxSizeVariable
))
1307 AutoGenH
.Append('extern const UINTN %s; \n' % PatchPcdMaxSizeVariable
)
1309 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1310 AutoGenH
.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName
, PcdVariableName
))
1311 AutoGenH
.Append('#define %s %s\n' % (PatchPcdSizeTokenName
, PcdDataSize
))
1313 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, PatchPcdSizeVariableName
))
1314 AutoGenH
.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName
)
1316 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1317 key
= ".".join((Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
))
1318 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + TokenCName
1319 if DatumType
== TAB_VOID
and Array
== '[]':
1320 DatumType
= [TAB_UINT8
, TAB_UINT16
][Pcd
.DefaultValue
[0] == 'L']
1321 if DatumType
not in TAB_PCD_NUMERIC_TYPES_VOID
:
1322 DatumType
= TAB_UINT8
1323 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1324 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1325 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1327 ConstFixedPcd
= False
1328 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
and (key
in Info
.ConstPcd
or (Info
.IsLibrary
and not Info
._ReferenceModules
)):
1329 ConstFixedPcd
= True
1330 if key
in Info
.ConstPcd
:
1331 Pcd
.DefaultValue
= Info
.ConstPcd
[key
]
1332 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1333 AutoGenH
.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName
, Type
, PcdVariableName
))
1335 AutoGenH
.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName
, Pcd
.DefaultValue
))
1336 PcdDataSize
= Pcd
.GetPcdSize()
1337 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
:
1338 if Pcd
.DatumType
not in TAB_PCD_NUMERIC_TYPES
:
1340 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1341 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1343 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixedPcdSizeVariableName
))
1344 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, FixedPcdSizeVariableName
))
1345 AutoGenH
.Append('extern const UINTN %s; \n' % FixedPcdSizeVariableName
)
1347 AutoGenH
.Append('#define %s %s\n' % (FixPcdSizeTokenName
, PcdDataSize
))
1348 AutoGenH
.Append('#define %s %s\n' % (GetModeSizeName
, FixPcdSizeTokenName
))
1350 ## Create code for library constructor
1352 # @param Info The ModuleAutoGen object
1353 # @param AutoGenC The TemplateString object for C code
1354 # @param AutoGenH The TemplateString object for header file
1356 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1358 # Library Constructors
1360 ConstructorPrototypeString
= TemplateString()
1361 ConstructorCallingString
= TemplateString()
1363 DependentLibraryList
= [Info
.Module
]
1365 DependentLibraryList
= Info
.DependentLibraryList
1366 for Lib
in DependentLibraryList
:
1367 if len(Lib
.ConstructorList
) <= 0:
1369 Dict
= {'Function':Lib
.ConstructorList
}
1370 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1371 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1372 ConstructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1373 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1374 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1375 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1376 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1377 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1378 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1379 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1380 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1381 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1382 ConstructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1384 if str(ConstructorPrototypeString
) == '':
1385 ConstructorPrototypeList
= []
1387 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1388 if str(ConstructorCallingString
) == '':
1389 ConstructorCallingList
= []
1391 ConstructorCallingList
= [str(ConstructorCallingString
)]
1394 'Type' : 'Constructor',
1395 'FunctionPrototype' : ConstructorPrototypeList
,
1396 'FunctionCall' : ConstructorCallingList
1399 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1401 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1402 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1403 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1404 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1405 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1406 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1407 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1408 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1409 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1411 ## Create code for library destructor
1413 # @param Info The ModuleAutoGen object
1414 # @param AutoGenC The TemplateString object for C code
1415 # @param AutoGenH The TemplateString object for header file
1417 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1419 # Library Destructors
1421 DestructorPrototypeString
= TemplateString()
1422 DestructorCallingString
= TemplateString()
1424 DependentLibraryList
= [Info
.Module
]
1426 DependentLibraryList
= Info
.DependentLibraryList
1427 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1428 Lib
= DependentLibraryList
[Index
]
1429 if len(Lib
.DestructorList
) <= 0:
1431 Dict
= {'Function':Lib
.DestructorList
}
1432 if Lib
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1433 DestructorPrototypeString
.Append(gLibraryStructorPrototype
[SUP_MODULE_BASE
].Replace(Dict
))
1434 DestructorCallingString
.Append(gLibraryStructorCall
[SUP_MODULE_BASE
].Replace(Dict
))
1435 elif Lib
.ModuleType
in SUP_MODULE_SET_PEI
:
1436 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1437 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1438 elif Lib
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1439 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1440 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1441 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1442 elif Lib
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1443 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['MM'].Replace(Dict
))
1444 DestructorCallingString
.Append(gLibraryStructorCall
['MM'].Replace(Dict
))
1446 if str(DestructorPrototypeString
) == '':
1447 DestructorPrototypeList
= []
1449 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1450 if str(DestructorCallingString
) == '':
1451 DestructorCallingList
= []
1453 DestructorCallingList
= [str(DestructorCallingString
)]
1456 'Type' : 'Destructor',
1457 'FunctionPrototype' : DestructorPrototypeList
,
1458 'FunctionCall' : DestructorCallingList
1461 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1463 if Info
.ModuleType
in [SUP_MODULE_BASE
, SUP_MODULE_SEC
]:
1464 AutoGenC
.Append(gLibraryString
[SUP_MODULE_BASE
].Replace(Dict
))
1465 elif Info
.ModuleType
in SUP_MODULE_SET_PEI
:
1466 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1467 elif Info
.ModuleType
in [SUP_MODULE_DXE_CORE
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SMM_DRIVER
, SUP_MODULE_DXE_RUNTIME_DRIVER
,
1468 SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
, SUP_MODULE_UEFI_APPLICATION
, SUP_MODULE_SMM_CORE
]:
1469 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1470 elif Info
.ModuleType
in [SUP_MODULE_MM_STANDALONE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1471 AutoGenC
.Append(gLibraryString
['MM'].Replace(Dict
))
1474 ## Create code for ModuleEntryPoint
1476 # @param Info The ModuleAutoGen object
1477 # @param AutoGenC The TemplateString object for C code
1478 # @param AutoGenH The TemplateString object for header file
1480 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1481 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1484 # Module Entry Points
1486 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1487 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1488 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1490 PiSpecVersion
= '0x00000000'
1491 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1492 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1494 UefiSpecVersion
= '0x00000000'
1496 'Function' : Info
.Module
.ModuleEntryPointList
,
1497 'PiSpecVersion' : PiSpecVersion
+ 'U',
1498 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1501 if Info
.ModuleType
in [SUP_MODULE_PEI_CORE
, SUP_MODULE_DXE_CORE
, SUP_MODULE_SMM_CORE
, SUP_MODULE_MM_CORE_STANDALONE
]:
1502 if Info
.SourceFileList
:
1503 if NumEntryPoints
!= 1:
1507 '%s must have exactly one entry point' % Info
.ModuleType
,
1509 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1511 if Info
.ModuleType
== SUP_MODULE_PEI_CORE
:
1512 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1513 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1514 elif Info
.ModuleType
== SUP_MODULE_DXE_CORE
:
1515 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1516 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1517 elif Info
.ModuleType
== SUP_MODULE_SMM_CORE
:
1518 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1519 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1520 elif Info
.ModuleType
== SUP_MODULE_MM_CORE_STANDALONE
:
1521 AutoGenC
.Append(gMmCoreStandaloneEntryPointString
.Replace(Dict
))
1522 AutoGenH
.Append(gMmCoreStandaloneEntryPointPrototype
.Replace(Dict
))
1523 elif Info
.ModuleType
== SUP_MODULE_PEIM
:
1524 if NumEntryPoints
< 2:
1525 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1527 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1528 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1529 elif Info
.ModuleType
in [SUP_MODULE_DXE_RUNTIME_DRIVER
, SUP_MODULE_DXE_DRIVER
, SUP_MODULE_DXE_SAL_DRIVER
, SUP_MODULE_UEFI_DRIVER
]:
1530 if NumEntryPoints
< 2:
1531 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1533 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1534 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1535 elif Info
.ModuleType
== SUP_MODULE_DXE_SMM_DRIVER
:
1536 if NumEntryPoints
== 0:
1537 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1539 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1540 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1541 elif Info
.ModuleType
== SUP_MODULE_MM_STANDALONE
:
1542 if NumEntryPoints
< 2:
1543 AutoGenC
.Append(gMmStandaloneEntryPointString
[NumEntryPoints
].Replace(Dict
))
1545 AutoGenC
.Append(gMmStandaloneEntryPointString
[2].Replace(Dict
))
1546 AutoGenH
.Append(gMmStandaloneEntryPointPrototype
.Replace(Dict
))
1547 elif Info
.ModuleType
== SUP_MODULE_UEFI_APPLICATION
:
1548 if NumEntryPoints
< 2:
1549 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1551 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1552 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1554 ## Create code for ModuleUnloadImage
1556 # @param Info The ModuleAutoGen object
1557 # @param AutoGenC The TemplateString object for C code
1558 # @param AutoGenH The TemplateString object for header file
1560 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1561 if Info
.IsLibrary
or Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_SEC
]:
1564 # Unload Image Handlers
1566 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1567 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1568 if NumUnloadImage
< 2:
1569 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1571 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1572 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1574 ## Create code for GUID
1576 # @param Info The ModuleAutoGen object
1577 # @param AutoGenC The TemplateString object for C code
1578 # @param AutoGenH The TemplateString object for header file
1580 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1581 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1584 GuidType
= "EFI_GUID"
1587 if not Info
.IsLibrary
:
1588 AutoGenC
.Append("\n// Guids\n")
1589 AutoGenH
.Append("\n// Guids\n")
1593 for Key
in Info
.GuidList
:
1594 if not Info
.IsLibrary
:
1595 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1596 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1598 ## Create code for protocol
1600 # @param Info The ModuleAutoGen object
1601 # @param AutoGenC The TemplateString object for C code
1602 # @param AutoGenH The TemplateString object for header file
1604 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1605 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1608 GuidType
= "EFI_GUID"
1610 if Info
.ProtocolList
:
1611 if not Info
.IsLibrary
:
1612 AutoGenC
.Append("\n// Protocols\n")
1613 AutoGenH
.Append("\n// Protocols\n")
1617 for Key
in Info
.ProtocolList
:
1618 if not Info
.IsLibrary
:
1619 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1620 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1622 ## Create code for PPI
1624 # @param Info The ModuleAutoGen object
1625 # @param AutoGenC The TemplateString object for C code
1626 # @param AutoGenH The TemplateString object for header file
1628 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1629 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1632 GuidType
= "EFI_GUID"
1635 if not Info
.IsLibrary
:
1636 AutoGenC
.Append("\n// PPIs\n")
1637 AutoGenH
.Append("\n// PPIs\n")
1641 for Key
in Info
.PpiList
:
1642 if not Info
.IsLibrary
:
1643 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1644 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Key
))
1646 ## Create code for PCD
1648 # @param Info The ModuleAutoGen object
1649 # @param AutoGenC The TemplateString object for C code
1650 # @param AutoGenH The TemplateString object for header file
1652 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1654 # Collect Token Space GUIDs used by DynamicEc PCDs
1656 for Pcd
in Info
.ModulePcdList
:
1657 if Pcd
.Type
in PCD_DYNAMIC_EX_TYPE_SET
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1658 TokenSpaceList
.append(Pcd
.TokenSpaceGuidCName
)
1660 SkuMgr
= Info
.Workspace
.Platform
.SkuIdMgr
1661 AutoGenH
.Append("\n// Definition of SkuId Array\n")
1662 AutoGenH
.Append("extern UINT64 _gPcd_SkuId_Array[];\n")
1663 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1665 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1666 if Info
.ModuleType
in [SUP_MODULE_USER_DEFINED
, SUP_MODULE_BASE
]:
1669 GuidType
= "EFI_GUID"
1670 for Item
in TokenSpaceList
:
1671 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1674 if Info
.ModulePcdList
:
1675 AutoGenH
.Append("\n// PCD definitions\n")
1676 for Pcd
in Info
.ModulePcdList
:
1677 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1678 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1680 AutoGenC
.Append("\n// Definition of SkuId Array\n")
1681 AutoGenC
.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr
.DumpSkuIdArrary())
1682 if Info
.ModulePcdList
:
1683 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1684 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1685 for Pcd
in Info
.ModulePcdList
:
1686 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1687 DynExPcdTokenNumberMapping (Info
, AutoGenH
)
1688 if Info
.LibraryPcdList
:
1689 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1690 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1691 for Pcd
in Info
.LibraryPcdList
:
1692 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1693 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1695 ## Create code for unicode string definition
1697 # @param Info The ModuleAutoGen object
1698 # @param AutoGenC The TemplateString object for C code
1699 # @param AutoGenH The TemplateString object for header file
1700 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1701 # @param UniGenBinBuffer Buffer to store uni string package data
1703 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1704 WorkingDir
= os
.getcwd()
1705 os
.chdir(Info
.WorkspaceDir
)
1707 IncList
= [Info
.MetaFile
.Dir
]
1708 # Get all files under [Sources] section in inf file for EDK-II module
1710 SrcList
= [F
for F
in Info
.SourceFileList
]
1711 if Info
.AutoGenVersion
< 0x00010005:
1713 # Get all files under the module directory for EDK-I module
1715 os
.chdir(Info
.MetaFile
.Dir
)
1716 for Root
, Dirs
, Files
in os
.walk("."):
1722 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1725 SrcList
.append(File
)
1728 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1729 CompatibleMode
= True
1731 CompatibleMode
= False
1734 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1736 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1738 EdkLogger
.error("build", AUTOGEN_ERROR
,
1739 "-c and -s build options should be used exclusively",
1740 ExtraData
="[%s]" % str(Info
))
1745 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
1747 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
1749 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
1750 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
1751 if CompatibleMode
or UniGenCFlag
:
1752 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1753 AutoGenC
.Append(Code
)
1754 AutoGenC
.Append("\n")
1755 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1756 AutoGenH
.Append(Header
)
1757 if CompatibleMode
or UniGenCFlag
:
1758 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1759 os
.chdir(WorkingDir
)
1761 def CreateIdfFileCode(Info
, AutoGenC
, StringH
, IdfGenCFlag
, IdfGenBinBuffer
):
1762 if len(Info
.IdfFileList
) > 0:
1763 ImageFiles
= IdfFileClassObject(sorted (Info
.IdfFileList
))
1764 if ImageFiles
.ImageFilesDict
:
1767 IncList
= [Info
.MetaFile
.Dir
]
1768 SrcList
= [F
for F
in Info
.SourceFileList
]
1769 SkipList
= ['.jpg', '.png', '.bmp', '.inf', '.idf']
1770 FileList
= GetFileList(SrcList
, IncList
, SkipList
)
1772 StringH
.Append("\n//\n//Image ID\n//\n")
1774 PaletteInfoOffset
= 0
1775 ImageBuffer
= pack('x')
1776 PaletteBuffer
= pack('x')
1780 for Idf
in ImageFiles
.ImageFilesDict
:
1781 if ImageFiles
.ImageFilesDict
[Idf
]:
1782 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1783 for sourcefile
in Info
.SourceFileList
:
1784 if FileObj
.FileName
== sourcefile
.File
:
1785 if not sourcefile
.Ext
.upper() in ['.PNG', '.BMP', '.JPG']:
1786 EdkLogger
.error("build", AUTOGEN_ERROR
, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj
.FileName
), ExtraData
="[%s]" % str(Info
))
1787 FileObj
.File
= sourcefile
1790 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
))
1792 for FileObj
in ImageFiles
.ImageFilesDict
[Idf
]:
1793 ID
= FileObj
.ImageID
1795 if not os
.path
.exists(File
.Path
) or not os
.path
.isfile(File
.Path
):
1796 EdkLogger
.error("build", FILE_NOT_FOUND
, ExtraData
=File
.Path
)
1797 SearchImageID (FileObj
, FileList
)
1798 if FileObj
.Referenced
:
1799 if (ValueStartPtr
- len(DEFINE_STR
+ ID
)) <= 0:
1800 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' + DecToHexStr(Index
, 4) + '\n'
1802 Line
= DEFINE_STR
+ ' ' + ID
+ ' ' * (ValueStartPtr
- len(DEFINE_STR
+ ID
)) + DecToHexStr(Index
, 4) + '\n'
1804 if File
not in FileDict
:
1805 FileDict
[File
] = Index
1807 DuplicateBlock
= pack('B', EFI_HII_IIBT_DUPLICATE
)
1808 DuplicateBlock
+= pack('H', FileDict
[File
])
1809 ImageBuffer
+= DuplicateBlock
1810 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1811 TempBufferList
= AscToHexList(DuplicateBlock
)
1812 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1813 StringH
.Append(Line
)
1817 TmpFile
= open(File
.Path
, 'rb')
1818 Buffer
= TmpFile
.read()
1820 if File
.Ext
.upper() == '.PNG':
1821 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_PNG
)
1822 TempBuffer
+= pack('I', len(Buffer
))
1823 TempBuffer
+= Buffer
1824 elif File
.Ext
.upper() == '.JPG':
1825 ImageType
, = struct
.unpack('4s', Buffer
[6:10])
1826 if ImageType
!= 'JFIF':
1827 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard JPG file." % File
.Path
)
1828 TempBuffer
= pack('B', EFI_HII_IIBT_IMAGE_JPEG
)
1829 TempBuffer
+= pack('I', len(Buffer
))
1830 TempBuffer
+= Buffer
1831 elif File
.Ext
.upper() == '.BMP':
1832 TempBuffer
, TempPalette
= BmpImageDecoder(File
, Buffer
, PaletteIndex
, FileObj
.TransParent
)
1833 if len(TempPalette
) > 1:
1835 NewPalette
= pack('H', len(TempPalette
))
1836 NewPalette
+= TempPalette
1837 PaletteBuffer
+= NewPalette
1838 PaletteStr
= WriteLine(PaletteStr
, '// %s: %s: %s' % (DecToHexStr(PaletteIndex
- 1, 4), ID
, DecToHexStr(PaletteIndex
- 1, 4)))
1839 TempPaletteList
= AscToHexList(NewPalette
)
1840 PaletteStr
= WriteLine(PaletteStr
, CreateArrayItem(TempPaletteList
, 16) + '\n')
1841 ImageBuffer
+= TempBuffer
1842 BufferStr
= WriteLine(BufferStr
, '// %s: %s: %s' % (DecToHexStr(Index
, 4), ID
, DecToHexStr(Index
, 4)))
1843 TempBufferList
= AscToHexList(TempBuffer
)
1844 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(TempBufferList
, 16) + '\n')
1846 StringH
.Append(Line
)
1849 BufferStr
= WriteLine(BufferStr
, '// End of the Image Info')
1850 BufferStr
= WriteLine(BufferStr
, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END
, 2)) + '\n')
1851 ImageEnd
= pack('B', EFI_HII_IIBT_END
)
1852 ImageBuffer
+= ImageEnd
1854 if len(ImageBuffer
) > 1:
1855 ImageInfoOffset
= 12
1856 if len(PaletteBuffer
) > 1:
1857 PaletteInfoOffset
= 12 + len(ImageBuffer
) - 1 # -1 is for the first empty pad byte of ImageBuffer
1859 IMAGE_PACKAGE_HDR
= pack('=II', ImageInfoOffset
, PaletteInfoOffset
)
1860 # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length
1861 if len(PaletteBuffer
) > 1:
1862 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1 + 2 + len(PaletteBuffer
) - 1
1864 PACKAGE_HEADER_Length
= 4 + 4 + 4 + len(ImageBuffer
) - 1
1865 if PaletteIndex
> 1:
1866 PALETTE_INFO_HEADER
= pack('H', PaletteIndex
- 1)
1867 # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF
1868 Hex_Length
= '%06X' % PACKAGE_HEADER_Length
1869 if PACKAGE_HEADER_Length
> 0xFFFFFF:
1870 EdkLogger
.error("build", AUTOGEN_ERROR
, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData
="[%s]" % str(Info
))
1871 PACKAGE_HEADER
= pack('=HBB', int('0x' + Hex_Length
[2:], 16), int('0x' + Hex_Length
[0:2], 16), EFI_HII_PACKAGE_IMAGES
)
1873 IdfGenBinBuffer
.write(PACKAGE_HEADER
)
1874 IdfGenBinBuffer
.write(IMAGE_PACKAGE_HDR
)
1875 if len(ImageBuffer
) > 1 :
1876 IdfGenBinBuffer
.write(ImageBuffer
[1:])
1877 if PaletteIndex
> 1:
1878 IdfGenBinBuffer
.write(PALETTE_INFO_HEADER
)
1879 if len(PaletteBuffer
) > 1:
1880 IdfGenBinBuffer
.write(PaletteBuffer
[1:])
1883 TotalLength
= EFI_HII_ARRAY_SIZE_LENGTH
+ PACKAGE_HEADER_Length
1884 AutoGenC
.Append("\n//\n//Image Pack Definition\n//\n")
1885 AllStr
= WriteLine('', CHAR_ARRAY_DEFIN
+ ' ' + Info
.Module
.BaseName
+ 'Images' + '[] = {\n')
1886 AllStr
= WriteLine(AllStr
, '// STRGATHER_OUTPUT_HEADER')
1887 AllStr
= WriteLine(AllStr
, CreateArrayItem(DecToHexList(TotalLength
)) + '\n')
1888 AllStr
= WriteLine(AllStr
, '// Image PACKAGE HEADER\n')
1889 IMAGE_PACKAGE_HDR_List
= AscToHexList(PACKAGE_HEADER
)
1890 IMAGE_PACKAGE_HDR_List
+= AscToHexList(IMAGE_PACKAGE_HDR
)
1891 AllStr
= WriteLine(AllStr
, CreateArrayItem(IMAGE_PACKAGE_HDR_List
, 16) + '\n')
1892 AllStr
= WriteLine(AllStr
, '// Image DATA\n')
1894 AllStr
= WriteLine(AllStr
, BufferStr
)
1896 AllStr
= WriteLine(AllStr
, '// Palette Header\n')
1897 PALETTE_INFO_HEADER_List
= AscToHexList(PALETTE_INFO_HEADER
)
1898 AllStr
= WriteLine(AllStr
, CreateArrayItem(PALETTE_INFO_HEADER_List
, 16) + '\n')
1899 AllStr
= WriteLine(AllStr
, '// Palette Data\n')
1900 AllStr
= WriteLine(AllStr
, PaletteStr
)
1901 AllStr
= WriteLine(AllStr
, '};')
1902 AutoGenC
.Append(AllStr
)
1903 AutoGenC
.Append("\n")
1904 StringH
.Append('\nextern unsigned char ' + Info
.Module
.BaseName
+ 'Images[];\n')
1905 StringH
.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info
.Module
.BaseName
)
1907 # typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {
1908 # EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES
1909 # UINT32 ImageInfoOffset;
1910 # UINT32 PaletteInfoOffset;
1911 # } EFI_HII_IMAGE_PACKAGE_HDR;
1917 # } EFI_HII_PACKAGE_HEADER;
1919 # typedef struct _EFI_HII_IMAGE_BLOCK {
1921 # UINT8 BlockBody[];
1922 # } EFI_HII_IMAGE_BLOCK;
1924 def BmpImageDecoder(File
, Buffer
, PaletteIndex
, TransParent
):
1925 ImageType
, = struct
.unpack('2s', Buffer
[0:2])
1926 if ImageType
!= 'BM': # BMP file type is 'BM'
1927 EdkLogger
.error("build", FILE_TYPE_MISMATCH
, "The file %s is not a standard BMP file." % File
.Path
)
1928 BMP_IMAGE_HEADER
= collections
.namedtuple('BMP_IMAGE_HEADER', ['bfSize', 'bfReserved1', 'bfReserved2', 'bfOffBits', 'biSize', 'biWidth', 'biHeight', 'biPlanes', 'biBitCount', 'biCompression', 'biSizeImage', 'biXPelsPerMeter', 'biYPelsPerMeter', 'biClrUsed', 'biClrImportant'])
1929 BMP_IMAGE_HEADER_STRUCT
= struct
.Struct('IHHIIIIHHIIIIII')
1930 BmpHeader
= BMP_IMAGE_HEADER
._make
(BMP_IMAGE_HEADER_STRUCT
.unpack_from(Buffer
[2:]))
1932 # Doesn't support compress.
1934 if BmpHeader
.biCompression
!= 0:
1935 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The compress BMP file %s is not support." % File
.Path
)
1937 # The Width and Height is UINT16 type in Image Package
1938 if BmpHeader
.biWidth
> 0xFFFF:
1939 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Width is exceed 0xFFFF." % File
.Path
)
1940 if BmpHeader
.biHeight
> 0xFFFF:
1941 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "The BMP file %s Height is exceed 0xFFFF." % File
.Path
)
1943 PaletteBuffer
= pack('x')
1944 if BmpHeader
.biBitCount
== 1:
1946 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS
)
1948 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_1BIT
)
1949 ImageBuffer
+= pack('B', PaletteIndex
)
1950 Width
= (BmpHeader
.biWidth
+ 7)/8
1951 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1952 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1953 elif BmpHeader
.biBitCount
== 4:
1955 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS
)
1957 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_4BIT
)
1958 ImageBuffer
+= pack('B', PaletteIndex
)
1959 Width
= (BmpHeader
.biWidth
+ 1)/2
1960 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1961 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1962 elif BmpHeader
.biBitCount
== 8:
1964 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS
)
1966 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_8BIT
)
1967 ImageBuffer
+= pack('B', PaletteIndex
)
1968 Width
= BmpHeader
.biWidth
1969 if BmpHeader
.bfOffBits
> BMP_IMAGE_HEADER_STRUCT
.size
+ 2:
1970 PaletteBuffer
= Buffer
[BMP_IMAGE_HEADER_STRUCT
.size
+ 2 : BmpHeader
.bfOffBits
]
1971 elif BmpHeader
.biBitCount
== 24:
1973 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS
)
1975 ImageBuffer
= pack('B', EFI_HII_IIBT_IMAGE_24BIT
)
1976 Width
= BmpHeader
.biWidth
* 3
1978 EdkLogger
.error("build", FORMAT_NOT_SUPPORTED
, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData
="[%s]" % str(File
.Path
))
1980 ImageBuffer
+= pack('H', BmpHeader
.biWidth
)
1981 ImageBuffer
+= pack('H', BmpHeader
.biHeight
)
1982 Start
= BmpHeader
.bfOffBits
1983 End
= BmpHeader
.bfSize
- 1
1984 for Height
in range(0, BmpHeader
.biHeight
):
1986 Start
= End
+ (Width
% 4) - 4 - Width
1989 ImageBuffer
+= Buffer
[Start
+ 1 : Start
+ Width
+ 1]
1992 # 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
1993 if PaletteBuffer
and len(PaletteBuffer
) > 1:
1994 PaletteTemp
= pack('x')
1995 for Index
in range(0, len(PaletteBuffer
)):
1998 PaletteTemp
+= PaletteBuffer
[Index
]
1999 PaletteBuffer
= PaletteTemp
[1:]
2000 return ImageBuffer
, PaletteBuffer
2002 ## Create common code
2004 # @param Info The ModuleAutoGen object
2005 # @param AutoGenC The TemplateString object for C code
2006 # @param AutoGenH The TemplateString object for header file
2008 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
2010 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
2011 # header file Prologue
2012 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-', '_')}))
2013 AutoGenH
.Append(gAutoGenHCppPrologueString
)
2014 if Info
.AutoGenVersion
>= 0x00010005:
2015 # header files includes
2016 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2017 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
2019 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
2020 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
2022 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
2023 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
2025 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;')
2026 AutoGenH
.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')
2031 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
2036 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
2037 if Info
.AutoGenVersion
>= 0x00010005:
2038 # C file header files includes
2039 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2040 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
2041 AutoGenC
.Append("#include <%s>\n" % Inc
)
2043 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
2046 # Publish the CallerId Guid
2048 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
2049 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info
.Name
)
2051 ## Create common code for header file
2053 # @param Info The ModuleAutoGen object
2054 # @param AutoGenC The TemplateString object for C code
2055 # @param AutoGenH The TemplateString object for header file
2057 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
2058 AutoGenH
.Append(gAutoGenHEpilogueString
)
2060 ## Create code for a module
2062 # @param Info The ModuleAutoGen object
2063 # @param AutoGenC The TemplateString object for C code
2064 # @param AutoGenH The TemplateString object for header file
2065 # @param StringH The TemplateString object for header file
2066 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
2067 # @param UniGenBinBuffer Buffer to store uni string package data
2068 # @param StringIdf The TemplateString object for header file
2069 # @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True
2070 # @param IdfGenBinBuffer Buffer to store Idf string package data
2072 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
):
2073 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
2075 if Info
.AutoGenVersion
>= 0x00010005:
2076 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2077 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2078 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2079 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
2080 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
2081 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
2082 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
2083 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
2085 if Info
.UnicodeFileList
:
2086 FileName
= "%sStrDefs.h" % Info
.Name
2087 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2088 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2089 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
2092 for Guid
in Info
.Module
.Guids
:
2093 if Guid
in Info
.Module
.GetGuidsUsedByPcd():
2095 GuidMacros
.append('#define %s %s' % (Guid
, Info
.Module
.Guids
[Guid
]))
2096 for Guid
, Value
in Info
.Module
.Protocols
.items() + Info
.Module
.Ppis
.items():
2097 GuidMacros
.append('#define %s %s' % (Guid
, Value
))
2098 # supports FixedAtBuild and FeaturePcd usage in VFR file
2099 if Info
.VfrFileList
and Info
.ModulePcdList
:
2100 GuidMacros
.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))
2101 GuidMacros
.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))
2102 GuidMacros
.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))
2103 GuidMacros
.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))
2104 GuidMacros
.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))
2105 GuidMacros
.append('#define %s %s' % ('FeaturePcdGet(TokenName)', '_PCD_VALUE_##TokenName'))
2106 for Pcd
in Info
.ModulePcdList
:
2107 if Pcd
.Type
in [TAB_PCDS_FIXED_AT_BUILD
, TAB_PCDS_FEATURE_FLAG
]:
2108 TokenCName
= Pcd
.TokenCName
2109 Value
= Pcd
.DefaultValue
2110 if Pcd
.DatumType
== 'BOOLEAN':
2111 BoolValue
= Value
.upper()
2112 if BoolValue
== 'TRUE':
2114 elif BoolValue
== 'FALSE':
2116 for PcdItem
in GlobalData
.MixedPcd
:
2117 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) in GlobalData
.MixedPcd
[PcdItem
]:
2118 TokenCName
= PcdItem
[0]
2120 GuidMacros
.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName
, Value
))
2122 if Info
.IdfFileList
:
2123 GuidMacros
.append('#include "%sImgDefs.h"' % Info
.Name
)
2126 StringH
.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros
))
2128 StringH
.Append("\n#endif\n")
2129 AutoGenH
.Append('#include "%s"\n' % FileName
)
2131 if Info
.IdfFileList
:
2132 FileName
= "%sImgDefs.h" % Info
.Name
2133 StringIdf
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2134 StringIdf
.Append(gAutoGenHPrologueString
.Replace({'File':'IMAGEDEFS', 'Guid':Info
.Guid
.replace('-', '_')}))
2135 CreateIdfFileCode(Info
, AutoGenC
, StringIdf
, IdfGenCFlag
, IdfGenBinBuffer
)
2137 StringIdf
.Append("\n#endif\n")
2138 AutoGenH
.Append('#include "%s"\n' % FileName
)
2140 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
2142 # no generation of AutoGen.c for Edk modules without unicode file
2143 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
2144 AutoGenC
.String
= ''
2146 ## Create the code file
2148 # @param FilePath The path of code file
2149 # @param Content The content of code file
2150 # @param IsBinaryFile The flag indicating if the file is binary file or not
2152 # @retval True If file content is changed or file doesn't exist
2153 # @retval False If the file exists and the content is not changed
2155 def Generate(FilePath
, Content
, IsBinaryFile
):
2156 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)