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

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