[mirror_edk2.git] / BaseTools / Source / Python / GenFds / Region.py

## @file\r
# process FD Region generation\r
#\r
#  Copyright (c) 2007 - 2015, 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
##\r
# Import Modules\r
#\r
from struct import *\r
from GenFdsGlobalVariable import GenFdsGlobalVariable\r
import StringIO\r
from CommonDataClass.FdfClass import RegionClassObject\r
import Common.LongFilePathOs as os\r
from stat import *\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
from Common.LongFilePathSupport import OpenLongFilePath as open\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
\r
## generate Region\r
#\r
#\r
class Region(RegionClassObject):\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        RegionClassObject.__init__(self)\r
\r
\r
    ## AddToBuffer()\r
    #\r
    #   Add region data to the Buffer\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  Buffer      The buffer generated region data will be put\r
    #   @param  BaseAddress base address of region\r
    #   @param  BlockSize   block size of region\r
    #   @param  BlockNum    How many blocks in region\r
    #   @param  ErasePolarity      Flash erase polarity\r
    #   @param  VtfDict     VTF objects\r
    #   @param  MacroDict   macro value pair\r
    #   @retval string      Generated FV file path\r
    #\r
\r
    def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}):\r
        Size = self.Size\r
        GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r
        GenFdsGlobalVariable.InfLogger("   Region Size = 0x%X" % Size)\r
        GenFdsGlobalVariable.SharpCounter = 0\r
\r
        if self.RegionType == 'FV':\r
            #\r
            # Get Fv from FvDict\r
            #\r
            self.FvAddress = int(BaseAddress, 16) + self.Offset\r
            FvBaseAddress = '0x%X' % self.FvAddress\r
            FvOffset = 0\r
            for RegionData in self.RegionDataList:\r
                FileName = None\r
                if RegionData.endswith(".fv"):\r
                    RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
                    GenFdsGlobalVariable.InfLogger('   Region FV File Name = .fv : %s' % RegionData)\r
                    if RegionData[1] != ':' :\r
                        RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
                    if not os.path.exists(RegionData):\r
                        EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
\r
                    FileName = RegionData\r
                elif RegionData.upper() + 'fv' in ImageBinDict.keys():\r
                    GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                    FileName = ImageBinDict[RegionData.upper() + 'fv']\r
                else:\r
                    #\r
                    # Generate FvImage.\r
                    #\r
                    FvObj = None\r
                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
                        FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(RegionData.upper())\r
\r
                    if FvObj != None :\r
                        GenFdsGlobalVariable.InfLogger('   Region Name = FV')\r
                        #\r
                        # Call GenFv tool\r
                        #\r
                        self.BlockInfoOfRegion(BlockSizeList, FvObj)\r
                        self.FvAddress = self.FvAddress + FvOffset\r
                        FvAlignValue = self.GetFvAlignValue(FvObj.FvAlignment)\r
                        if self.FvAddress % FvAlignValue != 0:\r
                            EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                            "FV (%s) is NOT %s Aligned!" % (FvObj.UiFvName, FvObj.FvAlignment))\r
                        FvBuffer = StringIO.StringIO('')\r
                        FvBaseAddress = '0x%X' % self.FvAddress\r
                        BlockSize = None\r
                        BlockNum = None\r
                        FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r
                        if FvBuffer.len > Size:\r
                            FvBuffer.close()\r
                            EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                            "Size of FV (%s) is larger than Region Size 0x%X specified." % (RegionData, Size))\r
                        #\r
                        # Put the generated image into FD buffer.\r
                        #\r
                        Buffer.write(FvBuffer.getvalue())\r
                        FvBuffer.close()\r
                        FvOffset = FvOffset + FvBuffer.len\r
                        Size = Size - FvBuffer.len\r
                        continue\r
                    else:\r
                        EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r
                #\r
                # Add the exist Fv image into FD buffer\r
                #\r
                if FileName != None:\r
                    FileLength = os.stat(FileName)[ST_SIZE]\r
                    if FileLength > Size:\r
                        EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                        "Size of FV File (%s) is larger than Region Size 0x%X specified." \\r
                                        % (RegionData, Size))\r
                    BinFile = open(FileName, 'r+b')\r
                    Buffer.write(BinFile.read())\r
                    BinFile.close()\r
                    Size = Size - FileLength\r
            #\r
            # Pad the left buffer\r
            #\r
            if Size > 0:\r
                if (ErasePolarity == '1') :\r
                    PadData = 0xFF\r
                else :\r
                    PadData = 0\r
                for i in range(0, Size):\r
                    Buffer.write(pack('B', PadData))\r
