]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.c
projects / mirror_edk2.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
For network dynamic media support:
[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiProto.c
CommitLineData
12618416 1/** @file\r
55a64ae0 2 The implementation of iSCSI protocol based on RFC3720.\r
6a690e23 3\r
dd29f3ed 4Copyright (c) 2004 - 2010, Intel Corporation.<BR>\r
7a444476 5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
6a690e23 12\r
12618416 13**/\r
6a690e23 14\r
15#include "IScsiImpl.h"\r
16\r
fe1e36e5 17UINT32 mDataSegPad = 0;\r
6a690e23 18\r
12618416 19/**\r
6a690e23 20 Attach the iSCSI connection to the iSCSI session. \r
21\r
c5de0d55 22 @param[in, out] Session The iSCSI session.\r
23 @param[in, out] Conn The iSCSI connection.\r
12618416 24**/\r
25VOID\r
26IScsiAttatchConnection (\r
c5de0d55 27 IN OUT ISCSI_SESSION *Session,\r
28 IN OUT ISCSI_CONNECTION *Conn\r
12618416 29 )\r
6a690e23 30{\r
e48e37fc 31 InsertTailList (&Session->Conns, &Conn->Link);\r
6a690e23 32 Conn->Session = Session;\r
33 Session->NumConns++;\r
34}\r
35\r
12618416 36/**\r
6a690e23 37 Detach the iSCSI connection from the session it belongs to. \r
38\r
c5de0d55 39 @param[in, out] Conn The iSCSI connection.\r
12618416 40**/\r
41VOID\r
42IScsiDetatchConnection (\r
c5de0d55 43 IN OUT ISCSI_CONNECTION *Conn\r
12618416 44 )\r
6a690e23 45{\r
e48e37fc 46 RemoveEntryList (&Conn->Link);\r
6a690e23 47 Conn->Session->NumConns--;\r
48 Conn->Session = NULL;\r
49}\r
50\r
12618416 51/**\r
6a690e23 52 Check the sequence number according to RFC3720. \r
53\r
c5de0d55 54 @param[in, out] ExpSN The currently expected sequence number.\r
55 @param[in] NewSN The sequence number to check.\r
6a690e23 56\r
db3e605d 57 @retval EFI_SUCCESS The check passed and the ExpSN is increased.\r
58 @retval EFI_NOT_READY Response was sent due to a retransmission request.\r
59 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
12618416 60**/\r
61EFI_STATUS\r
62IScsiCheckSN (\r
c5de0d55 63 IN OUT UINT32 *ExpSN,\r
64 IN UINT32 NewSN\r
12618416 65 )\r
6a690e23 66{\r
67 if (!ISCSI_SEQ_EQ (NewSN, *ExpSN)) {\r
68 if (ISCSI_SEQ_LT (NewSN, *ExpSN)) {\r
69 //\r
70 // Duplicate\r
71 //\r
72 return EFI_NOT_READY;\r
73 } else {\r
74 return EFI_PROTOCOL_ERROR;\r
75 }\r
76 } else {\r
77 //\r
78 // Advance the ExpSN\r
79 //\r
80 (*ExpSN)++;\r
81 return EFI_SUCCESS;\r
82 }\r
83}\r
84\r
12618416 85/**\r
6a690e23 86 Update the sequence numbers for the iSCSI command.\r
87\r
c5de0d55 88 @param[in, out] Session The iSCSI session.\r
89 @param[in] MaxCmdSN Maximum CmdSN from the target.\r
90 @param[in] ExpCmdSN Next expected CmdSN from the target.\r
12618416 91**/\r
92VOID\r
93IScsiUpdateCmdSN (\r
c5de0d55 94 IN OUT ISCSI_SESSION *Session,\r
95 IN UINT32 MaxCmdSN,\r
96 IN UINT32 ExpCmdSN\r
12618416 97 )\r
6a690e23 98{\r
99 if (ISCSI_SEQ_LT (MaxCmdSN, ExpCmdSN - 1)) {\r
100 return ;\r
101 }\r
102\r
103 if (ISCSI_SEQ_GT (MaxCmdSN, Session->MaxCmdSN)) {\r
104 Session->MaxCmdSN = MaxCmdSN;\r
105 }\r
106\r
107 if (ISCSI_SEQ_GT (ExpCmdSN, Session->ExpCmdSN)) {\r
108 Session->ExpCmdSN = ExpCmdSN;\r
109 }\r
110}\r
111\r
12618416 112/**\r
6a690e23 113 This function does the iSCSI connection login.\r
114\r
c5de0d55 115 @param[in, out] Conn The iSCSI connection to login.\r
6a690e23 116\r
12618416 117 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r
12618416 118 @retval EFI_TIMEOUT Timeout happened during the login procedure.\r
963dbb30 119 @retval Others Other errors as indicated. \r
12618416 120**/\r
121EFI_STATUS\r
122IScsiConnLogin (\r
c5de0d55 123 IN OUT ISCSI_CONNECTION *Conn\r
12618416 124 )\r
6a690e23 125{\r
126 EFI_STATUS Status;\r
127\r
128 //\r
129 // Start the timer, wait 16 seconds to establish the TCP connection.\r
130 //\r
131 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, 16 * TICKS_PER_SECOND);\r
132 if (EFI_ERROR (Status)) {\r
133 return Status;\r
134 }\r
135 //\r
136 // try to establish the tcp connection\r
137 //\r
138 Status = Tcp4IoConnect (&Conn->Tcp4Io, Conn->TimeoutEvent);\r
139 if (EFI_ERROR (Status)) {\r
140 return Status;\r
141 }\r
142\r
143 gBS->SetTimer (Conn->TimeoutEvent, TimerCancel, 0);\r
144 Conn->State = CONN_STATE_IN_LOGIN;\r
145\r
146 //\r
147 // connection is established, start the iSCSI Login\r
148 //\r
149 do {\r
150 Status = IScsiSendLoginReq (Conn);\r
151 if (EFI_ERROR (Status)) {\r
152 break;\r
153 }\r
154\r
155 Status = IScsiReceiveLoginRsp (Conn);\r
156 if (EFI_ERROR (Status)) {\r
157 break;\r
158 }\r
159 } while (Conn->CurrentStage != ISCSI_FULL_FEATURE_PHASE);\r
160\r
161 return Status;\r
162}\r
163\r
12618416 164/**\r
165 Reset the iSCSI connection.\r
166\r
c5de0d55 167 @param[in, out] Conn The iSCSI connection to reset.\r
12618416 168**/\r
6a690e23 169VOID\r
170IScsiConnReset (\r
c5de0d55 171 IN OUT ISCSI_CONNECTION *Conn\r
6a690e23 172 )\r
12618416 173{\r
174 Tcp4IoReset (&Conn->Tcp4Io);\r
175}\r
6a690e23 176\r
12618416 177/**\r
178 Create a TCP connection for the iSCSI session.\r
6a690e23 179\r
db3e605d 180 @param[in] Private The iSCSI driver data.\r
181 @param[in] Session Maximum CmdSN from the target.\r
6a690e23 182\r
db3e605d 183 @return The newly created iSCSI connection.\r
12618416 184**/\r
6a690e23 185ISCSI_CONNECTION *\r
186IScsiCreateConnection (\r
187 IN ISCSI_DRIVER_DATA *Private,\r
188 IN ISCSI_SESSION *Session\r
189 )\r
6a690e23 190{\r
191 ISCSI_CONNECTION *Conn;\r
192 TCP4_IO_CONFIG_DATA Tcp4IoConfig;\r
193 EFI_STATUS Status;\r
194\r
e48e37fc 195 Conn = AllocatePool (sizeof (ISCSI_CONNECTION));\r
6a690e23 196 if (Conn == NULL) {\r
197 return NULL;\r
198 }\r
199\r
200 Conn->Signature = ISCSI_CONNECTION_SIGNATURE;\r
201 Conn->State = CONN_STATE_FREE;\r
202 Conn->CurrentStage = ISCSI_SECURITY_NEGOTIATION;\r
203 Conn->NextStage = ISCSI_LOGIN_OPERATIONAL_NEGOTIATION;\r
204 Conn->CHAPStep = ISCSI_CHAP_INITIAL;\r
205 Conn->ExpStatSN = 0;\r
206 Conn->PartialReqSent = FALSE;\r
207 Conn->PartialRspRcvd = FALSE;\r
a78d176c 208 Conn->Cid = Session->NextCid++;\r
6a690e23 209\r
210 Status = gBS->CreateEvent (\r
e53a6ea9 211 EVT_TIMER,\r
e48e37fc 212 TPL_CALLBACK,\r
6a690e23 213 NULL,\r
214 NULL,\r
215 &Conn->TimeoutEvent\r
216 );\r
217 if (EFI_ERROR (Status)) {\r
766c7483 218 FreePool (Conn);\r
6a690e23 219 return NULL;\r
220 }\r
221\r
222 NetbufQueInit (&Conn->RspQue);\r
223\r
224 //\r
225 // set the default connection-only parameters\r
226 //\r
20621542 227 Conn->MaxRecvDataSegmentLength = DEFAULT_MAX_RECV_DATA_SEG_LEN;\r
f6b7393c 228 Conn->HeaderDigest = IScsiDigestNone;\r
229 Conn->DataDigest = IScsiDigestNone;\r
6a690e23 230\r
e48e37fc 231 CopyMem (&Tcp4IoConfig.LocalIp, &Session->ConfigData.NvData.LocalIp, sizeof (EFI_IPv4_ADDRESS));\r
232 CopyMem (&Tcp4IoConfig.SubnetMask, &Session->ConfigData.NvData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));\r
233 CopyMem (&Tcp4IoConfig.Gateway, &Session->ConfigData.NvData.Gateway, sizeof (EFI_IPv4_ADDRESS));\r
234 CopyMem (&Tcp4IoConfig.RemoteIp, &Session->ConfigData.NvData.TargetIp, sizeof (EFI_IPv4_ADDRESS));\r
6a690e23 235\r
236 Tcp4IoConfig.RemotePort = Session->ConfigData.NvData.TargetPort;\r
237\r
238 //\r
239 // Create the tcp4 IO for this connection\r
240 //\r
241 Status = Tcp4IoCreateSocket (\r
242 Private->Image,\r
243 Private->Controller,\r
244 &Tcp4IoConfig,\r
245 &Conn->Tcp4Io\r
246 );\r
247 if (EFI_ERROR (Status)) {\r
248 gBS->CloseEvent (Conn->TimeoutEvent);\r
766c7483 249 FreePool (Conn);\r
6a690e23 250 Conn = NULL;\r
251 }\r
252\r
253 return Conn;\r
254}\r
255\r
12618416 256/**\r
6a690e23 257 Destroy an iSCSI connection.\r
258\r
db3e605d 259 @param[in] Conn The connection to destroy.\r
12618416 260**/\r
261VOID\r
262IScsiDestroyConnection (\r
263 IN ISCSI_CONNECTION *Conn\r
264 )\r
6a690e23 265{\r
266 Tcp4IoDestroySocket (&Conn->Tcp4Io);\r
267 NetbufQueFlush (&Conn->RspQue);\r
268 gBS->CloseEvent (Conn->TimeoutEvent);\r
766c7483 269 FreePool (Conn);\r
6a690e23 270}\r
271\r
12618416 272/**\r
6a690e23 273 Login the iSCSI session.\r
274\r
db3e605d 275 @param[in] Private The iSCSI driver data.\r
6a690e23 276\r
12618416 277 @retval EFI_SUCCESS The iSCSI session login procedure finished.\r
12618416 278 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
dd29f3ed 279 @retval EFI_NO_MEDIA There was a media error.\r
963dbb30 280 @retval Others Other errors as indicated.\r
dd29f3ed 281\r
12618416 282**/\r
283EFI_STATUS\r
284IScsiSessionLogin (\r
285 IN ISCSI_DRIVER_DATA *Private\r
286 )\r
6a690e23 287{\r
288 EFI_STATUS Status;\r
289 ISCSI_SESSION *Session;\r
290 ISCSI_CONNECTION *Conn;\r
291 EFI_TCP4_PROTOCOL *Tcp4;\r
dd29f3ed 292 BOOLEAN MediaPresent;\r
6a690e23 293\r
294 Session = &Private->Session;\r
295\r
dd29f3ed 296 //\r
297 // Check media status before session login\r
298 //\r
299 MediaPresent = TRUE;\r
300 NetLibDetectMedia (Private->Controller, &MediaPresent);\r
301 if (!MediaPresent) {\r
302 return EFI_NO_MEDIA;\r
303 }\r
304\r
6a690e23 305 //\r
306 // Create a connection for the session.\r
307 //\r
308 Conn = IScsiCreateConnection (Private, Session);\r
309 if (Conn == NULL) {\r
310 return EFI_OUT_OF_RESOURCES;\r
311 }\r
312\r
313 IScsiAttatchConnection (Session, Conn);\r
314\r
315 //\r
316 // Login througth the newly created connection.\r
317 //\r
318 Status = IScsiConnLogin (Conn);\r
319 if (EFI_ERROR (Status)) {\r
320 IScsiConnReset (Conn);\r
321 IScsiDetatchConnection (Conn);\r
322 IScsiDestroyConnection (Conn);\r
323 } else {\r
324 Session->State = SESSION_STATE_LOGGED_IN;\r
325\r
326 gBS->OpenProtocol (\r
327 Conn->Tcp4Io.Handle,\r
328 &gEfiTcp4ProtocolGuid,\r
329 (VOID **)&Tcp4,\r
330 Private->Image,\r
331 Private->ExtScsiPassThruHandle,\r
332 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER\r
333 );\r
334 }\r
335\r
336 return Status;\r
337}\r
338\r
12618416 339/**\r
6a690e23 340 Build and send the iSCSI login request to the iSCSI target according to\r
341 the current login stage.\r
342\r
db3e605d 343 @param[in] Conn The connection in the iSCSI login phase.\r
6a690e23 344\r
12618416 345 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this\r
346 connection.\r
12618416 347 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
db3e605d 348 @retval EFI_DEVICE_ERROR Some kind of device error happened.\r
12618416 349**/\r
350EFI_STATUS\r
351IScsiSendLoginReq (\r
352 IN ISCSI_CONNECTION *Conn\r
353 )\r
6a690e23 354{\r
355 NET_BUF *Pdu;\r
356 EFI_STATUS Status;\r
357\r
358 //\r
359 // build the Login Request PDU\r
360 //\r
361 Pdu = IScsiPrepareLoginReq (Conn);\r
362 if (Pdu == NULL) {\r
363 return EFI_DEVICE_ERROR;\r
364 }\r
365 //\r
366 // Send it to the iSCSI target.\r
367 //\r
368 Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);\r
369\r
370 NetbufFree (Pdu);\r
371\r
372 return Status;\r
373}\r
374\r
12618416 375/**\r
6a690e23 376 Receive and process the iSCSI login response.\r
377\r
db3e605d 378 @param[in] Conn The connection in the iSCSI login phase.\r
379 \r
12618416 380 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.\r
963dbb30 381 @retval Others Other errors as indicated.\r
12618416 382**/\r
383EFI_STATUS\r
384IScsiReceiveLoginRsp (\r
385 IN ISCSI_CONNECTION *Conn\r
386 )\r
6a690e23 387{\r
388 EFI_STATUS Status;\r
389 NET_BUF *Pdu;\r
390\r
391 //\r
392 // Receive the iSCSI login response.\r
393 //\r
394 Status = IScsiReceivePdu (Conn, &Pdu, NULL, FALSE, FALSE, NULL);\r
395 if (EFI_ERROR (Status)) {\r
396 return Status;\r
397 }\r
398 //\r
399 // A Login Response is received, process it.\r
400 //\r
401 Status = IScsiProcessLoginRsp (Conn, Pdu);\r
402\r
403 NetbufFree (Pdu);\r
404\r
405 return Status;\r
406}\r
407\r
12618416 408/**\r
6a690e23 409 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.\r
410 The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r
411 updated.\r
412\r
c5de0d55 413 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will\r
12618416 414 be added to.\r
c5de0d55 415 @param[in] Key The key name string.\r
416 @param[in] Value The value string.\r
6a690e23 417\r
12618416 418 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and\r
419 the correspondence length fields are updated.\r
12618416 420 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value\r
421 pair.\r
12618416 422**/\r
423EFI_STATUS\r
424IScsiAddKeyValuePair (\r
c5de0d55 425 IN OUT NET_BUF *Pdu,\r
12618416 426 IN CHAR8 *Key,\r
427 IN CHAR8 *Value\r
428 )\r
6a690e23 429{\r
430 UINT32 DataSegLen;\r
431 UINT32 KeyLen;\r
432 UINT32 ValueLen;\r
433 UINT32 TotalLen;\r
434 ISCSI_LOGIN_REQUEST *LoginReq;\r
435 CHAR8 *Data;\r
436\r
437 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufGetByte (Pdu, 0, NULL);\r
438 DataSegLen = NTOH24 (LoginReq->DataSegmentLength);\r
439\r
440 KeyLen = (UINT32) AsciiStrLen (Key);\r
441 ValueLen = (UINT32) AsciiStrLen (Value);\r
442\r
443 //\r
444 // 1 byte for the key value separator '=' and 1 byte for the null\r
445 // delimiter after the value.\r
446 //\r
447 TotalLen = KeyLen + 1 + ValueLen + 1;\r
448\r
449 //\r
450 // Allocate the space for the key-value pair.\r
451 //\r
69b0882d 452 Data = (CHAR8 *)NetbufAllocSpace (Pdu, TotalLen, NET_BUF_TAIL);\r
6a690e23 453 if (Data == NULL) {\r
454 return EFI_OUT_OF_RESOURCES;\r
455 }\r
456 //\r
457 // Add the key.\r
458 //\r
e48e37fc 459 CopyMem (Data, Key, KeyLen);\r
6a690e23 460 Data += KeyLen;\r
461\r
462 *Data = '=';\r
463 Data++;\r
464\r
465 //\r
466 // Add the value.\r
467 //\r
e48e37fc 468 CopyMem (Data, Value, ValueLen);\r
6a690e23 469 Data += ValueLen;\r
470\r
471 *Data = '\0';\r
472\r
473 //\r
474 // update the DataSegmentLength\r
475 //\r
476 ISCSI_SET_DATASEG_LEN (LoginReq, DataSegLen + TotalLen);\r
477\r
478 return EFI_SUCCESS;\r
479}\r
480\r
12618416 481/**\r
6a690e23 482 Prepare the iSCSI login request to be sent according to the current login status.\r
483\r
c5de0d55 484 @param[in, out] Conn The connection in the iSCSI login phase.\r
6a690e23 485\r
db3e605d 486 @return The pointer to the net buffer containing the iSCSI login request built.\r
963dbb30 487 @retval Others Other errors as indicated.\r
12618416 488**/\r
489NET_BUF *\r
490IScsiPrepareLoginReq (\r
c5de0d55 491 IN OUT ISCSI_CONNECTION *Conn\r
12618416 492 )\r
6a690e23 493{\r
494 ISCSI_SESSION *Session;\r
495 NET_BUF *Nbuf;\r
496 ISCSI_LOGIN_REQUEST *LoginReq;\r
497 EFI_STATUS Status;\r
498\r
499 Session = Conn->Session;\r
500\r
501 Nbuf = NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST) + DEFAULT_MAX_RECV_DATA_SEG_LEN);\r
502 if (Nbuf == NULL) {\r
503 return NULL;\r
504 }\r
505\r
506 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufAllocSpace (Nbuf, sizeof (ISCSI_LOGIN_REQUEST), NET_BUF_TAIL);\r
653ef62e 507 ASSERT (LoginReq != NULL);\r
e48e37fc 508 ZeroMem (LoginReq, sizeof (ISCSI_LOGIN_REQUEST));\r
6a690e23 509\r
510 //\r
511 // Init the login request pdu\r
512 //\r
513 ISCSI_SET_OPCODE (LoginReq, ISCSI_OPCODE_LOGIN_REQ, ISCSI_REQ_IMMEDIATE);\r
514 ISCSI_SET_STAGES (LoginReq, Conn->CurrentStage, Conn->NextStage);\r
515 LoginReq->VersionMax = ISCSI_VERSION_MAX;\r
516 LoginReq->VersionMin = ISCSI_VERSION_MIN;\r
a78d176c 517 LoginReq->Tsih = HTONS (Session->Tsih);\r
6a690e23 518 LoginReq->InitiatorTaskTag = HTONL (Session->InitiatorTaskTag);\r
a78d176c 519 LoginReq->Cid = HTONS (Conn->Cid);\r
6a690e23 520 LoginReq->CmdSN = HTONL (Session->CmdSN);\r
521\r
522 //\r
523 // For the first Login Request on a coonection this is ExpStatSN for the\r
524 // old connection and this field is only valid if the Login Request restarts\r
525 // a connection.\r
526 // For subsequent Login Requests it is used to acknowledge the Login Responses\r
527 // with their increasing StatSN values.\r
528 //\r
529 LoginReq->ExpStatSN = HTONL (Conn->ExpStatSN);\r
a78d176c 530 CopyMem (LoginReq->Isid, Session->Isid, sizeof (LoginReq->Isid));\r
6a690e23 531\r
532 if (Conn->PartialRspRcvd) {\r
533 //\r
534 // A partial response, initiator must send an empty Login Request.\r
535 //\r
536 return Nbuf;\r
537 }\r
538\r
539 switch (Conn->CurrentStage) {\r
540 case ISCSI_SECURITY_NEGOTIATION:\r
541 Status = IScsiCHAPToSendReq (Conn, Nbuf);\r
542 break;\r
543\r
544 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:\r
545 Status = IScsiFillOpParams (Conn, Nbuf);\r
546 ISCSI_SET_FLAG (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);\r
547 break;\r
548\r
549 default:\r
550 //\r
551 // something error happens...\r
552 //\r
553 Status = EFI_DEVICE_ERROR;\r
554 break;\r
555 }\r
556\r
557 if (EFI_ERROR (Status)) {\r
558 NetbufFree (Nbuf);\r
559 Nbuf = NULL;\r
560 } else {\r
561 //\r
562 // Pad the data segment if needed.\r
563 //\r
564 IScsiPadSegment (Nbuf, ISCSI_GET_DATASEG_LEN (LoginReq));\r
565 //\r
566 // Check whether we will issue the stage transition signal?\r
567 //\r
69b0882d 568 Conn->TransitInitiated = (BOOLEAN) ISCSI_FLAG_ON (LoginReq, ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT);\r
6a690e23 569 }\r
570\r
571 return Nbuf;\r
572}\r
573\r
12618416 574/**\r
6a690e23 575 Process the iSCSI Login Response.\r
576\r
c5de0d55 577 @param[in, out] Conn The connection on which the iSCSI login response is received.\r
578 @param[in, out] Pdu The iSCSI login response PDU.\r
6a690e23 579\r
12618416 580 @retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.\r
12618416 581 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
db3e605d 582 @retval EFI_MEDIA_CHANGED Target is redirected.\r
963dbb30 583 @retval Others Other errors as indicated.\r
12618416 584**/\r
585EFI_STATUS\r
586IScsiProcessLoginRsp (\r
c5de0d55 587 IN OUT ISCSI_CONNECTION *Conn,\r
588 IN OUT NET_BUF *Pdu\r
12618416 589 )\r
6a690e23 590{\r
591 EFI_STATUS Status;\r
592 ISCSI_SESSION *Session;\r
593 ISCSI_LOGIN_RESPONSE *LoginRsp;\r
594 BOOLEAN Transit;\r
595 BOOLEAN Continue;\r
596 UINT8 CurrentStage;\r
597 UINT8 NextStage;\r
598 UINT8 *DataSeg;\r
599 UINT32 DataSegLen;\r
600\r
601 Session = Conn->Session;\r
602\r
603 LoginRsp = (ISCSI_LOGIN_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);\r
604 if (!ISCSI_CHECK_OPCODE (LoginRsp, ISCSI_OPCODE_LOGIN_RSP)) {\r
605 //\r
606 // It's not a Login Response\r
607 //\r
608 return EFI_PROTOCOL_ERROR;\r
609 }\r
610 //\r
611 // Get the data segment if any.\r
612 //\r
613 DataSegLen = ISCSI_GET_DATASEG_LEN (LoginRsp);\r
614 if (DataSegLen != 0) {\r
615 DataSeg = NetbufGetByte (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NULL);\r
616 } else {\r
617 DataSeg = NULL;\r
618 }\r
619 //\r
620 // Check the status class in the login response PDU.\r
621 //\r
622 switch (LoginRsp->StatusClass) {\r
623 case ISCSI_LOGIN_STATUS_SUCCESS:\r
624 //\r
625 // Just break here, the response and the data segment will be processed later.\r
626 //\r
627 break;\r
628\r
629 case ISCSI_LOGIN_STATUS_REDIRECTION:\r
630 //\r
631 // The target may be moved to a different address\r
632 //\r
633 if (DataSeg == NULL) {\r
634 return EFI_PROTOCOL_ERROR;\r
635 }\r
636 //\r
637 // Process the TargetAddress key-value strings in the data segment to update the\r
638 // target address info.\r
639 //\r
69b0882d 640 Status = IScsiUpdateTargetAddress (Session, (CHAR8 *)DataSeg, DataSegLen);\r
6a690e23 641 if (EFI_ERROR (Status)) {\r
642 return Status;\r
643 }\r
644 //\r
645 // Session will be restarted on this error status because the Target is\r
646 // redirected by this Login Response.\r
647 //\r
648 return EFI_MEDIA_CHANGED;\r
649\r
650 default:\r
651 //\r
652 // Initiator Error, Target Error, or any other undefined error code.\r
653 //\r
654 return EFI_PROTOCOL_ERROR;\r
655 }\r
656 //\r
657 // The status is sucess, extract the wanted fields from the header segment.\r
658 //\r
69b0882d 659 Transit = (BOOLEAN) ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT);\r
660 Continue = (BOOLEAN) ISCSI_FLAG_ON (LoginRsp, ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE);\r
6a690e23 661\r
69b0882d 662 CurrentStage = (UINT8) ISCSI_GET_CURRENT_STAGE (LoginRsp);\r
663 NextStage = (UINT8) ISCSI_GET_NEXT_STAGE (LoginRsp);\r
6a690e23 664\r
665 LoginRsp->InitiatorTaskTag = NTOHL (LoginRsp->InitiatorTaskTag);\r
666\r
667 if ((Transit && Continue) ||\r
668 (CurrentStage != Conn->CurrentStage) ||\r
669 (!Conn->TransitInitiated && Transit) ||\r
670 (Transit && (NextStage != Conn->NextStage)) ||\r
a78d176c 671 (CompareMem (Session->Isid, LoginRsp->Isid, sizeof (LoginRsp->Isid)) != 0) ||\r
6a690e23 672 (LoginRsp->InitiatorTaskTag != Session->InitiatorTaskTag)\r
673 ) {\r
674 //\r
675 // A Login Response with the C bit set to 1 MUST have the T bit set to 0;\r
676 // The CSG in the Login Response MUST be the same with the I-end of this connection;\r
677 // The T bit can't be 1 if the last Login Response sent by the initiator doesn't\r
678 // initiate the transistion;\r
679 // The NSG MUST be the same with the I-end of this connection if Transit is required.\r
680 // The ISID in the Login Response MUST be the same with this session.\r
681 //\r
682 return EFI_PROTOCOL_ERROR;\r
683 }\r
684\r
685 LoginRsp->StatSN = NTOHL (LoginRsp->StatSN);\r
686 LoginRsp->ExpCmdSN = NTOHL (LoginRsp->ExpCmdSN);\r
687 LoginRsp->MaxCmdSN = NTOHL (LoginRsp->MaxCmdSN);\r
688\r
689 if ((Conn->CurrentStage == ISCSI_SECURITY_NEGOTIATION) && (Conn->CHAPStep == ISCSI_CHAP_INITIAL)) {\r
690 //\r
691 // It's the initial Login Response, initialize the local ExpStatSN, MaxCmdSN\r
692 // and ExpCmdSN.\r
693 //\r
694 Conn->ExpStatSN = LoginRsp->StatSN + 1;\r
695 Session->MaxCmdSN = LoginRsp->MaxCmdSN;\r
696 Session->ExpCmdSN = LoginRsp->ExpCmdSN;\r
697 } else {\r
698 //\r
699 // Check the StatSN of this PDU\r
700 //\r
701 Status = IScsiCheckSN (&Conn->ExpStatSN, LoginRsp->StatSN);\r
702 if (!EFI_ERROR (Status)) {\r
703 //\r
704 // Update the MaxCmdSN and ExpCmdSN\r
705 //\r
706 IScsiUpdateCmdSN (Session, LoginRsp->MaxCmdSN, LoginRsp->ExpCmdSN);\r
707 } else {\r
708 return Status;\r
709 }\r
710 }\r
711 //\r
712 // Trim off the header segment.\r
713 //\r
714 NetbufTrim (Pdu, sizeof (ISCSI_LOGIN_RESPONSE), NET_BUF_HEAD);\r
715\r
716 //\r
717 // Queue this login response first in case it's a partial response so that\r
718 // later when the full response list is received we can combine these scattered\r
719 // responses' data segment and then process it.\r
720 //\r
721 NET_GET_REF (Pdu);\r
722 NetbufQueAppend (&Conn->RspQue, Pdu);\r
723\r
724 Conn->PartialRspRcvd = Continue;\r
725 if (Continue) {\r
726 //\r
727 // It's a partial response, have to wait for another or more Request/Response\r
728 // conversations to get the full response.\r
729 //\r
730 return EFI_SUCCESS;\r
731 }\r
732\r
733 switch (CurrentStage) {\r
734 case ISCSI_SECURITY_NEGOTIATION:\r
735 //\r
736 // In security negotiation stage, let CHAP module handle it.\r
737 //\r
c5de0d55 738 Status = IScsiCHAPOnRspReceived (Conn);\r
6a690e23 739 break;\r
740\r
741 case ISCSI_LOGIN_OPERATIONAL_NEGOTIATION:\r
742 //\r
743 // Response received with negotiation resonse on iSCSI parameters, check them.\r
744 //\r
c5de0d55 745 Status = IScsiCheckOpParams (Conn);\r
6a690e23 746 break;\r
747\r
748 default:\r
749 //\r
750 // Should never get here.\r
751 //\r
752 Status = EFI_PROTOCOL_ERROR;\r
753 break;\r
754 }\r
755\r
756 if (Transit && (Status == EFI_SUCCESS)) {\r
757 //\r
758 // Do the state transition.\r
759 //\r
760 Conn->CurrentStage = Conn->NextStage;\r
761\r
762 if (Conn->CurrentStage == ISCSI_LOGIN_OPERATIONAL_NEGOTIATION) {\r
763 Conn->NextStage = ISCSI_FULL_FEATURE_PHASE;\r
764 } else {\r
765 //\r
766 // CurrentStage is iSCSI Full Feature, it's the Login-Final Response,\r
767 // get the TSIH from the Login Response.\r
768 //\r
a78d176c 769 Session->Tsih = NTOHS (LoginRsp->Tsih);\r
6a690e23 770 }\r
771 }\r
772 //\r
773 // Flush the response(s) received.\r
774 //\r
775 NetbufQueFlush (&Conn->RspQue);\r
776\r
777 return Status;\r
778}\r
779\r
12618416 780/**\r
6a690e23 781 Updated the target information according the data received in the iSCSI\r
782 login response with an target redirection status.\r
783\r
c5de0d55 784 @param[in, out] Session The iSCSI session.\r
785 @param[in] Data The data segment which should contain the\r
786 TargetAddress key-value list.\r
787 @param[in] Len Length of the data.\r
db3e605d 788 \r
12618416 789 @retval EFI_SUCCESS The target address is updated.\r
12618416 790 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
12618416 791 @retval EFI_NOT_FOUND The TargetAddress key is not found.\r
963dbb30 792 @retval Others Other errors as indicated.\r
12618416 793**/\r
794EFI_STATUS\r
795IScsiUpdateTargetAddress (\r
c5de0d55 796 IN OUT ISCSI_SESSION *Session,\r
797 IN CHAR8 *Data,\r
798 IN UINT32 Len\r
12618416 799 )\r
6a690e23 800{\r
e48e37fc 801 LIST_ENTRY *KeyValueList;\r
6a690e23 802 CHAR8 *TargetAddress;\r
803 CHAR8 *IpStr;\r
804 EFI_STATUS Status;\r
805 UINTN Number;\r
806\r
807 KeyValueList = IScsiBuildKeyValueList (Data, Len);\r
808 if (KeyValueList == NULL) {\r
809 return EFI_OUT_OF_RESOURCES;\r
810 }\r
811\r
812 Status = EFI_NOT_FOUND;\r
813\r
814 while (TRUE) {\r
815 TargetAddress = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ADDRESS);\r
816 if (TargetAddress == NULL) {\r
817 break;\r
818 }\r
819\r
820 if (!NET_IS_DIGIT (TargetAddress[0])) {\r
821 //\r
822 // The domainname of the target may be presented in three formats: a DNS host name,\r
823 // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted\r
824 // IPv4 address.\r
825 //\r
826 continue;\r
827 }\r
828\r
829 IpStr = TargetAddress;\r
830\r
db3e605d 831 while ((*TargetAddress != 0) && (*TargetAddress != ':') && (*TargetAddress != ',')) {\r
6a690e23 832 //\r
833 // NULL, ':' or ',' ends the IPv4 string.\r
834 //\r
835 TargetAddress++;\r
836 }\r
837\r
838 if (*TargetAddress == ',') {\r
839 //\r
840 // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent\r
841 // as the result of a redirection.\r
842 //\r
843 continue;\r
844 } else if (*TargetAddress == ':') {\r
845 *TargetAddress = '\0';\r
846\r
847 TargetAddress++;\r
848\r
849 Number = AsciiStrDecimalToUintn (TargetAddress);\r
850 if (Number > 0xFFFF) {\r
851 continue;\r
852 } else {\r
853 Session->ConfigData.NvData.TargetPort = (UINT16) Number;\r
854 }\r
855 } else {\r
856 //\r
857 // The string only contains the IPv4 address. Use the well known port.\r
858 //\r
859 Session->ConfigData.NvData.TargetPort = ISCSI_WELL_KNOWN_PORT;\r
860 }\r
861 //\r
862 // Update the target IP address.\r
863 //\r
864 Status = IScsiAsciiStrToIp (IpStr, &Session->ConfigData.NvData.TargetIp);\r
865 if (EFI_ERROR (Status)) {\r
866 continue;\r
867 } else {\r
868 break;\r
869 }\r
870 }\r
871\r
872 IScsiFreeKeyValueList (KeyValueList);\r
873\r
874 return Status;\r
875}\r
876\r
12618416 877/**\r
6a690e23 878 The callback function to free the net buffer list.\r
879\r
db3e605d 880 @param[in] Arg The opaque parameter.\r
12618416 881**/\r
882VOID\r
883IScsiFreeNbufList (\r
884 VOID *Arg\r
885 )\r
6a690e23 886{\r
887 ASSERT (Arg != NULL);\r
888\r
e48e37fc 889 NetbufFreeList ((LIST_ENTRY *) Arg);\r
766c7483 890 FreePool (Arg);\r
6a690e23 891}\r
892\r
12618416 893/**\r
894 The callback function called in NetBufFree, it does nothing.\r
895\r
db3e605d 896 @param[in] Arg The opaque parameter.\r
12618416 897**/\r
6a690e23 898VOID\r
899IScsiNbufExtFree (\r
900 VOID *Arg\r
901 )\r
12618416 902{\r
903}\r
6a690e23 904\r
12618416 905/**\r
906 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and\r
907 an optional data segment. The two parts will be put into two blocks of buffers in the\r
908 net buffer. The digest check will be conducted in this function if needed and the digests\r
909 will be trimmed from the PDU buffer.\r
6a690e23 910\r
db3e605d 911 @param[in] Conn The iSCSI connection to receive data from.\r
912 @param[out] Pdu The received iSCSI pdu.\r
913 @param[in] Context The context used to describe information on the caller provided\r
12618416 914 buffer to receive data segment of the iSCSI pdu, it's optional.\r
db3e605d 915 @param[in] HeaderDigest Whether there will be header digest received.\r
916 @param[in] DataDigest Whether there will be data digest.\r
917 @param[in] TimeoutEvent The timeout event, it's optional.\r
6a690e23 918\r
db3e605d 919 @retval EFI_SUCCESS An iSCSI pdu is received.\r
920 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
921 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
963dbb30 922 @retval Others Other errors as indicated.\r
12618416 923**/\r
6a690e23 924EFI_STATUS\r
925IScsiReceivePdu (\r
926 IN ISCSI_CONNECTION *Conn,\r
927 OUT NET_BUF **Pdu,\r
928 IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL\r
929 IN BOOLEAN HeaderDigest,\r
930 IN BOOLEAN DataDigest,\r
931 IN EFI_EVENT TimeoutEvent OPTIONAL\r
932 )\r
6a690e23 933{\r
e48e37fc 934 LIST_ENTRY *NbufList;\r
6a690e23 935 UINT32 Len;\r
936 NET_BUF *PduHdr;\r
937 UINT8 *Header;\r
938 EFI_STATUS Status;\r
939 UINT32 PadLen;\r
940 UINT32 InDataOffset;\r
941 NET_FRAGMENT Fragment[2];\r
942 UINT32 FragmentCount;\r
943 NET_BUF *DataSeg;\r
944 UINT32 PadAndCRC32[2];\r
945\r
653ef62e 946 NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
6a690e23 947 if (NbufList == NULL) {\r
948 return EFI_OUT_OF_RESOURCES;\r
949 }\r
950\r
e48e37fc 951 InitializeListHead (NbufList);\r
6a690e23 952\r
953 //\r
954 // The header digest will be received together with the PDU header if exists.\r
955 //\r
956 Len = sizeof (ISCSI_BASIC_HEADER) + (HeaderDigest ? sizeof (UINT32) : 0);\r
957 PduHdr = NetbufAlloc (Len);\r
958 if (PduHdr == NULL) {\r
766c7483 959 FreePool (NbufList);\r
653ef62e 960 return EFI_OUT_OF_RESOURCES;\r
6a690e23 961 }\r
962\r
963 Header = NetbufAllocSpace (PduHdr, Len, NET_BUF_TAIL);\r
653ef62e 964 ASSERT (Header != NULL);\r
e48e37fc 965 InsertTailList (NbufList, &PduHdr->List);\r
6a690e23 966\r
967 //\r
968 // First step, receive the BHS of the PDU.\r
969 //\r
970 Status = Tcp4IoReceive (&Conn->Tcp4Io, PduHdr, FALSE, TimeoutEvent);\r
971 if (EFI_ERROR (Status)) {\r
972 goto ON_EXIT;\r
973 }\r
974\r
975 if (HeaderDigest) {\r
976 //\r
977 // TODO: check the header-digest.\r
978 //\r
979 //\r
980 // Trim off the digest.\r
981 //\r
982 NetbufTrim (PduHdr, sizeof (UINT32), NET_BUF_TAIL);\r
983 }\r
984\r
985 Len = ISCSI_GET_DATASEG_LEN (Header);\r
986 if (Len == 0) {\r
987 //\r
5af5b3fd 988 // No data segment.Form the pdu from a list of pdu segments.\r
6a690e23 989 //\r
5af5b3fd 990 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
991 if (*Pdu == NULL) {\r
992 Status = EFI_OUT_OF_RESOURCES;\r
993 goto ON_EXIT;\r
994 }\r
995 return Status;\r
6a690e23 996 }\r
997 //\r
998 // Get the length of the padding bytes of the data segment.\r
999 //\r
1000 PadLen = ISCSI_GET_PAD_LEN (Len);\r
1001\r
1002 switch (ISCSI_GET_OPCODE (Header)) {\r
1003 case ISCSI_OPCODE_SCSI_DATA_IN:\r
1004 //\r
1005 // Try to use the buffer described by Context if the PDU is an\r
1006 // iSCSI SCSI data in pdu so as to reduce memory copy overhead.\r
1007 //\r
1008 InDataOffset = ISCSI_GET_BUFFER_OFFSET (Header);\r
1009 if ((Context == NULL) || ((InDataOffset + Len) > Context->InDataLen)) {\r
1010 Status = EFI_PROTOCOL_ERROR;\r
1011 goto ON_EXIT;\r
1012 }\r
1013\r
1014 Fragment[0].Len = Len;\r
1015 Fragment[0].Bulk = Context->InData + InDataOffset;\r
1016\r
1017 if (DataDigest || (PadLen != 0)) {\r
1018 //\r
1019 // The data segment is padded, use two fragments to receive it.\r
1020 // The first to receive the useful data. The second to receive the padding.\r
1021 //\r
1022 Fragment[1].Len = PadLen + (DataDigest ? sizeof (UINT32) : 0);\r
82603e79 1023 Fragment[1].Bulk = (UINT8 *)PadAndCRC32 + (4 - PadLen);\r
6a690e23 1024 FragmentCount = 2;\r
1025 } else {\r
1026 FragmentCount = 1;\r
1027 }\r
1028\r
1029 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);\r
1030 if (DataSeg == NULL) {\r
1031 Status = EFI_OUT_OF_RESOURCES;\r
1032 goto ON_EXIT;\r
1033 }\r
1034\r
1035 break;\r
1036\r
1037 case ISCSI_OPCODE_SCSI_RSP:\r
1038 case ISCSI_OPCODE_NOP_IN:\r
1039 case ISCSI_OPCODE_LOGIN_RSP:\r
1040 case ISCSI_OPCODE_TEXT_RSP:\r
1041 case ISCSI_OPCODE_ASYNC_MSG:\r
1042 case ISCSI_OPCODE_REJECT:\r
1043 case ISCSI_OPCODE_VENDOR_T0:\r
1044 case ISCSI_OPCODE_VENDOR_T1:\r
1045 case ISCSI_OPCODE_VENDOR_T2:\r
1046 //\r
1047 // Allocate buffer to receive the data segment.\r
1048 //\r
1049 Len += PadLen + (DataDigest ? sizeof (UINT32) : 0);\r
1050 DataSeg = NetbufAlloc (Len);\r
1051 if (DataSeg == NULL) {\r
1052 Status = EFI_OUT_OF_RESOURCES;\r
1053 goto ON_EXIT;\r
1054 }\r
1055\r
1056 NetbufAllocSpace (DataSeg, Len, NET_BUF_TAIL);\r
1057 break;\r
1058\r
1059 default:\r
1060 Status = EFI_PROTOCOL_ERROR;\r
1061 goto ON_EXIT;\r
1062 }\r
1063\r
e48e37fc 1064 InsertTailList (NbufList, &DataSeg->List);\r
6a690e23 1065\r
1066 //\r
1067 // Receive the data segment with the data digest if any.\r
1068 //\r
1069 Status = Tcp4IoReceive (&Conn->Tcp4Io, DataSeg, FALSE, TimeoutEvent);\r
1070 if (EFI_ERROR (Status)) {\r
1071 goto ON_EXIT;\r
1072 }\r
1073\r
1074 if (DataDigest) {\r
1075 //\r
1076 // TODO: Check the data digest.\r
1077 //\r
1078 NetbufTrim (DataSeg, sizeof (UINT32), NET_BUF_TAIL);\r
1079 }\r
1080\r
1081 if (PadLen != 0) {\r
1082 //\r
1083 // Trim off the padding bytes in the data segment.\r
1084 //\r
1085 NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);\r
1086 }\r
1087\r
6a690e23 1088 //\r
1089 // Form the pdu from a list of pdu segments.\r
1090 //\r
1091 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
1092 if (*Pdu == NULL) {\r
1093 Status = EFI_OUT_OF_RESOURCES;\r
1094 }\r
1095\r
1096ON_EXIT:\r
1097\r
1098 if (EFI_ERROR (Status)) {\r
1099 //\r
1100 // Free the Nbufs in this NbufList and the NbufList itself.\r
1101 //\r
1102 IScsiFreeNbufList (NbufList);\r
1103 }\r
1104\r
1105 return Status;\r
1106}\r
1107\r
12618416 1108/**\r
6a690e23 1109 Check and get the result of the prameter negotiation.\r
1110\r
c5de0d55 1111 @param[in, out] Conn The connection in iSCSI login.\r
6a690e23 1112\r
db3e605d 1113 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.\r
1114 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
1115 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
12618416 1116**/\r
1117EFI_STATUS\r
1118IScsiCheckOpParams (\r
c5de0d55 1119 IN OUT ISCSI_CONNECTION *Conn\r
12618416 1120 )\r
6a690e23 1121{\r
1122 EFI_STATUS Status;\r
e48e37fc 1123 LIST_ENTRY *KeyValueList;\r
6a690e23 1124 CHAR8 *Data;\r
1125 UINT32 Len;\r
1126 ISCSI_SESSION *Session;\r
1127 CHAR8 *Value;\r
1128 UINTN NumericValue;\r
1129\r
1130 ASSERT (Conn->RspQue.BufNum != 0);\r
1131\r
1132 Session = Conn->Session;\r
1133\r
1134 Len = Conn->RspQue.BufSize;\r
e48e37fc 1135 Data = AllocatePool (Len);\r
6a690e23 1136 if (Data == NULL) {\r
1137 return EFI_OUT_OF_RESOURCES;\r
1138 }\r
1139\r
69b0882d 1140 NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);\r
6a690e23 1141\r
1142 Status = EFI_PROTOCOL_ERROR;\r
1143\r
1144 //\r
1145 // Extract the Key-Value pairs into a list.\r
1146 //\r
1147 KeyValueList = IScsiBuildKeyValueList (Data, Len);\r
1148 if (KeyValueList == NULL) {\r
766c7483 1149 FreePool (Data);\r
6a690e23 1150 return Status;\r
1151 }\r
1152 //\r
1153 // HeaderDigest\r
1154 //\r
1155 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);\r
1156 if (Value == NULL) {\r
1157 goto ON_ERROR;\r
1158 }\r
1159\r
1160 if (AsciiStrCmp (Value, "CRC32") == 0) {\r
f6b7393c 1161 if (Conn->HeaderDigest != IScsiDigestCRC32) {\r
6a690e23 1162 goto ON_ERROR;\r
1163 }\r
1164 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
f6b7393c 1165 Conn->HeaderDigest = IScsiDigestNone;\r
6a690e23 1166 } else {\r
1167 goto ON_ERROR;\r
1168 }\r
1169 //\r
1170 // DataDigest\r
1171 //\r
1172 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);\r
1173 if (Value == NULL) {\r
1174 goto ON_ERROR;\r
1175 }\r
1176\r
1177 if (AsciiStrCmp (Value, "CRC32") == 0) {\r
f6b7393c 1178 if (Conn->DataDigest != IScsiDigestCRC32) {\r
6a690e23 1179 goto ON_ERROR;\r
1180 }\r
1181 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {\r
f6b7393c 1182 Conn->DataDigest = IScsiDigestNone;\r
6a690e23 1183 } else {\r
1184 goto ON_ERROR;\r
1185 }\r
1186 //\r
1187 // ErrorRecoveryLevel, result fuction is Minimum.\r
1188 //\r
1189 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);\r
1190 if (Value == NULL) {\r
1191 goto ON_ERROR;\r
1192 }\r
1193\r
1194 NumericValue = AsciiStrDecimalToUintn (Value);\r
1195 if (NumericValue > 2) {\r
1196 goto ON_ERROR;\r
1197 }\r
1198\r
1199 Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);\r
1200\r
1201 //\r
1202 // InitialR2T, result function is OR.\r
1203 //\r
1204 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);\r
1205 if (Value == NULL) {\r
1206 goto ON_ERROR;\r
1207 }\r
1208\r
69b0882d 1209 Session->InitialR2T = (BOOLEAN) (Session->InitialR2T || (AsciiStrCmp (Value, "Yes") == 0));\r
6a690e23 1210\r
1211 //\r
1212 // ImmediateData, result function is AND.\r
1213 //\r
1214 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);\r
1215 if (Value == NULL) {\r
1216 goto ON_ERROR;\r
1217 }\r
1218\r
69b0882d 1219 Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (AsciiStrCmp (Value, "Yes") == 0));\r
6a690e23 1220\r
1221 //\r
28d19b00 1222 // MaxRecvDataSegmentLength is declarative.\r
6a690e23 1223 //\r
1224 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);\r
1225 if (Value != NULL) {\r
28d19b00 1226 Conn->MaxRecvDataSegmentLength = (UINT32) AsciiStrDecimalToUintn (Value);\r
6a690e23 1227 }\r
1228 //\r
1229 // MaxBurstLength, result funtion is Mininum.\r
1230 //\r
1231 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);\r
1232 if (Value == NULL) {\r
1233 goto ON_ERROR;\r
1234 }\r
1235\r
1236 NumericValue = AsciiStrDecimalToUintn (Value);\r
1237 Session->MaxBurstLength = (UINT32) MIN (Session->MaxBurstLength, NumericValue);\r
1238\r
1239 //\r
1240 // FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and\r
1241 // ImmediateData=No.\r
653ef62e 1242 // This Key/Value is negotiation type.\r
6a690e23 1243 //\r
1244 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);\r
653ef62e 1245 if (Value == NULL) {\r
6a690e23 1246 goto ON_ERROR;\r
1247 }\r
1248\r
1249 NumericValue = AsciiStrDecimalToUintn (Value);\r
1250 Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);\r
1251\r
1252 //\r
1253 // MaxConnections, result function is Minimum.\r
1254 //\r
1255 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);\r
1256 if (Value == NULL) {\r
1257 goto ON_ERROR;\r
1258 }\r
1259\r
1260 NumericValue = AsciiStrDecimalToUintn (Value);\r
1261 if ((NumericValue == 0) || (NumericValue > 65535)) {\r
1262 goto ON_ERROR;\r
1263 }\r
1264\r
1265 Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);\r
1266\r
1267 //\r
1268 // DataPDUInOrder, result function is OR.\r
1269 //\r
1270 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);\r
1271 if (Value == NULL) {\r
1272 goto ON_ERROR;\r
1273 }\r
1274\r
69b0882d 1275 Session->DataPDUInOrder = (BOOLEAN) (Session->DataPDUInOrder || (AsciiStrCmp (Value, "Yes") == 0));\r
6a690e23 1276\r
1277 //\r
1278 // DataSequenceInorder, result function is OR.\r
1279 //\r
1280 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);\r
1281 if (Value == NULL) {\r
1282 goto ON_ERROR;\r
1283 }\r
1284\r
69b0882d 1285 Session->DataSequenceInOrder = (BOOLEAN) (Session->DataSequenceInOrder || (AsciiStrCmp (Value, "Yes") == 0));\r
6a690e23 1286\r
1287 //\r
1288 // DefaultTime2Wait, result function is Maximum.\r
1289 //\r
1290 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);\r
1291 if (Value == NULL) {\r
1292 goto ON_ERROR;\r
1293 }\r
1294\r
1295 NumericValue = AsciiStrDecimalToUintn (Value);\r
1296 if (NumericValue == 0) {\r
1297 Session->DefaultTime2Wait = 0;\r
1298 } else if (NumericValue > 3600) {\r
1299 goto ON_ERROR;\r
1300 } else {\r
1301 Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);\r
1302 }\r
1303 //\r
1304 // DefaultTime2Retain, result function is Minimum.\r
1305 //\r
1306 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);\r
1307 if (Value == NULL) {\r
1308 goto ON_ERROR;\r
1309 }\r
1310\r
1311 NumericValue = AsciiStrDecimalToUintn (Value);\r
1312 if (NumericValue == 0) {\r
1313 Session->DefaultTime2Retain = 0;\r
1314 } else if (NumericValue > 3600) {\r
1315 goto ON_ERROR;\r
1316 } else {\r
1317 Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);\r
1318 }\r
1319 //\r
1320 // MaxOutstandingR2T, result function is Minimum.\r
1321 //\r
1322 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);\r
1323 if (Value == NULL) {\r
1324 goto ON_ERROR;\r
1325 }\r
1326\r
1327 NumericValue = AsciiStrDecimalToUintn (Value);\r
1328 if ((NumericValue == 0) || (NumericValue > 65535)) {\r
1329 goto ON_ERROR;\r
1330 }\r
1331\r
1332 Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);\r
1333\r
1334 //\r
1335 // Remove declarative key-value paris if any.\r
1336 //\r
1337 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);\r
1338 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);\r
1339 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);\r
1340\r
e48e37fc 1341 if (IsListEmpty (KeyValueList)) {\r
6a690e23 1342 //\r
1343 // Succeed if no more keys in the list.\r
1344 //\r
1345 Status = EFI_SUCCESS;\r
1346 }\r
1347\r
1348ON_ERROR:\r
1349\r
1350 IScsiFreeKeyValueList (KeyValueList);\r
1351\r
766c7483 1352 FreePool (Data);\r
6a690e23 1353\r
1354 return Status;\r
1355}\r
1356\r
12618416 1357/**\r
6a690e23 1358 Fill the oprational prameters.\r
1359\r
c5de0d55 1360 @param[in] Conn The connection in iSCSI login.\r
1361 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r
6a690e23 1362\r
12618416 1363 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.\r
12618416 1364**/\r
1365EFI_STATUS\r
1366IScsiFillOpParams (\r
1367 IN ISCSI_CONNECTION *Conn,\r
c5de0d55 1368 IN OUT NET_BUF *Pdu\r
12618416 1369 )\r
6a690e23 1370{\r
1371 ISCSI_SESSION *Session;\r
1372 CHAR8 Value[256];\r
1373\r
1374 Session = Conn->Session;\r
1375\r
f6b7393c 1376 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");\r
6a690e23 1377 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);\r
1378\r
f6b7393c 1379 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");\r
6a690e23 1380 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);\r
1381\r
1382 AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);\r
1383 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);\r
1384\r
1385 AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");\r
1386 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);\r
1387\r
1388 AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");\r
1389 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);\r
1390\r
20621542 1391 AsciiSPrint (Value, sizeof (Value), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP);\r
6a690e23 1392 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);\r
1393\r
1394 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);\r
1395 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);\r
1396\r
1397 AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);\r
1398 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);\r
1399\r
1400 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);\r
1401 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);\r
1402\r
1403 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");\r
1404 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);\r
1405\r
1406 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");\r
1407 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);\r
1408\r
1409 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);\r
1410 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);\r
1411\r
1412 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);\r
1413 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);\r
1414\r
1415 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);\r
1416 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);\r
1417\r
1418 return EFI_SUCCESS;\r
1419}\r
1420\r
12618416 1421/**\r
6a690e23 1422 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
1423\r
c5de0d55 1424 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.\r
1425 @param[in] Len The length of the last semgnet in the PDU.\r
6a690e23 1426\r
12618416 1427 @retval EFI_SUCCESS The segment is padded or no need to pad it.\r
12618416 1428 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r
1429 padding bytes.\r
12618416 1430**/\r
1431EFI_STATUS\r
1432IScsiPadSegment (\r
c5de0d55 1433 IN OUT NET_BUF *Pdu,\r
1434 IN UINT32 Len\r
12618416 1435 )\r
6a690e23 1436{\r
1437 UINT32 PadLen;\r
1438 UINT8 *Data;\r
1439\r
1440 PadLen = ISCSI_GET_PAD_LEN (Len);\r
1441\r
1442 if (PadLen != 0) {\r
1443 Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);\r
1444 if (Data == NULL) {\r
1445 return EFI_OUT_OF_RESOURCES;\r
1446 }\r
1447\r
e48e37fc 1448 ZeroMem (Data, PadLen);\r
6a690e23 1449 }\r
1450\r
1451 return EFI_SUCCESS;\r
1452}\r
1453\r
12618416 1454/**\r
6a690e23 1455 Build a key-value list from the data segment.\r
1456\r
db3e605d 1457 @param[in] Data The data segment containing the key-value pairs.\r
1458 @param[in] Len Length of the data segment.\r
6a690e23 1459\r
db3e605d 1460 @return The key-value list.\r
963dbb30 1461 @retval NULL Other errors as indicated.\r
12618416 1462**/\r
1463LIST_ENTRY *\r
1464IScsiBuildKeyValueList (\r
1465 IN CHAR8 *Data,\r
1466 IN UINT32 Len\r
1467 )\r
6a690e23 1468{\r
e48e37fc 1469 LIST_ENTRY *ListHead;\r
6a690e23 1470 ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
1471\r
653ef62e 1472 ListHead = AllocatePool (sizeof (LIST_ENTRY));\r
6a690e23 1473 if (ListHead == NULL) {\r
1474 return NULL;\r
1475 }\r
1476\r
e48e37fc 1477 InitializeListHead (ListHead);\r
6a690e23 1478\r
1479 while (Len > 0) {\r
e48e37fc 1480 KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));\r
6a690e23 1481 if (KeyValuePair == NULL) {\r
1482 goto ON_ERROR;\r
1483 }\r
1484\r
e48e37fc 1485 InitializeListHead (&KeyValuePair->List);\r
6a690e23 1486\r
1487 KeyValuePair->Key = Data;\r
1488\r
1489 while ((Len > 0) && (*Data != '=')) {\r
1490 Len--;\r
1491 Data++;\r
1492 }\r
1493\r
1494 if (*Data == '=') {\r
1495 *Data = '\0';\r
1496\r
1497 Data++;\r
1498 Len--;\r
1499 } else {\r
766c7483 1500 FreePool (KeyValuePair);\r
6a690e23 1501 goto ON_ERROR;\r
1502 }\r
1503\r
1504 KeyValuePair->Value = Data;\r
1505\r
e48e37fc 1506 InsertTailList (ListHead, &KeyValuePair->List);;\r
6a690e23 1507\r
1508 Data += AsciiStrLen (KeyValuePair->Value) + 1;\r
1509 Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;\r
1510 }\r
1511\r
1512 return ListHead;\r
1513\r
1514ON_ERROR:\r
1515\r
1516 IScsiFreeKeyValueList (ListHead);\r
1517\r
1518 return NULL;\r
1519}\r
1520\r
12618416 1521/**\r
6a690e23 1522 Get the value string by the key name from the key-value list. If found,\r
1523 the key-value entry will be removed from the list.\r
1524\r
c5de0d55 1525 @param[in, out] KeyValueList The key-value list.\r
1526 @param[in] Key The key name to find.\r
6a690e23 1527\r
db3e605d 1528 @return The value string.\r
12618416 1529**/\r
1530CHAR8 *\r
1531IScsiGetValueByKeyFromList (\r
c5de0d55 1532 IN OUT LIST_ENTRY *KeyValueList,\r
12618416 1533 IN CHAR8 *Key\r
1534 )\r
6a690e23 1535{\r
e48e37fc 1536 LIST_ENTRY *Entry;\r
6a690e23 1537 ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
1538 CHAR8 *Value;\r
1539\r
1540 Value = NULL;\r
1541\r
1542 NET_LIST_FOR_EACH (Entry, KeyValueList) {\r
1543 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);\r
1544\r
1545 if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {\r
1546 Value = KeyValuePair->Value;\r
1547\r
e48e37fc 1548 RemoveEntryList (&KeyValuePair->List);\r
766c7483 1549 FreePool (KeyValuePair);\r
6a690e23 1550 break;\r
1551 }\r
1552 }\r
1553\r
1554 return Value;\r
1555}\r
1556\r
12618416 1557/**\r
1558 Free the key-value list.\r
1559\r
db3e605d 1560 @param[in] KeyValueList The key-value list.\r
12618416 1561**/\r
6a690e23 1562VOID\r
1563IScsiFreeKeyValueList (\r
e48e37fc 1564 IN LIST_ENTRY *KeyValueList\r
6a690e23 1565 )\r
6a690e23 1566{\r
e48e37fc 1567 LIST_ENTRY *Entry;\r
6a690e23 1568 ISCSI_KEY_VALUE_PAIR *KeyValuePair;\r
1569\r
e48e37fc 1570 while (!IsListEmpty (KeyValueList)) {\r
6a690e23 1571 Entry = NetListRemoveHead (KeyValueList);\r
1572 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);\r
1573\r
766c7483 1574 FreePool (KeyValuePair);\r
6a690e23 1575 }\r
1576\r
766c7483 1577 FreePool (KeyValueList);\r
6a690e23 1578}\r
1579\r
12618416 1580/**\r
6a690e23 1581 Normalize the iSCSI name according to RFC.\r
1582\r
c5de0d55 1583 @param[in, out] Name The iSCSI name.\r
1584 @param[in] Len length of the iSCSI name.\r
6a690e23 1585\r
12618416 1586 @retval EFI_SUCCESS The iSCSI name is valid and normalized.\r
12618416 1587 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.\r
12618416 1588**/\r
1589EFI_STATUS\r
1590IScsiNormalizeName (\r
c5de0d55 1591 IN OUT CHAR8 *Name,\r
1592 IN UINTN Len\r
12618416 1593 )\r
6a690e23 1594{\r
1595 UINTN Index;\r
1596\r
1597 for (Index = 0; Index < Len; Index++) {\r
1598 if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {\r
1599 //\r
1600 // Convert the upper-case characters to lower-case ones\r
1601 //\r
69b0882d 1602 Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');\r
6a690e23 1603 }\r
1604\r
1605 if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&\r
1606 !NET_IS_DIGIT (Name[Index]) &&\r
1607 (Name[Index] != '-') &&\r
1608 (Name[Index] != '.') &&\r
1609 (Name[Index] != ':')\r
1610 ) {\r
1611 //\r
1612 // ASCII dash, dot, colon lower-case characters and digit characters\r
1613 // are allowed.\r
1614 //\r
1615 return EFI_PROTOCOL_ERROR;\r
1616 }\r
1617 }\r
1618\r
e48e37fc 1619 if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {\r
6a690e23 1620 //\r
1621 // Only IQN format is accepted now.\r
1622 //\r
1623 return EFI_PROTOCOL_ERROR;\r
1624 }\r
1625\r
1626 return EFI_SUCCESS;\r
1627}\r
1628\r
12618416 1629/**\r
6a690e23 1630 Create an iSCSI task control block.\r
1631\r
db3e605d 1632 @param[in] Conn The connection on which the task control block will be created.\r
1633 @param[out] Tcb The newly created task control block.\r
6a690e23 1634\r
12618416 1635 @retval EFI_SUCCESS The task control block is created.\r
12618416 1636 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
db3e605d 1637 @retval EFI_NOT_READY The target can not accept new commands.\r
12618416 1638**/\r
1639EFI_STATUS\r
1640IScsiNewTcb (\r
1641 IN ISCSI_CONNECTION *Conn,\r
1642 OUT ISCSI_TCB **Tcb\r
1643 )\r
6a690e23 1644{\r
1645 ISCSI_SESSION *Session;\r
1646 ISCSI_TCB *NewTcb;\r
1647\r
1648 ASSERT (Tcb != NULL);\r
1649\r
1650 Session = Conn->Session;\r
1651\r
1652 if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {\r
1653 return EFI_NOT_READY;\r
1654 }\r
1655\r
e48e37fc 1656 NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));\r
6a690e23 1657 if (NewTcb == NULL) {\r
1658 return EFI_OUT_OF_RESOURCES;\r
1659 }\r
1660\r
e48e37fc 1661 InitializeListHead (&NewTcb->Link);\r
6a690e23 1662\r
1663 NewTcb->SoFarInOrder = TRUE;\r
1664 NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;\r
1665 NewTcb->CmdSN = Session->CmdSN;\r
1666 NewTcb->Conn = Conn;\r
1667\r
e48e37fc 1668 InsertTailList (&Session->TcbList, &NewTcb->Link);\r
6a690e23 1669\r
1670 //\r
1671 // Advance the initiator task tag.\r
1672 //\r
1673 Session->InitiatorTaskTag++;\r
1674 Session->CmdSN++;\r
1675\r
1676 *Tcb = NewTcb;\r
1677\r
1678 return EFI_SUCCESS;\r
1679}\r
1680\r
12618416 1681/**\r
6a690e23 1682 Delete the tcb from the connection and destroy it.\r
1683\r
db3e605d 1684 @param[in] Tcb The tcb to delete.\r
12618416 1685**/\r
1686VOID\r
1687IScsiDelTcb (\r
1688 IN ISCSI_TCB *Tcb\r
1689 )\r
6a690e23 1690{\r
e48e37fc 1691 RemoveEntryList (&Tcb->Link);\r
6a690e23 1692\r
766c7483 1693 FreePool (Tcb);\r
6a690e23 1694}\r
1695\r
12618416 1696/**\r
6a690e23 1697 Find the task control block by the initator task tag.\r
1698\r
db3e605d 1699 @param[in] TcbList The tcb list.\r
1700 @param[in] InitiatorTaskTag The initiator task tag.\r
6a690e23 1701\r
db3e605d 1702 @return The task control block found.\r
12618416 1703**/\r
1704ISCSI_TCB *\r
1705IScsiFindTcbByITT (\r
1706 IN LIST_ENTRY *TcbList,\r
1707 IN UINT32 InitiatorTaskTag\r
1708 )\r
6a690e23 1709{\r
1710 ISCSI_TCB *Tcb;\r
e48e37fc 1711 LIST_ENTRY *Entry;\r
6a690e23 1712\r
1713 Tcb = NULL;\r
1714\r
1715 NET_LIST_FOR_EACH (Entry, TcbList) {\r
1716 Tcb = NET_LIST_USER_STRUCT (Entry, ISCSI_TCB, Link);\r
1717\r
1718 if (Tcb->InitiatorTaskTag == InitiatorTaskTag) {\r
1719 break;\r
1720 }\r
1721\r
1722 Tcb = NULL;\r
1723 }\r
1724\r
1725 return Tcb;\r
1726}\r
1727\r
12618416 1728/**\r
6a690e23 1729 Create a data segment, pad it and calculate the CRC if needed.\r
1730\r
db3e605d 1731 @param[in] Data The data to fill into the data segment.\r
1732 @param[in] Len Length of the data.\r
1733 @param[in] DataDigest Whether to calculate CRC for this data segment.\r
6a690e23 1734\r
db3e605d 1735 @return The net buffer wrapping the data segment.\r
12618416 1736**/\r
1737NET_BUF *\r
1738IScsiNewDataSegment (\r
1739 IN UINT8 *Data,\r
1740 IN UINT32 Len,\r
1741 IN BOOLEAN DataDigest\r
1742 )\r
6a690e23 1743{\r
1744 NET_FRAGMENT Fragment[2];\r
1745 UINT32 FragmentCount;\r
1746 UINT32 PadLen;\r
1747 NET_BUF *DataSeg;\r
1748\r
1749 Fragment[0].Len = Len;\r
1750 Fragment[0].Bulk = Data;\r
1751\r
1752 PadLen = ISCSI_GET_PAD_LEN (Len);\r
1753 if (PadLen != 0) {\r
1754 Fragment[1].Len = PadLen;\r
1755 Fragment[1].Bulk = (UINT8 *) &mDataSegPad;\r
1756\r
1757 FragmentCount = 2;\r
1758 } else {\r
1759 FragmentCount = 1;\r
1760 }\r
1761\r
1762 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);\r
1763\r
1764 return DataSeg;\r
1765}\r
1766\r
12618416 1767/**\r
6a690e23 1768 Create a iSCSI SCSI command PDU to encapsulate the command issued\r
1769 by SCSI through the EXT SCSI PASS THRU Protocol.\r
1770\r
db3e605d 1771 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.\r
1772 @param[in] Lun The LUN.\r
1773 @param[in] Tcb The tcb assocated with this SCSI command.\r
6a690e23 1774\r
db3e605d 1775 @return The created iSCSI SCSI command PDU.\r
963dbb30 1776 @retval NULL Other errors as indicated.\r
12618416 1777**/\r
1778NET_BUF *\r
1779IScsiNewScsiCmdPdu (\r
1780 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r
1781 IN UINT64 Lun,\r
1782 IN ISCSI_TCB *Tcb\r
1783 )\r
6a690e23 1784{\r
e48e37fc 1785 LIST_ENTRY *NbufList;\r
6a690e23 1786 NET_BUF *Pdu;\r
1787 NET_BUF *PduHeader;\r
1788 NET_BUF *DataSeg;\r
1789 SCSI_COMMAND *ScsiCmd;\r
1790 UINT8 AHSLength;\r
1791 UINT32 Length;\r
1792 ISCSI_ADDITIONAL_HEADER *Header;\r
1793 ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;\r
1794 ISCSI_SESSION *Session;\r
1795 UINT32 ImmediateDataLen;\r
1796\r
1797 AHSLength = 0;\r
1798\r
1799 if (Packet->DataDirection == DataBi) {\r
1800 //\r
1801 // Bi directional Read/Write command, the bidirectional expected\r
1802 // read data length AHS is required.\r
1803 //\r
1804 AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);\r
1805 }\r
1806\r
1807 if (Packet->CdbLength > 16) {\r
1808 //\r
1809 // The CDB exceeds 16 bytes, an extended CDB AHS is required.\r
1810 //\r
69b0882d 1811 AHSLength = (UINT8) (AHSLength + (ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER)));\r
6a690e23 1812 }\r
1813\r
1814 Length = sizeof (SCSI_COMMAND) + AHSLength;\r
1815 PduHeader = NetbufAlloc (Length);\r
1816 if (PduHeader == NULL) {\r
1817 return NULL;\r
1818 }\r
1819\r
1820 ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);\r
653ef62e 1821 if (ScsiCmd == NULL) {\r
1822 NetbufFree (PduHeader);\r
1823 return NULL;\r
1824 } \r
6a690e23 1825 Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);\r
1826\r
e48e37fc 1827 ZeroMem (ScsiCmd, Length);\r
6a690e23 1828\r
1829 ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);\r
1830 ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);\r
1831\r
1832 //\r
1833 // Set the READ/WRITE flags according to the IO type of this request.\r
1834 //\r
1835 switch (Packet->DataDirection) {\r
1836 case DataIn:\r
1837 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);\r
1838 ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);\r
1839 break;\r
1840\r
1841 case DataOut:\r
1842 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);\r
1843 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);\r
1844 break;\r
1845\r
1846 case DataBi:\r
1847 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);\r
1848 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);\r
1849\r
1850 //\r
1851 // Fill the bidirectional expected read data length AHS.\r
1852 //\r
1853 BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;\r
1854 Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);\r
1855\r
1856 BiExpReadDataLenAHS->Length = NTOHS (5);\r
1857 BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;\r
1858 BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);\r
1859\r
1860 break;\r
1861 }\r
1862\r
1863 ScsiCmd->TotalAHSLength = AHSLength;\r
e48e37fc 1864 CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));\r
6a690e23 1865 ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);\r
1866 ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);\r
1867 ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);\r
1868\r
f6b7393c 1869 CopyMem (ScsiCmd->Cdb, Packet->Cdb, sizeof (ScsiCmd->Cdb));\r
6a690e23 1870\r
1871 if (Packet->CdbLength > 16) {\r
1204fe83 1872 Header->Length = NTOHS ((UINT16) (Packet->CdbLength - 15));\r
6a690e23 1873 Header->Type = ISCSI_AHS_TYPE_EXT_CDB;\r
1874\r
e48e37fc 1875 CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);\r
6a690e23 1876 }\r
1877\r
1878 Pdu = PduHeader;\r
1879 Session = Tcb->Conn->Session;\r
1880 ImmediateDataLen = 0;\r
1881\r
1882 if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {\r
1883 //\r
1884 // Send immediate data in this SCSI Command PDU. The length of the immeidate\r
1885 // data is the minimum of FirstBurstLength, the data length to be xfered and\r
1886 // the MaxRecvdataSegmentLength on this connection.\r
1887 //\r
1888 ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);\r
1889 ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);\r
1890\r
1891 //\r
1892 // Update the data segment length in the PDU header.\r
1893 //\r
1894 ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);\r
1895\r
1896 //\r
1897 // Create the data segment.\r
1898 //\r
1899 DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);\r
1900 if (DataSeg == NULL) {\r
1901 NetbufFree (PduHeader);\r
1902 Pdu = NULL;\r
1903 goto ON_EXIT;\r
1904 }\r
1905\r
653ef62e 1906 NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
6a690e23 1907 if (NbufList == NULL) {\r
1908 NetbufFree (PduHeader);\r
1909 NetbufFree (DataSeg);\r
1910\r
1911 Pdu = NULL;\r
1912 goto ON_EXIT;\r
1913 }\r
1914\r
e48e37fc 1915 InitializeListHead (NbufList);\r
1916 InsertTailList (NbufList, &PduHeader->List);\r
1917 InsertTailList (NbufList, &DataSeg->List);\r
6a690e23 1918\r
1919 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
1920 if (Pdu == NULL) {\r
1921 IScsiFreeNbufList (NbufList);\r
1922 }\r
1923 }\r
1924\r
1925 if (Session->InitialR2T ||\r
1926 (ImmediateDataLen == Session->FirstBurstLength) ||\r
1927 (ImmediateDataLen == Packet->OutTransferLength)\r
1928 ) {\r
1929 //\r
1930 // Unsolicited data out sequence is not allowed,\r
653ef62e 1931 // or FirstBurstLength data is already sent out by immediate data\r
6a690e23 1932 // or all the OUT data accompany this SCSI packet is sent as\r
1933 // immediate data, the final flag should be set on this SCSI Command\r
1934 // PDU.\r
1935 //\r
1936 ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);\r
1937 }\r
1938\r
1939ON_EXIT:\r
1940\r
1941 return Pdu;\r
1942}\r
1943\r
12618416 1944/**\r
1945 Create a new iSCSI SCSI Data Out PDU.\r
1946\r
db3e605d 1947 @param[in] Data The data to put into the Data Out PDU.\r
1948 @param[in] Len Length of the data.\r
1949 @param[in] DataSN The DataSN of the Data Out PDU.\r
1950 @param[in] Tcb The task control block of this Data Out PDU.\r
1951 @param[in] Lun The LUN.\r
12618416 1952\r
db3e605d 1953 @return The net buffer wrapping the Data Out PDU.\r
963dbb30 1954 @retval NULL Other errors as indicated.\r
12618416 1955**/\r
6a690e23 1956NET_BUF *\r
1957IScsiNewDataOutPdu (\r
1958 IN UINT8 *Data,\r
1959 IN UINT32 Len,\r
1960 IN UINT32 DataSN,\r
1961 IN ISCSI_TCB *Tcb,\r
1962 IN UINT64 Lun\r
1963 )\r
6a690e23 1964{\r
e48e37fc 1965 LIST_ENTRY *NbufList;\r
6a690e23 1966 NET_BUF *PduHdr;\r
1967 NET_BUF *DataSeg;\r
1968 NET_BUF *Pdu;\r
1969 ISCSI_SCSI_DATA_OUT *DataOutHdr;\r
1970 ISCSI_XFER_CONTEXT *XferContext;\r
1971\r
653ef62e 1972 NbufList = AllocatePool (sizeof (LIST_ENTRY));\r
6a690e23 1973 if (NbufList == NULL) {\r
1974 return NULL;\r
1975 }\r
1976\r
e48e37fc 1977 InitializeListHead (NbufList);\r
6a690e23 1978\r
1979 //\r
1980 // Allocate memory for the BHS.\r
1981 //\r
1982 PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));\r
1983 if (PduHdr == NULL) {\r
766c7483 1984 FreePool (NbufList);\r
6a690e23 1985 return NULL;\r
1986 }\r
1987 //\r
1988 // Insert the BHS into the buffer list.\r
1989 //\r
e48e37fc 1990 InsertTailList (NbufList, &PduHdr->List);\r
6a690e23 1991\r
1992 DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);\r
653ef62e 1993 ASSERT (DataOutHdr != NULL);\r
6a690e23 1994 XferContext = &Tcb->XferContext;\r
1995\r
e48e37fc 1996 ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));\r
6a690e23 1997\r
1998 //\r
1999 // Set the flags and fields of the Data Out PDU BHS.\r
2000 //\r
2001 ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);\r
2002 ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);\r
2003\r
2004 DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);\r
2005 DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);\r
2006 DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);\r
2007 DataOutHdr->DataSN = HTONL (DataSN);\r
2008 DataOutHdr->BufferOffset = HTONL (XferContext->Offset);\r
2009\r
2010 if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {\r
e48e37fc 2011 CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));\r
6a690e23 2012 }\r
2013 //\r
2014 // Build the data segment for this Data Out PDU.\r
2015 //\r
2016 DataSeg = IScsiNewDataSegment (Data, Len, FALSE);\r
2017 if (DataSeg == NULL) {\r
2018 IScsiFreeNbufList (NbufList);\r
2019 return NULL;\r
2020 }\r
2021 //\r
2022 // Put the data segment into the buffer list and combine it with the BHS\r
2023 // into a full Data Out PDU.\r
2024 //\r
e48e37fc 2025 InsertTailList (NbufList, &DataSeg->List);\r
6a690e23 2026 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);\r
2027 if (Pdu == NULL) {\r
2028 IScsiFreeNbufList (NbufList);\r
2029 }\r
2030\r
2031 return Pdu;\r
2032}\r
2033\r
12618416 2034/**\r
6a690e23 2035 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.\r
2036\r
db3e605d 2037 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.\r
2038 @param[in] Tcb The task control block of the data to send out.\r
2039 @param[in] Lun The LUN the data will be sent to.\r
6a690e23 2040\r
db3e605d 2041 @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.\r
963dbb30 2042 @retval NULL Other errors as indicated.\r
12618416 2043**/\r
2044LIST_ENTRY *\r
2045IScsiGenerateDataOutPduSequence (\r
2046 IN UINT8 *Data,\r
2047 IN ISCSI_TCB *Tcb,\r
2048 IN UINT64 Lun\r
2049 )\r
6a690e23 2050{\r
e48e37fc 2051 LIST_ENTRY *PduList;\r
6a690e23 2052 UINT32 DataSN;\r
2053 UINT32 DataLen;\r
2054 NET_BUF *DataOutPdu;\r
2055 ISCSI_CONNECTION *Conn;\r
2056 ISCSI_XFER_CONTEXT *XferContext;\r
2057\r
653ef62e 2058 PduList = AllocatePool (sizeof (LIST_ENTRY));\r
6a690e23 2059 if (PduList == NULL) {\r
2060 return NULL;\r
2061 }\r
2062\r
e48e37fc 2063 InitializeListHead (PduList);\r
6a690e23 2064\r
2065 DataSN = 0;\r
2066 Conn = Tcb->Conn;\r
2067 DataOutPdu = NULL;\r
2068 XferContext = &Tcb->XferContext;\r
2069\r
2070 while (XferContext->DesiredLength > 0) {\r
2071 //\r
2072 // Determine the length of data this Data Out PDU can carry.\r
2073 //\r
2074 DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);\r
6a690e23 2075\r
2076 //\r
2077 // Create a Data Out PDU.\r
2078 //\r
2079 DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);\r
2080 if (DataOutPdu == NULL) {\r
2081 IScsiFreeNbufList (PduList);\r
2082 PduList = NULL;\r
2083\r
2084 goto ON_EXIT;\r
2085 }\r
2086\r
e48e37fc 2087 InsertTailList (PduList, &DataOutPdu->List);\r
6a690e23 2088\r
2089 //\r
2090 // Update the context and DataSN.\r
2091 //\r
2092 XferContext->Offset += DataLen;\r
2093 XferContext->DesiredLength -= DataLen;\r
2094 DataSN++;\r
e92d66f2 2095 Data += DataLen;\r
6a690e23 2096 }\r
2097 //\r
2098 // Set the F bit for the last data out PDU in this sequence.\r
2099 //\r
2100 ISCSI_SET_FLAG (NetbufGetByte (DataOutPdu, 0, NULL), ISCSI_BHS_FLAG_FINAL);\r
2101\r
2102ON_EXIT:\r
2103\r
2104 return PduList;\r
2105}\r
2106\r
12618416 2107/**\r
6a690e23 2108 Send the Data in a sequence of Data Out PDUs one by one.\r
2109\r
db3e605d 2110 @param[in] Data The data to carry by Data Out PDUs.\r
2111 @param[in] Lun The LUN the data will be sent to.\r
2112 @param[in] Tcb The task control block.\r
6a690e23 2113\r
12618416 2114 @retval EFI_SUCCES The data is sent out to the LUN.\r
12618416 2115 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
963dbb30 2116 @retval Others Other errors as indicated.\r
12618416 2117**/\r
2118EFI_STATUS\r
2119IScsiSendDataOutPduSequence (\r
2120 IN UINT8 *Data,\r
2121 IN UINT64 Lun,\r
2122 IN ISCSI_TCB *Tcb\r
2123 )\r
6a690e23 2124{\r
e48e37fc 2125 LIST_ENTRY *DataOutPduList;\r
2126 LIST_ENTRY *Entry;\r
6a690e23 2127 NET_BUF *Pdu;\r
2128 EFI_STATUS Status;\r
2129\r
2130 //\r
2131 // Generate the Data Out PDU sequence.\r
2132 //\r
2133 DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);\r
2134 if (DataOutPduList == NULL) {\r
2135 return EFI_OUT_OF_RESOURCES;\r
2136 }\r
2137\r
2138 Status = EFI_SUCCESS;\r
2139\r
2140 //\r
2141 // Send the Data Out PDU's one by one.\r
2142 //\r
2143 NET_LIST_FOR_EACH (Entry, DataOutPduList) {\r
2144 Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);\r
2145\r
2146 Status = Tcp4IoTransmit (&Tcb->Conn->Tcp4Io, Pdu);\r
2147 if (EFI_ERROR (Status)) {\r
2148 break;\r
2149 }\r
2150 }\r
2151\r
2152 IScsiFreeNbufList (DataOutPduList);\r
2153\r
2154 return Status;\r
2155}\r
2156\r
12618416 2157/**\r
6a690e23 2158 Process the received iSCSI SCSI Data In PDU.\r
2159\r
db3e605d 2160 @param[in] Pdu The Data In PDU received.\r
2161 @param[in] Tcb The task control block.\r
2162 @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
6a690e23 2163\r
db3e605d 2164 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update\r
2165 actions are taken.\r
2166 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
2167 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
963dbb30 2168 @retval Others Other errors as indicated.\r
12618416 2169**/\r
2170EFI_STATUS\r
2171IScsiOnDataInRcvd (\r
2172 IN NET_BUF *Pdu,\r
2173 IN ISCSI_TCB *Tcb,\r
2174 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
2175 )\r
6a690e23 2176{\r
2177 ISCSI_SCSI_DATA_IN *DataInHdr;\r
2178 EFI_STATUS Status;\r
2179\r
2180 DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);\r
2181\r
2182 DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);\r
2183 DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);\r
2184 DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);\r
2185 DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);\r
2186\r
2187 //\r
2188 // Check the DataSN.\r
2189 //\r
2190 Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);\r
2191 if (EFI_ERROR (Status)) {\r
2192 return Status;\r
2193 }\r
2194\r
2195 if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {\r
2196 return EFI_PROTOCOL_ERROR;\r
2197 }\r
2198 //\r
2199 // Update the command related sequence numbers.\r
2200 //\r
2201 IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);\r
2202\r
2203 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {\r
2204 if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {\r
2205 //\r
2206 // The S bit is on but the F bit is off.\r
2207 //\r
2208 return EFI_PROTOCOL_ERROR;\r
2209 }\r
2210\r
2211 Tcb->StatusXferd = TRUE;\r
2212\r
2213 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {\r
2214 //\r
2215 // Underflow and Overflow are mutual flags.\r
2216 //\r
2217 return EFI_PROTOCOL_ERROR;\r
2218 }\r
2219 //\r
2220 // S bit is on, the StatSN is valid.\r
2221 //\r
2222 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));\r
2223 if (EFI_ERROR (Status)) {\r
2224 return Status;\r
2225 }\r
2226\r
2227 Packet->HostAdapterStatus = 0;\r
2228 Packet->TargetStatus = DataInHdr->Status;\r
2229\r
2230 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {\r
2231 Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);\r
2232 Status = EFI_BAD_BUFFER_SIZE;\r
2233 }\r
2234\r
2235 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {\r
2236 Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);\r
2237 }\r
2238 }\r
2239\r
2240 return Status;\r
2241}\r
2242\r
12618416 2243/**\r
2244 Process the received iSCSI R2T PDU.\r
6a690e23 2245\r
db3e605d 2246 @param[in] Pdu The R2T PDU received.\r
2247 @param[in] Tcb The task control block.\r
2248 @param[in] Lun The Lun.\r
2249 @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
6a690e23 2250\r
12618416 2251 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.\r
12618416 2252 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
963dbb30 2253 @retval Others Other errors as indicated.\r
12618416 2254**/\r
2255EFI_STATUS\r
2256IScsiOnR2TRcvd (\r
2257 IN NET_BUF *Pdu,\r
2258 IN ISCSI_TCB *Tcb,\r
2259 IN UINT64 Lun,\r
2260 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
2261 )\r
6a690e23 2262{\r
2263 ISCSI_READY_TO_TRANSFER *R2THdr;\r
2264 EFI_STATUS Status;\r
2265 ISCSI_XFER_CONTEXT *XferContext;\r
2266 UINT8 *Data;\r
2267\r
2268 R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);\r
2269\r
2270 R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);\r
2271 R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);\r
2272 R2THdr->StatSN = NTOHL (R2THdr->StatSN);\r
f6b7393c 2273 R2THdr->R2TSeqNum = NTOHL (R2THdr->R2TSeqNum);\r
6a690e23 2274 R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);\r
2275 R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);\r
2276\r
2277 if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {\r
2278 return EFI_PROTOCOL_ERROR;;\r
2279 }\r
2280 //\r
2281 // Check the sequence number.\r
2282 //\r
f6b7393c 2283 Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSeqNum);\r
6a690e23 2284 if (EFI_ERROR (Status)) {\r
2285 return Status;\r
2286 }\r
2287\r
2288 XferContext = &Tcb->XferContext;\r
2289 XferContext->TargetTransferTag = R2THdr->TargetTransferTag;\r
2290 XferContext->Offset = R2THdr->BufferOffset;\r
2291 XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;\r
2292\r
2293 if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||\r
2294 (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)\r
2295 ) {\r
2296 return EFI_PROTOCOL_ERROR;\r
2297 }\r
2298 //\r
2299 // Send the data solicited by this R2T.\r
2300 //\r
2301 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;\r
2302 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);\r
2303\r
2304 return Status;\r
2305}\r
2306\r
12618416 2307/**\r
6a690e23 2308 Process the received iSCSI SCSI Response PDU.\r
2309\r
db3e605d 2310 @param[in] Pdu The Response PDU received.\r
2311 @param[in] Tcb The task control block.\r
2312 @param[in, out] Packet The EXT SCSI PASS THRU request packet.\r
6a690e23 2313\r
12618416 2314 @retval EFI_SUCCES The Response PDU is processed.\r
12618416 2315 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
db3e605d 2316 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.\r
963dbb30 2317 @retval Others Other errors as indicated.\r
12618416 2318**/\r
2319EFI_STATUS\r
2320IScsiOnScsiRspRcvd (\r
2321 IN NET_BUF *Pdu,\r
2322 IN ISCSI_TCB *Tcb,\r
2323 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
2324 )\r
6a690e23 2325{\r
2326 SCSI_RESPONSE *ScsiRspHdr;\r
2327 ISCSI_SENSE_DATA *SenseData;\r
2328 EFI_STATUS Status;\r
2329 UINT32 DataSegLen;\r
2330\r
2331 ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);\r
2332\r
2333 ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);\r
2334 if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {\r
2335 return EFI_PROTOCOL_ERROR;\r
2336 }\r
2337\r
2338 ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);\r
2339\r
2340 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);\r
2341 if (EFI_ERROR (Status)) {\r
2342 return Status;\r
2343 }\r
2344\r
2345 ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);\r
2346 ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);\r
2347 IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);\r
2348\r
2349 Tcb->StatusXferd = TRUE;\r
2350\r
2351 Packet->HostAdapterStatus = ScsiRspHdr->Response;\r
2352 if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {\r
2353 return EFI_SUCCESS;\r
2354 }\r
2355\r
2356 Packet->TargetStatus = ScsiRspHdr->Status;\r
2357\r
2358 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||\r
2359 ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)\r
2360 ) {\r
2361 return EFI_PROTOCOL_ERROR;\r
2362 }\r
2363\r
2364 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {\r
2365 Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);\r
2366 Status = EFI_BAD_BUFFER_SIZE;\r
2367 }\r
2368\r
2369 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {\r
2370 Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);\r
2371 }\r
2372\r
2373 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {\r
2374 if (Packet->DataDirection == DataIn) {\r
2375 Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);\r
2376 } else {\r
2377 Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);\r
2378 }\r
2379\r
2380 Status = EFI_BAD_BUFFER_SIZE;\r
2381 }\r
2382\r
2383 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {\r
2384 if (Packet->DataDirection == DataIn) {\r
2385 Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);\r
2386 } else {\r
2387 Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);\r
2388 }\r
2389 }\r
2390\r
2391 DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);\r
2392 if (DataSegLen != 0) {\r
2393 SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);\r
2394\r
2395 SenseData->Length = NTOHS (SenseData->Length);\r
2396\r
2397 Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);\r
2398 if (Packet->SenseDataLength != 0) {\r
e48e37fc 2399 CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);\r
6a690e23 2400 }\r
2401 } else {\r
2402 Packet->SenseDataLength = 0;\r
2403 }\r
2404\r
2405 return Status;\r
2406}\r
2407\r
12618416 2408/**\r
6a690e23 2409 Process the received NOP In PDU.\r
2410\r
db3e605d 2411 @param[in] Pdu The NOP In PDU received.\r
2412 @param[in] Tcb The task control block.\r
6a690e23 2413\r
12618416 2414 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence\r
2415 numbers are updated.\r
12618416 2416 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.\r
12618416 2417**/\r
2418EFI_STATUS\r
2419IScsiOnNopInRcvd (\r
2420 IN NET_BUF *Pdu,\r
2421 IN ISCSI_TCB *Tcb\r
2422 )\r
6a690e23 2423{\r
2424 ISCSI_NOP_IN *NopInHdr;\r
2425 EFI_STATUS Status;\r
2426\r
2427 NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);\r
2428\r
2429 NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);\r
2430 NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);\r
2431 NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);\r
2432\r
2433 if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {\r
2434 if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {\r
2435 return EFI_PROTOCOL_ERROR;\r
2436 }\r
2437 } else {\r
2438 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);\r
2439 if (EFI_ERROR (Status)) {\r
2440 return Status;\r
2441 }\r
2442 }\r
2443\r
2444 IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);\r
2445\r
2446 return EFI_SUCCESS;\r
2447}\r
2448\r
12618416 2449/**\r
2450 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.\r
6a690e23 2451\r
db3e605d 2452 @param[in] PassThru The EXT SCSI PASS THRU protocol.\r
2453 @param[in] Target The target ID.\r
2454 @param[in] Lun The LUN.\r
2455 @param[in, out] Packet The request packet containing IO request, SCSI command\r
2456 buffer and buffers to read/write.\r
2457 \r
2458 @retval EFI_SUCCES The SCSI command is executed and the result is updated to \r
2459 the Packet.\r
963dbb30 2460 @retval EFI_DEVICE_ERROR Session state was not as required.\r
db3e605d 2461 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
963dbb30 2462 @retval Others Other errors as indicated.\r
12618416 2463**/\r
2464EFI_STATUS\r
2465IScsiExecuteScsiCommand (\r
2466 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,\r
2467 IN UINT8 *Target,\r
2468 IN UINT64 Lun,\r
2469 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet\r
2470 )\r
6a690e23 2471{\r
2472 EFI_STATUS Status;\r
2473 ISCSI_DRIVER_DATA *Private;\r
2474 ISCSI_SESSION *Session;\r
2475 EFI_EVENT TimeoutEvent;\r
2476 ISCSI_CONNECTION *Conn;\r
2477 ISCSI_TCB *Tcb;\r
2478 NET_BUF *Pdu;\r
2479 ISCSI_XFER_CONTEXT *XferContext;\r
2480 UINT8 *Data;\r
2481 ISCSI_IN_BUFFER_CONTEXT InBufferContext;\r
2482 UINT64 Timeout;\r
69b0882d 2483 UINT8 *Buffer;\r
6a690e23 2484\r
2485 Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);\r
2486 Session = &Private->Session;\r
2487 Status = EFI_SUCCESS;\r
2488 Tcb = NULL;\r
2489 TimeoutEvent = NULL;\r
5c70cb32 2490 Timeout = 0;\r
6a690e23 2491\r
2492 if (Session->State != SESSION_STATE_LOGGED_IN) {\r
2493 return EFI_DEVICE_ERROR;\r
2494 }\r
2495\r
2496 Conn = NET_LIST_USER_STRUCT_S (\r
2497 Session->Conns.ForwardLink,\r
2498 ISCSI_CONNECTION,\r
2499 Link,\r
2500 ISCSI_CONNECTION_SIGNATURE\r
2501 );\r
2502\r
2503 if (Packet->Timeout != 0) {\r
2504 Timeout = MultU64x32 (Packet->Timeout, 2);\r
6a690e23 2505 }\r
2506\r
2507 Status = IScsiNewTcb (Conn, &Tcb);\r
2508 if (EFI_ERROR (Status)) {\r
2509 goto ON_EXIT;\r
2510 }\r
2511 //\r
2512 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.\r
2513 //\r
2514 Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);\r
2515 if (Pdu == NULL) {\r
2516 Status = EFI_OUT_OF_RESOURCES;\r
2517 goto ON_EXIT;\r
2518 }\r
2519\r
2520 XferContext = &Tcb->XferContext;\r
69b0882d 2521 Buffer = NetbufGetByte (Pdu, 0, NULL);\r
2522 XferContext->Offset = ISCSI_GET_DATASEG_LEN (Buffer);\r
6a690e23 2523\r
2524 //\r
2525 // Transmit the SCSI Command PDU.\r
2526 //\r
2527 Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);\r
2528\r
2529 NetbufFree (Pdu);\r
2530\r
2531 if (EFI_ERROR (Status)) {\r
2532 goto ON_EXIT;\r
2533 }\r
2534\r
2535 if (!Session->InitialR2T &&\r
2536 (XferContext->Offset < Session->FirstBurstLength) &&\r
2537 (XferContext->Offset < Packet->OutTransferLength)\r
2538 ) {\r
2539 //\r
2540 // Unsolicited Data-Out sequence is allowed, there is remaining SCSI\r
2541 // OUT data and the limit of FirstBurstLength is not reached.\r
2542 //\r
2543 XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;\r
2544 XferContext->DesiredLength = MIN (\r
2545 Session->FirstBurstLength,\r
2546 Packet->OutTransferLength - XferContext->Offset\r
2547 );\r
2548\r
2549 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;\r
2550 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);\r
2551 if (EFI_ERROR (Status)) {\r
2552 goto ON_EXIT;\r
2553 }\r
2554 }\r
2555\r
2556 InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;\r
2557 InBufferContext.InDataLen = Packet->InTransferLength;\r
2558\r
2559 while (!Tcb->StatusXferd) {\r
5c70cb32 2560 //\r
2561 // Start the timeout timer.\r
2562 //\r
db3e605d 2563 if (Timeout != 0) {\r
5c70cb32 2564 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);\r
2565 if (EFI_ERROR (Status)) {\r
2566 goto ON_EXIT;\r
2567 }\r
2568 TimeoutEvent = Conn->TimeoutEvent; \r
2569 }\r
6a690e23 2570 //\r
2571 // try to receive PDU from target.\r
2572 //\r
2573 Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);\r
2574 if (EFI_ERROR (Status)) {\r
2575 goto ON_EXIT;\r
2576 }\r
2577\r
2578 switch (ISCSI_GET_OPCODE (NetbufGetByte (Pdu, 0, NULL))) {\r
2579 case ISCSI_OPCODE_SCSI_DATA_IN:\r
2580 Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);\r
2581 break;\r
2582\r
2583 case ISCSI_OPCODE_R2T:\r
2584 Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);\r
2585 break;\r
2586\r
2587 case ISCSI_OPCODE_SCSI_RSP:\r
2588 Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);\r
2589 break;\r
2590\r
2591 case ISCSI_OPCODE_NOP_IN:\r
2592 Status = IScsiOnNopInRcvd (Pdu, Tcb);\r
2593 break;\r
2594\r
2595 case ISCSI_OPCODE_VENDOR_T0:\r
2596 case ISCSI_OPCODE_VENDOR_T1:\r
2597 case ISCSI_OPCODE_VENDOR_T2:\r
2598 //\r
2599 // These messages are vendor specific, skip them.\r
2600 //\r
2601 break;\r
2602\r
2603 default:\r
2604 Status = EFI_PROTOCOL_ERROR;\r
2605 break;\r
2606 }\r
2607\r
2608 NetbufFree (Pdu);\r
2609\r
2610 if (EFI_ERROR (Status)) {\r
2611 break;\r
2612 }\r
2613 }\r
2614\r
2615ON_EXIT:\r
2616\r
2617 if (TimeoutEvent != NULL) {\r
2618 gBS->SetTimer (TimeoutEvent, TimerCancel, 0);\r
2619 }\r
2620\r
2621 if (Tcb != NULL) {\r
2622 IScsiDelTcb (Tcb);\r
2623 }\r
2624\r
2625 if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) {\r
2626 //\r
2627 // Reinstate the session.\r
2628 //\r
2629 if (EFI_ERROR (IScsiSessionReinstatement (Private))) {\r
2630 Status = EFI_DEVICE_ERROR;\r
2631 }\r
2632 }\r
2633\r
2634 return Status;\r
2635}\r
2636\r
12618416 2637/**\r
6a690e23 2638 Reinstate the session on some error.\r
2639\r
c5de0d55 2640 @param[in, out] Private The iSCSI driver data.\r
6a690e23 2641\r
12618416 2642 @retval EFI_SUCCES The session is reinstated from some error.\r
db3e605d 2643 @retval Other Reinstatement failed.\r
12618416 2644**/\r
2645EFI_STATUS\r
2646IScsiSessionReinstatement (\r
c5de0d55 2647 IN OUT ISCSI_DRIVER_DATA *Private\r
12618416 2648 )\r
6a690e23 2649{\r
2650 ISCSI_SESSION *Session;\r
2651 EFI_STATUS Status;\r
2652\r
2653 Session = &Private->Session;\r
2654 ASSERT (Session->State == SESSION_STATE_LOGGED_IN);\r
2655\r
2656 //\r
2657 // Abort the session and re-init it.\r
2658 //\r
2659 IScsiSessionAbort (Session);\r
2660 IScsiSessionInit (Session, TRUE);\r
2661\r
2662 //\r
2663 // Login again.\r
2664 //\r
2665 Status = IScsiSessionLogin (Private);\r
2666\r
2667 return Status;\r
2668}\r
2669\r
12618416 2670/**\r
6a690e23 2671 Initialize some session parameters before login.\r
2672\r
963dbb30 2673 @param[in, out] Session The iSCSI session.\r
2674 @param[in] Recovery Whether the request is from a fresh new start or recovery.\r
12618416 2675**/\r
2676VOID\r
2677IScsiSessionInit (\r
963dbb30 2678 IN OUT ISCSI_SESSION *Session,\r
2679 IN BOOLEAN Recovery\r
12618416 2680 )\r
6a690e23 2681{\r
2682 UINT32 Random;\r
2683\r
2684 if (!Recovery) {\r
2685 Session->Signature = ISCSI_SESSION_SIGNATURE;\r
2686 Session->State = SESSION_STATE_FREE;\r
2687\r
2688 Random = NET_RANDOM (NetRandomInitSeed ());\r
2689\r
a78d176c 2690 Session->Isid[0] = ISID_BYTE_0;\r
2691 Session->Isid[1] = ISID_BYTE_1;\r
2692 Session->Isid[2] = ISID_BYTE_2;\r
2693 Session->Isid[3] = ISID_BYTE_3;\r
2694 Session->Isid[4] = (UINT8) Random;\r
2695 Session->Isid[5] = (UINT8) (Random >> 8);\r
6a690e23 2696\r
e48e37fc 2697 InitializeListHead (&Session->Conns);\r
2698 InitializeListHead (&Session->TcbList);\r
6a690e23 2699 }\r
2700\r
a78d176c 2701 Session->Tsih = 0;\r
6a690e23 2702\r
2703 Session->CmdSN = 1;\r
2704 Session->InitiatorTaskTag = 1;\r
a78d176c 2705 Session->NextCid = 1;\r
6a690e23 2706\r
2707 Session->TargetPortalGroupTag = 0;\r
2708 Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;\r
2709 Session->InitialR2T = FALSE;\r
2710 Session->ImmediateData = TRUE;\r
2711 Session->MaxBurstLength = 262144;\r
2712 Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;\r
2713 Session->DefaultTime2Wait = 2;\r
2714 Session->DefaultTime2Retain = 20;\r
2715 Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;\r
2716 Session->DataPDUInOrder = TRUE;\r
2717 Session->DataSequenceInOrder = TRUE;\r
2718 Session->ErrorRecoveryLevel = 0;\r
2719}\r
2720\r
12618416 2721/**\r
6a690e23 2722 Abort the iSCSI session, that is, reset all the connection and free the\r
2723 resources.\r
2724\r
c5de0d55 2725 @param[in, out] Session The iSCSI session.\r
6a690e23 2726\r
12618416 2727 @retval EFI_SUCCES The session is aborted.\r
12618416 2728**/\r
2729EFI_STATUS\r
2730IScsiSessionAbort (\r
c5de0d55 2731 IN OUT ISCSI_SESSION *Session\r
12618416 2732 )\r
6a690e23 2733{\r
2734 ISCSI_DRIVER_DATA *Private;\r
2735 ISCSI_CONNECTION *Conn;\r
2736\r
2737 if (Session->State != SESSION_STATE_LOGGED_IN) {\r
2738 return EFI_SUCCESS;\r
2739 }\r
2740\r
e48e37fc 2741 ASSERT (!IsListEmpty (&Session->Conns));\r
6a690e23 2742\r
2743 Private = ISCSI_DRIVER_DATA_FROM_SESSION (Session);\r
2744\r
e48e37fc 2745 while (!IsListEmpty (&Session->Conns)) {\r
6a690e23 2746 Conn = NET_LIST_USER_STRUCT_S (\r
2747 Session->Conns.ForwardLink,\r
2748 ISCSI_CONNECTION,\r
2749 Link,\r
2750 ISCSI_CONNECTION_SIGNATURE\r
2751 );\r
2752\r
2753 gBS->CloseProtocol (\r
2754 Conn->Tcp4Io.Handle,\r
2755 &gEfiTcp4ProtocolGuid,\r
2756 Private->Image,\r
2757 Private->ExtScsiPassThruHandle\r
2758 );\r
2759\r
2760 IScsiConnReset (Conn);\r
2761\r
2762 IScsiDetatchConnection (Conn);\r
2763 IScsiDestroyConnection (Conn);\r
2764 }\r
2765\r
2766 Session->State = SESSION_STATE_FAILED;\r
2767\r
2768 return EFI_SUCCESS;\r
2769}\r
EFI Development Kit II mirror for PVE