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

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