Nuvoton / Mbed OS NuMaker-mbed-tickless-example

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

README.md@16:ed2c228cbc9c, 2020-02-21 (annotated)

Committer:
ccli8
Date:
Fri Feb 21 11:19:30 2020 +0800
Revision:
16:ed2c228cbc9c
Parent:
14:83b73695da8f
Child:
20:759aab916d47
Update to mbed-os 5.15.1 and accompanying modifications



1.  Remove OS_IDLE_THREAD_STACK_SIZE because mbed-os has has reasonable default value.

2.  Configure tickless-from-us-ticker to false. It is needed to run tickless mode with lp_ticker instead of us_ticker for wake-up.

3.  Disable WDT wake-up when Mbed OS watchog API is enabled.

4.  Fix deprecated API.

5.  Update readme.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ccli8 1:eb1da9d36e12 1 # Example for tickless support on Nuvoton targets
ccli8 1:eb1da9d36e12 2
ccli8 1:eb1da9d36e12 3 This is an example to demonstrate [tickless](https://en.wikipedia.org/wiki/Tickless_kernel) support on
ccli8 1:eb1da9d36e12 4 Nuvoton Mbed-enabled boards.
ccli8 1:eb1da9d36e12 5 With tickless support, user program would enter **Idle** mode (shallow sleep) or **Power-down** mode (deep sleep)
ccli8 1:eb1da9d36e12 6 automatically when CPU is idle.
ccli8 1:eb1da9d36e12 7
ccli8 1:eb1da9d36e12 8 ## Supported platforms
ccli8 16:ed2c228cbc9c 9
ccli8 16:ed2c228cbc9c 10 - [NuMaker-PFM-NANO130](https://os.mbed.com/platforms/NuMaker-PFM-NANO130/)
ccli8 14:83b73695da8f 11 - [NuMaker-PFM-NUC472](https://os.mbed.com/platforms/Nuvoton-NUC472/)
ccli8 14:83b73695da8f 12 - [NuMaker-PFM-M453](https://os.mbed.com/platforms/Nuvoton-M453/)
ccli8 14:83b73695da8f 13 - [NuMaker-PFM-M487](https://os.mbed.com/platforms/NuMaker-PFM-M487/)
ccli8 1:eb1da9d36e12 14
ccli8 1:eb1da9d36e12 15 ## Supported wake-up source
ccli8 1:eb1da9d36e12 16 - Button(s)
ccli8 1:eb1da9d36e12 17 - lp_ticker (internal with tickless)
ccli8 1:eb1da9d36e12 18 - WDT timeout
ccli8 1:eb1da9d36e12 19 - RTC alarm
ccli8 1:eb1da9d36e12 20 - UART CTS state change (TODO)
ccli8 1:eb1da9d36e12 21 - I2C address match (TODO)
ccli8 1:eb1da9d36e12 22
ccli8 14:83b73695da8f 23 ## Choose idle handler
ccli8 14:83b73695da8f 24 Application user can choose to use Mbed OS internal idle handler or customize its own one.
ccli8 16:ed2c228cbc9c 25 1. To use Mbed OS internal idle handler, ensure the `MBED_TICKLESS` macro is defined and `tickless-from-us-ticker` is configured to false in `mbed_app.json`.
ccli8 14:83b73695da8f 26
ccli8 16:ed2c228cbc9c 27 ```json
ccli8 14:83b73695da8f 28 "target_overrides": {
ccli8 16:ed2c228cbc9c 29 ......
ccli8 14:83b73695da8f 30 "NUMAKER_PFM_NUC472": {
ccli8 16:ed2c228cbc9c 31 "target.macros_add": ["MBED_TICKLESS"],
ccli8 16:ed2c228cbc9c 32 "target.tickless-from-us-ticker": false,
ccli8 16:ed2c228cbc9c 33 ......
ccli8 16:ed2c228cbc9c 34 ```
ccli8 16:ed2c228cbc9c 35
ccli8 16:ed2c228cbc9c 36 **Note**: To enable tickless on existent project, just define `MBED_TICKLESS` and configure `tickless-from-us-ticker` to false as above.
ccli8 16:ed2c228cbc9c 37
ccli8 16:ed2c228cbc9c 38 1. To customize idle handler, ensure the `MBED_TICKLESS` macro is not defined in `mbed_app.json`.
ccli8 16:ed2c228cbc9c 39 This gives flexibility for providing platform-dependent idle handler.
ccli8 16:ed2c228cbc9c 40 The `idle_hdlr` in `main.cpp` is a trivial example.
ccli8 14:83b73695da8f 41
ccli8 1:eb1da9d36e12 42 ## Execution
ccli8 1:eb1da9d36e12 43 To run this tickless example, target board must run with no ICE connected.
ccli8 1:eb1da9d36e12 44 With ICE connected, system will enter **Idle** mode (shallow sleep) rather than **Power-down** mode (deep sleep)
ccli8 16:ed2c228cbc9c 45 even though `CLK_PowerDown()` is called.
ccli8 1:eb1da9d36e12 46
ccli8 16:ed2c228cbc9c 47 **Note:** With old Nu-Link1 firmware version, ICE is unexpected connected in MASS mode. Update to the latest Nu-Link firmware version to fix the issue.
ccli8 1:eb1da9d36e12 48
ccli8 16:ed2c228cbc9c 49 ### Terminal output
ccli8 16:ed2c228cbc9c 50 With your terminal program configured with 115200/8-N-1, you would see output with:
ccli8 1:eb1da9d36e12 51 <pre>
ccli8 1:eb1da9d36e12 52 I am going to shallow/deep sleep
ccli8 1:eb1da9d36e12 53 Wake up by WDT timeout from <b>deep sleep</b>
ccli8 1:eb1da9d36e12 54
ccli8 1:eb1da9d36e12 55 I am going to shallow/deep sleep
ccli8 1:eb1da9d36e12 56 Wake up by <b>Unidentified</b> from <b>deep sleep</b>
ccli8 1:eb1da9d36e12 57
ccli8 1:eb1da9d36e12 58 I am going to shallow/deep sleep
ccli8 1:eb1da9d36e12 59 Wake up by Button2 from <b>deep sleep</b>
ccli8 1:eb1da9d36e12 60
ccli8 1:eb1da9d36e12 61 I am going to shallow/deep sleep
ccli8 1:eb1da9d36e12 62 Wake up by RTC alarm from <b>deep sleep</b>
ccli8 1:eb1da9d36e12 63
ccli8 1:eb1da9d36e12 64 I am going to shallow/deep sleep
ccli8 1:eb1da9d36e12 65 Wake up by Button1 from <b>deep sleep</b>
ccli8 1:eb1da9d36e12 66 </pre>
ccli8 1:eb1da9d36e12 67
ccli8 1:eb1da9d36e12 68 1. If you see `shallow sleep` rather than `deep sleep`, you just enter **Idle** mode (shallow sleep) rather than
ccli8 1:eb1da9d36e12 69 **Power-down** mode (deep sleep). And you need to check your environment.
ccli8 1:eb1da9d36e12 70 1. If you see `Unidentified`, it means chip is waken up from **Power-down** mode but its wake-up source is unidentified.
ccli8 1:eb1da9d36e12 71 Usually it is `lp_ticker` which is internal with the tickless mechanism.
ccli8 1:eb1da9d36e12 72
ccli8 16:ed2c228cbc9c 73 ## Reference
ccli8 1:eb1da9d36e12 74
ccli8 16:ed2c228cbc9c 75 - [Tickless kernel](https://en.wikipedia.org/wiki/Tickless_kernel)
ccli8 16:ed2c228cbc9c 76 - [Mbed tickless](https://os.mbed.com/docs/mbed-os/v5.15/porting/tickless.html)