]>
Commit | Line | Data |
---|---|---|
1 | /** @file\r | |
2 | Mtftp6 support functions implementation.\r | |
3 | \r | |
4 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r | |
5 | \r | |
6 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
7 | \r | |
8 | **/\r | |
9 | \r | |
10 | #include "Mtftp6Impl.h"\r | |
11 | \r | |
12 | /**\r | |
13 | Allocate a MTFTP block range, then init it to the range of [Start, End].\r | |
14 | \r | |
15 | @param[in] Start The start block number.\r | |
16 | @param[in] End The last block number in the range.\r | |
17 | \r | |
18 | @return Range The range of the allocated block buffer.\r | |
19 | \r | |
20 | **/\r | |
21 | MTFTP6_BLOCK_RANGE *\r | |
22 | Mtftp6AllocateRange (\r | |
23 | IN UINT16 Start,\r | |
24 | IN UINT16 End\r | |
25 | )\r | |
26 | {\r | |
27 | MTFTP6_BLOCK_RANGE *Range;\r | |
28 | \r | |
29 | Range = AllocateZeroPool (sizeof (MTFTP6_BLOCK_RANGE));\r | |
30 | \r | |
31 | if (Range == NULL) {\r | |
32 | return NULL;\r | |
33 | }\r | |
34 | \r | |
35 | InitializeListHead (&Range->Link);\r | |
36 | Range->Start = Start;\r | |
37 | Range->End = End;\r | |
38 | Range->Bound = End;\r | |
39 | \r | |
40 | return Range;\r | |
41 | }\r | |
42 | \r | |
43 | /**\r | |
44 | Initialize the block range for either RRQ or WRQ. RRQ and WRQ have\r | |
45 | different requirements for Start and End. For example, during startup,\r | |
46 | WRQ initializes its whole valid block range to [0, 0xffff]. This\r | |
47 | is because the server will send an ACK0 to inform the user to start the\r | |
48 | upload. When the client receives an ACK0, it will remove 0 from the range,\r | |
49 | get the next block number, which is 1, then upload the BLOCK1. For RRQ\r | |
50 | without option negotiation, the server will directly send the BLOCK1\r | |
51 | in response to the client's RRQ. When received BLOCK1, the client will\r | |
52 | remove it from the block range and send an ACK. It also works if there\r | |
53 | is option negotiation.\r | |
54 | \r | |
55 | @param[in] Head The block range head to initialize.\r | |
56 | @param[in] Start The Start block number.\r | |
57 | @param[in] End The last block number.\r | |
58 | \r | |
59 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for initial block range.\r | |
60 | @retval EFI_SUCCESS The initial block range is created.\r | |
61 | \r | |
62 | **/\r | |
63 | EFI_STATUS\r | |
64 | Mtftp6InitBlockRange (\r | |
65 | IN LIST_ENTRY *Head,\r | |
66 | IN UINT16 Start,\r | |
67 | IN UINT16 End\r | |
68 | )\r | |
69 | {\r | |
70 | MTFTP6_BLOCK_RANGE *Range;\r | |
71 | \r | |
72 | Range = Mtftp6AllocateRange (Start, End);\r | |
73 | \r | |
74 | if (Range == NULL) {\r | |
75 | return EFI_OUT_OF_RESOURCES;\r | |
76 | }\r | |
77 | \r | |
78 | InsertTailList (Head, &Range->Link);\r | |
79 | return EFI_SUCCESS;\r | |
80 | }\r | |
81 | \r | |
82 | /**\r | |
83 | Get the first valid block number on the range list.\r | |
84 | \r | |
85 | @param[in] Head The block range head.\r | |
86 | \r | |
87 | @retval ==-1 If the block range is empty.\r | |
88 | @retval >-1 The first valid block number.\r | |
89 | \r | |
90 | **/\r | |
91 | INTN\r | |
92 | Mtftp6GetNextBlockNum (\r | |
93 | IN LIST_ENTRY *Head\r | |
94 | )\r | |
95 | {\r | |
96 | MTFTP6_BLOCK_RANGE *Range;\r | |
97 | \r | |
98 | if (IsListEmpty (Head)) {\r | |
99 | return -1;\r | |
100 | }\r | |
101 | \r | |
102 | Range = NET_LIST_HEAD (Head, MTFTP6_BLOCK_RANGE, Link);\r | |
103 | return Range->Start;\r | |
104 | }\r | |
105 | \r | |
106 | /**\r | |
107 | Set the last block number of the block range list. It\r | |
108 | removes all the blocks after the Last. MTFTP initialize the\r | |
109 | block range to the maximum possible range, such as [0, 0xffff]\r | |
110 | for WRQ. When it gets the last block number, it calls\r | |
111 | this function to set the last block number.\r | |
112 | \r | |
113 | @param[in] Head The block range list.\r | |
114 | @param[in] Last The last block number.\r | |
115 | \r | |
116 | **/\r | |
117 | VOID\r | |
118 | Mtftp6SetLastBlockNum (\r | |
119 | IN LIST_ENTRY *Head,\r | |
120 | IN UINT16 Last\r | |
121 | )\r | |
122 | {\r | |
123 | MTFTP6_BLOCK_RANGE *Range;\r | |
124 | \r | |
125 | //\r | |
126 | // Iterate from the tail to head to remove the block number\r | |
127 | // after the last.\r | |
128 | //\r | |
129 | while (!IsListEmpty (Head)) {\r | |
130 | Range = NET_LIST_TAIL (Head, MTFTP6_BLOCK_RANGE, Link);\r | |
131 | \r | |
132 | if (Range->Start > Last) {\r | |
133 | RemoveEntryList (&Range->Link);\r | |
134 | FreePool (Range);\r | |
135 | continue;\r | |
136 | }\r | |
137 | \r | |
138 | if (Range->End > Last) {\r | |
139 | Range->End = Last;\r | |
140 | }\r | |
141 | \r | |
142 | return;\r | |
143 | }\r | |
144 | }\r | |
145 | \r | |
146 | /**\r | |
147 | Remove the block number from the block range list.\r | |
148 | \r | |
149 | @param[in] Head The block range list to remove from.\r | |
150 | @param[in] Num The block number to remove.\r | |
151 | @param[in] Completed Whether Num is the last block number.\r | |
152 | @param[out] BlockCounter The continuous block counter instead of the value after roll-over.\r | |
153 | \r | |
154 | @retval EFI_NOT_FOUND The block number isn't in the block range list.\r | |
155 | @retval EFI_SUCCESS The block number has been removed from the list.\r | |
156 | @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r | |
157 | \r | |
158 | **/\r | |
159 | EFI_STATUS\r | |
160 | Mtftp6RemoveBlockNum (\r | |
161 | IN LIST_ENTRY *Head,\r | |
162 | IN UINT16 Num,\r | |
163 | IN BOOLEAN Completed,\r | |
164 | OUT UINT64 *BlockCounter\r | |
165 | )\r | |
166 | {\r | |
167 | MTFTP6_BLOCK_RANGE *Range;\r | |
168 | MTFTP6_BLOCK_RANGE *NewRange;\r | |
169 | LIST_ENTRY *Entry;\r | |
170 | \r | |
171 | NET_LIST_FOR_EACH (Entry, Head) {\r | |
172 | //\r | |
173 | // Each block represents a hole [Start, End] in the file,\r | |
174 | // skip to the first range with End >= Num\r | |
175 | //\r | |
176 | Range = NET_LIST_USER_STRUCT (Entry, MTFTP6_BLOCK_RANGE, Link);\r | |
177 | \r | |
178 | if (Range->End < Num) {\r | |
179 | continue;\r | |
180 | }\r | |
181 | \r | |
182 | //\r | |
183 | // There are three different cases for Start\r | |
184 | // 1. (Start > Num) && (End >= Num):\r | |
185 | // because all the holes before this one has the condition of\r | |
186 | // End < Num, so this block number has been removed.\r | |
187 | //\r | |
188 | // 2. (Start == Num) && (End >= Num):\r | |
189 | // Need to increase the Start by one, and if End == Num, this\r | |
190 | // hole has been removed completely, remove it.\r | |
191 | //\r | |
192 | // 3. (Start < Num) && (End >= Num):\r | |
193 | // if End == Num, only need to decrease the End by one because\r | |
194 | // we have (Start < Num) && (Num == End), so (Start <= End - 1).\r | |
195 | // if (End > Num), the hold is split into two holes, with\r | |
196 | // [Start, Num - 1] and [Num + 1, End].\r | |
197 | //\r | |
198 | if (Range->Start > Num) {\r | |
199 | return EFI_NOT_FOUND;\r | |
200 | } else if (Range->Start == Num) {\r | |
201 | Range->Start++;\r | |
202 | \r | |
203 | //\r | |
204 | // Note that: RFC 1350 does not mention block counter roll-over,\r | |
205 | // but several TFTP hosts implement the roll-over be able to accept\r | |
206 | // transfers of unlimited size. There is no consensus, however, whether\r | |
207 | // the counter should wrap around to zero or to one. Many implementations\r | |
208 | // wrap to zero, because this is the simplest to implement. Here we choose\r | |
209 | // this solution.\r | |
210 | //\r | |
211 | *BlockCounter = Num;\r | |
212 | \r | |
213 | if (Range->Round > 0) {\r | |
214 | *BlockCounter += Range->Bound + MultU64x32 (Range->Round - 1, (UINT32)(Range->Bound + 1)) + 1;\r | |
215 | }\r | |
216 | \r | |
217 | if (Range->Start > Range->Bound) {\r | |
218 | Range->Start = 0;\r | |
219 | Range->Round++;\r | |
220 | }\r | |
221 | \r | |
222 | if ((Range->Start > Range->End) || Completed) {\r | |
223 | RemoveEntryList (&Range->Link);\r | |
224 | FreePool (Range);\r | |
225 | }\r | |
226 | \r | |
227 | return EFI_SUCCESS;\r | |
228 | } else {\r | |
229 | if (Range->End == Num) {\r | |
230 | Range->End--;\r | |
231 | } else {\r | |
232 | NewRange = Mtftp6AllocateRange ((UINT16)(Num + 1), (UINT16)Range->End);\r | |
233 | \r | |
234 | if (NewRange == NULL) {\r | |
235 | return EFI_OUT_OF_RESOURCES;\r | |
236 | }\r | |
237 | \r | |
238 | Range->End = Num - 1;\r | |
239 | NetListInsertAfter (&Range->Link, &NewRange->Link);\r | |
240 | }\r | |
241 | \r | |
242 | return EFI_SUCCESS;\r | |
243 | }\r | |
244 | }\r | |
245 | \r | |
246 | return EFI_NOT_FOUND;\r | |
247 | }\r | |
248 | \r | |
249 | /**\r | |
250 | Configure the opened Udp6 instance until the corresponding Ip6 instance\r | |
251 | has been configured.\r | |
252 | \r | |
253 | @param[in] UdpIo The pointer to the Udp6 Io.\r | |
254 | @param[in] UdpCfgData The pointer to the Udp6 configure data.\r | |
255 | \r | |
256 | @retval EFI_SUCCESS Configure the Udp6 instance successfully.\r | |
257 | @retval EFI_NO_MAPPING The corresponding Ip6 instance has not\r | |
258 | been configured yet.\r | |
259 | \r | |
260 | **/\r | |
261 | EFI_STATUS\r | |
262 | Mtftp6GetMapping (\r | |
263 | IN UDP_IO *UdpIo,\r | |
264 | IN EFI_UDP6_CONFIG_DATA *UdpCfgData\r | |
265 | )\r | |
266 | {\r | |
267 | EFI_IP6_MODE_DATA Ip6Mode;\r | |
268 | EFI_UDP6_PROTOCOL *Udp6;\r | |
269 | EFI_STATUS Status;\r | |
270 | EFI_EVENT Event;\r | |
271 | \r | |
272 | Event = NULL;\r | |
273 | Udp6 = UdpIo->Protocol.Udp6;\r | |
274 | \r | |
275 | //\r | |
276 | // Create a timer to check whether the Ip6 instance configured or not.\r | |
277 | //\r | |
278 | Status = gBS->CreateEvent (\r | |
279 | EVT_TIMER,\r | |
280 | TPL_CALLBACK,\r | |
281 | NULL,\r | |
282 | NULL,\r | |
283 | &Event\r | |
284 | );\r | |
285 | if (EFI_ERROR (Status)) {\r | |
286 | goto ON_EXIT;\r | |
287 | }\r | |
288 | \r | |
289 | Status = gBS->SetTimer (\r | |
290 | Event,\r | |
291 | TimerRelative,\r | |
292 | MTFTP6_GET_MAPPING_TIMEOUT * MTFTP6_TICK_PER_SECOND\r | |
293 | );\r | |
294 | if (EFI_ERROR (Status)) {\r | |
295 | goto ON_EXIT;\r | |
296 | }\r | |
297 | \r | |
298 | //\r | |
299 | // Check the Ip6 mode data till timeout.\r | |
300 | //\r | |
301 | while (EFI_ERROR (gBS->CheckEvent (Event))) {\r | |
302 | Udp6->Poll (Udp6);\r | |
303 | \r | |
304 | Status = Udp6->GetModeData (Udp6, NULL, &Ip6Mode, NULL, NULL);\r | |
305 | \r | |
306 | if (!EFI_ERROR (Status)) {\r | |
307 | if (Ip6Mode.AddressList != NULL) {\r | |
308 | FreePool (Ip6Mode.AddressList);\r | |
309 | }\r | |
310 | \r | |
311 | if (Ip6Mode.GroupTable != NULL) {\r | |
312 | FreePool (Ip6Mode.GroupTable);\r | |
313 | }\r | |
314 | \r | |
315 | if (Ip6Mode.RouteTable != NULL) {\r | |
316 | FreePool (Ip6Mode.RouteTable);\r | |
317 | }\r | |
318 | \r | |
319 | if (Ip6Mode.NeighborCache != NULL) {\r | |
320 | FreePool (Ip6Mode.NeighborCache);\r | |
321 | }\r | |
322 | \r | |
323 | if (Ip6Mode.PrefixTable != NULL) {\r | |
324 | FreePool (Ip6Mode.PrefixTable);\r | |
325 | }\r | |
326 | \r | |
327 | if (Ip6Mode.IcmpTypeList != NULL) {\r | |
328 | FreePool (Ip6Mode.IcmpTypeList);\r | |
329 | }\r | |
330 | \r | |
331 | if (Ip6Mode.IsConfigured) {\r | |
332 | //\r | |
333 | // Continue to configure the Udp6 instance.\r | |
334 | //\r | |
335 | Status = Udp6->Configure (Udp6, UdpCfgData);\r | |
336 | } else {\r | |
337 | Status = EFI_NO_MAPPING;\r | |
338 | }\r | |
339 | }\r | |
340 | }\r | |
341 | \r | |
342 | ON_EXIT:\r | |
343 | \r | |
344 | if (Event != NULL) {\r | |
345 | gBS->CloseEvent (Event);\r | |
346 | }\r | |
347 | \r | |
348 | return Status;\r | |
349 | }\r | |
350 | \r | |
351 | /**\r | |
352 | The dummy configure routine for create a new Udp6 Io.\r | |
353 | \r | |
354 | @param[in] UdpIo The pointer to the Udp6 Io.\r | |
355 | @param[in] Context The pointer to the context.\r | |
356 | \r | |
357 | @retval EFI_SUCCESS This value is always returned.\r | |
358 | \r | |
359 | **/\r | |
360 | EFI_STATUS\r | |
361 | EFIAPI\r | |
362 | Mtftp6ConfigDummyUdpIo (\r | |
363 | IN UDP_IO *UdpIo,\r | |
364 | IN VOID *Context\r | |
365 | )\r | |
366 | {\r | |
367 | return EFI_SUCCESS;\r | |
368 | }\r | |
369 | \r | |
370 | /**\r | |
371 | The configure routine for Mtftp6 instance to transmit/receive.\r | |
372 | \r | |
373 | @param[in] UdpIo The pointer to the Udp6 Io.\r | |
374 | @param[in] ServerIp The pointer to the server address.\r | |
375 | @param[in] ServerPort The pointer to the server port.\r | |
376 | @param[in] LocalIp The pointer to the local address.\r | |
377 | @param[in] LocalPort The pointer to the local port.\r | |
378 | \r | |
379 | @retval EFI_SUCCESS Configured the Udp6 Io for Mtftp6 successfully.\r | |
380 | @retval EFI_NO_MAPPING The corresponding Ip6 instance has not been\r | |
381 | configured yet.\r | |
382 | \r | |
383 | **/\r | |
384 | EFI_STATUS\r | |
385 | Mtftp6ConfigUdpIo (\r | |
386 | IN UDP_IO *UdpIo,\r | |
387 | IN EFI_IPv6_ADDRESS *ServerIp,\r | |
388 | IN UINT16 ServerPort,\r | |
389 | IN EFI_IPv6_ADDRESS *LocalIp,\r | |
390 | IN UINT16 LocalPort\r | |
391 | )\r | |
392 | {\r | |
393 | EFI_STATUS Status;\r | |
394 | EFI_UDP6_PROTOCOL *Udp6;\r | |
395 | EFI_UDP6_CONFIG_DATA *Udp6Cfg;\r | |
396 | \r | |
397 | Udp6 = UdpIo->Protocol.Udp6;\r | |
398 | Udp6Cfg = &(UdpIo->Config.Udp6);\r | |
399 | \r | |
400 | ZeroMem (Udp6Cfg, sizeof (EFI_UDP6_CONFIG_DATA));\r | |
401 | \r | |
402 | //\r | |
403 | // Set the Udp6 Io configure data.\r | |
404 | //\r | |
405 | Udp6Cfg->AcceptPromiscuous = FALSE;\r | |
406 | Udp6Cfg->AcceptAnyPort = FALSE;\r | |
407 | Udp6Cfg->AllowDuplicatePort = FALSE;\r | |
408 | Udp6Cfg->TrafficClass = 0;\r | |
409 | Udp6Cfg->HopLimit = 128;\r | |
410 | Udp6Cfg->ReceiveTimeout = 0;\r | |
411 | Udp6Cfg->TransmitTimeout = 0;\r | |
412 | Udp6Cfg->StationPort = LocalPort;\r | |
413 | Udp6Cfg->RemotePort = ServerPort;\r | |
414 | \r | |
415 | CopyMem (\r | |
416 | &Udp6Cfg->StationAddress,\r | |
417 | LocalIp,\r | |
418 | sizeof (EFI_IPv6_ADDRESS)\r | |
419 | );\r | |
420 | \r | |
421 | CopyMem (\r | |
422 | &Udp6Cfg->RemoteAddress,\r | |
423 | ServerIp,\r | |
424 | sizeof (EFI_IPv6_ADDRESS)\r | |
425 | );\r | |
426 | \r | |
427 | //\r | |
428 | // Configure the Udp6 instance with current configure data.\r | |
429 | //\r | |
430 | Status = Udp6->Configure (Udp6, Udp6Cfg);\r | |
431 | \r | |
432 | if (Status == EFI_NO_MAPPING) {\r | |
433 | return Mtftp6GetMapping (UdpIo, Udp6Cfg);\r | |
434 | }\r | |
435 | \r | |
436 | return Status;\r | |
437 | }\r | |
438 | \r | |
439 | /**\r | |
440 | Build and transmit the request packet for the Mtftp6 instance.\r | |
441 | \r | |
442 | @param[in] Instance The pointer to the Mtftp6 instance.\r | |
443 | @param[in] Operation The operation code of this packet.\r | |
444 | \r | |
445 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the request.\r | |
446 | @retval EFI_SUCCESS The request is built and sent.\r | |
447 | @retval Others Failed to transmit the packet.\r | |
448 | \r | |
449 | **/\r | |
450 | EFI_STATUS\r | |
451 | Mtftp6SendRequest (\r | |
452 | IN MTFTP6_INSTANCE *Instance,\r | |
453 | IN UINT16 Operation\r | |
454 | )\r | |
455 | {\r | |
456 | EFI_MTFTP6_PACKET *Packet;\r | |
457 | EFI_MTFTP6_OPTION *Options;\r | |
458 | EFI_MTFTP6_TOKEN *Token;\r | |
459 | RETURN_STATUS Status;\r | |
460 | NET_BUF *Nbuf;\r | |
461 | UINT8 *Mode;\r | |
462 | UINT8 *Cur;\r | |
463 | UINTN Index;\r | |
464 | UINT32 BufferLength;\r | |
465 | UINTN FileNameLength;\r | |
466 | UINTN ModeLength;\r | |
467 | UINTN OptionStrLength;\r | |
468 | UINTN ValueStrLength;\r | |
469 | \r | |
470 | Token = Instance->Token;\r | |
471 | Options = Token->OptionList;\r | |
472 | Mode = Token->ModeStr;\r | |
473 | \r | |
474 | if (Mode == NULL) {\r | |
475 | Mode = (UINT8 *)"octet";\r | |
476 | }\r | |
477 | \r | |
478 | //\r | |
479 | // The header format of RRQ/WRQ packet is:\r | |
480 | //\r | |
481 | // 2 bytes string 1 byte string 1 byte\r | |
482 | // ------------------------------------------------\r | |
483 | // | Opcode | Filename | 0 | Mode | 0 |\r | |
484 | // ------------------------------------------------\r | |
485 | //\r | |
486 | // The common option format is:\r | |
487 | //\r | |
488 | // string 1 byte string 1 byte\r | |
489 | // ---------------------------------------\r | |
490 | // | OptionStr | 0 | ValueStr | 0 |\r | |
491 | // ---------------------------------------\r | |
492 | //\r | |
493 | \r | |
494 | //\r | |
495 | // Compute the size of new Mtftp6 packet.\r | |
496 | //\r | |
497 | FileNameLength = AsciiStrLen ((CHAR8 *)Token->Filename);\r | |
498 | ModeLength = AsciiStrLen ((CHAR8 *)Mode);\r | |
499 | BufferLength = (UINT32)FileNameLength + (UINT32)ModeLength + 4;\r | |
500 | \r | |
501 | for (Index = 0; Index < Token->OptionCount; Index++) {\r | |
502 | OptionStrLength = AsciiStrLen ((CHAR8 *)Options[Index].OptionStr);\r | |
503 | ValueStrLength = AsciiStrLen ((CHAR8 *)Options[Index].ValueStr);\r | |
504 | BufferLength += (UINT32)OptionStrLength + (UINT32)ValueStrLength + 2;\r | |
505 | }\r | |
506 | \r | |
507 | //\r | |
508 | // Allocate a packet then copy the data.\r | |
509 | //\r | |
510 | if ((Nbuf = NetbufAlloc (BufferLength)) == NULL) {\r | |
511 | return EFI_OUT_OF_RESOURCES;\r | |
512 | }\r | |
513 | \r | |
514 | //\r | |
515 | // Copy the opcode, filename and mode into packet.\r | |
516 | //\r | |
517 | Packet = (EFI_MTFTP6_PACKET *)NetbufAllocSpace (Nbuf, BufferLength, FALSE);\r | |
518 | ASSERT (Packet != NULL);\r | |
519 | \r | |
520 | Packet->OpCode = HTONS (Operation);\r | |
521 | BufferLength -= sizeof (Packet->OpCode);\r | |
522 | \r | |
523 | Cur = Packet->Rrq.Filename;\r | |
524 | Status = AsciiStrCpyS ((CHAR8 *)Cur, BufferLength, (CHAR8 *)Token->Filename);\r | |
525 | ASSERT_EFI_ERROR (Status);\r | |
526 | BufferLength -= (UINT32)(FileNameLength + 1);\r | |
527 | Cur += FileNameLength + 1;\r | |
528 | Status = AsciiStrCpyS ((CHAR8 *)Cur, BufferLength, (CHAR8 *)Mode);\r | |
529 | ASSERT_EFI_ERROR (Status);\r | |
530 | BufferLength -= (UINT32)(ModeLength + 1);\r | |
531 | Cur += ModeLength + 1;\r | |
532 | \r | |
533 | //\r | |
534 | // Copy all the extension options into the packet.\r | |
535 | //\r | |
536 | for (Index = 0; Index < Token->OptionCount; ++Index) {\r | |
537 | OptionStrLength = AsciiStrLen ((CHAR8 *)Options[Index].OptionStr);\r | |
538 | ValueStrLength = AsciiStrLen ((CHAR8 *)Options[Index].ValueStr);\r | |
539 | \r | |
540 | Status = AsciiStrCpyS ((CHAR8 *)Cur, BufferLength, (CHAR8 *)Options[Index].OptionStr);\r | |
541 | ASSERT_EFI_ERROR (Status);\r | |
542 | BufferLength -= (UINT32)(OptionStrLength + 1);\r | |
543 | Cur += OptionStrLength + 1;\r | |
544 | \r | |
545 | Status = AsciiStrCpyS ((CHAR8 *)Cur, BufferLength, (CHAR8 *)Options[Index].ValueStr);\r | |
546 | ASSERT_EFI_ERROR (Status);\r | |
547 | BufferLength -= (UINT32)(ValueStrLength + 1);\r | |
548 | Cur += ValueStrLength + 1;\r | |
549 | }\r | |
550 | \r | |
551 | //\r | |
552 | // Save the packet buf for retransmit\r | |
553 | //\r | |
554 | if (Instance->LastPacket != NULL) {\r | |
555 | NetbufFree (Instance->LastPacket);\r | |
556 | }\r | |
557 | \r | |
558 | Instance->LastPacket = Nbuf;\r | |
559 | Instance->CurRetry = 0;\r | |
560 | \r | |
561 | return Mtftp6TransmitPacket (Instance, Nbuf);\r | |
562 | }\r | |
563 | \r | |
564 | /**\r | |
565 | Build and send an error packet.\r | |
566 | \r | |
567 | @param[in] Instance The pointer to the Mtftp6 instance.\r | |
568 | @param[in] ErrCode The error code in the packet.\r | |
569 | @param[in] ErrInfo The error message in the packet.\r | |
570 | \r | |
571 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the error packet.\r | |
572 | @retval EFI_SUCCESS The error packet is transmitted.\r | |
573 | @retval Others Failed to transmit the packet.\r | |
574 | \r | |
575 | **/\r | |
576 | EFI_STATUS\r | |
577 | Mtftp6SendError (\r | |
578 | IN MTFTP6_INSTANCE *Instance,\r | |
579 | IN UINT16 ErrCode,\r | |
580 | IN UINT8 *ErrInfo\r | |
581 | )\r | |
582 | {\r | |
583 | NET_BUF *Nbuf;\r | |
584 | EFI_MTFTP6_PACKET *TftpError;\r | |
585 | UINT32 Len;\r | |
586 | \r | |
587 | //\r | |
588 | // Allocate a packet then copy the data.\r | |
589 | //\r | |
590 | Len = (UINT32)(AsciiStrLen ((CHAR8 *)ErrInfo) + sizeof (EFI_MTFTP6_ERROR_HEADER));\r | |
591 | Nbuf = NetbufAlloc (Len);\r | |
592 | \r | |
593 | if (Nbuf == NULL) {\r | |
594 | return EFI_OUT_OF_RESOURCES;\r | |
595 | }\r | |
596 | \r | |
597 | TftpError = (EFI_MTFTP6_PACKET *)NetbufAllocSpace (Nbuf, Len, FALSE);\r | |
598 | \r | |
599 | if (TftpError == NULL) {\r | |
600 | NetbufFree (Nbuf);\r | |
601 | return EFI_OUT_OF_RESOURCES;\r | |
602 | }\r | |
603 | \r | |
604 | TftpError->OpCode = HTONS (EFI_MTFTP6_OPCODE_ERROR);\r | |
605 | TftpError->Error.ErrorCode = HTONS (ErrCode);\r | |
606 | \r | |
607 | AsciiStrCpyS ((CHAR8 *)TftpError->Error.ErrorMessage, AsciiStrLen ((CHAR8 *)ErrInfo) + 1, (CHAR8 *)ErrInfo);\r | |
608 | \r | |
609 | //\r | |
610 | // Save the packet buf for retransmit\r | |
611 | //\r | |
612 | if (Instance->LastPacket != NULL) {\r | |
613 | NetbufFree (Instance->LastPacket);\r | |
614 | }\r | |
615 | \r | |
616 | Instance->LastPacket = Nbuf;\r | |
617 | Instance->CurRetry = 0;\r | |
618 | \r | |
619 | return Mtftp6TransmitPacket (Instance, Nbuf);\r | |
620 | }\r | |
621 | \r | |
622 | /**\r | |
623 | The callback function called when the packet is transmitted.\r | |
624 | \r | |
625 | @param[in] Packet The pointer to the packet.\r | |
626 | @param[in] UdpEpt The pointer to the Udp6 access point.\r | |
627 | @param[in] IoStatus The result of the transmission.\r | |
628 | @param[in] Context The pointer to the context.\r | |
629 | \r | |
630 | **/\r | |
631 | VOID\r | |
632 | EFIAPI\r | |
633 | Mtftp6OnPacketSent (\r | |
634 | IN NET_BUF *Packet,\r | |
635 | IN UDP_END_POINT *UdpEpt,\r | |
636 | IN EFI_STATUS IoStatus,\r | |
637 | IN VOID *Context\r | |
638 | )\r | |
639 | {\r | |
640 | NetbufFree (Packet);\r | |
641 | *(BOOLEAN *)Context = TRUE;\r | |
642 | }\r | |
643 | \r | |
644 | /**\r | |
645 | Send the packet for the Mtftp6 instance.\r | |
646 | \r | |
647 | @param[in] Instance The pointer to the Mtftp6 instance.\r | |
648 | @param[in] Packet The pointer to the packet to be sent.\r | |
649 | \r | |
650 | @retval EFI_SUCCESS The packet was sent out\r | |
651 | @retval Others Failed to transmit the packet.\r | |
652 | \r | |
653 | **/\r | |
654 | EFI_STATUS\r | |
655 | Mtftp6TransmitPacket (\r | |
656 | IN MTFTP6_INSTANCE *Instance,\r | |
657 | IN NET_BUF *Packet\r | |
658 | )\r | |
659 | {\r | |
660 | EFI_UDP6_PROTOCOL *Udp6;\r | |
661 | EFI_UDP6_CONFIG_DATA Udp6CfgData;\r | |
662 | EFI_STATUS Status;\r | |
663 | UINT16 *Temp;\r | |
664 | UINT16 Value;\r | |
665 | UINT16 OpCode;\r | |
666 | \r | |
667 | ZeroMem (&Udp6CfgData, sizeof (EFI_UDP6_CONFIG_DATA));\r | |
668 | Udp6 = Instance->UdpIo->Protocol.Udp6;\r | |
669 | \r | |
670 | //\r | |
671 | // Set the live time of the packet.\r | |
672 | //\r | |
673 | Instance->PacketToLive = Instance->IsMaster ? Instance->Timeout : (Instance->Timeout * 2);\r | |
674 | \r | |
675 | Temp = (UINT16 *)NetbufGetByte (Packet, 0, NULL);\r | |
676 | ASSERT (Temp != NULL);\r | |
677 | \r | |
678 | Value = *Temp;\r | |
679 | OpCode = NTOHS (Value);\r | |
680 | \r | |
681 | if ((OpCode == EFI_MTFTP6_OPCODE_RRQ) || (OpCode == EFI_MTFTP6_OPCODE_DIR) || (OpCode == EFI_MTFTP6_OPCODE_WRQ)) {\r | |
682 | //\r | |
683 | // For the Rrq, Dir, Wrq requests of the operation, configure the Udp6Io as\r | |
684 | // (serverip, 69, localip, localport) to send.\r | |
685 | // Usually local address and local port are both default as zero.\r | |
686 | //\r | |
687 | Status = Udp6->Configure (Udp6, NULL);\r | |
688 | \r | |
689 | if (EFI_ERROR (Status)) {\r | |
690 | return Status;\r | |
691 | }\r | |
692 | \r | |
693 | Status = Mtftp6ConfigUdpIo (\r | |
694 | Instance->UdpIo,\r | |
695 | &Instance->ServerIp,\r | |
696 | Instance->ServerCmdPort,\r | |
697 | &Instance->Config->StationIp,\r | |
698 | Instance->Config->LocalPort\r | |
699 | );\r | |
700 | \r | |
701 | if (EFI_ERROR (Status)) {\r | |
702 | return Status;\r | |
703 | }\r | |
704 | \r | |
705 | //\r | |
706 | // Get the current local address and port by get Udp6 mode data.\r | |
707 | //\r | |
708 | Status = Udp6->GetModeData (Udp6, &Udp6CfgData, NULL, NULL, NULL);\r | |
709 | if (EFI_ERROR (Status)) {\r | |
710 | return Status;\r | |
711 | }\r | |
712 | \r | |
713 | NET_GET_REF (Packet);\r | |
714 | \r | |
715 | Instance->IsTransmitted = FALSE;\r | |
716 | \r | |
717 | Status = UdpIoSendDatagram (\r | |
718 | Instance->UdpIo,\r | |
719 | Packet,\r | |
720 | NULL,\r | |
721 | NULL,\r | |
722 | Mtftp6OnPacketSent,\r | |
723 | &Instance->IsTransmitted\r | |
724 | );\r | |
725 | \r | |
726 | if (EFI_ERROR (Status)) {\r | |
727 | NET_PUT_REF (Packet);\r | |
728 | return Status;\r | |
729 | }\r | |
730 | \r | |
731 | //\r | |
732 | // Poll till the packet sent out from the ip6 queue.\r | |
733 | //\r | |
734 | gBS->RestoreTPL (Instance->OldTpl);\r | |
735 | \r | |
736 | while (!Instance->IsTransmitted) {\r | |
737 | Udp6->Poll (Udp6);\r | |
738 | }\r | |
739 | \r | |
740 | Instance->OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
741 | \r | |
742 | //\r | |
743 | // For the subsequent exchange of such requests, reconfigure the Udp6Io as\r | |
744 | // (serverip, 0, localip, localport) to receive.\r | |
745 | // Currently local address and local port are specified by Udp6 mode data.\r | |
746 | //\r | |
747 | Status = Udp6->Configure (Udp6, NULL);\r | |
748 | \r | |
749 | if (EFI_ERROR (Status)) {\r | |
750 | return Status;\r | |
751 | }\r | |
752 | \r | |
753 | Status = Mtftp6ConfigUdpIo (\r | |
754 | Instance->UdpIo,\r | |
755 | &Instance->ServerIp,\r | |
756 | Instance->ServerDataPort,\r | |
757 | &Udp6CfgData.StationAddress,\r | |
758 | Udp6CfgData.StationPort\r | |
759 | );\r | |
760 | } else {\r | |
761 | //\r | |
762 | // For the data exchange, configure the Udp6Io as (serverip, dataport,\r | |
763 | // localip, localport) to send/receive.\r | |
764 | // Currently local address and local port are specified by Udp6 mode data.\r | |
765 | //\r | |
766 | Status = Udp6->GetModeData (Udp6, &Udp6CfgData, NULL, NULL, NULL);\r | |
767 | if (EFI_ERROR (Status)) {\r | |
768 | return Status;\r | |
769 | }\r | |
770 | \r | |
771 | if (Udp6CfgData.RemotePort != Instance->ServerDataPort) {\r | |
772 | Status = Udp6->Configure (Udp6, NULL);\r | |
773 | \r | |
774 | if (EFI_ERROR (Status)) {\r | |
775 | return Status;\r | |
776 | }\r | |
777 | \r | |
778 | Status = Mtftp6ConfigUdpIo (\r | |
779 | Instance->UdpIo,\r | |
780 | &Instance->ServerIp,\r | |
781 | Instance->ServerDataPort,\r | |
782 | &Udp6CfgData.StationAddress,\r | |
783 | Udp6CfgData.StationPort\r | |
784 | );\r | |
785 | \r | |
786 | if (EFI_ERROR (Status)) {\r | |
787 | return Status;\r | |
788 | }\r | |
789 | }\r | |
790 | \r | |
791 | NET_GET_REF (Packet);\r | |
792 | \r | |
793 | Instance->IsTransmitted = FALSE;\r | |
794 | \r | |
795 | Status = UdpIoSendDatagram (\r | |
796 | Instance->UdpIo,\r | |
797 | Packet,\r | |
798 | NULL,\r | |
799 | NULL,\r | |
800 | Mtftp6OnPacketSent,\r | |
801 | &Instance->IsTransmitted\r | |
802 | );\r | |
803 | \r | |
804 | if (EFI_ERROR (Status)) {\r | |
805 | NET_PUT_REF (Packet);\r | |
806 | }\r | |
807 | \r | |
808 | //\r | |
809 | // Poll till the packet sent out from the ip6 queue.\r | |
810 | //\r | |
811 | gBS->RestoreTPL (Instance->OldTpl);\r | |
812 | \r | |
813 | while (!Instance->IsTransmitted) {\r | |
814 | Udp6->Poll (Udp6);\r | |
815 | }\r | |
816 | \r | |
817 | Instance->OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
818 | }\r | |
819 | \r | |
820 | return Status;\r | |
821 | }\r | |
822 | \r | |
823 | /**\r | |
824 | Check packet for GetInfo callback routine.\r | |
825 | \r | |
826 | GetInfo is implemented with EfiMtftp6ReadFile. It's used to inspect\r | |
827 | the first packet from server, then abort the session.\r | |
828 | \r | |
829 | @param[in] This The pointer to the Mtftp6 protocol.\r | |
830 | @param[in] Token The pointer to the Mtftp6 token.\r | |
831 | @param[in] PacketLen The length of the packet.\r | |
832 | @param[in] Packet The pointer to the received packet.\r | |
833 | \r | |
834 | @retval EFI_ABORTED Abort the Mtftp6 operation.\r | |
835 | \r | |
836 | **/\r | |
837 | EFI_STATUS\r | |
838 | EFIAPI\r | |
839 | Mtftp6CheckPacket (\r | |
840 | IN EFI_MTFTP6_PROTOCOL *This,\r | |
841 | IN EFI_MTFTP6_TOKEN *Token,\r | |
842 | IN UINT16 PacketLen,\r | |
843 | IN EFI_MTFTP6_PACKET *Packet\r | |
844 | )\r | |
845 | {\r | |
846 | MTFTP6_GETINFO_CONTEXT *Context;\r | |
847 | UINT16 OpCode;\r | |
848 | \r | |
849 | Context = (MTFTP6_GETINFO_CONTEXT *)Token->Context;\r | |
850 | OpCode = NTOHS (Packet->OpCode);\r | |
851 | \r | |
852 | //\r | |
853 | // Set the GetInfo's return status according to the OpCode.\r | |
854 | //\r | |
855 | switch (OpCode) {\r | |
856 | case EFI_MTFTP6_OPCODE_ERROR:\r | |
857 | Context->Status = EFI_TFTP_ERROR;\r | |
858 | break;\r | |
859 | \r | |
860 | case EFI_MTFTP6_OPCODE_OACK:\r | |
861 | Context->Status = EFI_SUCCESS;\r | |
862 | break;\r | |
863 | \r | |
864 | default:\r | |
865 | Context->Status = EFI_PROTOCOL_ERROR;\r | |
866 | }\r | |
867 | \r | |
868 | //\r | |
869 | // Allocate buffer then copy the packet over. Use gBS->AllocatePool\r | |
870 | // in case NetAllocatePool will implements something tricky.\r | |
871 | //\r | |
872 | *(Context->Packet) = AllocateZeroPool (PacketLen);\r | |
873 | \r | |
874 | if (*(Context->Packet) == NULL) {\r | |
875 | Context->Status = EFI_OUT_OF_RESOURCES;\r | |
876 | return EFI_ABORTED;\r | |
877 | }\r | |
878 | \r | |
879 | *(Context->PacketLen) = PacketLen;\r | |
880 | CopyMem (*(Context->Packet), Packet, PacketLen);\r | |
881 | \r | |
882 | return EFI_ABORTED;\r | |
883 | }\r | |
884 | \r | |
885 | /**\r | |
886 | Clean up the current Mtftp6 operation.\r | |
887 | \r | |
888 | @param[in] Instance The pointer to the Mtftp6 instance.\r | |
889 | @param[in] Result The result to be returned to the user.\r | |
890 | \r | |
891 | **/\r | |
892 | VOID\r | |
893 | Mtftp6OperationClean (\r | |
894 | IN MTFTP6_INSTANCE *Instance,\r | |
895 | IN EFI_STATUS Result\r | |
896 | )\r | |
897 | {\r | |
898 | LIST_ENTRY *Entry;\r | |
899 | LIST_ENTRY *Next;\r | |
900 | MTFTP6_BLOCK_RANGE *Block;\r | |
901 | \r | |
902 | //\r | |
903 | // Clean up the current token and event.\r | |
904 | //\r | |
905 | if (Instance->Token != NULL) {\r | |
906 | Instance->Token->Status = Result;\r | |
907 | if (Instance->Token->Event != NULL) {\r | |
908 | gBS->SignalEvent (Instance->Token->Event);\r | |
909 | }\r | |
910 | \r | |
911 | Instance->Token = NULL;\r | |
912 | }\r | |
913 | \r | |
914 | //\r | |
915 | // Clean up the corresponding Udp6Io.\r | |
916 | //\r | |
917 | if (Instance->UdpIo != NULL) {\r | |
918 | UdpIoCleanIo (Instance->UdpIo);\r | |
919 | }\r | |
920 | \r | |
921 | if (Instance->McastUdpIo != NULL) {\r | |
922 | gBS->CloseProtocol (\r | |
923 | Instance->McastUdpIo->UdpHandle,\r | |
924 | &gEfiUdp6ProtocolGuid,\r | |
925 | Instance->McastUdpIo->Image,\r | |
926 | Instance->Handle\r | |
927 | );\r | |
928 | UdpIoFreeIo (Instance->McastUdpIo);\r | |
929 | Instance->McastUdpIo = NULL;\r | |
930 | }\r | |
931 | \r | |
932 | //\r | |
933 | // Clean up the stored last packet.\r | |
934 | //\r | |
935 | if (Instance->LastPacket != NULL) {\r | |
936 | NetbufFree (Instance->LastPacket);\r | |
937 | Instance->LastPacket = NULL;\r | |
938 | }\r | |
939 | \r | |
940 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->BlkList) {\r | |
941 | Block = NET_LIST_USER_STRUCT (Entry, MTFTP6_BLOCK_RANGE, Link);\r | |
942 | RemoveEntryList (Entry);\r | |
943 | FreePool (Block);\r | |
944 | }\r | |
945 | \r | |
946 | //\r | |
947 | // Reinitialize the corresponding fields of the Mtftp6 operation.\r | |
948 | //\r | |
949 | ZeroMem (&Instance->ExtInfo, sizeof (MTFTP6_EXT_OPTION_INFO));\r | |
950 | ZeroMem (&Instance->ServerIp, sizeof (EFI_IPv6_ADDRESS));\r | |
951 | ZeroMem (&Instance->McastIp, sizeof (EFI_IPv6_ADDRESS));\r | |
952 | \r | |
953 | Instance->ServerCmdPort = 0;\r | |
954 | Instance->ServerDataPort = 0;\r | |
955 | Instance->McastPort = 0;\r | |
956 | Instance->BlkSize = 0;\r | |
957 | Instance->Operation = 0;\r | |
958 | Instance->WindowSize = 1;\r | |
959 | Instance->TotalBlock = 0;\r | |
960 | Instance->AckedBlock = 0;\r | |
961 | Instance->LastBlk = 0;\r | |
962 | Instance->PacketToLive = 0;\r | |
963 | Instance->MaxRetry = 0;\r | |
964 | Instance->CurRetry = 0;\r | |
965 | Instance->Timeout = 0;\r | |
966 | Instance->IsMaster = TRUE;\r | |
967 | }\r | |
968 | \r | |
969 | /**\r | |
970 | Start the Mtftp6 instance to perform the operation, such as read file,\r | |
971 | write file, and read directory.\r | |
972 | \r | |
973 | @param[in] This The MTFTP session.\r | |
974 | @param[in] Token The token than encapsules the user's request.\r | |
975 | @param[in] OpCode The operation to perform.\r | |
976 | \r | |
977 | @retval EFI_INVALID_PARAMETER Some of the parameters are invalid.\r | |
978 | @retval EFI_NOT_STARTED The MTFTP session hasn't been configured.\r | |
979 | @retval EFI_ALREADY_STARTED There is pending operation for the session.\r | |
980 | @retval EFI_SUCCESS The operation is successfully started.\r | |
981 | \r | |
982 | **/\r | |
983 | EFI_STATUS\r | |
984 | Mtftp6OperationStart (\r | |
985 | IN EFI_MTFTP6_PROTOCOL *This,\r | |
986 | IN EFI_MTFTP6_TOKEN *Token,\r | |
987 | IN UINT16 OpCode\r | |
988 | )\r | |
989 | {\r | |
990 | MTFTP6_INSTANCE *Instance;\r | |
991 | EFI_STATUS Status;\r | |
992 | \r | |
993 | if ((This == NULL) ||\r | |
994 | (Token == NULL) ||\r | |
995 | (Token->Filename == NULL) ||\r | |
996 | ((Token->OptionCount != 0) && (Token->OptionList == NULL)) ||\r | |
997 | ((Token->OverrideData != NULL) && !NetIp6IsValidUnicast (&Token->OverrideData->ServerIp))\r | |
998 | )\r | |
999 | {\r | |
1000 | return EFI_INVALID_PARAMETER;\r | |
1001 | }\r | |
1002 | \r | |
1003 | //\r | |
1004 | // At least define one method to collect the data for download.\r | |
1005 | //\r | |
1006 | if (((OpCode == EFI_MTFTP6_OPCODE_RRQ) || (OpCode == EFI_MTFTP6_OPCODE_DIR)) &&\r | |
1007 | (Token->Buffer == NULL) &&\r | |
1008 | (Token->CheckPacket == NULL)\r | |
1009 | )\r | |
1010 | {\r | |
1011 | return EFI_INVALID_PARAMETER;\r | |
1012 | }\r | |
1013 | \r | |
1014 | //\r | |
1015 | // At least define one method to provide the data for upload.\r | |
1016 | //\r | |
1017 | if ((OpCode == EFI_MTFTP6_OPCODE_WRQ) && (Token->Buffer == NULL) && (Token->PacketNeeded == NULL)) {\r | |
1018 | return EFI_INVALID_PARAMETER;\r | |
1019 | }\r | |
1020 | \r | |
1021 | Instance = MTFTP6_INSTANCE_FROM_THIS (This);\r | |
1022 | \r | |
1023 | if (Instance->Config == NULL) {\r | |
1024 | return EFI_NOT_STARTED;\r | |
1025 | }\r | |
1026 | \r | |
1027 | if (Instance->Token != NULL) {\r | |
1028 | return EFI_ACCESS_DENIED;\r | |
1029 | }\r | |
1030 | \r | |
1031 | Status = EFI_SUCCESS;\r | |
1032 | Instance->OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
1033 | \r | |
1034 | Instance->Operation = OpCode;\r | |
1035 | \r | |
1036 | //\r | |
1037 | // Parse the extension options in the request packet.\r | |
1038 | //\r | |
1039 | if (Token->OptionCount != 0) {\r | |
1040 | Status = Mtftp6ParseExtensionOption (\r | |
1041 | Token->OptionList,\r | |
1042 | Token->OptionCount,\r | |
1043 | TRUE,\r | |
1044 | Instance->Operation,\r | |
1045 | &Instance->ExtInfo\r | |
1046 | );\r | |
1047 | \r | |
1048 | if (EFI_ERROR (Status)) {\r | |
1049 | goto ON_ERROR;\r | |
1050 | }\r | |
1051 | }\r | |
1052 | \r | |
1053 | //\r | |
1054 | // Initialize runtime data from config data or override data.\r | |
1055 | //\r | |
1056 | Instance->Token = Token;\r | |
1057 | Instance->ServerCmdPort = Instance->Config->InitialServerPort;\r | |
1058 | Instance->ServerDataPort = 0;\r | |
1059 | Instance->MaxRetry = Instance->Config->TryCount;\r | |
1060 | Instance->Timeout = Instance->Config->TimeoutValue;\r | |
1061 | Instance->IsMaster = TRUE;\r | |
1062 | \r | |
1063 | CopyMem (\r | |
1064 | &Instance->ServerIp,\r | |
1065 | &Instance->Config->ServerIp,\r | |
1066 | sizeof (EFI_IPv6_ADDRESS)\r | |
1067 | );\r | |
1068 | \r | |
1069 | if (Token->OverrideData != NULL) {\r | |
1070 | Instance->ServerCmdPort = Token->OverrideData->ServerPort;\r | |
1071 | Instance->MaxRetry = Token->OverrideData->TryCount;\r | |
1072 | Instance->Timeout = Token->OverrideData->TimeoutValue;\r | |
1073 | \r | |
1074 | CopyMem (\r | |
1075 | &Instance->ServerIp,\r | |
1076 | &Token->OverrideData->ServerIp,\r | |
1077 | sizeof (EFI_IPv6_ADDRESS)\r | |
1078 | );\r | |
1079 | }\r | |
1080 | \r | |
1081 | //\r | |
1082 | // Set default value for undefined parameters.\r | |
1083 | //\r | |
1084 | if (Instance->ServerCmdPort == 0) {\r | |
1085 | Instance->ServerCmdPort = MTFTP6_DEFAULT_SERVER_CMD_PORT;\r | |
1086 | }\r | |
1087 | \r | |
1088 | if (Instance->BlkSize == 0) {\r | |
1089 | Instance->BlkSize = MTFTP6_DEFAULT_BLK_SIZE;\r | |
1090 | }\r | |
1091 | \r | |
1092 | if (Instance->WindowSize == 0) {\r | |
1093 | Instance->WindowSize = MTFTP6_DEFAULT_WINDOWSIZE;\r | |
1094 | }\r | |
1095 | \r | |
1096 | if (Instance->MaxRetry == 0) {\r | |
1097 | Instance->MaxRetry = MTFTP6_DEFAULT_MAX_RETRY;\r | |
1098 | }\r | |
1099 | \r | |
1100 | if (Instance->Timeout == 0) {\r | |
1101 | Instance->Timeout = MTFTP6_DEFAULT_TIMEOUT;\r | |
1102 | }\r | |
1103 | \r | |
1104 | Token->Status = EFI_NOT_READY;\r | |
1105 | \r | |
1106 | //\r | |
1107 | // Switch the routines by the operation code.\r | |
1108 | //\r | |
1109 | switch (OpCode) {\r | |
1110 | case EFI_MTFTP6_OPCODE_RRQ:\r | |
1111 | Status = Mtftp6RrqStart (Instance, OpCode);\r | |
1112 | break;\r | |
1113 | \r | |
1114 | case EFI_MTFTP6_OPCODE_DIR:\r | |
1115 | Status = Mtftp6RrqStart (Instance, OpCode);\r | |
1116 | break;\r | |
1117 | \r | |
1118 | case EFI_MTFTP6_OPCODE_WRQ:\r | |
1119 | Status = Mtftp6WrqStart (Instance, OpCode);\r | |
1120 | break;\r | |
1121 | \r | |
1122 | default:\r | |
1123 | Status = EFI_DEVICE_ERROR;\r | |
1124 | goto ON_ERROR;\r | |
1125 | }\r | |
1126 | \r | |
1127 | if (EFI_ERROR (Status)) {\r | |
1128 | goto ON_ERROR;\r | |
1129 | }\r | |
1130 | \r | |
1131 | //\r | |
1132 | // Return immediately for asynchronous or poll the instance for synchronous.\r | |
1133 | //\r | |
1134 | gBS->RestoreTPL (Instance->OldTpl);\r | |
1135 | \r | |
1136 | if (Token->Event == NULL) {\r | |
1137 | while (Token->Status == EFI_NOT_READY) {\r | |
1138 | This->Poll (This);\r | |
1139 | }\r | |
1140 | \r | |
1141 | return Token->Status;\r | |
1142 | }\r | |
1143 | \r | |
1144 | return EFI_SUCCESS;\r | |
1145 | \r | |
1146 | ON_ERROR:\r | |
1147 | \r | |
1148 | Mtftp6OperationClean (Instance, Status);\r | |
1149 | gBS->RestoreTPL (Instance->OldTpl);\r | |
1150 | \r | |
1151 | return Status;\r | |
1152 | }\r | |
1153 | \r | |
1154 | /**\r | |
1155 | The timer ticking routine for the Mtftp6 instance.\r | |
1156 | \r | |
1157 | @param[in] Event The pointer to the ticking event.\r | |
1158 | @param[in] Context The pointer to the context.\r | |
1159 | \r | |
1160 | **/\r | |
1161 | VOID\r | |
1162 | EFIAPI\r | |
1163 | Mtftp6OnTimerTick (\r | |
1164 | IN EFI_EVENT Event,\r | |
1165 | IN VOID *Context\r | |
1166 | )\r | |
1167 | {\r | |
1168 | MTFTP6_SERVICE *Service;\r | |
1169 | MTFTP6_INSTANCE *Instance;\r | |
1170 | LIST_ENTRY *Entry;\r | |
1171 | LIST_ENTRY *Next;\r | |
1172 | EFI_MTFTP6_TOKEN *Token;\r | |
1173 | EFI_STATUS Status;\r | |
1174 | \r | |
1175 | Service = (MTFTP6_SERVICE *)Context;\r | |
1176 | \r | |
1177 | //\r | |
1178 | // Iterate through all the children of the Mtftp service instance. Time\r | |
1179 | // out the packet. If maximum retries reached, clean the session up.\r | |
1180 | //\r | |
1181 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Service->Children) {\r | |
1182 | Instance = NET_LIST_USER_STRUCT (Entry, MTFTP6_INSTANCE, Link);\r | |
1183 | \r | |
1184 | if (Instance->Token == NULL) {\r | |
1185 | continue;\r | |
1186 | }\r | |
1187 | \r | |
1188 | if (Instance->PacketToLive > 0) {\r | |
1189 | Instance->PacketToLive--;\r | |
1190 | continue;\r | |
1191 | }\r | |
1192 | \r | |
1193 | Instance->CurRetry++;\r | |
1194 | Token = Instance->Token;\r | |
1195 | \r | |
1196 | if (Token->TimeoutCallback != NULL) {\r | |
1197 | //\r | |
1198 | // Call the timeout callback routine if has.\r | |
1199 | //\r | |
1200 | Status = Token->TimeoutCallback (&Instance->Mtftp6, Token);\r | |
1201 | \r | |
1202 | if (EFI_ERROR (Status)) {\r | |
1203 | Mtftp6SendError (\r | |
1204 | Instance,\r | |
1205 | EFI_MTFTP6_ERRORCODE_REQUEST_DENIED,\r | |
1206 | (UINT8 *)"User aborted the transfer in time out"\r | |
1207 | );\r | |
1208 | Mtftp6OperationClean (Instance, EFI_ABORTED);\r | |
1209 | continue;\r | |
1210 | }\r | |
1211 | }\r | |
1212 | \r | |
1213 | //\r | |
1214 | // Retransmit the packet if haven't reach the maximum retry count,\r | |
1215 | // otherwise exit the transfer.\r | |
1216 | //\r | |
1217 | if (Instance->CurRetry < Instance->MaxRetry) {\r | |
1218 | Mtftp6TransmitPacket (Instance, Instance->LastPacket);\r | |
1219 | } else {\r | |
1220 | Mtftp6OperationClean (Instance, EFI_TIMEOUT);\r | |
1221 | continue;\r | |
1222 | }\r | |
1223 | }\r | |
1224 | }\r |