BaseTools: Replace BSD License with BSD+Patent License

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

## @file\r
# process FD 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 . import Region\r
from . import Fv\r
import Common.LongFilePathOs as os\r
from io import BytesIO\r
import sys\r
from struct import *\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
from CommonDataClass.FdfClass import FDClassObject\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
from Common.Misc import SaveFileOnChange\r
from Common.DataType import BINARY_FILE_TYPE_FV\r
\r
## generate FD\r
#\r
#\r
class FD(FDClassObject):\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FDClassObject.__init__(self)\r
\r
    ## GenFd() method\r
    #\r
    #   Generate FD\r
    #\r
    #   @retval string      Generated FD file name\r
    #\r
    def GenFd (self, Flag = False):\r
        if self.FdUiName.upper() + 'fd' in GenFdsGlobalVariable.ImageBinDict:\r
            return GenFdsGlobalVariable.ImageBinDict[self.FdUiName.upper() + 'fd']\r
\r
        #\r
        # Print Information\r
        #\r
        FdFileName = os.path.join(GenFdsGlobalVariable.FvDir, self.FdUiName + '.fd')\r
        if not Flag:\r
            GenFdsGlobalVariable.InfLogger("\nFd File Name:%s (%s)" %(self.FdUiName, FdFileName))\r
\r
        Offset = 0x00\r
        for item in self.BlockSizeList:\r
            Offset = Offset + item[0]  * item[1]\r
        if Offset != self.Size:\r
            EdkLogger.error("GenFds", GENFDS_ERROR, 'FD %s Size not consistent with block array' % self.FdUiName)\r
        GenFdsGlobalVariable.VerboseLogger('Following Fv will be add to Fd !!!')\r
        for FvObj in GenFdsGlobalVariable.FdfParser.Profile.FvDict:\r
            GenFdsGlobalVariable.VerboseLogger(FvObj)\r
\r
        HasCapsuleRegion = False\r
        for RegionObj in self.RegionList:\r
            if RegionObj.RegionType == 'CAPSULE':\r
                HasCapsuleRegion = True\r
                break\r
        if HasCapsuleRegion:\r
            TempFdBuffer = BytesIO()\r
            PreviousRegionStart = -1\r
            PreviousRegionSize = 1\r
\r
            for RegionObj in self.RegionList :\r
                if RegionObj.RegionType == 'CAPSULE':\r
                    continue\r
                if RegionObj.Offset + RegionObj.Size <= PreviousRegionStart:\r
                    pass\r
                elif RegionObj.Offset <= PreviousRegionStart or (RegionObj.Offset >=PreviousRegionStart and RegionObj.Offset < PreviousRegionStart + PreviousRegionSize):\r
                    pass\r
                elif RegionObj.Offset > PreviousRegionStart + PreviousRegionSize:\r
                    if not Flag:\r
                        GenFdsGlobalVariable.InfLogger('Padding region starting from offset 0x%X, with size 0x%X' %(PreviousRegionStart + PreviousRegionSize, RegionObj.Offset - (PreviousRegionStart + PreviousRegionSize)))\r
                    PadRegion = Region.Region()\r
                    PadRegion.Offset = PreviousRegionStart + PreviousRegionSize\r
                    PadRegion.Size = RegionObj.Offset - PadRegion.Offset\r
                    if not Flag:\r
                        PadRegion.AddToBuffer(TempFdBuffer, self.BaseAddress, self.BlockSizeList, self.ErasePolarity, GenFdsGlobalVariable.ImageBinDict, self.DefineVarDict)\r
                PreviousRegionStart = RegionObj.Offset\r
                PreviousRegionSize = RegionObj.Size\r
                #\r
                # Call each region's AddToBuffer function\r
                #\r
                if PreviousRegionSize > self.Size:\r
                    pass\r
                GenFdsGlobalVariable.VerboseLogger('Call each region\'s AddToBuffer function')\r
                RegionObj.AddToBuffer (TempFdBuffer, self.BaseAddress, self.BlockSizeList, self.ErasePolarity, GenFdsGlobalVariable.ImageBinDict, self.DefineVarDict)\r
\r
        FdBuffer = BytesIO()\r
        PreviousRegionStart = -1\r
        PreviousRegionSize = 1\r
        for RegionObj in self.RegionList :\r
            if RegionObj.Offset + RegionObj.Size <= PreviousRegionStart:\r
                EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                'Region offset 0x%X in wrong order with Region starting from 0x%X, size 0x%X\nRegions in FDF must have offsets appear in ascending order.'\\r
                                % (RegionObj.Offset, PreviousRegionStart, PreviousRegionSize))\r
            elif RegionObj.Offset <= PreviousRegionStart or (RegionObj.Offset >=PreviousRegionStart and RegionObj.Offset < PreviousRegionStart + PreviousRegionSize):\r
                EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                'Region offset 0x%X overlaps with Region starting from 0x%X, size 0x%X' \\r
                                % (RegionObj.Offset, PreviousRegionStart, PreviousRegionSize))\r
            elif RegionObj.Offset > PreviousRegionStart + PreviousRegionSize:\r
                if not Flag:\r
                    GenFdsGlobalVariable.InfLogger('Padding region starting from offset 0x%X, with size 0x%X' %(PreviousRegionStart + PreviousRegionSize, RegionObj.Offset - (PreviousRegionStart + PreviousRegionSize)))\r
                PadRegion = Region.Region()\r
                PadRegion.Offset = PreviousRegionStart + PreviousRegionSize\r
                PadRegion.Size = RegionObj.Offset - PadRegion.Offset\r
                if not Flag:\r
                    PadRegion.AddToBuffer(FdBuffer, self.BaseAddress, self.BlockSizeList, self.ErasePolarity, GenFdsGlobalVariable.ImageBinDict, self.DefineVarDict)\r
            PreviousRegionStart = RegionObj.Offset\r
            PreviousRegionSize = RegionObj.Size\r
            #\r
            # Verify current region fits within allocated FD section Size\r
            #\r
            if PreviousRegionStart + PreviousRegionSize > self.Size:\r
                EdkLogger.error("GenFds", GENFDS_ERROR,\r
                                'FD %s size too small to fit region with offset 0x%X and size 0x%X'\r
                                % (self.FdUiName, PreviousRegionStart, PreviousRegionSize))\r
            #\r
            # Call each region's AddToBuffer function\r
            #\r
            GenFdsGlobalVariable.VerboseLogger('Call each region\'s AddToBuffer function')\r
            RegionObj.AddToBuffer (FdBuffer, self.BaseAddress, self.BlockSizeList, self.ErasePolarity, GenFdsGlobalVariable.ImageBinDict, self.DefineVarDict, Flag=Flag)\r
        #\r
        # Write the buffer contents to Fd file\r
        #\r
        GenFdsGlobalVariable.VerboseLogger('Write the buffer contents to Fd file')\r
        if not Flag:\r
            SaveFileOnChange(FdFileName, FdBuffer.getvalue())\r
        FdBuffer.close()\r
        GenFdsGlobalVariable.ImageBinDict[self.FdUiName.upper() + 'fd'] = FdFileName\r
        return FdFileName\r
\r
    ## generate flash map file\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def GenFlashMap (self):\r
        pass\r
\r
\r
\r
\r
\r
\r
\r
\r