]>
Commit | Line | Data |
---|---|---|
772db4bb | 1 | /** @file\r |
dab714aa | 2 | Interface routine for Mtftp4.\r |
3 | \r | |
35f910f0 | 4 | (C) Copyright 2014 Hewlett-Packard Development Company, L.P.<BR>\r |
01b5ac88 | 5 | Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r |
e5eed7d3 | 6 | This program and the accompanying materials\r |
772db4bb | 7 | are licensed and made available under the terms and conditions of the BSD License\r |
8 | which accompanies this distribution. The full text of the license may be found at\r | |
dab714aa | 9 | http://opensource.org/licenses/bsd-license.php<BR>\r |
772db4bb | 10 | \r |
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
13 | \r | |
772db4bb | 14 | **/\r |
15 | \r | |
772db4bb | 16 | \r |
dab714aa | 17 | #include "Mtftp4Impl.h"\r |
772db4bb | 18 | \r |
19 | \r | |
772db4bb | 20 | /**\r |
21 | Clean up the MTFTP session to get ready for new operation.\r | |
22 | \r | |
23 | @param Instance The MTFTP session to clean up\r | |
24 | @param Result The result to return to the caller who initiated\r | |
25 | the operation.\r | |
772db4bb | 26 | **/\r |
27 | VOID\r | |
28 | Mtftp4CleanOperation (\r | |
dab714aa | 29 | IN OUT MTFTP4_PROTOCOL *Instance,\r |
30 | IN EFI_STATUS Result\r | |
772db4bb | 31 | )\r |
32 | {\r | |
e48e37fc | 33 | LIST_ENTRY *Entry;\r |
34 | LIST_ENTRY *Next;\r | |
772db4bb | 35 | MTFTP4_BLOCK_RANGE *Block;\r |
36 | EFI_MTFTP4_TOKEN *Token;\r | |
37 | \r | |
38 | //\r | |
39 | // Free various resources.\r | |
40 | //\r | |
41 | Token = Instance->Token;\r | |
42 | \r | |
43 | if (Token != NULL) {\r | |
44 | Token->Status = Result;\r | |
45 | \r | |
46 | if (Token->Event != NULL) {\r | |
47 | gBS->SignalEvent (Token->Event);\r | |
48 | }\r | |
49 | \r | |
50 | Instance->Token = NULL;\r | |
51 | }\r | |
52 | \r | |
53 | ASSERT (Instance->UnicastPort != NULL);\r | |
b45b45b2 | 54 | UdpIoCleanIo (Instance->UnicastPort);\r |
772db4bb | 55 | \r |
56 | if (Instance->LastPacket != NULL) {\r | |
57 | NetbufFree (Instance->LastPacket);\r | |
58 | Instance->LastPacket = NULL;\r | |
59 | }\r | |
60 | \r | |
61 | if (Instance->McastUdpPort != NULL) {\r | |
216f7970 | 62 | gBS->CloseProtocol (\r |
63 | Instance->McastUdpPort->UdpHandle,\r | |
64 | &gEfiUdp4ProtocolGuid,\r | |
65 | gMtftp4DriverBinding.DriverBindingHandle,\r | |
66 | Instance->Handle\r | |
67 | );\r | |
b45b45b2 | 68 | UdpIoFreeIo (Instance->McastUdpPort);\r |
772db4bb | 69 | Instance->McastUdpPort = NULL;\r |
70 | }\r | |
71 | \r | |
72 | NET_LIST_FOR_EACH_SAFE (Entry, Next, &Instance->Blocks) {\r | |
73 | Block = NET_LIST_USER_STRUCT (Entry, MTFTP4_BLOCK_RANGE, Link);\r | |
e48e37fc | 74 | RemoveEntryList (Entry);\r |
766c7483 | 75 | FreePool (Block);\r |
772db4bb | 76 | }\r |
77 | \r | |
e48e37fc | 78 | ZeroMem (&Instance->RequestOption, sizeof (MTFTP4_OPTION));\r |
772db4bb | 79 | \r |
80 | Instance->Operation = 0;\r | |
81 | \r | |
82 | Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;\r | |
83 | Instance->LastBlock = 0;\r | |
84 | Instance->ServerIp = 0;\r | |
85 | Instance->ListeningPort = 0;\r | |
86 | Instance->ConnectedPort = 0;\r | |
87 | Instance->Gateway = 0;\r | |
88 | Instance->PacketToLive = 0;\r | |
89 | Instance->MaxRetry = 0;\r | |
90 | Instance->CurRetry = 0;\r | |
91 | Instance->Timeout = 0;\r | |
92 | Instance->McastIp = 0;\r | |
93 | Instance->McastPort = 0;\r | |
94 | Instance->Master = TRUE;\r | |
95 | }\r | |
96 | \r | |
97 | \r | |
772db4bb | 98 | /**\r |
dab714aa | 99 | Check packet for GetInfo. \r |
100 | \r | |
101 | GetInfo is implemented with EfiMtftp4ReadFile. It use Mtftp4GetInfoCheckPacket \r | |
102 | to inspect the first packet from server, then abort the session.\r | |
772db4bb | 103 | \r |
104 | @param This The MTFTP4 protocol instance\r | |
105 | @param Token The user's token\r | |
106 | @param PacketLen The length of the packet\r | |
107 | @param Packet The received packet.\r | |
108 | \r | |
109 | @retval EFI_ABORTED Abort the ReadFile operation and return.\r | |
110 | \r | |
111 | **/\r | |
772db4bb | 112 | EFI_STATUS\r |
6d3ea23f | 113 | EFIAPI\r |
772db4bb | 114 | Mtftp4GetInfoCheckPacket (\r |
115 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
116 | IN EFI_MTFTP4_TOKEN *Token,\r | |
117 | IN UINT16 PacketLen,\r | |
118 | IN EFI_MTFTP4_PACKET *Packet\r | |
119 | )\r | |
120 | {\r | |
121 | MTFTP4_GETINFO_STATE *State;\r | |
122 | EFI_STATUS Status;\r | |
123 | UINT16 OpCode;\r | |
21def103 | 124 | EFI_MTFTP4_ERROR_HEADER *ErrorHeader;\r |
772db4bb | 125 | \r |
ea886bef | 126 | State = (MTFTP4_GETINFO_STATE *) Token->Context;\r |
a5867703 | 127 | OpCode = NTOHS (Packet->OpCode);\r |
772db4bb | 128 | \r |
129 | //\r | |
130 | // Set the GetInfo's return status according to the OpCode.\r | |
131 | //\r | |
132 | switch (OpCode) {\r | |
133 | case EFI_MTFTP4_OPCODE_ERROR:\r | |
21def103 BJ |
134 | ErrorHeader = (EFI_MTFTP4_ERROR_HEADER *) Packet;\r |
135 | if (ErrorHeader->ErrorCode == EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND) {\r | |
136 | DEBUG ((EFI_D_ERROR, "TFTP error code 1 (File Not Found)\n"));\r | |
137 | } else {\r | |
138 | DEBUG ((EFI_D_ERROR, "TFTP error code %d\n", ErrorHeader->ErrorCode));\r | |
139 | }\r | |
772db4bb | 140 | State->Status = EFI_TFTP_ERROR;\r |
141 | break;\r | |
142 | \r | |
143 | case EFI_MTFTP4_OPCODE_OACK:\r | |
144 | State->Status = EFI_SUCCESS;\r | |
145 | break;\r | |
146 | \r | |
147 | default:\r | |
148 | State->Status = EFI_PROTOCOL_ERROR;\r | |
149 | }\r | |
150 | \r | |
151 | //\r | |
152 | // Allocate buffer then copy the packet over. Use gBS->AllocatePool\r | |
e48e37fc | 153 | // in case AllocatePool will implements something tricky.\r |
772db4bb | 154 | //\r |
155 | Status = gBS->AllocatePool (EfiBootServicesData, PacketLen, (VOID **) State->Packet);\r | |
156 | \r | |
157 | if (EFI_ERROR (Status)) {\r | |
158 | State->Status = EFI_OUT_OF_RESOURCES;\r | |
159 | return EFI_ABORTED;\r | |
160 | }\r | |
161 | \r | |
162 | *(State->PacketLen) = PacketLen;\r | |
e48e37fc | 163 | CopyMem (*(State->Packet), Packet, PacketLen);\r |
772db4bb | 164 | \r |
165 | return EFI_ABORTED;\r | |
166 | }\r | |
167 | \r | |
168 | \r | |
772db4bb | 169 | /**\r |
dab714aa | 170 | Check whether the override data is valid. \r |
171 | \r | |
172 | It will first validate whether the server is a valid unicast. If a gateway\r | |
173 | is provided in the Override, it also check that it is a unicast on the \r | |
174 | connected network.\r | |
772db4bb | 175 | \r |
176 | @param Instance The MTFTP instance\r | |
177 | @param Override The override data to validate.\r | |
178 | \r | |
dab714aa | 179 | @retval TRUE The override data is valid\r |
180 | @retval FALSE The override data is invalid\r | |
181 | \r | |
772db4bb | 182 | **/\r |
772db4bb | 183 | BOOLEAN\r |
184 | Mtftp4OverrideValid (\r | |
185 | IN MTFTP4_PROTOCOL *Instance,\r | |
186 | IN EFI_MTFTP4_OVERRIDE_DATA *Override\r | |
187 | )\r | |
188 | {\r | |
189 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
190 | IP4_ADDR Ip;\r | |
191 | IP4_ADDR Netmask;\r | |
192 | IP4_ADDR Gateway;\r | |
193 | \r | |
e48e37fc | 194 | CopyMem (&Ip, &Override->ServerIp, sizeof (IP4_ADDR));\r |
01b5ac88 | 195 | if (IP4_IS_UNSPECIFIED (NTOHL (Ip)) || IP4_IS_LOCAL_BROADCAST (NTOHL (Ip))) {\r |
772db4bb | 196 | return FALSE;\r |
197 | }\r | |
198 | \r | |
199 | Config = &Instance->Config;\r | |
200 | \r | |
e48e37fc | 201 | CopyMem (&Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));\r |
772db4bb | 202 | Gateway = NTOHL (Gateway);\r |
203 | \r | |
204 | if (!Config->UseDefaultSetting && (Gateway != 0)) {\r | |
e48e37fc | 205 | CopyMem (&Netmask, &Config->SubnetMask, sizeof (IP4_ADDR));\r |
206 | CopyMem (&Ip, &Config->StationIp, sizeof (IP4_ADDR));\r | |
772db4bb | 207 | \r |
208 | Netmask = NTOHL (Netmask);\r | |
209 | Ip = NTOHL (Ip);\r | |
210 | \r | |
f6b7393c | 211 | if (!NetIp4IsUnicast (Gateway, Netmask) || !IP4_NET_EQUAL (Gateway, Ip, Netmask)) {\r |
772db4bb | 212 | return FALSE;\r |
213 | }\r | |
214 | }\r | |
215 | \r | |
216 | return TRUE;\r | |
217 | }\r | |
218 | \r | |
219 | \r | |
220 | /**\r | |
221 | Poll the UDP to get the IP4 default address, which may be retrieved\r | |
dab714aa | 222 | by DHCP. \r |
223 | \r | |
224 | The default time out value is 5 seconds. If IP has retrieved the default address, \r | |
225 | the UDP is reconfigured.\r | |
772db4bb | 226 | \r |
227 | @param Instance The Mtftp instance\r | |
b45b45b2 | 228 | @param UdpIo The UDP_IO to poll\r |
229 | @param UdpCfgData The UDP configure data to reconfigure the UDP_IO\r | |
772db4bb | 230 | \r |
dab714aa | 231 | @retval TRUE The default address is retrieved and UDP is reconfigured.\r |
232 | @retval FALSE Some error occured.\r | |
772db4bb | 233 | \r |
234 | **/\r | |
235 | BOOLEAN\r | |
236 | Mtftp4GetMapping (\r | |
237 | IN MTFTP4_PROTOCOL *Instance,\r | |
b45b45b2 | 238 | IN UDP_IO *UdpIo,\r |
772db4bb | 239 | IN EFI_UDP4_CONFIG_DATA *UdpCfgData\r |
240 | )\r | |
241 | {\r | |
242 | MTFTP4_SERVICE *Service;\r | |
243 | EFI_IP4_MODE_DATA Ip4Mode;\r | |
244 | EFI_UDP4_PROTOCOL *Udp;\r | |
245 | EFI_STATUS Status;\r | |
246 | \r | |
247 | ASSERT (Instance->Config.UseDefaultSetting);\r | |
248 | \r | |
249 | Service = Instance->Service;\r | |
b45b45b2 | 250 | Udp = UdpIo->Protocol.Udp4;\r |
772db4bb | 251 | \r |
252 | Status = gBS->SetTimer (\r | |
253 | Service->TimerToGetMap,\r | |
254 | TimerRelative,\r | |
255 | MTFTP4_TIME_TO_GETMAP * TICKS_PER_SECOND\r | |
256 | );\r | |
257 | if (EFI_ERROR (Status)) {\r | |
258 | return FALSE;\r | |
259 | }\r | |
260 | \r | |
4b7aee0a | 261 | while (EFI_ERROR (gBS->CheckEvent (Service->TimerToGetMap))) {\r |
772db4bb | 262 | Udp->Poll (Udp);\r |
263 | \r | |
264 | if (!EFI_ERROR (Udp->GetModeData (Udp, NULL, &Ip4Mode, NULL, NULL)) &&\r | |
265 | Ip4Mode.IsConfigured) {\r | |
266 | \r | |
267 | Udp->Configure (Udp, NULL);\r | |
268 | return (BOOLEAN) (Udp->Configure (Udp, UdpCfgData) == EFI_SUCCESS);\r | |
269 | }\r | |
270 | }\r | |
271 | \r | |
272 | return FALSE;\r | |
273 | }\r | |
274 | \r | |
275 | \r | |
276 | /**\r | |
277 | Configure the UDP port for unicast receiving.\r | |
278 | \r | |
b45b45b2 | 279 | @param UdpIo The UDP_IO instance\r |
772db4bb | 280 | @param Instance The MTFTP session\r |
281 | \r | |
282 | @retval EFI_SUCCESS The UDP port is successfully configured for the\r | |
283 | session to unicast receive.\r | |
284 | \r | |
285 | **/\r | |
772db4bb | 286 | EFI_STATUS\r |
287 | Mtftp4ConfigUnicastPort (\r | |
b45b45b2 | 288 | IN UDP_IO *UdpIo,\r |
772db4bb | 289 | IN MTFTP4_PROTOCOL *Instance\r |
290 | )\r | |
291 | {\r | |
292 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
293 | EFI_UDP4_CONFIG_DATA UdpConfig;\r | |
294 | EFI_STATUS Status;\r | |
295 | IP4_ADDR Ip;\r | |
296 | \r | |
297 | Config = &Instance->Config;\r | |
298 | \r | |
299 | UdpConfig.AcceptBroadcast = FALSE;\r | |
300 | UdpConfig.AcceptPromiscuous = FALSE;\r | |
301 | UdpConfig.AcceptAnyPort = FALSE;\r | |
302 | UdpConfig.AllowDuplicatePort = FALSE;\r | |
303 | UdpConfig.TypeOfService = 0;\r | |
304 | UdpConfig.TimeToLive = 64;\r | |
305 | UdpConfig.DoNotFragment = FALSE;\r | |
306 | UdpConfig.ReceiveTimeout = 0;\r | |
307 | UdpConfig.TransmitTimeout = 0;\r | |
308 | UdpConfig.UseDefaultAddress = Config->UseDefaultSetting;\r | |
35f910f0 RP |
309 | IP4_COPY_ADDRESS (&UdpConfig.StationAddress, &Config->StationIp);\r |
310 | IP4_COPY_ADDRESS (&UdpConfig.SubnetMask, &Config->SubnetMask);\r | |
772db4bb | 311 | UdpConfig.StationPort = 0;\r |
312 | UdpConfig.RemotePort = 0;\r | |
313 | \r | |
314 | Ip = HTONL (Instance->ServerIp);\r | |
35f910f0 | 315 | IP4_COPY_ADDRESS (&UdpConfig.RemoteAddress, &Ip);\r |
772db4bb | 316 | \r |
b45b45b2 | 317 | Status = UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, &UdpConfig);\r |
772db4bb | 318 | \r |
319 | if ((Status == EFI_NO_MAPPING) && Mtftp4GetMapping (Instance, UdpIo, &UdpConfig)) {\r | |
320 | return EFI_SUCCESS;\r | |
321 | }\r | |
322 | \r | |
c4a62a12 | 323 | if (!Config->UseDefaultSetting && !EFI_IP4_EQUAL (&mZeroIp4Addr, &Config->GatewayIp)) {\r |
324 | //\r | |
325 | // The station IP address is manually configured and the Gateway IP is not 0.\r | |
326 | // Add the default route for this UDP instance.\r | |
327 | //\r | |
b45b45b2 | 328 | Status = UdpIo->Protocol.Udp4->Routes (\r |
329 | UdpIo->Protocol.Udp4,\r | |
330 | FALSE,\r | |
331 | &mZeroIp4Addr,\r | |
332 | &mZeroIp4Addr,\r | |
333 | &Config->GatewayIp\r | |
334 | );\r | |
c4a62a12 | 335 | if (EFI_ERROR (Status)) {\r |
b45b45b2 | 336 | UdpIo->Protocol.Udp4->Configure (UdpIo->Protocol.Udp4, NULL);\r |
c4a62a12 | 337 | }\r |
338 | }\r | |
772db4bb | 339 | return Status;\r |
340 | }\r | |
341 | \r | |
342 | \r | |
343 | /**\r | |
344 | Start the MTFTP session to do the operation, such as read file,\r | |
345 | write file, and read directory.\r | |
346 | \r | |
347 | @param This The MTFTP session\r | |
348 | @param Token The token than encapsues the user's request.\r | |
349 | @param Operation The operation to do\r | |
350 | \r | |
351 | @retval EFI_INVALID_PARAMETER Some of the parameters are invalid.\r | |
352 | @retval EFI_NOT_STARTED The MTFTP session hasn't been configured.\r | |
353 | @retval EFI_ALREADY_STARTED There is pending operation for the session.\r | |
354 | @retval EFI_SUCCESS The operation is successfully started.\r | |
355 | \r | |
356 | **/\r | |
772db4bb | 357 | EFI_STATUS\r |
358 | Mtftp4Start (\r | |
359 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
360 | IN EFI_MTFTP4_TOKEN *Token,\r | |
361 | IN UINT16 Operation\r | |
362 | )\r | |
363 | {\r | |
364 | MTFTP4_PROTOCOL *Instance;\r | |
365 | EFI_MTFTP4_OVERRIDE_DATA *Override;\r | |
366 | EFI_MTFTP4_CONFIG_DATA *Config;\r | |
367 | EFI_TPL OldTpl;\r | |
368 | EFI_STATUS Status;\r | |
369 | \r | |
370 | //\r | |
371 | // Validate the parameters\r | |
372 | //\r | |
373 | if ((This == NULL) || (Token == NULL) || (Token->Filename == NULL) ||\r | |
374 | ((Token->OptionCount != 0) && (Token->OptionList == NULL))) {\r | |
375 | return EFI_INVALID_PARAMETER;\r | |
376 | }\r | |
377 | \r | |
378 | //\r | |
379 | // User must provide at least one method to collect the data for download.\r | |
380 | //\r | |
381 | if (((Operation == EFI_MTFTP4_OPCODE_RRQ) || (Operation == EFI_MTFTP4_OPCODE_DIR)) &&\r | |
382 | ((Token->Buffer == NULL) && (Token->CheckPacket == NULL))) {\r | |
383 | return EFI_INVALID_PARAMETER;\r | |
384 | }\r | |
385 | \r | |
386 | //\r | |
387 | // User must provide at least one method to provide the data for upload.\r | |
388 | //\r | |
389 | if ((Operation == EFI_MTFTP4_OPCODE_WRQ) &&\r | |
390 | ((Token->Buffer == NULL) && (Token->PacketNeeded == NULL))) {\r | |
391 | return EFI_INVALID_PARAMETER;\r | |
392 | }\r | |
393 | \r | |
394 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
395 | \r | |
396 | Status = EFI_SUCCESS;\r | |
e48e37fc | 397 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r |
772db4bb | 398 | \r |
399 | if (Instance->State != MTFTP4_STATE_CONFIGED) {\r | |
400 | Status = EFI_NOT_STARTED;\r | |
401 | }\r | |
402 | \r | |
403 | if (Instance->Operation != 0) {\r | |
404 | Status = EFI_ACCESS_DENIED;\r | |
405 | }\r | |
406 | \r | |
407 | if (EFI_ERROR (Status)) {\r | |
e48e37fc | 408 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 409 | return Status;\r |
410 | }\r | |
411 | \r | |
412 | //\r | |
413 | // Set the Operation now to prevent the application start other\r | |
414 | // operations.\r | |
415 | //\r | |
416 | Instance->Operation = Operation;\r | |
417 | Override = Token->OverrideData;\r | |
418 | \r | |
419 | if ((Override != NULL) && !Mtftp4OverrideValid (Instance, Override)) {\r | |
420 | Status = EFI_INVALID_PARAMETER;\r | |
421 | goto ON_ERROR;\r | |
422 | }\r | |
423 | \r | |
424 | if (Token->OptionCount != 0) {\r | |
425 | Status = Mtftp4ParseOption (\r | |
426 | Token->OptionList,\r | |
427 | Token->OptionCount,\r | |
428 | TRUE,\r | |
429 | &Instance->RequestOption\r | |
430 | );\r | |
431 | \r | |
432 | if (EFI_ERROR (Status)) {\r | |
433 | goto ON_ERROR;\r | |
434 | }\r | |
435 | }\r | |
436 | \r | |
437 | //\r | |
438 | // Set the operation parameters from the configuration or override data.\r | |
439 | //\r | |
440 | Config = &Instance->Config;\r | |
441 | Instance->Token = Token;\r | |
442 | Instance->BlkSize = MTFTP4_DEFAULT_BLKSIZE;\r | |
443 | \r | |
e48e37fc | 444 | CopyMem (&Instance->ServerIp, &Config->ServerIp, sizeof (IP4_ADDR));\r |
772db4bb | 445 | Instance->ServerIp = NTOHL (Instance->ServerIp);\r |
446 | \r | |
447 | Instance->ListeningPort = Config->InitialServerPort;\r | |
448 | Instance->ConnectedPort = 0;\r | |
449 | \r | |
e48e37fc | 450 | CopyMem (&Instance->Gateway, &Config->GatewayIp, sizeof (IP4_ADDR));\r |
772db4bb | 451 | Instance->Gateway = NTOHL (Instance->Gateway);\r |
452 | \r | |
453 | Instance->MaxRetry = Config->TryCount;\r | |
454 | Instance->Timeout = Config->TimeoutValue;\r | |
455 | Instance->Master = TRUE;\r | |
456 | \r | |
457 | if (Override != NULL) {\r | |
e48e37fc | 458 | CopyMem (&Instance->ServerIp, &Override->ServerIp, sizeof (IP4_ADDR));\r |
459 | CopyMem (&Instance->Gateway, &Override->GatewayIp, sizeof (IP4_ADDR));\r | |
772db4bb | 460 | \r |
461 | Instance->ServerIp = NTOHL (Instance->ServerIp);\r | |
462 | Instance->Gateway = NTOHL (Instance->Gateway);\r | |
463 | \r | |
464 | Instance->ListeningPort = Override->ServerPort;\r | |
465 | Instance->MaxRetry = Override->TryCount;\r | |
466 | Instance->Timeout = Override->TimeoutValue;\r | |
467 | }\r | |
468 | \r | |
469 | if (Instance->ListeningPort == 0) {\r | |
470 | Instance->ListeningPort = MTFTP4_DEFAULT_SERVER_PORT;\r | |
471 | }\r | |
472 | \r | |
473 | if (Instance->MaxRetry == 0) {\r | |
474 | Instance->MaxRetry = MTFTP4_DEFAULT_RETRY;\r | |
475 | }\r | |
476 | \r | |
477 | if (Instance->Timeout == 0) {\r | |
478 | Instance->Timeout = MTFTP4_DEFAULT_TIMEOUT;\r | |
479 | }\r | |
480 | \r | |
481 | //\r | |
482 | // Config the unicast UDP child to send initial request\r | |
483 | //\r | |
484 | Status = Mtftp4ConfigUnicastPort (Instance->UnicastPort, Instance);\r | |
485 | \r | |
486 | if (EFI_ERROR (Status)) {\r | |
487 | goto ON_ERROR;\r | |
488 | }\r | |
489 | \r | |
174f03d2 | 490 | //\r |
491 | // Set initial status.\r | |
492 | //\r | |
493 | Token->Status = EFI_NOT_READY;\r | |
494 | \r | |
772db4bb | 495 | //\r |
496 | // Build and send an initial requests\r | |
497 | //\r | |
498 | if (Operation == EFI_MTFTP4_OPCODE_WRQ) {\r | |
499 | Status = Mtftp4WrqStart (Instance, Operation);\r | |
500 | } else {\r | |
501 | Status = Mtftp4RrqStart (Instance, Operation);\r | |
502 | }\r | |
503 | \r | |
e48e37fc | 504 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 505 | \r |
506 | if (EFI_ERROR (Status)) {\r | |
507 | goto ON_ERROR;\r | |
508 | }\r | |
772db4bb | 509 | \r |
510 | if (Token->Event != NULL) {\r | |
511 | return EFI_SUCCESS;\r | |
512 | }\r | |
513 | \r | |
174f03d2 | 514 | //\r |
515 | // Return immediately for asynchronous operation or poll the\r | |
516 | // instance for synchronous operation.\r | |
517 | //\r | |
772db4bb | 518 | while (Token->Status == EFI_NOT_READY) {\r |
519 | This->Poll (This);\r | |
520 | }\r | |
521 | \r | |
522 | return Token->Status;\r | |
523 | \r | |
524 | ON_ERROR:\r | |
525 | Mtftp4CleanOperation (Instance, Status);\r | |
e48e37fc | 526 | gBS->RestoreTPL (OldTpl);\r |
772db4bb | 527 | \r |
528 | return Status;\r | |
529 | }\r | |
530 | \r | |
531 | \r | |
3dc3861a | 532 | /**\r |
533 | Reads the current operational settings.\r | |
534 | \r | |
535 | The GetModeData()function reads the current operational settings of this \r | |
536 | EFI MTFTPv4 Protocol driver instance.\r | |
537 | \r | |
538 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
539 | @param ModeData Pointer to storage for the EFI MTFTPv4 Protocol\r | |
540 | driver mode data. \r | |
541 | \r | |
542 | @retval EFI_SUCCESS The configuration data was successfully returned.\r | |
543 | @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r | |
544 | @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.\r | |
545 | \r | |
546 | **/\r | |
547 | EFI_STATUS\r | |
548 | EFIAPI\r | |
549 | EfiMtftp4GetModeData (\r | |
550 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
551 | OUT EFI_MTFTP4_MODE_DATA *ModeData\r | |
552 | )\r | |
553 | {\r | |
554 | MTFTP4_PROTOCOL *Instance;\r | |
555 | EFI_TPL OldTpl;\r | |
556 | \r | |
557 | if ((This == NULL) || (ModeData == NULL)) {\r | |
558 | return EFI_INVALID_PARAMETER;\r | |
559 | }\r | |
560 | \r | |
561 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
562 | \r | |
563 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
564 | CopyMem(&ModeData->ConfigData, &Instance->Config, sizeof (Instance->Config));\r | |
565 | ModeData->SupportedOptionCount = MTFTP4_SUPPORTED_OPTIONS;\r | |
566 | ModeData->SupportedOptoins = (UINT8 **) mMtftp4SupportedOptions;\r | |
567 | ModeData->UnsupportedOptionCount = 0;\r | |
568 | ModeData->UnsupportedOptoins = NULL;\r | |
569 | \r | |
570 | gBS->RestoreTPL (OldTpl);\r | |
571 | \r | |
572 | return EFI_SUCCESS;\r | |
573 | }\r | |
574 | \r | |
575 | \r | |
576 | \r | |
577 | /**\r | |
578 | Initializes, changes, or resets the default operational setting for this \r | |
579 | EFI MTFTPv4 Protocol driver instance.\r | |
580 | \r | |
581 | The Configure() function is used to set and change the configuration data for \r | |
582 | this EFI MTFTPv4 Protocol driver instance. The configuration data can be reset \r | |
583 | to startup defaults by calling Configure() with MtftpConfigData set to NULL. \r | |
584 | Whenever the instance is reset, any pending operation is aborted. By changing \r | |
585 | the EFI MTFTPv4 Protocol driver instance configuration data, the client can \r | |
586 | connect to different MTFTPv4 servers. The configuration parameters in \r | |
587 | MtftpConfigData are used as the default parameters in later MTFTPv4 operations \r | |
588 | and can be overridden in later operations.\r | |
589 | \r | |
590 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
591 | @param ConfigData MtftpConfigDataPointer to the configuration data \r | |
592 | structure\r | |
593 | \r | |
594 | @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured \r | |
595 | successfully.\r | |
596 | @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r | |
597 | 1.This is NULL.\r | |
598 | 2.MtftpConfigData.UseDefaultSetting is FALSE and \r | |
599 | MtftpConfigData.StationIp is not a valid IPv4 \r | |
600 | unicast address.\r | |
601 | 3.MtftpCofigData.UseDefaultSetting is FALSE and \r | |
602 | MtftpConfigData.SubnetMask is invalid.\r | |
603 | 4.MtftpCofigData.ServerIp is not a valid IPv4 \r | |
604 | unicast address.\r | |
605 | 5.MtftpConfigData.UseDefaultSetting is FALSE and \r | |
606 | MtftpConfigData.GatewayIp is not a valid IPv4 \r | |
607 | unicast address or is not in the same subnet \r | |
608 | with station address.\r | |
609 | @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this \r | |
610 | time because there is one MTFTP background operation \r | |
611 | in progress.\r | |
612 | @retval EFI_NO_MAPPING When using a default address, configuration \r | |
613 | (DHCP, BOOTP, RARP, etc.) has not finished yet.\r | |
614 | @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) \r | |
615 | could not be located when clients choose to use \r | |
616 | the default address settings.\r | |
617 | @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could \r | |
618 | not be allocated.\r | |
619 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. \r | |
620 | The EFI MTFTPv4 Protocol driver instance is not \r | |
621 | configured.\r | |
622 | \r | |
623 | **/\r | |
624 | EFI_STATUS\r | |
625 | EFIAPI\r | |
626 | EfiMtftp4Configure (\r | |
627 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
628 | IN EFI_MTFTP4_CONFIG_DATA *ConfigData\r | |
629 | )\r | |
630 | {\r | |
631 | MTFTP4_PROTOCOL *Instance;\r | |
632 | EFI_TPL OldTpl;\r | |
633 | IP4_ADDR Ip;\r | |
634 | IP4_ADDR Netmask;\r | |
635 | IP4_ADDR Gateway;\r | |
636 | IP4_ADDR ServerIp;\r | |
637 | \r | |
638 | if (This == NULL) {\r | |
639 | return EFI_INVALID_PARAMETER;\r | |
640 | }\r | |
641 | \r | |
642 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
643 | \r | |
644 | if (ConfigData == NULL) {\r | |
645 | //\r | |
646 | // Reset the operation if ConfigData is NULL\r | |
647 | //\r | |
648 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
649 | \r | |
650 | Mtftp4CleanOperation (Instance, EFI_ABORTED);\r | |
651 | ZeroMem (&Instance->Config, sizeof (EFI_MTFTP4_CONFIG_DATA));\r | |
652 | Instance->State = MTFTP4_STATE_UNCONFIGED;\r | |
653 | \r | |
654 | gBS->RestoreTPL (OldTpl);\r | |
655 | \r | |
656 | } else {\r | |
657 | //\r | |
658 | // Configure the parameters for new operation.\r | |
659 | //\r | |
660 | CopyMem (&Ip, &ConfigData->StationIp, sizeof (IP4_ADDR));\r | |
661 | CopyMem (&Netmask, &ConfigData->SubnetMask, sizeof (IP4_ADDR));\r | |
662 | CopyMem (&Gateway, &ConfigData->GatewayIp, sizeof (IP4_ADDR));\r | |
663 | CopyMem (&ServerIp, &ConfigData->ServerIp, sizeof (IP4_ADDR));\r | |
664 | \r | |
665 | Ip = NTOHL (Ip);\r | |
666 | Netmask = NTOHL (Netmask);\r | |
667 | Gateway = NTOHL (Gateway);\r | |
668 | ServerIp = NTOHL (ServerIp);\r | |
669 | \r | |
3dc3861a | 670 | if (!ConfigData->UseDefaultSetting &&\r |
f6b7393c | 671 | ((!IP4_IS_VALID_NETMASK (Netmask) || !NetIp4IsUnicast (Ip, Netmask)))) {\r |
3dc3861a | 672 | \r |
673 | return EFI_INVALID_PARAMETER;\r | |
674 | }\r | |
675 | \r | |
676 | if ((Gateway != 0) &&\r | |
f6b7393c | 677 | (!IP4_NET_EQUAL (Gateway, Ip, Netmask) || !NetIp4IsUnicast (Gateway, Netmask))) {\r |
3dc3861a | 678 | \r |
679 | return EFI_INVALID_PARAMETER;\r | |
680 | }\r | |
681 | \r | |
682 | OldTpl = gBS->RaiseTPL (TPL_CALLBACK);\r | |
683 | \r | |
684 | if ((Instance->State == MTFTP4_STATE_CONFIGED) && (Instance->Operation != 0)) {\r | |
685 | gBS->RestoreTPL (OldTpl);\r | |
686 | return EFI_ACCESS_DENIED;\r | |
687 | }\r | |
688 | \r | |
689 | CopyMem(&Instance->Config, ConfigData, sizeof (*ConfigData));;\r | |
690 | Instance->State = MTFTP4_STATE_CONFIGED;\r | |
691 | \r | |
692 | gBS->RestoreTPL (OldTpl);\r | |
693 | }\r | |
694 | \r | |
695 | return EFI_SUCCESS;\r | |
696 | }\r | |
697 | \r | |
698 | \r | |
699 | \r | |
700 | /**\r | |
701 | Parses the options in an MTFTPv4 OACK packet.\r | |
702 | \r | |
703 | The ParseOptions() function parses the option fields in an MTFTPv4 OACK packet \r | |
704 | and returns the number of options that were found and optionally a list of \r | |
705 | pointers to the options in the packet.\r | |
706 | If one or more of the option fields are not valid, then EFI_PROTOCOL_ERROR is \r | |
707 | returned and *OptionCount and *OptionList stop at the last valid option.\r | |
708 | The OptionList is allocated by this function, and caller should free it when used.\r | |
709 | \r | |
710 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
711 | @param PacketLen Length of the OACK packet to be parsed.\r | |
712 | @param Packet Pointer to the OACK packet to be parsed. \r | |
713 | @param OptionCount Pointer to the number of options in following OptionList.\r | |
714 | @param OptionList Pointer to EFI_MTFTP4_OPTION storage. Call the \r | |
715 | EFI Boot Service FreePool() to release theOptionList\r | |
716 | if the options in this OptionList are not needed \r | |
717 | any more\r | |
718 | \r | |
719 | @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and\r | |
720 | OptionList parameters have been updated.\r | |
721 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
722 | 1.PacketLen is 0.\r | |
723 | 2.Packet is NULL or Packet is not a valid MTFTPv4 packet.\r | |
724 | 3.OptionCount is NULL.\r | |
725 | @retval EFI_NOT_FOUND No options were found in the OACK packet.\r | |
726 | @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated.\r | |
727 | @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.\r | |
728 | \r | |
729 | **/\r | |
730 | EFI_STATUS\r | |
731 | EFIAPI\r | |
732 | EfiMtftp4ParseOptions (\r | |
733 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
734 | IN UINT32 PacketLen,\r | |
735 | IN EFI_MTFTP4_PACKET *Packet,\r | |
736 | OUT UINT32 *OptionCount,\r | |
737 | OUT EFI_MTFTP4_OPTION **OptionList OPTIONAL\r | |
738 | )\r | |
739 | {\r | |
740 | EFI_STATUS Status;\r | |
741 | \r | |
742 | if ((This == NULL) || (PacketLen < MTFTP4_OPCODE_LEN) ||\r | |
743 | (Packet == NULL) || (OptionCount == NULL)) {\r | |
744 | \r | |
745 | return EFI_INVALID_PARAMETER;\r | |
746 | }\r | |
747 | \r | |
748 | Status = Mtftp4ExtractOptions (Packet, PacketLen, OptionCount, OptionList);\r | |
749 | \r | |
750 | if (EFI_ERROR (Status)) {\r | |
751 | return Status;\r | |
752 | }\r | |
753 | \r | |
754 | if (*OptionCount == 0) {\r | |
755 | return EFI_NOT_FOUND;\r | |
756 | }\r | |
757 | \r | |
758 | return EFI_SUCCESS;\r | |
759 | }\r | |
760 | \r | |
761 | \r | |
772db4bb | 762 | /**\r |
dab714aa | 763 | Downloads a file from an MTFTPv4 server.\r |
764 | \r | |
765 | The ReadFile() function is used to initialize and start an MTFTPv4 download \r | |
766 | process and optionally wait for completion. When the download operation completes, \r | |
767 | whether successfully or not, the Token.Status field is updated by the EFI MTFTPv4 \r | |
768 | Protocol driver and then Token.Event is signaled (if it is not NULL).\r | |
769 | Data can be downloaded from the MTFTPv4 server into either of the following locations:\r | |
770 | 1.A fixed buffer that is pointed to by Token.Buffer\r | |
771 | 2.A download service function that is pointed to by Token.CheckPacket\r | |
772 | If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket \r | |
773 | will be called first. If the call is successful, the packet will be stored in \r | |
774 | Token.Buffer.\r | |
775 | \r | |
776 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
777 | @param Token Pointer to the token structure to provide the \r | |
778 | parameters that are used in this operation.\r | |
779 | \r | |
780 | @retval EFI_SUCCESS The data file has been transferred successfully.\r | |
781 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
782 | @retval EFI_BUFFER_TOO_SMALL BufferSize is not large enough to hold the downloaded \r | |
783 | data in downloading process.\r | |
784 | @retval EFI_ABORTED Current operation is aborted by user.\r | |
785 | @retval EFI_ICMP_ERROR An ICMP ERROR packet was received.\r | |
786 | @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r | |
787 | @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.\r | |
788 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
dd29f3ed | 789 | @retval EFI_NO_MEDIA There was a media error.\r |
772db4bb | 790 | \r |
791 | **/\r | |
772db4bb | 792 | EFI_STATUS\r |
793 | EFIAPI\r | |
794 | EfiMtftp4ReadFile (\r | |
795 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
796 | IN EFI_MTFTP4_TOKEN *Token\r | |
797 | )\r | |
798 | {\r | |
799 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_RRQ);\r | |
800 | }\r | |
801 | \r | |
802 | \r | |
803 | /**\r | |
dab714aa | 804 | Sends a data file to an MTFTPv4 server. May be unsupported in some EFI implementations\r |
805 | \r | |
806 | The WriteFile() function is used to initialize an uploading operation with the \r | |
807 | given option list and optionally wait for completion. If one or more of the \r | |
808 | options is not supported by the server, the unsupported options are ignored and \r | |
809 | a standard TFTP process starts instead. When the upload process completes, \r | |
810 | whether successfully or not, Token.Event is signaled, and the EFI MTFTPv4 Protocol \r | |
811 | driver updates Token.Status.\r | |
812 | The caller can supply the data to be uploaded in the following two modes:\r | |
813 | 1.Through the user-provided buffer\r | |
814 | 2.Through a callback function\r | |
815 | With the user-provided buffer, the Token.BufferSize field indicates the length\r | |
816 | of the buffer, and the driver will upload the data in the buffer. With an \r | |
817 | EFI_MTFTP4_PACKET_NEEDED callback function, the driver will call this callback \r | |
818 | function to get more data from the user to upload. See the definition of \r | |
819 | EFI_MTFTP4_PACKET_NEEDED for more information. These two modes cannot be used at \r | |
820 | the same time. The callback function will be ignored if the user provides the buffer.\r | |
821 | \r | |
822 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance.\r | |
823 | @param Token Pointer to the token structure to provide the \r | |
824 | parameters that are used in this function\r | |
825 | \r | |
826 | @retval EFI_SUCCESS The upload session has started.\r | |
827 | @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r | |
828 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
829 | 1. This is NULL.\r | |
830 | 2. Token is NULL.\r | |
831 | 3. Token.Filename is NULL.\r | |
832 | 4. Token.OptionCount is not zero and\r | |
833 | Token.OptionList is NULL.\r | |
834 | 5. One or more options in Token.OptionList have wrong\r | |
835 | format.\r | |
836 | 6. Token.Buffer and Token.PacketNeeded are both\r | |
837 | NULL.\r | |
838 | 7. One or more IPv4 addresses in Token.OverrideData \r | |
839 | are not valid unicast IPv4 addresses if \r | |
840 | Token.OverrideData is not NULL.\r | |
841 | @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the\r | |
842 | unsupported list of structure EFI_MTFTP4_MODE_DATA.\r | |
843 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
844 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
845 | BOOTP, RARP, etc.) is not finished yet.\r | |
846 | @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 \r | |
847 | session.\r | |
848 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
849 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
850 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
772db4bb | 851 | \r |
852 | **/\r | |
772db4bb | 853 | EFI_STATUS\r |
854 | EFIAPI\r | |
855 | EfiMtftp4WriteFile (\r | |
856 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
857 | IN EFI_MTFTP4_TOKEN *Token\r | |
858 | )\r | |
859 | {\r | |
860 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_WRQ);\r | |
861 | }\r | |
862 | \r | |
863 | \r | |
864 | /**\r | |
dab714aa | 865 | Downloads a data file "directory" from an MTFTPv4 server. \r |
866 | May be unsupported in some EFI implementations\r | |
867 | \r | |
868 | The ReadDirectory() function is used to return a list of files on the MTFTPv4 \r | |
869 | server that are logically (or operationally) related to Token.Filename. The \r | |
870 | directory request packet that is sent to the server is built with the option \r | |
871 | list that was provided by caller, if present.\r | |
872 | The file information that the server returns is put into either of the following \r | |
873 | locations:\r | |
874 | 1.A fixed buffer that is pointed to by Token.Buffer\r | |
875 | 2.A download service function that is pointed to by Token.CheckPacket\r | |
876 | If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket will \r | |
877 | be called first. If the call is successful, the packet will be stored in Token.Buffer.\r | |
878 | The returned directory listing in the Token.Buffer or EFI_MTFTP4_PACKET consists \r | |
879 | of a list of two or three variable-length ASCII strings, each terminated by a \r | |
880 | null character, for each file in the directory. If the multicast option is involved, \r | |
881 | the first field of each directory entry is the static multicast IP address and \r | |
882 | UDP port number that is associated with the file name. The format of the field \r | |
883 | is ip:ip:ip:ip:port. If the multicast option is not involved, this field and its \r | |
884 | terminating null character are not present.\r | |
885 | The next field of each directory entry is the file name and the last field is \r | |
886 | the file information string. The information string contains the file size and \r | |
887 | the create/modify timestamp. The format of the information string is filesize \r | |
888 | yyyy-mm-dd hh:mm:ss:ffff. The timestamp is Coordinated Universal Time \r | |
889 | (UTC; also known as Greenwich Mean Time [GMT]).\r | |
890 | The only difference between ReadFile and ReadDirectory is the opcode used.\r | |
891 | \r | |
892 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
893 | @param Token Pointer to the token structure to provide the \r | |
894 | parameters that are used in this function\r | |
895 | \r | |
896 | @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.\r | |
897 | @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r | |
898 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
899 | 1. This is NULL.\r | |
900 | 2. Token is NULL.\r | |
901 | 3. Token.Filename is NULL.\r | |
902 | 4. Token.OptionCount is not zero and\r | |
903 | Token.OptionList is NULL.\r | |
904 | 5. One or more options in Token.OptionList have wrong\r | |
905 | format.\r | |
906 | 6. Token.Buffer and Token.PacketNeeded are both\r | |
907 | NULL.\r | |
908 | 7. One or more IPv4 addresses in Token.OverrideData \r | |
909 | are not valid unicast IPv4 addresses if \r | |
910 | Token.OverrideData is not NULL.\r | |
911 | @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in the\r | |
912 | unsupported list of structure EFI_MTFTP4_MODE_DATA.\r | |
913 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
914 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
915 | BOOTP, RARP, etc.) is not finished yet.\r | |
916 | @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 \r | |
917 | session.\r | |
918 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
919 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
920 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
772db4bb | 921 | \r |
922 | **/\r | |
772db4bb | 923 | EFI_STATUS\r |
924 | EFIAPI\r | |
925 | EfiMtftp4ReadDirectory (\r | |
926 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
927 | IN EFI_MTFTP4_TOKEN *Token\r | |
928 | )\r | |
929 | {\r | |
930 | return Mtftp4Start (This, Token, EFI_MTFTP4_OPCODE_DIR);\r | |
931 | }\r | |
932 | \r | |
933 | \r | |
934 | /**\r | |
dab714aa | 935 | Gets information about a file from an MTFTPv4 server. \r |
936 | \r | |
937 | The GetInfo() function assembles an MTFTPv4 request packet with options; \r | |
938 | sends it to the MTFTPv4 server; and may return an MTFTPv4 OACK, MTFTPv4 ERROR, \r | |
939 | or ICMP ERROR packet. Retries occur only if no response packets are received \r | |
940 | from the MTFTPv4 server before the timeout expires.\r | |
941 | It is implemented with EfiMtftp4ReadFile: build a token, then pass it to \r | |
942 | EfiMtftp4ReadFile. In its check packet callback abort the opertions.\r | |
943 | \r | |
944 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
945 | @param OverrideData Data that is used to override the existing \r | |
946 | parameters. If NULL, the default parameters that \r | |
947 | were set in the EFI_MTFTP4_PROTOCOL.Configure() \r | |
948 | function are used\r | |
4f077902 SZ |
949 | @param Filename Pointer to null-terminated ASCII file name string\r |
950 | @param ModeStr Pointer to null-terminated ASCII mode string. If NULL, "octet" \r | |
dab714aa | 951 | will be used\r |
952 | @param OptionCount Number of option/value string pairs in OptionList\r | |
953 | @param OptionList Pointer to array of option/value string pairs. \r | |
954 | Ignored if OptionCount is zero\r | |
955 | @param PacketLength The number of bytes in the returned packet\r | |
956 | @param Packet PacketThe pointer to the received packet. This \r | |
957 | buffer must be freed by the caller.\r | |
958 | \r | |
959 | @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in \r | |
960 | the Buffer.\r | |
961 | @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r | |
962 | 1.This is NULL.\r | |
963 | 2.Filename is NULL.\r | |
964 | 3.OptionCount is not zero and OptionList is NULL.\r | |
965 | 4.One or more options in OptionList have wrong format.\r | |
966 | 5.PacketLength is NULL.\r | |
967 | 6.One or more IPv4 addresses in OverrideData are \r | |
968 | not valid unicast IPv4 addresses if OverrideData \r | |
969 | is not NULL.\r | |
970 | @retval EFI_UNSUPPORTED One or more options in the OptionList are in the\r | |
971 | unsupported list of structure EFI_MTFTP4_MODE_DATA\r | |
972 | @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.\r | |
973 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, \r | |
974 | BOOTP, RARP, etc.) has not finished yet.\r | |
975 | @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r | |
976 | @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r | |
977 | @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in \r | |
978 | the Buffer.\r | |
979 | @retval EFI_ICMP_ERROR An ICMP ERROR packet was received and the Packet \r | |
980 | is set to NULL.\r | |
981 | @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is \r | |
982 | in the Buffer.\r | |
983 | @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.\r | |
984 | @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r | |
dd29f3ed | 985 | @retval EFI_NO_MEDIA There was a media error.\r |
986 | \r | |
dab714aa | 987 | **/\r |
988 | EFI_STATUS\r | |
989 | EFIAPI\r | |
990 | EfiMtftp4GetInfo (\r | |
991 | IN EFI_MTFTP4_PROTOCOL *This,\r | |
992 | IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,\r | |
993 | IN UINT8 *Filename,\r | |
994 | IN UINT8 *ModeStr OPTIONAL,\r | |
995 | IN UINT8 OptionCount,\r | |
996 | IN EFI_MTFTP4_OPTION *OptionList OPTIONAL,\r | |
997 | OUT UINT32 *PacketLength,\r | |
998 | OUT EFI_MTFTP4_PACKET **Packet OPTIONAL\r | |
999 | )\r | |
1000 | {\r | |
1001 | EFI_MTFTP4_TOKEN Token;\r | |
ea886bef | 1002 | MTFTP4_GETINFO_STATE State;\r |
dab714aa | 1003 | EFI_STATUS Status;\r |
1004 | \r | |
1005 | if ((This == NULL) || (Filename == NULL) || (PacketLength == NULL) ||\r | |
1006 | ((OptionCount != 0) && (OptionList == NULL))) {\r | |
1007 | return EFI_INVALID_PARAMETER;\r | |
1008 | }\r | |
1009 | \r | |
1010 | if (Packet != NULL) {\r | |
1011 | *Packet = NULL;\r | |
1012 | }\r | |
1013 | \r | |
1014 | *PacketLength = 0;\r | |
ea886bef | 1015 | State.Packet = Packet;\r |
1016 | State.PacketLen = PacketLength;\r | |
1017 | State.Status = EFI_SUCCESS;\r | |
dab714aa | 1018 | \r |
1019 | //\r | |
1020 | // Fill in the Token to issue an synchronous ReadFile operation\r | |
1021 | //\r | |
1022 | Token.Status = EFI_SUCCESS;\r | |
1023 | Token.Event = NULL;\r | |
1024 | Token.OverrideData = OverrideData;\r | |
1025 | Token.Filename = Filename;\r | |
1026 | Token.ModeStr = ModeStr;\r | |
1027 | Token.OptionCount = OptionCount;\r | |
1028 | Token.OptionList = OptionList;\r | |
1029 | Token.BufferSize = 0;\r | |
1030 | Token.Buffer = NULL;\r | |
ea886bef | 1031 | Token.Context = &State;\r |
dab714aa | 1032 | Token.CheckPacket = Mtftp4GetInfoCheckPacket;\r |
1033 | Token.TimeoutCallback = NULL;\r | |
1034 | Token.PacketNeeded = NULL;\r | |
1035 | \r | |
1036 | Status = EfiMtftp4ReadFile (This, &Token);\r | |
772db4bb | 1037 | \r |
dab714aa | 1038 | if (EFI_ABORTED == Status) {\r |
ea886bef | 1039 | return State.Status;\r |
dab714aa | 1040 | }\r |
1041 | \r | |
1042 | return Status;\r | |
1043 | }\r | |
772db4bb | 1044 | \r |
dab714aa | 1045 | /**\r |
1046 | Polls for incoming data packets and processes outgoing data packets.\r | |
1047 | \r | |
1048 | The Poll() function can be used by network drivers and applications to increase \r | |
1049 | the rate that data packets are moved between the communications device and the \r | |
1050 | transmit and receive queues.\r | |
1051 | In some systems, the periodic timer event in the managed network driver may not \r | |
1052 | poll the underlying communications device fast enough to transmit and/or receive \r | |
1053 | all data packets without missing incoming packets or dropping outgoing packets. \r | |
1054 | Drivers and applications that are experiencing packet loss should try calling \r | |
1055 | the Poll() function more often.\r | |
1056 | \r | |
1057 | @param This Pointer to the EFI_MTFTP4_PROTOCOL instance\r | |
1058 | \r | |
1059 | @retval EFI_SUCCESS Incoming or outgoing data was processed.\r | |
1060 | @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.\r | |
1061 | @retval EFI_NO_MAPPING When using a default address, configuration (DHCP,\r | |
1062 | BOOTP, RARP, etc.) is not finished yet.\r | |
772db4bb | 1063 | @retval EFI_INVALID_PARAMETER This is NULL.\r |
dab714aa | 1064 | @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r |
1065 | @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive \r | |
1066 | queue. Consider increasing the polling rate.\r | |
772db4bb | 1067 | \r |
1068 | **/\r | |
772db4bb | 1069 | EFI_STATUS\r |
1070 | EFIAPI\r | |
1071 | EfiMtftp4Poll (\r | |
1072 | IN EFI_MTFTP4_PROTOCOL *This\r | |
1073 | )\r | |
1074 | {\r | |
1075 | MTFTP4_PROTOCOL *Instance;\r | |
1076 | EFI_UDP4_PROTOCOL *Udp;\r | |
1077 | \r | |
1078 | if (This == NULL) {\r | |
1079 | return EFI_INVALID_PARAMETER;\r | |
1080 | }\r | |
1081 | \r | |
1082 | Instance = MTFTP4_PROTOCOL_FROM_THIS (This);\r | |
1083 | \r | |
1084 | if (Instance->State == MTFTP4_STATE_UNCONFIGED) {\r | |
1085 | return EFI_NOT_STARTED;\r | |
75dce340 | 1086 | } else if (Instance->State == MTFTP4_STATE_DESTROY) {\r |
772db4bb | 1087 | return EFI_DEVICE_ERROR;\r |
1088 | }\r | |
1089 | \r | |
b45b45b2 | 1090 | Udp = Instance->UnicastPort->Protocol.Udp4;\r |
772db4bb | 1091 | return Udp->Poll (Udp);\r |
1092 | }\r | |
1093 | \r | |
1094 | EFI_MTFTP4_PROTOCOL gMtftp4ProtocolTemplate = {\r | |
1095 | EfiMtftp4GetModeData,\r | |
1096 | EfiMtftp4Configure,\r | |
1097 | EfiMtftp4GetInfo,\r | |
1098 | EfiMtftp4ParseOptions,\r | |
1099 | EfiMtftp4ReadFile,\r | |
1100 | EfiMtftp4WriteFile,\r | |
1101 | EfiMtftp4ReadDirectory,\r | |
1102 | EfiMtftp4Poll\r | |
1103 | };\r |