]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/timers.c
96d22615d5e2f749a3fc19a7eeafb7c5101b43ee
[freertos] / FreeRTOS / Source / timers.c
1 /*\r
2     FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.\r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     This file is part of the FreeRTOS distribution.\r
8 \r
9     FreeRTOS is free software; you can redistribute it and/or modify it under\r
10     the terms of the GNU General Public License (version 2) as published by the\r
11     Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.\r
12 \r
13     ***************************************************************************\r
14     >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
15     >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
16     >>!   obliged to provide the source code for proprietary components     !<<\r
17     >>!   outside of the FreeRTOS kernel.                                   !<<\r
18     ***************************************************************************\r
19 \r
20     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
21     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
22     FOR A PARTICULAR PURPOSE.  Full license text is available on the following\r
23     link: http://www.freertos.org/a00114.html\r
24 \r
25     ***************************************************************************\r
26      *                                                                       *\r
27      *    FreeRTOS provides completely free yet professionally developed,    *\r
28      *    robust, strictly quality controlled, supported, and cross          *\r
29      *    platform software that is more than just the market leader, it     *\r
30      *    is the industry's de facto standard.                               *\r
31      *                                                                       *\r
32      *    Help yourself get started quickly while simultaneously helping     *\r
33      *    to support the FreeRTOS project by purchasing a FreeRTOS           *\r
34      *    tutorial book, reference manual, or both:                          *\r
35      *    http://www.FreeRTOS.org/Documentation                              *\r
36      *                                                                       *\r
37     ***************************************************************************\r
38 \r
39     http://www.FreeRTOS.org/FAQHelp.html - Having a problem?  Start by reading\r
40     the FAQ page "My application does not run, what could be wrong?".  Have you\r
41     defined configASSERT()?\r
42 \r
43     http://www.FreeRTOS.org/support - In return for receiving this top quality\r
44     embedded software for free we request you assist our global community by\r
45     participating in the support forum.\r
46 \r
47     http://www.FreeRTOS.org/training - Investing in training allows your team to\r
48     be as productive as possible as early as possible.  Now you can receive\r
49     FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers\r
50     Ltd, and the world's leading authority on the world's leading RTOS.\r
51 \r
52     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
53     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
54     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
55 \r
56     http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.\r
57     Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.\r
58 \r
59     http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High\r
60     Integrity Systems ltd. to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
61     licenses offer ticketed support, indemnification and commercial middleware.\r
62 \r
63     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
64     engineered and independently SIL3 certified version for use in safety and\r
65     mission critical applications that require provable dependability.\r
66 \r
67     1 tab == 4 spaces!\r
68 */\r
69 \r
70 /* Standard includes. */\r
71 #include <stdlib.h>\r
72 \r
73 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
74 all the API functions to use the MPU wrappers.  That should only be done when\r
75 task.h is included from an application file. */\r
76 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
77 \r
78 #include "FreeRTOS.h"\r
79 #include "task.h"\r
80 #include "queue.h"\r
81 #include "timers.h"\r
82 \r
83 #if ( INCLUDE_xTimerPendFunctionCall == 1 ) && ( configUSE_TIMERS == 0 )\r
84         #error configUSE_TIMERS must be set to 1 to make the xTimerPendFunctionCall() function available.\r
85 #endif\r
86 \r
87 /* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
88 MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
89 header files above, but not in this file, in order to generate the correct\r
90 privileged Vs unprivileged linkage and placement. */\r
91 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
92 \r
93 \r
94 /* This entire source file will be skipped if the application is not configured\r
95 to include software timer functionality.  This #if is closed at the very bottom\r
96 of this file.  If you want to include software timer functionality then ensure\r
97 configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
98 #if ( configUSE_TIMERS == 1 )\r
99 \r
100 /* Misc definitions. */\r
101 #define tmrNO_DELAY             ( TickType_t ) 0U\r
102 \r
103 /* The definition of the timers themselves. */\r
104 typedef struct tmrTimerControl\r
105 {\r
106         const char                              *pcTimerName;           /*<< Text name.  This is not used by the kernel, it is included simply to make debugging easier. */ /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
107         ListItem_t                              xTimerListItem;         /*<< Standard linked list item as used by all kernel features for event management. */\r
108         TickType_t                              xTimerPeriodInTicks;/*<< How quickly and often the timer expires. */\r
109         UBaseType_t                             uxAutoReload;           /*<< Set to pdTRUE if the timer should be automatically restarted once expired.  Set to pdFALSE if the timer is, in effect, a one-shot timer. */\r
110         void                                    *pvTimerID;                     /*<< An ID to identify the timer.  This allows the timer to be identified when the same callback is used for multiple timers. */\r
111         TimerCallbackFunction_t pxCallbackFunction;     /*<< The function that will be called when the timer expires. */\r
112         #if( configUSE_TRACE_FACILITY == 1 )\r
113                 UBaseType_t                     uxTimerNumber;          /*<< An ID assigned by trace tools such as FreeRTOS+Trace */\r
114         #endif\r
115 \r
116         #if( ( configSUPPORT_STATIC_ALLOCATION == 1 ) && ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) )\r
117                 uint8_t                         ucStaticallyAllocated; /*<< Set to pdTRUE if the timer was created statically so no attempt is made to free the memory again if the timer is later deleted. */\r
118         #endif\r
119 } xTIMER;\r
120 \r
121 /* The old xTIMER name is maintained above then typedefed to the new Timer_t\r
122 name below to enable the use of older kernel aware debuggers. */\r
123 typedef xTIMER Timer_t;\r
124 \r
125 /* The definition of messages that can be sent and received on the timer queue.\r
126 Two types of message can be queued - messages that manipulate a software timer,\r
127 and messages that request the execution of a non-timer related callback.  The\r
128 two message types are defined in two separate structures, xTimerParametersType\r
129 and xCallbackParametersType respectively. */\r
130 typedef struct tmrTimerParameters\r
131 {\r
132         TickType_t                      xMessageValue;          /*<< An optional value used by a subset of commands, for example, when changing the period of a timer. */\r
133         Timer_t *                       pxTimer;                        /*<< The timer to which the command will be applied. */\r
134 } TimerParameter_t;\r
135 \r
136 \r
137 typedef struct tmrCallbackParameters\r
138 {\r
139         PendedFunction_t        pxCallbackFunction;     /* << The callback function to execute. */\r
140         void *pvParameter1;                                             /* << The value that will be used as the callback functions first parameter. */\r
141         uint32_t ulParameter2;                                  /* << The value that will be used as the callback functions second parameter. */\r
142 } CallbackParameters_t;\r
143 \r
144 /* The structure that contains the two message types, along with an identifier\r
145 that is used to determine which message type is valid. */\r
146 typedef struct tmrTimerQueueMessage\r
147 {\r
148         BaseType_t                      xMessageID;                     /*<< The command being sent to the timer service task. */\r
149         union\r
150         {\r
151                 TimerParameter_t xTimerParameters;\r
152 \r
153                 /* Don't include xCallbackParameters if it is not going to be used as\r
154                 it makes the structure (and therefore the timer queue) larger. */\r
155                 #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
156                         CallbackParameters_t xCallbackParameters;\r
157                 #endif /* INCLUDE_xTimerPendFunctionCall */\r
158         } u;\r
159 } DaemonTaskMessage_t;\r
160 \r
161 /*lint -e956 A manual analysis and inspection has been used to determine which\r
162 static variables must be declared volatile. */\r
163 \r
164 /* The list in which active timers are stored.  Timers are referenced in expire\r
165 time order, with the nearest expiry time at the front of the list.  Only the\r
166 timer service task is allowed to access these lists. */\r
167 PRIVILEGED_DATA static List_t xActiveTimerList1;\r
168 PRIVILEGED_DATA static List_t xActiveTimerList2;\r
169 PRIVILEGED_DATA static List_t *pxCurrentTimerList;\r
170 PRIVILEGED_DATA static List_t *pxOverflowTimerList;\r
171 \r
172 /* A queue that is used to send commands to the timer service task. */\r
173 PRIVILEGED_DATA static QueueHandle_t xTimerQueue = NULL;\r
174 PRIVILEGED_DATA static TaskHandle_t xTimerTaskHandle = NULL;\r
175 \r
176 /*lint +e956 */\r
177 \r
178 /*-----------------------------------------------------------*/\r
179 \r
180 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
181 \r
182         /* If static allocation is supported then the application must provide the\r
183         following callback function - which enables the application to optionally\r
184         provide the memory that will be used by the timer task as the task's stack\r
185         and TCB. */\r
186         extern void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize );\r
187 \r
188 #endif\r
189 \r
190 /*\r
191  * Initialise the infrastructure used by the timer service task if it has not\r
192  * been initialised already.\r
193  */\r
194 static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
195 \r
196 /*\r
197  * The timer service task (daemon).  Timer functionality is controlled by this\r
198  * task.  Other tasks communicate with the timer service task using the\r
199  * xTimerQueue queue.\r
200  */\r
201 static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
202 \r
203 /*\r
204  * Called by the timer service task to interpret and process a command it\r
205  * received on the timer queue.\r
206  */\r
207 static void prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
208 \r
209 /*\r
210  * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
211  * depending on if the expire time causes a timer counter overflow.\r
212  */\r
213 static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime ) PRIVILEGED_FUNCTION;\r
214 \r
215 /*\r
216  * An active timer has reached its expire time.  Reload the timer if it is an\r
217  * auto reload timer, then call its callback.\r
218  */\r
219 static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow ) PRIVILEGED_FUNCTION;\r
220 \r
221 /*\r
222  * The tick count has overflowed.  Switch the timer lists after ensuring the\r
223  * current timer list does not still reference some timers.\r
224  */\r
225 static void prvSwitchTimerLists( void ) PRIVILEGED_FUNCTION;\r
226 \r
227 /*\r
228  * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
229  * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
230  */\r
231 static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
232 \r
233 /*\r
234  * If the timer list contains any active timers then return the expire time of\r
235  * the timer that will expire first and set *pxListWasEmpty to false.  If the\r
236  * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
237  * to pdTRUE.\r
238  */\r
239 static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
240 \r
241 /*\r
242  * If a timer has expired, process it.  Otherwise, block the timer service task\r
243  * until either a timer does expire or a command is received.\r
244  */\r
245 static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty ) PRIVILEGED_FUNCTION;\r
246 \r
247 /*\r
248  * Called after a Timer_t structure has been allocated either statically or\r
249  * dynamically to fill in the structure's members.\r
250  */\r
251 static void prvInitialiseNewTimer( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, Timer_t *pxNewTimer ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
252 /*-----------------------------------------------------------*/\r
253 \r
254 BaseType_t xTimerCreateTimerTask( void )\r
255 {\r
256 BaseType_t xReturn = pdFAIL;\r
257 \r
258         /* This function is called when the scheduler is started if\r
259         configUSE_TIMERS is set to 1.  Check that the infrastructure used by the\r
260         timer service task has been created/initialised.  If timers have already\r
261         been created then the initialisation will already have been performed. */\r
262         prvCheckForValidListAndQueue();\r
263 \r
264         if( xTimerQueue != NULL )\r
265         {\r
266 \r
267                 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
268                 {\r
269                         StaticTask_t *pxTimerTaskTCBBuffer = NULL;\r
270                         StackType_t *pxTimerTaskStackBuffer = NULL;\r
271                         uint32_t ulTimerTaskStackSize;\r
272 \r
273                         vApplicationGetTimerTaskMemory( &pxTimerTaskTCBBuffer, &pxTimerTaskStackBuffer, &ulTimerTaskStackSize );\r
274                         xTimerTaskHandle = xTaskCreateStatic( prvTimerTask, "Tmr Svc", ulTimerTaskStackSize, NULL, ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, pxTimerTaskStackBuffer, pxTimerTaskTCBBuffer );\r
275 \r
276                         if( xTimerTaskHandle != NULL )\r
277                         {\r
278                                 xReturn = pdPASS;\r
279                         }\r
280                 }\r
281                 #else\r
282                 {\r
283                         xReturn = xTaskCreate( prvTimerTask, "Tmr Svc", configTIMER_TASK_STACK_DEPTH, NULL, ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, &xTimerTaskHandle );\r
284                 }\r
285                 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
286         }\r
287         else\r
288         {\r
289                 mtCOVERAGE_TEST_MARKER();\r
290         }\r
291 \r
292         configASSERT( xReturn );\r
293         return xReturn;\r
294 }\r
295 /*-----------------------------------------------------------*/\r
296 \r
297 #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
298 \r
299         TimerHandle_t xTimerCreate( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
300         {\r
301         Timer_t *pxNewTimer;\r
302 \r
303                 pxNewTimer = ( Timer_t * ) pvPortMalloc( sizeof( Timer_t ) );\r
304 \r
305                 if( pxNewTimer != NULL )\r
306                 {\r
307                         prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
308 \r
309                         #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
310                         {\r
311                                 /* Timers can be created statically or dynamically, so note this\r
312                                 timer was created dynamically in case the timer is later\r
313                                 deleted. */\r
314                                 pxNewTimer->ucStaticallyAllocated = pdFALSE;\r
315                         }\r
316                         #endif /* configSUPPORT_STATIC_ALLOCATION */\r
317                 }\r
318 \r
319                 return pxNewTimer;\r
320         }\r
321 \r
322 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
323 /*-----------------------------------------------------------*/\r
324 \r
325 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
326 \r
327         TimerHandle_t xTimerCreateStatic( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, StaticTimer_t *pxTimerBuffer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
328         {\r
329         Timer_t *pxNewTimer;\r
330 \r
331                 #if( configASSERT_DEFINED == 1 )\r
332                 {\r
333                         /* Sanity check that the size of the structure used to declare a\r
334                         variable of type StaticTimer_t equals the size of the real timer\r
335                         structures. */\r
336                         volatile size_t xSize = sizeof( StaticTimer_t );\r
337                         configASSERT( xSize == sizeof( Timer_t ) );\r
338                 }\r
339                 #endif /* configASSERT_DEFINED */\r
340 \r
341                 /* A pointer to a StaticTimer_t structure MUST be provided, use it. */\r
342                 configASSERT( pxTimerBuffer );\r
343                 pxNewTimer = ( Timer_t * ) pxTimerBuffer; /*lint !e740 Unusual cast is ok as the structures are designed to have the same alignment, and the size is checked by an assert. */\r
344 \r
345                 if( pxNewTimer != NULL )\r
346                 {\r
347                         prvInitialiseNewTimer( pcTimerName, xTimerPeriodInTicks, uxAutoReload, pvTimerID, pxCallbackFunction, pxNewTimer );\r
348 \r
349                         #if( configSUPPORT_DYNAMIC_ALLOCATION == 1 )\r
350                         {\r
351                                 /* Timers can be created statically or dynamically so note this\r
352                                 timer was created statically in case it is later deleted. */\r
353                                 pxNewTimer->ucStaticallyAllocated = pdTRUE;\r
354                         }\r
355                         #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
356                 }\r
357 \r
358                 return pxNewTimer;\r
359         }\r
360 \r
361 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
362 /*-----------------------------------------------------------*/\r
363 \r
364 static void prvInitialiseNewTimer( const char * const pcTimerName, const TickType_t xTimerPeriodInTicks, const UBaseType_t uxAutoReload, void * const pvTimerID, TimerCallbackFunction_t pxCallbackFunction, Timer_t *pxNewTimer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
365 {\r
366         /* 0 is not a valid value for xTimerPeriodInTicks. */\r
367         configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
368 \r
369         if( pxNewTimer != NULL )\r
370         {\r
371                 /* Ensure the infrastructure used by the timer service task has been\r
372                 created/initialised. */\r
373                 prvCheckForValidListAndQueue();\r
374 \r
375                 /* Initialise the timer structure members using the function\r
376                 parameters. */\r
377                 pxNewTimer->pcTimerName = pcTimerName;\r
378                 pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
379                 pxNewTimer->uxAutoReload = uxAutoReload;\r
380                 pxNewTimer->pvTimerID = pvTimerID;\r
381                 pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
382                 vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
383                 traceTIMER_CREATE( pxNewTimer );\r
384         }\r
385 }\r
386 /*-----------------------------------------------------------*/\r
387 \r
388 BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait )\r
389 {\r
390 BaseType_t xReturn = pdFAIL;\r
391 DaemonTaskMessage_t xMessage;\r
392 \r
393         configASSERT( xTimer );\r
394 \r
395         /* Send a message to the timer service task to perform a particular action\r
396         on a particular timer definition. */\r
397         if( xTimerQueue != NULL )\r
398         {\r
399                 /* Send a command to the timer service task to start the xTimer timer. */\r
400                 xMessage.xMessageID = xCommandID;\r
401                 xMessage.u.xTimerParameters.xMessageValue = xOptionalValue;\r
402                 xMessage.u.xTimerParameters.pxTimer = ( Timer_t * ) xTimer;\r
403 \r
404                 if( xCommandID < tmrFIRST_FROM_ISR_COMMAND )\r
405                 {\r
406                         if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
407                         {\r
408                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
409                         }\r
410                         else\r
411                         {\r
412                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
413                         }\r
414                 }\r
415                 else\r
416                 {\r
417                         xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
418                 }\r
419 \r
420                 traceTIMER_COMMAND_SEND( xTimer, xCommandID, xOptionalValue, xReturn );\r
421         }\r
422         else\r
423         {\r
424                 mtCOVERAGE_TEST_MARKER();\r
425         }\r
426 \r
427         return xReturn;\r
428 }\r
429 /*-----------------------------------------------------------*/\r
430 \r
431 TaskHandle_t xTimerGetTimerDaemonTaskHandle( void )\r
432 {\r
433         /* If xTimerGetTimerDaemonTaskHandle() is called before the scheduler has been\r
434         started, then xTimerTaskHandle will be NULL. */\r
435         configASSERT( ( xTimerTaskHandle != NULL ) );\r
436         return xTimerTaskHandle;\r
437 }\r
438 /*-----------------------------------------------------------*/\r
439 \r
440 TickType_t xTimerGetPeriod( TimerHandle_t xTimer )\r
441 {\r
442 Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
443 \r
444         configASSERT( xTimer );\r
445         return pxTimer->xTimerPeriodInTicks;\r
446 }\r
447 /*-----------------------------------------------------------*/\r
448 \r
449 TickType_t xTimerGetExpiryTime( TimerHandle_t xTimer )\r
450 {\r
451 Timer_t * pxTimer = ( Timer_t * ) xTimer;\r
452 TickType_t xReturn;\r
453 \r
454         configASSERT( xTimer );\r
455         xReturn = listGET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ) );\r
456         return xReturn;\r
457 }\r
458 /*-----------------------------------------------------------*/\r
459 \r
460 const char * pcTimerGetName( TimerHandle_t xTimer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
461 {\r
462 Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
463 \r
464         configASSERT( xTimer );\r
465         return pxTimer->pcTimerName;\r
466 }\r
467 /*-----------------------------------------------------------*/\r
468 \r
469 static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow )\r
470 {\r
471 BaseType_t xResult;\r
472 Timer_t * const pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
473 \r
474         /* Remove the timer from the list of active timers.  A check has already\r
475         been performed to ensure the list is not empty. */\r
476         ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
477         traceTIMER_EXPIRED( pxTimer );\r
478 \r
479         /* If the timer is an auto reload timer then calculate the next\r
480         expiry time and re-insert the timer in the list of active timers. */\r
481         if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
482         {\r
483                 /* The timer is inserted into a list using a time relative to anything\r
484                 other than the current time.  It will therefore be inserted into the\r
485                 correct list relative to the time this task thinks it is now. */\r
486                 if( prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow, xNextExpireTime ) != pdFALSE )\r
487                 {\r
488                         /* The timer expired before it was added to the active timer\r
489                         list.  Reload it now.  */\r
490                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
491                         configASSERT( xResult );\r
492                         ( void ) xResult;\r
493                 }\r
494                 else\r
495                 {\r
496                         mtCOVERAGE_TEST_MARKER();\r
497                 }\r
498         }\r
499         else\r
500         {\r
501                 mtCOVERAGE_TEST_MARKER();\r
502         }\r
503 \r
504         /* Call the timer callback. */\r
505         pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
506 }\r
507 /*-----------------------------------------------------------*/\r
508 \r
509 static void prvTimerTask( void *pvParameters )\r
510 {\r
511 TickType_t xNextExpireTime;\r
512 BaseType_t xListWasEmpty;\r
513 \r
514         /* Just to avoid compiler warnings. */\r
515         ( void ) pvParameters;\r
516 \r
517         #if( configUSE_DAEMON_TASK_STARTUP_HOOK == 1 )\r
518         {\r
519                 extern void vApplicationDaemonTaskStartupHook( void );\r
520 \r
521                 /* Allow the application writer to execute some code in the context of\r
522                 this task at the point the task starts executing.  This is useful if the\r
523                 application includes initialisation code that would benefit from\r
524                 executing after the scheduler has been started. */\r
525                 vApplicationDaemonTaskStartupHook();\r
526         }\r
527         #endif /* configUSE_DAEMON_TASK_STARTUP_HOOK */\r
528 \r
529         for( ;; )\r
530         {\r
531                 /* Query the timers list to see if it contains any timers, and if so,\r
532                 obtain the time at which the next timer will expire. */\r
533                 xNextExpireTime = prvGetNextExpireTime( &xListWasEmpty );\r
534 \r
535                 /* If a timer has expired, process it.  Otherwise, block this task\r
536                 until either a timer does expire, or a command is received. */\r
537                 prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
538 \r
539                 /* Empty the command queue. */\r
540                 prvProcessReceivedCommands();\r
541         }\r
542 }\r
543 /*-----------------------------------------------------------*/\r
544 \r
545 static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty )\r
546 {\r
547 TickType_t xTimeNow;\r
548 BaseType_t xTimerListsWereSwitched;\r
549 \r
550         vTaskSuspendAll();\r
551         {\r
552                 /* Obtain the time now to make an assessment as to whether the timer\r
553                 has expired or not.  If obtaining the time causes the lists to switch\r
554                 then don't process this timer as any timers that remained in the list\r
555                 when the lists were switched will have been processed within the\r
556                 prvSampleTimeNow() function. */\r
557                 xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
558                 if( xTimerListsWereSwitched == pdFALSE )\r
559                 {\r
560                         /* The tick count has not overflowed, has the timer expired? */\r
561                         if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
562                         {\r
563                                 ( void ) xTaskResumeAll();\r
564                                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
565                         }\r
566                         else\r
567                         {\r
568                                 /* The tick count has not overflowed, and the next expire\r
569                                 time has not been reached yet.  This task should therefore\r
570                                 block to wait for the next expire time or a command to be\r
571                                 received - whichever comes first.  The following line cannot\r
572                                 be reached unless xNextExpireTime > xTimeNow, except in the\r
573                                 case when the current timer list is empty. */\r
574                                 if( xListWasEmpty != pdFALSE )\r
575                                 {\r
576                                         /* The current timer list is empty - is the overflow list\r
577                                         also empty? */\r
578                                         xListWasEmpty = listLIST_IS_EMPTY( pxOverflowTimerList );\r
579                                 }\r
580 \r
581                                 vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ), xListWasEmpty );\r
582 \r
583                                 if( xTaskResumeAll() == pdFALSE )\r
584                                 {\r
585                                         /* Yield to wait for either a command to arrive, or the\r
586                                         block time to expire.  If a command arrived between the\r
587                                         critical section being exited and this yield then the yield\r
588                                         will not cause the task to block. */\r
589                                         portYIELD_WITHIN_API();\r
590                                 }\r
591                                 else\r
592                                 {\r
593                                         mtCOVERAGE_TEST_MARKER();\r
594                                 }\r
595                         }\r
596                 }\r
597                 else\r
598                 {\r
599                         ( void ) xTaskResumeAll();\r
600                 }\r
601         }\r
602 }\r
603 /*-----------------------------------------------------------*/\r
604 \r
605 static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty )\r
606 {\r
607 TickType_t xNextExpireTime;\r
608 \r
609         /* Timers are listed in expiry time order, with the head of the list\r
610         referencing the task that will expire first.  Obtain the time at which\r
611         the timer with the nearest expiry time will expire.  If there are no\r
612         active timers then just set the next expire time to 0.  That will cause\r
613         this task to unblock when the tick count overflows, at which point the\r
614         timer lists will be switched and the next expiry time can be\r
615         re-assessed.  */\r
616         *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
617         if( *pxListWasEmpty == pdFALSE )\r
618         {\r
619                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
620         }\r
621         else\r
622         {\r
623                 /* Ensure the task unblocks when the tick count rolls over. */\r
624                 xNextExpireTime = ( TickType_t ) 0U;\r
625         }\r
626 \r
627         return xNextExpireTime;\r
628 }\r
629 /*-----------------------------------------------------------*/\r
630 \r
631 static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched )\r
632 {\r
633 TickType_t xTimeNow;\r
634 PRIVILEGED_DATA static TickType_t xLastTime = ( TickType_t ) 0U; /*lint !e956 Variable is only accessible to one task. */\r
635 \r
636         xTimeNow = xTaskGetTickCount();\r
637 \r
638         if( xTimeNow < xLastTime )\r
639         {\r
640                 prvSwitchTimerLists();\r
641                 *pxTimerListsWereSwitched = pdTRUE;\r
642         }\r
643         else\r
644         {\r
645                 *pxTimerListsWereSwitched = pdFALSE;\r
646         }\r
647 \r
648         xLastTime = xTimeNow;\r
649 \r
650         return xTimeNow;\r
651 }\r
652 /*-----------------------------------------------------------*/\r
653 \r
654 static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime )\r
655 {\r
656 BaseType_t xProcessTimerNow = pdFALSE;\r
657 \r
658         listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
659         listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
660 \r
661         if( xNextExpiryTime <= xTimeNow )\r
662         {\r
663                 /* Has the expiry time elapsed between the command to start/reset a\r
664                 timer was issued, and the time the command was processed? */\r
665                 if( ( ( TickType_t ) ( xTimeNow - xCommandTime ) ) >= pxTimer->xTimerPeriodInTicks ) /*lint !e961 MISRA exception as the casts are only redundant for some ports. */\r
666                 {\r
667                         /* The time between a command being issued and the command being\r
668                         processed actually exceeds the timers period.  */\r
669                         xProcessTimerNow = pdTRUE;\r
670                 }\r
671                 else\r
672                 {\r
673                         vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
674                 }\r
675         }\r
676         else\r
677         {\r
678                 if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
679                 {\r
680                         /* If, since the command was issued, the tick count has overflowed\r
681                         but the expiry time has not, then the timer must have already passed\r
682                         its expiry time and should be processed immediately. */\r
683                         xProcessTimerNow = pdTRUE;\r
684                 }\r
685                 else\r
686                 {\r
687                         vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
688                 }\r
689         }\r
690 \r
691         return xProcessTimerNow;\r
692 }\r
693 /*-----------------------------------------------------------*/\r
694 \r
695 static void     prvProcessReceivedCommands( void )\r
696 {\r
697 DaemonTaskMessage_t xMessage;\r
698 Timer_t *pxTimer;\r
699 BaseType_t xTimerListsWereSwitched, xResult;\r
700 TickType_t xTimeNow;\r
701 \r
702         while( xQueueReceive( xTimerQueue, &xMessage, tmrNO_DELAY ) != pdFAIL ) /*lint !e603 xMessage does not have to be initialised as it is passed out, not in, and it is not used unless xQueueReceive() returns pdTRUE. */\r
703         {\r
704                 #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
705                 {\r
706                         /* Negative commands are pended function calls rather than timer\r
707                         commands. */\r
708                         if( xMessage.xMessageID < ( BaseType_t ) 0 )\r
709                         {\r
710                                 const CallbackParameters_t * const pxCallback = &( xMessage.u.xCallbackParameters );\r
711 \r
712                                 /* The timer uses the xCallbackParameters member to request a\r
713                                 callback be executed.  Check the callback is not NULL. */\r
714                                 configASSERT( pxCallback );\r
715 \r
716                                 /* Call the function. */\r
717                                 pxCallback->pxCallbackFunction( pxCallback->pvParameter1, pxCallback->ulParameter2 );\r
718                         }\r
719                         else\r
720                         {\r
721                                 mtCOVERAGE_TEST_MARKER();\r
722                         }\r
723                 }\r
724                 #endif /* INCLUDE_xTimerPendFunctionCall */\r
725 \r
726                 /* Commands that are positive are timer commands rather than pended\r
727                 function calls. */\r
728                 if( xMessage.xMessageID >= ( BaseType_t ) 0 )\r
729                 {\r
730                         /* The messages uses the xTimerParameters member to work on a\r
731                         software timer. */\r
732                         pxTimer = xMessage.u.xTimerParameters.pxTimer;\r
733 \r
734                         if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE )\r
735                         {\r
736                                 /* The timer is in a list, remove it. */\r
737                                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
738                         }\r
739                         else\r
740                         {\r
741                                 mtCOVERAGE_TEST_MARKER();\r
742                         }\r
743 \r
744                         traceTIMER_COMMAND_RECEIVED( pxTimer, xMessage.xMessageID, xMessage.u.xTimerParameters.xMessageValue );\r
745 \r
746                         /* In this case the xTimerListsWereSwitched parameter is not used, but\r
747                         it must be present in the function call.  prvSampleTimeNow() must be\r
748                         called after the message is received from xTimerQueue so there is no\r
749                         possibility of a higher priority task adding a message to the message\r
750                         queue with a time that is ahead of the timer daemon task (because it\r
751                         pre-empted the timer daemon task after the xTimeNow value was set). */\r
752                         xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
753 \r
754                         switch( xMessage.xMessageID )\r
755                         {\r
756                                 case tmrCOMMAND_START :\r
757                             case tmrCOMMAND_START_FROM_ISR :\r
758                             case tmrCOMMAND_RESET :\r
759                             case tmrCOMMAND_RESET_FROM_ISR :\r
760                                 case tmrCOMMAND_START_DONT_TRACE :\r
761                                         /* Start or restart a timer. */\r
762                                         if( prvInsertTimerInActiveList( pxTimer,  xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.u.xTimerParameters.xMessageValue ) != pdFALSE )\r
763                                         {\r
764                                                 /* The timer expired before it was added to the active\r
765                                                 timer list.  Process it now. */\r
766                                                 pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
767                                                 traceTIMER_EXPIRED( pxTimer );\r
768 \r
769                                                 if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
770                                                 {\r
771                                                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
772                                                         configASSERT( xResult );\r
773                                                         ( void ) xResult;\r
774                                                 }\r
775                                                 else\r
776                                                 {\r
777                                                         mtCOVERAGE_TEST_MARKER();\r
778                                                 }\r
779                                         }\r
780                                         else\r
781                                         {\r
782                                                 mtCOVERAGE_TEST_MARKER();\r
783                                         }\r
784                                         break;\r
785 \r
786                                 case tmrCOMMAND_STOP :\r
787                                 case tmrCOMMAND_STOP_FROM_ISR :\r
788                                         /* The timer has already been removed from the active list.\r
789                                         There is nothing to do here. */\r
790                                         break;\r
791 \r
792                                 case tmrCOMMAND_CHANGE_PERIOD :\r
793                                 case tmrCOMMAND_CHANGE_PERIOD_FROM_ISR :\r
794                                         pxTimer->xTimerPeriodInTicks = xMessage.u.xTimerParameters.xMessageValue;\r
795                                         configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
796 \r
797                                         /* The new period does not really have a reference, and can\r
798                                         be longer or shorter than the old one.  The command time is\r
799                                         therefore set to the current time, and as the period cannot\r
800                                         be zero the next expiry time can only be in the future,\r
801                                         meaning (unlike for the xTimerStart() case above) there is\r
802                                         no fail case that needs to be handled here. */\r
803                                         ( void ) prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
804                                         break;\r
805 \r
806                                 case tmrCOMMAND_DELETE :\r
807                                         /* The timer has already been removed from the active list,\r
808                                         just free up the memory if the memory was dynamically\r
809                                         allocated. */\r
810                                         #if( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 0 ) )\r
811                                         {\r
812                                                 /* The timer can only have been allocated dynamically -\r
813                                                 free it again. */\r
814                                                 vPortFree( pxTimer );\r
815                                         }\r
816                                         #elif( ( configSUPPORT_DYNAMIC_ALLOCATION == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
817                                         {\r
818                                                 /* The timer could have been allocated statically or\r
819                                                 dynamically, so check before attempting to free the\r
820                                                 memory. */\r
821                                                 if( pxTimer->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
822                                                 {\r
823                                                         vPortFree( pxTimer );\r
824                                                 }\r
825                                                 else\r
826                                                 {\r
827                                                         mtCOVERAGE_TEST_MARKER();\r
828                                                 }\r
829                                         }\r
830                                         #endif /* configSUPPORT_DYNAMIC_ALLOCATION */\r
831                                         break;\r
832 \r
833                                 default :\r
834                                         /* Don't expect to get here. */\r
835                                         break;\r
836                         }\r
837                 }\r
838         }\r
839 }\r
840 /*-----------------------------------------------------------*/\r
841 \r
842 static void prvSwitchTimerLists( void )\r
843 {\r
844 TickType_t xNextExpireTime, xReloadTime;\r
845 List_t *pxTemp;\r
846 Timer_t *pxTimer;\r
847 BaseType_t xResult;\r
848 \r
849         /* The tick count has overflowed.  The timer lists must be switched.\r
850         If there are any timers still referenced from the current timer list\r
851         then they must have expired and should be processed before the lists\r
852         are switched. */\r
853         while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
854         {\r
855                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
856 \r
857                 /* Remove the timer from the list. */\r
858                 pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
859                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
860                 traceTIMER_EXPIRED( pxTimer );\r
861 \r
862                 /* Execute its callback, then send a command to restart the timer if\r
863                 it is an auto-reload timer.  It cannot be restarted here as the lists\r
864                 have not yet been switched. */\r
865                 pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
866 \r
867                 if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
868                 {\r
869                         /* Calculate the reload value, and if the reload value results in\r
870                         the timer going into the same timer list then it has already expired\r
871                         and the timer should be re-inserted into the current list so it is\r
872                         processed again within this loop.  Otherwise a command should be sent\r
873                         to restart the timer to ensure it is only inserted into a list after\r
874                         the lists have been swapped. */\r
875                         xReloadTime = ( xNextExpireTime + pxTimer->xTimerPeriodInTicks );\r
876                         if( xReloadTime > xNextExpireTime )\r
877                         {\r
878                                 listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xReloadTime );\r
879                                 listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
880                                 vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
881                         }\r
882                         else\r
883                         {\r
884                                 xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
885                                 configASSERT( xResult );\r
886                                 ( void ) xResult;\r
887                         }\r
888                 }\r
889                 else\r
890                 {\r
891                         mtCOVERAGE_TEST_MARKER();\r
892                 }\r
893         }\r
894 \r
895         pxTemp = pxCurrentTimerList;\r
896         pxCurrentTimerList = pxOverflowTimerList;\r
897         pxOverflowTimerList = pxTemp;\r
898 }\r
899 /*-----------------------------------------------------------*/\r
900 \r
901 static void prvCheckForValidListAndQueue( void )\r
902 {\r
903         /* Check that the list from which active timers are referenced, and the\r
904         queue used to communicate with the timer service, have been\r
905         initialised. */\r
906         taskENTER_CRITICAL();\r
907         {\r
908                 if( xTimerQueue == NULL )\r
909                 {\r
910                         vListInitialise( &xActiveTimerList1 );\r
911                         vListInitialise( &xActiveTimerList2 );\r
912                         pxCurrentTimerList = &xActiveTimerList1;\r
913                         pxOverflowTimerList = &xActiveTimerList2;\r
914 \r
915                         #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
916                         {\r
917                                 /* The timer queue is allocated statically in case\r
918                                 configSUPPORT_DYNAMIC_ALLOCATION is 0. */\r
919                                 static StaticQueue_t xStaticTimerQueue;\r
920                                 static uint8_t ucStaticTimerQueueStorage[ configTIMER_QUEUE_LENGTH * sizeof( DaemonTaskMessage_t ) ];\r
921 \r
922                                 xTimerQueue = xQueueCreateStatic( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, sizeof( DaemonTaskMessage_t ), &( ucStaticTimerQueueStorage[ 0 ] ), &xStaticTimerQueue );\r
923                         }\r
924                         #else\r
925                         {\r
926                                 xTimerQueue = xQueueCreate( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, sizeof( DaemonTaskMessage_t ) );\r
927                         }\r
928                         #endif\r
929 \r
930                         #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
931                         {\r
932                                 if( xTimerQueue != NULL )\r
933                                 {\r
934                                         vQueueAddToRegistry( xTimerQueue, "TmrQ" );\r
935                                 }\r
936                                 else\r
937                                 {\r
938                                         mtCOVERAGE_TEST_MARKER();\r
939                                 }\r
940                         }\r
941                         #endif /* configQUEUE_REGISTRY_SIZE */\r
942                 }\r
943                 else\r
944                 {\r
945                         mtCOVERAGE_TEST_MARKER();\r
946                 }\r
947         }\r
948         taskEXIT_CRITICAL();\r
949 }\r
950 /*-----------------------------------------------------------*/\r
951 \r
952 BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer )\r
953 {\r
954 BaseType_t xTimerIsInActiveList;\r
955 Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
956 \r
957         configASSERT( xTimer );\r
958 \r
959         /* Is the timer in the list of active timers? */\r
960         taskENTER_CRITICAL();\r
961         {\r
962                 /* Checking to see if it is in the NULL list in effect checks to see if\r
963                 it is referenced from either the current or the overflow timer lists in\r
964                 one go, but the logic has to be reversed, hence the '!'. */\r
965                 xTimerIsInActiveList = ( BaseType_t ) !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) );\r
966         }\r
967         taskEXIT_CRITICAL();\r
968 \r
969         return xTimerIsInActiveList;\r
970 } /*lint !e818 Can't be pointer to const due to the typedef. */\r
971 /*-----------------------------------------------------------*/\r
972 \r
973 void *pvTimerGetTimerID( const TimerHandle_t xTimer )\r
974 {\r
975 Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
976 void *pvReturn;\r
977 \r
978         configASSERT( xTimer );\r
979 \r
980         taskENTER_CRITICAL();\r
981         {\r
982                 pvReturn = pxTimer->pvTimerID;\r
983         }\r
984         taskEXIT_CRITICAL();\r
985 \r
986         return pvReturn;\r
987 }\r
988 /*-----------------------------------------------------------*/\r
989 \r
990 void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID )\r
991 {\r
992 Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
993 \r
994         configASSERT( xTimer );\r
995 \r
996         taskENTER_CRITICAL();\r
997         {\r
998                 pxTimer->pvTimerID = pvNewID;\r
999         }\r
1000         taskEXIT_CRITICAL();\r
1001 }\r
1002 /*-----------------------------------------------------------*/\r
1003 \r
1004 #if( INCLUDE_xTimerPendFunctionCall == 1 )\r
1005 \r
1006         BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken )\r
1007         {\r
1008         DaemonTaskMessage_t xMessage;\r
1009         BaseType_t xReturn;\r
1010 \r
1011                 /* Complete the message with the function parameters and post it to the\r
1012                 daemon task. */\r
1013                 xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR;\r
1014                 xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
1015                 xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
1016                 xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
1017 \r
1018                 xReturn = xQueueSendFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
1019 \r
1020                 tracePEND_FUNC_CALL_FROM_ISR( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
1021 \r
1022                 return xReturn;\r
1023         }\r
1024 \r
1025 #endif /* INCLUDE_xTimerPendFunctionCall */\r
1026 /*-----------------------------------------------------------*/\r
1027 \r
1028 #if( INCLUDE_xTimerPendFunctionCall == 1 )\r
1029 \r
1030         BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait )\r
1031         {\r
1032         DaemonTaskMessage_t xMessage;\r
1033         BaseType_t xReturn;\r
1034 \r
1035                 /* This function can only be called after a timer has been created or\r
1036                 after the scheduler has been started because, until then, the timer\r
1037                 queue does not exist. */\r
1038                 configASSERT( xTimerQueue );\r
1039 \r
1040                 /* Complete the message with the function parameters and post it to the\r
1041                 daemon task. */\r
1042                 xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK;\r
1043                 xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
1044                 xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
1045                 xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
1046 \r
1047                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
1048 \r
1049                 tracePEND_FUNC_CALL( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
1050 \r
1051                 return xReturn;\r
1052         }\r
1053 \r
1054 #endif /* INCLUDE_xTimerPendFunctionCall */\r
1055 /*-----------------------------------------------------------*/\r
1056 \r
1057 /* This entire source file will be skipped if the application is not configured\r
1058 to include software timer functionality.  If you want to include software timer\r
1059 functionality then ensure configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
1060 #endif /* configUSE_TIMERS == 1 */\r
1061 \r
1062 \r
1063 \r