openapi_cos.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2017-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_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
/*****************************************************************/
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);

#endif /* OPENAPI_COS_H_INCLUDED */