iPXE
Data Fields
EFI_IP6_CONFIG_DATA Struct Reference

EFI_IP6_CONFIG_DATA is used to report and change IPv6 session parameters. More...

#include <Ip6.h>

Data Fields

UINT8 DefaultProtocol
 For the IPv6 packet to send and receive, this is the default value of the 'Next Header' field in the last IPv6 extension header or in the IPv6 header if there are no extension headers. More...
 
BOOLEAN AcceptAnyProtocol
 Set to TRUE to receive all IPv6 packets that get through the receive filters. More...
 
BOOLEAN AcceptIcmpErrors
 Set to TRUE to receive ICMP error report packets. More...
 
BOOLEAN AcceptPromiscuous
 Set to TRUE to receive all IPv6 packets that are sent to any hardware address or any protocol address. More...
 
EFI_IPv6_ADDRESS DestinationAddress
 The destination address of the packets that will be transmitted. More...
 
EFI_IPv6_ADDRESS StationAddress
 The station IPv6 address that will be assigned to this EFI IPv6 Protocol instance. More...
 
UINT8 TrafficClass
 TrafficClass field in transmitted IPv6 packets. More...
 
UINT8 HopLimit
 HopLimit field in transmitted IPv6 packets. More...
 
UINT32 FlowLabel
 FlowLabel field in transmitted IPv6 packets. More...
 
UINT32 ReceiveTimeout
 The timer timeout value (number of microseconds) for the receive timeout event to be associated with each assembled packet. More...
 
UINT32 TransmitTimeout
 The timer timeout value (number of microseconds) for the transmit timeout event to be associated with each outgoing packet. More...
 

Detailed Description

EFI_IP6_CONFIG_DATA is used to report and change IPv6 session parameters.

Definition at line 139 of file Ip6.h.

Field Documentation

◆ DefaultProtocol

UINT8 EFI_IP6_CONFIG_DATA::DefaultProtocol

For the IPv6 packet to send and receive, this is the default value of the 'Next Header' field in the last IPv6 extension header or in the IPv6 header if there are no extension headers.

Ignored when AcceptPromiscuous is TRUE.

Definition at line 146 of file Ip6.h.

◆ AcceptAnyProtocol

BOOLEAN EFI_IP6_CONFIG_DATA::AcceptAnyProtocol

Set to TRUE to receive all IPv6 packets that get through the receive filters.

Set to FALSE to receive only the DefaultProtocol IPv6 packets that get through the receive filters. Ignored when AcceptPromiscuous is TRUE.

Definition at line 154 of file Ip6.h.

◆ AcceptIcmpErrors

BOOLEAN EFI_IP6_CONFIG_DATA::AcceptIcmpErrors

Set to TRUE to receive ICMP error report packets.

Ignored when AcceptPromiscuous or AcceptAnyProtocol is TRUE.

Definition at line 159 of file Ip6.h.

◆ AcceptPromiscuous

BOOLEAN EFI_IP6_CONFIG_DATA::AcceptPromiscuous

Set to TRUE to receive all IPv6 packets that are sent to any hardware address or any protocol address.

Set to FALSE to stop receiving all promiscuous IPv6 packets.

Definition at line 165 of file Ip6.h.

◆ DestinationAddress

EFI_IPv6_ADDRESS EFI_IP6_CONFIG_DATA::DestinationAddress

The destination address of the packets that will be transmitted.

Ignored if it is unspecified.

Definition at line 170 of file Ip6.h.

◆ StationAddress

EFI_IPv6_ADDRESS EFI_IP6_CONFIG_DATA::StationAddress

The station IPv6 address that will be assigned to this EFI IPv6 Protocol instance.

This field can be set and changed only when the EFI IPv6 driver is transitioning from the stopped to the started states. If the StationAddress is specified, the EFI IPv6 Protocol driver will deliver only incoming IPv6 packets whose destination matches this IPv6 address exactly. The StationAddress is required to be one of currently configured IPv6 addresses. An address containing all zeroes is also accepted as a special case. Under this situation, the IPv6 driver is responsible for binding a source address to this EFI IPv6 protocol instance according to the source address selection algorithm. Only incoming packets destined to the selected address will be delivered to the user. And the selected station address can be retrieved through later GetModeData() call. If no address is available for selecting, EFI_NO_MAPPING will be returned, and the station address will only be successfully bound to this EFI IPv6 protocol instance after IP6ModeData.IsConfigured changed to TRUE.

Definition at line 190 of file Ip6.h.

◆ TrafficClass

UINT8 EFI_IP6_CONFIG_DATA::TrafficClass

TrafficClass field in transmitted IPv6 packets.

Default value is zero.

Definition at line 195 of file Ip6.h.

◆ HopLimit

UINT8 EFI_IP6_CONFIG_DATA::HopLimit

HopLimit field in transmitted IPv6 packets.

Definition at line 199 of file Ip6.h.

◆ FlowLabel

UINT32 EFI_IP6_CONFIG_DATA::FlowLabel

FlowLabel field in transmitted IPv6 packets.

Default value is zero.

Definition at line 204 of file Ip6.h.

◆ ReceiveTimeout

UINT32 EFI_IP6_CONFIG_DATA::ReceiveTimeout

The timer timeout value (number of microseconds) for the receive timeout event to be associated with each assembled packet.

Zero means do not drop assembled packets.

Definition at line 210 of file Ip6.h.

◆ TransmitTimeout

UINT32 EFI_IP6_CONFIG_DATA::TransmitTimeout

The timer timeout value (number of microseconds) for the transmit timeout event to be associated with each outgoing packet.

Zero means do not drop outgoing packets.

Definition at line 216 of file Ip6.h.


The documentation for this struct was generated from the following file: