Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_ETS_TCG_NUM_MAX 7 /*<< Maximum ETS TCG number */ |
#define | OPEN_ETS_TCG_NUM_MIN 0 /*<< Minimum ETS TCG number */ |
#define | OPEN_LLDP_MGMT_STRING_SIZE_MAX (255+1) |
Functions | |
open_error_t | openapiDcbxAppPriTableGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t index, uint16_t *protocolId, uint32_t *protoSel, uint8_t *priority, OPEN_BOOL_t *appStatus) |
Get the application table. More... | |
open_error_t | openapiDcbxAutoCfgPortRoleGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_PORT_ROLE_t *role) |
Get the port role configuration. More... | |
open_error_t | openapiDcbxAutoCfgPortRoleSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_PORT_ROLE_t role) |
Set the port role for auto configuration. More... | |
open_error_t | openapiDcbxCfgSrcGet (openapiClientHandle_t *client_handle, uint32_t *ifNum, OPEN_BOOL_t *selected) |
Get the configuration port number. More... | |
open_error_t | openapiDcbxCounterGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *txCnt, uint32_t *rxCnt, uint32_t *errorFrames, uint32_t *unknownTlv) |
Get the DCBX counters. More... | |
open_error_t | openapiDcbxIntfIsCfgSrcGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isCfgSrc) |
Check the peer is config source for the auto configuration. More... | |
open_error_t | openapiDcbxIsValidIntf (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *valid) |
Determine if the interface is valid for DCBX. More... | |
open_error_t | openapiDcbxLocalEtsBwGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *bwList) |
Get local ETS bandwidth. More... | |
open_error_t | openapiDcbxLocalEtsSchedGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *schedList) |
Get the local scheduler type. More... | |
open_error_t | openapiDcbxOperStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_OP_STATUS *status) |
Get the operational status of DCBX. More... | |
open_error_t | openapiDcbxPeerAppPriTableGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t index, uint16_t *protocolId, uint32_t *protoSel, uint8_t *priority, OPEN_BOOL_t *appStatus) |
Get Peer application table. More... | |
open_error_t | openapiDcbxPeerDescGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *descr) |
Get the system description of the peer device. More... | |
open_error_t | openapiDcbxPeerMacGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *macAddr) |
Get the MAC address of remote DCBX device. More... | |
open_error_t | openapiDcbxPeerTlvMaskGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_CAPABILITIES_t *peerTlvMask) |
Get peer TLV supported mask. More... | |
open_error_t | openapiDcbxPeerVersionGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_VERSION_t *mode) |
Get the peer DCBX running version. More... | |
open_error_t | openapiDcbxPortConfigTLVsEnabledGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_CAPABILITIES_t *dcbxCap) |
Get bit mask of DCBX TLVs enabled. More... | |
open_error_t | openapiDcbxPortConfigTLVsEnabledSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_CAPABILITIES_t dcbxCap) |
Set bit mask of enabled DCBX TLVs. More... | |
open_error_t | openapiDcbxPortLegacyRemMaxVerGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *maxVer) |
Get the Max version supported by the remote legacy DCBX device. More... | |
open_error_t | openapiDcbxPortLegacyRemOperVerGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *operVer) |
Get the Oper version supported by remote legacy DCBX device. More... | |
open_error_t | openapiDcbxPortLegacyRemRcvdAckNumGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rcvdAckNum) |
Get the current ACK number that is sent by peer in DCBX control TLVs in Legacy mode. More... | |
open_error_t | openapiDcbxPortLegacyRemSeqNumGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *seqNum) |
Get the current sequence number that is sent in DCBX control TLVs in Legacy Mode. More... | |
open_error_t | openapiDcbxPortOperationalModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_VERSION_t *version) |
Gets the DCBX TLVs that need to be transmitted in the LLDP PDU. More... | |
open_error_t | openapiDcbxPortWillingGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *willing) |
Get the port local willing status. More... | |
open_error_t | openapiDcbxTimedOutAndMultiPeerCountGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *timedOutCount, uint32_t *multiPeerCount) |
Get the timed-out and multi-peer counts for an interface. More... | |
open_error_t | openapiDcbxVersionGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_VERSION_t *version) |
Get the DCBX version. More... | |
open_error_t | openapiDcbxVersionSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DCBX_VERSION_t version) |
Set the DCBX version. More... | |
open_error_t openapiDcbxAppPriTableGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | index, | ||
uint16_t * | protocolId, | ||
uint32_t * | protoSel, | ||
uint8_t * | priority, | ||
OPEN_BOOL_t * | appStatus | ||
) |
Get the application table.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | index | Index to the application priority |
[out] | protocolId | protocol Id(ethertype or socket num) |
[out] | protoSel | protocol sel |
[out] | priority | dot1p priority |
[out] | appStatus | application status |
OPEN_E_NONE | On success. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxAutoCfgPortRoleGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_PORT_ROLE_t * | role | ||
) |
Get the port role configuration.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | role | role. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxAutoCfgPortRoleSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_PORT_ROLE_t | role | ||
) |
Set the port role for auto configuration.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | role | port role for auto configuration. |
OPEN_E_NONE | On success. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxCfgSrcGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | ifNum, | ||
OPEN_BOOL_t * | selected | ||
) |
Get the configuration port number.
[in] | client_handle | client handle. |
[out] | ifNum | interface number. |
[out] | selected | if OPEN_TRUE, config source is selected. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxCounterGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | txCnt, | ||
uint32_t * | rxCnt, | ||
uint32_t * | errorFrames, | ||
uint32_t * | unknownTlv | ||
) |
Get the DCBX counters.
[in] | client_handle | client handle. |
[in] | ifNum | Interface Number |
[out] | txCnt | Transmits |
[out] | rxCnt | Receives |
[out] | errorFrames | error frames |
[out] | unknownTlv | unknown TLV |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxIntfIsCfgSrcGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | isCfgSrc | ||
) |
Check the peer is config source for the auto configuration.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | isCfgSrc | OPEN_TRUE if peer is config src, else OPEN_FALSE. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxIsValidIntf | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | valid | ||
) |
Determine if the interface is valid for DCBX.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | valid | OPEN_TRUE if valid, OPEN_FALSE otherwise. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxLocalEtsBwGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | bwList | ||
) |
Get local ETS bandwidth.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | bwList | bandwidth list. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxLocalEtsSchedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | schedList | ||
) |
Get the local scheduler type.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | schedList | scheduler list. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxOperStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_OP_STATUS * | status | ||
) |
Get the operational status of DCBX.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | status | status. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPeerAppPriTableGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t | index, | ||
uint16_t * | protocolId, | ||
uint32_t * | protoSel, | ||
uint8_t * | priority, | ||
OPEN_BOOL_t * | appStatus | ||
) |
Get Peer application table.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | index | Index to the application priority |
[out] | protocolId | protocol Id(ethertype or socket num) |
[out] | protoSel | protocol sel |
[out] | priority | dot1p priority |
[out] | appStatus | application status |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_NOT_FOUND | Peer is not present |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPeerDescGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | descr | ||
) |
Get the system description of the peer device.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | descr | description string. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPeerMacGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
open_buffdesc * | macAddr | ||
) |
Get the MAC address of remote DCBX device.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | macAddr | mac addr. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPeerTlvMaskGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_CAPABILITIES_t * | peerTlvMask | ||
) |
Get peer TLV supported mask.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | peerTlvMask | mask of TLV supported. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_NOT_FOUND | No peer detected. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPeerVersionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_VERSION_t * | mode | ||
) |
Get the peer DCBX running version.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | mode | peer DCBX running version. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortConfigTLVsEnabledGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_CAPABILITIES_t * | dcbxCap | ||
) |
Get bit mask of DCBX TLVs enabled.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | dcbxCap | mask of enabled DCBX TLVs. |
OPEN_E_NONE | On success. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortConfigTLVsEnabledSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_CAPABILITIES_t | dcbxCap | ||
) |
Set bit mask of enabled DCBX TLVs.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | dcbxCap | mask of enabled DCBX TLVs. |
OPEN_E_NONE | On success. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortLegacyRemMaxVerGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | maxVer | ||
) |
Get the Max version supported by the remote legacy DCBX device.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | maxVer | max version number. |
OPEN_E_NONE | On success. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortLegacyRemOperVerGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | operVer | ||
) |
Get the Oper version supported by remote legacy DCBX device.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | operVer | operVer. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortLegacyRemRcvdAckNumGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | rcvdAckNum | ||
) |
Get the current ACK number that is sent by peer in DCBX control TLVs in Legacy mode.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | rcvdAckNum | received ack number. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortLegacyRemSeqNumGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | seqNum | ||
) |
Get the current sequence number that is sent in DCBX control TLVs in Legacy Mode.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | seqNum | sequence number. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortOperationalModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_VERSION_t * | version | ||
) |
Gets the DCBX TLVs that need to be transmitted in the LLDP PDU.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | version | version. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxPortWillingGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_BOOL_t * | willing | ||
) |
Get the port local willing status.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | willing | port local willing status. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxTimedOutAndMultiPeerCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
uint32_t * | timedOutCount, | ||
uint32_t * | multiPeerCount | ||
) |
Get the timed-out and multi-peer counts for an interface.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | timedOutCount | timed-out count. |
[out] | multiPeerCount | multi-peer count. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxVersionGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_VERSION_t * | version | ||
) |
Get the DCBX version.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[out] | version | DCBX version. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_UNAVAIL | Interface not supported. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14
open_error_t openapiDcbxVersionSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_DCBX_VERSION_t | version | ||
) |
Set the DCBX version.
[in] | client_handle | client handle. |
[in] | ifNum | interface number. |
[in] | version | version. |
OPEN_E_NONE | On success. |
OPEN_E_PARAM | Bad parameter. |
OPEN_E_FAIL | Some failure occurred. |
OpEN API Version: 1.14