openapi_lag.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-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_lag.h
*
* @purpose   LAG Configuration and Status 
*
* @component OPEN
*
* @create    10/10/2012
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_LAG_H_INCLUDED
#define OPENAPI_LAG_H_INCLUDED

#include <stdio.h>
#include <stddef.h>
#include <sys/un.h>

#include "openapi_common.h"

typedef enum
{
  OPEN_LAG_HASHING_MODE_SA_VLAN     = 0, 
  OPEN_LAG_HASHING_MODE_DA_VLAN     = 1, 
  OPEN_LAG_HASHING_MODE_SDA_VLAN    = 2, 
  OPEN_LAG_HASHING_MODE_SIP_SPORT   = 3, 
  OPEN_LAG_HASHING_MODE_DIP_DPORT   = 4, 
  OPEN_LAG_HASHING_MODE_SDIP_DPORT  = 5, 
  OPEN_LAG_HASHING_MODE_ENHANCED    = 6  
} OPEN_LAG_HASH_MODE_t;

typedef enum
{
  OPEN_DOT3AD_STATE_AGGREGATION     = 0, 
  OPEN_DOT3AD_STATE_LACP_TIMEOUT    = 1, 
  OPEN_DOT3AD_STATE_LACP_ACTIVITY   = 2  
} OPEN_DOT3AD_STATE_TYPE_t;

#define OPEN_MAX_MEMBERS_PER_LAG 32
#define OPEN_LAG_MEMBER_BUFFER_SIZE (sizeof(uint32_t) * OPEN_MAX_MEMBERS_PER_LAG)

#define OPEN_LAG_PORT_ACTOR_SYSTEM_PRIORITY_MIN 0
#define OPEN_LAG_PORT_ACTOR_SYSTEM_PRIORITY_DEFAULT 32768
#define OPEN_LAG_PORT_ACTOR_SYSTEM_PRIORITY_MAX 65535

#define OPEN_LAG_PORT_ACTOR_PORT_PRIORITY_MIN 0
#define OPEN_LAG_PORT_ACTOR_PORT_PRIORITY_DEFAULT 128
#define OPEN_LAG_PORT_ACTOR_PORT_PRIORITY_MAX 65535

typedef enum
{
  OPEN_LAG_NON_UNICAST_HASH_MODE_SOURCE_PORT = 1,     
  OPEN_LAG_NON_UNICAST_HASH_MODE_SOURCE_ADDRESS,      
  OPEN_LAG_NON_UNICAST_HASH_MODE_DESTINATION_ADDRESS, 
  OPEN_LAG_NON_UNICAST_HASH_MODE_OPTIONS_TOTAL                   
} OPEN_LAG_NON_UNICAST_HASH_MODE_OPTIONS_t;

typedef struct
{
  maskValue_t modesConfigured[OPEN_MASK_LEN(OPEN_LAG_NON_UNICAST_HASH_MODE_OPTIONS_TOTAL)]; 
}openLagNonUnicastHashMode_t;


/*****************************************************************/
open_error_t openapiLagPortAdd (openapiClientHandle_t *client_handle,
                                uint32_t lagIfNum,
                                uint32_t phyIfNum);

/*****************************************************************/
open_error_t openapiLagPortDelete (openapiClientHandle_t *client_handle,
                                   uint32_t lagIfNum,
                                   uint32_t phyIfNum);

/*****************************************************************/
open_error_t openapiLagStaticModeGet (openapiClientHandle_t *client_handle,
                                      uint32_t lagIfNum,
                                      OPEN_CONTROL_t *staticMode);

/*****************************************************************/
open_error_t openapiLagStaticModeSet (openapiClientHandle_t *client_handle,
                                      uint32_t lagIfNum,
                                      OPEN_CONTROL_t staticMode);

/*****************************************************************/
open_error_t openapiLagNameMaxLengthGet(openapiClientHandle_t *client_handle,
                                        uint32_t *maxLen);

/***********************************************************************/
open_error_t openapiLagNameGet (openapiClientHandle_t *client_handle,
                                uint32_t lagIfNum, 
                                open_buffdesc *name);

/***********************************************************************/
open_error_t openapiLagNameSet (openapiClientHandle_t *client_handle,
                                uint32_t lagIfNum,
                                open_buffdesc *name);

/****************************************************************************/
open_error_t openapiLagLoadBalanceModeGet (openapiClientHandle_t *client_handle,
                                           uint32_t lagIfNum,
                                           OPEN_LAG_HASH_MODE_t *lbMode);

/****************************************************************************/
open_error_t openapiLagLoadBalanceModeSet (openapiClientHandle_t *client_handle,
                                           uint32_t lagIfNum,
                                           OPEN_LAG_HASH_MODE_t lbMode);

/*****************************************************************/
open_error_t openapiLagThresholdMinMaxGet(openapiClientHandle_t *client_handle,
                                          uint32_t *minThreshold,
                                          uint32_t *maxThreshold);

/****************************************************************************/
open_error_t openapiLagMinUplinksGet (openapiClientHandle_t *client_handle,
                                      uint32_t lagIfNum,
                                      uint32_t *minUpLinks);

/****************************************************************************/
open_error_t openapiLagMinUplinksSet (openapiClientHandle_t *client_handle,
                                      uint32_t lagIfNum,
                                      uint32_t minUpLinks);

