Add SMM Variable implementation.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11151 6f19259b-4bc3-4df7-8a09-765794883524

7 files changed, 1050 insertions, 474 deletions

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c
index cf72609777..625737eac0 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.c
@@ -1,44 +1,7 @@
 /** @file

 

-  This is a simple fault tolerant write driver.

-

-  This boot service protocol only provides fault tolerant write capability for 

-  block devices.  The protocol has internal non-volatile intermediate storage 

-  of the data and private information. It should be able to recover 

-  automatically from a critical fault, such as power failure. 

-

-  The implementation uses an FTW (Fault Tolerant Write) Work Space. 

-  This work space is a memory copy of the work space on the Working Block,

-  the size of the work space is the FTW_WORK_SPACE_SIZE bytes.

-  

-  The work space stores each write record as EFI_FTW_RECORD structure.

-  The spare block stores the write buffer before write to the target block.

-  

-  The write record has three states to specify the different phase of write operation.

-  1) WRITE_ALLOCATED is that the record is allocated in write space.

-     The information of write operation is stored in write record structure.

-  2) SPARE_COMPLETED is that the data from write buffer is writed into the spare block as the backup.

-  3) WRITE_COMPLETED is that the data is copied from the spare block to the target block.

-

-  This driver operates the data as the whole size of spare block.

-  It first read the SpareAreaLength data from the target block into the spare memory buffer.

-  Then copy the write buffer data into the spare memory buffer.

-  Then write the spare memory buffer into the spare block.

-  Final copy the data from the spare block to the target block.

-

-  To make this drive work well, the following conditions must be satisfied:

-  1. The write NumBytes data must be fit within Spare area. 

-     Offset + NumBytes <= SpareAreaLength

-  2. The whole flash range has the same block size.

-  3. Working block is an area which contains working space in its last block and has the same size as spare block.

-  4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on.  

-  5. Spare area must be in the single one Firmware Volume Block range which FVB protocol is produced on.

-  6. Any write data area (SpareAreaLength Area) which the data will be written into must be 

-     in the single one Firmware Volume Block range which FVB protocol is produced on.

-  7. If write data area (such as Variable range) is enlarged, the spare area range must be enlarged.

-     The spare area must be enough large to store the write data before write them into the target range.

-  If one of them is not satisfied, FtwWrite may fail.

-  Usually, Spare area only takes one block. That's SpareAreaLength = BlockSize, NumberOfSpareBlock = 1.

+  These are the common Fault Tolerant Write (FTW) functions that are shared 

+  by DXE FTW driver and SMM FTW driver.

 

 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials                          

@@ -53,8 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 #include "FaultTolerantWrite.h"

 

-EFI_EVENT          mFvbRegistration = NULL;

-

 //

 // Fault Tolerant Write Protocol API

 //

@@ -237,7 +198,7 @@ FtwWriteRecord (
 

   //

   // Spare Complete but Destination not complete,

-  // Recover the targt block with the spare block.

+  // Recover the target block with the spare block.

   //

   Header  = FtwDevice->FtwLastWriteHeader;

   Record  = FtwDevice->FtwLastWriteRecord;

@@ -864,390 +825,3 @@ FtwGetLastWrite (
   return Status;

 }

 

-/**

-  Firmware Volume Block Protocol notification event handler.

-

-  Initialization for Fault Tolerant Write is done in this handler.

-

-  @param[in] Event    Event whose notification function is being invoked.

-  @param[in] Context  Pointer to the notification function's context.

-**/

-VOID

-EFIAPI

-FvbNotificationEvent (

-  IN  EFI_EVENT       Event,

-  IN  VOID            *Context

-  )

-{

-  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_FVB_ATTRIBUTES_2                Attributes;

-  EFI_FTW_DEVICE                      *FtwDevice;

-  EFI_FV_BLOCK_MAP_ENTRY              *FvbMapEntry;

-  UINT32                              LbaIndex;

-  UINTN                               Length;

-  EFI_FAULT_TOLERANT_WRITE_HEADER     *FtwHeader;

-  UINTN                               Offset;

-  EFI_HANDLE                          FvbHandle;

-

-  FtwDevice = (EFI_FTW_DEVICE *)Context;

-  FvbHandle = NULL;

-  Fvb       = NULL;

-

-  FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);

-  if (FtwDevice->WorkSpaceAddress == 0) {

-    FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwWorkingBase);

-  }

-  

-  FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageFtwSpareBase64);

-  if (FtwDevice->SpareAreaAddress == 0) {

-    FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwSpareBase);

-  }

-  

-  

-  //

-  // Locate all handles of Fvb protocol

-  //

-  Status = gBS->LocateHandleBuffer (

-                ByProtocol,

-                &gEfiFirmwareVolumeBlockProtocolGuid,

-                NULL,

-                &HandleCount,

-                &HandleBuffer

-                );

-  if (EFI_ERROR (Status)) {

-    return;

-  }

-

-  //

-  // Get the FVB to access variable store

-  //

-  for (Index = 0; Index < HandleCount; Index += 1) {

-    Status = gBS->HandleProtocol (

-                  HandleBuffer[Index],

-                  &gEfiFirmwareVolumeBlockProtocolGuid,

-                  (VOID **) &Fvb

-                  );

-    if (EFI_ERROR (Status)) {

-      Status = EFI_NOT_FOUND;

-      break;

-    }

-

-    //

-    // 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) 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

-      //

-      if ((FwVolHeader->FvLength) > (FwVolHeader->HeaderLength)) {

-        //

-        // Now, one FV has one type of BlockLength

-        //

-        FvbMapEntry = &FwVolHeader->BlockMap[0];

-        for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {

-          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 - (FvbBaseAddress + FvbMapEntry->Length * (LbaIndex - 1)));

-            break;

-          }

-        }

-      }

-    }

-    

-    if ((FtwDevice->FtwBackupFvb == NULL) && (FtwDevice->SpareAreaAddress >= FvbBaseAddress) &&

-      ((FtwDevice->SpareAreaAddress + FtwDevice->SpareAreaLength) <= (FvbBaseAddress + FwVolHeader->FvLength))

-      ) {

-      FtwDevice->FtwBackupFvb = Fvb;

-      //

-      // To get the LBA of spare

-      //

-      if ((FwVolHeader->FvLength) > (FwVolHeader->HeaderLength)) {

-        //

-        // Now, one FV has one type of BlockLength

-        //

-        FvbMapEntry = &FwVolHeader->BlockMap[0];

-        for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {

-          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->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"));

-              ASSERT (FALSE);

-              return;

-            }

-            break;

-          }

-        }

-      }

-    }

-  }

-

-  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

