]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/TimerDemo.c
Update version numbers in preparation for a new release.
[freertos] / FreeRTOS / Demo / Common / Minimal / TimerDemo.c
index 35f8d96780ca6d83e6874c5cd9e21632e274886d..4dac44ec71931335c44785f5b4083d98bcceb260 100644 (file)
@@ -1,67 +1,29 @@
 /*\r
-    FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd. \r
-    All rights reserved\r
-\r
-    VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS provides completely free yet professionally developed,    *\r
-     *    robust, strictly quality controlled, supported, and cross          *\r
-     *    platform software that has become a de facto standard.             *\r
-     *                                                                       *\r
-     *    Help yourself get started quickly and support the FreeRTOS         *\r
-     *    project by purchasing a FreeRTOS tutorial book, reference          *\r
-     *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
-     *                                                                       *\r
-     *    Thank you!                                                         *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    This file is part of the FreeRTOS distribution.\r
-\r
-    FreeRTOS is free software; you can redistribute it and/or modify it under\r
-    the terms of the GNU General Public License (version 2) as published by the\r
-    Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
-\r
-    >>!   NOTE: The modification to the GPL is included to allow you to     !<<\r
-    >>!   distribute a combined work that includes FreeRTOS without being   !<<\r
-    >>!   obliged to provide the source code for proprietary components     !<<\r
-    >>!   outside of the FreeRTOS kernel.                                   !<<\r
-\r
-    FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
-    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
-    FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
-    link: http://www.freertos.org/a00114.html\r
-\r
-    1 tab == 4 spaces!\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    Having a problem?  Start by reading the FAQ "My application does   *\r
-     *    not run, what could be wrong?"                                     *\r
-     *                                                                       *\r
-     *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
-     *                                                                       *\r
-    ***************************************************************************\r
-\r
-    http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
-    license and Real Time Engineers Ltd. contact details.\r
-\r
-    http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
-    including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
-    compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
-    Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
-    licenses offer ticketed support, indemnification and middleware.\r
-\r
-    http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
-    engineered and independently SIL3 certified version for use in safety and\r
-    mission critical applications that require provable dependability.\r
-\r
-    1 tab == 4 spaces!\r
-*/\r
+ * FreeRTOS Kernel V10.1.0\r
+ * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.\r
+ *\r
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of\r
+ * this software and associated documentation files (the "Software"), to deal in\r
+ * the Software without restriction, including without limitation the rights to\r
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\r
+ * the Software, and to permit persons to whom the Software is furnished to do so,\r
+ * subject to the following conditions:\r
+ *\r
+ * The above copyright notice and this permission notice shall be included in all\r
+ * copies or substantial portions of the Software.\r
+ *\r
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\r
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\r
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\r
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\r
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r
+ *\r
+ * http://www.FreeRTOS.org\r
+ * http://aws.amazon.com/freertos\r
+ *\r
+ * 1 tab == 4 spaces!\r
+ */\r
 \r
 \r
 /*\r
@@ -188,7 +150,7 @@ static void prvTimerTestTask( void *pvParameters )
        xOneShotTimer = xTimerCreate(   "Oneshot Timer",                                /* Text name to facilitate debugging.  The kernel does not use this itself. */\r
                                                                        tmrdemoONE_SHOT_TIMER_PERIOD,   /* The period for the timer. */\r
                                                                        pdFALSE,                                                /* Don't auto-reload - hence a one shot timer. */\r
-                                                                       ( void * ) 0,                                   /* The timer identifier.  In this case this is not used as the timer has its own callback. */\r
+                                                                       ( void * ) 0,                                   /* The timer identifier.  Initialise to 0, then increment each time it is called. */\r
                                                                        prvOneShotTimerCallback );              /* The callback to be called when the timer expires. */\r
 \r
        if( xOneShotTimer == NULL )\r
@@ -210,7 +172,7 @@ static void prvTimerTestTask( void *pvParameters )
                /* Check the auto reload timers can be stopped correctly, and correctly\r
                report their state. */\r
                prvTest4_CheckAutoReloadTimersCanBeStopped();\r
-                               \r
+\r
                /* Check the one shot timer only calls its callback once after it has been\r
                started, and that it reports its state correctly. */\r
                prvTest5_CheckBasicOneShotTimerBehaviour();\r
@@ -238,7 +200,7 @@ static TickType_t xIterationsWithoutCounterIncrement = ( TickType_t ) 0, xLastCy
                elsewhere.  Start counting Iterations again. */\r
                xIterationsWithoutCounterIncrement = ( TickType_t ) 0;\r
                xLastCycleFrequency = xCycleFrequency;\r
