openapi_mvrp.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2020 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_mvrp.h
*
* @purpose   MVRP Open API(s)
*
* @component OPEN
*
* @create    06/18/2020
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_MVRP_H_INCLUDED
#define OPENAPI_MVRP_H_INCLUDED

#include "openapi_common.h" 
#include "openapi_vlan.h"

typedef enum
{
  OPEN_MVRP_VLAN_REGISTERED = 0,  
  OPEN_MVRP_VLAN_DECLARED         
} OPEN_MVRP_VLAN_TYPE_t;

typedef enum 
{
  OPEN_MVRP_STATS_RX = 0,         
  OPEN_MVRP_STATS_RX_BAD_HEADER,  
  OPEN_MVRP_STATS_RX_BAD_FORMAT,  
  OPEN_MVRP_STATS_TX,             
  OPEN_MVRP_STATS_TX_FAILURE,     
  OPEN_MVRP_STATS_MSG,            
  OPEN_MVRP_STATS_REG_FAIL        
} OPEN_MVRP_STATS_t;


/*************************************************************************/
open_error_t openapiMvrpModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiMvrpModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMvrpPeriodicStateMachineModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiMvrpPeriodicStateMachineModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t  mode);

/*************************************************************************/
open_error_t openapiMvrpIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiMvrpIntfModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiMvrpIsValidIntfGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *isValid);

/*************************************************************************/
open_error_t openapiMvrpValidIntfNextGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIfNum);

/*************************************************************************/
open_error_t openapiMvrpTrafficPduCounterGet(openapiClientHandle_t *client_handle, OPEN_MVRP_STATS_t type, uint32_t *counter);

/*************************************************************************/
open_error_t openapiMvrpIntfTrafficPduCounterGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MVRP_STATS_t type, uint32_t *counter);

/*************************************************************************/
open_error_t openapiMvrpVlanArrayGet(openapiClientHandle_t *client_handle, OPEN_MVRP_VLAN_TYPE_t vlanType, OPEN_VLAN_LIST_t *vlanList, uint32_t *count);

/*************************************************************************/
open_error_t openapiMvrpIntfVlanArrayGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MVRP_VLAN_TYPE_t vlanType, OPEN_VLAN_LIST_t *vlanList, uint32_t *count);

/*************************************************************************/
open_error_t openapiMvrpTrafficCountersPerIfClear(openapiClientHandle_t *client_handle, uint32_t intIfNum);

/*************************************************************************/
open_error_t openapiMvrpTrafficGlobalCountersClear(openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiMvrpTrafficCountersClear(openapiClientHandle_t *client_handle);

#endif /* OPENAPI_MVRP_H_INCLUDED */