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