openapi_cos.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2017-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_cos.h
*
* @purpose   Class of Service Configuration
*
* @component OpEN
*
* @create    01/11/2017
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_COS_H_INCLUDED
#define OPENAPI_COS_H_INCLUDED

#include "openapi_common.h"

#define OPEN_COS_ALL_INTERFACES 0
#define OPEN_COS_QUEUE_ID_MIN   0

#define OPEN_MIN_CFG_DROP_PREC_LEVELS 1
#define OPEN_MAX_CFG_DROP_PREC_LEVELS 4

typedef enum
{
  OPEN_QOS_COS_MAP_TRUST_MODE_INVALID = 0,  
  OPEN_QOS_COS_MAP_TRUST_MODE_UNTRUSTED,    
  OPEN_QOS_COS_MAP_TRUST_MODE_DOT1P,        
  OPEN_QOS_COS_MAP_TRUST_MODE_IPPREC,       
  OPEN_QOS_COS_MAP_TRUST_MODE_IPDSCP        
} OPEN_QOS_COS_MAP_TRUST_MODE_t;

typedef enum
{
  OPEN_QOS_COS_QUEUE_SCHED_TYPE_STRICT = 1,   
  OPEN_QOS_COS_QUEUE_SCHED_TYPE_WEIGHTED      
} OPEN_QOS_COS_QUEUE_SCHED_TYPE_t;

typedef enum
{
  OPEN_QOS_COS_QUEUE_MGMT_TYPE_TAILDROP = 1   
} OPEN_QOS_COS_QUEUE_MGMT_TYPE_t;

/*****************************************************************/
open_error_t openapiCosQueueIntfShapingRateUnitsGet(openapiClientHandle_t *client_handle, OPEN_RATE_UNIT_t *rateUnit);

/*****************************************************************/
open_error_t openapiCosQueueIntfShapingPercentageIncrementGet(openapiClientHandle_t *client_handle, uint32_t *increment);

/*****************************************************************/
open_error_t openapiCosQueueIntfShapingRateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rate);

/*****************************************************************/
open_error_t openapiCosQueueIntfShapingRateSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t rate);

/*****************************************************************/
open_error_t openapiCosQueueWredDropParamsSet(openapiClientHandle_t *client_handle, uint32_t intfNum, uint8_t queueNum,
                                              uint8_t dropPrecedence, OPEN_BOOL_t ecnEnabled, int16_t wredMinThreshold,
                                              int16_t wredMaxThreshold, int16_t wredDropProbability);

/*****************************************************************/
open_error_t openapiCosQueueWredDropParamsReset(openapiClientHandle_t *client_handle, uint32_t intfNum, uint8_t queueNum);

/*****************************************************************/
open_error_t openapiCosQueueWredStatsGet(openapiClientHandle_t *client_handle, uint32_t intfNum, 
                                         uint64_t *dropCount, uint64_t *ecnMarked);

/*****************************************************************/
open_error_t openapiCosQueueWredStatsClear(openapiClientHandle_t *client_handle, uint32_t intfNum);

/*****************************************************************/
open_error_t openapiCosQueueWredSet(openapiClientHandle_t *client_handle,
                                    uint32_t intfNum, uint8_t queueNum,
                                    OPEN_BOOL_t enableWred);

/*****************************************************************/
open_error_t openapiCosQueueMaxIdGet(openapiClientHandle_t *client_handle,
                                     uint32_t *maxQueueId);

/*************************************************************************/
open_error_t 
openapiQosCosMapGlobalTrustModeSet(openapiClientHandle_t *client_handle,
                                   OPEN_QOS_COS_MAP_TRUST_MODE_t trustMode);

/*************************************************************************/
open_error_t
openapiQosCosMapGlobalTrustModeGet(openapiClientHandle_t *client_handle,
                                   OPEN_QOS_COS_MAP_TRUST_MODE_t *pTrustMode);

/*************************************************************************/
open_error_t
openapiQosCosMapInterfaceTrustModeSet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum,
                                      OPEN_QOS_COS_MAP_TRUST_MODE_t trustMode);

/*************************************************************************/
open_error_t
openapiQosCosMapInterfaceTrustModeGet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum,
                                      OPEN_QOS_COS_MAP_TRUST_MODE_t *pTrustMode);

/*************************************************************************/
open_error_t
openapiQosCosMapTrustModeIntfIndexGet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum);

/*************************************************************************/
open_error_t
openapiQosCosMapTrustModeIntfIndexGetNext(openapiClientHandle_t *client_handle,
                                          uint32_t intIfNum,
                                          uint32_t *pNxtIntIfNum);

/*************************************************************************/
open_error_t
openapiQosCosMapUntrustedPortDefaultTrafficClassGet(openapiClientHandle_t *client_handle,
                                                    uint32_t intIfNum, uint32_t *pTcVal);

