Gan likun / mbed-dev

00

platform/CriticalSectionLock.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:13413ea9a877 1 /*
ganlikun 0:13413ea9a877 2 * PackageLicenseDeclared: Apache-2.0
ganlikun 0:13413ea9a877 3 * Copyright (c) 2017 ARM Limited
ganlikun 0:13413ea9a877 4 *
ganlikun 0:13413ea9a877 5 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:13413ea9a877 6 * you may not use this file except in compliance with the License.
ganlikun 0:13413ea9a877 7 * You may obtain a copy of the License at
ganlikun 0:13413ea9a877 8 *
ganlikun 0:13413ea9a877 9 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:13413ea9a877 10 *
ganlikun 0:13413ea9a877 11 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:13413ea9a877 12 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:13413ea9a877 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:13413ea9a877 14 * See the License for the specific language governing permissions and
ganlikun 0:13413ea9a877 15 * limitations under the License.
ganlikun 0:13413ea9a877 16 */
ganlikun 0:13413ea9a877 17
ganlikun 0:13413ea9a877 18 #ifndef MBED_CRITICALSECTIONLOCK_H
ganlikun 0:13413ea9a877 19 #define MBED_CRITICALSECTIONLOCK_H
ganlikun 0:13413ea9a877 20
ganlikun 0:13413ea9a877 21 #include "platform/mbed_critical.h"
ganlikun 0:13413ea9a877 22
ganlikun 0:13413ea9a877 23 namespace mbed {
ganlikun 0:13413ea9a877 24
ganlikun 0:13413ea9a877 25 /** RAII object for disabling, then restoring, interrupt state
ganlikun 0:13413ea9a877 26 * Usage:
ganlikun 0:13413ea9a877 27 * @code
ganlikun 0:13413ea9a877 28 *
ganlikun 0:13413ea9a877 29 * void f() {
ganlikun 0:13413ea9a877 30 * // some code here
ganlikun 0:13413ea9a877 31 * {
ganlikun 0:13413ea9a877 32 * CriticalSectionLock lock;
ganlikun 0:13413ea9a877 33 * // Code in this block will run with interrupts disabled
ganlikun 0:13413ea9a877 34 * }
ganlikun 0:13413ea9a877 35 * // interrupts will be restored to their previous state
ganlikun 0:13413ea9a877 36 * }
ganlikun 0:13413ea9a877 37 * @endcode
ganlikun 0:13413ea9a877 38 */
ganlikun 0:13413ea9a877 39 class CriticalSectionLock {
ganlikun 0:13413ea9a877 40 public:
ganlikun 0:13413ea9a877 41 CriticalSectionLock()
ganlikun 0:13413ea9a877 42 {
ganlikun 0:13413ea9a877 43 core_util_critical_section_enter();
ganlikun 0:13413ea9a877 44 }
ganlikun 0:13413ea9a877 45
ganlikun 0:13413ea9a877 46 ~CriticalSectionLock()
ganlikun 0:13413ea9a877 47 {
ganlikun 0:13413ea9a877 48 core_util_critical_section_exit();
ganlikun 0:13413ea9a877 49 }
ganlikun 0:13413ea9a877 50
ganlikun 0:13413ea9a877 51 /** Mark the start of a critical section
ganlikun 0:13413ea9a877 52 *
ganlikun 0:13413ea9a877 53 */
ganlikun 0:13413ea9a877 54 void lock()
ganlikun 0:13413ea9a877 55 {
ganlikun 0:13413ea9a877 56 core_util_critical_section_enter();
ganlikun 0:13413ea9a877 57 }
ganlikun 0:13413ea9a877 58
ganlikun 0:13413ea9a877 59 /** Mark the end of a critical section
ganlikun 0:13413ea9a877 60 *
ganlikun 0:13413ea9a877 61 */
ganlikun 0:13413ea9a877 62 void unlock()
ganlikun 0:13413ea9a877 63 {
ganlikun 0:13413ea9a877 64 core_util_critical_section_exit();
ganlikun 0:13413ea9a877 65 }
ganlikun 0:13413ea9a877 66 };
ganlikun 0:13413ea9a877 67
ganlikun 0:13413ea9a877 68
ganlikun 0:13413ea9a877 69 } // namespace mbed
ganlikun 0:13413ea9a877 70
ganlikun 0:13413ea9a877 71 #endif
ganlikun 0:13413ea9a877 72