]>
Commit | Line | Data |
---|---|---|
192f6d4c | 1 | /*++\r |
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 | |
20 | --*/\r | |
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 | |
145 | if (((UINT64) FileHandle > (UINT64) FwVolHeader ) && \\r | |
146 | ((UINT64) FileHandle <= ((UINT64) FwVolHeader + FwVolHeader->FvLength - 1))) {\r | |
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 | |
b0d803fe | 201 | if (FwVolHeader->Attributes & EFI_FVB_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 | |
227 | \r | |
228 | FileOffset = (UINT32) ((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);\r | |
229 | ASSERT (FileOffset <= 0xFFFFFFFF);\r | |
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 |
247 | return EFI_NOT_FOUND;\r | |
248 | }\r | |
b0d803fe | 249 | \r |
250 | FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
251 | FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r | |
252 | \r | |
253 | if (FileName != NULL) {\r | |
254 | if (CompareGuid (&FfsFileHeader->Name, (EFI_GUID*)FileName)) {\r | |
255 | *FileHeader = FfsFileHeader;\r | |
256 | return EFI_SUCCESS;\r | |
257 | }\r | |
258 | } else if (SearchType == PEI_CORE_INTERNAL_FFS_FILE_DISPATCH_TYPE) {\r | |
259 | if ((FfsFileHeader->Type == EFI_FV_FILETYPE_PEIM) || \r | |
260 | (FfsFileHeader->Type == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER)) { \r | |
261 | \r | |
262 | *FileHeader = FfsFileHeader;\r | |
263 | return EFI_SUCCESS;\r | |
264 | } else if (AprioriFile != NULL) {\r | |
265 | if (FfsFileHeader->Type == EFI_FV_FILETYPE_FREEFORM) {\r | |
266 | if (CompareGuid (&FfsFileHeader->Name, &gPeiAprioriFileNameGuid)) {\r | |
267 | *AprioriFile = FfsFileHeader;\r | |
268 | } \r | |
269 | } \r | |
270 | }\r | |
271 | } else if ((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) { \r | |
272 | *FileHeader = FfsFileHeader;\r | |
273 | return EFI_SUCCESS;\r | |
274 | }\r | |
275 | \r | |
276 | FileOffset += FileOccupiedSize; \r | |
277 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r | |
192f6d4c | 278 | break;\r |
279 | \r | |
280 | case EFI_FILE_DELETED:\r | |
281 | FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
b0d803fe | 282 | FileOccupiedSize = GET_OCCUPIED_SIZE(FileLength, 8);\r |
192f6d4c | 283 | FileOffset += FileOccupiedSize;\r |
284 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r | |
285 | break;\r | |
286 | \r | |
287 | default:\r | |
288 | return EFI_NOT_FOUND;\r | |
289 | \r | |
290 | } \r | |
291 | }\r | |
292 | \r | |
293 | return EFI_NOT_FOUND; \r | |
294 | }\r | |
295 | \r | |
b0d803fe | 296 | VOID \r |
297 | PeiInitializeFv (\r | |
298 | IN PEI_CORE_INSTANCE *PrivateData,\r | |
299 | IN CONST EFI_SEC_PEI_HAND_OFF *SecCoreData\r | |
300 | )\r | |
301 | /*++\r | |
302 | \r | |
303 | Routine Description:\r | |
304 | \r | |
305 | Initialize PeiCore Fv List.\r | |
306 | \r | |
307 | Arguments:\r | |
308 | PrivateData - Pointer to PEI_CORE_INSTANCE.\r | |
309 | SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.\r | |
310 | \r | |
311 | Returns:\r | |
312 | NONE \r | |
313 | \r | |
314 | --*/ \r | |
315 | {\r | |
316 | EFI_STATUS Status;\r | |
317 | //\r | |
318 | // The BFV must be the first entry. The Core FV support is stateless \r | |
319 | // The AllFV list has a single entry per FV in PEI. \r | |
320 | // The Fv list only includes FV that PEIMs will be dispatched from and\r | |
321 | // its File System Format is PI 1.0 definition.\r | |
322 | //\r | |
323 | PrivateData->FvCount = 1;\r | |
324 | PrivateData->Fv[0].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER *)SecCoreData->BootFirmwareVolumeBase;\r | |
325 | \r | |
326 | PrivateData->AllFvCount = 1;\r | |
327 | PrivateData->AllFv[0] = (EFI_PEI_FV_HANDLE)PrivateData->Fv[0].FvHeader;\r | |
328 | \r | |
329 | \r | |
330 | //\r | |
331 | // Post a call-back for the FvInfoPPI services to expose\r | |
332 | // additional Fvs to PeiCore.\r | |
333 | //\r | |
334 | Status = PeiServicesNotifyPpi (&mNotifyOnFvInfoList);\r | |
335 | ASSERT_EFI_ERROR (Status);\r | |
336 | \r | |
337 | }\r | |
338 | \r | |
339 | EFI_STATUS\r | |
340 | EFIAPI\r | |
341 | FirmwareVolmeInfoPpiNotifyCallback (\r | |
342 | IN EFI_PEI_SERVICES **PeiServices,\r | |
343 | IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r | |
344 | IN VOID *Ppi\r | |
345 | )\r | |
346 | /*++\r | |
347 | \r | |
348 | Routine Description:\r | |
349 | \r | |
350 | Process Firmware Volum Information once FvInfoPPI install.\r | |
351 | \r | |
352 | Arguments:\r | |
353 | \r | |
354 | PeiServices - General purpose services available to every PEIM.\r | |
355 | \r | |
356 | Returns:\r | |
357 | \r | |
358 | Status - EFI_SUCCESS if the interface could be successfully\r | |
359 | installed\r | |
360 | \r | |
361 | --*/\r | |
362 | {\r | |
363 | UINT8 FvCount;\r | |
364 | EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *Fv;\r | |
365 | PEI_CORE_INSTANCE *PrivateData;\r | |
366 | \r | |
367 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r | |
368 | \r | |
369 | if (PrivateData->FvCount >= PEI_CORE_MAX_FV_SUPPORTED) {\r | |
370 | ASSERT (FALSE);\r | |
371 | }\r | |
372 | \r | |
373 | Fv = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\r | |
374 | \r | |
375 | if (CompareGuid (&Fv->FvFormat, &gEfiFirmwareFileSystem2Guid)) {\r | |
376 | for (FvCount = 0; FvCount < PrivateData->FvCount; FvCount ++) {\r | |
377 | if ((UINTN)PrivateData->Fv[FvCount].FvHeader == (UINTN)Fv->FvInfo) {\r | |
378 | return EFI_SUCCESS;\r | |
379 | }\r | |
380 | }\r | |
381 | PrivateData->Fv[PrivateData->FvCount++].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo;\r | |
382 | BuildFvHob ((EFI_PHYSICAL_ADDRESS) (UINTN) Fv->FvInfo, (UINT64) Fv->FvInfoSize);\r | |
383 | }\r | |
384 | \r | |
385 | //\r | |
386 | // Allways add to the All list\r | |
387 | //\r | |
388 | PrivateData->AllFv[PrivateData->AllFvCount++] = (EFI_PEI_FV_HANDLE)Fv->FvInfo;\r | |
389 | \r | |
390 | return EFI_SUCCESS;\r | |
391 | }\r | |
392 | \r | |
393 | EFI_STATUS\r | |
394 | PeiFfsProcessSection (\r | |
395 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
396 | IN EFI_SECTION_TYPE SectionType,\r | |
397 | IN EFI_COMMON_SECTION_HEADER *Section,\r | |
398 | IN UINTN SectionSize,\r | |
399 | OUT VOID **OutputBuffer,\r | |
400 | OUT UINTN *OutputSize,\r | |
401 | OUT UINT32 *Authentication\r | |
402 | )\r | |
403 | /*++\r | |
404 | \r | |
405 | Routine Description:\r | |
406 | \r | |
407 | Go through the file to search SectionType section,\r | |
408 | when meeting an encapsuled section, search recursively. \r | |
409 | \r | |
410 | Arguments:\r | |
411 | PeiServices - Pointer to the PEI Core Services Table.\r | |
412 | SearchType - Filter to find only section of this type.\r | |
413 | Section - From where to search.\r | |
414 | SectionSize - The file size to search.\r | |
415 | OutputBuffer - Pointer to the section to search.\r | |
416 | OutputSize - The size of the section to search.\r | |
417 | Authentication - Authenticate the section.\r | |
418 | \r | |
419 | Returns:\r | |
420 | EFI_STATUS\r | |
421 | \r | |
422 | --*/\r | |
423 | {\r | |
424 | EFI_STATUS Status;\r | |
425 | UINT32 SectionLength;\r | |
426 | UINT32 ParsedLength;\r | |
427 | EFI_GUID_DEFINED_SECTION *GuidSection; \r | |
428 | EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *GuidSectionPpi;\r | |
429 | EFI_COMPRESSION_SECTION *CompressionSection;\r | |
430 | EFI_PEI_DECOMPRESS_PPI *DecompressPpi;\r | |
431 | VOID *PpiOutput;\r | |
432 | UINTN PpiOutputSize;\r | |
433 | \r | |
434 | *OutputBuffer = NULL;\r | |
435 | ParsedLength = 0;\r | |
436 | while (ParsedLength < SectionSize) {\r | |
437 | if (Section->Type == SectionType) {\r | |
438 | *OutputBuffer = (VOID *)(Section + 1);\r | |
439 | return EFI_SUCCESS;\r | |
440 | } else if (Section->Type == EFI_SECTION_GUID_DEFINED) {\r | |
441 | GuidSection = (EFI_GUID_DEFINED_SECTION *)Section;\r | |
442 | Status = PeiServicesLocatePpi (&GuidSection->SectionDefinitionGuid, 0, NULL, (VOID **) &GuidSectionPpi);\r | |
443 | if (!EFI_ERROR (Status)) {\r | |
444 | Status = GuidSectionPpi->ExtractSection (\r | |
445 | GuidSectionPpi,\r | |
446 | Section,\r | |
447 | &PpiOutput,\r | |
448 | &PpiOutputSize,\r | |
449 | Authentication\r | |
450 | );\r | |
451 | if (!EFI_ERROR (Status)) {\r | |
452 | return PeiFfsProcessSection (\r | |
453 | PeiServices,\r | |
454 | SectionType, \r | |
455 | PpiOutput, \r | |
456 | PpiOutputSize, \r | |
457 | OutputBuffer, \r | |
458 | OutputSize, \r | |
459 | Authentication\r | |
460 | );\r | |
461 | }\r | |
462 | }\r | |
463 | } else if (Section->Type == EFI_SECTION_COMPRESSION) {\r | |
464 | CompressionSection = (EFI_COMPRESSION_SECTION *)Section;\r | |
465 | Status = PeiServicesLocatePpi (&gEfiPeiDecompressPpiGuid, 0, NULL, (VOID **) &DecompressPpi);\r | |
466 | if (!EFI_ERROR (Status)) {\r | |
467 | Status = DecompressPpi->Decompress (\r | |
468 | DecompressPpi,\r | |
469 | CompressionSection,\r | |
470 | &PpiOutput,\r | |
471 | &PpiOutputSize\r | |
472 | );\r | |
473 | if (!EFI_ERROR (Status)) {\r | |
474 | return PeiFfsProcessSection (\r | |
475 | PeiServices, SectionType, PpiOutput, PpiOutputSize, OutputBuffer, OutputSize, Authentication\r | |
476 | );\r | |
477 | }\r | |
478 | }\r | |
479 | }\r | |
480 | \r | |
481 | //\r | |
482 | // Size is 24 bits wide so mask upper 8 bits. \r | |
483 | // SectionLength is adjusted it is 4 byte aligned.\r | |
484 | // Go to the next section\r | |
485 | //\r | |
486 | SectionLength = *(UINT32 *)Section->Size & 0x00FFFFFF;\r | |
487 | SectionLength = GET_OCCUPIED_SIZE (SectionLength, 4);\r | |
488 | ASSERT (SectionLength != 0);\r | |
489 | ParsedLength += SectionLength;\r | |
490 | Section = (EFI_COMMON_SECTION_HEADER *)((UINT8 *)Section + SectionLength);\r | |
491 | }\r | |
492 | \r | |
493 | return EFI_NOT_FOUND;\r | |
494 | }\r | |
495 | \r | |
192f6d4c | 496 | \r |
497 | EFI_STATUS\r | |
498 | EFIAPI\r | |
499 | PeiFfsFindSectionData (\r | |
0c2b5da8 | 500 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 501 | IN EFI_SECTION_TYPE SectionType,\r |
0c2b5da8 | 502 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
192f6d4c | 503 | IN OUT VOID **SectionData\r |
504 | )\r | |
505 | /*++\r | |
506 | \r | |
507 | Routine Description:\r | |
508 | Given the input file pointer, search for the next matching section in the\r | |
509 | FFS volume.\r | |
510 | \r | |
511 | Arguments:\r | |
512 | PeiServices - Pointer to the PEI Core Services Table.\r | |
513 | SearchType - Filter to find only sections of this type.\r | |
514 | FfsFileHeader - Pointer to the current file to search.\r | |
515 | SectionData - Pointer to the Section matching SectionType in FfsFileHeader.\r | |
516 | - NULL if section not found\r | |
517 | \r | |
518 | Returns:\r | |
519 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
520 | EFI_SUCCESS\r | |
521 | \r | |
522 | --*/\r | |
523 | {\r | |
b0d803fe | 524 | EFI_FFS_FILE_HEADER *FfsFileHeader;\r |
525 | UINT32 FileSize;\r | |
526 | EFI_COMMON_SECTION_HEADER *Section;\r | |
527 | UINTN OutputSize;\r | |
528 | UINT32 AuthenticationStatus;\r | |
529 | \r | |
530 | \r | |
531 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);\r | |
192f6d4c | 532 | \r |
533 | //\r | |
534 | // Size is 24 bits wide so mask upper 8 bits. \r | |
b0d803fe | 535 | // Does not include FfsFileHeader header size\r |
192f6d4c | 536 | // FileSize is adjusted to FileOccupiedSize as it is 8 byte aligned.\r |
537 | //\r | |
538 | Section = (EFI_COMMON_SECTION_HEADER *)(FfsFileHeader + 1);\r | |
539 | FileSize = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r | |
b0d803fe | 540 | FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r |
541 | \r | |
542 | return PeiFfsProcessSection (\r | |
543 | PeiServices, \r | |
544 | SectionType, \r | |
545 | Section, \r | |
546 | FileSize, \r | |
547 | SectionData, \r | |
548 | &OutputSize, \r | |
549 | &AuthenticationStatus\r | |
550 | );\r | |
192f6d4c | 551 | }\r |
552 | \r | |
553 | \r | |
554 | EFI_STATUS\r | |
555 | FindNextPeim (\r | |
556 | IN EFI_PEI_SERVICES **PeiServices,\r | |
557 | IN EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader,\r | |
558 | IN OUT EFI_FFS_FILE_HEADER **PeimFileHeader\r | |
559 | )\r | |
560 | /*++\r | |
561 | \r | |
562 | Routine Description:\r | |
563 | Given the input file pointer, search for the next matching file in the\r | |
564 | FFS volume. The search starts from FileHeader inside\r | |
565 | the Firmware Volume defined by FwVolHeader.\r | |
566 | \r | |
567 | Arguments:\r | |
568 | PeiServices - Pointer to the PEI Core Services Table.\r | |
569 | \r | |
570 | FwVolHeader - Pointer to the FV header of the volume to search.\r | |
571 | This parameter must point to a valid FFS volume.\r | |
572 | \r | |
573 | PeimFileHeader - Pointer to the current file from which to begin searching.\r | |
574 | This pointer will be updated upon return to reflect the file found.\r | |
575 | \r | |
576 | Returns:\r | |
577 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
578 | EFI_SUCCESS\r | |
579 | \r | |
580 | --*/\r | |
581 | {\r | |
b0d803fe | 582 | return PeiFindFileEx (\r |
583 | (EFI_PEI_FV_HANDLE) FwVolHeader, \r | |
584 | NULL, \r | |
585 | EFI_FV_FILETYPE_PEIM, \r | |
586 | (EFI_PEI_FILE_HANDLE *)PeimFileHeader, \r | |
587 | NULL\r | |
192f6d4c | 588 | );\r |
589 | }\r | |
590 | \r | |
591 | EFI_STATUS\r | |
592 | EFIAPI\r | |
593 | PeiFfsFindNextFile (\r | |
0c2b5da8 | 594 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
595 | IN UINT8 SearchType,\r | |
596 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
597 | IN OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
192f6d4c | 598 | )\r |
599 | /*++\r | |
600 | \r | |
601 | Routine Description:\r | |
602 | Given the input file pointer, search for the next matching file in the\r | |
603 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r | |
604 | the Firmware Volume defined by FwVolHeader.\r | |
605 | \r | |
606 | Arguments:\r | |
607 | PeiServices - Pointer to the PEI Core Services Table.\r | |
608 | \r | |
609 | SearchType - Filter to find only files of this type.\r | |
610 | Type EFI_FV_FILETYPE_ALL causes no filtering to be done.\r | |
611 | \r | |
612 | FwVolHeader - Pointer to the FV header of the volume to search.\r | |
613 | This parameter must point to a valid FFS volume.\r | |
614 | \r | |
615 | FileHeader - Pointer to the current file from which to begin searching.\r | |
616 | This pointer will be updated upon return to reflect the file found.\r | |
617 | \r | |
618 | Returns:\r | |
619 | EFI_NOT_FOUND - No files matching the search criteria were found\r | |
620 | EFI_SUCCESS\r | |
621 | \r | |
622 | --*/\r | |
623 | {\r | |
b0d803fe | 624 | return PeiFindFileEx (VolumeHandle, NULL, SearchType, FileHandle, NULL);\r |
192f6d4c | 625 | }\r |
626 | \r | |
b0d803fe | 627 | \r |
192f6d4c | 628 | EFI_STATUS \r |
629 | EFIAPI\r | |
630 | PeiFvFindNextVolume (\r | |
0c2b5da8 | 631 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 632 | IN UINTN Instance,\r |
0c2b5da8 | 633 | IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r |
192f6d4c | 634 | )\r |
635 | /*++\r | |
636 | \r | |
637 | Routine Description:\r | |
638 | \r | |
639 | Return the BFV location\r | |
640 | \r | |
641 | BugBug -- Move this to the location of this code to where the\r | |
642 | other FV and FFS support code lives.\r | |
643 | Also, update to use FindFV for instances #'s >= 1.\r | |
644 | \r | |
645 | Arguments:\r | |
646 | \r | |
647 | PeiServices - The PEI core services table.\r | |
648 | Instance - Instance of FV to find\r | |
649 | FwVolHeader - Pointer to contain the data to return\r | |
650 | \r | |
651 | Returns:\r | |
652 | Pointer to the Firmware Volume instance requested\r | |
653 | \r | |
654 | EFI_INVALID_PARAMETER - FwVolHeader is NULL\r | |
655 | \r | |
656 | EFI_SUCCESS - Firmware volume instance successfully found.\r | |
657 | \r | |
658 | --*/\r | |
659 | {\r | |
b0d803fe | 660 | PEI_CORE_INSTANCE *Private;\r |
192f6d4c | 661 | \r |
b0d803fe | 662 | Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r |
663 | if (VolumeHandle == NULL) {\r | |
664 | return EFI_INVALID_PARAMETER;\r | |
665 | } \r | |
192f6d4c | 666 | \r |
b0d803fe | 667 | if (Instance >= Private->AllFvCount) {\r |
668 | VolumeHandle = NULL;\r | |
669 | return EFI_NOT_FOUND;\r | |
670 | }\r | |
192f6d4c | 671 | \r |
b0d803fe | 672 | *VolumeHandle = Private->AllFv[Instance];\r |
673 | return EFI_SUCCESS;\r | |
674 | }\r | |
192f6d4c | 675 | \r |
192f6d4c | 676 | \r |
b0d803fe | 677 | EFI_STATUS\r |
678 | EFIAPI \r | |
679 | PeiFfsFindFileByName (\r | |
680 | IN CONST EFI_GUID *FileName,\r | |
681 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
682 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
683 | )\r | |
684 | /*++\r | |
685 | \r | |
686 | Routine Description:\r | |
687 | \r | |
688 | Given the input VolumeHandle, search for the next matching name file.\r | |
689 | \r | |
690 | Arguments:\r | |
691 | \r | |
692 | FileName - File name to search.\r | |
693 | VolumeHandle - The current FV to search.\r | |
694 | FileHandle - Pointer to the file matching name in VolumeHandle.\r | |
695 | - NULL if file not found\r | |
696 | Returns:\r | |
697 | EFI_STATUS\r | |
698 | \r | |
699 | --*/ \r | |
700 | {\r | |
701 | EFI_STATUS Status;\r | |
702 | if ((VolumeHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {\r | |
192f6d4c | 703 | return EFI_INVALID_PARAMETER;\r |
704 | }\r | |
b0d803fe | 705 | Status = PeiFindFileEx (VolumeHandle, FileName, 0, FileHandle, NULL);\r |
706 | if (Status == EFI_NOT_FOUND) {\r | |
707 | *FileHandle = NULL;\r | |
708 | }\r | |
709 | return Status;\r | |
710 | }\r | |
711 | \r | |
712 | EFI_STATUS\r | |
713 | EFIAPI \r | |
714 | PeiFfsGetFileInfo (\r | |
715 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
716 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
717 | )\r | |
718 | /*++\r | |
719 | \r | |
720 | Routine Description:\r | |
192f6d4c | 721 | \r |
b0d803fe | 722 | Collect information of given file.\r |
192f6d4c | 723 | \r |
b0d803fe | 724 | Arguments:\r |
725 | FileHandle - The handle to file.\r | |
726 | FileInfo - Pointer to the file information.\r | |
192f6d4c | 727 | \r |
b0d803fe | 728 | Returns:\r |
729 | EFI_STATUS\r | |
730 | \r | |
731 | --*/ \r | |
732 | {\r | |
733 | UINT8 FileState;\r | |
734 | UINT8 ErasePolarity;\r | |
735 | EFI_FFS_FILE_HEADER *FileHeader;\r | |
736 | EFI_PEI_FV_HANDLE VolumeHandle;\r | |
737 | \r | |
738 | if ((FileHandle == NULL) || (FileInfo == NULL)) {\r | |
739 | return EFI_INVALID_PARAMETER;\r | |
740 | }\r | |
741 | \r | |
742 | //\r | |
743 | // Retrieve the FirmwareVolume which the file resides in.\r | |
744 | //\r | |
745 | if (!PeiFileHandleToVolume(FileHandle, &VolumeHandle)) {\r | |
746 | return EFI_INVALID_PARAMETER;\r | |
747 | }\r | |
748 | \r | |
749 | if (((EFI_FIRMWARE_VOLUME_HEADER*)VolumeHandle)->Attributes & EFI_FVB_ERASE_POLARITY) {\r | |
750 | ErasePolarity = 1;\r | |
192f6d4c | 751 | } else {\r |
b0d803fe | 752 | ErasePolarity = 0;\r |
753 | }\r | |
754 | \r | |
755 | //\r | |
756 | // Get FileState which is the highest bit of the State \r | |
757 | //\r | |
758 | FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);\r | |
192f6d4c | 759 | \r |
b0d803fe | 760 | switch (FileState) {\r |
761 | case EFI_FILE_DATA_VALID:\r | |
762 | case EFI_FILE_MARKED_FOR_UPDATE:\r | |
763 | break; \r | |
764 | default:\r | |
765 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 766 | }\r |
b0d803fe | 767 | \r |
768 | FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;\r | |
769 | CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));\r | |
770 | FileInfo->FileType = FileHeader->Type;\r | |
771 | FileInfo->FileAttributes = FileHeader->Attributes;\r | |
772 | FileInfo->BufferSize = ((*(UINT32 *)FileHeader->Size) & 0x00FFFFFF) - sizeof (EFI_FFS_FILE_HEADER);\r | |
773 | FileInfo->Buffer = (FileHeader + 1);\r | |
774 | return EFI_SUCCESS;\r | |
775 | }\r | |
776 | \r | |
777 | \r | |
778 | EFI_STATUS\r | |
779 | EFIAPI \r | |
780 | PeiFfsGetVolumeInfo (\r | |
781 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
782 | OUT EFI_FV_INFO *VolumeInfo\r | |
783 | )\r | |
784 | /*++\r | |
785 | \r | |
786 | Routine Description:\r | |
787 | \r | |
788 | Collect information of given Fv Volume.\r | |
789 | \r | |
790 | Arguments:\r | |
791 | VolumeHandle - The handle to Fv Volume.\r | |
792 | VolumeInfo - The pointer to volume information.\r | |
793 | \r | |
794 | Returns:\r | |
795 | EFI_STATUS\r | |
796 | \r | |
797 | --*/ \r | |
798 | {\r | |
799 | EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;\r | |
800 | EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r | |
801 | \r | |
802 | if (VolumeInfo == NULL) {\r | |
803 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 804 | }\r |
b0d803fe | 805 | \r |
806 | FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *)(VolumeHandle);\r | |
807 | VolumeInfo->FvAttributes = FwVolHeader->Attributes;\r | |
808 | VolumeInfo->FvStart = FwVolHeader;\r | |
809 | VolumeInfo->FvSize = FwVolHeader->FvLength;\r | |
810 | CopyMem (&VolumeInfo->FvFormat, &FwVolHeader->FileSystemGuid,sizeof(EFI_GUID));\r | |
811 | \r | |
812 | if (FwVolHeader->ExtHeaderOffset != 0) {\r | |
813 | FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)FwVolHeader) + FwVolHeader->ExtHeaderOffset);\r | |
814 | CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));\r | |
815 | }\r | |
816 | return EFI_SUCCESS;\r | |
192f6d4c | 817 | }\r |
b0d803fe | 818 | \r |