Fixed comments to follow coding standard.

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

5 files changed, 496 insertions, 541 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

diff --git a/MdePkg/Include/Library/GraphicsLib.h b/MdePkg/Include/Library/GraphicsLib.h
index b1b9898c14..f503561708 100644
--- a/MdePkg/Include/Library/GraphicsLib.h
+++ b/MdePkg/Include/Library/GraphicsLib.h
@@ -1,55 +1,65 @@
-/*++

+/** @file

+  Graphics Library

 

-Copyright (c) 2006, Intel Corporation                                                         

-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        

-http://opensource.org/licenses/bsd-license.php                                            

-                                                                                          

-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+  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        

+  http://opensource.org/licenses/bsd-license.php                                            

 

- 

---*/

+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     

+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             

+

+**/

 

 #ifndef __EFI_GRAPHICS_LIB_H__

 #define __EFI_GRAPHICS_LIB_H__

 

 #include <Protocol/GraphicsOutput.h>

 

+

+/**

+  Return the graphics image file named FileNameGuid into Image and return it's

+  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the

+  file name.

+
+  @param[in]  FileNameGuid  File Name of graphics file in the FV(s).
+  @param[out] Image         Pointer to pointer to return graphics image.  If NULL, a 

+                            buffer will be allocated.
+  @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.

+
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+  @retval   EFI_UNSUPPORTED        Range can not be erased

+  @retval   EFI_SUCCESS            Image and ImageSize are valid. 

+  @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size

+  @retval   EFI_NOT_FOUND          FileNameGuid not found

+
+**/

 EFI_STATUS

 GetGraphicsBitMapFromFV (

   IN  EFI_GUID      *FileNameGuid,

   OUT VOID          **Image,

   OUT UINTN         *ImageSize

-  )

-/*++

-

-Routine Description:

-

-  Return the graphics image file named FileNameGuid into Image and return it's

-  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the

-  file name.

-

-Arguments:

-

-  FileNameGuid  - File Name of graphics file in the FV(s).

-

-  Image         - Pointer to pointer to return graphics image.  If NULL, a 

-                  buffer will be allocated.

-

-  ImageSize     - Size of the graphics Image in bytes. Zero if no image found.

-

-

-Returns: 

-

-  EFI_SUCCESS          - Image and ImageSize are valid. 

-  EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size

-  EFI_NOT_FOUND        - FileNameGuid not found

+  );

 

---*/

-;

 

