/** @file\r
-\r
Provides the functions to submit Scsi commands defined in SCSI-2 specification for scsi device.\r
\r
+ This library class provides the functions to submit SCSI commands defined in SCSI-2 specification\r
+ 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 - 2008, 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
\r
**/\r
\r
-#ifndef _SCSI_LIB_H_\r
-#define _SCSI_LIB_H_\r
+#ifndef __SCSI_LIB_H__\r
+#define __SCSI_LIB_H__\r
\r
#include <Protocol/ScsiIo.h>\r
\r
-//\r
-// the time unit is 100ns, since the SCSI I/O defines timeout in 100ns unit.\r
-//\r
-#define EFI_SCSI_STALL_1_MICROSECOND 10\r
-#define EFI_SCSI_STALL_1_MILLISECOND 10000\r
-#define EFI_SCSI_STALL_1_SECOND 10000000\r
-\r
-///\r
-/// this macro cannot be directly used by the gBS->Stall(),\r
-/// since the value output by this macro is in 100ns unit,\r
-/// not 1us unit (1us = 1000ns)\r
-///\r
-#define EFI_SCSI_STALL_SECONDS(a) ((a) * EFI_SCSI_STALL_1_SECOND)\r
-\r
-\r
/**\r
Execute Test Unit Ready SCSI command on a specific SCSI target.\r
\r
If SenseDataLength is 0, then this parameter is\r
optional and may be NULL.\r
@param[in, out] SenseDataLength On input, a pointer to the length in bytes of\r
- the SenseData buffer. On output, a poiinter to\r
+ the SenseData buffer. On output, a pointer to\r
the number of bytes written to the SenseData buffer. \r
@param[out] HostAdapterStatus The status of the SCSI Host Controller that produces\r
the SCSI bus containing the SCSI target specified by\r
See the EFI SCSI I/O Protocol in the UEFI Specification\r
for details on the possible return values.\r
@param[out] TargetStatus The status returned by the SCSI target specified\r
- by ScsiIo when the SCSI Request Packat was executed\r
+ by ScsiIo when the SCSI Request Packet was executed\r
on the SCSI Host Controller. See the EFI SCSI I/O\r
Protocol in the UEFI Specification for details on\r
the possible return values. \r
Packet to execute. See HostAdapterStatus, TargetStatus,\r
SenseDataLength, and SenseData in that order for\r
additional status information.\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
\r
**/\r
EFI_STATUS\r
SCSI I/O Protocol in the UEFI Specification\r
for details on the possible return values.\r
@param[out] TargetStatus The status returned by the SCSI target specified\r
- by ScsiIo when the SCSI Request Packat was\r
+ by ScsiIo when the SCSI Request Packet was\r
executed on the SCSI Host Controller.\r
See the EFI SCSI I/O Protocol in the UEFI\r
Specification for details on the possible\r
If Timeout is greater than zero, then this function\r
will return EFI_TIMEOUT if the time required to\r
execute the SCSI Request Packet is greater than Timeout.\r
- @param[in,out] SenseData A pointer to sense data that was generated\r
+ @param[in, out] SenseData A pointer to sense data that was generated\r
by the execution of the SCSI Request Packet.\r
This buffer must be allocated by the caller.\r
If SenseDataLength is 0, then this parameter\r
is optional and may be NULL.\r
- @param[in,out] SenseDataLength On input, the length in bytes of the SenseData buffer.\r
+ @param[in, out] SenseDataLength On input, the length in bytes of the SenseData buffer.\r
On output, the number of bytes written to the SenseData buffer. \r
@param[out] HostAdapterStatus The status of the SCSI Host Controller that\r
produces the SCSI bus containing the SCSI target\r
UEFI Specification for details on the possible\r
return values.\r
@param[out] TargetStatus The status returned by the SCSI target specified\r
- by ScsiIo when the SCSI Request Packat was executed\r
+ by ScsiIo when the SCSI Request Packet was executed\r
on the SCSI Host Controller. See the EFI SCSI\r
I/O Protocol in the UEFI Specification for details\r
on the possible return values.\r
- @param[in,out] DataBuffer A pointer to data that was generated by the\r
+ @param[in, out] DataBuffer A pointer to data that was generated by the\r
execution of the SCSI Request Packet. This\r
buffer must be allocated by the caller. If\r
DataLength is 0, then this parameter is optional\r
and may be NULL. \r
- @param[in,out] DataLength On input, a pointer to the length in bytes of\r
+ @param[in, out] DataLength On input, a pointer to the length in bytes of\r
the DataBuffer buffer. On output, a pointer\r
to the number of bytes written to the DataBuffer\r
buffer. \r
@param[in, out] DataLength The length of data buffer.\r
@param[in] PMI Partial medium indicator.\r
\r
- @retval EFI_SUCCESS Command is executed successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could\r
- not be transferred. The actual number of bytes transferred is returned in DataLength.\r
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many \r
- SCSI Command Packets already queued.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
- @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by \r
- the SCSI initiator(i.e., SCSI Host Controller)\r
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\r
+ @retval EFI_SUCCESS Command is executed successfully.\r
+ @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, but the entire\r
+ DataBuffer could not be transferred. The actual\r
+ number of bytes transferred is returned in DataLength.\r
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because\r
+ there are too many SCSI Command Packets already queued.\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet\r
+ is not supported by the SCSI initiator(i.e., SCSI Host Controller)\r
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\r
\r
**/\r
EFI_STATUS\r
);\r
\r
\r
+/**\r
+ Function to submit read capacity16 command.\r
+\r
+ @param ScsiIo A pointer to SCSI IO protocol.\r
+ @param Timeout The length of timeout period.\r
+ @param SenseData A pointer to output sense data.\r
+ @param SenseDataLength The length of output sense data.\r
+ @param HostAdapterStatus The status of Host Adapter.\r
+ @param TargetStatus The status of the target.\r
+ @param DataBuffer A pointer to a data buffer.\r
+ @param DataLength The length of data buffer.\r
+ @param PMI Partial medium indicator.\r
+\r
+ @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
+**/\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+ScsiReadCapacity16Command (\r
+ IN EFI_SCSI_IO_PROTOCOL *ScsiIo,\r
+ IN UINT64 Timeout,\r
+ IN VOID *SenseData,\r
+ IN OUT UINT8 *SenseDataLength,\r
+ OUT UINT8 *HostAdapterStatus,\r
+ OUT UINT8 *TargetStatus,\r
+ OUT VOID *DataBuffer,\r
+ IN OUT UINT32 *DataLength,\r
+ IN BOOLEAN PMI\r
+ );\r
+\r
+\r
/**\r
Execute Read(10) SCSI command on a specific SCSI target.\r
\r
@param[in] StartLba The start address of LBA.\r
@param[in] SectorSize The sector size.\r
\r
- @retval EFI_SUCCESS Command is executed successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could\r
- not be transferred. The actual number of bytes transferred is returned in DataLength.\r
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many \r
- SCSI Command Packets already queued.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
- @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by \r
- the SCSI initiator(i.e., SCSI Host Controller)\r
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\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
+ not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many \r
+ SCSI Command Packets already queued.\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by \r
+ the SCSI initiator(i.e., SCSI Host Controller)\r
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\r
\r
**/\r
EFI_STATUS\r
@param[in] StartLba The start address of LBA.\r
@param[in] SectorSize The sector size.\r
\r
- @retval EFI_SUCCESS Command is executed successfully.\r
- @retval EFI_WARN_BUFFER_TOO_SMALL The SCSI Request Packet was executed, but the entire DataBuffer could\r
- not be transferred. The actual number of bytes transferred is returned in DataLength.\r
- @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many \r
- SCSI Command Packets already queued.\r
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
- @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by \r
- the SCSI initiator(i.e., SCSI Host Controller)\r
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\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
+ not be transferred. The actual number of bytes transferred is returned in DataLength.\r
+ @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many \r
+ SCSI Command Packets already queued.\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to send SCSI Request Packet.\r
+ @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported by \r
+ the SCSI initiator(i.e., SCSI Host Controller)\r
+ @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.\r
\r
**/\r
EFI_STATUS\r
projects / mirror_edk2.git / blobdiff