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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
158:1c57384330a6
Release 155 of the mbed library.

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