//\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
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
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
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
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
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
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
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
projects / mirror_edk2.git / blobdiff