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