Some Doc cleanup in PM, crypto, audio and DSS by Pratham-T · Pull Request #556 · TexasInstruments/processor-sdk-doc

Pratham-T · 2025-12-05T11:47:21Z

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

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/Kernel/Kernel_Drivers/Display/DSS7.rst

Copilot · 2025-12-05T11:51:19Z

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:


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):

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

@vishalmti , @kwillis01

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

Pratham-T · 2025-12-05T11:52:05Z

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.

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst

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>

AM62DX has erroneously set CONFIG_crypto to DTHEv2. Correct that to sa2ul. Also add mcrc64. Signed-off-by: T Pratham <t-pratham@ti.com>

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>

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

Still a few vale comments

StaticRocket · 2025-12-09T17:54:21Z

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

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


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

gehariprasath · 2025-12-31T11:50:43Z

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

+
+This method of entry only supports Power button as the wake source.
+
+To use the rtc as a wake source, after enabling off mode use the


RTC in caps

gehariprasath · 2025-12-31T11:53:29Z

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

+    };
+
+Another important thing to make sure of is that you are using the proper
+u-boot. A certain u-boot is required in order to support RTC+DDR mode


Rather than "A certain u-boot", I think we can be more specific here itself about the configuration to use (which you have described below).

gehariprasath · 2025-12-31T11:53:59Z

source/linux/Foundational_Components/Power_Management/pm_rtc_ddr.rst

+
+Whether or not your board enters RTC-Only mode or RTC+DDR mode depends
+on the regulator configuration and whether or not the regulator that
+supplies the DDR is configured to remain on during suspend. This is


Pls rephrase this long sentence if possible.

Copilot AI review requested due to automatic review settings December 5, 2025 11:47

Pratham-T requested review from StaticRocket, VeeruPrudhvi, aniket-l, cshilwant, jeevantelukula, praneethbajjuri and uditkumarti as code owners December 5, 2025 11:47

github-actions bot assigned devarsht, DhruvaG2000, praneethbajjuri, r-vignesh, uditkumarti and vishalmti Dec 5, 2025

github-actions bot requested review from DhruvaG2000, devarsht, r-vignesh and vishalmti December 5, 2025 11:47

Copilot started reviewing on behalf of Pratham-T December 5, 2025 11:47 View session

Copilot finished reviewing on behalf of Pratham-T December 5, 2025 11:50

Copilot AI reviewed Dec 5, 2025

View reviewed changes

StaticRocket requested changes Dec 5, 2025

View reviewed changes

Pratham-T added 4 commits December 9, 2025 17:46

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 force-pushed the contrib branch from 36d7352 to 4e7fa2c Compare December 9, 2025 12:55

Pratham-T requested a review from gehariprasath as a code owner December 9, 2025 12:55

StaticRocket requested changes Dec 9, 2025

View reviewed changes

gehariprasath reviewed Dec 31, 2025

View reviewed changes

cshilwant added the stale PR is not updated by Author in recent times. Will be declined after 1 week label Jan 25, 2026

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


		.. code-block:: console

		$ echo 1 > /sys/kernel/debug/pm_debug/enable_off_mode


		This method of entry only supports Power button as the wake source.

		To use the rtc as a wake source, after enabling off mode use the

Conversation

Pratham-T commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Pratham-T Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

praneethbajjuri Dec 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pratham-T commented Dec 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

StaticRocket left a comment

Choose a reason for hiding this comment

Uh oh!

StaticRocket Dec 9, 2025

Choose a reason for hiding this comment

Uh oh!

gehariprasath Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

gehariprasath Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

gehariprasath Dec 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

gehariprasath Dec 31, 2025 •

edited

Loading