]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
dab714aa | 2 | Routines to process Rrq (download).\r |
3 | \r | |
f1f11ea2 | 4 | Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 5 | This program and the accompanying materials\r |
772db4bb | 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 | |
dab714aa | 8 | http://opensource.org/licenses/bsd-license.php<BR>\r |
772db4bb | 9 | \r |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
12 | \r | |
dab714aa | 13 | **/\r |
772db4bb | 14 | \r |
772db4bb | 15 | \r |
dab714aa | 16 | #include "Mtftp4Impl.h"\r |
772db4bb | 17 | \r |
18 | \r | |
dab714aa | 19 | /**\r |
20 | The packet process callback for MTFTP download.\r | |
772db4bb | 21 | \r |
dab714aa | 22 | @param UdpPacket The packet received\r |
b45b45b2 | 23 | @param EndPoint The local/remote access point of the packet\r |
dab714aa | 24 | @param IoStatus The status of the receiving\r |
25 | @param Context Opaque parameter, which is the MTFTP session\r | |
772db4bb | 26 | \r |
dab714aa | 27 | **/\r |
772db4bb | 28 | VOID\r |
e798cd87 | 29 | EFIAPI\r |
772db4bb | 30 | Mtftp4RrqInput (\r |
31 | IN NET_BUF *UdpPacket,\r | |
b45b45b2 | 32 | IN UDP_END_POINT *EndPoint,\r |
772db4bb | 33 | IN EFI_STATUS IoStatus,\r |
34 | IN VOID *Context\r | |
35 | );\r | |
36 | \r | |
37 | \r | |
38 | /**\r | |
dab714aa | 39 | Start the MTFTP session to download. \r |
40 | \r | |
41 | It will first initialize some of the internal states then build and send a RRQ \r | |
42 | reqeuest packet, at last, it will start receive for the downloading.\r | |
772db4bb | 43 | \r |
44 | @param Instance The Mtftp session\r | |
45 | @param Operation The MTFTP opcode, it may be a EFI_MTFTP4_OPCODE_RRQ\r | |
46 | or EFI_MTFTP4_OPCODE_DIR.\r | |
47 | \r | |
48 | @retval EFI_SUCCESS The mtftp download session is started.\r | |
49 | @retval Others Failed to start downloading.\r | |
50 | \r | |
51 | **/\r | |
52 | EFI_STATUS\r | |
53 | Mtftp4RrqStart (\r | |
54 | IN MTFTP4_PROTOCOL *Instance,\r | |
55 | IN UINT16 Operation\r | |
56 | )\r | |
57 | {\r | |
58 | EFI_STATUS Status;\r | |
59 | \r | |
60 | //\r | |
61 | // The valid block number range are [1, 0xffff]. For example:\r | |
62 | // the client sends an RRQ request to the server, the server\r | |
63 | // transfers the DATA1 block. If option negoitation is ongoing,\r | |
64 | // the server will send back an OACK, then client will send ACK0.\r | |
65 | //\r | |
66 | Status = Mtftp4InitBlockRange (&Instance->Blocks, 1, 0xffff);\r | |
67 | \r | |
68 | if (EFI_ERROR (Status)) {\r | |
69 | return Status;\r | |
70 | }\r | |
71 | \r | |
72 | Status = Mtftp4SendRequest (Instance);\r | |
73 | \r | |
74 | if (EFI_ERROR (Status)) {\r | |
75 | return Status;\r | |
76 | }\r | |
77 | \r | |
78 | return UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r | |
79 | }\r | |
80 | \r | |
81 | \r | |
82 | /**\r | |
83 | Build and send a ACK packet for the download session.\r | |
84 | \r | |
85 | @param Instance The Mtftp session\r | |
86 | @param BlkNo The BlkNo to ack.\r | |
87 | \r | |
88 | @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet\r | |
89 | @retval EFI_SUCCESS The ACK has been sent\r | |
90 | @retval Others Failed to send the ACK.\r | |
91 | \r | |
92 | **/\r | |
93 | EFI_STATUS\r | |
94 | Mtftp4RrqSendAck (\r | |
95 | IN MTFTP4_PROTOCOL *Instance,\r | |
96 | IN UINT16 BlkNo\r | |
97 | )\r | |
98 | {\r | |
99 | EFI_MTFTP4_PACKET *Ack;\r | |
100 | NET_BUF *Packet;\r | |
101 | \r | |
102 | Packet = NetbufAlloc (sizeof (EFI_MTFTP4_ACK_HEADER));\r | |
772db4bb | 103 | if (Packet == NULL) {\r |
104 | return EFI_OUT_OF_RESOURCES;\r | |
105 | }\r | |
106 | \r | |
107 | Ack = (EFI_MTFTP4_PACKET *) NetbufAllocSpace (\r | |
108 | Packet,\r | |
109 | sizeof (EFI_MTFTP4_ACK_HEADER),\r | |
110 | FALSE\r | |
111 | );\r | |
894d038a | 112 | ASSERT (Ack != NULL);\r |
772db4bb | 113 | \r |
114 | Ack->Ack.OpCode = HTONS (EFI_MTFTP4_OPCODE_ACK);\r | |
115 | Ack->Ack.Block[0] = HTONS (BlkNo);\r | |
116 | \r | |
117 | return Mtftp4SendPacket (Instance, Packet);\r | |
118 | }\r | |
119 | \r | |
120 | \r | |
121 | /**\r | |
122 | Deliver the received data block to the user, which can be saved\r | |
123 | in the user provide buffer or through the CheckPacket callback.\r | |
124 | \r | |
125 | @param Instance The Mtftp session\r | |
126 | @param Packet The received data packet\r | |
127 | @param Len The packet length\r | |
128 | \r | |
129 | @retval EFI_SUCCESS The data is saved successfully\r | |
130 | @retval EFI_ABORTED The user tells to abort by return an error through\r | |
131 | CheckPacket\r | |
132 | @retval EFI_BUFFER_TOO_SMALL The user's buffer is too small and buffer length is\r | |
133 | updated to the actual buffer size needed.\r | |
134 | \r | |
135 | **/\r | |
136 | EFI_STATUS\r | |
137 | Mtftp4RrqSaveBlock (\r | |
dab714aa | 138 | IN OUT MTFTP4_PROTOCOL *Instance,\r |
139 | IN EFI_MTFTP4_PACKET *Packet,\r | |
140 | IN UINT32 Len\r | |
772db4bb | 141 | )\r |
142 | {\r | |
143 | EFI_MTFTP4_TOKEN *Token;\r | |
144 | EFI_STATUS Status;\r | |
145 | UINT16 Block;\r | |
146 | UINT64 Start;\r | |
147 | UINT32 DataLen;\r | |
f1f11ea2 | 148 | UINT64 TotalBlock;\r |
149 | BOOLEAN Completed;\r | |
772db4bb | 150 | \r |
f1f11ea2 | 151 | Completed = FALSE;\r |
152 | Token = Instance->Token;\r | |
153 | Block = NTOHS (Packet->Data.Block);\r | |
154 | DataLen = Len - MTFTP4_DATA_HEAD_LEN;\r | |
772db4bb | 155 | \r |
156 | //\r | |
157 | // This is the last block, save the block no\r | |
158 | //\r | |
159 | if (DataLen < Instance->BlkSize) {\r | |
f1f11ea2 | 160 | Completed = TRUE;\r |
772db4bb | 161 | Instance->LastBlock = Block;\r |
162 | Mtftp4SetLastBlockNum (&Instance->Blocks, Block);\r | |
163 | }\r | |
164 | \r | |
165 | //\r | |
166 | // Remove this block number from the file hole. If Mtftp4RemoveBlockNum\r | |
167 | // returns EFI_NOT_FOUND, the block has been saved, don't save it again.\r | |
f1f11ea2 | 168 | // Note that : For bigger files, allowing the block counter to roll over\r |
169 | // to accept transfers of unlimited size. So TotalBlock is memorised as \r | |
170 | // continuous block counter.\r | |
772db4bb | 171 | //\r |
49fd66cb | 172 | Status = Mtftp4RemoveBlockNum (&Instance->Blocks, Block, Completed, &TotalBlock);\r |
772db4bb | 173 | \r |
174 | if (Status == EFI_NOT_FOUND) {\r | |
175 | return EFI_SUCCESS;\r | |
176 | } else if (EFI_ERROR (Status)) {\r | |
177 | return Status;\r | |
178 | }\r | |
179 | \r | |
180 | if (Token->CheckPacket != NULL) {\r | |
181 | Status = Token->CheckPacket (&Instance->Mtftp4, Token, (UINT16) Len, Packet);\r | |
182 | \r | |
183 | if (EFI_ERROR (Status)) {\r | |
184 | Mtftp4SendError (\r | |
185 | Instance,\r | |
186 | EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r | |
67a58d0f | 187 | (UINT8 *) "User aborted download"\r |
772db4bb | 188 | );\r |
189 | \r | |
190 | return EFI_ABORTED;\r | |
191 | }\r | |
192 | }\r | |
193 | \r | |
194 | if (Token->Buffer != NULL) {\r | |
f1f11ea2 | 195 | Start = MultU64x32 (TotalBlock - 1, Instance->BlkSize);\r |
772db4bb | 196 | \r |
197 | if (Start + DataLen <= Token->BufferSize) {\r | |
e48e37fc | 198 | CopyMem ((UINT8 *) Token->Buffer + Start, Packet->Data.Data, DataLen);\r |
772db4bb | 199 | \r |
200 | //\r | |
201 | // Update the file size when received the last block\r | |
202 | //\r | |
f1f11ea2 | 203 | if ((Instance->LastBlock == Block) && Completed) {\r |
772db4bb | 204 | Token->BufferSize = Start + DataLen;\r |
205 | }\r | |
206 | \r | |
207 | } else if (Instance->LastBlock != 0) {\r | |
208 | //\r | |
209 | // Don't save the data if the buffer is too small, return\r | |
210 | // EFI_BUFFER_TOO_SMALL if received the last packet. This\r | |
211 | // will give a accurate file length.\r | |
212 | //\r | |
213 | Token->BufferSize = Start + DataLen;\r | |
214 | \r | |
215 | Mtftp4SendError (\r | |
216 | Instance,\r | |
217 | EFI_MTFTP4_ERRORCODE_DISK_FULL,\r | |
67a58d0f | 218 | (UINT8 *) "User provided memory block is too small"\r |
772db4bb | 219 | );\r |
220 | \r | |
221 | return EFI_BUFFER_TOO_SMALL;\r | |
222 | }\r | |
223 | }\r | |
224 | \r | |
225 | return EFI_SUCCESS;\r | |
226 | }\r | |
227 | \r | |
228 | \r | |
229 | /**\r | |
dab714aa | 230 | Function to process the received data packets. \r |
231 | \r | |
232 | It will save the block then send back an ACK if it is active.\r | |
772db4bb | 233 | \r |
234 | @param Instance The downloading MTFTP session\r | |
235 | @param Packet The packet received\r | |
236 | @param Len The length of the packet\r | |
237 | @param Multicast Whether this packet is multicast or unicast\r | |
238 | @param Completed Return whether the download has completed\r | |
239 | \r | |
240 | @retval EFI_SUCCESS The data packet is successfully processed\r | |
241 | @retval EFI_ABORTED The download is aborted by the user\r | |
242 | @retval EFI_BUFFER_TOO_SMALL The user provided buffer is too small\r | |
243 | \r | |
244 | **/\r | |
245 | EFI_STATUS\r | |
246 | Mtftp4RrqHandleData (\r | |
dab714aa | 247 | IN MTFTP4_PROTOCOL *Instance,\r |
248 | IN EFI_MTFTP4_PACKET *Packet,\r | |
249 | IN UINT32 Len,\r | |
250 | IN BOOLEAN Multicast,\r | |
251 | OUT BOOLEAN *Completed\r | |
772db4bb | 252 | )\r |
253 | {\r | |
254 | EFI_STATUS Status;\r | |
255 | UINT16 BlockNum;\r | |
256 | INTN Expected;\r | |
257 | \r | |
258 | *Completed = FALSE;\r | |
259 | BlockNum = NTOHS (Packet->Data.Block);\r | |
260 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
261 | \r | |
262 | ASSERT (Expected >= 0);\r | |
263 | \r | |
264 | //\r | |
265 | // If we are active and received an unexpected packet, retransmit\r | |
266 | // the last ACK then restart receiving. If we are passive, save\r | |
267 | // the block.\r | |
268 | //\r | |
269 | if (Instance->Master && (Expected != BlockNum)) {\r | |
270 | Mtftp4Retransmit (Instance);\r | |
271 | return EFI_SUCCESS;\r | |
272 | }\r | |
273 | \r | |
274 | Status = Mtftp4RrqSaveBlock (Instance, Packet, Len);\r | |
275 | \r | |
276 | if (EFI_ERROR (Status)) {\r | |
277 | return Status;\r | |
278 | }\r | |
279 | \r | |
280 | //\r | |
281 | // Reset the passive client's timer whenever it received a\r | |
282 | // valid data packet.\r | |
283 | //\r | |
284 | if (!Instance->Master) {\r | |
285 | Mtftp4SetTimeout (Instance);\r | |
286 | }\r | |
287 | \r | |
288 | //\r | |
289 | // Check whether we have received all the blocks. Send the ACK if we\r | |
290 | // are active (unicast client or master client for multicast download).\r | |
291 | // If we have received all the blocks, send an ACK even if we are passive\r | |
292 | // to tell the server that we are done.\r | |
293 | //\r | |
294 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
295 | \r | |
296 | if (Instance->Master || (Expected < 0)) {\r | |
297 | if (Expected < 0) {\r | |
298 | //\r | |
299 | // If we are passive client, then the just received Block maybe\r | |
300 | // isn't the last block. We need to send an ACK to the last block\r | |
301 | // to inform the server that we are done. If we are active client,\r | |
302 | // the Block == Instance->LastBlock.\r | |
303 | //\r | |
304 | BlockNum = Instance->LastBlock;\r | |
305 | *Completed = TRUE;\r | |
306 | \r | |
307 | } else {\r | |
308 | BlockNum = (UINT16) (Expected - 1);\r | |
309 | }\r | |
310 | \r | |
311 | Mtftp4RrqSendAck (Instance, BlockNum);\r | |
312 | }\r | |
313 | \r | |
314 | return EFI_SUCCESS;\r | |
315 | }\r | |
316 | \r | |
317 | \r | |
318 | /**\r | |
319 | Validate whether the options received in the server's OACK packet is valid.\r | |
dab714aa | 320 | \r |
772db4bb | 321 | The options are valid only if:\r |
322 | 1. The server doesn't include options not requested by us\r | |
323 | 2. The server can only use smaller blksize than that is requested\r | |
324 | 3. The server can only use the same timeout as requested\r | |
325 | 4. The server doesn't change its multicast channel.\r | |
326 | \r | |
327 | @param This The downloading Mtftp session\r | |
328 | @param Reply The options in the OACK packet\r | |
329 | @param Request The requested options\r | |
330 | \r | |
dab714aa | 331 | @retval TRUE The options in the OACK is OK.\r |
332 | @retval FALSE The options in the OACK is invalid.\r | |
772db4bb | 333 | \r |
334 | **/\r | |
335 | BOOLEAN\r | |
336 | Mtftp4RrqOackValid (\r | |
337 | IN MTFTP4_PROTOCOL *This,\r | |
338 | IN MTFTP4_OPTION *Reply,\r | |
339 | IN MTFTP4_OPTION *Request\r | |
340 | )\r | |
341 | {\r | |
342 | \r | |
343 | //\r | |
344 | // It is invalid for server to return options we don't request\r | |
345 | //\r | |
346 | if ((Reply->Exist &~Request->Exist) != 0) {\r | |
347 | return FALSE;\r | |
348 | }\r | |
349 | \r | |
350 | //\r | |
351 | // Server can only specify a smaller block size to be used and\r | |
352 | // return the timeout matches that requested.\r | |
353 | //\r | |
dab714aa | 354 | if ((((Reply->Exist & MTFTP4_BLKSIZE_EXIST) != 0)&& (Reply->BlkSize > Request->BlkSize)) ||\r |
355 | (((Reply->Exist & MTFTP4_TIMEOUT_EXIST) != 0) && (Reply->Timeout != Request->Timeout))) {\r | |
772db4bb | 356 | return FALSE;\r |
357 | }\r | |
358 | \r | |
359 | //\r | |
360 | // The server can send ",,master" to client to change its master\r | |
361 | // setting. But if it use the specific multicast channel, it can't\r | |
362 | // change the setting.\r | |
363 | //\r | |
dab714aa | 364 | if (((Reply->Exist & MTFTP4_MCAST_EXIST) != 0) && (This->McastIp != 0)) {\r |
772db4bb | 365 | if ((Reply->McastIp != 0) && (Reply->McastIp != This->McastIp)) {\r |
366 | return FALSE;\r | |
367 | }\r | |
368 | \r | |
369 | if ((Reply->McastPort != 0) && (Reply->McastPort != This->McastPort)) {\r | |
370 | return FALSE;\r | |
371 | }\r | |
372 | }\r | |
373 | \r | |
374 | return TRUE;\r | |
375 | }\r | |
376 | \r | |
377 | \r | |
378 | /**\r | |
379 | Configure a UDP IO port to receive the multicast.\r | |
380 | \r | |
b45b45b2 | 381 | @param McastIo The UDP IO to configure\r |
772db4bb | 382 | @param Context The opaque parameter to the function which is the\r |
383 | MTFTP session.\r | |
384 | \r | |
dab714aa | 385 | @retval EFI_SUCCESS The UDP child is successfully configured.\r |
772db4bb | 386 | @retval Others Failed to configure the UDP child.\r |
387 | \r | |
388 | **/\r | |
772db4bb | 389 | EFI_STATUS\r |
e798cd87 | 390 | EFIAPI\r |
772db4bb | 391 | Mtftp4RrqConfigMcastPort (\r |
b45b45b2 | 392 | IN UDP_IO *McastIo,\r |
772db4bb | 393 | IN VOID *Context\r |
394 | )\r | |
395 | {\r | |
396 | MTFTP4_PROTOCOL *Instance;\r | |
397 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
398 | EFI_UDP4_CONFIG_DATA UdpConfig;\r | |
399 | EFI_IPv4_ADDRESS Group;\r | |
400 | EFI_STATUS Status;\r | |
401 | IP4_ADDR Ip;\r | |
402 | \r | |
403 | Instance = (MTFTP4_PROTOCOL *) Context;\r | |
404 | Config = &Instance->Config;\r | |
405 | \r | |
406 | UdpConfig.AcceptBroadcast = FALSE;\r | |
407 | UdpConfig.AcceptPromiscuous = FALSE;\r | |
408 | UdpConfig.AcceptAnyPort = FALSE;\r | |
409 | UdpConfig.AllowDuplicatePort = FALSE;\r | |
410 | UdpConfig.TypeOfService = 0;\r | |
411 | UdpConfig.TimeToLive = 64;\r | |
412 | UdpConfig.DoNotFragment = FALSE;\r | |
413 | UdpConfig.ReceiveTimeout = 0;\r | |
414 | UdpConfig.TransmitTimeout = 0;\r | |
415 | UdpConfig.UseDefaultAddress = Config->UseDefaultSetting;\r | |
416 | UdpConfig.StationAddress = Config->StationIp;\r | |
417 | UdpConfig.SubnetMask = Config->SubnetMask;\r | |
418 | UdpConfig.StationPort = Instance->McastPort;\r | |
419 | UdpConfig.RemotePort = 0;\r | |
420 | \r | |
421 | Ip = HTONL (Instance->ServerIp);\r | |
e48e37fc | 422 | CopyMem (&UdpConfig.RemoteAddress, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 423 | \r |
b45b45b2 | 424 | Status = McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, &UdpConfig);\r |
772db4bb | 425 | \r |
426 | if (EFI_ERROR (Status)) {\r | |
427 | return Status;\r | |
428 | }\r | |
429 | \r | |
dab714aa | 430 | if (!Config->UseDefaultSetting && \r |
431 | !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) {\r | |
c4a62a12 | 432 | //\r |
433 | // The station IP address is manually configured and the Gateway IP is not 0.\r | |
434 | // Add the default route for this UDP instance.\r | |
435 | //\r | |
b45b45b2 | 436 | Status = McastIo->Protocol.Udp4->Routes (\r |
437 | McastIo->Protocol.Udp4, \r | |
438 | FALSE,\r | |
439 | &mZeroIp4Addr,\r | |
440 | &mZeroIp4Addr,\r | |
441 | &Config->GatewayIp\r | |
442 | );\r | |
dab714aa | 443 | \r |
c4a62a12 | 444 | if (EFI_ERROR (Status)) {\r |
b45b45b2 | 445 | McastIo->Protocol.Udp4->Configure (McastIo->Protocol.Udp4, NULL);\r |
c4a62a12 | 446 | return Status;\r |
447 | }\r | |
448 | }\r | |
449 | \r | |
772db4bb | 450 | //\r |
451 | // join the multicast group\r | |
452 | //\r | |
453 | Ip = HTONL (Instance->McastIp);\r | |
e48e37fc | 454 | CopyMem (&Group, &Ip, sizeof (EFI_IPv4_ADDRESS));\r |
772db4bb | 455 | \r |
b45b45b2 | 456 | return McastIo->Protocol.Udp4->Groups (McastIo->Protocol.Udp4, TRUE, &Group);\r |
772db4bb | 457 | }\r |
458 | \r | |
459 | \r | |
460 | /**\r | |
dab714aa | 461 | Function to process the OACK. \r |
462 | \r | |
463 | It will first validate the OACK packet, then update the various negotiated parameters.\r | |
772db4bb | 464 | \r |
465 | @param Instance The download MTFTP session\r | |
466 | @param Packet The packet received\r | |
467 | @param Len The packet length\r | |
468 | @param Multicast Whether this packet is received as a multicast\r | |
469 | @param Completed Returns whether the download has completed. NOT\r | |
470 | used by this function.\r | |
471 | \r | |
472 | @retval EFI_DEVICE_ERROR Failed to create/start a multicast UDP child\r | |
473 | @retval EFI_TFTP_ERROR Some error happened during the process\r | |
474 | @retval EFI_SUCCESS The OACK is successfully processed.\r | |
475 | \r | |
476 | **/\r | |
477 | EFI_STATUS\r | |
478 | Mtftp4RrqHandleOack (\r | |
dab714aa | 479 | IN OUT MTFTP4_PROTOCOL *Instance,\r |
480 | IN EFI_MTFTP4_PACKET *Packet,\r | |
481 | IN UINT32 Len,\r | |
482 | IN BOOLEAN Multicast,\r | |
483 | OUT BOOLEAN *Completed\r | |
772db4bb | 484 | )\r |
485 | {\r | |
486 | MTFTP4_OPTION Reply;\r | |
487 | EFI_STATUS Status;\r | |
488 | INTN Expected;\r | |
489 | \r | |
490 | *Completed = FALSE;\r | |
491 | \r | |
492 | //\r | |
493 | // If already started the master download, don't change the\r | |
494 | // setting. Master download always succeeds.\r | |
495 | //\r | |
496 | Expected = Mtftp4GetNextBlockNum (&Instance->Blocks);\r | |
497 | ASSERT (Expected != -1);\r | |
498 | \r | |
499 | if (Instance->Master && (Expected != 1)) {\r | |
500 | return EFI_SUCCESS;\r | |
501 | }\r | |
502 | \r | |
503 | //\r | |
504 | // Parse and validate the options from server\r | |
505 | //\r | |
e48e37fc | 506 | ZeroMem (&Reply, sizeof (MTFTP4_OPTION));\r |
772db4bb | 507 | \r |
508 | Status = Mtftp4ParseOptionOack (Packet, Len, &Reply);\r | |
509 | \r | |
510 | if (EFI_ERROR (Status) ||\r | |
511 | !Mtftp4RrqOackValid (Instance, &Reply, &Instance->RequestOption)) {\r | |
512 | //\r | |
513 | // Don't send an ERROR packet if the error is EFI_OUT_OF_RESOURCES.\r | |
514 | //\r | |
515 | if (Status != EFI_OUT_OF_RESOURCES) {\r | |
516 | Mtftp4SendError (\r | |
517 | Instance,\r | |
518 | EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r | |
67a58d0f | 519 | (UINT8 *) "Mal-formated OACK packet"\r |
772db4bb | 520 | );\r |
521 | }\r | |
522 | \r | |
523 | return EFI_TFTP_ERROR;\r | |
524 | }\r | |
525 | \r | |
dab714aa | 526 | if ((Reply.Exist & MTFTP4_MCAST_EXIST) != 0) {\r |
772db4bb | 527 | \r |
528 | //\r | |
529 | // Save the multicast info. Always update the Master, only update the\r | |
530 | // multicast IP address, block size, timeoute at the first time. If IP\r | |
531 | // address is updated, create a UDP child to receive the multicast.\r | |
532 | //\r | |
533 | Instance->Master = Reply.Master;\r | |
534 | \r | |
535 | if (Instance->McastIp == 0) {\r | |
536 | if ((Reply.McastIp == 0) || (Reply.McastPort == 0)) {\r | |
537 | Mtftp4SendError (\r | |
538 | Instance,\r | |
539 | EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION,\r | |
67a58d0f | 540 | (UINT8 *) "Illegal multicast setting"\r |
772db4bb | 541 | );\r |
542 | \r | |
543 | return EFI_TFTP_ERROR;\r | |
544 | }\r | |
545 | \r | |
546 | //\r | |
547 | // Create a UDP child then start receive the multicast from it.\r | |
548 | //\r | |
549 | Instance->McastIp = Reply.McastIp;\r | |
550 | Instance->McastPort = Reply.McastPort;\r | |
b45b45b2 | 551 | Instance->McastUdpPort = UdpIoCreateIo (\r |
772db4bb | 552 | Instance->Service->Controller,\r |
553 | Instance->Service->Image,\r | |
554 | Mtftp4RrqConfigMcastPort,\r | |
b45b45b2 | 555 | UDP_IO_UDP4_VERSION,\r |
772db4bb | 556 | Instance\r |
557 | );\r | |
558 | \r | |
559 | if (Instance->McastUdpPort == NULL) {\r | |
560 | return EFI_DEVICE_ERROR;\r | |
561 | }\r | |
562 | \r | |
563 | Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r | |
564 | \r | |
565 | if (EFI_ERROR (Status)) {\r | |
566 | Mtftp4SendError (\r | |
567 | Instance,\r | |
568 | EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION,\r | |
67a58d0f | 569 | (UINT8 *) "Failed to create socket to receive multicast packet"\r |
772db4bb | 570 | );\r |
571 | \r | |
572 | return Status;\r | |
573 | }\r | |
c4a62a12 | 574 | \r |
772db4bb | 575 | //\r |
576 | // Update the parameters used.\r | |
577 | //\r | |
578 | if (Reply.BlkSize != 0) {\r | |
579 | Instance->BlkSize = Reply.BlkSize;\r | |
580 | }\r | |
c4a62a12 | 581 | \r |
772db4bb | 582 | if (Reply.Timeout != 0) {\r |
583 | Instance->Timeout = Reply.Timeout;\r | |
c4a62a12 | 584 | } \r |
585 | } \r | |
586 | \r | |
772db4bb | 587 | } else {\r |
588 | Instance->Master = TRUE;\r | |
c4a62a12 | 589 | \r |
772db4bb | 590 | if (Reply.BlkSize != 0) {\r |
591 | Instance->BlkSize = Reply.BlkSize;\r | |
592 | }\r | |
593 | \r | |
594 | if (Reply.Timeout != 0) {\r | |
595 | Instance->Timeout = Reply.Timeout;\r | |
596 | }\r | |
597 | }\r | |
c4a62a12 | 598 | \r |
772db4bb | 599 | //\r |
600 | // Send an ACK to (Expected - 1) which is 0 for unicast download,\r | |
601 | // or tell the server we want to receive the Expected block.\r | |
602 | //\r | |
603 | return Mtftp4RrqSendAck (Instance, (UINT16) (Expected - 1));\r | |
604 | }\r | |
605 | \r | |
606 | \r | |
607 | /**\r | |
608 | The packet process callback for MTFTP download.\r | |
609 | \r | |
610 | @param UdpPacket The packet received\r | |
b45b45b2 | 611 | @param EndPoint The local/remote access point of the packet\r |
772db4bb | 612 | @param IoStatus The status of the receiving\r |
613 | @param Context Opaque parameter, which is the MTFTP session\r | |
614 | \r | |
772db4bb | 615 | **/\r |
616 | VOID\r | |
e798cd87 | 617 | EFIAPI\r |
772db4bb | 618 | Mtftp4RrqInput (\r |
619 | IN NET_BUF *UdpPacket,\r | |
b45b45b2 | 620 | IN UDP_END_POINT *EndPoint,\r |
772db4bb | 621 | IN EFI_STATUS IoStatus,\r |
622 | IN VOID *Context\r | |
623 | )\r | |
624 | {\r | |
625 | MTFTP4_PROTOCOL *Instance;\r | |
626 | EFI_MTFTP4_PACKET *Packet;\r | |
627 | BOOLEAN Completed;\r | |
628 | BOOLEAN Multicast;\r | |
629 | EFI_STATUS Status;\r | |
630 | UINT16 Opcode;\r | |
631 | UINT32 Len;\r | |
632 | \r | |
633 | Instance = (MTFTP4_PROTOCOL *) Context;\r | |
634 | NET_CHECK_SIGNATURE (Instance, MTFTP4_PROTOCOL_SIGNATURE);\r | |
635 | \r | |
636 | Status = EFI_SUCCESS;\r | |
637 | Packet = NULL;\r | |
638 | Completed = FALSE;\r | |
639 | Multicast = FALSE;\r | |
640 | \r | |
641 | if (EFI_ERROR (IoStatus)) {\r | |
642 | Status = IoStatus;\r | |
643 | goto ON_EXIT;\r | |
644 | }\r | |
645 | \r | |
646 | ASSERT (UdpPacket != NULL);\r | |
647 | \r | |
648 | //\r | |
649 | // Find the port this packet is from to restart receive correctly.\r | |
650 | //\r | |
b45b45b2 | 651 | Multicast = (BOOLEAN) (EndPoint->LocalAddr.Addr[0] == Instance->McastIp);\r |
772db4bb | 652 | \r |
653 | if (UdpPacket->TotalSize < MTFTP4_OPCODE_LEN) {\r | |
654 | goto ON_EXIT;\r | |
655 | }\r | |
656 | \r | |
657 | //\r | |
658 | // Client send initial request to server's listening port. Server\r | |
659 | // will select a UDP port to communicate with the client. The server\r | |
660 | // is required to use the same port as RemotePort to multicast the\r | |
661 | // data.\r | |
662 | //\r | |
b45b45b2 | 663 | if (EndPoint->RemotePort != Instance->ConnectedPort) {\r |
772db4bb | 664 | if (Instance->ConnectedPort != 0) {\r |
665 | goto ON_EXIT;\r | |
666 | } else {\r | |
b45b45b2 | 667 | Instance->ConnectedPort = EndPoint->RemotePort;\r |
772db4bb | 668 | }\r |
669 | }\r | |
670 | \r | |
671 | //\r | |
672 | // Copy the MTFTP packet to a continuous buffer if it isn't already so.\r | |
673 | //\r | |
674 | Len = UdpPacket->TotalSize;\r | |
675 | \r | |
676 | if (UdpPacket->BlockOpNum > 1) {\r | |
e48e37fc | 677 | Packet = AllocatePool (Len);\r |
772db4bb | 678 | \r |
679 | if (Packet == NULL) {\r | |
680 | Status = EFI_OUT_OF_RESOURCES;\r | |
681 | goto ON_EXIT;\r | |
682 | }\r | |
683 | \r | |
684 | NetbufCopy (UdpPacket, 0, Len, (UINT8 *) Packet);\r | |
685 | \r | |
686 | } else {\r | |
687 | Packet = (EFI_MTFTP4_PACKET *) NetbufGetByte (UdpPacket, 0, NULL);\r | |
688 | }\r | |
689 | \r | |
690 | Opcode = NTOHS (Packet->OpCode);\r | |
691 | \r | |
692 | //\r | |
693 | // Call the user's CheckPacket if provided. Abort the transmission\r | |
694 | // if CheckPacket returns an EFI_ERROR code.\r | |
695 | //\r | |
696 | if ((Instance->Token->CheckPacket != NULL) &&\r | |
697 | ((Opcode == EFI_MTFTP4_OPCODE_OACK) || (Opcode == EFI_MTFTP4_OPCODE_ERROR))) {\r | |
698 | \r | |
699 | Status = Instance->Token->CheckPacket (\r | |
700 | &Instance->Mtftp4,\r | |
701 | Instance->Token,\r | |
702 | (UINT16) Len,\r | |
703 | Packet\r | |
704 | );\r | |
705 | \r | |
706 | if (EFI_ERROR (Status)) {\r | |
707 | //\r | |
708 | // Send an error message to the server to inform it\r | |
709 | //\r | |
710 | if (Opcode != EFI_MTFTP4_OPCODE_ERROR) {\r | |
711 | Mtftp4SendError (\r | |
712 | Instance,\r | |
713 | EFI_MTFTP4_ERRORCODE_REQUEST_DENIED,\r | |
67a58d0f | 714 | (UINT8 *) "User aborted the transfer"\r |
772db4bb | 715 | );\r |
716 | }\r | |
717 | \r | |
718 | Status = EFI_ABORTED;\r | |
719 | goto ON_EXIT;\r | |
720 | }\r | |
721 | }\r | |
722 | \r | |
723 | switch (Opcode) {\r | |
724 | case EFI_MTFTP4_OPCODE_DATA:\r | |
725 | if ((Len > (UINT32) (MTFTP4_DATA_HEAD_LEN + Instance->BlkSize)) ||\r | |
726 | (Len < (UINT32) MTFTP4_DATA_HEAD_LEN)) {\r | |
727 | goto ON_EXIT;\r | |
728 | }\r | |
729 | \r | |
730 | Status = Mtftp4RrqHandleData (Instance, Packet, Len, Multicast, &Completed);\r | |
731 | break;\r | |
732 | \r | |
733 | case EFI_MTFTP4_OPCODE_OACK:\r | |
734 | if (Multicast || (Len <= MTFTP4_OPCODE_LEN)) {\r | |
735 | goto ON_EXIT;\r | |
736 | }\r | |
737 | \r | |
738 | Status = Mtftp4RrqHandleOack (Instance, Packet, Len, Multicast, &Completed);\r | |
739 | break;\r | |
740 | \r | |
741 | case EFI_MTFTP4_OPCODE_ERROR:\r | |
742 | Status = EFI_TFTP_ERROR;\r | |
743 | break;\r | |
dab714aa | 744 | \r |
745 | default:\r | |
746 | break;\r | |
772db4bb | 747 | }\r |
748 | \r | |
749 | ON_EXIT:\r | |
750 | \r | |
751 | //\r | |
752 | // Free the resources, then if !EFI_ERROR (Status), restart the\r | |
753 | // receive, otherwise end the session.\r | |
754 | //\r | |
755 | if ((Packet != NULL) && (UdpPacket->BlockOpNum > 1)) {\r | |
766c7483 | 756 | FreePool (Packet);\r |
772db4bb | 757 | }\r |
758 | \r | |
759 | if (UdpPacket != NULL) {\r | |
760 | NetbufFree (UdpPacket);\r | |
761 | }\r | |
762 | \r | |
763 | if (!EFI_ERROR (Status) && !Completed) {\r | |
764 | if (Multicast) {\r | |
765 | Status = UdpIoRecvDatagram (Instance->McastUdpPort, Mtftp4RrqInput, Instance, 0);\r | |
766 | } else {\r | |
767 | Status = UdpIoRecvDatagram (Instance->UnicastPort, Mtftp4RrqInput, Instance, 0);\r | |
768 | }\r | |
769 | }\r | |
770 | \r | |
771 | if (EFI_ERROR (Status) || Completed) {\r | |
772 | Mtftp4CleanOperation (Instance, Status);\r | |
773 | }\r | |
774 | }\r |