Clean up FaultTolerantWriteDxe for Doxygen comments requirement.

[mirror_edk2.git] / MdeModulePkg / Universal / FirmwareVolume / FaultTolerantWriteDxe / x64 / x64FtwMisc.c

diff --git a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/x64/x64FtwMisc.c b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/x64/x64FtwMisc.c
index b782b2042d8e0b0d0d0892390c964224f5a19d5c..0474d78546ad56c6ffed2597577493e9649fe5c8 100644 (file)
--- a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/x64/x64FtwMisc.c
+++ b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/x64/x64FtwMisc.c
@@ -1,4 +1,4 @@
-/** \r
+/** @file\r
   \r
   X64 platform related code to support FtwLite.\r
   \r
@@ -21,111 +21,92 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //\r
 #define BOOT_BLOCK_BASE\r
 \r
-// STATIC\r
+/**\r
+\r
+  Get swap state.\r
+\r
+\r
+  @param FtwLiteDevice   Calling context\r
+  @param SwapState       Swap state\r
+\r
+  @retval  EFI_SUCCESS  State successfully read.\r
+\r
+**/\r
 EFI_STATUS\r
 GetSwapState (\r
   IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice,\r
   OUT BOOLEAN               *SwapState\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Get swap state\r
-\r
-Arguments:\r
+{\r
+  return EFI_SUCCESS;\r
+}\r
 \r
-  FtwLiteDevice - Calling context\r
-  SwapState     - Swap state\r
+/**\r
+  Set swap state.\r
 \r
-Returns:\r
 \r
-  EFI_SUCCESS - State successfully got\r
+  @param FtwLiteDevice   Indicates a pointer to the calling context.\r
+  @param TopSwap         New swap state\r
 \r
---*/\r
-{\r
-  return EFI_SUCCESS;\r
-}\r
+  @retval  EFI_SUCCESS    The function completed successfully\r
+                          Note:\r
+                          the Top-Swap bit (bit 13, D31: F0, Offset D4h). Note that\r
+                          software will not be able to clear the Top-Swap bit until the system is\r
+                          rebooted without GNT[A]# being pulled down.\r
 \r
-// STATIC\r
+**/\r
 EFI_STATUS\r
 SetSwapState (\r
   IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice,\r
   IN  BOOLEAN               TopSwap\r
   )\r
-/*++\r
+{\r
+  return EFI_SUCCESS;\r
+}\r
 \r
-Routine Description:\r
-    Set swap state.\r
+/**\r
 \r
-Arguments:\r
-    FtwLiteDevice  - Indicates a pointer to the calling context.  \r
-    TopSwap        - New swap state\r
+  Check whether the block is a boot block.\r
 \r
-Returns:\r
-    EFI_SUCCESS   - The function completed successfully\r
 \r
-Note:\r
-    the Top-Swap bit (bit 13, D31: F0, Offset D4h). Note that\r
-    software will not be able to clear the Top-Swap bit until the system is\r
-    rebooted without GNT[A]# being pulled down.\r
+  @param FtwLiteDevice   Calling context\r
+  @param FvBlock         Fvb protocol instance\r
+  @param Lba             Lba value\r
 \r
---*/\r
-{\r
-  return EFI_SUCCESS;\r
-}\r
+  @retval FALSE           This is a boot block.\r
+  @retval TRUE            This is not a boot block.\r
 \r
+**/\r
 BOOLEAN\r
 IsBootBlock (\r
   EFI_FTW_LITE_DEVICE                 *FtwLiteDevice,\r
   EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,\r
   EFI_LBA                             Lba\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Check whether the block is a boot block.\r
-\r
-Arguments:\r
+{\r
+  return FALSE;\r
+}\r
 \r
-  FtwLiteDevice - Calling context\r
-  FvBlock       - Fvb protocol instance\r
-  Lba           - Lba value\r
+/**\r
+  Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.\r
+  Spare block is accessed by FTW backup FVB protocol interface. LBA is\r
+  FtwLiteDevice->FtwSpareLba.\r
+  Boot block is accessed by BootFvb protocol interface. LBA is 0.\r
 \r
-Returns:\r
 \r
-  Is a boot block or not\r
+  @param FtwLiteDevice   The private data of FTW_LITE driver\r
 \r
---*/\r
-{\r
-  return FALSE;\r
-}\r
+  @retval  EFI_SUCCESS               Spare block content is copied to boot block\r
+  @retval  EFI_INVALID_PARAMETER     Input parameter error\r
+  @retval  EFI_OUT_OF_RESOURCES      Allocate memory error\r
+  @retval  EFI_ABORTED               The function could not complete successfully\r
+                                     Notes:\r
 \r
+**/\r
 EFI_STATUS\r
 FlushSpareBlockToBootBlock (\r
   EFI_FTW_LITE_DEVICE      *FtwLiteDevice\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-    Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.\r
-    Spare block is accessed by FTW backup FVB protocol interface. LBA is \r
-    FtwLiteDevice->FtwSpareLba.\r
-    Boot block is accessed by BootFvb protocol interface. LBA is 0.\r
-\r
-Arguments:\r
-    FtwLiteDevice  - The private data of FTW_LITE driver\r
-\r
-Returns:\r
-    EFI_SUCCESS              - Spare block content is copied to boot block\r
-    EFI_INVALID_PARAMETER    - Input parameter error\r
-    EFI_OUT_OF_RESOURCES     - Allocate memory error\r
-    EFI_ABORTED              - The function could not complete successfully\r
-\r
-Notes:\r
-\r
---*/\r
 {\r
   return EFI_SUCCESS;\r
 }\r