mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/DeepSleepLock.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
169:a7c7b631e539 
mbed library release version 165

Who changed what in which revision?

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