2 FreeRTOS V9.0.0rc1 - 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 * "FreeRTOS+CLI command console" - The command console uses SCI1 for its
\r
93 * input and output. The baud rate is set to 19200. Type "help" to see a list
\r
94 * of registered commands. The FreeRTOS+CLI license is different to the
\r
95 * FreeRTOS license, see http://www.FreeRTOS.org/cli for license and usage
\r
98 * "Reg test" tasks - These fill both the core and floating point registers with
\r
99 * known values, then check that each register maintains its expected value for
\r
100 * the lifetime of the task. Each task uses a different set of values. The reg
\r
101 * test tasks execute with a very low priority, so get preempted very
\r
102 * frequently. A register containing an unexpected value is indicative of an
\r
103 * error in the context switching mechanism.
\r
105 * "Check" task - The check task period is initially set to three seconds. The
\r
106 * task checks that all the standard demo tasks are not only still executing,
\r
107 * but are executing without reporting any errors. If the check task discovers
\r
108 * that a task has either stalled, or reported an error, then it changes its own
\r
109 * execution period from the initial three seconds, to just 200ms. The check
\r
110 * task also toggles an LED on each iteration of its loop. This provides a
\r
111 * visual indication of the system status: If the LED toggles every three
\r
112 * seconds, then no issues have been discovered. If the LED toggles every
\r
113 * 200ms, then an issue has been discovered with at least one task.
\r
116 /* Standard includes. */
\r
119 /* Kernel includes. */
\r
120 #include "FreeRTOS.h"
\r
122 #include "timers.h"
\r
123 #include "semphr.h"
\r
125 /* Standard demo application includes. */
\r
127 #include "semtest.h"
\r
128 #include "dynamic.h"
\r
129 #include "BlockQ.h"
\r
130 #include "blocktim.h"
\r
131 #include "countsem.h"
\r
132 #include "GenQTest.h"
\r
133 #include "recmutex.h"
\r
135 #include "partest.h"
\r
136 #include "comtest2.h"
\r
137 #include "serial.h"
\r
138 #include "TimerDemo.h"
\r
139 #include "QueueOverwrite.h"
\r
140 #include "IntQueue.h"
\r
141 #include "EventGroupsDemo.h"
\r
142 #include "TaskNotify.h"
\r
143 #include "IntSemTest.h"
\r
145 /* Renesas includes. */
\r
146 #include <rskrx71mdef.h>
\r
147 #include "r_cg_macrodriver.h"
\r
148 #include "r_cg_userdefine.h"
\r
150 /* Priorities for the demo application tasks. */
\r
151 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
152 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
153 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
154 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
155 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
156 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
157 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
159 /* The priority used by the UART command console task. */
\r
160 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
162 /* The period after which the check timer will expire, in ms, provided no errors
\r
163 have been reported by any of the standard demo tasks. ms are converted to the
\r
164 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
165 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
167 /* The period at which the check timer will expire, in ms, if an error has been
\r
168 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
169 in ticks using the portTICK_PERIOD_MS constant. */
\r
170 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 200UL )
\r
172 /* Parameters that are passed into the register check tasks solely for the
\r
173 purpose of ensuring parameters are passed into tasks correctly. */
\r
174 #define mainREG_TEST_1_PARAMETER ( ( void * ) 0x12121212UL )
\r
175 #define mainREG_TEST_2_PARAMETER ( ( void * ) 0x12345678UL )
\r
177 /* The base period used by the timer test tasks. */
\r
178 #define mainTIMER_TEST_PERIOD ( 50 )
\r
180 /*-----------------------------------------------------------*/
\r
183 * Entry point for the comprehensive demo (as opposed to the simple blinky
\r
186 void main_full( void );
\r
189 * The full demo includes some functionality called from the tick hook.
\r
191 void vFullDemoTickHook( void );
\r
194 * The check task, as described at the top of this file.
\r
196 static void prvCheckTask( void *pvParameters );
\r
199 * Register check tasks, and the tasks used to write over and check the contents
\r
200 * of the registers, as described at the top of this file. The nature of these
\r
201 * files necessitates that they are written in assembly, but the entry points
\r
202 * are kept in the C file for the convenience of checking the task parameter.
\r
204 static void prvRegTest1Task( void *pvParameters );
\r
205 static void prvRegTest2Task( void *pvParameters );
\r
206 void vRegTest1Implementation( void );
\r
207 void vRegTest2Implementation( void );
\r
210 * A high priority task that does nothing other than execute at a pseudo random
\r
211 * time to ensure the other test tasks don't just execute in a repeating
\r
214 static void prvPseudoRandomiser( void *pvParameters );
\r
217 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
218 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
220 extern void vRegisterSampleCLICommands( void );
\r
223 * The task that manages the FreeRTOS+CLI input and output.
\r
225 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
227 /*-----------------------------------------------------------*/
\r
229 /* The following two variables are used to communicate the status of the
\r
230 register check tasks to the check task. If the variables keep incrementing,
\r
231 then the register check tasks have not discovered any errors. If a variable
\r
232 stops incrementing, then an error has been found. */
\r
233 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
235 /*-----------------------------------------------------------*/
\r
237 void main_full( void )
\r
239 /* Start all the other standard demo/test tasks. They have no particular
\r
240 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
242 vStartInterruptQueueTasks();
\r
243 vStartDynamicPriorityTasks();
\r
244 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
245 vCreateBlockTimeTasks();
\r
246 vStartCountingSemaphoreTasks();
\r
247 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
248 vStartRecursiveMutexTasks();
\r
249 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
250 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
251 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
252 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
253 vStartEventGroupTasks();
\r
254 vStartTaskNotifyTask();
\r
255 vStartInterruptSemaphoreTasks();
\r
257 /* Create the register check tasks, as described at the top of this file */
\r
258 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
259 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
261 /* Create the task that just adds a little random behaviour. */
\r
262 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 2, NULL );
\r
264 /* Start the tasks that implements the command console on the UART, as
\r
265 described above. */
\r
266 vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );
\r
268 /* Register the standard CLI commands. */
\r
269 vRegisterSampleCLICommands();
\r
271 /* Create the task that performs the 'check' functionality, as described at
\r
272 the top of this file. */
\r
273 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
275 /* The set of tasks created by the following function call have to be
\r
276 created last as they keep account of the number of tasks they expect to see
\r
278 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
280 /* Start the scheduler. */
\r
281 vTaskStartScheduler();
\r
283 /* If all is well, the scheduler will now be running, and the following
\r
284 line will never be reached. If the following line does execute, then
\r
285 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
286 timer tasks to be created. See the memory management section on the
\r
287 FreeRTOS web site for more details on the FreeRTOS heap
\r
288 http://www.freertos.org/a00111.html. */
\r
291 /*-----------------------------------------------------------*/
\r
293 static void prvCheckTask( void *pvParameters )
\r
295 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
296 TickType_t xLastExecutionTime;
\r
297 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
298 unsigned long ulErrorFound = pdFALSE;
\r
300 /* Just to stop compiler warnings. */
\r
301 ( void ) pvParameters;
\r
303 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
304 works correctly. */
\r
305 xLastExecutionTime = xTaskGetTickCount();
\r
307 /* Cycle for ever, delaying then checking all the other tasks are still
\r
308 operating without error. The onboard LED is toggled on each iteration.
\r
309 If an error is detected then the delay period is decreased from
\r
310 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
311 effect of increasing the rate at which the onboard LED toggles, and in so
\r
312 doing gives visual feedback of the system status. */
\r
315 /* Delay until it is time to execute again. */
\r
316 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
318 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
319 that they are all still running, and that none have detected an error. */
\r
320 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
322 ulErrorFound |= 1UL << 0UL;
\r
325 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
327 ulErrorFound |= 1UL << 1UL;
\r
330 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
332 ulErrorFound |= 1UL << 2UL;
\r
335 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
337 ulErrorFound |= 1UL << 3UL;
\r
340 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
342 ulErrorFound |= 1UL << 4UL;
\r
345 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
347 ulErrorFound |= 1UL << 5UL;
\r
350 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
352 ulErrorFound |= 1UL << 6UL;
\r
355 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
357 ulErrorFound |= 1UL << 7UL;
\r
360 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
362 ulErrorFound |= 1UL << 8UL;
\r
365 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )
\r
367 ulErrorFound |= 1UL << 9UL;
\r
370 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
372 ulErrorFound |= 1UL << 10UL;
\r
375 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
377 ulErrorFound |= 1UL << 11UL;
\r
380 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
382 ulErrorFound |= 1UL << 12UL;
\r
385 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
387 ulErrorFound |= 1UL << 13UL;
\r
390 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
392 ulErrorFound |= 1UL << 14UL;
\r
395 /* Check that the register test 1 task is still running. */
\r
396 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
398 ulErrorFound |= 1UL << 15UL;
\r
400 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
402 /* Check that the register test 2 task is still running. */
\r
403 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
405 ulErrorFound |= 1UL << 16UL;
\r
407 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
409 /* Toggle the check LED to give an indication of the system status. If
\r
410 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
411 everything is ok. A faster toggle indicates an error. */
\r
414 if( ulErrorFound != pdFALSE )
\r
416 /* An error has been detected in one of the tasks - flash the LED
\r
417 at a higher frequency to give visible feedback that something has
\r
418 gone wrong (it might just be that the loop back connector required
\r
419 by the comtest tasks has not been fitted). */
\r
420 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
424 /*-----------------------------------------------------------*/
\r
426 static void prvPseudoRandomiser( void *pvParameters )
\r
428 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = pdMS_TO_TICKS( 35 );
\r
429 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
431 /* This task does nothing other than ensure there is a little bit of
\r
432 disruption in the scheduling pattern of the other tasks. Normally this is
\r
433 done by generating interrupts at pseudo random times. */
\r
436 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
437 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
439 if( ulValue < ulMinDelay )
\r
441 ulValue = ulMinDelay;
\r
444 vTaskDelay( ulValue );
\r
446 while( ulValue > 0 )
\r
448 __asm volatile( "NOP" );
\r
449 __asm volatile( "NOP" );
\r
450 __asm volatile( "NOP" );
\r
451 __asm volatile( "NOP" );
\r
452 __asm volatile( "NOP" );
\r
453 __asm volatile( "NOP" );
\r
454 __asm volatile( "NOP" );
\r
460 /*-----------------------------------------------------------*/
\r
462 void vFullDemoTickHook( void )
\r
464 /* The full demo includes a software timer demo/test that requires
\r
465 prodding periodically from the tick interrupt. */
\r
466 vTimerPeriodicISRTests();
\r
468 /* Call the periodic queue overwrite from ISR demo. */
\r
469 vQueueOverwritePeriodicISRDemo();
\r
471 /* Call the periodic event group from ISR demo. */
\r
472 vPeriodicEventGroupsProcessing();
\r
474 /* Use task notifications from an interrupt. */
\r
475 xNotifyTaskFromISR();
\r
477 /* Use mutexes from interrupts. */
\r
478 vInterruptSemaphorePeriodicTest();
\r
480 /*-----------------------------------------------------------*/
\r
482 /* This function is explained in the comments at the top of this file. */
\r
483 static void prvRegTest1Task( void *pvParameters )
\r
485 if( pvParameters != mainREG_TEST_1_PARAMETER )
\r
487 /* The parameter did not contain the expected value. */
\r
490 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
491 taskDISABLE_INTERRUPTS();
\r
495 /* This is an inline asm function that never returns. */
\r
496 vRegTest1Implementation();
\r
498 /*-----------------------------------------------------------*/
\r
500 /* This function is explained in the comments at the top of this file. */
\r
501 static void prvRegTest2Task( void *pvParameters )
\r
503 if( pvParameters != mainREG_TEST_2_PARAMETER )
\r
505 /* The parameter did not contain the expected value. */
\r
508 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
509 taskDISABLE_INTERRUPTS();
\r
513 /* This is an inline asm function that never returns. */
\r
514 vRegTest2Implementation();
\r
516 /*-----------------------------------------------------------*/
\r