In here reside a multitude of fundamental PTP-related constants and definitions. More...

#include <stdint.h>
#include <flexptp_options.h>

Macros
#define	PTP_IGMP_DEFAULT_STR ("224.0.1.129")
	PTP default IGMP group.

#define	PTP_IGMP_PEER_DELAY_STR ("224.0.0.107")
	PTP Peer-Delay IGMP group.

#define	PTP_ETHERTYPE (0x88F7)
	PTP EtherType.

#define	ETHERTYPE_PTP (PTP_ETHERTYPE)
	(for lwIP conformity)

#define	PTP_PORT_EVENT (319)
	PTP event message port.

#define	PTP_PORT_GENERAL (320)
	PTP general message port.

#define	PTP_HEADER_LENGTH (34)
	Length of the PTP header.

#define	PTP_TIMESTAMP_LENGTH (10)
	Length of a single timestamp.

#define	PTP_PORT_ID_LENGTH (10)
	Length of the port identification field.

#define	PTP_ANNOUNCE_BODY_LENGTH (20)
	Length of the Announce body.

#define	PTP_PCKT_SIZE_SYNC (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)
	Size of a Sync message.

#define	PTP_PCKT_SIZE_FOLLOW_UP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)
	Size of a Follow_Up message.

#define	PTP_PCKT_SIZE_DELAY_REQ (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)
	Size of a Delay_Req message.

#define	PTP_PCKT_SIZE_DELAY_RESP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)
	Size of a Delay_Resp message.

#define	PTP_PCKT_PDELAY_RESERVED_END (10)
	Reserved area at the end of the message.

#define	PTP_PCKT_SIZE_PDELAY_REQ (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PCKT_PDELAY_RESERVED_END)
	Size of a PDelay_Req message.

#define	PTP_PCKT_SIZE_PDELAY_RESP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)
	Size of a PDelay_Resp message.

#define	PTP_PCKT_SIZE_PDELAY_RESP_FOLLOW_UP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)
	Size of a PDelay_Resp_Follow_Up message.

#define	PTP_PCKT_SIZE_ANNOUNCE (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_ANNOUNCE_BODY_LENGTH)
	Size of an Announce message.

#define	PTP_MAX_PROFILE_NAME_LENGTH (7)
	Maximum profile name length.

#define	PTP_MAX_TLV_PRESET_NAME_LENGTH PTP_MAX_PROFILE_NAME_LENGTH
	Maximum TLV preset name length.

#define	PTP_CLOCK_TICK_FREQ_HZ (1000000000 / PTP_INCREMENT_NSEC)
	Rated clock tick frequency.

#define	PTP_ADDEND_INIT (((double)(0x100000000)) / (((double)(PTP_MAIN_OSCILLATOR_FREQ_HZ)) / ((double)(PTP_CLOCK_TICK_FREQ_HZ))))
	Initial addend value.

#define	PTP_ADDEND_CORR_PER_PPB_F (((double)0x100000000) / ((double)PTP_INCREMENT_NSEC * PTP_MAIN_OSCILLATOR_FREQ_HZ))
	Addend/ppb ratio.

#define	PTP_HEARTBEAT_TICKRATE_MS (125)
	Heartbeat ticking period.

#define	PTP_PORT_ID (1)
	PTP port ID on the device.

#define	PTP_ACCURACY_LIMIT_NS (100)
	Limit of the LOCKED state.

#define	PTP_DEFAULT_SERVO_OFFSET (0)
	Default servo offset in nanoseconds.

#define	PTP_DEFAULT_COARSE_TRIGGER_NS (20000000)
	Coarse correction kick-in threshold.

#define	PTP_BMCA_LISTENING_TIMEOUT_MS (3000)
	BMCA LISTENING state timeout.

#define	PTP_MASTER_QUALIFICATION_TIMEOUT (4)
	Number of Announce intervals.

