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

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