mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/mbed_power_mgmt.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 165:d1b4690b3f8b 1 /** \addtogroup platform */
AnnaBridge 165:d1b4690b3f8b 2 /** @{*/
AnnaBridge 165:d1b4690b3f8b 3 /**
AnnaBridge 165:d1b4690b3f8b 4 * \defgroup platform_power_mgmt Power management functions
AnnaBridge 165:d1b4690b3f8b 5 * @{
AnnaBridge 165:d1b4690b3f8b 6 */
AnnaBridge 165:d1b4690b3f8b 7
AnnaBridge 165:d1b4690b3f8b 8 /* mbed Microcontroller Library
AnnaBridge 165:d1b4690b3f8b 9 * Copyright (c) 2006-2018 ARM Limited
AnnaBridge 172:65be27845400 10 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 165:d1b4690b3f8b 11 *
AnnaBridge 165:d1b4690b3f8b 12 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 165:d1b4690b3f8b 13 * you may not use this file except in compliance with the License.
AnnaBridge 165:d1b4690b3f8b 14 * You may obtain a copy of the License at
AnnaBridge 165:d1b4690b3f8b 15 *
AnnaBridge 165:d1b4690b3f8b 16 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 165:d1b4690b3f8b 17 *
AnnaBridge 165:d1b4690b3f8b 18 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 165:d1b4690b3f8b 19 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 165:d1b4690b3f8b 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 165:d1b4690b3f8b 21 * See the License for the specific language governing permissions and
AnnaBridge 165:d1b4690b3f8b 22 * limitations under the License.
AnnaBridge 165:d1b4690b3f8b 23 */
AnnaBridge 165:d1b4690b3f8b 24 #ifndef MBED_POWER_MGMT_H
AnnaBridge 165:d1b4690b3f8b 25 #define MBED_POWER_MGMT_H
AnnaBridge 165:d1b4690b3f8b 26
AnnaBridge 171:3a7713b1edbc 27 #include "hal/sleep_api.h"
AnnaBridge 165:d1b4690b3f8b 28 #include "mbed_toolchain.h"
Anna Bridge 169:a7c7b631e539 29 #include "hal/ticker_api.h"
AnnaBridge 165:d1b4690b3f8b 30 #include <stdbool.h>
AnnaBridge 165:d1b4690b3f8b 31
AnnaBridge 165:d1b4690b3f8b 32 #ifdef __cplusplus
AnnaBridge 165:d1b4690b3f8b 33 extern "C" {
AnnaBridge 165:d1b4690b3f8b 34 #endif
AnnaBridge 165:d1b4690b3f8b 35
AnnaBridge 171:3a7713b1edbc 36 /**
AnnaBridge 171:3a7713b1edbc 37 * @defgroup hal_sleep_manager Sleep manager API
AnnaBridge 165:d1b4690b3f8b 38 * The sleep manager provides API to automatically select sleep mode.
AnnaBridge 165:d1b4690b3f8b 39 *
AnnaBridge 165:d1b4690b3f8b 40 * There are two sleep modes:
AnnaBridge 165:d1b4690b3f8b 41 * - sleep
AnnaBridge 165:d1b4690b3f8b 42 * - deepsleep
AnnaBridge 165:d1b4690b3f8b 43 *
AnnaBridge 165:d1b4690b3f8b 44 * Use locking/unlocking deepsleep for drivers that depend on features that
AnnaBridge 165:d1b4690b3f8b 45 * are not allowed (=disabled) during the deepsleep. For instance, high frequency
AnnaBridge 165:d1b4690b3f8b 46 * clocks.
AnnaBridge 165:d1b4690b3f8b 47 *
AnnaBridge 171:3a7713b1edbc 48 * # Defined behavior
AnnaBridge 171:3a7713b1edbc 49 * * The lock is a counter
AnnaBridge 172:65be27845400 50 * * The lock can be locked up to USHRT_MAX - Verified by ::test_lock_eq_ushrt_max
AnnaBridge 172:65be27845400 51 * * The lock has to be equally unlocked as locked - Verified by ::test_lock_eq_ushrt_max
AnnaBridge 171:3a7713b1edbc 52 * * The function sleep_manager_lock_deep_sleep_internal() locks the automatic deep mode selection - Verified by ::test_lock_unlock
AnnaBridge 171:3a7713b1edbc 53 * * The function sleep_manager_unlock_deep_sleep_internal() unlocks the automatic deep mode selection - Verified by ::test_lock_unlock
AnnaBridge 171:3a7713b1edbc 54 * * The function sleep_manager_sleep_auto() chooses the sleep or deep sleep modes based on the lock - Verified by ::test_sleep_auto
AnnaBridge 171:3a7713b1edbc 55 * * The function sleep_manager_lock_deep_sleep_internal() is IRQ and thread safe - Verified by ::sleep_manager_multithread_test and ::sleep_manager_irq_test
AnnaBridge 171:3a7713b1edbc 56 * * The function sleep_manager_unlock_deep_sleep_internal() is IRQ and thread safe - Verified by ::sleep_manager_multithread_test and ::sleep_manager_irq_test
AnnaBridge 171:3a7713b1edbc 57 * * The function sleep_manager_sleep_auto() is IRQ and thread safe
AnnaBridge 171:3a7713b1edbc 58 *
AnnaBridge 165:d1b4690b3f8b 59 * Example:
AnnaBridge 165:d1b4690b3f8b 60 * @code
AnnaBridge 165:d1b4690b3f8b 61 *
AnnaBridge 165:d1b4690b3f8b 62 * void driver::handler()
AnnaBridge 165:d1b4690b3f8b 63 * {
AnnaBridge 165:d1b4690b3f8b 64 * if (_sensor.get_event()) {
AnnaBridge 165:d1b4690b3f8b 65 * // any event - we are finished, unlock the deepsleep
AnnaBridge 165:d1b4690b3f8b 66 * sleep_manager_unlock_deep_sleep();
AnnaBridge 165:d1b4690b3f8b 67 * _callback();
AnnaBridge 165:d1b4690b3f8b 68 * }
AnnaBridge 165:d1b4690b3f8b 69 * }
AnnaBridge 165:d1b4690b3f8b 70 *
AnnaBridge 165:d1b4690b3f8b 71 * int driver::measure(event_t event, callback_t& callback)
AnnaBridge 165:d1b4690b3f8b 72 * {
AnnaBridge 165:d1b4690b3f8b 73 * _callback = callback;
AnnaBridge 165:d1b4690b3f8b 74 * sleep_manager_lock_deep_sleep();
AnnaBridge 165:d1b4690b3f8b 75 * // start async transaction, we are waiting for an event
AnnaBridge 165:d1b4690b3f8b 76 * return _sensor.start(event, callback);
AnnaBridge 165:d1b4690b3f8b 77 * }
AnnaBridge 165:d1b4690b3f8b 78 * @endcode
AnnaBridge 171:3a7713b1edbc 79 * @{
AnnaBridge 165:d1b4690b3f8b 80 */
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /**
AnnaBridge 171:3a7713b1edbc 83 * @defgroup hal_sleep_manager_tests Sleep manager API tests
AnnaBridge 171:3a7713b1edbc 84 * Tests to validate the proper implementation of the sleep manager
AnnaBridge 171:3a7713b1edbc 85 *
AnnaBridge 171:3a7713b1edbc 86 * To run the sleep manager hal tests use the command:
AnnaBridge 171:3a7713b1edbc 87 *
AnnaBridge 171:3a7713b1edbc 88 * mbed test -t <toolchain> -m <target> -n tests-mbed_hal-sleep_manager*
AnnaBridge 171:3a7713b1edbc 89 *
AnnaBridge 171:3a7713b1edbc 90 */
AnnaBridge 171:3a7713b1edbc 91
AnnaBridge 165:d1b4690b3f8b 92 #ifdef MBED_SLEEP_TRACING_ENABLED
AnnaBridge 165:d1b4690b3f8b 93
AnnaBridge 165:d1b4690b3f8b 94 void sleep_tracker_lock(const char *const filename, int line);
AnnaBridge 165:d1b4690b3f8b 95 void sleep_tracker_unlock(const char *const filename, int line);
AnnaBridge 165:d1b4690b3f8b 96
AnnaBridge 165:d1b4690b3f8b 97 #define sleep_manager_lock_deep_sleep() \
AnnaBridge 165:d1b4690b3f8b 98 do \
AnnaBridge 165:d1b4690b3f8b 99 { \
AnnaBridge 165:d1b4690b3f8b 100 sleep_manager_lock_deep_sleep_internal(); \
AnnaBridge 165:d1b4690b3f8b 101 sleep_tracker_lock(MBED_FILENAME, __LINE__); \
AnnaBridge 165:d1b4690b3f8b 102 } while (0);
AnnaBridge 165:d1b4690b3f8b 103
AnnaBridge 165:d1b4690b3f8b 104 #define sleep_manager_unlock_deep_sleep() \
AnnaBridge 165:d1b4690b3f8b 105 do \
AnnaBridge 165:d1b4690b3f8b 106 { \
AnnaBridge 165:d1b4690b3f8b 107 sleep_manager_unlock_deep_sleep_internal(); \
AnnaBridge 165:d1b4690b3f8b 108 sleep_tracker_unlock(MBED_FILENAME, __LINE__); \
AnnaBridge 165:d1b4690b3f8b 109 } while (0);
AnnaBridge 165:d1b4690b3f8b 110
AnnaBridge 165:d1b4690b3f8b 111 #else
AnnaBridge 165:d1b4690b3f8b 112
AnnaBridge 165:d1b4690b3f8b 113 #define sleep_manager_lock_deep_sleep() \
AnnaBridge 165:d1b4690b3f8b 114 sleep_manager_lock_deep_sleep_internal()
AnnaBridge 165:d1b4690b3f8b 115
AnnaBridge 165:d1b4690b3f8b 116 #define sleep_manager_unlock_deep_sleep() \
AnnaBridge 165:d1b4690b3f8b 117 sleep_manager_unlock_deep_sleep_internal()
AnnaBridge 165:d1b4690b3f8b 118
AnnaBridge 165:d1b4690b3f8b 119 #endif // MBED_SLEEP_TRACING_ENABLED
AnnaBridge 165:d1b4690b3f8b 120
AnnaBridge 165:d1b4690b3f8b 121 /** Lock the deep sleep mode
AnnaBridge 165:d1b4690b3f8b 122 *
AnnaBridge 165:d1b4690b3f8b 123 * This locks the automatic deep mode selection.
AnnaBridge 165:d1b4690b3f8b 124 * sleep_manager_sleep_auto() will ignore deepsleep mode if
AnnaBridge 165:d1b4690b3f8b 125 * this function is invoked at least once (the internal counter is non-zero)
AnnaBridge 165:d1b4690b3f8b 126 *
AnnaBridge 165:d1b4690b3f8b 127 * Use this locking mechanism for interrupt driven API that are
AnnaBridge 165:d1b4690b3f8b 128 * running in the background and deepsleep could affect their functionality
AnnaBridge 165:d1b4690b3f8b 129 *
AnnaBridge 165:d1b4690b3f8b 130 * The lock is a counter, can be locked up to USHRT_MAX
AnnaBridge 165:d1b4690b3f8b 131 * This function is IRQ and thread safe
AnnaBridge 165:d1b4690b3f8b 132 */
AnnaBridge 165:d1b4690b3f8b 133 void sleep_manager_lock_deep_sleep_internal(void);
AnnaBridge 165:d1b4690b3f8b 134
AnnaBridge 165:d1b4690b3f8b 135 /** Unlock the deep sleep mode
AnnaBridge 165:d1b4690b3f8b 136 *
AnnaBridge 165:d1b4690b3f8b 137 * Use unlocking in pair with sleep_manager_lock_deep_sleep().
AnnaBridge 165:d1b4690b3f8b 138 *
AnnaBridge 165:d1b4690b3f8b 139 * The lock is a counter, should be equally unlocked as locked
AnnaBridge 165:d1b4690b3f8b 140 * This function is IRQ and thread safe
AnnaBridge 165:d1b4690b3f8b 141 */
AnnaBridge 165:d1b4690b3f8b 142 void sleep_manager_unlock_deep_sleep_internal(void);
AnnaBridge 165:d1b4690b3f8b 143
AnnaBridge 165:d1b4690b3f8b 144 /** Get the status of deep sleep allowance for a target
AnnaBridge 165:d1b4690b3f8b 145 *
AnnaBridge 165:d1b4690b3f8b 146 * @return true if a target can go to deepsleep, false otherwise
AnnaBridge 165:d1b4690b3f8b 147 */
AnnaBridge 165:d1b4690b3f8b 148 bool sleep_manager_can_deep_sleep(void);
AnnaBridge 165:d1b4690b3f8b 149
AnnaBridge 171:3a7713b1edbc 150 /** Check if the target can deep sleep within a period of time
AnnaBridge 171:3a7713b1edbc 151 *
AnnaBridge 171:3a7713b1edbc 152 * This function in intended for use in testing. The amount
AnnaBridge 171:3a7713b1edbc 153 * of time this functions waits for deeps sleep to be available
AnnaBridge 171:3a7713b1edbc 154 * is currently 2ms. This may change in the future depending
AnnaBridge 171:3a7713b1edbc 155 * on testing requirements.
AnnaBridge 171:3a7713b1edbc 156 *
AnnaBridge 171:3a7713b1edbc 157 * @return true if a target can go to deepsleep, false otherwise
AnnaBridge 171:3a7713b1edbc 158 */
AnnaBridge 171:3a7713b1edbc 159 bool sleep_manager_can_deep_sleep_test_check(void);
AnnaBridge 171:3a7713b1edbc 160
AnnaBridge 171:3a7713b1edbc 161 /** Enter auto selected sleep mode. It chooses the sleep or deepsleep modes based
AnnaBridge 165:d1b4690b3f8b 162 * on the deepsleep locking counter
AnnaBridge 165:d1b4690b3f8b 163 *
AnnaBridge 165:d1b4690b3f8b 164 * This function is IRQ and thread safe
AnnaBridge 165:d1b4690b3f8b 165 *
AnnaBridge 165:d1b4690b3f8b 166 * @note
AnnaBridge 165:d1b4690b3f8b 167 * If MBED_DEBUG is defined, only hal_sleep is allowed. This ensures the debugger
AnnaBridge 165:d1b4690b3f8b 168 * to be active for debug modes.
AnnaBridge 165:d1b4690b3f8b 169 *
AnnaBridge 165:d1b4690b3f8b 170 */
AnnaBridge 165:d1b4690b3f8b 171 void sleep_manager_sleep_auto(void);
AnnaBridge 165:d1b4690b3f8b 172
AnnaBridge 165:d1b4690b3f8b 173 /** Send the microcontroller to sleep
AnnaBridge 165:d1b4690b3f8b 174 *
AnnaBridge 165:d1b4690b3f8b 175 * @note This function can be a noop if not implemented by the platform.
AnnaBridge 165:d1b4690b3f8b 176 * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined).
AnnaBridge 165:d1b4690b3f8b 177 * @note This function will be a noop if the following conditions are met:
AnnaBridge 165:d1b4690b3f8b 178 * - The RTOS is present
AnnaBridge 165:d1b4690b3f8b 179 * - The processor turn off the Systick clock during sleep
AnnaBridge 165:d1b4690b3f8b 180 * - The target does not implement tickless mode
AnnaBridge 165:d1b4690b3f8b 181 *
AnnaBridge 165:d1b4690b3f8b 182 * The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
AnnaBridge 165:d1b4690b3f8b 183 * system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
AnnaBridge 165:d1b4690b3f8b 184 * dynamic power used by the processor, memory systems and buses. The processor, peripheral and
AnnaBridge 165:d1b4690b3f8b 185 * memory state are maintained, and the peripherals continue to work and can generate interrupts.
AnnaBridge 165:d1b4690b3f8b 186 *
AnnaBridge 165:d1b4690b3f8b 187 * The processor can be woken up by any internal peripheral interrupt or external pin interrupt.
AnnaBridge 165:d1b4690b3f8b 188 *
AnnaBridge 165:d1b4690b3f8b 189 * @note
AnnaBridge 165:d1b4690b3f8b 190 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
AnnaBridge 165:d1b4690b3f8b 191 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
AnnaBridge 165:d1b4690b3f8b 192 * able to access the LocalFileSystem
AnnaBridge 165:d1b4690b3f8b 193 */
AnnaBridge 165:d1b4690b3f8b 194 static inline void sleep(void)
AnnaBridge 165:d1b4690b3f8b 195 {
AnnaBridge 165:d1b4690b3f8b 196 #if DEVICE_SLEEP
AnnaBridge 171:3a7713b1edbc 197 #if (MBED_CONF_RTOS_PRESENT == 0) || (DEVICE_SYSTICK_CLK_OFF_DURING_SLEEP == 0) || defined(MBED_TICKLESS)
AnnaBridge 165:d1b4690b3f8b 198 sleep_manager_sleep_auto();
AnnaBridge 171:3a7713b1edbc 199 #endif /* (MBED_CONF_RTOS_PRESENT == 0) || (DEVICE_SYSTICK_CLK_OFF_DURING_SLEEP == 0) || defined(MBED_TICKLESS) */
AnnaBridge 165:d1b4690b3f8b 200 #endif /* DEVICE_SLEEP */
AnnaBridge 165:d1b4690b3f8b 201 }
AnnaBridge 165:d1b4690b3f8b 202
AnnaBridge 165:d1b4690b3f8b 203 /** Send the microcontroller to deep sleep
AnnaBridge 165:d1b4690b3f8b 204 *
AnnaBridge 165:d1b4690b3f8b 205 * @deprecated
AnnaBridge 170:e95d10626187 206 * Do not use this function. Applications should use sleep() API which puts the system in deepsleep mode if supported.
AnnaBridge 165:d1b4690b3f8b 207 *
AnnaBridge 165:d1b4690b3f8b 208 * @note This function can be a noop if not implemented by the platform.
AnnaBridge 165:d1b4690b3f8b 209 * @note This function will be a noop in debug mode (debug build profile when MBED_DEBUG is defined)
AnnaBridge 165:d1b4690b3f8b 210 *
AnnaBridge 165:d1b4690b3f8b 211 * This processor is setup ready for deep sleep, and sent to sleep. This mode
AnnaBridge 165:d1b4690b3f8b 212 * has the same sleep features as sleep plus it powers down peripherals and clocks. All state
AnnaBridge 165:d1b4690b3f8b 213 * is still maintained.
AnnaBridge 165:d1b4690b3f8b 214 *
AnnaBridge 165:d1b4690b3f8b 215 * The processor can only be woken up by an external interrupt on a pin or a watchdog timer.
AnnaBridge 165:d1b4690b3f8b 216 *
AnnaBridge 165:d1b4690b3f8b 217 * @note
AnnaBridge 165:d1b4690b3f8b 218 * The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
AnnaBridge 165:d1b4690b3f8b 219 * Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
AnnaBridge 165:d1b4690b3f8b 220 * able to access the LocalFileSystem
AnnaBridge 165:d1b4690b3f8b 221 */
AnnaBridge 165:d1b4690b3f8b 222
AnnaBridge 165:d1b4690b3f8b 223 MBED_DEPRECATED_SINCE("mbed-os-5.6", "One entry point for an application, use sleep()")
AnnaBridge 165:d1b4690b3f8b 224 static inline void deepsleep(void)
AnnaBridge 165:d1b4690b3f8b 225 {
AnnaBridge 165:d1b4690b3f8b 226 #if DEVICE_SLEEP
AnnaBridge 165:d1b4690b3f8b 227 sleep_manager_sleep_auto();
AnnaBridge 165:d1b4690b3f8b 228 #endif /* DEVICE_SLEEP */
AnnaBridge 165:d1b4690b3f8b 229 }
AnnaBridge 170:e95d10626187 230
Anna Bridge 169:a7c7b631e539 231 /** Provides the time spent in sleep mode since boot.
Anna Bridge 169:a7c7b631e539 232 *
Anna Bridge 169:a7c7b631e539 233 * @return Time spent in sleep
Anna Bridge 169:a7c7b631e539 234 * @note Works only if platform supports LP ticker.
Anna Bridge 169:a7c7b631e539 235 */
Anna Bridge 169:a7c7b631e539 236 us_timestamp_t mbed_time_sleep(void);
Anna Bridge 169:a7c7b631e539 237
Anna Bridge 169:a7c7b631e539 238 /** Provides the time spent in deep sleep mode since boot.
Anna Bridge 169:a7c7b631e539 239 *
Anna Bridge 169:a7c7b631e539 240 * @return Time spent in deep sleep
Anna Bridge 169:a7c7b631e539 241 * @note Works only if platform supports LP ticker.
Anna Bridge 169:a7c7b631e539 242 */
Anna Bridge 169:a7c7b631e539 243 us_timestamp_t mbed_time_deepsleep(void);
Anna Bridge 169:a7c7b631e539 244
Anna Bridge 169:a7c7b631e539 245 /** Provides the time spent in idle mode since boot.
Anna Bridge 169:a7c7b631e539 246 *
Anna Bridge 169:a7c7b631e539 247 * @return Idle thread time.
Anna Bridge 169:a7c7b631e539 248 * @note Works only if platform supports LP ticker.
Anna Bridge 169:a7c7b631e539 249 */
Anna Bridge 169:a7c7b631e539 250 us_timestamp_t mbed_time_idle(void);
Anna Bridge 169:a7c7b631e539 251
Anna Bridge 169:a7c7b631e539 252 /** Provides the time since the system is up i.e. boot.
Anna Bridge 169:a7c7b631e539 253 *
Anna Bridge 169:a7c7b631e539 254 * @return System uptime.
Anna Bridge 169:a7c7b631e539 255 * @note Works only if platform supports LP ticker.
Anna Bridge 169:a7c7b631e539 256 */
Anna Bridge 169:a7c7b631e539 257 us_timestamp_t mbed_uptime(void);
AnnaBridge 165:d1b4690b3f8b 258
AnnaBridge 171:3a7713b1edbc 259 /** @}*/
AnnaBridge 171:3a7713b1edbc 260
AnnaBridge 171:3a7713b1edbc 261 /** Resets the processor and most of the sub-system
AnnaBridge 171:3a7713b1edbc 262 *
AnnaBridge 171:3a7713b1edbc 263 * @note Does not affect the debug sub-system
AnnaBridge 171:3a7713b1edbc 264 */
AnnaBridge 172:65be27845400 265 MBED_NORETURN static inline void system_reset(void)
AnnaBridge 171:3a7713b1edbc 266 {
AnnaBridge 171:3a7713b1edbc 267 NVIC_SystemReset();
AnnaBridge 171:3a7713b1edbc 268 }
AnnaBridge 171:3a7713b1edbc 269
AnnaBridge 165:d1b4690b3f8b 270 #ifdef __cplusplus
AnnaBridge 165:d1b4690b3f8b 271 }
AnnaBridge 165:d1b4690b3f8b 272 #endif
AnnaBridge 165:d1b4690b3f8b 273
AnnaBridge 165:d1b4690b3f8b 274 #endif
AnnaBridge 165:d1b4690b3f8b 275
AnnaBridge 165:d1b4690b3f8b 276 /** @}*/
AnnaBridge 165:d1b4690b3f8b 277 /** @}*/