2 FreeRTOS.org V5.0.0 - Copyright (C) 2003-2008 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 ***************************************************************************
\r
29 * SAVE TIME AND MONEY! We can port FreeRTOS.org to your own hardware, *
\r
30 * and even write all or part of your application on your behalf. *
\r
31 * See http://www.OpenRTOS.com for details of the services we provide to *
\r
32 * expedite your project. *
\r
34 ***************************************************************************
\r
35 ***************************************************************************
\r
37 Please ensure to read the configuration and relevant port sections of the
\r
38 online documentation.
\r
40 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
43 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
46 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
47 licensing and training services.
\r
51 * Creates all the demo application tasks, then starts the scheduler.
\r
53 * Main. c also creates a task called "Print". This only executes every five
\r
54 * seconds but has the highest priority so is guaranteed to get processor time.
\r
55 * Its main function is to check that all the other tasks are still operational.
\r
56 * Nearly all the tasks in the demo application maintain a unique count that is
\r
57 * incremented each time the task successfully completes its function. Should any
\r
58 * error occur within the task the count is permanently halted. The print task
\r
59 * checks the count of each task to ensure it has changed since the last time the
\r
60 * print task executed. If any count is found not to have changed the print task
\r
61 * displays an appropriate message, halts, and flashes the on board LED rapidly.
\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 displaying
\r
69 * are posted. It will therefore only block for the full 5 seconds if no messages
\r
70 * are posted onto the queue.
\r
72 * Main. c also provides a demonstration of how the trace visualisation utility can
\r
73 * be used, and how the scheduler can be stopped.
\r
75 * On the Flashlite it is preferable not to try to write to the console during
\r
76 * real time operation. The built in LED is toggled every cycle of the print task
\r
77 * that does not encounter any errors, so the console IO may be removed if required.
\r
78 * The build in LED will start flashing rapidly if any task reports an error.
\r
84 + Previously, if an error occurred in a task the on board LED was stopped from
\r
85 toggling. Now if an error occurs the check task enters an infinite loop,
\r
86 toggling the LED rapidly.
\r
90 + The integer and comtest tasks are now used when the cooperative scheduler
\r
91 is being used. Previously they were only used with the preemptive
\r
96 + Made the communications RX task a higher priority.
\r
100 + Delay periods are now specified using variables and constants of
\r
101 portTickType rather than unsigned portLONG.
\r
104 #include <stdlib.h>
\r
106 #include "FreeRTOS.h"
\r
108 #include "partest.h"
\r
109 #include "serial.h"
\r
111 /* Demo file headers. */
\r
112 #include "BlockQ.h"
\r
116 #include "integer.h"
\r
118 #include "comtest.h"
\r
119 #include "fileio.h"
\r
120 #include "semtest.h"
\r
122 /* Priority definitions for all the tasks in the demo application. */
\r
123 #define mainLED_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
124 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
125 #define mainPRINT_TASK_PRIORITY ( tskIDLE_PRIORITY + 5 )
\r
126 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
127 #define mainQUEUE_BLOCK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
128 #define mainCOM_TEST_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
129 #define mainSEMAPHORE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
131 #define mainPRINT_STACK_SIZE ( ( unsigned portSHORT ) 256 )
\r
132 #define mainDEBUG_LOG_BUFFER_SIZE ( ( unsigned portSHORT ) 20480 )
\r
134 /* Constant definitions for accessing the build in LED on the Flashlite 186. */
\r
135 #define mainLED_REG_DIR ( ( unsigned portSHORT ) 0xff78 )
\r
136 #define mainLED_REG ( ( unsigned portSHORT ) 0xff7a )
\r
138 /* If an error is detected in a task then the vErrorChecks() task will enter
\r
139 an infinite loop flashing the LED at this rate. */
\r
140 #define mainERROR_FLASH_RATE ( ( portTickType ) 100 / portTICK_RATE_MS )
\r
142 /* Task function for the "Print" task as described at the top of the file. */
\r
143 static void vErrorChecks( void *pvParameters );
\r
145 /* Function that checks the unique count of all the other tasks as described at
\r
146 the top of the file. */
\r
147 static void prvCheckOtherTasksAreStillRunning( void );
\r
149 /* Functions to setup and use the built in LED on the Flashlite 186 board. */
\r
150 static void prvToggleLED( void );
\r
151 static void prvInitLED( void );
\r
153 /* Key presses can be used to start/stop the trace visualisation utility or stop
\r
155 static void prvCheckForKeyPresses( void );
\r
157 /* Buffer used by the trace visualisation utility. */
\r
158 static portCHAR pcWriteBuffer[ mainDEBUG_LOG_BUFFER_SIZE ];
\r
160 /*-----------------------------------------------------------*/
\r
161 portSHORT main( void )
\r
163 /* Initialise hardware and utilities. */
\r
164 vParTestInitialise();
\r
165 vPrintInitialise();
\r
168 /* CREATE ALL THE DEMO APPLICATION TASKS. */
\r
170 vStartComTestTasks( mainCOM_TEST_PRIORITY, serCOM2, ser38400 );
\r
171 vStartIntegerMathTasks( tskIDLE_PRIORITY );
\r
172 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
173 vStartBlockingQueueTasks( mainQUEUE_BLOCK_PRIORITY );
\r
174 vStartLEDFlashTasks( mainLED_TASK_PRIORITY );
\r
175 vStartSemaphoreTasks( mainSEMAPHORE_TASK_PRIORITY );
\r
177 /* Create the "Print" task as described at the top of the file. */
\r
178 xTaskCreate( vErrorChecks, "Print", mainPRINT_STACK_SIZE, NULL, mainPRINT_TASK_PRIORITY, NULL );
\r
180 /* This task has to be created last as it keeps account of the number of tasks
\r
181 it expects to see running. */
\r
182 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
184 /* Set the scheduler running. This function will not return unless a task
\r
185 calls vTaskEndScheduler(). */
\r
186 vTaskStartScheduler();
\r
190 /*-----------------------------------------------------------*/
\r
192 static void vErrorChecks( void *pvParameters )
\r
194 portTickType xExpectedWakeTime;
\r
195 const portTickType xPrintRate = ( portTickType ) 5000 / portTICK_RATE_MS;
\r
196 const portLONG lMaxAllowableTimeDifference = ( portLONG ) 0;
\r
197 portTickType xWakeTime;
\r
198 portLONG lTimeDifference;
\r
199 const portCHAR *pcReceivedMessage;
\r
200 const portCHAR * const pcTaskBlockedTooLongMsg = "Print task blocked too long!\r\n";
\r
202 /* Stop warnings. */
\r
203 ( void ) pvParameters;
\r
205 /* Loop continuously, blocking, then checking all the other tasks are still
\r
206 running, before blocking once again. This task blocks on the queue of messages
\r
207 that require displaying so will wake either by its time out expiring, or a
\r
208 message becoming available. */
\r
211 /* Calculate the time we will unblock if no messages are received
\r
212 on the queue. This is used to check that we have not blocked for too long. */
\r
213 xExpectedWakeTime = xTaskGetTickCount();
\r
214 xExpectedWakeTime += xPrintRate;
\r
216 /* Block waiting for either a time out or a message to be posted that
\r
217 required displaying. */
\r
218 pcReceivedMessage = pcPrintGetNextMessage( xPrintRate );
\r
220 /* Was a message received? */
\r
221 if( pcReceivedMessage == NULL )
\r
223 /* A message was not received so we timed out, did we unblock at the
\r
225 xWakeTime = xTaskGetTickCount();
\r
227 /* Calculate the difference between the time we unblocked and the
\r
228 time we should have unblocked. */
\r
229 if( xWakeTime > xExpectedWakeTime )
\r
231 lTimeDifference = ( portLONG ) ( xWakeTime - xExpectedWakeTime );
\r
235 lTimeDifference = ( portLONG ) ( xExpectedWakeTime - xWakeTime );
\r
238 if( lTimeDifference > lMaxAllowableTimeDifference )
\r
240 /* We blocked too long - create a message that will get
\r
241 printed out the next time around. */
\r
242 vPrintDisplayMessage( &pcTaskBlockedTooLongMsg );
\r
245 /* Check the other tasks are still running, just in case. */
\r
246 prvCheckOtherTasksAreStillRunning();
\r
250 /* We unblocked due to a message becoming available. Send the message
\r
252 vDisplayMessage( pcReceivedMessage );
\r
255 /* Key presses are used to invoke the trace visualisation utility, or
\r
256 end the program. */
\r
257 prvCheckForKeyPresses();
\r
259 } /*lint !e715 !e818 pvParameters is not used but all task functions must take this form. */
\r
260 /*-----------------------------------------------------------*/
\r
262 static void prvCheckForKeyPresses( void )
\r
269 taskENTER_CRITICAL();
\r
271 taskEXIT_CRITICAL();
\r
275 unsigned portLONG ulBufferLength;
\r
277 /* Key presses can be used to start/stop the trace utility, or end the
\r
282 /* Only define keys for turning on and off the trace if the trace
\r
284 #if configUSE_TRACE_FACILITY == 1
\r
285 case 't' : vTaskList( pcWriteBuffer );
\r
286 vWriteMessageToDisk( pcWriteBuffer );
\r
289 case 's' : vTaskStartTrace( pcWriteBuffer, mainDEBUG_LOG_BUFFER_SIZE );
\r
292 case 'e' : ulBufferLength = ulTaskEndTrace();
\r
293 vWriteBufferToDisk( pcWriteBuffer, ulBufferLength );
\r
297 default : vTaskEndScheduler();
\r
303 ( void ) pcWriteBuffer;
\r
306 /*-----------------------------------------------------------*/
\r
308 static void prvCheckOtherTasksAreStillRunning( void )
\r
310 portSHORT sErrorHasOccurred = pdFALSE;
\r
312 if( xAreComTestTasksStillRunning() != pdTRUE )
\r
314 vDisplayMessage( "Com test count unchanged!\r\n" );
\r
315 sErrorHasOccurred = pdTRUE;
\r
318 if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
320 vDisplayMessage( "Integer maths task count unchanged!\r\n" );
\r
321 sErrorHasOccurred = pdTRUE;
\r
324 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
326 vDisplayMessage( "Blocking queues count unchanged!\r\n" );
\r
327 sErrorHasOccurred = pdTRUE;
\r
330 if( xArePollingQueuesStillRunning() != pdTRUE )
\r
332 vDisplayMessage( "Polling queue count unchanged!\r\n" );
\r
333 sErrorHasOccurred = pdTRUE;
\r
336 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
338 vDisplayMessage( "Incorrect number of tasks running!\r\n" );
\r
339 sErrorHasOccurred = pdTRUE;
\r
342 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
344 vDisplayMessage( "Semaphore take count unchanged!\r\n" );
\r
345 sErrorHasOccurred = pdTRUE;
\r
348 if( sErrorHasOccurred == pdFALSE )
\r
350 vDisplayMessage( "OK " );
\r
351 /* Toggle the LED if everything is okay so we know if an error occurs even if not
\r
352 using console IO. */
\r
359 /* An error has occurred in one of the tasks. Don't go any further and
\r
360 flash the LED rapidly in case console IO is not being used. */
\r
362 vTaskDelay( mainERROR_FLASH_RATE );
\r
366 /*-----------------------------------------------------------*/
\r
368 static void prvInitLED( void )
\r
370 unsigned portSHORT usPortDirection;
\r
371 const unsigned portSHORT usLEDOut = 0x400;
\r
373 /* Set the LED bit to an output. */
\r
375 usPortDirection = inpw( mainLED_REG_DIR );
\r
376 usPortDirection &= ~usLEDOut;
\r
377 outpw( mainLED_REG_DIR, usPortDirection );
\r
379 /*-----------------------------------------------------------*/
\r
381 static void prvToggleLED( void )
\r
383 static portSHORT sLED = pdTRUE;
\r
384 unsigned portSHORT usLEDState;
\r
385 const unsigned portSHORT usLEDBit = 0x400;
\r
387 /* Flip the state of the LED. */
\r
388 usLEDState = inpw( mainLED_REG );
\r
391 usLEDState &= ~usLEDBit;
\r
395 usLEDState |= usLEDBit;
\r
397 outpw( mainLED_REG, usLEDState );
\r