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

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /**\r
  68  * Creates six tasks that operate on three queues as follows:\r
  69  *\r
  70  * The first two tasks send and receive an incrementing number to/from a queue.  \r
  71  * One task acts as a producer and the other as the consumer.  The consumer is a \r
  72  * higher priority than the producer and is set to block on queue reads.  The queue \r
  73  * only has space for one item - as soon as the producer posts a message on the \r
  74  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  75  * \r
  76  * The second two tasks work the other way around.  Again the queue used only has\r
  77  * enough space for one item.  This time the consumer has a lower priority than the \r
  78  * producer.  The producer will try to post on the queue blocking when the queue is \r
  79  * full.  When the consumer wakes it will remove the item from the queue, causing \r
  80  * the producer to unblock, pre-empt the consumer, and immediately re-fill the \r
  81  * queue.\r
  82  * \r
  83  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  84  * enough space for lots of items and the tasks operate at the same priority.  The \r
  85  * producer will execute, placing items into the queue.  The consumer will start \r
  86  * executing when either the queue becomes full (causing the producer to block) or \r
  87  * a context switch occurs (tasks of the same priority will time slice).\r
  88  *\r
  89  * \page BlockQC blockQ.c\r
  90  * \ingroup DemoFiles\r
  91  * <HR>\r
  92  */\r
  93 \r
  94 /*\r
  95 Changes from V1.00:\r
  96         \r
  97         + Reversed the priority and block times of the second two demo tasks so\r
  98           they operate as per the description above.\r
  99 \r
 100 Changes from V2.0.0\r
 101 \r
 102         + Delay periods are now specified using variables and constants of\r
 103           portTickType rather than unsigned long.\r
 104 \r
 105 Changes from V4.0.2\r
 106 \r
 107         + The second set of tasks were created the wrong way around.  This has been\r
 108           corrected.\r
 109 */\r
 110 \r
 111 \r
 112 #include <stdlib.h>\r
 113 \r
 114 /* Scheduler include files. */\r
 115 #include "FreeRTOS.h"\r
 116 #include "task.h"\r
 117 #include "queue.h"\r
 118 \r
 119 /* Demo program include files. */\r
 120 #include "BlockQ.h"\r
 121 #include "print.h"\r
 122 \r
 123 #define blckqSTACK_SIZE         ( ( unsigned short ) configMINIMAL_STACK_SIZE )\r
 124 #define blckqNUM_TASK_SETS      ( 3 )\r
 125 \r
 126 /* Structure used to pass parameters to the blocking queue tasks. */\r
 127 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 128 {\r
 129         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
 130         portTickType xBlockTime;                        /*< The block time to use on queue reads/writes. */\r
 131         volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
 132 } xBlockingQueueParameters;\r
 133 \r
 134 /* Task function that creates an incrementing number and posts it on a queue. */\r
 135 static void vBlockingQueueProducer( void *pvParameters );\r
 136 \r
 137 /* Task function that removes the incrementing number from a queue and checks that \r
 138 it is the expected number. */\r
 139 static void vBlockingQueueConsumer( void *pvParameters );\r
 140 \r
 141 /* Variables which are incremented each time an item is removed from a queue, and \r
 142 found to be the expected value. \r
 143 These are used to check that the tasks are still running. */\r
 144 static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 145 \r
 146 /* Variable which are incremented each time an item is posted on a queue.   These \r
 147 are used to check that the tasks are still running. */\r
 148 static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 149 \r
 150 /*-----------------------------------------------------------*/\r
 151 \r
 152 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 153 {\r
 154 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 155 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 156 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 157 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 158 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 159 const portTickType xDontBlock = ( portTickType ) 0;\r
 160 \r
 161         /* Create the first two tasks as described at the top of the file. */ \r
 162         \r
 163         /* First create the structure used to pass parameters to the consumer tasks. */\r
 164         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 165 \r
 166         /* Create the queue used by the first two tasks to pass the incrementing number.  \r
 167         Pass a pointer to the queue in the parameter structure. */\r
 168         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 169 \r
 170         /* The consumer is created first so gets a block time as described above. */\r
 171         pxQueueParameters1->xBlockTime = xBlockTime;\r
 172 \r
 173         /* Pass in the variable that this task is going to increment so we can check it \r
 174         is still running. */\r
 175         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 176                 \r
 177         /* Create the structure used to pass parameters to the producer task. */\r
 178         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 179 \r
 180         /* Pass the queue to this task also, using the parameter structure. */\r
 181         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 182 \r
 183         /* The producer is not going to block - as soon as it posts the consumer will \r
 184         wake and remove the item so the producer should always have room to post. */\r
 185         pxQueueParameters2->xBlockTime = xDontBlock;\r
 186 \r
 187         /* Pass in the variable that this task is going to increment so we can check \r
 188         it is still running. */\r
 189         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 190 \r
 191 \r
 192         /* Note the producer has a lower priority than the consumer when the tasks are \r
 193         spawned. */\r
 194         xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 195         xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 196 \r
 197         \r
 198 \r
 199         /* Create the second two tasks as described at the top of the file.   This uses \r
 200         the same mechanism but reverses the task priorities. */\r
 201 \r
 202         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 203         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 204         pxQueueParameters3->xBlockTime = xDontBlock;\r
 205         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 206 \r
 207         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 208         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 209         pxQueueParameters4->xBlockTime = xBlockTime;\r
 210         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 211 \r
 212         xTaskCreate( vBlockingQueueProducer, "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 213         xTaskCreate( vBlockingQueueConsumer, "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 214 \r
 215 \r
 216 \r
 217         /* Create the last two tasks as described above.  The mechanism is again just \r
 218         the same.  This time both parameter structures are given a block time. */\r
 219         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 220         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 221         pxQueueParameters5->xBlockTime = xBlockTime;\r
 222         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 223 \r
 224         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 225         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 226         pxQueueParameters6->xBlockTime = xBlockTime;\r
 227         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 228 \r
 229         xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 230         xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 231 }\r
 232 /*-----------------------------------------------------------*/\r
 233 \r
 234 static void vBlockingQueueProducer( void *pvParameters )\r
 235 {\r
 236 unsigned short usValue = 0;\r
 237 xBlockingQueueParameters *pxQueueParameters;\r
 238 const char * const pcTaskStartMsg = "Blocking queue producer started.\r\n";\r
 239 const char * const pcTaskErrorMsg = "Could not post on blocking queue\r\n";\r
 240 short sErrorEverOccurred = pdFALSE;\r
 241 \r
 242         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 243 \r
 244         /* Queue a message for printing to say the task has started. */\r
 245         vPrintDisplayMessage( &pcTaskStartMsg );\r
 246 \r
 247         for( ;; )\r
 248         {               \r
 249                 if( xQueueSendToBack( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 250                 {\r
 251                         vPrintDisplayMessage( &pcTaskErrorMsg );\r
 252                         sErrorEverOccurred = pdTRUE;\r
 253                 }\r
 254                 else\r
 255                 {\r
 256                         /* We have successfully posted a message, so increment the variable \r
 257                         used to check we are still running. */\r
 258                         if( sErrorEverOccurred == pdFALSE )\r
 259                         {\r
 260                                 ( *pxQueueParameters->psCheckVariable )++;\r
 261                         }\r
 262 \r
 263                         /* Increment the variable we are going to post next time round.  The \r
 264                         consumer will expect the numbers to     follow in numerical order. */\r
 265                         ++usValue;\r
 266                 }\r
 267         }\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 static void vBlockingQueueConsumer( void *pvParameters )\r
 272 {\r
 273 unsigned short usData, usExpectedValue = 0;\r
 274 xBlockingQueueParameters *pxQueueParameters;\r
 275 const char * const pcTaskStartMsg = "Blocking queue consumer started.\r\n";\r
 276 const char * const pcTaskErrorMsg = "Incorrect value received on blocking queue.\r\n";\r
 277 short sErrorEverOccurred = pdFALSE;\r
 278 \r
 279         /* Queue a message for printing to say the task has started. */\r
 280         vPrintDisplayMessage( &pcTaskStartMsg );\r
 281 \r
 282         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 283 \r
 284         for( ;; )\r
 285         {       \r
 286                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 287                 {\r
 288                         if( usData != usExpectedValue )\r
 289                         {\r
 290                                 vPrintDisplayMessage( &pcTaskErrorMsg );\r
 291 \r
 292                                 /* Catch-up. */\r
 293                                 usExpectedValue = usData;\r
 294 \r
 295                                 sErrorEverOccurred = pdTRUE;\r
 296                         }\r
 297                         else\r
 298                         {\r
 299                                 /* We have successfully received a message, so increment the \r
 300                                 variable used to check we are still running. */ \r
 301                                 if( sErrorEverOccurred == pdFALSE )\r
 302                                 {\r
 303                                         ( *pxQueueParameters->psCheckVariable )++;\r
 304                                 }\r
 305                                                         \r
 306                                 /* Increment the value we expect to remove from the queue next time \r
 307                                 round. */\r
 308                                 ++usExpectedValue;\r
 309                         }                       \r
 310                 }               \r
 311         }\r
 312 }\r
 313 /*-----------------------------------------------------------*/\r
 314 \r
 315 /* This is called to check that all the created tasks are still running. */\r
 316 portBASE_TYPE xAreBlockingQueuesStillRunning( void )\r
 317 {\r
 318 static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 319 static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 320 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 321 \r
 322         /* Not too worried about mutual exclusion on these variables as they are 16 \r
 323         bits and we are only reading them. We also only care to see if they have \r
 324         changed or not.\r
 325         \r
 326         Loop through each check variable and return pdFALSE if any are found not \r
 327         to have changed since the last call. */\r
 328 \r
 329         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 330         {\r
 331                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 332                 {\r
 333                         xReturn = pdFALSE;\r
 334                 }\r
 335                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 336 \r
 337 \r
 338                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 339                 {\r
 340                         xReturn = pdFALSE;\r
 341                 }\r
 342                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 343         }\r
 344 \r
 345         return xReturn;\r
 346 }\r
 347 \r