\r
        if self.RegionType == 'CAPSULE':\r
            #\r
            # Get Capsule from Capsule Dict\r
            #\r
            for RegionData in self.RegionDataList:\r
                if RegionData.endswith(".cap"):\r
                    RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
                    GenFdsGlobalVariable.InfLogger('   Region CAPSULE Image Name = .cap : %s' % RegionData)\r
                    if RegionData[1] != ':' :\r
                        RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
                    if not os.path.exists(RegionData):\r
                        EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
\r
                    FileName = RegionData\r
                elif RegionData.upper() + 'cap' in ImageBinDict.keys():\r
                    GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
                    FileName = ImageBinDict[RegionData.upper() + 'cap']\r
                else:\r
                    #\r
                    # Generate Capsule image and Put it into FD buffer\r
                    #\r
                    CapsuleObj = None\r
                    if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.keys():\r
                        CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[RegionData.upper()]\r
\r
                    if CapsuleObj != None :\r
                        CapsuleObj.CapsuleName = RegionData.upper()\r
                        GenFdsGlobalVariable.InfLogger('   Region Name = CAPSULE')\r
                        #\r
                        # Call GenFv tool to generate Capsule Image\r
                        #\r
                        FileName = CapsuleObj.GenCapsule()\r
                        CapsuleObj.CapsuleName = None\r
                    else:\r
                        EdkLogger.error("GenFds", GENFDS_ERROR, "Capsule (%s) is NOT described in FDF file!" % (RegionData))\r
\r
                #\r
                # Add the capsule image into FD buffer\r
                #\r
                FileLength = os.stat(FileName)[ST_SIZE]\r
                if FileLength > Size:\r
                    EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                    "Size 0x%X of Capsule File (%s) is larger than Region Size 0x%X specified." \\r
                                    % (FileLength, RegionData, Size))\r
                BinFile = open(FileName, 'r+b')\r
                Buffer.write(BinFile.read())\r
                BinFile.close()\r
                Size = Size - FileLength\r
            #\r
            # Pad the left buffer\r
            #\r
            if Size > 0:\r
                if (ErasePolarity == '1') :\r
                    PadData = 0xFF\r
                else :\r
                    PadData = 0\r
                for i in range(0, Size):\r
                    Buffer.write(pack('B', PadData))\r
\r
        if self.RegionType in ('FILE', 'INF'):\r
            for RegionData in self.RegionDataList:\r
                if self.RegionType == 'INF':\r
                    RegionData.__InfParse__(None)\r
                    if len(RegionData.BinFileList) != 1:\r
                        EdkLogger.error('GenFds', GENFDS_ERROR, 'INF in FD region can only contain one binary: %s' % RegionData)\r
                    File = RegionData.BinFileList[0]\r
                    RegionData = RegionData.PatchEfiFile(File.Path, File.Type)\r
                else:\r
                    RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
                    if RegionData[1] != ':' :\r
                        RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
                    if not os.path.exists(RegionData):\r
                        EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
                #\r
                # Add the file image into FD buffer\r
                #\r
                FileLength = os.stat(RegionData)[ST_SIZE]\r
                if FileLength > Size:\r
                    EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                    "Size of File (%s) is larger than Region Size 0x%X specified." \\r
                                    % (RegionData, Size))\r
                GenFdsGlobalVariable.InfLogger('   Region File Name = %s' % RegionData)\r
                BinFile = open(RegionData, 'rb')\r
                Buffer.write(BinFile.read())\r
                BinFile.close()\r
                Size = Size - FileLength\r
            #\r
            # Pad the left buffer\r
            #\r
            if Size > 0:\r
                if (ErasePolarity == '1') :\r
                    PadData = 0xFF\r
                else :\r
                    PadData = 0\r
                for i in range(0, Size):\r
                    Buffer.write(pack('B', PadData))\r
