]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/Common/Minimal/BlockQ.c
Update version number in readiness for V10.3.0 release. Sync SVN with reviewed releas...
[freertos] / FreeRTOS / Demo / Common / Minimal / BlockQ.c
index 43f5ac70c069bfd7370ee79b4c789f578a2b6b14..df338ab2a6fcf29fa5cb4d471a9988722aff1410 100644 (file)
@@ -1,66 +1,29 @@
 /*\r
-    FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.\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 distribute\r
-    >>! a combined work that includes FreeRTOS without being obliged to provide\r
-    >>! 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.  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.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
  * Creates six tasks that operate on three queues as follows:\r
  *\r
  */\r
 \r
-/*\r
-\r
-Changes from V4.1.1\r
-\r
-       + The second set of tasks were created the wrong way around.  This has been\r
-         corrected.\r
-*/\r
-\r
-\r
 #include <stdlib.h>\r
 \r
 /* Scheduler include files. */\r
@@ -108,11 +62,15 @@ Changes from V4.1.1
 #define blckqSTACK_SIZE                configMINIMAL_STACK_SIZE\r
 #define blckqNUM_TASK_SETS     ( 3 )\r
 \r
+#if( configSUPPORT_DYNAMIC_ALLOCATION == 0 )\r
+       #error This example cannot be used if dynamic allocation is not allowed.\r
+#endif\r
+\r
 /* Structure used to pass parameters to the blocking queue tasks. */\r
 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 {\r
-       xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
-       portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
+       QueueHandle_t xQueue;                                   /*< The queue to be used by the task. */\r
+       TickType_t xBlockTime;                          /*< The block time to use on queue reads/writes. */\r
        volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
 } xBlockingQueueParameters;\r
 \r
@@ -126,31 +84,31 @@ static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );
 /* Variables which are incremented each time an item is removed from a queue, and\r
 found to be the expected value.\r
 These are used to check that the tasks are still running. */\r
-static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
+static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 \r
 /* Variable which are incremented each time an item is posted on a queue.   These\r
 are used to check that the tasks are still running. */\r
-static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
+static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 \r
 /*-----------------------------------------------------------*/\r
 \r
-void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
+void vStartBlockingQueueTasks( UBaseType_t uxPriority )\r
 {\r
 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
-const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
-const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
-const portTickType xDontBlock = ( portTickType ) 0;\r
+const UBaseType_t uxQueueSize1 = 1, uxQueueSize5 = 5;\r
+const TickType_t xBlockTime = pdMS_TO_TICKS( ( TickType_t ) 1000 );\r
+const TickType_t xDontBlock = ( TickType_t ) 0;\r
 \r
        /* Create the first two tasks as described at the top of the file. */\r
-       \r
+\r
        /* First create the structure used to pass parameters to the consumer tasks. */\r
        pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 \r
        /* Create the queue used by the first two tasks to pass the incrementing number.\r
        Pass a pointer to the queue in the parameter structure. */\r
-       pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
+       pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
 \r
        /* The consumer is created first so gets a block time as described above. */\r
        pxQueueParameters1->xBlockTime = xBlockTime;\r
@@ -158,7 +116,7 @@ const portTickType xDontBlock = ( portTickType ) 0;
        /* Pass in the variable that this task is going to increment so we can check it\r
        is still running. */\r
        pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
-               \r
+\r
        /* Create the structure used to pass parameters to the producer task. */\r
        pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 \r
@@ -176,16 +134,16 @@ const portTickType xDontBlock = ( portTickType ) 0;
 \r
        /* Note the producer has a lower priority than the consumer when the tasks are\r
        spawned. */\r
-       xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
-       xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
+       xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
+       xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
+\r
 \r
-       \r
 \r
        /* Create the second two tasks as described at the top of the file.   This uses\r
        the same mechanism but reverses the task priorities. */\r
 \r
        pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
-       pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
+       pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
        pxQueueParameters3->xBlockTime = xDontBlock;\r
        pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 \r
@@ -194,38 +152,38 @@ const portTickType xDontBlock = ( portTickType ) 0;
        pxQueueParameters4->xBlockTime = xBlockTime;\r
        pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 \r
-       xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
-       xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
+       xTaskCreate( vBlockingQueueConsumer, "QConsB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
+       xTaskCreate( vBlockingQueueProducer, "QProdB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 \r
 \r
 \r
        /* Create the last two tasks as described above.  The mechanism is again just\r
        the same.  This time both parameter structures are given a block time. */\r
        pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
-       pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
+       pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( UBaseType_t ) sizeof( uint16_t ) );\r
        pxQueueParameters5->xBlockTime = xBlockTime;\r
        pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 \r
        pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
        pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
        pxQueueParameters6->xBlockTime = xBlockTime;\r
-       pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
+       pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] );\r
 \r
