Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_mvrp.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2020 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_mvrp.h
28 *
29 * @purpose MVRP Open API(s)
30 *
31 * @component OPEN
32 *
33 * @create 06/18/2020
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_MVRP_H_INCLUDED
39 #define OPENAPI_MVRP_H_INCLUDED
40 
41 #include "openapi_common.h"
42 #include "openapi_vlan.h"
43 
44 typedef enum
45 {
46  OPEN_MVRP_VLAN_REGISTERED = 0,
47  OPEN_MVRP_VLAN_DECLARED
48 } OPEN_MVRP_VLAN_TYPE_t;
49 
50 typedef enum
51 {
52  OPEN_MVRP_STATS_RX = 0,
53  OPEN_MVRP_STATS_RX_BAD_HEADER,
54  OPEN_MVRP_STATS_RX_BAD_FORMAT,
55  OPEN_MVRP_STATS_TX,
56  OPEN_MVRP_STATS_TX_FAILURE,
57  OPEN_MVRP_STATS_MSG,
58  OPEN_MVRP_STATS_REG_FAIL
59 } OPEN_MVRP_STATS_t;
60 
61 
62 /*************************************************************************/
78 open_error_t openapiMvrpModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);
79 
80 /*************************************************************************/
96 open_error_t openapiMvrpModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);
97 
98 /*************************************************************************/
113 open_error_t openapiMvrpPeriodicStateMachineModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);
114 
115 /*************************************************************************/
130 open_error_t openapiMvrpPeriodicStateMachineModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);
131 
132 /*************************************************************************/
149 open_error_t openapiMvrpIntfModeGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t *mode);
150 
151 /*************************************************************************/
168 open_error_t openapiMvrpIntfModeSet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_CONTROL_t mode);
169 
170 /*************************************************************************/
186 open_error_t openapiMvrpIsValidIntfGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *isValid);
187 
188 /*************************************************************************/
204 open_error_t openapiMvrpValidIntfNextGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIfNum);
205 
206 /*************************************************************************/
222 open_error_t openapiMvrpTrafficPduCounterGet(openapiClientHandle_t *client_handle, OPEN_MVRP_STATS_t type, uint32_t *counter);
223 
224 /*************************************************************************/
241 open_error_t openapiMvrpIntfTrafficPduCounterGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MVRP_STATS_t type, uint32_t *counter);
242 
243 /*************************************************************************/
262 open_error_t openapiMvrpVlanArrayGet(openapiClientHandle_t *client_handle, OPEN_MVRP_VLAN_TYPE_t vlanType, OPEN_VLAN_LIST_t *vlanList, uint32_t *count);
263 
264 /*************************************************************************/
284 open_error_t openapiMvrpIntfVlanArrayGet(openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_MVRP_VLAN_TYPE_t vlanType, OPEN_VLAN_LIST_t *vlanList, uint32_t *count);
285 
286 /*************************************************************************/
301 open_error_t openapiMvrpTrafficCountersPerIfClear(openapiClientHandle_t *client_handle, uint32_t intIfNum);
302 
303 /*************************************************************************/
317 open_error_t openapiMvrpTrafficGlobalCountersClear(openapiClientHandle_t *client_handle);
318 
319 /*************************************************************************/
333 open_error_t openapiMvrpTrafficCountersClear(openapiClientHandle_t *client_handle);
334 
335 #endif /* OPENAPI_MVRP_H_INCLUDED */
336