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