]>
Commit | Line | Data |
---|---|---|
4c5a5e0c | 1 | /** @file\r |
2 | The header file of iSCSI Protocol that defines many specific data structures.\r | |
3 | \r | |
9c3dcd0f | 4 | Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>\r |
4c5a5e0c | 5 | This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r | |
7 | which accompanies this distribution. The full text of the license may be found at\r | |
8 | http://opensource.org/licenses/bsd-license.php\r | |
9 | \r | |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
13 | **/\r | |
14 | \r | |
15 | #ifndef _ISCSI_PROTO_H_\r | |
16 | #define _ISCSI_PROTO_H_\r | |
17 | \r | |
18 | //\r | |
19 | // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32\r | |
20 | //\r | |
21 | #define ISCSI_SEQ_EQ(s1, s2) ((s1) == (s2))\r | |
22 | #define ISCSI_SEQ_LT(s1, s2) \\r | |
23 | ( \\r | |
24 | (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \\r | |
25 | (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \\r | |
26 | )\r | |
27 | #define ISCSI_SEQ_GT(s1, s2) \\r | |
28 | ( \\r | |
29 | (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \\r | |
30 | (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \\r | |
31 | )\r | |
32 | \r | |
33 | #define ISCSI_WELL_KNOWN_PORT 3260\r | |
34 | #define ISCSI_MAX_CONNS_PER_SESSION 1\r | |
35 | \r | |
36 | #define DEFAULT_MAX_RECV_DATA_SEG_LEN 8192\r | |
37 | #define MAX_RECV_DATA_SEG_LEN_IN_FFP 65536\r | |
38 | #define DEFAULT_MAX_OUTSTANDING_R2T 1\r | |
39 | \r | |
40 | #define ISCSI_VERSION_MAX 0x00\r | |
41 | #define ISCSI_VERSION_MIN 0x00\r | |
42 | \r | |
152f2d5e | 43 | #define ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r |
44 | #define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r | |
45 | \r | |
9c3dcd0f ZL |
46 | #define ISCSI_REDIRECT_ADDR_START_DELIMITER '['\r |
47 | #define ISCSI_REDIRECT_ADDR_END_DELIMITER ']'\r | |
48 | \r | |
4c5a5e0c | 49 | #define ISCSI_KEY_AUTH_METHOD "AuthMethod"\r |
50 | #define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"\r | |
51 | #define ISCSI_KEY_DATA_DIGEST "DataDigest"\r | |
52 | #define ISCSI_KEY_MAX_CONNECTIONS "MaxConnections"\r | |
53 | #define ISCSI_KEY_TARGET_NAME "TargetName"\r | |
54 | #define ISCSI_KEY_INITIATOR_NAME "InitiatorName"\r | |
55 | #define ISCSI_KEY_TARGET_ALIAS "TargetAlias"\r | |
56 | #define ISCSI_KEY_INITIATOR_ALIAS "InitiatorAlias"\r | |
57 | #define ISCSI_KEY_TARGET_ADDRESS "TargetAddress"\r | |
58 | #define ISCSI_KEY_INITIAL_R2T "InitialR2T"\r | |
59 | #define ISCSI_KEY_IMMEDIATE_DATA "ImmediateData"\r | |
60 | #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG "TargetPortalGroupTag"\r | |
61 | #define ISCSI_KEY_MAX_BURST_LENGTH "MaxBurstLength"\r | |
62 | #define ISCSI_KEY_FIRST_BURST_LENGTH "FirstBurstLength"\r | |
63 | #define ISCSI_KEY_DEFAULT_TIME2WAIT "DefaultTime2Wait"\r | |
64 | #define ISCSI_KEY_DEFAULT_TIME2RETAIN "DefaultTime2Retain"\r | |
65 | #define ISCSI_KEY_MAX_OUTSTANDING_R2T "MaxOutstandingR2T"\r | |
66 | #define ISCSI_KEY_DATA_PDU_IN_ORDER "DataPDUInOrder"\r | |
67 | #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER "DataSequenceInOrder"\r | |
68 | #define ISCSI_KEY_ERROR_RECOVERY_LEVEL "ErrorRecoveryLevel"\r | |
69 | #define ISCSI_KEY_SESSION_TYPE "SessionType"\r | |
70 | #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH "MaxRecvDataSegmentLength"\r | |
71 | \r | |
72 | #define ISCSI_KEY_VALUE_NONE "None"\r | |
73 | \r | |
74 | ///\r | |
75 | /// connection state for initiator\r | |
76 | ///\r | |
77 | \r | |
78 | #define CONN_STATE_FREE 0\r | |
79 | #define CONN_STATE_XPT_WAIT 1\r | |
80 | #define CONN_STATE_IN_LOGIN 2\r | |
81 | #define CONN_STATE_LOGGED_IN 3\r | |
82 | #define CONN_STATE_IN_LOGOUT 4\r | |
83 | #define CONN_STATE_LOGOUT_REQUESTED 5\r | |
84 | #define CONN_STATE_CLEANUP_WAIT 6\r | |
85 | #define CONN_STATE_IN_CLEANUP 7\r | |
86 | \r | |
87 | ///\r | |
88 | /// session state for initiator\r | |
89 | ///\r | |
90 | #define SESSION_STATE_FREE 0\r | |
91 | #define SESSION_STATE_LOGGED_IN 1\r | |
92 | #define SESSION_STATE_FAILED 2\r | |
93 | \r | |
94 | #define ISCSI_RESERVED_TAG 0xffffffff\r | |
95 | \r | |
96 | #define ISCSI_REQ_IMMEDIATE 0x40\r | |
97 | #define ISCSI_OPCODE_MASK 0x3F\r | |
98 | \r | |
99 | #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))\r | |
100 | #define ISCSI_GET_OPCODE(PduHdr) ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)\r | |
101 | #define ISCSI_CHECK_OPCODE(PduHdr, Op) ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))\r | |
102 | #define ISCSI_IMMEDIATE_ON(PduHdr) ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)\r | |
103 | #define ISCSI_SET_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))\r | |
104 | #define ISCSI_CLEAR_FLAG(PduHdr, Flag) (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))\r | |
105 | #define ISCSI_FLAG_ON(PduHdr, Flag) ((BOOLEAN) ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag)))\r | |
106 | #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt) ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))\r | |
107 | #define ISCSI_GET_CURRENT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags >> 2) & 0x3))\r | |
108 | #define ISCSI_GET_NEXT_STAGE(PduHdr) ((UINT8) (((PduHdr)->Flags) & 0x3))\r | |
109 | \r | |
110 | #define ISCSI_GET_PAD_LEN(DataLen) ((~(DataLen) + 1) & 0x3)\r | |
111 | #define ISCSI_ROUNDUP(DataLen) (((DataLen) + 3) &~(0x3))\r | |
112 | \r | |
113 | #define HTON24(Dst, Src) \\r | |
114 | do { \\r | |
115 | (Dst)[0] = (UINT8) ((UINT8) ((Src) >> 16) & 0xFF); \\r | |
116 | (Dst)[1] = (UINT8) ((UINT8) ((Src) >> 8) & 0xFF); \\r | |
117 | (Dst)[2] = (UINT8) ((UINT8) (Src) & 0xFF); \\r | |
118 | } while (0);\r | |
119 | \r | |
120 | #define NTOH24(src) (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))\r | |
121 | \r | |
122 | #define ISCSI_GET_DATASEG_LEN(PduHdr) NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)\r | |
123 | #define ISCSI_SET_DATASEG_LEN(PduHdr, Len) HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))\r | |
124 | #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)\r | |
125 | \r | |
126 | //\r | |
127 | // Initiator opcodes.\r | |
128 | //\r | |
129 | #define ISCSI_OPCODE_NOP_OUT 0x00\r | |
130 | #define ISCSI_OPCODE_SCSI_CMD 0x01\r | |
131 | #define ISCSI_OPCODE_SCSI_TMF_REQ 0x02\r | |
132 | #define ISCSI_OPCODE_LOGIN_REQ 0x03\r | |
133 | #define ISCSI_OPCODE_TEXT_REQ 0x04\r | |
134 | #define ISCSI_OPCODE_SCSI_DATA_OUT 0x05\r | |
135 | #define ISCSI_OPCODE_LOGOUT_REQ 0x06\r | |
136 | #define ISCSI_OPCODE_SNACK_REQ 0x10\r | |
137 | #define ISCSI_OPCODE_VENDOR_I0 0x1c\r | |
138 | #define ISCSI_OPCODE_VENDOR_I1 0x1d\r | |
139 | #define ISCSI_OPCODE_VENDOR_I2 0x1e\r | |
140 | \r | |
141 | //\r | |
142 | // Target opcodes.\r | |
143 | //\r | |
144 | #define ISCSI_OPCODE_NOP_IN 0x20\r | |
145 | #define ISCSI_OPCODE_SCSI_RSP 0x21\r | |
146 | #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22\r | |
147 | #define ISCSI_OPCODE_LOGIN_RSP 0x23\r | |
148 | #define ISCSI_OPCODE_TEXT_RSP 0x24\r | |
149 | #define ISCSI_OPCODE_SCSI_DATA_IN 0x25\r | |
150 | #define ISCSI_OPCODE_LOGOUT_RSP 0x26\r | |
151 | #define ISCSI_OPCODE_R2T 0x31\r | |
152 | #define ISCSI_OPCODE_ASYNC_MSG 0x32\r | |
153 | #define ISCSI_OPCODE_VENDOR_T0 0x3c\r | |
154 | #define ISCSI_OPCODE_VENDOR_T1 0x3d\r | |
155 | #define ISCSI_OPCODE_VENDOR_T2 0x3e\r | |
156 | #define ISCSI_OPCODE_REJECT 0x3f\r | |
157 | \r | |
158 | #define ISCSI_BHS_FLAG_FINAL 0x80\r | |
159 | \r | |
160 | //\r | |
161 | // Defined AHS types, others are reserved.\r | |
162 | //\r | |
163 | #define ISCSI_AHS_TYPE_EXT_CDB 0x1\r | |
164 | #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2\r | |
165 | \r | |
166 | #define SCSI_CMD_PDU_FLAG_READ 0x40\r | |
167 | #define SCSI_CMD_PDU_FLAG_WRITE 0x20\r | |
168 | \r | |
169 | #define ISCSI_CMD_PDU_TASK_ATTR_MASK 0x07\r | |
170 | \r | |
171 | //\r | |
172 | // task attributes\r | |
173 | //\r | |
174 | #define ISCSI_TASK_ATTR_UNTAGGED 0x00\r | |
175 | #define ISCSI_TASK_ATTR_SIMPLE 0x01\r | |
176 | #define ISCSI_TASK_ATTR_ORDERD 0x02\r | |
177 | #define ISCSI_TASK_ATTR_HOQ 0x03\r | |
178 | #define ISCSI_TASK_ATTR_ACA 0x04\r | |
179 | \r | |
180 | //\r | |
181 | // Flag bit definitions in SCSI response.\r | |
182 | //\r | |
183 | #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW 0x10\r | |
184 | #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08\r | |
185 | #define SCSI_RSP_PDU_FLAG_OVERFLOW 0x04\r | |
186 | #define SCSI_RSP_PDU_FLAG_UNDERFLOW 0x02\r | |
187 | \r | |
188 | //\r | |
189 | // iSCSI service response codes.\r | |
190 | //\r | |
191 | #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET 0x00\r | |
192 | #define ISCSI_SERVICE_RSP_TARGET_FAILURE 0x01\r | |
193 | \r | |
194 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE 0\r | |
195 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST 1\r | |
196 | #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST 2\r | |
197 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT 3\r | |
198 | #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4\r | |
199 | #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED 5\r | |
200 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED 6\r | |
201 | #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED 255\r | |
202 | \r | |
203 | #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE 0x40\r | |
204 | #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW SCSI_RSP_PDU_FLAG_OVERFLOW\r | |
205 | #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW SCSI_RSP_PDU_FLAG_UNDERFLOW\r | |
206 | #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID 0x01\r | |
207 | \r | |
208 | #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT 0x80\r | |
209 | #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40\r | |
210 | \r | |
211 | #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT\r | |
212 | #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE\r | |
213 | \r | |
214 | #define ISCSI_LOGIN_STATUS_SUCCESS 0\r | |
215 | #define ISCSI_LOGIN_STATUS_REDIRECTION 1\r | |
216 | #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR 2\r | |
217 | #define ISCSI_LOGIN_STATUS_TARGET_ERROR 3\r | |
218 | \r | |
219 | #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0\r | |
220 | #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1\r | |
221 | #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY 2\r | |
222 | \r | |
223 | #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS 0\r | |
224 | #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND 1\r | |
225 | #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED 2\r | |
226 | #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED 3\r | |
227 | \r | |
228 | #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T 0\r | |
229 | #define ISCSI_SNACK_REQUEST_TYPE_STATUS 1\r | |
230 | #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK 2\r | |
231 | #define ISCSI_SNACK_REQUEST_TYPE_RDATA 3\r | |
232 | \r | |
233 | #define ISCSI_SECURITY_NEGOTIATION 0\r | |
234 | #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1\r | |
235 | #define ISCSI_FULL_FEATURE_PHASE 3\r | |
236 | \r | |
237 | typedef struct _ISCSI_SESSION ISCSI_SESSION;\r | |
238 | typedef struct _ISCSI_CONNECTION ISCSI_CONNECTION;\r | |
239 | \r | |
240 | typedef enum {\r | |
241 | DataIn = 0,\r | |
242 | DataOut = 1,\r | |
243 | DataBi = 2\r | |
244 | } DATA_DIRECTION;\r | |
245 | \r | |
246 | ///\r | |
247 | /// iSCSI Basic Header Segment\r | |
248 | ///\r | |
249 | typedef struct _ISCSI_BASIC_HEADER {\r | |
250 | UINT8 OpCode;\r | |
251 | UINT8 Flags;\r | |
252 | UINT16 OpCodeSpecific1;\r | |
253 | UINT8 TotalAHSLength;\r | |
254 | UINT8 DataSegmentLength[3];\r | |
255 | UINT8 Lun[8];\r | |
256 | UINT32 InitiatorTaskTag;\r | |
257 | UINT32 OpCodeSpecific2[7];\r | |
258 | } ISCSI_BASIC_HEADER;\r | |
259 | \r | |
260 | typedef struct _ISCSI_ADDTIONAL_HEADER {\r | |
261 | UINT16 Length;\r | |
262 | UINT8 Type;\r | |
263 | UINT8 TypeSpecific[1];\r | |
264 | } ISCSI_ADDITIONAL_HEADER;\r | |
265 | \r | |
266 | typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS {\r | |
267 | UINT16 Length;\r | |
268 | UINT8 Type;\r | |
269 | UINT8 Reserved;\r | |
270 | UINT32 ExpReadDataLength;\r | |
271 | } ISCSI_BI_EXP_READ_DATA_LEN_AHS;\r | |
272 | \r | |
273 | ///\r | |
274 | /// SCSI Command\r | |
275 | ///\r | |
276 | typedef struct _SCSI_COMMAND {\r | |
277 | UINT8 OpCode;\r | |
278 | UINT8 Flags;\r | |
279 | UINT16 Reserved;\r | |
280 | UINT8 TotalAHSLength;\r | |
281 | UINT8 DataSegmentLength[3];\r | |
282 | UINT8 Lun[8];\r | |
283 | UINT32 InitiatorTaskTag;\r | |
284 | UINT32 ExpDataXferLength;\r | |
285 | UINT32 CmdSN;\r | |
286 | UINT32 ExpStatSN;\r | |
287 | UINT8 Cdb[16];\r | |
288 | } SCSI_COMMAND;\r | |
289 | \r | |
290 | ///\r | |
291 | /// SCSI Response\r | |
292 | ///\r | |
293 | typedef struct _SCSI_RESPONSE {\r | |
294 | UINT8 OpCode;\r | |
295 | UINT8 Flags;\r | |
296 | UINT8 Response;\r | |
297 | UINT8 Status;\r | |
298 | UINT8 TotalAHSLength;\r | |
299 | UINT8 DataSegmentLength[3];\r | |
300 | UINT8 Reserved[8];\r | |
301 | UINT32 InitiatorTaskTag;\r | |
302 | UINT32 SNACKTag;\r | |
303 | UINT32 StatSN;\r | |
304 | UINT32 ExpCmdSN;\r | |
305 | UINT32 MaxCmdSN;\r | |
306 | UINT32 ExpDataSN;\r | |
307 | UINT32 BiReadResidualCount;\r | |
308 | UINT32 ResidualCount;\r | |
309 | } SCSI_RESPONSE;\r | |
310 | \r | |
311 | typedef struct _ISCSI_SENSE_DATA {\r | |
312 | UINT16 Length;\r | |
313 | UINT8 Data[2];\r | |
314 | } ISCSI_SENSE_DATA;\r | |
315 | \r | |
316 | ///\r | |
317 | /// iSCSI Task Managment Function Request.\r | |
318 | ///\r | |
319 | typedef struct _ISCSI_TMF_REQUEST {\r | |
320 | UINT8 OpCode;\r | |
321 | UINT8 Fuction;\r | |
322 | UINT16 Reserved1;\r | |
323 | UINT8 TotalAHSLength;\r | |
324 | UINT8 DataSegmentLength[3];\r | |
325 | UINT8 Lun[8];\r | |
326 | UINT32 InitiatorTaskTag;\r | |
327 | UINT32 ReferencedTaskTag;\r | |
328 | UINT32 CmdSN;\r | |
329 | UINT32 ExpStatSN;\r | |
330 | UINT32 RefCmdSN;\r | |
331 | UINT32 ExpDataSN;\r | |
332 | UINT32 Reserved2[2];\r | |
333 | } ISCSI_TMF_REQUEST;\r | |
334 | \r | |
335 | ///\r | |
336 | /// iSCSI Task Management Function Response.\r | |
337 | ///\r | |
338 | typedef struct _ISCSI_TMF_RESPONSE {\r | |
339 | UINT8 OpCode;\r | |
340 | UINT8 Reserved1;\r | |
341 | UINT8 Response;\r | |
342 | UINT8 Reserved2;\r | |
343 | UINT8 TotalAHSLength;\r | |
344 | UINT8 DataSegmentLength[3];\r | |
345 | UINT32 Reserver3[2];\r | |
346 | UINT32 InitiatorTaskTag;\r | |
347 | UINT32 Reserved4;\r | |
348 | UINT32 StatSN;\r | |
349 | UINT32 ExpCmdSN;\r | |
350 | UINT32 MaxCmdSN;\r | |
351 | UINT32 Reserved[3];\r | |
352 | } ISCSI_TMF_RESPONSE;\r | |
353 | \r | |
354 | ///\r | |
355 | /// SCSI Data-Out\r | |
356 | ///\r | |
357 | typedef struct _ISCSI_SCSI_DATA_OUT {\r | |
358 | UINT8 OpCode;\r | |
359 | UINT8 Reserved1[3];\r | |
360 | UINT8 TotalAHSLength;\r | |
361 | UINT8 DataSegmentLength[3];\r | |
362 | UINT8 Lun[8];\r | |
363 | UINT32 InitiatorTaskTag;\r | |
364 | UINT32 TargetTransferTag;\r | |
365 | UINT32 Reserved2;\r | |
366 | UINT32 ExpStatSN;\r | |
367 | UINT32 Reserved3;\r | |
368 | UINT32 DataSN;\r | |
369 | UINT32 BufferOffset;\r | |
370 | UINT32 Reserved4;\r | |
371 | } ISCSI_SCSI_DATA_OUT;\r | |
372 | \r | |
373 | ///\r | |
374 | /// SCSI Data-In\r | |
375 | ///\r | |
376 | typedef struct _ISCSI_SCSI_DATA_IN {\r | |
377 | UINT8 OpCode;\r | |
378 | UINT8 Flags;\r | |
379 | UINT8 Reserved1;\r | |
380 | UINT8 Status;\r | |
381 | UINT8 TotalAHSLength;\r | |
382 | UINT8 DataSegmentLength[3];\r | |
383 | UINT8 Lun[8];\r | |
384 | UINT32 InitiatorTaskTag;\r | |
385 | UINT32 TargetTransferTag;\r | |
386 | UINT32 StatSN;\r | |
387 | UINT32 ExpCmdSN;\r | |
388 | UINT32 MaxCmdSN;\r | |
389 | UINT32 DataSN;\r | |
390 | UINT32 BufferOffset;\r | |
391 | UINT32 ResidualCount;\r | |
392 | } ISCSI_SCSI_DATA_IN;\r | |
393 | \r | |
394 | ///\r | |
395 | /// Ready To Transfer.\r | |
396 | ///\r | |
397 | typedef struct _ISCSI_READY_TO_TRANSFER {\r | |
398 | UINT8 OpCode;\r | |
399 | UINT8 Reserved1[3];\r | |
400 | UINT8 TotalAHSLength;\r | |
401 | UINT8 DataSegmentLength[3];\r | |
402 | UINT8 Lun[8];\r | |
403 | UINT32 InitiatorTaskTag;\r | |
404 | UINT32 TargetTransferTag;\r | |
405 | UINT32 StatSN;\r | |
406 | UINT32 ExpCmdSN;\r | |
407 | UINT32 MaxCmdSN;\r | |
408 | UINT32 R2TSeqNum;\r | |
409 | UINT32 BufferOffset;\r | |
410 | UINT32 DesiredDataTransferLength;\r | |
411 | } ISCSI_READY_TO_TRANSFER;\r | |
412 | \r | |
413 | typedef struct _ISCSI_ASYNC_MESSAGE {\r | |
414 | UINT8 OpCode;\r | |
415 | UINT8 Reserved1[8];\r | |
416 | UINT8 TotalAHSLength;\r | |
417 | UINT8 DataSegmentLength[3];\r | |
418 | UINT8 Lun[8];\r | |
419 | UINT32 InitiatorTaskTag;\r | |
420 | UINT32 Reserved2;\r | |
421 | UINT32 StatSN;\r | |
422 | UINT32 ExpCmdSN;\r | |
423 | UINT32 MaxCmdSN;\r | |
424 | UINT8 AsyncEvent;\r | |
425 | UINT8 AsyncVCode;\r | |
426 | UINT16 Parameter1;\r | |
427 | UINT16 Parameter2;\r | |
428 | UINT16 Parameter3;\r | |
429 | UINT32 Reserved3;\r | |
430 | } ISCSI_ASYNC_MESSAGE;\r | |
431 | \r | |
432 | ///\r | |
433 | /// Login Request.\r | |
434 | ///\r | |
435 | typedef struct _ISCSI_LOGIN_REQUEST {\r | |
436 | UINT8 OpCode;\r | |
437 | UINT8 Flags;\r | |
438 | UINT8 VersionMax;\r | |
439 | UINT8 VersionMin;\r | |
440 | UINT8 TotalAHSLength;\r | |
441 | UINT8 DataSegmentLength[3];\r | |
442 | UINT8 Isid[6];\r | |
443 | UINT16 Tsih;\r | |
444 | UINT32 InitiatorTaskTag;\r | |
445 | UINT16 Cid;\r | |
446 | UINT16 Reserved1;\r | |
447 | UINT32 CmdSN;\r | |
448 | UINT32 ExpStatSN;\r | |
449 | UINT32 Reserved2[4];\r | |
450 | } ISCSI_LOGIN_REQUEST;\r | |
451 | \r | |
452 | ///\r | |
453 | /// Login Response.\r | |
454 | ///\r | |
455 | typedef struct _ISCSI_LOGIN_RESPONSE {\r | |
456 | UINT8 OpCode;\r | |
457 | UINT8 Flags;\r | |
458 | UINT8 VersionMax;\r | |
459 | UINT8 VersionActive;\r | |
460 | UINT8 TotalAHSLength;\r | |
461 | UINT8 DataSegmentLength[3];\r | |
462 | UINT8 Isid[6];\r | |
463 | UINT16 Tsih;\r | |
464 | UINT32 InitiatorTaskTag;\r | |
465 | UINT32 Reserved1;\r | |
466 | UINT32 StatSN;\r | |
467 | UINT32 ExpCmdSN;\r | |
468 | UINT32 MaxCmdSN;\r | |
469 | UINT8 StatusClass;\r | |
470 | UINT8 StatusDetail;\r | |
471 | UINT8 Reserved2[10];\r | |
472 | } ISCSI_LOGIN_RESPONSE;\r | |
473 | \r | |
474 | ///\r | |
475 | /// Logout Request.\r | |
476 | ///\r | |
477 | typedef struct _ISCSI_LOGOUT_REQUEST {\r | |
478 | UINT8 OpCode;\r | |
479 | UINT8 ReasonCode;\r | |
480 | UINT16 Reserved1;\r | |
481 | UINT8 TotalAHSLength;\r | |
482 | UINT8 DataSegmentLength[3];\r | |
483 | UINT32 Reserved2[2];\r | |
484 | UINT32 InitiatorTaskTag;\r | |
485 | UINT16 Cid;\r | |
486 | UINT16 Reserved3;\r | |
487 | UINT32 CmdSN;\r | |
488 | UINT32 ExpStatSN;\r | |
489 | UINT32 Reserved4[4];\r | |
490 | } ISCSI_LOGOUT_REQUEST;\r | |
491 | \r | |
492 | ///\r | |
493 | /// Logout Response.\r | |
494 | ///\r | |
495 | typedef struct _ISCSI_LOGOUT_RESPONSE {\r | |
496 | UINT8 OpCode;\r | |
497 | UINT8 Reserved1;\r | |
498 | UINT8 Response;\r | |
499 | UINT8 Reserved2;\r | |
500 | UINT8 TotalAHSLength;\r | |
501 | UINT8 DataSegmentLength[3];\r | |
502 | UINT32 Reserved3[2];\r | |
503 | UINT32 InitiatorTaskTag;\r | |
504 | UINT32 Reserved4;\r | |
505 | UINT32 StatSN;\r | |
506 | UINT32 ExpCmdSN;\r | |
507 | UINT32 MaxCmdSN;\r | |
508 | UINT32 Reserved5;\r | |
509 | UINT16 Time2Wait;\r | |
510 | UINT16 Time2Retain;\r | |
511 | UINT32 Reserved6;\r | |
512 | } ISCSI_LOGOUT_RESPONSE;\r | |
513 | \r | |
514 | ///\r | |
515 | /// SNACK Request.\r | |
516 | ///\r | |
517 | typedef struct _ISCSI_SNACK_REQUEST {\r | |
518 | UINT8 OpCode;\r | |
519 | UINT8 Type;\r | |
520 | UINT16 Reserved1;\r | |
521 | UINT8 TotalAHSLength;\r | |
522 | UINT8 DataSegmentLength[3];\r | |
523 | UINT8 Lun[8];\r | |
524 | UINT32 InitiatorTaskTag;\r | |
525 | UINT32 TargetTransferTag;\r | |
526 | UINT32 Reserved2;\r | |
527 | UINT32 ExpStatSN;\r | |
528 | UINT32 Reserved[2];\r | |
529 | UINT32 BegRun;\r | |
530 | UINT32 RunLength;\r | |
531 | } ISCSI_SNACK_REQUEST;\r | |
532 | \r | |
533 | ///\r | |
534 | /// Reject.\r | |
535 | ///\r | |
536 | typedef struct _ISCSI_REJECT {\r | |
537 | UINT8 OpCode;\r | |
538 | UINT8 Reserved1;\r | |
539 | UINT8 Reason;\r | |
540 | UINT8 Reserved2;\r | |
541 | UINT8 TotalAHSLength;\r | |
542 | UINT8 DataSegmentLength[3];\r | |
543 | UINT32 Reserved3[2];\r | |
544 | UINT32 InitiatorTaskTag;\r | |
545 | UINT32 Reserved4;\r | |
546 | UINT32 StatSN;\r | |
547 | UINT32 ExpCmdSN;\r | |
548 | UINT32 MaxCmdSN;\r | |
549 | UINT32 DataSN;\r | |
550 | UINT32 Reserved5[2];\r | |
551 | } ISCSI_REJECT;\r | |
552 | \r | |
553 | ///\r | |
554 | /// NOP-Out.\r | |
555 | ///\r | |
556 | typedef struct _ISCSI_NOP_OUT {\r | |
557 | UINT8 OpCode;\r | |
558 | UINT8 Reserved1[3];\r | |
559 | UINT8 TotalAHSLength;\r | |
560 | UINT8 DataSegmentLength[3];\r | |
561 | UINT8 Lun[8];\r | |
562 | UINT32 InitiatorTaskTag;\r | |
563 | UINT32 TargetTransferTag;\r | |
564 | UINT32 CmdSN;\r | |
565 | UINT32 ExpStatSN;\r | |
566 | UINT32 Reserved2[4];\r | |
567 | } ISCSI_NOP_OUT;\r | |
568 | \r | |
569 | ///\r | |
570 | /// NOP-In.\r | |
571 | ///\r | |
572 | typedef struct _ISCSI_NOP_IN {\r | |
573 | UINT8 OpCode;\r | |
574 | UINT8 Reserved1[3];\r | |
575 | UINT8 TotalAHSLength;\r | |
576 | UINT8 DataSegmentLength[3];\r | |
577 | UINT8 Lun[8];\r | |
578 | UINT32 InitiatorTaskTag;\r | |
579 | UINT32 TargetTransferTag;\r | |
580 | UINT32 StatSN;\r | |
581 | UINT32 ExpCmdSN;\r | |
582 | UINT32 MaxCmdSN;\r | |
583 | UINT32 Reserved2[3];\r | |
584 | } ISCSI_NOP_IN;\r | |
585 | \r | |
586 | typedef enum {\r | |
587 | IScsiDigestNone,\r | |
588 | IScsiDigestCRC32\r | |
589 | } ISCSI_DIGEST_TYPE;\r | |
590 | \r | |
591 | typedef struct _ISCSI_XFER_CONTEXT {\r | |
592 | UINT32 TargetTransferTag;\r | |
593 | UINT32 Offset;\r | |
594 | UINT32 DesiredLength;\r | |
595 | UINT32 ExpDataSN;\r | |
596 | } ISCSI_XFER_CONTEXT;\r | |
597 | \r | |
598 | typedef struct _ISCSI_IN_BUFFER_CONTEXT {\r | |
599 | UINT8 *InData;\r | |
600 | UINT32 InDataLen;\r | |
601 | } ISCSI_IN_BUFFER_CONTEXT;\r | |
602 | \r | |
603 | typedef struct _ISCSI_TCB {\r | |
604 | LIST_ENTRY Link;\r | |
605 | \r | |
606 | BOOLEAN SoFarInOrder;\r | |
607 | UINT32 ExpDataSN;\r | |
608 | BOOLEAN FbitReceived;\r | |
609 | BOOLEAN StatusXferd;\r | |
610 | UINT32 ActiveR2Ts;\r | |
611 | UINT32 Response;\r | |
612 | CHAR8 *Reason;\r | |
613 | UINT32 InitiatorTaskTag;\r | |
614 | UINT32 CmdSN;\r | |
615 | UINT32 SNACKTag;\r | |
616 | \r | |
617 | ISCSI_XFER_CONTEXT XferContext;\r | |
618 | \r | |
619 | ISCSI_CONNECTION *Conn;\r | |
620 | } ISCSI_TCB;\r | |
621 | \r | |
622 | typedef struct _ISCSI_KEY_VALUE_PAIR {\r | |
623 | LIST_ENTRY List;\r | |
624 | \r | |
625 | CHAR8 *Key;\r | |
626 | CHAR8 *Value;\r | |
627 | } ISCSI_KEY_VALUE_PAIR;\r | |
628 | \r | |
629 | /**\r | |
630 | Attach the iSCSI connection to the iSCSI session. \r | |
631 | \r | |
632 | @param[in, out] Session The iSCSI session.\r | |
633 | @param[in, out] Conn The iSCSI connection.\r | |
634 | \r | |
635 | **/\r | |
636 | VOID\r | |
637 | IScsiAttatchConnection (\r | |
638 | IN OUT ISCSI_SESSION *Session,\r | |
639 | IN OUT ISCSI_CONNECTION *Conn\r | |
640 | );\r | |
641 | \r | |
642 | /**\r | |
643 | Detach the iSCSI connection from the session it belongs to. \r | |
644 | \r | |
645 | @param[in, out] Conn The iSCSI connection.\r | |
646 | \r | |
647 | **/\r | |
648 | VOID\r | |
649 | IScsiDetatchConnection (\r | |
650 | IN OUT ISCSI_CONNECTION *Conn\r | |
651 | );\r | |
652 | \r | |
653 | /**\r | |
654 | This function performs the iSCSI connection login.\r | |
655 | \r | |
656 | @param[in, out] Conn The iSCSI connection to login.\r | |
657 | @param Timeout The timeout value in milliseconds.\r | |
658 | \r | |
659 | @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r | |
660 | @retval EFI_TIMEOUT Timeout occurred during the login procedure.\r | |
661 | @retval Others Other errors as indicated. \r | |
662 | \r | |
663 | **/\r | |
664 | EFI_STATUS\r | |
665 | IScsiConnLogin (\r | |
666 | IN OUT ISCSI_CONNECTION *Conn,\r | |
667 | IN UINT16 Timeout\r | |
668 | );\r | |
669 | \r | |
670 | /**\r | |
671 | Create a TCP connection for the iSCSI session.\r | |
672 | \r | |
673 | @param[in] Session Points to the iSCSI session.\r | |
674 | \r | |
675 | @return The newly created iSCSI connection.\r | |
676 | \r | |
677 | **/\r | |
678 | ISCSI_CONNECTION *\r | |
679 | IScsiCreateConnection (\r | |
680 | IN ISCSI_SESSION *Session\r | |
681 | );\r | |
682 | \r | |
683 | /**\r | |
684 | Destroy an iSCSI connection.\r | |
685 | \r | |
686 | @param[in] Conn The connection to destroy.\r | |
687 | \r | |
688 | **/\r | |
689 | VOID\r | |
690 | IScsiDestroyConnection (\r | |
691 | IN ISCSI_CONNECTION *Conn\r | |
692 | );\r | |
693 | \r | |
694 | /**\r | |
695 | Login the iSCSI session.\r | |
696 | \r | |
697 | @param[in] Session The iSCSI session\r | |
698 | \r | |
699 | @retval EFI_SUCCESS The iSCSI session login procedure finished.\r | |
700 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
701 | @retval EFI_NO_MEDIA There was a media error.\r | |
702 | @retval Others Other errors as indicated.\r | |
703 | \r | |
704 | **/\r | |
705 | EFI_STATUS\r | |
706 | IScsiSessionLogin (\r | |
707 | IN ISCSI_SESSION *Session\r | |
708 | );\r | |
709 | \r | |
710 | /**\r | |
711 | Wait for IPsec negotiation, then try to login the iSCSI session again.\r | |
712 | \r | |
713 | @param[in] Session The iSCSI session\r | |
714 | \r | |
715 | @retval EFI_SUCCESS The iSCSI session login procedure finished.\r | |
716 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
717 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r | |
718 | \r | |
719 | **/\r | |
720 | EFI_STATUS\r | |
721 | IScsiSessionReLogin (\r | |
722 | IN ISCSI_SESSION *Session\r | |
723 | );\r | |
724 | \r | |
725 | /**\r | |
726 | Build and send the iSCSI login request to the iSCSI target according to\r | |
727 | the current login stage.\r | |
728 | \r | |
729 | @param[in] Conn The connection in the iSCSI login phase.\r | |
730 | \r | |
731 | @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this\r | |
732 | connection.\r | |
733 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
734 | @retval EFI_DEVICE_ERROR Some kind of device error happened.\r | |
735 | \r | |
736 | **/\r | |
737 | EFI_STATUS\r | |
738 | IScsiSendLoginReq (\r | |
739 | IN ISCSI_CONNECTION *Conn\r | |
740 | );\r | |
741 | \r | |
742 | /**\r | |
743 | Receive and process the iSCSI login response.\r | |
744 | \r | |
745 | @param[in] Conn The connection in the iSCSI login phase.\r | |
746 | \r | |
747 | @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.\r | |
748 | @retval Others Other errors as indicated.\r | |
749 | \r | |
750 | **/\r | |
751 | EFI_STATUS\r | |
752 | IScsiReceiveLoginRsp (\r | |
753 | IN ISCSI_CONNECTION *Conn\r | |
754 | );\r | |
755 | \r | |
756 | /**\r | |
757 | Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.\r | |
758 | The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r | |
759 | updated.\r | |
760 | \r | |
761 | @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will\r | |
762 | be added to.\r | |
763 | @param[in] Key The key name string.\r | |
764 | @param[in] Value The value string.\r | |
765 | \r | |
766 | @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and\r | |
767 | the correspondence length fields are updated.\r | |
768 | @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value\r | |
769 | pair.\r | |
770 | **/\r | |
771 | EFI_STATUS\r | |
772 | IScsiAddKeyValuePair (\r | |
773 | IN OUT NET_BUF *Pdu,\r | |
774 | IN CHAR8 *Key,\r | |
775 | IN CHAR8 *Value\r | |
776 | );\r | |
777 | \r | |
778 | /**\r | |
779 | Prepare the iSCSI login request to be sent according to the current login status.\r | |
780 | \r | |
781 | @param[in, out] Conn The connection in the iSCSI login phase.\r | |
782 | \r | |
783 | @return The pointer to the net buffer containing the iSCSI login request built.\r | |
784 | @retval NULL Other errors as indicated.\r | |
785 | \r | |
786 | **/\r | |
787 | NET_BUF *\r | |
788 | IScsiPrepareLoginReq (\r | |
789 | IN OUT ISCSI_CONNECTION *Conn\r | |
790 | );\r | |
791 | \r | |
792 | /**\r | |
793 | Process the iSCSI Login Response.\r | |
794 | \r | |
795 | @param[in, out] Conn The connection on which the iSCSI login response is received.\r | |
796 | @param[in, out] Pdu The iSCSI login response PDU.\r | |
797 | \r | |
798 | @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.\r | |
799 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r | |
800 | @retval EFI_MEDIA_CHANGED Target is redirected.\r | |
801 | @retval Others Other errors as indicated.\r | |
802 | \r | |
803 | **/\r | |
804 | EFI_STATUS\r | |
805 | IScsiProcessLoginRsp (\r | |
806 | IN OUT ISCSI_CONNECTION *Conn,\r | |
807 | IN OUT NET_BUF *Pdu\r | |
808 | );\r | |
809 | \r | |
810 | /**\r | |
811 | Updated the target information according the data received in the iSCSI\r | |
812 | login response with an target redirection status.\r | |
813 | \r | |
814 | @param[in, out] Session The iSCSI session.\r | |
815 | @param[in] Data The data segment which should contain the\r | |
816 | TargetAddress key-value list.\r | |
817 | @param[in] Len Length of the data.\r | |
818 | \r | |
819 | @retval EFI_SUCCESS The target address is updated.\r | |
820 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
821 | @retval EFI_NOT_FOUND The TargetAddress key is not found.\r | |
822 | @retval Others Other errors as indicated.\r | |
823 | \r | |
824 | **/\r | |
825 | EFI_STATUS\r | |
826 | IScsiUpdateTargetAddress (\r | |
827 | IN OUT ISCSI_SESSION *Session,\r | |
828 | IN CHAR8 *Data,\r | |
829 | IN UINT32 Len\r | |
830 | );\r | |
831 | \r | |
832 | /**\r | |
833 | The callback function to free the net buffer list.\r | |
834 | \r | |
835 | @param[in] Arg The opaque parameter.\r | |
836 | \r | |
837 | **/\r | |
838 | VOID\r | |
839 | EFIAPI\r | |
840 | IScsiFreeNbufList (\r | |
841 | VOID *Arg\r | |
842 | );\r | |
843 | \r | |
844 | /**\r | |
845 | Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and\r | |
846 | an optional data segment. The two parts will be put into two blocks of buffers in the\r | |
847 | net buffer. The digest check will be conducted in this function if needed and the digests\r | |
848 | will be trimmed from the PDU buffer.\r | |
849 | \r | |
850 | @param[in] Conn The iSCSI connection to receive data from.\r | |
851 | @param[out] Pdu The received iSCSI pdu.\r | |
852 | @param[in] Context The context used to describe information on the caller provided\r | |
853 | buffer to receive data segment of the iSCSI pdu, it's optional.\r | |
854 | @param[in] HeaderDigest Whether there will be header digest received.\r | |
855 | @param[in] DataDigest Whether there will be data digest.\r | |
856 | @param[in] TimeoutEvent The timeout event, it's optional.\r | |
857 | \r | |
858 | @retval EFI_SUCCESS An iSCSI pdu is received.\r | |
859 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
860 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r | |
861 | @retval Others Other errors as indicated.\r | |
862 | \r | |
863 | **/\r | |
864 | EFI_STATUS\r | |
865 | IScsiReceivePdu (\r | |
866 | IN ISCSI_CONNECTION *Conn,\r | |
867 | OUT NET_BUF **Pdu,\r | |
868 | IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL\r | |
869 | IN BOOLEAN HeaderDigest,\r | |
870 | IN BOOLEAN DataDigest,\r | |
871 | IN EFI_EVENT TimeoutEvent OPTIONAL\r | |
872 | );\r | |
873 | \r | |
874 | /**\r | |
75acfab6 | 875 | Check and get the result of the parameter negotiation.\r |
4c5a5e0c | 876 | \r |
877 | @param[in, out] Conn The connection in iSCSI login.\r | |
878 | \r | |
879 | @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.\r | |
880 | @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r | |
881 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
882 | \r | |
883 | **/\r | |
884 | EFI_STATUS\r | |
885 | IScsiCheckOpParams (\r | |
886 | IN OUT ISCSI_CONNECTION *Conn\r | |
887 | );\r | |
888 | \r | |
889 | /**\r | |
75acfab6 | 890 | Fill the operational parameters.\r |
4c5a5e0c | 891 | \r |
892 | @param[in] Conn The connection in iSCSI login.\r | |
893 | @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r | |
894 | \r | |
895 | **/\r | |
896 | VOID\r | |
897 | IScsiFillOpParams (\r | |
898 | IN ISCSI_CONNECTION *Conn,\r | |
899 | IN OUT NET_BUF *Pdu\r | |
900 | );\r | |
901 | \r | |
902 | /**\r | |
903 | Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r | |
904 | \r | |
905 | @param[in, out] Pdu The iSCSI pdu which contains segments to pad.\r | |
906 | @param[in] Len The length of the last semgnet in the PDU.\r | |
907 | \r | |
908 | @retval EFI_SUCCESS The segment is padded or no need to pad it.\r | |
909 | @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r | |
910 | padding bytes.\r | |
911 | **/\r | |
912 | EFI_STATUS\r | |
913 | IScsiPadSegment (\r | |
914 | IN OUT NET_BUF *Pdu,\r | |
915 | IN UINT32 Len\r | |
916 | );\r | |
917 | \r | |
918 | /**\r | |
919 | Build a key-value list from the data segment.\r | |
920 | \r | |
921 | @param[in] Data The data segment containing the key-value pairs.\r | |
922 | @param[in] Len Length of the data segment.\r | |
923 | \r | |
924 | @return The key-value list.\r | |
925 | @retval NULL Other errors as indicated.\r | |
926 | \r | |
927 | **/\r | |
928 | LIST_ENTRY *\r | |
929 | IScsiBuildKeyValueList (\r | |
930 | IN CHAR8 *Data,\r | |
931 | IN UINT32 Len\r | |
932 | );\r | |
933 | \r | |
934 | /**\r | |
935 | Get the value string by the key name from the key-value list. If found,\r | |
936 | the key-value entry will be removed from the list.\r | |
937 | \r | |
938 | @param[in, out] KeyValueList The key-value list.\r | |
939 | @param[in] Key The key name to find.\r | |
940 | \r | |
941 | @return The value string.\r | |
942 | @retval NULL The key value pair can not be found.\r | |
943 | \r | |
944 | **/\r | |
945 | CHAR8 *\r | |
946 | IScsiGetValueByKeyFromList (\r | |
947 | IN OUT LIST_ENTRY *KeyValueList,\r | |
948 | IN CHAR8 *Key\r | |
949 | );\r | |
950 | \r | |
951 | /**\r | |
952 | Free the key-value list.\r | |
953 | \r | |
954 | @param[in] KeyValueList The key-value list.\r | |
955 | \r | |
956 | **/\r | |
957 | VOID\r | |
958 | IScsiFreeKeyValueList (\r | |
959 | IN LIST_ENTRY *KeyValueList\r | |
960 | );\r | |
961 | \r | |
962 | /**\r | |
963 | Normalize the iSCSI name according to RFC.\r | |
964 | \r | |
965 | @param[in, out] Name The iSCSI name.\r | |
966 | @param[in] Len length of the iSCSI name.\r | |
967 | \r | |
968 | @retval EFI_SUCCESS The iSCSI name is valid and normalized.\r | |
969 | @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.\r | |
970 | \r | |
971 | **/\r | |
972 | EFI_STATUS\r | |
973 | IScsiNormalizeName (\r | |
974 | IN OUT CHAR8 *Name,\r | |
975 | IN UINTN Len\r | |
976 | );\r | |
977 | \r | |
978 | /**\r | |
979 | Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.\r | |
980 | \r | |
981 | @param[in] PassThru The EXT SCSI PASS THRU protocol.\r | |
982 | @param[in] Target The target ID.\r | |
983 | @param[in] Lun The LUN.\r | |
984 | @param[in, out] Packet The request packet containing IO request, SCSI command\r | |
985 | buffer and buffers to read/write.\r | |
986 | \r | |
987 | @retval EFI_SUCCES The SCSI command is executed and the result is updated to \r | |
988 | the Packet.\r | |
989 | @retval EFI_DEVICE_ERROR Session state was not as required.\r | |
990 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r | |
cb162780 | 991 | @retval EFI_NOT_READY The target can not accept new commands.\r |
4c5a5e0c | 992 | @retval Others Other errors as indicated.\r |
993 | \r | |
994 | **/\r | |
995 | EFI_STATUS\r | |
996 | IScsiExecuteScsiCommand (\r | |
997 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,\r | |
998 | IN UINT8 *Target,\r | |
999 | IN UINT64 Lun,\r | |
1000 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r | |
1001 | );\r | |
1002 | \r | |
1003 | /**\r | |
1004 | Reinstate the session on some error.\r | |
1005 | \r | |
1006 | @param[in] Session The iSCSI session\r | |
1007 | \r | |
1008 | @retval EFI_SUCCES The session is reinstated from some error.\r | |
1009 | @retval Other Reinstatement failed.\r | |
1010 | \r | |
1011 | **/\r | |
1012 | EFI_STATUS\r | |
1013 | IScsiSessionReinstatement (\r | |
1014 | IN ISCSI_SESSION *Session\r | |
1015 | );\r | |
1016 | \r | |
1017 | /**\r | |
1018 | Initialize some session parameters before login.\r | |
1019 | \r | |
1020 | @param[in, out] Session The iSCSI session.\r | |
1021 | @param[in] Recovery Whether the request is from a fresh new start or recovery.\r | |
1022 | \r | |
1023 | **/\r | |
1024 | VOID\r | |
1025 | IScsiSessionInit (\r | |
1026 | IN OUT ISCSI_SESSION *Session,\r | |
1027 | IN BOOLEAN Recovery\r | |
1028 | );\r | |
1029 | \r | |
1030 | /**\r | |
1031 | Abort the iSCSI session, that is, reset all the connection and free the\r | |
1032 | resources.\r | |
1033 | \r | |
1034 | @param[in, out] Session The iSCSI session.\r | |
1035 | \r | |
1036 | **/\r | |
1037 | VOID\r | |
1038 | IScsiSessionAbort (\r | |
1039 | IN OUT ISCSI_SESSION *Session\r | |
1040 | );\r | |
1041 | \r | |
1042 | #endif\r |