openapi_garp.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_garp.h
*
* @purpose   This code implements the OpEN APIs for GARP
*
* @component OPEN
*
* @create    11/16/2022
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_GARP_H_INCLUDED
#define OPENAPI_GARP_H_INCLUDED

#include "openapi_common.h" 

/* join timer */
#define OPEN_GARP_MIN_JOIN_TIME      10      /* centiseconds */
#define OPEN_GARP_MAX_JOIN_TIME      100     /* centiseconds */
#define OPEN_GARP_DEF_JOIN_TIME      20      /* centiseconds */

/* leave timer */
#define OPEN_GARP_MIN_LEAVE_TIME     20      /* centiseconds */
#define OPEN_GARP_MAX_LEAVE_TIME     600     /* centiseconds */
#define OPEN_GARP_DEF_LEAVE_TIME     60      /* centiseconds */

/* leave all timer */
#define OPEN_GARP_MIN_LEAVE_ALL_TIME 200     /* centiseconds */
#define OPEN_GARP_MAX_LEAVE_ALL_TIME 6000    /* centiseconds */
#define OPEN_GARP_DEF_LEAVE_ALL_TIME 1000    /* centiseconds */


/*************************************************************************/
open_error_t openapiGarpGmrpEnableGet(openapiClientHandle_t *client_handle, 
                                      OPEN_CONTROL_t *globalGmrpStatus);

/*************************************************************************/
open_error_t openapiGarpGmrpEnableSet(openapiClientHandle_t *client_handle, 
                                      OPEN_CONTROL_t globalGmrpStatus);

/*************************************************************************/
open_error_t openapiGarpGmrpPortEnableGet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, 
                                          OPEN_CONTROL_t *intfGmrpStatus);

/*************************************************************************/
open_error_t openapiGarpGmrpPortEnableSet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, 
                                          OPEN_CONTROL_t intfGmrpStatus);

/*************************************************************************/
open_error_t openapiGarpGvrpEnableGet(openapiClientHandle_t *client_handle,
                                      OPEN_CONTROL_t *globalGvrpStatus);

/*************************************************************************/
open_error_t openapiGarpGvrpEnableSet(openapiClientHandle_t *client_handle, 
                                      OPEN_CONTROL_t globalGvrpStatus);

/*************************************************************************/
open_error_t openapiGarpGvrpPortEnableGet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, 
                                          OPEN_CONTROL_t *intfGvrpStatus);

/*************************************************************************/
open_error_t openapiGarpGvrpPortEnableSet(openapiClientHandle_t *client_handle,
                                          uint32_t ifNum, 
                                          OPEN_CONTROL_t intfGvrpStatus);

/*************************************************************************/
open_error_t openapiGarpJoinTimeGet(openapiClientHandle_t *client_handle, 
                                    uint32_t ifNum, uint32_t *joinTime);

/*************************************************************************/
open_error_t openapiGarpJoinTimeSet(openapiClientHandle_t *client_handle, 
                                    uint32_t ifNum, uint32_t joinTime);

/*************************************************************************/
open_error_t openapiGarpLeaveTimeGet(openapiClientHandle_t *client_handle, 
                                     uint32_t ifNum, uint32_t *leaveTime);

/*************************************************************************/
open_error_t openapiGarpLeaveTimeSet(openapiClientHandle_t *client_handle, 
                                     uint32_t ifNum, uint32_t leaveTime);

/*************************************************************************/
open_error_t openapiGarpLeaveAllTimeGet(openapiClientHandle_t *client_handle,
                                        uint32_t ifNum, uint32_t *leaveAllTime);

/*************************************************************************/
open_error_t openapiGarpLeaveAllTimeSet(openapiClientHandle_t *client_handle,
                                        uint32_t ifNum, uint32_t leaveAllTime);


#endif /* OPENAPI_GARP_H_INCLUDED */