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