Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

platform/DeepSleepLock.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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