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

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