Skip to content

docs(linux): Add PTP support documentation for HSR and PRP offload#644

Open
danish-ti wants to merge 1 commit intoTexasInstruments:masterfrom
danish-ti:latest
Open

docs(linux): Add PTP support documentation for HSR and PRP offload#644
danish-ti wants to merge 1 commit intoTexasInstruments:masterfrom
danish-ti:latest

Conversation

@danish-ti
Copy link
Copy Markdown
Contributor

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:

  • Cloning and building linuxptp-hsr
  • Patching config files with interface names and p2p_dst_mac
  • Running ptp4l with master/slave configs
  • Verifying sync via master offset values

Copy link
Copy Markdown
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

I would almost prefer this block be moved to it's own include file considering it's the same between the two offload mechanisms.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 7, 2026

New warnings found with rstcheck:

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:3: (ERROR/3) Undefined substitution referenced: "PTP_PROTO_FULL".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:23: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:23: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:23: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:23: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:38: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/_ptp_support.rst:44: (ERROR/3) Undefined substitution referenced: "PTP_CFG_PREFIX".

@danish-ti danish-ti force-pushed the latest branch 2 times, most recently from 609c1a7 to 8767b6a Compare April 7, 2026 06:33
@danish-ti
Copy link
Copy Markdown
Contributor Author

I would almost prefer this block be moved to it's own include file considering it's the same between the two offload mechanisms.

@StaticRocket I have moved the PTP documentation to separate doc and just refering it in both HSR and PRP docs. Please review and approve.

@danish-ti danish-ti requested a review from StaticRocket April 7, 2026 06:40
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
Copy link
Copy Markdown
Member

@StaticRocket StaticRocket Apr 8, 2026

Choose a reason for hiding this comment

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

Suggested change
``[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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also, shouldn't that regex just match the key? Matching the key and the value seems unnecessary.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yes. Matching only key is enough. I will update PR with your suggestion.

@StaticRocket
Copy link
Copy Markdown
Member

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants