mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/DeepSleepLock.h@178:79309dc6340a, 2017-11-23 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 23 11:57:25 2017 +0000
Revision:
178:79309dc6340a
Parent:
175:af195413fb11
Child:
184:08ed48f1de7f
mbed-dev library. Release version 156

Who changed what in which revision?

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