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

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