openapi_voip.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2017-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_voip.h
*
* @purpose   Auto-VoIP Configuration
*
* @component OpEN
*
* @note  This code must not include any ICOS header files.
*
* @create    08/02/2017
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_VOIP_H_INCLUDED
#define OPENAPI_VOIP_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_QOS_VOIP_TYPE_PROTOCOL=1,   
  OPEN_QOS_VOIP_TYPE_OUI,          
  OPEN_QOS_VOIP_TYPE_TOTAL         
} OPEN_QOS_VOIP_TYPE_t;

typedef enum
{
   OPEN_VOIP_PRI_REMARK = 1,    
   OPEN_VOIP_PRI_TRAFFIC_CLASS, 
} OPEN_VOIP_PRI_SCHEME_t; 

#define OUI_STR_LEN 9
#define OUI_DESC_STRINGLEN 33
/*****************************************************************/
open_error_t openapiVoipGlobalVlanIdSet(openapiClientHandle_t *client_handle,
                                        uint32_t vlanId);

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

/*****************************************************************/
open_error_t openapiVoipGlobalVlanIdGet(openapiClientHandle_t *client_handle,
                                        uint32_t *vlanId);

/*****************************************************************/
open_error_t openapiVoipMaxCallsGet(openapiClientHandle_t *client_handle,
                                    uint32_t *maxCalls);

/*****************************************************************/
open_error_t openapiVoipNumActiveProtocolSessionsGet(openapiClientHandle_t *client_handle,
                                                     uint32_t *sessions);

/*****************************************************************/
open_error_t openapiVoipProfileCosQueueGet(openapiClientHandle_t *client_handle,
                                           OPEN_VOIP_PRI_SCHEME_t *pType,
                                           uint32_t *pTypeVal);

/*****************************************************************/
open_error_t openapiVoipProfileCosQueueSet(openapiClientHandle_t *client_handle,
                                           OPEN_VOIP_PRI_SCHEME_t pType,
                                           uint32_t pTypeVal);

/*****************************************************************/
open_error_t openapiVoipIntfModeGet(openapiClientHandle_t *client_handle,
                                    uint32_t ifNum, 
                                    OPEN_QOS_VOIP_TYPE_t type,
                                    OPEN_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiVoipIntfModeSet(openapiClientHandle_t *client_handle,
                                    uint32_t ifNum, 
                                    OPEN_QOS_VOIP_TYPE_t type,
                                    OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiVoipIntfProtocolStatusGet(openapiClientHandle_t *client_handle,
                                              uint32_t ifNum, 
                                              OPEN_LINK_STATE_t *val);

/*****************************************************************/
open_error_t openapiVoipIntfOUIStatusGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum, 
                                         OPEN_LINK_STATE_t *val);

/*****************************************************************/
open_error_t openapiVoipOUIPriorityGet(openapiClientHandle_t *client_handle,
                                       uint32_t *priority); 

/*****************************************************************/
open_error_t openapiVoipOUIPrioritySet(openapiClientHandle_t *client_handle,
                                       uint32_t priority); 

/*************************************************************************/
open_error_t openapiVoipOuiAdd(openapiClientHandle_t *client_handle, 
                               open_buffdesc *voipOui, open_buffdesc *ouiDesc);

/*************************************************************************/
open_error_t openapiVoipOuiRemove(openapiClientHandle_t *client_handle, 
                                  open_buffdesc *voipOui);

/*************************************************************************/
open_error_t openapiVoipOuiCountGet(openapiClientHandle_t *client_handle, 
                                    uint32_t *voipOuiCount);

/*************************************************************************/
open_error_t openapiVoipOuiEntryGet(openapiClientHandle_t *client_handle, 
                                    uint32_t ouiIndex, open_buffdesc *voipOui, 
                                    open_buffdesc *ouiDesc);

/*************************************************************************/
open_error_t openapiVoipOuiEntryNextGet(openapiClientHandle_t *client_handle, 
                                        uint32_t ouiIndex, open_buffdesc *voipOui,
                                        open_buffdesc *ouiDesc, 
                                        uint32_t *nextOuiIndex);

/*************************************************************************/
open_error_t openapiVoipOuiFirstEntryGet(openapiClientHandle_t *client_handle, 
                                         open_buffdesc *voipOui, 
                                         open_buffdesc *ouiDesc);

/*************************************************************************/
open_error_t openapiVoipOuiDescGet(openapiClientHandle_t *client_handle, 
                                   open_buffdesc *voipOui, open_buffdesc *ouiDesc);

/*************************************************************************/
open_error_t openapiVoipOuiNextEntryGet(openapiClientHandle_t *client_handle, 
                                        open_buffdesc *voipOui, 
                                        open_buffdesc *nextVoipOui, 
                                        open_buffdesc *nextOuiDesc);

/*************************************************************************/
open_error_t openapiVoipIndexOuiAdd(openapiClientHandle_t *client_handle, 
                                    uint32_t ouiIndex, open_buffdesc *voipOui, 
                                    open_buffdesc *ouiDesc);

/*************************************************************************/
open_error_t openapiVoipIndexOuiRemove(openapiClientHandle_t *client_handle, 
                                       uint32_t ouiIndex);

#endif /*#ifndef OPENAPI_VOIP_H_INCLUDED*/