From 5bf2583ffb9e90b4ee93d4434d145c6ad04f83da Mon Sep 17 00:00:00 2001 From: Elaine Fonaro Date: Mon, 29 Aug 2022 17:56:09 -0300 Subject: [PATCH] Updated the configuring-ptp-service-using-the-cli Doc (r5,r6, dsr6, dsr7) 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 Change-Id: Ia67f5a324093dea77d7e990cb5bb35d02193b70e --- .../configuring-ptp-service-using-the-cli.rst | 21 ++++++++++++++++++ .../index-sysconf-kub-78f0e1e9ca5a.rst | 1 - .../ptp-limitations-64338c74b415.rst | 22 ------------------- 3 files changed, 21 insertions(+), 23 deletions(-) delete mode 100644 doc/source/system_configuration/kubernetes/ptp-limitations-64338c74b415.rst diff --git a/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst index a559d57a4..8023008ff 100644 --- a/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst +++ b/doc/source/system_configuration/kubernetes/configuring-ptp-service-using-the-cli.rst @@ -230,3 +230,24 @@ Create an interface and assign to ports ~(keystone_admin)]$ system ptp-instance-apply ~(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 \ No newline at end of file diff --git a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst index 1651185db..ed2e6330f 100644 --- a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst +++ b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst @@ -49,7 +49,6 @@ PTP Server Configuration :maxdepth: 2 ptp-introduction-d981dd710bda - ptp-limitations-64338c74b415 configuring-ptp-service-using-the-cli ptp-interfaces-df73e9b43677 instance-specific-considerations-d9d9509c79dd diff --git a/doc/source/system_configuration/kubernetes/ptp-limitations-64338c74b415.rst b/doc/source/system_configuration/kubernetes/ptp-limitations-64338c74b415.rst deleted file mode 100644 index a6f53e773..000000000 --- a/doc/source/system_configuration/kubernetes/ptp-limitations-64338c74b415.rst +++ /dev/null @@ -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 \ No newline at end of file