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

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