#define	PTP_ANNOUNCE_RECEIPT_TIMEOUT (3)
	Number of tolerated consecutive lost Announce messages.

#define	PTP_ENABLE_MASTER_OPERATION (0)
	By default, disable Master operation mode.

#define	PTP_CLOCK_PRIORITY1 (128)
	Clock priority1.

#define	PTP_CLOCK_PRIORITY2 (128)
	Clock priority2.

#define	PTP_BEST_CLOCK_CLASS (PTP_CC_DEFAULT)
	Best clock class of this device.

#define	PTP_WORST_ACCURACY (PTP_CA_UNKNOWN)
	Worst accuracy of this device.

#define	PTP_TIME_SOURCE (PTP_TSRC_INTERNAL_OSCILLATOR)
	Time source of this device.

#define	PTP_FALLBACK_UTC_OFFSET (37)
	UTC offset caused by the accumulated leap seconds.

#define	PTP_PDELAY_SLAVE_QUALIFICATION (3)
	Number of consecutive PDelReq-PDelResp iterations after the SLAVE is considered stable.

#define	PTP_PDELAY_DROPOUT PTP_PDELAY_SLAVE_QUALIFICATION
	Maximum number of failed PDelReq-PDelResp cycles before the MASTER drops the SLAVE.

#define	PTP_COLOR_RED "\x1b[31m"
	< Define this to override PTP_COLOR_* macros

#define	PTP_COLOR_BRED "\x1b[91m"
	Bright red.

#define	PTP_COLOR_GREEN "\x1b[32m"
	Green.

#define	PTP_COLOR_BGREEN "\x1b[92m"
	Bright green.

#define	PTP_COLOR_YELLOW "\x1b[33m"
	Yellow.

#define	PTP_COLOR_BYELLOW "\x1b[93m"
	Bright yellow.

#define	PTP_COLOR_BLUE "\x1b[34m"
	Blue.

#define	PTP_COLOR_MAGENTA "\x1b[35m"
	Magenta.

#define	PTP_COLOR_BMAGENTA "\x1b[95m"
	Bright magenta.

#define	PTP_COLOR_CYAN "\x1b[36m"
	Cyan.

#define	PTP_COLOR_RESET "\x1b[0m"
	Reset colors.

#define	FLEXPTP_htonl(a)

#define	FLEXPTP_ntohl(a) FLEXPTP_htonl((a))

#define	FLEXPTP_htons(a)

#define	FLEXPTP_ntohs(a) FLEXPTP_htons((a))

Typedefs
typedef ip4_addr	ip_addr_t

typedef ip4_addr	ip4_addr_t

Variables
const ip_addr_t	PTP_IGMP_PRIMARY
	Primary IGMP address.

const ip_addr_t	PTP_IGMP_PEER_DELAY
	Peer_Delay IGMP address.

const uint8_t	PTP_ETHERNET_PRIMARY [6]
	PTP's L2 Primary Ethernet address.

const uint8_t	PTP_ETHERNET_PEER_DELAY [6]
	PTP's L2 Peer_Delay Ethernet address.

Detailed Description

In here reside a multitude of fundamental PTP-related constants and definitions.

Copyright: András Wiesner, 2019-2025

Definition in file ptp_defs.h.

Macro Definition Documentation

◆ ETHERTYPE_PTP

#define ETHERTYPE_PTP (PTP_ETHERTYPE)

(for lwIP conformity)

Definition at line 30 of file ptp_defs.h.

◆ FLEXPTP_htonl

#define FLEXPTP_htonl ( a )

Value:

        ((((a) >> 24) & 0x000000ff) |   \
         (((a) >>  8) & 0x0000ff00) |   \
         (((a) <<  8) & 0x00ff0000) |   \
         (((a) << 24) & 0xff000000))

Definition at line 163 of file ptp_defs.h.

◆ FLEXPTP_htons

#define FLEXPTP_htons ( a )

Value:

((((a) >> 8) & 0x00ff) | \

(((a) << 8) & 0xff00))

