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