MdeModulePkg: Add the alignment check for FTW spare area address and length, and...

[mirror_edk2.git] / MdeModulePkg / Universal / FaultTolerantWriteDxe / FtwMisc.c

diff --git a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
index 7a32f4db83fc890ecb420f0431dc5831dcebde3a..b3352bbe070d03510200ae69bf0f96cf89fceb65 100644 (file)
--- a/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
+++ b/MdeModulePkg/Universal/FaultTolerantWriteDxe/FtwMisc.c
@@ -2,7 +2,7 @@
 \r
   Internal generic functions to operate flash block.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials                          \r
 are licensed and made available under the terms and conditions of the BSD License         \r
 which accompanies this distribution.  The full text of the license may be found at        \r
@@ -411,7 +411,7 @@ FlushSpareBlockToBootBlock (
     return EFI_ABORTED;\r
   }\r
   //\r
-  // Write memory buffer currenet spare block. Still top block.\r
+  // Write memory buffer to current spare block. Still top block.\r
   //\r
   Ptr = Buffer;\r
   for (Index = 0; Index < FtwDevice->NumberOfSpareBlock; Index += 1) {\r
@@ -572,6 +572,9 @@ FlushSpareBlockToWorkingBlock (
   if (Buffer == NULL) {\r
     return EFI_OUT_OF_RESOURCES;\r
   }\r
+\r
+  WorkSpaceLbaOffset = FtwDevice->FtwWorkSpaceLba - FtwDevice->FtwWorkBlockLba;\r
+\r
   //\r
   // To guarantee that the WorkingBlockValid is set on spare block\r
   //\r
@@ -581,7 +584,7 @@ FlushSpareBlockToWorkingBlock (
   //\r
   FtwUpdateFvState (\r
     FtwDevice->FtwBackupFvb,\r
-    FtwDevice->FtwWorkSpaceLba,\r
+    FtwDevice->FtwSpareLba + WorkSpaceLbaOffset,\r
     FtwDevice->FtwWorkSpaceBase + sizeof (EFI_GUID) + sizeof (UINT32),\r
     WORKING_BLOCK_VALID\r
     );\r
@@ -608,7 +611,6 @@ FlushSpareBlockToWorkingBlock (
   //\r
   // Clear the CRC and STATE, copy data from spare to working block.\r
   //\r
-  WorkSpaceLbaOffset = FtwDevice->FtwWorkSpaceLba - FtwDevice->FtwWorkBlockLba;\r
   WorkingBlockHeader = (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER *) (Buffer + (UINTN) WorkSpaceLbaOffset * FtwDevice->BlockSize + FtwDevice->FtwWorkSpaceBase);\r
   InitWorkSpaceHeader (WorkingBlockHeader);\r
   WorkingBlockHeader->WorkingBlockValid   = FTW_ERASE_POLARITY;\r
@@ -687,6 +689,7 @@ FlushSpareBlockToWorkingBlock (
     return EFI_ABORTED;\r
   }\r
 \r
+  FtwDevice->FtwWorkSpaceHeader->WorkingBlockInvalid = FTW_INVALID_STATE;\r
   FtwDevice->FtwWorkSpaceHeader->WorkingBlockValid = FTW_VALID_STATE;\r
 \r
   return EFI_SUCCESS;\r
@@ -773,11 +776,11 @@ FtwGetLastWriteHeader (
   Offset          = sizeof (EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER);\r
 \r
   while (FtwHeader->Complete == FTW_VALID_STATE) {\r
-    Offset += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);\r
+    Offset += FTW_WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);\r
     //\r
     // If Offset exceed the FTW work space boudary, return error.\r
     //\r
-    if (Offset > FtwWorkSpaceSize) {\r
+    if (Offset >= FtwWorkSpaceSize) {\r
       *FtwWriteHeader = FtwHeader;\r
       return EFI_ABORTED;\r
     }\r
@@ -832,7 +835,7 @@ FtwGetLastWriteRecord (
     FtwRecord++;\r
 \r
     if (FtwWriteHeader->PrivateDataSize != 0) {\r
-      FtwRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) ((UINTN) FtwRecord + FtwWriteHeader->PrivateDataSize);\r
+      FtwRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) ((UINTN) FtwRecord + (UINTN) FtwWriteHeader->PrivateDataSize);\r
     }\r
   }\r
   //\r
@@ -842,7 +845,7 @@ FtwGetLastWriteRecord (
   //  also return the last record.\r
   //\r
   if (Index == FtwWriteHeader->NumberOfWrites) {\r
-    *FtwWriteRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) ((UINTN) FtwRecord - RECORD_SIZE (FtwWriteHeader->PrivateDataSize));\r
+    *FtwWriteRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) ((UINTN) FtwRecord - FTW_RECORD_SIZE (FtwWriteHeader->PrivateDataSize));\r
     return EFI_SUCCESS;\r
   }\r
 \r
@@ -899,7 +902,7 @@ IsLastRecordOfWrites (
   Head  = (UINT8 *) FtwHeader;\r
   Ptr   = (UINT8 *) FtwRecord;\r
 \r
-  Head += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites - 1, FtwHeader->PrivateDataSize);\r
+  Head += FTW_WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites - 1, FtwHeader->PrivateDataSize);\r
   return (BOOLEAN) (Head == Ptr);\r
 }\r
 \r
