abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2025-08-04 21:44:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add bridge interface to documentation

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2017-03-15 19:58:32 +01:00
parent 2dcf31d6b1
commit 6328da87aa
2 changed files with 27 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/include/netif/bridgeif_opts.h
View File

@ -40,6 +40,12 @@
#include "lwip/opt.h" #include "lwip/opt.h"
/**
* @defgroup bridgeif_opts Options
* @ingroup bridgeif
* @{
*/
/** BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT==1: set port netif's 'input' function /** BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT==1: set port netif's 'input' function
* to call directly into bridgeif code and on top of that, directly call into * to call directly into bridgeif code and on top of that, directly call into
* the selected forwarding port's 'linkoutput' function. * the selected forwarding port's 'linkoutput' function.
@ -82,4 +88,8 @@
#define BRIDGEIF_FW_DEBUG LWIP_DBG_OFF #define BRIDGEIF_FW_DEBUG LWIP_DBG_OFF
#endif #endif
/**
* @}
*/
#endif /* LWIP_HDR_NETIF_BRIDGEIF_OPTS_H */ #endif /* LWIP_HDR_NETIF_BRIDGEIF_OPTS_H */

22
src/netif/bridgeif.c
View File

@ -35,7 +35,9 @@
* *
*/ */
/* /**
* @defgroup bridgeif IEEE 802.1D bridge interface
* @ingroup addons
* This file implements an IEEE 802.1D bridge by using a multilayer netif approach * 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). * (one hardware-independent netif for the bridge that uses hardware netifs for its ports).
* On transmit, the bridge selects the outgoing port(s). * On transmit, the bridge selects the outgoing port(s).
@ -270,7 +272,9 @@ bridgeif_age_tmr(void *arg)
sys_timeout(BRIDGEIF_AGE_TIMER_MS, bridgeif_age_tmr, arg); sys_timeout(BRIDGEIF_AGE_TIMER_MS, bridgeif_age_tmr, arg);
} }
/** Add a static entry to the forwarding database. /**
* @ingroup bridgeif
* Add a static entry to the forwarding database.
* A static entry marks where frames to a specific eth address (unicast or group address) are * A static entry marks where frames to a specific eth address (unicast or group address) are
* forwarded. * forwarded.
* bits [0..(BRIDGEIF_MAX_PORTS-1)]: hw ports * bits [0..(BRIDGEIF_MAX_PORTS-1)]: hw ports
@ -306,7 +310,10 @@ bridgeif_fdb_add(struct netif *bridgeif, const struct eth_addr *addr, bridgeif_p
return ERR_MEM; return ERR_MEM;
} }
/** Remove a static entry from the forwarding database */ /**
* @ingroup bridgeif
* Remove a static entry from the forwarding database
*/
err_t err_t
bridgeif_fdb_remove(struct netif *bridgeif, const struct eth_addr *addr) bridgeif_fdb_remove(struct netif *bridgeif, const struct eth_addr *addr)
{ {
@ -537,7 +544,9 @@ bridgeif_tcpip_input(struct pbuf *p, struct netif *netif)
} }
#endif /* BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT */ #endif /* BRIDGEIF_PORT_NETIFS_OUTPUT_DIRECT */
/** Initialization function passed to netif_add(). /**
* @ingroup bridgeif
* Initialization function passed to netif_add().
* *
* @param netif the lwip network interface structure for this ethernetif * @param netif the lwip network interface structure for this ethernetif
* @return ERR_OK if the loopif is initialized * @return ERR_OK if the loopif is initialized
@ -640,7 +649,10 @@ bridgeif_init(struct netif *netif)
return ERR_OK; return ERR_OK;
} }
/** Add a port to the bridge */ /**
* @ingroup bridgeif
* Add a port to the bridge
*/
err_t err_t
bridgeif_add_port(struct netif *bridgeif, struct netif *portif) bridgeif_add_port(struct netif *bridgeif, struct netif *portif)
{ {