zhang boie / mbed-dev-f30333

hal/mbed_sleep_manager.c@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 1 /* mbed Microcontroller Library
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 2 * Copyright (c) 2017 ARM Limited
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 3 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 4 * Licensed under the Apache License, Version 2.0 (the "License");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 5 * you may not use this file except in compliance with the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 6 * You may obtain a copy of the License at
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 7 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 8 * http://www.apache.org/licenses/LICENSE-2.0
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 9 *
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 10 * Unless required by applicable law or agreed to in writing, software
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 11 * distributed under the License is distributed on an "AS IS" BASIS,
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 13 * See the License for the specific language governing permissions and
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 14 * limitations under the License.
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 15 */
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 16
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 17 #include "mbed_sleep.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 18 #include "mbed_critical.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 19 #include "sleep_api.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 20 #include "mbed_error.h"
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 21 #include <limits.h>
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 22
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 23 #if DEVICE_SLEEP
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 24
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 25 // deep sleep locking counter. A target is allowed to deep sleep if counter == 0
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 26 static uint16_t deep_sleep_lock = 0U;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 27
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 28 void sleep_manager_lock_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 29 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 30 core_util_critical_section_enter();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 31 if (deep_sleep_lock == USHRT_MAX) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 32 core_util_critical_section_exit();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 33 error("Deep sleep lock would overflow (> USHRT_MAX)");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 34 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 35 core_util_atomic_incr_u16(&deep_sleep_lock, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 36 core_util_critical_section_exit();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 37 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 38
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 39 void sleep_manager_unlock_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 40 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 41 core_util_critical_section_enter();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 42 if (deep_sleep_lock == 0) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 43 core_util_critical_section_exit();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 44 error("Deep sleep lock would underflow (< 0)");
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 45 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 46 core_util_atomic_decr_u16(&deep_sleep_lock, 1);
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 47 core_util_critical_section_exit();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 48 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 49
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 50 bool sleep_manager_can_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 51 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 52 return deep_sleep_lock == 0 ? true : false;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 53 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 54
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 55 void sleep_manager_sleep_auto(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 56 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 57 core_util_critical_section_enter();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 58 // debug profile should keep debuggers attached, no deep sleep allowed
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 59 #ifdef MBED_DEBUG
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 60 hal_sleep();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 61 #else
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 62 if (sleep_manager_can_deep_sleep()) {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 63 hal_deepsleep();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 64 } else {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 65 hal_sleep();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 66 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 67 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 68 core_util_critical_section_exit();
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 69 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 70
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 71 #else
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 72
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 73 // locking is valid only if DEVICE_SLEEP is defined
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 74 // we provide empty implementation
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 75
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 76 void sleep_manager_lock_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 77 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 78
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 79 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 80
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 81 void sleep_manager_unlock_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 82 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 83
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 84 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 85
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 86 bool sleep_manager_can_deep_sleep(void)
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 87 {
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 88 // no sleep implemented
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 89 return false;
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 90 }
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 91
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 92 #endif
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4 0:bdf663c61a82 93