4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI Multicast Trivial File Tranfer Protocol Definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x2FE800BE, 0x8F01, 0x4aa6, {0x94, 0x6B, 0xD7, 0x13, 0x88, 0xE1, 0x83, 0x3F } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x78247c57, 0x63db, 0x4708, {0x99, 0xc2, 0xa8, 0xb4, 0xa9, 0xa6, 0x1f, 0x6b } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_MTFTP4_PROTOCOL EFI_MTFTP4_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//MTFTP4 packet opcode definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// MTFTP4 error code definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// MTFTP4 pacekt definitions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Type of packets as defined by the MTFTPv4 packet opcodes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Read request packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Write request packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Option acknowledge packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Data packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Acknowledgement packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Data packet header with big block number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Acknowledgement header with big block num.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Error packet header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// MTFTP4 option definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Protocol interfaces definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A callback function that is provided by the caller to intercept
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the EFI_MTFTP4_OPCODE_DATA or EFI_MTFTP4_OPCODE_DATA8 packets processed in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.ReadFile() function, and alternatively to intercept
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_OPCODE_OACK or EFI_MTFTP4_OPCODE_ERROR packets during a call to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile() or ReadDirectory().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The token that the caller provided in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.ReadFile(), WriteFile()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or ReadDirectory() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PacketLen Indicates the length of the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The pointer to an MTFTPv4 packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Aborts the transfer process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Timeout callback funtion.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The token that is provided in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.ReadFile() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.WriteFile() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.ReadDirectory() functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Aborts download process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A callback function that the caller provides to feed data to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.WriteFile() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The token provided in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.WriteFile() by the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Length Indicates the length of the raw data wanted on input, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync length the data available on output.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Buffer The pointer to the buffer where the data is stored.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation was successful.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others Aborts session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Submits an asynchronous interrupt transfer to an interrupt endpoint of a USB device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ModeData The pointer to storage for the EFI MTFTPv4 Protocol driver mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The configuration data was successfully returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or ModeData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initializes, changes, or resets the default operational setting for this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI MTFTPv4 Protocol driver instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MtftpConfigData The pointer to the configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The EFI MTFTPv4 Protocol driver was configured successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The EFI configuration could not be changed at this time because
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync there is one MTFTP background operation in progress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) has not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED A configuration protocol (DHCP, BOOTP, RARP, etc.) could not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be located when clients choose to use the default address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv4 Protocol driver instance data could not be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTFTPv4 Protocol driver instance is not configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_MTFTP4_CONFIG_DATA *MtftpConfigData OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets information about a file from an MTFTPv4 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OverrideData Data that is used to override the existing parameters. If NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the default parameters that were set in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MTFTP4_PROTOCOL.Configure() function are used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Filename The pointer to null-terminated ASCII file name string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ModeStr The pointer to null-terminated ASCII mode string. If NULL, "octet" will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OptionCount Number of option/value string pairs in OptionList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OptionList The pointer to array of option/value string pairs. Ignored if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PacketLength The number of bytes in the returned packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The pointer to the received packet. This buffer must be freed by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS An MTFTPv4 OACK packet was received and is in the Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Filename is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - OptionCount is not zero and OptionList is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more options in OptionList have wrong format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - PacketLength is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more IPv4 addresses in OverrideData are not valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unicast IPv4 addresses if OverrideData is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the OptionList are in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unsupported list of structure EFI_MTFTP4_MODE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) has not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received and is in the Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received and is in the Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv4 packet was received and is in the Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA There was a media error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_MTFTP4_OVERRIDE_DATA *OverrideData OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parses the options in an MTFTPv4 OACK packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param PacketLen Length of the OACK packet to be parsed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Packet The pointer to the OACK packet to be parsed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OptionCount The pointer to the number of options in following OptionList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param OptionList The pointer to EFI_MTFTP4_OPTION storage. Call the EFI Boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Service FreePool() to release the OptionList if the options
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in this OptionList are not needed any more.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The OACK packet was valid and the OptionCount and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionList parameters have been updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - PacketLen is 0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Packet is NULL or Packet is not a valid MTFTPv4 packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - OptionCount is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND No options were found in the OACK packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Storage for the OptionList array cannot be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Downloads a file from an MTFTPv4 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to the token structure to provide the parameters that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used in this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data file has been transferred successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL BufferSize is not zero but not large enough to hold the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync downloaded data in downloading process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED Current operation is aborted by user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR Some other ICMP ERROR packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT No responses were received from the MTFTPv4 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TFTP_ERROR An MTFTPv4 ERROR packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA There was a media error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Sends a file to an MTFTPv4 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to the token structure to provide the parameters that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used in this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The upload session has started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the unsupported list of structure EFI_MTFTP4_MODE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Downloads a data file "directory" from an MTFTPv4 server. May be unsupported in some EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync implementations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to the token structure to provide the parameters that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used in this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The MTFTPv4 related file "directory" has been downloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The operation is not supported by this implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the unsupported list of structure EFI_MTFTP4_MODE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv4 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv4 session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Required system resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The previous operation has not completed yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected network error or system error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Polls for incoming data packets and processes outgoing data packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_MTFTP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI MTFTPv4 Protocol instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using a default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Consider increasing the polling rate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI_MTFTP4_PROTOCOL is designed to be used by UEFI drivers and applications
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// to transmit and receive data files. The EFI MTFTPv4 Protocol driver uses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the underlying EFI UDPv4 Protocol driver and EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The status that is returned to the caller at the end of the operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to indicate whether this operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The event that will be signaled when the operation completes. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// set to NULL, the corresponding function will wait until the read or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// write operation finishes. The type of Event must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EVT_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Event must be lower than or equal to TPL_CALLBACK.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If not NULL, the data that will be used to override the existing configure data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the null-terminated ASCII file name string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the null-terminated ASCII mode string. If NULL, "octet" is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of option/value string pairs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to an array of option/value string pairs. Ignored if OptionCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of the data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the data buffer. Data that is downloaded from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// MTFTPv4 server is stored here. Data that is uploaded to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// MTFTPv4 server is read from here. Ignored if BufferSize is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the context that will be used by CheckPacket,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TimeoutCallback and PacketNeeded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the callback function to check the contents of the received packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the function to be called when a timeout occurs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The pointer to the function to provide the needed packet contents.