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@152:235179ab3f27, 2017-10-02 (annotated)

Committer:
AnnaBridge
Date:
Mon Oct 02 15:20:36 2017 +0100
Revision:
152:235179ab3f27
Child:
158:1c57384330a6
Release 152 of the mbed library.

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 152:235179ab3f27 25 /** RAII object for disabling, then restoring, interrupt state
AnnaBridge 152:235179ab3f27 26 * Usage:
AnnaBridge 152:235179ab3f27 27 * @code
AnnaBridge 152:235179ab3f27 28 *
AnnaBridge 152:235179ab3f27 29 * void f() {
AnnaBridge 152:235179ab3f27 30 * // some code here
AnnaBridge 152:235179ab3f27 31 * {
AnnaBridge 152:235179ab3f27 32 * CriticalSectionLock lock;
AnnaBridge 152:235179ab3f27 33 * // Code in this block will run with interrupts disabled
AnnaBridge 152:235179ab3f27 34 * }
AnnaBridge 152:235179ab3f27 35 * // interrupts will be restored to their previous state
AnnaBridge 152:235179ab3f27 36 * }
AnnaBridge 152:235179ab3f27 37 * @endcode
AnnaBridge 152:235179ab3f27 38 */
AnnaBridge 152:235179ab3f27 39 class CriticalSectionLock {
AnnaBridge 152:235179ab3f27 40 public:
AnnaBridge 152:235179ab3f27 41 CriticalSectionLock()
AnnaBridge 152:235179ab3f27 42 {
AnnaBridge 152:235179ab3f27 43 core_util_critical_section_enter();
AnnaBridge 152:235179ab3f27 44 }
AnnaBridge 152:235179ab3f27 45
AnnaBridge 152:235179ab3f27 46 ~CriticalSectionLock()
AnnaBridge 152:235179ab3f27 47 {
AnnaBridge 152:235179ab3f27 48 core_util_critical_section_exit();
AnnaBridge 152:235179ab3f27 49 }
AnnaBridge 152:235179ab3f27 50
AnnaBridge 152:235179ab3f27 51 /** Mark the start of a critical section
AnnaBridge 152:235179ab3f27 52 *
AnnaBridge 152:235179ab3f27 53 */
AnnaBridge 152:235179ab3f27 54 void lock()
AnnaBridge 152:235179ab3f27 55 {
AnnaBridge 152:235179ab3f27 56 core_util_critical_section_enter();
AnnaBridge 152:235179ab3f27 57 }
AnnaBridge 152:235179ab3f27 58
AnnaBridge 152:235179ab3f27 59 /** Mark the end of a critical section
AnnaBridge 152:235179ab3f27 60 *
AnnaBridge 152:235179ab3f27 61 */
AnnaBridge 152:235179ab3f27 62 void unlock()
AnnaBridge 152:235179ab3f27 63 {
AnnaBridge 152:235179ab3f27 64 core_util_critical_section_exit();
AnnaBridge 152:235179ab3f27 65 }
AnnaBridge 152:235179ab3f27 66 };
AnnaBridge 152:235179ab3f27 67
AnnaBridge 152:235179ab3f27 68
AnnaBridge 152:235179ab3f27 69 } // namespace mbed
AnnaBridge 152:235179ab3f27 70
AnnaBridge 152:235179ab3f27 71 #endif