2 * FreeRTOS Kernel V10.3.0
\r
3 * Copyright (C) 2020 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 style
\r
30 * project, and a more comprehensive test and demo application. The
\r
31 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
\r
32 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
\r
33 * in main.c. This file implements the comprehensive test and demo version.
\r
35 * NOTE 2: This file only contains the source code that is specific to the
\r
36 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
37 * required to configure the hardware, are defined in main.c.
\r
39 ******************************************************************************
\r
41 * main_full() creates all the demo application tasks and software timers, then
\r
42 * starts the scheduler. The web documentation provides more details of the
\r
43 * standard demo application tasks, which provide no particular functionality,
\r
44 * but do provide a good example of how to use the FreeRTOS API.
\r
46 * In addition to the standard demo tasks, the following tasks and tests are
\r
47 * defined and/or created within this file:
\r
49 * "Reg test" tasks - These fill both the core registers with known values, then
\r
50 * check that each register maintains its expected value for the lifetime of the
\r
51 * task. Each task uses a different set of values. The reg test tasks execute
\r
52 * with a very low priority, so get preempted very frequently. A register
\r
53 * containing an unexpected value is indicative of an error in the context
\r
54 * switching mechanism.
\r
56 * "Check" task - The check executes every three seconds. It checks that all
\r
57 * the standard demo tasks, and the register check tasks, are not only still
\r
58 * executing, but are executing without reporting any errors. If the check task
\r
59 * discovers that a task has either stalled, or reported an error, then it
\r
60 * prints an error message to the UART, otherwise it prints "Pass.".
\r
63 /* Standard includes. */
\r
67 /* Kernel includes. */
\r
68 #include "FreeRTOS.h"
\r
73 /* Standard demo application includes. */
\r
74 #include "dynamic.h"
\r
75 #include "blocktim.h"
\r
76 #include "GenQTest.h"
\r
77 #include "recmutex.h"
\r
78 #include "TimerDemo.h"
\r
79 #include "EventGroupsDemo.h"
\r
80 #include "TaskNotify.h"
\r
81 #include "AbortDelay.h"
\r
82 #include "countsem.h"
\r
84 #include "MessageBufferDemo.h"
\r
85 #include "StreamBufferDemo.h"
\r
86 #include "StreamBufferInterrupt.h"
\r
88 /* Priorities for the demo application tasks. */
\r
89 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
90 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
92 /* The period of the check task, in ms, converted to ticks using the
\r
93 pdMS_TO_TICKS() macro. mainNO_ERROR_CHECK_TASK_PERIOD is used if no errors have
\r
94 been found, mainERROR_CHECK_TASK_PERIOD is used if an error has been found. */
\r
95 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
96 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 500UL )
\r
98 /* Parameters that are passed into the register check tasks solely for the
\r
99 purpose of ensuring parameters are passed into tasks correctly. */
\r
100 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
101 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
103 /* The base period used by the timer test tasks. */
\r
104 #define mainTIMER_TEST_PERIOD ( 50 )
\r
106 /* The size of the stack allocated to the check task (as described in the
\r
107 comments at the top of this file. This is surprisingly large as it calls
\r
108 the logging library's print function, which allocates a 128 byte buffer on its
\r
110 #define mainCHECK_TASK_STACK_SIZE_WORDS 200
\r
112 /* Size of the stacks to allocated for the register check tasks. */
\r
113 #define mainREG_TEST_STACK_SIZE_WORDS 150
\r
115 /*-----------------------------------------------------------*/
\r
118 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
119 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
121 void main_full( void );
\r
124 * The check task, as described at the top of this file.
\r
126 static void prvCheckTask( void *pvParameters );
\r
129 * Initialise and start the peripheral timers that are used to exercise external
\r
130 * interrupt processing.
\r
132 static void prvSetupPeripheralTimers( void );
\r
135 * Register check tasks as described at the top of this file. The nature of
\r
136 * these files necessitates that they are written in an assembly file, but the
\r
137 * entry points are kept in the C file for the convenience of checking the task
\r
140 static void prvRegTestTaskEntry1( void *pvParameters );
\r
141 extern void vRegTest1Implementation( void );
\r
142 static void prvRegTestTaskEntry2( void *pvParameters );
\r
143 extern void vRegTest2Implementation( void );
\r
146 * Tick hook used by the full demo, which includes code that interacts with
\r
147 * some of the tests.
\r
149 void vFullDemoTickHook( void );
\r
151 /*-----------------------------------------------------------*/
\r
153 /* The following two variables are used to communicate the status of the
\r
154 register check tasks to the check task. If the variables keep incrementing,
\r
155 then the register check tasks have not discovered any errors. If a variable
\r
156 stops incrementing, then an error has been found. */
\r
157 volatile uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
159 /*-----------------------------------------------------------*/
\r
161 void main_full( void )
\r
163 /* Start all the other standard demo/test tasks. They have no particular
\r
164 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
166 vStartDynamicPriorityTasks();
\r
167 vCreateBlockTimeTasks();
\r
168 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
169 vStartRecursiveMutexTasks();
\r
170 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
171 vStartEventGroupTasks();
\r
172 vStartTaskNotifyTask();
\r
173 vCreateAbortDelayTasks();
\r
174 vStartCountingSemaphoreTasks();
\r
175 vStartMessageBufferTasks( configMINIMAL_STACK_SIZE );
\r
176 vStartStreamBufferTasks();
\r
177 vStartStreamBufferInterruptDemo();
\r
179 /* Create the register check tasks, as described at the top of this file.
\r
180 Use xTaskCreateStatic() to create a task using only statically allocated
\r
182 xTaskCreate( prvRegTestTaskEntry1, /* The function that implements the task. */
\r
183 "Reg1", /* The name of the task. */
\r
184 mainREG_TEST_STACK_SIZE_WORDS, /* Size of stack to allocate for the task - in words not bytes!. */
\r
185 mainREG_TEST_TASK_1_PARAMETER, /* Parameter passed into the task. */
\r
186 tskIDLE_PRIORITY, /* Priority of the task. */
\r
187 NULL ); /* Can be used to pass out a handle to the created task. */
\r
188 xTaskCreate( prvRegTestTaskEntry2, "Reg2", mainREG_TEST_STACK_SIZE_WORDS, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
190 /* Create the task that performs the 'check' functionality, as described at
\r
191 the top of this file. */
\r
192 xTaskCreate( prvCheckTask, "Check", mainCHECK_TASK_STACK_SIZE_WORDS, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
194 /* The set of tasks created by the following function call have to be
\r
195 created last as they keep account of the number of tasks they expect to see
\r
197 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
199 /* Start the timers that are used to exercise external interrupt handling. */
\r
200 prvSetupPeripheralTimers();
\r
202 /* Start the scheduler. */
\r
203 vTaskStartScheduler();
\r
205 /* If all is well, the scheduler will now be running, and the following
\r
206 line will never be reached. If the following line does execute, then
\r
207 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
208 timer tasks to be created. See the memory management section on the
\r
209 FreeRTOS web site for more details on the FreeRTOS heap
\r
210 http://www.freertos.org/a00111.html. */
\r
213 /*-----------------------------------------------------------*/
\r
215 static void prvCheckTask( void *pvParameters )
\r
217 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
218 TickType_t xLastExecutionTime;
\r
219 uint32_t ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
220 char * const pcPassMessage = ".";
\r
221 char * pcStatusMessage = pcPassMessage;
\r
222 extern void vSendString( const char * const pcString );
\r
223 extern void vToggleLED( void );
\r
225 /* Just to stop compiler warnings. */
\r
226 ( void ) pvParameters;
\r
228 /* Output "pass", then an additional '.' character for each successful
\r
230 vSendString( "Pass" );
\r
232 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
233 works correctly. */
\r
234 xLastExecutionTime = xTaskGetTickCount();
\r
236 /* Cycle for ever, delaying then checking all the other tasks are still
\r
237 operating without error. The onboard LED is toggled on each iteration.
\r
238 If an error is detected then the delay period is decreased from
\r
239 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
240 effect of increasing the rate at which the onboard LED toggles, and in so
\r
241 doing gives visual feedback of the system status. */
\r
244 /* Delay until it is time to execute again. */
\r
245 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
247 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
248 that they are all still running, and that none have detected an error. */
\r
249 if( xAreDynamicPriorityTasksStillRunning() == pdFALSE )
\r
251 pcStatusMessage = "ERROR: Dynamic priority demo/tests.\r\n";
\r
254 if( xAreBlockTimeTestTasksStillRunning() == pdFALSE )
\r
256 pcStatusMessage = "ERROR: Block time demo/tests.\r\n";
\r
259 if( xAreGenericQueueTasksStillRunning() == pdFALSE )
\r
261 pcStatusMessage = "ERROR: Generic queue demo/tests.\r\n";
\r
264 if( xAreRecursiveMutexTasksStillRunning() == pdFALSE )
\r
266 pcStatusMessage = "ERROR: Recursive mutex demo/tests.\r\n";
\r
269 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) == pdFALSE )
\r
271 pcStatusMessage = "ERROR: Timer demo/tests.\r\n";
\r
274 if( xAreEventGroupTasksStillRunning() == pdFALSE )
\r
276 pcStatusMessage = "ERROR: Event group demo/tests.\r\n";
\r
279 if( xAreTaskNotificationTasksStillRunning() == pdFALSE )
\r
281 pcStatusMessage = "ERROR: Task notification demo/tests.\r\n";
\r
284 if( xAreAbortDelayTestTasksStillRunning() == pdFALSE )
\r
286 pcStatusMessage = "ERROR: Abort delay.\r\n";
\r
289 if( xAreCountingSemaphoreTasksStillRunning() == pdFALSE )
\r
291 pcStatusMessage = "ERROR: Counting semaphores.\r\n";
\r
294 if( xIsCreateTaskStillRunning() == pdFALSE )
\r
296 pcStatusMessage = "ERROR: Suicide tasks.\r\n";
\r
299 if( xAreMessageBufferTasksStillRunning() == pdFALSE )
\r
301 pcStatusMessage = "ERROR: Message buffer.\r\n";
\r
304 if( xAreStreamBufferTasksStillRunning() == pdFALSE )
\r
306 pcStatusMessage = "ERROR: Stream buffer.\r\n";
\r
309 if( xIsInterruptStreamBufferDemoStillRunning() == pdFALSE )
\r
311 pcStatusMessage = "ERROR: Stream buffer interrupt.\r\n";
\r
314 /* Check that the register test 1 task is still running. */
\r
315 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
317 pcStatusMessage = "ERROR: Register test 1.\r\n";
\r
319 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
321 /* Check that the register test 2 task is still running. */
\r
322 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
324 pcStatusMessage = "ERROR: Register test 2.\r\n";
\r
326 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
328 /* Write the status message to the UART. */
\r
330 vSendString( pcStatusMessage );
\r
332 /* If an error has been found then increase the LED toggle rate by
\r
333 increasing the cycle frequency. */
\r
334 if( pcStatusMessage != pcPassMessage )
\r
336 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
340 /*-----------------------------------------------------------*/
\r
342 static void prvRegTestTaskEntry1( void *pvParameters )
\r
344 /* Although the regtest task is written in assembler, its entry point is
\r
345 written in C for convenience of checking the task parameter is being passed
\r
347 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
349 /* Start the part of the test that is written in assembler. */
\r
350 vRegTest1Implementation();
\r
353 /* The following line will only execute if the task parameter is found to
\r
354 be incorrect. The check task will detect that the regtest loop counter is
\r
355 not being incremented and flag an error. */
\r
356 vTaskDelete( NULL );
\r
358 /*-----------------------------------------------------------*/
\r
360 static void prvRegTestTaskEntry2( void *pvParameters )
\r
362 /* Although the regtest task is written in assembler, its entry point is
\r
363 written in C for convenience of checking the task parameter is being passed
\r
365 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
367 /* Start the part of the test that is written in assembler. */
\r
368 vRegTest2Implementation();
\r
371 /* The following line will only execute if the task parameter is found to
\r
372 be incorrect. The check task will detect that the regtest loop counter is
\r
373 not being incremented and flag an error. */
\r
374 vTaskDelete( NULL );
\r
376 /*-----------------------------------------------------------*/
\r
378 void vFullDemoTickHook( void )
\r
380 /* The full demo includes a software timer demo/test that requires
\r
381 prodding periodically from the tick interrupt. */
\r
382 vTimerPeriodicISRTests();
\r
384 /* Call the periodic event group from ISR demo. */
\r
385 vPeriodicEventGroupsProcessing();
\r
387 /* Use task notifications from an interrupt. */
\r
388 xNotifyTaskFromISR();
\r
390 /* Writes to stream buffer byte by byte to test the stream buffer trigger
\r
391 level functionality. */
\r
392 vPeriodicStreamBufferProcessing();
\r
394 /* Writes a string to a string buffer four bytes at a time to demonstrate
\r
395 a stream being sent from an interrupt to a task. */
\r
396 vBasicStreamBufferSendFromISR();
\r
398 /* Called from vApplicationTickHook() when the project is configured to
\r
399 build the full test/demo applications. */
\r
401 /*-----------------------------------------------------------*/
\r
403 static void prvSetupPeripheralTimers( void )
\r
406 /*-----------------------------------------------------------*/
\r