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