2 * FreeRTOS Kernel V10.0.0
\r
3 * Copyright (C) 2017 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. If you wish to use our Amazon
\r
14 * FreeRTOS name, please do so in a fair use way that does not cause confusion.
\r
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
\r
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
\r
18 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
\r
19 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
\r
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
\r
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\r
23 * http://www.FreeRTOS.org
\r
24 * http://aws.amazon.com/freertos
\r
26 * 1 tab == 4 spaces!
\r
29 /******************************************************************************
\r
30 * NOTE 1: This project provides two demo applications. A simple blinky
\r
31 * style project, and a more comprehensive test and demo application. The
\r
32 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to
\r
33 * select between the two. See the notes on using
\r
34 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY in main.c. This file implements the
\r
35 * comprehensive version.
\r
37 * NOTE 2: This file only contains the source code that is specific to the
\r
38 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
39 * required to configure the hardware, are defined in main.c.
\r
41 ******************************************************************************
\r
43 * main_full() creates a set of demo application tasks and software timers, then
\r
44 * starts the scheduler. The web documentation provides more details of the
\r
45 * standard demo application tasks, which provide no particular functionality,
\r
46 * but do provide a good example of how to use the FreeRTOS API.
\r
48 * In addition to the standard demo tasks, the following tasks and tests are
\r
49 * defined and/or created within this file:
\r
51 * "FreeRTOS+CLI command console" - The command console uses SCI1 for its
\r
52 * input and output. The baud rate is set to 19200. Type "help" to see a list
\r
53 * of registered commands. The FreeRTOS+CLI license is different to the
\r
54 * FreeRTOS license, see http://www.FreeRTOS.org/cli for license and usage
\r
57 * "Reg test" tasks - These fill both the core and floating point registers with
\r
58 * known values, then check that each register maintains its expected value for
\r
59 * the lifetime of the task. Each task uses a different set of values. The reg
\r
60 * test tasks execute with a very low priority, so get preempted very
\r
61 * frequently. A register containing an unexpected value is indicative of an
\r
62 * error in the context switching mechanism.
\r
64 * "Check" task - The check task period is initially set to three seconds. The
\r
65 * task checks that all the standard demo tasks are not only still executing,
\r
66 * but are executing without reporting any errors. If the check task discovers
\r
67 * that a task has either stalled, or reported an error, then it changes its own
\r
68 * execution period from the initial three seconds, to just 200ms. The check
\r
69 * task also toggles an LED on each iteration of its loop. This provides a
\r
70 * visual indication of the system status: If the LED toggles every three
\r
71 * seconds, then no issues have been discovered. If the LED toggles every
\r
72 * 200ms, then an issue has been discovered with at least one task.
\r
75 /* Standard includes. */
\r
78 /* Kernel includes. */
\r
79 #include "FreeRTOS.h"
\r
84 /* 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 mainUART_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3UL )
\r
112 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
113 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
115 /* The priority used by the UART command console task. */
\r
116 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
118 /* The period of the check task, in ms, provided no errors have been reported by
\r
119 any of the standard demo tasks. ms are converted to the equivalent in ticks
\r
120 using the portTICK_PERIOD_MS constant. */
\r
121 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
123 /* The period of the check task, in ms, if an error has been reported in one of
\r
124 the standard demo tasks. ms are converted to the equivalent in ticks using the
\r
125 portTICK_PERIOD_MS constant. */
\r
126 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 200UL )
\r
128 /* Parameters that are passed into the register check tasks solely for the
\r
129 purpose of ensuring parameters are passed into tasks correctly. */
\r
130 #define mainREG_TEST_1_PARAMETER ( ( void * ) 0x12121212UL )
\r
131 #define mainREG_TEST_2_PARAMETER ( ( void * ) 0x12345678UL )
\r
133 /* The base period used by the timer test tasks. */
\r
134 #define mainTIMER_TEST_PERIOD ( 50 )
\r
136 /*-----------------------------------------------------------*/
\r
139 * Entry point for the comprehensive demo (as opposed to the simple blinky
\r
142 void main_full( void );
\r
145 * The full demo includes some functionality called from the tick hook.
\r
147 void vFullDemoTickHook( void );
\r
150 * The check task, as described at the top of this file.
\r
152 static void prvCheckTask( void *pvParameters );
\r
155 * Register check tasks, and the tasks used to write over and check the contents
\r
156 * of the registers, as described at the top of this file. The nature of these
\r
157 * files necessitates that they are written in assembly, but the entry points
\r
158 * are kept in the C file for the convenience of checking the task parameter.
\r
160 static void prvRegTest1Task( void *pvParameters );
\r
161 static void prvRegTest2Task( void *pvParameters );
\r
162 static void prvRegTest1Implementation( void );
\r
163 static void prvRegTest2Implementation( void );
\r
166 * A high priority task that does nothing other than execute at a pseudo random
\r
167 * time to ensure the other test tasks don't just execute in a repeating
\r
170 static void prvPseudoRandomiser( void *pvParameters );
\r
173 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
174 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
176 extern void vRegisterSampleCLICommands( void );
\r
179 * The task that manages the FreeRTOS+CLI input and output.
\r
181 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
183 /*-----------------------------------------------------------*/
\r
185 /* The following two variables are used to communicate the status of the
\r
186 register check tasks to the check task. If the variables keep incrementing,
\r
187 then the register check tasks have not discovered any errors. If a variable
\r
188 stops incrementing, then an error has been found. */
\r
189 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
191 /*-----------------------------------------------------------*/
\r
193 void main_full( void )
\r
195 /* Start all the other standard demo/test tasks. They have no particular
\r
196 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
198 vStartInterruptQueueTasks();
\r
199 vStartDynamicPriorityTasks();
\r
200 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
201 vCreateBlockTimeTasks();
\r
202 vStartCountingSemaphoreTasks();
\r
203 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
204 vStartRecursiveMutexTasks();
\r
205 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
206 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
207 vStartEventGroupTasks();
\r
208 vStartTaskNotifyTask();
\r
209 vStartInterruptSemaphoreTasks();
\r
211 /* Create the register check tasks, as described at the top of this file */
\r
212 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
213 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
215 /* Create the task that just adds a little random behaviour. */
\r
216 xTaskCreate( prvPseudoRandomiser, "Rnd", configMINIMAL_STACK_SIZE, NULL, configMAX_PRIORITIES - 1, NULL );
\r
218 /* Start the tasks that implements the command console on the UART, as
\r
219 described above. */
\r
220 vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );
\r
222 /* Register the standard CLI commands. */
\r
223 vRegisterSampleCLICommands();
\r
225 /* Create the task that performs the 'check' functionality, as described at
\r
226 the top of this file. */
\r
227 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
229 /* The set of tasks created by the following function call have to be
\r
230 created last as they keep account of the number of tasks they expect to see
\r
232 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
234 /* Start the scheduler. */
\r
235 vTaskStartScheduler();
\r
237 /* If all is well, the scheduler will now be running, and the following
\r
238 line will never be reached. If the following line does execute, then
\r
239 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
240 timer tasks to be created. See the memory management section on the
\r
241 FreeRTOS web site for more details on the FreeRTOS heap
\r
242 http://www.freertos.org/a00111.html. */
\r
245 /*-----------------------------------------------------------*/
\r
247 static void prvCheckTask( void *pvParameters )
\r
249 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
250 TickType_t xLastExecutionTime;
\r
251 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
252 unsigned long ulErrorFound = pdFALSE;
\r
254 /* Just to stop compiler warnings. */
\r
255 ( void ) pvParameters;
\r
257 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
258 works correctly. */
\r
259 xLastExecutionTime = xTaskGetTickCount();
\r
261 /* Cycle for ever, delaying then checking all the other tasks are still
\r
262 operating without error. The onboard LED is toggled on each iteration.
\r
263 If an error is detected then the delay period is decreased from
\r
264 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
265 effect of increasing the rate at which the onboard LED toggles, and in so
\r
266 doing gives visual feedback of the system status. */
\r
269 /* Delay until it is time to execute again. */
\r
270 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
272 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
273 that they are all still running, and that none have detected an error. */
\r
274 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
276 ulErrorFound |= 1UL << 0UL;
\r
279 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
281 ulErrorFound |= 1UL << 2UL;
\r
284 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
286 ulErrorFound |= 1UL << 3UL;
\r
289 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
291 ulErrorFound |= 1UL << 4UL;
\r
294 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
296 ulErrorFound |= 1UL << 5UL;
\r
299 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
301 ulErrorFound |= 1UL << 6UL;
\r
304 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
306 ulErrorFound |= 1UL << 7UL;
\r
309 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
311 ulErrorFound |= 1UL << 8UL;
\r
314 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
316 ulErrorFound |= 1UL << 10UL;
\r
319 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
321 ulErrorFound |= 1UL << 11UL;
\r
324 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
326 ulErrorFound |= 1UL << 12UL;
\r
329 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )
\r
331 ulErrorFound |= 1UL << 13UL;
\r
334 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )
\r
336 ulErrorFound |= 1UL << 14UL;
\r
339 /* Check that the register test 1 task is still running. */
\r
340 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
342 ulErrorFound |= 1UL << 15UL;
\r
344 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
346 /* Check that the register test 2 task is still running. */
\r
347 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
349 ulErrorFound |= 1UL << 16UL;
\r
351 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
353 /* Toggle the check LED to give an indication of the system status. If
\r
354 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
355 everything is ok. A faster toggle indicates an error. */
\r
358 if( ulErrorFound != pdFALSE )
\r
360 /* An error has been detected in one of the tasks - flash the LED
\r
361 at a higher frequency to give visible feedback that something has
\r
362 gone wrong (it might just be that the loop back connector required
\r
363 by the comtest tasks has not been fitted). */
\r
364 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
368 /*-----------------------------------------------------------*/
\r
370 static void prvPseudoRandomiser( void *pvParameters )
\r
372 const uint32_t ulMultiplier = 0x015a4e35UL, ulIncrement = 1UL, ulMinDelay = ( 35 / portTICK_PERIOD_MS );
\r
373 volatile uint32_t ulNextRand = ( uint32_t ) &pvParameters, ulValue;
\r
375 /* This task does nothing other than ensure there is a little bit of
\r
376 disruption in the scheduling pattern of the other tasks. Normally this is
\r
377 done by generating interrupts at pseudo random times. */
\r
380 ulNextRand = ( ulMultiplier * ulNextRand ) + ulIncrement;
\r
381 ulValue = ( ulNextRand >> 16UL ) & 0xffUL;
\r
383 if( ulValue < ulMinDelay )
\r
385 ulValue = ulMinDelay;
\r
388 vTaskDelay( ulValue );
\r
390 while( ulValue > 0 )
\r
405 /*-----------------------------------------------------------*/
\r
407 void vFullDemoTickHook( void )
\r
409 /* Call the periodic queue overwrite from ISR demo. */
\r
410 vQueueOverwritePeriodicISRDemo();
\r
412 /* Call the periodic event group from ISR demo. */
\r
413 vPeriodicEventGroupsProcessing();
\r
415 /* Use task notifications from an interrupt. */
\r
416 xNotifyTaskFromISR();
\r
418 /* Use mutexes from interrupts. */
\r
419 vInterruptSemaphorePeriodicTest();
\r
421 /*-----------------------------------------------------------*/
\r
423 /* This function is explained in the comments at the top of this file. */
\r
424 static void prvRegTest1Task( void *pvParameters )
\r
426 if( pvParameters != mainREG_TEST_1_PARAMETER )
\r
428 /* The parameter did not contain the expected value. */
\r
431 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
432 taskDISABLE_INTERRUPTS();
\r
436 /* This is an inline asm function that never returns. */
\r
437 prvRegTest1Implementation();
\r
439 /*-----------------------------------------------------------*/
\r
441 /* This function is explained in the comments at the top of this file. */
\r
442 static void prvRegTest2Task( void *pvParameters )
\r
444 if( pvParameters != mainREG_TEST_2_PARAMETER )
\r
446 /* The parameter did not contain the expected value. */
\r
449 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
450 taskDISABLE_INTERRUPTS();
\r
454 /* This is an inline asm function that never returns. */
\r
455 prvRegTest2Implementation();
\r
457 /*-----------------------------------------------------------*/
\r
459 /* This function is explained in the comments at the top of this file. */
\r
460 #pragma inline_asm prvRegTest1Implementation
\r
461 static void prvRegTest1Implementation( void )
\r
463 ; Put a known value in each register.
\r
480 ; Loop, checking each iteration that each register still contains the
\r
484 ; Push the registers that are going to get clobbered.
\r
487 ; Increment the loop counter to show this task is still getting CPU time.
\r
488 MOV.L #_ulRegTest1LoopCounter, R14
\r
493 ; Yield to extend the text coverage. Set the bit in the ITU SWINTR register.
\r
495 MOV.L #0872E0H, R15
\r
500 ; Restore the clobbered registers.
\r
503 ; Now compare each register to ensure it still contains the value that was
\r
504 ; set before this loop was entered.
\r
536 ; All comparisons passed, start a new itteratio of this loop.
\r
540 ; A compare failed, just loop here so the loop counter stops incrementing
\r
541 ; causing the check task to indicate the error.
\r
544 /*-----------------------------------------------------------*/
\r
546 /* This function is explained in the comments at the top of this file. */
\r
547 #pragma inline_asm prvRegTest2Implementation
\r
548 static void prvRegTest2Implementation( void )
\r
550 ; Put a known value in each register.
\r
567 ; Loop, checking on each iteration that each register still contains the
\r
571 ; Push the registers that are going to get clobbered.
\r
574 ; Increment the loop counter to show this task is still getting CPU time.
\r
575 MOV.L #_ulRegTest2LoopCounter, R14
\r
580 ; Restore the clobbered registers.
\r
614 ; All comparisons passed, start a new itteratio of this loop.
\r
618 ; A compare failed, just loop here so the loop counter stops incrementing
\r
619 ; - causing the check task to indicate the error.
\r
622 /*-----------------------------------------------------------*/
\r