Kyle Wengryn / platform

update

CriticalSectionLock.h@0:bfff72fb3650, 2021-04-08 (annotated)

Committer:
kwengryn3
Date:
Thu Apr 08 16:43:07 2021 +0000
Revision:
0:bfff72fb3650
update;

Who changed what in which revision?

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