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