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

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