This Code Implements The OpEN LinuxPTP API [OPENAPI_LINUXPTP]

Macros
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_INTERVAL_DEFAULT   1
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_INTERVAL_MAXIMUM   4
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_TIMEOUT_DEFAULT   3
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_TIMEOUT_MAXIMUM   10
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_ANNOUNCE_TIMEOUT_MINIMUM   2
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DELAY_REQ_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DELAY_REQ_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DOMAIN_DEFAULT   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DOMAIN_MAXIMUM   127
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_DOMAIN_MINIMUM   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_PDELAY_REQ_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_PDELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_PDELAY_REQ_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_SYNC_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_SYNC_INTERVAL_MAXIMUM   1
#define	OPEN_LINUXPTP_1588_DEFAULT_PROFILE_SYNC_INTERVAL_MINIMUM   -1
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_INTERVAL_DEFAULT   1
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_INTERVAL_MAXIMUM   4
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_TIMEOUT_DEFAULT   3
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_TIMEOUT_MAXIMUM   10
#define	OPEN_LINUXPTP_AES67_PROFILE_ANNOUNCE_TIMEOUT_MINIMUM   2
#define	OPEN_LINUXPTP_AES67_PROFILE_DELAY_REQ_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_AES67_PROFILE_DELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_AES67_PROFILE_DELAY_REQ_INTERVAL_MINIMUM   -3
#define	OPEN_LINUXPTP_AES67_PROFILE_DOMAIN_DEFAULT   0
#define	OPEN_LINUXPTP_AES67_PROFILE_DOMAIN_MAXIMUM   127
#define	OPEN_LINUXPTP_AES67_PROFILE_DOMAIN_MINIMUM   0
#define	OPEN_LINUXPTP_AES67_PROFILE_PDELAY_REQ_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_AES67_PROFILE_PDELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_AES67_PROFILE_PDELAY_REQ_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_AES67_PROFILE_SYNC_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_AES67_PROFILE_SYNC_INTERVAL_MAXIMUM   1
#define	OPEN_LINUXPTP_AES67_PROFILE_SYNC_INTERVAL_MINIMUM   -4
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_INTERVAL_MAXIMUM   1
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_INTERVAL_MINIMUM   0
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_TIMEOUT_DEFAULT   3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_TIMEOUT_MAXIMUM   3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_ANNOUNCE_TIMEOUT_MINIMUM   3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DELAY_REQ_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DELAY_REQ_INTERVAL_MINIMUM   -4
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DOMAIN_DEFAULT   127
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DOMAIN_MAXIMUM   127
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_DOMAIN_MINIMUM   127
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_PDELAY_REQ_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_PDELAY_REQ_INTERVAL_MAXIMUM   5
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_PDELAY_REQ_INTERVAL_MINIMUM   -4
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_SYNC_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_SYNC_INTERVAL_MAXIMUM   1
#define	OPEN_LINUXPTP_AES_R16_2016_PROFILE_SYNC_INTERVAL_MINIMUM   -4
#define	OPEN_LINUXPTP_PRIORITY_1_DEFAULT   128
#define	OPEN_LINUXPTP_PRIORITY_1_MAXIMUM   255
#define	OPEN_LINUXPTP_PRIORITY_1_MINIMUM   0
#define	OPEN_LINUXPTP_PRIORITY_2_DEFAULT   128
#define	OPEN_LINUXPTP_PRIORITY_2_MAXIMUM   255
#define	OPEN_LINUXPTP_PRIORITY_2_MINIMUM   0
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_INTERVAL_DEFAULT   0
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_INTERVAL_MAXIMUM   1
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_INTERVAL_MINIMUM   -3
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_TIMEOUT_DEFAULT   3
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_TIMEOUT_MAXIMUM   10
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_ANNOUNCE_TIMEOUT_MINIMUM   2
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DELAY_REQ_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DELAY_REQ_INTERVAL_MAXIMUM   4
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DELAY_REQ_INTERVAL_MINIMUM   -7
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DOMAIN_DEFAULT   127
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DOMAIN_MAXIMUM   127
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_DOMAIN_MINIMUM   0
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_PDELAY_REQ_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_PDELAY_REQ_INTERVAL_MAXIMUM   4
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_PDELAY_REQ_INTERVAL_MINIMUM   -7
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_SYNC_INTERVAL_DEFAULT   -3
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_SYNC_INTERVAL_MAXIMUM   -1
#define	OPEN_LINUXPTP_SMPTE_2059_2_PROFILE_SYNC_INTERVAL_MINIMUM   -7

