# Routines for generating AutoGen.h and AutoGen.c\r
#\r
# Copyright (c) 2007 - 2018, 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
+# SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
\r
## Import Modules\r
#\r
+from __future__ import absolute_import\r
import string\r
import collections\r
import struct\r
from Common import EdkLogger\r
-\r
+from Common import GlobalData\r
from Common.BuildToolError import *\r
from Common.DataType import *\r
from Common.Misc import *\r
gLibraryStructorCall = {\r
SUP_MODULE_BASE : TemplateString("""${BEGIN}\r
Status = ${Function} ();\r
- ASSERT_EFI_ERROR (Status);${END}\r
+ ASSERT_RETURN_ERROR (Status);${END}\r
"""),\r
\r
'PEI' : TemplateString("""${BEGIN}\r
VOID\r
)\r
{\r
-${BEGIN} EFI_STATUS Status;\r
+${BEGIN} RETURN_STATUS Status;\r
${FunctionCall}${END}\r
}\r
"""),\r
gBasicHeaderFile = "Base.h"\r
\r
gModuleTypeHeaderFile = {\r
- SUP_MODULE_BASE : [gBasicHeaderFile],\r
+ SUP_MODULE_BASE : [gBasicHeaderFile, "Library/DebugLib.h"],\r
SUP_MODULE_SEC : ["PiPei.h", "Library/DebugLib.h"],\r
SUP_MODULE_PEI_CORE : ["PiPei.h", "Library/DebugLib.h", "Library/PeiCoreEntryPoint.h"],\r
SUP_MODULE_PEIM : ["PiPei.h", "Library/DebugLib.h", "Library/PeimEntryPoint.h"],\r
SUP_MODULE_SMM_CORE : ["PiDxe.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/UefiDriverEntryPoint.h"],\r
SUP_MODULE_MM_STANDALONE : ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmDriverEntryPoint.h"],\r
SUP_MODULE_MM_CORE_STANDALONE : ["PiMm.h", "Library/BaseLib.h", "Library/DebugLib.h", "Library/StandaloneMmCoreEntryPoint.h"],\r
- SUP_MODULE_USER_DEFINED : [gBasicHeaderFile]\r
+ SUP_MODULE_USER_DEFINED : [gBasicHeaderFile, "Library/DebugLib.h"]\r
}\r
\r
## Autogen internal worker macro to define DynamicEx PCD name includes both the TokenSpaceGuidName\r
try:\r
if Value.upper().endswith('L'):\r
Value = Value[:-1]\r
+ if Value.startswith('0') and not Value.lower().startswith('0x') and len(Value) > 1 and Value.lstrip('0'):\r
+ Value = Value.lstrip('0')\r
ValueNumber = int (Value, 0)\r
except:\r
EdkLogger.error("build", AUTOGEN_ERROR,\r
else:\r
NewValue = NewValue + str(ord(Value[Index]) % 0x100) + ', '\r
if Unicode:\r
- ArraySize = ArraySize / 2\r
+ ArraySize = ArraySize // 2\r
Value = NewValue + '0 }'\r
if ArraySize < ValueSize:\r
if Pcd.MaxSizeUserSet:\r
else:\r
ArraySize = Pcd.GetPcdSize()\r
if Unicode:\r
- ArraySize = ArraySize / 2\r
+ ArraySize = ArraySize // 2\r
Array = '[%d]' % ArraySize\r
#\r
# skip casting for fixed at build since it breaks ARM assembly.\r
if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
ConstructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r
ConstructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r
- elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
- ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
- elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r
- SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
- ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
- elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r
- ConstructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r
- ConstructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r
+ if Info.ModuleType not in [SUP_MODULE_BASE, SUP_MODULE_USER_DEFINED]:\r
+ if Lib.ModuleType in SUP_MODULE_SET_PEI:\r
+ ConstructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
+ ConstructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
+ elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r
+ SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r
+ ConstructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
+ ConstructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
+ elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_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
if Info.IsLibrary:\r
AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
else:\r
- if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
+ if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_USER_DEFINED]:\r
AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r
elif Info.ModuleType in SUP_MODULE_SET_PEI:\r
AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
if Lib.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
DestructorPrototypeString.Append(gLibraryStructorPrototype[SUP_MODULE_BASE].Replace(Dict))\r
DestructorCallingString.Append(gLibraryStructorCall[SUP_MODULE_BASE].Replace(Dict))\r
- elif Lib.ModuleType in SUP_MODULE_SET_PEI:\r
- DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
- DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
- elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r
- SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r
- DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
- DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
- elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_MM_CORE_STANDALONE]:\r
- DestructorPrototypeString.Append(gLibraryStructorPrototype['MM'].Replace(Dict))\r
- DestructorCallingString.Append(gLibraryStructorCall['MM'].Replace(Dict))\r
+ if Info.ModuleType not in [SUP_MODULE_BASE, SUP_MODULE_USER_DEFINED]:\r
+ if Lib.ModuleType in SUP_MODULE_SET_PEI:\r
+ DestructorPrototypeString.Append(gLibraryStructorPrototype['PEI'].Replace(Dict))\r
+ DestructorCallingString.Append(gLibraryStructorCall['PEI'].Replace(Dict))\r
+ elif Lib.ModuleType in [SUP_MODULE_DXE_CORE, SUP_MODULE_DXE_DRIVER, SUP_MODULE_DXE_SMM_DRIVER, SUP_MODULE_DXE_RUNTIME_DRIVER,\r
+ SUP_MODULE_DXE_SAL_DRIVER, SUP_MODULE_UEFI_DRIVER, SUP_MODULE_UEFI_APPLICATION, SUP_MODULE_SMM_CORE]:\r
+ DestructorPrototypeString.Append(gLibraryStructorPrototype['DXE'].Replace(Dict))\r
+ DestructorCallingString.Append(gLibraryStructorCall['DXE'].Replace(Dict))\r
+ elif Lib.ModuleType in [SUP_MODULE_MM_STANDALONE, SUP_MODULE_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
if Info.IsLibrary:\r
AutoGenH.Append("${BEGIN}${FunctionPrototype}${END}", Dict)\r
else:\r
- if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
+ if Info.ModuleType in [SUP_MODULE_BASE, SUP_MODULE_SEC, SUP_MODULE_USER_DEFINED]:\r
AutoGenC.Append(gLibraryString[SUP_MODULE_BASE].Replace(Dict))\r
elif Info.ModuleType in SUP_MODULE_SET_PEI:\r
AutoGenC.Append(gLibraryString['PEI'].Replace(Dict))\r
# @param AutoGenH The TemplateString object for header file\r
#\r
def CreateModuleUnloadImageCode(Info, AutoGenC, AutoGenH):\r
- if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_SEC]:\r
+ if Info.IsLibrary or Info.ModuleType in [SUP_MODULE_USER_DEFINED, SUP_MODULE_BASE, SUP_MODULE_SEC]:\r
return\r
#\r
# Unload Image Handlers\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
TempBuffer += Buffer\r
elif File.Ext.upper() == '.JPG':\r
ImageType, = struct.unpack('4s', Buffer[6:10])\r
- if ImageType != 'JFIF':\r
+ if ImageType != b'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
\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
+ if ImageType!= b'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
else:\r
ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_1BIT)\r
ImageBuffer += pack('B', PaletteIndex)\r
- Width = (BmpHeader.biWidth + 7)/8\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
else:\r
ImageBuffer = pack('B', EFI_HII_IIBT_IMAGE_4BIT)\r
ImageBuffer += pack('B', PaletteIndex)\r
- Width = (BmpHeader.biWidth + 1)/2\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
for Index in range(0, len(PaletteBuffer)):\r
if Index % 4 == 3:\r
continue\r
- PaletteTemp += PaletteBuffer[Index]\r
+ PaletteTemp += PaletteBuffer[Index:Index+1]\r
PaletteBuffer = PaletteTemp[1:]\r
return ImageBuffer, PaletteBuffer\r
\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
- if Info.ModuleType in gModuleTypeHeaderFile:\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
+ # header files includes\r
+ if Info.ModuleType in gModuleTypeHeaderFile:\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
- if Info.IsLibrary:\r
- return\r
+ AutoGenH.Append('\nextern GUID gEfiCallerIdGuid;')\r
+ AutoGenH.Append('\nextern CHAR8 *gEfiCallerBaseName;\n\n')\r
\r
- AutoGenH.Append("#define EFI_CALLER_ID_GUID \\\n %s\n" % GuidStringToGuidStructureString(Info.Guid))\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
+ # 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
+ # 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
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
+ 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
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
+ for Guid, Value in list(Info.Module.Protocols.items()) + list(Info.Module.Ppis.items()):\r
GuidMacros.append('#define %s %s' % (Guid, Value))\r
# supports FixedAtBuild and FeaturePcd usage in VFR file\r
if Info.VfrFileList and Info.ModulePcdList:\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