git.sur5r.net Git - freertos/blob - Demo/Common/Minimal/BlockQ.c

   1 /*\r
   2         FreeRTOS V5.4.2 - Copyright (C) 2009 Real Time Engineers Ltd.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify it     under \r
   7         the terms of the GNU General Public License (version 2) as published by the \r
   8         Free Software Foundation and modified by the FreeRTOS exception.\r
   9         **NOTE** The exception to the GPL is included to allow you to distribute a\r
  10         combined work that includes FreeRTOS without being obliged to provide the \r
  11         source code for proprietary components outside of the FreeRTOS kernel.  \r
  12         Alternative commercial license and support terms are also available upon \r
  13         request.  See the licensing section of http://www.FreeRTOS.org for full \r
  14         license details.\r
  15 \r
  16         FreeRTOS is distributed in the hope that it will be useful,     but WITHOUT\r
  17         ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  18         FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  19         more details.\r
  20 \r
  21         You should have received a copy of the GNU General Public License along\r
  22         with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59\r
  23         Temple Place, Suite 330, Boston, MA  02111-1307  USA.\r
  24 \r
  25 \r
  26         ***************************************************************************\r
  27         *                                                                         *\r
  28         * Looking for a quick start?  Then check out the FreeRTOS eBook!          *\r
  29         * See http://www.FreeRTOS.org/Documentation for details                   *\r
  30         *                                                                         *\r
  31         ***************************************************************************\r
  32 \r
  33         1 tab == 4 spaces!\r
  34 \r
  35         Please ensure to read the configuration and relevant port sections of the\r
  36         online documentation.\r
  37 \r
  38         http://www.FreeRTOS.org - Documentation, latest information, license and\r
  39         contact details.\r
  40 \r
  41         http://www.SafeRTOS.com - A version that is certified for use in safety\r
  42         critical systems.\r
  43 \r
  44         http://www.OpenRTOS.com - Commercial support, development, porting,\r
  45         licensing and training services.\r
  46 */\r
  47 \r
  48 /*\r
  49  * Creates six tasks that operate on three queues as follows:\r
  50  *\r
  51  * The first two tasks send and receive an incrementing number to/from a queue.\r
  52  * One task acts as a producer and the other as the consumer.  The consumer is a\r
  53  * higher priority than the producer and is set to block on queue reads.  The queue\r
  54  * only has space for one item - as soon as the producer posts a message on the\r
  55  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  56  *\r
  57  * The second two tasks work the other way around.  Again the queue used only has\r
  58  * enough space for one item.  This time the consumer has a lower priority than the\r
  59  * producer.  The producer will try to post on the queue blocking when the queue is\r
  60  * full.  When the consumer wakes it will remove the item from the queue, causing\r
  61  * the producer to unblock, pre-empt the consumer, and immediately re-fill the\r
  62  * queue.\r
  63  *\r
  64  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  65  * enough space for lots of items and the tasks operate at the same priority.  The\r
  66  * producer will execute, placing items into the queue.  The consumer will start\r
  67  * executing when either the queue becomes full (causing the producer to block) or\r
  68  * a context switch occurs (tasks of the same priority will time slice).\r
  69  *\r
  70  */\r
  71 \r
  72 /*\r
  73 \r
  74 Changes from V4.1.1\r
  75 \r
  76         + The second set of tasks were created the wrong way around.  This has been\r
  77           corrected.\r
  78 */\r
  79 \r
  80 \r
  81 #include <stdlib.h>\r
  82 \r
  83 /* Scheduler include files. */\r
  84 #include "FreeRTOS.h"\r
  85 #include "task.h"\r
  86 #include "queue.h"\r
  87 \r
  88 /* Demo program include files. */\r
  89 #include "BlockQ.h"\r
  90 \r
  91 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
  92 #define blckqNUM_TASK_SETS      ( 3 )\r
  93 \r
  94 /* Structure used to pass parameters to the blocking queue tasks. */\r
  95 typedef struct BLOCKING_QUEUE_PARAMETERS\r
  96 {\r
  97         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
  98         portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
  99         volatile portSHORT *psCheckVariable;    /*< Incremented on each successful cycle to check the task is still running. */\r
 100 } xBlockingQueueParameters;\r
 101 \r
 102 /* Task function that creates an incrementing number and posts it on a queue. */\r
 103 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 104 \r
 105 /* Task function that removes the incrementing number from a queue and checks that\r
 106 it is the expected number. */\r
 107 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 108 \r
 109 /* Variables which are incremented each time an item is removed from a queue, and\r
 110 found to be the expected value.\r
 111 These are used to check that the tasks are still running. */\r
 112 static volatile portSHORT sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 113 \r
 114 /* Variable which are incremented each time an item is posted on a queue.   These\r
 115 are used to check that the tasks are still running. */\r
 116 static volatile portSHORT sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 117 \r
 118 /*-----------------------------------------------------------*/\r
 119 \r
 120 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 121 {\r
 122 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 123 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 124 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 125 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 126 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 127 const portTickType xDontBlock = ( portTickType ) 0;\r
 128 \r
 129         /* Create the first two tasks as described at the top of the file. */\r
 130         \r
 131         /* First create the structure used to pass parameters to the consumer tasks. */\r
 132         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 133 \r
 134         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 135         Pass a pointer to the queue in the parameter structure. */\r
 136         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 137 \r
 138         /* The consumer is created first so gets a block time as described above. */\r
 139         pxQueueParameters1->xBlockTime = xBlockTime;\r
 140 \r
 141         /* Pass in the variable that this task is going to increment so we can check it\r
 142         is still running. */\r
 143         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 144                 \r
 145         /* Create the structure used to pass parameters to the producer task. */\r
 146         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 147 \r
 148         /* Pass the queue to this task also, using the parameter structure. */\r
 149         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 150 \r
 151         /* The producer is not going to block - as soon as it posts the consumer will\r
 152         wake and remove the item so the producer should always have room to post. */\r
 153         pxQueueParameters2->xBlockTime = xDontBlock;\r
 154 \r
 155         /* Pass in the variable that this task is going to increment so we can check\r
 156         it is still running. */\r
 157         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 158 \r
 159 \r
 160         /* Note the producer has a lower priority than the consumer when the tasks are\r
 161         spawned. */\r
 162         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 163         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 164 \r
 165         \r
 166 \r
 167         /* Create the second two tasks as described at the top of the file.   This uses\r
 168         the same mechanism but reverses the task priorities. */\r
 169 \r
 170         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 171         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 172         pxQueueParameters3->xBlockTime = xDontBlock;\r
 173         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 174 \r
 175         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 176         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 177         pxQueueParameters4->xBlockTime = xBlockTime;\r
 178         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 179 \r
 180         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 181         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 182 \r
 183 \r
 184 \r
 185         /* Create the last two tasks as described above.  The mechanism is again just\r
 186         the same.  This time both parameter structures are given a block time. */\r
 187         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 188         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 189         pxQueueParameters5->xBlockTime = xBlockTime;\r
 190         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 191 \r
 192         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 193         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 194         pxQueueParameters6->xBlockTime = xBlockTime;\r
 195         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 196 \r
 197         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 198         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 199 }\r
 200 /*-----------------------------------------------------------*/\r
 201 \r
 202 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 203 {\r
 204 unsigned portSHORT usValue = 0;\r
 205 xBlockingQueueParameters *pxQueueParameters;\r
 206 portSHORT sErrorEverOccurred = pdFALSE;\r
 207 \r
 208         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 209 \r
 210         for( ;; )\r
 211         {               \r
 212                 if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 213                 {\r
 214                         sErrorEverOccurred = pdTRUE;\r
 215                 }\r
 216                 else\r
 217                 {\r
 218                         /* We have successfully posted a message, so increment the variable\r
 219                         used to check we are still running. */\r
 220                         if( sErrorEverOccurred == pdFALSE )\r
 221                         {\r
 222                                 ( *pxQueueParameters->psCheckVariable )++;\r
 223                         }\r
 224 \r
 225                         /* Increment the variable we are going to post next time round.  The\r
 226                         consumer will expect the numbers to     follow in numerical order. */\r
 227                         ++usValue;\r
 228                 }\r
 229         }\r
 230 }\r
 231 /*-----------------------------------------------------------*/\r
 232 \r
 233 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 234 {\r
 235 unsigned portSHORT usData, usExpectedValue = 0;\r
 236 xBlockingQueueParameters *pxQueueParameters;\r
 237 portSHORT sErrorEverOccurred = pdFALSE;\r
 238 \r
 239         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 240 \r
 241         for( ;; )\r
 242         {       \r
 243                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 244                 {\r
 245                         if( usData != usExpectedValue )\r
 246                         {\r
 247                                 /* Catch-up. */\r
 248                                 usExpectedValue = usData;\r
 249 \r
 250                                 sErrorEverOccurred = pdTRUE;\r
 251                         }\r
 252                         else\r
 253                         {\r
 254                                 /* We have successfully received a message, so increment the\r
 255                                 variable used to check we are still running. */ \r
 256                                 if( sErrorEverOccurred == pdFALSE )\r
 257                                 {\r
 258                                         ( *pxQueueParameters->psCheckVariable )++;\r
 259                                 }\r
 260                                                         \r
 261                                 /* Increment the value we expect to remove from the queue next time\r
 262                                 round. */\r
 263                                 ++usExpectedValue;\r
 264                         }                       \r
 265                 }               \r
 266         }\r
 267 }\r
 268 /*-----------------------------------------------------------*/\r
 269 \r
 270 /* This is called to check that all the created tasks are still running. */\r
 271 portBASE_TYPE xAreBlockingQueuesStillRunning( void )\r
 272 {\r
 273 static portSHORT sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 274 static portSHORT sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 275 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 276 \r
 277         /* Not too worried about mutual exclusion on these variables as they are 16\r
 278         bits and we are only reading them. We also only care to see if they have\r
 279         changed or not.\r
 280         \r
 281         Loop through each check variable to and return pdFALSE if any are found not\r
 282         to have changed since the last call. */\r
 283 \r
 284         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 285         {\r
 286                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 287                 {\r
 288                         xReturn = pdFALSE;\r
 289                 }\r
 290                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 291 \r
 292 \r
 293                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 294                 {\r
 295                         xReturn = pdFALSE;\r
 296                 }\r
 297                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 298         }\r
 299 \r
 300         return xReturn;\r
 301 }\r
 302 \r