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


87c214cc69c3ba0295dcf3d72b58a481a31fb0df
[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiProto.c
1 /** @file
2 The implementation of iSCSI protocol based on RFC3720.
3
4 Copyright (c) 2004 - 2008, Intel Corporation.<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #include "IScsiImpl.h"
16
17 UINT32 mDataSegPad = 0;
18
19 /**
20 Attach the iSCSI connection to the iSCSI session.
21
22 @param[in, out] Session The iSCSI session.
23 @param[in, out] Conn The iSCSI connection.
24 **/
25 VOID
26 IScsiAttatchConnection (
27 IN OUT ISCSI_SESSION *Session,
28 IN OUT ISCSI_CONNECTION *Conn
29 )
30 {
31 InsertTailList (&Session->Conns, &Conn->Link);
32 Conn->Session = Session;
33 Session->NumConns++;
34 }
35
36 /**
37 Detach the iSCSI connection from the session it belongs to.
38
39 @param[in, out] Conn The iSCSI connection.
40 **/
41 VOID
42 IScsiDetatchConnection (
43 IN OUT ISCSI_CONNECTION *Conn
44 )
45 {
46 RemoveEntryList (&Conn->Link);
47 Conn->Session->NumConns--;
48 Conn->Session = NULL;
49 }
50
51 /**
52 Check the sequence number according to RFC3720.
53
54 @param[in, out] ExpSN The currently expected sequence number.
55 @param[in] NewSN The sequence number to check.
56
57 @retval EFI_SUCCESS The check passed and the ExpSN is increased.
58 @retval EFI_NOT_READY Response was sent due to a retransmission request.
59 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
60 **/
61 EFI_STATUS
62 IScsiCheckSN (
63 IN OUT UINT32 *ExpSN,
64 IN UINT32 NewSN
65 )
66 {
67 if (!ISCSI_SEQ_EQ (NewSN, *ExpSN)) {
68 if (ISCSI_SEQ_LT (NewSN, *ExpSN)) {
69 //
70 // Duplicate
71 //
72 return EFI_NOT_READY;
73 } else {
74 return EFI_PROTOCOL_ERROR;
75 }
76 } else {
77 //
78 // Advance the ExpSN
79 //
80 (*ExpSN)++;
81 return EFI_SUCCESS;
82 }
83 }
84
85 /**
86 Update the sequence numbers for the iSCSI command.
87
88 @param[in, out] Session The iSCSI session.
89 @param[in] MaxCmdSN Maximum CmdSN from the target.
90 @param[in] ExpCmdSN Next expected CmdSN from the target.
91 **/
92 VOID
93 IScsiUpdateCmdSN (
94 IN OUT ISCSI_SESSION *Session,
95 IN UINT32 MaxCmdSN,
96 IN UINT32 ExpCmdSN
97 )
98 {
99 if (ISCSI_SEQ_LT (MaxCmdSN, ExpCmdSN - 1)) {
100 return ;
101 }
102
103 if (ISCSI_SEQ_GT (MaxCmdSN, Session->MaxCmdSN)) {
104 Session->MaxCmdSN = MaxCmdSN;
105 }
106
107 if (ISCSI_SEQ_GT (ExpCmdSN, Session->ExpCmdSN)) {
108 Session->ExpCmdSN = ExpCmdSN;
109 }
110 }
111
112 /**
113 This function does the iSCSI connection login.
114
115 @param[in, out] Conn The iSCSI connection to login.
116
117 @retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.
118 @retval EFI_TIMEOUT Timeout happened during the login procedure.
119 @retval Others Other errors as indicated.
120 **/
121 EFI_STATUS
122 IScsiConnLogin (
123 IN OUT ISCSI_CONNECTION *Conn
124 )
125 {
126 EFI_STATUS Status;
127
128 //
129 // Start the timer, wait 16 seconds to establish the TCP connection.
130 //
131 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, 16 * TICKS_PER_SECOND);
132 if (EFI_ERROR (Status)) {
133 return Status;
134 }
135 //
136 // try to establish the tcp connection
137 //
138 Status = Tcp4IoConnect (&Conn->Tcp4Io, Conn->TimeoutEvent);
139 if (EFI_ERROR (Status)) {
140 return Status;
141 }
142
143 gBS->SetTimer (Conn->TimeoutEvent, TimerCancel, 0);
144 Conn->State = CONN_STATE_IN_LOGIN;
145
146 //
147 // connection is established, start the iSCSI Login
148 //
149 do {
150 Status = IScsiSendLoginReq (Conn);
151 if (EFI_ERROR (Status)) {
152 break;
153 }
154
155 Status = IScsiReceiveLoginRsp (Conn);
156 if (EFI_ERROR (Status)) {
157 break;
158 }
159 } while (Conn->CurrentStage != ISCSI_FULL_FEATURE_PHASE);
160
161 return Status;
162 }
163
164 /**
165 Reset the iSCSI connection.
166
167 @param[in, out] Conn The iSCSI connection to reset.
168 **/
169 VOID
170 IScsiConnReset (
171 IN OUT ISCSI_CONNECTION *Conn
172 )
173 {
174 Tcp4IoReset (&Conn->Tcp4Io);
175 }
176
177 /**
178 Create a TCP connection for the iSCSI session.
179
180 @param[in] Private The iSCSI driver data.
181 @param[in] Session Maximum CmdSN from the target.
182
183 @return The newly created iSCSI connection.
184 **/
185 ISCSI_CONNECTION *
186 IScsiCreateConnection (
187 IN ISCSI_DRIVER_DATA *Private,
188 IN ISCSI_SESSION *Session
189 )
190 {
191 ISCSI_CONNECTION *Conn;
192 TCP4_IO_CONFIG_DATA Tcp4IoConfig;
193 EFI_STATUS Status;
194
195 Conn = AllocatePool (sizeof (ISCSI_CONNECTION));
196 if (Conn == NULL) {
197 return NULL;
198 }
199
200 Conn->Signature = ISCSI_CONNECTION_SIGNATURE;
201 Conn->State = CONN_STATE_FREE;
202 Conn->CurrentStage = ISCSI_SECURITY_NEGOTIATION;
203 Conn->NextStage = ISCSI_LOGIN_OPERATIONAL_NEGOTIATION;
204 Conn->CHAPStep = ISCSI_CHAP_INITIAL;
205 Conn->ExpStatSN = 0;
206 Conn->PartialReqSent = FALSE;
207 Conn->PartialRspRcvd = FALSE;
208 Conn->Cid = Session->NextCid++;
209
210 Status = gBS->CreateEvent (
211 EVT_TIMER,
212 TPL_CALLBACK,
213 NULL,
214 NULL,
215 &Conn->TimeoutEvent
216 );
217 if (EFI_ERROR (Status)) {
218 gBS->FreePool (Conn);
219 return NULL;
220 }
221
222 NetbufQueInit (&Conn->RspQue);
223
224 //
225 // set the default connection-only parameters
226 //
227 Conn->MaxRecvDataSegmentLength = DEFAULT_MAX_RECV_DATA_SEG_LEN;
228 Conn->HeaderDigest = ISCSI_DIGEST_NONE;
229 Conn->DataDigest = ISCSI_DIGEST_NONE;
230
231 CopyMem (&Tcp4IoConfig.LocalIp, &Session->ConfigData.NvData.LocalIp, sizeof (EFI_IPv4_ADDRESS));
232 CopyMem (&Tcp4IoConfig.SubnetMask, &Session->ConfigData.NvData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
233 CopyMem (&Tcp4IoConfig.Gateway, &Session->ConfigData.NvData.Gateway, sizeof (EFI_IPv4_ADDRESS));
234 CopyMem (&Tcp4IoConfig.RemoteIp, &Session->ConfigData.NvData.TargetIp, sizeof (EFI_IPv4_ADDRESS));
235
236 Tcp4IoConfig.RemotePort = Session->ConfigData.NvData.TargetPort;
237
238 //
239 // Create the tcp4 IO for this connection
240 //
241 Status = Tcp4IoCreateSocket (
242 Private->Image,
243 Private->Controller,
244 &Tcp4IoConfig,
245 &Conn->Tcp4Io
246 );
247 if (EFI_ERROR (Status)) {
248 gBS->CloseEvent (Conn->TimeoutEvent);
249 gBS->FreePool (Conn);
250 Conn = NULL;
251 }
252
253 return Conn;
254 }
255
256 /**
257 Destroy an iSCSI connection.
258
259 @param[in] Conn The connection to destroy.
260 **/
261 VOID
262 IScsiDestroyConnection (
263 IN ISCSI_CONNECTION *Conn
264 )
265 {
266 Tcp4IoDestroySocket (&Conn->Tcp4Io);
267 NetbufQueFlush (&Conn->RspQue);
268 gBS->CloseEvent (Conn->TimeoutEvent);
269 gBS->FreePool (Conn);
270 }
271
272 /**
273 Login the iSCSI session.
274
275 @param[in] Private The iSCSI driver data.
276
277 @retval EFI_SUCCESS The iSCSI session login procedure finished.
278 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
279 @retval Others Other errors as indicated.
280 **/
281 EFI_STATUS
282 IScsiSessionLogin (
283 IN ISCSI_DRIVER_DATA *Private
284 )
285 {
286 EFI_STATUS Status;
287 ISCSI_SESSION *Session;
288 ISCSI_CONNECTION *Conn;
289 EFI_TCP4_PROTOCOL *Tcp4;
290
291 Session = &Private->Session;
292
293 //
294 // Create a connection for the session.
295 //
296 Conn = IScsiCreateConnection (Private, Session);
297 if (Conn == NULL) {
298 return EFI_OUT_OF_RESOURCES;
299 }
300
301 IScsiAttatchConnection (Session, Conn);
302
303 //
304 // Login througth the newly created connection.
305 //
306 Status = IScsiConnLogin (Conn);
307 if (EFI_ERROR (Status)) {
308 IScsiConnReset (Conn);
309 IScsiDetatchConnection (Conn);
310 IScsiDestroyConnection (Conn);
311 } else {
312 Session->State = SESSION_STATE_LOGGED_IN;
313
314 gBS->OpenProtocol (
315 Conn->Tcp4Io.Handle,
316 &gEfiTcp4ProtocolGuid,
317 (VOID **)&Tcp4,
318 Private->Image,
319 Private->ExtScsiPassThruHandle,
320 EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER
321 );
322 }
323
324 return Status;
325 }
326
327 /**
328 Build and send the iSCSI login request to the iSCSI target according to
329 the current login stage.
330
331 @param[in] Conn The connection in the iSCSI login phase.
332
333 @retval EFI_SUCCESS The iSCSI login request PDU is built and sent on this
334 connection.
335 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
336 @retval EFI_DEVICE_ERROR Some kind of device error happened.
337 **/
338 EFI_STATUS
339 IScsiSendLoginReq (
340 IN ISCSI_CONNECTION *Conn
341 )
342 {
343 NET_BUF *Pdu;
344 EFI_STATUS Status;
345
346 //
347 // build the Login Request PDU
348 //
349 Pdu = IScsiPrepareLoginReq (Conn);
350 if (Pdu == NULL) {
351 return EFI_DEVICE_ERROR;
352 }
353 //
354 // Send it to the iSCSI target.
355 //
356 Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);
357
358 NetbufFree (Pdu);
359
360 return Status;
361 }
362
363 /**
364 Receive and process the iSCSI login response.
365
366 @param[in] Conn The connection in the iSCSI login phase.
367
368 @retval EFI_SUCCESS The iSCSI login response PDU is received and processed.
369 @retval Others Other errors as indicated.
370 **/
371 EFI_STATUS
372 IScsiReceiveLoginRsp (
373 IN ISCSI_CONNECTION *Conn
374 )
375 {
376 EFI_STATUS Status;
377 NET_BUF *Pdu;
378
379 //
380 // Receive the iSCSI login response.
381 //
382 Status = IScsiReceivePdu (Conn, &Pdu, NULL, FALSE, FALSE, NULL);
383 if (EFI_ERROR (Status)) {
384 return Status;
385 }
386 //
387 // A Login Response is received, process it.
388 //
389 Status = IScsiProcessLoginRsp (Conn, Pdu);
390
391 NetbufFree (Pdu);
392
393 return Status;
394 }
395
396 /**
397 Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
398 The DataSegmentLength and the actual size of the net buffer containing this PDU will be
399 updated.
400
401 @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will
402 be added to.
403 @param[in] Key The key name string.
404 @param[in] Value The value string.
405
406 @retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and
407 the correspondence length fields are updated.
408 @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
409 pair.
410 **/
411 EFI_STATUS
412 IScsiAddKeyValuePair (
413 IN OUT NET_BUF *Pdu,
414 IN CHAR8 *Key,
415 IN CHAR8 *Value
416 )
417 {
418 UINT32 DataSegLen;
419 UINT32 KeyLen;
420 UINT32 ValueLen;
421 UINT32 TotalLen;
422 ISCSI_LOGIN_REQUEST *LoginReq;
423 CHAR8 *Data;
424
425 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufGetByte (Pdu, 0, NULL);
426 DataSegLen = NTOH24 (LoginReq->DataSegmentLength);
427
428 KeyLen = (UINT32) AsciiStrLen (Key);
429 ValueLen = (UINT32) AsciiStrLen (Value);
430
431 //
432 // 1 byte for the key value separator '=' and 1 byte for the null
433 // delimiter after the value.
434 //
435 TotalLen = KeyLen + 1 + ValueLen + 1;
436
437 //
438 // Allocate the space for the key-value pair.
439 //
440 Data = (CHAR8 *)NetbufAllocSpace (Pdu, TotalLen, NET_BUF_TAIL);
441 if (Data == NULL) {
442 return EFI_OUT_OF_RESOURCES;
443 }
444 //
445 // Add the key.
446 //
447 CopyMem (Data, Key, KeyLen);
448 Data += KeyLen;
449
450 *Data = '=';
451 Data++;
452
453 //
454 // Add the value.
455 //
456 CopyMem (Data, Value, ValueLen);
457 Data += ValueLen;
458
459 *Data = '\0';
460
461 //
462 // update the DataSegmentLength
463 //
464 ISCSI_SET_DATASEG_LEN (LoginReq, DataSegLen + TotalLen);
465
466 return EFI_SUCCESS;
467 }
468
469 /**
470 Prepare the iSCSI login request to be sent according to the current login status.
471
472 @param[in, out] Conn The connection in the iSCSI login phase.
473
474 @return The pointer to the net buffer containing the iSCSI login request built.
475 @retval Others Other errors as indicated.
476 **/
477 NET_BUF *
478 IScsiPrepareLoginReq (
479 IN OUT ISCSI_CONNECTION *Conn
480 )
481 {
482 ISCSI_SESSION *Session;
483 NET_BUF *Nbuf;
484 ISCSI_LOGIN_REQUEST *LoginReq;
485 EFI_STATUS Status;
486
487 Session = Conn->Session;
488
489 Nbuf = NetbufAlloc (sizeof (ISCSI_LOGIN_REQUEST) + DEFAULT_MAX_RECV_DATA_SEG_LEN);
490 if (Nbuf == NULL) {
491 return NULL;
492 }
493
494 LoginReq = (ISCSI_LOGIN_REQUEST *) NetbufAllocSpace (Nbuf, sizeof (ISCSI_LOGIN_REQUEST), NET_BUF_TAIL);
495 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.Form the pdu from a list of pdu segments.
975 //
976 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
977 if (*Pdu == NULL) {
978 Status = EFI_OUT_OF_RESOURCES;
979 goto ON_EXIT;
980 }
981 return Status;
982 }
983 //
984 // Get the length of the padding bytes of the data segment.
985 //
986 PadLen = ISCSI_GET_PAD_LEN (Len);
987
988 switch (ISCSI_GET_OPCODE (Header)) {
989 case ISCSI_OPCODE_SCSI_DATA_IN:
990 //
991 // Try to use the buffer described by Context if the PDU is an
992 // iSCSI SCSI data in pdu so as to reduce memory copy overhead.
993 //
994 InDataOffset = ISCSI_GET_BUFFER_OFFSET (Header);
995 if ((Context == NULL) || ((InDataOffset + Len) > Context->InDataLen)) {
996 Status = EFI_PROTOCOL_ERROR;
997 goto ON_EXIT;
998 }
999
1000 Fragment[0].Len = Len;
1001 Fragment[0].Bulk = Context->InData + InDataOffset;
1002
1003 if (DataDigest || (PadLen != 0)) {
1004 //
1005 // The data segment is padded, use two fragments to receive it.
1006 // The first to receive the useful data. The second to receive the padding.
1007 //
1008 Fragment[1].Len = PadLen + (DataDigest ? sizeof (UINT32) : 0);
1009 Fragment[1].Bulk = (UINT8 *) ((UINTN) &PadAndCRC32[1] - PadLen);
1010
1011 FragmentCount = 2;
1012 } else {
1013 FragmentCount = 1;
1014 }
1015
1016 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
1017 if (DataSeg == NULL) {
1018 Status = EFI_OUT_OF_RESOURCES;
1019 goto ON_EXIT;
1020 }
1021
1022 break;
1023
1024 case ISCSI_OPCODE_SCSI_RSP:
1025 case ISCSI_OPCODE_NOP_IN:
1026 case ISCSI_OPCODE_LOGIN_RSP:
1027 case ISCSI_OPCODE_TEXT_RSP:
1028 case ISCSI_OPCODE_ASYNC_MSG:
1029 case ISCSI_OPCODE_REJECT:
1030 case ISCSI_OPCODE_VENDOR_T0:
1031 case ISCSI_OPCODE_VENDOR_T1:
1032 case ISCSI_OPCODE_VENDOR_T2:
1033 //
1034 // Allocate buffer to receive the data segment.
1035 //
1036 Len += PadLen + (DataDigest ? sizeof (UINT32) : 0);
1037 DataSeg = NetbufAlloc (Len);
1038 if (DataSeg == NULL) {
1039 Status = EFI_OUT_OF_RESOURCES;
1040 goto ON_EXIT;
1041 }
1042
1043 NetbufAllocSpace (DataSeg, Len, NET_BUF_TAIL);
1044 break;
1045
1046 default:
1047 Status = EFI_PROTOCOL_ERROR;
1048 goto ON_EXIT;
1049 }
1050
1051 InsertTailList (NbufList, &DataSeg->List);
1052
1053 //
1054 // Receive the data segment with the data digest if any.
1055 //
1056 Status = Tcp4IoReceive (&Conn->Tcp4Io, DataSeg, FALSE, TimeoutEvent);
1057 if (EFI_ERROR (Status)) {
1058 goto ON_EXIT;
1059 }
1060
1061 if (DataDigest) {
1062 //
1063 // TODO: Check the data digest.
1064 //
1065 NetbufTrim (DataSeg, sizeof (UINT32), NET_BUF_TAIL);
1066 }
1067
1068 if (PadLen != 0) {
1069 //
1070 // Trim off the padding bytes in the data segment.
1071 //
1072 NetbufTrim (DataSeg, PadLen, NET_BUF_TAIL);
1073 }
1074
1075 //
1076 // Form the pdu from a list of pdu segments.
1077 //
1078 *Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
1079 if (*Pdu == NULL) {
1080 Status = EFI_OUT_OF_RESOURCES;
1081 }
1082
1083 ON_EXIT:
1084
1085 if (EFI_ERROR (Status)) {
1086 //
1087 // Free the Nbufs in this NbufList and the NbufList itself.
1088 //
1089 IScsiFreeNbufList (NbufList);
1090 }
1091
1092 return Status;
1093 }
1094
1095 /**
1096 Check and get the result of the prameter negotiation.
1097
1098 @param[in, out] Conn The connection in iSCSI login.
1099
1100 @retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.
1101 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
1102 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1103 **/
1104 EFI_STATUS
1105 IScsiCheckOpParams (
1106 IN OUT ISCSI_CONNECTION *Conn
1107 )
1108 {
1109 EFI_STATUS Status;
1110 LIST_ENTRY *KeyValueList;
1111 CHAR8 *Data;
1112 UINT32 Len;
1113 ISCSI_SESSION *Session;
1114 CHAR8 *Value;
1115 UINTN NumericValue;
1116
1117 ASSERT (Conn->RspQue.BufNum != 0);
1118
1119 Session = Conn->Session;
1120
1121 Len = Conn->RspQue.BufSize;
1122 Data = AllocatePool (Len);
1123 if (Data == NULL) {
1124 return EFI_OUT_OF_RESOURCES;
1125 }
1126
1127 NetbufQueCopy (&Conn->RspQue, 0, Len, (UINT8 *) Data);
1128
1129 Status = EFI_PROTOCOL_ERROR;
1130
1131 //
1132 // Extract the Key-Value pairs into a list.
1133 //
1134 KeyValueList = IScsiBuildKeyValueList (Data, Len);
1135 if (KeyValueList == NULL) {
1136 gBS->FreePool (Data);
1137 return Status;
1138 }
1139 //
1140 // HeaderDigest
1141 //
1142 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_HEADER_DIGEST);
1143 if (Value == NULL) {
1144 goto ON_ERROR;
1145 }
1146
1147 if (AsciiStrCmp (Value, "CRC32") == 0) {
1148 if (Conn->HeaderDigest != ISCSI_DIGEST_CRC32) {
1149 goto ON_ERROR;
1150 }
1151 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1152 Conn->HeaderDigest = ISCSI_DIGEST_NONE;
1153 } else {
1154 goto ON_ERROR;
1155 }
1156 //
1157 // DataDigest
1158 //
1159 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_DIGEST);
1160 if (Value == NULL) {
1161 goto ON_ERROR;
1162 }
1163
1164 if (AsciiStrCmp (Value, "CRC32") == 0) {
1165 if (Conn->DataDigest != ISCSI_DIGEST_CRC32) {
1166 goto ON_ERROR;
1167 }
1168 } else if (AsciiStrCmp (Value, ISCSI_KEY_VALUE_NONE) == 0) {
1169 Conn->DataDigest = ISCSI_DIGEST_NONE;
1170 } else {
1171 goto ON_ERROR;
1172 }
1173 //
1174 // ErrorRecoveryLevel, result fuction is Minimum.
1175 //
1176 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_ERROR_RECOVERY_LEVEL);
1177 if (Value == NULL) {
1178 goto ON_ERROR;
1179 }
1180
1181 NumericValue = AsciiStrDecimalToUintn (Value);
1182 if (NumericValue > 2) {
1183 goto ON_ERROR;
1184 }
1185
1186 Session->ErrorRecoveryLevel = (UINT8) MIN (Session->ErrorRecoveryLevel, NumericValue);
1187
1188 //
1189 // InitialR2T, result function is OR.
1190 //
1191 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_INITIAL_R2T);
1192 if (Value == NULL) {
1193 goto ON_ERROR;
1194 }
1195
1196 Session->InitialR2T = (BOOLEAN) (Session->InitialR2T || (AsciiStrCmp (Value, "Yes") == 0));
1197
1198 //
1199 // ImmediateData, result function is AND.
1200 //
1201 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_IMMEDIATE_DATA);
1202 if (Value == NULL) {
1203 goto ON_ERROR;
1204 }
1205
1206 Session->ImmediateData = (BOOLEAN) (Session->ImmediateData && (AsciiStrCmp (Value, "Yes") == 0));
1207
1208 //
1209 // MaxRecvDataSegmentLength is declarative.
1210 //
1211 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH);
1212 if (Value != NULL) {
1213 Conn->MaxRecvDataSegmentLength = (UINT32) AsciiStrDecimalToUintn (Value);
1214 }
1215 //
1216 // MaxBurstLength, result funtion is Mininum.
1217 //
1218 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_BURST_LENGTH);
1219 if (Value == NULL) {
1220 goto ON_ERROR;
1221 }
1222
1223 NumericValue = AsciiStrDecimalToUintn (Value);
1224 Session->MaxBurstLength = (UINT32) MIN (Session->MaxBurstLength, NumericValue);
1225
1226 //
1227 // FirstBurstLength, result function is Minimum. Irrelevant when InitialR2T=Yes and
1228 // ImmediateData=No.
1229 //
1230 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_FIRST_BURST_LENGTH);
1231 if ((Value == NULL) && !(Session->InitialR2T && !Session->ImmediateData)) {
1232 goto ON_ERROR;
1233 }
1234
1235 NumericValue = AsciiStrDecimalToUintn (Value);
1236 Session->FirstBurstLength = (UINT32) MIN (Session->FirstBurstLength, NumericValue);
1237
1238 //
1239 // MaxConnections, result function is Minimum.
1240 //
1241 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_CONNECTIONS);
1242 if (Value == NULL) {
1243 goto ON_ERROR;
1244 }
1245
1246 NumericValue = AsciiStrDecimalToUintn (Value);
1247 if ((NumericValue == 0) || (NumericValue > 65535)) {
1248 goto ON_ERROR;
1249 }
1250
1251 Session->MaxConnections = (UINT32) MIN (Session->MaxConnections, NumericValue);
1252
1253 //
1254 // DataPDUInOrder, result function is OR.
1255 //
1256 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_PDU_IN_ORDER);
1257 if (Value == NULL) {
1258 goto ON_ERROR;
1259 }
1260
1261 Session->DataPDUInOrder = (BOOLEAN) (Session->DataPDUInOrder || (AsciiStrCmp (Value, "Yes") == 0));
1262
1263 //
1264 // DataSequenceInorder, result function is OR.
1265 //
1266 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER);
1267 if (Value == NULL) {
1268 goto ON_ERROR;
1269 }
1270
1271 Session->DataSequenceInOrder = (BOOLEAN) (Session->DataSequenceInOrder || (AsciiStrCmp (Value, "Yes") == 0));
1272
1273 //
1274 // DefaultTime2Wait, result function is Maximum.
1275 //
1276 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2WAIT);
1277 if (Value == NULL) {
1278 goto ON_ERROR;
1279 }
1280
1281 NumericValue = AsciiStrDecimalToUintn (Value);
1282 if (NumericValue == 0) {
1283 Session->DefaultTime2Wait = 0;
1284 } else if (NumericValue > 3600) {
1285 goto ON_ERROR;
1286 } else {
1287 Session->DefaultTime2Wait = (UINT32) MAX (Session->DefaultTime2Wait, NumericValue);
1288 }
1289 //
1290 // DefaultTime2Retain, result function is Minimum.
1291 //
1292 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_DEFAULT_TIME2RETAIN);
1293 if (Value == NULL) {
1294 goto ON_ERROR;
1295 }
1296
1297 NumericValue = AsciiStrDecimalToUintn (Value);
1298 if (NumericValue == 0) {
1299 Session->DefaultTime2Retain = 0;
1300 } else if (NumericValue > 3600) {
1301 goto ON_ERROR;
1302 } else {
1303 Session->DefaultTime2Retain = (UINT32) MIN (Session->DefaultTime2Retain, NumericValue);
1304 }
1305 //
1306 // MaxOutstandingR2T, result function is Minimum.
1307 //
1308 Value = IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_MAX_OUTSTANDING_R2T);
1309 if (Value == NULL) {
1310 goto ON_ERROR;
1311 }
1312
1313 NumericValue = AsciiStrDecimalToUintn (Value);
1314 if ((NumericValue == 0) || (NumericValue > 65535)) {
1315 goto ON_ERROR;
1316 }
1317
1318 Session->MaxOutstandingR2T = (UINT16) MIN (Session->MaxOutstandingR2T, NumericValue);
1319
1320 //
1321 // Remove declarative key-value paris if any.
1322 //
1323 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_SESSION_TYPE);
1324 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_ALIAS);
1325 IScsiGetValueByKeyFromList (KeyValueList, ISCSI_KEY_TARGET_PORTAL_GROUP_TAG);
1326
1327 if (IsListEmpty (KeyValueList)) {
1328 //
1329 // Succeed if no more keys in the list.
1330 //
1331 Status = EFI_SUCCESS;
1332 }
1333
1334 ON_ERROR:
1335
1336 IScsiFreeKeyValueList (KeyValueList);
1337
1338 gBS->FreePool (Data);
1339
1340 return Status;
1341 }
1342
1343 /**
1344 Fill the oprational prameters.
1345
1346 @param[in] Conn The connection in iSCSI login.
1347 @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.
1348
1349 @retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.
1350 **/
1351 EFI_STATUS
1352 IScsiFillOpParams (
1353 IN ISCSI_CONNECTION *Conn,
1354 IN OUT NET_BUF *Pdu
1355 )
1356 {
1357 ISCSI_SESSION *Session;
1358 CHAR8 Value[256];
1359
1360 Session = Conn->Session;
1361
1362 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->HeaderDigest == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");
1363 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_HEADER_DIGEST, Value);
1364
1365 AsciiSPrint (Value, sizeof (Value), "%a", (Conn->DataDigest == ISCSI_DIGEST_CRC32) ? "None,CRC32" : "None");
1366 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_DIGEST, Value);
1367
1368 AsciiSPrint (Value, sizeof (Value), "%d", Session->ErrorRecoveryLevel);
1369 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_ERROR_RECOVERY_LEVEL, Value);
1370
1371 AsciiSPrint (Value, sizeof (Value), "%a", Session->InitialR2T ? "Yes" : "No");
1372 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_INITIAL_R2T, Value);
1373
1374 AsciiSPrint (Value, sizeof (Value), "%a", Session->ImmediateData ? "Yes" : "No");
1375 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_IMMEDIATE_DATA, Value);
1376
1377 AsciiSPrint (Value, sizeof (Value), "%d", MAX_RECV_DATA_SEG_LEN_IN_FFP);
1378 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH, Value);
1379
1380 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxBurstLength);
1381 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_BURST_LENGTH, Value);
1382
1383 AsciiSPrint (Value, sizeof (Value), "%d", Session->FirstBurstLength);
1384 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_FIRST_BURST_LENGTH, Value);
1385
1386 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxConnections);
1387 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_CONNECTIONS, Value);
1388
1389 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataPDUInOrder ? "Yes" : "No");
1390 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_PDU_IN_ORDER, Value);
1391
1392 AsciiSPrint (Value, sizeof (Value), "%a", Session->DataSequenceInOrder ? "Yes" : "No");
1393 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DATA_SEQUENCE_IN_ORDER, Value);
1394
1395 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Wait);
1396 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2WAIT, Value);
1397
1398 AsciiSPrint (Value, sizeof (Value), "%d", Session->DefaultTime2Retain);
1399 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_DEFAULT_TIME2RETAIN, Value);
1400
1401 AsciiSPrint (Value, sizeof (Value), "%d", Session->MaxOutstandingR2T);
1402 IScsiAddKeyValuePair (Pdu, ISCSI_KEY_MAX_OUTSTANDING_R2T, Value);
1403
1404 return EFI_SUCCESS;
1405 }
1406
1407 /**
1408 Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
1409
1410 @param[in, out] Pdu The iSCSI pdu which contains segments to pad.
1411 @param[in] Len The length of the last semgnet in the PDU.
1412
1413 @retval EFI_SUCCESS The segment is padded or no need to pad it.
1414 @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
1415 padding bytes.
1416 **/
1417 EFI_STATUS
1418 IScsiPadSegment (
1419 IN OUT NET_BUF *Pdu,
1420 IN UINT32 Len
1421 )
1422 {
1423 UINT32 PadLen;
1424 UINT8 *Data;
1425
1426 PadLen = ISCSI_GET_PAD_LEN (Len);
1427
1428 if (PadLen != 0) {
1429 Data = NetbufAllocSpace (Pdu, PadLen, NET_BUF_TAIL);
1430 if (Data == NULL) {
1431 return EFI_OUT_OF_RESOURCES;
1432 }
1433
1434 ZeroMem (Data, PadLen);
1435 }
1436
1437 return EFI_SUCCESS;
1438 }
1439
1440 /**
1441 Build a key-value list from the data segment.
1442
1443 @param[in] Data The data segment containing the key-value pairs.
1444 @param[in] Len Length of the data segment.
1445
1446 @return The key-value list.
1447 @retval NULL Other errors as indicated.
1448 **/
1449 LIST_ENTRY *
1450 IScsiBuildKeyValueList (
1451 IN CHAR8 *Data,
1452 IN UINT32 Len
1453 )
1454 {
1455 LIST_ENTRY *ListHead;
1456 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1457
1458 ListHead = AllocatePool (sizeof (LIST_ENTRY ));
1459 if (ListHead == NULL) {
1460 return NULL;
1461 }
1462
1463 InitializeListHead (ListHead);
1464
1465 while (Len > 0) {
1466 KeyValuePair = AllocatePool (sizeof (ISCSI_KEY_VALUE_PAIR));
1467 if (KeyValuePair == NULL) {
1468 goto ON_ERROR;
1469 }
1470
1471 InitializeListHead (&KeyValuePair->List);
1472
1473 KeyValuePair->Key = Data;
1474
1475 while ((Len > 0) && (*Data != '=')) {
1476 Len--;
1477 Data++;
1478 }
1479
1480 if (*Data == '=') {
1481 *Data = '\0';
1482
1483 Data++;
1484 Len--;
1485 } else {
1486 gBS->FreePool (KeyValuePair);
1487 goto ON_ERROR;
1488 }
1489
1490 KeyValuePair->Value = Data;
1491
1492 InsertTailList (ListHead, &KeyValuePair->List);;
1493
1494 Data += AsciiStrLen (KeyValuePair->Value) + 1;
1495 Len -= (UINT32) AsciiStrLen (KeyValuePair->Value) + 1;
1496 }
1497
1498 return ListHead;
1499
1500 ON_ERROR:
1501
1502 IScsiFreeKeyValueList (ListHead);
1503
1504 return NULL;
1505 }
1506
1507 /**
1508 Get the value string by the key name from the key-value list. If found,
1509 the key-value entry will be removed from the list.
1510
1511 @param[in, out] KeyValueList The key-value list.
1512 @param[in] Key The key name to find.
1513
1514 @return The value string.
1515 **/
1516 CHAR8 *
1517 IScsiGetValueByKeyFromList (
1518 IN OUT LIST_ENTRY *KeyValueList,
1519 IN CHAR8 *Key
1520 )
1521 {
1522 LIST_ENTRY *Entry;
1523 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1524 CHAR8 *Value;
1525
1526 Value = NULL;
1527
1528 NET_LIST_FOR_EACH (Entry, KeyValueList) {
1529 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1530
1531 if (AsciiStrCmp (KeyValuePair->Key, Key) == 0) {
1532 Value = KeyValuePair->Value;
1533
1534 RemoveEntryList (&KeyValuePair->List);
1535 gBS->FreePool (KeyValuePair);
1536 break;
1537 }
1538 }
1539
1540 return Value;
1541 }
1542
1543 /**
1544 Free the key-value list.
1545
1546 @param[in] KeyValueList The key-value list.
1547 **/
1548 VOID
1549 IScsiFreeKeyValueList (
1550 IN LIST_ENTRY *KeyValueList
1551 )
1552 {
1553 LIST_ENTRY *Entry;
1554 ISCSI_KEY_VALUE_PAIR *KeyValuePair;
1555
1556 while (!IsListEmpty (KeyValueList)) {
1557 Entry = NetListRemoveHead (KeyValueList);
1558 KeyValuePair = NET_LIST_USER_STRUCT (Entry, ISCSI_KEY_VALUE_PAIR, List);
1559
1560 gBS->FreePool (KeyValuePair);
1561 }
1562
1563 gBS->FreePool (KeyValueList);
1564 }
1565
1566 /**
1567 Normalize the iSCSI name according to RFC.
1568
1569 @param[in, out] Name The iSCSI name.
1570 @param[in] Len length of the iSCSI name.
1571
1572 @retval EFI_SUCCESS The iSCSI name is valid and normalized.
1573 @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
1574 **/
1575 EFI_STATUS
1576 IScsiNormalizeName (
1577 IN OUT CHAR8 *Name,
1578 IN UINTN Len
1579 )
1580 {
1581 UINTN Index;
1582
1583 for (Index = 0; Index < Len; Index++) {
1584 if (NET_IS_UPPER_CASE_CHAR (Name[Index])) {
1585 //
1586 // Convert the upper-case characters to lower-case ones
1587 //
1588 Name[Index] = (CHAR8) (Name[Index] - 'A' + 'a');
1589 }
1590
1591 if (!NET_IS_LOWER_CASE_CHAR (Name[Index]) &&
1592 !NET_IS_DIGIT (Name[Index]) &&
1593 (Name[Index] != '-') &&
1594 (Name[Index] != '.') &&
1595 (Name[Index] != ':')
1596 ) {
1597 //
1598 // ASCII dash, dot, colon lower-case characters and digit characters
1599 // are allowed.
1600 //
1601 return EFI_PROTOCOL_ERROR;
1602 }
1603 }
1604
1605 if ((Len < 4) || (CompareMem (Name, "iqn.", 4) != 0)) {
1606 //
1607 // Only IQN format is accepted now.
1608 //
1609 return EFI_PROTOCOL_ERROR;
1610 }
1611
1612 return EFI_SUCCESS;
1613 }
1614
1615 /**
1616 Create an iSCSI task control block.
1617
1618 @param[in] Conn The connection on which the task control block will be created.
1619 @param[out] Tcb The newly created task control block.
1620
1621 @retval EFI_SUCCESS The task control block is created.
1622 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
1623 @retval EFI_NOT_READY The target can not accept new commands.
1624 **/
1625 EFI_STATUS
1626 IScsiNewTcb (
1627 IN ISCSI_CONNECTION *Conn,
1628 OUT ISCSI_TCB **Tcb
1629 )
1630 {
1631 ISCSI_SESSION *Session;
1632 ISCSI_TCB *NewTcb;
1633
1634 ASSERT (Tcb != NULL);
1635
1636 Session = Conn->Session;
1637
1638 if (ISCSI_SEQ_GT (Session->CmdSN, Session->MaxCmdSN)) {
1639 return EFI_NOT_READY;
1640 }
1641
1642 NewTcb = AllocateZeroPool (sizeof (ISCSI_TCB));
1643 if (NewTcb == NULL) {
1644 return EFI_OUT_OF_RESOURCES;
1645 }
1646
1647 InitializeListHead (&NewTcb->Link);
1648
1649 NewTcb->SoFarInOrder = TRUE;
1650 NewTcb->InitiatorTaskTag = Session->InitiatorTaskTag;
1651 NewTcb->CmdSN = Session->CmdSN;
1652 NewTcb->Conn = Conn;
1653
1654 InsertTailList (&Session->TcbList, &NewTcb->Link);
1655
1656 //
1657 // Advance the initiator task tag.
1658 //
1659 Session->InitiatorTaskTag++;
1660 Session->CmdSN++;
1661
1662 *Tcb = NewTcb;
1663
1664 return EFI_SUCCESS;
1665 }
1666
1667 /**
1668 Delete the tcb from the connection and destroy it.
1669
1670 @param[in] Tcb The tcb to delete.
1671 **/
1672 VOID
1673 IScsiDelTcb (
1674 IN ISCSI_TCB *Tcb
1675 )
1676 {
1677 RemoveEntryList (&Tcb->Link);
1678
1679 gBS->FreePool (Tcb);
1680 }
1681
1682 /**
1683 Find the task control block by the initator task tag.
1684
1685 @param[in] TcbList The tcb list.
1686 @param[in] InitiatorTaskTag The initiator task tag.
1687
1688 @return The task control block found.
1689 **/
1690 ISCSI_TCB *
1691 IScsiFindTcbByITT (
1692 IN LIST_ENTRY *TcbList,
1693 IN UINT32 InitiatorTaskTag
1694 )
1695 {
1696 ISCSI_TCB *Tcb;
1697 LIST_ENTRY *Entry;
1698
1699 Tcb = NULL;
1700
1701 NET_LIST_FOR_EACH (Entry, TcbList) {
1702 Tcb = NET_LIST_USER_STRUCT (Entry, ISCSI_TCB, Link);
1703
1704 if (Tcb->InitiatorTaskTag == InitiatorTaskTag) {
1705 break;
1706 }
1707
1708 Tcb = NULL;
1709 }
1710
1711 return Tcb;
1712 }
1713
1714 /**
1715 Create a data segment, pad it and calculate the CRC if needed.
1716
1717 @param[in] Data The data to fill into the data segment.
1718 @param[in] Len Length of the data.
1719 @param[in] DataDigest Whether to calculate CRC for this data segment.
1720
1721 @return The net buffer wrapping the data segment.
1722 **/
1723 NET_BUF *
1724 IScsiNewDataSegment (
1725 IN UINT8 *Data,
1726 IN UINT32 Len,
1727 IN BOOLEAN DataDigest
1728 )
1729 {
1730 NET_FRAGMENT Fragment[2];
1731 UINT32 FragmentCount;
1732 UINT32 PadLen;
1733 NET_BUF *DataSeg;
1734
1735 Fragment[0].Len = Len;
1736 Fragment[0].Bulk = Data;
1737
1738 PadLen = ISCSI_GET_PAD_LEN (Len);
1739 if (PadLen != 0) {
1740 Fragment[1].Len = PadLen;
1741 Fragment[1].Bulk = (UINT8 *) &mDataSegPad;
1742
1743 FragmentCount = 2;
1744 } else {
1745 FragmentCount = 1;
1746 }
1747
1748 DataSeg = NetbufFromExt (&Fragment[0], FragmentCount, 0, 0, IScsiNbufExtFree, NULL);
1749
1750 return DataSeg;
1751 }
1752
1753 /**
1754 Create a iSCSI SCSI command PDU to encapsulate the command issued
1755 by SCSI through the EXT SCSI PASS THRU Protocol.
1756
1757 @param[in] Packet The EXT SCSI PASS THRU request packet containing the SCSI command.
1758 @param[in] Lun The LUN.
1759 @param[in] Tcb The tcb assocated with this SCSI command.
1760
1761 @return The created iSCSI SCSI command PDU.
1762 @retval NULL Other errors as indicated.
1763 **/
1764 NET_BUF *
1765 IScsiNewScsiCmdPdu (
1766 IN EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,
1767 IN UINT64 Lun,
1768 IN ISCSI_TCB *Tcb
1769 )
1770 {
1771 LIST_ENTRY *NbufList;
1772 NET_BUF *Pdu;
1773 NET_BUF *PduHeader;
1774 NET_BUF *DataSeg;
1775 SCSI_COMMAND *ScsiCmd;
1776 UINT8 AHSLength;
1777 UINT32 Length;
1778 ISCSI_ADDITIONAL_HEADER *Header;
1779 ISCSI_BI_EXP_READ_DATA_LEN_AHS *BiExpReadDataLenAHS;
1780 ISCSI_SESSION *Session;
1781 UINT32 ImmediateDataLen;
1782
1783 AHSLength = 0;
1784
1785 if (Packet->DataDirection == DataBi) {
1786 //
1787 // Bi directional Read/Write command, the bidirectional expected
1788 // read data length AHS is required.
1789 //
1790 AHSLength += sizeof (ISCSI_BI_EXP_READ_DATA_LEN_AHS);
1791 }
1792
1793 if (Packet->CdbLength > 16) {
1794 //
1795 // The CDB exceeds 16 bytes, an extended CDB AHS is required.
1796 //
1797 AHSLength = (UINT8) (AHSLength + (ISCSI_ROUNDUP (Packet->CdbLength - 16) + sizeof (ISCSI_ADDITIONAL_HEADER)));
1798 }
1799
1800 Length = sizeof (SCSI_COMMAND) + AHSLength;
1801 PduHeader = NetbufAlloc (Length);
1802 if (PduHeader == NULL) {
1803 return NULL;
1804 }
1805
1806 ScsiCmd = (SCSI_COMMAND *) NetbufAllocSpace (PduHeader, Length, NET_BUF_TAIL);
1807 Header = (ISCSI_ADDITIONAL_HEADER *) (ScsiCmd + 1);
1808
1809 ZeroMem (ScsiCmd, Length);
1810
1811 ISCSI_SET_OPCODE (ScsiCmd, ISCSI_OPCODE_SCSI_CMD, 0);
1812 ISCSI_SET_FLAG (ScsiCmd, ISCSI_TASK_ATTR_SIMPLE);
1813
1814 //
1815 // Set the READ/WRITE flags according to the IO type of this request.
1816 //
1817 switch (Packet->DataDirection) {
1818 case DataIn:
1819 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ);
1820 ScsiCmd->ExpDataXferLength = NTOHL (Packet->InTransferLength);
1821 break;
1822
1823 case DataOut:
1824 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_WRITE);
1825 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
1826 break;
1827
1828 case DataBi:
1829 ISCSI_SET_FLAG (ScsiCmd, SCSI_CMD_PDU_FLAG_READ | SCSI_CMD_PDU_FLAG_WRITE);
1830 ScsiCmd->ExpDataXferLength = NTOHL (Packet->OutTransferLength);
1831
1832 //
1833 // Fill the bidirectional expected read data length AHS.
1834 //
1835 BiExpReadDataLenAHS = (ISCSI_BI_EXP_READ_DATA_LEN_AHS *) Header;
1836 Header = (ISCSI_ADDITIONAL_HEADER *) (BiExpReadDataLenAHS + 1);
1837
1838 BiExpReadDataLenAHS->Length = NTOHS (5);
1839 BiExpReadDataLenAHS->Type = ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN;
1840 BiExpReadDataLenAHS->ExpReadDataLength = NTOHL (Packet->InTransferLength);
1841
1842 break;
1843 }
1844
1845 ScsiCmd->TotalAHSLength = AHSLength;
1846 CopyMem (ScsiCmd->Lun, &Lun, sizeof (ScsiCmd->Lun));
1847 ScsiCmd->InitiatorTaskTag = NTOHL (Tcb->InitiatorTaskTag);
1848 ScsiCmd->CmdSN = NTOHL (Tcb->CmdSN);
1849 ScsiCmd->ExpStatSN = NTOHL (Tcb->Conn->ExpStatSN);
1850
1851 CopyMem (ScsiCmd->CDB, Packet->Cdb, sizeof (ScsiCmd->CDB));
1852
1853 if (Packet->CdbLength > 16) {
1854 Header->Length = NTOHS (Packet->CdbLength - 15);
1855 Header->Type = ISCSI_AHS_TYPE_EXT_CDB;
1856
1857 CopyMem (Header + 1, (UINT8 *) Packet->Cdb + 16, Packet->CdbLength - 16);
1858 }
1859
1860 Pdu = PduHeader;
1861 Session = Tcb->Conn->Session;
1862 ImmediateDataLen = 0;
1863
1864 if (Session->ImmediateData && (Packet->OutTransferLength != 0)) {
1865 //
1866 // Send immediate data in this SCSI Command PDU. The length of the immeidate
1867 // data is the minimum of FirstBurstLength, the data length to be xfered and
1868 // the MaxRecvdataSegmentLength on this connection.
1869 //
1870 ImmediateDataLen = MIN (Session->FirstBurstLength, Packet->OutTransferLength);
1871 ImmediateDataLen = MIN (ImmediateDataLen, Tcb->Conn->MaxRecvDataSegmentLength);
1872
1873 //
1874 // Update the data segment length in the PDU header.
1875 //
1876 ISCSI_SET_DATASEG_LEN (ScsiCmd, ImmediateDataLen);
1877
1878 //
1879 // Create the data segment.
1880 //
1881 DataSeg = IScsiNewDataSegment ((UINT8 *) Packet->OutDataBuffer, ImmediateDataLen, FALSE);
1882 if (DataSeg == NULL) {
1883 NetbufFree (PduHeader);
1884 Pdu = NULL;
1885 goto ON_EXIT;
1886 }
1887
1888 NbufList = AllocatePool (sizeof (LIST_ENTRY ));
1889 if (NbufList == NULL) {
1890 NetbufFree (PduHeader);
1891 NetbufFree (DataSeg);
1892
1893 Pdu = NULL;
1894 goto ON_EXIT;
1895 }
1896
1897 InitializeListHead (NbufList);
1898 InsertTailList (NbufList, &PduHeader->List);
1899 InsertTailList (NbufList, &DataSeg->List);
1900
1901 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
1902 if (Pdu == NULL) {
1903 IScsiFreeNbufList (NbufList);
1904 }
1905 }
1906
1907 if (Session->InitialR2T ||
1908 (ImmediateDataLen == Session->FirstBurstLength) ||
1909 (ImmediateDataLen == Packet->OutTransferLength)
1910 ) {
1911 //
1912 // Unsolicited data out sequence is not allowed,
1913 // or FirstBustLength data is already sent out by immediate data
1914 // or all the OUT data accompany this SCSI packet is sent as
1915 // immediate data, the final flag should be set on this SCSI Command
1916 // PDU.
1917 //
1918 ISCSI_SET_FLAG (ScsiCmd, ISCSI_BHS_FLAG_FINAL);
1919 }
1920
1921 ON_EXIT:
1922
1923 return Pdu;
1924 }
1925
1926 /**
1927 Create a new iSCSI SCSI Data Out PDU.
1928
1929 @param[in] Data The data to put into the Data Out PDU.
1930 @param[in] Len Length of the data.
1931 @param[in] DataSN The DataSN of the Data Out PDU.
1932 @param[in] Tcb The task control block of this Data Out PDU.
1933 @param[in] Lun The LUN.
1934
1935 @return The net buffer wrapping the Data Out PDU.
1936 @retval NULL Other errors as indicated.
1937 **/
1938 NET_BUF *
1939 IScsiNewDataOutPdu (
1940 IN UINT8 *Data,
1941 IN UINT32 Len,
1942 IN UINT32 DataSN,
1943 IN ISCSI_TCB *Tcb,
1944 IN UINT64 Lun
1945 )
1946 {
1947 LIST_ENTRY *NbufList;
1948 NET_BUF *PduHdr;
1949 NET_BUF *DataSeg;
1950 NET_BUF *Pdu;
1951 ISCSI_SCSI_DATA_OUT *DataOutHdr;
1952 ISCSI_XFER_CONTEXT *XferContext;
1953
1954 NbufList = AllocatePool (sizeof (LIST_ENTRY ));
1955 if (NbufList == NULL) {
1956 return NULL;
1957 }
1958
1959 InitializeListHead (NbufList);
1960
1961 //
1962 // Allocate memory for the BHS.
1963 //
1964 PduHdr = NetbufAlloc (sizeof (ISCSI_SCSI_DATA_OUT));
1965 if (PduHdr == NULL) {
1966 gBS->FreePool (NbufList);
1967 return NULL;
1968 }
1969 //
1970 // Insert the BHS into the buffer list.
1971 //
1972 InsertTailList (NbufList, &PduHdr->List);
1973
1974 DataOutHdr = (ISCSI_SCSI_DATA_OUT *) NetbufAllocSpace (PduHdr, sizeof (ISCSI_SCSI_DATA_OUT), NET_BUF_TAIL);
1975 XferContext = &Tcb->XferContext;
1976
1977 ZeroMem (DataOutHdr, sizeof (ISCSI_SCSI_DATA_OUT));
1978
1979 //
1980 // Set the flags and fields of the Data Out PDU BHS.
1981 //
1982 ISCSI_SET_OPCODE (DataOutHdr, ISCSI_OPCODE_SCSI_DATA_OUT, 0);
1983 ISCSI_SET_DATASEG_LEN (DataOutHdr, Len);
1984
1985 DataOutHdr->InitiatorTaskTag = HTONL (Tcb->InitiatorTaskTag);
1986 DataOutHdr->TargetTransferTag = HTONL (XferContext->TargetTransferTag);
1987 DataOutHdr->ExpStatSN = HTONL (Tcb->Conn->ExpStatSN);
1988 DataOutHdr->DataSN = HTONL (DataSN);
1989 DataOutHdr->BufferOffset = HTONL (XferContext->Offset);
1990
1991 if (XferContext->TargetTransferTag != ISCSI_RESERVED_TAG) {
1992 CopyMem (&DataOutHdr->Lun, &Lun, sizeof (DataOutHdr->Lun));
1993 }
1994 //
1995 // Build the data segment for this Data Out PDU.
1996 //
1997 DataSeg = IScsiNewDataSegment (Data, Len, FALSE);
1998 if (DataSeg == NULL) {
1999 IScsiFreeNbufList (NbufList);
2000 return NULL;
2001 }
2002 //
2003 // Put the data segment into the buffer list and combine it with the BHS
2004 // into a full Data Out PDU.
2005 //
2006 InsertTailList (NbufList, &DataSeg->List);
2007 Pdu = NetbufFromBufList (NbufList, 0, 0, IScsiFreeNbufList, NbufList);
2008 if (Pdu == NULL) {
2009 IScsiFreeNbufList (NbufList);
2010 }
2011
2012 return Pdu;
2013 }
2014
2015 /**
2016 Generate a consecutive sequence of iSCSI SCSI Data Out PDUs.
2017
2018 @param[in] Data The data which will be carried by the sequence of iSCSI SCSI Data Out PDUs.
2019 @param[in] Tcb The task control block of the data to send out.
2020 @param[in] Lun The LUN the data will be sent to.
2021
2022 @return A list of net buffers with each of them wraps an iSCSI SCSI Data Out PDU.
2023 @retval NULL Other errors as indicated.
2024 **/
2025 LIST_ENTRY *
2026 IScsiGenerateDataOutPduSequence (
2027 IN UINT8 *Data,
2028 IN ISCSI_TCB *Tcb,
2029 IN UINT64 Lun
2030 )
2031 {
2032 LIST_ENTRY *PduList;
2033 UINT32 DataSN;
2034 UINT32 DataLen;
2035 NET_BUF *DataOutPdu;
2036 ISCSI_CONNECTION *Conn;
2037 ISCSI_XFER_CONTEXT *XferContext;
2038
2039 PduList = AllocatePool (sizeof (LIST_ENTRY ));
2040 if (PduList == NULL) {
2041 return NULL;
2042 }
2043
2044 InitializeListHead (PduList);
2045
2046 DataSN = 0;
2047 Conn = Tcb->Conn;
2048 DataOutPdu = NULL;
2049 XferContext = &Tcb->XferContext;
2050
2051 while (XferContext->DesiredLength > 0) {
2052 //
2053 // Determine the length of data this Data Out PDU can carry.
2054 //
2055 DataLen = MIN (XferContext->DesiredLength, Conn->MaxRecvDataSegmentLength);
2056
2057 //
2058 // Create a Data Out PDU.
2059 //
2060 DataOutPdu = IScsiNewDataOutPdu (Data, DataLen, DataSN, Tcb, Lun);
2061 if (DataOutPdu == NULL) {
2062 IScsiFreeNbufList (PduList);
2063 PduList = NULL;
2064
2065 goto ON_EXIT;
2066 }
2067
2068 InsertTailList (PduList, &DataOutPdu->List);
2069
2070 //
2071 // Update the context and DataSN.
2072 //
2073 XferContext->Offset += DataLen;
2074 XferContext->DesiredLength -= DataLen;
2075 DataSN++;
2076 Data += DataLen;
2077 }
2078 //
2079 // Set the F bit for the last data out PDU in this sequence.
2080 //
2081 ISCSI_SET_FLAG (NetbufGetByte (DataOutPdu, 0, NULL), ISCSI_BHS_FLAG_FINAL);
2082
2083 ON_EXIT:
2084
2085 return PduList;
2086 }
2087
2088 /**
2089 Send the Data in a sequence of Data Out PDUs one by one.
2090
2091 @param[in] Data The data to carry by Data Out PDUs.
2092 @param[in] Lun The LUN the data will be sent to.
2093 @param[in] Tcb The task control block.
2094
2095 @retval EFI_SUCCES The data is sent out to the LUN.
2096 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2097 @retval Others Other errors as indicated.
2098 **/
2099 EFI_STATUS
2100 IScsiSendDataOutPduSequence (
2101 IN UINT8 *Data,
2102 IN UINT64 Lun,
2103 IN ISCSI_TCB *Tcb
2104 )
2105 {
2106 LIST_ENTRY *DataOutPduList;
2107 LIST_ENTRY *Entry;
2108 NET_BUF *Pdu;
2109 EFI_STATUS Status;
2110
2111 //
2112 // Generate the Data Out PDU sequence.
2113 //
2114 DataOutPduList = IScsiGenerateDataOutPduSequence (Data, Tcb, Lun);
2115 if (DataOutPduList == NULL) {
2116 return EFI_OUT_OF_RESOURCES;
2117 }
2118
2119 Status = EFI_SUCCESS;
2120
2121 //
2122 // Send the Data Out PDU's one by one.
2123 //
2124 NET_LIST_FOR_EACH (Entry, DataOutPduList) {
2125 Pdu = NET_LIST_USER_STRUCT (Entry, NET_BUF, List);
2126
2127 Status = Tcp4IoTransmit (&Tcb->Conn->Tcp4Io, Pdu);
2128 if (EFI_ERROR (Status)) {
2129 break;
2130 }
2131 }
2132
2133 IScsiFreeNbufList (DataOutPduList);
2134
2135 return Status;
2136 }
2137
2138 /**
2139 Process the received iSCSI SCSI Data In PDU.
2140
2141 @param[in] Pdu The Data In PDU received.
2142 @param[in] Tcb The task control block.
2143 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2144
2145 @retval EFI_SUCCES The check on the Data IN PDU is passed and some update
2146 actions are taken.
2147 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2148 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2149 @retval Others Other errors as indicated.
2150 **/
2151 EFI_STATUS
2152 IScsiOnDataInRcvd (
2153 IN NET_BUF *Pdu,
2154 IN ISCSI_TCB *Tcb,
2155 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2156 )
2157 {
2158 ISCSI_SCSI_DATA_IN *DataInHdr;
2159 EFI_STATUS Status;
2160
2161 DataInHdr = (ISCSI_SCSI_DATA_IN *) NetbufGetByte (Pdu, 0, NULL);
2162
2163 DataInHdr->InitiatorTaskTag = NTOHL (DataInHdr->InitiatorTaskTag);
2164 DataInHdr->ExpCmdSN = NTOHL (DataInHdr->ExpCmdSN);
2165 DataInHdr->MaxCmdSN = NTOHL (DataInHdr->MaxCmdSN);
2166 DataInHdr->DataSN = NTOHL (DataInHdr->DataSN);
2167
2168 //
2169 // Check the DataSN.
2170 //
2171 Status = IScsiCheckSN (&Tcb->ExpDataSN, DataInHdr->DataSN);
2172 if (EFI_ERROR (Status)) {
2173 return Status;
2174 }
2175
2176 if (DataInHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2177 return EFI_PROTOCOL_ERROR;
2178 }
2179 //
2180 // Update the command related sequence numbers.
2181 //
2182 IScsiUpdateCmdSN (Tcb->Conn->Session, DataInHdr->MaxCmdSN, DataInHdr->ExpCmdSN);
2183
2184 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_STATUS_VALID)) {
2185 if (!ISCSI_FLAG_ON (DataInHdr, ISCSI_BHS_FLAG_FINAL)) {
2186 //
2187 // The S bit is on but the F bit is off.
2188 //
2189 return EFI_PROTOCOL_ERROR;
2190 }
2191
2192 Tcb->StatusXferd = TRUE;
2193
2194 if (ISCSI_FLAG_ON (DataInHdr, SCSI_DATA_IN_PDU_FLAG_OVERFLOW | SCSI_DATA_IN_PDU_FLAG_UNDERFLOW)) {
2195 //
2196 // Underflow and Overflow are mutual flags.
2197 //
2198 return EFI_PROTOCOL_ERROR;
2199 }
2200 //
2201 // S bit is on, the StatSN is valid.
2202 //
2203 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NTOHL (DataInHdr->StatSN));
2204 if (EFI_ERROR (Status)) {
2205 return Status;
2206 }
2207
2208 Packet->HostAdapterStatus = 0;
2209 Packet->TargetStatus = DataInHdr->Status;
2210
2211 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2212 Packet->InTransferLength += NTOHL (DataInHdr->ResidualCount);
2213 Status = EFI_BAD_BUFFER_SIZE;
2214 }
2215
2216 if (ISCSI_FLAG_ON (DataInHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2217 Packet->InTransferLength -= NTOHL (DataInHdr->ResidualCount);
2218 }
2219 }
2220
2221 return Status;
2222 }
2223
2224 /**
2225 Process the received iSCSI R2T PDU.
2226
2227 @param[in] Pdu The R2T PDU received.
2228 @param[in] Tcb The task control block.
2229 @param[in] Lun The Lun.
2230 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2231
2232 @retval EFI_SUCCES The R2T PDU is valid and the solicited data is sent out.
2233 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2234 @retval Others Other errors as indicated.
2235 **/
2236 EFI_STATUS
2237 IScsiOnR2TRcvd (
2238 IN NET_BUF *Pdu,
2239 IN ISCSI_TCB *Tcb,
2240 IN UINT64 Lun,
2241 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2242 )
2243 {
2244 ISCSI_READY_TO_TRANSFER *R2THdr;
2245 EFI_STATUS Status;
2246 ISCSI_XFER_CONTEXT *XferContext;
2247 UINT8 *Data;
2248
2249 R2THdr = (ISCSI_READY_TO_TRANSFER *) NetbufGetByte (Pdu, 0, NULL);
2250
2251 R2THdr->InitiatorTaskTag = NTOHL (R2THdr->InitiatorTaskTag);
2252 R2THdr->TargetTransferTag = NTOHL (R2THdr->TargetTransferTag);
2253 R2THdr->StatSN = NTOHL (R2THdr->StatSN);
2254 R2THdr->R2TSN = NTOHL (R2THdr->R2TSN);
2255 R2THdr->BufferOffset = NTOHL (R2THdr->BufferOffset);
2256 R2THdr->DesiredDataTransferLength = NTOHL (R2THdr->DesiredDataTransferLength);
2257
2258 if ((R2THdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) || !ISCSI_SEQ_EQ (R2THdr->StatSN, Tcb->Conn->ExpStatSN)) {
2259 return EFI_PROTOCOL_ERROR;;
2260 }
2261 //
2262 // Check the sequence number.
2263 //
2264 Status = IScsiCheckSN (&Tcb->ExpDataSN, R2THdr->R2TSN);
2265 if (EFI_ERROR (Status)) {
2266 return Status;
2267 }
2268
2269 XferContext = &Tcb->XferContext;
2270 XferContext->TargetTransferTag = R2THdr->TargetTransferTag;
2271 XferContext->Offset = R2THdr->BufferOffset;
2272 XferContext->DesiredLength = R2THdr->DesiredDataTransferLength;
2273
2274 if (((XferContext->Offset + XferContext->DesiredLength) > Packet->OutTransferLength) ||
2275 (XferContext->DesiredLength > Tcb->Conn->Session->MaxBurstLength)
2276 ) {
2277 return EFI_PROTOCOL_ERROR;
2278 }
2279 //
2280 // Send the data solicited by this R2T.
2281 //
2282 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2283 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2284
2285 return Status;
2286 }
2287
2288 /**
2289 Process the received iSCSI SCSI Response PDU.
2290
2291 @param[in] Pdu The Response PDU received.
2292 @param[in] Tcb The task control block.
2293 @param[in, out] Packet The EXT SCSI PASS THRU request packet.
2294
2295 @retval EFI_SUCCES The Response PDU is processed.
2296 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2297 @retval EFI_BAD_BUFFER_SIZEE The buffer was not the proper size for the request.
2298 @retval Others Other errors as indicated.
2299 **/
2300 EFI_STATUS
2301 IScsiOnScsiRspRcvd (
2302 IN NET_BUF *Pdu,
2303 IN ISCSI_TCB *Tcb,
2304 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2305 )
2306 {
2307 SCSI_RESPONSE *ScsiRspHdr;
2308 ISCSI_SENSE_DATA *SenseData;
2309 EFI_STATUS Status;
2310 UINT32 DataSegLen;
2311
2312 ScsiRspHdr = (SCSI_RESPONSE *) NetbufGetByte (Pdu, 0, NULL);
2313
2314 ScsiRspHdr->InitiatorTaskTag = NTOHL (ScsiRspHdr->InitiatorTaskTag);
2315 if (ScsiRspHdr->InitiatorTaskTag != Tcb->InitiatorTaskTag) {
2316 return EFI_PROTOCOL_ERROR;
2317 }
2318
2319 ScsiRspHdr->StatSN = NTOHL (ScsiRspHdr->StatSN);
2320
2321 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, ScsiRspHdr->StatSN);
2322 if (EFI_ERROR (Status)) {
2323 return Status;
2324 }
2325
2326 ScsiRspHdr->MaxCmdSN = NTOHL (ScsiRspHdr->MaxCmdSN);
2327 ScsiRspHdr->ExpCmdSN = NTOHL (ScsiRspHdr->ExpCmdSN);
2328 IScsiUpdateCmdSN (Tcb->Conn->Session, ScsiRspHdr->MaxCmdSN, ScsiRspHdr->ExpCmdSN);
2329
2330 Tcb->StatusXferd = TRUE;
2331
2332 Packet->HostAdapterStatus = ScsiRspHdr->Response;
2333 if (Packet->HostAdapterStatus != ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET) {
2334 return EFI_SUCCESS;
2335 }
2336
2337 Packet->TargetStatus = ScsiRspHdr->Status;
2338
2339 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW | SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW) ||
2340 ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW | SCSI_RSP_PDU_FLAG_UNDERFLOW)
2341 ) {
2342 return EFI_PROTOCOL_ERROR;
2343 }
2344
2345 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW)) {
2346 Packet->InTransferLength += NTOHL (ScsiRspHdr->BiReadResidualCount);
2347 Status = EFI_BAD_BUFFER_SIZE;
2348 }
2349
2350 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW)) {
2351 Packet->InTransferLength -= NTOHL (ScsiRspHdr->BiReadResidualCount);
2352 }
2353
2354 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_OVERFLOW)) {
2355 if (Packet->DataDirection == DataIn) {
2356 Packet->InTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2357 } else {
2358 Packet->OutTransferLength += NTOHL (ScsiRspHdr->ResidualCount);
2359 }
2360
2361 Status = EFI_BAD_BUFFER_SIZE;
2362 }
2363
2364 if (ISCSI_FLAG_ON (ScsiRspHdr, SCSI_RSP_PDU_FLAG_UNDERFLOW)) {
2365 if (Packet->DataDirection == DataIn) {
2366 Packet->InTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2367 } else {
2368 Packet->OutTransferLength -= NTOHL (ScsiRspHdr->ResidualCount);
2369 }
2370 }
2371
2372 DataSegLen = ISCSI_GET_DATASEG_LEN (ScsiRspHdr);
2373 if (DataSegLen != 0) {
2374 SenseData = (ISCSI_SENSE_DATA *) NetbufGetByte (Pdu, sizeof (SCSI_RESPONSE), NULL);
2375
2376 SenseData->Length = NTOHS (SenseData->Length);
2377
2378 Packet->SenseDataLength = (UINT8) MIN (SenseData->Length, Packet->SenseDataLength);
2379 if (Packet->SenseDataLength != 0) {
2380 CopyMem (Packet->SenseData, &SenseData->Data[0], Packet->SenseDataLength);
2381 }
2382 } else {
2383 Packet->SenseDataLength = 0;
2384 }
2385
2386 return Status;
2387 }
2388
2389 /**
2390 Process the received NOP In PDU.
2391
2392 @param[in] Pdu The NOP In PDU received.
2393 @param[in] Tcb The task control block.
2394
2395 @retval EFI_SUCCES The NOP In PDU is processed and the related sequence
2396 numbers are updated.
2397 @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol errror happened.
2398 **/
2399 EFI_STATUS
2400 IScsiOnNopInRcvd (
2401 IN NET_BUF *Pdu,
2402 IN ISCSI_TCB *Tcb
2403 )
2404 {
2405 ISCSI_NOP_IN *NopInHdr;
2406 EFI_STATUS Status;
2407
2408 NopInHdr = (ISCSI_NOP_IN *) NetbufGetByte (Pdu, 0, NULL);
2409
2410 NopInHdr->StatSN = NTOHL (NopInHdr->StatSN);
2411 NopInHdr->ExpCmdSN = NTOHL (NopInHdr->ExpCmdSN);
2412 NopInHdr->MaxCmdSN = NTOHL (NopInHdr->MaxCmdSN);
2413
2414 if (NopInHdr->InitiatorTaskTag == ISCSI_RESERVED_TAG) {
2415 if (NopInHdr->StatSN != Tcb->Conn->ExpStatSN) {
2416 return EFI_PROTOCOL_ERROR;
2417 }
2418 } else {
2419 Status = IScsiCheckSN (&Tcb->Conn->ExpStatSN, NopInHdr->StatSN);
2420 if (EFI_ERROR (Status)) {
2421 return Status;
2422 }
2423 }
2424
2425 IScsiUpdateCmdSN (Tcb->Conn->Session, NopInHdr->MaxCmdSN, NopInHdr->ExpCmdSN);
2426
2427 return EFI_SUCCESS;
2428 }
2429
2430 /**
2431 Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
2432
2433 @param[in] PassThru The EXT SCSI PASS THRU protocol.
2434 @param[in] Target The target ID.
2435 @param[in] Lun The LUN.
2436 @param[in, out] Packet The request packet containing IO request, SCSI command
2437 buffer and buffers to read/write.
2438
2439 @retval EFI_SUCCES The SCSI command is executed and the result is updated to
2440 the Packet.
2441 @retval EFI_DEVICE_ERROR Session state was not as required.
2442 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
2443 @retval Others Other errors as indicated.
2444 **/
2445 EFI_STATUS
2446 IScsiExecuteScsiCommand (
2447 IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru,
2448 IN UINT8 *Target,
2449 IN UINT64 Lun,
2450 IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet
2451 )
2452 {
2453 EFI_STATUS Status;
2454 ISCSI_DRIVER_DATA *Private;
2455 ISCSI_SESSION *Session;
2456 EFI_EVENT TimeoutEvent;
2457 ISCSI_CONNECTION *Conn;
2458 ISCSI_TCB *Tcb;
2459 NET_BUF *Pdu;
2460 ISCSI_XFER_CONTEXT *XferContext;
2461 UINT8 *Data;
2462 ISCSI_IN_BUFFER_CONTEXT InBufferContext;
2463 UINT64 Timeout;
2464 UINT8 *Buffer;
2465
2466 Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (PassThru);
2467 Session = &Private->Session;
2468 Status = EFI_SUCCESS;
2469 Tcb = NULL;
2470 TimeoutEvent = NULL;
2471 Timeout = 0;
2472
2473 if (Session->State != SESSION_STATE_LOGGED_IN) {
2474 return EFI_DEVICE_ERROR;
2475 }
2476
2477 Conn = NET_LIST_USER_STRUCT_S (
2478 Session->Conns.ForwardLink,
2479 ISCSI_CONNECTION,
2480 Link,
2481 ISCSI_CONNECTION_SIGNATURE
2482 );
2483
2484 if (Packet->Timeout != 0) {
2485 Timeout = MultU64x32 (Packet->Timeout, 2);
2486 }
2487
2488 Status = IScsiNewTcb (Conn, &Tcb);
2489 if (EFI_ERROR (Status)) {
2490 goto ON_EXIT;
2491 }
2492 //
2493 // Encapsulate the SCSI request packet into an iSCSI SCSI Command PDU.
2494 //
2495 Pdu = IScsiNewScsiCmdPdu (Packet, Lun, Tcb);
2496 if (Pdu == NULL) {
2497 Status = EFI_OUT_OF_RESOURCES;
2498 goto ON_EXIT;
2499 }
2500
2501 XferContext = &Tcb->XferContext;
2502 Buffer = NetbufGetByte (Pdu, 0, NULL);
2503 XferContext->Offset = ISCSI_GET_DATASEG_LEN (Buffer);
2504
2505 //
2506 // Transmit the SCSI Command PDU.
2507 //
2508 Status = Tcp4IoTransmit (&Conn->Tcp4Io, Pdu);
2509
2510 NetbufFree (Pdu);
2511
2512 if (EFI_ERROR (Status)) {
2513 goto ON_EXIT;
2514 }
2515
2516 if (!Session->InitialR2T &&
2517 (XferContext->Offset < Session->FirstBurstLength) &&
2518 (XferContext->Offset < Packet->OutTransferLength)
2519 ) {
2520 //
2521 // Unsolicited Data-Out sequence is allowed, there is remaining SCSI
2522 // OUT data and the limit of FirstBurstLength is not reached.
2523 //
2524 XferContext->TargetTransferTag = ISCSI_RESERVED_TAG;
2525 XferContext->DesiredLength = MIN (
2526 Session->FirstBurstLength,
2527 Packet->OutTransferLength - XferContext->Offset
2528 );
2529
2530 Data = (UINT8 *) Packet->OutDataBuffer + XferContext->Offset;
2531 Status = IScsiSendDataOutPduSequence (Data, Lun, Tcb);
2532 if (EFI_ERROR (Status)) {
2533 goto ON_EXIT;
2534 }
2535 }
2536
2537 InBufferContext.InData = (UINT8 *) Packet->InDataBuffer;
2538 InBufferContext.InDataLen = Packet->InTransferLength;
2539
2540 while (!Tcb->StatusXferd) {
2541 //
2542 // Start the timeout timer.
2543 //
2544 if (Timeout != 0) {
2545 Status = gBS->SetTimer (Conn->TimeoutEvent, TimerRelative, Timeout);
2546 if (EFI_ERROR (Status)) {
2547 goto ON_EXIT;
2548 }
2549 TimeoutEvent = Conn->TimeoutEvent;
2550 }
2551 //
2552 // try to receive PDU from target.
2553 //
2554 Status = IScsiReceivePdu (Conn, &Pdu, &InBufferContext, FALSE, FALSE, TimeoutEvent);
2555 if (EFI_ERROR (Status)) {
2556 goto ON_EXIT;
2557 }
2558
2559 switch (ISCSI_GET_OPCODE (NetbufGetByte (Pdu, 0, NULL))) {
2560 case ISCSI_OPCODE_SCSI_DATA_IN:
2561 Status = IScsiOnDataInRcvd (Pdu, Tcb, Packet);
2562 break;
2563
2564 case ISCSI_OPCODE_R2T:
2565 Status = IScsiOnR2TRcvd (Pdu, Tcb, Lun, Packet);
2566 break;
2567
2568 case ISCSI_OPCODE_SCSI_RSP:
2569 Status = IScsiOnScsiRspRcvd (Pdu, Tcb, Packet);
2570 break;
2571
2572 case ISCSI_OPCODE_NOP_IN:
2573 Status = IScsiOnNopInRcvd (Pdu, Tcb);
2574 break;
2575
2576 case ISCSI_OPCODE_VENDOR_T0:
2577 case ISCSI_OPCODE_VENDOR_T1:
2578 case ISCSI_OPCODE_VENDOR_T2:
2579 //
2580 // These messages are vendor specific, skip them.
2581 //
2582 break;
2583
2584 default:
2585 Status = EFI_PROTOCOL_ERROR;
2586 break;
2587 }
2588
2589 NetbufFree (Pdu);
2590
2591 if (EFI_ERROR (Status)) {
2592 break;
2593 }
2594 }
2595
2596 ON_EXIT:
2597
2598 if (TimeoutEvent != NULL) {
2599 gBS->SetTimer (TimeoutEvent, TimerCancel, 0);
2600 }
2601
2602 if (Tcb != NULL) {
2603 IScsiDelTcb (Tcb);
2604 }
2605
2606 if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) {
2607 //
2608 // Reinstate the session.
2609 //
2610 if (EFI_ERROR (IScsiSessionReinstatement (Private))) {
2611 Status = EFI_DEVICE_ERROR;
2612 }
2613 }
2614
2615 return Status;
2616 }
2617
2618 /**
2619 Reinstate the session on some error.
2620
2621 @param[in, out] Private The iSCSI driver data.
2622
2623 @retval EFI_SUCCES The session is reinstated from some error.
2624 @retval Other Reinstatement failed.
2625 **/
2626 EFI_STATUS
2627 IScsiSessionReinstatement (
2628 IN OUT ISCSI_DRIVER_DATA *Private
2629 )
2630 {
2631 ISCSI_SESSION *Session;
2632 EFI_STATUS Status;
2633
2634 Session = &Private->Session;
2635 ASSERT (Session->State == SESSION_STATE_LOGGED_IN);
2636
2637 //
2638 // Abort the session and re-init it.
2639 //
2640 IScsiSessionAbort (Session);
2641 IScsiSessionInit (Session, TRUE);
2642
2643 //
2644 // Login again.
2645 //
2646 Status = IScsiSessionLogin (Private);
2647
2648 return Status;
2649 }
2650
2651 /**
2652 Initialize some session parameters before login.
2653
2654 @param[in, out] Session The iSCSI session.
2655 @param[in] Recovery Whether the request is from a fresh new start or recovery.
2656 **/
2657 VOID
2658 IScsiSessionInit (
2659 IN OUT ISCSI_SESSION *Session,
2660 IN BOOLEAN Recovery
2661 )
2662 {
2663 UINT32 Random;
2664
2665 if (!Recovery) {
2666 Session->Signature = ISCSI_SESSION_SIGNATURE;
2667 Session->State = SESSION_STATE_FREE;
2668
2669 Random = NET_RANDOM (NetRandomInitSeed ());
2670
2671 Session->Isid[0] = ISID_BYTE_0;
2672 Session->Isid[1] = ISID_BYTE_1;
2673 Session->Isid[2] = ISID_BYTE_2;
2674 Session->Isid[3] = ISID_BYTE_3;
2675 Session->Isid[4] = (UINT8) Random;
2676 Session->Isid[5] = (UINT8) (Random >> 8);
2677
2678 InitializeListHead (&Session->Conns);
2679 InitializeListHead (&Session->TcbList);
2680 }
2681
2682 Session->Tsih = 0;
2683
2684 Session->CmdSN = 1;
2685 Session->InitiatorTaskTag = 1;
2686 Session->NextCid = 1;
2687
2688 Session->TargetPortalGroupTag = 0;
2689 Session->MaxConnections = ISCSI_MAX_CONNS_PER_SESSION;
2690 Session->InitialR2T = FALSE;
2691 Session->ImmediateData = TRUE;
2692 Session->MaxBurstLength = 262144;
2693 Session->FirstBurstLength = MAX_RECV_DATA_SEG_LEN_IN_FFP;
2694 Session->DefaultTime2Wait = 2;
2695 Session->DefaultTime2Retain = 20;
2696 Session->MaxOutstandingR2T = DEFAULT_MAX_OUTSTANDING_R2T;
2697 Session->DataPDUInOrder = TRUE;
2698 Session->DataSequenceInOrder = TRUE;
2699 Session->ErrorRecoveryLevel = 0;
2700 }
2701
2702 /**
2703 Abort the iSCSI session, that is, reset all the connection and free the
2704 resources.
2705
2706 @param[in, out] Session The iSCSI session.
2707
2708 @retval EFI_SUCCES The session is aborted.
2709 **/
2710 EFI_STATUS
2711 IScsiSessionAbort (
2712 IN OUT ISCSI_SESSION *Session
2713 )
2714 {
2715 ISCSI_DRIVER_DATA *Private;
2716 ISCSI_CONNECTION *Conn;
2717
2718 if (Session->State != SESSION_STATE_LOGGED_IN) {
2719 return EFI_SUCCESS;
2720 }
2721
2722 ASSERT (!IsListEmpty (&Session->Conns));
2723
2724 Private = ISCSI_DRIVER_DATA_FROM_SESSION (Session);
2725
2726 while (!IsListEmpty (&Session->Conns)) {
2727 Conn = NET_LIST_USER_STRUCT_S (
2728 Session->Conns.ForwardLink,
2729 ISCSI_CONNECTION,
2730 Link,
2731 ISCSI_CONNECTION_SIGNATURE
2732 );
2733
2734 gBS->CloseProtocol (
2735 Conn->Tcp4Io.Handle,
2736 &gEfiTcp4ProtocolGuid,
2737 Private->Image,
2738 Private->ExtScsiPassThruHandle
2739 );
2740
2741 IScsiConnReset (Conn);
2742
2743 IScsiDetatchConnection (Conn);
2744 IScsiDestroyConnection (Conn);
2745 }
2746
2747 Session->State = SESSION_STATE_FAILED;
2748
2749 return EFI_SUCCESS;
2750 }
EFI Development Kit II mirror for PVE