net_if.h File Reference

Public API for network interface. More...

#include <device.h>
#include <sys/slist.h>
#include <net/net_core.h>
#include <net/hostname.h>
#include <net/net_linkaddr.h>
#include <net/net_ip.h>
#include <net/net_l2.h>
#include <net/net_stats.h>
#include <net/net_timeout.h>
#include <syscalls/net_if.h>

Go to the source code of this file.

Data Structures
struct	net_if_addr
	Network Interface unicast IP addresses. More...
struct	net_if_mcast_addr
	Network Interface multicast IP addresses. More...
struct	net_if_ipv6_prefix
	Network Interface IPv6 prefixes. More...
struct	net_if_router
	Information about routers in the system. More...
struct	net_if_ipv6
struct	net_if_ipv4
struct	net_if_ip
	Network interface IP address configuration. More...
struct	net_if_config
	IP and other configuration related data for network interface. More...
struct	net_traffic_class
	Network traffic class. More...
struct	net_if_dev
	Network Interface Device structure. More...
struct	net_if
	Network Interface structure. More...
struct	net_if_mcast_monitor
	Multicast monitor handler struct. More...
struct	net_if_link_cb
	Link callback handler struct. More...

Macros
#define	NET_DEVICE_INIT(dev_name, drv_name, init_fn, pm_control_fn, data, cfg, prio, api, l2, l2_ctx_type, mtu)
	Create a network interface and bind it to network device. More...
#define	NET_DEVICE_DT_DEFINE(node_id, init_fn, pm_control_fn, data, cfg, prio, api, l2, l2_ctx_type, mtu)
	Like NET_DEVICE_INIT but taking metadata from a devicetree node. Create a network interface and bind it to network device. More...
#define	NET_DEVICE_DT_INST_DEFINE(inst, ...)    NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
	Like NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible. More...
#define	NET_DEVICE_INIT_INSTANCE(dev_name, drv_name, instance, init_fn, pm_control_fn, data, cfg, prio, api, l2, l2_ctx_type, mtu)
	Create multiple network interfaces and bind them to network device. If your network device needs more than one instance of a network interface, use this macro below and provide a different instance suffix each time (0, 1, 2, ... or a, b, c ... whatever works for you) More...
#define	NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm_control_fn, data, cfg, prio, api, l2, l2_ctx_type, mtu)
	Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree. Create multiple network interfaces and bind them to network device. If your network device needs more than one instance of a network interface, use this macro below and provide a different instance suffix each time (0, 1, 2, ... or a, b, c ... whatever works for you) More...
#define	NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...)    NET_DEVICE_DT_DEFINE_INSTANCE(DT_DRV_INST(inst), __VA_ARGS__)
	Like NET_DEVICE_DT_DEFINE_INSTANCE for an instance of a DT_DRV_COMPAT compatible. More...
#define	NET_DEVICE_OFFLOAD_INIT(dev_name, drv_name, init_fn, pm_control_fn, data, cfg, prio, api, mtu)
	Create a offloaded network interface and bind it to network device. The offloaded network interface is implemented by a device vendor HAL or similar. More...
#define	NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm_control_fn, data, cfg, prio, api, mtu)
	Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree node. Create a offloaded network interface and bind it to network device. The offloaded network interface is implemented by a device vendor HAL or similar. More...
#define	NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...)    NET_DEVICE_DT_OFFLOAD_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
	Like NET_DEVICE_DT_OFFLOAD_DEFINE for an instance of a DT_DRV_COMPAT compatible. More...

Typedefs
typedef void(*	net_if_mcast_callback_t) (struct net_if *iface, const struct in6_addr *addr, bool is_joined)
	Define callback that is called whenever IPv6 multicast address group is joined or left. More...
typedef void(*	net_if_link_callback_t) (struct net_if *iface, struct net_linkaddr *dst, int status)
	Define callback that is called after a network packet has been sent. More...
typedef void(*	net_if_cb_t) (struct net_if *iface, void *user_data)
	Callback used while iterating over network interfaces. More...

Enumerations
enum	net_if_flag {   NET_IF_UP , NET_IF_POINTOPOINT , NET_IF_PROMISC , NET_IF_NO_AUTO_START ,   NET_IF_SUSPENDED , NET_IF_FORWARD_MULTICASTS , NET_IF_IPV4 , NET_IF_IPV6 }

Functions
static void	net_if_flag_set (struct net_if *iface, enum net_if_flag value)
	Set a value in network interface flags. More...
