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