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

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