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