Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_voip.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2017-2018 Broadcom
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_voip.h
28 *
29 * @purpose Auto-VoIP Configuration
30 *
31 * @component OpEN
32 *
33 * @note This code must not include any ICOS header files.
34 *
35 * @create 08/02/2017
36 *
37 * @end
38 *
39 **********************************************************************/
40 #ifndef OPENAPI_VOIP_H_INCLUDED
41 #define OPENAPI_VOIP_H_INCLUDED
42 
43 #include "openapi_common.h"
44 
45 typedef enum
46 {
47  OPEN_QOS_VOIP_TYPE_PROTOCOL=1,
48  OPEN_QOS_VOIP_TYPE_OUI,
49  OPEN_QOS_VOIP_TYPE_TOTAL
50 } OPEN_QOS_VOIP_TYPE_t;
51 
52 typedef enum
53 {
54  OPEN_VOIP_PRI_REMARK = 1,
55  OPEN_VOIP_PRI_TRAFFIC_CLASS,
56 } OPEN_VOIP_PRI_SCHEME_t;
57 
58 /*****************************************************************/
73 open_error_t openapiVoipGlobalVlanIdSet(openapiClientHandle_t *client_handle,
74  uint32_t vlanId);
75 
76 /*****************************************************************/
90 open_error_t openapiVoipGlobalVlanIdReset(openapiClientHandle_t *client_handle);
91 
92 /*****************************************************************/
107 open_error_t openapiVoipGlobalVlanIdGet(openapiClientHandle_t *client_handle,
108  uint32_t *vlanId);
109 
110 /*****************************************************************/
125 open_error_t openapiVoipMaxCallsGet(openapiClientHandle_t *client_handle,
126  uint32_t *maxCalls);
127 
128 /*****************************************************************/
143 open_error_t openapiVoipNumActiveProtocolSessionsGet(openapiClientHandle_t *client_handle,
144  uint32_t *sessions);
145 
146 /*****************************************************************/
162 open_error_t openapiVoipProfileCosQueueGet(openapiClientHandle_t *client_handle,
163  OPEN_VOIP_PRI_SCHEME_t *pType,
164  uint32_t *pTypeVal);
165 
166 /*****************************************************************/
182 open_error_t openapiVoipProfileCosQueueSet(openapiClientHandle_t *client_handle,
183  OPEN_VOIP_PRI_SCHEME_t pType,
184  uint32_t pTypeVal);
185 
186 /*****************************************************************/
203 open_error_t openapiVoipIntfModeGet(openapiClientHandle_t *client_handle,
204  uint32_t ifNum,
205  OPEN_QOS_VOIP_TYPE_t type,
206  OPEN_CONTROL_t *mode);
207 
208 /*****************************************************************/
225 open_error_t openapiVoipIntfModeSet(openapiClientHandle_t *client_handle,
226  uint32_t ifNum,
227  OPEN_QOS_VOIP_TYPE_t type,
228  OPEN_CONTROL_t mode);
229 
230 /*****************************************************************/
246 open_error_t openapiVoipIntfProtocolStatusGet(openapiClientHandle_t *client_handle,
247  uint32_t ifNum,
248  OPEN_LINK_STATE_t *val);
249 
250 /*****************************************************************/
266 open_error_t openapiVoipIntfOUIStatusGet(openapiClientHandle_t *client_handle,
267  uint32_t ifNum,
268  OPEN_LINK_STATE_t *val);
269 
270 /*****************************************************************/
285 open_error_t openapiVoipOUIPriorityGet(openapiClientHandle_t *client_handle,
286  uint32_t *priority);
287 
288 /*****************************************************************/
303 open_error_t openapiVoipOUIPrioritySet(openapiClientHandle_t *client_handle,
304  uint32_t priority);
305 
306 #endif /*#ifndef OPENAPI_VOIP_H_INCLUDED*/
307