2 The shared head file for iSCSI driver.
4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #define _ISCSI_IMPL_H_
14 #include <IndustryStandard/Dhcp.h>
16 #include <Protocol/ComponentName.h>
17 #include <Protocol/ComponentName2.h>
18 #include <Protocol/DriverBinding.h>
19 #include <Protocol/DevicePath.h>
20 #include <Protocol/HiiConfigAccess.h>
22 #include <Protocol/Ip6.h>
23 #include <Protocol/Dhcp4.h>
24 #include <Protocol/Dhcp6.h>
25 #include <Protocol/Dns4.h>
26 #include <Protocol/Dns6.h>
27 #include <Protocol/Tcp4.h>
28 #include <Protocol/Tcp6.h>
29 #include <Protocol/Ip4Config2.h>
30 #include <Protocol/Ip6Config.h>
32 #include <Protocol/AuthenticationInfo.h>
33 #include <Protocol/IScsiInitiatorName.h>
34 #include <Protocol/ScsiPassThruExt.h>
35 #include <Protocol/AdapterInformation.h>
36 #include <Protocol/NetworkInterfaceIdentifier.h>
38 #include <Library/HiiLib.h>
39 #include <Library/UefiHiiServicesLib.h>
40 #include <Library/DevicePathLib.h>
41 #include <Library/DebugLib.h>
42 #include <Library/BaseLib.h>
43 #include <Library/BaseMemoryLib.h>
44 #include <Library/MemoryAllocationLib.h>
45 #include <Library/PrintLib.h>
46 #include <Library/UefiBootServicesTableLib.h>
47 #include <Library/UefiRuntimeServicesTableLib.h>
48 #include <Library/UefiLib.h>
49 #include <Library/DpcLib.h>
50 #include <Library/NetLib.h>
51 #include <Library/TcpIoLib.h>
52 #include <Library/BaseCryptLib.h>
54 #include <Guid/MdeModuleHii.h>
55 #include <Guid/EventGroup.h>
56 #include <Guid/Acpi.h>
58 #include "IScsiConfigNVDataStruc.h"
59 #include "IScsiDriver.h"
60 #include "IScsiProto.h"
61 #include "IScsiCHAP.h"
62 #include "IScsiDhcp.h"
63 #include "IScsiDhcp6.h"
65 #include "IScsiIbft.h"
66 #include "IScsiMisc.h"
68 #include "IScsiConfig.h"
70 #define ISCSI_AUTH_INITIAL 0
72 #define ISCSI_SESSION_SIGNATURE SIGNATURE_32 ('I', 'S', 'S', 'N')
76 #define ISCSI_GET_MAPPING_TIMEOUT 100000000U
80 #define ISCSI_WAIT_IPSEC_TIMEOUT 30000000U
82 struct _ISCSI_SESSION
{
85 ISCSI_DRIVER_DATA
*Private
;
86 ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
;
90 ISCSI_CHAP_AUTH_DATA CHAP
;
102 UINT32 InitiatorTaskTag
;
111 // Session-wide parameters
113 UINT16 TargetPortalGroupTag
;
114 UINT32 MaxConnections
;
116 BOOLEAN ImmediateData
;
117 UINT32 MaxBurstLength
;
118 UINT32 FirstBurstLength
;
119 UINT32 DefaultTime2Wait
;
120 UINT32 DefaultTime2Retain
;
121 UINT16 MaxOutstandingR2T
;
122 BOOLEAN DataPDUInOrder
;
123 BOOLEAN DataSequenceInOrder
;
124 UINT8 ErrorRecoveryLevel
;
127 #define ISCSI_CONNECTION_SIGNATURE SIGNATURE_32 ('I', 'S', 'C', 'N')
129 struct _ISCSI_CONNECTION
{
133 EFI_EVENT TimeoutEvent
;
135 ISCSI_SESSION
*Session
;
143 BOOLEAN PartialReqSent
;
144 BOOLEAN PartialRspRcvd
;
146 BOOLEAN TransitInitiated
;
147 BOOLEAN ParamNegotiated
;
155 NET_BUF_QUEUE RspQue
;
161 // Connection-only parameters.
163 UINT32 MaxRecvDataSegmentLength
;
164 ISCSI_DIGEST_TYPE HeaderDigest
;
165 ISCSI_DIGEST_TYPE DataDigest
;
168 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
170 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
174 IScsiExtScsiPassThru, \
175 ISCSI_DRIVER_DATA_SIGNATURE \
178 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
183 ISCSI_DRIVER_DATA_SIGNATURE \
186 struct _ISCSI_DRIVER_DATA
{
189 EFI_HANDLE Controller
;
190 ISCSI_PRIVATE_PROTOCOL IScsiIdentifier
;
192 EFI_EVENT ExitBootServiceEvent
;
194 EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru
;
195 EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode
;
196 EFI_HANDLE ExtScsiPassThruHandle
;
197 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
198 EFI_HANDLE ChildHandle
;
199 ISCSI_SESSION
*Session
;