ptp_types.h

Go to the documentation of this file.

/*
 * ptp_types.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_TYPES_H
#define PTP_TYPES_H

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

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

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

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

#define PTP_CLOCK_TYPE_BOUNDARY 1
#define PTP_CLOCK_TYPE_ORDINARY 2
#define PTP_CLOCK_TYPE_TRANSPARENT 4

#define PTP_FALSE 0
#define PTP_TRUE 1

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

typedef unsigned char ptp_boolean;

// Numeric types

typedef signed char ptp_integer4;

typedef unsigned char ptp_uinteger4;

typedef signed char ptp_integer8;

typedef unsigned char ptp_uinteger8;

typedef short ptp_integer16;

typedef unsigned short ptp_uinteger16;

typedef long ptp_integer32;

typedef unsigned long ptp_uinteger32;

typedef unsigned long long ptp_uinteger48; // Está ocupando 64 bits, deveria ser 48, converter quando necessario

typedef long long ptp_integer64;

typedef unsigned long long ptp_uinteger64;

// Types not interpreted as a number

typedef char ptp_nibble;

typedef char ptp_octet;

typedef enum ptp_networkProtocol {
  // Reserved = 0x0000
  PTP_NP_UDP_IPv4 = 0x0001, 
  PTP_NP_UDP_IPv6 = 0x0002, 
  PTP_NP_IEEE_802_3 = 0x0003, 
  PTP_NP_DeviceNe = 0x0004, 
  PTP_NP_ControlNet = 0x0005, 
  PTP_NP_PROFINET = 0x0006, 
  // Reserved for assignment by the Precise Networked Clock Working Group
  //   of the IM/ST Committee 0007 - EFFF
  // Reserved for assignment in a PTP profile F000 - FFFD
  PTP_NP_Unknown = 0xFFFE
// Reserved  = FFFF
} ptp_networkProtocol; // Enum16

typedef enum ptp_clockAccuracy {
  //00-1F Reserved
  PTP_CA_025NS = 0x20, // The time is accurate to within 25 ns
  PTP_CA_100NS = 0x21, // The time is accurate to within 100 ns
  PTP_CA_250NS = 0x22, // The time is accurate to within 250 ns
  PTP_CA_001US = 0x23, // The time is accurate to within 1 us
  PTP_CA_002US = 0x24, // The time is accurate to within 2.5 us
  PTP_CA_010US = 0x25, // The time is accurate to within 10 us
  PTP_CA_025US = 0x26, // The time is accurate to within 25 us
  PTP_CA_100US = 0x27, // The time is accurate to within 100 us
  PTP_CA_250US = 0x28, // The time is accurate to within 250 us
  PTP_CA_001MS = 0x29, // The time is accurate to within 1 ms
  PTP_CA_002MS = 0x2A, // The time is accurate to within 2.5 ms
  PTP_CA_010MS = 0x2B, // The time is accurate to within 10 ms
  PTP_CA_025MS = 0x2C, // The time is accurate to within 25 ms
  PTP_CA_100MS = 0x2D, // The time is accurate to within 100 ms
  PTP_CA_250MS = 0x2E, // The time is accurate to within 250 ms
  PTP_CA_001S = 0x2F, // The time is accurate to within 1 s
  PTP_CA_010S = 0x30, // The time is accurate to within 10 s
  PTP_CA_OVER = 0x31, // The time is accurate to >10 s
  // 32 - 7F Reserved
  // 80 - FD For use by alternate PTP profiles
  PTP_CA_Unknown = 0xFE // Unknown
// FF Reserved
} ptp_clockAccuracy; // Enum8

typedef enum ptp_tlvType {
  // Reserved 0000
  // Standard TLVs
  PTP_TT_MANAGEMENT = 0x0001, 
  PTP_TT_MANAGEMENT_ERROR_STATUS = 0x0002, 
  PTP_TT_ORGANIZATION_EXTENSION = 0x0003, 
  // Optional unicast message negotiation TLVs - IEC 61588-2009 / IEEE 1588-2008 16.1
  PTP_TT_REQUEST_UNICAST_TRANSMISSION = 0x0004,
  PTP_TT_GRANT_UNICAST_TRANSMISSION = 0x0005,
  PTP_TT_CANCEL_UNICAST_TRANSMISSION = 0x0006,
  PTP_TT_ACKNOWLEDGE_CANCEL_UNICAST_TRANSMISSION = 0x0007,
  // Optional path trace mechanism TLV - IEC 61588-2009 / IEEE 1588-2008 16.2
  PTP_TT_PATH_TRACE = 0x0008,
  // Optional alternate timescale TLV - IEC 61588-2009 / IEEE 1588-2008 16.3
  PTP_TT_ALTERNATE_TIME_OFFSET_INDICATOR = 0x0009,
  // Reserved for standard TLVs 000A - 1FFF
  // Experimental TLVs - IEC 61588-2009 / IEEE 1588-2008 14.2
  // Security TLVs Annex K
  PTP_TT_AUTHENTICATION = 0x2000,
  PTP_TT_AUTHENTICATION_CHALLENGE = 0x2001,
  PTP_TT_SECURITY_ASSOCIATION_UPDATE = 0x2002,
  // Cumulative frequency scale factor offset - IEC 61588-2009 / IEEE 1588-2008 Annex L
  PTP_TT_PTP_TLV_CUM_FREQ_SCALE_FACTOR_OFFSET = 0x2003
// Reserved for Experimental TLVs 2004 - 3FFF
// Reserved 4000 - FFFF
} ptp_tlvType; // Enum16

typedef enum ptp_severityCode {
  PTP_SC_EMERGENCY = 0x00, // system is unusable
  PTP_SC_ALERT = 0x01, // immediate action needed
  PTP_SC_CRITICAL = 0x02, // critical conditions
  PTP_SC_ERROR = 0x03, // error conditions
  PTP_SC_WARNING = 0x04, // warning conditions
  PTP_SC_NOTICE = 0x05, // normal but significant condition
  PTP_SC_INFORMATIONAL = 0x06, // informational messages
  PTP_SC_DEBUG = 0x07 // debug-level messages
// 08 - FF Reserved
} ptp_severityCode; // Enum8

typedef enum ptp_timeSource {
  PTP_TS_ATOMIC_CLOCK = 0x10,
  PTP_TS_GPS = 0x20,
  PTP_TS_TERRESTRIAL_RADIO = 0x30,
  PTP_TS_PTP = 0x40,
  PTP_TS_NTP = 0x50,
  PTP_TS_HAND_SET = 0x60,
  PTP_TS_OTHER = 0x90,
  PTP_TS_INTERNAL_OSCILLATOR = 0xA0
// F0-FE For use by alternate PTP profiles
// FF Reserved
} ptp_timeSource; // Enum8;

typedef enum ptp_portState {
  // 00 Reserved
  PTP_PS_INITIALIZING = 0x01,
  PTP_PS_FAULTY = 0x02,
  PTP_PS_DISABLED = 0x03,
  PTP_PS_LISTENING = 0x04,
  PTP_PS_PRE_MASTER = 0x05,
  PTP_PS_MASTER = 0x06,
  PTP_PS_PASSIVE = 0x07,
  PTP_PS_UNCALIBRATED = 0x08,
  PTP_PS_SLAVE = 0x09
// 10-FF Reserved
} ptp_portState; // Enum8

typedef enum ptp_delayMechanism {
  PTP_DM_E2E = 0x01, 
  PTP_DM_P2P = 0x02, 
  PTP_DM_DISABLED = 0xFE 
} ptp_delayMechanism; //Enum8

typedef enum ptp_clockType {
  PTP_CT_BOUNDARY, 
  PTP_CT_ORDINARY, 
  PTP_CT_TRANSPARENT 
} ptp_clockType; //Enum8

typedef enum ptp_recommendedState {
  PTP_BMC_M1, 
  PTP_BMC_M2, 
  PTP_BMC_M3, 
  PTP_BMC_S1, 
  PTP_BMC_P1, 
  PTP_BMC_P2, 
  PTP_BMC_LISTENING 
} ptp_recommendedState; // Enum8

//
// Derived data type specifications
//

typedef ptp_octet ptp_clockIdentity[8];

typedef struct PTP_TimeInterval {
  ptp_integer64 scalatedNanoseconds;
} PTP_TimeInterval;

// PTP_SecondsCount
typedef struct PTP_SecondsCount {
  ptp_uinteger32 secondsLow;
  ptp_uinteger16 secondsHigh;
} PTP_SecondsCount;

typedef struct PTP_TimeStamp {
  PTP_SecondsCount secondsField;
  ptp_uinteger32 nanoSecondsField;
} PTP_TimeStamp;

// All values of this type are read from other locations when it would be used
// * Port identity with clock identity as pointer
// */
//typedef struct PTP_PortIdentityP {
//} PTP_PortIdentityP;