Definition at line 171 of file ptp_defs.h.

◆ FLEXPTP_ntohl

#define FLEXPTP_ntohl ( a ) FLEXPTP_htonl((a))

Definition at line 169 of file ptp_defs.h.

◆ FLEXPTP_ntohs

#define FLEXPTP_ntohs ( a ) FLEXPTP_htons((a))

Definition at line 175 of file ptp_defs.h.

◆ PTP_ACCURACY_LIMIT_NS

#define PTP_ACCURACY_LIMIT_NS (100)

Limit of the LOCKED state.

Definition at line 77 of file ptp_defs.h.

◆ PTP_ADDEND_CORR_PER_PPB_F

#define PTP_ADDEND_CORR_PER_PPB_F (((double)0x100000000) / ((double)PTP_INCREMENT_NSEC * PTP_MAIN_OSCILLATOR_FREQ_HZ))

Addend/ppb ratio.

Definition at line 64 of file ptp_defs.h.

◆ PTP_ADDEND_INIT

#define PTP_ADDEND_INIT (((double)(0x100000000)) / (((double)(PTP_MAIN_OSCILLATOR_FREQ_HZ)) / ((double)(PTP_CLOCK_TICK_FREQ_HZ))))

Initial addend value.

Definition at line 63 of file ptp_defs.h.

◆ PTP_ANNOUNCE_BODY_LENGTH

#define PTP_ANNOUNCE_BODY_LENGTH (20)

Length of the Announce body.

Definition at line 43 of file ptp_defs.h.

◆ PTP_ANNOUNCE_RECEIPT_TIMEOUT

#define PTP_ANNOUNCE_RECEIPT_TIMEOUT (3)

Number of tolerated consecutive lost Announce messages.

Definition at line 97 of file ptp_defs.h.

◆ PTP_BEST_CLOCK_CLASS

#define PTP_BEST_CLOCK_CLASS (PTP_CC_DEFAULT)

Best clock class of this device.

Definition at line 115 of file ptp_defs.h.

◆ PTP_BMCA_LISTENING_TIMEOUT_MS

#define PTP_BMCA_LISTENING_TIMEOUT_MS (3000)

BMCA LISTENING state timeout.

Definition at line 89 of file ptp_defs.h.

◆ PTP_CLOCK_PRIORITY1

#define PTP_CLOCK_PRIORITY1 (128)

Clock priority1.

Definition at line 105 of file ptp_defs.h.

◆ PTP_CLOCK_PRIORITY2

#define PTP_CLOCK_PRIORITY2 (128)

Clock priority2.

Definition at line 109 of file ptp_defs.h.

◆ PTP_CLOCK_TICK_FREQ_HZ

#define PTP_CLOCK_TICK_FREQ_HZ (1000000000 / PTP_INCREMENT_NSEC)

Rated clock tick frequency.

Definition at line 62 of file ptp_defs.h.

◆ PTP_COLOR_BGREEN

#define PTP_COLOR_BGREEN "\x1b[92m"

Bright green.

Definition at line 148 of file ptp_defs.h.

◆ PTP_COLOR_BLUE

#define PTP_COLOR_BLUE "\x1b[34m"

Blue.

Definition at line 151 of file ptp_defs.h.

◆ PTP_COLOR_BMAGENTA

#define PTP_COLOR_BMAGENTA "\x1b[95m"

Bright magenta.

Definition at line 153 of file ptp_defs.h.

◆ PTP_COLOR_BRED

#define PTP_COLOR_BRED "\x1b[91m"

Bright red.

Definition at line 146 of file ptp_defs.h.

◆ PTP_COLOR_BYELLOW

#define PTP_COLOR_BYELLOW "\x1b[93m"

Bright yellow.

Definition at line 150 of file ptp_defs.h.

◆ PTP_COLOR_CYAN

#define PTP_COLOR_CYAN "\x1b[36m"

Cyan.

