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

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