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

   1 /*\r
   2         FreeRTOS.org V5.3.0 - 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  */\r
  75 \r
  76 /*\r
  77 \r
  78 Changes from V4.1.1\r
  79 \r
  80         + The second set of tasks were created the wrong way around.  This has been\r
  81           corrected.\r
  82 */\r
  83 \r
  84 \r
  85 #include <stdlib.h>\r
  86 \r
  87 /* Scheduler include files. */\r
  88 #include "FreeRTOS.h"\r
  89 #include "task.h"\r
  90 #include "queue.h"\r
  91 \r
  92 /* Demo program include files. */\r
  93 #include "BlockQ.h"\r
  94 \r
  95 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
  96 #define blckqNUM_TASK_SETS      ( 3 )\r
  97 \r
  98 /* Structure used to pass parameters to the blocking queue tasks. */\r
  99 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 100 {\r
 101         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
 102         portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
 103         volatile portSHORT *psCheckVariable;    /*< Incremented on each successful cycle to check the task is still running. */\r
 104 } xBlockingQueueParameters;\r
 105 \r
 106 /* Task function that creates an incrementing number and posts it on a queue. */\r
 107 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 108 \r
 109 /* Task function that removes the incrementing number from a queue and checks that\r
 110 it is the expected number. */\r
 111 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 112 \r
 113 /* Variables which are incremented each time an item is removed from a queue, and\r
 114 found to be the expected value.\r
 115 These are used to check that the tasks are still running. */\r
 116 static volatile portSHORT sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 117 \r
 118 /* Variable which are incremented each time an item is posted on a queue.   These\r
 119 are used to check that the tasks are still running. */\r
 120 static volatile portSHORT sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 121 \r
 122 /*-----------------------------------------------------------*/\r
 123 \r
 124 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 125 {\r
 126 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 127 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 128 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 129 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 130 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 131 const portTickType xDontBlock = ( portTickType ) 0;\r
 132 \r
 133         /* Create the first two tasks as described at the top of the file. */\r
 134         \r
 135         /* First create the structure used to pass parameters to the consumer tasks. */\r
 136         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 137 \r
 138         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 139         Pass a pointer to the queue in the parameter structure. */\r
 140         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 141 \r
 142         /* The consumer is created first so gets a block time as described above. */\r
 143         pxQueueParameters1->xBlockTime = xBlockTime;\r
 144 \r
 145         /* Pass in the variable that this task is going to increment so we can check it\r
 146         is still running. */\r
 147         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 148                 \r
 149         /* Create the structure used to pass parameters to the producer task. */\r
 150         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 151 \r
 152         /* Pass the queue to this task also, using the parameter structure. */\r
 153         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 154 \r
 155         /* The producer is not going to block - as soon as it posts the consumer will\r
 156         wake and remove the item so the producer should always have room to post. */\r
 157         pxQueueParameters2->xBlockTime = xDontBlock;\r
 158 \r
 159         /* Pass in the variable that this task is going to increment so we can check\r
 160         it is still running. */\r
 161         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 162 \r
 163 \r
 164         /* Note the producer has a lower priority than the consumer when the tasks are\r
 165         spawned. */\r
 166         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 167         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 168 \r
 169         \r
 170 \r
 171         /* Create the second two tasks as described at the top of the file.   This uses\r
 172         the same mechanism but reverses the task priorities. */\r
 173 \r
 174         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 175         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 176         pxQueueParameters3->xBlockTime = xDontBlock;\r
 177         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 178 \r
 179         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 180         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 181         pxQueueParameters4->xBlockTime = xBlockTime;\r
 182         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 183 \r
 184         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 185         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 186 \r
 187 \r
 188 \r
 189         /* Create the last two tasks as described above.  The mechanism is again just\r
 190         the same.  This time both parameter structures are given a block time. */\r
 191         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 192         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 193         pxQueueParameters5->xBlockTime = xBlockTime;\r
 194         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 195 \r
 196         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 197         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 198         pxQueueParameters6->xBlockTime = xBlockTime;\r
 199         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 200 \r
 201         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 202         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 207 {\r
 208 unsigned portSHORT usValue = 0;\r
 209 xBlockingQueueParameters *pxQueueParameters;\r
 210 portSHORT sErrorEverOccurred = pdFALSE;\r
 211 \r
 212         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 213 \r
 214         for( ;; )\r
 215         {               \r
 216                 if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 217                 {\r
 218                         sErrorEverOccurred = pdTRUE;\r
 219                 }\r
 220                 else\r
 221                 {\r
 222                         /* We have successfully posted a message, so increment the variable\r
 223                         used to check we are still running. */\r
 224                         if( sErrorEverOccurred == pdFALSE )\r
 225                         {\r
 226                                 ( *pxQueueParameters->psCheckVariable )++;\r
 227                         }\r
 228 \r
 229                         /* Increment the variable we are going to post next time round.  The\r
 230                         consumer will expect the numbers to     follow in numerical order. */\r
 231                         ++usValue;\r
 232                 }\r
 233         }\r
 234 }\r
 235 /*-----------------------------------------------------------*/\r
 236 \r
 237 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 238 {\r
 239 unsigned portSHORT usData, usExpectedValue = 0;\r
 240 xBlockingQueueParameters *pxQueueParameters;\r
 241 portSHORT sErrorEverOccurred = pdFALSE;\r
 242 \r
 243         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 244 \r
 245         for( ;; )\r
 246         {       \r
 247                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 248                 {\r
 249                         if( usData != usExpectedValue )\r
 250                         {\r
 251                                 /* Catch-up. */\r
 252                                 usExpectedValue = usData;\r
 253 \r
 254                                 sErrorEverOccurred = pdTRUE;\r
 255                         }\r
 256                         else\r
 257                         {\r
 258                                 /* We have successfully received a message, so increment the\r
 259                                 variable 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 value we expect to remove from the queue next time\r
 266                                 round. */\r
 267                                 ++usExpectedValue;\r
 268                         }                       \r
 269                 }               \r
 270         }\r
 271 }\r
 272 /*-----------------------------------------------------------*/\r
 273 \r
 274 /* This is called to check that all the created tasks are still running. */\r
 275 portBASE_TYPE xAreBlockingQueuesStillRunning( void )\r
 276 {\r
 277 static portSHORT sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 278 static portSHORT sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 279 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 280 \r
 281         /* Not too worried about mutual exclusion on these variables as they are 16\r
 282         bits and we are only reading them. We also only care to see if they have\r
 283         changed or not.\r
 284         \r
 285         Loop through each check variable to and return pdFALSE if any are found not\r
 286         to have changed since the last call. */\r
 287 \r
 288         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 289         {\r
 290                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 291                 {\r
 292                         xReturn = pdFALSE;\r
 293                 }\r
 294                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 295 \r
 296 \r
 297                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 298                 {\r
 299                         xReturn = pdFALSE;\r
 300                 }\r
 301                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 302         }\r
 303 \r
 304         return xReturn;\r
 305 }\r
 306 \r