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