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

   1 /*\r
   2         FreeRTOS.org V5.0.0 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS.org is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS.org; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section\r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26     ***************************************************************************\r
  27     ***************************************************************************\r
  28     *                                                                         *\r
  29     * SAVE TIME AND MONEY!  We can port FreeRTOS.org to your own hardware,    *\r
  30     * and even write all or part of your application on your behalf.          *\r
  31     * See http://www.OpenRTOS.com for details of the services we provide to   *\r
  32     * expedite your project.                                                  *\r
  33     *                                                                         *\r
  34     ***************************************************************************\r
  35     ***************************************************************************\r
  36 \r
  37         Please ensure to read the configuration and relevant port sections of the\r
  38         online documentation.\r
  39 \r
  40         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  41         contact details.\r
  42 \r
  43         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  44         critical systems.\r
  45 \r
  46         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  47         licensing and training services.\r
  48 */\r
  49 \r
  50 /*\r
  51  * This is a version of BlockQ.c that uses the alternative (Alt) API.\r
  52  *\r
  53  * Creates six tasks that operate on three queues as follows:\r
  54  *\r
  55  * The first two tasks send and receive an incrementing number to/from a queue.\r
  56  * One task acts as a producer and the other as the consumer.  The consumer is a\r
  57  * higher priority than the producer and is set to block on queue reads.  The queue\r
  58  * only has space for one item - as soon as the producer posts a message on the\r
  59  * queue the consumer will unblock, pre-empt the producer, and remove the item.\r
  60  *\r
  61  * The second two tasks work the other way around.  Again the queue used only has\r
  62  * enough space for one item.  This time the consumer has a lower priority than the\r
  63  * producer.  The producer will try to post on the queue blocking when the queue is\r
  64  * full.  When the consumer wakes it will remove the item from the queue, causing\r
  65  * the producer to unblock, pre-empt the consumer, and immediately re-fill the\r
  66  * queue.\r
  67  *\r
  68  * The last two tasks use the same queue producer and consumer functions.  This time the queue has\r
  69  * enough space for lots of items and the tasks operate at the same priority.  The\r
  70  * producer will execute, placing items into the queue.  The consumer will start\r
  71  * executing when either the queue becomes full (causing the producer to block) or\r
  72  * a context switch occurs (tasks of the same priority will time slice).\r
  73  *\r
  74  */\r
  75 \r
  76 \r
  77 #include <stdlib.h>\r
  78 \r
  79 /* Scheduler include files. */\r
  80 #include "FreeRTOS.h"\r
  81 #include "task.h"\r
  82 #include "queue.h"\r
  83 \r
  84 /* Demo program include files. */\r
  85 #include "AltBlckQ.h"\r
  86 \r
  87 #define blckqSTACK_SIZE         configMINIMAL_STACK_SIZE\r
  88 #define blckqNUM_TASK_SETS      ( 3 )\r
  89 \r
  90 /* Structure used to pass parameters to the blocking queue tasks. */\r
  91 typedef struct BLOCKING_QUEUE_PARAMETERS\r
  92 {\r
  93         xQueueHandle xQueue;                                    /*< The queue to be used by the task. */\r
  94         portTickType xBlockTime;                                /*< The block time to use on queue reads/writes. */\r
  95         volatile portSHORT *psCheckVariable;    /*< Incremented on each successful cycle to check the task is still running. */\r
  96 } xBlockingQueueParameters;\r
  97 \r
  98 /* Task function that creates an incrementing number and posts it on a queue. */\r
  99 static portTASK_FUNCTION_PROTO( vBlockingQueueProducer, pvParameters );\r
 100 \r
 101 /* Task function that removes the incrementing number from a queue and checks that\r
 102 it is the expected number. */\r
 103 static portTASK_FUNCTION_PROTO( vBlockingQueueConsumer, pvParameters );\r
 104 \r
 105 /* Variables which are incremented each time an item is removed from a queue, and\r
 106 found to be the expected value.\r
 107 These are used to check that the tasks are still running. */\r
 108 static volatile portSHORT sBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 109 \r
 110 /* Variable which are incremented each time an item is posted on a queue.   These\r
 111 are used to check that the tasks are still running. */\r
 112 static volatile portSHORT sBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 113 \r
 114 /*-----------------------------------------------------------*/\r
 115 \r
 116 void vStartAltBlockingQueueTasks( unsigned portBASE_TYPE uxPriority )\r
 117 {\r
 118 xBlockingQueueParameters *pxQueueParameters1, *pxQueueParameters2;\r
 119 xBlockingQueueParameters *pxQueueParameters3, *pxQueueParameters4;\r
 120 xBlockingQueueParameters *pxQueueParameters5, *pxQueueParameters6;\r
 121 const unsigned portBASE_TYPE uxQueueSize1 = 1, uxQueueSize5 = 5;\r
 122 const portTickType xBlockTime = ( portTickType ) 1000 / portTICK_RATE_MS;\r
 123 const portTickType xDontBlock = ( portTickType ) 0;\r
 124 \r
 125         /* Create the first two tasks as described at the top of the file. */\r
 126         \r
 127         /* First create the structure used to pass parameters to the consumer tasks. */\r
 128         pxQueueParameters1 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 129 \r
 130         /* Create the queue used by the first two tasks to pass the incrementing number.\r
 131         Pass a pointer to the queue in the parameter structure. */\r
 132         pxQueueParameters1->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 133 \r
 134         /* The consumer is created first so gets a block time as described above. */\r
 135         pxQueueParameters1->xBlockTime = xBlockTime;\r
 136 \r
 137         /* Pass in the variable that this task is going to increment so we can check it\r
 138         is still running. */\r
 139         pxQueueParameters1->psCheckVariable = &( sBlockingConsumerCount[ 0 ] );\r
 140                 \r
 141         /* Create the structure used to pass parameters to the producer task. */\r
 142         pxQueueParameters2 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 143 \r
 144         /* Pass the queue to this task also, using the parameter structure. */\r
 145         pxQueueParameters2->xQueue = pxQueueParameters1->xQueue;\r
 146 \r
 147         /* The producer is not going to block - as soon as it posts the consumer will\r
 148         wake and remove the item so the producer should always have room to post. */\r
 149         pxQueueParameters2->xBlockTime = xDontBlock;\r
 150 \r
 151         /* Pass in the variable that this task is going to increment so we can check\r
 152         it is still running. */\r
 153         pxQueueParameters2->psCheckVariable = &( sBlockingProducerCount[ 0 ] );\r
 154 \r
 155 \r
 156         /* Note the producer has a lower priority than the consumer when the tasks are\r
 157         spawned. */\r
 158         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB1", blckqSTACK_SIZE, ( void * ) pxQueueParameters1, uxPriority, NULL );\r
 159         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB2", blckqSTACK_SIZE, ( void * ) pxQueueParameters2, tskIDLE_PRIORITY, NULL );\r
 160 \r
 161         \r
 162 \r
 163         /* Create the second two tasks as described at the top of the file.   This uses\r
 164         the same mechanism but reverses the task priorities. */\r
 165 \r
 166         pxQueueParameters3 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 167         pxQueueParameters3->xQueue = xQueueCreate( uxQueueSize1, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 168         pxQueueParameters3->xBlockTime = xDontBlock;\r
 169         pxQueueParameters3->psCheckVariable = &( sBlockingProducerCount[ 1 ] );\r
 170 \r
 171         pxQueueParameters4 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 172         pxQueueParameters4->xQueue = pxQueueParameters3->xQueue;\r
 173         pxQueueParameters4->xBlockTime = xBlockTime;\r
 174         pxQueueParameters4->psCheckVariable = &( sBlockingConsumerCount[ 1 ] );\r
 175 \r
 176         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QProdB3", blckqSTACK_SIZE, ( void * ) pxQueueParameters3, tskIDLE_PRIORITY, NULL );\r
 177         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QConsB4", blckqSTACK_SIZE, ( void * ) pxQueueParameters4, uxPriority, NULL );\r
 178 \r
 179 \r
 180 \r
 181         /* Create the last two tasks as described above.  The mechanism is again just\r
 182         the same.  This time both parameter structures are given a block time. */\r
 183         pxQueueParameters5 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 184         pxQueueParameters5->xQueue = xQueueCreate( uxQueueSize5, ( unsigned portBASE_TYPE ) sizeof( unsigned portSHORT ) );\r
 185         pxQueueParameters5->xBlockTime = xBlockTime;\r
 186         pxQueueParameters5->psCheckVariable = &( sBlockingProducerCount[ 2 ] );\r
 187 \r
 188         pxQueueParameters6 = ( xBlockingQueueParameters * ) pvPortMalloc( sizeof( xBlockingQueueParameters ) );\r
 189         pxQueueParameters6->xQueue = pxQueueParameters5->xQueue;\r
 190         pxQueueParameters6->xBlockTime = xBlockTime;\r
 191         pxQueueParameters6->psCheckVariable = &( sBlockingConsumerCount[ 2 ] ); \r
 192 \r
 193         xTaskCreate( vBlockingQueueProducer, ( signed portCHAR * ) "QProdB5", blckqSTACK_SIZE, ( void * ) pxQueueParameters5, tskIDLE_PRIORITY, NULL );\r
 194         xTaskCreate( vBlockingQueueConsumer, ( signed portCHAR * ) "QConsB6", blckqSTACK_SIZE, ( void * ) pxQueueParameters6, tskIDLE_PRIORITY, NULL );\r
 195 }\r
 196 /*-----------------------------------------------------------*/\r
 197 \r
 198 static portTASK_FUNCTION( vBlockingQueueProducer, pvParameters )\r
 199 {\r
 200 unsigned portSHORT usValue = 0;\r
 201 xBlockingQueueParameters *pxQueueParameters;\r
 202 portSHORT sErrorEverOccurred = pdFALSE;\r
 203 \r
 204         #ifdef USE_STDIO\r
 205         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 206         \r
 207                 const portCHAR * const pcTaskStartMsg = "Alt blocking queue producer task started.\r\n";\r
 208 \r
 209                 /* Queue a message for printing to say the task has started. */\r
 210                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 211         #endif\r
 212 \r
 213         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 214 \r
 215         for( ;; )\r
 216         {               \r
 217                 if( xQueueAltSendToBack( pxQueueParameters->xQueue, ( void * ) &usValue, pxQueueParameters->xBlockTime ) != pdPASS )\r
 218                 {\r
 219                         sErrorEverOccurred = pdTRUE;\r
 220                 }\r
 221                 else\r
 222                 {\r
 223                         /* We have successfully posted a message, so increment the variable\r
 224                         used to check we are still running. */\r
 225                         if( sErrorEverOccurred == pdFALSE )\r
 226                         {\r
 227                                 ( *pxQueueParameters->psCheckVariable )++;\r
 228                         }\r
 229 \r
 230                         /* Increment the variable we are going to post next time round.  The\r
 231                         consumer will expect the numbers to     follow in numerical order. */\r
 232                         ++usValue;\r
 233                 }\r
 234         }\r
 235 }\r
 236 /*-----------------------------------------------------------*/\r
 237 \r
 238 static portTASK_FUNCTION( vBlockingQueueConsumer, pvParameters )\r
 239 {\r
 240 unsigned portSHORT usData, usExpectedValue = 0;\r
 241 xBlockingQueueParameters *pxQueueParameters;\r
 242 portSHORT sErrorEverOccurred = pdFALSE;\r
 243 \r
 244         #ifdef USE_STDIO\r
 245         void vPrintDisplayMessage( const portCHAR * const * ppcMessageToSend );\r
 246         \r
 247                 const portCHAR * const pcTaskStartMsg = "Alt blocking queue consumer task started.\r\n";\r
 248 \r
 249                 /* Queue a message for printing to say the task has started. */\r
 250                 vPrintDisplayMessage( &pcTaskStartMsg );\r
 251         #endif\r
 252 \r
 253         pxQueueParameters = ( xBlockingQueueParameters * ) pvParameters;\r
 254 \r
 255         for( ;; )\r
 256         {       \r
 257                 if( xQueueAltReceive( pxQueueParameters->xQueue, &usData, pxQueueParameters->xBlockTime ) == pdPASS )\r
 258                 {\r
 259                         if( usData != usExpectedValue )\r
 260                         {\r
 261                                 /* Catch-up. */\r
 262                                 usExpectedValue = usData;\r
 263 \r
 264                                 sErrorEverOccurred = pdTRUE;\r
 265                         }\r
 266                         else\r
 267                         {\r
 268                                 /* We have successfully received a message, so increment the\r
 269                                 variable used to check we are still running. */ \r
 270                                 if( sErrorEverOccurred == pdFALSE )\r
 271                                 {\r
 272                                         ( *pxQueueParameters->psCheckVariable )++;\r
 273                                 }\r
 274                                                         \r
 275                                 /* Increment the value we expect to remove from the queue next time\r
 276                                 round. */\r
 277                                 ++usExpectedValue;\r
 278                         }                       \r
 279                 }               \r
 280         }\r
 281 }\r
 282 /*-----------------------------------------------------------*/\r
 283 \r
 284 /* This is called to check that all the created tasks are still running. */\r
 285 portBASE_TYPE xAreAltBlockingQueuesStillRunning( void )\r
 286 {\r
 287 static portSHORT sLastBlockingConsumerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 288 static portSHORT sLastBlockingProducerCount[ blckqNUM_TASK_SETS ] = { ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0, ( unsigned portSHORT ) 0 };\r
 289 portBASE_TYPE xReturn = pdPASS, xTasks;\r
 290 \r
 291         /* Not too worried about mutual exclusion on these variables as they are 16\r
 292         bits and we are only reading them. We also only care to see if they have\r
 293         changed or not.\r
 294         \r
 295         Loop through each check variable to and return pdFALSE if any are found not\r
 296         to have changed since the last call. */\r
 297 \r
 298         for( xTasks = 0; xTasks < blckqNUM_TASK_SETS; xTasks++ )\r
 299         {\r
 300                 if( sBlockingConsumerCount[ xTasks ] == sLastBlockingConsumerCount[ xTasks ]  )\r
 301                 {\r
 302                         xReturn = pdFALSE;\r
 303                 }\r
 304                 sLastBlockingConsumerCount[ xTasks ] = sBlockingConsumerCount[ xTasks ];\r
 305 \r
 306 \r
 307                 if( sBlockingProducerCount[ xTasks ] == sLastBlockingProducerCount[ xTasks ]  )\r
 308                 {\r
 309                         xReturn = pdFALSE;\r
 310                 }\r
 311                 sLastBlockingProducerCount[ xTasks ] = sBlockingProducerCount[ xTasks ];\r
 312         }\r
 313 \r
 314         return xReturn;\r
 315 }\r
 316 \r