NetworkPkg/IScsiDxe/IScsiImpl.h

   1 /** @file
   2   The shared head file for iSCSI driver.
   3
   4 Copyright (c) 2004 - 2018, 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 <IndustryStandard/Dhcp.h>
  21
  22 #include <Protocol/ComponentName.h>
  23 #include <Protocol/ComponentName2.h>
  24 #include <Protocol/DriverBinding.h>
  25 #include <Protocol/DevicePath.h>
  26 #include <Protocol/HiiConfigAccess.h>
  27
  28 #include <Protocol/Ip6.h>
  29 #include <Protocol/Dhcp4.h>
  30 #include <Protocol/Dhcp6.h>
  31 #include <Protocol/Dns4.h>
  32 #include <Protocol/Dns6.h>
  33 #include <Protocol/Tcp4.h>
  34 #include <Protocol/Tcp6.h>
  35 #include <Protocol/Ip4Config2.h>
  36 #include <Protocol/Ip6Config.h>
  37
  38 #include <Protocol/AuthenticationInfo.h>
  39 #include <Protocol/IScsiInitiatorName.h>
  40 #include <Protocol/ScsiPassThruExt.h>
  41 #include <Protocol/AdapterInformation.h>
  42 #include <Protocol/NetworkInterfaceIdentifier.h>
  43
  44 #include <Library/HiiLib.h>
  45 #include <Library/UefiHiiServicesLib.h>
  46 #include <Library/DevicePathLib.h>
  47 #include <Library/DebugLib.h>
  48 #include <Library/BaseLib.h>
  49 #include <Library/BaseMemoryLib.h>
  50 #include <Library/MemoryAllocationLib.h>
  51 #include <Library/PrintLib.h>
  52 #include <Library/UefiBootServicesTableLib.h>
  53 #include <Library/UefiRuntimeServicesTableLib.h>
  54 #include <Library/UefiLib.h>
  55 #include <Library/DpcLib.h>
  56 #include <Library/NetLib.h>
  57 #include <Library/TcpIoLib.h>
  58 #include <Library/BaseCryptLib.h>
  59
  60 #include <Guid/MdeModuleHii.h>
  61 #include <Guid/EventGroup.h>
  62 #include <Guid/Acpi.h>
  63
  64 #include "IScsiConfigNVDataStruc.h"
  65 #include "IScsiDriver.h"
  66 #include "IScsiProto.h"
  67 #include "IScsiCHAP.h"
  68 #include "IScsiDhcp.h"
  69 #include "IScsiDhcp6.h"
  70
  71 #include "IScsiIbft.h"
  72 #include "IScsiMisc.h"
  73 #include "IScsiDns.h"
  74 #include "IScsiConfig.h"
  75
  76 #define ISCSI_AUTH_INITIAL        0
  77
  78 #define ISCSI_SESSION_SIGNATURE   SIGNATURE_32 ('I', 'S', 'S', 'N')
  79 ///
  80 /// 10 seconds
  81 ///
  82 #define ISCSI_GET_MAPPING_TIMEOUT 100000000U
  83 ///
  84 /// 3 seconds
  85 ///
  86 #define ISCSI_WAIT_IPSEC_TIMEOUT  30000000U
  87
  88 struct _ISCSI_SESSION {
  89   UINT32                      Signature;
  90
  91   ISCSI_DRIVER_DATA           *Private;
  92   ISCSI_ATTEMPT_CONFIG_NVDATA *ConfigData;
  93
  94   UINT8                       AuthType;
  95   union {
  96     ISCSI_CHAP_AUTH_DATA      CHAP;
  97   } AuthData;
  98
  99   UINT8                       State;
 100
 101   UINT8                       Isid[6];
 102   UINT16                      Tsih;
 103
 104   UINT32                      CmdSN;
 105   UINT32                      ExpCmdSN;
 106   UINT32                      MaxCmdSN;
 107
 108   UINT32                      InitiatorTaskTag;
 109   UINT16                      NextCid;
 110
 111   LIST_ENTRY                  Conns;
 112   UINT32                      NumConns;
 113
 114   LIST_ENTRY                  TcbList;
 115
 116   //
 117   // Session-wide parameters
 118   //
 119   UINT16                      TargetPortalGroupTag;
 120   UINT32                      MaxConnections;
 121   BOOLEAN                     InitialR2T;
 122   BOOLEAN                     ImmediateData;
 123   UINT32                      MaxBurstLength;
 124   UINT32                      FirstBurstLength;
 125   UINT32                      DefaultTime2Wait;
 126   UINT32                      DefaultTime2Retain;
 127   UINT16                      MaxOutstandingR2T;
 128   BOOLEAN                     DataPDUInOrder;
 129   BOOLEAN                     DataSequenceInOrder;
 130   UINT8                       ErrorRecoveryLevel;
 131 };
 132
 133 #define ISCSI_CONNECTION_SIGNATURE  SIGNATURE_32 ('I', 'S', 'C', 'N')
 134
 135 struct _ISCSI_CONNECTION {
 136   UINT32            Signature;
 137   LIST_ENTRY        Link;
 138
 139   EFI_EVENT         TimeoutEvent;
 140
 141   ISCSI_SESSION     *Session;
 142
 143   UINT8             State;
 144   UINT8             CurrentStage;
 145   UINT8             NextStage;
 146
 147   UINT8             AuthStep;
 148
 149   BOOLEAN           PartialReqSent;
 150   BOOLEAN           PartialRspRcvd;
 151
 152   BOOLEAN           TransitInitiated;
 153   BOOLEAN           ParamNegotiated;
 154
 155   UINT16            Cid;
 156   UINT32            ExpStatSN;
 157
 158   //
 159   // Queues...
 160   //
 161   NET_BUF_QUEUE     RspQue;
 162
 163   BOOLEAN           Ipv6Flag;
 164   TCP_IO            TcpIo;
 165
 166   //
 167   // Connection-only parameters.
 168   //
 169   UINT32            MaxRecvDataSegmentLength;
 170   ISCSI_DIGEST_TYPE HeaderDigest;
 171   ISCSI_DIGEST_TYPE DataDigest;
 172 };
 173
 174 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
 175
 176 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
 177   CR ( \
 178   PassThru, \
 179   ISCSI_DRIVER_DATA, \
 180   IScsiExtScsiPassThru, \
 181   ISCSI_DRIVER_DATA_SIGNATURE \
 182   )
 183
 184 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
 185   CR ( \
 186   Identifier, \
 187   ISCSI_DRIVER_DATA, \
 188   IScsiIdentifier, \
 189   ISCSI_DRIVER_DATA_SIGNATURE \
 190   )
 191
 192 struct _ISCSI_DRIVER_DATA {
 193   UINT32                          Signature;
 194   EFI_HANDLE                      Image;
 195   EFI_HANDLE                      Controller;
 196   ISCSI_PRIVATE_PROTOCOL          IScsiIdentifier;
 197
 198   EFI_EVENT                       ExitBootServiceEvent;
 199
 200   EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru;
 201   EFI_EXT_SCSI_PASS_THRU_MODE     ExtScsiPassThruMode;
 202   EFI_HANDLE                      ExtScsiPassThruHandle;
 203   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 204   EFI_HANDLE                      ChildHandle;
 205   ISCSI_SESSION                   *Session;
 206 };
 207
 208 #endif