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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/**
* @file os_mutex.c
* @author ALLWINNERTECH IOT WLAN Team
*/
/*
* Copyright (C) 2017 ALLWINNERTECH TECHNOLOGY CO., LTD. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of ALLWINNERTECH TECHNOLOGY CO., LTD. nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "os_mutex.h"
#include "os_util.h"
/**
* @brief Create and initialize a mutex object
* @note A mutex can only be locked by a single thread at any given time.
* @param[in] mutex Pointer to the mutex object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_MutexCreate(OS_Mutex_t *mutex)
{
OS_HANDLE_ASSERT(!OS_MutexIsValid(mutex), mutex->handle);
mutex->handle = xSemaphoreCreateMutex();
if (mutex->handle == NULL) {
OS_ERR("err %"OS_HANDLE_F"\n", mutex->handle);
return OS_FAIL;
}
return OS_OK;
}
/**
* @brief Delete the mutex object
* @param[in] mutex Pointer to the mutex object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_MutexDelete(OS_Mutex_t *mutex)
{
OS_HANDLE_ASSERT(OS_MutexIsValid(mutex), mutex->handle);
vSemaphoreDelete(mutex->handle);
OS_MutexSetInvalid(mutex);
return OS_OK;
}
/**
* @brief Lock the mutex object
* @note A mutex can only be locked by a single thread at any given time. If
* the mutex is already locked, the caller will be blocked for the
* specified time duration.
* @param[in] mutex Pointer to the mutex object
* @param[in] waitMS The maximum amount of time (in millisecond) the thread
* should remain in the blocked state to wait for the mutex
* to become unlocked.
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_MutexLock(OS_Mutex_t *mutex, OS_Time_t waitMS)
{
BaseType_t ret;
OS_HANDLE_ASSERT(OS_MutexIsValid(mutex), mutex->handle);
ret = xSemaphoreTake(mutex->handle, OS_CalcWaitTicks(waitMS));
if (ret != pdPASS) {
OS_DBG("%s() fail @ %d, %"OS_TIME_F" ms\n", __func__, __LINE__, waitMS);
return OS_FAIL;
}
return OS_OK;
}
/**
* @brief Unlock the mutex object previously locked using OS_MutexLock()
* @note The mutex should be unlocked from the same thread context from which
* it was locked.
* @param[in] mutex Pointer to the mutex object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_MutexUnlock(OS_Mutex_t *mutex)
{
BaseType_t ret;
OS_HANDLE_ASSERT(OS_MutexIsValid(mutex), mutex->handle);
ret = xSemaphoreGive(mutex->handle);
if (ret != pdPASS) {
OS_DBG("%s() fail @ %d\n", __func__, __LINE__);
return OS_FAIL;
}
return OS_OK;
}
/**
* @brief Create and initialize a recursive mutex object
* @note A recursive mutex can be locked repeatedly by one single thread.
* The mutex doesn't become available again until the owner has called
* OS_RecursiveMutexUnlock() for each successful OS_RecursiveMutexLock().
* @param[in] mutex Pointer to the recursive mutex object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_RecursiveMutexCreate(OS_Mutex_t *mutex)
{
OS_HANDLE_ASSERT(!OS_MutexIsValid(mutex), mutex->handle);
mutex->handle = xSemaphoreCreateRecursiveMutex();
if (mutex->handle == NULL) {
OS_ERR("err %"OS_HANDLE_F"\n", mutex->handle);
return OS_FAIL;
}
return OS_OK;
}
/**
* @brief Lock the recursive mutex object
* @note A recursive mutex can be locked repeatedly by one single thread.
* If the recursive mutex is already locked by other thread, the caller
* will be blocked for the specified time duration.
* @param[in] mutex Pointer to the recursive mutex object
* @param[in] waitMS The maximum amount of time (in millisecond) the thread
* should remain in the blocked state to wait for the
* recursive mutex to become unlocked.
* OS_WAIT_FOREVER for waiting forever, zero for no waiting.
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_RecursiveMutexLock(OS_Mutex_t *mutex, OS_Time_t waitMS)
{
BaseType_t ret;
OS_HANDLE_ASSERT(OS_MutexIsValid(mutex), mutex->handle);
ret = xSemaphoreTakeRecursive(mutex->handle, OS_CalcWaitTicks(waitMS));
if (ret != pdPASS) {
OS_DBG("%s() fail @ %d, %"OS_TIME_F" ms\n", __func__, __LINE__, waitMS);
return OS_FAIL;
}
return OS_OK;
}
/**
* @brief Unlock the recursive mutex object previously locked using
* OS_RecursiveMutexLock()
* @note The recursive mutex should be unlocked from the same thread context
* from which it was locked.
* @param[in] mutex Pointer to the mutex object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_RecursiveMutexUnlock(OS_Mutex_t *mutex)
{
BaseType_t ret;
OS_HANDLE_ASSERT(OS_MutexIsValid(mutex), mutex->handle);
ret = xSemaphoreGiveRecursive(mutex->handle);
if (ret != pdPASS) {
OS_DBG("%s() fail @ %d\n", __func__, __LINE__);
return OS_FAIL;
}
return OS_OK;
}
|
