2 FreeRTOS V8.0.1 - Copyright (C) 2014 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS provides completely free yet professionally developed, *
\r
10 * robust, strictly quality controlled, supported, and cross *
\r
11 * platform software that has become a de facto standard. *
\r
13 * Help yourself get started quickly and support the FreeRTOS *
\r
14 * project by purchasing a FreeRTOS tutorial book, reference *
\r
15 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\r
23 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
24 the terms of the GNU General Public License (version 2) as published by the
\r
25 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
27 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
28 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
29 >>! obliged to provide the source code for proprietary components !<<
\r
30 >>! outside of the FreeRTOS kernel. !<<
\r
32 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
33 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
34 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
35 link: http://www.freertos.org/a00114.html
\r
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\r
51 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
52 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
53 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
55 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
56 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
57 licenses offer ticketed support, indemnification and middleware.
\r
59 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
60 engineered and independently SIL3 certified version for use in safety and
\r
61 mission critical applications that require provable dependability.
\r
66 /******************************************************************************
\r
67 * NOTE 1: This project provides two demo applications. A simple blinky style
\r
68 * project, and a more comprehensive test and demo application. The
\r
69 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
\r
70 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
\r
71 * in main.c. This file implements the comprehensive test and demo version.
\r
73 * NOTE 2: This file only contains the source code that is specific to the
\r
74 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
75 * required to configure the hardware, are defined in main.c.
\r
77 * NOTE 3: If mainINCLUDE_FAT_SL_DEMO is set to 1 then the UART is used to
\r
78 * interface to the FreeRTOS+CLI command line interface. If
\r
79 * mainINCLUDE_FAT_SL_DEMO is set to 0 then the UART is used to run the standard
\r
80 * COM test tasks and a loopback connector must be fitted to the UART port
\r
81 * because the test expects to receive every character that is transmitted. A
\r
82 * simple loopback connector can be created by linking pins 2 and 3 of the 9 way
\r
84 ******************************************************************************
\r
86 * main_full() creates all the demo application tasks and software timers, then
\r
87 * starts the scheduler. The web documentation provides more details of the
\r
88 * standard demo application tasks, which provide no particular functionality,
\r
89 * but do provide a good example of how to use the FreeRTOS API.
\r
91 * In addition to the standard demo tasks, the following tasks and tests are
\r
92 * defined and/or created within this file:
\r
94 * FreeRTOS+CLI command console. The command console is access through UART2
\r
95 * using 115200 baud if mainINCLUDE_FAT_SL_DEMO is set to 1. For reasons of
\r
96 * robustness testing the UART driver is deliberately written to be inefficient
\r
97 * and should not be used as a template for a production driver. Type "help" to
\r
98 * see a list of registered commands. The FreeRTOS+CLI license is different to
\r
99 * the FreeRTOS license, see http://www.FreeRTOS.org/cli for license and usage
\r
102 * FreeRTOS+FAT SL. FreeRTOS+FAT SL is demonstrated using a RAM disk if
\r
103 * mainINCLUDE_FAT_SL_DEMO is set to 1. [At the time of writing] The
\r
104 * functionality of the file system demo is identical to the functionality of
\r
105 * the FreeRTOS Win32 simulator file system demo, with the command console being
\r
106 * accessed via the UART (as described above) instead of a network terminal.
\r
107 * The FreeRTOS+FAT SL license is different to the FreeRTOS license, see
\r
108 * http://www.FreeRTOS.org/fat_sl for license and usage details, and a
\r
109 * description of the file system demo functionality.
\r
111 * "Reg test" tasks - These fill both the core and floating point registers with
\r
112 * known values, then check that each register maintains its expected value for
\r
113 * the lifetime of the task. Each task uses a different set of values. The reg
\r
114 * test tasks execute with a very low priority, so get preempted very
\r
115 * frequently. A register containing an unexpected value is indicative of an
\r
116 * error in the context switching mechanism.
\r
118 * "Check" task - The check task period is initially set to three seconds. The
\r
119 * task checks that all the standard demo tasks, and the register check tasks,
\r
120 * are not only still executing, but are executing without reporting any errors.
\r
121 * If the check task discovers that a task has either stalled, or reported an
\r
122 * error, then it changes its own execution period from the initial three
\r
123 * seconds, to just 200ms. The check task also toggles an LED each time it is
\r
124 * called. This provides a visual indication of the system status: If the LED
\r
125 * toggles every three seconds, then no issues have been discovered. If the LED
\r
126 * toggles every 200ms, then an issue has been discovered with at least one
\r
130 /* Standard includes. */
\r
133 /* Kernel includes. */
\r
134 #include "FreeRTOS.h"
\r
136 #include "timers.h"
\r
137 #include "semphr.h"
\r
139 /* Standard demo application includes. */
\r
141 #include "semtest.h"
\r
142 #include "dynamic.h"
\r
143 #include "BlockQ.h"
\r
144 #include "blocktim.h"
\r
145 #include "countsem.h"
\r
146 #include "GenQTest.h"
\r
147 #include "recmutex.h"
\r
149 #include "partest.h"
\r
150 #include "comtest2.h"
\r
151 #include "serial.h"
\r
152 #include "TimerDemo.h"
\r
153 #include "QueueOverwrite.h"
\r
155 /* FreeRTOS+CLI and FreeRTOS+FAT SL includes. */
\r
156 #include "UARTCommandConsole.h"
\r
158 /* Either the FreeRTOS+FAT SL demo or the COM test demo can be build into the
\r
159 project, not both (because they use the same UART). Set
\r
160 configINCLUDE_FAT_SL_DEMO to 1 to include the FreeRTOS+FAT SL (and therefore
\r
161 also FreeRTOS+CLI) demo in the build. Set configINCLUDE_FAT_SL_DEMO to 0 to
\r
162 include the COM test tasks. The COM test tasks require a loop back connector
\r
163 to be fitted to the UART port. */
\r
164 #define mainINCLUDE_FAT_SL_DEMO 1
\r
166 /* Priorities for the demo application tasks. */
\r
167 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
168 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
169 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
170 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
171 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
172 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
173 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
174 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
176 /* The priority used by the UART command console task. */
\r
177 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
179 /* The LED used by the check timer. */
\r
180 #define mainCHECK_LED ( 0 )
\r
182 /* A block time of zero simply means "don't block". */
\r
183 #define mainDONT_BLOCK ( 0UL )
\r
185 /* In this example the baud rate is hard coded and there is no LED for use by
\r
186 the COM test tasks, so just set both to invalid values. */
\r
187 #define mainCOM_TEST_LED ( 100 )
\r
188 #define mainBAUD_RATE ( 0 )
\r
190 /* The period after which the check timer will expire, in ms, provided no errors
\r
191 have been reported by any of the standard demo tasks. ms are converted to the
\r
192 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
193 #define mainNO_ERROR_CHECK_TASK_PERIOD ( 3000UL / portTICK_PERIOD_MS )
\r
195 /* The period at which the check timer will expire, in ms, if an error has been
\r
196 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
197 in ticks using the portTICK_PERIOD_MS constant. */
\r
198 #define mainERROR_CHECK_TASK_PERIOD ( 200UL / portTICK_PERIOD_MS )
\r
200 /* Parameters that are passed into the register check tasks solely for the
\r
201 purpose of ensuring parameters are passed into tasks correctly. */
\r
202 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
203 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
205 /* The base period used by the timer test tasks. */
\r
206 #define mainTIMER_TEST_PERIOD ( 50 )
\r
208 /* The length of queues used to pass characters into and out of the UART
\r
209 interrupt. Note the comments above about the UART driver being implemented in
\r
210 this way to test the kernel robustness rather than to provide a template for an
\r
211 efficient production driver. */
\r
212 #define mainUART_QUEUE_LENGTHS 10
\r
214 /*-----------------------------------------------------------*/
\r
217 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
218 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
220 void main_full( void );
\r
223 * The check task, as described at the top of this file.
\r
225 static void prvCheckTask( void *pvParameters );
\r
228 * Register check tasks, and the tasks used to write over and check the contents
\r
229 * of the FPU registers, as described at the top of this file. The nature of
\r
230 * these files necessitates that they are written in an assembly file, but the
\r
231 * entry points are kept in the C file for the convenience of checking the task
\r
234 static void prvRegTestTaskEntry1( void *pvParameters );
\r
235 extern void vRegTest1Implementation( void );
\r
236 static void prvRegTestTaskEntry2( void *pvParameters );
\r
237 extern void vRegTest2Implementation( void );
\r
240 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
241 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
243 extern void vRegisterSampleCLICommands( void );
\r
244 extern void vRegisterFileSystemCLICommands( void );
\r
247 * Creates and verifies different files on the volume, demonstrating the use of
\r
248 * various different API functions.
\r
250 extern void vCreateAndVerifySampleFiles( void );
\r
252 /*-----------------------------------------------------------*/
\r
254 /* The following two variables are used to communicate the status of the
\r
255 register check tasks to the check software timer. If the variables keep
\r
256 incrementing, then the register check tasks has not discovered any errors. If
\r
257 a variable stops incrementing, then an error has been found. */
\r
258 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
260 /*-----------------------------------------------------------*/
\r
262 void main_full( void )
\r
264 /* The baud rate setting here has no effect, hence it is set to 0 to
\r
265 make that obvious. */
\r
266 xSerialPortInitMinimal( 0, mainUART_QUEUE_LENGTHS );
\r
268 /* If the file system is only going to be accessed from one task then
\r
269 F_FS_THREAD_AWARE can be set to 0 and the set of example files are created
\r
270 before the RTOS scheduler is started. If the file system is going to be
\r
271 access from more than one task then F_FS_THREAD_AWARE must be set to 1 and
\r
272 the set of sample files are created from the idle task hook function
\r
273 vApplicationIdleHook() - which is defined in this file. */
\r
274 #if ( mainINCLUDE_FAT_SL_DEMO == 1 )&& ( F_FS_THREAD_AWARE == 0 )
\r
276 /* Initialise the drive and file system, then create a few example
\r
277 files. The output from this function just goes to the stdout window,
\r
278 allowing the output to be viewed when the UDP command console is not
\r
280 vCreateAndVerifySampleFiles();
\r
284 /* Start all the other standard demo/test tasks. The have not particular
\r
285 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
287 vStartDynamicPriorityTasks();
\r
288 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
289 vCreateBlockTimeTasks();
\r
290 vStartCountingSemaphoreTasks();
\r
291 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
292 vStartRecursiveMutexTasks();
\r
293 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
294 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
295 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
296 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
298 #if mainINCLUDE_FAT_SL_DEMO == 1
\r
300 /* Start the tasks that implements the command console on the UART, as
\r
301 described above. */
\r
302 vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );
\r
304 /* Register both the standard and file system related CLI commands. */
\r
305 vRegisterSampleCLICommands();
\r
306 vRegisterFileSystemCLICommands();
\r
310 /* The COM test tasks can use the UART if the CLI is not used by the
\r
311 FAT SL demo. The COM test tasks require a UART connector to be fitted
\r
312 to the UART port. */
\r
313 vAltStartComTestTasks( mainCOM_TEST_TASK_PRIORITY, mainBAUD_RATE, mainCOM_TEST_LED );
\r
318 /* Create the register check tasks, as described at the top of this
\r
320 xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
321 xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
323 /* Create the task that performs the 'check' functionality, as described at
\r
324 the top of this file. */
\r
325 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
327 /* The set of tasks created by the following function call have to be
\r
328 created last as they keep account of the number of tasks they expect to see
\r
330 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
332 /* Start the scheduler. */
\r
333 vTaskStartScheduler();
\r
335 /* If all is well, the scheduler will now be running, and the following
\r
336 line will never be reached. If the following line does execute, then
\r
337 there was either insufficient FreeRTOS heap memory available for the idle
\r
338 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
339 User mode. See the memory management section on the FreeRTOS web site for
\r
340 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
341 mode from which main() is called is set in the C start up code and must be
\r
342 a privileged mode (not user mode). */
\r
345 /*-----------------------------------------------------------*/
\r
347 static void prvCheckTask( void *pvParameters )
\r
349 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
350 TickType_t xLastExecutionTime;
\r
351 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
352 unsigned long ulErrorFound = pdFALSE;
\r
354 /* Just to stop compiler warnings. */
\r
355 ( void ) pvParameters;
\r
357 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
358 works correctly. */
\r
359 xLastExecutionTime = xTaskGetTickCount();
\r
361 /* Cycle for ever, delaying then checking all the other tasks are still
\r
362 operating without error. The onboard LED is toggled on each iteration.
\r
363 If an error is detected then the delay period is decreased from
\r
364 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
365 effect of increasing the rate at which the onboard LED toggles, and in so
\r
366 doing gives visual feedback of the system status. */
\r
369 /* Delay until it is time to execute again. */
\r
370 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
372 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
373 that they are all still running, and that none have detected an error. */
\r
374 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
376 ulErrorFound = pdTRUE;
\r
379 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
381 ulErrorFound = pdTRUE;
\r
384 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
386 ulErrorFound = pdTRUE;
\r
389 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
391 ulErrorFound = pdTRUE;
\r
394 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
396 ulErrorFound = pdTRUE;
\r
399 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
401 ulErrorFound = pdTRUE;
\r
404 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
406 ulErrorFound = pdTRUE;
\r
409 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
411 ulErrorFound = pdTRUE;
\r
414 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
416 ulErrorFound = pdTRUE;
\r
419 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
421 ulErrorFound = pdTRUE;
\r
424 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
426 ulErrorFound = pdTRUE;
\r
429 #if mainINCLUDE_FAT_SL_DEMO == 0
\r
431 if( xAreComTestTasksStillRunning() != pdTRUE )
\r
433 ulErrorFound = pdTRUE;
\r
438 /* Check that the register test 1 task is still running. */
\r
439 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
441 ulErrorFound = pdTRUE;
\r
443 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
445 /* Check that the register test 2 task is still running. */
\r
446 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
448 ulErrorFound = pdTRUE;
\r
450 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
452 /* Toggle the check LED to give an indication of the system status. If
\r
453 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
454 everything is ok. A faster toggle indicates an error. */
\r
455 vParTestToggleLED( mainCHECK_LED );
\r
457 if( ulErrorFound != pdFALSE )
\r
459 /* An error has been detected in one of the tasks - flash the LED
\r
460 at a higher frequency to give visible feedback that something has
\r
461 gone wrong (it might just be that the loop back connector required
\r
462 by the comtest tasks has not been fitted). */
\r
463 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
467 /*-----------------------------------------------------------*/
\r
469 static void prvRegTestTaskEntry1( void *pvParameters )
\r
471 /* Although the regtest task is written in assembler, its entry point is
\r
472 written in C for convenience of checking the task parameter is being passed
\r
474 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
476 /* The reg test task also tests the floating point registers. Tasks
\r
477 that use the floating point unit must call vPortTaskUsesFPU() before
\r
478 any floating point instructions are executed. */
\r
479 vPortTaskUsesFPU();
\r
481 /* Start the part of the test that is written in assembler. */
\r
482 vRegTest1Implementation();
\r
485 /* The following line will only execute if the task parameter is found to
\r
486 be incorrect. The check timer will detect that the regtest loop counter is
\r
487 not being incremented and flag an error. */
\r
488 vTaskDelete( NULL );
\r
490 /*-----------------------------------------------------------*/
\r
492 static void prvRegTestTaskEntry2( void *pvParameters )
\r
494 /* Although the regtest task is written in assembler, its entry point is
\r
495 written in C for convenience of checking the task parameter is being passed
\r
497 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
499 /* The reg test task also tests the floating point registers. Tasks
\r
500 that use the floating point unit must call vPortTaskUsesFPU() before
\r
501 any floating point instructions are executed. */
\r
502 vPortTaskUsesFPU();
\r
504 /* Start the part of the test that is written in assembler. */
\r
505 vRegTest2Implementation();
\r
508 /* The following line will only execute if the task parameter is found to
\r
509 be incorrect. The check timer will detect that the regtest loop counter is
\r
510 not being incremented and flag an error. */
\r
511 vTaskDelete( NULL );
\r
513 /*-----------------------------------------------------------*/
\r