2 EFI Multicast Trivial File Transfer Protocol Definition
4 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
5 SPDX-License-Identifier: BSD-2-Clause-Patent
7 @par Revision Reference:
8 This Protocol is introduced in UEFI Specification 2.0
12 #ifndef __EFI_MTFTP4_PROTOCOL_H__
13 #define __EFI_MTFTP4_PROTOCOL_H__
15 #define EFI_MTFTP4_SERVICE_BINDING_PROTOCOL_GUID \
17 0x2FE800BE, 0x8F01, 0x4aa6, {0x94, 0x6B, 0xD7, 0x13, 0x88, 0xE1, 0x83, 0x3F } \
20 #define EFI_MTFTP4_PROTOCOL_GUID \
22 0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \
25 typedef struct _EFI_MTFTP4_PROTOCOL EFI_MTFTP4_PROTOCOL
;
26 typedef struct _EFI_MTFTP4_TOKEN EFI_MTFTP4_TOKEN
;
29 //MTFTP4 packet opcode definition
31 #define EFI_MTFTP4_OPCODE_RRQ 1
32 #define EFI_MTFTP4_OPCODE_WRQ 2
33 #define EFI_MTFTP4_OPCODE_DATA 3
34 #define EFI_MTFTP4_OPCODE_ACK 4
35 #define EFI_MTFTP4_OPCODE_ERROR 5
36 #define EFI_MTFTP4_OPCODE_OACK 6
37 #define EFI_MTFTP4_OPCODE_DIR 7
38 #define EFI_MTFTP4_OPCODE_DATA8 8
39 #define EFI_MTFTP4_OPCODE_ACK8 9
42 // MTFTP4 error code definition
44 #define EFI_MTFTP4_ERRORCODE_NOT_DEFINED 0
45 #define EFI_MTFTP4_ERRORCODE_FILE_NOT_FOUND 1
46 #define EFI_MTFTP4_ERRORCODE_ACCESS_VIOLATION 2
47 #define EFI_MTFTP4_ERRORCODE_DISK_FULL 3
48 #define EFI_MTFTP4_ERRORCODE_ILLEGAL_OPERATION 4
49 #define EFI_MTFTP4_ERRORCODE_UNKNOWN_TRANSFER_ID 5
50 #define EFI_MTFTP4_ERRORCODE_FILE_ALREADY_EXISTS 6
51 #define EFI_MTFTP4_ERRORCODE_NO_SUCH_USER 7
52 #define EFI_MTFTP4_ERRORCODE_REQUEST_DENIED 8
55 // MTFTP4 pacekt definitions
62 } EFI_MTFTP4_REQ_HEADER
;
67 } EFI_MTFTP4_OACK_HEADER
;
73 } EFI_MTFTP4_DATA_HEADER
;
78 } EFI_MTFTP4_ACK_HEADER
;
84 } EFI_MTFTP4_DATA8_HEADER
;
89 } EFI_MTFTP4_ACK8_HEADER
;
94 UINT8 ErrorMessage
[1];
95 } EFI_MTFTP4_ERROR_HEADER
;
99 /// Type of packets as defined by the MTFTPv4 packet opcodes.
103 /// Read request packet header.
105 EFI_MTFTP4_REQ_HEADER Rrq
;
107 /// Write request packet header.
109 EFI_MTFTP4_REQ_HEADER Wrq
;
111 /// Option acknowledge packet header.
113 EFI_MTFTP4_OACK_HEADER Oack
;
115 /// Data packet header.
117 EFI_MTFTP4_DATA_HEADER Data
;
119 /// Acknowledgement packet header.
121 EFI_MTFTP4_ACK_HEADER Ack
;
123 /// Data packet header with big block number.
125 EFI_MTFTP4_DATA8_HEADER Data8
;
127 /// Acknowledgement header with big block num.
129 EFI_MTFTP4_ACK8_HEADER Ack8
;
131 /// Error packet header.
133 EFI_MTFTP4_ERROR_HEADER Error
;
139 /// MTFTP4 option definition.
148 BOOLEAN UseDefaultSetting
;
149 EFI_IPv4_ADDRESS StationIp
;
150 EFI_IPv4_ADDRESS SubnetMask
;
152 EFI_IPv4_ADDRESS GatewayIp
;
153 EFI_IPv4_ADDRESS ServerIp
;
154 UINT16 InitialServerPort
;
157 } EFI_MTFTP4_CONFIG_DATA
;
161 EFI_MTFTP4_CONFIG_DATA ConfigData
;
162 UINT8 SupportedOptionCount
;
163 UINT8
**SupportedOptoins
;
164 UINT8 UnsupportedOptionCount
;
165 UINT8
**UnsupportedOptoins
;
166 } EFI_MTFTP4_MODE_DATA
;
170 EFI_IPv4_ADDRESS GatewayIp
;
171 EFI_IPv4_ADDRESS ServerIp
;
175 } EFI_MTFTP4_OVERRIDE_DATA
;
178 // Protocol interfaces definition
182 A callback function that is provided by the caller to intercept
183 the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the
184 EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept
185 EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to
186 EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().
188 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
189 @param Token The token that the caller provided in the
190 EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()
191 or ReadDirectory() function.
192 @param PacketLen Indicates the length of the packet.
193 @param Packet The pointer to an MTFTPv4 packet.
195 @retval EFI_SUCCESS The operation was successful.
196 @retval Others Aborts the transfer process.
201 (EFIAPI
*EFI_MTFTP4_CHECK_PACKET
)(
202 IN EFI_MTFTP4_PROTOCOL
*This
,
203 IN EFI_MTFTP4_TOKEN
*Token
,
205 IN EFI_MTFTP4_PACKET
*Paket
209 Timeout callback function.
211 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
212 @param Token The token that is provided in the
213 EFI_MTFTP4_PROTOCOL.ReadFile() or
214 EFI_MTFTP4_PROTOCOL.WriteFile() or
215 EFI_MTFTP4_PROTOCOL.ReadDirectory() functions
218 @retval EFI_SUCCESS The operation was successful.
219 @retval Others Aborts download process.
224 (EFIAPI
*EFI_MTFTP4_TIMEOUT_CALLBACK
)(
225 IN EFI_MTFTP4_PROTOCOL
*This
,
226 IN EFI_MTFTP4_TOKEN
*Token
230 A callback function that the caller provides to feed data to the
231 EFI_MTFTP4_PROTOCOL.WriteFile() function.
233 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
234 @param Token The token provided in the
235 EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.
236 @param Length Indicates the length of the raw data wanted on input, and the
237 length the data available on output.
238 @param Buffer The pointer to the buffer where the data is stored.
240 @retval EFI_SUCCESS The operation was successful.
241 @retval Others Aborts session.
246 (EFIAPI
*EFI_MTFTP4_PACKET_NEEDED
)(
247 IN EFI_MTFTP4_PROTOCOL
*This
,
248 IN EFI_MTFTP4_TOKEN
*Token
,
249 IN OUT UINT16
*Length
,
255 Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
257 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
258 @param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.
260 @retval EFI_SUCCESS The configuration data was successfully returned.
261 @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
262 @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.
267 (EFIAPI
*EFI_MTFTP4_GET_MODE_DATA
)(
268 IN EFI_MTFTP4_PROTOCOL
*This
,
269 OUT EFI_MTFTP4_MODE_DATA
*ModeData
274 Initializes, changes, or resets the default operational setting for this
275 EFI MTFTPv4 Protocol driver instance.
277 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
278 @param MtftpConfigData The pointer to the configuration data structure.
280 @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.
281 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
282 @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this time because
283 there is one MTFTP background operation in progress.
284 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
285 RARP, etc.) has not finished yet.
286 @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) could not
287 be located when clients choose to use the default address
289 @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could not be
291 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
292 MTFTPv4 Protocol driver instance is not configured.
297 (EFIAPI
*EFI_MTFTP4_CONFIGURE
)(
298 IN EFI_MTFTP4_PROTOCOL
*This
,
299 IN EFI_MTFTP4_CONFIG_DATA
*MtftpConfigData OPTIONAL
304 Gets information about a file from an MTFTPv4 server.
306 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
307 @param OverrideData Data that is used to override the existing parameters. If NULL,
308 the default parameters that were set in the
309 EFI_MTFTP4_PROTOCOL.Configure() function are used.
310 @param Filename The pointer to null-terminated ASCII file name string.
311 @param ModeStr The pointer to null-terminated ASCII mode string. If NULL, "octet" will be used.
312 @param OptionCount Number of option/value string pairs in OptionList.
313 @param OptionList The pointer to array of option/value string pairs. Ignored if
315 @param PacketLength The number of bytes in the returned packet.
316 @param Packet The pointer to the received packet. This buffer must be freed by
319 @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in the Packet.
320 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
323 - OptionCount is not zero and OptionList is NULL.
324 - One or more options in OptionList have wrong format.
325 - PacketLength is NULL.
326 - One or more IPv4 addresses in OverrideData are not valid
327 unicast IPv4 addresses if OverrideData is not NULL.
328 @retval EFI_UNSUPPORTED One or more options in the OptionList are in the
329 unsupported list of structure EFI_MTFTP4_MODE_DATA.
330 @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
331 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
332 RARP, etc.) has not finished yet.
333 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
334 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
335 @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in the Packet.
336 @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
337 @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
338 @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
339 @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
340 @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and is in the Buffer.
341 @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.
342 @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
343 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
344 @retval EFI_NO_MEDIA There was a media error.
349 (EFIAPI
*EFI_MTFTP4_GET_INFO
)(
350 IN EFI_MTFTP4_PROTOCOL
*This
,
351 IN EFI_MTFTP4_OVERRIDE_DATA
*OverrideData OPTIONAL
,
353 IN UINT8
*ModeStr OPTIONAL
,
354 IN UINT8 OptionCount
,
355 IN EFI_MTFTP4_OPTION
*OptionList
,
356 OUT UINT32
*PacketLength
,
357 OUT EFI_MTFTP4_PACKET
**Packet OPTIONAL
361 Parses the options in an MTFTPv4 OACK packet.
363 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
364 @param PacketLen Length of the OACK packet to be parsed.
365 @param Packet The pointer to the OACK packet to be parsed.
366 @param OptionCount The pointer to the number of options in following OptionList.
367 @param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot
368 Service FreePool() to release the OptionList if the options
369 in this OptionList are not needed any more.
371 @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and
372 OptionList parameters have been updated.
373 @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
375 - Packet is NULL or Packet is not a valid MTFTPv4 packet.
376 - OptionCount is NULL.
377 @retval EFI_NOT_FOUND No options were found in the OACK packet.
378 @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated.
379 @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.
384 (EFIAPI
*EFI_MTFTP4_PARSE_OPTIONS
)(
385 IN EFI_MTFTP4_PROTOCOL
*This
,
387 IN EFI_MTFTP4_PACKET
*Packet
,
388 OUT UINT32
*OptionCount
,
389 OUT EFI_MTFTP4_OPTION
**OptionList OPTIONAL
394 Downloads a file from an MTFTPv4 server.
396 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
397 @param Token The pointer to the token structure to provide the parameters that are
398 used in this operation.
400 @retval EFI_SUCCESS The data file has been transferred successfully.
401 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
402 @retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
403 downloaded data in downloading process.
404 @retval EFI_ABORTED Current operation is aborted by user.
405 @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
406 @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
407 @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
408 @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
409 @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received.
410 @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
411 @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.
412 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
413 @retval EFI_NO_MEDIA There was a media error.
418 (EFIAPI
*EFI_MTFTP4_READ_FILE
)(
419 IN EFI_MTFTP4_PROTOCOL
*This
,
420 IN EFI_MTFTP4_TOKEN
*Token
426 Sends a file to an MTFTPv4 server.
428 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
429 @param Token The pointer to the token structure to provide the parameters that are
430 used in this operation.
432 @retval EFI_SUCCESS The upload session has started.
433 @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
434 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
435 @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
436 the unsupported list of structure EFI_MTFTP4_MODE_DATA.
437 @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
438 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
439 RARP, etc.) is not finished yet.
440 @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
441 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
442 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
443 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
448 (EFIAPI
*EFI_MTFTP4_WRITE_FILE
)(
449 IN EFI_MTFTP4_PROTOCOL
*This
,
450 IN EFI_MTFTP4_TOKEN
*Token
455 Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI
458 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
459 @param Token The pointer to the token structure to provide the parameters that are
460 used in this operation.
462 @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.
463 @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
464 @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
465 @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
466 the unsupported list of structure EFI_MTFTP4_MODE_DATA.
467 @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
468 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
469 RARP, etc.) is not finished yet.
470 @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
471 @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
472 @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
473 @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
478 (EFIAPI
*EFI_MTFTP4_READ_DIRECTORY
)(
479 IN EFI_MTFTP4_PROTOCOL
*This
,
480 IN EFI_MTFTP4_TOKEN
*Token
484 Polls for incoming data packets and processes outgoing data packets.
486 @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
488 @retval EFI_SUCCESS Incoming or outgoing data was processed.
489 @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.
490 @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
491 RARP, etc.) is not finished yet.
492 @retval EFI_INVALID_PARAMETER This is NULL.
493 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
494 @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
495 Consider increasing the polling rate.
500 (EFIAPI
*EFI_MTFTP4_POLL
)(
501 IN EFI_MTFTP4_PROTOCOL
*This
505 /// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications
506 /// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses
507 /// the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.
509 struct _EFI_MTFTP4_PROTOCOL
{
510 EFI_MTFTP4_GET_MODE_DATA GetModeData
;
511 EFI_MTFTP4_CONFIGURE Configure
;
512 EFI_MTFTP4_GET_INFO GetInfo
;
513 EFI_MTFTP4_PARSE_OPTIONS ParseOptions
;
514 EFI_MTFTP4_READ_FILE ReadFile
;
515 EFI_MTFTP4_WRITE_FILE WriteFile
;
516 EFI_MTFTP4_READ_DIRECTORY ReadDirectory
;
517 EFI_MTFTP4_POLL Poll
;
520 struct _EFI_MTFTP4_TOKEN
{
522 /// The status that is returned to the caller at the end of the operation
523 /// to indicate whether this operation completed successfully.
527 /// The event that will be signaled when the operation completes. If
528 /// set to NULL, the corresponding function will wait until the read or
529 /// write operation finishes. The type of Event must be
530 /// EVT_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
531 /// Event must be lower than or equal to TPL_CALLBACK.
535 /// If not NULL, the data that will be used to override the existing configure data.
537 EFI_MTFTP4_OVERRIDE_DATA
*OverrideData
;
539 /// The pointer to the null-terminated ASCII file name string.
543 /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.
547 /// Number of option/value string pairs.
551 /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
553 EFI_MTFTP4_OPTION
*OptionList
;
555 /// The size of the data buffer.
559 /// The pointer to the data buffer. Data that is downloaded from the
560 /// MTFTPv4 server is stored here. Data that is uploaded to the
561 /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.
565 /// The pointer to the context that will be used by CheckPacket,
566 /// TimeoutCallback and PacketNeeded.
570 /// The pointer to the callback function to check the contents of the received packet.
572 EFI_MTFTP4_CHECK_PACKET CheckPacket
;
574 /// The pointer to the function to be called when a timeout occurs.
576 EFI_MTFTP4_TIMEOUT_CALLBACK TimeoutCallback
;
578 /// The pointer to the function to provide the needed packet contents.
580 EFI_MTFTP4_PACKET_NEEDED PacketNeeded
;
583 extern EFI_GUID gEfiMtftp4ServiceBindingProtocolGuid
;
584 extern EFI_GUID gEfiMtftp4ProtocolGuid
;