ontime CM-1600 User manual

v1.12
Cloudberry Management – PTP Management User Manual
- 1 -
Cloudberry Management – PTP User Manual

v1.12
Cloudberry Management – PTP Management User Manual
- 2 -
Contents
1 INTRODUCTION ..................................................................................................................... - 3 -
1.1 IP SET INTRODUCTION ............................................................................................................- 4 -
1.1.1 Installation................................................................................................................... - 4 -
1.1.2 Starting IPSet............................................................................................................... - 5 -
1.2 IPS ET ADVANCED CONFIGURATION .......................................................................................- 7 -
1.2.1 PTP CPU settings ........................................................................................................ - 7 -
1.2.2 Switch CPU settings .................................................................................................... - 8 -
1.2.3 PTP Status ................................................................................................................... - 9 -
1.2.4 Time ........................................................................................................................... - 10 -
1.2.5 Software/Hardware version....................................................................................... - 11 -
1.2.6 Summary .................................................................................................................... - 12 -
1.2.7 Temperature............................................................................................................... - 13 -
1.2.8 Configuration popup.................................................................................................. - 14 -
1.2.9 Management/Upgrade of multiple devices ................................................................ - 35 -
1.3 IPS ET S IMPLIFIED CONFIGURATION .....................................................................................- 37 -
1.3.1 Discovered devices .................................................................................................... - 37 -
1.3.2 Configuration popup.................................................................................................. - 38 -
1.3.3 Upgrade of multiple devices ...................................................................................... - 41 -
1.4 PTP PARAMETERS AND DATA SETS ......................................................................................- 43 -
1.4.1 ClockDesc data set .................................................................................................... - 43 -
1.4.2 Save to non volatile storage....................................................................................... - 44 -
1.4.3 Create initialization event.......................................................................................... - 44 -
1.4.4 Clock accuracy .......................................................................................................... - 44 -
1.4.5 PTP default data set................................................................................................... - 44 -
1.4.6 PTP current data set.................................................................................................. - 45 -
1.4.7 PTP parent data set ................................................................................................... - 46 -
1.4.8 PTP time property data set ........................................................................................ - 47 -
1.4.9 PTP port data set....................................................................................................... - 47 -
1.4.10 PTP TC data set......................................................................................................... - 48 -
1.4.11 PTP TC port data set ................................................................................................. - 49 -
1.5 PTP M ANAGEMENT VIA PTP V 2B ROWSER ...........................................................................- 49 -
1.5.1 PTP Data sets ............................................................................................................ - 51 -
1.5.2 Ordinary clock summary ........................................................................................... - 51 -
1.5.3 Logging...................................................................................................................... - 51 -
1.5.4 Settings pane.............................................................................................................. - 52 -
1.5.5 Decode IEEE1588-2008 messages ............................................................................ - 54 -
1.5.6 PTPBrowser notes ..................................................................................................... - 55 -
1.6 SNMP MANAGEMENT .........................................................................................................- 56 -
1.6.1 OnTime private MIB .................................................................................................. - 56 -

v1.12
Cloudberry Management – PTP Management User Manual
- 3 -
1 Introduction
This manual describes how to configure and manage the CM-1600 from OnTime Networks.
The CM-1600 platform contains two CPUs. The switch CPU is used for switch management
and the PTP CPU is used for the PTP (IEEE-2002 and IEEE-2008) protocol. Separate IP
addresses are used for the two CPUs. This manual only describes the PTP CPU features
that can be managed through:
- IPSet / PTPv2Browser
- SNMP

v1.12
Cloudberry Management – PTP Management User Manual
- 4 -
1.1 IPset introduction
IPSet is a tool for configuration of the PTP CPU of CM1600. The tool is bundled together with
the PTPBrowser tool in the same installation. Via IPSet you can:
- Set IP address, mask and gateway
- Upload PTP settings file
- Configure PTP settings
- Upgrade the PTP CPU
- Read software and hardware revision data.
1.1.1 Installation
Installation is done following the instructions given when starting the installer executable

v1.12
Cloudberry Management – PTP Management User Manual
- 5 -
1.1.2 Starting IPSet
The figure above shows the startup screen of IPSet. In order to start the tool you must select
an interface on your computer; until you select an interface the three image buttons on the
bottom are disabled. You may start different sessions on different interfaces, and IPSet will
search for devices on the specified interface. Note that you do not need to be in the same IP
domain in order to find the device during scan, but you need to be in the same IP domain to
configure a device.
There are three options after you have selected an interface:

v1.12
Cloudberry Management – PTP Management User Manual
- 6 -
Start IPSet with advanced configuration. IPSet searches for devices on the selected interface
and displays detailed information about the unit. All configuration options are available.
Start IPSet with simplified configuration. IPSet searches for devices on the selected interface
and shows a subset of information about the discovered devices. A set of especially relevant
parameters are configurable.
Start the PTP Browser tool on the selected interface.

