Skip to content

Commit 42c3b4a

Browse files
committed
Incorporated the review comments
1 parent 127cd3a commit 42c3b4a

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed
Loading
Loading

docs/porting/target/tickless/tickless.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,20 @@ To support tickless mode in Mbed OS, your target needs to meet two requirements:
1818
- Support for Sleep HAL API
1919
- Support for either Low Power or Microsecond Ticker HAL API
2020

21-
To enable tickless mode for your target, add the `MBED_TICKLESS` macro in target.json > your target's section > macro options.
22-
23-
When the tickless mode is enabled, the device default SysTick mechanism overrides by the [OsTimer](../mbed-os-api-doxy/structos__timer__def.html) implementation based on either the [low power ticker](../mbed-os-api-doxy/group__hal__lp__ticker.html) or [microsecond ticker](../mbed-os-api-doxy/group__hal__us__ticker.html).
24-
25-
By default, tickless mode uses the low-power ticker (if available). If a target's low-power ticker has an excessively long wake-up time or other performance issues, make it use the microsecond ticker instead: set `tickless-from-us-ticker` to `true` in target.json > your target's section.
21+
To enable tickless mode for your target, add the `MBED_TICKLESS` macro in `target.json` of your target's section as follows:
22+
```json
23+
"macros_add": [
24+
"MBED_TICKLESS"
25+
]
26+
```
27+
28+
When tickless mode is enabled, Mbed OS's default [OsTimer](../mbed-os-api-doxy/structos__timer__def.html) based on the [low power ticker](../mbed-os-api-doxy/group__hal__lp__ticker.html) replaces SysTick. If a target's low power ticker has an excessively long wake-up time or other performance issues, make it use the [microsecond ticker](../mbed-os-api-doxy/group__hal__us__ticker.html) instead by adding the below configuration in 'target.json' of your target's section. And this configuration is not required for the target which does not have low power ticker as the default OsTimer based on the microsecond ticker.
29+
30+
```json
31+
"overrides": {
32+
"tickless-from-us-ticker": true
33+
}
34+
```
2635

2736
If tickless mode uses the microsecond ticker, the device will enter sleep rather than deep sleep, but will still avoid unnecessary tick calls.
2837

0 commit comments

Comments
 (0)