2 FreeRTOS V6.0.0 - Copyright (C) 2009 Real Time Engineers Ltd.
\r
4 This file is part of the FreeRTOS distribution.
\r
6 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
7 the terms of the GNU General Public License (version 2) as published by the
\r
8 Free Software Foundation and modified by the FreeRTOS exception.
\r
9 **NOTE** The exception to the GPL is included to allow you to distribute a
\r
10 combined work that includes FreeRTOS without being obliged to provide the
\r
11 source code for proprietary components outside of the FreeRTOS kernel.
\r
12 Alternative commercial license and support terms are also available upon
\r
13 request. See the licensing section of http://www.FreeRTOS.org for full
\r
16 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
18 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
21 You should have received a copy of the GNU General Public License along
\r
22 with FreeRTOS; if not, write to the Free Software Foundation, Inc., 59
\r
23 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
26 ***************************************************************************
\r
28 * The FreeRTOS eBook and reference manual are available to purchase for a *
\r
29 * small fee. Help yourself get started quickly while also helping the *
\r
30 * FreeRTOS project! See http://www.FreeRTOS.org/Documentation for details *
\r
32 ***************************************************************************
\r
36 Please ensure to read the configuration and relevant port sections of the
\r
37 online documentation.
\r
39 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
42 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
45 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
46 licensing and training services.
\r
50 * Creates all the demo application tasks and co-routines, then starts the
\r
53 * Main. c also creates a task called "Print". This only executes every
\r
54 * five seconds but has the highest priority so is guaranteed to get
\r
55 * processor time. Its main function is to check that all the other tasks
\r
56 * are still operational. Nearly all the tasks in the demo application
\r
57 * maintain a unique count that is incremented each time the task successfully
\r
58 * completes its function. Should any error occur within the task the count is
\r
59 * permanently halted. The print task checks the count of each task to ensure
\r
60 * it has changed since the last time the print task executed. If any count is
\r
61 * found not to have changed the print task displays an appropriate message.
\r
62 * If all the tasks are still incrementing their unique counts the print task
\r
63 * displays an "OK" message.
\r
65 * The LED flash tasks do not maintain a count as they already provide visual
\r
66 * feedback of their status.
\r
68 * The print task blocks on the queue into which messages that require
\r
69 * displaying are posted. It will therefore only block for the full 5 seconds
\r
70 * if no messages are posted onto the queue.
\r
72 * Main. c also provides a demonstration of how the trace visualisation utility
\r
73 * can be used, and how the scheduler can be stopped.
\r
75 * \page MainC main.c
\r
76 * \ingroup DemoFiles
\r
82 #include "FreeRTOS.h"
\r
84 #include "croutine.h"
\r
85 #include "partest.h"
\r
88 /* Demo file headers. */
\r
92 #include "crflash.h"
\r
95 #include "comtest.h"
\r
97 #include "semtest.h"
\r
98 #include "integer.h"
\r
99 #include "dynamic.h"
\r
100 #include "mevents.h"
\r
101 #include "crhook.h"
\r
102 #include "blocktim.h"
\r
103 #include "AltBlock.h"
\r
104 #include "GenQTest.h"
\r
106 #include "countsem.h"
\r
107 #include "AltQTest.h"
\r
108 #include "AltPollQ.h"
\r
109 #include "AltBlckQ.h"
\r
110 #include "RecMutex.h"
\r
112 /* Priority definitions for the tasks in the demo application. */
\r
113 #define mainLED_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
114 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
115 #define mainPRINT_TASK_PRIORITY ( tskIDLE_PRIORITY + 4 )
\r
116 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
117 #define mainQUEUE_BLOCK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
118 #define mainCOM_TEST_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
119 #define mainSEMAPHORE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
120 #define mainGENERIC_QUEUE_PRIORITY ( tskIDLE_PRIORITY )
\r
122 #define mainPRINT_STACK_SIZE ( ( unsigned short ) 512 )
\r
123 #define mainDEBUG_LOG_BUFFER_SIZE ( ( unsigned short ) 20480 )
\r
125 /* The number of flash co-routines to create. */
\r
126 #define mainNUM_FLASH_CO_ROUTINES ( 8 )
\r
128 /* Task function for the "Print" task as described at the top of the file. */
\r
129 static void vErrorChecks( void *pvParameters );
\r
131 /* Function that checks the unique count of all the other tasks as described at
\r
132 the top of the file. */
\r
133 static void prvCheckOtherTasksAreStillRunning( void );
\r
135 /* Key presses can be used to start/stop the trace visualisation utility or stop
\r
137 static void prvCheckForKeyPresses( void );
\r
139 /* Buffer used by the trace visualisation utility so only needed if the trace
\r
141 #if configUSE_TRACE_FACILITY == 1
\r
142 static char pcWriteBuffer[ mainDEBUG_LOG_BUFFER_SIZE ];
\r
145 /* Constant definition used to turn on/off the pre-emptive scheduler. */
\r
146 static const short sUsingPreemption = configUSE_PREEMPTION;
\r
148 /* Start the math tasks appropriate to the build. The Borland port does
\r
149 not yet support floating point so uses the integer equivalent. */
\r
150 static void prvStartMathTasks( void );
\r
152 /* Check which ever tasks are relevant to this build. */
\r
153 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void );
\r
155 /* Used to demonstrate the "task switched in" callback function. */
\r
156 static portBASE_TYPE prvExampleTaskHook( void * pvParameter );
\r
158 /* Just used to count the number of times the example task callback function is
\r
159 called, and the number of times a queue send passes. */
\r
160 static unsigned long long uxCheckTaskHookCallCount = 0;
\r
161 static unsigned long long uxQueueSendPassedCount = 0;
\r
163 /*-----------------------------------------------------------*/
\r
167 /* Initialise hardware and utilities. */
\r
168 vParTestInitialise();
\r
169 vPrintInitialise();
\r
171 /* CREATE ALL THE DEMO APPLICATION TASKS. */
\r
172 prvStartMathTasks();
\r
173 vStartComTestTasks( mainCOM_TEST_PRIORITY, serCOM1, ser115200 );
\r
174 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
175 vStartBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
176 vCreateBlockTimeTasks();
\r
177 vStartGenericQueueTasks( mainGENERIC_QUEUE_PRIORITY );
\r
178 vStartSemaphoreTasks( mainSEMAPHORE_TASK_PRIORITY );
\r
179 vStartDynamicPriorityTasks();
\r
180 vStartMultiEventTasks();
\r
181 vStartQueuePeekTasks();
\r
182 vStartCountingSemaphoreTasks();
\r
183 vStartAltGenericQueueTasks( mainGENERIC_QUEUE_PRIORITY );
\r
184 vCreateAltBlockTimeTasks();
\r
185 vStartAltBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
186 vStartAltPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
187 vStartRecursiveMutexTasks();
\r
189 /* Create the "Print" task as described at the top of the file. */
\r
190 xTaskCreate( vErrorChecks, "Print", mainPRINT_STACK_SIZE, NULL, mainPRINT_TASK_PRIORITY, NULL );
\r
192 /* This task has to be created last as it keeps account of the number of tasks
\r
193 it expects to see running. */
\r
194 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
196 /* Create the co-routines that flash the LED's. */
\r
197 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
199 /* Create the co-routines that communicate with the tick hook. */
\r
200 vStartHookCoRoutines();
\r
202 /* Set the scheduler running. This function will not return unless a task
\r
203 calls vTaskEndScheduler(). */
\r
204 vTaskStartScheduler();
\r
208 /*-----------------------------------------------------------*/
\r
210 static portBASE_TYPE prvExampleTaskHook( void * pvParameter )
\r
212 if( pvParameter != ( void * ) 0xabcd )
\r
214 /* The parameter did not contain the value we expected, so cause an
\r
215 error to be detected by setting the call count back to zero. */
\r
216 uxCheckTaskHookCallCount = 0;
\r
220 /* Simply increment a number so we know the callback has been executed. */
\r
221 uxCheckTaskHookCallCount++;
\r
226 /*-----------------------------------------------------------*/
\r
228 void vMainQueueSendPassed( void )
\r
230 /* This is just an example implementation of the "queue send" trace hook. */
\r
231 uxQueueSendPassedCount++;
\r
233 /*-----------------------------------------------------------*/
\r
235 static void vErrorChecks( void *pvParameters )
\r
237 portTickType xExpectedWakeTime;
\r
238 const portTickType xPrintRate = ( portTickType ) 5000 / portTICK_RATE_MS;
\r
239 const long lMaxAllowableTimeDifference = ( long ) 0;
\r
240 portTickType xWakeTime;
\r
241 long lTimeDifference;
\r
242 const char *pcReceivedMessage;
\r
243 const char * const pcTaskBlockedTooLongMsg = "Print task blocked too long!\r\n";
\r
244 const char * const pcUnexpectedHookValueMsg = "Task hook has unexpected value!\r\n";
\r
246 ( void ) pvParameters;
\r
248 /* Register our callback function. */
\r
249 vTaskSetApplicationTaskTag( NULL, prvExampleTaskHook );
\r
251 /* Just for test purposes. */
\r
252 if( xTaskGetApplicationTaskTag( NULL ) != prvExampleTaskHook )
\r
254 vPrintDisplayMessage( &pcUnexpectedHookValueMsg );
\r
257 /* Loop continuously, blocking, then checking all the other tasks are still
\r
258 running, before blocking once again. This task blocks on the queue of
\r
259 messages that require displaying so will wake either by its time out expiring,
\r
260 or a message becoming available. */
\r
263 /* Calculate the time we will unblock if no messages are received
\r
264 on the queue. This is used to check that we have not blocked for too long. */
\r
265 xExpectedWakeTime = xTaskGetTickCount();
\r
266 xExpectedWakeTime += xPrintRate;
\r
268 /* Block waiting for either a time out or a message to be posted that
\r
269 required displaying. */
\r
270 pcReceivedMessage = pcPrintGetNextMessage( xPrintRate );
\r
272 /* Was a message received? */
\r
273 if( pcReceivedMessage == NULL )
\r
275 /* A message was not received so we timed out, did we unblock at the
\r
277 xWakeTime = xTaskGetTickCount();
\r
279 /* Calculate the difference between the time we unblocked and the
\r
280 time we should have unblocked. */
\r
281 if( xWakeTime > xExpectedWakeTime )
\r
283 lTimeDifference = ( long ) ( xWakeTime - xExpectedWakeTime );
\r
287 lTimeDifference = ( long ) ( xExpectedWakeTime - xWakeTime );
\r
290 if( lTimeDifference > lMaxAllowableTimeDifference )
\r
292 /* We blocked too long - create a message that will get
\r
293 printed out the next time around. If we are not using
\r
294 preemption then we won't expect the timing to be so
\r
296 if( sUsingPreemption == pdTRUE )
\r
298 vPrintDisplayMessage( &pcTaskBlockedTooLongMsg );
\r
302 /* Check the other tasks are still running, just in case. */
\r
303 prvCheckOtherTasksAreStillRunning();
\r
307 /* We unblocked due to a message becoming available. Send the message
\r
309 vDisplayMessage( pcReceivedMessage );
\r
312 /* Key presses are used to invoke the trace visualisation utility, or end
\r
314 prvCheckForKeyPresses();
\r
317 /*-----------------------------------------------------------*/
\r
319 static void prvCheckForKeyPresses( void )
\r
323 taskENTER_CRITICAL();
\r
325 /* kbhit can be used in .exe's that are executed from the command
\r
326 line, but not if executed through the debugger. */
\r
331 taskEXIT_CRITICAL();
\r
335 /* Key presses can be used to start/stop the trace utility, or end the
\r
340 /* Only define keys for turning on and off the trace if the trace
\r
342 #if configUSE_TRACE_FACILITY == 1
\r
343 case 't' : vTaskList( pcWriteBuffer );
\r
344 vWriteMessageToDisk( pcWriteBuffer );
\r
346 case 's' : vTaskStartTrace( pcWriteBuffer, mainDEBUG_LOG_BUFFER_SIZE );
\r
350 unsigned long ulBufferLength;
\r
351 ulBufferLength = ulTaskEndTrace();
\r
352 vWriteBufferToDisk( pcWriteBuffer, ulBufferLength );
\r
357 default : vTaskEndScheduler();
\r
362 /*-----------------------------------------------------------*/
\r
364 static void prvCheckOtherTasksAreStillRunning( void )
\r
366 static short sErrorHasOccurred = pdFALSE;
\r
367 static unsigned long long uxLastHookCallCount = 0, uxLastQueueSendCount = 0;
\r
369 if( prvCheckMathTasksAreStillRunning() != pdTRUE )
\r
371 vDisplayMessage( "Maths task count unchanged!\r\n" );
\r
372 sErrorHasOccurred = pdTRUE;
\r
375 if( xAreComTestTasksStillRunning() != pdTRUE )
\r
377 vDisplayMessage( "Com test count unchanged!\r\n" );
\r
378 sErrorHasOccurred = pdTRUE;
\r
381 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
383 vDisplayMessage( "Blocking queues count unchanged!\r\n" );
\r
384 sErrorHasOccurred = pdTRUE;
\r
387 if( xAreAltBlockingQueuesStillRunning() != pdTRUE )
\r
389 vDisplayMessage( "Alt blocking queues count unchanged!\r\n" );
\r
390 sErrorHasOccurred = pdTRUE;
\r
393 if( xArePollingQueuesStillRunning() != pdTRUE )
\r
395 vDisplayMessage( "Polling queue count unchanged!\r\n" );
\r
396 sErrorHasOccurred = pdTRUE;
\r
399 if( xAreAltPollingQueuesStillRunning() != pdTRUE )
\r
401 vDisplayMessage( "Alt polling queue count unchanged!\r\n" );
\r
402 sErrorHasOccurred = pdTRUE;
\r
405 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
407 vDisplayMessage( "Incorrect number of tasks running!\r\n" );
\r
408 sErrorHasOccurred = pdTRUE;
\r
411 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
413 vDisplayMessage( "Semaphore take count unchanged!\r\n" );
\r
414 sErrorHasOccurred = pdTRUE;
\r
417 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
419 vDisplayMessage( "Dynamic priority count unchanged!\r\n" );
\r
420 sErrorHasOccurred = pdTRUE;
\r
423 if( xAreMultiEventTasksStillRunning() != pdTRUE )
\r
425 vDisplayMessage( "Error in multi events tasks!\r\n" );
\r
426 sErrorHasOccurred = pdTRUE;
\r
429 if( xAreFlashCoRoutinesStillRunning() != pdTRUE )
\r
431 vDisplayMessage( "Error in co-routine flash tasks!\r\n" );
\r
432 sErrorHasOccurred = pdTRUE;
\r
435 if( xAreHookCoRoutinesStillRunning() != pdTRUE )
\r
437 vDisplayMessage( "Error in tick hook to co-routine communications!\r\n" );
\r
438 sErrorHasOccurred = pdTRUE;
\r
441 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
443 vDisplayMessage( "Error in block time test tasks!\r\n" );
\r
444 sErrorHasOccurred = pdTRUE;
\r
447 if( xAreAltBlockTimeTestTasksStillRunning() != pdTRUE )
\r
449 vDisplayMessage( "Error in fast block time test tasks!\r\n" );
\r
450 sErrorHasOccurred = pdTRUE;
\r
453 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
455 vDisplayMessage( "Error in generic queue test task!\r\n" );
\r
456 sErrorHasOccurred = pdTRUE;
\r
459 if( xAreAltGenericQueueTasksStillRunning() != pdTRUE )
\r
461 vDisplayMessage( "Error in fast generic queue test task!\r\n" );
\r
462 sErrorHasOccurred = pdTRUE;
\r
465 if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
467 vDisplayMessage( "Error in queue peek test task!\r\n" );
\r
468 sErrorHasOccurred = pdTRUE;
\r
471 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
473 vDisplayMessage( "Error in counting semaphore demo task!\r\n" );
\r
474 sErrorHasOccurred = pdTRUE;
\r
477 if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
479 vDisplayMessage( "Error in recursive mutex tasks!\r\n" );
\r
480 sErrorHasOccurred = pdTRUE;
\r
483 /* The hook function associated with this task is called each time the task
\r
484 is switched in. We therefore expect the number of times the callback
\r
485 function has been executed to have increrment since the last time this
\r
486 function executed. */
\r
487 if( uxCheckTaskHookCallCount <= uxLastHookCallCount )
\r
489 vDisplayMessage( "Error in task hook call count!\r\n" );
\r
490 sErrorHasOccurred = pdTRUE;
\r
494 uxLastHookCallCount = uxCheckTaskHookCallCount;
\r
497 /* We would expect some queue sending to occur between calls of this
\r
499 if( uxQueueSendPassedCount <= uxLastQueueSendCount )
\r
501 vDisplayMessage( "Error in queue send hook call count!\r\n" );
\r
502 sErrorHasOccurred = pdTRUE;
\r
506 uxLastQueueSendCount = uxQueueSendPassedCount;
\r
509 if( sErrorHasOccurred == pdFALSE )
\r
511 vDisplayMessage( "OK " );
\r
514 /*-----------------------------------------------------------*/
\r
516 static void prvStartMathTasks( void )
\r
518 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
519 /* The Borland project does not yet support floating point. */
\r
520 vStartIntegerMathTasks( tskIDLE_PRIORITY );
\r
522 vStartMathTasks( tskIDLE_PRIORITY );
\r
525 /*-----------------------------------------------------------*/
\r
527 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void )
\r
529 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
530 /* The Borland project does not yet support floating point. */
\r
531 return xAreIntegerMathsTaskStillRunning();
\r
533 return xAreMathsTaskStillRunning();
\r
536 /*-----------------------------------------------------------*/
\r
538 void vApplicationIdleHook( void )
\r
540 /* The co-routines are executed in the idle task using the idle task
\r
542 vCoRoutineSchedule();
\r
544 /*-----------------------------------------------------------*/
\r