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