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 31     
typedef enum
{
  OPEN_ARP_ACL_RULE_ACTION_PERMIT = 1, 
  OPEN_ARP_ACL_RULE_ACTION_DENY   = 2  
} OPEN_ARP_ACL_RULE_ACTION_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);

#endif /* OPENAPI_DYNAMIC_ARP_INSPECTION_H_INCLUDED */