2 FreeRTOS.org V5.2.0 - Copyright (C) 2003-2009 Richard Barry.
\r
4 This file is part of the FreeRTOS.org distribution.
\r
6 FreeRTOS.org is free software; you can redistribute it and/or modify it
\r
7 under the terms of the GNU General Public License (version 2) as published
\r
8 by the Free Software Foundation and modified by the FreeRTOS exception.
\r
10 FreeRTOS.org is distributed in the hope that it will be useful, but WITHOUT
\r
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
15 You should have received a copy of the GNU General Public License along
\r
16 with FreeRTOS.org; if not, write to the Free Software Foundation, Inc., 59
\r
17 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
\r
19 A special exception to the GPL is included to allow you to distribute a
\r
20 combined work that includes FreeRTOS.org without being obliged to provide
\r
21 the source code for any proprietary components. See the licensing section
\r
22 of http://www.FreeRTOS.org for full details.
\r
25 ***************************************************************************
\r
27 * Get the FreeRTOS eBook! See http://www.FreeRTOS.org/Documentation *
\r
29 * This is a concise, step by step, 'hands on' guide that describes both *
\r
30 * general multitasking concepts and FreeRTOS specifics. It presents and *
\r
31 * explains numerous examples that are written using the FreeRTOS API. *
\r
32 * Full source code for all the examples is provided in an accompanying *
\r
35 ***************************************************************************
\r
39 Please ensure to read the configuration and relevant port sections of the
\r
40 online documentation.
\r
42 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
45 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
48 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
49 licensing and training services.
\r
53 * Creates all the demo application tasks and co-routines, then starts the
\r
56 * Main. c also creates a task called "Print". This only executes every
\r
57 * five seconds but has the highest priority so is guaranteed to get
\r
58 * processor time. Its main function is to check that all the other tasks
\r
59 * are still operational. Nearly all the tasks in the demo application
\r
60 * maintain a unique count that is incremented each time the task successfully
\r
61 * completes its function. Should any error occur within the task the count is
\r
62 * permanently halted. The print task checks the count of each task to ensure
\r
63 * it has changed since the last time the print task executed. If any count is
\r
64 * found not to have changed the print task displays an appropriate message.
\r
65 * If all the tasks are still incrementing their unique counts the print task
\r
66 * displays an "OK" message.
\r
68 * The LED flash tasks do not maintain a count as they already provide visual
\r
69 * feedback of their status.
\r
71 * The print task blocks on the queue into which messages that require
\r
72 * displaying are posted. It will therefore only block for the full 5 seconds
\r
73 * if no messages are posted onto the queue.
\r
75 * Main. c also provides a demonstration of how the trace visualisation utility
\r
76 * can be used, and how the scheduler can be stopped.
\r
78 * \page MainC main.c
\r
79 * \ingroup DemoFiles
\r
85 #include "FreeRTOS.h"
\r
87 #include "croutine.h"
\r
88 #include "partest.h"
\r
91 /* Demo file headers. */
\r
95 #include "crflash.h"
\r
98 #include "comtest.h"
\r
100 #include "semtest.h"
\r
101 #include "integer.h"
\r
102 #include "dynamic.h"
\r
103 #include "mevents.h"
\r
104 #include "crhook.h"
\r
105 #include "blocktim.h"
\r
106 #include "AltBlock.h"
\r
107 #include "GenQTest.h"
\r
109 #include "countsem.h"
\r
110 #include "AltQTest.h"
\r
111 #include "AltPollQ.h"
\r
112 #include "AltBlckQ.h"
\r
113 #include "RecMutex.h"
\r
115 /* Priority definitions for the tasks in the demo application. */
\r
116 #define mainLED_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
117 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
118 #define mainPRINT_TASK_PRIORITY ( tskIDLE_PRIORITY + 4 )
\r
119 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
120 #define mainQUEUE_BLOCK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
121 #define mainCOM_TEST_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
122 #define mainSEMAPHORE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
123 #define mainGENERIC_QUEUE_PRIORITY ( tskIDLE_PRIORITY )
\r
125 #define mainPRINT_STACK_SIZE ( ( unsigned portSHORT ) 512 )
\r
126 #define mainDEBUG_LOG_BUFFER_SIZE ( ( unsigned portSHORT ) 20480 )
\r
128 /* The number of flash co-routines to create. */
\r
129 #define mainNUM_FLASH_CO_ROUTINES ( 8 )
\r
131 /* Task function for the "Print" task as described at the top of the file. */
\r
132 static void vErrorChecks( void *pvParameters );
\r
134 /* Function that checks the unique count of all the other tasks as described at
\r
135 the top of the file. */
\r
136 static void prvCheckOtherTasksAreStillRunning( void );
\r
138 /* Key presses can be used to start/stop the trace visualisation utility or stop
\r
140 static void prvCheckForKeyPresses( void );
\r
142 /* Buffer used by the trace visualisation utility so only needed if the trace
\r
144 #if configUSE_TRACE_FACILITY == 1
\r
145 static portCHAR pcWriteBuffer[ mainDEBUG_LOG_BUFFER_SIZE ];
\r
148 /* Constant definition used to turn on/off the pre-emptive scheduler. */
\r
149 static const portSHORT sUsingPreemption = configUSE_PREEMPTION;
\r
151 /* Start the math tasks appropriate to the build. The Borland port does
\r
152 not yet support floating point so uses the integer equivalent. */
\r
153 static void prvStartMathTasks( void );
\r
155 /* Check which ever tasks are relevant to this build. */
\r
156 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void );
\r
158 /* Used to demonstrate the "task switched in" callback function. */
\r
159 static portBASE_TYPE prvExampleTaskHook( void * pvParameter );
\r
161 /* Just used to count the number of times the example task callback function is
\r
162 called, and the number of times a queue send passes. */
\r
163 static unsigned portLONG portLONG uxCheckTaskHookCallCount = 0;
\r
164 static unsigned portLONG portLONG uxQueueSendPassedCount = 0;
\r
166 /*-----------------------------------------------------------*/
\r
168 portSHORT main( void )
\r
170 /* Initialise hardware and utilities. */
\r
171 vParTestInitialise();
\r
172 vPrintInitialise();
\r
174 /* CREATE ALL THE DEMO APPLICATION TASKS. */
\r
175 prvStartMathTasks();
\r
176 vStartComTestTasks( mainCOM_TEST_PRIORITY, serCOM1, ser115200 );
\r
177 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
178 vStartBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
179 vCreateBlockTimeTasks();
\r
180 vStartGenericQueueTasks( mainGENERIC_QUEUE_PRIORITY );
\r
181 vStartSemaphoreTasks( mainSEMAPHORE_TASK_PRIORITY );
\r
182 vStartDynamicPriorityTasks();
\r
183 vStartMultiEventTasks();
\r
184 vStartQueuePeekTasks();
\r
185 vStartCountingSemaphoreTasks();
\r
186 vStartAltGenericQueueTasks( mainGENERIC_QUEUE_PRIORITY );
\r
187 vCreateAltBlockTimeTasks();
\r
188 vStartAltBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
189 vStartAltPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
190 vStartRecursiveMutexTasks();
\r
192 /* Create the "Print" task as described at the top of the file. */
\r
193 xTaskCreate( vErrorChecks, "Print", mainPRINT_STACK_SIZE, NULL, mainPRINT_TASK_PRIORITY, NULL );
\r
195 /* This task has to be created last as it keeps account of the number of tasks
\r
196 it expects to see running. */
\r
197 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
199 /* Create the co-routines that flash the LED's. */
\r
200 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
202 /* Create the co-routines that communicate with the tick hook. */
\r
203 vStartHookCoRoutines();
\r
205 /* Set the scheduler running. This function will not return unless a task
\r
206 calls vTaskEndScheduler(). */
\r
207 vTaskStartScheduler();
\r
211 /*-----------------------------------------------------------*/
\r
213 static portBASE_TYPE prvExampleTaskHook( void * pvParameter )
\r
215 if( pvParameter != ( void * ) 0xabcd )
\r
217 /* The parameter did not contain the value we expected, so cause an
\r
218 error to be detected by setting the call count back to zero. */
\r
219 uxCheckTaskHookCallCount = 0;
\r
223 /* Simply increment a number so we know the callback has been executed. */
\r
224 uxCheckTaskHookCallCount++;
\r
229 /*-----------------------------------------------------------*/
\r
231 void vMainQueueSendPassed( void )
\r
233 /* This is just an example implementation of the "queue send" trace hook. */
\r
234 uxQueueSendPassedCount++;
\r
236 /*-----------------------------------------------------------*/
\r
238 static void vErrorChecks( void *pvParameters )
\r
240 portTickType xExpectedWakeTime;
\r
241 const portTickType xPrintRate = ( portTickType ) 5000 / portTICK_RATE_MS;
\r
242 const portLONG lMaxAllowableTimeDifference = ( portLONG ) 0;
\r
243 portTickType xWakeTime;
\r
244 portLONG lTimeDifference;
\r
245 const portCHAR *pcReceivedMessage;
\r
246 const portCHAR * const pcTaskBlockedTooLongMsg = "Print task blocked too long!\r\n";
\r
248 ( void ) pvParameters;
\r
250 /* Register our callback function. */
\r
251 vTaskSetApplicationTaskTag( NULL, prvExampleTaskHook );
\r
253 /* Loop continuously, blocking, then checking all the other tasks are still
\r
254 running, before blocking once again. This task blocks on the queue of
\r
255 messages that require displaying so will wake either by its time out expiring,
\r
256 or a message becoming available. */
\r
259 /* Calculate the time we will unblock if no messages are received
\r
260 on the queue. This is used to check that we have not blocked for too long. */
\r
261 xExpectedWakeTime = xTaskGetTickCount();
\r
262 xExpectedWakeTime += xPrintRate;
\r
264 /* Block waiting for either a time out or a message to be posted that
\r
265 required displaying. */
\r
266 pcReceivedMessage = pcPrintGetNextMessage( xPrintRate );
\r
268 /* Was a message received? */
\r
269 if( pcReceivedMessage == NULL )
\r
271 /* A message was not received so we timed out, did we unblock at the
\r
273 xWakeTime = xTaskGetTickCount();
\r
275 /* Calculate the difference between the time we unblocked and the
\r
276 time we should have unblocked. */
\r
277 if( xWakeTime > xExpectedWakeTime )
\r
279 lTimeDifference = ( portLONG ) ( xWakeTime - xExpectedWakeTime );
\r
283 lTimeDifference = ( portLONG ) ( xExpectedWakeTime - xWakeTime );
\r
286 if( lTimeDifference > lMaxAllowableTimeDifference )
\r
288 /* We blocked too long - create a message that will get
\r
289 printed out the next time around. If we are not using
\r
290 preemption then we won't expect the timing to be so
\r
292 if( sUsingPreemption == pdTRUE )
\r
294 vPrintDisplayMessage( &pcTaskBlockedTooLongMsg );
\r
298 /* Check the other tasks are still running, just in case. */
\r
299 prvCheckOtherTasksAreStillRunning();
\r
303 /* We unblocked due to a message becoming available. Send the message
\r
305 vDisplayMessage( pcReceivedMessage );
\r
308 /* Key presses are used to invoke the trace visualisation utility, or end
\r
310 prvCheckForKeyPresses();
\r
313 /*-----------------------------------------------------------*/
\r
315 static void prvCheckForKeyPresses( void )
\r
319 taskENTER_CRITICAL();
\r
321 /* kbhit can be used in .exe's that are executed from the command
\r
322 line, but not if executed through the debugger. */
\r
327 taskEXIT_CRITICAL();
\r
331 /* Key presses can be used to start/stop the trace utility, or end the
\r
336 /* Only define keys for turning on and off the trace if the trace
\r
338 #if configUSE_TRACE_FACILITY == 1
\r
339 case 't' : vTaskList( pcWriteBuffer );
\r
340 vWriteMessageToDisk( pcWriteBuffer );
\r
342 case 's' : vTaskStartTrace( pcWriteBuffer, mainDEBUG_LOG_BUFFER_SIZE );
\r
346 unsigned portLONG ulBufferLength;
\r
347 ulBufferLength = ulTaskEndTrace();
\r
348 vWriteBufferToDisk( pcWriteBuffer, ulBufferLength );
\r
353 default : vTaskEndScheduler();
\r
358 /*-----------------------------------------------------------*/
\r
360 static void prvCheckOtherTasksAreStillRunning( void )
\r
362 static portSHORT sErrorHasOccurred = pdFALSE;
\r
363 static unsigned portLONG portLONG uxLastHookCallCount = 0, uxLastQueueSendCount = 0;
\r
365 if( prvCheckMathTasksAreStillRunning() != pdTRUE )
\r
367 vDisplayMessage( "Maths task count unchanged!\r\n" );
\r
368 sErrorHasOccurred = pdTRUE;
\r
371 if( xAreComTestTasksStillRunning() != pdTRUE )
\r
373 vDisplayMessage( "Com test count unchanged!\r\n" );
\r
374 sErrorHasOccurred = pdTRUE;
\r
377 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
379 vDisplayMessage( "Blocking queues count unchanged!\r\n" );
\r
380 sErrorHasOccurred = pdTRUE;
\r
383 if( xAreAltBlockingQueuesStillRunning() != pdTRUE )
\r
385 vDisplayMessage( "Alt blocking queues count unchanged!\r\n" );
\r
386 sErrorHasOccurred = pdTRUE;
\r
389 if( xArePollingQueuesStillRunning() != pdTRUE )
\r
391 vDisplayMessage( "Polling queue count unchanged!\r\n" );
\r
392 sErrorHasOccurred = pdTRUE;
\r
395 if( xAreAltPollingQueuesStillRunning() != pdTRUE )
\r
397 vDisplayMessage( "Alt polling queue count unchanged!\r\n" );
\r
398 sErrorHasOccurred = pdTRUE;
\r
401 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
403 vDisplayMessage( "Incorrect number of tasks running!\r\n" );
\r
404 sErrorHasOccurred = pdTRUE;
\r
407 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
409 vDisplayMessage( "Semaphore take count unchanged!\r\n" );
\r
410 sErrorHasOccurred = pdTRUE;
\r
413 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
415 vDisplayMessage( "Dynamic priority count unchanged!\r\n" );
\r
416 sErrorHasOccurred = pdTRUE;
\r
419 if( xAreMultiEventTasksStillRunning() != pdTRUE )
\r
421 vDisplayMessage( "Error in multi events tasks!\r\n" );
\r
422 sErrorHasOccurred = pdTRUE;
\r
425 if( xAreFlashCoRoutinesStillRunning() != pdTRUE )
\r
427 vDisplayMessage( "Error in co-routine flash tasks!\r\n" );
\r
428 sErrorHasOccurred = pdTRUE;
\r
431 if( xAreHookCoRoutinesStillRunning() != pdTRUE )
\r
433 vDisplayMessage( "Error in tick hook to co-routine communications!\r\n" );
\r
434 sErrorHasOccurred = pdTRUE;
\r
437 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
439 vDisplayMessage( "Error in block time test tasks!\r\n" );
\r
440 sErrorHasOccurred = pdTRUE;
\r
443 if( xAreAltBlockTimeTestTasksStillRunning() != pdTRUE )
\r
445 vDisplayMessage( "Error in fast block time test tasks!\r\n" );
\r
446 sErrorHasOccurred = pdTRUE;
\r
449 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
451 vDisplayMessage( "Error in generic queue test task!\r\n" );
\r
452 sErrorHasOccurred = pdTRUE;
\r
455 if( xAreAltGenericQueueTasksStillRunning() != pdTRUE )
\r
457 vDisplayMessage( "Error in fast generic queue test task!\r\n" );
\r
458 sErrorHasOccurred = pdTRUE;
\r
461 if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
463 vDisplayMessage( "Error in queue peek test task!\r\n" );
\r
464 sErrorHasOccurred = pdTRUE;
\r
467 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
469 vDisplayMessage( "Error in counting semaphore demo task!\r\n" );
\r
470 sErrorHasOccurred = pdTRUE;
\r
473 if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
475 vDisplayMessage( "Error in recursive mutex tasks!\r\n" );
\r
476 sErrorHasOccurred = pdTRUE;
\r
479 /* The hook function associated with this task is called each time the task
\r
480 is switched in. We therefore expect the number of times the callback
\r
481 function has been executed to have increrment since the last time this
\r
482 function executed. */
\r
483 if( uxCheckTaskHookCallCount <= uxLastHookCallCount )
\r
485 vDisplayMessage( "Error in task hook call count!\r\n" );
\r
486 sErrorHasOccurred = pdTRUE;
\r
490 uxLastHookCallCount = uxCheckTaskHookCallCount;
\r
493 /* We would expect some queue sending to occur between calls of this
\r
495 if( uxQueueSendPassedCount <= uxLastQueueSendCount )
\r
497 vDisplayMessage( "Error in queue send hook call count!\r\n" );
\r
498 sErrorHasOccurred = pdTRUE;
\r
502 uxLastQueueSendCount = uxQueueSendPassedCount;
\r
505 if( sErrorHasOccurred == pdFALSE )
\r
507 vDisplayMessage( "OK " );
\r
510 /*-----------------------------------------------------------*/
\r
512 static void prvStartMathTasks( void )
\r
514 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
515 /* The Borland project does not yet support floating point. */
\r
516 vStartIntegerMathTasks( tskIDLE_PRIORITY );
\r
518 vStartMathTasks( tskIDLE_PRIORITY );
\r
521 /*-----------------------------------------------------------*/
\r
523 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void )
\r
525 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
526 /* The Borland project does not yet support floating point. */
\r
527 return xAreIntegerMathsTaskStillRunning();
\r
529 return xAreMathsTaskStillRunning();
\r
532 /*-----------------------------------------------------------*/
\r
534 void vApplicationIdleHook( void )
\r
536 /* The co-routines are executed in the idle task using the idle task
\r
538 vCoRoutineSchedule();
\r
540 /*-----------------------------------------------------------*/
\r