ScsiIo.h

Go to the documentation of this file.

 
#ifndef __EFI_SCSI_IO_PROTOCOL_H__
#define __EFI_SCSI_IO_PROTOCOL_H__
 
#define EFI_SCSI_IO_PROTOCOL_GUID \
  { \
    0x932f47e6, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \
  }
 
typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;
 
//
// SCSI Device type information, defined in the SCSI Primary Commands standard (e.g., SPC-4)
//
#define EFI_SCSI_IO_TYPE_DISK                                  0x00    
#define EFI_SCSI_IO_TYPE_TAPE                                  0x01    
#define EFI_SCSI_IO_TYPE_PRINTER                               0x02    
#define EFI_SCSI_IO_TYPE_PROCESSOR                             0x03    
#define EFI_SCSI_IO_TYPE_WORM                                  0x04    
#define EFI_SCSI_IO_TYPE_CDROM                                 0x05    
#define EFI_SCSI_IO_TYPE_SCANNER                               0x06    
#define EFI_SCSI_IO_TYPE_OPTICAL                               0x07    
#define EFI_SCSI_IO_TYPE_MEDIUMCHANGER                         0x08    
#define EFI_SCSI_IO_TYPE_COMMUNICATION                         0x09    
#define MFI_SCSI_IO_TYPE_A                                     0x0A    
#define MFI_SCSI_IO_TYPE_B                                     0x0B    
#define MFI_SCSI_IO_TYPE_RAID                                  0x0C    
#define MFI_SCSI_IO_TYPE_SES                                   0x0D    
#define MFI_SCSI_IO_TYPE_RBC                                   0x0E    
#define MFI_SCSI_IO_TYPE_OCRW                                  0x0F    
#define MFI_SCSI_IO_TYPE_BRIDGE                                0x10    
#define MFI_SCSI_IO_TYPE_OSD                                   0x11    
#define EFI_SCSI_IO_TYPE_RESERVED_LOW                          0x12    
#define EFI_SCSI_IO_TYPE_RESERVED_HIGH                         0x1E    
#define EFI_SCSI_IO_TYPE_UNKNOWN                               0x1F    
 
//
// SCSI Data Direction definition
//
#define EFI_SCSI_IO_DATA_DIRECTION_READ                        0
#define EFI_SCSI_IO_DATA_DIRECTION_WRITE                       1
#define EFI_SCSI_IO_DATA_DIRECTION_BIDIRECTIONAL               2
 
//
// SCSI Host Adapter Status definition
//
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OK                     0x00
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND        0x09    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_TIMEOUT                0x0b    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_MESSAGE_REJECT         0x0d    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_RESET              0x0e    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PARITY_ERROR           0x0f
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_REQUEST_SENSE_FAILED   0x10    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_SELECTION_TIMEOUT      0x11    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN  0x12    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_BUS_FREE               0x13    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_PHASE_ERROR            0x14    
#define EFI_SCSI_IO_STATUS_HOST_ADAPTER_OTHER                  0x7f
 
 
//
// SCSI Target Status definition
//
#define EFI_SCSI_IO_STATUS_TARGET_GOOD                         0x00
#define EFI_SCSI_IO_STATUS_TARGET_CHECK_CONDITION              0x02    
#define EFI_SCSI_IO_STATUS_TARGET_CONDITION_MET                0x04    
#define EFI_SCSI_IO_STATUS_TARGET_BUSY                         0x08    
#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE                 0x10    
#define EFI_SCSI_IO_STATUS_TARGET_INTERMEDIATE_CONDITION_MET   0x14    
#define EFI_SCSI_IO_STATUS_TARGET_RESERVATION_CONFLICT         0x18    
#define EFI_SCSI_IO_STATUS_TARGET_COMMOND_TERMINATED           0x22    
#define EFI_SCSI_IO_STATUS_TARGET_QUEUE_FULL                   0x28    
 
typedef struct {
  UINT64                              Timeout;
  VOID                                *InDataBuffer;
  VOID                                *OutDataBuffer;
  VOID                                *SenseData;
  VOID                                *Cdb;
  UINT32                              InTransferLength;
  UINT32                              OutTransferLength;
  UINT8                               CdbLength;
  UINT8                               DataDirection;
  UINT8                               HostAdapterStatus;
  UINT8                               TargetStatus;
  UINT8                               SenseDataLength;
} EFI_SCSI_IO_SCSI_REQUEST_PACKET;
 
typedef
EFI_STATUS
(EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE)(
  IN  EFI_SCSI_IO_PROTOCOL            *This,
  OUT UINT8                           *DeviceType
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION)(
  IN EFI_SCSI_IO_PROTOCOL           *This,
  IN OUT UINT8                      **Target,
  OUT UINT64                        *Lun
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_BUS)(
  IN EFI_SCSI_IO_PROTOCOL     *This
  );
 
typedef
EFI_STATUS
(EFIAPI *EFI_SCSI_IO_PROTOCOL_RESET_DEVICE)(
  IN EFI_SCSI_IO_PROTOCOL     *This
  );
 
 
typedef
EFI_STATUS
(EFIAPI *EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND)(
  IN EFI_SCSI_IO_PROTOCOL                   *This,
  IN OUT  EFI_SCSI_IO_SCSI_REQUEST_PACKET   *Packet,
  IN EFI_EVENT                              Event  OPTIONAL
  );
 
struct _EFI_SCSI_IO_PROTOCOL {
  EFI_SCSI_IO_PROTOCOL_GET_DEVICE_TYPE      GetDeviceType;
  EFI_SCSI_IO_PROTOCOL_GET_DEVICE_LOCATION  GetDeviceLocation;
  EFI_SCSI_IO_PROTOCOL_RESET_BUS            ResetBus;
  EFI_SCSI_IO_PROTOCOL_RESET_DEVICE         ResetDevice;
  EFI_SCSI_IO_PROTOCOL_EXEC_SCSI_COMMAND    ExecuteScsiCommand;
 
  UINT32                                    IoAlign;
};
 
extern EFI_GUID gEfiScsiIoProtocolGuid;
 
#endif