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