Clean up FaultTolerantWriteDxe for Doxygen comments requirement.

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

1 files changed, 52 insertions, 70 deletions

diff --git a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ipf/IpfFtwMisc.c b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ipf/IpfFtwMisc.c
index 20b7f566b9..e7087c8548 100644
--- a/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ipf/IpfFtwMisc.c
+++ b/MdeModulePkg/Universal/FirmwareVolume/FaultTolerantWriteDxe/Ipf/IpfFtwMisc.c
@@ -21,83 +21,69 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 //

 #define BOOT_BLOCK_BASE

 

-STATIC

+/**

+

+  Get swap state

+  This is a internal function.

+

+  @param FtwLiteDevice   Calling context

+  @param SwapState       Swap state

+

+  @retval  EFI_SUCCESS  State successfully got

+

+**/

 EFI_STATUS

 GetSwapState (

   IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice,

   OUT BOOLEAN               *SwapState

   )

-/*++

-

-Routine Description:

-

-  Get swap state

-

-Arguments:

+{

+  return EFI_SUCCESS;

+}

 

-  FtwLiteDevice - Calling context

-  SwapState     - Swap state

+/**

+  Set swap state.

+  This is a internal function.

 

-Returns:

 

-  EFI_SUCCESS - State successfully got

+  @param FtwLiteDevice   Indicates a pointer to the calling context.

+  @param TopSwap         New swap state

 

---*/

-{

-  return EFI_SUCCESS;

-}

+  @retval  EFI_SUCCESS    The function completed successfully

+                          Note:

+                          the Top-Swap bit (bit 13, D31: F0, Offset D4h). Note that

+                          software will not be able to clear the Top-Swap bit until the system is

+                          rebooted without GNT[A]# being pulled down.

 

-STATIC

+**/

 EFI_STATUS

 SetSwapState (

   IN EFI_FTW_LITE_DEVICE    *FtwLiteDevice,

   IN  BOOLEAN               TopSwap

   )

-/*++

+{

+  return EFI_SUCCESS;

+}

 

-Routine Description:

-    Set swap state.

+/**

 

-Arguments:

-    FtwLiteDevice  - Indicates a pointer to the calling context.  

-    TopSwap        - New swap state

+  Check whether the block is a boot block.

 

-Returns:

-    EFI_SUCCESS   - The function completed successfully

 

-Note:

-    the Top-Swap bit (bit 13, D31: F0, Offset D4h). Note that

-    software will not be able to clear the Top-Swap bit until the system is

-    rebooted without GNT[A]# being pulled down.

+  @param FtwLiteDevice   Calling context

+  @param FvBlock         Fvb protocol instance

+  @param Lba             Lba value

 

---*/

-{

-  return EFI_SUCCESS;

-}

+  @retval FALSE           This is a boot block.

+  @retval TRUE            This is not a boot block.

 

+**/

 BOOLEAN

 IsBootBlock (

   EFI_FTW_LITE_DEVICE                 *FtwLiteDevice,

   EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL  *FvBlock,

   EFI_LBA                             Lba

   )

-/*++

-

-Routine Description:

-

-  Check whether the block is a boot block.

-

-Arguments:

-

-  FtwLiteDevice - Calling context

-  FvBlock       - Fvb protocol instance

-  Lba           - Lba value

-

-Returns:

-

-  Is a boot block or not

-

---*/

 {

   //

   // IPF doesn't support safe bootblock update

@@ -106,30 +92,26 @@ Returns:
   return FALSE;

 }

 

-EFI_STATUS

-FlushSpareBlockToBootBlock (

-  EFI_FTW_LITE_DEVICE      *FtwLiteDevice

-  )

-/*++

-

-Routine Description:

-    Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.

-    Spare block is accessed by FTW backup FVB protocol interface. LBA is 

-    FtwLiteDevice->FtwSpareLba.

-    Boot block is accessed by BootFvb protocol interface. LBA is 0.

+/**

+  Copy the content of spare block to a boot block. Size is FTW_BLOCK_SIZE.

+  Spare block is accessed by FTW backup FVB protocol interface. LBA is

+  FtwLiteDevice->FtwSpareLba.

+  Boot block is accessed by BootFvb protocol interface. LBA is 0.

 

-Arguments:

-    FtwLiteDevice  - The private data of FTW_LITE driver

 

-Returns:

-    EFI_SUCCESS              - Spare block content is copied to boot block

-    EFI_INVALID_PARAMETER    - Input parameter error

-    EFI_OUT_OF_RESOURCES     - Allocate memory error

-    EFI_ABORTED              - The function could not complete successfully

+  @param FtwLiteDevice   The private data of FTW_LITE driver

 

-Notes:

+  @retval  EFI_SUCCESS               Spare block content is copied to boot block

+  @retval  EFI_INVALID_PARAMETER     Input parameter error

+  @retval  EFI_OUT_OF_RESOURCES      Allocate memory error

+  @retval  EFI_ABORTED               The function could not complete successfully

+                                     Notes:

 

---*/

+**/

+EFI_STATUS

+FlushSpareBlockToBootBlock (

+  EFI_FTW_LITE_DEVICE      *FtwLiteDevice

+  )

 {

   return EFI_SUCCESS;

 }