mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/CriticalSectionLock.h@158:1c57384330a6, 2017-11-23 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 23 11:44:04 2017 +0000
Revision:
158:1c57384330a6
Parent:
152:235179ab3f27
Child:
161:aa5281ff4a02
mbed library. Release version 156

Who changed what in which revision?

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