2 FreeRTOS V8.1.2 - 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 ******************************************************************************
\r
79 * main_full() creates all the demo application tasks and software timers, then
\r
80 * starts the scheduler. The web documentation provides more details of the
\r
81 * standard demo application tasks, which provide no particular functionality,
\r
82 * but do provide a good example of how to use the FreeRTOS API.
\r
84 * In addition to the standard demo tasks, the following tasks and tests are
\r
85 * defined and/or created within this file:
\r
87 * "Reg test" tasks - These fill the core registers with known values, then
\r
88 * check that each register maintains its expected value for the lifetime of the
\r
89 * task. Each task uses a different set of values. The reg test tasks execute
\r
90 * with a very low priority, so get preempted very frequently. A register
\r
91 * containing an unexpected value is indicative of an error in the context
\r
92 * switching mechanism.
\r
94 * "Check" task - The check task period is initially set to three seconds. The
\r
95 * task checks that all the standard demo tasks, and the register check tasks,
\r
96 * are not only still executing, but are executing without reporting any errors.
\r
97 * If the check task discovers that a task has either stalled, or reported an
\r
98 * error, then it changes its own execution period from the initial three
\r
99 * seconds, to just 200ms. The check task also toggles an LED each time it is
\r
100 * called. This provides a visual indication of the system status: If the LED
\r
101 * toggles every three seconds, then no issues have been discovered. If the LED
\r
102 * toggles every 200ms, then an issue has been discovered with at least one
\r
106 /* Standard includes. */
\r
109 /* Kernel includes. */
\r
110 #include "FreeRTOS.h"
\r
112 #include "timers.h"
\r
113 #include "semphr.h"
\r
115 /* Standard demo application includes. */
\r
117 #include "semtest.h"
\r
118 #include "dynamic.h"
\r
119 #include "BlockQ.h"
\r
120 #include "blocktim.h"
\r
121 #include "countsem.h"
\r
122 #include "GenQTest.h"
\r
123 #include "recmutex.h"
\r
125 #include "partest.h"
\r
126 #include "comtest2.h"
\r
127 #include "serial.h"
\r
128 #include "TimerDemo.h"
\r
129 #include "QueueOverwrite.h"
\r
130 #include "IntQueue.h"
\r
131 #include "EventGroupsDemo.h"
\r
134 /* Priorities for the demo application tasks. */
\r
135 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
136 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
137 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
138 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
139 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
140 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
141 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
142 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
143 #define mainFLASH_PRIORITY ( tskIDLE_PRIORITY )
\r
145 /* The priority used by the UART command console task. */
\r
146 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
148 /* The LED used by the check timer. */
\r
149 #define mainCHECK_LED ( 3 )
\r
151 /* A block time of zero simply means "don't block". */
\r
152 #define mainDONT_BLOCK ( 0UL )
\r
154 /* The period after which the check timer will expire, in ms, provided no errors
\r
155 have been reported by any of the standard demo tasks. ms are converted to the
\r
156 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
157 #define mainNO_ERROR_CHECK_TASK_PERIOD ( 3000UL / portTICK_PERIOD_MS )
\r
159 /* The period at which the check timer will expire, in ms, if an error has been
\r
160 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
161 in ticks using the portTICK_PERIOD_MS constant. */
\r
162 #define mainERROR_CHECK_TASK_PERIOD ( 200UL / portTICK_PERIOD_MS )
\r
164 /* Parameters that are passed into the register check tasks solely for the
\r
165 purpose of ensuring parameters are passed into tasks correctly. */
\r
166 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
167 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
169 /* The base period used by the timer test tasks. */
\r
170 #define mainTIMER_TEST_PERIOD ( 50 )
\r
172 /*-----------------------------------------------------------*/
\r
175 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
176 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
178 void main_full( void );
\r
181 * The check task, as described at the top of this file.
\r
183 static void prvCheckTask( void *pvParameters );
\r
186 * Register check tasks, and the tasks used to write over and check the contents
\r
187 * of the FPU registers, as described at the top of this file. The nature of
\r
188 * these files necessitates that they are written in an assembly file, but the
\r
189 * entry points are kept in the C file for the convenience of checking the task
\r
192 static void prvRegTestTaskEntry1( void *pvParameters );
\r
193 extern void vRegTest1Implementation( void );
\r
194 static void prvRegTestTaskEntry2( void *pvParameters );
\r
195 extern void vRegTest2Implementation( void );
\r
198 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
199 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
201 extern void vRegisterSampleCLICommands( void );
\r
204 * The task that manages the FreeRTOS+CLI input and output.
\r
206 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
209 * A high priority task that does nothing other than execute at a pseudo random
\r
210 * time to ensure the other test tasks don't just execute in a repeating
\r
213 static void prvPseudoRandomiser( void *pvParameters );
\r
215 /*-----------------------------------------------------------*/
\r
217 /* The following two variables are used to communicate the status of the
\r
218 register check tasks to the check task. If the variables keep incrementing,
\r
219 then the register check tasks has not discovered any errors. If a variable
\r
220 stops incrementing, then an error has been found. */
\r
221 volatile uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
223 /*-----------------------------------------------------------*/
\r
225 void main_full( void )
\r
227 /* Start all the other standard demo/test tasks. They have not particular
\r
228 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
230 vStartInterruptQueueTasks();
\r
231 vStartDynamicPriorityTasks();
\r
232 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
233 vCreateBlockTimeTasks();
\r
234 vStartCountingSemaphoreTasks();
\r
235 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
236 vStartRecursiveMutexTasks();
\r
237 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
238 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
239 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
240 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
241 vStartEventGroupTasks();
\r
242 vStartLEDFlashTasks( mainFLASH_PRIORITY );
\r
244 /* Create the register check tasks, as described at the top of this file */
\r
245 xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
246 xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
248 /* Create the task that just adds a little random behaviour. */
\r
249 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
251 /* Create the task that performs the 'check' functionality, as described at
\r
252 the top of this file. */
\r
253 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
255 /* The set of tasks created by the following function call have to be
\r
256 created last as they keep account of the number of tasks they expect to see
\r
258 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
260 /* Start the scheduler. */
\r
261 vTaskStartScheduler();
\r
263 /* If all is well, the scheduler will now be running, and the following
\r
264 line will never be reached. If the following line does execute, then
\r
265 there was either insufficient FreeRTOS heap memory available for the idle
\r
266 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
267 User mode. See the memory management section on the FreeRTOS web site for
\r
268 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
269 mode from which main() is called is set in the C start up code and must be
\r
270 a privileged mode (not user mode). */
\r
273 /*-----------------------------------------------------------*/
\r
275 static void prvCheckTask( void *pvParameters )
\r
277 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
278 TickType_t xLastExecutionTime;
\r
279 static uint32_t ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
280 uint32_t ulErrorFound = pdFALSE;
\r
282 /* Just to stop compiler warnings. */
\r
283 ( void ) pvParameters;
\r
285 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
286 works correctly. */
\r
287 xLastExecutionTime = xTaskGetTickCount();
\r
289 /* Cycle for ever, delaying then checking all the other tasks are still
\r
290 operating without error. The onboard LED is toggled on each iteration.
\r
291 If an error is detected then the delay period is decreased from
\r
292 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
293 effect of increasing the rate at which the onboard LED toggles, and in so
\r
294 doing gives visual feedback of the system status. */
\r
297 /* Delay until it is time to execute again. */
\r
298 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
300 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
301 that they are all still running, and that none have detected an error. */
\r
302 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
304 ulErrorFound = pdTRUE;
\r
307 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
309 ulErrorFound = pdTRUE;
\r
312 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
314 ulErrorFound = pdTRUE;
\r
317 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
319 ulErrorFound = pdTRUE;
\r
322 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
324 ulErrorFound = pdTRUE;
\r
327 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
329 ulErrorFound = pdTRUE;
\r
332 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
334 ulErrorFound = pdTRUE;
\r
337 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
339 ulErrorFound = pdTRUE;
\r
342 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
344 ulErrorFound = pdTRUE;
\r
347 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
349 ulErrorFound = pdTRUE;
\r
352 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
354 ulErrorFound = pdTRUE;
\r
357 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
359 ulErrorFound = pdTRUE;
\r
362 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
364 ulErrorFound = pdTRUE;
\r
367 /* Check that the register test 1 task is still running. */
\r
368 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
370 ulErrorFound = pdTRUE;
\r
372 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
374 /* Check that the register test 2 task is still running. */
\r
375 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
377 ulErrorFound = pdTRUE;
\r
379 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
381 /* Toggle the check LED to give an indication of the system status. If
\r
382 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
383 everything is ok. A faster toggle indicates an error. */
\r
384 vParTestToggleLED( mainCHECK_LED );
\r
386 if( ulErrorFound != pdFALSE )
\r
388 /* An error has been detected in one of the tasks - flash the LED
\r
389 at a higher frequency to give visible feedback that something has
\r
390 gone wrong (it might just be that the loop back connector required
\r
391 by the comtest tasks has not been fitted). */
\r
392 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
396 /*-----------------------------------------------------------*/
\r
398 static void prvRegTestTaskEntry1( void *pvParameters )
\r
400 /* Although the regtest task is written in assembler, its entry point is
\r
401 written in C for convenience of checking the task parameter is being passed
\r
403 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
405 /* Start the part of the test that is written in assembler. */
\r
406 vRegTest1Implementation();
\r
409 /* The following line will only execute if the task parameter is found to
\r
410 be incorrect. The check timer will detect that the regtest loop counter is
\r
411 not being incremented and flag an error. */
\r
412 vTaskDelete( NULL );
\r
414 /*-----------------------------------------------------------*/
\r
416 static void prvRegTestTaskEntry2( void *pvParameters )
\r
418 /* Although the regtest task is written in assembler, its entry point is
\r
419 written in C for convenience of checking the task parameter is being passed
\r
421 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
423 /* Start the part of the test that is written in assembler. */
\r
424 vRegTest2Implementation();
\r
427 /* The following line will only execute if the task parameter is found to
\r
428 be incorrect. The check timer will detect that the regtest loop counter is
\r
429 not being incremented and flag an error. */
\r
430 vTaskDelete( NULL );
\r
432 /*-----------------------------------------------------------*/
\r
434 static void prvPseudoRandomiser( void *pvParameters )
\r
436 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = ( 35 / portTICK_PERIOD_MS );
\r
437 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
439 /* This task does nothing other than ensure there is a little bit of
\r
440 disruption in the scheduling pattern of the other tasks. Normally this is
\r
441 done by generating interrupts at pseudo random times. */
\r
444 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
445 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
447 if( ulValue < ulMinDelay )
\r
449 ulValue = ulMinDelay;
\r
452 vTaskDelay( ulValue );
\r
454 while( ulValue > 0 )
\r