Definition at line 154 of file ptp_defs.h.

◆ PTP_COLOR_GREEN

#define PTP_COLOR_GREEN "\x1b[32m"

Green.

Definition at line 147 of file ptp_defs.h.

◆ PTP_COLOR_MAGENTA

#define PTP_COLOR_MAGENTA "\x1b[35m"

Magenta.

Definition at line 152 of file ptp_defs.h.

◆ PTP_COLOR_RED

#define PTP_COLOR_RED "\x1b[31m"

< Define this to override PTP_COLOR_* macros

Red

Definition at line 145 of file ptp_defs.h.

◆ PTP_COLOR_RESET

#define PTP_COLOR_RESET "\x1b[0m"

Reset colors.

Definition at line 155 of file ptp_defs.h.

◆ PTP_COLOR_YELLOW

#define PTP_COLOR_YELLOW "\x1b[33m"

Yellow.

Definition at line 149 of file ptp_defs.h.

◆ PTP_DEFAULT_COARSE_TRIGGER_NS

#define PTP_DEFAULT_COARSE_TRIGGER_NS (20000000)

Coarse correction kick-in threshold.

Definition at line 85 of file ptp_defs.h.

◆ PTP_DEFAULT_SERVO_OFFSET

#define PTP_DEFAULT_SERVO_OFFSET (0)

Default servo offset in nanoseconds.

Definition at line 81 of file ptp_defs.h.

◆ PTP_ENABLE_MASTER_OPERATION

#define PTP_ENABLE_MASTER_OPERATION (0)

By default, disable Master operation mode.

Definition at line 101 of file ptp_defs.h.

◆ PTP_ETHERTYPE

#define PTP_ETHERTYPE (0x88F7)

PTP EtherType.

Definition at line 29 of file ptp_defs.h.

◆ PTP_FALLBACK_UTC_OFFSET

#define PTP_FALLBACK_UTC_OFFSET (37)

UTC offset caused by the accumulated leap seconds.

Definition at line 127 of file ptp_defs.h.

◆ PTP_HEADER_LENGTH

#define PTP_HEADER_LENGTH (34)

Length of the PTP header.

Definition at line 40 of file ptp_defs.h.

◆ PTP_HEARTBEAT_TICKRATE_MS

#define PTP_HEARTBEAT_TICKRATE_MS (125)

Heartbeat ticking period.

Definition at line 69 of file ptp_defs.h.

◆ PTP_IGMP_DEFAULT_STR

#define PTP_IGMP_DEFAULT_STR ("224.0.1.129")

PTP default IGMP group.

Definition at line 18 of file ptp_defs.h.

◆ PTP_IGMP_PEER_DELAY_STR

#define PTP_IGMP_PEER_DELAY_STR ("224.0.0.107")

PTP Peer-Delay IGMP group.

Definition at line 19 of file ptp_defs.h.

◆ PTP_MASTER_QUALIFICATION_TIMEOUT

#define PTP_MASTER_QUALIFICATION_TIMEOUT (4)

Number of Announce intervals.

Definition at line 93 of file ptp_defs.h.

◆ PTP_MAX_PROFILE_NAME_LENGTH

#define PTP_MAX_PROFILE_NAME_LENGTH (7)

Maximum profile name length.

Definition at line 57 of file ptp_defs.h.

◆ PTP_MAX_TLV_PRESET_NAME_LENGTH

#define PTP_MAX_TLV_PRESET_NAME_LENGTH PTP_MAX_PROFILE_NAME_LENGTH

Maximum TLV preset name length.

Definition at line 58 of file ptp_defs.h.

◆ PTP_PCKT_PDELAY_RESERVED_END

#define PTP_PCKT_PDELAY_RESERVED_END (10)

Reserved area at the end of the message.

Definition at line 49 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_ANNOUNCE

#define PTP_PCKT_SIZE_ANNOUNCE (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_ANNOUNCE_BODY_LENGTH)