/*****************************************************************/
open_error_t openapiLagMaxMemberCountGet(openapiClientHandle_t *client_handle,
                                         uint32_t *memberMax);

/****************************************************************************/
open_error_t openapiLagMembersGet (openapiClientHandle_t *client_handle,
                                   uint32_t lagIfNum,
                                   uint32_t *count,
                                   open_buffdesc *bufd);

/****************************************************************************/
open_error_t openapiLagMembersListGet (openapiClientHandle_t *client_handle,
                                       uint32_t lagIfNum,
                                       uint32_t *count,
                                       open_buffdesc *bufd);

/****************************************************************************/
open_error_t openapiLagActiveMembersGet (openapiClientHandle_t *client_handle,
                                         uint32_t lagIfNum,
                                         uint32_t *count,
                                         open_buffdesc *bufd);

/****************************************************************************/
open_error_t openapiLagActiveMembersListGet (openapiClientHandle_t *client_handle,
                                             uint32_t lagIfNum,
                                             uint32_t *count,
                                             open_buffdesc *bufd);

/****************************************************************************/
open_error_t openapiDot3adAggPortLacpModeGet (openapiClientHandle_t *client_handle,
                                              uint32_t ifNum,
                                              OPEN_CONTROL_t *lacpMode);

/****************************************************************************/
open_error_t openapiDot3adAggPortLacpModeSet (openapiClientHandle_t *client_handle,
                                              uint32_t ifNum,
                                              OPEN_CONTROL_t lacpMode);

/****************************************************************************/
open_error_t openapiDot3adAggPortActorAdminStateGet (openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,
                                                     OPEN_DOT3AD_STATE_TYPE_t type,
                                                     OPEN_CONTROL_t *state);

/****************************************************************************/
open_error_t openapiDot3adAggPortActorAdminStateSet (openapiClientHandle_t *client_handle,
                                                     uint32_t ifNum,
                                                     OPEN_DOT3AD_STATE_TYPE_t type,
                                                     OPEN_CONTROL_t mode);

/*****************************************************************/
open_error_t openapiLagAdminModeGet(openapiClientHandle_t *client_handle,
                                    uint32_t lagIfNum, 
                                    OPEN_CONTROL_t *adminMode);

/*****************************************************************/
open_error_t openapiLagAdminModeSet(openapiClientHandle_t *client_handle,
                                    uint32_t lagIfNum, 
                                    OPEN_CONTROL_t adminMode);

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

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

/****************************************************************************/
open_error_t openapiLagAutoLAGHashModeGet(openapiClientHandle_t *client_handle,
                                          OPEN_LAG_HASH_MODE_t *hashMode);

/****************************************************************************/
open_error_t openapiLagAutoLAGHashModeSet(openapiClientHandle_t *client_handle,
                                          OPEN_LAG_HASH_MODE_t hashMode);

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

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

/*****************************************************************/
open_error_t openapiLagAvbProfileModeGet(openapiClientHandle_t *client_handle,
                                         uint32_t lagIntIfNum,
                                         OPEN_CONTROL_t *adminMode);

/*****************************************************************/
open_error_t openapiLagAutoLAGStatusGet(openapiClientHandle_t *client_handle,
                                        uint32_t lagIntIfNum,
                                        OPEN_BOOL_t *autoLagStatus);

/*************************************************************************/
open_error_t openapiLagLinkTrapGet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum, uint32_t *val);

/*************************************************************************/
open_error_t openapiLagLinkTrapSet(openapiClientHandle_t *client_handle,
                                   uint32_t ifNum, uint32_t val);
/*************************************************************************/
open_error_t openapiLagAggPortActorSystemPriorityGet(openapiClientHandle_t *client_handle,
                                                     uint32_t *val);

/*************************************************************************/
open_error_t openapiLagAggPortActorSystemPrioritySet(openapiClientHandle_t *client_handle,
                                                     uint32_t val);

/*************************************************************************/
open_error_t openapiLagAggPortActorPortPriorityGet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum, uint32_t *val);
/*************************************************************************/
open_error_t openapiLagAggPortActorPortPrioritySet(openapiClientHandle_t *client_handle,
                                                   uint32_t ifNum, uint32_t val);

/*************************************************************************/
open_error_t openapiLagCountGet(openapiClientHandle_t *client_handle,
                                uint32_t *lagCount);

/*************************************************************************/
open_error_t openapiLagIfIndexGetFirst(openapiClientHandle_t *client_handle,
                                       uint32_t *intfIndex);

/*************************************************************************/
open_error_t openapiLagIfIndexGetNext(openapiClientHandle_t *client_handle,
                                      uint32_t intfIndex,
                                      uint32_t *nextIntfIndex);

/*************************************************************************/
open_error_t openapiLagPortChannelIdGet(openapiClientHandle_t *client_handle,
                                        uint32_t ifNum,
                                        uint32_t *portChannelId);

/*****************************************************************/
open_error_t openapiLagNonUnicastGlobalHashModeGet(openapiClientHandle_t *client_handle,
                                                   openLagNonUnicastHashMode_t *hashMode);

/*****************************************************************/
open_error_t openapiLagNonUnicastGlobalHashModeSet(openapiClientHandle_t *client_handle,
                                                   openLagNonUnicastHashMode_t hashMode);
#endif