flexPTP 1.0
An IEEE 1588 PTP implementation designed for microcontrollers
Loading...
Searching...
No Matches
PtpCoreState Struct Reference

Giant PTP core state object. More...

#include <ptp_types.h>

Collaboration diagram for PtpCoreState:

Data Fields

PtpProfile profile
 PTP profile.
 
PtpMasterProperties capabilities
 The capabilities of this device.
 
PtpHWClockState hwclock
 Hardware clock state.
 
struct {
   TimestampI   offset
 PPS signal offset. More...
 
   uint64_t   clockIdentity
 clockIdentity calculated from MAC address More...
 
hwoptions
 Hardware options.
 
PtpBmcaState bmca
 BMCA state.
 
PtpNetworkState network
 Network state.
 
uint32_t ticks
 ticks counting form the initialization
 
struct {
   bool   def
 default More...
 
   bool   corr
 correction fields More...
 
   bool   timestamps
 timestamps More...
 
   bool   info
 informative messages More...
 
   bool   locked
 clock lock state change More...
 
   bool   bmca
 BMCA state change. More...
 
   bool   transmission
 Transmission logging. More...
 
logging
 Logging.
 
PtpStats stats
 Statistics.
 
PtpUserEventCallback userEventCb
 User event callback pointer.
 
struct {
   bool   enabled
 Slave module is enabled. More...
 
   PtpSlaveMessagingState   messaging
 Messaging state. More...
 
   PtpSyncCycleData   scd
 Sync cycle data. More...
 
   bool   expectPDelRespFollowUp
 Expect a PDelay_Resp_Follow_Up message. More...
 
   PtpFastCompState   fastCompState
 State of fast compensation. More...
 
   uint8_t   fastCompCntr
 Cycle counter for fast compensation. More...
 
   TimestampI   prevSyncMa
 T1 from the previous cycle. More...
 
   TimestampI   prevSyncSl
 T2 from the previous cycle. More...
 
   TimestampI   prevTimeError
 Time error in the previous cycle. More...
 
   uint64_t   coarseLimit
 time error limit above coarse correction is engaged More...
 
   uint32_t   delReqTickPeriod
 ticks between Delay_Req transmissions More...
 
   uint32_t   delReqTmr
 Timer counting ticks for Delay_Req transmissions. More...
 
   PtpSyncCallback   syncCb
 Sync callback invoked in every synchronization cycle. More...
 
slave
 
struct {
   bool   enabled
 Master module is enabled. More...
 
   PtpP2PSlaveInfo   p2pSlave
 Information on the connected P2P slave (only used in P2P modes) More...
 
   uint32_t   pdelay_reqSequenceID
 Sequence number of the last PDelay_Request sent. More...
 
   PtpSyncCycleData   scd
 Sync cycle data. More...
 
   bool   expectPDelRespFollowUp
 Expect a PDelay_Resp_Follow_Up message. More...
 
   PtpMasterMessagingState   messaging
 Messaging state. More...
 
   uint32_t   syncTickPeriod
 Sync transmission period in ticks. More...
 
   uint32_t   syncTmr
 Counter for scheduling Sync transmission. More...
 
   uint32_t   announceTickPeriod
 Announce transmission in ticks. More...
 
   uint32_t   announceTmr
 Counter to schedule Announce transmission. More...
 
   uint32_t   pdelayReqTickPeriod
 PDelayReq transmission period in ticks. More...
 
