Skip to content
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.

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

doc: power management: Remove references to previous PM states terminology #32048

Closed
erwango opened this issue Feb 5, 2021 · 1 comment · Fixed by #32099
Closed

doc: power management: Remove references to previous PM states terminology #32048

erwango opened this issue Feb 5, 2021 · 1 comment · Fixed by #32099
Assignees
Labels
area: Documentation area: Power Management bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug

Comments

@erwango
Copy link
Member

erwango commented Feb 5, 2021

Describe the bug

Following merge of #31273
https://docs.zephyrproject.org/latest/reference/power_management/index.html was not updated.
Particularly the following terminology is not up to date anymore:

:dfn:`Active State`
   The CPU and clocks are powered on. This is the normal operating state when
   the system is running.

:dfn:`Sleep State`
   Some of the SoC clocks are gated. The CPU is stopped but does not lose
   execution context. Configuration of the peripherals is preserved.

:dfn:`Deep Sleep State`
   The SoC is power gated and loses context. Most peripherals would also be
   power gated. RAM may be selectively retained.

:dfn:`Idle Thread`
   A system thread that runs when there are no other threads ready to run.

:dfn:`Power gating`
   Power gating reduces power consumption by shutting off current to blocks of
   the integrated circuit that are not in use.

To Reproduce
See doc.

Impact
Confusion

@erwango erwango added bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug area: Documentation area: Power Management labels Feb 5, 2021
@nashif nashif added priority: high High impact/importance bug and removed priority: low Low impact/importance bug labels Feb 5, 2021
@nashif
Copy link
Member

nashif commented Feb 8, 2021

@ceolin is working on that already, lets have just 1 assignee and avoid 2 people working on the same thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation area: Power Management bug The issue is a bug, or the PR is fixing a bug priority: high High impact/importance bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants