openapi_qos_auto_vlan.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2022-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_qos auto vlan.h
*
* @purpose   This code implements the OpEN QOS Auto VLAN APIs
*
* @component OPEN
*
* @create    09/07/2022
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_QOS_AUTO_VLAN_H_INCLUDED
#define OPENAPI_QOS_AUTO_VLAN_H_INCLUDED

#include "openapi_common.h" 

typedef enum
{
  OPEN_AUTO_VLAN_FIRST  = 0,
  OPEN_AUTO_VLAN_CAMERA = 0, 
  OPEN_AUTO_VLAN_WIFI,       
  OPEN_AUTO_VLAN_LAST
} OPEN_AUTO_VLAN_TYPES_t;

/* AUTO VLAN factory defaults */
#define OPEN_QOS_AUTO_VLAN_DYNAMIC_VLAN_SUPPORT              L7_FALSE
#define OPEN_DEFAULT_AUTO_CAMERA_STATUS                      OPEN_DISABLE
#define OPEN_DEFAULT_AUTO_CAMERA_VLAN                        0
#define OPEN_DEFAULT_AUTO_CAMERA_PRIORITY                    7 
   
#define OPEN_DEFAULT_AUTO_WIFI_STATUS                        OPEN_DISABLE
#define OPEN_DEFAULT_AUTO_WIFI_VLAN                          0
#define OPEN_DEFAULT_AUTO_WIFI_PRIORITY                      7 

#define OPEN_AUTO_VLAN_MAX_MAC_OUIS                          L7_AUTO_VLAN_MAX_MAC_OUIS
#define OPEN_AUTO_VLAN_FIRST_MAC_OUI_INDEX                   0
#define OPEN_AUTO_VLAN_OUI_LEN                               AUTO_VLAN_OUI_LEN
#define OPEN_AUTO_VLAN_OUI_DESC_STRINGLEN                    AUTO_VLAN_OUI_DESC_STRINGLEN
#define OPEN_AUTO_VLAN_OUI_STR_MAX_LEN                       9

/*************************************************************************/
open_error_t openapiQosAutoVlanGlobalModeGet(openapiClientHandle_t *client_handle, 
                                             OPEN_AUTO_VLAN_TYPES_t autoVlanType, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiQosAutoVlanGlobalModeSet(openapiClientHandle_t *client_handle, 
                                             OPEN_AUTO_VLAN_TYPES_t autoVlanType, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiQosAutoVlanIntfModeSet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                           uint32_t ifNum, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiQosAutoVlanIntfModeGet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                           uint32_t ifNum, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiQosAutoVlanIdSet(openapiClientHandle_t *client_handle, 
                                     OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t vlanId);

/*************************************************************************/
open_error_t openapiQosAutoVlanIdGet(openapiClientHandle_t *client_handle, 
                                     OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t *vlanId);

/*************************************************************************/
open_error_t openapiQosAutoVlanPrioritySet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                           uint32_t autoVlanPriority);

/*************************************************************************/
open_error_t openapiQosAutoVlanPriorityGet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t *autoVlanPriority);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiAdd(openapiClientHandle_t *client_handle, 
                                      OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                      open_buffdesc *autoVlanOui, open_buffdesc *autoOuiDesc);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiRemove(openapiClientHandle_t *client_handle, 
                                         OPEN_AUTO_VLAN_TYPES_t autoVlanType, open_buffdesc *autoVlanOui);

/*************************************************************************/
open_error_t openapiQosAutoVlanIndexOuiAdd(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t ouiIndex, 
                                           open_buffdesc *autoVlanOui, open_buffdesc *autoOuiDesc);

/*************************************************************************/
open_error_t openapiQosAutoVlanIndexOuiRemove(openapiClientHandle_t *client_handle, uint32_t ouiIndex);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiCountGet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t *autoVlanOuiCount);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiFirstEntryGet(openapiClientHandle_t *client_handle, 
                                                OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t *firstIndex);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiEntryNextGet(openapiClientHandle_t *client_handle, 
                                               OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                               uint32_t currentIndex, uint32_t *nextOuiIndex);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiEntryGet(openapiClientHandle_t *client_handle, 
                                           OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t currentIndex, 
                                           open_buffdesc *autoVlanOui, open_buffdesc *autoOuiDesc);

/*************************************************************************/
open_error_t openapiQosAutoVlanOuiDescGet(openapiClientHandle_t *client_handle, 
                                          OPEN_AUTO_VLAN_TYPES_t autoVlanType, 
                                          open_buffdesc *autoVlanOui, open_buffdesc *autoOuiDesc);

/*************************************************************************/
open_error_t openapiQoSAutoVlanIsValidIntf(openapiClientHandle_t *client_handle, 
                                           uint32_t ifNum, OPEN_BOOL_t *isValid);

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

/*************************************************************************/
open_error_t openapiQosAutoVlanValidIntfNextGet(openapiClientHandle_t *client_handle, 
                                                uint32_t prevIfNum, uint32_t *nextIfNum);

/*************************************************************************/
open_error_t openapiQosAutoVlanPortStatusGet(openapiClientHandle_t *client_handle, 
                                             OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t ifNum,        
                                             OPEN_CONTROL_t *status);

/*************************************************************************/
open_error_t openapiQosAutoVlanDetectedDevicesGet(openapiClientHandle_t *client_handle, 
                                                  OPEN_AUTO_VLAN_TYPES_t autoVlanType, uint32_t *count);


/*************************************************************************/
open_error_t openapiQosAutoVlanLearnedEntryNextGet(openapiClientHandle_t *client_handle,
                                                   uint32_t index,
                                                   open_buffdesc *autoVlanMac,
                                                   OPEN_AUTO_VLAN_TYPES_t *autoVlanType,
                                                   uint32_t *intIfNum,
                                                   uint32_t *nextIndex);
#endif /* OPENAPI_QOS_AUTO_VLAN_H_INCLUDED */