Wake-up timer library to wake from deepsleep/power-down

Dependencies:   LPC1114_WakeInterruptIn

Dependents:   LPC812_Sleep_HelloWorld KL05Z_DCF77_RTC_Clock LPC1114_data_logger mBuinoBlinky ... more

Supported Targets

Please read the target specific comments below. A general small warning: If you have other interrupts enabled, and they request attention after the WakeUp interrupt is set, but before deepsleep is entered, and these take long to handle, it is possible that the WakeUp interrupt is handled before you enter deepsleep. In that case there is no interrupt anymore which should wake it from deepsleep.

Example code

// Depending on the LED connections either the LED is off the 2 seconds
// the target spends in deepsleep(), and on for the other second. Or it is inverted 
 
#include "mbed.h"
#include "WakeUp.h"
 
DigitalOut myled(LED1);
 
int main() {
    //The low-power oscillator can be quite inaccurate on some targets
    //this function calibrates it against the main clock
    WakeUp::calibrate();
   
    while(1) {
        //Set LED to zero
        myled = 0;
        
        //Set wakeup time for 2 seconds
        WakeUp::set_ms(2000);
        
        //Enter deepsleep, the program won't go beyond this point until it is woken up
        deepsleep();
  
        //Set LED for 1 second to one
        myled = 1;
        wait(1);
    }
}

Target comments

All targets use different implementations, some of these have some things that need to be taken into account. If your target is supported but not listed here, then there is nothing relevant to mention.

Core M3/M4 microcontrollers

These microcontrollers cannot wake from deepsleep while they are being debugged. Core M0s can, although their power consumption is very high while being debugged. Generally to exit debug mode you need to power cycle the microcontroller, while making sure the debugger isn't powercycled as well.

On NUCLEO boards you can for example break the connection to the target IC with a jumper, which does this. Most Freescale boards have a USB connector for the target IC (in addition to the SDA USB). If you use this one to power the board, the debugger should not get powered.

KLxx

These targets (such as the KL25z, KL05z, etc) use the same LPTMR for both WakeUp and for ticker generation. The WakeUp code is nice, and it will backup the old values when being set, and restore those after waking up, allowing you to continue using your ticker, and a ticker which was already set will continue again. However you are not allowed to set a new ticker after you already set WakeUp, since this will give clashes. Do you for whatever reason need to do it (for example you set WakeUp, and then you wake using an InteruptIn), you can disable the WakeUp timer and restore the ticker functionality by setting WakeUp for 0 seconds.

LPC11u24

This target uses the watchdog timer to generate the necesary interrupts to wake from deepsleep. The reset functionality of the timer is disabled, so you don't need to worry about that. However the library won't work if other code also uses the watchdog timer. Most likely the result is unpredictable.

STM

For STM targets the library uses the RTC of these targets. The calibration subroutine is not (yet) implemented, since it assumes that an RTC is quite accurate (which might not be true if it runs as by default on an internal RC oscillator). Currently it keeps the RTC in the default settings of the mbed code. Due to the nature of these settings the maximum time resolution this lib can achieve on those targets is, depending on if a 32kHz crystal is fitted, 3-4ms, instead of the 1ms of other targets.

Also it might not compile for your specific target even though it has an RTC. In that case send me a message (or you can also look yourself). The required interrupt vector changes place and name depending on the target, and it could be that another define needs to be added for your target.

LPC1114

The LPC1114 is special. Not in a good way special. It lacks any kind of regular low-power timer/RTC/WDT which is suitable to wake it from deepsleep mode. What the library does instead is that when the WakeUp command is called, it sets the entire main clock of the device to the watchdog oscillator (at 20kHz). Clock gating is used to disable all peripherals except one timer, this timer then is used to create a pulse on an output pin. Connected to this output pin is an external interrupt, which wakes the device, and restores the original settings.

The first thing this means is that you need an unused pin. Currently by default it is set for dp24 (P0_1), if you don't add anything this pin is used. You can remap this in your code to pins dp1 (P0_8) and dp2 (P0_9):

//Add the following global variable to any .cpp file (generally your main.cpp).
PinName WakeUpPin = dp2;  //Or dp1/dp24. If this line is not included it will default to dp24

While this pin generates a pulse, other pwm outputs on the same peripheral which are active will keep running (although very slowly).

