]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Protocol/Ftp4.h
Add into MdePkg definitions for the SMM General Purpose Input (GPI) Dispatch2 Protoco...
[mirror_edk2.git] / MdePkg / Include / Protocol / Ftp4.h
CommitLineData
badd7e61 1/** @file\r
2 EFI FTPv4 (File Transfer Protocol version 4) Protocol Definition\r
3 The EFI FTPv4 Protocol is used to locate communication devices that are \r
4 supported by an EFI FTPv4 Protocol driver and to create and destroy instances\r
5 of the EFI FTPv4 Protocol child protocol driver that can use the underlying\r
6 communication device.\r
7 The definitions in this file are defined in UEFI Specification 2.3, which have\r
8 not been verified by one implementation yet.\r
9\r
10 Copyright (c) 2009, Intel Corporation\r
11 All rights reserved. This program and the accompanying materials\r
12 are licensed and made available under the terms and conditions of the BSD License\r
13 which accompanies this distribution. The full text of the license may be found at\r
14 http://opensource.org/licenses/bsd-license.php\r
15\r
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
18\r
19**/\r
20\r
21#ifndef __EFI_FTP4_PROTOCOL_H__\r
22#define __EFI_FTP4_PROTOCOL_H__\r
23\r
24\r
25#define EFI_FTP4_SERVICE_BINDING_PROTOCOL_GUID \\r
26 { \\r
27 0xfaaecb1, 0x226e, 0x4782, {0xaa, 0xce, 0x7d, 0xb9, 0xbc, 0xbf, 0x4d, 0xaf } \\r
28 }\r
29\r
30#define EFI_FTP4_PROTOCOL_GUID \\r
31 { \\r
32 0xeb338826, 0x681b, 0x4295, {0xb3, 0x56, 0x2b, 0x36, 0x4c, 0x75, 0x7b, 0x9 } \\r
33 }\r
34\r
35typedef struct _EFI_FTP4_PROTOCOL EFI_FTP4_PROTOCOL;\r
36\r
37///\r
38/// EFI_FTP4_CONNECTION_TOKEN\r
39///\r
40typedef struct {\r
41 /// \r
42 /// The Event to signal after the connection is established and Status field is updated \r
43 /// by the EFI FTP v4 Protocol driver. The type of Event must be \r
44 /// EVENT_NOTIFY_SIGNAL, and its Task Priority Level (TPL) must be lower than or \r
45 /// equal to TPL_CALLBACK. If it is set to NULL, this function will not return until the \r
46 /// function completes.\r
47 /// \r
48 EFI_EVENT Event; \r
49 ///\r
50 /// The variable to receive the result of the completed operation.\r
51 /// EFI_SUCCESS: The FTP connection is established successfully\r
52 /// EFI_ACCESS_DENIED: The FTP server denied the access the user's request to access it. \r
53 /// EFI_CONNECTION_RESET: The connect fails because the connection is reset either by instance \r
54 /// itself or communication peer.\r
55 /// EFI_TIMEOUT: The connection establishment timer expired and no more specific \r
56 /// information is available.\r
57 /// EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable error is \r
58 /// received. \r
59 /// EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable error is \r
60 /// received. \r
61 /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable error is \r
62 /// received.\r
63 /// EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port \r
64 /// unreachable error is received.\r
65 /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP \r
66 /// error is received.\r
67 /// EFI_DEVICE_ERROR: An unexpected system or network error occurred.\r
68 /// \r
69 EFI_STATUS Status;\r
70} EFI_FTP4_CONNECTION_TOKEN;\r
71\r
72///\r
73/// EFI_FTP4_CONFIG_DATA \r
74///\r
75typedef struct {\r
76 /// \r
77 /// Pointer to a ASCII string that contains user name. The caller is \r
78 /// responsible for freeing Username after GetModeData() is called.\r
79 /// \r
80 UINT8 *Username;\r
81 /// \r
82 /// Pointer to a ASCII string that contains password. The caller is \r
83 /// responsible for freeing Password after GetModeData() is called.\r
84 /// \r
85 UINT8 *Password;\r
86 /// \r
87 /// Set it to TRUE to initiate an active data connection. Set it to \r
88 /// FALSE to initiate a passive data connection.\r
89 /// \r
90 BOOLEAN Active;\r
91 /// \r
92 /// Boolean value indicating if default network settting used.\r
93 /// \r
94 BOOLEAN UseDefaultSetting;\r
95 /// \r
96 /// IP address of station if UseDefaultSetting is FALSE.\r
97 /// \r
98 EFI_IPv4_ADDRESS StationIp;\r
99 /// \r
100 /// Subnet mask of station if UseDefaultSetting is FALSE.\r
101 /// \r
102 EFI_IPv4_ADDRESS SubnetMask;\r
103 /// \r
104 /// IP address of gateway if UseDefaultSetting is FALSE.\r
105 /// \r
106 EFI_IPv4_ADDRESS GatewayIp;\r
107 /// \r
108 /// IP address of FTPv4 server.\r
109 /// \r
110 EFI_IPv4_ADDRESS ServerIp;\r
111 /// \r
112 /// FTPv4 server port number of control connection, and the default \r
113 /// value is 21 as convention.\r
114 /// \r
115 UINT16 ServerPort;\r
116 /// \r
117 /// FTPv4 server port number of data connection. If it is zero, use \r
118 /// (ServerPort - 1) by convention. \r
119 /// \r
120 UINT16 AltDataPort;\r
121 /// \r
122 /// A byte indicate the representation type. The right 4 bit is used for \r
123 /// first parameter, the left 4 bit is use for second parameter\r
124 /// - For the first parameter, 0x0 = image, 0x1 = EBCDIC, 0x2 = ASCII, 0x3 = local\r
125 /// - For the second parameter, 0x0 = Non-print, 0x1 = Telnet format effectors, 0x2 = \r
126 /// Carriage Control.\r
127 /// - If it is a local type, the second parameter is the local byte byte size.\r
128 /// - If it is a image type, the second parameter is undefined.\r
129 /// \r
130 UINT8 RepType;\r
131 /// \r
132 /// Defines the file structure in FTP used. 0x00 = file, 0x01 = record, 0x02 = page.\r
133 /// \r
134 UINT8 FileStruct;\r
135 /// \r
136 /// Defines the transifer mode used in FTP. 0x00 = stream, 0x01 = Block, 0x02 = Compressed.\r
137 /// \r
138 UINT8 TransMode;\r
139} EFI_FTP4_CONFIG_DATA;\r
140\r
141typedef struct _EFI_FTP4_COMMAND_TOKEN EFI_FTP4_COMMAND_TOKEN;\r
142\r
143/**\r
144 Callback function when process inbound or outbound data.\r
145\r
146 If it is receiving function that leads to inbound data, the callback function\r
147 is called when data buffer is full. Then, old data in the data buffer should be\r
148 flushed and new data is stored from the beginning of data buffer.\r
149 If it is a transmit function that lead to outbound data and the size of \r
150 Data in daata buffer has been transmitted, this callback function is called to \r
151 supply additional data to be transmitted. \r
152\r
153 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
154 @param[in] Token Pointer to the token structure to provide the parameters that\r
155 are used in this operation.\r
156 @return User defined Status.\r
157\r
158**/\r
159typedef\r
160EFI_STATUS \r
161(EFIAPI *EFI_FTP4_DATA_CALLBACK)( \r
162 IN EFI_FTP4_PROTOCOL *This,\r
163 IN EFI_FTP4_COMMAND_TOKEN *Token\r
164 );\r
165\r
166///\r
167/// EFI_FTP4_COMMAND_TOKEN\r
168///\r
169struct _EFI_FTP4_COMMAND_TOKEN {\r
170 /// \r
171 /// The Event to signal after request is finished and Status field \r
172 /// is updated by the EFI FTP v4 Protocol driver. The type of Event \r
173 /// must be EVT_NOTIFY_SIGNAL, and its Task Priority Level \r
174 /// (TPL) must be lower than or equal to TPL_CALLBACK. If it is \r
175 /// set to NULL, related function must wait until the function \r
176 /// completes.\r
177 /// \r
178 EFI_EVENT Event; \r
179 /// \r
180 /// Pointer to an ASCIIZ path name string. \r
181 /// \r
182 UINT8 *Pathname;\r
183 /// \r
184 /// The size of data buffer in bytes.\r
185 /// \r
186 UINT64 DataBufferSize; \r
187 /// \r
188 /// Pointer to the data buffer. Data downloaded from FTP server \r
189 /// through connection is downloaded here.\r
190 /// \r
191 VOID *DataBuffer;\r
192 /// \r
193 /// Pointer to a callback function. If it is receiving function that leads \r
194 /// to inbound data, the callback function is called when databuffer is \r
195 /// full. Then, old data in the data buffer should be flushed and new \r
196 /// data is stored from the beginning of data buffer. If it is a transmit \r
197 /// function that lead to outbound data and DataBufferSize of \r
198 /// Data in DataBuffer has been transmitted, this callback \r
199 /// function is called to supply additional data to be transmitted. The \r
200 /// size of additional data to be transmitted is indicated in \r
201 /// DataBufferSize, again. If there is no data remained, \r
202 /// DataBufferSize should be set to 0.\r
203 /// \r
204 EFI_FTP4_DATA_CALLBACK *DataCallback;\r
205 /// \r
206 /// Pointer to the parameter for DataCallback.\r
207 /// \r
208 VOID *Context;\r
209 /// \r
210 /// The variable to receive the result of the completed operation.\r
211 /// EFI_SUCCESS: The FTP command is completed successfully.\r
212 /// EFI_ACCESS_DENIED: The FTP server denied the access to the requested file.\r
213 /// EFI_CONNECTION_RESET: The connect fails because the connection is reset either\r
214 /// by instance itself or communication peer.\r
215 /// EFI_TIMEOUT: The connection establishment timer expired and no more \r
216 /// specific information is available.\r
217 /// EFI_NETWORK_UNREACHABLE: The active open fails because an ICMP network unreachable\r
218 /// error is received. \r
219 /// EFI_HOST_UNREACHABLE: The active open fails because an ICMP host unreachable\r
220 /// error is received. \r
221 /// EFI_PROTOCOL_UNREACHABLE: The active open fails because an ICMP protocol unreachable\r
222 /// error is received.\r
223 /// EFI_PORT_UNREACHABLE: The connection establishment timer times out and an ICMP port\r
224 /// unreachable error is received.\r
225 /// EFI_ICMP_ERROR: The connection establishment timer timeout and some other ICMP\r
226 /// error is received.\r
227 /// EFI_DEVICE_ERROR: An unexpected system or network error occurred.\r
228 ///\r
229 EFI_STATUS Status;\r
230};\r
231\r
232/**\r
233 Gets the current operational settings.\r
234\r
235 The GetModeData() function reads the current operational settings of this\r
236 EFI FTPv4 Protocol driver instance. EFI_FTP4_CONFIG_DATA is defined in the \r
237 EFI_FTP4_PROTOCOL.Configure.\r
238\r
239 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
240 @param[out] ModeData Pointer to storage for the EFI FTPv4 Protocol driver \r
241 mode data. The string buffers for Username and Password\r
242 in EFI_FTP4_CONFIG_DATA are allocated by the function,\r
243 and the caller should take the responsibility to free the \r
244 buffer later.\r
245\r
246 @retval EFI_SUCCESS This function is called successfully.\r
247 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
248 - This is NULL.\r
249 - ModeData is NULL.\r
250 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started\r
251 @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.\r
252 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
253\r
254**/\r
255typedef \r
256EFI_STATUS \r
257(EFIAPI *EFI_FTP4_GET_MODE_DATA)(\r
258 IN EFI_FTP4_PROTOCOL *This,\r
259 OUT EFI_FTP4_CONFIG_DATA *ModeData\r
260 );\r
261\r
262/**\r
263 Disconnecting a FTP connection gracefully.\r
264\r
265 The Connect() function will initiate a connection request to the remote FTP server\r
266 with the corresponding connection token. If this function returns EFI_SUCCESS, the \r
267 connection sequence is initiated successfully. If the connection succeeds or faild\r
268 due to any error, the Token->Event will be signaled and Token->Status will be updated\r
269 accordingly.\r
270\r
271 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
272 @param[in] Token Pointer to the token used to establish control connection.\r
273\r
274 @retval EFI_SUCCESS The connection sequence is successfully initiated.\r
275 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
276 - This is NULL.\r
277 - Token is NULL.\r
278 - Token->Event is NULL.\r
279 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started.\r
280 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
281 RARP, etc.) is not finished yet.\r
282 @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.\r
283 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
284\r
285**/\r
286typedef\r
287EFI_STATUS\r
288(EFIAPI *EFI_FTP4_CONNECT)(\r
289 IN EFI_FTP4_PROTOCOL *This,\r
290 IN EFI_FTP4_CONNECTION_TOKEN *Token\r
291 );\r
292\r
293/**\r
294 Disconnecting a FTP connection gracefully.\r
295\r
296 The Close() function will initiate a close request to the remote FTP server with the\r
297 corresponding connection token. If this function returns EFI_SUCCESS, the control \r
298 connection with the remote FTP server is closed.\r
299\r
300 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
301 @param[in] Token Pointer to the token used to close control connection.\r
302\r
303 @retval EFI_SUCCESS The close request is successfully initiated.\r
304 @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:\r
305 - This is NULL.\r
306 - Token is NULL.\r
307 - Token->Event is NULL.\r
308 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started.\r
309 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
310 RARP, etc.) is not finished yet.\r
311 @retval EFI_OUT_OF_RESOURCES Could not allocate enough resource to finish the operation.\r
312 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.\r
313\r
314**/\r
315typedef\r
316EFI_STATUS\r
317(EFIAPI *EFI_FTP4_CLOSE)(\r
318 IN EFI_FTP4_PROTOCOL *This,\r
319 IN EFI_FTP4_CONNECTION_TOKEN *Token\r
320 );\r
321\r
322/**\r
323 Sets or clears the operational parameters for the FTP child driver.\r
324\r
325 The Configure() function will configure the connected FTP session with the \r
326 configuration setting specified in FtpConfigData. The configuration data can\r
327 be reset by calling Configure() with FtpConfigData set to NULL.\r
328\r
329 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
330 @param[in] FtpConfigData Pointer to configuration data that will be assigned to \r
331 the FTP child driver instance. If NULL, the FTP child\r
332 driver instance is reset to startup defaults and all \r
333 pending transmit and receive requests are flushed.\r
334\r
335 @retval EFI_SUCCESS The FTPv4 driver was configured successfully.\r
336 @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:\r
337 - This is NULL.\r
338 - FtpConfigData.RepType is invalid.\r
339 - FtpConfigData.FileStruct is invalid.\r
340 - FtpConfigData.TransMode is invalid.\r
341 - IP address in FtpConfigData is invalid.\r
342 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
343 RARP, etc.) is not finished yet.\r
344 @retval EFI_UNSUPPORTED One or more of the configuration parameters are not supported\r
345 by this implementation. \r
346 @retval EFI_OUT_OF_RESOURCES The EFI FTPv4 Protocol driver instance data could not be \r
347 allocated.\r
348 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI FTPv4 \r
349 Protocol driver instance is not configured.\r
350\r
351**/\r
352typedef\r
353EFI_STATUS\r
354(EFIAPI *EFI_FTP4_CONFIGURE)(\r
355 IN EFI_FTP4_PROTOCOL *This,\r
356 IN EFI_FTP4_CONFIG_DATA *FtpConfigData OPTIONAL\r
357 );\r
358\r
359\r
360/**\r
361 Downloads a file from an FTPv4 server. \r
362\r
363 The ReadFile() function is used to initialize and start an FTPv4 download process\r
364 and optionally wait for completion. When the download operation completes, whether\r
365 successfully or not, the Token.Status field is updated by the EFI FTPv4 Protocol \r
366 driver and then Token.Event is signaled (if it is not NULL).\r
367\r
368 Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size\r
369 is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for \r
370 processing data and then new data will be placed at the beginning of Token.DataBuffer.\r
371\r
372 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
373 @param[in] Token Pointer to the token structure to provide the parameters that\r
374 are used in this operation.\r
375\r
376 @retval EFI_SUCCESS The data file is being downloaded successfully.\r
377 @retval EFI_INVALID_PARAMETER One or more of the parameters is not valid.\r
378 - This is NULL.\r
379 - Token is NULL.\r
380 - Token.Pathname is NULL.\r
381 - Token. DataBuffer is NULL.\r
382 - Token. DataBufferSize is 0.\r
383 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started.\r
384 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
385 RARP, etc.) is not finished yet.\r
386 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
387 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
388\r
389**/\r
390typedef \r
391EFI_STATUS \r
392(EFIAPI *EFI_FTP4_READ_FILE)(\r
393 IN EFI_FTP4_PROTOCOL *This,\r
394 IN EFI_FTP4_COMMAND_TOKEN *Token\r
395 );\r
396\r
397/**\r
398 Uploads a file from an FTPv4 server. \r
399\r
400 The WriteFile() function is used to initialize and start an FTPv4 upload process and\r
401 optionally wait for completion. When the upload operation completes, whether successfully\r
402 or not, the Token.Status field is updated by the EFI FTPv4 Protocol driver and then\r
403 Token.Event is signaled (if it is not NULL). Data to be uploaded to server is stored\r
404 into Token.DataBuffer. Token.DataBufferSize is the number bytes to be transferred. \r
405 If the file size is larger than Token.DataBufferSize, Token.DataCallback will be called\r
406 to allow for processing data and then new data will be placed at the beginning of \r
407 Token.DataBuffer. Token.DataBufferSize is updated to reflect the actual number of bytes\r
408 to be transferred. Token.DataBufferSize is set to 0 by the call back to indicate the\r
409 completion of data transfer.\r
410\r
411 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
412 @param[in] Token Pointer to the token structure to provide the parameters that\r
413 are used in this operation.\r
414\r
415 @retval EFI_SUCCESS TThe data file is being uploaded successfully.\r
416 @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r
417 @retval EFI_INVALID_PARAMETER One or more of the parameters is not valid.\r
418 - This is NULL.\r
419 - Token is NULL.\r
420 - Token.Pathname is NULL.\r
421 - Token. DataBuffer is NULL.\r
422 - Token. DataBufferSize is 0.\r
423 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started.\r
424 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
425 RARP, etc.) is not finished yet.\r
426 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
427 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
428\r
429**/\r
430typedef \r
431EFI_STATUS \r
432(EFIAPI *EFI_FTP4_WRITE_FILE)(\r
433 IN EFI_FTP4_PROTOCOL *This,\r
434 IN EFI_FTP4_COMMAND_TOKEN *Token\r
435 );\r
436\r
437/**\r
438 Download a data file "directory" from a FTPv4 server. May be unsupported in some EFI \r
439 implementations.\r
440\r
441 The ReadDirectory() function is used to return a list of files on the FTPv4 server that\r
442 logically (or operationally) related to Token.Pathname, and optionally wait for completion.\r
443 When the download operation completes, whether successfully or not, the Token.Status field \r
444 is updated by the EFI FTPv4 Protocol driver and then Token.Event is signaled (if it is not\r
445 NULL). Data will be downloaded from the FTPv4 server into Token.DataBuffer. If the file size\r
446 is larger than Token.DataBufferSize, Token.DataCallback will be called to allow for processing\r
447 data and then new data will be placed at the beginning of Token.DataBuffer. \r
448\r
449 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
450 @param[in] Token Pointer to the token structure to provide the parameters that\r
451 are used in this operation.\r
452\r
453 @retval EFI_SUCCESS The file list information is being downloaded successfully.\r
454 @retval EFI_UNSUPPORTED The operation is not supported by this implementation.\r
455 @retval EFI_INVALID_PARAMETER One or more of the parameters is not valid.\r
456 - This is NULL.\r
457 - Token is NULL.\r
458 - Token. DataBuffer is NULL.\r
459 - Token. DataBufferSize is 0.\r
460 @retval EFI_NOT_STARTED The EFI FTPv4 Protocol driver has not been started.\r
461 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP, \r
462 RARP, etc.) is not finished yet.\r
463 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.\r
464 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.\r
465\r
466**/\r
467typedef\r
468EFI_STATUS\r
469(EFIAPI *EFI_FTP4_READ_DIRECTORY)(\r
470 IN EFI_FTP4_PROTOCOL *This,\r
471 IN EFI_FTP4_COMMAND_TOKEN *Token\r
472 );\r
473\r
474/**\r
475 Polls for incoming data packets and processes outgoing data packets. \r
476\r
477 The Poll() function can be used by network drivers and applications to increase the\r
478 rate that data packets are moved between the communications device and the transmit\r
479 and receive queues. In some systems, the periodic timer event in the managed network\r
480 driver may not poll the underlying communications device fast enough to transmit \r
481 and/or receive all data packets without missing incoming packets or dropping outgoing\r
482 packets. Drivers and applications that are experiencing packet loss should try calling\r
483 the Poll() function more often. \r
484\r
485 @param[in] This Pointer to the EFI_FTP4_PROTOCOL instance.\r
486\r
487 @retval EFI_SUCCESS Incoming or outgoing data was processed.\r
488 @retval EFI_NOT_STARTED This EFI FTPv4 Protocol instance has not been started.\r
489 @retval EFI_INVALID_PARAMETER This is NULL.\r
490 @retval EFI_DEVICE_ERROR EapAuthType An unexpected system or network error occurred.\r
491 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.\r
492 Consider increasing the polling rate.\r
493\r
494**/\r
495typedef\r
496EFI_STATUS\r
497(EFIAPI *EFI_FTP4_POLL)(\r
498 IN EFI_FTP4_PROTOCOL *This\r
499 );\r
500\r
501///\r
502/// EFI_FTP4_PROTOCOL \r
503/// provides basic services for client-side FTP (File Transfer Protocol) \r
504/// operations.\r
505///\r
506struct _EFI_FTP4_PROTOCOL {\r
507 EFI_FTP4_GET_MODE_DATA GetModeData;\r
508 EFI_FTP4_CONNECT Connect;\r
509 EFI_FTP4_CLOSE Close;\r
510 EFI_FTP4_CONFIGURE Configure;\r
511 EFI_FTP4_READ_FILE ReadFile;\r
512 EFI_FTP4_WRITE_FILE WriteFile;\r
513 EFI_FTP4_READ_DIRECTORY ReadDirectory;\r
514 EFI_FTP4_POLL Poll;\r
515};\r
516\r
517extern EFI_GUID gEfiFtp4ServiceBindingProtocolGuid;\r
518extern EFI_GUID gEfiFtp4ProtocolGuid;\r
519\r
520#endif\r
521\r