2 FreeRTOS V8.2.0rc1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\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
13 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
14 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
15 >>! obliged to provide the source code for proprietary components !<<
\r
16 >>! outside of the FreeRTOS kernel. !<<
\r
18 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
19 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
20 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
21 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * Having a problem? Start by reading the FAQ "My application does *
\r
28 * not run, what could be wrong?". Have you defined configASSERT()? *
\r
30 * http://www.FreeRTOS.org/FAQHelp.html *
\r
32 ***************************************************************************
\r
34 ***************************************************************************
\r
36 * FreeRTOS provides completely free yet professionally developed, *
\r
37 * robust, strictly quality controlled, supported, and cross *
\r
38 * platform software that is more than just the market leader, it *
\r
39 * is the industry's de facto standard. *
\r
41 * Help yourself get started quickly while simultaneously helping *
\r
42 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
43 * tutorial book, reference manual, or both: *
\r
44 * http://www.FreeRTOS.org/Documentation *
\r
46 ***************************************************************************
\r
48 ***************************************************************************
\r
50 * Investing in training allows your team to be as productive as *
\r
51 * possible as early as possible, lowering your overall development *
\r
52 * cost, and enabling you to bring a more robust product to market *
\r
53 * earlier than would otherwise be possible. Richard Barry is both *
\r
54 * the architect and key author of FreeRTOS, and so also the world's *
\r
55 * leading authority on what is the world's most popular real time *
\r
56 * kernel for deeply embedded MCU designs. Obtaining your training *
\r
57 * from Richard ensures your team will gain directly from his in-depth *
\r
58 * product knowledge and years of usage experience. Contact Real Time *
\r
59 * Engineers Ltd to enquire about the FreeRTOS Masterclass, presented *
\r
60 * by Richard Barry: http://www.FreeRTOS.org/contact
\r
62 ***************************************************************************
\r
64 ***************************************************************************
\r
66 * You are receiving this top quality software for free. Please play *
\r
67 * fair and reciprocate by reporting any suspected issues and *
\r
68 * participating in the community forum: *
\r
69 * http://www.FreeRTOS.org/support *
\r
73 ***************************************************************************
\r
75 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
76 license and Real Time Engineers Ltd. contact details.
\r
78 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
79 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
80 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
82 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
83 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
85 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
86 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
87 licenses offer ticketed support, indemnification and commercial middleware.
\r
89 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
90 engineered and independently SIL3 certified version for use in safety and
\r
91 mission critical applications that require provable dependability.
\r
99 * This file contains fairly comprehensive checks on the behaviour of event
\r
100 * groups. It is not intended to be a user friendly demonstration of the
\r
101 * event groups API.
\r
103 * NOTE: The tests implemented in this file are informal 'sanity' tests
\r
104 * only and are not part of the module tests that make use of the
\r
105 * mtCOVERAGE_TEST_MARKER macro within the event groups implementation.
\r
109 /* Scheduler include files. */
\r
110 #include "FreeRTOS.h"
\r
112 #include "event_groups.h"
\r
114 /* Demo app includes. */
\r
115 #include "EventGroupsDemo.h"
\r
117 #if( INCLUDE_eTaskGetState != 1 )
\r
118 #error INCLUDE_eTaskGetState must be set to 1 in FreeRTOSConfig.h to use this demo file.
\r
121 /* Priorities used by the tasks. */
\r
122 #define ebSET_BIT_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
123 #define ebWAIT_BIT_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
125 /* Generic bit definitions. */
\r
126 #define ebBIT_0 ( 0x01UL )
\r
127 #define ebBIT_1 ( 0x02UL )
\r
128 #define ebBIT_2 ( 0x04UL )
\r
129 #define ebBIT_3 ( 0x08UL )
\r
130 #define ebBIT_4 ( 0x10UL )
\r
131 #define ebBIT_5 ( 0x20UL )
\r
132 #define ebBIT_6 ( 0x40UL )
\r
133 #define ebBIT_7 ( 0x80UL )
\r
135 /* Combinations of bits used in the demo. */
\r
136 #define ebCOMBINED_BITS ( ebBIT_1 | ebBIT_5 | ebBIT_7 )
\r
137 #define ebALL_BITS ( ebBIT_0 | ebBIT_1 | ebBIT_2 | ebBIT_3 | ebBIT_4 | ebBIT_5 | ebBIT_6 | ebBIT_7 )
\r
139 /* Associate a bit to each task. These bits are used to identify all the tasks
\r
140 that synchronise with the xEventGroupSync() function. */
\r
141 #define ebSET_BIT_TASK_SYNC_BIT ebBIT_0
\r
142 #define ebWAIT_BIT_TASK_SYNC_BIT ebBIT_1
\r
143 #define ebRENDESVOUS_TASK_1_SYNC_BIT ebBIT_2
\r
144 #define ebRENDESVOUS_TASK_2_SYNC_BIT ebBIT_3
\r
145 #define ebALL_SYNC_BITS ( ebSET_BIT_TASK_SYNC_BIT | ebWAIT_BIT_TASK_SYNC_BIT | ebRENDESVOUS_TASK_1_SYNC_BIT | ebRENDESVOUS_TASK_2_SYNC_BIT )
\r
147 /* A block time of zero simply means "don't block". */
\r
148 #define ebDONT_BLOCK ( 0 )
\r
151 #define ebSHORT_DELAY ( 5 / portTICK_PERIOD_MS )
\r
153 /* Used in the selective bits test which checks no, one or both tasks blocked on
\r
154 event bits in a group are unblocked as appropriate as different bits get set. */
\r
155 #define ebSELECTIVE_BITS_1 0x03
\r
156 #define ebSELECTIVE_BITS_2 0x05
\r
158 /*-----------------------------------------------------------*/
\r
161 * NOTE: The tests implemented in this function are informal 'sanity' tests
\r
162 * only and are not part of the module tests that make use of the
\r
163 * mtCOVERAGE_TEST_MARKER macro within the event groups implementation.
\r
165 * The master test task. This task:
\r
167 * 1) Calls prvSelectiveBitsTestMasterFunction() to test the behaviour when two
\r
168 * tasks are blocked on different bits in an event group. The counterpart of
\r
169 * this test is implemented by the prvSelectiveBitsTestSlaveFunction()
\r
170 * function (which is called by the two tasks that block on the event group).
\r
172 * 2) Calls prvBitCombinationTestMasterFunction() to test the behaviour when
\r
173 * just one task is blocked on various combinations of bits within an event
\r
174 * group. The counterpart of this test is implemented within the 'test
\r
177 * 3) Calls prvPerformTaskSyncTests() to test task synchronisation behaviour.
\r
179 static void prvTestMasterTask( void *pvParameters );
\r
182 * A helper task that enables the 'test master' task to perform several
\r
183 * behavioural tests. See the comments above the prvTestMasterTask() prototype
\r
186 static void prvTestSlaveTask( void *pvParameters );
\r
189 * The part of the test that is performed between the 'test master' task and the
\r
190 * 'test slave' task to test the behaviour when the slave blocks on various
\r
191 * event bit combinations.
\r
193 static BaseType_t prvBitCombinationTestMasterFunction( BaseType_t xError, TaskHandle_t xTestSlaveTaskHandle );
\r
196 * The part of the test that uses all the tasks to test the task synchronisation
\r
199 static BaseType_t prvPerformTaskSyncTests( BaseType_t xError, TaskHandle_t xTestSlaveTaskHandle );
\r
202 * Two instances of prvSyncTask() are created. They start by calling
\r
203 * prvSelectiveBitsTestSlaveFunction() to act as slaves when the test master is
\r
204 * executing the prvSelectiveBitsTestMasterFunction() function. They then loop
\r
205 * to test the task synchronisation (rendezvous) behaviour.
\r
207 static void prvSyncTask( void *pvParameters );
\r
210 * Functions used in a test that blocks two tasks on various different bits
\r
211 * within an event group - then sets each bit in turn and checks that the
\r
212 * correct tasks unblock at the correct times.
\r
214 static BaseType_t prvSelectiveBitsTestMasterFunction( void );
\r
215 static void prvSelectiveBitsTestSlaveFunction( void );
\r
217 /*-----------------------------------------------------------*/
\r
219 /* Variables that are incremented by the tasks on each cycle provided no errors
\r
220 have been found. Used to detect an error or stall in the test cycling. */
\r
221 static volatile uint32_t ulTestMasterCycles = 0, ulTestSlaveCycles = 0, ulISRCycles = 0;
\r
223 /* The event group used by all the task based tests. */
\r
224 static EventGroupHandle_t xEventGroup = NULL;
\r
226 /* The event group used by the interrupt based tests. */
\r
227 static EventGroupHandle_t xISREventGroup = NULL;
\r
229 /* Handles to the tasks that only take part in the synchronisation calls. */
\r
230 static TaskHandle_t xSyncTask1 = NULL, xSyncTask2 = NULL;
\r
232 /*-----------------------------------------------------------*/
\r
234 void vStartEventGroupTasks( void )
\r
236 TaskHandle_t xTestSlaveTaskHandle;
\r
239 * This file contains fairly comprehensive checks on the behaviour of event
\r
240 * groups. It is not intended to be a user friendly demonstration of the
\r
241 * event groups API.
\r
243 * NOTE: The tests implemented in this file are informal 'sanity' tests
\r
244 * only and are not part of the module tests that make use of the
\r
245 * mtCOVERAGE_TEST_MARKER macro within the event groups implementation.
\r
247 * Create the test tasks as described at the top of this file.
\r
249 xTaskCreate( prvTestSlaveTask, "WaitO", configMINIMAL_STACK_SIZE, NULL, ebWAIT_BIT_TASK_PRIORITY, &xTestSlaveTaskHandle );
\r
250 xTaskCreate( prvTestMasterTask, "SetB", configMINIMAL_STACK_SIZE, ( void * ) xTestSlaveTaskHandle, ebSET_BIT_TASK_PRIORITY, NULL );
\r
251 xTaskCreate( prvSyncTask, "Rndv", configMINIMAL_STACK_SIZE, ( void * ) ebRENDESVOUS_TASK_1_SYNC_BIT, ebWAIT_BIT_TASK_PRIORITY, &xSyncTask1 );
\r
252 xTaskCreate( prvSyncTask, "Rndv", configMINIMAL_STACK_SIZE, ( void * ) ebRENDESVOUS_TASK_2_SYNC_BIT, ebWAIT_BIT_TASK_PRIORITY, &xSyncTask2 );
\r
254 /* If the last task was created then the others will have been too. */
\r
255 configASSERT( xSyncTask2 );
\r
257 /* Create the event group used by the ISR tests. The event group used by
\r
258 the tasks is created by the tasks themselves. */
\r
259 xISREventGroup = xEventGroupCreate();
\r
260 configASSERT( xISREventGroup );
\r
262 /*-----------------------------------------------------------*/
\r
264 static void prvTestMasterTask( void *pvParameters )
\r
268 /* The handle to the slave task is passed in as the task parameter. */
\r
269 TaskHandle_t xTestSlaveTaskHandle = ( TaskHandle_t ) pvParameters;
\r
271 /* Avoid compiler warnings. */
\r
272 ( void ) pvParameters;
\r
274 /* Create the event group used by the tasks ready for the initial tests. */
\r
275 xEventGroup = xEventGroupCreate();
\r
276 configASSERT( xEventGroup );
\r
278 /* Perform the tests that block two tasks on different combinations of bits,
\r
279 then set each bit in turn and check the correct tasks unblock at the correct
\r
281 xError = prvSelectiveBitsTestMasterFunction();
\r
285 /* Recreate the event group ready for the next cycle. */
\r
286 xEventGroup = xEventGroupCreate();
\r
287 configASSERT( xEventGroup );
\r
289 /* Perform the tests that check the behaviour when a single task is
\r
290 blocked on various combinations of event bits. */
\r
291 xError = prvBitCombinationTestMasterFunction( xError, xTestSlaveTaskHandle );
\r
293 /* Perform the task synchronisation tests. */
\r
294 xError = prvPerformTaskSyncTests( xError, xTestSlaveTaskHandle );
\r
296 /* Delete the event group. */
\r
297 vEventGroupDelete( xEventGroup );
\r
299 /* Now all the other tasks should have completed and suspended
\r
300 themselves ready for the next go around the loop. */
\r
301 if( eTaskGetState( xTestSlaveTaskHandle ) != eSuspended )
\r
306 if( eTaskGetState( xSyncTask1 ) != eSuspended )
\r
311 if( eTaskGetState( xSyncTask2 ) != eSuspended )
\r
316 /* Only increment the cycle variable if no errors have been detected. */
\r
317 if( xError == pdFALSE )
\r
319 ulTestMasterCycles++;
\r
322 configASSERT( xError == pdFALSE );
\r
325 /*-----------------------------------------------------------*/
\r
327 static void prvSyncTask( void *pvParameters )
\r
329 EventBits_t uxSynchronisationBit, uxReturned;
\r
331 /* A few tests that check the behaviour when two tasks are blocked on
\r
332 various different bits within an event group are performed before this task
\r
333 enters its infinite loop to carry out its main demo function. */
\r
334 prvSelectiveBitsTestSlaveFunction();
\r
336 /* The bit to use to indicate this task is at the synchronisation point is
\r
337 passed in as the task parameter. */
\r
338 uxSynchronisationBit = ( EventBits_t ) pvParameters;
\r
342 /* Now this task takes part in a task synchronisation - sometimes known
\r
343 as a 'rendezvous'. Its execution pattern is controlled by the 'test
\r
344 master' task, which is responsible for taking this task out of the
\r
345 Suspended state when it is time to test the synchronisation behaviour.
\r
346 See: http://www.freertos.org/xEventGroupSync.html. */
\r
347 vTaskSuspend( NULL );
\r
349 /* Set the bit that indicates this task is at the synchronisation
\r
350 point. The first time this is done the 'test master' task has a lower
\r
351 priority than this task so this task will get to the sync point before
\r
352 the set bits task. */
\r
353 uxReturned = xEventGroupSync( xEventGroup, /* The event group used for the synchronisation. */
\r
354 uxSynchronisationBit, /* The bit to set in the event group to indicate this task is at the sync point. */
\r
355 ebALL_SYNC_BITS,/* The bits to wait for - these bits are set by the other tasks taking part in the sync. */
\r
356 portMAX_DELAY );/* The maximum time to wait for the sync condition to be met before giving up. */
\r
358 /* A max delay was used, so this task should only exit the above
\r
359 function call when the sync condition is met. Check this is the
\r
361 configASSERT( ( uxReturned & ebALL_SYNC_BITS ) == ebALL_SYNC_BITS );
\r
363 /* Remove compiler warning if configASSERT() is not defined. */
\r
364 ( void ) uxReturned;
\r
366 /* Wait until the 'test master' task unsuspends this task again. */
\r
367 vTaskSuspend( NULL );
\r
369 /* Set the bit that indicates this task is at the synchronisation
\r
370 point again. This time the 'test master' task has a higher priority
\r
371 than this task so will get to the sync point before this task. */
\r
372 uxReturned = xEventGroupSync( xEventGroup, uxSynchronisationBit, ebALL_SYNC_BITS, portMAX_DELAY );
\r
374 /* Again a max delay was used, so this task should only exit the above
\r
375 function call when the sync condition is met. Check this is the
\r
377 configASSERT( ( uxReturned & ebALL_SYNC_BITS ) == ebALL_SYNC_BITS );
\r
379 /* Block on the event group again. This time the event group is going
\r
380 to be deleted while this task is blocked on it so it is expected that 0
\r
382 uxReturned = xEventGroupWaitBits( xEventGroup, ebALL_SYNC_BITS, pdFALSE, pdTRUE, portMAX_DELAY );
\r
383 configASSERT( uxReturned == 0 );
\r
386 /*-----------------------------------------------------------*/
\r
388 static void prvTestSlaveTask( void *pvParameters )
\r
390 EventBits_t uxReturned;
\r
391 BaseType_t xError = pdFALSE;
\r
393 /* Avoid compiler warnings. */
\r
394 ( void ) pvParameters;
\r
398 /**********************************************************************
\r
399 * Part 1: This section is the counterpart to the
\r
400 * prvBitCombinationTestMasterFunction() function which is called by the
\r
401 * test master task.
\r
402 ***********************************************************************
\r
404 This task is controller by the 'test master' task (which is
\r
405 implemented by prvTestMasterTask()). Suspend until resumed by the
\r
406 'test master' task. */
\r
407 vTaskSuspend( NULL );
\r
409 /* Wait indefinitely for one of the bits in ebCOMBINED_BITS to get
\r
410 set. Clear the bit on exit. */
\r
411 uxReturned = xEventGroupWaitBits( xEventGroup, /* The event group that contains the event bits being queried. */
\r
412 ebBIT_1, /* The bit to wait for. */
\r
413 pdTRUE, /* Clear the bit on exit. */
\r
414 pdTRUE, /* Wait for all the bits (only one in this case anyway). */
\r
415 portMAX_DELAY ); /* Block indefinitely to wait for the condition to be met. */
\r
417 /* The 'test master' task set all the bits defined by ebCOMBINED_BITS,
\r
418 only one of which was being waited for by this task. The return value
\r
419 shows the state of the event bits when the task was unblocked, however
\r
420 because the task was waiting for ebBIT_1 and 'clear on exit' was set to
\r
421 the current state of the event bits will have ebBIT_1 clear. */
\r
422 if( uxReturned != ebCOMBINED_BITS )
\r
427 /* Now call xEventGroupWaitBits() again, this time waiting for all the
\r
428 bits in ebCOMBINED_BITS to be set. This call should block until the
\r
429 'test master' task sets ebBIT_1 - which was the bit cleared in the call
\r
430 to xEventGroupWaitBits() above. */
\r
431 uxReturned = xEventGroupWaitBits( xEventGroup,
\r
432 ebCOMBINED_BITS, /* The bits being waited on. */
\r
433 pdFALSE, /* Don't clear the bits on exit. */
\r
434 pdTRUE, /* All the bits must be set to unblock. */
\r
437 /* Were all the bits set? */
\r
438 if( ( uxReturned & ebCOMBINED_BITS ) != ebCOMBINED_BITS )
\r
443 /* Suspend again to wait for the 'test master' task. */
\r
444 vTaskSuspend( NULL );
\r
446 /* Now call xEventGroupWaitBits() again, again waiting for all the bits
\r
447 in ebCOMBINED_BITS to be set, but this time clearing the bits when the
\r
448 task is unblocked. */
\r
449 uxReturned = xEventGroupWaitBits( xEventGroup,
\r
450 ebCOMBINED_BITS, /* The bits being waited on. */
\r
451 pdTRUE, /* Clear the bits on exit. */
\r
452 pdTRUE, /* All the bits must be set to unblock. */
\r
455 /* The 'test master' task set all the bits in the event group, so that
\r
456 is the value that should have been returned. The bits defined by
\r
457 ebCOMBINED_BITS will have been clear again in the current value though
\r
458 as 'clear on exit' was set to pdTRUE. */
\r
459 if( uxReturned != ebALL_BITS )
\r
468 /**********************************************************************
\r
469 * Part 2: This section is the counterpart to the
\r
470 * prvPerformTaskSyncTests() function which is called by the
\r
471 * test master task.
\r
472 ***********************************************************************
\r
475 Once again wait for the 'test master' task to unsuspend this task
\r
476 when it is time for the next test. */
\r
477 vTaskSuspend( NULL );
\r
479 /* Now peform a synchronisation with all the other tasks. At this point
\r
480 the 'test master' task has the lowest priority so will get to the sync
\r
481 point after all the other synchronising tasks. */
\r
482 uxReturned = xEventGroupSync( xEventGroup, /* The event group used for the sync. */
\r
483 ebWAIT_BIT_TASK_SYNC_BIT, /* The bit in the event group used to indicate this task is at the sync point. */
\r
484 ebALL_SYNC_BITS, /* The bits to wait for. These bits are set by the other tasks taking part in the sync. */
\r
485 portMAX_DELAY ); /* The maximum time to wait for the sync condition to be met before giving up. */
\r
487 /* A sync with a max delay should only exit when all the synchronisation
\r
489 if( ( uxReturned & ebALL_SYNC_BITS ) != ebALL_SYNC_BITS )
\r
494 /* ...but now the synchronisation bits should be clear again. Read back
\r
495 the current value of the bits within the event group to check that is
\r
496 the case. Setting the bits to zero will return the bits previous value
\r
497 then leave all the bits clear. */
\r
498 if( xEventGroupSetBits( xEventGroup, 0x00 ) != 0 )
\r
503 /* Check the bits are indeed 0 now by simply reading then. */
\r
504 if( xEventGroupGetBits( xEventGroup ) != 0 )
\r
509 if( xError == pdFALSE )
\r
511 /* This task is still cycling without finding an error. */
\r
512 ulTestSlaveCycles++;
\r
515 vTaskSuspend( NULL );
\r
517 /* This time sync when the 'test master' task has the highest priority
\r
518 at the point where it sets its sync bit - so this time the 'test master'
\r
519 task will get to the sync point before this task. */
\r
520 uxReturned = xEventGroupSync( xEventGroup, ebWAIT_BIT_TASK_SYNC_BIT, ebALL_SYNC_BITS, portMAX_DELAY );
\r
522 /* A sync with a max delay should only exit when all the synchronisation
\r
524 if( ( uxReturned & ebALL_SYNC_BITS ) != ebALL_SYNC_BITS )
\r
529 /* ...but now the sync bits should be clear again. */
\r
530 if( xEventGroupSetBits( xEventGroup, 0x00 ) != 0 )
\r
535 /* Block on the event group again. This time the event group is going
\r
536 to be deleted while this task is blocked on it, so it is expected that 0
\r
537 will be returned. */
\r
538 uxReturned = xEventGroupWaitBits( xEventGroup, ebALL_SYNC_BITS, pdFALSE, pdTRUE, portMAX_DELAY );
\r
540 if( uxReturned != 0 )
\r
545 if( xError == pdFALSE )
\r
547 /* This task is still cycling without finding an error. */
\r
548 ulTestSlaveCycles++;
\r
551 configASSERT( xError == pdFALSE );
\r
554 /*-----------------------------------------------------------*/
\r
556 static BaseType_t prvPerformTaskSyncTests( BaseType_t xError, TaskHandle_t xTestSlaveTaskHandle )
\r
558 EventBits_t uxBits;
\r
560 /* The three tasks that take part in the synchronisation (rendezvous) are
\r
561 expected to be in the suspended state at the start of the test. */
\r
562 if( eTaskGetState( xTestSlaveTaskHandle ) != eSuspended )
\r
567 if( eTaskGetState( xSyncTask1 ) != eSuspended )
\r
572 if( eTaskGetState( xSyncTask2 ) != eSuspended )
\r
577 /* Try a synch with no other tasks involved. First set all the bits other
\r
578 than this task's bit. */
\r
579 xEventGroupSetBits( xEventGroup, ( ebALL_SYNC_BITS & ~ebSET_BIT_TASK_SYNC_BIT ) );
\r
581 /* Then wait on just one bit - the bit that is being set. */
\r
582 uxBits = xEventGroupSync( xEventGroup, /* The event group used for the synchronisation. */
\r
583 ebSET_BIT_TASK_SYNC_BIT,/* The bit set by this task when it reaches the sync point. */
\r
584 ebSET_BIT_TASK_SYNC_BIT,/* The bits to wait for - in this case it is just waiting for itself. */
\r
585 portMAX_DELAY ); /* The maximum time to wait for the sync condition to be met. */
\r
587 /* A sync with a max delay should only exit when all the synchronise
\r
588 bits are set...check that is the case. In this case there is only one
\r
589 sync bit anyway. */
\r
590 if( ( uxBits & ebSET_BIT_TASK_SYNC_BIT ) != ebSET_BIT_TASK_SYNC_BIT )
\r
595 /* ...but now the sync bits should be clear again, leaving all the other
\r
596 bits set (as only one bit was being waited for). */
\r
597 if( xEventGroupGetBits( xEventGroup ) != ( ebALL_SYNC_BITS & ~ebSET_BIT_TASK_SYNC_BIT ) )
\r
602 /* Clear all the bits to zero again. */
\r
603 xEventGroupClearBits( xEventGroup, ( ebALL_SYNC_BITS & ~ebSET_BIT_TASK_SYNC_BIT ) );
\r
604 if( xEventGroupGetBits( xEventGroup ) != 0 )
\r
609 /* Unsuspend the other tasks then check they have executed up to the
\r
610 synchronisation point. */
\r
611 vTaskResume( xTestSlaveTaskHandle );
\r
612 vTaskResume( xSyncTask1 );
\r
613 vTaskResume( xSyncTask2 );
\r
615 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
620 if( eTaskGetState( xSyncTask1 ) != eBlocked )
\r
625 if( eTaskGetState( xSyncTask2 ) != eBlocked )
\r
630 /* Set this task's sync bit. */
\r
631 uxBits = xEventGroupSync( xEventGroup, /* The event group used for the synchronisation. */
\r
632 ebSET_BIT_TASK_SYNC_BIT,/* The bit set by this task when it reaches the sync point. */
\r
633 ebALL_SYNC_BITS, /* The bits to wait for - these bits are set by the other tasks that take part in the sync. */
\r
634 portMAX_DELAY ); /* The maximum time to wait for the sync condition to be met. */
\r
636 /* A sync with a max delay should only exit when all the synchronise
\r
637 bits are set...check that is the case. */
\r
638 if( ( uxBits & ebALL_SYNC_BITS ) != ebALL_SYNC_BITS )
\r
643 /* ...but now the sync bits should be clear again. */
\r
644 if( xEventGroupGetBits( xEventGroup ) != 0 )
\r
650 /* The other tasks should now all be suspended again, ready for the next
\r
651 synchronisation. */
\r
652 if( eTaskGetState( xTestSlaveTaskHandle ) != eSuspended )
\r
657 if( eTaskGetState( xSyncTask1 ) != eSuspended )
\r
662 if( eTaskGetState( xSyncTask2 ) != eSuspended )
\r
668 /* Sync again - but this time set the last necessary bit as the
\r
669 highest priority task, rather than the lowest priority task. Unsuspend
\r
670 the other tasks then check they have executed up to the synchronisation
\r
672 vTaskResume( xTestSlaveTaskHandle );
\r
673 vTaskResume( xSyncTask1 );
\r
674 vTaskResume( xSyncTask2 );
\r
676 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
681 if( eTaskGetState( xSyncTask1 ) != eBlocked )
\r
686 if( eTaskGetState( xSyncTask2 ) != eBlocked )
\r
691 /* Raise the priority of this task above that of the other tasks. */
\r
692 vTaskPrioritySet( NULL, ebWAIT_BIT_TASK_PRIORITY + 1 );
\r
694 /* Set this task's sync bit. */
\r
695 uxBits = xEventGroupSync( xEventGroup, ebSET_BIT_TASK_SYNC_BIT, ebALL_SYNC_BITS, portMAX_DELAY );
\r
697 /* A sync with a max delay should only exit when all the synchronisation
\r
699 if( ( uxBits & ebALL_SYNC_BITS ) != ebALL_SYNC_BITS )
\r
704 /* ...but now the sync bits should be clear again. */
\r
705 if( xEventGroupGetBits( xEventGroup ) != 0 )
\r
711 /* The other tasks should now all be in the ready state again, but not
\r
712 executed yet as this task still has a higher relative priority. */
\r
713 if( eTaskGetState( xTestSlaveTaskHandle ) != eReady )
\r
718 if( eTaskGetState( xSyncTask1 ) != eReady )
\r
723 if( eTaskGetState( xSyncTask2 ) != eReady )
\r
729 /* Reset the priority of this task back to its original value. */
\r
730 vTaskPrioritySet( NULL, ebSET_BIT_TASK_PRIORITY );
\r
732 /* Now all the other tasks should have reblocked on the event bits
\r
733 to test the behaviour when the event bits are deleted. */
\r
734 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
739 if( eTaskGetState( xSyncTask1 ) != eBlocked )
\r
744 if( eTaskGetState( xSyncTask2 ) != eBlocked )
\r
751 /*-----------------------------------------------------------*/
\r
753 static BaseType_t prvBitCombinationTestMasterFunction( BaseType_t xError, TaskHandle_t xTestSlaveTaskHandle )
\r
755 EventBits_t uxBits;
\r
757 /* Resume the other task. It will block, pending a single bit from
\r
758 within ebCOMBINED_BITS. */
\r
759 vTaskResume( xTestSlaveTaskHandle );
\r
761 /* Ensure the other task is blocked on the task. */
\r
762 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
767 /* Set all the bits in ebCOMBINED_BITS - the 'test slave' task is only
\r
768 blocked waiting for one of them. */
\r
769 xEventGroupSetBits( xEventGroup, ebCOMBINED_BITS );
\r
771 /* The 'test slave' task should now have executed, clearing ebBIT_1 (the
\r
772 bit it was blocked on), then re-entered the Blocked state to wait for
\r
773 all the other bits in ebCOMBINED_BITS to be set again. First check
\r
774 ebBIT_1 is clear. */
\r
775 uxBits = xEventGroupWaitBits( xEventGroup, ebALL_BITS, pdFALSE, pdFALSE, ebDONT_BLOCK );
\r
777 if( uxBits != ( ebCOMBINED_BITS & ~ebBIT_1 ) )
\r
782 /* Ensure the other task is still in the blocked state. */
\r
783 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
788 /* Set all the bits other than ebBIT_1 - which is the bit that must be
\r
789 set before the other task unblocks. */
\r
790 xEventGroupSetBits( xEventGroup, ebALL_BITS & ~ebBIT_1 );
\r
792 /* Ensure all the expected bits are still set. */
\r
793 uxBits = xEventGroupWaitBits( xEventGroup, ebALL_BITS, pdFALSE, pdFALSE, ebDONT_BLOCK );
\r
795 if( uxBits != ( ebALL_BITS & ~ebBIT_1 ) )
\r
800 /* Ensure the other task is still in the blocked state. */
\r
801 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
806 /* Now also set ebBIT_1, which should unblock the other task, which will
\r
807 then suspend itself. */
\r
808 xEventGroupSetBits( xEventGroup, ebBIT_1 );
\r
810 /* Ensure the other task is suspended. */
\r
811 if( eTaskGetState( xTestSlaveTaskHandle ) != eSuspended )
\r
816 /* The other task should not have cleared the bits - so all the bits
\r
817 should still be set. */
\r
818 if( xEventGroupSetBits( xEventGroup, 0x00 ) != ebALL_BITS )
\r
823 /* Clear ebBIT_1 again. */
\r
824 if( xEventGroupClearBits( xEventGroup, ebBIT_1 ) != ebALL_BITS )
\r
829 /* Resume the other task - which will wait on all the ebCOMBINED_BITS
\r
830 again - this time clearing the bits when it is unblocked. */
\r
831 vTaskResume( xTestSlaveTaskHandle );
\r
833 /* Ensure the other task is blocked once again. */
\r
834 if( eTaskGetState( xTestSlaveTaskHandle ) != eBlocked )
\r
839 /* Set the bit the other task is waiting for. */
\r
840 xEventGroupSetBits( xEventGroup, ebBIT_1 );
\r
842 /* Ensure the other task is suspended once again. */
\r
843 if( eTaskGetState( xTestSlaveTaskHandle ) != eSuspended )
\r
848 /* The other task should have cleared the bits in ebCOMBINED_BITS.
\r
849 Clear the remaining bits. */
\r
850 uxBits = xEventGroupWaitBits( xEventGroup, ebALL_BITS, pdFALSE, pdFALSE, ebDONT_BLOCK );
\r
852 if( uxBits != ( ebALL_BITS & ~ebCOMBINED_BITS ) )
\r
857 /* Clear all bits ready for the sync with the other three tasks. The
\r
858 value returned is the value prior to the bits being cleared. */
\r
859 if( xEventGroupClearBits( xEventGroup, ebALL_BITS ) != ( ebALL_BITS & ~ebCOMBINED_BITS ) )
\r
864 /* The bits should be clear now. */
\r
865 if( xEventGroupGetBits( xEventGroup ) != 0x00 )
\r
872 /*-----------------------------------------------------------*/
\r
874 static void prvSelectiveBitsTestSlaveFunction( void )
\r
876 EventBits_t uxPendBits, uxReturned;
\r
878 /* Used in a test that blocks two tasks on various different bits within an
\r
879 event group - then sets each bit in turn and checks that the correct tasks
\r
880 unblock at the correct times.
\r
882 This function is called by two different tasks - each of which will use a
\r
883 different bit. Check the task handle to see which task the function was
\r
885 if( xTaskGetCurrentTaskHandle() == xSyncTask1 )
\r
887 uxPendBits = ebSELECTIVE_BITS_1;
\r
891 uxPendBits = ebSELECTIVE_BITS_2;
\r
896 /* Wait until it is time to perform the next cycle of the test. The
\r
897 task is unsuspended by the tests implemented in the
\r
898 prvSelectiveBitsTestMasterFunction() function. */
\r
899 vTaskSuspend( NULL );
\r
900 uxReturned = xEventGroupWaitBits( xEventGroup, uxPendBits, pdTRUE, pdFALSE, portMAX_DELAY );
\r
902 if( uxReturned == ( EventBits_t ) 0 )
\r
908 /*-----------------------------------------------------------*/
\r
910 static BaseType_t prvSelectiveBitsTestMasterFunction( void )
\r
912 BaseType_t xError = pdFALSE;
\r
915 /* Used in a test that blocks two tasks on various different bits within an
\r
916 event group - then sets each bit in turn and checks that the correct tasks
\r
917 unblock at the correct times. The two other tasks (xSyncTask1 and
\r
918 xSyncTask2) call prvSelectiveBitsTestSlaveFunction() to perform their parts in
\r
921 Both other tasks should start in the suspended state. */
\r
922 if( eTaskGetState( xSyncTask1 ) != eSuspended )
\r
927 if( eTaskGetState( xSyncTask2 ) != eSuspended )
\r
932 /* Test each bit in the byte individually. */
\r
933 for( uxBit = 0x01; uxBit < 0x100; uxBit <<= 1 )
\r
935 /* Resume both tasks. */
\r
936 vTaskResume( xSyncTask1 );
\r
937 vTaskResume( xSyncTask2 );
\r
939 /* Now both tasks should be blocked on the event group. */
\r
940 if( eTaskGetState( xSyncTask1 ) != eBlocked )
\r
945 if( eTaskGetState( xSyncTask2 ) != eBlocked )
\r
951 xEventGroupSetBits( xEventGroup, uxBit );
\r
953 /* Is the bit set in the first set of selective bits? If so the first
\r
954 sync task should have unblocked and returned to the suspended state. */
\r
955 if( ( uxBit & ebSELECTIVE_BITS_1 ) == 0 )
\r
957 /* Task should not have unblocked. */
\r
958 if( eTaskGetState( xSyncTask1 ) != eBlocked )
\r
965 /* Task should have unblocked and returned to the suspended state. */
\r
966 if( eTaskGetState( xSyncTask1 ) != eSuspended )
\r
972 /* Same checks for the second sync task. */
\r
973 if( ( uxBit & ebSELECTIVE_BITS_2 ) == 0 )
\r
975 /* Task should not have unblocked. */
\r
976 if( eTaskGetState( xSyncTask2 ) != eBlocked )
\r
983 /* Task should have unblocked and returned to the suspended state. */
\r
984 if( eTaskGetState( xSyncTask2 ) != eSuspended )
\r
991 /* Ensure both tasks are blocked on the event group again, then delete the
\r
992 event group so the other tasks leave this portion of the test. */
\r
993 vTaskResume( xSyncTask1 );
\r
994 vTaskResume( xSyncTask2 );
\r
996 /* Deleting the event group is the signal that the two other tasks should
\r
997 leave the prvSelectiveBitsTestSlaveFunction() function and continue to the main
\r
998 part of their functionality. */
\r
999 vEventGroupDelete( xEventGroup );
\r
1003 /*-----------------------------------------------------------*/
\r
1005 void vPeriodicEventGroupsProcessing( void )
\r
1007 static BaseType_t xCallCount = 0, xISRTestError = pdFALSE;
\r
1008 const BaseType_t xSetBitCount = 100, xGetBitsCount = 200, xClearBitsCount = 300;
\r
1009 const EventBits_t uxBitsToSet = 0x12U;
\r
1010 EventBits_t uxReturned;
\r
1011 BaseType_t xMessagePosted;
\r
1013 /* Called periodically from the tick hook to exercise the "FromISR"
\r
1018 if( xCallCount == xSetBitCount )
\r
1020 /* All the event bits should start clear. */
\r
1021 uxReturned = xEventGroupGetBitsFromISR( xISREventGroup );
\r
1022 if( uxReturned != 0x00 )
\r
1024 xISRTestError = pdTRUE;
\r
1028 /* Set the bits. This is called from the tick hook so it is not
\r
1029 necessary to use the last parameter to ensure a context switch
\r
1030 occurs immediately. */
\r
1031 xMessagePosted = xEventGroupSetBitsFromISR( xISREventGroup, uxBitsToSet, NULL );
\r
1032 if( xMessagePosted != pdPASS )
\r
1034 xISRTestError = pdTRUE;
\r
1038 else if( xCallCount == xGetBitsCount )
\r
1040 /* Check the bits were set as expected. */
\r
1041 uxReturned = xEventGroupGetBitsFromISR( xISREventGroup );
\r
1042 if( uxReturned != uxBitsToSet )
\r
1044 xISRTestError = pdTRUE;
\r
1047 else if( xCallCount == xClearBitsCount )
\r
1049 /* Clear the bits again. */
\r
1050 uxReturned = xEventGroupClearBitsFromISR( xISREventGroup, uxBitsToSet );
\r
1052 /* Check the message was posted. */
\r
1053 if( uxReturned != pdPASS )
\r
1055 xISRTestError = pdTRUE;
\r
1058 /* Go back to the start. */
\r
1061 /* If no errors have been detected then increment the count of test
\r
1063 if( xISRTestError == pdFALSE )
\r
1070 /* Nothing else to do. */
\r
1074 /*-----------------------------------------------------------*/
\r
1075 /* This is called to check that all the created tasks are still running. */
\r
1076 BaseType_t xAreEventGroupTasksStillRunning( void )
\r
1078 static uint32_t ulPreviousWaitBitCycles = 0, ulPreviousSetBitCycles = 0, ulPreviousISRCycles = 0;
\r
1079 BaseType_t xStatus = pdPASS;
\r
1081 /* Check the tasks are still cycling without finding any errors. */
\r
1082 if( ulPreviousSetBitCycles == ulTestMasterCycles )
\r
1086 ulPreviousSetBitCycles = ulTestMasterCycles;
\r
1088 if( ulPreviousWaitBitCycles == ulTestSlaveCycles )
\r
1092 ulPreviousWaitBitCycles = ulTestSlaveCycles;
\r
1094 if( ulPreviousISRCycles == ulISRCycles )
\r
1098 ulPreviousISRCycles = ulISRCycles;
\r