| ClockDomainType |
uint32 |
The Domain is identified by an integer, the domainNumber, in
the range of 0 to 255. An integer value that is used to assign
each PTP device to a particular domain. The following values
define the valid domains. [1] Section 7.1 Domains Table 2
Value definition.
--------- -------------------
0 Default domain
1 Alternate domain 1
2 Alternate domain 2
3 Alternate domain 3
4 - 127 User-defined domains
128 - 255 Reserved |
| ClockIdentity |
binary |
The clock Identity is an 8-octet array and will be presented in
the form of a character array. The value of the
ClockIdentity should be taken from the IEEE EUI-64 individual
assigned numbers as indicated in Section 7.5.2.2.2 of [1]. The
EUI-64 address is divided into the following fields.
OUI byte[0-2]
Extension identifier bytes:[3-7]
The clock identifier can be constructed from existing EUI-48
assignments and here is an abbreviated example extracted from
section 7.5.2.2.2 [1].
Company EUI-48 = 0xACDE4823456716
EUI-64 = ACDE48FFFE23456716
It is important to note the IEEE Registration Authority has
deprecated the use of MAC-48 in any new design. |
| ClockInstanceType |
uint32 |
The instance of the Clock of a given clock type in a given
domain. |
| ClockIntervalBase2 |
int32 |
The interval included in message types Announce, Sync,
Delay_Req, and Pdelay_Req as indicated in section 7.7.2.1 of
[1].
The mean time interval between successive messages shall be
represented as the logarithm to the base 2 of this time
interval measured in seconds on the local clock of the device
sending the message. The values of these logarithmic attributes
shall be selected from integers in the range -128 to 127 subject
to further limits established in an applicable PTP profile. |
| ClockMechanismType |
enumeration |
The clock type based on whether End to End or peer to peer
mechanisms are used. The mechanism used to calculate the Mean
Path Delay as indicated in Table 9 of IEEE 1588-2008.
Delay mechanism Value(hex) Specification
E2E 01 The port is configured to use
the delay request-response
mechanism.
P2P 02 The port is configured to use
the peer delay mechanism.
DISABLED FE The port does not implement
the delay mechanism. |
| ClockPortNumber |
uint32 |
An index identifying a specific Precision Time Protocol (PTP)
port on a PTP node. |
| ClockPortState |
enumeration |
This is the value of the current state of the protocol engine
associated with this port.
Port state Value Description
-----------------------------------------------------------
initializing 1 In this state a port initializes
its data sets, hardware, and
communication facilities.
faulty 2 The fault state of the protocol.
disabled 3 The port shall not place any
messages on its communication path.
listening 4 The port is waiting for the
announceReceiptTimeout to expire or
to receive an Announce message from
a master.
preMaster 5 The port shall behave in all respects
as though it were in the MASTER state
except that it shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, signaling, or
management messages.
master 6 The port is behaving as a master
port.
passive 7 The port shall not place any
messages on its communication path
except for Pdelay_Req, Pdelay_Resp,
Pdelay_Resp_Follow_Up, or signaling
messages, or management messages
that are a required response to
another management message
uncalibrated 8 The local port is preparing to
synchronize to the master port.
slave 9 The port is synchronizing to the
selected master port. |
| ClockProfileType |
enumeration |
Clock Profile used. From [1] section 3.1.30, Profile is the set
of allowed Precision Time Protocol (PTP) features applicable to
a device. |
| ClockQualityAccuracyType |
enumeration |
The ClockQuality as specified in section 5.3.7, 7.6.2.5 and
Table 6 of [1].
The following values are not represented in the enumerated
values.
0x01-0x1F Reserved
0x32-0x7F Reserved
It is important to note that section 7.1.1 RFC2578 allows for
gaps and enumerate values to start with zero when indicated by
the protocol. |
| ClockQualityClassType |
uint32 |
The ClockQuality as specified in section 5.3.7, 7.6.2.4 and
Table 5 of [1].
Value Description
------
----------------------------------------------------------
0 Reserved to enable compatibility with future
versions.
1-5 Reserved
6 Shall designate a clock that is synchronized
to a primary reference time source. The
timescale distributed shall be PTP. A
clockClass 6 clock shall not be a slave to
another clock in the domain.
7 Shall designate a clock that has previously
been designated as clockClass 6 but that has
lost the ability to synchronize to a primary
reference time source and is in holdover mode
and within holdover specifications. The
timescale distributed shall be PTP. A
clockClass 7 clock shall not be a slave to
another clock in the domain.
8 Reserved.
9-10 Reserved to enable compatibility with future
versions.
11-12 Reserved.
13 Shall designate a clock that is synchronized
to an application-specific source of time.
The timescale distributed shall be ARB. A
clockClass 13 clock shall not be a slave to
another clock in the domain.
14 Shall designate a clock that has previously
been designated as clockClass 13 but that
has lost the ability to synchronize to an
application-specific source of time and is
in holdover mode and within holdover
specifications. The timescale distributed
shall be ARB. A clockClass 14 clock shall
not be a slave to another clock in the domain.
15-51 Reserved.
52 Degradation alternative A for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 52
shall not be a slave to another clock in
the domain.
53-57 Reserved.
58 Degradation alternative A for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 58 shall
not be a slave to another clock in the domain.
59-67 Reserved.
68-122 For use by alternate PTP profiles.
123-127 Reserved.
128-132 Reserved.
133-170 For use by alternate PTP profiles.
171-186 Reserved.
187 Degradation alternative B for a clock of
clockClass 7 that is not within holdover
specification. A clock of clockClass 187 may
be a slave to another clock in the domain.
188-192 Reserved.
193 Degradation alternative B for a clock of
clockClass 14 that is not within holdover
specification. A clock of clockClass 193 may
be a slave to another clock in the domain.
194-215 Reserved.
216-232 For use by alternate PTP profiles.
233-247 Reserved.
248 Default. This clockClass shall be used if
none of the other clockClass definitions apply.
249-250 Reserved.
251 Reserved for version 1 compatibility; see Clause 18.
252-254 Reserved.
255 Shall be the clockClass of a slave-only clock; see
9.2.2. |
| ClockRoleType |
enumeration |
The Clock Role. The protocol generates a Master Slave
relationship among the clocks in the system.
Clock Role Value Description
--------------------------------------------------------------
Master clock 1 A clock that is the source of
time to which all other clocks on
that path synchronize.
Slave clock 2 A clock which synchronizes to
another clock (master). |
| ClockStateType |
enumeration |
The clock state returned by PTP engine.
Clock State Value Description
--------------------------------------------------------------
Freerun state 1 Applies to a slave device that is not
locked to a master. This is the initial
state a slave starts out with when it
is not getting any PTP packets from the
master or because of some other input
error (erroneous packets, etc).
Holdover state 2 In this state the slave device is
locked to a master but communication
with the master is lost or the
timestamps in the ptp packets are
incorrect. But since the slave was
locked to the master, it can run with
the same accuracy for sometime. The
slave can continue to operate in this
state for some time. If communication
with the master is not restored for a
while, the device is moved to the
FREERUN state.
Acquiring state 3 The slave device is receiving packets
from a master and is trying to acquire
a lock.
Freq_locked state 4 Slave device is locked to the Master
with respect to frequency, but not phase
aligned
Phase_aligned state 5 Locked to the master with respect to
frequency and phase. |
| ClockTimeInterval |
binary |
This textual convention corresponds to the TimeInterval
structure indicated in section 5.3.2 of [1]. It will be
presented in the form of a character array.
The TimeInterval type represents time intervals.
struct TimeInterval
{
Integer64 scaledNanoseconds;
};
The scaledNanoseconds member is the time interval expressed in
units of nanoseconds and multiplied by 2**16.
Positive or negative time intervals outside the maximum range
of this data type shall be encoded as the largest positive and
negative values of the data type, respectively.
For example, 2.5 ns is expressed as 0000 0000 0002 8000 in
Base16. |
| ClockTimeSourceType |
enumeration |
The ClockQuality as specified in section 5.3.7, 7.6.2.6 and
Table 7 of [1].
The following values are not represented in the enumerated
values.
0xF0-0xFE For use by alternate PTP profiles
0xFF Reserved
It is important to note that section 7.1.1 RFC2578 allows for
gaps and enumerate values to start with zero when indicated by
the protocol. |
| ClockTxModeType |
enumeration |
Transmission mode.
unicast. Using unicast commnuication channel.
multicast. Using Multicast communication channel.
multicast-mix. Using multicast-unicast communication channel |
| ClockType |
enumeration |
The clock types as defined in the MIB module description. |