]>
Commit | Line | Data |
---|---|---|
615c6dd0 | 1 | /** @file\r |
b1f6a7c6 | 2 | Pei Core Firmware File System service routines.\r |
3 | \r | |
ed299e3c | 4 | Copyright (c) 2006 - 2008, Intel Corporation \r |
192f6d4c | 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 | |
615c6dd0 | 13 | **/\r |
192f6d4c | 14 | \r |
192f6d4c | 15 | #include <PeiMain.h>\r |
16 | \r | |
b0d803fe | 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 | |
ed299e3c | 25 | ((ActualSize) + (((Alignment) - ((ActualSize) & ((Alignment) - 1))) & ((Alignment) - 1)))\r |
192f6d4c | 26 | \r |
b1f6a7c6 | 27 | /**\r |
ed299e3c | 28 | Returns the file state set by the highest zero bit in the State field\r |
192f6d4c | 29 | \r |
b1f6a7c6 | 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 | |
192f6d4c | 33 | \r |
ed299e3c LG |
34 | @retval EFI_FFS_FILE_STATE File state is set by the highest none zero bit \r |
35 | in the header State field.\r | |
b1f6a7c6 | 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 | |
192f6d4c | 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 | |
ed299e3c LG |
51 | \r |
52 | //\r | |
53 | // Get file state set by its highest none zero bit.\r | |
54 | //\r | |
192f6d4c | 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 | |
b1f6a7c6 | 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 | |
b1f6a7c6 | 69 | Zero means the header is good.\r |
70 | Non-zero means the header is bad.\r | |
71 | **/\r | |
192f6d4c | 72 | UINT8\r |
73 | CalculateHeaderChecksum (\r | |
74 | IN EFI_FFS_FILE_HEADER *FileHeader\r | |
75 | )\r | |
192f6d4c | 76 | {\r |
ed299e3c | 77 | EFI_FFS_FILE_HEADER TestFileHeader;\r |
192f6d4c | 78 | \r |
ed299e3c | 79 | CopyMem (&TestFileHeader, FileHeader, sizeof (EFI_FFS_FILE_HEADER));\r |
192f6d4c | 80 | //\r |
ed299e3c | 81 | // Ingore State and File field in FFS header.\r |
192f6d4c | 82 | //\r |
ed299e3c LG |
83 | TestFileHeader.State = 0;\r |
84 | TestFileHeader.IntegrityCheck.Checksum.File = 0;\r | |
192f6d4c | 85 | \r |
ed299e3c | 86 | return CalculateSum8 ((CONST UINT8 *) &TestFileHeader, sizeof (EFI_FFS_FILE_HEADER));\r |
192f6d4c | 87 | }\r |
88 | \r | |
b1f6a7c6 | 89 | /**\r |
90 | Find FV handler according some FileHandle in that FV.\r | |
91 | \r | |
92 | @param FileHandle Handle of file image\r | |
ed299e3c | 93 | @param VolumeHandle Handle of the found FV, if not found, NULL will be set.\r |
b1f6a7c6 | 94 | \r |
ed299e3c LG |
95 | @retval TRUE The corresponding FV handler is found.\r |
96 | @retval FALSE The corresponding FV handler is not found.\r | |
b1f6a7c6 | 97 | \r |
98 | **/\r | |
b0d803fe | 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 | |
67a58d0f | 113 | if (((UINT64) (UINTN) FileHandle > (UINT64) (UINTN) FwVolHeader ) && \\r |
114 | ((UINT64) (UINTN) FileHandle <= ((UINT64) (UINTN) FwVolHeader + FwVolHeader->FvLength - 1))) {\r | |
b0d803fe | 115 | *VolumeHandle = (EFI_PEI_FV_HANDLE)FwVolHeader;\r |
116 | return TRUE;\r | |
117 | }\r | |
118 | }\r | |
ed299e3c | 119 | *VolumeHandle = NULL;\r |
b0d803fe | 120 | return FALSE;\r |
121 | }\r | |
122 | \r | |
b1f6a7c6 | 123 | /**\r |
ed299e3c | 124 | Given the input file pointer, search for the first matching file in the\r |
b1f6a7c6 | 125 | FFS volume as defined by SearchType. The search starts from FileHeader inside\r |
126 | the Firmware Volume defined by FwVolHeader.\r | |
ed299e3c LG |
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 | |
b1f6a7c6 | 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 | |
b0d803fe | 137 | \r |
b1f6a7c6 | 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 | |
192f6d4c | 142 | EFI_STATUS\r |
b0d803fe | 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 | |
192f6d4c | 149 | )\r |
192f6d4c | 150 | {\r |
b0d803fe | 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 | |
192f6d4c | 164 | \r |
165 | FvLength = FwVolHeader->FvLength;\r | |
797a9d67 | 166 | if (FwVolHeader->Attributes & EFI_FVB2_ERASE_POLARITY) {\r |
192f6d4c | 167 | ErasePolarity = 1;\r |
168 | } else {\r | |
169 | ErasePolarity = 0;\r | |
170 | }\r | |
171 | \r | |
172 | //\r | |
b0d803fe | 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 | |
192f6d4c | 176 | //\r |
b0d803fe | 177 | if ((*FileHeader == NULL) || (FileName != NULL)) {\r |
192f6d4c | 178 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FwVolHeader + FwVolHeader->HeaderLength);\r |
b0d803fe | 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 | |
192f6d4c | 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 | |
b0d803fe | 189 | FileOccupiedSize = GET_OCCUPIED_SIZE (FileLength, 8);\r |
192f6d4c | 190 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)*FileHeader + FileOccupiedSize);\r |
191 | }\r | |
e98cd821 | 192 | \r |
192f6d4c | 193 | FileOffset = (UINT32) ((UINT8 *)FfsFileHeader - (UINT8 *)FwVolHeader);\r |
194 | ASSERT (FileOffset <= 0xFFFFFFFF);\r | |
e98cd821 | 195 | \r |
b0d803fe | 196 | while (FileOffset < (FvLength - sizeof (EFI_FFS_FILE_HEADER))) {\r |
192f6d4c | 197 | //\r |
198 | // Get FileState which is the highest bit of the State \r | |
199 | //\r | |
200 | FileState = GetFileState (ErasePolarity, FfsFileHeader);\r | |
192f6d4c | 201 | switch (FileState) {\r |
202 | \r | |
203 | case EFI_FILE_HEADER_INVALID:\r | |
40f26b8f | 204 | FileOffset += sizeof(EFI_FFS_FILE_HEADER);\r |
205 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + sizeof(EFI_FFS_FILE_HEADER));\r | |
192f6d4c | 206 | break;\r |
207 | \r | |
208 | case EFI_FILE_DATA_VALID:\r | |
209 | case EFI_FILE_MARKED_FOR_UPDATE:\r | |
b0d803fe | 210 | if (CalculateHeaderChecksum (FfsFileHeader) != 0) {\r |
192f6d4c | 211 | ASSERT (FALSE);\r |
e98cd821 | 212 | *FileHeader = NULL;\r |
192f6d4c | 213 | return EFI_NOT_FOUND;\r |
214 | }\r | |
b0d803fe | 215 | \r |
40f26b8f | 216 | FileLength = *(UINT32 *)(FfsFileHeader->Size) & 0x00FFFFFF;\r |
b0d803fe | 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 | |
288f9b38 LG |
226 | (FfsFileHeader->Type == EFI_FV_FILETYPE_COMBINED_PEIM_DRIVER) ||\r |
227 | (FfsFileHeader->Type == EFI_FV_FILETYPE_FIRMWARE_VOLUME_IMAGE)) { \r | |
b0d803fe | 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 | |
7e181f2f | 238 | } else if (((SearchType == FfsFileHeader->Type) || (SearchType == EFI_FV_FILETYPE_ALL)) && \r |
239 | (FfsFileHeader->Type != EFI_FV_FILETYPE_FFS_PAD)) { \r | |
b0d803fe | 240 | *FileHeader = FfsFileHeader;\r |
241 | return EFI_SUCCESS;\r | |
242 | }\r | |
243 | \r | |
40f26b8f | 244 | FileOffset += FileOccupiedSize; \r |
245 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)((UINT8 *)FfsFileHeader + FileOccupiedSize);\r | |
192f6d4c | 246 | break;\r |
247 | \r | |
248 | case EFI_FILE_DELETED:\r | |
40f26b8f | 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 | |
192f6d4c | 253 | break;\r |
254 | \r | |
255 | default:\r | |
e98cd821 | 256 | *FileHeader = NULL;\r |
192f6d4c | 257 | return EFI_NOT_FOUND;\r |
192f6d4c | 258 | } \r |
259 | }\r | |
e98cd821 LG |
260 | \r |
261 | *FileHeader = NULL;\r | |
192f6d4c | 262 | return EFI_NOT_FOUND; \r |
263 | }\r | |
264 | \r | |
b1f6a7c6 | 265 | /**\r |
b1f6a7c6 | 266 | Initialize PeiCore Fv List.\r |
267 | \r | |
b1f6a7c6 | 268 | @param PrivateData - Pointer to PEI_CORE_INSTANCE.\r |
269 | @param SecCoreData - Pointer to EFI_SEC_PEI_HAND_OFF.\r | |
b1f6a7c6 | 270 | **/\r |
b0d803fe | 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 | |
b0d803fe | 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 | |
b1f6a7c6 | 300 | /**\r |
301 | Process Firmware Volum Information once FvInfoPPI install.\r | |
ed299e3c LG |
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 | |
b1f6a7c6 | 304 | \r |
ed299e3c | 305 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r |
731bd38e | 306 | @param NotifyDescriptor Address of the notification descriptor data structure.\r |
307 | @param Ppi Address of the PPI that was installed.\r | |
b1f6a7c6 | 308 | \r |
ed299e3c | 309 | @retval EFI_SUCCESS The FV Info is registered into PeiCore private data structure.\r |
b1f6a7c6 | 310 | \r |
311 | **/\r | |
b0d803fe | 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 | |
b0d803fe | 319 | {\r |
320 | UINT8 FvCount;\r | |
321 | EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *Fv;\r | |
322 | PEI_CORE_INSTANCE *PrivateData;\r | |
288f9b38 LG |
323 | EFI_PEI_FILE_HANDLE FileHandle;\r |
324 | VOID *DepexData;\r | |
325 | UINT32 AuthenticationStatus;\r | |
326 | EFI_STATUS Status;\r | |
b0d803fe | 327 | \r |
288f9b38 LG |
328 | FileHandle = NULL;\r |
329 | DepexData = NULL;\r | |
330 | Status = EFI_SUCCESS;\r | |
331 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r | |
b0d803fe | 332 | \r |
177aabe6 | 333 | if (PrivateData->FvCount >= FixedPcdGet32 (PcdPeiCoreMaxFvSupported)) {\r |
b0d803fe | 334 | ASSERT (FALSE);\r |
335 | }\r | |
336 | \r | |
337 | Fv = (EFI_PEI_FIRMWARE_VOLUME_INFO_PPI *)Ppi;\r | |
338 | \r | |
288f9b38 LG |
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 | |
b0d803fe | 345 | PrivateData->Fv[PrivateData->FvCount++].FvHeader = (EFI_FIRMWARE_VOLUME_HEADER*)Fv->FvInfo;\r |
b0d803fe | 346 | \r |
288f9b38 LG |
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 | |
91136124 | 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 |
288f9b38 LG |
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 | |
b0d803fe | 386 | \r |
387 | return EFI_SUCCESS;\r | |
388 | }\r | |
389 | \r | |
b1f6a7c6 | 390 | /**\r |
ed299e3c LG |
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 | |
b1f6a7c6 | 401 | \r |
ed299e3c LG |
402 | @return EFI_NOT_FOUND The match section is not found.\r |
403 | @return EFI_SUCCESS The match section is found.\r | |
b1f6a7c6 | 404 | \r |
405 | **/\r | |
b0d803fe | 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 | |
288f9b38 | 412 | OUT VOID **OutputBuffer\r |
b0d803fe | 413 | )\r |
b0d803fe | 414 | {\r |
415 | EFI_STATUS Status;\r | |
416 | UINT32 SectionLength;\r | |
417 | UINT32 ParsedLength;\r | |
b0d803fe | 418 | EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *GuidSectionPpi;\r |
b0d803fe | 419 | EFI_PEI_DECOMPRESS_PPI *DecompressPpi;\r |
420 | VOID *PpiOutput;\r | |
421 | UINTN PpiOutputSize;\r | |
288f9b38 LG |
422 | UINTN Index;\r |
423 | UINT32 Authentication;\r | |
424 | PEI_CORE_INSTANCE *PrivateData;\r | |
b0d803fe | 425 | \r |
288f9b38 | 426 | PrivateData = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r |
b0d803fe | 427 | *OutputBuffer = NULL;\r |
288f9b38 LG |
428 | ParsedLength = 0;\r |
429 | Index = 0;\r | |
430 | Status = EFI_NOT_FOUND;\r | |
431 | PpiOutput = NULL;\r | |
432 | PpiOutputSize = 0;\r | |
b0d803fe | 433 | while (ParsedLength < SectionSize) {\r |
434 | if (Section->Type == SectionType) {\r | |
435 | *OutputBuffer = (VOID *)(Section + 1);\r | |
436 | return EFI_SUCCESS;\r | |
288f9b38 LG |
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 | |
b0d803fe | 448 | return PeiFfsProcessSection (\r |
449 | PeiServices,\r | |
450 | SectionType, \r | |
451 | PpiOutput, \r | |
452 | PpiOutputSize, \r | |
288f9b38 | 453 | OutputBuffer \r |
b0d803fe | 454 | );\r |
455 | }\r | |
456 | }\r | |
288f9b38 LG |
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 | |
b0d803fe | 466 | if (!EFI_ERROR (Status)) {\r |
288f9b38 LG |
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 | |
b0d803fe | 484 | }\r |
485 | }\r | |
288f9b38 LG |
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 | |
b0d803fe | 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 | |
192f6d4c | 524 | \r |
b1f6a7c6 | 525 | /**\r |
ed299e3c | 526 | Given the input file pointer, search for the first matching section in the\r |
b1f6a7c6 | 527 | FFS volume.\r |
528 | \r | |
ed299e3c | 529 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r |
b1f6a7c6 | 530 | @param SectionType Filter to find only sections of this type.\r |
531 | @param FileHandle Pointer to the current file to search.\r | |
ed299e3c | 532 | @param SectionData A pointer to the discovered section, if successful.\r |
b1f6a7c6 | 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 | |
192f6d4c | 539 | EFI_STATUS\r |
540 | EFIAPI\r | |
541 | PeiFfsFindSectionData (\r | |
0c2b5da8 | 542 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 543 | IN EFI_SECTION_TYPE SectionType,\r |
0c2b5da8 | 544 | IN EFI_PEI_FILE_HANDLE FileHandle,\r |
192f6d4c | 545 | IN OUT VOID **SectionData\r |
546 | )\r | |
192f6d4c | 547 | {\r |
b0d803fe | 548 | EFI_FFS_FILE_HEADER *FfsFileHeader;\r |
549 | UINT32 FileSize;\r | |
550 | EFI_COMMON_SECTION_HEADER *Section;\r | |
b0d803fe | 551 | \r |
552 | FfsFileHeader = (EFI_FFS_FILE_HEADER *)(FileHandle);\r | |
192f6d4c | 553 | \r |
554 | //\r | |
555 | // Size is 24 bits wide so mask upper 8 bits. \r | |
b0d803fe | 556 | // Does not include FfsFileHeader header size\r |
192f6d4c | 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 | |
b0d803fe | 561 | FileSize -= sizeof (EFI_FFS_FILE_HEADER);\r |
562 | \r | |
563 | return PeiFfsProcessSection (\r | |
288f9b38 | 564 | PeiServices,\r |
b0d803fe | 565 | SectionType, \r |
566 | Section, \r | |
567 | FileSize, \r | |
288f9b38 | 568 | SectionData\r |
b0d803fe | 569 | );\r |
192f6d4c | 570 | }\r |
571 | \r | |
b1f6a7c6 | 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 | |
192f6d4c | 576 | \r |
b1f6a7c6 | 577 | \r |
d73d93c3 | 578 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r |
b1f6a7c6 | 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 | |
192f6d4c | 588 | EFI_STATUS\r |
589 | EFIAPI\r | |
590 | PeiFfsFindNextFile (\r | |
0c2b5da8 | 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 | |
192f6d4c | 595 | )\r |
192f6d4c | 596 | {\r |
b0d803fe | 597 | return PeiFindFileEx (VolumeHandle, NULL, SearchType, FileHandle, NULL);\r |
192f6d4c | 598 | }\r |
599 | \r | |
b0d803fe | 600 | \r |
b1f6a7c6 | 601 | /**\r |
ed299e3c | 602 | Search the firmware volumes by index\r |
b1f6a7c6 | 603 | \r |
ed299e3c | 604 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation\r |
b1f6a7c6 | 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 | |
192f6d4c | 612 | EFI_STATUS \r |
613 | EFIAPI\r | |
614 | PeiFvFindNextVolume (\r | |
2a00326e | 615 | IN CONST EFI_PEI_SERVICES **PeiServices,\r |
192f6d4c | 616 | IN UINTN Instance,\r |
0c2b5da8 | 617 | IN OUT EFI_PEI_FV_HANDLE *VolumeHandle\r |
192f6d4c | 618 | )\r |
192f6d4c | 619 | {\r |
2a00326e LG |
620 | PEI_CORE_INSTANCE *Private;\r |
621 | UINTN Index;\r | |
622 | BOOLEAN Match;\r | |
623 | EFI_HOB_FIRMWARE_VOLUME *FvHob;\r | |
192f6d4c | 624 | \r |
b0d803fe | 625 | Private = PEI_CORE_INSTANCE_FROM_PS_THIS (PeiServices);\r |
626 | if (VolumeHandle == NULL) {\r | |
627 | return EFI_INVALID_PARAMETER;\r | |
2a00326e LG |
628 | }\r |
629 | \r | |
630 | //\r | |
631 | // Handle Framework FvHob and Install FvInfo Ppi for it.\r | |
632 | //\r | |
633 | if (FeaturePcdGet (PcdFrameworkFvHobCompatibilitySupport)) {\r | |
634 | //\r | |
635 | // Loop to search the wanted FirmwareVolume which supports FFS\r | |
636 | //\r | |
637 | FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetFirstHob (EFI_HOB_TYPE_FV);\r | |
638 | while (FvHob != NULL) {\r | |
639 | for (Index = 0, Match = FALSE; Index < Private->AllFvCount; Index++) {\r | |
640 | if ((EFI_PEI_FV_HANDLE)(UINTN)FvHob->BaseAddress == Private->AllFv[Index]) {\r | |
641 | Match = TRUE;\r | |
642 | break;\r | |
643 | }\r | |
644 | }\r | |
645 | //\r | |
646 | // If Not Found, Install FvInfo Ppi for it.\r | |
647 | //\r | |
648 | if (!Match) {\r | |
649 | PiLibInstallFvInfoPpi (\r | |
650 | NULL,\r | |
651 | (VOID *)(UINTN)FvHob->BaseAddress,\r | |
652 | (UINT32)FvHob->Length,\r | |
653 | NULL,\r | |
654 | NULL\r | |
655 | );\r | |
656 | }\r | |
657 | FvHob = (EFI_HOB_FIRMWARE_VOLUME *)GetNextHob (EFI_HOB_TYPE_FV, (VOID *)((UINTN)FvHob + FvHob->Header.HobLength)); \r | |
658 | }\r | |
659 | }\r | |
192f6d4c | 660 | \r |
b0d803fe | 661 | if (Instance >= Private->AllFvCount) {\r |
662 | VolumeHandle = NULL;\r | |
663 | return EFI_NOT_FOUND;\r | |
664 | }\r | |
192f6d4c | 665 | \r |
b0d803fe | 666 | *VolumeHandle = Private->AllFv[Instance];\r |
667 | return EFI_SUCCESS;\r | |
668 | }\r | |
192f6d4c | 669 | \r |
192f6d4c | 670 | \r |
b1f6a7c6 | 671 | /**\r |
ed299e3c | 672 | Find a file within a volume by its name.\r |
b1f6a7c6 | 673 | \r |
ed299e3c LG |
674 | @param FileName A pointer to the name of the file to find within the firmware volume.\r |
675 | @param VolumeHandle The firmware volume to search\r | |
676 | @param FileHandle Upon exit, points to the found file's handle \r | |
677 | or NULL if it could not be found.\r | |
b1f6a7c6 | 678 | \r |
ed299e3c LG |
679 | @retval EFI_SUCCESS File was found.\r |
680 | @retval EFI_NOT_FOUND File was not found.\r | |
681 | @retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or FileName was NULL.\r | |
b1f6a7c6 | 682 | \r |
b1f6a7c6 | 683 | **/\r |
b0d803fe | 684 | EFI_STATUS\r |
685 | EFIAPI \r | |
686 | PeiFfsFindFileByName (\r | |
687 | IN CONST EFI_GUID *FileName,\r | |
688 | IN EFI_PEI_FV_HANDLE VolumeHandle,\r | |
689 | OUT EFI_PEI_FILE_HANDLE *FileHandle\r | |
690 | )\r | |
b0d803fe | 691 | {\r |
692 | EFI_STATUS Status;\r | |
693 | if ((VolumeHandle == NULL) || (FileName == NULL) || (FileHandle == NULL)) {\r | |
192f6d4c | 694 | return EFI_INVALID_PARAMETER;\r |
695 | }\r | |
b0d803fe | 696 | Status = PeiFindFileEx (VolumeHandle, FileName, 0, FileHandle, NULL);\r |
697 | if (Status == EFI_NOT_FOUND) {\r | |
698 | *FileHandle = NULL;\r | |
699 | }\r | |
700 | return Status;\r | |
701 | }\r | |
702 | \r | |
b1f6a7c6 | 703 | /**\r |
704 | \r | |
705 | Returns information about a specific file.\r | |
706 | \r | |
707 | \r | |
708 | @param FileHandle - The handle to file.\r | |
709 | @param FileInfo - Pointer to the file information.\r | |
710 | \r | |
711 | @retval EFI_INVALID_PARAMETER Invalid FileHandle or FileInfo.\r | |
712 | @retval EFI_SUCCESS Success to collect file info.\r | |
713 | \r | |
714 | **/\r | |
b0d803fe | 715 | EFI_STATUS\r |
716 | EFIAPI \r | |
717 | PeiFfsGetFileInfo (\r | |
718 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
719 | OUT EFI_FV_FILE_INFO *FileInfo\r | |
720 | )\r | |
b0d803fe | 721 | {\r |
722 | UINT8 FileState;\r | |
723 | UINT8 ErasePolarity;\r | |
724 | EFI_FFS_FILE_HEADER *FileHeader;\r | |
725 | EFI_PEI_FV_HANDLE VolumeHandle;\r | |
726 | \r | |
727 | if ((FileHandle == NULL) || (FileInfo == NULL)) {\r | |
728 | return EFI_INVALID_PARAMETER;\r | |
729 | }\r | |
730 | \r | |
173b35e4 | 731 | VolumeHandle = 0;\r |
b0d803fe | 732 | //\r |
733 | // Retrieve the FirmwareVolume which the file resides in.\r | |
734 | //\r | |
735 | if (!PeiFileHandleToVolume(FileHandle, &VolumeHandle)) {\r | |
736 | return EFI_INVALID_PARAMETER;\r | |
737 | }\r | |
738 | \r | |
797a9d67 | 739 | if (((EFI_FIRMWARE_VOLUME_HEADER*)VolumeHandle)->Attributes & EFI_FVB2_ERASE_POLARITY) {\r |
b0d803fe | 740 | ErasePolarity = 1;\r |
192f6d4c | 741 | } else {\r |
b0d803fe | 742 | ErasePolarity = 0;\r |
743 | }\r | |
744 | \r | |
745 | //\r | |
746 | // Get FileState which is the highest bit of the State \r | |
747 | //\r | |
748 | FileState = GetFileState (ErasePolarity, (EFI_FFS_FILE_HEADER*)FileHandle);\r | |
192f6d4c | 749 | \r |
b0d803fe | 750 | switch (FileState) {\r |
751 | case EFI_FILE_DATA_VALID:\r | |
752 | case EFI_FILE_MARKED_FOR_UPDATE:\r | |
753 | break; \r | |
754 | default:\r | |
755 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 756 | }\r |
b0d803fe | 757 | \r |
758 | FileHeader = (EFI_FFS_FILE_HEADER *)FileHandle;\r | |
759 | CopyMem (&FileInfo->FileName, &FileHeader->Name, sizeof(EFI_GUID));\r | |
760 | FileInfo->FileType = FileHeader->Type;\r | |
761 | FileInfo->FileAttributes = FileHeader->Attributes;\r | |
762 | FileInfo->BufferSize = ((*(UINT32 *)FileHeader->Size) & 0x00FFFFFF) - sizeof (EFI_FFS_FILE_HEADER);\r | |
763 | FileInfo->Buffer = (FileHeader + 1);\r | |
764 | return EFI_SUCCESS;\r | |
765 | }\r | |
766 | \r | |
767 | \r | |
b1f6a7c6 | 768 | /**\r |
769 | \r | |
770 | Collect information of given Fv Volume.\r | |
771 | \r | |
772 | @param VolumeHandle - The handle to Fv Volume.\r | |
773 | @param VolumeInfo - The pointer to volume information.\r | |
774 | \r | |
775 | @retval EFI_INVALID_PARAMETER VolumeInfo is NULL\r | |
776 | @retval EFI_SUCCESS Success to collect fv info.\r | |
777 | **/\r | |
b0d803fe | 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 | |
b0d803fe | 784 | {\r |
288f9b38 | 785 | EFI_FIRMWARE_VOLUME_HEADER FwVolHeader;\r |
b0d803fe | 786 | EFI_FIRMWARE_VOLUME_EXT_HEADER *FwVolExHeaderInfo;\r |
787 | \r | |
788 | if (VolumeInfo == NULL) {\r | |
789 | return EFI_INVALID_PARAMETER;\r | |
192f6d4c | 790 | }\r |
288f9b38 LG |
791 | \r |
792 | //\r | |
793 | // VolumeHandle may not align at 8 byte, \r | |
794 | // but FvLength is UINT64 type, which requires FvHeader align at least 8 byte. \r | |
795 | // So, Copy FvHeader into the local FvHeader structure.\r | |
796 | //\r | |
797 | CopyMem (&FwVolHeader, VolumeHandle, sizeof (EFI_FIRMWARE_VOLUME_HEADER));\r | |
798 | //\r | |
799 | // Check Fv Image Signature\r | |
800 | //\r | |
801 | if (FwVolHeader.Signature != EFI_FVH_SIGNATURE) {\r | |
802 | return EFI_INVALID_PARAMETER;\r | |
803 | }\r | |
804 | VolumeInfo->FvAttributes = FwVolHeader.Attributes;\r | |
805 | VolumeInfo->FvStart = (VOID *) VolumeHandle;\r | |
806 | VolumeInfo->FvSize = FwVolHeader.FvLength;\r | |
807 | CopyMem (&VolumeInfo->FvFormat, &FwVolHeader.FileSystemGuid, sizeof(EFI_GUID));\r | |
b0d803fe | 808 | \r |
288f9b38 LG |
809 | if (FwVolHeader.ExtHeaderOffset != 0) {\r |
810 | FwVolExHeaderInfo = (EFI_FIRMWARE_VOLUME_EXT_HEADER*)(((UINT8 *)VolumeHandle) + FwVolHeader.ExtHeaderOffset);\r | |
b0d803fe | 811 | CopyMem (&VolumeInfo->FvName, &FwVolExHeaderInfo->FvName, sizeof(EFI_GUID));\r |
812 | }\r | |
813 | return EFI_SUCCESS;\r | |
192f6d4c | 814 | }\r |
b0d803fe | 815 | \r |