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

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