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