The second, and also important part, is that you should NOT set it to immediatly start a timer and enter deepsleep after a reset. Add a wait of a few seconds (random amount) in between (or just other code). When it runs at 20kHz it will refuse to be reprogrammed by the Switch Science LPC1114 mbed board, and I can do the educated guess that ISP programming via the UART also isn't going to work. If you add a wait at the start there is no problem.

Did you ignore my advice and got your LPC1114 bricked? Don't worry (too much), I managed to unbrick all mine again. I used uVision 5, export an LPC1114 project from mbed to have correct device settings. In Project > Options for Target > Debug > Use debugger: CMSIS-DAP > Settings you can change debugger settings. Playing with these can help (I haven't found yet what is required exactly). Now from Flash you can do erase/download. This is giving errors for me. Doesn't matter, what is important is that if you do the right thing (if your code blinks an LED for example that is useful), the code will stop running. Either the uC is set in permanent reset (faint glow of LEDs connected to ground), or it just stops running. At this point you can drag an drop program it again.

The calibrate function requires dp24, regardless of which pin is set as the WakeUpPin. After calibration you can use set it to do something else, however during calibration it needs to be able to toggle.

Changes

RevisionDateWhoCommit message
24:65c04a02ad45 2 months agoSissorsAdded attach documentation default tip
23:69a0c843e4bd 3 months agoSissorsSwitched WakeUp to use the new callback system, to remove warnings during compilation.; ; Attached normal functions should still work the same. Attaching member functions is now:; WakeUp::attach(callback(&object, &Class::function));
22:49ca85e8822f 22 months agoroot@developer-sjc-cyan-compiler.local.mbed.orgAdded tag test for changeset 30845899cca2
21:30845899cca2 22 months agolabishresthaModified to support for LPC11UXX in new branch LPC11UXX test
20:68f2ee917691 23 months agoSissorsAdded L476 support (changing some names/adding some defines).
19:9d355da2770e 2015-07-01SissorsFixed for KSDK targets because Freescale couldn't agree if they called the oscillator "OSC" or "OSC0"
18:13aed323e040 2015-07-01SissorsUse for Freescale devices 32k system oscillator if available. In this mode no calibration is available: It is assumed you are using a 32kHz crystal with sufficient performance.
17:49d9e3a3e904 2015-04-22SissorsKeep backup power domain always enabled for STM since the mbed library does not like it (anymore) when I disable it again.
16:f3adba7cf7c4 2014-09-14SissorsSet KLXX code for all Freescale targets (for now).
15:b2a710aca356 2014-08-29SissorsImproved STM support (now properly support L152 (hopefully) by fixing which RTC IRQ vector it should use).
14:6bf547e1e62d 2014-07-30SissorsCalibrate on LPC1114 now restores pin function settings afterwards (previously this broke wakeups were dp24 was used).
13:fd24cec76d5a 2014-07-30SissorsLatest mbed(-src) lib does not automatically include toolchain.h on the LPC1114 anymore. So added in WakeUp code itself.
12:779d866b8a2d 2014-07-30SissorsAdded calibrate for LPC1114
11:72db657fc572 2014-07-30SissorsRewritten pin selection for LPC1114, now can be changed without modifying WakeUp code
10:c41bc9154a7c 2014-07-28SissorsAdded initial LPC11xx support (LPC1114). Might need another commit :)
9:29bdf5fed21a 2014-07-24SissorsGeneral STM support for all devices with same RTC and Alarm A
8:8d9a6ac0fba8 2014-07-24SissorsUpdated documentation
7:bb411115f814 2014-07-23SissorsAdded NUCLEO F030R8
6:815bef56e136 2014-07-12SissorsAdded K20D50M support
5:89dae784c38f 2014-02-20SissorsSupport al KLxx devices and properly use new ticker timer setups
4:ec26a6713bb9 2014-01-12SissorsAdded LPC11u24
3:2c62a668f265 2014-01-07SissorsKL46Z included
2:648712aa15b4 2013-12-07SissorsKL25 should now play nicely with mbed
1:92f4c2b52771 2013-12-05SissorsAdded KL25, doesn't play nice with mbed yet
0:fc439458a359 2013-11-23Sissorsv1.0