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 * This project includes a lot of tasks and tests and is therefore complex.
\r
31 * If you would prefer a much simpler project to get started with then select
\r
32 * the 'Blinky' build configuration within the HEW IDE.
\r
33 * ****************************************************************************
\r
35 * Creates all the demo application tasks, then starts the scheduler. The web
\r
36 * documentation provides more details of the standard demo application tasks,
\r
37 * which provide no particular functionality but do provide a good example of
\r
38 * how to use the FreeRTOS API. The tasks defined in flop.c are included in the
\r
39 * set of standard demo tasks to ensure the floating point unit gets some
\r
42 * In addition to the standard demo tasks, the following tasks and tests are
\r
43 * defined and/or created within this file:
\r
45 * Webserver ("uIP") task - This serves a number of dynamically generated WEB
\r
46 * pages to a standard WEB browser. The IP and MAC addresses are configured by
\r
47 * constants defined at the bottom of FreeRTOSConfig.h. Use either a standard
\r
48 * Ethernet cable to connect through a hug, or a cross over (point to point)
\r
49 * cable to connect directly. Ensure the IP address used is compatible with the
\r
50 * IP address of the machine running the browser - the easiest way to achieve
\r
51 * this is to ensure the first three octets of the IP addresses are the same.
\r
53 * "Reg test" tasks - These fill the registers with known values, then check
\r
54 * that each register still contains its expected value. Each task uses
\r
55 * different values. The tasks run with very low priority so get preempted
\r
56 * very frequently. A check variable is incremented on each iteration of the
\r
57 * test loop. A register containing an unexpected value is indicative of an
\r
58 * error in the context switching mechanism and will result in a branch to a
\r
59 * null loop - which in turn will prevent the check variable from incrementing
\r
60 * any further and allow the check task (described below) to determine that an
\r
61 * error has occurred. The nature of the reg test tasks necessitates that they
\r
62 * are written in assembly code.
\r
64 * "Check" task - This only executes every five seconds but has a high priority
\r
65 * to ensure it gets processor time. Its main function is to check that all the
\r
66 * standard demo tasks are still operational. While no errors have been
\r
67 * discovered the check task will toggle LED 5 (marked LED 9 on the silk
\r
68 * screen!) every 5 seconds - the toggle rate increasing to 200ms being a visual
\r
69 * indication that at least one task has reported unexpected behaviour.
\r
71 * "High frequency timer test" - A high frequency periodic interrupt is
\r
72 * generated using a timer - the interrupt is assigned a priority above
\r
73 * configMAX_SYSCALL_INTERRUPT_PRIORITY so should not be effected by anything
\r
74 * the kernel is doing. The frequency and priority of the interrupt, in
\r
75 * combination with other standard tests executed in this demo, should result
\r
76 * in interrupts nesting at least 3 and probably 4 deep. This test is only
\r
77 * included in build configurations that have the optimiser switched on. In
\r
78 * optimised builds the count of high frequency ticks is used as the time base
\r
79 * for the run time stats.
\r
81 * *NOTE 1* If LED5 is toggling every 5 seconds then all the demo application
\r
82 * tasks are executing as expected and no errors have been reported in any
\r
83 * tasks. The toggle rate increasing to 200ms indicates that at least one task
\r
84 * has reported unexpected behaviour.
\r
86 * *NOTE 2* vApplicationSetupTimerInterrupt() is called by the kernel to let
\r
87 * the application set up a timer to generate the tick interrupt. In this
\r
88 * example a compare match timer is used for this purpose.
\r
90 * *NOTE 3* The CPU must be in Supervisor mode when the scheduler is started.
\r
91 * The PowerON_Reset_PC() supplied in resetprg.c with this demo has
\r
92 * Change_PSW_PM_to_UserMode() commented out to ensure this is the case.
\r
94 * *NOTE 4* The IntQueue common demo tasks test interrupt nesting and make use
\r
95 * of all the 8bit timers (as two cascaded 16bit units).
\r
98 /* Hardware specific includes. */
\r
99 #include "iodefine.h"
\r
101 /* Kernel includes. */
\r
102 #include "FreeRTOS.h"
\r
105 /* Standard demo includes. */
\r
106 #include "partest.h"
\r
108 #include "IntQueue.h"
\r
109 #include "BlockQ.h"
\r
111 #include "integer.h"
\r
112 #include "blocktim.h"
\r
113 #include "semtest.h"
\r
115 #include "GenQTest.h"
\r
117 #include "recmutex.h"
\r
120 /* Values that are passed into the reg test tasks using the task parameter. The
\r
121 tasks check that the values are passed in correctly. */
\r
122 #define mainREG_TEST_1_PARAMETER ( 0x12121212UL )
\r
123 #define mainREG_TEST_2_PARAMETER ( 0x12345678UL )
\r
125 /* Priorities at which the tasks are created. */
\r
126 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
127 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
128 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
129 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
130 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
131 #define mainFLASH_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
132 #define mainuIP_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
133 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
134 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
135 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
137 /* The WEB server uses string handling functions, which in turn use a bit more
\r
138 stack than most of the other tasks. */
\r
139 #define mainuIP_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
141 /* The LED toggled by the check task. */
\r
142 #define mainCHECK_LED ( 5 ) /* Marked LED 9 on the RDK silk screen. */
\r
144 /* The rate at which mainCHECK_LED will toggle when all the tasks are running
\r
145 without error. Controlled by the check task as described at the top of this
\r
147 #define mainNO_ERROR_CYCLE_TIME ( 5000 / portTICK_PERIOD_MS )
\r
149 /* The rate at which mainCHECK_LED will toggle when an error has been reported
\r
150 by at least one task. Controlled by the check task as described at the top of
\r
152 #define mainERROR_CYCLE_TIME ( 200 / portTICK_PERIOD_MS )
\r
155 * vApplicationMallocFailedHook() will only be called if
\r
156 * configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
157 * function that will execute if a call to pvPortMalloc() fails.
\r
158 * pvPortMalloc() is called internally by the kernel whenever a task, queue or
\r
159 * semaphore is created. It is also called by various parts of the demo
\r
162 void vApplicationMallocFailedHook( void );
\r
165 * vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set to 1
\r
166 * in FreeRTOSConfig.h. It is a hook function that is called on each iteration
\r
167 * of the idle task. It is essential that code added to this hook function
\r
168 * never attempts to block in any way (for example, call xQueueReceive() with
\r
169 * a block time specified). If the application makes use of the vTaskDelete()
\r
170 * API function (as this demo application does) then it is also important that
\r
171 * vApplicationIdleHook() is permitted to return to its calling function because
\r
172 * it is the responsibility of the idle task to clean up memory allocated by the
\r
173 * kernel to any task that has since been deleted.
\r
175 void vApplicationIdleHook( void );
\r
178 * vApplicationStackOverflowHook() will only be called if
\r
179 * configCHECK_FOR_STACK_OVERFLOW is set to a non-zero value. The handle and
\r
180 * name of the offending task should be passed in the function parameters, but
\r
181 * it is possible that the stack overflow will have corrupted these - in which
\r
182 * case pxCurrentTCB can be inspected to find the same information.
\r
184 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );
\r
187 * The reg test tasks as described at the top of this file.
\r
189 static void prvRegTest1Task( void *pvParameters );
\r
190 static void prvRegTest2Task( void *pvParameters );
\r
193 * The actual implementation of the reg test functionality, which, because of
\r
194 * the direct register access, have to be in assembly.
\r
196 static void prvRegTest1Implementation( void );
\r
197 static void prvRegTest2Implementation( void );
\r
200 * The check task as described at the top of this file.
\r
202 static void prvCheckTask( void *pvParameters );
\r
205 * Contains the implementation of the WEB server.
\r
207 extern void vuIP_Task( void *pvParameters );
\r
209 /*-----------------------------------------------------------*/
\r
211 /* Variables that are incremented on each iteration of the reg test tasks -
\r
212 provided the tasks have not reported any errors. The check task inspects these
\r
213 variables to ensure they are still incrementing as expected. If a variable
\r
214 stops incrementing then it is likely that its associate task has stalled. */
\r
215 unsigned long ulRegTest1CycleCount = 0UL, ulRegTest2CycleCount = 0UL;
\r
217 /* The status message that is displayed at the bottom of the "task stats" web
\r
218 page, which is served by the uIP task. This will report any errors picked up
\r
219 by the reg test task. */
\r
220 const char *pcStatusMessage = "All tasks executing without error.";
\r
222 /*-----------------------------------------------------------*/
\r
226 extern void HardwareSetup( void );
\r
228 /* Renesas provided CPU configuration routine. The clocks are configured in
\r
232 /* Turn all LEDs off. */
\r
233 vParTestInitialise();
\r
235 /* Start the reg test tasks which test the context switching mechanism. */
\r
236 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
237 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
239 /* The web server task. */
\r
240 xTaskCreate( vuIP_Task, "uIP", mainuIP_STACK_SIZE, NULL, mainuIP_TASK_PRIORITY, NULL );
\r
242 /* Start the check task as described at the top of this file. */
\r
243 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE * 3, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
245 /* Create the standard demo tasks. */
\r
246 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
247 vCreateBlockTimeTasks();
\r
248 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
249 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
250 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
251 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
252 vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );
\r
253 vStartQueuePeekTasks();
\r
254 vStartRecursiveMutexTasks();
\r
255 vStartInterruptQueueTasks();
\r
256 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
258 /* The suicide tasks must be created last as they need to know how many
\r
259 tasks were running prior to their creation in order to ascertain whether
\r
260 or not the correct/expected number of tasks are running at any given time. */
\r
261 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
263 /* Start the tasks running. */
\r
264 vTaskStartScheduler();
\r
266 /* If all is well we will never reach here as the scheduler will now be
\r
267 running. If we do reach here then it is likely that there was insufficient
\r
268 heap available for the idle task to be created. */
\r
271 /*-----------------------------------------------------------*/
\r
273 static void prvCheckTask( void *pvParameters )
\r
275 static volatile unsigned long ulLastRegTest1CycleCount = 0UL, ulLastRegTest2CycleCount = 0UL;
\r
276 TickType_t xNextWakeTime, xCycleFrequency = mainNO_ERROR_CYCLE_TIME;
\r
277 extern void vSetupHighFrequencyTimer( void );
\r
279 /* If this is being executed then the kernel has been started. Start the high
\r
280 frequency timer test as described at the top of this file. This is only
\r
281 included in the optimised build configuration - otherwise it takes up too much
\r
282 CPU time and can disrupt other tests. */
\r
283 #ifdef INCLUDE_HIGH_FREQUENCY_TIMER_TEST
\r
284 vSetupHighFrequencyTimer();
\r
287 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
288 xNextWakeTime = xTaskGetTickCount();
\r
292 /* Place this task in the blocked state until it is time to run again. */
\r
293 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );
\r
295 /* Check the standard demo tasks are running without error. */
\r
296 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
298 /* Increase the rate at which this task cycles, which will increase the
\r
299 rate at which mainCHECK_LED flashes to give visual feedback that an error
\r
301 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
302 pcStatusMessage = "Error: GenQueue";
\r
304 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
306 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
307 pcStatusMessage = "Error: QueuePeek";
\r
309 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
311 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
312 pcStatusMessage = "Error: BlockQueue";
\r
314 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
316 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
317 pcStatusMessage = "Error: BlockTime";
\r
319 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
321 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
322 pcStatusMessage = "Error: SemTest";
\r
324 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
326 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
327 pcStatusMessage = "Error: PollQueue";
\r
329 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
331 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
332 pcStatusMessage = "Error: Death";
\r
334 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
336 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
337 pcStatusMessage = "Error: IntMath";
\r
339 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
341 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
342 pcStatusMessage = "Error: RecMutex";
\r
344 else if( xAreIntQueueTasksStillRunning() != pdPASS )
\r
346 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
347 pcStatusMessage = "Error: IntQueue";
\r
349 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
351 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
352 pcStatusMessage = "Error: Flop";
\r
355 /* Check the reg test tasks are still cycling. They will stop incrementing
\r
356 their loop counters if they encounter an error. */
\r
357 if( ulRegTest1CycleCount == ulLastRegTest1CycleCount )
\r
359 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
360 pcStatusMessage = "Error: RegTest1";
\r
363 if( ulRegTest2CycleCount == ulLastRegTest2CycleCount )
\r
365 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
366 pcStatusMessage = "Error: RegTest2";
\r
369 ulLastRegTest1CycleCount = ulRegTest1CycleCount;
\r
370 ulLastRegTest2CycleCount = ulRegTest2CycleCount;
\r
372 /* Toggle the check LED to give an indication of the system status. If
\r
373 the LED toggles every 5 seconds then everything is ok. A faster toggle
\r
374 indicates an error. */
\r
375 vParTestToggleLED( mainCHECK_LED );
\r
378 /*-----------------------------------------------------------*/
\r
380 /* The RX port uses this callback function to configure its tick interrupt.
\r
381 This allows the application to choose the tick interrupt source. */
\r
382 void vApplicationSetupTimerInterrupt( void )
\r
384 /* Enable compare match timer 0. */
\r
387 /* Interrupt on compare match. */
\r
388 CMT0.CMCR.BIT.CMIE = 1;
\r
390 /* Set the compare match value. */
\r
391 CMT0.CMCOR = ( unsigned short ) ( ( ( configPERIPHERAL_CLOCK_HZ / configTICK_RATE_HZ ) -1 ) / 8 );
\r
393 /* Divide the PCLK by 8. */
\r
394 CMT0.CMCR.BIT.CKS = 0;
\r
396 /* Enable the interrupt... */
\r
397 _IEN( _CMT0_CMI0 ) = 1;
\r
399 /* ...and set its priority to the application defined kernel priority. */
\r
400 _IPR( _CMT0_CMI0 ) = configKERNEL_INTERRUPT_PRIORITY;
\r
402 /* Start the timer. */
\r
403 CMT.CMSTR0.BIT.STR0 = 1;
\r
405 /*-----------------------------------------------------------*/
\r
407 /* This function is explained by the comments above its prototype at the top
\r
409 void vApplicationMallocFailedHook( void )
\r
413 /*-----------------------------------------------------------*/
\r
415 /* This function is explained by the comments above its prototype at the top
\r
417 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
421 /*-----------------------------------------------------------*/
\r
423 /* This function is explained by the comments above its prototype at the top
\r
425 void vApplicationIdleHook( void )
\r
428 /*-----------------------------------------------------------*/
\r
430 /* This function is explained in the comments at the top of this file. */
\r
431 static void prvRegTest1Task( void *pvParameters )
\r
433 if( ( ( unsigned long ) pvParameters ) != mainREG_TEST_1_PARAMETER )
\r
435 /* The parameter did not contain the expected value. */
\r
438 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
439 taskDISABLE_INTERRUPTS();
\r
443 /* This is an inline asm function that never returns. */
\r
444 prvRegTest1Implementation();
\r
446 /*-----------------------------------------------------------*/
\r
448 /* This function is explained in the comments at the top of this file. */
\r
449 static void prvRegTest2Task( void *pvParameters )
\r
451 if( ( ( unsigned long ) pvParameters ) != mainREG_TEST_2_PARAMETER )
\r
453 /* The parameter did not contain the expected value. */
\r
456 /* Stop the tick interrupt so its obvious something has gone wrong. */
\r
457 taskDISABLE_INTERRUPTS();
\r
461 /* This is an inline asm function that never returns. */
\r
462 prvRegTest2Implementation();
\r
464 /*-----------------------------------------------------------*/
\r
466 /* This function is explained in the comments at the top of this file. */
\r
467 #pragma inline_asm prvRegTest1Implementation
\r
468 static void prvRegTest1Implementation( void )
\r
470 ; Put a known value in each register.
\r
487 ; Loop, checking each iteration that each register still contains the
\r
491 ; Push the registers that are going to get clobbered.
\r
494 ; Increment the loop counter to show this task is still getting CPU time.
\r
495 MOV.L #_ulRegTest1CycleCount, R14
\r
500 ; Yield to extend the text coverage. Set the bit in the ITU SWINTR register.
\r
502 MOV.L #0872E0H, R15
\r
507 ; Restore the clobbered registers.
\r
510 ; Now compare each register to ensure it still contains the value that was
\r
511 ; set before this loop was entered.
\r
543 ; All comparisons passed, start a new itteratio of this loop.
\r
547 ; A compare failed, just loop here so the loop counter stops incrementing
\r
548 ; causing the check task to indicate the error.
\r
551 /*-----------------------------------------------------------*/
\r
553 /* This function is explained in the comments at the top of this file. */
\r
554 #pragma inline_asm prvRegTest2Implementation
\r
555 static void prvRegTest2Implementation( void )
\r
557 ; Put a known value in each register.
\r
574 ; Loop, checking on each iteration that each register still contains the
\r
578 ; Push the registers that are going to get clobbered.
\r
581 ; Increment the loop counter to show this task is still getting CPU time.
\r
582 MOV.L #_ulRegTest2CycleCount, R14
\r
587 ; Restore the clobbered registers.
\r
621 ; All comparisons passed, start a new itteratio of this loop.
\r
625 ; A compare failed, just loop here so the loop counter stops incrementing
\r
626 ; - causing the check task to indicate the error.
\r
629 /*-----------------------------------------------------------*/
\r
631 char *pcGetTaskStatusMessage( void )
\r
633 /* Not bothered about a critical section here although technically because of
\r
634 the task priorities the pointer could change it will be atomic if not near
\r
635 atomic and its not critical. */
\r
636 return ( char * ) pcStatusMessage;
\r
638 /*-----------------------------------------------------------*/
\r