Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_storm_control.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_storm_control.h
28 *
29 * @purpose Storm Control Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 30/01/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_STORM_CONTROL_H_INCLUDED
39 #define OPENAPI_STORM_CONTROL_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
51 
53 typedef enum
54 {
55  OPEN_POLICY_PORT_ACTION_NONE = 0,
60 
61 /*****************************************************************/
82  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
83  OPEN_CONTROL_t state);
84 
85 /*****************************************************************/
101  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
102  OPEN_CONTROL_t *state);
103 
104 /*****************************************************************/
126  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
127  OPEN_RATE_UNIT_t rateUnit,
128  uint32_t threshold);
129 
130 /*****************************************************************/
149  OPEN_STORM_CTRL_MODE_t stormCtrlMode);
150 
151 /*****************************************************************/
168  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
169  OPEN_RATE_UNIT_t *rateUnit,
170  uint32_t *threshold);
171 
172 /*****************************************************************/
191  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
192  uint32_t interface,
193  OPEN_CONTROL_t state);
194 
195 /*****************************************************************/
213  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
214  uint32_t interface,
215  OPEN_CONTROL_t *state);
216 
217 /*****************************************************************/
244  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
245  uint32_t interface,
246  OPEN_RATE_UNIT_t rateUnit,
247  uint32_t threshold);
248 
249 /*****************************************************************/
270  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
271  uint32_t interface);
272 
273 /*****************************************************************/
293  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
294  uint32_t interface,
295  OPEN_RATE_UNIT_t *rateUnit,
296  uint32_t *threshold);
297 
298 /*****************************************************************/
316  OPEN_RATE_UNIT_t rateUnit,
317  uint32_t *minThreshold,
318  uint32_t *maxThreshold);
319 
320 /*****************************************************************/
339  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
341 
342 /*****************************************************************/
358  OPEN_STORM_CTRL_MODE_t stormCtrlMode,
359  OPEN_POLICY_PORT_ACTION_t *action);
360 
361 #endif
362 
open_error_t openapiStormControlThresholdDefaultSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode)
Set the storm control threshold and rate unit on all the interfaces to default values.
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiStormControlIntfModeGet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_CONTROL_t *state)
Get the state of storm control mode on an interface.
open_error_t openapiStormControlIntfThresholdSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_RATE_UNIT_t rateUnit, uint32_t threshold)
Set the storm control mode and threshold on an interface.
OPEN_RATE_UNIT_t
OpEN uses this enumeration to define rate units.
Storm Control broadcast mode.
open_error_t openapiStormControlActionGet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_POLICY_PORT_ACTION_t *action)
Get the global storm control action.
open_error_t openapiStormControlActionSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_POLICY_PORT_ACTION_t action)
Set the storm control action globally and on all the interfaces.
open_error_t openapiStormControlThresholdGet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_RATE_UNIT_t *rateUnit, uint32_t *threshold)
Get the global storm control threshold value and rate unit.
open_error_t openapiStormControlModeGet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_CONTROL_t *state)
Get the state of global storm control mode.
open_error_t openapiStormControlThresholdSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_RATE_UNIT_t rateUnit, uint32_t threshold)
Set the storm control threshold and rate unit on all the interfaces.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
open_error_t openapiStormControlIntfThresholdDefaultSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface)
Set the storm control threshold value and rate unit to default on an interface.
open_error_t openapiStormControlIntfThresholdGet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_RATE_UNIT_t *rateUnit, uint32_t *threshold)
Get the storm control threshold on an interface.
open_error_t openapiStormControlThresholdMinMaxGet(openapiClientHandle_t *client_handle, OPEN_RATE_UNIT_t rateUnit, uint32_t *minThreshold, uint32_t *maxThreshold)
Get the storm control minimum and maximum threshold values based on the rate.
open_error_t openapiStormControlIntfModeSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, uint32_t interface, OPEN_CONTROL_t state)
Set the state of storm control mode on an interface.
OPEN_POLICY_PORT_ACTION_t
OpEN uses this enumeration to define Storm Control actions.
open_error_t openapiStormControlModeSet(openapiClientHandle_t *client_handle, OPEN_STORM_CTRL_MODE_t stormCtrlMode, OPEN_CONTROL_t state)
Set the state of storm control mode globally and on all the interfaces.
Storm Control mode none.
Storm Control multicast mode.
OPEN_STORM_CTRL_MODE_t
OpEN uses this enumeration to define Storm Control modes.
Storm Control unicast mode.