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