openapi_pbvlan.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_pbvlan.h
*
* @purpose   Provide an external API to applications in other processes
*            accessing Protocol-Based VLAN configuration.
*
* @component OpEN
*
* @note  This code implements the RPC accessible function calls
*            for the Protocol-Based VLAN configuration.
* 
*            Type translation between external and internal name spaces
*            occurs here.
*
* @create    04/20/2016
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_PBVLAN_H_INCLUDED
#define OPENAPI_PBVLAN_H_INCLUDED

#define OPENAPI_PBVLAN_MIN_NUM_GROUPS              1       
#define OPENAPI_PBVLAN_MAX_NUM_GROUPS              128     
#define OPENAPI_PBVLAN_MIN_GROUP_NAME              1       
#define OPENAPI_PBVLAN_MAX_GROUP_NAME              16     
#define OPENAPI_PBVLAN_MAX_CONFIGURABLE_PROTOCOLS  16      
#define OPEN_PB_VLAN_GROUP_PROTOCOL_HEX_IP      0x0800          
#define OPEN_PB_VLAN_GROUP_PROTOCOL_HEX_ARP     0x0806
#define OPEN_PB_VLAN_GROUP_PROTOCOL_HEX_IPX     0x8137
/*****************************************************************/
open_error_t openapiPbVlanGroupCreate(openapiClientHandle_t *client_handle,
                                      uint32_t groupId);

/*****************************************************************/
open_error_t openapiPbVlanGroupDelete(openapiClientHandle_t *client_handle,
                                      uint32_t groupId);

/*****************************************************************/
open_error_t openapiPbVlanGroupGetFirst(openapiClientHandle_t *client_handle,
                                        uint32_t *groupId);

/*****************************************************************/
open_error_t openapiPbVlanGroupGetNext(openapiClientHandle_t *client_handle,
                                       uint32_t groupId,
                                       uint32_t *nextGroupId);

/****************************************************************************/
open_error_t openapiPbVlanGroupNameSet(openapiClientHandle_t *client_handle,
                                       uint32_t groupId,
                                       open_buffdesc *groupName);

/****************************************************************************/
open_error_t openapiPbVlanGroupNameGet(openapiClientHandle_t *client_handle,
                                       uint32_t groupId,
                                       open_buffdesc *groupName);

/****************************************************************************/
open_error_t openapiPbVlanGroupIdGet(openapiClientHandle_t *client_handle,
                                     open_buffdesc *groupName,
                                     uint32_t *groupId);

/*****************************************************************/
open_error_t openapiPbVlanGroupVlanIDAdd(openapiClientHandle_t *client_handle,
                                         uint32_t groupId,
                                         uint32_t vlanId);

/*****************************************************************/
open_error_t openapiPbVlanGroupVlanIDDelete(openapiClientHandle_t *client_handle,
                                            uint32_t groupId,
                                            uint32_t vlanId);

/****************************************************************************/
open_error_t openapiPbVlanGroupVlanIDGet(openapiClientHandle_t *client_handle,
                                         uint32_t groupId,
                                         uint32_t *vlanId);

/*****************************************************************/
open_error_t openapiPbVlanGroupProtocolAdd(openapiClientHandle_t *client_handle,
                                           uint32_t groupId,
                                           uint32_t prot);

/*****************************************************************/
open_error_t openapiPbVlanGroupProtocolDelete(openapiClientHandle_t *client_handle,
                                              uint32_t groupId,
                                              uint32_t prot);

/*****************************************************************/
open_error_t openapiPbVlanGroupProtocolGet(openapiClientHandle_t *client_handle,
                                           uint32_t groupId,
                                           open_buffdesc *protList);

/*****************************************************************/
open_error_t openapiPbVlanGroupProtocolGetNext(openapiClientHandle_t *client_handle,
                                               uint32_t groupId,
                                               uint32_t prot,
                                               uint32_t *nextProt);

/*****************************************************************/
open_error_t openapiPbVlanGroupPortAdd(openapiClientHandle_t *client_handle,
                                       uint32_t groupId,
                                       uint32_t ifNum);

/*****************************************************************/
open_error_t openapiPbVlanGroupPortDelete(openapiClientHandle_t *client_handle,
                                          uint32_t groupId,
                                          uint32_t ifNum);

/*****************************************************************/
open_error_t openapiPbVlanGroupPortGetNext(openapiClientHandle_t *client_handle,
                                           uint32_t groupId,
                                           uint32_t ifNum,
                                           uint32_t *nextIfNum);

/*****************************************************************/
open_error_t openapiPbVlanIntfValidate(openapiClientHandle_t *client_handle,
                                       uint32_t ifNum);
#endif /* OPENAPI_PBVLAN_H_INCLUDED */