ETHFW API Guide

Introduction

Data Structures

struct  EthFwMcast_McastCfg
 Multicast configuration params. More...
 
struct  EthFwMcast_SharedMcastCfg
 Multicast configuration parameters. More...
 
struct  EthFwMcast_RsvdMcast
 Reserved multicast. More...
 
struct  EthFwMcast_RsvdMcastCfg
 Reserved multicast configuration. More...
 
struct  EthFwMcast_Cfg
 Multicast configuration (shared and reserved addresses). More...
 

Typedefs

typedef void(* EthFwMcast_FilterAddMacSharedCb) (const uint8_t *macAddr, uint8_t coreId)
 Filter 'add' shared multicast callback. More...
 
typedef void(* EthFwMcast_FilterDelMacSharedCb) (const uint8_t *macAddr, uint8_t coreId)
 Filter delete shared multicast callback. More...
 

Macros

#define ETHFW_SHARED_MCAST_LIST_LEN   (8U)
 
#define ETHFW_RSVD_MCAST_LIST_LEN   (4U)
 
#define ETHFW_EXCLUSIVE_MCAST_LIST_LEN   (32U)
 

Macro Definition Documentation

◆ ETHFW_SHARED_MCAST_LIST_LEN

#define ETHFW_SHARED_MCAST_LIST_LEN   (8U)

Size of shared multicast address table

◆ ETHFW_RSVD_MCAST_LIST_LEN

#define ETHFW_RSVD_MCAST_LIST_LEN   (4U)

Size of reserved multicast address table

◆ ETHFW_EXCLUSIVE_MCAST_LIST_LEN

#define ETHFW_EXCLUSIVE_MCAST_LIST_LEN   (32U)

Size of Exclusive multicast address table

Typedef Documentation

◆ EthFwMcast_FilterAddMacSharedCb

typedef void(* EthFwMcast_FilterAddMacSharedCb) (const uint8_t *macAddr, uint8_t coreId)

Filter 'add' shared multicast callback.

Application callback function called when a remote client requests the addition of a shared multicast address to the filter.

Parameters
macAddrMulticast address being added
coreIdRemote core id which originated the multicast 'add' request

◆ EthFwMcast_FilterDelMacSharedCb

typedef void(* EthFwMcast_FilterDelMacSharedCb) (const uint8_t *macAddr, uint8_t coreId)

Filter delete shared multicast callback.

Application callback function called when a remote client requests the deletion of a shared multicast address from the filter.

Parameters
macAddrMulticast address being added
coreIdRemote core id which originated the multicast 'remove' request