2 FreeRTOS V8.0.0 - 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 distribute
\r
28 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
29 >>! the source code for proprietary components outside of the FreeRTOS
\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 * FreeRTOS+CLI command console. The command console is access through the
\r
88 * UART to USB connector on the ZC702 Zynq development board (marked J2). For
\r
89 * reasons of robustness testing the UART driver is deliberately written to be
\r
90 * inefficient and should not be used as a template for a production driver.
\r
91 * Type "help" to see a list of registered commands. The FreeRTOS+CLI license
\r
92 * is different to the FreeRTOS license, see http://www.FreeRTOS.org/cli for
\r
93 * license and usage details. The default baud rate is 115200.
\r
95 * "Reg test" tasks - These fill both the core and floating point registers with
\r
96 * known values, then check that each register maintains its expected value for
\r
97 * the lifetime of the task. Each task uses a different set of values. The reg
\r
98 * test tasks execute with a very low priority, so get preempted very
\r
99 * frequently. A register containing an unexpected value is indicative of an
\r
100 * error in the context switching mechanism.
\r
102 * "Check" task - The check task period is initially set to three seconds. The
\r
103 * task checks that all the standard demo tasks, and the register check tasks,
\r
104 * are not only still executing, but are executing without reporting any errors.
\r
105 * If the check task discovers that a task has either stalled, or reported an
\r
106 * error, then it changes its own execution period from the initial three
\r
107 * seconds, to just 200ms. The check task also toggles an LED each time it is
\r
108 * called. This provides a visual indication of the system status: If the LED
\r
109 * toggles every three seconds, then no issues have been discovered. If the LED
\r
110 * toggles every 200ms, then an issue has been discovered with at least one
\r
114 /* Standard includes. */
\r
117 /* Kernel includes. */
\r
118 #include "FreeRTOS.h"
\r
120 #include "timers.h"
\r
121 #include "semphr.h"
\r
123 /* Standard demo application includes. */
\r
125 #include "semtest.h"
\r
126 #include "dynamic.h"
\r
127 #include "BlockQ.h"
\r
128 #include "blocktim.h"
\r
129 #include "countsem.h"
\r
130 #include "GenQTest.h"
\r
131 #include "recmutex.h"
\r
133 #include "partest.h"
\r
134 #include "comtest2.h"
\r
135 #include "serial.h"
\r
136 #include "TimerDemo.h"
\r
137 #include "QueueOverwrite.h"
\r
138 #include "IntQueue.h"
\r
139 #include "EventGroupsDemo.h"
\r
141 /* Priorities for the demo application tasks. */
\r
142 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
143 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
144 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
145 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
146 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
147 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
148 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
149 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
151 /* The priority used by the UART command console task. */
\r
152 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
154 /* The LED used by the check timer. */
\r
155 #define mainCHECK_LED ( 0 )
\r
157 /* A block time of zero simply means "don't block". */
\r
158 #define mainDONT_BLOCK ( 0UL )
\r
160 /* The period after which the check timer will expire, in ms, provided no errors
\r
161 have been reported by any of the standard demo tasks. ms are converted to the
\r
162 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
163 #define mainNO_ERROR_CHECK_TASK_PERIOD ( 3000UL / portTICK_PERIOD_MS )
\r
165 /* The period at which the check timer will expire, in ms, if an error has been
\r
166 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
167 in ticks using the portTICK_PERIOD_MS constant. */
\r
168 #define mainERROR_CHECK_TASK_PERIOD ( 200UL / portTICK_PERIOD_MS )
\r
170 /* Parameters that are passed into the register check tasks solely for the
\r
171 purpose of ensuring parameters are passed into tasks correctly. */
\r
172 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
173 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
175 /* The base period used by the timer test tasks. */
\r
176 #define mainTIMER_TEST_PERIOD ( 50 )
\r
178 /*-----------------------------------------------------------*/
\r
181 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
182 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
184 void main_full( void );
\r
187 * The check task, as described at the top of this file.
\r
189 static void prvCheckTask( void *pvParameters );
\r
192 * Register check tasks, and the tasks used to write over and check the contents
\r
193 * of the FPU registers, as described at the top of this file. The nature of
\r
194 * these files necessitates that they are written in an assembly file, but the
\r
195 * entry points are kept in the C file for the convenience of checking the task
\r
198 static void prvRegTestTaskEntry1( void *pvParameters );
\r
199 extern void vRegTest1Implementation( void );
\r
200 static void prvRegTestTaskEntry2( void *pvParameters );
\r
201 extern void vRegTest2Implementation( void );
\r
204 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
205 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
207 extern void vRegisterSampleCLICommands( void );
\r
210 * The task that manages the FreeRTOS+CLI input and output.
\r
212 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
215 * A high priority task that does nothing other than execute at a pseudo random
\r
216 * time to ensure the other test tasks don't just execute in a repeating
\r
219 static void prvPseudoRandomiser( void *pvParameters );
\r
221 /*-----------------------------------------------------------*/
\r
223 /* The following two variables are used to communicate the status of the
\r
224 register check tasks to the check task. If the variables keep incrementing,
\r
225 then the register check tasks has not discovered any errors. If a variable
\r
226 stops incrementing, then an error has been found. */
\r
227 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
229 /*-----------------------------------------------------------*/
\r
231 void main_full( void )
\r
233 /* Start all the other standard demo/test tasks. They have not particular
\r
234 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
236 // vStartInterruptQueueTasks();
\r
237 vStartDynamicPriorityTasks();
\r
238 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
239 vCreateBlockTimeTasks();
\r
240 vStartCountingSemaphoreTasks();
\r
241 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
242 vStartRecursiveMutexTasks();
\r
243 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
244 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
245 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
246 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
247 vStartEventGroupTasks();
\r
249 /* Start the tasks that implements the command console on the UART, as
\r
250 described above. */
\r
251 // vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );
\r
253 /* Register the standard CLI commands. */
\r
254 // vRegisterSampleCLICommands();
\r
256 /* Create the register check tasks, as described at the top of this file */
\r
257 xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
258 xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
260 /* Create the task that just adds a little random behaviour. */
\r
261 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
263 /* Create the task that performs the 'check' functionality, as described at
\r
264 the top of this file. */
\r
265 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
267 /* The set of tasks created by the following function call have to be
\r
268 created last as they keep account of the number of tasks they expect to see
\r
270 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
272 /* Start the scheduler. */
\r
273 vTaskStartScheduler();
\r
275 /* If all is well, the scheduler will now be running, and the following
\r
276 line will never be reached. If the following line does execute, then
\r
277 there was either insufficient FreeRTOS heap memory available for the idle
\r
278 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
279 User mode. See the memory management section on the FreeRTOS web site for
\r
280 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
281 mode from which main() is called is set in the C start up code and must be
\r
282 a privileged mode (not user mode). */
\r
285 /*-----------------------------------------------------------*/
\r
287 static void prvCheckTask( void *pvParameters )
\r
289 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
290 TickType_t xLastExecutionTime;
\r
291 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
292 unsigned long ulErrorFound = pdFALSE;
\r
294 /* Just to stop compiler warnings. */
\r
295 ( void ) pvParameters;
\r
297 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
298 works correctly. */
\r
299 xLastExecutionTime = xTaskGetTickCount();
\r
301 /* Cycle for ever, delaying then checking all the other tasks are still
\r
302 operating without error. The onboard LED is toggled on each iteration.
\r
303 If an error is detected then the delay period is decreased from
\r
304 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
305 effect of increasing the rate at which the onboard LED toggles, and in so
\r
306 doing gives visual feedback of the system status. */
\r
309 /* Delay until it is time to execute again. */
\r
310 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
312 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
313 that they are all still running, and that none have detected an error. */
\r
314 // if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
316 // ulErrorFound = pdTRUE;
\r
319 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
321 ulErrorFound = pdTRUE;
\r
324 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
326 ulErrorFound = pdTRUE;
\r
329 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
331 ulErrorFound = pdTRUE;
\r
334 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
336 ulErrorFound = pdTRUE;
\r
339 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
341 ulErrorFound = pdTRUE;
\r
344 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
346 ulErrorFound = pdTRUE;
\r
349 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
351 ulErrorFound = pdTRUE;
\r
354 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
356 ulErrorFound = pdTRUE;
\r
359 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
361 ulErrorFound = pdTRUE;
\r
364 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
366 ulErrorFound = pdTRUE;
\r
369 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
371 ulErrorFound = pdTRUE;
\r
374 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
376 ulErrorFound = pdTRUE;
\r
379 /* Check that the register test 1 task is still running. */
\r
380 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
382 ulErrorFound = pdTRUE;
\r
384 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
386 /* Check that the register test 2 task is still running. */
\r
387 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
389 ulErrorFound = pdTRUE;
\r
391 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
393 /* Toggle the check LED to give an indication of the system status. If
\r
394 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
395 everything is ok. A faster toggle indicates an error. */
\r
396 vParTestToggleLED( mainCHECK_LED );
\r
398 if( ulErrorFound != pdFALSE )
\r
400 /* An error has been detected in one of the tasks - flash the LED
\r
401 at a higher frequency to give visible feedback that something has
\r
402 gone wrong (it might just be that the loop back connector required
\r
403 by the comtest tasks has not been fitted). */
\r
404 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
408 /*-----------------------------------------------------------*/
\r
410 static void prvRegTestTaskEntry1( void *pvParameters )
\r
412 /* Although the regtest task is written in assembler, its entry point is
\r
413 written in C for convenience of checking the task parameter is being passed
\r
415 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
417 /* Start the part of the test that is written in assembler. */
\r
418 vRegTest1Implementation();
\r
421 /* The following line will only execute if the task parameter is found to
\r
422 be incorrect. The check timer will detect that the regtest loop counter is
\r
423 not being incremented and flag an error. */
\r
424 vTaskDelete( NULL );
\r
426 /*-----------------------------------------------------------*/
\r
428 static void prvRegTestTaskEntry2( void *pvParameters )
\r
430 /* Although the regtest task is written in assembler, its entry point is
\r
431 written in C for convenience of checking the task parameter is being passed
\r
433 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
435 /* Start the part of the test that is written in assembler. */
\r
436 vRegTest2Implementation();
\r
439 /* The following line will only execute if the task parameter is found to
\r
440 be incorrect. The check timer will detect that the regtest loop counter is
\r
441 not being incremented and flag an error. */
\r
442 vTaskDelete( NULL );
\r
444 /*-----------------------------------------------------------*/
\r
446 static void prvPseudoRandomiser( void *pvParameters )
\r
448 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = ( 35 / portTICK_PERIOD_MS );
\r
449 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
451 /* This task does nothing other than ensure there is a little bit of
\r
452 disruption in the scheduling pattern of the other tasks. Normally this is
\r
453 done by generating interrupts at pseudo random times. */
\r
456 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
457 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
459 if( ulValue < ulMinDelay )
\r
461 ulValue = ulMinDelay;
\r
464 vTaskDelay( ulValue );
\r
466 while( ulValue > 0 )
\r