-  // block, unless there are not enough blocks before the block that contains

-  // working space.

-  //

-  FtwDevice->FtwWorkBlockLba = FtwDevice->FtwWorkSpaceLba - FtwDevice->NumberOfSpareBlock + 1;

-  ASSERT ((INT64) (FtwDevice->FtwWorkBlockLba) >= 0); 

-

-  //

-  // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.

-  //

-  FtwDevice->FtwWorkSpace = (UINT8 *) (FtwDevice + 1);

-  FtwDevice->FtwWorkSpaceHeader = (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *) FtwDevice->FtwWorkSpace;

-

-  FtwDevice->FtwLastWriteHeader = NULL;

-  FtwDevice->FtwLastWriteRecord = NULL;

-

-  //

-  // Refresh the working space data from working block

-  //

-  Status = WorkSpaceRefresh (FtwDevice);

-  ASSERT_EFI_ERROR (Status);

-  //

-  // If the working block workspace is not valid, try the spare block

-  //

-  if (!IsValidWorkSpace (FtwDevice->FtwWorkSpaceHeader)) {

-    //

-    // Read from spare block

-    //

-    Length = FtwDevice->FtwWorkSpaceSize;

-    Status = FtwDevice->FtwBackupFvb->Read (

-                    FtwDevice->FtwBackupFvb,

-                    FtwDevice->FtwSpareLba,

-                    FtwDevice->FtwWorkSpaceBase,

-                    &Length,

-                    FtwDevice->FtwWorkSpace

-                    );

-    ASSERT_EFI_ERROR (Status);

-

-    //

-    // If spare block is valid, then replace working block content.

-    //

-    if (IsValidWorkSpace (FtwDevice->FtwWorkSpaceHeader)) {

-      Status = FlushSpareBlockToWorkingBlock (FtwDevice);

-      DEBUG ((EFI_D_ERROR, "Ftw: Restart working block update in Init() - %r\n", Status));

-      FtwAbort (&FtwDevice->FtwInstance);

-      //

-      // Refresh work space.

-      //

-      Status = WorkSpaceRefresh (FtwDevice);

-      ASSERT_EFI_ERROR (Status);

-    } else {

-      DEBUG ((EFI_D_ERROR, "Ftw: Both are invalid, init workspace\n"));

-      //

-      // If both are invalid, then initialize work space.

-      //

-      SetMem (

-        FtwDevice->FtwWorkSpace,

-        FtwDevice->FtwWorkSpaceSize,

-        FTW_ERASED_BYTE

-        );

-      InitWorkSpaceHeader (FtwDevice->FtwWorkSpaceHeader);

-      //

-      // Initialize the work space

-      //

-      Status = FtwReclaimWorkSpace (FtwDevice, FALSE);

-      ASSERT_EFI_ERROR (Status);

-    }

-  }

-  //

-  // If the FtwDevice->FtwLastWriteRecord is 1st record of write header &&

-  // (! SpareComplete) THEN call Abort().

-  //

-  if ((FtwDevice->FtwLastWriteHeader->HeaderAllocated == FTW_VALID_STATE) &&

-    (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);

-  }

-  //

-  // If Header is incompleted and the last record has completed, then

-  // 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)

-    ) {

-    DEBUG ((EFI_D_ERROR, "Ftw: Init.. find last record completed but header not, abort()\n"));

-    FtwAbort (&FtwDevice->FtwInstance);

-  }

-  //

-  // To check the workspace buffer following last Write header/records is EMPTY or not.

-  // If it's not EMPTY, FTW also need to call reclaim().

-  //

-  FtwHeader = FtwDevice->FtwLastWriteHeader;

-  Offset    = (UINT8 *) FtwHeader - FtwDevice->FtwWorkSpace;

-  if (FtwDevice->FtwWorkSpace[Offset] != FTW_ERASED_BYTE) {

-    Offset += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);

-  }

-  

-  if (!IsErasedFlashBuffer (FtwDevice->FtwWorkSpace + Offset, FtwDevice->FtwWorkSpaceSize - Offset)) {

-    Status = FtwReclaimWorkSpace (FtwDevice, TRUE);

-    ASSERT_EFI_ERROR (Status);

-  }

-

-  //

-  // Restart if it's boot block

-  //

-  if ((FtwDevice->FtwLastWriteHeader->Complete != 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));

-      ASSERT_EFI_ERROR (Status);

-      FtwAbort (&FtwDevice->FtwInstance);

-    } else {

-      //

-      // if (SpareCompleted) THEN  Restart to fault tolerant write.

-      //

-      FvbHandle = GetFvbByAddress (FtwDevice->FtwLastWriteRecord->FvBaseAddress, &Fvb);

-      if (FvbHandle != NULL) {

-        Status = FtwRestart (&FtwDevice->FtwInstance, FvbHandle);

-        DEBUG ((EFI_D_ERROR, "FtwLite: Restart last write - %r\n", Status));

-        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;

-  

-  //

-  // Install protocol interface

-  //

-  Status = gBS->InstallProtocolInterface (

-            &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;

-  }

-

-  ZeroMem (FtwDevice, sizeof (EFI_FTW_DEVICE));

-  FtwDevice->Signature = FTW_DEVICE_SIGNATURE;

-

-  //

-  // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.

-  //

-

-  FtwDevice->WorkSpaceLength  = (UINTN) PcdGet32 (PcdFlashNvStorageFtwWorkingSize);

-

-  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;

-  }

-  FtwDevice->FtwFvBlock       = NULL;

-  FtwDevice->FtwBackupFvb     = NULL;

-  FtwDevice->FtwWorkSpaceLba  = (EFI_LBA) (-1);

-  FtwDevice->FtwSpareLba      = (EFI_LBA) (-1);

-

-  //

-  // Register FvbNotificationEvent () notify function.

-  // 

-  EfiCreateProtocolNotifyEvent (

-    &gEfiFirmwareVolumeBlockProtocolGuid,

-    TPL_CALLBACK,

-    FvbNotificationEvent,

-    (VOID *)FtwDevice,

-    &mFvbRegistration

-    );

-

-  return EFI_SUCCESS;

-}

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
index a75db426fd..00ac5c9c98 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWrite.h
@@ -3,7 +3,7 @@
   The internal header file includes the common header files, defines

   internal structure and functions used by FtwLite module.

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials                          

 are licensed and made available under the terms and conditions of the BSD License         

 which accompanies this distribution.  The full text of the license may be found at        

@@ -670,4 +670,71 @@ GetFvbByAddress (
   OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL **FvBlock

   );

 