+/**

+  Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer

+  is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt

+  buffer is passed in it will be used if it is big enough.

+
+  @param[in]      BmpImage      Pointer to BMP file
+  @param[in]      BmpImageSize  Number of bytes in BmpImage
+  @param[in,out]  UgaBlt        Buffer containing UGA version of BmpImage.
+  @param[in,out]  UgaBltSize    Size of UgaBlt in bytes.
+  @param[out]     PixelHeight   Height of UgaBlt/BmpImage in pixels
+  @param[out]     PixelWidth    Width of UgaBlt/BmpImage in pixels
+
+  @retval EFI_SUCCESS           UgaBlt and UgaBltSize are returned. 

+  @retval EFI_UNSUPPORTED       BmpImage is not a valid *.BMP image

+  @retval EFI_BUFFER_TOO_SMALL  The passed in UgaBlt buffer is not big enough.

+                                UgaBltSize will contain the required size.
+**/

 EFI_STATUS

 ConvertBmpToUgaBlt (

   IN  VOID      *BmpImage,

@@ -58,113 +68,71 @@ ConvertBmpToUgaBlt (
   IN OUT UINTN  *UgaBltSize,

   OUT UINTN     *PixelHeight,

   OUT UINTN     *PixelWidth

-  )

-/*++

-

-Routine Description:

-

-  Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer

-  is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt

-  buffer is passed in it will be used if it is big enough.

-

-Arguments:

-

-  BmpImage      - Pointer to BMP file

-

-  BmpImageSize  - Number of bytes in BmpImage

-

-  UgaBlt        - Buffer containing UGA version of BmpImage.

-

-  UgaBltSize    - Size of UgaBlt in bytes.

-

-  PixelHeight   - Height of UgaBlt/BmpImage in pixels

-

-  PixelWidth    - Width of UgaBlt/BmpImage in pixels

-

-

-Returns: 

+  );

 

-  EFI_SUCCESS           - UgaBlt and UgaBltSize are returned. 

-  EFI_UNSUPPORTED       - BmpImage is not a valid *.BMP image

-  EFI_BUFFER_TOO_SMALL  - The passed in UgaBlt buffer is not big enough.

-                          UgaBltSize will contain the required size.

 

---*/

-;

+/**

+  Use Console Control to turn off UGA based Simple Text Out consoles from going

+  to the UGA device. Put up LogoFile on every UGA device that is a console

+
+  @param[in]  LogoFile   File name of logo to display on the center of the screen.
+
+  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.

+  @retval EFI_UNSUPPORTED Logo not found

 

+**/

 EFI_STATUS

 EnableQuietBoot (

   IN  EFI_GUID  *LogoFile

-  )

-/*++

-

-Routine Description:

-

-  Use Console Control to turn off UGA based Simple Text Out consoles from going

-  to the UGA device. Put up LogoFile on every UGA device that is a console

-

-Arguments:

-

-  LogoFile - File name of logo to display on the center of the screen.

-

+  );

 

-Returns: 

 

-  EFI_SUCCESS           - ConsoleControl has been flipped to graphics and logo

-                          displayed.

-  EFI_UNSUPPORTED       - Logo not found

-

---*/

-;

+/**

+  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA 

+  Simple Text Out screens will now be synced up with all non UGA output devices

+
+  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.

 

+**/

 EFI_STATUS

 DisableQuietBoot (

   VOID

-  )

-/*++

-

-Routine Description:

-

-  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA 

-  Simple Text Out screens will now be synced up with all non UGA output devices

+  );

 

-Arguments:

 

-  NONE

-

-Returns: 

-

-  EFI_SUCCESS           - UGA devices are back in text mode and synced up.

-  EFI_UNSUPPORTED       - Logo not found

-

---*/

-;

-

-EFI_STATUS

-LockKeyboards (

-  IN  CHAR16    *Password

-  )

-/*++

-

-Routine Description:

+/**

   Use Console Control Protocol to lock the Console In Spliter virtual handle. 

   This is the ConInHandle and ConIn handle in the EFI system table. All key

   presses will be ignored until the Password is typed in. The only way to

   disable the password is to type it in to a ConIn device.

+
+  @param[in]  Password   Password used to lock ConIn device.
+
+  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo

+                          displayed.

+  @retval EFI_UNSUPPORTED Password not found

 

-Arguments:

-  Password - Password used to lock ConIn device

-

-

-Returns: 

-

-  EFI_SUCCESS     - ConsoleControl has been flipped to graphics and logo

-                    displayed.

-  EFI_UNSUPPORTED - Logo not found

-

---*/

-;

-

+**/

+EFI_STATUS

+LockKeyboards (

+  IN  CHAR16    *Password

+  );

+

+

+/**

+  Print to graphics screen at the given X,Y coordinates of the graphics screen.
+  see definition of Print to find rules for constructing Fmt.
+
+  @param[in]  X            Row to start printing at
+  @param[in]  Y            Column to start printing at
+  @param[in]  Foreground   Foreground color
+  @param[in]  Background   background color
+  @param[in]  Fmt          Print format sting. See definition of Print
+  @param[in]  ...          Argumnet stream defined by Fmt string
+
+  @retval UINTN     Number of Characters printed

+

+**/

 UINTN

 EFIAPI

 PrintXY (

@@ -174,8 +142,7 @@ PrintXY (
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background, OPTIONAL

   IN CHAR16                           *Fmt,

   ...

-  )

-;

+  );

 

 

 #endif

diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h
index 5c2e60b008..607a67cef8 100644
--- a/MdePkg/Include/Library/ScsiLib.h
+++ b/MdePkg/Include/Library/ScsiLib.h
@@ -31,6 +31,35 @@
 //

 #define EfiScsiStallSeconds(a)  (a) * EFI_SCSI_STALL_1_SECOND

 

+

+/**
+  Function test the ready status of the SCSI unit.

+
+  @param[in]     ScsiIo             A pointer to SCSI IO protocol.
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[out]    SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+
+  @retval EFI_SUCCESS           The status of the unit is tested successfully.

+  @retval EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, 

+                                but the entire DataBuffer could not be transferred.

+                                The actual number of bytes transferred is returned

+                                in InTransferLength.

+  @retval EFI_NOT_READY         The SCSI Request Packet could not be sent because 

+                                there are too many SCSI Command Packets already 

+                                queued.

+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send 

+                                the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet

+                                is not supported by the SCSI initiator(i.e., SCSI 

+                                Host Controller).

+  @retval EFI_TIMEOUT           A timeout occurred while waiting for the SCSI 

+                                Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitTestUnitReadyCommand (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -39,29 +68,40 @@ SubmitTestUnitReadyCommand (
   OUT UINT8                 *SenseDataLength,

   OUT UINT8                 *HostAdapterStatus,

   OUT UINT8                 *TargetStatus

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

+  );

+

+

+/**
+  Function to submit SCSI inquiry command.

+
+  @param[in]     ScsiIo             SCSI IO Protocol to use
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+  @param[in,out] InquirydataBuffer  A pointer to inquiry data buffer.
+  @param[in,out] InquiryDataLength  The length of inquiry data buffer.
+  @param[in]     EnableVitalProductData  Boolean to enable Vital Product Data.
+
+  @retval EFI_SUCCESS         The status of the unit is tested successfully.

+  @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, 

+                              but the entire DataBuffer could not be transferred.

+                              The actual number of bytes transferred is returned

+                              in TransferLength.

+  @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because 

+                          there are too many SCSI Command Packets already 

+                          queued.

+  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send 

+                            the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet

+                          is not supported by the SCSI initiator(i.e., SCSI 

+                          Host Controller).

+  @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI 

+                          Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitInquiryCommand (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -73,32 +113,42 @@ SubmitInquiryCommand (
   IN OUT VOID               *InquiryDataBuffer,

   IN OUT UINT32             *InquiryDataLength,

   IN  BOOLEAN               EnableVitalProductData

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo                  - TODO: add argument description

-  Timeout                 - TODO: add argument description

-  SenseData               - TODO: add argument description

-  SenseDataLength         - TODO: add argument description

-  HostAdapterStatus       - TODO: add argument description

-  TargetStatus            - TODO: add argument description

-  InquiryDataBuffer       - TODO: add argument description

-  InquiryDataLength       - TODO: add argument description

-  EnableVitalProductData  - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

+  );

+

+

+/**
+  Function to submit SCSI mode sense 10 command.

+
+  @param[in]     ScsiIo             A pointer to SCSI IO protocol.
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+  @param[in]     DataBuffer         A pointer to input data buffer.
+  @param[in,out] DataLength         The length of input data buffer.
+  @param[in]     DBDField           The DBD Field (Optional).
+  @param[in]     PageControl        Page Control.
+  @param[in]     PageCode           Page code.
+
+  @retval EFI_SUCCESS               The status of the unit is tested successfully.

+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, 

+                                    but the entire DataBuffer could not be transferred.

+                                    The actual number of bytes transferred is returned

+                                    in TransferLength.

+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because 

+                                    there are too many SCSI Command Packets already 

+                                    queued.

+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send 

+                                    the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet

+                                    is not supported by the SCSI initiator(i.e., SCSI 

+                                    Host Controller).

+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI 

+                                    Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitModeSense10Command (

   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,

@@ -112,34 +162,45 @@ SubmitModeSense10Command (
   IN  UINT8                   DBDField, OPTIONAL

   IN  UINT8                   PageControl,

   IN  UINT8                   PageCode

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-  DataBuffer        - TODO: add argument description

-  DataLength        - TODO: add argument description

-  DBDField          - TODO: add argument description

-  PageControl       - TODO: add argument description

-  PageCode          - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

+  );

+

+

+

+/**
+  Function to submit SCSI request sense command.

+  ScsiIo               - A pointer to SCSI IO protocol.

+  Timeout              - The length of timeout period.

+  SenseData            - A pointer to output sense data.

+  SenseDataLength      - The length of output sense data.

+  HostAdapterStatus    - The status of Host Adapter.

+  TargetStatus         - The status of the target.

+
+  @param[in]     ScsiIo             SCSI IO Protocol to use
+  @param[in]     Timeout            TODO:
+  @param[out]    SenseData          TODO:
+  @param[in,out] SenseDataLength    TODO:
+  @param[out]    HostAdapterStatus  TODO:
+  @param[out]    TargetStatus       TODO:
+
+  @retval EFI_SUCCESS        Valid data returned
+  @retval EFI_SUCCESS        The status of the unit is tested successfully.

+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, 

+                                    but the entire DataBuffer could not be transferred.

+                                    The actual number of bytes transferred is returned

+                                    in TransferLength.

+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because 

+                                    there are too many SCSI Command Packets already 

+                                    queued.

+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send 

+                                    the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet

+                                    is not supported by the SCSI initiator(i.e., SCSI 

+                                    Host Controller).

+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI 

+                                    Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitRequestSenseCommand (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -148,32 +209,40 @@ SubmitRequestSenseCommand (
   IN OUT UINT8              *SenseDataLength,

   OUT UINT8                 *HostAdapterStatus,

   OUT UINT8                 *TargetStatus

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

-//

-// Commands for direct access command

-//

+  );

+

+

+/**
+  Function to submit read capacity command.

+

+  @param[in]     ScsiIo             A pointer to SCSI IO protocol.
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+  @param[out]    DataBuffer         A pointer to a data buffer.
+  @param[in,out] DataLength         The length of data buffer.
+  @param[in]     PMI                Partial medium indicator.
+
+  @retval  EFI_SUCCESS                The status of the unit is tested successfully.

+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, 

+                                      but the entire DataBuffer could not be transferred.

+                                      The actual number of bytes transferred is returned

+                                      in TransferLength.

+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because 

+                                      there are too many SCSI Command Packets already 

+                                      queued.

+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send 

+                                      the SCSI Request Packet.

+  @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid.  

+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet

+                                      is not supported by the SCSI initiator(i.e., SCSI 

+                                      Host Controller).

+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI 

+                                      Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitReadCapacityCommand (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -185,32 +254,41 @@ SubmitReadCapacityCommand (
   OUT VOID                  *DataBuffer,

   IN OUT UINT32             *DataLength,

   IN  BOOLEAN               PMI

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-  DataBuffer        - TODO: add argument description

-  DataLength        - TODO: add argument description

-  PMI               - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

+  );

+

+

+/**
+  Function to submit read 10 command.

+
+  @param[in]     ScsiIo             A pointer to SCSI IO protocol.
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+  @param[out]    DataBuffer         Read 10 command data.
+  @param[in,out] DataLength         The length of data buffer.
+  @param[in]     StartLba           The start address of LBA.
+  @param[in]     SectorSize         The sector size.
+
+  @retval EFI_SUCCESS               The status of the unit is tested successfully.

+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, 

+                                    but the entire DataBuffer could not be transferred.

+                                    The actual number of bytes transferred is returned

+                                    in TransferLength.

+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because 

+                                    there are too many SCSI Command Packets already 

+                                    queued.

+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send 

+                                    the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet

+                                    is not supported by the SCSI initiator(i.e., SCSI 

+                                    Host Controller).

+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI 

+                                    Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitRead10Command (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -223,33 +301,41 @@ SubmitRead10Command (
   IN OUT UINT32             *DataLength,

   IN  UINT32                StartLba,

   IN  UINT32                SectorSize

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-  DataBuffer        - TODO: add argument description

-  DataLength        - TODO: add argument description

-  StartLba          - TODO: add argument description

-  SectorSize        - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

-

---*/

-;

-

+  );

