]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/blocktim.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Demo / Common / Minimal / blocktim.c
index 4684dcd368ad7fadd23fb614ee598a80e856148b..92282fe26bdb7c75bccc395ff4a668c6f9a89835 100644 (file)
@@ -1,76 +1,29 @@
 /*\r
-    FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.\r
-\r
-    FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT\r
-    http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
-\r
-    ***************************************************************************\r
-     *                                                                       *\r
-     *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
-     *    Complete, revised, and edited pdf reference manuals are also       *\r
-     *    available.                                                         *\r
-     *                                                                       *\r
-     *    Purchasing FreeRTOS documentation will not only help you, by       *\r
-     *    ensuring you get running as quickly as possible and with an        *\r
-     *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
-     *    the FreeRTOS project to continue with its mission of providing     *\r
-     *    professional grade, cross platform, de facto standard solutions    *\r
-     *    for microcontrollers - completely free of charge!                  *\r
-     *                                                                       *\r
-     *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
-     *                                                                       *\r
-     *    Thank you for using FreeRTOS, and thank you for your support!      *\r
-     *                                                                       *\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 obliged to\r
-    provide the source code for proprietary components outside of the FreeRTOS\r
-    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.  See the GNU General Public License for more\r
-    details. You should have received a copy of the GNU General Public License\r
-    and the FreeRTOS license exception along with FreeRTOS; if not it can be\r
-    viewed here: http://www.freertos.org/a00114.html and also obtained by\r
-    writing to Real Time Engineers Ltd., contact details for whom are available\r
-    on the FreeRTOS WEB site.\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
-\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, and our new\r
-    fully thread aware and reentrant UDP/IP stack.\r
-\r
-    http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High \r
-    Integrity Systems, who sell the code with commercial support, \r
-    indemnification and middleware, under the OpenRTOS brand.\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
+ * FreeRTOS Kernel V10.3.0\r
+ * Copyright (C) 2020 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
  * This file contains some test scenarios that ensure tasks do not exit queue\r
@@ -86,7 +39,7 @@
 /* Demo includes. */\r
 #include "blocktim.h"\r
 \r
-/* Task priorities.  Allow these to be overridden. */\r
+/* Task priorities and stack sizes.  Allow these to be overridden. */\r
 #ifndef bktPRIMARY_PRIORITY\r
        #define bktPRIMARY_PRIORITY             ( configMAX_PRIORITIES - 3 )\r
 #endif\r
        #define bktSECONDARY_PRIORITY   ( configMAX_PRIORITIES - 4 )\r
 #endif\r
 \r
+#ifndef bktBLOCK_TIME_TASK_STACK_SIZE\r
+       #define bktBLOCK_TIME_TASK_STACK_SIZE configMINIMAL_STACK_SIZE\r
+#endif\r
+\r
 /* Task behaviour. */\r
 #define bktQUEUE_LENGTH                                ( 5 )\r
-#define bktSHORT_WAIT                          ( ( ( portTickType ) 20 ) / portTICK_RATE_MS )\r
+#define bktSHORT_WAIT                          pdMS_TO_TICKS( ( TickType_t ) 20 )\r
 #define bktPRIMARY_BLOCK_TIME          ( 10 )\r
 #define bktALLOWABLE_MARGIN                    ( 15 )\r
 #define bktTIME_TO_BLOCK                       ( 175 )\r
-#define bktDONT_BLOCK                          ( ( portTickType ) 0 )\r
-#define bktRUN_INDICATOR                       ( ( unsigned portBASE_TYPE ) 0x55 )\r
+#define bktDONT_BLOCK                          ( ( TickType_t ) 0 )\r
+#define bktRUN_INDICATOR                       ( ( UBaseType_t ) 0x55 )\r
+\r
+/* In case the demo does not have software timers enabled, as this file uses\r
+the configTIMER_TASK_PRIORITY setting. */\r
+#ifndef configTIMER_TASK_PRIORITY\r
+       #define configTIMER_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )\r
+#endif\r
+\r
+/*-----------------------------------------------------------*/\r
+\r
+/*\r
+ * The two test tasks.  Their behaviour is commented within the functions.\r
+ */\r
+static void vPrimaryBlockTimeTestTask( void *pvParameters );\r
+static void vSecondaryBlockTimeTestTask( void *pvParameters );\r
+\r
+/*\r
+ * Very basic tests to verify the block times are as expected.\r
+ */\r
+static void prvBasicDelayTests( void );\r
+\r
+/*-----------------------------------------------------------*/\r
 \r
 /* The queue on which the tasks block. */\r
