]> git.proxmox.com Git - mirror_edk2.git/blob - NetworkPkg/IScsiDxe/IScsiProto.c
projects / mirror_edk2.git / blob
? search:


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