+/**

+  Retrive the proper Swap Address Range protocol interface.

+

+  @param[out] SarProtocol       The interface of SAR protocol

+

+  @retval EFI_SUCCESS           The SAR protocol instance was found and returned in SarProtocol.

+  @retval EFI_NOT_FOUND         The SAR protocol instance was not found.

+  @retval EFI_INVALID_PARAMETER SarProtocol is NULL.

+

+**/

+EFI_STATUS

+FtwGetSarProtocol (

+  OUT VOID                                **SarProtocol

+  );

+  

+/**

+  Function returns an array of handles that support the FVB protocol

+  in a buffer allocated from pool. 

+

+  @param[out]  NumberHandles    The number of handles returned in Buffer.

+  @param[out]  Buffer           A pointer to the buffer to return the requested

+                                array of  handles that support FVB protocol.

+

+  @retval EFI_SUCCESS           The array of handles was returned in Buffer, and the number of

+                                handles in Buffer was returned in NumberHandles.

+  @retval EFI_NOT_FOUND         No FVB handle was found.

+  @retval EFI_OUT_OF_RESOURCES  There is not enough pool memory to store the matching results.

+  @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.

+

+**/

+EFI_STATUS

+GetFvbCountAndBuffer (

+  OUT UINTN                               *NumberHandles,

+  OUT EFI_HANDLE                          **Buffer

+  );

+

+

+/**

+  Allocate private data for FTW driver and initialize it.

+

+  @param[out] FtwData           Pointer to the FTW device structure

+

+  @retval EFI_SUCCESS           Initialize the FTW device successfully.

+  @retval EFI_OUT_OF_RESOURCES  Allocate memory error

+  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist

+

+**/

+EFI_STATUS

+InitFtwDevice (

+  OUT EFI_FTW_DEVICE               **FtwData 

+  );

+

+

+/**

+  Initialization for Fault Tolerant Write is done in this handler.

+

+  @param[in,out] FtwData        Pointer to the FTW device structure

+

+  @retval EFI_SUCCESS           Initialize the FTW protocol successfully.

+  @retval EFI_NOT_FOUND         No proper FVB protocol was found.

+  

+**/

+EFI_STATUS

+InitFtwProtocol (

+  IN OUT EFI_FTW_DEVICE               *FtwDevice

+  );

+ 

 #endif

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.c
new file mode 100644
index 0000000000..5f998c0c66
--- /dev/null
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.c
@@ -0,0 +1,250 @@
+/** @file

+

+  This is a simple fault tolerant write driver.

+

+  This boot service protocol only provides fault tolerant write capability for 

+  block devices.  The protocol has internal non-volatile intermediate storage 

+  of the data and private information. It should be able to recover 

+  automatically from a critical fault, such as power failure. 

+

+  The implementation uses an FTW (Fault Tolerant Write) Work Space. 

+  This work space is a memory copy of the work space on the Working Block,

+  the size of the work space is the FTW_WORK_SPACE_SIZE bytes.

+  

+  The work space stores each write record as EFI_FTW_RECORD structure.

+  The spare block stores the write buffer before write to the target block.

+  

+  The write record has three states to specify the different phase of write operation.

+  1) WRITE_ALLOCATED is that the record is allocated in write space.

+     The information of write operation is stored in write record structure.

+  2) SPARE_COMPLETED is that the data from write buffer is writed into the spare block as the backup.

+  3) WRITE_COMPLETED is that the data is copied from the spare block to the target block.

+

+  This driver operates the data as the whole size of spare block.

+  It first read the SpareAreaLength data from the target block into the spare memory buffer.

+  Then copy the write buffer data into the spare memory buffer.

+  Then write the spare memory buffer into the spare block.

+  Final copy the data from the spare block to the target block.

+

+  To make this drive work well, the following conditions must be satisfied:

+  1. The write NumBytes data must be fit within Spare area. 

+     Offset + NumBytes <= SpareAreaLength

+  2. The whole flash range has the same block size.

+  3. Working block is an area which contains working space in its last block and has the same size as spare block.

+  4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on.  

+  5. Spare area must be in the single one Firmware Volume Block range which FVB protocol is produced on.

+  6. Any write data area (SpareAreaLength Area) which the data will be written into must be 

+     in the single one Firmware Volume Block range which FVB protocol is produced on.

+  7. If write data area (such as Variable range) is enlarged, the spare area range must be enlarged.

+     The spare area must be enough large to store the write data before write them into the target range.

+  If one of them is not satisfied, FtwWrite may fail.

+  Usually, Spare area only takes one block. That's SpareAreaLength = BlockSize, NumberOfSpareBlock = 1.

+

+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

+This program and the accompanying materials                          

+are licensed and made available under the terms and conditions of the BSD License         

+which accompanies this distribution.  The full text of the license may be found at        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  

+

+**/

+

+#include "FaultTolerantWrite.h"

+EFI_EVENT                                 mFvbRegistration = NULL;

+

+

+/**

+  Retrive the FVB protocol interface by HANDLE.

+

+  @param[in]  FvBlockHandle     The handle of FVB protocol that provides services for

+                                reading, writing, and erasing the target block.

+  @param[out] FvBlock           The interface of FVB protocol

+

+  @retval EFI_SUCCESS           The interface information for the specified protocol was returned.

+  @retval EFI_UNSUPPORTED       The device does not support the FVB protocol.

+  @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.

+  

+**/

+EFI_STATUS

+FtwGetFvbByHandle (

+  IN  EFI_HANDLE                          FvBlockHandle,

+  OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvBlock

+  )

+{

+  //

+  // To get the FVB protocol interface on the handle

+  //

+  return gBS->HandleProtocol (

+                FvBlockHandle,

+                &gEfiFirmwareVolumeBlockProtocolGuid,

+                (VOID **) FvBlock

+                );

+}

+

+/**

+  Retrive the Swap Address Range protocol interface.

+

+  @param[out] SarProtocol       The interface of SAR protocol

+

+  @retval EFI_SUCCESS           The SAR protocol instance was found and returned in SarProtocol.

+  @retval EFI_NOT_FOUND         The SAR protocol instance was not found.

+  @retval EFI_INVALID_PARAMETER SarProtocol is NULL.

+

+**/

+EFI_STATUS

+FtwGetSarProtocol (

+  OUT VOID                                **SarProtocol

+  )

+{

+  EFI_STATUS                              Status;

+

+  //

+  // Locate Swap Address Range protocol

+  //

+  Status = gBS->LocateProtocol (

+                  &gEfiSwapAddressRangeProtocolGuid, 

+                  NULL, 

+                  SarProtocol

+                  );

+  return Status;

+}

+

