openapi_dhcp_snooping.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2018-2024 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_dhcp_snooping.h
*
* @purpose   DHCP Snooping API
*
* @component OpEN
*
* @note  This code must not include any ICOS header files.
*
* @create    7/9/2018
*
* @end
*                                    
**********************************************************************/
#ifndef OPENAPI_DHCP_SNOOPING_H_INCLUDED
#define OPENAPI_DHCP_SNOOPING_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_DROP   = 0,  
  OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_KEEP   = 1,  
  OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_UPDATE = 2  
} OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t;

#define OPEN_DS_BINDING_TENTATIVE   0      
#define OPEN_DS_BINDING_STATIC      1      
#define OPEN_DS_BINDING_DYNAMIC     2      
#define OPEN_DS_BINDING_VOLATILE    3      
#define OPEN_MAC_ADDR_LEN      6
typedef struct OPEN_DHCP_SNOOP_BINDING_s
{
  unsigned char macAddr[OPEN_MAC_ADDR_LEN]; 
  unsigned short vlanId;               
  uint32_t ipAddr;                     
  uint32_t intIfNum;                   
  uint32_t remLease;                   
  uint32_t allottedLeaseTime;          
  uint32_t bindingType;                
} OPEN_DHCP_SNOOP_BINDING_t;

typedef struct OPEN_DHCP_V6_SNOOP_BINDING_s
{
  unsigned char macAddr[OPEN_MAC_ADDR_LEN]; 
  unsigned short vlanId;               
  open_in6_addr_t ipAddr;              
  uint32_t intIfNum;                   
  uint32_t remLease;                   
  uint32_t allottedLeaseTime;          
  uint32_t bindingType;                
} OPEN_DHCP_V6_SNOOP_BINDING_t;

#define OPEN_DS_CID_MAC_VERIFY                1
#define OPEN_DS_CID_INTF_MISMATCH             2
#define OPEN_DS_CID_UNTRUSTED_SRVR_MSG        3

#define OPEN_DS_DB_MIN_STORE_INTERVAL 15 
#define OPEN_DS_DB_MAX_STORE_INTERVAL 86400 

#define OPEN_DS_RATE_LIMIT_MIN                0
#define OPEN_DS_RATE_LIMIT_MAX              300
#define OPEN_DS_RATE_LIMIT_DEFAULT           -1 /* rate-limit disabled */
#define OPEN_DS_BURST_INTERVAL_MIN            1
#define OPEN_DS_BURST_INTERVAL_MAX           15
#define OPEN_DS_BURST_INTERVAL_DEFAULT       -1 /* No burst interval by default */
/*****************************************************************/
open_error_t openapiDhcpSnoopingAdminModeGet(openapiClientHandle_t *client_handle,
                                             OPEN_AF_t family,
                                             OPEN_CONTROL_t *adminMode);

/*****************************************************************/
open_error_t openapiDhcpSnoopingVerifySourceMacGet(openapiClientHandle_t *client_handle,
                                                   OPEN_AF_t family,
                                                   OPEN_CONTROL_t *sourceMacVerify);

/*****************************************************************/
open_error_t openapiDhcpSnoopingEnabledVlanRangeNextGet(openapiClientHandle_t *client_handle,
                                                        OPEN_AF_t family,
                                                        uint32_t *vlanStart,
                                                        uint32_t *vlanEnd);

/*****************************************************************/
open_error_t openapiDhcpSnoopingPortEnabledGet(openapiClientHandle_t *client_handle,
                                               OPEN_AF_t family,
                                               uint32_t ifNum, 
                                               OPEN_CONTROL_t *enabled);

/*****************************************************************/
open_error_t openapiDhcpSnoopingIntfTrustedGet(openapiClientHandle_t *client_handle,
                                               OPEN_AF_t family,
                                               uint32_t ifNum, 
                                               OPEN_BOOL_t *trusted);

/*****************************************************************/
open_error_t openapiDhcpSnoopingIntfLoggedGet(openapiClientHandle_t *client_handle,
                                              OPEN_AF_t family,
                                              uint32_t ifNum, 
                                              OPEN_BOOL_t *logged);

/*****************************************************************/
open_error_t openapiDhcpSnoopingDbFileNameMaxLengthGet(openapiClientHandle_t *client_handle, uint32_t *len);

/*****************************************************************/
open_error_t openapiDhcpSnoopingDbFileNameGet(openapiClientHandle_t *client_handle,
                                              OPEN_AF_t family,
                                              open_buffdesc *fileName);

/*****************************************************************/
open_error_t openapiDhcpSnoopingDbIpAddressGet(openapiClientHandle_t *client_handle,
                                               OPEN_AF_t family,
                                               open_inet_addr_t *addr);

/*****************************************************************/
open_error_t openapiDhcpSnoopingDbWriteDelayGet(openapiClientHandle_t *client_handle,
                                                OPEN_AF_t family,
                                                uint32_t *delay);

/*****************************************************************/
open_error_t openapiDsL2RelayAdminModeGet(openapiClientHandle_t *client_handle,
                                          OPEN_CONTROL_t *adminMode);

/*****************************************************************/
open_error_t openapiDsL2RelayAdminModeSet(openapiClientHandle_t *client_handle,
                                          OPEN_CONTROL_t adminMode);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfModeGet(openapiClientHandle_t *client_handle,
                                         uint32_t ifNum, 
                                         OPEN_CONTROL_t *intfMode);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfModeSet (openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, 
                                          OPEN_CONTROL_t intfMode);

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

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

/*****************************************************************/
open_error_t openapiDsL2RelayVlanModeGet(openapiClientHandle_t *client_handle,
                                         uint32_t vlanNum, 
                                         OPEN_CONTROL_t *l2RelayMode);

/*****************************************************************/
open_error_t openapiDsL2RelayVlanModeSet (openapiClientHandle_t *client_handle,
                                          uint32_t vlanNum, 
                                          OPEN_CONTROL_t l2RelayMode);

/*****************************************************************/
open_error_t openapiDsL2RelayVlanRangeModeSet (openapiClientHandle_t *client_handle,
                                               uint32_t vlanStart, uint32_t vlanEnd,
                                               OPEN_CONTROL_t l2RelayMode);

/*****************************************************************/
open_error_t openapiDsL2RelayCircuitIdGet(openapiClientHandle_t *client_handle,
                                          uint32_t vlanNum, 
                                          OPEN_CONTROL_t *circuitIdMode);

/*****************************************************************/
open_error_t openapiDsL2RelayCircuitIdSet (openapiClientHandle_t *client_handle,
                                           uint32_t  vlanNum, 
                                           OPEN_CONTROL_t circuitIdMode);

/*****************************************************************/
open_error_t openapiDsL2RelayVlanRangeCircuitIdSet (openapiClientHandle_t *client_handle,
                                                    uint32_t vlanStart, 
                                                    uint32_t vlanEnd,
                                                    OPEN_CONTROL_t circuitIdMode);

/*****************************************************************/
open_error_t openapiDsL2RelayRemoteIdGet(openapiClientHandle_t *client_handle,
                                         uint32_t vlanNum, 
                                         open_buffdesc *remoteId);

/*****************************************************************/
open_error_t openapiDsL2RelayRemoteIdSet(openapiClientHandle_t *client_handle,
                                         uint32_t vlanNum, 
                                         open_buffdesc *remoteId);

