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

## @file\r
# process FV image section 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 Section\r
from io import BytesIO\r
from .Ffs import SectionSuffix\r
import subprocess\r
from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
import Common.LongFilePathOs as os\r
from CommonDataClass.FdfClass import FvImageSectionClassObject\r
from Common.MultipleWorkspace import MultipleWorkspace as mws\r
from Common import EdkLogger\r
from Common.BuildToolError import *\r
from Common.DataType import *\r
\r
## generate FV image section\r
#\r
#\r
class FvImageSection(FvImageSectionClassObject):\r
\r
    ## The constructor\r
    #\r
    #   @param  self        The object pointer\r
    #\r
    def __init__(self):\r
        FvImageSectionClassObject.__init__(self)\r
\r
    ## GenSection() method\r
    #\r
    #   Generate FV image section\r
    #\r
    #   @param  self        The object pointer\r
    #   @param  OutputPath  Where to place output file\r
    #   @param  ModuleName  Which module this section belongs to\r
    #   @param  SecNum      Index of section\r
    #   @param  KeyStringList  Filter for inputs of section generation\r
    #   @param  FfsInf      FfsInfStatement object that contains this section data\r
    #   @param  Dict        dictionary contains macro and its value\r
    #   @retval tuple       (Generated file name, section alignment)\r
    #\r
    def GenSection(self, OutputPath, ModuleName, SecNum, KeyStringList, FfsInf = None, Dict = None, IsMakefile = False):\r
\r
        OutputFileList = []\r
        if Dict is None:\r
            Dict = {}\r
        if self.FvFileType is not None:\r
            FileList, IsSect = Section.Section.GetFileList(FfsInf, self.FvFileType, self.FvFileExtension)\r
            if IsSect :\r
                return FileList, self.Alignment\r
\r
            Num = SecNum\r
\r
            MaxFvAlignment = 0\r
            for FvFileName in FileList:\r
                FvAlignmentValue = 0\r
                if os.path.isfile(FvFileName):\r
                    FvFileObj = open (FvFileName, 'rb')\r
                    FvFileObj.seek(0)\r
                    # PI FvHeader is 0x48 byte\r
                    FvHeaderBuffer = FvFileObj.read(0x48)\r
                    # FV alignment position.\r
                    if isinstance(FvHeaderBuffer[0x2E], str):\r
                        FvAlignmentValue = 1 << (ord(FvHeaderBuffer[0x2E]) & 0x1F)\r
                    else:\r
                        FvAlignmentValue = 1 << (FvHeaderBuffer[0x2E] & 0x1F)\r
                    FvFileObj.close()\r
                if FvAlignmentValue > MaxFvAlignment:\r
                    MaxFvAlignment = FvAlignmentValue\r
\r
                OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + Num + SectionSuffix.get("FV_IMAGE"))\r
                GenFdsGlobalVariable.GenerateSection(OutputFile, [FvFileName], 'EFI_SECTION_FIRMWARE_VOLUME_IMAGE', IsMakefile=IsMakefile)\r
                OutputFileList.append(OutputFile)\r
