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@153:b484a57bc302, 2017-10-11 (annotated)

Committer:
AnnaBridge
Date:
Wed Oct 11 12:36:33 2017 +0100
Revision:
153:b484a57bc302
Parent:
152:235179ab3f27 
Release 153 of the mbed library.

Who changed what in which revision?

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