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