Ethernet support functions. More...

Modules
	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	ethernet_t1s_param

struct	ethernet_qav_param

struct	ethernet_qbv_param

struct	ethernet_qbu_param

struct	ethernet_filter

struct	ethernet_txtime_param

struct	ethernet_api

struct	ethernet_context
	Ethernet L2 context that is needed for VLAN. More...

Macros
#define	NET_ETH_ADDR_LEN 6U

#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, ...) ETH_NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
	Like ETH_NET_DEVICE_DT_DEFINE 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_AUTO_NEGOTIATION_SET = BIT(3) , ETHERNET_LINK_10BASE_T = BIT(4) , ETHERNET_LINK_100BASE_T = BIT(5) , ETHERNET_LINK_1000BASE_T = BIT(6) , ETHERNET_DUPLEX_SET = 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_SLAVE_PORT = BIT(15) , ETHERNET_DSA_MASTER_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_flags { ETH_CARRIER_UP }

Functions
void	ethernet_init (struct net_if *iface)
	Initialize Ethernet L2 stack for a given interface.

void	net_eth_ipv4_mcast_to_mac_addr (const struct 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 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_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.

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.

void	net_eth_carrier_on (struct net_if *iface)
	Inform ethernet L2 driver that ethernet carrier is detected.

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`.

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 int	net_eth_get_ptp_port (struct net_if *iface)
	Return PTP port number attached to this interface.

static void	net_eth_set_ptp_port (struct net_if *iface, int port)
	Set PTP port number attached to this interface.

static bool	net_eth_type_is_wifi (struct net_if *iface)
	Check if the Ethernet L2 network interface can perform Wi-Fi.

Detailed Description

Ethernet support functions.

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,
		...
	)	ETH_NET_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)

#include <zephyr/net/ethernet.h>

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_COMPAT(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:87

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.

◆ NET_ETH_ADDR_LEN

#define NET_ETH_ADDR_LEN 6U

#include <zephyr/net/ethernet.h>

Enumeration Type Documentation

◆ ethernet_flags

enum ethernet_flags

#include <zephyr/net/ethernet.h>

Enumerator
ETH_CARRIER_UP

◆ 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_AUTO_NEGOTIATION_SET	Enabling/disabling auto negotiation supported.
ETHERNET_LINK_10BASE_T	10 Mbits link supported
ETHERNET_LINK_100BASE_T	100 Mbits link supported
ETHERNET_LINK_1000BASE_T	1 Gbits link supported
ETHERNET_DUPLEX_SET	Changing duplex (half/full) 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_SLAVE_PORT	DSA switch.
ETHERNET_DSA_MASTER_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.

Function Documentation

◆ ethernet_init()

void ethernet_init ( struct net_if * iface )

#include <zephyr/net/ethernet.h>

Initialize Ethernet L2 stack for a given interface.

Parameters

iface A valid pointer to a network interface

◆ net_eth_carrier_off()

void net_eth_carrier_off ( struct net_if * iface )

#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 )

#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_get_hw_capabilities()

static 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_ptp_clock()

static 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_ptp_port()

static int net_eth_get_ptp_port ( struct net_if * iface )

inlinestatic

#include <zephyr/net/ethernet.h>

Return PTP port number attached to this interface.

Parameters

iface Network interface

Returns: Port number, no such port if < 0

◆ net_eth_get_vlan_iface()

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

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

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

static 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 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 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_vlan_enabled()

static 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.

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

static 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_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_ptp_port()

static void net_eth_set_ptp_port	(	struct net_if *	iface,
		int	port
	)

inlinestatic

#include <zephyr/net/ethernet.h>

Set PTP port number attached to this interface.

Parameters

iface	Network interface
port	Port number to set

◆ 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_wifi()

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

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

static 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

Modules

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

◆ NET_ETH_ADDR_LEN

Enumeration Type Documentation

◆ ethernet_flags

◆ ethernet_hw_caps

◆ ethernet_if_types

Function Documentation

◆ ethernet_init()

◆ net_eth_carrier_off()

◆ net_eth_carrier_on()

◆ net_eth_get_hw_capabilities()

◆ net_eth_get_ptp_clock()

◆ net_eth_get_ptp_clock_by_index()

◆ net_eth_get_ptp_port()

◆ 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_vlan_enabled()

◆ net_eth_is_vlan_interface()

◆ net_eth_mac_filter()

◆ net_eth_promisc_mode()

◆ net_eth_set_ptp_port()

◆ net_eth_txinjection_mode()

◆ net_eth_type_is_wifi()

◆ net_eth_vlan_disable()

◆ net_eth_vlan_enable()