4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This EFI_MTFTP6_PROTOCOL interface implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It supports the following RFCs:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC1350 - THE TFTP PROTOCOL (REVISION 2)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC2090 - TFTP Multicast Option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC2347 - TFTP Option Extension
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC2348 - TFTP Blocksize Option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC2349 - TFTP Timeout Interval and Transfer Size Options
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns the current operating mode data for the MTFTP6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetModeData() function returns the current operating mode and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cached data packet for the MTFTP6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] ModeData The buffer in which the EFI MTFTPv6 Protocol driver mode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The configuration data was returned successfully.
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 // Copy back the configure data if the instance already configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set the current support options in mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ModeData->SupportedOptionCount = MTFTP6_SUPPORTED_OPTIONS_NUM;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ModeData->SupportedOptions = (UINT8 **) mMtftp6SupportedOptions;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Initializes, changes, or resets the default operational setting for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this EFI MTFTPv6 Protocol driver instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Configure() function is used to set and change the configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data for this EFI MTFTPv6 Protocol driver instance. The configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync data can be reset to startup defaults by calling Configure() with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MtftpConfigData set to NULL. Whenever the instance is reset, any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pending operation is aborted. By changing the EFI MTFTPv6 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver instance configuration data, the client can connect to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync different MTFTPv6 servers. The configuration parameters in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MtftpConfigData are used as the default parameters in later MTFTPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync operations and can be overridden in later operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] MtftpConfigData Pointer to the configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The EFI MTFTPv6 Protocol instance was configured successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more following conditions are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - MtftpConfigData.StationIp is neither zero nor one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the configured IP addresses in the underlying IPv6 driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - MtftpCofigData.ServerIp is not a valid IPv6 unicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It does not match the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED - The configuration could not be changed at this time because there
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is some MTFTP background operation in progress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - MtftpCofigData.LocalPort is already in use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It does not match the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address for this instance, but no source address was available for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The EFI MTFTPv6 Protocol driver instance data could not be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTFTPv6 Protocol driver instance is not configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_MTFTP6_CONFIG_DATA *MtftpConfigData OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (MtftpConfigData != NULL && !NetIp6IsValidUnicast (&MtftpConfigData->ServerIp)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure the instance as NULL to abort the current session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // It's not allowed to configure one instance twice without configure null.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Allocate the configure buffer of the instance and store the user's data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Instance->Config = AllocateZeroPool (sizeof (EFI_MTFTP6_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (Instance->Config, MtftpConfigData, sizeof (EFI_MTFTP6_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Don't configure the udpio here because each operation might override
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // the configuration, so delay udpio configuration in each operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Continue to configure the downside Udp6 instance by user's data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Udp6Cfg.RemotePort = Instance->Config->InitialServerPort;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Get the information of the download from the server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetInfo() function assembles an MTFTPv6 request packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with options, sends it to the MTFTPv6 server, and may return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync an MTFTPv6 OACK, MTFTPv6 ERROR, or ICMP ERROR packet. Retries
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync occur only if no response packets are received from the MTFTPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync server before the timeout expires.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OverrideData Data that is used to override the existing parameters. If NULL, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default parameters that were set in the EFI_MTFTP6_PROTOCOL.Configure()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function are used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Filename Pointer to null-terminated ASCII file name string.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ModeStr Pointer to null-terminated ASCII mode string. If NULL, octet will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptionCount Number of option/value string pairs in OptionList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OptionList Pointer to array of option/value string pairs. Ignored if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] PacketLength The number of bytes in the returned packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Packet The pointer to the received packet. This buffer must be freed by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS An MTFTPv6 OACK packet was received and is in the Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It does not match the UEFI 2.3 Specification.
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 - OverrideData.ServerIp is not valid unicast IPv6 addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the OptionList are unsupported by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address for this instance, but no source address was available for use.
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 MTFTPv6 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 Note: It is not defined in UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received and the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
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 the Packet is set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It does not match the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_ERROR An unexpected MTFTPv6 packet was received and is in the Packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT No responses were received from the MTFTPv6 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_MTFTP6_OVERRIDE_DATA *OverrideData OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (OverrideData != NULL && !NetIp6IsValidUnicast (&OverrideData->ServerIp))
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Fill fields of the Token for GetInfo operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start the GetInfo operation by issue the Token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Mtftp6OperationStart (This, &Token, EFI_MTFTP6_OPCODE_RRQ);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Return the status if failed to issue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parse the options in an MTFTPv6 OACK packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ParseOptions() function parses the option fields in an MTFTPv6 OACK
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packet and returns the number of options that were found, and optionally,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a list of pointers to the options in the packet. If one or more of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync option fields are not valid, then EFI_PROTOCOL_ERROR is returned and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *OptionCount and *OptionList stop at the last valid option.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PacketLen Length of the OACK packet to be parsed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Packet Pointer to the OACK packet to be parsed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] OptionCount Pointer to the number of options in the following OptionList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] OptionList Pointer to EFI_MTFTP6_OPTION storage. Each pointer in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OptionList points to the corresponding MTFTP option buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the Packet. Call the EFI Boot Service FreePool() to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync release the OptionList if the options in this OptionList
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are not needed anymore.
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 MTFTPv6 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 can not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_ERROR One or more of the option fields is invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Mtftp6ParseStart (Packet, PacketLen, OptionCount, OptionList);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Download a file from an MTFTPv6 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ReadFile() function is used to initialize and start an MTFTPv6 download
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process, and optionally, wait for completion. When the download operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync completes, whether successfully or not, the Token.Status field is updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by the EFI MTFTPv6 Protocol driver, and then Token.Event is signaled if it
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Data can be downloaded from the MTFTPv6 server into either of the following
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A fixed buffer that is pointed to by Token.Buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A download service function that is pointed to by Token.CheckPacket.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be called first. If the call is successful, the packet will be stored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Token.Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token 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 Note: It does not match the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED Current operation is aborted by user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NETWORK_UNREACHABLE An ICMP network unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_HOST_UNREACHABLE An ICMP host unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PROTOCOL_UNREACHABLE An ICMP protocol unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PORT_UNREACHABLE An ICMP port unreachable error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Note: It is not defined in the UEFI 2.3 Specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP ERROR packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT No responses were received from the MTFTPv6 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TFTP_ERROR An MTFTPv6 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 return Mtftp6OperationStart (This, Token, EFI_MTFTP6_OPCODE_RRQ);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Send a file to an MTFTPv6 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The WriteFile() function is used to initialize an uploading operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with the given option list and optionally wait for completion. If one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or more of the options is not supported by the server, the unsupported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync options are ignored and a standard TFTP process starts instead. When
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the upload process completes, whether successfully or not, Token.Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is signaled, and the EFI MTFTPv6 Protocol driver updates Token.Status.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The caller can supply the data to be uploaded in the following two modes:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Through the user-provided buffer
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Through a callback function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync With the user-provided buffer, the Token.BufferSize field indicates
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the length of the buffer, and the driver will upload the data in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer. With an EFI_MTFTP6_PACKET_NEEDED callback function, the driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will call this callback function to get more data from the user to upload.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token 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 of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Filename is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.OptionCount is not zero and Token.OptionList is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more options in Token.OptionList have wrong format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Buffer and Token.PacketNeeded are both NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.OverrideData.ServerIp is not a valid unicast IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported by this implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address for this instance, but no source address was available for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv6 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 return Mtftp6OperationStart (This, Token, EFI_MTFTP6_OPCODE_WRQ);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Download a data file directory from an MTFTPv6 server.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The ReadDirectory() function is used to return a list of files on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MTFTPv6 server that are logically (or operationally) related to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token.Filename. The directory request packet that is sent to the server
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is built with the option list that was provided by the caller, if present.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The file information that the server returns is put into either of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the following locations:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A fixed buffer that is pointed to by Token.Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - A download service function that is pointed to by Token.CheckPacket.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If both Token.Buffer and Token.CheckPacket are used, then Token.CheckPacket
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be called first. If the call is successful, the packet will be stored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Token.Buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_MTFTP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token Pointer to the token structure to provide the parameters that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used in this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The MTFTPv6 related file "directory" has been downloaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The EFI MTFTPv6 Protocol driver does not support this function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Filename is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.OptionCount is not zero and Token.OptionList is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more options in Token.OptionList have wrong format.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Buffer and Token.CheckPacket are both NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.OverrideData.ServerIp is not valid unicast IPv6 addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more options in the Token.OptionList are not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync supported by this implementation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The EFI MTFTPv6 Protocol driver has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The underlying IPv6 driver was responsible for choosing a source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address for this instance, but no source address was available for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED This Token is already being used in another MTFTPv6 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 return Mtftp6OperationStart (This, Token, EFI_MTFTP6_OPCODE_DIR);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Polls for incoming data packets and processes outgoing data packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Poll() function can be used by network drivers and applications
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to increase the rate that data packets are moved between the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync communications device and the transmit and receive queues. In some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync systems, the periodic timer event in the managed network driver may
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not poll the underlying communications device fast enough to transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and/or receive all data packets without missing incoming packets or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync dropping outgoing packets. Drivers and applications that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync experiencing packet loss should try calling the Poll() function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more often.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This The MTFTP6 protocol instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI MTFTPv6 Protocol instance has not been started.
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 // Check the instance whether configured or in destory.