ptp_datasets.h

Go to the documentation of this file.

/*
 * ptp_datasets.h
 *
 *  Date: 19/06/2014
 *  Author: Fernando Biazi Nascimento
 *  Copyright © 2014 Fernando Biazi Nascimento. All rights reserved.
 *
 *  License of use and copy on file license.txt
 *
 */

#ifndef PTP_DATASETS_H
#define PTP_DATASETS_H

/*
 * ======== Includes ========
 */

#include "ptp_cfg.h"
#include "ptp_types.h"

/*
 * ======== Doxygen ========
 */
/*
 * ======== Constants ========
 */

/*
 * ======== Macros ========
 */

/*
 * ======== Types ========
 */

#if (PTP_CLOCK_TYPE == PTP_CLOCK_TYPE_BOUNDARY) || (PTP_CLOCK_TYPE == PTP_CLOCK_TYPE_ORDINARY)
//
// Ordinary and boundary clock data sets
//

// PTP_defaultDS
typedef struct PTP_defaultDS {
  // static
  ptp_boolean twoStepFlag :1;
  ptp_clockIdentity *clockIdentity;
  ptp_uinteger16 numberPorts;
  // dynamic
  PTP_ClockQuality clockQuality;
  // configurable
  ptp_uinteger8 priority1;
  ptp_uinteger8 priority2;
  ptp_uinteger8 domainNumber;
  ptp_boolean slaveOnly :1;
} PTP_defaultDS;

typedef struct PTP_currentDS {
  // dynamic
  ptp_uinteger16 stepsRemoved;
  PTP_TimeInterval offsetFromMaster;
  PTP_TimeInterval meanPathDelay;
} PTP_currentDS;

typedef struct PTP_parentDS {
  // dynamic
  PTP_ParentPortIdentityP parentPortIdentity;
  ptp_boolean parentStats :1;
  ptp_uinteger16 observedParentOffsetScaledLogVariance;
  ptp_integer32 observedParentClockPhaseChangeRate;
  ptp_clockIdentity *grandMasterIdentity;
  PTP_ClockQuality grandMasterclockQuality;
  ptp_uinteger8 grandMasterPriority1;
  ptp_uinteger8 grandMasterPriority2;
} PTP_parentDS;

typedef struct PTP_timePropertiesDS {
  // - ptpTimescale must be initialized first
  // dynamic
  ptp_integer16 currentUtcOffset;
  ptp_boolean currentUtcOffsetValid;
  ptp_boolean leap59 :1;
  ptp_boolean leap61 :1;
  ptp_boolean timeTraceable :1;
  ptp_boolean frequencyTraceable :1;
  ptp_boolean ptpTimescale :1;
  ptp_timeSource timeSource :8;
} PTP_timePropertiesDS;

typedef struct PTP_portDS {
  // static
//  PTP_PortIdentityP portIdentity; // read values from other locations
  // dynamic
  ptp_portState portState :8;
  ptp_uinteger8 logMinDelayReqInterval;
  PTP_TimeInterval peerMeanPathDelay;
  // configurable
  ptp_integer8 logAnnounceInterval;
  ptp_uinteger8 announceReceiptTimeout;
  ptp_integer8 logSyncInterval;
  ptp_delayMechanism delayMechanism :8;
  ptp_integer8 logMinPdelayReqInterval;
  ptp_uinteger4 versionNumber :4; // must use 4 bits on communication packets.
} PTP_portDS;

#elif PTP_CLOCK_TYPE == PTP_CLOCK_TYPE_TRANSPARENT

//
// Transparent clock data sets
//

typedef struct PTP_transparentClockDefaultDS {
  // static
  ptp_clockIdentity *clockIdentity;
  ptp_uinteger16 numberPorts;
  // configurable
  ptp_delayMechanism delayMechanism;
  ptp_uinteger8 primaryDomain;
}PTP_transparentClockDefaultDS;

// PTP_transparentClockPortDS - per port
typedef struct PTP_transparentClockPortDS {
  // static
//  PTP_PortIdentityP portIdentity; // read values from other locations
  // dynamic
  ptp_integer8 logMinPdelayReqInterval;
  ptp_boolean faultyFlag:1;
  PTP_TimeInterval peerMeanPathDelay;
}PTP_transparentClockPortDS;

#endif

//
// BMC data sets
//

typedef struct PTP_foreignMasterDS {
//  PTP_PortIdentity  foreignMasterPortIdentity; // - the port is registered at the network unit, save some memory here
  ptp_clockIdentity clockIdentity;
  ptp_uinteger8 foreignMasterAnnounceMessages;
} PTP_foreignMasterDS;

typedef struct PTP_announceDS {
  ptp_uinteger8 grandMasterPriority1;
  ptp_clockIdentity grandMasterIdentity;
  PTP_ClockQuality grandMasterClockQuality;
  ptp_uinteger8 grandMasterPriority2;
  ptp_uinteger16 stepsRemoved;
  ptp_uinteger16 currentUtcOffset;
  ptp_boolean currentUtcOffsetValid :1;
  ptp_boolean leap59 :1;
  ptp_boolean leap61 :1;
  ptp_boolean timeTraceable :1;
  ptp_boolean frequencyTraceable :1;
  ptp_boolean ptpTimescale :1;
  ptp_timeSource timeSource :8;
} PTP_announceDS;

typedef struct PTP_P2PPDelayReqDS {
  ptp_uinteger8 localPortNumber;
  PTP_TimeStamp t2;
  ptp_uinteger16 sequenceId;
  ptp_clockIdentity clockIdentity;
  ptp_uinteger8 domain;
  ptp_uinteger64 correctionField;
} PTP_P2PPDelayReqDS;

/*
 * ======== Global Variables ========
 */

/*
 * ======== Global Functions ========
 */

#endif /* PTP_DATASETS_H */