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