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