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