]>
Commit | Line | Data |
---|---|---|
615c6dd0 | 1 | /** @file\r |
192f6d4c | 2 | \r |
b0d803fe | 3 | Copyright (c) 2006 - 2007, Intel Corporation \r |
192f6d4c | 4 | All rights reserved. This program and the accompanying materials \r |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | FwVol.c\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Pei Core Firmware File System service routines.\r | |
19 | \r | |
615c6dd0 | 20 | **/\r |
192f6d4c | 21 | \r |
192f6d4c | 22 | #include <PeiMain.h>\r |
23 | \r | |
b0d803fe | 24 | STATIC EFI_PEI_NOTIFY_DESCRIPTOR mNotifyOnFvInfoList = {\r |
25 | (EFI_PEI_PPI_DESCRIPTOR_NOTIFY_CALLBACK | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r | |
26 | &gEfiPeiFirmwareVolumeInfoPpiGuid,\r | |
27 | FirmwareVolmeInfoPpiNotifyCallback \r | |
28 | };\r | |
29 | \r | |
30 | \r | |
31 | #define GET_OCCUPIED_SIZE(ActualSize, Alignment) \\r | |
192f6d4c | 32 | (ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1))\r |
33 | \r | |
34 | STATIC\r | |
35 | EFI_FFS_FILE_STATE\r | |
36 | GetFileState(\r | |
37 | IN UINT8 ErasePolarity,\r | |
38 | IN EFI_FFS_FILE_HEADER *FfsHeader\r | |
39 | )\r | |
40 | /*++\r | |
41 | \r | |
42 | Routine Description:\r | |
43 | \r | |
44 | Returns the highest bit set of the State field\r | |
45 | \r | |
46 | Arguments:\r | |
47 | \r | |
48 | ErasePolarity - Erase Polarity as defined by EFI_FVB2_ERASE_POLARITY\r | |
49 | in the Attributes field.\r | |
50 | FfsHeader - Pointer to FFS File Header.\r | |
51 | \r | |
52 | Returns:\r | |
53 | Returns the highest bit in the State field\r | |
54 | \r | |
55 | --*/\r | |
56 | {\r | |
57 | EFI_FFS_FILE_STATE FileState;\r | |
58 | EFI_FFS_FILE_STATE HighestBit;\r | |
59 | \r | |
60 | FileState = FfsHeader->State;\r | |
61 | \r | |
62 | if (ErasePolarity != 0) {\r | |
63 | FileState = (EFI_FFS_FILE_STATE)~FileState;\r | |
64 | }\r | |
65 | \r | |
66 | HighestBit = 0x80;\r | |
67 | while (HighestBit != 0 && (HighestBit & FileState) == 0) {\r | |
68 | HighestBit >>= 1;\r | |
69 | }\r | |
70 | \r | |
71 | return HighestBit;\r | |
72 | } \r | |
73 | \r | |
74 | STATIC\r | |
75 | UINT8\r | |
76 | CalculateHeaderChecksum (\r | |
77 | IN EFI_FFS_FILE_HEADER *FileHeader\r | |
78 | )\r | |
79 | /*++\r | |
80 | \r | |
81 | Routine Description:\r | |
82 | \r | |
83 | Calculates the checksum of the header of a file.\r | |
84 | \r | |
85 | Arguments:\r | |
86 | \r | |
87 | FileHeader - Pointer to FFS File Header.\r | |
88 | \r | |
89 | Returns:\r | |
90 | Checksum of the header.\r | |
91 | \r | |
92 | The header is zero byte checksum.\r | |
93 | - Zero means the header is good.\r | |
94 | - Non-zero means the header is bad.\r | |
95 | \r | |
96 | \r | |
97 | Bugbug: For PEI performance reason, we comments this code at this time.\r | |
98 | --*/\r | |
99 | {\r | |
100 | UINT8 *ptr;\r | |
101 | UINTN Index;\r | |
102 | UINT8 Sum;\r | |
103 | \r | |
104 | Sum = 0;\r | |
105 | ptr = (UINT8 *)FileHeader;\r | |
106 | \r | |
107 | for (Index = 0; Index < sizeof(EFI_FFS_FILE_HEADER) - 3; Index += 4) {\r | |
108 | Sum = (UINT8)(Sum + ptr[Index]);\r | |
109 | Sum = (UINT8)(Sum + ptr[Index+1]);\r | |
110 | Sum = (UINT8)(Sum + ptr[Index+2]);\r | |
111 | Sum = (UINT8)(Sum + ptr[Index+3]);\r | |
112 | }\r | |
113 | \r | |
114 | for (; Index < sizeof(EFI_FFS_FILE_HEADER); Index++) {\r | |
115 | Sum = (UINT8)(Sum + ptr[Index]);\r | |
116 | }\r | |
117 | \r | |
118 | //\r | |
119 | // State field (since this indicates the different state of file). \r | |
120 | //\r | |
121 | Sum = (UINT8)(Sum - FileHeader->State);\r | |
122 | //\r | |
123 | // Checksum field of the file is not part of the header checksum.\r | |
124 | //\r | |
125 | Sum = (UINT8)(Sum - FileHeader->IntegrityCheck.Checksum.File);\r | |
126 | \r | |
127 | return Sum;\r | |
128 | }\r | |
129 | \r | |
130 | STATIC\r | |
b0d803fe | 131 | BOOLEAN\r |
132 | EFIAPI\r | |
133 | PeiFileHandleToVolume (\r | |
134 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
135 | OUT EFI_PEI_FV_HANDLE *VolumeHandle\r | |
136 | )\r | |
137 | {\r | |
138 | UINTN Index;\r | |
139 | PEI_CORE_INSTANCE *PrivateData;\r | |
140 | EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r | |
141 | \r | |
142 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (GetPeiServicesTablePointer ());\r | |
143 | for (Index = 0; Index < PrivateData->FvCount; Index++) {\r | |
144 | FwVolHeader = PrivateData->Fv[Index].FvHeader;\r | |
67a58d0f | 145 | if (((UINT64) (UINTN) FileHandle > (UINT64) (UINTN) FwVolHeader ) && \\r |
146 | ((UINT64) (UINTN) FileHandle <= ((UINT64) (UINTN) FwVolHeader + FwVolHeader->FvLength - 1))) {\r | |
b0d803fe | 147 | *VolumeHandle = (EFI_PEI_FV_HANDLE)FwVolHeader;\r |
148 | return TRUE;\r | |
149 | }\r | |
150 | }\r | |
151 | return FALSE;\r | |
152 | }\r | |
153 | \r | |
154 | \r | |
192f6d4c | 155 | EFI_STATUS\r |
b0d803fe | 156 | PeiFindFileEx (\r |
157 | IN CONST EFI_PEI_FV_HANDLE FvHandle,\r | |
158 | IN CONST EFI_GUID *FileName, OPTIONAL\r | |
159 | IN EFI_FV_FILETYPE SearchType,\r | |
160 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle,\r | |
161 | IN OUT EFI_PEI_FV_HANDLE *AprioriFile OPTIONAL\r | |
192f6d4c | 162 | )\r |
163 | /*++\r | |
164 | \r | |
165 | Routine Description:\r | |
166 | Given the input file pointer, search for the next matching file in the\r | |
167 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r | |
168 | the Firmware Volume defined by FwVolHeader.\r | |
169 | \r | |
170 | Arguments:\r | |
171 | PeiServices - Pointer to the PEI Core Services Table.\r | |
172 | SearchType - Filter to find only files of this type.\r | |
173 | Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r | |
174 | FwVolHeader - Pointer to the FV header of the volume to search.\r | |
175 | This parameter must point to a valid FFS volume.\r | |
176 | FileHeader - Pointer to the current file from which to begin searching.\r | |
177 | This pointer will be updated upon return to reflect the file found.\r | |
178 | Flag - Indicator for if this is for PEI Dispath search \r | |
b0d803fe | 179 | \r |
192f6d4c | 180 | Returns:\r |
181 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
182 | EFI_SUCCESS\r | |
183 | \r | |
184 | --*/\r | |
185 | {\r | |
b0d803fe | 186 | EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r |
187 | EFI_FFS_FILE_HEADER **FileHeader;\r | |
188 | EFI_FFS_FILE_HEADER *FfsFileHeader;\r | |
189 | EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r | |
190 | UINT32 FileLength;\r | |
191 | UINT32 FileOccupiedSize;\r | |
192 | UINT32 FileOffset;\r | |
193 | UINT64 FvLength;\r | |
194 | UINT8 ErasePolarity;\r | |
195 | UINT8 FileState;\r | |
196 | \r | |
197 | FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)FvHandle;\r | |
198 | FileHeader = (EFI_FFS_FILE_HEADER **)FileHandle;\r | |
192f6d4c | 199 | \r |
200 | FvLength = FwVolHeader->FvLength;\r | |
797a9d67 | 201 | if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r |
192f6d4c | 202 | ErasePolarity = 1;\r |
203 | } else {\r | |
204 | ErasePolarity = 0;\r | |
205 | }\r | |
206 | \r | |
207 | //\r | |
b0d803fe | 208 | // If FileHeader is not specified (NULL) or FileName is not NULL,\r |
209 | // start with the first file in the firmware volume. Otherwise,\r | |
210 | // start from the FileHeader.\r | |
192f6d4c | 211 | //\r |
b0d803fe | 212 | if ((*FileHeader == NULL) || (FileName != NULL)) {\r |
192f6d4c | 213 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);\r |
b0d803fe | 214 | if (FwVolHeader->ExtHeaderOffset != 0) {\r |
215 | FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER *)(((UINT8 *)FwVolHeader) + FwVolHeader->ExtHeaderOffset);\r | |
216 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)(((UINT8 *)FwVolExHeaderInfo) + FwVolExHeaderInfo->ExtHeaderSize);\r | |
217 | }\r | |
192f6d4c | 218 | } else {\r |
219 | //\r | |
220 | // Length is 24 bits wide so mask upper 8 bits\r | |
221 | // FileLength is adjusted to FileOccupiedSize as it is 8 byte aligned.\r | |
222 | //\r | |
223 | FileLength = *(UINT32 *)(*FileHeader)->Size & 0x00FFFFFF;\r | |
b0d803fe | 224 | FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r |
192f6d4c | 225 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)*FileHeader + FileOccupiedSize);\r |
226 | }\r | |
e98cd821 | 227 | \r |
192f6d4c | 228 | FileOffset = (UINT32) ((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);\r |
229 | ASSERT (FileOffset <= 0xFFFFFFFF);\r | |
e98cd821 | 230 | \r |
b0d803fe | 231 | while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r |
192f6d4c | 232 | //\r |
233 | // Get FileState which is the highest bit of the State \r | |
234 | //\r | |
235 | FileState = GetFileState (ErasePolarity, FfsFileHeader);\r | |
192f6d4c | 236 | switch (FileState) {\r |
237 | \r | |
238 | case EFI_FILE_HEADER_INVALID:\r | |
239 | FileOffset += sizeof(EFI_FFS_FILE_HEADER);\r | |
240 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof(EFI_FFS_FILE_HEADER));\r | |
241 | break;\r | |
242 | \r | |
243 | case EFI_FILE_DATA_VALID:\r | |
244 | case EFI_FILE_MARKED_FOR_UPDATE:\r | |
b0d803fe | 245 | if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r |
192f6d4c | 246 | ASSERT (FALSE);\r |
e98cd821 | 247 | *FileHeader = NULL;\r |
192f6d4c | 248 | return EFI_NOT_FOUND;\r |
249 | }\r | |
b0d803fe | 250 | \r |
251 | FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
252 | FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r | |
253 | \r | |
254 | if (FileName != NULL) {\r | |
255 | if (CompareGuid (&FfsFileHeader->Name, (EFI_GUID*)FileName)) {\r | |
256 | *FileHeader = FfsFileHeader;\r | |
257 | return EFI_SUCCESS;\r | |
258 | }\r | |
259 | } else if (SearchType == PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE) {\r | |
260 | if ((FfsFileHeader->Type == EFI_FV_FILETYPE_PEIM) || \r | |
288f9b38 LG |
261 | (FfsFileHeader->Type == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER) ||\r |
262 | (FfsFileHeader->Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) { \r | |
b0d803fe | 263 | \r |
264 | *FileHeader = FfsFileHeader;\r | |
265 | return EFI_SUCCESS;\r | |
266 | } else if (AprioriFile != NULL) {\r | |
267 | if (FfsFileHeader->Type == EFI_FV_FILETYPE_FREEFORM) {\r | |
268 | if (CompareGuid (&FfsFileHeader->Name, &gPeiAprioriFileNameGuid)) {\r | |
269 | *AprioriFile = FfsFileHeader;\r | |
270 | } \r | |
271 | } \r | |
272 | }\r | |
7e181f2f | 273 | } else if (((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) && \r |
274 | (FfsFileHeader->Type != EFI_FV_FILETYPE_FFS_PAD)) { \r | |
b0d803fe | 275 | *FileHeader = FfsFileHeader;\r |
276 | return EFI_SUCCESS;\r | |
277 | }\r | |
278 | \r | |
279 | FileOffset += FileOccupiedSize; \r | |
280 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r | |
192f6d4c | 281 | break;\r |
282 | \r | |
283 | case EFI_FILE_DELETED:\r | |
284 | FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
b0d803fe | 285 | FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r |
192f6d4c | 286 | FileOffset += FileOccupiedSize;\r |
287 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r | |
288 | break;\r | |
289 | \r | |
290 | default:\r | |
e98cd821 | 291 | *FileHeader = NULL;\r |
192f6d4c | 292 | return EFI_NOT_FOUND;\r |
192f6d4c | 293 | } \r |
294 | }\r | |
e98cd821 LG |
295 | \r |
296 | *FileHeader = NULL;\r | |
192f6d4c | 297 | return EFI_NOT_FOUND; \r |
298 | }\r | |
299 | \r | |
b0d803fe | 300 | VOID \r |
301 | PeiInitializeFv (\r | |
302 | IN PEI_CORE_INSTANCE *PrivateData,\r | |
303 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r | |
304 | )\r | |
305 | /*++\r | |
306 | \r | |
307 | Routine Description:\r | |
308 | \r | |
309 | Initialize PeiCore Fv List.\r | |
310 | \r | |
311 | Arguments:\r | |
312 | PrivateData - Pointer to PEI_CORE_INSTANCE.\r | |
313 | SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.\r | |
314 | \r | |
315 | Returns:\r | |
316 | NONE \r | |
317 | \r | |
318 | --*/ \r | |
319 | {\r | |
320 | EFI_STATUS Status;\r | |
321 | //\r | |
322 | // The BFV must be the first entry. The Core FV support is stateless \r | |
323 | // The AllFV list has a single entry per FV in PEI. \r | |
324 | // The Fv list only includes FV that PEIMs will be dispatched from and\r | |
325 | // its File System Format is PI 1.0 definition.\r | |
326 | //\r | |
327 | PrivateData->FvCount = 1;\r | |
328 | PrivateData->Fv[0].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;\r | |
329 | \r | |
330 | PrivateData->AllFvCount = 1;\r | |
331 | PrivateData->AllFv[0] = (EFI_PEI_FV_HANDLE)PrivateData->Fv[0].FvHeader;\r | |
332 | \r | |
333 | \r | |
334 | //\r | |
335 | // Post a call-back for the FvInfoPPI services to expose\r | |
336 | // additional Fvs to PeiCore.\r | |
337 | //\r | |
338 | Status = PeiServicesNotifyPpi (&mNotifyOnFvInfoList);\r | |
339 | ASSERT_EFI_ERROR (Status);\r | |
340 | \r | |
341 | }\r | |
342 | \r | |
343 | EFI_STATUS\r | |
344 | EFIAPI\r | |
345 | FirmwareVolmeInfoPpiNotifyCallback (\r | |
346 | IN EFI_PEI_SERVICES **PeiServices,\r | |
347 | IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r | |
348 | IN VOID *Ppi\r | |
349 | )\r | |
350 | /*++\r | |
351 | \r | |
352 | Routine Description:\r | |
353 | \r | |
354 | Process Firmware Volum Information once FvInfoPPI install.\r | |
355 | \r | |
356 | Arguments:\r | |
357 | \r | |
358 | PeiServices - General purpose services available to every PEIM.\r | |
359 | \r | |
360 | Returns:\r | |
361 | \r | |
362 | Status - EFI_SUCCESS if the interface could be successfully\r | |
363 | installed\r | |
364 | \r | |
365 | --*/\r | |
366 | {\r | |
367 | UINT8 FvCount;\r | |
368 | EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *Fv;\r | |
369 | PEI_CORE_INSTANCE *PrivateData;\r | |
288f9b38 LG |
370 | EFI_PEI_FILE_HANDLE FileHandle;\r |
371 | VOID *DepexData;\r | |
372 | UINT32 AuthenticationStatus;\r | |
373 | EFI_STATUS Status;\r | |
b0d803fe | 374 | \r |
288f9b38 LG |
375 | FileHandle = NULL;\r |
376 | DepexData = NULL;\r | |
377 | Status = EFI_SUCCESS;\r | |
378 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r | |
b0d803fe | 379 | \r |
177aabe6 | 380 | if (PrivateData->FvCount >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {\r |
b0d803fe | 381 | ASSERT (FALSE);\r |
382 | }\r | |
383 | \r | |
384 | Fv = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\r | |
385 | \r | |
288f9b38 LG |
386 | if (CompareGuid (&Fv->FvFormat, &gEfiFirmwareFileSystem2Guid)) {\r |
387 | for (FvCount = 0; FvCount < PrivateData->FvCount; FvCount ++) {\r | |
388 | if ((UINTN)PrivateData->Fv[FvCount].FvHeader == (UINTN)Fv->FvInfo) {\r | |
389 | return EFI_SUCCESS;\r | |
390 | }\r | |
391 | }\r | |
b0d803fe | 392 | PrivateData->Fv[PrivateData->FvCount++].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo;\r |
b0d803fe | 393 | \r |
288f9b38 LG |
394 | //\r |
395 | // Only add FileSystem2 Fv to the All list\r | |
396 | //\r | |
397 | PrivateData->AllFv[PrivateData->AllFvCount++] = (EFI_PEI_FV_HANDLE)Fv->FvInfo;\r | |
398 | \r | |
399 | DEBUG ((EFI_D_INFO, "The %dth FvImage start address is 0x%10p and size is 0x%08x\n", PrivateData->AllFvCount, (VOID *) Fv->FvInfo, Fv->FvInfoSize));\r | |
400 | //\r | |
401 | // Preprocess all FV type files in this new FileSystem2 Fv image\r | |
402 | //\r | |
403 | do {\r | |
404 | Status = PeiFindFileEx (\r | |
405 | (EFI_PEI_FV_HANDLE)Fv->FvInfo, \r | |
406 | NULL, \r | |
407 | EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE, \r | |
408 | &FileHandle, \r | |
409 | NULL\r | |
410 | );\r | |
411 | if (!EFI_ERROR (Status)) {\r | |
412 | Status = PeiFfsFindSectionData (\r | |
413 | (CONST EFI_PEI_SERVICES **) PeiServices,\r | |
414 | EFI_SECTION_PEI_DEPEX,\r | |
415 | FileHandle, \r | |
416 | (VOID **)&DepexData\r | |
417 | );\r | |
418 | if (!EFI_ERROR (Status)) {\r | |
419 | if (!PeimDispatchReadiness (PeiServices, DepexData)) {\r | |
420 | //\r | |
421 | // Dependency is not satisfied.\r | |
422 | //\r | |
423 | continue;\r | |
424 | }\r | |
425 | }\r | |
426 | //\r | |
427 | // Process FvFile to install FvInfo ppi and build FvHob\r | |
428 | // \r | |
429 | ProcessFvFile (PeiServices, FileHandle, &AuthenticationStatus);\r | |
430 | }\r | |
431 | } while (FileHandle != NULL);\r | |
432 | }\r | |
b0d803fe | 433 | \r |
434 | return EFI_SUCCESS;\r | |
435 | }\r | |
436 | \r | |
437 | EFI_STATUS\r | |
438 | PeiFfsProcessSection (\r | |
439 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
440 | IN EFI_SECTION_TYPE SectionType,\r | |
441 | IN EFI_COMMON_SECTION_HEADER *Section,\r | |
442 | IN UINTN SectionSize,\r | |
288f9b38 | 443 | OUT VOID **OutputBuffer\r |
b0d803fe | 444 | )\r |
445 | /*++\r | |
446 | \r | |
447 | Routine Description:\r | |
448 | \r | |
449 | Go through the file to search SectionType section,\r | |
288f9b38 | 450 | when meeting an encapsuled section. \r |
b0d803fe | 451 | \r |
452 | Arguments:\r | |
288f9b38 | 453 | PeiServices - General purpose services available to every PEIM.\r |
b0d803fe | 454 | SearchType - Filter to find only section of this type.\r |
455 | Section - From where to search.\r | |
456 | SectionSize - The file size to search.\r | |
457 | OutputBuffer - Pointer to the section to search.\r | |
b0d803fe | 458 | \r |
459 | Returns:\r | |
460 | EFI_STATUS\r | |
461 | \r | |
462 | --*/\r | |
463 | {\r | |
464 | EFI_STATUS Status;\r | |
465 | UINT32 SectionLength;\r | |
466 | UINT32 ParsedLength;\r | |
b0d803fe | 467 | EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *GuidSectionPpi;\r |
b0d803fe | 468 | EFI_PEI_DECOMPRESS_PPI *DecompressPpi;\r |
469 | VOID *PpiOutput;\r | |
470 | UINTN PpiOutputSize;\r | |
288f9b38 LG |
471 | UINTN Index;\r |
472 | UINT32 Authentication;\r | |
473 | PEI_CORE_INSTANCE *PrivateData;\r | |
b0d803fe | 474 | \r |
288f9b38 | 475 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r |
b0d803fe | 476 | *OutputBuffer = NULL;\r |
288f9b38 LG |
477 | ParsedLength = 0;\r |
478 | Index = 0;\r | |
479 | Status = EFI_NOT_FOUND;\r | |
480 | PpiOutput = NULL;\r | |
481 | PpiOutputSize = 0;\r | |
b0d803fe | 482 | while (ParsedLength < SectionSize) {\r |
483 | if (Section->Type == SectionType) {\r | |
484 | *OutputBuffer = (VOID *)(Section + 1);\r | |
485 | return EFI_SUCCESS;\r | |
288f9b38 LG |
486 | } else if ((Section->Type == EFI_SECTION_GUID_DEFINED) || (Section->Type == EFI_SECTION_COMPRESSION)) {\r |
487 | //\r | |
488 | // Check the encapsulated section is extracted into the cache data.\r | |
489 | //\r | |
490 | for (Index = 0; Index < PrivateData->CacheSection.AllSectionCount; Index ++) {\r | |
491 | if (Section == PrivateData->CacheSection.Section[Index]) {\r | |
492 | PpiOutput = PrivateData->CacheSection.SectionData[Index];\r | |
493 | PpiOutputSize = PrivateData->CacheSection.SectionSize[Index];\r | |
494 | //\r | |
495 | // Search section directly from the cache data.\r | |
496 | //\r | |
b0d803fe | 497 | return PeiFfsProcessSection (\r |
498 | PeiServices,\r | |
499 | SectionType, \r | |
500 | PpiOutput, \r | |
501 | PpiOutputSize, \r | |
288f9b38 | 502 | OutputBuffer \r |
b0d803fe | 503 | );\r |
504 | }\r | |
505 | }\r | |
288f9b38 LG |
506 | \r |
507 | Status = EFI_NOT_FOUND;\r | |
508 | if (Section->Type == EFI_SECTION_GUID_DEFINED) {\r | |
509 | Status = PeiServicesLocatePpi (\r | |
510 | &((EFI_GUID_DEFINED_SECTION *)Section)->SectionDefinitionGuid, \r | |
511 | 0, \r | |
512 | NULL, \r | |
513 | (VOID **) &GuidSectionPpi\r | |
514 | );\r | |
b0d803fe | 515 | if (!EFI_ERROR (Status)) {\r |
288f9b38 LG |
516 | Status = GuidSectionPpi->ExtractSection (\r |
517 | GuidSectionPpi,\r | |
518 | Section,\r | |
519 | &PpiOutput,\r | |
520 | &PpiOutputSize,\r | |
521 | &Authentication\r | |
522 | );\r | |
523 | }\r | |
524 | } else if (Section->Type == EFI_SECTION_COMPRESSION) {\r | |
525 | Status = PeiServicesLocatePpi (&gEfiPeiDecompressPpiGuid, 0, NULL, (VOID **) &DecompressPpi);\r | |
526 | if (!EFI_ERROR (Status)) {\r | |
527 | Status = DecompressPpi->Decompress (\r | |
528 | DecompressPpi,\r | |
529 | (CONST EFI_COMPRESSION_SECTION*) Section,\r | |
530 | &PpiOutput,\r | |
531 | &PpiOutputSize\r | |
532 | );\r | |
b0d803fe | 533 | }\r |
534 | }\r | |
288f9b38 LG |
535 | \r |
536 | if (!EFI_ERROR (Status)) {\r | |
537 | //\r | |
538 | // Update cache section data.\r | |
539 | //\r | |
540 | if (PrivateData->CacheSection.AllSectionCount < CACHE_SETION_MAX_NUMBER) {\r | |
541 | PrivateData->CacheSection.AllSectionCount ++;\r | |
542 | }\r | |
543 | PrivateData->CacheSection.Section [PrivateData->CacheSection.SectionIndex] = Section;\r | |
544 | PrivateData->CacheSection.SectionData [PrivateData->CacheSection.SectionIndex] = PpiOutput;\r | |
545 | PrivateData->CacheSection.SectionSize [PrivateData->CacheSection.SectionIndex] = PpiOutputSize;\r | |
546 | PrivateData->CacheSection.SectionIndex = (PrivateData->CacheSection.SectionIndex + 1)%CACHE_SETION_MAX_NUMBER;\r | |
547 | \r | |
548 | return PeiFfsProcessSection (\r | |
549 | PeiServices,\r | |
550 | SectionType, \r | |
551 | PpiOutput, \r | |
552 | PpiOutputSize, \r | |
553 | OutputBuffer \r | |
554 | );\r | |
555 | }\r | |
b0d803fe | 556 | }\r |
557 | \r | |
558 | //\r | |
559 | // Size is 24 bits wide so mask upper 8 bits. \r | |
560 | // SectionLength is adjusted it is 4 byte aligned.\r | |
561 | // Go to the next section\r | |
562 | //\r | |
563 | SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;\r | |
564 | SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r | |
565 | ASSERT (SectionLength != 0);\r | |
566 | ParsedLength += SectionLength;\r | |
567 | Section = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);\r | |
568 | }\r | |
569 | \r | |
570 | return EFI_NOT_FOUND;\r | |
571 | }\r | |
572 | \r | |
192f6d4c | 573 | \r |
574 | EFI_STATUS\r | |
575 | EFIAPI\r | |
576 | PeiFfsFindSectionData (\r | |
0c2b5da8 | 577 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 578 | IN EFI_SECTION_TYPE SectionType,\r |
0c2b5da8 | 579 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
192f6d4c | 580 | IN OUT VOID **SectionData\r |
581 | )\r | |
582 | /*++\r | |
583 | \r | |
584 | Routine Description:\r | |
585 | Given the input file pointer, search for the next matching section in the\r | |
586 | FFS volume.\r | |
587 | \r | |
588 | Arguments:\r | |
589 | PeiServices - Pointer to the PEI Core Services Table.\r | |
590 | SearchType - Filter to find only sections of this type.\r | |
591 | FfsFileHeader - Pointer to the current file to search.\r | |
592 | SectionData - Pointer to the Section matching SectionType in FfsFileHeader.\r | |
593 | - NULL if section not found\r | |
594 | \r | |
595 | Returns:\r | |
596 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
597 | EFI_SUCCESS\r | |
598 | \r | |
599 | --*/\r | |
600 | {\r | |
b0d803fe | 601 | EFI_FFS_FILE_HEADER *FfsFileHeader;\r |
602 | UINT32 FileSize;\r | |
603 | EFI_COMMON_SECTION_HEADER *Section;\r | |
b0d803fe | 604 | \r |
605 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);\r | |
192f6d4c | 606 | \r |
607 | //\r | |
608 | // Size is 24 bits wide so mask upper 8 bits. \r | |
b0d803fe | 609 | // Does not include FfsFileHeader header size\r |
192f6d4c | 610 | // FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.\r |
611 | //\r | |
612 | Section = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);\r | |
613 | FileSize = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
b0d803fe | 614 | FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r |
615 | \r | |
616 | return PeiFfsProcessSection (\r | |
288f9b38 | 617 | PeiServices,\r |
b0d803fe | 618 | SectionType, \r |
619 | Section, \r | |
620 | FileSize, \r | |
288f9b38 | 621 | SectionData\r |
b0d803fe | 622 | );\r |
192f6d4c | 623 | }\r |
624 | \r | |
625 | \r | |
192f6d4c | 626 | EFI_STATUS\r |
627 | EFIAPI\r | |
628 | PeiFfsFindNextFile (\r | |
0c2b5da8 | 629 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
630 | IN UINT8 SearchType,\r | |
631 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
632 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
192f6d4c | 633 | )\r |
634 | /*++\r | |
635 | \r | |
636 | Routine Description:\r | |
637 | Given the input file pointer, search for the next matching file in the\r | |
638 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r | |
639 | the Firmware Volume defined by FwVolHeader.\r | |
640 | \r | |
641 | Arguments:\r | |
642 | PeiServices - Pointer to the PEI Core Services Table.\r | |
643 | \r | |
644 | SearchType - Filter to find only files of this type.\r | |
645 | Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r | |
646 | \r | |
647 | FwVolHeader - Pointer to the FV header of the volume to search.\r | |
648 | This parameter must point to a valid FFS volume.\r | |
649 | \r | |
650 | FileHeader - Pointer to the current file from which to begin searching.\r | |
651 | This pointer will be updated upon return to reflect the file found.\r | |
652 | \r | |
653 | Returns:\r | |
654 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
655 | EFI_SUCCESS\r | |
656 | \r | |
657 | --*/\r | |
658 | {\r | |
b0d803fe | 659 | return PeiFindFileEx (VolumeHandle, NULL, SearchType, FileHandle, NULL);\r |
192f6d4c | 660 | }\r |
661 | \r | |
b0d803fe | 662 | \r |
192f6d4c | 663 | EFI_STATUS \r |
664 | EFIAPI\r | |
665 | PeiFvFindNextVolume (\r | |
0c2b5da8 | 666 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 667 | IN UINTN Instance,\r |
0c2b5da8 | 668 | IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r |
192f6d4c | 669 | )\r |
670 | /*++\r | |
671 | \r | |
672 | Routine Description:\r | |
673 | \r | |
288f9b38 | 674 | Return the firmware volumes.\r |
192f6d4c | 675 | \r |
676 | BugBug -- Move this to the location of this code to where the\r | |
677 | other FV and FFS support code lives.\r | |
678 | Also, update to use FindFV for instances #'s >= 1.\r | |
679 | \r | |
680 | Arguments:\r | |
681 | \r | |
682 | PeiServices - The PEI core services table.\r | |
683 | Instance - Instance of FV to find\r | |
684 | FwVolHeader - Pointer to contain the data to return\r | |
685 | \r | |
686 | Returns:\r | |
687 | Pointer to the Firmware Volume instance requested\r | |
688 | \r | |
689 | EFI_INVALID_PARAMETER - FwVolHeader is NULL\r | |
690 | \r | |
691 | EFI_SUCCESS - Firmware volume instance successfully found.\r | |
692 | \r | |
693 | --*/\r | |
694 | {\r | |
b0d803fe | 695 | PEI_CORE_INSTANCE *Private;\r |
192f6d4c | 696 | \r |
b0d803fe | 697 | Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r |
698 | if (VolumeHandle == NULL) {\r | |
699 | return EFI_INVALID_PARAMETER;\r | |
700 | } \r | |
192f6d4c | 701 | \r |
b0d803fe | 702 | if (Instance >= Private->AllFvCount) {\r |
703 | VolumeHandle = NULL;\r | |
704 | return EFI_NOT_FOUND;\r | |
705 | }\r | |
192f6d4c | 706 | \r |
b0d803fe | 707 | *VolumeHandle = Private->AllFv[Instance];\r |
708 | return EFI_SUCCESS;\r | |
709 | }\r | |
192f6d4c | 710 | \r |
192f6d4c | 711 | \r |
b0d803fe | 712 | EFI_STATUS\r |
713 | EFIAPI \r | |
714 | PeiFfsFindFileByName (\r | |
715 | IN CONST EFI_GUID *FileName,\r | |
716 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
717 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
718 | )\r | |
719 | /*++\r | |
720 | \r | |
721 | Routine Description:\r | |
722 | \r | |
723 | Given the input VolumeHandle, search for the next matching name file.\r | |
724 | \r | |
725 | Arguments:\r | |
726 | \r | |
727 | FileName - File name to search.\r | |
728 | VolumeHandle - The current FV to search.\r | |
729 | FileHandle - Pointer to the file matching name in VolumeHandle.\r | |
730 | - NULL if file not found\r | |
731 | Returns:\r | |
732 | EFI_STATUS\r | |
733 | \r | |
734 | --*/ \r | |
735 | {\r | |
736 | EFI_STATUS Status;\r | |
737 | if ((VolumeHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {\r | |
192f6d4c | 738 | return EFI_INVALID_PARAMETER;\r |
739 | }\r | |
b0d803fe | 740 | Status = PeiFindFileEx (VolumeHandle, FileName, 0, FileHandle, NULL);\r |
741 | if (Status == EFI_NOT_FOUND) {\r | |
742 | *FileHandle = NULL;\r | |
743 | }\r | |
744 | return Status;\r | |
745 | }\r | |
746 | \r | |
747 | EFI_STATUS\r | |
748 | EFIAPI \r | |
749 | PeiFfsGetFileInfo (\r | |
750 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
751 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
752 | )\r | |
753 | /*++\r | |
754 | \r | |
755 | Routine Description:\r | |
192f6d4c | 756 | \r |
b0d803fe | 757 | Collect information of given file.\r |
192f6d4c | 758 | \r |
b0d803fe | 759 | Arguments:\r |
760 | FileHandle - The handle to file.\r | |
761 | FileInfo - Pointer to the file information.\r | |
192f6d4c | 762 | \r |
b0d803fe | 763 | Returns:\r |
764 | EFI_STATUS\r | |
765 | \r | |
766 | --*/ \r | |
767 | {\r | |
768 | UINT8 FileState;\r | |
769 | UINT8 ErasePolarity;\r | |
770 | EFI_FFS_FILE_HEADER *FileHeader;\r | |
771 | EFI_PEI_FV_HANDLE VolumeHandle;\r | |
772 | \r | |
773 | if ((FileHandle == NULL) || (FileInfo == NULL)) {\r | |
774 | return EFI_INVALID_PARAMETER;\r | |
775 | }\r | |
776 | \r | |
173b35e4 | 777 | VolumeHandle = 0;\r |
b0d803fe | 778 | //\r |
779 | // Retrieve the FirmwareVolume which the file resides in.\r | |
780 | //\r | |
781 | if (!PeiFileHandleToVolume(FileHandle, &VolumeHandle)) {\r | |
782 | return EFI_INVALID_PARAMETER;\r | |
783 | }\r | |
784 | \r | |
797a9d67 | 785 | if (((EFI_FIRMWARE_VOLUME_HEADER*)VolumeHandle)->Attributes & EFI_FVB2_ERASE_POLARITY) {\r |
b0d803fe | 786 | ErasePolarity = 1;\r |
192f6d4c | 787 | } else {\r |
b0d803fe | 788 | ErasePolarity = 0;\r |
789 | }\r | |
790 | \r | |
791 | //\r | |
792 | // Get FileState which is the highest bit of the State \r | |
793 | //\r | |
794 | FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);\r | |
192f6d4c | 795 | \r |
b0d803fe | 796 | switch (FileState) {\r |
797 | case EFI_FILE_DATA_VALID:\r | |
798 | case EFI_FILE_MARKED_FOR_UPDATE:\r | |
799 | break; \r | |
800 | default:\r | |
801 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 802 | }\r |
b0d803fe | 803 | \r |
804 | FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;\r | |
805 | CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));\r | |
806 | FileInfo->FileType = FileHeader->Type;\r | |
807 | FileInfo->FileAttributes = FileHeader->Attributes;\r | |
808 | FileInfo->BufferSize = ((*(UINT32 *)FileHeader->Size) & 0x00FFFFFF) - sizeof (EFI_FFS_FILE_HEADER);\r | |
809 | FileInfo->Buffer = (FileHeader + 1);\r | |
810 | return EFI_SUCCESS;\r | |
811 | }\r | |
812 | \r | |
813 | \r | |
814 | EFI_STATUS\r | |
815 | EFIAPI \r | |
816 | PeiFfsGetVolumeInfo (\r | |
817 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
818 | OUT EFI_FV_INFO *VolumeInfo\r | |
819 | )\r | |
820 | /*++\r | |
821 | \r | |
822 | Routine Description:\r | |
823 | \r | |
824 | Collect information of given Fv Volume.\r | |
825 | \r | |
826 | Arguments:\r | |
827 | VolumeHandle - The handle to Fv Volume.\r | |
828 | VolumeInfo - The pointer to volume information.\r | |
829 | \r | |
830 | Returns:\r | |
831 | EFI_STATUS\r | |
832 | \r | |
833 | --*/ \r | |
834 | {\r | |
288f9b38 | 835 | EFI_FIRMWARE_VOLUME_HEADER FwVolHeader;\r |
b0d803fe | 836 | EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r |
837 | \r | |
838 | if (VolumeInfo == NULL) {\r | |
839 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 840 | }\r |
288f9b38 LG |
841 | \r |
842 | //\r | |
843 | // VolumeHandle may not align at 8 byte, \r | |
844 | // but FvLength is UINT64 type, which requires FvHeader align at least 8 byte. \r | |
845 | // So, Copy FvHeader into the local FvHeader structure.\r | |
846 | //\r | |
847 | CopyMem (&FwVolHeader, VolumeHandle, sizeof (EFI_FIRMWARE_VOLUME_HEADER));\r | |
848 | //\r | |
849 | // Check Fv Image Signature\r | |
850 | //\r | |
851 | if (FwVolHeader.Signature != EFI_FVH_SIGNATURE) {\r | |
852 | return EFI_INVALID_PARAMETER;\r | |
853 | }\r | |
854 | VolumeInfo->FvAttributes = FwVolHeader.Attributes;\r | |
855 | VolumeInfo->FvStart = (VOID *) VolumeHandle;\r | |
856 | VolumeInfo->FvSize = FwVolHeader.FvLength;\r | |
857 | CopyMem (&VolumeInfo->FvFormat, &FwVolHeader.FileSystemGuid, sizeof(EFI_GUID));\r | |
b0d803fe | 858 | \r |
288f9b38 LG |
859 | if (FwVolHeader.ExtHeaderOffset != 0) {\r |
860 | FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)VolumeHandle) + FwVolHeader.ExtHeaderOffset);\r | |
b0d803fe | 861 | CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));\r |
862 | }\r | |
863 | return EFI_SUCCESS;\r | |
192f6d4c | 864 | }\r |
b0d803fe | 865 | \r |