+/**

+  Function returns an array of handles that support the FVB protocol

+  in a buffer allocated from pool. 

+

+  @param[out]  NumberHandles    The number of handles returned in Buffer.

+  @param[out]  Buffer           A pointer to the buffer to return the requested

+                                array of  handles that support FVB protocol.

+

+  @retval EFI_SUCCESS           The array of handles was returned in Buffer, and the number of

+                                handles in Buffer was returned in NumberHandles.

+  @retval EFI_NOT_FOUND         No FVB handle was found.

+  @retval EFI_OUT_OF_RESOURCES  There is not enough pool memory to store the matching results.

+  @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.

+  

+**/

+EFI_STATUS

+GetFvbCountAndBuffer (

+  OUT UINTN                               *NumberHandles,

+  OUT EFI_HANDLE                          **Buffer

+  )

+{

+  EFI_STATUS                              Status;

+

+  //

+  // Locate all handles of Fvb protocol

+  //

+  Status = gBS->LocateHandleBuffer (

+                  ByProtocol,

+                  &gEfiFirmwareVolumeBlockProtocolGuid,

+                  NULL,

+                  NumberHandles,

+                  Buffer

+                  );

+  return Status;

+}

+

+

+/**

+  Firmware Volume Block Protocol notification event handler.

+

+  @param[in] Event    Event whose notification function is being invoked.

+  @param[in] Context  Pointer to the notification function's context.

+

+**/

+VOID

+EFIAPI

+FvbNotificationEvent (

+  IN  EFI_EVENT                           Event,

+  IN  VOID                                *Context

+  )

+{

+  EFI_STATUS                              Status;

+  EFI_FAULT_TOLERANT_WRITE_PROTOCOL       *FtwProtocol;

+  EFI_FTW_DEVICE                          *FtwDevice;

+

+  //

+  // Just return to avoid install SMM FaultTolerantWriteProtocol again

+  // if Fault Tolerant Write protocol had been installed.

+  //  

+  Status = gBS->LocateProtocol (

+                  &gEfiFaultTolerantWriteProtocolGuid, 

+                  NULL, 

+                  (VOID **) &FtwProtocol

+                  );

+  if (!EFI_ERROR (Status)) {

+    return ;

+  }

+

+  //

+  // Found proper FVB protocol and initialize FtwDevice for protocol installation

+  //

+  FtwDevice = (EFI_FTW_DEVICE *)Context;

+  Status = InitFtwProtocol (FtwDevice);

+  if (EFI_ERROR(Status)) {

+    return ;

+  }                          

+    

+  //

+  // Install protocol interface

+  //

+  Status = gBS->InstallProtocolInterface (

+                  &FtwDevice->Handle,

+                  &gEfiFaultTolerantWriteProtocolGuid,

+                  EFI_NATIVE_INTERFACE,

+                  &FtwDevice->FtwInstance

+                  );

+  ASSERT_EFI_ERROR (Status);

+  

+  Status = gBS->CloseEvent (Event);

+  ASSERT_EFI_ERROR (Status);

+  

+  return;

+}

+

+

+/**

+  This function is the entry point of the Fault Tolerant Write driver.

+

+  @param[in] ImageHandle        A handle for the image that is initializing this driver

+  @param[in] SystemTable        A pointer to the EFI system table

+

+  @retval EFI_SUCCESS           The initialization finished successfully.

+  @retval EFI_OUT_OF_RESOURCES  Allocate memory error

+  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist

+  

+**/

+EFI_STATUS

+EFIAPI

+FaultTolerantWriteInitialize (

+  IN EFI_HANDLE                           ImageHandle,

+  IN EFI_SYSTEM_TABLE                     *SystemTable

+  )

+{

+  EFI_STATUS                              Status;

+  EFI_FTW_DEVICE                          *FtwDevice;

+

+  //

+  // Allocate private data structure for FTW protocol and do some initialization

+  //

+  Status = InitFtwDevice (&FtwDevice);

+  if (EFI_ERROR(Status)) {

+    return Status;

+  }

+

+  //

+  // Register FvbNotificationEvent () notify function.

+  // 

+  EfiCreateProtocolNotifyEvent (

+    &gEfiFirmwareVolumeBlockProtocolGuid,

+    TPL_CALLBACK,

+    FvbNotificationEvent,

+    (VOID *)FtwDevice,

+    &mFvbRegistration

+    );

+  

+  return EFI_SUCCESS;

+}

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
index 1376959163..61139d486f 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteDxe.inf
@@ -20,7 +20,7 @@
   FILE_GUID                      = FE5CEA76-4F72-49e8-986F-2CD899DFFE5D

   MODULE_TYPE                    = DXE_DRIVER

   VERSION_STRING                 = 1.0

-  ENTRY_POINT                    = InitializeFaultTolerantWrite

+  ENTRY_POINT                    = FaultTolerantWriteInitialize

 

 #

 # The following information is for reference only and not required by the build tools.

@@ -32,6 +32,7 @@
   FtwMisc.c

   UpdateWorkingBlock.c

   FaultTolerantWrite.c

+  FaultTolerantWriteDxe.c

   FaultTolerantWrite.h

 

 [Packages]

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.c
new file mode 100644
index 0000000000..ffa7cb91e4
--- /dev/null
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.c
@@ -0,0 +1,281 @@
+/** @file

+

+  This is a simple fault tolerant write driver that is intended to use in the SMM environment.

+

+  This boot service protocol only provides fault tolerant write capability for 

+  block devices.  The protocol has internal non-volatile intermediate storage 

+  of the data and private information. It should be able to recover 

+  automatically from a critical fault, such as power failure. 

+

+  The implementation uses an FTW (Fault Tolerant Write) Work Space. 

+  This work space is a memory copy of the work space on the Working Block,

+  the size of the work space is the FTW_WORK_SPACE_SIZE bytes.

+  

+  The work space stores each write record as EFI_FTW_RECORD structure.

+  The spare block stores the write buffer before write to the target block.

+  

+  The write record has three states to specify the different phase of write operation.

+  1) WRITE_ALLOCATED is that the record is allocated in write space.

+     The information of write operation is stored in write record structure.

+  2) SPARE_COMPLETED is that the data from write buffer is writed into the spare block as the backup.

+  3) WRITE_COMPLETED is that the data is copied from the spare block to the target block.

+

+  This driver operates the data as the whole size of spare block.

+  It first read the SpareAreaLength data from the target block into the spare memory buffer.

+  Then copy the write buffer data into the spare memory buffer.

+  Then write the spare memory buffer into the spare block.

+  Final copy the data from the spare block to the target block.

+

+  To make this drive work well, the following conditions must be satisfied:

+  1. The write NumBytes data must be fit within Spare area. 

+     Offset + NumBytes <= SpareAreaLength

+  2. The whole flash range has the same block size.

+  3. Working block is an area which contains working space in its last block and has the same size as spare block.

+  4. Working Block area must be in the single one Firmware Volume Block range which FVB protocol is produced on.  

+  5. Spare area must be in the single one Firmware Volume Block range which FVB protocol is produced on.

+  6. Any write data area (SpareAreaLength Area) which the data will be written into must be 

+     in the single one Firmware Volume Block range which FVB protocol is produced on.

+  7. If write data area (such as Variable range) is enlarged, the spare area range must be enlarged.

+     The spare area must be enough large to store the write data before write them into the target range.

+  If one of them is not satisfied, FtwWrite may fail.

+  Usually, Spare area only takes one block. That's SpareAreaLength = BlockSize, NumberOfSpareBlock = 1.

+

+Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>

+This program and the accompanying materials                          

+are licensed and made available under the terms and conditions of the BSD License         

+which accompanies this distribution.  The full text of the license may be found at        

+http://opensource.org/licenses/bsd-license.php                                            

+                                                                                          

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.  

+

+**/

