MdeModulePkg: Fix build warning on Xhci driver with XCode 32 tool chain.

[mirror_edk2.git] / BaseTools / Source / Python / MigrationMsa2Inf / AutoGenExterns.py

#!/usr/bin/env python\r
#\r
#\r
# Copyright (c) 2007, 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
#\r
# Import Modules\r
#\r
import re, os, glob\r
from Common.XmlRoutines import  *\r
\r
#"ModuleType"=>(PackageGuid, headerFileName) List\r
HeaderFiles = {}\r
GuidList = []\r
GuidMap = {}\r
HeaderFileContents = {}\r
gTest = {}\r
GuidMacro2CName = {}\r
GuidAliasList = []\r
\r
def collectIncludeFolder(pkgDirName, guidType, pkgName):\r
    includeFolder = os.path.join(pkgDirName, "Include", guidType)\r
    if os.path.exists(includeFolder) and os.path.isdir(includeFolder):\r
        for headerFileName in os.listdir(includeFolder):\r
            if headerFileName[-2:] == ".h":\r
                headerFile = open(os.path.join(includeFolder, headerFileName))\r
                HeaderFileContents[(guidType, headerFileName, pkgName)] = headerFile.read()\r
                headerFile.close()\r
\r
GuidMacroReg = re.compile(r"\b(?!EFI_GUID\b)[A-Z0-9_]+_GUID\b")\r
GuidCNameReg = re.compile(r"\bg\w+Guid\b")\r
GuidAliasReg = re.compile(r"#define\s+([A-Z0-9_]+_GUID)\s+([A-Z0-9_]+_GUID)\b")\r
\r
def collectPackageInfo(spdFileName):\r
    pkgDirName = os.path.dirname(spdFileName)\r
\r
    spd = XmlParseFile(spdFileName)\r
\r
    pkgName = XmlElement(spd, "/PackageSurfaceArea/SpdHeader/PackageName")\r
    pkgGuid = XmlElement(spd, "/PackageSurfaceArea/SpdHeader/GuidValue")\r
\r
    \r
    for IncludePkgHeader in XmlList(spd, "/PackageSurfaceArea/PackageHeaders/IncludePkgHeader"):\r
        moduleType = XmlAttribute(IncludePkgHeader, "ModuleType")\r
        headerFilePath = XmlElementData(IncludePkgHeader)\r
        headerFilePath = re.sub("Include/", "", headerFilePath, 1)\r
\r
        headerTuple = HeaderFiles.get(moduleType, [])\r
        headerTuple.append((pkgGuid, headerFilePath))\r
        HeaderFiles[moduleType] = headerTuple\r
        \r
    guidTypes = ["Guid", "Protocol", "Ppi"]\r
\r
    for guidType in guidTypes:\r
        for guidEntry in XmlList(spd, "/PackageSurfaceArea/" + guidType + "Declarations/Entry"):\r
            guidCName = XmlElement(guidEntry, "Entry/C_Name")\r
            GuidList.append(guidCName)\r
                      \r
        collectIncludeFolder(pkgDirName, guidType, pkgName)   \r
\r
    for DecFile in glob.glob(os.path.join(pkgDirName, "*.dec")):\r
        fileContents = open(DecFile).read()\r
        for GuidCNameMatch in GuidCNameReg.finditer(fileContents):\r
            GuidCName = GuidCNameMatch.group(0)\r
            if GuidCName not in GuidList:\r
                GuidList.append(GuidCName)\r
\r
def AddGuidMacro2GuidCName(GuidMacros, GuidCNames):\r
   for GuidMacro in GuidMacros:\r
       GuessGuidCName = "g" + GuidMacro.lower().title().replace("_", "")\r
       if GuessGuidCName in GuidCNames:\r
           GuidMacro2CName[GuidMacro] = GuessGuidCName\r
       elif len(GuidCNames) == 1:\r
           GuidMacro2CName[GuidMacro] = GuidCNames[0]\r
       else:\r
           for GuidCName in GuidCNames:\r
               if GuidCName.lower() == GuessGuidCName.lower():\r
                   GuidMacro2CName[GuidMacro] = GuidCName\r
                   break\r
           else:\r
               pass\r
               #print "No matching GuidMacro %s" % GuidMacro\r
               \r
\r
def TranslateGuid(GuidMacroMatch):\r
    GuidMacro = GuidMacroMatch.group(0)\r
    return GuidMacro2CName.get(GuidMacro, GuidMacro)\r