// * Port identity
// */
//typedef struct PTP_PortIdentity {
//  ptp_clockIdentity clockIdentity;
//} PTP_PortIdentity;

typedef struct PTP_ParentPortIdentityP {
  ptp_clockIdentity *clockIdentity;
  ptp_uinteger16 portNumber;
} PTP_ParentPortIdentityP;

typedef struct PTP_PortAddress {
  ptp_networkProtocol networkProtocol;
  ptp_uinteger16 addressLength;
  ptp_octet *addressField;
} PTP_PortAddress;

typedef struct PTP_ClockQuality {
  ptp_uinteger8 clockClass;
  ptp_clockAccuracy clockAccuracy :8;
  ptp_uinteger16 offsetScaledLogVariance;
} PTP_ClockQuality;

typedef struct PTP_TLV {
  ptp_tlvType tlvType;
  ptp_uinteger16 lengthField;
  ptp_octet *valueField;
} PTP_TLV;

typedef struct PTP_PTPText {
  ptp_uinteger8 lengthField;
  ptp_octet *textField;
} PTP_PTPText;

typedef struct PTP_FaultRecord {
  ptp_uinteger16 faultRecordLength;
  PTP_TimeStamp faultTime;
  ptp_severityCode severityCode :8;
  PTP_PTPText faultName;
  PTP_PTPText faultValue;
  PTP_PTPText faultDescription;
} PTP_FaultRecord;

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

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

#endif /* PTP_TYPES_H */