openapi_mvr.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2022 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_mvr.h
*
* @purpose   This code implements the OpEN MVR API
*
* @component OPEN
*
* @create    11/30/2022
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_MVR_H_INCLUDED
#define OPENAPI_MVR_H_INCLUDED

#include "openapi_common.h" 

typedef enum
{
  OPEN_MVR_NONE_MODE = 0,
  OPEN_MVR_COMPATIBLE_MODE,
  OPEN_MVR_DYNAMIC_MODE
} OPEN_MVR_MODE_TYPE_t;

typedef enum
{
  OPEN_MVR_NONE_TYPE = 0,
  OPEN_MVR_STATIC_TYPE,
  OPEN_MVR_DYNAMIC_TYPE
} OPEN_MVR_ENTRY_TYPE_t;

typedef enum
{
  OPEN_MVR_NONE_PORT_TYPE = 0,
  OPEN_MVR_SOURCE_PORT_TYPE,
  OPEN_MVR_RECEIVER_PORT_TYPE,
  OPEN_MVR_LAST_TYPE
} OPEN_MVR_INTF_TYPE_t;

typedef enum
{  
  OPEN_MVR_PKT_IGMP_QUERY_RX_COUNTER = 0,
  OPEN_MVR_PKT_IGMP_REPORT_V1_RX_COUNTER,
  OPEN_MVR_PKT_IGMP_REPORT_V2_RX_COUNTER,
  OPEN_MVR_PKT_IGMP_LEAVE_RX_COUNTER,
  OPEN_MVR_PKT_IGMP_QUERY_TX_COUNTER,
  OPEN_MVR_PKT_IGMP_REPORT_V1_TX_COUNTER,
  OPEN_MVR_PKT_IGMP_REPORT_V2_TX_COUNTER,
  OPEN_MVR_PKT_IGMP_LEAVE_TX_COUNTER,
  OPEN_MVR_PKT_RX_FAILURE_COUNTER,
  OPEN_MVR_PKT_TX_FAILURE_COUNTER,
  OPEN_MVR_PKT_COUNTER_LAST
} OPEN_MVR_PDU_COUNTER_t;

#define OPEN_MVR_QUERY_TIME_MIN     1
#define OPEN_MVR_QUERY_TIME_MAX     100
#define OPEN_MVR_MULT_IP_ADDR_MIN       0xe0000100
#define OPEN_MVR_MULT_IP_ADDR_MAX       0xefffffff
/*************************************************************************/
open_error_t openapiMvrAdminModeGet(openapiClientHandle_t *client_handle, 
                                    OPEN_CONTROL_t *adminMode);

/*************************************************************************/
open_error_t openapiMvrAdminModeSet(openapiClientHandle_t *client_handle,
                                    OPEN_CONTROL_t adminMode);

/*************************************************************************/
open_error_t openapiMvrQueryTimeGet(openapiClientHandle_t *client_handle,
                                    uint32_t *queryTime);

/*************************************************************************/
open_error_t openapiMvrQueryTimeSet(openapiClientHandle_t *client_handle,
                                    uint32_t queryTime);

/*************************************************************************/
open_error_t openapiMvrModeTypeGet(openapiClientHandle_t *client_handle, 
                                   OPEN_MVR_MODE_TYPE_t *modeType);

/*************************************************************************/
open_error_t openapiMvrModeTypeSet(openapiClientHandle_t *client_handle, 
                                   OPEN_MVR_MODE_TYPE_t modeType);

/*************************************************************************/
open_error_t openapiMvrMulticastVlanGet(openapiClientHandle_t *client_handle, 
                                        uint32_t *multicastVlan);

/*************************************************************************/
open_error_t openapiMvrMulticastVlanSet(openapiClientHandle_t *client_handle,
                                        uint32_t multicastVlan);

/*************************************************************************/
open_error_t openapiMvrIsReceiversInVlan(openapiClientHandle_t *client_handle, 
                                         uint32_t vlanId, 
                                         OPEN_BOOL_t *rxVlanParticipationStatus);

/*************************************************************************/
open_error_t openapiMvrIntfModeGet(openapiClientHandle_t *client_handle, 
                                   uint32_t ifNum,    
                                   OPEN_CONTROL_t *intfMode);

