Skip to content

TELCODOCS#2164: Added pin information #95044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

TELCODOCS#2164: Added pin information #95044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions modules/nw-ptp-dual-wpc-hardware-config-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,29 @@ The value that you configure depends on your specific measurements and SMA1 cabl
|`spec.profile.ptp4lConf`
|Set the value of `boundary_clock_jbod` to 1 to enable support for multiple NICs.
|====

Each value in the `spec.profile.plugins.e810.pins` list follows the `<function>` `<connector ID>` format.

Where:

`<function>`:: Specifies the pin role.

The following values are associated with the pin role:

`0`::: Disabled
`1`::: Receive (Rx) – for 1PPS IN
`2`::: Transmit (Tx) – for 1PPS OUT

`<connector ID>`:: Identifies the physical connector.

The following values are associated with the physical connector:

`1`::: `SMA1` or `U.FL1`
`2`::: `SMA2` or `U.FL2`

Examples:

`2 1`::: Enables `1PPS OUT` (Tx) on `SMA1`.
`1 1`::: Enables `1PPS IN` (Rx) on `SMA1`.

The PTP Operator passes these values to the Intel E810 hardware plugin and writes them to the sysfs pin configuration interface on each NIC.
32 changes: 30 additions & 2 deletions modules/nw-ptp-e810-hardware-configuration-reference.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,38 @@ The `SMA1` connector is bidirectional.
The `SMA2` connector is bidirectional.
|====

To configure a hardware pin on the Intel E810 NIC, run the following command:
[source,terminal]
----
export ETH=enp1s0f0
echo <function> <connector ID> > /sys/class/net/$ETH/device/ptp/*/pins/SMA1
----

Comment on lines +27 to +33
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To configure a hardware pin on the Intel E810 NIC, run the following command:
[source,terminal]
----
export ETH=enp1s0f0
echo <function> <connector ID> > /sys/class/net/$ETH/device/ptp/*/pins/SMA1
----
Pin configuration on the Intel E810 NIC can be done through the plugin `spec.profile.plugins.e810.pins` section:
pins:
<interface name>:
<Connector name>: <function> <channel number>

Where:

`<function>`:: Specifies the role of the pin.

The following values are associated with the pin role:

`0`::: Disabled
`1`::: Rx (Receive timestamping)
`2`::: Tx (Transmit timestamping)

`<connector ID>`:: Identifies the physical connector.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`<connector ID>`:: Identifies the physical connector.
`<channel number>`:: A number associated with the physical connector.


The following values are associated with the physical connector:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following values are associated with the physical connector:
The following channel numbers are associated with the physical connectors:


`1`::: `SMA1` or `U.FL1`
`2`::: `SMA2` or `U.FL2`

Examples:

`0 1`::: Disables the pin mapped to `SMA1` or `U.FL1`.
`1 2`::: Assigns the Rx function to `SMA2` or `U.FL2`.

[NOTE]
====
`SMA1` and `U.FL1` connectors share channel one.
`SMA2` and `U.FL2` connectors share channel two.
`SMA1` and `U.FL1` connectors share channel one. `SMA2` and `U.FL2` connectors share channel two.
====

Set `spec.profile.plugins.e810.ublxCmds` parameters to configure the GNSS clock in the `PtpConfig` custom resource (CR).
Expand Down