+

+#include <Library/SmmServicesTableLib.h>

+#include "FaultTolerantWrite.h"

+#include <Protocol/SmmFirmwareVolumeBlock.h>

+#include <Protocol/SmmSwapAddressRange.h>

+#include <Protocol/SmmFaultTolerantWrite.h>

+

+EFI_EVENT                                 mFvbRegistration = NULL;

+EFI_FTW_DEVICE                            *gFtwDevice      = NULL;

+

+/**

+  Retrive the SMM FVB protocol interface by HANDLE.

+

+  @param[in]  FvBlockHandle     The handle of SMM FVB protocol that provides services for

+                                reading, writing, and erasing the target block.

+  @param[out] FvBlock           The interface of SMM FVB protocol

+

+  @retval EFI_SUCCESS           The interface information for the specified protocol was returned.

+  @retval EFI_UNSUPPORTED       The device does not support the SMM FVB protocol.

+  @retval EFI_INVALID_PARAMETER FvBlockHandle is not a valid EFI_HANDLE or FvBlock is NULL.

+

+**/

+EFI_STATUS

+FtwGetFvbByHandle (

+  IN  EFI_HANDLE                          FvBlockHandle,

+  OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvBlock

+  )

+{

+  //

+  // To get the SMM FVB protocol interface on the handle

+  //

+  return gSmst->SmmHandleProtocol (

+                  FvBlockHandle,

+                  &gEfiSmmFirmwareVolumeBlockProtocolGuid,

+                  (VOID **) FvBlock

+                  );

+}

+

+/**

+  Retrive the SMM Swap Address Range protocol interface.

+

+  @param[out] SarProtocol       The interface of SMM SAR protocol

+

+  @retval EFI_SUCCESS           The SMM SAR protocol instance was found and returned in SarProtocol.

+  @retval EFI_NOT_FOUND         The SMM SAR protocol instance was not found.

+  @retval EFI_INVALID_PARAMETER SarProtocol is NULL.

+

+**/

+EFI_STATUS

+FtwGetSarProtocol (

+  OUT VOID                                **SarProtocol

+  )

+{

+  EFI_STATUS                              Status;

+

+  //

+  // Locate Smm Swap Address Range protocol

+  //

+  Status = gSmst->SmmLocateProtocol (

+                    &gEfiSmmSwapAddressRangeProtocolGuid, 

+                    NULL, 

+                    SarProtocol

+                    );

+  return Status;

+}

+

+/**

+  Function returns an array of handles that support the SMM FVB protocol

+  in a buffer allocated from pool. 

+

+  @param[out]  NumberHandles    The number of handles returned in Buffer.

+  @param[out]  Buffer           A pointer to the buffer to return the requested

+                                array of  handles that support SMM FVB protocol.

+

+  @retval EFI_SUCCESS           The array of handles was returned in Buffer, and the number of

+                                handles in Buffer was returned in NumberHandles.

+  @retval EFI_NOT_FOUND         No SMM FVB handle was found.

+  @retval EFI_OUT_OF_RESOURCES  There is not enough pool memory to store the matching results.

+  @retval EFI_INVALID_PARAMETER NumberHandles is NULL or Buffer is NULL.

+

+**/

+EFI_STATUS

+GetFvbCountAndBuffer (

+  OUT UINTN                               *NumberHandles,

+  OUT EFI_HANDLE                          **Buffer

+  )

+{

+  EFI_STATUS                              Status;

+  UINTN                                   BufferSize;

+

+  if ((NumberHandles == NULL) || (Buffer == NULL)) {

+    return EFI_INVALID_PARAMETER;

+  }

+

+  BufferSize     = 0;

+  *NumberHandles = 0;

+  *Buffer        = NULL;

+  Status = gSmst->SmmLocateHandle (

+                    ByProtocol,

+                    &gEfiSmmFirmwareVolumeBlockProtocolGuid,

+                    NULL,

+                    &BufferSize,

+                    *Buffer

+                    );

+  if (EFI_ERROR(Status) && Status != EFI_BUFFER_TOO_SMALL) {

+    return EFI_NOT_FOUND;

+  }

+

+  *Buffer = AllocatePool (BufferSize);

+  if (*Buffer == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  Status = gSmst->SmmLocateHandle (

+                    ByProtocol,

+                    &gEfiSmmFirmwareVolumeBlockProtocolGuid,

+                    NULL,

+                    &BufferSize,

+                    *Buffer

+                    );

+

+  *NumberHandles = BufferSize / sizeof(EFI_HANDLE);

+  if (EFI_ERROR(Status)) {

+    *NumberHandles = 0;

+  }

+

+  return Status;

+}

+

+

+/**

+  SMM Firmware Volume Block Protocol notification event handler.

+  

+  @param[in]  Protocol      Points to the protocol's unique identifier

+  @param[in]  Interface     Points to the interface instance

+  @param[in]  Handle        The handle on which the interface was installed

+

+  @retval EFI_SUCCESS       SmmEventCallback runs successfully

+  

+ **/

+EFI_STATUS

+EFIAPI

+FvbNotificationEvent (

+  IN CONST EFI_GUID                       *Protocol,

+  IN VOID                                 *Interface,

+  IN EFI_HANDLE                           Handle

+  )

+{

+  EFI_STATUS                              Status;

+  EFI_SMM_FAULT_TOLERANT_WRITE_PROTOCOL   *FtwProtocol;

+  

+  //

+  // Just return to avoid install SMM FaultTolerantWriteProtocol again

+  // if SMM Fault Tolerant Write protocol had been installed.

+  //  

+  Status = gSmst->SmmLocateProtocol (

+                    &gEfiSmmFaultTolerantWriteProtocolGuid, 

+                    NULL, 

+                    (VOID **) &FtwProtocol

+                    );

+  if (!EFI_ERROR (Status)) {

+    return EFI_SUCCESS;

+  }

+

+  //

+  // Found proper FVB protocol and initialize FtwDevice for protocol installation

+  //

+  Status = InitFtwProtocol (gFtwDevice);

+  if (EFI_ERROR(Status)) {

+    return Status;

+  }

+  

+  //

+  // Install protocol interface

+  //

+  Status = gSmst->SmmInstallProtocolInterface (

+                    &gFtwDevice->Handle,

+                    &gEfiSmmFaultTolerantWriteProtocolGuid,

+                    EFI_NATIVE_INTERFACE,

+                    &gFtwDevice->FtwInstance

+                    );

+  ASSERT_EFI_ERROR (Status); 

+  

+  return EFI_SUCCESS;

+}

+

+

+/**

+  This function is the entry point of the Fault Tolerant Write driver.

+

+  @param[in] ImageHandle        A handle for the image that is initializing this driver

+  @param[in] SystemTable        A pointer to the EFI system table

+

+  @retval EFI_SUCCESS           The initialization finished successfully.

+  @retval EFI_OUT_OF_RESOURCES  Allocate memory error

+  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist

+

+**/

+EFI_STATUS

+EFIAPI

+SmmFaultTolerantWriteInitialize (

+  IN EFI_HANDLE                           ImageHandle,

+  IN EFI_SYSTEM_TABLE                     *SystemTable

+  )

+{

+  EFI_STATUS                              Status;

+

+  //

+  // Allocate private data structure for SMM FTW protocol and do some initialization

+  //

+  Status = InitFtwDevice (&gFtwDevice);

+  if (EFI_ERROR(Status)) {

+    return Status;

+  }

+  

+  //

+  // Register FvbNotificationEvent () notify function.

+  // 

+  Status = gSmst->SmmRegisterProtocolNotify (

+                    &gEfiSmmFirmwareVolumeBlockProtocolGuid,

+                    FvbNotificationEvent,

+                    &mFvbRegistration

+                    );

+  ASSERT_EFI_ERROR (Status);

+

+  FvbNotificationEvent (NULL, NULL, NULL);

+  

+  return EFI_SUCCESS;

+}

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
new file mode 100644
index 0000000000..356172171d
--- /dev/null
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmm.inf
@@ -0,0 +1,73 @@
+## @file

+#   This driver installs SMM Fault Tolerant Write (FTW) protocol, which provides fault 

+#   tolerant write capability in SMM environment for block devices. Its implementation 

+#   depends on the full functionality SMM FVB protocol that support read, write/erase 

+#   flash access.

+#

+# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>

+#

+#  This program and the accompanying materials

+#  are licensed and made available under the terms and conditions of the BSD License

+#  which accompanies this distribution. The full text of the license may be found at

+#  http://opensource.org/licenses/bsd-license.php

+#  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

+#  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

+#

+##

+

+[Defines]

+  INF_VERSION                    = 0x00010005

+  BASE_NAME                      = SmmFaultTolerantWriteDxe

+  FILE_GUID                      = 470CB248-E8AC-473c-BB4F-81069A1FE6FD

+  MODULE_TYPE                    = DXE_SMM_DRIVER

+  VERSION_STRING                 = 1.0

+  PI_SPECIFICATION_VERSION       = 0x0001000A

+  ENTRY_POINT                    = SmmFaultTolerantWriteInitialize

+

+#

+# The following information is for reference only and not required by the build tools.

+#

+#  VALID_ARCHITECTURES           = IA32 X64

+#

+

+[Sources]

+  FtwMisc.c

+  UpdateWorkingBlock.c

+  FaultTolerantWrite.c

+  FaultTolerantWriteSmm.c

+  FaultTolerantWrite.h

+

+[Packages]

+  MdePkg/MdePkg.dec

+  MdeModulePkg/MdeModulePkg.dec

+

+[LibraryClasses]

+  SmmServicesTableLib

+  MemoryAllocationLib

+  BaseMemoryLib

+  UefiDriverEntryPoint

+  DebugLib

+  UefiLib

+

+[Guids]

+  gEfiSystemNvDataFvGuid                        ## CONSUMES ## FV Signature of Working Space Header

+

+[Protocols]

+  gEfiSmmSwapAddressRangeProtocolGuid     | PcdFullFtwServiceEnable          ## CONSUMES

+  gEfiSmmFirmwareVolumeBlockProtocolGuid           ## CONSUMES

+  gEfiSmmFaultTolerantWriteProtocolGuid            ## PRODUCES

+

+[FeaturePcd]

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable

+

+[Pcd]

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase64

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingSize

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareBase64

+  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwSpareSize

+

+[Depex]

+  gEfiSmmFirmwareVolumeBlockProtocolGuid

+

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
index b8550f5d86..7a32f4db83 100644
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
@@ -2,7 +2,7 @@
 

   Internal generic functions to operate flash block.

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials                          

 are licensed and made available under the terms and conditions of the BSD License         

 which accompanies this distribution.  The full text of the license may be found at        

@@ -105,34 +105,6 @@ FtwEraseSpareBlock (
 }

 

 /**

-  Retrive the proper FVB protocol interface by HANDLE.

-

-

-  @param FvBlockHandle   The handle of FVB protocol that provides services for

-                         reading, writing, and erasing the target block.

-  @param FvBlock         The interface of FVB protocol

-

-  @retval  EFI_SUCCESS   The function completed successfully

-  @retval  EFI_ABORTED   The function could not complete successfully

-

-**/

-EFI_STATUS

-FtwGetFvbByHandle (

-  IN EFI_HANDLE                           FvBlockHandle,

-  OUT EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  **FvBlock

-  )

-{

-  //

-  // To get the FVB protocol interface on the handle

-  //

-  return gBS->HandleProtocol (

-                FvBlockHandle,

-                &gEfiFirmwareVolumeBlockProtocolGuid,

-                (VOID **) FvBlock

-                );

-}

-

-/**

 

   Is it in working block?

 

@@ -195,13 +167,7 @@ GetFvbByAddress (
   //

   // Locate all handles of Fvb protocol

   //

-  Status = gBS->LocateHandleBuffer (

-                  ByProtocol,

-                  &gEfiFirmwareVolumeBlockProtocolGuid,

-                  NULL,

-                  &HandleCount,

-                  &HandleBuffer

-                  );

+  Status = GetFvbCountAndBuffer (&HandleCount, &HandleBuffer);

   if (EFI_ERROR (Status)) {

     return NULL;

   }

@@ -209,11 +175,7 @@ GetFvbByAddress (
   // Get the FVB to access variable store

   //

   for (Index = 0; Index < HandleCount; Index += 1) {

-    Status = gBS->HandleProtocol (

-                    HandleBuffer[Index],

-                    &gEfiFirmwareVolumeBlockProtocolGuid,

-                    (VOID **) &Fvb

-                    );

+    Status = FtwGetFvbByHandle (HandleBuffer[Index], &Fvb);

     if (EFI_ERROR (Status)) {

       break;

     }

@@ -269,7 +231,7 @@ IsBootBlock (
     return FALSE;

   }

 

-  Status = gBS->LocateProtocol (&gEfiSwapAddressRangeProtocolGuid, NULL, (VOID **) &SarProtocol);

+  Status = FtwGetSarProtocol ((VOID **) &SarProtocol);

   if (EFI_ERROR (Status)) {

     return FALSE;

   }

@@ -358,7 +320,7 @@ FlushSpareBlockToBootBlock (
   //

   // Locate swap address range protocol

   //

-  Status = gBS->LocateProtocol (&gEfiSwapAddressRangeProtocolGuid, NULL, (VOID **) &SarProtocol);

+  Status = FtwGetSarProtocol ((VOID **) &SarProtocol);

   if (EFI_ERROR (Status)) {

     return Status;

   }

@@ -969,3 +931,371 @@ GetPreviousRecordOfWrites (
   *FtwRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) Ptr;

   return EFI_SUCCESS;

 }

+

+/**

+  Allocate private data for FTW driver and initialize it.

+

+  @param[out] FtwData           Pointer to the FTW device structure

+

+  @retval EFI_SUCCESS           Initialize the FTW device successfully.

+  @retval EFI_OUT_OF_RESOURCES  Allocate memory error

+  @retval EFI_INVALID_PARAMETER Workspace or Spare block does not exist

+

+**/

+EFI_STATUS

+InitFtwDevice (

+  OUT EFI_FTW_DEVICE               **FtwData 

+  )

+{

+  EFI_FTW_DEVICE                   *FtwDevice;

+  

+  //

+  // Allocate private data of this driver,

+  // Including the FtwWorkSpace[FTW_WORK_SPACE_SIZE].

+  //

+  FtwDevice = AllocateZeroPool (sizeof (EFI_FTW_DEVICE) + PcdGet32 (PcdFlashNvStorageFtwWorkingSize));

+  if (FtwDevice == NULL) {

+    return EFI_OUT_OF_RESOURCES;

+  }

+

+  //

+  // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.

+  //

+  FtwDevice->WorkSpaceLength  = (UINTN) PcdGet32 (PcdFlashNvStorageFtwWorkingSize);

+  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_INVALID_PARAMETER;

+  }

+

+  FtwDevice->Signature        = FTW_DEVICE_SIGNATURE;

+  FtwDevice->FtwFvBlock       = NULL;

+  FtwDevice->FtwBackupFvb     = NULL;

+  FtwDevice->FtwWorkSpaceLba  = (EFI_LBA) (-1);

+  FtwDevice->FtwSpareLba      = (EFI_LBA) (-1);

+

+  FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageFtwWorkingBase64);

