Fixed comments to follow coding standard.

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

1 files changed, 120 insertions, 171 deletions

diff --git a/MdePkg/Include/Library/FvbServiceLib.h b/MdePkg/Include/Library/FvbServiceLib.h
index cfd5063deb..27b0f08822 100644
--- a/MdePkg/Include/Library/FvbServiceLib.h
+++ b/MdePkg/Include/Library/FvbServiceLib.h
@@ -1,7 +1,7 @@
 /** @file

   Firmeware Volume BLock Service Library

 

-  Copyright (c) 2006 - 2007, Intel Corporation

+  Copyright (c) 2006 - 2007, Intel Corporation.<BR>

   All rights reserved. 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        

@@ -15,6 +15,22 @@
 #ifndef __EDK_FVB_SERVICE_LIB_H__

 #define __EDK_FVB_SERVICE_LIB_H__

 

+/**
+  Reads specified number of bytes into a buffer from the specified block

+
+  @param[in]     Instance    The FV instance to be read from
+  @param[in]     Lba         The logical block address to be read from
+  @param[in]     Offset      Offset into the block at which to begin reading
+  @param[in,out] NumBytes    Pointer that on input contains the total size of

+                             the buffer. On output, it contains the total number

+                             of bytes read
+  @param[in]     Buffer      Pointer to a caller allocated buffer that will be

+                             used to hold the data read
+
+  @retval   EFI_EFI_SUCCESS        Buffer contains data read from FVB
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbReadBlock (

   IN UINTN                                        Instance,

@@ -22,31 +38,25 @@ EfiFvbReadBlock (
   IN UINTN                                        Offset,

   IN OUT UINTN                                    *NumBytes,

   IN UINT8                                        *Buffer

-  )

-/*++

-

-Routine Description:

-  Reads specified number of bytes into a buffer from the specified block

-

-Arguments:

-  Instance              - The FV instance to be read from

-  Lba                   - The logical block address to be read from

-  Offset                - Offset into the block at which to begin reading

-  NumBytes              - Pointer that on input contains the total size of

-                          the buffer. On output, it contains the total number

-                          of bytes read

-  Buffer                - Pointer to a caller allocated buffer that will be

-                          used to hold the data read

-

-Returns: 

-

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

+  );

 

---*/

-;

 

+/**
+  Writes specified number of bytes from the input buffer to the block

+
+  @param[in]     Instance    The FV instance to be read from
+  @param[in]     Lba         The logical block address to be write to 
+  @param[in]     Offset      Offset into the block at which to begin writing
+  @param[in,out] NumBytes    Pointer that on input contains the total size of

+                             the buffer. On output, it contains the total number

+                             of bytes actually written.
+  @param[in]     Buffer      Pointer to a caller allocated buffer that contains

+                             the source for the write
+
+  @retval   EFI_EFI_SUCCESS        Buffer written to FVB
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbWriteBlock (

   IN UINTN                                        Instance,

@@ -54,163 +64,125 @@ EfiFvbWriteBlock (
   IN UINTN                                        Offset,

   IN OUT UINTN                                    *NumBytes,

   IN UINT8                                        *Buffer

-  )

-/*++

-

-Routine Description:

-  Writes specified number of bytes from the input buffer to the block

-

-Arguments:

-  Instance              - The FV instance to be written to

-  Lba                   - The starting logical block index to write to

-  Offset                - Offset into the block at which to begin writing

-  NumBytes              - Pointer that on input contains the total size of

-                          the buffer. On output, it contains the total number

-                          of bytes actually written

-  Buffer                - Pointer to a caller allocated buffer that contains

-                          the source for the write

-

-Returns: 

+  );

 

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

-

---*/

-;

 

+/**
+  Erases and initializes a firmware volume block

+
+  @param[in]     Instance    The FV instance to be erased
+  @param[in]     Lba         The logical block address to be erased
+
+  @retval   EFI_EFI_SUCCESS        Lba was erased
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbEraseBlock (

   IN UINTN                                Instance,

   IN EFI_LBA                              Lba

-  )

-/*++

-

-Routine Description:

-  Erases and initializes a firmware volume block

-

-Arguments:

-  Instance              - The FV instance to be erased

-  Lba                   - The logical block index to be erased

-  

-Returns: 

-

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

+  );

 

---*/

-;

 

+/**
+  Retrieves attributes, insures positive polarity of attribute bits, returns

+  resulting attributes in output parameter

+
+  @param[in]     Instance    The FV instance
+  @param[out]    Attributes  The FV instance whose attributes is going to be 

+                             returned
+
+  @retval   EFI_EFI_SUCCESS        Valid Attributes were returned 
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbGetVolumeAttributes (

   IN UINTN                                Instance,

   OUT EFI_FVB_ATTRIBUTES                  *Attributes

-  )

-/*++

-

-Routine Description:

-  Retrieves attributes, insures positive polarity of attribute bits, returns

-  resulting attributes in output parameter

+  );

 

-Arguments:

-  Instance              - The FV instance whose attributes is going to be 

-                          returned

-  Attributes            - Output buffer which contains attributes

-

-Returns: 

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

-

---*/