static bool	net_if_flag_test_and_set (struct net_if *iface, enum net_if_flag value)
	Test and set a value in network interface flags. More...
static void	net_if_flag_clear (struct net_if *iface, enum net_if_flag value)
	Clear a value in network interface flags. More...
static bool	net_if_flag_is_set (struct net_if *iface, enum net_if_flag value)
	Check if a value in network interface flags is set. More...
enum net_verdict	net_if_send_data (struct net_if *iface, struct net_pkt *pkt)
	Send a packet through a net iface. More...
static const struct net_l2 *const	net_if_l2 (struct net_if *iface)
	Get a pointer to the interface L2. More...
enum net_verdict	net_if_recv_data (struct net_if *iface, struct net_pkt *pkt)
	Input a packet through a net iface. More...
static void *	net_if_l2_data (struct net_if *iface)
	Get a pointer to the interface L2 private data. More...
static const struct device *	net_if_get_device (struct net_if *iface)
	Get an network interface's device. More...
void	net_if_queue_tx (struct net_if *iface, struct net_pkt *pkt)
	Queue a packet to the net interface TX queue. More...
static bool	net_if_is_ip_offloaded (struct net_if *iface)
	Return the IP offload status. More...
static struct net_offload *	net_if_offload (struct net_if *iface)
	Return the IP offload plugin. More...
static bool	net_if_is_socket_offloaded (struct net_if *iface)
	Return the socket offload status. More...
static struct net_linkaddr *	net_if_get_link_addr (struct net_if *iface)
	Get an network interface's link address. More...
static struct net_if_config *	net_if_get_config (struct net_if *iface)
	Return network configuration for this network interface. More...
static void	net_if_start_dad (struct net_if *iface)
	Start duplicate address detection procedure. More...
void	net_if_start_rs (struct net_if *iface)
	Start neighbor discovery and send router solicitation message. More...
static void	net_if_stop_rs (struct net_if *iface)
	Stop neighbor discovery. More...
static int	net_if_set_link_addr (struct net_if *iface, uint8_t *addr, uint8_t len, enum net_link_type type)
	Set a network interface's link address. More...
static uint16_t	net_if_get_mtu (struct net_if *iface)
	Get an network interface's MTU. More...
static void	net_if_set_mtu (struct net_if *iface, uint16_t mtu)
	Set an network interface's MTU. More...
static void	net_if_addr_set_lf (struct net_if_addr *ifaddr, bool is_infinite)
	Set the infinite status of the network interface address. More...
struct net_if *	net_if_get_by_link_addr (struct net_linkaddr *ll_addr)
	Get an interface according to link layer address. More...
struct net_if *	net_if_lookup_by_dev (const struct device *dev)
	Find an interface from it's related device. More...
static struct net_if_config *	net_if_config_get (struct net_if *iface)
	Get network interface IP config. More...
void	net_if_router_rm (struct net_if_router *router)
	Remove a router from the system. More...
struct net_if *	net_if_get_default (void)
	Get the default network interface. More...
struct net_if *	net_if_get_first_by_type (const struct net_l2 *l2)
	Get the first network interface according to its type. More...
int	net_if_config_ipv6_get (struct net_if *iface, struct net_if_ipv6 **ipv6)
	Allocate network interface IPv6 config. More...
int	net_if_config_ipv6_put (struct net_if *iface)
	Release network interface IPv6 config. More...
struct net_if_addr *	net_if_ipv6_addr_lookup (const struct in6_addr *addr, struct net_if **iface)
	Check if this IPv6 address belongs to one of the interfaces. More...
struct net_if_addr *	net_if_ipv6_addr_lookup_by_iface (struct net_if *iface, struct in6_addr *addr)
	Check if this IPv6 address belongs to this specific interfaces. More...
int	net_if_ipv6_addr_lookup_by_index (const struct in6_addr *addr)
	Check if this IPv6 address belongs to one of the interface indices. More...
struct net_if_addr *	net_if_ipv6_addr_add (struct net_if *iface, struct in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
	Add a IPv6 address to an interface. More...
bool	net_if_ipv6_addr_add_by_index (int index, struct in6_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
	Add a IPv6 address to an interface by index. More...
void	net_if_ipv6_addr_update_lifetime (struct net_if_addr *ifaddr, uint32_t vlifetime)
	Update validity lifetime time of an IPv6 address. More...
bool	net_if_ipv6_addr_rm (struct net_if *iface, const struct in6_addr *addr)
	Remove an IPv6 address from an interface. More...
bool	net_if_ipv6_addr_rm_by_index (int index, const struct in6_addr *addr)
	Remove an IPv6 address from an interface by index. More...
struct net_if_mcast_addr *	net_if_ipv6_maddr_add (struct net_if *iface, const struct in6_addr *addr)
	Add a IPv6 multicast address to an interface. More...
bool	net_if_ipv6_maddr_rm (struct net_if *iface, const struct in6_addr *addr)
	Remove an IPv6 multicast address from an interface. More...
struct net_if_mcast_addr *	net_if_ipv6_maddr_lookup (const struct in6_addr *addr, struct net_if **iface)
	Check if this IPv6 multicast address belongs to a specific interface or one of the interfaces. More...
void	net_if_mcast_mon_register (struct net_if_mcast_monitor *mon, struct net_if *iface, net_if_mcast_callback_t cb)
	Register a multicast monitor. More...
void	net_if_mcast_mon_unregister (struct net_if_mcast_monitor *mon)
	Unregister a multicast monitor. More...
void	net_if_mcast_monitor (struct net_if *iface, const struct in6_addr *addr, bool is_joined)
	Call registered multicast monitors. More...
void	net_if_ipv6_maddr_join (struct net_if_mcast_addr *addr)
	Mark a given multicast address to be joined. More...
static bool	net_if_ipv6_maddr_is_joined (struct net_if_mcast_addr *addr)
	Check if given multicast address is joined or not. More...
void	net_if_ipv6_maddr_leave (struct net_if_mcast_addr *addr)
	Mark a given multicast address to be left. More...
struct net_if_ipv6_prefix *	net_if_ipv6_prefix_get (struct net_if *iface, struct in6_addr *addr)
	Return prefix that corresponds to this IPv6 address. More...
struct net_if_ipv6_prefix *	net_if_ipv6_prefix_lookup (struct net_if *iface, struct in6_addr *addr, uint8_t len)
	Check if this IPv6 prefix belongs to this interface. More...
struct net_if_ipv6_prefix *	net_if_ipv6_prefix_add (struct net_if *iface, struct in6_addr *prefix, uint8_t len, uint32_t lifetime)
	Add a IPv6 prefix to an network interface. More...
bool	net_if_ipv6_prefix_rm (struct net_if *iface, struct in6_addr *addr, uint8_t len)
	Remove an IPv6 prefix from an interface. More...
static void	net_if_ipv6_prefix_set_lf (struct net_if_ipv6_prefix *prefix, bool is_infinite)
	Set the infinite status of the prefix. More...
void	net_if_ipv6_prefix_set_timer (struct net_if_ipv6_prefix *prefix, uint32_t lifetime)
	Set the prefix lifetime timer. More...
void	net_if_ipv6_prefix_unset_timer (struct net_if_ipv6_prefix *prefix)
	Unset the prefix lifetime timer. More...
bool	net_if_ipv6_addr_onlink (struct net_if **iface, struct in6_addr *addr)
	Check if this IPv6 address is part of the subnet of our network interface. More...
static struct in6_addr *	net_if_router_ipv6 (struct net_if_router *router)
	Get the IPv6 address of the given router. More...
struct net_if_router *	net_if_ipv6_router_lookup (struct net_if *iface, struct in6_addr *addr)
	Check if IPv6 address is one of the routers configured in the system. More...
struct net_if_router *	net_if_ipv6_router_find_default (struct net_if *iface, struct in6_addr *addr)
	Find default router for this IPv6 address. More...
void	net_if_ipv6_router_update_lifetime (struct net_if_router *router, uint16_t lifetime)
	Update validity lifetime time of a router. More...
struct net_if_router *	net_if_ipv6_router_add (struct net_if *iface, struct in6_addr *addr, uint16_t router_lifetime)
	Add IPv6 router to the system. More...
bool	net_if_ipv6_router_rm (struct net_if_router *router)
	Remove IPv6 router from the system. More...
uint8_t	net_if_ipv6_get_hop_limit (struct net_if *iface)
	Get IPv6 hop limit specified for a given interface. This is the default value but can be overridden by the user. More...
void	net_ipv6_set_hop_limit (struct net_if *iface, uint8_t hop_limit)
	Set the default IPv6 hop limit of a given interface. More...
static void	net_if_ipv6_set_base_reachable_time (struct net_if *iface, uint32_t reachable_time)
	Set IPv6 reachable time for a given interface. More...
static uint32_t	net_if_ipv6_get_reachable_time (struct net_if *iface)
	Get IPv6 reachable timeout specified for a given interface. More...
uint32_t	net_if_ipv6_calc_reachable_time (struct net_if_ipv6 *ipv6)
	Calculate next reachable time value for IPv6 reachable time. More...
static void	net_if_ipv6_set_reachable_time (struct net_if_ipv6 *ipv6)
	Set IPv6 reachable time for a given interface. This requires that base reachable time is set for the interface. More...
static void	net_if_ipv6_set_retrans_timer (struct net_if *iface, uint32_t retrans_timer)
	Set IPv6 retransmit timer for a given interface. More...
static uint32_t	net_if_ipv6_get_retrans_timer (struct net_if *iface)
	Get IPv6 retransmit timer specified for a given interface. More...
static const struct in6_addr *	net_if_ipv6_select_src_addr (struct net_if *iface, const struct in6_addr *dst)
	Get a IPv6 source address that should be used when sending network data to destination. More...
static struct net_if *	net_if_ipv6_select_src_iface (const struct in6_addr *dst)
	Get a network interface that should be used when sending IPv6 network data to destination. More...
struct in6_addr *	net_if_ipv6_get_ll (struct net_if *iface, enum net_addr_state addr_state)
	Get a IPv6 link local address in a given state. More...
struct in6_addr *	net_if_ipv6_get_ll_addr (enum net_addr_state state, struct net_if **iface)
	Return link local IPv6 address from the first interface that has a link local address matching give state. More...
void	net_if_ipv6_dad_failed (struct net_if *iface, const struct in6_addr *addr)
	Stop IPv6 Duplicate Address Detection (DAD) procedure if we find out that our IPv6 address is already in use. More...
struct in6_addr *	net_if_ipv6_get_global_addr (enum net_addr_state state, struct net_if **iface)
	Return global IPv6 address from the first interface that has a global IPv6 address matching the given state. More...
int	net_if_config_ipv4_get (struct net_if *iface, struct net_if_ipv4 **ipv4)
	Allocate network interface IPv4 config. More...
int	net_if_config_ipv4_put (struct net_if *iface)
	Release network interface IPv4 config. More...
uint8_t	net_if_ipv4_get_ttl (struct net_if *iface)
	Get IPv4 time-to-live value specified for a given interface. More...
void	net_if_ipv4_set_ttl (struct net_if *iface, uint8_t ttl)
	Set IPv4 time-to-live value specified to a given interface. More...
struct net_if_addr *	net_if_ipv4_addr_lookup (const struct in_addr *addr, struct net_if **iface)
	Check if this IPv4 address belongs to one of the interfaces. More...
struct net_if_addr *	net_if_ipv4_addr_add (struct net_if *iface, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
	Add a IPv4 address to an interface. More...
bool	net_if_ipv4_addr_rm (struct net_if *iface, const struct in_addr *addr)
	Remove a IPv4 address from an interface. More...
int	net_if_ipv4_addr_lookup_by_index (const struct in_addr *addr)
	Check if this IPv4 address belongs to one of the interface indices. More...
bool	net_if_ipv4_addr_add_by_index (int index, struct in_addr *addr, enum net_addr_type addr_type, uint32_t vlifetime)
	Add a IPv4 address to an interface by network interface index. More...
bool	net_if_ipv4_addr_rm_by_index (int index, const struct in_addr *addr)
	Remove a IPv4 address from an interface by interface index. More...
struct net_if_mcast_addr *	net_if_ipv4_maddr_add (struct net_if *iface, const struct in_addr *addr)
	Add a IPv4 multicast address to an interface. More...
bool	net_if_ipv4_maddr_rm (struct net_if *iface, const struct in_addr *addr)
	Remove an IPv4 multicast address from an interface. More...
struct net_if_mcast_addr *	net_if_ipv4_maddr_lookup (const struct in_addr *addr, struct net_if **iface)
	Check if this IPv4 multicast address belongs to a specific interface or one of the interfaces. More...
void	net_if_ipv4_maddr_join (struct net_if_mcast_addr *addr)
	Mark a given multicast address to be joined. More...
static bool	net_if_ipv4_maddr_is_joined (struct net_if_mcast_addr *addr)
	Check if given multicast address is joined or not. More...
void	net_if_ipv4_maddr_leave (struct net_if_mcast_addr *addr)
	Mark a given multicast address to be left. More...
static struct in_addr *	net_if_router_ipv4 (struct net_if_router *router)
	Get the IPv4 address of the given router. More...
struct net_if_router *	net_if_ipv4_router_lookup (struct net_if *iface, struct in_addr *addr)
	Check if IPv4 address is one of the routers configured in the system. More...
struct net_if_router *	net_if_ipv4_router_find_default (struct net_if *iface, struct in_addr *addr)
	Find default router for this IPv4 address. More...
struct net_if_router *	net_if_ipv4_router_add (struct net_if *iface, struct in_addr *addr, bool is_default, uint16_t router_lifetime)
	Add IPv4 router to the system. More...
bool	net_if_ipv4_router_rm (struct net_if_router *router)
	Remove IPv4 router from the system. More...
bool	net_if_ipv4_addr_mask_cmp (struct net_if *iface, const struct in_addr *addr)
	Check if the given IPv4 address belongs to local subnet. More...
bool	net_if_ipv4_is_addr_bcast (struct net_if *iface, const struct in_addr *addr)
	Check if the given IPv4 address is a broadcast address. More...
static struct net_if *	net_if_ipv4_select_src_iface (const struct in_addr *dst)
	Get a network interface that should be used when sending IPv4 network data to destination. More...
static const struct in_addr *	net_if_ipv4_select_src_addr (struct net_if *iface, const struct in_addr *dst)
	Get a IPv4 source address that should be used when sending network data to destination. More...
struct in_addr *	net_if_ipv4_get_ll (struct net_if *iface, enum net_addr_state addr_state)
	Get a IPv4 link local address in a given state. More...
struct in_addr *	net_if_ipv4_get_global_addr (struct net_if *iface, enum net_addr_state addr_state)
	Get a IPv4 global address in a given state. More...
void	net_if_ipv4_set_netmask (struct net_if *iface, const struct in_addr *netmask)
	Set IPv4 netmask for an interface. More...
bool	net_if_ipv4_set_netmask_by_index (int index, const struct in_addr *netmask)
	Set IPv4 netmask for an interface index. More...
void	net_if_ipv4_set_gw (struct net_if *iface, const struct in_addr *gw)
	Set IPv4 gateway for an interface. More...
bool	net_if_ipv4_set_gw_by_index (int index, const struct in_addr *gw)
	Set IPv4 gateway for an interface index. More...
struct net_if *	net_if_select_src_iface (const struct sockaddr *dst)
	Get a network interface that should be used when sending IPv6 or IPv4 network data to destination. More...
void	net_if_register_link_cb (struct net_if_link_cb *link, net_if_link_callback_t cb)
	Register a link callback. More...
void	net_if_unregister_link_cb (struct net_if_link_cb *link)
	Unregister a link callback. More...
void	net_if_call_link_cb (struct net_if *iface, struct net_linkaddr *lladdr, int status)
	Call a link callback function. More...
bool	net_if_need_calc_rx_checksum (struct net_if *iface)
	Check if received network packet checksum calculation can be avoided or not. For example many ethernet devices support network packet offloading in which case the IP stack does not need to calculate the checksum. More...
bool	net_if_need_calc_tx_checksum (struct net_if *iface)
	Check if network packet checksum calculation can be avoided or not when sending the packet. For example many ethernet devices support network packet offloading in which case the IP stack does not need to calculate the checksum. More...
struct net_if *	net_if_get_by_index (int index)
	Get interface according to index. More...
int	net_if_get_by_iface (struct net_if *iface)
	Get interface index according to pointer. More...
void	net_if_foreach (net_if_cb_t cb, void *user_data)
	Go through all the network interfaces and call callback for each interface. More...
int	net_if_up (struct net_if *iface)
	Bring interface up. More...
static bool	net_if_is_up (struct net_if *iface)
	Check if interface is up. More...
int	net_if_down (struct net_if *iface)
	Bring interface down. More...
int	net_if_set_promisc (struct net_if *iface)
	Set network interface into promiscuous mode. More...
void	net_if_unset_promisc (struct net_if *iface)
	Set network interface into normal mode. More...
bool	net_if_is_promisc (struct net_if *iface)
	Check if promiscuous mode is set or not. More...
static bool	net_if_are_pending_tx_packets (struct net_if *iface)
	Check if there are any pending TX network data for a given network interface. More...

Detailed Description

Public API for network interface.