Skip to content

Commit d70fca9

Browse files
StaticRocketpraneethbajjuri
authored andcommitted
fix(ptp): use proper refs
Replace all relative links with proper refs. Some of these links were already invalid. If any of these are wrong I'll leave it to the IP owner to sort out. Signed-off-by: Randolph Sapp <[email protected]>
1 parent 03d3ea0 commit d70fca9

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

source/linux/Industrial_Protocols/HSR_PRP/_HSR_PRP_for_Linux.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ The driver source code is located under net/hsr-prp folder of the Linux
103103
source tree. To build kernel with this driver, set Kconfig option
104104
CONFIG\_HSR=y in the dotconfig or enable it from the menu.
105105

106+
.. _hsr-prp-overview-and-setup:
107+
106108
Linux HSR/PRP Driver
107109
^^^^^^^^^^^^^^^^^^^^^^^^
108110

source/linux/Industrial_Protocols/PTP/_PTP.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -135,10 +135,9 @@ clock entity.
135135
GMAC
136136
----
137137

138-
GMAC interface can be configured to run at either 100 Mbps or 1 Gbps.
139-
CPTS hardware block helps with timestamping of packets. Refer to
140-
`here <Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.html#common-platform-time-sync-cpts>`__
141-
for details.
138+
GMAC interface can be configured to run at either 100 Mbps or 1 Gbps. CPTS
139+
hardware block helps with timestamping of packets. Refer to
140+
:ref:`common-platform-time-sync-cpts` for details.
142141

143142
PRU-ICSS
144143
--------
@@ -422,11 +421,13 @@ PTP/OC in slave mode:
422421

423422
|
424423
424+
.. _redundancy-hsr-prp:
425+
425426
Redundancy (HSR/PRP)
426427
^^^^^^^^^^^^^^^^^^^^
427428

428429
To set up PTP OC over HSR/PRP redundant interface, first setup HSR/PRP interface
429-
as detailed in `HSR/PRP Linux Software <Industrial_Protocols_HSR_PRP.html#linux-software>`__.
430+
as detailed in :ref:`hsr-prp-overview-and-setup`.
430431

431432
Start PTP with the same command listed above, but using a different
432433
configuration file:
@@ -725,9 +726,10 @@ the same ICSS-PRU simultaneously.
725726

726727
PTP Ordinary Clock on GMAC
727728
--------------------------
728-
Refer to `here <Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW.html#common-platform-time-sync-cpts>`__
729-
for more details about the CPTS driver and how to run **linuxptp** over the CPSW GMAC port
730-
for providing the PTP OC functionality.
729+
730+
Refer to :ref:`common-platform-time-sync-cpts` for more details about the CPTS
731+
driver and how to run **linuxptp** over the CPSW GMAC port for providing the PTP
732+
OC functionality.
731733

732734
For example, once the AM57xx IDK is boot into Linux kernel prompt and
733735
the CPSW GMAC ports are properly configured, to run linuxptp over the
@@ -1848,8 +1850,8 @@ Procedure
18481850

18491851
The script file :ref:`setup-hsr` and clock configuration files e.g.
18501852
dut_1_hsr_oc.cfg, dut_2_hsr_oc.cfg, dut_3_hsr_oc.cfg (each identical, same as
1851-
listed in `PTP Redundancy <Industrial_Protocols_PTP.html#redundancy-hsr-prp>`__
1852-
section for HSR) will be used in the setup of the tests.
1853+
listed in :ref:`redundancy-hsr-prp` section for HSR) will be used in the setup
1854+
of the tests.
18531855

18541856
.. code-block:: bash
18551857
:caption: setup_hsr.sh

0 commit comments

Comments
 (0)