Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Enumerations | Functions
Cable Test Configuration And Status [OPENAPI_CABLE_STATUS]

Enumerations

enum  OPEN_CABLE_STATUS_t {
  OPEN_CABLE_STATUS_UNTESTED = 0, OPEN_CABLE_STATUS_TEST_FAIL = 1, OPEN_CABLE_STATUS_NORMAL = 2, OPEN_CABLE_STATUS_OPEN = 3,
  OPEN_CABLE_STATUS_SHORT = 4, OPEN_CABLE_STATUS_OPENSHORT = 5, OPEN_CABLE_STATUS_CROSSTALK = 6, OPEN_CABLE_STATUS_NOCABLE = 7
}
 

Functions

open_error_t openapiCableStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CABLE_STATUS_t *cableStatus, uint32_t *lengthKnown, uint32_t *shortestLength, uint32_t *longestLength, uint32_t *cableFailureLength)
 Test the status of the cable attached to a given interface and report result. More...
 

Detailed Description

Enumeration Type Documentation

Enumerator
OPEN_CABLE_STATUS_UNTESTED 

Test has not been run for this interface.

OPEN_CABLE_STATUS_TEST_FAIL 

Test failed for unknown reason.

OPEN_CABLE_STATUS_NORMAL 

Cable is OK.

OPEN_CABLE_STATUS_OPEN 

Cable is not connected on one end.

OPEN_CABLE_STATUS_SHORT 

Cable is shorted.

OPEN_CABLE_STATUS_OPENSHORT 

Cable has an open or short, platform cannot determine which.

OPEN_CABLE_STATUS_CROSSTALK 

Cable has crosstalk.

OPEN_CABLE_STATUS_NOCABLE 

Cable is not present.

Definition at line 43 of file openapi_cable_status.h.

Function Documentation

open_error_t openapiCableStatusGet ( openapiClientHandle_t client_handle,
uint32_t  ifNum,
OPEN_CABLE_STATUS_t cableStatus,
uint32_t *  lengthKnown,
uint32_t *  shortestLength,
uint32_t *  longestLength,
uint32_t *  cableFailureLength 
)

Test the status of the cable attached to a given interface and report result.

All length parameters expressed in meters.

Parameters
[in]client_handleclient handle from registration API
[in]ifNumInterface number
[out]cableStatuscable status detected
[out]lengthKnownif 0, cable length could not be determined, otherwise length data is valid
[out]shortestLengthcable length range shorter limit
[out]longestLengthcable length range longer limit
[out]cableFailureLengthdistance along cable to detected fault
Return values
OPEN_E_NONETest completed successfully
OPEN_E_ERRORThe cable is not of the proper type for the test or the interface does not exist
OPEN_E_FAILFailed to complete the cable test
OPEN_E_PARAMError in parameter passed
OPEN_E_INTERNALOther internal error
Note
Only valid for copper cables

OpEN API Version: 1.14