netif Struct Reference

Generic data structure used for all lwIP network interfaces.

The following fields should be filled in by the initialization function for the device driver: hwaddr_len, hwaddr[], mtu, flags

#include <netif.h>

Data Fields
u8_t	flags
	flags (see NETIF_FLAG_ above) More...
ip_addr_t	gw
u8_t	hwaddr [NETIF_MAX_HWADDR_LEN]
	link level hardware address of this interface More...
u8_t	hwaddr_len
	number of bytes used in hwaddr More...
netif_input_fn	input
	This function is called by the network device driver to pass a packet up the TCP/IP stack. More...
ip_addr_t	ip_addr
	IP address configuration in network byte order. More...
netif_linkoutput_fn	linkoutput
	This function is called by the ARP module when it wants to send a packet on the interface. More...
u16_t	mtu
	maximum transfer unit (in bytes) More...
char	name [2]
	descriptive abbreviation More...
ip_addr_t	netmask
struct netif *	next
	pointer to next in linked list More...
u8_t	num
	number of this interface More...
netif_output_fn	output
	This function is called by the IP module when it wants to send a packet on the interface. More...
void *	state
	This field can be set by the device driver and could point to state information for the device. More...
netif_status_callback_fn	status_callback
	This function is called when the netif state is set to up or down. More...

u8_t netif::flags

flags (see NETIF_FLAG_ above)

Referenced by ethernet_input(), gmac_low_level_init(), ip4_addr_isbroadcast(), ip_input(), netif_add(), netif_remove(), netif_set_down(), netif_set_link_down(), netif_set_link_up(), and netif_set_up().

ip_addr_t netif::gw

Referenced by etharp_output(), netif_add(), and netif_set_gw().

u8_t netif::hwaddr[NETIF_MAX_HWADDR_LEN]

link level hardware address of this interface

Referenced by etharp_output(), etharp_output_to_arp_index(), etharp_query(), etharp_request(), etharp_update_arp_entry(), ethernet_input(), and gmac_low_level_init().

u8_t netif::hwaddr_len

number of bytes used in hwaddr

Referenced by etharp_arp_input(), etharp_raw(), etharp_send_ip(), etharp_update_arp_entry(), and gmac_low_level_init().

netif_input_fn netif::input

This function is called by the network device driver to pass a packet up the TCP/IP stack.

Referenced by ethernetif_input(), and netif_add().

ip_addr_t netif::ip_addr

IP address configuration in network byte order.

Referenced by etharp_arp_input(), etharp_output(), etharp_request(), ip4_addr_isbroadcast(), ip_input(), ip_route(), netif_add(), netif_set_ipaddr(), status_callback(), tcp_connect(), tcp_output_segment(), udp_connect(), and udp_input().

netif_linkoutput_fn netif::linkoutput

This function is called by the ARP module when it wants to send a packet on the interface.

This function outputs the pbuf as-is on the link medium.

Referenced by etharp_arp_input(), etharp_raw(), etharp_send_ip(), and ethernetif_init().

u16_t netif::mtu

maximum transfer unit (in bytes)

Referenced by gmac_low_level_init(), ip_frag(), and tcp_eff_send_mss().

char netif::name[2]

descriptive abbreviation

Referenced by ethernetif_init(), ip_input(), netif_add(), netif_find(), netif_set_default(), netif_set_gw(), netif_set_ipaddr(), and netif_set_netmask().

ip_addr_t netif::netmask

Referenced by etharp_output(), ip4_addr_isbroadcast(), ip_input(), ip_route(), netif_add(), netif_set_netmask(), and udp_input().

struct netif* netif::next

pointer to next in linked list

Referenced by ip_input(), ip_route(), netif_add(), netif_find(), and netif_remove().

u8_t netif::num

number of this interface

Referenced by netif_add(), and netif_find().

netif_output_fn netif::output

This function is called by the IP module when it wants to send a packet on the interface.

This function typically first resolves the hardware address, then sends the packet.

Referenced by ethernetif_init(), and ip_frag().

void* netif::state

This field can be set by the device driver and could point to state information for the device.

Referenced by etharp_cleanup_netif(), etharp_find_addr(), etharp_update_arp_entry(), ethernetif_init(), gmac_low_level_input(), gmac_low_level_output(), and netif_add().

netif_status_callback_fn netif::status_callback

This function is called when the netif state is set to up or down.

Referenced by netif_add(), and netif_set_status_callback().