@@ -927,7 +930,7 @@ GetPreviousRecordOfWrites (
   }\r
 \r
   Ptr = (UINT8 *) (*FtwRecord);\r
-  Ptr -= RECORD_SIZE (FtwHeader->PrivateDataSize);\r
+  Ptr -= FTW_RECORD_SIZE (FtwHeader->PrivateDataSize);\r
   *FtwRecord = (EFI_FAULT_TOLERANT_WRITE_RECORD *) Ptr;\r
   return EFI_SUCCESS;\r
 }\r
@@ -991,11 +994,11 @@ InitFtwDevice (
 \r
 \r
 /**\r
-  Initialization for Fault Tolerant Write is done in this handler.\r
+  Find the proper Firmware Volume Block protocol for FTW operation.\r
 \r
-  @param[in,out] FtwData        Pointer to the FTW device structure\r
+  @param[in, out] FtwDevice     Pointer to the FTW device structure\r
 \r
-  @retval EFI_SUCCESS           Initialize the FTW device successfully.\r
+  @retval EFI_SUCCESS           Find the FVB protocol successfully.\r
   @retval EFI_NOT_FOUND         No proper FVB protocol was found.\r
   @retval EFI_ABORTED           Some data can not be got or be invalid.\r
   \r
@@ -1108,6 +1111,20 @@ FindFvbForFtw (
               ASSERT (FALSE);\r
               return EFI_ABORTED;\r
             }\r
+            //\r
+            // Check the alignment of spare area address and length, they should be block size aligned\r
+            //\r
+            if (((FtwDevice->SpareAreaAddress & (FtwDevice->BlockSize - 1)) != 0) ||\r
+                ((FtwDevice->SpareAreaLength & (FtwDevice->BlockSize - 1)) != 0)) {\r
+              DEBUG ((EFI_D_ERROR, "Ftw: Spare area address or length is not block size aligned\n"));\r
+              FreePool (HandleBuffer);\r
+              //\r
+              // Report Status Code EFI_SW_EC_ABORTED.\r
+              //\r
+              REPORT_STATUS_CODE (  (EFI_ERROR_CODE | EFI_ERROR_UNRECOVERED), (EFI_SOFTWARE_DXE_BS_DRIVER | EFI_SW_EC_ABORTED));\r
+              ASSERT (FALSE);\r
+              CpuDeadLoop ();\r
+            }\r
             break;\r
           }\r
         }\r
@@ -1115,12 +1132,12 @@ FindFvbForFtw (
     }\r
   }\r
   FreePool (HandleBuffer);\r
- \r
+\r
   if ((FtwDevice->FtwBackupFvb == NULL) || (FtwDevice->FtwFvBlock == NULL) ||\r
     (FtwDevice->FtwWorkSpaceLba == (EFI_LBA) (-1)) || (FtwDevice->FtwSpareLba == (EFI_LBA) (-1))) {\r
     return EFI_ABORTED;\r
   }\r
-    \r
+\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -1128,7 +1145,7 @@ FindFvbForFtw (
 /**\r
   Initialization for Fault Tolerant Write protocol.\r
 \r
-  @param[in,out] FtwData        Pointer to the FTW device structure\r
+  @param[in, out] FtwDevice     Pointer to the FTW device structure\r
 \r
   @retval EFI_SUCCESS           Initialize the FTW protocol successfully.\r
   @retval EFI_NOT_FOUND         No proper FVB protocol was found.\r
@@ -1145,6 +1162,7 @@ InitFtwProtocol (
   EFI_FAULT_TOLERANT_WRITE_HEADER     *FtwHeader;\r
   UINTN                               Offset;\r
   EFI_HANDLE                          FvbHandle;\r
+  EFI_LBA                             WorkSpaceLbaOffset;\r
 \r
   //\r
   // Find the right SMM Fvb protocol instance for FTW.\r
@@ -1172,6 +1190,8 @@ InitFtwProtocol (
   FtwDevice->FtwLastWriteHeader = NULL;\r
   FtwDevice->FtwLastWriteRecord = NULL;\r
 \r
+  InitializeLocalWorkSpaceHeader ();\r
+\r
   //\r
   // Refresh the working space data from working block\r
   //\r
@@ -1184,10 +1204,11 @@ InitFtwProtocol (
     //\r
     // Read from spare block\r
     //\r
+    WorkSpaceLbaOffset = FtwDevice->FtwWorkSpaceLba - FtwDevice->FtwWorkBlockLba;\r
     Length = FtwDevice->FtwWorkSpaceSize;\r
     Status = FtwDevice->FtwBackupFvb->Read (\r
                     FtwDevice->FtwBackupFvb,\r
-                    FtwDevice->FtwSpareLba,\r
+                    FtwDevice->FtwSpareLba + WorkSpaceLbaOffset,\r
                     FtwDevice->FtwWorkSpaceBase,\r
                     &Length,\r
                     FtwDevice->FtwWorkSpace\r
@@ -1253,7 +1274,7 @@ InitFtwProtocol (
   FtwHeader = FtwDevice->FtwLastWriteHeader;\r
   Offset    = (UINT8 *) FtwHeader - FtwDevice->FtwWorkSpace;\r
   if (FtwDevice->FtwWorkSpace[Offset] != FTW_ERASED_BYTE) {\r
-    Offset += WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);\r
+    Offset += FTW_WRITE_TOTAL_SIZE (FtwHeader->NumberOfWrites, FtwHeader->PrivateDataSize);\r
   }\r
   \r
   if (!IsErasedFlashBuffer (FtwDevice->FtwWorkSpace + Offset, FtwDevice->FtwWorkSpaceSize - Offset)) {\r
@@ -1277,7 +1298,7 @@ InitFtwProtocol (
       // if (SpareCompleted) THEN  Restart to fault tolerant write.\r
       //\r
       FvbHandle = NULL;\r
-      FvbHandle = GetFvbByAddress (FtwDevice->FtwLastWriteRecord->FvBaseAddress, &Fvb);\r
+      FvbHandle = GetFvbByAddress ((EFI_PHYSICAL_ADDRESS) (UINTN) ((INT64) FtwDevice->SpareAreaAddress + FtwDevice->FtwLastWriteRecord->RelativeOffset), &Fvb);\r
       if (FvbHandle != NULL) {\r
         Status = FtwRestart (&FtwDevice->FtwInstance, FvbHandle);\r
         DEBUG ((EFI_D_ERROR, "FtwLite: Restart last write - %r\n", Status));\r