NetworkPkg/IScsiDxe/IScsiImpl.h

   1 /** @file
   2   The shared head file for iSCSI driver.
   3
   4 Copyright (c) 2004 - 2012, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _ISCSI_IMPL_H_
  16 #define _ISCSI_IMPL_H_
  17
  18 #include <Uefi.h>
  19
  20 #include <Protocol/ComponentName.h>
  21 #include <Protocol/ComponentName2.h>
  22 #include <Protocol/DriverBinding.h>
  23 #include <Protocol/DevicePath.h>
  24 #include <Protocol/HiiConfigAccess.h>
  25
  26 #include <Protocol/Ip6.h>
  27 #include <Protocol/Dhcp4.h>
  28 #include <Protocol/Dhcp6.h>
  29 #include <Protocol/Tcp4.h>
  30 #include <Protocol/Tcp6.h>
  31
  32 #include <Protocol/AuthenticationInfo.h>
  33 #include <Protocol/IScsiInitiatorName.h>
  34 #include <Protocol/ScsiPassThruExt.h>
  35
  36 #include <Library/HiiLib.h>
  37 #include <Library/UefiHiiServicesLib.h>
  38 #include <Library/DevicePathLib.h>
  39 #include <Library/DebugLib.h>
  40 #include <Library/BaseLib.h>
  41 #include <Library/BaseMemoryLib.h>
  42 #include <Library/MemoryAllocationLib.h>
  43 #include <Library/PrintLib.h>
  44 #include <Library/UefiBootServicesTableLib.h>
  45 #include <Library/UefiRuntimeServicesTableLib.h>
  46 #include <Library/UefiLib.h>
  47 #include <Library/DpcLib.h>
  48 #include <Library/NetLib.h>
  49 #include <Library/TcpIoLib.h>
  50 #include <Library/BaseCryptLib.h>
  51
  52 #include <Guid/MdeModuleHii.h>
  53 #include <Guid/EventGroup.h>
  54 #include <Guid/Acpi.h>
  55
  56 #include "IScsiConfigNVDataStruc.h"
  57 #include "IScsiDriver.h"
  58 #include "IScsiProto.h"
  59 #include "IScsiCHAP.h"
  60 #include "IScsiDhcp.h"
  61 #include "IScsiDhcp6.h"
  62 #include "IScsiIbft.h"
  63 #include "IScsiMisc.h"
  64 #include "IScsiConfig.h"
  65
  66 #define ISCSI_AUTH_INITIAL        0
  67
  68 #define ISCSI_SESSION_SIGNATURE   SIGNATURE_32 ('I', 'S', 'S', 'N')
  69 ///
  70 /// 10 seconds
  71 ///
  72 #define ISCSI_GET_MAPPING_TIMEOUT 100000000U
  73 ///
  74 /// 3 seconds
  75 ///
  76 #define ISCSI_WAIT_IPSEC_TIMEOUT  30000000U
  77
  78 struct _ISCSI_SESSION {
  79   UINT32                      Signature;
  80
  81   ISCSI_DRIVER_DATA           *Private;
  82   ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData;
  83
  84   UINT8                       AuthType;
  85   union {
  86     ISCSI_CHAP_AUTH_DATA      CHAP;
  87   } AuthData;
  88
  89   UINT8                       State;
  90
  91   UINT8                       Isid[6];
  92   UINT16                      Tsih;
  93
  94   UINT32                      CmdSN;
  95   UINT32                      ExpCmdSN;
  96   UINT32                      MaxCmdSN;
  97
  98   UINT32                      InitiatorTaskTag;
  99   UINT16                      NextCid;
 100
 101   LIST_ENTRY                  Conns;
 102   UINT32                      NumConns;
 103
 104   LIST_ENTRY                  TcbList;
 105
 106   //
 107   // Session-wide parameters
 108   //
 109   UINT16                      TargetPortalGroupTag;
 110   UINT32                      MaxConnections;
 111   BOOLEAN                     InitialR2T;
 112   BOOLEAN                     ImmediateData;
 113   UINT32                      MaxBurstLength;
 114   UINT32                      FirstBurstLength;
 115   UINT32                      DefaultTime2Wait;
 116   UINT32                      DefaultTime2Retain;
 117   UINT16                      MaxOutstandingR2T;
 118   BOOLEAN                     DataPDUInOrder;
 119   BOOLEAN                     DataSequenceInOrder;
 120   UINT8                       ErrorRecoveryLevel;
 121 };
 122
 123 #define ISCSI_CONNECTION_SIGNATURE  SIGNATURE_32 ('I', 'S', 'C', 'N')
 124
 125 struct _ISCSI_CONNECTION {
 126   UINT32            Signature;
 127   LIST_ENTRY        Link;
 128
 129   EFI_EVENT         TimeoutEvent;
 130
 131   ISCSI_SESSION     *Session;
 132
 133   UINT8             State;
 134   UINT8             CurrentStage;
 135   UINT8             NextStage;
 136
 137   UINT8             AuthStep;
 138
 139   BOOLEAN           PartialReqSent;
 140   BOOLEAN           PartialRspRcvd;
 141
 142   BOOLEAN           TransitInitiated;
 143   BOOLEAN           ParamNegotiated;
 144
 145   UINT16            Cid;
 146   UINT32            ExpStatSN;
 147
 148   //
 149   // Queues...
 150   //
 151   NET_BUF_QUEUE     RspQue;
 152
 153   BOOLEAN           Ipv6Flag;
 154   TCP_IO            TcpIo;
 155
 156   //
 157   // Connection-only parameters.
 158   //
 159   UINT32            MaxRecvDataSegmentLength;
 160   ISCSI_DIGEST_TYPE HeaderDigest;
 161   ISCSI_DIGEST_TYPE DataDigest;
 162 };
 163
 164 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
 165
 166 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
 167   CR ( \
 168   PassThru, \
 169   ISCSI_DRIVER_DATA, \
 170   IScsiExtScsiPassThru, \
 171   ISCSI_DRIVER_DATA_SIGNATURE \
 172   )
 173
 174 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
 175   CR ( \
 176   Identifier, \
 177   ISCSI_DRIVER_DATA, \
 178   IScsiIdentifier, \
 179   ISCSI_DRIVER_DATA_SIGNATURE \
 180   )
 181
 182 struct _ISCSI_DRIVER_DATA {
 183   UINT32                          Signature;
 184   EFI_HANDLE                      Image;
 185   EFI_HANDLE                      Controller;
 186   ISCSI_PRIVATE_PROTOCOL          IScsiIdentifier;
 187
 188   EFI_EVENT                       ExitBootServiceEvent;
 189
 190   EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru;
 191   EFI_EXT_SCSI_PASS_THRU_MODE     ExtScsiPassThruMode;
 192   EFI_HANDLE                      ExtScsiPassThruHandle;
 193   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 194   EFI_HANDLE                      ChildHandle;
 195   ISCSI_SESSION                   *Session;
 196 };
 197
 198 #endif