diff options
Diffstat (limited to 'MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c')
-rw-r--r-- | MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c | 348 |
1 files changed, 176 insertions, 172 deletions
diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c index 53352881c4..e0ac6ee17c 100644 --- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c +++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c @@ -53,6 +53,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include "FaultTolerantWrite.h"
+EFI_EVENT mFvbRegistration = NULL;
//
// Fault Tolerant Write Protocol API
@@ -862,116 +863,80 @@ FtwGetLastWrite ( return Status;
}
-/**
- This function is the entry point of the Fault Tolerant Write driver.
-
- @param ImageHandle A handle for the image that is initializing this driver
- @param SystemTable A pointer to the EFI system table
-
- @return EFI_SUCCESS FTW has finished the initialization
- @retval EFI_NOT_FOUND Locate FVB protocol error
- @retval EFI_OUT_OF_RESOURCES Allocate memory error
- @retval EFI_VOLUME_CORRUPTED Firmware volume is error
- @retval EFI_ABORTED FTW initialization error
-
-**/
-EFI_STATUS
+VOID
EFIAPI
-InitializeFaultTolerantWrite (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
+FvbNotificationEvent (
+ IN EFI_EVENT Event,
+ IN VOID *Context
)
{
- EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
- UINTN Index;
+ EFI_STATUS Status;
EFI_HANDLE *HandleBuffer;
UINTN HandleCount;
+ UINTN Index;
+ EFI_PHYSICAL_ADDRESS FvbBaseAddress;
+ EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
EFI_FIRMWARE_VOLUME_HEADER *FwVolHeader;
- EFI_PHYSICAL_ADDRESS BaseAddress;
+ EFI_FVB_ATTRIBUTES_2 Attributes;
EFI_FTW_DEVICE *FtwDevice;
- EFI_FAULT_TOLERANT_WRITE_HEADER *FtwHeader;
- UINTN Length;
- EFI_STATUS Status;
- UINTN Offset;
EFI_FV_BLOCK_MAP_ENTRY *FvbMapEntry;
UINT32 LbaIndex;
+ UINTN Length;
+ EFI_FAULT_TOLERANT_WRITE_HEADER *FtwHeader;
+ UINTN Offset;
EFI_HANDLE FvbHandle;
- //
- // Allocate Private data of this driver,
- // INCLUDING THE FtwWorkSpace[FTW_WORK_SPACE_SIZE].
- //
+ FtwDevice = (EFI_FTW_DEVICE *)Context;
FvbHandle = NULL;
- FtwDevice = NULL;
- FtwDevice = AllocatePool (sizeof (EFI_FTW_DEVICE) + PcdGet32 (PcdFlashNvStorageFtwWorkingSize));
- if (FtwDevice == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
-
- ZeroMem (FtwDevice, sizeof (EFI_FTW_DEVICE));
- FtwDevice->Signature = FTW_DEVICE_SIGNATURE;
+ Fvb = NULL;
//
- // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.
- //
-
- FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
- FtwDevice->WorkSpaceLength = (UINTN) PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
-
- FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwSpareBase);
- FtwDevice->SpareAreaLength = (UINTN) PcdGet32 (PcdFlashNvStorageFtwSpareSize);
-
- if ((FtwDevice->WorkSpaceLength == 0) || (FtwDevice->SpareAreaLength == 0)) {
- DEBUG ((EFI_D_ERROR, "Ftw: Workspace or Spare block does not exist!\n"));
- FreePool (FtwDevice);
- return EFI_OUT_OF_RESOURCES;
- }
- //
- // Locate FVB protocol by handle
+ // Locate all handles of Fvb protocol
//
Status = gBS->LocateHandleBuffer (
- ByProtocol,
- &gEfiFirmwareVolumeBlockProtocolGuid,
- NULL,
- &HandleCount,
- &HandleBuffer
- );
+ ByProtocol,
+ &gEfiFirmwareVolumeBlockProtocolGuid,
+ NULL,
+ &HandleCount,
+ &HandleBuffer
+ );
if (EFI_ERROR (Status)) {
- FreePool (FtwDevice);
- return EFI_NOT_FOUND;
- }
-
- if (HandleCount <= 0) {
- FreePool (FtwDevice);
- return EFI_NOT_FOUND;
+ return;
}
- Fvb = NULL;
- FtwDevice->FtwFvBlock = NULL;
- FtwDevice->FtwBackupFvb = NULL;
- FtwDevice->FtwWorkSpaceLba = (EFI_LBA) (-1);
- FtwDevice->FtwSpareLba = (EFI_LBA) (-1);
+ //
+ // Get the FVB to access variable store
+ //
for (Index = 0; Index < HandleCount; Index += 1) {
Status = gBS->HandleProtocol (
- HandleBuffer[Index],
- &gEfiFirmwareVolumeBlockProtocolGuid,
- (VOID **) &Fvb
- );
+ HandleBuffer[Index],
+ &gEfiFirmwareVolumeBlockProtocolGuid,
+ (VOID **) &Fvb
+ );
if (EFI_ERROR (Status)) {
- FreePool (FtwDevice);
- return Status;
+ Status = EFI_NOT_FOUND;
+ break;
}
- Status = Fvb->GetPhysicalAddress (Fvb, &BaseAddress);
+ //
+ // Ensure this FVB protocol supported Write operation.
+ //
+ Status = Fvb->GetAttributes (Fvb, &Attributes);
+ if (EFI_ERROR (Status) || ((Attributes & EFI_FVB2_WRITE_STATUS) == 0)) {
+ continue;
+ }
+ //
+ // Compare the address and select the right one
+ //
+ Status = Fvb->GetPhysicalAddress (Fvb, &FvbBaseAddress);
if (EFI_ERROR (Status)) {
continue;
}
- FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) BaseAddress);
-
- if ((FtwDevice->WorkSpaceAddress >= BaseAddress) &&
- ((FtwDevice->WorkSpaceAddress + FtwDevice->WorkSpaceLength) <= (BaseAddress + FwVolHeader->FvLength))
- ) {
+ FwVolHeader = (EFI_FIRMWARE_VOLUME_HEADER *) ((UINTN) FvbBaseAddress);
+ if ((FtwDevice->FtwFvBlock == NULL) && (FtwDevice->WorkSpaceAddress >= FvbBaseAddress) &&
+ ((FtwDevice->WorkSpaceAddress + FtwDevice->WorkSpaceLength) <= (FvbBaseAddress + FwVolHeader->FvLength))
+ ) {
FtwDevice->FtwFvBlock = Fvb;
//
// To get the LBA of work space
@@ -982,23 +947,23 @@ InitializeFaultTolerantWrite ( //
FvbMapEntry = &FwVolHeader->BlockMap[0];
for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {
- if ((FtwDevice->WorkSpaceAddress >= (BaseAddress + FvbMapEntry->Length * (LbaIndex - 1)))
- && (FtwDevice->WorkSpaceAddress < (BaseAddress + FvbMapEntry->Length * LbaIndex))) {
+ if ((FtwDevice->WorkSpaceAddress >= (FvbBaseAddress + FvbMapEntry->Length * (LbaIndex - 1)))
+ && (FtwDevice->WorkSpaceAddress < (FvbBaseAddress + FvbMapEntry->Length * LbaIndex))) {
FtwDevice->FtwWorkSpaceLba = LbaIndex - 1;
//
// Get the Work space size and Base(Offset)
//
FtwDevice->FtwWorkSpaceSize = FtwDevice->WorkSpaceLength;
- FtwDevice->FtwWorkSpaceBase = (UINTN) (FtwDevice->WorkSpaceAddress - (BaseAddress + FvbMapEntry->Length * (LbaIndex - 1)));
+ FtwDevice->FtwWorkSpaceBase = (UINTN) (FtwDevice->WorkSpaceAddress - (FvbBaseAddress + FvbMapEntry->Length * (LbaIndex - 1)));
break;
}
}
}
}
-
- if ((FtwDevice->SpareAreaAddress >= BaseAddress) &&
- ((FtwDevice->SpareAreaAddress + FtwDevice->SpareAreaLength) <= (BaseAddress + FwVolHeader->FvLength))
- ) {
+
+ if ((FtwDevice->FtwBackupFvb == NULL) && (FtwDevice->SpareAreaAddress >= FvbBaseAddress) &&
+ ((FtwDevice->SpareAreaAddress + FtwDevice->SpareAreaLength) <= (FvbBaseAddress + FwVolHeader->FvLength))
+ ) {
FtwDevice->FtwBackupFvb = Fvb;
//
// To get the LBA of spare
@@ -1009,21 +974,21 @@ InitializeFaultTolerantWrite ( //
FvbMapEntry = &FwVolHeader->BlockMap[0];
for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {
- if ((FtwDevice->SpareAreaAddress >= (BaseAddress + FvbMapEntry->Length * (LbaIndex - 1)))
- && (FtwDevice->SpareAreaAddress < (BaseAddress + FvbMapEntry->Length * LbaIndex))) {
+ if ((FtwDevice->SpareAreaAddress >= (FvbBaseAddress + FvbMapEntry->Length * (LbaIndex - 1)))
+ && (FtwDevice->SpareAreaAddress < (FvbBaseAddress + FvbMapEntry->Length * LbaIndex))) {
//
// Get the NumberOfSpareBlock and BlockSize
//
- FtwDevice->FtwSpareLba = LbaIndex - 1;
- FtwDevice->BlockSize = FvbMapEntry->Length;
+ FtwDevice->FtwSpareLba = LbaIndex - 1;
+ FtwDevice->BlockSize = FvbMapEntry->Length;
FtwDevice->NumberOfSpareBlock = FtwDevice->SpareAreaLength / FtwDevice->BlockSize;
//
// Check the range of spare area to make sure that it's in FV range
//
if ((FtwDevice->FtwSpareLba + FtwDevice->NumberOfSpareBlock) > FvbMapEntry->NumBlocks) {
DEBUG ((EFI_D_ERROR, "Ftw: Spare area is out of FV range\n"));
- FreePool (FtwDevice);
- return EFI_ABORTED;
+ ASSERT (FALSE);
+ return;
}
break;
}
@@ -1032,6 +997,12 @@ InitializeFaultTolerantWrite ( }
}
+ if ((FtwDevice->FtwBackupFvb == NULL) || (FtwDevice->FtwFvBlock == NULL) ||
+ (FtwDevice->FtwWorkSpaceLba == (EFI_LBA) (-1)) || (FtwDevice->FtwSpareLba == (EFI_LBA) (-1))) {
+ return;
+ }
+
+ DEBUG ((EFI_D_INFO, "Ftw: Working and spare FVB is ready\n"));
//
// Calculate the start LBA of working block. Working block is an area which
// contains working space in its last block and has the same size as spare
@@ -1039,21 +1010,8 @@ InitializeFaultTolerantWrite ( // working space.
//
FtwDevice->FtwWorkBlockLba = FtwDevice->FtwWorkSpaceLba - FtwDevice->NumberOfSpareBlock + 1;
- if ((INT64) (FtwDevice->FtwWorkBlockLba) < 0) {
- DEBUG ((EFI_D_ERROR, "Ftw: The spare block range is too large than the working block range!\n"));
- FreePool (FtwDevice);
- return EFI_ABORTED;
- }
+ ASSERT ((INT64) (FtwDevice->FtwWorkBlockLba) >= 0);
- if ((FtwDevice->FtwFvBlock == NULL) ||
- (FtwDevice->FtwBackupFvb == NULL) ||
- (FtwDevice->FtwWorkSpaceLba == (EFI_LBA) (-1)) ||
- (FtwDevice->FtwSpareLba == (EFI_LBA) (-1))
- ) {
- DEBUG ((EFI_D_ERROR, "Ftw: Working or spare FVB not ready\n"));
- FreePool (FtwDevice);
- return EFI_ABORTED;
- }
//
// Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.
//
@@ -1067,9 +1025,7 @@ InitializeFaultTolerantWrite ( // Refresh the working space data from working block
//
Status = WorkSpaceRefresh (FtwDevice);
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ ASSERT_EFI_ERROR (Status);
//
// If the working block workspace is not valid, try the spare block
//
@@ -1079,15 +1035,14 @@ InitializeFaultTolerantWrite ( //
Length = FtwDevice->FtwWorkSpaceSize;
Status = FtwDevice->FtwBackupFvb->Read (
- FtwDevice->FtwBackupFvb,
- FtwDevice->FtwSpareLba,
- FtwDevice->FtwWorkSpaceBase,
- &Length,
- FtwDevice->FtwWorkSpace
- );
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ FtwDevice->FtwBackupFvb,
+ FtwDevice->FtwSpareLba,
+ FtwDevice->FtwWorkSpaceBase,
+ &Length,
+ FtwDevice->FtwWorkSpace
+ );
+ ASSERT_EFI_ERROR (Status);
+
//
// If spare block is valid, then replace working block content.
//
@@ -1099,9 +1054,7 @@ InitializeFaultTolerantWrite ( // Refresh work space.
//
Status = WorkSpaceRefresh (FtwDevice);
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ ASSERT_EFI_ERROR (Status);
} else {
DEBUG ((EFI_D_ERROR, "Ftw: Both are invalid, init workspace\n"));
//
@@ -1117,20 +1070,17 @@ InitializeFaultTolerantWrite ( // Initialize the work space
//
Status = FtwReclaimWorkSpace (FtwDevice, FALSE);
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ ASSERT_EFI_ERROR (Status);
}
}
-
//
// If the FtwDevice->FtwLastWriteRecord is 1st record of write header &&
- // (! SpareComplete) THEN call Abort().
+ // (! SpareComplete) THEN call Abort().
//
if ((FtwDevice->FtwLastWriteHeader->HeaderAllocated == FTW_VALID_STATE) &&
- (FtwDevice->FtwLastWriteRecord->SpareComplete != FTW_VALID_STATE) &&
- IsFirstRecordOfWrites (FtwDevice->FtwLastWriteHeader, FtwDevice->FtwLastWriteRecord)
- ) {
+ (FtwDevice->FtwLastWriteRecord->SpareComplete != FTW_VALID_STATE) &&
+ IsFirstRecordOfWrites (FtwDevice->FtwLastWriteHeader, FtwDevice->FtwLastWriteRecord)
+ ) {
DEBUG ((EFI_D_ERROR, "Ftw: Init.. find first record not SpareCompleted, abort()\n"));
FtwAbort (&FtwDevice->FtwInstance);
}
@@ -1139,9 +1089,9 @@ InitializeFaultTolerantWrite ( // call Abort() to set the Header->Complete FLAG.
//
if ((FtwDevice->FtwLastWriteHeader->Complete != FTW_VALID_STATE) &&
- (FtwDevice->FtwLastWriteRecord->DestinationComplete == FTW_VALID_STATE) &&
- IsLastRecordOfWrites (FtwDevice->FtwLastWriteHeader, FtwDevice->FtwLastWriteRecord)
- ) {
+ (FtwDevice->FtwLastWriteRecord->DestinationComplete == FTW_VALID_STATE) &&
+ IsLastRecordOfWrites (FtwDevice->FtwLastWriteHeader, FtwDevice->FtwLastWriteRecord)
+ ) {
DEBUG ((EFI_D_ERROR, "Ftw: Init.. find last record completed but header not, abort()\n"));
FtwAbort (&FtwDevice->FtwInstance);
}
@@ -1154,29 +1104,22 @@ InitializeFaultTolerantWrite ( if (FtwDevice->FtwWorkSpace[Offset] != FTW_ERASED_BYTE) {
Offset += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);
}
-
- if (!IsErasedFlashBuffer (
- FtwDevice->FtwWorkSpace + Offset,
- FtwDevice->FtwWorkSpaceSize - Offset
- )) {
+
+ if (!IsErasedFlashBuffer (FtwDevice->FtwWorkSpace + Offset, FtwDevice->FtwWorkSpaceSize - Offset)) {
Status = FtwReclaimWorkSpace (FtwDevice, TRUE);
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ ASSERT_EFI_ERROR (Status);
}
+
//
// Restart if it's boot block
//
if ((FtwDevice->FtwLastWriteHeader->Complete != FTW_VALID_STATE) &&
- (FtwDevice->FtwLastWriteRecord->SpareComplete == FTW_VALID_STATE)
- ) {
+ (FtwDevice->FtwLastWriteRecord->SpareComplete == FTW_VALID_STATE)
+ ) {
if (FtwDevice->FtwLastWriteRecord->BootBlockUpdate == FTW_VALID_STATE) {
Status = FlushSpareBlockToBootBlock (FtwDevice);
DEBUG ((EFI_D_ERROR, "Ftw: Restart boot block update - %r\n", Status));
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
-
+ ASSERT_EFI_ERROR (Status);
FtwAbort (&FtwDevice->FtwInstance);
} else {
//
@@ -1186,46 +1129,107 @@ InitializeFaultTolerantWrite ( if (FvbHandle != NULL) {
Status = FtwRestart (&FtwDevice->FtwInstance, FvbHandle);
DEBUG ((EFI_D_ERROR, "FtwLite: Restart last write - %r\n", Status));
- if (EFI_ERROR (Status)) {
- goto Recovery;
- }
+ ASSERT_EFI_ERROR (Status);
}
FtwAbort (&FtwDevice->FtwInstance);
}
}
-
//
// Hook the protocol API
//
- FtwDevice->FtwInstance.GetMaxBlockSize = FtwGetMaxBlockSize;
- FtwDevice->FtwInstance.Allocate = FtwAllocate;
- FtwDevice->FtwInstance.Write = FtwWrite;
- FtwDevice->FtwInstance.Restart = FtwRestart;
- FtwDevice->FtwInstance.Abort = FtwAbort;
- FtwDevice->FtwInstance.GetLastWrite = FtwGetLastWrite;
-
+ FtwDevice->FtwInstance.GetMaxBlockSize = FtwGetMaxBlockSize;
+ FtwDevice->FtwInstance.Allocate = FtwAllocate;
+ FtwDevice->FtwInstance.Write = FtwWrite;
+ FtwDevice->FtwInstance.Restart = FtwRestart;
+ FtwDevice->FtwInstance.Abort = FtwAbort;
+ FtwDevice->FtwInstance.GetLastWrite = FtwGetLastWrite;
+
//
// Install protocol interface
//
Status = gBS->InstallProtocolInterface (
- &FtwDevice->Handle,
- &gEfiFaultTolerantWriteProtocolGuid,
- EFI_NATIVE_INTERFACE,
- &FtwDevice->FtwInstance
- );
- if (EFI_ERROR (Status)) {
- goto Recovery;
+ &FtwDevice->Handle,
+ &gEfiFaultTolerantWriteProtocolGuid,
+ EFI_NATIVE_INTERFACE,
+ &FtwDevice->FtwInstance
+ );
+
+ ASSERT_EFI_ERROR (Status);
+
+ //
+ // Close the notify event to avoid install FaultTolerantWriteProtocol again.
+ //
+ Status = gBS->CloseEvent (Event);
+ ASSERT_EFI_ERROR (Status);
+
+ return;
+}
+
+/**
+ This function is the entry point of the Fault Tolerant Write driver.
+
+ @param ImageHandle A handle for the image that is initializing this driver
+ @param SystemTable A pointer to the EFI system table
+
+ @return EFI_SUCCESS FTW has finished the initialization
+ @retval EFI_NOT_FOUND Locate FVB protocol error
+ @retval EFI_OUT_OF_RESOURCES Allocate memory error
+ @retval EFI_VOLUME_CORRUPTED Firmware volume is error
+ @retval EFI_ABORTED FTW initialization error
+
+**/
+EFI_STATUS
+EFIAPI
+InitializeFaultTolerantWrite (
+ IN EFI_HANDLE ImageHandle,
+ IN EFI_SYSTEM_TABLE *SystemTable
+ )
+{
+ EFI_FTW_DEVICE *FtwDevice;
+
+ //
+ // Allocate Private data of this driver,
+ // INCLUDING THE FtwWorkSpace[FTW_WORK_SPACE_SIZE].
+ //
+ FtwDevice = NULL;
+ FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + PcdGet32 (PcdFlashNvStorageFtwWorkingSize));
+ if (FtwDevice == NULL) {
+ return EFI_OUT_OF_RESOURCES;
}
- return EFI_SUCCESS;
+ ZeroMem (FtwDevice, sizeof (EFI_FTW_DEVICE));
+ FtwDevice->Signature = FTW_DEVICE_SIGNATURE;
-Recovery:
+ //
+ // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.
+ //
+
+ FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwWorkingBase);
+ FtwDevice->WorkSpaceLength = (UINTN) PcdGet32 (PcdFlashNvStorageFtwWorkingSize);
+
+ FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwSpareBase);
+ FtwDevice->SpareAreaLength = (UINTN) PcdGet32 (PcdFlashNvStorageFtwSpareSize);
- if (FtwDevice != NULL) {
+ if ((FtwDevice->WorkSpaceLength == 0) || (FtwDevice->SpareAreaLength == 0)) {
+ DEBUG ((EFI_D_ERROR, "Ftw: Workspace or Spare block does not exist!\n"));
FreePool (FtwDevice);
+ return EFI_OUT_OF_RESOURCES;
}
+ FtwDevice->FtwFvBlock = NULL;
+ FtwDevice->FtwBackupFvb = NULL;
+ FtwDevice->FtwWorkSpaceLba = (EFI_LBA) (-1);
+ FtwDevice->FtwSpareLba = (EFI_LBA) (-1);
- DEBUG ((EFI_D_ERROR, "Ftw: Severe Error occurs, need to recovery\n"));
+ //
+ // Register FvbNotificationEvent () notify function.
+ //
+ EfiCreateProtocolNotifyEvent (
+ &gEfiFirmwareVolumeBlockProtocolGuid,
+ TPL_CALLBACK,
+ FvbNotificationEvent,
+ (VOID *)FtwDevice,
+ &mFvbRegistration
+ );
- return EFI_VOLUME_CORRUPTED;
+ return EFI_SUCCESS;
}
|