diff --git a/modules/nw-ptp-dual-wpc-hardware-config-reference.adoc b/modules/nw-ptp-dual-wpc-hardware-config-reference.adoc index 9adc4292c15f..9520cf7732ed 100644 --- a/modules/nw-ptp-dual-wpc-hardware-config-reference.adoc +++ b/modules/nw-ptp-dual-wpc-hardware-config-reference.adoc @@ -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 `` `` format. + +Where: + +``:: 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 + +``:: 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. \ No newline at end of file diff --git a/modules/nw-ptp-e810-hardware-configuration-reference.adoc b/modules/nw-ptp-e810-hardware-configuration-reference.adoc index 6102e37a0fc1..0dfc255eb050 100644 --- a/modules/nw-ptp-e810-hardware-configuration-reference.adoc +++ b/modules/nw-ptp-e810-hardware-configuration-reference.adoc @@ -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 > /sys/class/net/$ETH/device/ptp/*/pins/SMA1 +---- + +Where: + +``:: 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) + +``:: Identifies the physical connector. + +The following values are associated with the physical connector: + +`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).