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 * 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 a set of 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 are not only still executing,
\r
101 * but are executing without reporting any errors. If the check task discovers
\r
102 * that a task has either stalled, or reported an error, then it changes its own
\r
103 * execution period from the initial three seconds, to just 200ms. The check
\r
104 * task also toggles an LED on each iteration of its loop. This provides a
\r
105 * visual indication of the system status: If the LED toggles every three
\r
106 * seconds, then no issues have been discovered. If the LED toggles every
\r
107 * 200ms, then an issue has been discovered with at least one task.
\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 "BlockQ.h"
\r
124 #include "blocktim.h"
\r
125 #include "countsem.h"
\r
126 #include "GenQTest.h"
\r
127 #include "recmutex.h"
\r
129 #include "partest.h"
\r
130 #include "comtest2.h"
\r
131 #include "serial.h"
\r
132 #include "TimerDemo.h"
\r
133 #include "QueueOverwrite.h"
\r
134 #include "IntQueue.h"
\r
135 #include "EventGroupsDemo.h"
\r
136 #include "TaskNotify.h"
\r
137 #include "IntSemTest.h"
\r
139 /* Renesas includes. */
\r
140 #include "rskrx231def.h"
\r
142 /* Priorities for the demo application tasks. */
\r
143 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
144 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
145 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
146 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
147 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
148 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
149 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
151 /* The period after which the check timer will expire, in ms, provided no errors
\r
152 have been reported by any of the standard demo tasks. ms are converted to the
\r
153 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
154 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
156 /* The period at which the check timer will expire, in ms, if an error has been
\r
157 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
158 in ticks using the portTICK_PERIOD_MS constant. */
\r
159 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 200UL )
\r
161 /* Parameters that are passed into the register check tasks solely for the
\r
162 purpose of ensuring parameters are passed into tasks correctly. */
\r
163 #define mainREG_TEST_1_PARAMETER ( ( void * ) 0x12121212UL )
\r
164 #define mainREG_TEST_2_PARAMETER ( ( void * ) 0x12345678UL )
\r
166 /* The base period used by the timer test tasks. */
\r
167 #define mainTIMER_TEST_PERIOD ( 50 )
\r
169 /*-----------------------------------------------------------*/
\r
172 * Entry point for the comprehensive demo (as opposed to the simple blinky
\r
175 void main_full( void );
\r
178 * The full demo includes some functionality called from the tick hook.
\r
180 void vFullDemoTickHook( void );
\r
183 * The check task, as described at the top of this file.
\r
185 static void prvCheckTask( void *pvParameters );
\r
188 * Register check tasks, and the tasks used to write over and check the contents
\r
189 * of the registers, as described at the top of this file. The nature of these
\r
190 * files necessitates that they are written in assembly, but the entry points
\r
191 * are kept in the C file for the convenience of checking the task parameter.
\r
193 static void prvRegTest1Task( void *pvParameters );
\r
194 static void prvRegTest2Task( void *pvParameters );
\r
195 static void prvRegTest1Implementation( void );
\r
196 static void prvRegTest2Implementation( void );
\r
199 * A high priority task that does nothing other than execute at a pseudo random
\r
200 * time to ensure the other test tasks don't just execute in a repeating
\r
203 static void prvPseudoRandomiser( void *pvParameters );
\r
205 /*-----------------------------------------------------------*/
\r
207 /* The following two variables are used to communicate the status of the
\r
208 register check tasks to the check task. If the variables keep incrementing,
\r
209 then the register check tasks have not discovered any errors. If a variable
\r
210 stops incrementing, then an error has been found. */
\r
211 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
213 /*-----------------------------------------------------------*/
\r
215 void main_full( void )
\r
217 /* Start all the other standard demo/test tasks. They have no particular
\r
218 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
220 vStartInterruptQueueTasks();
\r
221 vStartDynamicPriorityTasks();
\r
222 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
223 vCreateBlockTimeTasks();
\r
224 vStartCountingSemaphoreTasks();
\r
225 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
226 vStartRecursiveMutexTasks();
\r
227 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
228 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
229 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
230 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
231 vStartEventGroupTasks();
\r
232 vStartTaskNotifyTask();
\r
233 vStartInterruptSemaphoreTasks();
\r
235 /* Create the register check tasks, as described at the top of this file */
\r
236 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
237 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
239 /* Create the task that just adds a little random behaviour. */
\r
240 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
242 /* Create the task that performs the 'check' functionality, as described at
\r
243 the top of this file. */
\r
244 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
246 /* The set of tasks created by the following function call have to be
\r
247 created last as they keep account of the number of tasks they expect to see
\r
249 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
251 /* Start the scheduler. */
\r
252 vTaskStartScheduler();
\r
254 /* If all is well, the scheduler will now be running, and the following
\r
255 line will never be reached. If the following line does execute, then
\r
256 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
257 timer tasks to be created. See the memory management section on the
\r
258 FreeRTOS web site for more details on the FreeRTOS heap
\r
259 http://www.freertos.org/a00111.html. */
\r
262 /*-----------------------------------------------------------*/
\r
264 static void prvCheckTask( void *pvParameters )
\r
266 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
267 TickType_t xLastExecutionTime;
\r
268 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
269 unsigned long ulErrorFound = pdFALSE;
\r
271 /* Just to stop compiler warnings. */
\r
272 ( void ) pvParameters;
\r
274 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
275 works correctly. */
\r
276 xLastExecutionTime = xTaskGetTickCount();
\r
278 /* Cycle for ever, delaying then checking all the other tasks are still
\r
279 operating without error. The onboard LED is toggled on each iteration.
\r
280 If an error is detected then the delay period is decreased from
\r
281 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
282 effect of increasing the rate at which the onboard LED toggles, and in so
\r
283 doing gives visual feedback of the system status. */
\r
286 /* Delay until it is time to execute again. */
\r
287 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
289 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
290 that they are all still running, and that none have detected an error. */
\r
291 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
293 ulErrorFound |= 1UL << 0UL;
\r
296 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
298 ulErrorFound |= 1UL << 1UL;
\r
301 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
303 ulErrorFound |= 1UL << 2UL;
\r
306 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
308 ulErrorFound |= 1UL << 3UL;
\r
311 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
313 ulErrorFound |= 1UL << 4UL;
\r
316 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
318 ulErrorFound |= 1UL << 5UL;
\r
321 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
323 ulErrorFound |= 1UL << 6UL;
\r
326 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
328 ulErrorFound |= 1UL << 7UL;
\r
331 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
333 ulErrorFound |= 1UL << 8UL;
\r
336 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
338 ulErrorFound |= 1UL << 9UL;
\r
341 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
343 ulErrorFound |= 1UL << 10UL;
\r
346 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
348 ulErrorFound |= 1UL << 11UL;
\r
351 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
353 ulErrorFound |= 1UL << 12UL;
\r
356 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
358 ulErrorFound |= 1UL << 13UL;
\r
361 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
363 ulErrorFound |= 1UL << 14UL;
\r
366 /* Check that the register test 1 task is still running. */
\r
367 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
369 ulErrorFound |= 1UL << 15UL;
\r
371 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
373 /* Check that the register test 2 task is still running. */
\r
374 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
376 ulErrorFound |= 1UL << 16UL;
\r
378 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
380 /* Toggle the check LED to give an indication of the system status. If
\r
381 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
382 everything is ok. A faster toggle indicates an error. */
\r
385 if( ulErrorFound != pdFALSE )
\r
387 /* An error has been detected in one of the tasks - flash the LED
\r
388 at a higher frequency to give visible feedback that something has
\r
389 gone wrong (it might just be that the loop back connector required
\r
390 by the comtest tasks has not been fitted). */
\r
391 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
395 /*-----------------------------------------------------------*/
\r
397 static void prvPseudoRandomiser( void *pvParameters )
\r
399 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = pdMS_TO_TICKS( 35 );
\r
400 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
402 /* This task does nothing other than ensure there is a little bit of
\r
403 disruption in the scheduling pattern of the other tasks. Normally this is
\r
404 done by generating interrupts at pseudo random times. */
\r
407 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
408 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
410 if( ulValue < ulMinDelay )
\r
412 ulValue = ulMinDelay;
\r
415 vTaskDelay( ulValue );
\r
417 while( ulValue > 0 )
\r
432 /*-----------------------------------------------------------*/
\r
434 void vFullDemoTickHook( void )
\r
436 /* The full demo includes a software timer demo/test that requires
\r
437 prodding periodically from the tick interrupt. */
\r
438 vTimerPeriodicISRTests();
\r
440 /* Call the periodic queue overwrite from ISR demo. */
\r
441 vQueueOverwritePeriodicISRDemo();
\r
443 /* Call the periodic event group from ISR demo. */
\r
444 vPeriodicEventGroupsProcessing();
\r
446 /* Use task notifications from an interrupt. */
\r
447 xNotifyTaskFromISR();
\r
449 /* Use mutexes from interrupts. */
\r
450 vInterruptSemaphorePeriodicTest();
\r
452 /*-----------------------------------------------------------*/
\r
454 /* This function is explained in the comments at the top of this file. */
\r
455 static void prvRegTest1Task( void *pvParameters )
\r
457 if( pvParameters != mainREG_TEST_1_PARAMETER )
\r
459 /* The parameter did not contain the expected value. */
\r
462 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
463 taskDISABLE_INTERRUPTS();
\r
467 /* This is an inline asm function that never returns. */
\r
468 prvRegTest1Implementation();
\r
470 /*-----------------------------------------------------------*/
\r
472 /* This function is explained in the comments at the top of this file. */
\r
473 static void prvRegTest2Task( void *pvParameters )
\r
475 if( pvParameters != mainREG_TEST_2_PARAMETER )
\r
477 /* The parameter did not contain the expected value. */
\r
480 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
481 taskDISABLE_INTERRUPTS();
\r
485 /* This is an inline asm function that never returns. */
\r
486 prvRegTest2Implementation();
\r
488 /*-----------------------------------------------------------*/
\r
490 /* This function is explained in the comments at the top of this file. */
\r
491 #pragma inline_asm prvRegTest1Implementation
\r
492 static void prvRegTest1Implementation( void )
\r
494 ; Put a known value in each register.
\r
511 ; Loop, checking each iteration that each register still contains the
\r
515 ; Push the registers that are going to get clobbered.
\r
518 ; Increment the loop counter to show this task is still getting CPU time.
\r
519 MOV.L #_ulRegTest1LoopCounter, R14
\r
524 ; Yield to extend the text coverage. Set the bit in the ITU SWINTR register.
\r
526 MOV.L #0872E0H, R15
\r
531 ; Restore the clobbered registers.
\r
534 ; Now compare each register to ensure it still contains the value that was
\r
535 ; set before this loop was entered.
\r
567 ; All comparisons passed, start a new itteratio of this loop.
\r
571 ; A compare failed, just loop here so the loop counter stops incrementing
\r
572 ; causing the check task to indicate the error.
\r
575 /*-----------------------------------------------------------*/
\r
577 /* This function is explained in the comments at the top of this file. */
\r
578 #pragma inline_asm prvRegTest2Implementation
\r
579 static void prvRegTest2Implementation( void )
\r
581 ; Put a known value in each register.
\r
598 ; Loop, checking on each iteration that each register still contains the
\r
602 ; Push the registers that are going to get clobbered.
\r
605 ; Increment the loop counter to show this task is still getting CPU time.
\r
606 MOV.L #_ulRegTest2LoopCounter, R14
\r
611 ; Restore the clobbered registers.
\r
645 ; All comparisons passed, start a new itteratio of this loop.
\r
649 ; A compare failed, just loop here so the loop counter stops incrementing
\r
650 ; - causing the check task to indicate the error.
\r
653 /*-----------------------------------------------------------*/
\r