\r
        if self.RegionType == 'DATA' :\r
            GenFdsGlobalVariable.InfLogger('   Region Name = DATA')\r
            DataSize = 0\r
            for RegionData in self.RegionDataList:\r
                Data = RegionData.split(',')\r
                DataSize = DataSize + len(Data)\r
                if DataSize > Size:\r
                   EdkLogger.error("GenFds", GENFDS_ERROR, "Size of DATA is larger than Region Size ")\r
                else:\r
                    for item in Data :\r
                        Buffer.write(pack('B', int(item, 16)))\r
                Size = Size - DataSize\r
            #\r
            # Pad the left buffer\r
            #\r
            if Size > 0:\r
                if (ErasePolarity == '1') :\r
                    PadData = 0xFF\r
                else :\r
                    PadData = 0\r
                for i in range(0, Size):\r
                    Buffer.write(pack('B', PadData))\r
\r
        if self.RegionType == None:\r
            GenFdsGlobalVariable.InfLogger('   Region Name = None')\r
            if (ErasePolarity == '1') :\r
                PadData = 0xFF\r
            else :\r
                PadData = 0\r
            for i in range(0, Size):\r
                Buffer.write(pack('B', PadData))\r
\r
    def GetFvAlignValue(self, Str):\r
        AlignValue = 1\r
        Granu = 1\r
        Str = Str.strip().upper()\r
        if Str.endswith('K'):\r
            Granu = 1024\r
            Str = Str[:-1]\r
        elif Str.endswith('M'):\r
            Granu = 1024 * 1024\r
            Str = Str[:-1]\r
        elif Str.endswith('G'):\r
            Granu = 1024 * 1024 * 1024\r
            Str = Str[:-1]\r
        else:\r
            pass\r
\r
        AlignValue = int(Str) * Granu\r
        return AlignValue\r
\r
    ## BlockSizeOfRegion()\r
    #\r
    #   @param  BlockSizeList        List of block information\r
    #   @param  FvObj                The object for FV\r
    #\r
    def BlockInfoOfRegion(self, BlockSizeList, FvObj):\r
        Start = 0\r
        End = 0\r
        RemindingSize = self.Size\r
        ExpectedList = []\r
        for (BlockSize, BlockNum, pcd) in BlockSizeList:\r
            End = Start + BlockSize * BlockNum\r
            # region not started yet\r
            if self.Offset >= End:\r
                Start = End\r
                continue\r
            # region located in current blocks \r
            else:\r
                # region ended within current blocks\r
                if self.Offset + self.Size <= End:\r
                    ExpectedList.append((BlockSize, (RemindingSize + BlockSize - 1) / BlockSize))\r
                    break\r
                # region not ended yet\r
                else:\r
                    # region not started in middle of current blocks\r
                    if self.Offset <= Start:\r
                        UsedBlockNum = BlockNum\r
                    # region started in middle of current blocks\r
                    else:\r
                        UsedBlockNum = (End - self.Offset) / BlockSize\r
                    Start = End\r
                    ExpectedList.append((BlockSize, UsedBlockNum))\r
                    RemindingSize -= BlockSize * UsedBlockNum\r
\r
        if FvObj.BlockSizeList == []:\r
            FvObj.BlockSizeList = ExpectedList\r
        else:\r
            # first check whether FvObj.BlockSizeList items have only "BlockSize" or "NumBlocks",\r
            # if so, use ExpectedList\r
            for Item in FvObj.BlockSizeList:\r
                if Item[0] == None or Item[1] == None:\r
                    FvObj.BlockSizeList = ExpectedList\r
                    break\r
            # make sure region size is no smaller than the summed block size in FV\r
            Sum = 0\r
            for Item in FvObj.BlockSizeList:\r
                Sum += Item[0] * Item[1]\r
            if self.Size < Sum:\r
                EdkLogger.error("GenFds", GENFDS_ERROR, "Total Size of FV %s 0x%x is larger than Region Size 0x%x "\r
                                % (FvObj.UiFvName, Sum, self.Size))\r
            # check whether the BlockStatements in FV section is appropriate\r
            ExpectedListData = ''\r
            for Item in ExpectedList:\r
                ExpectedListData += "BlockSize = 0x%x\n\tNumBlocks = 0x%x\n\t" % Item\r
            Index = 0\r
            for Item in FvObj.BlockSizeList:\r
                if Item[0] != ExpectedList[Index][0]:\r
                    EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
                                    % FvObj.UiFvName, ExtraData=ExpectedListData)\r
                elif Item[1] != ExpectedList[Index][1]:\r
                    if (Item[1] < ExpectedList[Index][1]) and (Index == len(FvObj.BlockSizeList) - 1):\r
                        break;\r
                    else:\r
                        EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
                                        % FvObj.UiFvName, ExtraData=ExpectedListData)\r
                else:\r
                    Index += 1\r
