Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Enumerations | Functions
openapi_mfdb.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_MATCH_EXACT   1
 
#define OPEN_MATCH_FREE   3
 
#define OPEN_MATCH_GETNEXT   2
 
#define OPEN_MFDB_INTF_LIST_LENGTH   4096
 
#define OPEN_MFDB_MAC_LENGTH   18
 
#define OPEN_MFDB_VIDMAC_LENGTH   24
 
#define OPENAPI_MFDB_DESCR_LEN   16
 

Enumerations

enum  OPEN_MFDB_ENTRY_TYPE_t { OPEN_MFDB_TYPE_STATIC = 0, OPEN_MFDB_TYPE_DYNAMIC = 1 }
 OpEN uses this enumeration to define type of MFDB entry. More...
 
enum  OPEN_MFDB_PROTOCOL_TYPE_t {
  OPEN_MFDB_PROTOCOL_STATIC = 1, OPEN_MFDB_PROTOCOL_GMRP = 2, OPEN_MFDB_PROTOCOL_IGMP = 3, OPEN_MFDB_PROTOCOL_MLD = 4,
  OPEN_MFDB_PROTOCOL_MVR = 5, OPEN_MFDB_PROTOCOL_MMRP = 6, OPEN_MFDB_PROTOCOL_MSRP = 7, OPEN_MFDB_TOTAL_NUM_PROTOCOLS
}
 OpEN uses this enumeration to define type of MFDB protocol. More...
 

Functions

open_error_t openapiMfdbComponentEntryGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, OPEN_MFDB_PROTOCOL_TYPE_t compId, OPEN_MFDB_PROTOCOL_TYPE_t *nextCompId, OPEN_MFDB_ENTRY_TYPE_t *type, open_buffdesc *desc, open_buffdesc *frwdPortMask, open_buffdesc *fltPortMask)
 Returns the next VLANID-MAC entry of the same user. More...
 
open_error_t openapiMfdbCurrEntriesGet (openapiClientHandle_t *client_handle, uint32_t *currEntries)
 Returns the number of current entries in the MFDB table. More...
 
open_error_t openapiMfdbEntryDataGet (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, OPEN_MFDB_PROTOCOL_TYPE_t nextProt, open_buffdesc *mac, uint32_t *vlanId, OPEN_MFDB_PROTOCOL_TYPE_t *compId, OPEN_MFDB_ENTRY_TYPE_t *type, open_buffdesc *desc, open_buffdesc *frwdIntMask, open_buffdesc *fltIntMask, open_buffdesc *absPortMask)
 Returns the MFDB Entry data. More...
 
open_error_t openapiMfdbEntryFwdIntfGetExact (openapiClientHandle_t *client_handle, open_buffdesc *vidMac)
 Checks if a VLANID-MAC entry exists in the MFDB table. More...
 
open_error_t openapiMfdbEntryFwdIntfGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, uint32_t matchType, open_buffdesc *absMask)
 Returns the forwarding interfaces of the next VLANID-MAC entry. More...
 
open_error_t openapiMfdbEntryGetFirst (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, OPEN_MFDB_PROTOCOL_TYPE_t *prot)
 Returns the first VLANID-MAC entry. More...
 
open_error_t openapiMfdbEntryGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, OPEN_MFDB_PROTOCOL_TYPE_t *nextProt)
 Returns the next VLANID-MAC entry. More...
 
open_error_t openapiMfdbEntryLearntIntfGetNext (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, uint32_t matchType, open_buffdesc *absMask)
 Returns the forwarding interfaces of the next learned VLANID-MAC entry. More...
 
open_error_t openapiMfdbEntryProtocolGetExact (openapiClientHandle_t *client_handle, open_buffdesc *vidMac, OPEN_MFDB_PROTOCOL_TYPE_t protocol)
 Checks if a VLANID-MAC entry, that uses a specific protocol, exists in the MFDB table. More...
 
open_error_t openapiMfdbMaxTableEntriesGet (openapiClientHandle_t *client_handle, uint32_t *maxEntries)
 Returns the maximum number of entries that the MFDB table can hold. More...
 
open_error_t openapiMfdbMostEntriesGet (openapiClientHandle_t *client_handle, uint32_t *mostEntries)
 Returns the most number of entries ever in the MFDB table. More...