netif.h File Reference

#include "lwip/opt.h"
#include "lwip/err.h"
#include "lwip/ip_addr.h"
#include "lwip/def.h"
#include "lwip/pbuf.h"
#include "lwip/stats.h"

Include dependency graph for netif.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	netif

Macros
#define	ENABLE_LOOPBACK   (LWIP_NETIF_LOOPBACK || LWIP_HAVE_LOOPIF)
#define	NETIF_MAX_HWADDR_LEN   6U
#define	NETIF_FLAG_UP   0x01U
#define	NETIF_FLAG_BROADCAST   0x02U
#define	NETIF_FLAG_LINK_UP   0x04U
#define	NETIF_FLAG_ETHARP   0x08U
#define	NETIF_FLAG_ETHERNET   0x10U
#define	NETIF_FLAG_IGMP   0x20U
#define	NETIF_FLAG_MLD6   0x40U
#define	NETIF_SET_CHECKSUM_CTRL(netif, chksumflags)
#define	IF__NETIF_CHECKSUM_ENABLED(netif, chksumflag)
#define	netif_is_up(netif)   (((netif)->flags & NETIF_FLAG_UP) ? (u8_t)1 : (u8_t)0)
#define	netif_is_link_up(netif)   (((netif)->flags & NETIF_FLAG_LINK_UP) ? (u8_t)1 : (u8_t)0)
#define	NETIF_SET_HWADDRHINT(netif, hint)

Typedefs
typedef err_t(*	netif_init_fn) (struct netif *netif)
typedef err_t(*	netif_input_fn) (struct pbuf *p, struct netif *inp)
typedef err_t(*	netif_linkoutput_fn) (struct netif *netif, struct pbuf *p)
typedef void(*	netif_status_callback_fn) (struct netif *netif)

Enumerations
enum	lwip_internal_netif_client_data_index { LWIP_NETIF_CLIENT_DATA_INDEX_MAX }
enum	netif_mac_filter_action { NETIF_DEL_MAC_FILTER = 0, NETIF_ADD_MAC_FILTER = 1 }

Functions
void	netif_init (void)
struct netif *	netif_add (struct netif *netif, void *state, netif_init_fn init, netif_input_fn input)
void	netif_remove (struct netif *netif)
struct netif *	netif_find (const char *name)
void	netif_set_default (struct netif *netif)
void	netif_set_up (struct netif *netif)
void	netif_set_down (struct netif *netif)
void	netif_set_link_up (struct netif *netif)
void	netif_set_link_down (struct netif *netif)
err_t	netif_input (struct pbuf *p, struct netif *inp)

Variables
struct netif *	netif_list
struct netif *	netif_default

Detailed Description

netif API (to be used from TCPIP thread)

Definition in file netif.h.

Macro Definition Documentation

#define netif_is_link_up

(

netif

)

(((netif)->flags & NETIF_FLAG_LINK_UP) ? (u8_t)1 : (u8_t)0)

Ask if a link is up

Definition at line 432 of file netif.h.

#define NETIF_MAX_HWADDR_LEN   6U

Must be the maximum of all used hardware address lengths across all types of interfaces in use. This does not have to be changed, normally.

Definition at line 82 of file netif.h.

Typedef Documentation

typedef err_t(* netif_init_fn) (struct netif *netif)

Function prototype for netif init functions. Set up flags and output/linkoutput callback functions in this function.

Parameters

netif

The netif to initialize

Definition at line 174 of file netif.h.

typedef err_t(* netif_input_fn) (struct pbuf *p, struct netif *inp)

Function prototype for netif->input functions. This function is saved as 'input' callback function in the netif struct. Call it when a packet has been received.

Parameters

p	The received packet, copied into a pbuf
inp	The netif which received the packet

Definition at line 181 of file netif.h.

typedef err_t(* netif_linkoutput_fn) (struct netif *netif, struct pbuf *p)

Function prototype for netif->linkoutput functions. Only used for ethernet netifs. This function is called by ARP when a packet shall be sent.

Parameters

netif	The netif which shall send a packet
p	The packet to send (raw ethernet packet)

Definition at line 215 of file netif.h.

typedef void(* netif_status_callback_fn) (struct netif *netif)

Function prototype for netif status- or link-callback functions.

Definition at line 217 of file netif.h.

Enumeration Type Documentation

enum netif_mac_filter_action

MAC Filter Actions, these are passed to a netif's igmp_mac_filter or mld_mac_filter callback function.

Enumerator
NETIF_DEL_MAC_FILTER	Delete a filter entry
NETIF_ADD_MAC_FILTER	Add a filter entry

Definition at line 162 of file netif.h.

Function Documentation

err_t netif_input	(	struct pbuf *	p,
		struct netif *	inp
	)

Forwards a received packet for input processing with ethernet_input() or ip_input() depending on netif flags. Don't call directly, pass to netif_add() and call netif->input(). Only works if the netif driver correctly sets NETIF_FLAG_ETHARP and/or NETIF_FLAG_ETHERNET flag!

Definition at line 222 of file netif.c.

References netif::flags, NETIF_FLAG_ETHARP, and NETIF_FLAG_ETHERNET.

Variable Documentation

struct netif* netif_default

The default network interface.

Definition at line 124 of file netif.c.

struct netif* netif_list

The list of network interfaces.

Definition at line 123 of file netif.c.

Referenced by netif_add(), and netif_set_link_down().