Sync BaseTool trunk (version r2640) into EDKII BaseTools.

[mirror_edk2.git] / BaseTools / Source / Python / CommonDataClass / FdfClass.py

## @file\r
# classes represent data in FDF\r
#\r
#  Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
#\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
## FD data in FDF\r
#\r
#\r
class FDClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.FdUiName = ''\r
        self.CreateFileName = None\r
        self.BaseAddress = None\r
        self.BaseAddressPcd = None\r
        self.Size = None\r
        self.SizePcd = None\r
        self.ErasePolarity = None\r
        # 3-tuple list (blockSize, numBlocks, pcd)\r
        self.BlockSizeList = []\r
        # DefineVarDict[var] = value\r
        self.DefineVarDict = {}\r
        # SetVarDict[var] = value\r
        self.SetVarDict = {}\r
        self.RegionList = []\r
        self.vtfRawDict = {}\r
\r
## FV data in FDF\r
#\r
#\r
class FvClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.UiFvName = None\r
        self.CreateFileName = None\r
        # 3-tuple list (blockSize, numBlocks, pcd)\r
        self.BlockSizeList = []\r
        # DefineVarDict[var] = value\r
        self.DefineVarDict = {}\r
        # SetVarDict[var] = value\r
        self.SetVarDict = {}\r
        self.FvAlignment = None\r
        # FvAttributeDict[attribute] = TRUE/FALSE (1/0)\r
        self.FvAttributeDict = {}\r
        self.FvNameGuid = None\r
        self.AprioriSectionList = []\r
        self.FfsList = []\r
        self.BsBaseAddress = None\r
        self.RtBaseAddress = None\r
\r
## Region data in FDF\r
#\r
#\r
class RegionClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.Offset = None       # The begin position of the Region\r
        self.Size = None         # The Size of the Region\r
        self.PcdOffset = None\r
        self.PcdSize = None\r
        self.SetVarDict = {}\r
        self.RegionType = None\r
        self.RegionDataList = []\r
\r
## FFS data in FDF\r
#\r
#        \r
class FfsClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.NameGuid = None\r
        self.Fixed = False\r
        self.CheckSum = False\r
        self.Alignment = None\r
        self.SectionList = []\r
\r
## FILE statement data in FDF\r
#\r
#        \r
class FileStatementClassObject (FfsClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FfsClassObject.__init__(self)\r
        self.FvFileType = None\r
        self.FileName = None\r
        self.KeyStringList = []\r
        self.FvName = None\r
        self.FdName = None\r
        self.DefineVarDict = {}\r
        self.AprioriSection = None\r
        self.KeepReloc = None\r
\r
## INF statement data in FDF\r
#\r
#\r
class FfsInfStatementClassObject(FfsClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FfsClassObject.__init__(self)\r
        self.Rule = None\r
        self.Version = None\r
        self.Ui = None\r
        self.InfFileName = None\r
        self.BuildNum = ''\r
        self.KeyStringList = []\r
        self.KeepReloc = None\r
        self.UseArch = None\r
\r
## APRIORI section data in FDF\r
#\r
#\r
class AprioriSectionClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        # DefineVarDict[var] = value\r
        self.DefineVarDict = {}\r
        self.FfsList = []\r
\r
## section data in FDF\r
#\r
#        \r
class SectionClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.Alignment = None\r
        \r
## Depex expression section in FDF\r
#\r
#        \r
class DepexSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.DepexType = None\r
        self.Expression = None\r
        self.ExpressionProcessed = False\r
\r
## Compress section data in FDF\r
#\r
#\r
class CompressSectionClassObject (SectionClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.CompType = None\r
        self.SectionList = []\r
\r
## Data section data in FDF\r
#\r
#        \r
class DataSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.SecType = None\r
        self.SectFileName = None\r
        self.SectionList = []\r
        self.KeepReloc = True\r
\r
## Rule section data in FDF\r
#\r
#\r
class EfiSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.SectionType = None\r
        self.Optional = False\r
        self.FileType = None\r
        self.StringData = None\r
        self.FileName = None\r
        self.FileExtension = None\r
        self.BuildNum = None\r
        self.KeepReloc = None\r
\r
## FV image section data in FDF\r
#\r
#        \r
class FvImageSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.Fv = None\r
        self.FvName = None\r
        self.FvFileType = None\r
        self.FvFileName = None\r
        self.FvFileExtension = None\r
        self.FvAddr = None\r
\r
## GUIDed section data in FDF\r
#\r
#        \r
class GuidSectionClassObject (SectionClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.NameGuid = None\r
        self.SectionList = []\r
        self.SectionType = None\r
        self.ProcessRequired = False\r
        self.AuthStatusValid = False\r
        self.ExtraHeaderSize = -1\r
        self.FvAddr = []\r
        self.FvParentAddr = None\r
        self.IncludeFvSection = False\r
\r
## UI section data in FDF\r
#\r
#\r
class UiSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.StringData = None\r
        self.FileName = None\r
\r
## Version section data in FDF\r
#\r
#        \r
class VerSectionClassObject (SectionClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        SectionClassObject.__init__(self)\r
        self.BuildNum = None\r
        self.StringData = None\r
        self.FileName = None\r
\r
## Rule data in FDF\r
#\r
#\r
class RuleClassObject :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.Arch = None\r
        self.ModuleType = None    # For Module Type\r
        self.TemplateName = None\r
        self.NameGuid = None\r
        self.Fixed = False\r
        self.Alignment = None\r
        self.SectAlignment = None\r
        self.CheckSum = False\r
        self.FvFileType = None       # for Ffs File Type\r
        self.KeyStringList = []\r
        self.KeepReloc = None\r
\r
## Complex rule data in FDF\r
#\r
#        \r
class RuleComplexFileClassObject(RuleClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        RuleClassObject.__init__(self)\r
        self.SectionList = []\r
\r
## Simple rule data in FDF\r
#\r
#\r
class RuleSimpleFileClassObject(RuleClassObject) :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        RuleClassObject.__init__(self)\r
        self.FileName = None\r
        self.SectionType = ''\r
        self.FileExtension = None\r
\r
## File extension rule data in FDF\r
#\r
#\r
class RuleFileExtensionClassObject(RuleClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        RuleClassObject.__init__(self)\r
        self.FileExtension = None\r
\r
## Capsule data in FDF\r
#\r
#        \r
class CapsuleClassObject :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.SpecName = None\r
        self.UiCapsuleName = None\r
        self.CreateFile = None\r
        self.GroupIdNumber = None\r
        # DefineVarDict[var] = value\r
        self.DefineVarDict = {}\r
        # SetVarDict[var] = value\r
        self.SetVarDict = {}\r
        # TokensDict[var] = value\r
        self.TokensDict = {}\r
        self.CapsuleDataList = []\r
\r
## VTF data in FDF\r
#\r
#\r
class VtfClassObject :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.KeyArch = None\r
        self.ArchList = None\r
        self.UiName = None\r
        self.ResetBin = None\r
        self.ComponentStatementList = []\r
\r
## VTF component data in FDF\r
#\r
#        \r
class ComponentStatementClassObject :\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.CompName = None\r
        self.CompLoc = None\r
        self.CompType = None\r
        self.CompVer = None\r
        self.CompCs = None\r
        self.CompBin = None\r
        self.CompSym = None\r
        self.CompSize = None\r
        self.FilePos = None\r
 \r
## OptionROM data in FDF\r
#\r
#\r
class OptionRomClassObject:\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        self.DriverName = None\r
        self.FfsList = []\r
       \r