EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

platform/CriticalSectionLock.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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