2 FreeRTOS.org V4.1.1 - Copyright (C) 2003-2006 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
\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
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
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
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
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
34 * Creates all the demo application tasks and co-routines, then starts the
\r
37 * Main. c also creates a task called "Print". This only executes every
\r
38 * five seconds but has the highest priority so is guaranteed to get
\r
39 * processor time. Its main function is to check that all the other tasks
\r
40 * are still operational. Nearly all the tasks in the demo application
\r
41 * maintain a unique count that is incremented each time the task successfully
\r
42 * completes its function. Should any error occur within the task the count is
\r
43 * permanently halted. The print task checks the count of each task to ensure
\r
44 * it has changed since the last time the print task executed. If any count is
\r
45 * found not to have changed the print task displays an appropriate message.
\r
46 * If all the tasks are still incrementing their unique counts the print task
\r
47 * displays an "OK" message.
\r
49 * The LED flash tasks do not maintain a count as they already provide visual
\r
50 * feedback of their status.
\r
52 * The print task blocks on the queue into which messages that require
\r
53 * displaying are posted. It will therefore only block for the full 5 seconds
\r
54 * if no messages are posted onto the queue.
\r
56 * Main. c also provides a demonstration of how the trace visualisation utility
\r
57 * can be used, and how the scheduler can be stopped.
\r
59 * \page MainC main.c
\r
60 * \ingroup DemoFiles
\r
67 + Prevent the call to kbhit() for debug builds as the debugger seems to
\r
68 have problems stepping over the call.
\r
72 + The integer and comtest tasks are now used when the cooperative scheduler
\r
73 is being used. Previously they were only used with the preemptive
\r
78 + Create new tasks as defined by the new demo application file dynamic.c.
\r
82 + Delay periods are now specified using variables and constants of
\r
83 portTickType rather than unsigned portLONG.
\r
87 + The tasks defined in the new file "events.c" are now created and
\r
88 monitored for errors.
\r
92 + Now includes the flash co-routine demo rather than the flash task demo.
\r
93 This is to demonstrate the co-routine functionality.
\r
98 #include "FreeRTOS.h"
\r
100 #include "croutine.h"
\r
101 #include "partest.h"
\r
102 #include "serial.h"
\r
104 /* Demo file headers. */
\r
105 #include "BlockQ.h"
\r
108 #include "crflash.h"
\r
111 #include "comtest.h"
\r
112 #include "fileio.h"
\r
113 #include "semtest.h"
\r
114 #include "integer.h"
\r
115 #include "dynamic.h"
\r
116 #include "mevents.h"
\r
117 #include "crhook.h"
\r
118 #include "blocktim.h"
\r
120 /* Priority definitions for the tasks in the demo application. */
\r
121 #define mainLED_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
122 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
123 #define mainPRINT_TASK_PRIORITY ( tskIDLE_PRIORITY + 4 )
\r
124 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
125 #define mainQUEUE_BLOCK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
126 #define mainCOM_TEST_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
127 #define mainSEMAPHORE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
129 #define mainPRINT_STACK_SIZE ( ( unsigned portSHORT ) 512 )
\r
130 #define mainDEBUG_LOG_BUFFER_SIZE ( ( unsigned portSHORT ) 20480 )
\r
132 /* The number of flash co-routines to create. */
\r
133 #define mainNUM_FLASH_CO_ROUTINES ( 8 )
\r
135 /* Task function for the "Print" task as described at the top of the file. */
\r
136 static void vErrorChecks( void *pvParameters );
\r
138 /* Function that checks the unique count of all the other tasks as described at
\r
139 the top of the file. */
\r
140 static void prvCheckOtherTasksAreStillRunning( void );
\r
142 /* Key presses can be used to start/stop the trace visualisation utility or stop
\r
144 static void prvCheckForKeyPresses( void );
\r
146 /* Buffer used by the trace visualisation utility so only needed if the trace
\r
148 #if configUSE_TRACE_FACILITY == 1
\r
149 static portCHAR pcWriteBuffer[ mainDEBUG_LOG_BUFFER_SIZE ];
\r
152 /* Constant definition used to turn on/off the pre-emptive scheduler. */
\r
153 static const portSHORT sUsingPreemption = configUSE_PREEMPTION;
\r
155 /* Start the math tasks appropriate to the build. The Borland port does
\r
156 not yet support floating point so uses the integer equivalent. */
\r
157 static void prvStartMathTasks( void );
\r
159 /* Check which ever tasks are relevant to this build. */
\r
160 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void );
\r
162 /*-----------------------------------------------------------*/
\r
164 portSHORT main( void )
\r
166 /* Initialise hardware and utilities. */
\r
167 vParTestInitialise();
\r
168 vPrintInitialise();
\r
170 /* CREATE ALL THE DEMO APPLICATION TASKS. */
\r
171 prvStartMathTasks();
\r
172 vStartComTestTasks( mainCOM_TEST_PRIORITY, serCOM1, ser115200 );
\r
173 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
174 vStartBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
175 vCreateBlockTimeTasks();
\r
177 vStartSemaphoreTasks( mainSEMAPHORE_TASK_PRIORITY );
\r
178 vStartDynamicPriorityTasks();
\r
179 vStartMultiEventTasks();
\r
181 /* Create the "Print" task as described at the top of the file. */
\r
182 xTaskCreate( vErrorChecks, "Print", mainPRINT_STACK_SIZE, NULL, mainPRINT_TASK_PRIORITY, NULL );
\r
184 /* This task has to be created last as it keeps account of the number of tasks
\r
185 it expects to see running. */
\r
186 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
188 /* Create the co-routines that flash the LED's. */
\r
189 vStartFlashCoRoutines( mainNUM_FLASH_CO_ROUTINES );
\r
191 /* Create the co-routines that communicate with the tick hook. */
\r
192 vStartHookCoRoutines();
\r
194 /* Set the scheduler running. This function will not return unless a task
\r
195 calls vTaskEndScheduler(). */
\r
196 vTaskStartScheduler();
\r
200 /*-----------------------------------------------------------*/
\r
202 static void vErrorChecks( void *pvParameters )
\r
204 portTickType xExpectedWakeTime;
\r
205 const portTickType xPrintRate = ( portTickType ) 5000 / portTICK_RATE_MS;
\r
206 const portLONG lMaxAllowableTimeDifference = ( portLONG ) 0;
\r
207 portTickType xWakeTime;
\r
208 portLONG lTimeDifference;
\r
209 const portCHAR *pcReceivedMessage;
\r
210 const portCHAR * const pcTaskBlockedTooLongMsg = "Print task blocked too long!\r\n";
\r
212 ( void ) pvParameters;
\r
214 /* Loop continuously, blocking, then checking all the other tasks are still
\r
215 running, before blocking once again. This task blocks on the queue of
\r
216 messages that require displaying so will wake either by its time out expiring,
\r
217 or a message becoming available. */
\r
220 /* Calculate the time we will unblock if no messages are received
\r
221 on the queue. This is used to check that we have not blocked for too long. */
\r
222 xExpectedWakeTime = xTaskGetTickCount();
\r
223 xExpectedWakeTime += xPrintRate;
\r
225 /* Block waiting for either a time out or a message to be posted that
\r
226 required displaying. */
\r
227 pcReceivedMessage = pcPrintGetNextMessage( xPrintRate );
\r
229 /* Was a message received? */
\r
230 if( pcReceivedMessage == NULL )
\r
232 /* A message was not received so we timed out, did we unblock at the
\r
234 xWakeTime = xTaskGetTickCount();
\r
236 /* Calculate the difference between the time we unblocked and the
\r
237 time we should have unblocked. */
\r
238 if( xWakeTime > xExpectedWakeTime )
\r
240 lTimeDifference = ( portLONG ) ( xWakeTime - xExpectedWakeTime );
\r
244 lTimeDifference = ( portLONG ) ( xExpectedWakeTime - xWakeTime );
\r
247 if( lTimeDifference > lMaxAllowableTimeDifference )
\r
249 /* We blocked too long - create a message that will get
\r
250 printed out the next time around. If we are not using
\r
251 preemption then we won't expect the timing to be so
\r
253 if( sUsingPreemption == pdTRUE )
\r
255 vPrintDisplayMessage( &pcTaskBlockedTooLongMsg );
\r
259 /* Check the other tasks are still running, just in case. */
\r
260 prvCheckOtherTasksAreStillRunning();
\r
264 /* We unblocked due to a message becoming available. Send the message
\r
266 vDisplayMessage( pcReceivedMessage );
\r
269 /* Key presses are used to invoke the trace visualisation utility, or end
\r
271 prvCheckForKeyPresses();
\r
274 /*-----------------------------------------------------------*/
\r
276 static void prvCheckForKeyPresses( void )
\r
280 taskENTER_CRITICAL();
\r
282 /* kbhit can be used in .exe's that are executed from the command
\r
283 line, but not if executed through the debugger. */
\r
288 taskEXIT_CRITICAL();
\r
292 /* Key presses can be used to start/stop the trace utility, or end the
\r
297 /* Only define keys for turning on and off the trace if the trace
\r
299 #if configUSE_TRACE_FACILITY == 1
\r
300 case 't' : vTaskList( pcWriteBuffer );
\r
301 vWriteMessageToDisk( pcWriteBuffer );
\r
303 case 's' : vTaskStartTrace( pcWriteBuffer, mainDEBUG_LOG_BUFFER_SIZE );
\r
307 unsigned portLONG ulBufferLength;
\r
308 ulBufferLength = ulTaskEndTrace();
\r
309 vWriteBufferToDisk( pcWriteBuffer, ulBufferLength );
\r
314 default : vTaskEndScheduler();
\r
319 /*-----------------------------------------------------------*/
\r
321 static void prvCheckOtherTasksAreStillRunning( void )
\r
323 static portSHORT sErrorHasOccurred = pdFALSE;
\r
325 if( prvCheckMathTasksAreStillRunning() != pdTRUE )
\r
327 vDisplayMessage( "Maths task count unchanged!\r\n" );
\r
328 sErrorHasOccurred = pdTRUE;
\r
331 if( xAreComTestTasksStillRunning() != pdTRUE )
\r
333 vDisplayMessage( "Com test count unchanged!\r\n" );
\r
334 sErrorHasOccurred = pdTRUE;
\r
337 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
339 vDisplayMessage( "Blocking queues count unchanged!\r\n" );
\r
340 sErrorHasOccurred = pdTRUE;
\r
343 if( xArePollingQueuesStillRunning() != pdTRUE )
\r
345 vDisplayMessage( "Polling queue count unchanged!\r\n" );
\r
346 sErrorHasOccurred = pdTRUE;
\r
349 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
351 vDisplayMessage( "Incorrect number of tasks running!\r\n" );
\r
352 sErrorHasOccurred = pdTRUE;
\r
355 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
357 vDisplayMessage( "Semaphore take count unchanged!\r\n" );
\r
358 sErrorHasOccurred = pdTRUE;
\r
361 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
363 vDisplayMessage( "Dynamic priority count unchanged!\r\n" );
\r
364 sErrorHasOccurred = pdTRUE;
\r
367 if( xAreMultiEventTasksStillRunning() != pdTRUE )
\r
369 vDisplayMessage( "Error in multi events tasks!\r\n" );
\r
370 sErrorHasOccurred = pdTRUE;
\r
373 if( xAreFlashCoRoutinesStillRunning() != pdTRUE )
\r
375 vDisplayMessage( "Error in co-routine flash tasks!\r\n" );
\r
376 sErrorHasOccurred = pdTRUE;
\r
379 if( xAreHookCoRoutinesStillRunning() != pdTRUE )
\r
381 vDisplayMessage( "Error in tick hook to co-routine communications!\r\n" );
\r
382 sErrorHasOccurred = pdTRUE;
\r
385 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
387 vDisplayMessage( "Error in block time test tasks!\r\n" );
\r
388 sErrorHasOccurred = pdTRUE;
\r
391 if( sErrorHasOccurred == pdFALSE )
\r
393 vDisplayMessage( "OK " );
\r
396 /*-----------------------------------------------------------*/
\r
398 static void prvStartMathTasks( void )
\r
400 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
401 /* The Borland project does not yet support floating point. */
\r
402 vStartIntegerMathTasks( tskIDLE_PRIORITY );
\r
404 vStartMathTasks( tskIDLE_PRIORITY );
\r
407 /*-----------------------------------------------------------*/
\r
409 static portBASE_TYPE prvCheckMathTasksAreStillRunning( void )
\r
411 #ifdef BCC_INDUSTRIAL_PC_PORT
\r
412 /* The Borland project does not yet support floating point. */
\r
413 return xAreIntegerMathsTaskStillRunning();
\r
415 return xAreMathsTaskStillRunning();
\r
418 /*-----------------------------------------------------------*/
\r
420 void vApplicationIdleHook( void )
\r
422 /* The co-routines are executed in the idle task using the idle task
\r
424 vCoRoutineSchedule();
\r
426 /*-----------------------------------------------------------*/
\r