takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/CriticalSectionLock.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kadonotakashi 0:8fdf9a60065b 1 /*
kadonotakashi 0:8fdf9a60065b 2 * PackageLicenseDeclared: Apache-2.0
kadonotakashi 0:8fdf9a60065b 3 * Copyright (c) 2017 ARM Limited
kadonotakashi 0:8fdf9a60065b 4 *
kadonotakashi 0:8fdf9a60065b 5 * Licensed under the Apache License, Version 2.0 (the "License");
kadonotakashi 0:8fdf9a60065b 6 * you may not use this file except in compliance with the License.
kadonotakashi 0:8fdf9a60065b 7 * You may obtain a copy of the License at
kadonotakashi 0:8fdf9a60065b 8 *
kadonotakashi 0:8fdf9a60065b 9 * http://www.apache.org/licenses/LICENSE-2.0
kadonotakashi 0:8fdf9a60065b 10 *
kadonotakashi 0:8fdf9a60065b 11 * Unless required by applicable law or agreed to in writing, software
kadonotakashi 0:8fdf9a60065b 12 * distributed under the License is distributed on an "AS IS" BASIS,
kadonotakashi 0:8fdf9a60065b 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
kadonotakashi 0:8fdf9a60065b 14 * See the License for the specific language governing permissions and
kadonotakashi 0:8fdf9a60065b 15 * limitations under the License.
kadonotakashi 0:8fdf9a60065b 16 */
kadonotakashi 0:8fdf9a60065b 17
kadonotakashi 0:8fdf9a60065b 18 #ifndef MBED_CRITICALSECTIONLOCK_H
kadonotakashi 0:8fdf9a60065b 19 #define MBED_CRITICALSECTIONLOCK_H
kadonotakashi 0:8fdf9a60065b 20
kadonotakashi 0:8fdf9a60065b 21 #include "platform/mbed_critical.h"
kadonotakashi 0:8fdf9a60065b 22 #include "platform/mbed_toolchain.h"
kadonotakashi 0:8fdf9a60065b 23
kadonotakashi 0:8fdf9a60065b 24 namespace mbed {
kadonotakashi 0:8fdf9a60065b 25
kadonotakashi 0:8fdf9a60065b 26 /** \addtogroup platform */
kadonotakashi 0:8fdf9a60065b 27 /** @{*/
kadonotakashi 0:8fdf9a60065b 28 /**
kadonotakashi 0:8fdf9a60065b 29 * \defgroup platform_CriticalSectionLock CriticalSectionLock functions
kadonotakashi 0:8fdf9a60065b 30 * @{
kadonotakashi 0:8fdf9a60065b 31 */
kadonotakashi 0:8fdf9a60065b 32
kadonotakashi 0:8fdf9a60065b 33 /** RAII object for disabling, then restoring, interrupt state
kadonotakashi 0:8fdf9a60065b 34 * Usage:
kadonotakashi 0:8fdf9a60065b 35 * @code
kadonotakashi 0:8fdf9a60065b 36 *
kadonotakashi 0:8fdf9a60065b 37 * // RAII style usage
kadonotakashi 0:8fdf9a60065b 38 * unsigned int atomic_counter_increment(unsigned int &counter) {
kadonotakashi 0:8fdf9a60065b 39 * CriticalSectionLock lock;
kadonotakashi 0:8fdf9a60065b 40 * // Code in this block will run with interrupts disabled
kadonotakashi 0:8fdf9a60065b 41 * // Interrupts will be restored to their previous state automatically
kadonotakashi 0:8fdf9a60065b 42 * // at the end of function scope
kadonotakashi 0:8fdf9a60065b 43 * return ++counter;
kadonotakashi 0:8fdf9a60065b 44 * }
kadonotakashi 0:8fdf9a60065b 45 *
kadonotakashi 0:8fdf9a60065b 46 * // free locking usage
kadonotakashi 0:8fdf9a60065b 47 * unsigned int atomic_counter_decrement(unsigned int &counter) {
kadonotakashi 0:8fdf9a60065b 48 * CriticalSectionLock::enable();
kadonotakashi 0:8fdf9a60065b 49 * // Code in this block will run with interrupts disabled
kadonotakashi 0:8fdf9a60065b 50 * counter--;
kadonotakashi 0:8fdf9a60065b 51 * CriticalSectionLock::disable(); // need explicitly to disable critical section lock
kadonotakashi 0:8fdf9a60065b 52 * // interrupts will be restored to their previous state here
kadonotakashi 0:8fdf9a60065b 53 * return counter;
kadonotakashi 0:8fdf9a60065b 54 * }
kadonotakashi 0:8fdf9a60065b 55 *
kadonotakashi 0:8fdf9a60065b 56 * @endcode
kadonotakashi 0:8fdf9a60065b 57 */
kadonotakashi 0:8fdf9a60065b 58 class CriticalSectionLock {
kadonotakashi 0:8fdf9a60065b 59 public:
kadonotakashi 0:8fdf9a60065b 60 CriticalSectionLock()
kadonotakashi 0:8fdf9a60065b 61 {
kadonotakashi 0:8fdf9a60065b 62 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 63 }
kadonotakashi 0:8fdf9a60065b 64
kadonotakashi 0:8fdf9a60065b 65 ~CriticalSectionLock()
kadonotakashi 0:8fdf9a60065b 66 {
kadonotakashi 0:8fdf9a60065b 67 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 68 }
kadonotakashi 0:8fdf9a60065b 69
kadonotakashi 0:8fdf9a60065b 70 /** Mark the start of a critical section
kadonotakashi 0:8fdf9a60065b 71 * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
kadonotakashi 0:8fdf9a60065b 72 *
kadonotakashi 0:8fdf9a60065b 73 */
kadonotakashi 0:8fdf9a60065b 74 MBED_DEPRECATED_SINCE("mbed-os-5.8",
kadonotakashi 0:8fdf9a60065b 75 "This function is inconsistent with RAII and is being removed in the future."
kadonotakashi 0:8fdf9a60065b 76 "Replaced by static function CriticalSectionLock::enable.")
kadonotakashi 0:8fdf9a60065b 77 void lock()
kadonotakashi 0:8fdf9a60065b 78 {
kadonotakashi 0:8fdf9a60065b 79 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 80 }
kadonotakashi 0:8fdf9a60065b 81
kadonotakashi 0:8fdf9a60065b 82 /** Mark the end of a critical section
kadonotakashi 0:8fdf9a60065b 83 * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
kadonotakashi 0:8fdf9a60065b 84 *
kadonotakashi 0:8fdf9a60065b 85 */
kadonotakashi 0:8fdf9a60065b 86 MBED_DEPRECATED_SINCE("mbed-os-5.8",
kadonotakashi 0:8fdf9a60065b 87 "This function is inconsistent with RAII and is being removed in the future."
kadonotakashi 0:8fdf9a60065b 88 "Replaced by static function CriticalSectionLock::disable.")
kadonotakashi 0:8fdf9a60065b 89 void unlock()
kadonotakashi 0:8fdf9a60065b 90 {
kadonotakashi 0:8fdf9a60065b 91 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 92 }
kadonotakashi 0:8fdf9a60065b 93
kadonotakashi 0:8fdf9a60065b 94 /** Mark the start of a critical section
kadonotakashi 0:8fdf9a60065b 95 */
kadonotakashi 0:8fdf9a60065b 96 static void enable()
kadonotakashi 0:8fdf9a60065b 97 {
kadonotakashi 0:8fdf9a60065b 98 core_util_critical_section_enter();
kadonotakashi 0:8fdf9a60065b 99 }
kadonotakashi 0:8fdf9a60065b 100
kadonotakashi 0:8fdf9a60065b 101 /** Mark the end of a critical section
kadonotakashi 0:8fdf9a60065b 102 */
kadonotakashi 0:8fdf9a60065b 103 static void disable()
kadonotakashi 0:8fdf9a60065b 104 {
kadonotakashi 0:8fdf9a60065b 105 core_util_critical_section_exit();
kadonotakashi 0:8fdf9a60065b 106 }
kadonotakashi 0:8fdf9a60065b 107 };
kadonotakashi 0:8fdf9a60065b 108
kadonotakashi 0:8fdf9a60065b 109 /**@}*/
kadonotakashi 0:8fdf9a60065b 110
kadonotakashi 0:8fdf9a60065b 111 /**@}*/
kadonotakashi 0:8fdf9a60065b 112
kadonotakashi 0:8fdf9a60065b 113 } // namespace mbed
kadonotakashi 0:8fdf9a60065b 114
kadonotakashi 0:8fdf9a60065b 115 #endif