2 FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /******************************************************************************
\r
71 * NOTE 1: This project provides two demo applications. A simple blinky
\r
72 * style project, and a more comprehensive test and demo application. The
\r
73 * mainSELECTED_APPLICATION setting in main.c is used to select between the two.
\r
74 * See the notes on using mainSELECTED_APPLICATION in main.c. This file
\r
75 * implements the comprehensive version.
\r
77 * NOTE 2: This file only contains the source code that is specific to the
\r
78 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
79 * required to configure the hardware, are defined in main.c.
\r
81 * NOTE 3: The full demo includes a test that checks the floating point context
\r
82 * is maintained correctly across task switches. The standard GCC libraries can
\r
83 * use floating point registers and made this test fail (unless the tasks that
\r
84 * use the library are given a floating point context as described on the
\r
85 * documentation page for this demo).
\r
87 ******************************************************************************
\r
89 * main_full() creates all the demo application tasks and software timers, then
\r
90 * starts the scheduler. The web documentation provides more details of the
\r
91 * standard demo application tasks, which provide no particular functionality,
\r
92 * but do provide a good example of how to use the FreeRTOS API.
\r
94 * In addition to the standard demo tasks, the following tasks and tests are
\r
95 * defined and/or created within this file:
\r
97 * "Reg test" tasks - These fill both the core and floating point registers with
\r
98 * known values, then check that each register maintains its expected value for
\r
99 * the lifetime of the task. Each task uses a different set of values. The reg
\r
100 * test tasks execute with a very low priority, so get preempted very
\r
101 * frequently. A register containing an unexpected value is indicative of an
\r
102 * error in the context switching mechanism.
\r
104 * "Check" task - The check task period is set to five seconds. Each time it
\r
105 * executes it checks all the standard demo tasks, and the register check tasks,
\r
106 * are not only still executing, but are executing without reporting any errors,
\r
107 * then outputs the system status to the UART.
\r
110 /* Standard includes. */
\r
113 /* Kernel includes. */
\r
114 #include "FreeRTOS.h"
\r
116 #include "timers.h"
\r
117 #include "semphr.h"
\r
119 /* Standard demo application includes. */
\r
121 #include "semtest.h"
\r
122 #include "dynamic.h"
\r
123 #include "blocktim.h"
\r
124 #include "countsem.h"
\r
125 #include "GenQTest.h"
\r
126 #include "recmutex.h"
\r
127 #include "IntQueue.h"
\r
128 #include "EventGroupsDemo.h"
\r
129 #include "TaskNotify.h"
\r
130 #include "IntSemTest.h"
\r
131 #include "StaticAllocation.h"
\r
132 #include "AbortDelay.h"
\r
133 #include "QueueOverwrite.h"
\r
134 #include "TimerDemo.h"
\r
136 /* Xilinx includes. */
\r
137 #include "xil_printf.h"
\r
139 /* Priorities for the demo application tasks. */
\r
140 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + ( UBaseType_t ) 1 )
\r
141 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + ( UBaseType_t ) 2 )
\r
142 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + ( UBaseType_t ) 3 )
\r
143 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
144 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * ( UBaseType_t ) 3 )
\r
145 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + ( UBaseType_t ) 2 )
\r
146 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - ( UBaseType_t ) 1 )
\r
147 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
149 /* A block time of zero simply means "don't block". */
\r
150 #define mainDONT_BLOCK ( ( TickType_t ) 0 )
\r
152 /* The period of the check task, in ms. */
\r
153 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( ( TickType_t ) 5000 )
\r
155 /* Parameters that are passed into the register check tasks solely for the
\r
156 purpose of ensuring parameters are passed into tasks correctly. */
\r
157 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
158 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
160 /* The base period used by the timer test tasks. */
\r
161 #define mainTIMER_TEST_PERIOD ( 50 )
\r
163 /*-----------------------------------------------------------*/
\r
167 * The check task, as described at the top of this file.
\r
169 static void prvCheckTask( void *pvParameters );
\r
172 * Register check tasks, and the tasks used to write over and check the contents
\r
173 * of the FPU registers, as described at the top of this file. The nature of
\r
174 * these files necessitates that they are written in an assembly file, but the
\r
175 * entry points are kept in the C file for the convenience of checking the task
\r
178 static void prvRegTestTaskEntry1( void *pvParameters );
\r
179 extern void vRegTest1Implementation( void );
\r
180 static void prvRegTestTaskEntry2( void *pvParameters );
\r
181 extern void vRegTest2Implementation( void );
\r
184 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
185 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
187 extern void vRegisterSampleCLICommands( void );
\r
190 * The task that manages the FreeRTOS+CLI input and output.
\r
192 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
195 * A high priority task that does nothing other than execute at a pseudo random
\r
196 * time to ensure the other test tasks don't just execute in a repeating
\r
199 static void prvPseudoRandomiser( void *pvParameters );
\r
202 * The full demo uses the tick hook function to include test code in the tick
\r
203 * interrupt. vFullDemoTickHook() is called by vApplicationTickHook(), which
\r
204 * is defined in main.c.
\r
206 void vFullDemoTickHook( void );
\r
208 /*-----------------------------------------------------------*/
\r
210 /* The following two variables are used to communicate the status of the
\r
211 register check tasks to the check task. If the variables keep incrementing,
\r
212 then the register check tasks have not discovered any errors. If a variable
\r
213 stops incrementing, then an error has been found. */
\r
214 volatile uint64_t ullRegTest1LoopCounter = 0ULL, ullRegTest2LoopCounter = 0ULL;
\r
216 /*-----------------------------------------------------------*/
\r
218 void main_full( void )
\r
220 /* Start all the other standard demo/test tasks. They have no particular
\r
221 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
223 vStartInterruptQueueTasks();
\r
224 vStartDynamicPriorityTasks();
\r
225 vCreateBlockTimeTasks();
\r
226 vStartCountingSemaphoreTasks();
\r
227 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
228 vStartRecursiveMutexTasks();
\r
229 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
230 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
231 vStartEventGroupTasks();
\r
232 vStartTaskNotifyTask();
\r
233 vStartInterruptSemaphoreTasks();
\r
234 vStartStaticallyAllocatedTasks();
\r
235 vCreateAbortDelayTasks();
\r
236 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
237 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
239 /* Create the register check tasks, as described at the top of this file */
\r
240 xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
241 xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
243 /* Create the task that just adds a little random behaviour. */
\r
244 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
246 /* Create the task that performs the 'check' functionality, as described at
\r
247 the top of this file. */
\r
248 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
250 /* Start the scheduler. */
\r
251 vTaskStartScheduler();
\r
253 /* If all is well, the scheduler will now be running, and the following
\r
254 line will never be reached. If the following line does execute, then
\r
255 there was either insufficient FreeRTOS heap memory available for the idle
\r
256 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
257 User mode. See the memory management section on the FreeRTOS web site for
\r
258 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
259 mode from which main() is called is set in the C start up code and must be
\r
260 a privileged mode (not user mode). */
\r
263 /*-----------------------------------------------------------*/
\r
265 static void prvCheckTask( void *pvParameters )
\r
267 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
268 TickType_t xLastExecutionTime;
\r
269 static uint64_t ullLastRegTest1Value = 0, ullLastRegTest2Value = 0;
\r
270 uint64_t ullErrorFound = pdFALSE;
\r
271 const char *pcStatusString = "Pass";
\r
273 /* Just to stop compiler warnings. */
\r
274 ( void ) pvParameters;
\r
276 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
277 works correctly. */
\r
278 xLastExecutionTime = xTaskGetTickCount();
\r
280 /* Cycle for ever, delaying then checking all the other tasks are still
\r
281 operating without error. The system status is written to the UART on each
\r
285 /* Delay until it is time to execute again. */
\r
286 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
288 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
289 that they are all still running, and that none have detected an error. */
\r
290 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
292 ullErrorFound |= 1ULL << 0ULL;
\r
293 pcStatusString = "Error: IntQ";
\r
296 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
298 ullErrorFound |= 1ULL << 1ULL;
\r
299 pcStatusString = "Error: Math";
\r
302 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
304 ullErrorFound |= 1ULL << 2ULL;
\r
305 pcStatusString = "Error: Dynamic";
\r
308 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
310 ullErrorFound |= 1ULL << 4ULL;
\r
311 pcStatusString = "Error: Block Time";
\r
314 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
316 ullErrorFound |= 1ULL << 5ULL;
\r
317 pcStatusString = "Error: Generic Queue";
\r
320 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
322 ullErrorFound |= 1ULL << 6ULL;
\r
323 pcStatusString = "Error: Recursive Mutex";
\r
326 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
328 ullErrorFound |= 1ULL << 8ULL;
\r
329 pcStatusString = "Error: Semaphore";
\r
332 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
334 ullErrorFound |= 1ULL << 10ULL;
\r
335 pcStatusString = "Error: Counting Semaphore";
\r
338 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
340 ullErrorFound |= 1ULL << 12ULL;
\r
341 pcStatusString = "Error: Event Group";
\r
344 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
346 ullErrorFound |= 1ULL << 13ULL;
\r
347 pcStatusString = "Error: Task Notifications";
\r
350 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
352 ullErrorFound |= 1ULL << 14ULL;
\r
353 pcStatusString = "Error: Interrupt Semaphore";
\r
356 if( xAreStaticAllocationTasksStillRunning() != pdTRUE )
\r
358 ullErrorFound |= 1ULL << 15ULL;
\r
359 pcStatusString = "Error: Static Allocation";
\r
362 if( xAreAbortDelayTestTasksStillRunning() != pdTRUE )
\r
364 ullErrorFound |= 1ULL << 16ULL;
\r
365 pcStatusString = "Error: Abort Delay";
\r
368 if( xIsQueueOverwriteTaskStillRunning() != pdTRUE )
\r
370 ullErrorFound |= 1ULL << 17ULL;
\r
371 pcStatusString = "Error: Queue Overwrite";
\r
374 if( xAreTimerDemoTasksStillRunning( xDelayPeriod ) != pdTRUE )
\r
376 ullErrorFound |= 1ULL << 18ULL;
\r
377 pcStatusString = "Error: Timer Demo";
\r
380 /* Check that the register test 1 task is still running. */
\r
381 if( ullLastRegTest1Value == ullRegTest1LoopCounter )
\r
383 ullErrorFound |= 1ULL << 17ULL;
\r
384 pcStatusString = "Error: Reg Test 1";
\r
386 ullLastRegTest1Value = ullRegTest1LoopCounter;
\r
388 /* Check that the register test 2 task is still running. */
\r
389 if( ullLastRegTest2Value == ullRegTest2LoopCounter )
\r
391 ullErrorFound |= 1ULL << 18ULL;
\r
392 pcStatusString = "Error: Reg Test 2";
\r
394 ullLastRegTest2Value = ullRegTest2LoopCounter;
\r
396 /* Output the system status string. */
\r
397 xil_printf( "%s, status code = %lu, tick count = %lu\r\n", pcStatusString, ullErrorFound, xTaskGetTickCount() );
\r
399 configASSERT( ullErrorFound == pdFALSE );
\r
402 /*-----------------------------------------------------------*/
\r
404 static void prvRegTestTaskEntry1( void *pvParameters )
\r
406 /* Although the regtest task is written in assembler, its entry point is
\r
407 written in C for convenience of checking the task parameter is being passed
\r
409 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
411 /* The reg test task also tests the floating point registers. Tasks
\r
412 that use the floating point unit must call vPortTaskUsesFPU() before
\r
413 any floating point instructions are executed. */
\r
414 vPortTaskUsesFPU();
\r
416 /* Start the part of the test that is written in assembler. */
\r
417 vRegTest1Implementation();
\r
420 /* The following line will only execute if the task parameter is found to
\r
421 be incorrect. The check task will detect that the regtest loop counter is
\r
422 not being incremented and flag an error. */
\r
423 vTaskDelete( NULL );
\r
425 /*-----------------------------------------------------------*/
\r
427 static void prvRegTestTaskEntry2( void *pvParameters )
\r
429 /* Although the regtest task is written in assembler, its entry point is
\r
430 written in C for convenience of checking the task parameter is being passed
\r
432 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
434 /* The reg test task also tests the floating point registers. Tasks
\r
435 that use the floating point unit must call vPortTaskUsesFPU() before
\r
436 any floating point instructions are executed. */
\r
437 vPortTaskUsesFPU();
\r
439 /* Start the part of the test that is written in assembler. */
\r
440 vRegTest2Implementation();
\r
443 /* The following line will only execute if the task parameter is found to
\r
444 be incorrect. The check task will detect that the regtest loop counter is
\r
445 not being incremented and flag an error. */
\r
446 vTaskDelete( NULL );
\r
448 /*-----------------------------------------------------------*/
\r
450 static void prvPseudoRandomiser( void *pvParameters )
\r
452 const uint64_t ullMultiplier = 0x015a4e35ULL, ullIncrement = 1ULL, ullMinDelay = pdMS_TO_TICKS( 95 );
\r
453 volatile uint64_t ullNextRand = ( uint64_t ) &pvParameters, ullValue;
\r
455 /* This task does nothing other than ensure there is a little bit of
\r
456 disruption in the scheduling pattern of the other tasks. Normally this is
\r
457 done by generating interrupts at pseudo random times. */
\r
460 ullNextRand = ( ullMultiplier * ullNextRand ) + ullIncrement;
\r
461 ullValue = ( ullNextRand >> 16ULL ) & 0xffULL;
\r
463 if( ullValue < ullMinDelay )
\r
465 ullValue = ullMinDelay;
\r
468 vTaskDelay( ullValue );
\r
470 while( ullValue > 0 )
\r
472 __asm volatile( "NOP" );
\r
473 __asm volatile( "NOP" );
\r
474 __asm volatile( "NOP" );
\r
475 __asm volatile( "NOP" );
\r
480 /*-----------------------------------------------------------*/
\r
482 void vFullDemoTickHook( void )
\r
484 /* The full demo includes a software timer demo/test that requires
\r
485 prodding periodically from the tick interrupt. */
\r
486 vTimerPeriodicISRTests();
\r
488 /* Call the periodic queue overwrite from ISR demo. */
\r
489 vQueueOverwritePeriodicISRDemo();
\r
491 /* Call the periodic event group from ISR demo. */
\r
492 vPeriodicEventGroupsProcessing();
\r
494 /* Call the ISR component of the interrupt semaphore test. */
\r
495 vInterruptSemaphorePeriodicTest();
\r
497 /* Call the code that 'gives' a task notification from an ISR. */
\r
498 xNotifyTaskFromISR();
\r