Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
Macros | Enumerations | Functions
openapi_cos.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_COS_ALL_INTERFACES   0
 
#define OPEN_COS_QUEUE_ID_MIN   0
 
#define OPEN_MAX_CFG_DROP_PREC_LEVELS   4
 
#define OPEN_MIN_CFG_DROP_PREC_LEVELS   1
 

Enumerations

enum  OPEN_QOS_COS_MAP_TRUST_MODE_t {
  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
}
 QOS COS mapping trust modes. More...
 
enum  OPEN_QOS_COS_QUEUE_MGMT_TYPE_t { OPEN_QOS_COS_QUEUE_MGMT_TYPE_TAILDROP = 1 }
 QOS COS queue management types. More...
 
enum  OPEN_QOS_COS_QUEUE_SCHED_TYPE_t { OPEN_QOS_COS_QUEUE_SCHED_TYPE_STRICT = 1, OPEN_QOS_COS_QUEUE_SCHED_TYPE_WEIGHTED }
 QOS COS queue scheduler types. More...
 

Functions

open_error_t openapiCosQueueIntfShapingPercentageIncrementGet (openapiClientHandle_t *client_handle, uint32_t *increment)
 Get the minimum increment allowed when percentage of link speed is used to express rates. More...
 
open_error_t openapiCosQueueIntfShapingRateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rate)
 Get the COS egress shaping rate for an interface. More...
 
open_error_t openapiCosQueueIntfShapingRateSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t rate)
 Set the COS egress shaping rate for an interface. More...
 
open_error_t openapiCosQueueIntfShapingRateUnitsGet (openapiClientHandle_t *client_handle, OPEN_RATE_UNIT_t *rateUnit)
 Get the units used to express rates. More...
 
open_error_t openapiCosQueueMaxIdGet (openapiClientHandle_t *client_handle, uint32_t *maxQueueId)
 Get the max cos queue ID value. More...
 
open_error_t openapiCosQueueWredDropParamsReset (openapiClientHandle_t *client_handle, uint32_t intfNum, uint8_t queueNum)
 Reset WRED and ECN drop configuration on a given queue for a given or all interfaces. More...
 
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)
 Set WRED and ECN drop configuration on a given queue for a given or all interfaces. More...
 
open_error_t openapiCosQueueWredSet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint8_t queueNum, OPEN_BOOL_t enableWred)
 Enable or disable WRED for a given queue and for a given or all interfaces. More...
 
open_error_t openapiCosQueueWredStatsClear (openapiClientHandle_t *client_handle, uint32_t intfNum)
 Clear WRED and ECN counters for a given or all interfaces. More...
 
open_error_t openapiCosQueueWredStatsGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint64_t *dropCount, uint64_t *ecnMarked)
 Get WRED drop and ECN marked counters for a given or all interfaces. More...
 
open_error_t openapiQosCosDot1dDefaultTrafficClassGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority, uint32_t *pTc)
 Gets factory default dot1d traffic class information. More...
 
open_error_t openapiQosCosDot1dTrafficClassEntryGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority)
 Gets status of user priority to traffic class mapping for a given interface. More...
 
open_error_t openapiQosCosDot1dTrafficClassEntryNextGet (openapiClientHandle_t *client_handle, uint32_t *pIntIfNum, uint32_t *pPriority)
 Gets next sequential user priority to traffic class mapping. More...
 
open_error_t openapiQosCosDot1dTrafficClassGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority, uint32_t *pTc)
 Gets dot1d traffic class information. More...
 
open_error_t openapiQosCosDot1dTrafficClassSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority, uint32_t tc)
 Sets dot1d traffic class. More...
 
open_error_t openapiQosCosMapGetIntfIndexForGlobalConfig (openapiClientHandle_t *client_handle, uint32_t *pIntIfNum)
 Gets intIfNum to denotes global config operation. More...
 
open_error_t openapiQosCosMapGlobalTrustModeGet (openapiClientHandle_t *client_handle, OPEN_QOS_COS_MAP_TRUST_MODE_t *pTrustMode)
 Gets CoS global trust mode. More...
 
open_error_t openapiQosCosMapGlobalTrustModeSet (openapiClientHandle_t *client_handle, OPEN_QOS_COS_MAP_TRUST_MODE_t trustMode)
 Sets the CoS global trust mode. More...
 