+

+

+/**
+  Function to submit SCSI write 10 command.

+
+  @param[in]     ScsiIo             SCSI IO Protocol to use
+  @param[in]     Timeout            The length of timeout period.
+  @param[out]    SenseData          A pointer to output sense data.
+  @param[in,out] SenseDataLength    The length of output sense data.
+  @param[out]    HostAdapterStatus  The status of Host Adapter.
+  @param[out]    TargetStatus       The status of the target.
+  @param[out]    DataBuffer         A pointer to a data buffer.
+  @param[in,out] DataLength         The length of data buffer.
+  @param[in]     StartLba           The start address of LBA.
+  @param[in]     SectorSize         The sector size.
+
+  @retval EFI_SUCCESS               The status of the unit is tested successfully.

+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, 

+                                    but the entire DataBuffer could not be transferred.

+                                    The actual number of bytes transferred is returned

+                                    in InTransferLength.

+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because 

+                                    there are too many SCSI Command Packets already 

+                                    queued.

+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send 

+                                    the SCSI Request Packet.

+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  

+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet

+                                    is not supported by the SCSI initiator(i.e., SCSI 

+                                    Host Controller).

+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI 

+                                    Request Packet to execute.

+
+**/

 EFI_STATUS

 SubmitWrite10Command (

   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,

@@ -262,31 +348,7 @@ SubmitWrite10Command (
   IN OUT UINT32             *DataLength,

   IN  UINT32                StartLba,

   IN  UINT32                SectorSize

-  )

-/*++

-

-Routine Description:

-

-  TODO: Add function description

-

-Arguments:

-

-  ScsiIo            - TODO: add argument description

-  Timeout           - TODO: add argument description

-  SenseData         - TODO: add argument description

-  SenseDataLength   - TODO: add argument description

-  HostAdapterStatus - TODO: add argument description

-  TargetStatus      - TODO: add argument description

-  DataBuffer        - TODO: add argument description

-  DataLength        - TODO: add argument description

-  StartLba          - TODO: add argument description

-  SectorSize        - TODO: add argument description

-

-Returns:

-

-  TODO: add return values

+  );

 

---*/

-;

 

 #endif

diff --git a/MdePkg/Include/Library/UefiRuntimeLib.h b/MdePkg/Include/Library/UefiRuntimeLib.h
index 09abf0ceb1..99b4110215 100644
--- a/MdePkg/Include/Library/UefiRuntimeLib.h
+++ b/MdePkg/Include/Library/UefiRuntimeLib.h
@@ -142,8 +142,7 @@ EfiGetVariable (
   OUT     UINT32                   *Attributes,

   IN OUT  UINTN                    *DataSize,

   OUT     VOID                     *Data

-  )

-;

+  );

 

 /**

   Enumerates variable's name.

@@ -280,7 +279,7 @@ EfiSetVirtualAddressMap (
 

 

 /**

-  Conver the standard Lib double linked list to a virtual mapping.

+  Convert the standard Lib double linked list to a virtual mapping.

 

   @param  DebugDisposition   Supplies type information for the pointer being converted.

   @param  ListHead           Head of linked list to convert.

@@ -297,7 +296,6 @@ EfiConvertList (
   );

 

 /**

-

   Passes capsules to the firmware with both virtual and physical mapping.

   Depending on the intended consumption, the firmware may

   process the capsule immediately. If the payload should persist across a

@@ -339,7 +337,6 @@ EfiUpdateCapsule (
 

 

 /**

-

   The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or

   capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and

   size of the entire capsule is checked.

@@ -381,7 +378,6 @@ EfiQueryCapsuleCapabilities (
 

 

 /**

-

   The QueryVariableInfo() function allows a caller to obtain the information about the

   maximum size of the storage space available for the EFI variables, the remaining size of the storage

   space available for the EFI variables and the maximum size of each individual EFI variable,

diff --git a/MdePkg/Include/Protocol/UgaIo.h b/MdePkg/Include/Protocol/UgaIo.h
index ebe0a1b589..02654051af 100644
--- a/MdePkg/Include/Protocol/UgaIo.h
+++ b/MdePkg/Include/Protocol/UgaIo.h
@@ -94,49 +94,51 @@ typedef struct {
   OUT VOID                *pvOutBuffer;

   IN UINT64               ui64OutBufferSize;

   OUT UINT64              ui64BytesReturned;

-}

-UGA_IO_REQUEST, *PUGA_IO_REQUEST;

+} UGA_IO_REQUEST, *PUGA_IO_REQUEST;

+

+

+/**
+  Dynamically allocate storage for a child UGA_DEVICE .

+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is 

+                                 defined in Section 10.7.
+  @param[in]     ParentDevice    ParentDevice specifies a pointer to the parent device of Device.
+  @param[in]     DeviceData      A pointer to UGA_DEVICE_DATA returned from a call to DispatchService()

+                                 with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.      
+  @param[in]     RunTimeContext  Context to associate with Device.  
+  @param[out]    Device          The Device returns a dynamically allocated child UGA_DEVICE object

+                                 for ParentDevice. The caller is responsible for deleting Device.
+
+                                 

+  @retval  EFI_SUCCESS           Device was returned.

+  @retval  EFI_INVALID_PARAMETER One of the arguments was not valid.

+  @retval  EFI_DEVICE_ERROR      The device had an error and could not complete the request.

 

+**/

 typedef

 EFI_STATUS

 (EFIAPI *EFI_UGA_IO_PROTOCOL_CREATE_DEVICE) (

-  IN  EFI_UGA_IO_PROTOCOL  * This,

-  IN  UGA_DEVICE           * ParentDevice,

-  IN  UGA_DEVICE_DATA      * DeviceData,

+  IN  EFI_UGA_IO_PROTOCOL  *This,

+  IN  UGA_DEVICE           *ParentDevice,

+  IN  UGA_DEVICE_DATA      *DeviceData,

   IN  VOID                 *RunTimeContext,

   OUT UGA_DEVICE           **Device

   );

 