v1.12
Cloudberry Management – PTP Management User Manual
- 7 -
1.2 IPSet advanced configuration
There are a number of panes on the IPSet menu. Common for all panes are
the MAC and IP address of the devices.
1.2.1 PTP CPU settings
The PTP CPU handles the PTP protocol and this menu shows the network settings for this
CPU. How to change network settings is explained later in this document.
Table column
Description
PTP MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
Mask
Mask of the PTP CPU. The mask will be set equal on the
PTP CPU and the Switch CPU when settings IP-address via
IPSet.
Gateway
Gateway of the PTP CPU. The gateway will be set equal on
the PTP CPU and the Switch CPU when settings IP-address
via IPSet.
DHCP
PTP CPU DHCP enabled/disabled
Hostname
An optional hostname of the device
Signature
Signature of the device
Mechanics
CM-1600 comes in different versions, for instance: AERO,
and 19’’ RJ45. This tab shows the type of mechanics

v1.12
Cloudberry Management – PTP Management User Manual
- 8 -
1.2.2 Switch CPU settings
The switch CPU handles switch management. A subset of the switch settings are
configurable via the IPSet tool. The rest of the switch protocols are managed via SNMP and
the switch web interface.
Table column
Description
PTP MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
Switch MAC Address
MAC address of the Switch CPU
Switch IP Address
IP Address of the Switch CPU
Mask
Mask of the Switch CPU. The mask will be set equal on the
PTP CPU and the Switch CPU when settings IP-address via
IPSet.
Gateway
Gateway of the Switch CPU. The gateway will be set equal
on the PTP CPU and the Switch CPU when settings IP-
address via IPSet.
Serial number
The serial number of the device
System
Name
System Name – configurable via web interface

v1.12
Cloudberry Management – PTP Management User Manual
- 9 -
1.2.3 PTP Status
The PTP status pane gives a short summary of the PTP status for the different devices in the
network. Information such as device state, PTP version, Delay Mechanism and GPS
information can be found here. Further details regarding PTP management is performed in
the PTPv2Browser which is embedded in IPSet. This overview is useful for verifying that the
devices have compatible configuration.
Table column
Description
MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
PTP State
PTP state of the device.
Valid states: MASTER, SLAVE, INITIALIZING, PASSIVE,
UNCALIBRATED
PTP Delay Mechanism
PTP Delay mechanism.
Valid states are: End to End or Peer to Peer
PTP Version
PTP version 2 equals IEEE1588-2008
PTP Version 1 equals IEEE1588-2002
Two Step
False = One Step (Time stamps are inserted on the fly on
event messages)
True = Two step operation (The event messages are time
stamped and time information is updated in general
messages)
GPS Enabled
Enabled = PTP stack will synchronize to GPS. Requires that
a GPS antenna is connected to work.
GPS Short circuited
Indicates that the GPS antenna is short circuited. This
situation must be resolved at once or else the GPS receiver
might be damaged.
GPS Sync
The PTP stack is synchronized to GPS time.
GPS Lock
The GPS receiver has lock to satellites. The GPS receiver
has sufficient reception in order to synchronize to GPS time,
but is not necessarily synchronized to GPS. See GPS sync.

v1.12
Cloudberry Management – PTP Management User Manual
- 10 -
1.2.4 Time
The Time pane shows the time of the device in the PTP time scale
Table column
Description
MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
Time
PTP time

v1.12
Cloudberry Management – PTP Management User Manual
- 11 -
1.2.5 Software/Hardware version
The software/hardware version pane is for informational use. This documents which Image
the unit is using and software/hardware revisions of all major components within CM-1600.
Note that the whole view is not visible above.
Table column
Description
PTP MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
PTP Image Selected
Image which will be run at next boot. The PTP CPU has dual
images.
PTP Image Booted
Current running image
PTP Uboot revisi
on
Bootloader version
PTP Software revision
PTP software revision
FPGA revision
FPGA revision
Hardware front board rev.
Front (Connector) printed circuit board revision
Hardware switch b
oard rev
Switch (Motherboard with CPUs) printed circuit board
revision
Switch software revision
Switch CPU software revision
Switch kernel revision
Switch CPU kernel revision
Mechanics
CM-1600 comes in different versions, for instance: AERO,
and 19’’ RJ45. This tab shows the type of mechanics

