Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

mbed-os/platform/CriticalSectionLock.h@0:9fca2b23d0ba, 2019-02-23 (annotated)

Committer:
marcozecchini
Date:
Sat Feb 23 12:13:36 2019 +0000
Revision:
0:9fca2b23d0ba
final commit

Who changed what in which revision?

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