4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_EXT_SCSI_PASS_THRU_PROTOCOL as defined in UEFI 2.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This protocol provides services that allow SCSI Pass Thru commands
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be sent to SCSI devices attached to a SCSI channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x143b7632, 0xb81b, 0x4cb7, {0xab, 0xd3, 0xb6, 0x25, 0xa5, 0xb9, 0xbf, 0xfe } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL 0x0002
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_NONBLOCKIO 0x0004
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// DataDirection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// HostAdapterStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND 0x09
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT 0x0b
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_MESSAGE_REJECT 0x0d
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET 0x0e
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PARITY_ERROR 0x0f
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED 0x10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT 0x11
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN 0x12
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_FREE 0x13
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR 0x14
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// TargetStatus
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION 0x02
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_CONDITION_MET 0x04
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE 0x10
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE_CONDITION_MET 0x14
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_RESERVATION_CONFLICT 0x18
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_TASK_SET_FULL 0x28
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED 0x40
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The Target ID of the host adapter on the SCSI channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Additional information on the attributes of the SCSI channel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Supplies the alignment requirement for any buffer used in a data transfer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timeout, in 100 ns units, to use for the execution of this SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Request Packet. A Timeout value of 0 means that this function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// will wait indefinitely for the SCSI Request Packet to execute. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Timeout is greater than zero, then this function will return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_TIMEOUT if the time required to execute the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Request Packet is greater than Timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the data buffer to transfer between the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// controller and the SCSI device for read and bidirectional commands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the data buffer to transfer between the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// controller and the SCSI device for write or bidirectional commands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to the sense data that was generated by the execution of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A pointer to buffer that contains the Command Data Block to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// send to the SCSI device specified by Target and Lun.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On Input, the size, in bytes, of InDataBuffer. On output, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// number of bytes transferred between the SCSI controller and the SCSI device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On Input, the size, in bytes of OutDataBuffer. On Output, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of bytes transferred between SCSI Controller and the SCSI device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length, in bytes, of the buffer Cdb. The standard values are 6,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// 10, 12, and 16, but other values are possible if a variable length CDB is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The direction of the data transfer. 0 for reads, 1 for writes. A
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value of 2 is Reserved for Bi-Directional SCSI commands.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The status of the host adapter specified by This when the SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Request Packet was executed on the target device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The status returned by the device specified by Target and Lun
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// when the SCSI Request Packet was executed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On input, the length in bytes of the SenseData buffer. On
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// output, the number of bytes written to the SenseData buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync nonblocking I/O functionality is optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Target The Target is an array of size TARGET_MAX_BYTES and it represents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the id of the SCSI device to send the SCSI Request Packet. Each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transport driver may choose to utilize a subset of this size to suit the needs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of transport target representation. For example, a Fibre Channel driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync may use only 8 bytes (WWN) to represent an FC target.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Lun The LUN of the SCSI device to send the SCSI Request Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet A pointer to the SCSI Request Packet to send to the SCSI device
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Target and Lun.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Event If nonblocking I/O is not supported then Event is ignored, and blocking
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync I/O is performed. If Event is NULL, then blocking I/O is performed. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Event is not NULL and non blocking I/O is supported, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync nonblocking I/O is performed, and Event will be signaled when the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Request Packet completes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync commands, InTransferLength bytes were transferred from
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InDataBuffer. For write and bi-directional commands,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutTransferLength bytes were transferred by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OutDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could be transferred is returned in InTransferLength. For write
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and bi-directional commands, OutTransferLength bytes were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transferred by OutDataBuffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SCSI Request Packets already queued. The caller may retry again later.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the host adapter. This includes the case of Bi-directional SCSI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync commands not supported by the implementation. The SCSI Request
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Packet was not sent, so no additional status information is available.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal