Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
Enhanced Transmission Session APIs [OPENAPI_ETS]

Macros

#define OPEN_DOT1P_MAX_PRIORITY   7
 
#define OPEN_DOT1P_MIN_PRIORITY   0
 
#define OPEN_ETS_BW_PERCENTAGE_MAX   100
 
#define OPEN_ETS_BW_PERCENTAGE_MIN   1
 
#define OPEN_ETS_TCG_NUM_MAX   7
 
#define OPEN_ETS_TCG_NUM_MIN   0
 

Functions

open_error_t openapiEtsPeerCbsStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *cbsStatus)
 Gets the cbs status received from peer. More...
 
open_error_t openapiEtsPeerIncompatibleCfgCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *incompatibleCfgCount)
 Gets the count of incompatible configurations received from peer. More...
 
open_error_t openapiEtsPeerMinBandwidthGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t tcg, uint8_t *bw)
 Gets the peer minimum bandwidth. More...
 
open_error_t openapiEtsPeerNumTcGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t priority, uint8_t *numTc)
 Gets the peer number of traffic class groups for the interface. More...
 
open_error_t openapiEtsPeerTsaGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t tcg, uint8_t *sched)
 Gets the peer schedule info. More...
 
open_error_t openapiEtsPeerWillingGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *willing)
 Get the willingness of the peer. More...
 

Detailed Description

Function Documentation

open_error_t openapiEtsPeerCbsStatusGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t cbsStatus 
)

Gets the cbs status received from peer.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[out]cbsStatuscbs status of the peer.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome failure occurred.

OpEN API Version: 1.14

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

Gets the count of incompatible configurations received from peer.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[out]incompatibleCfgCountCount of incompatible configurations.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome failure occurred.

OpEN API Version: 1.14

open_error_t openapiEtsPeerMinBandwidthGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  tcg,
uint8_t *  bw 
)

Gets the peer minimum bandwidth.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[out]tcgTCG index.
[out]bwMinimum bandwidth.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome failure occurred.
Note
tcg must be in the range [OPEN_ETS_TCG_NUM_MIN, OPEN_ETS_TCG_NUM_MAX] bandwidth values are percentage in range [OPEN_ETS_BW_PERCENTAGE_MIN, OPEN_ETS_BW_PERCENTAGE_MAX]

OpEN API Version: 1.14

open_error_t openapiEtsPeerNumTcGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  priority,
uint8_t *  numTc 
)

Gets the peer number of traffic class groups for the interface.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[in]priorityThe priority.
[out]numTcNumber of traffic classes.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_NOT_FOUNDPriority level is not supported.
OPEN_E_FAILSome failure occurred.

OpEN API Version: 1.14

open_error_t openapiEtsPeerTsaGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
uint32_t  tcg,
uint8_t *  sched 
)

Gets the peer schedule info.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[out]tcgTCG index.
[out]schedSchedule info.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_FAILSome failure occurred.
Note
tcg must be in the range [OPEN_ETS_TCG_NUM_MIN, OPEN_ETS_TCG_NUM_MAX]

OpEN API Version: 1.14

open_error_t openapiEtsPeerWillingGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_BOOL_t willing 
)

Get the willingness of the peer.

Parameters
[in]client_handleclient handle from registration API.
[in]ifNumInterface number.
[out]willingWillingness of the peer.
Return values
OPEN_E_NONEOn success.
OPEN_E_PARAMBad parameter.
OPEN_E_NOT_FOUNDPeer not detected.
OPEN_E_FAILSome failure occurred.

OpEN API Version: 1.14