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
struct autoip *	autoip
	the AutoIP client state information for this netif More...
struct dhcp *	dhcp
	the DHCP client state information for this netif More...
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...
ip6_addr_t	ip6_addr [LWIP_IPV6_NUM_ADDRESSES]
	Array of IPv6 addresses for this netif. More...
u8_t	ip6_addr_state [LWIP_IPV6_NUM_ADDRESSES]
	The state of each IPv6 address (Tentative, Preferred, etc). More...
u8_t	ip6_autoconfig_enabled
	is this netif enabled for IPv6 autoconfiguration 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...
netif_mld_mac_filter_fn	mld_mac_filter
	This function could be called to add or delete an entry in the IPv6 multicast filter table of the ethernet MAC. 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...
netif_output_ip6_fn	output_ip6
	This function is called by the IPv6 module when it wants to send a packet on the interface. More...
u8_t	rs_count
	Number of Router Solicitation messages that remain to be sent. 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...

struct autoip* netif::autoip

the AutoIP client state information for this netif

Referenced by autoip_arp_announce(), autoip_arp_probe(), autoip_arp_reply(), autoip_bind(), autoip_create_addr(), autoip_handle_arp_conflict(), autoip_network_changed(), autoip_restart(), autoip_set_struct(), autoip_start(), autoip_start_probing(), autoip_stop(), autoip_tmr(), ip_input(), netif_add(), and netif_set_link_up().

struct dhcp* netif::dhcp

the DHCP client state information for this netif

Referenced by dhcp_arp_reply(), dhcp_bind(), dhcp_check(), dhcp_cleanup(), dhcp_coarse_tmr(), dhcp_decline(), dhcp_discover(), dhcp_fine_tmr(), dhcp_handle_ack(), dhcp_handle_nak(), dhcp_handle_offer(), dhcp_inform(), dhcp_network_changed(), dhcp_rebind(), dhcp_reboot(), dhcp_recv(), dhcp_release(), dhcp_renew(), dhcp_select(), dhcp_set_struct(), dhcp_start(), dhcp_stop(), dhcp_t1_timeout(), dhcp_t2_timeout(), dhcp_timeout(), netif_add(), netif_set_link_up(), and udp_input().

u8_t netif::flags

flags (see NETIF_FLAG_ above)

Referenced by dhcp_start(), dhcp_stop(), ethernet_input(), ip4_addr_isbroadcast(), ip_input(), nd6_tmr(), netif_add(), netif_remove(), netif_set_down(), netif_set_link_down(), netif_set_link_up(), netif_set_up(), tcpip_input(), and winc_netif_low_level_init().

ip_addr_t netif::gw

Referenced by autoip_start(), 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 autoip_arp_announce(), autoip_arp_probe(), autoip_arp_reply(), dhcp_create_msg(), dhcp_recv(), etharp_output(), etharp_output_to_arp_index(), etharp_query(), etharp_request(), etharp_update_arp_entry(), ethernet_input(), ethip6_output(), nd6_send_na(), nd6_send_ns(), nd6_send_rs(), netif_create_ip6_linklocal_address(), and winc_netif_low_level_init().

u8_t netif::hwaddr_len

number of bytes used in hwaddr

Referenced by dhcp_create_msg(), dhcp_recv(), etharp_arp_input(), etharp_raw(), etharp_send_ip(), etharp_update_arp_entry(), ethip6_send(), nd6_input(), nd6_send_na(), nd6_send_ns(), nd6_send_rs(), netif_create_ip6_linklocal_address(), and winc_netif_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 netif_add(), and winc_netif_rx_callback().

ip6_addr_t netif::ip6_addr[LWIP_IPV6_NUM_ADDRESSES]

Array of IPv6 addresses for this netif.

Referenced by nd6_tmr(), netif_add(), and netif_create_ip6_linklocal_address().

u8_t netif::ip6_addr_state[LWIP_IPV6_NUM_ADDRESSES]

The state of each IPv6 address (Tentative, Preferred, etc).

See Also

ip6_addr.h

Referenced by nd6_tmr(), and netif_create_ip6_linklocal_address().

u8_t netif::ip6_autoconfig_enabled

is this netif enabled for IPv6 autoconfiguration

Referenced by nd6_tmr(), and netif_add().

ip_addr_t netif::ip_addr

IP address configuration in network byte order.

Referenced by autoip_start(), dhcp_create_msg(), etharp_arp_input(), etharp_output(), etharp_request(), ip4_addr_isbroadcast(), ip_input(), ip_route(), netif_add(), netif_set_ipaddr(), status_callback(), 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(), ethip6_send(), and winc_netif_init().

netif_mld_mac_filter_fn netif::mld_mac_filter

This function could be called to add or delete an entry in the IPv6 multicast filter table of the ethernet MAC.

Referenced by mld6_joingroup(), mld6_leavegroup(), mld6_stop(), netif_add(), and winc_netif_init().

u16_t netif::mtu

maximum transfer unit (in bytes)

Referenced by dhcp_start(), ip6_output_if_src(), ip_frag(), nd6_get_destination_mtu(), nd6_get_next_hop_entry(), nd6_input(), tcp_eff_send_mss_impl(), and winc_netif_low_level_init().

char netif::name[2]

descriptive abbreviation

Referenced by autoip_bind(), autoip_start(), dhcp_bind(), dhcp_check(), dhcp_handle_nak(), dhcp_handle_offer(), dhcp_select(), dhcp_start(), ip6_input(), ip6_output_if_src(), ip_input(), netif_add(), netif_find(), netif_set_default(), netif_set_gw(), netif_set_ipaddr(), netif_set_netmask(), and winc_netif_init().

ip_addr_t netif::netmask

Referenced by autoip_start(), 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 autoip_tmr(), dhcp_coarse_tmr(), dhcp_fine_tmr(), ip6_input(), ip6_route(), ip_input(), ip_route(), mld6_joingroup(), mld6_leavegroup(), nd6_tmr(), netif_add(), netif_find(), and netif_remove().

u8_t netif::num

number of this interface

Referenced by autoip_bind(), autoip_start(), dhcp_bind(), dhcp_handle_nak(), dhcp_handle_offer(), dhcp_select(), dhcp_start(), ip6_output_if_src(), 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 ip_frag(), and winc_netif_init().

netif_output_ip6_fn netif::output_ip6

This function is called by the IPv6 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 ip6_output_if_src(), netif_add(), and winc_netif_init().

u8_t netif::rs_count

Number of Router Solicitation messages that remain to be sent.

Referenced by nd6_input(), nd6_tmr(), netif_add(), and netif_set_up().

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(), nd6_tmr(), netif_add(), and winc_netif_init().

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().