]> git.sur5r.net Git - freertos/blob - FreeRTOS/Source/timers.c
Update version number ready for version 9 release candidate 1.
[freertos] / FreeRTOS / Source / timers.c
1 /*\r
2     FreeRTOS V9.0.0rc1 - 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 )\r
117                 uint8_t                         ucStaticallyAllocated; /*<< Set to pdTRUE if the timer was created from a StaticTimer_t structure, and pdFALSE if the timer structure was allocated dynamically. */\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 \r
175 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
176 \r
177         PRIVILEGED_DATA static TaskHandle_t xTimerTaskHandle = NULL;\r
178 \r
179 #endif\r
180 \r
181 /*lint +e956 */\r
182 \r
183 /*-----------------------------------------------------------*/\r
184 \r
185 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
186 \r
187         /* If static allocation is supported then the application must provide the\r
188         following callback function - which enables the application to optionally\r
189         provide the memory that will be used by the timer task as the task's stack\r
190         and TCB. */\r
191         extern void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint16_t *pusTimerTaskStackSize );\r
192 \r
193 #endif\r
194 \r
195 /*\r
196  * Initialise the infrastructure used by the timer service task if it has not\r
197  * been initialised already.\r
198  */\r
199 static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
200 \r
201 /*\r
202  * The timer service task (daemon).  Timer functionality is controlled by this\r
203  * task.  Other tasks communicate with the timer service task using the\r
204  * xTimerQueue queue.\r
205  */\r
206 static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
207 \r
208 /*\r
209  * Called by the timer service task to interpret and process a command it\r
210  * received on the timer queue.\r
211  */\r
212 static void prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
213 \r
214 /*\r
215  * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
216  * depending on if the expire time causes a timer counter overflow.\r
217  */\r
218 static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime ) PRIVILEGED_FUNCTION;\r
219 \r
220 /*\r
221  * An active timer has reached its expire time.  Reload the timer if it is an\r
222  * auto reload timer, then call its callback.\r
223  */\r
224 static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow ) PRIVILEGED_FUNCTION;\r
225 \r
226 /*\r
227  * The tick count has overflowed.  Switch the timer lists after ensuring the\r
228  * current timer list does not still reference some timers.\r
229  */\r
230 static void prvSwitchTimerLists( void ) PRIVILEGED_FUNCTION;\r
231 \r
232 /*\r
233  * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
234  * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
235  */\r
236 static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
237 \r
238 /*\r
239  * If the timer list contains any active timers then return the expire time of\r
240  * the timer that will expire first and set *pxListWasEmpty to false.  If the\r
241  * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
242  * to pdTRUE.\r
243  */\r
244 static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
245 \r
246 /*\r
247  * If a timer has expired, process it.  Otherwise, block the timer service task\r
248  * until either a timer does expire or a command is received.\r
249  */\r
250 static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty ) PRIVILEGED_FUNCTION;\r
251 \r
252 /*-----------------------------------------------------------*/\r
253 \r
254 BaseType_t xTimerCreateTimerTask( void )\r
255 {\r
256 BaseType_t xReturn = pdFAIL;\r
257 StaticTask_t *pxTimerTaskTCBBuffer = NULL;\r
258 StackType_t *pxTimerTaskStackBuffer = NULL;\r
259 uint16_t usTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;\r
260 \r
261 \r
262         /* This function is called when the scheduler is started if\r
263         configUSE_TIMERS is set to 1.  Check that the infrastructure used by the\r
264         timer service task has been created/initialised.  If timers have already\r
265         been created then the initialisation will already have been performed. */\r
266         prvCheckForValidListAndQueue();\r
267 \r
268         if( xTimerQueue != NULL )\r
269         {\r
270 \r
271                 #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
272                 {\r
273                         vApplicationGetTimerTaskMemory( &pxTimerTaskTCBBuffer, &pxTimerTaskStackBuffer, &usTimerTaskStackSize );\r
274                 }\r
275                 #endif /* configSUPPORT_STATIC_ALLOCATION */\r
276 \r
277                 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
278                 {\r
279                         /* Create the timer task, storing its handle in xTimerTaskHandle so\r
280                         it can be returned by the xTimerGetTimerDaemonTaskHandle() function. */\r
281                         xReturn = xTaskGenericCreate( prvTimerTask, "Tmr Svc", usTimerTaskStackSize, NULL, ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, &xTimerTaskHandle, pxTimerTaskStackBuffer, pxTimerTaskTCBBuffer, NULL );\r
282                 }\r
283                 #else\r
284                 {\r
285                         /* Create the timer task without storing its handle. */\r
286                         xReturn = xTaskGenericCreate( prvTimerTask, "Tmr Svc", usTimerTaskStackSize, NULL, ( ( UBaseType_t ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, NULL, pxTimerTaskStackBuffer, pxTimerTaskTCBBuffer, NULL );\r
287                 }\r
288                 #endif\r
289         }\r
290         else\r
291         {\r
292                 mtCOVERAGE_TEST_MARKER();\r
293         }\r
294 \r
295         configASSERT( xReturn );\r
296         return xReturn;\r
297 }\r
298 /*-----------------------------------------------------------*/\r
299 \r
300 TimerHandle_t xTimerGenericCreate( 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
301 {\r
302 Timer_t *pxNewTimer;\r
303 \r
304         #if( ( configASSERT_DEFINED == 1 ) && ( configSUPPORT_STATIC_ALLOCATION == 1 ) )\r
305         {\r
306                 /* Sanity check that the size of the structure used to declare a\r
307                 variable of type StaticTimer_t equals the size of the real timer\r
308                 structures. */\r
309                 volatile size_t xSize = sizeof( StaticTimer_t );\r
310                 configASSERT( xSize == sizeof( Timer_t ) );\r
311         }\r
312         #endif /* configASSERT_DEFINED */\r
313 \r
314         /* Allocate the timer structure. */\r
315         if( xTimerPeriodInTicks == ( TickType_t ) 0U )\r
316         {\r
317                 pxNewTimer = NULL;\r
318         }\r
319         else\r
320         {\r
321                 /* If the user passed in a statically allocated timer structure then use\r
322                 it, otherwise allocate the structure dynamically. */\r
323                 if( pxTimerBuffer == NULL )\r
324                 {\r
325                         pxNewTimer = ( Timer_t * ) pvPortMalloc( sizeof( Timer_t ) );\r
326                 }\r
327                 else\r
328                 {\r
329                         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
330                 }\r
331 \r
332                 if( pxNewTimer != NULL )\r
333                 {\r
334                         /* Ensure the infrastructure used by the timer service task has been\r
335                         created/initialised. */\r
336                         prvCheckForValidListAndQueue();\r
337 \r
338                         /* Initialise the timer structure members using the function\r
339                         parameters. */\r
340                         pxNewTimer->pcTimerName = pcTimerName;\r
341                         pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
342                         pxNewTimer->uxAutoReload = uxAutoReload;\r
343                         pxNewTimer->pvTimerID = pvTimerID;\r
344                         pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
345                         vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
346 \r
347                         #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
348                         {\r
349                                 if( pxTimerBuffer == NULL )\r
350                                 {\r
351                                         pxNewTimer->ucStaticallyAllocated = pdFALSE;\r
352                                 }\r
353                                 else\r
354                                 {\r
355                                         pxNewTimer->ucStaticallyAllocated = pdTRUE;\r
356                                 }\r
357                         }\r
358                         #endif /* configSUPPORT_STATIC_ALLOCATION */\r
359 \r
360                         traceTIMER_CREATE( pxNewTimer );\r
361                 }\r
362                 else\r
363                 {\r
364                         traceTIMER_CREATE_FAILED();\r
365                 }\r
366         }\r
367 \r
368         /* 0 is not a valid value for xTimerPeriodInTicks. */\r
369         configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
370 \r
371         return ( TimerHandle_t ) pxNewTimer;\r
372 }\r
373 /*-----------------------------------------------------------*/\r
374 \r
375 BaseType_t xTimerGenericCommand( TimerHandle_t xTimer, const BaseType_t xCommandID, const TickType_t xOptionalValue, BaseType_t * const pxHigherPriorityTaskWoken, const TickType_t xTicksToWait )\r
376 {\r
377 BaseType_t xReturn = pdFAIL;\r
378 DaemonTaskMessage_t xMessage;\r
379 \r
380         configASSERT( xTimer );\r
381 \r
382         /* Send a message to the timer service task to perform a particular action\r
383         on a particular timer definition. */\r
384         if( xTimerQueue != NULL )\r
385         {\r
386                 /* Send a command to the timer service task to start the xTimer timer. */\r
387                 xMessage.xMessageID = xCommandID;\r
388                 xMessage.u.xTimerParameters.xMessageValue = xOptionalValue;\r
389                 xMessage.u.xTimerParameters.pxTimer = ( Timer_t * ) xTimer;\r
390 \r
391                 if( xCommandID < tmrFIRST_FROM_ISR_COMMAND )\r
392                 {\r
393                         if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
394                         {\r
395                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
396                         }\r
397                         else\r
398                         {\r
399                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
400                         }\r
401                 }\r
402                 else\r
403                 {\r
404                         xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
405                 }\r
406 \r
407                 traceTIMER_COMMAND_SEND( xTimer, xCommandID, xOptionalValue, xReturn );\r
408         }\r
409         else\r
410         {\r
411                 mtCOVERAGE_TEST_MARKER();\r
412         }\r
413 \r
414         return xReturn;\r
415 }\r
416 /*-----------------------------------------------------------*/\r
417 \r
418 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
419 \r
420         TaskHandle_t xTimerGetTimerDaemonTaskHandle( void )\r
421         {\r
422                 /* If xTimerGetTimerDaemonTaskHandle() is called before the scheduler has been\r
423                 started, then xTimerTaskHandle will be NULL. */\r
424                 configASSERT( ( xTimerTaskHandle != NULL ) );\r
425                 return xTimerTaskHandle;\r
426         }\r
427 \r
428 #endif\r
429 /*-----------------------------------------------------------*/\r
430 \r
431 const char * pcTimerGetTimerName( TimerHandle_t xTimer ) /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
432 {\r
433 Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
434 \r
435         configASSERT( xTimer );\r
436         return pxTimer->pcTimerName;\r
437 }\r
438 /*-----------------------------------------------------------*/\r
439 \r
440 static void prvProcessExpiredTimer( const TickType_t xNextExpireTime, const TickType_t xTimeNow )\r
441 {\r
442 BaseType_t xResult;\r
443 Timer_t * const pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
444 \r
445         /* Remove the timer from the list of active timers.  A check has already\r
446         been performed to ensure the list is not empty. */\r
447         ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
448         traceTIMER_EXPIRED( pxTimer );\r
449 \r
450         /* If the timer is an auto reload timer then calculate the next\r
451         expiry time and re-insert the timer in the list of active timers. */\r
452         if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
453         {\r
454                 /* The timer is inserted into a list using a time relative to anything\r
455                 other than the current time.  It will therefore be inserted into the\r
456                 correct list relative to the time this task thinks it is now. */\r
457                 if( prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow, xNextExpireTime ) != pdFALSE )\r
458                 {\r
459                         /* The timer expired before it was added to the active timer\r
460                         list.  Reload it now.  */\r
461                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
462                         configASSERT( xResult );\r
463                         ( void ) xResult;\r
464                 }\r
465                 else\r
466                 {\r
467                         mtCOVERAGE_TEST_MARKER();\r
468                 }\r
469         }\r
470         else\r
471         {\r
472                 mtCOVERAGE_TEST_MARKER();\r
473         }\r
474 \r
475         /* Call the timer callback. */\r
476         pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
477 }\r
478 /*-----------------------------------------------------------*/\r
479 \r
480 static void prvTimerTask( void *pvParameters )\r
481 {\r
482 TickType_t xNextExpireTime;\r
483 BaseType_t xListWasEmpty;\r
484 \r
485         /* Just to avoid compiler warnings. */\r
486         ( void ) pvParameters;\r
487 \r
488         #if( configUSE_DAEMON_TASK_STARTUP_HOOK == 1 )\r
489         {\r
490                 extern void vApplicationDaemonTaskStartupHook( void );\r
491 \r
492                 /* Allow the application writer to execute some code in the context of\r
493                 this task at the point the task starts executing.  This is useful if the\r
494                 application includes initialisation code that would benefit from\r
495                 executing after the scheduler has been started. */\r
496                 vApplicationDaemonTaskStartupHook();\r
497         }\r
498         #endif /* configUSE_DAEMON_TASK_STARTUP_HOOK */\r
499 \r
500         for( ;; )\r
501         {\r
502                 /* Query the timers list to see if it contains any timers, and if so,\r
503                 obtain the time at which the next timer will expire. */\r
504                 xNextExpireTime = prvGetNextExpireTime( &xListWasEmpty );\r
505 \r
506                 /* If a timer has expired, process it.  Otherwise, block this task\r
507                 until either a timer does expire, or a command is received. */\r
508                 prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
509 \r
510                 /* Empty the command queue. */\r
511                 prvProcessReceivedCommands();\r
512         }\r
513 }\r
514 /*-----------------------------------------------------------*/\r
515 \r
516 static void prvProcessTimerOrBlockTask( const TickType_t xNextExpireTime, BaseType_t xListWasEmpty )\r
517 {\r
518 TickType_t xTimeNow;\r
519 BaseType_t xTimerListsWereSwitched;\r
520 \r
521         vTaskSuspendAll();\r
522         {\r
523                 /* Obtain the time now to make an assessment as to whether the timer\r
524                 has expired or not.  If obtaining the time causes the lists to switch\r
525                 then don't process this timer as any timers that remained in the list\r
526                 when the lists were switched will have been processed within the\r
527                 prvSampleTimeNow() function. */\r
528                 xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
529                 if( xTimerListsWereSwitched == pdFALSE )\r
530                 {\r
531                         /* The tick count has not overflowed, has the timer expired? */\r
532                         if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
533                         {\r
534                                 ( void ) xTaskResumeAll();\r
535                                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
536                         }\r
537                         else\r
538                         {\r
539                                 /* The tick count has not overflowed, and the next expire\r
540                                 time has not been reached yet.  This task should therefore\r
541                                 block to wait for the next expire time or a command to be\r
542                                 received - whichever comes first.  The following line cannot\r
543                                 be reached unless xNextExpireTime > xTimeNow, except in the\r
544                                 case when the current timer list is empty. */\r
545                                 if( xListWasEmpty != pdFALSE )\r
546                                 {\r
547                                         /* The current timer list is empty - is the overflow list\r
548                                         also empty? */\r
549                                         xListWasEmpty = listLIST_IS_EMPTY( pxOverflowTimerList );\r
550                                 }\r
551 \r
552                                 vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ), xListWasEmpty );\r
553 \r
554                                 if( xTaskResumeAll() == pdFALSE )\r
555                                 {\r
556                                         /* Yield to wait for either a command to arrive, or the\r
557                                         block time to expire.  If a command arrived between the\r
558                                         critical section being exited and this yield then the yield\r
559                                         will not cause the task to block. */\r
560                                         portYIELD_WITHIN_API();\r
561                                 }\r
562                                 else\r
563                                 {\r
564                                         mtCOVERAGE_TEST_MARKER();\r
565                                 }\r
566                         }\r
567                 }\r
568                 else\r
569                 {\r
570                         ( void ) xTaskResumeAll();\r
571                 }\r
572         }\r
573 }\r
574 /*-----------------------------------------------------------*/\r
575 \r
576 static TickType_t prvGetNextExpireTime( BaseType_t * const pxListWasEmpty )\r
577 {\r
578 TickType_t xNextExpireTime;\r
579 \r
580         /* Timers are listed in expiry time order, with the head of the list\r
581         referencing the task that will expire first.  Obtain the time at which\r
582         the timer with the nearest expiry time will expire.  If there are no\r
583         active timers then just set the next expire time to 0.  That will cause\r
584         this task to unblock when the tick count overflows, at which point the\r
585         timer lists will be switched and the next expiry time can be\r
586         re-assessed.  */\r
587         *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
588         if( *pxListWasEmpty == pdFALSE )\r
589         {\r
590                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
591         }\r
592         else\r
593         {\r
594                 /* Ensure the task unblocks when the tick count rolls over. */\r
595                 xNextExpireTime = ( TickType_t ) 0U;\r
596         }\r
597 \r
598         return xNextExpireTime;\r
599 }\r
600 /*-----------------------------------------------------------*/\r
601 \r
602 static TickType_t prvSampleTimeNow( BaseType_t * const pxTimerListsWereSwitched )\r
603 {\r
604 TickType_t xTimeNow;\r
605 PRIVILEGED_DATA static TickType_t xLastTime = ( TickType_t ) 0U; /*lint !e956 Variable is only accessible to one task. */\r
606 \r
607         xTimeNow = xTaskGetTickCount();\r
608 \r
609         if( xTimeNow < xLastTime )\r
610         {\r
611                 prvSwitchTimerLists();\r
612                 *pxTimerListsWereSwitched = pdTRUE;\r
613         }\r
614         else\r
615         {\r
616                 *pxTimerListsWereSwitched = pdFALSE;\r
617         }\r
618 \r
619         xLastTime = xTimeNow;\r
620 \r
621         return xTimeNow;\r
622 }\r
623 /*-----------------------------------------------------------*/\r
624 \r
625 static BaseType_t prvInsertTimerInActiveList( Timer_t * const pxTimer, const TickType_t xNextExpiryTime, const TickType_t xTimeNow, const TickType_t xCommandTime )\r
626 {\r
627 BaseType_t xProcessTimerNow = pdFALSE;\r
628 \r
629         listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
630         listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
631 \r
632         if( xNextExpiryTime <= xTimeNow )\r
633         {\r
634                 /* Has the expiry time elapsed between the command to start/reset a\r
635                 timer was issued, and the time the command was processed? */\r
636                 if( ( ( TickType_t ) ( xTimeNow - xCommandTime ) ) >= pxTimer->xTimerPeriodInTicks )\r
637                 {\r
638                         /* The time between a command being issued and the command being\r
639                         processed actually exceeds the timers period.  */\r
640                         xProcessTimerNow = pdTRUE;\r
641                 }\r
642                 else\r
643                 {\r
644                         vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
645                 }\r
646         }\r
647         else\r
648         {\r
649                 if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
650                 {\r
651                         /* If, since the command was issued, the tick count has overflowed\r
652                         but the expiry time has not, then the timer must have already passed\r
653                         its expiry time and should be processed immediately. */\r
654                         xProcessTimerNow = pdTRUE;\r
655                 }\r
656                 else\r
657                 {\r
658                         vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
659                 }\r
660         }\r
661 \r
662         return xProcessTimerNow;\r
663 }\r
664 /*-----------------------------------------------------------*/\r
665 \r
666 static void     prvProcessReceivedCommands( void )\r
667 {\r
668 DaemonTaskMessage_t xMessage;\r
669 Timer_t *pxTimer;\r
670 BaseType_t xTimerListsWereSwitched, xResult;\r
671 TickType_t xTimeNow;\r
672 \r
673         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
674         {\r
675                 #if ( INCLUDE_xTimerPendFunctionCall == 1 )\r
676                 {\r
677                         /* Negative commands are pended function calls rather than timer\r
678                         commands. */\r
679                         if( xMessage.xMessageID < ( BaseType_t ) 0 )\r
680                         {\r
681                                 const CallbackParameters_t * const pxCallback = &( xMessage.u.xCallbackParameters );\r
682 \r
683                                 /* The timer uses the xCallbackParameters member to request a\r
684                                 callback be executed.  Check the callback is not NULL. */\r
685                                 configASSERT( pxCallback );\r
686 \r
687                                 /* Call the function. */\r
688                                 pxCallback->pxCallbackFunction( pxCallback->pvParameter1, pxCallback->ulParameter2 );\r
689                         }\r
690                         else\r
691                         {\r
692                                 mtCOVERAGE_TEST_MARKER();\r
693                         }\r
694                 }\r
695                 #endif /* INCLUDE_xTimerPendFunctionCall */\r
696 \r
697                 /* Commands that are positive are timer commands rather than pended\r
698                 function calls. */\r
699                 if( xMessage.xMessageID >= ( BaseType_t ) 0 )\r
700                 {\r
701                         /* The messages uses the xTimerParameters member to work on a\r
702                         software timer. */\r
703                         pxTimer = xMessage.u.xTimerParameters.pxTimer;\r
704 \r
705                         if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE )\r
706                         {\r
707                                 /* The timer is in a list, remove it. */\r
708                                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
709                         }\r
710                         else\r
711                         {\r
712                                 mtCOVERAGE_TEST_MARKER();\r
713                         }\r
714 \r
715                         traceTIMER_COMMAND_RECEIVED( pxTimer, xMessage.xMessageID, xMessage.u.xTimerParameters.xMessageValue );\r
716 \r
717                         /* In this case the xTimerListsWereSwitched parameter is not used, but\r
718                         it must be present in the function call.  prvSampleTimeNow() must be\r
719                         called after the message is received from xTimerQueue so there is no\r
720                         possibility of a higher priority task adding a message to the message\r
721                         queue with a time that is ahead of the timer daemon task (because it\r
722                         pre-empted the timer daemon task after the xTimeNow value was set). */\r
723                         xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
724 \r
725                         switch( xMessage.xMessageID )\r
726                         {\r
727                                 case tmrCOMMAND_START :\r
728                             case tmrCOMMAND_START_FROM_ISR :\r
729                             case tmrCOMMAND_RESET :\r
730                             case tmrCOMMAND_RESET_FROM_ISR :\r
731                                 case tmrCOMMAND_START_DONT_TRACE :\r
732                                         /* Start or restart a timer. */\r
733                                         if( prvInsertTimerInActiveList( pxTimer,  xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.u.xTimerParameters.xMessageValue ) != pdFALSE )\r
734                                         {\r
735                                                 /* The timer expired before it was added to the active\r
736                                                 timer list.  Process it now. */\r
737                                                 pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
738                                                 traceTIMER_EXPIRED( pxTimer );\r
739 \r
740                                                 if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
741                                                 {\r
742                                                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
743                                                         configASSERT( xResult );\r
744                                                         ( void ) xResult;\r
745                                                 }\r
746                                                 else\r
747                                                 {\r
748                                                         mtCOVERAGE_TEST_MARKER();\r
749                                                 }\r
750                                         }\r
751                                         else\r
752                                         {\r
753                                                 mtCOVERAGE_TEST_MARKER();\r
754                                         }\r
755                                         break;\r
756 \r
757                                 case tmrCOMMAND_STOP :\r
758                                 case tmrCOMMAND_STOP_FROM_ISR :\r
759                                         /* The timer has already been removed from the active list.\r
760                                         There is nothing to do here. */\r
761                                         break;\r
762 \r
763                                 case tmrCOMMAND_CHANGE_PERIOD :\r
764                                 case tmrCOMMAND_CHANGE_PERIOD_FROM_ISR :\r
765                                         pxTimer->xTimerPeriodInTicks = xMessage.u.xTimerParameters.xMessageValue;\r
766                                         configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
767 \r
768                                         /* The new period does not really have a reference, and can\r
769                                         be longer or shorter than the old one.  The command time is\r
770                                         therefore set to the current time, and as the period cannot\r
771                                         be zero the next expiry time can only be in the future,\r
772                                         meaning (unlike for the xTimerStart() case above) there is\r
773                                         no fail case that needs to be handled here. */\r
774                                         ( void ) prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
775                                         break;\r
776 \r
777                                 case tmrCOMMAND_DELETE :\r
778                                         /* The timer has already been removed from the active list,\r
779                                         just free up the memory if the memory was dynamically\r
780                                         allocated. */\r
781                                         #if( configSUPPORT_STATIC_ALLOCATION == 1 )\r
782                                         {\r
783                                                 if( pxTimer->ucStaticallyAllocated == ( uint8_t ) pdFALSE )\r
784                                                 {\r
785                                                         vPortFree( pxTimer );\r
786                                                 }\r
787                                                 else\r
788                                                 {\r
789                                                         mtCOVERAGE_TEST_MARKER();\r
790                                                 }\r
791                                         }\r
792                                         #else\r
793                                         {\r
794                                                 vPortFree( pxTimer );\r
795                                         }\r
796                                         #endif /* configSUPPORT_STATIC_ALLOCATION */\r
797                                         break;\r
798 \r
799                                 default :\r
800                                         /* Don't expect to get here. */\r
801                                         break;\r
802                         }\r
803                 }\r
804         }\r
805 }\r
806 /*-----------------------------------------------------------*/\r
807 \r
808 static void prvSwitchTimerLists( void )\r
809 {\r
810 TickType_t xNextExpireTime, xReloadTime;\r
811 List_t *pxTemp;\r
812 Timer_t *pxTimer;\r
813 BaseType_t xResult;\r
814 \r
815         /* The tick count has overflowed.  The timer lists must be switched.\r
816         If there are any timers still referenced from the current timer list\r
817         then they must have expired and should be processed before the lists\r
818         are switched. */\r
819         while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
820         {\r
821                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
822 \r
823                 /* Remove the timer from the list. */\r
824                 pxTimer = ( Timer_t * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
825                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
826                 traceTIMER_EXPIRED( pxTimer );\r
827 \r
828                 /* Execute its callback, then send a command to restart the timer if\r
829                 it is an auto-reload timer.  It cannot be restarted here as the lists\r
830                 have not yet been switched. */\r
831                 pxTimer->pxCallbackFunction( ( TimerHandle_t ) pxTimer );\r
832 \r
833                 if( pxTimer->uxAutoReload == ( UBaseType_t ) pdTRUE )\r
834                 {\r
835                         /* Calculate the reload value, and if the reload value results in\r
836                         the timer going into the same timer list then it has already expired\r
837                         and the timer should be re-inserted into the current list so it is\r
838                         processed again within this loop.  Otherwise a command should be sent\r
839                         to restart the timer to ensure it is only inserted into a list after\r
840                         the lists have been swapped. */\r
841                         xReloadTime = ( xNextExpireTime + pxTimer->xTimerPeriodInTicks );\r
842                         if( xReloadTime > xNextExpireTime )\r
843                         {\r
844                                 listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xReloadTime );\r
845                                 listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
846                                 vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
847                         }\r
848                         else\r
849                         {\r
850                                 xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START_DONT_TRACE, xNextExpireTime, NULL, tmrNO_DELAY );\r
851                                 configASSERT( xResult );\r
852                                 ( void ) xResult;\r
853                         }\r
854                 }\r
855                 else\r
856                 {\r
857                         mtCOVERAGE_TEST_MARKER();\r
858                 }\r
859         }\r
860 \r
861         pxTemp = pxCurrentTimerList;\r
862         pxCurrentTimerList = pxOverflowTimerList;\r
863         pxOverflowTimerList = pxTemp;\r
864 }\r
865 /*-----------------------------------------------------------*/\r
866 \r
867 static void prvCheckForValidListAndQueue( void )\r
868 {\r
869         /* Check that the list from which active timers are referenced, and the\r
870         queue used to communicate with the timer service, have been\r
871         initialised. */\r
872         taskENTER_CRITICAL();\r
873         {\r
874                 if( xTimerQueue == NULL )\r
875                 {\r
876                         vListInitialise( &xActiveTimerList1 );\r
877                         vListInitialise( &xActiveTimerList2 );\r
878                         pxCurrentTimerList = &xActiveTimerList1;\r
879                         pxOverflowTimerList = &xActiveTimerList2;\r
880                         xTimerQueue = xQueueCreate( ( UBaseType_t ) configTIMER_QUEUE_LENGTH, sizeof( DaemonTaskMessage_t ) );\r
881                         configASSERT( xTimerQueue );\r
882 \r
883                         #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
884                         {\r
885                                 if( xTimerQueue != NULL )\r
886                                 {\r
887                                         vQueueAddToRegistry( xTimerQueue, "TmrQ" );\r
888                                 }\r
889                                 else\r
890                                 {\r
891                                         mtCOVERAGE_TEST_MARKER();\r
892                                 }\r
893                         }\r
894                         #endif /* configQUEUE_REGISTRY_SIZE */\r
895                 }\r
896                 else\r
897                 {\r
898                         mtCOVERAGE_TEST_MARKER();\r
899                 }\r
900         }\r
901         taskEXIT_CRITICAL();\r
902 }\r
903 /*-----------------------------------------------------------*/\r
904 \r
905 BaseType_t xTimerIsTimerActive( TimerHandle_t xTimer )\r
906 {\r
907 BaseType_t xTimerIsInActiveList;\r
908 Timer_t *pxTimer = ( Timer_t * ) xTimer;\r
909 \r
910         configASSERT( xTimer );\r
911 \r
912         /* Is the timer in the list of active timers? */\r
913         taskENTER_CRITICAL();\r
914         {\r
915                 /* Checking to see if it is in the NULL list in effect checks to see if\r
916                 it is referenced from either the current or the overflow timer lists in\r
917                 one go, but the logic has to be reversed, hence the '!'. */\r
918                 xTimerIsInActiveList = ( BaseType_t ) !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) );\r
919         }\r
920         taskEXIT_CRITICAL();\r
921 \r
922         return xTimerIsInActiveList;\r
923 } /*lint !e818 Can't be pointer to const due to the typedef. */\r
924 /*-----------------------------------------------------------*/\r
925 \r
926 void *pvTimerGetTimerID( const TimerHandle_t xTimer )\r
927 {\r
928 Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
929 void *pvReturn;\r
930 \r
931         configASSERT( xTimer );\r
932 \r
933         taskENTER_CRITICAL();\r
934         {\r
935                 pvReturn = pxTimer->pvTimerID;\r
936         }\r
937         taskEXIT_CRITICAL();\r
938 \r
939         return pvReturn;\r
940 }\r
941 /*-----------------------------------------------------------*/\r
942 \r
943 void vTimerSetTimerID( TimerHandle_t xTimer, void *pvNewID )\r
944 {\r
945 Timer_t * const pxTimer = ( Timer_t * ) xTimer;\r
946 \r
947         configASSERT( xTimer );\r
948 \r
949         taskENTER_CRITICAL();\r
950         {\r
951                 pxTimer->pvTimerID = pvNewID;\r
952         }\r
953         taskEXIT_CRITICAL();\r
954 }\r
955 /*-----------------------------------------------------------*/\r
956 \r
957 #if( INCLUDE_xTimerPendFunctionCall == 1 )\r
958 \r
959         BaseType_t xTimerPendFunctionCallFromISR( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, BaseType_t *pxHigherPriorityTaskWoken )\r
960         {\r
961         DaemonTaskMessage_t xMessage;\r
962         BaseType_t xReturn;\r
963 \r
964                 /* Complete the message with the function parameters and post it to the\r
965                 daemon task. */\r
966                 xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK_FROM_ISR;\r
967                 xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
968                 xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
969                 xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
970 \r
971                 xReturn = xQueueSendFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
972 \r
973                 tracePEND_FUNC_CALL_FROM_ISR( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
974 \r
975                 return xReturn;\r
976         }\r
977 \r
978 #endif /* INCLUDE_xTimerPendFunctionCall */\r
979 /*-----------------------------------------------------------*/\r
980 \r
981 #if( INCLUDE_xTimerPendFunctionCall == 1 )\r
982 \r
983         BaseType_t xTimerPendFunctionCall( PendedFunction_t xFunctionToPend, void *pvParameter1, uint32_t ulParameter2, TickType_t xTicksToWait )\r
984         {\r
985         DaemonTaskMessage_t xMessage;\r
986         BaseType_t xReturn;\r
987 \r
988                 /* This function can only be called after a timer has been created or\r
989                 after the scheduler has been started because, until then, the timer\r
990                 queue does not exist. */\r
991                 configASSERT( xTimerQueue );\r
992 \r
993                 /* Complete the message with the function parameters and post it to the\r
994                 daemon task. */\r
995                 xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK;\r
996                 xMessage.u.xCallbackParameters.pxCallbackFunction = xFunctionToPend;\r
997                 xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
998                 xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
999 \r
1000                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xTicksToWait );\r
1001 \r
1002                 tracePEND_FUNC_CALL( xFunctionToPend, pvParameter1, ulParameter2, xReturn );\r
1003 \r
1004                 return xReturn;\r
1005         }\r
1006 \r
1007 #endif /* INCLUDE_xTimerPendFunctionCall */\r
1008 /*-----------------------------------------------------------*/\r
1009 \r
1010 /* This entire source file will be skipped if the application is not configured\r
1011 to include software timer functionality.  If you want to include software timer\r
1012 functionality then ensure configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
1013 #endif /* configUSE_TIMERS == 1 */\r
1014 \r
1015 \r
1016 \r