-## @file
-# Routines for generating AutoGen.h and AutoGen.c
-#
-# Copyright (c) 2007 - 2013, 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 *
-from GenPcdDb import CreatePcdDatabaseCode
-
-## 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'}
-
-## 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]
-}
-
-## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName
-# the TokenName and Guid comparison to avoid define name collisions.
-#
-# @param Info The ModuleAutoGen object
-# @param AutoGenH The TemplateString object for header file
-#
-#
-def DynExPcdTokenNumberMapping(Info, AutoGenH):
- ExTokenCNameList = []
- PcdExList = []
- if Info.IsLibrary:
- PcdList = Info.LibraryPcdList
- else:
- PcdList = Info.ModulePcdList
- for Pcd in PcdList:
- if Pcd.Type in gDynamicExPcd:
- ExTokenCNameList.append(Pcd.TokenCName)
- PcdExList.append(Pcd)
- if len(ExTokenCNameList) == 0:
- return
- AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')
- # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.
- # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.
- # Use the Guid pointer to see if it matches any of the token space GUIDs.
- TokenCNameList = []
- for TokenCName in ExTokenCNameList:
- if TokenCName in TokenCNameList:
- continue
- Index = 0
- Count = ExTokenCNameList.count(TokenCName)
- for Pcd in PcdExList:
- if Pcd.TokenCName == TokenCName:
- Index = Index + 1
- if Index == 1:
- AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (Pcd.TokenCName))
- AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
- % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
- else:
- AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:'
- % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
- if Index == Count:
- AutoGenH.Append('0 \\\n )\n')
- TokenCNameList.append(TokenCName)
-
- TokenCNameList = []
- for TokenCName in ExTokenCNameList:
- if TokenCName in TokenCNameList:
- continue
- Index = 0
- Count = ExTokenCNameList.count(TokenCName)
- for Pcd in PcdExList:
- if Pcd.Type in gDynamicExPcd and Pcd.TokenCName == TokenCName:
- Index = Index + 1
- if Index == 1:
- AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr) (' % (Pcd.TokenCName))
- AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
- % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
- else:
- AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:'
- % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))
- if Index == Count:
- AutoGenH.Append('0 \\\n )\n')
- # Autogen internal worker macro to compare GUIDs. Guid1 is a pointer to a GUID.
- # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler
- # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().
- # COMPAREGUID() will only be used if the Guid passed in is local to the module.
- AutoGenH.Append('#define _PCD_TOKEN_EX_%s(GuidPtr) __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr) \n'
- % (Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))
- TokenCNameList.append(TokenCName)
-
-## 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)
- # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with
- # different Guids but same TokenCName
- PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + Pcd.TokenCName
- AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))
- else:
- if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:
- # If one of the Source built modules listed in the DSC is not listed in FDF modules,
- # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
- # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
- # report warning message notify the PI that they are attempting to build a module
- # that must be included in a flash image in order to be functional. These Dynamic PCD
- # will not be added into the Database unless it is used by other modules that are
- # included in the FDF file.
- # In this case, just assign an invalid token number to make it pass build.
- if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:
- TokenNumber = 0
- else:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- else:
- 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
-
- PcdExCNameList = []
- if Pcd.Type in gDynamicExPcd:
- if Info.IsLibrary:
- PcdList = Info.LibraryPcdList
- else:
- PcdList = Info.ModulePcdList
- for PcdModule in PcdList:
- if PcdModule.Type in gDynamicExPcd:
- PcdExCNameList.append(PcdModule.TokenCName)
- # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.
- # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.
- # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
- if PcdExCNameList.count(Pcd.TokenCName) > 1:
- 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')
- AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))
- 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))
- else:
- AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))
- 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
- PcdTokenName = '_PCD_TOKEN_' + TokenCName
- #
- # Write PCDs
- #
- if Pcd.Type in gDynamicExPcd:
- TokenNumber = int(Pcd.TokenValue, 0)
- else:
- if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:
- # If one of the Source built modules listed in the DSC is not listed in FDF modules,
- # and the INF lists a PCD can only use the PcdsDynamic access method (it is only
- # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will
- # report warning message notify the PI that they are attempting to build a module
- # that must be included in a flash image in order to be functional. These Dynamic PCD
- # will not be added into the Database unless it is used by other modules that are
- # included in the FDF file.
- # In this case, just assign an invalid token number to make it pass build.
- if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:
- TokenNumber = 0
- else:
- EdkLogger.error("build", AUTOGEN_ERROR,
- "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, Pcd.TokenCName),
- ExtraData="[%s]" % str(Info))
- else:
- TokenNumber = PcdTokenNumber[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))
-
- 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 = '[]'
- PcdItemType = Pcd.Type
- PcdExCNameList = []
- if PcdItemType in gDynamicExPcd:
- PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + Pcd.TokenCName
- AutoGenH.Append('\n#define %s %dU\n' % (PcdExTokenName, TokenNumber))
-
- if Info.IsLibrary:
- PcdList = Info.LibraryPcdList
- else:
- PcdList = Info.ModulePcdList
- for PcdModule in PcdList:
- if PcdModule.Type in gDynamicExPcd:
- PcdExCNameList.append(PcdModule.TokenCName)
- # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.
- # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.
- # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.
- if PcdExCNameList.count(Pcd.TokenCName) > 1:
- 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')
- AutoGenH.Append('// #define %s %s\n' % (PcdTokenName, PcdExTokenName))
- 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))
- else:
- AutoGenH.Append('#define %s %s\n' % (PcdTokenName, PcdExTokenName))
- 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))
- else:
- AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))
- if PcdItemType in gDynamicPcd:
- 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 volatile %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:
- key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))
-
- AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))
- 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)
-
- if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and key in Info.ConstPcd:
- AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))
-
-
-
-## 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)
- DynExPcdTokenNumberMapping (Info, AutoGenH)
- 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)
- DynExPcdTokenNumberMapping (Info, AutoGenH)
- 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;')
- AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\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))
- AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)
-
-## 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 - 2013, 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
+\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
+\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
+ if Pcd.TokenCName == TokenCName:\r
+ Index = Index + 1\r
+ if Index == 1:\r
+ AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr) (' % (Pcd.TokenCName))\r
+ AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
+ else:\r
+ AutoGenH.Append('\\\n (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\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
+ 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) (' % (Pcd.TokenCName))\r
+ AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\r
+ else:\r
+ AutoGenH.Append('\\\n COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
+ % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, Pcd.TokenCName))\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
+ % (Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
+ TokenCNameList.append(TokenCName)\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
+ PcdTokenName = '_PCD_TOKEN_' + Pcd.TokenCName\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 + '_' + Pcd.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, Pcd.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 " + Pcd.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, Pcd.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, Pcd.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] + '_' + Pcd.TokenCName\r
+ SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + Pcd.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
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, 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
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ elif Pcd.Type in gDynamicPcd:\r
+ AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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, Pcd.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_' + Pcd.TokenCName\r
+ else:\r
+ PcdValueName = '_PCD_VALUE_' + Pcd.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 _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\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 _PCD_PATCHABLE_%s_SIZE %s\n' % (Pcd.TokenCName, Pcd.MaxDatumSize))\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
+ 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
+ else:\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) LibPatchPcdSetPtr(_gPcd_BinaryPatch_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, 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
+ PcdTokenName = '_PCD_TOKEN_' + TokenCName\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, Pcd.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, Pcd.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, Pcd.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
+\r
+ Type = ''\r
+ Array = ''\r
+ if Pcd.DatumType == 'VOID*':\r
+ Type = '(VOID *)'\r
+ Array = '[]'\r
+ PcdItemType = Pcd.Type\r
+ PcdExCNameList = []\r
+ if PcdItemType in gDynamicExPcd:\r
+ PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + Pcd.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
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('// #define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, 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
+ if Pcd.DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define _PCD_TOKEN_%s %dU\n' % (TokenCName, TokenNumber))\r
+ if PcdItemType in gDynamicPcd:\r
+ AutoGenH.Append('#define %s LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
+ if DatumType == 'VOID*':\r
+ AutoGenH.Append('#define %s(SizeOfBuffer, Buffer) LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
+ else:\r
+ AutoGenH.Append('#define %s(Value) LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
+ if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r
+ PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r
+ AutoGenH.Append('extern volatile %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array) )\r
+ AutoGenH.Append('#define %s %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
+ AutoGenH.Append('#define %s(Value) (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
+ if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r
+ key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
+ \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:\r
+ AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
+ \r
+\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.IsLibrary:\r
+ return\r
+\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.GuidList:\r
+ AutoGenC.Append("\n// Guids\n")\r
+ #\r
+ # GUIDs\r
+ #\r
+ for Key in Info.GuidList:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[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.IsLibrary:\r
+ return\r
+\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.ProtocolList:\r
+ AutoGenC.Append("\n// Protocols\n")\r
+ #\r
+ # Protocol GUIDs\r
+ #\r
+ for Key in Info.ProtocolList:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[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.IsLibrary:\r
+ return\r
+\r
+ if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
+ GuidType = "GUID"\r
+ else:\r
+ GuidType = "EFI_GUID"\r
+\r
+ if Info.PpiList:\r
+ AutoGenC.Append("\n// PPIs\n")\r
+ #\r
+ # PPI GUIDs\r
+ #\r
+ for Key in Info.PpiList:\r
+ AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[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
+## 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 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 CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer):\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
+ StringH.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