Fix XDP documentation to a unified location for ICSSG and CPSW#642
Open
MeghanaMalladiTI wants to merge 2 commits into
Open
Fix XDP documentation to a unified location for ICSSG and CPSW#642MeghanaMalladiTI wants to merge 2 commits into
MeghanaMalladiTI wants to merge 2 commits into
Conversation
MeghanaMalladiTI
requested review from
StaticRocket,
VeeruPrudhvi,
cshilwant,
gehariprasath,
jeevantelukula,
praneethbajjuri and
uditkumarti
as code owners
github-actions
Bot
assigned
devarsht,
gehariprasath,
praneethbajjuri,
r-vignesh,
Siddharth-Vadapalli-at-TI and
uditkumarti
Contributor
Author
|
@danish-ti and @daolin can you please review this PR |
dao-qiu
suggested changes
Mar 24, 2026
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
0e1fd27 to
c38b907
Compare
StaticRocket
requested changes
Apr 6, 2026
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
c38b907 to
eedbe25
Compare
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
eedbe25 to
5480f52
Compare
StaticRocket
requested changes
Apr 21, 2026
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
5480f52 to
5ca55f7
Compare
|
New warnings found with rstcheck: |
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
2 times, most recently
from
61e0e52 to
bf8615a
Compare
StaticRocket
reviewed
May 4, 2026
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
bf8615a to
7433a5e
Compare
StaticRocket
approved these changes
May 7, 2026
StaticRocket
requested changes
May 7, 2026
Member
StaticRocket
left a comment
StaticRocket
left a comment
There was a problem hiding this comment.
Ah, section depth still looks weird.
https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#headings--sections
…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>
Contributor
Author
Ahh, I used claude to address this commit last time when you pointed it out. Should have verified the changes without blindly pushing the changes :) |
MeghanaMalladiTI
force-pushed
the
xdp-doc-fixes
branch
from
7433a5e to
b51b552
Compare
StaticRocket
approved these changes
May 18, 2026
Collaborator
|
@danish-ti , @dao-qiu please review. |
dao-qiu
reviewed
May 26, 2026
| * - rxdrop | ||
| - 322 | ||
| - 491 | ||
| - 845 |
There was a problem hiding this comment.
I didn't extensively test this but on some latest test with all AM6x platforms and all configurations but I found that on AM62Px tests on SDK 11.2 the actual kps rate was was much less.
For documentation purposes I can approve this for now but later I might create JIRA if I indeed see kps rate is poor on latest SDK
There was a problem hiding this comment.
Update: A couple addition points to address before approving
- Can the specific XDP application and options used to obtain these performance numbers be added? For example, if for txonly benchmark "xdpsock -i eth0 -q0 -t -x --tx-dmac ff:ff:ff:ff:ff:ff -s64 -N -z" was used then that should be indicated in the docs
- Are these performance numbers the same between CPSW and PRU-ICSSG Ethernet? If not, then there should be a separate section for CPSW and another section for PRU-ICSSG Ethernet.
- If xdpsock was used to obtain these performance numbers, I think some documentation on xdpsock should be included in the documentation here otherwise the benchmarks should be done with xdp-tools since that already has a section in the documentation here (I see that xdp-tools here is the new utility tool to use so if that is the case, it would be inconsistent to show performance numbers using xdpsock)
- If xdpsock is used to obtain the performance numbers, then xdpsock utility tool should also be built into the SDK release so customers can also evaluate easily on their systems
dao-qiu
reviewed
May 26, 2026
dao-qiu
left a comment
dao-qiu
left a comment
There was a problem hiding this comment.
Please see my comment on XDP zero copy benchmark:
I didn't extensively test this but on some latest test with all AM6x platforms and all configurations but I found that on AM62Px tests on SDK 11.2 the actual kps rate was was much less.
For documentation purposes I can approve this for now but later I might create JIRA if I indeed see kps rate is poor on latest SDK
dao-qiu
suggested changes
Jun 5, 2026
| * - rxdrop | ||
| - 322 | ||
| - 491 | ||
| - 845 |
There was a problem hiding this comment.
Update: A couple addition points to address before approving
- Can the specific XDP application and options used to obtain these performance numbers be added? For example, if for txonly benchmark "xdpsock -i eth0 -q0 -t -x --tx-dmac ff:ff:ff:ff:ff:ff -s64 -N -z" was used then that should be indicated in the docs
- Are these performance numbers the same between CPSW and PRU-ICSSG Ethernet? If not, then there should be a separate section for CPSW and another section for PRU-ICSSG Ethernet.
- If xdpsock was used to obtain these performance numbers, I think some documentation on xdpsock should be included in the documentation here otherwise the benchmarks should be done with xdp-tools since that already has a section in the documentation here (I see that xdp-tools here is the new utility tool to use so if that is the case, it would be inconsistent to show performance numbers using xdpsock)
- If xdpsock is used to obtain the performance numbers, then xdpsock utility tool should also be built into the SDK release so customers can also evaluate easily on their systems
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add new centralized XDP documentation at Kernel/Kernel_Drivers/Network/XDP.rst for CPSW and ICSSG