2 Firmware File System driver that produce Firmware Volume protocol.
3 Layers on top of Firmware Block protocol to produce a file abstraction
6 Copyright (c) 2006 - 2019, Intel Corporation. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include "FwVolDriver.h"
22 // Protocol notify related globals
24 VOID
*gEfiFwVolBlockNotifyReg
;
25 EFI_EVENT gEfiFwVolBlockEvent
;
27 FV_DEVICE mFvDevice
= {
32 FvGetVolumeAttributes
,
33 FvSetVolumeAttributes
,
56 // FFS helper functions
59 Read data from Firmware Block by FVB protocol Read.
60 The data may cross the multi block ranges.
62 @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to read data.
63 @param StartLba Pointer to StartLba.
64 On input, the start logical block index from which to read.
65 On output,the end logical block index after reading.
66 @param Offset Pointer to Offset
67 On input, offset into the block at which to begin reading.
68 On output, offset into the end block after reading.
69 @param DataSize Size of data to be read.
70 @param Data Pointer to Buffer that the data will be read into.
72 @retval EFI_SUCCESS Successfully read data from firmware block.
77 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
,
78 IN OUT EFI_LBA
*StartLba
,
91 // Try read data in current block
94 ReadDataSize
= DataSize
;
95 Status
= Fvb
->Read (Fvb
, *StartLba
, *Offset
, &ReadDataSize
, Data
);
96 if (Status
== EFI_SUCCESS
) {
99 } else if (Status
!= EFI_BAD_BUFFER_SIZE
) {
101 // other error will direct return
107 // Data crosses the blocks, read data from next block
109 DataSize
-= ReadDataSize
;
110 Data
+= ReadDataSize
;
111 *StartLba
= *StartLba
+ 1;
112 while (DataSize
> 0) {
113 Status
= Fvb
->GetBlockSize (Fvb
, *StartLba
, &BlockSize
, &NumberOfBlocks
);
114 if (EFI_ERROR (Status
)) {
119 // Read data from the crossing blocks
122 while (BlockIndex
< NumberOfBlocks
&& DataSize
>= BlockSize
) {
123 Status
= Fvb
->Read (Fvb
, *StartLba
+ BlockIndex
, 0, &BlockSize
, Data
);
124 if (EFI_ERROR (Status
)) {
128 DataSize
-= BlockSize
;
133 // Data doesn't exceed the current block range.
135 if (DataSize
< BlockSize
) {
140 // Data must be got from the next block range.
142 *StartLba
+= NumberOfBlocks
;
146 // read the remaining data
149 Status
= Fvb
->Read (Fvb
, *StartLba
+ BlockIndex
, 0, &DataSize
, Data
);
150 if (EFI_ERROR (Status
)) {
156 // Update Lba and Offset used by the following read.
158 *StartLba
+= BlockIndex
;
165 Given the supplied FW_VOL_BLOCK_PROTOCOL, allocate a buffer for output and
166 copy the real length volume header into it.
168 @param Fvb The FW_VOL_BLOCK_PROTOCOL instance from which to
169 read the volume header
170 @param FwVolHeader Pointer to pointer to allocated buffer in which
171 the volume header is returned.
173 @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.
174 @retval EFI_SUCCESS Successfully read volume header to the allocated
176 @retval EFI_INVALID_PARAMETER The FV Header signature is not as expected or
177 the file system could not be understood.
182 IN EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
,
183 OUT EFI_FIRMWARE_VOLUME_HEADER
**FwVolHeader
187 EFI_FIRMWARE_VOLUME_HEADER TempFvh
;
194 // Read the standard FV header
198 FvhLength
= sizeof (EFI_FIRMWARE_VOLUME_HEADER
);
199 Status
= ReadFvbData (Fvb
, &StartLba
, &Offset
, FvhLength
, (UINT8
*)&TempFvh
);
200 if (EFI_ERROR (Status
)) {
205 // Validate FV Header signature, if not as expected, continue.
207 if (TempFvh
.Signature
!= EFI_FVH_SIGNATURE
) {
208 return EFI_INVALID_PARAMETER
;
212 // Check to see that the file system is indeed formatted in a way we can
215 if ((!CompareGuid (&TempFvh
.FileSystemGuid
, &gEfiFirmwareFileSystem2Guid
)) &&
216 (!CompareGuid (&TempFvh
.FileSystemGuid
, &gEfiFirmwareFileSystem3Guid
))) {
217 return EFI_INVALID_PARAMETER
;
221 // Allocate a buffer for the caller
223 *FwVolHeader
= AllocatePool (TempFvh
.HeaderLength
);
224 if (*FwVolHeader
== NULL
) {
225 return EFI_OUT_OF_RESOURCES
;
229 // Copy the standard header into the buffer
231 CopyMem (*FwVolHeader
, &TempFvh
, sizeof (EFI_FIRMWARE_VOLUME_HEADER
));
234 // Read the rest of the header
236 FvhLength
= TempFvh
.HeaderLength
- sizeof (EFI_FIRMWARE_VOLUME_HEADER
);
237 Buffer
= (UINT8
*)*FwVolHeader
+ sizeof (EFI_FIRMWARE_VOLUME_HEADER
);
238 Status
= ReadFvbData (Fvb
, &StartLba
, &Offset
, FvhLength
, Buffer
);
239 if (EFI_ERROR (Status
)) {
241 // Read failed so free buffer
243 CoreFreePool (*FwVolHeader
);
252 Free FvDevice resource when error happens
254 @param FvDevice pointer to the FvDevice to be freed.
258 FreeFvDeviceResource (
259 IN FV_DEVICE
*FvDevice
262 FFS_FILE_LIST_ENTRY
*FfsFileEntry
;
263 LIST_ENTRY
*NextEntry
;
266 // Free File List Entry
268 FfsFileEntry
= (FFS_FILE_LIST_ENTRY
*)FvDevice
->FfsFileListHeader
.ForwardLink
;
269 while (&FfsFileEntry
->Link
!= &FvDevice
->FfsFileListHeader
) {
270 NextEntry
= (&FfsFileEntry
->Link
)->ForwardLink
;
272 if (FfsFileEntry
->StreamHandle
!= 0) {
274 // Close stream and free resources from SEP
276 CloseSectionStream (FfsFileEntry
->StreamHandle
, FALSE
);
279 if (FfsFileEntry
->FileCached
) {
281 // Free the cached file buffer.
283 CoreFreePool (FfsFileEntry
->FfsHeader
);
286 CoreFreePool (FfsFileEntry
);
288 FfsFileEntry
= (FFS_FILE_LIST_ENTRY
*) NextEntry
;
291 if (!FvDevice
->IsMemoryMapped
) {
293 // Free the cached FV buffer.
295 CoreFreePool (FvDevice
->CachedFv
);
299 // Free Volume Header
301 CoreFreePool (FvDevice
->FwVolHeader
);
309 Check if an FV is consistent and allocate cache for it.
311 @param FvDevice A pointer to the FvDevice to be checked.
313 @retval EFI_OUT_OF_RESOURCES No enough buffer could be allocated.
314 @retval EFI_SUCCESS FV is consistent and cache is allocated.
315 @retval EFI_VOLUME_CORRUPTED File system is corrupted.
320 IN OUT FV_DEVICE
*FvDevice
324 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
;
325 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
326 EFI_FIRMWARE_VOLUME_EXT_HEADER
*FwVolExtHeader
;
327 EFI_FVB_ATTRIBUTES_2 FvbAttributes
;
328 EFI_FV_BLOCK_MAP_ENTRY
*BlockMap
;
329 FFS_FILE_LIST_ENTRY
*FfsFileEntry
;
330 EFI_FFS_FILE_HEADER
*FfsHeader
;
331 UINT8
*CacheLocation
;
335 EFI_FFS_FILE_STATE FileState
;
338 EFI_PHYSICAL_ADDRESS PhysicalAddress
;
341 EFI_FFS_FILE_HEADER
*CacheFfsHeader
;
344 CacheFfsHeader
= NULL
;
347 FwVolHeader
= FvDevice
->FwVolHeader
;
349 Status
= Fvb
->GetAttributes (Fvb
, &FvbAttributes
);
350 if (EFI_ERROR (Status
)) {
354 Size
= (UINTN
) FwVolHeader
->FvLength
;
355 if ((FvbAttributes
& EFI_FVB2_MEMORY_MAPPED
) != 0) {
356 FvDevice
->IsMemoryMapped
= TRUE
;
358 Status
= Fvb
->GetPhysicalAddress (Fvb
, &PhysicalAddress
);
359 if (EFI_ERROR (Status
)) {
364 // Don't cache memory mapped FV really.
366 FvDevice
->CachedFv
= (UINT8
*) (UINTN
) PhysicalAddress
;
368 FvDevice
->IsMemoryMapped
= FALSE
;
369 FvDevice
->CachedFv
= AllocatePool (Size
);
371 if (FvDevice
->CachedFv
== NULL
) {
372 return EFI_OUT_OF_RESOURCES
;
377 // Remember a pointer to the end of the CachedFv
379 FvDevice
->EndOfCachedFv
= FvDevice
->CachedFv
+ Size
;
381 if (!FvDevice
->IsMemoryMapped
) {
383 // Copy FV into memory using the block map.
385 BlockMap
= FwVolHeader
->BlockMap
;
386 CacheLocation
= FvDevice
->CachedFv
;
388 while ((BlockMap
->NumBlocks
!= 0) || (BlockMap
->Length
!= 0)) {
392 Size
= BlockMap
->Length
;
393 for (Index
= 0; Index
< BlockMap
->NumBlocks
; Index
++) {
403 // Not check EFI_BAD_BUFFER_SIZE, for Size = BlockMap->Length
405 if (EFI_ERROR (Status
)) {
410 CacheLocation
+= BlockMap
->Length
;
418 // Scan to check the free space & File list
420 if ((FvbAttributes
& EFI_FVB2_ERASE_POLARITY
) != 0) {
421 FvDevice
->ErasePolarity
= 1;
423 FvDevice
->ErasePolarity
= 0;
428 // go through the whole FV cache, check the consistence of the FV.
429 // Make a linked list of all the Ffs file headers
431 Status
= EFI_SUCCESS
;
432 InitializeListHead (&FvDevice
->FfsFileListHeader
);
437 if (FwVolHeader
->ExtHeaderOffset
!= 0) {
439 // Searching for files starts on an 8 byte aligned boundary after the end of the Extended Header if it exists.
441 FwVolExtHeader
= (EFI_FIRMWARE_VOLUME_EXT_HEADER
*) (FvDevice
->CachedFv
+ FwVolHeader
->ExtHeaderOffset
);
442 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FwVolExtHeader
+ FwVolExtHeader
->ExtHeaderSize
);
444 FfsHeader
= (EFI_FFS_FILE_HEADER
*) (FvDevice
->CachedFv
+ FwVolHeader
->HeaderLength
);
446 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ALIGN_POINTER (FfsHeader
, 8);
447 TopFvAddress
= FvDevice
->EndOfCachedFv
;
448 while (((UINTN
) FfsHeader
>= (UINTN
) FvDevice
->CachedFv
) && ((UINTN
) FfsHeader
<= (UINTN
) ((UINTN
) TopFvAddress
- sizeof (EFI_FFS_FILE_HEADER
)))) {
451 CoreFreePool (CacheFfsHeader
);
455 TestLength
= TopFvAddress
- ((UINT8
*) FfsHeader
);
456 if (TestLength
> sizeof (EFI_FFS_FILE_HEADER
)) {
457 TestLength
= sizeof (EFI_FFS_FILE_HEADER
);
460 if (IsBufferErased (FvDevice
->ErasePolarity
, FfsHeader
, TestLength
)) {
462 // We have found the free space so we are done!
467 if (!IsValidFfsHeader (FvDevice
->ErasePolarity
, FfsHeader
, &FileState
)) {
468 if ((FileState
== EFI_FILE_HEADER_INVALID
) ||
469 (FileState
== EFI_FILE_HEADER_CONSTRUCTION
)) {
470 if (IS_FFS_FILE2 (FfsHeader
)) {
471 if (!FvDevice
->IsFfs3Fv
) {
472 DEBUG ((EFI_D_ERROR
, "Found a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &FfsHeader
->Name
));
474 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FfsHeader
+ sizeof (EFI_FFS_FILE_HEADER2
));
476 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FfsHeader
+ sizeof (EFI_FFS_FILE_HEADER
));
481 // File system is corrputed
483 Status
= EFI_VOLUME_CORRUPTED
;
488 CacheFfsHeader
= FfsHeader
;
489 if ((CacheFfsHeader
->Attributes
& FFS_ATTRIB_CHECKSUM
) == FFS_ATTRIB_CHECKSUM
) {
490 if (FvDevice
->IsMemoryMapped
) {
492 // Memory mapped FV has not been cached.
493 // Here is to cache FFS file to memory buffer for following checksum calculating.
494 // And then, the cached file buffer can be also used for FvReadFile.
496 WholeFileSize
= IS_FFS_FILE2 (CacheFfsHeader
) ? FFS_FILE2_SIZE (CacheFfsHeader
): FFS_FILE_SIZE (CacheFfsHeader
);
497 CacheFfsHeader
= AllocateCopyPool (WholeFileSize
, CacheFfsHeader
);
498 if (CacheFfsHeader
== NULL
) {
499 Status
= EFI_OUT_OF_RESOURCES
;
506 if (!IsValidFfsFile (FvDevice
->ErasePolarity
, CacheFfsHeader
)) {
508 // File system is corrupted
510 Status
= EFI_VOLUME_CORRUPTED
;
514 if (IS_FFS_FILE2 (CacheFfsHeader
)) {
515 ASSERT (FFS_FILE2_SIZE (CacheFfsHeader
) > 0x00FFFFFF);
516 if (!FvDevice
->IsFfs3Fv
) {
517 DEBUG ((EFI_D_ERROR
, "Found a FFS3 formatted file: %g in a non-FFS3 formatted FV.\n", &CacheFfsHeader
->Name
));
518 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FfsHeader
+ FFS_FILE2_SIZE (CacheFfsHeader
));
520 // Adjust pointer to the next 8-byte aligned boundary.
522 FfsHeader
= (EFI_FFS_FILE_HEADER
*) (((UINTN
) FfsHeader
+ 7) & ~0x07);
527 FileState
= GetFileState (FvDevice
->ErasePolarity
, CacheFfsHeader
);
530 // check for non-deleted file
532 if (FileState
!= EFI_FILE_DELETED
) {
534 // Create a FFS list entry for each non-deleted file
536 FfsFileEntry
= AllocateZeroPool (sizeof (FFS_FILE_LIST_ENTRY
));
537 if (FfsFileEntry
== NULL
) {
538 Status
= EFI_OUT_OF_RESOURCES
;
542 FfsFileEntry
->FfsHeader
= CacheFfsHeader
;
543 FfsFileEntry
->FileCached
= FileCached
;
545 InsertTailList (&FvDevice
->FfsFileListHeader
, &FfsFileEntry
->Link
);
548 if (IS_FFS_FILE2 (CacheFfsHeader
)) {
549 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FfsHeader
+ FFS_FILE2_SIZE (CacheFfsHeader
));
551 FfsHeader
= (EFI_FFS_FILE_HEADER
*) ((UINT8
*) FfsHeader
+ FFS_FILE_SIZE (CacheFfsHeader
));
555 // Adjust pointer to the next 8-byte aligned boundary.
557 FfsHeader
= (EFI_FFS_FILE_HEADER
*)(((UINTN
)FfsHeader
+ 7) & ~0x07);
562 if (EFI_ERROR (Status
)) {
564 CoreFreePool (CacheFfsHeader
);
567 FreeFvDeviceResource (FvDevice
);
576 This notification function is invoked when an instance of the
577 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL is produced. It layers an instance of the
578 EFI_FIRMWARE_VOLUME2_PROTOCOL on the same handle. This is the function where
579 the actual initialization of the EFI_FIRMWARE_VOLUME2_PROTOCOL is done.
581 @param Event The event that occured
582 @param Context For EFI compatiblity. Not used.
595 EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL
*Fvb
;
596 EFI_FIRMWARE_VOLUME2_PROTOCOL
*Fv
;
598 EFI_FIRMWARE_VOLUME_HEADER
*FwVolHeader
;
600 // Examine all new handles
604 // Get the next handle
606 BufferSize
= sizeof (Handle
);
607 Status
= CoreLocateHandle (
610 gEfiFwVolBlockNotifyReg
,
616 // If not found, we're done
618 if (EFI_NOT_FOUND
== Status
) {
622 if (EFI_ERROR (Status
)) {
627 // Get the FirmwareVolumeBlock protocol on that handle
629 Status
= CoreHandleProtocol (Handle
, &gEfiFirmwareVolumeBlockProtocolGuid
, (VOID
**)&Fvb
);
630 ASSERT_EFI_ERROR (Status
);
631 ASSERT (Fvb
!= NULL
);
634 // Make sure the Fv Header is O.K.
636 Status
= GetFwVolHeader (Fvb
, &FwVolHeader
);
637 if (EFI_ERROR (Status
)) {
640 ASSERT (FwVolHeader
!= NULL
);
642 if (!VerifyFvHeaderChecksum (FwVolHeader
)) {
643 CoreFreePool (FwVolHeader
);
648 // Check if there is an FV protocol already installed in that handle
650 Status
= CoreHandleProtocol (Handle
, &gEfiFirmwareVolume2ProtocolGuid
, (VOID
**)&Fv
);
651 if (!EFI_ERROR (Status
)) {
653 // Update Fv to use a new Fvb
655 FvDevice
= BASE_CR (Fv
, FV_DEVICE
, Fv
);
656 if (FvDevice
->Signature
== FV2_DEVICE_SIGNATURE
) {
658 // Only write into our device structure if it's our device structure
665 // No FwVol protocol on the handle so create a new one
667 FvDevice
= AllocateCopyPool (sizeof (FV_DEVICE
), &mFvDevice
);
668 if (FvDevice
== NULL
) {
673 FvDevice
->Handle
= Handle
;
674 FvDevice
->FwVolHeader
= FwVolHeader
;
675 FvDevice
->IsFfs3Fv
= CompareGuid (&FwVolHeader
->FileSystemGuid
, &gEfiFirmwareFileSystem3Guid
);
676 FvDevice
->Fv
.ParentHandle
= Fvb
->ParentHandle
;
678 // Inherit the authentication status from FVB.
680 FvDevice
->AuthenticationStatus
= GetFvbAuthenticationStatus (Fvb
);
682 if (!EFI_ERROR (FvCheck (FvDevice
))) {
684 // Install an New FV protocol on the existing handle
686 Status
= CoreInstallProtocolInterface (
688 &gEfiFirmwareVolume2ProtocolGuid
,
689 EFI_NATIVE_INTERFACE
,
692 ASSERT_EFI_ERROR (Status
);
695 // Free FvDevice Buffer for the corrupt FV image.
697 CoreFreePool (FvDevice
);
708 This routine is the driver initialization entry point. It registers
709 a notification function. This notification function are responsible
710 for building the FV stack dynamically.
712 @param ImageHandle The image handle.
713 @param SystemTable The system table.
715 @retval EFI_SUCCESS Function successfully returned.
721 IN EFI_HANDLE ImageHandle
,
722 IN EFI_SYSTEM_TABLE
*SystemTable
725 gEfiFwVolBlockEvent
= EfiCreateProtocolNotifyEvent (
726 &gEfiFirmwareVolumeBlockProtocolGuid
,
730 &gEfiFwVolBlockNotifyReg