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

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