Skip to content

Some Doc cleanup in PM, crypto, audio and DSS #556

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
Pratham-T wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Some Doc cleanup in PM, crypto, audio and DSS #556

Pratham-T wants to merge 4 commits into from

Conversation

@Pratham-T
Copy link
Contributor

@Pratham-T Pratham-T commented Dec 5, 2025

This pull request contains minor cleanups (mostly found from build warnings), summarised below:

Power Management Documentation and Configuration:

  • Restore the erroneously purged documentation file pm_rtc_ddr.rst describing RTC-Only and RTC+DDR modes for AM437x.
  • Updated the AM437X Linux table of contents to include this file.

AM62D Configuration Updates:

  • Changed the cryptography engine for AM62DX from DTHEv2 to sa2ul and added mcrc64 in the Linux configuration.

Documentation Improvements:

Audio Documentation:

  • Updated explicit target names in the audio driver documentation to remove duplicate target name warnings.

Display Documentation:

  • Fixed whitespaces and a typo.
  • Reformatted a note to use ..note :: directive to better align with documentation style.

Copilot AI review requested due to automatic review settings December 5, 2025 11:47
Copilot AI reviewed Dec 5, 2025
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request performs documentation cleanup and configuration corrections across Power Management, cryptography, audio, and display subsystems. The changes address build warnings from duplicate target names, restore erroneously deleted documentation, correct hardware configuration, and improve documentation formatting.

Key changes:

  • Restored PM documentation for AM437x RTC-Only and RTC+DDR modes
  • Updated AM62DX crypto configuration from DTHEv2 to sa2ul, aligning with AM62 family standards
  • Fixed duplicate target name warnings in audio driver documentation
  • Improved DSS7 documentation formatting with proper note directive syntax

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst Restored previously deleted documentation for AM437x RTC power modes
configs/AM62DX/AM62DX_linux_config.txt Updated crypto engine from DTHEv2 to sa2ul and added mcrc64 support, aligning with AM62 family configuration
configs/AM437X/AM437X_linux_toc.txt Added pm_rtc_ddr.rst to table of contents
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst Updated target names (kernel-config-9→10→11, user-space-9→10→11) to eliminate duplicate warnings
source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst Fixed whitespace, changed inline note to proper note directive, and removed extra :: syntax

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst
$ echo 1 > /sys/kernel/debug/pm_debug/enable_off_mode

With off-mode enabled, a command to enter DeepSleep0 will now enter
RTC-Only mode:
Copy link

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

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

This text appears to be incorrect. Under the "RTC+DDR Mode" section, it states that "a command to enter DeepSleep0 will now enter RTC-Only mode", but based on the context and section heading, it should describe entering RTC+DDR mode. The distinction between RTC-Only and RTC+DDR modes is explained later (lines 49-53) as depending on regulator configuration, but the text here should clarify that with proper regulator configuration, this enters RTC+DDR mode.

Suggested change
RTC-Only mode:
either RTC-Only mode or RTC+DDR mode, depending on the regulator configuration (see below):

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@Pratham-T Pratham-T Dec 9, 2025

Choose a reason for hiding this comment

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

Need someone from PM to verify whether this change makes sense or not.

Copy link
Collaborator

@praneethbajjuri praneethbajjuri Dec 10, 2025

Choose a reason for hiding this comment

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

@vishalmti , @kwillis01

@Pratham-T
Copy link
Contributor Author

Pratham-T commented Dec 5, 2025

Had synced locally with @DhruvaG2000 that the pm_rtc_ddr.rst was indeed erroneously removed. I have simply restored the file from git history. So I was expecting Vale to report some warnings as the file is old.

StaticRocket
StaticRocket requested changes Dec 5, 2025
View reviewed changes
@Pratham-T
fix(linux): pm: restore rtc_ddr doc page
778e8a1 
Commit f1723aa ("Power Management: Move under Foundational_Components")
moved the Power Management docs under a new header and updated the paths
in only K3 devices.

Then, during commit 7918014 ("fix(configs): Cleanup SITARA's toc tree")
these were cleaned in the toc trees of legacy devices. But it misses
correctly renaming the pm_rtc_ddr file in AM437X. This is the only SoC
which is using this page. As a result, now this file shows up as an
unreachable file.

So, commit 5904b7a ("fix(unreachable): purge all unreachable files")
removes this file.

Restore the pm_rtc_ddr doc and correctly add it in AM437X's toc tree.
This also rectifies some build warnings as this file is still being
referenced in other AM437X docs.

Signed-off-by: T Pratham <t-pratham@ti.com>
@Pratham-T
fix(configs): am62d: correct the crypto config values
d43051b 
AM62DX has erroneously set CONFIG_crypto to DTHEv2. Correct that to
sa2ul. Also add mcrc64.

Signed-off-by: T Pratham <t-pratham@ti.com>
@Pratham-T
fix(linux): audio: remove duplicate target names
9765171 
Build complains of duplicate explicit target names. Target names should
be unique. Also, names are not needed for rubrics unless they are
referenced somewhere else. These duplicates are not referenced anywhere.
Remove repeated target names in audio doc.

Signed-off-by: T Pratham <t-pratham@ti.com>
@Pratham-T
fix(linux): display: Correct formatting issues and typos
4e7fa2c 
This commit fixes the following formatting issues in DSS7 docs, which
were caught from build and AI warnings:

- An extra colon at the end of line
- Adding a new line after end of list
- Indentation at a note. While here corecting indentation, also change
  the `**note**` to `..note ::` directive.
- Correcting typo paritioning to partitioning.

Signed-off-by: T Pratham <t-pratham@ti.com>
StaticRocket
StaticRocket requested changes Dec 9, 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.

Still a few vale comments

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

.. code-block:: console
$ echo 1 > /sys/kernel/debug/pm_debug/enable_off_mode
Copy link
Member

@StaticRocket StaticRocket Dec 9, 2025

Choose a reason for hiding this comment

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

https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#indentation-and-whitespace

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@StaticRocket StaticRocket StaticRocket requested changes

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

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

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

@aniket-l aniket-l Awaiting requested review from aniket-l

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

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

@devarsht devarsht Awaiting requested review from devarsht

@DhruvaG2000 DhruvaG2000 Awaiting requested review from DhruvaG2000

@r-vignesh r-vignesh Awaiting requested review from r-vignesh

@vishalmti vishalmti Awaiting requested review from vishalmti

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

Requested changes must be addressed to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@DhruvaG2000 DhruvaG2000

@uditkumarti uditkumarti

@vishalmti vishalmti

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@Pratham-T @praneethbajjuri @StaticRocket @devarsht @r-vignesh @DhruvaG2000 @uditkumarti @vishalmti