2 The shared head file for iSCSI driver.
4 Copyright (c) 2004 - 2016, 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/Tcp4.h>
32 #include <Protocol/Tcp6.h>
34 #include <Protocol/AuthenticationInfo.h>
35 #include <Protocol/IScsiInitiatorName.h>
36 #include <Protocol/ScsiPassThruExt.h>
37 #include <Protocol/AdapterInformation.h>
39 #include <Library/HiiLib.h>
40 #include <Library/UefiHiiServicesLib.h>
41 #include <Library/DevicePathLib.h>
42 #include <Library/DebugLib.h>
43 #include <Library/BaseLib.h>
44 #include <Library/BaseMemoryLib.h>
45 #include <Library/MemoryAllocationLib.h>
46 #include <Library/PrintLib.h>
47 #include <Library/UefiBootServicesTableLib.h>
48 #include <Library/UefiRuntimeServicesTableLib.h>
49 #include <Library/UefiLib.h>
50 #include <Library/DpcLib.h>
51 #include <Library/NetLib.h>
52 #include <Library/TcpIoLib.h>
53 #include <Library/BaseCryptLib.h>
55 #include <Guid/MdeModuleHii.h>
56 #include <Guid/EventGroup.h>
57 #include <Guid/Acpi.h>
59 #include "IScsiConfigNVDataStruc.h"
60 #include "IScsiDriver.h"
61 #include "IScsiProto.h"
62 #include "IScsiCHAP.h"
63 #include "IScsiDhcp.h"
64 #include "IScsiDhcp6.h"
65 #include "IScsiIbft.h"
66 #include "IScsiMisc.h"
67 #include "IScsiConfig.h"
69 #define ISCSI_AUTH_INITIAL 0
71 #define ISCSI_SESSION_SIGNATURE SIGNATURE_32 ('I', 'S', 'S', 'N')
75 #define ISCSI_GET_MAPPING_TIMEOUT 100000000U
79 #define ISCSI_WAIT_IPSEC_TIMEOUT 30000000U
81 struct _ISCSI_SESSION
{
84 ISCSI_DRIVER_DATA
*Private
;
85 ISCSI_ATTEMPT_CONFIG_NVDATA
*ConfigData
;
89 ISCSI_CHAP_AUTH_DATA CHAP
;
101 UINT32 InitiatorTaskTag
;
110 // Session-wide parameters
112 UINT16 TargetPortalGroupTag
;
113 UINT32 MaxConnections
;
115 BOOLEAN ImmediateData
;
116 UINT32 MaxBurstLength
;
117 UINT32 FirstBurstLength
;
118 UINT32 DefaultTime2Wait
;
119 UINT32 DefaultTime2Retain
;
120 UINT16 MaxOutstandingR2T
;
121 BOOLEAN DataPDUInOrder
;
122 BOOLEAN DataSequenceInOrder
;
123 UINT8 ErrorRecoveryLevel
;
126 #define ISCSI_CONNECTION_SIGNATURE SIGNATURE_32 ('I', 'S', 'C', 'N')
128 struct _ISCSI_CONNECTION
{
132 EFI_EVENT TimeoutEvent
;
134 ISCSI_SESSION
*Session
;
142 BOOLEAN PartialReqSent
;
143 BOOLEAN PartialRspRcvd
;
145 BOOLEAN TransitInitiated
;
146 BOOLEAN ParamNegotiated
;
154 NET_BUF_QUEUE RspQue
;
160 // Connection-only parameters.
162 UINT32 MaxRecvDataSegmentLength
;
163 ISCSI_DIGEST_TYPE HeaderDigest
;
164 ISCSI_DIGEST_TYPE DataDigest
;
167 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
169 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
173 IScsiExtScsiPassThru, \
174 ISCSI_DRIVER_DATA_SIGNATURE \
177 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
182 ISCSI_DRIVER_DATA_SIGNATURE \
185 struct _ISCSI_DRIVER_DATA
{
188 EFI_HANDLE Controller
;
189 ISCSI_PRIVATE_PROTOCOL IScsiIdentifier
;
191 EFI_EVENT ExitBootServiceEvent
;
193 EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru
;
194 EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode
;
195 EFI_HANDLE ExtScsiPassThruHandle
;
196 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
197 EFI_HANDLE ChildHandle
;
198 ISCSI_SESSION
*Session
;