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