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

   1 /*\r
   2     FreeRTOS V7.4.2 - 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  * This is a version of BlockQ.c that uses the alternative (Alt) API.\r
  77  *\r
  78  * Creates six tasks that operate on three queues as follows:\r
  79  *\r
  80  * The first two tasks send and receive an incrementing number to/from a queue.\r
  81  * One task acts as a producer and the other as the consumer.  The consumer is a\r
  82  * higher priority than the producer and is set to block on queue reads.  The queue\r
  83  * only has space for one item - as soon as the producer posts a message on the\r
  84  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  85  *\r
  86  * The second two tasks work the other way around.  Again the queue used only has\r
  87  * enough space for one item.  This time the consumer has a lower priority than the\r
  88  * producer.  The producer will try to post on the queue blocking when the queue is\r
  89  * full.  When the consumer wakes it will remove the item from the queue, causing\r
  90  * the producer to unblock, pre-empt the consumer, and immediately re-fill the\r
  91  * queue.\r
  92  *\r
  93  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  94  * enough space for lots of items and the tasks operate at the same priority.  The\r
  95  * producer will execute, placing items into the queue.  The consumer will start\r
  96  * executing when either the queue becomes full (causing the producer to block) or\r
  97  * a context switch occurs (tasks of the same priority will time slice).\r
  98  *\r
  99  */\r
 100 \r
 101 \r
 102 #include <stdlib.h>\r
 103 \r
 104 /* Scheduler include files. */\r
 105 #include "FreeRTOS.h"\r
 106 #include "task.h"\r
 107 #include "queue.h"\r
 108 \r
 109 /* Demo program include files. */\r
 110 #include "AltBlckQ.h"\r
 111 \r
 112 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
 113 #define blckqNUM_TASK_SETS      ( 3 )\r
 114 \r
 115 /* Structure used to pass parameters to the blocking queue tasks. */\r
 116 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 117 {\r
 118         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
 119         portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
 120         volatile portSHORT *psCheckVariable;    /*< Incremented on each successful cycle to check the task is still running. */\r
 121 } xBlockingQueueParameters;\r
 122 \r
 123 /* Task function that creates an incrementing number and posts it on a queue. */\r
 124 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 125 \r
 126 /* Task function that removes the incrementing number from a queue and checks that\r
 127 it is the expected number. */\r
 128 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 129 \r
 130 /* Variables which are incremented each time an item is removed from a queue, and\r
 131 found to be the expected value.\r
 132 These are used to check that the tasks are still running. */\r
 133 static volatile portSHORT sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 134 \r
 135 /* Variable which are incremented each time an item is posted on a queue.   These\r
 136 are used to check that the tasks are still running. */\r
 137 static volatile portSHORT sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 void vStartAltBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 142 {\r
 143 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 144 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 145 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 146 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 147 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 148 const portTickType xDontBlock = ( portTickType ) 0;\r
 149 \r
 150         /* Create the first two tasks as described at the top of the file. */\r
 151         \r
 152         /* First create the structure used to pass parameters to the consumer tasks. */\r
 153         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 154 \r
 155         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 156         Pass a pointer to the queue in the parameter structure. */\r
 157         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 158 \r
 159         /* The consumer is created first so gets a block time as described above. */\r
 160         pxQueueParameters1->xBlockTime = xBlockTime;\r
 161 \r
 162         /* Pass in the variable that this task is going to increment so we can check it\r
 163         is still running. */\r
 164         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 165                 \r
 166         /* Create the structure used to pass parameters to the producer task. */\r
 167         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 168 \r
 169         /* Pass the queue to this task also, using the parameter structure. */\r
 170         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 171 \r
 172         /* The producer is not going to block - as soon as it posts the consumer will\r
 173         wake and remove the item so the producer should always have room to post. */\r
 174         pxQueueParameters2->xBlockTime = xDontBlock;\r
 175 \r
 176         /* Pass in the variable that this task is going to increment so we can check\r
 177         it is still running. */\r
 178         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 179 \r
 180 \r
 181         /* Note the producer has a lower priority than the consumer when the tasks are\r
 182         spawned. */\r
 183         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 184         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 185 \r
 186         \r
 187 \r
 188         /* Create the second two tasks as described at the top of the file.   This uses\r
 189         the same mechanism but reverses the task priorities. */\r
 190 \r
 191         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 192         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 193         pxQueueParameters3->xBlockTime = xDontBlock;\r
 194         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 195 \r
 196         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 197         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 198         pxQueueParameters4->xBlockTime = xBlockTime;\r
 199         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 200 \r
 201         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 202         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 203 \r
 204 \r
 205 \r
 206         /* Create the last two tasks as described above.  The mechanism is again just\r
 207         the same.  This time both parameter structures are given a block time. */\r
 208         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 209         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 210         pxQueueParameters5->xBlockTime = xBlockTime;\r
 211         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 212 \r
 213         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 214         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 215         pxQueueParameters6->xBlockTime = xBlockTime;\r
 216         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 217 \r
 218         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 219         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 220 }\r
 221 /*-----------------------------------------------------------*/\r
 222 \r
 223 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 224 {\r
 225 unsigned portSHORT usValue = 0;\r
 226 xBlockingQueueParameters *pxQueueParameters;\r
 227 portSHORT sErrorEverOccurred = pdFALSE;\r
 228 \r
 229         #ifdef USE_STDIO\r
 230         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 231         \r
 232                 const portCHAR * const pcTaskStartMsg = "Alt blocking queue producer task started.\r\n";\r
 233 \r
 234                 /* Queue a message for printing to say the task has started. */\r
 235                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 236         #endif\r
 237 \r
 238         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 239 \r
 240         for( ;; )\r
 241         {               \r
 242                 if( xQueueAltSendToBack( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 243                 {\r
 244                         sErrorEverOccurred = pdTRUE;\r
 245                 }\r
 246                 else\r
 247                 {\r
 248                         /* We have successfully posted a message, so increment the variable\r
 249                         used to check we are still running. */\r
 250                         if( sErrorEverOccurred == pdFALSE )\r
 251                         {\r
 252                                 ( *pxQueueParameters->psCheckVariable )++;\r
 253                         }\r
 254 \r
 255                         /* Increment the variable we are going to post next time round.  The\r
 256                         consumer will expect the numbers to     follow in numerical order. */\r
 257                         ++usValue;\r
 258                 }\r
 259         }\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 264 {\r
 265 unsigned portSHORT usData, usExpectedValue = 0;\r
 266 xBlockingQueueParameters *pxQueueParameters;\r
 267 portSHORT sErrorEverOccurred = pdFALSE;\r
 268 \r
 269         #ifdef USE_STDIO\r
 270         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 271         \r
 272                 const portCHAR * const pcTaskStartMsg = "Alt blocking queue consumer task started.\r\n";\r
 273 \r
 274                 /* Queue a message for printing to say the task has started. */\r
 275                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 276         #endif\r
 277 \r
 278         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 279 \r
 280         for( ;; )\r
 281         {       \r
 282                 if( xQueueAltReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 283                 {\r
 284                         if( usData != usExpectedValue )\r
 285                         {\r
 286                                 /* Catch-up. */\r
 287                                 usExpectedValue = usData;\r
 288 \r
 289                                 sErrorEverOccurred = pdTRUE;\r
 290                         }\r
 291                         else\r
 292                         {\r
 293                                 /* We have successfully received a message, so increment the\r
 294                                 variable used to check we are still running. */ \r
 295                                 if( sErrorEverOccurred == pdFALSE )\r
 296                                 {\r
 297                                         ( *pxQueueParameters->psCheckVariable )++;\r
 298                                 }\r
 299                                                         \r
 300                                 /* Increment the value we expect to remove from the queue next time\r
 301                                 round. */\r
 302                                 ++usExpectedValue;\r
 303                         }                       \r
 304                 }               \r
 305         }\r
 306 }\r
 307 /*-----------------------------------------------------------*/\r
 308 \r
 309 /* This is called to check that all the created tasks are still running. */\r
 310 portBASE_TYPE xAreAltBlockingQueuesStillRunning( void )\r
 311 {\r
 312 static portSHORT sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 313 static portSHORT sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 314 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 315 \r
 316         /* Not too worried about mutual exclusion on these variables as they are 16\r
 317         bits and we are only reading them. We also only care to see if they have\r
 318         changed or not.\r
 319         \r
 320         Loop through each check variable to and return pdFALSE if any are found not\r
 321         to have changed since the last call. */\r
 322 \r
 323         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 324         {\r
 325                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 326                 {\r
 327                         xReturn = pdFALSE;\r
 328                 }\r
 329                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 330 \r
 331 \r
 332                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 333                 {\r
 334                         xReturn = pdFALSE;\r
 335                 }\r
 336                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 337         }\r
 338 \r
 339         return xReturn;\r
 340 }\r
 341 \r