\r
            \r
\r
Commit	Line	Data
30fdf114 LG	1	## @file\r
	2	# process FD Region generation\r
	3	#\r
b21a13fb	4	# Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
30fdf114	5	#\r
40d841f6	6	# This program and the accompanying materials\r
30fdf114 LG	7	# are licensed and made available under the terms and conditions of the BSD License\r
	8	# which accompanies this distribution. The full text of the license may be found at\r
	9	# http://opensource.org/licenses/bsd-license.php\r
	10	#\r
	11	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	#\r
	14	\r
	15	##\r
	16	# Import Modules\r
	17	#\r
	18	from struct import *\r
	19	from GenFdsGlobalVariable import GenFdsGlobalVariable\r
	20	import StringIO\r
	21	from CommonDataClass.FdfClass import RegionClassObject\r
1be2ed90	22	import Common.LongFilePathOs as os\r
fd171542	23	from stat import *\r
30fdf114 LG	24	from Common import EdkLogger\r
30fdf114 LG	25	from Common.BuildToolError import *\r
1be2ed90	26	from Common.LongFilePathSupport import OpenLongFilePath as open\r
05cc51ad	27	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
30fdf114	28	\r
30fdf114 LG	29	## generate Region\r
	30	#\r
	31	#\r
	32	class Region(RegionClassObject):\r
	33	\r
	34	## The constructor\r
	35	#\r
	36	# @param self The object pointer\r
	37	#\r
	38	def __init__(self):\r
	39	RegionClassObject.__init__(self)\r
	40	\r
	41	\r
	42	## AddToBuffer()\r
	43	#\r
	44	# Add region data to the Buffer\r
	45	#\r
	46	# @param self The object pointer\r
	47	# @param Buffer The buffer generated region data will be put\r
	48	# @param BaseAddress base address of region\r
	49	# @param BlockSize block size of region\r
	50	# @param BlockNum How many blocks in region\r
	51	# @param ErasePolarity Flash erase polarity\r
	52	# @param VtfDict VTF objects\r
	53	# @param MacroDict macro value pair\r
	54	# @retval string Generated FV file path\r
	55	#\r
	56	\r
47fea6af	57	def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}):\r
30fdf114	58	Size = self.Size\r
fd171542	59	GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r
47fea6af	60	GenFdsGlobalVariable.InfLogger(" Region Size = 0x%X" % Size)\r
30fdf114 LG	61	GenFdsGlobalVariable.SharpCounter = 0\r
	62	\r
	63	if self.RegionType == 'FV':\r
	64	#\r
	65	# Get Fv from FvDict\r
	66	#\r
30fdf114	67	self.FvAddress = int(BaseAddress, 16) + self.Offset\r
47fea6af YZ	68	FvBaseAddress = '0x%X' % self.FvAddress\r
47fea6af YZ	69	FvOffset = 0\r
30fdf114	70	for RegionData in self.RegionDataList:\r
fd171542	71	FileName = None\r
30fdf114 LG	72	if RegionData.endswith(".fv"):\r
30fdf114 LG	73	RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
47fea6af	74	GenFdsGlobalVariable.InfLogger(' Region FV File Name = .fv : %s' % RegionData)\r
30fdf114 LG	75	if RegionData[1] != ':' :\r
	76	RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
	77	if not os.path.exists(RegionData):\r
	78	EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
	79	\r
fd171542	80	FileName = RegionData\r
	81	elif RegionData.upper() + 'fv' in ImageBinDict.keys():\r
	82	GenFdsGlobalVariable.InfLogger(' Region Name = FV')\r
	83	FileName = ImageBinDict[RegionData.upper() + 'fv']\r
	84	else:\r
	85	#\r
	86	# Generate FvImage.\r
	87	#\r
	88	FvObj = None\r
	89	if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r
	90	FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(RegionData.upper())\r
	91	\r
	92	if FvObj != None :\r
	93	GenFdsGlobalVariable.InfLogger(' Region Name = FV')\r
	94	#\r
	95	# Call GenFv tool\r
	96	#\r
