starlingx/docs
Code Issues Proposed changes

Update definition of ptp-notification holdover (r6,r7,dsR7)

Browse Source 
Update Holdover state definition for Intel Ice vs.
other NICs.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ide80681db7ed1ed916612a03b461ad97f304ef05
This commit is contained in:
Ron Stone 2022-09-26 14:27:21 -04:00
parent 362af54d37
commit b791544690
1 changed files with 15 additions and 13 deletions

28
doc/source/guest_integration/kubernetes/ptp-notifications-overview.rst

@ -44,19 +44,21 @@ same pod and communicates with the application via a REST API.
.. table::
:widths: auto
+---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| Clock Status | Status | Description |
+=====================+===================================================+========================================================================================================================================================+
| Freerun | Clock is out of sync state | - If portState is not "SECONDARY" or ClockClass value is NOT "6, 7 or 135" or timeTraceable flag is FALSE. |
| | | |
| | | - If holdover time exceeds its provided value. |
| | | |
| | | - 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, 7 or 135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. |
+---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| Holdover | Clock is in holdover state | If the state is transitioned from "Locked" to "Freerun" AND phc2sys is accessible, and holdover time does not expire. |
+---------------------+---------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Clock Status | Status | Description |
+=====================+===================================================+===================================================================================================================================================================+
| Freerun | Clock is out of sync state | - If portState is not "SECONDARY" or ClockClass value is NOT "6, 7 or 135" or timeTraceable flag is FALSE. |
| | | |
| | | - If holdover time exceeds its provided value. |
| | | |
| | | - 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, 7 or 135" and timeTraceable flag is TRUE and PMC, ptp4l.conf, ptp4l or phc2sys are accessible. |
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
| | | |
| | | * For other NIC types: If the state is transitioned from ``Locked`` to ``Freerun`` AND phc2sys is accessible, and holdover time does not expire. |
+---------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
**Integrated Containerized Applications**