Skip to content

docs(linux): AM64X: Add ICSSG PRP Mode Docs #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(linux): AM64X: Add ICSSG PRP Mode Docs #348

wants to merge 2 commits into from
+369 −1

Conversation

hm-ti
Copy link

@hm-ti hm-ti commented Jul 8, 2025

Adds documentation on PRP offload mode supported by ICSSG

Siddharth-Vadapalli-at-TI
Siddharth-Vadapalli-at-TI reviewed Jul 8, 2025
View reviewed changes
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/PRP_Offload.rst Outdated
The ICSSG PRP firmware supports offloading of all above functionalities saving overhead from the driver.

.. note::
The offload of functionality hsr-fwd-offload should also be enabled for correct driver configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

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

@hm-ti, can this documentation be moved into the existing documentation for "HSR_Offload"? The file can be renamed to "HSR_PRP_Offload". It will be even better if we move the existing "HSR_Offload" documentation also into "HSR_PRP_Non_Offload" and rename it to "HSR_PRP" with different sections for Non-Offload and Offload documentation.

Please refer to the following as an example:
https://software-dl.ti.com/processor-sdk-linux/esd/docs/06_03_00_106/linux/Industrial_Protocols_HSR_PRP.html

Copy link
Contributor

@danish-ti danish-ti Jul 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@Siddharth-Vadapalli-at-TI I had asked @hm-ti to create separate doc for PRP.
HSR / PRP non offload is already present here
However, I thought having a separate doc for PRP offload will be better as the topology is very different.

Copy link
Collaborator

@Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI Jul 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@danish-ti, I don't have a strong objection to creating separate documentation. I had pointed it out based on older documentation that I had seen at:
https://software-dl.ti.com/processor-sdk-linux/esd/docs/06_03_00_106/linux/Industrial_Protocols_HSR_PRP.html
Since PRP documentation seems to contain references to HSR, it was just a suggestion to group them together.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 9, 2025

New warnings found with rstcheck:

source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:191: (ERROR/3) Error with CSV data in "csv-table" directive:

danish-ti
danish-ti approved these changes Jul 10, 2025
View reviewed changes
Copy link
Contributor

@danish-ti danish-ti left a comment

Choose a reason for hiding this comment

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

LGTM

uditkumarti
uditkumarti previously approved these changes Jul 10, 2025
View reviewed changes
@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM64X/linux/Release_Specific_Release_Notes.rst:191: (ERROR/3) Error with CSV data in "csv-table" directive:

cshilwant
cshilwant requested changes Jul 10, 2025
View reviewed changes
StaticRocket
StaticRocket requested changes Jul 10, 2025
View reviewed changes
Copy link
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.

Please address the vale comments and fix the csv table currently generating errors.

@hm-ti hm-ti requested review from StaticRocket and danish-ti July 11, 2025 09:07
StaticRocket
StaticRocket requested changes Jul 11, 2025
View reviewed changes
Copy link
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.

This probably should have been 3 commits with more reasonable information than just docs(linux): AM64X: Update docs, and that's without commenting on https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#commit-formatting

@github-actions GitHub Actions
Copy link

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:13 devices/AM62DX/linux/Release_Specific_Workarounds
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:76 linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup

StaticRocket
StaticRocket requested changes Jul 14, 2025
View reviewed changes
Copy link
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.

This should use the feat tag, not the docs tag

@github-actions GitHub Actions
Copy link

New issues found with check_toc_txt.py:

WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:7 devices/AM62DX/linux/Release_Specific_Release_Notes
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:14 devices/AM62DX/linux/Release_Specific_Workarounds
WARNING:root:Invalid slug: configs/AM62DX/AM62DX_linux_toc.txt:77 linux/How_to_Guides/Hardware_Setup_with_CCS/AM62DX_EVM_Hardware_Setup

@github-actions GitHub Actions
Copy link

New warnings found with rstcheck:

source/devices/AM62DX/index.rst:33: (SEVERE/4) Problems with "include" directive path:

@StaticRocket
Copy link
Member

StaticRocket commented Jul 15, 2025 •
edited
Loading

The commit tags need to be updated. You fixed the first one, but the second one is now wrong. I'd like to suggest:

feat(ICSSG): Add PRP mode docs for AM64X
feat(ICSSG): Update Release notes for AM64X

There are also some valid vale warnings (usage of linux instead of Linux, etc.)

@hm-ti hm-ti force-pushed the master branch 2 times, most recently from 1ae5cec to 681cc02 Compare July 16, 2025 08:53
@hm-ti
feat(ICSSG): Add PRP mode docs for AM64X
835a999 
- Adds documentation on ICSSG PRP offload mode supported by
prueth driver

Signed-off-by: Himanshu Mittal <h-mittal1@ti.com>
@hm-ti
feat(ICSSG): Update Release notes for AM64X
0b78f93 
- Issue Tracker Update containing details of ICSSG firmware
    related bugs resolved and bugs open.
- Adds new PRP feature in What's New section

Signed-off-by: Himanshu Mittal <h-mittal1@ti.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI left review comments

@cshilwant cshilwant cshilwant requested changes

@StaticRocket StaticRocket StaticRocket approved these changes

@danish-ti danish-ti danish-ti approved these changes

@uditkumarti uditkumarti uditkumarti left review comments

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

@aniket-l aniket-l Awaiting requested review from aniket-l aniket-l is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@uditkumarti uditkumarti

@Siddharth-Vadapalli-at-TI Siddharth-Vadapalli-at-TI

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@hm-ti @StaticRocket @cshilwant @uditkumarti @Siddharth-Vadapalli-at-TI @danish-ti @praneethbajjuri @devarsht @r-vignesh