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

   1 /*\r
   2     FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public\r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /* Defining MPU_WRAPPERS_INCLUDED_FROM_API_FILE prevents task.h from redefining\r
  55 all the API functions to use the MPU wrappers.  That should only be done when\r
  56 task.h is included from an application file. */\r
  57 #define MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  58 \r
  59 #include "FreeRTOS.h"\r
  60 #include "task.h"\r
  61 #include "queue.h"\r
  62 #include "timers.h"\r
  63 \r
  64 #undef MPU_WRAPPERS_INCLUDED_FROM_API_FILE\r
  65 \r
  66 /* Misc definitions. */\r
  67 #define tmrNO_DELAY             ( portTickType ) 0U\r
  68 \r
  69 /* The definition of the timers themselves. */\r
  70 typedef struct tmrTimerControl\r
  71 {\r
  72         const signed char               *pcTimerName;           /*<< Text name.  This is not used by the kernel, it is included simply to make debugging easier. */\r
  73         xListItem                               xTimerListItem;         /*<< Standard linked list item as used by all kernel features for event management. */\r
  74         portTickType                    xTimerPeriodInTicks;/*<< How quickly and often the timer expires. */\r
  75         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
  76         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
  77         tmrTIMER_CALLBACK               pxCallbackFunction;     /*<< The function that will be called when the timer expires. */\r
  78 } xTIMER;\r
  79 \r
  80 /* The definition of messages that can be sent and received on the timer\r
  81 queue. */\r
  82 typedef struct tmrTimerQueueMessage\r
  83 {\r
  84         portBASE_TYPE                   xMessageID;                     /*<< The command being sent to the timer service task. */\r
  85         portTickType                    xMessageValue;          /*<< An optional value used by a subset of commands, for example, when changing the period of a timer. */\r
  86         xTIMER *                                pxTimer;                        /*<< The timer to which the command will be applied. */\r
  87 } xTIMER_MESSAGE;\r
  88 \r
  89 \r
  90 /* The list in which active timers are stored.  Timers are referenced in expire\r
  91 time order, with the nearest expiry time at the front of the list.  Only the\r
  92 timer service task is allowed to access xActiveTimerList. */\r
  93 PRIVILEGED_DATA static xList xActiveTimerList1;\r
  94 PRIVILEGED_DATA static xList xActiveTimerList2;\r
  95 PRIVILEGED_DATA static xList *pxCurrentTimerList;\r
  96 PRIVILEGED_DATA static xList *pxOverflowTimerList;\r
  97 \r
  98 /* A queue that is used to send commands to the timer service task. */\r
  99 PRIVILEGED_DATA static xQueueHandle xTimerQueue = NULL;\r
 100 \r
 101 /*-----------------------------------------------------------*/\r
 102 \r
 103 /*\r
 104  * Initialise the infrastructure used by the timer service task if it has not\r
 105  * been initialised already.\r
 106  */\r
 107 static void prvCheckForValidListAndQueue( void ) PRIVILEGED_FUNCTION;\r
 108 \r
 109 /*\r
 110  * The timer service task (daemon).  Timer functionality is controlled by this\r
 111  * task.  Other tasks communicate with the timer service task using the\r
 112  * xTimerQueue queue.\r
 113  */\r
 114 static void prvTimerTask( void *pvParameters ) PRIVILEGED_FUNCTION;\r
 115 \r
 116 /*\r
 117  * Called by the timer service task to interpret and process a command it\r
 118  * received on the timer queue.\r
 119  */\r
 120 static void     prvProcessReceivedCommands( void ) PRIVILEGED_FUNCTION;\r
 121 \r
 122 /*\r
 123  * Insert the timer into either xActiveTimerList1, or xActiveTimerList2,\r
 124  * depending on if the expire time causes a timer counter overflow.\r
 125  */\r
 126 static portBASE_TYPE prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow, portTickType xCommandTime ) PRIVILEGED_FUNCTION;\r
 127 \r
 128 /*\r
 129  * An active timer has reached its expire time.  Reload the timer if it is an\r
 130  * auto reload timer, then call its callback.\r
 131  */\r
 132 static void prvProcessExpiredTimer( portTickType xNextExpireTime, portTickType xTimeNow ) PRIVILEGED_FUNCTION;\r
 133 \r
 134 /*\r
 135  * The tick count has overflowed.  Switch the timer lists after ensuring the\r
 136  * current timer list does not still reference some timers.\r
 137  */\r
 138 static void prvSwitchTimerLists( portTickType xTimeNow, portTickType xLastTime ) PRIVILEGED_FUNCTION;\r
 139 \r
 140 /*\r
 141  * Obtain the current tick count, setting *pxTimerListsWereSwitched to pdTRUE\r
 142  * if a tick count overflow occurred since prvSampleTimeNow() was last called.\r
 143  */\r
 144 static portTickType prvSampleTimeNow( portBASE_TYPE *pxTimerListsWereSwitched ) PRIVILEGED_FUNCTION;\r
 145 \r
 146 /*\r
 147  * If the timer list contains any active timers then return the expire time of\r
 148  * the timer that will expire first and set *pxListWasEmpty to false.  If the\r
 149  * timer list does not contain any timers then return 0 and set *pxListWasEmpty\r
 150  * to pdTRUE.\r
 151  */\r
 152 static portTickType prvLookForExpiredTimer( portBASE_TYPE *pxListWasEmpty ) PRIVILEGED_FUNCTION;\r
 153 \r
 154 /*\r
 155  * If a timer has expired, process it.  Otherwise, block the timer service task\r
 156  * until either a timer does expire or a command is received.\r
 157  */\r
 158 static void prvProcessTimerOrBlockTask( portTickType xNextExpireTime, portBASE_TYPE xListWasEmpty ) PRIVILEGED_FUNCTION;\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 portBASE_TYPE xTimerCreateTimerTask( void )\r
 163 {\r
 164 portBASE_TYPE xReturn = pdFAIL;\r
 165 \r
 166         /* This function is called when the scheduler is started if\r
 167         configUSE_TIMERS is set to 1.  Check that the infrastructure used by the\r
 168         timer service task has been created/initialised.  If timers have already\r
 169         been created then the initialisation will already have been performed. */\r
 170         prvCheckForValidListAndQueue();\r
 171 \r
 172         if( xTimerQueue != NULL )\r
 173         {\r
 174                 xReturn = xTaskCreate( prvTimerTask, ( const signed char * ) "Tmr Svc", configTIMER_TASK_STACK_DEPTH, NULL, configTIMER_TASK_PRIORITY, NULL);\r
 175         }\r
 176 \r
 177         return xReturn;\r
 178 }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 xTimerHandle xTimerCreate( const signed char *pcTimerName, portTickType xTimerPeriodInTicks, unsigned portBASE_TYPE uxAutoReload, void *pvTimerID, tmrTIMER_CALLBACK pxCallbackFunction )\r
 182 {\r
 183 xTIMER *pxNewTimer;\r
 184 \r
 185         /* Allocate the timer structure. */\r
 186         if( xTimerPeriodInTicks == ( portTickType ) 0U )\r
 187         {\r
 188                 pxNewTimer = NULL;\r
 189                 configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
 190         }\r
 191         else\r
 192         {\r
 193                 pxNewTimer = ( xTIMER * ) pvPortMalloc( sizeof( xTIMER ) );\r
 194                 if( pxNewTimer != NULL )\r
 195                 {\r
 196                         /* Ensure the infrastructure used by the timer service task has been\r
 197                         created/initialised. */\r
 198                         prvCheckForValidListAndQueue();\r
 199         \r
 200                         configASSERT( ( xTimerPeriodInTicks > 0 ) );\r
 201         \r
 202                         /* Initialise the timer structure members using the function parameters. */\r
 203                         pxNewTimer->pcTimerName = pcTimerName;\r
 204                         pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
 205                         pxNewTimer->uxAutoReload = uxAutoReload;\r
 206                         pxNewTimer->pvTimerID = pvTimerID;\r
 207                         pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
 208                         vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
 209                 }\r
 210         }\r
 211         \r
 212         return ( xTimerHandle ) pxNewTimer;\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 portBASE_TYPE xTimerGenericCommand( xTimerHandle xTimer, portBASE_TYPE xCommandID, portTickType xOptionalValue, portBASE_TYPE *pxHigherPriorityTaskWoken, portTickType xBlockTime )\r
 217 {\r
 218 portBASE_TYPE xReturn = pdFAIL;\r
 219 xTIMER_MESSAGE xMessage;\r
 220 \r
 221         /* Send a message to the timer service task to perform a particular action\r
 222         on a particular timer definition. */\r
 223         if( xTimerQueue != NULL )\r
 224         {\r
 225                 /* Send a command to the timer service task to start the xTimer timer. */\r
 226                 xMessage.xMessageID = xCommandID;\r
 227                 xMessage.xMessageValue = xOptionalValue;\r
 228                 xMessage.pxTimer = ( xTIMER * ) xTimer;\r
 229 \r
 230                 if( pxHigherPriorityTaskWoken == NULL )\r
 231                 {\r
 232                         if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
 233                         {\r
 234                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xBlockTime );\r
 235                         }\r
 236                         else\r
 237                         {\r
 238                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
 239                         }\r
 240                 }\r
 241                 else\r
 242                 {\r
 243                         xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
 244                 }\r
 245         }\r
 246 \r
 247         configASSERT( xReturn );\r
 248         return xReturn;\r
 249 }\r
 250 /*-----------------------------------------------------------*/\r
 251 \r
 252 static void prvProcessExpiredTimer( portTickType xNextExpireTime, portTickType xTimeNow )\r
 253 {\r
 254 xTIMER *pxTimer;\r
 255 \r
 256         /* Remove the timer from the list of active timers.  A check has already\r
 257         been performed to ensure the list is not empty. */\r
 258         pxTimer = ( xTIMER * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 259         vListRemove( &( pxTimer->xTimerListItem ) );\r
 260 \r
 261         /* If the timer is an auto reload timer then calculate the next\r
 262         expiry time and re-insert the timer in the list of active timers. */\r
 263         if( pxTimer->uxAutoReload == pdTRUE )\r
 264         {\r
 265                 /* This is the only time a timer is inserted into a list using\r
 266                 a time relative to anything other than the current time.  It\r
 267                 will therefore be inserted into the correct list relative to\r
 268                 the time this task thinks it is now, even if a command to\r
 269                 switch lists due to a tick count overflow is already waiting in\r
 270                 the timer queue. */\r
 271                 prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow );\r
 272         }\r
 273 \r
 274         /* Call the timer callback. */\r
 275         pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 276 }\r
 277 /*-----------------------------------------------------------*/\r
 278 \r
 279 static void prvTimerTask( void *pvParameters )\r
 280 {\r
 281 portTickType xNextExpireTime;\r
 282 portBASE_TYPE xListWasEmpty;\r
 283 \r
 284         /* Just to avoid compiler warnings. */\r
 285         ( void ) pvParameters;\r
 286 \r
 287         for( ;; )\r
 288         {\r
 289                 /* Query the timers list to see if it contains any timers, and if so,\r
 290                 obtain the time at which the next timer will expire. */\r
 291                 xNextExpireTime = prvLookForExpiredTimer( &xListWasEmpty );\r
 292 \r
 293                 /* If a timer has expired, process it.  Otherwise, block this task\r
 294                 until either a timer does expire, or a command is received. */\r
 295                 prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
 296                 \r
 297                 /* Empty the command queue. */\r
 298                 prvProcessReceivedCommands();           \r
 299         }\r
 300 }\r
 301 /*-----------------------------------------------------------*/\r
 302 \r
 303 static void prvProcessTimerOrBlockTask( portTickType xNextExpireTime, portBASE_TYPE xListWasEmpty )\r
 304 {\r
 305 portTickType xTimeNow;\r
 306 portBASE_TYPE xTimerListsWereSwitched;\r
 307 \r
 308         vTaskSuspendAll();\r
 309         {\r
 310                 /* Obtain the time now to make an assessment as to whether the timer\r
 311                 has expired or not.  If obtaining the time causes the lists to switch\r
 312                 then don't process this timer as any timers that remained in the list\r
 313                 when the lists were switched will have been processed within the\r
 314                 prvSampelTimeNow() function. */\r
 315                 xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 316                 if( xTimerListsWereSwitched == pdFALSE )\r
 317                 {\r
 318                         /* The tick count has not overflowed, has the timer expired? */\r
 319                         if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
 320                         {\r
 321                                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
 322                         }\r
 323                         else\r
 324                         {\r
 325                                 /* The tick count has not overflowed, and the next expire\r
 326                                 time has not been reached yet.  This task should therefore\r
 327                                 block to wait for the next expire time or a command to be\r
 328                                 received - whichever comes first.  The following line cannot\r
 329                                 be reached unless xNextExpireTime > xTimeNow, except in the\r
 330                                 case when the current timer list is empty. */\r
 331                                 vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ) );\r
 332                         }\r
 333                 }\r
 334         }\r
 335         if( xTaskResumeAll() == pdFALSE )\r
 336         {\r
 337                 /* Yield to wait for either a command to arrive, or the block time\r
 338                 to expire.  If a command arrived between the critical section being\r
 339                 exited and this yield then the yield will not cause the task\r
 340                 to block. */\r
 341                 portYIELD_WITHIN_API();\r
 342         }\r
 343 }\r
 344 /*-----------------------------------------------------------*/\r
 345 \r
 346 static portTickType prvLookForExpiredTimer( portBASE_TYPE *pxListWasEmpty )\r
 347 {\r
 348 portTickType xNextExpireTime;\r
 349 \r
 350         /* Timers are listed in expiry time order, with the head of the list\r
 351         referencing the task that will expire first.  Obtain the time at which\r
 352         the timer with the nearest expiry time will expire.  If there are no\r
 353         active timers then just set the next expire time to 0.  That will cause\r
 354         this task to unblock when the tick count overflows, at which point the\r
 355         timer lists will be switched and the next expiry time can be\r
 356         re-assessed.  */\r
 357         *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
 358         if( *pxListWasEmpty == pdFALSE )\r
 359         {\r
 360                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 361         }\r
 362         else\r
 363         {\r
 364                 /* Ensure the task unblocks when the tick count rolls over. */\r
 365                 xNextExpireTime = ( portTickType ) 0U;\r
 366         }\r
 367 \r
 368         return xNextExpireTime;\r
 369 }\r
 370 /*-----------------------------------------------------------*/\r
 371 \r
 372 static portTickType prvSampleTimeNow( portBASE_TYPE *pxTimerListsWereSwitched )\r
 373 {\r
 374 portTickType xTimeNow;\r
 375 static portTickType xLastTime = ( portTickType ) 0U;\r
 376 \r
 377         xTimeNow = xTaskGetTickCount();\r
 378         \r
 379         if( xTimeNow < xLastTime )\r
 380         {\r
 381                 prvSwitchTimerLists( xTimeNow, xLastTime );\r
 382                 *pxTimerListsWereSwitched = pdTRUE;\r
 383         }\r
 384         else\r
 385         {\r
 386                 *pxTimerListsWereSwitched = pdFALSE;\r
 387         }\r
 388         \r
 389         xLastTime = xTimeNow;\r
 390         \r
 391         return xTimeNow;\r
 392 }\r
 393 /*-----------------------------------------------------------*/\r
 394 \r
 395 static portBASE_TYPE prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow, portTickType xCommandTime )\r
 396 {\r
 397 portBASE_TYPE xProcessTimerNow = pdFALSE;\r
 398 \r
 399         listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
 400         listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
 401         \r
 402         if( xNextExpiryTime <= xTimeNow )\r
 403         {\r
 404                 /* Has the expiry time elapsed between the command to start/reset a\r
 405                 timer was issued, and the time the command was processed? */\r
 406                 if( ( xTimeNow - xCommandTime ) >= pxTimer->xTimerPeriodInTicks )\r
 407                 {\r
 408                         /* The time between a command being issued and the command being\r
 409                         processed actually exceeds the timers period.  */\r
 410                         xProcessTimerNow = pdTRUE;\r
 411                 }\r
 412                 else\r
 413                 {\r
 414                         vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
 415                 }\r
 416         }\r
 417         else\r
 418         {\r
 419                 if( ( xTimeNow < xCommandTime ) && ( xNextExpiryTime >= xCommandTime ) )\r
 420                 {\r
 421                         /* If, since the command was issued, the tick count has overflowed\r
 422                         but the expiry time has not, then the timer must have already passed\r
 423                         its expiry time and should be processed immediately. */\r
 424                         xProcessTimerNow = pdTRUE;\r
 425                 }\r
 426                 else\r
 427                 {\r
 428                         vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
 429                 }\r
 430         }\r
 431 \r
 432         return xProcessTimerNow;\r
 433 }\r
 434 /*-----------------------------------------------------------*/\r
 435 \r
 436 static void     prvProcessReceivedCommands( void )\r
 437 {\r
 438 xTIMER_MESSAGE xMessage;\r
 439 xTIMER *pxTimer;\r
 440 portBASE_TYPE xTimerListsWereSwitched;\r
 441 portTickType xTimeNow;\r
 442 \r
 443         /* In this case the xTimerListsWereSwitched parameter is not used, but it\r
 444         must be present in the function call. */\r
 445         xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 446 \r
 447         while( xQueueReceive( xTimerQueue, &xMessage, tmrNO_DELAY ) != pdFAIL )\r
 448         {\r
 449                 pxTimer = xMessage.pxTimer;\r
 450 \r
 451                 /* Is the timer already in a list of active timers?  When the command\r
 452                 is trmCOMMAND_PROCESS_TIMER_OVERFLOW, the timer will be NULL as the\r
 453                 command is to the task rather than to an individual timer. */\r
 454                 if( pxTimer != NULL )\r
 455                 {\r
 456                         if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE )\r
 457                         {\r
 458                                 /* The timer is in a list, remove it. */\r
 459                                 vListRemove( &( pxTimer->xTimerListItem ) );\r
 460                         }\r
 461                 }\r
 462 \r
 463                 switch( xMessage.xMessageID )\r
 464                 {\r
 465                         case tmrCOMMAND_START : \r
 466                                 /* Start or restart a timer. */\r
 467                                 if( prvInsertTimerInActiveList( pxTimer,  xMessage.xMessageValue + pxTimer->xTimerPeriodInTicks, xTimeNow, xMessage.xMessageValue ) == pdTRUE )\r
 468                                 {\r
 469                                         /* The timer expired before it was added to the active timer\r
 470                                         list.  Process it now. */\r
 471                                         /* Call the timer callback. */\r
 472                                         pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 473 \r
 474                                         if( pxTimer->uxAutoReload == pdTRUE )\r
 475                                         {\r
 476                                                 xTimerGenericCommand( pxTimer, tmrCOMMAND_START, xMessage.xMessageValue + pxTimer->xTimerPeriodInTicks, NULL, tmrNO_DELAY );\r
 477                                         }\r
 478                                 }\r
 479                                 break;\r
 480 \r
 481                         case tmrCOMMAND_STOP :  \r
 482                                 /* The timer has already been removed from the active list.\r
 483                                 There is nothing to do here. */\r
 484                                 break;\r
 485 \r
 486                         case tmrCOMMAND_CHANGE_PERIOD :\r
 487                                 pxTimer->xTimerPeriodInTicks = xMessage.xMessageValue;\r
 488                                 configASSERT( ( pxTimer->xTimerPeriodInTicks > 0 ) );\r
 489                                 prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow, xTimeNow );\r
 490                                 break;\r
 491 \r
 492                         case tmrCOMMAND_DELETE :\r
 493                                 /* The timer has already been removed from the active list,\r
 494                                 just free up the memory. */\r
 495                                 vPortFree( pxTimer );\r
 496                                 break;\r
 497 \r
 498                         default :                       \r
 499                                 /* Don't expect to get here. */\r
 500                                 break;\r
 501                 }\r
 502         }\r
 503 }\r
 504 /*-----------------------------------------------------------*/\r
 505 \r
 506 static void prvSwitchTimerLists( portTickType xTimeNow, portTickType xLastTime )\r
 507 {\r
 508 portTickType xNextExpireTime;\r
 509 xList *pxTemp;\r
 510 \r
 511         /* Remove compiler warnings if configASSERT() is not defined. */\r
 512         ( void ) xLastTime;\r
 513         \r
 514         /* The tick count has overflowed.  The timer lists must be switched.\r
 515         If there are any timers still referenced from the current timer list\r
 516         then they must have expired and should be processed before the lists\r
 517         are switched. */\r
 518         while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
 519         {\r
 520                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 521                 configASSERT( ( xNextExpireTime >= xLastTime ) );\r
 522                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
 523         }\r
 524 \r
 525         pxTemp = pxCurrentTimerList;\r
 526         pxCurrentTimerList = pxOverflowTimerList;\r
 527         pxOverflowTimerList = pxTemp;\r
 528 }\r
 529 /*-----------------------------------------------------------*/\r
 530 \r
 531 static void prvCheckForValidListAndQueue( void )\r
 532 {\r
 533         /* Check that the list from which active timers are referenced, and the\r
 534         queue used to communicate with the timer service, have been\r
 535         initialised. */\r
 536         taskENTER_CRITICAL();\r
 537         {\r
 538                 if( xTimerQueue == NULL )\r
 539                 {\r
 540                         vListInitialise( &xActiveTimerList1 );\r
 541                         vListInitialise( &xActiveTimerList2 );\r
 542                         pxCurrentTimerList = &xActiveTimerList1;\r
 543                         pxOverflowTimerList = &xActiveTimerList2;\r
 544                         xTimerQueue = xQueueCreate( configTIMER_QUEUE_LENGTH, sizeof( xTIMER_MESSAGE ) );\r
 545                 }\r
 546         }\r
 547         taskEXIT_CRITICAL();\r
 548 }\r
 549 /*-----------------------------------------------------------*/\r
 550 \r
 551 portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer )\r
 552 {\r
 553 portBASE_TYPE xTimerIsInActiveList;\r
 554 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 555 \r
 556         /* Is the timer in the list of active timers? */\r
 557         taskENTER_CRITICAL();\r
 558         {\r
 559                 /* Checking to see if it is in the NULL list in effect checks to see if\r
 560                 it is referenced from either the current or the overflow timer lists in\r
 561                 one go, but the logic has to be reversed, hence the '!'. */\r
 562                 xTimerIsInActiveList = !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) );\r
 563         }\r
 564         taskEXIT_CRITICAL();\r
 565 \r
 566         return xTimerIsInActiveList;\r
 567 }\r
 568 /*-----------------------------------------------------------*/\r
 569 \r
 570 void *pvTimerGetTimerID( xTimerHandle xTimer )\r
 571 {\r
 572 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 573 \r
 574         return pxTimer->pvTimerID;\r
 575 }\r
 576 /*-----------------------------------------------------------*/\r
 577 \r
 578 \r