Ronak Kanabar | 1ae366f | 2023-06-07 01:21:56 +0530 | [diff] [blame^] | 1 | /** @file |
| 2 | EFI_SCSI_IO_PROTOCOL as defined in UEFI 2.0. |
| 3 | This protocol is used by code, typically drivers, running in the EFI boot |
| 4 | services environment to access SCSI devices. In particular, functions for |
| 5 | managing devices on SCSI buses are defined here. |
| 6 | |
| 7 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> |
| 8 | SPDX-License-Identifier: BSD-2-Clause-Patent |
| 9 | |
| 10 | **/ |
| 11 | |
| 12 | #ifndef __EFI_SCSI_IO_PROTOCOL_H__ |
| 13 | #define __EFI_SCSI_IO_PROTOCOL_H__ |
| 14 | |
| 15 | #define EFI_SCSI_IO_PROTOCOL_GUID \ |
| 16 | { \ |
| 17 | 0x932f47e6, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \ |
| 18 | } |
| 19 | |
| 20 | /// |
| 21 | /// Forward reference for pure ANSI compatability |
| 22 | /// |
| 23 | typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL; |
| 24 | |
| 25 | // |
| 26 | // SCSI Device type information, defined in the SCSI Primary Commands standard (e.g., SPC-4) |
| 27 | // |
| 28 | #define EFI_SCSI_IO_TYPE_DISK 0x00 ///< Disk device |
| 29 | #define EFI_SCSI_IO_TYPE_TAPE 0x01 ///< Tape device |
| 30 | #define EFI_SCSI_IO_TYPE_PRINTER 0x02 ///< Printer |
| 31 | #define EFI_SCSI_IO_TYPE_PROCESSOR 0x03 ///< Processor |
| 32 | #define EFI_SCSI_IO_TYPE_WORM 0x04 ///< Write-once read-multiple |
| 33 | #define EFI_SCSI_IO_TYPE_CDROM 0x05 ///< CD or DVD device |
| 34 | #define EFI_SCSI_IO_TYPE_SCANNER 0x06 ///< Scanner device |
| 35 | #define EFI_SCSI_IO_TYPE_OPTICAL 0x07 ///< Optical memory device |
| 36 | #define EFI_SCSI_IO_TYPE_MEDIUMCHANGER 0x08 ///< Medium Changer device |
| 37 | #define EFI_SCSI_IO_TYPE_COMMUNICATION 0x09 ///< Communications device |
| 38 | #define MFI_SCSI_IO_TYPE_A 0x0A ///< Obsolete |
| 39 | #define MFI_SCSI_IO_TYPE_B 0x0B ///< Obsolete |
| 40 | #define MFI_SCSI_IO_TYPE_RAID 0x0C ///< Storage array controller device (e.g., RAID) |
| 41 | #define MFI_SCSI_IO_TYPE_SES 0x0D ///< Enclosure services device |
| 42 | #define MFI_SCSI_IO_TYPE_RBC 0x0E ///< Simplified direct-access device (e.g., magnetic disk) |
| 43 | #define MFI_SCSI_IO_TYPE_OCRW 0x0F ///< Optical card reader/writer device |
| 44 | #define MFI_SCSI_IO_TYPE_BRIDGE 0x10 ///< Bridge Controller Commands |
| 45 | #define MFI_SCSI_IO_TYPE_OSD 0x11 ///< Object-based Storage Device |
| 46 | #define EFI_SCSI_IO_TYPE_RESERVED_LOW 0x12 ///< Reserved (low) |
| 47 | #define EFI_SCSI_IO_TYPE_RESERVED_HIGH 0x1E ///< Reserved (high) |
| 48 | #define EFI_SCSI_IO_TYPE_UNKNOWN 0x1F ///< Unknown no device type |
| 49 | |
| 50 | // |
| 51 | // SCSI Data Direction definition |
| 52 | // |
| 53 | #define EFI_SCSI_IO_DATA_DIRECTION_READ 0 |
| 54 | #define EFI_SCSI_IO_DATA_DIRECTION_WRITE 1 |
| 55 | #define EFI_SCSI_IO_DATA_DIRECTION_BIDIRECTIONAL 2 |
| 56 | |
| 57 | // |
| 58 | // SCSI Host Adapter Status definition |
| 59 | // |
| 60 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK 0x00 |
| 61 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND 0x09 ///< timeout when processing the command |
| 62 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT 0x0b ///< timeout when waiting for the command processing |
| 63 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT 0x0d ///< a message reject was received when processing command |
| 64 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET 0x0e ///< a bus reset was detected |
| 65 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR 0x0f |
| 66 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED 0x10 ///< the adapter failed in issuing request sense command |
| 67 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT 0x11 ///< selection timeout |
| 68 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN 0x12 ///< data overrun or data underrun |
| 69 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE 0x13 ///< Unexepected bus free |
| 70 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR 0x14 ///< Target bus phase sequence failure |
| 71 | #define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER 0x7f |
| 72 | |
| 73 | // |
| 74 | // SCSI Target Status definition |
| 75 | // |
| 76 | #define EFI_SCSI_IO_STATUS_TARGET_GOOD 0x00 |
| 77 | #define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION 0x02 ///< check condition |
| 78 | #define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET 0x04 ///< condition met |
| 79 | #define EFI_SCSI_IO_STATUS_TARGET_BUSY 0x08 ///< busy |
| 80 | #define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE 0x10 ///< intermediate |
| 81 | #define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET 0x14 ///< intermediate-condition met |
| 82 | #define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT 0x18 ///< reservation conflict |
| 83 | #define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED 0x22 ///< command terminated |
| 84 | #define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL 0x28 ///< queue full |
| 85 | |
| 86 | typedef struct { |
| 87 | /// |
| 88 | /// The timeout, in 100 ns units, to use for the execution of this SCSI |
| 89 | /// Request Packet. A Timeout value of 0 means that this function |
| 90 | /// will wait indefinitely for the SCSI Request Packet to execute. If |
| 91 | /// Timeout is greater than zero, then this function will return |
| 92 | /// EFI_TIMEOUT if the time required to execute the SCSI Request |
| 93 | /// Packet is greater than Timeout. |
| 94 | /// |
| 95 | UINT64 Timeout; |
| 96 | /// |
| 97 | /// A pointer to the data buffer to transfer between the SCSI |
| 98 | /// controller and the SCSI device for SCSI READ command |
| 99 | /// |
| 100 | VOID *InDataBuffer; |
| 101 | /// |
| 102 | /// A pointer to the data buffer to transfer between the SCSI |
| 103 | /// controller and the SCSI device for SCSI WRITE command. |
| 104 | /// |
| 105 | VOID *OutDataBuffer; |
| 106 | /// |
| 107 | /// A pointer to the sense data that was generated by the execution of |
| 108 | /// the SCSI Request Packet. |
| 109 | /// |
| 110 | VOID *SenseData; |
| 111 | /// |
| 112 | /// A pointer to buffer that contains the Command Data Block to |
| 113 | /// send to the SCSI device. |
| 114 | /// |
| 115 | VOID *Cdb; |
| 116 | /// |
| 117 | /// On Input, the size, in bytes, of InDataBuffer. On output, the |
| 118 | /// number of bytes transferred between the SCSI controller and the SCSI device. |
| 119 | /// |
| 120 | UINT32 InTransferLength; |
| 121 | /// |
| 122 | /// On Input, the size, in bytes of OutDataBuffer. On Output, the |
| 123 | /// Number of bytes transferred between SCSI Controller and the SCSI device. |
| 124 | /// |
| 125 | UINT32 OutTransferLength; |
| 126 | /// |
| 127 | /// The length, in bytes, of the buffer Cdb. The standard values are |
| 128 | /// 6, 10, 12, and 16, but other values are possible if a variable length CDB is used. |
| 129 | /// |
| 130 | UINT8 CdbLength; |
| 131 | /// |
| 132 | /// The direction of the data transfer. 0 for reads, 1 for writes. A |
| 133 | /// value of 2 is Reserved for Bi-Directional SCSI commands. |
| 134 | /// |
| 135 | UINT8 DataDirection; |
| 136 | /// |
| 137 | /// The status of the SCSI Host Controller that produces the SCSI |
| 138 | /// bus where the SCSI device attached when the SCSI Request |
| 139 | /// Packet was executed on the SCSI Controller. |
| 140 | /// |
| 141 | UINT8 HostAdapterStatus; |
| 142 | /// |
| 143 | /// The status returned by the SCSI device when the SCSI Request |
| 144 | /// Packet was executed. |
| 145 | /// |
| 146 | UINT8 TargetStatus; |
| 147 | /// |
| 148 | /// On input, the length in bytes of the SenseData buffer. On |
| 149 | /// output, the number of bytes written to the SenseData buffer. |
| 150 | /// |
| 151 | UINT8 SenseDataLength; |
| 152 | } EFI_SCSI_IO_SCSI_REQUEST_PACKET; |
| 153 | |
| 154 | /** |
| 155 | Retrieves the device type information of the SCSI Controller. |
| 156 | |
| 157 | @param This Protocol instance pointer. |
| 158 | @param DeviceType A pointer to the device type information |
| 159 | retrieved from the SCSI Controller. |
| 160 | |
| 161 | @retval EFI_SUCCESS Retrieved the device type information successfully. |
| 162 | @retval EFI_INVALID_PARAMETER The DeviceType is NULL. |
| 163 | |
| 164 | **/ |
| 165 | typedef |
| 166 | EFI_STATUS |
| 167 | (EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE)( |
| 168 | IN EFI_SCSI_IO_PROTOCOL *This, |
| 169 | OUT UINT8 *DeviceType |
| 170 | ); |
| 171 | |
| 172 | /** |
| 173 | Retrieves the device location in the SCSI channel. |
| 174 | |
| 175 | @param This Protocol instance pointer. |
| 176 | @param Target A pointer to the Target ID of a SCSI device |
| 177 | on the SCSI channel. |
| 178 | @param Lun A pointer to the LUN of the SCSI device on |
| 179 | the SCSI channel. |
| 180 | |
| 181 | @retval EFI_SUCCESS Retrieves the device location successfully. |
| 182 | @retval EFI_INVALID_PARAMETER The Target or Lun is NULL. |
| 183 | |
| 184 | **/ |
| 185 | typedef |
| 186 | EFI_STATUS |
| 187 | (EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION)( |
| 188 | IN EFI_SCSI_IO_PROTOCOL *This, |
| 189 | IN OUT UINT8 **Target, |
| 190 | OUT UINT64 *Lun |
| 191 | ); |
| 192 | |
| 193 | /** |
| 194 | Resets the SCSI Bus that the SCSI Controller is attached to. |
| 195 | |
| 196 | @param This Protocol instance pointer. |
| 197 | |
| 198 | @retval EFI_SUCCESS The SCSI bus is reset successfully. |
| 199 | @retval EFI_DEVICE_ERROR Errors encountered when resetting the SCSI bus. |
| 200 | @retval EFI_UNSUPPORTED The bus reset operation is not supported by the |
| 201 | SCSI Host Controller. |
| 202 | @retval EFI_TIMEOUT A timeout occurred while attempting to reset |
| 203 | the SCSI bus. |
| 204 | |
| 205 | **/ |
| 206 | typedef |
| 207 | EFI_STATUS |
| 208 | (EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_BUS)( |
| 209 | IN EFI_SCSI_IO_PROTOCOL *This |
| 210 | ); |
| 211 | |
| 212 | /** |
| 213 | Resets the SCSI Controller that the device handle specifies. |
| 214 | |
| 215 | @param This Protocol instance pointer. |
| 216 | |
| 217 | @retval EFI_SUCCESS Reset the SCSI controller successfully. |
| 218 | @retval EFI_DEVICE_ERROR Errors were encountered when resetting the |
| 219 | SCSI Controller. |
| 220 | @retval EFI_UNSUPPORTED The SCSI bus does not support a device |
| 221 | reset operation. |
| 222 | @retval EFI_TIMEOUT A timeout occurred while attempting to |
| 223 | reset the SCSI Controller. |
| 224 | |
| 225 | **/ |
| 226 | typedef |
| 227 | EFI_STATUS |
| 228 | (EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_DEVICE)( |
| 229 | IN EFI_SCSI_IO_PROTOCOL *This |
| 230 | ); |
| 231 | |
| 232 | /** |
| 233 | Sends a SCSI Request Packet to the SCSI Controller for execution. |
| 234 | |
| 235 | @param This Protocol instance pointer. |
| 236 | @param Packet The SCSI request packet to send to the SCSI |
| 237 | Controller specified by the device handle. |
| 238 | @param Event If the SCSI bus to which the SCSI device is attached |
| 239 | does not support non-blocking I/O, then Event is |
| 240 | ignored, and blocking I/O is performed. |
| 241 | If Event is NULL, then blocking I/O is performed. |
| 242 | If Event is not NULL and non-blocking I/O is |
| 243 | supported, then non-blocking I/O is performed, |
| 244 | and Event will be signaled when the SCSI Request |
| 245 | Packet completes. |
| 246 | |
| 247 | @retval EFI_SUCCESS The SCSI Request Packet was sent by the host |
| 248 | successfully, and TransferLength bytes were |
| 249 | transferred to/from DataBuffer. See |
| 250 | HostAdapterStatus, TargetStatus, |
| 251 | SenseDataLength, and SenseData in that order |
| 252 | for additional status information. |
| 253 | @retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed, |
| 254 | but the entire DataBuffer could not be transferred. |
| 255 | The actual number of bytes transferred is returned |
| 256 | in TransferLength. See HostAdapterStatus, |
| 257 | TargetStatus, SenseDataLength, and SenseData in |
| 258 | that order for additional status information. |
| 259 | @retval EFI_NOT_READY The SCSI Request Packet could not be sent because |
| 260 | there are too many SCSI Command Packets already |
| 261 | queued.The caller may retry again later. |
| 262 | @retval EFI_DEVICE_ERROR A device error occurred while attempting to send |
| 263 | the SCSI Request Packet. See HostAdapterStatus, |
| 264 | TargetStatus, SenseDataLength, and SenseData in |
| 265 | that order for additional status information. |
| 266 | @retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid. |
| 267 | The SCSI Request Packet was not sent, so no |
| 268 | additional status information is available. |
| 269 | @retval EFI_UNSUPPORTED The command described by the SCSI Request Packet |
| 270 | is not supported by the SCSI initiator(i.e., SCSI |
| 271 | Host Controller). The SCSI Request Packet was not |
| 272 | sent, so no additional status information is |
| 273 | available. |
| 274 | @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI |
| 275 | Request Packet to execute. See HostAdapterStatus, |
| 276 | TargetStatus, SenseDataLength, and SenseData in |
| 277 | that order for additional status information. |
| 278 | |
| 279 | **/ |
| 280 | typedef |
| 281 | EFI_STATUS |
| 282 | (EFIAPI *EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND)( |
| 283 | IN EFI_SCSI_IO_PROTOCOL *This, |
| 284 | IN OUT EFI_SCSI_IO_SCSI_REQUEST_PACKET *Packet, |
| 285 | IN EFI_EVENT Event OPTIONAL |
| 286 | ); |
| 287 | |
| 288 | /// |
| 289 | /// Provides services to manage and communicate with SCSI devices. |
| 290 | /// |
| 291 | struct _EFI_SCSI_IO_PROTOCOL { |
| 292 | EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE GetDeviceType; |
| 293 | EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION GetDeviceLocation; |
| 294 | EFI_SCSI_IO_PROTOCOL_RESET_BUS ResetBus; |
| 295 | EFI_SCSI_IO_PROTOCOL_RESET_DEVICE ResetDevice; |
| 296 | EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND ExecuteScsiCommand; |
| 297 | |
| 298 | /// |
| 299 | /// Supplies the alignment requirement for any buffer used in a data transfer. |
| 300 | /// IoAlign values of 0 and 1 mean that the buffer can be placed anywhere in memory. |
| 301 | /// Otherwise, IoAlign must be a power of 2, and the requirement is that the |
| 302 | /// start address of a buffer must be evenly divisible by IoAlign with no remainder. |
| 303 | /// |
| 304 | UINT32 IoAlign; |
| 305 | }; |
| 306 | |
| 307 | extern EFI_GUID gEfiScsiIoProtocolGuid; |
| 308 | |
| 309 | #endif |