begriffs open source - freertos/blob - Demo/Common/Full/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  * \page BlockQC blockQ.c\r
  72  * \ingroup DemoFiles\r
  73  * <HR>\r
  74  */\r
  75 \r
  76 /*\r
  77 Changes from V1.00:\r
  78         \r
  79         + Reversed the priority and block times of the second two demo tasks so\r
  80           they operate as per the description above.\r
  81 \r
  82 Changes from V2.0.0\r
  83 \r
  84         + Delay periods are now specified using variables and constants of\r
  85           portTickType rather than unsigned long.\r
  86 \r
  87 Changes from V4.0.2\r
  88 \r
  89         + The second set of tasks were created the wrong way around.  This has been\r
  90           corrected.\r
  91 */\r
  92 \r
  93 \r
  94 #include <stdlib.h>\r
  95 \r
  96 /* Scheduler include files. */\r
  97 #include "FreeRTOS.h"\r
  98 #include "task.h"\r
  99 #include "queue.h"\r
 100 \r
 101 /* Demo program include files. */\r
 102 #include "BlockQ.h"\r
 103 #include "print.h"\r
 104 \r
 105 #define blckqSTACK_SIZE         ( ( unsigned short ) configMINIMAL_STACK_SIZE )\r
 106 #define blckqNUM_TASK_SETS      ( 3 )\r
 107 \r
 108 /* Structure used to pass parameters to the blocking queue tasks. */\r
 109 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 110 {\r
 111         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
 112         portTickType xBlockTime;                        /*< The block time to use on queue reads/writes. */\r
 113         volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
 114 } xBlockingQueueParameters;\r
 115 \r
 116 /* Task function that creates an incrementing number and posts it on a queue. */\r
 117 static void vBlockingQueueProducer( void *pvParameters );\r
 118 \r
 119 /* Task function that removes the incrementing number from a queue and checks that \r
 120 it is the expected number. */\r
 121 static void vBlockingQueueConsumer( void *pvParameters );\r
 122 \r
 123 /* Variables which are incremented each time an item is removed from a queue, and \r
 124 found to be the expected value. \r
 125 These are used to check that the tasks are still running. */\r
 126 static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 127 \r
 128 /* Variable which are incremented each time an item is posted on a queue.   These \r
 129 are used to check that the tasks are still running. */\r
 130 static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 131 \r
 132 /*-----------------------------------------------------------*/\r
 133 \r
 134 void vStartBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 135 {\r
 136 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 137 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 138 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 139 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 140 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 141 const portTickType xDontBlock = ( portTickType ) 0;\r
 142 \r
 143         /* Create the first two tasks as described at the top of the file. */ \r
 144         \r
 145         /* First create the structure used to pass parameters to the consumer tasks. */\r
 146         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 147 \r
 148         /* Create the queue used by the first two tasks to pass the incrementing number.  \r
 149         Pass a pointer to the queue in the parameter structure. */\r
 150         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 151 \r
 152         /* The consumer is created first so gets a block time as described above. */\r
 153         pxQueueParameters1->xBlockTime = xBlockTime;\r
 154 \r
 155         /* Pass in the variable that this task is going to increment so we can check it \r
 156         is still running. */\r
 157         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 158                 \r
 159         /* Create the structure used to pass parameters to the producer task. */\r
 160         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 161 \r
 162         /* Pass the queue to this task also, using the parameter structure. */\r
 163         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 164 \r
 165         /* The producer is not going to block - as soon as it posts the consumer will \r
 166         wake and remove the item so the producer should always have room to post. */\r
 167         pxQueueParameters2->xBlockTime = xDontBlock;\r
 168 \r
 169         /* Pass in the variable that this task is going to increment so we can check \r
 170         it is still running. */\r
 171         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 172 \r
 173 \r
 174         /* Note the producer has a lower priority than the consumer when the tasks are \r
 175         spawned. */\r
 176         xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 177         xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 178 \r
 179         \r
 180 \r
 181         /* Create the second two tasks as described at the top of the file.   This uses \r
 182         the same mechanism but reverses the task priorities. */\r
 183 \r
 184         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 185         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 186         pxQueueParameters3->xBlockTime = xDontBlock;\r
 187         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 188 \r
 189         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 190         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 191         pxQueueParameters4->xBlockTime = xBlockTime;\r
 192         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 193 \r
 194         xTaskCreate( vBlockingQueueProducer, "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 195         xTaskCreate( vBlockingQueueConsumer, "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 196 \r
 197 \r
 198 \r
 199         /* Create the last two tasks as described above.  The mechanism is again just \r
 200         the same.  This time both parameter structures are given a block time. */\r
 201         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 202         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned short ) );\r
 203         pxQueueParameters5->xBlockTime = xBlockTime;\r
 204         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 205 \r
 206         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 207         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 208         pxQueueParameters6->xBlockTime = xBlockTime;\r
 209         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 210 \r
 211         xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 212         xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 static void vBlockingQueueProducer( void *pvParameters )\r
 217 {\r
 218 unsigned short usValue = 0;\r
 219 xBlockingQueueParameters *pxQueueParameters;\r
 220 const char * const pcTaskStartMsg = "Blocking queue producer started.\r\n";\r
 221 const char * const pcTaskErrorMsg = "Could not post on blocking queue\r\n";\r
 222 short sErrorEverOccurred = pdFALSE;\r
 223 \r
 224         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 225 \r
 226         /* Queue a message for printing to say the task has started. */\r
 227         vPrintDisplayMessage( &pcTaskStartMsg );\r
 228 \r
 229         for( ;; )\r
 230         {               \r
 231                 if( xQueueSendToBack( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 232                 {\r
 233                         vPrintDisplayMessage( &pcTaskErrorMsg );\r
 234                         sErrorEverOccurred = pdTRUE;\r
 235                 }\r
 236                 else\r
 237                 {\r
 238                         /* We have successfully posted a message, so increment the variable \r
 239                         used to check we are still running. */\r
 240                         if( sErrorEverOccurred == pdFALSE )\r
 241                         {\r
 242                                 ( *pxQueueParameters->psCheckVariable )++;\r
 243                         }\r
 244 \r
 245                         /* Increment the variable we are going to post next time round.  The \r
 246                         consumer will expect the numbers to     follow in numerical order. */\r
 247                         ++usValue;\r
 248                 }\r
 249         }\r
 250 }\r
 251 /*-----------------------------------------------------------*/\r
 252 \r
 253 static void vBlockingQueueConsumer( void *pvParameters )\r
 254 {\r
 255 unsigned short usData, usExpectedValue = 0;\r
 256 xBlockingQueueParameters *pxQueueParameters;\r
 257 const char * const pcTaskStartMsg = "Blocking queue consumer started.\r\n";\r
 258 const char * const pcTaskErrorMsg = "Incorrect value received on blocking queue.\r\n";\r
 259 short sErrorEverOccurred = pdFALSE;\r
 260 \r
 261         /* Queue a message for printing to say the task has started. */\r
 262         vPrintDisplayMessage( &pcTaskStartMsg );\r
 263 \r
 264         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 265 \r
 266         for( ;; )\r
 267         {       \r
 268                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 269                 {\r
 270                         if( usData != usExpectedValue )\r
 271                         {\r
 272                                 vPrintDisplayMessage( &pcTaskErrorMsg );\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 ] = { ( short ) 0, ( short ) 0, ( short ) 0 };\r
 301 static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( short ) 0, ( short ) 0, ( 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 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