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

STM32: add information in README for SLEEP feature #14670

Merged
merged 1 commit into from
Jun 7, 2021

Conversation

jeromecoutant
Copy link
Collaborator

Summary of changes

Few high level information added in the STM32 read me file about sleep and deepsleep feature implementation.

Part of #14610

Impact of changes

Migration actions required

Documentation


Pull request type

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[x] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[] Tests / results supplied as part of this PR

Reviewers


@ciarmcom ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label May 17, 2021
@ciarmcom
Copy link
Member

@jeromecoutant, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.


ST MCUs feature several low-power modes, please check Reference Manual of each one for more details.

- MBED sleep mode is usually mapped on ST SLEEP mode:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- MBED sleep mode is usually mapped on ST SLEEP mode:
- MBED sleep mode is usually mapped to ST SLEEP mode:

- all peripherals can run and wake up the CPU when an interrupt or an event
occurs

- MBED deepsleep mode is mapped on ST STOP2 mode:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- MBED deepsleep mode is mapped on ST STOP2 mode:
- MBED deepsleep mode is mapped to ST STOP2 mode:

- the LSI and the LSE can be kept running
- RTC can remain active

Reminder: related mbed-os is described there https://os.mbed.com/docs/mbed-os/latest/apis/power-management-sleep.html
Copy link
Contributor

Choose a reason for hiding this comment

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

This is rather a note or is it a reminider?

Detailed sleep Mbed OS description https://os.mbed.com/docs/mbed-os/latest/apis/power-management-sleep.html

@jeromecoutant
Copy link
Collaborator Author

@0xc0170 Thx for the review

Copy link
Contributor

@0xc0170 0xc0170 left a comment

Choose a reason for hiding this comment

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

otherwise LGTM

Detailed sleep Mbed OS description : https://os.mbed.com/docs/mbed-os/latest/apis/power-management-sleep.html
- debug profile is disabling deepsleep
- deepsleep can also be disabled by application or drivers using sleep_manager_lock_deep_sleep()
- deep-sleep-latency value is configured to 4 by default for STM32
Copy link
Contributor

Choose a reason for hiding this comment

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

would it be worth documenting why 4 was selected here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@ciarmcom ciarmcom added the stale Stale Pull Request label May 26, 2021
@ciarmcom
Copy link
Member

This pull request has automatically been marked as stale because it has had no recent activity. , please complete review of the changes to move the PR forward. Thank you for your contributions.

@ciarmcom ciarmcom added stale Stale Pull Request and removed stale Stale Pull Request labels May 28, 2021
@jeromecoutant
Copy link
Collaborator Author

@adbridge let's merge this doc update ?

@adbridge
Copy link
Contributor

adbridge commented Jun 4, 2021

CI started

@0xc0170 0xc0170 merged commit 0675d30 into ARMmbed:master Jun 7, 2021
@mergify mergify bot removed ready for merge stale Stale Pull Request labels Jun 7, 2021
@jeromecoutant jeromecoutant deleted the PR_README_SLEEP branch June 8, 2021 11:33
@mbedmain mbedmain added release-version: 6.12.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Jun 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants