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

[mirror_edk2.git] / BaseTools / Source / Python / spd2dec / StoreDec.py

## @file\r
# Store a Package class object to a DEC file.\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 os\r
from Common.MigrationUtilities import *\r
from LoadSpd import LoadSpd\r
from CommonDataClass.PackageClass import *\r
\r
\r
## Store Defines section.\r
#\r
# Write [Defines] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Defines section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackageDefinesSection(DecFile, Package):\r
    DefinesTupleList = []\r
    DefinesTupleList.append(("DEC_VERSION", Package.Header.DecSpecification))\r
    DefinesTupleList.append(("PACKAGE_NAME", Package.Header.Name))\r
    DefinesTupleList.append(("PACKAGE_GUID", Package.Header.Guid))\r
    \r
    StoreDefinesSection(DecFile, DefinesTupleList)\r
\r
\r
## Return a Package Include Class Item.\r
#\r
# Read the input Include class object and return one Include Class Item.\r
#\r
# @param  Include            An input Include class object.\r
#\r
# @retval IncludeClassItem   A Package Include Class Item.\r
#\r
def GetPackageIncludeClassItem(Include):\r
    return Include.FilePath\r
\r
\r
## Store Includes section.\r
#\r
# Write [Includes] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Includes section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackageIncludesSection(DecFile, Package):\r
    Includes = Package.Includes\r
    Section = GetSection("Includes", GetPackageIncludeClassItem, Includes)\r
    StoreTextFile(DecFile, Section)\r
    \r
\r
## Return a Package Library Class Item.\r
#\r
# Read the input LibraryClass class object and return one Library Class Item.\r
#\r
# @param  LibraryClass       An input LibraryClass class object.\r
#\r
# @retval LibraryClassItem   A Package Library Class Item.\r
#\r
def GetPackageLibraryClassItem(LibraryClass):\r
    return "|".join((LibraryClass.LibraryClass, LibraryClass.IncludeHeader))\r
\r
\r
## Store Library Classes section.\r
#\r
# Write [LibraryClasses] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Library Classes\r
#                            section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackageLibraryClassesSection(DecFile, Package):\r
    LibraryClasses = Package.LibraryClassDeclarations\r
    Section = GetSection("LibraryClasses", GetPackageLibraryClassItem, LibraryClasses)\r
    StoreTextFile(DecFile, Section)\r
\r
\r
## Return a Package Guid Declaration Item.\r
#\r
# Read the input Guid class object and return one line of Guid Declaration Item.\r
#\r
# @param  Guid                An input Guid class object.\r
#\r
# @retval GuidDeclarationItem A Package Guid Declaration Item.\r
#\r
def GetPackageGuidDeclarationItem(Guid):\r
    GuidCName = Guid.CName\r
    GuidValue = Guid.Guid.replace("-", "")\r
    GuidValueList = [GuidValue[0:8]]\r
    GuidValueList += [GuidValue[i : i + 4] for i in range(8, 16, 4)]\r
    GuidValueList += [GuidValue[i : i + 2] for i in range(16, 32, 2)]\r
\r
    GuidCFormat = "{0x%s" + ", 0x%s" * 2 + ", {0x%s" + ", 0x%s" * 7 + "}}"\r
    GuidCValue = GuidCFormat % tuple(GuidValueList)\r
    return "%-30s = %s" % (GuidCName, GuidCValue)\r
\r
\r
## Store Protocols section.\r
#\r
# Write [Protocols] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Protocols section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackageProtocolsSection(DecFile, Package):\r
    Protocols = Package.ProtocolDeclarations\r
    Section = GetSection("Protocols", GetPackageGuidDeclarationItem, Protocols)\r
    StoreTextFile(DecFile, Section)\r
    \r
\r
## Store Ppis section.\r
#\r
# Write [Ppis] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Ppis section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackagePpisSection(DecFile, Package):\r
    Ppis = Package.PpiDeclarations\r
    Section = GetSection("Ppis", GetPackageGuidDeclarationItem, Ppis)\r
    StoreTextFile(DecFile, Section)\r
