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

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