-;

 

+/**
+  Modifies the current settings of the firmware volume according to the 

+  input parameter, and returns the new setting of the volume

+
+  @param[in]     Instance    The FV instance
+  @param[in]     Attributes  On input, it is a pointer to EFI_FVB_ATTRIBUTES 

+                             containing the desired firmware volume settings.

+                             On successful return, it contains the new settings

+                             of the firmware volume
+
+  @retval   EFI_EFI_SUCCESS        Attributes were updated
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbSetVolumeAttributes (

   IN UINTN                                Instance,

   IN EFI_FVB_ATTRIBUTES                   Attributes

-  )

-/*++

+  );

 

-Routine Description:

-  Modifies the current settings of the firmware volume according to the 

-  input parameter, and returns the new setting of the volume

-

-Arguments:

-  Instance              - The FV instance whose attributes is going to be 

-                          modified

-  Attributes            - On input, it is a pointer to EFI_FVB_ATTRIBUTES 

-                          containing the desired firmware volume settings.

-                          On successful return, it contains the new settings

-                          of the firmware volume

-

-Returns: 

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

-

---*/

-;

 

+/**
+  Retrieves the physical address of a memory mapped FV

+
+  @param[in]     Instance    The FV instance
+  @param[out]    BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS 

+                             that on successful return, contains the base address

+                             of the firmware volume. 
+
+  @retval   EFI_EFI_SUCCESS        BaseAddress was returned
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbGetPhysicalAddress (

   IN UINTN                                Instance,

   OUT EFI_PHYSICAL_ADDRESS                *BaseAddress

-  )

-/*++

-

-Routine Description:

-  Retrieves the physical address of a memory mapped FV

-

-Arguments:

-  Instance              - The FV instance whose base address is going to be

-                          returned

-  BaseAddress           - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS 

-                          that on successful return, contains the base address

-                          of the firmware volume. 

-

-Returns: 

-

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

+  );

 

---*/

-;

 

+/**
+  Retrieve the size of a logical block

+
+  @param[in]     Instance    The FV instance
+  @param[in]     Lba         Indicates which block to return the size for.
+  @param[out]    BlockSizze  A pointer to a caller allocated UINTN in which

+                             the size of the block is returned
+  @param[out]    NumOfBlocks a pointer to a caller allocated UINTN in which the

+                             number of consecutive blocks starting with Lba is

+                             returned. All blocks in this range have a size of

+                             BlockSize
+
+  @retval   EFI_EFI_SUCCESS        BlockSize  and NumOfBlocks returned
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/

 EFI_STATUS

 EfiFvbGetBlockSize (

   IN UINTN                                        Instance,

   IN EFI_LBA                                      Lba,

   OUT UINTN                                       *BlockSize,

   OUT UINTN                                       *NumOfBlocks

-  )

-/*++

+  );

 

-Routine Description:

-  Retrieve the size of a logical block

-

-Arguments:

-  Instance              - The FV instance whose block size is going to be

-                          returned

-  Lba                   - Indicates which block to return the size for.

-  BlockSize             - A pointer to a caller allocated UINTN in which

-                          the size of the block is returned

-  NumOfBlocks           - a pointer to a caller allocated UINTN in which the

-                          number of consecutive blocks starting with Lba is

-                          returned. All blocks in this range have a size of

-                          BlockSize

-

-Returns: 

-  EFI_SUCCESS           - The firmware volume was read successfully and 

-                          contents are in Buffer

-                          

-  EFI_INVALID_PARAMETER - invalid parameter

-

---*/

-;

 

+/**
+  Erases and initializes a specified range of a firmware volume

+
+  @param[in]     Instance       The FV instance
+  @param[in]     StartLba       The starting logical block index to be erased
+  @param[in]     OffsetStartLba Offset into the starting block at which to 

+                                begin erasing    
+  @param[in]     LastLba        The last logical block index to be erased
+  @param[in]     OffsetLastLba  Offset into the last block at which to end erasing     
+
+  @retval   EFI_EFI_SUCCESS        Range was erased 
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+  @retval   EFI_UNSUPPORTED        Range can not be erased

+
+**/

 EFI_STATUS

 EfiFvbEraseCustomBlockRange (

   IN UINTN                                Instance,

@@ -218,29 +190,6 @@ EfiFvbEraseCustomBlockRange (
   IN UINTN                                OffsetStartLba,

   IN EFI_LBA                              LastLba,

   IN UINTN                                OffsetLastLba

-  )

-/*++

-

-Routine Description:

-  Erases and initializes a specified range of a firmware volume

-

-Arguments:

-  Instance              - The FV instance to be erased

-  StartLba              - The starting logical block index to be erased

-  OffsetStartLba        - Offset into the starting block at which to 

-                          begin erasing

-  LastLba               - The last logical block index to be erased

-  OffsetLastLba         - Offset into the last block at which to end erasing

-

-Returns: 

-

-  Status code

-  

-  EFI_INVALID_PARAMETER - invalid parameter

-  

-  EFI_UNSUPPORTED       - not support

-  

---*/

-;

+  );

 

 #endif