takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/DeepSleepLock.h@0:8fdf9a60065b, 2018-10-10 (annotated)

Committer:
kadonotakashi
Date:
Wed Oct 10 00:33:53 2018 +0000
Revision:
0:8fdf9a60065b
how to make mbed librry

Who changed what in which revision?

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