+  if (FtwDevice->WorkSpaceAddress == 0) {

+    FtwDevice->WorkSpaceAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwWorkingBase);

+  }

+  

+  FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet64 (PcdFlashNvStorageFtwSpareBase64);

+  if (FtwDevice->SpareAreaAddress == 0) {

+    FtwDevice->SpareAreaAddress = (EFI_PHYSICAL_ADDRESS) PcdGet32 (PcdFlashNvStorageFtwSpareBase);

+  }  

+

+  *FtwData = FtwDevice;

+  return EFI_SUCCESS;

+}

+

+

+/**

+  Initialization for Fault Tolerant Write is done in this handler.

+

+  @param[in,out] FtwData        Pointer to the FTW device structure

+

+  @retval EFI_SUCCESS           Initialize the FTW device successfully.

+  @retval EFI_NOT_FOUND         No proper FVB protocol was found.

+  @retval EFI_ABORTED           Some data can not be got or be invalid.

+  

+**/

+EFI_STATUS

+FindFvbForFtw (

+  IN OUT EFI_FTW_DEVICE               *FtwDevice

+  )

+{

+  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_FVB_ATTRIBUTES_2                Attributes;

+  EFI_FV_BLOCK_MAP_ENTRY              *FvbMapEntry;

+  UINT32                              LbaIndex;

+

+  //

+  // Get all FVB handle.

+  //

+  Status = GetFvbCountAndBuffer (&HandleCount, &HandleBuffer);

+  if (EFI_ERROR (Status)) {

+    return EFI_NOT_FOUND;

+  }

+

+  //

+  // Get the FVB to access variable store

+  //

+  Fvb = NULL;

+  for (Index = 0; Index < HandleCount; Index += 1) {

+    Status = FtwGetFvbByHandle (HandleBuffer[Index], &Fvb);

+    if (EFI_ERROR (Status)) {

+      Status = EFI_NOT_FOUND;

+      break;

+    }

+

+    //

+    // Ensure this FVB protocol support 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) 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

+      //

+      if ((FwVolHeader->FvLength) > (FwVolHeader->HeaderLength)) {

+        //

+        // Now, one FV has one type of BlockLength

+        //

+        FvbMapEntry = &FwVolHeader->BlockMap[0];

+        for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {

+          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 - (FvbBaseAddress + FvbMapEntry->Length * (LbaIndex - 1)));

+            break;

+          }

+        }

+      }

+    }

+    

+    if ((FtwDevice->FtwBackupFvb == NULL) && (FtwDevice->SpareAreaAddress >= FvbBaseAddress) &&

+      ((FtwDevice->SpareAreaAddress + FtwDevice->SpareAreaLength) <= (FvbBaseAddress + FwVolHeader->FvLength))

+      ) {

+      FtwDevice->FtwBackupFvb = Fvb;

+      //

+      // To get the LBA of spare

+      //

+      if ((FwVolHeader->FvLength) > (FwVolHeader->HeaderLength)) {

+        //

+        // Now, one FV has one type of BlockLength

+        //

+        FvbMapEntry = &FwVolHeader->BlockMap[0];

+        for (LbaIndex = 1; LbaIndex <= FvbMapEntry->NumBlocks; LbaIndex += 1) {

+          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->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 (HandleBuffer);

+              ASSERT (FALSE);

+              return EFI_ABORTED;

+            }

+            break;

+          }

+        }

