Skip to content

Fix XDP documentation to a unified location for ICSSG and CPSW#642

Open
MeghanaMalladiTI wants to merge 2 commits intoTexasInstruments:masterfrom
MeghanaMalladiTI:xdp-doc-fixes
Open

Fix XDP documentation to a unified location for ICSSG and CPSW#642
MeghanaMalladiTI wants to merge 2 commits intoTexasInstruments:masterfrom
MeghanaMalladiTI:xdp-doc-fixes

Conversation

@MeghanaMalladiTI
Copy link
Copy Markdown
Contributor

Add new centralized XDP documentation at Kernel/Kernel_Drivers/Network/XDP.rst for CPSW and ICSSG

@MeghanaMalladiTI
Copy link
Copy Markdown
Contributor Author

@danish-ti and @daolin can you please review this PR

Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_XDP.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/XDP.rst Outdated
Comment thread source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_XDP.rst Outdated
MeghanaMalladiTI and others added 2 commits April 21, 2026 14:54
…CSSG and CPSW

- Add new centralized XDP documentation at
  Kernel/Kernel_Drivers/Network/XDP.rst
- Add kernel_xdp reference label that can be used throughout the docs
- Update PRU_ICSSG_XDP.rst to redirect to the consolidated XDP docs
- Update features supported in PRU_ICSSG_Ethernet.rst
- Update CPSW-Ethernet.rst to reference kernel_xdp instead of
  pru_icssg_xdp
- Add XDP.rst to AM64X device-specific table of contents
- Add XDP.rst to main Kernel Drivers toctree

The new XDP documentation covers:
- XDP introduction and concepts
- Use cases and kernel configuration
- AF_XDP sockets and zero-copy mode
- Testing with xdp-tools (xdp-bench, xdp-trafficgen)
- Performance comparison for CPSW and ICSSG drivers

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Meghana Malladi <m-malladi@ti.com>
Add XDP documentation support to the following SoC platforms by
including Network/XDP.rst in their device-specific table of contents:

- AM62AX (am62axx_sk-fs)
- AM62PX (am62pxx_sk-fs)
- AM62X (am62xx_sk-fs)
- J7200 (j7200-evm)
- J721E (j721e-idk-gw)
- J722S (j722s_evm-fs)

Note: AM64X (am64xx-evm, am64xx-hsevm) already has XDP support from
the initial commit.

This ensures that users of these platforms can access the consolidated
XDP documentation covering Native XDP, Generic XDP, and Zero-copy modes.

Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
Signed-off-by: Meghana Malladi <m-malladi@ti.com>
Comment on lines +3 to 6
===
XDP
===

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.

==================

The `xdp-tools <https://github.com/xdp-project/xdp-tools>`__ package provides
utility tools for testing XDP and AF_XDP such as `xdp-bench`, `xdp-trafficgen` etc.
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.

Suggested change
utility tools for testing XDP and AF_XDP such as `xdp-bench`, `xdp-trafficgen` etc.
tools for testing XDP and AF_XDP such as ``xdp-bench``, ``xdp-trafficgen`` etc.

or

Suggested change
utility tools for testing XDP and AF_XDP such as `xdp-bench`, `xdp-trafficgen` etc.
tools for testing XDP and AF_XDP such as :command:`xdp-bench`, :command:`xdp-trafficgen` etc.

utility tools for testing XDP and AF_XDP such as `xdp-bench`, `xdp-trafficgen` etc.

TI SDK packages the latest version of ``xdp-tools`` utilities and provides it as part of the SDK.
This allows users to easily test XDP functionality on EVM using these tools.
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.

Suggested change
This allows users to easily test XDP functionality on EVM using these tools.

Redundant, considering the paragraph above.

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.

9 participants