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