starlingx/docs
Code Issues Proposed changes

Updated the configuring-ptp-service-using-the-cli Doc (r5,r6, dsr6, dsr7)

Browse Source 
Updated the correct ptp-cli file.
Minor formatting fixes.
Added the PTP Limitations contents to the CLI file.
Removed the PTP Limitations topic from index.
Removed the PTP Limitations file.

Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com>
Change-Id: Ia67f5a324093dea77d7e990cb5bb35d02193b70e
This commit is contained in:
Elaine Fonaro 2022-08-29 17:56:09 -03:00 committed by Juanita-Balaraj
parent 126131ce63
commit 5bf2583ffb
3 changed files with 21 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst
View File

@ -230,3 +230,24 @@ Create an interface and assign to ports
~(keystone_admin)]$ system ptp-instance-apply ~(keystone_admin)]$ system ptp-instance-apply
~(keystone_admin)]$ fm alarm-list ~(keystone_admin)]$ fm alarm-list
PTP Limitations
---------------
NICs using the Intel Ice NIC driver may report the following in the ``ptp4l``
logs, which might coincide with a |PTP| port switching to ``FAULTY`` before
re-initializing.
.. code-block:: none
ptp4l[80330.489]: timed out while polling for tx timestamp
ptp4l[80330.489]: increasing tx_timestamp_timeout may correct this issue, but it is likely caused by a driver bug
This is due to a limitation of the Intel Ice driver. The recommended workaround
is to set the ``tx_timestamp_timeout`` parameter to 700 (ms) in the ``ptp4l``
config.
.. code-block:: none
~(keystone_admin)]$ system ptp-instance-parameter-add ptp-inst1 tx_timestamp_timeout=700

1
doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst
View File

@ -49,7 +49,6 @@ PTP Server Configuration
:maxdepth: 2 :maxdepth: 2
ptp-introduction-d981dd710bda ptp-introduction-d981dd710bda
ptp-limitations-64338c74b415
configuring-ptp-service-using-the-cli configuring-ptp-service-using-the-cli
ptp-interfaces-df73e9b43677 ptp-interfaces-df73e9b43677
instance-specific-considerations-d9d9509c79dd instance-specific-considerations-d9d9509c79dd

22
doc/source/system_configuration/kubernetes/ptp-limitations-64338c74b415.rst
View File

@ -1,22 +0,0 @@
.. _ptp-limitations-64338c74b415:
===============
PTP Limitations
===============
NICs using the Intel ICE NIC driver may report the following in the `ptp4l``
logs, which might coincide with a |PTP| port switching to ``FAULTY`` before
re-initializing.
.. code-block:: none
ptp4l[80330.489]: timed out while polling for tx timestamp
ptp4l[80330.489]: increasing tx_timestamp_timeout may correct this issue, but it is likely caused by a driver bug
This is due to a limitation of the Intel ICE driver. The recommended workaround
is to set the ``tx_timestamp_timeout`` parameter to 700 (ms) in the ``ptp4l``
config.
.. code-block:: none
~(keystone_admin)]$ system ptp-instance-parameter-add ptp-inst1 tx_timestamp_timeout=700