openapi_storm_control.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_storm_control.h
*
* @purpose   Storm Control Configuration and Status 
*
* @component OPEN
*
* @create    30/01/2013
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_STORM_CONTROL_H_INCLUDED
#define OPENAPI_STORM_CONTROL_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_STORM_CTRL_MODE_NONE      = 0, 
  OPEN_STORM_CTRL_MODE_UNICAST   = 1, 
  OPEN_STORM_CTRL_MODE_BROADCAST = 2, 
  OPEN_STORM_CTRL_MODE_MULTICAST = 3  
} OPEN_STORM_CTRL_MODE_t;

typedef enum
{
  OPEN_POLICY_PORT_ACTION_NONE      = 0,
  OPEN_POLICY_PORT_ACTION_SHUTDOWN  = 1,  
  OPEN_POLICY_PORT_ACTION_RATELIMIT = 2,  
  OPEN_POLICY_PORT_ACTION_TRAP      = 3   
} OPEN_POLICY_PORT_ACTION_t;


typedef enum
{
  OPEN_STORMCONTROL_BCAST = 0x01,
  OPEN_STORMCONTROL_MCAST = 0x02,
  OPEN_STORMCONTROL_UCAST = 0x04,
} OPEN_STORMCONTROL_TYPE;

/*****************************************************************/
open_error_t openapiStormControlModeSet(openapiClientHandle_t *client_handle,
                                        OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                        OPEN_CONTROL_t state);

/*****************************************************************/
open_error_t openapiStormControlModeGet(openapiClientHandle_t *client_handle,
                                        OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                        OPEN_CONTROL_t *state);

/*****************************************************************/
open_error_t openapiStormControlThresholdSet(openapiClientHandle_t *client_handle,
                                             OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                             OPEN_RATE_UNIT_t rateUnit,
                                             uint32_t threshold);

/*****************************************************************/
open_error_t openapiStormControlThresholdDefaultSet(openapiClientHandle_t *client_handle,
                                                    OPEN_STORM_CTRL_MODE_t stormCtrlMode);

/*****************************************************************/
open_error_t openapiStormControlThresholdGet(openapiClientHandle_t *client_handle,
                                             OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                             OPEN_RATE_UNIT_t *rateUnit,
                                             uint32_t *threshold);

/*****************************************************************/
open_error_t openapiStormControlIntfModeSet(openapiClientHandle_t *client_handle,
                                            OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                            uint32_t interface,
                                            OPEN_CONTROL_t state);

/*****************************************************************/
open_error_t openapiStormControlIntfModeGet(openapiClientHandle_t *client_handle,
                                            OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                            uint32_t interface,
                                            OPEN_CONTROL_t *state);

/*****************************************************************/
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);

/*****************************************************************/
open_error_t openapiStormControlIntfThresholdDefaultSet(openapiClientHandle_t *client_handle,
                                                        OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                                        uint32_t 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);

/*****************************************************************/
open_error_t openapiStormControlThresholdMinMaxGet(openapiClientHandle_t *client_handle,
                                                   OPEN_RATE_UNIT_t rateUnit,
                                                   uint32_t *minThreshold,
                                                   uint32_t *maxThreshold);

/*****************************************************************/
open_error_t openapiStormControlActionSet(openapiClientHandle_t *client_handle,
                                          OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                          OPEN_POLICY_PORT_ACTION_t action);

/*****************************************************************/
open_error_t openapiStormControlActionGet(openapiClientHandle_t *client_handle,
                                          OPEN_STORM_CTRL_MODE_t stormCtrlMode,
                                          OPEN_POLICY_PORT_ACTION_t *action);

/*************************************************************************/
open_error_t 
openapiSwDevCtrlBcastStormControlActionIntfGet(openapiClientHandle_t *client_handle, 
                                               uint32_t interface, 
                                               OPEN_POLICY_PORT_ACTION_t *action);

/*************************************************************************/
open_error_t 
openapiSwDevCtrlStormControlActionIntfGet(openapiClientHandle_t *client_handle, 
                                          uint32_t interface, uint32_t type, 
                                          OPEN_POLICY_PORT_ACTION_t *action);

/*************************************************************************/
open_error_t 
openapiSwDevCtrlBcastStormControlActionIntfSet(openapiClientHandle_t *client_handle, 
                                               uint32_t interface, 
                                               OPEN_POLICY_PORT_ACTION_t action);

/*************************************************************************/
open_error_t 
openapiSwDevCtrlMcastStormControlActionIntfSet(openapiClientHandle_t *client_handle, 
                                               uint32_t interface, 
                                               OPEN_POLICY_PORT_ACTION_t action);

/*************************************************************************/
open_error_t 
openapiSwDevCtrlUcastStormControlActionIntfSet(openapiClientHandle_t *client_handle, 
                                               uint32_t interface, 
                                               OPEN_POLICY_PORT_ACTION_t action);

#endif