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