]>
Commit | Line | Data |
---|---|---|
30fdf114 LG |
1 | ## @file\r |
2 | # process FD Region generation\r | |
3 | #\r | |
b21a13fb | 4 | # Copyright (c) 2007 - 2015, 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 | |
18 | from struct import *\r | |
19 | from GenFdsGlobalVariable import GenFdsGlobalVariable\r | |
20 | import StringIO\r | |
21 | from CommonDataClass.FdfClass import RegionClassObject\r | |
1be2ed90 | 22 | import Common.LongFilePathOs as os\r |
fd171542 | 23 | from stat import *\r |
30fdf114 LG |
24 | from Common import EdkLogger\r |
25 | from Common.BuildToolError import *\r | |
1be2ed90 | 26 | from Common.LongFilePathSupport import OpenLongFilePath as open\r |
05cc51ad | 27 | from Common.MultipleWorkspace import MultipleWorkspace as mws\r |
30fdf114 | 28 | \r |
30fdf114 LG |
29 | ## generate Region\r |
30 | #\r | |
31 | #\r | |
32 | class Region(RegionClassObject):\r | |
33 | \r | |
34 | ## The constructor\r | |
35 | #\r | |
36 | # @param self The object pointer\r | |
37 | #\r | |
38 | def __init__(self):\r | |
39 | RegionClassObject.__init__(self)\r | |
40 | \r | |
41 | \r | |
5588565f LE |
42 | ## PadBuffer()\r |
43 | #\r | |
44 | # Add padding bytes to the Buffer\r | |
45 | #\r | |
46 | # @param Buffer The buffer the generated region data will be put\r | |
47 | # in\r | |
48 | # @param ErasePolarity Flash erase polarity\r | |
49 | # @param Size Number of padding bytes requested\r | |
50 | #\r | |
51 | \r | |
52 | def PadBuffer(self, Buffer, ErasePolarity, Size):\r | |
53 | if Size > 0:\r | |
54 | if (ErasePolarity == '1') :\r | |
55 | PadData = 0xFF\r | |
56 | else:\r | |
57 | PadData = 0\r | |
58 | for i in range(0, Size):\r | |
59 | Buffer.write(pack('B', PadData))\r | |
60 | \r | |
30fdf114 LG |
61 | ## AddToBuffer()\r |
62 | #\r | |
63 | # Add region data to the Buffer\r | |
64 | #\r | |
65 | # @param self The object pointer\r | |
66 | # @param Buffer The buffer generated region data will be put\r | |
67 | # @param BaseAddress base address of region\r | |
68 | # @param BlockSize block size of region\r | |
69 | # @param BlockNum How many blocks in region\r | |
70 | # @param ErasePolarity Flash erase polarity\r | |
71 | # @param VtfDict VTF objects\r | |
72 | # @param MacroDict macro value pair\r | |
73 | # @retval string Generated FV file path\r | |
74 | #\r | |
75 | \r | |
47fea6af | 76 | def AddToBuffer(self, Buffer, BaseAddress, BlockSizeList, ErasePolarity, ImageBinDict, vtfDict=None, MacroDict={}):\r |
30fdf114 | 77 | Size = self.Size\r |
fd171542 | 78 | GenFdsGlobalVariable.InfLogger('\nGenerate Region at Offset 0x%X' % self.Offset)\r |
47fea6af | 79 | GenFdsGlobalVariable.InfLogger(" Region Size = 0x%X" % Size)\r |
30fdf114 LG |
80 | GenFdsGlobalVariable.SharpCounter = 0\r |
81 | \r | |
82 | if self.RegionType == 'FV':\r | |
83 | #\r | |
84 | # Get Fv from FvDict\r | |
85 | #\r | |
30fdf114 | 86 | self.FvAddress = int(BaseAddress, 16) + self.Offset\r |
47fea6af YZ |
87 | FvBaseAddress = '0x%X' % self.FvAddress\r |
88 | FvOffset = 0\r | |
30fdf114 | 89 | for RegionData in self.RegionDataList:\r |
fd171542 | 90 | FileName = None\r |
30fdf114 LG |
91 | if RegionData.endswith(".fv"):\r |
92 | RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r | |
47fea6af | 93 | GenFdsGlobalVariable.InfLogger(' Region FV File Name = .fv : %s' % RegionData)\r |
30fdf114 | 94 | if RegionData[1] != ':' :\r |
534ef50c | 95 | RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r |
30fdf114 LG |
96 | if not os.path.exists(RegionData):\r |
97 | EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r | |
98 | \r | |
fd171542 | 99 | FileName = RegionData\r |
100 | elif RegionData.upper() + 'fv' in ImageBinDict.keys():\r | |
101 | GenFdsGlobalVariable.InfLogger(' Region Name = FV')\r | |
102 | FileName = ImageBinDict[RegionData.upper() + 'fv']\r | |
103 | else:\r | |
104 | #\r | |
105 | # Generate FvImage.\r | |
106 | #\r | |
107 | FvObj = None\r | |
108 | if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.FvDict.keys():\r | |
109 | FvObj = GenFdsGlobalVariable.FdfParser.Profile.FvDict.get(RegionData.upper())\r | |
110 | \r | |
111 | if FvObj != None :\r | |
112 | GenFdsGlobalVariable.InfLogger(' Region Name = FV')\r | |
113 | #\r | |
114 | # Call GenFv tool\r | |
115 | #\r | |
6780eef1 | 116 | self.BlockInfoOfRegion(BlockSizeList, FvObj)\r |
fd171542 | 117 | self.FvAddress = self.FvAddress + FvOffset\r |
118 | FvAlignValue = self.GetFvAlignValue(FvObj.FvAlignment)\r | |
119 | if self.FvAddress % FvAlignValue != 0:\r | |
120 | EdkLogger.error("GenFds", GENFDS_ERROR,\r | |
121 | "FV (%s) is NOT %s Aligned!" % (FvObj.UiFvName, FvObj.FvAlignment))\r | |
122 | FvBuffer = StringIO.StringIO('')\r | |
47fea6af | 123 | FvBaseAddress = '0x%X' % self.FvAddress\r |
6780eef1 LG |
124 | BlockSize = None\r |
125 | BlockNum = None\r | |
fd171542 | 126 | FvObj.AddToBuffer(FvBuffer, FvBaseAddress, BlockSize, BlockNum, ErasePolarity, vtfDict)\r |
127 | if FvBuffer.len > Size:\r | |
128 | FvBuffer.close()\r | |
129 | EdkLogger.error("GenFds", GENFDS_ERROR,\r | |
130 | "Size of FV (%s) is larger than Region Size 0x%X specified." % (RegionData, Size))\r | |
131 | #\r | |
132 | # Put the generated image into FD buffer.\r | |
133 | #\r | |
134 | Buffer.write(FvBuffer.getvalue())\r | |
135 | FvBuffer.close()\r | |
136 | FvOffset = FvOffset + FvBuffer.len\r | |
137 | Size = Size - FvBuffer.len\r | |
138 | continue\r | |
139 | else:\r | |
140 | EdkLogger.error("GenFds", GENFDS_ERROR, "FV (%s) is NOT described in FDF file!" % (RegionData))\r | |
141 | #\r | |
142 | # Add the exist Fv image into FD buffer\r | |
143 | #\r | |
144 | if FileName != None:\r | |
145 | FileLength = os.stat(FileName)[ST_SIZE]\r | |
146 | if FileLength > Size:\r | |
30fdf114 LG |
147 | EdkLogger.error("GenFds", GENFDS_ERROR,\r |
148 | "Size of FV File (%s) is larger than Region Size 0x%X specified." \\r | |
149 | % (RegionData, Size))\r | |
47fea6af | 150 | BinFile = open(FileName, 'r+b')\r |
fd171542 | 151 | Buffer.write(BinFile.read())\r |
152 | BinFile.close()\r | |
153 | Size = Size - FileLength\r | |
154 | #\r | |
155 | # Pad the left buffer\r | |
156 | #\r | |
5588565f | 157 | self.PadBuffer(Buffer, ErasePolarity, Size)\r |
30fdf114 | 158 | \r |
fd171542 | 159 | if self.RegionType == 'CAPSULE':\r |
160 | #\r | |
161 | # Get Capsule from Capsule Dict\r | |
162 | #\r | |
163 | for RegionData in self.RegionDataList:\r | |
164 | if RegionData.endswith(".cap"):\r | |
165 | RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r | |
47fea6af | 166 | GenFdsGlobalVariable.InfLogger(' Region CAPSULE Image Name = .cap : %s' % RegionData)\r |
fd171542 | 167 | if RegionData[1] != ':' :\r |
534ef50c | 168 | RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r |
fd171542 | 169 | if not os.path.exists(RegionData):\r |
170 | EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r | |
30fdf114 | 171 | \r |
fd171542 | 172 | FileName = RegionData\r |
173 | elif RegionData.upper() + 'cap' in ImageBinDict.keys():\r | |
174 | GenFdsGlobalVariable.InfLogger(' Region Name = CAPSULE')\r | |
175 | FileName = ImageBinDict[RegionData.upper() + 'cap']\r | |
176 | else:\r | |
30fdf114 | 177 | #\r |
fd171542 | 178 | # Generate Capsule image and Put it into FD buffer\r |
30fdf114 | 179 | #\r |
fd171542 | 180 | CapsuleObj = None\r |
181 | if RegionData.upper() in GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict.keys():\r | |
182 | CapsuleObj = GenFdsGlobalVariable.FdfParser.Profile.CapsuleDict[RegionData.upper()]\r | |
30fdf114 | 183 | \r |
fd171542 | 184 | if CapsuleObj != None :\r |
185 | CapsuleObj.CapsuleName = RegionData.upper()\r | |
186 | GenFdsGlobalVariable.InfLogger(' Region Name = CAPSULE')\r | |
187 | #\r | |
188 | # Call GenFv tool to generate Capsule Image\r | |
189 | #\r | |
190 | FileName = CapsuleObj.GenCapsule()\r | |
191 | CapsuleObj.CapsuleName = None\r | |
192 | else:\r | |
193 | EdkLogger.error("GenFds", GENFDS_ERROR, "Capsule (%s) is NOT described in FDF file!" % (RegionData))\r | |
30fdf114 | 194 | \r |
fd171542 | 195 | #\r |
196 | # Add the capsule image into FD buffer\r | |
197 | #\r | |
198 | FileLength = os.stat(FileName)[ST_SIZE]\r | |
199 | if FileLength > Size:\r | |
200 | EdkLogger.error("GenFds", GENFDS_ERROR,\r | |
201 | "Size 0x%X of Capsule File (%s) is larger than Region Size 0x%X specified." \\r | |
202 | % (FileLength, RegionData, Size))\r | |
47fea6af | 203 | BinFile = open(FileName, 'r+b')\r |
30fdf114 | 204 | Buffer.write(BinFile.read())\r |
fd171542 | 205 | BinFile.close()\r |
206 | Size = Size - FileLength\r | |
207 | #\r | |
208 | # Pad the left buffer\r | |
209 | #\r | |
5588565f | 210 | self.PadBuffer(Buffer, ErasePolarity, Size)\r |
30fdf114 | 211 | \r |
b21a13fb | 212 | if self.RegionType in ('FILE', 'INF'):\r |
30fdf114 | 213 | for RegionData in self.RegionDataList:\r |
b21a13fb YZ |
214 | if self.RegionType == 'INF':\r |
215 | RegionData.__InfParse__(None)\r | |
216 | if len(RegionData.BinFileList) != 1:\r | |
217 | EdkLogger.error('GenFds', GENFDS_ERROR, 'INF in FD region can only contain one binary: %s' % RegionData)\r | |
218 | File = RegionData.BinFileList[0]\r | |
219 | RegionData = RegionData.PatchEfiFile(File.Path, File.Type)\r | |
220 | else:\r | |
221 | RegionData = GenFdsGlobalVariable.MacroExtend(RegionData, MacroDict)\r | |
222 | if RegionData[1] != ':' :\r | |
534ef50c | 223 | RegionData = mws.join (GenFdsGlobalVariable.WorkSpaceDir, RegionData)\r |
b21a13fb YZ |
224 | if not os.path.exists(RegionData):\r |
225 | EdkLogger.error("GenFds", FILE_NOT_FOUND, ExtraData=RegionData)\r | |
fd171542 | 226 | #\r |
227 | # Add the file image into FD buffer\r | |
228 | #\r | |
229 | FileLength = os.stat(RegionData)[ST_SIZE]\r | |
230 | if FileLength > Size:\r | |
30fdf114 | 231 | EdkLogger.error("GenFds", GENFDS_ERROR,\r |
fd171542 | 232 | "Size of File (%s) is larger than Region Size 0x%X specified." \\r |
233 | % (RegionData, Size))\r | |
47fea6af YZ |
234 | GenFdsGlobalVariable.InfLogger(' Region File Name = %s' % RegionData)\r |
235 | BinFile = open(RegionData, 'rb')\r | |
fd171542 | 236 | Buffer.write(BinFile.read())\r |
237 | BinFile.close()\r | |
238 | Size = Size - FileLength\r | |
30fdf114 | 239 | #\r |
fd171542 | 240 | # Pad the left buffer\r |
30fdf114 | 241 | #\r |
5588565f | 242 | self.PadBuffer(Buffer, ErasePolarity, Size)\r |
30fdf114 LG |
243 | \r |
244 | if self.RegionType == 'DATA' :\r | |
245 | GenFdsGlobalVariable.InfLogger(' Region Name = DATA')\r | |
246 | DataSize = 0\r | |
247 | for RegionData in self.RegionDataList:\r | |
248 | Data = RegionData.split(',')\r | |
249 | DataSize = DataSize + len(Data)\r | |
250 | if DataSize > Size:\r | |
251 | EdkLogger.error("GenFds", GENFDS_ERROR, "Size of DATA is larger than Region Size ")\r | |
252 | else:\r | |
253 | for item in Data :\r | |
254 | Buffer.write(pack('B', int(item, 16)))\r | |
fd171542 | 255 | Size = Size - DataSize\r |
256 | #\r | |
257 | # Pad the left buffer\r | |
258 | #\r | |
5588565f | 259 | self.PadBuffer(Buffer, ErasePolarity, Size)\r |
30fdf114 LG |
260 | \r |
261 | if self.RegionType == None:\r | |
262 | GenFdsGlobalVariable.InfLogger(' Region Name = None')\r | |
5588565f | 263 | self.PadBuffer(Buffer, ErasePolarity, Size)\r |
30fdf114 LG |
264 | \r |
265 | def GetFvAlignValue(self, Str):\r | |
266 | AlignValue = 1\r | |
267 | Granu = 1\r | |
268 | Str = Str.strip().upper()\r | |
269 | if Str.endswith('K'):\r | |
270 | Granu = 1024\r | |
271 | Str = Str[:-1]\r | |
272 | elif Str.endswith('M'):\r | |
47fea6af | 273 | Granu = 1024 * 1024\r |
30fdf114 LG |
274 | Str = Str[:-1]\r |
275 | elif Str.endswith('G'):\r | |
47fea6af | 276 | Granu = 1024 * 1024 * 1024\r |
30fdf114 LG |
277 | Str = Str[:-1]\r |
278 | else:\r | |
279 | pass\r | |
280 | \r | |
47fea6af | 281 | AlignValue = int(Str) * Granu\r |
30fdf114 | 282 | return AlignValue\r |
47fea6af | 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 | |
300 | # region located in current blocks \r | |
301 | else:\r | |
302 | # region ended within current blocks\r | |
303 | if self.Offset + self.Size <= End:\r | |
47fea6af | 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 | |
47fea6af | 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 | |
324 | if Item[0] == None or Item[1] == None:\r | |
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 |
6780eef1 | 352 | \r |
30fdf114 | 353 | \r |