]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Universal/FaultTolerantWriteDxe/FaultTolerantWriteSmmDxe.c
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Universal / FaultTolerantWriteDxe / FaultTolerantWriteSmmDxe.c
index 772d10dcd46cb18e6965c1743bf39156a62f72ca..259e9365f4831b60e029fe0676326bbd1ba38524 100644 (file)
@@ -1,16 +1,16 @@
 /** @file\r
 \r
-  Implement the Fault Tolerant Write (FTW) protocol based on SMM FTW \r
+  Implement the Fault Tolerant Write (FTW) protocol based on SMM FTW\r
   module.\r
 \r
-Copyright (c) 2011 - 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
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2011 - 2018, 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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -46,28 +46,28 @@ InitCommunicateBuffer (
   IN      UINTN                             Function\r
   )\r
 {\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
-  SMM_FTW_COMMUNICATE_FUNCTION_HEADER       *SmmFtwFunctionHeader; \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
+  SMM_FTW_COMMUNICATE_FUNCTION_HEADER       *SmmFtwFunctionHeader;\r
 \r
   //\r
   // The whole buffer size: SMM_COMMUNICATE_HEADER_SIZE + SMM_FTW_COMMUNICATE_HEADER_SIZE + DataSize.\r
   //\r
   SmmCommunicateHeader = AllocateZeroPool (DataSize + SMM_COMMUNICATE_HEADER_SIZE + SMM_FTW_COMMUNICATE_HEADER_SIZE);\r
   ASSERT (SmmCommunicateHeader != NULL);\r
-   \r
+\r
   //\r
   // Prepare data buffer.\r
   //\r
   CopyGuid (&SmmCommunicateHeader->HeaderGuid, &gEfiSmmFaultTolerantWriteProtocolGuid);\r
   SmmCommunicateHeader->MessageLength = DataSize + SMM_FTW_COMMUNICATE_HEADER_SIZE;\r
\r
+\r
   SmmFtwFunctionHeader = (SMM_FTW_COMMUNICATE_FUNCTION_HEADER *) SmmCommunicateHeader->Data;\r
   SmmFtwFunctionHeader->Function = Function;\r
 \r
   *CommunicateBuffer = SmmCommunicateHeader;\r
   if (DataPtr != NULL) {\r
     *DataPtr = SmmFtwFunctionHeader->Data;\r
-  }  \r
+  }\r
 }\r
 \r
 \r
@@ -76,7 +76,7 @@ InitCommunicateBuffer (
 \r
   @param[in, out]  SmmCommunicateHeader    The communicate buffer.\r
   @param[in]       DataSize                The payload size.\r
-                      \r
+\r
 **/\r
 EFI_STATUS\r
 SendCommunicateBuffer (\r
@@ -86,8 +86,8 @@ SendCommunicateBuffer (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     CommSize;\r
-  SMM_FTW_COMMUNICATE_FUNCTION_HEADER       *SmmFtwFunctionHeader; \r
\r
+  SMM_FTW_COMMUNICATE_FUNCTION_HEADER       *SmmFtwFunctionHeader;\r
+\r
   CommSize = DataSize + SMM_COMMUNICATE_HEADER_SIZE + SMM_FTW_COMMUNICATE_HEADER_SIZE;\r
   Status = mSmmCommunication->Communicate (mSmmCommunication, SmmCommunicateHeader, &CommSize);\r
   ASSERT_EFI_ERROR (Status);\r
@@ -103,7 +103,7 @@ SendCommunicateBuffer (
   @param[in]   FvbHandle         The handle of FVB protocol that provides services.\r
   @param[out]  FvbBaseAddress    The base address of the FVB attached with FvbHandle.\r
   @param[out]  FvbAttributes     The attributes of the FVB attached with FvbHandle.\r
-    \r
+\r
   @retval EFI_SUCCESS            The function completed successfully.\r
   @retval Others                 The function could not complete successfully.\r
 \r
@@ -122,14 +122,14 @@ ConvertFvbHandle (
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
-  \r
+\r
   Status = Fvb->GetPhysicalAddress (Fvb, FvbBaseAddress);\r
   if (EFI_ERROR (Status)) {\r
     return Status;\r
   }\r
 \r
   Status = Fvb->GetAttributes (Fvb, FvbAttributes);\r
-  return Status;  \r
+  return Status;\r
 }\r
 \r
 \r
@@ -154,7 +154,7 @@ FtwGetMaxBlockSize (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     PayloadSize;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
   SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER         *SmmFtwBlockSizeHeader;\r
 \r
   //\r
@@ -162,7 +162,7 @@ FtwGetMaxBlockSize (
   //\r
   PayloadSize  = sizeof (SMM_FTW_GET_MAX_BLOCK_SIZE_HEADER);\r
   InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, (VOID **)&SmmFtwBlockSizeHeader, PayloadSize, FTW_FUNCTION_GET_MAX_BLOCK_SIZE);\r
-    \r
+\r
   //\r
   // Send data to SMM.\r
   //\r
@@ -171,9 +171,9 @@ FtwGetMaxBlockSize (
   //\r
   // Get data from SMM\r
   //\r
-  *BlockSize = SmmFtwBlockSizeHeader->BlockSize; \r
+  *BlockSize = SmmFtwBlockSizeHeader->BlockSize;\r
   FreePool (SmmCommunicateHeader);\r
-  \r
+\r
   return Status;\r
 }\r
 \r
@@ -210,7 +210,7 @@ FtwAllocate (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     PayloadSize;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
   SMM_FTW_ALLOCATE_HEADER                   *SmmFtwAllocateHeader;\r
 \r
   //\r
@@ -220,8 +220,8 @@ FtwAllocate (
   InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, (VOID **)&SmmFtwAllocateHeader, PayloadSize, FTW_FUNCTION_ALLOCATE);\r
   CopyGuid (&SmmFtwAllocateHeader->CallerId, CallerId);\r
   SmmFtwAllocateHeader->PrivateDataSize = PrivateDataSize;\r
-  SmmFtwAllocateHeader->NumberOfWrites  = NumberOfWrites; \r
-    \r
+  SmmFtwAllocateHeader->NumberOfWrites  = NumberOfWrites;\r
+\r
   //\r
   // Send data to SMM.\r
   //\r
@@ -276,7 +276,7 @@ FtwWrite (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     PayloadSize;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
   SMM_FTW_WRITE_HEADER                      *SmmFtwWriteHeader;\r
 \r
   //\r
@@ -292,7 +292,7 @@ FtwWrite (
   InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, (VOID **)&SmmFtwWriteHeader, PayloadSize, FTW_FUNCTION_WRITE);\r
 \r
   //\r
-  // FvBlockHandle can not be used in SMM environment. Here we get the FVB protocol first, then get FVB base address \r
+  // FvBlockHandle can not be used in SMM environment. Here we get the FVB protocol first, then get FVB base address\r
   // and its attribute. Send these information to SMM handler, the SMM handler will find the proper FVB to write data.\r
   //\r
   Status = ConvertFvbHandle (FvBlockHandle, &SmmFtwWriteHeader->FvbBaseAddress, &SmmFtwWriteHeader->FvbAttributes);\r
@@ -300,9 +300,9 @@ FtwWrite (
     FreePool (SmmCommunicateHeader);\r
     return EFI_ABORTED;\r
   }\r
-  \r
+\r
   SmmFtwWriteHeader->Lba    = Lba;\r
-  SmmFtwWriteHeader->Offset = Offset; \r
+  SmmFtwWriteHeader->Offset = Offset;\r
   SmmFtwWriteHeader->Length = Length;\r
   CopyMem (SmmFtwWriteHeader->Data, Buffer, Length);\r
   if (PrivateData == NULL) {\r
@@ -316,7 +316,7 @@ FtwWrite (
   // Send data to SMM.\r
   //\r
   Status = SendCommunicateBuffer (SmmCommunicateHeader, PayloadSize);\r
-  FreePool (SmmCommunicateHeader);  \r
+  FreePool (SmmCommunicateHeader);\r
   return Status;\r
 }\r
 \r
@@ -342,22 +342,22 @@ FtwRestart (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     PayloadSize;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
   SMM_FTW_RESTART_HEADER                    *SmmFtwRestartHeader;\r
\r
+\r
   //\r
   // Initialize the communicate buffer.\r
   //\r
   PayloadSize  = sizeof (SMM_FTW_RESTART_HEADER);\r
-  InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, (VOID **)&SmmFtwRestartHeader, PayloadSize, FTW_FUNCTION_RESTART); \r
+  InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, (VOID **)&SmmFtwRestartHeader, PayloadSize, FTW_FUNCTION_RESTART);\r
 \r
   //\r
-  // FvBlockHandle can not be used in SMM environment. Here we get the FVB protocol first, then get FVB base address \r
+  // FvBlockHandle can not be used in SMM environment. Here we get the FVB protocol first, then get FVB base address\r
   // and its attribute. Send these information to SMM handler, the SMM handler will find the proper FVB to write data.\r
   //\r
   Status = ConvertFvbHandle (FvBlockHandle, &SmmFtwRestartHeader->FvbBaseAddress, &SmmFtwRestartHeader->FvbAttributes);\r
   if (EFI_ERROR (Status)) {\r
-    FreePool (SmmCommunicateHeader); \r
+    FreePool (SmmCommunicateHeader);\r
     return EFI_ABORTED;\r
   }\r
 \r
@@ -365,7 +365,7 @@ FtwRestart (
   // Send data to SMM.\r
   //\r
   Status = SendCommunicateBuffer (SmmCommunicateHeader, PayloadSize);\r
-  FreePool (SmmCommunicateHeader);  \r
+  FreePool (SmmCommunicateHeader);\r
   return Status;\r
 }\r
 \r
@@ -387,19 +387,19 @@ FtwAbort (
   )\r
 {\r
   EFI_STATUS                                Status;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
\r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
+\r
   //\r
   // Initialize the communicate buffer.\r
   //\r
   InitCommunicateBuffer ((VOID **)&SmmCommunicateHeader, NULL, 0, FTW_FUNCTION_ABORT);\r
\r
+\r
   //\r
   // Send data to SMM.\r
   //\r
   Status = SendCommunicateBuffer (SmmCommunicateHeader, 0);\r
 \r
-  FreePool (SmmCommunicateHeader);  \r
+  FreePool (SmmCommunicateHeader);\r
   return Status;\r
 }\r
 \r
@@ -444,7 +444,7 @@ FtwGetLastWrite (
 {\r
   EFI_STATUS                                Status;\r
   UINTN                                     PayloadSize;\r
-  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;  \r
+  EFI_SMM_COMMUNICATE_HEADER                *SmmCommunicateHeader;\r
   SMM_FTW_GET_LAST_WRITE_HEADER             *SmmFtwGetLastWriteHeader;\r
 \r
   //\r
@@ -465,7 +465,7 @@ FtwGetLastWrite (
   *PrivateDataSize = SmmFtwGetLastWriteHeader->PrivateDataSize;\r
   if (Status == EFI_SUCCESS || Status == EFI_BUFFER_TOO_SMALL) {\r
     *Lba      = SmmFtwGetLastWriteHeader->Lba;\r
-    *Offset   = SmmFtwGetLastWriteHeader->Offset; \r
+    *Offset   = SmmFtwGetLastWriteHeader->Offset;\r
     *Length   = SmmFtwGetLastWriteHeader->Length;\r
     *Complete = SmmFtwGetLastWriteHeader->Complete;\r
     CopyGuid (CallerId, &SmmFtwGetLastWriteHeader->CallerId);\r
@@ -476,7 +476,7 @@ FtwGetLastWrite (
     *Complete = SmmFtwGetLastWriteHeader->Complete;\r
   }\r
 \r
-  FreePool (SmmCommunicateHeader);  \r
+  FreePool (SmmCommunicateHeader);\r
   return Status;\r
 }\r
 \r
@@ -501,12 +501,12 @@ SmmFtwReady (
   //\r
   // Just return to avoid install SMM FaultTolerantWriteProtocol again\r
   // if Fault Tolerant Write protocol had been installed.\r
-  //  \r
+  //\r
   Status = gBS->LocateProtocol (&gEfiFaultTolerantWriteProtocolGuid, NULL, (VOID **)&FtwProtocol);\r
   if (!EFI_ERROR (Status)) {\r
     return;\r
   }\r
-  \r
+\r
   Status = gBS->LocateProtocol (&gEfiSmmCommunicationProtocolGuid, NULL, (VOID **) &mSmmCommunication);\r
   ASSERT_EFI_ERROR (Status);\r
 \r
@@ -520,9 +520,9 @@ SmmFtwReady (
                   &mFaultTolerantWriteDriver\r
                   );\r
   ASSERT_EFI_ERROR (Status);\r
-  \r
+\r
   Status = gBS->CloseEvent (Event);\r
-  ASSERT_EFI_ERROR (Status);  \r
+  ASSERT_EFI_ERROR (Status);\r
 }\r
 \r
 \r
@@ -551,12 +551,12 @@ FaultTolerantWriteSmmInitialize (
   //\r
   EfiCreateProtocolNotifyEvent (\r
     &gEfiSmmFaultTolerantWriteProtocolGuid,\r
-    TPL_CALLBACK, \r
-    SmmFtwReady, \r
-    NULL, \r
+    TPL_CALLBACK,\r
+    SmmFtwReady,\r
+    NULL,\r
     &SmmFtwRegistration\r
     );\r
-  \r
+\r
   return EFI_SUCCESS;\r
 }\r
 \r