docs(linux): Add PTP support documentation for HSR and PRP offload#644
docs(linux): Add PTP support documentation for HSR and PRP offload#644danish-ti wants to merge 1 commit intoTexasInstruments:masterfrom
Conversation
StaticRocket
left a comment
There was a problem hiding this comment.
I would almost prefer this block be moved to it's own include file considering it's the same between the two offload mechanisms.
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst
Outdated
Show resolved
Hide resolved
|
New warnings found with rstcheck: |
609c1a7 to
8767b6a
Compare
@StaticRocket I have moved the PTP documentation to separate doc and just refering it in both HSR and PRP docs. Please review and approve. |
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_PRP_PTP.rst
Outdated
Show resolved
Hide resolved
| address. The config files use INI-style sections where ``[eth1]`` and ``[eth2]`` | ||
| denote the two physical interfaces. The first command appends the ``p2p_dst_mac`` | ||
| key (destination MAC for P2P delay-request messages) into the | ||
| ``[delay_mechanism P2P]`` section. The second command replaces the ``[eth1]`` and |
There was a problem hiding this comment.
| ``[delay_mechanism P2P]`` section. The second command replaces the ``[eth1]`` and | |
| ``[global]`` section just after the ``delay_mechanism`` key. The second command replaces the ``[eth1]`` and |
There was a problem hiding this comment.
Also, shouldn't that regex just match the key? Matching the key and the value seems unnecessary.
There was a problem hiding this comment.
yes. Matching only key is enough. I will update PR with your suggestion.
|
I didn't notice it earlier, but https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-formatting |
Add a new standalone page HSR_PRP_PTP.rst documenting PTP synchronization support for HSR and PRP interfaces using the linuxptp-hsr implementation (hsr_prp_v2_plus branch). The page covers: - Cloning and building linuxptp-hsr - Patching config files with interface names and p2p_dst_mac - Running ptp4l with primary/secondary configs - Verifying sync via master offset values HSR_Offload.rst and PRP_Offload.rst each get a brief PTP Support section with a cross-reference to the new page. HSR_PRP_PTP.rst is added to the toctree in Foundational_Components_Kernel_Drivers.rst. Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
Document PTP synchronization support over HSR and PRP interfaces using the linuxptp-hsr implementation (hsr_prp_v2_plus branch).
Add Prerequisites, Running PTP, and Verifying PTP Synchronization subsections to both HSR_Offload.rst and PRP_Offload.rst covering: