2 FreeRTOS V8.2.2 - Copyright (C) 2015 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 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to
\r
74 * select between the two. See the notes on using
\r
75 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY in main.c. This file implements the
\r
76 * comprehensive version.
\r
78 * NOTE 2: This file only contains the source code that is specific to the
\r
79 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
80 * required to configure the hardware, are defined in main.c.
\r
82 ******************************************************************************
\r
84 * main_full() creates all the demo application tasks and software timers, then
\r
85 * starts the scheduler. The web documentation provides more details of the
\r
86 * standard demo application tasks, which provide no particular functionality,
\r
87 * but do provide a good example of how to use the FreeRTOS API.
\r
89 * In addition to the standard demo tasks, the following tasks and tests are
\r
90 * defined and/or created within this file:
\r
92 * "Reg test" tasks - These fill both the core and floating point registers with
\r
93 * known values, then check that each register maintains its expected value for
\r
94 * the lifetime of the task. Each task uses a different set of values. The reg
\r
95 * test tasks execute with a very low priority, so get preempted very
\r
96 * frequently. A register containing an unexpected value is indicative of an
\r
97 * error in the context switching mechanism.
\r
99 * "Check" task - The check task period is initially set to three seconds. The
\r
100 * task checks that all the standard demo tasks, and the register check tasks,
\r
101 * are not only still executing, but are executing without reporting any errors.
\r
102 * If the check task discovers that a task has either stalled, or reported an
\r
103 * error, then it changes its own execution period from the initial three
\r
104 * seconds, to just 200ms. The check task also toggles an LED each time it is
\r
105 * called. This provides a visual indication of the system status: If the LED
\r
106 * toggles every three seconds, then no issues have been discovered. If the LED
\r
107 * toggles every 200ms, then an issue has been discovered with at least one
\r
111 /* Standard includes. */
\r
114 /* Kernel includes. */
\r
115 #include "FreeRTOS.h"
\r
117 #include "timers.h"
\r
118 #include "semphr.h"
\r
120 /* Standard demo application includes. */
\r
122 #include "semtest.h"
\r
123 #include "dynamic.h"
\r
124 #include "BlockQ.h"
\r
125 #include "blocktim.h"
\r
126 #include "countsem.h"
\r
127 #include "GenQTest.h"
\r
128 #include "recmutex.h"
\r
130 #include "partest.h"
\r
131 #include "comtest2.h"
\r
132 #include "serial.h"
\r
133 #include "TimerDemo.h"
\r
134 #include "QueueOverwrite.h"
\r
135 #include "IntQueue.h"
\r
136 #include "EventGroupsDemo.h"
\r
137 #include "TaskNotify.h"
\r
138 #include "IntSemTest.h"
\r
140 /* Renesas includes. */
\r
141 #include "rskrx231def.h"
\r
143 /* Priorities for the demo application tasks. */
\r
144 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
145 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
146 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
147 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
148 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
149 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
150 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
151 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
153 /* The priority used by the UART command console task. */
\r
154 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
156 /* A block time of zero simply means "don't block". */
\r
157 #define mainDONT_BLOCK ( 0UL )
\r
159 /* The period after which the check timer will expire, in ms, provided no errors
\r
160 have been reported by any of the standard demo tasks. ms are converted to the
\r
161 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
162 #define mainNO_ERROR_CHECK_TASK_PERIOD ( 3000UL / portTICK_PERIOD_MS )
\r
164 /* The period at which the check timer will expire, in ms, if an error has been
\r
165 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
166 in ticks using the portTICK_PERIOD_MS constant. */
\r
167 #define mainERROR_CHECK_TASK_PERIOD ( 200UL / portTICK_PERIOD_MS )
\r
169 /* Parameters that are passed into the register check tasks solely for the
\r
170 purpose of ensuring parameters are passed into tasks correctly. */
\r
171 #define mainREG_TEST_1_PARAMETER ( ( void * ) 0x12121212UL )
\r
172 #define mainREG_TEST_2_PARAMETER ( ( void * ) 0x12345678UL )
\r
174 /* The base period used by the timer test tasks. */
\r
175 #define mainTIMER_TEST_PERIOD ( 50 )
\r
177 /*-----------------------------------------------------------*/
\r
180 * Entry point for the comprehensive demo (as opposed to the simple blinky
\r
183 void main_full( void );
\r
186 * The full demo includes some functionality called from the tick hook.
\r
188 void vFullDemoTickHook( void );
\r
191 * The check task, as described at the top of this file.
\r
193 static void prvCheckTask( void *pvParameters );
\r
196 * Register check tasks, and the tasks used to write over and check the contents
\r
197 * of the registers, as described at the top of this file. The nature of these
\r
198 * files necessitates that they are written in assembly, but the entry points
\r
199 * are kept in the C file for the convenience of checking the task parameter.
\r
201 static void prvRegTest1Task( void *pvParameters );
\r
202 static void prvRegTest2Task( void *pvParameters );
\r
203 static void prvRegTest1Implementation( void );
\r
204 static void prvRegTest2Implementation( void );
\r
207 * A high priority task that does nothing other than execute at a pseudo random
\r
208 * time to ensure the other test tasks don't just execute in a repeating
\r
211 static void prvPseudoRandomiser( void *pvParameters );
\r
213 /*-----------------------------------------------------------*/
\r
215 /* The following two variables are used to communicate the status of the
\r
216 register check tasks to the check task. If the variables keep incrementing,
\r
217 then the register check tasks have not discovered any errors. If a variable
\r
218 stops incrementing, then an error has been found. */
\r
219 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
221 /* String for display in the web server. It is set to an error message if the
\r
222 check task detects an error. */
\r
223 const char *pcStatusMessage = "All tasks running without error";
\r
224 /*-----------------------------------------------------------*/
\r
226 void main_full( void )
\r
228 /* Start all the other standard demo/test tasks. They have no particular
\r
229 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
231 vStartInterruptQueueTasks();
\r
232 vStartDynamicPriorityTasks();
\r
233 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
234 vCreateBlockTimeTasks();
\r
235 vStartCountingSemaphoreTasks();
\r
236 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
237 vStartRecursiveMutexTasks();
\r
238 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
239 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
240 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
241 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
242 vStartEventGroupTasks();
\r
243 vStartTaskNotifyTask();
\r
244 vStartInterruptSemaphoreTasks();
\r
246 /* Create the register check tasks, as described at the top of this file */
\r
247 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
248 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
250 /* Create the task that just adds a little random behaviour. */
\r
251 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
253 /* Create the task that performs the 'check' functionality, as described at
\r
254 the top of this file. */
\r
255 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
257 /* The set of tasks created by the following function call have to be
\r
258 created last as they keep account of the number of tasks they expect to see
\r
260 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
262 /* Start the scheduler. */
\r
263 vTaskStartScheduler();
\r
265 /* If all is well, the scheduler will now be running, and the following
\r
266 line will never be reached. If the following line does execute, then
\r
267 there was either insufficient FreeRTOS heap memory available for the idle
\r
268 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
269 User mode. See the memory management section on the FreeRTOS web site for
\r
270 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
271 mode from which main() is called is set in the C start up code and must be
\r
272 a privileged mode (not user mode). */
\r
275 /*-----------------------------------------------------------*/
\r
277 static void prvCheckTask( void *pvParameters )
\r
279 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
280 TickType_t xLastExecutionTime;
\r
281 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
282 unsigned long ulErrorFound = pdFALSE;
\r
284 /* Just to stop compiler warnings. */
\r
285 ( void ) pvParameters;
\r
287 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
288 works correctly. */
\r
289 xLastExecutionTime = xTaskGetTickCount();
\r
291 /* Cycle for ever, delaying then checking all the other tasks are still
\r
292 operating without error. The onboard LED is toggled on each iteration.
\r
293 If an error is detected then the delay period is decreased from
\r
294 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
295 effect of increasing the rate at which the onboard LED toggles, and in so
\r
296 doing gives visual feedback of the system status. */
\r
299 /* Delay until it is time to execute again. */
\r
300 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
302 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
303 that they are all still running, and that none have detected an error. */
\r
304 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
306 ulErrorFound |= 1UL << 0UL;
\r
309 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
311 ulErrorFound |= 1UL << 1UL;
\r
314 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
316 ulErrorFound |= 1UL << 2UL;
\r
319 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
321 ulErrorFound |= 1UL << 3UL;
\r
324 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
326 ulErrorFound |= 1UL << 4UL;
\r
329 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
331 ulErrorFound |= 1UL << 5UL;
\r
334 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
336 ulErrorFound |= 1UL << 6UL;
\r
339 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
341 ulErrorFound |= 1UL << 7UL;
\r
344 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
346 ulErrorFound |= 1UL << 8UL;
\r
349 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
351 ulErrorFound |= 1UL << 9UL;
\r
354 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
356 ulErrorFound |= 1UL << 10UL;
\r
359 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
361 ulErrorFound |= 1UL << 11UL;
\r
364 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
366 ulErrorFound |= 1UL << 12UL;
\r
369 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
371 ulErrorFound |= 1UL << 13UL;
\r
374 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
376 ulErrorFound |= 1UL << 14UL;
\r
379 /* Check that the register test 1 task is still running. */
\r
380 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
382 ulErrorFound |= 1UL << 15UL;
\r
384 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
386 /* Check that the register test 2 task is still running. */
\r
387 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
389 ulErrorFound |= 1UL << 16UL;
\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
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
405 pcStatusMessage = "Error found in at least one task.";
\r
409 /*-----------------------------------------------------------*/
\r
411 static void prvPseudoRandomiser( void *pvParameters )
\r
413 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = ( 35 / portTICK_PERIOD_MS );
\r
414 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
416 /* This task does nothing other than ensure there is a little bit of
\r
417 disruption in the scheduling pattern of the other tasks. Normally this is
\r
418 done by generating interrupts at pseudo random times. */
\r
421 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
422 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
424 if( ulValue < ulMinDelay )
\r
426 ulValue = ulMinDelay;
\r
429 vTaskDelay( ulValue );
\r
431 while( ulValue > 0 )
\r
446 /*-----------------------------------------------------------*/
\r
448 void vFullDemoTickHook( void )
\r
450 /* The full demo includes a software timer demo/test that requires
\r
451 prodding periodically from the tick interrupt. */
\r
452 vTimerPeriodicISRTests();
\r
454 /* Call the periodic queue overwrite from ISR demo. */
\r
455 vQueueOverwritePeriodicISRDemo();
\r
457 /* Call the periodic event group from ISR demo. */
\r
458 vPeriodicEventGroupsProcessing();
\r
460 /* Use task notifications from an interrupt. */
\r
461 xNotifyTaskFromISR();
\r
463 /* Use mutexes from interrupts. */
\r
464 vInterruptSemaphorePeriodicTest();
\r
466 /*-----------------------------------------------------------*/
\r
468 /* This function is explained in the comments at the top of this file. */
\r
469 static void prvRegTest1Task( void *pvParameters )
\r
471 if( pvParameters != mainREG_TEST_1_PARAMETER )
\r
473 /* The parameter did not contain the expected value. */
\r
476 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
477 taskDISABLE_INTERRUPTS();
\r
481 /* This is an inline asm function that never returns. */
\r
482 prvRegTest1Implementation();
\r
484 /*-----------------------------------------------------------*/
\r
486 /* This function is explained in the comments at the top of this file. */
\r
487 static void prvRegTest2Task( void *pvParameters )
\r
489 if( pvParameters != mainREG_TEST_2_PARAMETER )
\r
491 /* The parameter did not contain the expected value. */
\r
494 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
495 taskDISABLE_INTERRUPTS();
\r
499 /* This is an inline asm function that never returns. */
\r
500 prvRegTest2Implementation();
\r
502 /*-----------------------------------------------------------*/
\r
504 /* This function is explained in the comments at the top of this file. */
\r
505 #pragma inline_asm prvRegTest1Implementation
\r
506 static void prvRegTest1Implementation( void )
\r
508 ; Put a known value in each register.
\r
525 ; Loop, checking each iteration that each register still contains the
\r
529 ; Push the registers that are going to get clobbered.
\r
532 ; Increment the loop counter to show this task is still getting CPU time.
\r
533 MOV.L #_ulRegTest1LoopCounter, R14
\r
538 ; Yield to extend the text coverage. Set the bit in the ITU SWINTR register.
\r
540 MOV.L #0872E0H, R15
\r
545 ; Restore the clobbered registers.
\r
548 ; Now compare each register to ensure it still contains the value that was
\r
549 ; set before this loop was entered.
\r
581 ; All comparisons passed, start a new itteratio of this loop.
\r
585 ; A compare failed, just loop here so the loop counter stops incrementing
\r
586 ; causing the check task to indicate the error.
\r
589 /*-----------------------------------------------------------*/
\r
591 /* This function is explained in the comments at the top of this file. */
\r
592 #pragma inline_asm prvRegTest2Implementation
\r
593 static void prvRegTest2Implementation( void )
\r
595 ; Put a known value in each register.
\r
612 ; Loop, checking on each iteration that each register still contains the
\r
616 ; Push the registers that are going to get clobbered.
\r
619 ; Increment the loop counter to show this task is still getting CPU time.
\r
620 MOV.L #_ulRegTest2LoopCounter, R14
\r
625 ; Restore the clobbered registers.
\r
659 ; All comparisons passed, start a new itteratio of this loop.
\r
663 ; A compare failed, just loop here so the loop counter stops incrementing
\r
664 ; - causing the check task to indicate the error.
\r
667 /*-----------------------------------------------------------*/
\r