Enumerations
enum	OPEN_LINUXPTP_CLOCK_OPERATION_t { OPEN_LINUXPTP_CLOCK_OPER_NONE = 0, OPEN_LINUXPTP_TWO_STEP = 1, OPEN_LINUXPTP_ONE_STEP = 2 }
enum	OPEN_LINUXPTP_CLOCK_PRIORITY_t { OPEN_LINUXPTP_CLOCK_PRIORITY1 = 0, OPEN_LINUXPTP_CLOCK_PRIORITY2 }
enum	OPEN_LINUXPTP_DELAY_MECHANISM_t {   OPEN_LINUXPTP_E2E_DELAY_MECHANISM = 1, OPEN_LINUXPTP_P2P_DELAY_MECHANISM = 2, OPEN_LINUXPTP_COMMON_P2P_DELAY_MECHANISM = 3, OPEN_LINUXPTP_SPECIAL_DELAY_MECHANISM = 4,   OPEN_LINUXPTP_NO_DELAY_MECHANISM = 254 }
enum	OPEN_LINUXPTP_DS_TYPE_t {   OPEN_LINUXPTP_DS_NONE = 0, OPEN_LINUXPTP_PARENTDS_PARENT_IDENTITY, OPEN_LINUXPTP_PARENTDS_PARENT_STATS, OPEN_LINUXPTP_PARENTDS_PARENT_OFFSET,   OPEN_LINUXPTP_PARENTDS_PARENT_PHASE_CHANGE_RATE, OPEN_LINUXPTP_PARENTDS_GM_PRIORITY1, OPEN_LINUXPTP_PARENTDS_GM_CLASS, OPEN_LINUXPTP_PARENTDS_GM_ACCURACY,   OPEN_LINUXPTP_PARENTDS_GM_OFFSET, OPEN_LINUXPTP_PARENTDS_GM_PRIORITY2, OPEN_LINUXPTP_PARENTDS_GM_IDENTITY, OPEN_LINUXPTP_CURRENTDS_OFFSET_FROM_MASTER,   OPEN_LINUXPTP_CURRENTDS_STEPS_REMOVED, OPEN_LINUXPTP_CURRENTDS_MEAN_PATH_DELAY, OPEN_LINUXPTP_DEFAULTDS_TWO_STEP_FLAG, OPEN_LINUXPTP_DEFAULTDS_NUMBER_OF_PORTS,   OPEN_LINUXPTP_DEFAULTDS_PRIORITY1, OPEN_LINUXPTP_DEFAULTDS_CLASS, OPEN_LINUXPTP_DEFAULTDS_ACCURACY, OPEN_LINUXPTP_DEFAULTDS_OFFSET,   OPEN_LINUXPTP_DEFAULTDS_PRIORITY2, OPEN_LINUXPTP_DEFAULTDS_IDENTITY, OPEN_LINUXPTP_DEFAULTDS_DOMAIN_IDENTIFIER, OPEN_LINUXPTP_DS_LAST }
enum	OPEN_LINUXPTP_PORTSTATE_TYPE_t {   OPEN_LINUXPTP_PTP_PORT_STATE_NONE = 0, OPEN_LINUXPTP_PTP_PORT_STATE_INITIALIZING, OPEN_LINUXPTP_PTP_PORT_STATE_FAULTY, OPEN_LINUXPTP_PTP_PORT_STATE_DISABLED,   OPEN_LINUXPTP_PTP_PORT_STATE_LISTENING, OPEN_LINUXPTP_PTP_PORT_STATE_PRE_MASTER, OPEN_LINUXPTP_PTP_PORT_STATE_MASTER, OPEN_LINUXPTP_PTP_PORT_STATE_PASSIVE,   OPEN_LINUXPTP_PTP_PORT_STATE_UNCALIBRATED, OPEN_LINUXPTP_PTP_PORT_STATE_SLAVE, OPEN_LINUXPTP_PTP_PORT_STATE_LAST }
enum	OPEN_LINUXPTP_PROFILES_t { OPEN_LINUXPTP_PROFILE_DEFAULT = 0, OPEN_LINUXPTP_PROFILE_AES67 = 1, OPEN_LINUXPTP_PROFILE_SMPTE_2059_2 = 2, OPEN_LINUXPTP_PROFILE_AES_R16_2016 = 3 }
enum	OPEN_LINUXPTP_STATS_TYPE_t {   OPEN_LINUXPTP_STATS_NONE = 0, OPEN_LINUXPTP_ANNOUNCE_TX_COUNT, OPEN_LINUXPTP_ANNOUNCE_RX_COUNT, OPEN_LINUXPTP_ANNOUNCE_RX_TIMEOUTS,   OPEN_LINUXPTP_SYNC_TX_COUNT, OPEN_LINUXPTP_SYNC_RX_COUNT, OPEN_LINUXPTP_SYNC_MISMATCH, OPEN_LINUXPTP_SYNC_RX_TIMEOUTS,   OPEN_LINUXPTP_FOLLOWUP_TX_COUNT, OPEN_LINUXPTP_FOLLOWUP_RX_COUNT, OPEN_LINUXPTP_FOLLOWUP_MISMATCH, OPEN_LINUXPTP_DELAY_REQ_TX_COUNT,   OPEN_LINUXPTP_DELAY_REQ_RX_COUNT, OPEN_LINUXPTP_PDELAY_REQ_TX_COUNT, OPEN_LINUXPTP_PDELAY_REQ_RX_COUNT, OPEN_LINUXPTP_PDELAY_RESP_TX_COUNT,   OPEN_LINUXPTP_PDELAY_RESP_RX_COUNT, OPEN_LINUXPTP_DELAY_RESP_TX_COUNT, OPEN_LINUXPTP_DELAY_RESP_RX_COUNT, OPEN_LINUXPTP_PDELAY_RESP_FOLLOWUP_TX_COUNT,   OPEN_LINUXPTP_PDELAY_RESP_FOLLOWUP_RX_COUNT, OPEN_LINUXPTP_SIGNALING_TX_COUNT, OPEN_LINUXPTP_SIGNALING_RX_COUNT, OPEN_LINUXPTP_MANAGEMENT_TX_COUNT,   OPEN_LINUXPTP_MANAGEMENT_RX_COUNT, OPEN_LINUXPTP_STATS_LAST }
enum	OPEN_LINUXPTP_TIME_PROPERTIES_TYPE_t {   OPEN_LINUXPTP_TIME_PROPERTIES_NONE = 0, OPEN_LINUXPTP_TIME_PROPERTIES_CURRENTUTCOFFSET, OPEN_LINUXPTP_TIME_PROPERTIES_LEAP61, OPEN_LINUXPTP_TIME_PROPERTIES_LEAP59,   OPEN_LINUXPTP_TIME_PROPERTIES_CURRENTUTCOFFSETVALID, OPEN_LINUXPTP_TIME_PROPERTIES_PTPTIMESCALE, OPEN_LINUXPTP_TIME_PROPERTIES_TIMETRACEABLE, OPEN_LINUXPTP_TIME_PROPERTIES_FREQUENCYTRACEABLE,   OPEN_LINUXPTP_TIME_PROPERTIES_TIMESOURCE, OPEN_LINUXPTP_TIME_PROPERTIES_LAST }
enum	OPEN_LINUXPTP_TRANSPORT_MODE_t { OPEN_LINUXPTP_TRANSPORT_NONE = 0, OPEN_LINUXPTP_TRANSPORT_V4, OPEN_LINUXPTP_TRANSPORT_V6, OPEN_LINUXPTP_TRANSPORT_L2 }

