mbed official / mbed

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.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

platform/mbed_sleep.h@160:5571c4ff569f, 2018-01-17 (annotated)

Committer:
Anna Bridge
Date:
Wed Jan 17 16:13:02 2018 +0000
Revision:
160:5571c4ff569f
Parent:
158:1c57384330a6
Child:
163:e59c8e839560
mbed library. Release version 158

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4 /**
AnnaBridge 158:1c57384330a6 5 * \defgroup platform_sleep Sleep functions
AnnaBridge 158:1c57384330a6 6 * @{
AnnaBridge 158:1c57384330a6 7 */
AnnaBridge 158:1c57384330a6 8
AnnaBridge 156:ff21514d8981 9 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 10 * Copyright (c) 2006-2017 ARM Limited
AnnaBridge 156:ff21514d8981 11 *
AnnaBridge 156:ff21514d8981 12 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 13 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 14 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 15 *
AnnaBridge 156:ff21514d8981 16 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 17 *
AnnaBridge 156:ff21514d8981 18 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 19 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 21 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 22 * limitations under the License.
AnnaBridge 156:ff21514d8981 23 */
AnnaBridge 156:ff21514d8981 24 #ifndef MBED_SLEEP_H
AnnaBridge 156:ff21514d8981 25 #define MBED_SLEEP_H
AnnaBridge 156:ff21514d8981 26
AnnaBridge 156:ff21514d8981 27 #include "sleep_api.h"
AnnaBridge 156:ff21514d8981 28 #include "mbed_toolchain.h"
AnnaBridge 156:ff21514d8981 29 #include <stdbool.h>
AnnaBridge 156:ff21514d8981 30
AnnaBridge 156:ff21514d8981 31 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 32 extern "C" {
AnnaBridge 156:ff21514d8981 33 #endif
AnnaBridge 156:ff21514d8981 34
AnnaBridge 156:ff21514d8981 35 /** Sleep manager API
AnnaBridge 156:ff21514d8981 36 * The sleep manager provides API to automatically select sleep mode.
AnnaBridge 156:ff21514d8981 37 *
AnnaBridge 156:ff21514d8981 38 * There are two sleep modes:
AnnaBridge 156:ff21514d8981 39 * - sleep
AnnaBridge 156:ff21514d8981 40 * - deepsleep
AnnaBridge 156:ff21514d8981 41 *
AnnaBridge 156:ff21514d8981 42 * Use locking/unlocking deepsleep for drivers that depend on features that
AnnaBridge 156:ff21514d8981 43 * are not allowed (=disabled) during the deepsleep. For instance, high frequency
AnnaBridge 156:ff21514d8981 44 * clocks.
AnnaBridge 156:ff21514d8981 45 *
AnnaBridge 156:ff21514d8981 46 * Example:
AnnaBridge 156:ff21514d8981 47 * @code
AnnaBridge 156:ff21514d8981 48 *
AnnaBridge 156:ff21514d8981 49 * void driver::handler()
AnnaBridge 156:ff21514d8981 50 * {
AnnaBridge 156:ff21514d8981 51 * if (_sensor.get_event()) {
AnnaBridge 156:ff21514d8981 52 * // any event - we are finished, unlock the deepsleep
AnnaBridge 156:ff21514d8981 53 * sleep_manager_unlock_deep_sleep();
AnnaBridge 156:ff21514d8981 54 * _callback();
AnnaBridge 156:ff21514d8981 55 * }
AnnaBridge 156:ff21514d8981 56 * }
AnnaBridge 156:ff21514d8981 57 *
AnnaBridge 156:ff21514d8981 58 * int driver::measure(event_t event, callback_t& callback)
AnnaBridge 156:ff21514d8981 59 * {
AnnaBridge 156:ff21514d8981 60 * _callback = callback;
AnnaBridge 156:ff21514d8981 61 * sleep_manager_lock_deep_sleep();
AnnaBridge 156:ff21514d8981 62 * // start async transaction, we are waiting for an event
AnnaBridge 156:ff21514d8981 63 * return _sensor.start(event, callback);
AnnaBridge 156:ff21514d8981 64 * }
AnnaBridge 156:ff21514d8981 65 * @endcode
AnnaBridge 156:ff21514d8981 66 */
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 /** Lock the deep sleep mode
AnnaBridge 156:ff21514d8981 69 *
AnnaBridge 156:ff21514d8981 70 * This locks the automatic deep mode selection.
AnnaBridge 156:ff21514d8981 71 * sleep_manager_sleep_auto() will ignore deepsleep mode if
AnnaBridge 156:ff21514d8981 72 * this function is invoked at least once (the internal counter is non-zero)
AnnaBridge 156:ff21514d8981 73 *
AnnaBridge 156:ff21514d8981 74 * Use this locking mechanism for interrupt driven API that are
AnnaBridge 156:ff21514d8981 75 * running in the background and deepsleep could affect their functionality
AnnaBridge 156:ff21514d8981 76 *
AnnaBridge 156:ff21514d8981 77 * The lock is a counter, can be locked up to USHRT_MAX
AnnaBridge 156:ff21514d8981 78 * This function is IRQ and thread safe
AnnaBridge 156:ff21514d8981 79 */
AnnaBridge 156:ff21514d8981 80 void sleep_manager_lock_deep_sleep(void);
AnnaBridge 156:ff21514d8981 81
AnnaBridge 156:ff21514d8981 82 /** Unlock the deep sleep mode
AnnaBridge 156:ff21514d8981 83 *
AnnaBridge 156:ff21514d8981 84 * Use unlocking in pair with sleep_manager_lock_deep_sleep().
AnnaBridge 156:ff21514d8981 85 *
AnnaBridge 156:ff21514d8981 86 * The lock is a counter, should be equally unlocked as locked
AnnaBridge 156:ff21514d8981 87 * This function is IRQ and thread safe
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 void sleep_manager_unlock_deep_sleep(void);
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Get the status of deep sleep allowance for a target
AnnaBridge 156:ff21514d8981 92 *
AnnaBridge 156:ff21514d8981 93 * @return true if a target can go to deepsleep, false otherwise
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95 bool sleep_manager_can_deep_sleep(void);
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /** Enter auto selected sleep mode. It chooses the sleep or deeepsleep modes based
AnnaBridge 156:ff21514d8981 98 * on the deepsleep locking counter
AnnaBridge 156:ff21514d8981 99 *
AnnaBridge 156:ff21514d8981 100 * This function is IRQ and thread safe
AnnaBridge 156:ff21514d8981 101 *
AnnaBridge 156:ff21514d8981 102 * @note
AnnaBridge 156:ff21514d8981 103 * If MBED_DEBUG is defined, only hal_sleep is allowed. This ensures the debugger
AnnaBridge 156:ff21514d8981 104 * to be active for debug modes.
AnnaBridge 156:ff21514d8981 105 *
AnnaBridge 156:ff21514d8981 106 */
AnnaBridge 156:ff21514d8981 107 void sleep_manager_sleep_auto(void);
AnnaBridge 156:ff21514d8981 108
AnnaBridge 156:ff21514d8981 109 /** Send the microcontroller to sleep
AnnaBridge 156:ff21514d8981 110 *
AnnaBridge 156:ff21514d8981 111 * @note This function can be a noop if not implemented by the platform.
AnnaBridge 156:ff21514d8981 112 * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined).
AnnaBridge 156:ff21514d8981 113 * @note This function will be a noop while uVisor is in use.
AnnaBridge 156:ff21514d8981 114 * @note This function will be a noop if the following conditions are met:
AnnaBridge 156:ff21514d8981 115 * - The RTOS is present
AnnaBridge 156:ff21514d8981 116 * - The processor turn off the Systick clock during sleep
AnnaBridge 156:ff21514d8981 117 * - The target does not implement tickless mode
AnnaBridge 156:ff21514d8981 118 *
AnnaBridge 156:ff21514d8981 119 * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
AnnaBridge 156:ff21514d8981 120 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
AnnaBridge 156:ff21514d8981 121 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
AnnaBridge 156:ff21514d8981 122 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
AnnaBridge 156:ff21514d8981 125 *
AnnaBridge 156:ff21514d8981 126 * @note
AnnaBridge 156:ff21514d8981 127 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
AnnaBridge 156:ff21514d8981 128 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
AnnaBridge 156:ff21514d8981 129 * able to access the LocalFileSystem
AnnaBridge 156:ff21514d8981 130 */
AnnaBridge 156:ff21514d8981 131 __INLINE static void sleep(void)
AnnaBridge 156:ff21514d8981 132 {
AnnaBridge 156:ff21514d8981 133 #if !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED))
AnnaBridge 156:ff21514d8981 134 #if DEVICE_SLEEP
AnnaBridge 156:ff21514d8981 135 #if (MBED_CONF_RTOS_PRESENT == 0) || (DEVICE_STCLK_OFF_DURING_SLEEP == 0) || defined(MBED_TICKLESS)
AnnaBridge 156:ff21514d8981 136 sleep_manager_sleep_auto();
AnnaBridge 156:ff21514d8981 137 #endif /* (MBED_CONF_RTOS_PRESENT == 0) || (DEVICE_STCLK_OFF_DURING_SLEEP == 0) || defined(MBED_TICKLESS) */
AnnaBridge 156:ff21514d8981 138 #endif /* DEVICE_SLEEP */
AnnaBridge 156:ff21514d8981 139 #endif /* !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) */
AnnaBridge 156:ff21514d8981 140 }
AnnaBridge 156:ff21514d8981 141
AnnaBridge 156:ff21514d8981 142 /** Send the microcontroller to deep sleep
AnnaBridge 156:ff21514d8981 143 *
AnnaBridge 156:ff21514d8981 144 * @note This function can be a noop if not implemented by the platform.
AnnaBridge 156:ff21514d8981 145 * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined)
AnnaBridge 156:ff21514d8981 146 * @note This function will be a noop while uVisor is in use.
AnnaBridge 156:ff21514d8981 147 *
AnnaBridge 156:ff21514d8981 148 * This processor is setup ready for deep sleep, and sent to sleep. This mode
AnnaBridge 156:ff21514d8981 149 * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
AnnaBridge 156:ff21514d8981 150 * is still maintained.
AnnaBridge 156:ff21514d8981 151 *
AnnaBridge 156:ff21514d8981 152 * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
AnnaBridge 156:ff21514d8981 153 *
AnnaBridge 156:ff21514d8981 154 * @note
AnnaBridge 156:ff21514d8981 155 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
AnnaBridge 156:ff21514d8981 156 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
AnnaBridge 156:ff21514d8981 157 * able to access the LocalFileSystem
AnnaBridge 156:ff21514d8981 158 */
AnnaBridge 156:ff21514d8981 159
AnnaBridge 156:ff21514d8981 160 MBED_DEPRECATED_SINCE("mbed-os-5.6", "One entry point for an application, use sleep()")
AnnaBridge 156:ff21514d8981 161 __INLINE static void deepsleep(void)
AnnaBridge 156:ff21514d8981 162 {
AnnaBridge 156:ff21514d8981 163 #if !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED))
AnnaBridge 156:ff21514d8981 164 #if DEVICE_SLEEP
AnnaBridge 156:ff21514d8981 165 sleep_manager_sleep_auto();
AnnaBridge 156:ff21514d8981 166 #endif /* DEVICE_SLEEP */
AnnaBridge 156:ff21514d8981 167 #endif /* !(defined(FEATURE_UVISOR) && defined(TARGET_UVISOR_SUPPORTED)) */
AnnaBridge 156:ff21514d8981 168 }
AnnaBridge 156:ff21514d8981 169
AnnaBridge 156:ff21514d8981 170 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 171 }
AnnaBridge 156:ff21514d8981 172 #endif
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174 #endif
AnnaBridge 156:ff21514d8981 175
AnnaBridge 156:ff21514d8981 176 /** @}*/
AnnaBridge 158:1c57384330a6 177 /** @}*/