v1.12
Cloudberry Management – PTP Management User Manual
- 12 -
1.2.6 Summary
NOTE: The summary tab is removed in versions >= 2.35
The summary pane contains an excerpt of the information from the other panes in the
network.
Table column
Description
PTP MAC Address
MAC address of the PTP CPU
PTP IP Address
IP Address of the PTP CPU
Mask
Mask of the PTP CPU. The mask will be set equal on the
PTP CPU and the Switch CPU when settings IP-address via
IPSet.
Gateway
Gateway of the PTP CPU. The gateway will be set equal on
the PTP CPU and the Switch CPU when settings IP-address
via IPSet.
DHCP
PTP CPU DHCP enabled/disabled
PTP State
PTP state of the device.
Valid states: MASTER, SLAVE, INITIALIZING, PASSIVE,
UNCALIBRATED
PTP Delay Mechanism
PTP Delay mechanism.
Valid states are: End to End or Peer to Peer
PTP Version
PTP version 2 equals IEEE1588-2008
PTP Version 1 equals IEEE1588-2002
GPS Status
GPS connected
PTP Image Selected
Image which will be run at next boot. The PTP CPU has dual
images.
PTP Image Booted
Current running image
PTP Uboot revision
Bootloader version
PTP Softwa
re revision
PTP software revision
FPGA revision
FPGA revision
Hardware front board rev.
Front (Connector) printed circuit board revision
Hardware switch board rev
Switch (Motherboard with CPUs) printed circuit board
revision

v1.12
Cloudberry Management – PTP Management User Manual
- 13 -
1.2.7 Temperature
The temperature pane is fully supported for FPGA versions from 6.41 and above. The column
called: “temperature” shows the temperature at one of the edges of the switch board, which is
closest to the air temperature within the box. The FPGA temperature column shows the
temperature from a sensor close to the FPGA, which is placed in the center of the switch
board. Both Celcius and Farenheit temperature units are shown.

v1.12
Cloudberry Management – PTP Management User Manual
- 14 -
1.2.8 Configuration popup
In order to change some of the settings you can double click or right click on the unit. A small
popup screen will appear with several choices. The different choices are described below.
1.2.8.1 Set IP address
Here you may change the IP address, mask, gateway for both CPUs and enable/disable the
DHCP client for the PTP CPU. Note that the mask and gateway of the switch CPU is
automatically set to the mask of the PTP CPU. This is done in order to avoid mis-
configuration of CM-1600.
After apply is pressed the settings are stored permanently. The main frame of IPSet shall
reappear and the new settings shall be reflected here.

v1.12
Cloudberry Management – PTP Management User Manual
- 15 -
1.2.8.2 Configure device
1.2.8.2.1 PTP Settings
In this menu you can configure PTP parameters. You may change values in the menu without
it being stored to CM-1600. Blue fields are fields with changes which have not been stored to
CM-1600.
In order to save the new configuration, press the: “Set” button. You shall receive confirmation
by a popup dialog if the new settings are stored correctly and all fields shall be white.
However, the settings are not applied to the running configuration. In order to run with the
new settings the PTP CPU must be rebooted. The “Reboot PTP CPU” button will force a
reboot of the PTP CPU. Note that the switch functionality of CM-1600 will run unaffected by a
reboot of the PTP CPU.
The refresh button will force a read of the values for the relevant CM-1600.
Store config: Press “set”
Apply config: Press the “Reboot PTP CPU” after a “Set” (The PTP CPU will reboot and use
new settings when it boots up)
Refresh: Force a new read of the stored values on CM-1600 (Note: These are the stored
values of the device and not necessarily running values)

v1.12
Cloudberry Management – PTP Management User Manual
- 16 -
Section
Description
PTP Settings
-
User De
s
cription
Optional user description of the PTP application
-
PTP Version
Per port
- PTP version is seleced per port. The focus is
shifted to the PTP Per port settings
Version 1 – equals IEEE1588-2002.
Not all these settings are relevant for IEEE1588-2002. By
choosing PTP version 1, the menu changes to reflect the
relevant settings for IEEE1588-2002.
Version 2 – equals IEEE1588-2008
-
Network Protocol
Per Port
– Packet encapsulation is selectable per port
UDP/Ipv4 – PTP Packets are transported over UDP/Ipv4
IEEE802.3/Ethernet – PTP packets are transported over
Layer2 IEEE803.3
-
Datagram
Per Port
– Packet datagram is selectable per port
Multicast – One to many communication. The PTP stack will
send IGMP join to the relevant MC groups for PTP.
Unicast – One to one communication
-
P
d
elay req interval
The frequency of Path Delay request messages
-
Announce interv
al
The frequency of Announce messages
-
Sync interval
The frequency of Sync messages
-
Delay requ
est
interval
In SLAVE state, this is the number of Delay request
messages sent per second.
Note that a MASTER clock may override this setting and
send fewer Delay responses.
In MASTER state, this value has no meaning.
-
Max incoming
delay req/s
In MASTER state, this number denotes the maximum
number of delay requests per second which is processed per
slave. In other words, the maximum number of delay
responses which is sent to each slave per second. The
number is linked to the Sync interval and will be updated
when the Sync interval is updated.
In SLAVE state this number has no meaning.
-
Operation mode
One Step
– Time stamps are inserted on the fly in event
packets (Sync, Delay_req). Transparent clock operation is
also 1-step.
Two Step – Event packets are time stamped and time
information is updated in general packets (Follow_up,
Delay_resp, Pdelay_Resp_FU ). Transparent clock operation
is also 2-step.

