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

   1 /*\r
   2     FreeRTOS V7.6.0 - Copyright (C) 2013 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     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS provides completely free yet professionally developed,    *\r
  10      *    robust, strictly quality controlled, supported, and cross          *\r
  11      *    platform software that has become a de facto standard.             *\r
  12      *                                                                       *\r
  13      *    Help yourself get started quickly and support the FreeRTOS         *\r
  14      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  15      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  16      *                                                                       *\r
  17      *    Thank you!                                                         *\r
  18      *                                                                       *\r
  19     ***************************************************************************\r
  20 \r
  21     This file is part of the FreeRTOS distribution.\r
  22 \r
  23     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  24     the terms of the GNU General Public License (version 2) as published by the\r
  25     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  26 \r
  27     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  28     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  29     >>! the source code for proprietary components outside of the FreeRTOS\r
  30     >>! kernel.\r
  31 \r
  32     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  33     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  34     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  35     link: http://www.freertos.org/a00114.html\r
  36 \r
  37     1 tab == 4 spaces!\r
  38 \r
  39     ***************************************************************************\r
  40      *                                                                       *\r
  41      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  42      *    not run, what could be wrong?"                                     *\r
  43      *                                                                       *\r
  44      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  45      *                                                                       *\r
  46     ***************************************************************************\r
  47 \r
  48     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  49     license and Real Time Engineers Ltd. contact details.\r
  50 \r
  51     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  52     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  53     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  54 \r
  55     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  56     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  57     licenses offer ticketed support, indemnification and middleware.\r
  58 \r
  59     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  60     engineered and independently SIL3 certified version for use in safety and\r
  61     mission critical applications that require provable dependability.\r
  62 \r
  63     1 tab == 4 spaces!\r
  64 */\r
  65 \r
  66 /* Standard includes. */\r
  67 #include <stdlib.h>\r
  68 \r
  69 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
  70 all the API functions to use the MPU wrappers.  That should only be done when\r
  71 task.h is included from an application file. */\r
  72 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  73 \r
  74 #include "FreeRTOS.h"\r
  75 #include "task.h"\r
  76 #include "queue.h"\r
  77 #include "timers.h"\r
  78 \r
  79 #if ( INCLUDE_xTimerPendCallbackFromISR == 1 ) && ( configUSE_TIMERS == 0 )\r
  80         #error configUSE_TIMERS must be set to 1 to make the INCLUDE_xTimerPendCallbackFromISR() function available.\r
  81 #endif\r
  82 \r
  83 /* Lint e961 and e750 are suppressed as a MISRA exception justified because the\r
  84 MPU ports require MPU_WRAPPERS_INCLUDED_FROM_API_FILE to be defined for the\r
  85 header files above, but not in this file, in order to generate the correct\r
  86 privileged Vs unprivileged linkage and placement. */\r
  87 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE /*lint !e961 !e750. */\r
  88 \r
  89 \r
  90 /* This entire source file will be skipped if the application is not configured\r
  91 to include software timer functionality.  This #if is closed at the very bottom\r
  92 of this file.  If you want to include software timer functionality then ensure\r
  93 configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
  94 #if ( configUSE_TIMERS == 1 )\r
  95 \r
  96 /* Misc definitions. */\r
  97 #define tmrNO_DELAY             ( portTickType ) 0U\r
  98 \r
  99 /* The definition of the timers themselves. */\r
 100 typedef struct tmrTimerControl\r
 101 {\r
 102         const signed char               *pcTimerName;           /*<< Text name.  This is not used by the kernel, it is included simply to make debugging easier. */\r
 103         xListItem                               xTimerListItem;         /*<< Standard linked list item as used by all kernel features for event management. */\r
 104         portTickType                    xTimerPeriodInTicks;/*<< How quickly and often the timer expires. */\r
 105         unsigned portBASE_TYPE  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
 106         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
 107         tmrTIMER_CALLBACK               pxCallbackFunction;     /*<< The function that will be called when the timer expires. */\r
 108 } xTIMER;\r
 109 \r
 110 /* The definition of messages that can be sent and received on the timer queue.\r
 111 Two types of message can be queued - messages that manipulate a software timer,\r
 112 and messages that request the execution of a non-timer related callback.  The\r
 113 two message types are defined in two separate structures, xTimerParametersType\r
 114 and xCallbackParametersType respectively. */\r
 115 typedef struct tmrTimerParameters\r
 116 {\r
 117         portTickType                    xMessageValue;          /*<< An optional value used by a subset of commands, for example, when changing the period of a timer. */\r
 118         xTIMER *                                pxTimer;                        /*<< The timer to which the command will be applied. */\r
 119 } xTimerParametersType;\r
 120 \r
 121 \r
 122 typedef struct tmrCallbackParameters\r
 123 {\r
 124         pdAPPLICATION_CALLBACK_CODE     pxCallbackFunction; /* << The callback function to execute. */\r
 125         void *pvParameter1;                                                             /* << The value that will be used as the callback functions first parameter. */\r
 126         unsigned long ulParameter2;                                             /* << The value that will be used as the callback functions second parameter. */\r
 127 } xCallbackParametersType;\r
 128 \r
 129 /* The structure that contains the two message types, along with an identifier\r
 130 that is used to determine which message type is valid. */\r
 131 typedef struct tmrTimerQueueMessage\r
 132 {\r
 133         portBASE_TYPE                   xMessageID;                     /*<< The command being sent to the timer service task. */\r
 134         union\r
 135         {\r
 136                 xTimerParametersType xTimerParameters;\r
 137 \r
 138                 /* Don't include xCallbackParameters if it is not going to be used as\r
 139                 it makes the structure (and therefore the timer queue) larger. */\r
 140                 #if ( INCLUDE_xTimerPendCallbackFromISR == 1 )\r
 141                         xCallbackParametersType xCallbackParameters;\r
 142                 #endif /* INCLUDE_xTimerPendCallbackFromISR */\r
 143         } u;\r
 144 } xDAEMON_TASK_MESSAGE;\r
 145 \r
 146 /*lint -e956 A manual analysis and inspection has been used to determine which\r
 147 static variables must be declared volatile. */\r
 148 \r
 149 /* The list in which active timers are stored.  Timers are referenced in expire\r
 150 time order, with the nearest expiry time at the front of the list.  Only the\r
 151 timer service task is allowed to access these lists. */\r
 152 PRIVILEGED_DATA static xList xActiveTimerList1;\r
 153 PRIVILEGED_DATA static xList xActiveTimerList2;\r
 154 PRIVILEGED_DATA static xList *pxCurrentTimerList;\r
 155 PRIVILEGED_DATA static xList *pxOverflowTimerList;\r
 156 \r
 157 /* A queue that is used to send commands to the timer service task. */\r
 158 PRIVILEGED_DATA static xQueueHandle xTimerQueue = NULL;\r
 159 \r
 160 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
 161 \r
 162         PRIVILEGED_DATA static xTaskHandle xTimerTaskHandle = NULL;\r
 163 \r
 164 #endif\r
 165 \r
 166 /*lint +e956 */\r
 167 \r
 168 /*-----------------------------------------------------------*/\r
 169 \r
 170 /*\r
 171  * Initialise the infrastructure used by the timer service task if it has not\r
 172  * been initialised already.\r
 173  */\r
 174 static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
 175 \r
 176 /*\r
 177  * The timer service task (daemon).  Timer functionality is controlled by this\r
 178  * task.  Other tasks communicate with the timer service task using the\r
 179  * xTimerQueue queue.\r
 180  */\r
 181 static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
 182 \r
 183 /*\r
 184  * Called by the timer service task to interpret and process a command it\r
 185  * received on the timer queue.\r
 186  */\r
 187 static void     prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
 188 \r
 189 /*\r
 190  * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
 191  * depending on if the expire time causes a timer counter overflow.\r
 192  */\r
 193 static portBASE_TYPE prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow, portTickType xCommandTime ) PRIVILEGED_FUNCTION;\r
 194 \r
 195 /*\r
 196  * An active timer has reached its expire time.  Reload the timer if it is an\r
 197  * auto reload timer, then call its callback.\r
 198  */\r
 199 static void prvProcessExpiredTimer( portTickType xNextExpireTime, portTickType xTimeNow ) PRIVILEGED_FUNCTION;\r
 200 \r
 201 /*\r
 202  * The tick count has overflowed.  Switch the timer lists after ensuring the\r
 203  * current timer list does not still reference some timers.\r
 204  */\r
 205 static void prvSwitchTimerLists( portTickType xLastTime ) PRIVILEGED_FUNCTION;\r
 206 \r
 207 /*\r
 208  * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
 209  * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
 210  */\r
 211 static portTickType prvSampleTimeNow( portBASE_TYPE *pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
 212 \r
 213 /*\r
 214  * If the timer list contains any active timers then return the expire time of\r
 215  * the timer that will expire first and set *pxListWasEmpty to false.  If the\r
 216  * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
 217  * to pdTRUE.\r
 218  */\r
 219 static portTickType prvGetNextExpireTime( portBASE_TYPE *pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
 220 \r
 221 /*\r
 222  * If a timer has expired, process it.  Otherwise, block the timer service task\r
 223  * until either a timer does expire or a command is received.\r
 224  */\r
 225 static void prvProcessTimerOrBlockTask( portTickType xNextExpireTime, portBASE_TYPE xListWasEmpty ) PRIVILEGED_FUNCTION;\r
 226 \r
 227 /*-----------------------------------------------------------*/\r
 228 \r
 229 portBASE_TYPE xTimerCreateTimerTask( void )\r
 230 {\r
 231 portBASE_TYPE xReturn = pdFAIL;\r
 232 \r
 233         /* This function is called when the scheduler is started if\r
 234         configUSE_TIMERS is set to 1.  Check that the infrastructure used by the\r
 235         timer service task has been created/initialised.  If timers have already\r
 236         been created then the initialisation will already have been performed. */\r
 237         prvCheckForValidListAndQueue();\r
 238 \r
 239         if( xTimerQueue != NULL )\r
 240         {\r
 241                 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
 242                 {\r
 243                         /* Create the timer task, storing its handle in xTimerTaskHandle so\r
 244                         it can be returned by the xTimerGetTimerDaemonTaskHandle() function. */\r
 245                         xReturn = xTaskCreate( prvTimerTask, ( signed char * ) "Tmr Svc", ( unsigned short ) configTIMER_TASK_STACK_DEPTH, NULL, ( ( unsigned portBASE_TYPE ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, &xTimerTaskHandle );\r
 246                 }\r
 247                 #else\r
 248                 {\r
 249                         /* Create the timer task without storing its handle. */\r
 250                         xReturn = xTaskCreate( prvTimerTask, ( signed char * ) "Tmr Svc", ( unsigned short ) configTIMER_TASK_STACK_DEPTH, NULL, ( ( unsigned portBASE_TYPE ) configTIMER_TASK_PRIORITY ) | portPRIVILEGE_BIT, NULL);\r
 251                 }\r
 252                 #endif\r
 253         }\r
 254 \r
 255         configASSERT( xReturn );\r
 256         return xReturn;\r
 257 }\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 xTimerHandle xTimerCreate( const signed char * const pcTimerName, portTickType xTimerPeriodInTicks, unsigned portBASE_TYPE uxAutoReload, void *pvTimerID, tmrTIMER_CALLBACK pxCallbackFunction )\r
 261 {\r
 262 xTIMER *pxNewTimer;\r
 263 \r
 264         /* Allocate the timer structure. */\r
 265         if( xTimerPeriodInTicks == ( portTickType ) 0U )\r
 266         {\r
 267                 pxNewTimer = NULL;\r
 268         }\r
 269         else\r
 270         {\r
 271                 pxNewTimer = ( xTIMER * ) pvPortMalloc( sizeof( xTIMER ) );\r
 272                 if( pxNewTimer != NULL )\r
 273                 {\r
 274                         /* Ensure the infrastructure used by the timer service task has been\r
 275                         created/initialised. */\r
 276                         prvCheckForValidListAndQueue();\r
 277 \r
 278                         /* Initialise the timer structure members using the function parameters. */\r
 279                         pxNewTimer->pcTimerName = pcTimerName;\r
 280                         pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
 281                         pxNewTimer->uxAutoReload = uxAutoReload;\r
 282                         pxNewTimer->pvTimerID = pvTimerID;\r
 283                         pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
 284                         vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
 285 \r
 286                         traceTIMER_CREATE( pxNewTimer );\r
 287                 }\r
 288                 else\r
 289                 {\r
 290                         traceTIMER_CREATE_FAILED();\r
 291                 }\r
 292         }\r
 293 \r
 294         /* 0 is not a valid value for xTimerPeriodInTicks. */\r
 295         configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
 296 \r
 297         return ( xTimerHandle ) pxNewTimer;\r
 298 }\r
 299 /*-----------------------------------------------------------*/\r
 300 \r
 301 portBASE_TYPE xTimerGenericCommand( xTimerHandle xTimer, portBASE_TYPE xCommandID, portTickType xOptionalValue, signed portBASE_TYPE *pxHigherPriorityTaskWoken, portTickType xBlockTime )\r
 302 {\r
 303 portBASE_TYPE xReturn = pdFAIL;\r
 304 xDAEMON_TASK_MESSAGE xMessage;\r
 305 \r
 306         /* Send a message to the timer service task to perform a particular action\r
 307         on a particular timer definition. */\r
 308         if( xTimerQueue != NULL )\r
 309         {\r
 310                 /* Send a command to the timer service task to start the xTimer timer. */\r
 311                 xMessage.xMessageID = xCommandID;\r
 312                 xMessage.u.xTimerParameters.xMessageValue = xOptionalValue;\r
 313                 xMessage.u.xTimerParameters.pxTimer = ( xTIMER * ) xTimer;\r
 314 \r
 315                 if( pxHigherPriorityTaskWoken == NULL )\r
 316                 {\r
 317                         if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
 318                         {\r
 319                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xBlockTime );\r
 320                         }\r
 321                         else\r
 322                         {\r
 323                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
 324                         }\r
 325                 }\r
 326                 else\r
 327                 {\r
 328                         xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
 329                 }\r
 330 \r
 331                 traceTIMER_COMMAND_SEND( xTimer, xCommandID, xOptionalValue, xReturn );\r
 332         }\r
 333 \r
 334         return xReturn;\r
 335 }\r
 336 /*-----------------------------------------------------------*/\r
 337 \r
 338 #if ( INCLUDE_xTimerGetTimerDaemonTaskHandle == 1 )\r
 339 \r
 340         xTaskHandle xTimerGetTimerDaemonTaskHandle( void )\r
 341         {\r
 342                 /* If xTimerGetTimerDaemonTaskHandle() is called before the scheduler has been\r
 343                 started, then xTimerTaskHandle will be NULL. */\r
 344                 configASSERT( ( xTimerTaskHandle != NULL ) );\r
 345                 return xTimerTaskHandle;\r
 346         }\r
 347 \r
 348 #endif\r
 349 /*-----------------------------------------------------------*/\r
 350 \r
 351 static void prvProcessExpiredTimer( portTickType xNextExpireTime, portTickType xTimeNow )\r
 352 {\r
 353 xTIMER *pxTimer;\r
 354 portBASE_TYPE xResult;\r
 355 \r
 356         /* Remove the timer from the list of active timers.  A check has already\r
 357         been performed to ensure the list is not empty. */\r
 358         pxTimer = ( xTIMER * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 359         ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
 360         traceTIMER_EXPIRED( pxTimer );\r
 361 \r
 362         /* If the timer is an auto reload timer then calculate the next\r
 363         expiry time and re-insert the timer in the list of active timers. */\r
 364         if( pxTimer->uxAutoReload == ( unsigned portBASE_TYPE ) pdTRUE )\r
 365         {\r
 366                 /* This is the only time a timer is inserted into a list using\r
 367                 a time relative to anything other than the current time.  It\r
 368                 will therefore be inserted into the correct list relative to\r
 369                 the time this task thinks it is now, even if a command to\r
 370                 switch lists due to a tick count overflow is already waiting in\r
 371                 the timer queue. */\r
 372                 if( prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow, xNextExpireTime ) == pdTRUE )\r
 373                 {\r
 374                         /* The timer expired before it was added to the active timer\r
 375                         list.  Reload it now.  */\r
 376                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START, xNextExpireTime, NULL, tmrNO_DELAY );\r
 377                         configASSERT( xResult );\r
 378                         ( void ) xResult;\r
 379                 }\r
 380         }\r
 381 \r
 382         /* Call the timer callback. */\r
 383         pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 384 }\r
 385 /*-----------------------------------------------------------*/\r
 386 \r
 387 static void prvTimerTask( void *pvParameters )\r
 388 {\r
 389 portTickType xNextExpireTime;\r
 390 portBASE_TYPE xListWasEmpty;\r
 391 \r
 392         /* Just to avoid compiler warnings. */\r
 393         ( void ) pvParameters;\r
 394 \r
 395         for( ;; )\r
 396         {\r
 397                 /* Query the timers list to see if it contains any timers, and if so,\r
 398                 obtain the time at which the next timer will expire. */\r
 399                 xNextExpireTime = prvGetNextExpireTime( &xListWasEmpty );\r
 400 \r
 401                 /* If a timer has expired, process it.  Otherwise, block this task\r
 402                 until either a timer does expire, or a command is received. */\r
 403                 prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
 404 \r
 405                 /* Empty the command queue. */\r
 406                 prvProcessReceivedCommands();\r
 407         }\r
 408 }\r
 409 /*-----------------------------------------------------------*/\r
 410 \r
 411 static void prvProcessTimerOrBlockTask( portTickType xNextExpireTime, portBASE_TYPE xListWasEmpty )\r
 412 {\r
 413 portTickType xTimeNow;\r
 414 portBASE_TYPE xTimerListsWereSwitched;\r
 415 \r
 416         vTaskSuspendAll();\r
 417         {\r
 418                 /* Obtain the time now to make an assessment as to whether the timer\r
 419                 has expired or not.  If obtaining the time causes the lists to switch\r
 420                 then don't process this timer as any timers that remained in the list\r
 421                 when the lists were switched will have been processed within the\r
 422                 prvSampleTimeNow() function. */\r
 423                 xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 424                 if( xTimerListsWereSwitched == pdFALSE )\r
 425                 {\r
 426                         /* The tick count has not overflowed, has the timer expired? */\r
 427                         if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
 428                         {\r
 429                                 ( void ) xTaskResumeAll();\r
 430                                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
 431                         }\r
 432                         else\r
 433                         {\r
 434                                 /* The tick count has not overflowed, and the next expire\r
 435                                 time has not been reached yet.  This task should therefore\r
 436                                 block to wait for the next expire time or a command to be\r
 437                                 received - whichever comes first.  The following line cannot\r
 438                                 be reached unless xNextExpireTime > xTimeNow, except in the\r
 439                                 case when the current timer list is empty. */\r
 440                                 vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ) );\r
 441 \r
 442                                 if( xTaskResumeAll() == pdFALSE )\r
 443                                 {\r
 444                                         /* Yield to wait for either a command to arrive, or the block time\r
 445                                         to expire.  If a command arrived between the critical section being\r
 446                                         exited and this yield then the yield will not cause the task\r
 447                                         to block. */\r
 448                                         portYIELD_WITHIN_API();\r
 449                                 }\r
 450                         }\r
 451                 }\r
 452                 else\r
 453                 {\r
 454                         ( void ) xTaskResumeAll();\r
 455                 }\r
 456         }\r
 457 }\r
 458 /*-----------------------------------------------------------*/\r
 459 \r
 460 static portTickType prvGetNextExpireTime( portBASE_TYPE *pxListWasEmpty )\r
 461 {\r
 462 portTickType xNextExpireTime;\r
 463 \r
 464         /* Timers are listed in expiry time order, with the head of the list\r
 465         referencing the task that will expire first.  Obtain the time at which\r
 466         the timer with the nearest expiry time will expire.  If there are no\r
 467         active timers then just set the next expire time to 0.  That will cause\r
 468         this task to unblock when the tick count overflows, at which point the\r
 469         timer lists will be switched and the next expiry time can be\r
 470         re-assessed.  */\r
 471         *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
 472         if( *pxListWasEmpty == pdFALSE )\r
 473         {\r
 474                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 475         }\r
 476         else\r
 477         {\r
 478                 /* Ensure the task unblocks when the tick count rolls over. */\r
 479                 xNextExpireTime = ( portTickType ) 0U;\r
 480         }\r
 481 \r
 482         return xNextExpireTime;\r
 483 }\r
 484 /*-----------------------------------------------------------*/\r
 485 \r
 486 static portTickType prvSampleTimeNow( portBASE_TYPE *pxTimerListsWereSwitched )\r
 487 {\r
 488 portTickType xTimeNow;\r
 489 PRIVILEGED_DATA static portTickType xLastTime = ( portTickType ) 0U; /*lint !e956 Variable is only accessible to one task. */\r
 490 \r
 491         xTimeNow = xTaskGetTickCount();\r
 492 \r
 493         if( xTimeNow < xLastTime )\r
 494         {\r
 495                 prvSwitchTimerLists( xLastTime );\r
 496                 *pxTimerListsWereSwitched = pdTRUE;\r
 497         }\r
 498         else\r
 499         {\r
 500                 *pxTimerListsWereSwitched = pdFALSE;\r
 501         }\r
 502 \r
 503         xLastTime = xTimeNow;\r
 504 \r
 505         return xTimeNow;\r
 506 }\r
 507 /*-----------------------------------------------------------*/\r
 508 \r
 509 static portBASE_TYPE prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow, portTickType xCommandTime )\r
 510 {\r
 511 portBASE_TYPE xProcessTimerNow = pdFALSE;\r
 512 \r
 513         listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
 514         listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
 515 \r
 516         if( xNextExpiryTime <= xTimeNow )\r
 517         {\r
 518                 /* Has the expiry time elapsed between the command to start/reset a\r
 519                 timer was issued, and the time the command was processed? */\r
 520                 if( ( xTimeNow - xCommandTime ) >= pxTimer->xTimerPeriodInTicks )\r
 521                 {\r
 522                         /* The time between a command being issued and the command being\r
 523                         processed actually exceeds the timers period.  */\r
 524                         xProcessTimerNow = pdTRUE;\r
 525                 }\r
 526                 else\r
 527                 {\r
 528                         vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
 529                 }\r
 530         }\r
 531         else\r
 532         {\r
 533                 if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
 534                 {\r
 535                         /* If, since the command was issued, the tick count has overflowed\r
 536                         but the expiry time has not, then the timer must have already passed\r
 537                         its expiry time and should be processed immediately. */\r
 538                         xProcessTimerNow = pdTRUE;\r
 539                 }\r
 540                 else\r
 541                 {\r
 542                         vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
 543                 }\r
 544         }\r
 545 \r
 546         return xProcessTimerNow;\r
 547 }\r
 548 /*-----------------------------------------------------------*/\r
 549 \r
 550 static void     prvProcessReceivedCommands( void )\r
 551 {\r
 552 xDAEMON_TASK_MESSAGE xMessage;\r
 553 xTIMER *pxTimer;\r
 554 portBASE_TYPE xTimerListsWereSwitched, xResult;\r
 555 portTickType xTimeNow;\r
 556 \r
 557         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
 558         {\r
 559                 #if ( INCLUDE_xTimerPendCallbackFromISR == 1 )\r
 560                 {\r
 561                         if( xMessage.xMessageID == tmrCOMMAND_EXECUTE_CALLBACK )\r
 562                         {\r
 563                                 const xCallbackParametersType * const pxCallback = &( xMessage.u.xCallbackParameters );\r
 564 \r
 565                                 /* The timer uses the xCallbackParameters member to request a\r
 566                                 callback be executed.  Check the callback is not NULL. */\r
 567                                 configASSERT( pxCallback );\r
 568 \r
 569                                 /* Call the function. */\r
 570                                 pxCallback->pxCallbackFunction( pxCallback->pvParameter1, pxCallback->ulParameter2 );\r
 571                         }\r
 572                 }\r
 573                 #endif /* INCLUDE_xTimerPendCallbackFromISR */\r
 574 \r
 575                 if( xMessage.xMessageID != tmrCOMMAND_EXECUTE_CALLBACK )\r
 576                 {\r
 577                         /* The messages uses the xTimerParameters member to work on a\r
 578                         software timer. */\r
 579                         pxTimer = xMessage.u.xTimerParameters.pxTimer;\r
 580 \r
 581                         if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE )\r
 582                         {\r
 583                                 /* The timer is in a list, remove it. */\r
 584                                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
 585                         }\r
 586 \r
 587                         traceTIMER_COMMAND_RECEIVED( pxTimer, xMessage.xMessageID, xMessage.u.xTimerParameters.xMessageValue );\r
 588 \r
 589                         /* In this case the xTimerListsWereSwitched parameter is not used, but\r
 590                         it must be present in the function call.  prvSampleTimeNow() must be\r
 591                         called after the message is received from xTimerQueue so there is no\r
 592                         possibility of a higher priority task adding a message to the message\r
 593                         queue with a time that is ahead of the timer daemon task (because it\r
 594                         pre-empted the timer daemon task after the xTimeNow value was set). */\r
 595                         xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 596 \r
 597                         switch( xMessage.xMessageID )\r
 598                         {\r
 599                                 case tmrCOMMAND_START :\r
 600                                         /* Start or restart a timer. */\r
 601                                         if( prvInsertTimerInActiveList( pxTimer,  xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.u.xTimerParameters.xMessageValue ) == pdTRUE )\r
 602                                         {\r
 603                                                 /* The timer expired before it was added to the active timer\r
 604                                                 list.  Process it now. */\r
 605                                                 pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 606 \r
 607                                                 if( pxTimer->uxAutoReload == ( unsigned portBASE_TYPE ) pdTRUE )\r
 608                                                 {\r
 609                                                         xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START, xMessage.u.xTimerParameters.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
 610                                                         configASSERT( xResult );\r
 611                                                         ( void ) xResult;\r
 612                                                 }\r
 613                                         }\r
 614                                         break;\r
 615 \r
 616                                 case tmrCOMMAND_STOP :\r
 617                                         /* The timer has already been removed from the active list.\r
 618                                         There is nothing to do here. */\r
 619                                         break;\r
 620 \r
 621                                 case tmrCOMMAND_CHANGE_PERIOD :\r
 622                                         pxTimer->xTimerPeriodInTicks = xMessage.u.xTimerParameters.xMessageValue;\r
 623                                         configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
 624 \r
 625                                         /* The new period does not really have a reference, and can be\r
 626                                         longer or shorter than the old one.  The command time is\r
 627                                         therefore set to the current time, and as the period cannot be\r
 628                                         zero the next expiry time can only be in the future, meaning\r
 629                                         (unlike for the xTimerStart() case above) there is no fail case\r
 630                                         that needs to be handled here. */\r
 631                                         ( void ) prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
 632                                         break;\r
 633 \r
 634                                 case tmrCOMMAND_DELETE :\r
 635                                         /* The timer has already been removed from the active list,\r
 636                                         just free up the memory. */\r
 637                                         vPortFree( pxTimer );\r
 638                                         break;\r
 639 \r
 640                                 default :\r
 641                                         /* Don't expect to get here. */\r
 642                                         break;\r
 643                         }\r
 644                 }\r
 645         }\r
 646 }\r
 647 /*-----------------------------------------------------------*/\r
 648 \r
 649 static void prvSwitchTimerLists( portTickType xLastTime )\r
 650 {\r
 651 portTickType xNextExpireTime, xReloadTime;\r
 652 xList *pxTemp;\r
 653 xTIMER *pxTimer;\r
 654 portBASE_TYPE xResult;\r
 655 \r
 656         /* Remove compiler warnings if configASSERT() is not defined. */\r
 657         ( void ) xLastTime;\r
 658 \r
 659         /* The tick count has overflowed.  The timer lists must be switched.\r
 660         If there are any timers still referenced from the current timer list\r
 661         then they must have expired and should be processed before the lists\r
 662         are switched. */\r
 663         while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
 664         {\r
 665                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 666 \r
 667                 /* Remove the timer from the list. */\r
 668                 pxTimer = ( xTIMER * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 669                 ( void ) uxListRemove( &( pxTimer->xTimerListItem ) );\r
 670 \r
 671                 /* Execute its callback, then send a command to restart the timer if\r
 672                 it is an auto-reload timer.  It cannot be restarted here as the lists\r
 673                 have not yet been switched. */\r
 674                 pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 675 \r
 676                 if( pxTimer->uxAutoReload == ( unsigned portBASE_TYPE ) pdTRUE )\r
 677                 {\r
 678                         /* Calculate the reload value, and if the reload value results in\r
 679                         the timer going into the same timer list then it has already expired\r
 680                         and the timer should be re-inserted into the current list so it is\r
 681                         processed again within this loop.  Otherwise a command should be sent\r
 682                         to restart the timer to ensure it is only inserted into a list after\r
 683                         the lists have been swapped. */\r
 684                         xReloadTime = ( xNextExpireTime + pxTimer->xTimerPeriodInTicks );\r
 685                         if( xReloadTime > xNextExpireTime )\r
 686                         {\r
 687                                 listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xReloadTime );\r
 688                                 listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
 689                                 vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
 690                         }\r
 691                         else\r
 692                         {\r
 693                                 xResult = xTimerGenericCommand( pxTimer, tmrCOMMAND_START, xNextExpireTime, NULL, tmrNO_DELAY );\r
 694                                 configASSERT( xResult );\r
 695                                 ( void ) xResult;\r
 696                         }\r
 697                 }\r
 698         }\r
 699 \r
 700         pxTemp = pxCurrentTimerList;\r
 701         pxCurrentTimerList = pxOverflowTimerList;\r
 702         pxOverflowTimerList = pxTemp;\r
 703 }\r
 704 /*-----------------------------------------------------------*/\r
 705 \r
 706 static void prvCheckForValidListAndQueue( void )\r
 707 {\r
 708         /* Check that the list from which active timers are referenced, and the\r
 709         queue used to communicate with the timer service, have been\r
 710         initialised. */\r
 711         taskENTER_CRITICAL();\r
 712         {\r
 713                 if( xTimerQueue == NULL )\r
 714                 {\r
 715                         vListInitialise( &xActiveTimerList1 );\r
 716                         vListInitialise( &xActiveTimerList2 );\r
 717                         pxCurrentTimerList = &xActiveTimerList1;\r
 718                         pxOverflowTimerList = &xActiveTimerList2;\r
 719                         xTimerQueue = xQueueCreate( ( unsigned portBASE_TYPE ) configTIMER_QUEUE_LENGTH, sizeof( xDAEMON_TASK_MESSAGE ) );\r
 720                         configASSERT( xTimerQueue );\r
 721 \r
 722                         #if ( configQUEUE_REGISTRY_SIZE > 0 )\r
 723                         {\r
 724                                 if( xTimerQueue != NULL )\r
 725                                 {\r
 726                                         vQueueAddToRegistry( xTimerQueue, ( signed char * ) "TmrQ" );\r
 727                                 }\r
 728                         }\r
 729                         #endif /* configQUEUE_REGISTRY_SIZE */\r
 730                 }\r
 731         }\r
 732         taskEXIT_CRITICAL();\r
 733 }\r
 734 /*-----------------------------------------------------------*/\r
 735 \r
 736 portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer )\r
 737 {\r
 738 portBASE_TYPE xTimerIsInActiveList;\r
 739 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 740 \r
 741         /* Is the timer in the list of active timers? */\r
 742         taskENTER_CRITICAL();\r
 743         {\r
 744                 /* Checking to see if it is in the NULL list in effect checks to see if\r
 745                 it is referenced from either the current or the overflow timer lists in\r
 746                 one go, but the logic has to be reversed, hence the '!'. */\r
 747                 xTimerIsInActiveList = !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) );\r
 748         }\r
 749         taskEXIT_CRITICAL();\r
 750 \r
 751         return xTimerIsInActiveList;\r
 752 }\r
 753 /*-----------------------------------------------------------*/\r
 754 \r
 755 void *pvTimerGetTimerID( xTimerHandle xTimer )\r
 756 {\r
 757 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 758 \r
 759         return pxTimer->pvTimerID;\r
 760 }\r
 761 /*-----------------------------------------------------------*/\r
 762 \r
 763 #if( INCLUDE_xTimerPendCallbackFromISR == 1 )\r
 764 \r
 765         portBASE_TYPE xTimerPendCallbackFromISR( pdAPPLICATION_CALLBACK_CODE pvCallbackFunction, void *pvParameter1, unsigned long ulParameter2, portBASE_TYPE *pxHigherPriorityTaskWoken )\r
 766         {\r
 767         xDAEMON_TASK_MESSAGE xMessage;\r
 768         portBASE_TYPE xReturn;\r
 769 \r
 770                 /* Complete the message with the function parameters and post it to the\r
 771                 daemon task. */\r
 772                 xMessage.xMessageID = tmrCOMMAND_EXECUTE_CALLBACK;\r
 773                 xMessage.u.xCallbackParameters.pxCallbackFunction = pvCallbackFunction;\r
 774                 xMessage.u.xCallbackParameters.pvParameter1 = pvParameter1;\r
 775                 xMessage.u.xCallbackParameters.ulParameter2 = ulParameter2;\r
 776 \r
 777                 xReturn = xQueueSendFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
 778 \r
 779                 return xReturn;\r
 780         }\r
 781 \r
 782 #endif /* INCLUDE_xTimerPendCallbackFromISR */\r
 783 /*-----------------------------------------------------------*/\r
 784 \r
 785 /* This entire source file will be skipped if the application is not configured\r
 786 to include software timer functionality.  If you want to include software timer\r
 787 functionality then ensure configUSE_TIMERS is set to 1 in FreeRTOSConfig.h. */\r
 788 #endif /* configUSE_TIMERS == 1 */\r
 789 \r
 790 \r
 791 \r