Fixed comments to follow coding standard.
authorAJFISH <AJFISH@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 13 Jul 2007 03:21:40 +0000 (03:21 +0000)
committerAJFISH <AJFISH@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 13 Jul 2007 03:21:40 +0000 (03:21 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@3221 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/FvbServiceLib.h
MdePkg/Include/Library/GraphicsLib.h
MdePkg/Include/Library/ScsiLib.h
MdePkg/Include/Library/UefiRuntimeLib.h
MdePkg/Include/Protocol/UgaIo.h
MdePkg/Library/BaseCustomDecompressLibNull/BaseCustomDecompressLibNull.c
MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
MdePkg/Library/PeiServicesTablePointerLibKr7/PeiServicesTablePointer.c
MdePkg/Library/UefiRuntimeLib/RuntimeService.c
MdePkg/Library/UefiScsiLib/UefiScsiLib.c

index cfd5063..27b0f08 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Firmeware Volume BLock Service Library\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
   All rights reserved. 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
 #ifndef __EDK_FVB_SERVICE_LIB_H__\r
 #define __EDK_FVB_SERVICE_LIB_H__\r
 \r
+/**
+  Reads specified number of bytes into a buffer from the specified block\r
+
+  @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\r
+                             the buffer. On output, it contains the total number\r
+                             of bytes read
+  @param[in]     Buffer      Pointer to a caller allocated buffer that will be\r
+                             used to hold the data read
+
+  @retval   EFI_EFI_SUCCESS        Buffer contains data read from FVB
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbReadBlock (\r
   IN UINTN                                        Instance,\r
@@ -22,31 +38,25 @@ EfiFvbReadBlock (
   IN UINTN                                        Offset,\r
   IN OUT UINTN                                    *NumBytes,\r
   IN UINT8                                        *Buffer\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Reads specified number of bytes into a buffer from the specified block\r
-\r
-Arguments:\r
-  Instance              - The FV instance to be read from\r
-  Lba                   - The logical block address to be read from\r
-  Offset                - Offset into the block at which to begin reading\r
-  NumBytes              - Pointer that on input contains the total size of\r
-                          the buffer. On output, it contains the total number\r
-                          of bytes read\r
-  Buffer                - Pointer to a caller allocated buffer that will be\r
-                          used to hold the data read\r
-\r
-Returns: \r
-\r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
+  );\r
 \r
---*/\r
-;\r
 \r
+/**
+  Writes specified number of bytes from the input buffer to the block\r
+
+  @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\r
+                             the buffer. On output, it contains the total number\r
+                             of bytes actually written.
+  @param[in]     Buffer      Pointer to a caller allocated buffer that contains\r
+                             the source for the write
+
+  @retval   EFI_EFI_SUCCESS        Buffer written to FVB
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbWriteBlock (\r
   IN UINTN                                        Instance,\r
@@ -54,163 +64,125 @@ EfiFvbWriteBlock (
   IN UINTN                                        Offset,\r
   IN OUT UINTN                                    *NumBytes,\r
   IN UINT8                                        *Buffer\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Writes specified number of bytes from the input buffer to the block\r
-\r
-Arguments:\r
-  Instance              - The FV instance to be written to\r
-  Lba                   - The starting logical block index to write to\r
-  Offset                - Offset into the block at which to begin writing\r
-  NumBytes              - Pointer that on input contains the total size of\r
-                          the buffer. On output, it contains the total number\r
-                          of bytes actually written\r
-  Buffer                - Pointer to a caller allocated buffer that contains\r
-                          the source for the write\r
-\r
-Returns: \r
+  );\r
 \r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
-\r
---*/\r
-;\r
 \r
+/**
+  Erases and initializes a firmware volume block\r
+
+  @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
+
+**/\r
 EFI_STATUS\r
 EfiFvbEraseBlock (\r
   IN UINTN                                Instance,\r
   IN EFI_LBA                              Lba\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Erases and initializes a firmware volume block\r
-\r
-Arguments:\r
-  Instance              - The FV instance to be erased\r
-  Lba                   - The logical block index to be erased\r
-  \r
-Returns: \r
-\r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
+  );\r
 \r
---*/\r
-;\r
 \r
+/**
+  Retrieves attributes, insures positive polarity of attribute bits, returns\r
+  resulting attributes in output parameter\r
+
+  @param[in]     Instance    The FV instance
+  @param[out]    Attributes  The FV instance whose attributes is going to be \r
+                             returned
+
+  @retval   EFI_EFI_SUCCESS        Valid Attributes were returned 
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbGetVolumeAttributes (\r
   IN UINTN                                Instance,\r
   OUT EFI_FVB_ATTRIBUTES                  *Attributes\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Retrieves attributes, insures positive polarity of attribute bits, returns\r
-  resulting attributes in output parameter\r
+  );\r
 \r
-Arguments:\r
-  Instance              - The FV instance whose attributes is going to be \r
-                          returned\r
-  Attributes            - Output buffer which contains attributes\r
-\r
-Returns: \r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
-\r
---*/\r
-;\r
 \r
+/**
+  Modifies the current settings of the firmware volume according to the \r
+  input parameter, and returns the new setting of the volume\r
+
+  @param[in]     Instance    The FV instance
+  @param[in]     Attributes  On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
+                             containing the desired firmware volume settings.\r
+                             On successful return, it contains the new settings\r
+                             of the firmware volume
+
+  @retval   EFI_EFI_SUCCESS        Attributes were updated
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbSetVolumeAttributes (\r
   IN UINTN                                Instance,\r
   IN EFI_FVB_ATTRIBUTES                   Attributes\r
-  )\r
-/*++\r
+  );\r
 \r
-Routine Description:\r
-  Modifies the current settings of the firmware volume according to the \r
-  input parameter, and returns the new setting of the volume\r
-\r
-Arguments:\r
-  Instance              - The FV instance whose attributes is going to be \r
-                          modified\r
-  Attributes            - On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
-                          containing the desired firmware volume settings.\r
-                          On successful return, it contains the new settings\r
-                          of the firmware volume\r
-\r
-Returns: \r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
-\r
---*/\r
-;\r
 \r
+/**
+  Retrieves the physical address of a memory mapped FV\r
+
+  @param[in]     Instance    The FV instance
+  @param[out]    BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
+                             that on successful return, contains the base address\r
+                             of the firmware volume. 
+
+  @retval   EFI_EFI_SUCCESS        BaseAddress was returned
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbGetPhysicalAddress (\r
   IN UINTN                                Instance,\r
   OUT EFI_PHYSICAL_ADDRESS                *BaseAddress\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Retrieves the physical address of a memory mapped FV\r
-\r
-Arguments:\r
-  Instance              - The FV instance whose base address is going to be\r
-                          returned\r
-  BaseAddress           - Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
-                          that on successful return, contains the base address\r
-                          of the firmware volume. \r
-\r
-Returns: \r
-\r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
+  );\r
 \r
---*/\r
-;\r
 \r
+/**
+  Retrieve the size of a logical block\r
+
+  @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\r
+                             the size of the block is returned
+  @param[out]    NumOfBlocks a pointer to a caller allocated UINTN in which the\r
+                             number of consecutive blocks starting with Lba is\r
+                             returned. All blocks in this range have a size of\r
+                             BlockSize
+
+  @retval   EFI_EFI_SUCCESS        BlockSize  and NumOfBlocks returned
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+
+**/\r
 EFI_STATUS\r
 EfiFvbGetBlockSize (\r
   IN UINTN                                        Instance,\r
   IN EFI_LBA                                      Lba,\r
   OUT UINTN                                       *BlockSize,\r
   OUT UINTN                                       *NumOfBlocks\r
-  )\r
-/*++\r
+  );\r
 \r
-Routine Description:\r
-  Retrieve the size of a logical block\r
-\r
-Arguments:\r
-  Instance              - The FV instance whose block size is going to be\r
-                          returned\r
-  Lba                   - Indicates which block to return the size for.\r
-  BlockSize             - A pointer to a caller allocated UINTN in which\r
-                          the size of the block is returned\r
-  NumOfBlocks           - a pointer to a caller allocated UINTN in which the\r
-                          number of consecutive blocks starting with Lba is\r
-                          returned. All blocks in this range have a size of\r
-                          BlockSize\r
-\r
-Returns: \r
-  EFI_SUCCESS           - The firmware volume was read successfully and \r
-                          contents are in Buffer\r
-                          \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
-\r
---*/\r
-;\r
 \r
+/**
+  Erases and initializes a specified range of a firmware volume\r
+
+  @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 \r
+                                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\r
+
+**/\r
 EFI_STATUS\r
 EfiFvbEraseCustomBlockRange (\r
   IN UINTN                                Instance,\r
@@ -218,29 +190,6 @@ EfiFvbEraseCustomBlockRange (
   IN UINTN                                OffsetStartLba,\r
   IN EFI_LBA                              LastLba,\r
   IN UINTN                                OffsetLastLba\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-  Erases and initializes a specified range of a firmware volume\r
-\r
-Arguments:\r
-  Instance              - The FV instance to be erased\r
-  StartLba              - The starting logical block index to be erased\r
-  OffsetStartLba        - Offset into the starting block at which to \r
-                          begin erasing\r
-  LastLba               - The last logical block index to be erased\r
-  OffsetLastLba         - Offset into the last block at which to end erasing\r
-\r
-Returns: \r
-\r
-  Status code\r
-  \r
-  EFI_INVALID_PARAMETER - invalid parameter\r
-  \r
-  EFI_UNSUPPORTED       - not support\r
-  \r
---*/\r
-;\r
+  );\r
 \r
 #endif\r
index b1b9898..f503561 100644 (file)
@@ -1,55 +1,65 @@
-/*++\r
+/** @file\r
+  Graphics Library\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. 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) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
\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
 #ifndef __EFI_GRAPHICS_LIB_H__\r
 #define __EFI_GRAPHICS_LIB_H__\r
 \r
 #include <Protocol/GraphicsOutput.h>\r
 \r
+\r
+/**\r
+  Return the graphics image file named FileNameGuid into Image and return it's\r
+  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
+  file name.\r
+
+  @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 \r
+                            buffer will be allocated.
+  @param[out] ImageSize     Size of the graphics Image in bytes. Zero if no image found.\r
+
+  @retval   EFI_INVALID_PARAMETER  invalid parameter
+  @retval   EFI_UNSUPPORTED        Range can not be erased\r
+  @retval   EFI_SUCCESS            Image and ImageSize are valid. \r
+  @retval   EFI_BUFFER_TOO_SMALL   Image not big enough. ImageSize has required size\r
+  @retval   EFI_NOT_FOUND          FileNameGuid not found\r
+
+**/\r
 EFI_STATUS\r
 GetGraphicsBitMapFromFV (\r
   IN  EFI_GUID      *FileNameGuid,\r
   OUT VOID          **Image,\r
   OUT UINTN         *ImageSize\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Return the graphics image file named FileNameGuid into Image and return it's\r
-  size in ImageSize. All Firmware Volumes (FV) in the system are searched for the\r
-  file name.\r
-\r
-Arguments:\r
-\r
-  FileNameGuid  - File Name of graphics file in the FV(s).\r
-\r
-  Image         - Pointer to pointer to return graphics image.  If NULL, a \r
-                  buffer will be allocated.\r
-\r
-  ImageSize     - Size of the graphics Image in bytes. Zero if no image found.\r
-\r
-\r
-Returns: \r
-\r
-  EFI_SUCCESS          - Image and ImageSize are valid. \r
-  EFI_BUFFER_TOO_SMALL - Image not big enough. ImageSize has required size\r
-  EFI_NOT_FOUND        - FileNameGuid not found\r
+  );\r
 \r
---*/\r
-;\r
 \r
+/**\r
+  Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer\r
+  is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt\r
+  buffer is passed in it will be used if it is big enough.\r
+
+  @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. \r
+  @retval EFI_UNSUPPORTED       BmpImage is not a valid *.BMP image\r
+  @retval EFI_BUFFER_TOO_SMALL  The passed in UgaBlt buffer is not big enough.\r
+                                UgaBltSize will contain the required size.
+**/\r
 EFI_STATUS\r
 ConvertBmpToUgaBlt (\r
   IN  VOID      *BmpImage,\r
@@ -58,113 +68,71 @@ ConvertBmpToUgaBlt (
   IN OUT UINTN  *UgaBltSize,\r
   OUT UINTN     *PixelHeight,\r
   OUT UINTN     *PixelWidth\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Convert a *.BMP graphics image to a UGA blt buffer. If a NULL UgaBlt buffer\r
-  is passed in a UgaBlt buffer will be allocated by this routine. If a UgaBlt\r
-  buffer is passed in it will be used if it is big enough.\r
-\r
-Arguments:\r
-\r
-  BmpImage      - Pointer to BMP file\r
-\r
-  BmpImageSize  - Number of bytes in BmpImage\r
-\r
-  UgaBlt        - Buffer containing UGA version of BmpImage.\r
-\r
-  UgaBltSize    - Size of UgaBlt in bytes.\r
-\r
-  PixelHeight   - Height of UgaBlt/BmpImage in pixels\r
-\r
-  PixelWidth    - Width of UgaBlt/BmpImage in pixels\r
-\r
-\r
-Returns: \r
+  );\r
 \r
-  EFI_SUCCESS           - UgaBlt and UgaBltSize are returned. \r
-  EFI_UNSUPPORTED       - BmpImage is not a valid *.BMP image\r
-  EFI_BUFFER_TOO_SMALL  - The passed in UgaBlt buffer is not big enough.\r
-                          UgaBltSize will contain the required size.\r
 \r
---*/\r
-;\r
+/**\r
+  Use Console Control to turn off UGA based Simple Text Out consoles from going\r
+  to the UGA device. Put up LogoFile on every UGA device that is a console\r
+
+  @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.\r
+  @retval EFI_UNSUPPORTED Logo not found\r
 \r
+**/\r
 EFI_STATUS\r
 EnableQuietBoot (\r
   IN  EFI_GUID  *LogoFile\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Use Console Control to turn off UGA based Simple Text Out consoles from going\r
-  to the UGA device. Put up LogoFile on every UGA device that is a console\r
-\r
-Arguments:\r
-\r
-  LogoFile - File name of logo to display on the center of the screen.\r
-\r
+  );\r
 \r
-Returns: \r
 \r
-  EFI_SUCCESS           - ConsoleControl has been flipped to graphics and logo\r
-                          displayed.\r
-  EFI_UNSUPPORTED       - Logo not found\r
-\r
---*/\r
-;\r
+/**\r
+  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
+  Simple Text Out screens will now be synced up with all non UGA output devices\r
+
+  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
 \r
+**/\r
 EFI_STATUS\r
 DisableQuietBoot (\r
   VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
-  Simple Text Out screens will now be synced up with all non UGA output devices\r
+  );\r
 \r
-Arguments:\r
 \r
-  NONE\r
-\r
-Returns: \r
-\r
-  EFI_SUCCESS           - UGA devices are back in text mode and synced up.\r
-  EFI_UNSUPPORTED       - Logo not found\r
-\r
---*/\r
-;\r
-\r
-EFI_STATUS\r
-LockKeyboards (\r
-  IN  CHAR16    *Password\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Use Console Control Protocol to lock the Console In Spliter virtual handle. \r
   This is the ConInHandle and ConIn handle in the EFI system table. All key\r
   presses will be ignored until the Password is typed in. The only way to\r
   disable the password is to type it in to a ConIn device.\r
+
+  @param[in]  Password   Password used to lock ConIn device.
+
+  @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo\r
+                          displayed.\r
+  @retval EFI_UNSUPPORTED Password not found\r
 \r
-Arguments:\r
-  Password - Password used to lock ConIn device\r
-\r
-\r
-Returns: \r
-\r
-  EFI_SUCCESS     - ConsoleControl has been flipped to graphics and logo\r
-                    displayed.\r
-  EFI_UNSUPPORTED - Logo not found\r
-\r
---*/\r
-;\r
-\r
+**/\r
+EFI_STATUS\r
+LockKeyboards (\r
+  IN  CHAR16    *Password\r
+  );\r
+\r
+\r
+/**\r
+  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\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 PrintXY (\r
@@ -174,8 +142,7 @@ PrintXY (
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL    *Background, OPTIONAL\r
   IN CHAR16                           *Fmt,\r
   ...\r
-  )\r
-;\r
+  );\r
 \r
 \r
 #endif\r
index 5c2e60b..607a67c 100644 (file)
 //\r
 #define EfiScsiStallSeconds(a)  (a) * EFI_SCSI_STALL_1_SECOND\r
 \r
+\r
+/**
+  Function test the ready status of the SCSI unit.\r
+
+  @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.\r
+  @retval EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, \r
+                                but the entire DataBuffer could not be transferred.\r
+                                The actual number of bytes transferred is returned\r
+                                in InTransferLength.\r
+  @retval EFI_NOT_READY         The SCSI Request Packet could not be sent because \r
+                                there are too many SCSI Command Packets already \r
+                                queued.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send \r
+                                the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet\r
+                                is not supported by the SCSI initiator(i.e., SCSI \r
+                                Host Controller).\r
+  @retval EFI_TIMEOUT           A timeout occurred while waiting for the SCSI \r
+                                Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitTestUnitReadyCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -39,29 +68,40 @@ SubmitTestUnitReadyCommand (
   OUT UINT8                 *SenseDataLength,\r
   OUT UINT8                 *HostAdapterStatus,\r
   OUT UINT8                 *TargetStatus\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
+  );\r
+\r
+\r
+/**
+  Function to submit SCSI inquiry command.\r
+
+  @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.\r
+  @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
+                              but the entire DataBuffer could not be transferred.\r
+                              The actual number of bytes transferred is returned\r
+                              in TransferLength.\r
+  @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because \r
+                          there are too many SCSI Command Packets already \r
+                          queued.\r
+  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send \r
+                            the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
+                          is not supported by the SCSI initiator(i.e., SCSI \r
+                          Host Controller).\r
+  @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI \r
+                          Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitInquiryCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -73,32 +113,42 @@ SubmitInquiryCommand (
   IN OUT VOID               *InquiryDataBuffer,\r
   IN OUT UINT32             *InquiryDataLength,\r
   IN  BOOLEAN               EnableVitalProductData\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo                  - TODO: add argument description\r
-  Timeout                 - TODO: add argument description\r
-  SenseData               - TODO: add argument description\r
-  SenseDataLength         - TODO: add argument description\r
-  HostAdapterStatus       - TODO: add argument description\r
-  TargetStatus            - TODO: add argument description\r
-  InquiryDataBuffer       - TODO: add argument description\r
-  InquiryDataLength       - TODO: add argument description\r
-  EnableVitalProductData  - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
+  );\r
+\r
+\r
+/**
+  Function to submit SCSI mode sense 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitModeSense10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,\r
@@ -112,34 +162,45 @@ SubmitModeSense10Command (
   IN  UINT8                   DBDField, OPTIONAL\r
   IN  UINT8                   PageControl,\r
   IN  UINT8                   PageCode\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-  DataBuffer        - TODO: add argument description\r
-  DataLength        - TODO: add argument description\r
-  DBDField          - TODO: add argument description\r
-  PageControl       - TODO: add argument description\r
-  PageCode          - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
+  );\r
+\r
+\r
+\r
+/**
+  Function to submit SCSI request sense command.\r
+  ScsiIo               - A pointer to SCSI IO protocol.\r
+  Timeout              - The length of timeout period.\r
+  SenseData            - A pointer to output sense data.\r
+  SenseDataLength      - The length of output sense data.\r
+  HostAdapterStatus    - The status of Host Adapter.\r
+  TargetStatus         - The status of the target.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitRequestSenseCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -148,32 +209,40 @@ SubmitRequestSenseCommand (
   IN OUT UINT8              *SenseDataLength,\r
   OUT UINT8                 *HostAdapterStatus,\r
   OUT UINT8                 *TargetStatus\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
-//\r
-// Commands for direct access command\r
-//\r
+  );\r
+\r
+\r
+/**
+  Function to submit read capacity command.\r
+\r
+  @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.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, \r
+                                      but the entire DataBuffer could not be transferred.\r
+                                      The actual number of bytes transferred is returned\r
+                                      in TransferLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
+                                      there are too many SCSI Command Packets already \r
+                                      queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
+                                      the SCSI Request Packet.\r
+  @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid.  \r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
+                                      is not supported by the SCSI initiator(i.e., SCSI \r
+                                      Host Controller).\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
+                                      Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitReadCapacityCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -185,32 +254,41 @@ SubmitReadCapacityCommand (
   OUT VOID                  *DataBuffer,\r
   IN OUT UINT32             *DataLength,\r
   IN  BOOLEAN               PMI\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-  DataBuffer        - TODO: add argument description\r
-  DataLength        - TODO: add argument description\r
-  PMI               - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
+  );\r
+\r
+\r
+/**
+  Function to submit read 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitRead10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -223,33 +301,41 @@ SubmitRead10Command (
   IN OUT UINT32             *DataLength,\r
   IN  UINT32                StartLba,\r
   IN  UINT32                SectorSize\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-  DataBuffer        - TODO: add argument description\r
-  DataLength        - TODO: add argument description\r
-  StartLba          - TODO: add argument description\r
-  SectorSize        - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
-;\r
-\r
+  );\r
+\r
+\r
+/**
+  Function to submit SCSI write 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in InTransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitWrite10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -262,31 +348,7 @@ SubmitWrite10Command (
   IN OUT UINT32             *DataLength,\r
   IN  UINT32                StartLba,\r
   IN  UINT32                SectorSize\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  ScsiIo            - TODO: add argument description\r
-  Timeout           - TODO: add argument description\r
-  SenseData         - TODO: add argument description\r
-  SenseDataLength   - TODO: add argument description\r
-  HostAdapterStatus - TODO: add argument description\r
-  TargetStatus      - TODO: add argument description\r
-  DataBuffer        - TODO: add argument description\r
-  DataLength        - TODO: add argument description\r
-  StartLba          - TODO: add argument description\r
-  SectorSize        - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
+  );\r
 \r
---*/\r
-;\r
 \r
 #endif\r
index 09abf0c..99b4110 100644 (file)
@@ -142,8 +142,7 @@ EfiGetVariable (
   OUT     UINT32                   *Attributes,\r
   IN OUT  UINTN                    *DataSize,\r
   OUT     VOID                     *Data\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Enumerates variable's name.\r
@@ -280,7 +279,7 @@ EfiSetVirtualAddressMap (
 \r
 \r
 /**\r
-  Conver the standard Lib double linked list to a virtual mapping.\r
+  Convert the standard Lib double linked list to a virtual mapping.\r
 \r
   @param  DebugDisposition   Supplies type information for the pointer being converted.\r
   @param  ListHead           Head of linked list to convert.\r
@@ -297,7 +296,6 @@ EfiConvertList (
   );\r
 \r
 /**\r
-\r
   Passes capsules to the firmware with both virtual and physical mapping.\r
   Depending on the intended consumption, the firmware may\r
   process the capsule immediately. If the payload should persist across a\r
@@ -339,7 +337,6 @@ EfiUpdateCapsule (
 \r
 \r
 /**\r
-\r
   The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r
   capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r
   size of the entire capsule is checked.\r
@@ -381,7 +378,6 @@ EfiQueryCapsuleCapabilities (
 \r
 \r
 /**\r
-\r
   The QueryVariableInfo() function allows a caller to obtain the information about the\r
   maximum size of the storage space available for the EFI variables, the remaining size of the storage\r
   space available for the EFI variables and the maximum size of each individual EFI variable,\r
index ebe0a1b..0265405 100644 (file)
@@ -94,49 +94,51 @@ typedef struct {
   OUT VOID                *pvOutBuffer;\r
   IN UINT64               ui64OutBufferSize;\r
   OUT UINT64              ui64BytesReturned;\r
-}\r
-UGA_IO_REQUEST, *PUGA_IO_REQUEST;\r
+} UGA_IO_REQUEST, *PUGA_IO_REQUEST;\r
+\r
+\r
+/**
+  Dynamically allocate storage for a child UGA_DEVICE .\r
+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
+                                 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()\r
+                                 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\r
+                                 for ParentDevice. The caller is responsible for deleting Device.
+
+                                 \r
+  @retval  EFI_SUCCESS           Device was returned.\r
+  @retval  EFI_INVALID_PARAMETER One of the arguments was not valid.\r
+  @retval  EFI_DEVICE_ERROR      The device had an error and could not complete the request.\r
 \r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_IO_PROTOCOL_CREATE_DEVICE) (\r
-  IN  EFI_UGA_IO_PROTOCOL  * This,\r
-  IN  UGA_DEVICE           * ParentDevice,\r
-  IN  UGA_DEVICE_DATA      * DeviceData,\r
+  IN  EFI_UGA_IO_PROTOCOL  *This,\r
+  IN  UGA_DEVICE           *ParentDevice,\r
+  IN  UGA_DEVICE_DATA      *DeviceData,\r
   IN  VOID                 *RunTimeContext,\r
   OUT UGA_DEVICE           **Device\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-\r
-    Dynamically allocate storage for a child UGA_DEVICE .\r
-\r
-  Arguments:\r
-\r
-    This           - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
-                     defined in Section 10.7.\r
-\r
-    ParentDevice   - ParentDevice specifies a pointer to the parent device of Device.\r
-\r
-    DeviceData     - A pointer to UGA_DEVICE_DATA returned from a call to DispatchService()\r
-                     with a UGA_DEVICE of Parent and an IoRequest of type UgaIoGetChildDevice.\r
-\r
-    RuntimeContext - Context to associate with Device.\r
-\r
-    Device         - The Device returns a dynamically allocated child UGA_DEVICE object\r
-                     for ParentDevice. The caller is responsible for deleting Device.\r
-      \r
-  Returns:\r
-\r
-    EFI_SUCCESS           - Device was returned.\r
 \r
-    EFI_INVALID_PARAMETER - One of the arguments was not valid.\r
+/**
+  Delete a dynamically allocated child UGA_DEVICE object that was allocated via CreateDevice() .\r
+
+  @param[in]     This            The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is \r
+                                 defined in Section 10.7.
+  @param[in]     Device          The Device points to a UGA_DEVICE object that was dynamically\r
+                                 allocated via a CreateDevice() call.\r
+
+                                 \r
+  @retval  EFI_SUCCESS           Device was returned.\r
+  @retval  EFI_INVALID_PARAMETER The Device was not allocated via CreateDevice().\r
 \r
-    EFI_DEVICE_ERROR      - The device had an error and could not complete the request.\r
-\r
---*/\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_UGA_IO_PROTOCOL_DELETE_DEVICE) (\r
@@ -144,31 +146,10 @@ EFI_STATUS
   IN UGA_DEVICE           * Device\r
   );\r
 \r
-/*++\r
-\r
-  Routine Description:\r
-\r
-    Delete a dynamically allocated child UGA_DEVICE object that was allocated via\r
-    CreateDevice() .\r
-\r
-  Arguments:\r
-\r
-    This   - The EFI_UGA_IO_PROTOCOL instance. Type EFI_UGA_IO_PROTOCOL is defined \r
-             in Section 10.7.\r
-\r
-    Device - The Device points to a UGA_DEVICE object that was dynamically\r
-             allocated via a CreateDevice() call.\r
-\r
-  Returns:\r
 \r
-    EFI_SUCCESS           - Device was deleted.\r
-\r
-    EFI_INVALID_PARAMETER - The Device was not allocated via CreateDevice()\r
-\r
---*/\r
 typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, IN OUT PUGA_IO_REQUEST pIoRequest);\r
 \r
-/*++\r
+/**\r
 \r
   Routine Description:\r
 \r
@@ -190,7 +171,7 @@ typedef UGA_STATUS (EFIAPI *PUGA_FW_SERVICE_DISPATCH) (IN PUGA_DEVICE pDevice, I
 \r
   Varies depending on pIoRequest.\r
 \r
---*/\r
+**/\r
 struct _EFI_UGA_IO_PROTOCOL {\r
   EFI_UGA_IO_PROTOCOL_CREATE_DEVICE CreateDevice;\r
   EFI_UGA_IO_PROTOCOL_DELETE_DEVICE DeleteDevice;\r
index 7f59a10..669f937 100644 (file)
@@ -1,21 +1,33 @@
-/*++\r
+/** @file\r
+  Null implementation of the custom decompress library\r
 \r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. 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) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
 \r
 #include <Base.h>\r
 #include <Library/CustomDecompressLib.h>\r
 \r
 \r
+/**
+  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r
+
+  @param[in]     Source           The source buffer containing the compressed data.
+  @param[in]     SourceSize       The size of source buffer
+  @param[out]    DestinationSize  The size of destination buffer.
+  @param[out]    ScratchSize      The size of scratch buffer.
+
+  @retval  RETURN_SUCCESS           The size of destination buffer and the size of scratch buffer are successull retrieved.\r
+  @retval  RETURN_INVALID_PARAMETER The source data is corrupted
+
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 CustomDecompressGetInfo (\r
@@ -24,29 +36,23 @@ CustomDecompressGetInfo (
   OUT UINT32      *DestinationSize,\r
   OUT UINT32      *ScratchSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of *_DECOMPRESS_PROTOCOL.GetInfo().\r
-\r
-Arguments:\r
-\r
-  Source          - The source buffer containing the compressed data.\r
-  SourceSize      - The size of source buffer\r
-  DestinationSize - The size of destination buffer.\r
-  ScratchSize     - The size of scratch buffer.\r
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - The size of destination buffer and the size of scratch buffer are successull retrieved.\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-\r
---*/\r
 {\r
   return RETURN_UNSUPPORTED;\r
 }\r
 \r
+\r
+/**
+  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
+
+  @param[in]     Source           The source buffer containing the compressed data.
+  @param[in]     Destination      The destination buffer to store the decompressed data
+  @param[out]    Scratch          The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
+
+
+  @retval  RETURN_SUCCESS            Decompression is successfull\r
+  @retval  RETURN_INVALID_PARAMETER The source data is corrupted
+
+**/\r
 RETURN_STATUS\r
 EFIAPI\r
 CustomDecompress (\r
@@ -54,24 +60,6 @@ CustomDecompress (
   IN OUT VOID    *Destination,\r
   IN OUT VOID    *Scratch\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  The internal implementation of *_DECOMPRESS_PROTOCOL.Decompress().\r
-\r
-Arguments:\r
-\r
-  Source          - The source buffer containing the compressed data.\r
-  Destination     - The destination buffer to store the decompressed data\r
-  Scratch         - The buffer used internally by the decompress routine. This  buffer is needed to store intermediate data.\r
-\r
-Returns:\r
-\r
-  RETURN_SUCCESS           - Decompression is successfull\r
-  RETURN_INVALID_PARAMETER - The source data is corrupted\r
-\r
---*/\r
 {\r
   return RETURN_UNSUPPORTED;\r
 }\r
index aaae182..a75ddb1 100644 (file)
@@ -1,20 +1,20 @@
-/*++\r
-\r
-Copyright (c) 2006 Intel Corporation. All rights reserved\r
-This software and associated documentation (if any) is furnished\r
-under a license and may only be used or copied in accordance\r
-with the terms of the license. Except as permitted by such\r
-license, no part of this software or documentation may be\r
-reproduced, stored in a retrieval system, or transmitted in any\r
-form or by any means without the express written consent of\r
-Intel Corporation.\r
-\r
-  PEI Services Table Pointer Library.\r
-  \r
---*/\r
+/** @file\r
+  PEI Services Table Pointer Library for IA-32 and X64.\r
+\r
+  Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
 #include "InternalPeiServicesTablePointer.h"\r
 \r
+\r
 /**\r
   \r
   The function returns the pointer to PeiServicee following\r
@@ -23,8 +23,7 @@ Intel Corporation.
   For IA32, the four-bytes field immediately prior to new IDT\r
   base addres is used to save the EFI_PEI_SERVICES**.\r
   For x64, the eight-bytes field immediately prior to new IDT\r
-  base addres is used to save the EFI_PEI_SERVICES**.\r
-\r
+  base addres is used to save the EFI_PEI_SERVICES**\r
   @retval  The pointer to PeiServices.\r
 \r
 **/\r
index 160e553..4146651 100644 (file)
@@ -1,19 +1,18 @@
-/*++\r
+/** @file\r
+  PEI Services Table Pointer Library implementation for IPF that uses Kernel \r
+  Register 7 to store the pointer.\r
 \r
-Copyright (c) 2006 Intel Corporation. All rights reserved\r
-This software and associated documentation (if any) is furnished\r
-under a license and may only be used or copied in accordance\r
-with the terms of the license. Except as permitted by such\r
-license, no part of this software or documentation may be\r
-reproduced, stored in a retrieval system, or transmitted in any\r
-form or by any means without the express written consent of\r
-Intel Corporation.\r
+  Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
-  PEI Services Table Pointer Library.\r
-  \r
---*/\r
 \r
 #include <Library/BaseLib.h>\r
 \r
index b873495..48db6bd 100644 (file)
@@ -1,20 +1,37 @@
-/*++\r
+/** @file\r
+  UEFI Runtime Library implementation for non IPF processor types.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
-All rights reserved. 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
+  This library hides the global variable for the EFI Runtime Services so the\r
+  caller does not need to deal with the possiblitly of being called from an\r
+  OS virtual address space. All pointer values are different for a virtual \r
+  mapping than from the normal physical mapping at boot services time.\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) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
---*/\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
 #include <PiDxe.h>\r
 \r
 #include <RuntimeLibInternal.h>\r
 \r
+\r
+/**\r
+  Resets the entire platform.\r
+\r
+  @param  ResetType   The type of reset to perform.\r
+  @param  ResetStatus The status code for reset.\r
+  @param  DataSize    The size in bytes of reset data.\r
+  @param  ResetData   Pointer to data buffer that includes\r
+                      Null-Terminated Unicode string.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 EfiResetSystem (\r
@@ -23,85 +40,64 @@ EfiResetSystem (
   IN UINTN                        DataSize,\r
   IN CHAR16                       *ResetData\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Resets the entire platform.\r
+{\r
+  mRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);\r
+}\r
 \r
-Arguments:\r
 \r
-  ResetType   - The type of reset to perform.\r
-  ResetStatus - The status code for the reset.\r
-  DataSize    - The size, in bytes, of ResetData.\r
-  ResetData   - A data buffer that includes a Null-terminated Unicode string, optionally\r
-                followed by additional binary data.\r
+/**\r
+  Return current time and date information, and time-keeping\r
+  capabilities of hardware platform.\r
 \r
-Returns:\r
+  @param  Time         A pointer to storage to receive a snapshot of the current time.\r
+  @param  Capabilities An optional pointer to a buffer to receive the real time clock device's\r
+                       capabilities.\r
 \r
-  None\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
---*/\r
-{\r
-  mRT->ResetSystem (ResetType, ResetStatus, DataSize, ResetData);\r
-}\r
-\r
-//\r
-// The following functions hide the mRT local global from the call to\r
-// runtime service in the EFI system table.\r
-//\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiGetTime (\r
   OUT EFI_TIME                    *Time,\r
   OUT EFI_TIME_CAPABILITIES       *Capabilities\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Returns the current time and date information, and the time-keeping\r
-  capabilities of the hardware platform.\r
+{\r
+  return mRT->GetTime (Time, Capabilities);\r
+}\r
 \r
-Arguments:\r
 \r
-  Time          - A pointer to storage to receive a snapshot of the current time.\r
-  Capabilities  - An optional pointer to a buffer to receive the real time clock device's\r
-                  capabilities.\r
+/**\r
+  Set current time and date information.\r
 \r
-Returns:\r
+  @param  Time         A pointer to cache of time setting.\r
 \r
-  Status code\r
-\r
---*/\r
-{\r
-  return mRT->GetTime (Time, Capabilities);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to execute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiSetTime (\r
   IN EFI_TIME                   *Time\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Sets the current local time and date information.\r
-\r
-Arguments:\r
+{\r
+  return mRT->SetTime (Time);\r
+}\r
 \r
-  Time  - A pointer to the current time.\r
 \r
-Returns:\r
+/**\r
+  Return current wakeup alarm clock setting.\r
 \r
-  Status code\r
+  @param  Enabled Indicate if the alarm clock is enabled or disabled.\r
+  @param  Pending Indicate if the alarm signal is pending and requires acknowledgement.\r
+  @param  Time    Current alarm clock setting.\r
 \r
---*/\r
-{\r
-  return mRT->SetTime (Time);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiGetWakeupTime (\r
@@ -109,57 +105,49 @@ EfiGetWakeupTime (
   OUT BOOLEAN                     *Pending,\r
   OUT EFI_TIME                    *Time\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Returns the current wakeup alarm clock setting.\r
+{\r
+  return mRT->GetWakeupTime (Enabled, Pending, Time);\r
+}\r
 \r
-Arguments:\r
 \r
-  Enabled - Indicates if the alarm is currently enabled or disabled.\r
-  Pending - Indicates if the alarm signal is pending and requires acknowledgement.\r
-  Time    - The current alarm setting.\r
 \r
-Returns:\r
+/**\r
+  Set current wakeup alarm clock.\r
 \r
-  Status code\r
+  @param  Enable Enable or disable current alarm clock..\r
+  @param  Time   Point to alarm clock setting.\r
 \r
---*/\r
-{\r
-  return mRT->GetWakeupTime (Enabled, Pending, Time);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiSetWakeupTime (\r
   IN BOOLEAN                      Enable,\r
   IN EFI_TIME                     *Time\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Sets the system wakeup alarm clock time.\r
-\r
-Arguments:\r
-\r
-  Enable  - Enable or disable the wakeup alarm.\r
-  Time    - If Enable is TRUE, the time to set the wakeup alarm for.\r
-            If Enable is FALSE, then this parameter is optional, and may be NULL.\r
-\r
-Returns:\r
-\r
-  Status code\r
-\r
---*/\r
 {\r
   return mRT->SetWakeupTime (Enable, Time);\r
 }\r
 \r
 \r
+/**\r
+  Return value of variable.\r
+\r
+  @param  VariableName the name of the vendor's variable, it's a\r
+                       Null-Terminated Unicode String\r
+  @param  VendorGuid   Unify identifier for vendor.\r
+  @param  Attributes   Point to memory location to return the attributes of variable. If the point\r
+                       is NULL, the parameter would be ignored.\r
+  @param  DataSize     As input, point to the maxinum size of return Data-Buffer.\r
+                       As output, point to the actual size of the returned Data-Buffer.\r
+  @param  Data         Point to return Data-Buffer.\r
 \r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiGetVariable (\r
@@ -169,32 +157,28 @@ EfiGetVariable (
   IN OUT UINTN                    *DataSize,\r
   OUT VOID                        *Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Returns the value of a variable.\r
-\r
-Arguments:\r
+{\r
+  return mRT->GetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r
+}\r
 \r
-  VariableName  - A Null-terminated Unicode string that is the name of the\r
-                  vendor's variable.\r
-  VendorGuid    - A unique identifier for the vendor.\r
-  Attributes    - If not NULL, a pointer to the memory location to return the\r
-                  attributes bitmask for the variable.\r
-  DataSize      - On input, the size in bytes of the return Data buffer.\r
-                  On output the size of data returned in Data.\r
-  Data          - The buffer to return the contents of the variable.\r
 \r
-Returns:\r
+/**\r
+  Enumerates variable's name.\r
 \r
-  Status code\r
+  @param  VariableNameSize As input, point to maxinum size of variable name.\r
+                           As output, point to actual size of varaible name.\r
+  @param  VariableName     As input, supplies the last VariableName that was returned by\r
+                           GetNextVariableName().\r
+                           As output, returns the name of variable. The name\r
+                           string is Null-Terminated Unicode string.\r
+  @param  VendorGuid       As input, supplies the last VendorGuid that was returned by\r
+                           GetNextVriableName().\r
+                           As output, returns the VendorGuid of the current variable.\r
 \r
---*/\r
-{\r
-  return mRT->GetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiGetNextVariableName (\r
@@ -202,32 +186,26 @@ EfiGetNextVariableName (
   IN OUT CHAR16                   *VariableName,\r
   IN OUT EFI_GUID                 *VendorGuid\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Enumerates the current variable names.\r
-\r
-Arguments:\r
+{\r
+  return mRT->GetNextVariableName (VariableNameSize, VariableName, VendorGuid);\r
+}\r
 \r
-  VariableNameSize  - The size of the VariableName buffer.\r
-  VariableName      - On input, supplies the last VariableName that was returned\r
-                      by GetNextVariableName().\r
-                      On output, returns the Nullterminated Unicode string of the\r
-                      current variable.\r
-  VendorGuid        - On input, supplies the last VendorGuid that was returned by\r
-                      GetNextVariableName().\r
-                      On output, returns the VendorGuid of the current variable.\r
 \r
-Returns:\r
+/**\r
+  Sets value of variable.\r
 \r
-  Status code\r
+  @param  VariableName the name of the vendor's variable, it's a\r
+                       Null-Terminated Unicode String\r
+  @param  VendorGuid   Unify identifier for vendor.\r
+  @param  Attributes   Point to memory location to return the attributes of variable. If the point\r
+                       is NULL, the parameter would be ignored.\r
+  @param  DataSize     The size in bytes of Data-Buffer.\r
+  @param  Data         Point to the content of the variable.\r
 \r
---*/\r
-{\r
-  return mRT->GetNextVariableName (VariableNameSize, VariableName, VendorGuid);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiSetVariable (\r
@@ -237,104 +215,69 @@ EfiSetVariable (
   IN UINTN                        DataSize,\r
   IN VOID                         *Data\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Sets the value of a variable.\r
-\r
-Arguments:\r
+{\r
+  return mRT->SetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r
+}\r
 \r
-  VariableName  - A Null-terminated Unicode string that is the name of the\r
-                  vendor's variable.\r
-  VendorGuid    - A unique identifier for the vendor.\r
-  Attributes    - Attributes bitmask to set for the variable.\r
-  DataSize      - The size in bytes of the Data buffer.\r
-  Data          - The contents for the variable.\r
 \r
-Returns:\r
+/**\r
+  Returns the next high 32 bits of platform's monotonic counter.\r
 \r
-  Status code\r
+  @param  HighCount Pointer to returned value.\r
 \r
---*/\r
-{\r
-  return mRT->SetVariable (VariableName, VendorGuid, Attributes, DataSize, Data);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiGetNextHighMonotonicCount (\r
   OUT UINT32                      *HighCount\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Returns the next high 32 bits of the platform's monotonic counter.\r
+{\r
+  return mRT->GetNextHighMonotonicCount (HighCount);\r
+}\r
 \r
-Arguments:\r
 \r
-  HighCount - Pointer to returned value.\r
+/**\r
+  Determines the new virtual address that is to be used on subsequent memory accesses.\r
 \r
-Returns:\r
+  @param  DebugDisposition   Supplies type information for the pointer being converted.\r
+  @param  Address            The pointer to a pointer that is to be fixed to be the\r
+                             value needed for the new virtual address mapping being\r
+                             applied.\r
 \r
-  Status code\r
-\r
---*/\r
-{\r
-  return mRT->GetNextHighMonotonicCount (HighCount);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiConvertPointer (\r
   IN UINTN                  DebugDisposition,\r
   IN OUT VOID               **Address\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Determines the new virtual address that is to be used on subsequent memory accesses.\r
-\r
-Arguments:\r
+{\r
+  return mRT->ConvertPointer (DebugDisposition, Address);\r
+}\r
 \r
-  DebugDisposition  - Supplies type information for the pointer being converted.\r
-  Address           - A pointer to a pointer that is to be fixed to be the value needed\r
-                      for the new virtual address mappings being applied.\r
 \r
-Returns:\r
+/**\r
+  Conver the standard Lib double linked list to a virtual mapping.\r
 \r
-  Status code\r
+  @param  DebugDisposition   Supplies type information for the pointer being converted.\r
+  @param  ListHead           Head of linked list to convert.\r
 \r
---*/\r
-{\r
-  return mRT->ConvertPointer (DebugDisposition, Address);\r
-}\r
+  @retval  EFI_SUCCESS  Success to execute the function.\r
+  @retval  !EFI_SUCCESS Failed to e3xecute the function.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiConvertList (\r
   IN UINTN                DebugDisposition,\r
   IN OUT LIST_ENTRY       *ListHead\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Conver the standard Lib double linked list to a virtual mapping.\r
-\r
-Arguments:\r
-\r
-  DebugDisposition - Argument to EfiConvertPointer (EFI 1.0 API)\r
-\r
-  ListHead         - Head of linked list to convert\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS\r
-\r
---*/\r
 {\r
   LIST_ENTRY  *Link;\r
   LIST_ENTRY  *NextLink;\r
@@ -401,6 +344,38 @@ EfiSetVirtualAddressMap (
 }\r
 \r
 \r
+/**\r
+  Passes capsules to the firmware with both virtual and physical mapping.\r
+  Depending on the intended consumption, the firmware may\r
+  process the capsule immediately. If the payload should persist across a\r
+  system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r
+  be passed into ResetSystem() and will cause the capsule to be processed by\r
+  the firmware as part of the reset process.\r
+\r
+  @param  CapsuleHeaderArray    Virtual pointer to an array of virtual pointers to the capsules\r
+                                being passed into update capsule. Each capsules is assumed to\r
+                                stored in contiguous virtual memory. The capsules in the\r
+                                CapsuleHeaderArray must be the same capsules as the\r
+                                ScatterGatherList. The CapsuleHeaderArray must\r
+                                have the capsules in the same order as the ScatterGatherList.\r
+  @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in\r
+                                CaspuleHeaderArray.\r
+  @param  ScatterGatherList     Physical pointer to a set of\r
+                                EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r
+                                location in physical memory of a set of capsules. See Related\r
+                                Definitions for an explanation of how more than one capsule is\r
+                                passed via this interface. The capsules in the\r
+                                ScatterGatherList must be in the same order as the\r
+                                CapsuleHeaderArray. This parameter is only referenced if\r
+                                the capsules are defined to persist across system reset.\r
+\r
+  @retval EFI_SUCCESS           Valid capsule was passed. I Valid capsule was passed. If\r
+                                CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r
+                                capsule has been successfully processed by the firmware.\r
+  @retval EFI_INVALID_PARAMETER CapsuleSize is NULL or ResetTye is NULL.\r
+  @retval EFI_DEVICE_ERROR      The capsule update was started, but failed due to a device error.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiUpdateCapsule (\r
@@ -416,6 +391,38 @@ EfiUpdateCapsule (
                 );\r
 }\r
 \r
+\r
+/**\r
+  The QueryCapsuleCapabilities() function allows a caller to test to see if a capsule or\r
+  capsules can be updated via UpdateCapsule(). The Flags values in the capsule header and\r
+  size of the entire capsule is checked.\r
+  If the caller needs to query for generic capsule capability a fake EFI_CAPSULE_HEADER can be\r
+  constructed where CapsuleImageSize is equal to HeaderSize that is equal to sizeof\r
+  (EFI_CAPSULE_HEADER). To determine reset requirements,\r
+  CAPSULE_FLAGS_PERSIST_ACROSS_RESET should be set in the Flags field of the\r
+  EFI_CAPSULE_HEADER.\r
+  The firmware must support any capsule that has the\r
+  CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set in EFI_CAPSULE_HEADER. The\r
+  firmware sets the policy for what capsules are supported that do not have the\r
+  CAPSULE_FLAGS_PERSIST_ACROSS_RESET flag set.\r
+\r
+  @param  CapsuleHeaderArray    Virtual pointer to an array of virtual pointers to the capsules\r
+                                being passed into update capsule. The capsules are assumed to\r
+                                stored in contiguous virtual memory.\r
+  @param  CapsuleCount          Number of pointers to EFI_CAPSULE_HEADER in\r
+                                CaspuleHeaderArray.\r
+  @param  MaxiumCapsuleSize     On output the maximum size that UpdateCapsule() can\r
+                                support as an argument to UpdateCapsule() via\r
+                                CapsuleHeaderArray and ScatterGatherList.\r
+                                Undefined on input.\r
+  @param  ResetType             Returns the type of reset required for the capsule update.\r
+\r
+  @retval EFI_SUCCESS           Valid answer returned..\r
+  @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL.\r
+  @retval EFI_UNSUPPORTED       The capsule type is not supported on this platform, and\r
+                                MaximumCapsuleSize and ResetType are undefined.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiQueryCapsuleCapabilities (\r
@@ -434,6 +441,37 @@ EfiQueryCapsuleCapabilities (
 }\r
 \r
 \r
+/**\r
+  The QueryVariableInfo() function allows a caller to obtain the information about the\r
+  maximum size of the storage space available for the EFI variables, the remaining size of the storage\r
+  space available for the EFI variables and the maximum size of each individual EFI variable,\r
+  associated with the attributes specified.\r
+  The returned MaximumVariableStorageSize, RemainingVariableStorageSize,\r
+  MaximumVariableSize information may change immediately after the call based on other\r
+  runtime activities including asynchronous error events. Also, these values associated with different\r
+  attributes are not additive in nature.\r
+\r
+  @param  Attributes            Attributes bitmask to specify the type of variables on\r
+                                which to return information. Refer to the\r
+                                GetVariable() function description.\r
+  @param  MaximumVariableStorageSize\r
+                                On output the maximum size of the storage space\r
+                                available for the EFI variables associated with the\r
+                                attributes specified.\r
+  @param  RemainingVariableStorageSize\r
+                                Returns the remaining size of the storage space\r
+                                available for the EFI variables associated with the\r
+                                attributes specified..\r
+  @param  MaximumVariableSize   Returns the maximum size of the individual EFI\r
+                                variables associated with the attributes specified.\r
+\r
+  @retval EFI_SUCCESS           Valid answer returned.\r
+  @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied.\r
+  @retval EFI_UNSUPPORTED       EFI_UNSUPPORTED The attribute is not supported on this platform, and the\r
+                                MaximumVariableStorageSize,\r
+                                RemainingVariableStorageSize, MaximumVariableSize\r
+                                are undefined.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 EfiQueryVariableInfo (\r
index 5eb94ba..ee576d7 100644 (file)
@@ -1,32 +1,53 @@
-/*++\r
-\r
-Copyright (c) 2006, Intel Corporation                                                         \r
-All rights reserved. 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
-//\r
-// The package level header files this module uses\r
-//\r
-#include <PiDxe.h>\r
+/** @file\r
+  UEFI SCSI Library implementation\r
+\r
+  Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
+  All rights reserved. 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
-//\r
-// The protocols, PPI and GUID defintions for this module\r
-//\r
-//\r
-// The Library classes this module consumes\r
-//\r
+\r
+#include <PiDxe.h>\r
 #include <Library/ScsiLib.h>\r
 #include <Library/BaseMemoryLib.h>\r
 \r
 #include <IndustryStandard/scsi.h>\r
 \r
+\r
+/**
+  Function test the ready status of the SCSI unit.\r
+
+  @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.\r
+  @retval EFI_BAD_BUFFER_SIZE   The SCSI Request Packet was executed, \r
+                                but the entire DataBuffer could not be transferred.\r
+                                The actual number of bytes transferred is returned\r
+                                in InTransferLength.\r
+  @retval EFI_NOT_READY         The SCSI Request Packet could not be sent because \r
+                                there are too many SCSI Command Packets already \r
+                                queued.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred while attempting to send \r
+                                the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED       The command described by the SCSI Request Packet\r
+                                is not supported by the SCSI initiator(i.e., SCSI \r
+                                Host Controller).\r
+  @retval EFI_TIMEOUT           A timeout occurred while waiting for the SCSI \r
+                                Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitTestUnitReadyCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -36,40 +57,6 @@ SubmitTestUnitReadyCommand (
   OUT UINT8                 *HostAdapterStatus,\r
   OUT UINT8                 *TargetStatus\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function tests the ready status of SCSI unit.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-  EFI_BAD_BUFFER_SIZE        - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in InTransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -109,6 +96,38 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit SCSI inquiry command.\r
+
+  @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.\r
+  @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, \r
+                              but the entire DataBuffer could not be transferred.\r
+                              The actual number of bytes transferred is returned\r
+                              in TransferLength.\r
+  @retval EFI_NOT_READY   The SCSI Request Packet could not be sent because \r
+                          there are too many SCSI Command Packets already \r
+                          queued.\r
+  @retval EFI_DEVICE_ERROR  A device error occurred while attempting to send \r
+                            the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
+                          is not supported by the SCSI initiator(i.e., SCSI \r
+                          Host Controller).\r
+  @retval EFI_TIMEOUT     A timeout occurred while waiting for the SCSI \r
+                          Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitInquiryCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -121,43 +140,6 @@ SubmitInquiryCommand (
   IN OUT UINT32             *InquiryDataLength,\r
   IN  BOOLEAN               EnableVitalProductData\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit SCSI inquiry command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-  InquiryDataBuffer    - A pointer to inquiry data buffer.\r
-  InquiryDataLength    - The length of inquiry data buffer.\r
-  EnableVitalProductData - Boolean to enable Vital Product Data.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-  EFI_BAD_BUFFER_SIZE        - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in TransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -203,6 +185,40 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit SCSI mode sense 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitModeSense10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL    *ScsiIo,\r
@@ -217,45 +233,6 @@ SubmitModeSense10Command (
   IN  UINT8                   PageControl,\r
   IN  UINT8                   PageCode\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit SCSI mode sense 10 command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-  DataBuffer           - A pointer to input data buffer.\r
-  DataLength           - The length of input data buffer.\r
-  DBDField             - The DBD Field (Optional).\r
-  PageControl          - Page Control.\r
-  PageCode             - Page code.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-    EFI_WARN_BUFFER_TOO_SMALL  - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in TransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -298,6 +275,42 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit SCSI request sense command.\r
+  ScsiIo               - A pointer to SCSI IO protocol.\r
+  Timeout              - The length of timeout period.\r
+  SenseData            - A pointer to output sense data.\r
+  SenseDataLength      - The length of output sense data.\r
+  HostAdapterStatus    - The status of Host Adapter.\r
+  TargetStatus         - The status of the target.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitRequestSenseCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -307,40 +320,6 @@ SubmitRequestSenseCommand (
   OUT UINT8                 *HostAdapterStatus,\r
   OUT UINT8                 *TargetStatus\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit SCSI request sense command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-    EFI_WARN_BUFFER_TOO_SMALL  - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in TransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -380,6 +359,38 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit read capacity command.\r
+\r
+  @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.\r
+  @retval  EFI_WARN_BUFFER_TOO_SMALL  The SCSI Request Packet was executed, \r
+                                      but the entire DataBuffer could not be transferred.\r
+                                      The actual number of bytes transferred is returned\r
+                                      in TransferLength.\r
+  @retval  EFI_NOT_READY              The SCSI Request Packet could not be sent because \r
+                                      there are too many SCSI Command Packets already \r
+                                      queued.\r
+  @retval  EFI_DEVICE_ERROR           A device error occurred while attempting to send \r
+                                      the SCSI Request Packet.\r
+  @retval  EFI_INVALID_PARAMETER      The contents of CommandPacket are invalid.  \r
+  @retval  EFI_UNSUPPORTED            The command described by the SCSI Request Packet\r
+                                      is not supported by the SCSI initiator(i.e., SCSI \r
+                                      Host Controller).\r
+  @retval  EFI_TIMEOUT                A timeout occurred while waiting for the SCSI \r
+                                      Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitReadCapacityCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -392,43 +403,6 @@ SubmitReadCapacityCommand (
   IN OUT UINT32             *DataLength,\r
   IN  BOOLEAN               PMI\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit read capacity command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-  DataBuffer           - A pointer to a data buffer.\r
-  DataLength           - The length of data buffer.\r
-  PMI                  - Partial medium indicator.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-    EFI_WARN_BUFFER_TOO_SMALL  - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in TransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -476,6 +450,39 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit read 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in TransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitRead10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -489,44 +496,6 @@ SubmitRead10Command (
   IN  UINT32                StartLba,\r
   IN  UINT32                SectorSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit read 10 command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-  DataBuffer           - A pointer to a data buffer.\r
-  DataLength           - The length of data buffer.\r
-  StartLba             - The start address of LBA.\r
-  SectorSize           - The sector size.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-    EFI_WARN_BUFFER_TOO_SMALL  - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in TransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r
@@ -572,6 +541,39 @@ Returns:
   return Status;\r
 }\r
 \r
+\r
+/**
+  Function to submit SCSI write 10 command.\r
+
+  @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.\r
+  @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, \r
+                                    but the entire DataBuffer could not be transferred.\r
+                                    The actual number of bytes transferred is returned\r
+                                    in InTransferLength.\r
+  @retval EFI_NOT_READY             The SCSI Request Packet could not be sent because \r
+                                    there are too many SCSI Command Packets already \r
+                                    queued.\r
+  @retval EFI_DEVICE_ERROR          A device error occurred while attempting to send \r
+                                    the SCSI Request Packet.\r
+  @retval EFI_INVALID_PARAMETER     The contents of CommandPacket are invalid.  \r
+  @retval EFI_UNSUPPORTED           The command described by the SCSI Request Packet\r
+                                    is not supported by the SCSI initiator(i.e., SCSI \r
+                                    Host Controller).\r
+  @retval EFI_TIMEOUT               A timeout occurred while waiting for the SCSI \r
+                                    Request Packet to execute.\r
+
+**/\r
 EFI_STATUS\r
 SubmitWrite10Command (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
@@ -585,44 +587,6 @@ SubmitWrite10Command (
   IN  UINT32                StartLba,\r
   IN  UINT32                SectorSize\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Function to submit SCSI write 10 command.\r
-\r
-Arguments:\r
-  ScsiIo               - A pointer to SCSI IO protocol.\r
-  Timeout              - The length of timeout period.\r
-  SenseData            - A pointer to output sense data.\r
-  SenseDataLength      - The length of output sense data.\r
-  HostAdapterStatus    - The status of Host Adapter.\r
-  TargetStatus         - The status of the target.\r
-  DataBuffer           - A pointer to a data buffer.\r
-  DataLength           - The length of data buffer.\r
-  StartLba             - The start address of LBA.\r
-  SectorSize           - The sector size.\r
-\r
-Returns:\r
-\r
-  Returns:\r
-    EFI_SUCCESS            - The status of the unit is tested successfully.\r
-    EFI_WARN_BUFFER_TOO_SMALL  - The SCSI Request Packet was executed, \r
-                            but the entire DataBuffer could not be transferred.\r
-                            The actual number of bytes transferred is returned\r
-                            in InTransferLength.\r
-    EFI_NOT_READY          - The SCSI Request Packet could not be sent because \r
-                            there are too many SCSI Command Packets already \r
-                            queued.\r
-    EFI_DEVICE_ERROR      - A device error occurred while attempting to send \r
-                            the SCSI Request Packet.\r
-    EFI_INVALID_PARAMETER  - The contents of CommandPacket are invalid.  \r
-    EFI_UNSUPPORTED        - The command described by the SCSI Request Packet\r
-                            is not supported by the SCSI initiator(i.e., SCSI \r
-                            Host Controller).\r
-    EFI_TIMEOUT            - A timeout occurred while waiting for the SCSI \r
-                            Request Packet to execute.\r
-\r
---*/\r
 {\r
   EFI_SCSI_IO_SCSI_REQUEST_PACKET CommandPacket;\r
   UINT64                          Lun;\r