iPXE
Data Fields
EFI_IP4_CONFIG_DATA Struct Reference

#include <Ip4.h>

Data Fields

UINT8 DefaultProtocol
 The default IPv4 protocol packets to send and receive. More...
 
BOOLEAN AcceptAnyProtocol
 Set to TRUE to receive all IPv4 packets that get through the receive filters. More...
 
BOOLEAN AcceptIcmpErrors
 Set to TRUE to receive ICMP error report packets. More...
 
BOOLEAN AcceptBroadcast
 Set to TRUE to receive broadcast IPv4 packets. More...
 
BOOLEAN AcceptPromiscuous
 Set to TRUE to receive all IPv4 packets that are sent to any hardware address or any protocol address. More...
 
BOOLEAN UseDefaultAddress
 Set to TRUE to use the default IPv4 address and default routing table. More...
 
EFI_IPv4_ADDRESS StationAddress
 The station IPv4 address that will be assigned to this EFI IPv4Protocol instance. More...
 
EFI_IPv4_ADDRESS SubnetMask
 The subnet address mask that is associated with the station address. More...
 
UINT8 TypeOfService
 TypeOfService field in transmitted IPv4 packets. More...
 
UINT8 TimeToLive
 TimeToLive field in transmitted IPv4 packets. More...
 
BOOLEAN DoNotFragment
 State of the DoNotFragment bit in transmitted IPv4 packets. More...
 
BOOLEAN RawData
 Set to TRUE to send and receive unformatted 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

Definition at line 60 of file Ip4.h.

Field Documentation

◆ DefaultProtocol

UINT8 EFI_IP4_CONFIG_DATA::DefaultProtocol

The default IPv4 protocol packets to send and receive.

Ignored when AcceptPromiscuous is TRUE.

Definition at line 65 of file Ip4.h.

◆ AcceptAnyProtocol

BOOLEAN EFI_IP4_CONFIG_DATA::AcceptAnyProtocol

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

Set to FALSE to receive only the DefaultProtocol IPv4 packets that get through the receive filters.

Definition at line 71 of file Ip4.h.

◆ AcceptIcmpErrors

BOOLEAN EFI_IP4_CONFIG_DATA::AcceptIcmpErrors

Set to TRUE to receive ICMP error report packets.

Ignored when AcceptPromiscuous or AcceptAnyProtocol is TRUE.

Definition at line 76 of file Ip4.h.

◆ AcceptBroadcast

BOOLEAN EFI_IP4_CONFIG_DATA::AcceptBroadcast

Set to TRUE to receive broadcast IPv4 packets.

Ignored when AcceptPromiscuous is TRUE. Set to FALSE to stop receiving broadcast IPv4 packets.

Definition at line 82 of file Ip4.h.

◆ AcceptPromiscuous

BOOLEAN EFI_IP4_CONFIG_DATA::AcceptPromiscuous

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

Set to FALSE to stop receiving all promiscuous IPv4 packets

Definition at line 88 of file Ip4.h.

◆ UseDefaultAddress

BOOLEAN EFI_IP4_CONFIG_DATA::UseDefaultAddress

Set to TRUE to use the default IPv4 address and default routing table.

Definition at line 92 of file Ip4.h.

◆ StationAddress

EFI_IPv4_ADDRESS EFI_IP4_CONFIG_DATA::StationAddress

The station IPv4 address that will be assigned to this EFI IPv4Protocol instance.

Definition at line 96 of file Ip4.h.

◆ SubnetMask

EFI_IPv4_ADDRESS EFI_IP4_CONFIG_DATA::SubnetMask

The subnet address mask that is associated with the station address.

Definition at line 100 of file Ip4.h.

◆ TypeOfService

UINT8 EFI_IP4_CONFIG_DATA::TypeOfService

TypeOfService field in transmitted IPv4 packets.

Definition at line 104 of file Ip4.h.

◆ TimeToLive

UINT8 EFI_IP4_CONFIG_DATA::TimeToLive

TimeToLive field in transmitted IPv4 packets.

Definition at line 108 of file Ip4.h.

◆ DoNotFragment

BOOLEAN EFI_IP4_CONFIG_DATA::DoNotFragment

State of the DoNotFragment bit in transmitted IPv4 packets.

Definition at line 112 of file Ip4.h.

◆ RawData

BOOLEAN EFI_IP4_CONFIG_DATA::RawData

Set to TRUE to send and receive unformatted packets.

The other IPv4 receive filters are still applied. Fragmentation is disabled for RawData mode.

Definition at line 117 of file Ip4.h.

◆ ReceiveTimeout

UINT32 EFI_IP4_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 123 of file Ip4.h.

◆ TransmitTimeout

UINT32 EFI_IP4_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 129 of file Ip4.h.


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