| /** @file | |
| EFI_EXT_SCSI_PASS_THRU_PROTOCOL as defined in UEFI 2.0. | |
| This protocol provides services that allow SCSI Pass Thru commands | |
| to be sent to SCSI devices attached to a SCSI channel. | |
| Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> | |
| SPDX-License-Identifier: BSD-2-Clause-Patent | |
| **/ | |
| #ifndef __EXT_SCSI_PASS_THROUGH_PROTOCOL_H__ | |
| #define __EXT_SCSI_PASS_THROUGH_PROTOCOL_H__ | |
| #define EFI_EXT_SCSI_PASS_THRU_PROTOCOL_GUID \ | |
| { \ | |
| 0x143b7632, 0xb81b, 0x4cb7, {0xab, 0xd3, 0xb6, 0x25, 0xa5, 0xb9, 0xbf, 0xfe } \ | |
| } | |
| typedef struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL EFI_EXT_SCSI_PASS_THRU_PROTOCOL; | |
| #define TARGET_MAX_BYTES 0x10 | |
| #define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001 | |
| #define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL 0x0002 | |
| #define EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_NONBLOCKIO 0x0004 | |
| // | |
| // DataDirection | |
| // | |
| #define EFI_EXT_SCSI_DATA_DIRECTION_READ 0 | |
| #define EFI_EXT_SCSI_DATA_DIRECTION_WRITE 1 | |
| #define EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL 2 | |
| // | |
| // HostAdapterStatus | |
| // | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK 0x00 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND 0x09 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT 0x0b | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_MESSAGE_REJECT 0x0d | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET 0x0e | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PARITY_ERROR 0x0f | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED 0x10 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT 0x11 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN 0x12 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_FREE 0x13 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_PHASE_ERROR 0x14 | |
| #define EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER 0x7f | |
| // | |
| // TargetStatus | |
| // | |
| #define EFI_EXT_SCSI_STATUS_TARGET_GOOD 0x00 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_CHECK_CONDITION 0x02 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_CONDITION_MET 0x04 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_BUSY 0x08 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE 0x10 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_INTERMEDIATE_CONDITION_MET 0x14 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_RESERVATION_CONFLICT 0x18 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_TASK_SET_FULL 0x28 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_ACA_ACTIVE 0x30 | |
| #define EFI_EXT_SCSI_STATUS_TARGET_TASK_ABORTED 0x40 | |
| typedef struct { | |
| /// | |
| /// The Target ID of the host adapter on the SCSI channel. | |
| /// | |
| UINT32 AdapterId; | |
| /// | |
| /// Additional information on the attributes of the SCSI channel. | |
| /// | |
| UINT32 Attributes; | |
| /// | |
| /// Supplies the alignment requirement for any buffer used in a data transfer. | |
| /// | |
| UINT32 IoAlign; | |
| } EFI_EXT_SCSI_PASS_THRU_MODE; | |
| typedef struct { | |
| /// | |
| /// The timeout, in 100 ns units, to use for the execution of this SCSI | |
| /// Request Packet. A Timeout value of 0 means that this function | |
| /// will wait indefinitely for the SCSI Request Packet to execute. If | |
| /// Timeout is greater than zero, then this function will return | |
| /// EFI_TIMEOUT if the time required to execute the SCSI | |
| /// Request Packet is greater than Timeout. | |
| /// | |
| UINT64 Timeout; | |
| /// | |
| /// A pointer to the data buffer to transfer between the SCSI | |
| /// controller and the SCSI device for read and bidirectional commands. | |
| /// | |
| VOID *InDataBuffer; | |
| /// | |
| /// A pointer to the data buffer to transfer between the SCSI | |
| /// controller and the SCSI device for write or bidirectional commands. | |
| /// | |
| VOID *OutDataBuffer; | |
| /// | |
| /// A pointer to the sense data that was generated by the execution of | |
| /// the SCSI Request Packet. | |
| /// | |
| VOID *SenseData; | |
| /// | |
| /// A pointer to buffer that contains the Command Data Block to | |
| /// send to the SCSI device specified by Target and Lun. | |
| /// | |
| VOID *Cdb; | |
| /// | |
| /// On Input, the size, in bytes, of InDataBuffer. On output, the | |
| /// number of bytes transferred between the SCSI controller and the SCSI device. | |
| /// | |
| UINT32 InTransferLength; | |
| /// | |
| /// On Input, the size, in bytes of OutDataBuffer. On Output, the | |
| /// Number of bytes transferred between SCSI Controller and the SCSI device. | |
| /// | |
| UINT32 OutTransferLength; | |
| /// | |
| /// The length, in bytes, of the buffer Cdb. The standard values are 6, | |
| /// 10, 12, and 16, but other values are possible if a variable length CDB is used. | |
| /// | |
| UINT8 CdbLength; | |
| /// | |
| /// The direction of the data transfer. 0 for reads, 1 for writes. A | |
| /// value of 2 is Reserved for Bi-Directional SCSI commands. | |
| /// | |
| UINT8 DataDirection; | |
| /// | |
| /// The status of the host adapter specified by This when the SCSI | |
| /// Request Packet was executed on the target device. | |
| /// | |
| UINT8 HostAdapterStatus; | |
| /// | |
| /// The status returned by the device specified by Target and Lun | |
| /// when the SCSI Request Packet was executed. | |
| /// | |
| UINT8 TargetStatus; | |
| /// | |
| /// On input, the length in bytes of the SenseData buffer. On | |
| /// output, the number of bytes written to the SenseData buffer. | |
| /// | |
| UINT8 SenseDataLength; | |
| } EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET; | |
| /** | |
| Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function | |
| supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the | |
| nonblocking I/O functionality is optional. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param Target The Target is an array of size TARGET_MAX_BYTES and it represents | |
| the id of the SCSI device to send the SCSI Request Packet. Each | |
| transport driver may choose to utilize a subset of this size to suit the needs | |
| of transport target representation. For example, a Fibre Channel driver | |
| may use only 8 bytes (WWN) to represent an FC target. | |
| @param Lun The LUN of the SCSI device to send the SCSI Request Packet. | |
| @param Packet A pointer to the SCSI Request Packet to send to the SCSI device | |
| specified by Target and Lun. | |
| @param Event If nonblocking I/O is not supported then Event is ignored, and blocking | |
| I/O is performed. If Event is NULL, then blocking I/O is performed. If | |
| Event is not NULL and non blocking I/O is supported, then | |
| nonblocking I/O is performed, and Event will be signaled when the | |
| SCSI Request Packet completes. | |
| @retval EFI_SUCCESS The SCSI Request Packet was sent by the host. For bi-directional | |
| commands, InTransferLength bytes were transferred from | |
| InDataBuffer. For write and bi-directional commands, | |
| OutTransferLength bytes were transferred by | |
| OutDataBuffer. | |
| @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was not executed. The number of bytes that | |
| could be transferred is returned in InTransferLength. For write | |
| and bi-directional commands, OutTransferLength bytes were | |
| transferred by OutDataBuffer. | |
| @retval EFI_NOT_READY The SCSI Request Packet could not be sent because there are too many | |
| SCSI Request Packets already queued. The caller may retry again later. | |
| @retval EFI_DEVICE_ERROR A device error occurred while attempting to send the SCSI Request | |
| Packet. | |
| @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket are invalid. | |
| @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet is not supported | |
| by the host adapter. This includes the case of Bi-directional SCSI | |
| commands not supported by the implementation. The SCSI Request | |
| Packet was not sent, so no additional status information is available. | |
| @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI Request Packet to execute. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_PASSTHRU)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN UINT8 *Target, | |
| IN UINT64 Lun, | |
| IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, | |
| IN EFI_EVENT Event OPTIONAL | |
| ); | |
| /** | |
| Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These | |
| can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal | |
| Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the | |
| Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI | |
| channel. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param Target On input, a pointer to the Target ID (an array of size | |
| TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. | |
| On output, a pointer to the Target ID (an array of | |
| TARGET_MAX_BYTES) of the next SCSI device present on a SCSI | |
| channel. An input value of 0xF(all bytes in the array are 0xF) in the | |
| Target array retrieves the Target ID of the first SCSI device present on a | |
| SCSI channel. | |
| @param Lun On input, a pointer to the LUN of a SCSI device present on the SCSI | |
| channel. On output, a pointer to the LUN of the next SCSI device present | |
| on a SCSI channel. | |
| @retval EFI_SUCCESS The Target ID and LUN of the next SCSI device on the SCSI | |
| channel was returned in Target and Lun. | |
| @retval EFI_INVALID_PARAMETER Target array is not all 0xF, and Target and Lun were | |
| not returned on a previous call to GetNextTargetLun(). | |
| @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN OUT UINT8 **Target, | |
| IN OUT UINT64 *Lun | |
| ); | |
| /** | |
| Used to allocate and build a device path node for a SCSI device on a SCSI channel. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param Target The Target is an array of size TARGET_MAX_BYTES and it specifies the | |
| Target ID of the SCSI device for which a device path node is to be | |
| allocated and built. Transport drivers may chose to utilize a subset of | |
| this size to suit the representation of targets. For example, a Fibre | |
| Channel driver may use only 8 bytes (WWN) in the array to represent a | |
| FC target. | |
| @param Lun The LUN of the SCSI device for which a device path node is to be | |
| allocated and built. | |
| @param DevicePath A pointer to a single device path node that describes the SCSI device | |
| specified by Target and Lun. This function is responsible for | |
| allocating the buffer DevicePath with the boot service | |
| AllocatePool(). It is the caller's responsibility to free | |
| DevicePath when the caller is finished with DevicePath. | |
| @retval EFI_SUCCESS The device path node that describes the SCSI device specified by | |
| Target and Lun was allocated and returned in | |
| DevicePath. | |
| @retval EFI_INVALID_PARAMETER DevicePath is NULL. | |
| @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does not exist | |
| on the SCSI channel. | |
| @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate DevicePath. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_BUILD_DEVICE_PATH)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN UINT8 *Target, | |
| IN UINT64 Lun, | |
| OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath | |
| ); | |
| /** | |
| Used to translate a device path node to a Target ID and LUN. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param DevicePath A pointer to a single device path node that describes the SCSI device | |
| on the SCSI channel. | |
| @param Target A pointer to the Target Array which represents the ID of a SCSI device | |
| on the SCSI channel. | |
| @param Lun A pointer to the LUN of a SCSI device on the SCSI channel. | |
| @retval EFI_SUCCESS DevicePath was successfully translated to a Target ID and | |
| LUN, and they were returned in Target and Lun. | |
| @retval EFI_INVALID_PARAMETER DevicePath or Target or Lun is NULL. | |
| @retval EFI_NOT_FOUND A valid translation from DevicePath to a Target ID and LUN | |
| does not exist. | |
| @retval EFI_UNSUPPORTED This driver does not support the device path node type in | |
| DevicePath. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_TARGET_LUN)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, | |
| OUT UINT8 **Target, | |
| OUT UINT64 *Lun | |
| ); | |
| /** | |
| Resets a SCSI channel. This operation resets all the SCSI devices connected to the SCSI channel. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @retval EFI_SUCCESS The SCSI channel was reset. | |
| @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI channel. | |
| @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI channel. | |
| @retval EFI_UNSUPPORTED The SCSI channel does not support a channel reset operation. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This | |
| ); | |
| /** | |
| Resets a SCSI logical unit that is connected to a SCSI channel. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param Target The Target is an array of size TARGET_MAX_BYTE and it represents the | |
| target port ID of the SCSI device containing the SCSI logical unit to | |
| reset. Transport drivers may chose to utilize a subset of this array to suit | |
| the representation of their targets. | |
| @param Lun The LUN of the SCSI device to reset. | |
| @retval EFI_SUCCESS The SCSI device specified by Target and Lun was reset. | |
| @retval EFI_INVALID_PARAMETER Target or Lun is NULL. | |
| @retval EFI_TIMEOUT A timeout occurred while attempting to reset the SCSI device | |
| specified by Target and Lun. | |
| @retval EFI_UNSUPPORTED The SCSI channel does not support a target reset operation. | |
| @retval EFI_DEVICE_ERROR A device error occurred while attempting to reset the SCSI device | |
| specified by Target and Lun. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_RESET_TARGET_LUN)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN UINT8 *Target, | |
| IN UINT64 Lun | |
| ); | |
| /** | |
| Used to retrieve the list of legal Target IDs for SCSI devices on a SCSI channel. These can either | |
| be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target IDs | |
| for the SCSI channel. Regardless, the caller of this function must probe the Target ID returned to | |
| see if a SCSI device is actually present at that location on the SCSI channel. | |
| @param This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. | |
| @param Target (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. | |
| On output, a pointer to the Target ID (an array of | |
| TARGET_MAX_BYTES) of the next SCSI device present on a SCSI | |
| channel. An input value of 0xF(all bytes in the array are 0xF) in the | |
| Target array retrieves the Target ID of the first SCSI device present on a | |
| SCSI channel. | |
| @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI | |
| channel was returned in Target. | |
| @retval EFI_INVALID_PARAMETER Target or Lun is NULL. | |
| @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not | |
| returned on a previous call to GetNextTarget(). | |
| @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel. | |
| **/ | |
| typedef | |
| EFI_STATUS | |
| (EFIAPI *EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET)( | |
| IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, | |
| IN OUT UINT8 **Target | |
| ); | |
| /// | |
| /// The EFI_EXT_SCSI_PASS_THRU_PROTOCOL provides information about a SCSI channel | |
| /// and the ability to send SCI Request Packets to any SCSI device attached to | |
| /// that SCSI channel. The information includes the Target ID of the host controller | |
| /// on the SCSI channel and the attributes of the SCSI channel. | |
| /// | |
| struct _EFI_EXT_SCSI_PASS_THRU_PROTOCOL { | |
| /// | |
| /// A pointer to the EFI_EXT_SCSI_PASS_THRU_MODE data for this SCSI channel. | |
| /// | |
| EFI_EXT_SCSI_PASS_THRU_MODE *Mode; | |
| EFI_EXT_SCSI_PASS_THRU_PASSTHRU PassThru; | |
| EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET_LUN GetNextTargetLun; | |
| EFI_EXT_SCSI_PASS_THRU_BUILD_DEVICE_PATH BuildDevicePath; | |
| EFI_EXT_SCSI_PASS_THRU_GET_TARGET_LUN GetTargetLun; | |
| EFI_EXT_SCSI_PASS_THRU_RESET_CHANNEL ResetChannel; | |
| EFI_EXT_SCSI_PASS_THRU_RESET_TARGET_LUN ResetTargetLun; | |
| EFI_EXT_SCSI_PASS_THRU_GET_NEXT_TARGET GetNextTarget; | |
| }; | |
| extern EFI_GUID gEfiExtScsiPassThruProtocolGuid; | |
| #endif |