Collaboration diagram for IEEE 802.1D bridge:

Modules
	Options

	FDB example code

Classes
struct	bridgeif_initdata_s

Macros
#define	BRIDGEIF_INITDATA1(max_ports, max_fdb_dynamic_entries, max_fdb_static_entries, ethaddr) {ethaddr, max_ports, max_fdb_dynamic_entries, max_fdb_static_entries}

#define	BRIDGEIF_INITDATA2(max_ports, max_fdb_dynamic_entries, max_fdb_static_entries, e0, e1, e2, e3, e4, e5) {{e0, e1, e2, e3, e4, e5}, max_ports, max_fdb_dynamic_entries, max_fdb_static_entries}

Typedefs
typedef struct bridgeif_initdata_s	bridgeif_initdata_t

Detailed Description

This file implements an IEEE 802.1D bridge by using a multilayer netif approach (one hardware-independent netif for the bridge that uses hardware netifs for its ports). On transmit, the bridge selects the outgoing port(s). On receive, the port netif calls into the bridge (via its netif->input function) and the bridge selects the port(s) (and/or its netif->input function) to pass the received pbuf to.

Usage:

add the port netifs just like you would when using them as dedicated netif without a bridge
- only NETIF_FLAG_ETHARP/NETIF_FLAG_ETHERNET netifs are supported as bridge ports
- add the bridge port netifs without IPv4 addresses (i.e. pass 'NULL, NULL, NULL')
- don't add IPv6 addresses to the port netifs!
set up the bridge configuration in a global variable of type 'bridgeif_initdata_t' that contains
- the MAC address of the bridge
- some configuration options controlling the memory consumption (maximum number of ports and FDB entries)
- e.g. for a bridge MAC address 00-01-02-03-04-05, 2 bridge ports, 1024 FDB entries + 16 static MAC entries: bridgeif_initdata_t mybridge_initdata = BRIDGEIF_INITDATA1(2, 1024, 16, ETH_ADDR(0, 1, 2, 3, 4, 5));
add the bridge netif (with IPv4 config): struct netif bridge_netif; netif_add(&bridge_netif, &my_ip, &my_netmask, &my_gw, &mybridge_initdata, bridgeif_init, tcpip_input); NOTE: the passed 'input' function depends on BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT setting, which controls where the forwarding is done (netif low level input context vs. tcpip_thread)
set up all ports netifs and the bridge netif
When adding a port netif, NETIF_FLAG_ETHARP flag will be removed from a port to prevent ETHARP working on that port netif (we only want one IP per bridge not per port).
When adding a port netif, its input function is changed to call into the bridge.

Todo:
:

Macro Definition Documentation

◆ BRIDGEIF_INITDATA1

#define BRIDGEIF_INITDATA1	(	max_ports,
		max_fdb_dynamic_entries,
		max_fdb_static_entries,
		ethaddr
	)	{ethaddr, max_ports, max_fdb_dynamic_entries, max_fdb_static_entries}

Use this for constant initialization of a bridgeif_initdat_t (ethaddr must be passed as ETH_ADDR())

Definition at line 87 of file bridgeif.h.

◆ BRIDGEIF_INITDATA2

#define BRIDGEIF_INITDATA2	(	max_ports,
		max_fdb_dynamic_entries,
		max_fdb_static_entries,
		e0,
		e1,
		e2,
		e3,
		e4,
		e5
	)	{{e0, e1, e2, e3, e4, e5}, max_ports, max_fdb_dynamic_entries, max_fdb_static_entries}

Use this for constant initialization of a bridgeif_initdat_t (each byte of ethaddr must be passed)

Definition at line 92 of file bridgeif.h.

Typedef Documentation

◆ bridgeif_initdata_t

typedef struct bridgeif_initdata_s bridgeif_initdata_t

Initialisation data for bridgeif_init. An instance of this type must be passed as parameter 'state' to netif_add when the bridge is added.

Modules

Classes