\r
            # MaxFvAlignment is larger than or equal to 1K\r
            if MaxFvAlignment >= 0x400:\r
                if MaxFvAlignment >= 0x100000:\r
                    #The max alignment supported by FFS is 16M.\r
                    if MaxFvAlignment >= 0x1000000:\r
                        self.Alignment = "16M"\r
                    else:\r
                        self.Alignment = str(MaxFvAlignment // 0x100000) + "M"\r
                else:\r
                    self.Alignment = str (MaxFvAlignment // 0x400) + "K"\r
            else:\r
                # MaxFvAlignment is less than 1K\r
                self.Alignment = str (MaxFvAlignment)\r
\r
            return OutputFileList, self.Alignment\r
        #\r
        # Generate Fv\r
        #\r
        if self.FvName is not None:\r
            Buffer = BytesIO()\r
            Fv = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName)\r
            if Fv is not None:\r
                self.Fv = Fv\r
                if not self.FvAddr and self.Fv.BaseAddress:\r
                    self.FvAddr = self.Fv.BaseAddress\r
                FvFileName = Fv.AddToBuffer(Buffer, self.FvAddr, MacroDict = Dict, Flag=IsMakefile)\r
                if Fv.FvAlignment is not None:\r
                    if self.Alignment is None:\r
                        self.Alignment = Fv.FvAlignment\r
                    else:\r
                        if GenFdsGlobalVariable.GetAlignment (Fv.FvAlignment) > GenFdsGlobalVariable.GetAlignment (self.Alignment):\r
                            self.Alignment = Fv.FvAlignment\r
            else:\r
                if self.FvFileName is not None:\r
                    FvFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FvFileName)\r
                    if os.path.isfile(FvFileName):\r
                        FvFileObj = open (FvFileName, 'rb')\r
                        FvFileObj.seek(0)\r
                        # PI FvHeader is 0x48 byte\r
                        FvHeaderBuffer = FvFileObj.read(0x48)\r
                        # FV alignment position.\r
                        if isinstance(FvHeaderBuffer[0x2E], str):\r
                            FvAlignmentValue = 1 << (ord(FvHeaderBuffer[0x2E]) & 0x1F)\r
                        else:\r
                            FvAlignmentValue = 1 << (FvHeaderBuffer[0x2E] & 0x1F)\r
                        # FvAlignmentValue is larger than or equal to 1K\r
                        if FvAlignmentValue >= 0x400:\r
                            if FvAlignmentValue >= 0x100000:\r
                                #The max alignment supported by FFS is 16M.\r
                                if FvAlignmentValue >= 0x1000000:\r
                                    self.Alignment = "16M"\r
                                else:\r
                                    self.Alignment = str(FvAlignmentValue // 0x100000) + "M"\r
                            else:\r
                                self.Alignment = str (FvAlignmentValue // 0x400) + "K"\r
                        else:\r
                            # FvAlignmentValue is less than 1K\r
                            self.Alignment = str (FvAlignmentValue)\r
                        FvFileObj.close()\r
                    else:\r
                        if len (mws.getPkgPath()) == 0:\r
                            EdkLogger.error("GenFds", FILE_NOT_FOUND, "%s is not found in WORKSPACE: %s" % self.FvFileName, GenFdsGlobalVariable.WorkSpaceDir)\r
                        else:\r
                            EdkLogger.error("GenFds", FILE_NOT_FOUND, "%s is not found in packages path:\n\t%s" % (self.FvFileName, '\n\t'.join(mws.getPkgPath())))\r
\r
                else:\r
                    EdkLogger.error("GenFds", GENFDS_ERROR, "FvImageSection Failed! %s NOT found in FDF" % self.FvName)\r
\r
            #\r
            # Prepare the parameter of GenSection\r
            #\r
            OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + SecNum + SectionSuffix.get("FV_IMAGE"))\r
            GenFdsGlobalVariable.GenerateSection(OutputFile, [FvFileName], 'EFI_SECTION_FIRMWARE_VOLUME_IMAGE', IsMakefile=IsMakefile)\r
            OutputFileList.append(OutputFile)\r
\r
            return OutputFileList, self.Alignment\r
Commit	Line	Data
	1	## @file\r
	2	# process FV image section generation\r
	3	#\r
	4	# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
	5	#\r
	6	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
	7	#\r
	8	\r
	9	##\r
	10	# Import Modules\r
	11	#\r
	12	from __future__ import absolute_import\r
	13	from . import Section\r
	14	from io import BytesIO\r
	15	from .Ffs import SectionSuffix\r
	16	import subprocess\r
	17	from .GenFdsGlobalVariable import GenFdsGlobalVariable\r
	18	import Common.LongFilePathOs as os\r
	19	from CommonDataClass.FdfClass import FvImageSectionClassObject\r
	20	from Common.MultipleWorkspace import MultipleWorkspace as mws\r
	21	from Common import EdkLogger\r
	22	from Common.BuildToolError import *\r
	23	from Common.DataType import *\r
	24	\r
	25	## generate FV image section\r
	26	#\r
	27	#\r
	28	class FvImageSection(FvImageSectionClassObject):\r
	29	\r
	30	## The constructor\r
	31	#\r
	32	# @param self The object pointer\r
	33	#\r
	34	def __init__(self):\r
	35	FvImageSectionClassObject.__init__(self)\r
	36	\r
	37	## GenSection() method\r
	38	#\r
	39	# Generate FV image section\r
	40	#\r
	41	# @param self The object pointer\r
	42	# @param OutputPath Where to place output file\r
	43	# @param ModuleName Which module this section belongs to\r
	44	# @param SecNum Index of section\r
	45	# @param KeyStringList Filter for inputs of section generation\r
	46	# @param FfsInf FfsInfStatement object that contains this section data\r
	47	# @param Dict dictionary contains macro and its value\r
	48	# @retval tuple (Generated file name, section alignment)\r
	49	#\r
	50	def GenSection(self, OutputPath, ModuleName, SecNum, KeyStringList, FfsInf = None, Dict = None, IsMakefile = False):\r
	51	\r
	52	OutputFileList = []\r
	53	if Dict is None:\r
	54	Dict = {}\r
	55	if self.FvFileType is not None:\r
	56	FileList, IsSect = Section.Section.GetFileList(FfsInf, self.FvFileType, self.FvFileExtension)\r
	57	if IsSect :\r
	58	return FileList, self.Alignment\r
	59	\r
	60	Num = SecNum\r
	61	\r
	62	MaxFvAlignment = 0\r
	63	for FvFileName in FileList:\r
	64	FvAlignmentValue = 0\r
	65	if os.path.isfile(FvFileName):\r
	66	FvFileObj = open (FvFileName, 'rb')\r
	67	FvFileObj.seek(0)\r
	68	# PI FvHeader is 0x48 byte\r
	69	FvHeaderBuffer = FvFileObj.read(0x48)\r
	70	# FV alignment position.\r
	71	if isinstance(FvHeaderBuffer[0x2E], str):\r
	72	FvAlignmentValue = 1 << (ord(FvHeaderBuffer[0x2E]) & 0x1F)\r
	73	else:\r
	74	FvAlignmentValue = 1 << (FvHeaderBuffer[0x2E] & 0x1F)\r
	75	FvFileObj.close()\r
	76	if FvAlignmentValue > MaxFvAlignment:\r
	77	MaxFvAlignment = FvAlignmentValue\r
	78	\r
	79	OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + Num + SectionSuffix.get("FV_IMAGE"))\r
	80	GenFdsGlobalVariable.GenerateSection(OutputFile, [FvFileName], 'EFI_SECTION_FIRMWARE_VOLUME_IMAGE', IsMakefile=IsMakefile)\r
	81	OutputFileList.append(OutputFile)\r
	82	\r
	83	# MaxFvAlignment is larger than or equal to 1K\r
	84	if MaxFvAlignment >= 0x400:\r
	85	if MaxFvAlignment >= 0x100000:\r
	86	#The max alignment supported by FFS is 16M.\r
	87	if MaxFvAlignment >= 0x1000000:\r
	88	self.Alignment = "16M"\r
	89	else:\r
	90	self.Alignment = str(MaxFvAlignment // 0x100000) + "M"\r
	91	else:\r
	92	self.Alignment = str (MaxFvAlignment // 0x400) + "K"\r
	93	else:\r
	94	# MaxFvAlignment is less than 1K\r
	95	self.Alignment = str (MaxFvAlignment)\r
	96	\r
	97	return OutputFileList, self.Alignment\r
	98	#\r
	99	# Generate Fv\r
	100	#\r
	101	if self.FvName is not None:\r
	102	Buffer = BytesIO()\r
	103	Fv = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(self.FvName)\r
	104	if Fv is not None:\r
	105	self.Fv = Fv\r
	106	if not self.FvAddr and self.Fv.BaseAddress:\r
	107	self.FvAddr = self.Fv.BaseAddress\r
	108	FvFileName = Fv.AddToBuffer(Buffer, self.FvAddr, MacroDict = Dict, Flag=IsMakefile)\r
	109	if Fv.FvAlignment is not None:\r
	110	if self.Alignment is None:\r
	111	self.Alignment = Fv.FvAlignment\r
	112	else:\r
	113	if GenFdsGlobalVariable.GetAlignment (Fv.FvAlignment) > GenFdsGlobalVariable.GetAlignment (self.Alignment):\r
	114	self.Alignment = Fv.FvAlignment\r
	115	else:\r
	116	if self.FvFileName is not None:\r
	117	FvFileName = GenFdsGlobalVariable.ReplaceWorkspaceMacro(self.FvFileName)\r
	118	if os.path.isfile(FvFileName):\r
	119	FvFileObj = open (FvFileName, 'rb')\r
	120	FvFileObj.seek(0)\r
	121	# PI FvHeader is 0x48 byte\r
	122	FvHeaderBuffer = FvFileObj.read(0x48)\r
	123	# FV alignment position.\r
	124	if isinstance(FvHeaderBuffer[0x2E], str):\r
	125	FvAlignmentValue = 1 << (ord(FvHeaderBuffer[0x2E]) & 0x1F)\r
	126	else:\r
	127	FvAlignmentValue = 1 << (FvHeaderBuffer[0x2E] & 0x1F)\r
	128	# FvAlignmentValue is larger than or equal to 1K\r
	129	if FvAlignmentValue >= 0x400:\r
	130	if FvAlignmentValue >= 0x100000:\r
	131	#The max alignment supported by FFS is 16M.\r
	132	if FvAlignmentValue >= 0x1000000:\r
	133	self.Alignment = "16M"\r
	134	else:\r
	135	self.Alignment = str(FvAlignmentValue // 0x100000) + "M"\r
	136	else:\r
	137	self.Alignment = str (FvAlignmentValue // 0x400) + "K"\r
	138	else:\r
	139	# FvAlignmentValue is less than 1K\r
	140	self.Alignment = str (FvAlignmentValue)\r
	141	FvFileObj.close()\r
	142	else:\r
	143	if len (mws.getPkgPath()) == 0:\r
	144	EdkLogger.error("GenFds", FILE_NOT_FOUND, "%s is not found in WORKSPACE: %s" % self.FvFileName, GenFdsGlobalVariable.WorkSpaceDir)\r
	145	else:\r
	146	EdkLogger.error("GenFds", FILE_NOT_FOUND, "%s is not found in packages path:\n\t%s" % (self.FvFileName, '\n\t'.join(mws.getPkgPath())))\r
	147	\r
	148	else:\r
	149	EdkLogger.error("GenFds", GENFDS_ERROR, "FvImageSection Failed! %s NOT found in FDF" % self.FvName)\r
	150	\r
	151	#\r
	152	# Prepare the parameter of GenSection\r
	153	#\r
	154	OutputFile = os.path.join(OutputPath, ModuleName + SUP_MODULE_SEC + SecNum + SectionSuffix.get("FV_IMAGE"))\r
	155	GenFdsGlobalVariable.GenerateSection(OutputFile, [FvFileName], 'EFI_SECTION_FIRMWARE_VOLUME_IMAGE', IsMakefile=IsMakefile)\r
	156	OutputFileList.append(OutputFile)\r
	157	\r
	158	return OutputFileList, self.Alignment\r