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 void prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow ) 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         pxNewTimer = ( xTIMER * ) pvPortMalloc( sizeof( xTIMER ) );\r
 187         if( pxNewTimer != NULL )\r
 188         {\r
 189                 /* Ensure the infrastructure used by the timer service task has been\r
 190                 created/initialised. */\r
 191                 prvCheckForValidListAndQueue();\r
 192 \r
 193                 /* Initialise the timer structure members using the function parameters. */\r
 194                 pxNewTimer->pcTimerName = pcTimerName;\r
 195                 pxNewTimer->xTimerPeriodInTicks = xTimerPeriodInTicks;\r
 196                 pxNewTimer->uxAutoReload = uxAutoReload;\r
 197                 pxNewTimer->pvTimerID = pvTimerID;\r
 198                 pxNewTimer->pxCallbackFunction = pxCallbackFunction;\r
 199                 vListInitialiseItem( &( pxNewTimer->xTimerListItem ) );\r
 200         }\r
 201 \r
 202         return ( xTimerHandle ) pxNewTimer;\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 portBASE_TYPE xTimerGenericCommand( xTimerHandle xTimer, portBASE_TYPE xCommandID, portTickType xOptionalValue, portBASE_TYPE *pxHigherPriorityTaskWoken, portTickType xBlockTime )\r
 207 {\r
 208 portBASE_TYPE xReturn = pdFAIL;\r
 209 xTIMER_MESSAGE xMessage;\r
 210 \r
 211         /* Send a message to the timer service task to perform a particular action\r
 212         on a particular timer definition. */\r
 213         if( xTimerQueue != NULL )\r
 214         {\r
 215                 /* Send a command to the timer service task to start the xTimer timer. */\r
 216                 xMessage.xMessageID = xCommandID;\r
 217                 xMessage.xMessageValue = xOptionalValue;\r
 218                 xMessage.pxTimer = ( xTIMER * ) xTimer;\r
 219 \r
 220                 if( pxHigherPriorityTaskWoken == NULL )\r
 221                 {\r
 222                         if( xTaskGetSchedulerState() == taskSCHEDULER_RUNNING )\r
 223                         {\r
 224                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, xBlockTime );\r
 225                         }\r
 226                         else\r
 227                         {\r
 228                                 xReturn = xQueueSendToBack( xTimerQueue, &xMessage, tmrNO_DELAY );\r
 229                         }\r
 230                 }\r
 231                 else\r
 232                 {\r
 233                         xReturn = xQueueSendToBackFromISR( xTimerQueue, &xMessage, pxHigherPriorityTaskWoken );\r
 234                 }\r
 235         }\r
 236 \r
 237         return xReturn;\r
 238 }\r
 239 /*-----------------------------------------------------------*/\r
 240 \r
 241 static void prvProcessExpiredTimer( portTickType xNextExpireTime, portTickType xTimeNow )\r
 242 {\r
 243 xTIMER *pxTimer;\r
 244 \r
 245         /* Remove the timer from the list of active timers.  A check has already\r
 246         been performed to ensure the list is not empty. */\r
 247         pxTimer = ( xTIMER * ) listGET_OWNER_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 248         vListRemove( &( pxTimer->xTimerListItem ) );\r
 249 \r
 250         /* If the timer is an auto reload timer then calculate the next\r
 251         expiry time and re-insert the timer in the list of active timers. */\r
 252         if( pxTimer->uxAutoReload == pdTRUE )\r
 253         {\r
 254                 /* This is the only time a timer is inserted into a list using\r
 255                 a time relative to anything other than the current time.  It\r
 256                 will therefore be inserted into the correct list relative to\r
 257                 the time this task thinks it is now, even if a command to\r
 258                 switch lists due to a tick count overflow is already waiting in\r
 259                 the timer queue. */\r
 260                 prvInsertTimerInActiveList( pxTimer, ( xNextExpireTime + pxTimer->xTimerPeriodInTicks ), xTimeNow );\r
 261         }\r
 262 \r
 263         /* Call the timer callback. */\r
 264         pxTimer->pxCallbackFunction( ( xTimerHandle ) pxTimer );\r
 265 }\r
 266 /*-----------------------------------------------------------*/\r
 267 \r
 268 static void prvTimerTask( void *pvParameters )\r
 269 {\r
 270 portTickType xNextExpireTime;\r
 271 portBASE_TYPE xListWasEmpty;\r
 272 \r
 273         /* Just to avoid compiler warnings. */\r
 274         ( void ) pvParameters;\r
 275 \r
 276         for( ;; )\r
 277         {\r
 278                 /* Query the timers list to see if it contains any timers, and if so,\r
 279                 obtain the time at which the next timer will expire. */\r
 280                 xNextExpireTime = prvLookForExpiredTimer( &xListWasEmpty );\r
 281 \r
 282                 /* If a timer has expired, process it.  Otherwise, block this task\r
 283                 until either a timer does expire, or a command is received. */\r
 284                 prvProcessTimerOrBlockTask( xNextExpireTime, xListWasEmpty );\r
 285                 \r
 286                 /* Empty the command queue. */\r
 287                 prvProcessReceivedCommands();           \r
 288         }\r
 289 }\r
 290 /*-----------------------------------------------------------*/\r
 291 \r
 292 static void prvProcessTimerOrBlockTask( portTickType xNextExpireTime, portBASE_TYPE xListWasEmpty )\r
 293 {\r
 294 portTickType xTimeNow;\r
 295 portBASE_TYPE xTimerListsWereSwitched;\r
 296 \r
 297         vTaskSuspendAll();\r
 298         {\r
 299                 /* Obtain the time now to make an assessment as to whether the timer\r
 300                 has expired or not.  If obtaining the time causes the lists to switch\r
 301                 then don't process this timer as any timers that remained in the list\r
 302                 when the lists were switched will have been processed within the\r
 303                 prvSampelTimeNow() function. */\r
 304                 xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 305                 if( xTimerListsWereSwitched == pdFALSE )\r
 306                 {\r
 307                         /* The tick count has not overflowed, has the timer expired? */\r
 308                         if( ( xListWasEmpty == pdFALSE ) && ( xNextExpireTime <= xTimeNow ) )\r
 309                         {\r
 310                                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
 311                         }\r
 312                         else\r
 313                         {\r
 314                                 /* The tick count has not overflowed, and the next expire \r
 315                                 time has not been reached yet.  This task should therefore \r
 316                                 block to wait for the next expire time or a command to be \r
 317                                 received - whichever comes first.  The following line cannot\r
 318                                 be reached unless xNextExpireTime > xTimeNow, except in the \r
 319                                 case when the current timer list is empty. */\r
 320                                 vQueueWaitForMessageRestricted( xTimerQueue, ( xNextExpireTime - xTimeNow ) );\r
 321                         }\r
 322                 }\r
 323         }\r
 324         if( xTaskResumeAll() == pdFALSE )\r
 325         {\r
 326                 /* Yield to wait for either a command to arrive, or the block time\r
 327                 to expire.  If a command arrived between the critical section being\r
 328                 exited and this yield then the yield will not cause the task\r
 329                 to block. */\r
 330                 portYIELD_WITHIN_API();\r
 331         }\r
 332 }\r
 333 /*-----------------------------------------------------------*/\r
 334 \r
 335 static portTickType prvLookForExpiredTimer( portBASE_TYPE *pxListWasEmpty )\r
 336 {\r
 337 portTickType xNextExpireTime;\r
 338 \r
 339         /* Timers are listed in expiry time order, with the head of the list\r
 340         referencing the task that will expire first.  Obtain the time at which\r
 341         the timer with the nearest expiry time will expire.  If there are no\r
 342         active timers then just set the next expire time to 0.  That will cause\r
 343         this task to unblock when the tick count overflows, at which point the\r
 344         timer lists will be switched and the next expiry time can be \r
 345         re-assessed.  */\r
 346         *pxListWasEmpty = listLIST_IS_EMPTY( pxCurrentTimerList );\r
 347         if( *pxListWasEmpty == pdFALSE )\r
 348         {\r
 349                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 350         }\r
 351         else\r
 352         {\r
 353                 /* Ensure the task unblocks when the tick count rolls over. */\r
 354                 xNextExpireTime = ( portTickType ) 0U;\r
 355         }\r
 356 \r
 357         return xNextExpireTime;\r
 358 }\r
 359 /*-----------------------------------------------------------*/\r
 360 \r
 361 static portTickType prvSampleTimeNow( portBASE_TYPE *pxTimerListsWereSwitched )\r
 362 {\r
 363 portTickType xTimeNow;\r
 364 static portTickType xLastTime = ( portTickType ) 0U;\r
 365 \r
 366         xTimeNow = xTaskGetTickCount();\r
 367         \r
 368         if( xTimeNow < xLastTime )\r
 369         {\r
 370                 prvSwitchTimerLists( xTimeNow, xLastTime );\r
 371                 *pxTimerListsWereSwitched = pdTRUE;\r
 372         }\r
 373         else\r
 374         {\r
 375                 *pxTimerListsWereSwitched = pdFALSE;\r
 376         }\r
 377         \r
 378         xLastTime = xTimeNow;\r
 379         \r
 380         return xTimeNow;\r
 381 }\r
 382 /*-----------------------------------------------------------*/\r
 383 \r
 384 static void prvInsertTimerInActiveList( xTIMER *pxTimer, portTickType xNextExpiryTime, portTickType xTimeNow )\r
 385 {\r
 386         listSET_LIST_ITEM_VALUE( &( pxTimer->xTimerListItem ), xNextExpiryTime );\r
 387         listSET_LIST_ITEM_OWNER( &( pxTimer->xTimerListItem ), pxTimer );\r
 388         \r
 389         if( xNextExpiryTime < xTimeNow )\r
 390         {\r
 391                 vListInsert( pxOverflowTimerList, &( pxTimer->xTimerListItem ) );\r
 392         }\r
 393         else\r
 394         {\r
 395                 vListInsert( pxCurrentTimerList, &( pxTimer->xTimerListItem ) );\r
 396         }\r
 397 }\r
 398 /*-----------------------------------------------------------*/\r
 399 \r
 400 static void     prvProcessReceivedCommands( void )\r
 401 {\r
 402 xTIMER_MESSAGE xMessage;\r
 403 xTIMER *pxTimer;\r
 404 portBASE_TYPE xTimerListsWereSwitched;\r
 405 portTickType xTimeNow;\r
 406 \r
 407         /* In this case the xTimerListsWereSwitched parameter is not used, but it\r
 408         must be present in the function call. */\r
 409         xTimeNow = prvSampleTimeNow( &xTimerListsWereSwitched );\r
 410 \r
 411         while( xQueueReceive( xTimerQueue, &xMessage, tmrNO_DELAY ) != pdFAIL )\r
 412         {\r
 413                 pxTimer = xMessage.pxTimer;\r
 414 \r
 415                 /* Is the timer already in a list of active timers?  When the command\r
 416                 is trmCOMMAND_PROCESS_TIMER_OVERFLOW, the timer will be NULL as the\r
 417                 command is to the task rather than to an individual timer. */\r
 418                 if( pxTimer != NULL )\r
 419                 {\r
 420                         if( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) == pdFALSE )\r
 421                         {\r
 422                                 /* The timer is in a list, remove it. */\r
 423                                 vListRemove( &( pxTimer->xTimerListItem ) );\r
 424                         }\r
 425                 }\r
 426 \r
 427                 switch( xMessage.xMessageID )\r
 428                 {\r
 429                         case tmrCOMMAND_START : \r
 430                                 /* Start or restart a timer. */\r
 431                                 prvInsertTimerInActiveList( pxTimer,  xTimeNow + pxTimer->xTimerPeriodInTicks, xTimeNow );\r
 432                                 break;\r
 433 \r
 434                         case tmrCOMMAND_STOP :  \r
 435                                 /* The timer has already been removed from the active list.\r
 436                                 There is nothing to do here. */\r
 437                                 break;\r
 438 \r
 439                         case tmrCOMMAND_CHANGE_PERIOD :\r
 440                                 pxTimer->xTimerPeriodInTicks = xMessage.xMessageValue;\r
 441                                 prvInsertTimerInActiveList( pxTimer, ( xTimeNow + pxTimer->xTimerPeriodInTicks ), xTimeNow );\r
 442                                 break;\r
 443 \r
 444                         case tmrCOMMAND_DELETE :\r
 445                                 /* The timer has already been removed from the active list,\r
 446                                 just free up the memory. */\r
 447                                 vPortFree( pxTimer );\r
 448                                 break;\r
 449 \r
 450                         default :                       \r
 451                                 /* Don't expect to get here. */\r
 452                                 break;\r
 453                 }\r
 454         }\r
 455 }\r
 456 /*-----------------------------------------------------------*/\r
 457 \r
 458 static void prvSwitchTimerLists( portTickType xTimeNow, portTickType xLastTime )\r
 459 {\r
 460 portTickType xNextExpireTime;\r
 461 xList *pxTemp;\r
 462 \r
 463         /* Remove compiler warnings if configASSERT() is not defined. */\r
 464         ( void ) xLastTime;\r
 465         \r
 466         /* The tick count has overflowed.  The timer lists must be switched.\r
 467         If there are any timers still referenced from the current timer list\r
 468         then they must have expired and should be processed before the lists\r
 469         are switched. */\r
 470         while( listLIST_IS_EMPTY( pxCurrentTimerList ) == pdFALSE )\r
 471         {\r
 472                 xNextExpireTime = listGET_ITEM_VALUE_OF_HEAD_ENTRY( pxCurrentTimerList );\r
 473                 configASSERT( ( xNextExpireTime >= xLastTime ) );\r
 474                 prvProcessExpiredTimer( xNextExpireTime, xTimeNow );\r
 475         }\r
 476 \r
 477         pxTemp = pxCurrentTimerList;\r
 478         pxCurrentTimerList = pxOverflowTimerList;\r
 479         pxOverflowTimerList = pxTemp;\r
 480 }\r
 481 /*-----------------------------------------------------------*/\r
 482 \r
 483 static void prvCheckForValidListAndQueue( void )\r
 484 {\r
 485         /* Check that the list from which active timers are referenced, and the\r
 486         queue used to communicate with the timer service, have been\r
 487         initialised. */\r
 488         taskENTER_CRITICAL();\r
 489         {\r
 490                 if( xTimerQueue == NULL )\r
 491                 {\r
 492                         vListInitialise( &xActiveTimerList1 );\r
 493                         vListInitialise( &xActiveTimerList2 );\r
 494                         pxCurrentTimerList = &xActiveTimerList1;\r
 495                         pxOverflowTimerList = &xActiveTimerList2;\r
 496                         xTimerQueue = xQueueCreate( configTIMER_QUEUE_LENGTH, sizeof( xTIMER_MESSAGE ) );\r
 497                 }\r
 498         }\r
 499         taskEXIT_CRITICAL();\r
 500 }\r
 501 /*-----------------------------------------------------------*/\r
 502 \r
 503 portBASE_TYPE xTimerIsTimerActive( xTimerHandle xTimer )\r
 504 {\r
 505 portBASE_TYPE xTimerIsInActiveList;\r
 506 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 507 \r
 508         /* Is the timer in the list of active timers? */\r
 509         taskENTER_CRITICAL();\r
 510         {\r
 511                 /* Checking to see if it is in the NULL list in effect checks to see if\r
 512                 it is referenced from either the current or the overflow timer lists in\r
 513                 one go, but the logic has to be reversed, hence the '!'. */\r
 514                 xTimerIsInActiveList = !( listIS_CONTAINED_WITHIN( NULL, &( pxTimer->xTimerListItem ) ) );\r
 515         }\r
 516         taskEXIT_CRITICAL();\r
 517 \r
 518         return xTimerIsInActiveList;\r
 519 }\r
 520 /*-----------------------------------------------------------*/\r
 521 \r
 522 void *pvTimerGetTimerID( xTimerHandle xTimer )\r
 523 {\r
 524 xTIMER *pxTimer = ( xTIMER * ) xTimer;\r
 525 \r
 526         return pxTimer->pvTimerID;\r
 527 }\r
 528 /*-----------------------------------------------------------*/\r
 529 \r
 530 \r
 531 \r
 532 \r