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

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