BaseTools: Parse PCD GUID name in FILE statement issue

[mirror_edk2.git] / BaseTools / Source / Python / AutoGen / GenC.py

## @file\r
# Routines for generating AutoGen.h and AutoGen.c\r
#\r
# Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.  The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
\r
## Import Modules\r
#\r
import string\r
import collections\r
import struct\r
from Common import EdkLogger\r
\r
from Common.BuildToolError import *\r
from Common.DataType import *\r
from Common.Misc import *\r
from Common.String import StringToArray\r
from StrGather import *\r
from GenPcdDb import CreatePcdDatabaseCode\r
from IdfClassObject import *\r
\r
## PCD type string\r
gItemTypeStringDatabase  = {\r
    TAB_PCDS_FEATURE_FLAG       :   'FixedAtBuild',\r
    TAB_PCDS_FIXED_AT_BUILD     :   'FixedAtBuild',\r
    TAB_PCDS_PATCHABLE_IN_MODULE:   'BinaryPatch',\r
    TAB_PCDS_DYNAMIC            :   '',\r
    TAB_PCDS_DYNAMIC_DEFAULT    :   '',\r
    TAB_PCDS_DYNAMIC_VPD        :   '',\r
    TAB_PCDS_DYNAMIC_HII        :   '',\r
    TAB_PCDS_DYNAMIC_EX         :   '',\r
    TAB_PCDS_DYNAMIC_EX_DEFAULT :   '',\r
    TAB_PCDS_DYNAMIC_EX_VPD     :   '',\r
    TAB_PCDS_DYNAMIC_EX_HII     :   '',\r
}\r
\r
_NumericDataTypesList = ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN']\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
## MM_CORE_STANDALONE Entry Point Templates\r
gMmCoreStandaloneEntryPointPrototype = TemplateString("""\r
${BEGIN}\r
EFI_STATUS\r
EFIAPI\r
${Function} (\r
  IN VOID *HobStart\r
  );\r
${END}\r
""")\r
\r
gMmCoreStandaloneEntryPointString = TemplateString("""\r
${BEGIN}\r
const UINT32 _gMmRevision = ${PiSpecVersion};\r
\r
VOID\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN VOID *HobStart\r
  )\r
{\r
  ${Function} (HobStart);\r
}\r
${END}\r
""")\r
\r
## MM_STANDALONE Entry Point Templates\r
gMmStandaloneEntryPointPrototype = TemplateString("""\r
${BEGIN}\r
EFI_STATUS\r
EFIAPI\r
${Function} (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r
  );\r
${END}\r
""")\r
\r
gMmStandaloneEntryPointString = [\r
TemplateString("""\r
GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r
\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r
  )\r
\r
{\r
  return EFI_SUCCESS;\r
}\r
"""),\r
TemplateString("""\r
GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r
${BEGIN}\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r
  )\r
\r
{\r
  return ${Function} (ImageHandle, MmSystemTable);\r
}\r
${END}\r
"""),\r
TemplateString("""\r
GLOBAL_REMOVE_IF_UNREFERENCED const UINT32 _gMmRevision = ${PiSpecVersion};\r
\r
EFI_STATUS\r
EFIAPI\r
ProcessModuleEntryPointList (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2 *MmSystemTable\r
  )\r
\r
{\r
  EFI_STATUS  Status;\r
  EFI_STATUS  CombinedStatus;\r
\r
  CombinedStatus = EFI_LOAD_ERROR;\r
${BEGIN}\r
  Status = ${Function} (ImageHandle, MmSystemTable);\r
  if (!EFI_ERROR (Status) || EFI_ERROR (CombinedStatus)) {\r
    CombinedStatus = Status;\r
  }\r
${END}\r
  return CombinedStatus;\r
}\r
""")\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
'MM'   : TemplateString("""${BEGIN}\r
EFI_STATUS\r
EFIAPI\r
${Function} (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2  *MmSystemTable\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
'MM'   : TemplateString("""${BEGIN}\r
  Status = ${Function} (ImageHandle, MmSystemTable);\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
'MM'   :   TemplateString("""\r
${BEGIN}${FunctionPrototype}${END}\r
\r
VOID\r
EFIAPI\r
ProcessLibrary${Type}List (\r
  IN EFI_HANDLE            ImageHandle,\r
  IN EFI_SMM_SYSTEM_TABLE2  *MmSystemTable\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
    "MM_STANDALONE"     :   ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmDriverStandaloneEntryPoint.h"],\r
    "MM_CORE_STANDALONE" :  ["PiSmm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/SmmCoreStandaloneEntryPoint.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
    # Even it is the Library, the PCD is saved in the ModulePcdList\r
    PcdList = Info.ModulePcdList\r
    for Pcd in PcdList:\r
        if Pcd.Type in gDynamicExPcd:\r
            ExTokenCNameList.append(Pcd.TokenCName)\r
            PcdExList.append(Pcd)\r
    if len(ExTokenCNameList) == 0:\r
        return\r
    AutoGenH.Append('\n#define COMPAREGUID(Guid1, Guid2) (BOOLEAN)(*(CONST UINT64*)Guid1 == *(CONST UINT64*)Guid2 && *((CONST UINT64*)Guid1 + 1) == *((CONST UINT64*)Guid2 + 1))\n')\r
    # AutoGen for each PCD listed in a [PcdEx] section of a Module/Lib INF file.\r
    # Auto generate a macro for each TokenName that takes a Guid pointer as a parameter.  \r
    # Use the Guid pointer to see if it matches any of the token space GUIDs.\r
    TokenCNameList = []\r
    for TokenCName in ExTokenCNameList:\r
        if TokenCName in TokenCNameList:\r
            continue\r
        Index = 0\r
        Count = ExTokenCNameList.count(TokenCName)\r
        for Pcd in PcdExList:\r
            RealTokenCName = Pcd.TokenCName\r
            for PcdItem in GlobalData.MixedPcd:\r
                if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
                    RealTokenCName = PcdItem[0]\r
                    break\r
            if Pcd.TokenCName == TokenCName:\r
                Index = Index + 1\r
                if Index == 1:\r
                    AutoGenH.Append('\n#define __PCD_%s_ADDR_CMP(GuidPtr)  (' % (RealTokenCName))\r
                    AutoGenH.Append('\\\n  (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
                                    % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
                else:\r
                    AutoGenH.Append('\\\n  (GuidPtr == &%s) ? _PCD_TOKEN_%s_%s:' \r
                                    % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
                if Index == Count:\r
                    AutoGenH.Append('0 \\\n  )\n')\r
                TokenCNameList.append(TokenCName)\r
    \r
    TokenCNameList = []\r
    for TokenCName in ExTokenCNameList:\r
        if TokenCName in TokenCNameList:\r
            continue\r
        Index = 0\r
        Count = ExTokenCNameList.count(TokenCName)\r
        for Pcd in PcdExList:\r
            RealTokenCName = Pcd.TokenCName\r
            for PcdItem in GlobalData.MixedPcd:\r
                if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
                    RealTokenCName = PcdItem[0]\r
                    break\r
            if Pcd.Type in gDynamicExPcd and Pcd.TokenCName == TokenCName:\r
                Index = Index + 1\r
                if Index == 1:\r
                    AutoGenH.Append('\n#define __PCD_%s_VAL_CMP(GuidPtr)  (' % (RealTokenCName))\r
                    AutoGenH.Append('\\\n  (GuidPtr == NULL) ? 0:')\r
                    AutoGenH.Append('\\\n  COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
                                    % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
                else:\r
                    AutoGenH.Append('\\\n  COMPAREGUID (GuidPtr, &%s) ? _PCD_TOKEN_%s_%s:' \r
                                    % (Pcd.TokenSpaceGuidCName, Pcd.TokenSpaceGuidCName, RealTokenCName))\r
                if Index == Count:\r
                    AutoGenH.Append('0 \\\n  )\n')\r
                    # Autogen internal worker macro to compare GUIDs.  Guid1 is a pointer to a GUID.  \r
                    # Guid2 is a C name for a GUID. Compare pointers first because optimizing compiler\r
                    # can do this at build time on CONST GUID pointers and optimize away call to COMPAREGUID().\r
                    #  COMPAREGUID() will only be used if the Guid passed in is local to the module.\r
                    AutoGenH.Append('#define _PCD_TOKEN_EX_%s(GuidPtr)   __PCD_%s_ADDR_CMP(GuidPtr) ? __PCD_%s_ADDR_CMP(GuidPtr) : __PCD_%s_VAL_CMP(GuidPtr)  \n'\r
                                    % (RealTokenCName, RealTokenCName, RealTokenCName, RealTokenCName))\r
                TokenCNameList.append(TokenCName)\r
\r
def GetPcdSize(Pcd):\r
    if Pcd.DatumType not in _NumericDataTypesList:\r
        Value = Pcd.DefaultValue\r
        if Value in [None, '']:\r
            return 1\r
        elif Value[0] == 'L':\r
            return (len(Value) - 2) * 2\r
        elif Value[0] == '{':\r
            return len(Value.split(','))\r
        else:\r
            return len(Value) - 1\r
    if Pcd.DatumType == 'UINT64':\r
        return 8\r
    if Pcd.DatumType == 'UINT32':\r
        return 4\r
    if Pcd.DatumType == 'UINT16':\r
        return 2\r
    if Pcd.DatumType == 'UINT8':\r
        return 1\r
    if Pcd.DatumType == 'BOOLEAN':\r
        return 1\r
    else:\r
        return Pcd.MaxDatumSize\r
\r
\r
## Create code for module PCDs\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#   @param      Pcd         The PCD object\r
#\r
def CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
    TokenSpaceGuidValue = Pcd.TokenSpaceGuidValue   #Info.GuidList[Pcd.TokenSpaceGuidCName]\r
    PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
    #\r
    # Write PCDs\r
    #\r
    TokenCName = Pcd.TokenCName\r
    for PcdItem in GlobalData.MixedPcd:\r
        if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
            TokenCName = PcdItem[0]\r
            break\r
    PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
    PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r
    PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r
    FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r
\r
    if Pcd.PcdValueFromComm:\r
        Pcd.DefaultValue = Pcd.PcdValueFromComm\r
    \r
    if Pcd.Type in gDynamicExPcd:\r
        TokenNumber = int(Pcd.TokenValue, 0)\r
        # Add TokenSpaceGuidValue value to PcdTokenName to discriminate the DynamicEx PCDs with \r
        # different Guids but same TokenCName\r
        PcdExTokenName = '_PCD_TOKEN_' + Pcd.TokenSpaceGuidCName + '_' + TokenCName\r
        AutoGenH.Append('\n#define %s  %dU\n' % (PcdExTokenName, TokenNumber))\r
    else:\r
        if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
            # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
            # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
            # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
            # report warning message notify the PI that they are attempting to build a module \r
            # that must be included in a flash image in order to be functional. These Dynamic PCD \r
            # will not be added into the Database unless it is used by other modules that are \r
            # included in the FDF file. \r
            # In this case, just assign an invalid token number to make it pass build.\r
            if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
                TokenNumber = 0\r
            else:\r
                EdkLogger.error("build", AUTOGEN_ERROR,\r
                                "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                ExtraData="[%s]" % str(Info))\r
        else:\r
            TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
        AutoGenH.Append('\n#define %s  %dU\n' % (PcdTokenName, TokenNumber))\r
\r
    EdkLogger.debug(EdkLogger.DEBUG_3, "Creating code for " + TokenCName + "." + Pcd.TokenSpaceGuidCName)\r
    if Pcd.Type not in gItemTypeStringDatabase:\r
        EdkLogger.error("build", AUTOGEN_ERROR,\r
                        "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r
                        ExtraData="[%s]" % str(Info))\r
\r
    DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase['VOID*']\r
    DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib['VOID*']\r
    GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_' + TokenCName\r
    SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_' + TokenCName\r
    SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_S_' + TokenCName\r
    GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r
    \r
    PcdExCNameList  = []\r
    if Pcd.Type in gDynamicExPcd:\r
        if Info.IsLibrary:\r
            PcdList = Info.LibraryPcdList\r
        else:\r
            PcdList = Info.ModulePcdList\r
        for PcdModule in PcdList:\r
            if PcdModule.Type in gDynamicExPcd:\r
                PcdExCNameList.append(PcdModule.TokenCName)\r
        # Be compatible with the current code which using PcdToken and PcdGet/Set for DynamicEx Pcd.\r
        # If only PcdToken and PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
        # If PcdToken and PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
        if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
            AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r
            AutoGenH.Append('// #define %s  %s\n' % (PcdTokenName, PcdExTokenName))\r
            AutoGenH.Append('// #define %s  LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            AutoGenH.Append('// #define %s  LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            else:\r
                AutoGenH.Append('// #define %s(Value)  LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('// #define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
        else:\r
            AutoGenH.Append('#define %s  %s\n' % (PcdTokenName, PcdExTokenName))\r
            AutoGenH.Append('#define %s  LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            else:\r
                AutoGenH.Append('#define %s(Value)  LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('#define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
    elif Pcd.Type in gDynamicPcd:\r
        PcdList = []\r
        PcdCNameList = []\r
        PcdList.extend(Info.LibraryPcdList)\r
        PcdList.extend(Info.ModulePcdList)\r
        for PcdModule in PcdList:\r
            if PcdModule.Type in gDynamicPcd:\r
                PcdCNameList.append(PcdModule.TokenCName)\r
        if PcdCNameList.count(Pcd.TokenCName) > 1:\r
            EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName. They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r
        else:\r
            AutoGenH.Append('#define %s  LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
            AutoGenH.Append('#define %s  LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
            else:\r
                AutoGenH.Append('#define %s(Value)  LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
                AutoGenH.Append('#define %s(Value)  LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
    else:\r
        PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r
        Const = 'const'\r
        if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
            Const = ''\r
        Type = ''\r
        Array = ''\r
        Value = Pcd.DefaultValue\r
        Unicode = False\r
        ValueNumber = 0\r
\r
        if Pcd.DatumType == 'BOOLEAN':\r
            BoolValue = Value.upper()\r
            if BoolValue == 'TRUE' or BoolValue == '1':\r
                Value = '1U'\r
            elif BoolValue == 'FALSE' or BoolValue == '0':\r
                Value = '0U'\r
\r
        if Pcd.DatumType in ['UINT64', 'UINT32', 'UINT16', 'UINT8']:\r
            try:\r
                if Value.upper().endswith('L'):\r
                    Value = Value[:-1]\r
                ValueNumber = int (Value, 0)\r
            except:\r
                EdkLogger.error("build", AUTOGEN_ERROR,\r
                                "PCD value is not valid dec or hex number for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                ExtraData="[%s]" % str(Info))\r
            if Pcd.DatumType == 'UINT64':\r
                if ValueNumber < 0:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                elif ValueNumber >= 0x10000000000000000:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                if not Value.endswith('ULL'):\r
                    Value += 'ULL'\r
            elif Pcd.DatumType == 'UINT32':\r
                if ValueNumber < 0:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                elif ValueNumber >= 0x100000000:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                if not Value.endswith('U'):\r
                    Value += 'U'\r
            elif Pcd.DatumType == 'UINT16':\r
                if ValueNumber < 0:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                elif ValueNumber >= 0x10000:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                if not Value.endswith('U'):\r
                    Value += 'U'                    \r
            elif Pcd.DatumType == 'UINT8':\r
                if ValueNumber < 0:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "PCD can't be set to negative value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                elif ValueNumber >= 0x100:\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "Too large PCD value for datum type [%s] of PCD %s.%s" % (Pcd.DatumType, Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                if not Value.endswith('U'):\r
                    Value += 'U'\r
        if Pcd.DatumType not in _NumericDataTypesList:\r
            if Pcd.MaxDatumSize is None or Pcd.MaxDatumSize == '':\r
                EdkLogger.error("build", AUTOGEN_ERROR,\r
                                "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                ExtraData="[%s]" % str(Info))\r
\r
            ArraySize = int(Pcd.MaxDatumSize, 0)\r
            if Value[0] == '{':\r
                Type = '(VOID *)'\r
            else:\r
                if Value[0] == 'L':\r
                    Unicode = True\r
                Value = Value.lstrip('L')   #.strip('"')\r
                Value = eval(Value)         # translate escape character\r
                NewValue = '{'\r
                for Index in range(0,len(Value)):\r
                    if Unicode:\r
                        NewValue = NewValue + str(ord(Value[Index]) % 0x10000) + ', '\r
                    else:\r
                        NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r
                if Unicode:\r
                    ArraySize = ArraySize / 2;\r
\r
                if ArraySize < (len(Value) + 1):\r
                    EdkLogger.error("build", AUTOGEN_ERROR,\r
                                    "The maximum size of VOID* type PCD '%s.%s' is less than its actual size occupied." % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                    ExtraData="[%s]" % str(Info))\r
                Value = NewValue + '0 }'\r
            Array = '[%d]' % ArraySize\r
        #\r
        # skip casting for fixed at build since it breaks ARM assembly.\r
        # Long term we need PCD macros that work in assembly\r
        #\r
        elif Pcd.Type != TAB_PCDS_FIXED_AT_BUILD and Pcd.DatumType in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN', 'VOID*']:\r
            Value = "((%s)%s)" % (Pcd.DatumType, Value)\r
\r
        if Pcd.DatumType not in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN', 'VOID*']:\r
            # handle structure PCD\r
            if Pcd.MaxDatumSize is None or Pcd.MaxDatumSize == '':\r
                EdkLogger.error("build", AUTOGEN_ERROR,\r
                                "Unknown [MaxDatumSize] of PCD [%s.%s]" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                ExtraData="[%s]" % str(Info))\r
\r
            ArraySize = int(Pcd.MaxDatumSize, 0)\r
            Array = '[%d]' % ArraySize\r
\r
        if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
            PcdValueName = '_PCD_PATCHABLE_VALUE_' + TokenCName\r
        else:\r
            PcdValueName = '_PCD_VALUE_' + TokenCName\r
            \r
        if Pcd.DatumType not in _NumericDataTypesList:\r
            #\r
            # For unicode, UINT16 array will be generated, so the alignment of unicode is guaranteed.\r
            #\r
            AutoGenH.Append('#define %s  %s%s\n' %(PcdValueName, Type, PcdVariableName))\r
            if Unicode:\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
            else:\r
                AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s UINT8 %s%s = %s;\n' % (Const, PcdVariableName, Array, Value))\r
                AutoGenH.Append('extern %s UINT8 %s%s;\n' %(Const, PcdVariableName, Array))\r
            AutoGenH.Append('#define %s  %s%s\n' %(GetModeName, Type, PcdVariableName))\r
                \r
            PcdDataSize = GetPcdSize(Pcd)\r
            if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r
                AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
                AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
            \r
            if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
                AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, Pcd.MaxDatumSize))\r
                AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
                AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
                AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r
        elif Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
            AutoGenH.Append('#define %s  %s\n' %(PcdValueName, Value))\r
            AutoGenC.Append('volatile %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
            AutoGenH.Append('extern volatile %s  %s  %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
            AutoGenH.Append('#define %s  %s%s\n' % (GetModeName, Type, PcdVariableName))\r
            \r
            PcdDataSize = GetPcdSize(Pcd)\r
            AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r
            \r
            AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
            AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
            AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED UINTN %s = %s;\n' % (PatchPcdSizeVariableName,PcdDataSize))\r
        else:\r
            PcdDataSize = GetPcdSize(Pcd)\r
            AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
            AutoGenH.Append('#define %s  %s \n' % (GetModeSizeName,FixPcdSizeTokenName))\r
            \r
            AutoGenH.Append('#define %s  %s\n' %(PcdValueName, Value))\r
            AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s %s = %s;\n' %(Const, Pcd.DatumType, PcdVariableName, PcdValueName))\r
            AutoGenH.Append('extern %s  %s  %s%s;\n' % (Const, Pcd.DatumType, PcdVariableName, Array))\r
            AutoGenH.Append('#define %s  %s%s\n' % (GetModeName, Type, PcdVariableName))\r
\r
        if Pcd.Type == TAB_PCDS_PATCHABLE_IN_MODULE:\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, Pcd.TokenCName, Pcd.TokenCName, Pcd.TokenCName))\r
            else:\r
                AutoGenH.Append('#define %s(Value)  (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
                AutoGenH.Append('#define %s(Value)  ((%s = (Value)), RETURN_SUCCESS) \n' % (SetModeStatusName, PcdVariableName))\r
        else:\r
            AutoGenH.Append('//#define %s  ASSERT(FALSE)  // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
\r
## Create code for library module PCDs\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#   @param      Pcd         The PCD object\r
#\r
def CreateLibraryPcdCode(Info, AutoGenC, AutoGenH, Pcd):\r
    PcdTokenNumber = Info.PlatformInfo.PcdTokenNumber\r
    TokenSpaceGuidCName = Pcd.TokenSpaceGuidCName\r
    TokenCName  = Pcd.TokenCName\r
    for PcdItem in GlobalData.MixedPcd:\r
        if (TokenCName, TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
            TokenCName = PcdItem[0]\r
            break\r
    PcdTokenName = '_PCD_TOKEN_' + TokenCName\r
    FixPcdSizeTokenName = '_PCD_SIZE_' + TokenCName\r
    PatchPcdSizeTokenName = '_PCD_PATCHABLE_' + TokenCName +'_SIZE'\r
    PatchPcdSizeVariableName = '_gPcd_BinaryPatch_Size_' + TokenCName\r
\r
    if Pcd.PcdValueFromComm:\r
        Pcd.DefaultValue = Pcd.PcdValueFromComm\r
    #\r
    # Write PCDs\r
    #\r
    if Pcd.Type in gDynamicExPcd:\r
        TokenNumber = int(Pcd.TokenValue, 0)\r
    else:\r
        if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) not in PcdTokenNumber:\r
            # If one of the Source built modules listed in the DSC is not listed in FDF modules, \r
            # and the INF lists a PCD can only use the PcdsDynamic access method (it is only \r
            # listed in the DEC file that declares the PCD as PcdsDynamic), then build tool will \r
            # report warning message notify the PI that they are attempting to build a module \r
            # that must be included in a flash image in order to be functional. These Dynamic PCD \r
            # will not be added into the Database unless it is used by other modules that are \r
            # included in the FDF file. \r
            # In this case, just assign an invalid token number to make it pass build.\r
            if Pcd.Type in PCD_DYNAMIC_TYPE_LIST:\r
                TokenNumber = 0\r
            else:\r
                EdkLogger.error("build", AUTOGEN_ERROR,\r
                                "No generated token number for %s.%s\n" % (Pcd.TokenSpaceGuidCName, TokenCName),\r
                                ExtraData="[%s]" % str(Info))\r
        else:\r
            TokenNumber = PcdTokenNumber[Pcd.TokenCName, Pcd.TokenSpaceGuidCName]\r
\r
    if Pcd.Type not in gItemTypeStringDatabase:\r
        EdkLogger.error("build", AUTOGEN_ERROR,\r
                        "Unknown PCD type [%s] of PCD %s.%s" % (Pcd.Type, Pcd.TokenSpaceGuidCName, TokenCName),\r
                        ExtraData="[%s]" % str(Info))\r
\r
    DatumType   = Pcd.DatumType\r
    DatumSize = gDatumSizeStringDatabase[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabase else gDatumSizeStringDatabase['VOID*']\r
    DatumSizeLib = gDatumSizeStringDatabaseLib[Pcd.DatumType] if Pcd.DatumType in gDatumSizeStringDatabaseLib else gDatumSizeStringDatabaseLib['VOID*']\r
    GetModeName = '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_GET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_' + TokenCName\r
    SetModeName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_' + TokenCName\r
    SetModeStatusName = '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH[Pcd.DatumType] + '_S_' + TokenCName if Pcd.DatumType in gDatumSizeStringDatabaseH else '_PCD_SET_MODE_' + gDatumSizeStringDatabaseH['VOID*'] + '_S_' + TokenCName\r
    GetModeSizeName = '_PCD_GET_MODE_SIZE' + '_' + TokenCName\r
\r
    Type = ''\r
    Array = ''\r
    if Pcd.DatumType not in _NumericDataTypesList:\r
        if Pcd.DefaultValue[0]== '{':\r
            Type = '(VOID *)'\r
        Array = '[]'\r
    PcdItemType = Pcd.Type\r
    PcdExCNameList  = []\r
    if PcdItemType in gDynamicExPcd:\r
        PcdExTokenName = '_PCD_TOKEN_' + TokenSpaceGuidCName + '_' + TokenCName\r
        AutoGenH.Append('\n#define %s  %dU\n' % (PcdExTokenName, TokenNumber))\r
        \r
        if Info.IsLibrary:\r
            PcdList = Info.LibraryPcdList\r
        else:\r
            PcdList = Info.ModulePcdList\r
        for PcdModule in PcdList:\r
            if PcdModule.Type in gDynamicExPcd:\r
                PcdExCNameList.append(PcdModule.TokenCName)\r
        # Be compatible with the current code which using PcdGet/Set for DynamicEx Pcd.\r
        # If only PcdGet/Set used in all Pcds with different CName, it should succeed to build.\r
        # If PcdGet/Set used in the Pcds with different Guids but same CName, it should failed to build.\r
        if PcdExCNameList.count(Pcd.TokenCName) > 1:\r
            AutoGenH.Append('// Disabled the macros, as PcdToken and PcdGet/Set are not allowed in the case that more than one DynamicEx Pcds are different Guids but same CName.\n')\r
            AutoGenH.Append('// #define %s  %s\n' % (PcdTokenName, PcdExTokenName))\r
            AutoGenH.Append('// #define %s  LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            AutoGenH.Append('// #define %s  LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('// #define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            else:\r
                AutoGenH.Append('// #define %s(Value)  LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('// #define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
        else:\r
            AutoGenH.Append('#define %s  %s\n' % (PcdTokenName, PcdExTokenName))\r
            AutoGenH.Append('#define %s  LibPcdGetEx%s(&%s, %s)\n' % (GetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            AutoGenH.Append('#define %s LibPcdGetExSize(&%s, %s)\n' % (GetModeSizeName,Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%s(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSetEx%sS(&%s, %s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
            else:\r
                AutoGenH.Append('#define %s(Value)  LibPcdSetEx%s(&%s, %s, (Value))\n' % (SetModeName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
                AutoGenH.Append('#define %s(Value)  LibPcdSetEx%sS(&%s, %s, (Value))\n' % (SetModeStatusName, DatumSizeLib, Pcd.TokenSpaceGuidCName, PcdTokenName))\r
    else:\r
        AutoGenH.Append('#define _PCD_TOKEN_%s  %dU\n' % (TokenCName, TokenNumber))\r
    if PcdItemType in gDynamicPcd:\r
        PcdList = []\r
        PcdCNameList = []\r
        PcdList.extend(Info.LibraryPcdList)\r
        PcdList.extend(Info.ModulePcdList)\r
        for PcdModule in PcdList:\r
            if PcdModule.Type in gDynamicPcd:\r
                PcdCNameList.append(PcdModule.TokenCName)\r
        if PcdCNameList.count(Pcd.TokenCName) > 1:\r
            EdkLogger.error("build", AUTOGEN_ERROR, "More than one Dynamic Pcds [%s] are different Guids but same CName.They need to be changed to DynamicEx type to avoid the confliction.\n" % (TokenCName), ExtraData="[%s]" % str(Info.MetaFile.Path))\r
        else:\r
            AutoGenH.Append('#define %s  LibPcdGet%s(%s)\n' % (GetModeName, DatumSizeLib, PcdTokenName))\r
            AutoGenH.Append('#define %s  LibPcdGetSize(%s)\n' % (GetModeSizeName, PcdTokenName))\r
            if DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSet%s(%s, (SizeOfBuffer), (Buffer))\n' %(SetModeName, DatumSizeLib, PcdTokenName))\r
                AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPcdSet%sS(%s, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
            else:\r
                AutoGenH.Append('#define %s(Value)  LibPcdSet%s(%s, (Value))\n' % (SetModeName, DatumSizeLib, PcdTokenName))\r
                AutoGenH.Append('#define %s(Value)  LibPcdSet%sS(%s, (Value))\n' % (SetModeStatusName, DatumSizeLib, PcdTokenName))\r
    if PcdItemType == TAB_PCDS_PATCHABLE_IN_MODULE:\r
        PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[TAB_PCDS_PATCHABLE_IN_MODULE] + '_' + TokenCName\r
        if DatumType not in _NumericDataTypesList:\r
            ArraySize = int(Pcd.MaxDatumSize, 0)\r
            if Pcd.DefaultValue[0] == 'L':\r
                ArraySize = ArraySize / 2\r
            Array = '[%d]' % ArraySize\r
            DatumType = ['UINT8', 'UINT16'][Pcd.DefaultValue[0] == 'L']\r
            AutoGenH.Append('extern %s _gPcd_BinaryPatch_%s%s;\n' %(DatumType, TokenCName, Array))\r
        else:\r
            AutoGenH.Append('extern volatile  %s  %s%s;\n' % (DatumType, PcdVariableName, Array))\r
        AutoGenH.Append('#define %s  %s_gPcd_BinaryPatch_%s\n' %(GetModeName, Type, TokenCName))\r
        PcdDataSize = GetPcdSize(Pcd)\r
        if Pcd.DatumType not in _NumericDataTypesList:\r
            AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSize((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeName, TokenCName, TokenCName, TokenCName))\r
            AutoGenH.Append('#define %s(SizeOfBuffer, Buffer)  LibPatchPcdSetPtrAndSizeS((VOID *)_gPcd_BinaryPatch_%s, &_gPcd_BinaryPatch_Size_%s, (UINTN)_PCD_PATCHABLE_%s_SIZE, (SizeOfBuffer), (Buffer))\n' % (SetModeStatusName, TokenCName, TokenCName, TokenCName))\r
            AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, Pcd.MaxDatumSize))\r
        else:\r
            AutoGenH.Append('#define %s(Value)  (%s = (Value))\n' % (SetModeName, PcdVariableName))\r
            AutoGenH.Append('#define %s(Value)  ((%s = (Value)), RETURN_SUCCESS)\n' % (SetModeStatusName, PcdVariableName))\r
            AutoGenH.Append('#define %s %s\n' % (PatchPcdSizeTokenName, PcdDataSize))\r
\r
        AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,PatchPcdSizeVariableName))\r
        AutoGenH.Append('extern UINTN %s; \n' % PatchPcdSizeVariableName)\r
        \r
    if PcdItemType == TAB_PCDS_FIXED_AT_BUILD or PcdItemType == TAB_PCDS_FEATURE_FLAG:\r
        key = ".".join((Pcd.TokenSpaceGuidCName,Pcd.TokenCName))\r
        PcdVariableName = '_gPcd_' + gItemTypeStringDatabase[Pcd.Type] + '_' + TokenCName\r
        if DatumType == 'VOID*' and Array == '[]':\r
            DatumType = ['UINT8', 'UINT16'][Pcd.DefaultValue[0] == 'L']\r
        if DatumType not in ['UINT8', 'UINT16', 'UINT32', 'UINT64', 'BOOLEAN', 'VOID*']:\r
            DatumType = 'UINT8'\r
        AutoGenH.Append('extern const %s _gPcd_FixedAtBuild_%s%s;\n' %(DatumType, TokenCName, Array))\r
        AutoGenH.Append('#define %s  %s_gPcd_FixedAtBuild_%s\n' %(GetModeName, Type, TokenCName))\r
        AutoGenH.Append('//#define %s  ASSERT(FALSE)  // It is not allowed to set value for a FIXED_AT_BUILD PCD\n' % SetModeName)\r
        \r
        if PcdItemType == TAB_PCDS_FIXED_AT_BUILD and (key in Info.ConstPcd or (Info.IsLibrary and not Info._ReferenceModules)):\r
            if Pcd.DatumType not in _NumericDataTypesList:\r
                AutoGenH.Append('#define _PCD_VALUE_%s %s%s\n' %(TokenCName, Type, PcdVariableName))\r
            else:\r
                AutoGenH.Append('#define _PCD_VALUE_%s %s\n' %(TokenCName, Pcd.DefaultValue))\r
        \r
        if PcdItemType == TAB_PCDS_FIXED_AT_BUILD:\r
            PcdDataSize = GetPcdSize(Pcd)\r
            AutoGenH.Append('#define %s %s\n' % (FixPcdSizeTokenName, PcdDataSize))\r
            AutoGenH.Append('#define %s %s\n' % (GetModeSizeName,FixPcdSizeTokenName))\r
\r
## Create code for library constructor\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH):\r
    #\r
    # Library Constructors\r
    #\r
    ConstructorPrototypeString = TemplateString()\r
    ConstructorCallingString = TemplateString()\r
    if Info.IsLibrary:\r
        DependentLibraryList = [Info.Module]\r
    else:\r
        DependentLibraryList = Info.DependentLibraryList\r
    for Lib in DependentLibraryList:\r
        if len(Lib.ConstructorList) <= 0:\r
            continue\r
        Dict = {'Function':Lib.ConstructorList}\r
        if Lib.ModuleType in ['BASE', 'SEC']:\r
            ConstructorPrototypeString.Append(gLibraryStructorPrototype['BASE'].Replace(Dict))\r
            ConstructorCallingString.Append(gLibraryStructorCall['BASE'].Replace(Dict))\r
        elif Lib.ModuleType in ['PEI_CORE','PEIM']:\r
            ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
            ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
        elif Lib.ModuleType in ['DXE_CORE','DXE_DRIVER','DXE_SMM_DRIVER','DXE_RUNTIME_DRIVER',\r
                                'DXE_SAL_DRIVER','UEFI_DRIVER','UEFI_APPLICATION','SMM_CORE']:\r
            ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
            ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
        elif Lib.ModuleType in ['MM_STANDALONE','MM_CORE_STANDALONE']:\r
            ConstructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r
            ConstructorCallingString.Append(gLibraryStructorCall['MM'].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
        elif Info.ModuleType in ['MM_STANDALONE','MM_CORE_STANDALONE']:\r
            AutoGenC.Append(gLibraryString['MM'].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
        elif Lib.ModuleType in ['MM_STANDALONE','MM_CORE_STANDALONE']:\r
            DestructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r
            DestructorCallingString.Append(gLibraryStructorCall['MM'].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
        elif Info.ModuleType in ['MM_STANDALONE','MM_CORE_STANDALONE']:\r
            AutoGenC.Append(gLibraryString['MM'].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', 'MM_CORE_STANDALONE']:\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 == 'MM_CORE_STANDALONE':\r
        AutoGenC.Append(gMmCoreStandaloneEntryPointString.Replace(Dict))\r
        AutoGenH.Append(gMmCoreStandaloneEntryPointPrototype.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 == 'MM_STANDALONE':\r
        if NumEntryPoints < 2:\r
            AutoGenC.Append(gMmStandaloneEntryPointString[NumEntryPoints].Replace(Dict))\r
        else:\r
            AutoGenC.Append(gMmStandaloneEntryPointString[2].Replace(Dict))\r
        AutoGenH.Append(gMmStandaloneEntryPointPrototype.Replace(Dict))\r
    elif Info.ModuleType == 'UEFI_APPLICATION':\r
        if NumEntryPoints < 2:\r
            AutoGenC.Append(gUefiApplicationEntryPointString[NumEntryPoints].Replace(Dict))\r
        else:\r
            AutoGenC.Append(gUefiApplicationEntryPointString[2].Replace(Dict))\r
        AutoGenH.Append(gUefiApplicationEntryPointPrototype.Replace(Dict))\r
\r
## Create code for ModuleUnloadImage\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r
    if Info.IsLibrary or Info.ModuleType in ['USER_DEFINED', 'SEC']:\r
        return\r
    #\r
    # Unload Image Handlers\r
    #\r
    NumUnloadImage = len(Info.Module.ModuleUnloadImageList)\r
    Dict = {'Count':str(NumUnloadImage) + 'U', 'Function':Info.Module.ModuleUnloadImageList}\r
    if NumUnloadImage < 2:\r
        AutoGenC.Append(gUefiUnloadImageString[NumUnloadImage].Replace(Dict))\r
    else:\r
        AutoGenC.Append(gUefiUnloadImageString[2].Replace(Dict))\r
    AutoGenH.Append(gUefiUnloadImagePrototype.Replace(Dict))\r
\r
## Create code for GUID\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH):\r
    if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
        GuidType = "GUID"\r
    else:\r
        GuidType = "EFI_GUID"\r
\r
    if Info.GuidList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append("\n// Guids\n")\r
        AutoGenH.Append("\n// Guids\n")\r
    #\r
    # GUIDs\r
    #\r
    for Key in Info.GuidList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.GuidList[Key]))\r
        AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
\r
## Create code for protocol\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH):\r
    if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
        GuidType = "GUID"\r
    else:\r
        GuidType = "EFI_GUID"\r
\r
    if Info.ProtocolList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append("\n// Protocols\n")\r
        AutoGenH.Append("\n// Protocols\n")\r
    #\r
    # Protocol GUIDs\r
    #\r
    for Key in Info.ProtocolList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.ProtocolList[Key]))\r
        AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
\r
## Create code for PPI\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH):\r
    if Info.ModuleType in ["USER_DEFINED", "BASE"]:\r
        GuidType = "GUID"\r
    else:\r
        GuidType = "EFI_GUID"\r
\r
    if Info.PpiList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append("\n// PPIs\n")\r
        AutoGenH.Append("\n// PPIs\n")\r
    #\r
    # PPI GUIDs\r
    #\r
    for Key in Info.PpiList:\r
        if not Info.IsLibrary:\r
            AutoGenC.Append('GLOBAL_REMOVE_IF_UNREFERENCED %s %s = %s;\n' % (GuidType, Key, Info.PpiList[Key]))\r
        AutoGenH.Append('extern %s %s;\n' % (GuidType, Key))\r
\r
## Create code for PCD\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreatePcdCode(Info, AutoGenC, AutoGenH):\r
\r
    # Collect Token Space GUIDs used by DynamicEc PCDs\r
    TokenSpaceList = []\r
    for Pcd in Info.ModulePcdList:\r
        if Pcd.Type in gDynamicExPcd and Pcd.TokenSpaceGuidCName not in TokenSpaceList:\r
            TokenSpaceList += [Pcd.TokenSpaceGuidCName]\r
            \r
    SkuMgr = Info.Workspace.Platform.SkuIdMgr\r
    AutoGenH.Append("\n// Definition of SkuId Array\n")\r
    AutoGenH.Append("extern UINT64 _gPcd_SkuId_Array[];\n")\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
        AutoGenC.Append("\n// Definition of SkuId Array\n")\r
        AutoGenC.Append("GLOBAL_REMOVE_IF_UNREFERENCED UINT64 _gPcd_SkuId_Array[] = %s;\n" % SkuMgr.DumpSkuIdArrary())\r
        if Info.ModulePcdList:\r
            AutoGenH.Append("\n// Definition of PCDs used in this module\n")\r
            AutoGenC.Append("\n// Definition of PCDs used in this module\n")\r
        for Pcd in Info.ModulePcdList:\r
            CreateModulePcdCode(Info, AutoGenC, AutoGenH, Pcd)\r
        DynExPcdTokenNumberMapping (Info, AutoGenH)\r
        if Info.LibraryPcdList:\r
            AutoGenH.Append("\n// Definition of PCDs used in libraries is in AutoGen.c\n")\r
            AutoGenC.Append("\n// Definition of PCDs used in libraries\n")\r
        for Pcd in Info.LibraryPcdList:\r
            CreateModulePcdCode(Info, AutoGenC, AutoGenC, Pcd)\r
    CreatePcdDatabaseCode(Info, AutoGenC, AutoGenH)\r
\r
## Create code for unicode string definition\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#   @param      UniGenCFlag     UniString is generated into AutoGen C file when it is set to True\r
#   @param      UniGenBinBuffer Buffer to store uni string package data\r
#\r
def CreateUnicodeStringCode(Info, AutoGenC, AutoGenH, UniGenCFlag, UniGenBinBuffer):\r
    WorkingDir = os.getcwd()\r
    os.chdir(Info.WorkspaceDir)\r
\r
    IncList = [Info.MetaFile.Dir]\r
    # Get all files under [Sources] section in inf file for EDK-II module\r
    EDK2Module = True\r
    SrcList = [F for F in Info.SourceFileList]\r
    if Info.AutoGenVersion < 0x00010005:\r
        EDK2Module = False\r
        # Get all files under the module directory for EDK-I module\r
        Cwd = os.getcwd()\r
        os.chdir(Info.MetaFile.Dir)\r
        for Root, Dirs, Files in os.walk("."):\r
            if 'CVS' in Dirs:\r
                Dirs.remove('CVS')\r
            if '.svn' in Dirs:\r
                Dirs.remove('.svn')\r
            for File in Files:\r
                File = PathClass(os.path.join(Root, File), Info.MetaFile.Dir)\r
                if File in SrcList:\r
                    continue\r
                SrcList.append(File)\r
        os.chdir(Cwd)\r
\r
    if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-c') > -1:\r
        CompatibleMode = True\r
    else:\r
        CompatibleMode = False\r
\r
    #\r
    # -s is a temporary option dedicated for building .UNI files with ISO 639-2 language codes of EDK Shell in EDK2\r
    #\r
    if 'BUILD' in Info.BuildOption and Info.BuildOption['BUILD']['FLAGS'].find('-s') > -1:\r
        if CompatibleMode:\r
            EdkLogger.error("build", AUTOGEN_ERROR,\r
                            "-c and -s build options should be used exclusively",\r
                            ExtraData="[%s]" % str(Info))\r
        ShellMode = True\r
    else:\r
        ShellMode = False\r
\r
    #RFC4646 is only for EDKII modules and ISO639-2 for EDK modules\r
    if EDK2Module:\r
        FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.RFCLanguages]\r
    else:\r
        FilterInfo = [EDK2Module] + [Info.PlatformInfo.Platform.ISOLanguages]\r
    Header, Code = GetStringFiles(Info.UnicodeFileList, SrcList, IncList, Info.IncludePathList, ['.uni', '.inf'], Info.Name, CompatibleMode, ShellMode, UniGenCFlag, UniGenBinBuffer, FilterInfo)\r
    if CompatibleMode or UniGenCFlag:\r
        AutoGenC.Append("\n//\n//Unicode String Pack Definition\n//\n")\r
        AutoGenC.Append(Code)\r
        AutoGenC.Append("\n")\r
    AutoGenH.Append("\n//\n//Unicode String ID\n//\n")\r
    AutoGenH.Append(Header)\r
    if CompatibleMode or UniGenCFlag:\r
        AutoGenH.Append("\n#define STRING_ARRAY_NAME %sStrings\n" % Info.Name)\r
    os.chdir(WorkingDir)\r
\r
def CreateIdfFileCode(Info, AutoGenC, StringH, IdfGenCFlag, IdfGenBinBuffer):\r
    if len(Info.IdfFileList) > 0:\r
        ImageFiles = IdfFileClassObject(sorted (Info.IdfFileList))\r
        if ImageFiles.ImageFilesDict:\r
            Index = 1\r
            PaletteIndex = 1\r
            IncList = [Info.MetaFile.Dir]\r
            SrcList = [F for F in Info.SourceFileList]\r
            SkipList = ['.jpg', '.png', '.bmp', '.inf', '.idf']\r
            FileList = GetFileList(SrcList, IncList, SkipList)\r
            ValueStartPtr = 60\r
            StringH.Append("\n//\n//Image ID\n//\n")\r
            ImageInfoOffset = 0\r
            PaletteInfoOffset = 0\r
            ImageBuffer = pack('x')\r
            PaletteBuffer = pack('x')\r
            BufferStr = ''\r
            PaletteStr = ''\r
            FileDict = {}\r
            for Idf in ImageFiles.ImageFilesDict:\r
                if ImageFiles.ImageFilesDict[Idf]:\r
                    for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
                        for sourcefile in Info.SourceFileList:\r
                            if FileObj.FileName == sourcefile.File:\r
                                if not sourcefile.Ext.upper() in ['.PNG', '.BMP', '.JPG']:\r
                                    EdkLogger.error("build", AUTOGEN_ERROR, "The %s's postfix must be one of .bmp, .jpg, .png" % (FileObj.FileName), ExtraData="[%s]" % str(Info))\r
                                FileObj.File = sourcefile\r
                                break\r
                        else:\r
                            EdkLogger.error("build", AUTOGEN_ERROR, "The %s in %s is not defined in the driver's [Sources] section" % (FileObj.FileName, Idf), ExtraData="[%s]" % str(Info))\r
\r
                    for FileObj in ImageFiles.ImageFilesDict[Idf]:\r
                        ID = FileObj.ImageID\r
                        File = FileObj.File\r
                        if not os.path.exists(File.Path) or not os.path.isfile(File.Path):\r
                            EdkLogger.error("build", FILE_NOT_FOUND, ExtraData=File.Path)\r
                        SearchImageID (FileObj, FileList)\r
                        if FileObj.Referenced:\r
                            if (ValueStartPtr - len(DEFINE_STR + ID)) <= 0:\r
                                Line = DEFINE_STR + ' ' + ID + ' ' + DecToHexStr(Index, 4) + '\n'\r
                            else:\r
                                Line = DEFINE_STR + ' ' + ID + ' ' * (ValueStartPtr - len(DEFINE_STR + ID)) + DecToHexStr(Index, 4) + '\n'\r
\r
                            if File not in FileDict:\r
                                FileDict[File] = Index\r
                            else:\r
                                DuplicateBlock = pack('B', EFI_HII_IIBT_DUPLICATE)\r
                                DuplicateBlock += pack('H', FileDict[File])\r
                                ImageBuffer += DuplicateBlock\r
                                BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r
                                TempBufferList = AscToHexList(DuplicateBlock)\r
                                BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r
                                StringH.Append(Line)\r
                                Index += 1\r
                                continue\r
\r
                            TmpFile = open(File.Path, 'rb')\r
                            Buffer = TmpFile.read()\r
                            TmpFile.close()\r
                            if File.Ext.upper() == '.PNG':\r
                                TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_PNG)\r
                                TempBuffer += pack('I', len(Buffer))\r
                                TempBuffer += Buffer\r
                            elif File.Ext.upper() == '.JPG':\r
                                ImageType, = struct.unpack('4s', Buffer[6:10])\r
                                if ImageType != 'JFIF':\r
                                    EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard JPG file." % File.Path)\r
                                TempBuffer = pack('B', EFI_HII_IIBT_IMAGE_JPEG)\r
                                TempBuffer += pack('I', len(Buffer))\r
                                TempBuffer += Buffer\r
                            elif File.Ext.upper() == '.BMP':\r
                                TempBuffer, TempPalette = BmpImageDecoder(File, Buffer, PaletteIndex, FileObj.TransParent)\r
                                if len(TempPalette) > 1:\r
                                    PaletteIndex += 1\r
                                    NewPalette = pack('H', len(TempPalette))\r
                                    NewPalette += TempPalette\r
                                    PaletteBuffer += NewPalette\r
                                    PaletteStr = WriteLine(PaletteStr, '// %s: %s: %s' % (DecToHexStr(PaletteIndex - 1, 4), ID, DecToHexStr(PaletteIndex - 1, 4)))\r
                                    TempPaletteList = AscToHexList(NewPalette)\r
                                    PaletteStr = WriteLine(PaletteStr, CreateArrayItem(TempPaletteList, 16) + '\n')\r
                            ImageBuffer += TempBuffer\r
                            BufferStr = WriteLine(BufferStr, '// %s: %s: %s' % (DecToHexStr(Index, 4), ID, DecToHexStr(Index, 4)))\r
                            TempBufferList = AscToHexList(TempBuffer)\r
                            BufferStr = WriteLine(BufferStr, CreateArrayItem(TempBufferList, 16) + '\n')\r
\r
                            StringH.Append(Line)\r
                            Index += 1\r
\r
            BufferStr = WriteLine(BufferStr, '// End of the Image Info')\r
            BufferStr = WriteLine(BufferStr, CreateArrayItem(DecToHexList(EFI_HII_IIBT_END, 2)) + '\n')\r
            ImageEnd = pack('B', EFI_HII_IIBT_END)\r
            ImageBuffer += ImageEnd\r
\r
            if len(ImageBuffer) > 1:\r
                ImageInfoOffset = 12\r
            if len(PaletteBuffer) > 1:\r
                PaletteInfoOffset = 12 + len(ImageBuffer) - 1 # -1 is for the first empty pad byte of ImageBuffer\r
\r
            IMAGE_PACKAGE_HDR = pack('=II', ImageInfoOffset, PaletteInfoOffset)\r
            # PACKAGE_HEADER_Length = PACKAGE_HEADER + ImageInfoOffset + PaletteInfoOffset + ImageBuffer Length + PaletteCount + PaletteBuffer Length\r
            if len(PaletteBuffer) > 1:\r
                PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1 + 2 + len(PaletteBuffer) - 1\r
            else:\r
                PACKAGE_HEADER_Length = 4 + 4 + 4 + len(ImageBuffer) - 1\r
            if PaletteIndex > 1:\r
                PALETTE_INFO_HEADER = pack('H', PaletteIndex - 1)\r
            # EFI_HII_PACKAGE_HEADER length max value is 0xFFFFFF\r
            Hex_Length = '%06X' % PACKAGE_HEADER_Length\r
            if PACKAGE_HEADER_Length > 0xFFFFFF:\r
                EdkLogger.error("build", AUTOGEN_ERROR, "The Length of EFI_HII_PACKAGE_HEADER exceed its maximum value", ExtraData="[%s]" % str(Info))\r
            PACKAGE_HEADER = pack('=HBB', int('0x' + Hex_Length[2:], 16), int('0x' + Hex_Length[0:2], 16), EFI_HII_PACKAGE_IMAGES)\r
\r
            IdfGenBinBuffer.write(PACKAGE_HEADER)\r
            IdfGenBinBuffer.write(IMAGE_PACKAGE_HDR)\r
            if len(ImageBuffer) > 1 :\r
                IdfGenBinBuffer.write(ImageBuffer[1:])\r
            if PaletteIndex > 1:\r
                IdfGenBinBuffer.write(PALETTE_INFO_HEADER)\r
            if len(PaletteBuffer) > 1:\r
                IdfGenBinBuffer.write(PaletteBuffer[1:])\r
\r
            if IdfGenCFlag:\r
                TotalLength = EFI_HII_ARRAY_SIZE_LENGTH + PACKAGE_HEADER_Length\r
                AutoGenC.Append("\n//\n//Image Pack Definition\n//\n")\r
                AllStr = WriteLine('', CHAR_ARRAY_DEFIN + ' ' + Info.Module.BaseName + 'Images' + '[] = {\n')\r
                AllStr = WriteLine(AllStr, '// STRGATHER_OUTPUT_HEADER')\r
                AllStr = WriteLine(AllStr, CreateArrayItem(DecToHexList(TotalLength)) + '\n')\r
                AllStr = WriteLine(AllStr, '// Image PACKAGE HEADER\n')\r
                IMAGE_PACKAGE_HDR_List = AscToHexList(PACKAGE_HEADER)\r
                IMAGE_PACKAGE_HDR_List += AscToHexList(IMAGE_PACKAGE_HDR)\r
                AllStr = WriteLine(AllStr, CreateArrayItem(IMAGE_PACKAGE_HDR_List, 16) + '\n')\r
                AllStr = WriteLine(AllStr, '// Image DATA\n')\r
                if BufferStr:\r
                    AllStr = WriteLine(AllStr, BufferStr)\r
                if PaletteStr:\r
                    AllStr = WriteLine(AllStr, '// Palette Header\n')\r
                    PALETTE_INFO_HEADER_List = AscToHexList(PALETTE_INFO_HEADER)\r
                    AllStr = WriteLine(AllStr, CreateArrayItem(PALETTE_INFO_HEADER_List, 16) + '\n')\r
                    AllStr = WriteLine(AllStr, '// Palette Data\n')\r
                    AllStr = WriteLine(AllStr, PaletteStr)\r
                AllStr = WriteLine(AllStr, '};')\r
                AutoGenC.Append(AllStr)\r
                AutoGenC.Append("\n")\r
                StringH.Append('\nextern unsigned char ' + Info.Module.BaseName + 'Images[];\n')\r
                StringH.Append("\n#define IMAGE_ARRAY_NAME %sImages\n" % Info.Module.BaseName)\r
\r
# typedef struct _EFI_HII_IMAGE_PACKAGE_HDR {\r
#   EFI_HII_PACKAGE_HEADER  Header;          # Standard package header, where Header.Type = EFI_HII_PACKAGE_IMAGES\r
#   UINT32                  ImageInfoOffset;\r
#   UINT32                  PaletteInfoOffset;\r
# } EFI_HII_IMAGE_PACKAGE_HDR;\r
\r
# typedef struct {\r
#   UINT32   Length:24;\r
#   UINT32   Type:8;\r
#   UINT8    Data[];\r
# } EFI_HII_PACKAGE_HEADER;\r
\r
# typedef struct _EFI_HII_IMAGE_BLOCK {\r
#   UINT8    BlockType;\r
#   UINT8    BlockBody[];\r
# } EFI_HII_IMAGE_BLOCK;\r
\r
def BmpImageDecoder(File, Buffer, PaletteIndex, TransParent):\r
    ImageType, = struct.unpack('2s', Buffer[0:2])\r
    if ImageType!= 'BM': # BMP file type is 'BM'\r
        EdkLogger.error("build", FILE_TYPE_MISMATCH, "The file %s is not a standard BMP file." % File.Path)\r
    BMP_IMAGE_HEADER = collections.namedtuple('BMP_IMAGE_HEADER', ['bfSize','bfReserved1','bfReserved2','bfOffBits','biSize','biWidth','biHeight','biPlanes','biBitCount', 'biCompression', 'biSizeImage','biXPelsPerMeter','biYPelsPerMeter','biClrUsed','biClrImportant'])\r
    BMP_IMAGE_HEADER_STRUCT = struct.Struct('IHHIIIIHHIIIIII')\r
    BmpHeader = BMP_IMAGE_HEADER._make(BMP_IMAGE_HEADER_STRUCT.unpack_from(Buffer[2:]))\r
    #\r
    # Doesn't support compress.\r
    #\r
    if BmpHeader.biCompression != 0:\r
        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The compress BMP file %s is not support." % File.Path)\r
\r
    # The Width and Height is UINT16 type in Image Package\r
    if BmpHeader.biWidth > 0xFFFF:\r
        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Width is exceed 0xFFFF." % File.Path)\r
    if BmpHeader.biHeight > 0xFFFF:\r
        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "The BMP file %s Height is exceed 0xFFFF." % File.Path)\r
\r
    PaletteBuffer = pack('x')\r
    if BmpHeader.biBitCount == 1:\r
        if TransParent:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT_TRANS)\r
        else:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r
        ImageBuffer += pack('B', PaletteIndex)\r
        Width = (BmpHeader.biWidth + 7)/8\r
        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
    elif BmpHeader.biBitCount == 4:\r
        if TransParent:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT_TRANS)\r
        else:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r
        ImageBuffer += pack('B', PaletteIndex)\r
        Width = (BmpHeader.biWidth + 1)/2\r
        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
    elif BmpHeader.biBitCount == 8:\r
        if TransParent:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT_TRANS)\r
        else:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_8BIT)\r
        ImageBuffer += pack('B', PaletteIndex)\r
        Width = BmpHeader.biWidth\r
        if BmpHeader.bfOffBits > BMP_IMAGE_HEADER_STRUCT.size + 2:\r
            PaletteBuffer = Buffer[BMP_IMAGE_HEADER_STRUCT.size + 2 : BmpHeader.bfOffBits]\r
    elif BmpHeader.biBitCount == 24:\r
        if TransParent:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT_TRANS)\r
        else:\r
            ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_24BIT)\r
        Width = BmpHeader.biWidth * 3\r
    else:\r
        EdkLogger.error("build", FORMAT_NOT_SUPPORTED, "Only support the 1 bit, 4 bit, 8bit, 24 bit BMP files.", ExtraData="[%s]" % str(File.Path))\r
\r
    ImageBuffer += pack('H', BmpHeader.biWidth)\r
    ImageBuffer += pack('H', BmpHeader.biHeight)\r
    Start = BmpHeader.bfOffBits\r
    End = BmpHeader.bfSize - 1\r
    for Height in range(0, BmpHeader.biHeight):\r
        if Width % 4 != 0:\r
            Start = End + (Width % 4) - 4 - Width\r
        else:\r
            Start = End - Width\r
        ImageBuffer += Buffer[Start + 1 : Start + Width + 1]\r
        End = Start\r
\r
    # handle the Palette info,  BMP use 4 bytes for R, G, B and Reserved info while EFI_HII_RGB_PIXEL only have the R, G, B info\r
    if PaletteBuffer and len(PaletteBuffer) > 1:\r
        PaletteTemp = pack('x')\r
        for Index in range(0, len(PaletteBuffer)):\r
            if Index % 4 == 3:\r
                continue\r
            PaletteTemp += PaletteBuffer[Index]\r
        PaletteBuffer = PaletteTemp[1:]\r
    return ImageBuffer, PaletteBuffer\r
\r
## Create common code\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateHeaderCode(Info, AutoGenC, AutoGenH):\r
    # file header\r
    AutoGenH.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.h'}))\r
    # header file Prologue\r
    AutoGenH.Append(gAutoGenHPrologueString.Replace({'File':'AUTOGENH','Guid':Info.Guid.replace('-','_')}))\r
    AutoGenH.Append(gAutoGenHCppPrologueString)\r
    if Info.AutoGenVersion >= 0x00010005:\r
        # header files includes\r
        AutoGenH.Append("#include <%s>\n" % gBasicHeaderFile)\r
        if Info.ModuleType in gModuleTypeHeaderFile \\r
           and gModuleTypeHeaderFile[Info.ModuleType][0] != gBasicHeaderFile:\r
            AutoGenH.Append("#include <%s>\n" % gModuleTypeHeaderFile[Info.ModuleType][0])\r
        #\r
        # if either PcdLib in [LibraryClasses] sections or there exist Pcd section, add PcdLib.h \r
        # As if modules only uses FixedPcd, then PcdLib is not needed in [LibraryClasses] section.\r
        #\r
        if 'PcdLib' in Info.Module.LibraryClasses or Info.Module.Pcds:\r
            AutoGenH.Append("#include <Library/PcdLib.h>\n")\r
\r
        AutoGenH.Append('\nextern GUID  gEfiCallerIdGuid;')\r
        AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r
\r
        if Info.IsLibrary:\r
            return\r
\r
        AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n  %s\n" % GuidStringToGuidStructureString(Info.Guid))\r
\r
    if Info.IsLibrary:\r
        return\r
    # C file header\r
    AutoGenC.Append(gAutoGenHeaderString.Replace({'FileName':'AutoGen.c'}))\r
    if Info.AutoGenVersion >= 0x00010005:\r
        # C file header files includes\r
        if Info.ModuleType in gModuleTypeHeaderFile:\r
            for Inc in gModuleTypeHeaderFile[Info.ModuleType]:\r
                AutoGenC.Append("#include <%s>\n" % Inc)\r
        else:\r
            AutoGenC.Append("#include <%s>\n" % gBasicHeaderFile)\r
\r
        #\r
        # Publish the CallerId Guid\r
        #\r
        AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED GUID gEfiCallerIdGuid = %s;\n' % GuidStringToGuidStructureString(Info.Guid))\r
        AutoGenC.Append('\nGLOBAL_REMOVE_IF_UNREFERENCED CHAR8 *gEfiCallerBaseName = "%s";\n' % Info.Name)\r
\r
## Create common code for header file\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#\r
def CreateFooterCode(Info, AutoGenC, AutoGenH):\r
    AutoGenH.Append(gAutoGenHEpilogueString)\r
\r
## Create code for a module\r
#\r
#   @param      Info        The ModuleAutoGen object\r
#   @param      AutoGenC    The TemplateString object for C code\r
#   @param      AutoGenH    The TemplateString object for header file\r
#   @param      StringH     The TemplateString object for header file\r
#   @param      UniGenCFlag     UniString is generated into AutoGen C file when it is set to True\r
#   @param      UniGenBinBuffer Buffer to store uni string package data\r
#   @param      StringIdf       The TemplateString object for header file\r
#   @param      IdfGenCFlag     IdfString is generated into AutoGen C file when it is set to True\r
#   @param      IdfGenBinBuffer Buffer to store Idf string package data\r
#\r
def CreateCode(Info, AutoGenC, AutoGenH, StringH, UniGenCFlag, UniGenBinBuffer, StringIdf, IdfGenCFlag, IdfGenBinBuffer):\r
    CreateHeaderCode(Info, AutoGenC, AutoGenH)\r
\r
    if Info.AutoGenVersion >= 0x00010005:\r
        CreateGuidDefinitionCode(Info, AutoGenC, AutoGenH)\r
        CreateProtocolDefinitionCode(Info, AutoGenC, AutoGenH)\r
        CreatePpiDefinitionCode(Info, AutoGenC, AutoGenH)\r
        CreatePcdCode(Info, AutoGenC, AutoGenH)\r
        CreateLibraryConstructorCode(Info, AutoGenC, AutoGenH)\r
        CreateLibraryDestructorCode(Info, AutoGenC, AutoGenH)\r
        CreateModuleEntryPointCode(Info, AutoGenC, AutoGenH)\r
        CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH)\r
\r
    if Info.UnicodeFileList:\r
        FileName = "%sStrDefs.h" % Info.Name\r
        StringH.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
        StringH.Append(gAutoGenHPrologueString.Replace({'File':'STRDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
        CreateUnicodeStringCode(Info, AutoGenC, StringH, UniGenCFlag, UniGenBinBuffer)\r
\r
        GuidMacros = []\r
        for Guid in Info.Module.Guids:\r
            if Guid in Info.Module.GetGuidsUsedByPcd():\r
                continue\r
            GuidMacros.append('#define %s %s' % (Guid, Info.Module.Guids[Guid]))\r
        for Guid, Value in Info.Module.Protocols.items() + Info.Module.Ppis.items():\r
            GuidMacros.append('#define %s %s' % (Guid, Value))\r
        # supports FixedAtBuild usage in VFR file\r
        if Info.VfrFileList and Info.ModulePcdList:\r
            GuidMacros.append('#define %s %s' % ('FixedPcdGetBool(TokenName)', '_PCD_VALUE_##TokenName'))\r
            GuidMacros.append('#define %s %s' % ('FixedPcdGet8(TokenName)', '_PCD_VALUE_##TokenName'))\r
            GuidMacros.append('#define %s %s' % ('FixedPcdGet16(TokenName)', '_PCD_VALUE_##TokenName'))\r
            GuidMacros.append('#define %s %s' % ('FixedPcdGet32(TokenName)', '_PCD_VALUE_##TokenName'))\r
            GuidMacros.append('#define %s %s' % ('FixedPcdGet64(TokenName)', '_PCD_VALUE_##TokenName'))\r
            for Pcd in Info.ModulePcdList:\r
                if Pcd.Type == TAB_PCDS_FIXED_AT_BUILD:\r
                    TokenCName = Pcd.TokenCName\r
                    Value = Pcd.DefaultValue\r
                    if Pcd.DatumType == 'BOOLEAN':\r
                        BoolValue = Value.upper()\r
                        if BoolValue == 'TRUE':\r
                            Value = '1'\r
                        elif BoolValue == 'FALSE':\r
                            Value = '0'\r
                    for PcdItem in GlobalData.MixedPcd:\r
                        if (Pcd.TokenCName, Pcd.TokenSpaceGuidCName) in GlobalData.MixedPcd[PcdItem]:\r
                            TokenCName = PcdItem[0]\r
                            break\r
                    GuidMacros.append('#define %s %s' % ('_PCD_VALUE_'+TokenCName, Value))\r
\r
        if Info.IdfFileList:\r
            GuidMacros.append('#include "%sImgDefs.h"' % Info.Name)\r
\r
        if GuidMacros:\r
            StringH.Append('\n#ifdef VFRCOMPILE\n%s\n#endif\n' % '\n'.join(GuidMacros))\r
\r
        StringH.Append("\n#endif\n")\r
        AutoGenH.Append('#include "%s"\n' % FileName)\r
\r
    if Info.IdfFileList:\r
        FileName = "%sImgDefs.h" % Info.Name\r
        StringIdf.Append(gAutoGenHeaderString.Replace({'FileName':FileName}))\r
        StringIdf.Append(gAutoGenHPrologueString.Replace({'File':'IMAGEDEFS', 'Guid':Info.Guid.replace('-','_')}))\r
        CreateIdfFileCode(Info, AutoGenC, StringIdf, IdfGenCFlag, IdfGenBinBuffer)\r
\r
        StringIdf.Append("\n#endif\n")\r
        AutoGenH.Append('#include "%s"\n' % FileName)\r
\r
    CreateFooterCode(Info, AutoGenC, AutoGenH)\r
\r
    # no generation of AutoGen.c for Edk modules without unicode file\r
    if Info.AutoGenVersion < 0x00010005 and len(Info.UnicodeFileList) == 0:\r
        AutoGenC.String = ''\r
\r
## Create the code file\r
#\r
#   @param      FilePath     The path of code file\r
#   @param      Content      The content of code file\r
#   @param      IsBinaryFile The flag indicating if the file is binary file or not\r
#\r
#   @retval     True        If file content is changed or file doesn't exist\r
#   @retval     False       If the file exists and the content is not changed\r
#\r
def Generate(FilePath, Content, IsBinaryFile):\r
    return SaveFileOnChange(FilePath, Content, IsBinaryFile)\r
\r