open_error_t openapiQosCosMapInterfaceTrustModeGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_QOS_COS_MAP_TRUST_MODE_t *pTrustMode)
 Gets CoS internal trust mode. More...
 
open_error_t openapiQosCosMapInterfaceTrustModeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_QOS_COS_MAP_TRUST_MODE_t trustMode)
 Sets the CoS interface trust mode. More...
 
open_error_t openapiQosCosMapIpDscpDefaultsRestore (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Restore default ip DSCP mappings for given interface. More...
 
open_error_t openapiQosCosMapIpDscpDefaultTrafficClassGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t dscp, uint32_t *pTc)
 Gets the default traffic class mapping for specified ip DSCP value. More...
 
open_error_t openapiQosCosMapIpDscpIndexGet (openapiClientHandle_t *client_handle, uint32_t dscp)
 Gets status of specified IP DSCP mapping table index. More...
 
open_error_t openapiQosCosMapIpDscpIndexGetNext (openapiClientHandle_t *client_handle, uint32_t dscp, uint32_t *pNxtDscp)
 Gets next sequential ip DSCP mapping table index. More...
 
open_error_t openapiQosCosMapIpDscpIntfIndexGet (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Gets status of specified ip DSCP mapping table interface index. More...
 
open_error_t openapiQosCosMapIpDscpIntfIndexGetNext (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pNxtIntIfNum)
 Gets next sequential ip DSCP mapping table interface index. More...
 
open_error_t openapiQosCosMapIpDscpTrafficClassGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t dscp, uint32_t *pTc)
 Gets the assigned traffic class (queue) for given ip DSCP. More...
 
open_error_t openapiQosCosMapIpDscpTrafficClassSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t dscp, uint32_t tc)
 Sets the assigned traffic class (queue) for given Ip DSCP. More...
 
open_error_t openapiQosCosMapTrustModeIntfIndexGet (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Gets specified trust mode interface index status. More...
 
open_error_t openapiQosCosMapTrustModeIntfIndexGetNext (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pNxtIntIfNum)
 Gets next sequential specified trust mode interface. More...
 
open_error_t openapiQosCosMapUntrustedPortDefaultTrafficClassGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pTcVal)
 Gets CoS untrusted port default traffic class for given internal interface. More...
 
open_error_t openapiQosCosQueueIdIndexGet (openapiClientHandle_t *client_handle, uint32_t queueId)
 Gets specified queueId index status. More...
 
open_error_t openapiQosCosQueueIdIndexGetNext (openapiClientHandle_t *client_handle, uint32_t queueId, uint32_t *pNxtqueueId)
 Gets next sequential specified queueId index. More...
 
open_error_t openapiQosCosQueueIntfIndexGet (openapiClientHandle_t *client_handle, uint32_t intIfNum)
 Gets specified queue config interface index status. More...
 
open_error_t openapiQosCosQueueIntfIndexGetNext (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *pNxtIntIfNum)
 Gets next sequential specified queue config interface index. More...
 
open_error_t openapiQosCosQueueIntfIsValid (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *pIsQueueIntfValid)
 Gets if the specified interface is valid for COS queue config. More...
 
open_error_t openapiQosCosQueueMgmtTypeListGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, open_buffdesc *pMgmtTypeList)
 Gets queue management type list for all queues on a given interface. More...
 
open_error_t openapiQosCosQueueMgmtTypeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t queueId, OPEN_QOS_COS_QUEUE_MGMT_TYPE_t qMgmtType)
 Sets queue management type for a specific queue on a given interface. More...
 
open_error_t openapiQosCosQueueMinBandwidthListGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, open_buffdesc *pMinBwList)
 Gets minimum bandwidth list for all queues on a given interface. More...
 
open_error_t openapiQosCosQueueMinBandwidthSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t queueId, uint32_t minBwVal)
 Sets minimum bandwidth for a specific queue on a given interface. More...
 
open_error_t openapiQosCosQueueSchedulerTypeListGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, open_buffdesc *pSchTypeList)
 Gets scheduler type list for all queues on a given interface. More...
 
open_error_t openapiQosCosQueueSchedulerTypeSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t queueId, OPEN_QOS_COS_QUEUE_SCHED_TYPE_t schTypeVal)
 Sets scheduler type for a specific queue on a given interface. More...