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


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