tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update function header description of ScsiReadCapacity16Command() in the UEFI Scsi Library 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8277 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
mdkinney 2009-05-09 01:31:20 +00:00
parent aa2f249e38
commit 5e11e7c691
2 changed files with 60 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
MdePkg/Include/Library/UefiScsiLib.h
View File

@ -378,34 +378,38 @@ ScsiReadCapacityCommand (
/** /**
Function to submit read capacity16 command. Execute Read Capacity SCSI 16 command on a specific SCSI target.
@param ScsiIo A pointer to SCSI IO protocol. Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.
@param Timeout The length of timeout period. If Timeout is zero, then this function waits indefinitely for the command to complete.
@param SenseData A pointer to output sense data. If Timeout is greater than zero, then the command is executed and will timeout after
@param SenseDataLength The length of output sense data. Timeout 100 ns units. The Pmi parameter is used to construct the CDB for this SCSI command.
@param HostAdapterStatus The status of Host Adapter. If ScsiIo is NULL, then ASSERT().
@param TargetStatus The status of the target. If SenseDataLength is NULL, then ASSERT().
@param DataBuffer A pointer to a data buffer. If HostAdapterStatus is NULL, then ASSERT().
@param DataLength The length of data buffer. If TargetStatus is NULL, then ASSERT().
@param Pmi Partial medium indicator. If DataLength is NULL, then ASSERT().
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to SCSI IO protocol.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, @param[in] Timeout The length of timeout period.
but the entire DataBuffer could not be transferred. @param[in, out] SenseData A pointer to output sense data.
The actual number of bytes transferred is returned @param[in, out] SenseDataLength The length of output sense data.
in TransferLength. @param[out] HostAdapterStatus The status of Host Adapter.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because @param[out] TargetStatus The status of the target.
there are too many SCSI Command Packets already @param[in, out] DataBuffer A pointer to a data buffer.
queued. @param[in, out] DataLength The length of data buffer.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send @param[in] Pmi Partial medium indicator.
the SCSI Request Packet.
@retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. @retval EFI_SUCCESS Command is executed successfully.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
is not supported by the SCSI initiator(i.e., SCSI DataBuffer could not be transferred. The actual
Host Controller). number of bytes transferred is returned in DataLength.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
Request Packet to execute. there are too many SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
**/ **/
EFI_STATUS EFI_STATUS

56
MdePkg/Library/UefiScsiLib/UefiScsiLib.c
View File

@ -636,34 +636,38 @@ ScsiReadCapacityCommand (
/** /**
Function to submit read capacity16 command. Execute Read Capacity SCSI 16 command on a specific SCSI target.
@param ScsiIo A pointer to SCSI IO protocol. Executes the SCSI Read Capacity 16 command on the SCSI target specified by ScsiIo.
@param Timeout The length of timeout period. If Timeout is zero, then this function waits indefinitely for the command to complete.
@param SenseData A pointer to output sense data. If Timeout is greater than zero, then the command is executed and will timeout after
@param SenseDataLength The length of output sense data. Timeout 100 ns units. The Pmi parameter is used to construct the CDB for this SCSI command.
@param HostAdapterStatus The status of Host Adapter. If ScsiIo is NULL, then ASSERT().
@param TargetStatus The status of the target. If SenseDataLength is NULL, then ASSERT().
@param DataBuffer A pointer to a data buffer. If HostAdapterStatus is NULL, then ASSERT().
@param DataLength The length of data buffer. If TargetStatus is NULL, then ASSERT().
@param Pmi Partial medium indicator. If DataLength is NULL, then ASSERT().
@retval EFI_SUCCESS The status of the unit is tested successfully. @param[in] ScsiIo A pointer to SCSI IO protocol.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, @param[in] Timeout The length of timeout period.
but the entire DataBuffer could not be transferred. @param[in, out] SenseData A pointer to output sense data.
The actual number of bytes transferred is returned @param[in, out] SenseDataLength The length of output sense data.
in TransferLength. @param[out] HostAdapterStatus The status of Host Adapter.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because @param[out] TargetStatus The status of the target.
there are too many SCSI Command Packets already @param[in, out] DataBuffer A pointer to a data buffer.
queued. @param[in, out] DataLength The length of data buffer.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send @param[in] Pmi Partial medium indicator.
the SCSI Request Packet.
@retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. @retval EFI_SUCCESS Command is executed successfully.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire
is not supported by the SCSI initiator(i.e., SCSI DataBuffer could not be transferred. The actual
Host Controller). number of bytes transferred is returned in DataLength.
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI @retval EFI_NOT_READY The SCSI Request Packet could not be sent because
Request Packet to execute. there are too many SCSI Command Packets already queued.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI Host Controller)
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
**/ **/
EFI_STATUS EFI_STATUS