Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_COS_ALL_INTERFACES 0 |
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 | 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, uint8_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, uint8_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, uint8_t queueNum) |
Clear WRED and ECN counters for a given queue and for a given or all interfaces. More... | |
open_error_t | openapiCosQueueWredStatsGet (openapiClientHandle_t *client_handle, uint32_t intfNum, uint8_t queueNum, uint64_t *dropCount, uint64_t *ecnMarked) |
Get WRED drop and ECN marked counters for a given queue and for a given or all interfaces. More... | |
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.
[in] | client_handle | Client handle from registration API |
[out] | increment | minimum percentage increment |
OPEN_E_NONE | value returned successfully |
OPEN_E_ERROR | platform does not use percentage to express rates |
OPEN_E_PARAM | invalid parameter passed |
OpEN API Version: 1.14
open_error_t openapiCosQueueIntfShapingRateGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | rate | ||
) |
Get the COS egress shaping rate for an interface.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | interface number |
[out] | rate | shaping rate value |
OPEN_E_NONE | value returned successfully |
OPEN_E_UNAVAIL | platform does not support COS egress shaping |
OPEN_E_FAIL | failed to get shaping rate |
OPEN_E_PARAM | invalid parameter passed |
OpEN API Version: 1.14
open_error_t openapiCosQueueIntfShapingRateSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | rate | ||
) |
Set the COS egress shaping rate for an interface.
[in] | client_handle | Client handle from registration API |
[in] | ifNum | interface number |
[in] | rate | shaping rate value |
OPEN_E_NONE | value set successfully |
OPEN_E_UNAVAIL | platform does not support COS egress shaping |
OPEN_E_FAIL | failed to set shaping rate |
OPEN_E_PARAM | invalid parameter passed |
OpEN API Version: 1.14
open_error_t openapiCosQueueIntfShapingRateUnitsGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_RATE_UNIT_t * | rateUnit | ||
) |
Get the units used to express rates.
[in] | client_handle | Client handle from registration API |
[out] | rateUnit | rate unit identifier |
OPEN_E_NONE | value returned successfully |
OPEN_E_PARAM | invalid parameter passed |
OpEN API Version: 1.14
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.
[in] | client_handle | Client handle from registration API |
[in] | intfNum | interface number |
[in] | queueNum | queue number |
OPEN_E_NONE | value set successfully |
OPEN_E_UNAVAIL | platform does not support WRED feature |
OPEN_E_FAIL | failed to reset drop params config |
OpEN API Version: 1.14
open_error_t openapiCosQueueWredDropParamsSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intfNum, | ||
uint8_t | queueNum, | ||
uint8_t | dropPrecedence, | ||
uint8_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.
[in] | client_handle | Client handle from registration API |
[in] | intfNum | interface number |
[in] | queueNum | queue number |
[in] | dropPrecedence | drop precedence |
[in] | ecnEnabled | ECN enabled |
[in] | wredMinThreshold | WRED minimum threshold |
[in] | wredMaxThreshold | WRED maximum threshold |
[in] | wredDropProbability | WRED drop probability |
OPEN_E_NONE | value set successfully |
OPEN_E_UNAVAIL | platform does not support WRED or ECN feature |
OPEN_E_FAIL | failed to set or get drop params config |
OPEN_E_PARAM | invalid parameter passed |
OpEN API Version: 1.14
open_error_t openapiCosQueueWredSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intfNum, | ||
uint8_t | queueNum, | ||
uint8_t | enableWred | ||
) |
Enable or disable WRED for a given queue and for a given or all interfaces.
[in] | client_handle | Client handle from registration API |
[in] | intfNum | interface number |
[in] | queueNum | queue number |
[in] | enableWred | enable or disable WRED |
OPEN_E_NONE | enabled WRED successfully |
OPEN_E_FAIL | unable to enable WRED |
OpEN API Version: 1.14
open_error_t openapiCosQueueWredStatsClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intfNum, | ||
uint8_t | queueNum | ||
) |
Clear WRED and ECN counters for a given queue and for a given or all interfaces.
[in] | client_handle | Client handle from registration API |
[in] | intfNum | interface number |
[in] | queueNum | queue number |
OPEN_E_NONE | counters reset successfully |
OPEN_E_FAIL | unable to reset counters |
OpEN API Version: 1.14
open_error_t openapiCosQueueWredStatsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intfNum, | ||
uint8_t | queueNum, | ||
uint64_t * | dropCount, | ||
uint64_t * | ecnMarked | ||
) |
Get WRED drop and ECN marked counters for a given queue and for a given or all interfaces.
[in] | client_handle | Client handle from registration API |
[in] | intfNum | interface number |
[in] | queueNum | queue number |
[out] | dropCounters | WRED drop counters |
[out] | ecnMarked | ECN marked counters |
OPEN_E_NONE | counters retrieved successfully |
OPEN_E_FAIL | unable to retrieve counters |
OpEN API Version: 1.14