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