\r
\r
## Store Guids section.\r
#\r
# Write [Guids] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile            The output DEC file to store the Guids section.\r
# @param  Package            An input Package class object.\r
#\r
def StorePackageGuidsSection(DecFile, Package):\r
    Guids = Package.GuidDeclarations\r
    Section = GetSection("Guids", GetPackageGuidDeclarationItem, Guids)\r
    StoreTextFile(DecFile, Section)\r
\r
\r
## Return a Package Pcd Item.\r
#\r
# Read the input Pcd class object and return one line of Pcd Item.\r
#\r
# @param  Pcd                An input Pcd class object.\r
#\r
# @retval PcdItem            A Package Pcd Item.\r
#\r
def GetPackagePcdItem(Pcd):\r
    PcdPair = "%s.%s" % (Pcd.TokenSpaceGuidCName, Pcd.CName)\r
    DatumType = Pcd.DatumType\r
    DefaultValue = Pcd.DefaultValue\r
    Token = Pcd.Token\r
    PcdList = [PcdPair, DefaultValue, DatumType, Token]\r
    return "|".join(PcdList)\r
\r
\r
## DEC Pcd Section Name dictionary indexed by PCD Item Type.\r
mDecPcdSectionNameDict = {\r
    "FEATURE_FLAG" : "PcdsFeatureFlag",\r
    "FIXED_AT_BUILD" : "PcdsFixedAtBuild",\r
    "PATCHABLE_IN_MODULE" : "PcdsPatchableInModule",\r
    "DYNAMIC" : "PcdsDynamic",\r
    "DYNAMIC_EX" : "PcdsDynamicEx"\r
    }\r
\r
## Store Pcds section.\r
#\r
# Write [Pcds*] section to the DecFile based on Package class object.\r
# Different CPU architectures are specified in the subsection if possible.\r
#\r
# @param  DecFile              The output DEC file to store the Pcds section.\r
# @param  Package              An input Package class object.\r
#\r
def StorePackagePcdsSection(DecFile, Package):\r
    PcdsDict = {}\r
    for Pcd in Package.PcdDeclarations:\r
        for PcdItemType in Pcd.ValidUsage:\r
            PcdSectionName = mDecPcdSectionNameDict.get(PcdItemType)\r
            if PcdSectionName:\r
                PcdsDict.setdefault(PcdSectionName, []).append(Pcd)\r
            else:\r
                EdkLogger.info("Unknown Pcd Item Type: %s" % PcdItemType)\r
\r
    Section = ""\r
    for PcdSectionName in PcdsDict:\r
        Pcds = PcdsDict[PcdSectionName]\r
        Section += GetSection(PcdSectionName, GetPackagePcdItem, Pcds)\r
\r
    StoreTextFile(DecFile, Section)\r
\r
\r
## Store User Extensions section.\r
#\r
# Write [UserExtensions] section to the DecFile based on Package class object.\r
#\r
# @param  DecFile              The output DEC file to store the User Extensions section.\r
# @param  Package              An input Package class object.\r
#\r
def StorePackageUserExtensionsSection(DecFile, Package):\r
    Section = "".join(map(GetUserExtensions, Package.UserExtensions))\r
    StoreTextFile(DecFile, Section)\r
\r
\r
## Store a Package class object to a new DEC file.\r
#\r
# Read an input Package class object and ave the contents to a new DEC file.\r
#\r
# @param  DecFileName          The output DEC file.\r
# @param  Package              An input Package class object.\r
#\r
def StoreDec(DecFileName, Package):\r
    DecFile = open(DecFileName, "w+")\r
    EdkLogger.info("Save file to %s" % DecFileName)\r
    \r
    StoreHeader(DecFile, Package.Header)\r
    StorePackageDefinesSection(DecFile, Package)\r
    StorePackageIncludesSection(DecFile, Package)\r
    StorePackageLibraryClassesSection(DecFile, Package)\r
    StorePackageProtocolsSection(DecFile, Package)\r
    StorePackagePpisSection(DecFile, Package)\r
    StorePackageGuidsSection(DecFile, Package)\r
    StorePackagePcdsSection(DecFile, Package)\r
    StorePackageUserExtensionsSection(DecFile, Package)\r
    \r
    DecFile.close()\r
\r
    \r
# This acts like the main() function for the script, unless it is 'import'ed\r
# into another script.\r
if __name__ == '__main__':\r
    pass\r