openapi_mfdb.h

Go to the documentation of this file.

/********************************************************************************
*
* Copyright 2016-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
********************************************************************************
*
* @filename  openapi_mfdb.h
*
* @purpose   Provide interface to Switch MFDB
*
* @component OpEN
*
* @create    06/18/2015
*
* @end
*
********************************************************************************/
#ifndef OPENAPI_MFDB_H_INCLUDED
#define OPENAPI_MFDB_H_INCLUDED

#include "openapi_common.h"

#define OPEN_MFDB_INTF_LIST_LENGTH   4096
#define OPEN_MFDB_VIDMAC_LENGTH      24
#define OPEN_MFDB_MAC_LENGTH         18
#define OPENAPI_MFDB_DESCR_LEN       16

typedef enum
{
  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_PROTOCOL_KNOWN_MULTICAST = 8,
  OPEN_MFDB_PROTOCOL_RESERVED_MCAST  = 9,
  OPEN_MFDB_TOTAL_NUM_PROTOCOLS            
} OPEN_MFDB_PROTOCOL_TYPE_t;

typedef enum
{
  OPEN_MFDB_TYPE_STATIC  = 0,     
  OPEN_MFDB_TYPE_DYNAMIC = 1      
} OPEN_MFDB_ENTRY_TYPE_t;

/*************************************************************************************************/
open_error_t openapiMfdbEntryProtocolGetExact(openapiClientHandle_t * client_handle,
                                              open_buffdesc * vidMac,
                                              OPEN_MFDB_PROTOCOL_TYPE_t protocol);

/*************************************************************************************************/
open_error_t openapiMfdbEntryGetFirst(openapiClientHandle_t * client_handle,
                                      open_buffdesc * vidMac,
                                      OPEN_MFDB_PROTOCOL_TYPE_t * prot);

/*************************************************************************************************/
open_error_t openapiMfdbEntryGetNext(openapiClientHandle_t * client_handle,
                                     open_buffdesc * vidMac,
                                     OPEN_MFDB_PROTOCOL_TYPE_t * nextProt);

/*************************************************************************************************/
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);

/*************************************************************************************************/
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);

/*************************************************************************************************/
open_error_t openapiMfdbEntryFwdIntfGetExact(openapiClientHandle_t * client_handle,
                                             open_buffdesc * vidMac);

/*************************************************************************************************/
open_error_t openapiMfdbEntryFwdIntfGetNext(openapiClientHandle_t * client_handle,
                                            open_buffdesc * vidMac,
                                            uint32_t matchType,
                                            open_buffdesc * absMask);

/*************************************************************************************************/
open_error_t openapiMfdbEntryLearntIntfGetNext(openapiClientHandle_t * client_handle,
                                               open_buffdesc * vidMac,
                                               uint32_t matchType,
                                               open_buffdesc * absMask);

/*************************************************************************************************/
open_error_t openapiMfdbMaxTableEntriesGet(openapiClientHandle_t * client_handle,
                                           uint32_t * maxEntries);

/*************************************************************************************************/
open_error_t openapiMfdbMostEntriesGet(openapiClientHandle_t * client_handle,
                                       uint32_t * mostEntries);

/*************************************************************************************************/
open_error_t openapiMfdbCurrEntriesGet(openapiClientHandle_t * client_handle,
                                       uint32_t * currEntries);
#endif /* OPENAPI_MFDB_H_INCLUDED */