Priority-Based Flow Control Configuration And Statistics APIs [OPENAPI_PFC]

Macros
#define	OPEN_PFC_DEADLOCK_DETECT_TIME_MAX   1500
#define	OPEN_PFC_DEADLOCK_DETECT_TIME_MIN   0
#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

Enumerations
enum	OPEN_PFC_ACTION_t { OPEN_PFC_ACTION_DROP = 0, OPEN_PFC_ACTION_NO_DROP = 1 }
enum	OPEN_PFC_DDR_ACTION_t { OPEN_PFC_DDR_ACTION_TRANSMIT = 0, OPEN_PFC_DDR_ACTION_DROP = 1 }
enum	OPEN_PFC_DDR_DETECT_TIME_t { OPEN_PFC_DDR_DETECT_TIME_10MS = 0, OPEN_PFC_DDR_DETECT_TIME_100MS = 1 }
enum	OPEN_PFC_DDR_MODE_t { OPEN_PFC_DDR_MODE_DISABLE = 0, OPEN_PFC_DDR_MODE_ENABLE = 1 }
enum	OPEN_PFC_FEATURE_IDS_t { OPEN_PFC_FEATURE_SUPPORTED = 0, OPEN_PFC_PORT_PRIORITY_FLOW_CONTROL_FEATURE_ID = 1, OPEN_PFC_TX_STATS_FEATURE_ID = 2 }
enum	OPEN_PFC_MODE_t { OPEN_PFC_MODE_DISABLE = 0, OPEN_PFC_MODE_ENABLE = 1 }
enum	OPEN_PFC_PRI_DROP_MODE_t { OPEN_PFC_PRI_DROP_MODE = 0, OPEN_PFC_PRI_NODROP_MODE = 1 }
enum	OPEN_PFC_STATUS_t { OPEN_PFC_STATUS_ACTIVE = 0, OPEN_PFC_STATUS_INACTIVE = 1 }

Functions
open_error_t	openapiIfPfcDeadlockConfigGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority, OPEN_PFC_DDR_MODE_t *mode)
	Get the deadlock detect mode for the priority on an interface. More...
open_error_t	openapiIfPfcDeadlockConfigSet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t priority, OPEN_PFC_DDR_MODE_t mode)
	Enable/Disable deadlock detect for the priority on an interface. More...
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	openapiPfcDeadlockDetectIntervalGet (openapiClientHandle_t *client_handle, OPEN_PFC_DDR_DETECT_TIME_t *val)
	Get the deadlock detect interval. More...
open_error_t	openapiPfcDeadlockDetectIntervalSet (openapiClientHandle_t *client_handle, OPEN_PFC_DDR_DETECT_TIME_t val)
	Set the deadlock detect interval. More...
open_error_t	openapiPfcDeadlockDetectTimeGet (openapiClientHandle_t *client_handle, uint32_t priority, uint32_t *det_time, uint32_t *rec_time)
	Get the deadlock detect time and recovery time for a priority. More...
open_error_t	openapiPfcDeadlockDetectTimeSet (openapiClientHandle_t *client_handle, uint32_t priority, uint32_t val)
	Set the deadlock detect time for a priority. More...
open_error_t	openapiPfcDeadlockRecoveryActionGet (openapiClientHandle_t *client_handle, OPEN_PFC_DDR_ACTION_t *val)
	Get the deadlock recovery action. More...
open_error_t	openapiPfcDeadlockRecoveryActionSet (openapiClientHandle_t *client_handle, OPEN_PFC_DDR_ACTION_t val)
	Set the deadlock recovery action. More...
open_error_t	openapiPfcDeadlockRecoveryTimeSet (openapiClientHandle_t *client_handle, uint32_t priority, uint32_t val)
	Set the deadlock recovery time for a priority. 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...

Detailed Description

Enumeration Type Documentation

enum OPEN_PFC_ACTION_t

Enumerator
OPEN_PFC_ACTION_DROP	action drop
OPEN_PFC_ACTION_NO_DROP	action no drop

Definition at line 65 of file openapi_pfc.h.

enum OPEN_PFC_DDR_ACTION_t

Enumerator
OPEN_PFC_DDR_ACTION_TRANSMIT	PFC deadlock recovery action transmit.
OPEN_PFC_DDR_ACTION_DROP	PFC deadlock recovery action drop.

Definition at line 96 of file openapi_pfc.h.

enum OPEN_PFC_DDR_DETECT_TIME_t

Enumerator
OPEN_PFC_DDR_DETECT_TIME_10MS	PFC deadlock detect time 10 ms.
OPEN_PFC_DDR_DETECT_TIME_100MS	PFC deadlock detect time 100 ms.

Definition at line 102 of file openapi_pfc.h.

enum OPEN_PFC_DDR_MODE_t

Enumerator
OPEN_PFC_DDR_MODE_DISABLE	PFC Deadlock Detect disable mode.
OPEN_PFC_DDR_MODE_ENABLE	PFC Deadlock Detect enable mode.

Definition at line 90 of file openapi_pfc.h.

enum OPEN_PFC_FEATURE_IDS_t

Enumerator
OPEN_PFC_FEATURE_SUPPORTED	general support statement
OPEN_PFC_PORT_PRIORITY_FLOW_CONTROL_FEATURE_ID	port priority flow control feature
OPEN_PFC_TX_STATS_FEATURE_ID	tx stats feature

Definition at line 71 of file openapi_pfc.h.

enum OPEN_PFC_MODE_t

Enumerator
OPEN_PFC_MODE_DISABLE	PFC disable mode.
OPEN_PFC_MODE_ENABLE	PFC enable mode.

Definition at line 78 of file openapi_pfc.h.

enum OPEN_PFC_PRI_DROP_MODE_t

Enumerator
OPEN_PFC_PRI_DROP_MODE	priority drop mode
OPEN_PFC_PRI_NODROP_MODE	priority no drop mode

Definition at line 59 of file openapi_pfc.h.

enum OPEN_PFC_STATUS_t

Enumerator
OPEN_PFC_STATUS_ACTIVE	PFC status active.
OPEN_PFC_STATUS_INACTIVE	PFC status inactive.

Definition at line 84 of file openapi_pfc.h.

Function Documentation

open_error_t openapiIfPfcDeadlockConfigGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	priority,
		OPEN_PFC_DDR_MODE_t *	mode
	)

Get the deadlock detect mode for the priority on an interface.

Parameters

[in]	client_handle	Client handle.
[in]	intIfNum	Interface number.
[in]	priority	Priority to get.
[out]	mode	Deadlock detect mode on interface.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiIfPfcDeadlockConfigSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intIfNum,
		uint32_t	priority,
		OPEN_PFC_DDR_MODE_t	mode
	)

Enable/Disable deadlock detect for the priority on an interface.

Parameters

[in]	client_handle	Client handle.
[in]	intIfNum	Interface number.
[in]	priority	Priority to get.
[in]	mode	Deadlock detect mode on interface.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiIfPfcModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_PFC_MODE_t *	mode
	)

Get the pfc mode for the interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	mode	enabled for pfc or not.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiIfPfcModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_PFC_MODE_t	mode
	)

Enable an interface for PFC.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	mode	mode

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority to get.
[out]	mode	the drop mode of the interface.

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority
[in]	dropMode	drop mode

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority to get.
[out]	stat	the statistic.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiIfPfcRxStatGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	count
	)

Get the PFC Rx stat on an interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	count	PFC Rx statistic.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiIfPfcStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Clear the PFC stats on an interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiIfPfcStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_PFC_STATUS_t *	status
	)

Get the active status on the interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	status	The active status of the interface.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiIfPfcTxStatGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	count
	)

Get the PFC Tx stat on an interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	count	PFC Tx statistic.

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority.
[out]	mode	participation mode.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockDetectIntervalGet	(	openapiClientHandle_t *	client_handle,
		OPEN_PFC_DDR_DETECT_TIME_t *	val
	)

