MdeModulePkg/Universal/Network/IScsiDxe/IScsiImpl.h

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