2 # process FV generation
4 # Copyright (c) 2007 - 2016, 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.
18 import Common
.LongFilePathOs
as os
25 from GenFdsGlobalVariable
import GenFdsGlobalVariable
26 from GenFds
import GenFds
27 from CommonDataClass
.FdfClass
import FvClassObject
28 from Common
.Misc
import SaveFileOnChange
29 from Common
.LongFilePathSupport
import CopyLongFilePath
30 from Common
.LongFilePathSupport
import OpenLongFilePath
as open
33 FV_UI_EXT_ENTY_GUID
= 'A67DF1FA-8DE8-4E98-AF09-4BDF2EFFBC7C'
38 class FV (FvClassObject
):
41 # @param self The object pointer
44 FvClassObject
.__init
__(self
)
46 self
.FvAddressFile
= None
47 self
.BaseAddress
= None
48 self
.InfFileName
= None
49 self
.FvAddressFileName
= None
50 self
.CapsuleName
= None
51 self
.FvBaseAddress
= None
52 self
.FvForceRebase
= None
56 # Generate Fv and add it to the Buffer
58 # @param self The object pointer
59 # @param Buffer The buffer generated FV data will be put
60 # @param BaseAddress base address of FV
61 # @param BlockSize block size of FV
62 # @param BlockNum How many blocks in FV
63 # @param ErasePolarity Flash erase polarity
64 # @param VtfDict VTF objects
65 # @param MacroDict macro value pair
66 # @retval string Generated FV file path
68 def AddToBuffer (self
, Buffer
, BaseAddress
=None, BlockSize
= None, BlockNum
=None, ErasePloarity
='1', VtfDict
=None, MacroDict
= {}) :
70 if BaseAddress
== None and self
.UiFvName
.upper() + 'fv' in GenFds
.ImageBinDict
.keys():
71 return GenFds
.ImageBinDict
[self
.UiFvName
.upper() + 'fv']
74 # Check whether FV in Capsule is in FD flash region.
75 # If yes, return error. Doesn't support FV in Capsule image is also in FD flash region.
77 if self
.CapsuleName
!= None:
78 for FdName
in GenFdsGlobalVariable
.FdfParser
.Profile
.FdDict
.keys():
79 FdObj
= GenFdsGlobalVariable
.FdfParser
.Profile
.FdDict
[FdName
]
80 for RegionObj
in FdObj
.RegionList
:
81 if RegionObj
.RegionType
== 'FV':
82 for RegionData
in RegionObj
.RegionDataList
:
83 if RegionData
.endswith(".fv"):
85 elif RegionData
.upper() + 'fv' in GenFds
.ImageBinDict
.keys():
87 elif self
.UiFvName
.upper() == RegionData
.upper():
88 GenFdsGlobalVariable
.ErrorLogger("Capsule %s in FD region can't contain a FV %s in FD region." % (self
.CapsuleName
, self
.UiFvName
.upper()))
90 GenFdsGlobalVariable
.InfLogger( "\nGenerating %s FV" %self
.UiFvName
)
91 GenFdsGlobalVariable
.LargeFileInFvFlags
.append(False)
94 if self
.FvBaseAddress
!= None:
95 BaseAddress
= self
.FvBaseAddress
97 self
.__InitializeInf
__(BaseAddress
, BlockSize
, BlockNum
, ErasePloarity
, VtfDict
)
99 # First Process the Apriori section
101 MacroDict
.update(self
.DefineVarDict
)
103 GenFdsGlobalVariable
.VerboseLogger('First generate Apriori file !')
105 for AprSection
in self
.AprioriSectionList
:
106 FileName
= AprSection
.GenFfs (self
.UiFvName
, MacroDict
)
107 FfsFileList
.append(FileName
)
108 # Add Apriori file name to Inf file
109 self
.FvInfFile
.writelines("EFI_FILE_NAME = " + \
113 # Process Modules in FfsList
114 for FfsFile
in self
.FfsList
:
115 FileName
= FfsFile
.GenFfs(MacroDict
, FvParentAddr
=BaseAddress
)
116 FfsFileList
.append(FileName
)
117 self
.FvInfFile
.writelines("EFI_FILE_NAME = " + \
121 SaveFileOnChange(self
.InfFileName
, self
.FvInfFile
.getvalue(), False)
122 self
.FvInfFile
.close()
126 FvOutputFile
= os
.path
.join(GenFdsGlobalVariable
.FvDir
, self
.UiFvName
)
127 FvOutputFile
= FvOutputFile
+ '.Fv'
128 # BUGBUG: FvOutputFile could be specified from FDF file (FV section, CreateFile statement)
129 if self
.CreateFileName
!= None:
130 FvOutputFile
= self
.CreateFileName
132 FvInfoFileName
= os
.path
.join(GenFdsGlobalVariable
.FfsDir
, self
.UiFvName
+ '.inf')
133 CopyLongFilePath(GenFdsGlobalVariable
.FvAddressFileName
, FvInfoFileName
)
135 if os
.path
.exists (FvInfoFileName
):
136 OrigFvInfo
= open(FvInfoFileName
, 'r').read()
137 if GenFdsGlobalVariable
.LargeFileInFvFlags
[-1]:
138 FFSGuid
= GenFdsGlobalVariable
.EFI_FIRMWARE_FILE_SYSTEM3_GUID
;
139 GenFdsGlobalVariable
.GenerateFirmwareVolume(
142 AddressFile
=FvInfoFileName
,
144 ForceRebase
=self
.FvForceRebase
,
145 FileSystemGuid
=FFSGuid
149 if os
.path
.exists (FvInfoFileName
):
150 NewFvInfo
= open(FvInfoFileName
, 'r').read()
151 if NewFvInfo
!= None and NewFvInfo
!= OrigFvInfo
:
153 AddFileObj
= open(FvInfoFileName
, 'r')
154 AddrStrings
= AddFileObj
.readlines()
156 for AddrString
in AddrStrings
:
158 #get base address for the inside FvImage
159 FvChildAddr
.append (AddrString
)
160 elif AddrString
.find ("[FV_BASE_ADDRESS]") != -1:
164 if FvChildAddr
!= []:
166 for FfsFile
in self
.FfsList
:
167 FileName
= FfsFile
.GenFfs(MacroDict
, FvChildAddr
, BaseAddress
)
169 if GenFdsGlobalVariable
.LargeFileInFvFlags
[-1]:
170 FFSGuid
= GenFdsGlobalVariable
.EFI_FIRMWARE_FILE_SYSTEM3_GUID
;
172 GenFdsGlobalVariable
.GenerateFirmwareVolume(
175 AddressFile
=FvInfoFileName
,
177 ForceRebase
=self
.FvForceRebase
,
178 FileSystemGuid
=FFSGuid
182 # Write the Fv contents to Buffer
184 if os
.path
.isfile(FvOutputFile
):
185 FvFileObj
= open ( FvOutputFile
,'r+b')
187 GenFdsGlobalVariable
.VerboseLogger( "\nGenerate %s FV Successfully" %self
.UiFvName
)
188 GenFdsGlobalVariable
.SharpCounter
= 0
190 Buffer
.write(FvFileObj
.read())
192 # PI FvHeader is 0x48 byte
193 FvHeaderBuffer
= FvFileObj
.read(0x48)
194 # FV alignment position.
195 FvAlignmentValue
= 1 << (ord (FvHeaderBuffer
[0x2E]) & 0x1F)
196 # FvAlignmentValue is larger than or equal to 1K
197 if FvAlignmentValue
>= 0x400:
198 if FvAlignmentValue
>= 0x10000:
199 #The max alignment supported by FFS is 64K.
200 self
.FvAlignment
= "64K"
202 self
.FvAlignment
= str (FvAlignmentValue
/ 0x400) + "K"
204 # FvAlignmentValue is less than 1K
205 self
.FvAlignment
= str (FvAlignmentValue
)
207 GenFds
.ImageBinDict
[self
.UiFvName
.upper() + 'fv'] = FvOutputFile
208 GenFdsGlobalVariable
.LargeFileInFvFlags
.pop()
210 GenFdsGlobalVariable
.ErrorLogger("Failed to generate %s FV file." %self
.UiFvName
)
215 # Calculate FV's block size
216 # Inherit block size from FD if no block size specified in FV
218 def _GetBlockSize(self
):
219 if self
.BlockSizeList
:
222 for FdName
in GenFdsGlobalVariable
.FdfParser
.Profile
.FdDict
.keys():
223 FdObj
= GenFdsGlobalVariable
.FdfParser
.Profile
.FdDict
[FdName
]
224 for RegionObj
in FdObj
.RegionList
:
225 if RegionObj
.RegionType
!= 'FV':
227 for RegionData
in RegionObj
.RegionDataList
:
229 # Found the FD and region that contain this FV
231 if self
.UiFvName
.upper() == RegionData
.upper():
232 RegionObj
.BlockInfoOfRegion(FdObj
.BlockSizeList
, self
)
233 if self
.BlockSizeList
:
237 ## __InitializeInf__()
239 # Initilize the inf file to create FV
241 # @param self The object pointer
242 # @param BaseAddress base address of FV
243 # @param BlockSize block size of FV
244 # @param BlockNum How many blocks in FV
245 # @param ErasePolarity Flash erase polarity
246 # @param VtfDict VTF objects
248 def __InitializeInf__ (self
, BaseAddress
= None, BlockSize
= None, BlockNum
= None, ErasePloarity
='1', VtfDict
=None) :
252 self
.InfFileName
= os
.path
.join(GenFdsGlobalVariable
.FvDir
,
253 self
.UiFvName
+ '.inf')
254 self
.FvInfFile
= StringIO
.StringIO()
259 self
.FvInfFile
.writelines("[options]" + T_CHAR_LF
)
260 if BaseAddress
!= None :
261 self
.FvInfFile
.writelines("EFI_BASE_ADDRESS = " + \
265 if BlockSize
!= None:
266 self
.FvInfFile
.writelines("EFI_BLOCK_SIZE = " + \
267 '0x%X' %BlockSize
+ \
270 self
.FvInfFile
.writelines("EFI_NUM_BLOCKS = " + \
271 ' 0x%X' %BlockNum
+ \
274 if self
.BlockSizeList
== []:
275 if not self
._GetBlockSize
():
276 #set default block size is 1
277 self
.FvInfFile
.writelines("EFI_BLOCK_SIZE = 0x1" + T_CHAR_LF
)
279 for BlockSize
in self
.BlockSizeList
:
280 if BlockSize
[0] != None:
281 self
.FvInfFile
.writelines("EFI_BLOCK_SIZE = " + \
282 '0x%X' %BlockSize
[0] + \
285 if BlockSize
[1] != None:
286 self
.FvInfFile
.writelines("EFI_NUM_BLOCKS = " + \
287 ' 0x%X' %BlockSize
[1] + \
290 if self
.BsBaseAddress
!= None:
291 self
.FvInfFile
.writelines('EFI_BOOT_DRIVER_BASE_ADDRESS = ' + \
292 '0x%X' %self
.BsBaseAddress
)
293 if self
.RtBaseAddress
!= None:
294 self
.FvInfFile
.writelines('EFI_RUNTIME_DRIVER_BASE_ADDRESS = ' + \
295 '0x%X' %self
.RtBaseAddress
)
299 self
.FvInfFile
.writelines("[attributes]" + T_CHAR_LF
)
301 self
.FvInfFile
.writelines("EFI_ERASE_POLARITY = " + \
302 ' %s' %ErasePloarity
+ \
304 if not (self
.FvAttributeDict
== None):
305 for FvAttribute
in self
.FvAttributeDict
.keys() :
306 self
.FvInfFile
.writelines("EFI_" + \
309 self
.FvAttributeDict
[FvAttribute
] + \
311 if self
.FvAlignment
!= None:
312 self
.FvInfFile
.writelines("EFI_FVB2_ALIGNMENT_" + \
313 self
.FvAlignment
.strip() + \
318 # Generate FV extension header file
320 if self
.FvNameGuid
== None or self
.FvNameGuid
== '':
321 if len(self
.FvExtEntryType
) > 0:
322 GenFdsGlobalVariable
.ErrorLogger("FV Extension Header Entries declared for %s with no FvNameGuid declaration." % (self
.UiFvName
))
324 if self
.FvNameGuid
<> None and self
.FvNameGuid
<> '':
327 if self
.FvNameString
== 'TRUE':
329 # Create EXT entry for FV UI name
330 # This GUID is used: A67DF1FA-8DE8-4E98-AF09-4BDF2EFFBC7C
332 FvUiLen
= len(self
.UiFvName
)
333 TotalSize
+= (FvUiLen
+ 16 + 4)
334 Guid
= FV_UI_EXT_ENTY_GUID
.split('-')
337 # EFI_FIRMWARE_VOLUME_EXT_ENTRY : size 4
341 Buffer
+= (pack('HH', (FvUiLen
+ 16 + 4), 0x0002)
342 + pack('=LHHBBBBBBBB', int(Guid
[0], 16), int(Guid
[1], 16), int(Guid
[2], 16),
343 int(Guid
[3][-4:-2], 16), int(Guid
[3][-2:], 16), int(Guid
[4][-12:-10], 16),
344 int(Guid
[4][-10:-8], 16), int(Guid
[4][-8:-6], 16), int(Guid
[4][-6:-4], 16),
345 int(Guid
[4][-4:-2], 16), int(Guid
[4][-2:], 16))
348 for Index
in range (0, len(self
.FvExtEntryType
)):
349 if self
.FvExtEntryType
[Index
] == 'FILE':
350 # check if the path is absolute or relative
351 if os
.path
.isabs(self
.FvExtEntryData
[Index
]):
352 FileFullPath
= os
.path
.normpath(self
.FvExtEntryData
[Index
])
354 FileFullPath
= os
.path
.normpath(os
.path
.join(GenFdsGlobalVariable
.WorkSpaceDir
, self
.FvExtEntryData
[Index
]))
355 # check if the file path exists or not
356 if not os
.path
.isfile(FileFullPath
):
357 GenFdsGlobalVariable
.ErrorLogger("Error opening FV Extension Header Entry file %s." % (self
.FvExtEntryData
[Index
]))
358 FvExtFile
= open (FileFullPath
,'rb')
360 Size
= FvExtFile
.tell()
362 GenFdsGlobalVariable
.ErrorLogger("The size of FV Extension Header Entry file %s exceeds 0x10000." % (self
.FvExtEntryData
[Index
]))
363 TotalSize
+= (Size
+ 4)
365 Buffer
+= pack('HH', (Size
+ 4), int(self
.FvExtEntryTypeValue
[Index
], 16))
366 Buffer
+= FvExtFile
.read()
368 if self
.FvExtEntryType
[Index
] == 'DATA':
369 ByteList
= self
.FvExtEntryData
[Index
].split(',')
370 Size
= len (ByteList
)
372 GenFdsGlobalVariable
.ErrorLogger("The size of FV Extension Header Entry data %s exceeds 0x10000." % (self
.FvExtEntryData
[Index
]))
373 TotalSize
+= (Size
+ 4)
374 Buffer
+= pack('HH', (Size
+ 4), int(self
.FvExtEntryTypeValue
[Index
], 16))
375 for Index1
in range (0, Size
):
376 Buffer
+= pack('B', int(ByteList
[Index1
], 16))
378 Guid
= self
.FvNameGuid
.split('-')
379 Buffer
= pack('=LHHBBBBBBBBL',
383 int(Guid
[3][-4:-2], 16),
384 int(Guid
[3][-2:], 16),
385 int(Guid
[4][-12:-10], 16),
386 int(Guid
[4][-10:-8], 16),
387 int(Guid
[4][-8:-6], 16),
388 int(Guid
[4][-6:-4], 16),
389 int(Guid
[4][-4:-2], 16),
390 int(Guid
[4][-2:], 16),
395 # Generate FV extension header file if the total size is not zero
398 FvExtHeaderFileName
= os
.path
.join(GenFdsGlobalVariable
.FvDir
, self
.UiFvName
+ '.ext')
399 FvExtHeaderFile
= StringIO
.StringIO()
400 FvExtHeaderFile
.write(Buffer
)
401 Changed
= SaveFileOnChange(FvExtHeaderFileName
, FvExtHeaderFile
.getvalue(), True)
402 FvExtHeaderFile
.close()
404 if os
.path
.exists (self
.InfFileName
):
405 os
.remove (self
.InfFileName
)
406 self
.FvInfFile
.writelines("EFI_FV_EXT_HEADER_FILE_NAME = " + \
407 FvExtHeaderFileName
+ \
414 self
.FvInfFile
.writelines("[files]" + T_CHAR_LF
)
415 if VtfDict
!= None and self
.UiFvName
in VtfDict
.keys():
416 self
.FvInfFile
.writelines("EFI_FILE_NAME = " + \
417 VtfDict
.get(self
.UiFvName
) + \