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

   1 /*\r
   2     FreeRTOS V7.5.0 - Copyright (C) 2013 Real Time Engineers Ltd.\r
   3 \r
   4     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   5 \r
   6     ***************************************************************************\r
   7      *                                                                       *\r
   8      *    FreeRTOS provides completely free yet professionally developed,    *\r
   9      *    robust, strictly quality controlled, supported, and cross          *\r
  10      *    platform software that has become a de facto standard.             *\r
  11      *                                                                       *\r
  12      *    Help yourself get started quickly and support the FreeRTOS         *\r
  13      *    project by purchasing a FreeRTOS tutorial book, reference          *\r
  14      *    manual, or both from: http://www.FreeRTOS.org/Documentation        *\r
  15      *                                                                       *\r
  16      *    Thank you!                                                         *\r
  17      *                                                                       *\r
  18     ***************************************************************************\r
  19 \r
  20     This file is part of the FreeRTOS distribution.\r
  21 \r
  22     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  23     the terms of the GNU General Public License (version 2) as published by the\r
  24     Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.\r
  25 \r
  26     >>! NOTE: The modification to the GPL is included to allow you to distribute\r
  27     >>! a combined work that includes FreeRTOS without being obliged to provide\r
  28     >>! the source code for proprietary components outside of the FreeRTOS\r
  29     >>! kernel.\r
  30 \r
  31     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY\r
  32     WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS\r
  33     FOR A PARTICULAR PURPOSE.  Full license text is available from the following\r
  34     link: http://www.freertos.org/a00114.html\r
  35 \r
  36     1 tab == 4 spaces!\r
  37 \r
  38     ***************************************************************************\r
  39      *                                                                       *\r
  40      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  41      *    not run, what could be wrong?"                                     *\r
  42      *                                                                       *\r
  43      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  44      *                                                                       *\r
  45     ***************************************************************************\r
  46 \r
  47     http://www.FreeRTOS.org - Documentation, books, training, latest versions,\r
  48     license and Real Time Engineers Ltd. contact details.\r
  49 \r
  50     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  51     including FreeRTOS+Trace - an indispensable productivity tool, a DOS\r
  52     compatible FAT file system, and our tiny thread aware UDP/IP stack.\r
  53 \r
  54     http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High\r
  55     Integrity Systems to sell under the OpenRTOS brand.  Low cost OpenRTOS\r
  56     licenses offer ticketed support, indemnification and middleware.\r
  57 \r
  58     http://www.SafeRTOS.com - High Integrity Systems also provide a safety\r
  59     engineered and independently SIL3 certified version for use in safety and\r
  60     mission critical applications that require provable dependability.\r
  61 \r
  62     1 tab == 4 spaces!\r
  63 */\r
  64 \r
  65 /*\r
  66  * Creates six tasks that operate on three queues as follows:\r
  67  *\r
  68  * The first two tasks send and receive an incrementing number to/from a queue.\r
  69  * One task acts as a producer and the other as the consumer.  The consumer is a\r
  70  * higher priority than the producer and is set to block on queue reads.  The queue\r
  71  * only has space for one item - as soon as the producer posts a message on the\r
  72  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  73  *\r
  74  * The second two tasks work the other way around.  Again the queue used only has\r
  75  * enough space for one item.  This time the consumer has a lower priority than the\r
  76  * producer.  The producer will try to post on the queue blocking when the queue is\r
  77  * full.  When the consumer wakes it will remove the item from the queue, causing\r
  78  * the producer to unblock, pre-empt the consumer, and immediately re-fill the\r
  79  * queue.\r
  80  *\r
  81  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  82  * enough space for lots of items and the tasks operate at the same priority.  The\r
  83  * producer will execute, placing items into the queue.  The consumer will start\r
  84  * executing when either the queue becomes full (causing the producer to block) or\r
  85  * a context switch occurs (tasks of the same priority will time slice).\r
  86  *\r
  87  */\r
  88 \r
  89 /*\r
  90 \r
  91 Changes from V4.1.1\r
  92 \r
  93         + The second set of tasks were created the wrong way around.  This has been\r
  94           corrected.\r
  95 */\r
  96 \r
  97 \r
  98 #include <stdlib.h>\r
  99 \r
 100 /* Scheduler include files. */\r
 101 #include "FreeRTOS.h"\r
 102 #include "task.h"\r
 103 #include "queue.h"\r
 104 \r
 105 /* Demo program include files. */\r
 106 #include "BlockQ.h"\r
 107 \r
 108 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
 109 #define blckqNUM_TASK_SETS      ( 3 )\r
 110 \r
 111 /* Structure used to pass parameters to the blocking queue tasks. */\r
 112 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 113 {\r
 114         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
 115         portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
 116         volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
 117 } xBlockingQueueParameters;\r
 118 \r
 119 /* Task function that creates an incrementing number and posts it on a queue. */\r
 120 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 121 \r
 122 /* Task function that removes the incrementing number from a queue and checks that\r
 123 it is the expected number. */\r
 124 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 125 \r
 126 /* Variables which are incremented each time an item is removed from a queue, and\r
 127 found to be the expected value.\r
 128 These are used to check that the tasks are still running. */\r
 129 static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
 130 \r
 131 /* Variable which are incremented each time an item is posted on a queue.   These\r
 132 are used to check that the tasks are still running. */\r
 133 static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
 134 \r
 135 /*-----------------------------------------------------------*/\r
 136 \r
 137 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 138 {\r
 139 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 140 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 141 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 142 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 143 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 144 const portTickType xDontBlock = ( portTickType ) 0;\r
 145 \r
 146         /* Create the first two tasks as described at the top of the file. */\r
 147         \r
 148         /* First create the structure used to pass parameters to the consumer tasks. */\r
 149         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 150 \r
 151         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 152         Pass a pointer to the queue in the parameter structure. */\r
 153         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 154 \r
 155         /* The consumer is created first so gets a block time as described above. */\r
 156         pxQueueParameters1->xBlockTime = xBlockTime;\r
 157 \r
 158         /* Pass in the variable that this task is going to increment so we can check it\r
 159         is still running. */\r
 160         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 161                 \r
 162         /* Create the structure used to pass parameters to the producer task. */\r
 163         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 164 \r
 165         /* Pass the queue to this task also, using the parameter structure. */\r
 166         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 167 \r
 168         /* The producer is not going to block - as soon as it posts the consumer will\r
 169         wake and remove the item so the producer should always have room to post. */\r
 170         pxQueueParameters2->xBlockTime = xDontBlock;\r
 171 \r
 172         /* Pass in the variable that this task is going to increment so we can check\r
 173         it is still running. */\r
 174         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 175 \r
 176 \r
 177         /* Note the producer has a lower priority than the consumer when the tasks are\r
 178         spawned. */\r
 179         xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 180         xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 181 \r
 182         \r
 183 \r
 184         /* Create the second two tasks as described at the top of the file.   This uses\r
 185         the same mechanism but reverses the task priorities. */\r
 186 \r
 187         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 188         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 189         pxQueueParameters3->xBlockTime = xDontBlock;\r
 190         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 191 \r
 192         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 193         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 194         pxQueueParameters4->xBlockTime = xBlockTime;\r
 195         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 196 \r
 197         xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 198         xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 199 \r
 200 \r
 201 \r
 202         /* Create the last two tasks as described above.  The mechanism is again just\r
 203         the same.  This time both parameter structures are given a block time. */\r
 204         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 205         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 206         pxQueueParameters5->xBlockTime = xBlockTime;\r
 207         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 208 \r
 209         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 210         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 211         pxQueueParameters6->xBlockTime = xBlockTime;\r
 212         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 213 \r
 214         xTaskCreate( vBlockingQueueProducer, ( signed char * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 215         xTaskCreate( vBlockingQueueConsumer, ( signed char * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 216 }\r
 217 /*-----------------------------------------------------------*/\r
 218 \r
 219 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 220 {\r
 221 unsigned short usValue = 0;\r
 222 xBlockingQueueParameters *pxQueueParameters;\r
 223 short sErrorEverOccurred = pdFALSE;\r
 224 \r
 225         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 226 \r
 227         for( ;; )\r
 228         {               \r
 229                 if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 230                 {\r
 231                         sErrorEverOccurred = pdTRUE;\r
 232                 }\r
 233                 else\r
 234                 {\r
 235                         /* We have successfully posted a message, so increment the variable\r
 236                         used to check we are still running. */\r
 237                         if( sErrorEverOccurred == pdFALSE )\r
 238                         {\r
 239                                 ( *pxQueueParameters->psCheckVariable )++;\r
 240                         }\r
 241 \r
 242                         /* Increment the variable we are going to post next time round.  The\r
 243                         consumer will expect the numbers to     follow in numerical order. */\r
 244                         ++usValue;\r
 245                 }\r
 246         }\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 251 {\r
 252 unsigned short usData, usExpectedValue = 0;\r
 253 xBlockingQueueParameters *pxQueueParameters;\r
 254 short sErrorEverOccurred = pdFALSE;\r
 255 \r
 256         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 257 \r
 258         for( ;; )\r
 259         {       \r
 260                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 261                 {\r
 262                         if( usData != usExpectedValue )\r
 263                         {\r
 264                                 /* Catch-up. */\r
 265                                 usExpectedValue = usData;\r
 266 \r
 267                                 sErrorEverOccurred = pdTRUE;\r
 268                         }\r
 269                         else\r
 270                         {\r
 271                                 /* We have successfully received a message, so increment the\r
 272                                 variable used to check we are still running. */ \r
 273                                 if( sErrorEverOccurred == pdFALSE )\r
 274                                 {\r
 275                                         ( *pxQueueParameters->psCheckVariable )++;\r
 276                                 }\r
 277                                                         \r
 278                                 /* Increment the value we expect to remove from the queue next time\r
 279                                 round. */\r
 280                                 ++usExpectedValue;\r
 281                         }                       \r
 282                 }               \r
 283         }\r
 284 }\r
 285 /*-----------------------------------------------------------*/\r
 286 \r
 287 /* This is called to check that all the created tasks are still running. */\r
 288 portBASE_TYPE xAreBlockingQueuesStillRunning( void )\r
 289 {\r
 290 static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
 291 static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned short ) 0, ( unsigned short ) 0, ( unsigned short ) 0 };\r
 292 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 293 \r
 294         /* Not too worried about mutual exclusion on these variables as they are 16\r
 295         bits and we are only reading them. We also only care to see if they have\r
 296         changed or not.\r
 297         \r
 298         Loop through each check variable to and return pdFALSE if any are found not\r
 299         to have changed since the last call. */\r
 300 \r
 301         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 302         {\r
 303                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 304                 {\r
 305                         xReturn = pdFALSE;\r
 306                 }\r
 307                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 308 \r
 309 \r
 310                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 311                 {\r
 312                         xReturn = pdFALSE;\r
 313                 }\r
 314                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 315         }\r
 316 \r
 317         return xReturn;\r
 318 }\r
 319 \r