SZSPTP ez430-RF2480 1.0

ZigBee Sensor Network with synchronized time and time-stamped measurements.
Enumerations
+ Collaboration diagram for Enumerations:

Typedefs

typedef enum ptp_networkProtocol ptp_networkProtocol
 
typedef enum ptp_clockAccuracy ptp_clockAccuracy
 
typedef enum ptp_tlvType ptp_tlvType
 
typedef enum ptp_severityCode ptp_severityCode
 
typedef enum ptp_timeSource ptp_timeSource
 
typedef enum ptp_portState ptp_portState
 
typedef enum ptp_delayMechanism ptp_delayMechanism
 
typedef enum ptp_clockType ptp_clockType
 
typedef enum ptp_recommendedState ptp_recommendedState
 

Enumerations

enum  ptp_networkProtocol {
  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, PTP_NP_Unknown = 0xFFFE
}
 
enum  ptp_clockAccuracy {
  PTP_CA_025NS = 0x20, PTP_CA_100NS = 0x21, PTP_CA_250NS = 0x22, PTP_CA_001US = 0x23,
  PTP_CA_002US = 0x24, PTP_CA_010US = 0x25, PTP_CA_025US = 0x26, PTP_CA_100US = 0x27,
  PTP_CA_250US = 0x28, PTP_CA_001MS = 0x29, PTP_CA_002MS = 0x2A, PTP_CA_010MS = 0x2B,
  PTP_CA_025MS = 0x2C, PTP_CA_100MS = 0x2D, PTP_CA_250MS = 0x2E, PTP_CA_001S = 0x2F,
  PTP_CA_010S = 0x30, PTP_CA_OVER = 0x31, PTP_CA_Unknown = 0xFE
}
 
enum  ptp_tlvType {
  PTP_TT_MANAGEMENT = 0x0001, PTP_TT_MANAGEMENT_ERROR_STATUS = 0x0002, PTP_TT_ORGANIZATION_EXTENSION = 0x0003, 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, PTP_TT_PATH_TRACE = 0x0008,
  PTP_TT_ALTERNATE_TIME_OFFSET_INDICATOR = 0x0009, PTP_TT_AUTHENTICATION = 0x2000, PTP_TT_AUTHENTICATION_CHALLENGE = 0x2001, PTP_TT_SECURITY_ASSOCIATION_UPDATE = 0x2002,
  PTP_TT_PTP_TLV_CUM_FREQ_SCALE_FACTOR_OFFSET = 0x2003
}
 
enum  ptp_severityCode {
  PTP_SC_EMERGENCY = 0x00, PTP_SC_ALERT = 0x01, PTP_SC_CRITICAL = 0x02, PTP_SC_ERROR = 0x03,
  PTP_SC_WARNING = 0x04, PTP_SC_NOTICE = 0x05, PTP_SC_INFORMATIONAL = 0x06, PTP_SC_DEBUG = 0x07
}
 
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
}
 
enum  ptp_portState {
  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
}
 
enum  ptp_delayMechanism { PTP_DM_E2E = 0x01, PTP_DM_P2P = 0x02, PTP_DM_DISABLED = 0xFE }
 
enum  ptp_clockType { PTP_CT_BOUNDARY, PTP_CT_ORDINARY, PTP_CT_TRANSPARENT }
 
enum  ptp_recommendedState {
  PTP_BMC_M1, PTP_BMC_M2, PTP_BMC_M3, PTP_BMC_S1,
  PTP_BMC_P1, PTP_BMC_P2, PTP_BMC_LISTENING
}
 

Detailed Description

Typedef Documentation

Clock accuracy code, Enum8

PTP clock type, Enum8

Delay mechanism code, Enum8

Network Protocol code, Enum16

Port state code, IEC 61588-2009 / IEEE 1588-2008 8.2.5.3.1 and 9.2.5, Enum8

Recomended port state with clockClass indication, Enum8

Severity code, Enum8

Time source code, Enum8

typedef enum ptp_tlvType ptp_tlvType

TLV type code, Enum16

Enumeration Type Documentation

Clock accuracy code, Enum8

Definition at line 170 of file ptp_types.h.

PTP clock type, Enum8

Enumerator
PTP_CT_BOUNDARY 

Boundary clock.

PTP_CT_ORDINARY 

Ordinary clock (only one port)

PTP_CT_TRANSPARENT 

Transparent clock (forward PTP messages, do not count as a node to PTP messages)

Definition at line 286 of file ptp_types.h.

Delay mechanism code, Enum8

Enumerator
PTP_DM_E2E 

end-to-end

PTP_DM_P2P 

pear-to-pear

PTP_DM_DISABLED 

see IEC 61588/IEEE 1588

Definition at line 277 of file ptp_types.h.

Network Protocol code, Enum16

Enumerator
PTP_NP_UDP_IPv4 

IEC 61588-2009 / IEEE 1588-2008 Annex D.

PTP_NP_UDP_IPv6 

IEC 61588-2009 / IEEE 1588-2008 Annex E.

PTP_NP_IEEE_802_3 

IEC 61588-2009 / IEEE 1588-2008 Annex F.

PTP_NP_DeviceNe 

IEC 61588-2009 / IEEE 1588-2008 Annex G.

PTP_NP_ControlNet 

IEC 61588-2009 / IEEE 1588-2008 Annex H.

PTP_NP_PROFINET 

IEC 61588-2009 / IEEE 1588-2008 Annex I.

Definition at line 152 of file ptp_types.h.

Port state code, IEC 61588-2009 / IEEE 1588-2008 8.2.5.3.1 and 9.2.5, Enum8

Definition at line 260 of file ptp_types.h.

Recomended port state with clockClass indication, Enum8

Enumerator
PTP_BMC_M1 

Master on clockClass 1 ~ 127 and grandMaster.

PTP_BMC_M2 

Master on clockClass > 128 and grandMaster.

PTP_BMC_M3 

Master and NOT grandMaster.

PTP_BMC_S1 

Slave.

PTP_BMC_P1 

clockClass 1 ~ 127 and NOT grandMaster or is PASSIVE to break a timing loop

PTP_BMC_P2 

clockClass > 128 and is PASSIVE to break a timing loop

PTP_BMC_LISTENING 

When port have no connection, keep listening state.

Definition at line 295 of file ptp_types.h.

Severity code, Enum8

Definition at line 229 of file ptp_types.h.

Time source code, Enum8

Definition at line 244 of file ptp_types.h.

TLV type code, Enum16

Enumerator
PTP_TT_MANAGEMENT 

IEC 61588-2009 / IEEE 1588-2008 15.5.3.

PTP_TT_MANAGEMENT_ERROR_STATUS 

IEC 61588-2009 / IEEE 1588-2008 15.5.4.

PTP_TT_ORGANIZATION_EXTENSION 

IEC 61588-2009 / IEEE 1588-2008 14.3.

Definition at line 199 of file ptp_types.h.