PTP TC Configuration And Status [OPENAPI_PTP_TC]

Functions
open_error_t	openapiPtpTcAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Gets PTP TC global administrative mode.
open_error_t	openapiPtpTcAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets PTP TC global administrative mode.
open_error_t	openapiPtpTcIntfAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_CONTROL_t *adminMode)
	Get PTP TC mode on the specified interface.
open_error_t	openapiPtpTcIntfAdminModeSet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_CONTROL_t adminMode)
	Set PTP TC mode on the specified interface.
open_error_t	openapiPtpTcIntfHwConfigAllowedGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_BOOL_t *isAllowed)
	Determine if interface configuration can be applied in hardware.
open_error_t	openapiPtpTcIntfOperAdminModeGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_CONTROL_t *mode)
	Gets PTP TC operational mode on the specified interface.
open_error_t	openapiPtpTcIsSupportedGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *isSupported)
	Check if the PTP TC is supported.
open_error_t	openapiPtpTcIsValidIntfGet (openapiClientHandle_t *client_handle, uint32_t intfNum, OPEN_BOOL_t *isValid)
	Check if the interface is valid for PTP TC.
open_error_t	openapiPtpTcIsValidUnitGet (openapiClientHandle_t *client_handle, uint32_t unit, OPEN_BOOL_t *isValid)
	Check if the unit is valid for PTP TC.

Detailed Description

Function Documentation

open_error_t openapiPtpTcAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Gets PTP TC global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	administrative mode

Return values

OPEN_E_NONE	Administrative mode get successful.
OPEN_E_FAIL	Administrative mode get failed.
OPEN_E_PARAM	Error in parameter passed.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets PTP TC global administrative mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	administrative mode

Return values

OPEN_E_NONE	Administrative mode set successful.
OPEN_E_FAIL	Administrative mode set failed.
OPEN_E_PARAM	Error in parameter passed.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIntfAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intfNum,
		OPEN_CONTROL_t *	adminMode
	)

Get PTP TC mode on the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intfNum	Interface number.
[out]	adminMode	Interface PTP TC admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIntfAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intfNum,
		OPEN_CONTROL_t	adminMode
	)

Set PTP TC mode on the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intfNum	Interface number.
[in]	adminMode	Interface PTP TC admin mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIntfHwConfigAllowedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intfNum,
		OPEN_BOOL_t *	isAllowed
	)

Determine if interface configuration can be applied in hardware.

Parameters

[in]	client_handle	client handle from registration API
[in]	intfNum	Interface number.
[out]	isAllowed	Flag to tell if Hardware configuration allowed.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIntfOperAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intfNum,
		OPEN_CONTROL_t *	mode
	)

Gets PTP TC operational mode on the specified interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	intfNum	Interface number.
[out]	mode	PTP TC operational mode.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIsSupportedGet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	isSupported
	)

Check if the PTP TC is supported.

Parameters

[in]

client_handle

client handle from registration API

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIsValidIntfGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	intfNum,
		OPEN_BOOL_t *	isValid
	)

Check if the interface is valid for PTP TC.

Parameters

[in]	client_handle	client handle from registration API
[in]	intfNum	Interface number.
[out]	isValid	Flag to tell if the interface is valid for PTP TC.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.

open_error_t openapiPtpTcIsValidUnitGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	unit,
		OPEN_BOOL_t *	isValid
	)

Check if the unit is valid for PTP TC.

Parameters

[in]	client_handle	client handle from registration API
[in]	unit	Unit number.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.20

Examples:

ptp_tc_example.c.