Functions
open_error_t	openapiLinuxptpAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode)
	Get the linuxPTP Global Admin Mode. More...
open_error_t	openapiLinuxptpAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Set the linuxPTP Global Admin Mode. More...
open_error_t	openapiLinuxptpAnnounceIntervalGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t *announceInterval)
	Get the configured linuxPTP announce interval for a given profile. More...
open_error_t	openapiLinuxptpAnnounceIntervalSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t announceInterval)
	Configure announce interval for given PTP profile. More...
open_error_t	openapiLinuxptpAnnounceTimeoutGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, uint32_t *announceTimeout)
	Get the linuxPTP announce timeout value for a given profile. More...
open_error_t	openapiLinuxptpAnnounceTimeoutSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, uint32_t announceTimeout)
	Configure announce timeout for given PTP profile. More...
open_error_t	openapiLinuxptpBridgePriorityGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_CLOCK_PRIORITY_t prioType, uint32_t *prioVal)
	Get priority value of the local clock. More...
open_error_t	openapiLinuxptpBridgePrioritySet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_CLOCK_PRIORITY_t prioType, uint32_t prioVal)
	Configure priority value of the local clock. More...
open_error_t	openapiLinuxptpClockIdGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_DS_TYPE_t type, open_buffdesc *identity)
	Fetch parent or GM or local clock identity. More...
