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