Network Interface abstraction layer

Network Interface abstraction layer . More...

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
	IPv6 configuration. More...
struct	net_if_addr_ipv4
	Network Interface unicast IPv4 address and netmask. More...
struct	net_if_ipv4
	IPv4 configuration. More...
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_id, name, init_fn, pm, data, config, prio, api, l2, l2_ctx_type, mtu)
	Create a network interface and bind it to network device.
#define	NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, prio, api, l2, l2_ctx_type, mtu)
	Like NET_DEVICE_INIT but taking metadata from a devicetree node.
#define	NET_DEVICE_DT_INST_DEFINE(inst, ...)
	Like NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible.
#define	NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, data, config, prio, api, l2, l2_ctx_type, mtu)
	Create multiple network interfaces and bind them to network device.
#define	NET_DEVICE_DT_DEFINE_INSTANCE(node_id, instance, init_fn, pm, data, config, prio, api, l2, l2_ctx_type, mtu)
	Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree.
#define	NET_DEVICE_DT_INST_DEFINE_INSTANCE(inst, ...)
	Like NET_DEVICE_DT_DEFINE_INSTANCE for an instance of a DT_DRV_COMPAT compatible.
#define	NET_DEVICE_OFFLOAD_INIT(dev_id, name, init_fn, pm, data, config, prio, api, mtu)
	Create a offloaded network interface and bind it to network device.
#define	NET_DEVICE_DT_OFFLOAD_DEFINE(node_id, init_fn, pm, data, config, prio, api, mtu)
	Like NET_DEVICE_OFFLOAD_INIT but taking metadata from a devicetree node.
#define	NET_DEVICE_DT_INST_OFFLOAD_DEFINE(inst, ...)
	Like NET_DEVICE_DT_OFFLOAD_DEFINE for an instance of a DT_DRV_COMPAT compatible.
#define	NET_IFACE_COUNT(_dst)
	Count the number of network interfaces.

Typedefs
typedef int(*	net_socket_create_t) (int, int, int)
	A function prototype to create an offloaded socket.
typedef void(*	net_if_ip_addr_cb_t) (struct net_if *iface, struct net_if_addr *addr, void *user_data)
	Callback used while iterating over network interface IP addresses.
typedef void(*	net_if_ip_maddr_cb_t) (struct net_if *iface, struct net_if_mcast_addr *maddr, void *user_data)
	Callback used while iterating over network interface multicast IP addresses.
typedef void(*	net_if_mcast_callback_t) (struct net_if *iface, const struct net_addr *addr, bool is_joined)
	Define a callback that is called whenever a IPv6 or IPv4 multicast address group is joined or left.
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.
typedef void(*	net_if_cb_t) (struct net_if *iface, void *user_data)
	Callback used while iterating over network interfaces.

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 ,   NET_IF_RUNNING , NET_IF_LOWER_UP , NET_IF_DORMANT , NET_IF_IPV6_NO_ND ,   NET_IF_IPV6_NO_MLD , NET_IF_NO_TX_LOCK }
	Network interface flags. More...
enum	net_if_oper_state {   NET_IF_OPER_UNKNOWN , NET_IF_OPER_NOTPRESENT , NET_IF_OPER_DOWN , NET_IF_OPER_LOWERLAYERDOWN ,   NET_IF_OPER_TESTING , NET_IF_OPER_DORMANT , NET_IF_OPER_UP }
	Network interface operational status (RFC 2863). More...
enum	net_if_checksum_type {   NET_IF_CHECKSUM_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT , NET_IF_CHECKSUM_IPV4_TCP , NET_IF_CHECKSUM_IPV4_UDP , NET_IF_CHECKSUM_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT ,   NET_IF_CHECKSUM_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT , NET_IF_CHECKSUM_IPV6_TCP , NET_IF_CHECKSUM_IPV6_UDP , NET_IF_CHECKSUM_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT }
	Type of checksum for which support in the interface will be queried. More...

Functions
static void	net_if_flag_set (struct net_if *iface, enum net_if_flag value)
	Set a value in network interface flags.
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.
static void	net_if_flag_clear (struct net_if *iface, enum net_if_flag value)
	Clear a value in network interface flags.
static bool	net_if_flag_test_and_clear (struct net_if *iface, enum net_if_flag value)
	Test and clear a value in network interface flags.
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.
static enum net_if_oper_state	net_if_oper_state_set (struct net_if *iface, enum net_if_oper_state oper_state)
	Set an operational state on an interface.
static enum net_if_oper_state	net_if_oper_state (struct net_if *iface)
	Get an operational state of an interface.
enum net_verdict	net_if_send_data (struct net_if *iface, struct net_pkt *pkt)
	Send a packet through a net iface.
static const struct net_l2 *	net_if_l2 (struct net_if *iface)
	Get a pointer to the interface L2.
enum net_verdict	net_if_recv_data (struct net_if *iface, struct net_pkt *pkt)
	Input a packet through a net iface.
static void *	net_if_l2_data (struct net_if *iface)
	Get a pointer to the interface L2 private data.
static const struct device *	net_if_get_device (struct net_if *iface)
	Get an network interface's device.
void	net_if_queue_tx (struct net_if *iface, struct net_pkt *pkt)
	Queue a packet to the net interface TX queue.
static bool	net_if_is_ip_offloaded (struct net_if *iface)
	Return the IP offload status.
bool	net_if_is_offloaded (struct net_if *iface)
	Return offload status of a given network interface.
static struct net_offload *	net_if_offload (struct net_if *iface)
	Return the IP offload plugin.
static bool	net_if_is_socket_offloaded (struct net_if *iface)
	Return the socket offload status.
static void	net_if_socket_offload_set (struct net_if *iface, net_socket_create_t socket_offload)
	Set the function to create an offloaded socket.
static net_socket_create_t	net_if_socket_offload (struct net_if *iface)
	Return the function to create an offloaded socket.
static struct net_linkaddr *	net_if_get_link_addr (struct net_if *iface)
	Get an network interface's link address.
static struct net_if_config *	net_if_get_config (struct net_if *iface)
	Return network configuration for this network interface.
static void	net_if_start_dad (struct net_if *iface)
	Start duplicate address detection procedure.
void	net_if_start_rs (struct net_if *iface)
	Start neighbor discovery and send router solicitation message.
static void	net_if_stop_rs (struct net_if *iface)
	Stop neighbor discovery.
static void	net_if_nbr_reachability_hint (struct net_if *iface, const struct in6_addr *ipv6_addr)
	Provide a reachability hint for IPv6 Neighbor Discovery.
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.
static uint16_t	net_if_get_mtu (struct net_if *iface)
	Get an network interface's MTU.
static void	net_if_set_mtu (struct net_if *iface, uint16_t mtu)
	Set an network interface's MTU.
static void	net_if_addr_set_lf (struct net_if_addr *ifaddr, bool is_infinite)
	Set the infinite status of the network interface address.
struct net_if *	net_if_get_by_link_addr (struct net_linkaddr *ll_addr)
	Get an interface according to link layer address.
struct net_if *	net_if_lookup_by_dev (const struct device *dev)
	Find an interface from it's related device.
static struct net_if_config *	net_if_config_get (struct net_if *iface)
	Get network interface IP config.
void	net_if_router_rm (struct net_if_router *router)
	Remove a router from the system.
void	net_if_set_default (struct net_if *iface)
	Set the default network interface.
struct net_if *	net_if_get_default (void)
	Get the default network interface.
struct net_if *	net_if_get_first_by_type (const struct net_l2 *l2)
	Get the first network interface according to its type.
struct net_if *	net_if_get_first_up (void)
	Get the first network interface which is up.
int	net_if_config_ipv6_get (struct net_if *iface, struct net_if_ipv6 **ipv6)
	Allocate network interface IPv6 config.
int	net_if_config_ipv6_put (struct net_if *iface)
	Release network interface IPv6 config.
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.
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.
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.
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.
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.
void	net_if_ipv6_addr_update_lifetime (struct net_if_addr *ifaddr, uint32_t vlifetime)
	Update validity lifetime time of an IPv6 address.
bool	net_if_ipv6_addr_rm (struct net_if *iface, const struct in6_addr *addr)
	Remove an IPv6 address from an interface.
bool	net_if_ipv6_addr_rm_by_index (int index, const struct in6_addr *addr)
	Remove an IPv6 address from an interface by index.
void	net_if_ipv6_addr_foreach (struct net_if *iface, net_if_ip_addr_cb_t cb, void *user_data)
	Go through all IPv6 addresses on a network interface and call callback for each used address.
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.
bool	net_if_ipv6_maddr_rm (struct net_if *iface, const struct in6_addr *addr)
	Remove an IPv6 multicast address from an interface.
void	net_if_ipv6_maddr_foreach (struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
	Go through all IPv6 multicast addresses on a network interface and call callback for each used address.
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.
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.
void	net_if_mcast_mon_unregister (struct net_if_mcast_monitor *mon)
	Unregister a multicast monitor.
void	net_if_mcast_monitor (struct net_if *iface, const struct net_addr *addr, bool is_joined)
	Call registered multicast monitors.
void	net_if_ipv6_maddr_join (struct net_if *iface, struct net_if_mcast_addr *addr)
	Mark a given multicast address to be joined.
static bool	net_if_ipv6_maddr_is_joined (struct net_if_mcast_addr *addr)
	Check if given multicast address is joined or not.
void	net_if_ipv6_maddr_leave (struct net_if *iface, struct net_if_mcast_addr *addr)
	Mark a given multicast address to be left.
struct net_if_ipv6_prefix *	net_if_ipv6_prefix_get (struct net_if *iface, const struct in6_addr *addr)
	Return prefix that corresponds to this IPv6 address.
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.
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.
bool	net_if_ipv6_prefix_rm (struct net_if *iface, struct in6_addr *addr, uint8_t len)
	Remove an IPv6 prefix from an interface.
static void	net_if_ipv6_prefix_set_lf (struct net_if_ipv6_prefix *prefix, bool is_infinite)
	Set the infinite status of the prefix.
void	net_if_ipv6_prefix_set_timer (struct net_if_ipv6_prefix *prefix, uint32_t lifetime)
	Set the prefix lifetime timer.
void	net_if_ipv6_prefix_unset_timer (struct net_if_ipv6_prefix *prefix)
	Unset the prefix lifetime timer.
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.
static struct in6_addr *	net_if_router_ipv6 (struct net_if_router *router)
	Get the IPv6 address of the given router.
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.
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.
void	net_if_ipv6_router_update_lifetime (struct net_if_router *router, uint16_t lifetime)
	Update validity lifetime time of a router.
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.
bool	net_if_ipv6_router_rm (struct net_if_router *router)
	Remove IPv6 router from the system.
static uint8_t	net_if_ipv6_get_hop_limit (struct net_if *iface)
	Get IPv6 hop limit specified for a given interface.
static void	net_if_ipv6_set_hop_limit (struct net_if *iface, uint8_t hop_limit)
	Set the default IPv6 hop limit of a given interface.
static uint8_t	net_if_ipv6_get_mcast_hop_limit (struct net_if *iface)
	Get IPv6 multicast hop limit specified for a given interface.
static void	net_if_ipv6_set_mcast_hop_limit (struct net_if *iface, uint8_t hop_limit)
	Set the default IPv6 multicast hop limit of a given interface.
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.
static uint32_t	net_if_ipv6_get_reachable_time (struct net_if *iface)
	Get IPv6 reachable timeout specified for a given interface.
uint32_t	net_if_ipv6_calc_reachable_time (struct net_if_ipv6 *ipv6)
	Calculate next reachable time value for IPv6 reachable time.
static void	net_if_ipv6_set_reachable_time (struct net_if_ipv6 *ipv6)
	Set IPv6 reachable time for a given interface.
static void	net_if_ipv6_set_retrans_timer (struct net_if *iface, uint32_t retrans_timer)
	Set IPv6 retransmit timer for a given interface.
static uint32_t	net_if_ipv6_get_retrans_timer (struct net_if *iface)
	Get IPv6 retransmit timer specified for a given interface.
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.
static const struct in6_addr *	net_if_ipv6_select_src_addr_hint (struct net_if *iface, const struct in6_addr *dst, int flags)
	Get a IPv6 source address that should be used when sending network data to destination.
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.
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.
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.
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.
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.
int	net_if_config_ipv4_get (struct net_if *iface, struct net_if_ipv4 **ipv4)
	Allocate network interface IPv4 config.
int	net_if_config_ipv4_put (struct net_if *iface)
	Release network interface IPv4 config.
uint8_t	net_if_ipv4_get_ttl (struct net_if *iface)
	Get IPv4 time-to-live value specified for a given interface.
void	net_if_ipv4_set_ttl (struct net_if *iface, uint8_t ttl)
	Set IPv4 time-to-live value specified to a given interface.
uint8_t	net_if_ipv4_get_mcast_ttl (struct net_if *iface)
	Get IPv4 multicast time-to-live value specified for a given interface.
void	net_if_ipv4_set_mcast_ttl (struct net_if *iface, uint8_t ttl)
	Set IPv4 multicast time-to-live value specified to a given interface.
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.
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.
bool	net_if_ipv4_addr_rm (struct net_if *iface, const struct in_addr *addr)
	Remove a IPv4 address from an interface.
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.
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.
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.
void	net_if_ipv4_addr_foreach (struct net_if *iface, net_if_ip_addr_cb_t cb, void *user_data)
	Go through all IPv4 addresses on a network interface and call callback for each used address.
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.
bool	net_if_ipv4_maddr_rm (struct net_if *iface, const struct in_addr *addr)
	Remove an IPv4 multicast address from an interface.
void	net_if_ipv4_maddr_foreach (struct net_if *iface, net_if_ip_maddr_cb_t cb, void *user_data)
	Go through all IPv4 multicast addresses on a network interface and call callback for each used address.
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.
void	net_if_ipv4_maddr_join (struct net_if *iface, struct net_if_mcast_addr *addr)
	Mark a given multicast address to be joined.
static bool	net_if_ipv4_maddr_is_joined (struct net_if_mcast_addr *addr)
	Check if given multicast address is joined or not.
void	net_if_ipv4_maddr_leave (struct net_if *iface, struct net_if_mcast_addr *addr)
	Mark a given multicast address to be left.
static struct in_addr *	net_if_router_ipv4 (struct net_if_router *router)
	Get the IPv4 address of the given router.
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.
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.
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.
bool	net_if_ipv4_router_rm (struct net_if_router *router)
	Remove IPv4 router from the system.
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.
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.
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.
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.
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.
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.
struct in_addr	net_if_ipv4_get_netmask_by_addr (struct net_if *iface, const struct in_addr *addr)
	Get IPv4 netmask related to an address of an interface.
struct in_addr	net_if_ipv4_get_netmask (struct net_if *iface)
	Get IPv4 netmask of an interface.
void	net_if_ipv4_set_netmask (struct net_if *iface, const struct in_addr *netmask)
	Set IPv4 netmask for an interface.
bool	net_if_ipv4_set_netmask_by_index (int index, const struct in_addr *netmask)
	Set IPv4 netmask for an interface index.
bool	net_if_ipv4_set_netmask_by_addr_by_index (int index, const struct in_addr *addr, const struct in_addr *netmask)
	Set IPv4 netmask for an interface index for a given address.
bool	net_if_ipv4_set_netmask_by_addr (struct net_if *iface, const struct in_addr *addr, const struct in_addr *netmask)
	Set IPv4 netmask for an interface index for a given address.
struct in_addr	net_if_ipv4_get_gw (struct net_if *iface)
	Get IPv4 gateway of an interface.
void	net_if_ipv4_set_gw (struct net_if *iface, const struct in_addr *gw)
	Set IPv4 gateway for an interface.
bool	net_if_ipv4_set_gw_by_index (int index, const struct in_addr *gw)
	Set IPv4 gateway for an interface index.
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.
void	net_if_register_link_cb (struct net_if_link_cb *link, net_if_link_callback_t cb)
	Register a link callback.
void	net_if_unregister_link_cb (struct net_if_link_cb *link)
	Unregister a link callback.
void	net_if_call_link_cb (struct net_if *iface, struct net_linkaddr *lladdr, int status)
	Call a link callback function.
bool	net_if_need_calc_rx_checksum (struct net_if *iface, enum net_if_checksum_type chksum_type)
	Check if received network packet checksum calculation can be avoided or not.
bool	net_if_need_calc_tx_checksum (struct net_if *iface, enum net_if_checksum_type chksum_type)
	Check if network packet checksum calculation can be avoided or not when sending the packet.
struct net_if *	net_if_get_by_index (int index)
	Get interface according to index.
int	net_if_get_by_iface (struct net_if *iface)
	Get interface index according to pointer.
void	net_if_foreach (net_if_cb_t cb, void *user_data)
	Go through all the network interfaces and call callback for each interface.
int	net_if_up (struct net_if *iface)
	Bring interface up.
static bool	net_if_is_up (struct net_if *iface)
	Check if interface is up and running.
int	net_if_down (struct net_if *iface)
	Bring interface down.
static bool	net_if_is_admin_up (struct net_if *iface)
	Check if interface was brought up by the administrator.
void	net_if_carrier_on (struct net_if *iface)
	Underlying network device has detected the carrier (cable connected).
void	net_if_carrier_off (struct net_if *iface)
	Underlying network device has lost the carrier (cable disconnected).
static bool	net_if_is_carrier_ok (struct net_if *iface)
	Check if carrier is present on network device.
void	net_if_dormant_on (struct net_if *iface)
	Mark interface as dormant.
void	net_if_dormant_off (struct net_if *iface)
	Mark interface as not dormant.
static bool	net_if_is_dormant (struct net_if *iface)
	Check if the interface is dormant.
static int	net_if_set_promisc (struct net_if *iface)
	Set network interface into promiscuous mode.
static void	net_if_unset_promisc (struct net_if *iface)
	Set network interface into normal mode.
static bool	net_if_is_promisc (struct net_if *iface)
	Check if promiscuous mode is set or not.
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.
bool	net_if_is_wifi (struct net_if *iface)
	Check if the network interface supports Wi-Fi.
struct net_if *	net_if_get_first_wifi (void)
	Get first Wi-Fi network interface.
struct net_if *	net_if_get_wifi_sta (void)
	Get Wi-Fi network station interface.
struct net_if *	net_if_get_wifi_sap (void)
	Get first Wi-Fi network Soft-AP interface.
int	net_if_get_name (struct net_if *iface, char *buf, int len)
	Get network interface name.
int	net_if_set_name (struct net_if *iface, const char *buf)
	Set network interface name.
int	net_if_get_by_name (const char *name)
	Get interface index according to its name.

Detailed Description

Network Interface abstraction layer .

Since

1.5

Version

1.0.0

Macro Definition Documentation

NET_DEVICE_DT_DEFINE

#define NET_DEVICE_DT_DEFINE	(		node_id,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			l2,
			l2_ctx_type,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
                          DEVICE_DT_NAME(node_id), init_fn, pm, data,   \
                          config, 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.

Parameters

node_id	The devicetree node identifier.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
l2	Network L2 layer for this network interface.
l2_ctx_type	Type of L2 context data.
mtu	Maximum transfer unit in bytes for this network interface.

NET_DEVICE_DT_DEFINE_INSTANCE

#define NET_DEVICE_DT_DEFINE_INSTANCE	(		node_id,
			instance,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			l2,
			l2_ctx_type,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_INIT_INSTANCE(node_id,                             \
                                   Z_DEVICE_DT_DEV_ID(node_id),         \
                                   DEVICE_DT_NAME(node_id), instance,   \
                                   init_fn, pm, data, config, 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)

Parameters

node_id	The devicetree node identifier.
instance	Instance identifier.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
l2	Network L2 layer for this network interface.
l2_ctx_type	Type of L2 context data.
mtu	Maximum transfer unit in bytes for this network interface.

NET_DEVICE_DT_INST_DEFINE

#define NET_DEVICE_DT_INST_DEFINE	(		inst,
			... )

#include <zephyr/net/net_if.h>

Value:

        NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)

Like NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible.

Parameters

inst	instance number. This is replaced by DT_DRV_COMPAT(inst) in the call to NET_DEVICE_DT_DEFINE.
...	other parameters as expected by NET_DEVICE_DT_DEFINE.

NET_DEVICE_DT_INST_DEFINE_INSTANCE

#define NET_DEVICE_DT_INST_DEFINE_INSTANCE	(		inst,
			... )

#include <zephyr/net/net_if.h>

Value:

        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.

Parameters

inst	instance number. This is replaced by DT_DRV_COMPAT(inst) in the call to NET_DEVICE_DT_DEFINE_INSTANCE.
...	other parameters as expected by NET_DEVICE_DT_DEFINE_INSTANCE.

NET_DEVICE_DT_INST_OFFLOAD_DEFINE

#define NET_DEVICE_DT_INST_OFFLOAD_DEFINE	(		inst,
			... )

#include <zephyr/net/net_if.h>

Value:

        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.

Parameters

inst	instance number. This is replaced by DT_DRV_COMPAT(inst) in the call to NET_DEVICE_DT_OFFLOAD_DEFINE.
...	other parameters as expected by NET_DEVICE_DT_OFFLOAD_DEFINE.

NET_DEVICE_DT_OFFLOAD_DEFINE

#define NET_DEVICE_DT_OFFLOAD_DEFINE	(		node_id,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_OFFLOAD_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
                                  DEVICE_DT_NAME(node_id), init_fn, pm, \
                                  data, config, 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.

Parameters

node_id	The devicetree node identifier.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
mtu	Maximum transfer unit in bytes for this network interface.

NET_DEVICE_INIT

#define NET_DEVICE_INIT	(		dev_id,
			name,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			l2,
			l2_ctx_type,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, pm,   \
                          data, config, prio, api, l2, l2_ctx_type, mtu)

Create a network interface and bind it to network device.

Parameters

dev_id	Network device id.
name	The name this instance of the driver exposes to the system.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
l2	Network L2 layer for this network interface.
l2_ctx_type	Type of L2 context data.
mtu	Maximum transfer unit in bytes for this network interface.

NET_DEVICE_INIT_INSTANCE

#define NET_DEVICE_INIT_INSTANCE	(		dev_id,
			name,
			instance,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			l2,
			l2_ctx_type,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name,       \
                                   instance, init_fn, pm, data, config, \
                                   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)

Parameters

dev_id	Network device id.
name	The name this instance of the driver exposes to the system.
instance	Instance identifier.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
l2	Network L2 layer for this network interface.
l2_ctx_type	Type of L2 context data.
mtu	Maximum transfer unit in bytes for this network interface.

NET_DEVICE_OFFLOAD_INIT

#define NET_DEVICE_OFFLOAD_INIT	(		dev_id,
			name,
			init_fn,
			pm,
			data,
			config,
			prio,
			api,
			mtu )

#include <zephyr/net/net_if.h>

Value:

        Z_NET_DEVICE_OFFLOAD_INIT(DT_INVALID_NODE, dev_id, name,        \
                                  init_fn, pm, data, config, 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.

Parameters

dev_id	Network device id.
name	The name this instance of the driver exposes to the system.
init_fn	Address to the init function of the driver.
pm	Reference to struct pm_device associated with the device. (optional).
data	Pointer to the device's private data.
config	The address to the structure containing the configuration information for this instance of the driver.
prio	The initialization level at which configuration occurs.
api	Provides an initial pointer to the API function struct used by the driver. Can be NULL.
mtu	Maximum transfer unit in bytes for this network interface.

NET_IFACE_COUNT

#define NET_IFACE_COUNT

(

_dst

)

#include <zephyr/net/net_if.h>

Value:

                do {                                                    \
                        extern struct net_if _net_if_list_start[];      \
                        extern struct net_if _net_if_list_end[];        \
                        *(_dst) = ((uintptr_t)_net_if_list_end -        \
                                   (uintptr_t)_net_if_list_start) /     \
                                sizeof(struct net_if);                  \
                } while (0)

Count the number of network interfaces.

Parameters

[out]

_dst

Pointer to location where result is written.

Typedef Documentation

net_if_cb_t

typedef void(* net_if_cb_t) (struct net_if *iface, void *user_data)

#include <zephyr/net/net_if.h>

Callback used while iterating over network interfaces.

Parameters

iface	Pointer to current network interface
user_data	A valid pointer to user data or NULL

net_if_ip_addr_cb_t

typedef void(* net_if_ip_addr_cb_t) (struct net_if *iface, struct net_if_addr *addr, void *user_data)

#include <zephyr/net/net_if.h>

Callback used while iterating over network interface IP addresses.

Parameters

iface	Pointer to the network interface the address belongs to
addr	Pointer to current IP address
user_data	A valid pointer to user data or NULL

net_if_ip_maddr_cb_t

typedef void(* net_if_ip_maddr_cb_t) (struct net_if *iface, struct net_if_mcast_addr *maddr, void *user_data)

#include <zephyr/net/net_if.h>

Callback used while iterating over network interface multicast IP addresses.

Parameters

iface	Pointer to the network interface the address belongs to
maddr	Pointer to current multicast IP address
user_data	A valid pointer to user data or NULL

net_if_link_callback_t

typedef void(* net_if_link_callback_t) (struct net_if *iface, struct net_linkaddr *dst, int status)

#include <zephyr/net/net_if.h>

Define callback that is called after a network packet has been sent.

Parameters

iface	A pointer to a struct net_if to which the net_pkt was sent to.
dst	Link layer address of the destination where the network packet was sent.
status	Send status, 0 is ok, < 0 error.

net_if_mcast_callback_t

typedef void(* net_if_mcast_callback_t) (struct net_if *iface, const struct net_addr *addr, bool is_joined)

#include <zephyr/net/net_if.h>

Define a callback that is called whenever a IPv6 or IPv4 multicast address group is joined or left.

Parameters

iface	A pointer to a struct net_if to which the multicast address is attached.
addr	IP multicast address.
is_joined	True if the multicast group is joined, false if group is left.

net_socket_create_t

typedef int(* net_socket_create_t) (int, int, int)

#include <zephyr/net/net_if.h>

A function prototype to create an offloaded socket.

The prototype is compatible with socket() function.

Enumeration Type Documentation

net_if_checksum_type

enum net_if_checksum_type

#include <zephyr/net/net_if.h>

Type of checksum for which support in the interface will be queried.

Enumerator
NET_IF_CHECKSUM_IPV4_HEADER	Interface supports IP version 4 header checksum calculation.
NET_IF_CHECKSUM_IPV4_TCP	Interface supports checksum calculation for TCP payload in IPv4.
NET_IF_CHECKSUM_IPV4_UDP	Interface supports checksum calculation for UDP payload in IPv4.
NET_IF_CHECKSUM_IPV4_ICMP	Interface supports checksum calculation for ICMP4 payload in IPv4.
NET_IF_CHECKSUM_IPV6_HEADER	Interface supports IP version 6 header checksum calculation.
NET_IF_CHECKSUM_IPV6_TCP	Interface supports checksum calculation for TCP payload in IPv6.
NET_IF_CHECKSUM_IPV6_UDP	Interface supports checksum calculation for UDP payload in IPv6.
NET_IF_CHECKSUM_IPV6_ICMP	Interface supports checksum calculation for ICMP6 payload in IPv6.

net_if_flag

enum net_if_flag

#include <zephyr/net/net_if.h>

Network interface flags.

Enumerator
NET_IF_UP	Interface is admin up.
NET_IF_POINTOPOINT	Interface is pointopoint.
NET_IF_PROMISC	Interface is in promiscuous mode.
NET_IF_NO_AUTO_START	Do not start the interface immediately after initialization. This requires that either the device driver or some other entity will need to manually take the interface up when needed. For example for Ethernet this will happen when the driver calls the net_eth_carrier_on() function.
NET_IF_SUSPENDED	Power management specific: interface is being suspended.
NET_IF_FORWARD_MULTICASTS	Flag defines if received multicasts of other interface are forwarded on this interface. This activates multicast routing / forwarding for this interface.
NET_IF_IPV4	Interface supports IPv4.
NET_IF_IPV6	Interface supports IPv6.
NET_IF_RUNNING	Interface up and running (ready to receive and transmit).
NET_IF_LOWER_UP	Driver signals L1 is up.
NET_IF_DORMANT	Driver signals dormant.
NET_IF_IPV6_NO_ND	IPv6 Neighbor Discovery disabled.
NET_IF_IPV6_NO_MLD	IPv6 Multicast Listener Discovery disabled.
NET_IF_NO_TX_LOCK	Mutex locking on TX data path disabled on the interface.

net_if_oper_state

enum net_if_oper_state

#include <zephyr/net/net_if.h>

Network interface operational status (RFC 2863).

Enumerator
NET_IF_OPER_UNKNOWN	Initial (unknown) value.
NET_IF_OPER_NOTPRESENT	Hardware missing.
NET_IF_OPER_DOWN	Interface is down.
NET_IF_OPER_LOWERLAYERDOWN	Lower layer interface is down.
NET_IF_OPER_TESTING	Training mode.
NET_IF_OPER_DORMANT	Waiting external action.
NET_IF_OPER_UP	Interface is up.

Function Documentation

net_if_addr_set_lf()

static void net_if_addr_set_lf ( struct net_if_addr * ifaddr, bool is_infinite )

inlinestatic

#include <zephyr/net/net_if.h>

Set the infinite status of the network interface address.

Parameters

ifaddr	IP address for network interface
is_infinite	Infinite status

net_if_are_pending_tx_packets()

static bool net_if_are_pending_tx_packets ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if there are any pending TX network data for a given network interface.

Parameters

iface

Pointer to network interface

Returns

True if there are pending TX network packets for this network interface, False otherwise.

net_if_call_link_cb()

void net_if_call_link_cb	(	struct net_if *	iface,
		struct net_linkaddr *	lladdr,
		int	status )

#include <zephyr/net/net_if.h>

Call a link callback function.

Parameters

iface	Network interface.
lladdr	Destination link layer address
status	0 is ok, < 0 error

net_if_carrier_off()

void net_if_carrier_off

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Underlying network device has lost the carrier (cable disconnected).

The function should be used by the respective network device driver or L2 implementation to update its state on a network interface.

Parameters

iface

Pointer to network interface

net_if_carrier_on()

void net_if_carrier_on

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Underlying network device has detected the carrier (cable connected).

The function should be used by the respective network device driver or L2 implementation to update its state on a network interface.

Parameters

iface

Pointer to network interface

net_if_config_get()

static struct net_if_config * net_if_config_get ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get network interface IP config.

Parameters

iface

Interface to use.

Returns

NULL if not found or pointer to correct config settings.

net_if_config_ipv4_get()

int net_if_config_ipv4_get	(	struct net_if *	iface,
		struct net_if_ipv4 **	ipv4 )

#include <zephyr/net/net_if.h>

Allocate network interface IPv4 config.

This function will allocate new IPv4 config.

Parameters

iface	Interface to use.
ipv4	Pointer to allocated IPv4 struct is returned to caller.

Returns

0 if ok, <0 if error

net_if_config_ipv4_put()

int net_if_config_ipv4_put

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Release network interface IPv4 config.

Parameters

iface

Interface to use.

Returns

0 if ok, <0 if error

net_if_config_ipv6_get()

int net_if_config_ipv6_get	(	struct net_if *	iface,
		struct net_if_ipv6 **	ipv6 )

#include <zephyr/net/net_if.h>

Allocate network interface IPv6 config.

This function will allocate new IPv6 config.

Parameters

iface	Interface to use.
ipv6	Pointer to allocated IPv6 struct is returned to caller.

Returns

0 if ok, <0 if error

net_if_config_ipv6_put()

int net_if_config_ipv6_put

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Release network interface IPv6 config.

Parameters

iface

Interface to use.

Returns

0 if ok, <0 if error

net_if_dormant_off()

void net_if_dormant_off

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Mark interface as not dormant.

The function should be used by the respective network device driver or L2 implementation to update its state on a network interface.

Parameters

iface

Pointer to network interface

net_if_dormant_on()

void net_if_dormant_on

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Mark interface as dormant.

Dormant state indicates that the interface is not ready to pass packets yet, but is waiting for some event (for example Wi-Fi network association).

The function should be used by the respective network device driver or L2 implementation to update its state on a network interface.

Parameters

iface

Pointer to network interface

net_if_down()

int net_if_down

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Bring interface down.

Parameters

iface

Pointer to network interface

Returns

0 on success

net_if_flag_clear()

static void net_if_flag_clear ( struct net_if * iface, enum net_if_flag value )

inlinestatic

#include <zephyr/net/net_if.h>

Clear a value in network interface flags.

Parameters

iface	Pointer to network interface
value	Flag value

net_if_flag_is_set()

static bool net_if_flag_is_set ( struct net_if * iface, enum net_if_flag value )

inlinestatic

#include <zephyr/net/net_if.h>

Check if a value in network interface flags is set.

Parameters

iface	Pointer to network interface
value	Flag value

Returns

True if the value is set, false otherwise

net_if_flag_set()

static void net_if_flag_set ( struct net_if * iface, enum net_if_flag value )

inlinestatic

#include <zephyr/net/net_if.h>

Set a value in network interface flags.

Parameters

iface	Pointer to network interface
value	Flag value

net_if_flag_test_and_clear()

static bool net_if_flag_test_and_clear ( struct net_if * iface, enum net_if_flag value )

inlinestatic

#include <zephyr/net/net_if.h>

Test and clear a value in network interface flags.

Parameters

iface	Pointer to network interface
value	Flag value

Returns

true if the bit was set, false if it wasn't.

net_if_flag_test_and_set()

static bool net_if_flag_test_and_set ( struct net_if * iface, enum net_if_flag value )

inlinestatic

#include <zephyr/net/net_if.h>

Test and set a value in network interface flags.

Parameters

iface	Pointer to network interface
value	Flag value

Returns

true if the bit was set, false if it wasn't.

net_if_foreach()

void net_if_foreach	(	net_if_cb_t	cb,
		void *	user_data )

#include <zephyr/net/net_if.h>

Go through all the network interfaces and call callback for each interface.

Parameters

cb	User-supplied callback function to call
user_data	User specified data

net_if_get_by_iface()

int net_if_get_by_iface

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Get interface index according to pointer.

Parameters

iface

Pointer to network interface

Returns

Interface index

net_if_get_by_index()

struct net_if * net_if_get_by_index

(

int

index

)

#include <zephyr/net/net_if.h>

Get interface according to index.

This is a syscall only to provide access to the object for purposes of assigning permissions.

Parameters

index

Interface index

Returns

Pointer to interface or NULL if not found.

net_if_get_by_link_addr()

struct net_if * net_if_get_by_link_addr

(

struct net_linkaddr *

ll_addr

)

#include <zephyr/net/net_if.h>

Get an interface according to link layer address.

Parameters

ll_addr

Link layer address.

Returns

Network interface or NULL if not found.

net_if_get_by_name()

int net_if_get_by_name

(

const char *

name

)

#include <zephyr/net/net_if.h>

Get interface index according to its name.

Parameters

name	Name of the network interface

Returns

Interface index

net_if_get_config()

static struct net_if_config * net_if_get_config ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Return network configuration for this network interface.

Parameters

iface

Pointer to a network interface structure

Returns

Pointer to configuration

net_if_get_default()

struct net_if * net_if_get_default

(

void

)

#include <zephyr/net/net_if.h>

Get the default network interface.

Returns

Default interface or NULL if no interfaces are configured.

net_if_get_device()

static const struct device * net_if_get_device ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get an network interface's device.

Parameters

iface

Pointer to a network interface structure

Returns

a pointer to the device driver instance

net_if_get_first_by_type()

struct net_if * net_if_get_first_by_type

(

const struct net_l2 *

l2

)

#include <zephyr/net/net_if.h>

Get the first network interface according to its type.

Parameters

l2	Layer 2 type of the network interface.

Returns

First network interface of a given type or NULL if no such interfaces was found.

net_if_get_first_up()

struct net_if * net_if_get_first_up

(

void

)

#include <zephyr/net/net_if.h>

Get the first network interface which is up.

Returns

First network interface which is up or NULL if all interfaces are down.

net_if_get_first_wifi()

struct net_if * net_if_get_first_wifi

(

void

)

#include <zephyr/net/net_if.h>

Get first Wi-Fi network interface.

Returns

Pointer to network interface, NULL if not found.

net_if_get_link_addr()

static struct net_linkaddr * net_if_get_link_addr ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get an network interface's link address.

Parameters

iface

Pointer to a network interface structure

Returns

a pointer to the network link address

net_if_get_mtu()

static uint16_t net_if_get_mtu ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get an network interface's MTU.

Parameters

iface

Pointer to a network interface structure

Returns

the MTU

net_if_get_name()

int net_if_get_name	(	struct net_if *	iface,
		char *	buf,
		int	len )

#include <zephyr/net/net_if.h>

Get network interface name.

If interface name support is not enabled, empty string is returned.

Parameters

iface	Pointer to network interface
buf	User supplied buffer
len	Length of the user supplied buffer

Returns

Length of the interface name copied to buf, -EINVAL if invalid parameters, -ERANGE if name cannot be copied to the user supplied buffer, -ENOTSUP if interface name support is disabled,

net_if_get_wifi_sap()

struct net_if * net_if_get_wifi_sap

(

void

)

#include <zephyr/net/net_if.h>

Get first Wi-Fi network Soft-AP interface.

Returns

Pointer to network interface, NULL if not found.

net_if_get_wifi_sta()

struct net_if * net_if_get_wifi_sta

(

void

)

#include <zephyr/net/net_if.h>

Get Wi-Fi network station interface.

Returns

Pointer to network interface, NULL if not found.

net_if_ipv4_addr_add()

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 )

#include <zephyr/net/net_if.h>

Add a IPv4 address to an interface.

Parameters

iface	Network interface
addr	IPv4 address
addr_type	IPv4 address type
vlifetime	Validity time for this address

Returns

Pointer to interface address, NULL if cannot be added

net_if_ipv4_addr_add_by_index()

bool net_if_ipv4_addr_add_by_index	(	int	index,
		struct in_addr *	addr,
		enum net_addr_type	addr_type,
		uint32_t	vlifetime )

#include <zephyr/net/net_if.h>

Add a IPv4 address to an interface by network interface index.

Parameters

index	Network interface index
addr	IPv4 address
addr_type	IPv4 address type
vlifetime	Validity time for this address

Returns

True if ok, false if the address could not be added

net_if_ipv4_addr_foreach()

void net_if_ipv4_addr_foreach	(	struct net_if *	iface,
		net_if_ip_addr_cb_t	cb,
		void *	user_data )

#include <zephyr/net/net_if.h>

Go through all IPv4 addresses on a network interface and call callback for each used address.

Parameters

iface	Pointer to the network interface
cb	User-supplied callback function to call
user_data	User specified data

net_if_ipv4_addr_lookup()

struct net_if_addr * net_if_ipv4_addr_lookup	(	const struct in_addr *	addr,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Check if this IPv4 address belongs to one of the interfaces.

Parameters

addr	IPv4 address
iface	Interface is returned

Returns

Pointer to interface address, NULL if not found.

net_if_ipv4_addr_lookup_by_index()

int net_if_ipv4_addr_lookup_by_index

(

const struct in_addr *

addr

)

#include <zephyr/net/net_if.h>

Check if this IPv4 address belongs to one of the interface indices.

Parameters

addr	IPv4 address

Returns

>0 if address was found in given network interface index, all other values mean address was not found

net_if_ipv4_addr_mask_cmp()

bool net_if_ipv4_addr_mask_cmp	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Check if the given IPv4 address belongs to local subnet.

Parameters

iface	Interface to use. Must be a valid pointer to an interface.
addr	IPv4 address

Returns

True if address is part of local subnet, false otherwise.

net_if_ipv4_addr_rm()

bool net_if_ipv4_addr_rm	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Remove a IPv4 address from an interface.

Parameters

iface	Network interface
addr	IPv4 address

Returns

True if successfully removed, false otherwise

net_if_ipv4_addr_rm_by_index()

bool net_if_ipv4_addr_rm_by_index	(	int	index,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Remove a IPv4 address from an interface by interface index.

Parameters

index	Network interface index
addr	IPv4 address

Returns

True if successfully removed, false otherwise

net_if_ipv4_get_global_addr()

struct in_addr * net_if_ipv4_get_global_addr	(	struct net_if *	iface,
		enum net_addr_state	addr_state )

#include <zephyr/net/net_if.h>

Get a IPv4 global address in a given state.

Parameters

iface	Interface to use. Must be a valid pointer to an interface.
addr_state	IPv4 address state (preferred, tentative, deprecated)

Returns

Pointer to link local IPv4 address, NULL if no proper IPv4 address could be found.

net_if_ipv4_get_gw()

struct in_addr net_if_ipv4_get_gw

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Get IPv4 gateway of an interface.

Parameters

iface

Interface to use.

Returns

The gateway set on the interface, unspecified address if not found.

net_if_ipv4_get_ll()

struct in_addr * net_if_ipv4_get_ll	(	struct net_if *	iface,
		enum net_addr_state	addr_state )

#include <zephyr/net/net_if.h>

Get a IPv4 link local address in a given state.

Parameters

iface	Interface to use. Must be a valid pointer to an interface.
addr_state	IPv4 address state (preferred, tentative, deprecated)

Returns

Pointer to link local IPv4 address, NULL if no proper IPv4 address could be found.

net_if_ipv4_get_mcast_ttl()

uint8_t net_if_ipv4_get_mcast_ttl

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Get IPv4 multicast time-to-live value specified for a given interface.

Parameters

iface

Network interface

Returns

Time-to-live

net_if_ipv4_get_netmask()

struct in_addr net_if_ipv4_get_netmask

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Get IPv4 netmask of an interface.

Deprecated

Use net_if_ipv4_get_netmask_by_addr() instead.

Parameters

iface

Interface to use.

Returns

The netmask set on the interface, unspecified address if not found.

net_if_ipv4_get_netmask_by_addr()

struct in_addr net_if_ipv4_get_netmask_by_addr	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Get IPv4 netmask related to an address of an interface.

Parameters

iface	Interface to use.
addr	IPv4 address to check.

Returns

The netmask set on the interface related to the give address, unspecified address if not found.

net_if_ipv4_get_ttl()

uint8_t net_if_ipv4_get_ttl

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Get IPv4 time-to-live value specified for a given interface.

Parameters

iface

Network interface

Returns

Time-to-live

net_if_ipv4_is_addr_bcast()

bool net_if_ipv4_is_addr_bcast	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Check if the given IPv4 address is a broadcast address.

Parameters

iface	Interface to use. Must be a valid pointer to an interface.
addr	IPv4 address, this should be in network byte order

Returns

True if address is a broadcast address, false otherwise.

net_if_ipv4_maddr_add()

struct net_if_mcast_addr * net_if_ipv4_maddr_add	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Add a IPv4 multicast address to an interface.

Parameters

iface	Network interface
addr	IPv4 multicast address

Returns

Pointer to interface multicast address, NULL if cannot be added

net_if_ipv4_maddr_foreach()

void net_if_ipv4_maddr_foreach	(	struct net_if *	iface,
		net_if_ip_maddr_cb_t	cb,
		void *	user_data )

#include <zephyr/net/net_if.h>

Go through all IPv4 multicast addresses on a network interface and call callback for each used address.

Parameters

iface	Pointer to the network interface
cb	User-supplied callback function to call
user_data	User specified data

net_if_ipv4_maddr_is_joined()

static bool net_if_ipv4_maddr_is_joined ( struct net_if_mcast_addr * addr )

inlinestatic

#include <zephyr/net/net_if.h>

Check if given multicast address is joined or not.

Parameters

addr	IPv4 multicast address

Returns

True if address is joined, False otherwise.

net_if_ipv4_maddr_join()

void net_if_ipv4_maddr_join	(	struct net_if *	iface,
		struct net_if_mcast_addr *	addr )

#include <zephyr/net/net_if.h>

Mark a given multicast address to be joined.

Parameters

iface	Network interface the address belongs to
addr	IPv4 multicast address

net_if_ipv4_maddr_leave()

void net_if_ipv4_maddr_leave	(	struct net_if *	iface,
		struct net_if_mcast_addr *	addr )

#include <zephyr/net/net_if.h>

Mark a given multicast address to be left.

Parameters

iface	Network interface the address belongs to
addr	IPv4 multicast address

net_if_ipv4_maddr_lookup()

struct net_if_mcast_addr * net_if_ipv4_maddr_lookup	(	const struct in_addr *	addr,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Check if this IPv4 multicast address belongs to a specific interface or one of the interfaces.

Parameters

addr	IPv4 address
iface	If *iface is null, then pointer to interface is returned, otherwise the *iface value needs to be matched.

Returns

Pointer to interface multicast address, NULL if not found.

net_if_ipv4_maddr_rm()

bool net_if_ipv4_maddr_rm	(	struct net_if *	iface,
		const struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Remove an IPv4 multicast address from an interface.

Parameters

iface	Network interface
addr	IPv4 multicast address

Returns

True if successfully removed, false otherwise

net_if_ipv4_router_add()

struct net_if_router * net_if_ipv4_router_add	(	struct net_if *	iface,
		struct in_addr *	addr,
		bool	is_default,
		uint16_t	router_lifetime )

#include <zephyr/net/net_if.h>

Add IPv4 router to the system.

Parameters

iface	Network interface
addr	IPv4 address
is_default	Is this router the default one
router_lifetime	Lifetime of the router

Returns

Pointer to router information, NULL if could not be added

net_if_ipv4_router_find_default()

struct net_if_router * net_if_ipv4_router_find_default	(	struct net_if *	iface,
		struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Find default router for this IPv4 address.

Parameters

iface	Network interface. This can be NULL in which case we go through all the network interfaces to find a suitable router.
addr	IPv4 address

Returns

Pointer to router information, NULL if cannot be found

net_if_ipv4_router_lookup()

struct net_if_router * net_if_ipv4_router_lookup	(	struct net_if *	iface,
		struct in_addr *	addr )

#include <zephyr/net/net_if.h>

Check if IPv4 address is one of the routers configured in the system.

Parameters

iface	Network interface
addr	IPv4 address

Returns

Pointer to router information, NULL if cannot be found

net_if_ipv4_router_rm()

bool net_if_ipv4_router_rm

(

struct net_if_router *

router

)

#include <zephyr/net/net_if.h>

Remove IPv4 router from the system.

Parameters

router

Router information.

Returns

True if successfully removed, false otherwise

net_if_ipv4_select_src_addr()

static const struct in_addr * net_if_ipv4_select_src_addr ( struct net_if * iface, const struct in_addr * dst )

inlinestatic

#include <zephyr/net/net_if.h>

Get a IPv4 source address that should be used when sending network data to destination.

Parameters

iface	Interface to use when sending the packet. If the interface is not known, then NULL can be given.
dst	IPv4 destination address

Returns

Pointer to IPv4 address to use, NULL if no IPv4 address could be found.

net_if_ipv4_select_src_iface()

static struct net_if * net_if_ipv4_select_src_iface ( const struct in_addr * dst )

inlinestatic

#include <zephyr/net/net_if.h>

Get a network interface that should be used when sending IPv4 network data to destination.

Parameters

dst	IPv4 destination address

Returns

Pointer to network interface to use, NULL if no suitable interface could be found.

net_if_ipv4_set_gw()

void net_if_ipv4_set_gw	(	struct net_if *	iface,
		const struct in_addr *	gw )

#include <zephyr/net/net_if.h>

Set IPv4 gateway for an interface.

Parameters

iface	Interface to use.
gw	IPv4 address of an gateway

net_if_ipv4_set_gw_by_index()

bool net_if_ipv4_set_gw_by_index	(	int	index,
		const struct in_addr *	gw )

#include <zephyr/net/net_if.h>

Set IPv4 gateway for an interface index.

Parameters

index	Network interface index
gw	IPv4 address of an gateway

Returns

True if gateway was added, false otherwise.

net_if_ipv4_set_mcast_ttl()

void net_if_ipv4_set_mcast_ttl	(	struct net_if *	iface,
		uint8_t	ttl )

#include <zephyr/net/net_if.h>

Set IPv4 multicast time-to-live value specified to a given interface.

Parameters

iface	Network interface
ttl	Time-to-live value

net_if_ipv4_set_netmask()

void net_if_ipv4_set_netmask	(	struct net_if *	iface,
		const struct in_addr *	netmask )

#include <zephyr/net/net_if.h>

Set IPv4 netmask for an interface.

Deprecated

Use net_if_ipv4_set_netmask_by_addr() instead.

Parameters

iface	Interface to use.
netmask	IPv4 netmask

net_if_ipv4_set_netmask_by_addr()

bool net_if_ipv4_set_netmask_by_addr	(	struct net_if *	iface,
		const struct in_addr *	addr,
		const struct in_addr *	netmask )

#include <zephyr/net/net_if.h>

Set IPv4 netmask for an interface index for a given address.

Parameters

iface	Network interface
addr	IPv4 address related to this netmask
netmask	IPv4 netmask

Returns

True if netmask was added, false otherwise.

net_if_ipv4_set_netmask_by_addr_by_index()

bool net_if_ipv4_set_netmask_by_addr_by_index	(	int	index,
		const struct in_addr *	addr,
		const struct in_addr *	netmask )

#include <zephyr/net/net_if.h>

Set IPv4 netmask for an interface index for a given address.

Parameters

index	Network interface index
addr	IPv4 address related to this netmask
netmask	IPv4 netmask

Returns

True if netmask was added, false otherwise.

net_if_ipv4_set_netmask_by_index()

bool net_if_ipv4_set_netmask_by_index	(	int	index,
		const struct in_addr *	netmask )

#include <zephyr/net/net_if.h>

Set IPv4 netmask for an interface index.

Deprecated

Use net_if_ipv4_set_netmask_by_addr() instead.

Parameters

index	Network interface index
netmask	IPv4 netmask

Returns

True if netmask was added, false otherwise.

net_if_ipv4_set_ttl()

void net_if_ipv4_set_ttl	(	struct net_if *	iface,
		uint8_t	ttl )

#include <zephyr/net/net_if.h>

Set IPv4 time-to-live value specified to a given interface.

Parameters

iface	Network interface
ttl	Time-to-live value

net_if_ipv6_addr_add()

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 )

#include <zephyr/net/net_if.h>

Add a IPv6 address to an interface.

Parameters

iface	Network interface
addr	IPv6 address
addr_type	IPv6 address type
vlifetime	Validity time for this address

Returns

Pointer to interface address, NULL if cannot be added

net_if_ipv6_addr_add_by_index()

bool net_if_ipv6_addr_add_by_index	(	int	index,
		struct in6_addr *	addr,
		enum net_addr_type	addr_type,
		uint32_t	vlifetime )

#include <zephyr/net/net_if.h>

Add a IPv6 address to an interface by index.

Parameters

index	Network interface index
addr	IPv6 address
addr_type	IPv6 address type
vlifetime	Validity time for this address

Returns

True if ok, false if address could not be added

net_if_ipv6_addr_foreach()

void net_if_ipv6_addr_foreach	(	struct net_if *	iface,
		net_if_ip_addr_cb_t	cb,
		void *	user_data )

#include <zephyr/net/net_if.h>

Go through all IPv6 addresses on a network interface and call callback for each used address.

Parameters

iface	Pointer to the network interface
cb	User-supplied callback function to call
user_data	User specified data

net_if_ipv6_addr_lookup()

struct net_if_addr * net_if_ipv6_addr_lookup	(	const struct in6_addr *	addr,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Check if this IPv6 address belongs to one of the interfaces.

Parameters

addr	IPv6 address
iface	Pointer to interface is returned

Returns

Pointer to interface address, NULL if not found.

net_if_ipv6_addr_lookup_by_iface()

struct net_if_addr * net_if_ipv6_addr_lookup_by_iface	(	struct net_if *	iface,
		struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Check if this IPv6 address belongs to this specific interfaces.

Parameters

iface	Network interface
addr	IPv6 address

Returns

Pointer to interface address, NULL if not found.

net_if_ipv6_addr_lookup_by_index()

int net_if_ipv6_addr_lookup_by_index

(

const struct in6_addr *

addr

)

#include <zephyr/net/net_if.h>

Check if this IPv6 address belongs to one of the interface indices.

Parameters

addr	IPv6 address

Returns

>0 if address was found in given network interface index, all other values mean address was not found

net_if_ipv6_addr_onlink()

bool net_if_ipv6_addr_onlink	(	struct net_if **	iface,
		struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Check if this IPv6 address is part of the subnet of our network interface.

Parameters

iface	Network interface. This is returned to the caller. The iface can be NULL in which case we check all the interfaces.
addr	IPv6 address

Returns

True if address is part of our subnet, false otherwise

net_if_ipv6_addr_rm()

bool net_if_ipv6_addr_rm	(	struct net_if *	iface,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Remove an IPv6 address from an interface.

Parameters

iface	Network interface
addr	IPv6 address

Returns

True if successfully removed, false otherwise

net_if_ipv6_addr_rm_by_index()

bool net_if_ipv6_addr_rm_by_index	(	int	index,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Remove an IPv6 address from an interface by index.

Parameters

index	Network interface index
addr	IPv6 address

Returns

True if successfully removed, false otherwise

net_if_ipv6_addr_update_lifetime()

void net_if_ipv6_addr_update_lifetime	(	struct net_if_addr *	ifaddr,
		uint32_t	vlifetime )

#include <zephyr/net/net_if.h>

Update validity lifetime time of an IPv6 address.

Parameters

ifaddr	Network IPv6 address
vlifetime	Validity time for this address

net_if_ipv6_calc_reachable_time()

uint32_t net_if_ipv6_calc_reachable_time

(

struct net_if_ipv6 *

ipv6

)

#include <zephyr/net/net_if.h>

Calculate next reachable time value for IPv6 reachable time.

Parameters

ipv6	IPv6 address configuration

Returns

Reachable time

net_if_ipv6_dad_failed()

void net_if_ipv6_dad_failed	(	struct net_if *	iface,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Stop IPv6 Duplicate Address Detection (DAD) procedure if we find out that our IPv6 address is already in use.

Parameters

iface	Interface where the DAD was running.
addr	IPv6 address that failed DAD

net_if_ipv6_get_global_addr()

struct in6_addr * net_if_ipv6_get_global_addr	(	enum net_addr_state	state,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Return global IPv6 address from the first interface that has a global IPv6 address matching the given state.

Parameters

state	IPv6 address state (ANY, TENTATIVE, PREFERRED, DEPRECATED)
iface	Caller can give an interface to check. If iface is set to NULL, then all the interfaces are checked. Pointer to interface where the IPv6 address is defined is returned to the caller.

Returns

Pointer to IPv6 address, NULL if not found.

net_if_ipv6_get_hop_limit()

static uint8_t net_if_ipv6_get_hop_limit ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get IPv6 hop limit specified for a given interface.

This is the default value but can be overridden by the user.

Parameters

iface

Network interface

Returns

Hop limit

net_if_ipv6_get_ll()

struct in6_addr * net_if_ipv6_get_ll	(	struct net_if *	iface,
		enum net_addr_state	addr_state )

#include <zephyr/net/net_if.h>

Get a IPv6 link local address in a given state.

Parameters

iface	Interface to use. Must be a valid pointer to an interface.
addr_state	IPv6 address state (preferred, tentative, deprecated)

Returns

Pointer to link local IPv6 address, NULL if no proper IPv6 address could be found.

net_if_ipv6_get_ll_addr()

struct in6_addr * net_if_ipv6_get_ll_addr	(	enum net_addr_state	state,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Return link local IPv6 address from the first interface that has a link local address matching give state.

Parameters

state	IPv6 address state (ANY, TENTATIVE, PREFERRED, DEPRECATED)
iface	Pointer to interface is returned

Returns

Pointer to IPv6 address, NULL if not found.

net_if_ipv6_get_mcast_hop_limit()

static uint8_t net_if_ipv6_get_mcast_hop_limit ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get IPv6 multicast hop limit specified for a given interface.

This is the default value but can be overridden by the user.

Parameters

iface

Network interface

Returns

Hop limit

net_if_ipv6_get_reachable_time()

static uint32_t net_if_ipv6_get_reachable_time ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get IPv6 reachable timeout specified for a given interface.

Parameters

iface

Network interface

Returns

Reachable timeout

net_if_ipv6_get_retrans_timer()

static uint32_t net_if_ipv6_get_retrans_timer ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get IPv6 retransmit timer specified for a given interface.

Parameters

iface

Network interface

Returns

Retransmit timer

net_if_ipv6_maddr_add()

struct net_if_mcast_addr * net_if_ipv6_maddr_add	(	struct net_if *	iface,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Add a IPv6 multicast address to an interface.

Parameters

iface	Network interface
addr	IPv6 multicast address

Returns

Pointer to interface multicast address, NULL if cannot be added

net_if_ipv6_maddr_foreach()

void net_if_ipv6_maddr_foreach	(	struct net_if *	iface,
		net_if_ip_maddr_cb_t	cb,
		void *	user_data )

#include <zephyr/net/net_if.h>

Go through all IPv6 multicast addresses on a network interface and call callback for each used address.

Parameters

iface	Pointer to the network interface
cb	User-supplied callback function to call
user_data	User specified data

net_if_ipv6_maddr_is_joined()

static bool net_if_ipv6_maddr_is_joined ( struct net_if_mcast_addr * addr )

inlinestatic

#include <zephyr/net/net_if.h>

Check if given multicast address is joined or not.

Parameters

addr	IPv6 multicast address

Returns

True if address is joined, False otherwise.

net_if_ipv6_maddr_join()

void net_if_ipv6_maddr_join	(	struct net_if *	iface,
		struct net_if_mcast_addr *	addr )

#include <zephyr/net/net_if.h>

Mark a given multicast address to be joined.

Parameters

iface	Network interface the address belongs to
addr	IPv6 multicast address

net_if_ipv6_maddr_leave()

void net_if_ipv6_maddr_leave	(	struct net_if *	iface,
		struct net_if_mcast_addr *	addr )

#include <zephyr/net/net_if.h>

Mark a given multicast address to be left.

Parameters

iface	Network interface the address belongs to
addr	IPv6 multicast address

net_if_ipv6_maddr_lookup()

struct net_if_mcast_addr * net_if_ipv6_maddr_lookup	(	const struct in6_addr *	addr,
		struct net_if **	iface )

#include <zephyr/net/net_if.h>

Check if this IPv6 multicast address belongs to a specific interface or one of the interfaces.

Parameters

addr	IPv6 address
iface	If *iface is null, then pointer to interface is returned, otherwise the *iface value needs to be matched.

Returns

Pointer to interface multicast address, NULL if not found.

net_if_ipv6_maddr_rm()

bool net_if_ipv6_maddr_rm	(	struct net_if *	iface,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Remove an IPv6 multicast address from an interface.

Parameters

iface	Network interface
addr	IPv6 multicast address

Returns

True if successfully removed, false otherwise

net_if_ipv6_prefix_add()

struct net_if_ipv6_prefix * net_if_ipv6_prefix_add	(	struct net_if *	iface,
		struct in6_addr *	prefix,
		uint8_t	len,
		uint32_t	lifetime )

#include <zephyr/net/net_if.h>

Add a IPv6 prefix to an network interface.

Parameters

iface	Network interface
prefix	IPv6 address
len	Prefix length
lifetime	Prefix lifetime in seconds

Returns

Pointer to prefix, NULL if the prefix was not added.

net_if_ipv6_prefix_get()

struct net_if_ipv6_prefix * net_if_ipv6_prefix_get	(	struct net_if *	iface,
		const struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Return prefix that corresponds to this IPv6 address.

Parameters

iface	Network interface
addr	IPv6 address

Returns

Pointer to prefix, NULL if not found.

net_if_ipv6_prefix_lookup()

struct net_if_ipv6_prefix * net_if_ipv6_prefix_lookup	(	struct net_if *	iface,
		struct in6_addr *	addr,
		uint8_t	len )

#include <zephyr/net/net_if.h>

Check if this IPv6 prefix belongs to this interface.

Parameters

iface	Network interface
addr	IPv6 address
len	Prefix length

Returns

Pointer to prefix, NULL if not found.

net_if_ipv6_prefix_rm()

bool net_if_ipv6_prefix_rm	(	struct net_if *	iface,
		struct in6_addr *	addr,
		uint8_t	len )

#include <zephyr/net/net_if.h>

Remove an IPv6 prefix from an interface.

Parameters

iface	Network interface
addr	IPv6 prefix address
len	Prefix length

Returns

True if successfully removed, false otherwise

net_if_ipv6_prefix_set_lf()

static void net_if_ipv6_prefix_set_lf ( struct net_if_ipv6_prefix * prefix, bool is_infinite )

inlinestatic

#include <zephyr/net/net_if.h>

Set the infinite status of the prefix.

Parameters

prefix	IPv6 address
is_infinite	Infinite status

net_if_ipv6_prefix_set_timer()

void net_if_ipv6_prefix_set_timer	(	struct net_if_ipv6_prefix *	prefix,
		uint32_t	lifetime )

#include <zephyr/net/net_if.h>

Set the prefix lifetime timer.

Parameters

prefix	IPv6 address
lifetime	Prefix lifetime in seconds

net_if_ipv6_prefix_unset_timer()

void net_if_ipv6_prefix_unset_timer

(

struct net_if_ipv6_prefix *

prefix

)

#include <zephyr/net/net_if.h>

Unset the prefix lifetime timer.

Parameters

prefix

IPv6 address

net_if_ipv6_router_add()

struct net_if_router * net_if_ipv6_router_add	(	struct net_if *	iface,
		struct in6_addr *	addr,
		uint16_t	router_lifetime )

#include <zephyr/net/net_if.h>

Add IPv6 router to the system.

Parameters

iface	Network interface
addr	IPv6 address
router_lifetime	Lifetime of the router

Returns

Pointer to router information, NULL if could not be added

net_if_ipv6_router_find_default()

struct net_if_router * net_if_ipv6_router_find_default	(	struct net_if *	iface,
		struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Find default router for this IPv6 address.

Parameters

iface	Network interface. This can be NULL in which case we go through all the network interfaces to find a suitable router.
addr	IPv6 address

Returns

Pointer to router information, NULL if cannot be found

net_if_ipv6_router_lookup()

struct net_if_router * net_if_ipv6_router_lookup	(	struct net_if *	iface,
		struct in6_addr *	addr )

#include <zephyr/net/net_if.h>

Check if IPv6 address is one of the routers configured in the system.

Parameters

iface	Network interface
addr	IPv6 address

Returns

Pointer to router information, NULL if cannot be found

net_if_ipv6_router_rm()

bool net_if_ipv6_router_rm

(

struct net_if_router *

router

)

#include <zephyr/net/net_if.h>

Remove IPv6 router from the system.

Parameters

router

Router information.

Returns

True if successfully removed, false otherwise

net_if_ipv6_router_update_lifetime()

void net_if_ipv6_router_update_lifetime	(	struct net_if_router *	router,
		uint16_t	lifetime )

#include <zephyr/net/net_if.h>

Update validity lifetime time of a router.

Parameters

router	Network IPv6 address
lifetime	Lifetime of this router.

net_if_ipv6_select_src_addr()

static const struct in6_addr * net_if_ipv6_select_src_addr ( struct net_if * iface, const struct in6_addr * dst )

inlinestatic

#include <zephyr/net/net_if.h>

Get a IPv6 source address that should be used when sending network data to destination.

Parameters

iface	Interface that was used when packet was received. If the interface is not known, then NULL can be given.
dst	IPv6 destination address

Returns

Pointer to IPv6 address to use, NULL if no IPv6 address could be found.

net_if_ipv6_select_src_addr_hint()

static const struct in6_addr * net_if_ipv6_select_src_addr_hint ( struct net_if * iface, const struct in6_addr * dst, int flags )

inlinestatic

#include <zephyr/net/net_if.h>

Get a IPv6 source address that should be used when sending network data to destination.

Use a hint set to the socket to select the proper address.

Parameters

iface	Interface that was used when packet was received. If the interface is not known, then NULL can be given.
dst	IPv6 destination address
flags	Hint from the related socket. See RFC 5014 for value details.

Returns

Pointer to IPv6 address to use, NULL if no IPv6 address could be found.

net_if_ipv6_select_src_iface()

static struct net_if * net_if_ipv6_select_src_iface ( const struct in6_addr * dst )

inlinestatic

#include <zephyr/net/net_if.h>

Get a network interface that should be used when sending IPv6 network data to destination.

Parameters

dst	IPv6 destination address

Returns

Pointer to network interface to use, NULL if no suitable interface could be found.

net_if_ipv6_set_base_reachable_time()

static void net_if_ipv6_set_base_reachable_time ( struct net_if * iface, uint32_t reachable_time )

inlinestatic

#include <zephyr/net/net_if.h>

Set IPv6 reachable time for a given interface.

Parameters

iface	Network interface
reachable_time	New reachable time

net_if_ipv6_set_hop_limit()

static void net_if_ipv6_set_hop_limit ( struct net_if * iface, uint8_t hop_limit )

inlinestatic

#include <zephyr/net/net_if.h>

Set the default IPv6 hop limit of a given interface.

Parameters

iface	Network interface
hop_limit	New hop limit

net_if_ipv6_set_mcast_hop_limit()

static void net_if_ipv6_set_mcast_hop_limit ( struct net_if * iface, uint8_t hop_limit )

inlinestatic

#include <zephyr/net/net_if.h>

Set the default IPv6 multicast hop limit of a given interface.

Parameters

iface	Network interface
hop_limit	New hop limit

net_if_ipv6_set_reachable_time()

static void net_if_ipv6_set_reachable_time ( struct net_if_ipv6 * ipv6 )

inlinestatic

#include <zephyr/net/net_if.h>

Set IPv6 reachable time for a given interface.

This requires that base reachable time is set for the interface.

Parameters

ipv6	IPv6 address configuration

net_if_ipv6_set_retrans_timer()

static void net_if_ipv6_set_retrans_timer ( struct net_if * iface, uint32_t retrans_timer )

inlinestatic

#include <zephyr/net/net_if.h>

Set IPv6 retransmit timer for a given interface.

Parameters

iface	Network interface
retrans_timer	New retransmit timer

net_if_is_admin_up()

static bool net_if_is_admin_up ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if interface was brought up by the administrator.

Parameters

iface

Pointer to network interface

Returns

True if interface is admin up, false otherwise.

net_if_is_carrier_ok()

static bool net_if_is_carrier_ok ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if carrier is present on network device.

Parameters

iface

Pointer to network interface

Returns

True if carrier is present, false otherwise.

net_if_is_dormant()

static bool net_if_is_dormant ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if the interface is dormant.

Parameters

iface

Pointer to network interface

Returns

True if interface is dormant, false otherwise.

net_if_is_ip_offloaded()

static bool net_if_is_ip_offloaded ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Return the IP offload status.

Parameters

iface

Network interface

Returns

True if IP offloading is active, false otherwise.

net_if_is_offloaded()

bool net_if_is_offloaded

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Return offload status of a given network interface.

Parameters

iface

Network interface

Returns

True if IP or socket offloading is active, false otherwise.

net_if_is_promisc()

static bool net_if_is_promisc ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if promiscuous mode is set or not.

Parameters

iface

Pointer to network interface

Returns

True if interface is in promisc mode, False if interface is not in promiscuous mode.

net_if_is_socket_offloaded()

static bool net_if_is_socket_offloaded ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Return the socket offload status.

Parameters

iface

Network interface

Returns

True if socket offloading is active, false otherwise.

net_if_is_up()

static bool net_if_is_up ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Check if interface is up and running.

Parameters

iface

Pointer to network interface

Returns

True if interface is up, False if it is down.

net_if_is_wifi()

bool net_if_is_wifi

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Check if the network interface supports Wi-Fi.

Parameters

iface

Pointer to network interface

Returns

True if interface supports Wi-Fi, False otherwise.

net_if_l2()

static const struct net_l2 * net_if_l2 ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get a pointer to the interface L2.

Parameters

iface

a valid pointer to a network interface structure

Returns

a pointer to the iface L2

net_if_l2_data()

static void * net_if_l2_data ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get a pointer to the interface L2 private data.

Parameters

iface

a valid pointer to a network interface structure

Returns

a pointer to the iface L2 data

net_if_lookup_by_dev()

struct net_if * net_if_lookup_by_dev

(

const struct device *

dev

)

#include <zephyr/net/net_if.h>

Find an interface from it's related device.

Parameters

dev	A valid struct device pointer to relate with an interface

Returns

a valid struct net_if pointer on success, NULL otherwise

net_if_mcast_mon_register()

void net_if_mcast_mon_register	(	struct net_if_mcast_monitor *	mon,
		struct net_if *	iface,
		net_if_mcast_callback_t	cb )

#include <zephyr/net/net_if.h>

Register a multicast monitor.

Parameters

mon	Monitor handle. This is a pointer to a monitor storage structure which should be allocated by caller, but does not need to be initialized.
iface	Network interface or NULL for all interfaces
cb	Monitor callback

net_if_mcast_mon_unregister()

void net_if_mcast_mon_unregister

(

struct net_if_mcast_monitor *

mon

)

#include <zephyr/net/net_if.h>

Unregister a multicast monitor.

Parameters

mon	Monitor handle

net_if_mcast_monitor()

void net_if_mcast_monitor	(	struct net_if *	iface,
		const struct net_addr *	addr,
		bool	is_joined )

#include <zephyr/net/net_if.h>

Call registered multicast monitors.

Parameters

iface	Network interface
addr	Multicast address
is_joined	Is this multicast address group joined (true) or not (false)

net_if_nbr_reachability_hint()

static void net_if_nbr_reachability_hint ( struct net_if * iface, const struct in6_addr * ipv6_addr )

inlinestatic

#include <zephyr/net/net_if.h>

Provide a reachability hint for IPv6 Neighbor Discovery.

This function is intended for upper-layer protocols to inform the IPv6 Neighbor Discovery process about an active link to a specific neighbor. By signaling a recent "forward progress" event, such as the reception of an ACK, this function can help reduce unnecessary ND traffic as per the guidelines in RFC 4861 (section 7.3).

Parameters

iface	A pointer to the network interface.
ipv6_addr	Pointer to the IPv6 address of the neighbor node.

net_if_need_calc_rx_checksum()

bool net_if_need_calc_rx_checksum	(	struct net_if *	iface,
		enum net_if_checksum_type	chksum_type )

#include <zephyr/net/net_if.h>

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.

Parameters

iface	Network interface
chksum_type	L3 and/or L4 protocol for which to compute checksum

Returns

True if checksum needs to be calculated, false otherwise.

net_if_need_calc_tx_checksum()

bool net_if_need_calc_tx_checksum	(	struct net_if *	iface,
		enum net_if_checksum_type	chksum_type )

#include <zephyr/net/net_if.h>

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.

Parameters

iface	Network interface
chksum_type	L3 and/or L4 protocol for which to compute checksum

Returns

True if checksum needs to be calculated, false otherwise.

net_if_offload()

static struct net_offload * net_if_offload ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Return the IP offload plugin.

Parameters

iface

Network interface

Returns

NULL if there is no offload plugin defined, valid pointer otherwise

net_if_oper_state()

static enum net_if_oper_state net_if_oper_state ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Get an operational state of an interface.

Parameters

iface

Pointer to network interface

Returns

Operational state of an interface

net_if_oper_state_set()

static enum net_if_oper_state net_if_oper_state_set ( struct net_if * iface, enum net_if_oper_state oper_state )

inlinestatic

#include <zephyr/net/net_if.h>

Set an operational state on an interface.

Parameters

iface	Pointer to network interface
oper_state	Operational state to set

Returns

The new operational state of an interface

net_if_queue_tx()

void net_if_queue_tx	(	struct net_if *	iface,
		struct net_pkt *	pkt )

#include <zephyr/net/net_if.h>

Queue a packet to the net interface TX queue.

Parameters

iface	Pointer to a network interface structure
pkt	Pointer to a net packet to queue

net_if_recv_data()

enum net_verdict net_if_recv_data	(	struct net_if *	iface,
		struct net_pkt *	pkt )

#include <zephyr/net/net_if.h>

Input a packet through a net iface.

Parameters

iface	Pointer to a network interface structure
pkt	Pointer to a net packet to input

Returns

verdict about the packet

net_if_register_link_cb()

void net_if_register_link_cb	(	struct net_if_link_cb *	link,
		net_if_link_callback_t	cb )

#include <zephyr/net/net_if.h>

Register a link callback.

Parameters

link	Caller specified handler for the callback.
cb	Callback to register.

net_if_router_ipv4()

static struct in_addr * net_if_router_ipv4 ( struct net_if_router * router )

inlinestatic

#include <zephyr/net/net_if.h>

Get the IPv4 address of the given router.

Parameters

router

a network router

Returns

pointer to the IPv4 address, or NULL if none

net_if_router_ipv6()

static struct in6_addr * net_if_router_ipv6 ( struct net_if_router * router )

inlinestatic

#include <zephyr/net/net_if.h>

Get the IPv6 address of the given router.

Parameters

router

a network router

Returns

pointer to the IPv6 address, or NULL if none

net_if_router_rm()

void net_if_router_rm

(

struct net_if_router *

router

)

#include <zephyr/net/net_if.h>

Remove a router from the system.

Parameters

router

Pointer to existing router

net_if_select_src_iface()

struct net_if * net_if_select_src_iface

(

const struct sockaddr *

dst

)

#include <zephyr/net/net_if.h>

Get a network interface that should be used when sending IPv6 or IPv4 network data to destination.

Parameters

dst	IPv6 or IPv4 destination address

Returns

Pointer to network interface to use. Note that the function will return the default network interface if the best network interface is not found.

net_if_send_data()

enum net_verdict net_if_send_data	(	struct net_if *	iface,
		struct net_pkt *	pkt )

#include <zephyr/net/net_if.h>

Send a packet through a net iface.

Parameters

iface	Pointer to a network interface structure
pkt	Pointer to a net packet to send

return verdict about the packet

net_if_set_default()

void net_if_set_default

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Set the default network interface.

Parameters

iface

New default interface, or NULL to revert to the one set by Kconfig.

net_if_set_link_addr()

static int net_if_set_link_addr ( struct net_if * iface, uint8_t * addr, uint8_t len, enum net_link_type type )

inlinestatic

#include <zephyr/net/net_if.h>

Set a network interface's link address.

Parameters

iface	Pointer to a network interface structure
addr	A pointer to a uint8_t buffer representing the address. The buffer must remain valid throughout interface lifetime.
len	length of the address buffer
type	network bearer type of this link address

Returns

0 on success

net_if_set_mtu()

static void net_if_set_mtu ( struct net_if * iface, uint16_t mtu )

inlinestatic

#include <zephyr/net/net_if.h>

Set an network interface's MTU.

Parameters

iface	Pointer to a network interface structure
mtu	New MTU, note that we store only 16 bit mtu value.

net_if_set_name()

int net_if_set_name	(	struct net_if *	iface,
		const char *	buf )

#include <zephyr/net/net_if.h>

Set network interface name.

Normally this function is not needed to call as the system will automatically assign a name to the network interface.

Parameters

iface	Pointer to network interface
buf	User supplied name

Returns

0 name is set correctly -ENOTSUP interface name support is disabled -EINVAL if invalid parameters are given, -ENAMETOOLONG if name is too long

net_if_set_promisc()

static int net_if_set_promisc ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Set network interface into promiscuous mode.

Note that not all network technologies will support this.

Parameters

iface

Pointer to network interface

Returns

0 on success, <0 if error

net_if_socket_offload()

static net_socket_create_t net_if_socket_offload ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Return the function to create an offloaded socket.

Parameters

iface

Network interface

Returns

NULL if the interface is not socket offloaded, valid pointer otherwise

net_if_socket_offload_set()

static void net_if_socket_offload_set ( struct net_if * iface, net_socket_create_t socket_offload )

inlinestatic

#include <zephyr/net/net_if.h>

Set the function to create an offloaded socket.

Parameters

iface	Network interface
socket_offload	A function to create an offloaded socket

net_if_start_dad()

static void net_if_start_dad ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Start duplicate address detection procedure.

Parameters

iface

Pointer to a network interface structure

net_if_start_rs()

void net_if_start_rs

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Start neighbor discovery and send router solicitation message.

Parameters

iface

Pointer to a network interface structure

net_if_stop_rs()

static void net_if_stop_rs ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Stop neighbor discovery.

Parameters

iface

Pointer to a network interface structure

net_if_unregister_link_cb()

void net_if_unregister_link_cb

(

struct net_if_link_cb *

link

)

#include <zephyr/net/net_if.h>

Unregister a link callback.

Parameters

link	Caller specified handler for the callback.

net_if_unset_promisc()

static void net_if_unset_promisc ( struct net_if * iface )

inlinestatic

#include <zephyr/net/net_if.h>

Set network interface into normal mode.

Parameters

iface

Pointer to network interface

net_if_up()

int net_if_up

(

struct net_if *

iface

)

#include <zephyr/net/net_if.h>

Bring interface up.

Parameters

iface

Pointer to network interface

Returns

0 on success