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