import cPickle\r
import array\r
import shutil\r
+from struct import pack\r
from UserDict import IterableUserDict\r
from UserList import UserList\r
\r
AvailableSkuIdSet = property(__GetAvailableSkuIds)\r
SkuUsageType = property(__SkuUsageType)\r
AvailableSkuIdNumSet = property(__GetAvailableSkuIdNumber)\r
+\r
+#\r
+# Pack a registry format GUID\r
+#\r
+def PackRegistryFormatGuid(Guid):\r
+ Guid = Guid.split('-')\r
+ return pack('=LHHBBBBBBBB',\r
+ int(Guid[0], 16),\r
+ int(Guid[1], 16),\r
+ int(Guid[2], 16),\r
+ int(Guid[3][-4:-2], 16),\r
+ int(Guid[3][-2:], 16),\r
+ int(Guid[4][-12:-10], 16),\r
+ int(Guid[4][-10:-8], 16),\r
+ int(Guid[4][-8:-6], 16),\r
+ int(Guid[4][-6:-4], 16),\r
+ int(Guid[4][-4:-2], 16),\r
+ int(Guid[4][-2:], 16)\r
+ )\r
+\r
##\r
#\r
# This acts like the main() function for the script, unless it is 'import'ed into another\r
# TokensDict[var] = value\r
self.TokensDict = {}\r
self.CapsuleDataList = []\r
+ self.FmpPayloadList = []\r
\r
## VTF data in FDF\r
#\r
import StringIO\r
from Common.Misc import SaveFileOnChange\r
from GenFds import GenFds\r
+from Common.Misc import PackRegistryFormatGuid\r
+import uuid\r
+from struct import pack\r
\r
\r
T_CHAR_LF = '\n'\r
self.BlockNum = None\r
self.CapsuleName = None\r
\r
+ ## Generate FMP capsule\r
+ #\r
+ # @retval string Generated Capsule file path\r
+ #\r
+ def GenFmpCapsule(self):\r
+ #\r
+ # Generate capsule header\r
+ # typedef struct {\r
+ # EFI_GUID CapsuleGuid;\r
+ # UINT32 HeaderSize;\r
+ # UINT32 Flags;\r
+ # UINT32 CapsuleImageSize;\r
+ # } EFI_CAPSULE_HEADER;\r
+ #\r
+ Header = StringIO.StringIO()\r
+ #\r
+ # Use FMP capsule GUID: 6DCBD5ED-E82D-4C44-BDA1-7194199AD92A\r
+ #\r
+ Header.write(PackRegistryFormatGuid('6DCBD5ED-E82D-4C44-BDA1-7194199AD92A'))\r
+ HdrSize = 0\r
+ if 'CAPSULE_HEADER_SIZE' in self.TokensDict:\r
+ Header.write(pack('=I', int(self.TokensDict['CAPSULE_HEADER_SIZE'], 16)))\r
+ HdrSize = int(self.TokensDict['CAPSULE_HEADER_SIZE'], 16)\r
+ else:\r
+ Header.write(pack('=I', 0x20))\r
+ HdrSize = 0x20\r
+ Flags = 0\r
+ if 'CAPSULE_FLAGS' in self.TokensDict:\r
+ for flag in self.TokensDict['CAPSULE_FLAGS'].split(','):\r
+ flag = flag.strip()\r
+ if flag == 'PopulateSystemTable':\r
+ Flags |= 0x00010000 | 0x00020000\r
+ elif flag == 'PersistAcrossReset':\r
+ Flags |= 0x00010000\r
+ elif flag == 'InitiateReset':\r
+ Flags |= 0x00040000\r
+ Header.write(pack('=I', Flags))\r
+ #\r
+ # typedef struct {\r
+ # UINT32 Version;\r
+ # UINT16 EmbeddedDriverCount;\r
+ # UINT16 PayloadItemCount;\r
+ # // UINT64 ItemOffsetList[];\r
+ # } EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER;\r
+ #\r
+ FwMgrHdr = StringIO.StringIO()\r
+ if 'CAPSULE_HEADER_INIT_VERSION' in self.TokensDict:\r
+ FwMgrHdr.write(pack('=I', int(self.TokensDict['CAPSULE_HEADER_INIT_VERSION'], 16)))\r
+ else:\r
+ FwMgrHdr.write(pack('=I', 0x00000001))\r
+ FwMgrHdr.write(pack('=HH', len(self.CapsuleDataList), len(self.FmpPayloadList)))\r
+ FwMgrHdrSize = 4+2+2+8*(len(self.CapsuleDataList)+len(self.FmpPayloadList))\r
+\r
+ PreSize = FwMgrHdrSize\r
+ Content = StringIO.StringIO()\r
+ for driver in self.CapsuleDataList:\r
+ FileName = driver.GenCapsuleSubItem()\r
+ FwMgrHdr.write(pack('=Q', PreSize))\r
+ PreSize += os.path.getsize(FileName)\r
+ File = open(FileName, 'rb')\r
+ Content.write(File.read())\r
+ File.close()\r
+ for fmp in self.FmpPayloadList:\r
+ payload = fmp.GenCapsuleSubItem()\r
+ FwMgrHdr.write(pack('=Q', PreSize))\r
+ PreSize += len(payload)\r
+ Content.write(payload)\r
+ BodySize = len(FwMgrHdr.getvalue()) + len(Content.getvalue())\r
+ Header.write(pack('=I', HdrSize + BodySize))\r
+ #\r
+ # The real capsule header structure is 28 bytes\r
+ #\r
+ Header.write('\x00'*(HdrSize-28))\r
+ Header.write(FwMgrHdr.getvalue())\r
+ Header.write(Content.getvalue())\r
+ #\r
+ # Generate FMP capsule file\r
+ #\r
+ CapOutputFile = os.path.join(GenFdsGlobalVariable.FvDir, self.UiCapsuleName) + '.Cap'\r
+ SaveFileOnChange(CapOutputFile, Header.getvalue(), True)\r
+ return CapOutputFile\r
+\r
## Generate capsule\r
#\r
# @param self The object pointer\r
return GenFds.ImageBinDict[self.UiCapsuleName.upper() + 'cap']\r
\r
GenFdsGlobalVariable.InfLogger( "\nGenerate %s Capsule" %self.UiCapsuleName)\r
+ if ('CAPSULE_GUID' in self.TokensDict and \r
+ uuid.UUID(self.TokensDict['CAPSULE_GUID']) == uuid.UUID('6DCBD5ED-E82D-4C44-BDA1-7194199AD92A')):\r
+ return self.GenFmpCapsule()\r
+\r
CapInfFile = self.GenCapInf()\r
CapInfFile.writelines("[files]" + T_CHAR_LF)\r
CapFileList = []\r
import Ffs\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
import StringIO\r
+from struct import pack\r
+import os\r
+from Common.Misc import SaveFileOnChange\r
\r
## base class for capsule data\r
#\r
# @retval string Generated file name\r
#\r
def GenCapsuleSubItem(self):\r
- return self.FileName
\ No newline at end of file
+ return self.FileName\r
+\r
+class CapsulePayload(CapsuleData):\r
+ '''Generate payload file, the header is defined below:\r
+ #pragma pack(1)\r
+ typedef struct {\r
+ UINT32 Version;\r
+ EFI_GUID UpdateImageTypeId;\r
+ UINT8 UpdateImageIndex;\r
+ UINT8 reserved_bytes[3];\r
+ UINT32 UpdateImageSize;\r
+ UINT32 UpdateVendorCodeSize;\r
+ UINT64 UpdateHardwareInstance; //Introduced in v2\r
+ } EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER;\r
+ '''\r
+ def __init__(self):\r
+ self.UiName = None\r
+ self.Version = None\r
+ self.ImageTypeId = None\r
+ self.ImageIndex = None\r
+ self.HardwareInstance = None\r
+ self.ImageFile = None\r
+ self.VendorCodeFile = None\r
+\r
+ def GenCapsuleSubItem(self):\r
+ if not self.Version:\r
+ self.Version = 0x00000002\r
+ ImageFileSize = os.path.getsize(self.ImageFile)\r
+ VendorFileSize = 0\r
+ if self.VendorCodeFile:\r
+ VendorFileSize = os.path.getsize(self.VendorCodeFile)\r
+\r
+ #\r
+ # Fill structure\r
+ #\r
+ Guid = self.ImageTypeId.split('-')\r
+ Buffer = pack('=ILHHBBBBBBBBBBBBIIQ',\r
+ int(self.Version,16),\r
+ int(Guid[0], 16), \r
+ int(Guid[1], 16), \r
+ int(Guid[2], 16), \r
+ int(Guid[3][-4:-2], 16), \r
+ int(Guid[3][-2:], 16), \r
+ int(Guid[4][-12:-10], 16),\r
+ int(Guid[4][-10:-8], 16),\r
+ int(Guid[4][-8:-6], 16),\r
+ int(Guid[4][-6:-4], 16),\r
+ int(Guid[4][-4:-2], 16),\r
+ int(Guid[4][-2:], 16),\r
+ int(self.ImageIndex, 16),\r
+ 0,\r
+ 0,\r
+ 0,\r
+ ImageFileSize,\r
+ VendorFileSize,\r
+ int(self.HardwareInstance, 16)\r
+ )\r
+ #\r
+ # Append file content to the structure\r
+ #\r
+ ImageFile = open(self.ImageFile, 'rb')\r
+ Buffer += ImageFile.read()\r
+ ImageFile.close()\r
+ if self.VendorCodeFile:\r
+ VendorFile = open(self.VendorCodeFile, 'rb')\r
+ Buffer += VendorFile.read()\r
+ VendorFile.close()\r
+ return Buffer\r
self.VtfList = []\r
self.RuleDict = {}\r
self.OptRomDict = {}\r
+ self.FmpPayloadDict = {}\r
\r
## The syntax parser for FDF\r
#\r
while self.__GetFv():\r
pass\r
\r
+ while self.__GetFmp():\r
+ pass\r
+\r
while self.__GetCapsule():\r
pass\r
\r
\r
S = self.__Token.upper()\r
if S.startswith("[") and not S.startswith("[FD."):\r
- if not S.startswith("[FV.") and not S.startswith("[CAPSULE.") \\r
+ if not S.startswith("[FV.") and not S.startswith('[FMPPAYLOAD.') and not S.startswith("[CAPSULE.") \\r
and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
raise Warning("Unknown section", self.FileName, self.CurrentLineNumber)\r
self.__UndoToken()\r
\r
S = self.__Token.upper()\r
if S.startswith("[") and not S.startswith("[FV."):\r
- if not S.startswith("[CAPSULE.") \\r
+ if not S.startswith('[FMPPAYLOAD.') and not S.startswith("[CAPSULE.") \\r
and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
self.__UndoToken()\r
else:\r
return True\r
\r
+ def __GetFmp(self):\r
+ if not self.__GetNextToken():\r
+ return False\r
+ S = self.__Token.upper()\r
+ if not S.startswith("[FMPPAYLOAD."):\r
+ if not S.startswith("[CAPSULE.") and not S.startswith("[VTF.") and not S.startswith("[RULE.") and not S.startswith("[OPTIONROM."):\r
+ raise Warning("Unknown section or section appear sequence error (The correct sequence should be [FD.], [FV.], [FmpPayload.], [Capsule.], [VTF.], [Rule.], [OptionRom.])", self.FileName, self.CurrentLineNumber)\r
+ self.__UndoToken()\r
+ return False\r
+\r
+ self.__UndoToken()\r
+ self.__SkipToToken("[FMPPAYLOAD.", True)\r
+ FmpUiName = self.__GetUiName().upper()\r
+ if FmpUiName in self.Profile.FmpPayloadDict:\r
+ raise Warning("Duplicated FMP UI name found: %s" % FmpUiName, self.FileName, self.CurrentLineNumber)\r
+\r
+ FmpData = CapsuleData.CapsulePayload()\r
+ FmpData.UiName = FmpUiName\r
+\r
+ if not self.__IsToken( "]"):\r
+ raise Warning("expected ']'", self.FileName, self.CurrentLineNumber)\r
+\r
+ if not self.__GetNextToken():\r
+ raise Warning("The FMP payload section is empty!", self.FileName, self.CurrentLineNumber)\r
+ FmpKeyList = ['IMAGE_HEADER_INIT_VERSION', 'IMAGE_TYPE_ID', 'IMAGE_INDEX', 'HARDWARE_INSTANCE']\r
+ while self.__Token in FmpKeyList:\r
+ Name = self.__Token\r
+ FmpKeyList.remove(Name)\r
+ if not self.__IsToken("="):\r
+ raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+ if Name == 'IMAGE_TYPE_ID':\r
+ if not self.__GetNextGuid():\r
+ raise Warning("expected GUID value for IMAGE_TYPE_ID", self.FileName, self.CurrentLineNumber)\r
+ FmpData.ImageTypeId = self.__Token\r
+ else:\r
+ if not self.__GetNextToken():\r
+ raise Warning("expected value of %s" % Name, self.FileName, self.CurrentLineNumber)\r
+ Value = self.__Token\r
+ if Name == 'IMAGE_HEADER_INIT_VERSION':\r
+ FmpData.Version = Value\r
+ elif Name == 'IMAGE_INDEX':\r
+ FmpData.ImageIndex = Value\r
+ elif Name == 'HARDWARE_INSTANCE':\r
+ FmpData.HardwareInstance = Value\r
+ if not self.__GetNextToken():\r
+ break\r
+ else:\r
+ self.__UndoToken()\r
+\r
+ if FmpKeyList:\r
+ raise Warning("Missing keywords %s in FMP payload section" % ', '.join(FmpKeyList), self.FileName, self.CurrentLineNumber)\r
+ ImageFile = self.__ParseRawFileStatement()\r
+ if not ImageFile:\r
+ raise Warning("Missing image file in FMP payload section", self.FileName, self.CurrentLineNumber)\r
+ FmpData.ImageFile = ImageFile\r
+ VendorCodeFile = self.__ParseRawFileStatement()\r
+ if VendorCodeFile:\r
+ FmpData.VendorCodeFile = VendorCodeFile\r
+ self.Profile.FmpPayloadDict[FmpUiName] = FmpData\r
+ return True\r
+\r
## __GetCapsule() method\r
#\r
# Get capsule section contents and store its data into capsule list of self.Profile\r
def __GetCapsuleTokens(self, Obj):\r
if not self.__GetNextToken():\r
return False\r
- while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS", "OEM_CAPSULE_FLAGS"):\r
+ while self.__Token in ("CAPSULE_GUID", "CAPSULE_HEADER_SIZE", "CAPSULE_FLAGS", "OEM_CAPSULE_FLAGS", "CAPSULE_HEADER_INIT_VERSION"):\r
Name = self.__Token.strip()\r
if not self.__IsToken("="):\r
raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
IsFd = self.__GetFdStatement(Obj)\r
IsAnyFile = self.__GetAnyFileStatement(Obj)\r
IsAfile = self.__GetAfileStatement(Obj)\r
- if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile):\r
+ IsFmp = self.__GetFmpStatement(Obj)\r
+ if not (IsInf or IsFile or IsFv or IsFd or IsAnyFile or IsAfile or IsFmp):\r
break\r
\r
## __GetFvStatement() method\r
CapsuleObj.CapsuleDataList.append(CapsuleFd)\r
return True\r
\r
- ## __GetAnyFileStatement() method\r
- #\r
- # Get AnyFile for capsule\r
- #\r
- # @param self The object pointer\r
- # @param CapsuleObj for whom AnyFile is got\r
- # @retval True Successfully find a Anyfile statement\r
- # @retval False Not able to find a AnyFile statement\r
- #\r
- def __GetAnyFileStatement(self, CapsuleObj):\r
+ def __GetFmpStatement(self, CapsuleObj):\r
+ if not self.__IsKeyword("FMP"):\r
+ return False\r
\r
- if not self.__IsKeyword("FILE"):\r
+ if not self.__IsKeyword("PAYLOAD"):\r
+ self.__UndoToken()\r
return False\r
\r
+ if not self.__IsToken("="):\r
+ raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
+\r
+ if not self.__GetNextToken():\r
+ raise Warning("expected payload name after FMP PAYLOAD =", self.FileName, self.CurrentLineNumber)\r
+ Payload = self.__Token.upper()\r
+ if Payload not in self.Profile.FmpPayloadDict:\r
+ raise Warning("This FMP Payload does not exist: %s" % self.__Token, self.FileName, self.CurrentLineNumber)\r
+ CapsuleObj.FmpPayloadList.append(self.Profile.FmpPayloadDict[Payload])\r
+ return True\r
+\r
+ def __ParseRawFileStatement(self):\r
+ if not self.__IsKeyword("FILE"):\r
+ return None\r
+\r
if not self.__IsKeyword("DATA"):\r
self.__UndoToken()\r
- return False\r
+ return None\r
\r
if not self.__IsToken("="):\r
raise Warning("expected '='", self.FileName, self.CurrentLineNumber)\r
AnyFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(AnyFileName)\r
if not os.path.exists(AnyFileName):\r
raise Warning("File %s not exists"%AnyFileName, self.FileName, self.CurrentLineNumber)\r
+ return AnyFileName\r
+\r
+ ## __GetAnyFileStatement() method\r
+ #\r
+ # Get AnyFile for capsule\r
+ #\r
+ # @param self The object pointer\r
+ # @param CapsuleObj for whom AnyFile is got\r
+ # @retval True Successfully find a Anyfile statement\r
+ # @retval False Not able to find a AnyFile statement\r
+ #\r
+ def __GetAnyFileStatement(self, CapsuleObj):\r
+ AnyFileName = self.__ParseRawFileStatement()\r
+ if not AnyFileName:\r
+ return False\r
\r
CapsuleAnyFile = CapsuleData.CapsuleAnyFile()\r
CapsuleAnyFile.FileName = AnyFileName\r
projects / mirror_edk2.git / commitdiff