Size of an Announce message.

Definition at line 53 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_DELAY_REQ

#define PTP_PCKT_SIZE_DELAY_REQ (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)

Size of a Delay_Req message.

Definition at line 47 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_DELAY_RESP

#define PTP_PCKT_SIZE_DELAY_RESP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)

Size of a Delay_Resp message.

Definition at line 48 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_FOLLOW_UP

#define PTP_PCKT_SIZE_FOLLOW_UP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)

Size of a Follow_Up message.

Definition at line 46 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_PDELAY_REQ

#define PTP_PCKT_SIZE_PDELAY_REQ (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PCKT_PDELAY_RESERVED_END)

Size of a PDelay_Req message.

Definition at line 50 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_PDELAY_RESP

#define PTP_PCKT_SIZE_PDELAY_RESP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)

Size of a PDelay_Resp message.

Definition at line 51 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_PDELAY_RESP_FOLLOW_UP

#define PTP_PCKT_SIZE_PDELAY_RESP_FOLLOW_UP (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH + PTP_PORT_ID_LENGTH)

Size of a PDelay_Resp_Follow_Up message.

Definition at line 52 of file ptp_defs.h.

◆ PTP_PCKT_SIZE_SYNC

#define PTP_PCKT_SIZE_SYNC (PTP_HEADER_LENGTH + PTP_TIMESTAMP_LENGTH)

Size of a Sync message.

Definition at line 45 of file ptp_defs.h.

◆ PTP_PDELAY_DROPOUT

#define PTP_PDELAY_DROPOUT PTP_PDELAY_SLAVE_QUALIFICATION

Maximum number of failed PDelReq-PDelResp cycles before the MASTER drops the SLAVE.

Definition at line 137 of file ptp_defs.h.

◆ PTP_PDELAY_SLAVE_QUALIFICATION

#define PTP_PDELAY_SLAVE_QUALIFICATION (3)

Number of consecutive PDelReq-PDelResp iterations after the SLAVE is considered stable.

Definition at line 133 of file ptp_defs.h.

◆ PTP_PORT_EVENT

#define PTP_PORT_EVENT (319)

PTP event message port.

Definition at line 37 of file ptp_defs.h.

◆ PTP_PORT_GENERAL

#define PTP_PORT_GENERAL (320)

PTP general message port.

Definition at line 38 of file ptp_defs.h.

◆ PTP_PORT_ID

#define PTP_PORT_ID (1)

PTP port ID on the device.

Definition at line 73 of file ptp_defs.h.

◆ PTP_PORT_ID_LENGTH

#define PTP_PORT_ID_LENGTH (10)

Length of the port identification field.

Definition at line 42 of file ptp_defs.h.

◆ PTP_TIME_SOURCE

#define PTP_TIME_SOURCE (PTP_TSRC_INTERNAL_OSCILLATOR)

Time source of this device.

Definition at line 123 of file ptp_defs.h.

◆ PTP_TIMESTAMP_LENGTH

#define PTP_TIMESTAMP_LENGTH (10)

Length of a single timestamp.

Definition at line 41 of file ptp_defs.h.

◆ PTP_WORST_ACCURACY

#define PTP_WORST_ACCURACY (PTP_CA_UNKNOWN)

Worst accuracy of this device.

Definition at line 119 of file ptp_defs.h.

Typedef Documentation

◆ ip4_addr_t

typedef ip4_addr ip4_addr_t

Definition at line 23 of file ptp_defs.h.

◆ ip_addr_t

typedef ip4_addr ip_addr_t

Definition at line 22 of file ptp_defs.h.

Variable Documentation

◆ PTP_ETHERNET_PEER_DELAY

const uint8_t PTP_ETHERNET_PEER_DELAY[6]

extern

PTP's L2 Peer_Delay Ethernet address.

Definition at line 4 of file ptp_defs.c.

◆ PTP_ETHERNET_PRIMARY

