]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/UefiScsiLib.h
MdePkg: fix comment typo in DebugLib.h
[mirror_edk2.git] / MdePkg / Include / Library / UefiScsiLib.h
index 26e4aa4e0f02b158aacb585b9cbd65dcb59da097..067acfdb43478898dbd1c6c833093157c2c7dc7e 100644 (file)
@@ -818,4 +818,364 @@ ScsiWrite16Command (
   IN     UINT32                SectorSize\r
   );\r
 \r
+\r
+/**\r
+  Execute blocking/non-blocking Read(10) SCSI command on a specific SCSI\r
+  target.\r
+\r
+  Executes the SCSI Read(10) command on the SCSI target specified by ScsiIo.\r
+  When Event is NULL, blocking command will be executed. Otherwise non-blocking\r
+  command will be executed.\r
+  For blocking I/O, if Timeout is zero, this function will wait indefinitely\r
+  for the command to complete. If Timeout is greater than zero, then the\r
+  command is executed and will timeout after Timeout 100 ns units.\r
+  For non-blocking I/O, if Timeout is zero, Event will be signaled only after\r
+  the command to completes. If Timeout is greater than zero, Event will also be\r
+  signaled after Timeout 100 ns units.\r
+  The StartLba and SectorSize parameters are used to construct the CDB for this\r
+  SCSI command.\r
+\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  If TargetStatus is NULL, then ASSERT().\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  @param[in]      ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]      Timeout              The length of timeout period.\r
+  @param[in, out] SenseData            A pointer to output sense data.\r
+  @param[in, out] SenseDataLength      The length of output sense data.\r
+  @param[out]     HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]     TargetStatus         The status of the target.\r
+  @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 number of contiguous logical blocks\r
+                                       of data that shall be transferred.\r
+  @param[in]      Event                If the SCSI target does not support\r
+                                       non-blocking I/O, then Event is ignored,\r
+                                       and blocking I/O is performed. If Event\r
+                                       is NULL, then blocking I/O is performed.\r
+                                       If Event is not NULL and non-blocking\r
+                                       I/O is supported, then non-blocking I/O\r
+                                       is performed, and Event will be signaled\r
+                                       when the SCSI Read(10) command\r
+                                       completes.\r
+\r
+  @retval  EFI_SUCCESS                 Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE         The SCSI Request Packet was executed,\r
+                                       but the entire DataBuffer could not be\r
+                                       transferred. The actual number of bytes\r
+                                       transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY               The SCSI Request Packet could not be\r
+                                       sent because there are too many SCSI\r
+                                       Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR            A device error occurred while attempting\r
+                                       to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED             The command described by the SCSI\r
+                                       Request Packet is not supported by the\r
+                                       SCSI initiator(i.e., SCSI  Host\r
+                                       Controller)\r
+  @retval  EFI_TIMEOUT                 A timeout occurred while waiting for the\r
+                                       SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER       The contents of the SCSI Request Packet\r
+                                       are invalid.\r
+  @retval  EFI_OUT_OF_RESOURCES        The request could not be completed due\r
+                                       to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ScsiRead10CommandEx (\r
+  IN     EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
+  IN     UINT64                Timeout,\r
+  IN OUT VOID                  *SenseData,   OPTIONAL\r
+  IN OUT UINT8                 *SenseDataLength,\r
+     OUT UINT8                 *HostAdapterStatus,\r
+     OUT UINT8                 *TargetStatus,\r
+  IN OUT VOID                  *DataBuffer,  OPTIONAL\r
+  IN OUT UINT32                *DataLength,\r
+  IN     UINT32                StartLba,\r
+  IN     UINT32                SectorSize,\r
+  IN     EFI_EVENT             Event         OPTIONAL\r
+  );\r
+\r
+\r
+/**\r
+  Execute blocking/non-blocking Write(10) SCSI command on a specific SCSI\r
+  target.\r
+\r
+  Executes the SCSI Write(10) command on the SCSI target specified by ScsiIo.\r
+  When Event is NULL, blocking command will be executed. Otherwise non-blocking\r
+  command will be executed.\r
+  For blocking I/O, if Timeout is zero, this function will wait indefinitely\r
+  for the command to complete. If Timeout is greater than zero, then the\r
+  command is executed and will timeout after Timeout 100 ns units.\r
+  For non-blocking I/O, if Timeout is zero, Event will be signaled only after\r
+  the command to completes. If Timeout is greater than zero, Event will also be\r
+  signaled after Timeout 100 ns units.\r
+  The StartLba and SectorSize parameters are used to construct the CDB for this\r
+  SCSI command.\r
+\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  If TargetStatus is NULL, then ASSERT().\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  @param[in]      ScsiIo               SCSI IO Protocol to use\r
+  @param[in]      Timeout              The length of timeout period.\r
+  @param[in, out] SenseData            A pointer to output sense data.\r
+  @param[in, out] SenseDataLength      The length of output sense data.\r
+  @param[out]     HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]     TargetStatus         The status of the target.\r
+  @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 number of contiguous logical blocks\r
+                                       of data that shall be transferred.\r
+  @param[in]      Event                If the SCSI target does not support\r
+                                       non-blocking I/O, then Event is ignored,\r
+                                       and blocking I/O is performed. If Event\r
+                                       is NULL, then blocking I/O is performed.\r
+                                       If Event is not NULL and non-blocking\r
+                                       I/O is supported, then non-blocking I/O\r
+                                       is performed, and Event will be signaled\r
+                                       when the SCSI Write(10) command\r
+                                       completes.\r
+\r
+  @retval  EFI_SUCCESS                 Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE         The SCSI Request Packet was executed,\r
+                                       but the entire DataBuffer could not be\r
+                                       transferred. The actual number of bytes\r
+                                       transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY               The SCSI Request Packet could not be\r
+                                       sent because there are too many SCSI\r
+                                       Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR            A device error occurred while attempting\r
+                                       to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED             The command described by the SCSI\r
+                                       Request Packet is not supported by the\r
+                                       SCSI initiator(i.e., SCSI  Host\r
+                                       Controller)\r
+  @retval  EFI_TIMEOUT                 A timeout occurred while waiting for the\r
+                                       SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER       The contents of the SCSI Request Packet\r
+                                       are invalid.\r
+  @retval  EFI_OUT_OF_RESOURCES        The request could not be completed due\r
+                                       to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ScsiWrite10CommandEx (\r
+  IN     EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
+  IN     UINT64                Timeout,\r
+  IN OUT VOID                  *SenseData,   OPTIONAL\r
+  IN OUT UINT8                 *SenseDataLength,\r
+     OUT UINT8                 *HostAdapterStatus,\r
+     OUT UINT8                 *TargetStatus,\r
+  IN OUT VOID                  *DataBuffer,  OPTIONAL\r
+  IN OUT UINT32                *DataLength,\r
+  IN     UINT32                StartLba,\r
+  IN     UINT32                SectorSize,\r
+  IN     EFI_EVENT             Event         OPTIONAL\r
+  );\r
+\r
+\r
+/**\r
+  Execute blocking/non-blocking Read(16) SCSI command on a specific SCSI\r
+  target.\r
+\r
+  Executes the SCSI Read(16) command on the SCSI target specified by ScsiIo.\r
+  When Event is NULL, blocking command will be executed. Otherwise non-blocking\r
+  command will be executed.\r
+  For blocking I/O, if Timeout is zero, this function will wait indefinitely\r
+  for the command to complete. If Timeout is greater than zero, then the\r
+  command is executed and will timeout after Timeout 100 ns units.\r
+  For non-blocking I/O, if Timeout is zero, Event will be signaled only after\r
+  the command to completes. If Timeout is greater than zero, Event will also be\r
+  signaled after Timeout 100 ns units.\r
+  The StartLba and SectorSize parameters are used to construct the CDB for this\r
+  SCSI command.\r
+\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  If TargetStatus is NULL, then ASSERT().\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  @param[in]      ScsiIo               A pointer to SCSI IO protocol.\r
+  @param[in]      Timeout              The length of timeout period.\r
+  @param[in, out] SenseData            A pointer to output sense data.\r
+  @param[in, out] SenseDataLength      The length of output sense data.\r
+  @param[out]     HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]     TargetStatus         The status of the target.\r
+  @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 number of contiguous logical blocks\r
+                                       of data that shall be transferred.\r
+  @param[in]      Event                If the SCSI target does not support\r
+                                       non-blocking I/O, then Event is ignored,\r
+                                       and blocking I/O is performed. If Event\r
+                                       is NULL, then blocking I/O is performed.\r
+                                       If Event is not NULL and non-blocking\r
+                                       I/O is supported, then non-blocking I/O\r
+                                       is performed, and Event will be signaled\r
+                                       when the SCSI Read(16) command\r
+                                       completes.\r
+\r
+  @retval  EFI_SUCCESS                 Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE         The SCSI Request Packet was executed,\r
+                                       but the entire DataBuffer could not be\r
+                                       transferred. The actual number of bytes\r
+                                       transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY               The SCSI Request Packet could not be\r
+                                       sent because there are too many SCSI\r
+                                       Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR            A device error occurred while attempting\r
+                                       to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED             The command described by the SCSI\r
+                                       Request Packet is not supported by the\r
+                                       SCSI initiator(i.e., SCSI  Host\r
+                                       Controller)\r
+  @retval  EFI_TIMEOUT                 A timeout occurred while waiting for the\r
+                                       SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER       The contents of the SCSI Request Packet\r
+                                       are invalid.\r
+  @retval  EFI_OUT_OF_RESOURCES        The request could not be completed due\r
+                                       to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ScsiRead16CommandEx (\r
+  IN     EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
+  IN     UINT64                Timeout,\r
+  IN OUT VOID                  *SenseData,   OPTIONAL\r
+  IN OUT UINT8                 *SenseDataLength,\r
+     OUT UINT8                 *HostAdapterStatus,\r
+     OUT UINT8                 *TargetStatus,\r
+  IN OUT VOID                  *DataBuffer,  OPTIONAL\r
+  IN OUT UINT32                *DataLength,\r
+  IN     UINT64                StartLba,\r
+  IN     UINT32                SectorSize,\r
+  IN     EFI_EVENT             Event         OPTIONAL\r
+  );\r
+\r
+\r
+/**\r
+  Execute blocking/non-blocking Write(16) SCSI command on a specific SCSI\r
+  target.\r
+\r
+  Executes the SCSI Write(16) command on the SCSI target specified by ScsiIo.\r
+  When Event is NULL, blocking command will be executed. Otherwise non-blocking\r
+  command will be executed.\r
+  For blocking I/O, if Timeout is zero, this function will wait indefinitely\r
+  for the command to complete. If Timeout is greater than zero, then the\r
+  command is executed and will timeout after Timeout 100 ns units.\r
+  For non-blocking I/O, if Timeout is zero, Event will be signaled only after\r
+  the command to completes. If Timeout is greater than zero, Event will also be\r
+  signaled after Timeout 100 ns units.\r
+  The StartLba and SectorSize parameters are used to construct the CDB for this\r
+  SCSI command.\r
+\r
+  If ScsiIo is NULL, then ASSERT().\r
+  If SenseDataLength is NULL, then ASSERT().\r
+  If HostAdapterStatus is NULL, then ASSERT().\r
+  If TargetStatus is NULL, then ASSERT().\r
+  If DataLength is NULL, then ASSERT().\r
+\r
+  If SenseDataLength is non-zero and SenseData is not NULL, SenseData must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  If DataLength is non-zero and DataBuffer is not NULL, DataBuffer must meet\r
+  buffer alignment requirement defined in EFI_SCSI_IO_PROTOCOL. Otherwise\r
+  EFI_INVALID_PARAMETER gets returned.\r
+\r
+  @param[in]      ScsiIo               SCSI IO Protocol to use\r
+  @param[in]      Timeout              The length of timeout period.\r
+  @param[in, out] SenseData            A pointer to output sense data.\r
+  @param[in, out] SenseDataLength      The length of output sense data.\r
+  @param[out]     HostAdapterStatus    The status of Host Adapter.\r
+  @param[out]     TargetStatus         The status of the target.\r
+  @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 number of contiguous logical blocks\r
+                                       of data that shall be transferred.\r
+  @param[in]      Event                If the SCSI target does not support\r
+                                       non-blocking I/O, then Event is ignored,\r
+                                       and blocking I/O is performed. If Event\r
+                                       is NULL, then blocking I/O is performed.\r
+                                       If Event is not NULL and non-blocking\r
+                                       I/O is supported, then non-blocking I/O\r
+                                       is performed, and Event will be signaled\r
+                                       when the SCSI Write(16) command\r
+                                       completes.\r
+\r
+  @retval  EFI_SUCCESS                 Command is executed successfully.\r
+  @retval  EFI_BAD_BUFFER_SIZE         The SCSI Request Packet was executed,\r
+                                       but the entire DataBuffer could not be\r
+                                       transferred. The actual number of bytes\r
+                                       transferred is returned in DataLength.\r
+  @retval  EFI_NOT_READY               The SCSI Request Packet could not be\r
+                                       sent because there are too many SCSI\r
+                                       Command Packets already queued.\r
+  @retval  EFI_DEVICE_ERROR            A device error occurred while attempting\r
+                                       to send SCSI Request Packet.\r
+  @retval  EFI_UNSUPPORTED             The command described by the SCSI\r
+                                       Request Packet is not supported by the\r
+                                       SCSI initiator(i.e., SCSI  Host\r
+                                       Controller)\r
+  @retval  EFI_TIMEOUT                 A timeout occurred while waiting for the\r
+                                       SCSI Request Packet to execute.\r
+  @retval  EFI_INVALID_PARAMETER       The contents of the SCSI Request Packet\r
+                                       are invalid.\r
+  @retval  EFI_OUT_OF_RESOURCES        The request could not be completed due\r
+                                       to a lack of resources.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ScsiWrite16CommandEx (\r
+  IN     EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
+  IN     UINT64                Timeout,\r
+  IN OUT VOID                  *SenseData,   OPTIONAL\r
+  IN OUT UINT8                 *SenseDataLength,\r
+     OUT UINT8                 *HostAdapterStatus,\r
+     OUT UINT8                 *TargetStatus,\r
+  IN OUT VOID                  *DataBuffer,  OPTIONAL\r
+  IN OUT UINT32                *DataLength,\r
+  IN     UINT64                StartLba,\r
+  IN     UINT32                SectorSize,\r
+  IN     EFI_EVENT             Event         OPTIONAL\r
+  );\r
+\r
 #endif\r