2 # Routines for generating AutoGen.h and AutoGen.c
4 # Copyright (c) 2007, Intel Corporation
5 # All rights reserved. This program and the accompanying materials
6 # are licensed and made available under the terms and conditions of the BSD License
7 # which accompanies this distribution. The full text of the license may be found at
8 # http://opensource.org/licenses/bsd-license.php
10 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 from Common
import EdkLogger
20 from Common
.BuildToolError
import *
21 from Common
.DataType
import *
22 from Common
.Misc
import *
23 from Common
.String
import StringToArray
24 from StrGather
import *
27 gItemTypeStringDatabase
= {
28 TAB_PCDS_FEATURE_FLAG
: 'FixedAtBuild',
29 TAB_PCDS_FIXED_AT_BUILD
: 'FixedAtBuild',
30 TAB_PCDS_PATCHABLE_IN_MODULE
: 'BinaryPatch',
31 TAB_PCDS_DYNAMIC
: '',
32 TAB_PCDS_DYNAMIC_DEFAULT
: '',
33 TAB_PCDS_DYNAMIC_VPD
: '',
34 TAB_PCDS_DYNAMIC_HII
: '',
35 TAB_PCDS_DYNAMIC_EX
: '',
36 TAB_PCDS_DYNAMIC_EX_DEFAULT
: '',
37 TAB_PCDS_DYNAMIC_EX_VPD
: '',
38 TAB_PCDS_DYNAMIC_EX_HII
: '',
42 gDynamicPcd
= [TAB_PCDS_DYNAMIC
, TAB_PCDS_DYNAMIC_DEFAULT
, TAB_PCDS_DYNAMIC_VPD
, TAB_PCDS_DYNAMIC_HII
]
44 ## Dynamic-ex PCD types
45 gDynamicExPcd
= [TAB_PCDS_DYNAMIC_EX
, TAB_PCDS_DYNAMIC_EX_DEFAULT
, TAB_PCDS_DYNAMIC_EX_VPD
, TAB_PCDS_DYNAMIC_EX_HII
]
48 gDatumSizeStringDatabase
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOLEAN','VOID*':'8'}
49 gDatumSizeStringDatabaseH
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOL','VOID*':'PTR'}
50 gDatumSizeStringDatabaseLib
= {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'Bool','VOID*':'Ptr'}
52 ## Mapping between PCD driver type and EFI phase
54 "PEI_PCD_DRIVER" : "PEI",
55 "DXE_PCD_DRIVER" : "DXE"
58 gPcdDatabaseCommonAutoGenH
= """
60 // The following definition will be generated by build tool
68 #define PCD_TYPE_SHIFT 28
70 #define PCD_TYPE_DATA (0x0 << PCD_TYPE_SHIFT)
71 #define PCD_TYPE_HII (0x8 << PCD_TYPE_SHIFT)
72 #define PCD_TYPE_VPD (0x4 << PCD_TYPE_SHIFT)
73 #define PCD_TYPE_SKU_ENABLED (0x2 << PCD_TYPE_SHIFT)
74 #define PCD_TYPE_STRING (0x1 << PCD_TYPE_SHIFT)
76 #define PCD_TYPE_ALL_SET (PCD_TYPE_DATA | PCD_TYPE_HII | PCD_TYPE_VPD | PCD_TYPE_SKU_ENABLED | PCD_TYPE_STRING)
78 #define PCD_DATUM_TYPE_SHIFT 24
80 #define PCD_DATUM_TYPE_POINTER (0x0 << PCD_DATUM_TYPE_SHIFT)
81 #define PCD_DATUM_TYPE_UINT8 (0x1 << PCD_DATUM_TYPE_SHIFT)
82 #define PCD_DATUM_TYPE_UINT16 (0x2 << PCD_DATUM_TYPE_SHIFT)
83 #define PCD_DATUM_TYPE_UINT32 (0x4 << PCD_DATUM_TYPE_SHIFT)
84 #define PCD_DATUM_TYPE_UINT64 (0x8 << PCD_DATUM_TYPE_SHIFT)
86 #define PCD_DATUM_TYPE_ALL_SET (PCD_DATUM_TYPE_POINTER | \\
87 PCD_DATUM_TYPE_UINT8 | \\
88 PCD_DATUM_TYPE_UINT16 | \\
89 PCD_DATUM_TYPE_UINT32 | \\
90 PCD_DATUM_TYPE_UINT64)
92 #define PCD_DATABASE_OFFSET_MASK (~(PCD_TYPE_ALL_SET | PCD_DATUM_TYPE_ALL_SET))
96 UINT16 LocalTokenNumber; // PCD Number of this particular platform build
97 UINT16 ExGuidIndex; // Index of GuidTable
101 UINT32 SkuDataStartOffset; //We have to use offsetof MACRO as we don't know padding done by compiler
102 UINT32 SkuIdTableOffset; //Offset from the PCD_DB
106 UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID.
107 UINT16 StringIndex; // Offset in String Table in units of UINT16.
108 UINT16 Offset; // Offset in Variable
109 UINT16 DefaultValueOffset; // Offset of the Default Value
116 typedef UINT16 STRING_HEAD;
118 typedef UINT16 SIZE_INFO;
120 #define offsetof(s,m) (UINT32) (UINTN) &(((s *)0)->m)
124 gPcdDatabaseEpilogueAutoGenH
= """
126 PEI_PCD_DATABASE PeiDb;
127 DXE_PCD_DATABASE DxeDb;
130 #define PCD_TOTAL_TOKEN_NUMBER (PEI_LOCAL_TOKEN_NUMBER + DXE_LOCAL_TOKEN_NUMBER)
134 gPcdDatabaseAutoGenH
= TemplateString("""
135 #define ${PHASE}_GUID_TABLE_SIZE ${GUID_TABLE_SIZE}
136 #define ${PHASE}_STRING_TABLE_SIZE ${STRING_TABLE_SIZE}
137 #define ${PHASE}_SKUID_TABLE_SIZE ${SKUID_TABLE_SIZE}
138 #define ${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE ${LOCAL_TOKEN_NUMBER_TABLE_SIZE}
139 #define ${PHASE}_LOCAL_TOKEN_NUMBER ${LOCAL_TOKEN_NUMBER}
140 #define ${PHASE}_EXMAPPING_TABLE_SIZE ${EXMAPPING_TABLE_SIZE}
141 #define ${PHASE}_EX_TOKEN_NUMBER ${EX_TOKEN_NUMBER}
142 #define ${PHASE}_SIZE_TABLE_SIZE ${SIZE_TABLE_SIZE}
143 #define ${PHASE}_GUID_TABLE_EMPTY ${GUID_TABLE_EMPTY}
144 #define ${PHASE}_STRING_TABLE_EMPTY ${STRING_TABLE_EMPTY}
145 #define ${PHASE}_SKUID_TABLE_EMPTY ${SKUID_TABLE_EMPTY}
146 #define ${PHASE}_DATABASE_EMPTY ${DATABASE_EMPTY}
147 #define ${PHASE}_EXMAP_TABLE_EMPTY ${EXMAP_TABLE_EMPTY}
150 ${BEGIN} UINT64 ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}];
152 ${BEGIN} UINT64 ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64};
154 ${BEGIN} UINT32 ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}];
156 ${BEGIN} UINT32 ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32};
158 ${BEGIN} VPD_HEAD ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}];
160 DYNAMICEX_MAPPING ExMapTable[${PHASE}_EXMAPPING_TABLE_SIZE];
161 UINT32 LocalTokenNumberTable[${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE];
162 GUID GuidTable[${PHASE}_GUID_TABLE_SIZE];
163 ${BEGIN} STRING_HEAD ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}];
165 ${BEGIN} VARIABLE_HEAD ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}[${VARIABLE_HEAD_NUMSKUS_DECL}];
167 ${BEGIN} UINT8 StringTable${STRING_TABLE_INDEX}[${STRING_TABLE_LENGTH}]; /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
169 SIZE_INFO SizeTable[${PHASE}_SIZE_TABLE_SIZE];
170 ${BEGIN} UINT16 ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}];
172 ${BEGIN} UINT16 ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16};
174 ${BEGIN} UINT8 ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}];
176 ${BEGIN} UINT8 ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8};
178 ${BEGIN} BOOLEAN ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}];
180 ${BEGIN} BOOLEAN ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN};
182 UINT8 SkuIdTable[${PHASE}_SKUID_TABLE_SIZE];
184 } ${PHASE}_PCD_DATABASE_INIT;
187 ${PCD_DATABASE_UNINIT_EMPTY}
188 ${BEGIN} UINT64 ${UNINIT_CNAME_DECL_UINT64}_${UNINIT_GUID_DECL_UINT64}[${UNINIT_NUMSKUS_DECL_UINT64}];
190 ${BEGIN} UINT32 ${UNINIT_CNAME_DECL_UINT32}_${UNINIT_GUID_DECL_UINT32}[${UNINIT_NUMSKUS_DECL_UINT32}];
192 ${BEGIN} UINT16 ${UNINIT_CNAME_DECL_UINT16}_${UNINIT_GUID_DECL_UINT16}[${UNINIT_NUMSKUS_DECL_UINT16}];
194 ${BEGIN} UINT8 ${UNINIT_CNAME_DECL_UINT8}_${UNINIT_GUID_DECL_UINT8}[${UNINIT_NUMSKUS_DECL_UINT8}];
196 ${BEGIN} BOOLEAN ${UNINIT_CNAME_DECL_BOOLEAN}_${UNINIT_GUID_DECL_BOOLEAN}[${UNINIT_NUMSKUS_DECL_BOOLEAN}];
198 } ${PHASE}_PCD_DATABASE_UNINIT;
200 #define PCD_${PHASE}_SERVICE_DRIVER_VERSION 2
203 ${PHASE}_PCD_DATABASE_INIT Init;
204 ${PHASE}_PCD_DATABASE_UNINIT Uninit;
205 } ${PHASE}_PCD_DATABASE;
207 #define ${PHASE}_NEX_TOKEN_NUMBER (${PHASE}_LOCAL_TOKEN_NUMBER - ${PHASE}_EX_TOKEN_NUMBER)
210 gEmptyPcdDatabaseAutoGenC
= TemplateString("""
211 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
216 /* LocalTokenNumberTable */
222 {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
232 ${SYSTEM_SKU_ID_VALUE}
236 gPcdDatabaseAutoGenC
= TemplateString("""
237 ${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
238 ${BEGIN} { ${INIT_VALUE_UINT64} }, /* ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}] */
240 ${BEGIN} ${VARDEF_VALUE_UINT64}, /* ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64} */
242 ${BEGIN} { ${INIT_VALUE_UINT32} }, /* ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}] */
244 ${BEGIN} ${VARDEF_VALUE_UINT32}, /* ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32} */
247 ${BEGIN} { ${VPD_HEAD_VALUE} }, /* ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}] */
251 ${BEGIN} { ${EXMAPPING_TABLE_EXTOKEN}, ${EXMAPPING_TABLE_LOCAL_TOKEN}, ${EXMAPPING_TABLE_GUID_INDEX} },
254 /* LocalTokenNumberTable */
256 ${BEGIN} offsetof(${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}) | ${TOKEN_TYPE},
261 ${BEGIN} ${GUID_STRUCTURE},
264 ${BEGIN} { ${STRING_HEAD_VALUE} }, /* ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}] */
266 ${BEGIN} /* ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}[${VARIABLE_HEAD_NUMSKUS_DECL}] */
268 ${VARIABLE_HEAD_VALUE}
272 ${BEGIN} ${STRING_TABLE_VALUE}, /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
276 ${BEGIN} ${SIZE_TABLE_MAXIMUM_LENGTH}, ${SIZE_TABLE_CURRENT_LENGTH}, /* ${SIZE_TABLE_CNAME}_${SIZE_TABLE_GUID} */
279 ${BEGIN} { ${INIT_VALUE_UINT16} }, /* ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}] */
281 ${BEGIN} ${VARDEF_VALUE_UINT16}, /* ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16} */
283 ${BEGIN} { ${INIT_VALUE_UINT8} }, /* ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}] */
285 ${BEGIN} ${VARDEF_VALUE_UINT8}, /* ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8} */
287 ${BEGIN} { ${INIT_VALUE_BOOLEAN} }, /* ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}] */
289 ${BEGIN} ${VARDEF_VALUE_BOOLEAN}, /* ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN} */
292 { ${BEGIN}${SKUID_VALUE}, ${END} },
293 ${SYSTEM_SKU_ID_VALUE}
298 ## AutoGen File Header Templates
299 gAutoGenHeaderString
= TemplateString("""\
305 Abstract: Auto-generated ${FileName} for building module or library.
309 gAutoGenHPrologueString
= TemplateString("""
310 #ifndef _${File}_${Guid}
311 #define _${File}_${Guid}
315 gAutoGenHEpilogueString
= """
319 ## PEI Core Entry Point Templates
320 gPeiCoreEntryPointPrototype
= TemplateString("""
325 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
326 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
332 gPeiCoreEntryPointString
= TemplateString("""
336 ProcessModuleEntryPointList (
337 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
338 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
343 ${Function} (SecCoreData, PpiList, Context);
349 ## DXE Core Entry Point Templates
350 gDxeCoreEntryPointPrototype
= TemplateString("""
360 gDxeCoreEntryPointString
= TemplateString("""
364 ProcessModuleEntryPointList (
369 ${Function} (HobStart);
374 ## PEIM Entry Point Templates
375 gPeimEntryPointPrototype
= TemplateString("""
380 IN EFI_PEI_FILE_HANDLE FileHandle,
381 IN CONST EFI_PEI_SERVICES **PeiServices
386 gPeimEntryPointString
= [
388 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
392 ProcessModuleEntryPointList (
393 IN EFI_PEI_FILE_HANDLE FileHandle,
394 IN CONST EFI_PEI_SERVICES **PeiServices
402 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
406 ProcessModuleEntryPointList (
407 IN EFI_PEI_FILE_HANDLE FileHandle,
408 IN CONST EFI_PEI_SERVICES **PeiServices
412 return ${Function} (FileHandle, PeiServices);
417 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
421 ProcessModuleEntryPointList (
422 IN EFI_PEI_FILE_HANDLE FileHandle,
423 IN CONST EFI_PEI_SERVICES **PeiServices
428 EFI_STATUS CombinedStatus;
430 CombinedStatus = EFI_LOAD_ERROR;
432 Status = ${Function} (FileHandle, PeiServices);
433 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
434 CombinedStatus = Status;
437 return CombinedStatus;
442 ## SMM_CORE Entry Point Templates
443 gSmmCoreEntryPointPrototype
= TemplateString("""
448 IN EFI_HANDLE ImageHandle,
449 IN EFI_SYSTEM_TABLE *SystemTable
454 gSmmCoreEntryPointString
= TemplateString("""
456 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
457 const UINT32 _gDxeRevision = ${PiSpecVersion};
461 ProcessModuleEntryPointList (
462 IN EFI_HANDLE ImageHandle,
463 IN EFI_SYSTEM_TABLE *SystemTable
466 return ${Function} (ImageHandle, SystemTable);
471 ## DXE SMM Entry Point Templates
472 gDxeSmmEntryPointPrototype
= TemplateString("""
477 IN EFI_HANDLE ImageHandle,
478 IN EFI_SYSTEM_TABLE *SystemTable
483 gDxeSmmEntryPointString
= [
485 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
486 const UINT32 _gDxeRevision = ${PiSpecVersion};
490 ProcessModuleEntryPointList (
491 IN EFI_HANDLE ImageHandle,
492 IN EFI_SYSTEM_TABLE *SystemTable
500 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
501 const UINT32 _gDxeRevision = ${PiSpecVersion};
503 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
504 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
512 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
513 mDriverEntryPointStatus = Status;
515 LongJump (&mJumpContext, (UINTN)-1);
521 ProcessModuleEntryPointList (
522 IN EFI_HANDLE ImageHandle,
523 IN EFI_SYSTEM_TABLE *SystemTable
528 if (SetJump (&mJumpContext) == 0) {
529 ExitDriver (${Function} (ImageHandle, SystemTable));
534 return mDriverEntryPointStatus;
539 ## UEFI Driver Entry Point Templates
540 gUefiDriverEntryPointPrototype
= TemplateString("""
545 IN EFI_HANDLE ImageHandle,
546 IN EFI_SYSTEM_TABLE *SystemTable
551 gUefiDriverEntryPointString
= [
553 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
554 const UINT32 _gDxeRevision = ${PiSpecVersion};
558 ProcessModuleEntryPointList (
559 IN EFI_HANDLE ImageHandle,
560 IN EFI_SYSTEM_TABLE *SystemTable
567 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
568 const UINT32 _gDxeRevision = ${PiSpecVersion};
573 ProcessModuleEntryPointList (
574 IN EFI_HANDLE ImageHandle,
575 IN EFI_SYSTEM_TABLE *SystemTable
579 return ${Function} (ImageHandle, SystemTable);
588 if (EFI_ERROR (Status)) {
589 ProcessLibraryDestructorList (gImageHandle, gST);
591 gBS->Exit (gImageHandle, Status, 0, NULL);
595 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
596 const UINT32 _gDxeRevision = ${PiSpecVersion};
600 ProcessModuleEntryPointList (
601 IN EFI_HANDLE ImageHandle,
602 IN EFI_SYSTEM_TABLE *SystemTable
607 if (SetJump (&mJumpContext) == 0) {
608 ExitDriver (${Function} (ImageHandle, SystemTable));
612 return mDriverEntryPointStatus;
615 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
616 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
624 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
625 mDriverEntryPointStatus = Status;
627 LongJump (&mJumpContext, (UINTN)-1);
634 ## UEFI Application Entry Point Templates
635 gUefiApplicationEntryPointPrototype
= TemplateString("""
640 IN EFI_HANDLE ImageHandle,
641 IN EFI_SYSTEM_TABLE *SystemTable
646 gUefiApplicationEntryPointString
= [
648 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
652 ProcessModuleEntryPointList (
653 IN EFI_HANDLE ImageHandle,
654 IN EFI_SYSTEM_TABLE *SystemTable
661 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
666 ProcessModuleEntryPointList (
667 IN EFI_HANDLE ImageHandle,
668 IN EFI_SYSTEM_TABLE *SystemTable
672 return ${Function} (ImageHandle, SystemTable);
681 if (EFI_ERROR (Status)) {
682 ProcessLibraryDestructorList (gImageHandle, gST);
684 gBS->Exit (gImageHandle, Status, 0, NULL);
688 const UINT32 _gUefiDriverRevision = ${EfiSpecVersion};
692 ProcessModuleEntryPointList (
693 IN EFI_HANDLE ImageHandle,
694 IN EFI_SYSTEM_TABLE *SystemTable
699 if (SetJump (&mJumpContext) == 0) {
700 ExitDriver (${Function} (ImageHandle, SystemTable));
704 return mDriverEntryPointStatus;
707 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
708 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
716 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
717 mDriverEntryPointStatus = Status;
719 LongJump (&mJumpContext, (UINTN)-1);
725 ## UEFI Unload Image Templates
726 gUefiUnloadImagePrototype
= TemplateString("""
731 IN EFI_HANDLE ImageHandle
736 gUefiUnloadImageString
= [
738 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
742 ProcessModuleUnloadList (
743 IN EFI_HANDLE ImageHandle
750 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
755 ProcessModuleUnloadList (
756 IN EFI_HANDLE ImageHandle
759 return ${Function} (ImageHandle);
764 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
768 ProcessModuleUnloadList (
769 IN EFI_HANDLE ImageHandle
774 Status = EFI_SUCCESS;
776 if (EFI_ERROR (Status)) {
777 ${Function} (ImageHandle);
779 Status = ${Function} (ImageHandle);
787 gLibraryStructorPrototype
= {
788 'BASE' : TemplateString("""${BEGIN}
796 'PEI' : TemplateString("""${BEGIN}
800 IN EFI_PEI_FILE_HANDLE FileHandle,
801 IN CONST EFI_PEI_SERVICES **PeiServices
805 'DXE' : TemplateString("""${BEGIN}
809 IN EFI_HANDLE ImageHandle,
810 IN EFI_SYSTEM_TABLE *SystemTable
815 gLibraryStructorCall
= {
816 'BASE' : TemplateString("""${BEGIN}
817 Status = ${Function} ();
818 ASSERT_EFI_ERROR (Status);${END}
821 'PEI' : TemplateString("""${BEGIN}
822 Status = ${Function} (FileHandle, PeiServices);
823 ASSERT_EFI_ERROR (Status);${END}
826 'DXE' : TemplateString("""${BEGIN}
827 Status = ${Function} (ImageHandle, SystemTable);
828 ASSERT_EFI_ERROR (Status);${END}
832 ## Library Constructor and Destructor Templates
834 'BASE' : TemplateString("""
835 ${BEGIN}${FunctionPrototype}${END}
839 ProcessLibrary${Type}List (
843 ${BEGIN} EFI_STATUS Status;
844 ${FunctionCall}${END}
848 'PEI' : TemplateString("""
849 ${BEGIN}${FunctionPrototype}${END}
853 ProcessLibrary${Type}List (
854 IN EFI_PEI_FILE_HANDLE FileHandle,
855 IN CONST EFI_PEI_SERVICES **PeiServices
858 ${BEGIN} EFI_STATUS Status;
859 ${FunctionCall}${END}
863 'DXE' : TemplateString("""
864 ${BEGIN}${FunctionPrototype}${END}
868 ProcessLibrary${Type}List (
869 IN EFI_HANDLE ImageHandle,
870 IN EFI_SYSTEM_TABLE *SystemTable
873 ${BEGIN} EFI_STATUS Status;
874 ${FunctionCall}${END}
879 gSpecificationString
= TemplateString("""
881 #undef ${SpecificationName}
882 #define ${SpecificationName} ${SpecificationValue}
886 gBasicHeaderFile
= "Base.h"
888 gModuleTypeHeaderFile
= {
889 "BASE" : [gBasicHeaderFile
],
890 "SEC" : ["PiPei.h", "Library/DebugLib.h"],
891 "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
892 "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
893 "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
894 "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
895 "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
896 "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
897 "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
898 "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
899 "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
900 "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
901 "USER_DEFINED" : [gBasicHeaderFile
]
904 ## Create code for module PCDs
906 # @param Info The ModuleAutoGen object
907 # @param AutoGenC The TemplateString object for C code
908 # @param AutoGenH The TemplateString object for header file
909 # @param Pcd The PCD object
911 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
912 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
913 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
917 PcdTokenName
= '_PCD_TOKEN_' + Pcd
.TokenCName
918 if Pcd
.Type
in gDynamicExPcd
:
919 TokenNumber
= int(Pcd
.TokenValue
, 0)
921 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
922 EdkLogger
.error("build", AUTOGEN_ERROR
,
923 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
924 ExtraData
="[%s]" % str(Info
))
925 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
926 AutoGenH
.Append('\n#define %s %d\n' % (PcdTokenName
, TokenNumber
))
928 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + Pcd
.TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
929 if Pcd
.Type
not in gItemTypeStringDatabase
:
930 EdkLogger
.error("build", AUTOGEN_ERROR
,
931 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
932 ExtraData
="[%s]" % str(Info
))
933 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
934 EdkLogger
.error("build", AUTOGEN_ERROR
,
935 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
936 ExtraData
="[%s]" % str(Info
))
938 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
]
939 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
]
940 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
941 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
943 if Pcd
.Type
in gDynamicExPcd
:
944 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
945 if Pcd
.DatumType
== 'VOID*':
946 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
948 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
949 elif Pcd
.Type
in gDynamicPcd
:
950 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
951 if Pcd
.DatumType
== 'VOID*':
952 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
954 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
956 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + Pcd
.TokenCName
958 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
962 Value
= Pcd
.DefaultValue
964 if Pcd
.DatumType
== 'UINT64':
965 if not Value
.endswith('ULL'):
967 if Pcd
.DatumType
== 'VOID*':
968 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
969 EdkLogger
.error("build", AUTOGEN_ERROR
,
970 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
971 ExtraData
="[%s]" % str(Info
))
973 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
979 Value
= Value
.lstrip('L') #.strip('"')
980 Value
= eval(Value
) # translate escape character
982 for Index
in range(0,len(Value
)):
984 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
986 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
988 ArraySize
= ArraySize
/ 2;
990 if ArraySize
< (len(Value
) + 1):
991 ArraySize
= len(Value
) + 1
992 Value
= NewValue
+ '0 }'
993 Array
= '[%d]' % ArraySize
995 # skip casting for fixed at build since it breaks ARM assembly.
996 # Long term we need PCD macros that work in assembly
998 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
999 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1001 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1002 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + Pcd
.TokenCName
1004 PcdValueName
= '_PCD_VALUE_' + Pcd
.TokenCName
1006 if Pcd
.DatumType
== 'VOID*':
1008 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1011 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
1012 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1013 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1014 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1015 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1017 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
1018 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1019 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1020 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1021 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1022 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1023 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1024 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1025 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1026 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1028 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1029 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1030 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1031 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1033 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1034 if Pcd
.DatumType
== 'VOID*':
1035 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1037 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1039 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1041 ## Create code for library module PCDs
1043 # @param Info The ModuleAutoGen object
1044 # @param AutoGenC The TemplateString object for C code
1045 # @param AutoGenH The TemplateString object for header file
1046 # @param Pcd The PCD object
1048 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1049 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1050 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1051 TokenCName
= Pcd
.TokenCName
1052 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[TokenSpaceGuidCName]
1053 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1054 EdkLogger
.error("build", AUTOGEN_ERROR
,
1055 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1056 ExtraData
="[%s]" % str(Info
))
1057 TokenNumber
= PcdTokenNumber
[TokenCName
, TokenSpaceGuidCName
]
1059 if Pcd
.Type
not in gItemTypeStringDatabase
:
1060 EdkLogger
.error("build", AUTOGEN_ERROR
,
1061 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1062 ExtraData
="[%s]" % str(Info
))
1063 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1064 EdkLogger
.error("build", AUTOGEN_ERROR
,
1065 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1066 ExtraData
="[%s]" % str(Info
))
1068 DatumType
= Pcd
.DatumType
1069 DatumSize
= gDatumSizeStringDatabaseH
[DatumType
]
1070 DatumSizeLib
= gDatumSizeStringDatabaseLib
[DatumType
]
1071 GetModeName
= '_PCD_GET_MODE_' + DatumSize
+ '_' + TokenCName
1072 SetModeName
= '_PCD_SET_MODE_' + DatumSize
+ '_' + TokenCName
1076 if Pcd
.DatumType
== 'VOID*':
1080 AutoGenH
.Append('#define _PCD_TOKEN_%s %d\n' % (TokenCName
, TokenNumber
))
1082 PcdItemType
= Pcd
.Type
1083 #if PcdItemType in gDynamicPcd:
1084 # PcdItemType = TAB_PCDS_FIXED_AT_BUILD
1085 # if (TokenCName, TokenSpaceGuidCName) in Info.PlatformInfo.Platform.Pcds:
1086 # PcdItemType = Info.PlatformInfo.Platform.Pcds[TokenCName, TokenSpaceGuidCName].Type
1087 if PcdItemType
in gDynamicExPcd
:
1088 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1089 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1090 if DatumType
== 'VOID*':
1091 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
,DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1093 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1094 if PcdItemType
in gDynamicPcd
:
1095 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1096 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1097 if DatumType
== 'VOID*':
1098 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1100 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1101 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1102 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1103 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
) )
1104 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1105 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1106 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1107 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1108 #AutoGenH.Append('#define _PCD_VALUE_%s _gPcd_FixedAtBuild_%s\n' %(TokenCName, TokenCName))
1109 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1110 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1112 ## Create code for PCD database in DXE or PEI phase
1114 # @param Platform The platform object
1115 # @retval tuple Two TemplateString objects for C code and header file,
1118 def CreatePcdDatabasePhaseSpecificAutoGen (Platform
, Phase
):
1119 AutoGenC
= TemplateString()
1120 AutoGenH
= TemplateString()
1124 'GUID_TABLE_SIZE' : '1',
1125 'STRING_TABLE_SIZE' : '1',
1126 'SKUID_TABLE_SIZE' : '1',
1127 'LOCAL_TOKEN_NUMBER_TABLE_SIZE' : '1',
1128 'LOCAL_TOKEN_NUMBER' : '0',
1129 'EXMAPPING_TABLE_SIZE' : '1',
1130 'EX_TOKEN_NUMBER' : '0',
1131 'SIZE_TABLE_SIZE' : '2',
1132 'GUID_TABLE_EMPTY' : 'TRUE',
1133 'STRING_TABLE_EMPTY' : 'TRUE',
1134 'SKUID_TABLE_EMPTY' : 'TRUE',
1135 'DATABASE_EMPTY' : 'TRUE',
1136 'EXMAP_TABLE_EMPTY' : 'TRUE',
1137 'PCD_DATABASE_UNINIT_EMPTY' : ' UINT8 dummy; /* PCD_DATABASE_UNINIT is emptry */',
1138 'SYSTEM_SKU_ID' : ' SKU_ID SystemSkuId;',
1139 'SYSTEM_SKU_ID_VALUE' : '0'
1142 for DatumType
in ['UINT64','UINT32','UINT16','UINT8','BOOLEAN']:
1143 Dict
['VARDEF_CNAME_' + DatumType
] = []
1144 Dict
['VARDEF_GUID_' + DatumType
] = []
1145 Dict
['VARDEF_SKUID_' + DatumType
] = []
1146 Dict
['VARDEF_VALUE_' + DatumType
] = []
1147 for Init
in ['INIT','UNINIT']:
1148 Dict
[Init
+'_CNAME_DECL_' + DatumType
] = []
1149 Dict
[Init
+'_GUID_DECL_' + DatumType
] = []
1150 Dict
[Init
+'_NUMSKUS_DECL_' + DatumType
] = []
1151 Dict
[Init
+'_VALUE_' + DatumType
] = []
1153 for Type
in ['STRING_HEAD','VPD_HEAD','VARIABLE_HEAD']:
1154 Dict
[Type
+ '_CNAME_DECL'] = []
1155 Dict
[Type
+ '_GUID_DECL'] = []
1156 Dict
[Type
+ '_NUMSKUS_DECL'] = []
1157 Dict
[Type
+ '_VALUE'] = []
1159 Dict
['STRING_TABLE_INDEX'] = []
1160 Dict
['STRING_TABLE_LENGTH'] = []
1161 Dict
['STRING_TABLE_CNAME'] = []
1162 Dict
['STRING_TABLE_GUID'] = []
1163 Dict
['STRING_TABLE_VALUE'] = []
1165 Dict
['SIZE_TABLE_CNAME'] = []
1166 Dict
['SIZE_TABLE_GUID'] = []
1167 Dict
['SIZE_TABLE_CURRENT_LENGTH'] = []
1168 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'] = []
1170 Dict
['EXMAPPING_TABLE_EXTOKEN'] = []
1171 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'] = []
1172 Dict
['EXMAPPING_TABLE_GUID_INDEX'] = []
1174 Dict
['GUID_STRUCTURE'] = []
1176 Dict
['SKUID_VALUE'] = []
1179 Dict
['SYSTEM_SKU_ID'] = ''
1180 Dict
['SYSTEM_SKU_ID_VALUE'] = ''
1182 StringTableIndex
= 0
1184 NumberOfLocalTokens
= 0
1185 NumberOfPeiLocalTokens
= 0
1186 NumberOfDxeLocalTokens
= 0
1187 NumberOfExTokens
= 0
1188 NumberOfSizeItems
= 0
1191 for Pcd
in Platform
.DynamicPcdList
:
1192 CName
= Pcd
.TokenCName
1193 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1195 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "PCD: %s %s (%s : %s)" % (CName
, TokenSpaceGuidCName
, Pcd
.Phase
, Phase
))
1196 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1197 EdkLogger
.error("build", AUTOGEN_ERROR
,
1198 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1199 ExtraData
="[%s]" % str(Platform
))
1201 if Pcd
.Phase
== 'PEI':
1202 NumberOfPeiLocalTokens
+= 1
1203 if Pcd
.Phase
== 'DXE':
1204 NumberOfDxeLocalTokens
+= 1
1205 if Pcd
.Phase
!= Phase
:
1209 # TODO: need GetGuidValue() definition
1211 TokenSpaceGuidStructure
= Pcd
.TokenSpaceGuidValue
1212 TokenSpaceGuid
= GuidStructureStringToGuidValueName(TokenSpaceGuidStructure
)
1213 if Pcd
.Type
in gDynamicExPcd
:
1214 if TokenSpaceGuid
not in GuidList
:
1215 GuidList
+= [TokenSpaceGuid
]
1216 Dict
['GUID_STRUCTURE'].append(TokenSpaceGuidStructure
)
1217 NumberOfExTokens
+= 1
1220 StringHeadOffsetList
= []
1221 VpdHeadOffsetList
= []
1222 VariableHeadValueList
= []
1223 Pcd
.InitString
= 'UNINIT'
1225 if Pcd
.DatumType
== 'VOID*':
1226 Pcd
.TokenTypeList
= ['PCD_DATUM_TYPE_POINTER']
1227 elif Pcd
.DatumType
== 'BOOLEAN':
1228 Pcd
.TokenTypeList
= ['PCD_DATUM_TYPE_UINT8']
1230 Pcd
.TokenTypeList
= ['PCD_DATUM_TYPE_' + Pcd
.DatumType
]
1232 if len(Pcd
.SkuInfoList
) > 1:
1233 Pcd
.TokenTypeList
+= ['PCD_TYPE_SKU_ENABLED']
1235 for SkuName
in Pcd
.SkuInfoList
:
1236 Sku
= Pcd
.SkuInfoList
[SkuName
]
1238 if SkuId
== None or SkuId
== '':
1241 if SkuId
not in Dict
['SKUID_VALUE']:
1242 Dict
['SKUID_VALUE'].append(SkuId
)
1244 SkuIdIndex
= Dict
['SKUID_VALUE'].index(SkuId
)
1245 if len(Sku
.VariableName
) > 0:
1246 Pcd
.TokenTypeList
+= ['PCD_TYPE_HII']
1247 Pcd
.InitString
= 'INIT'
1248 VariableNameStructure
= StringToArray(Sku
.VariableName
)
1249 if VariableNameStructure
not in Dict
['STRING_TABLE_VALUE']:
1250 Dict
['STRING_TABLE_CNAME'].append(CName
)
1251 Dict
['STRING_TABLE_GUID'].append(TokenSpaceGuid
)
1252 if StringTableIndex
== 0:
1253 Dict
['STRING_TABLE_INDEX'].append('')
1255 Dict
['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex
)
1257 Dict
['STRING_TABLE_LENGTH'].append((len(Sku
.VariableName
) - 3 + 1) * 2)
1258 Dict
['STRING_TABLE_VALUE'].append(VariableNameStructure
)
1259 StringTableIndex
+= 1
1260 StringTableSize
+= (len(Sku
.VariableName
) - 3 + 1) * 2
1262 VariableHeadStringIndex
= 0
1263 for Index
in range(Dict
['STRING_TABLE_VALUE'].index(VariableNameStructure
)):
1264 VariableHeadStringIndex
+= Dict
['STRING_TABLE_LENGTH'][Index
]
1266 VariableGuidStructure
= Sku
.VariableGuidValue
1267 VariableGuid
= GuidStructureStringToGuidValueName(VariableGuidStructure
)
1268 if VariableGuid
not in GuidList
:
1269 GuidList
+= [VariableGuid
]
1270 Dict
['GUID_STRUCTURE'].append(VariableGuidStructure
)
1271 VariableHeadGuidIndex
= GuidList
.index(VariableGuid
)
1273 VariableHeadValueList
.append('%d, %d, %s, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s)' %
1274 (VariableHeadGuidIndex
, VariableHeadStringIndex
, Sku
.VariableOffset
,
1275 Phase
, CName
, TokenSpaceGuid
, SkuIdIndex
))
1276 Dict
['VARDEF_CNAME_'+Pcd
.DatumType
].append(CName
)
1277 Dict
['VARDEF_GUID_'+Pcd
.DatumType
].append(TokenSpaceGuid
)
1278 Dict
['VARDEF_SKUID_'+Pcd
.DatumType
].append(SkuIdIndex
)
1279 Dict
['VARDEF_VALUE_'+Pcd
.DatumType
].append(Sku
.HiiDefaultValue
)
1280 elif Sku
.VpdOffset
!= '':
1281 Pcd
.TokenTypeList
+= ['PCD_TYPE_VPD']
1282 Pcd
.InitString
= 'INIT'
1283 VpdHeadOffsetList
.append(Sku
.VpdOffset
)
1285 if Pcd
.DatumType
== 'VOID*':
1286 Pcd
.TokenTypeList
+= ['PCD_TYPE_STRING']
1287 Pcd
.InitString
= 'INIT'
1288 if Sku
.DefaultValue
!= '':
1289 NumberOfSizeItems
+= 1
1290 Dict
['STRING_TABLE_CNAME'].append(CName
)
1291 Dict
['STRING_TABLE_GUID'].append(TokenSpaceGuid
)
1293 if StringTableIndex
== 0:
1294 Dict
['STRING_TABLE_INDEX'].append('')
1296 Dict
['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex
)
1297 if Sku
.DefaultValue
[0] == 'L':
1298 Size
= (len(Sku
.DefaultValue
) - 3 + 1) * 2
1299 Dict
['STRING_TABLE_VALUE'].append(StringToArray(Sku
.DefaultValue
))
1300 elif Sku
.DefaultValue
[0] == '"':
1301 Size
= len(Sku
.DefaultValue
) - 2 + 1
1302 Dict
['STRING_TABLE_VALUE'].append(StringToArray(Sku
.DefaultValue
))
1303 elif Sku
.DefaultValue
[0] == '{':
1304 Size
= len(Sku
.DefaultValue
.replace(',',' ').split())
1305 Dict
['STRING_TABLE_VALUE'].append(Sku
.DefaultValue
)
1307 StringHeadOffsetList
.append(str(StringTableSize
))
1308 Dict
['SIZE_TABLE_CNAME'].append(CName
)
1309 Dict
['SIZE_TABLE_GUID'].append(TokenSpaceGuid
)
1310 Dict
['SIZE_TABLE_CURRENT_LENGTH'].append(Size
)
1311 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'].append(Pcd
.MaxDatumSize
)
1312 if Pcd
.MaxDatumSize
!= '':
1313 MaxDatumSize
= int(Pcd
.MaxDatumSize
, 0)
1314 if MaxDatumSize
> Size
:
1316 Dict
['STRING_TABLE_LENGTH'].append(Size
)
1317 StringTableIndex
+= 1
1318 StringTableSize
+= (Size
)
1320 Pcd
.TokenTypeList
+= ['PCD_TYPE_DATA']
1321 if Sku
.DefaultValue
== 'TRUE':
1322 Pcd
.InitString
= 'INIT'
1325 if int(Sku
.DefaultValue
, 0) != 0:
1326 Pcd
.InitString
= 'INIT'
1331 # For UNIT64 type PCD's value, ULL should be append to avoid
1332 # warning under linux building environment.
1334 if Pcd
.DatumType
== "UINT64":
1335 ValueList
.append(Sku
.DefaultValue
+ "ULL")
1337 ValueList
.append(Sku
.DefaultValue
)
1339 Pcd
.TokenTypeList
= list(set(Pcd
.TokenTypeList
))
1341 if 'PCD_TYPE_HII' in Pcd
.TokenTypeList
:
1342 Dict
['VARIABLE_HEAD_CNAME_DECL'].append(CName
)
1343 Dict
['VARIABLE_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1344 Dict
['VARIABLE_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1345 Dict
['VARIABLE_HEAD_VALUE'].append('{ %s }\n' % ' },\n { '.join(VariableHeadValueList
))
1346 if 'PCD_TYPE_VPD' in Pcd
.TokenTypeList
:
1347 Dict
['VPD_HEAD_CNAME_DECL'].append(CName
)
1348 Dict
['VPD_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1349 Dict
['VPD_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1350 Dict
['VPD_HEAD_VALUE'].append('{ %s }' % ' }, { '.join(VpdHeadOffsetList
))
1351 if 'PCD_TYPE_STRING' in Pcd
.TokenTypeList
:
1352 Dict
['STRING_HEAD_CNAME_DECL'].append(CName
)
1353 Dict
['STRING_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1354 Dict
['STRING_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1355 Dict
['STRING_HEAD_VALUE'].append(', '.join(StringHeadOffsetList
))
1356 if 'PCD_TYPE_DATA' in Pcd
.TokenTypeList
:
1357 Dict
[Pcd
.InitString
+'_CNAME_DECL_'+Pcd
.DatumType
].append(CName
)
1358 Dict
[Pcd
.InitString
+'_GUID_DECL_'+Pcd
.DatumType
].append(TokenSpaceGuid
)
1359 Dict
[Pcd
.InitString
+'_NUMSKUS_DECL_'+Pcd
.DatumType
].append(len(Pcd
.SkuInfoList
))
1360 if Pcd
.InitString
== 'UNINIT':
1361 Dict
['PCD_DATABASE_UNINIT_EMPTY'] = ''
1363 Dict
[Pcd
.InitString
+'_VALUE_'+Pcd
.DatumType
].append(', '.join(ValueList
))
1366 NumberOfLocalTokens
= NumberOfPeiLocalTokens
1368 NumberOfLocalTokens
= NumberOfDxeLocalTokens
1370 Dict
['TOKEN_INIT'] = ['' for x
in range(NumberOfLocalTokens
)]
1371 Dict
['TOKEN_CNAME'] = ['' for x
in range(NumberOfLocalTokens
)]
1372 Dict
['TOKEN_GUID'] = ['' for x
in range(NumberOfLocalTokens
)]
1373 Dict
['TOKEN_TYPE'] = ['' for x
in range(NumberOfLocalTokens
)]
1375 for Pcd
in Platform
.DynamicPcdList
:
1376 CName
= Pcd
.TokenCName
1377 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1378 if Pcd
.Phase
!= Phase
:
1381 TokenSpaceGuid
= GuidStructureStringToGuidValueName(Pcd
.TokenSpaceGuidValue
) #(Platform.PackageList, TokenSpaceGuidCName))
1382 GeneratedTokenNumber
= Platform
.PcdTokenNumber
[CName
, TokenSpaceGuidCName
] - 1
1384 GeneratedTokenNumber
-= NumberOfPeiLocalTokens
1386 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "PCD = %s.%s" % (CName
, TokenSpaceGuidCName
))
1387 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "phase = %s" % Phase
)
1388 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "GeneratedTokenNumber = %s" % str(GeneratedTokenNumber
))
1390 Dict
['TOKEN_INIT'][GeneratedTokenNumber
] = 'Init'
1391 if Pcd
.InitString
== 'UNINIT':
1392 Dict
['TOKEN_INIT'][GeneratedTokenNumber
] = 'Uninit'
1393 Dict
['TOKEN_CNAME'][GeneratedTokenNumber
] = CName
1394 Dict
['TOKEN_GUID'][GeneratedTokenNumber
] = TokenSpaceGuid
1395 Dict
['TOKEN_TYPE'][GeneratedTokenNumber
] = ' | '.join(Pcd
.TokenTypeList
)
1396 if Pcd
.Type
in gDynamicExPcd
:
1397 Dict
['EXMAPPING_TABLE_EXTOKEN'].append(Pcd
.TokenValue
)
1399 GeneratedTokenNumber
+= NumberOfPeiLocalTokens
1401 # Per, PCD architecture specification, PCD Token Number is 1 based and 0 is defined as invalid token number.
1402 # For each EX type PCD, a PCD Token Number is assigned. When the
1403 # PCD Driver/PEIM map EX_GUID and EX_TOKEN_NUMBER to the PCD Token Number,
1404 # the non-EX Protocol/PPI interface can be called to get/set the value. This assumption is made by
1405 # Pcd Driver/PEIM in MdeModulePkg.
1406 # Therefore, 1 is added to GeneratedTokenNumber to generate a PCD Token Number before being inserted
1407 # to the EXMAPPING_TABLE.
1409 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'].append(GeneratedTokenNumber
+ 1)
1410 Dict
['EXMAPPING_TABLE_GUID_INDEX'].append(GuidList
.index(TokenSpaceGuid
))
1413 Dict
['GUID_TABLE_EMPTY'] = 'FALSE'
1414 Dict
['GUID_TABLE_SIZE'] = len(GuidList
)
1416 Dict
['GUID_STRUCTURE'] = [GuidStringToGuidStructureString('00000000-0000-0000-0000-000000000000')]
1418 if StringTableIndex
== 0:
1419 Dict
['STRING_TABLE_INDEX'].append('')
1420 Dict
['STRING_TABLE_LENGTH'].append(1)
1421 Dict
['STRING_TABLE_CNAME'].append('')
1422 Dict
['STRING_TABLE_GUID'].append('')
1423 Dict
['STRING_TABLE_VALUE'].append('{ 0 }')
1425 Dict
['STRING_TABLE_EMPTY'] = 'FALSE'
1426 Dict
['STRING_TABLE_SIZE'] = StringTableSize
1428 if Dict
['SIZE_TABLE_CNAME'] == []:
1429 Dict
['SIZE_TABLE_CNAME'].append('')
1430 Dict
['SIZE_TABLE_GUID'].append('')
1431 Dict
['SIZE_TABLE_CURRENT_LENGTH'].append(0)
1432 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'].append(0)
1434 if NumberOfLocalTokens
!= 0:
1435 Dict
['DATABASE_EMPTY'] = 'FALSE'
1436 Dict
['LOCAL_TOKEN_NUMBER_TABLE_SIZE'] = NumberOfLocalTokens
1437 Dict
['LOCAL_TOKEN_NUMBER'] = NumberOfLocalTokens
1439 if NumberOfExTokens
!= 0:
1440 Dict
['EXMAP_TABLE_EMPTY'] = 'FALSE'
1441 Dict
['EXMAPPING_TABLE_SIZE'] = NumberOfExTokens
1442 Dict
['EX_TOKEN_NUMBER'] = NumberOfExTokens
1444 Dict
['EXMAPPING_TABLE_EXTOKEN'].append(0)
1445 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'].append(0)
1446 Dict
['EXMAPPING_TABLE_GUID_INDEX'].append(0)
1448 if NumberOfSizeItems
!= 0:
1449 Dict
['SIZE_TABLE_SIZE'] = NumberOfSizeItems
* 2
1451 AutoGenH
.Append(gPcdDatabaseAutoGenH
.Replace(Dict
))
1452 if NumberOfLocalTokens
== 0:
1453 AutoGenC
.Append(gEmptyPcdDatabaseAutoGenC
.Replace(Dict
))
1455 AutoGenC
.Append(gPcdDatabaseAutoGenC
.Replace(Dict
))
1457 return AutoGenH
, AutoGenC
1459 ## Create code for PCD database
1461 # @param Info The ModuleAutoGen object
1462 # @param AutoGenC The TemplateString object for C code
1463 # @param AutoGenH The TemplateString object for header file
1465 def CreatePcdDatabaseCode (Info
, AutoGenC
, AutoGenH
):
1466 if Info
.PcdIsDriver
== "":
1468 if Info
.PcdIsDriver
not in gPcdPhaseMap
:
1469 EdkLogger
.error("build", AUTOGEN_ERROR
, "Not supported PcdIsDriver type:%s" % Info
.PcdIsDriver
,
1470 ExtraData
="[%s]" % str(Info
))
1472 AutoGenH
.Append(gPcdDatabaseCommonAutoGenH
)
1473 AdditionalAutoGenH
, AdditionalAutoGenC
= CreatePcdDatabasePhaseSpecificAutoGen (Info
.PlatformInfo
, 'PEI')
1474 AutoGenH
.Append(AdditionalAutoGenH
.String
)
1476 Phase
= gPcdPhaseMap
[Info
.PcdIsDriver
]
1478 AutoGenC
.Append(AdditionalAutoGenC
.String
)
1481 AdditionalAutoGenH
, AdditionalAutoGenC
= CreatePcdDatabasePhaseSpecificAutoGen (Info
.PlatformInfo
, Phase
)
1482 AutoGenH
.Append(AdditionalAutoGenH
.String
)
1483 AutoGenC
.Append(AdditionalAutoGenC
.String
)
1484 AutoGenH
.Append(gPcdDatabaseEpilogueAutoGenH
)
1486 ## Create code for library constructor
1488 # @param Info The ModuleAutoGen object
1489 # @param AutoGenC The TemplateString object for C code
1490 # @param AutoGenH The TemplateString object for header file
1492 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1494 # Library Constructors
1496 ConstructorPrototypeString
= TemplateString()
1497 ConstructorCallingString
= TemplateString()
1499 DependentLibraryList
= [Info
.Module
]
1501 DependentLibraryList
= Info
.DependentLibraryList
1502 for Lib
in DependentLibraryList
:
1503 if len(Lib
.ConstructorList
) <= 0:
1505 Dict
= {'Function':Lib
.ConstructorList
}
1506 if Lib
.ModuleType
in ['BASE', 'SEC']:
1507 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1508 ConstructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1509 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1510 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1511 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1512 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1513 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1514 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1515 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1517 if str(ConstructorPrototypeString
) == '':
1518 ConstructorPrototypeList
= []
1520 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1521 if str(ConstructorCallingString
) == '':
1522 ConstructorCallingList
= []
1524 ConstructorCallingList
= [str(ConstructorCallingString
)]
1527 'Type' : 'Constructor',
1528 'FunctionPrototype' : ConstructorPrototypeList
,
1529 'FunctionCall' : ConstructorCallingList
1532 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1534 if Info
.ModuleType
in ['BASE', 'SEC']:
1535 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1536 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1537 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1538 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1539 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1540 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1542 ## Create code for library destructor
1544 # @param Info The ModuleAutoGen object
1545 # @param AutoGenC The TemplateString object for C code
1546 # @param AutoGenH The TemplateString object for header file
1548 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1550 # Library Destructors
1552 DestructorPrototypeString
= TemplateString()
1553 DestructorCallingString
= TemplateString()
1555 DependentLibraryList
= [Info
.Module
]
1557 DependentLibraryList
= Info
.DependentLibraryList
1558 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1559 Lib
= DependentLibraryList
[Index
]
1560 if len(Lib
.DestructorList
) <= 0:
1562 Dict
= {'Function':Lib
.DestructorList
}
1563 if Lib
.ModuleType
in ['BASE', 'SEC']:
1564 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1565 DestructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1566 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1567 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1568 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1569 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1570 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:
1571 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1572 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1574 if str(DestructorPrototypeString
) == '':
1575 DestructorPrototypeList
= []
1577 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1578 if str(DestructorCallingString
) == '':
1579 DestructorCallingList
= []
1581 DestructorCallingList
= [str(DestructorCallingString
)]
1584 'Type' : 'Destructor',
1585 'FunctionPrototype' : DestructorPrototypeList
,
1586 'FunctionCall' : DestructorCallingList
1589 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1591 if Info
.ModuleType
in ['BASE', 'SEC']:
1592 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1593 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1594 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1595 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1596 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1597 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1600 ## Create code for ModuleEntryPoint
1602 # @param Info The ModuleAutoGen object
1603 # @param AutoGenC The TemplateString object for C code
1604 # @param AutoGenH The TemplateString object for header file
1606 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1607 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1610 # Module Entry Points
1612 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1613 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1614 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1617 if 'EFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1618 EfiSpecVersion
= Info
.Module
.Specification
['EFI_SPECIFICATION_VERSION']
1622 'Function' : Info
.Module
.ModuleEntryPointList
,
1623 'PiSpecVersion' : PiSpecVersion
,
1624 'EfiSpecVersion': EfiSpecVersion
1627 if Info
.ModuleType
in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:
1628 if NumEntryPoints
!= 1:
1632 '%s must have exactly one entry point' % Info
.ModuleType
,
1634 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1636 if Info
.ModuleType
== 'PEI_CORE':
1637 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1638 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1639 elif Info
.ModuleType
== 'DXE_CORE':
1640 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1641 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1642 elif Info
.ModuleType
== 'SMM_CORE':
1643 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1644 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1645 elif Info
.ModuleType
== 'PEIM':
1646 if NumEntryPoints
< 2:
1647 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1649 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1650 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1651 elif Info
.ModuleType
in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
1652 if NumEntryPoints
< 2:
1653 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1655 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1656 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1657 elif Info
.ModuleType
== 'DXE_SMM_DRIVER':
1658 if NumEntryPoints
== 0:
1659 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1661 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1662 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1663 elif Info
.ModuleType
== 'UEFI_APPLICATION':
1664 if NumEntryPoints
< 2:
1665 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1667 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1668 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1670 ## Create code for ModuleUnloadImage
1672 # @param Info The ModuleAutoGen object
1673 # @param AutoGenC The TemplateString object for C code
1674 # @param AutoGenH The TemplateString object for header file
1676 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1677 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1680 # Unload Image Handlers
1682 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1683 Dict
= {'Count':NumUnloadImage
, 'Function':Info
.Module
.ModuleUnloadImageList
}
1684 if NumUnloadImage
< 2:
1685 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1687 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1688 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1690 ## Create code for GUID
1692 # @param Info The ModuleAutoGen object
1693 # @param AutoGenC The TemplateString object for C code
1694 # @param AutoGenH The TemplateString object for header file
1696 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1700 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1703 GuidType
= "EFI_GUID"
1706 AutoGenC
.Append("\n// Guids\n")
1710 for Key
in Info
.GuidList
:
1711 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1713 ## Create code for protocol
1715 # @param Info The ModuleAutoGen object
1716 # @param AutoGenC The TemplateString object for C code
1717 # @param AutoGenH The TemplateString object for header file
1719 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1723 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1726 GuidType
= "EFI_GUID"
1728 if Info
.ProtocolList
:
1729 AutoGenC
.Append("\n// Protocols\n")
1733 for Key
in Info
.ProtocolList
:
1734 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1736 ## Create code for PPI
1738 # @param Info The ModuleAutoGen object
1739 # @param AutoGenC The TemplateString object for C code
1740 # @param AutoGenH The TemplateString object for header file
1742 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1746 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1749 GuidType
= "EFI_GUID"
1752 AutoGenC
.Append("\n// PPIs\n")
1756 for Key
in Info
.PpiList
:
1757 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1759 ## Create code for PCD
1761 # @param Info The ModuleAutoGen object
1762 # @param AutoGenC The TemplateString object for C code
1763 # @param AutoGenH The TemplateString object for header file
1765 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1767 if Info
.ModulePcdList
:
1768 AutoGenH
.Append("\n// PCD definitions\n")
1769 for Pcd
in Info
.ModulePcdList
:
1770 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1772 if Info
.ModulePcdList
:
1773 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1774 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1775 for Pcd
in Info
.ModulePcdList
:
1776 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1778 if Info
.LibraryPcdList
:
1779 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1780 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1781 for Pcd
in Info
.LibraryPcdList
:
1782 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1783 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1785 ## Create code for unicode string definition
1787 # @param Info The ModuleAutoGen object
1788 # @param AutoGenC The TemplateString object for C code
1789 # @param AutoGenH The TemplateString object for header file
1790 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1791 # @param UniGenBinBuffer Buffer to store uni string package data
1793 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1794 WorkingDir
= os
.getcwd()
1795 os
.chdir(Info
.WorkspaceDir
)
1797 IncList
= [Info
.MetaFile
.Dir
]
1798 # Get all files under [Sources] section in inf file for EDK-II module
1799 SrcList
= [F
for F
in Info
.SourceFileList
]
1800 if Info
.AutoGenVersion
< 0x00010005:
1801 # Get all files under the module directory for EDK-I module
1803 os
.chdir(Info
.MetaFile
.Dir
)
1804 for Root
, Dirs
, Files
in os
.walk("."):
1810 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1813 SrcList
.append(File
)
1816 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1817 CompatibleMode
= True
1819 CompatibleMode
= False
1822 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 lanauge codes of EDK Shell in EDK2
1824 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1826 EdkLogger
.error("build", AUTOGEN_ERROR
,
1827 "-c and -s build options should be used exclusively",
1828 ExtraData
="[%s]" % str(Info
))
1833 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
)
1834 if CompatibleMode
or UniGenCFlag
:
1835 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
1836 AutoGenC
.Append(Code
)
1837 AutoGenC
.Append("\n")
1838 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
1839 AutoGenH
.Append(Header
)
1840 if CompatibleMode
or UniGenCFlag
:
1841 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
1842 os
.chdir(WorkingDir
)
1844 ## Create common code
1846 # @param Info The ModuleAutoGen object
1847 # @param AutoGenC The TemplateString object for C code
1848 # @param AutoGenH The TemplateString object for header file
1850 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
1852 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
1853 # header file Prologue
1854 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-','_')}))
1855 if Info
.AutoGenVersion
>= 0x00010005:
1856 # specification macros
1857 AutoGenH
.Append(gSpecificationString
.Replace({'SpecificationName':Info
.Specification
.keys(),
1858 'SpecificationValue':Info
.Specification
.values()}))
1859 # header files includes
1860 AutoGenH
.Append("#include <%s>\n" % gBasicHeaderFile
)
1861 if Info
.ModuleType
in gModuleTypeHeaderFile \
1862 and gModuleTypeHeaderFile
[Info
.ModuleType
][0] != gBasicHeaderFile
:
1863 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
1864 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;\n\n')
1869 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
1874 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
1875 if Info
.AutoGenVersion
>= 0x00010005:
1876 # C file header files includes
1877 if Info
.ModuleType
in gModuleTypeHeaderFile
:
1878 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
1879 AutoGenC
.Append("#include <%s>\n" % Inc
)
1881 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
1884 # Publish the CallerId Guid
1886 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
1888 ## Create common code for header file
1890 # @param Info The ModuleAutoGen object
1891 # @param AutoGenC The TemplateString object for C code
1892 # @param AutoGenH The TemplateString object for header file
1894 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
1895 AutoGenH
.Append(gAutoGenHEpilogueString
)
1897 ## Create code for a module
1899 # @param Info The ModuleAutoGen object
1900 # @param AutoGenC The TemplateString object for C code
1901 # @param AutoGenH The TemplateString object for header file
1902 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1903 # @param UniGenBinBuffer Buffer to store uni string package data
1905 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
):
1906 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
1908 if Info
.AutoGenVersion
>= 0x00010005:
1909 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1910 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1911 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
1912 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
1913 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
1914 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
1915 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
1916 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
1918 if Info
.UnicodeFileList
:
1919 FileName
= "%sStrDefs.h" % Info
.Name
1920 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
1921 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-','_')}))
1922 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
1923 StringH
.Append("\n#endif\n")
1924 AutoGenH
.Append('#include "%s"\n' % FileName
)
1926 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
1928 # no generation of AutoGen.c for R8 modules without unicode file
1929 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
1930 AutoGenC
.String
= ''
1932 ## Create the code file
1934 # @param FilePath The path of code file
1935 # @param Content The content of code file
1936 # @param IsBinaryFile The flag indicating if the file is binary file or not
1938 # @retval True If file content is changed or file doesn't exist
1939 # @retval False If the file exists and the content is not changed
1941 def Generate(FilePath
, Content
, IsBinaryFile
):
1942 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)