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@166:5aab5a7997ee, 2018-04-20 (annotated)

Committer:
Anna Bridge
Date:
Fri Apr 20 11:08:29 2018 +0100
Revision:
166:5aab5a7997ee
Parent:
165:d1b4690b3f8b
Child:
169:a7c7b631e539
Updating mbed 2 version number

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