2 * FreeRTOS Kernel V10.2.1
\r
3 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
\r
5 * Permission is hereby granted, free of charge, to any person obtaining a copy of
\r
6 * this software and associated documentation files (the "Software"), to deal in
\r
7 * the Software without restriction, including without limitation the rights to
\r
8 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
\r
9 * the Software, and to permit persons to whom the Software is furnished to do so,
\r
10 * subject to the following conditions:
\r
12 * The above copyright notice and this permission notice shall be included in all
\r
13 * copies or substantial portions of the Software.
\r
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
17 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
18 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
19 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
20 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
22 * http://www.FreeRTOS.org
\r
23 * http://aws.amazon.com/freertos
\r
25 * 1 tab == 4 spaces!
\r
28 /******************************************************************************
\r
29 * NOTE 1: This project provides two demo applications. A simple blinky
\r
30 * style project, and a more comprehensive test and demo application. The
\r
31 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to
\r
32 * select between the two. See the notes on using
\r
33 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY in main.c. This file implements the
\r
34 * comprehensive version.
\r
36 * NOTE 2: This file only contains the source code that is specific to the
\r
37 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
38 * required to configure the hardware, are defined in main.c.
\r
40 ******************************************************************************
\r
42 * main_full() creates a set of demo application tasks and software timers, then
\r
43 * starts the scheduler. The web documentation provides more details of the
\r
44 * standard demo application tasks, which provide no particular functionality,
\r
45 * but do provide a good example of how to use the FreeRTOS API.
\r
47 * In addition to the standard demo tasks, the following tasks and tests are
\r
48 * defined and/or created within this file:
\r
50 * "FreeRTOS+CLI command console" - The command console uses SCI1 for its
\r
51 * input and output. The baud rate is set to 19200. Type "help" to see a list
\r
52 * of registered commands. The FreeRTOS+CLI license is different to the
\r
53 * FreeRTOS license, see http://www.FreeRTOS.org/cli for license and usage
\r
56 * "Reg test" tasks - These fill both the core and floating point registers with
\r
57 * known values, then check that each register maintains its expected value for
\r
58 * the lifetime of the task. Each task uses a different set of values. The reg
\r
59 * test tasks execute with a very low priority, so get preempted very
\r
60 * frequently. A register containing an unexpected value is indicative of an
\r
61 * error in the context switching mechanism.
\r
63 * "Check" task - The check task period is initially set to three seconds. The
\r
64 * task checks that all the standard demo tasks are not only still executing,
\r
65 * but are executing without reporting any errors. If the check task discovers
\r
66 * that a task has either stalled, or reported an error, then it changes its own
\r
67 * execution period from the initial three seconds, to just 200ms. The check
\r
68 * task also toggles an LED on each iteration of its loop. This provides a
\r
69 * visual indication of the system status: If the LED toggles every three
\r
70 * seconds, then no issues have been discovered. If the LED toggles every
\r
71 * 200ms, then an issue has been discovered with at least one task.
\r
74 /* Standard includes. */
\r
77 /* Kernel includes. */
\r
78 #include "FreeRTOS.h"
\r
83 /* Standard demo application includes. */
\r
85 #include "semtest.h"
\r
86 #include "dynamic.h"
\r
88 #include "blocktim.h"
\r
89 #include "countsem.h"
\r
90 #include "GenQTest.h"
\r
91 #include "recmutex.h"
\r
93 #include "partest.h"
\r
94 #include "comtest2.h"
\r
96 #include "QueueOverwrite.h"
\r
97 #include "IntQueue.h"
\r
98 #include "EventGroupsDemo.h"
\r
99 #include "TaskNotify.h"
\r
100 #include "IntSemTest.h"
\r
102 /* Renesas includes. */
\r
103 #include <rskrx113def.h>
\r
104 #include "r_cg_macrodriver.h"
\r
105 #include "r_cg_userdefine.h"
\r
107 /* Priorities for the demo application tasks. */
\r
108 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
109 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
110 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
111 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
112 #define mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
113 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
114 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
116 /* The priority used by the UART command console task. */
\r
117 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
119 /* The period of the check task, in ms, provided no errors have been reported by
\r
120 any of the standard demo tasks. ms are converted to the equivalent in ticks
\r
121 using the portTICK_PERIOD_MS constant. */
\r
122 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
124 /* The period of the check task, in ms, if an error has been reported in one of
\r
125 the standard demo tasks. ms are converted to the equivalent in ticks using the
\r
126 portTICK_PERIOD_MS constant. */
\r
127 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 200UL )
\r
129 /* Parameters that are passed into the register check tasks solely for the
\r
130 purpose of ensuring parameters are passed into tasks correctly. */
\r
131 #define mainREG_TEST_1_PARAMETER ( ( void * ) 0x12121212UL )
\r
132 #define mainREG_TEST_2_PARAMETER ( ( void * ) 0x12345678UL )
\r
134 /* The base period used by the timer test tasks. */
\r
135 #define mainTIMER_TEST_PERIOD ( 50 )
\r
137 /*-----------------------------------------------------------*/
\r
140 * Entry point for the comprehensive demo (as opposed to the simple blinky
\r
143 void main_full( void );
\r
146 * The full demo includes some functionality called from the tick hook.
\r
148 void vFullDemoTickHook( void );
\r
151 * The check task, as described at the top of this file.
\r
153 static void prvCheckTask( void *pvParameters );
\r
156 * Register check tasks, and the tasks used to write over and check the contents
\r
157 * of the registers, as described at the top of this file. The nature of these
\r
158 * files necessitates that they are written in assembly, but the entry points
\r
159 * are kept in the C file for the convenience of checking the task parameter.
\r
161 static void prvRegTest1Task( void *pvParameters );
\r
162 static void prvRegTest2Task( void *pvParameters );
\r
163 void vRegTest1Implementation( void );
\r
164 void vRegTest2Implementation( void );
\r
167 * A high priority task that does nothing other than execute at a pseudo random
\r
168 * time to ensure the other test tasks don't just execute in a repeating
\r
171 static void prvPseudoRandomiser( void *pvParameters );
\r
174 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
175 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
177 extern void vRegisterSampleCLICommands( void );
\r
180 * The task that manages the FreeRTOS+CLI input and output.
\r
182 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
184 /*-----------------------------------------------------------*/
\r
186 /* The following two variables are used to communicate the status of the
\r
187 register check tasks to the check task. If the variables keep incrementing,
\r
188 then the register check tasks have not discovered any errors. If a variable
\r
189 stops incrementing, then an error has been found. */
\r
190 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
192 /*-----------------------------------------------------------*/
\r
194 void main_full( void )
\r
196 /* Start all the other standard demo/test tasks. They have no particular
\r
197 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
199 vStartInterruptQueueTasks();
\r
200 vStartDynamicPriorityTasks();
\r
201 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
202 vCreateBlockTimeTasks();
\r
203 vStartCountingSemaphoreTasks();
\r
204 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
205 vStartRecursiveMutexTasks();
\r
206 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
207 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
208 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
209 vStartEventGroupTasks();
\r
210 vStartTaskNotifyTask();
\r
211 vStartInterruptSemaphoreTasks();
\r
213 /* Create the register check tasks, as described at the top of this file */
\r
214 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
215 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
217 /* Create the task that just adds a little random behaviour. */
\r
218 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 2, NULL );
\r
220 /* Start the tasks that implements the command console on the UART, as
\r
221 described above. */
\r
222 vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );
\r
224 /* Register the standard CLI commands. */
\r
225 vRegisterSampleCLICommands();
\r
227 /* Create the task that performs the 'check' functionality, as described at
\r
228 the top of this file. */
\r
229 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
231 /* The set of tasks created by the following function call have to be
\r
232 created last as they keep account of the number of tasks they expect to see
\r
234 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
236 /* Start the scheduler. */
\r
237 vTaskStartScheduler();
\r
239 /* If all is well, the scheduler will now be running, and the following
\r
240 line will never be reached. If the following line does execute, then
\r
241 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
242 timer tasks to be created. See the memory management section on the
\r
243 FreeRTOS web site for more details on the FreeRTOS heap
\r
244 http://www.freertos.org/a00111.html. */
\r
247 /*-----------------------------------------------------------*/
\r
249 static void prvCheckTask( void *pvParameters )
\r
251 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
252 TickType_t xLastExecutionTime;
\r
253 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
254 unsigned long ulErrorFound = pdFALSE;
\r
256 /* Just to stop compiler warnings. */
\r
257 ( void ) pvParameters;
\r
259 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
260 works correctly. */
\r
261 xLastExecutionTime = xTaskGetTickCount();
\r
263 /* Cycle for ever, delaying then checking all the other tasks are still
\r
264 operating without error. The onboard LED is toggled on each iteration.
\r
265 If an error is detected then the delay period is decreased from
\r
266 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
267 effect of increasing the rate at which the onboard LED toggles, and in so
\r
268 doing gives visual feedback of the system status. */
\r
271 /* Delay until it is time to execute again. */
\r
272 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
274 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
275 that they are all still running, and that none have detected an error. */
\r
276 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
278 ulErrorFound |= 1UL << 0UL;
\r
281 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
283 ulErrorFound |= 1UL << 1UL;
\r
286 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
288 ulErrorFound |= 1UL << 2UL;
\r
291 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
293 ulErrorFound |= 1UL << 3UL;
\r
296 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
298 ulErrorFound |= 1UL << 4UL;
\r
301 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
303 ulErrorFound |= 1UL << 5UL;
\r
306 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
308 ulErrorFound |= 1UL << 6UL;
\r
311 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
313 ulErrorFound |= 1UL << 7UL;
\r
316 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
318 ulErrorFound |= 1UL << 8UL;
\r
321 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
323 ulErrorFound |= 1UL << 10UL;
\r
326 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
328 ulErrorFound |= 1UL << 11UL;
\r
331 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
333 ulErrorFound |= 1UL << 12UL;
\r
336 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
338 ulErrorFound |= 1UL << 13UL;
\r
341 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
343 ulErrorFound |= 1UL << 14UL;
\r
346 /* Check that the register test 1 task is still running. */
\r
347 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
349 ulErrorFound |= 1UL << 15UL;
\r
351 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
353 /* Check that the register test 2 task is still running. */
\r
354 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
356 ulErrorFound |= 1UL << 16UL;
\r
358 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
360 /* Toggle the check LED to give an indication of the system status. If
\r
361 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
362 everything is ok. A faster toggle indicates an error. */
\r
365 if( ulErrorFound != pdFALSE )
\r
367 /* An error has been detected in one of the tasks - flash the LED
\r
368 at a higher frequency to give visible feedback that something has
\r
369 gone wrong (it might just be that the loop back connector required
\r
370 by the comtest tasks has not been fitted). */
\r
371 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
375 /*-----------------------------------------------------------*/
\r
377 static void prvPseudoRandomiser( void *pvParameters )
\r
379 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = pdMS_TO_TICKS( 35 );
\r
380 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
382 /* This task does nothing other than ensure there is a little bit of
\r
383 disruption in the scheduling pattern of the other tasks. Normally this is
\r
384 done by generating interrupts at pseudo random times. */
\r
387 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
388 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
390 if( ulValue < ulMinDelay )
\r
392 ulValue = ulMinDelay;
\r
395 vTaskDelay( ulValue );
\r
397 while( ulValue > 0 )
\r
399 __asm volatile( "NOP" );
\r
400 __asm volatile( "NOP" );
\r
401 __asm volatile( "NOP" );
\r
402 __asm volatile( "NOP" );
\r
403 __asm volatile( "NOP" );
\r
404 __asm volatile( "NOP" );
\r
405 __asm volatile( "NOP" );
\r
411 /*-----------------------------------------------------------*/
\r
413 void vFullDemoTickHook( void )
\r
415 /* Call the periodic queue overwrite from ISR demo. */
\r
416 vQueueOverwritePeriodicISRDemo();
\r
418 /* Call the periodic event group from ISR demo. */
\r
419 vPeriodicEventGroupsProcessing();
\r
421 /* Use task notifications from an interrupt. */
\r
422 xNotifyTaskFromISR();
\r
424 /* Use mutexes from interrupts. */
\r
425 vInterruptSemaphorePeriodicTest();
\r
427 /*-----------------------------------------------------------*/
\r
429 /* This function is explained in the comments at the top of this file. */
\r
430 static void prvRegTest1Task( void *pvParameters )
\r
432 if( pvParameters != mainREG_TEST_1_PARAMETER )
\r
434 /* The parameter did not contain the expected value. */
\r
437 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
438 taskDISABLE_INTERRUPTS();
\r
442 /* This is an inline asm function that never returns. */
\r
443 vRegTest1Implementation();
\r
445 /*-----------------------------------------------------------*/
\r
447 /* This function is explained in the comments at the top of this file. */
\r
448 static void prvRegTest2Task( void *pvParameters )
\r
450 if( pvParameters != mainREG_TEST_2_PARAMETER )
\r
452 /* The parameter did not contain the expected value. */
\r
455 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
456 taskDISABLE_INTERRUPTS();
\r
460 /* This is an inline asm function that never returns. */
\r
461 vRegTest2Implementation();
\r
463 /*-----------------------------------------------------------*/
\r