-       xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
-       xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
+       xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
+       xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 {\r
-unsigned short usValue = 0;\r
+uint16_t usValue = 0;\r
 xBlockingQueueParameters *pxQueueParameters;\r
 short sErrorEverOccurred = pdFALSE;\r
 \r
        pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 \r
        for( ;; )\r
-       {               \r
+       {\r
                if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
                {\r
                        sErrorEverOccurred = pdTRUE;\r
@@ -242,6 +200,10 @@ short sErrorEverOccurred = pdFALSE;
                        /* Increment the variable we are going to post next time round.  The\r
                        consumer will expect the numbers to     follow in numerical order. */\r
                        ++usValue;\r
+\r
+                       #if configUSE_PREEMPTION == 0\r
+                               taskYIELD();\r
+                       #endif\r
                }\r
        }\r
 }\r
@@ -249,14 +211,14 @@ short sErrorEverOccurred = pdFALSE;
 \r
 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 {\r
-unsigned short usData, usExpectedValue = 0;\r
+uint16_t usData, usExpectedValue = 0;\r
 xBlockingQueueParameters *pxQueueParameters;\r
 short sErrorEverOccurred = pdFALSE;\r
 \r
        pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 \r
        for( ;; )\r
-       {       \r
+       {\r
                if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
                {\r
                        if( usData != usExpectedValue )\r
@@ -269,32 +231,41 @@ short sErrorEverOccurred = pdFALSE;
                        else\r
                        {\r
                                /* We have successfully received a message, so increment the\r
-                               variable used to check we are still running. */ \r
+                               variable used to check we are still running. */\r
                                if( sErrorEverOccurred == pdFALSE )\r
                                {\r
                                        ( *pxQueueParameters->psCheckVariable )++;\r
                                }\r
-                                                       \r
+\r
                                /* Increment the value we expect to remove from the queue next time\r
                                round. */\r
                                ++usExpectedValue;\r
-                       }                       \r
-               }               \r
+                       }\r
+\r
+                       #if configUSE_PREEMPTION == 0\r
+                       {\r
+                               if( pxQueueParameters->xBlockTime == 0 )\r
+                               {\r
+                                       taskYIELD();\r
+                               }\r
+                       }\r
+                       #endif\r
+               }\r
        }\r
 }\r
 /*-----------------------------------------------------------*/\r
 \r
 /* This is called to check that all the created tasks are still running. */\r
-portBASE_TYPE xAreBlockingQueuesStillRunning( void )\r
+BaseType_t xAreBlockingQueuesStillRunning( void )\r
 {\r
-static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
-static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
-portBASE_TYPE xReturn = pdPASS, xTasks;\r
+static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
+static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
+BaseType_t xReturn = pdPASS, xTasks;\r
 \r
        /* Not too worried about mutual exclusion on these variables as they are 16\r
        bits and we are only reading them. We also only care to see if they have\r
        changed or not.\r
-       \r
+\r
        Loop through each check variable to and return pdFALSE if any are found not\r
        to have changed since the last call. */\r
 \r