-       }               \r
+       }\r
 \r
        /* Calculate the maximum number of times that it is permissible for this\r
        function to be called without ulLoopCounter being incremented.  This is\r
@@ -256,7 +218,6 @@ static TickType_t xIterationsWithoutCounterIncrement = ( TickType_t ) 0, xLastCy
                {\r
                        /* The tests appear to be no longer running (stalled). */\r
                        xTestStatus = pdFAIL;\r
-                       configASSERT( xTestStatus );\r
                }\r
        }\r
        else\r
@@ -277,22 +238,20 @@ static TickType_t xIterationsWithoutCounterIncrement = ( TickType_t ) 0, xLastCy
 \r
 static void prvTest1_CreateTimersWithoutSchedulerRunning( void )\r
 {\r
-UBaseType_t xTimer;\r
+TickType_t xTimer;\r
 \r
        for( xTimer = 0; xTimer < configTIMER_QUEUE_LENGTH; xTimer++ )\r
        {\r
-               /* As the timer queue is not yet full, it should be possible to both create\r
-               and start a timer.  These timers are being started before the scheduler has\r
-               been started, so their block times should get set to zero within the timer\r
-               API itself. */\r
+               /* As the timer queue is not yet full, it should be possible to both\r
+               create and start a timer.  These timers are being started before the\r
+               scheduler has been started, so their block times should get set to zero\r
+               within the timer API itself. */\r
                xAutoReloadTimers[ xTimer ] = xTimerCreate( "FR Timer",                                                 /* Text name to facilitate debugging.  The kernel does not use this itself. */\r
                                                                                                        ( ( xTimer + ( TickType_t ) 1 ) * xBasePeriod ),/* The period for the timer.  The plus 1 ensures a period of zero is not specified. */\r
                                                                                                        pdTRUE,                                                         /* Auto-reload is set to true. */\r
                                                                                                        ( void * ) xTimer,                                      /* An identifier for the timer as all the auto reload timers use the same callback. */\r
                                                                                                        prvAutoReloadTimerCallback );           /* The callback to be called when the timer expires. */\r
 \r
-               configASSERT( strcmp( pcTimerGetTimerName( xAutoReloadTimers[ xTimer ] ), "FR Timer" ) == 0 );\r
-\r
                if( xAutoReloadTimers[ xTimer ] == NULL )\r
                {\r
                        xTestStatus = pdFAIL;\r
@@ -300,6 +259,8 @@ UBaseType_t xTimer;
                }\r
                else\r
                {\r
+                       configASSERT( strcmp( pcTimerGetName( xAutoReloadTimers[ xTimer ] ), "FR Timer" ) == 0 );\r
+\r
                        /* The scheduler has not yet started, so the block period of\r
                        portMAX_DELAY should just get set to zero in xTimerStart().  Also,\r
                        the timer queue is not yet full so xTimerStart() should return\r
@@ -336,7 +297,7 @@ UBaseType_t xTimer;
                        configASSERT( xTestStatus );\r
                }\r
        }\r
-       \r
+\r
        /* Create the timers that are used from the tick interrupt to test the timer\r
        API functions that can be called from an ISR. */\r
        xISRAutoReloadTimer = xTimerCreate( "ISR AR",                                                   /* The text name given to the timer. */\r
@@ -350,7 +311,7 @@ UBaseType_t xTimer;
                                                                                pdFALSE,                                                        /* This is a one shot timer. */\r
                                                                                ( void * ) NULL,                                        /* The identifier is not required. */\r
                                                                                prvISROneShotTimerCallback );           /* The callback that is executed when the timer expires. */\r
-                                                                               \r
+\r
        if( ( xISRAutoReloadTimer == NULL ) || ( xISROneShotTimer == NULL ) )\r
        {\r
                xTestStatus = pdFAIL;\r
@@ -391,16 +352,20 @@ static void       prvTest3_CheckAutoReloadExpireRates( void )
 {\r
 uint8_t ucMaxAllowableValue, ucMinAllowableValue, ucTimer;\r
 TickType_t xBlockPeriod, xTimerPeriod, xExpectedNumber;\r
+UBaseType_t uxOriginalPriority;\r
 \r
-       /* Check the auto reload timers expire at the expected rates. */\r
+       /* Check the auto reload timers expire at the expected rates.  Do this at a\r
+       high priority for maximum accuracy.  This is ok as most of the time is spent\r
+       in the Blocked state. */\r
+       uxOriginalPriority = uxTaskPriorityGet( NULL );\r
+       vTaskPrioritySet( NULL, ( configMAX_PRIORITIES - 1 ) );\r
 \r
-       \r
        /* Delaying for configTIMER_QUEUE_LENGTH * xBasePeriod ticks should allow\r
        all the auto reload timers to expire at least once. */\r
        xBlockPeriod = ( ( TickType_t ) configTIMER_QUEUE_LENGTH ) * xBasePeriod;\r
        vTaskDelay( xBlockPeriod );\r
 \r
-       /* Check that all the auto reload timers have called their callback     \r
+       /* Check that all the auto reload timers have called their callback\r
        function the expected number of times. */\r
        for( ucTimer = 0; ucTimer < ( uint8_t ) configTIMER_QUEUE_LENGTH; ucTimer++ )\r
        {\r
@@ -408,7 +373,7 @@ TickType_t xBlockPeriod, xTimerPeriod, xExpectedNumber;
                by the timer period. */\r
                xTimerPeriod = ( ( ( TickType_t ) ucTimer + ( TickType_t ) 1 ) * xBasePeriod );\r
                xExpectedNumber = xBlockPeriod / xTimerPeriod;\r
-               \r
+\r
                ucMaxAllowableValue = ( ( uint8_t ) xExpectedNumber ) ;\r
                ucMinAllowableValue = ( uint8_t ) ( ( uint8_t ) xExpectedNumber - ( uint8_t ) 1 ); /* Weird casting to try and please all compilers. */\r
 \r
@@ -421,6 +386,9 @@ TickType_t xBlockPeriod, xTimerPeriod, xExpectedNumber;
                }\r
        }\r
 \r
+       /* Return to the original priority. */\r
+       vTaskPrioritySet( NULL, uxOriginalPriority );\r
+\r
        if( xTestStatus == pdPASS )\r
        {\r
                /* No errors have been reported so increment the loop counter so the\r
@@ -431,7 +399,7 @@ TickType_t xBlockPeriod, xTimerPeriod, xExpectedNumber;
 /*-----------------------------------------------------------*/\r
 \r
 static void prvTest4_CheckAutoReloadTimersCanBeStopped( void )\r
-{              \r
+{\r
 uint8_t ucTimer;\r
 \r
        /* Check the auto reload timers can be stopped correctly, and correctly\r
@@ -739,9 +707,19 @@ static TickType_t uxTick = ( TickType_t ) -1;
        will expire when the kernel's tick count is (100 + xBasePeriod).  For this\r
        reason xMargin is used as an allowable margin for premature timer expiries\r
        as well as late timer expiries. */\r
-       const TickType_t xMargin = 6;\r
+       #ifdef _WINDOWS_\r
+               /* Windows is not real real time. */\r
+               const TickType_t xMargin = 20;\r
+       #else\r
+               const TickType_t xMargin = 6;\r
+       #endif /* _WINDOWS_ */\r
 #else\r
-       const TickType_t xMargin = 3;\r
+       #ifdef _WINDOWS_\r
+               /* Windows is not real real time. */\r
+               const TickType_t xMargin = 20;\r
+       #else\r
+               const TickType_t xMargin = 4;\r
+       #endif /* _WINDOWS_ */\r
 #endif\r
 \r
 \r
@@ -749,7 +727,7 @@ static TickType_t uxTick = ( TickType_t ) -1;
 \r
        if( uxTick == 0 )\r
        {\r
-               /* The timers will have been created, but not started.  Start them now \r
+               /* The timers will have been created, but not started.  Start them now\r
                by setting their period. */\r
                ucISRAutoReloadTimerCounter = 0;\r
                ucISROneShotTimerCounter = 0;\r
@@ -765,7 +743,7 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        /* First timer was started, try starting the second timer. */\r
                        if( xTimerChangePeriodFromISR( xISROneShotTimer, xBasePeriod, NULL ) == pdPASS )\r
                        {\r
-                               /* Both timers were started, so set the uxTick back to its \r
+                               /* Both timers were started, so set the uxTick back to its\r
                                proper value. */\r
                                uxTick = 0;\r
                        }\r
@@ -805,7 +783,7 @@ static TickType_t uxTick = ( TickType_t ) -1;
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
-               }               \r
+               }\r
        }\r
        else if( uxTick == ( ( 2 * xBasePeriod ) + xMargin ) )\r
        {\r
@@ -817,7 +795,7 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 1 )\r
                {\r
                        xTestStatus = pdFAIL;\r
@@ -834,13 +812,13 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 1 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-       }       \r
+       }\r
        else if( uxTick == ( 3 * xBasePeriod ) )\r
        {\r
                /* Start the one shot timer again. */\r
@@ -856,17 +834,17 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 1 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                /* Now stop the auto reload timer.  The one shot timer was started\r
                a few ticks ago. */\r
                xTimerStopFromISR( xISRAutoReloadTimer, NULL );\r
-       }       \r
+       }\r
        else if( uxTick == ( 4 * ( xBasePeriod - xMargin ) ) )\r
        {\r
                /* The auto reload timer is now stopped, and the one shot timer is\r
@@ -877,13 +855,13 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 1 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-       }       \r
+       }\r
        else if( uxTick == ( ( 4 * xBasePeriod ) + xMargin ) )\r
        {\r
                /* The auto reload timer is now stopped, and the one shot timer is\r
@@ -894,13 +872,13 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 2 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-       }       \r
+       }\r
        else if( uxTick == ( 8 * xBasePeriod ) )\r
        {\r
                /* The auto reload timer is now stopped, and the one shot timer has\r
@@ -911,16 +889,16 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 2 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                /* Now reset the one shot timer. */\r
                xTimerResetFromISR( xISROneShotTimer, NULL );\r
-       }       \r
+       }\r
        else if( uxTick == ( ( 9 * xBasePeriod ) - xMargin ) )\r
        {\r
                /* Only the one shot timer should be running, but it should not have\r
@@ -931,15 +909,15 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 2 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                xTimerResetFromISR( xISROneShotTimer, NULL );\r
-       }       \r
+       }\r
        else if( uxTick == ( ( 10 * xBasePeriod ) - ( 2 * xMargin ) ) )\r
        {\r
                /* Only the one shot timer should be running, but it should not have\r
@@ -950,13 +928,13 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 2 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                xTimerResetFromISR( xISROneShotTimer, NULL );\r
        }\r
        else if( uxTick == ( ( 11 * xBasePeriod ) - ( 3 * xMargin ) ) )\r
@@ -969,15 +947,15 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 2 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                xTimerResetFromISR( xISROneShotTimer, NULL );\r
-       }       \r
+       }\r
        else if( uxTick == ( ( 12 * xBasePeriod ) - ( 2 * xMargin ) ) )\r
        {\r
                /* Only the one shot timer should have been running and this time it\r
@@ -990,7 +968,7 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 3 )\r
                {\r
                        xTestStatus = pdFAIL;\r
@@ -1007,15 +985,15 @@ static TickType_t uxTick = ( TickType_t ) -1;
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                if( ucISROneShotTimerCounter != 3 )\r
                {\r
                        xTestStatus = pdFAIL;\r
                        configASSERT( xTestStatus );\r
                }\r
-               \r
+\r
                uxTick = ( TickType_t ) -1;\r
-       }       \r
+       }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
@@ -1023,12 +1001,12 @@ static TickType_t uxTick = ( TickType_t ) -1;
 \r
 static void prvAutoReloadTimerCallback( TimerHandle_t pxExpiredTimer )\r
 {\r
-uint32_t ulTimerID;\r
+size_t uxTimerID;\r
 \r
-       ulTimerID = ( uint32_t ) pvTimerGetTimerID( pxExpiredTimer );\r
-       if( ulTimerID <= ( configTIMER_QUEUE_LENGTH + 1 ) )\r
+       uxTimerID = ( size_t ) pvTimerGetTimerID( pxExpiredTimer );\r
+       if( uxTimerID <= ( configTIMER_QUEUE_LENGTH + 1 ) )\r
        {\r
-               ( ucAutoReloadTimerCounters[ ulTimerID ] )++;\r
+               ( ucAutoReloadTimerCounters[ uxTimerID ] )++;\r
        }\r
        else\r
        {\r
@@ -1041,9 +1019,22 @@ uint32_t ulTimerID;
 \r
 static void prvOneShotTimerCallback( TimerHandle_t pxExpiredTimer )\r
 {\r
-       /* The parameter is not used in this case as only one timer uses this\r
-       callback function. */\r
-       ( void ) pxExpiredTimer;\r
+/* A count is kept of the number of times this callback function is executed.\r
+The count is stored as the timer's ID.  This is only done to test the\r
+vTimerSetTimerID() function. */\r
+static size_t uxCallCount = 0;\r
+size_t uxLastCallCount;\r
+\r
+       /* Obtain the timer's ID, which should be a count of the number of times\r
+       this callback function has been executed. */\r
+       uxLastCallCount = ( size_t ) pvTimerGetTimerID( pxExpiredTimer );\r
+       configASSERT( uxLastCallCount == uxCallCount );\r
+\r
+       /* Increment the call count, then save it back as the timer's ID.  This is\r
+       only done to test the vTimerSetTimerID() API function. */\r
+       uxLastCallCount++;\r
+       vTimerSetTimerID( pxExpiredTimer, ( void * ) uxLastCallCount );\r
+       uxCallCount++;\r
 \r
        ucOneShotTimerCounter++;\r
 }\r