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

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/platform/CriticalSectionLock.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 /*
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
ommpy 0:d383e2dee0f7 18 #ifndef MBED_CRITICALSECTIONLOCK_H
ommpy 0:d383e2dee0f7 19 #define MBED_CRITICALSECTIONLOCK_H
ommpy 0:d383e2dee0f7 20
ommpy 0:d383e2dee0f7 21 #include "platform/mbed_critical.h"
ommpy 0:d383e2dee0f7 22 #include "platform/mbed_toolchain.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_CriticalSectionLock CriticalSectionLock functions
ommpy 0:d383e2dee0f7 30 * @{
ommpy 0:d383e2dee0f7 31 */
ommpy 0:d383e2dee0f7 32
ommpy 0:d383e2dee0f7 33 /** RAII object for disabling, then restoring, interrupt state
ommpy 0:d383e2dee0f7 34 * Usage:
ommpy 0:d383e2dee0f7 35 * @code
ommpy 0:d383e2dee0f7 36 *
ommpy 0:d383e2dee0f7 37 * // RAII style usage
ommpy 0:d383e2dee0f7 38 * unsigned int atomic_counter_increment(unsigned int &counter) {
ommpy 0:d383e2dee0f7 39 * CriticalSectionLock lock;
ommpy 0:d383e2dee0f7 40 * // Code in this block will run with interrupts disabled
ommpy 0:d383e2dee0f7 41 * // Interrupts will be restored to their previous state automatically
ommpy 0:d383e2dee0f7 42 * // at the end of function scope
ommpy 0:d383e2dee0f7 43 * return ++counter;
ommpy 0:d383e2dee0f7 44 * }
ommpy 0:d383e2dee0f7 45 *
ommpy 0:d383e2dee0f7 46 * // free locking usage
ommpy 0:d383e2dee0f7 47 * unsigned int atomic_counter_decrement(unsigned int &counter) {
ommpy 0:d383e2dee0f7 48 * CriticalSectionLock::enable();
ommpy 0:d383e2dee0f7 49 * // Code in this block will run with interrupts disabled
ommpy 0:d383e2dee0f7 50 * counter--;
ommpy 0:d383e2dee0f7 51 * CriticalSectionLock::disable(); // need explicitly to disable critical section lock
ommpy 0:d383e2dee0f7 52 * // interrupts will be restored to their previous state here
ommpy 0:d383e2dee0f7 53 * return counter;
ommpy 0:d383e2dee0f7 54 * }
ommpy 0:d383e2dee0f7 55 *
ommpy 0:d383e2dee0f7 56 * @endcode
ommpy 0:d383e2dee0f7 57 */
ommpy 0:d383e2dee0f7 58 class CriticalSectionLock {
ommpy 0:d383e2dee0f7 59 public:
ommpy 0:d383e2dee0f7 60 CriticalSectionLock()
ommpy 0:d383e2dee0f7 61 {
ommpy 0:d383e2dee0f7 62 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 63 }
ommpy 0:d383e2dee0f7 64
ommpy 0:d383e2dee0f7 65 ~CriticalSectionLock()
ommpy 0:d383e2dee0f7 66 {
ommpy 0:d383e2dee0f7 67 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 68 }
ommpy 0:d383e2dee0f7 69
ommpy 0:d383e2dee0f7 70 /** Mark the start of a critical section
ommpy 0:d383e2dee0f7 71 * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
ommpy 0:d383e2dee0f7 72 *
ommpy 0:d383e2dee0f7 73 */
ommpy 0:d383e2dee0f7 74 MBED_DEPRECATED_SINCE("mbed-os-5.8",
ommpy 0:d383e2dee0f7 75 "This function is inconsistent with RAII and is being removed in the future."
ommpy 0:d383e2dee0f7 76 "Replaced by static function CriticalSectionLock::enable.")
ommpy 0:d383e2dee0f7 77 void lock()
ommpy 0:d383e2dee0f7 78 {
ommpy 0:d383e2dee0f7 79 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 80 }
ommpy 0:d383e2dee0f7 81
ommpy 0:d383e2dee0f7 82 /** Mark the end of a critical section
ommpy 0:d383e2dee0f7 83 * @deprecated This function is inconsistent with RAII and is being removed in the future. Replaced by static function CriticalSectionLock::enable.
ommpy 0:d383e2dee0f7 84 *
ommpy 0:d383e2dee0f7 85 */
ommpy 0:d383e2dee0f7 86 MBED_DEPRECATED_SINCE("mbed-os-5.8",
ommpy 0:d383e2dee0f7 87 "This function is inconsistent with RAII and is being removed in the future."
ommpy 0:d383e2dee0f7 88 "Replaced by static function CriticalSectionLock::disable.")
ommpy 0:d383e2dee0f7 89 void unlock()
ommpy 0:d383e2dee0f7 90 {
ommpy 0:d383e2dee0f7 91 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 92 }
ommpy 0:d383e2dee0f7 93
ommpy 0:d383e2dee0f7 94 /** Mark the start of a critical section
ommpy 0:d383e2dee0f7 95 */
ommpy 0:d383e2dee0f7 96 static void enable()
ommpy 0:d383e2dee0f7 97 {
ommpy 0:d383e2dee0f7 98 core_util_critical_section_enter();
ommpy 0:d383e2dee0f7 99 }
ommpy 0:d383e2dee0f7 100
ommpy 0:d383e2dee0f7 101 /** Mark the end of a critical section
ommpy 0:d383e2dee0f7 102 */
ommpy 0:d383e2dee0f7 103 static void disable()
ommpy 0:d383e2dee0f7 104 {
ommpy 0:d383e2dee0f7 105 core_util_critical_section_exit();
ommpy 0:d383e2dee0f7 106 }
ommpy 0:d383e2dee0f7 107 };
ommpy 0:d383e2dee0f7 108
ommpy 0:d383e2dee0f7 109 /**@}*/
ommpy 0:d383e2dee0f7 110
ommpy 0:d383e2dee0f7 111 /**@}*/
ommpy 0:d383e2dee0f7 112
ommpy 0:d383e2dee0f7 113 } // namespace mbed
ommpy 0:d383e2dee0f7 114
ommpy 0:d383e2dee0f7 115 #endif