Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/DeepSleepLock.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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