Gan likun / mbed-dev11

platform/DeepSleepLock.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:06036f8bee2d 1 /* mbed Microcontroller Library
ganlikun 0:06036f8bee2d 2 * Copyright (c) 2017 ARM Limited
ganlikun 0:06036f8bee2d 3 *
ganlikun 0:06036f8bee2d 4 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:06036f8bee2d 5 * you may not use this file except in compliance with the License.
ganlikun 0:06036f8bee2d 6 * You may obtain a copy of the License at
ganlikun 0:06036f8bee2d 7 *
ganlikun 0:06036f8bee2d 8 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:06036f8bee2d 9 *
ganlikun 0:06036f8bee2d 10 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:06036f8bee2d 11 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:06036f8bee2d 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:06036f8bee2d 13 * See the License for the specific language governing permissions and
ganlikun 0:06036f8bee2d 14 * limitations under the License.
ganlikun 0:06036f8bee2d 15 */
ganlikun 0:06036f8bee2d 16 #ifndef MBED_DEEPSLEEPLOCK_H
ganlikun 0:06036f8bee2d 17 #define MBED_DEEPSLEEPLOCK_H
ganlikun 0:06036f8bee2d 18
ganlikun 0:06036f8bee2d 19 #include <limits.h>
ganlikun 0:06036f8bee2d 20 #include "platform/mbed_sleep.h"
ganlikun 0:06036f8bee2d 21 #include "platform/mbed_critical.h"
ganlikun 0:06036f8bee2d 22
ganlikun 0:06036f8bee2d 23 namespace mbed {
ganlikun 0:06036f8bee2d 24
ganlikun 0:06036f8bee2d 25
ganlikun 0:06036f8bee2d 26 /** RAII object for disabling, then restoring the deep sleep mode
ganlikun 0:06036f8bee2d 27 * Usage:
ganlikun 0:06036f8bee2d 28 * @code
ganlikun 0:06036f8bee2d 29 *
ganlikun 0:06036f8bee2d 30 * void f() {
ganlikun 0:06036f8bee2d 31 * // some code here
ganlikun 0:06036f8bee2d 32 * {
ganlikun 0:06036f8bee2d 33 * DeepSleepLock lock;
ganlikun 0:06036f8bee2d 34 * // Code in this block will run with the deep sleep mode locked
ganlikun 0:06036f8bee2d 35 * }
ganlikun 0:06036f8bee2d 36 * // deep sleep mode will be restored to their previous state
ganlikun 0:06036f8bee2d 37 * }
ganlikun 0:06036f8bee2d 38 * @endcode
ganlikun 0:06036f8bee2d 39 */
ganlikun 0:06036f8bee2d 40 class DeepSleepLock {
ganlikun 0:06036f8bee2d 41 private:
ganlikun 0:06036f8bee2d 42 uint16_t _lock_count;
ganlikun 0:06036f8bee2d 43
ganlikun 0:06036f8bee2d 44 public:
ganlikun 0:06036f8bee2d 45 DeepSleepLock(): _lock_count(1)
ganlikun 0:06036f8bee2d 46 {
ganlikun 0:06036f8bee2d 47 sleep_manager_lock_deep_sleep();
ganlikun 0:06036f8bee2d 48 }
ganlikun 0:06036f8bee2d 49
ganlikun 0:06036f8bee2d 50 ~DeepSleepLock()
ganlikun 0:06036f8bee2d 51 {
ganlikun 0:06036f8bee2d 52 if (_lock_count) {
ganlikun 0:06036f8bee2d 53 sleep_manager_unlock_deep_sleep();
ganlikun 0:06036f8bee2d 54 }
ganlikun 0:06036f8bee2d 55 }
ganlikun 0:06036f8bee2d 56
ganlikun 0:06036f8bee2d 57 /** Mark the start of a locked deep sleep section
ganlikun 0:06036f8bee2d 58 */
ganlikun 0:06036f8bee2d 59 void lock()
ganlikun 0:06036f8bee2d 60 {
ganlikun 0:06036f8bee2d 61 uint16_t count = core_util_atomic_incr_u16(&_lock_count, 1);
ganlikun 0:06036f8bee2d 62 if (1 == count) {
ganlikun 0:06036f8bee2d 63 sleep_manager_lock_deep_sleep();
ganlikun 0:06036f8bee2d 64 }
ganlikun 0:06036f8bee2d 65 if (0 == count) {
ganlikun 0:06036f8bee2d 66 error("DeepSleepLock overflow (> USHRT_MAX)");
ganlikun 0:06036f8bee2d 67 }
ganlikun 0:06036f8bee2d 68 }
ganlikun 0:06036f8bee2d 69
ganlikun 0:06036f8bee2d 70 /** Mark the end of a locked deep sleep section
ganlikun 0:06036f8bee2d 71 */
ganlikun 0:06036f8bee2d 72 void unlock()
ganlikun 0:06036f8bee2d 73 {
ganlikun 0:06036f8bee2d 74 uint16_t count = core_util_atomic_decr_u16(&_lock_count, 1);
ganlikun 0:06036f8bee2d 75 if (count == 0) {
ganlikun 0:06036f8bee2d 76 sleep_manager_unlock_deep_sleep();
ganlikun 0:06036f8bee2d 77 }
ganlikun 0:06036f8bee2d 78 if (count == USHRT_MAX) {
ganlikun 0:06036f8bee2d 79 core_util_critical_section_exit();
ganlikun 0:06036f8bee2d 80 error("DeepSleepLock underflow (< 0)");
ganlikun 0:06036f8bee2d 81 }
ganlikun 0:06036f8bee2d 82 }
ganlikun 0:06036f8bee2d 83 };
ganlikun 0:06036f8bee2d 84
ganlikun 0:06036f8bee2d 85 }
ganlikun 0:06036f8bee2d 86
ganlikun 0:06036f8bee2d 87 #endif