git.sur5r.net Git - freertos/blob - FreeRTOS/Source/timers.c

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