Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_pbvlan.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_pbvlan.h
28 *
29 * @purpose Provide an external API to applications in other processes
30 * accessing Protocol-Based VLAN configuration.
31 *
32 * @component OpEN
33 *
34 * @note This code implements the RPC accessible function calls
35 * for the Protocol-Based VLAN configuration.
36 *
37 * Type translation between external and internal name spaces
38 * occurs here.
39 *
40 * @create 04/20/2016
41 *
42 * @end
43 *
44 **********************************************************************/
45 #ifndef OPENAPI_PBVLAN_H_INCLUDED
46 #define OPENAPI_PBVLAN_H_INCLUDED
47 
48 #define OPENAPI_PBVLAN_MIN_NUM_GROUPS 1
49 #define OPENAPI_PBVLAN_MAX_NUM_GROUPS 128
50 #define OPENAPI_PBVLAN_MIN_GROUP_NAME 1
51 #define OPENAPI_PBVLAN_MAX_GROUP_NAME 16
52 #define OPENAPI_PBVLAN_MAX_CONFIGURABLE_PROTOCOLS 16
55 typedef enum
56 {
57  OPENAPI_PBVLAN_STR_PROT_TYPE = 0,
58  OPENAPI_PBVLAN_NUM_PROT_TYPE = 1
59 } OPENAPI_PBVLAN_PROT_TYPE_t;
60 
61 /*****************************************************************/
79 open_error_t openapiPbVlanGroupCreate(openapiClientHandle_t *client_handle,
80  uint32_t groupId);
81 
82 /*****************************************************************/
100 open_error_t openapiPbVlanGroupDelete(openapiClientHandle_t *client_handle,
101  uint32_t groupId);
102 
103 /*****************************************************************/
116 open_error_t openapiPbVlanGroupGetFirst(openapiClientHandle_t *client_handle,
117  uint32_t *groupId);
118 
119 /*****************************************************************/
136 open_error_t openapiPbVlanGroupGetNext(openapiClientHandle_t *client_handle,
137  uint32_t groupId,
138  uint32_t *nextGroupId);
139 
140 /****************************************************************************/
161 open_error_t openapiPbVlanGroupNameSet(openapiClientHandle_t *client_handle,
162  uint32_t groupId,
163  open_buffdesc *groupName);
164 
165 /****************************************************************************/
183 open_error_t openapiPbVlanGroupNameGet(openapiClientHandle_t *client_handle,
184  uint32_t groupId,
185  open_buffdesc *groupName);
186 
187 /****************************************************************************/
204 open_error_t openapiPbVlanGroupIdGet(openapiClientHandle_t *client_handle,
205  open_buffdesc *groupName,
206  uint32_t *groupId);
207 
208 /*****************************************************************/
229 open_error_t openapiPbVlanGroupVlanIDAdd(openapiClientHandle_t *client_handle,
230  uint32_t groupId,
231  uint32_t vlanId);
232 
233 /*****************************************************************/
255 open_error_t openapiPbVlanGroupVlanIDDelete(openapiClientHandle_t *client_handle,
256  uint32_t groupId,
257  uint32_t vlanId);
258 
259 /****************************************************************************/
276 open_error_t openapiPbVlanGroupVlanIDGet(openapiClientHandle_t *client_handle,
277  uint32_t groupId,
278  uint32_t *vlanId);
279 
280 /*****************************************************************/
308 open_error_t openapiPbVlanGroupProtocolAdd(openapiClientHandle_t *client_handle,
309  uint32_t groupId,
310  uint32_t prot,
311  OPENAPI_PBVLAN_PROT_TYPE_t protType);
312 
313 /*****************************************************************/
335 open_error_t openapiPbVlanGroupProtocolDelete(openapiClientHandle_t *client_handle,
336  uint32_t groupId,
337  uint32_t prot);
338 
339 /*****************************************************************/
358 open_error_t openapiPbVlanGroupProtocolGet(openapiClientHandle_t *client_handle,
359  uint32_t groupId,
360  open_buffdesc *protList);
361 
362 /*****************************************************************/
385 open_error_t openapiPbVlanGroupProtocolGetNext(openapiClientHandle_t *client_handle,
386  uint32_t groupId,
387  uint32_t prot,
388  uint32_t *nextProt);
389 
390 /*****************************************************************/
412 open_error_t openapiPbVlanGroupPortAdd(openapiClientHandle_t *client_handle,
413  uint32_t groupId,
414  uint32_t ifNum);
415 
416 /*****************************************************************/
439 open_error_t openapiPbVlanGroupPortDelete(openapiClientHandle_t *client_handle,
440  uint32_t groupId,
441  uint32_t ifNum);
442 
443 /*****************************************************************/
468 open_error_t openapiPbVlanGroupPortGetNext(openapiClientHandle_t *client_handle,
469  uint32_t groupId,
470  uint32_t ifNum,
471  uint32_t *nextIfNum);
472 
473 /*****************************************************************/
491 open_error_t openapiPbVlanIntfValidate(openapiClientHandle_t *client_handle,
492  uint32_t ifNum);
493 #endif /* OPENAPI_PBVLAN_H_INCLUDED */
494