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

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