open_error_t	openapiLinuxptpClockMeanPathDelayGet (openapiClientHandle_t *client_handle, open_buffdesc *clockMeanPathDelay)
	Fetch E2E mean path delay. More...
open_error_t	openapiLinuxptpClockOffsetFromMaster (openapiClientHandle_t *client_handle, open_buffdesc *offsetFromMaster)
	Fetch current clock offset in time between slave and master. More...
open_error_t	openapiLinuxptpClockOperModeGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_CLOCK_OPERATION_t *operMode)
	Get the Clock Operation for the local clock. More...
open_error_t	openapiLinuxptpClockOperModeSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_CLOCK_OPERATION_t operMode)
	Configure PTP clock operation mode. More...
open_error_t	openapiLinuxptpClockParamGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_DS_TYPE_t type, int32_t *value)
	Fetch parent or GM or local clock parameters. More...
open_error_t	openapiLinuxptpClockRoleGet (openapiClientHandle_t *client_handle, uint32_t *clockRole)
	Status of the mode the clock is operating in master or slave. More...
open_error_t	openapiLinuxptpClockStepsRemovedGet (openapiClientHandle_t *client_handle, uint32_t *stepsRemoved)
	Fetch number of boundary clocks between local clock and foreign master. More...
open_error_t	openapiLinuxptpDelayMechanismGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, OPEN_LINUXPTP_DELAY_MECHANISM_t *delayMech)
	Get the linuxPTP delay mechanism for a given profile. More...
open_error_t	openapiLinuxptpDelayMechanismSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, OPEN_LINUXPTP_DELAY_MECHANISM_t delayMech)
	Configure PTP delay mechanism. More...
open_error_t	openapiLinuxptpDelayRequestIntervalGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t *delayReqInterval)
	Get the linuxPTP delay request Interval for a given profile. More...
open_error_t	openapiLinuxptpDelayRequestIntervalSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t delayReqInterval)
	Configure delay request interval for given PTP profile. More...
open_error_t	openapiLinuxptpDomainGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, uint32_t *domain)
	Get the linuxPTP Domain for a given profile. More...
open_error_t	openapiLinuxptpDomainSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, uint32_t domain)
	Configure domain number for given PTP profile. More...
open_error_t	openapiLinuxptpIntfAdminModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t *mode)
	Get the linuxPTP interface Admin Mode. More...
open_error_t	openapiLinuxptpIntfAdminModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_CONTROL_t mode)
	Set the linuxPTP interface Admin Mode. More...
