2 The header file of IScsiImpl.c.
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
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 <Library/BaseMemoryLib.h>
21 #include <Library/MemoryAllocationLib.h>
22 #include <Library/NetLib.h>
23 #include <Library/PrintLib.h>
24 #include <Library/UefiRuntimeServicesTableLib.h>
26 #include <Guid/EventGroup.h>
28 #include "IScsiCommon.h"
29 #include "IScsiDriver.h"
30 #include "IScsiInitiatorName.h"
31 #include "ComponentName.h"
32 #include "IScsiConfigNVDataStruc.h"
33 #include "IScsiExtScsiPassThru.h"
34 #include "IScsiProto.h"
35 #include "IScsiMisc.h"
36 #include "IScsiCHAP.h"
37 #include "IScsiConfig.h"
38 #include "IScsiDhcp.h"
39 #include "IScsiTcp4Io.h"
40 #include "IScsiIbft.h"
43 #define ISCSI_SESSION_SIGNATURE SIGNATURE_32 ('I', 'S', 'S', 'N')
45 struct _ISCSI_SESSION
{
48 ISCSI_SESSION_CONFIG_DATA ConfigData
;
49 ISCSI_CHAP_AUTH_DATA AuthData
;
51 CHAR8 InitiatorName
[ISCSI_NAME_MAX_SIZE
];
52 UINTN InitiatorNameLength
;
62 UINT32 InitiatorTaskTag
;
71 // session-wide parameters
73 UINT16 TargetPortalGroupTag
;
74 UINT32 MaxConnections
;
76 BOOLEAN ImmediateData
;
77 UINT32 MaxBurstLength
;
78 UINT32 FirstBurstLength
;
79 UINT32 DefaultTime2Wait
;
80 UINT32 DefaultTime2Retain
;
81 UINT16 MaxOutstandingR2T
;
82 BOOLEAN DataPDUInOrder
;
83 BOOLEAN DataSequenceInOrder
;
84 UINT8 ErrorRecoveryLevel
;
87 #define ISCSI_CONNECTION_SIGNATURE SIGNATURE_32 ('I', 'S', 'C', 'N')
89 struct _ISCSI_CONNECTION
{
93 EFI_EVENT TimeoutEvent
;
95 ISCSI_SESSION
*Session
;
103 BOOLEAN PartialReqSent
;
104 BOOLEAN PartialRspRcvd
;
106 BOOLEAN TransitInitiated
;
114 NET_BUF_QUEUE RspQue
;
119 // connection-only parameters
121 UINT32 MaxRecvDataSegmentLength
;
122 ISCSI_DIGEST_TYPE HeaderDigest
;
123 ISCSI_DIGEST_TYPE DataDigest
;
126 #define ISCSI_DRIVER_DATA_SIGNATURE SIGNATURE_32 ('I', 'S', 'D', 'A')
128 #define ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU(PassThru) \
132 IScsiExtScsiPassThru, \
133 ISCSI_DRIVER_DATA_SIGNATURE \
135 #define ISCSI_DRIVER_DATA_FROM_IDENTIFIER(Identifier) \
140 ISCSI_DRIVER_DATA_SIGNATURE \
142 #define ISCSI_DRIVER_DATA_FROM_SESSION(s) \
147 ISCSI_DRIVER_DATA_SIGNATURE \
150 struct _ISCSI_DRIVER_DATA
{
153 EFI_HANDLE Controller
;
154 ISCSI_PRIVATE_PROTOCOL IScsiIdentifier
;
156 EFI_EVENT ExitBootServiceEvent
;
158 EFI_EXT_SCSI_PASS_THRU_PROTOCOL IScsiExtScsiPassThru
;
159 EFI_EXT_SCSI_PASS_THRU_MODE ExtScsiPassThruMode
;
160 EFI_HANDLE ExtScsiPassThruHandle
;
161 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
163 ISCSI_SESSION Session
;