Revision History - UG1602

Enhanced PTP User Guide (UG1602)
Document ID
UG1602
Release Date
2024-12-19
Revision
1.2 English

The following table shows the revision history for this document.

Section Revision Summary
12/19/2024 Version 1.2
New Features in Version 3.8.0 Added.
New Features in Version 3.7.1 Added.
New Features in Version 3.7.0 Added.
Add Chronyd Sync Module Updated to recommend disabling implicit instance of crny sync module.
Assume One Hardware Clock per NIC Updated to add new default value.
Third Party Adapters Added reference to config options.
Table 1 Updated to current supported OS versions.
Additional Kernel Requirements Added.
XtremeScale X2 and SFN8000 Series Network Adapters Split into XtremeScale X2 Series Network Adapters and XtremeScale SFN8000 Series Network Adapters, updated to remove AppFlex.
Flareon SFN7000 Series Network Adapters Updated to remove AppFlex.
PPS Support Updated with X2541 modification.
OS ‘in-tree’ sfc Driver Updated to add example of kernel version string.
Download and Install sfptpd Added new packages and Install DEB section, deprecated tarball, reordered and made consistent other sections.
NTP Updated example.
Multicast IP Routing Added.
Run sfptpd Updated to add running from a DEB install.
Command Line Options Updated location of config files.
Table 1 Updated as follows:
  • Added ext-constraints parameter for selection_policy_rules option.
  • Added patterns for paths in message_log, stats_log, state_path, control_path, and json_stats options.
  • Added user option.
  • Deprecated daemon option.
  • Added range and default for sync_interval option.
  • Added step_threshold option.
  • Reverted non_xilinx_nics option to non_solarflare_nics.
  • Changed default for assume_one_phc_per_nic option.
  • Added efx parameter for phc_diff_methods option.
  • Added netlink, ntp, servo, and clocks parameters for trace_level option.
  • Deprecated json_remote_monitor option.
  • Removed netlink-and-probe, probe, manual, and manual-with-scan parameters for hotplug_detection_mode option, and deprecated option..
  • Added reporting_intervals option.
  • Added netlink_rescan_interval option.
  • Added netlink_coalesce_ms option.
  • Added rtc_adjust option.
  • Added clock_display_fmts option.
  • Added unique_clockid_bits option.
  • Added legacy_clockids option.
Example Configuration Files Updated to add locations for a DEB install.
default.cfg Changed filename, updated to match current file.
default-sysv.cfg Removed.
many_instances.cfg Updated to match current file.
Viewing State and Statistics Files Updated to add config and sync-instances files.
Sync Instances File Added.
Config File Added.
Event Logging Updated to add file output.
Trace Level Updated to add categories.
Reporting Intervals Added.
Generic Configuration Options Updated as follows:
  • Removed ptp_uuid_filtering option.
  • Removed ptp_domain_filtering option.
  • Deprecated remote_monitor option.
  • Added onload_ext option.
  • Added lacp_bypass option.
Instance-specific Configuration Options Updated as follows:
  • Added master-only parameter for ptp_mode option.
  • Added range and updated default values for ptp_announce_interval, ptp_announce_timeout, ptp_sync_pkt_interval, and ptp_delayreq_interval options.
  • Updated mon_monitor_address option to add support for multiple addresses.
ptp_slave_chrony_fallback.cfg Updated to match current file.
ptp_boundary.cfg Updated to match current file.
Description Updated to state that ntpsec is interoperable, and preferred over cronyd.
Description Updated to state that ntpsec is preferred over cronyd.
Instance-specific Configuration Options Updated to add clock_control option.
Example Configuration Files Updated to recommend disabling implicit instance of crny sync module.
Instance-specific Configuration Options Updated to state that interface can be a bond. bridge, or vlan.
Cpu Affinity and the sfptpd Threading Model Updated to add CPUAffinity= unit file option.
Standalone Client Updated to add locations for a DEB install.
Python Client Updated to add locations for a DEB install.
Options in Detail Moved Clustering topic to start.
Chronyd Updated to include recent additional support, and to recommend disabling implicit instance of crny sync module.
1PPS Measurement Procedure Updated how to get mean offset.
1PPS I/O Specification Updated pulse width.
State/State Files Updated to add config and sync-instances files.
Collecting JSON Format Stats Added.
Remote Reporting of Real-Time Statistics Updated because IEEE 1588 is no longer a draft.
Enable for a Monitored Node Updated to add port parameter for mon_monitor_address option.
Enable for a Monitoring Station Updated to use sfptpmon script.
Remote Monitoring Retitled, updated to add sftpmon script.
Meinberg NetSync Monitor Updated section to use in config file.
LACP Updated to add improvements.
Automatic Startup Removed Using the init.d script from Using a Binary RPM Package, added Using a Binary DEB Package section, reordered and made consistent all sections.
Figure 1 Updated with step for OS application.
Thread Engine Timer Expired Messages Added.
04/07/2023 Version 1.1
New Features in Version 3.6.0 Added.
Table 1 Updated to current supported OS versions.
Table 1 Updated as follows:
  • Added crny parameter for sync_module option.
  • Added manual-startup parameter for selection_policy option.
  • Changed default for epoch_guard option.
  • Added bic parameter for trace_level option.
  • Added ignore_critical option.
Reordered some rows.
Example Configuration Files Updated to match supplied examples.
Example Configuration Files Updated to match supplied examples.
ptp_slave_chrony_fallback.cfg Added.
Example Configuration Files Retitled.
Example Configuration Files Retitled.
Chronyd Sync Module Added.
Chronyd Updated to add support in version 3.6.0.
10/18/2022 Version 1.0
Initial release. N/A