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

   1 /*\r
   2     FreeRTOS V8.2.3 - Copyright (C) 2015 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  */\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 \r
 104 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
 105 #define blckqNUM_TASK_SETS      ( 3 )\r
 106 \r
 107 /* Structure used to pass parameters to the blocking queue tasks. */\r
 108 typedef struct BLOCKING_QUEUE_PARAMETERS\r
 109 {\r
 110         QueueHandle_t xQueue;                                   /*< The queue to be used by the task. */\r
 111         TickType_t xBlockTime;                          /*< The block time to use on queue reads/writes. */\r
 112         volatile short *psCheckVariable;        /*< Incremented on each successful cycle to check the task is still running. */\r
 113 } xBlockingQueueParameters;\r
 114 \r
 115 /* Task function that creates an incrementing number and posts it on a queue. */\r
 116 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 117 \r
 118 /* Task function that removes the incrementing number from a queue and checks that\r
 119 it is the expected number. */\r
 120 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 121 \r
 122 /* Variables which are incremented each time an item is removed from a queue, and\r
 123 found to be the expected value.\r
 124 These are used to check that the tasks are still running. */\r
 125 static volatile short sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 126 \r
 127 /* Variable which are incremented each time an item is posted on a queue.   These\r
 128 are used to check that the tasks are still running. */\r
 129 static volatile short sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 130 \r
 131 /*-----------------------------------------------------------*/\r
 132 \r
 133 void vStartBlockingQueueTasks( UBaseType_t uxPriority )\r
 134 {\r
 135 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 136 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 137 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 138 const UBaseType_t uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 139 const TickType_t xBlockTime = ( TickType_t ) 1000 / portTICK_PERIOD_MS;\r
 140 const TickType_t xDontBlock = ( TickType_t ) 0;\r
 141 \r
 142         /* Create the first two tasks as described at the top of the file. */\r
 143 \r
 144         /* First create the structure used to pass parameters to the consumer tasks. */\r
 145         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 146 \r
 147         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 148         Pass a pointer to the queue in the parameter structure. */\r
 149         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
 150 \r
 151         /* The consumer is created first so gets a block time as described above. */\r
 152         pxQueueParameters1->xBlockTime = xBlockTime;\r
 153 \r
 154         /* Pass in the variable that this task is going to increment so we can check it\r
 155         is still running. */\r
 156         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 157 \r
 158         /* Create the structure used to pass parameters to the producer task. */\r
 159         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 160 \r
 161         /* Pass the queue to this task also, using the parameter structure. */\r
 162         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 163 \r
 164         /* The producer is not going to block - as soon as it posts the consumer will\r
 165         wake and remove the item so the producer should always have room to post. */\r
 166         pxQueueParameters2->xBlockTime = xDontBlock;\r
 167 \r
 168         /* Pass in the variable that this task is going to increment so we can check\r
 169         it is still running. */\r
 170         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 171 \r
 172 \r
 173         /* Note the producer has a lower priority than the consumer when the tasks are\r
 174         spawned. */\r
 175         xTaskCreate( vBlockingQueueConsumer, "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 176         xTaskCreate( vBlockingQueueProducer, "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 177 \r
 178 \r
 179 \r
 180         /* Create the second two tasks as described at the top of the file.   This uses\r
 181         the same mechanism but reverses the task priorities. */\r
 182 \r
 183         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 184         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( UBaseType_t ) sizeof( uint16_t ) );\r
 185         pxQueueParameters3->xBlockTime = xDontBlock;\r
 186         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 187 \r
 188         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 189         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 190         pxQueueParameters4->xBlockTime = xBlockTime;\r
 191         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 192 \r
 193         xTaskCreate( vBlockingQueueConsumer, "QConsB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 194         xTaskCreate( vBlockingQueueProducer, "QProdB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 195 \r
 196 \r
 197 \r
 198         /* Create the last two tasks as described above.  The mechanism is again just\r
 199         the same.  This time both parameter structures are given a block time. */\r
 200         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 201         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( UBaseType_t ) sizeof( uint16_t ) );\r
 202         pxQueueParameters5->xBlockTime = xBlockTime;\r
 203         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 204 \r
 205         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 206         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 207         pxQueueParameters6->xBlockTime = xBlockTime;\r
 208         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] );\r
 209 \r
 210         xTaskCreate( vBlockingQueueProducer, "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 211         xTaskCreate( vBlockingQueueConsumer, "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 216 {\r
 217 uint16_t usValue = 0;\r
 218 xBlockingQueueParameters *pxQueueParameters;\r
 219 short sErrorEverOccurred = pdFALSE;\r
 220 \r
 221         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 222 \r
 223         for( ;; )\r
 224         {\r
 225                 if( xQueueSend( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 226                 {\r
 227                         sErrorEverOccurred = pdTRUE;\r
 228                 }\r
 229                 else\r
 230                 {\r
 231                         /* We have successfully posted a message, so increment the variable\r
 232                         used to check we are still running. */\r
 233                         if( sErrorEverOccurred == pdFALSE )\r
 234                         {\r
 235                                 ( *pxQueueParameters->psCheckVariable )++;\r
 236                         }\r
 237 \r
 238                         /* Increment the variable we are going to post next time round.  The\r
 239                         consumer will expect the numbers to     follow in numerical order. */\r
 240                         ++usValue;\r
 241 \r
 242                         #if configUSE_PREEMPTION == 0\r
 243                                 taskYIELD();\r
 244                         #endif\r
 245                 }\r
 246         }\r
 247 }\r
 248 /*-----------------------------------------------------------*/\r
 249 \r
 250 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 251 {\r
 252 uint16_t usData, usExpectedValue = 0;\r
 253 xBlockingQueueParameters *pxQueueParameters;\r
 254 short sErrorEverOccurred = pdFALSE;\r
 255 \r
 256         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 257 \r
 258         for( ;; )\r
 259         {\r
 260                 if( xQueueReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 261                 {\r
 262                         if( usData != usExpectedValue )\r
 263                         {\r
 264                                 /* Catch-up. */\r
 265                                 usExpectedValue = usData;\r
 266 \r
 267                                 sErrorEverOccurred = pdTRUE;\r
 268                         }\r
 269                         else\r
 270                         {\r
 271                                 /* We have successfully received a message, so increment the\r
 272                                 variable used to check we are still running. */\r
 273                                 if( sErrorEverOccurred == pdFALSE )\r
 274                                 {\r
 275                                         ( *pxQueueParameters->psCheckVariable )++;\r
 276                                 }\r
 277 \r
 278                                 /* Increment the value we expect to remove from the queue next time\r
 279                                 round. */\r
 280                                 ++usExpectedValue;\r
 281                         }\r
 282 \r
 283                         #if configUSE_PREEMPTION == 0\r
 284                         {\r
 285                                 if( pxQueueParameters->xBlockTime == 0 )\r
 286                                 {\r
 287                                         taskYIELD();\r
 288                                 }\r
 289                         }\r
 290                         #endif\r
 291                 }\r
 292         }\r
 293 }\r
 294 /*-----------------------------------------------------------*/\r
 295 \r
 296 /* This is called to check that all the created tasks are still running. */\r
 297 BaseType_t xAreBlockingQueuesStillRunning( void )\r
 298 {\r
 299 static short sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 300 static short sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( uint16_t ) 0, ( uint16_t ) 0, ( uint16_t ) 0 };\r
 301 BaseType_t xReturn = pdPASS, xTasks;\r
 302 \r
 303         /* Not too worried about mutual exclusion on these variables as they are 16\r
 304         bits and we are only reading them. We also only care to see if they have\r
 305         changed or not.\r
 306 \r
 307         Loop through each check variable to and return pdFALSE if any are found not\r
 308         to have changed since the last call. */\r
 309 \r
 310         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 311         {\r
 312                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 313                 {\r
 314                         xReturn = pdFALSE;\r
 315                 }\r
 316                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 317 \r
 318 \r
 319                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 320                 {\r
 321                         xReturn = pdFALSE;\r
 322                 }\r
 323                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 324         }\r
 325 \r
 326         return xReturn;\r
 327 }\r
 328 \r