   uint32_t   pdelayReqTmr
 Counter for PDelayReq transmission scheduling. More...
 
master
 

Detailed Description

Giant PTP core state object.

Definition at line 501 of file ptp_types.h.

Field Documentation

◆ announceTickPeriod

uint32_t announceTickPeriod

Announce transmission in ticks.

Definition at line 566 of file ptp_types.h.

◆ announceTmr

uint32_t announceTmr

Counter to schedule Announce transmission.

Definition at line 567 of file ptp_types.h.

◆ bmca [1/2]

BMCA state.

Definition at line 512 of file ptp_types.h.

◆ bmca [2/2]

bool bmca

BMCA state change.

Definition at line 524 of file ptp_types.h.

◆ capabilities

PtpMasterProperties capabilities

The capabilities of this device.

Definition at line 503 of file ptp_types.h.

◆ clockIdentity

uint64_t clockIdentity

clockIdentity calculated from MAC address

Definition at line 509 of file ptp_types.h.

◆ coarseLimit

uint64_t coarseLimit

time error limit above coarse correction is engaged

Definition at line 544 of file ptp_types.h.

◆ corr

bool corr

correction fields

Definition at line 520 of file ptp_types.h.

◆ def

bool def

default

Definition at line 519 of file ptp_types.h.

◆ delReqTickPeriod

uint32_t delReqTickPeriod

ticks between Delay_Req transmissions

Definition at line 546 of file ptp_types.h.

◆ delReqTmr

uint32_t delReqTmr

Timer counting ticks for Delay_Req transmissions.

Definition at line 547 of file ptp_types.h.

◆ enabled

bool enabled

Slave module is enabled.

Master module is enabled.

Definition at line 534 of file ptp_types.h.

◆ expectPDelRespFollowUp

bool expectPDelRespFollowUp

Expect a PDelay_Resp_Follow_Up message.

Definition at line 538 of file ptp_types.h.

◆ fastCompCntr

uint8_t fastCompCntr

Cycle counter for fast compensation.

Definition at line 540 of file ptp_types.h.

◆ fastCompState

PtpFastCompState fastCompState

State of fast compensation.

Definition at line 539 of file ptp_types.h.

◆ hwclock

PtpHWClockState hwclock

Hardware clock state.

Definition at line 505 of file ptp_types.h.

◆ 

struct { ... } hwoptions

Hardware options.

◆ info

bool info

informative messages

Definition at line 522 of file ptp_types.h.

◆ locked

bool locked

clock lock state change

Definition at line 523 of file ptp_types.h.

◆ 

struct { ... } logging

Logging.

◆ 

struct { ... } master

◆ messaging [1/2]

Messaging state.

Definition at line 536 of file ptp_types.h.

◆ messaging [2/2]

Messaging state.

Definition at line 562 of file ptp_types.h.

◆ network

PtpNetworkState network

Network state.

Definition at line 513 of file ptp_types.h.

◆ offset

TimestampI offset

PPS signal offset.

Definition at line 508 of file ptp_types.h.

◆ p2pSlave

PtpP2PSlaveInfo p2pSlave

Information on the connected P2P slave (only used in P2P modes)

Definition at line 557 of file ptp_types.h.

◆ pdelay_reqSequenceID

uint32_t pdelay_reqSequenceID

Sequence number of the last PDelay_Request sent.

Definition at line 558 of file ptp_types.h.

◆ pdelayReqTickPeriod

uint32_t pdelayReqTickPeriod

PDelayReq transmission period in ticks.

Definition at line 568 of file ptp_types.h.

◆ pdelayReqTmr

uint32_t pdelayReqTmr

Counter for PDelayReq transmission scheduling.

Definition at line 569 of file ptp_types.h.

◆ prevSyncMa

TimestampI prevSyncMa

T1 from the previous cycle.

Definition at line 541 of file ptp_types.h.

◆ prevSyncSl

TimestampI prevSyncSl

T2 from the previous cycle.

Definition at line 542 of file ptp_types.h.

◆ prevTimeError

TimestampI prevTimeError

Time error in the previous cycle.

Definition at line 543 of file ptp_types.h.

◆ profile

PtpProfile profile

PTP profile.

Definition at line 502 of file ptp_types.h.

◆ scd

Sync cycle data.

Definition at line 537 of file ptp_types.h.

◆ 

struct { ... } slave

◆ stats

PtpStats stats

Statistics.

Definition at line 528 of file ptp_types.h.

◆ syncCb

Sync callback invoked in every synchronization cycle.

Definition at line 549 of file ptp_types.h.

◆ syncTickPeriod

uint32_t syncTickPeriod

Sync transmission period in ticks.

Definition at line 564 of file ptp_types.h.

◆ syncTmr

uint32_t syncTmr

Counter for scheduling Sync transmission.

Definition at line 565 of file ptp_types.h.

◆ ticks

uint32_t ticks

ticks counting form the initialization

Definition at line 515 of file ptp_types.h.

◆ timestamps

bool timestamps

timestamps

Definition at line 521 of file ptp_types.h.

◆ transmission

bool transmission

Transmission logging.

Definition at line 525 of file ptp_types.h.

◆ userEventCb

PtpUserEventCallback userEventCb

User event callback pointer.

Definition at line 529 of file ptp_types.h.


The documentation for this struct was generated from the following file: