2 # Routines for generating AutoGen.h and AutoGen.c
4 # Copyright (c) 2007 - 2012, 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.
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 (0x0U << PCD_TYPE_SHIFT)
71 #define PCD_TYPE_HII (0x8U << PCD_TYPE_SHIFT)
72 #define PCD_TYPE_VPD (0x4U << PCD_TYPE_SHIFT)
73 #define PCD_TYPE_SKU_ENABLED (0x2U << PCD_TYPE_SHIFT)
74 #define PCD_TYPE_STRING (0x1U << 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 (0x0U << PCD_DATUM_TYPE_SHIFT)
81 #define PCD_DATUM_TYPE_UINT8 (0x1U << PCD_DATUM_TYPE_SHIFT)
82 #define PCD_DATUM_TYPE_UINT16 (0x2U << PCD_DATUM_TYPE_SHIFT)
83 #define PCD_DATUM_TYPE_UINT32 (0x4U << PCD_DATUM_TYPE_SHIFT)
84 #define PCD_DATUM_TYPE_UINT64 (0x8U << 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 UINT32 StringIndex; // Offset in String Table in units of UINT32.
107 UINT32 DefaultValueOffset; // Offset of the Default Value
108 UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID.
109 UINT16 Offset; // Offset in Variable
116 typedef UINT32 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_Header[${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}${VARDEF_HEADER}) | ${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_Header[${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 gAutoGenHCppPrologueString
= """\
322 gAutoGenHEpilogueString
= """
331 ## PEI Core Entry Point Templates
332 gPeiCoreEntryPointPrototype
= TemplateString("""
337 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
338 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
344 gPeiCoreEntryPointString
= TemplateString("""
348 ProcessModuleEntryPointList (
349 IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
350 IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
355 ${Function} (SecCoreData, PpiList, Context);
361 ## DXE Core Entry Point Templates
362 gDxeCoreEntryPointPrototype
= TemplateString("""
372 gDxeCoreEntryPointString
= TemplateString("""
376 ProcessModuleEntryPointList (
381 ${Function} (HobStart);
386 ## PEIM Entry Point Templates
387 gPeimEntryPointPrototype
= TemplateString("""
392 IN EFI_PEI_FILE_HANDLE FileHandle,
393 IN CONST EFI_PEI_SERVICES **PeiServices
398 gPeimEntryPointString
= [
400 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
404 ProcessModuleEntryPointList (
405 IN EFI_PEI_FILE_HANDLE FileHandle,
406 IN CONST EFI_PEI_SERVICES **PeiServices
414 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
418 ProcessModuleEntryPointList (
419 IN EFI_PEI_FILE_HANDLE FileHandle,
420 IN CONST EFI_PEI_SERVICES **PeiServices
424 return ${Function} (FileHandle, PeiServices);
429 GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
433 ProcessModuleEntryPointList (
434 IN EFI_PEI_FILE_HANDLE FileHandle,
435 IN CONST EFI_PEI_SERVICES **PeiServices
440 EFI_STATUS CombinedStatus;
442 CombinedStatus = EFI_LOAD_ERROR;
444 Status = ${Function} (FileHandle, PeiServices);
445 if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
446 CombinedStatus = Status;
449 return CombinedStatus;
454 ## SMM_CORE Entry Point Templates
455 gSmmCoreEntryPointPrototype
= TemplateString("""
460 IN EFI_HANDLE ImageHandle,
461 IN EFI_SYSTEM_TABLE *SystemTable
466 gSmmCoreEntryPointString
= TemplateString("""
468 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
469 const UINT32 _gDxeRevision = ${PiSpecVersion};
473 ProcessModuleEntryPointList (
474 IN EFI_HANDLE ImageHandle,
475 IN EFI_SYSTEM_TABLE *SystemTable
478 return ${Function} (ImageHandle, SystemTable);
483 ## DXE SMM Entry Point Templates
484 gDxeSmmEntryPointPrototype
= TemplateString("""
489 IN EFI_HANDLE ImageHandle,
490 IN EFI_SYSTEM_TABLE *SystemTable
495 gDxeSmmEntryPointString
= [
497 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
498 const UINT32 _gDxeRevision = ${PiSpecVersion};
502 ProcessModuleEntryPointList (
503 IN EFI_HANDLE ImageHandle,
504 IN EFI_SYSTEM_TABLE *SystemTable
512 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
513 const UINT32 _gDxeRevision = ${PiSpecVersion};
515 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
516 static EFI_STATUS mDriverEntryPointStatus;
524 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
525 mDriverEntryPointStatus = Status;
527 LongJump (&mJumpContext, (UINTN)-1);
533 ProcessModuleEntryPointList (
534 IN EFI_HANDLE ImageHandle,
535 IN EFI_SYSTEM_TABLE *SystemTable
538 mDriverEntryPointStatus = EFI_LOAD_ERROR;
541 if (SetJump (&mJumpContext) == 0) {
542 ExitDriver (${Function} (ImageHandle, SystemTable));
547 return mDriverEntryPointStatus;
552 ## UEFI Driver Entry Point Templates
553 gUefiDriverEntryPointPrototype
= TemplateString("""
558 IN EFI_HANDLE ImageHandle,
559 IN EFI_SYSTEM_TABLE *SystemTable
564 gUefiDriverEntryPointString
= [
566 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
567 const UINT32 _gDxeRevision = ${PiSpecVersion};
571 ProcessModuleEntryPointList (
572 IN EFI_HANDLE ImageHandle,
573 IN EFI_SYSTEM_TABLE *SystemTable
580 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
581 const UINT32 _gDxeRevision = ${PiSpecVersion};
586 ProcessModuleEntryPointList (
587 IN EFI_HANDLE ImageHandle,
588 IN EFI_SYSTEM_TABLE *SystemTable
592 return ${Function} (ImageHandle, SystemTable);
601 if (EFI_ERROR (Status)) {
602 ProcessLibraryDestructorList (gImageHandle, gST);
604 gBS->Exit (gImageHandle, Status, 0, NULL);
608 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
609 const UINT32 _gDxeRevision = ${PiSpecVersion};
611 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
612 static EFI_STATUS mDriverEntryPointStatus;
616 ProcessModuleEntryPointList (
617 IN EFI_HANDLE ImageHandle,
618 IN EFI_SYSTEM_TABLE *SystemTable
621 mDriverEntryPointStatus = EFI_LOAD_ERROR;
623 if (SetJump (&mJumpContext) == 0) {
624 ExitDriver (${Function} (ImageHandle, SystemTable));
628 return mDriverEntryPointStatus;
637 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
638 mDriverEntryPointStatus = Status;
640 LongJump (&mJumpContext, (UINTN)-1);
647 ## UEFI Application Entry Point Templates
648 gUefiApplicationEntryPointPrototype
= TemplateString("""
653 IN EFI_HANDLE ImageHandle,
654 IN EFI_SYSTEM_TABLE *SystemTable
659 gUefiApplicationEntryPointString
= [
661 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
665 ProcessModuleEntryPointList (
666 IN EFI_HANDLE ImageHandle,
667 IN EFI_SYSTEM_TABLE *SystemTable
674 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
679 ProcessModuleEntryPointList (
680 IN EFI_HANDLE ImageHandle,
681 IN EFI_SYSTEM_TABLE *SystemTable
685 return ${Function} (ImageHandle, SystemTable);
694 if (EFI_ERROR (Status)) {
695 ProcessLibraryDestructorList (gImageHandle, gST);
697 gBS->Exit (gImageHandle, Status, 0, NULL);
701 const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
705 ProcessModuleEntryPointList (
706 IN EFI_HANDLE ImageHandle,
707 IN EFI_SYSTEM_TABLE *SystemTable
712 if (SetJump (&mJumpContext) == 0) {
713 ExitDriver (${Function} (ImageHandle, SystemTable));
717 return mDriverEntryPointStatus;
720 static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
721 static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
729 if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
730 mDriverEntryPointStatus = Status;
732 LongJump (&mJumpContext, (UINTN)-1);
738 ## UEFI Unload Image Templates
739 gUefiUnloadImagePrototype
= TemplateString("""
744 IN EFI_HANDLE ImageHandle
749 gUefiUnloadImageString
= [
751 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
755 ProcessModuleUnloadList (
756 IN EFI_HANDLE ImageHandle
763 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
768 ProcessModuleUnloadList (
769 IN EFI_HANDLE ImageHandle
772 return ${Function} (ImageHandle);
777 GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
781 ProcessModuleUnloadList (
782 IN EFI_HANDLE ImageHandle
787 Status = EFI_SUCCESS;
789 if (EFI_ERROR (Status)) {
790 ${Function} (ImageHandle);
792 Status = ${Function} (ImageHandle);
800 gLibraryStructorPrototype
= {
801 'BASE' : TemplateString("""${BEGIN}
809 'PEI' : TemplateString("""${BEGIN}
813 IN EFI_PEI_FILE_HANDLE FileHandle,
814 IN CONST EFI_PEI_SERVICES **PeiServices
818 'DXE' : TemplateString("""${BEGIN}
822 IN EFI_HANDLE ImageHandle,
823 IN EFI_SYSTEM_TABLE *SystemTable
828 gLibraryStructorCall
= {
829 'BASE' : TemplateString("""${BEGIN}
830 Status = ${Function} ();
831 ASSERT_EFI_ERROR (Status);${END}
834 'PEI' : TemplateString("""${BEGIN}
835 Status = ${Function} (FileHandle, PeiServices);
836 ASSERT_EFI_ERROR (Status);${END}
839 'DXE' : TemplateString("""${BEGIN}
840 Status = ${Function} (ImageHandle, SystemTable);
841 ASSERT_EFI_ERROR (Status);${END}
845 ## Library Constructor and Destructor Templates
847 'BASE' : TemplateString("""
848 ${BEGIN}${FunctionPrototype}${END}
852 ProcessLibrary${Type}List (
856 ${BEGIN} EFI_STATUS Status;
857 ${FunctionCall}${END}
861 'PEI' : TemplateString("""
862 ${BEGIN}${FunctionPrototype}${END}
866 ProcessLibrary${Type}List (
867 IN EFI_PEI_FILE_HANDLE FileHandle,
868 IN CONST EFI_PEI_SERVICES **PeiServices
871 ${BEGIN} EFI_STATUS Status;
872 ${FunctionCall}${END}
876 'DXE' : TemplateString("""
877 ${BEGIN}${FunctionPrototype}${END}
881 ProcessLibrary${Type}List (
882 IN EFI_HANDLE ImageHandle,
883 IN EFI_SYSTEM_TABLE *SystemTable
886 ${BEGIN} EFI_STATUS Status;
887 ${FunctionCall}${END}
892 gBasicHeaderFile
= "Base.h"
894 gModuleTypeHeaderFile
= {
895 "BASE" : [gBasicHeaderFile
],
896 "SEC" : ["PiPei.h", "Library/DebugLib.h"],
897 "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
898 "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
899 "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
900 "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
901 "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
902 "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
903 "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
904 "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
905 "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
906 "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
907 "USER_DEFINED" : [gBasicHeaderFile
]
910 ## Create code for module PCDs
912 # @param Info The ModuleAutoGen object
913 # @param AutoGenC The TemplateString object for C code
914 # @param AutoGenH The TemplateString object for header file
915 # @param Pcd The PCD object
917 def CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
918 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[Pcd.TokenSpaceGuidCName]
919 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
923 PcdTokenName
= '_PCD_TOKEN_' + Pcd
.TokenCName
924 if Pcd
.Type
in gDynamicExPcd
:
925 TokenNumber
= int(Pcd
.TokenValue
, 0)
927 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
928 EdkLogger
.error("build", AUTOGEN_ERROR
,
929 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
930 ExtraData
="[%s]" % str(Info
))
931 TokenNumber
= PcdTokenNumber
[Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
]
932 AutoGenH
.Append('\n#define %s %dU\n' % (PcdTokenName
, TokenNumber
))
934 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "Creating code for " + Pcd
.TokenCName
+ "." + Pcd
.TokenSpaceGuidCName
)
935 if Pcd
.Type
not in gItemTypeStringDatabase
:
936 EdkLogger
.error("build", AUTOGEN_ERROR
,
937 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
938 ExtraData
="[%s]" % str(Info
))
939 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
940 EdkLogger
.error("build", AUTOGEN_ERROR
,
941 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
942 ExtraData
="[%s]" % str(Info
))
944 DatumSize
= gDatumSizeStringDatabase
[Pcd
.DatumType
]
945 DatumSizeLib
= gDatumSizeStringDatabaseLib
[Pcd
.DatumType
]
946 GetModeName
= '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
947 SetModeName
= '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH
[Pcd
.DatumType
] + '_' + Pcd
.TokenCName
949 if Pcd
.Type
in gDynamicExPcd
:
950 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
951 if Pcd
.DatumType
== 'VOID*':
952 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
954 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, Pcd
.TokenSpaceGuidCName
, PcdTokenName
))
955 elif Pcd
.Type
in gDynamicPcd
:
956 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
957 if Pcd
.DatumType
== 'VOID*':
958 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
960 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
962 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[Pcd
.Type
] + '_' + Pcd
.TokenCName
964 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
968 Value
= Pcd
.DefaultValue
972 if Pcd
.DatumType
== 'BOOLEAN':
973 BoolValue
= Value
.upper()
974 if BoolValue
== 'TRUE' or BoolValue
== '1':
976 elif BoolValue
== 'FALSE' or BoolValue
== '0':
979 if Pcd
.DatumType
in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:
981 if Value
.upper().startswith('0X'):
982 ValueNumber
= int (Value
, 16)
984 ValueNumber
= int (Value
)
986 EdkLogger
.error("build", AUTOGEN_ERROR
,
987 "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
988 ExtraData
="[%s]" % str(Info
))
989 if Pcd
.DatumType
== 'UINT64':
991 EdkLogger
.error("build", AUTOGEN_ERROR
,
992 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
993 ExtraData
="[%s]" % str(Info
))
994 elif ValueNumber
>= 0x10000000000000000:
995 EdkLogger
.error("build", AUTOGEN_ERROR
,
996 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
997 ExtraData
="[%s]" % str(Info
))
998 if not Value
.endswith('ULL'):
1000 elif Pcd
.DatumType
== 'UINT32':
1002 EdkLogger
.error("build", AUTOGEN_ERROR
,
1003 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1004 ExtraData
="[%s]" % str(Info
))
1005 elif ValueNumber
>= 0x100000000:
1006 EdkLogger
.error("build", AUTOGEN_ERROR
,
1007 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1008 ExtraData
="[%s]" % str(Info
))
1009 if not Value
.endswith('U'):
1011 elif Pcd
.DatumType
== 'UINT16':
1013 EdkLogger
.error("build", AUTOGEN_ERROR
,
1014 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1015 ExtraData
="[%s]" % str(Info
))
1016 elif ValueNumber
>= 0x10000:
1017 EdkLogger
.error("build", AUTOGEN_ERROR
,
1018 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1019 ExtraData
="[%s]" % str(Info
))
1020 if not Value
.endswith('U'):
1022 elif Pcd
.DatumType
== 'UINT8':
1024 EdkLogger
.error("build", AUTOGEN_ERROR
,
1025 "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1026 ExtraData
="[%s]" % str(Info
))
1027 elif ValueNumber
>= 0x100:
1028 EdkLogger
.error("build", AUTOGEN_ERROR
,
1029 "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1030 ExtraData
="[%s]" % str(Info
))
1031 if not Value
.endswith('U'):
1033 if Pcd
.DatumType
== 'VOID*':
1034 if Pcd
.MaxDatumSize
== None or Pcd
.MaxDatumSize
== '':
1035 EdkLogger
.error("build", AUTOGEN_ERROR
,
1036 "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1037 ExtraData
="[%s]" % str(Info
))
1039 ArraySize
= int(Pcd
.MaxDatumSize
, 0)
1045 Value
= Value
.lstrip('L') #.strip('"')
1046 Value
= eval(Value
) # translate escape character
1048 for Index
in range(0,len(Value
)):
1050 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x10000) + ', '
1052 NewValue
= NewValue
+ str(ord(Value
[Index
]) % 0x100) + ', '
1054 ArraySize
= ArraySize
/ 2;
1056 if ArraySize
< (len(Value
) + 1):
1057 EdkLogger
.error("build", AUTOGEN_ERROR
,
1058 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1059 ExtraData
="[%s]" % str(Info
))
1060 Value
= NewValue
+ '0 }'
1061 Array
= '[%d]' % ArraySize
1063 # skip casting for fixed at build since it breaks ARM assembly.
1064 # Long term we need PCD macros that work in assembly
1066 elif Pcd
.Type
!= TAB_PCDS_FIXED_AT_BUILD
:
1067 Value
= "((%s)%s)" % (Pcd
.DatumType
, Value
)
1069 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1070 PcdValueName
= '_PCD_PATCHABLE_VALUE_' + Pcd
.TokenCName
1072 PcdValueName
= '_PCD_VALUE_' + Pcd
.TokenCName
1074 if Pcd
.DatumType
== 'VOID*':
1076 # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
1079 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
1080 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1081 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1082 AutoGenH
.Append('extern %s UINT16 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1083 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1085 AutoGenH
.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd
.TokenCName
, Pcd
.MaxDatumSize
))
1086 AutoGenH
.Append('#define %s %s%s\n' %(PcdValueName
, Type
, PcdVariableName
))
1087 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const
, PcdVariableName
, Array
, Value
))
1088 AutoGenH
.Append('extern %s UINT8 %s%s;\n' %(Const
, PcdVariableName
, Array
))
1089 AutoGenH
.Append('#define %s %s%s\n' %(GetModeName
, Type
, PcdVariableName
))
1090 elif Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1091 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1092 AutoGenC
.Append('volatile %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1093 AutoGenH
.Append('extern volatile %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1094 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1096 AutoGenH
.Append('#define %s %s\n' %(PcdValueName
, Value
))
1097 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const
, Pcd
.DatumType
, PcdVariableName
, PcdValueName
))
1098 AutoGenH
.Append('extern %s %s %s%s;\n' % (Const
, Pcd
.DatumType
, PcdVariableName
, Array
))
1099 AutoGenH
.Append('#define %s %s%s\n' % (GetModeName
, Type
, PcdVariableName
))
1101 if Pcd
.Type
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1102 if Pcd
.DatumType
== 'VOID*':
1103 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName
, Pcd
.TokenCName
, Pcd
.TokenCName
))
1105 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1107 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1109 ## Create code for library module PCDs
1111 # @param Info The ModuleAutoGen object
1112 # @param AutoGenC The TemplateString object for C code
1113 # @param AutoGenH The TemplateString object for header file
1114 # @param Pcd The PCD object
1116 def CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
):
1117 PcdTokenNumber
= Info
.PlatformInfo
.PcdTokenNumber
1118 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1119 TokenCName
= Pcd
.TokenCName
1120 TokenSpaceGuidValue
= Pcd
.TokenSpaceGuidValue
#Info.GuidList[TokenSpaceGuidCName]
1121 if (Pcd
.TokenCName
, Pcd
.TokenSpaceGuidCName
) not in PcdTokenNumber
:
1122 EdkLogger
.error("build", AUTOGEN_ERROR
,
1123 "No generated token number for %s.%s\n" % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1124 ExtraData
="[%s]" % str(Info
))
1125 TokenNumber
= PcdTokenNumber
[TokenCName
, TokenSpaceGuidCName
]
1127 # If PCD is DynamicEx, then use TokenNumber declared in DEC file
1128 if Pcd
.Type
in gDynamicExPcd
:
1129 TokenNumber
= int(Pcd
.TokenValue
, 0)
1131 if Pcd
.Type
not in gItemTypeStringDatabase
:
1132 EdkLogger
.error("build", AUTOGEN_ERROR
,
1133 "Unknown PCD type [%s] of PCD %s.%s" % (Pcd
.Type
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1134 ExtraData
="[%s]" % str(Info
))
1135 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1136 EdkLogger
.error("build", AUTOGEN_ERROR
,
1137 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1138 ExtraData
="[%s]" % str(Info
))
1140 DatumType
= Pcd
.DatumType
1141 DatumSize
= gDatumSizeStringDatabaseH
[DatumType
]
1142 DatumSizeLib
= gDatumSizeStringDatabaseLib
[DatumType
]
1143 GetModeName
= '_PCD_GET_MODE_' + DatumSize
+ '_' + TokenCName
1144 SetModeName
= '_PCD_SET_MODE_' + DatumSize
+ '_' + TokenCName
1148 if Pcd
.DatumType
== 'VOID*':
1152 AutoGenH
.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName
, TokenNumber
))
1154 PcdItemType
= Pcd
.Type
1155 #if PcdItemType in gDynamicPcd:
1156 # PcdItemType = TAB_PCDS_FIXED_AT_BUILD
1157 # if (TokenCName, TokenSpaceGuidCName) in Info.PlatformInfo.Platform.Pcds:
1158 # PcdItemType = Info.PlatformInfo.Platform.Pcds[TokenCName, TokenSpaceGuidCName].Type
1159 if PcdItemType
in gDynamicExPcd
:
1160 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1161 AutoGenH
.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName
, DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1162 if DatumType
== 'VOID*':
1163 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName
,DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1165 AutoGenH
.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName
, DatumSizeLib
, TokenSpaceGuidCName
, PcdTokenName
))
1166 if PcdItemType
in gDynamicPcd
:
1167 PcdTokenName
= '_PCD_TOKEN_' + TokenCName
1168 AutoGenH
.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName
, DatumSizeLib
, PcdTokenName
))
1169 if DatumType
== 'VOID*':
1170 AutoGenH
.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName
, DatumSizeLib
, PcdTokenName
))
1172 AutoGenH
.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName
, DatumSizeLib
, PcdTokenName
))
1173 if PcdItemType
== TAB_PCDS_PATCHABLE_IN_MODULE
:
1174 PcdVariableName
= '_gPcd_' + gItemTypeStringDatabase
[TAB_PCDS_PATCHABLE_IN_MODULE
] + '_' + TokenCName
1175 AutoGenH
.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType
, TokenCName
, Array
) )
1176 AutoGenH
.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName
, Type
, TokenCName
))
1177 AutoGenH
.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName
, PcdVariableName
))
1178 if PcdItemType
== TAB_PCDS_FIXED_AT_BUILD
or PcdItemType
== TAB_PCDS_FEATURE_FLAG
:
1179 AutoGenH
.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType
, TokenCName
, Array
))
1180 #AutoGenH.Append('#define _PCD_VALUE_%s _gPcd_FixedAtBuild_%s\n' %(TokenCName, TokenCName))
1181 AutoGenH
.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName
, Type
, TokenCName
))
1182 AutoGenH
.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName
)
1184 ## Create code for PCD database in DXE or PEI phase
1186 # @param Platform The platform object
1187 # @retval tuple Two TemplateString objects for C code and header file,
1190 def CreatePcdDatabasePhaseSpecificAutoGen (Platform
, Phase
):
1191 AutoGenC
= TemplateString()
1192 AutoGenH
= TemplateString()
1196 'GUID_TABLE_SIZE' : '1U',
1197 'STRING_TABLE_SIZE' : '1U',
1198 'SKUID_TABLE_SIZE' : '1U',
1199 'LOCAL_TOKEN_NUMBER_TABLE_SIZE' : '1U',
1200 'LOCAL_TOKEN_NUMBER' : '0U',
1201 'EXMAPPING_TABLE_SIZE' : '1U',
1202 'EX_TOKEN_NUMBER' : '0U',
1203 'SIZE_TABLE_SIZE' : '2U',
1204 'GUID_TABLE_EMPTY' : 'TRUE',
1205 'STRING_TABLE_EMPTY' : 'TRUE',
1206 'SKUID_TABLE_EMPTY' : 'TRUE',
1207 'DATABASE_EMPTY' : 'TRUE',
1208 'EXMAP_TABLE_EMPTY' : 'TRUE',
1209 'PCD_DATABASE_UNINIT_EMPTY' : ' UINT8 dummy; /* PCD_DATABASE_UNINIT is emptry */',
1210 'SYSTEM_SKU_ID' : ' SKU_ID SystemSkuId;',
1211 'SYSTEM_SKU_ID_VALUE' : '0U'
1214 for DatumType
in ['UINT64','UINT32','UINT16','UINT8','BOOLEAN', "VOID*"]:
1215 Dict
['VARDEF_CNAME_' + DatumType
] = []
1216 Dict
['VARDEF_GUID_' + DatumType
] = []
1217 Dict
['VARDEF_SKUID_' + DatumType
] = []
1218 Dict
['VARDEF_VALUE_' + DatumType
] = []
1219 for Init
in ['INIT','UNINIT']:
1220 Dict
[Init
+'_CNAME_DECL_' + DatumType
] = []
1221 Dict
[Init
+'_GUID_DECL_' + DatumType
] = []
1222 Dict
[Init
+'_NUMSKUS_DECL_' + DatumType
] = []
1223 Dict
[Init
+'_VALUE_' + DatumType
] = []
1225 for Type
in ['STRING_HEAD','VPD_HEAD','VARIABLE_HEAD']:
1226 Dict
[Type
+ '_CNAME_DECL'] = []
1227 Dict
[Type
+ '_GUID_DECL'] = []
1228 Dict
[Type
+ '_NUMSKUS_DECL'] = []
1229 Dict
[Type
+ '_VALUE'] = []
1231 Dict
['STRING_TABLE_INDEX'] = []
1232 Dict
['STRING_TABLE_LENGTH'] = []
1233 Dict
['STRING_TABLE_CNAME'] = []
1234 Dict
['STRING_TABLE_GUID'] = []
1235 Dict
['STRING_TABLE_VALUE'] = []
1237 Dict
['SIZE_TABLE_CNAME'] = []
1238 Dict
['SIZE_TABLE_GUID'] = []
1239 Dict
['SIZE_TABLE_CURRENT_LENGTH'] = []
1240 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'] = []
1242 Dict
['EXMAPPING_TABLE_EXTOKEN'] = []
1243 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'] = []
1244 Dict
['EXMAPPING_TABLE_GUID_INDEX'] = []
1246 Dict
['GUID_STRUCTURE'] = []
1248 Dict
['SKUID_VALUE'] = []
1249 Dict
['VARDEF_HEADER'] = []
1251 Dict
['SYSTEM_SKU_ID'] = ''
1252 Dict
['SYSTEM_SKU_ID_VALUE'] = ''
1254 StringTableIndex
= 0
1256 NumberOfLocalTokens
= 0
1257 NumberOfPeiLocalTokens
= 0
1258 NumberOfDxeLocalTokens
= 0
1259 NumberOfExTokens
= 0
1260 NumberOfSizeItems
= 0
1263 for Pcd
in Platform
.DynamicPcdList
:
1264 CName
= Pcd
.TokenCName
1265 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1267 EdkLogger
.debug(EdkLogger
.DEBUG_3
, "PCD: %s %s (%s : %s)" % (CName
, TokenSpaceGuidCName
, Pcd
.Phase
, Phase
))
1268 if Pcd
.DatumType
not in gDatumSizeStringDatabase
:
1269 EdkLogger
.error("build", AUTOGEN_ERROR
,
1270 "Unknown datum type [%s] of PCD %s.%s" % (Pcd
.DatumType
, Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1271 ExtraData
="[%s]" % str(Platform
))
1273 if Pcd
.Phase
== 'PEI':
1274 NumberOfPeiLocalTokens
+= 1
1275 if Pcd
.Phase
== 'DXE':
1276 NumberOfDxeLocalTokens
+= 1
1277 if Pcd
.Phase
!= Phase
:
1281 # TODO: need GetGuidValue() definition
1283 TokenSpaceGuidStructure
= Pcd
.TokenSpaceGuidValue
1284 TokenSpaceGuid
= GuidStructureStringToGuidValueName(TokenSpaceGuidStructure
)
1285 if Pcd
.Type
in gDynamicExPcd
:
1286 if TokenSpaceGuid
not in GuidList
:
1287 GuidList
+= [TokenSpaceGuid
]
1288 Dict
['GUID_STRUCTURE'].append(TokenSpaceGuidStructure
)
1289 NumberOfExTokens
+= 1
1292 StringHeadOffsetList
= []
1293 VpdHeadOffsetList
= []
1294 VariableHeadValueList
= []
1295 Pcd
.InitString
= 'UNINIT'
1297 if Pcd
.DatumType
== 'VOID*':
1298 if Pcd
.Type
not in ["DynamicVpd", "DynamicExVpd"]:
1299 Pcd
.TokenTypeList
= ['PCD_TYPE_STRING']
1301 Pcd
.TokenTypeList
= []
1302 elif Pcd
.DatumType
== 'BOOLEAN':
1303 Pcd
.TokenTypeList
= ['PCD_DATUM_TYPE_UINT8']
1305 Pcd
.TokenTypeList
= ['PCD_DATUM_TYPE_' + Pcd
.DatumType
]
1307 if len(Pcd
.SkuInfoList
) > 1:
1308 Pcd
.TokenTypeList
+= ['PCD_TYPE_SKU_ENABLED']
1310 for SkuName
in Pcd
.SkuInfoList
:
1311 Sku
= Pcd
.SkuInfoList
[SkuName
]
1313 if SkuId
== None or SkuId
== '':
1316 if (SkuId
+ 'U') not in Dict
['SKUID_VALUE']:
1317 Dict
['SKUID_VALUE'].append(SkuId
+ 'U')
1319 SkuIdIndex
= Dict
['SKUID_VALUE'].index(SkuId
+ 'U')
1320 if len(Sku
.VariableName
) > 0:
1321 Pcd
.TokenTypeList
+= ['PCD_TYPE_HII']
1322 Pcd
.InitString
= 'INIT'
1323 VariableNameStructure
= StringToArray(Sku
.VariableName
)
1324 if VariableNameStructure
not in Dict
['STRING_TABLE_VALUE']:
1325 Dict
['STRING_TABLE_CNAME'].append(CName
)
1326 Dict
['STRING_TABLE_GUID'].append(TokenSpaceGuid
)
1327 if StringTableIndex
== 0:
1328 Dict
['STRING_TABLE_INDEX'].append('')
1330 Dict
['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex
)
1332 Dict
['STRING_TABLE_LENGTH'].append((len(Sku
.VariableName
) - 3 + 1) * 2)
1333 Dict
['STRING_TABLE_VALUE'].append(VariableNameStructure
)
1334 StringTableIndex
+= 1
1335 StringTableSize
+= (len(Sku
.VariableName
) - 3 + 1) * 2
1337 VariableHeadStringIndex
= 0
1338 for Index
in range(Dict
['STRING_TABLE_VALUE'].index(VariableNameStructure
)):
1339 VariableHeadStringIndex
+= Dict
['STRING_TABLE_LENGTH'][Index
]
1341 VariableGuidStructure
= Sku
.VariableGuidValue
1342 VariableGuid
= GuidStructureStringToGuidValueName(VariableGuidStructure
)
1343 if VariableGuid
not in GuidList
:
1344 GuidList
+= [VariableGuid
]
1345 Dict
['GUID_STRUCTURE'].append(VariableGuidStructure
)
1346 VariableHeadGuidIndex
= GuidList
.index(VariableGuid
)
1348 if "PCD_TYPE_STRING" in Pcd
.TokenTypeList
:
1349 VariableHeadValueList
.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s), %dU, %sU' %
1350 (VariableHeadStringIndex
, Phase
, CName
, TokenSpaceGuid
,
1351 VariableHeadGuidIndex
, Sku
.VariableOffset
))
1353 VariableHeadValueList
.append('%dU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s), %dU, %sU' %
1354 (VariableHeadStringIndex
, Phase
, CName
, TokenSpaceGuid
, SkuIdIndex
,
1355 VariableHeadGuidIndex
, Sku
.VariableOffset
))
1356 Dict
['VARDEF_CNAME_'+Pcd
.DatumType
].append(CName
)
1357 Dict
['VARDEF_GUID_'+Pcd
.DatumType
].append(TokenSpaceGuid
)
1358 Dict
['VARDEF_SKUID_'+Pcd
.DatumType
].append(SkuIdIndex
)
1359 if "PCD_TYPE_STRING" in Pcd
.TokenTypeList
:
1360 Dict
['VARDEF_VALUE_' + Pcd
.DatumType
].append("%s_%s[%d]" % (Pcd
.TokenCName
, TokenSpaceGuid
, SkuIdIndex
))
1363 # ULL (for UINT64) or U(other integer type) should be append to avoid
1364 # warning under linux building environment.
1366 if Pcd
.DatumType
== "UINT64":
1367 Dict
['VARDEF_VALUE_'+Pcd
.DatumType
].append(Sku
.HiiDefaultValue
+ "ULL")
1368 elif Pcd
.DatumType
in ("UINT32", "UINT16", "UINT8"):
1369 Dict
['VARDEF_VALUE_'+Pcd
.DatumType
].append(Sku
.HiiDefaultValue
+ "U")
1370 elif Pcd
.DatumType
== "BOOLEAN":
1371 if Sku
.HiiDefaultValue
in ["1", "0"]:
1372 Dict
['VARDEF_VALUE_'+Pcd
.DatumType
].append(Sku
.HiiDefaultValue
+ "U")
1374 Dict
['VARDEF_VALUE_'+Pcd
.DatumType
].append(Sku
.HiiDefaultValue
)
1376 elif Sku
.VpdOffset
!= '':
1377 Pcd
.TokenTypeList
+= ['PCD_TYPE_VPD']
1378 Pcd
.InitString
= 'INIT'
1379 VpdHeadOffsetList
.append(str(Sku
.VpdOffset
) + 'U')
1382 if Pcd
.DatumType
== 'VOID*':
1383 Pcd
.TokenTypeList
+= ['PCD_TYPE_STRING']
1384 Pcd
.InitString
= 'INIT'
1385 if Sku
.HiiDefaultValue
!= '' and Sku
.DefaultValue
== '':
1386 Sku
.DefaultValue
= Sku
.HiiDefaultValue
1387 if Sku
.DefaultValue
!= '':
1388 NumberOfSizeItems
+= 1
1389 Dict
['STRING_TABLE_CNAME'].append(CName
)
1390 Dict
['STRING_TABLE_GUID'].append(TokenSpaceGuid
)
1392 if StringTableIndex
== 0:
1393 Dict
['STRING_TABLE_INDEX'].append('')
1395 Dict
['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex
)
1396 if Sku
.DefaultValue
[0] == 'L':
1397 Size
= (len(Sku
.DefaultValue
) - 3 + 1) * 2
1398 Dict
['STRING_TABLE_VALUE'].append(StringToArray(Sku
.DefaultValue
))
1399 elif Sku
.DefaultValue
[0] == '"':
1400 Size
= len(Sku
.DefaultValue
) - 2 + 1
1401 Dict
['STRING_TABLE_VALUE'].append(StringToArray(Sku
.DefaultValue
))
1402 elif Sku
.DefaultValue
[0] == '{':
1403 Size
= len(Sku
.DefaultValue
.replace(',',' ').split())
1404 Dict
['STRING_TABLE_VALUE'].append(Sku
.DefaultValue
)
1406 StringHeadOffsetList
.append(str(StringTableSize
) + 'U')
1407 Dict
['SIZE_TABLE_CNAME'].append(CName
)
1408 Dict
['SIZE_TABLE_GUID'].append(TokenSpaceGuid
)
1409 Dict
['SIZE_TABLE_CURRENT_LENGTH'].append(str(Size
) + 'U')
1410 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'].append(str(Pcd
.MaxDatumSize
) + 'U')
1411 if Pcd
.MaxDatumSize
!= '':
1412 MaxDatumSize
= int(Pcd
.MaxDatumSize
, 0)
1413 if MaxDatumSize
< Size
:
1414 EdkLogger
.error("build", AUTOGEN_ERROR
,
1415 "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd
.TokenSpaceGuidCName
, Pcd
.TokenCName
),
1416 ExtraData
="[%s]" % str(Platform
))
1418 Dict
['STRING_TABLE_LENGTH'].append(Size
)
1419 StringTableIndex
+= 1
1420 StringTableSize
+= (Size
)
1422 if "PCD_TYPE_HII" not in Pcd
.TokenTypeList
:
1423 Pcd
.TokenTypeList
+= ['PCD_TYPE_DATA']
1424 if Sku
.DefaultValue
== 'TRUE':
1425 Pcd
.InitString
= 'INIT'
1428 if int(Sku
.DefaultValue
, 0) != 0:
1429 Pcd
.InitString
= 'INIT'
1434 # For UNIT64 type PCD's value, ULL should be append to avoid
1435 # warning under linux building environment.
1437 if Pcd
.DatumType
== "UINT64":
1438 ValueList
.append(Sku
.DefaultValue
+ "ULL")
1439 elif Pcd
.DatumType
in ("UINT32", "UINT16", "UINT8"):
1440 ValueList
.append(Sku
.DefaultValue
+ "U")
1441 elif Pcd
.DatumType
== "BOOLEAN":
1442 if Sku
.DefaultValue
in ["1", "0"]:
1443 ValueList
.append(Sku
.DefaultValue
+ "U")
1445 ValueList
.append(Sku
.DefaultValue
)
1447 Pcd
.TokenTypeList
= list(set(Pcd
.TokenTypeList
))
1450 if 'PCD_TYPE_HII' in Pcd
.TokenTypeList
:
1451 Dict
['VARIABLE_HEAD_CNAME_DECL'].append(CName
)
1452 Dict
['VARIABLE_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1453 Dict
['VARIABLE_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1454 Dict
['VARIABLE_HEAD_VALUE'].append('{ %s }\n' % ' },\n { '.join(VariableHeadValueList
))
1455 Dict
['VARDEF_HEADER'].append('_Variable_Header')
1457 Dict
['VARDEF_HEADER'].append('')
1458 if 'PCD_TYPE_VPD' in Pcd
.TokenTypeList
:
1459 Dict
['VPD_HEAD_CNAME_DECL'].append(CName
)
1460 Dict
['VPD_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1461 Dict
['VPD_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1462 Dict
['VPD_HEAD_VALUE'].append('{ %s }' % ' }, { '.join(VpdHeadOffsetList
))
1463 if 'PCD_TYPE_STRING' in Pcd
.TokenTypeList
:
1464 Dict
['STRING_HEAD_CNAME_DECL'].append(CName
)
1465 Dict
['STRING_HEAD_GUID_DECL'].append(TokenSpaceGuid
)
1466 Dict
['STRING_HEAD_NUMSKUS_DECL'].append(len(Pcd
.SkuInfoList
))
1467 Dict
['STRING_HEAD_VALUE'].append(', '.join(StringHeadOffsetList
))
1468 if 'PCD_TYPE_DATA' in Pcd
.TokenTypeList
:
1469 Dict
[Pcd
.InitString
+'_CNAME_DECL_'+Pcd
.DatumType
].append(CName
)
1470 Dict
[Pcd
.InitString
+'_GUID_DECL_'+Pcd
.DatumType
].append(TokenSpaceGuid
)
1471 Dict
[Pcd
.InitString
+'_NUMSKUS_DECL_'+Pcd
.DatumType
].append(len(Pcd
.SkuInfoList
))
1472 if Pcd
.InitString
== 'UNINIT':
1473 Dict
['PCD_DATABASE_UNINIT_EMPTY'] = ''
1475 Dict
[Pcd
.InitString
+'_VALUE_'+Pcd
.DatumType
].append(', '.join(ValueList
))
1478 NumberOfLocalTokens
= NumberOfPeiLocalTokens
1480 NumberOfLocalTokens
= NumberOfDxeLocalTokens
1482 Dict
['TOKEN_INIT'] = ['' for x
in range(NumberOfLocalTokens
)]
1483 Dict
['TOKEN_CNAME'] = ['' for x
in range(NumberOfLocalTokens
)]
1484 Dict
['TOKEN_GUID'] = ['' for x
in range(NumberOfLocalTokens
)]
1485 Dict
['TOKEN_TYPE'] = ['' for x
in range(NumberOfLocalTokens
)]
1487 for Pcd
in Platform
.DynamicPcdList
:
1488 CName
= Pcd
.TokenCName
1489 TokenSpaceGuidCName
= Pcd
.TokenSpaceGuidCName
1490 if Pcd
.Phase
!= Phase
:
1493 TokenSpaceGuid
= GuidStructureStringToGuidValueName(Pcd
.TokenSpaceGuidValue
) #(Platform.PackageList, TokenSpaceGuidCName))
1494 GeneratedTokenNumber
= Platform
.PcdTokenNumber
[CName
, TokenSpaceGuidCName
] - 1
1496 GeneratedTokenNumber
-= NumberOfPeiLocalTokens
1498 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "PCD = %s.%s" % (CName
, TokenSpaceGuidCName
))
1499 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "phase = %s" % Phase
)
1500 EdkLogger
.debug(EdkLogger
.DEBUG_1
, "GeneratedTokenNumber = %s" % str(GeneratedTokenNumber
))
1502 Dict
['TOKEN_INIT'][GeneratedTokenNumber
] = 'Init'
1503 if Pcd
.InitString
== 'UNINIT':
1504 Dict
['TOKEN_INIT'][GeneratedTokenNumber
] = 'Uninit'
1505 Dict
['TOKEN_CNAME'][GeneratedTokenNumber
] = CName
1506 Dict
['TOKEN_GUID'][GeneratedTokenNumber
] = TokenSpaceGuid
1507 Dict
['TOKEN_TYPE'][GeneratedTokenNumber
] = ' | '.join(Pcd
.TokenTypeList
)
1509 Pcd
.TokenTypeList
= list(set(Pcd
.TokenTypeList
))
1511 # Update VARDEF_HEADER
1513 if 'PCD_TYPE_HII' in Pcd
.TokenTypeList
:
1514 Dict
['VARDEF_HEADER'][GeneratedTokenNumber
] = '_Variable_Header'
1516 Dict
['VARDEF_HEADER'][GeneratedTokenNumber
] = ''
1519 if Pcd
.Type
in gDynamicExPcd
:
1520 Dict
['EXMAPPING_TABLE_EXTOKEN'].append(str(Pcd
.TokenValue
) + 'U')
1522 GeneratedTokenNumber
+= NumberOfPeiLocalTokens
1524 # Per, PCD architecture specification, PCD Token Number is 1 based and 0 is defined as invalid token number.
1525 # For each EX type PCD, a PCD Token Number is assigned. When the
1526 # PCD Driver/PEIM map EX_GUID and EX_TOKEN_NUMBER to the PCD Token Number,
1527 # the non-EX Protocol/PPI interface can be called to get/set the value. This assumption is made by
1528 # Pcd Driver/PEIM in MdeModulePkg.
1529 # Therefore, 1 is added to GeneratedTokenNumber to generate a PCD Token Number before being inserted
1530 # to the EXMAPPING_TABLE.
1532 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'].append(str(GeneratedTokenNumber
+ 1) + 'U')
1533 Dict
['EXMAPPING_TABLE_GUID_INDEX'].append(str(GuidList
.index(TokenSpaceGuid
)) + 'U')
1536 Dict
['GUID_TABLE_EMPTY'] = 'FALSE'
1537 Dict
['GUID_TABLE_SIZE'] = str(len(GuidList
)) + 'U'
1539 Dict
['GUID_STRUCTURE'] = [GuidStringToGuidStructureString('00000000-0000-0000-0000-000000000000')]
1541 if StringTableIndex
== 0:
1542 Dict
['STRING_TABLE_INDEX'].append('')
1543 Dict
['STRING_TABLE_LENGTH'].append(1)
1544 Dict
['STRING_TABLE_CNAME'].append('')
1545 Dict
['STRING_TABLE_GUID'].append('')
1546 Dict
['STRING_TABLE_VALUE'].append('{ 0 }')
1548 Dict
['STRING_TABLE_EMPTY'] = 'FALSE'
1549 Dict
['STRING_TABLE_SIZE'] = str(StringTableSize
) + 'U'
1551 if Dict
['SIZE_TABLE_CNAME'] == []:
1552 Dict
['SIZE_TABLE_CNAME'].append('')
1553 Dict
['SIZE_TABLE_GUID'].append('')
1554 Dict
['SIZE_TABLE_CURRENT_LENGTH'].append('0U')
1555 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'].append('0U')
1557 if NumberOfLocalTokens
!= 0:
1558 Dict
['DATABASE_EMPTY'] = 'FALSE'
1559 Dict
['LOCAL_TOKEN_NUMBER_TABLE_SIZE'] = NumberOfLocalTokens
1560 Dict
['LOCAL_TOKEN_NUMBER'] = NumberOfLocalTokens
1562 if NumberOfExTokens
!= 0:
1563 Dict
['EXMAP_TABLE_EMPTY'] = 'FALSE'
1564 Dict
['EXMAPPING_TABLE_SIZE'] = str(NumberOfExTokens
) + 'U'
1565 Dict
['EX_TOKEN_NUMBER'] = str(NumberOfExTokens
) + 'U'
1567 Dict
['EXMAPPING_TABLE_EXTOKEN'].append('0U')
1568 Dict
['EXMAPPING_TABLE_LOCAL_TOKEN'].append('0U')
1569 Dict
['EXMAPPING_TABLE_GUID_INDEX'].append('0U')
1571 if NumberOfSizeItems
!= 0:
1572 Dict
['SIZE_TABLE_SIZE'] = str(NumberOfSizeItems
* 2) + 'U'
1574 AutoGenH
.Append(gPcdDatabaseAutoGenH
.Replace(Dict
))
1575 if NumberOfLocalTokens
== 0:
1576 AutoGenC
.Append(gEmptyPcdDatabaseAutoGenC
.Replace(Dict
))
1579 # Update Size Table to the right order, it should be same with LocalTokenNumberTable
1581 SizeCNameTempList
= []
1582 SizeGuidTempList
= []
1583 SizeCurLenTempList
= []
1584 SizeMaxLenTempList
= []
1587 if len(Dict
['SIZE_TABLE_CNAME']) == 1:
1588 if not (Dict
['SIZE_TABLE_CNAME'][0] and Dict
['SIZE_TABLE_GUID'][0]):
1592 for Count
in range(len(Dict
['TOKEN_CNAME'])):
1593 for Count1
in range(len(Dict
['SIZE_TABLE_CNAME'])):
1594 if Dict
['TOKEN_CNAME'][Count
] == Dict
['SIZE_TABLE_CNAME'][Count1
] and \
1595 Dict
['TOKEN_GUID'][Count
] == Dict
['SIZE_TABLE_GUID'][Count1
]:
1596 SizeCNameTempList
.append(Dict
['SIZE_TABLE_CNAME'][Count1
])
1597 SizeGuidTempList
.append(Dict
['SIZE_TABLE_GUID'][Count1
])
1598 SizeCurLenTempList
.append(Dict
['SIZE_TABLE_CURRENT_LENGTH'][Count1
])
1599 SizeMaxLenTempList
.append(Dict
['SIZE_TABLE_MAXIMUM_LENGTH'][Count1
])
1601 for Count
in range(len(Dict
['SIZE_TABLE_CNAME'])):
1602 Dict
['SIZE_TABLE_CNAME'][Count
] = SizeCNameTempList
[Count
]
1603 Dict
['SIZE_TABLE_GUID'][Count
] = SizeGuidTempList
[Count
]
1604 Dict
['SIZE_TABLE_CURRENT_LENGTH'][Count
] = SizeCurLenTempList
[Count
]
1605 Dict
['SIZE_TABLE_MAXIMUM_LENGTH'][Count
] = SizeMaxLenTempList
[Count
]
1607 AutoGenC
.Append(gPcdDatabaseAutoGenC
.Replace(Dict
))
1609 return AutoGenH
, AutoGenC
1611 ## Create code for PCD database
1613 # @param Info The ModuleAutoGen object
1614 # @param AutoGenC The TemplateString object for C code
1615 # @param AutoGenH The TemplateString object for header file
1617 def CreatePcdDatabaseCode (Info
, AutoGenC
, AutoGenH
):
1618 if Info
.PcdIsDriver
== "":
1620 if Info
.PcdIsDriver
not in gPcdPhaseMap
:
1621 EdkLogger
.error("build", AUTOGEN_ERROR
, "Not supported PcdIsDriver type:%s" % Info
.PcdIsDriver
,
1622 ExtraData
="[%s]" % str(Info
))
1624 AutoGenH
.Append(gPcdDatabaseCommonAutoGenH
)
1625 AdditionalAutoGenH
, AdditionalAutoGenC
= CreatePcdDatabasePhaseSpecificAutoGen (Info
.PlatformInfo
, 'PEI')
1626 AutoGenH
.Append(AdditionalAutoGenH
.String
)
1628 Phase
= gPcdPhaseMap
[Info
.PcdIsDriver
]
1630 AutoGenC
.Append(AdditionalAutoGenC
.String
)
1633 AdditionalAutoGenH
, AdditionalAutoGenC
= CreatePcdDatabasePhaseSpecificAutoGen (Info
.PlatformInfo
, Phase
)
1634 AutoGenH
.Append(AdditionalAutoGenH
.String
)
1635 AutoGenC
.Append(AdditionalAutoGenC
.String
)
1636 AutoGenH
.Append(gPcdDatabaseEpilogueAutoGenH
)
1638 ## Create code for library constructor
1640 # @param Info The ModuleAutoGen object
1641 # @param AutoGenC The TemplateString object for C code
1642 # @param AutoGenH The TemplateString object for header file
1644 def CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
):
1646 # Library Constructors
1648 ConstructorPrototypeString
= TemplateString()
1649 ConstructorCallingString
= TemplateString()
1651 DependentLibraryList
= [Info
.Module
]
1653 DependentLibraryList
= Info
.DependentLibraryList
1654 for Lib
in DependentLibraryList
:
1655 if len(Lib
.ConstructorList
) <= 0:
1657 Dict
= {'Function':Lib
.ConstructorList
}
1658 if Lib
.ModuleType
in ['BASE', 'SEC']:
1659 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1660 ConstructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1661 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1662 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1663 ConstructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1664 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1665 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1666 ConstructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1667 ConstructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1669 if str(ConstructorPrototypeString
) == '':
1670 ConstructorPrototypeList
= []
1672 ConstructorPrototypeList
= [str(ConstructorPrototypeString
)]
1673 if str(ConstructorCallingString
) == '':
1674 ConstructorCallingList
= []
1676 ConstructorCallingList
= [str(ConstructorCallingString
)]
1679 'Type' : 'Constructor',
1680 'FunctionPrototype' : ConstructorPrototypeList
,
1681 'FunctionCall' : ConstructorCallingList
1684 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1686 if Info
.ModuleType
in ['BASE', 'SEC']:
1687 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1688 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1689 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1690 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1691 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1692 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1694 ## Create code for library destructor
1696 # @param Info The ModuleAutoGen object
1697 # @param AutoGenC The TemplateString object for C code
1698 # @param AutoGenH The TemplateString object for header file
1700 def CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
):
1702 # Library Destructors
1704 DestructorPrototypeString
= TemplateString()
1705 DestructorCallingString
= TemplateString()
1707 DependentLibraryList
= [Info
.Module
]
1709 DependentLibraryList
= Info
.DependentLibraryList
1710 for Index
in range(len(DependentLibraryList
)-1, -1, -1):
1711 Lib
= DependentLibraryList
[Index
]
1712 if len(Lib
.DestructorList
) <= 0:
1714 Dict
= {'Function':Lib
.DestructorList
}
1715 if Lib
.ModuleType
in ['BASE', 'SEC']:
1716 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['BASE'].Replace(Dict
))
1717 DestructorCallingString
.Append(gLibraryStructorCall
['BASE'].Replace(Dict
))
1718 elif Lib
.ModuleType
in ['PEI_CORE','PEIM']:
1719 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['PEI'].Replace(Dict
))
1720 DestructorCallingString
.Append(gLibraryStructorCall
['PEI'].Replace(Dict
))
1721 elif Lib
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1722 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:
1723 DestructorPrototypeString
.Append(gLibraryStructorPrototype
['DXE'].Replace(Dict
))
1724 DestructorCallingString
.Append(gLibraryStructorCall
['DXE'].Replace(Dict
))
1726 if str(DestructorPrototypeString
) == '':
1727 DestructorPrototypeList
= []
1729 DestructorPrototypeList
= [str(DestructorPrototypeString
)]
1730 if str(DestructorCallingString
) == '':
1731 DestructorCallingList
= []
1733 DestructorCallingList
= [str(DestructorCallingString
)]
1736 'Type' : 'Destructor',
1737 'FunctionPrototype' : DestructorPrototypeList
,
1738 'FunctionCall' : DestructorCallingList
1741 AutoGenH
.Append("${BEGIN}${FunctionPrototype}${END}", Dict
)
1743 if Info
.ModuleType
in ['BASE', 'SEC']:
1744 AutoGenC
.Append(gLibraryString
['BASE'].Replace(Dict
))
1745 elif Info
.ModuleType
in ['PEI_CORE','PEIM']:
1746 AutoGenC
.Append(gLibraryString
['PEI'].Replace(Dict
))
1747 elif Info
.ModuleType
in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
1748 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
1749 AutoGenC
.Append(gLibraryString
['DXE'].Replace(Dict
))
1752 ## Create code for ModuleEntryPoint
1754 # @param Info The ModuleAutoGen object
1755 # @param AutoGenC The TemplateString object for C code
1756 # @param AutoGenH The TemplateString object for header file
1758 def CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
):
1759 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1762 # Module Entry Points
1764 NumEntryPoints
= len(Info
.Module
.ModuleEntryPointList
)
1765 if 'PI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1766 PiSpecVersion
= Info
.Module
.Specification
['PI_SPECIFICATION_VERSION']
1768 PiSpecVersion
= '0x00000000'
1769 if 'UEFI_SPECIFICATION_VERSION' in Info
.Module
.Specification
:
1770 UefiSpecVersion
= Info
.Module
.Specification
['UEFI_SPECIFICATION_VERSION']
1772 UefiSpecVersion
= '0x00000000'
1774 'Function' : Info
.Module
.ModuleEntryPointList
,
1775 'PiSpecVersion' : PiSpecVersion
+ 'U',
1776 'UefiSpecVersion': UefiSpecVersion
+ 'U'
1779 if Info
.ModuleType
in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:
1780 if Info
.SourceFileList
<> None and Info
.SourceFileList
<> []:
1781 if NumEntryPoints
!= 1:
1785 '%s must have exactly one entry point' % Info
.ModuleType
,
1787 ExtraData
= ", ".join(Info
.Module
.ModuleEntryPointList
)
1789 if Info
.ModuleType
== 'PEI_CORE':
1790 AutoGenC
.Append(gPeiCoreEntryPointString
.Replace(Dict
))
1791 AutoGenH
.Append(gPeiCoreEntryPointPrototype
.Replace(Dict
))
1792 elif Info
.ModuleType
== 'DXE_CORE':
1793 AutoGenC
.Append(gDxeCoreEntryPointString
.Replace(Dict
))
1794 AutoGenH
.Append(gDxeCoreEntryPointPrototype
.Replace(Dict
))
1795 elif Info
.ModuleType
== 'SMM_CORE':
1796 AutoGenC
.Append(gSmmCoreEntryPointString
.Replace(Dict
))
1797 AutoGenH
.Append(gSmmCoreEntryPointPrototype
.Replace(Dict
))
1798 elif Info
.ModuleType
== 'PEIM':
1799 if NumEntryPoints
< 2:
1800 AutoGenC
.Append(gPeimEntryPointString
[NumEntryPoints
].Replace(Dict
))
1802 AutoGenC
.Append(gPeimEntryPointString
[2].Replace(Dict
))
1803 AutoGenH
.Append(gPeimEntryPointPrototype
.Replace(Dict
))
1804 elif Info
.ModuleType
in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
1805 if NumEntryPoints
< 2:
1806 AutoGenC
.Append(gUefiDriverEntryPointString
[NumEntryPoints
].Replace(Dict
))
1808 AutoGenC
.Append(gUefiDriverEntryPointString
[2].Replace(Dict
))
1809 AutoGenH
.Append(gUefiDriverEntryPointPrototype
.Replace(Dict
))
1810 elif Info
.ModuleType
== 'DXE_SMM_DRIVER':
1811 if NumEntryPoints
== 0:
1812 AutoGenC
.Append(gDxeSmmEntryPointString
[0].Replace(Dict
))
1814 AutoGenC
.Append(gDxeSmmEntryPointString
[1].Replace(Dict
))
1815 AutoGenH
.Append(gDxeSmmEntryPointPrototype
.Replace(Dict
))
1816 elif Info
.ModuleType
== 'UEFI_APPLICATION':
1817 if NumEntryPoints
< 2:
1818 AutoGenC
.Append(gUefiApplicationEntryPointString
[NumEntryPoints
].Replace(Dict
))
1820 AutoGenC
.Append(gUefiApplicationEntryPointString
[2].Replace(Dict
))
1821 AutoGenH
.Append(gUefiApplicationEntryPointPrototype
.Replace(Dict
))
1823 ## Create code for ModuleUnloadImage
1825 # @param Info The ModuleAutoGen object
1826 # @param AutoGenC The TemplateString object for C code
1827 # @param AutoGenH The TemplateString object for header file
1829 def CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
):
1830 if Info
.IsLibrary
or Info
.ModuleType
in ['USER_DEFINED', 'SEC']:
1833 # Unload Image Handlers
1835 NumUnloadImage
= len(Info
.Module
.ModuleUnloadImageList
)
1836 Dict
= {'Count':str(NumUnloadImage
) + 'U', 'Function':Info
.Module
.ModuleUnloadImageList
}
1837 if NumUnloadImage
< 2:
1838 AutoGenC
.Append(gUefiUnloadImageString
[NumUnloadImage
].Replace(Dict
))
1840 AutoGenC
.Append(gUefiUnloadImageString
[2].Replace(Dict
))
1841 AutoGenH
.Append(gUefiUnloadImagePrototype
.Replace(Dict
))
1843 ## Create code for GUID
1845 # @param Info The ModuleAutoGen object
1846 # @param AutoGenC The TemplateString object for C code
1847 # @param AutoGenH The TemplateString object for header file
1849 def CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1853 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1856 GuidType
= "EFI_GUID"
1859 AutoGenC
.Append("\n// Guids\n")
1863 for Key
in Info
.GuidList
:
1864 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.GuidList
[Key
]))
1866 ## Create code for protocol
1868 # @param Info The ModuleAutoGen object
1869 # @param AutoGenC The TemplateString object for C code
1870 # @param AutoGenH The TemplateString object for header file
1872 def CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1876 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1879 GuidType
= "EFI_GUID"
1881 if Info
.ProtocolList
:
1882 AutoGenC
.Append("\n// Protocols\n")
1886 for Key
in Info
.ProtocolList
:
1887 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.ProtocolList
[Key
]))
1889 ## Create code for PPI
1891 # @param Info The ModuleAutoGen object
1892 # @param AutoGenC The TemplateString object for C code
1893 # @param AutoGenH The TemplateString object for header file
1895 def CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
):
1899 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1902 GuidType
= "EFI_GUID"
1905 AutoGenC
.Append("\n// PPIs\n")
1909 for Key
in Info
.PpiList
:
1910 AutoGenC
.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType
, Key
, Info
.PpiList
[Key
]))
1912 ## Create code for PCD
1914 # @param Info The ModuleAutoGen object
1915 # @param AutoGenC The TemplateString object for C code
1916 # @param AutoGenH The TemplateString object for header file
1918 def CreatePcdCode(Info
, AutoGenC
, AutoGenH
):
1920 # Collect Token Space GUIDs used by DynamicEc PCDs
1922 for Pcd
in Info
.ModulePcdList
:
1923 if Pcd
.Type
in gDynamicExPcd
and Pcd
.TokenSpaceGuidCName
not in TokenSpaceList
:
1924 TokenSpaceList
+= [Pcd
.TokenSpaceGuidCName
]
1926 # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
1927 if TokenSpaceList
<> []:
1928 AutoGenH
.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
1929 if Info
.ModuleType
in ["USER_DEFINED", "BASE"]:
1932 GuidType
= "EFI_GUID"
1933 for Item
in TokenSpaceList
:
1934 AutoGenH
.Append('extern %s %s;\n' % (GuidType
, Item
))
1937 if Info
.ModulePcdList
:
1938 AutoGenH
.Append("\n// PCD definitions\n")
1939 for Pcd
in Info
.ModulePcdList
:
1940 CreateLibraryPcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1942 if Info
.ModulePcdList
:
1943 AutoGenH
.Append("\n// Definition of PCDs used in this module\n")
1944 AutoGenC
.Append("\n// Definition of PCDs used in this module\n")
1945 for Pcd
in Info
.ModulePcdList
:
1946 CreateModulePcdCode(Info
, AutoGenC
, AutoGenH
, Pcd
)
1948 if Info
.LibraryPcdList
:
1949 AutoGenH
.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
1950 AutoGenC
.Append("\n// Definition of PCDs used in libraries\n")
1951 for Pcd
in Info
.LibraryPcdList
:
1952 CreateModulePcdCode(Info
, AutoGenC
, AutoGenC
, Pcd
)
1953 CreatePcdDatabaseCode(Info
, AutoGenC
, AutoGenH
)
1955 ## Create code for unicode string definition
1957 # @param Info The ModuleAutoGen object
1958 # @param AutoGenC The TemplateString object for C code
1959 # @param AutoGenH The TemplateString object for header file
1960 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
1961 # @param UniGenBinBuffer Buffer to store uni string package data
1963 def CreateUnicodeStringCode(Info
, AutoGenC
, AutoGenH
, UniGenCFlag
, UniGenBinBuffer
):
1964 WorkingDir
= os
.getcwd()
1965 os
.chdir(Info
.WorkspaceDir
)
1967 IncList
= [Info
.MetaFile
.Dir
]
1968 # Get all files under [Sources] section in inf file for EDK-II module
1970 SrcList
= [F
for F
in Info
.SourceFileList
]
1971 if Info
.AutoGenVersion
< 0x00010005:
1973 # Get all files under the module directory for EDK-I module
1975 os
.chdir(Info
.MetaFile
.Dir
)
1976 for Root
, Dirs
, Files
in os
.walk("."):
1982 File
= PathClass(os
.path
.join(Root
, File
), Info
.MetaFile
.Dir
)
1985 SrcList
.append(File
)
1988 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-c') > -1:
1989 CompatibleMode
= True
1991 CompatibleMode
= False
1994 # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
1996 if 'BUILD' in Info
.BuildOption
and Info
.BuildOption
['BUILD']['FLAGS'].find('-s') > -1:
1998 EdkLogger
.error("build", AUTOGEN_ERROR
,
1999 "-c and -s build options should be used exclusively",
2000 ExtraData
="[%s]" % str(Info
))
2005 #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
2007 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.RFCLanguages
]
2009 FilterInfo
= [EDK2Module
] + [Info
.PlatformInfo
.Platform
.ISOLanguages
]
2010 Header
, Code
= GetStringFiles(Info
.UnicodeFileList
, SrcList
, IncList
, Info
.IncludePathList
, ['.uni', '.inf'], Info
.Name
, CompatibleMode
, ShellMode
, UniGenCFlag
, UniGenBinBuffer
, FilterInfo
)
2011 if CompatibleMode
or UniGenCFlag
:
2012 AutoGenC
.Append("\n//\n//Unicode String Pack Definition\n//\n")
2013 AutoGenC
.Append(Code
)
2014 AutoGenC
.Append("\n")
2015 AutoGenH
.Append("\n//\n//Unicode String ID\n//\n")
2016 AutoGenH
.Append(Header
)
2017 if CompatibleMode
or UniGenCFlag
:
2018 AutoGenH
.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info
.Name
)
2019 os
.chdir(WorkingDir
)
2021 ## Create common code
2023 # @param Info The ModuleAutoGen object
2024 # @param AutoGenC The TemplateString object for C code
2025 # @param AutoGenH The TemplateString object for header file
2027 def CreateHeaderCode(Info
, AutoGenC
, AutoGenH
):
2029 AutoGenH
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.h'}))
2030 # header file Prologue
2031 AutoGenH
.Append(gAutoGenHPrologueString
.Replace({'File':'AUTOGENH','Guid':Info
.Guid
.replace('-','_')}))
2032 AutoGenH
.Append(gAutoGenHCppPrologueString
)
2033 if Info
.AutoGenVersion
>= 0x00010005:
2034 # header files includes
2035 AutoGenH
.Append("#include <%s>\n" % gBasicHeaderFile
)
2036 if Info
.ModuleType
in gModuleTypeHeaderFile \
2037 and gModuleTypeHeaderFile
[Info
.ModuleType
][0] != gBasicHeaderFile
:
2038 AutoGenH
.Append("#include <%s>\n" % gModuleTypeHeaderFile
[Info
.ModuleType
][0])
2040 # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
2041 # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
2043 if 'PcdLib' in Info
.Module
.LibraryClasses
or Info
.Module
.Pcds
:
2044 AutoGenH
.Append("#include <Library/PcdLib.h>\n")
2046 AutoGenH
.Append('\nextern GUID gEfiCallerIdGuid;\n\n')
2051 AutoGenH
.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info
.Guid
))
2056 AutoGenC
.Append(gAutoGenHeaderString
.Replace({'FileName':'AutoGen.c'}))
2057 if Info
.AutoGenVersion
>= 0x00010005:
2058 # C file header files includes
2059 if Info
.ModuleType
in gModuleTypeHeaderFile
:
2060 for Inc
in gModuleTypeHeaderFile
[Info
.ModuleType
]:
2061 AutoGenC
.Append("#include <%s>\n" % Inc
)
2063 AutoGenC
.Append("#include <%s>\n" % gBasicHeaderFile
)
2066 # Publish the CallerId Guid
2068 AutoGenC
.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info
.Guid
))
2070 ## Create common code for header file
2072 # @param Info The ModuleAutoGen object
2073 # @param AutoGenC The TemplateString object for C code
2074 # @param AutoGenH The TemplateString object for header file
2076 def CreateFooterCode(Info
, AutoGenC
, AutoGenH
):
2077 AutoGenH
.Append(gAutoGenHEpilogueString
)
2079 ## Create code for a module
2081 # @param Info The ModuleAutoGen object
2082 # @param AutoGenC The TemplateString object for C code
2083 # @param AutoGenH The TemplateString object for header file
2084 # @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
2085 # @param UniGenBinBuffer Buffer to store uni string package data
2087 def CreateCode(Info
, AutoGenC
, AutoGenH
, StringH
, UniGenCFlag
, UniGenBinBuffer
):
2088 CreateHeaderCode(Info
, AutoGenC
, AutoGenH
)
2090 if Info
.AutoGenVersion
>= 0x00010005:
2091 CreateGuidDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2092 CreateProtocolDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2093 CreatePpiDefinitionCode(Info
, AutoGenC
, AutoGenH
)
2094 CreatePcdCode(Info
, AutoGenC
, AutoGenH
)
2095 CreateLibraryConstructorCode(Info
, AutoGenC
, AutoGenH
)
2096 CreateLibraryDestructorCode(Info
, AutoGenC
, AutoGenH
)
2097 CreateModuleEntryPointCode(Info
, AutoGenC
, AutoGenH
)
2098 CreateModuleUnloadImageCode(Info
, AutoGenC
, AutoGenH
)
2100 if Info
.UnicodeFileList
:
2101 FileName
= "%sStrDefs.h" % Info
.Name
2102 StringH
.Append(gAutoGenHeaderString
.Replace({'FileName':FileName
}))
2103 StringH
.Append(gAutoGenHPrologueString
.Replace({'File':'STRDEFS', 'Guid':Info
.Guid
.replace('-','_')}))
2104 CreateUnicodeStringCode(Info
, AutoGenC
, StringH
, UniGenCFlag
, UniGenBinBuffer
)
2105 StringH
.Append("\n#endif\n")
2106 AutoGenH
.Append('#include "%s"\n' % FileName
)
2108 CreateFooterCode(Info
, AutoGenC
, AutoGenH
)
2110 # no generation of AutoGen.c for Edk modules without unicode file
2111 if Info
.AutoGenVersion
< 0x00010005 and len(Info
.UnicodeFileList
) == 0:
2112 AutoGenC
.String
= ''
2114 ## Create the code file
2116 # @param FilePath The path of code file
2117 # @param Content The content of code file
2118 # @param IsBinaryFile The flag indicating if the file is binary file or not
2120 # @retval True If file content is changed or file doesn't exist
2121 # @retval False If the file exists and the content is not changed
2123 def Generate(FilePath
, Content
, IsBinaryFile
):
2124 return SaveFileOnChange(FilePath
, Content
, IsBinaryFile
)