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@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

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