PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/platform/DeepSleepLock.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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