Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_voice_vlan.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-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_voice_vlan.h
28 *
29 * @purpose Voice VLAN Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 11/02/2016
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_VOICE_VLAN_H_INCLUDED
39 #define OPENAPI_VOICE_VLAN_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 typedef enum
44 {
51 
52 /*****************************************************************/
68  OPEN_CONTROL_t mode);
69 
70 /*****************************************************************/
84  OPEN_CONTROL_t *mode);
85 
86 /*****************************************************************/
106  uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t mode,
107  uint32_t dataValue);
108 
109 /*****************************************************************/
124  uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t *mode);
125 
126 /*****************************************************************/
141  uint32_t ifNum, uint32_t *vlanId);
142 
143 /*****************************************************************/
158  uint32_t ifNum, uint32_t *priority);
159 
160 #endif /* OPENAPI_VOICE_VLAN_H_INCLUDED */
161 
open_error_t openapiVoiceVlanPortDot1pPriorityGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *priority)
Get the Voice VLAN port DOT1P priority.
send untagged packets, no data needed to configure
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiVoiceVlanAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
Sets Voice VLAN global administrative mode.
allow device to use its own configuration, no data needed to configure
voice VLAN disabled, no data needed to configure
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiVoiceVlanAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
Gets Voice VLAN global administrative mode.
use 802.1p priority tagging, priority data specified when configured
open_error_t openapiVoiceVlanPortAdminModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t mode, uint32_t dataValue)
Set the Voice VLAN interface mode.
OPEN_VOICE_VLAN_CONFIG_TYPE_t
open_error_t openapiVoiceVlanPortAdminModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_VOICE_VLAN_CONFIG_TYPE_t *mode)
Get the Voice VLAN interface mode.
tag with specified VLAN ID, VLAN ID specified when configured
open_error_t openapiVoiceVlanPortVlanIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *vlanId)
Get the Voice VLAN port VLAN ID.