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