openapi_voice_vlan.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_voice_vlan.h
*
* @purpose   Voice VLAN Configuration and Status
*
* @component OpEN
*
* @create    11/02/2016
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_VOICE_VLAN_H_INCLUDED
#define OPENAPI_VOICE_VLAN_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_VOICE_VLAN_CONFIG_DISABLE  = 0,  
  OPEN_VOICE_VLAN_CONFIG_VLAN_ID  = 1,  
  OPEN_VOICE_VLAN_CONFIG_DOT1P    = 2,  
  OPEN_VOICE_VLAN_CONFIG_NONE     = 3,  
  OPEN_VOICE_VLAN_CONFIG_UNTAGGED = 4,  
} OPEN_VOICE_VLAN_CONFIG_TYPE_t;

#define OPEN_VOICE_VLAN_DSCP_MIN          0  
#define OPEN_VOICE_VLAN_DSCP_MAX          64 
#define OPEN_VOICE_VLAN_DOT1P_MIN         0  
#define OPEN_VOICE_VLAN_DOT1P_MAX         7  
/*****************************************************************/
open_error_t openapiVoiceVlanAdminModeSet(openapiClientHandle_t *client_handle,
                                          OPEN_CONTROL_t mode);

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

/*****************************************************************/
open_error_t openapiVoiceVlanPortAdminModeSet(openapiClientHandle_t *client_handle,
                                              uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t mode,
                                              uint32_t dataValue);

/*****************************************************************/
open_error_t openapiVoiceVlanPortAdminModeGet(openapiClientHandle_t *client_handle,
                                              uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t *mode);

/*****************************************************************/
open_error_t openapiVoiceVlanPortVlanIdGet(openapiClientHandle_t *client_handle,
                                           uint32_t ifNum, uint32_t *vlanId);

/*****************************************************************/
open_error_t openapiVoiceVlanPortDot1pPriorityGet(openapiClientHandle_t *client_handle,
                                                  uint32_t ifNum, uint32_t *priority);

/*************************************************************************/
open_error_t openapiVoiceVlanPortCosOverrideModeGet(openapiClientHandle_t *client_handle, 
                                                    uint32_t ifNum, 
                                                    OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiVoiceVlanPortCosOverrideModeSet(openapiClientHandle_t *client_handle, 
                                                    uint32_t ifNum, 
                                                    OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiVoiceVlanPortAuthStateGet(openapiClientHandle_t *client_handle, 
                                              uint32_t ifNum, OPEN_CONTROL_t *state);

/*************************************************************************/
open_error_t openapiVoiceVlanPortAuthStateSet(openapiClientHandle_t *client_handle, 
                                              uint32_t ifNum, OPEN_CONTROL_t state);

/*************************************************************************/
open_error_t openapiVoiceVlanPortDscpGet(openapiClientHandle_t *client_handle, 
                                         uint32_t ifNum, uint32_t *dscp);

/*************************************************************************/
open_error_t openapiVoiceVlanPortDscpSet(openapiClientHandle_t *client_handle, 
                                         uint32_t ifNum, uint32_t dscp);

/*************************************************************************/
open_error_t openapiVoiceVlanPortDot1pPrioritySet(openapiClientHandle_t *client_handle, 
                                                 uint32_t ifNum, 
                                                 uint32_t dot1pPriority);

/*************************************************************************/
open_error_t openapiVoiceVlanPortVlanIdSet(openapiClientHandle_t *client_handle, 
                                           uint32_t ifNum, uint32_t vlanId);

/*************************************************************************/
open_error_t openapiVoiceVlanPortStatusGet(openapiClientHandle_t *client_handle, 
                                           uint32_t ifNum, OPEN_CONTROL_t *mode);


#endif /* OPENAPI_VOICE_VLAN_H_INCLUDED */