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