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

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