starlingx/docs
Code Issues Proposed changes

Enhance PTP features to support 5G Time SyncE Solution - Phase 2

Browse Source 
Add mention of Logan Beach NIC in all PTP contexts where Westport
Channel NIC is currenty mentioned.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I9952a6803a11bd0982a0ac853a69826e8b121b34
This commit is contained in:
Ron Stone 2022-06-13 14:35:00 -04:00
parent 72b67d3d14
commit 3dbc75a4d6
4 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -147,8 +147,8 @@ types are:
``clock``
``clock`` is not an daemon or service, but instead an abstract unit used to
hold the interfaces and configuration for setting Westport Channel NIC
control parameters (syncE and PPS transmission).
hold the interfaces and configuration for setting Westport Channel
or Logan Beach NIC control parameters (syncE and PPS transmission).
Valid instance level parameters are found in the man pages for each service,
under:

21
doc/source/system_configuration/kubernetes/gnss-and-synce-support-62004dc97f3e.rst
View File

@ -4,17 +4,18 @@
SyncE and Introduction
======================
Intel's Westport Channel NICs support a built-in GNSS module and the ability to
distribute clock via Synchronous Ethernet (SyncE). This feature allows a PPS
signal to be taken in via the GNSS module and redistributed to additional NICs
on the same host or on different hosts. This behavior is configured on |prod|
using the ``clock`` instance type in the |PTP| configuration. Many of the
configuration steps in this section are similar to those in the |PTP|
Configuration section - reference this for additional details if required.
Intel's Westport Channel and Logan Beach NICs support a built-in GNSS module
and the ability to distribute clock via Synchronous Ethernet (SyncE). This
feature allows a PPS signal to be taken in via the |GNSS| module and
redistributed to additional NICs on the same host or on different hosts.
This behavior is configured on |prod| using the ``clock`` instance type in
the |PTP| configuration. Many of the configuration steps in this section are
similar to those in the |PTP| Configuration section - reference this for
additional details if required.
.. important::
Users should reference the user guide for their Westport Channel NIC for
Reference the user guide for their Westport Channel or Logan Beach NIC for
additional information on configuring these features. The intent of this
section is to explain how these parameters can be set, rather than
describing each possible configuration.
@ -40,7 +41,7 @@ NONE
**Other requirements**
The clock type instance is a special instance used for configuring the NIC
control parameters of the Westport Channel NIC.
control parameters of the Westport Channel or Logan Beach NIC.
Configure a 'clock' instance
----------------------------
@ -108,4 +109,4 @@ PTP Parameters:
* u.fl1=output
* u.fl2=input
* synce_rclka=enabled
* synce_rclkb=enabled
* synce_rclkb=enabled

3
doc/source/system_configuration/kubernetes/instance-specific-considerations-d9d9509c79dd.rst
View File

@ -109,7 +109,8 @@ NONE
**Other requirements**
The clock type instance is a special instance used for configuring the NIC
control parameters of the Westport Channel NIC clock interface parameters.
control parameters of the Westport Channel or Logan Beach NIC clock
interface parameters.
These parameters can be applied to the interface of a clock instance |PTP|
parameters:

4
doc/source/system_configuration/kubernetes/ptp-instance-examples-517dce312f56.rst
View File

@ -324,8 +324,8 @@ clock
.. note::
These parameters are used to enable the UFL/SMA ports, recovered clock
syncE, and so-on. Refer to the user's guide for the Westport Channel NIC for
additional details on how to operate these cards.
syncE, and so-on. Refer to the user's guide for the Westport Channel or Logan
Beach NIC for additional details on how to operate these cards.
The following |PTP| parameters can be applied to the interface of a clock
instance: