2 FreeRTOS V8.0.0:rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\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
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
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\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
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
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
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\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
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
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
68 * Tests the behaviour of timers. Some timers are created before the scheduler
\r
69 * is started, and some after.
\r
72 /* Standard includes. */
\r
75 /* Scheduler include files. */
\r
76 #include "FreeRTOS.h"
\r
80 /* Demo program include files. */
\r
81 #include "TimerDemo.h"
\r
83 #if ( configTIMER_TASK_PRIORITY < 1 )
\r
84 #error configTIMER_TASK_PRIORITY must be set to at least 1 for this test/demo to function correctly.
\r
87 #define tmrdemoDONT_BLOCK ( ( portTickType ) 0 )
\r
88 #define tmrdemoONE_SHOT_TIMER_PERIOD ( xBasePeriod * ( portTickType ) 3 )
\r
89 #define trmdemoNUM_TIMER_RESETS ( ( unsigned char ) 10 )
\r
91 /*-----------------------------------------------------------*/
\r
93 /* The callback functions used by the timers. These each increment a counter
\r
94 to indicate which timer has expired. The auto-reload timers that are used by
\r
95 the test task (as opposed to being used from an ISR) all share the same
\r
96 prvAutoReloadTimerCallback() callback function, and use the ID of the
\r
97 pxExpiredTimer parameter passed into that function to know which counter to
\r
98 increment. The other timers all have their own unique callback function and
\r
99 simply increment their counters without using the callback function parameter. */
\r
100 static void prvAutoReloadTimerCallback( xTimerHandle pxExpiredTimer );
\r
101 static void prvOneShotTimerCallback( xTimerHandle pxExpiredTimer );
\r
102 static void prvTimerTestTask( void *pvParameters );
\r
103 static void prvISRAutoReloadTimerCallback( xTimerHandle pxExpiredTimer );
\r
104 static void prvISROneShotTimerCallback( xTimerHandle pxExpiredTimer );
\r
106 /* The test functions used by the timer test task. These manipulate the auto
\r
107 reload and one shot timers in various ways, then delay, then inspect the timers
\r
108 to ensure they have behaved as expected. */
\r
109 static void prvTest1_CreateTimersWithoutSchedulerRunning( void );
\r
110 static void prvTest2_CheckTaskAndTimersInitialState( void );
\r
111 static void prvTest3_CheckAutoReloadExpireRates( void );
\r
112 static void prvTest4_CheckAutoReloadTimersCanBeStopped( void );
\r
113 static void prvTest5_CheckBasicOneShotTimerBehaviour( void );
\r
114 static void prvTest6_CheckAutoReloadResetBehaviour( void );
\r
115 static void prvResetStartConditionsForNextIteration( void );
\r
117 /*-----------------------------------------------------------*/
\r
119 /* Flag that will be latched to pdFAIL should any unexpected behaviour be
\r
120 detected in any of the demo tests. */
\r
121 static volatile portBASE_TYPE xTestStatus = pdPASS;
\r
123 /* Counter that is incremented on each cycle of a test. This is used to
\r
124 detect a stalled task - a test that is no longer running. */
\r
125 static volatile unsigned long ulLoopCounter = 0;
\r
127 /* A set of auto reload timers - each of which use the same callback function.
\r
128 The callback function uses the timer ID to index into, and then increment, a
\r
129 counter in the ucAutoReloadTimerCounters[] array. The auto reload timers
\r
130 referenced from xAutoReloadTimers[] are used by the prvTimerTestTask task. */
\r
131 static xTimerHandle xAutoReloadTimers[ configTIMER_QUEUE_LENGTH + 1 ] = { 0 };
\r
132 static unsigned char ucAutoReloadTimerCounters[ configTIMER_QUEUE_LENGTH + 1 ] = { 0 };
\r
134 /* The one shot timer is configured to use a callback function that increments
\r
135 ucOneShotTimerCounter each time it gets called. */
\r
136 static xTimerHandle xOneShotTimer = NULL;
\r
137 static unsigned char ucOneShotTimerCounter = ( unsigned char ) 0;
\r
139 /* The ISR reload timer is controlled from the tick hook to exercise the timer
\r
140 API functions that can be used from an ISR. It is configured to increment
\r
141 ucISRReloadTimerCounter each time its callback function is executed. */
\r
142 static xTimerHandle xISRAutoReloadTimer = NULL;
\r
143 static unsigned char ucISRAutoReloadTimerCounter = ( unsigned char ) 0;
\r
145 /* The ISR one shot timer is controlled from the tick hook to exercise the timer
\r
146 API functions that can be used from an ISR. It is configured to increment
\r
147 ucISRReloadTimerCounter each time its callback function is executed. */
\r
148 static xTimerHandle xISROneShotTimer = NULL;
\r
149 static unsigned char ucISROneShotTimerCounter = ( unsigned char ) 0;
\r
151 /* The period of all the timers are a multiple of the base period. The base
\r
152 period is configured by the parameter to vStartTimerDemoTask(). */
\r
153 static portTickType xBasePeriod = 0;
\r
155 /*-----------------------------------------------------------*/
\r
157 void vStartTimerDemoTask( portTickType xBasePeriodIn )
\r
159 /* Start with the timer and counter arrays clear - this is only necessary
\r
160 where the compiler does not clear them automatically on start up. */
\r
161 memset( ucAutoReloadTimerCounters, 0x00, sizeof( ucAutoReloadTimerCounters ) );
\r
162 memset( xAutoReloadTimers, 0x00, sizeof( xAutoReloadTimers ) );
\r
164 /* Store the period from which all the timer periods will be generated from
\r
166 xBasePeriod = xBasePeriodIn;
\r
168 /* Create a set of timers for use by this demo/test. */
\r
169 prvTest1_CreateTimersWithoutSchedulerRunning();
\r
171 /* Create the task that will control and monitor the timers. This is
\r
172 created at a lower priority than the timer service task to ensure, as
\r
173 far as it is concerned, commands on timers are actioned immediately
\r
174 (sending a command to the timer service task will unblock the timer service
\r
175 task, which will then preempt this task). */
\r
176 if( xTestStatus != pdFAIL )
\r
178 xTaskCreate( prvTimerTestTask, "Tmr Tst", configMINIMAL_STACK_SIZE, NULL, configTIMER_TASK_PRIORITY - 1, NULL );
\r
181 /*-----------------------------------------------------------*/
\r
183 static void prvTimerTestTask( void *pvParameters )
\r
185 ( void ) pvParameters;
\r
187 /* Create a one-shot timer for use later on in this test. */
\r
188 xOneShotTimer = xTimerCreate( "Oneshot Timer", /* Text name to facilitate debugging. The kernel does not use this itself. */
\r
189 tmrdemoONE_SHOT_TIMER_PERIOD, /* The period for the timer. */
\r
190 pdFALSE, /* Don't auto-reload - hence a one shot timer. */
\r
191 ( void * ) 0, /* The timer identifier. In this case this is not used as the timer has its own callback. */
\r
192 prvOneShotTimerCallback ); /* The callback to be called when the timer expires. */
\r
194 if( xOneShotTimer == NULL )
\r
196 xTestStatus = pdFAIL;
\r
197 configASSERT( xTestStatus );
\r
201 /* Ensure all the timers are in their expected initial state. This
\r
202 depends on the timer service task having a higher priority than this task. */
\r
203 prvTest2_CheckTaskAndTimersInitialState();
\r
207 /* Check the auto reload timers expire at the expected/correct rates. */
\r
208 prvTest3_CheckAutoReloadExpireRates();
\r
210 /* Check the auto reload timers can be stopped correctly, and correctly
\r
211 report their state. */
\r
212 prvTest4_CheckAutoReloadTimersCanBeStopped();
\r
214 /* Check the one shot timer only calls its callback once after it has been
\r
215 started, and that it reports its state correctly. */
\r
216 prvTest5_CheckBasicOneShotTimerBehaviour();
\r
218 /* Check timer reset behaviour. */
\r
219 prvTest6_CheckAutoReloadResetBehaviour();
\r
221 /* Start the timers again to restart all the tests over again. */
\r
222 prvResetStartConditionsForNextIteration();
\r
225 /*-----------------------------------------------------------*/
\r
227 /* This is called to check that the created task is still running and has not
\r
228 detected any errors. */
\r
229 portBASE_TYPE xAreTimerDemoTasksStillRunning( portTickType xCycleFrequency )
\r
231 static unsigned long ulLastLoopCounter = 0UL;
\r
232 portTickType xMaxBlockTimeUsedByTheseTests, xLoopCounterIncrementTimeMax;
\r
233 static portTickType xIterationsWithoutCounterIncrement = ( portTickType ) 0, xLastCycleFrequency;
\r
235 if( xLastCycleFrequency != xCycleFrequency )
\r
237 /* The cycle frequency has probably become much faster due to an error
\r
238 elsewhere. Start counting Iterations again. */
\r
239 xIterationsWithoutCounterIncrement = ( portTickType ) 0;
\r
240 xLastCycleFrequency = xCycleFrequency;
\r
243 /* Calculate the maximum number of times that it is permissible for this
\r
244 function to be called without ulLoopCounter being incremented. This is
\r
245 necessary because the tests in this file block for extended periods, and the
\r
246 block period might be longer than the time between calls to this function. */
\r
247 xMaxBlockTimeUsedByTheseTests = ( ( portTickType ) configTIMER_QUEUE_LENGTH ) * xBasePeriod;
\r
248 xLoopCounterIncrementTimeMax = ( xMaxBlockTimeUsedByTheseTests / xCycleFrequency ) + 1;
\r
250 /* If the demo task is still running then the loop counter is expected to
\r
251 have incremented every xLoopCounterIncrementTimeMax calls. */
\r
252 if( ulLastLoopCounter == ulLoopCounter )
\r
254 xIterationsWithoutCounterIncrement++;
\r
255 if( xIterationsWithoutCounterIncrement > xLoopCounterIncrementTimeMax )
\r
257 /* The tests appear to be no longer running (stalled). */
\r
258 xTestStatus = pdFAIL;
\r
259 configASSERT( xTestStatus );
\r
264 /* ulLoopCounter changed, so the count of times this function was called
\r
265 without a change can be reset to zero. */
\r
266 xIterationsWithoutCounterIncrement = ( portTickType ) 0;
\r
269 ulLastLoopCounter = ulLoopCounter;
\r
271 /* Errors detected in the task itself will have latched xTestStatus
\r
274 return xTestStatus;
\r
276 /*-----------------------------------------------------------*/
\r
278 static void prvTest1_CreateTimersWithoutSchedulerRunning( void )
\r
280 unsigned portBASE_TYPE xTimer;
\r
282 for( xTimer = 0; xTimer < configTIMER_QUEUE_LENGTH; xTimer++ )
\r
284 /* As the timer queue is not yet full, it should be possible to both create
\r
285 and start a timer. These timers are being started before the scheduler has
\r
286 been started, so their block times should get set to zero within the timer
\r
288 xAutoReloadTimers[ xTimer ] = xTimerCreate( "FR Timer", /* Text name to facilitate debugging. The kernel does not use this itself. */
\r
289 ( ( xTimer + ( portTickType ) 1 ) * xBasePeriod ),/* The period for the timer. The plus 1 ensures a period of zero is not specified. */
\r
290 pdTRUE, /* Auto-reload is set to true. */
\r
291 ( void * ) xTimer, /* An identifier for the timer as all the auto reload timers use the same callback. */
\r
292 prvAutoReloadTimerCallback ); /* The callback to be called when the timer expires. */
\r
294 if( xAutoReloadTimers[ xTimer ] == NULL )
\r
296 xTestStatus = pdFAIL;
\r
297 configASSERT( xTestStatus );
\r
301 /* The scheduler has not yet started, so the block period of
\r
302 portMAX_DELAY should just get set to zero in xTimerStart(). Also,
\r
303 the timer queue is not yet full so xTimerStart() should return
\r
305 if( xTimerStart( xAutoReloadTimers[ xTimer ], portMAX_DELAY ) != pdPASS )
\r
307 xTestStatus = pdFAIL;
\r
308 configASSERT( xTestStatus );
\r
313 /* The timers queue should now be full, so it should be possible to create
\r
314 another timer, but not possible to start it (the timer queue will not get
\r
315 drained until the scheduler has been started. */
\r
316 xAutoReloadTimers[ configTIMER_QUEUE_LENGTH ] = xTimerCreate( "FR Timer", /* Text name to facilitate debugging. The kernel does not use this itself. */
\r
317 ( configTIMER_QUEUE_LENGTH * xBasePeriod ), /* The period for the timer. */
\r
318 pdTRUE, /* Auto-reload is set to true. */
\r
319 ( void * ) xTimer, /* An identifier for the timer as all the auto reload timers use the same callback. */
\r
320 prvAutoReloadTimerCallback ); /* The callback executed when the timer expires. */
\r
322 if( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH ] == NULL )
\r
324 xTestStatus = pdFAIL;
\r
325 configASSERT( xTestStatus );
\r
329 if( xTimerStart( xAutoReloadTimers[ xTimer ], portMAX_DELAY ) == pdPASS )
\r
331 /* This time it would not be expected that the timer could be
\r
332 started at this point. */
\r
333 xTestStatus = pdFAIL;
\r
334 configASSERT( xTestStatus );
\r
338 /* Create the timers that are used from the tick interrupt to test the timer
\r
339 API functions that can be called from an ISR. */
\r
340 xISRAutoReloadTimer = xTimerCreate( "ISR AR", /* The text name given to the timer. */
\r
341 0xffff, /* The timer is not given a period yet - this will be done from the tick hook, but a period of 0 is invalid. */
\r
342 pdTRUE, /* This is an auto reload timer. */
\r
343 ( void * ) NULL, /* The identifier is not required. */
\r
344 prvISRAutoReloadTimerCallback ); /* The callback that is executed when the timer expires. */
\r
346 xISROneShotTimer = xTimerCreate( "ISR OS", /* The text name given to the timer. */
\r
347 0xffff, /* The timer is not given a period yet - this will be done from the tick hook, but a period of 0 is invalid. */
\r
348 pdFALSE, /* This is a one shot timer. */
\r
349 ( void * ) NULL, /* The identifier is not required. */
\r
350 prvISROneShotTimerCallback ); /* The callback that is executed when the timer expires. */
\r
352 if( ( xISRAutoReloadTimer == NULL ) || ( xISROneShotTimer == NULL ) )
\r
354 xTestStatus = pdFAIL;
\r
355 configASSERT( xTestStatus );
\r
358 /*-----------------------------------------------------------*/
\r
360 static void prvTest2_CheckTaskAndTimersInitialState( void )
\r
362 unsigned char ucTimer;
\r
364 /* Ensure all the timers are in their expected initial state. This depends
\r
365 on the timer service task having a higher priority than this task.
\r
367 auto reload timers 0 to ( configTIMER_QUEUE_LENGTH - 1 ) should now be active,
\r
368 and auto reload timer configTIMER_QUEUE_LENGTH should not yet be active (it
\r
369 could not be started prior to the scheduler being started when it was
\r
371 for( ucTimer = 0; ucTimer < ( unsigned char ) configTIMER_QUEUE_LENGTH; ucTimer++ )
\r
373 if( xTimerIsTimerActive( xAutoReloadTimers[ ucTimer ] ) == pdFALSE )
\r
375 xTestStatus = pdFAIL;
\r
376 configASSERT( xTestStatus );
\r
380 if( xTimerIsTimerActive( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH ] ) != pdFALSE )
\r
382 xTestStatus = pdFAIL;
\r
383 configASSERT( xTestStatus );
\r
386 /*-----------------------------------------------------------*/
\r
388 static void prvTest3_CheckAutoReloadExpireRates( void )
\r
390 unsigned char ucMaxAllowableValue, ucMinAllowableValue, ucTimer;
\r
391 portTickType xBlockPeriod, xTimerPeriod, xExpectedNumber;
\r
393 /* Check the auto reload timers expire at the expected rates. */
\r
396 /* Delaying for configTIMER_QUEUE_LENGTH * xBasePeriod ticks should allow
\r
397 all the auto reload timers to expire at least once. */
\r
398 xBlockPeriod = ( ( portTickType ) configTIMER_QUEUE_LENGTH ) * xBasePeriod;
\r
399 vTaskDelay( xBlockPeriod );
\r
401 /* Check that all the auto reload timers have called their callback
\r
402 function the expected number of times. */
\r
403 for( ucTimer = 0; ucTimer < ( unsigned char ) configTIMER_QUEUE_LENGTH; ucTimer++ )
\r
405 /* The expected number of expiries is equal to the block period divided
\r
406 by the timer period. */
\r
407 xTimerPeriod = ( ( ( portTickType ) ucTimer + ( portTickType ) 1 ) * xBasePeriod );
\r
408 xExpectedNumber = xBlockPeriod / xTimerPeriod;
\r
410 ucMaxAllowableValue = ( ( unsigned char ) xExpectedNumber ) ;
\r
411 ucMinAllowableValue = ( ( unsigned char ) xExpectedNumber - ( unsigned char ) 1 );
\r
413 if( ( ucAutoReloadTimerCounters[ ucTimer ] < ucMinAllowableValue ) ||
\r
414 ( ucAutoReloadTimerCounters[ ucTimer ] > ucMaxAllowableValue )
\r
417 xTestStatus = pdFAIL;
\r
418 configASSERT( xTestStatus );
\r
422 if( xTestStatus == pdPASS )
\r
424 /* No errors have been reported so increment the loop counter so the
\r
425 check task knows this task is still running. */
\r
429 /*-----------------------------------------------------------*/
\r
431 static void prvTest4_CheckAutoReloadTimersCanBeStopped( void )
\r
433 unsigned char ucTimer;
\r
435 /* Check the auto reload timers can be stopped correctly, and correctly
\r
436 report their state. */
\r
438 /* Stop all the active timers. */
\r
439 for( ucTimer = 0; ucTimer < ( unsigned char ) configTIMER_QUEUE_LENGTH; ucTimer++ )
\r
441 /* The timer has not been stopped yet! */
\r
442 if( xTimerIsTimerActive( xAutoReloadTimers[ ucTimer ] ) == pdFALSE )
\r
444 xTestStatus = pdFAIL;
\r
445 configASSERT( xTestStatus );
\r
448 /* Now stop the timer. This will appear to happen immediately to
\r
449 this task because this task is running at a priority below the
\r
450 timer service task. */
\r
451 xTimerStop( xAutoReloadTimers[ ucTimer ], tmrdemoDONT_BLOCK );
\r
453 /* The timer should now be inactive. */
\r
454 if( xTimerIsTimerActive( xAutoReloadTimers[ ucTimer ] ) != pdFALSE )
\r
456 xTestStatus = pdFAIL;
\r
457 configASSERT( xTestStatus );
\r
461 taskENTER_CRITICAL();
\r
463 /* The timer in array position configTIMER_QUEUE_LENGTH should not
\r
464 be active. The critical section is used to ensure the timer does
\r
465 not call its callback between the next line running and the array
\r
466 being cleared back to zero, as that would mask an error condition. */
\r
467 if( ucAutoReloadTimerCounters[ configTIMER_QUEUE_LENGTH ] != ( unsigned char ) 0 )
\r
469 xTestStatus = pdFAIL;
\r
470 configASSERT( xTestStatus );
\r
473 /* Clear the timer callback count. */
\r
474 memset( ( void * ) ucAutoReloadTimerCounters, 0, sizeof( ucAutoReloadTimerCounters ) );
\r
476 taskEXIT_CRITICAL();
\r
478 /* The timers are now all inactive, so this time, after delaying, none
\r
479 of the callback counters should have incremented. */
\r
480 vTaskDelay( ( ( portTickType ) configTIMER_QUEUE_LENGTH ) * xBasePeriod );
\r
481 for( ucTimer = 0; ucTimer < ( unsigned char ) configTIMER_QUEUE_LENGTH; ucTimer++ )
\r
483 if( ucAutoReloadTimerCounters[ ucTimer ] != ( unsigned char ) 0 )
\r
485 xTestStatus = pdFAIL;
\r
486 configASSERT( xTestStatus );
\r
490 if( xTestStatus == pdPASS )
\r
492 /* No errors have been reported so increment the loop counter so
\r
493 the check task knows this task is still running. */
\r
497 /*-----------------------------------------------------------*/
\r
499 static void prvTest5_CheckBasicOneShotTimerBehaviour( void )
\r
501 /* Check the one shot timer only calls its callback once after it has been
\r
502 started, and that it reports its state correctly. */
\r
504 /* The one shot timer should not be active yet. */
\r
505 if( xTimerIsTimerActive( xOneShotTimer ) != pdFALSE )
\r
507 xTestStatus = pdFAIL;
\r
508 configASSERT( xTestStatus );
\r
511 if( ucOneShotTimerCounter != ( unsigned char ) 0 )
\r
513 xTestStatus = pdFAIL;
\r
514 configASSERT( xTestStatus );
\r
517 /* Start the one shot timer and check that it reports its state correctly. */
\r
518 xTimerStart( xOneShotTimer, tmrdemoDONT_BLOCK );
\r
519 if( xTimerIsTimerActive( xOneShotTimer ) == pdFALSE )
\r
521 xTestStatus = pdFAIL;
\r
522 configASSERT( xTestStatus );
\r
525 /* Delay for three times as long as the one shot timer period, then check
\r
526 to ensure it has only called its callback once, and is now not in the
\r
528 vTaskDelay( tmrdemoONE_SHOT_TIMER_PERIOD * ( portTickType ) 3 );
\r
530 if( xTimerIsTimerActive( xOneShotTimer ) != pdFALSE )
\r
532 xTestStatus = pdFAIL;
\r
533 configASSERT( xTestStatus );
\r
536 if( ucOneShotTimerCounter != ( unsigned char ) 1 )
\r
538 xTestStatus = pdFAIL;
\r
539 configASSERT( xTestStatus );
\r
543 /* Reset the one shot timer callback count. */
\r
544 ucOneShotTimerCounter = ( unsigned char ) 0;
\r
547 if( xTestStatus == pdPASS )
\r
549 /* No errors have been reported so increment the loop counter so the
\r
550 check task knows this task is still running. */
\r
554 /*-----------------------------------------------------------*/
\r
556 static void prvTest6_CheckAutoReloadResetBehaviour( void )
\r
558 unsigned char ucTimer;
\r
560 /* Check timer reset behaviour. */
\r
562 /* Restart the one shot timer and check it reports its status correctly. */
\r
563 xTimerStart( xOneShotTimer, tmrdemoDONT_BLOCK );
\r
564 if( xTimerIsTimerActive( xOneShotTimer ) == pdFALSE )
\r
566 xTestStatus = pdFAIL;
\r
567 configASSERT( xTestStatus );
\r
570 /* Restart one of the auto reload timers and check that it reports its
\r
571 status correctly. */
\r
572 xTimerStart( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ], tmrdemoDONT_BLOCK );
\r
573 if( xTimerIsTimerActive( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ] ) == pdFALSE )
\r
575 xTestStatus = pdFAIL;
\r
576 configASSERT( xTestStatus );
\r
579 for( ucTimer = 0; ucTimer < trmdemoNUM_TIMER_RESETS; ucTimer++ )
\r
581 /* Delay for half as long as the one shot timer period, then reset it.
\r
582 It should never expire while this is done, so its callback count should
\r
583 never increment. */
\r
584 vTaskDelay( tmrdemoONE_SHOT_TIMER_PERIOD / 2 );
\r
586 /* Check both running timers are still active, but have not called their
\r
587 callback functions. */
\r
588 if( xTimerIsTimerActive( xOneShotTimer ) == pdFALSE )
\r
590 xTestStatus = pdFAIL;
\r
591 configASSERT( xTestStatus );
\r
594 if( ucOneShotTimerCounter != ( unsigned char ) 0 )
\r
596 xTestStatus = pdFAIL;
\r
597 configASSERT( xTestStatus );
\r
600 if( xTimerIsTimerActive( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ] ) == pdFALSE )
\r
602 xTestStatus = pdFAIL;
\r
603 configASSERT( xTestStatus );
\r
606 if( ucAutoReloadTimerCounters[ configTIMER_QUEUE_LENGTH - 1 ] != ( unsigned char ) 0 )
\r
608 xTestStatus = pdFAIL;
\r
609 configASSERT( xTestStatus );
\r
612 /* Reset both running timers. */
\r
613 xTimerReset( xOneShotTimer, tmrdemoDONT_BLOCK );
\r
614 xTimerReset( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ], tmrdemoDONT_BLOCK );
\r
616 if( xTestStatus == pdPASS )
\r
618 /* No errors have been reported so increment the loop counter so
\r
619 the check task knows this task is still running. */
\r
624 /* Finally delay long enough for both running timers to expire. */
\r
625 vTaskDelay( ( ( portTickType ) configTIMER_QUEUE_LENGTH ) * xBasePeriod );
\r
627 /* The timers were not reset during the above delay period so should now
\r
628 both have called their callback functions. */
\r
629 if( ucOneShotTimerCounter != ( unsigned char ) 1 )
\r
631 xTestStatus = pdFAIL;
\r
632 configASSERT( xTestStatus );
\r
635 if( ucAutoReloadTimerCounters[ configTIMER_QUEUE_LENGTH - 1 ] == 0 )
\r
637 xTestStatus = pdFAIL;
\r
638 configASSERT( xTestStatus );
\r
641 /* The one shot timer should no longer be active, while the auto reload
\r
642 timer should still be active. */
\r
643 if( xTimerIsTimerActive( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ] ) == pdFALSE )
\r
645 xTestStatus = pdFAIL;
\r
646 configASSERT( xTestStatus );
\r
649 if( xTimerIsTimerActive( xOneShotTimer ) == pdTRUE )
\r
651 xTestStatus = pdFAIL;
\r
652 configASSERT( xTestStatus );
\r
655 /* Stop the auto reload timer again. */
\r
656 xTimerStop( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ], tmrdemoDONT_BLOCK );
\r
658 if( xTimerIsTimerActive( xAutoReloadTimers[ configTIMER_QUEUE_LENGTH - 1 ] ) != pdFALSE )
\r
660 xTestStatus = pdFAIL;
\r
661 configASSERT( xTestStatus );
\r
664 /* Clear the timer callback counts, ready for another iteration of these
\r
666 ucAutoReloadTimerCounters[ configTIMER_QUEUE_LENGTH - 1 ] = ( unsigned char ) 0;
\r
667 ucOneShotTimerCounter = ( unsigned char ) 0;
\r
669 if( xTestStatus == pdPASS )
\r
671 /* No errors have been reported so increment the loop counter so the check
\r
672 task knows this task is still running. */
\r
676 /*-----------------------------------------------------------*/
\r
678 static void prvResetStartConditionsForNextIteration( void )
\r
680 unsigned char ucTimer;
\r
682 /* Start the timers again to start all the tests over again. */
\r
684 /* Start the timers again. */
\r
685 for( ucTimer = 0; ucTimer < ( unsigned char ) configTIMER_QUEUE_LENGTH; ucTimer++ )
\r
687 /* The timer has not been started yet! */
\r
688 if( xTimerIsTimerActive( xAutoReloadTimers[ ucTimer ] ) != pdFALSE )
\r
690 xTestStatus = pdFAIL;
\r
691 configASSERT( xTestStatus );
\r
694 /* Now start the timer. This will appear to happen immediately to
\r
695 this task because this task is running at a priority below the timer
\r
697 xTimerStart( xAutoReloadTimers[ ucTimer ], tmrdemoDONT_BLOCK );
\r
699 /* The timer should now be active. */
\r
700 if( xTimerIsTimerActive( xAutoReloadTimers[ ucTimer ] ) == pdFALSE )
\r
702 xTestStatus = pdFAIL;
\r
703 configASSERT( xTestStatus );
\r
707 if( xTestStatus == pdPASS )
\r
709 /* No errors have been reported so increment the loop counter so the
\r
710 check task knows this task is still running. */
\r
714 /*-----------------------------------------------------------*/
\r
716 void vTimerPeriodicISRTests( void )
\r
718 static portTickType uxTick = ( portTickType ) -1;
\r
720 #if( configTIMER_TASK_PRIORITY != ( configMAX_PRIORITIES - 1 ) )
\r
721 /* The timer service task is not the highest priority task, so it cannot
\r
722 be assumed that timings will be exact. Timers should never call their
\r
723 callback before their expiry time, but a margin is permissible for calling
\r
724 their callback after their expiry time. If exact timing is required then
\r
725 configTIMER_TASK_PRIORITY must be set to ensure the timer service task
\r
726 is the highest priority task in the system. */
\r
727 const portTickType xMargin = 5;
\r
729 const portTickType xMargin = 2;
\r
736 /* The timers will have been created, but not started. Start them now
\r
737 by setting their period. */
\r
738 ucISRAutoReloadTimerCounter = 0;
\r
739 ucISROneShotTimerCounter = 0;
\r
741 /* It is possible that the timer task has not yet made room in the
\r
742 timer queue. If the timers cannot be started then reset uxTick so
\r
743 another attempt is made later. */
\r
744 uxTick = ( portTickType ) -1;
\r
746 /* Try starting first timer. */
\r
747 if( xTimerChangePeriodFromISR( xISRAutoReloadTimer, xBasePeriod, NULL ) == pdPASS )
\r
749 /* First timer was started, try starting the second timer. */
\r
750 if( xTimerChangePeriodFromISR( xISROneShotTimer, xBasePeriod, NULL ) == pdPASS )
\r
752 /* Both timers were started, so set the uxTick back to its
\r
758 /* Second timer could not be started, so stop the first one
\r
760 xTimerStopFromISR( xISRAutoReloadTimer, NULL );
\r
764 else if( uxTick == xBasePeriod )
\r
766 /* Neither timer should have expired yet. */
\r
767 if( ( ucISRAutoReloadTimerCounter != 0 ) || ( ucISROneShotTimerCounter != 0 ) )
\r
769 xTestStatus = pdFAIL;
\r
770 configASSERT( xTestStatus );
\r
773 else if( uxTick == ( xBasePeriod + xMargin ) )
\r
775 /* Both timers should now have expired once. The auto reload timer will
\r
776 still be active, but the one shot timer should now have stopped. */
\r
777 if( ( ucISRAutoReloadTimerCounter != 1 ) || ( ucISROneShotTimerCounter != 1 ) )
\r
779 xTestStatus = pdFAIL;
\r
780 configASSERT( xTestStatus );
\r
783 else if( uxTick == ( 2 * xBasePeriod ) )
\r
785 /* The auto reload timer will still be active, but the one shot timer
\r
786 should now have stopped - however, at this time neither of the timers
\r
787 should have expired again since the last test. */
\r
788 if( ( ucISRAutoReloadTimerCounter != 1 ) || ( ucISROneShotTimerCounter != 1 ) )
\r
790 xTestStatus = pdFAIL;
\r
791 configASSERT( xTestStatus );
\r
794 else if( uxTick == ( ( 2 * xBasePeriod ) + xMargin ) )
\r
796 /* The auto reload timer will still be active, but the one shot timer
\r
797 should now have stopped. At this time the auto reload timer should have
\r
798 expired again, but the one shot timer count should not have changed. */
\r
799 if( ucISRAutoReloadTimerCounter != 2 )
\r
801 xTestStatus = pdFAIL;
\r
802 configASSERT( xTestStatus );
\r
805 if( ucISROneShotTimerCounter != 1 )
\r
807 xTestStatus = pdFAIL;
\r
808 configASSERT( xTestStatus );
\r
811 else if( uxTick == ( ( 2 * xBasePeriod ) + ( xBasePeriod >> ( portTickType ) 2U ) ) )
\r
813 /* The auto reload timer will still be active, but the one shot timer
\r
814 should now have stopped. Again though, at this time, neither timer call
\r
815 back should have been called since the last test. */
\r
816 if( ucISRAutoReloadTimerCounter != 2 )
\r
818 xTestStatus = pdFAIL;
\r
819 configASSERT( xTestStatus );
\r
822 if( ucISROneShotTimerCounter != 1 )
\r
824 xTestStatus = pdFAIL;
\r
825 configASSERT( xTestStatus );
\r
828 else if( uxTick == ( 3 * xBasePeriod ) )
\r
830 /* Start the one shot timer again. */
\r
831 xTimerStartFromISR( xISROneShotTimer, NULL );
\r
833 else if( uxTick == ( ( 3 * xBasePeriod ) + xMargin ) )
\r
835 /* The auto reload timer and one shot timer will be active. At
\r
836 this time the auto reload timer should have expired again, but the one
\r
837 shot timer count should not have changed yet. */
\r
838 if( ucISRAutoReloadTimerCounter != 3 )
\r
840 xTestStatus = pdFAIL;
\r
841 configASSERT( xTestStatus );
\r
844 if( ucISROneShotTimerCounter != 1 )
\r
846 xTestStatus = pdFAIL;
\r
847 configASSERT( xTestStatus );
\r
850 /* Now stop the auto reload timer. The one shot timer was started
\r
851 a few ticks ago. */
\r
852 xTimerStopFromISR( xISRAutoReloadTimer, NULL );
\r
854 else if( uxTick == ( 4 * xBasePeriod ) )
\r
856 /* The auto reload timer is now stopped, and the one shot timer is
\r
857 active, but at this time neither timer should have expired since the
\r
859 if( ucISRAutoReloadTimerCounter != 3 )
\r
861 xTestStatus = pdFAIL;
\r
862 configASSERT( xTestStatus );
\r
865 if( ucISROneShotTimerCounter != 1 )
\r
867 xTestStatus = pdFAIL;
\r
868 configASSERT( xTestStatus );
\r
871 else if( uxTick == ( ( 4 * xBasePeriod ) + xMargin ) )
\r
873 /* The auto reload timer is now stopped, and the one shot timer is
\r
874 active. The one shot timer should have expired again, but the auto
\r
875 reload timer should not have executed its callback. */
\r
876 if( ucISRAutoReloadTimerCounter != 3 )
\r
878 xTestStatus = pdFAIL;
\r
879 configASSERT( xTestStatus );
\r
882 if( ucISROneShotTimerCounter != 2 )
\r
884 xTestStatus = pdFAIL;
\r
885 configASSERT( xTestStatus );
\r
888 else if( uxTick == ( ( 8 * xBasePeriod ) + xMargin ) )
\r
890 /* The auto reload timer is now stopped, and the one shot timer has
\r
891 already expired and then stopped itself. Both callback counters should
\r
892 not have incremented since the last test. */
\r
893 if( ucISRAutoReloadTimerCounter != 3 )
\r
895 xTestStatus = pdFAIL;
\r
896 configASSERT( xTestStatus );
\r
899 if( ucISROneShotTimerCounter != 2 )
\r
901 xTestStatus = pdFAIL;
\r
902 configASSERT( xTestStatus );
\r
905 /* Now reset the one shot timer. */
\r
906 xTimerResetFromISR( xISROneShotTimer, NULL );
\r
908 else if( uxTick == ( 9 * xBasePeriod ) )
\r
910 /* Only the one shot timer should be running, but it should not have
\r
911 expired since the last test. Check the callback counters have not
\r
912 incremented, then reset the one shot timer again. */
\r
913 if( ucISRAutoReloadTimerCounter != 3 )
\r
915 xTestStatus = pdFAIL;
\r
916 configASSERT( xTestStatus );
\r
919 if( ucISROneShotTimerCounter != 2 )
\r
921 xTestStatus = pdFAIL;
\r
922 configASSERT( xTestStatus );
\r
925 xTimerResetFromISR( xISROneShotTimer, NULL );
\r
927 else if( uxTick == ( 10 * xBasePeriod ) )
\r
929 /* Only the one shot timer should be running, but it should not have
\r
930 expired since the last test. Check the callback counters have not
\r
931 incremented, then reset the one shot timer again. */
\r
932 if( ucISRAutoReloadTimerCounter != 3 )
\r
934 xTestStatus = pdFAIL;
\r
935 configASSERT( xTestStatus );
\r
938 if( ucISROneShotTimerCounter != 2 )
\r
940 xTestStatus = pdFAIL;
\r
941 configASSERT( xTestStatus );
\r
944 xTimerResetFromISR( xISROneShotTimer, NULL );
\r
946 else if( uxTick == ( 11 * xBasePeriod ) )
\r
948 /* Only the one shot timer should be running, but it should not have
\r
949 expired since the last test. Check the callback counters have not
\r
950 incremented, then reset the one shot timer once again. */
\r
951 if( ucISRAutoReloadTimerCounter != 3 )
\r
953 xTestStatus = pdFAIL;
\r
954 configASSERT( xTestStatus );
\r
957 if( ucISROneShotTimerCounter != 2 )
\r
959 xTestStatus = pdFAIL;
\r
960 configASSERT( xTestStatus );
\r
963 xTimerResetFromISR( xISROneShotTimer, NULL );
\r
965 else if( uxTick == ( ( 12 * xBasePeriod ) + xMargin ) )
\r
967 /* Only the one shot timer should have been running and this time it
\r
968 should have expired. Check its callback count has been incremented.
\r
969 The auto reload timer is still not running so should still have the same
\r
970 count value. This time the one shot timer is not reset so should not
\r
971 restart from its expiry period again. */
\r
972 if( ucISRAutoReloadTimerCounter != 3 )
\r
974 xTestStatus = pdFAIL;
\r
975 configASSERT( xTestStatus );
\r
978 if( ucISROneShotTimerCounter != 3 )
\r
980 xTestStatus = pdFAIL;
\r
981 configASSERT( xTestStatus );
\r
984 else if( uxTick == ( 15 * xBasePeriod ) )
\r
986 /* Neither timer should be running now. Check neither callback count
\r
987 has incremented, then go back to the start to run these tests all
\r
989 if( ucISRAutoReloadTimerCounter != 3 )
\r
991 xTestStatus = pdFAIL;
\r
992 configASSERT( xTestStatus );
\r
995 if( ucISROneShotTimerCounter != 3 )
\r
997 xTestStatus = pdFAIL;
\r
998 configASSERT( xTestStatus );
\r
1001 uxTick = ( portTickType ) -1;
\r
1004 /*-----------------------------------------------------------*/
\r
1006 /*** Timer callback functions are defined below here. ***/
\r
1008 static void prvAutoReloadTimerCallback( xTimerHandle pxExpiredTimer )
\r
1010 unsigned long ulTimerID;
\r
1012 ulTimerID = ( unsigned long ) pvTimerGetTimerID( pxExpiredTimer );
\r
1013 if( ulTimerID <= ( configTIMER_QUEUE_LENGTH + 1 ) )
\r
1015 ( ucAutoReloadTimerCounters[ ulTimerID ] )++;
\r
1019 /* The timer ID appears to be unexpected (invalid). */
\r
1020 xTestStatus = pdFAIL;
\r
1021 configASSERT( xTestStatus );
\r
1024 /*-----------------------------------------------------------*/
\r
1026 static void prvOneShotTimerCallback( xTimerHandle pxExpiredTimer )
\r
1028 /* The parameter is not used in this case as only one timer uses this
\r
1029 callback function. */
\r
1030 ( void ) pxExpiredTimer;
\r
1032 ucOneShotTimerCounter++;
\r
1034 /*-----------------------------------------------------------*/
\r
1036 static void prvISRAutoReloadTimerCallback( xTimerHandle pxExpiredTimer )
\r
1038 /* The parameter is not used in this case as only one timer uses this
\r
1039 callback function. */
\r
1040 ( void ) pxExpiredTimer;
\r
1042 ucISRAutoReloadTimerCounter++;
\r
1044 /*-----------------------------------------------------------*/
\r
1046 static void prvISROneShotTimerCallback( xTimerHandle pxExpiredTimer )
\r
1048 /* The parameter is not used in this case as only one timer uses this
\r
1049 callback function. */
\r
1050 ( void ) pxExpiredTimer;
\r
1052 ucISROneShotTimerCounter++;
\r
1054 /*-----------------------------------------------------------*/
\r