IScsiMisc.h

Go to the documentation of this file.

 
#ifndef _ISCSI_MISC_H_
#define _ISCSI_MISC_H_
 
typedef struct _ISCSI_DRIVER_DATA ISCSI_DRIVER_DATA;
 
#define IP4_NODE_LEN_NEW_VERSIONS  27
 
#define IP6_NODE_LEN_OLD_VERSIONS  43
#define IP6_NODE_LEN_NEW_VERSIONS  60
 
#define IP6_OLD_IPADDRESS_OFFSET  42
 
#pragma pack(1)
typedef struct _ISCSI_SESSION_CONFIG_NVDATA {
  UINT16              TargetPort;
  UINT8               Enabled;
  UINT8               IpMode;
 
  EFI_IP_ADDRESS      LocalIp;
  EFI_IPv4_ADDRESS    SubnetMask;
  EFI_IP_ADDRESS      Gateway;
 
  BOOLEAN             InitiatorInfoFromDhcp;
  BOOLEAN             TargetInfoFromDhcp;
 
  CHAR8               TargetName[ISCSI_NAME_MAX_SIZE];
  EFI_IP_ADDRESS      TargetIp;
  UINT8               PrefixLength;
  UINT8               BootLun[8];
 
  UINT16              ConnectTimeout; 
  UINT8               ConnectRetryCount;
  UINT8               IsId[6];
 
  BOOLEAN             RedirectFlag;
  UINT16              OriginalTargetPort;   // The port of proxy/virtual target.
  EFI_IP_ADDRESS      OriginalTargetIp;     // The address of proxy/virtual target.
 
  BOOLEAN             DnsMode; // Flag indicate whether the Target address is expressed as URL format.
  CHAR8               TargetUrl[ISCSI_TARGET_URI_MAX_SIZE];
} ISCSI_SESSION_CONFIG_NVDATA;
#pragma pack()
 
UINT8
IScsiGetSubnetMaskPrefixLength (
  IN EFI_IPv4_ADDRESS  *SubnetMask
  );
 
EFI_STATUS
IScsiAsciiStrToLun (
  IN  CHAR8  *Str,
  OUT UINT8  *Lun
  );
 
VOID
IScsiLunToUnicodeStr (
  IN UINT8    *Lun,
  OUT CHAR16  *String
  );
 
VOID
IScsiMacAddrToStr (
  IN  EFI_MAC_ADDRESS  *Mac,
  IN  UINT32           Len,
  IN  UINT16           VlanId,
  OUT CHAR16           *Str
  );
 
EFI_STATUS
IScsiAsciiStrToIp (
  IN  CHAR8           *Str,
  IN  UINT8           IpMode,
  OUT EFI_IP_ADDRESS  *Ip
  );
 
EFI_STATUS
IScsiBinToHex (
  IN     UINT8   *BinBuffer,
  IN     UINT32  BinLength,
  IN OUT CHAR8   *HexStr,
  IN OUT UINT32  *HexLength
  );
 
EFI_STATUS
IScsiHexToBin (
  IN OUT UINT8   *BinBuffer,
  IN OUT UINT32  *BinLength,
  IN     CHAR8   *HexStr
  );
 
UINTN
IScsiNetNtoi (
  IN     CHAR8  *Str
  );
 
EFI_STATUS
IScsiGenRandom (
  IN OUT UINT8  *Rand,
  IN     UINTN  RandLength
  );
 
EFI_STATUS
IScsiAddNic (
  IN EFI_HANDLE  Controller,
  IN EFI_HANDLE  Image
  );
 
EFI_STATUS
IScsiRemoveNic (
  IN EFI_HANDLE  Controller
  );
 
EFI_STATUS
IScsiCreateAttempts (
  IN UINTN  AttemptNum
  );
 
EFI_STATUS
IScsiCreateKeywords (
  IN UINTN  KeywordNum
  );
 
VOID
IScsiCleanAttemptVariable (
  IN   VOID
  );
 
ISCSI_NIC_INFO *
IScsiGetNicInfoByIndex (
  IN UINT8  NicIndex
  );
 
UINT16
IScsiGetNICPciLocation (
  IN EFI_HANDLE  Controller,
  OUT UINTN      *Bus,
  OUT UINTN      *Device,
  OUT UINTN      *Function
  );
 
VOID *
IScsiGetVariableAndSize (
  IN  CHAR16    *Name,
  IN  EFI_GUID  *VendorGuid,
  OUT UINTN     *VariableSize
  );
 
ISCSI_DRIVER_DATA *
IScsiCreateDriverData (
  IN EFI_HANDLE  Image,
  IN EFI_HANDLE  Controller
  );
 
EFI_STATUS
IScsiCleanDriverData (
  IN ISCSI_DRIVER_DATA  *Private
  );
 
BOOLEAN
IScsiDhcpIsConfigured (
  IN EFI_HANDLE  Controller,
  IN UINT8       IpVersion
  );
 
BOOLEAN
IScsiDnsIsConfigured (
  IN EFI_HANDLE  Controller
  );
 
EFI_STATUS
IScsiGetConfigData (
  IN ISCSI_DRIVER_DATA  *Private
  );
 
EFI_DEVICE_PATH_PROTOCOL *
IScsiGetTcpConnDevicePath (
  IN ISCSI_SESSION  *Session
  );
 
VOID
EFIAPI
IScsiOnExitBootService (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
EFIAPI
IScsiTestManagedDevice (
  IN  EFI_HANDLE  ControllerHandle,
  IN  EFI_HANDLE  DriverBindingHandle,
  IN  EFI_GUID    *ProtocolGuid
  );
 
#endif