MdePkg/UefiScsiLib: Wrong function parameter comments in UefiScsiLib. It should be...

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Tian, Feng <feng.tian@intel.com>
Reviewed-by: Zeng, Star <star.zeng@intel.com>
Reviewed-by: Fu, Siyuan <siyuan.fu@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15492 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/UefiScsiLib.h b/MdePkg/Include/Library/UefiScsiLib.h
index d6907c406077cc0ef86ebaf665552377b171c7dc..768a912a22fcd528a85c2a0a69f4044313539deb 100644 (file)
--- a/MdePkg/Include/Library/UefiScsiLib.h
+++ b/MdePkg/Include/Library/UefiScsiLib.h
@@ -5,7 +5,7 @@
   for hard drive, CD and DVD devices that are the most common SCSI boot targets used by UEFI platforms.\r
   This library class depends on SCSI I/O Protocol defined in UEFI Specification and SCSI-2 industry standard.\r
 \r
-Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
 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
@@ -547,7 +547,7 @@ ScsiReadCapacity16Command (
   @param[in, out] DataBuffer           Read 10 command data.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          Command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -599,7 +599,7 @@ ScsiRead10Command (
   @param[in, out] DataBuffer           A pointer to a data buffer.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          Command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -651,7 +651,7 @@ ScsiWrite10Command (
   @param[in, out] DataBuffer           Read 16 command data.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          Command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -703,7 +703,7 @@ ScsiRead16Command (
   @param[in, out] DataBuffer           A pointer to a data buffer.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          Command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r

diff --git a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
index ff4d8da507813ab88fbe6f5624161af953815e4b..bd838c4ff431753c71ee7abd363091c59ca5040d 100644 (file)
--- a/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
+++ b/MdePkg/Library/UefiScsiLib/UefiScsiLib.c
@@ -874,7 +874,7 @@ ScsiReadCapacity16Command (
   @param[in, out] DataBuffer           Read 10 command data.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          The command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -972,7 +972,7 @@ ScsiRead10Command (
   @param[in, out] DataBuffer           A pointer to a data buffer.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          The command executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -1070,7 +1070,7 @@ ScsiWrite10Command (
   @param[in, out] DataBuffer           Read 16 command data.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          The command executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r
@@ -1168,7 +1168,7 @@ ScsiRead16Command (
   @param[in, out] DataBuffer           A pointer to a data buffer.\r
   @param[in, out] DataLength           The length of data buffer.\r
   @param[in]      StartLba             The start address of LBA.\r
-  @param[in]      SectorSize           The sector size.\r
+  @param[in]      SectorSize           The number of contiguous logical blocks of data that shall be transferred.\r
 \r
   @retval  EFI_SUCCESS          The command is executed successfully.\r
   @retval  EFI_BAD_BUFFER_SIZE  The SCSI Request Packet was executed, but the entire DataBuffer could\r