]> 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
1） delete unused parameter from IScsiCHAPOnRspReceived ()
[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 = 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 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 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, out] Conn The connection on which the iSCSI login response is received.
565 @param[in, out] 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 Other errors as indicated.
571 **/
572 EFI_STATUS
573 IScsiProcessLoginRsp (
574 IN OUT ISCSI_CONNECTION *Conn,
575 IN OUT 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);
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);
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, out] 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 Other errors as indicated.
780 **/
781 EFI_STATUS
782 IScsiUpdateTargetAddress (
783 IN OUT 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 Other errors as indicated.
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, out] Conn The connection in iSCSI login.
1095
1096 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1097 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
1098 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1099 **/
1100 EFI_STATUS
1101 IScsiCheckOpParams (
1102 IN OUT ISCSI_CONNECTION *Conn
1103 )
1104 {
1105 EFI_STATUS Status;
1106 LIST_ENTRY *KeyValueList;
1107 CHAR8 *Data;
1108 UINT32 Len;
1109 ISCSI_SESSION *Session;
1110 CHAR8 *Value;
1111 UINTN NumericValue;
1112
1113 ASSERT (Conn->RspQue.BufNum != 0);
1114
1115 Session = Conn->Session;
1116
1117 Len = Conn->RspQue.BufSize;
1118 Data = AllocatePool (Len);
1119 if (Data == NULL) {
1120 return EFI_OUT_OF_RESOURCES;
1121 }
1122
1123 NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);
1124
1125 Status = EFI_PROTOCOL_ERROR;
1126
1127 //
1128 // Extract the Key-Value pairs into a list.
1129 //
1130 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1131 if (KeyValueList == NULL) {
1132 gBS->FreePool (Data);
1133 return Status;
1134 }
1135 //
1136 // HeaderDigest
1137 //
1138 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);
1139 if (Value == NULL) {
1140 goto ON_ERROR;
1141 }
1142
1143 if (AsciiStrCmp (Value, "CRC32") == 0) {
1144 if (Conn->HeaderDigest != ISCSI_DIGEST_CRC32) {
1145 goto ON_ERROR;
1146 }
1147 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1148 Conn->HeaderDigest = ISCSI_DIGEST_NONE;
1149 } else {
1150 goto ON_ERROR;
1151 }
1152 //
1153 // DataDigest
1154 //
1155 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);
1156 if (Value == NULL) {
1157 goto ON_ERROR;
1158 }
1159
1160 if (AsciiStrCmp (Value, "CRC32") == 0) {
1161 if (Conn->DataDigest != ISCSI_DIGEST_CRC32) {
1162 goto ON_ERROR;
1163 }
1164 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1165 Conn->DataDigest = ISCSI_DIGEST_NONE;
1166 } else {
1167 goto ON_ERROR;
1168 }
1169 //
1170 // ErrorRecoveryLevel, result fuction is Minimum.
1171 //
1172 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);
1173 if (Value == NULL) {
1174 goto ON_ERROR;
1175 }
1176
1177 NumericValue = AsciiStrDecimalToUintn (Value);
1178 if (NumericValue > 2) {
1179 goto ON_ERROR;
1180 }
1181
1182 Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);
1183
1184 //
1185 // InitialR2T, result function is OR.
1186 //
1187 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1188 if (Value == NULL) {
1189 goto ON_ERROR;
1190 }
1191
1192 Session->InitialR2T = (BOOLEAN) (Session->InitialR2T || (AsciiStrCmp (Value, "Yes") == 0));
1193
1194 //
1195 // ImmediateData, result function is AND.
1196 //
1197 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);
1198 if (Value == NULL) {
1199 goto ON_ERROR;
1200 }
1201
1202 Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (AsciiStrCmp (Value, "Yes") == 0));
1203
1204 //
1205 // MaxRecvDataSegmentLength, result function is Mininum.
1206 //
1207 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);
1208 if (Value != NULL) {
1209 //
1210 // MaxRecvDataSegmentLength is declarative.
1211 //
1212 NumericValue = AsciiStrDecimalToUintn (Value);
1213
1214 Conn->MaxRecvDataSegmentLength = (UINT32) MIN (Conn->MaxRecvDataSegmentLength, NumericValue);
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 //
1231 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1232 if ((Value == NULL) && !(Session->InitialR2T && !Session->ImmediateData)) {
1233 goto ON_ERROR;
1234 }
1235
1236 NumericValue = AsciiStrDecimalToUintn (Value);
1237 Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);
1238
1239 //
1240 // MaxConnections, result function is Minimum.
1241 //
1242 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);
1243 if (Value == NULL) {
1244 goto ON_ERROR;
1245 }
1246
1247 NumericValue = AsciiStrDecimalToUintn (Value);
1248 if ((NumericValue == 0) || (NumericValue > 65535)) {
1249 goto ON_ERROR;
1250 }
1251
1252 Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);
1253
1254 //
1255 // DataPDUInOrder, result function is OR.
1256 //
1257 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1258 if (Value == NULL) {
1259 goto ON_ERROR;
1260 }
1261
1262 Session->DataPDUInOrder = (BOOLEAN) (Session->DataPDUInOrder || (AsciiStrCmp (Value, "Yes") == 0));
1263
1264 //
1265 // DataSequenceInorder, result function is OR.
1266 //
1267 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1268 if (Value == NULL) {
1269 goto ON_ERROR;
1270 }
1271
1272 Session->DataSequenceInOrder = (BOOLEAN) (Session->DataSequenceInOrder || (AsciiStrCmp (Value, "Yes") == 0));
1273
1274 //
1275 // DefaultTime2Wait, result function is Maximum.
1276 //
1277 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);
1278 if (Value == NULL) {
1279 goto ON_ERROR;
1280 }
1281
1282 NumericValue = AsciiStrDecimalToUintn (Value);
1283 if (NumericValue == 0) {
1284 Session->DefaultTime2Wait = 0;
1285 } else if (NumericValue > 3600) {
1286 goto ON_ERROR;
1287 } else {
1288 Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);
1289 }
1290 //
1291 // DefaultTime2Retain, result function is Minimum.
1292 //
1293 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);
1294 if (Value == NULL) {
1295 goto ON_ERROR;
1296 }
1297
1298 NumericValue = AsciiStrDecimalToUintn (Value);
1299 if (NumericValue == 0) {
1300 Session->DefaultTime2Retain = 0;
1301 } else if (NumericValue > 3600) {
1302 goto ON_ERROR;
1303 } else {
1304 Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);
1305 }
1306 //
1307 // MaxOutstandingR2T, result function is Minimum.
1308 //
1309 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);
1310 if (Value == NULL) {
1311 goto ON_ERROR;
1312 }
1313
1314 NumericValue = AsciiStrDecimalToUintn (Value);
1315 if ((NumericValue == 0) || (NumericValue > 65535)) {
1316 goto ON_ERROR;
1317 }
1318
1319 Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);
1320
1321 //
1322 // Remove declarative key-value paris if any.
1323 //
1324 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);
1325 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);
1326 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);
1327
1328 if (IsListEmpty (KeyValueList)) {
1329 //
1330 // Succeed if no more keys in the list.
1331 //
1332 Status = EFI_SUCCESS;
1333 }
1334
1335 ON_ERROR:
1336
1337 IScsiFreeKeyValueList (KeyValueList);
1338
1339 gBS->FreePool (Data);
1340
1341 return Status;
1342 }
1343
1344 /**
1345 Fill the oprational prameters.
1346
1347 @param[in] Conn The connection in iSCSI login.
1348 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1349
1350 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
1351 **/
1352 EFI_STATUS
1353 IScsiFillOpParams (
1354 IN ISCSI_CONNECTION *Conn,
1355 IN OUT NET_BUF *Pdu
1356 )
1357 {
1358 ISCSI_SESSION *Session;
1359 CHAR8 Value[256];
1360
1361 Session = Conn->Session;
1362
1363 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");
1364 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);
1365
1366 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");
1367 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);
1368
1369 AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);
1370 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);
1371
1372 AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");
1373 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);
1374
1375 AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");
1376 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);
1377
1378 AsciiSPrint (Value, sizeof (Value), "%d", Conn->MaxRecvDataSegmentLength);
1379 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);
1380
1381 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);
1382 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);
1383
1384 AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);
1385 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);
1386
1387 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);
1388 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);
1389
1390 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");
1391 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);
1392
1393 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");
1394 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);
1395
1396 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);
1397 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);
1398
1399 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);
1400 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);
1401
1402 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);
1403 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);
1404
1405 return EFI_SUCCESS;
1406 }
1407
1408 /**
1409 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1410
1411 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1412 @param[in] Len The length of the last semgnet in the PDU.
1413
1414 @retval EFI_SUCCESS The segment is padded or no need to pad it.
1415 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1416 padding bytes.
1417 **/
1418 EFI_STATUS
1419 IScsiPadSegment (
1420 IN OUT NET_BUF *Pdu,
1421 IN UINT32 Len
1422 )
1423 {
1424 UINT32 PadLen;
1425 UINT8 *Data;
1426
1427 PadLen = ISCSI_GET_PAD_LEN (Len);
1428
1429 if (PadLen != 0) {
1430 Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);
1431 if (Data == NULL) {
1432 return EFI_OUT_OF_RESOURCES;
1433 }
1434
1435 ZeroMem (Data, PadLen);
1436 }
1437
1438 return EFI_SUCCESS;
1439 }
1440
1441 /**
1442 Build a key-value list from the data segment.
1443
1444 @param[in] Data The data segment containing the key-value pairs.
1445 @param[in] Len Length of the data segment.
1446
1447 @return The key-value list.
1448 @retval NULL Other errors as indicated.
1449 **/
1450 LIST_ENTRY *
1451 IScsiBuildKeyValueList (
1452 IN CHAR8 *Data,
1453 IN UINT32 Len
1454 )
1455 {
1456 LIST_ENTRY *ListHead;
1457 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1458
1459 ListHead = AllocatePool (sizeof (LIST_ENTRY ));
1460 if (ListHead == NULL) {
1461 return NULL;
1462 }
1463
1464 InitializeListHead (ListHead);
1465
1466 while (Len > 0) {
1467 KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));
1468 if (KeyValuePair == NULL) {
1469 goto ON_ERROR;
1470 }
1471
1472 InitializeListHead (&KeyValuePair->List);
1473
1474 KeyValuePair->Key = Data;
1475
1476 while ((Len > 0) && (*Data != '=')) {
1477 Len--;
1478 Data++;
1479 }
1480
1481 if (*Data == '=') {
1482 *Data = '\0';
1483
1484 Data++;
1485 Len--;
1486 } else {
1487 gBS->FreePool (KeyValuePair);
1488 goto ON_ERROR;
1489 }
1490
1491 KeyValuePair->Value = Data;
1492
1493 InsertTailList (ListHead, &KeyValuePair->List);;
1494
1495 Data += AsciiStrLen (KeyValuePair->Value) + 1;
1496 Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;
1497 }
1498
1499 return ListHead;
1500
1501 ON_ERROR:
1502
1503 IScsiFreeKeyValueList (ListHead);
1504
1505 return NULL;
1506 }
1507
1508 /**
1509 Get the value string by the key name from the key-value list. If found,
1510 the key-value entry will be removed from the list.
1511
1512 @param[in, out] KeyValueList The key-value list.
1513 @param[in] Key The key name to find.
1514
1515 @return The value string.
1516 **/
1517 CHAR8 *
1518 IScsiGetValueByKeyFromList (
1519 IN OUT LIST_ENTRY *KeyValueList,
1520 IN CHAR8 *Key
1521 )
1522 {
1523 LIST_ENTRY *Entry;
1524 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1525 CHAR8 *Value;
1526
1527 Value = NULL;
1528
1529 NET_LIST_FOR_EACH (Entry, KeyValueList) {
1530 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1531
1532 if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {
1533 Value = KeyValuePair->Value;
1534
1535 RemoveEntryList (&KeyValuePair->List);
1536 gBS->FreePool (KeyValuePair);
1537 break;
1538 }
1539 }
1540
1541 return Value;
1542 }
1543
1544 /**
1545 Free the key-value list.
1546
1547 @param[in] KeyValueList The key-value list.
1548 **/
1549 VOID
1550 IScsiFreeKeyValueList (
1551 IN LIST_ENTRY *KeyValueList
1552 )
1553 {
1554 LIST_ENTRY *Entry;
1555 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1556
1557 while (!IsListEmpty (KeyValueList)) {
1558 Entry = NetListRemoveHead (KeyValueList);
1559 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1560
1561 gBS->FreePool (KeyValuePair);
1562 }
1563
1564 gBS->FreePool (KeyValueList);
1565 }
1566
1567 /**
1568 Normalize the iSCSI name according to RFC.
1569
1570 @param[in, out] Name The iSCSI name.
1571 @param[in] Len length of the iSCSI name.
1572
1573 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1574 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
1575 **/
1576 EFI_STATUS
1577 IScsiNormalizeName (
1578 IN OUT CHAR8 *Name,
1579 IN UINTN Len
1580 )
1581 {
1582 UINTN Index;
1583
1584 for (Index = 0; Index < Len; Index++) {
1585 if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {
1586 //
1587 // Convert the upper-case characters to lower-case ones
1588 //
1589 Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');
1590 }
1591
1592 if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&
1593 !NET_IS_DIGIT (Name[Index]) &&
1594 (Name[Index] != '-') &&
1595 (Name[Index] != '.') &&
1596 (Name[Index] != ':')
1597 ) {
1598 //
1599 // ASCII dash, dot, colon lower-case characters and digit characters
1600 // are allowed.
1601 //
1602 return EFI_PROTOCOL_ERROR;
1603 }
1604 }
1605
1606 if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {
1607 //
1608 // Only IQN format is accepted now.
1609 //
1610 return EFI_PROTOCOL_ERROR;
1611 }
1612
1613 return EFI_SUCCESS;
1614 }
1615
1616 /**
1617 Create an iSCSI task control block.
1618
1619 @param[in] Conn The connection on which the task control block will be created.
1620 @param[out] Tcb The newly created task control block.
1621
1622 @retval EFI_SUCCESS The task control block is created.
1623 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1624 @retval EFI_NOT_READY The target can not accept new commands.
1625 **/
1626 EFI_STATUS
1627 IScsiNewTcb (
1628 IN ISCSI_CONNECTION *Conn,
1629 OUT ISCSI_TCB **Tcb
1630 )
1631 {
1632 ISCSI_SESSION *Session;
1633 ISCSI_TCB *NewTcb;
1634
1635 ASSERT (Tcb != NULL);
1636
1637 Session = Conn->Session;
1638
1639 if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {
1640 return EFI_NOT_READY;
1641 }
1642
1643 NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));
1644 if (NewTcb == NULL) {
1645 return EFI_OUT_OF_RESOURCES;
1646 }
1647
1648 InitializeListHead (&NewTcb->Link);
1649
1650 NewTcb->SoFarInOrder = TRUE;
1651 NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;
1652 NewTcb->CmdSN = Session->CmdSN;
1653 NewTcb->Conn = Conn;
1654
1655 InsertTailList (&Session->TcbList, &NewTcb->Link);
1656
1657 //
1658 // Advance the initiator task tag.
1659 //
1660 Session->InitiatorTaskTag++;
1661 Session->CmdSN++;
1662
1663 *Tcb = NewTcb;
1664
1665 return EFI_SUCCESS;
1666 }
1667
1668 /**
1669 Delete the tcb from the connection and destroy it.
1670
1671 @param[in] Tcb The tcb to delete.
1672 **/
1673 VOID
1674 IScsiDelTcb (
1675 IN ISCSI_TCB *Tcb
1676 )
1677 {
1678 RemoveEntryList (&Tcb->Link);
1679
1680 gBS->FreePool (Tcb);
1681 }
1682
1683 /**
1684 Find the task control block by the initator task tag.
1685
1686 @param[in] TcbList The tcb list.
1687 @param[in] InitiatorTaskTag The initiator task tag.
1688
1689 @return The task control block found.
1690 **/
1691 ISCSI_TCB *
1692 IScsiFindTcbByITT (
1693 IN LIST_ENTRY *TcbList,
1694 IN UINT32 InitiatorTaskTag
1695 )
1696 {
1697 ISCSI_TCB *Tcb;
1698 LIST_ENTRY *Entry;
1699
1700 Tcb = NULL;
1701
1702 NET_LIST_FOR_EACH (Entry, TcbList) {
1703 Tcb = NET_LIST_USER_STRUCT (Entry, ISCSI_TCB, Link);
1704
1705 if (Tcb->InitiatorTaskTag == InitiatorTaskTag) {
1706 break;
1707 }
1708
1709 Tcb = NULL;
1710 }
1711
1712 return Tcb;
1713 }
1714
1715 /**
1716 Create a data segment, pad it and calculate the CRC if needed.
1717
1718 @param[in] Data The data to fill into the data segment.
1719 @param[in] Len Length of the data.
1720 @param[in] DataDigest Whether to calculate CRC for this data segment.
1721
1722 @return The net buffer wrapping the data segment.
1723 **/
1724 NET_BUF *
1725 IScsiNewDataSegment (
1726 IN UINT8 *Data,
1727 IN UINT32 Len,
1728 IN BOOLEAN DataDigest
1729 )
1730 {
1731 NET_FRAGMENT Fragment[2];
1732 UINT32 FragmentCount;
1733 UINT32 PadLen;
1734 NET_BUF *DataSeg;
1735
1736 Fragment[0].Len = Len;
1737 Fragment[0].Bulk = Data;
1738
1739 PadLen = ISCSI_GET_PAD_LEN (Len);
1740 if (PadLen != 0) {
1741 Fragment[1].Len = PadLen;
1742 Fragment[1].Bulk = (UINT8 *) &mDataSegPad;
1743
1744 FragmentCount = 2;
1745 } else {
1746 FragmentCount = 1;
1747 }
1748
1749 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
1750
1751 return DataSeg;
1752 }
1753
1754 /**
1755 Create a iSCSI SCSI command PDU to encapsulate the command issued
1756 by SCSI through the EXT SCSI PASS THRU Protocol.
1757
1758 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
1759 @param[in] Lun The LUN.
1760 @param[in] Tcb The tcb assocated with this SCSI command.
1761
1762 @return The created iSCSI SCSI command PDU.
1763 @retval NULL Other errors as indicated.
1764 **/
1765 NET_BUF *
1766 IScsiNewScsiCmdPdu (
1767 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
1768 IN UINT64 Lun,
1769 IN ISCSI_TCB *Tcb
1770 )
1771 {
1772 LIST_ENTRY *NbufList;
1773 NET_BUF *Pdu;
1774 NET_BUF *PduHeader;
1775 NET_BUF *DataSeg;
1776 SCSI_COMMAND *ScsiCmd;
1777 UINT8 AHSLength;
1778 UINT32 Length;
1779 ISCSI_ADDITIONAL_HEADER *Header;
1780 ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;
1781 ISCSI_SESSION *Session;
1782 UINT32 ImmediateDataLen;
1783
1784 AHSLength = 0;
1785
1786 if (Packet->DataDirection == DataBi) {
1787 //
1788 // Bi directional Read/Write command, the bidirectional expected
1789 // read data length AHS is required.
1790 //
1791 AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);
1792 }
1793
1794 if (Packet->CdbLength > 16) {
1795 //
1796 // The CDB exceeds 16 bytes, an extended CDB AHS is required.
1797 //
1798 AHSLength = (UINT8) (AHSLength + (ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER)));
1799 }
1800
1801 Length = sizeof (SCSI_COMMAND) + AHSLength;
1802 PduHeader = NetbufAlloc (Length);
1803 if (PduHeader == NULL) {
1804 return NULL;
1805 }
1806
1807 ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);
1808 Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);
1809
1810 ZeroMem (ScsiCmd, Length);
1811
1812 ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);
1813 ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);
1814
1815 //
1816 // Set the READ/WRITE flags according to the IO type of this request.
1817 //
1818 switch (Packet->DataDirection) {
1819 case DataIn:
1820 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);
1821 ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);
1822 break;
1823
1824 case DataOut:
1825 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);
1826 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
1827 break;
1828
1829 case DataBi:
1830 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);
1831 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
1832
1833 //
1834 // Fill the bidirectional expected read data length AHS.
1835 //
1836 BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;
1837 Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);
1838
1839 BiExpReadDataLenAHS->Length = NTOHS (5);
1840 BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;
1841 BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);
1842
1843 break;
1844 }
1845
1846 ScsiCmd->TotalAHSLength = AHSLength;
1847 CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));
1848 ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);
1849 ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);
1850 ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);
1851
1852 CopyMem (ScsiCmd->CDB, Packet->Cdb, sizeof (ScsiCmd->CDB));
1853
1854 if (Packet->CdbLength > 16) {
1855 Header->Length = NTOHS (Packet->CdbLength - 15);
1856 Header->Type = ISCSI_AHS_TYPE_EXT_CDB;
1857
1858 CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);
1859 }
1860
1861 Pdu = PduHeader;
1862 Session = Tcb->Conn->Session;
1863 ImmediateDataLen = 0;
1864
1865 if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {
1866 //
1867 // Send immediate data in this SCSI Command PDU. The length of the immeidate
1868 // data is the minimum of FirstBurstLength, the data length to be xfered and
1869 // the MaxRecvdataSegmentLength on this connection.
1870 //
1871 ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);
1872 ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);
1873
1874 //
1875 // Update the data segment length in the PDU header.
1876 //
1877 ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);
1878
1879 //
1880 // Create the data segment.
1881 //
1882 DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);
1883 if (DataSeg == NULL) {
1884 NetbufFree (PduHeader);
1885 Pdu = NULL;
1886 goto ON_EXIT;
1887 }
1888
1889 NbufList = AllocatePool (sizeof (LIST_ENTRY ));
1890 if (NbufList == NULL) {
1891 NetbufFree (PduHeader);
1892 NetbufFree (DataSeg);
1893
1894 Pdu = NULL;
1895 goto ON_EXIT;
1896 }
1897
1898 InitializeListHead (NbufList);
1899 InsertTailList (NbufList, &PduHeader->List);
1900 InsertTailList (NbufList, &DataSeg->List);
1901
1902 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
1903 if (Pdu == NULL) {
1904 IScsiFreeNbufList (NbufList);
1905 }
1906 }
1907
1908 if (Session->InitialR2T ||
1909 (ImmediateDataLen == Session->FirstBurstLength) ||
1910 (ImmediateDataLen == Packet->OutTransferLength)
1911 ) {
1912 //
1913 // Unsolicited data out sequence is not allowed,
1914 // or FirstBustLength data is already sent out by immediate data
1915 // or all the OUT data accompany this SCSI packet is sent as
1916 // immediate data, the final flag should be set on this SCSI Command
1917 // PDU.
1918 //
1919 ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);
1920 }
1921
1922 ON_EXIT:
1923
1924 return Pdu;
1925 }
1926
1927 /**
1928 Create a new iSCSI SCSI Data Out PDU.
1929
1930 @param[in] Data The data to put into the Data Out PDU.
1931 @param[in] Len Length of the data.
1932 @param[in] DataSN The DataSN of the Data Out PDU.
1933 @param[in] Tcb The task control block of this Data Out PDU.
1934 @param[in] Lun The LUN.
1935
1936 @return The net buffer wrapping the Data Out PDU.
1937 @retval NULL Other errors as indicated.
1938 **/
1939 NET_BUF *
1940 IScsiNewDataOutPdu (
1941 IN UINT8 *Data,
1942 IN UINT32 Len,
1943 IN UINT32 DataSN,
1944 IN ISCSI_TCB *Tcb,
1945 IN UINT64 Lun
1946 )
1947 {
1948 LIST_ENTRY *NbufList;
1949 NET_BUF *PduHdr;
1950 NET_BUF *DataSeg;
1951 NET_BUF *Pdu;
1952 ISCSI_SCSI_DATA_OUT *DataOutHdr;
1953 ISCSI_XFER_CONTEXT *XferContext;
1954
1955 NbufList = AllocatePool (sizeof (LIST_ENTRY ));
1956 if (NbufList == NULL) {
1957 return NULL;
1958 }
1959
1960 InitializeListHead (NbufList);
1961
1962 //
1963 // Allocate memory for the BHS.
1964 //
1965 PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));
1966 if (PduHdr == NULL) {
1967 gBS->FreePool (NbufList);
1968 return NULL;
1969 }
1970 //
1971 // Insert the BHS into the buffer list.
1972 //
1973 InsertTailList (NbufList, &PduHdr->List);
1974
1975 DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);
1976 XferContext = &Tcb->XferContext;
1977
1978 ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));
1979
1980 //
1981 // Set the flags and fields of the Data Out PDU BHS.
1982 //
1983 ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);
1984 ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);
1985
1986 DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);
1987 DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);
1988 DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);
1989 DataOutHdr->DataSN = HTONL (DataSN);
1990 DataOutHdr->BufferOffset = HTONL (XferContext->Offset);
1991
1992 if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {
1993 CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));
1994 }
1995 //
1996 // Build the data segment for this Data Out PDU.
1997 //
1998 DataSeg = IScsiNewDataSegment (Data, Len, FALSE);
1999 if (DataSeg == NULL) {
2000 IScsiFreeNbufList (NbufList);
2001 return NULL;
2002 }
2003 //
2004 // Put the data segment into the buffer list and combine it with the BHS
2005 // into a full Data Out PDU.
2006 //
2007 InsertTailList (NbufList, &DataSeg->List);
2008 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2009 if (Pdu == NULL) {
2010 IScsiFreeNbufList (NbufList);
2011 }
2012
2013 return Pdu;
2014 }
2015
2016 /**
2017 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2018
2019 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2020 @param[in] Tcb The task control block of the data to send out.
2021 @param[in] Lun The LUN the data will be sent to.
2022
2023 @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.
2024 @retval NULL Other errors as indicated.
2025 **/
2026 LIST_ENTRY *
2027 IScsiGenerateDataOutPduSequence (
2028 IN UINT8 *Data,
2029 IN ISCSI_TCB *Tcb,
2030 IN UINT64 Lun
2031 )
2032 {
2033 LIST_ENTRY *PduList;
2034 UINT32 DataSN;
2035 UINT32 DataLen;
2036 NET_BUF *DataOutPdu;
2037 ISCSI_CONNECTION *Conn;
2038 ISCSI_XFER_CONTEXT *XferContext;
2039
2040 PduList = AllocatePool (sizeof (LIST_ENTRY ));
2041 if (PduList == NULL) {
2042 return NULL;
2043 }
2044
2045 InitializeListHead (PduList);
2046
2047 DataSN = 0;
2048 Conn = Tcb->Conn;
2049 DataOutPdu = NULL;
2050 XferContext = &Tcb->XferContext;
2051
2052 while (XferContext->DesiredLength > 0) {
2053 //
2054 // Determine the length of data this Data Out PDU can carry.
2055 //
2056 DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);
2057
2058 //
2059 // Create a Data Out PDU.
2060 //
2061 DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);
2062 if (DataOutPdu == NULL) {
2063 IScsiFreeNbufList (PduList);
2064 PduList = NULL;
2065
2066 goto ON_EXIT;
2067 }
2068
2069 InsertTailList (PduList, &DataOutPdu->List);
2070
2071 //
2072 // Update the context and DataSN.
2073 //
2074 XferContext->Offset += DataLen;
2075 XferContext->DesiredLength -= DataLen;
2076 DataSN++;
2077 Data += DataLen;
2078 }
2079 //
2080 // Set the F bit for the last data out PDU in this sequence.
2081 //
2082 ISCSI_SET_FLAG (NetbufGetByte (DataOutPdu, 0, NULL), ISCSI_BHS_FLAG_FINAL);
2083
2084 ON_EXIT:
2085
2086 return PduList;
2087 }
2088
2089 /**
2090 Send the Data in a sequence of Data Out PDUs one by one.
2091
2092 @param[in] Data The data to carry by Data Out PDUs.
2093 @param[in] Lun The LUN the data will be sent to.
2094 @param[in] Tcb The task control block.
2095
2096 @retval EFI_SUCCES The data is sent out to the LUN.
2097 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2098 @retval Others Other errors as indicated.
2099 **/
2100 EFI_STATUS
2101 IScsiSendDataOutPduSequence (
2102 IN UINT8 *Data,
2103 IN UINT64 Lun,
2104 IN ISCSI_TCB *Tcb
2105 )
2106 {
2107 LIST_ENTRY *DataOutPduList;
2108 LIST_ENTRY *Entry;
2109 NET_BUF *Pdu;
2110 EFI_STATUS Status;
2111
2112 //
2113 // Generate the Data Out PDU sequence.
2114 //
2115 DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);
2116 if (DataOutPduList == NULL) {
2117 return EFI_OUT_OF_RESOURCES;
2118 }
2119
2120 Status = EFI_SUCCESS;
2121
2122 //
2123 // Send the Data Out PDU's one by one.
2124 //
2125 NET_LIST_FOR_EACH (Entry, DataOutPduList) {
2126 Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);
2127
2128 Status = Tcp4IoTransmit (&Tcb->Conn->Tcp4Io, Pdu);
2129 if (EFI_ERROR (Status)) {
2130 break;
2131 }
2132 }
2133
2134 IScsiFreeNbufList (DataOutPduList);
2135
2136 return Status;
2137 }
2138
2139 /**
2140 Process the received iSCSI SCSI Data In PDU.
2141
2142 @param[in] Pdu The Data In PDU received.
2143 @param[in] Tcb The task control block.
2144 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2145
2146 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2147 actions are taken.
2148 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2149 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2150 @retval Others Other errors as indicated.
2151 **/
2152 EFI_STATUS
2153 IScsiOnDataInRcvd (
2154 IN NET_BUF *Pdu,
2155 IN ISCSI_TCB *Tcb,
2156 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2157 )
2158 {
2159 ISCSI_SCSI_DATA_IN *DataInHdr;
2160 EFI_STATUS Status;
2161
2162 DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);
2163
2164 DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);
2165 DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);
2166 DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);
2167 DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);
2168
2169 //
2170 // Check the DataSN.
2171 //
2172 Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);
2173 if (EFI_ERROR (Status)) {
2174 return Status;
2175 }
2176
2177 if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2178 return EFI_PROTOCOL_ERROR;
2179 }
2180 //
2181 // Update the command related sequence numbers.
2182 //
2183 IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);
2184
2185 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {
2186 if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {
2187 //
2188 // The S bit is on but the F bit is off.
2189 //
2190 return EFI_PROTOCOL_ERROR;
2191 }
2192
2193 Tcb->StatusXferd = TRUE;
2194
2195 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {
2196 //
2197 // Underflow and Overflow are mutual flags.
2198 //
2199 return EFI_PROTOCOL_ERROR;
2200 }
2201 //
2202 // S bit is on, the StatSN is valid.
2203 //
2204 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));
2205 if (EFI_ERROR (Status)) {
2206 return Status;
2207 }
2208
2209 Packet->HostAdapterStatus = 0;
2210 Packet->TargetStatus = DataInHdr->Status;
2211
2212 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2213 Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);
2214 Status = EFI_BAD_BUFFER_SIZE;
2215 }
2216
2217 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2218 Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);
2219 }
2220 }
2221
2222 return Status;
2223 }
2224
2225 /**
2226 Process the received iSCSI R2T PDU.
2227
2228 @param[in] Pdu The R2T PDU received.
2229 @param[in] Tcb The task control block.
2230 @param[in] Lun The Lun.
2231 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2232
2233 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2234 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2235 @retval Others Other errors as indicated.
2236 **/
2237 EFI_STATUS
2238 IScsiOnR2TRcvd (
2239 IN NET_BUF *Pdu,
2240 IN ISCSI_TCB *Tcb,
2241 IN UINT64 Lun,
2242 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2243 )
2244 {
2245 ISCSI_READY_TO_TRANSFER *R2THdr;
2246 EFI_STATUS Status;
2247 ISCSI_XFER_CONTEXT *XferContext;
2248 UINT8 *Data;
2249
2250 R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);
2251
2252 R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);
2253 R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);
2254 R2THdr->StatSN = NTOHL (R2THdr->StatSN);
2255 R2THdr->R2TSN = NTOHL (R2THdr->R2TSN);
2256 R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);
2257 R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);
2258
2259 if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {
2260 return EFI_PROTOCOL_ERROR;;
2261 }
2262 //
2263 // Check the sequence number.
2264 //
2265 Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSN);
2266 if (EFI_ERROR (Status)) {
2267 return Status;
2268 }
2269
2270 XferContext = &Tcb->XferContext;
2271 XferContext->TargetTransferTag = R2THdr->TargetTransferTag;
2272 XferContext->Offset = R2THdr->BufferOffset;
2273 XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;
2274
2275 if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||
2276 (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)
2277 ) {
2278 return EFI_PROTOCOL_ERROR;
2279 }
2280 //
2281 // Send the data solicited by this R2T.
2282 //
2283 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2284 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2285
2286 return Status;
2287 }
2288
2289 /**
2290 Process the received iSCSI SCSI Response PDU.
2291
2292 @param[in] Pdu The Response PDU received.
2293 @param[in] Tcb The task control block.
2294 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2295
2296 @retval EFI_SUCCES The Response PDU is processed.
2297 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2298 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2299 @retval Others Other errors as indicated.
2300 **/
2301 EFI_STATUS
2302 IScsiOnScsiRspRcvd (
2303 IN NET_BUF *Pdu,
2304 IN ISCSI_TCB *Tcb,
2305 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2306 )
2307 {
2308 SCSI_RESPONSE *ScsiRspHdr;
2309 ISCSI_SENSE_DATA *SenseData;
2310 EFI_STATUS Status;
2311 UINT32 DataSegLen;
2312
2313 ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);
2314
2315 ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);
2316 if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2317 return EFI_PROTOCOL_ERROR;
2318 }
2319
2320 ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);
2321
2322 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);
2323 if (EFI_ERROR (Status)) {
2324 return Status;
2325 }
2326
2327 ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);
2328 ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);
2329 IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);
2330
2331 Tcb->StatusXferd = TRUE;
2332
2333 Packet->HostAdapterStatus = ScsiRspHdr->Response;
2334 if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {
2335 return EFI_SUCCESS;
2336 }
2337
2338 Packet->TargetStatus = ScsiRspHdr->Status;
2339
2340 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||
2341 ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)
2342 ) {
2343 return EFI_PROTOCOL_ERROR;
2344 }
2345
2346 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {
2347 Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);
2348 Status = EFI_BAD_BUFFER_SIZE;
2349 }
2350
2351 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {
2352 Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);
2353 }
2354
2355 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2356 if (Packet->DataDirection == DataIn) {
2357 Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2358 } else {
2359 Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2360 }
2361
2362 Status = EFI_BAD_BUFFER_SIZE;
2363 }
2364
2365 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2366 if (Packet->DataDirection == DataIn) {
2367 Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2368 } else {
2369 Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2370 }
2371 }
2372
2373 DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);
2374 if (DataSegLen != 0) {
2375 SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);
2376
2377 SenseData->Length = NTOHS (SenseData->Length);
2378
2379 Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);
2380 if (Packet->SenseDataLength != 0) {
2381 CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);
2382 }
2383 } else {
2384 Packet->SenseDataLength = 0;
2385 }
2386
2387 return Status;
2388 }
2389
2390 /**
2391 Process the received NOP In PDU.
2392
2393 @param[in] Pdu The NOP In PDU received.
2394 @param[in] Tcb The task control block.
2395
2396 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2397 numbers are updated.
2398 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2399 **/
2400 EFI_STATUS
2401 IScsiOnNopInRcvd (
2402 IN NET_BUF *Pdu,
2403 IN ISCSI_TCB *Tcb
2404 )
2405 {
2406 ISCSI_NOP_IN *NopInHdr;
2407 EFI_STATUS Status;
2408
2409 NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);
2410
2411 NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);
2412 NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);
2413 NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);
2414
2415 if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {
2416 if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {
2417 return EFI_PROTOCOL_ERROR;
2418 }
2419 } else {
2420 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);
2421 if (EFI_ERROR (Status)) {
2422 return Status;
2423 }
2424 }
2425
2426 IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);
2427
2428 return EFI_SUCCESS;
2429 }
2430
2431 /**
2432 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2433
2434 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2435 @param[in] Target The target ID.
2436 @param[in] Lun The LUN.
2437 @param[in, out] Packet The request packet containing IO request, SCSI command
2438 buffer and buffers to read/write.
2439
2440 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2441 the Packet.
2442 @retval EFI_DEVICE_ERROR Session state was not as required.
2443 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2444 @retval Others Other errors as indicated.
2445 **/
2446 EFI_STATUS
2447 IScsiExecuteScsiCommand (
2448 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,
2449 IN UINT8 *Target,
2450 IN UINT64 Lun,
2451 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2452 )
2453 {
2454 EFI_STATUS Status;
2455 ISCSI_DRIVER_DATA *Private;
2456 ISCSI_SESSION *Session;
2457 EFI_EVENT TimeoutEvent;
2458 ISCSI_CONNECTION *Conn;
2459 ISCSI_TCB *Tcb;
2460 NET_BUF *Pdu;
2461 ISCSI_XFER_CONTEXT *XferContext;
2462 UINT8 *Data;
2463 ISCSI_IN_BUFFER_CONTEXT InBufferContext;
2464 UINT64 Timeout;
2465 UINT8 *Buffer;
2466
2467 Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);
2468 Session = &Private->Session;
2469 Status = EFI_SUCCESS;
2470 Tcb = NULL;
2471 TimeoutEvent = NULL;
2472 Timeout = 0;
2473
2474 if (Session->State != SESSION_STATE_LOGGED_IN) {
2475 return EFI_DEVICE_ERROR;
2476 }
2477
2478 Conn = NET_LIST_USER_STRUCT_S (
2479 Session->Conns.ForwardLink,
2480 ISCSI_CONNECTION,
2481 Link,
2482 ISCSI_CONNECTION_SIGNATURE
2483 );
2484
2485 if (Packet->Timeout != 0) {
2486 Timeout = MultU64x32 (Packet->Timeout, 2);
2487 }
2488
2489 Status = IScsiNewTcb (Conn, &Tcb);
2490 if (EFI_ERROR (Status)) {
2491 goto ON_EXIT;
2492 }
2493 //
2494 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2495 //
2496 Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);
2497 if (Pdu == NULL) {
2498 Status = EFI_OUT_OF_RESOURCES;
2499 goto ON_EXIT;
2500 }
2501
2502 XferContext = &Tcb->XferContext;
2503 Buffer = NetbufGetByte (Pdu, 0, NULL);
2504 XferContext->Offset = ISCSI_GET_DATASEG_LEN (Buffer);
2505
2506 //
2507 // Transmit the SCSI Command PDU.
2508 //
2509 Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);
2510
2511 NetbufFree (Pdu);
2512
2513 if (EFI_ERROR (Status)) {
2514 goto ON_EXIT;
2515 }
2516
2517 if (!Session->InitialR2T &&
2518 (XferContext->Offset < Session->FirstBurstLength) &&
2519 (XferContext->Offset < Packet->OutTransferLength)
2520 ) {
2521 //
2522 // Unsolicited Data-Out sequence is allowed, there is remaining SCSI
2523 // OUT data and the limit of FirstBurstLength is not reached.
2524 //
2525 XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;
2526 XferContext->DesiredLength = MIN (
2527 Session->FirstBurstLength,
2528 Packet->OutTransferLength - XferContext->Offset
2529 );
2530
2531 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2532 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2533 if (EFI_ERROR (Status)) {
2534 goto ON_EXIT;
2535 }
2536 }
2537
2538 InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;
2539 InBufferContext.InDataLen = Packet->InTransferLength;
2540
2541 while (!Tcb->StatusXferd) {
2542 //
2543 // Start the timeout timer.
2544 //
2545 if (Timeout != 0) {
2546 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);
2547 if (EFI_ERROR (Status)) {
2548 goto ON_EXIT;
2549 }
2550 TimeoutEvent = Conn->TimeoutEvent;
2551 }
2552 //
2553 // try to receive PDU from target.
2554 //
2555 Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);
2556 if (EFI_ERROR (Status)) {
2557 goto ON_EXIT;
2558 }
2559
2560 switch (ISCSI_GET_OPCODE (NetbufGetByte (Pdu, 0, NULL))) {
2561 case ISCSI_OPCODE_SCSI_DATA_IN:
2562 Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);
2563 break;
2564
2565 case ISCSI_OPCODE_R2T:
2566 Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);
2567 break;
2568
2569 case ISCSI_OPCODE_SCSI_RSP:
2570 Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);
2571 break;
2572
2573 case ISCSI_OPCODE_NOP_IN:
2574 Status = IScsiOnNopInRcvd (Pdu, Tcb);
2575 break;
2576
2577 case ISCSI_OPCODE_VENDOR_T0:
2578 case ISCSI_OPCODE_VENDOR_T1:
2579 case ISCSI_OPCODE_VENDOR_T2:
2580 //
2581 // These messages are vendor specific, skip them.
2582 //
2583 break;
2584
2585 default:
2586 Status = EFI_PROTOCOL_ERROR;
2587 break;
2588 }
2589
2590 NetbufFree (Pdu);
2591
2592 if (EFI_ERROR (Status)) {
2593 break;
2594 }
2595 }
2596
2597 ON_EXIT:
2598
2599 if (TimeoutEvent != NULL) {
2600 gBS->SetTimer (TimeoutEvent, TimerCancel, 0);
2601 }
2602
2603 if (Tcb != NULL) {
2604 IScsiDelTcb (Tcb);
2605 }
2606
2607 if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) {
2608 //
2609 // Reinstate the session.
2610 //
2611 if (EFI_ERROR (IScsiSessionReinstatement (Private))) {
2612 Status = EFI_DEVICE_ERROR;
2613 }
2614 }
2615
2616 return Status;
2617 }
2618
2619 /**
2620 Reinstate the session on some error.
2621
2622 @param[in, out] Private The iSCSI driver data.
2623
2624 @retval EFI_SUCCES The session is reinstated from some error.
2625 @retval Other Reinstatement failed.
2626 **/
2627 EFI_STATUS
2628 IScsiSessionReinstatement (
2629 IN OUT ISCSI_DRIVER_DATA *Private
2630 )
2631 {
2632 ISCSI_SESSION *Session;
2633 EFI_STATUS Status;
2634
2635 Session = &Private->Session;
2636 ASSERT (Session->State == SESSION_STATE_LOGGED_IN);
2637
2638 //
2639 // Abort the session and re-init it.
2640 //
2641 IScsiSessionAbort (Session);
2642 IScsiSessionInit (Session, TRUE);
2643
2644 //
2645 // Login again.
2646 //
2647 Status = IScsiSessionLogin (Private);
2648
2649 return Status;
2650 }
2651
2652 /**
2653 Initialize some session parameters before login.
2654
2655 @param[in, out] Session The iSCSI session.
2656 @param[in] Recovery Whether the request is from a fresh new start or recovery.
2657 **/
2658 VOID
2659 IScsiSessionInit (
2660 IN OUT ISCSI_SESSION *Session,
2661 IN BOOLEAN Recovery
2662 )
2663 {
2664 UINT32 Random;
2665
2666 if (!Recovery) {
2667 Session->Signature = ISCSI_SESSION_SIGNATURE;
2668 Session->State = SESSION_STATE_FREE;
2669
2670 Random = NET_RANDOM (NetRandomInitSeed ());
2671
2672 Session->ISID[0] = ISID_BYTE_0;
2673 Session->ISID[1] = ISID_BYTE_1;
2674 Session->ISID[2] = ISID_BYTE_2;
2675 Session->ISID[3] = ISID_BYTE_3;
2676 Session->ISID[4] = (UINT8) Random;
2677 Session->ISID[5] = (UINT8) (Random >> 8);
2678
2679 InitializeListHead (&Session->Conns);
2680 InitializeListHead (&Session->TcbList);
2681 }
2682
2683 Session->TSIH = 0;
2684
2685 Session->CmdSN = 1;
2686 Session->InitiatorTaskTag = 1;
2687 Session->NextCID = 1;
2688
2689 Session->TargetPortalGroupTag = 0;
2690 Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;
2691 Session->InitialR2T = FALSE;
2692 Session->ImmediateData = TRUE;
2693 Session->MaxBurstLength = 262144;
2694 Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;
2695 Session->DefaultTime2Wait = 2;
2696 Session->DefaultTime2Retain = 20;
2697 Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;
2698 Session->DataPDUInOrder = TRUE;
2699 Session->DataSequenceInOrder = TRUE;
2700 Session->ErrorRecoveryLevel = 0;
2701 }
2702
2703 /**
2704 Abort the iSCSI session, that is, reset all the connection and free the
2705 resources.
2706
2707 @param[in, out] Session The iSCSI session.
2708
2709 @retval EFI_SUCCES The session is aborted.
2710 **/
2711 EFI_STATUS
2712 IScsiSessionAbort (
2713 IN OUT ISCSI_SESSION *Session
2714 )
2715 {
2716 ISCSI_DRIVER_DATA *Private;
2717 ISCSI_CONNECTION *Conn;
2718
2719 if (Session->State != SESSION_STATE_LOGGED_IN) {
2720 return EFI_SUCCESS;
2721 }
2722
2723 ASSERT (!IsListEmpty (&Session->Conns));
2724
2725 Private = ISCSI_DRIVER_DATA_FROM_SESSION (Session);
2726
2727 while (!IsListEmpty (&Session->Conns)) {
2728 Conn = NET_LIST_USER_STRUCT_S (
2729 Session->Conns.ForwardLink,
2730 ISCSI_CONNECTION,
2731 Link,
2732 ISCSI_CONNECTION_SIGNATURE
2733 );
2734
2735 gBS->CloseProtocol (
2736 Conn->Tcp4Io.Handle,
2737 &gEfiTcp4ProtocolGuid,
2738 Private->Image,
2739 Private->ExtScsiPassThruHandle
2740 );
2741
2742 IScsiConnReset (Conn);
2743
2744 IScsiDetatchConnection (Conn);
2745 IScsiDestroyConnection (Conn);
2746 }
2747
2748 Session->State = SESSION_STATE_FAILED;
2749
2750 return EFI_SUCCESS;
2751 }
EFI Development Kit II mirror for PVE