pt1588-SH7216 1
IEEE1588v2 Implementation for Renesas SH7216 Demo

PTPState Struct Reference

Attributes describing the current state of the PTP. More...

#include <ptp-data-types.h>

Data Fields

DefaultDS defaultDS
 Describes the ordinary clock (8.2.1).
CurrentDS currentDS
 Data related to syncrhonization (8.2.2).
ParentDS parentDS
 Describes the parent and grandmaster clock (8.2.3).
TimePropertiesDS timePropertiesDS
 Describes the timescale (8.2.4).
PortDS portDS
 Describes the port (only 1 port is currently implemented) (8.2.5).
ForeignMasterDS foreignMasterDS [FOREIGNMASTERDSSIZE]
 An array that contains information about foreign masters (9.3.2.4).
UInteger8 foreignMasterDSIndex
 Next available index for storing a foreign master in the array.
UInteger16 sequenceIdAnnounce
 Sequence Id for transmitted Announce messages (7.3.7).
UInteger16 sequenceIdSync
 Sequence Id for transmitted Sync messages (7.3.7).
UInteger16 sequenceIdDelayReq
 Sequence Id for transmitted Delay_Req messages (7.3.7).
UInteger16 sequenceIdManagement
 Sequence Id for transmitted Management messages (7.3.7).
Timestamp syncEventIngressTimestamp
 Timestamp (according to the slave clock) of the reception of the Sync message.
Timestamp syncEventEgressTimestamp
 Timestamp (according to master clock) of the transmission of the Sync message.
Timestamp delayEventIngressTimestamp
 Timestamp (according to the master clock) of the reception of the Delay_Req message.
Timestamp delayEventEgressTimestamp
 Timestamp (according to the slave clock) of the transmission of the Delay_Req message.
TimeInterval syncEventTimeInterval
 Time interval between the syncEventEgressTimestamp and the syncEventIngressTimestamp.
TimeInterval delayEventTimeInterval
 Time interval between the delayEventEgressTimestamp and the delaycEventIngressTimestamp.
Integer64 lastCorrectionField
 Last correction field from a message.
Integer32 rateAdjFreq
 Amount to adjust the rate of the clock to correct the frequency difference between master and slave clocks.
Integer32 rateAdjFreqAcc
 Accumulator of rateAdjFreq.
Integer32 rateAdjOffset
 Amount to adjust the rate of the clock to correct the offset between master and slave clocks within specified time period.
Integer32 rateAdjOffsetAcc
 Accumulator of rateAdjOffset.
UInteger8 lastAdjType
 Last type of clock adjust made (clock step, rate adjust, or combination of both).
UInteger16 announceReceiptTimeoutExpiresID
 Maintain the Id of the current active announce receipt timeout.
PortIdentity lastSyncMsgSourcePortIdentity
 Source port identity of the last Sync message is needed to determine if a Follow_Up message should be accepted.
UInteger16 lastSyncMsgSequenceId
 Sequence Id of the last Sync message is needed to determine if a Follow_Up message should be accepted.
Integer64 lastSyncMsgCorrectionField
 Correction field of the last Sync message is used along with the correction field of the accepted Follow_Up message.
Boolean sameMaster
 TRUE if the master clock doesn't change when the BMC algorithm is run, FALSE otherwise.

Detailed Description

Attributes describing the current state of the PTP.

Definition at line 484 of file ptp-data-types.h.


Field Documentation

Maintain the Id of the current active announce receipt timeout.

Current active timeout can be disabled by incrementing this Id.

Definition at line 555 of file ptp-data-types.h.

Data related to syncrhonization (8.2.2).

Definition at line 488 of file ptp-data-types.h.

Describes the ordinary clock (8.2.1).

Definition at line 487 of file ptp-data-types.h.

Timestamp (according to the slave clock) of the transmission of the Delay_Req message.

Definition at line 525 of file ptp-data-types.h.

Timestamp (according to the master clock) of the reception of the Delay_Req message.

Definition at line 522 of file ptp-data-types.h.

Time interval between the delayEventEgressTimestamp and the delaycEventIngressTimestamp.

Definition at line 531 of file ptp-data-types.h.

ForeignMasterDS foreignMasterDS[FOREIGNMASTERDSSIZE]

An array that contains information about foreign masters (9.3.2.4).

It is used in the BMC algorithm for qualifying Announce messages.

Definition at line 495 of file ptp-data-types.h.

Next available index for storing a foreign master in the array.

Definition at line 499 of file ptp-data-types.h.

Last type of clock adjust made (clock step, rate adjust, or combination of both).

It is used by adjustClock() to determine they type of the next clock adjustment.

Definition at line 551 of file ptp-data-types.h.

Last correction field from a message.

Correction field is used to correct timestamps.

Definition at line 534 of file ptp-data-types.h.

Correction field of the last Sync message is used along with the correction field of the accepted Follow_Up message.

Definition at line 568 of file ptp-data-types.h.

Sequence Id of the last Sync message is needed to determine if a Follow_Up message should be accepted.

Definition at line 565 of file ptp-data-types.h.

Source port identity of the last Sync message is needed to determine if a Follow_Up message should be accepted.

Definition at line 561 of file ptp-data-types.h.

Describes the parent and grandmaster clock (8.2.3).

Definition at line 489 of file ptp-data-types.h.

Describes the port (only 1 port is currently implemented) (8.2.5).

Definition at line 491 of file ptp-data-types.h.

Amount to adjust the rate of the clock to correct the frequency difference between master and slave clocks.

It is expressed in units of 2^-32 nanoseconds per clock cycle.

Definition at line 539 of file ptp-data-types.h.

Accumulator of rateAdjFreq.

Definition at line 543 of file ptp-data-types.h.

Amount to adjust the rate of the clock to correct the offset between master and slave clocks within specified time period.

It is expressed in units of 2^-32 nanoseconds per clock cycle.

Definition at line 544 of file ptp-data-types.h.

Accumulator of rateAdjOffset.

Definition at line 549 of file ptp-data-types.h.

TRUE if the master clock doesn't change when the BMC algorithm is run, FALSE otherwise.

Definition at line 573 of file ptp-data-types.h.

Sequence Id for transmitted Announce messages (7.3.7).

Definition at line 503 of file ptp-data-types.h.

Sequence Id for transmitted Delay_Req messages (7.3.7).

Definition at line 509 of file ptp-data-types.h.

Sequence Id for transmitted Management messages (7.3.7).

Definition at line 512 of file ptp-data-types.h.

Sequence Id for transmitted Sync messages (7.3.7).

Definition at line 506 of file ptp-data-types.h.

Timestamp (according to master clock) of the transmission of the Sync message.

Definition at line 519 of file ptp-data-types.h.

Timestamp (according to the slave clock) of the reception of the Sync message.

Definition at line 516 of file ptp-data-types.h.

Time interval between the syncEventEgressTimestamp and the syncEventIngressTimestamp.

Definition at line 528 of file ptp-data-types.h.

Describes the timescale (8.2.4).

Definition at line 490 of file ptp-data-types.h.


The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerator Defines