4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file defines the EFI IPv4 (Internet Protocol version 4)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol interface. It is split into the following three main
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv4 Service Binding Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv4 Variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv4 Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI IPv4 Protocol provides basic network IPv4 packet I/O services,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which includes support foR a subset of the Internet Control Message
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol (ICMP) and may include support for the Internet Group Management
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol (IGMP).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xc51711e7, 0xb4bf, 0x404a, {0xbf, 0xb8, 0x0a, 0x04, 0x8e, 0xf1, 0xff, 0xe4 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x41d94cd2, 0x35b6, 0x455a, {0x82, 0x58, 0xd4, 0xe5, 0x13, 0x34, 0xaa, 0xdd } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The default IPv4 protocol packets to send and receive. Ignored
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// when AcceptPromiscuous is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive all IPv4 packets that get through the receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE to receive only the DefaultProtocol IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// packets that get through the receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive ICMP error report packets. Ignored when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive broadcast IPv4 packets. Ignored when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AcceptPromiscuous is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE to stop receiving broadcast IPv4 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive all IPv4 packets that are sent to any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// hardware address or any protocol address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE to stop receiving all promiscuous IPv4 packets
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to use the default IPv4 address and default routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The subnet address mask that is associated with the station address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TypeOfService field in transmitted IPv4 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TimeToLive field in transmitted IPv4 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// State of the DoNotFragment bit in transmitted IPv4 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to send and receive unformatted packets. The other
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timer timeout value (number of microseconds) for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// receive timeout event to be associated with each assembled
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// packet. Zero means do not drop assembled packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The timer timeout value (number of microseconds) for the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// transmit timeout event to be associated with each outgoing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// packet. Zero means do not drop outgoing packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE after this EFI IPv4 Protocol instance has been successfully configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Current configuration settings.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE when the EFI IPv4 Protocol instance has a station address and subnet mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of joined multicast groups.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// List of joined multicast group addresses.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Routing table entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the supported ICMP types list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of ICMP types and codes that are supported by this EFI IPv4 Protocol driver
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This Event will be signaled after the Status field is updated
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// by the EFI IPv4 Protocol driver. The type of Event must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NOTIFY_SIGNAL. The Task Priority Level (TPL) of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Event must be lower than or equal to TPL_CALLBACK.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The status that is returned to the caller at the end of the operation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to indicate whether this operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When this token is used for receiving, RxData is a pointer to the EFI_IP4_RECEIVE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When this token is used for transmitting, TxData is a pointer to the EFI_IP4_TRANSMIT_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetModeData() function returns the current operational mode data for this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver instance. The data fields in EFI_IP4_MODE_DATA are read only. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function is used optionally to retrieve the operational mode data of underlying
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync networks or drivers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Ip4ModeData The pointer to the EFI IPv4 Protocol mode data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MnpConfigData The pointer to the managed network configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SnpModeData The pointer to the simple network mode data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The required mode data could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData OPTIONAL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Configure() function is used to set, change, or reset the operational
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameters and filter settings for this EFI IPv4 Protocol instance. Until these
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameters have been set, no network traffic can be sent or received by this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instance. Once the parameters have been reset (by calling this function with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpConfigData set to NULL), no more traffic can be sent or received until these
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameters have been set again. Each EFI IPv4 Protocol instance can be started
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and stopped independently of each other by enabling or disabling their receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync filter settings with the Configure() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync When IpConfigData.UseDefaultAddress is set to FALSE, the new station address will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be appended as an alias address into the addresses list in the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver. While set to TRUE, Configure() will trigger the EFI_IP4_CONFIG_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to retrieve the default IPv4 address if it is not available yet. Clients could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync frequently call GetModeData() to check the status to ensure that the default IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address is ready.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If operational parameters are reset or changed, any pending transmit and receive
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync requests will be cancelled. Their completion token status will be set to EFI_ABORTED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and their events will be signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param IpConfigData The pointer to the EFI IPv4 Protocol configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The driver instance was successfully opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpConfigData.StationAddress is not a unicast IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IpConfigData.SubnetMask is not a valid IPv4 subnet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A configuration protocol (DHCP, BOOTP, RARP, etc.) could
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not be located when clients choose to use the default IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address. This EFI IPv4 Protocol implementation does not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support this requested filter or timeout setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The EFI IPv4 Protocol driver instance data could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv4 address or subnet mask can be changed. The interface must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync also be stopped when switching to/from raw packet mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol driver instance is not opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Joins and leaves multicast groups.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Groups() function is used to join and leave multicast group sessions. Joining
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a group will enable reception of matching multicast packets. Leaving a group will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync disable the multicast packet reception.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GroupAddress The pointer to the IPv4 multicast address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - JoinFlag is TRUE and GroupAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - GroupAddress is not NULL and *GroupAddress is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not a multicast IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This EFI IPv4 Protocol implementation does not support multicast groups.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The group address is already in the group table (when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync JoinFlag is TRUE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The group address is not in the group table (when JoinFlag is FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Adds and deletes routing table entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Routes() function adds a route to or deletes a route from the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Routes are determined by comparing the SubnetAddress with the destination IPv4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address arithmetically AND-ed with the SubnetMask. The gateway address must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync on the same subnet as the configured station address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default route is added with SubnetAddress and SubnetMask both set to 0.0.0.0.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default route matches all destination IPv4 addresses that do not match any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync other routes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync A GatewayAddress that is zero is a nonroute. Packets are sent to the destination
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IP address if it can be found in the ARP cache or on the local subnet. One automatic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync nonroute entry will be inserted into the routing table for outgoing packets that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are addressed to a local subnet (gateway address of 0.0.0.0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Each EFI IPv4 Protocol instance has its own independent routing table. Those EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv4 Protocol instances that use the default IPv4 address will also have copies
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of the routing table that was provided by the EFI_IP4_CONFIG_PROTOCOL, and these
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync copies will be updated whenever the EIF IPv4 Protocol driver reconfigures its
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync instances. As a result, client modification to the routing table will be lost.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param DeleteRoute Set to TRUE to delete this route from the routing table. Set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE to add this route to the routing table. SubnetAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and SubnetMask are used as the key to each route entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetAddress The address of the subnet that needs to be routed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SubnetMask The subnet mask of SubnetAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param GatewayAddress The unicast gateway IPv4 address for this route.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The operation completed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED The driver instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - SubnetAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - SubnetMask is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - GatewayAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *SubnetAddress is not a valid subnet address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *SubnetMask is not a valid subnet mask.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *GatewayAddress is not a valid unicast IPv4 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not add the entry to the routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND This route is not in the routing table (when DeleteRoute is TRUE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The route is already defined in the routing table (when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DeleteRoute is FALSE).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Places outgoing data packets into the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Transmit() function places a sending request in the transmit queue of this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI IPv4 Protocol instance. Whenever the packet in the token is sent out or some
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync errors occur, the event in the token will be signaled and the status is updated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to the transmit token.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The data has been queued for transmission.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more pameters are invalid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The transmit completion token with the same Token.Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync was already in the transmit queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The completion token could not be queued because the transmit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND Not route is found to destination address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not queue the transmit data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL Token.Packet.TxData.TotalDataLength is too
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync short to transmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BAD_BUFFER_SIZE The length of the IPv4 header + option length + total data length is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync greater than MTU (or greater than the maximum packet size if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token.Packet.TxData.OverrideData.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DoNotFragment is TRUE.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Places a receiving request into the receiving queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Receive() function places a completion token into the receive packet queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is always asynchronous.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Token.Event field in the completion token must be filled in by the caller
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and cannot be NULL. When the receive operation completes, the EFI IPv4 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to a token that is associated with the receive data descriptor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The receive completion token was cached.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP, RARP, etc.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The receive completion token could not be queued due to a lack of system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync resources (usually memory).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI IPv4 Protocol instance has been reset to startup defaults.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The receive completion token with the same Token.Event was already
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync in the receive queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY The receive request could not be queued because the receive queue is full.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ICMP_ERROR An ICMP error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Abort an asynchronous transmit or receive request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Cancel() function is used to abort a pending transmit or receive request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the token is in the transmit or receive request queues, after calling this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function, Token->Status will be set to EFI_ABORTED and then Token->Event will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be signaled. If the token is not in one of the queues, which usually means the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync asynchronous operation has completed, this function will not signal the token
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param Token The pointer to a token that has been issued by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP4_PROTOCOL.Transmit() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP4_PROTOCOL.Receive(). If NULL, all pending
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync tokens are aborted. Type EFI_IP4_COMPLETION_TOKEN is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined in EFI_IP4_PROTOCOL.Transmit().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The asynchronous I/O request was aborted and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Token->Event was signaled. When Token is NULL, all
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync pending requests were aborted and their events were signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND When Token is not NULL, the asynchronous I/O request was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync not found in the transmit or receive queue. It has either completed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync or was not issued by Transmit() and Receive().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Polls for incoming data packets and processes outgoing data packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Poll() function polls for incoming data packets and processes outgoing data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync packets. Network drivers and applications can call the EFI_IP4_PROTOCOL.Poll()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function to increase the rate that data packets are moved between the communications
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device and the transmit and receive queues.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync In some systems the periodic timer event may not poll the underlying communications
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync device fast enough to transmit and/or receive all data packets without missing
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync incoming packets or dropping outgoing packets. Drivers and applications that are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync experiencing packet loss should try calling the EFI_IP4_PROTOCOL.Poll() function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more often.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param This The pointer to the EFI_IP4_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI IPv4 Protocol instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When using the default address, configuration (DHCP, BOOTP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RARP, etc.) is not finished yet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_READY No incoming or outgoing data is processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_TIMEOUT Data was dropped out of the transmit and/or receive queue.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Consider increasing the polling rate.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The EFI IPv4 Protocol implements a simple packet-oriented interface that can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// used by drivers, daemons, and applications to transmit and receive network packets.