MdeModulePkg/Universal/Network/IScsiDxe/IScsiImpl.h

   1 /*++
   2
   3 Copyright (c) 2004 - 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   IScsiImpl.h
  15
  16 Abstract:
  17
  18 --*/
  19
  20 #ifndef _ISCSI_IMPL_H_
  21 #define _ISCSI_IMPL_H_
  22
  23 #include <Library/NetLib.h>
  24 #include <Library/PrintLib.h>
  25 #include <Library/UefiRuntimeServicesTableLib.h>
  26 #include "IScsiCommon.h"
  27 #include "IScsiDriver.h"
  28 #include "IScsiConfigNVDataStruc.h"
  29 #include "IScsiExtScsiPassThru.h"
  30 #include "IScsiProto.h"
  31 #include "IScsiCHAP.h"
  32 #include "IScsiDhcp.h"
  33 #include "IScsiTcp4Io.h"
  34 #include "IScsiIbft.h"
  35 #include "IScsiMisc.h"
  36 #include "IScsiConfig.h"
  37
  38 #define ISCSI_SESSION_SIGNATURE EFI_SIGNATURE_32 ('I', 'S', 'S', 'N')
  39
  40 struct _ISCSI_SESSION {
  41   UINT32                    Signature;
  42
  43   ISCSI_SESSION_CONFIG_DATA ConfigData;
  44   ISCSI_CHAP_AUTH_DATA      AuthData;
  45
  46   CHAR8                     InitiatorName[ISCSI_NAME_MAX_SIZE];
  47   UINTN                     InitiatorNameLength;
  48   UINT8                     State;
  49
  50   UINT8                     ISID[6];
  51   UINT16                    TSIH;
  52
  53   UINT32                    CmdSN;
  54   UINT32                    ExpCmdSN;
  55   UINT32                    MaxCmdSN;
  56
  57   UINT32                    InitiatorTaskTag;
  58   UINT16                    NextCID;
  59
  60   LIST_ENTRY                Conns;
  61   UINT32                    NumConns;
  62
  63   LIST_ENTRY                TcbList;
  64
  65   //
  66   // session-wide parameters
  67   //
  68   UINT16                    TargetPortalGroupTag;
  69   UINT32                    MaxConnections;
  70   BOOLEAN                   InitialR2T;
  71   BOOLEAN                   ImmediateData;
  72   UINT32                    MaxBurstLength;
  73   UINT32                    FirstBurstLength;
  74   UINT32                    DefaultTime2Wait;
  75   UINT32                    DefaultTime2Retain;
  76   UINT16                    MaxOutstandingR2T;
  77   BOOLEAN                   DataPDUInOrder;
  78   BOOLEAN                   DataSequenceInOrder;
  79   UINT8                     ErrorRecoveryLevel;
  80 };
  81
  82 #define ISCSI_CONNECTION_SIGNATURE  EFI_SIGNATURE_32 ('I', 'S', 'C', 'N')
  83
  84 struct _ISCSI_CONNECTION {
  85   UINT32            Signature;
  86   LIST_ENTRY        Link;
  87
  88   EFI_EVENT         TimeoutEvent;
  89
  90   ISCSI_SESSION     *Session;
  91
  92   UINT8             State;
  93   UINT8             CurrentStage;
  94   UINT8             NextStage;
  95
  96   UINT8             CHAPStep;
  97
  98   BOOLEAN           PartialReqSent;
  99   BOOLEAN           PartialRspRcvd;
 100
 101   BOOLEAN           TransitInitiated;
 102
 103   UINT16            CID;
 104   UINT32            ExpStatSN;
 105
 106   //
 107   // queues...
 108   //
 109   NET_BUF_QUEUE     RspQue;
 110
 111   TCP4_IO           Tcp4Io;
 112
 113   //
 114   // connection-only parameters
 115   //
 116   UINT32            MaxRecvDataSegmentLength;
 117   ISCSI_DIGEST_TYPE HeaderDigest;
 118   ISCSI_DIGEST_TYPE DataDigest;
 119 };
 120
 121 #define ISCSI_DRIVER_DATA_SIGNATURE EFI_SIGNATURE_32 ('I', 'S', 'D', 'A')
 122
 123 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
 124   CR ( \
 125   PassThru, \
 126   ISCSI_DRIVER_DATA, \
 127   IScsiExtScsiPassThru, \
 128   ISCSI_DRIVER_DATA_SIGNATURE \
 129   )
 130 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
 131   CR ( \
 132   Identifier, \
 133   ISCSI_DRIVER_DATA, \
 134   IScsiIdentifier, \
 135   ISCSI_DRIVER_DATA_SIGNATURE \
 136   )
 137 #define ISCSI_DRIVER_DATA_FROM_SESSION(s) \
 138   CR ( \
 139   s, \
 140   ISCSI_DRIVER_DATA, \
 141   Session, \
 142   ISCSI_DRIVER_DATA_SIGNATURE \
 143   )
 144
 145 struct _ISCSI_DRIVER_DATA {
 146   UINT32                          Signature;
 147   EFI_HANDLE                      Image;
 148   EFI_HANDLE                      Controller;
 149   ISCSI_PRIVATE_PROTOCOL          IScsiIdentifier;
 150
 151   EFI_EVENT                       ExitBootServiceEvent;
 152
 153   EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru;
 154   EFI_EXT_SCSI_PASS_THRU_MODE     ExtScsiPassThruMode;
 155   EFI_HANDLE                      ExtScsiPassThruHandle;
 156   EFI_DEVICE_PATH_PROTOCOL        *DevicePath;
 157
 158   ISCSI_SESSION                   Session;
 159 };
 160
 161 #endif