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/PlatformMutex.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

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