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