v1.12
Cloudberry Management – PTP Management User Manual
- 17 -
-
P
riority 1
PTP Priority 1 field.
Used in the BMCA algorithm to determine the best master
clock
-
Priority 2
PTP Priority 2 field.
Used in the BMCA algorithm to determine the best master
clock
-
Slave only
PTP SC flag
enable/
disable
.
Enabling this checkbox ensures that the node can only
become a Slave clock.
Section
Description
PTP Profiles
-
Default profile
OC/TC
Default PTP profile as described in the IEEE1588-2008
standard.
Settings: UDP/Ipv4, Multicast, E2E, 1 Sync/s, 1 Delay_req/s,
Two step
Note that the unit is both a Transparent clock and an
Ordinary clock.
-
Layer 2 profile
Layer 2 profile
Settings: IEEE802.3/Ethernet, Multicast, P2P, 8 Sync/s, 1
Delay_req/s, Two step, VLAN
Note that the unit is both a Transparent clock and an
Ordinary clock.
-
Telecom profile
Telecom profile.
Settings: UDP/Ipv4, Unicast, E2E, 128 Sync/s, 128
Delay_req/s, One step
This option may be grayed out depending of the firmware
version of the unit. Note that the unit is both a one step
Transparent clock and an Ordinary clock.
-
Custom profile
If the settings differ from any of the profiles above, the
custom profile will be activated.
-
TC only (1
-
step)
This option disables the Ordinary clock and the node is a 1-
Step End-to-End Transparent Clock only. This mode can
handle full wire speed of PTP data since the TC is
implemented in hardware. Note that the device will only
answer IPSet configuration commands, but not respond to
Management messages (sent by for instance PTPBrowser)
since the Ordinary clock is disabled.
-
TC
translator
This option enables the Transparent clock translator function.
Upon selection, the focus is set on the PTP Port settings
where the PTP version per port is configurable.

v1.12
Cloudberry Management – PTP Management User Manual
- 18 -
Section
Description
GPS settings
-
Disable
GPS is disabled.
The unit will start counting from the last set time in memory.
-
Internal
Internal GPS is enabled.
The unit will synchronize to GPS time and will not act as
master until GPS lock and GPS sync is achieved.
An antenna must be connected for GPS to achieve signal
(QN on rugged CM-1600, BNC on RJ-45 versions)
-
External GPS
External GPS enabled. The internal GPS is disabled. The
interface to the GPS is then via a serial connection and a
PPS interface. Serial settings must also be configured.
Note that not any GPS may be used since they often have
proprietary configuration protocols. Contact OnTime
Networks if a different GPS than the standard one shall be
used. A firmware update may be necessary.
-
GPS cable length
Specify the GPS cable length in meter [m].
This parameter is meant for compensating for the static
offset a GPS cable introduces. The propagation delay of the
signal in a GPS cable is approximately 5ns/m, which is the
offset introduced per meter of cable.
Section
Description
Regulator settings
The SC uses a PI regulator when synchronizing to master
time. This regulator is tunable by the parameters below.
-
Proportional part
Default value 0.8
-
Integral part
Default value 0.1

v1.12
Cloudberry Management – PTP Management User Manual
- 19 -
1.2.8.2.2 PTP Port Settings
PTP Port Settings page contains two main configuration categories, the PTP translation
settings and the PTP port enable/disable functionality. The PTP port enable/disable feature
enables and disables PTP functionality completely on the selected port.
In TC translator mode it is possible to set the PTP version as well as the encapsulation on
each port. The PTP Translation settings page will be enabled by selecting either of the
following options on the PTP Settings page:
- PTP version : Per port
- Network protocol : Per port
- PTP Profiles: TC Translator
Until one of the selections above is done, the PTP translation settings are disabled.

v1.12
Cloudberry Management – PTP Management User Manual
- 20 -
Section
Description
PTP Port settings
In TC translator mode it is possible to set the PTP version
on each port as well as the encapsulation.
-
PTP v1
IEEE1588 - 2002
-
PTP v2
IEEE1588 - 2008
-
Layer 2
Transport over IEEE802.3/ Ethernet
-
UDP IPv4
Transport over UDP IPv4
PTP Port enable/disable
Enable or disable PTP functionality on a port.
A checked box indicates a PTP enabled port, whereas an
unchecked box disabled PTP functionality on this port. If a
port is disabled, PTP messages will not be sent on this port.
Peer to Peer messages will not be answered etc.