
test
mbed/platform/PlatformMutex.h@0:d383e2dee0f7, 2020-07-06 (annotated)
- Committer:
- ommpy
- Date:
- Mon Jul 06 17:18:59 2020 +0530
- Revision:
- 0:d383e2dee0f7
first commit
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
ommpy | 0:d383e2dee0f7 | 1 | /* mbed Microcontroller Library |
ommpy | 0:d383e2dee0f7 | 2 | * Copyright (c) 2006-2013 ARM Limited |
ommpy | 0:d383e2dee0f7 | 3 | * SPDX-License-Identifier: Apache-2.0 |
ommpy | 0:d383e2dee0f7 | 4 | * |
ommpy | 0:d383e2dee0f7 | 5 | * Licensed under the Apache License, Version 2.0 (the "License"); |
ommpy | 0:d383e2dee0f7 | 6 | * you may not use this file except in compliance with the License. |
ommpy | 0:d383e2dee0f7 | 7 | * You may obtain a copy of the License at |
ommpy | 0:d383e2dee0f7 | 8 | * |
ommpy | 0:d383e2dee0f7 | 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
ommpy | 0:d383e2dee0f7 | 10 | * |
ommpy | 0:d383e2dee0f7 | 11 | * Unless required by applicable law or agreed to in writing, software |
ommpy | 0:d383e2dee0f7 | 12 | * distributed under the License is distributed on an "AS IS" BASIS, |
ommpy | 0:d383e2dee0f7 | 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
ommpy | 0:d383e2dee0f7 | 14 | * See the License for the specific language governing permissions and |
ommpy | 0:d383e2dee0f7 | 15 | * limitations under the License. |
ommpy | 0:d383e2dee0f7 | 16 | */ |
ommpy | 0:d383e2dee0f7 | 17 | #ifndef PLATFORM_MUTEX_H |
ommpy | 0:d383e2dee0f7 | 18 | #define PLATFORM_MUTEX_H |
ommpy | 0:d383e2dee0f7 | 19 | |
ommpy | 0:d383e2dee0f7 | 20 | #include "platform/NonCopyable.h" |
ommpy | 0:d383e2dee0f7 | 21 | |
ommpy | 0:d383e2dee0f7 | 22 | /** \addtogroup platform |
ommpy | 0:d383e2dee0f7 | 23 | * @{ |
ommpy | 0:d383e2dee0f7 | 24 | */ |
ommpy | 0:d383e2dee0f7 | 25 | |
ommpy | 0:d383e2dee0f7 | 26 | /** \defgroup platform_PlatformMutex PlatformMutex class |
ommpy | 0:d383e2dee0f7 | 27 | * @{ |
ommpy | 0:d383e2dee0f7 | 28 | */ |
ommpy | 0:d383e2dee0f7 | 29 | |
ommpy | 0:d383e2dee0f7 | 30 | /** The PlatformMutex class is used to synchronize the execution of threads. |
ommpy | 0:d383e2dee0f7 | 31 | * |
ommpy | 0:d383e2dee0f7 | 32 | * Mbed drivers use the PlatformMutex class instead of rtos::Mutex. |
ommpy | 0:d383e2dee0f7 | 33 | * This enables the use of drivers when the Mbed OS is compiled without the RTOS. |
ommpy | 0:d383e2dee0f7 | 34 | * |
ommpy | 0:d383e2dee0f7 | 35 | * @note |
ommpy | 0:d383e2dee0f7 | 36 | * - When the RTOS is present, the PlatformMutex becomes a typedef for rtos::Mutex. |
ommpy | 0:d383e2dee0f7 | 37 | * - When the RTOS is absent, all methods are defined as noop. |
ommpy | 0:d383e2dee0f7 | 38 | */ |
ommpy | 0:d383e2dee0f7 | 39 | |
ommpy | 0:d383e2dee0f7 | 40 | #ifdef MBED_CONF_RTOS_PRESENT |
ommpy | 0:d383e2dee0f7 | 41 | |
ommpy | 0:d383e2dee0f7 | 42 | #include "rtos/Mutex.h" |
ommpy | 0:d383e2dee0f7 | 43 | typedef rtos::Mutex PlatformMutex; |
ommpy | 0:d383e2dee0f7 | 44 | |
ommpy | 0:d383e2dee0f7 | 45 | #else |
ommpy | 0:d383e2dee0f7 | 46 | |
ommpy | 0:d383e2dee0f7 | 47 | class PlatformMutex: private mbed::NonCopyable<PlatformMutex> { |
ommpy | 0:d383e2dee0f7 | 48 | public: |
ommpy | 0:d383e2dee0f7 | 49 | /** Create a PlatformMutex object. |
ommpy | 0:d383e2dee0f7 | 50 | * |
ommpy | 0:d383e2dee0f7 | 51 | * @note When the RTOS is present, this is an alias for rtos::Mutex::Mutex(). |
ommpy | 0:d383e2dee0f7 | 52 | */ |
ommpy | 0:d383e2dee0f7 | 53 | PlatformMutex() |
ommpy | 0:d383e2dee0f7 | 54 | { |
ommpy | 0:d383e2dee0f7 | 55 | } |
ommpy | 0:d383e2dee0f7 | 56 | |
ommpy | 0:d383e2dee0f7 | 57 | /** PlatformMutex destructor. |
ommpy | 0:d383e2dee0f7 | 58 | * |
ommpy | 0:d383e2dee0f7 | 59 | * @note When the RTOS is present, this is an alias for rtos::Mutex::~Mutex(). |
ommpy | 0:d383e2dee0f7 | 60 | */ |
ommpy | 0:d383e2dee0f7 | 61 | ~PlatformMutex() |
ommpy | 0:d383e2dee0f7 | 62 | { |
ommpy | 0:d383e2dee0f7 | 63 | } |
ommpy | 0:d383e2dee0f7 | 64 | |
ommpy | 0:d383e2dee0f7 | 65 | /** Wait until a PlatformMutex becomes available. |
ommpy | 0:d383e2dee0f7 | 66 | * |
ommpy | 0:d383e2dee0f7 | 67 | * @note |
ommpy | 0:d383e2dee0f7 | 68 | * - When the RTOS is present, this is an alias for rtos::Mutex::lock(). |
ommpy | 0:d383e2dee0f7 | 69 | * - When the RTOS is absent, this is a noop. |
ommpy | 0:d383e2dee0f7 | 70 | */ |
ommpy | 0:d383e2dee0f7 | 71 | void lock() |
ommpy | 0:d383e2dee0f7 | 72 | { |
ommpy | 0:d383e2dee0f7 | 73 | } |
ommpy | 0:d383e2dee0f7 | 74 | |
ommpy | 0:d383e2dee0f7 | 75 | /** Unlock a PlatformMutex that the same thread has previously locked. |
ommpy | 0:d383e2dee0f7 | 76 | * |
ommpy | 0:d383e2dee0f7 | 77 | * @note |
ommpy | 0:d383e2dee0f7 | 78 | * - When the RTOS is present, this is an alias for rtos::Mutex::unlock(). |
ommpy | 0:d383e2dee0f7 | 79 | * - When the RTOS is absent, this is a noop. |
ommpy | 0:d383e2dee0f7 | 80 | */ |
ommpy | 0:d383e2dee0f7 | 81 | void unlock() |
ommpy | 0:d383e2dee0f7 | 82 | { |
ommpy | 0:d383e2dee0f7 | 83 | } |
ommpy | 0:d383e2dee0f7 | 84 | }; |
ommpy | 0:d383e2dee0f7 | 85 | |
ommpy | 0:d383e2dee0f7 | 86 | #endif |
ommpy | 0:d383e2dee0f7 | 87 | |
ommpy | 0:d383e2dee0f7 | 88 | #endif |
ommpy | 0:d383e2dee0f7 | 89 | |
ommpy | 0:d383e2dee0f7 | 90 | /**@}*/ |
ommpy | 0:d383e2dee0f7 | 91 | |
ommpy | 0:d383e2dee0f7 | 92 | /**@}*/ |