\r
DepexReg = re.compile(r"DEPENDENCY_START(.*?)DEPENDENCY_END", re.DOTALL)\r
\r
def TranslateDpxSection(fileContents):\r
    DepexMatch = DepexReg.search(fileContents)\r
    if not DepexMatch:\r
        return "", []\r
    \r
    fileContents = DepexMatch.group(1)\r
    fileContents = re.sub(r"\s+", " ", fileContents).strip()\r
    fileContents = GuidMacroReg.sub(TranslateGuid, fileContents)\r
    return fileContents, GuidMacroReg.findall(fileContents)\r
\r
def InitializeAutoGen(workspace, db):\r
    \r
    \r
    for spdFile in XmlList(db, "/FrameworkDatabase/PackageList/Filename"):\r
        spdFileName = XmlElementData(spdFile)\r
        collectPackageInfo(os.path.join(workspace, spdFileName))\r
\r
\r
    BlockCommentReg = re.compile(r"/\*.*?\*/", re.DOTALL)\r
    LineCommentReg = re.compile(r"//.*")\r
    GuidReg = re.compile(r"\b(" + '|'.join(GuidList) + r")\b")\r
\r
    for headerFile in HeaderFileContents:\r
        Contents = HeaderFileContents[headerFile]\r
        Contents = BlockCommentReg.sub("", Contents)\r
        Contents = LineCommentReg.sub("", Contents)\r
        \r
        FoundGuids = GuidReg.findall(Contents)\r
        for FoundGuid in FoundGuids:\r
            GuidMap[FoundGuid] = "%s/%s" % (headerFile[0], headerFile[1])\r
            #print "%-40s %s/%s" % (FoundGuid, headerFile[0], headerFile[1])\r
\r
        GuidMacros = GuidMacroReg.findall(Contents)\r
        GuidCNames = GuidCNameReg.findall(Contents)\r
        \r
        for GuidAliasMatch in  GuidAliasReg.finditer(Contents):\r
            Name1, Name2 = GuidAliasMatch.group(1), GuidAliasMatch.group(2)\r
            GuidAliasList.append((Name1, Name2))\r
\r
        AddGuidMacro2GuidCName(GuidMacros, GuidCNames)\r
\r
def AddSystemIncludeStatement(moduleType, PackageList):\r
    IncludeStatement = "\n"\r
\r
    headerList = HeaderFiles.get(moduleType, [])\r
\r
    for pkgGuid in PackageList:\r
        \r
        for pkgTuple in headerList:\r
            if pkgTuple[0] == pkgGuid:\r
                IncludeStatement += "#include <%s>\n" % pkgTuple[1]\r
\r
    return IncludeStatement\r
        \r
    \r
def AddLibraryClassStatement(LibraryClassList):\r
    IncludeStatement = "\n"\r
    for LibraryClass in LibraryClassList:\r
        IncludeStatement += "#include <Library/%s.h>\n" % LibraryClass\r
\r
    return IncludeStatement\r
\r
def AddGuidStatement(GuidList):\r
    IncludeStatement = "\n"\r
    GuidIncludeSet = {}\r
    for Guid in GuidList:\r
        if Guid in GuidMap:\r
            GuidIncludeSet[GuidMap[Guid]] = 1\r
        else:\r
            print "GUID CName: %s cannot be found in any public header file" % Guid\r
\r
    for GuidInclude in GuidIncludeSet:\r
        IncludeStatement += "#include <%s>\n" % GuidInclude\r
\r
    return IncludeStatement\r
\r
DriverBindingMap = {\r
    "gEfiDriverBindingProtocolGuid" : "EFI_DRIVER_BINDING_PROTOCOL",\r
    "gEfiComponentNameProtocolGuid" : "EFI_COMPONENT_NAME_PROTOCOL",\r
    "gEfiDriverConfigurationProtocolGuid" : "EFI_DRIVER_CONFIGURATION_PROTOCOL",\r
    "gEfiDriverDiagnosticProtocolGuid" : "EFI_DRIVER_CONFIGURATION_PROTOCOL"\r
    }\r
