BaseTools/Source/Python/GenFds/CapsuleData.py

   1 ## @file
   2 # generate capsule
   3 #
   4 #  Copyright (c) 2007-2013, Intel Corporation. All rights reserved.<BR>
   5 #
   6 #  This program and the accompanying materials
   7 #  are licensed and made available under the terms and conditions of the BSD License
   8 #  which accompanies this distribution.  The full text of the license may be found at
   9 #  http://opensource.org/licenses/bsd-license.php
  10 #
  11 #  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 #  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13 #
  14
  15 ##
  16 # Import Modules
  17 #
  18 import Ffs
  19 from GenFdsGlobalVariable import GenFdsGlobalVariable
  20 import StringIO
  21
  22 ## base class for capsule data
  23 #
  24 #
  25 class CapsuleData:
  26     ## The constructor
  27     #
  28     #   @param  self        The object pointer
  29     def __init__(self):
  30         pass
  31
  32     ## generate capsule data
  33     #
  34     #   @param  self        The object pointer
  35     def GenCapsuleSubItem(self):
  36         pass
  37
  38 ## FFS class for capsule data
  39 #
  40 #
  41 class CapsuleFfs (CapsuleData):
  42     ## The constructor
  43     #
  44     #   @param  self        The object pointer
  45     #
  46     def __init__(self) :
  47         self.Ffs = None
  48         self.FvName = None
  49
  50     ## generate FFS capsule data
  51     #
  52     #   @param  self        The object pointer
  53     #   @retval string      Generated file name
  54     #
  55     def GenCapsuleSubItem(self):
  56         FfsFile = self.Ffs.GenFfs()
  57         return FfsFile
  58
  59 ## FV class for capsule data
  60 #
  61 #
  62 class CapsuleFv (CapsuleData):
  63     ## The constructor
  64     #
  65     #   @param  self        The object pointer
  66     #
  67     def __init__(self) :
  68         self.Ffs = None
  69         self.FvName = None
  70         self.CapsuleName = None
  71
  72     ## generate FV capsule data
  73     #
  74     #   @param  self        The object pointer
  75     #   @retval string      Generated file name
  76     #
  77     def GenCapsuleSubItem(self):
  78         if self.FvName.find('.fv') == -1:
  79             if self.FvName.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():
  80                 FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName.upper())
  81                 FdBuffer = StringIO.StringIO('')
  82                 FvObj.CapsuleName = self.CapsuleName
  83                 FvFile = FvObj.AddToBuffer(FdBuffer)
  84                 FvObj.CapsuleName = None
  85                 FdBuffer.close()
  86                 return FvFile
  87         else:
  88             FvFile = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FvName)
  89             return FvFile
  90
  91 ## FD class for capsule data
  92 #
  93 #
  94 class CapsuleFd (CapsuleData):
  95     ## The constructor
  96     #
  97     #   @param  self        The object pointer
  98     #
  99     def __init__(self) :
 100         self.Ffs = None
 101         self.FdName = None
 102         self.CapsuleName = None
 103
 104     ## generate FD capsule data
 105     #
 106     #   @param  self        The object pointer
 107     #   @retval string      Generated file name
 108     #
 109     def GenCapsuleSubItem(self):
 110         if self.FdName.find('.fd') == -1:
 111             if self.FdName.upper() in GenFdsGlobalVariable.FdfParser.Profile.FdDict.keys():
 112                 FdObj = GenFdsGlobalVariable.FdfParser.Profile.FdDict.get(self.FdName.upper())
 113                 FdFile = FdObj.GenFd()
 114                 return FdFile
 115         else:
 116             FdFile = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FdName)
 117             return FdFile
 118
 119 ## AnyFile class for capsule data
 120 #
 121 #
 122 class CapsuleAnyFile (CapsuleData):
 123     ## The constructor
 124     #
 125     #   @param  self        The object pointer
 126     #
 127     def __init__(self) :
 128         self.Ffs = None
 129         self.FileName = None
 130
 131     ## generate AnyFile capsule data
 132     #
 133     #   @param  self        The object pointer
 134     #   @retval string      Generated file name
 135     #
 136     def GenCapsuleSubItem(self):
 137         return self.FileName
 138
 139 ## Afile class for capsule data
 140 #
 141 #
 142 class CapsuleAfile (CapsuleData):
 143     ## The constructor
 144     #
 145     #   @param  self        The object pointer
 146     #
 147     def __init__(self) :
 148         self.Ffs = None
 149         self.FileName = None
 150
 151     ## generate Afile capsule data
 152     #
 153     #   @param  self        The object pointer
 154     #   @retval string      Generated file name
 155     #
 156     def GenCapsuleSubItem(self):
 157         return self.FileName