]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/Mtftp6Dxe/Mtftp6Impl.h
NetworkPkg: Apply uncrustify changes
[mirror_edk2.git] / NetworkPkg / Mtftp6Dxe / Mtftp6Impl.h
CommitLineData
a3bcde70
HT
1/** @file\r
2 Mtftp6 internal data structure and definition declaration.\r
3\r
f3427f12 4 Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved. <BR>\r
a3bcde70 5\r
ecf98fbc 6 SPDX-License-Identifier: BSD-2-Clause-Patent\r
a3bcde70
HT
7\r
8**/\r
9\r
10#ifndef __EFI_MTFTP6_IMPL_H__\r
11#define __EFI_MTFTP6_IMPL_H__\r
12\r
13#include <Uefi.h>\r
14\r
15#include <Protocol/Udp6.h>\r
16#include <Protocol/Mtftp6.h>\r
17#include <Protocol/ServiceBinding.h>\r
18#include <Protocol/DriverBinding.h>\r
19\r
20#include <Library/DebugLib.h>\r
21#include <Library/UefiDriverEntryPoint.h>\r
22#include <Library/UefiBootServicesTableLib.h>\r
23#include <Library/UefiLib.h>\r
24#include <Library/BaseLib.h>\r
25#include <Library/NetLib.h>\r
216f7970 26#include <Library/PrintLib.h>\r
a3bcde70 27\r
d1050b9d
MK
28typedef struct _MTFTP6_SERVICE MTFTP6_SERVICE;\r
29typedef struct _MTFTP6_INSTANCE MTFTP6_INSTANCE;\r
a3bcde70
HT
30\r
31#include "Mtftp6Driver.h"\r
32#include "Mtftp6Option.h"\r
33#include "Mtftp6Support.h"\r
34\r
d1050b9d
MK
35#define MTFTP6_SERVICE_SIGNATURE SIGNATURE_32 ('M', 'F', '6', 'S')\r
36#define MTFTP6_INSTANCE_SIGNATURE SIGNATURE_32 ('M', 'F', '6', 'I')\r
a3bcde70 37\r
d1050b9d
MK
38#define MTFTP6_DEFAULT_SERVER_CMD_PORT 69\r
39#define MTFTP6_DEFAULT_TIMEOUT 3\r
40#define MTFTP6_GET_MAPPING_TIMEOUT 3\r
41#define MTFTP6_DEFAULT_MAX_RETRY 5\r
42#define MTFTP6_DEFAULT_BLK_SIZE 512\r
43#define MTFTP6_DEFAULT_WINDOWSIZE 1\r
44#define MTFTP6_TICK_PER_SECOND 10000000U\r
a3bcde70 45\r
d1050b9d
MK
46#define MTFTP6_SERVICE_FROM_THIS(a) CR (a, MTFTP6_SERVICE, ServiceBinding, MTFTP6_SERVICE_SIGNATURE)\r
47#define MTFTP6_INSTANCE_FROM_THIS(a) CR (a, MTFTP6_INSTANCE, Mtftp6, MTFTP6_INSTANCE_SIGNATURE)\r
a3bcde70 48\r
d1050b9d 49extern EFI_MTFTP6_PROTOCOL gMtftp6ProtocolTemplate;\r
a3bcde70 50\r
d1050b9d
MK
51typedef struct _MTFTP6_GETINFO_CONTEXT {\r
52 EFI_MTFTP6_PACKET **Packet;\r
53 UINT32 *PacketLen;\r
54 EFI_STATUS Status;\r
a3bcde70
HT
55} MTFTP6_GETINFO_CONTEXT;\r
56\r
57//\r
58// Control block for MTFTP6 instance, it's per configuration data.\r
59//\r
60struct _MTFTP6_INSTANCE {\r
d1050b9d
MK
61 UINT32 Signature;\r
62 EFI_HANDLE Handle;\r
63 LIST_ENTRY Link;\r
64 EFI_MTFTP6_PROTOCOL Mtftp6;\r
65 MTFTP6_SERVICE *Service;\r
66 EFI_MTFTP6_CONFIG_DATA *Config;\r
a3bcde70 67\r
d1050b9d
MK
68 EFI_MTFTP6_TOKEN *Token;\r
69 MTFTP6_EXT_OPTION_INFO ExtInfo;\r
a3bcde70 70\r
d1050b9d
MK
71 UINT16 BlkSize;\r
72 UINT16 LastBlk;\r
73 LIST_ENTRY BlkList;\r
a3bcde70 74\r
d1050b9d 75 UINT16 Operation;\r
f3427f12 76\r
d1050b9d 77 UINT16 WindowSize;\r
f3427f12
JW
78\r
79 //\r
2f6693c2 80 // Record the total received and saved block number.\r
f3427f12 81 //\r
d1050b9d 82 UINT64 TotalBlock;\r
c41da217 83\r
2f6693c2
JW
84 //\r
85 // Record the acked block number.\r
86 //\r
d1050b9d
MK
87 UINT64 AckedBlock;\r
88\r
89 EFI_IPv6_ADDRESS ServerIp;\r
90 UINT16 ServerCmdPort;\r
91 UINT16 ServerDataPort;\r
92 UDP_IO *UdpIo;\r
93\r
94 EFI_IPv6_ADDRESS McastIp;\r
95 UINT16 McastPort;\r
96 UDP_IO *McastUdpIo;\r
97\r
98 NET_BUF *LastPacket;\r
99 UINT32 CurRetry;\r
100 UINT32 MaxRetry;\r
101 UINT32 PacketToLive;\r
102 UINT32 Timeout;\r
103\r
104 EFI_TPL OldTpl;\r
105 BOOLEAN IsTransmitted;\r
106 BOOLEAN IsMaster;\r
107 BOOLEAN InDestroy;\r
a3bcde70
HT
108};\r
109\r
110//\r
111// Control block for MTFTP6 service, it's per Nic handle.\r
112//\r
113struct _MTFTP6_SERVICE {\r
d1050b9d
MK
114 UINT32 Signature;\r
115 EFI_SERVICE_BINDING_PROTOCOL ServiceBinding;\r
116 EFI_HANDLE Controller;\r
117 EFI_HANDLE Image;\r
a3bcde70 118\r
d1050b9d
MK
119 UINT16 ChildrenNum;\r
120 LIST_ENTRY Children;\r
a3bcde70
HT
121 //\r
122 // It is used to be as internal calculagraph for all instances.\r
123 //\r
d1050b9d 124 EFI_EVENT Timer;\r
a3bcde70
HT
125 //\r
126 // It is used to maintain the parent-child relationship between\r
127 // mtftp driver and udp driver.\r
128 //\r
d1050b9d 129 UDP_IO *DummyUdpIo;\r
a3bcde70
HT
130};\r
131\r
216f7970 132typedef struct {\r
d1050b9d
MK
133 EFI_SERVICE_BINDING_PROTOCOL *ServiceBinding;\r
134 UINTN NumberOfChildren;\r
135 EFI_HANDLE *ChildHandleBuffer;\r
216f7970 136} MTFTP6_DESTROY_CHILD_IN_HANDLE_BUF_CONTEXT;\r
137\r
a3bcde70
HT
138/**\r
139 Returns the current operating mode data for the MTFTP6 instance.\r
140\r
141 The GetModeData() function returns the current operating mode and\r
142 cached data packet for the MTFTP6 instance.\r
143\r
144 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
145 @param[out] ModeData The buffer in which the EFI MTFTPv6 Protocol driver mode\r
146 data is returned.\r
147\r
148 @retval EFI_SUCCESS The configuration data was returned successfully.\r
149 @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.\r
150 @retval EFI_INVALID_PARAMETER This is NULL, or ModeData is NULL.\r
151\r
152**/\r
153EFI_STATUS\r
154EFIAPI\r
155EfiMtftp6GetModeData (\r
d1050b9d
MK
156 IN EFI_MTFTP6_PROTOCOL *This,\r
157 OUT EFI_MTFTP6_MODE_DATA *ModeData\r
a3bcde70
HT
158 );\r
159\r
160/**\r
161 Initializes, changes, or resets the default operational setting for\r
162 this EFI MTFTPv6 Protocol driver instance.\r
163\r
164 The Configure() function is used to set and change the configuration\r
165 data for this EFI MTFTPv6 Protocol driver instance. The configuration\r
166 data can be reset to startup defaults by calling Configure() with\r
167 MtftpConfigData set to NULL. Whenever the instance is reset, any\r
168 pending operation is aborted. By changing the EFI MTFTPv6 Protocol\r
169 driver instance configuration data, the client can connect to\r
170 different MTFTPv6 servers. The configuration parameters in\r
171 MtftpConfigData are used as the default parameters in later MTFTPv6\r
172 operations and can be overridden in later operations.\r
173\r
174 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
175 @param[in] MtftpConfigData Pointer to the configuration data structure.\r
176\r
177 @retval EFI_SUCCESS The EFI MTFTPv6 Protocol instance was configured successfully.\r
178 @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
179 - This is NULL.\r
180 - MtftpConfigData.StationIp is neither zero nor one\r
181 of the configured IP addresses in the underlying IPv6 driver.\r
f6c8bbbe 182 - MtftpConfigData.ServerIp is not a valid IPv6 unicast address.\r
a3bcde70
HT
183 Note: It does not match the UEFI 2.3 Specification.\r
184 @retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there\r
185 is some MTFTP background operation in progress.\r
f6c8bbbe 186 - MtftpConfigData.LocalPort is already in use.\r
a3bcde70
HT
187 Note: It does not match the UEFI 2.3 Specification.\r
188 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source\r
189 address for this instance, but no source address was available for use.\r
190 @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv6 Protocol driver instance data could not be\r
191 allocated.\r
192 Note: It is not defined in the UEFI 2.3 Specification.\r
193 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI\r
194 MTFTPv6 Protocol driver instance is not configured.\r
195 Note: It is not defined in the UEFI 2.3 Specification.\r
196\r
197**/\r
198EFI_STATUS\r
199EFIAPI\r
200EfiMtftp6Configure (\r
d1050b9d
MK
201 IN EFI_MTFTP6_PROTOCOL *This,\r
202 IN EFI_MTFTP6_CONFIG_DATA *MtftpConfigData OPTIONAL\r
a3bcde70
HT
203 );\r
204\r
205/**\r
206 Get the information of the download from the server.\r
207\r
208 The GetInfo() function assembles an MTFTPv6 request packet\r
209 with options, sends it to the MTFTPv6 server, and may return\r
210 an MTFTPv6 OACK, MTFTPv6 ERROR, or ICMP ERROR packet. Retries\r
211 occur only if no response packets are received from the MTFTPv6\r
212 server before the timeout expires.\r
213\r
214 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
215 @param[in] OverrideData Data that is used to override the existing parameters. If NULL, the\r
216 default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()\r
217 function are used.\r
4f077902
SZ
218 @param[in] Filename Pointer to null-terminated ASCII file name string.\r
219 @param[in] ModeStr Pointer to null-terminated ASCII mode string. If NULL, octet will be used\r
a3bcde70
HT
220 @param[in] OptionCount Number of option/value string pairs in OptionList.\r
221 @param[in] OptionList Pointer to array of option/value string pairs. Ignored if\r
222 OptionCount is zero.\r
223 @param[out] PacketLength The number of bytes in the returned packet.\r
224 @param[out] Packet The pointer to the received packet. This buffer must be freed by\r
225 the caller.\r
226\r
227 @retval EFI_SUCCESS An MTFTPv6 OACK packet was received and is in the Packet.\r
228 Note: It does not match the UEFI 2.3 Specification.\r
229 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
230 - This is NULL.\r
231 - Filename is NULL.\r
232 - OptionCount is not zero and OptionList is NULL.\r
233 - One or more options in OptionList have wrong format.\r
234 - PacketLength is NULL.\r
235 - OverrideData.ServerIp is not a valid unicast IPv6 address.\r
236 @retval EFI_UNSUPPORTED One or more options in the OptionList are unsupported by\r
237 this implementation.\r
238 @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.\r
239 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source\r
240 address for this instance, but no source address was available for use.\r
241 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r
242 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
243 @retval EFI_TFTP_ERROR An MTFTPv6 ERROR packet was received and is in the Packet.\r
244 @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received, and the Packet is set to NULL.\r
245 Note: It is not defined in the UEFI 2.3 Specification.\r
246 @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received, and the Packet is set to NULL.\r
247 Note: It is not defined in the UEFI 2.3 Specification.\r
248 @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received, and the Packet is set to NULL.\r
249 Note: It is not defined in the UEFI 2.3 Specification.\r
250 @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received, and the Packet is set to NULL.\r
251 @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received, and the Packet is set to NULL.\r
252 Note: It does not match the UEFI 2.3 Specification.\r
253 @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv6 packet was received and is in the Packet.\r
254 @retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.\r
255 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
256\r
257**/\r
258EFI_STATUS\r
259EFIAPI\r
260EfiMtftp6GetInfo (\r
d1050b9d
MK
261 IN EFI_MTFTP6_PROTOCOL *This,\r
262 IN EFI_MTFTP6_OVERRIDE_DATA *OverrideData OPTIONAL,\r
263 IN UINT8 *Filename,\r
264 IN UINT8 *ModeStr OPTIONAL,\r
265 IN UINT8 OptionCount,\r
266 IN EFI_MTFTP6_OPTION *OptionList OPTIONAL,\r
267 OUT UINT32 *PacketLength,\r
268 OUT EFI_MTFTP6_PACKET **Packet OPTIONAL\r
a3bcde70
HT
269 );\r
270\r
271/**\r
272 Parse the options in an MTFTPv6 OACK packet.\r
273\r
274 The ParseOptions() function parses the option fields in an MTFTPv6 OACK\r
275 packet and returns the number of options that were found, and optionally,\r
276 a list of pointers to the options in the packet. If one or more of the\r
277 option fields are not valid, then EFI_PROTOCOL_ERROR is returned and\r
278 *OptionCount and *OptionList stop at the last valid option.\r
279\r
280 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
281 @param[in] PacketLen Length of the OACK packet to be parsed.\r
282 @param[in] Packet Pointer to the OACK packet to be parsed.\r
283 @param[out] OptionCount Pointer to the number of options in the following OptionList.\r
284 @param[out] OptionList Pointer to EFI_MTFTP6_OPTION storage. Each pointer in the\r
285 OptionList points to the corresponding MTFTP option buffer\r
286 in the Packet. Call the EFI Boot Service FreePool() to\r
287 release the OptionList if the options in this OptionList\r
288 are not needed any more.\r
289\r
290 @retval EFI_SUCCESS The OACK packet was valid and the OptionCount, and\r
291 OptionList parameters have been updated.\r
292 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
293 - PacketLen is 0.\r
294 - Packet is NULL or Packet is not a valid MTFTPv6 packet.\r
295 - OptionCount is NULL.\r
296 @retval EFI_NOT_FOUND No options were found in the OACK packet.\r
297 @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array can not be allocated.\r
298 @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.\r
299\r
300**/\r
301EFI_STATUS\r
302EFIAPI\r
303EfiMtftp6ParseOptions (\r
d1050b9d
MK
304 IN EFI_MTFTP6_PROTOCOL *This,\r
305 IN UINT32 PacketLen,\r
306 IN EFI_MTFTP6_PACKET *Packet,\r
307 OUT UINT32 *OptionCount,\r
308 OUT EFI_MTFTP6_OPTION **OptionList OPTIONAL\r
a3bcde70
HT
309 );\r
310\r
311/**\r
312 Download a file from an MTFTPv6 server.\r
313\r
314 The ReadFile() function is used to initialize and start an MTFTPv6 download\r
315 process and optionally wait for completion. When the download operation\r
316 completes, whether successfully or not, the Token.Status field is updated\r
317 by the EFI MTFTPv6 Protocol driver, and then Token.Event is signaled if it\r
318 is not NULL.\r
319 Data can be downloaded from the MTFTPv6 server into either of the following\r
320 locations:\r
321 - A fixed buffer that is pointed to by Token.Buffer.\r
322 - A download service function that is pointed to by Token.CheckPacket.\r
323 If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket\r
324 will be called first. If the call is successful, the packet will be stored\r
325 in Token.Buffer.\r
326\r
327 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
328 @param[in] Token Pointer to the token structure to provide the parameters that are\r
329 used in this operation.\r
330\r
331 @retval EFI_SUCCESS The data file has been transferred successfully.\r
332 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
333 @retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the\r
334 downloaded data in downloading process.\r
335 Note: It does not match the UEFI 2.3 Specification.\r
336 @retval EFI_ABORTED Current operation is aborted by user.\r
337 @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.\r
338 Note: It is not defined in the UEFI 2.3 Specification.\r
339 @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.\r
340 Note: It is not defined in the UEFI 2.3 Specification.\r
341 @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.\r
342 Note: It is not defined in the UEFI 2.3 Specification.\r
343 @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.\r
344 Note: It is not defined in the UEFI 2.3 Specification.\r
345 @retval EFI_ICMP_ERROR An ICMP ERROR packet was received.\r
346 @retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.\r
347 @retval EFI_TFTP_ERROR An MTFTPv6 ERROR packet was received.\r
348 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
349\r
350**/\r
351EFI_STATUS\r
352EFIAPI\r
353EfiMtftp6ReadFile (\r
d1050b9d
MK
354 IN EFI_MTFTP6_PROTOCOL *This,\r
355 IN EFI_MTFTP6_TOKEN *Token\r
a3bcde70
HT
356 );\r
357\r
358/**\r
359 Send a file to an MTFTPv6 server.\r
360\r
361 The WriteFile() function is used to initialize an uploading operation\r
362 with the given option list, and optionally, wait for completion. If one\r
363 or more of the options is not supported by the server, the unsupported\r
364 options are ignored and a standard TFTP process starts instead. When\r
365 the upload process completes, whether successfully or not, Token.Event\r
366 is signaled, and the EFI MTFTPv6 Protocol driver updates Token.Status.\r
367 The caller can supply the data to be uploaded in the following two modes:\r
368 - Through the user-provided buffer.\r
369 - Through a callback function.\r
370 With the user-provided buffer, the Token.BufferSize field indicates\r
371 the length of the buffer, and the driver will upload the data in the\r
372 buffer. With an EFI_MTFTP6_PACKET_NEEDED callback function, the driver\r
373 will call this callback function to get more data from the user to upload.\r
374\r
375 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
376 @param[in] Token Pointer to the token structure to provide the parameters that are\r
377 used in this operation.\r
378\r
379 @retval EFI_SUCCESS The upload session has started.\r
380 @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r
381 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
382 - This is NULL.\r
383 - Token is NULL.\r
384 - Token.Filename is NULL.\r
385 - Token.OptionCount is not zero and Token.OptionList is NULL.\r
386 - One or more options in Token.OptionList have wrong format.\r
387 - Token.Buffer and Token.PacketNeeded are both NULL.\r
388 - Token.OverrideData.ServerIp is not valid unicast IPv6 addresses.\r
389 @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are not\r
390 supported by this implementation.\r
391 @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.\r
392 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source\r
393 address for this instance, but no source address was available for use.\r
394 @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv6 session.\r
395 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
396 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r
397 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
398\r
399**/\r
400EFI_STATUS\r
401EFIAPI\r
402EfiMtftp6WriteFile (\r
d1050b9d
MK
403 IN EFI_MTFTP6_PROTOCOL *This,\r
404 IN EFI_MTFTP6_TOKEN *Token\r
a3bcde70
HT
405 );\r
406\r
407/**\r
408 Download a data file directory from an MTFTPv6 server.\r
409\r
410 The ReadDirectory() function is used to return a list of files on the\r
411 MTFTPv6 server that are logically (or operationally) related to\r
412 Token.Filename. The directory request packet that is sent to the server\r
413 is built with the option list that was provided by caller, if present.\r
414 The file information that the server returns is put into either of\r
415 the following locations:\r
416 - A fixed buffer that is pointed to by Token.Buffer.\r
417 - A download service function that is pointed to by Token.CheckPacket.\r
418 If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket\r
419 will be called first. If the call is successful, the packet will be stored\r
420 in Token.Buffer.\r
421\r
422 @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.\r
423 @param[in] Token Pointer to the token structure to provide the parameters that are\r
424 used in this operation.\r
425\r
426 @retval EFI_SUCCESS The MTFTPv6 related file "directory" has been downloaded.\r
427 @retval EFI_UNSUPPORTED The EFI MTFTPv6 Protocol driver does not support this function.\r
428 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:\r
429 - This is NULL.\r
430 - Token is NULL.\r
431 - Token.Filename is NULL.\r
432 - Token.OptionCount is not zero and Token.OptionList is NULL.\r
433 - One or more options in Token.OptionList have wrong format.\r
434 - Token.Buffer and Token.CheckPacket are both NULL.\r
435 - Token.OverrideData.ServerIp is not valid unicast IPv6 addresses.\r
436 @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are not\r
437 supported by this implementation.\r
438 @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.\r
439 @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source\r
440 address for this instance, but no source address was available for use.\r
441 @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv6 session.\r
442 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
443 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.\r
444 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
445\r
446**/\r
447EFI_STATUS\r
448EFIAPI\r
449EfiMtftp6ReadDirectory (\r
d1050b9d
MK
450 IN EFI_MTFTP6_PROTOCOL *This,\r
451 IN EFI_MTFTP6_TOKEN *Token\r
a3bcde70
HT
452 );\r
453\r
454/**\r
455 Polls for incoming data packets and processes outgoing data packets.\r
456\r
457 The Poll() function can be used by network drivers and applications\r
458 to increase the rate that data packets are moved between the\r
459 communications device and the transmit and receive queues.In some\r
460 systems, the periodic timer event in the managed network driver may\r
461 not poll the underlying communications device fast enough to transmit\r
462 and/or receive all data packets without missing incoming packets or\r
463 dropping outgoing packets. Drivers and applications that are\r
464 experiencing packet loss should try calling the Poll() function\r
465 more often.\r
466\r
467 @param[in] This The MTFTP6 protocol instance.\r
468\r
469\r
470 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
471 @retval EFI_NOT_STARTED This EFI MTFTPv6 Protocol instance has not been started.\r
472 @retval EFI_INVALID_PARAMETER This is NULL.\r
473 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
474 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
475 Consider increasing the polling rate.\r
476\r
477**/\r
478EFI_STATUS\r
479EFIAPI\r
480EfiMtftp6Poll (\r
d1050b9d 481 IN EFI_MTFTP6_PROTOCOL *This\r
a3bcde70
HT
482 );\r
483\r
484#endif\r