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