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


50923654644194d77b2bc8cc77ea39d660dbc457
[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
1079 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1080 if (KeyValueList == NULL) {
1081 return EFI_OUT_OF_RESOURCES;
1082 }
1083
1084 Status = EFI_NOT_FOUND;
1085
1086 while (TRUE) {
1087 TargetAddress = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ADDRESS);
1088 if (TargetAddress == NULL) {
1089 break;
1090 }
1091
1092 if (!NET_IS_DIGIT (TargetAddress[0])) {
1093 //
1094 // The domainname of the target may be presented in three formats: a DNS host name,
1095 // a dotted-decimal IPv4 address, or a bracketed IPv6 address. Only accept dotted
1096 // IPv4 address.
1097 //
1098 continue;
1099 }
1100
1101 IpStr = TargetAddress;
1102
1103 while ((*TargetAddress != 0) && (*TargetAddress != ':') && (*TargetAddress != ',')) {
1104 //
1105 // NULL, ':', or ',' ends the IPv4 string.
1106 //
1107 TargetAddress++;
1108 }
1109
1110 if (*TargetAddress == ',') {
1111 //
1112 // Comma and the portal group tag MUST be ommitted if the TargetAddress is sent
1113 // as the result of a redirection.
1114 //
1115 continue;
1116 } else if (*TargetAddress == ':') {
1117 *TargetAddress = '\0';
1118
1119 TargetAddress++;
1120
1121 Number = AsciiStrDecimalToUintn (TargetAddress);
1122 if (Number > 0xFFFF) {
1123 continue;
1124 } else {
1125 Session->ConfigData->SessionConfigData.TargetPort = (UINT16) Number;
1126 }
1127 } else {
1128 //
1129 // The string only contains the IPv4 address. Use the well-known port.
1130 //
1131 Session->ConfigData->SessionConfigData.TargetPort = ISCSI_WELL_KNOWN_PORT;
1132 }
1133 //
1134 // Update the target IP address.
1135 //
1136 if (Session->ConfigData->SessionConfigData.IpMode < IP_MODE_AUTOCONFIG) {
1137 IpMode = Session->ConfigData->SessionConfigData.IpMode;
1138 } else {
1139 IpMode = Session->ConfigData->AutoConfigureMode;
1140 }
1141
1142 Status = IScsiAsciiStrToIp (
1143 IpStr,
1144 IpMode,
1145 &Session->ConfigData->SessionConfigData.TargetIp
1146 );
1147
1148 if (EFI_ERROR (Status)) {
1149 continue;
1150 } else {
1151 break;
1152 }
1153 }
1154
1155 IScsiFreeKeyValueList (KeyValueList);
1156
1157 return Status;
1158 }
1159
1160
1161 /**
1162 The callback function to free the net buffer list.
1163
1164 @param[in] Arg The opaque parameter.
1165
1166 **/
1167 VOID
1168 EFIAPI
1169 IScsiFreeNbufList (
1170 VOID *Arg
1171 )
1172 {
1173 ASSERT (Arg != NULL);
1174
1175 NetbufFreeList ((LIST_ENTRY *) Arg);
1176 FreePool (Arg);
1177 }
1178
1179
1180 /**
1181 The callback function called in NetBufFree; it does nothing.
1182
1183 @param[in] Arg The opaque parameter.
1184
1185 **/
1186 VOID
1187 EFIAPI
1188 IScsiNbufExtFree (
1189 VOID *Arg
1190 )
1191 {
1192 }
1193
1194
1195 /**
1196 Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
1197 an optional data segment. The two parts will be put into two blocks of buffers in the
1198 net buffer. The digest check will be conducted in this function if needed and the digests
1199 will be trimmed from the PDU buffer.
1200
1201 @param[in] Conn The iSCSI connection to receive data from.
1202 @param[out] Pdu The received iSCSI pdu.
1203 @param[in] Context The context used to describe information on the caller provided
1204 buffer to receive data segment of the iSCSI pdu. It is optional.
1205 @param[in] HeaderDigest Whether there will be header digest received.
1206 @param[in] DataDigest Whether there will be data digest.
1207 @param[in] TimeoutEvent The timeout event. It is optional.
1208
1209 @retval EFI_SUCCESS An iSCSI pdu is received.
1210 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1211 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1212 @retval Others Other errors as indicated.
1213
1214 **/
1215 EFI_STATUS
1216 IScsiReceivePdu (
1217 IN ISCSI_CONNECTION *Conn,
1218 OUT NET_BUF **Pdu,
1219 IN ISCSI_IN_BUFFER_CONTEXT *Context, OPTIONAL
1220 IN BOOLEAN HeaderDigest,
1221 IN BOOLEAN DataDigest,
1222 IN EFI_EVENT TimeoutEvent OPTIONAL
1223 )
1224 {
1225 LIST_ENTRY *NbufList;
1226 UINT32 Len;
1227 NET_BUF *PduHdr;
1228 UINT8 *Header;
1229 EFI_STATUS Status;
1230 UINT32 PadLen;
1231 UINT32 InDataOffset;
1232 NET_FRAGMENT Fragment[2];
1233 UINT32 FragmentCount;
1234 NET_BUF *DataSeg;
1235 UINT32 PadAndCRC32[2];
1236
1237 NbufList = AllocatePool (sizeof (LIST_ENTRY));
1238 if (NbufList == NULL) {
1239 return EFI_OUT_OF_RESOURCES;
1240 }
1241
1242 InitializeListHead (NbufList);
1243
1244 //
1245 // The header digest will be received together with the PDU header, if exists.
1246 //
1247 Len = sizeof (ISCSI_BASIC_HEADER) + (HeaderDigest ? sizeof (UINT32) : 0);
1248 PduHdr = NetbufAlloc (Len);
1249 if (PduHdr == NULL) {
1250 Status = EFI_OUT_OF_RESOURCES;
1251 goto ON_EXIT;
1252 }
1253
1254 Header = NetbufAllocSpace (PduHdr, Len, NET_BUF_TAIL);
1255 if (Header == NULL) {
1256 Status = EFI_OUT_OF_RESOURCES;
1257 goto ON_EXIT;
1258 }
1259 InsertTailList (NbufList, &PduHdr->List);
1260
1261 //
1262 // First step, receive the BHS of the PDU.
1263 //
1264 Status = TcpIoReceive (&Conn->TcpIo, PduHdr, FALSE, TimeoutEvent);
1265
1266 if (EFI_ERROR (Status)) {
1267 goto ON_EXIT;
1268 }
1269
1270 if (HeaderDigest) {
1271 //
1272 // TODO: check the header-digest.
1273 //
1274 //
1275 // Trim off the digest.
1276 //
1277 NetbufTrim (PduHdr, sizeof (UINT32), NET_BUF_TAIL);
1278 }
1279
1280 Len = ISCSI_GET_DATASEG_LEN (Header);
1281 if (Len == 0) {
1282 //
1283 // No data segment.
1284 //
1285 goto FORM_PDU;
1286 }
1287 //
1288 // Get the length of the padding bytes of the data segment.
1289 //
1290 PadLen = ISCSI_GET_PAD_LEN (Len);
1291
1292 switch (ISCSI_GET_OPCODE (Header)) {
1293 case ISCSI_OPCODE_SCSI_DATA_IN:
1294 //
1295 // To reduce memory copy overhead, try to use the buffer described by Context
1296 // if the PDU is an iSCSI SCSI data.
1297 //
1298 InDataOffset = ISCSI_GET_BUFFER_OFFSET (Header);
1299 if ((Context == NULL) || ((InDataOffset + Len) > Context->InDataLen)) {
1300 Status = EFI_PROTOCOL_ERROR;
1301 goto ON_EXIT;
1302 }
1303
1304 Fragment[0].Len = Len;
1305 Fragment[0].Bulk = Context->InData + InDataOffset;
1306
1307 if (DataDigest || (PadLen != 0)) {
1308 //
1309 // The data segment is padded. Use two fragments to receive it:
1310 // the first to receive the useful data; the second to receive the padding.
1311 //
1312 Fragment[1].Len = PadLen + (DataDigest ? sizeof (UINT32) : 0);
1313 Fragment[1].Bulk = (UINT8 *)PadAndCRC32 + (4 - PadLen);
1314
1315 FragmentCount = 2;
1316 } else {
1317 FragmentCount = 1;
1318 }
1319
1320 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
1321 if (DataSeg == NULL) {
1322 Status = EFI_OUT_OF_RESOURCES;
1323 goto ON_EXIT;
1324 }
1325
1326 break;
1327
1328 case ISCSI_OPCODE_SCSI_RSP:
1329 case ISCSI_OPCODE_NOP_IN:
1330 case ISCSI_OPCODE_LOGIN_RSP:
1331 case ISCSI_OPCODE_TEXT_RSP:
1332 case ISCSI_OPCODE_ASYNC_MSG:
1333 case ISCSI_OPCODE_REJECT:
1334 case ISCSI_OPCODE_VENDOR_T0:
1335 case ISCSI_OPCODE_VENDOR_T1:
1336 case ISCSI_OPCODE_VENDOR_T2:
1337 //
1338 // Allocate buffer to receive the data segment.
1339 //
1340 Len += PadLen + (DataDigest ? sizeof (UINT32) : 0);
1341 DataSeg = NetbufAlloc (Len);
1342 if (DataSeg == NULL) {
1343 Status = EFI_OUT_OF_RESOURCES;
1344 goto ON_EXIT;
1345 }
1346
1347 NetbufAllocSpace (DataSeg, Len, NET_BUF_TAIL);
1348 break;
1349
1350 default:
1351 Status = EFI_PROTOCOL_ERROR;
1352 goto ON_EXIT;
1353 }
1354
1355 InsertTailList (NbufList, &DataSeg->List);
1356
1357 //
1358 // Receive the data segment with the data digest, if any.
1359 //
1360 Status = TcpIoReceive (&Conn->TcpIo, DataSeg, FALSE, TimeoutEvent);
1361
1362 if (EFI_ERROR (Status)) {
1363 goto ON_EXIT;
1364 }
1365
1366 if (DataDigest) {
1367 //
1368 // TODO: Check the data digest.
1369 //
1370 NetbufTrim (DataSeg, sizeof (UINT32), NET_BUF_TAIL);
1371 }
1372
1373 if (PadLen != 0) {
1374 //
1375 // Trim off the padding bytes in the data segment.
1376 //
1377 NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);
1378 }
1379
1380 FORM_PDU:
1381 //
1382 // Form the pdu from a list of pdu segments.
1383 //
1384 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
1385 if (*Pdu == NULL) {
1386 Status = EFI_OUT_OF_RESOURCES;
1387 }
1388
1389 ON_EXIT:
1390
1391 if (EFI_ERROR (Status)) {
1392 //
1393 // Free the Nbufs in this NbufList and the NbufList itself.
1394 //
1395 IScsiFreeNbufList (NbufList);
1396 }
1397
1398 return Status;
1399 }
1400
1401
1402 /**
1403 Check and get the result of the parameter negotiation.
1404
1405 @param[in, out] Conn The connection in iSCSI login.
1406
1407 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1408 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.
1409 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1410
1411 **/
1412 EFI_STATUS
1413 IScsiCheckOpParams (
1414 IN OUT ISCSI_CONNECTION *Conn
1415 )
1416 {
1417 EFI_STATUS Status;
1418 LIST_ENTRY *KeyValueList;
1419 CHAR8 *Data;
1420 UINT32 Len;
1421 ISCSI_SESSION *Session;
1422 CHAR8 *Value;
1423 UINTN NumericValue;
1424
1425 ASSERT (Conn->RspQue.BufNum != 0);
1426
1427 Session = Conn->Session;
1428
1429 Len = Conn->RspQue.BufSize;
1430 Data = AllocatePool (Len);
1431 if (Data == NULL) {
1432 return EFI_OUT_OF_RESOURCES;
1433 }
1434
1435 NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);
1436
1437 Status = EFI_PROTOCOL_ERROR;
1438
1439 //
1440 // Extract the Key-Value pairs into a list.
1441 //
1442 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1443 if (KeyValueList == NULL) {
1444 FreePool (Data);
1445 return Status;
1446 }
1447 //
1448 // HeaderDigest
1449 //
1450 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);
1451 if (Value == NULL) {
1452 goto ON_ERROR;
1453 }
1454
1455 if (AsciiStrCmp (Value, "CRC32") == 0) {
1456 if (Conn->HeaderDigest != IScsiDigestCRC32) {
1457 goto ON_ERROR;
1458 }
1459 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1460 Conn->HeaderDigest = IScsiDigestNone;
1461 } else {
1462 goto ON_ERROR;
1463 }
1464 //
1465 // DataDigest
1466 //
1467 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);
1468 if (Value == NULL) {
1469 goto ON_ERROR;
1470 }
1471
1472 if (AsciiStrCmp (Value, "CRC32") == 0) {
1473 if (Conn->DataDigest != IScsiDigestCRC32) {
1474 goto ON_ERROR;
1475 }
1476 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1477 Conn->DataDigest = IScsiDigestNone;
1478 } else {
1479 goto ON_ERROR;
1480 }
1481 //
1482 // ErrorRecoveryLevel: result fuction is Minimum.
1483 //
1484 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);
1485 if (Value == NULL) {
1486 goto ON_ERROR;
1487 }
1488
1489 NumericValue = IScsiNetNtoi (Value);
1490 if (NumericValue > 2) {
1491 goto ON_ERROR;
1492 }
1493
1494 Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);
1495
1496 //
1497 // InitialR2T: result function is OR.
1498 //
1499 if (!Session->InitialR2T) {
1500 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1501 if (Value == NULL) {
1502 goto ON_ERROR;
1503 }
1504
1505 Session->InitialR2T = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1506 }
1507
1508 //
1509 // ImmediateData: result function is AND.
1510 //
1511 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);
1512 if (Value == NULL) {
1513 goto ON_ERROR;
1514 }
1515
1516 Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0));
1517
1518 //
1519 // MaxRecvDataSegmentLength is declarative.
1520 //
1521 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);
1522 if (Value != NULL) {
1523 Conn->MaxRecvDataSegmentLength = (UINT32) IScsiNetNtoi (Value);
1524 }
1525 //
1526 // MaxBurstLength: result funtion is Mininum.
1527 //
1528 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);
1529 if (Value == NULL) {
1530 goto ON_ERROR;
1531 }
1532
1533 NumericValue = IScsiNetNtoi (Value);
1534 Session->MaxBurstLength = (UINT32) MIN (Session->MaxBurstLength, NumericValue);
1535
1536 //
1537 // FirstBurstLength: result function is Minimum. Irrelevant when InitialR2T=Yes and
1538 // ImmediateData=No.
1539 //
1540 if (!(Session->InitialR2T && !Session->ImmediateData)) {
1541 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1542 if (Value == NULL) {
1543 goto ON_ERROR;
1544 }
1545
1546 NumericValue = IScsiNetNtoi (Value);
1547 Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);
1548 }
1549
1550 //
1551 // MaxConnections: result function is Minimum.
1552 //
1553 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);
1554 if (Value == NULL) {
1555 goto ON_ERROR;
1556 }
1557
1558 NumericValue = IScsiNetNtoi (Value);
1559 if ((NumericValue == 0) || (NumericValue > 65535)) {
1560 goto ON_ERROR;
1561 }
1562
1563 Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);
1564
1565 //
1566 // DataPDUInOrder: result function is OR.
1567 //
1568 if (!Session->DataPDUInOrder) {
1569 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1570 if (Value == NULL) {
1571 goto ON_ERROR;
1572 }
1573
1574 Session->DataPDUInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1575 }
1576
1577 //
1578 // DataSequenceInorder: result function is OR.
1579 //
1580 if (!Session->DataSequenceInOrder) {
1581 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1582 if (Value == NULL) {
1583 goto ON_ERROR;
1584 }
1585
1586 Session->DataSequenceInOrder = (BOOLEAN) (AsciiStrCmp (Value, "Yes") == 0);
1587 }
1588
1589 //
1590 // DefaultTime2Wait: result function is Maximum.
1591 //
1592 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);
1593 if (Value == NULL) {
1594 goto ON_ERROR;
1595 }
1596
1597 NumericValue = IScsiNetNtoi (Value);
1598 if (NumericValue == 0) {
1599 Session->DefaultTime2Wait = 0;
1600 } else if (NumericValue > 3600) {
1601 goto ON_ERROR;
1602 } else {
1603 Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);
1604 }
1605 //
1606 // DefaultTime2Retain: result function is Minimum.
1607 //
1608 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);
1609 if (Value == NULL) {
1610 goto ON_ERROR;
1611 }
1612
1613 NumericValue = IScsiNetNtoi (Value);
1614 if (NumericValue == 0) {
1615 Session->DefaultTime2Retain = 0;
1616 } else if (NumericValue > 3600) {
1617 goto ON_ERROR;
1618 } else {
1619 Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);
1620 }
1621 //
1622 // MaxOutstandingR2T: result function is Minimum.
1623 //
1624 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);
1625 if (Value == NULL) {
1626 goto ON_ERROR;
1627 }
1628
1629 NumericValue = IScsiNetNtoi (Value);
1630 if ((NumericValue == 0) || (NumericValue > 65535)) {
1631 goto ON_ERROR;
1632 }
1633
1634 Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);
1635
1636 //
1637 // Remove declarative key-value pairs, if any.
1638 //
1639 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);
1640 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);
1641 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);
1642
1643
1644 //
1645 // Remove the key-value that may not needed for result function is OR.
1646 //
1647 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1648 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1649 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1650
1651 //
1652 // Remove irrelevant parameter, if any.
1653 //
1654 if (Session->InitialR2T && !Session->ImmediateData) {
1655 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1656 }
1657
1658 if (IsListEmpty (KeyValueList)) {
1659 //
1660 // Succeed if no more keys in the list.
1661 //
1662 Status = EFI_SUCCESS;
1663 }
1664
1665 ON_ERROR:
1666
1667 IScsiFreeKeyValueList (KeyValueList);
1668
1669 FreePool (Data);
1670
1671 return Status;
1672 }
1673
1674
1675 /**
1676 Fill the operational parameters.
1677
1678 @param[in] Conn The connection in iSCSI login.
1679 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1680
1681 **/
1682 VOID
1683 IScsiFillOpParams (
1684 IN ISCSI_CONNECTION *Conn,
1685 IN OUT NET_BUF *Pdu
1686 )
1687 {
1688 ISCSI_SESSION *Session;
1689 CHAR8 Value[256];
1690
1691 Session = Conn->Session;
1692
1693 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");
1694 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);
1695
1696 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == IScsiDigestCRC32) ? "None,CRC32" : "None");
1697 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);
1698
1699 AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);
1700 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);
1701
1702 AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");
1703 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);
1704
1705 AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");
1706 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);
1707
1708 AsciiSPrint (Value, sizeof (Value), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP);
1709 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);
1710
1711 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);
1712 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);
1713
1714 AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);
1715 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);
1716
1717 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);
1718 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);
1719
1720 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");
1721 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);
1722
1723 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");
1724 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);
1725
1726 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);
1727 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);
1728
1729 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);
1730 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);
1731
1732 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);
1733 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);
1734 }
1735
1736
1737 /**
1738 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1739
1740 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1741 @param[in] Len The length of the last segment in the PDU.
1742
1743 @retval EFI_SUCCESS The segment is padded or there is no need to pad it.
1744 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1745 padding bytes.
1746 **/
1747 EFI_STATUS
1748 IScsiPadSegment (
1749 IN OUT NET_BUF *Pdu,
1750 IN UINT32 Len
1751 )
1752 {
1753 UINT32 PadLen;
1754 UINT8 *Data;
1755
1756 PadLen = ISCSI_GET_PAD_LEN (Len);
1757
1758 if (PadLen != 0) {
1759 Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);
1760 if (Data == NULL) {
1761 return EFI_OUT_OF_RESOURCES;
1762 }
1763
1764 ZeroMem (Data, PadLen);
1765 }
1766
1767 return EFI_SUCCESS;
1768 }
1769
1770
1771 /**
1772 Build a key-value list from the data segment.
1773
1774 @param[in] Data The data segment containing the key-value pairs.
1775 @param[in] Len Length of the data segment.
1776
1777 @return The key-value list.
1778 @retval NULL Other errors as indicated.
1779
1780 **/
1781 LIST_ENTRY *
1782 IScsiBuildKeyValueList (
1783 IN CHAR8 *Data,
1784 IN UINT32 Len
1785 )
1786 {
1787 LIST_ENTRY *ListHead;
1788 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1789
1790 ListHead = AllocatePool (sizeof (LIST_ENTRY));
1791 if (ListHead == NULL) {
1792 return NULL;
1793 }
1794
1795 InitializeListHead (ListHead);
1796
1797 while (Len > 0) {
1798 KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));
1799 if (KeyValuePair == NULL) {
1800 goto ON_ERROR;
1801 }
1802
1803 InitializeListHead (&KeyValuePair->List);
1804
1805 KeyValuePair->Key = Data;
1806
1807 while ((Len > 0) && (*Data != '=')) {
1808 Len--;
1809 Data++;
1810 }
1811
1812 if (*Data == '=') {
1813 *Data = '\0';
1814
1815 Data++;
1816 Len--;
1817 } else {
1818 FreePool (KeyValuePair);
1819 goto ON_ERROR;
1820 }
1821
1822 KeyValuePair->Value = Data;
1823
1824 InsertTailList (ListHead, &KeyValuePair->List);;
1825
1826 Data += AsciiStrLen (KeyValuePair->Value) + 1;
1827 Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;
1828 }
1829
1830 return ListHead;
1831
1832 ON_ERROR:
1833
1834 IScsiFreeKeyValueList (ListHead);
1835
1836 return NULL;
1837 }
1838
1839
1840 /**
1841 Get the value string by the key name from the key-value list. If found,
1842 the key-value entry will be removed from the list.
1843
1844 @param[in, out] KeyValueList The key-value list.
1845 @param[in] Key The key name to find.
1846
1847 @return The value string.
1848 @retval NULL The key value pair cannot be found.
1849
1850 **/
1851 CHAR8 *
1852 IScsiGetValueByKeyFromList (
1853 IN OUT LIST_ENTRY *KeyValueList,
1854 IN CHAR8 *Key
1855 )
1856 {
1857 LIST_ENTRY *Entry;
1858 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1859 CHAR8 *Value;
1860
1861 Value = NULL;
1862
1863 NET_LIST_FOR_EACH (Entry, KeyValueList) {
1864 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1865
1866 if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {
1867 Value = KeyValuePair->Value;
1868
1869 RemoveEntryList (&KeyValuePair->List);
1870 FreePool (KeyValuePair);
1871 break;
1872 }
1873 }
1874
1875 return Value;
1876 }
1877
1878
1879 /**
1880 Free the key-value list.
1881
1882 @param[in] KeyValueList The key-value list.
1883
1884 **/
1885 VOID
1886 IScsiFreeKeyValueList (
1887 IN LIST_ENTRY *KeyValueList
1888 )
1889 {
1890 LIST_ENTRY *Entry;
1891 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1892
1893 while (!IsListEmpty (KeyValueList)) {
1894 Entry = NetListRemoveHead (KeyValueList);
1895 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1896
1897 FreePool (KeyValuePair);
1898 }
1899
1900 FreePool (KeyValueList);
1901 }
1902
1903
1904 /**
1905 Normalize the iSCSI name according to RFC.
1906
1907 @param[in, out] Name The iSCSI name.
1908 @param[in] Len Length of the iSCSI name.
1909
1910 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1911 @retval EFI_PROTOCOL_ERROR The iSCSI name is malformatted or not in the IQN format.
1912
1913 **/
1914 EFI_STATUS
1915 IScsiNormalizeName (
1916 IN OUT CHAR8 *Name,
1917 IN UINTN Len
1918 )
1919 {
1920 UINTN Index;
1921
1922 for (Index = 0; Index < Len; Index++) {
1923 if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {
1924 //
1925 // Convert the upper-case characters to lower-case ones.
1926 //
1927 Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');
1928 }
1929
1930 if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&
1931 !NET_IS_DIGIT (Name[Index]) &&
1932 (Name[Index] != '-') &&
1933 (Name[Index] != '.') &&
1934 (Name[Index] != ':')
1935 ) {
1936 //
1937 // ASCII dash, dot, colon lower-case characters and digit characters
1938 // are allowed.
1939 //
1940 return EFI_PROTOCOL_ERROR;
1941 }
1942 }
1943
1944 if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {
1945 //
1946 // Only IQN format is accepted now.
1947 //
1948 return EFI_PROTOCOL_ERROR;
1949 }
1950
1951 return EFI_SUCCESS;
1952 }
1953
1954
1955 /**
1956 Create an iSCSI task control block.
1957
1958 @param[in] Conn The connection on which the task control block will be created.
1959 @param[out] Tcb The newly created task control block.
1960
1961 @retval EFI_SUCCESS The task control block is created.
1962 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1963 @retval EFI_NOT_READY The target cannot accept new commands.
1964
1965 **/
1966 EFI_STATUS
1967 IScsiNewTcb (
1968 IN ISCSI_CONNECTION *Conn,
1969 OUT ISCSI_TCB **Tcb
1970 )
1971 {
1972 ISCSI_SESSION *Session;
1973 ISCSI_TCB *NewTcb;
1974
1975 ASSERT (Tcb != NULL);
1976
1977 Session = Conn->Session;
1978
1979 if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {
1980 return EFI_NOT_READY;
1981 }
1982
1983 NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));
1984 if (NewTcb == NULL) {
1985 return EFI_OUT_OF_RESOURCES;
1986 }
1987
1988 InitializeListHead (&NewTcb->Link);
1989
1990 NewTcb->SoFarInOrder = TRUE;
1991 NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;
1992 NewTcb->CmdSN = Session->CmdSN;
1993 NewTcb->Conn = Conn;
1994
1995 InsertTailList (&Session->TcbList, &NewTcb->Link);
1996
1997 //
1998 // Advance the initiator task tag.
1999 //
2000 Session->InitiatorTaskTag++;
2001 Session->CmdSN++;
2002
2003 *Tcb = NewTcb;
2004
2005 return EFI_SUCCESS;
2006 }
2007
2008
2009 /**
2010 Delete the tcb from the connection and destroy it.
2011
2012 @param[in] Tcb The tcb to delete.
2013
2014 **/
2015 VOID
2016 IScsiDelTcb (
2017 IN ISCSI_TCB *Tcb
2018 )
2019 {
2020 RemoveEntryList (&Tcb->Link);
2021
2022 FreePool (Tcb);
2023 }
2024
2025
2026 /**
2027 Find the task control block by the initator task tag.
2028
2029 @param[in] TcbList The tcb list.
2030 @param[in] InitiatorTaskTag The initiator task tag.
2031
2032 @return The task control block found.
2033 @retval NULL The task control block cannot be found.
2034
2035 **/
2036 ISCSI_TCB *
2037 IScsiFindTcbByITT (
2038 IN LIST_ENTRY *TcbList,
2039 IN UINT32 InitiatorTaskTag
2040 )
2041 {
2042 ISCSI_TCB *Tcb;
2043 LIST_ENTRY *Entry;
2044
2045 Tcb = NULL;
2046
2047 NET_LIST_FOR_EACH (Entry, TcbList) {
2048 Tcb = NET_LIST_USER_STRUCT (Entry, ISCSI_TCB, Link);
2049
2050 if (Tcb->InitiatorTaskTag == InitiatorTaskTag) {
2051 break;
2052 }
2053 }
2054
2055 return Tcb;
2056 }
2057
2058
2059 /**
2060 Create a data segment, pad it, and calculate the CRC if needed.
2061
2062 @param[in] Data The data to fill into the data segment.
2063 @param[in] Len Length of the data.
2064 @param[in] DataDigest Whether to calculate CRC for this data segment.
2065
2066 @return The net buffer wrapping the data segment.
2067
2068 **/
2069 NET_BUF *
2070 IScsiNewDataSegment (
2071 IN UINT8 *Data,
2072 IN UINT32 Len,
2073 IN BOOLEAN DataDigest
2074 )
2075 {
2076 NET_FRAGMENT Fragment[2];
2077 UINT32 FragmentCount;
2078 UINT32 PadLen;
2079 NET_BUF *DataSeg;
2080
2081 Fragment[0].Len = Len;
2082 Fragment[0].Bulk = Data;
2083
2084 PadLen = ISCSI_GET_PAD_LEN (Len);
2085 if (PadLen != 0) {
2086 Fragment[1].Len = PadLen;
2087 Fragment[1].Bulk = (UINT8 *) &mDataSegPad;
2088
2089 FragmentCount = 2;
2090 } else {
2091 FragmentCount = 1;
2092 }
2093
2094 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
2095
2096 return DataSeg;
2097 }
2098
2099
2100 /**
2101 Create a iSCSI SCSI command PDU to encapsulate the command issued
2102 by SCSI through the EXT SCSI PASS THRU Protocol.
2103
2104 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
2105 @param[in] Lun The LUN.
2106 @param[in] Tcb The tcb assocated with this SCSI command.
2107
2108 @return The created iSCSI SCSI command PDU.
2109 @retval NULL Other errors as indicated.
2110
2111 **/
2112 NET_BUF *
2113 IScsiNewScsiCmdPdu (
2114 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
2115 IN UINT64 Lun,
2116 IN ISCSI_TCB *Tcb
2117 )
2118 {
2119 LIST_ENTRY *NbufList;
2120 NET_BUF *Pdu;
2121 NET_BUF *PduHeader;
2122 NET_BUF *DataSeg;
2123 SCSI_COMMAND *ScsiCmd;
2124 UINT8 AHSLength;
2125 UINT32 Length;
2126 ISCSI_ADDITIONAL_HEADER *Header;
2127 ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;
2128 ISCSI_SESSION *Session;
2129 UINT32 ImmediateDataLen;
2130
2131 AHSLength = 0;
2132
2133 if (Packet->DataDirection == DataBi) {
2134 //
2135 // Bidirectional Read/Write command, the bidirectional expected
2136 // read data length AHS is required.
2137 //
2138 AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);
2139 }
2140
2141 if (Packet->CdbLength > 16) {
2142 //
2143 // The CDB exceeds 16 bytes. An extended CDB AHS is required.
2144 //
2145 AHSLength = (UINT8) (AHSLength + ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER));
2146 }
2147
2148 Length = sizeof (SCSI_COMMAND) + AHSLength;
2149 PduHeader = NetbufAlloc (Length);
2150 if (PduHeader == NULL) {
2151 return NULL;
2152 }
2153
2154 ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);
2155 if (ScsiCmd == NULL) {
2156 NetbufFree (PduHeader);
2157 return NULL;
2158 }
2159 Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);
2160
2161 ZeroMem (ScsiCmd, Length);
2162
2163 ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);
2164 ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);
2165
2166 //
2167 // Set the READ/WRITE flags according to the IO type of this request.
2168 //
2169 switch (Packet->DataDirection) {
2170 case DataIn:
2171 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);
2172 ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);
2173 break;
2174
2175 case DataOut:
2176 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);
2177 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
2178 break;
2179
2180 case DataBi:
2181 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);
2182 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
2183
2184 //
2185 // Fill the bidirectional expected read data length AHS.
2186 //
2187 BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;
2188 Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);
2189
2190 BiExpReadDataLenAHS->Length = NTOHS (5);
2191 BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;
2192 BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);
2193
2194 break;
2195 }
2196
2197 ScsiCmd->TotalAHSLength = AHSLength;
2198 CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));
2199 ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);
2200 ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);
2201 ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);
2202
2203 CopyMem (ScsiCmd->Cdb, Packet->Cdb, sizeof (ScsiCmd->Cdb));
2204
2205 if (Packet->CdbLength > 16) {
2206 Header->Length = NTOHS ((UINT16) (Packet->CdbLength - 15));
2207 Header->Type = ISCSI_AHS_TYPE_EXT_CDB;
2208
2209 CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);
2210 }
2211
2212 Pdu = PduHeader;
2213 Session = Tcb->Conn->Session;
2214 ImmediateDataLen = 0;
2215
2216 if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {
2217 //
2218 // Send immediate data in this SCSI Command PDU. The length of the immeidate
2219 // data is the minimum of FirstBurstLength, the data length to be xfered, and
2220 // the MaxRecvdataSegmentLength on this connection.
2221 //
2222 ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);
2223 ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);
2224
2225 //
2226 // Update the data segment length in the PDU header.
2227 //
2228 ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);
2229
2230 //
2231 // Create the data segment.
2232 //
2233 DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);
2234 if (DataSeg == NULL) {
2235 NetbufFree (PduHeader);
2236 Pdu = NULL;
2237 goto ON_EXIT;
2238 }
2239
2240 NbufList = AllocatePool (sizeof (LIST_ENTRY));
2241 if (NbufList == NULL) {
2242 NetbufFree (PduHeader);
2243 NetbufFree (DataSeg);
2244
2245 Pdu = NULL;
2246 goto ON_EXIT;
2247 }
2248
2249 InitializeListHead (NbufList);
2250 InsertTailList (NbufList, &PduHeader->List);
2251 InsertTailList (NbufList, &DataSeg->List);
2252
2253 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2254 if (Pdu == NULL) {
2255 IScsiFreeNbufList (NbufList);
2256 }
2257 }
2258
2259 if (Session->InitialR2T ||
2260 (ImmediateDataLen == Session->FirstBurstLength) ||
2261 (ImmediateDataLen == Packet->OutTransferLength)
2262 ) {
2263 //
2264 // Unsolicited data out sequence is not allowed,
2265 // or FirstBustLength data is already sent out by immediate data,
2266 // or all the OUT data accompany this SCSI packet are sent as
2267 // immediate data. The final flag should be set on this SCSI Command
2268 // PDU.
2269 //
2270 ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);
2271 }
2272
2273 ON_EXIT:
2274
2275 return Pdu;
2276 }
2277
2278
2279 /**
2280 Create a new iSCSI SCSI Data Out PDU.
2281
2282 @param[in] Data The data to put into the Data Out PDU.
2283 @param[in] Len Length of the data.
2284 @param[in] DataSN The DataSN of the Data Out PDU.
2285 @param[in] Tcb The task control block of this Data Out PDU.
2286 @param[in] Lun The LUN.
2287
2288 @return The net buffer wrapping the Data Out PDU.
2289 @retval NULL Other errors as indicated.
2290
2291 **/
2292 NET_BUF *
2293 IScsiNewDataOutPdu (
2294 IN UINT8 *Data,
2295 IN UINT32 Len,
2296 IN UINT32 DataSN,
2297 IN ISCSI_TCB *Tcb,
2298 IN UINT64 Lun
2299 )
2300 {
2301 LIST_ENTRY *NbufList;
2302 NET_BUF *PduHdr;
2303 NET_BUF *DataSeg;
2304 NET_BUF *Pdu;
2305 ISCSI_SCSI_DATA_OUT *DataOutHdr;
2306 ISCSI_XFER_CONTEXT *XferContext;
2307
2308 NbufList = AllocatePool (sizeof (LIST_ENTRY));
2309 if (NbufList == NULL) {
2310 return NULL;
2311 }
2312
2313 InitializeListHead (NbufList);
2314
2315 //
2316 // Allocate memory for the BHS.
2317 //
2318 PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));
2319 if (PduHdr == NULL) {
2320 FreePool (NbufList);
2321 return NULL;
2322 }
2323 //
2324 // Insert the BHS into the buffer list.
2325 //
2326 InsertTailList (NbufList, &PduHdr->List);
2327
2328 DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);
2329 if (DataOutHdr == NULL) {
2330 IScsiFreeNbufList (NbufList);
2331 return NULL;
2332 }
2333 XferContext = &Tcb->XferContext;
2334
2335 ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));
2336
2337 //
2338 // Set the flags and fields of the Data Out PDU BHS.
2339 //
2340 ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);
2341 ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);
2342
2343 DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);
2344 DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);
2345 DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);
2346 DataOutHdr->DataSN = HTONL (DataSN);
2347 DataOutHdr->BufferOffset = HTONL (XferContext->Offset);
2348
2349 if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {
2350 CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));
2351 }
2352 //
2353 // Build the data segment for this Data Out PDU.
2354 //
2355 DataSeg = IScsiNewDataSegment (Data, Len, FALSE);
2356 if (DataSeg == NULL) {
2357 IScsiFreeNbufList (NbufList);
2358 return NULL;
2359 }
2360 //
2361 // Put the data segment into the buffer list and combine it with the BHS
2362 // into a full Data Out PDU.
2363 //
2364 InsertTailList (NbufList, &DataSeg->List);
2365 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2366 if (Pdu == NULL) {
2367 IScsiFreeNbufList (NbufList);
2368 }
2369
2370 return Pdu;
2371 }
2372
2373
2374 /**
2375 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2376
2377 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2378 @param[in] Tcb The task control block of the data to send out.
2379 @param[in] Lun The LUN the data will be sent to.
2380
2381 @return A list of net buffers with each of them wrapping an iSCSI SCSI Data Out PDU.
2382 @retval NULL Other errors as indicated.
2383
2384 **/
2385 LIST_ENTRY *
2386 IScsiGenerateDataOutPduSequence (
2387 IN UINT8 *Data,
2388 IN ISCSI_TCB *Tcb,
2389 IN UINT64 Lun
2390 )
2391 {
2392 LIST_ENTRY *PduList;
2393 UINT32 DataSN;
2394 UINT32 DataLen;
2395 NET_BUF *DataOutPdu;
2396 ISCSI_CONNECTION *Conn;
2397 ISCSI_XFER_CONTEXT *XferContext;
2398 UINT8 *DataOutPacket;
2399
2400 PduList = AllocatePool (sizeof (LIST_ENTRY));
2401 if (PduList == NULL) {
2402 return NULL;
2403 }
2404
2405 InitializeListHead (PduList);
2406
2407 DataSN = 0;
2408 Conn = Tcb->Conn;
2409 DataOutPdu = NULL;
2410 XferContext = &Tcb->XferContext;
2411
2412 while (XferContext->DesiredLength > 0) {
2413 //
2414 // Determine the length of data this Data Out PDU can carry.
2415 //
2416 DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);
2417
2418 //
2419 // Create a Data Out PDU.
2420 //
2421 DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);
2422 if (DataOutPdu == NULL) {
2423 IScsiFreeNbufList (PduList);
2424 PduList = NULL;
2425
2426 goto ON_EXIT;
2427 }
2428
2429 InsertTailList (PduList, &DataOutPdu->List);
2430
2431 //
2432 // Update the context and DataSN.
2433 //
2434 Data += DataLen;
2435 XferContext->Offset += DataLen;
2436 XferContext->DesiredLength -= DataLen;
2437 DataSN++;
2438 }
2439 //
2440 // Set the F bit for the last data out PDU in this sequence.
2441 //
2442 DataOutPacket = NetbufGetByte (DataOutPdu, 0, NULL);
2443 if (DataOutPacket == NULL) {
2444 IScsiFreeNbufList (PduList);
2445 PduList = NULL;
2446 goto ON_EXIT;
2447 }
2448
2449 ISCSI_SET_FLAG (DataOutPacket, ISCSI_BHS_FLAG_FINAL);
2450
2451 ON_EXIT:
2452
2453 return PduList;
2454 }
2455
2456 /**
2457 Send the Data in a sequence of Data Out PDUs one by one.
2458
2459 @param[in] Data The data to carry by Data Out PDUs.
2460 @param[in] Lun The LUN the data will be sent to.
2461 @param[in] Tcb The task control block.
2462
2463 @retval EFI_SUCCES The data is sent out to the LUN.
2464 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2465 @retval Others Other errors as indicated.
2466
2467 **/
2468 EFI_STATUS
2469 IScsiSendDataOutPduSequence (
2470 IN UINT8 *Data,
2471 IN UINT64 Lun,
2472 IN ISCSI_TCB *Tcb
2473 )
2474 {
2475 LIST_ENTRY *DataOutPduList;
2476 LIST_ENTRY *Entry;
2477 NET_BUF *Pdu;
2478 EFI_STATUS Status;
2479
2480 //
2481 // Generate the Data Out PDU sequence.
2482 //
2483 DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);
2484 if (DataOutPduList == NULL) {
2485 return EFI_OUT_OF_RESOURCES;
2486 }
2487
2488 Status = EFI_SUCCESS;
2489
2490 //
2491 // Send the Data Out PDU's one by one.
2492 //
2493 NET_LIST_FOR_EACH (Entry, DataOutPduList) {
2494 Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);
2495
2496 Status = TcpIoTransmit (&Tcb->Conn->TcpIo, Pdu);
2497
2498 if (EFI_ERROR (Status)) {
2499 break;
2500 }
2501 }
2502
2503 IScsiFreeNbufList (DataOutPduList);
2504
2505 return Status;
2506 }
2507
2508
2509 /**
2510 Process the received iSCSI SCSI Data In PDU.
2511
2512 @param[in] Pdu The Data In PDU received.
2513 @param[in] Tcb The task control block.
2514 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2515
2516 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2517 actions are taken.
2518 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2519 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2520 @retval Others Other errors as indicated.
2521
2522 **/
2523 EFI_STATUS
2524 IScsiOnDataInRcvd (
2525 IN NET_BUF *Pdu,
2526 IN ISCSI_TCB *Tcb,
2527 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2528 )
2529 {
2530 ISCSI_SCSI_DATA_IN *DataInHdr;
2531 EFI_STATUS Status;
2532
2533 DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);
2534 if (DataInHdr == NULL) {
2535 return EFI_PROTOCOL_ERROR;
2536 }
2537
2538 DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);
2539 DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);
2540 DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);
2541 DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);
2542
2543 //
2544 // Check the DataSN.
2545 //
2546 Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);
2547 if (EFI_ERROR (Status)) {
2548 return Status;
2549 }
2550
2551 if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2552 return EFI_PROTOCOL_ERROR;
2553 }
2554 //
2555 // Update the command related sequence numbers.
2556 //
2557 IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);
2558
2559 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {
2560 if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {
2561 //
2562 // The S bit is on but the F bit is off.
2563 //
2564 return EFI_PROTOCOL_ERROR;
2565 }
2566
2567 Tcb->StatusXferd = TRUE;
2568
2569 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {
2570 //
2571 // Underflow and Overflow are mutual flags.
2572 //
2573 return EFI_PROTOCOL_ERROR;
2574 }
2575 //
2576 // S bit is on, the StatSN is valid.
2577 //
2578 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));
2579 if (EFI_ERROR (Status)) {
2580 return Status;
2581 }
2582
2583 Packet->HostAdapterStatus = 0;
2584 Packet->TargetStatus = DataInHdr->Status;
2585
2586 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2587 Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);
2588 Status = EFI_BAD_BUFFER_SIZE;
2589 }
2590
2591 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2592 Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);
2593 }
2594 }
2595
2596 return Status;
2597 }
2598
2599
2600 /**
2601 Process the received iSCSI R2T PDU.
2602
2603 @param[in] Pdu The R2T PDU received.
2604 @param[in] Tcb The task control block.
2605 @param[in] Lun The Lun.
2606 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2607
2608 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2609 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2610 @retval Others Other errors as indicated.
2611
2612 **/
2613 EFI_STATUS
2614 IScsiOnR2TRcvd (
2615 IN NET_BUF *Pdu,
2616 IN ISCSI_TCB *Tcb,
2617 IN UINT64 Lun,
2618 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2619 )
2620 {
2621 ISCSI_READY_TO_TRANSFER *R2THdr;
2622 EFI_STATUS Status;
2623 ISCSI_XFER_CONTEXT *XferContext;
2624 UINT8 *Data;
2625
2626 R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);
2627 if (R2THdr == NULL) {
2628 return EFI_PROTOCOL_ERROR;
2629 }
2630
2631 R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);
2632 R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);
2633 R2THdr->StatSN = NTOHL (R2THdr->StatSN);
2634 R2THdr->R2TSeqNum = NTOHL (R2THdr->R2TSeqNum);
2635 R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);
2636 R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);
2637
2638 if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {
2639 return EFI_PROTOCOL_ERROR;;
2640 }
2641 //
2642 // Check the sequence number.
2643 //
2644 Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSeqNum);
2645 if (EFI_ERROR (Status)) {
2646 return Status;
2647 }
2648
2649 XferContext = &Tcb->XferContext;
2650 XferContext->TargetTransferTag = R2THdr->TargetTransferTag;
2651 XferContext->Offset = R2THdr->BufferOffset;
2652 XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;
2653
2654 if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||
2655 (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)
2656 ) {
2657 return EFI_PROTOCOL_ERROR;
2658 }
2659 //
2660 // Send the data solicited by this R2T.
2661 //
2662 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2663 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2664
2665 return Status;
2666 }
2667
2668
2669 /**
2670 Process the received iSCSI SCSI Response PDU.
2671
2672 @param[in] Pdu The Response PDU received.
2673 @param[in] Tcb The task control block.
2674 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2675
2676 @retval EFI_SUCCES The Response PDU is processed.
2677 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2678 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2679 @retval Others Other errors as indicated.
2680
2681 **/
2682 EFI_STATUS
2683 IScsiOnScsiRspRcvd (
2684 IN NET_BUF *Pdu,
2685 IN ISCSI_TCB *Tcb,
2686 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2687 )
2688 {
2689 SCSI_RESPONSE *ScsiRspHdr;
2690 ISCSI_SENSE_DATA *SenseData;
2691 EFI_STATUS Status;
2692 UINT32 DataSegLen;
2693
2694 ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);
2695 if (ScsiRspHdr == NULL) {
2696 return EFI_PROTOCOL_ERROR;
2697 }
2698
2699 ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);
2700 if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2701 return EFI_PROTOCOL_ERROR;
2702 }
2703
2704 ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);
2705
2706 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);
2707 if (EFI_ERROR (Status)) {
2708 return Status;
2709 }
2710
2711 ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);
2712 ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);
2713 IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);
2714
2715 Tcb->StatusXferd = TRUE;
2716
2717 Packet->HostAdapterStatus = ScsiRspHdr->Response;
2718 if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {
2719 return EFI_SUCCESS;
2720 }
2721
2722 Packet->TargetStatus = ScsiRspHdr->Status;
2723
2724 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||
2725 ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)
2726 ) {
2727 return EFI_PROTOCOL_ERROR;
2728 }
2729
2730 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {
2731 Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);
2732 Status = EFI_BAD_BUFFER_SIZE;
2733 }
2734
2735 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {
2736 Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);
2737 }
2738
2739 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2740 if (Packet->DataDirection == DataIn) {
2741 Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2742 } else {
2743 Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2744 }
2745
2746 Status = EFI_BAD_BUFFER_SIZE;
2747 }
2748
2749 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2750 if (Packet->DataDirection == DataIn) {
2751 Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2752 } else {
2753 Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2754 }
2755 }
2756
2757 DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);
2758 if (DataSegLen != 0) {
2759 SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);
2760 if (SenseData == NULL) {
2761 return EFI_PROTOCOL_ERROR;
2762 }
2763
2764 SenseData->Length = NTOHS (SenseData->Length);
2765
2766 Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);
2767 if (Packet->SenseDataLength != 0) {
2768 CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);
2769 }
2770 } else {
2771 Packet->SenseDataLength = 0;
2772 }
2773
2774 return Status;
2775 }
2776
2777
2778 /**
2779 Process the received NOP In PDU.
2780
2781 @param[in] Pdu The NOP In PDU received.
2782 @param[in] Tcb The task control block.
2783
2784 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2785 numbers are updated.
2786 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror occurred.
2787
2788 **/
2789 EFI_STATUS
2790 IScsiOnNopInRcvd (
2791 IN NET_BUF *Pdu,
2792 IN ISCSI_TCB *Tcb
2793 )
2794 {
2795 ISCSI_NOP_IN *NopInHdr;
2796 EFI_STATUS Status;
2797
2798 NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);
2799 if (NopInHdr == NULL) {
2800 return EFI_PROTOCOL_ERROR;
2801 }
2802
2803 NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);
2804 NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);
2805 NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);
2806
2807 if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {
2808 if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {
2809 return EFI_PROTOCOL_ERROR;
2810 }
2811 } else {
2812 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);
2813 if (EFI_ERROR (Status)) {
2814 return Status;
2815 }
2816 }
2817
2818 IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);
2819
2820 return EFI_SUCCESS;
2821 }
2822
2823
2824 /**
2825 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2826
2827 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2828 @param[in] Target The target ID.
2829 @param[in] Lun The LUN.
2830 @param[in, out] Packet The request packet containing IO request, SCSI command
2831 buffer and buffers to read/write.
2832
2833 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2834 the Packet.
2835 @retval EFI_DEVICE_ERROR Session state was not as required.
2836 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2837 @retval EFI_PROTOCOL_ERROR There is no such data in the net buffer.
2838 @retval EFI_NOT_READY The target can not accept new commands.
2839 @retval Others Other errors as indicated.
2840
2841 **/
2842 EFI_STATUS
2843 IScsiExecuteScsiCommand (
2844 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,
2845 IN UINT8 *Target,
2846 IN UINT64 Lun,
2847 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2848 )
2849 {
2850 EFI_STATUS Status;
2851 ISCSI_DRIVER_DATA *Private;
2852 ISCSI_SESSION *Session;
2853 EFI_EVENT TimeoutEvent;
2854 ISCSI_CONNECTION *Conn;
2855 ISCSI_TCB *Tcb;
2856 NET_BUF *Pdu;
2857 ISCSI_XFER_CONTEXT *XferContext;
2858 UINT8 *Data;
2859 ISCSI_IN_BUFFER_CONTEXT InBufferContext;
2860 UINT64 Timeout;
2861 UINT8 *PduHdr;
2862
2863 Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);
2864 Session = Private->Session;
2865 Status = EFI_SUCCESS;
2866 Tcb = NULL;
2867 TimeoutEvent = NULL;
2868 Timeout = 0;
2869
2870 if (Session->State != SESSION_STATE_LOGGED_IN) {
2871 Status = EFI_DEVICE_ERROR;
2872 goto ON_EXIT;
2873 }
2874
2875 Conn = NET_LIST_USER_STRUCT_S (
2876 Session->Conns.ForwardLink,
2877 ISCSI_CONNECTION,
2878 Link,
2879 ISCSI_CONNECTION_SIGNATURE
2880 );
2881
2882 if (Packet->Timeout != 0) {
2883 Timeout = MultU64x32 (Packet->Timeout, 4);
2884 }
2885
2886 Status = IScsiNewTcb (Conn, &Tcb);
2887 if (EFI_ERROR (Status)) {
2888 goto ON_EXIT;
2889 }
2890 //
2891 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2892 //
2893 Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);
2894 if (Pdu == NULL) {
2895 Status = EFI_OUT_OF_RESOURCES;
2896 goto ON_EXIT;
2897 }
2898
2899 XferContext = &Tcb->XferContext;
2900 PduHdr = NetbufGetByte (Pdu, 0, NULL);
2901 if (PduHdr == NULL) {
2902 Status = EFI_PROTOCOL_ERROR;
2903 NetbufFree (Pdu);
2904 goto ON_EXIT;
2905 }
2906 XferContext->Offset = ISCSI_GET_DATASEG_LEN (PduHdr);
2907
2908 //
2909 // Transmit the SCSI Command PDU.
2910 //
2911 Status = TcpIoTransmit (&Conn->TcpIo, Pdu);
2912
2913 NetbufFree (Pdu);
2914
2915 if (EFI_ERROR (Status)) {
2916 goto ON_EXIT;
2917 }
2918
2919 if (!Session->InitialR2T &&
2920 (XferContext->Offset < Session->FirstBurstLength) &&
2921 (XferContext->Offset < Packet->OutTransferLength)
2922 ) {
2923 //
2924 // Unsolicited Data-Out sequence is allowed. There is remaining SCSI
2925 // OUT data, and the limit of FirstBurstLength is not reached.
2926 //
2927 XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;
2928 XferContext->DesiredLength = MIN (
2929 Session->FirstBurstLength,
2930 Packet->OutTransferLength - XferContext->Offset
2931 );
2932
2933 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2934 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2935 if (EFI_ERROR (Status)) {
2936 goto ON_EXIT;
2937 }
2938 }
2939
2940 InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;
2941 InBufferContext.InDataLen = Packet->InTransferLength;
2942
2943 while (!Tcb->StatusXferd) {
2944 //
2945 // Start the timeout timer.
2946 //
2947 if (Timeout != 0) {
2948 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);
2949 if (EFI_ERROR (Status)) {
2950 goto ON_EXIT;
2951 }
2952
2953 TimeoutEvent = Conn->TimeoutEvent;
2954 }
2955
2956 //
2957 // Try to receive PDU from target.
2958 //
2959 Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);
2960 if (EFI_ERROR (Status)) {
2961 goto ON_EXIT;
2962 }
2963
2964 PduHdr = NetbufGetByte (Pdu, 0, NULL);
2965 if (PduHdr == NULL) {
2966 Status = EFI_PROTOCOL_ERROR;
2967 NetbufFree (Pdu);
2968 goto ON_EXIT;
2969 }
2970 switch (ISCSI_GET_OPCODE (PduHdr)) {
2971 case ISCSI_OPCODE_SCSI_DATA_IN:
2972 Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);
2973 break;
2974
2975 case ISCSI_OPCODE_R2T:
2976 Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);
2977 break;
2978
2979 case ISCSI_OPCODE_SCSI_RSP:
2980 Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);
2981 break;
2982
2983 case ISCSI_OPCODE_NOP_IN:
2984 Status = IScsiOnNopInRcvd (Pdu, Tcb);
2985 break;
2986
2987 case ISCSI_OPCODE_VENDOR_T0:
2988 case ISCSI_OPCODE_VENDOR_T1:
2989 case ISCSI_OPCODE_VENDOR_T2:
2990 //
2991 // These messages are vendor specific. Skip them.
2992 //
2993 break;
2994
2995 default:
2996 Status = EFI_PROTOCOL_ERROR;
2997 break;
2998 }
2999
3000 NetbufFree (Pdu);
3001
3002 if (EFI_ERROR (Status)) {
3003 break;
3004 }
3005 }
3006
3007 ON_EXIT:
3008
3009 if (TimeoutEvent != NULL) {
3010 gBS->SetTimer (TimeoutEvent, TimerCancel, 0);
3011 }
3012
3013 if (Tcb != NULL) {
3014 IScsiDelTcb (Tcb);
3015 }
3016
3017 return Status;
3018 }
3019
3020
3021 /**
3022 Reinstate the session on some error.
3023
3024 @param[in] Session The iSCSI session
3025
3026 @retval EFI_SUCCESS The session is reinstated from some error.
3027 @retval Other Reinstatement failed.
3028
3029 **/
3030 EFI_STATUS
3031 IScsiSessionReinstatement (
3032 IN ISCSI_SESSION *Session
3033 )
3034 {
3035 EFI_STATUS Status;
3036
3037 ASSERT (Session->State != SESSION_STATE_FREE);
3038
3039 //
3040 // Abort the session and re-init it.
3041 //
3042 IScsiSessionAbort (Session);
3043 IScsiSessionInit (Session, TRUE);
3044
3045 //
3046 // Login again.
3047 //
3048 Status = IScsiSessionLogin (Session);
3049
3050 return Status;
3051 }
3052
3053
3054 /**
3055 Initialize some session parameters before login.
3056
3057 @param[in, out] Session The iSCSI session.
3058 @param[in] Recovery Whether the request is from a fresh new start or recovery.
3059
3060 **/
3061 VOID
3062 IScsiSessionInit (
3063 IN OUT ISCSI_SESSION *Session,
3064 IN BOOLEAN Recovery
3065 )
3066 {
3067 if (!Recovery) {
3068 Session->Signature = ISCSI_SESSION_SIGNATURE;
3069 Session->State = SESSION_STATE_FREE;
3070
3071 InitializeListHead (&Session->Conns);
3072 InitializeListHead (&Session->TcbList);
3073 }
3074
3075 Session->Tsih = 0;
3076
3077 Session->CmdSN = 1;
3078 Session->InitiatorTaskTag = 1;
3079 Session->NextCid = 1;
3080
3081 Session->TargetPortalGroupTag = 0;
3082 Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;
3083 Session->InitialR2T = FALSE;
3084 Session->ImmediateData = TRUE;
3085 Session->MaxBurstLength = 262144;
3086 Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;
3087 Session->DefaultTime2Wait = 2;
3088 Session->DefaultTime2Retain = 20;
3089 Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;
3090 Session->DataPDUInOrder = TRUE;
3091 Session->DataSequenceInOrder = TRUE;
3092 Session->ErrorRecoveryLevel = 0;
3093 }
3094
3095
3096 /**
3097 Abort the iSCSI session. That is, reset all the connection(s), and free the
3098 resources.
3099
3100 @param[in, out] Session The iSCSI session.
3101
3102 **/
3103 VOID
3104 IScsiSessionAbort (
3105 IN OUT ISCSI_SESSION *Session
3106 )
3107 {
3108 ISCSI_CONNECTION *Conn;
3109 EFI_GUID *ProtocolGuid;
3110
3111 if (Session->State != SESSION_STATE_LOGGED_IN) {
3112 return ;
3113 }
3114
3115 ASSERT (!IsListEmpty (&Session->Conns));
3116
3117 while (!IsListEmpty (&Session->Conns)) {
3118 Conn = NET_LIST_USER_STRUCT_S (
3119 Session->Conns.ForwardLink,
3120 ISCSI_CONNECTION,
3121 Link,
3122 ISCSI_CONNECTION_SIGNATURE
3123 );
3124 if (!Conn->Ipv6Flag) {
3125 ProtocolGuid = &gEfiTcp4ProtocolGuid;
3126 } else {
3127 ProtocolGuid = &gEfiTcp6ProtocolGuid;
3128 }
3129
3130 gBS->CloseProtocol (
3131 Conn->TcpIo.Handle,
3132 ProtocolGuid,
3133 Session->Private->Image,
3134 Session->Private->ExtScsiPassThruHandle
3135 );
3136
3137 IScsiConnReset (Conn);
3138
3139 IScsiDetatchConnection (Conn);
3140 IScsiDestroyConnection (Conn);
3141 }
3142
3143 Session->State = SESSION_STATE_FAILED;
3144
3145 return ;
3146 }
EFI Development Kit II mirror for PVE