6780eef1	97	self.BlockInfoOfRegion(BlockSizeList, FvObj)\r
fd171542	98	self.FvAddress = self.FvAddress + FvOffset\r
	99	FvAlignValue = self.GetFvAlignValue(FvObj.FvAlignment)\r
	100	if self.FvAddress % FvAlignValue != 0:\r
	101	EdkLogger.error("GenFds", GENFDS_ERROR,\r
	102	"FV (%s) is NOT %s Aligned!" % (FvObj.UiFvName, FvObj.FvAlignment))\r
	103	FvBuffer = StringIO.StringIO('')\r
47fea6af	104	FvBaseAddress = '0x%X' % self.FvAddress\r
6780eef1 LG	105	BlockSize = None\r
6780eef1 LG	106	BlockNum = None\r
fd171542	107	FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r
	108	if FvBuffer.len > Size:\r
	109	FvBuffer.close()\r
	110	EdkLogger.error("GenFds", GENFDS_ERROR,\r
	111	"Size of FV (%s) is larger than Region Size 0x%X specified." % (RegionData, Size))\r
	112	#\r
	113	# Put the generated image into FD buffer.\r
	114	#\r
	115	Buffer.write(FvBuffer.getvalue())\r
	116	FvBuffer.close()\r
	117	FvOffset = FvOffset + FvBuffer.len\r
	118	Size = Size - FvBuffer.len\r
	119	continue\r
	120	else:\r
	121	EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r
	122	#\r
	123	# Add the exist Fv image into FD buffer\r
	124	#\r
	125	if FileName != None:\r
	126	FileLength = os.stat(FileName)[ST_SIZE]\r
	127	if FileLength > Size:\r
30fdf114 LG	128	EdkLogger.error("GenFds", GENFDS_ERROR,\r
	129	"Size of FV File (%s) is larger than Region Size 0x%X specified." \\r
	130	% (RegionData, Size))\r
47fea6af	131	BinFile = open(FileName, 'r+b')\r
fd171542	132	Buffer.write(BinFile.read())\r
	133	BinFile.close()\r
	134	Size = Size - FileLength\r
	135	#\r
	136	# Pad the left buffer\r
	137	#\r
	138	if Size > 0:\r
	139	if (ErasePolarity == '1') :\r
	140	PadData = 0xFF\r
	141	else :\r
	142	PadData = 0\r
	143	for i in range(0, Size):\r
	144	Buffer.write(pack('B', PadData))\r
30fdf114	145	\r
fd171542	146	if self.RegionType == 'CAPSULE':\r
	147	#\r
	148	# Get Capsule from Capsule Dict\r
	149	#\r
	150	for RegionData in self.RegionDataList:\r
	151	if RegionData.endswith(".cap"):\r
	152	RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
47fea6af	153	GenFdsGlobalVariable.InfLogger(' Region CAPSULE Image Name = .cap : %s' % RegionData)\r
fd171542	154	if RegionData[1] != ':' :\r
	155	RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
	156	if not os.path.exists(RegionData):\r
	157	EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
30fdf114	158	\r
fd171542	159	FileName = RegionData\r
	160	elif RegionData.upper() + 'cap' in ImageBinDict.keys():\r
	161	GenFdsGlobalVariable.InfLogger(' Region Name = CAPSULE')\r
	162	FileName = ImageBinDict[RegionData.upper() + 'cap']\r
	163	else:\r
30fdf114	164	#\r
fd171542	165	# Generate Capsule image and Put it into FD buffer\r
30fdf114	166	#\r
fd171542	167	CapsuleObj = None\r
	168	if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.keys():\r
	169	CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[RegionData.upper()]\r
30fdf114	170	\r
fd171542	171	if CapsuleObj != None :\r
	172	CapsuleObj.CapsuleName = RegionData.upper()\r
	173	GenFdsGlobalVariable.InfLogger(' Region Name = CAPSULE')\r
	174	#\r
	175	# Call GenFv tool to generate Capsule Image\r
	176	#\r
	177	FileName = CapsuleObj.GenCapsule()\r
	178	CapsuleObj.CapsuleName = None\r
	179	else:\r
	180	EdkLogger.error("GenFds", GENFDS_ERROR, "Capsule (%s) is NOT described in FDF file!" % (RegionData))\r
30fdf114	181	\r
fd171542	182	#\r
	183	# Add the capsule image into FD buffer\r
	184	#\r
	185	FileLength = os.stat(FileName)[ST_SIZE]\r
	186	if FileLength > Size:\r
	187	EdkLogger.error("GenFds", GENFDS_ERROR,\r
	188	"Size 0x%X of Capsule File (%s) is larger than Region Size 0x%X specified." \\r
	189	% (FileLength, RegionData, Size))\r
