]>
git.proxmox.com Git - mirror_edk2.git/blob - BaseTools/Source/Python/GenFds/GuidSection.py
2 # process GUIDed section generation
4 # Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
6 # This program and the accompanying materials
7 # are licensed and made available under the terms and conditions of the BSD License
8 # which accompanies this distribution. The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 from GenFdsGlobalVariable
import GenFdsGlobalVariable
23 from CommonDataClass
.FdfClass
import GuidSectionClassObject
24 from Common
import ToolDefClassObject
26 from Common
import EdkLogger
27 from Common
.BuildToolError
import *
28 from FvImageSection
import FvImageSection
30 ## generate GUIDed section
33 class GuidSection(GuidSectionClassObject
) :
37 # @param self The object pointer
40 GuidSectionClassObject
.__init
__(self
)
42 ## GenSection() method
44 # Generate GUIDed section
46 # @param self The object pointer
47 # @param OutputPath Where to place output file
48 # @param ModuleName Which module this section belongs to
49 # @param SecNum Index of section
50 # @param KeyStringList Filter for inputs of section generation
51 # @param FfsInf FfsInfStatement object that contains this section data
52 # @param Dict dictionary contains macro and its value
53 # @retval tuple (Generated file name, section alignment)
55 def GenSection(self
, OutputPath
, ModuleName
, SecNum
, KeyStringList
, FfsInf
= None, Dict
= {}):
57 # Generate all section
59 self
.KeyStringList
= KeyStringList
60 self
.CurrentArchList
= GenFdsGlobalVariable
.ArchList
62 self
.Alignment
= FfsInf
.__ExtendMacro
__(self
.Alignment
)
63 self
.NameGuid
= FfsInf
.__ExtendMacro
__(self
.NameGuid
)
64 self
.SectionType
= FfsInf
.__ExtendMacro
__(self
.SectionType
)
65 self
.CurrentArchList
= [FfsInf
.CurrentArch
]
76 if self
.ProcessRequired
in ("TRUE", "1"):
78 #no use FvAddr when the image is processed.
80 if self
.FvParentAddr
!= None:
81 #no use Parent Addr when the image is processed.
82 self
.FvParentAddr
= None
84 for Sect
in self
.SectionList
:
86 SecIndex
= '%s.%d' %(SecNum
,Index
)
87 # set base address for inside FvImage
88 if isinstance(Sect
, FvImageSection
):
90 Sect
.FvAddr
= self
.FvAddr
.pop(0)
91 self
.IncludeFvSection
= True
92 elif isinstance(Sect
, GuidSection
):
93 Sect
.FvAddr
= self
.FvAddr
94 Sect
.FvParentAddr
= self
.FvParentAddr
95 ReturnSectList
, align
= Sect
.GenSection(OutputPath
, ModuleName
, SecIndex
, KeyStringList
,FfsInf
, Dict
)
96 if isinstance(Sect
, GuidSection
):
97 if Sect
.IncludeFvSection
:
98 self
.IncludeFvSection
= Sect
.IncludeFvSection
103 if GenFdsGlobalVariable
.GetAlignment (align
) > GenFdsGlobalVariable
.GetAlignment (MaxAlign
):
105 if ReturnSectList
!= []:
108 for file in ReturnSectList
:
110 SectAlign
.append(align
)
113 if self
.Alignment
== None:
114 self
.Alignment
= MaxAlign
116 if GenFdsGlobalVariable
.GetAlignment (MaxAlign
) > GenFdsGlobalVariable
.GetAlignment (self
.Alignment
):
117 self
.Alignment
= MaxAlign
119 OutputFile
= OutputPath
+ \
124 Ffs
.SectionSuffix
['GUIDED']
125 OutputFile
= os
.path
.normpath(OutputFile
)
128 ExternalOption
= None
129 if self
.NameGuid
!= None:
130 ExternalTool
, ExternalOption
= self
.__FindExtendTool
__()
133 # If not have GUID , call default
136 if self
.NameGuid
== None :
137 GenFdsGlobalVariable
.VerboseLogger( "Use GenSection function Generate CRC32 Section")
138 GenFdsGlobalVariable
.GenerateSection(OutputFile
, SectFile
, Section
.Section
.SectionType
[self
.SectionType
], InputAlign
=SectAlign
)
140 OutputFileList
.append(OutputFile
)
141 return OutputFileList
, self
.Alignment
142 #or GUID not in External Tool List
143 elif ExternalTool
== None:
144 EdkLogger
.error("GenFds", GENFDS_ERROR
, "No tool found with GUID %s" % self
.NameGuid
)
146 DummyFile
= OutputFile
+".dummy"
148 # Call GenSection with DUMMY section type.
150 GenFdsGlobalVariable
.GenerateSection(DummyFile
, SectFile
, InputAlign
=SectAlign
)
152 # Use external tool process the Output
154 TempFile
= OutputPath
+ \
160 TempFile
= os
.path
.normpath(TempFile
)
164 if ExternalOption
!= None:
165 CmdOption
= CmdOption
+ ' ' + ExternalOption
166 if self
.ProcessRequired
not in ("TRUE", "1") and self
.IncludeFvSection
and not FvAddrIsSet
and self
.FvParentAddr
!= None:
167 #FirstCall is only set for the encapsulated flash FV image without process required attribute.
174 #first try to call the guided tool with -z option and CmdOption for the no process required guided tool.
175 GenFdsGlobalVariable
.GuidTool(TempFile
, [DummyFile
], ExternalTool
, '-z' + ' ' + CmdOption
, ReturnValue
)
178 # when no call or first call failed, ReturnValue are not 1.
179 # Call the guided tool with CmdOption
181 if ReturnValue
[0] != 0:
184 GenFdsGlobalVariable
.GuidTool(TempFile
, [DummyFile
], ExternalTool
, CmdOption
)
186 FileHandleIn
= open(DummyFile
,'rb')
187 FileHandleIn
.seek(0,2)
188 InputFileSize
= FileHandleIn
.tell()
190 FileHandleOut
= open(TempFile
,'rb')
191 FileHandleOut
.seek(0,2)
192 TempFileSize
= FileHandleOut
.tell()
196 if self
.ProcessRequired
== "NONE":
197 if TempFileSize
> InputFileSize
and TempFileSize
% 4 == 0:
199 BufferIn
= FileHandleIn
.read()
200 FileHandleOut
.seek(0)
201 BufferOut
= FileHandleOut
.read()
202 if BufferIn
== BufferOut
[TempFileSize
- InputFileSize
:]:
203 HeaderLength
= str(TempFileSize
- InputFileSize
)
204 #auto sec guided attribute with process required
205 if HeaderLength
== None:
206 Attribute
.append('PROCESSING_REQUIRED')
209 FileHandleOut
.close()
211 if FirstCall
and 'PROCESSING_REQUIRED' in Attribute
:
212 # Guided data by -z option on first call is the process required data. Call the guided tool with the real option.
213 GenFdsGlobalVariable
.GuidTool(TempFile
, [DummyFile
], ExternalTool
, CmdOption
)
216 # Call Gensection Add Section Header
218 if self
.ProcessRequired
in ("TRUE", "1"):
219 if 'PROCESSING_REQUIRED' not in Attribute
:
220 Attribute
.append('PROCESSING_REQUIRED')
222 if self
.AuthStatusValid
in ("TRUE", "1"):
223 Attribute
.append('AUTH_STATUS_VALID')
224 GenFdsGlobalVariable
.GenerateSection(OutputFile
, [TempFile
], Section
.Section
.SectionType
['GUIDED'],
225 Guid
=self
.NameGuid
, GuidAttr
=Attribute
, GuidHdrLen
=HeaderLength
)
227 OutputFileList
.append(OutputFile
)
228 if 'PROCESSING_REQUIRED' in Attribute
:
229 # reset guided section alignment to none for the processed required guided data
230 self
.Alignment
= None
231 self
.IncludeFvSection
= False
232 self
.ProcessRequired
= "TRUE"
233 return OutputFileList
, self
.Alignment
235 ## __FindExtendTool()
237 # Find location of tools to process section data
239 # @param self The object pointer
241 def __FindExtendTool__(self
):
242 # if user not specify filter, try to deduce it from global data.
243 if self
.KeyStringList
== None or self
.KeyStringList
== []:
244 Target
= GenFdsGlobalVariable
.TargetName
245 ToolChain
= GenFdsGlobalVariable
.ToolChainTag
246 ToolDb
= ToolDefClassObject
.ToolDefDict(GenFdsGlobalVariable
.WorkSpaceDir
).ToolsDefTxtDatabase
247 if ToolChain
not in ToolDb
['TOOL_CHAIN_TAG']:
248 EdkLogger
.error("GenFds", GENFDS_ERROR
, "Can not find external tool because tool tag %s is not defined in tools_def.txt!" % ToolChain
)
249 self
.KeyStringList
= [Target
+'_'+ToolChain
+'_'+self
.CurrentArchList
[0]]
250 for Arch
in self
.CurrentArchList
:
251 if Target
+'_'+ToolChain
+'_'+Arch
not in self
.KeyStringList
:
252 self
.KeyStringList
.append(Target
+'_'+ToolChain
+'_'+Arch
)
254 ToolDefinition
= ToolDefClassObject
.ToolDefDict(GenFdsGlobalVariable
.WorkSpaceDir
).ToolsDefTxtDictionary
256 for ToolDef
in ToolDefinition
.items():
257 if self
.NameGuid
== ToolDef
[1]:
258 KeyList
= ToolDef
[0].split('_')
264 if Key
in self
.KeyStringList
and KeyList
[4] == 'GUID':
266 ToolPath
= ToolDefinition
.get( Key
+ \
272 ToolOption
= ToolDefinition
.get( Key
+ \
277 if ToolPathTmp
== None:
278 ToolPathTmp
= ToolPath
280 if ToolPathTmp
!= ToolPath
:
281 EdkLogger
.error("GenFds", GENFDS_ERROR
, "Don't know which tool to use, %s or %s ?" % (ToolPathTmp
, ToolPath
))
284 return ToolPathTmp
, ToolOption