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