-## @file
-# Routines for generating AutoGen.h and AutoGen.c
-#
-# Copyright (c) 2007 - 2011, Intel Corporation. All rights reserved.<BR>
-# This program and the accompanying materials
-# are licensed and made available under the terms and conditions of the BSD License
-# which accompanies this distribution. The full text of the license may be found at
-# http://opensource.org/licenses/bsd-license.php
-#
-# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-#
-
-## Import Modules
-#
-import string
-
-from Common import EdkLogger
-
-from Common.BuildToolError import *
-from Common.DataType import *
-from Common.Misc import *
-from Common.String import StringToArray
-from StrGather import *
-
-## PCD type string
-gItemTypeStringDatabase = {
- TAB_PCDS_FEATURE_FLAG : 'FixedAtBuild',
- TAB_PCDS_FIXED_AT_BUILD : 'FixedAtBuild',
- TAB_PCDS_PATCHABLE_IN_MODULE: 'BinaryPatch',
- TAB_PCDS_DYNAMIC : '',
- TAB_PCDS_DYNAMIC_DEFAULT : '',
- TAB_PCDS_DYNAMIC_VPD : '',
- TAB_PCDS_DYNAMIC_HII : '',
- TAB_PCDS_DYNAMIC_EX : '',
- TAB_PCDS_DYNAMIC_EX_DEFAULT : '',
- TAB_PCDS_DYNAMIC_EX_VPD : '',
- TAB_PCDS_DYNAMIC_EX_HII : '',
-}
-
-## Dynamic PCD types
-gDynamicPcd = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]
-
-## Dynamic-ex PCD types
-gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]
-
-## Datum size
-gDatumSizeStringDatabase = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOLEAN','VOID*':'8'}
-gDatumSizeStringDatabaseH = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOL','VOID*':'PTR'}
-gDatumSizeStringDatabaseLib = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'Bool','VOID*':'Ptr'}
-
-## Mapping between PCD driver type and EFI phase
-gPcdPhaseMap = {
- "PEI_PCD_DRIVER" : "PEI",
- "DXE_PCD_DRIVER" : "DXE"
-}
-
-gPcdDatabaseCommonAutoGenH = """
-//
-// The following definition will be generated by build tool
-//
-
-//
-// Common definitions
-//
-typedef UINT8 SKU_ID;
-
-#define PCD_TYPE_SHIFT 28
-
-#define PCD_TYPE_DATA (0x0U << PCD_TYPE_SHIFT)
-#define PCD_TYPE_HII (0x8U << PCD_TYPE_SHIFT)
-#define PCD_TYPE_VPD (0x4U << PCD_TYPE_SHIFT)
-#define PCD_TYPE_SKU_ENABLED (0x2U << PCD_TYPE_SHIFT)
-#define PCD_TYPE_STRING (0x1U << PCD_TYPE_SHIFT)
-
-#define PCD_TYPE_ALL_SET (PCD_TYPE_DATA | PCD_TYPE_HII | PCD_TYPE_VPD | PCD_TYPE_SKU_ENABLED | PCD_TYPE_STRING)
-
-#define PCD_DATUM_TYPE_SHIFT 24
-
-#define PCD_DATUM_TYPE_POINTER (0x0U << PCD_DATUM_TYPE_SHIFT)
-#define PCD_DATUM_TYPE_UINT8 (0x1U << PCD_DATUM_TYPE_SHIFT)
-#define PCD_DATUM_TYPE_UINT16 (0x2U << PCD_DATUM_TYPE_SHIFT)
-#define PCD_DATUM_TYPE_UINT32 (0x4U << PCD_DATUM_TYPE_SHIFT)
-#define PCD_DATUM_TYPE_UINT64 (0x8U << PCD_DATUM_TYPE_SHIFT)
-
-#define PCD_DATUM_TYPE_ALL_SET (PCD_DATUM_TYPE_POINTER | \\
- PCD_DATUM_TYPE_UINT8 | \\
- PCD_DATUM_TYPE_UINT16 | \\
- PCD_DATUM_TYPE_UINT32 | \\
- PCD_DATUM_TYPE_UINT64)
-
-#define PCD_DATABASE_OFFSET_MASK (~(PCD_TYPE_ALL_SET | PCD_DATUM_TYPE_ALL_SET))
-
-typedef struct {
- UINT32 ExTokenNumber;
- UINT16 LocalTokenNumber; // PCD Number of this particular platform build
- UINT16 ExGuidIndex; // Index of GuidTable
-} DYNAMICEX_MAPPING;
-
-typedef struct {
- UINT32 SkuDataStartOffset; //We have to use offsetof MACRO as we don't know padding done by compiler
- UINT32 SkuIdTableOffset; //Offset from the PCD_DB
-} SKU_HEAD;
-
-typedef struct {
- UINT16 GuidTableIndex; // Offset in Guid Table in units of GUID.
- UINT16 StringIndex; // Offset in String Table in units of UINT16.
- UINT16 Offset; // Offset in Variable
- UINT16 DefaultValueOffset; // Offset of the Default Value
-} VARIABLE_HEAD;
-
-typedef struct {
- UINT32 Offset;
-} VPD_HEAD;
-
-typedef UINT16 STRING_HEAD;
-
-typedef UINT16 SIZE_INFO;
-
-#define offsetof(s,m) (UINT32) (UINTN) &(((s *)0)->m)
-
-"""
-
-gPcdDatabaseEpilogueAutoGenH = """
-typedef struct {
- PEI_PCD_DATABASE PeiDb;
- DXE_PCD_DATABASE DxeDb;
-} PCD_DATABASE;
-
-#define PCD_TOTAL_TOKEN_NUMBER (PEI_LOCAL_TOKEN_NUMBER + DXE_LOCAL_TOKEN_NUMBER)
-
-"""
-
-gPcdDatabaseAutoGenH = TemplateString("""
-#define ${PHASE}_GUID_TABLE_SIZE ${GUID_TABLE_SIZE}
-#define ${PHASE}_STRING_TABLE_SIZE ${STRING_TABLE_SIZE}
-#define ${PHASE}_SKUID_TABLE_SIZE ${SKUID_TABLE_SIZE}
-#define ${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE ${LOCAL_TOKEN_NUMBER_TABLE_SIZE}
-#define ${PHASE}_LOCAL_TOKEN_NUMBER ${LOCAL_TOKEN_NUMBER}
-#define ${PHASE}_EXMAPPING_TABLE_SIZE ${EXMAPPING_TABLE_SIZE}
-#define ${PHASE}_EX_TOKEN_NUMBER ${EX_TOKEN_NUMBER}
-#define ${PHASE}_SIZE_TABLE_SIZE ${SIZE_TABLE_SIZE}
-#define ${PHASE}_GUID_TABLE_EMPTY ${GUID_TABLE_EMPTY}
-#define ${PHASE}_STRING_TABLE_EMPTY ${STRING_TABLE_EMPTY}
-#define ${PHASE}_SKUID_TABLE_EMPTY ${SKUID_TABLE_EMPTY}
-#define ${PHASE}_DATABASE_EMPTY ${DATABASE_EMPTY}
-#define ${PHASE}_EXMAP_TABLE_EMPTY ${EXMAP_TABLE_EMPTY}
-
-typedef struct {
-${BEGIN} UINT64 ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}];
-${END}
-${BEGIN} UINT64 ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64};
-${END}
-${BEGIN} UINT32 ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}];
-${END}
-${BEGIN} UINT32 ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32};
-${END}
-${BEGIN} VPD_HEAD ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}];
-${END}
- DYNAMICEX_MAPPING ExMapTable[${PHASE}_EXMAPPING_TABLE_SIZE];
- UINT32 LocalTokenNumberTable[${PHASE}_LOCAL_TOKEN_NUMBER_TABLE_SIZE];
- GUID GuidTable[${PHASE}_GUID_TABLE_SIZE];
-${BEGIN} STRING_HEAD ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}];
-${END}
-${BEGIN} VARIABLE_HEAD ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}];
-${END}
-${BEGIN} UINT8 StringTable${STRING_TABLE_INDEX}[${STRING_TABLE_LENGTH}]; /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
-${END}
- SIZE_INFO SizeTable[${PHASE}_SIZE_TABLE_SIZE];
-${BEGIN} UINT16 ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}];
-${END}
-${BEGIN} UINT16 ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16};
-${END}
-${BEGIN} UINT8 ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}];
-${END}
-${BEGIN} UINT8 ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8};
-${END}
-${BEGIN} BOOLEAN ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}];
-${END}
-${BEGIN} BOOLEAN ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN};
-${END}
- UINT8 SkuIdTable[${PHASE}_SKUID_TABLE_SIZE];
-${SYSTEM_SKU_ID}
-} ${PHASE}_PCD_DATABASE_INIT;
-
-typedef struct {
-${PCD_DATABASE_UNINIT_EMPTY}
-${BEGIN} UINT64 ${UNINIT_CNAME_DECL_UINT64}_${UNINIT_GUID_DECL_UINT64}[${UNINIT_NUMSKUS_DECL_UINT64}];
-${END}
-${BEGIN} UINT32 ${UNINIT_CNAME_DECL_UINT32}_${UNINIT_GUID_DECL_UINT32}[${UNINIT_NUMSKUS_DECL_UINT32}];
-${END}
-${BEGIN} UINT16 ${UNINIT_CNAME_DECL_UINT16}_${UNINIT_GUID_DECL_UINT16}[${UNINIT_NUMSKUS_DECL_UINT16}];
-${END}
-${BEGIN} UINT8 ${UNINIT_CNAME_DECL_UINT8}_${UNINIT_GUID_DECL_UINT8}[${UNINIT_NUMSKUS_DECL_UINT8}];
-${END}
-${BEGIN} BOOLEAN ${UNINIT_CNAME_DECL_BOOLEAN}_${UNINIT_GUID_DECL_BOOLEAN}[${UNINIT_NUMSKUS_DECL_BOOLEAN}];
-${END}
-} ${PHASE}_PCD_DATABASE_UNINIT;
-
-#define PCD_${PHASE}_SERVICE_DRIVER_VERSION 2
-
-typedef struct {
- ${PHASE}_PCD_DATABASE_INIT Init;
- ${PHASE}_PCD_DATABASE_UNINIT Uninit;
-} ${PHASE}_PCD_DATABASE;
-
-#define ${PHASE}_NEX_TOKEN_NUMBER (${PHASE}_LOCAL_TOKEN_NUMBER - ${PHASE}_EX_TOKEN_NUMBER)
-""")
-
-gEmptyPcdDatabaseAutoGenC = TemplateString("""
-${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
- /* ExMapTable */
- {
- {0, 0, 0}
- },
- /* LocalTokenNumberTable */
- {
- 0
- },
- /* GuidTable */
- {
- {0x00000000, 0x0000, 0x0000, {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}}
- },
- /* StringTable */
- { 0 },
- /* SizeTable */
- {
- 0, 0
- },
- /* SkuIdTable */
- { 0 },
- ${SYSTEM_SKU_ID_VALUE}
-};
-""")
-
-gPcdDatabaseAutoGenC = TemplateString("""
-${PHASE}_PCD_DATABASE_INIT g${PHASE}PcdDbInit = {
-${BEGIN} { ${INIT_VALUE_UINT64} }, /* ${INIT_CNAME_DECL_UINT64}_${INIT_GUID_DECL_UINT64}[${INIT_NUMSKUS_DECL_UINT64}] */
-${END}
-${BEGIN} ${VARDEF_VALUE_UINT64}, /* ${VARDEF_CNAME_UINT64}_${VARDEF_GUID_UINT64}_VariableDefault_${VARDEF_SKUID_UINT64} */
-${END}
-${BEGIN} { ${INIT_VALUE_UINT32} }, /* ${INIT_CNAME_DECL_UINT32}_${INIT_GUID_DECL_UINT32}[${INIT_NUMSKUS_DECL_UINT32}] */
-${END}
-${BEGIN} ${VARDEF_VALUE_UINT32}, /* ${VARDEF_CNAME_UINT32}_${VARDEF_GUID_UINT32}_VariableDefault_${VARDEF_SKUID_UINT32} */
-${END}
- /* VPD */
-${BEGIN} { ${VPD_HEAD_VALUE} }, /* ${VPD_HEAD_CNAME_DECL}_${VPD_HEAD_GUID_DECL}[${VPD_HEAD_NUMSKUS_DECL}] */
-${END}
- /* ExMapTable */
- {
-${BEGIN} { ${EXMAPPING_TABLE_EXTOKEN}, ${EXMAPPING_TABLE_LOCAL_TOKEN}, ${EXMAPPING_TABLE_GUID_INDEX} },
-${END}
- },
- /* LocalTokenNumberTable */
- {
-${BEGIN} offsetof(${PHASE}_PCD_DATABASE, ${TOKEN_INIT}.${TOKEN_CNAME}_${TOKEN_GUID}${VARDEF_HEADER}) | ${TOKEN_TYPE},
-${END}
- },
- /* GuidTable */
- {
-${BEGIN} ${GUID_STRUCTURE},
-${END}
- },
-${BEGIN} { ${STRING_HEAD_VALUE} }, /* ${STRING_HEAD_CNAME_DECL}_${STRING_HEAD_GUID_DECL}[${STRING_HEAD_NUMSKUS_DECL}] */
-${END}
-${BEGIN} /* ${VARIABLE_HEAD_CNAME_DECL}_${VARIABLE_HEAD_GUID_DECL}_Variable_Header[${VARIABLE_HEAD_NUMSKUS_DECL}] */
- {
- ${VARIABLE_HEAD_VALUE}
- },
-${END}
- /* StringTable */
-${BEGIN} ${STRING_TABLE_VALUE}, /* ${STRING_TABLE_CNAME}_${STRING_TABLE_GUID} */
-${END}
- /* SizeTable */
- {
-${BEGIN} ${SIZE_TABLE_MAXIMUM_LENGTH}, ${SIZE_TABLE_CURRENT_LENGTH}, /* ${SIZE_TABLE_CNAME}_${SIZE_TABLE_GUID} */
-${END}
- },
-${BEGIN} { ${INIT_VALUE_UINT16} }, /* ${INIT_CNAME_DECL_UINT16}_${INIT_GUID_DECL_UINT16}[${INIT_NUMSKUS_DECL_UINT16}] */
-${END}
-${BEGIN} ${VARDEF_VALUE_UINT16}, /* ${VARDEF_CNAME_UINT16}_${VARDEF_GUID_UINT16}_VariableDefault_${VARDEF_SKUID_UINT16} */
-${END}
-${BEGIN} { ${INIT_VALUE_UINT8} }, /* ${INIT_CNAME_DECL_UINT8}_${INIT_GUID_DECL_UINT8}[${INIT_NUMSKUS_DECL_UINT8}] */
-${END}
-${BEGIN} ${VARDEF_VALUE_UINT8}, /* ${VARDEF_CNAME_UINT8}_${VARDEF_GUID_UINT8}_VariableDefault_${VARDEF_SKUID_UINT8} */
-${END}
-${BEGIN} { ${INIT_VALUE_BOOLEAN} }, /* ${INIT_CNAME_DECL_BOOLEAN}_${INIT_GUID_DECL_BOOLEAN}[${INIT_NUMSKUS_DECL_BOOLEAN}] */
-${END}
-${BEGIN} ${VARDEF_VALUE_BOOLEAN}, /* ${VARDEF_CNAME_BOOLEAN}_${VARDEF_GUID_BOOLEAN}_VariableDefault_${VARDEF_SKUID_BOOLEAN} */
-${END}
- /* SkuIdTable */
- { ${BEGIN}${SKUID_VALUE}, ${END} },
- ${SYSTEM_SKU_ID_VALUE}
-};
-""")
-
-
-## AutoGen File Header Templates
-gAutoGenHeaderString = TemplateString("""\
-/**
- DO NOT EDIT
- FILE auto-generated
- Module name:
- ${FileName}
- Abstract: Auto-generated ${FileName} for building module or library.
-**/
-""")
-
-gAutoGenHPrologueString = TemplateString("""
-#ifndef _${File}_${Guid}
-#define _${File}_${Guid}
-
-""")
-
-gAutoGenHCppPrologueString = """\
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-"""
-
-gAutoGenHEpilogueString = """
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
-"""
-
-## PEI Core Entry Point Templates
-gPeiCoreEntryPointPrototype = TemplateString("""
-${BEGIN}
-VOID
-EFIAPI
-${Function} (
- IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
- IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
- IN VOID *Context
- );
-${END}
-""")
-
-gPeiCoreEntryPointString = TemplateString("""
-${BEGIN}
-VOID
-EFIAPI
-ProcessModuleEntryPointList (
- IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,
- IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,
- IN VOID *Context
- )
-
-{
- ${Function} (SecCoreData, PpiList, Context);
-}
-${END}
-""")
-
-
-## DXE Core Entry Point Templates
-gDxeCoreEntryPointPrototype = TemplateString("""
-${BEGIN}
-VOID
-EFIAPI
-${Function} (
- IN VOID *HobStart
- );
-${END}
-""")
-
-gDxeCoreEntryPointString = TemplateString("""
-${BEGIN}
-VOID
-EFIAPI
-ProcessModuleEntryPointList (
- IN VOID *HobStart
- )
-
-{
- ${Function} (HobStart);
-}
-${END}
-""")
-
-## PEIM Entry Point Templates
-gPeimEntryPointPrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- );
-${END}
-""")
-
-gPeimEntryPointString = [
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
-
-{
- return EFI_SUCCESS;
-}
-"""),
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
-${BEGIN}
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
-
-{
- return ${Function} (FileHandle, PeiServices);
-}
-${END}
-"""),
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
-
-{
- EFI_STATUS Status;
- EFI_STATUS CombinedStatus;
-
- CombinedStatus = EFI_LOAD_ERROR;
-${BEGIN}
- Status = ${Function} (FileHandle, PeiServices);
- if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {
- CombinedStatus = Status;
- }
-${END}
- return CombinedStatus;
-}
-""")
-]
-
-## SMM_CORE Entry Point Templates
-gSmmCoreEntryPointPrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- );
-${END}
-""")
-
-gSmmCoreEntryPointString = TemplateString("""
-${BEGIN}
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- return ${Function} (ImageHandle, SystemTable);
-}
-${END}
-""")
-
-## DXE SMM Entry Point Templates
-gDxeSmmEntryPointPrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- );
-${END}
-""")
-
-gDxeSmmEntryPointString = [
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-
-{
- return EFI_SUCCESS;
-}
-"""),
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
-static EFI_STATUS mDriverEntryPointStatus;
-
-VOID
-EFIAPI
-ExitDriver (
- IN EFI_STATUS Status
- )
-{
- if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
- mDriverEntryPointStatus = Status;
- }
- LongJump (&mJumpContext, (UINTN)-1);
- ASSERT (FALSE);
-}
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- mDriverEntryPointStatus = EFI_LOAD_ERROR;
-
-${BEGIN}
- if (SetJump (&mJumpContext) == 0) {
- ExitDriver (${Function} (ImageHandle, SystemTable));
- ASSERT (FALSE);
- }
-${END}
-
- return mDriverEntryPointStatus;
-}
-""")
-]
-
-## UEFI Driver Entry Point Templates
-gUefiDriverEntryPointPrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- );
-${END}
-""")
-
-gUefiDriverEntryPointString = [
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- return EFI_SUCCESS;
-}
-"""),
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-${BEGIN}
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-
-{
- return ${Function} (ImageHandle, SystemTable);
-}
-${END}
-VOID
-EFIAPI
-ExitDriver (
- IN EFI_STATUS Status
- )
-{
- if (EFI_ERROR (Status)) {
- ProcessLibraryDestructorList (gImageHandle, gST);
- }
- gBS->Exit (gImageHandle, Status, 0, NULL);
-}
-"""),
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-const UINT32 _gDxeRevision = ${PiSpecVersion};
-
-static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
-static EFI_STATUS mDriverEntryPointStatus;
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- mDriverEntryPointStatus = EFI_LOAD_ERROR;
- ${BEGIN}
- if (SetJump (&mJumpContext) == 0) {
- ExitDriver (${Function} (ImageHandle, SystemTable));
- ASSERT (FALSE);
- }
- ${END}
- return mDriverEntryPointStatus;
-}
-
-VOID
-EFIAPI
-ExitDriver (
- IN EFI_STATUS Status
- )
-{
- if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
- mDriverEntryPointStatus = Status;
- }
- LongJump (&mJumpContext, (UINTN)-1);
- ASSERT (FALSE);
-}
-""")
-]
-
-
-## UEFI Application Entry Point Templates
-gUefiApplicationEntryPointPrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- );
-${END}
-""")
-
-gUefiApplicationEntryPointString = [
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- return EFI_SUCCESS;
-}
-"""),
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-
-${BEGIN}
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-
-{
- return ${Function} (ImageHandle, SystemTable);
-}
-${END}
-VOID
-EFIAPI
-ExitDriver (
- IN EFI_STATUS Status
- )
-{
- if (EFI_ERROR (Status)) {
- ProcessLibraryDestructorList (gImageHandle, gST);
- }
- gBS->Exit (gImageHandle, Status, 0, NULL);
-}
-"""),
-TemplateString("""
-const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleEntryPointList (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-
-{
- ${BEGIN}
- if (SetJump (&mJumpContext) == 0) {
- ExitDriver (${Function} (ImageHandle, SystemTable));
- ASSERT (FALSE);
- }
- ${END}
- return mDriverEntryPointStatus;
-}
-
-static BASE_LIBRARY_JUMP_BUFFER mJumpContext;
-static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;
-
-VOID
-EFIAPI
-ExitDriver (
- IN EFI_STATUS Status
- )
-{
- if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {
- mDriverEntryPointStatus = Status;
- }
- LongJump (&mJumpContext, (UINTN)-1);
- ASSERT (FALSE);
-}
-""")
-]
-
-## UEFI Unload Image Templates
-gUefiUnloadImagePrototype = TemplateString("""
-${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle
- );
-${END}
-""")
-
-gUefiUnloadImageString = [
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleUnloadList (
- IN EFI_HANDLE ImageHandle
- )
-{
- return EFI_SUCCESS;
-}
-"""),
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
-
-${BEGIN}
-EFI_STATUS
-EFIAPI
-ProcessModuleUnloadList (
- IN EFI_HANDLE ImageHandle
- )
-{
- return ${Function} (ImageHandle);
-}
-${END}
-"""),
-TemplateString("""
-GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};
-
-EFI_STATUS
-EFIAPI
-ProcessModuleUnloadList (
- IN EFI_HANDLE ImageHandle
- )
-{
- EFI_STATUS Status;
-
- Status = EFI_SUCCESS;
-${BEGIN}
- if (EFI_ERROR (Status)) {
- ${Function} (ImageHandle);
- } else {
- Status = ${Function} (ImageHandle);
- }
-${END}
- return Status;
-}
-""")
-]
-
-gLibraryStructorPrototype = {
-'BASE' : TemplateString("""${BEGIN}
-RETURN_STATUS
-EFIAPI
-${Function} (
- VOID
- );${END}
-"""),
-
-'PEI' : TemplateString("""${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- );${END}
-"""),
-
-'DXE' : TemplateString("""${BEGIN}
-EFI_STATUS
-EFIAPI
-${Function} (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- );${END}
-"""),
-}
-
-gLibraryStructorCall = {
-'BASE' : TemplateString("""${BEGIN}
- Status = ${Function} ();
- ASSERT_EFI_ERROR (Status);${END}
-"""),
-
-'PEI' : TemplateString("""${BEGIN}
- Status = ${Function} (FileHandle, PeiServices);
- ASSERT_EFI_ERROR (Status);${END}
-"""),
-
-'DXE' : TemplateString("""${BEGIN}
- Status = ${Function} (ImageHandle, SystemTable);
- ASSERT_EFI_ERROR (Status);${END}
-"""),
-}
-
-## Library Constructor and Destructor Templates
-gLibraryString = {
-'BASE' : TemplateString("""
-${BEGIN}${FunctionPrototype}${END}
-
-VOID
-EFIAPI
-ProcessLibrary${Type}List (
- VOID
- )
-{
-${BEGIN} EFI_STATUS Status;
-${FunctionCall}${END}
-}
-"""),
-
-'PEI' : TemplateString("""
-${BEGIN}${FunctionPrototype}${END}
-
-VOID
-EFIAPI
-ProcessLibrary${Type}List (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
- )
-{
-${BEGIN} EFI_STATUS Status;
-${FunctionCall}${END}
-}
-"""),
-
-'DXE' : TemplateString("""
-${BEGIN}${FunctionPrototype}${END}
-
-VOID
-EFIAPI
-ProcessLibrary${Type}List (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
-${BEGIN} EFI_STATUS Status;
-${FunctionCall}${END}
-}
-"""),
-}
-
-gBasicHeaderFile = "Base.h"
-
-gModuleTypeHeaderFile = {
- "BASE" : [gBasicHeaderFile],
- "SEC" : ["PiPei.h", "Library/DebugLib.h"],
- "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],
- "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],
- "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],
- "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
- "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
- "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
- "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
- "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],
- "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],
- "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],
- "USER_DEFINED" : [gBasicHeaderFile]
-}
-
-## Create code for module PCDs
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-# @param Pcd The PCD object
-#
-def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):
- TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[Pcd.TokenSpaceGuidCName]
- PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber
- #
- # Write PCDs
- #
- PcdTokenName = '_PCD_TOKEN_' + Pcd.TokenCName
- if Pcd.Type in gDynamicExPcd:
- TokenNumber = int(Pcd.TokenValue, 0)
- else:
- if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]
- AutoGenH.Append('\n#define %s %dU\n' % (PcdTokenName, TokenNumber))
-
- EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + Pcd.TokenCName + "." + Pcd.TokenSpaceGuidCName)
- if Pcd.Type not in gItemTypeStringDatabase:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if Pcd.DatumType not in gDatumSizeStringDatabase:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
-
- DatumSize = gDatumSizeStringDatabase[Pcd.DatumType]
- DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType]
- GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + Pcd.TokenCName
- SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + Pcd.TokenCName
-
- if Pcd.Type in gDynamicExPcd:
- AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))
- if Pcd.DatumType == 'VOID*':
- AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))
- else:
- AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))
- elif Pcd.Type in gDynamicPcd:
- AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))
- if Pcd.DatumType == 'VOID*':
- AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))
- else:
- AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))
- else:
- PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + Pcd.TokenCName
- Const = 'const'
- if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
- Const = ''
- Type = ''
- Array = ''
- Value = Pcd.DefaultValue
- Unicode = False
- ValueNumber = 0
-
- if Pcd.DatumType == 'BOOLEAN':
- BoolValue = Value.upper()
- if BoolValue == 'TRUE' or BoolValue == '1':
- Value = '1U'
- elif BoolValue == 'FALSE' or BoolValue == '0':
- Value = '0U'
-
- if Pcd.DatumType in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:
- try:
- if Value.upper().startswith('0X'):
- ValueNumber = int (Value, 16)
- else:
- ValueNumber = int (Value)
- except:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if Pcd.DatumType == 'UINT64':
- if ValueNumber < 0:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- elif ValueNumber >= 0x10000000000000000:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if not Value.endswith('ULL'):
- Value += 'ULL'
- elif Pcd.DatumType == 'UINT32':
- if ValueNumber < 0:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- elif ValueNumber >= 0x100000000:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if not Value.endswith('U'):
- Value += 'U'
- elif Pcd.DatumType == 'UINT16':
- if ValueNumber < 0:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- elif ValueNumber >= 0x10000:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if not Value.endswith('U'):
- Value += 'U'
- elif Pcd.DatumType == 'UINT8':
- if ValueNumber < 0:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- elif ValueNumber >= 0x100:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if not Value.endswith('U'):
- Value += 'U'
- if Pcd.DatumType == 'VOID*':
- if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
-
- ArraySize = int(Pcd.MaxDatumSize, 0)
- if Value[0] == '{':
- Type = '(VOID *)'
- else:
- if Value[0] == 'L':
- Unicode = True
- Value = Value.lstrip('L') #.strip('"')
- Value = eval(Value) # translate escape character
- NewValue = '{'
- for Index in range(0,len(Value)):
- if Unicode:
- NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '
- else:
- NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '
- if Unicode:
- ArraySize = ArraySize / 2;
-
- if ArraySize < (len(Value) + 1):
- EdkLogger.error("build", AUTOGEN_ERROR,
- "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- Value = NewValue + '0 }'
- Array = '[%d]' % ArraySize
- #
- # skip casting for fixed at build since it breaks ARM assembly.
- # Long term we need PCD macros that work in assembly
- #
- elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:
- Value = "((%s)%s)" % (Pcd.DatumType, Value)
-
- if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
- PcdValueName = '_PCD_PATCHABLE_VALUE_' + Pcd.TokenCName
- else:
- PcdValueName = '_PCD_VALUE_' + Pcd.TokenCName
-
- if Pcd.DatumType == 'VOID*':
- #
- # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.
- #
- if Unicode:
- AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))
- AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))
- AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))
- AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))
- else:
- AutoGenH.Append('#define _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))
- AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))
- AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))
- AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))
- elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
- AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))
- AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))
- AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))
- AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))
- else:
- AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))
- AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))
- AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))
-
- if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:
- if Pcd.DatumType == 'VOID*':
- AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName))
- else:
- AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))
- else:
- AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)
-
-## Create code for library module PCDs
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-# @param Pcd The PCD object
-#
-def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):
- PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber
- TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
- TokenCName = Pcd.TokenCName
- TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[TokenSpaceGuidCName]
- if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- TokenNumber = PcdTokenNumber[TokenCName, TokenSpaceGuidCName]
-
- # If PCD is DynamicEx, then use TokenNumber declared in DEC file
- if Pcd.Type in gDynamicExPcd:
- TokenNumber = int(Pcd.TokenValue, 0)
-
- if Pcd.Type not in gItemTypeStringDatabase:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- if Pcd.DatumType not in gDatumSizeStringDatabase:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
-
- DatumType = Pcd.DatumType
- DatumSize = gDatumSizeStringDatabaseH[DatumType]
- DatumSizeLib= gDatumSizeStringDatabaseLib[DatumType]
- GetModeName = '_PCD_GET_MODE_' + DatumSize + '_' + TokenCName
- SetModeName = '_PCD_SET_MODE_' + DatumSize + '_' + TokenCName
-
- Type = ''
- Array = ''
- if Pcd.DatumType == 'VOID*':
- Type = '(VOID *)'
- Array = '[]'
-
- AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))
-
- PcdItemType = Pcd.Type
- #if PcdItemType in gDynamicPcd:
- # PcdItemType = TAB_PCDS_FIXED_AT_BUILD
- # if (TokenCName, TokenSpaceGuidCName) in Info.PlatformInfo.Platform.Pcds:
- # PcdItemType = Info.PlatformInfo.Platform.Pcds[TokenCName, TokenSpaceGuidCName].Type
- if PcdItemType in gDynamicExPcd:
- PcdTokenName = '_PCD_TOKEN_' + TokenCName
- AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, TokenSpaceGuidCName, PcdTokenName))
- if DatumType == 'VOID*':
- AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName,DatumSizeLib, TokenSpaceGuidCName, PcdTokenName))
- else:
- AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, TokenSpaceGuidCName, PcdTokenName))
- if PcdItemType in gDynamicPcd:
- PcdTokenName = '_PCD_TOKEN_' + TokenCName
- AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))
- if DatumType == 'VOID*':
- AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))
- else:
- AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))
- if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:
- PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName
- AutoGenH.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array) )
- AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))
- AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))
- if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:
- AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))
- #AutoGenH.Append('#define _PCD_VALUE_%s _gPcd_FixedAtBuild_%s\n' %(TokenCName, TokenCName))
- AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))
- AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)
-
-## Create code for PCD database in DXE or PEI phase
-#
-# @param Platform The platform object
-# @retval tuple Two TemplateString objects for C code and header file,
-# respectively
-#
-def CreatePcdDatabasePhaseSpecificAutoGen (Platform, Phase):
- AutoGenC = TemplateString()
- AutoGenH = TemplateString()
-
- Dict = {
- 'PHASE' : Phase,
- 'GUID_TABLE_SIZE' : '1U',
- 'STRING_TABLE_SIZE' : '1U',
- 'SKUID_TABLE_SIZE' : '1U',
- 'LOCAL_TOKEN_NUMBER_TABLE_SIZE' : '1U',
- 'LOCAL_TOKEN_NUMBER' : '0U',
- 'EXMAPPING_TABLE_SIZE' : '1U',
- 'EX_TOKEN_NUMBER' : '0U',
- 'SIZE_TABLE_SIZE' : '2U',
- 'GUID_TABLE_EMPTY' : 'TRUE',
- 'STRING_TABLE_EMPTY' : 'TRUE',
- 'SKUID_TABLE_EMPTY' : 'TRUE',
- 'DATABASE_EMPTY' : 'TRUE',
- 'EXMAP_TABLE_EMPTY' : 'TRUE',
- 'PCD_DATABASE_UNINIT_EMPTY' : ' UINT8 dummy; /* PCD_DATABASE_UNINIT is emptry */',
- 'SYSTEM_SKU_ID' : ' SKU_ID SystemSkuId;',
- 'SYSTEM_SKU_ID_VALUE' : '0U'
- }
-
- for DatumType in ['UINT64','UINT32','UINT16','UINT8','BOOLEAN', "VOID*"]:
- Dict['VARDEF_CNAME_' + DatumType] = []
- Dict['VARDEF_GUID_' + DatumType] = []
- Dict['VARDEF_SKUID_' + DatumType] = []
- Dict['VARDEF_VALUE_' + DatumType] = []
- for Init in ['INIT','UNINIT']:
- Dict[Init+'_CNAME_DECL_' + DatumType] = []
- Dict[Init+'_GUID_DECL_' + DatumType] = []
- Dict[Init+'_NUMSKUS_DECL_' + DatumType] = []
- Dict[Init+'_VALUE_' + DatumType] = []
-
- for Type in ['STRING_HEAD','VPD_HEAD','VARIABLE_HEAD']:
- Dict[Type + '_CNAME_DECL'] = []
- Dict[Type + '_GUID_DECL'] = []
- Dict[Type + '_NUMSKUS_DECL'] = []
- Dict[Type + '_VALUE'] = []
-
- Dict['STRING_TABLE_INDEX'] = []
- Dict['STRING_TABLE_LENGTH'] = []
- Dict['STRING_TABLE_CNAME'] = []
- Dict['STRING_TABLE_GUID'] = []
- Dict['STRING_TABLE_VALUE'] = []
-
- Dict['SIZE_TABLE_CNAME'] = []
- Dict['SIZE_TABLE_GUID'] = []
- Dict['SIZE_TABLE_CURRENT_LENGTH'] = []
- Dict['SIZE_TABLE_MAXIMUM_LENGTH'] = []
-
- Dict['EXMAPPING_TABLE_EXTOKEN'] = []
- Dict['EXMAPPING_TABLE_LOCAL_TOKEN'] = []
- Dict['EXMAPPING_TABLE_GUID_INDEX'] = []
-
- Dict['GUID_STRUCTURE'] = []
-
- Dict['SKUID_VALUE'] = []
- Dict['VARDEF_HEADER'] = []
- if Phase == 'DXE':
- Dict['SYSTEM_SKU_ID'] = ''
- Dict['SYSTEM_SKU_ID_VALUE'] = ''
-
- StringTableIndex = 0
- StringTableSize = 0
- NumberOfLocalTokens = 0
- NumberOfPeiLocalTokens = 0
- NumberOfDxeLocalTokens = 0
- NumberOfExTokens = 0
- NumberOfSizeItems = 0
- GuidList = []
-
- for Pcd in Platform.DynamicPcdList:
- CName = Pcd.TokenCName
- TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
-
- EdkLogger.debug(EdkLogger.DEBUG_3, "PCD: %s %s (%s : %s)" % (CName, TokenSpaceGuidCName, Pcd.Phase, Phase))
- if Pcd.DatumType not in gDatumSizeStringDatabase:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Platform))
-
- if Pcd.Phase == 'PEI':
- NumberOfPeiLocalTokens += 1
- if Pcd.Phase == 'DXE':
- NumberOfDxeLocalTokens += 1
- if Pcd.Phase != Phase:
- continue
-
- #
- # TODO: need GetGuidValue() definition
- #
- TokenSpaceGuidStructure = Pcd.TokenSpaceGuidValue
- TokenSpaceGuid = GuidStructureStringToGuidValueName(TokenSpaceGuidStructure)
- if Pcd.Type in gDynamicExPcd:
- if TokenSpaceGuid not in GuidList:
- GuidList += [TokenSpaceGuid]
- Dict['GUID_STRUCTURE'].append(TokenSpaceGuidStructure)
- NumberOfExTokens += 1
-
- ValueList = []
- StringHeadOffsetList = []
- VpdHeadOffsetList = []
- VariableHeadValueList = []
- Pcd.InitString = 'UNINIT'
-
- if Pcd.DatumType == 'VOID*':
- if Pcd.Type not in ["DynamicVpd", "DynamicExVpd"]:
- Pcd.TokenTypeList = ['PCD_TYPE_STRING']
- else:
- Pcd.TokenTypeList = []
- elif Pcd.DatumType == 'BOOLEAN':
- Pcd.TokenTypeList = ['PCD_DATUM_TYPE_UINT8']
- else:
- Pcd.TokenTypeList = ['PCD_DATUM_TYPE_' + Pcd.DatumType]
-
- if len(Pcd.SkuInfoList) > 1:
- Pcd.TokenTypeList += ['PCD_TYPE_SKU_ENABLED']
-
- for SkuName in Pcd.SkuInfoList:
- Sku = Pcd.SkuInfoList[SkuName]
- SkuId = Sku.SkuId
- if SkuId == None or SkuId == '':
- continue
-
- if (SkuId + 'U') not in Dict['SKUID_VALUE']:
- Dict['SKUID_VALUE'].append(SkuId + 'U')
-
- SkuIdIndex = Dict['SKUID_VALUE'].index(SkuId + 'U')
- if len(Sku.VariableName) > 0:
- Pcd.TokenTypeList += ['PCD_TYPE_HII']
- Pcd.InitString = 'INIT'
- VariableNameStructure = StringToArray(Sku.VariableName)
- if VariableNameStructure not in Dict['STRING_TABLE_VALUE']:
- Dict['STRING_TABLE_CNAME'].append(CName)
- Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
- if StringTableIndex == 0:
- Dict['STRING_TABLE_INDEX'].append('')
- else:
- Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
-
- Dict['STRING_TABLE_LENGTH'].append((len(Sku.VariableName) - 3 + 1) * 2)
- Dict['STRING_TABLE_VALUE'].append(VariableNameStructure)
- StringTableIndex += 1
- StringTableSize += (len(Sku.VariableName) - 3 + 1) * 2
-
- VariableHeadStringIndex = 0
- for Index in range(Dict['STRING_TABLE_VALUE'].index(VariableNameStructure)):
- VariableHeadStringIndex += Dict['STRING_TABLE_LENGTH'][Index]
-
- VariableGuidStructure = Sku.VariableGuidValue
- VariableGuid = GuidStructureStringToGuidValueName(VariableGuidStructure)
- if VariableGuid not in GuidList:
- GuidList += [VariableGuid]
- Dict['GUID_STRUCTURE'].append(VariableGuidStructure)
- VariableHeadGuidIndex = GuidList.index(VariableGuid)
-
- if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
- VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s)' %
- (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
- Phase, CName, TokenSpaceGuid))
- else:
- VariableHeadValueList.append('%dU, %dU, %sU, offsetof(%s_PCD_DATABASE, Init.%s_%s_VariableDefault_%s)' %
- (VariableHeadGuidIndex, VariableHeadStringIndex, Sku.VariableOffset,
- Phase, CName, TokenSpaceGuid, SkuIdIndex))
- Dict['VARDEF_CNAME_'+Pcd.DatumType].append(CName)
- Dict['VARDEF_GUID_'+Pcd.DatumType].append(TokenSpaceGuid)
- Dict['VARDEF_SKUID_'+Pcd.DatumType].append(SkuIdIndex)
- if "PCD_TYPE_STRING" in Pcd.TokenTypeList:
- Dict['VARDEF_VALUE_' + Pcd.DatumType].append("%s_%s[%d]" % (Pcd.TokenCName, TokenSpaceGuid, SkuIdIndex))
- else:
- #
- # ULL (for UINT64) or U(other integer type) should be append to avoid
- # warning under linux building environment.
- #
- if Pcd.DatumType == "UINT64":
- Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "ULL")
- elif Pcd.DatumType in ("UINT32", "UINT16", "UINT8"):
- Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "U")
- elif Pcd.DatumType == "BOOLEAN":
- if Sku.HiiDefaultValue in ["1", "0"]:
- Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue + "U")
- else:
- Dict['VARDEF_VALUE_'+Pcd.DatumType].append(Sku.HiiDefaultValue)
-
- elif Sku.VpdOffset != '':
- Pcd.TokenTypeList += ['PCD_TYPE_VPD']
- Pcd.InitString = 'INIT'
- VpdHeadOffsetList.append(str(Sku.VpdOffset) + 'U')
- continue
-
- if Pcd.DatumType == 'VOID*':
- Pcd.TokenTypeList += ['PCD_TYPE_STRING']
- Pcd.InitString = 'INIT'
- if Sku.HiiDefaultValue != '' and Sku.DefaultValue == '':
- Sku.DefaultValue = Sku.HiiDefaultValue
- if Sku.DefaultValue != '':
- NumberOfSizeItems += 1
- Dict['STRING_TABLE_CNAME'].append(CName)
- Dict['STRING_TABLE_GUID'].append(TokenSpaceGuid)
-
- if StringTableIndex == 0:
- Dict['STRING_TABLE_INDEX'].append('')
- else:
- Dict['STRING_TABLE_INDEX'].append('_%d' % StringTableIndex)
- if Sku.DefaultValue[0] == 'L':
- Size = (len(Sku.DefaultValue) - 3 + 1) * 2
- Dict['STRING_TABLE_VALUE'].append(StringToArray(Sku.DefaultValue))
- elif Sku.DefaultValue[0] == '"':
- Size = len(Sku.DefaultValue) - 2 + 1
- Dict['STRING_TABLE_VALUE'].append(StringToArray(Sku.DefaultValue))
- elif Sku.DefaultValue[0] == '{':
- Size = len(Sku.DefaultValue.replace(',',' ').split())
- Dict['STRING_TABLE_VALUE'].append(Sku.DefaultValue)
-
- StringHeadOffsetList.append(str(StringTableSize) + 'U')
- Dict['SIZE_TABLE_CNAME'].append(CName)
- Dict['SIZE_TABLE_GUID'].append(TokenSpaceGuid)
- Dict['SIZE_TABLE_CURRENT_LENGTH'].append(str(Size) + 'U')
- Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append(str(Pcd.MaxDatumSize) + 'U')
- if Pcd.MaxDatumSize != '':
- MaxDatumSize = int(Pcd.MaxDatumSize, 0)
- if MaxDatumSize < Size:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Platform))
- Size = MaxDatumSize
- Dict['STRING_TABLE_LENGTH'].append(Size)
- StringTableIndex += 1
- StringTableSize += (Size)
- else:
- if "PCD_TYPE_HII" not in Pcd.TokenTypeList:
- Pcd.TokenTypeList += ['PCD_TYPE_DATA']
- if Sku.DefaultValue == 'TRUE':
- Pcd.InitString = 'INIT'
- else:
- try:
- if int(Sku.DefaultValue, 0) != 0:
- Pcd.InitString = 'INIT'
- except:
- pass
-
- #
- # For UNIT64 type PCD's value, ULL should be append to avoid
- # warning under linux building environment.
- #
- if Pcd.DatumType == "UINT64":
- ValueList.append(Sku.DefaultValue + "ULL")
- elif Pcd.DatumType in ("UINT32", "UINT16", "UINT8"):
- ValueList.append(Sku.DefaultValue + "U")
- elif Pcd.DatumType == "BOOLEAN":
- if Sku.DefaultValue in ["1", "0"]:
- ValueList.append(Sku.DefaultValue + "U")
- else:
- ValueList.append(Sku.DefaultValue)
-
- Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
-
-
- if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
- Dict['VARIABLE_HEAD_CNAME_DECL'].append(CName)
- Dict['VARIABLE_HEAD_GUID_DECL'].append(TokenSpaceGuid)
- Dict['VARIABLE_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
- Dict['VARIABLE_HEAD_VALUE'].append('{ %s }\n' % ' },\n { '.join(VariableHeadValueList))
- Dict['VARDEF_HEADER'].append('_Variable_Header')
- else:
- Dict['VARDEF_HEADER'].append('')
- if 'PCD_TYPE_VPD' in Pcd.TokenTypeList:
- Dict['VPD_HEAD_CNAME_DECL'].append(CName)
- Dict['VPD_HEAD_GUID_DECL'].append(TokenSpaceGuid)
- Dict['VPD_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
- Dict['VPD_HEAD_VALUE'].append('{ %s }' % ' }, { '.join(VpdHeadOffsetList))
- if 'PCD_TYPE_STRING' in Pcd.TokenTypeList:
- Dict['STRING_HEAD_CNAME_DECL'].append(CName)
- Dict['STRING_HEAD_GUID_DECL'].append(TokenSpaceGuid)
- Dict['STRING_HEAD_NUMSKUS_DECL'].append(len(Pcd.SkuInfoList))
- Dict['STRING_HEAD_VALUE'].append(', '.join(StringHeadOffsetList))
- if 'PCD_TYPE_DATA' in Pcd.TokenTypeList:
- Dict[Pcd.InitString+'_CNAME_DECL_'+Pcd.DatumType].append(CName)
- Dict[Pcd.InitString+'_GUID_DECL_'+Pcd.DatumType].append(TokenSpaceGuid)
- Dict[Pcd.InitString+'_NUMSKUS_DECL_'+Pcd.DatumType].append(len(Pcd.SkuInfoList))
- if Pcd.InitString == 'UNINIT':
- Dict['PCD_DATABASE_UNINIT_EMPTY'] = ''
- else:
- Dict[Pcd.InitString+'_VALUE_'+Pcd.DatumType].append(', '.join(ValueList))
-
- if Phase == 'PEI':
- NumberOfLocalTokens = NumberOfPeiLocalTokens
- if Phase == 'DXE':
- NumberOfLocalTokens = NumberOfDxeLocalTokens
-
- Dict['TOKEN_INIT'] = ['' for x in range(NumberOfLocalTokens)]
- Dict['TOKEN_CNAME'] = ['' for x in range(NumberOfLocalTokens)]
- Dict['TOKEN_GUID'] = ['' for x in range(NumberOfLocalTokens)]
- Dict['TOKEN_TYPE'] = ['' for x in range(NumberOfLocalTokens)]
-
- for Pcd in Platform.DynamicPcdList:
- CName = Pcd.TokenCName
- TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName
- if Pcd.Phase != Phase:
- continue
-
- TokenSpaceGuid = GuidStructureStringToGuidValueName(Pcd.TokenSpaceGuidValue) #(Platform.PackageList, TokenSpaceGuidCName))
- GeneratedTokenNumber = Platform.PcdTokenNumber[CName, TokenSpaceGuidCName] - 1
- if Phase == 'DXE':
- GeneratedTokenNumber -= NumberOfPeiLocalTokens
-
- EdkLogger.debug(EdkLogger.DEBUG_1, "PCD = %s.%s" % (CName, TokenSpaceGuidCName))
- EdkLogger.debug(EdkLogger.DEBUG_1, "phase = %s" % Phase)
- EdkLogger.debug(EdkLogger.DEBUG_1, "GeneratedTokenNumber = %s" % str(GeneratedTokenNumber))
-
- Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Init'
- if Pcd.InitString == 'UNINIT':
- Dict['TOKEN_INIT'][GeneratedTokenNumber] = 'Uninit'
- Dict['TOKEN_CNAME'][GeneratedTokenNumber] = CName
- Dict['TOKEN_GUID'][GeneratedTokenNumber] = TokenSpaceGuid
- Dict['TOKEN_TYPE'][GeneratedTokenNumber] = ' | '.join(Pcd.TokenTypeList)
-
- Pcd.TokenTypeList = list(set(Pcd.TokenTypeList))
- #
- # Update VARDEF_HEADER
- #
- if 'PCD_TYPE_HII' in Pcd.TokenTypeList:
- Dict['VARDEF_HEADER'][GeneratedTokenNumber] = '_Variable_Header'
- else:
- Dict['VARDEF_HEADER'][GeneratedTokenNumber] = ''
-
-
- if Pcd.Type in gDynamicExPcd:
- Dict['EXMAPPING_TABLE_EXTOKEN'].append(str(Pcd.TokenValue) + 'U')
- if Phase == 'DXE':
- GeneratedTokenNumber += NumberOfPeiLocalTokens
- #
- # Per, PCD architecture specification, PCD Token Number is 1 based and 0 is defined as invalid token number.
- # For each EX type PCD, a PCD Token Number is assigned. When the
- # PCD Driver/PEIM map EX_GUID and EX_TOKEN_NUMBER to the PCD Token Number,
- # the non-EX Protocol/PPI interface can be called to get/set the value. This assumption is made by
- # Pcd Driver/PEIM in MdeModulePkg.
- # Therefore, 1 is added to GeneratedTokenNumber to generate a PCD Token Number before being inserted
- # to the EXMAPPING_TABLE.
- #
- Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append(str(GeneratedTokenNumber + 1) + 'U')
- Dict['EXMAPPING_TABLE_GUID_INDEX'].append(str(GuidList.index(TokenSpaceGuid)) + 'U')
-
- if GuidList != []:
- Dict['GUID_TABLE_EMPTY'] = 'FALSE'
- Dict['GUID_TABLE_SIZE'] = str(len(GuidList)) + 'U'
- else:
- Dict['GUID_STRUCTURE'] = [GuidStringToGuidStructureString('00000000-0000-0000-0000-000000000000')]
-
- if StringTableIndex == 0:
- Dict['STRING_TABLE_INDEX'].append('')
- Dict['STRING_TABLE_LENGTH'].append(1)
- Dict['STRING_TABLE_CNAME'].append('')
- Dict['STRING_TABLE_GUID'].append('')
- Dict['STRING_TABLE_VALUE'].append('{ 0 }')
- else:
- Dict['STRING_TABLE_EMPTY'] = 'FALSE'
- Dict['STRING_TABLE_SIZE'] = str(StringTableSize) + 'U'
-
- if Dict['SIZE_TABLE_CNAME'] == []:
- Dict['SIZE_TABLE_CNAME'].append('')
- Dict['SIZE_TABLE_GUID'].append('')
- Dict['SIZE_TABLE_CURRENT_LENGTH'].append('0U')
- Dict['SIZE_TABLE_MAXIMUM_LENGTH'].append('0U')
-
- if NumberOfLocalTokens != 0:
- Dict['DATABASE_EMPTY'] = 'FALSE'
- Dict['LOCAL_TOKEN_NUMBER_TABLE_SIZE'] = NumberOfLocalTokens
- Dict['LOCAL_TOKEN_NUMBER'] = NumberOfLocalTokens
-
- if NumberOfExTokens != 0:
- Dict['EXMAP_TABLE_EMPTY'] = 'FALSE'
- Dict['EXMAPPING_TABLE_SIZE'] = str(NumberOfExTokens) + 'U'
- Dict['EX_TOKEN_NUMBER'] = str(NumberOfExTokens) + 'U'
- else:
- Dict['EXMAPPING_TABLE_EXTOKEN'].append('0U')
- Dict['EXMAPPING_TABLE_LOCAL_TOKEN'].append('0U')
- Dict['EXMAPPING_TABLE_GUID_INDEX'].append('0U')
-
- if NumberOfSizeItems != 0:
- Dict['SIZE_TABLE_SIZE'] = str(NumberOfSizeItems * 2) + 'U'
-
- AutoGenH.Append(gPcdDatabaseAutoGenH.Replace(Dict))
- if NumberOfLocalTokens == 0:
- AutoGenC.Append(gEmptyPcdDatabaseAutoGenC.Replace(Dict))
- else:
- AutoGenC.Append(gPcdDatabaseAutoGenC.Replace(Dict))
-
- return AutoGenH, AutoGenC
-
-## Create code for PCD database
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreatePcdDatabaseCode (Info, AutoGenC, AutoGenH):
- if Info.PcdIsDriver == "":
- return
- if Info.PcdIsDriver not in gPcdPhaseMap:
- EdkLogger.error("build", AUTOGEN_ERROR, "Not supported PcdIsDriver type:%s" % Info.PcdIsDriver,
- ExtraData="[%s]" % str(Info))
-
- AutoGenH.Append(gPcdDatabaseCommonAutoGenH)
- AdditionalAutoGenH, AdditionalAutoGenC = CreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, 'PEI')
- AutoGenH.Append(AdditionalAutoGenH.String)
-
- Phase = gPcdPhaseMap[Info.PcdIsDriver]
- if Phase == 'PEI':
- AutoGenC.Append(AdditionalAutoGenC.String)
-
- if Phase == 'DXE':
- AdditionalAutoGenH, AdditionalAutoGenC = CreatePcdDatabasePhaseSpecificAutoGen (Info.PlatformInfo, Phase)
- AutoGenH.Append(AdditionalAutoGenH.String)
- AutoGenC.Append(AdditionalAutoGenC.String)
- AutoGenH.Append(gPcdDatabaseEpilogueAutoGenH)
-
-## Create code for library constructor
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):
- #
- # Library Constructors
- #
- ConstructorPrototypeString = TemplateString()
- ConstructorCallingString = TemplateString()
- if Info.IsLibrary:
- DependentLibraryList = [Info.Module]
- else:
- DependentLibraryList = Info.DependentLibraryList
- for Lib in DependentLibraryList:
- if len(Lib.ConstructorList) <= 0:
- continue
- Dict = {'Function':Lib.ConstructorList}
- if Lib.ModuleType in ['BASE', 'SEC']:
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))
- ConstructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))
- elif Lib.ModuleType in ['PEI_CORE','PEIM']:
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))
- ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))
- elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
- 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))
- ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))
-
- if str(ConstructorPrototypeString) == '':
- ConstructorPrototypeList = []
- else:
- ConstructorPrototypeList = [str(ConstructorPrototypeString)]
- if str(ConstructorCallingString) == '':
- ConstructorCallingList = []
- else:
- ConstructorCallingList = [str(ConstructorCallingString)]
-
- Dict = {
- 'Type' : 'Constructor',
- 'FunctionPrototype' : ConstructorPrototypeList,
- 'FunctionCall' : ConstructorCallingList
- }
- if Info.IsLibrary:
- AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)
- else:
- if Info.ModuleType in ['BASE', 'SEC']:
- AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))
- elif Info.ModuleType in ['PEI_CORE','PEIM']:
- AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))
- elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
- 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
- AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))
-
-## Create code for library destructor
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):
- #
- # Library Destructors
- #
- DestructorPrototypeString = TemplateString()
- DestructorCallingString = TemplateString()
- if Info.IsLibrary:
- DependentLibraryList = [Info.Module]
- else:
- DependentLibraryList = Info.DependentLibraryList
- for Index in range(len(DependentLibraryList)-1, -1, -1):
- Lib = DependentLibraryList[Index]
- if len(Lib.DestructorList) <= 0:
- continue
- Dict = {'Function':Lib.DestructorList}
- if Lib.ModuleType in ['BASE', 'SEC']:
- DestructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))
- DestructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))
- elif Lib.ModuleType in ['PEI_CORE','PEIM']:
- DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))
- DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))
- elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
- 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:
- DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))
- DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))
-
- if str(DestructorPrototypeString) == '':
- DestructorPrototypeList = []
- else:
- DestructorPrototypeList = [str(DestructorPrototypeString)]
- if str(DestructorCallingString) == '':
- DestructorCallingList = []
- else:
- DestructorCallingList = [str(DestructorCallingString)]
-
- Dict = {
- 'Type' : 'Destructor',
- 'FunctionPrototype' : DestructorPrototypeList,
- 'FunctionCall' : DestructorCallingList
- }
- if Info.IsLibrary:
- AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)
- else:
- if Info.ModuleType in ['BASE', 'SEC']:
- AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))
- elif Info.ModuleType in ['PEI_CORE','PEIM']:
- AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))
- elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',
- 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:
- AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))
-
-
-## Create code for ModuleEntryPoint
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):
- if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:
- return
- #
- # Module Entry Points
- #
- NumEntryPoints = len(Info.Module.ModuleEntryPointList)
- if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:
- PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']
- else:
- PiSpecVersion = '0x00000000'
- if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:
- UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']
- else:
- UefiSpecVersion = '0x00000000'
- Dict = {
- 'Function' : Info.Module.ModuleEntryPointList,
- 'PiSpecVersion' : PiSpecVersion + 'U',
- 'UefiSpecVersion': UefiSpecVersion + 'U'
- }
-
- if Info.ModuleType in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:
- if Info.SourceFileList <> None and Info.SourceFileList <> []:
- if NumEntryPoints != 1:
- EdkLogger.error(
- "build",
- AUTOGEN_ERROR,
- '%s must have exactly one entry point' % Info.ModuleType,
- File=str(Info),
- ExtraData= ", ".join(Info.Module.ModuleEntryPointList)
- )
- if Info.ModuleType == 'PEI_CORE':
- AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))
- AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType == 'DXE_CORE':
- AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))
- AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType == 'SMM_CORE':
- AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))
- AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType == 'PEIM':
- if NumEntryPoints < 2:
- AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))
- else:
- AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))
- AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:
- if NumEntryPoints < 2:
- AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))
- else:
- AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))
- AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType == 'DXE_SMM_DRIVER':
- if NumEntryPoints == 0:
- AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))
- else:
- AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))
- AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict))
- elif Info.ModuleType == 'UEFI_APPLICATION':
- if NumEntryPoints < 2:
- AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))
- else:
- AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))
- AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))
-
-## Create code for ModuleUnloadImage
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):
- if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:
- return
- #
- # Unload Image Handlers
- #
- NumUnloadImage = len(Info.Module.ModuleUnloadImageList)
- Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}
- if NumUnloadImage < 2:
- AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))
- else:
- AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))
- AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))
-
-## Create code for GUID
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):
- if Info.IsLibrary:
- return
-
- if Info.ModuleType in ["USER_DEFINED", "BASE"]:
- GuidType = "GUID"
- else:
- GuidType = "EFI_GUID"
-
- if Info.GuidList:
- AutoGenC.Append("\n// Guids\n")
- #
- # GUIDs
- #
- for Key in Info.GuidList:
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))
-
-## Create code for protocol
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):
- if Info.IsLibrary:
- return
-
- if Info.ModuleType in ["USER_DEFINED", "BASE"]:
- GuidType = "GUID"
- else:
- GuidType = "EFI_GUID"
-
- if Info.ProtocolList:
- AutoGenC.Append("\n// Protocols\n")
- #
- # Protocol GUIDs
- #
- for Key in Info.ProtocolList:
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))
-
-## Create code for PPI
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):
- if Info.IsLibrary:
- return
-
- if Info.ModuleType in ["USER_DEFINED", "BASE"]:
- GuidType = "GUID"
- else:
- GuidType = "EFI_GUID"
-
- if Info.PpiList:
- AutoGenC.Append("\n// PPIs\n")
- #
- # PPI GUIDs
- #
- for Key in Info.PpiList:
- AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))
-
-## Create code for PCD
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreatePcdCode(Info, AutoGenC, AutoGenH):
-
- # Collect Token Space GUIDs used by DynamicEc PCDs
- TokenSpaceList = []
- for Pcd in Info.ModulePcdList:
- if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:
- TokenSpaceList += [Pcd.TokenSpaceGuidCName]
-
- # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found
- if TokenSpaceList <> []:
- AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")
- if Info.ModuleType in ["USER_DEFINED", "BASE"]:
- GuidType = "GUID"
- else:
- GuidType = "EFI_GUID"
- for Item in TokenSpaceList:
- AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))
-
- if Info.IsLibrary:
- if Info.ModulePcdList:
- AutoGenH.Append("\n// PCD definitions\n")
- for Pcd in Info.ModulePcdList:
- CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)
- else:
- if Info.ModulePcdList:
- AutoGenH.Append("\n// Definition of PCDs used in this module\n")
- AutoGenC.Append("\n// Definition of PCDs used in this module\n")
- for Pcd in Info.ModulePcdList:
- CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)
-
- if Info.LibraryPcdList:
- AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")
- AutoGenC.Append("\n// Definition of PCDs used in libraries\n")
- for Pcd in Info.LibraryPcdList:
- CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)
- CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)
-
-## Create code for unicode string definition
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
-# @param UniGenBinBuffer Buffer to store uni string package data
-#
-def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):
- WorkingDir = os.getcwd()
- os.chdir(Info.WorkspaceDir)
-
- IncList = [Info.MetaFile.Dir]
- # Get all files under [Sources] section in inf file for EDK-II module
- EDK2Module = True
- SrcList = [F for F in Info.SourceFileList]
- if Info.AutoGenVersion < 0x00010005:
- EDK2Module = False
- # Get all files under the module directory for EDK-I module
- Cwd = os.getcwd()
- os.chdir(Info.MetaFile.Dir)
- for Root, Dirs, Files in os.walk("."):
- if 'CVS' in Dirs:
- Dirs.remove('CVS')
- if '.svn' in Dirs:
- Dirs.remove('.svn')
- for File in Files:
- File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)
- if File in SrcList:
- continue
- SrcList.append(File)
- os.chdir(Cwd)
-
- if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:
- CompatibleMode = True
- else:
- CompatibleMode = False
-
- #
- # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2
- #
- if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:
- if CompatibleMode:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "-c and -s build options should be used exclusively",
- ExtraData="[%s]" % str(Info))
- ShellMode = True
- else:
- ShellMode = False
-
- #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules
- if EDK2Module:
- FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]
- else:
- FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]
- Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)
- if CompatibleMode or UniGenCFlag:
- AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")
- AutoGenC.Append(Code)
- AutoGenC.Append("\n")
- AutoGenH.Append("\n//\n//Unicode String ID\n//\n")
- AutoGenH.Append(Header)
- if CompatibleMode or UniGenCFlag:
- AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)
- os.chdir(WorkingDir)
-
-## Create common code
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateHeaderCode(Info, AutoGenC, AutoGenH):
- # file header
- AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))
- # header file Prologue
- AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))
- AutoGenH.Append(gAutoGenHCppPrologueString)
- if Info.AutoGenVersion >= 0x00010005:
- # header files includes
- AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)
- if Info.ModuleType in gModuleTypeHeaderFile \
- and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:
- AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])
- #
- # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h
- # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.
- #
- if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:
- AutoGenH.Append("#include <Library/PcdLib.h>\n")
-
- AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;\n\n')
-
- if Info.IsLibrary:
- return
-
- AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))
-
- if Info.IsLibrary:
- return
- # C file header
- AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))
- if Info.AutoGenVersion >= 0x00010005:
- # C file header files includes
- if Info.ModuleType in gModuleTypeHeaderFile:
- for Inc in gModuleTypeHeaderFile[Info.ModuleType]:
- AutoGenC.Append("#include <%s>\n" % Inc)
- else:
- AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)
-
- #
- # Publish the CallerId Guid
- #
- AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))
-
-## Create common code for header file
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-#
-def CreateFooterCode(Info, AutoGenC, AutoGenH):
- AutoGenH.Append(gAutoGenHEpilogueString)
-
-## Create code for a module
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenC The TemplateString object for C code
-# @param AutoGenH The TemplateString object for header file
-# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True
-# @param UniGenBinBuffer Buffer to store uni string package data
-#
-def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):
- CreateHeaderCode(Info, AutoGenC, AutoGenH)
-
- if Info.AutoGenVersion >= 0x00010005:
- CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)
- CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)
- CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)
- CreatePcdCode(Info, AutoGenC, AutoGenH)
- CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)
- CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)
- CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)
- CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)
-
- if Info.UnicodeFileList:
- FileName = "%sStrDefs.h" % Info.Name
- StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))
- StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))
- CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)
- StringH.Append("\n#endif\n")
- AutoGenH.Append('#include "%s"\n' % FileName)
-
- CreateFooterCode(Info, AutoGenC, AutoGenH)
-
- # no generation of AutoGen.c for Edk modules without unicode file
- if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:
- AutoGenC.String = ''
-
-## Create the code file
-#
-# @param FilePath The path of code file
-# @param Content The content of code file
-# @param IsBinaryFile The flag indicating if the file is binary file or not
-#
-# @retval True If file content is changed or file doesn't exist
-# @retval False If the file exists and the content is not changed
-#
-def Generate(FilePath, Content, IsBinaryFile):
- return SaveFileOnChange(FilePath, Content, IsBinaryFile)
-
+## @file\r
+# Routines for generating AutoGen.h and AutoGen.c\r
+#\r
+# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
+# This program and the accompanying materials\r
+# are licensed and made available under the terms and conditions of the BSD License\r
+# which accompanies this distribution. The full text of the license may be found at\r
+# http://opensource.org/licenses/bsd-license.php\r
+#\r
+# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+#\r
+\r
+## Import Modules\r
+#\r
+import string\r
+import collections\r
+import struct\r
+from Common import EdkLogger\r
+\r
+from Common.BuildToolError import *\r
+from Common.DataType import *\r
+from Common.Misc import *\r
+from Common.String import StringToArray\r
+from StrGather import *\r
+from GenPcdDb import CreatePcdDatabaseCode\r
+from IdfClassObject import *\r
+\r
+## PCD type string\r
+gItemTypeStringDatabase = {\r
+ TAB_PCDS_FEATURE_FLAG : 'FixedAtBuild',\r
+ TAB_PCDS_FIXED_AT_BUILD : 'FixedAtBuild',\r
+ TAB_PCDS_PATCHABLE_IN_MODULE: 'BinaryPatch',\r
+ TAB_PCDS_DYNAMIC : '',\r
+ TAB_PCDS_DYNAMIC_DEFAULT : '',\r
+ TAB_PCDS_DYNAMIC_VPD : '',\r
+ TAB_PCDS_DYNAMIC_HII : '',\r
+ TAB_PCDS_DYNAMIC_EX : '',\r
+ TAB_PCDS_DYNAMIC_EX_DEFAULT : '',\r
+ TAB_PCDS_DYNAMIC_EX_VPD : '',\r
+ TAB_PCDS_DYNAMIC_EX_HII : '',\r
+}\r
+\r
+## Dynamic PCD types\r
+gDynamicPcd = [TAB_PCDS_DYNAMIC, TAB_PCDS_DYNAMIC_DEFAULT, TAB_PCDS_DYNAMIC_VPD, TAB_PCDS_DYNAMIC_HII]\r
+\r
+## Dynamic-ex PCD types\r
+gDynamicExPcd = [TAB_PCDS_DYNAMIC_EX, TAB_PCDS_DYNAMIC_EX_DEFAULT, TAB_PCDS_DYNAMIC_EX_VPD, TAB_PCDS_DYNAMIC_EX_HII]\r
+\r
+## Datum size\r
+gDatumSizeStringDatabase = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOLEAN','VOID*':'8'}\r
+gDatumSizeStringDatabaseH = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'BOOL','VOID*':'PTR'}\r
+gDatumSizeStringDatabaseLib = {'UINT8':'8','UINT16':'16','UINT32':'32','UINT64':'64','BOOLEAN':'Bool','VOID*':'Ptr'}\r
+\r
+## AutoGen File Header Templates\r
+gAutoGenHeaderString = TemplateString("""\\r
+/**\r
+ DO NOT EDIT\r
+ FILE auto-generated\r
+ Module name:\r
+ ${FileName}\r
+ Abstract: Auto-generated ${FileName} for building module or library.\r
+**/\r
+""")\r
+\r
+gAutoGenHPrologueString = TemplateString("""\r
+#ifndef _${File}_${Guid}\r
+#define _${File}_${Guid}\r
+\r
+""")\r
+\r
+gAutoGenHCppPrologueString = """\\r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif\r
+\r
+"""\r
+\r
+gAutoGenHEpilogueString = """\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif\r
+"""\r
+\r
+## PEI Core Entry Point Templates\r
+gPeiCoreEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+VOID\r
+EFIAPI\r
+${Function} (\r
+ IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
+ IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
+ IN VOID *Context\r
+ );\r
+${END}\r
+""")\r
+\r
+gPeiCoreEntryPointString = TemplateString("""\r
+${BEGIN}\r
+VOID\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData,\r
+ IN CONST EFI_PEI_PPI_DESCRIPTOR *PpiList,\r
+ IN VOID *Context\r
+ )\r
+\r
+{\r
+ ${Function} (SecCoreData, PpiList, Context);\r
+}\r
+${END}\r
+""")\r
+\r
+\r
+## DXE Core Entry Point Templates\r
+gDxeCoreEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+VOID\r
+EFIAPI\r
+${Function} (\r
+ IN VOID *HobStart\r
+ );\r
+${END}\r
+""")\r
+\r
+gDxeCoreEntryPointString = TemplateString("""\r
+${BEGIN}\r
+VOID\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN VOID *HobStart\r
+ )\r
+\r
+{\r
+ ${Function} (HobStart);\r
+}\r
+${END}\r
+""")\r
+\r
+## PEIM Entry Point Templates\r
+gPeimEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ );\r
+${END}\r
+""")\r
+\r
+gPeimEntryPointString = [\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ )\r
+\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+"""),\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ )\r
+\r
+{\r
+ return ${Function} (FileHandle, PeiServices);\r
+}\r
+${END}\r
+"""),\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gPeimRevision = ${PiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ )\r
+\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_STATUS CombinedStatus;\r
+\r
+ CombinedStatus = EFI_LOAD_ERROR;\r
+${BEGIN}\r
+ Status = ${Function} (FileHandle, PeiServices);\r
+ if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r
+ CombinedStatus = Status;\r
+ }\r
+${END}\r
+ return CombinedStatus;\r
+}\r
+""")\r
+]\r
+\r
+## SMM_CORE Entry Point Templates\r
+gSmmCoreEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );\r
+${END}\r
+""")\r
+\r
+gSmmCoreEntryPointString = TemplateString("""\r
+${BEGIN}\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ return ${Function} (ImageHandle, SystemTable);\r
+}\r
+${END}\r
+""")\r
+\r
+## DXE SMM Entry Point Templates\r
+gDxeSmmEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );\r
+${END}\r
+""")\r
+\r
+gDxeSmmEntryPointString = [\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+"""),\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
+static EFI_STATUS mDriverEntryPointStatus;\r
+\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+ IN EFI_STATUS Status\r
+ )\r
+{\r
+ if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
+ mDriverEntryPointStatus = Status;\r
+ }\r
+ LongJump (&mJumpContext, (UINTN)-1);\r
+ ASSERT (FALSE);\r
+}\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
+\r
+${BEGIN}\r
+ if (SetJump (&mJumpContext) == 0) {\r
+ ExitDriver (${Function} (ImageHandle, SystemTable));\r
+ ASSERT (FALSE);\r
+ }\r
+${END}\r
+\r
+ return mDriverEntryPointStatus;\r
+}\r
+""")\r
+]\r
+\r
+## UEFI Driver Entry Point Templates\r
+gUefiDriverEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );\r
+${END}\r
+""")\r
+\r
+gUefiDriverEntryPointString = [\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+"""),\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+\r
+{\r
+ return ${Function} (ImageHandle, SystemTable);\r
+}\r
+${END}\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+ IN EFI_STATUS Status\r
+ )\r
+{\r
+ if (EFI_ERROR (Status)) {\r
+ ProcessLibraryDestructorList (gImageHandle, gST);\r
+ }\r
+ gBS->Exit (gImageHandle, Status, 0, NULL);\r
+}\r
+"""),\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+const UINT32 _gDxeRevision = ${PiSpecVersion};\r
+\r
+static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
+static EFI_STATUS mDriverEntryPointStatus;\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
+ ${BEGIN}\r
+ if (SetJump (&mJumpContext) == 0) {\r
+ ExitDriver (${Function} (ImageHandle, SystemTable));\r
+ ASSERT (FALSE);\r
+ }\r
+ ${END}\r
+ return mDriverEntryPointStatus;\r
+}\r
+\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+ IN EFI_STATUS Status\r
+ )\r
+{\r
+ if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
+ mDriverEntryPointStatus = Status;\r
+ }\r
+ LongJump (&mJumpContext, (UINTN)-1);\r
+ ASSERT (FALSE);\r
+}\r
+""")\r
+]\r
+\r
+\r
+## UEFI Application Entry Point Templates\r
+gUefiApplicationEntryPointPrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );\r
+${END}\r
+""")\r
+\r
+gUefiApplicationEntryPointString = [\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+"""),\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+\r
+{\r
+ return ${Function} (ImageHandle, SystemTable);\r
+}\r
+${END}\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+ IN EFI_STATUS Status\r
+ )\r
+{\r
+ if (EFI_ERROR (Status)) {\r
+ ProcessLibraryDestructorList (gImageHandle, gST);\r
+ }\r
+ gBS->Exit (gImageHandle, Status, 0, NULL);\r
+}\r
+"""),\r
+TemplateString("""\r
+const UINT32 _gUefiDriverRevision = ${UefiSpecVersion};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleEntryPointList (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+\r
+{\r
+ ${BEGIN}\r
+ if (SetJump (&mJumpContext) == 0) {\r
+ ExitDriver (${Function} (ImageHandle, SystemTable));\r
+ ASSERT (FALSE);\r
+ }\r
+ ${END}\r
+ return mDriverEntryPointStatus;\r
+}\r
+\r
+static BASE_LIBRARY_JUMP_BUFFER mJumpContext;\r
+static EFI_STATUS mDriverEntryPointStatus = EFI_LOAD_ERROR;\r
+\r
+VOID\r
+EFIAPI\r
+ExitDriver (\r
+ IN EFI_STATUS Status\r
+ )\r
+{\r
+ if (!EFI_ERROR (Status) || EFI_ERROR (mDriverEntryPointStatus)) {\r
+ mDriverEntryPointStatus = Status;\r
+ }\r
+ LongJump (&mJumpContext, (UINTN)-1);\r
+ ASSERT (FALSE);\r
+}\r
+""")\r
+]\r
+\r
+## UEFI Unload Image Templates\r
+gUefiUnloadImagePrototype = TemplateString("""\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle\r
+ );\r
+${END}\r
+""")\r
+\r
+gUefiUnloadImageString = [\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleUnloadList (\r
+ IN EFI_HANDLE ImageHandle\r
+ )\r
+{\r
+ return EFI_SUCCESS;\r
+}\r
+"""),\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
+\r
+${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleUnloadList (\r
+ IN EFI_HANDLE ImageHandle\r
+ )\r
+{\r
+ return ${Function} (ImageHandle);\r
+}\r
+${END}\r
+"""),\r
+TemplateString("""\r
+GLOBAL_REMOVE_IF_UNREFERENCED const UINT8 _gDriverUnloadImageCount = ${Count};\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ProcessModuleUnloadList (\r
+ IN EFI_HANDLE ImageHandle\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = EFI_SUCCESS;\r
+${BEGIN}\r
+ if (EFI_ERROR (Status)) {\r
+ ${Function} (ImageHandle);\r
+ } else {\r
+ Status = ${Function} (ImageHandle);\r
+ }\r
+${END}\r
+ return Status;\r
+}\r
+""")\r
+]\r
+\r
+gLibraryStructorPrototype = {\r
+'BASE' : TemplateString("""${BEGIN}\r
+RETURN_STATUS\r
+EFIAPI\r
+${Function} (\r
+ VOID\r
+ );${END}\r
+"""),\r
+\r
+'PEI' : TemplateString("""${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ );${END}\r
+"""),\r
+\r
+'DXE' : TemplateString("""${BEGIN}\r
+EFI_STATUS\r
+EFIAPI\r
+${Function} (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ );${END}\r
+"""),\r
+}\r
+\r
+gLibraryStructorCall = {\r
+'BASE' : TemplateString("""${BEGIN}\r
+ Status = ${Function} ();\r
+ ASSERT_EFI_ERROR (Status);${END}\r
+"""),\r
+\r
+'PEI' : TemplateString("""${BEGIN}\r
+ Status = ${Function} (FileHandle, PeiServices);\r
+ ASSERT_EFI_ERROR (Status);${END}\r
+"""),\r
+\r
+'DXE' : TemplateString("""${BEGIN}\r
+ Status = ${Function} (ImageHandle, SystemTable);\r
+ ASSERT_EFI_ERROR (Status);${END}\r
+"""),\r
+}\r
+\r
+## Library Constructor and Destructor Templates\r
+gLibraryString = {\r
+'BASE' : TemplateString("""\r
+${BEGIN}${FunctionPrototype}${END}\r
+\r
+VOID\r
+EFIAPI\r
+ProcessLibrary${Type}List (\r
+ VOID\r
+ )\r
+{\r
+${BEGIN} EFI_STATUS Status;\r
+${FunctionCall}${END}\r
+}\r
+"""),\r
+\r
+'PEI' : TemplateString("""\r
+${BEGIN}${FunctionPrototype}${END}\r
+\r
+VOID\r
+EFIAPI\r
+ProcessLibrary${Type}List (\r
+ IN EFI_PEI_FILE_HANDLE FileHandle,\r
+ IN CONST EFI_PEI_SERVICES **PeiServices\r
+ )\r
+{\r
+${BEGIN} EFI_STATUS Status;\r
+${FunctionCall}${END}\r
+}\r
+"""),\r
+\r
+'DXE' : TemplateString("""\r
+${BEGIN}${FunctionPrototype}${END}\r
+\r
+VOID\r
+EFIAPI\r
+ProcessLibrary${Type}List (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+${BEGIN} EFI_STATUS Status;\r
+${FunctionCall}${END}\r
+}\r
+"""),\r
+}\r
+\r
+gBasicHeaderFile = "Base.h"\r
+\r
+gModuleTypeHeaderFile = {\r
+ "BASE" : [gBasicHeaderFile],\r
+ "SEC" : ["PiPei.h", "Library/DebugLib.h"],\r
+ "PEI_CORE" : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],\r
+ "PEIM" : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],\r
+ "DXE_CORE" : ["PiDxe.h", "Library/DebugLib.h", "Library/DxeCoreEntryPoint.h"],\r
+ "DXE_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "DXE_SMM_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "DXE_RUNTIME_DRIVER": ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "DXE_SAL_DRIVER" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "UEFI_DRIVER" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "UEFI_APPLICATION" : ["Uefi.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiBootServicesTableLib.h", "Library/UefiApplicationEntryPoint.h"],\r
+ "SMM_CORE" : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],\r
+ "USER_DEFINED" : [gBasicHeaderFile]\r
+}\r
+\r
+## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName \r
+# the TokenName and Guid comparison to avoid define name collisions.\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+#\r
+def DynExPcdTokenNumberMapping(Info, AutoGenH):\r
+ ExTokenCNameList = []\r
+ PcdExList = []\r
+ if Info.IsLibrary:\r
+ PcdList = Info.LibraryPcdList\r
+ else:\r
+ PcdList = Info.ModulePcdList\r
+ for Pcd in PcdList:\r
+ if Pcd.Type in gDynamicExPcd:\r
+ ExTokenCNameList.append(Pcd.TokenCName)\r
+ PcdExList.append(Pcd)\r
+ if len(ExTokenCNameList) == 0:\r
+ return\r
+ AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')\r
+ # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.\r
+ # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter. \r
+ # Use the Guid pointer to see if it matches any of the token space GUIDs.\r
+ TokenCNameList = []\r
+ for TokenCName in ExTokenCNameList:\r
+ if TokenCName in TokenCNameList:\r
+ continue\r
+ Index = 0\r
+ Count = ExTokenCNameList.count(TokenCName)\r
+ for Pcd in PcdExList:\r
+ RealTokenCName = Pcd.TokenCName\r
+ for PcdItem in GlobalData.MixedPcd:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
+ RealTokenCName = PcdItem[0]\r
+ break\r
+ if Pcd.TokenCName == TokenCName:\r
+ Index = Index + 1\r
+ if Index == 1:\r
+ AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (RealTokenCName))\r
+ AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
+ else:\r
+ AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
+ if Index == Count:\r
+ AutoGenH.Append('0 \\\n )\n')\r
+ TokenCNameList.append(TokenCName)\r
+ \r
+ TokenCNameList = []\r
+ for TokenCName in ExTokenCNameList:\r
+ if TokenCName in TokenCNameList:\r
+ continue\r
+ Index = 0\r
+ Count = ExTokenCNameList.count(TokenCName)\r
+ for Pcd in PcdExList:\r
+ RealTokenCName = Pcd.TokenCName\r
+ for PcdItem in GlobalData.MixedPcd:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
+ RealTokenCName = PcdItem[0]\r
+ break\r
+ if Pcd.Type in gDynamicExPcd and Pcd.TokenCName == TokenCName:\r
+ Index = Index + 1\r
+ if Index == 1:\r
+ AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (RealTokenCName))\r
+ AutoGenH.Append('\\\n (GuidPtr == NULL) ? 0:')\r
+ AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
+ else:\r
+ AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
+ if Index == Count:\r
+ AutoGenH.Append('0 \\\n )\n')\r
+ # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID. \r
+ # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler\r
+ # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().\r
+ # COMPAREGUID() will only be used if the Guid passed in is local to the module.\r
+ AutoGenH.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'\r
+ % (RealTokenCName, RealTokenCName, RealTokenCName, RealTokenCName))\r
+ TokenCNameList.append(TokenCName)\r
+\r
+def GetPcdSize(Pcd):\r
+ if Pcd.DatumType == 'VOID*':\r
+ Value = Pcd.DefaultValue\r
+ if Value in [None, '']:\r
+ return 1\r
+ elif Value[0] == 'L':\r
+ return (len(Value) - 2) * 2\r
+ elif Value[0] == '{':\r
+ return len(Value.split(','))\r
+ else:\r
+ return len(Value) - 1\r
+ if Pcd.DatumType == 'UINT64':\r
+ return 8\r
+ if Pcd.DatumType == 'UINT32':\r
+ return 4\r
+ if Pcd.DatumType == 'UINT16':\r
+ return 2\r
+ if Pcd.DatumType == 'UINT8':\r
+ return 1\r
+ if Pcd.DatumType == 'BOOLEAN':\r
+ return 1\r
+\r
+\r
+## Create code for module PCDs\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+# @param Pcd The PCD object\r
+#\r
+def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
+ TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue #Info.GuidList[Pcd.TokenSpaceGuidCName]\r
+ PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
+ #\r
+ # Write PCDs\r
+ #\r
+ TokenCName = Pcd.TokenCName\r
+ for PcdItem in GlobalData.MixedPcd:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
+ TokenCName = PcdItem[0]\r
+ break\r
+ PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
+ PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r
+ PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r
+ FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r
+\r
+ if GlobalData.BuildOptionPcd:\r
+ for PcdItem in GlobalData.BuildOptionPcd:\r
+ if (Pcd.TokenSpaceGuidCName, TokenCName) == (PcdItem[0], PcdItem[1]):\r
+ Pcd.DefaultValue = PcdItem[2]\r
+ break\r
+ \r
+ if Pcd.Type in gDynamicExPcd:\r
+ TokenNumber = int(Pcd.TokenValue, 0)\r
+ # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with \r
+ # different Guids but same TokenCName\r
+ PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + TokenCName\r
+ AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r
+ else:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
+ # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
+ # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
+ # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
+ # report warning message notify the PI that they are attempting to build a module \r
+ # that must be included in a flash image in order to be functional. These Dynamic PCD \r
+ # will not be added into the Database unless it is used by other modules that are \r
+ # included in the FDF file. \r
+ # In this case, just assign an invalid token number to make it pass build.\r
+ if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
+ TokenNumber = 0\r
+ else:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ else:\r
+ TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
+ AutoGenH.Append('\n#define %s %dU\n' % (PcdTokenName, TokenNumber))\r
+\r
+ EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + TokenCName + "." + Pcd.TokenSpaceGuidCName)\r
+ if Pcd.Type not in gItemTypeStringDatabase:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if Pcd.DatumType not in gDatumSizeStringDatabase:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+\r
+ DatumSize = gDatumSizeStringDatabase[Pcd.DatumType]\r
+ DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType]\r
+ GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName\r
+ SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName\r
+ SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName\r
+ GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r
+ \r
+ PcdExCNameList = []\r
+ if Pcd.Type in gDynamicExPcd:\r
+ if Info.IsLibrary:\r
+ PcdList = Info.LibraryPcdList\r
+ else:\r
+ PcdList = Info.ModulePcdList\r
+ for PcdModule in PcdList:\r
+ if PcdModule.Type in gDynamicExPcd:\r
+ PcdExCNameList.append(PcdModule.TokenCName)\r
+ # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r
+ # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
+ # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
+ if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
+ AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r
+ AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
+ AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ elif Pcd.Type in gDynamicPcd:\r
+ PcdList = []\r
+ PcdCNameList = []\r
+ PcdList.extend(Info.LibraryPcdList)\r
+ PcdList.extend(Info.ModulePcdList)\r
+ for PcdModule in PcdList:\r
+ if PcdModule.Type in gDynamicPcd:\r
+ PcdCNameList.append(PcdModule.TokenCName)\r
+ if PcdCNameList.count(Pcd.TokenCName) > 1:\r
+ EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName. They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r
+ else:\r
+ AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r
+ Const = 'const'\r
+ if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ Const = ''\r
+ Type = ''\r
+ Array = ''\r
+ Value = Pcd.DefaultValue\r
+ Unicode = False\r
+ ValueNumber = 0\r
+\r
+ if Pcd.DatumType == 'BOOLEAN':\r
+ BoolValue = Value.upper()\r
+ if BoolValue == 'TRUE' or BoolValue == '1':\r
+ Value = '1U'\r
+ elif BoolValue == 'FALSE' or BoolValue == '0':\r
+ Value = '0U'\r
+\r
+ if Pcd.DatumType in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:\r
+ try:\r
+ if Value.upper().startswith('0X'):\r
+ ValueNumber = int (Value, 16)\r
+ else:\r
+ ValueNumber = int (Value)\r
+ except:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if Pcd.DatumType == 'UINT64':\r
+ if ValueNumber < 0:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ elif ValueNumber >= 0x10000000000000000:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if not Value.endswith('ULL'):\r
+ Value += 'ULL'\r
+ elif Pcd.DatumType == 'UINT32':\r
+ if ValueNumber < 0:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ elif ValueNumber >= 0x100000000:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if not Value.endswith('U'):\r
+ Value += 'U'\r
+ elif Pcd.DatumType == 'UINT16':\r
+ if ValueNumber < 0:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ elif ValueNumber >= 0x10000:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if not Value.endswith('U'):\r
+ Value += 'U' \r
+ elif Pcd.DatumType == 'UINT8':\r
+ if ValueNumber < 0:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ elif ValueNumber >= 0x100:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if not Value.endswith('U'):\r
+ Value += 'U'\r
+ if Pcd.DatumType == 'VOID*':\r
+ if Pcd.MaxDatumSize == None or Pcd.MaxDatumSize == '':\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+\r
+ ArraySize = int(Pcd.MaxDatumSize, 0)\r
+ if Value[0] == '{':\r
+ Type = '(VOID *)'\r
+ else:\r
+ if Value[0] == 'L':\r
+ Unicode = True\r
+ Value = Value.lstrip('L') #.strip('"')\r
+ Value = eval(Value) # translate escape character\r
+ NewValue = '{'\r
+ for Index in range(0,len(Value)):\r
+ if Unicode:\r
+ NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r
+ else:\r
+ NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r
+ if Unicode:\r
+ ArraySize = ArraySize / 2;\r
+\r
+ if ArraySize < (len(Value) + 1):\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ Value = NewValue + '0 }'\r
+ Array = '[%d]' % ArraySize\r
+ #\r
+ # skip casting for fixed at build since it breaks ARM assembly.\r
+ # Long term we need PCD macros that work in assembly\r
+ #\r
+ elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD:\r
+ Value = "((%s)%s)" % (Pcd.DatumType, Value)\r
+\r
+ if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ PcdValueName = '_PCD_PATCHABLE_VALUE_' + TokenCName\r
+ else:\r
+ PcdValueName = '_PCD_VALUE_' + TokenCName\r
+ \r
+ if Pcd.DatumType == 'VOID*':\r
+ #\r
+ # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r
+ #\r
+ if Unicode:\r
+ AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT16 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
+ AutoGenH.Append('extern %s UINT16 %s%s;\n' %(Const, PcdVariableName, Array))\r
+ AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
+ else:\r
+ AutoGenH.Append('#define %s %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
+ AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r
+ AutoGenH.Append('#define %s %s%s\n' %(GetModeName, Type, PcdVariableName))\r
+ \r
+ PcdDataSize = GetPcdSize(Pcd)\r
+ if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r
+ AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
+ AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
+ \r
+ if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, Pcd.MaxDatumSize))\r
+ AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
+ AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r
+ elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
+ AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
+ AutoGenH.Append('extern volatile %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
+ AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
+ \r
+ PcdDataSize = GetPcdSize(Pcd)\r
+ AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r
+ \r
+ AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
+ AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r
+ else:\r
+ PcdDataSize = GetPcdSize(Pcd)\r
+ AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
+ AutoGenH.Append('#define %s %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
+ \r
+ AutoGenH.Append('#define %s %s\n' %(PcdValueName, Value))\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
+ AutoGenH.Append('extern %s %s %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
+ AutoGenH.Append('#define %s %s%s\n' % (GetModeName, Type, PcdVariableName))\r
+\r
+ if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
+ AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName, PcdVariableName))\r
+ else:\r
+ AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
+\r
+## Create code for library module PCDs\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+# @param Pcd The PCD object\r
+#\r
+def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
+ PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
+ TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r
+ TokenCName = Pcd.TokenCName\r
+ for PcdItem in GlobalData.MixedPcd:\r
+ if (TokenCName, TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
+ TokenCName = PcdItem[0]\r
+ break\r
+ PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
+ FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r
+ PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r
+ PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r
+\r
+ if GlobalData.BuildOptionPcd:\r
+ for PcdItem in GlobalData.BuildOptionPcd:\r
+ if (Pcd.TokenSpaceGuidCName, TokenCName) == (PcdItem[0], PcdItem[1]):\r
+ Pcd.DefaultValue = PcdItem[2]\r
+ break\r
+\r
+ #\r
+ # Write PCDs\r
+ #\r
+ if Pcd.Type in gDynamicExPcd:\r
+ TokenNumber = int(Pcd.TokenValue, 0)\r
+ else:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
+ # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
+ # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
+ # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
+ # report warning message notify the PI that they are attempting to build a module \r
+ # that must be included in a flash image in order to be functional. These Dynamic PCD \r
+ # will not be added into the Database unless it is used by other modules that are \r
+ # included in the FDF file. \r
+ # In this case, just assign an invalid token number to make it pass build.\r
+ if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
+ TokenNumber = 0\r
+ else:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ else:\r
+ TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
+\r
+ if Pcd.Type not in gItemTypeStringDatabase:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+ if Pcd.DatumType not in gDatumSizeStringDatabase:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "Unknown datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
+ ExtraData="[%s]" % str(Info))\r
+\r
+ DatumType = Pcd.DatumType\r
+ DatumSize = gDatumSizeStringDatabaseH[DatumType]\r
+ DatumSizeLib= gDatumSizeStringDatabaseLib[DatumType]\r
+ GetModeName = '_PCD_GET_MODE_' + DatumSize + '_' + TokenCName\r
+ SetModeName = '_PCD_SET_MODE_' + DatumSize + '_' + TokenCName\r
+ SetModeStatusName = '_PCD_SET_MODE_' + DatumSize + '_S_' + TokenCName\r
+ GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r
+\r
+ Type = ''\r
+ Array = ''\r
+ if Pcd.DatumType == 'VOID*':\r
+ if Pcd.DefaultValue[0]== '{':\r
+ Type = '(VOID *)'\r
+ Array = '[]'\r
+ PcdItemType = Pcd.Type\r
+ PcdExCNameList = []\r
+ if PcdItemType in gDynamicExPcd:\r
+ PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + TokenCName\r
+ AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))\r
+ \r
+ if Info.IsLibrary:\r
+ PcdList = Info.LibraryPcdList\r
+ else:\r
+ PcdList = Info.ModulePcdList\r
+ for PcdModule in PcdList:\r
+ if PcdModule.Type in gDynamicExPcd:\r
+ PcdExCNameList.append(PcdModule.TokenCName)\r
+ # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r
+ # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
+ # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
+ if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
+ AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r
+ AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
+ AutoGenH.Append('// #define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s LibPcdGetExSize(&%s, %s \n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r
+ if PcdItemType in gDynamicPcd:\r
+ PcdList = []\r
+ PcdCNameList = []\r
+ PcdList.extend(Info.LibraryPcdList)\r
+ PcdList.extend(Info.ModulePcdList)\r
+ for PcdModule in PcdList:\r
+ if PcdModule.Type in gDynamicPcd:\r
+ PcdCNameList.append(PcdModule.TokenCName)\r
+ if PcdCNameList.count(Pcd.TokenCName) > 1:\r
+ EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r
+ else:\r
+ AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r
+ if DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
+ if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r
+ if DatumType == 'VOID*':\r
+ ArraySize = int(Pcd.MaxDatumSize, 0)\r
+ if Pcd.DefaultValue[0] == 'L':\r
+ ArraySize = ArraySize / 2\r
+ Array = '[%d]' % ArraySize\r
+ DatumType = ['UINT8', 'UINT16'][Pcd.DefaultValue[0] == 'L']\r
+ AutoGenH.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array))\r
+ else:\r
+ AutoGenH.Append('extern volatile %s %s%s;\n' % (DatumType, PcdVariableName, Array))\r
+ AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, TokenCName, TokenCName, TokenCName))\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, TokenCName, TokenCName, TokenCName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
+ AutoGenH.Append('#define %s(Value) ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName, PcdVariableName))\r
+ \r
+ PcdDataSize = GetPcdSize(Pcd)\r
+ AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r
+ AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
+ AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
+ \r
+ if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r
+ key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
+ \r
+ if DatumType == 'VOID*' and Array == '[]':\r
+ DatumType = ['UINT8', 'UINT16'][Pcd.DefaultValue[0] == 'L']\r
+ AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r
+ AutoGenH.Append('#define %s %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r
+ AutoGenH.Append('//#define %s ASSERT(FALSE) // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
+ \r
+ if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and (key in Info.ConstPcd or (Info.IsLibrary and not Info._ReferenceModules)):\r
+ AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
+ \r
+ if PcdItemType == TAB_PCDS_FIXED_AT_BUILD:\r
+ PcdDataSize = GetPcdSize(Pcd)\r
+ AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
+ AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,FixPcdSizeTokenName))\r
+\r
+## Create code for library constructor\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r
+ #\r
+ # Library Constructors\r
+ #\r
+ ConstructorPrototypeString = TemplateString()\r
+ ConstructorCallingString = TemplateString()\r
+ if Info.IsLibrary:\r
+ DependentLibraryList = [Info.Module]\r
+ else:\r
+ DependentLibraryList = Info.DependentLibraryList\r
+ for Lib in DependentLibraryList:\r
+ if len(Lib.ConstructorList) <= 0:\r
+ continue\r
+ Dict = {'Function':Lib.ConstructorList}\r
+ if Lib.ModuleType in ['BASE', 'SEC']:\r
+ ConstructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
+ ConstructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
+ elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
+ ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
+ ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
+ elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
+ 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
+ ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
+ ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
+\r
+ if str(ConstructorPrototypeString) == '':\r
+ ConstructorPrototypeList = []\r
+ else:\r
+ ConstructorPrototypeList = [str(ConstructorPrototypeString)]\r
+ if str(ConstructorCallingString) == '':\r
+ ConstructorCallingList = []\r
+ else:\r
+ ConstructorCallingList = [str(ConstructorCallingString)]\r
+\r
+ Dict = {\r
+ 'Type' : 'Constructor',\r
+ 'FunctionPrototype' : ConstructorPrototypeList,\r
+ 'FunctionCall' : ConstructorCallingList\r
+ }\r
+ if Info.IsLibrary:\r
+ AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
+ else:\r
+ if Info.ModuleType in ['BASE', 'SEC']:\r
+ AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
+ elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
+ AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
+ elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
+ 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
+ AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
+\r
+## Create code for library destructor\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH):\r
+ #\r
+ # Library Destructors\r
+ #\r
+ DestructorPrototypeString = TemplateString()\r
+ DestructorCallingString = TemplateString()\r
+ if Info.IsLibrary:\r
+ DependentLibraryList = [Info.Module]\r
+ else:\r
+ DependentLibraryList = Info.DependentLibraryList\r
+ for Index in range(len(DependentLibraryList)-1, -1, -1):\r
+ Lib = DependentLibraryList[Index]\r
+ if len(Lib.DestructorList) <= 0:\r
+ continue\r
+ Dict = {'Function':Lib.DestructorList}\r
+ if Lib.ModuleType in ['BASE', 'SEC']:\r
+ DestructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
+ DestructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
+ elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
+ DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
+ DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
+ elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
+ 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION', 'SMM_CORE']:\r
+ DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
+ DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
+\r
+ if str(DestructorPrototypeString) == '':\r
+ DestructorPrototypeList = []\r
+ else:\r
+ DestructorPrototypeList = [str(DestructorPrototypeString)]\r
+ if str(DestructorCallingString) == '':\r
+ DestructorCallingList = []\r
+ else:\r
+ DestructorCallingList = [str(DestructorCallingString)]\r
+\r
+ Dict = {\r
+ 'Type' : 'Destructor',\r
+ 'FunctionPrototype' : DestructorPrototypeList,\r
+ 'FunctionCall' : DestructorCallingList\r
+ }\r
+ if Info.IsLibrary:\r
+ AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
+ else:\r
+ if Info.ModuleType in ['BASE', 'SEC']:\r
+ AutoGenC.Append(gLibraryString['BASE'].Replace(Dict))\r
+ elif Info.ModuleType in ['PEI_CORE','PEIM']:\r
+ AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
+ elif Info.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
+ 'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
+ AutoGenC.Append(gLibraryString['DXE'].Replace(Dict))\r
+\r
+\r
+## Create code for ModuleEntryPoint\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH):\r
+ if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
+ return\r
+ #\r
+ # Module Entry Points\r
+ #\r
+ NumEntryPoints = len(Info.Module.ModuleEntryPointList)\r
+ if 'PI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
+ PiSpecVersion = Info.Module.Specification['PI_SPECIFICATION_VERSION']\r
+ else:\r
+ PiSpecVersion = '0x00000000'\r
+ if 'UEFI_SPECIFICATION_VERSION' in Info.Module.Specification:\r
+ UefiSpecVersion = Info.Module.Specification['UEFI_SPECIFICATION_VERSION']\r
+ else:\r
+ UefiSpecVersion = '0x00000000'\r
+ Dict = {\r
+ 'Function' : Info.Module.ModuleEntryPointList,\r
+ 'PiSpecVersion' : PiSpecVersion + 'U',\r
+ 'UefiSpecVersion': UefiSpecVersion + 'U'\r
+ }\r
+\r
+ if Info.ModuleType in ['PEI_CORE', 'DXE_CORE', 'SMM_CORE']:\r
+ if Info.SourceFileList <> None and Info.SourceFileList <> []:\r
+ if NumEntryPoints != 1:\r
+ EdkLogger.error(\r
+ "build",\r
+ AUTOGEN_ERROR,\r
+ '%s must have exactly one entry point' % Info.ModuleType,\r
+ File=str(Info),\r
+ ExtraData= ", ".join(Info.Module.ModuleEntryPointList)\r
+ )\r
+ if Info.ModuleType == 'PEI_CORE':\r
+ AutoGenC.Append(gPeiCoreEntryPointString.Replace(Dict))\r
+ AutoGenH.Append(gPeiCoreEntryPointPrototype.Replace(Dict))\r
+ elif Info.ModuleType == 'DXE_CORE':\r
+ AutoGenC.Append(gDxeCoreEntryPointString.Replace(Dict))\r
+ AutoGenH.Append(gDxeCoreEntryPointPrototype.Replace(Dict))\r
+ elif Info.ModuleType == 'SMM_CORE':\r
+ AutoGenC.Append(gSmmCoreEntryPointString.Replace(Dict))\r
+ AutoGenH.Append(gSmmCoreEntryPointPrototype.Replace(Dict))\r
+ elif Info.ModuleType == 'PEIM':\r
+ if NumEntryPoints < 2:\r
+ AutoGenC.Append(gPeimEntryPointString[NumEntryPoints].Replace(Dict))\r
+ else:\r
+ AutoGenC.Append(gPeimEntryPointString[2].Replace(Dict))\r
+ AutoGenH.Append(gPeimEntryPointPrototype.Replace(Dict))\r
+ elif Info.ModuleType in ['DXE_RUNTIME_DRIVER','DXE_DRIVER','DXE_SAL_DRIVER','UEFI_DRIVER']:\r
+ if NumEntryPoints < 2:\r
+ AutoGenC.Append(gUefiDriverEntryPointString[NumEntryPoints].Replace(Dict))\r
+ else:\r
+ AutoGenC.Append(gUefiDriverEntryPointString[2].Replace(Dict))\r
+ AutoGenH.Append(gUefiDriverEntryPointPrototype.Replace(Dict))\r
+ elif Info.ModuleType == 'DXE_SMM_DRIVER':\r
+ if NumEntryPoints == 0:\r
+ AutoGenC.Append(gDxeSmmEntryPointString[0].Replace(Dict))\r
+ else:\r
+ AutoGenC.Append(gDxeSmmEntryPointString[1].Replace(Dict))\r
+ AutoGenH.Append(gDxeSmmEntryPointPrototype.Replace(Dict)) \r
+ elif Info.ModuleType == 'UEFI_APPLICATION':\r
+ if NumEntryPoints < 2:\r
+ AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r
+ else:\r
+ AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r
+ AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r
+\r
+## Create code for ModuleUnloadImage\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r
+ if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
+ return\r
+ #\r
+ # Unload Image Handlers\r
+ #\r
+ NumUnloadImage = len(Info.Module.ModuleUnloadImageList)\r
+ Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}\r
+ if NumUnloadImage < 2:\r
+ AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r
+ else:\r
+ AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r
+ AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r
+\r
+## Create code for GUID\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.GuidList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append("\n// Guids\n")\r
+ AutoGenH.Append("\n// Guids\n")\r
+ #\r
+ # GUIDs\r
+ #\r
+ for Key in Info.GuidList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r
+ AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
+\r
+## Create code for protocol\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.ProtocolList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append("\n// Protocols\n")\r
+ AutoGenH.Append("\n// Protocols\n")\r
+ #\r
+ # Protocol GUIDs\r
+ #\r
+ for Key in Info.ProtocolList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r
+ AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
+\r
+## Create code for PPI\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.PpiList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append("\n// PPIs\n")\r
+ AutoGenH.Append("\n// PPIs\n")\r
+ #\r
+ # PPI GUIDs\r
+ #\r
+ for Key in Info.PpiList:\r
+ if not Info.IsLibrary:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r
+ AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
+\r
+## Create code for PCD\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreatePcdCode(Info, AutoGenC, AutoGenH):\r
+\r
+ # Collect Token Space GUIDs used by DynamicEc PCDs\r
+ TokenSpaceList = []\r
+ for Pcd in Info.ModulePcdList:\r
+ if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
+ TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r
+ \r
+ # Add extern declarations to AutoGen.h if one or more Token Space GUIDs were found\r
+ if TokenSpaceList <> []: \r
+ AutoGenH.Append("\n// Definition of PCD Token Space GUIDs used in this module\n\n")\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID" \r
+ for Item in TokenSpaceList:\r
+ AutoGenH.Append('extern %s %s;\n' % (GuidType, Item))\r
+\r
+ if Info.IsLibrary:\r
+ if Info.ModulePcdList:\r
+ AutoGenH.Append("\n// PCD definitions\n")\r
+ for Pcd in Info.ModulePcdList:\r
+ CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
+ DynExPcdTokenNumberMapping (Info, AutoGenH)\r
+ else:\r
+ if Info.ModulePcdList:\r
+ AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r
+ AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r
+ for Pcd in Info.ModulePcdList:\r
+ CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
+ DynExPcdTokenNumberMapping (Info, AutoGenH)\r
+ if Info.LibraryPcdList:\r
+ AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r
+ AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r
+ for Pcd in Info.LibraryPcdList:\r
+ CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r
+ CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r
+\r
+## Create code for unicode string definition\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
+# @param UniGenBinBuffer Buffer to store uni string package data\r
+#\r
+def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r
+ WorkingDir = os.getcwd()\r
+ os.chdir(Info.WorkspaceDir)\r
+\r
+ IncList = [Info.MetaFile.Dir]\r
+ # Get all files under [Sources] section in inf file for EDK-II module\r
+ EDK2Module = True\r
+ SrcList = [F for F in Info.SourceFileList]\r
+ if Info.AutoGenVersion < 0x00010005:\r
+ EDK2Module = False\r
+ # Get all files under the module directory for EDK-I module\r
+ Cwd = os.getcwd()\r
+ os.chdir(Info.MetaFile.Dir)\r
+ for Root, Dirs, Files in os.walk("."):\r
+ if 'CVS' in Dirs:\r
+ Dirs.remove('CVS')\r
+ if '.svn' in Dirs:\r
+ Dirs.remove('.svn')\r
+ for File in Files:\r
+ File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)\r
+ if File in SrcList:\r
+ continue\r
+ SrcList.append(File)\r
+ os.chdir(Cwd)\r
+\r
+ if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r
+ CompatibleMode = True\r
+ else:\r
+ CompatibleMode = False\r
+\r
+ #\r
+ # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r
+ #\r
+ if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r
+ if CompatibleMode:\r
+ EdkLogger.error("build", AUTOGEN_ERROR,\r
+ "-c and -s build options should be used exclusively",\r
+ ExtraData="[%s]" % str(Info))\r
+ ShellMode = True\r
+ else:\r
+ ShellMode = False\r
+\r
+ #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r
+ if EDK2Module:\r
+ FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r
+ else:\r
+ FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r
+ Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r
+ if CompatibleMode or UniGenCFlag:\r
+ AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r
+ AutoGenC.Append(Code)\r
+ AutoGenC.Append("\n")\r
+ AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r
+ AutoGenH.Append(Header)\r
+ if CompatibleMode or UniGenCFlag:\r
+ AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r
+ os.chdir(WorkingDir)\r
+\r
+def CreateIdfFileCode(Info, AutoGenC, StringH, IdfGenCFlag, IdfGenBinBuffer):\r
+ if len(Info.IdfFileList) > 0:\r
+ ImageFiles = IdfFileClassObject(sorted (Info.IdfFileList))\r
+ if ImageFiles.ImageFilesDict:\r
+ Index = 1\r
+ PaletteIndex = 1\r
+ IncList = [Info.MetaFile.Dir]\r
+ SrcList = [F for F in Info.SourceFileList]\r
+ SkipList = ['.jpg', '.png', '.bmp', '.inf', '.idf']\r
+ FileList = GetFileList(SrcList, IncList, SkipList)\r
+ ValueStartPtr = 60\r
+ StringH.Append("\n//\n//Image ID\n//\n")\r
+ ImageInfoOffset = 0\r
+ PaletteInfoOffset = 0\r
+ ImageBuffer = pack('x')\r
+ PaletteBuffer = pack('x')\r
+ BufferStr = ''\r
+ PaletteStr = ''\r
+ FileDict = {}\r
+ for Idf in ImageFiles.ImageFilesDict:\r
+ if ImageFiles.ImageFilesDict[Idf]:\r
+ for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
+ for sourcefile in Info.SourceFileList:\r
+ if FileObj.FileName == sourcefile.File:\r
+ if not sourcefile.Ext.upper() in ['.PNG', '.BMP', '.JPG']:\r
+ EdkLogger.error("build", AUTOGEN_ERROR, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj.FileName), ExtraData="[%s]" % str(Info))\r
+ FileObj.File = sourcefile\r
+ break\r
+ else:\r
+ EdkLogger.error("build", AUTOGEN_ERROR, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj.FileName, Idf), ExtraData="[%s]" % str(Info))\r
+\r
+ for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
+ ID = FileObj.ImageID\r
+ File = FileObj.File\r
+ if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r
+ EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=File.Path)\r
+ SearchImageID (FileObj, FileList)\r
+ if FileObj.Referenced:\r
+ if (ValueStartPtr - len(DEFINE_STR + ID)) <= 0:\r
+ Line = DEFINE_STR + ' ' + ID + ' ' + DecToHexStr(Index, 4) + '\n'\r
+ else:\r
+ Line = DEFINE_STR + ' ' + ID + ' ' * (ValueStartPtr - len(DEFINE_STR + ID)) + DecToHexStr(Index, 4) + '\n'\r
+\r
+ if File not in FileDict:\r
+ FileDict[File] = Index\r
+ else:\r
+ DuplicateBlock = pack('B', EFI_HII_IIBT_DUPLICATE)\r
+ DuplicateBlock += pack('H', FileDict[File])\r
+ ImageBuffer += DuplicateBlock\r
+ BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r
+ TempBufferList = AscToHexList(DuplicateBlock)\r
+ BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r
+ StringH.Append(Line)\r
+ Index += 1\r
+ continue\r
+\r
+ TmpFile = open(File.Path, 'rb')\r
+ Buffer = TmpFile.read()\r
+ TmpFile.close()\r
+ if File.Ext.upper() == '.PNG':\r
+ TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_PNG)\r
+ TempBuffer += pack('I', len(Buffer))\r
+ TempBuffer += Buffer\r
+ elif File.Ext.upper() == '.JPG':\r
+ ImageType, = struct.unpack('4s', Buffer[6:10])\r
+ if ImageType != 'JFIF':\r
+ EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard JPG file." % File.Path)\r
+ TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_JPEG)\r
+ TempBuffer += pack('I', len(Buffer))\r
+ TempBuffer += Buffer\r
+ elif File.Ext.upper() == '.BMP':\r
+ TempBuffer, TempPalette = BmpImageDecoder(File, Buffer, PaletteIndex, FileObj.TransParent)\r
+ if len(TempPalette) > 1:\r
+ PaletteIndex += 1\r
+ NewPalette = pack('H', len(TempPalette))\r
+ NewPalette += TempPalette\r
+ PaletteBuffer += NewPalette\r
+ PaletteStr = WriteLine(PaletteStr, '// %s: %s: %s' % (DecToHexStr(PaletteIndex - 1, 4), ID, DecToHexStr(PaletteIndex - 1, 4)))\r
+ TempPaletteList = AscToHexList(NewPalette)\r
+ PaletteStr = WriteLine(PaletteStr, CreateArrayItem(TempPaletteList, 16) + '\n')\r
+ ImageBuffer += TempBuffer\r
+ BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r
+ TempBufferList = AscToHexList(TempBuffer)\r
+ BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r
+\r
+ StringH.Append(Line)\r
+ Index += 1\r
+\r
+ BufferStr = WriteLine(BufferStr, '// End of the Image Info')\r
+ BufferStr = WriteLine(BufferStr, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END, 2)) + '\n')\r
+ ImageEnd = pack('B', EFI_HII_IIBT_END)\r
+ ImageBuffer += ImageEnd\r
+\r
+ if len(ImageBuffer) > 1:\r
+ ImageInfoOffset = 12\r
+ if len(PaletteBuffer) > 1:\r
+ PaletteInfoOffset = 12 + len(ImageBuffer) - 1 # -1 is for the first empty pad byte of ImageBuffer\r
+\r
+ IMAGE_PACKAGE_HDR = pack('=II', ImageInfoOffset, PaletteInfoOffset)\r
+ # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length\r
+ if len(PaletteBuffer) > 1:\r
+ PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1 + 2 + len(PaletteBuffer) - 1\r
+ else:\r
+ PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1\r
+ if PaletteIndex > 1:\r
+ PALETTE_INFO_HEADER = pack('H', PaletteIndex - 1)\r
+ # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF\r
+ Hex_Length = '%06X' % PACKAGE_HEADER_Length\r
+ if PACKAGE_HEADER_Length > 0xFFFFFF:\r
+ EdkLogger.error("build", AUTOGEN_ERROR, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData="[%s]" % str(Info))\r
+ PACKAGE_HEADER = pack('=HBB', int('0x' + Hex_Length[2:], 16), int('0x' + Hex_Length[0:2], 16), EFI_HII_PACKAGE_IMAGES)\r
+\r
+ IdfGenBinBuffer.write(PACKAGE_HEADER)\r
+ IdfGenBinBuffer.write(IMAGE_PACKAGE_HDR)\r
+ if len(ImageBuffer) > 1 :\r
+ IdfGenBinBuffer.write(ImageBuffer[1:])\r
+ if PaletteIndex > 1:\r
+ IdfGenBinBuffer.write(PALETTE_INFO_HEADER)\r
+ if len(PaletteBuffer) > 1:\r
+ IdfGenBinBuffer.write(PaletteBuffer[1:])\r
+\r
+ if IdfGenCFlag:\r
+ TotalLength = EFI_HII_ARRAY_SIZE_LENGTH + PACKAGE_HEADER_Length\r
+ AutoGenC.Append("\n//\n//Image Pack Definition\n//\n")\r
+ AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + Info.Module.BaseName + 'Images' + '[] = {\n')\r
+ AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r
+ AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r
+ AllStr = WriteLine(AllStr, '// Image PACKAGE HEADER\n')\r
+ IMAGE_PACKAGE_HDR_List = AscToHexList(PACKAGE_HEADER)\r
+ IMAGE_PACKAGE_HDR_List += AscToHexList(IMAGE_PACKAGE_HDR)\r
+ AllStr = WriteLine(AllStr, CreateArrayItem(IMAGE_PACKAGE_HDR_List, 16) + '\n')\r
+ AllStr = WriteLine(AllStr, '// Image DATA\n')\r
+ if BufferStr:\r
+ AllStr = WriteLine(AllStr, BufferStr)\r
+ if PaletteStr:\r
+ AllStr = WriteLine(AllStr, '// Palette Header\n')\r
+ PALETTE_INFO_HEADER_List = AscToHexList(PALETTE_INFO_HEADER)\r
+ AllStr = WriteLine(AllStr, CreateArrayItem(PALETTE_INFO_HEADER_List, 16) + '\n')\r
+ AllStr = WriteLine(AllStr, '// Palette Data\n')\r
+ AllStr = WriteLine(AllStr, PaletteStr)\r
+ AllStr = WriteLine(AllStr, '};')\r
+ AutoGenC.Append(AllStr)\r
+ AutoGenC.Append("\n")\r
+ StringH.Append('\nextern unsigned char ' + Info.Module.BaseName + 'Images[];\n')\r
+ StringH.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info.Module.BaseName)\r
+\r
+# typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
+# EFI_HII_PACKAGE_HEADER Header; # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES\r
+# UINT32 ImageInfoOffset;\r
+# UINT32 PaletteInfoOffset;\r
+# } EFI_HII_IMAGE_PACKAGE_HDR;\r
+\r
+# typedef struct {\r
+# UINT32 Length:24;\r
+# UINT32 Type:8;\r
+# UINT8 Data[];\r
+# } EFI_HII_PACKAGE_HEADER;\r
+\r
+# typedef struct _EFI_HII_IMAGE_BLOCK {\r
+# UINT8 BlockType;\r
+# UINT8 BlockBody[];\r
+# } EFI_HII_IMAGE_BLOCK;\r
+\r
+def BmpImageDecoder(File, Buffer, PaletteIndex, TransParent):\r
+ ImageType, = struct.unpack('2s', Buffer[0:2])\r
+ if ImageType!= 'BM': # BMP file type is 'BM'\r
+ EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard BMP file." % File.Path)\r
+ BMP_IMAGE_HEADER = collections.namedtuple('BMP_IMAGE_HEADER', ['bfSize','bfReserved1','bfReserved2','bfOffBits','biSize','biWidth','biHeight','biPlanes','biBitCount', 'biCompression', 'biSizeImage','biXPelsPerMeter','biYPelsPerMeter','biClrUsed','biClrImportant'])\r
+ BMP_IMAGE_HEADER_STRUCT = struct.Struct('IHHIIIIHHIIIIII')\r
+ BmpHeader = BMP_IMAGE_HEADER._make(BMP_IMAGE_HEADER_STRUCT.unpack_from(Buffer[2:]))\r
+ #\r
+ # Doesn't support compress.\r
+ #\r
+ if BmpHeader.biCompression != 0:\r
+ EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The compress BMP file %s is not support." % File.Path)\r
+\r
+ # The Width and Height is UINT16 type in Image Package\r
+ if BmpHeader.biWidth > 0xFFFF:\r
+ EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Width is exceed 0xFFFF." % File.Path)\r
+ if BmpHeader.biHeight > 0xFFFF:\r
+ EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Height is exceed 0xFFFF." % File.Path)\r
+\r
+ PaletteBuffer = pack('x')\r
+ if BmpHeader.biBitCount == 1:\r
+ if TransParent:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS)\r
+ else:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r
+ ImageBuffer += pack('B', PaletteIndex)\r
+ Width = (BmpHeader.biWidth + 7)/8\r
+ if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+ PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+ elif BmpHeader.biBitCount == 4:\r
+ if TransParent:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS)\r
+ else:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r
+ ImageBuffer += pack('B', PaletteIndex)\r
+ Width = (BmpHeader.biWidth + 1)/2\r
+ if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+ PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+ elif BmpHeader.biBitCount == 8:\r
+ if TransParent:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS)\r
+ else:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT)\r
+ ImageBuffer += pack('B', PaletteIndex)\r
+ Width = BmpHeader.biWidth\r
+ if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
+ PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
+ elif BmpHeader.biBitCount == 24:\r
+ if TransParent:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS)\r
+ else:\r
+ ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT)\r
+ Width = BmpHeader.biWidth * 3\r
+ else:\r
+ EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData="[%s]" % str(File.Path))\r
+\r
+ ImageBuffer += pack('H', BmpHeader.biWidth)\r
+ ImageBuffer += pack('H', BmpHeader.biHeight)\r
+ Start = BmpHeader.bfOffBits\r
+ End = BmpHeader.bfSize - 1\r
+ for Height in range(0, BmpHeader.biHeight):\r
+ if Width % 4 != 0:\r
+ Start = End + (Width % 4) - 4 - Width\r
+ else:\r
+ Start = End - Width\r
+ ImageBuffer += Buffer[Start + 1 : Start + Width + 1]\r
+ End = Start\r
+\r
+ # handle the Palette info, BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info\r
+ if PaletteBuffer and len(PaletteBuffer) > 1:\r
+ PaletteTemp = pack('x')\r
+ for Index in range(0, len(PaletteBuffer)):\r
+ if Index % 4 == 3:\r
+ continue\r
+ PaletteTemp += PaletteBuffer[Index]\r
+ PaletteBuffer = PaletteTemp[1:]\r
+ return ImageBuffer, PaletteBuffer\r
+\r
+## Create common code\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r
+ # file header\r
+ AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r
+ # header file Prologue\r
+ AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))\r
+ AutoGenH.Append(gAutoGenHCppPrologueString)\r
+ if Info.AutoGenVersion >= 0x00010005:\r
+ # header files includes\r
+ AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)\r
+ if Info.ModuleType in gModuleTypeHeaderFile \\r
+ and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:\r
+ AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r
+ #\r
+ # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h \r
+ # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r
+ #\r
+ if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r
+ AutoGenH.Append("#include <Library/PcdLib.h>\n")\r
+\r
+ AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r
+ AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r
+\r
+ if Info.IsLibrary:\r
+ return\r
+\r
+ AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\r
+\r
+ if Info.IsLibrary:\r
+ return\r
+ # C file header\r
+ AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r
+ if Info.AutoGenVersion >= 0x00010005:\r
+ # C file header files includes\r
+ if Info.ModuleType in gModuleTypeHeaderFile:\r
+ for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r
+ AutoGenC.Append("#include <%s>\n" % Inc)\r
+ else:\r
+ AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r
+\r
+ #\r
+ # Publish the CallerId Guid\r
+ #\r
+ AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r
+ AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r
+\r
+## Create common code for header file\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+#\r
+def CreateFooterCode(Info, AutoGenC, AutoGenH):\r
+ AutoGenH.Append(gAutoGenHEpilogueString)\r
+\r
+## Create code for a module\r
+#\r
+# @param Info The ModuleAutoGen object\r
+# @param AutoGenC The TemplateString object for C code\r
+# @param AutoGenH The TemplateString object for header file\r
+# @param StringH The TemplateString object for header file\r
+# @param UniGenCFlag UniString is generated into AutoGen C file when it is set to True\r
+# @param UniGenBinBuffer Buffer to store uni string package data\r
+# @param StringIdf The TemplateString object for header file\r
+# @param IdfGenCFlag IdfString is generated into AutoGen C file when it is set to True\r
+# @param IdfGenBinBuffer Buffer to store Idf string package data\r
+#\r
+def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer, StringIdf, IdfGenCFlag, IdfGenBinBuffer):\r
+ CreateHeaderCode(Info, AutoGenC, AutoGenH)\r
+\r
+ if Info.AutoGenVersion >= 0x00010005:\r
+ CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r
+ CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r
+ CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r
+ CreatePcdCode(Info, AutoGenC, AutoGenH)\r
+ CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r
+ CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r
+ CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r
+ CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r
+\r
+ if Info.UnicodeFileList:\r
+ FileName = "%sStrDefs.h" % Info.Name\r
+ StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
+ StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
+ CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r
+\r
+ GuidMacros = []\r
+ for Guid in Info.Module.Guids:\r
+ if Guid in Info.Module.GetGuidsUsedByPcd():\r
+ continue\r
+ GuidMacros.append('#define %s %s' % (Guid, Info.Module.Guids[Guid]))\r
+ for Guid, Value in Info.Module.Protocols.items() + Info.Module.Ppis.items():\r
+ GuidMacros.append('#define %s %s' % (Guid, Value))\r
+ # supports FixedAtBuild usage in VFR file\r
+ if Info.VfrFileList and Info.ModulePcdList:\r
+ GuidMacros.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))\r
+ GuidMacros.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))\r
+ GuidMacros.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))\r
+ GuidMacros.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))\r
+ GuidMacros.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))\r
+ for Pcd in Info.ModulePcdList:\r
+ if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r
+ TokenCName = Pcd.TokenCName\r
+ Value = Pcd.DefaultValue\r
+ if Pcd.DatumType == 'BOOLEAN':\r
+ BoolValue = Value.upper()\r
+ if BoolValue == 'TRUE':\r
+ Value = '1'\r
+ elif BoolValue == 'FALSE':\r
+ Value = '0'\r
+ for PcdItem in GlobalData.MixedPcd:\r
+ if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
+ TokenCName = PcdItem[0]\r
+ break\r
+ GuidMacros.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName, Value))\r
+\r
+ if GuidMacros:\r
+ StringH.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros))\r
+\r
+ StringH.Append("\n#endif\n")\r
+ AutoGenH.Append('#include "%s"\n' % FileName)\r
+\r
+ if Info.IdfFileList:\r
+ FileName = "%sImgDefs.h" % Info.Name\r
+ StringIdf.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
+ StringIdf.Append(gAutoGenHPrologueString.Replace({'File':'IMAGEDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
+ CreateIdfFileCode(Info, AutoGenC, StringIdf, IdfGenCFlag, IdfGenBinBuffer)\r
+\r
+ StringIdf.Append("\n#endif\n")\r
+ AutoGenH.Append('#include "%s"\n' % FileName)\r
+\r
+ CreateFooterCode(Info, AutoGenC, AutoGenH)\r
+\r
+ # no generation of AutoGen.c for Edk modules without unicode file\r
+ if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:\r
+ AutoGenC.String = ''\r
+\r
+## Create the code file\r
+#\r
+# @param FilePath The path of code file\r
+# @param Content The content of code file\r
+# @param IsBinaryFile The flag indicating if the file is binary file or not\r
+#\r
+# @retval True If file content is changed or file doesn't exist\r
+# @retval False If the file exists and the content is not changed\r
+#\r
+def Generate(FilePath, Content, IsBinaryFile):\r
+ return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r
+\r
projects / mirror_edk2.git / blobdiff