open_error_t	openapiLinuxptpIntfDelayGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *p2pPathDelay)
	Fetch P2P mean path delay. More...
open_error_t	openapiLinuxptpIntfOperStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *status)
	Get PTP interface operational status. More...
open_error_t	openapiLinuxptpIntfStateGet (openapiClientHandle_t *client_handle, uint32_t ifNum, int32_t *portState)
	Fetch PTP port state. More...
open_error_t	openapiLinuxptpIntfStatsClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
	Clear PTP statistics on an interface. More...
open_error_t	openapiLinuxptpIntfStatsGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINUXPTP_STATS_TYPE_t statType, int32_t *statsCount)
	Fetch statistics for the given type on an interface. More...
open_error_t	openapiLinuxptpIpv6McScopeGet (openapiClientHandle_t *client_handle, uint32_t *mcScope)
	Get LinuxPTP IPv6 multicast destination scope. More...
open_error_t	openapiLinuxptpIpv6McScopeSet (openapiClientHandle_t *client_handle, open_buffdesc *mcScope)
	Set LinuxPTP IPv6 multicast desination scope. More...
open_error_t	openapiLinuxptpIsDomainExists (openapiClientHandle_t *client_handle, uint32_t domain, OPEN_BOOL_t *isValidDomain)
	Check if the passed domain identifier is configured. More...
open_error_t	openapiLinuxptpIsSupported (openapiClientHandle_t *client_handle, OPEN_BOOL_t *isLinuxptpSupported)
	Check whether Linux PTP is supported. More...
open_error_t	openapiLinuxptpIsValidIntf (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isValid)
	Check whether the interface is eligible for linuxptp operation. More...
open_error_t	openapiLinuxptpLoggingGet (openapiClientHandle_t *client_handle, uint32_t *level)
	Fetch PTP logging severity level. More...
open_error_t	openapiLinuxptpLoggingSet (openapiClientHandle_t *client_handle, uint32_t level)
	Configure PTP logging severity level. More...
open_error_t	openapiLinuxptpParentClockOperModeGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_CLOCK_OPERATION_t *operMode)
	Get LinuxPTP parent clock operation mode. More...
open_error_t	openapiLinuxptpPathTraceClockIdGetNext (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_DS_TYPE_t type, open_buffdesc *identity)
	Fetch next clock identity in the path. More...
open_error_t	openapiLinuxptpPathTraceTlvGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *traceMode)
	Fetch PTP path trace TLV status. More...
open_error_t	openapiLinuxptpPathTraceTlvSet (openapiClientHandle_t *client_handle, OPEN_BOOL_t traceMode)
	Configure PTP path trace TLV. More...
open_error_t	openapiLinuxptpPdelayRequestIntervalGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t *pDelayReqInterval)
	Get the linuxPTP peer delay request Interval for a given profile. More...
open_error_t	openapiLinuxptpPdelayRequestIntervalSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t pDelayReqInterval)
	Configure peer delay request interval for given PTP profile. More...
open_error_t	openapiLinuxptpProcessRunningStatusGet (openapiClientHandle_t *client_handle, OPEN_BOOL_t *processStatus)
	Get LinuxPTP process running status. More...
open_error_t	openapiLinuxptpProfileGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t *ptpProfile)
	Get the active linuxPTP profile. More...
open_error_t	openapiLinuxptpProfileSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile)
	Configure PTP profile. More...
open_error_t	openapiLinuxptpSourceIPv4AddrGet (openapiClientHandle_t *client_handle, uint32_t *ipAddr)
	Get the source IPv4 address used for linuxPTP communication. More...
open_error_t	openapiLinuxptpSourceIPv4AddrSet (openapiClientHandle_t *client_handle, uint32_t ipAddr)
	Configure source IPv4 address to be used for linuxPTP communication. More...
open_error_t	openapiLinuxptpSourceIPv6AddrGet (openapiClientHandle_t *client_handle, open_in6_addr_t *ipAddr)
	Get the source IPv6 address used for linuxPTP communication. More...
