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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/**
* @file os_timer.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_timer.h"
#include "os_util.h"
/* TODO: what block time should be used ? */
#define OS_TIMER_WAIT_FOREVER portMAX_DELAY
#define OS_TIMER_WAIT_NONE 0
#if OS_TIMER_USE_FREERTOS_ORIG_CALLBACK
static void OS_TimerPrivCallback(TimerHandle_t xTimer)
{
OS_TimerCallbackData_t *priv;
priv = pvTimerGetTimerID(xTimer);
if (priv && priv->callback) {
priv->callback(priv->argument);
} else {
OS_WRN("Invalid timer callback\n");
}
}
/**
* @brief Create and initialize a timer object
*
* @note Creating a timer does not start the timer running. The OS_TimerStart()
* and OS_TimerChangePeriod() API functions can all be used to start the
* timer running.
*
* @param[in] timer Pointer to the timer object
* @param[in] type Timer type
* @param[in] cb Timer expire callback function
* @param[in] arg Argument of Timer expire callback function
* @param[in] periodMS Timer period in milliseconds
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerCreate(OS_Timer_t *timer, OS_TimerType type,
OS_TimerCallback_t cb, void *arg, uint32_t periodMS)
{
OS_TimerCallbackData_t *priv;
OS_HANDLE_ASSERT(!OS_TimerIsValid(timer), timer->handle);
priv = OS_Malloc(sizeof(OS_TimerCallbackData_t));
if (priv == NULL) {
return OS_E_NOMEM;
}
priv->callback = cb;
priv->argument = arg;
timer->handle = xTimerCreate("",
OS_MSecsToTicks(periodMS),
type == OS_TIMER_PERIODIC ? pdTRUE : pdFALSE,
priv,
OS_TimerPrivCallback);
if (timer->handle == NULL) {
OS_ERR("err %"OS_HANDLE_F"\n", timer->handle);
OS_Free(priv);
return OS_FAIL;
}
timer->priv = priv;
return OS_OK;
}
#else /* OS_TIMER_USE_FREERTOS_ORIG_CALLBACK */
/**
* @brief Create and initialize a timer object
*
* @note Creating a timer does not start the timer running. The OS_TimerStart()
* and OS_TimerChangePeriod() API functions can all be used to start the
* timer running.
*
* @param[in] timer Pointer to the timer object
* @param[in] type Timer type
* @param[in] cb Timer expire callback function
* @param[in] arg Argument of timer expire callback function
* @param[in] periodMS Timer period in milliseconds
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerCreate(OS_Timer_t *timer, OS_TimerType type,
OS_TimerCallback_t cb, void *arg, uint32_t periodMS)
{
OS_HANDLE_ASSERT(!OS_TimerIsValid(timer), timer->handle);
timer->handle = xTimerCreate("",
OS_MSecsToTicks(periodMS),
type == OS_TIMER_PERIODIC ? pdTRUE : pdFALSE,
arg,
cb);
if (timer->handle == NULL) {
OS_ERR("err %"OS_HANDLE_F"\n", timer->handle);
return OS_FAIL;
}
return OS_OK;
}
#endif /* OS_TIMER_USE_FREERTOS_ORIG_CALLBACK */
/**
* @brief Delete the timer object
* @param[in] timer Pointer to the timer object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerDelete(OS_Timer_t *timer)
{
BaseType_t ret;
OS_HANDLE_ASSERT(OS_TimerIsValid(timer), timer->handle);
ret = xTimerDelete(timer->handle, OS_TIMER_WAIT_FOREVER);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
OS_TimerSetInvalid(timer);
#if OS_TIMER_USE_FREERTOS_ORIG_CALLBACK
OS_Free(timer->priv);
timer->priv = NULL;
#endif
return OS_OK;
}
/**
* @brief Start a timer running.
* @note If the timer is already running, this function will re-start the timer.
* @param[in] timer Pointer to the timer object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerStart(OS_Timer_t *timer)
{
BaseType_t ret;
BaseType_t taskWoken;
OS_HANDLE_ASSERT(OS_TimerIsValid(timer), timer->handle);
if (OS_IsISRContext()) {
taskWoken = pdFALSE;
ret = xTimerStartFromISR(timer->handle, &taskWoken);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
portEND_SWITCHING_ISR(taskWoken);
} else {
ret = xTimerStart(timer->handle, OS_TIMER_WAIT_NONE);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
}
return OS_OK;
}
/**
* @brief Change the period of a timer
*
* If OS_TimerChangePeriod() is used to change the period of a timer that is
* already running, then the timer will use the new period value to recalculate
* its expiry time. The recalculated expiry time will then be relative to when
* OS_TimerChangePeriod() was called, and not relative to when the timer was
* originally started.
* If OS_TimerChangePeriod() is used to change the period of a timer that is
* not already running, then the timer will use the new period value to
* calculate an expiry time, and the timer will start running.
*
* @param[in] timer Pointer to the timer object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerChangePeriod(OS_Timer_t *timer, uint32_t periodMS)
{
BaseType_t ret;
BaseType_t taskWoken;
OS_HANDLE_ASSERT(OS_TimerIsValid(timer), timer->handle);
if (OS_IsISRContext()) {
taskWoken = pdFALSE;
ret = xTimerChangePeriodFromISR(timer->handle, periodMS, &taskWoken);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
portEND_SWITCHING_ISR(taskWoken);
} else {
ret = xTimerChangePeriod(timer->handle, periodMS, OS_TIMER_WAIT_NONE);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
}
return OS_OK;
}
/**
* @brief Stop a timer running.
* @param[in] timer Pointer to the timer object
* @retval OS_Status, OS_OK on success
*/
OS_Status OS_TimerStop(OS_Timer_t *timer)
{
BaseType_t ret;
BaseType_t taskWoken;
OS_HANDLE_ASSERT(OS_TimerIsValid(timer), timer->handle);
if (OS_IsISRContext()) {
taskWoken = pdFALSE;
ret = xTimerStopFromISR(timer->handle, &taskWoken);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
portEND_SWITCHING_ISR(taskWoken);
} else {
ret = xTimerStop(timer->handle, OS_TIMER_WAIT_FOREVER);
if (ret != pdPASS) {
OS_ERR("err %"OS_BASETYPE_F"\n", ret);
return OS_FAIL;
}
}
return OS_OK;
}
|
