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

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