open_error_t	openapiLinuxptpSourceIPv6AddrSet (openapiClientHandle_t *client_handle, open_in6_addr_t ipAddr)
	Configure source IPv6 address to be used for linuxPTP communication. More...
open_error_t	openapiLinuxptpSyncIntervalGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t *syncInterval)
	Get the linuxPTP Sync Interval for a given profile. More...
open_error_t	openapiLinuxptpSyncIntervalSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, int32_t syncInterval)
	Configure sync interval for given PTP profile. More...
open_error_t	openapiLinuxptpTimePropGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_TIME_PROPERTIES_TYPE_t type, int32_t *value)
	Fetch time properties information. More...
open_error_t	openapiLinuxptpTransportGet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, OPEN_LINUXPTP_TRANSPORT_MODE_t *transMode)
	Get the linuxPTP transport for a given profile. More...
open_error_t	openapiLinuxptpTransportSet (openapiClientHandle_t *client_handle, OPEN_LINUXPTP_PROFILES_t ptpProfile, OPEN_LINUXPTP_TRANSPORT_MODE_t transMode)
	Configure PTP profile's transport mode. More...

Detailed Description

Function Documentation

open_error_t openapiLinuxptpAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	mode
	)

Get the linuxPTP Global Admin Mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Global admin mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Set the linuxPTP Global Admin Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Global admin mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpAnnounceIntervalGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t *	announceInterval
	)

Get the configured linuxPTP announce interval for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	announceInterval	Announce interval

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpAnnounceIntervalSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t	announceInterval
	)

Configure announce interval for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	announceInterval	time interval b/w announce frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpAnnounceTimeoutGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		uint32_t *	announceTimeout
	)

Get the linuxPTP announce timeout value for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	announceTimeout	Announce timeout

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpAnnounceTimeoutSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		uint32_t	announceTimeout
	)

Configure announce timeout for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	announceTimeout	Announce timeout

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpBridgePriorityGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_CLOCK_PRIORITY_t	prioType,
		uint32_t *	prioVal
	)

Get priority value of the local clock.

Parameters

[in]	client_handle	client handle from registration API
[in]	prioType	priority 1 or 2
[out]	prioVal	priority value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpBridgePrioritySet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_CLOCK_PRIORITY_t	prioType,
		uint32_t	prioVal
	)

Configure priority value of the local clock.

Parameters

[in]	client_handle	client handle from registration API
[in]	prioType	priority 1 or 2
[in]	prioVal	priority value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockIdGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_DS_TYPE_t	type,
		open_buffdesc *	identity
	)

Fetch parent or GM or local clock identity.

Parameters

[in]	client_handle	client handle from registration API
[in]	type	Clock type
[out]	identity	clock identity

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockMeanPathDelayGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	clockMeanPathDelay
	)

Fetch E2E mean path delay.

Parameters

[in]	client_handle	client handle from registration API
[out]	clockMeanPathDelay	E2E mean path delay

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockOffsetFromMaster	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	offsetFromMaster
	)

Fetch current clock offset in time between slave and master.

Parameters

[in]	client_handle	client handle from registration API
[out]	offsetFromMaster	clock offset from master clock

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockOperModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_CLOCK_OPERATION_t *	operMode
	)

Get the Clock Operation for the local clock.

Parameters

[in]	client_handle	client handle from registration API
[out]	operMode	one-step or two-step

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockOperModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_CLOCK_OPERATION_t	operMode
	)

Configure PTP clock operation mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	operMode	one-step or two-step

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockParamGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_DS_TYPE_t	type,
		int32_t *	value
	)

Fetch parent or GM or local clock parameters.

Parameters

[in]	client_handle	client handle from registration API
[in]	type	Clock type
[out]	value	fetched value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockRoleGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	clockRole
	)

Status of the mode the clock is operating in master or slave.

Parameters

[in]	client_handle	client handle from registration API
[out]	clockRole	Clock role

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpClockStepsRemovedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	stepsRemoved
	)

Fetch number of boundary clocks between local clock and foreign master.

Parameters

