Sleep functions
[Platform]

Send the microcontroller to deep sleep.

Note:

This function can be a noop if not implemented by the platform.

This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined)

This function will be a noop while uVisor is in use.

This processor is setup ready for deep sleep, and sent to sleep. This mode has the same sleep features as sleep plus it powers down peripherals and clocks. All state is still maintained.

The processor can only be woken up by an external interrupt on a pin or a watchdog timer.

Note:

The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be able to access the LocalFileSystem

Definition at line 160 of file mbed_sleep.h.

Send the microcontroller to sleep.

Note:

This function can be a noop if not implemented by the platform.

This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined).

This function will be a noop while uVisor is in use.

This function will be a noop if the following conditions are met:

• The RTOS is present
• The processor turn off the Systick clock during sleep
• The target does not implement tickless mode

The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the system clock to the core is stopped until a reset or an interrupt occurs. This eliminates dynamic power used by the processor, memory systems and buses. The processor, peripheral and memory state are maintained, and the peripherals continue to work and can generate interrupts.

The processor can be woken up by any internal peripheral interrupt or external pin interrupt.

Note:

The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored. Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be able to access the LocalFileSystem

Definition at line 131 of file mbed_sleep.h.

Get the status of deep sleep allowance for a target.

Returns:

true if a target can go to deepsleep, false otherwise

Definition at line 50 of file mbed_sleep_manager.c.

Sleep manager API The sleep manager provides API to automatically select sleep mode.

There are two sleep modes:

• sleep
• deepsleep

Use locking/unlocking deepsleep for drivers that depend on features that are not allowed (=disabled) during the deepsleep. For instance, high frequency clocks.

Example:

 void driver::handler()
 {
     if (_sensor.get_event()) {
         // any event - we are finished, unlock the deepsleep
         sleep_manager_unlock_deep_sleep();
         _callback();
     }
 }

 int driver::measure(event_t event, callback_t& callback)
 {
      _callback = callback;
      sleep_manager_lock_deep_sleep();
      // start async transaction, we are waiting for an event
      return _sensor.start(event, callback);
 }

Lock the deep sleep mode

This locks the automatic deep mode selection. sleep_manager_sleep_auto() will ignore deepsleep mode if this function is invoked at least once (the internal counter is non-zero)

Use this locking mechanism for interrupt driven API that are running in the background and deepsleep could affect their functionality

The lock is a counter, can be locked up to USHRT_MAX This function is IRQ and thread safe

Definition at line 28 of file mbed_sleep_manager.c.

Enter auto selected sleep mode.

It chooses the sleep or deeepsleep modes based on the deepsleep locking counter

This function is IRQ and thread safe

Note:

If MBED_DEBUG is defined, only hal_sleep is allowed. This ensures the debugger to be active for debug modes.

Definition at line 55 of file mbed_sleep_manager.c.

Unlock the deep sleep mode.

Use unlocking in pair with sleep_manager_lock_deep_sleep().

The lock is a counter, should be equally unlocked as locked This function is IRQ and thread safe

Definition at line 39 of file mbed_sleep_manager.c.