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

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