MdeModulePkg/Universal/Network/IScsiDxe/IScsiImpl.h

   1 /** @file
   2   The header file of IScsiImpl.c.
   3
   4 Copyright (c) 2004 - 2016, 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 <Library/BaseMemoryLib.h>
  23 #include <Library/MemoryAllocationLib.h>
  24 #include <Library/NetLib.h>
  25 #include <Library/PrintLib.h>
  26 #include <Library/UefiRuntimeServicesTableLib.h>
  27
  28 #include <Guid/EventGroup.h>
  29
  30 #include "IScsiCommon.h"
  31 #include "IScsiDriver.h"
  32 #include "IScsiInitiatorName.h"
  33 #include "ComponentName.h"
  34 #include "IScsiConfigNVDataStruc.h"
  35 #include "IScsiExtScsiPassThru.h"
  36 #include "IScsiProto.h"
  37 #include "IScsiMisc.h"
  38 #include "IScsiCHAP.h"
  39 #include "IScsiConfig.h"
  40 #include "IScsiDhcp.h"
  41 #include "IScsiTcp4Io.h"
  42 #include "IScsiIbft.h"
  43
  44
  45 #define ISCSI_SESSION_SIGNATURE SIGNATURE_32 ('I', 'S', 'S', 'N')
  46
  47 struct _ISCSI_SESSION {
  48   UINT32                    Signature;
  49
  50   ISCSI_SESSION_CONFIG_DATA ConfigData;
  51   ISCSI_CHAP_AUTH_DATA      AuthData;
  52
  53   CHAR8                     InitiatorName[ISCSI_NAME_MAX_SIZE];
  54   UINTN                     InitiatorNameLength;
  55   UINT8                     State;
  56
  57   UINT8                     Isid[6];
  58   UINT16                    Tsih;
  59
  60   UINT32                    CmdSN;
  61   UINT32                    ExpCmdSN;
  62   UINT32                    MaxCmdSN;
  63
  64   UINT32                    InitiatorTaskTag;
  65   UINT16                    NextCid;
  66
  67   LIST_ENTRY                Conns;
  68   UINT32                    NumConns;
  69
  70   LIST_ENTRY                TcbList;
  71
  72   //
  73   // session-wide parameters
  74   //
  75   UINT16                    TargetPortalGroupTag;
  76   UINT32                    MaxConnections;
  77   BOOLEAN                   InitialR2T;
  78   BOOLEAN                   ImmediateData;
  79   UINT32                    MaxBurstLength;
  80   UINT32                    FirstBurstLength;
  81   UINT32                    DefaultTime2Wait;
  82   UINT32                    DefaultTime2Retain;
  83   UINT16                    MaxOutstandingR2T;
  84   BOOLEAN                   DataPDUInOrder;
  85   BOOLEAN                   DataSequenceInOrder;
  86   UINT8                     ErrorRecoveryLevel;
  87 };
  88
  89 #define ISCSI_CONNECTION_SIGNATURE  SIGNATURE_32 ('I', 'S', 'C', 'N')
  90
  91 struct _ISCSI_CONNECTION {
  92   UINT32            Signature;
  93   LIST_ENTRY        Link;
  94
  95   EFI_EVENT         TimeoutEvent;
  96
  97   ISCSI_SESSION     *Session;
  98
  99   UINT8             State;
 100   UINT8             CurrentStage;
 101   UINT8             NextStage;
 102
 103   UINT8             CHAPStep;
 104
 105   BOOLEAN           PartialReqSent;
 106   BOOLEAN           PartialRspRcvd;
 107
 108   BOOLEAN           TransitInitiated;
 109
 110   UINT16            Cid;
 111   UINT32            ExpStatSN;
 112
 113   //
 114   // queues...
 115   //
 116   NET_BUF_QUEUE     RspQue;
 117
 118   TCP4_IO           Tcp4Io;
 119
 120   //
 121   // connection-only parameters
 122   //
 123   UINT32            MaxRecvDataSegmentLength;
 124   ISCSI_DIGEST_TYPE HeaderDigest;
 125   ISCSI_DIGEST_TYPE DataDigest;
 126 };
 127
 128 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
 129
 130 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
 131   CR ( \
 132   PassThru, \
 133   ISCSI_DRIVER_DATA, \
 134   IScsiExtScsiPassThru, \
 135   ISCSI_DRIVER_DATA_SIGNATURE \
 136   )
 137 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
 138   CR ( \
 139   Identifier, \
 140   ISCSI_DRIVER_DATA, \
 141   IScsiIdentifier, \
 142   ISCSI_DRIVER_DATA_SIGNATURE \
 143   )
 144 #define ISCSI_DRIVER_DATA_FROM_SESSION(s) \
 145   CR ( \
 146   s, \
 147   ISCSI_DRIVER_DATA, \
 148   Session, \
 149   ISCSI_DRIVER_DATA_SIGNATURE \
 150   )
 151
 152 struct _ISCSI_DRIVER_DATA {
 153   UINT32                          Signature;
 154   EFI_HANDLE                      Image;
 155   EFI_HANDLE                      Controller;
 156   ISCSI_PRIVATE_PROTOCOL          IScsiIdentifier;
 157   EFI_HANDLE                      ChildHandle;
 158   EFI_EVENT                       ExitBootServiceEvent;
 159
 160   EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru;
 161   EFI_EXT_SCSI_PASS_THRU_MODE     ExtScsiPassThruMode;
 162   EFI_HANDLE                      ExtScsiPassThruHandle;
 163   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 164
 165   ISCSI_SESSION                   Session;
 166 };
 167
 168 #endif