\r
def AddDriverBindingProtocolStatement(AutoGenDriverModel):\r
    InstallStatement   = "\n"\r
    DBindingHandle     = "ImageHandle"\r
    GlobalDeclaration  = "\n"\r
    \r
    \r
    for DriverModelItem in AutoGenDriverModel:\r
        \r
        if DriverModelItem[1] == "NULL" and DriverModelItem[2] == "NULL" and DriverModelItem[3] == "NULL":\r
            InstallStatement += "  Status = EfiLibInstallDriverBinding (\n"\r
            InstallStatement += "             ImageHandle,\n"\r
            InstallStatement += "             SystemTable,\n"\r
            InstallStatement += "             %s,\n" % DriverModelItem[0]\r
            InstallStatement += "             %s\n" % DBindingHandle\r
            InstallStatement += "             );\n"\r
        else:\r
            InstallStatement += "  Status = EfiLibInstallAllDriverProtocols (\n"\r
            InstallStatement += "             ImageHandle,\n"\r
            InstallStatement += "             SystemTable,\n"\r
            InstallStatement += "             %s,\n" % DriverModelItem[0]\r
            InstallStatement += "             %s,\n" % DBindingHandle\r
            InstallStatement += "             %s,\n" % DriverModelItem[1]\r
            InstallStatement += "             %s,\n" % DriverModelItem[2]\r
            InstallStatement += "             %s\n" % DriverModelItem[3]\r
            InstallStatement += "             );\n"\r
\r
        InstallStatement += "  ASSERT_EFI_ERROR (Status);\n\n"\r
            \r
        GlobalDeclaration += "extern EFI_DRIVER_BINDING_PROTOCOL %s;\n" % DriverModelItem[0][1:]\r
        if (DriverModelItem[1] != "NULL"):\r
            GlobalDeclaration += "extern EFI_COMPONENT_NAME_PROTOCOL %s;\n" % DriverModelItem[1][1:]\r
        if (DriverModelItem[2] != "NULL"):\r
            GlobalDeclaration += "extern EFI_DRIVER_CONFIGURATION_PROTOCOL %s;\n" % DriverModelItem[2][1:]\r
        if (DriverModelItem[3] != "NULL"):\r
            GlobalDeclaration += "extern EFI_DRIVER_CONFIGURATION_PROTOCOL %s;\n" % DriverModelItem[3][1:]\r
\r
        DBindingHandle = "NULL"\r
         \r
    return (InstallStatement, "", "", GlobalDeclaration)\r
\r
EventDeclarationTemplate = """\r
//\r
// Declaration for callback Event.\r
//\r
VOID\r
EFIAPI\r
%s (\r
  IN EFI_EVENT  Event,\r
  IN VOID       *Context\r
  );\r
"""\r
\r
def AddBootServiceEventStatement(EventList):\r
    FinalEvent = ""\r
    if len(EventList) > 1:\r
        \r
        print "Current prototype does not support multi boot service event"\r
    else:\r
        FinalEvent       = EventList[0]\r
    \r
    CreateStatement  = "\n"\r
    CreateStatement += "  Status = gBS->CreateEvent (\n"\r
    CreateStatement += "                  EVT_SIGNAL_EXIT_BOOT_SERVICES,\n"\r
    CreateStatement += "                  EFI_TPL_NOTIFY,\n"\r
    CreateStatement += "                  " + FinalEvent + ",\n"\r
    CreateStatement += "                  NULL,\n"\r
    CreateStatement += "                  &mExitBootServicesEvent\n"\r
    CreateStatement += "                  );\n"\r
    CreateStatement += "  ASSERT_EFI_ERROR (Status);\n"\r
\r
    GlobalDefinition  = "\n"\r
    GlobalDefinition += "STATIC EFI_EVENT mExitBootServicesEvent = NULL;\n"\r
\r
    GlobalDeclaration = EventDeclarationTemplate % FinalEvent\r
    \r
    DestroyStatement  = "\n"\r
    DestroyStatement += "  Status = gBS->CloseEvent (mExitBootServicesEvent);\n"\r
    DestroyStatement += "  ASSERT_EFI_ERROR (Status);\n"\r
    return (CreateStatement, "", GlobalDefinition, GlobalDeclaration)\r
\r
def AddVirtualAddressEventStatement(EventList):\r
    FinalEvent = ""\r
    if len(EventList) > 1:\r
        print "Current prototype does not support multi virtual address change event"\r
    else:\r
        FinalEvent       = EventList[0]\r
    \r
    CreateStatement  = "\n"\r
