Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/platform/mbed_power_mgmt.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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