const uint8_t PTP_ETHERNET_PRIMARY[6]

extern

PTP's L2 Primary Ethernet address.

Definition at line 3 of file ptp_defs.c.

◆ PTP_IGMP_PEER_DELAY

const ip_addr_t PTP_IGMP_PEER_DELAY

extern

Peer_Delay IGMP address.

◆ PTP_IGMP_PRIMARY

const ip_addr_t PTP_IGMP_PRIMARY

extern

Primary IGMP address.

Macros

Typedefs

Variables

Detailed Description

Macro Definition Documentation

◆ ETHERTYPE_PTP

◆ FLEXPTP_htonl

◆ FLEXPTP_htons

◆ FLEXPTP_ntohl

◆ FLEXPTP_ntohs

◆ PTP_ACCURACY_LIMIT_NS

◆ PTP_ADDEND_CORR_PER_PPB_F

◆ PTP_ADDEND_INIT

◆ PTP_ANNOUNCE_BODY_LENGTH

◆ PTP_ANNOUNCE_RECEIPT_TIMEOUT

◆ PTP_BEST_CLOCK_CLASS

◆ PTP_BMCA_LISTENING_TIMEOUT_MS

◆ PTP_CLOCK_PRIORITY1

◆ PTP_CLOCK_PRIORITY2

◆ PTP_CLOCK_TICK_FREQ_HZ

◆ PTP_COLOR_BGREEN

◆ PTP_COLOR_BLUE

◆ PTP_COLOR_BMAGENTA

◆ PTP_COLOR_BRED

◆ PTP_COLOR_BYELLOW

◆ PTP_COLOR_CYAN

◆ PTP_COLOR_GREEN

◆ PTP_COLOR_MAGENTA

◆ PTP_COLOR_RED

◆ PTP_COLOR_RESET

◆ PTP_COLOR_YELLOW

◆ PTP_DEFAULT_COARSE_TRIGGER_NS

◆ PTP_DEFAULT_SERVO_OFFSET

◆ PTP_ENABLE_MASTER_OPERATION

◆ PTP_ETHERTYPE

◆ PTP_FALLBACK_UTC_OFFSET

◆ PTP_HEADER_LENGTH

◆ PTP_HEARTBEAT_TICKRATE_MS

◆ PTP_IGMP_DEFAULT_STR

◆ PTP_IGMP_PEER_DELAY_STR

◆ PTP_MASTER_QUALIFICATION_TIMEOUT

◆ PTP_MAX_PROFILE_NAME_LENGTH

◆ PTP_MAX_TLV_PRESET_NAME_LENGTH

◆ PTP_PCKT_PDELAY_RESERVED_END

◆ PTP_PCKT_SIZE_ANNOUNCE

◆ PTP_PCKT_SIZE_DELAY_REQ

◆ PTP_PCKT_SIZE_DELAY_RESP

◆ PTP_PCKT_SIZE_FOLLOW_UP

◆ PTP_PCKT_SIZE_PDELAY_REQ

◆ PTP_PCKT_SIZE_PDELAY_RESP

◆ PTP_PCKT_SIZE_PDELAY_RESP_FOLLOW_UP

◆ PTP_PCKT_SIZE_SYNC

◆ PTP_PDELAY_DROPOUT

◆ PTP_PDELAY_SLAVE_QUALIFICATION

◆ PTP_PORT_EVENT

◆ PTP_PORT_GENERAL

◆ PTP_PORT_ID

◆ PTP_PORT_ID_LENGTH

◆ PTP_TIME_SOURCE

◆ PTP_TIMESTAMP_LENGTH

◆ PTP_WORST_ACCURACY

Typedef Documentation

◆ ip4_addr_t

◆ ip_addr_t

Variable Documentation

◆ PTP_ETHERNET_PEER_DELAY

◆ PTP_ETHERNET_PRIMARY

◆ PTP_IGMP_PEER_DELAY

◆ PTP_IGMP_PRIMARY