\r
    CreateStatement += "  Status = gBS->CreateEvent (\n"\r
    CreateStatement += "                  EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE,\n"\r
    CreateStatement += "                  TPL_NOTIFY,\n"\r
    CreateStatement += "                  " + FinalEvent + ",\n"\r
    CreateStatement += "                  NULL,\n"\r
    CreateStatement += "                  &mVirtualAddressChangedEvent\n"\r
    CreateStatement += "                  );\n"\r
    CreateStatement += "  ASSERT_EFI_ERROR (Status);\n"\r
\r
    GlobalDefinition  = "\n"\r
    GlobalDefinition += "STATIC EFI_EVENT mVirtualAddressChangedEvent = NULL;\n"\r
    \r
    GlobalDeclaration = EventDeclarationTemplate % FinalEvent\r
\r
    DestroyStatement  = "\n"\r
    DestroyStatement += "  Status = gBS->CloseEvent (mVirtualAddressChangedEvent);\n"\r
    DestroyStatement += "  ASSERT_EFI_ERROR (Status);\n"\r
    \r
    return (CreateStatement, "", GlobalDefinition, GlobalDeclaration)\r
    \r
\r
EntryPointDeclarationTemplate = """\r
//\r
// Declaration for original Entry Point. \r
//\r
EFI_STATUS\r
EFIAPI\r
%s (\r
  IN EFI_HANDLE           ImageHandle,\r
  IN EFI_SYSTEM_TABLE     *SystemTable\r
  );\r
"""\r
    \r
EntryPointHeader = r"""\r
/**\r
  The user Entry Point for module %s. The user code starts with this function.\r
\r
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.  \r
  @param[in] SystemTable    A pointer to the EFI System Table.\r
  \r
  @retval EFI_SUCCESS       The entry point is executed successfully.\r
  @retval other             Some error occurs when executing this entry point.\r
\r
**/\r
"""\r
def AddNewEntryPointContentsStatement (moduleName, EntryPoint, InstallStatement = ""):\r
    if EntryPoint != "Initialize%s" % moduleName:\r
        NewEntryPoint = "Initialize%s" % moduleName\r
    else:\r
        NewEntryPoint = "NewInitialize%s" % moduleName\r
\r
    EntryPointContents  = EntryPointHeader % moduleName\r
    EntryPointContents += "EFI_STATUS\n"\r
    EntryPointContents += "EFIAPI\n"\r
    EntryPointContents += NewEntryPoint + "(\n"\r
    EntryPointContents += "  IN EFI_HANDLE           ImageHandle,\n"\r
    EntryPointContents += "  IN EFI_SYSTEM_TABLE     *SystemTable\n"\r
    EntryPointContents += "  )\n"\r
    EntryPointContents += "{\n"\r
    EntryPointContents += "  EFI_STATUS              Status;\n"\r
    EntryPointContents += InstallStatement + "\n"\r
    GlobalDeclaration   = ""\r
\r
    if EntryPoint != "":\r
        EntryPointContents += "  //\n  // Call the original Entry Point\n  //\n"\r
        EntryPointContents += "  Status = %s (ImageHandle, SystemTable);\n\n" % EntryPoint\r
        GlobalDeclaration  += EntryPointDeclarationTemplate % EntryPoint\r
\r
    EntryPointContents += "  return Status;\n"\r
    EntryPointContents += "}\n"\r
\r
    return (NewEntryPoint, EntryPointContents, GlobalDeclaration)\r
\r
reFileHeader = re.compile(r"^\s*/\*.*?\*/\s*", re.DOTALL)\r
reNext       = re.compile(r"#ifndef\s*(\w+)\s*#define\s*\1\s*")\r
\r
def AddCommonInclusionStatement(fileContents, includeStatement):\r
    if includeStatement in fileContents:\r
        return fileContents\r
\r
    insertPos       = 0\r
    matchFileHeader = reFileHeader.search(fileContents)\r
    if matchFileHeader:\r
        insertPos = matchFileHeader.end()\r
\r
    matchFileHeader = reNext.search(fileContents, insertPos)\r
    if matchFileHeader:\r
        insertPos = matchFileHeader.end()\r
                          \r
    includeStatement = "\n%s\n\n" % includeStatement \r
    fileContents = fileContents[0:insertPos] + includeStatement + fileContents[insertPos:] \r
    return fileContents \r
\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# script.\r
if __name__ == '__main__':\r
\r
    pass\r
    \r