IScsiDriver.h

Go to the documentation of this file.

 
#ifndef _ISCSI_DRIVER_H_
#define _ISCSI_DRIVER_H_
 
#define ISCSI_V4_PRIVATE_GUID \
  { \
    0xfa3cde4c, 0x87c2, 0x427d, { 0xae, 0xde, 0x7d, 0xd0, 0x96, 0xc8, 0x8c, 0x58 } \
  }
 
#define ISCSI_V6_PRIVATE_GUID \
  { \
    0x28be27e5, 0x66cc, 0x4a31, { 0xa3, 0x15, 0xdb, 0x14, 0xc3, 0x74, 0x4d, 0x85 } \
  }
 
#define ISCSI_INITIATOR_NAME_VAR_NAME  L"I_NAME"
 
#define IP_MODE_AUTOCONFIG_IP4                      3
#define IP_MODE_AUTOCONFIG_IP6                      4
#define ALWAYS_USE_UEFI_ISCSI_AND_IGNORE_ISCSI_HBA  0x00
#define STOP_UEFI_ISCSI_IF_HBA_INSTALL_AIP          0x01
#define STOP_UEFI_ISCSI_IF_AIP_SUPPORT_IP4          0x02
#define STOP_UEFI_ISCSI_IF_AIP_SUPPORT_IP6          0x04
#define STOP_UEFI_ISCSI_IF_AIP_SUPPORT_OFFLOAD      0x08
#define STOP_UEFI_ISCSI_IF_AIP_SUPPORT_MPIO         0x10
#define STOP_UEFI_ISCSI_IF_AIP_CONFIGURED_IP4       0x20
#define STOP_UEFI_ISCSI_IF_AIP_CONFIGURED_IP6       0x40
#define ALWAYS_USE_ISCSI_HBA_AND_IGNORE_UEFI_ISCSI  0xFF
 
extern EFI_COMPONENT_NAME2_PROTOCOL       gIScsiComponentName2;
extern EFI_COMPONENT_NAME_PROTOCOL        gIScsiComponentName;
extern EFI_UNICODE_STRING_TABLE           *gIScsiControllerNameTable;
extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL  gIScsiInitiatorName;
extern EFI_AUTHENTICATION_INFO_PROTOCOL   gIScsiAuthenticationInfo;
extern EFI_EXT_SCSI_PASS_THRU_PROTOCOL    gIScsiExtScsiPassThruProtocolTemplate;
extern EFI_GUID                           gIScsiV4PrivateGuid;
extern EFI_GUID                           gIScsiV6PrivateGuid;
 
typedef struct {
  CHAR16        PortString[ISCSI_NAME_IFR_MAX_SIZE];
  LIST_ENTRY    NicInfoList;
  UINT8         NicCount;
  UINT8         CurrentNic;
  UINT8         MaxNic;
  BOOLEAN       Ipv6Flag;
  BOOLEAN       OneSessionEstablished;
  BOOLEAN       EnableMpio;
  UINT8         MpioCount;              // The number of attempts in MPIO.
  UINT8         Krb5MpioCount;          // The number of attempts login with KRB5 in MPIO.
  UINT8         SinglePathCount;        // The number of single path attempts.
  UINT8         ValidSinglePathCount;   // The number of valid single path attempts.
  UINT8         BootSelectedIndex;
  UINT8         AttemptCount;
  LIST_ENTRY    AttemptConfigs;         // User configured Attempt list.
  CHAR8         InitiatorName[ISCSI_NAME_MAX_SIZE];
  UINTN         InitiatorNameLength;
} ISCSI_PRIVATE_DATA;
 
extern ISCSI_PRIVATE_DATA  *mPrivate;
 
typedef struct {
  LIST_ENTRY         Link;
  UINT32             HwAddressSize;
  EFI_MAC_ADDRESS    PermanentAddress;
  UINT8              NicIndex;
  UINT16             VlanId;
  UINTN              BusNumber;
  UINTN              DeviceNumber;
  UINTN              FunctionNumber;
  BOOLEAN            Ipv6Available;
} ISCSI_NIC_INFO;
 
typedef struct _ISCSI_PRIVATE_PROTOCOL {
  UINT32    Reserved;
} ISCSI_PRIVATE_PROTOCOL;
 
//
// EFI Driver Binding Protocol for iSCSI driver.
//
 
EFI_STATUS
EFIAPI
IScsiIp4DriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IScsiIp4DriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IScsiIp4DriverBindingStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IScsiIp6DriverBindingSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IScsiIp6DriverBindingStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath OPTIONAL
  );
 
EFI_STATUS
EFIAPI
IScsiIp6DriverBindingStop (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   ControllerHandle,
  IN UINTN                        NumberOfChildren,
  IN EFI_HANDLE                   *ChildHandleBuffer OPTIONAL
  );
 
//
// EFI Component Name(2) Protocol for iSCSI driver.
//
 
EFI_STATUS
EFIAPI
IScsiComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **DriverName
  );
 
EFI_STATUS
EFIAPI
IScsiComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,
  IN  EFI_HANDLE                   ControllerHandle,
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,
  IN  CHAR8                        *Language,
  OUT CHAR16                       **ControllerName
  );
 
//
// EFI iSCSI Initiator Name Protocol for iSCSI driver.
//
 
EFI_STATUS
EFIAPI
IScsiGetInitiatorName (
  IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
  IN OUT UINTN                              *BufferSize,
  OUT    VOID                               *Buffer
  );
 
EFI_STATUS
EFIAPI
IScsiSetInitiatorName (
  IN     EFI_ISCSI_INITIATOR_NAME_PROTOCOL  *This,
  IN OUT UINTN                              *BufferSize,
  IN     VOID                               *Buffer
  );
 
//
// EFI_AUTHENTICATION_INFO_PROTOCOL for iSCSI driver.
//
 
EFI_STATUS
EFIAPI
IScsiGetAuthenticationInfo (
  IN  EFI_AUTHENTICATION_INFO_PROTOCOL  *This,
  IN  EFI_HANDLE                        ControllerHandle,
  OUT VOID                              **Buffer
  );
 
EFI_STATUS
EFIAPI
IScsiSetAuthenticationInfo (
  IN EFI_AUTHENTICATION_INFO_PROTOCOL  *This,
  IN EFI_HANDLE                        ControllerHandle,
  IN VOID                              *Buffer
  );
 
//
// EFI_EXT_SCSI_PASS_THRU_PROTOCOL for iSCSI driver.
//
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruFunction (
  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
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruGetNextTargetLun (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN OUT UINT8                        **Target,
  IN OUT UINT64                       *Lun
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruBuildDevicePath (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN UINT8                            *Target,
  IN UINT64                           Lun,
  IN OUT EFI_DEVICE_PATH_PROTOCOL     **DevicePath
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruGetTargetLun (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN EFI_DEVICE_PATH_PROTOCOL         *DevicePath,
  OUT UINT8                           **Target,
  OUT UINT64                          *Lun
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruResetChannel (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruResetTargetLun (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN UINT8                            *Target,
  IN UINT64                           Lun
  );
 
EFI_STATUS
EFIAPI
IScsiExtScsiPassThruGetNextTarget (
  IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL  *This,
  IN OUT UINT8                        **Target
  );
 
#endif