/*************************************************************************/
open_error_t openapiMvrIntfModeSet(openapiClientHandle_t *client_handle, 
                                   uint32_t ifNum,    
                                   OPEN_CONTROL_t intfMode);

/*************************************************************************/
open_error_t openapiMvrIntfMvrTypeGet(openapiClientHandle_t *client_handle, 
                                      uint32_t ifNum, 
                                      OPEN_MVR_INTF_TYPE_t *intfMvrType);

/*************************************************************************/
open_error_t openapiMvrIntfMvrTypeSet(openapiClientHandle_t *client_handle, 
                                      uint32_t ifNum, 
                                      OPEN_MVR_INTF_TYPE_t intfMvrType);

/*************************************************************************/
open_error_t openapiMvrIntfImmediateModeGet(openapiClientHandle_t *client_handle, 
                                            uint32_t ifNum, 
                                            OPEN_CONTROL_t *immediateMode);

/*************************************************************************/
open_error_t openapiMvrIntfImmediateModeSet(openapiClientHandle_t *client_handle,
                                            uint32_t ifNum, 
                                            OPEN_CONTROL_t immediateMode);

/*************************************************************************/
open_error_t openapiMvrGroupIpAdd(openapiClientHandle_t *client_handle, 
                                  uint32_t groupIp);

/*************************************************************************/
open_error_t openapiMvrGroupIpDelete(openapiClientHandle_t *client_handle, 
                                     uint32_t groupIp);

/*************************************************************************/
open_error_t openapiMvrIntfGroupIpAdd(openapiClientHandle_t *client_handle, 
                                      uint32_t ifNum, uint32_t groupIp);

/*************************************************************************/
open_error_t openapiMvrIntfGroupIpDelete(openapiClientHandle_t *client_handle, 
                                         uint32_t ifNum, uint32_t groupIp);

/*************************************************************************/
open_error_t openapiMvrGroupEntryGetNext(openapiClientHandle_t *client_handle, 
                                         uint32_t groupId, uint32_t *nextGroupId);

/*************************************************************************/
open_error_t openapiMvrEntryGetNext(openapiClientHandle_t *client_handle, 
                                    uint32_t groupIp, uint32_t *nextGroupIp);

/*************************************************************************/
open_error_t openapiMvrGroupIpGet(openapiClientHandle_t *client_handle, 
                                  uint32_t groupId, uint32_t *groupIp);

/*************************************************************************/
open_error_t openapiMvrIntfEntryTypeGet(openapiClientHandle_t *client_handle, 
                                        uint32_t ifNum, uint32_t groupId, 
                                        OPEN_MVR_ENTRY_TYPE_t *type);

/*************************************************************************/
open_error_t openapiMvrIntfGroupGetNext(openapiClientHandle_t *client_handle, 
                                        uint32_t groupId, uint32_t ifNum, 
                                        uint32_t *nextIfNum);

/*************************************************************************/
open_error_t openapiMvrIntfGetNext(openapiClientHandle_t *client_handle, 
                                   uint32_t ifNum, uint32_t *nextIfNum);

/*************************************************************************/
open_error_t openapiMvrGroupNumGet(openapiClientHandle_t *client_handle, 
                                   uint32_t *groupEntries);

/*************************************************************************/
open_error_t openapiMvrGroupStatusGet(openapiClientHandle_t *client_handle, 
                                      uint32_t groupId, OPEN_BOOL_t *status);

/*************************************************************************/
open_error_t openapiMvrGroupIdGet(openapiClientHandle_t *client_handle, 
                                  uint32_t groupIp, uint32_t *groupId);

/*************************************************************************/
open_error_t openapiMvrIntfGroupIdGetNext(openapiClientHandle_t *client_handle, 
                                          uint32_t ifNum, uint32_t groupId,
                                          uint32_t *nextGroupId);

/*************************************************************************/
open_error_t openapiMvrIntfStaticGroupIpGetNext(openapiClientHandle_t *client_handle,
                                                uint32_t ifNum, uint32_t groupIp,
                                                uint32_t *nextGroupIp);

/*************************************************************************/
open_error_t openapiMvrPduCounterGet(openapiClientHandle_t *client_handle, 
                                     OPEN_MVR_PDU_COUNTER_t counterType, 
                                     uint32_t *counterValue);


#endif /* OPENAPI_MVR_H_INCLUDED */