+      }

+    }

+  }

+  FreePool (HandleBuffer);

+ 

+  if ((FtwDevice->FtwBackupFvb == NULL) || (FtwDevice->FtwFvBlock == NULL) ||

+    (FtwDevice->FtwWorkSpaceLba == (EFI_LBA) (-1)) || (FtwDevice->FtwSpareLba == (EFI_LBA) (-1))) {

+    return EFI_ABORTED;

+  }

+    

+  return EFI_SUCCESS;

+}

+

+

+/**

+  Initialization for Fault Tolerant Write protocol.

+

+  @param[in,out] FtwData        Pointer to the FTW device structure

+

+  @retval EFI_SUCCESS           Initialize the FTW protocol successfully.

+  @retval EFI_NOT_FOUND         No proper FVB protocol was found.

+  

+**/

+EFI_STATUS

+InitFtwProtocol (

+  IN OUT EFI_FTW_DEVICE               *FtwDevice

+  )

+{

+  EFI_STATUS                          Status;

+  EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *Fvb;

+  UINTN                               Length;

+  EFI_FAULT_TOLERANT_WRITE_HEADER     *FtwHeader;

+  UINTN                               Offset;

+  EFI_HANDLE                          FvbHandle;

+

+  //

+  // Find the right SMM Fvb protocol instance for FTW.

+  //

+  Status = FindFvbForFtw (FtwDevice);

+  if (EFI_ERROR (Status)) {

+    return EFI_NOT_FOUND;

+  }  

+  

+  //

+  // 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

+  // block, unless there are not enough blocks before the block that contains

+  // working space.

+  //

+  FtwDevice->FtwWorkBlockLba = FtwDevice->FtwWorkSpaceLba - FtwDevice->NumberOfSpareBlock + 1;

+  ASSERT ((INT64) (FtwDevice->FtwWorkBlockLba) >= 0); 

+

+  //

+  // Initialize other parameters, and set WorkSpace as FTW_ERASED_BYTE.

+  //

+  FtwDevice->FtwWorkSpace = (UINT8 *) (FtwDevice + 1);

+  FtwDevice->FtwWorkSpaceHeader = (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *) FtwDevice->FtwWorkSpace;

+

+  FtwDevice->FtwLastWriteHeader = NULL;

+  FtwDevice->FtwLastWriteRecord = NULL;

+

+  //

+  // Refresh the working space data from working block

+  //

+  Status = WorkSpaceRefresh (FtwDevice);

+  ASSERT_EFI_ERROR (Status);

+  //

+  // If the working block workspace is not valid, try the spare block

+  //

+  if (!IsValidWorkSpace (FtwDevice->FtwWorkSpaceHeader)) {

+    //

+    // Read from spare block

+    //

+    Length = FtwDevice->FtwWorkSpaceSize;

+    Status = FtwDevice->FtwBackupFvb->Read (

+                    FtwDevice->FtwBackupFvb,

+                    FtwDevice->FtwSpareLba,

+                    FtwDevice->FtwWorkSpaceBase,

+                    &Length,

+                    FtwDevice->FtwWorkSpace

+                    );

+    ASSERT_EFI_ERROR (Status);

+

+    //

+    // If spare block is valid, then replace working block content.

+    //

+    if (IsValidWorkSpace (FtwDevice->FtwWorkSpaceHeader)) {

+      Status = FlushSpareBlockToWorkingBlock (FtwDevice);

+      DEBUG ((EFI_D_ERROR, "Ftw: Restart working block update in InitFtwProtocol() - %r\n", Status));

+      FtwAbort (&FtwDevice->FtwInstance);

+      //

+      // Refresh work space.

+      //

+      Status = WorkSpaceRefresh (FtwDevice);

+      ASSERT_EFI_ERROR (Status);

+    } else {

+      DEBUG ((EFI_D_ERROR, "Ftw: Both are invalid, init workspace\n"));

+      //

+      // If both are invalid, then initialize work space.

+      //

+      SetMem (

+        FtwDevice->FtwWorkSpace,

+        FtwDevice->FtwWorkSpaceSize,

+        FTW_ERASED_BYTE

+        );

+      InitWorkSpaceHeader (FtwDevice->FtwWorkSpaceHeader);

+      //

+      // Initialize the work space

+      //

+      Status = FtwReclaimWorkSpace (FtwDevice, FALSE);

+      ASSERT_EFI_ERROR (Status);

+    }

+  }

+  //

+  // If the FtwDevice->FtwLastWriteRecord is 1st record of write header &&

+  // (! SpareComplete) THEN call Abort().

+  //

+  if ((FtwDevice->FtwLastWriteHeader->HeaderAllocated == FTW_VALID_STATE) &&

+    (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);

+  }

+  //

+  // If Header is incompleted and the last record has completed, then

+  // 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)

+    ) {

+    DEBUG ((EFI_D_ERROR, "Ftw: Init.. find last record completed but header not, abort()\n"));

+    FtwAbort (&FtwDevice->FtwInstance);

+  }

+  //

+  // To check the workspace buffer following last Write header/records is EMPTY or not.

+  // If it's not EMPTY, FTW also need to call reclaim().

+  //

+  FtwHeader = FtwDevice->FtwLastWriteHeader;

+  Offset    = (UINT8 *) FtwHeader - FtwDevice->FtwWorkSpace;

+  if (FtwDevice->FtwWorkSpace[Offset] != FTW_ERASED_BYTE) {

+    Offset += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);

+  }

+  

+  if (!IsErasedFlashBuffer (FtwDevice->FtwWorkSpace + Offset, FtwDevice->FtwWorkSpaceSize - Offset)) {

+    Status = FtwReclaimWorkSpace (FtwDevice, TRUE);

+    ASSERT_EFI_ERROR (Status);

+  }

+

+  //

+  // Restart if it's boot block

+  //

+  if ((FtwDevice->FtwLastWriteHeader->Complete != 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));

+      ASSERT_EFI_ERROR (Status);

+      FtwAbort (&FtwDevice->FtwInstance);

+    } else {

+      //

+      // if (SpareCompleted) THEN  Restart to fault tolerant write.

+      //

+      FvbHandle = NULL;

+      FvbHandle = GetFvbByAddress (FtwDevice->FtwLastWriteRecord->FvBaseAddress, &Fvb);

+      if (FvbHandle != NULL) {

+        Status = FtwRestart (&FtwDevice->FtwInstance, FvbHandle);

+        DEBUG ((EFI_D_ERROR, "FtwLite: Restart last write - %r\n", Status));

+        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;

+    

+  return EFI_SUCCESS;

+}

+