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 * This project includes a lot of tasks and tests and is therefore complex.
\r
30 * If you would prefer a much simpler project to get started with then select
\r
31 * the 'Blinky' build configuration within the HEW IDE.
\r
32 * ****************************************************************************
\r
34 * Creates all the demo application tasks, then starts the scheduler. The web
\r
35 * documentation provides more details of the standard demo application tasks,
\r
36 * which provide no particular functionality but do provide a good example of
\r
37 * how to use the FreeRTOS API. The tasks defined in flop.c are included in the
\r
38 * set of standard demo tasks to ensure the floating point unit gets some
\r
41 * In addition to the standard demo tasks, the following tasks and tests are
\r
42 * defined and/or created within this file:
\r
44 * Webserver ("uIP") task - This serves a number of dynamically generated WEB
\r
45 * pages to a standard WEB browser. The IP and MAC addresses are configured by
\r
46 * constants defined at the bottom of FreeRTOSConfig.h. Use either a standard
\r
47 * Ethernet cable to connect through a hug, or a cross over (point to point)
\r
48 * cable to connect directly. Ensure the IP address used is compatible with the
\r
49 * IP address of the machine running the browser - the easiest way to achieve
\r
50 * this is to ensure the first three octets of the IP addresses are the same.
\r
52 * "Reg test" tasks - These fill the registers with known values, then check
\r
53 * that each register still contains its expected value. Each task uses
\r
54 * different values. The tasks run with very low priority so get preempted
\r
55 * very frequently. A check variable is incremented on each iteration of the
\r
56 * test loop. A register containing an unexpected value is indicative of an
\r
57 * error in the context switching mechanism and will result in a branch to a
\r
58 * null loop - which in turn will prevent the check variable from incrementing
\r
59 * any further and allow the check task (described below) to determine that an
\r
60 * error has occurred. The nature of the reg test tasks necessitates that they
\r
61 * are written in assembly code.
\r
63 * "Check" task - This only executes every five seconds but has a high priority
\r
64 * to ensure it gets processor time. Its main function is to check that all the
\r
65 * standard demo tasks are still operational. While no errors have been
\r
66 * discovered the check task will toggle LED 5 every 5 seconds - the toggle
\r
67 * rate increasing to 200ms being a visual indication that at least one task has
\r
68 * reported unexpected behaviour.
\r
70 * "High frequency timer test" - A high frequency periodic interrupt is
\r
71 * generated using a timer - the interrupt is assigned a priority above
\r
72 * configMAX_SYSCALL_INTERRUPT_PRIORITY so should not be effected by anything
\r
73 * the kernel is doing. The frequency and priority of the interrupt, in
\r
74 * combination with other standard tests executed in this demo, should result
\r
75 * in interrupts nesting at least 3 and probably 4 deep. This test is only
\r
76 * included in build configurations that have the optimiser switched on. In
\r
77 * optimised builds the count of high frequency ticks is used as the time base
\r
78 * for the run time stats.
\r
80 * *NOTE 1* If LED5 is toggling every 5 seconds then all the demo application
\r
81 * tasks are executing as expected and no errors have been reported in any
\r
82 * tasks. The toggle rate increasing to 200ms indicates that at least one task
\r
83 * has reported unexpected behaviour.
\r
85 * *NOTE 2* vApplicationSetupTimerInterrupt() is called by the kernel to let
\r
86 * the application set up a timer to generate the tick interrupt. In this
\r
87 * example a compare match timer is used for this purpose.
\r
89 * *NOTE 3* The CPU must be in Supervisor mode when the scheduler is started.
\r
90 * The PowerON_Reset_PC() supplied in resetprg.c with this demo has
\r
91 * Change_PSW_PM_to_UserMode() commented out to ensure this is the case.
\r
93 * *NOTE 4* The IntQueue common demo tasks test interrupt nesting and make use
\r
94 * of all the 8bit timers (as two cascaded 16bit units).
\r
97 /* Hardware specific includes. */
\r
98 #include "iodefine.h"
\r
100 /* Kernel includes. */
\r
101 #include "FreeRTOS.h"
\r
104 /* Standard demo includes. */
\r
105 #include "partest.h"
\r
107 #include "IntQueue.h"
\r
108 #include "BlockQ.h"
\r
110 #include "integer.h"
\r
111 #include "blocktim.h"
\r
112 #include "semtest.h"
\r
114 #include "GenQTest.h"
\r
116 #include "recmutex.h"
\r
119 /* Values that are passed into the reg test tasks using the task parameter. The
\r
120 tasks check that the values are passed in correctly. */
\r
121 #define mainREG_TEST_1_PARAMETER ( 0x12121212UL )
\r
122 #define mainREG_TEST_2_PARAMETER ( 0x12345678UL )
\r
124 /* Priorities at which the tasks are created. */
\r
125 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
126 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
127 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
128 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
129 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
130 #define mainFLASH_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
131 #define mainuIP_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
132 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
133 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
134 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
136 /* The WEB server uses string handling functions, which in turn use a bit more
\r
137 stack than most of the other tasks. */
\r
138 #define mainuIP_STACK_SIZE ( configMINIMAL_STACK_SIZE * 3 )
\r
140 /* The LED toggled by the check task. */
\r
141 #define mainCHECK_LED ( 5 )
\r
143 /* The rate at which mainCHECK_LED will toggle when all the tasks are running
\r
144 without error. Controlled by the check task as described at the top of this
\r
146 #define mainNO_ERROR_CYCLE_TIME ( 5000 / portTICK_PERIOD_MS )
\r
148 /* The rate at which mainCHECK_LED will toggle when an error has been reported
\r
149 by at least one task. Controlled by the check task as described at the top of
\r
151 #define mainERROR_CYCLE_TIME ( 200 / portTICK_PERIOD_MS )
\r
154 * vApplicationMallocFailedHook() will only be called if
\r
155 * configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h. It is a hook
\r
156 * function that will execute if a call to pvPortMalloc() fails.
\r
157 * pvPortMalloc() is called internally by the kernel whenever a task, queue or
\r
158 * semaphore is created. It is also called by various parts of the demo
\r
161 void vApplicationMallocFailedHook( void );
\r
164 * vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set to 1
\r
165 * in FreeRTOSConfig.h. It is a hook function that is called on each iteration
\r
166 * of the idle task. It is essential that code added to this hook function
\r
167 * never attempts to block in any way (for example, call xQueueReceive() with
\r
168 * a block time specified). If the application makes use of the vTaskDelete()
\r
169 * API function (as this demo application does) then it is also important that
\r
170 * vApplicationIdleHook() is permitted to return to its calling function because
\r
171 * it is the responsibility of the idle task to clean up memory allocated by the
\r
172 * kernel to any task that has since been deleted.
\r
174 void vApplicationIdleHook( void );
\r
177 * vApplicationStackOverflowHook() will only be called if
\r
178 * configCHECK_FOR_STACK_OVERFLOW is set to a non-zero value. The handle and
\r
179 * name of the offending task should be passed in the function parameters, but
\r
180 * it is possible that the stack overflow will have corrupted these - in which
\r
181 * case pxCurrentTCB can be inspected to find the same information.
\r
183 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName );
\r
186 * The reg test tasks as described at the top of this file.
\r
188 static void prvRegTest1Task( void *pvParameters );
\r
189 static void prvRegTest2Task( void *pvParameters );
\r
192 * The actual implementation of the reg test functionality, which, because of
\r
193 * the direct register access, have to be in assembly.
\r
195 static void prvRegTest1Implementation( void );
\r
196 static void prvRegTest2Implementation( void );
\r
199 * The check task as described at the top of this file.
\r
201 static void prvCheckTask( void *pvParameters );
\r
204 * Contains the implementation of the WEB server.
\r
206 extern void vuIP_Task( void *pvParameters );
\r
208 /*-----------------------------------------------------------*/
\r
210 /* Variables that are incremented on each iteration of the reg test tasks -
\r
211 provided the tasks have not reported any errors. The check task inspects these
\r
212 variables to ensure they are still incrementing as expected. If a variable
\r
213 stops incrementing then it is likely that its associate task has stalled. */
\r
214 unsigned long ulRegTest1CycleCount = 0UL, ulRegTest2CycleCount = 0UL;
\r
216 /* The status message that is displayed at the bottom of the "task stats" web
\r
217 page, which is served by the uIP task. This will report any errors picked up
\r
218 by the reg test task. */
\r
219 const char *pcStatusMessage = "All tasks executing without error.";
\r
221 /*-----------------------------------------------------------*/
\r
225 extern void HardwareSetup( void );
\r
227 /* Renesas provided CPU configuration routine. The clocks are configured in
\r
231 /* Turn all LEDs off. */
\r
232 vParTestInitialise();
\r
234 /* Start the reg test tasks which test the context switching mechanism. */
\r
235 xTaskCreate( prvRegTest1Task, "RegTst1", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
236 xTaskCreate( prvRegTest2Task, "RegTst2", configMINIMAL_STACK_SIZE, ( void * ) mainREG_TEST_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
238 /* The web server task. */
\r
239 xTaskCreate( vuIP_Task, "uIP", mainuIP_STACK_SIZE, NULL, mainuIP_TASK_PRIORITY, NULL );
\r
241 /* Start the check task as described at the top of this file. */
\r
242 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE * 3, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
244 /* Create the standard demo tasks. */
\r
245 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
246 vCreateBlockTimeTasks();
\r
247 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
248 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
249 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
250 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
251 vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );
\r
252 vStartQueuePeekTasks();
\r
253 vStartRecursiveMutexTasks();
\r
254 vStartInterruptQueueTasks();
\r
255 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
257 /* The suicide tasks must be created last as they need to know how many
\r
258 tasks were running prior to their creation in order to ascertain whether
\r
259 or not the correct/expected number of tasks are running at any given time. */
\r
260 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
262 /* Start the tasks running. */
\r
263 vTaskStartScheduler();
\r
265 /* If all is well we will never reach here as the scheduler will now be
\r
266 running. If we do reach here then it is likely that there was insufficient
\r
267 heap available for the idle task to be created. */
\r
270 /*-----------------------------------------------------------*/
\r
272 static void prvCheckTask( void *pvParameters )
\r
274 static volatile unsigned long ulLastRegTest1CycleCount = 0UL, ulLastRegTest2CycleCount = 0UL;
\r
275 TickType_t xNextWakeTime, xCycleFrequency = mainNO_ERROR_CYCLE_TIME;
\r
276 extern void vSetupHighFrequencyTimer( void );
\r
278 /* If this is being executed then the kernel has been started. Start the high
\r
279 frequency timer test as described at the top of this file. This is only
\r
280 included in the optimised build configuration - otherwise it takes up too much
\r
281 CPU time and can disrupt other tests. */
\r
282 #ifdef INCLUDE_HIGH_FREQUENCY_TIMER_TEST
\r
283 vSetupHighFrequencyTimer();
\r
286 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
287 xNextWakeTime = xTaskGetTickCount();
\r
291 /* Place this task in the blocked state until it is time to run again. */
\r
292 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );
\r
294 /* Check the standard demo tasks are running without error. */
\r
295 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
297 /* Increase the rate at which this task cycles, which will increase the
\r
298 rate at which mainCHECK_LED flashes to give visual feedback that an error
\r
300 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
301 pcStatusMessage = "Error: GenQueue";
\r
303 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
305 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
306 pcStatusMessage = "Error: QueuePeek";
\r
308 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
310 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
311 pcStatusMessage = "Error: BlockQueue";
\r
313 else if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
315 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
316 pcStatusMessage = "Error: BlockTime";
\r
318 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
320 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
321 pcStatusMessage = "Error: SemTest";
\r
323 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
325 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
326 pcStatusMessage = "Error: PollQueue";
\r
328 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
330 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
331 pcStatusMessage = "Error: Death";
\r
333 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
335 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
336 pcStatusMessage = "Error: IntMath";
\r
338 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
340 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
341 pcStatusMessage = "Error: RecMutex";
\r
343 else if( xAreIntQueueTasksStillRunning() != pdPASS )
\r
345 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
346 pcStatusMessage = "Error: IntQueue";
\r
348 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
350 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
351 pcStatusMessage = "Error: Flop";
\r
354 /* Check the reg test tasks are still cycling. They will stop incrementing
\r
355 their loop counters if they encounter an error. */
\r
356 if( ulRegTest1CycleCount == ulLastRegTest1CycleCount )
\r
358 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
359 pcStatusMessage = "Error: RegTest1";
\r
362 if( ulRegTest2CycleCount == ulLastRegTest2CycleCount )
\r
364 xCycleFrequency = mainERROR_CYCLE_TIME;
\r
365 pcStatusMessage = "Error: RegTest2";
\r
368 ulLastRegTest1CycleCount = ulRegTest1CycleCount;
\r
369 ulLastRegTest2CycleCount = ulRegTest2CycleCount;
\r
371 /* Toggle the check LED to give an indication of the system status. If
\r
372 the LED toggles every 5 seconds then everything is ok. A faster toggle
\r
373 indicates an error. */
\r
374 vParTestToggleLED( mainCHECK_LED );
\r
377 /*-----------------------------------------------------------*/
\r
379 /* The RX port uses this callback function to configure its tick interrupt.
\r
380 This allows the application to choose the tick interrupt source. */
\r
381 void vApplicationSetupTimerInterrupt( void )
\r
383 /* Enable compare match timer 0. */
\r
386 /* Interrupt on compare match. */
\r
387 CMT0.CMCR.BIT.CMIE = 1;
\r
389 /* Set the compare match value. */
\r
390 CMT0.CMCOR = ( unsigned short ) ( ( ( configPERIPHERAL_CLOCK_HZ / configTICK_RATE_HZ ) -1 ) / 8 );
\r
392 /* Divide the PCLK by 8. */
\r
393 CMT0.CMCR.BIT.CKS = 0;
\r
395 /* Enable the interrupt... */
\r
396 _IEN( _CMT0_CMI0 ) = 1;
\r
398 /* ...and set its priority to the application defined kernel priority. */
\r
399 _IPR( _CMT0_CMI0 ) = configKERNEL_INTERRUPT_PRIORITY;
\r
401 /* Start the timer. */
\r
402 CMT.CMSTR0.BIT.STR0 = 1;
\r
404 /*-----------------------------------------------------------*/
\r
406 /* This function is explained by the comments above its prototype at the top
\r
408 void vApplicationMallocFailedHook( void )
\r
412 /*-----------------------------------------------------------*/
\r
414 /* This function is explained by the comments above its prototype at the top
\r
416 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
420 /*-----------------------------------------------------------*/
\r
422 /* This function is explained by the comments above its prototype at the top
\r
424 void vApplicationIdleHook( void )
\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( ( ( unsigned long ) 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 prvRegTest1Implementation();
\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( ( ( unsigned long ) 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 prvRegTest2Implementation();
\r
463 /*-----------------------------------------------------------*/
\r
465 /* This function is explained in the comments at the top of this file. */
\r
466 #pragma inline_asm prvRegTest1Implementation
\r
467 static void prvRegTest1Implementation( void )
\r
469 ; Put a known value in each register.
\r
486 ; Loop, checking each iteration that each register still contains the
\r
490 ; Push the registers that are going to get clobbered.
\r
493 ; Increment the loop counter to show this task is still getting CPU time.
\r
494 MOV.L #_ulRegTest1CycleCount, R14
\r
499 ; Yield to extend the text coverage. Set the bit in the ITU SWINTR register.
\r
501 MOV.L #0872E0H, R15
\r
506 ; Restore the clobbered registers.
\r
509 ; Now compare each register to ensure it still contains the value that was
\r
510 ; set before this loop was entered.
\r
542 ; All comparisons passed, start a new itteratio of this loop.
\r
546 ; A compare failed, just loop here so the loop counter stops incrementing
\r
547 ; causing the check task to indicate the error.
\r
550 /*-----------------------------------------------------------*/
\r
552 /* This function is explained in the comments at the top of this file. */
\r
553 #pragma inline_asm prvRegTest2Implementation
\r
554 static void prvRegTest2Implementation( void )
\r
556 ; Put a known value in each register.
\r
573 ; Loop, checking on each iteration that each register still contains the
\r
577 ; Push the registers that are going to get clobbered.
\r
580 ; Increment the loop counter to show this task is still getting CPU time.
\r
581 MOV.L #_ulRegTest2CycleCount, R14
\r
586 ; Restore the clobbered registers.
\r
620 ; All comparisons passed, start a new itteratio of this loop.
\r
624 ; A compare failed, just loop here so the loop counter stops incrementing
\r
625 ; - causing the check task to indicate the error.
\r
628 /*-----------------------------------------------------------*/
\r
630 char *pcGetTaskStatusMessage( void )
\r
632 /* Not bothered about a critical section here although technically because of
\r
633 the task priorities the pointer could change it will be atomic if not near
\r
634 atomic and its not critical. */
\r
635 return ( char * ) pcStatusMessage;
\r
637 /*-----------------------------------------------------------*/
\r
projects / freertos / blob