Get the deadlock detect interval.

Parameters

[in]	client_handle	Client handle.
[out]	val	Deadlock detect interval.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockDetectIntervalSet	(	openapiClientHandle_t *	client_handle,
		OPEN_PFC_DDR_DETECT_TIME_t	val
	)

Set the deadlock detect interval.

Parameters

[in]	client_handle	Client handle.
[in]	val	Deadlock detect interval.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockDetectTimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	priority,
		uint32_t *	det_time,
		uint32_t *	rec_time
	)

Get the deadlock detect time and recovery time for a priority.

Parameters

[in]	client_handle	Client handle.
[in]	priority	Priority to get.
[out]	det_time	Deadlock detect time.
[out]	rec_time	Deadlock recovery time.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockDetectTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	priority,
		uint32_t	val
	)

Set the deadlock detect time for a priority.

Parameters

[in]	client_handle	Client handle.
[in]	priority	Priority to get.
[in]	val	Deadlock detect time.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockRecoveryActionGet	(	openapiClientHandle_t *	client_handle,
		OPEN_PFC_DDR_ACTION_t *	val
	)

Get the deadlock recovery action.

Parameters

[in]	client_handle	Client handle.
[out]	val	Deadlock recovery action.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockRecoveryActionSet	(	openapiClientHandle_t *	client_handle,
		OPEN_PFC_DDR_ACTION_t	val
	)

Set the deadlock recovery action.

Parameters

[in]	client_handle	Client handle.
[in]	val	Deadlock recovery action.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcDeadlockRecoveryTimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	priority,
		uint32_t	val
	)

Set the deadlock recovery time for a priority.

Parameters

[in]	client_handle	Client handle.
[in]	priority	Priority to get.
[in]	val	Deadlock recovery time.

Return values

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.27

Examples:

pfc_example.c.

open_error_t openapiPfcMaxNoDropPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxPrio
	)

Returns the maximum priority that can be configured in PFC.

Parameters

[in]	client_handle	client handle.
[out]	maxPrio	maximum priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiPfcMinNoDropPriorityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	minPrio
	)

Returns the minimum priority that can be configured in PFC.

Parameters

[in]	client_handle	client handle.
[out]	minPrio	minimum priority.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiPfcOperLinkDelayAllowanceGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	allowance
	)

Gets the link delay allowance in bits for the interface.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	allowance	link delay allowance.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority to get.
[out]	mode	the drop mode of the interface.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiPfcPeerCapabilityGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	numPfcCap
	)

Get the capability of the peer.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	numPfcCap	capability of the peer.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

Note

if peer is not detected, numPfcCap is set to 0.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiPfcPeerCfgCompatibleGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	compatible
	)

Indicates if the peer configuration is compatible.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	compatible	peer configuration compatible.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiPfcPeerCompatibleCfgCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	count
	)

Gets the count of compatible configurations received from peer.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	count	count of compatible configurations.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiPfcPeerIncompatibleCfgCountGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	incompatibleCfgCount
	)

Gets the count of incompatible configurations received from peer.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	incompatibleCfgCount	incompatible count from peer.

Return values

OPEN_E_NONE	On success.
OPEN_E_PARAM	Bad parameter.
OPEN_E_FAIL	Some failure occurred.

OpEN API Version: 1.14

Examples:

pfc_example.c.

open_error_t openapiPfcPeerMbcStatusGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	mbcStatus
	)

Get the MACSEC bypass capability of the peer.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	mbcStatus	MACSEC bypass capability of peer.

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority.
[out]	mode	peer priority mode.

Return values

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

Examples:

pfc_example.c.

open_error_t openapiPfcPeerWillingGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	willing
	)

Get the willingness of the peer.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[out]	willing	willingness of the peer.

Return values

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

Examples:

pfc_example.c.

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.

Parameters

[in]	client_handle	client handle.
[in]	ifNum	interface number.
[in]	priority	priority to get.
[out]	count	Number of pfc packets tx on this priority

Return values

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

Examples:

pfc_example.c.