-/*++

-

-  Routine Description:

-

-    Dynamically allocate storage for a child UGA_DEVICE .

-

-  Arguments:

-

-    This           - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is 

-                     defined in Section 10.7.

-

-    ParentDevice   - ParentDevice specifies a pointer to the parent device of Device.

-

-    DeviceData     - A pointer to UGA_DEVICE_DATA returned from a call to DispatchService()

-                     with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.

-

-    RuntimeContext - Context to associate with Device.

-

-    Device         - The Device returns a dynamically allocated child UGA_DEVICE object

-                     for ParentDevice. The caller is responsible for deleting Device.

-      

-  Returns:

-

-    EFI_SUCCESS           - Device was returned.

 

-    EFI_INVALID_PARAMETER - One of the arguments was not valid.

+/**
+  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .

+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is 

+                                 defined in Section 10.7.
+  @param[in]     Device          The Device points to a UGA_DEVICE object that was dynamically

+                                 allocated via a CreateDevice() call.

+
+                                 

+  @retval  EFI_SUCCESS           Device was returned.

+  @retval  EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice().

 

-    EFI_DEVICE_ERROR      - The device had an error and could not complete the request.

-

---*/

+**/

 typedef

 EFI_STATUS

 (EFIAPI *EFI_UGA_IO_PROTOCOL_DELETE_DEVICE) (

@@ -144,31 +146,10 @@ EFI_STATUS
   IN UGA_DEVICE           * Device

   );

 

-/*++

-

-  Routine Description:

-

-    Delete a dynamically allocated child UGA_DEVICE object that was allocated via

-    CreateDevice() .

-

-  Arguments:

-

-    This   - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined 

-             in Section 10.7.

-

-    Device - The Device points to a UGA_DEVICE object that was dynamically

-             allocated via a CreateDevice() call.

-

-  Returns:

 

-    EFI_SUCCESS           - Device was deleted.

-

-    EFI_INVALID_PARAMETER - The Device was not allocated via CreateDevice()

-

---*/

 typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, IN OUT PUGA_IO_REQUEST pIoRequest);

 

-/*++

+/**

 

   Routine Description:

 

@@ -190,7 +171,7 @@ typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, I
 

   Varies depending on pIoRequest.

 

---*/

+**/

 struct _EFI_UGA_IO_PROTOCOL {

   EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice;

   EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;