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