47fea6af	190	BinFile = open(FileName, 'r+b')\r
30fdf114	191	Buffer.write(BinFile.read())\r
fd171542	192	BinFile.close()\r
	193	Size = Size - FileLength\r
	194	#\r
	195	# Pad the left buffer\r
	196	#\r
	197	if Size > 0:\r
	198	if (ErasePolarity == '1') :\r
	199	PadData = 0xFF\r
	200	else :\r
	201	PadData = 0\r
	202	for i in range(0, Size):\r
	203	Buffer.write(pack('B', PadData))\r
30fdf114	204	\r
b21a13fb	205	if self.RegionType in ('FILE', 'INF'):\r
30fdf114	206	for RegionData in self.RegionDataList:\r
b21a13fb YZ	207	if self.RegionType == 'INF':\r
	208	RegionData.__InfParse__(None)\r
	209	if len(RegionData.BinFileList) != 1:\r
	210	EdkLogger.error('GenFds', GENFDS_ERROR, 'INF in FD region can only contain one binary: %s' % RegionData)\r
	211	File = RegionData.BinFileList[0]\r
	212	RegionData = RegionData.PatchEfiFile(File.Path, File.Type)\r
	213	else:\r
	214	RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r
	215	if RegionData[1] != ':' :\r
	216	RegionData = os.path.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r
	217	if not os.path.exists(RegionData):\r
	218	EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r
fd171542	219	#\r
	220	# Add the file image into FD buffer\r
	221	#\r
	222	FileLength = os.stat(RegionData)[ST_SIZE]\r
	223	if FileLength > Size:\r
30fdf114	224	EdkLogger.error("GenFds", GENFDS_ERROR,\r
fd171542	225	"Size of File (%s) is larger than Region Size 0x%X specified." \\r
fd171542	226	% (RegionData, Size))\r
47fea6af YZ	227	GenFdsGlobalVariable.InfLogger(' Region File Name = %s' % RegionData)\r
47fea6af YZ	228	BinFile = open(RegionData, 'rb')\r
fd171542	229	Buffer.write(BinFile.read())\r
	230	BinFile.close()\r
	231	Size = Size - FileLength\r
30fdf114	232	#\r
fd171542	233	# Pad the left buffer\r
30fdf114	234	#\r
fd171542	235	if Size > 0:\r
	236	if (ErasePolarity == '1') :\r
	237	PadData = 0xFF\r
	238	else :\r
	239	PadData = 0\r
	240	for i in range(0, Size):\r
	241	Buffer.write(pack('B', PadData))\r
30fdf114 LG	242	\r
	243	if self.RegionType == 'DATA' :\r
	244	GenFdsGlobalVariable.InfLogger(' Region Name = DATA')\r
	245	DataSize = 0\r
	246	for RegionData in self.RegionDataList:\r
	247	Data = RegionData.split(',')\r
	248	DataSize = DataSize + len(Data)\r
	249	if DataSize > Size:\r
	250	EdkLogger.error("GenFds", GENFDS_ERROR, "Size of DATA is larger than Region Size ")\r
	251	else:\r
	252	for item in Data :\r
	253	Buffer.write(pack('B', int(item, 16)))\r
fd171542	254	Size = Size - DataSize\r
	255	#\r
	256	# Pad the left buffer\r
	257	#\r
	258	if Size > 0:\r
	259	if (ErasePolarity == '1') :\r
30fdf114	260	PadData = 0xFF\r
fd171542	261	else :\r
30fdf114	262	PadData = 0\r
fd171542	263	for i in range(0, Size):\r
30fdf114 LG	264	Buffer.write(pack('B', PadData))\r
	265	\r
	266	if self.RegionType == None:\r
	267	GenFdsGlobalVariable.InfLogger(' Region Name = None')\r
	268	if (ErasePolarity == '1') :\r
	269	PadData = 0xFF\r
	270	else :\r
	271	PadData = 0\r
	272	for i in range(0, Size):\r
	273	Buffer.write(pack('B', PadData))\r
	274	\r
	275	def GetFvAlignValue(self, Str):\r
	276	AlignValue = 1\r
	277	Granu = 1\r
	278	Str = Str.strip().upper()\r
	279	if Str.endswith('K'):\r
	280	Granu = 1024\r
	281	Str = Str[:-1]\r
	282	elif Str.endswith('M'):\r
