starlingx/docs
Code Issues Proposed changes

Differentiate the ptp-notification behavior between T-GM and T-BC (dsr8)

Browse Source 
Updated PTP Notification Status Conditions
Updated abbrev.txt file

Change-Id: I65543482bb06ba2198463a1cb208bf2c82b8ff4a
Signed-off-by: Juanita Balaraj <juanita.balaraj@windriver.com>
This commit is contained in:
Juanita Balaraj 2023-10-13 17:58:12 +00:00 committed by Juanita-Balaraj
parent 89baab8331
commit 8a2edff833
2 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/guest_integration/kubernetes/ptp-notification-status-conditions-6d6105fccf10.rst
View File

@ -14,13 +14,15 @@ The |PTP| status notifications are derived based on the following conditions:
+=====================+===================================================+===================================================================================================================================================================+ +=====================+===================================================+===================================================================================================================================================================+
| Clock Status | Status | Description | | Clock Status | Status | Description |
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Freerun | Clock is out of sync state | - If portState is not “SECONDARY” or ClockClass value is NOT "6" or timeTraceable flag is FALSE. | | Freerun | Clock is out of sync state | - If portState is not “SECONDARY” or ClockClass value is NOT "6", "7", "135" or timeTraceable flag is FALSE. |
| | | | | | | |
| | | - If holdover time exceeds its provided value. | | | | - If holdover time exceeds its provided value. |
| | | | | | | |
| | | - If PMC, ptp4l.conf, ptp4l or phc2sys are not accessible. | | | | - If PMC, ptp4l.conf, ptp4l or phc2sys are not accessible. |
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Locked | Clock is in sync state | If portState is "SECONDARY" and ClockClass value is "6" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. | | Locked | Clock is in sync state | - If portState is "SECONDARY" and ClockClass value is "6", "7" or "135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. |
| | | |
| | | - Locked clockClass values can be changed using the ptp4lClockClassLockedList Helm override. See "Install PTP Notifications" document for instructions. |
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Holdover | Clock is in holdover state | * For NICs using the Intel ice driver: If the state is transitioned from ``Locked`` to ``Holdover`` AND phc2sys is accessible, and holdover time does not expire. | | Holdover | Clock is in holdover state | * For NICs using the Intel ice driver: If the state is transitioned from ``Locked`` to ``Holdover`` AND phc2sys is accessible, and holdover time does not expire. |
| | | | | | | |

2
doc/source/shared/abbrevs.txt
View File

@ -169,7 +169,7 @@
.. |TBF| replace:: :abbr:`TBF (Token Bucket Filter)` .. |TBF| replace:: :abbr:`TBF (Token Bucket Filter)`
.. |TCP| replace:: :abbr:`TCP (Transition Control Protocol)` .. |TCP| replace:: :abbr:`TCP (Transition Control Protocol)`
.. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)` .. |TFTP| replace:: :abbr:`TFTP (Trivial File Transfer Protocol)`
.. |T-GM| replace:: :abbr:`T-GM (Telecom Grand Primary)` .. |T-GM| replace:: :abbr:`T-GM (Telecom Grand Master)`
.. |TLS| replace:: :abbr:`TLS (Transport Layer Security)` .. |TLS| replace:: :abbr:`TLS (Transport Layer Security)`
.. |ToR| replace:: :abbr:`ToR (Top-of-Rack)` .. |ToR| replace:: :abbr:`ToR (Top-of-Rack)`
.. |TPM| replace:: :abbr:`TPM (Trusted Platform Module)` .. |TPM| replace:: :abbr:`TPM (Trusted Platform Module)`