/*****************************************************************/
open_error_t openapiDsL2RelayVlanRangeRemoteIdSet(openapiClientHandle_t *client_handle,
                                                  uint32_t vlanStart, 
                                                  uint32_t vlanEnd, 
                                                  open_buffdesc *remoteId);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionModeGet (openapiClientHandle_t *client_handle,
                                                  uint32_t ifNum,
                                                  open_buffdesc *subscriptionName,
                                                  OPEN_CONTROL_t *l2RelaySubMode);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionModeSet (openapiClientHandle_t *client_handle,
                                                  uint32_t ifNum,
                                                  open_buffdesc *subscriptionName,
                                                  OPEN_CONTROL_t l2RelaySubMode);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionCircuitIdModeGet (openapiClientHandle_t *client_handle,
                                                           uint32_t ifNum,
                                                           open_buffdesc *subscriptionName,
                                                           OPEN_CONTROL_t *l2RelayCIdMode);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionCircuitIdModeSet (openapiClientHandle_t *client_handle,
                                                           uint32_t ifNum,
                                                           open_buffdesc *subscriptionName,
                                                           OPEN_CONTROL_t l2RelayCIdMode);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionRemoteIdGet (openapiClientHandle_t *client_handle,
                                                      uint32_t ifNum,
                                                      open_buffdesc *subscriptionName,
                                                      open_buffdesc *remoteId);

/*****************************************************************/
open_error_t openapiDsL2RelaySubscriptionRemoteIdSet (openapiClientHandle_t *client_handle,
                                                      uint32_t ifNum,
                                                      open_buffdesc *subscriptionName,
                                                      open_buffdesc *remoteId);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfStatsGet (openapiClientHandle_t *client_handle,
                                           uint32_t ifNum,
                                           uint32_t *untrustedSrvMsgsWithOpt82,
                                           uint32_t *untrustedCliMsgsWithOpt82, 
                                           uint32_t *trustedSrvMsgsWithoutOpt82,
                                           uint32_t *trustedCliMsgsWithoutOpt82,
                                           uint32_t *trustedSrvMsgsWithOpt82,
                                           uint32_t *trustedCliMsgsWithOpt82);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfStatsClear (openapiClientHandle_t *client_handle,
                                             uint32_t ifNum);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfTrustNoOption82ActionGet (openapiClientHandle_t *client_handle,
                                                           uint32_t ifNum,
                                                           OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t *action);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfTrustNoOption82ActionSet (openapiClientHandle_t *client_handle,
                                                           uint32_t ifNum,
                                                           OPEN_DHCP_L2RELAY_NO_OPTION_82_ACTION_t action);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfCircuitIdStringGet (openapiClientHandle_t *client_handle,
                                                     uint32_t intIfNum,
                                                     open_buffdesc *circuitId);

/*****************************************************************/
open_error_t openapiDsL2RelayIntfCircuitIdStringSet (openapiClientHandle_t *client_handle,
                                                     uint32_t intIfNum,
                                                     open_buffdesc *circuitId);

/*************************************************************************/
open_error_t openapiDsIntfRateLimitGet(openapiClientHandle_t *client_handle, 
                                       OPEN_AF_t family, uint32_t ifNum, 
                                       int32_t *rate);

/*************************************************************************/
open_error_t openapiDsIntfRateLimitSet(openapiClientHandle_t *client_handle, 
                                       OPEN_AF_t family, uint32_t ifNum, 
                                       int32_t rate);

/*************************************************************************/
open_error_t openapiDsIntfBurstIntervalGet(openapiClientHandle_t *client_handle, 
                                           OPEN_AF_t family, uint32_t ifNum,
                                           int32_t *interval);

/*************************************************************************/
open_error_t openapiDsIntfBurstIntervalSet(openapiClientHandle_t *client_handle, 
                                           OPEN_AF_t family, uint32_t ifNum, 
                                           int32_t interval);

/*************************************************************************/
open_error_t openapiDsStaticBindingCountGet(openapiClientHandle_t *client_handle, 
                                            OPEN_AF_t family, uint32_t *count);

/*************************************************************************/
open_error_t openapiDsBindingGet(openapiClientHandle_t *client_handle, 
                                 OPEN_DHCP_SNOOP_BINDING_t *dsBinding);

/*************************************************************************/
open_error_t openapiDsBindingGetNext(openapiClientHandle_t *client_handle, 
                                     OPEN_DHCP_SNOOP_BINDING_t *dsBinding, 
                                     OPEN_DHCP_SNOOP_BINDING_t *dsBindingNext);

/*************************************************************************/
open_error_t openapiDsDbIpAddrGet(openapiClientHandle_t *client_handle, 
                                  OPEN_AF_t family, uint32_t *ipAddr);

/*************************************************************************/
open_error_t openapiDsDbIpAddrSet(openapiClientHandle_t *client_handle, 
                                  OPEN_AF_t family, uint32_t ipAddr);

/*************************************************************************/
open_error_t openapiDsDbFileNameGet(openapiClientHandle_t *client_handle, 
                                    OPEN_AF_t family, open_buffdesc *fileName);

/*************************************************************************/
open_error_t openapiDsDbFileNameSet(openapiClientHandle_t *client_handle, 
                                    OPEN_AF_t family, open_buffdesc *fileName);

/*************************************************************************/
open_error_t openapiDsDbStoreIntervalSet(openapiClientHandle_t *client_handle, 
                                         OPEN_AF_t family, uint32_t interval);

/*************************************************************************/
open_error_t openapiDsIntfStatsGet(openapiClientHandle_t *client_handle, 
                                   OPEN_AF_t family, uint32_t ifNum, 
                                   uint32_t counterId, uint32_t *value);

/*************************************************************************/
open_error_t openapiDsBindingClear(openapiClientHandle_t *client_handle, 
                                   OPEN_AF_t family, uint32_t ifNum, 
                                   OPEN_BOOL_t clearStaticFlag);

/*************************************************************************/
open_error_t openapiDsAdminModeSet(openapiClientHandle_t *client_handle, 
                                   OPEN_AF_t family, uint32_t mode);

/*************************************************************************/
open_error_t openapiDsVerifyMacSet(openapiClientHandle_t *client_handle, 
                                   OPEN_AF_t family, OPEN_BOOL_t status);

/*************************************************************************/
open_error_t openapiDsVlanConfigGet(openapiClientHandle_t *client_handle, 
                                    OPEN_AF_t family, uint32_t vlanId, 
                                    uint32_t *mode);

/*************************************************************************/
open_error_t openapiDsVlanConfigSet(openapiClientHandle_t *client_handle, 
                                    OPEN_AF_t family, uint32_t vlanStart,
                                    uint32_t vlanEnd, uint32_t mode);

/*************************************************************************/
open_error_t openapiDsIntfTrustSet(openapiClientHandle_t *client_handle, 
                                   OPEN_AF_t family, uint32_t ifNum, 
                                   OPEN_BOOL_t trustMode);

/*************************************************************************/
open_error_t openapiDsIntfLogInvalidSet(openapiClientHandle_t *client_handle, 
                                        OPEN_AF_t family, uint32_t ifNum, 
                                        OPEN_BOOL_t logMode);

/*************************************************************************/
open_error_t openapiDsIpv6BindingGet(openapiClientHandle_t *client_handle, 
                                     OPEN_DHCP_V6_SNOOP_BINDING_t *dsBinding);

/*************************************************************************/
open_error_t openapiDsIpv6BindingGetNext(openapiClientHandle_t *client_handle, 
                                         OPEN_DHCP_V6_SNOOP_BINDING_t *dsBinding, 
                                         OPEN_DHCP_V6_SNOOP_BINDING_t *dsBindingNext);

/*************************************************************************/
open_error_t openapiDsIpStaticBindingAdd(openapiClientHandle_t *client_handle, 
                                         OPEN_AF_t family, open_buffdesc *macAddr,
                                         open_buffdesc *ipAddr, uint32_t vlanId, 
                                         uint32_t ifNum);

/*************************************************************************/
open_error_t openapiDsIpStaticBindingRemove(openapiClientHandle_t *client_handle, 
                                            OPEN_AF_t family, 
                                            open_buffdesc *macAddr);

/*************************************************************************/
open_error_t openapiDsIpVolatileBindingAdd(openapiClientHandle_t *client_handle, 
                                         OPEN_AF_t family, open_buffdesc *macAddr,
                                         open_buffdesc *ipAddr, uint32_t vlanId, 
                                         uint32_t ifNum, uint32_t leaseTime);

#endif /* OPENAPI_DHCP_SNOOPING_H_INCLUDED */