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 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. The check task
\r
59 * toggles the LED every three seconds if all the standard demo tasks are
\r
60 * executing as expected, or every 500ms if a potential error is discovered in
\r
64 /* Standard includes. */
\r
68 /* Kernel includes. */
\r
69 #include "FreeRTOS.h"
\r
74 /* Standard demo application includes. */
\r
75 #include "dynamic.h"
\r
76 #include "blocktim.h"
\r
77 #include "TimerDemo.h"
\r
78 #include "TaskNotify.h"
\r
80 /* Priorities for the demo application tasks. */
\r
81 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
83 /* The period of the check task, in ms, converted to ticks using the
\r
84 pdMS_TO_TICKS() macro. mainNO_ERROR_CHECK_TASK_PERIOD is used if no errors have
\r
85 been found, mainERROR_CHECK_TASK_PERIOD is used if an error has been found. */
\r
86 #define mainNO_ERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 3000UL )
\r
87 #define mainERROR_CHECK_TASK_PERIOD pdMS_TO_TICKS( 500UL )
\r
89 /* Parameters that are passed into the register check tasks solely for the
\r
90 purpose of ensuring parameters are passed into tasks correctly. */
\r
91 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
92 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
94 /* The base period used by the timer test tasks. */
\r
95 #define mainTIMER_TEST_PERIOD ( 50 )
\r
97 /* The size of the stack allocated to the check task (as described in the
\r
98 comments at the top of this file. */
\r
99 #define mainCHECK_TASK_STACK_SIZE_WORDS 100
\r
101 /* Size of the stacks to allocated for the register check tasks. */
\r
102 #define mainREG_TEST_STACK_SIZE_WORDS 70
\r
104 /*-----------------------------------------------------------*/
\r
107 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
108 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
110 void main_full( void );
\r
113 * The check task, as described at the top of this file.
\r
115 static void prvCheckTask( void *pvParameters );
\r
118 * Register check tasks as described at the top of this file. The nature of
\r
119 * these files necessitates that they are written in an assembly file, but the
\r
120 * entry points are kept in the C file for the convenience of checking the task
\r
123 static void prvRegTestTaskEntry1( void *pvParameters );
\r
124 extern void vRegTest1Implementation( void );
\r
125 static void prvRegTestTaskEntry2( void *pvParameters );
\r
126 extern void vRegTest2Implementation( void );
\r
129 * Tick hook used by the full demo, which includes code that interacts with
\r
130 * some of the tests.
\r
132 void vFullDemoTickHook( void );
\r
134 /*-----------------------------------------------------------*/
\r
136 /* The following two variables are used to communicate the status of the
\r
137 register check tasks to the check task. If the variables keep incrementing,
\r
138 then the register check tasks have not discovered any errors. If a variable
\r
139 stops incrementing, then an error has been found. */
\r
140 uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
141 volatile uint32_t *pulRegTest1LoopCounter = &ulRegTest1LoopCounter;
\r
142 volatile uint32_t *pulRegTest2LoopCounter = &ulRegTest2LoopCounter;
\r
143 /*-----------------------------------------------------------*/
\r
145 void main_full( void )
\r
147 /* Start all the other standard demo/test tasks. They have no particular
\r
148 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
150 vCreateBlockTimeTasks();
\r
151 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
152 vStartDynamicPriorityTasks();
\r
153 vStartTaskNotifyTask();
\r
155 /* Create the register check tasks, as described at the top of this file.
\r
156 Use xTaskCreateStatic() to create a task using only statically allocated
\r
158 xTaskCreate( prvRegTestTaskEntry1, /* The function that implements the task. */
\r
159 "Reg1", /* The name of the task. */
\r
160 mainREG_TEST_STACK_SIZE_WORDS, /* Size of stack to allocate for the task - in words not bytes!. */
\r
161 mainREG_TEST_TASK_1_PARAMETER, /* Parameter passed into the task. */
\r
162 tskIDLE_PRIORITY, /* Priority of the task. */
\r
163 NULL ); /* Can be used to pass out a handle to the created task. */
\r
164 xTaskCreate( prvRegTestTaskEntry2, "Reg2", mainREG_TEST_STACK_SIZE_WORDS, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
166 /* Create the task that performs the 'check' functionality, as described at
\r
167 the top of this file. */
\r
168 xTaskCreate( prvCheckTask, "Check", mainCHECK_TASK_STACK_SIZE_WORDS, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
170 /* Start the scheduler. */
\r
171 vTaskStartScheduler();
\r
173 /* If all is well, the scheduler will now be running, and the following
\r
174 line will never be reached. If the following line does execute, then
\r
175 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
176 timer tasks to be created. See the memory management section on the
\r
177 FreeRTOS web site for more details on the FreeRTOS heap
\r
178 http://www.freertos.org/a00111.html. */
\r
181 /*-----------------------------------------------------------*/
\r
183 static void prvCheckTask( void *pvParameters )
\r
185 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
186 TickType_t xLastExecutionTime;
\r
187 uint32_t ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
188 char * const pcPassMessage = ".";
\r
189 char * pcStatusMessage = pcPassMessage;
\r
190 extern void vToggleLED( void );
\r
192 /* Just to stop compiler warnings. */
\r
193 ( void ) pvParameters;
\r
195 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
196 works correctly. */
\r
197 xLastExecutionTime = xTaskGetTickCount();
\r
199 /* Cycle for ever, delaying then checking all the other tasks are still
\r
200 operating without error. The onboard LED is toggled on each iteration.
\r
201 If an error is detected then the delay period is decreased from
\r
202 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
203 effect of increasing the rate at which the onboard LED toggles, and in so
\r
204 doing gives visual feedback of the system status. */
\r
207 /* Delay until it is time to execute again. */
\r
208 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
210 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
211 that they are all still running, and that none have detected an error. */
\r
212 if( xAreDynamicPriorityTasksStillRunning() == pdFALSE )
\r
214 pcStatusMessage = "ERROR: Dynamic priority demo/tests.\r\n";
\r
217 if( xAreBlockTimeTestTasksStillRunning() == pdFALSE )
\r
219 pcStatusMessage = "ERROR: Block time demo/tests.\r\n";
\r
222 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) == pdFALSE )
\r
224 pcStatusMessage = "ERROR: Timer demo/tests.\r\n";
\r
227 if( xAreTaskNotificationTasksStillRunning() == pdFALSE )
\r
229 pcStatusMessage = "ERROR: Task notification demo/tests.\r\n";
\r
232 /* Check that the register test 1 task is still running. */
\r
233 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
235 pcStatusMessage = "ERROR: Register test 1.\r\n";
\r
237 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
239 /* Check that the register test 2 task is still running. */
\r
240 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
242 pcStatusMessage = "ERROR: Register test 2.\r\n";
\r
244 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
246 /* Write the status message to the UART and toggle the LED to show the
\r
247 system status if the UART is not connected. */
\r
250 /* If an error has been found then increase the LED toggle rate by
\r
251 increasing the cycle frequency. */
\r
252 if( pcStatusMessage != pcPassMessage )
\r
254 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
258 /*-----------------------------------------------------------*/
\r
260 static void prvRegTestTaskEntry1( void *pvParameters )
\r
262 /* Although the regtest task is written in assembler, its entry point is
\r
263 written in C for convenience of checking the task parameter is being passed
\r
265 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
267 /* Start the part of the test that is written in assembler. */
\r
268 vRegTest1Implementation();
\r
271 /* The following line will only execute if the task parameter is found to
\r
272 be incorrect. The check task will detect that the regtest loop counter is
\r
273 not being incremented and flag an error. */
\r
274 vTaskDelete( NULL );
\r
276 /*-----------------------------------------------------------*/
\r
278 static void prvRegTestTaskEntry2( void *pvParameters )
\r
280 /* Although the regtest task is written in assembler, its entry point is
\r
281 written in C for convenience of checking the task parameter is being passed
\r
283 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
285 /* Start the part of the test that is written in assembler. */
\r
286 vRegTest2Implementation();
\r
289 /* The following line will only execute if the task parameter is found to
\r
290 be incorrect. The check task will detect that the regtest loop counter is
\r
291 not being incremented and flag an error. */
\r
292 vTaskDelete( NULL );
\r
294 /*-----------------------------------------------------------*/
\r
296 void vFullDemoTickHook( void )
\r
298 /* Called from vApplicationTickHook() when the project is configured to
\r
299 build the full test/demo applications. */
\r
301 /* Use task notifications from an interrupt. */
\r
302 xNotifyTaskFromISR();
\r
304 /*-----------------------------------------------------------*/
\r