Skip to content

PM: Introduce docs for s2idle #562

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

PM: Introduce docs for s2idle #562

DhruvaG2000 wants to merge 6 commits into from
+313 −0

Conversation

@DhruvaG2000
Copy link
Collaborator

@DhruvaG2000 DhruvaG2000 commented Dec 8, 2025

Document all about s2idle and PSCI and how the whole stack helps us in selecting between low power modes on the TI AM62L

@DhruvaG2000 DhruvaG2000 changed the title feat(linux): Add s2idle docs [WIP][DNM] Add s2idle docs Dec 8, 2025
@github-actions
Copy link

github-actions bot commented Dec 8, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst:25: (ERROR/3) Unexpected indentation.

cshilwant
cshilwant reviewed Dec 8, 2025
View reviewed changes
@DhruvaG2000
Copy link
Collaborator Author

DhruvaG2000 commented Dec 9, 2025

@cshilwant , and rest I'll mark the PR ready for review once it has undergone LPM team internal review. Till then requesting you to hold off reviews.
This is going to be a major documentation update for AM62L PM story hence might take some time to get reviews and complete.

Thanks!

kwillis01
kwillis01 suggested changes Dec 9, 2025
View reviewed changes
@github-actions
Copy link

github-actions bot commented Dec 15, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst:48: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst:29: (ERROR/3) Error parsing content block for the "list-table" directive: two-level bullet list expected, but row 4 does not contain a second-level bullet list.

@DhruvaG2000 DhruvaG2000 force-pushed the s2idle_doc branch 2 times, most recently from c7f9288 to 4a0b798 Compare December 23, 2025 13:14
@github-actions
Copy link

github-actions bot commented Dec 23, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst:302: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst:283: (ERROR/3) Error parsing content block for the "list-table" directive: two-level bullet list expected, but row 4 does not contain a second-level bullet list.

kwillis01
kwillis01 suggested changes Dec 29, 2025
View reviewed changes
Copy link
Contributor

@kwillis01 kwillis01 left a comment

Choose a reason for hiding this comment

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

Besides the execution level things, everything else looks good to me! Good work on adding all of this, it's very infomative

@DhruvaG2000 DhruvaG2000 changed the title [WIP][DNM] Add s2idle docs PM: Introduce docs for s2idle Dec 30, 2025
@DhruvaG2000 DhruvaG2000 marked this pull request as ready for review January 2, 2026 04:34
ti-scaria
ti-scaria reviewed Jan 2, 2026
View reviewed changes
kwillis01
kwillis01 approved these changes Jan 5, 2026
View reviewed changes
Copy link
Contributor

@kwillis01 kwillis01 left a comment

Choose a reason for hiding this comment

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

LGTM, just some small wording nits.

@DhruvaG2000 DhruvaG2000 requested a review from ti-scaria January 6, 2026 05:41
@DhruvaG2000
feat(linux): Add s2idle docs
ab9546d 
Introduce the concept of s2idle and how we use it for mode
selection

Signed-off-by: Dhruva Gole <[email protected]>
@DhruvaG2000 DhruvaG2000 requested a review from cshilwant January 6, 2026 10:46
StaticRocket
StaticRocket requested changes Jan 6, 2026
View reviewed changes
source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst

The coordination in OSI mode follows a specific "Last Man Standing" sequence. The OS tracks the state of all cores in a topology node (e.g., a cluster).

.. code-block:: text
Copy link
Member

@StaticRocket StaticRocket Jan 6, 2026

Choose a reason for hiding this comment

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

Just a heads up, we can inject graphviz script with an additional extension if you would prefer to use that over ascii diagrams.

Copy link
Collaborator Author

@DhruvaG2000 DhruvaG2000 Jan 8, 2026

Choose a reason for hiding this comment

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

oh nice, let me check it out

Copy link
Member

@StaticRocket StaticRocket Jan 8, 2026

Choose a reason for hiding this comment

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

Official docs are here: https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html

source/linux/Foundational_Components/Power_Management/pm_psci_s2idle.rst
Comment on lines +263 to +265
**********************************
S2Idle vs Deep Sleep (mem)
**********************************
Copy link
Member

@StaticRocket StaticRocket Jan 6, 2026

Choose a reason for hiding this comment

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

Title overrun

Copy link
Collaborator Author

@DhruvaG2000 DhruvaG2000 Jan 8, 2026

Choose a reason for hiding this comment

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

fixing, thanks

DhruvaG2000 and others added 5 commits January 8, 2026 14:03
@DhruvaG2000 @StaticRocket
Update backticks in source/linux/Foundational_Components/Power_Manage…
4c473e6 
…ment/pm_psci_s2idle.rst

Co-authored-by: Randolph Sapp <[email protected]>
Signed-off-by: Dhruva Gole <[email protected]>
@DhruvaG2000 @StaticRocket
Update source/linux/Foundational_Components/Power_Management/pm_psci_…
004f456 
…s2idle.rst

Co-authored-by: Randolph Sapp <[email protected]>
Signed-off-by: Dhruva Gole <[email protected]>
@DhruvaG2000 @StaticRocket
Update source/linux/Foundational_Components/Power_Management/pm_psci_…
52d7b75 
…s2idle.rst

Co-authored-by: Randolph Sapp <[email protected]>
Signed-off-by: Dhruva Gole <[email protected]>
@DhruvaG2000 @StaticRocket
Update source/linux/Foundational_Components/Power_Management/pm_psci_…
6d733dc 
…s2idle.rst

Co-authored-by: Randolph Sapp <[email protected]>
Signed-off-by: Dhruva Gole <[email protected]>
@DhruvaG2000 @StaticRocket
Update source/linux/Foundational_Components/Power_Management/pm_psci_…
c666292 
…s2idle.rst

Co-authored-by: Randolph Sapp <[email protected]>
Signed-off-by: Dhruva Gole <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StaticRocket StaticRocket StaticRocket requested changes

@devarsht devarsht Awaiting requested review from devarsht

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

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

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

@vishalmti vishalmti Awaiting requested review from vishalmti

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

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

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

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

+2 more reviewers

@kwillis01 kwillis01 kwillis01 approved these changes

@ti-scaria ti-scaria ti-scaria approved these changes

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@gehariprasath gehariprasath

@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.