/*************************************************************************/
open_error_t
openapiQosCosQueueIntfIndexGet(openapiClientHandle_t *client_handle,
                               uint32_t intIfNum);

/*************************************************************************/
open_error_t
openapiQosCosQueueIntfIndexGetNext(openapiClientHandle_t *client_handle,
                                   uint32_t intIfNum, uint32_t *pNxtIntIfNum);

/*************************************************************************/
open_error_t
openapiQosCosQueueIntfIsValid(openapiClientHandle_t *client_handle,
                              uint32_t intIfNum, OPEN_BOOL_t *pIsQueueIntfValid);

/*************************************************************************/
open_error_t
openapiQosCosQueueIdIndexGet(openapiClientHandle_t *client_handle,
                             uint32_t queueId);

/*************************************************************************/
open_error_t
openapiQosCosQueueIdIndexGetNext(openapiClientHandle_t *client_handle,
                                 uint32_t queueId, uint32_t *pNxtqueueId);

/*************************************************************************/
open_error_t
openapiQosCosQueueMinBandwidthSet(openapiClientHandle_t *client_handle, 
                                  uint32_t intIfNum, uint32_t queueId,
                                  uint32_t minBwVal);

/*************************************************************************/
open_error_t
openapiQosCosQueueMinBandwidthListGet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum, open_buffdesc *pMinBwList);

/*************************************************************************/
open_error_t
openapiQosCosQueueSchedulerTypeSet(openapiClientHandle_t *client_handle,
                                   uint32_t intIfNum, uint32_t queueId,
                                   OPEN_QOS_COS_QUEUE_SCHED_TYPE_t schTypeVal);

/*************************************************************************/
open_error_t
openapiQosCosQueueSchedulerTypeListGet(openapiClientHandle_t *client_handle,
                                       uint32_t intIfNum, open_buffdesc *pSchTypeList);

/*************************************************************************/
open_error_t
openapiQosCosQueueMgmtTypeSet(openapiClientHandle_t *client_handle,
                              uint32_t intIfNum, uint32_t queueId,
                              OPEN_QOS_COS_QUEUE_MGMT_TYPE_t qMgmtType);

/*************************************************************************/
open_error_t
openapiQosCosQueueMgmtTypeListGet(openapiClientHandle_t *client_handle,
                                  uint32_t intIfNum, open_buffdesc *pMgmtTypeList);

/*************************************************************************/
open_error_t
openapiQosCosDot1dTrafficClassSet(openapiClientHandle_t *client_handle,
                                  uint32_t intIfNum, uint32_t priority,
                                  uint32_t tc);

/*************************************************************************/
open_error_t
openapiQosCosDot1dTrafficClassGet(openapiClientHandle_t *client_handle,
                                  uint32_t intIfNum, uint32_t priority,
                                  uint32_t *pTc);

/*************************************************************************/
open_error_t
openapiQosCosDot1dTrafficClassEntryGet(openapiClientHandle_t *client_handle,
                                       uint32_t intIfNum, uint32_t priority);

/*************************************************************************/
open_error_t
openapiQosCosDot1dTrafficClassEntryNextGet(openapiClientHandle_t *client_handle,
                                           uint32_t *pIntIfNum, uint32_t *pPriority);

/*************************************************************************/
open_error_t
openapiQosCosDot1dDefaultTrafficClassGet(openapiClientHandle_t *client_handle,
                                         uint32_t intIfNum, uint32_t priority,
                                         uint32_t *pTc);
/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpIndexGet(openapiClientHandle_t *client_handle,
                               uint32_t dscp);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpIndexGetNext(openapiClientHandle_t *client_handle,
                                   uint32_t dscp, uint32_t *pNxtDscp);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpTrafficClassSet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum, uint32_t dscp,
                                      uint32_t tc);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpTrafficClassGet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum, uint32_t dscp,
                                      uint32_t *pTc);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpDefaultTrafficClassGet(openapiClientHandle_t *client_handle,
                                             uint32_t intIfNum, uint32_t dscp,
                                             uint32_t *pTc);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpDefaultsRestore(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpIntfIndexGet(openapiClientHandle_t *client_handle,
                                   uint32_t intIfNum);

/*************************************************************************/
open_error_t
openapiQosCosMapIpDscpIntfIndexGetNext(openapiClientHandle_t *client_handle,
                                       uint32_t intIfNum, uint32_t *pNxtIntIfNum);

/*************************************************************************/
open_error_t
openapiQosCosMapGetIntfIndexForGlobalConfig(openapiClientHandle_t *client_handle,
                                            uint32_t *pIntIfNum);

#endif /* OPENAPI_COS_H_INCLUDED */