47fea6af	283	Granu = 1024 * 1024\r
30fdf114 LG	284	Str = Str[:-1]\r
30fdf114 LG	285	elif Str.endswith('G'):\r
47fea6af	286	Granu = 1024 * 1024 * 1024\r
30fdf114 LG	287	Str = Str[:-1]\r
	288	else:\r
	289	pass\r
	290	\r
47fea6af	291	AlignValue = int(Str) * Granu\r
30fdf114	292	return AlignValue\r
47fea6af	293	\r
30fdf114 LG	294	## BlockSizeOfRegion()\r
	295	#\r
	296	# @param BlockSizeList List of block information\r
6780eef1	297	# @param FvObj The object for FV\r
30fdf114	298	#\r
6780eef1 LG	299	def BlockInfoOfRegion(self, BlockSizeList, FvObj):\r
	300	Start = 0\r
	301	End = 0\r
	302	RemindingSize = self.Size\r
	303	ExpectedList = []\r
	304	for (BlockSize, BlockNum, pcd) in BlockSizeList:\r
	305	End = Start + BlockSize * BlockNum\r
	306	# region not started yet\r
	307	if self.Offset >= End:\r
	308	Start = End\r
	309	continue\r
	310	# region located in current blocks \r
	311	else:\r
	312	# region ended within current blocks\r
	313	if self.Offset + self.Size <= End:\r
47fea6af	314	ExpectedList.append((BlockSize, (RemindingSize + BlockSize - 1) / BlockSize))\r
6780eef1 LG	315	break\r
	316	# region not ended yet\r
	317	else:\r
	318	# region not started in middle of current blocks\r
	319	if self.Offset <= Start:\r
	320	UsedBlockNum = BlockNum\r
	321	# region started in middle of current blocks\r
	322	else:\r
47fea6af	323	UsedBlockNum = (End - self.Offset) / BlockSize\r
6780eef1 LG	324	Start = End\r
	325	ExpectedList.append((BlockSize, UsedBlockNum))\r
	326	RemindingSize -= BlockSize * UsedBlockNum\r
47fea6af	327	\r
6780eef1 LG	328	if FvObj.BlockSizeList == []:\r
	329	FvObj.BlockSizeList = ExpectedList\r
	330	else:\r
	331	# first check whether FvObj.BlockSizeList items have only "BlockSize" or "NumBlocks",\r
	332	# if so, use ExpectedList\r
	333	for Item in FvObj.BlockSizeList:\r
	334	if Item[0] == None or Item[1] == None:\r
	335	FvObj.BlockSizeList = ExpectedList\r
	336	break\r
	337	# make sure region size is no smaller than the summed block size in FV\r
	338	Sum = 0\r
	339	for Item in FvObj.BlockSizeList:\r
	340	Sum += Item[0] * Item[1]\r
	341	if self.Size < Sum:\r
	342	EdkLogger.error("GenFds", GENFDS_ERROR, "Total Size of FV %s 0x%x is larger than Region Size 0x%x "\r
47fea6af	343	% (FvObj.UiFvName, Sum, self.Size))\r
6780eef1 LG	344	# check whether the BlockStatements in FV section is appropriate\r
	345	ExpectedListData = ''\r
	346	for Item in ExpectedList:\r
47fea6af	347	ExpectedListData += "BlockSize = 0x%x\n\tNumBlocks = 0x%x\n\t" % Item\r
6780eef1 LG	348	Index = 0\r
	349	for Item in FvObj.BlockSizeList:\r
	350	if Item[0] != ExpectedList[Index][0]:\r
	351	EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
47fea6af	352	% FvObj.UiFvName, ExtraData=ExpectedListData)\r
6780eef1 LG	353	elif Item[1] != ExpectedList[Index][1]:\r
	354	if (Item[1] < ExpectedList[Index][1]) and (Index == len(FvObj.BlockSizeList) - 1):\r
	355	break;\r
	356	else:\r
	357	EdkLogger.error("GenFds", GENFDS_ERROR, "BlockStatements of FV %s are not align with FD's, suggested FV BlockStatement"\r
47fea6af	358	% FvObj.UiFvName, ExtraData=ExpectedListData)\r
6780eef1 LG	359	else:\r
6780eef1 LG	360	Index += 1\r
30fdf114	361	\r
6780eef1	362	\r
30fdf114	363	\r