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


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