git.sur5r.net Git - freertos/blob - Demo/Common/Full/events.c

   1 /*\r
   2         FreeRTOS.org V4.2.1 - Copyright (C) 2003-2007 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         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30 \r
  31         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  32         with commercial development and support options.\r
  33         ***************************************************************************\r
  34 */\r
  35 \r
  36 /**\r
  37  * This file exercises the event mechanism whereby more than one task is\r
  38  * blocked waiting for the same event.\r
  39  *\r
  40  * The demo creates five tasks - four 'event' tasks, and a controlling task.\r
  41  * The event tasks have various different priorities and all block on reading\r
  42  * the same queue.  The controlling task writes data to the queue, then checks\r
  43  * to see which of the event tasks read the data from the queue.  The\r
  44  * controlling task has the lowest priority of all the tasks so is guaranteed\r
  45  * to always get preempted immediately upon writing to the queue.\r
  46  *\r
  47  * By selectively suspending and resuming the event tasks the controlling task\r
  48  * can check that the highest priority task that is blocked on the queue is the\r
  49  * task that reads the posted data from the queue.\r
  50  *\r
  51  * Two of the event tasks share the same priority.  When neither of these tasks\r
  52  * are suspended they should alternate - one reading one message from the queue,\r
  53  * the other the next message, etc.\r
  54  */\r
  55 \r
  56 /* Standard includes. */\r
  57 #include <stdlib.h>\r
  58 #include <stdio.h>\r
  59 #include <string.h>\r
  60 \r
  61 /* Scheduler include files. */\r
  62 #include "FreeRTOS.h"\r
  63 #include "task.h"\r
  64 #include "queue.h"\r
  65 \r
  66 /* Demo program include files. */\r
  67 #include "mevents.h"\r
  68 #include "print.h"\r
  69 \r
  70 /* Demo specific constants. */\r
  71 #define evtSTACK_SIZE           ( ( unsigned portBASE_TYPE ) 128 )\r
  72 #define evtNUM_TASKS            ( 4 )\r
  73 #define evtQUEUE_LENGTH         ( ( unsigned portBASE_TYPE ) 3 )\r
  74 #define evtNO_DELAY                                             0\r
  75 \r
  76 /* Just indexes used to uniquely identify the tasks.  Note that two tasks are\r
  77 'highest' priority. */\r
  78 #define evtHIGHEST_PRIORITY_INDEX_2             3\r
  79 #define evtHIGHEST_PRIORITY_INDEX_1             2\r
  80 #define evtMEDIUM_PRIORITY_INDEX                1\r
  81 #define evtLOWEST_PRIORITY_INDEX                0\r
  82 \r
  83 /* Each event task increments one of these counters each time it reads data\r
  84 from the queue. */\r
  85 static volatile portBASE_TYPE xTaskCounters[ evtNUM_TASKS ] = { 0, 0, 0, 0 };\r
  86 \r
  87 /* Each time the controlling task posts onto the queue it increments the \r
  88 expected count of the task that it expected to read the data from the queue \r
  89 (i.e. the task with the highest priority that should be blocked on the queue).  \r
  90 \r
  91 xExpectedTaskCounters are incremented from the controlling task, and \r
  92 xTaskCounters are incremented from the individual event tasks - therefore\r
  93 comparing xTaskCounters to xExpectedTaskCounters shows whether or not the \r
  94 correct task was unblocked by the post. */\r
  95 static portBASE_TYPE xExpectedTaskCounters[ evtNUM_TASKS ] = { 0, 0, 0, 0 };\r
  96 \r
  97 /* Handles to the four event tasks.  These are required to suspend and resume\r
  98 the tasks. */\r
  99 static xTaskHandle xCreatedTasks[ evtNUM_TASKS ];\r
 100 \r
 101 /* The single queue onto which the controlling task posts, and the four event\r
 102 tasks block. */\r
 103 static xQueueHandle xQueue;\r
 104 \r
 105 /* Flag used to indicate whether or not an error has occurred at any time.\r
 106 An error is either the queue being full when not expected, or an unexpected\r
 107 task reading data from the queue. */\r
 108 static portBASE_TYPE xHealthStatus = pdPASS;\r
 109 \r
 110 /*-----------------------------------------------------------*/\r
 111 \r
 112 /* Function that implements the event task.  This is created four times. */\r
 113 static void prvMultiEventTask( void *pvParameters );\r
 114 \r
 115 /* Function that implements the controlling task. */\r
 116 static void prvEventControllerTask( void *pvParameters );\r
 117 \r
 118 /* This is a utility function that posts data to the queue, then compares \r
 119 xExpectedTaskCounters with xTaskCounters to ensure everything worked as \r
 120 expected.\r
 121 \r
 122 The event tasks all have higher priorities the controlling task.  Therefore\r
 123 the controlling task will always get preempted between writhing to the queue\r
 124 and checking the task counters. \r
 125 \r
 126 @param xExpectedTask  The index to the task that the controlling task thinks\r
 127                       should be the highest priority task waiting for data, and\r
 128                                           therefore the task that will unblock.\r
 129                                           \r
 130 @param  xIncrement    The number of items that should be written to the queue.\r
 131 */\r
 132 static void prvCheckTaskCounters( portBASE_TYPE xExpectedTask, portBASE_TYPE xIncrement );\r
 133 \r
 134 /* This is just incremented each cycle of the controlling tasks function so\r
 135 the main application can ensure the test is still running. */\r
 136 static portBASE_TYPE xCheckVariable = 0;\r
 137 \r
 138 /*-----------------------------------------------------------*/\r
 139 \r
 140 void vStartMultiEventTasks( void )\r
 141 {\r
 142         /* Create the queue to be used for all the communications. */\r
 143         xQueue = xQueueCreate( evtQUEUE_LENGTH, ( unsigned portBASE_TYPE ) sizeof( unsigned portBASE_TYPE ) );\r
 144 \r
 145         /* Start the controlling task.  This has the idle priority to ensure it is\r
 146         always preempted by the event tasks. */\r
 147         xTaskCreate( prvEventControllerTask, "EvntCTRL", evtSTACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );\r
 148 \r
 149         /* Start the four event tasks.  Note that two have priority 3, one \r
 150         priority 2 and the other priority 1. */\r
 151         xTaskCreate( prvMultiEventTask, "Event0", evtSTACK_SIZE, ( void * ) &( xTaskCounters[ 0 ] ), 1, &( xCreatedTasks[ evtLOWEST_PRIORITY_INDEX ] ) );\r
 152         xTaskCreate( prvMultiEventTask, "Event1", evtSTACK_SIZE, ( void * ) &( xTaskCounters[ 1 ] ), 2, &( xCreatedTasks[ evtMEDIUM_PRIORITY_INDEX ] ) );\r
 153         xTaskCreate( prvMultiEventTask, "Event2", evtSTACK_SIZE, ( void * ) &( xTaskCounters[ 2 ] ), 3, &( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] ) );\r
 154         xTaskCreate( prvMultiEventTask, "Event3", evtSTACK_SIZE, ( void * ) &( xTaskCounters[ 3 ] ), 3, &( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_2 ] ) );\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 static void prvMultiEventTask( void *pvParameters )\r
 159 {\r
 160 portBASE_TYPE *pxCounter;\r
 161 unsigned portBASE_TYPE uxDummy;\r
 162 const portCHAR * const pcTaskStartMsg = "Multi event task started.\r\n";\r
 163 \r
 164         /* The variable this task will increment is passed in as a parameter. */\r
 165         pxCounter = ( portBASE_TYPE * ) pvParameters;\r
 166 \r
 167         vPrintDisplayMessage( &pcTaskStartMsg );\r
 168 \r
 169         for( ;; )\r
 170         {\r
 171                 /* Block on the queue. */\r
 172                 if( xQueueReceive( xQueue, &uxDummy, portMAX_DELAY ) )\r
 173                 {\r
 174                         /* We unblocked by reading the queue - so simply increment\r
 175                         the counter specific to this task instance. */\r
 176                         ( *pxCounter )++;\r
 177                 }\r
 178                 else\r
 179                 {\r
 180                         xHealthStatus = pdFAIL;\r
 181                 }\r
 182         }\r
 183 }\r
 184 /*-----------------------------------------------------------*/\r
 185 \r
 186 static void prvEventControllerTask( void *pvParameters )\r
 187 {\r
 188 const portCHAR * const pcTaskStartMsg = "Multi event controller task started.\r\n";\r
 189 portBASE_TYPE xDummy = 0;\r
 190 \r
 191         /* Just to stop warnings. */\r
 192         ( void ) pvParameters;\r
 193 \r
 194         vPrintDisplayMessage( &pcTaskStartMsg );\r
 195 \r
 196         for( ;; )\r
 197         {\r
 198                 /* All tasks are blocked on the queue.  When a message is posted one of\r
 199                 the two tasks that share the highest priority should unblock to read\r
 200                 the queue.  The next message written should unblock the other task with\r
 201                 the same high priority, and so on in order.   No other task should \r
 202                 unblock to read data as they have lower priorities. */\r
 203 \r
 204                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 205                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_2, 1 );\r
 206                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 207                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_2, 1 );\r
 208                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 209 \r
 210                 /* For the rest of these tests we don't need the second 'highest' \r
 211                 priority task - so it is suspended. */\r
 212                 vTaskSuspend( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_2 ] );\r
 213 \r
 214 \r
 215 \r
 216                 /* Now suspend the other highest priority task.  The medium priority \r
 217                 task will then be the task with the highest priority that remains \r
 218                 blocked on the queue. */\r
 219                 vTaskSuspend( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 220                 \r
 221                 /* This time, when we post onto the queue we will expect the medium\r
 222                 priority task to unblock and preempt us. */\r
 223                 prvCheckTaskCounters( evtMEDIUM_PRIORITY_INDEX, 1 );\r
 224 \r
 225                 /* Now try resuming the highest priority task while the scheduler is\r
 226                 suspended.  The task should start executing as soon as the scheduler\r
 227                 is resumed - therefore when we post to the queue again, the highest\r
 228                 priority task should again preempt us. */\r
 229                 vTaskSuspendAll();\r
 230                         vTaskResume( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 231                 xTaskResumeAll();\r
 232                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 233                 \r
 234                 /* Now we are going to suspend the high and medium priority tasks.  The\r
 235                 low priority task should then preempt us.  Again the task suspension is \r
 236                 done with the whole scheduler suspended just for test purposes. */\r
 237                 vTaskSuspendAll();\r
 238                         vTaskSuspend( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 239                         vTaskSuspend( xCreatedTasks[ evtMEDIUM_PRIORITY_INDEX ] );\r
 240                 xTaskResumeAll();\r
 241                 prvCheckTaskCounters( evtLOWEST_PRIORITY_INDEX, 1 );\r
 242                 \r
 243                 \r
 244                 \r
 245                 /* Do the same basic test another few times - selectively suspending\r
 246                 and resuming tasks and each time calling prvCheckTaskCounters() passing\r
 247                 to the function the number of the task we expected to be unblocked by \r
 248                 the     post. */\r
 249 \r
 250                 vTaskResume( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 251                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 252                 \r
 253                 vTaskSuspendAll(); /* Just for test. */\r
 254                         vTaskSuspendAll(); /* Just for test. */\r
 255                                 vTaskSuspendAll(); /* Just for even more test. */\r
 256                                         vTaskSuspend( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 257                                 xTaskResumeAll();\r
 258                         xTaskResumeAll();\r
 259                 xTaskResumeAll();\r
 260                 prvCheckTaskCounters( evtLOWEST_PRIORITY_INDEX, 1 );\r
 261                 \r
 262                 vTaskResume( xCreatedTasks[ evtMEDIUM_PRIORITY_INDEX ] );\r
 263                 prvCheckTaskCounters( evtMEDIUM_PRIORITY_INDEX, 1 );\r
 264                 \r
 265                 vTaskResume( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 266                 prvCheckTaskCounters( evtHIGHEST_PRIORITY_INDEX_1, 1 );\r
 267 \r
 268 \r
 269 \r
 270 \r
 271 \r
 272                 /* Now a slight change, first suspend all tasks. */\r
 273                 vTaskSuspend( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 274                 vTaskSuspend( xCreatedTasks[ evtMEDIUM_PRIORITY_INDEX ] );\r
 275                 vTaskSuspend( xCreatedTasks[ evtLOWEST_PRIORITY_INDEX ] );\r
 276                 \r
 277                 /* Now when we resume the low priority task and write to the queue 3 \r
 278                 times.  We expect the low priority task to service the queue three\r
 279                 times. */\r
 280                 vTaskResume( xCreatedTasks[ evtLOWEST_PRIORITY_INDEX ] );\r
 281                 prvCheckTaskCounters( evtLOWEST_PRIORITY_INDEX, evtQUEUE_LENGTH );\r
 282                 \r
 283                 /* Again suspend all tasks (only the low priority task is not suspended\r
 284                 already). */\r
 285                 vTaskSuspend( xCreatedTasks[ evtLOWEST_PRIORITY_INDEX ] );\r
 286                 \r
 287                 /* This time we are going to suspend the scheduler, resume the low\r
 288                 priority task, then resume the high priority task.  In this state we\r
 289                 will write to the queue three times.  When the scheduler is resumed\r
 290                 we expect the high priority task to service all three messages. */\r
 291                 vTaskSuspendAll();\r
 292                 {\r
 293                         vTaskResume( xCreatedTasks[ evtLOWEST_PRIORITY_INDEX ] );\r
 294                         vTaskResume( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_1 ] );\r
 295                         \r
 296                         for( xDummy = 0; xDummy < evtQUEUE_LENGTH; xDummy++ )\r
 297                         {\r
 298                                 if( xQueueSend( xQueue, &xDummy, evtNO_DELAY ) != pdTRUE )\r
 299                                 {\r
 300                                         xHealthStatus = pdFAIL;\r
 301                                 }\r
 302                         }                       \r
 303                         \r
 304                         /* The queue should not have been serviced yet!.  The scheduler\r
 305                         is still suspended. */\r
 306                         if( memcmp( ( void * ) xExpectedTaskCounters, ( void * ) xTaskCounters, sizeof( xExpectedTaskCounters ) ) )\r
 307                         {\r
 308                                 xHealthStatus = pdFAIL;\r
 309                         }\r
 310                 }\r
 311                 xTaskResumeAll();\r
 312                 \r
 313                 /* We should have been preempted by resuming the scheduler - so by the\r
 314                 time we are running again we expect the high priority task to have \r
 315                 removed three items from the queue. */\r
 316                 xExpectedTaskCounters[ evtHIGHEST_PRIORITY_INDEX_1 ] += evtQUEUE_LENGTH;\r
 317                 if( memcmp( ( void * ) xExpectedTaskCounters, ( void * ) xTaskCounters, sizeof( xExpectedTaskCounters ) ) )\r
 318                 {\r
 319                         xHealthStatus = pdFAIL;\r
 320                 }\r
 321                 \r
 322                 /* The medium priority and second high priority tasks are still \r
 323                 suspended.  Make sure to resume them before starting again. */\r
 324                 vTaskResume( xCreatedTasks[ evtMEDIUM_PRIORITY_INDEX ] );\r
 325                 vTaskResume( xCreatedTasks[ evtHIGHEST_PRIORITY_INDEX_2 ] );\r
 326 \r
 327                 /* Just keep incrementing to show the task is still executing. */\r
 328                 xCheckVariable++;\r
 329         }\r
 330 }\r
 331 /*-----------------------------------------------------------*/\r
 332 \r
 333 static void prvCheckTaskCounters( portBASE_TYPE xExpectedTask, portBASE_TYPE xIncrement )\r
 334 {\r
 335 portBASE_TYPE xDummy = 0;\r
 336 \r
 337         /* Write to the queue the requested number of times.  The data written is\r
 338         not important. */\r
 339         for( xDummy = 0; xDummy < xIncrement; xDummy++ )\r
 340         {\r
 341                 if( xQueueSend( xQueue, &xDummy, evtNO_DELAY ) != pdTRUE )\r
 342                 {\r
 343                         /* Did not expect to ever find the queue full. */\r
 344                         xHealthStatus = pdFAIL;\r
 345                 }\r
 346         }\r
 347 \r
 348         /* All the tasks blocked on the queue have a priority higher than the \r
 349         controlling task.  Writing to the queue will therefore have caused this\r
 350         task to be preempted.  By the time this line executes the event task will\r
 351         have executed and incremented its counter.  Increment the expected counter\r
 352         to the same value. */\r
 353         ( xExpectedTaskCounters[ xExpectedTask ] ) += xIncrement;\r
 354 \r
 355         /* Check the actual counts and expected counts really are the same. */\r
 356         if( memcmp( ( void * ) xExpectedTaskCounters, ( void * ) xTaskCounters, sizeof( xExpectedTaskCounters ) ) )\r
 357         {\r
 358                 /* The counters were not the same.  This means a task we did not expect\r
 359                 to unblock actually did unblock. */\r
 360                 xHealthStatus = pdFAIL;\r
 361         }\r
 362 }\r
 363 /*-----------------------------------------------------------*/\r
 364 \r
 365 portBASE_TYPE xAreMultiEventTasksStillRunning( void )\r
 366 {\r
 367 static portBASE_TYPE xPreviousCheckVariable = 0;\r
 368 \r
 369         /* Called externally to periodically check that this test is still\r
 370         operational. */\r
 371 \r
 372         if( xPreviousCheckVariable == xCheckVariable )\r
 373         {\r
 374                 xHealthStatus = pdFAIL;\r
 375         }\r
 376         \r
 377         xPreviousCheckVariable = xCheckVariable;\r
 378         \r
 379         return xHealthStatus;   \r
 380 }\r
 381 \r
 382 \r