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

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