-
Notifications
You must be signed in to change notification settings - Fork 178
Use template for sleep PG #390
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,52 @@ | ||
### Sleep and deep sleep | ||
### Sleep | ||
|
||
Mbed OS defines two sleep modes for HAL: | ||
<span class="warnings">**Warning:** We are changing the Sleep HAL API in an upcoming release of Mbed OS. You can find details on how it may affect you in the [Implementing the Sleep API](#Implementing-the-Sleep-API) section. | ||
|
||
- Sleep. | ||
- Deep sleep. | ||
Implement Sleep HAL API to enable your device to go into a low power state when not being actively used. | ||
|
||
Each target should document in their implementation: | ||
#### Assumptions | ||
|
||
- The target's mode description for each mode (how the target's mode maps to the Mbed OS sleep modes). | ||
- Wake-up latency for each mode. | ||
- Wake-up sources for each mode. | ||
##### Defined behavior | ||
|
||
#### Sleep | ||
There are two power saving modes available in Mbed OS: | ||
|
||
The core system clock is disabled, both the low and high precision clocks are enabled and RAM is retained. | ||
###### Sleep | ||
|
||
1. Wake-up sources - any interrupt source can wake up the MCU. | ||
1. Latency - can wake up within 10 us. | ||
The core system clock is disabled, both the low and high frequency clocks can be used and RAM is retained. | ||
|
||
#### Deep sleep | ||
1. Wake-up sources - any interrupt must wake up the MCU. | ||
1. Latency - MCU must wake up within 10 us. | ||
|
||
The core system clock is disabled. The low precision clocks are enabled, and RAM is retained. | ||
###### Deep sleep | ||
|
||
1. Wake-up sources - RTC, low power ticker and GPIO can wake up the MCU. | ||
1. Latency - can wake up within 10 ms. | ||
The core system clock is disabled. Only the low frequency clocks can be enabled and RAM is retained. | ||
|
||
The deep sleep latency (10 ms) is the higher limit of the boards we support. Most of targets have wake-up latency for deep sleep within a few microseconds, but often, reinitializing clocks and other configurations require additional time to restore previous state. | ||
1. Wake-up sources - either RTC, low power ticker or GPIO must wake up the MCU. | ||
1. Latency - MCU must wake up within 10 ms. | ||
|
||
#### Dependencies | ||
|
||
None. | ||
|
||
#### Implementing the Sleep API | ||
|
||
There are two functions that the target needs to implement to support sleep, Their prototypes are in [hal/sleep_api.h](/docs/v5.7/mbed-os-api-doxy/sleep__api_8h_source.html): | ||
We are working on the new HAL Sleep API, which will replace current version in an upcoming release of Mbed OS. You will need to implement the Sleep API in both variants. Firstly you need to implement the current API, you can find it on master branch: | ||
|
||
- Sleep. | ||
[](https://os-doc-builder.test.mbed.com/docs/v5.7/mbed-os-api-doxy/sleep__api_8h_source.html) | ||
|
||
```c++ | ||
void hal_sleep(void); | ||
``` | ||
To make sure your platform is ready for the upcoming changes, you will need to implement the future API and submit it in a separate pull request against `feature-hal-spec-sleep` branch. You can find the API and specification for the new Sleep API in the following header file: | ||
|
||
- Deep sleep. | ||
[](https://github.com/ARMmbed/mbed-os/blob/feature-hal-spec-sleep/hal/sleep_api.h) | ||
|
||
To enable sleep support in Mbed OS, you need to add the `SLEEP` label in the `device_has` option of the target's section in the `targets.json` file. | ||
|
||
```c++ | ||
void hal_deepsleep(void); | ||
#### Testing | ||
|
||
The Mbed OS HAL provides a set of conformance tests for Sleep. You can use these tests to validate the correctness of your implementation. To run the Sleep HAL tests use the following command: | ||
``` | ||
mbed test -t <toolchain> -m <target> -n "tests-mbed_hal-sleep*" | ||
``` | ||
|
||
To enable sleep support in Mbed OS, you need to add the `SLEEP` label in the `device_has` option of the target's section in the `targets.json` file. | ||
You can read more about the test cases: | ||
|
||
[](https://github.com/ARMmbed/mbed-os/blob/feature-hal-spec-sleep/TESTS/mbed_hal/sleep/sleep_api_tests.h) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't find this in the feature branch Doxygen.