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