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

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