4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This file defines the EFI IPv6 (Internet Protocol version 6)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol interface. It is split into the following three main
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv6 Service Binding Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv6 Variable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - EFI IPv6 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI IPv6 Protocol provides basic network IPv6 packet I/O services,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which includes support for Neighbor Discovery Protocol (ND), Multicast
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Listener Discovery Protocol (MLD), and a subset of the Internet Control
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Message Protocol (ICMPv6).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2008 - 2010, 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 @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xec835dd3, 0xfe0f, 0x617b, {0xa6, 0x21, 0xb3, 0x50, 0xc3, 0xe1, 0x33, 0x88 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x2c8759d5, 0x5c2d, 0x66ef, {0x92, 0x5f, 0xb6, 0x6c, 0x10, 0x19, 0x57, 0xe2 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_ADDRESS_PAIR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The EFI IPv6 Protocol instance handle that is using this address/prefix pair.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv6 address in network byte order.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the prefix associated with the Ip6Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_VARIABLE_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The handle of the driver that creates this entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of IPv6 address pairs that follow this data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// List of IPv6 address pairs that are currently in use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ICMPv6 type definitions for error messages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ICMPv6 type definition for informational messages
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ICMPv6 code definitions for ICMP_V6_DEST_UNREACHABLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ICMPv6 code definitions for ICMP_V6_TIME_EXCEEDED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// ICMPv6 code definitions for ICMP_V6_PARAMETER_PROBLEM
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_CONFIG_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is used to report and change IPv6 session parameters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// For the IPv6 packet to send and receive, this is the default value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the 'Next Header' field in the last IPv6 extension header or in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the IPv6 header if there are no extension headers. Ignored when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AcceptPromiscuous is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive all IPv6 packets that get through the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// receive filters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE to receive only the DefaultProtocol IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// packets that get through the receive filters. Ignored when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AcceptPromiscuous is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive ICMP error report packets. Ignored when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AcceptPromiscuous or AcceptAnyProtocol is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE to receive all IPv6 packets that are sent to any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// hardware address or any protocol address. Set to FALSE to stop
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// receiving all promiscuous IPv6 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The destination address of the packets that will be transmitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ignored if it is unspecified.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The station IPv6 address that will be assigned to this EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Protocol instance. This field can be set and changed only when
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the EFI IPv6 driver is transitioning from the stopped to the started
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// states. If the StationAddress is specified, the EFI IPv6 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// driver will deliver only incoming IPv6 packets whose destination
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// matches this IPv6 address exactly. The StationAddress is required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to be one of currently configured IPv6 addresses. An address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// containing all zeroes is also accepted as a special case. Under this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// situation, the IPv6 driver is responsible for binding a source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address to this EFI IPv6 protocol instance according to the source
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address selection algorithm. Only incoming packets destined to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the selected address will be delivered to the user. And the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// selected station address can be retrieved through later
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// GetModeData() call. If no address is available for selecting,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_NO_MAPPING will be returned, and the station address will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// only be successfully bound to this EFI IPv6 protocol instance
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// after IP6ModeData.IsConfigured changed to TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// TrafficClass field in transmitted IPv6 packets. Default value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// HopLimit field in transmitted IPv6 packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// FlowLabel field in transmitted IPv6 packets. Default value is
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.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_ADDRESS_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 PrefixLength; ///< The length of the prefix associated with the Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_ROUTE_TABLE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is the entry structure that is used in routing tables
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IPv6 address of the gateway to be used as the next hop for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// packets to this prefix. If the IPv6 address is all zeros, then the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// prefix is on-link.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The destination prefix to be routed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length of the prefix associated with the Destination.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_NEIGHBOR_STATE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Address resolution is being performed on this entry. Specially,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Neighbor Solicitation has been sent to the solicited-node
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// multicast address of the target, but corresponding Neighbor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Advertisement has not been received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Positive confirmation was received that the forward path to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// neighbor was functioning properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///Reachable Time has elapsed since the last positive confirmation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///was received. In this state, the forward path to the neighbor was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///functioning properly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This state is an optimization that gives upper-layer protocols
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// additional time to provide reachability confirmation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A reachability confirmation is actively sought by retransmitting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Neighbor Solicitations every RetransTimer milliseconds until a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// reachability confirmation is received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_NEIGHBOR_CACHE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is the entry structure that is used in neighbor cache. It records a set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// of entries about individual neighbors to which traffic has been sent recently.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPv6_ADDRESS Neighbor; ///< The on-link unicast/anycast IP address of the neighbor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_MAC_ADDRESS LinkAddress; ///< Link-layer address of the neighbor.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_NEIGHBOR_STATE State; ///< State of this neighbor cache entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_ICMP_TYPE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// is used to describe those ICMP messages that are supported by this EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// IPv6 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_MODE_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE after this EFI IPv6 Protocol instance is started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// All other fields in this structure are undefined until this field is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE when the EFI IPv6 Protocol instance is stopped.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The maximum packet size, in bytes, of the packet which the upper layer driver could feed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Current configuration settings. Undefined until IsStarted is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to TRUE when the EFI IPv6 Protocol instance is configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The instance is configured when it has a station address and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// corresponding prefix length.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Set to FALSE when the EFI IPv6 Protocol instance is not configured.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of configured IPv6 addresses on this interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// List of currently configured IPv6 addresses and corresponding
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// prefix lengths assigned to this interface. It is caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of joined multicast groups. Undefined until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// List of joined multicast group addresses. It is caller's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// responsibility to free this buffer. Undefined until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the routing table. Undefined until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Routing table entries. It is caller's responsibility to free this buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the neighbor cache. Undefined until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Neighbor cache entries. It is caller's responsibility to free this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffer. Undefined until IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the prefix table. Undefined until
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// On-link Prefix table entries. It is caller's responsibility to free this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffer. Undefined until IsConfigured is TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the supported ICMP types list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of ICMP types and codes that are supported by this EFI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPv6 Protocol driver. It is caller's responsibility to free this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_HEADER
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The fields in the IPv6 header structure are defined in the Internet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Protocol version6 specification.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_FRAGMENT_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes the location and length of the IPv6 packet
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// fragment to transmit or that has been received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 FragmentLength; ///< Length of fragment data. This field may not be set to zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *FragmentBuffer; ///< Pointer to fragment data. This field may not be set to NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_RECEIVE_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Time when the EFI IPv6 Protocol driver accepted the packet.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Ignored if it is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// After this event is signaled, the receive data structure is released
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// and must not be referenced.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///Length of the IPv6 packet headers, including both the IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///header and any extension headers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to the IPv6 packet header. If the IPv6 packet was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// fragmented, this argument is a pointer to the header in the first
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// fragment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Sum of the lengths of IPv6 packet buffers in FragmentTable. May
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of IPv6 payload fragments. May be zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Array of payload fragment lengths and buffer pointers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_OVERRIDE_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The information and flags in the override data structure will override
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// default parameters or settings for one Transmit() function call.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_TRANSMIT_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The destination IPv6 address. If it is unspecified,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ConfigData.DestinationAddress will be used instead.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If not NULL, the IPv6 transmission control override data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Total length in byte of the IPv6 extension headers specified in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ExtHdrs.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to the IPv6 extension headers. The IP layer will append
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the required extension headers if they are not specified by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ExtHdrs. Ignored if ExtHdrsLength is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The protocol of first extension header in ExtHdrs. Ignored if
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ExtHdrsLength is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Total length in bytes of the FragmentTable data to transmit.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Number of entries in the fragment data table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Start of the fragment data table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP6_COMPLETION_TOKEN
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// structures are used for both transmit and receive operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This Event will be signaled after the Status field is updated by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the EFI IPv6 Protocol driver. The type of Event must be EFI_NOTIFY_SIGNAL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Will be set to one of the following values:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_SUCCESS: The receive or transmit completed
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_ABORTED: The receive or transmit was aborted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_TIMEOUT: The transmit timeout expired.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_ICMP_ERROR: An ICMP error packet was received.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_DEVICE_ERROR: An unexpected system or network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_SECURITY_VIOLATION: The transmit or receive was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// failed because of an IPsec policy check.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// - EFI_NO_MEDIA: There was a media error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When the Token is used for receiving, RxData is a pointer to the EFI_IP6_RECEIVE_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// When the Token is used for transmitting, TxData is a pointer to the EFI_IP6_TRANSMIT_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Gets the current operational settings for this instance of the EFI IPv6 Protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The GetModeData() function returns the current operational mode data for this driver instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The data fields in EFI_IP6_MODE_DATA are read only. This function is used optionally to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync retrieve the operational mode data of underlying networks or drivers..
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Ip6ModeData Pointer to the EFI IPv6 Protocol mode data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] MnpConfigData Pointer to the managed network configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] SnpModeData 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 IPv6 address and subnet mask to this EFI IPv6 Protocol driver instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Configure() function is used to set, change, or reset the operational parameters and filter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync settings for this EFI IPv6 Protocol instance. Until these parameters have been set, no network traffic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync can be sent or received by this instance. Once the parameters have been reset (by calling this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync function with Ip6ConfigData set to NULL), no more traffic can be sent or received until these
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync parameters have been set again. Each EFI IPv6 Protocol instance can be started and stopped
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync independently of each other by enabling or disabling their receive filter settings with the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Configure() function.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If Ip6ConfigData.StationAddress is a valid non-zero IPv6 unicast address, it is required
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to be one of the currently configured IPv6 addresses list in the EFI IPv6 drivers, or else
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_INVALID_PARAMETER will be returned. If Ip6ConfigData.StationAddress is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync unspecified, the IPv6 driver will bind a source address according to the source address selection
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync algorithm. Clients could frequently call GetModeData() to check get currently configured IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address list in the EFI IPv6 driver. If both Ip6ConfigData.StationAddress and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigData.Destination are unspecified, when transmitting the packet afterwards, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync source address filled in each outgoing IPv6 packet is decided based on the destination of this packet. .
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If operational parameters are reset or changed, any pending transmit and receive requests will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cancelled. Their completion token status will be set to EFI_ABORTED and their events will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Ip6ConfigData Pointer to the EFI IPv6 Protocol configuration data structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The driver instance was successfully opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Ip6ConfigData.StationAddress is neither zero nor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a unicast IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Ip6ConfigData.StationAddress is neither zero nor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync one of the configured IP addresses in the EFI IPv6 driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Ip6ConfigData.DefaultProtocol is illegal.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES The EFI IPv6 Protocol driver instance data could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING The IPv6 driver was responsible for choosing a source address for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this instance, but no source address was available for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ALREADY_STARTED The interface is already open and must be stopped before the IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync address or prefix length can be changed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred. The EFI IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Protocol driver instance is not opened.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED Default protocol specified through
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Ip6ConfigData.DefaulProtocol isn't supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Joins and leaves multicast groups.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Groups() function is used to join and leave multicast group sessions. Joining a group will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync enable reception of matching multicast packets. Leaving a group will disable reception of matching
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync multicast packets. Source-Specific Multicast isn't required to be supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If JoinFlag is FALSE and GroupAddress is NULL, all joined groups will be left.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] JoinFlag Set to TRUE to join the multicast group session and FALSE to leave.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] GroupAddress Pointer to the IPv6 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 IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - GroupAddress is not NULL and *GroupAddress is in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync range of SSM destination address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES System resources could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED This EFI IPv6 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 leftmost PrefixLength bits of Destination with
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the destination IPv6 address arithmetically. The gateway address must be on the same subnet as the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configured station address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The default route is added with Destination and PrefixLegth both set to all zeros. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync default route matches all destination IPv6 addresses that do not match any other routes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync All EFI IPv6 Protocol instances share a routing table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DeleteRoute Set to TRUE to delete this route from the routing table. Set to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync FALSE to add this route to the routing table. Destination,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync PrefixLength and Gateway are used as the key to each
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync route entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Destination The address prefix of the subnet that needs to be routed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] PrefixLength The prefix length of Destination. Ignored if Destination
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] GatewayAddress The unicast gateway IPv6 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_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When DeleteRoute is TRUE, both Destination and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GatewayAddress are NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - When DeleteRoute is FALSE, either Destination or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync GatewayAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *GatewayAddress is not a valid unicast IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *GatewayAddress is one of the local configured IPv6
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 Add or delete Neighbor cache entries.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The Neighbors() function is used to add, update, or delete an entry from neighbor cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPv6 neighbor cache entries are typically inserted and updated by the network protocol driver as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync network traffic is processed. Most neighbor cache entries will time out and be deleted if the network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync traffic stops. Neighbor cache entries that were inserted by Neighbors() may be static (will not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync timeout) or dynamic (will time out).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The implementation should follow the neighbor cache timeout mechanism which is defined in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync RFC4861. The default neighbor cache timeout value should be tuned for the expected network
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync environment
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DeleteFlag Set to TRUE to delete the specified cache entry, set to FALSE to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync add (or update, if it already exists and Override is TRUE) the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified cache entry. TargetIp6Address is used as the key
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to find the requested cache entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TargetIp6Address Pointer to Target IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] TargetLinkAddress Pointer to link-layer address of the target. Ignored if NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Timeout Time in 100-ns units that this entry will remain in the neighbor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync cache, it will be deleted after Timeout. A value of zero means that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the entry is permanent. A non-zero value means that the entry is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Override If TRUE, the cached link-layer address of the matching entry will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be overridden and updated; if FALSE, EFI_ACCESS_DENIED
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync will be returned if a corresponding cache entry already existed.
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_INVALID_PARAMETER One or more of the following conditions is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - TargetIpAddress is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *TargetLinkAddress is invalid when not NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *TargetIpAddress is not a valid unicast IPv6 address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - *TargetIpAddress is one of the local configured IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCES Could not add the entry to the neighbor cache.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND This entry is not in the neighbor cache (when DeleteFlag is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TRUE or when DeleteFlag is FALSE while
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TargetLinkAddress is NULL.).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The to-be-added entry is already defined in the neighbor cache,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync and that entry is tagged as un-overridden (when DeleteFlag
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 IPv6 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[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token 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 The IPv6 driver was responsible for choosing a source address for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync this transmission, but no source address was available for use.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following is TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.TxData is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.ExtHdrsLength is not zero and Token.Packet.ExtHdrs is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.FragmentCount is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more of the Token.Packet.TxData.FragmentTable[].FragmentLength fields is zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - One or more of the Token.Packet.TxData.FragmentTable[].FragmentBuffer fields is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.TxData.DataLength is zero or not equal to the sum of fragment lengths.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.TxData.DestinationAddress is non-zero when DestinationAddress is configured as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync non-zero when doing Configure() for this EFI IPv6 protocol instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Token.Packet.TxData.DestinationAddress is unspecified when DestinationAddress is unspecified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync when doing Configure() for this EFI IPv6 protocol instance.
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 If Token.Packet.TxData.DataLength is beyond the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maximum that which can be described through the Fragment Offset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync field in Fragment header when performing fragmentation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
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 IPv6 Protocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync driver updates the Token.Status and Token.Packet.RxData fields and the Token.Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync is signaled.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token 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 IPv6 Protocol instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NO_MAPPING When IP6 driver responsible for binding source address to this instance,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync while no source address is available for use.
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 IPv6 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 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[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Token Pointer to a token that has been issued by
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_PROTOCOL.Transmit() or
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP6_PROTOCOL.Receive(). If NULL, all pending
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync tokens are aborted. Type EFI_IP6_COMPLETION_TOKEN is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync defined in EFI_IP6_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_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 @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
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_IP6_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_IP6_PROTOCOL.Poll() function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync more often.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IP6_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Incoming or outgoing data was processed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_STARTED This EFI IPv6 Protocol instance has not been started.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR An unexpected system or network error occurred.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_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 IPv6 Protocol implements a simple packet-oriented interface that can be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// used by drivers, daemons, and applications to transmit and receive network packets.