Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/platform/DeepSleepLock.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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