Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_QOS_PFC_PRIORITY_ALL 8 |
#define | OPEN_QOS_PFC_PRIORITY_MAX (OPEN_QOS_PFC_PRIORITY_ALL-1) |
#define | OPEN_QOS_PFC_PRIORITY_MIN 0 |
Functions | |
open_error_t | openapiIfPfcModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PFC_MODE_t *mode) |
Get the pfc mode for the interface. More... | |
open_error_t | openapiIfPfcModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PFC_MODE_t mode) |
Enable an interface for PFC. More... | |
open_error_t | openapiIfPfcPriorityModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, OPEN_PFC_PRI_DROP_MODE_t *mode) |
Get the drop mode for the priority on an interface. More... | |
open_error_t | openapiIfPfcPriorityModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, OPEN_PFC_PRI_DROP_MODE_t dropMode) |
Set the drop mode for the priority on an interface. More... | |
open_error_t | openapiIfPfcRxPriorityStatGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, uint32_t *stat) |
Get the PFC Rx Priority stat on an interface. More... | |
open_error_t | openapiIfPfcRxStatGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count) |
Get the PFC Rx stat on an interface. More... | |
open_error_t | openapiIfPfcStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum) |
Clear the PFC stats on an interface. More... | |
open_error_t | openapiIfPfcStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_PFC_STATUS_t *status) |
Get the active status on the interface. More... | |
open_error_t | openapiIfPfcTxStatGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count) |
Get the PFC Tx stat on an interface. More... | |
open_error_t | openapiPfcAdvPriorityModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, OPEN_PFC_PRI_DROP_MODE_t *mode) |
Gets the advertised PFC Priority participation mode for the interface. More... | |
open_error_t | openapiPfcMaxNoDropPriorityGet (openapiClientHandle_t *client_handle, uint32_t *maxPrio) |
Returns the maximum priority that can be configured in PFC. More... | |
open_error_t | openapiPfcMinNoDropPriorityGet (openapiClientHandle_t *client_handle, uint32_t *minPrio) |
Returns the minimum priority that can be configured in PFC. More... | |
open_error_t | openapiPfcOperLinkDelayAllowanceGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *allowance) |
Gets the link delay allowance in bits for the interface. More... | |
open_error_t | openapiPfcOprPriorityModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, OPEN_PFC_PRI_DROP_MODE_t *mode) |
Gets the operational PFC Priority participation mode for the interface. More... | |
open_error_t | openapiPfcPeerCapabilityGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *numPfcCap) |
Get the capability of the peer. More... | |
open_error_t | openapiPfcPeerCfgCompatibleGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *compatible) |
Indicates if the peer configuration is compatible. More... | |
open_error_t | openapiPfcPeerCompatibleCfgCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *count) |
Gets the count of compatible configurations received from peer. More... | |
open_error_t | openapiPfcPeerIncompatibleCfgCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *incompatibleCfgCount) |
Gets the count of incompatible configurations received from peer. More... | |
open_error_t | openapiPfcPeerMbcStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *mbcStatus) |
Get the MACSEC bypass capability of the peer. More... | |
open_error_t | openapiPfcPeerPriorityModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, OPEN_PFC_PRI_DROP_MODE_t *mode) |
Get the peer priority mode for a priority. More... | |
open_error_t | openapiPfcPeerWillingGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *willing) |
Get the willingness of the peer. More... | |
open_error_t | openapiPfcTxPriorityStatGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, uint32_t *count) |
Gets the number of PFC packets transmitted per interface/priority. More... | |
open_error_t openapiIfPfcModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_PFC_MODE_t * | mode | ||
) |
Get the pfc mode for the interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | mode | enabled for pfc or not. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_PFC_MODE_t | mode | ||
) |
Enable an interface for PFC.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | mode | mode |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcPriorityModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
OPEN_PFC_PRI_DROP_MODE_t * | mode | ||
) |
Get the drop mode for the priority on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority to get. |
[out] | mode | the drop mode of the interface. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_NOT_FOUND | Priority is greater than OPEN_DOT1P_MAX_PRIORITY |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcPriorityModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
OPEN_PFC_PRI_DROP_MODE_t | dropMode | ||
) |
Set the drop mode for the priority on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority |
[in] | dropMode | drop mode |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Priority is less than PFC minimum priority or greater than PFC maximum priority. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcRxPriorityStatGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
uint32_t * | stat | ||
) |
Get the PFC Rx Priority stat on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority to get. |
[out] | stat | the statistic. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_NOT_FOUND | Priority is greater than OPEN_DOT1P_MAX_PRIORITY |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcRxStatGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | count | ||
) |
Get the PFC Rx stat on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | count | PFC Rx statistic. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcStatsClear | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum | ||
) |
Clear the PFC stats on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_PFC_STATUS_t * | status | ||
) |
Get the active status on the interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | status | The active status of the interface. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiIfPfcTxStatGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | count | ||
) |
Get the PFC Tx stat on an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | count | PFC Tx statistic. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcAdvPriorityModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
OPEN_PFC_PRI_DROP_MODE_t * | mode | ||
) |
Gets the advertised PFC Priority participation mode for the interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority. |
[out] | mode | participation mode. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcMaxNoDropPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxPrio | ||
) |
Returns the maximum priority that can be configured in PFC.
[in] | client_handle | client handle. |
[out] | maxPrio | maximum priority. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OpEN API Version: 1.14
open_error_t openapiPfcMinNoDropPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | minPrio | ||
) |
Returns the minimum priority that can be configured in PFC.
[in] | client_handle | client handle. |
[out] | minPrio | minimum priority. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OpEN API Version: 1.14
open_error_t openapiPfcOperLinkDelayAllowanceGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | allowance | ||
) |
Gets the link delay allowance in bits for the interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | allowance | link delay allowance. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcOprPriorityModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
OPEN_PFC_PRI_DROP_MODE_t * | mode | ||
) |
Gets the operational PFC Priority participation mode for the interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority to get. |
[out] | mode | the drop mode of the interface. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Priority is greater than OPEN_DOT1P_MAX_PRIORITY |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerCapabilityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | numPfcCap | ||
) |
Get the capability of the peer.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | numPfcCap | capability of the peer. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerCfgCompatibleGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | compatible | ||
) |
Indicates if the peer configuration is compatible.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | compatible | peer configuration compatible. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Peer not detected. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerCompatibleCfgCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | count | ||
) |
Gets the count of compatible configurations received from peer.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | count | count of compatible configurations. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerIncompatibleCfgCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | incompatibleCfgCount | ||
) |
Gets the count of incompatible configurations received from peer.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | incompatibleCfgCount | incompatible count from peer. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerMbcStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | mbcStatus | ||
) |
Get the MACSEC bypass capability of the peer.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | mbcStatus | MACSEC bypass capability of peer. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Peer not detected. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerPriorityModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
OPEN_PFC_PRI_DROP_MODE_t * | mode | ||
) |
Get the peer priority mode for a priority.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority. |
[out] | mode | peer priority mode. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Priority is greater than OPEN_DOT1P_MAX_PRIORITY or peer is not detected. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcPeerWillingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | willing | ||
) |
Get the willingness of the peer.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | willing | willingness of the peer. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_NOT_FOUND | Peer not detected. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiPfcTxPriorityStatGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | priority, | ||
uint32_t * | count | ||
) |
Gets the number of PFC packets transmitted per interface/priority.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | priority | priority to get. |
[out] | count | Number of pfc packets tx on this priority |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Feature not supported. |
OPEN_E_NOT_FOUND | Priority is greater than OPEN_DOT1P_MAX_PRIORITY |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14