Skip to content

Commit 1e84cfd

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

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed
Loading

docs/porting/target/tickless/tickless.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,21 @@ 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 the tickless mode is enabled, the device's 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).
29+
30+
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 by adding the below configuration in `target.json` of your target's section.
31+
```json
32+
"overrides": {
33+
"tickless-from-us-ticker": true
34+
}
35+
```
2636

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

0 commit comments

Comments
 (0)