diff options
Diffstat (limited to 'MdePkg/Include/Library/ScsiLib.h')
| -rw-r--r-- | MdePkg/Include/Library/ScsiLib.h | 188 |
1 files changed, 94 insertions, 94 deletions
diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h index 2087d82ad3..e8b33a08ef 100644 --- a/MdePkg/Include/Library/ScsiLib.h +++ b/MdePkg/Include/Library/ScsiLib.h @@ -24,24 +24,24 @@ #define EFI_SCSI_STALL_1_MILLISECOND 10000
#define EFI_SCSI_STALL_1_SECOND 10000000
-//
-// this macro cannot be directly used by the gBS->Stall(),
-// since the value output by this macro is in 100ns unit,
-// not 1us unit (1us = 1000ns)
-//
+///
+/// this macro cannot be directly used by the gBS->Stall(),
+/// since the value output by this macro is in 100ns unit,
+/// not 1us unit (1us = 1000ns)
+///
#define EfiScsiStallSeconds(a) ((a) * EFI_SCSI_STALL_1_SECOND)
-/** +/**
Function test the ready status of the SCSI unit.
- - @param[in] ScsiIo A pointer to SCSI IO protocol. - @param[in] Timeout The length of timeout period. - @param[out] SenseData A pointer to output sense data. - @param[out] SenseDataLength The length of output sense data. - @param[out] HostAdapterStatus The status of Host Adapter. - @param[out] TargetStatus The status of the target. - +
+ @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[out] SenseData A pointer to output sense data.
+ @param[out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -58,7 +58,7 @@ Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -72,19 +72,19 @@ ScsiTestUnitReadyCommand ( );
-/** +/**
Function to submit SCSI inquiry command.
- - @param[in] ScsiIo SCSI IO Protocol to use - @param[in] Timeout The length of timeout period. - @param[in] 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. - +
+ @param[in] ScsiIo SCSI IO Protocol to use
+ @param[in] Timeout The length of timeout period.
+ @param[in] SenseData A pointer to output sense data.
+ @param[in out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[in out] InquirydataBuffer A pointer to inquiry data buffer.
+ @param[in out] InquiryDataLength The length of inquiry data buffer.
+ @param[in] EnableVitalProductData Boolean to enable Vital Product Data.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -101,7 +101,7 @@ ScsiTestUnitReadyCommand ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -118,21 +118,21 @@ ScsiInquiryCommand ( );
-/** +/**
Function to submit SCSI mode sense 10 command.
- - @param[in] ScsiIo A pointer to SCSI IO protocol. - @param[in] Timeout The length of timeout period. - @param[in] 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. - +
+ @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[in] SenseData A pointer to output sense data.
+ @param[in out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[in] DataBuffer A pointer to input data buffer.
+ @param[in out] DataLength The length of input data buffer.
+ @param[in] DBDField The DBD Field (Optional).
+ @param[in] PageControl Page Control.
+ @param[in] PageCode Page code.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -149,7 +149,7 @@ ScsiInquiryCommand ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -169,7 +169,7 @@ ScsiModeSense10Command ( -/** +/**
Function to submit SCSI request sense command.
ScsiIo - A pointer to SCSI IO protocol.
Timeout - The length of timeout period.
@@ -177,15 +177,15 @@ ScsiModeSense10Command ( SenseDataLength - The length of output sense data.
HostAdapterStatus - The status of Host Adapter.
TargetStatus - The status of the target.
- - @param[in] ScsiIo SCSI IO Protocol to use - @param[in] Timeout TODO: - @param[in] SenseData TODO: - @param[in out] SenseDataLength TODO: - @param[out] HostAdapterStatus TODO: - @param[out] TargetStatus TODO: - - @retval EFI_SUCCESS Valid data returned +
+ @param[in] ScsiIo SCSI IO Protocol to use
+ @param[in] Timeout TODO:
+ @param[in] SenseData TODO:
+ @param[in out] SenseDataLength TODO:
+ @param[out] HostAdapterStatus TODO:
+ @param[out] TargetStatus TODO:
+
+ @retval EFI_SUCCESS Valid data returned
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -202,7 +202,7 @@ ScsiModeSense10Command ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -216,19 +216,19 @@ ScsiRequestSenseCommand ( );
-/** +/**
Function to submit read capacity command.
- @param[in] ScsiIo A pointer to SCSI IO protocol. - @param[in] Timeout The length of timeout period. - @param[in] 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. - + @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[in] SenseData A pointer to output sense data.
+ @param[in out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[out] DataBuffer A pointer to a data buffer.
+ @param[in out] DataLength The length of data buffer.
+ @param[in] PMI Partial medium indicator.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -245,7 +245,7 @@ ScsiRequestSenseCommand ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -262,20 +262,20 @@ ScsiReadCapacityCommand ( );
-/** +/**
Function to submit read 10 command.
- - @param[in] ScsiIo A pointer to SCSI IO protocol. - @param[in] Timeout The length of timeout period. - @param[in] 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. - +
+ @param[in] ScsiIo A pointer to SCSI IO protocol.
+ @param[in] Timeout The length of timeout period.
+ @param[in] SenseData A pointer to output sense data.
+ @param[in out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[out] DataBuffer Read 10 command data.
+ @param[in out] DataLength The length of data buffer.
+ @param[in] StartLba The start address of LBA.
+ @param[in] SectorSize The sector size.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -292,7 +292,7 @@ ScsiReadCapacityCommand ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
@@ -310,20 +310,20 @@ ScsiRead10Command ( );
-/** +/**
Function to submit SCSI write 10 command.
- - @param[in] ScsiIo SCSI IO Protocol to use - @param[in] Timeout The length of timeout period. - @param[in] 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. - +
+ @param[in] ScsiIo SCSI IO Protocol to use
+ @param[in] Timeout The length of timeout period.
+ @param[in] SenseData A pointer to output sense data.
+ @param[in out] SenseDataLength The length of output sense data.
+ @param[out] HostAdapterStatus The status of Host Adapter.
+ @param[out] TargetStatus The status of the target.
+ @param[out] DataBuffer A pointer to a data buffer.
+ @param[in out] DataLength The length of data buffer.
+ @param[in] StartLba The start address of LBA.
+ @param[in] SectorSize The sector size.
+
@retval EFI_SUCCESS The status of the unit is tested successfully.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
@@ -340,7 +340,7 @@ ScsiRead10Command ( Host Controller).
@retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
Request Packet to execute.
- +
**/
EFI_STATUS
EFIAPI
|