PTP driver Interface

Interface for PTP functions. More...

Data Structures
struct	UInt64_t
struct	ptp_timestamp_t
struct	ptp_address_t
union	ptp_announce_flag_t
struct	ptp_clock_quality_t
struct	ptp_announce_message_t
struct	ptp_message_reception_t
struct	ptp_callback_args_t
struct	ptp_cfg_t
struct	ptp_api_t
struct	ptp_instance_t

Typedefs
typedef void	ptp_ctrl_t

Enumerations
enum	ptp_device_t {   PTP_DEVICE_DISABLED = 0xFFU, PTP_DEVICE_ORDINARY_CLOCK0 = 0U, PTP_DEVICE_ORDINARY_CLOCK1, PTP_DEVICE_BOUNDARY_CLOCK,   PTP_DEVICE_TRANSPARENT_CLOCK }
enum	ptp_delay_mechanism_t { PTP_DELAY_MECHANISM_DISABLED = 0xFFU, PTP_DELAY_MECHANISM_P2P = 0U, PTP_DELAY_MECHANISM_E2E }
enum	ptp_state_t { PTP_STATE_DISABLED = 0xFFU, PTP_STATE_MASTER = 0U, PTP_STATE_SLAVE, PTP_STATE_LISTENING }
enum	ptp_stca_mode_t { PTP_STCA_MODE_1 = 0x00U, PTP_STCA_MODE_2_HW = 0x02U, PTP_STCA_MODE_2_SW = 0x03U }
enum	ptp_frame_format_t {   PTP_FRAME_FORMAT_DISABLED = 0xFFU, PTP_FRAME_FORMAT_ETH = 0x00U, PTP_FRAME_FORMAT_ETH_8023, PTP_FRAME_FORMAT_UDP4,   PTP_FRAME_FORMAT_UDP4_8023 }
enum	ptp_stca_timer_channel_t {   PTP_STCA_TIMER_CHANNEL_0 = 0x01U, PTP_STCA_TIMER_CHANNEL_1 = 0x02U, PTP_STCA_TIMER_CHANNEL_2 = 0x04U, PTP_STCA_TIMER_CHANNEL_3 = 0x08U,   PTP_STCA_TIMER_CHANNEL_4 = 0x10U, PTP_STCA_TIMER_CHANNEL_5 = 0x20U }
enum	ptp_stca_timer_pulse_edge_t { PTP_STCA_TIMER_PULSE_EDGE_RISING = 0U, PTP_STCA_TIMER_PULSE_EDGE_FALLING }
enum	ptp_event_t {   PTP_EVENT_TIMER = 0U, PTP_EVENT_STCA, PTP_EVENT_PRCTC, PTP_EVENT_SYNFP0,   PTP_EVENT_SYNFP1 }

Detailed Description

Interface for PTP functions.

Summary

The PTP interface provides time synchronization functionality.

The PTP interface can be implemented by:

• PTP

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

PTP Interface description: PTP Driver on r_ptp

Typedef Documentation

ptp_ctrl_t

typedef void ptp_ctrl_t

PTP control block. Allocate an instance specific control block to pass into the PTP API calls.

Implemented as

• ptp_instance_ctrl_t

Enumeration Type Documentation

ptp_delay_mechanism_t

enum ptp_delay_mechanism_t

PTP Delay correction mechanism definitions

Enumerator
PTP_DELAY_MECHANISM_DISABLED	Unsupported.
PTP_DELAY_MECHANISM_P2P	Peer to peer delay mechanism.
PTP_DELAY_MECHANISM_E2E	End to end delay mechanism.

ptp_device_t

enum ptp_device_t

PTP Clock type definitions

Enumerator
PTP_DEVICE_DISABLED	Unsupported.
PTP_DEVICE_ORDINARY_CLOCK0	Ordinary Clock Port 0.
PTP_DEVICE_ORDINARY_CLOCK1	Ordinary Clock Port 1.
PTP_DEVICE_BOUNDARY_CLOCK	Boundary Clock.
PTP_DEVICE_TRANSPARENT_CLOCK	Transparent Clock.

ptp_event_t

enum ptp_event_t

MINT interrupt register definitions

Enumerator
PTP_EVENT_TIMER	Interrupt from Timer.
PTP_EVENT_STCA	Interrupt from STCA.
PTP_EVENT_PRCTC	Interrupt from PRC-TC.
PTP_EVENT_SYNFP0	Interrupt from SYNFP0.
PTP_EVENT_SYNFP1	Interrupt from SYNFP1.

ptp_frame_format_t

enum ptp_frame_format_t

PTP message frame format definitions

Enumerator
PTP_FRAME_FORMAT_DISABLED	Unsupported.
PTP_FRAME_FORMAT_ETH	Ethernet II frame format.
PTP_FRAME_FORMAT_ETH_8023	Ethernet 802.3 frame format.
PTP_FRAME_FORMAT_UDP4	Ethernet II over UDP4 frame format.
PTP_FRAME_FORMAT_UDP4_8023	Ethernet 802.3 over UDP4 frame format.

ptp_state_t

enum ptp_state_t

PTP clock state definitions

Enumerator
PTP_STATE_DISABLED	Unsupported.
PTP_STATE_MASTER	Master state.
PTP_STATE_SLAVE	Slave state.
PTP_STATE_LISTENING	Listening state.

ptp_stca_mode_t

enum ptp_stca_mode_t

STCA mode and gradient setting definitions

Enumerator
PTP_STCA_MODE_1	Mode1 (not use STCA)
PTP_STCA_MODE_2_HW	Mode2 (use STCA) and HW gradient setting.
PTP_STCA_MODE_2_SW	Mode2 (use STCA) and SW gradient setting.

ptp_stca_timer_channel_t

enum ptp_stca_timer_channel_t

STCA pulse output timer channel definitions

Enumerator
PTP_STCA_TIMER_CHANNEL_0	STCA pulse output timer 0.
PTP_STCA_TIMER_CHANNEL_1	STCA pulse output timer 1.
PTP_STCA_TIMER_CHANNEL_2	STCA pulse output timer 2.
PTP_STCA_TIMER_CHANNEL_3	STCA pulse output timer 3.
PTP_STCA_TIMER_CHANNEL_4	STCA pulse output timer 4.
PTP_STCA_TIMER_CHANNEL_5	STCA pulse output timer 5.

ptp_stca_timer_pulse_edge_t

enum ptp_stca_timer_pulse_edge_t

STCA pulse output timer edge definitions

Enumerator
PTP_STCA_TIMER_PULSE_EDGE_RISING	Rising edge.
PTP_STCA_TIMER_PULSE_EDGE_FALLING	Falling edge.