4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This implementation of EFI_PXE_BASE_CODE_PROTOCOL and EFI_LOAD_FILE_PROTOCOL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2007 - 2012, 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 Enables the use of the PXE Base Code Protocol functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function enables the use of the PXE Base Code Protocol functions. If the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Started field of the EFI_PXE_BASE_CODE_MODE structure is already TRUE, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ALREADY_STARTED will be returned. If UseIpv6 is TRUE, then IPv6 formatted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses will be used in this session. If UseIpv6 is FALSE, then IPv4 formatted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync addresses will be used in this session. If UseIpv6 is TRUE, and the Ipv6Supported
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field of the EFI_PXE_BASE_CODE_MODE structure is FALSE, then EFI_UNSUPPORTED will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be returned. If there is not enough memory or other resources to start the PXE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Base Code Protocol, then EFI_OUT_OF_RESOURCES will be returned. Otherwise, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE Base Code Protocol will be started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UseIpv6 Specifies the type of IP addresses that are to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync used during the session that is being started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set to TRUE for IPv6, and FALSE for IPv4.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PXE Base Code Protocol was started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED UseIpv6 is TRUE, but the Ipv6Supported field of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_MODE structure is FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The PXE Base Code Protocol is already in the started state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_PROTOCOL structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory or other resources to start the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE Base Code Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Detect whether using IPv6 or not, and set it into mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (UseIpv6 && Mode->Ipv6Available && Mode->Ipv6Supported && Private->Ip6Nic != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure udp6 instance to receive data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure block size for TFTP as a default value to handle all link layers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->BlockSize = (UINTN) (Private->Ip6MaxPacketSize -
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // PXE over IPv6 starts here, initialize the fields and list header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->ProxyOffer.Dhcp6.Packet.Offer.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->DhcpAck.Dhcp6.Packet.Ack.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->PxeReply.Dhcp6.Packet.Ack.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->OfferBuffer[Index].Dhcp6.Packet.Offer.Size = PXEBC_DHCP6_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create event and set status for token to capture ICMP6 error message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure udp4 instance to receive data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure block size for TFTP as a default value to handle all link layers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->BlockSize = (UINTN) (Private->Ip4MaxPacketSize -
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXEBC_DEFAULT_UDP_OVERHEAD_SIZE - PXEBC_DEFAULT_TFTP_OVERHEAD_SIZE);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // PXE over IPv4 starts here, initialize the fields.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->ProxyOffer.Dhcp4.Packet.Offer.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->DhcpAck.Dhcp4.Packet.Ack.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->PxeReply.Dhcp4.Packet.Ack.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < PXEBC_OFFER_MAX_NUM; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->OfferBuffer[Index].Dhcp4.Packet.Offer.Size = PXEBC_DHCP4_PACKET_MAX_SIZE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PxeBcSeedDhcp4Packet (&Private->SeedPacket, Private->Udp4Read);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create the event for Arp cache update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start a periodic timer by second to update Arp cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create event and set status for token to capture ICMP error message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If PcdTftpBlockSize is set to non-zero, override the default value.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->BlockSize = (UINTN) PcdGet64 (PcdTftpBlockSize);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create event for UdpRead/UdpWrite timeout since they are both blocking API.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Disable the use of the PXE Base Code Protocol functions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function stops all activity on the network device. All the resources allocated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in Start() are released, the Started field of the EFI_PXE_BASE_CODE_MODE structure is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set to FALSE, and EFI_SUCCESS is returned. If the Started field of the EFI_PXE_BASE_CODE_MODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure is already FALSE, then EFI_NOT_STARTED will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The PXE Base Code Protocol was stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is already in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_PROTOCOL structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval Others
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure all the instances for IPv6 as NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Udp6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Ip6CfgData.StationAddress, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Write->Configure (Private->Udp6Write, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Groups (Private->Udp6Read, FALSE, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Ip6->Cancel (Private->Ip6, &Private->Icmp6Token);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure all the instances for IPv4 as NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Udp4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Udp4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Ip4CfgData.StationAddress, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->Ip4CfgData.SubnetMask, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Write->Configure (Private->Udp4Write, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Groups (Private->Udp4Read, FALSE, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Ip4->Cancel (Private->Ip4, &Private->IcmpToken);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reset the mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attempts to complete a DHCPv4 D.O.R.A. (discover / offer / request / acknowledge) or DHCPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync S.A.R.R (solicit / advertise / request / reply) sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If SortOffers is TRUE, then the cached DHCP offer packets will be sorted before
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync they are tried. If SortOffers is FALSE, then the cached DHCP offer packets will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be tried in the order in which they are received. Please see the Preboot Execution
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Environment (PXE) Specification and Unified Extensible Firmware Interface (UEFI)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Specification for additional details on the implementation of DHCP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the DHCP sequence will be stopped and EFI_ABORTED will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SortOffers TRUE if the offers received should be sorted. Set to FALSE to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync try the offers in the order that they are received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid DHCP has completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER The This parameter is NULL or does not point to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_PROTOCOL structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete the DHCP Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The callback function aborted the DHCP Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The DHCP Protocol timed out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP error packet was received during the DHCP session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_RESPONSE Valid PXE offer was not received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DHCP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp6Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start S.A.R.R. process to get a IPv6 address and other boot information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp4Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start D.O.R.A. process to get a IPv4 address and other boot information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Attempts to complete the PXE Boot Server and/or boot image discovery sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function attempts to complete the PXE Boot Server and/or boot image discovery
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sequence. If this sequence is completed, then EFI_SUCCESS is returned, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PxeDiscoverValid, PxeDiscover, PxeReplyReceived, and PxeReply fields of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_MODE structure are filled in. If UseBis is TRUE, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PxeBisReplyReceived and PxeBisReply fields of the EFI_PXE_BASE_CODE_MODE structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will also be filled in. If UseBis is FALSE, then PxeBisReplyValid will be set to FALSE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In the structure referenced by parameter Info, the PXE Boot Server list, SrvList[],
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has two uses: It is the Boot Server IP address list used for unicast discovery
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (if the UseUCast field is TRUE), and it is the list used for Boot Server verification
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (if the MustUseList field is TRUE). Also, if the MustUseList field in that structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is TRUE and the AcceptAnyResponse field in the SrvList[] array is TRUE, any Boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Server reply of that type will be accepted. If the AcceptAnyResponse field is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE, only responses from Boot Servers with matching IP addresses will be accepted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can take at least 10 seconds to timeout and return control to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync caller. If the Discovery sequence does not complete, then EFI_TIMEOUT will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. Please see the Preboot Execution Environment (PXE) Specification for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync additional details on the implementation of the Discovery sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the Discovery sequence is stopped and EFI_ABORTED will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Type The type of bootstrap to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Layer Pointer to the boot server layer number to discover, which must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PXE_BOOT_LAYER_INITIAL when a new server type is being
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync discovered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] UseBis TRUE if Boot Integrity Services are to be used. FALSE otherwise.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Info Pointer to a data structure that contains additional information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the type of discovery operation that is to be performed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It is optional.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The Discovery sequence has been completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not allocate enough memory to complete Discovery.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The callback function aborted the Discovery sequence.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The Discovery sequence timed out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP error packet was received during the PXE discovery
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Function = EFI_PXE_BASE_CODE_FUNCTION_DISCOVER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Station address should be ready before do discover.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp6Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp4Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There are 3 methods to get the information for discover.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*Layer != EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 1. Take the previous setting as the discover info.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&SrvList->IpAddr, &Private->ServerIp, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 2. Extract the discover information from the cached packets if unspecified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcExtractDiscoverInfo (Private, Type, Info, &BootSvrEntry, &SrvList);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 3. Take the pass-in information as the discover info, and validate the server list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // It's invalid if the first server doesn't accecpt any response
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // and meanwhile any of the rest servers accept any reponse.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Info and BootSvrEntry/SrvList are all ready by now, so execute discover by UniCast/BroadCast/MultiCast.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((!Info->UseUCast && !Info->UseBCast && !Info->UseMCast) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do discover by unicast.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Private->ServerIp, &SrvList[Index].IpAddr, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Private->ServerIp, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Private->ServerIp, &BootSvrEntry->IpAddr[Index], sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do discover by multicast.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Do discover by broadcast, but only valid for IPv4.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Parse the cached PXE reply packet, and store it into mode data if valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcParseDhcp6Packet (&Private->PxeReply.Dhcp6);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcParseDhcp4Packet (&Private->PxeReply.Dhcp4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Used to perform TFTP and MTFTP services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to perform TFTP and MTFTP services. This includes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TFTP operations to get the size of a file, read a directory, read a file, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync write a file. It also includes the MTFTP operations to get the size of a file,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync read a directory, and read a file. The type of operation is specified by Operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the callback function that is invoked during the TFTP/MTFTP operation does
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For read operations, the return data will be placed in the buffer specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferPtr. If BufferSize is too small to contain the entire downloaded file,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then EFI_BUFFER_TOO_SMALL will be returned and BufferSize will be set to zero,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or the size of the requested file. (NOTE: the size of the requested file is only returned
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the TFTP server supports TFTP options). If BufferSize is large enough for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync read operation, then BufferSize will be set to the size of the downloaded file,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and EFI_SUCCESS will be returned. Applications using the PxeBc.Mtftp() services
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync should use the get-file-size operations to determine the size of the downloaded
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync file prior to using the read-file operations-especially when downloading large
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (greater than 64 MB) files-instead of making two calls to the read-file operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Following this recommendation will save time if the file is larger than expected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and the TFTP server does not support TFTP option extensions. Without TFTP option
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync extension support, the client must download the entire file, counting and discarding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the received packets, to determine the file size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For write operations, the data to be sent is in the buffer specified by BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferSize specifies the number of bytes to send. If the write operation completes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully, then EFI_SUCCESS will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync For TFTP "get file size" operations, the size of the requested file or directory
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is returned in BufferSize, and EFI_SUCCESS will be returned. If the TFTP server
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync does not support options, the file will be downloaded into a bit bucket and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync length of the downloaded file will be returned. For MTFTP "get file size" operations,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if the MTFTP server does not support the "get file size" option, EFI_UNSUPPORTED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function can take up to 10 seconds to timeout and return control to the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the TFTP sequence does not complete, EFI_TIMEOUT will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then the TFTP sequence is stopped and EFI_ABORTED will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Operation The type of operation to perform.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferPtr A pointer to the data buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Overwrite Only used on write file operations. TRUE if a file on a remote
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync server can be overwritten.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize For get-file-size operations, *BufferSize returns the size of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync requested file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BlockSize The requested block size to be used during a TFTP transfer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] ServerIp The TFTP / MTFTP server IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Filename A Null-terminated ASCII string that specifies a directory name
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or a file name.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Info Pointer to the MTFTP information.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DontUseBuffer Set to FALSE for normal TFTP and MTFTP read file operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The TFTP/MTFTP operation was completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The buffer is not large enough to complete the read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The callback function aborted the TFTP/MTFTP operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The TFTP/MTFTP operation timed out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP error packet was received during the MTFTP session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TFTP_ERROR A TFTP error packet was received during the MTFTP session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((BlockSize != NULL) && (*BlockSize < PXE_MTFTP_DEFAULT_BLOCK_SIZE)) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (!NetIp4IsUnicast (NTOHL (ServerIp->Addr[0]), 0) && !NetIp6IsValidUnicast (&ServerIp->v6))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set configuration data for Mtftp6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Mtftp6Config, sizeof (EFI_MTFTP6_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp6Config.StationIp, &Private->StationIp.v6, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp6Config.ServerIp, &ServerIp->v6, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp6Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set configuration data for Mtftp4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Mtftp4Config, sizeof (EFI_MTFTP4_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp4Config.StationIp, &Private->StationIp.v4, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp4Config.SubnetMask, &Private->SubnetMask.v4, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp4Config.GatewayIp, &Private->GatewayIp.v4, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mtftp4Config.ServerIp, &ServerIp->v4, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Stop Udp4Read instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send TFTP request to get file size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send TFTP request to read file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send TFTP request to write file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Send TFTP request to read directory.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, &Private->Udp6CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, &Private->Udp4CfgData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // receive filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem(&IpFilter, sizeof (EFI_PXE_BASE_CODE_IP_FILTER));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpFilter.Filters = EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Writes a UDP packet to the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function writes a UDP packet specified by the (optional HeaderPtr and)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferPtr parameters to the network interface. The UDP header is automatically
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync built by this routine. It uses the parameters OpFlags, DestIp, DestPort, GatewayIp,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SrcIp, and SrcPort to build this header. If the packet is successfully built and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync transmitted through the network interface, then EFI_SUCCESS will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If a timeout occurs during the transmission of the packet, then EFI_TIMEOUT will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be returned. If an ICMP error occurs during the transmission of the packet, then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the IcmpErrorReceived field is set to TRUE, the IcmpError field is filled in and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_ICMP_ERROR will be returned. If the Callback Protocol does not return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE, then EFI_ABORTED will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OpFlags The UDP operation flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DestIp The destination IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DestPort The destination UDP port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] GatewayIp The gateway IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] SrcIp The source IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SrcPort The source UDP port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeaderSize An optional field which may be set to the length of a header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync at HeaderPtr to be prefixed to the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prefixed to the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BufferSize A pointer to the size of the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BufferPtr A pointer to the data to be written.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The UDP Write operation completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The buffer is too long to be transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The callback function aborted the UDP Write operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The UDP Write operation timed out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP error packet was received during the UDP write session.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (This == NULL || DestIp == NULL || DestPort == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_MAY_FRAGMENT) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!Mode->UsingIpv6 && GatewayIp != NULL && !NetIp4IsUnicast (NTOHL (GatewayIp->Addr[0]), 0)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Gateway is provided but it's not a unicast IPv4 address, while it will be ignored for IPv6.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HeaderSize != NULL && (*HeaderSize == 0 || HeaderPtr == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (BufferSize == NULL || (*BufferSize != 0 && BufferPtr == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (SrcPort != NULL && *SrcPort != Private->CurSrcPort)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reconfigure UDPv4/UDPv6 for UdpWrite if the source port changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure the UDPv4 instance with gateway information from DHCP server as default.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start a timer as timeout event for this blocking API.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Construct UDPv6 session data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Udp6Session, sizeof (EFI_UDP6_SESSION_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Udp6Session.DestinationAddress, DestIp, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Udp6Session.SourceAddress, SrcIp, sizeof (EFI_IPv6_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Construct UDPv4 session data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Udp4Session, sizeof (EFI_UDP4_SESSION_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Udp4Session.DestinationAddress, DestIp, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Udp4Session.SourceAddress, SrcIp, sizeof (EFI_IPv4_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Override the gateway information if user specified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Reset the UdpWrite instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Write->Configure (Private->Udp6Write, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Write->Configure (Private->Udp4Write, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Reads a UDP packet from the network interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function reads a UDP packet from a network interface. The data contents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are returned in (the optional HeaderPtr and) BufferPtr, and the size of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync buffer received is returned in BufferSize . If the input BufferSize is smaller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than the UDP packet received (less optional HeaderSize), it will be set to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync required size, and EFI_BUFFER_TOO_SMALL will be returned. In this case, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync contents of BufferPtr are undefined, and the packet is lost. If a UDP packet is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync successfully received, then EFI_SUCCESS will be returned, and the information
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync from the UDP header will be returned in DestIp, DestPort, SrcIp, and SrcPort if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync they are not NULL. Depending on the values of OpFlags and the DestIp, DestPort,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SrcIp, and SrcPort input values, different types of UDP packet receive filtering
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be performed. The following tables summarize these receive filter operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] OpFlags The UDP operation flags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DestIp The destination IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DestPort The destination UDP port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SrcIp The source IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SrcPort The source UDP port number.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeaderSize An optional field which may be set to the length of a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync header at HeaderPtr to be prefixed to the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] HeaderPtr If HeaderSize is not NULL, a pointer to a header to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync prefixed to the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize A pointer to the size of the data at BufferPtr.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BufferPtr A pointer to the data to be read.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The UDP Read operation was completed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The packet is larger than Buffer can hold.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The callback function aborted the UDP Read operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT The UDP Read operation timed out.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_PXE_BASE_CODE_UDP_PORT *DestPort OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_PXE_BASE_CODE_UDP_PORT *SrcPort OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (This == NULL || DestIp == NULL || DestPort == NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_DEST_PORT) != 0 && DestPort == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_IP) != 0 && SrcIp == NULL) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ((OpFlags & EFI_PXE_BASE_CODE_UDP_OPFLAGS_ANY_SRC_PORT) != 0 && SrcPort == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((HeaderSize != NULL && *HeaderSize == 0) || (HeaderSize != NULL && HeaderPtr == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Udp6Token, sizeof (EFI_UDP6_COMPLETION_TOKEN));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&Udp4Token, sizeof (EFI_UDP4_COMPLETION_TOKEN));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start a timer as timeout event for this blocking API.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SetTimer (Private->UdpTimeOutEvent, TimerRelative, PXEBC_UDP_TIMEOUT);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Read packet by Udp4Read/Udp6Read until matched or timeout.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Get different return status for icmp error from Udp, refers to UEFI spec.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gBS->SetTimer (Private->UdpTimeOutEvent, TimerCancel, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the rececived packet to user if matched by filter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Udp6Rx->DataLength - HeaderLen > *BufferSize) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (FragmentIndex = 0; FragmentIndex < Udp6Rx->FragmentCount; FragmentIndex++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FragmentLength = Udp6Rx->FragmentTable[FragmentIndex].FragmentLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FragmentBuffer = Udp6Rx->FragmentTable[FragmentIndex].FragmentBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HeaderCopiedLen + FragmentLength < HeaderLen) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the header part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the header part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the other part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the other part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Recycle the receiving buffer after copy to user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Udp4Rx->DataLength - HeaderLen > *BufferSize) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (FragmentIndex = 0; FragmentIndex < Udp4Rx->FragmentCount; FragmentIndex++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FragmentLength = Udp4Rx->FragmentTable[FragmentIndex].FragmentLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FragmentBuffer = Udp4Rx->FragmentTable[FragmentIndex].FragmentBuffer;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (HeaderCopiedLen + FragmentLength < HeaderLen) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the header part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, FragmentLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the header part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) HeaderPtr + HeaderCopiedLen, FragmentBuffer, CopiedLen);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the other part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer + CopiedLen, FragmentLength - CopiedLen);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the other part of received data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem ((UINT8 *) BufferPtr + BufferCopiedLen, FragmentBuffer, FragmentLength);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Recycle the receiving buffer after copy to user.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Cancel (Private->Udp6Read, &Udp6Token);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Cancel (Private->Udp4Read, &Udp4Token);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates the IP receive filters of a network device and enables software filtering.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The NewFilter field is used to modify the network device's current IP receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filter settings and to enable a software filter. This function updates the IpFilter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field of the EFI_PXE_BASE_CODE_MODE structure with the contents of NewIpFilter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The software filter is used when the USE_FILTER in OpFlags is set to UdpRead().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The current hardware filter remains in effect no matter what the settings of OpFlags.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is so that the meaning of ANY_DEST_IP set in OpFlags to UdpRead() is from those
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packets whose reception is enabled in hardware-physical NIC address (unicast),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync broadcast address, logical address or addresses (multicast), or all (promiscuous).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UdpRead() does not modify the IP filter settings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Dhcp(), Discover(), and Mtftp() set the IP filter, and return with the IP receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filter list emptied and the filter set to EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If an application or driver wishes to preserve the IP receive filter settings,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync it will have to preserve the IP receive filter settings before these calls, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync use SetIpFilter() to restore them after the calls. If incompatible filtering is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync requested (for example, PROMISCUOUS with anything else), or if the device does not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support a requested filter setting and it cannot be accommodated in software
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (for example, PROMISCUOUS not supported), EFI_INVALID_PARAMETER will be returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The IPlist field is used to enable IPs other than the StationIP. They may be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync multicast or unicast. If IPcnt is set as well as EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then both the StationIP and the IPs from the IPlist will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewFilter Pointer to the new set of IP receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The IP receive filter settings were updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < NewFilter->IpCnt; Index++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IP4_IS_LOCAL_BROADCAST (EFI_IP4 (NewFilter->IpList[Index].v4))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // IPv4 broadcast address should not be in IP filter.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0 &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (NetIp4IsUnicast (EFI_IP4 (NewFilter->IpList[Index].v4), 0) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetIp6IsValidUnicast (&NewFilter->IpList[Index].v6))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP is set and IPv4/IPv6 address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // is in IpList, promiscuous mode is needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS) != 0 ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure UDPv4/UDPv6 as promiscuous mode to receive all packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_BROADCAST) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure UDPv4 to receive all broadcast packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In multicast condition when Promiscuous FALSE and IpCnt no-zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Here check if there is any update of the multicast ip address. If yes,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // we need leave the old multicast group (by Config UDP instance to NULL),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // and join the new multicast group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((NewFilter->Filters & EFI_PXE_BASE_CODE_IP_FILTER_STATION_IP) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else if (CompareMem (Mode->IpFilter.IpList, NewFilter->IpList, NewFilter->IpCnt * sizeof (EFI_IP_ADDRESS)) != 0 ) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether we need reconfigure the UDP4 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((AcceptPromiscuous != Udp4Cfg->AcceptPromiscuous) ||
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (AcceptBroadcast != Udp4Cfg->AcceptBroadcast) || MultiCastUpdate) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clear the UDP4 instance configuration, all joined groups will be left
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // during the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp4Read->Configure (Private->Udp4Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure the UDP instance with the new configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Private->Udp4Read->Configure (Private->Udp4Read, Udp4Cfg);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In not Promiscuous mode, need to join the new multicast group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (IP4_IS_MULTICAST (EFI_NTOHL (NewFilter->IpList[Index].v4))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Join the mutilcast group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Private->Udp4Read->Groups (Private->Udp4Read, TRUE, &NewFilter->IpList[Index].v4);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether we need reconfigure the UDP6 instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((AcceptPromiscuous != Udp6Cfg->AcceptPromiscuous) || MultiCastUpdate) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Clear the UDP6 instance configuration, all joined groups will be left
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // during the operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Udp6Read->Configure (Private->Udp6Read, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure the UDP instance with the new configuration.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Private->Udp6Read->Configure (Private->Udp6Read, Udp6Cfg);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // In not Promiscuous mode, need to join the new multicast group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (Index = 0; Index < NewFilter->IpCnt; ++Index) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (IP6_IS_MULTICAST (&NewFilter->IpList[Index].v6)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Join the mutilcast group.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Private->Udp6Read->Groups (Private->Udp6Read, TRUE, &NewFilter->IpList[Index].v6);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Save the new IP filter into mode data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->IpFilter, NewFilter, sizeof (Mode->IpFilter));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Uses the ARP protocol to resolve a MAC address. It is not supported for IPv6.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function uses the ARP protocol to resolve a MAC address. The IP address specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by IpAddr is used to resolve a MAC address. If the ARP protocol succeeds in resolving
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the specified address, then the ArpCacheEntries and ArpCache fields of the mode data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are updated, and EFI_SUCCESS is returned. If MacAddr is not NULL, the resolved
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MAC address is placed there as well. If the PXE Base Code protocol is in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync stopped state, then EFI_NOT_STARTED is returned. If the ARP protocol encounters
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a timeout condition while attempting to resolve an address, then EFI_TIMEOUT is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned. If the Callback Protocol does not return EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then EFI_ABORTED is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] IpAddr Pointer to the IP address that is used to resolve a MAC address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] MacAddr If not NULL, a pointer to the MAC address that was resolved with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ARP protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The IP or MAC address was resolved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The network device encountered an error during this operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An error occur with the ICMP packet message.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Station address should be ready before do arp.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If AutoArp is FALSE, only search in the current Arp cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!PxeBcCheckArpCache (Mode, &IpAddr->v4, &TempMac)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // If AutoArp is TRUE, try to send Arp request on initiative.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = Private->Arp->Request (Private->Arp, &IpAddr->v4, ResolvedEvent, &TempMac);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status) && Status != EFI_NOT_READY) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CompareMem (&TempMac, &ZeroMac, sizeof (EFI_MAC_ADDRESS)) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Copy the Mac address to user if needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (MacAddr, &TempMac, sizeof (EFI_MAC_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates the parameters that affect the operation of the PXE Base Code Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function sets parameters that affect the operation of the PXE Base Code Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The parameter specified by NewAutoArp is used to control the generation of ARP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync protocol packets. If NewAutoArp is TRUE, then ARP Protocol packets will be generated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync as required by the PXE Base Code Protocol. If NewAutoArp is FALSE, then no ARP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol packets will be generated. In this case, the only mappings that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync available are those stored in the ArpCache of the EFI_PXE_BASE_CODE_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If there are not enough mappings in the ArpCache to perform a PXE Base Code Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync service, then the service will fail. This function updates the AutoArp field of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the EFI_PXE_BASE_CODE_MODE structure to NewAutoArp.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SetParameters() call must be invoked after a Callback Protocol is installed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to enable the use of callbacks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewAutoArp If not NULL, a pointer to a value that specifies whether to replace the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current value of AutoARP.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewSendGUID If not NULL, a pointer to a value that specifies whether to replace the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current value of SendGUID.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewTTL If not NULL, a pointer to be used in place of the current value of TTL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the "time to live" field of the IP header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewToS If not NULL, a pointer to be used in place of the current value of ToS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the "type of service" field of the IP header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewMakeCallback If not NULL, a pointer to a value that specifies whether to replace the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync current value of the MakeCallback field of the Mode structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new parameters values were updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Update the previous PxeBcCallback protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR (Status) || (Private->PxeBcCallback->Callback == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (*NewSendGUID && EFI_ERROR (NetLibGetSystemGuid (&SystemGuid))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates the station IP address and/or subnet mask values of a network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function updates the station IP address and/or subnet mask values of a network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device. The NewStationIp field is used to modify the network device's current IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If NewStationIP is NULL, then the current IP address will not be modified. Otherwise,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this function updates the StationIp field of the EFI_PXE_BASE_CODE_MODE structure
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync with NewStationIp. The NewSubnetMask field is used to modify the network device's current subnet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mask. If NewSubnetMask is NULL, then the current subnet mask will not be modified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Otherwise, this function updates the SubnetMask field of the EFI_PXE_BASE_CODE_MODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync structure with NewSubnetMask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewStationIp Pointer to the new IP address to be used by the network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewSubnetMask Pointer to the new subnet mask to be used by the network device.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The new station IP address and/or subnet mask were updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more parameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (!NetIp4IsUnicast (NTOHL (NewStationIp->Addr[0]), 0) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync !IP4_IS_VALID_NETMASK (NTOHL (NewSubnetMask->Addr[0]))) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Set the IPv6 address by Ip6Config protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcRegisterIp6Address (Private, &NewStationIp->v6);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else if (!Mode->UsingIpv6 && NewStationIp != NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Configure the corresponding ARP with the IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ZeroMem (&ArpConfigData, sizeof (EFI_ARP_CONFIG_DATA));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ArpConfigData.SwAddressLength = (UINT8) sizeof (EFI_IPv4_ADDRESS);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Private->Arp->Configure (Private->Arp, &ArpConfigData);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Mode->RouteTable[0].IpAddr.Addr[0] = NewStationIp->Addr[0] & NewSubnetMask->Addr[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Mode->RouteTable[0].SubnetMask.Addr[0] = NewSubnetMask->Addr[0];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Private->StationIp, NewStationIp, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->SubnetMask, NewSubnetMask, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Private->SubnetMask ,NewSubnetMask, sizeof (EFI_IP_ADDRESS));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcFlushStaionIp (Private, NewStationIp, NewSubnetMask);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Updates the contents of the cached DHCP and Discover packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The pointers to the new packets are used to update the contents of the cached
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packets in the EFI_PXE_BASE_CODE_MODE structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewDhcpDiscoverValid Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DhcpDiscoverValid field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewDhcpAckReceived Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DhcpAckReceived field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewProxyOfferReceived Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ProxyOfferReceived field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeDiscoverValid Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ProxyOfferReceived field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeReplyReceived Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PxeReplyReceived field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeBisReplyReceived Pointer to a value that will replace the current
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PxeBisReplyReceived field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewDhcpDiscover Pointer to the new cached DHCP Discover packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewDhcpAck Pointer to the new cached DHCP Ack packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewProxyOffer Pointer to the new cached Proxy Offer packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeDiscover Pointer to the new cached PXE Discover packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeReply Pointer to the new cached PXE Reply packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] NewPxeBisReply Pointer to the new cached PXE BIS Reply packet contents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The cached packet contents were updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The PXE Base Code Protocol is in the stopped state.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or does not point to a valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PXE_BASE_CODE_PROTOCOL structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PXE_BASE_CODE_PACKET *NewDhcpDiscover OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PXE_BASE_CODE_PACKET *NewProxyOffer OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PXE_BASE_CODE_PACKET *NewPxeDiscover OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PXE_BASE_CODE_PACKET *NewPxeBisReply OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Mode->PxeBisReplyReceived = *NewPxeBisReplyReceived;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->DhcpDiscover, NewDhcpDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->DhcpAck, NewDhcpAck, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->ProxyOffer, NewProxyOffer, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->PxeDiscover, NewPxeDiscover, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->PxeReply, NewPxeReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CopyMem (&Mode->PxeBisReply, NewPxeBisReply, sizeof (EFI_PXE_BASE_CODE_PACKET));
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_PXE_BASE_CODE_PROTOCOL gPxeBcProtocolTemplate = {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Callback function that is invoked when the PXE Base Code Protocol is about to transmit, has
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync received, or is waiting to receive a packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is invoked when the PXE Base Code Protocol is about to transmit, has received,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or is waiting to receive a packet. Parameters Function and Received specify the type of event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Parameters PacketLen and Packet specify the packet that generated the event. If these fields
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are zero and NULL respectively, then this is a status update callback. If the operation specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by Function is to continue, then CALLBACK_STATUS_CONTINUE should be returned. If the operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by Function should be aborted, then CALLBACK_STATUS_ABORT should be returned. Due to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the polling nature of UEFI device drivers, a callback function should not execute for more than 5 ms.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The SetParameters() function must be called after a Callback Protocol is installed to enable the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync use of callbacks.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Function The PXE Base Code Protocol function that is waiting for an event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Received TRUE if the callback is being invoked due to a receive event. FALSE if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the callback is being invoked due to a transmit event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PacketLength The length, in bytes, of Packet. This field will have a value of zero if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this is a wait for receive event.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PacketPtr If Received is TRUE, a pointer to the packet that was just received;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync otherwise a pointer to the packet that is about to be transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_CONTINUE If Function specifies a continue operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_PXE_BASE_CODE_CALLBACK_STATUS_ABORT If Function specifies an abort operation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Catch Ctrl-C or ESC to abort.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gST->ConIn->ReadKeyStroke (gST->ConIn, &Key);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Key.ScanCode == SCAN_ESC || Key.UnicodeChar == (0x1F & 'c')) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // No print if receive packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Print only for three functions
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Print only for open MTFTP packets, not every MTFTP packets
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (PacketPtr->Raw[0x1C] != 0x00 || PacketPtr->Raw[0x1D] != 0x01) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Print '.' when transmit a packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_PXE_BASE_CODE_CALLBACK_PROTOCOL gPxeBcCallBackTemplate = {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Causes the driver to load a specified file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Protocol instance pointer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] FilePath The device specific path of the file to load.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] BootPolicy If TRUE, indicates that the request originates from the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync boot manager is attempting to load FilePath as a boot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync selection. If FALSE, then FilePath must match an exact file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] BufferSize On input the size of Buffer in bytes. On output with a return
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync code of EFI_SUCCESS, the amount of data transferred to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Buffer. On output with a return code of EFI_BUFFER_TOO_SMALL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the size of Buffer required to retrieve the requested file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Buffer The memory buffer to transfer the file to. IF Buffer is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync then no the size of the requested file is returned in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferSize.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The file was loaded.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The device does not support the provided BootPolicy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER FilePath is not a valid device path, or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BufferSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MEDIA No medium was present to load the file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The file was not loaded due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_RESPONSE The remote system did not respond.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The file was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ABORTED The file load process was manually cancelled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VirtualNic = PXEBC_VIRTUAL_NIC_FROM_LOADFILE (This);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Only support BootPolicy
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check media status before PXE start
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NetLibDetectMedia (Private->Controller, &MediaPresent);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether the virtual nic is using IPv6 or not.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Start Pxe Base Code to initialize PXE boot.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (Status == EFI_SUCCESS || Status == EFI_ALREADY_STARTED) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = PxeBcLoadBootFile (Private, BufferSize, Buffer);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // There are three cases, which needn't stop pxebc here.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 1. success to download file.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 2. success to get file size.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // 3. unsupported.