DOC: Differentiate the ptp-notification behavior between T-GM and T-BC
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
StarlingX |
Fix Released
|
Low
|
Elisamara Aoki Gonçalves |
Bug Description
Brief Description
-----------------
Doc changes are required to align with the code changes introduced in https:/
Severity
--------
<Minor: System/Feature is usable with minor issue>
Diff with proposed changes in https:/
diff --git a/doc/source/
index bea04ea8..8aa2b921 100644
--- a/doc/source/
+++ b/doc/source/
@@ -132,6 +132,7 @@ For example, follow the steps below:
+ ptp4lClockClass
device:
@@ -139,6 +140,8 @@ For example, follow the steps below:
+ ptp4lClockClass
+ phc2sysToleranc
device:
@@ -161,9 +164,10 @@ For example, follow the steps below:
- device:
- holdover_seconds: 15
- poll_freq_seconds: 2
+ ptp4lClockClass
+ device:
+ holdover_seconds: 15
+ poll_freq_seconds: 2
@@ -184,6 +188,19 @@ For example, follow the steps below:
Set the logging level. DEBUG can be used for additional logs.
+ ``ptp4lClockCla
+ Set the list of clock classes that will allow ptp-notification to report "Locked". The
+ clockClass for a monitored ptp4l instance is read via the 'pmc'; if the instance
+ clockClass matches once of the 'ptp4lClockClas
+ ptp-notification will report "Locked" for that instance.
+
+ The default values are "6,7,135", which means that ptp-notification will report locked
+ when reading a clockClass of 6, 7 or 135 from the configured ptp4l instance. These
+ values are recommended for nodes operating as a Boundary Clock (BC).
+
+ For nodes operating as a GM, it is recommended to set the value to "6", so that only
+ clockClass 6 is reported as locked.
+
the HOLDOVER state before transitioning to FREERUN. The holdover value
@@ -209,6 +226,8 @@ For example, follow the steps below:
+ ptp4lClockClass
+ phc2sysToleranc
@@ -240,6 +259,30 @@ For example, follow the steps below:
Set the logging level. DEBUG can be used for additional logs.
+ ``ptp4lClockCla
+ Set the list of clock classes that will allow ptp-notification to report "LOCKED". The
+ clockClass for a monitored ptp4l instance is read via the 'pmc'; if the instance
+ clockClass matches once of the 'ptp4lClockClas
+ ptp-notification will report "LOCKED" for that instance.
+
+ The default values are "6,7,135", which means that ptp-notification will report locked
+ when reading a clockClass of 6, 7 or 135 from the configured ptp4l instance. These
+ values are recommended for nodes operating as a Boundary Clock (BC).
+
+ For nodes operating as a Grand Master (GM), it is recommended to set the value to "6",
+ so that only clockClass 6 is reported as locked.
+
+ ``phc2sysTolera
+ Default value: 1000
+
+ Set the skew threshold in nanoseconds at which ptp-notification will report that the
+ system clock is no longer considered "LOCKED".
+
+ The ptp-notification application compares the time of the system clock to the configured
+ source PHC; if the delta between the system clock and the PHC is greater than the
+ 'phc2sysToleran
+ not locked.
+
Value applies to all service types.
Changed in starlingx: | |
assignee: | nobody → Elisamara Aoki Gonçalves (egoncalv) |
description: | updated |
Changed in starlingx: | |
importance: | Undecided → Low |
Fix proposed to branch: master /review. opendev. org/c/starlingx /docs/+ /898013
Review: https:/