1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

net/l2filter : Update documentation

This commit is contained in:
Akshai M 2020-07-17 20:16:33 +05:30
parent 9bed3c64e9
commit 60170971bd
2 changed files with 11 additions and 5 deletions

View File

@ -281,11 +281,11 @@ typedef void (*netdev_event_cb_t)(netdev_t *dev, netdev_event_t event);
* be used by upper layers to store reference information.
*/
struct netdev {
const struct netdev_driver *driver; /**< ptr to that driver's interface. */
netdev_event_cb_t event_callback; /**< callback for device events */
void *context; /**< ptr to network stack context */
const struct netdev_driver *driver; /**< ptr to that driver's interface. */
netdev_event_cb_t event_callback; /**< callback for device events */
void *context; /**< ptr to network stack context */
#ifdef MODULE_NETDEV_LAYER
netdev_t *lower; /**< ptr to the lower netdev layer */
netdev_t *lower; /**< ptr to the lower netdev layer */
#endif
#ifdef MODULE_L2FILTER
l2filter_t filter[CONFIG_L2FILTER_LISTSIZE]; /**< link layer address filters */

View File

@ -40,6 +40,11 @@
extern "C" {
#endif
/**
* @defgroup net_l2filter_conf Link layer address filter compile configurations
* @ingroup config
* @{
*/
/**
* @brief Maximal length of addresses that can be stored in the filter list
*/
@ -53,6 +58,7 @@ extern "C" {
#ifndef CONFIG_L2FILTER_LISTSIZE
#define CONFIG_L2FILTER_LISTSIZE (8U)
#endif
/** @} */
/**
* @brief Filter list entries
@ -63,7 +69,7 @@ extern "C" {
*/
typedef struct {
uint8_t addr[CONFIG_L2FILTER_ADDR_MAXLEN]; /**< link layer address */
size_t addr_len; /**< address length in byte */
size_t addr_len; /**< address length in byte */
} l2filter_t;
/**