Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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... | |
OpEN uses this enumeration to define type of MFDB entry.
Enumerator | |
---|---|
OPEN_MFDB_TYPE_DYNAMIC |
MFDB entry type is static. |
Definition at line 67 of file openapi_mfdb.h.
OpEN uses this enumeration to define type of MFDB protocol.
Definition at line 53 of file openapi_mfdb.h.
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.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[in] | compId | component id, start |
[out] | nextCompId | pointer to next component's info |
[out] | type | type |
[out] | desc | description |
- | minimum buffer size 1 | |
- | maximum buffer size OPENAPI_MFDB_COMPONENT_DESCR_STRING_LEN | |
[out] | frwdPortMask | forward ports mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTHGTH | |
[out] | fltPortMask | filtering ports mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH |
OPEN_E_NONE | Next VLANID-MAC entry of the same user returned. |
OPEN_E_FAIL | Failed to get next VLANID-MAC entry of the same user |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbCurrEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | currEntries | ||
) |
Returns the number of current entries in the MFDB table.
[in] | client_handle | client handle from registration API |
[out] | currEntries | pointer to the number of current entries |
OPEN_E_NONE | Number of current entries returned. |
OPEN_E_FAIL | Failed to get number of current entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[in] | nextProt | protocol type (see OPEN_MFDB_PROTOCOL_TYPE_t) |
[out] | mac | pointer to MAC address |
- | buffer size must be OPEN_MFDB_MAC_LENGTH | |
[out] | vlanId | pointer to VLAN ID |
[out] | compId | pointer to component ID |
[out] | type | pointer to type |
[out] | desc | pointer to description |
- | minimum buffer size 1 | |
- | maximum buffer size OPENAPI_MFDB_COMPONENT_DESCR_STRING_LEN | |
[out] | frwdIntMask | forward interface mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH | |
[out] | fltIntMask | filter interface mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH | |
[out] | absPortMask | absolute port mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH |
OPEN_E_NONE | MFDB Entry data returned. |
OPEN_E_FAIL | Failed to get MFDB Entry data. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbEntryFwdIntfGetExact | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vidMac | ||
) |
Checks if a VLANID-MAC entry exists in the MFDB table.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH |
OPEN_E_NONE | VLANID-MAC entry exists in the MFDB table. |
OPEN_E_FAIL | VLANID-MAC entry doesn't exist in the MFDB table. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[in] | matchType | OPEN_MATCH_EXACT or OPEN_MATCH_GETNEXT |
[in] | absMask | pointer to mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH |
OPEN_E_NONE | Forwarding interfaces of the next VLANID-MAC entry returned. |
OPEN_E_FAIL | Failed to get forwarding interfaces of the next VLANID-MAC entry. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbEntryGetFirst | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vidMac, | ||
OPEN_MFDB_PROTOCOL_TYPE_t * | prot | ||
) |
Returns the first VLANID-MAC entry.
[in] | client_handle | client handle from registration API |
[out] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[out] | prot | pointer to protocol type (see OPEN_MFDB_PROTOCOL_TYPE_t) |
OPEN_E_NONE | First VLANID-MAC entry returned. |
OPEN_E_FAIL | Failed to get first VLANID-MAC entry. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbEntryGetNext | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | vidMac, | ||
OPEN_MFDB_PROTOCOL_TYPE_t * | nextProt | ||
) |
Returns the next VLANID-MAC entry.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[out] | nextProt | pointer to protocol type (see OPEN_MFDB_PROTOCOL_TYPE_t) |
OPEN_E_NONE | Next VLANID-MAC entry returned. |
OPEN_E_FAIL | Failed to get next VLANID-MAC entry. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[in] | matchType | OPEN_MATCH_EXACT or OPEN_MATCH_GETNEXT |
[out] | absMask | pointer to mask |
- | minimum buffer size 1 | |
- | maximum buffer size OPEN_MFDB_INTF_LIST_LENGTH |
OPEN_E_NONE | Forwarding interfaces of the next learned VLANID-MAC entry returned. |
OPEN_E_FAIL | Failed to get forwarding interfaces of the next learned VLANID-MAC entry. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
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.
[in] | client_handle | client handle from registration API |
[in] | vidMac | pointer to the VID-MAC combo. |
- | (2-byte VLAN ID + 6-byte MAC address) | |
- | buffer size must be OPEN_MFDB_VIDMAC_LENGTH | |
[in] | protocol | the protocol type (see OPEN_MFDB_PROTOCOL_TYPE_t) |
OPEN_E_NONE | VLANID-MAC entry using that protocol exists in the MFDB table. |
OPEN_E_FAIL | VLANID-MAC entry using that protocol doesn't exist in the MFDB table. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbMaxTableEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxEntries | ||
) |
Returns the maximum number of entries that the MFDB table can hold.
[in] | client_handle | client handle from registration API |
[out] | maxEntries | pointer to the number of total entries |
OPEN_E_NONE | Maximum number of entries returned. |
OPEN_E_FAIL | Failed to get maximum number of entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7
open_error_t openapiMfdbMostEntriesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | mostEntries | ||
) |
Returns the most number of entries ever in the MFDB table.
[in] | client_handle | client handle from registration API |
[out] | mostEntries | pointer to the number of most entries |
OPEN_E_NONE | Most number of entries returned. |
OPEN_E_FAIL | Failed to get most number of entries. |
OPEN_E_PARAM | Error in parameter passed. |
OpEN API Version: 1.7