2 The shared head file for iSCSI driver.
4 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
5 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
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.
15 #ifndef _ISCSI_IMPL_H_
16 #define _ISCSI_IMPL_H_
20 #include <IndustryStandard/Dhcp.h>
22 #include <Protocol/ComponentName.h>
23 #include <Protocol/ComponentName2.h>
24 #include <Protocol/DriverBinding.h>
25 #include <Protocol/DevicePath.h>
26 #include <Protocol/HiiConfigAccess.h>
28 #include <Protocol/Ip6.h>
29 #include <Protocol/Dhcp4.h>
30 #include <Protocol/Dhcp6.h>
31 #include <Protocol/Dns4.h>
32 #include <Protocol/Dns6.h>
33 #include <Protocol/Tcp4.h>
34 #include <Protocol/Tcp6.h>
35 #include <Protocol/Ip4Config2.h>
36 #include <Protocol/Ip6Config.h>
38 #include <Protocol/AuthenticationInfo.h>
39 #include <Protocol/IScsiInitiatorName.h>
40 #include <Protocol/ScsiPassThruExt.h>
41 #include <Protocol/AdapterInformation.h>
42 #include <Protocol/NetworkInterfaceIdentifier.h>
44 #include <Library/HiiLib.h>
45 #include <Library/UefiHiiServicesLib.h>
46 #include <Library/DevicePathLib.h>
47 #include <Library/DebugLib.h>
48 #include <Library/BaseLib.h>
49 #include <Library/BaseMemoryLib.h>
50 #include <Library/MemoryAllocationLib.h>
51 #include <Library/PrintLib.h>
52 #include <Library/UefiBootServicesTableLib.h>
53 #include <Library/UefiRuntimeServicesTableLib.h>
54 #include <Library/UefiLib.h>
55 #include <Library/DpcLib.h>
56 #include <Library/NetLib.h>
57 #include <Library/TcpIoLib.h>
58 #include <Library/BaseCryptLib.h>
60 #include <Guid/MdeModuleHii.h>
61 #include <Guid/EventGroup.h>
62 #include <Guid/Acpi.h>
64 #include "IScsiConfigNVDataStruc.h"
65 #include "IScsiDriver.h"
66 #include "IScsiProto.h"
67 #include "IScsiCHAP.h"
68 #include "IScsiDhcp.h"
69 #include "IScsiDhcp6.h"
71 #include "IScsiIbft.h"
72 #include "IScsiMisc.h"
74 #include "IScsiConfig.h"
76 #define ISCSI_AUTH_INITIAL 0
78 #define ISCSI_SESSION_SIGNATURE SIGNATURE_32 ('I', 'S', 'S', 'N')
82 #define ISCSI_GET_MAPPING_TIMEOUT 100000000U
86 #define ISCSI_WAIT_IPSEC_TIMEOUT 30000000U
88 struct _ISCSI_SESSION
{
91 ISCSI_DRIVER_DATA
*Private
;
92 ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
;
96 ISCSI_CHAP_AUTH_DATA CHAP
;
108 UINT32 InitiatorTaskTag
;
117 // Session-wide parameters
119 UINT16 TargetPortalGroupTag
;
120 UINT32 MaxConnections
;
122 BOOLEAN ImmediateData
;
123 UINT32 MaxBurstLength
;
124 UINT32 FirstBurstLength
;
125 UINT32 DefaultTime2Wait
;
126 UINT32 DefaultTime2Retain
;
127 UINT16 MaxOutstandingR2T
;
128 BOOLEAN DataPDUInOrder
;
129 BOOLEAN DataSequenceInOrder
;
130 UINT8 ErrorRecoveryLevel
;
133 #define ISCSI_CONNECTION_SIGNATURE SIGNATURE_32 ('I', 'S', 'C', 'N')
135 struct _ISCSI_CONNECTION
{
139 EFI_EVENT TimeoutEvent
;
141 ISCSI_SESSION
*Session
;
149 BOOLEAN PartialReqSent
;
150 BOOLEAN PartialRspRcvd
;
152 BOOLEAN TransitInitiated
;
153 BOOLEAN ParamNegotiated
;
161 NET_BUF_QUEUE RspQue
;
167 // Connection-only parameters.
169 UINT32 MaxRecvDataSegmentLength
;
170 ISCSI_DIGEST_TYPE HeaderDigest
;
171 ISCSI_DIGEST_TYPE DataDigest
;
174 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
176 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
180 IScsiExtScsiPassThru, \
181 ISCSI_DRIVER_DATA_SIGNATURE \
184 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
189 ISCSI_DRIVER_DATA_SIGNATURE \
192 struct _ISCSI_DRIVER_DATA
{
195 EFI_HANDLE Controller
;
196 ISCSI_PRIVATE_PROTOCOL IScsiIdentifier
;
198 EFI_EVENT ExitBootServiceEvent
;
200 EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru
;
201 EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode
;
202 EFI_HANDLE ExtScsiPassThruHandle
;
203 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
204 EFI_HANDLE ChildHandle
;
205 ISCSI_SESSION
*Session
;