[in]	client_handle	client handle from registration API
[out]	stepsRemoved	hops to foreign master

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDelayMechanismGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		OPEN_LINUXPTP_DELAY_MECHANISM_t *	delayMech
	)

Get the linuxPTP delay mechanism for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	delayMech	Delay Mechanism, E2E or P2P

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDelayMechanismSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		OPEN_LINUXPTP_DELAY_MECHANISM_t	delayMech
	)

Configure PTP delay mechanism.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	delayMech	Either end-to-end or peer-to-peer delay calculation mechanism

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDelayRequestIntervalGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t *	delayReqInterval
	)

Get the linuxPTP delay request Interval for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	delayReqInterval	Time interval b/w delay-request frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDelayRequestIntervalSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t	delayReqInterval
	)

Configure delay request interval for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	delayReqInterval	Time interval b/w delay-request frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDomainGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		uint32_t *	domain
	)

Get the linuxPTP Domain for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	domain	PTP domain identifier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpDomainSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		uint32_t	domain
	)

Configure domain number for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	domain	PTP domain identifier

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfAdminModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t *	mode
	)

Get the linuxPTP interface Admin Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	mode	interface admin mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfAdminModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_CONTROL_t	mode
	)

Set the linuxPTP interface Admin Mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[in]	mode	Interface admin mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available
OPEN_E_ERROR	If linuxPTP config is done on member unit interface.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfDelayGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_buffdesc *	p2pPathDelay
	)

Fetch P2P mean path delay.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	p2pPathDelay	delay measured using p2p

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfOperStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	status
	)

Get PTP interface operational status.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	status	Operational status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfStateGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		int32_t *	portState
	)

Fetch PTP port state.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	portState	PTP port state

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfStatsClear	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum
	)

Clear PTP statistics on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIntfStatsGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_LINUXPTP_STATS_TYPE_t	statType,
		int32_t *	statsCount
	)

Fetch statistics for the given type on an interface.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[in]	statType	statistic type
[out]	statsCount	statistics for the given type

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIpv6McScopeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	mcScope
	)

Get LinuxPTP IPv6 multicast destination scope.

Parameters

[in]	client_handle	client handle from registration API
[out]	mcScope	scope range is 0x0-0xf

Return values

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

OpEN API Version: 1.26

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIpv6McScopeSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	mcScope
	)

Set LinuxPTP IPv6 multicast desination scope.

Parameters

[in]	client_handle	client handle from registration API
[in]	mcScope	allowed scope values: 0x2,0x4,0x5 0x8 and 0xE

Return values

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

OpEN API Version: 1.28

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIsDomainExists	(	openapiClientHandle_t *	client_handle,
		uint32_t	domain,
		OPEN_BOOL_t *	isValidDomain
	)

Check if the passed domain identifier is configured.

Parameters

[in]	client_handle	client handle from registration API
[in]	domain	domain identifier
[out]	isValidDomain	Valid status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIsSupported	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	isLinuxptpSupported
	)

Check whether Linux PTP is supported.

Parameters

[in]	client_handle	client handle from registration API.
[out]	isLinuxptpSupported	is Linux PTP supported or not.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available.

Note

This API needs to be invoked before calling the Linux PTP OpEN APIs. If Linux PTP is not supported then OpEN APIs should not be called.

OpEN API Version: 1.26

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpIsValidIntf	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	isValid
	)

Check whether the interface is eligible for linuxptp operation.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	Interface number
[out]	isValid	Valid status

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpLoggingGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	level
	)

Fetch PTP logging severity level.

Parameters

[in]	client_handle	client handle from registration API
[out]	level	severity level

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpLoggingSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	level
	)

Configure PTP logging severity level.

Parameters

[in]	client_handle	client handle from registration API
[in]	level	severity level

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpParentClockOperModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_CLOCK_OPERATION_t *	operMode
	)

Get LinuxPTP parent clock operation mode.

Parameters

[in]	client_handle	client handle from registration API
[out]	operMode	Parent clock operation mode: one-step or two-step

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Not available.
OPEN_E_EMPTY	Not applicable.

OpEN API Version: 1.26

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpPathTraceClockIdGetNext	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_DS_TYPE_t	type,
		open_buffdesc *	identity
	)

Fetch next clock identity in the path.

Parameters

[in]	client_handle	client handle from registration API
[in]	type	Parent identity type
[out]	identity	Clock identity

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpPathTraceTlvGet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	traceMode
	)

Fetch PTP path trace TLV status.

Parameters

[in]	client_handle	client handle from registration API
[out]	traceMode	Trace mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpPathTraceTlvSet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t	traceMode
	)

Configure PTP path trace TLV.

Parameters

[in]	client_handle	client handle from registration API
[in]	traceMode	Trace mode

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpPdelayRequestIntervalGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t *	pDelayReqInterval
	)

Get the linuxPTP peer delay request Interval for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	pDelayReqInterval	Time interval b/w peer delay-request frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpPdelayRequestIntervalSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t	pDelayReqInterval
	)

Configure peer delay request interval for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	pDelayReqInterval	Time interval b/w peer delay-request frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpProcessRunningStatusGet	(	openapiClientHandle_t *	client_handle,
		OPEN_BOOL_t *	processStatus
	)

Get LinuxPTP process running status.

Parameters

[in]	client_handle	client handle from registration API
[out]	processStatus	Running status of LinuxPTP process

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available.

OpEN API Version: 1.26

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpProfileGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t *	ptpProfile
	)

Get the active linuxPTP profile.

Parameters

[in]	client_handle	client handle from registration API
[out]	ptpProfile	PTP profile

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpProfileSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile
	)

Configure PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSourceIPv4AddrGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	ipAddr
	)

Get the source IPv4 address used for linuxPTP communication.

Parameters

[in]	client_handle	client handle from registration API
[out]	ipAddr	source IPv4 address

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSourceIPv4AddrSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ipAddr
	)

Configure source IPv4 address to be used for linuxPTP communication.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	source IPv4 address

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSourceIPv6AddrGet	(	openapiClientHandle_t *	client_handle,
		open_in6_addr_t *	ipAddr
	)

Get the source IPv6 address used for linuxPTP communication.

Parameters

[in]	client_handle	client handle from registration API
[out]	ipAddr	source IPv6 address

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSourceIPv6AddrSet	(	openapiClientHandle_t *	client_handle,
		open_in6_addr_t	ipAddr
	)

Configure source IPv6 address to be used for linuxPTP communication.

Parameters

[in]	client_handle	client handle from registration API
[in]	ipAddr	source IPv6 address

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSyncIntervalGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t *	syncInterval
	)

Get the linuxPTP Sync Interval for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	syncInterval	Time interval b/w sync frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpSyncIntervalSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		int32_t	syncInterval
	)

Configure sync interval for given PTP profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	syncInterval	Time interval b/w sync frames

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpTimePropGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_TIME_PROPERTIES_TYPE_t	type,
		int32_t *	value
	)

Fetch time properties information.

Parameters

[in]	client_handle	client handle from registration API
[in]	type	Time properties type
[out]	value	Value

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpTransportGet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		OPEN_LINUXPTP_TRANSPORT_MODE_t *	transMode
	)

Get the linuxPTP transport for a given profile.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[out]	transMode	Mode : ethernet or ipv4 or ipv6

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

OpEN API Version: 1.25

Examples:

linuxptp_example.c.

open_error_t openapiLinuxptpTransportSet	(	openapiClientHandle_t *	client_handle,
		OPEN_LINUXPTP_PROFILES_t	ptpProfile,
		OPEN_LINUXPTP_TRANSPORT_MODE_t	transMode
	)

Configure PTP profile's transport mode.

Parameters

[in]	client_handle	client handle from registration API
[in]	ptpProfile	PTP profile
[in]	transMode	Mode : ethernet or ipv4 or ipv6

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.
OPEN_E_UNAVAIL	Feature not available

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.25

Examples:

linuxptp_example.c.