-static xQueueHandle xTestQueue;\r
+static QueueHandle_t xTestQueue;\r
 \r
 /* Handle to the secondary task is required by the primary task for calls\r
 to vTaskSuspend/Resume(). */\r
-static xTaskHandle xSecondary;\r
+static TaskHandle_t xSecondary;\r
 \r
 /* Used to ensure that tasks are still executing without error. */\r
-static volatile portBASE_TYPE xPrimaryCycles = 0, xSecondaryCycles = 0;\r
-static volatile portBASE_TYPE xErrorOccurred = pdFALSE;\r
+static volatile BaseType_t xPrimaryCycles = 0, xSecondaryCycles = 0;\r
+static volatile BaseType_t xErrorOccurred = pdFALSE;\r
 \r
 /* Provides a simple mechanism for the primary task to know when the\r
 secondary task has executed. */\r
-static volatile unsigned portBASE_TYPE xRunIndicator;\r
-\r
-/* The two test tasks.  Their behaviour is commented within the files. */\r
-static void vPrimaryBlockTimeTestTask( void *pvParameters );\r
-static void vSecondaryBlockTimeTestTask( void *pvParameters );\r
+static volatile UBaseType_t xRunIndicator;\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
 void vCreateBlockTimeTasks( void )\r
 {\r
        /* Create the queue on which the two tasks block. */\r
-    xTestQueue = xQueueCreate( bktQUEUE_LENGTH, sizeof( portBASE_TYPE ) );\r
-\r
-       /* vQueueAddToRegistry() adds the queue to the queue registry, if one is\r
-       in use.  The queue registry is provided as a means for kernel aware\r
-       debuggers to locate queues and has no purpose if a kernel aware debugger\r
-       is not being used.  The call to vQueueAddToRegistry() will be removed\r
-       by the pre-processor if configQUEUE_REGISTRY_SIZE is not defined or is\r
-       defined to be less than 1. */\r
-       vQueueAddToRegistry( xTestQueue, ( signed char * ) "Block_Time_Queue" );\r
-\r
-       /* Create the two test tasks. */\r
-       xTaskCreate( vPrimaryBlockTimeTestTask, ( signed char * )"BTest1", configMINIMAL_STACK_SIZE, NULL, bktPRIMARY_PRIORITY, NULL );\r
-       xTaskCreate( vSecondaryBlockTimeTestTask, ( signed char * )"BTest2", configMINIMAL_STACK_SIZE, NULL, bktSECONDARY_PRIORITY, &xSecondary );\r
+       xTestQueue = xQueueCreate( bktQUEUE_LENGTH, sizeof( BaseType_t ) );\r
+\r
+       if( xTestQueue != NULL )\r
+       {\r
+               /* vQueueAddToRegistry() adds the queue to the queue registry, if one\r
+               is in use.  The queue registry is provided as a means for kernel aware\r
+               debuggers to locate queues and has no purpose if a kernel aware\r
+               debugger is not being used.  The call to vQueueAddToRegistry() will be\r
+               removed by the pre-processor if configQUEUE_REGISTRY_SIZE is not\r
+               defined or is defined to be less than 1. */\r
+               vQueueAddToRegistry( xTestQueue, "Block_Time_Queue" );\r
+\r
+               /* Create the two test tasks. */\r
+               xTaskCreate( vPrimaryBlockTimeTestTask, "BTest1", bktBLOCK_TIME_TASK_STACK_SIZE, NULL, bktPRIMARY_PRIORITY, NULL );\r
+               xTaskCreate( vSecondaryBlockTimeTestTask, "BTest2", bktBLOCK_TIME_TASK_STACK_SIZE, NULL, bktSECONDARY_PRIORITY, &xSecondary );\r
+       }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 static void vPrimaryBlockTimeTestTask( void *pvParameters )\r
 {\r
-portBASE_TYPE xItem, xData;\r
-portTickType xTimeWhenBlocking;\r
-portTickType xTimeToBlock, xBlockedTime;\r
+BaseType_t xItem, xData;\r
+TickType_t xTimeWhenBlocking;\r
+TickType_t xTimeToBlock, xBlockedTime;\r
 \r
        ( void ) pvParameters;\r
 \r
        for( ;; )\r
        {\r
                /*********************************************************************\r
-        Test 1\r
+               Test 0\r
 \r
-        Simple block time wakeup test on queue receives. */\r
+               Basic vTaskDelay() and vTaskDelayUntil() tests. */\r
+               prvBasicDelayTests();\r
+\r
+\r
+               /*********************************************************************\r
+               Test 1\r
+\r
+               Simple block time wakeup test on queue receives. */\r
                for( xItem = 0; xItem < bktQUEUE_LENGTH; xItem++ )\r
                {\r
                        /* The queue is empty. Attempt to read from the queue using a block\r
                        time.  When we wake, ensure the delta in time is as expected. */\r
-                       xTimeToBlock = ( portTickType ) ( bktPRIMARY_BLOCK_TIME << xItem );\r
+                       xTimeToBlock = ( TickType_t ) ( bktPRIMARY_BLOCK_TIME << xItem );\r
 \r
                        xTimeWhenBlocking = xTaskGetTickCount();\r
 \r
@@ -192,9 +176,9 @@ portTickType xTimeToBlock, xBlockedTime;
                }\r
 \r
                /*********************************************************************\r
-        Test 2\r
+               Test 2\r
 \r
-        Simple block time wakeup test on queue sends.\r
+               Simple block time wakeup test on queue sends.\r
 \r
                First fill the queue.  It should be empty so all sends should pass. */\r
                for( xItem = 0; xItem < bktQUEUE_LENGTH; xItem++ )\r
@@ -213,7 +197,7 @@ portTickType xTimeToBlock, xBlockedTime;
                {\r
                        /* The queue is full. Attempt to write to the queue using a block\r
                        time.  When we wake, ensure the delta in time is as expected. */\r
-                       xTimeToBlock = ( portTickType ) ( bktPRIMARY_BLOCK_TIME << xItem );\r
+                       xTimeToBlock = ( TickType_t ) ( bktPRIMARY_BLOCK_TIME << xItem );\r
 \r
                        xTimeWhenBlocking = xTaskGetTickCount();\r
 \r
@@ -243,7 +227,7 @@ portTickType xTimeToBlock, xBlockedTime;
                }\r
 \r
                /*********************************************************************\r
-        Test 3\r
+               Test 3\r
 \r
                Wake the other task, it will block attempting to post to the queue.\r
                When we read from the queue the other task will wake, but before it\r
@@ -318,7 +302,7 @@ portTickType xTimeToBlock, xBlockedTime;
 \r
 \r
                /*********************************************************************\r
-        Test 4\r
+               Test 4\r
 \r
                As per test 3 - but with the send and receive the other way around.\r
                The other task blocks attempting to read from the queue.\r
@@ -397,29 +381,29 @@ portTickType xTimeToBlock, xBlockedTime;
 \r
 static void vSecondaryBlockTimeTestTask( void *pvParameters )\r
 {\r
-portTickType xTimeWhenBlocking, xBlockedTime;\r
-portBASE_TYPE xData;\r
+TickType_t xTimeWhenBlocking, xBlockedTime;\r
+BaseType_t xData;\r
 \r
        ( void ) pvParameters;\r
 \r
        for( ;; )\r
        {\r
                /*********************************************************************\r
-        Test 1 and 2\r
+               Test 0, 1 and 2\r
 \r
-               This task does does not participate in these tests. */\r
+               This task does not participate in these tests. */\r
                vTaskSuspend( NULL );\r
 \r
                /*********************************************************************\r
-        Test 3\r
+               Test 3\r
 \r
                The first thing we do is attempt to read from the queue.  It should be\r
                full so we block.  Note the time before we block so we can check the\r
                wake time is as per that expected. */\r
                xTimeWhenBlocking = xTaskGetTickCount();\r
 \r
-               /* We should unblock after bktTIME_TO_BLOCK having not sent\r
-               anything to the queue. */\r
+               /* We should unblock after bktTIME_TO_BLOCK having not sent anything to\r
+               the queue. */\r
                xData = 0;\r
                xRunIndicator = bktRUN_INDICATOR;\r
                if( xQueueSend( xTestQueue, &xData, bktTIME_TO_BLOCK ) != errQUEUE_FULL )\r
@@ -485,10 +469,57 @@ portBASE_TYPE xData;
 }\r
 /*-----------------------------------------------------------*/\r
 \r
-portBASE_TYPE xAreBlockTimeTestTasksStillRunning( void )\r
+static void prvBasicDelayTests( void )\r
+{\r
+TickType_t xPreTime, xPostTime, x, xLastUnblockTime, xExpectedUnblockTime;\r
+const TickType_t xPeriod = 75, xCycles = 5, xAllowableMargin = ( bktALLOWABLE_MARGIN >> 1 );\r
+\r
+       /* Temporarily increase priority so the timing is more accurate, but not so\r
+       high as to disrupt the timer tests. */\r
+       vTaskPrioritySet( NULL, configTIMER_TASK_PRIORITY - 1 );\r
+\r
+       /* Crude check to too see that vTaskDelay() blocks for the expected\r
+       period. */\r
+       xPreTime = xTaskGetTickCount();\r
+       vTaskDelay( bktTIME_TO_BLOCK );\r
+       xPostTime = xTaskGetTickCount();\r
+\r
+       /* The priority is higher, so the allowable margin is halved when compared\r
+       to the other tests in this file. */\r
+       if( ( xPostTime - xPreTime ) > ( bktTIME_TO_BLOCK + xAllowableMargin ) )\r
+       {\r
+               xErrorOccurred = pdTRUE;\r
+       }\r
+\r
+       /* Now crude tests to check the vTaskDelayUntil() functionality. */\r
+       xPostTime = xTaskGetTickCount();\r
+       xLastUnblockTime = xPostTime;\r
+\r
+       for( x = 0; x < xCycles; x++ )\r
+       {\r
+               /* Calculate the next expected unblock time from the time taken before\r
+               this loop was entered. */\r
+               xExpectedUnblockTime = xPostTime + ( x * xPeriod );\r
+\r
+               vTaskDelayUntil( &xLastUnblockTime, xPeriod );\r
+\r
+               if( ( xTaskGetTickCount() - xExpectedUnblockTime ) > ( bktTIME_TO_BLOCK + xAllowableMargin ) )\r
+               {\r
+                       xErrorOccurred = pdTRUE;\r
+               }\r
+\r
+               xPrimaryCycles++;\r
+       }\r
+\r
+       /* Reset to the original task priority ready for the other tests. */\r
+       vTaskPrioritySet( NULL, bktPRIMARY_PRIORITY );\r
+}\r
+/*-----------------------------------------------------------*/\r
+\r
+BaseType_t xAreBlockTimeTestTasksStillRunning( void )\r
 {\r
-static portBASE_TYPE xLastPrimaryCycleCount = 0, xLastSecondaryCycleCount = 0;\r
-portBASE_TYPE xReturn = pdPASS;\r
+static BaseType_t xLastPrimaryCycleCount = 0, xLastSecondaryCycleCount = 0;\r
+BaseType_t xReturn = pdPASS;\r
 \r
        /* Have both tasks performed at least one cycle since this function was\r
        last called? */\r