openapi_dynamic_arp_inspection.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.
*
*  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_dynamic_arp_inspection.h
*
* @purpose   Dynamic ARP table configuration and status.
*
* @component OPEN
*
* @create    12/16/2016
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED
#define OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED

#include <stdio.h>
#include <stddef.h>
#include <sys/un.h>

#include "openapi_common.h"

#define OPEN_ARP_ACL_NAME_LEN_MIN 1      
#define OPEN_ARP_ACL_NAME_LEN_MAX 32     
typedef enum
{
  OPEN_ARP_ACL_RULE_ACTION_PERMIT = 1, 
  OPEN_ARP_ACL_RULE_ACTION_DENY   = 2  
} OPEN_ARP_ACL_RULE_ACTION_t;

#define OPEN_DAI_BURST_INTERVAL_MIN  1
#define OPEN_DAI_BURST_INTERVAL_MAX  15

#define OPEN_DAI_RATE_LIMIT_MIN      0 
#define OPEN_DAI_RATE_LIMIT_MAX      300

typedef struct DAI_VLAN_STATS_S 
{
  uint32_t forwarded;
  uint32_t dropped;
  uint32_t dhcpDrops;
  uint32_t dhcpPermits;
  uint32_t aclDrops;
  uint32_t aclPermits;
  uint32_t aclDenials;
  uint32_t sMacFailures;
  uint32_t dMacFailures;
  uint32_t ipValidFailures;
} OPEN_DAI_VLAN_STATS_t;

/*****************************************************************/
open_error_t openapiArpAclGet(openapiClientHandle_t *client_handle,
                              open_buffdesc *aclName);

/*****************************************************************/
open_error_t openapiArpAclRuleNextGet(openapiClientHandle_t *client_handle,
                                        open_buffdesc *aclName, 
                                        open_inet_addr_t ipAddr, 
                                        open_buffdesc *macAddr,
                                        open_inet_addr_t *ipAddrNext, 
                                        open_buffdesc *macAddrNext);

/*****************************************************************/
open_error_t openapiArpAclRuleNextGetV2(openapiClientHandle_t *client_handle,
                                        open_buffdesc *aclName, 
                                        uint32_t seqNo, 
                                        uint32_t *seqNoNext, 
                                        open_inet_addr_t *ipAddrNext, 
                                        open_buffdesc *macAddrNext,
                                        OPEN_ARP_ACL_RULE_ACTION_t *actionNext);

/*****************************************************************/
open_error_t openapiArpAclNextGet(openapiClientHandle_t *client_handle,
                                  open_buffdesc *aclName, 
                                  open_buffdesc *aclNameNext);

/*****************************************************************/
open_error_t openapiDaiSourceMacValidateModeSet(openapiClientHandle_t *client_handle,
                                                OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiDaiSourceMacValidateModeGet(openapiClientHandle_t *client_handle,
                                                OPEN_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDaiDestMacValidateModeSet(openapiClientHandle_t *client_handle,
                                              OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiDaiDestMacValidateModeGet(openapiClientHandle_t *client_handle,
                                              OPEN_CONTROL_t *mode);

/*****************************************************************/
open_error_t openapiDaiIpAddrValidateModeSet(openapiClientHandle_t *client_handle,
                                             OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiDaiIpAddrValidateModeGet(openapiClientHandle_t *client_handle,
                                             OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiDaiIntfTrustGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
                                    OPEN_BOOL_t *trustMode);

/*************************************************************************/
open_error_t openapiDaiIntfTrustSet(openapiClientHandle_t *client_handle, uint32_t ifNum, 
                                    OPEN_BOOL_t trustMode);

/*************************************************************************/
open_error_t openapiDaiIntfRateLimitGet(openapiClientHandle_t *client_handle, 
                                        uint32_t ifNum, int32_t *rate);

/*************************************************************************/
open_error_t openapiDaiIntfRateLimitSet(openapiClientHandle_t *client_handle, 
                                        uint32_t ifNum, int32_t rate);

/*************************************************************************/
open_error_t openapiDaiIntfBurstIntervalGet(openapiClientHandle_t *client_handle, 
                                            uint32_t ifNum, int32_t *burstInterval);

/*************************************************************************/
open_error_t openapiDaiIntfBurstIntervalSet(openapiClientHandle_t *client_handle, 
                                            uint32_t ifNum, int32_t burstInterval);

/*************************************************************************/
open_error_t openapiDaiVlanStatsGet(openapiClientHandle_t *client_handle, uint32_t vlanId, 
                                    OPEN_DAI_VLAN_STATS_t *vlanStats);

/*************************************************************************/
open_error_t openapiDaiVlanNextGet(openapiClientHandle_t *client_handle, 
                                   uint32_t vlanId, uint32_t *nextVlan);

/*************************************************************************/
open_error_t openapiDaiVlanEnableGet(openapiClientHandle_t *client_handle, 
                                     uint32_t vlanId, uint32_t *val);

/*************************************************************************/
open_error_t openapiDaiVlanEnableSet(openapiClientHandle_t *client_handle, 
                                     uint32_t vlanId, uint32_t val);

/*************************************************************************/
open_error_t openapiDaiVlanLoggingEnableGet(openapiClientHandle_t *client_handle, 
                                            uint32_t vlanId, uint32_t *val);

/*************************************************************************/
open_error_t openapiDaiVlanLoggingEnableSet(openapiClientHandle_t *client_handle, 
                                            uint32_t vlanId, uint32_t val);

/*************************************************************************/
open_error_t openapiDaiVlanArpAclStaticFlagGet(openapiClientHandle_t *client_handle, 
                                               uint32_t vlanId, 
                                               uint32_t *staticFlag);

/*************************************************************************/
open_error_t openapiDaiVlanArpAclStaticFlagSet(openapiClientHandle_t *client_handle, 
                                               uint32_t vlanId, 
                                               uint32_t staticFlag);

/*************************************************************************/
open_error_t openapiDaiVlanStatsClear(openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiArpAclRuleAdd(openapiClientHandle_t *client_handle, 
                                  open_buffdesc *bufd, uint32_t seqNo, 
                                  uint32_t ipAddr, open_buffdesc *macAddr, 
                                  OPEN_ARP_ACL_RULE_ACTION_t action);

/*************************************************************************/
open_error_t openapiArpAclRuleDelete(openapiClientHandle_t *client_handle, 
                                     open_buffdesc *bufd, uint32_t seqNo);

/*************************************************************************/
open_error_t openapiDaiVlanArpAclGet(openapiClientHandle_t *client_handle, 
                                     uint32_t vlanId, open_buffdesc *aclName);


/*************************************************************************/
open_error_t openapiDaiVlanARPAclRangeSet(openapiClientHandle_t *client_handle, 
                                          open_buffdesc *aclName, 
                                          uint32_t vlanStart, uint32_t vlanEnd, 
                                          uint32_t val, uint32_t staticFlag);

/*************************************************************************/
open_error_t openapiDaiVlanArpAclSet(openapiClientHandle_t *client_handle, 
                                     uint32_t vlanId, open_buffdesc *aclName);

/*************************************************************************/
open_error_t openapiArpAclCreate(openapiClientHandle_t *client_handle, 
                                 open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiArpAclDelete(openapiClientHandle_t *client_handle, 
                                 open_buffdesc *bufd);


#endif /* OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED */