Skip to content

fix(linux): Split CSI2RX documentation into platform-specific files#645

Open
Rishikesh-D wants to merge 1 commit intoTexasInstruments:masterfrom
Rishikesh-D:csi_per_platform
Open

fix(linux): Split CSI2RX documentation into platform-specific files#645
Rishikesh-D wants to merge 1 commit intoTexasInstruments:masterfrom
Rishikesh-D:csi_per_platform

Conversation

@Rishikesh-D
Copy link
Copy Markdown
Contributor

Refactor the CSI documentation to have a per platform file. This improves the maintainability and organization by separating platform-specific content from common documentation

The monolithic CSI2RX.rst file has been split into:

  • CSI2RX_common.rst: Shared introduction, architecture, driver details, and usage instructions
  • CSI2RX_AM62X.rst: AM62X-specific testing details and sensor information
  • CSI2RX_AM62PX.rst: AM62PX-specific content including V3Link support and mosaic pipelines
  • CSI2RX_AM62AX.rst: AM62AX-specific FPDLink camera support and ISP pipelines
  • CSI2RX_J721E.rst: J721E platform-specific details
  • CSI2RX_J721S2.rst: J721S2 platform-specific details
  • CSI2RX_J722S.rst: J722S platform-specific details
  • CSI2RX_J784S4.rst: J784S4 platform-specific details

Testing: A diff comparison of these files before and after refactoring showed no differences.

./build/processor-sdk-linux-AM62AX/esd/docs/11_01_07_05/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-J742S2/esd/docs/11_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-J721S2/esd/docs/11_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-J784S4/esd/docs/11_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-AM62X/esd/docs/11_02_08_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-J722S/esd/docs/11_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-J721E/esd/docs/11_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html
./build/processor-sdk-linux-AM62PX/esd/docs/11_02_08_02/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.html

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 1, 2026

New issues found with check_toc_txt.py:

WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_AM62X.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_J722S.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_J721E.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_J721S2.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_AM62AX.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_J784S4.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_AM62PX.rst
WARNING:root:File not in any toc: source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX_common.rst

Comment thread source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/CSI2RX.rst Outdated
@StaticRocket
Copy link
Copy Markdown
Member

You split everything up into nice logical sections, why would you want to merge it all back to a single page for the reader anyway?

@StaticRocket
Copy link
Copy Markdown
Member

@Rishikesh-D
Copy link
Copy Markdown
Contributor Author

Refactored further to parse per platform file. Now each platform has its own .rst file and the source/linux/Foundational_Components/Kernel/Kernel_Drivers/Camera/_CSI2RX_common.rst has the common docs.

StaticRocket
StaticRocket previously approved these changes Apr 14, 2026
@Rishikesh-D
Copy link
Copy Markdown
Contributor Author

@Yemike-Abhilash-Chandra , please review w.r.t Jacinto platforms and let me know if any changes are required.

Copy link
Copy Markdown
Collaborator

@uditkumarti uditkumarti left a comment

Choose a reason for hiding this comment

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

1/ Instead latest SDK, use exact SDK version through out series
2/ j742s2 can be merged into j784s4.rst

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

The following combinations of sensors are tested in the latest sdk.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

use SDK version instead of latest

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.

@uditkumarti , This is present in all the CSI_*.rst files.

Different platforms have different latest SDK releases. For example, the "latest" public release for AM62A is 11.01, and for AM62P it’s 12.00. I’m unsure whether to use the "latest" public SDK version available for each specific platform, or to use 12.00 across all the platforms.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sorry latest has no meaning

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.

Hi @uditkumarti , thank you for the review, I discussed with @jeevantelukula and @cshilwant , currently we don't have a variable / placeholder which will get populated with the release version in the final .html file.

So, I have mentioned the release version in the respective per platform CSI rst files directly, Please let me know if you have a different approach you'd prefer.

Thanks

Refactor the CSI documentation to have a per platform file. This improves
the  maintainability and organization by separating platform-specific
content from common documentation

 The monolithic CSI2RX.rst file has been split into:
 - CSI2RX_common.rst: Shared introduction, architecture, driver details, and usage
 instructions
 - CSI2RX_AM62X.rst: AM62X-specific testing details and sensor information
 - CSI2RX_AM62PX.rst: AM62PX-specific content including V3Link support and mosaic pipelines
 - CSI2RX_AM62AX.rst: AM62AX-specific FPDLink camera support and ISP pipelines
 - CSI2RX_J721E.rst: J721E platform-specific details
 - CSI2RX_J721S2.rst: J721S2 platform-specific details
 - CSI2RX_J722S.rst: J722S platform-specific details
 - CSI2RX_J784S4.rst: J784S4 platform-specific details

Signed-off-by: Rishikesh Donadkar <r-donadkar@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.

7 participants