Ethernet support functions. More...

Topics
	DSA tag protocol
	Definitions for DSA tag protocol.
	Ethernet MII Support Functions
	Ethernet MII (media independent interface) functions.
	IEEE 802.3 management interface
	Definitions for IEEE 802.3 management interface.

Data Structures
struct	net_eth_addr
	Ethernet address. More...
struct	ethernet_qav_param
	Ethernet Qav specific parameters. More...
struct	ethernet_qbv_param
	Ethernet Qbv specific parameters. More...
struct	ethernet_qbu_param
	Ethernet Qbu specific parameters. More...
struct	ethernet_filter
	Ethernet filter description. More...
struct	ethernet_txtime_param
	Ethernet TXTIME specific parameters. More...
struct	ethernet_api
	Ethernet L2 API operations. More...
struct	ethernet_lldp
	Ethernet LLDP specific parameters. More...
struct	net_eth_mac_config
	MAC address configuration. More...

Macros
#define	NET_ETH_ADDR_LEN 6U
	Ethernet MAC address length.
#define	NET_ETH_MINIMAL_FRAME_SIZE 60
	Minimum Ethernet frame size.
#define	NET_ETH_MTU 1500
	Ethernet MTU size.
#define	ETH_NET_DEVICE_INIT(dev_id, name, init_fn, pm, data, config, prio, api, mtu)
	Create an Ethernet network interface and bind it to network device.
#define	ETH_NET_DEVICE_INIT_INSTANCE(dev_id, name, instance, init_fn, pm, data, config, prio, api, mtu)
	Create multiple Ethernet network interfaces and bind them to network devices.
#define	ETH_NET_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, prio, api, mtu)
	Like ETH_NET_DEVICE_INIT but taking metadata from a devicetree.
#define	ETH_NET_DEVICE_DT_INST_DEFINE(inst, ...)
	Like ETH_NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible.
#define	ETH_NET_L3_REGISTER(name, ptype, handler)
	Ethernet L3 protocol register macro.
#define	NET_ETH_MAC_DT_CONFIG_INIT(node_id)
	Initialize the ethernet MAC config for the given DT node identifier.
#define	NET_ETH_MAC_DT_INST_CONFIG_INIT(inst)
	Like NET_ETH_MAC_DT_CONFIG_INIT for an instance of a DT_DRV_COMPAT compatible.

Enumerations
enum	ethernet_hw_caps { ETHERNET_HW_TX_CHKSUM_OFFLOAD = BIT(0) , ETHERNET_HW_RX_CHKSUM_OFFLOAD = BIT(1) , ETHERNET_HW_VLAN = BIT(2) , ETHERNET_LINK_10BASE = BIT(3) , ETHERNET_LINK_100BASE = BIT(4) , ETHERNET_LINK_1000BASE = BIT(5) , ETHERNET_LINK_2500BASE = BIT(6) , ETHERNET_LINK_5000BASE = BIT(7) , ETHERNET_PTP = BIT(8) , ETHERNET_QAV = BIT(9) , ETHERNET_PROMISC_MODE = BIT(10) , ETHERNET_PRIORITY_QUEUES = BIT(11) , ETHERNET_HW_FILTERING = BIT(12) , ETHERNET_LLDP = BIT(13) , ETHERNET_HW_VLAN_TAG_STRIP = BIT(14) , ETHERNET_DSA_USER_PORT = BIT(15) , ETHERNET_DSA_CONDUIT_PORT = BIT(16) , ETHERNET_QBV = BIT(17) , ETHERNET_QBU = BIT(18) , ETHERNET_TXTIME = BIT(19) , ETHERNET_TXINJECTION_MODE = BIT(20) }
	Ethernet hardware capabilities. More...
enum	ethernet_if_types { L2_ETH_IF_TYPE_ETHERNET , L2_ETH_IF_TYPE_WIFI }
	Types of Ethernet L2. More...
enum	ethernet_checksum_support { ETHERNET_CHECKSUM_SUPPORT_NONE = NET_IF_CHECKSUM_NONE_BIT , ETHERNET_CHECKSUM_SUPPORT_IPV4_HEADER = NET_IF_CHECKSUM_IPV4_HEADER_BIT , ETHERNET_CHECKSUM_SUPPORT_IPV4_ICMP = NET_IF_CHECKSUM_IPV4_ICMP_BIT , ETHERNET_CHECKSUM_SUPPORT_IPV6_HEADER = NET_IF_CHECKSUM_IPV6_HEADER_BIT , ETHERNET_CHECKSUM_SUPPORT_IPV6_ICMP = NET_IF_CHECKSUM_IPV6_ICMP_BIT , ETHERNET_CHECKSUM_SUPPORT_TCP = NET_IF_CHECKSUM_TCP_BIT , ETHERNET_CHECKSUM_SUPPORT_UDP = NET_IF_CHECKSUM_UDP_BIT }
	Protocols that are supported by checksum offloading. More...
enum	ethernet_stats_type { ETHERNET_STATS_TYPE_COMMON = BIT(0) , ETHERNET_STATS_TYPE_VENDOR = BIT(1) , ETHERNET_STATS_TYPE_ALL = 0xFFFFFFFFU }
	Ethernet statistics type (bitmap). More...
enum	net_eth_mac_type { NET_ETH_MAC_DEFAULT = 0 , NET_ETH_MAC_RANDOM , NET_ETH_MAC_NVMEM , NET_ETH_MAC_STATIC }
	MAC address configuration types. More...

Functions
static bool	net_eth_is_addr_broadcast (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is a broadcast address.
static bool	net_eth_is_addr_all_zeroes (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is a all zeroes address.
static bool	net_eth_is_addr_unspecified (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is unspecified.
static bool	net_eth_is_addr_multicast (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is a multicast address.
static bool	net_eth_is_addr_unicast (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is an unicast address.
static bool	net_eth_is_addr_valid (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is valid.
static bool	net_eth_is_addr_lldp_multicast (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is a LLDP multicast address.
static bool	net_eth_is_addr_ptp_multicast (struct net_eth_addr *addr)
	Check if the Ethernet MAC address is a PTP multicast address.
const struct net_eth_addr *	net_eth_broadcast_addr (void)
	Return Ethernet broadcast address.
void	net_eth_ipv4_mcast_to_mac_addr (const struct net_in_addr ipv4_addr, struct net_eth_addr mac_addr)
	Convert IPv4 multicast address to Ethernet address.
void	net_eth_ipv6_mcast_to_mac_addr (const struct net_in6_addr ipv6_addr, struct net_eth_addr mac_addr)
	Convert IPv6 multicast address to Ethernet address.
static enum ethernet_hw_caps	net_eth_get_hw_capabilities (struct net_if *iface)
	Return ethernet device hardware capability information.
static int	net_eth_get_hw_config (struct net_if iface, enum ethernet_config_type type, struct ethernet_config config)
	Return ethernet device hardware configuration information.
static int	net_eth_vlan_enable (struct net_if *iface, uint16_t tag)
	Add VLAN tag to the interface.
static int	net_eth_vlan_disable (struct net_if *iface, uint16_t tag)
	Remove VLAN tag from the interface.
static uint16_t	net_eth_get_vlan_tag (struct net_if *iface)
	Return VLAN tag specified to network interface.
static struct net_if *	net_eth_get_vlan_iface (struct net_if *iface, uint16_t tag)
	Return network interface related to this VLAN tag.
static struct net_if *	net_eth_get_vlan_main (struct net_if *iface)
	Return main network interface that is attached to this VLAN tag.
static bool	net_eth_is_vlan_enabled (struct ethernet_context ctx, struct net_if iface)
	Check if there are any VLAN interfaces enabled to this specific Ethernet network interface or if priority tagged frames (tag 0) are supported.
static bool	net_eth_get_vlan_status (struct net_if *iface)
	Get VLAN status for a given network interface (enabled or not).
static bool	net_eth_is_vlan_interface (struct net_if *iface)
	Check if the given interface is a VLAN interface.
static int	net_eth_mac_load (const struct net_eth_mac_config cfg, uint8_t mac_addr)
	Load a MAC address from a MAC address configuration structure with the specified type.
void	net_eth_carrier_set (struct net_if *iface, bool carrier_up)
	Inform ethernet L2 driver that ethernet carrier is detected or was lost.
static void	net_eth_carrier_on (struct net_if *iface)
	Inform ethernet L2 driver that ethernet carrier is detected.
static void	net_eth_carrier_off (struct net_if *iface)
	Inform ethernet L2 driver that ethernet carrier was lost.
int	net_eth_promisc_mode (struct net_if *iface, bool enable)
	Set promiscuous mode either ON or OFF.
int	net_eth_txinjection_mode (struct net_if *iface, bool enable)
	Set TX-Injection mode either ON or OFF.
int	net_eth_mac_filter (struct net_if iface, struct net_eth_addr mac, enum ethernet_filter_type type, bool enable)
	Set or unset HW filtering for MAC address `mac`.
const struct device *	net_eth_get_phy (struct net_if *iface)
	Return the PHY device that is tied to this ethernet network interface.
static const struct device *	net_eth_get_ptp_clock (struct net_if *iface)
	Return PTP clock that is tied to this ethernet network interface.
const struct device *	net_eth_get_ptp_clock_by_index (int index)
	Return PTP clock that is tied to this ethernet network interface index.
static bool	net_eth_type_is_wifi (struct net_if *iface)
	Check if the Ethernet L2 network interface can perform Wi-Fi.
static bool	net_eth_type_is_ethernet (struct net_if *iface)
	Check if the Ethernet L2 network interface is cabled ethernet.
static void	net_eth_set_if_type_wifi (struct net_if *iface)
	Set the Ethernet interface type to Wi-Fi.

Detailed Description

Ethernet support functions.

Since: 1.0

Version: 0.8.0

Macro Definition Documentation

◆ ETH_NET_DEVICE_DT_DEFINE

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

#include <zephyr/net/ethernet.h>

Value:

Z_ETH_NET_DEVICE_INIT(node_id, Z_DEVICE_DT_DEV_ID(node_id),     \
                      DEVICE_DT_NAME(node_id), init_fn, pm,     \
                      data, config, prio, api, mtu)

Like ETH_NET_DEVICE_INIT but taking metadata from a devicetree.

Create an Ethernet 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.
mtu	Maximum transfer unit in bytes for this network interface.

◆ ETH_NET_DEVICE_DT_INST_DEFINE

#define ETH_NET_DEVICE_DT_INST_DEFINE	(		inst,
			... )

#include <zephyr/net/ethernet.h>

Value:

ETH_NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)

DT_DRV_INST

#define DT_DRV_INST(inst)

Node identifier for an instance of a DT_DRV_COMPAT compatible.

Definition devicetree.h:4333

ETH_NET_DEVICE_DT_DEFINE

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

Like ETH_NET_DEVICE_INIT but taking metadata from a devicetree.

Definition ethernet.h:1175

Like ETH_NET_DEVICE_DT_DEFINE for an instance of a DT_DRV_COMPAT compatible.

Parameters

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

◆ ETH_NET_DEVICE_INIT

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

#include <zephyr/net/ethernet.h>

Value:

Z_ETH_NET_DEVICE_INIT(DT_INVALID_NODE, dev_id, name, init_fn, \

pm, data, config, prio, api, mtu)

DT_INVALID_NODE

#define DT_INVALID_NODE

Name for an invalid node identifier.

Definition devicetree.h:84

Create an Ethernet 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.
mtu	Maximum transfer unit in bytes for this network interface.

◆ ETH_NET_DEVICE_INIT_INSTANCE

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

#include <zephyr/net/ethernet.h>

Value:

Z_ETH_NET_DEVICE_INIT_INSTANCE(DT_INVALID_NODE, dev_id, name,   \
                               instance, init_fn, pm, data,     \
                               config, prio, api, mtu)

Create multiple Ethernet network interfaces and bind them to network devices.

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.
mtu	Maximum transfer unit in bytes for this network interface.

◆ ETH_NET_L3_REGISTER

#define ETH_NET_L3_REGISTER	(	name,
		ptype,
		handler )

#include <zephyr/net/ethernet.h>

Value:

NET_L3_REGISTER(&NET_L2_GET_NAME(ETHERNET), name, ptype, handler)

Ethernet L3 protocol register macro.

Parameters

name	Name of the L3 protocol.
ptype	Ethernet protocol type.
handler	Handler function for this protocol type.

◆ NET_ETH_ADDR_LEN

#define NET_ETH_ADDR_LEN 6U

#include <zephyr/net/ethernet.h>

Ethernet MAC address length.

◆ NET_ETH_MAC_DT_CONFIG_INIT

#define NET_ETH_MAC_DT_CONFIG_INIT ( node_id )

#include <zephyr/net/ethernet.h>

Value:

COND_CASE_1(DT_PROP(node_id, zephyr_random_mac_address),                                   \
            (Z_NET_ETH_MAC_DT_CONFIG_INIT_RANDOM(node_id)),                                \
            DT_NVMEM_CELLS_HAS_NAME(node_id, mac_address),                                 \
            (Z_NET_ETH_MAC_DT_CONFIG_INIT_NVMEM(node_id)),                                 \
            DT_NODE_HAS_PROP(node_id, local_mac_address),                                  \
            (Z_NET_ETH_MAC_DT_CONFIG_INIT_STATIC(node_id)),                                \
            (Z_NET_ETH_MAC_DT_CONFIG_INIT_DEFAULT(node_id)))

Initialize the ethernet MAC config for the given DT node identifier.

Parameters

node_id Node identifier.

◆ NET_ETH_MAC_DT_INST_CONFIG_INIT

#define NET_ETH_MAC_DT_INST_CONFIG_INIT ( inst )

#include <zephyr/net/ethernet.h>

Value:

NET_ETH_MAC_DT_CONFIG_INIT(DT_DRV_INST(inst))

NET_ETH_MAC_DT_CONFIG_INIT

#define NET_ETH_MAC_DT_CONFIG_INIT(node_id)

Initialize the ethernet MAC config for the given DT node identifier.

Definition ethernet.h:1337

Like NET_ETH_MAC_DT_CONFIG_INIT for an instance of a DT_DRV_COMPAT compatible.

Parameters

inst	Instance number.

See also: NET_ETH_MAC_DT_CONFIG_INIT

◆ NET_ETH_MINIMAL_FRAME_SIZE

#define NET_ETH_MINIMAL_FRAME_SIZE 60

#include <zephyr/net/ethernet.h>

Minimum Ethernet frame size.

◆ NET_ETH_MTU

#define NET_ETH_MTU 1500

#include <zephyr/net/ethernet.h>

Ethernet MTU size.

Enumeration Type Documentation

◆ ethernet_checksum_support

enum ethernet_checksum_support

#include <zephyr/net/ethernet.h>

Protocols that are supported by checksum offloading.

Enumerator
ETHERNET_CHECKSUM_SUPPORT_NONE	Device does not support any L3/L4 checksum offloading.
ETHERNET_CHECKSUM_SUPPORT_IPV4_HEADER	Device supports checksum offloading for the IPv4 header.
ETHERNET_CHECKSUM_SUPPORT_IPV4_ICMP	Device supports checksum offloading for ICMPv4 payload (implies IPv4 header).
ETHERNET_CHECKSUM_SUPPORT_IPV6_HEADER	Device supports checksum offloading for the IPv6 header.
ETHERNET_CHECKSUM_SUPPORT_IPV6_ICMP	Device supports checksum offloading for ICMPv6 payload (implies IPv6 header).
ETHERNET_CHECKSUM_SUPPORT_TCP	Device supports TCP checksum offloading for all supported IP protocols.
ETHERNET_CHECKSUM_SUPPORT_UDP	Device supports UDP checksum offloading for all supported IP protocols.

◆ ethernet_hw_caps

enum ethernet_hw_caps

#include <zephyr/net/ethernet.h>

Ethernet hardware capabilities.

Enumerator
ETHERNET_HW_TX_CHKSUM_OFFLOAD	TX Checksum offloading supported for all of IPv4, UDP, TCP.
ETHERNET_HW_RX_CHKSUM_OFFLOAD	RX Checksum offloading supported for all of IPv4, UDP, TCP.
ETHERNET_HW_VLAN	VLAN supported.
ETHERNET_LINK_10BASE	10 Mbits link supported
ETHERNET_LINK_100BASE	100 Mbits link supported
ETHERNET_LINK_1000BASE	1 Gbits link supported
ETHERNET_LINK_2500BASE	2.5 Gbits link supported
ETHERNET_LINK_5000BASE	5 Gbits link supported
ETHERNET_PTP	IEEE 802.1AS (gPTP) clock supported.
ETHERNET_QAV	IEEE 802.1Qav (credit-based shaping) supported.
ETHERNET_PROMISC_MODE	Promiscuous mode supported.
ETHERNET_PRIORITY_QUEUES	Priority queues available.
ETHERNET_HW_FILTERING	MAC address filtering supported.
ETHERNET_LLDP	Link Layer Discovery Protocol supported.
ETHERNET_HW_VLAN_TAG_STRIP	VLAN Tag stripping.
ETHERNET_DSA_USER_PORT	DSA switch user port.
ETHERNET_DSA_CONDUIT_PORT	DSA switch conduit port.
ETHERNET_QBV	IEEE 802.1Qbv (scheduled traffic) supported.
ETHERNET_QBU	IEEE 802.1Qbu (frame preemption) supported.
ETHERNET_TXTIME	TXTIME supported.
ETHERNET_TXINJECTION_MODE	TX-Injection supported.

◆ ethernet_if_types

enum ethernet_if_types

#include <zephyr/net/ethernet.h>

Types of Ethernet L2.

Enumerator
L2_ETH_IF_TYPE_ETHERNET	IEEE 802.3 Ethernet (default).
L2_ETH_IF_TYPE_WIFI	IEEE 802.11 Wi-Fi.

◆ ethernet_stats_type

enum ethernet_stats_type

#include <zephyr/net/ethernet.h>

Ethernet statistics type (bitmap).

Enumerator
ETHERNET_STATS_TYPE_COMMON	Common statistics only (excludes vendor statistics).
ETHERNET_STATS_TYPE_VENDOR	Vendor statistics only.
ETHERNET_STATS_TYPE_ALL	All statistics.

◆ net_eth_mac_type

enum net_eth_mac_type

#include <zephyr/net/ethernet.h>

MAC address configuration types.

Enumerator
NET_ETH_MAC_DEFAULT	MAC address is handled by the driver (backwards compatible case).
NET_ETH_MAC_RANDOM	A random MAC address is generated during initialization.
NET_ETH_MAC_NVMEM	The MAC address is read from an NVMEM cell. Attention Available only when the following Kconfig option is enabled: `CONFIG_NVMEM`.
NET_ETH_MAC_STATIC	A static MAC address is provided in the device tree.

Function Documentation

◆ net_eth_broadcast_addr()

const struct net_eth_addr * net_eth_broadcast_addr ( void )

#include <zephyr/net/ethernet.h>

Return Ethernet broadcast address.

Returns: Ethernet broadcast address.

◆ net_eth_carrier_off()

void net_eth_carrier_off ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Inform ethernet L2 driver that ethernet carrier was lost.

This happens when cable is disconnected.

Parameters

iface Network interface

◆ net_eth_carrier_on()

void net_eth_carrier_on ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Inform ethernet L2 driver that ethernet carrier is detected.

This happens when cable is connected.

Parameters

iface Network interface

◆ net_eth_carrier_set()

void net_eth_carrier_set	(	struct net_if *	iface,
		bool	carrier_up )

#include <zephyr/net/ethernet.h>

Inform ethernet L2 driver that ethernet carrier is detected or was lost.

This happens when cable is connected or disconnected.

Parameters

iface	Network interface
carrier_up	true if carrier is detected, false if carrier was lost

◆ net_eth_get_hw_capabilities()

enum ethernet_hw_caps net_eth_get_hw_capabilities ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Return ethernet device hardware capability information.

Parameters

iface Network interface

Returns: Hardware capabilities

◆ net_eth_get_hw_config()

int net_eth_get_hw_config	(	struct net_if *	iface,
		enum ethernet_config_type	type,
		struct ethernet_config *	config )

inlinestatic

#include <zephyr/net/ethernet.h>

Return ethernet device hardware configuration information.

Parameters

iface	Network interface
type	configuration type
config	Ethernet configuration

Returns: 0 if ok, <0 if error

◆ net_eth_get_phy()

const struct device * net_eth_get_phy ( struct net_if * iface )

#include <zephyr/net/ethernet.h>

Return the PHY device that is tied to this ethernet network interface.

Parameters

iface Network interface

Returns: Pointer to PHY device if found, NULL if not found.

◆ net_eth_get_ptp_clock()

const struct device * net_eth_get_ptp_clock ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Return PTP clock that is tied to this ethernet network interface.

Parameters

iface Network interface

Returns: Pointer to PTP clock if found, NULL if not found or if this ethernet interface does not support PTP.

◆ net_eth_get_ptp_clock_by_index()

const struct device * net_eth_get_ptp_clock_by_index ( int index )

#include <zephyr/net/ethernet.h>

Return PTP clock that is tied to this ethernet network interface index.

Parameters

index Network interface index

Returns: Pointer to PTP clock if found, NULL if not found or if this ethernet interface index does not support PTP.

◆ net_eth_get_vlan_iface()

struct net_if * net_eth_get_vlan_iface	(	struct net_if *	iface,
		uint16_t	tag )

inlinestatic

#include <zephyr/net/ethernet.h>

Return network interface related to this VLAN tag.

Parameters

iface	Main network interface (not the VLAN one).
tag	VLAN tag

Returns: Network interface related to this tag or NULL if no such interface exists.

◆ net_eth_get_vlan_main()

struct net_if * net_eth_get_vlan_main ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Return main network interface that is attached to this VLAN tag.

Parameters

iface VLAN network interface. This is used to get the pointer to ethernet L2 context

Returns: Network interface related to this tag or NULL if no such interface exists.

◆ net_eth_get_vlan_status()

bool net_eth_get_vlan_status ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Get VLAN status for a given network interface (enabled or not).

Parameters

iface Network interface

Returns: True if VLAN is enabled for this network interface, false if not.

◆ net_eth_get_vlan_tag()

uint16_t net_eth_get_vlan_tag ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Return VLAN tag specified to network interface.

Note that the interface parameter must be the VLAN interface, and not the Ethernet one.

Parameters

iface VLAN network interface.

Returns: VLAN tag for this interface or NET_VLAN_TAG_UNSPEC if VLAN is not configured for that interface.

◆ net_eth_ipv4_mcast_to_mac_addr()

void net_eth_ipv4_mcast_to_mac_addr	(	const struct net_in_addr *	ipv4_addr,
		struct net_eth_addr *	mac_addr )

#include <zephyr/net/ethernet.h>

Convert IPv4 multicast address to Ethernet address.

Parameters

ipv4_addr	IPv4 multicast address
mac_addr	Output buffer for Ethernet address

◆ net_eth_ipv6_mcast_to_mac_addr()

void net_eth_ipv6_mcast_to_mac_addr	(	const struct net_in6_addr *	ipv6_addr,
		struct net_eth_addr *	mac_addr )

#include <zephyr/net/ethernet.h>

Convert IPv6 multicast address to Ethernet address.

Parameters

ipv6_addr	IPv6 multicast address
mac_addr	Output buffer for Ethernet address

◆ net_eth_is_addr_all_zeroes()

bool net_eth_is_addr_all_zeroes ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is a all zeroes address.

Parameters

addr	A valid pointer to an Ethernet MAC address.

Returns: true if address is an all zeroes address, false if not

◆ net_eth_is_addr_broadcast()

bool net_eth_is_addr_broadcast ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is a broadcast address.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is a broadcast address, false if not

◆ net_eth_is_addr_lldp_multicast()

bool net_eth_is_addr_lldp_multicast ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is a LLDP multicast address.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is a LLDP multicast address, false if not

◆ net_eth_is_addr_multicast()

bool net_eth_is_addr_multicast ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is a multicast address.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is a multicast address, false if not

◆ net_eth_is_addr_ptp_multicast()

bool net_eth_is_addr_ptp_multicast ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is a PTP multicast address.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is a PTP multicast address, false if not

◆ net_eth_is_addr_unicast()

bool net_eth_is_addr_unicast ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is an unicast address.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is an unicast address, false if not

◆ net_eth_is_addr_unspecified()

bool net_eth_is_addr_unspecified ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is unspecified.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is unspecified, false if not

◆ net_eth_is_addr_valid()

bool net_eth_is_addr_valid ( struct net_eth_addr * addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet MAC address is valid.

Parameters

addr	A valid pointer to a Ethernet MAC address.

Returns: true if address is valid, false if not

◆ net_eth_is_vlan_enabled()

bool net_eth_is_vlan_enabled	(	struct ethernet_context *	ctx,
		struct net_if *	iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if there are any VLAN interfaces enabled to this specific Ethernet network interface or if priority tagged frames (tag 0) are supported.

Note that the iface must be the actual Ethernet interface and not the virtual VLAN interface.

Parameters

ctx	Ethernet context
iface	Ethernet network interface

Returns: True if there are enabled VLANs for this network interface, false if not.

◆ net_eth_is_vlan_interface()

bool net_eth_is_vlan_interface ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the given interface is a VLAN interface.

Parameters

iface Network interface

Returns: True if this network interface is VLAN one, false if not.

◆ net_eth_mac_filter()

int net_eth_mac_filter	(	struct net_if *	iface,
		struct net_eth_addr *	mac,
		enum ethernet_filter_type	type,
		bool	enable )

#include <zephyr/net/ethernet.h>

Set or unset HW filtering for MAC address mac.

Parameters

iface	Network interface
mac	Pointer to an ethernet MAC address
type	Filter type, either source or destination
enable	Set (true) or unset (false)

Returns: 0 if filter set or unset was successful, <0 otherwise.

◆ net_eth_mac_load()

int net_eth_mac_load	(	const struct net_eth_mac_config *	cfg,
		uint8_t *	mac_addr )

inlinestatic

#include <zephyr/net/ethernet.h>

Load a MAC address from a MAC address configuration structure with the specified type.

In the case of a randomized MAC address, the universal vs local (U/L) bit is set to a locally administered address (LAA) and the unicast vs multicast (I/G) bit is cleared to make it a unicast address.

Parameters

cfg	The MAC address configuration.
mac_addr	The resulting MAC address buffer, needs a size of NET_ETH_ADDR_LEN bytes.

Return values

-ENODATA	No MAC address configuration data is loaded.
<0	Negative errno code if failure.
0	If successful.

< Ethernet MAC address length

◆ net_eth_promisc_mode()

int net_eth_promisc_mode	(	struct net_if *	iface,
		bool	enable )

#include <zephyr/net/ethernet.h>

Set promiscuous mode either ON or OFF.

Parameters

iface	Network interface
enable	on (true) or off (false)

Returns: 0 if mode set or unset was successful, <0 otherwise.

◆ net_eth_set_if_type_wifi()

void net_eth_set_if_type_wifi ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Set the Ethernet interface type to Wi-Fi.

Parameters

iface Network interface

◆ net_eth_txinjection_mode()

int net_eth_txinjection_mode	(	struct net_if *	iface,
		bool	enable )

#include <zephyr/net/ethernet.h>

Set TX-Injection mode either ON or OFF.

Parameters

iface	Network interface
enable	on (true) or off (false)

Returns: 0 if mode set or unset was successful, <0 otherwise.

◆ net_eth_type_is_ethernet()

bool net_eth_type_is_ethernet ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet L2 network interface is cabled ethernet.

Parameters

iface Pointer to network interface

Returns: True if interface is cabled ethernet, False otherwise.

◆ net_eth_type_is_wifi()

bool net_eth_type_is_wifi ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Check if the Ethernet L2 network interface can perform Wi-Fi.

Parameters

iface Pointer to network interface

Returns: True if interface supports Wi-Fi, False otherwise.

◆ net_eth_vlan_disable()

int net_eth_vlan_disable	(	struct net_if *	iface,
		uint16_t	tag )

inlinestatic

#include <zephyr/net/ethernet.h>

Remove VLAN tag from the interface.

Parameters

iface	Interface to use.
tag	VLAN tag to remove

Returns: 0 if ok, <0 if error

◆ net_eth_vlan_enable()

int net_eth_vlan_enable	(	struct net_if *	iface,
		uint16_t	tag )

inlinestatic

#include <zephyr/net/ethernet.h>

Add VLAN tag to the interface.

Parameters

iface	Interface to use.
tag	VLAN tag to add

Returns: 0 if ok, <0 if error

Topics

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ ETH_NET_DEVICE_DT_DEFINE

◆ ETH_NET_DEVICE_DT_INST_DEFINE

◆ ETH_NET_DEVICE_INIT

◆ ETH_NET_DEVICE_INIT_INSTANCE

◆ ETH_NET_L3_REGISTER

◆ NET_ETH_ADDR_LEN

◆ NET_ETH_MAC_DT_CONFIG_INIT

◆ NET_ETH_MAC_DT_INST_CONFIG_INIT

◆ NET_ETH_MINIMAL_FRAME_SIZE

◆ NET_ETH_MTU

Enumeration Type Documentation

◆ ethernet_checksum_support

◆ ethernet_hw_caps

◆ ethernet_if_types

◆ ethernet_stats_type

◆ net_eth_mac_type

Function Documentation

◆ net_eth_broadcast_addr()

◆ net_eth_carrier_off()

◆ net_eth_carrier_on()

◆ net_eth_carrier_set()

◆ net_eth_get_hw_capabilities()

◆ net_eth_get_hw_config()

◆ net_eth_get_phy()

◆ net_eth_get_ptp_clock()

◆ net_eth_get_ptp_clock_by_index()

◆ net_eth_get_vlan_iface()

◆ net_eth_get_vlan_main()

◆ net_eth_get_vlan_status()

◆ net_eth_get_vlan_tag()

◆ net_eth_ipv4_mcast_to_mac_addr()

◆ net_eth_ipv6_mcast_to_mac_addr()

◆ net_eth_is_addr_all_zeroes()

◆ net_eth_is_addr_broadcast()

◆ net_eth_is_addr_lldp_multicast()

◆ net_eth_is_addr_multicast()

◆ net_eth_is_addr_ptp_multicast()

◆ net_eth_is_addr_unicast()

◆ net_eth_is_addr_unspecified()

◆ net_eth_is_addr_valid()

◆ net_eth_is_vlan_enabled()

◆ net_eth_is_vlan_interface()

◆ net_eth_mac_filter()

◆ net_eth_mac_load()

◆ net_eth_promisc_mode()

◆ net_eth_set_if_type_wifi()

◆ net_eth_txinjection_mode()

◆ net_eth_type_is_ethernet()

◆ net_eth_type_is_wifi()

◆ net_eth_vlan_disable()

◆ net_eth_vlan_enable()