mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/mbed_sleep_manager.c@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /* mbed Microcontroller Library
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2017 ARM Limited
AnnaBridge 189:f392fc9709a3 3 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 189:f392fc9709a3 6 * you may not use this file except in compliance with the License.
AnnaBridge 189:f392fc9709a3 7 * You may obtain a copy of the License at
AnnaBridge 189:f392fc9709a3 8 *
AnnaBridge 189:f392fc9709a3 9 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 189:f392fc9709a3 12 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 189:f392fc9709a3 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 189:f392fc9709a3 14 * See the License for the specific language governing permissions and
AnnaBridge 189:f392fc9709a3 15 * limitations under the License.
AnnaBridge 189:f392fc9709a3 16 */
AnnaBridge 189:f392fc9709a3 17
AnnaBridge 189:f392fc9709a3 18 #include "mbed_power_mgmt.h"
AnnaBridge 189:f392fc9709a3 19 #include "mbed_interface.h"
AnnaBridge 189:f392fc9709a3 20 #include "mbed_critical.h"
AnnaBridge 189:f392fc9709a3 21 #include "mbed_assert.h"
AnnaBridge 189:f392fc9709a3 22 #include "mbed_error.h"
AnnaBridge 189:f392fc9709a3 23 #include "mbed_stats.h"
AnnaBridge 189:f392fc9709a3 24
AnnaBridge 189:f392fc9709a3 25 #include "hal/us_ticker_api.h"
AnnaBridge 189:f392fc9709a3 26 #include "hal/lp_ticker_api.h"
AnnaBridge 189:f392fc9709a3 27
AnnaBridge 189:f392fc9709a3 28 #include <limits.h>
AnnaBridge 189:f392fc9709a3 29 #include <stdio.h>
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #if DEVICE_SLEEP
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 // deep sleep locking counter. A target is allowed to deep sleep if counter == 0
AnnaBridge 189:f392fc9709a3 34 static uint16_t deep_sleep_lock = 0U;
AnnaBridge 189:f392fc9709a3 35 static us_timestamp_t sleep_time = 0;
AnnaBridge 189:f392fc9709a3 36 static us_timestamp_t deep_sleep_time = 0;
AnnaBridge 189:f392fc9709a3 37
AnnaBridge 189:f392fc9709a3 38 #if defined(MBED_CPU_STATS_ENABLED) && DEVICE_LPTICKER
AnnaBridge 189:f392fc9709a3 39 static ticker_data_t *sleep_ticker = NULL;
AnnaBridge 189:f392fc9709a3 40 #endif
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 static inline us_timestamp_t read_us(void)
AnnaBridge 189:f392fc9709a3 43 {
AnnaBridge 189:f392fc9709a3 44 #if defined(MBED_CPU_STATS_ENABLED) && DEVICE_LPTICKER
AnnaBridge 189:f392fc9709a3 45 if (NULL == sleep_ticker) {
AnnaBridge 189:f392fc9709a3 46 sleep_ticker = (ticker_data_t *)get_lp_ticker_data();
AnnaBridge 189:f392fc9709a3 47 }
AnnaBridge 189:f392fc9709a3 48 return ticker_read_us(sleep_ticker);
AnnaBridge 189:f392fc9709a3 49 #else
AnnaBridge 189:f392fc9709a3 50 return 0;
AnnaBridge 189:f392fc9709a3 51 #endif
AnnaBridge 189:f392fc9709a3 52 }
AnnaBridge 189:f392fc9709a3 53
AnnaBridge 189:f392fc9709a3 54 us_timestamp_t mbed_time_idle(void)
AnnaBridge 189:f392fc9709a3 55 {
AnnaBridge 189:f392fc9709a3 56 return (sleep_time + deep_sleep_time);
AnnaBridge 189:f392fc9709a3 57 }
AnnaBridge 189:f392fc9709a3 58
AnnaBridge 189:f392fc9709a3 59 us_timestamp_t mbed_uptime(void)
AnnaBridge 189:f392fc9709a3 60 {
AnnaBridge 189:f392fc9709a3 61 return read_us();
AnnaBridge 189:f392fc9709a3 62 }
AnnaBridge 189:f392fc9709a3 63
AnnaBridge 189:f392fc9709a3 64 us_timestamp_t mbed_time_sleep(void)
AnnaBridge 189:f392fc9709a3 65 {
AnnaBridge 189:f392fc9709a3 66 return sleep_time;
AnnaBridge 189:f392fc9709a3 67 }
AnnaBridge 189:f392fc9709a3 68
AnnaBridge 189:f392fc9709a3 69 us_timestamp_t mbed_time_deepsleep(void)
AnnaBridge 189:f392fc9709a3 70 {
AnnaBridge 189:f392fc9709a3 71 return deep_sleep_time;
AnnaBridge 189:f392fc9709a3 72 }
AnnaBridge 189:f392fc9709a3 73
AnnaBridge 189:f392fc9709a3 74 #ifdef MBED_SLEEP_TRACING_ENABLED
AnnaBridge 189:f392fc9709a3 75
AnnaBridge 189:f392fc9709a3 76 // Number of drivers that can be stored in the structure
AnnaBridge 189:f392fc9709a3 77 #define STATISTIC_COUNT 10
AnnaBridge 189:f392fc9709a3 78
AnnaBridge 189:f392fc9709a3 79 typedef struct sleep_statistic {
AnnaBridge 189:f392fc9709a3 80 const char *identifier;
AnnaBridge 189:f392fc9709a3 81 uint8_t count;
AnnaBridge 189:f392fc9709a3 82 } sleep_statistic_t;
AnnaBridge 189:f392fc9709a3 83
AnnaBridge 189:f392fc9709a3 84 static sleep_statistic_t sleep_stats[STATISTIC_COUNT];
AnnaBridge 189:f392fc9709a3 85
AnnaBridge 189:f392fc9709a3 86 static sleep_statistic_t *sleep_tracker_find(const char *const filename)
AnnaBridge 189:f392fc9709a3 87 {
AnnaBridge 189:f392fc9709a3 88 for (int i = 0; i < STATISTIC_COUNT; ++i) {
AnnaBridge 189:f392fc9709a3 89 if (sleep_stats[i].identifier == filename) {
AnnaBridge 189:f392fc9709a3 90 return &sleep_stats[i];
AnnaBridge 189:f392fc9709a3 91 }
AnnaBridge 189:f392fc9709a3 92 }
AnnaBridge 189:f392fc9709a3 93
AnnaBridge 189:f392fc9709a3 94 return NULL;
AnnaBridge 189:f392fc9709a3 95 }
AnnaBridge 189:f392fc9709a3 96
AnnaBridge 189:f392fc9709a3 97 static sleep_statistic_t *sleep_tracker_add(const char *const filename)
AnnaBridge 189:f392fc9709a3 98 {
AnnaBridge 189:f392fc9709a3 99 for (int i = 0; i < STATISTIC_COUNT; ++i) {
AnnaBridge 189:f392fc9709a3 100 if (sleep_stats[i].identifier == NULL) {
AnnaBridge 189:f392fc9709a3 101 sleep_stats[i].identifier = filename;
AnnaBridge 189:f392fc9709a3 102
AnnaBridge 189:f392fc9709a3 103 return &sleep_stats[i];
AnnaBridge 189:f392fc9709a3 104 }
AnnaBridge 189:f392fc9709a3 105 }
AnnaBridge 189:f392fc9709a3 106
AnnaBridge 189:f392fc9709a3 107 mbed_error_printf("No free indexes left to use in mbed sleep tracker.\r\n");
AnnaBridge 189:f392fc9709a3 108
AnnaBridge 189:f392fc9709a3 109 return NULL;
AnnaBridge 189:f392fc9709a3 110 }
AnnaBridge 189:f392fc9709a3 111
AnnaBridge 189:f392fc9709a3 112 static void sleep_tracker_print_stats(void)
AnnaBridge 189:f392fc9709a3 113 {
AnnaBridge 189:f392fc9709a3 114 mbed_error_printf("Sleep locks held:\r\n");
AnnaBridge 189:f392fc9709a3 115 for (int i = 0; i < STATISTIC_COUNT; ++i) {
AnnaBridge 189:f392fc9709a3 116 if (sleep_stats[i].count == 0) {
AnnaBridge 189:f392fc9709a3 117 continue;
AnnaBridge 189:f392fc9709a3 118 }
AnnaBridge 189:f392fc9709a3 119
AnnaBridge 189:f392fc9709a3 120 if (sleep_stats[i].identifier == NULL) {
AnnaBridge 189:f392fc9709a3 121 return;
AnnaBridge 189:f392fc9709a3 122 }
AnnaBridge 189:f392fc9709a3 123
AnnaBridge 189:f392fc9709a3 124 mbed_error_printf("[id: %s, count: %u]\r\n", sleep_stats[i].identifier,
AnnaBridge 189:f392fc9709a3 125 sleep_stats[i].count);
AnnaBridge 189:f392fc9709a3 126 }
AnnaBridge 189:f392fc9709a3 127 }
AnnaBridge 189:f392fc9709a3 128
AnnaBridge 189:f392fc9709a3 129 void sleep_tracker_lock(const char *const filename, int line)
AnnaBridge 189:f392fc9709a3 130 {
AnnaBridge 189:f392fc9709a3 131 sleep_statistic_t *stat = sleep_tracker_find(filename);
AnnaBridge 189:f392fc9709a3 132
AnnaBridge 189:f392fc9709a3 133 // Entry for this driver does not exist, create one.
AnnaBridge 189:f392fc9709a3 134 if (stat == NULL) {
AnnaBridge 189:f392fc9709a3 135 stat = sleep_tracker_add(filename);
AnnaBridge 189:f392fc9709a3 136 }
AnnaBridge 189:f392fc9709a3 137
AnnaBridge 189:f392fc9709a3 138 core_util_atomic_incr_u8(&stat->count, 1);
AnnaBridge 189:f392fc9709a3 139
AnnaBridge 189:f392fc9709a3 140 mbed_error_printf("LOCK: %s, ln: %i, lock count: %u\r\n", filename, line, deep_sleep_lock);
AnnaBridge 189:f392fc9709a3 141 }
AnnaBridge 189:f392fc9709a3 142
AnnaBridge 189:f392fc9709a3 143 void sleep_tracker_unlock(const char *const filename, int line)
AnnaBridge 189:f392fc9709a3 144 {
AnnaBridge 189:f392fc9709a3 145 sleep_statistic_t *stat = sleep_tracker_find(filename);
AnnaBridge 189:f392fc9709a3 146
AnnaBridge 189:f392fc9709a3 147 // Entry for this driver does not exist, something went wrong.
AnnaBridge 189:f392fc9709a3 148 if (stat == NULL) {
AnnaBridge 189:f392fc9709a3 149 mbed_error_printf("Unlocking sleep for driver that was not previously locked: %s, ln: %i\r\n", filename, line);
AnnaBridge 189:f392fc9709a3 150 return;
AnnaBridge 189:f392fc9709a3 151 }
AnnaBridge 189:f392fc9709a3 152
AnnaBridge 189:f392fc9709a3 153 core_util_atomic_decr_u8(&stat->count, 1);
AnnaBridge 189:f392fc9709a3 154
AnnaBridge 189:f392fc9709a3 155 mbed_error_printf("UNLOCK: %s, ln: %i, lock count: %u\r\n", filename, line, deep_sleep_lock);
AnnaBridge 189:f392fc9709a3 156 }
AnnaBridge 189:f392fc9709a3 157
AnnaBridge 189:f392fc9709a3 158 #endif // MBED_SLEEP_TRACING_ENABLED
AnnaBridge 189:f392fc9709a3 159
AnnaBridge 189:f392fc9709a3 160 void sleep_manager_lock_deep_sleep_internal(void)
AnnaBridge 189:f392fc9709a3 161 {
AnnaBridge 189:f392fc9709a3 162 core_util_critical_section_enter();
AnnaBridge 189:f392fc9709a3 163 if (deep_sleep_lock == USHRT_MAX) {
AnnaBridge 189:f392fc9709a3 164 core_util_critical_section_exit();
AnnaBridge 189:f392fc9709a3 165 MBED_ERROR1(MBED_MAKE_ERROR(MBED_MODULE_HAL, MBED_ERROR_CODE_OVERFLOW), "DeepSleepLock overflow (> USHRT_MAX)", deep_sleep_lock);
AnnaBridge 189:f392fc9709a3 166 }
AnnaBridge 189:f392fc9709a3 167 core_util_atomic_incr_u16(&deep_sleep_lock, 1);
AnnaBridge 189:f392fc9709a3 168 core_util_critical_section_exit();
AnnaBridge 189:f392fc9709a3 169 }
AnnaBridge 189:f392fc9709a3 170
AnnaBridge 189:f392fc9709a3 171 void sleep_manager_unlock_deep_sleep_internal(void)
AnnaBridge 189:f392fc9709a3 172 {
AnnaBridge 189:f392fc9709a3 173 core_util_critical_section_enter();
AnnaBridge 189:f392fc9709a3 174 if (deep_sleep_lock == 0) {
AnnaBridge 189:f392fc9709a3 175 core_util_critical_section_exit();
AnnaBridge 189:f392fc9709a3 176 MBED_ERROR1(MBED_MAKE_ERROR(MBED_MODULE_HAL, MBED_ERROR_CODE_UNDERFLOW), "DeepSleepLock underflow (< 0)", deep_sleep_lock);
AnnaBridge 189:f392fc9709a3 177 }
AnnaBridge 189:f392fc9709a3 178 core_util_atomic_decr_u16(&deep_sleep_lock, 1);
AnnaBridge 189:f392fc9709a3 179 core_util_critical_section_exit();
AnnaBridge 189:f392fc9709a3 180 }
AnnaBridge 189:f392fc9709a3 181
AnnaBridge 189:f392fc9709a3 182 bool sleep_manager_can_deep_sleep(void)
AnnaBridge 189:f392fc9709a3 183 {
AnnaBridge 189:f392fc9709a3 184 return deep_sleep_lock == 0 ? true : false;
AnnaBridge 189:f392fc9709a3 185 }
AnnaBridge 189:f392fc9709a3 186
AnnaBridge 189:f392fc9709a3 187 bool sleep_manager_can_deep_sleep_test_check()
AnnaBridge 189:f392fc9709a3 188 {
AnnaBridge 189:f392fc9709a3 189 const uint32_t check_time_us = 2000;
AnnaBridge 189:f392fc9709a3 190 const ticker_data_t *const ticker = get_us_ticker_data();
AnnaBridge 189:f392fc9709a3 191 uint32_t start = ticker_read(ticker);
AnnaBridge 189:f392fc9709a3 192 while ((ticker_read(ticker) - start) < check_time_us) {
AnnaBridge 189:f392fc9709a3 193 if (sleep_manager_can_deep_sleep()) {
AnnaBridge 189:f392fc9709a3 194 return true;
AnnaBridge 189:f392fc9709a3 195 }
AnnaBridge 189:f392fc9709a3 196 }
AnnaBridge 189:f392fc9709a3 197 return false;
AnnaBridge 189:f392fc9709a3 198 }
AnnaBridge 189:f392fc9709a3 199
AnnaBridge 189:f392fc9709a3 200 void sleep_manager_sleep_auto(void)
AnnaBridge 189:f392fc9709a3 201 {
AnnaBridge 189:f392fc9709a3 202 #ifdef MBED_SLEEP_TRACING_ENABLED
AnnaBridge 189:f392fc9709a3 203 sleep_tracker_print_stats();
AnnaBridge 189:f392fc9709a3 204 #endif
AnnaBridge 189:f392fc9709a3 205 core_util_critical_section_enter();
AnnaBridge 189:f392fc9709a3 206 us_timestamp_t start = read_us();
AnnaBridge 189:f392fc9709a3 207 bool deep = false;
AnnaBridge 189:f392fc9709a3 208
AnnaBridge 189:f392fc9709a3 209 // debug profile should keep debuggers attached, no deep sleep allowed
AnnaBridge 189:f392fc9709a3 210 #ifdef MBED_DEBUG
AnnaBridge 189:f392fc9709a3 211 hal_sleep();
AnnaBridge 189:f392fc9709a3 212 #else
AnnaBridge 189:f392fc9709a3 213 if (sleep_manager_can_deep_sleep()) {
AnnaBridge 189:f392fc9709a3 214 deep = true;
AnnaBridge 189:f392fc9709a3 215 hal_deepsleep();
AnnaBridge 189:f392fc9709a3 216 } else {
AnnaBridge 189:f392fc9709a3 217 hal_sleep();
AnnaBridge 189:f392fc9709a3 218 }
AnnaBridge 189:f392fc9709a3 219 #endif
AnnaBridge 189:f392fc9709a3 220
AnnaBridge 189:f392fc9709a3 221 us_timestamp_t end = read_us();
AnnaBridge 189:f392fc9709a3 222 if (true == deep) {
AnnaBridge 189:f392fc9709a3 223 deep_sleep_time += end - start;
AnnaBridge 189:f392fc9709a3 224 } else {
AnnaBridge 189:f392fc9709a3 225 sleep_time += end - start;
AnnaBridge 189:f392fc9709a3 226 }
AnnaBridge 189:f392fc9709a3 227 core_util_critical_section_exit();
AnnaBridge 189:f392fc9709a3 228 }
AnnaBridge 189:f392fc9709a3 229
AnnaBridge 189:f392fc9709a3 230 #else
AnnaBridge 189:f392fc9709a3 231
AnnaBridge 189:f392fc9709a3 232 // locking is valid only if DEVICE_SLEEP is defined
AnnaBridge 189:f392fc9709a3 233 // we provide empty implementation
AnnaBridge 189:f392fc9709a3 234
AnnaBridge 189:f392fc9709a3 235 void sleep_manager_lock_deep_sleep_internal(void)
AnnaBridge 189:f392fc9709a3 236 {
AnnaBridge 189:f392fc9709a3 237
AnnaBridge 189:f392fc9709a3 238 }
AnnaBridge 189:f392fc9709a3 239
AnnaBridge 189:f392fc9709a3 240 void sleep_manager_unlock_deep_sleep_internal(void)
AnnaBridge 189:f392fc9709a3 241 {
AnnaBridge 189:f392fc9709a3 242
AnnaBridge 189:f392fc9709a3 243 }
AnnaBridge 189:f392fc9709a3 244
AnnaBridge 189:f392fc9709a3 245 bool sleep_manager_can_deep_sleep(void)
AnnaBridge 189:f392fc9709a3 246 {
AnnaBridge 189:f392fc9709a3 247 // no sleep implemented
AnnaBridge 189:f392fc9709a3 248 return false;
AnnaBridge 189:f392fc9709a3 249 }
AnnaBridge 189:f392fc9709a3 250
AnnaBridge 189:f392fc9709a3 251 #endif