2 * FreeRTOS Kernel V10.1.1
\r
3 * Copyright (C) 2018 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. */
\r
108 #define mainCHECK_TASK_STACK_SIZE_WORDS 200
\r
110 /* Size of the stacks to allocated for the register check tasks. */
\r
111 #define mainREG_TEST_STACK_SIZE_WORDS 150
\r
113 /*-----------------------------------------------------------*/
\r
116 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
117 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
119 void main_full( void );
\r
122 * The check task, as described at the top of this file.
\r
124 static void prvCheckTask( void *pvParameters );
\r
127 * Initialise and start the peripheral timers that are used to exercise external
\r
128 * interrupt processing.
\r
130 static void prvSetupPeripheralTimers( void );
\r
133 * Register check tasks as described at the top of this file. The nature of
\r
134 * these files necessitates that they are written in an assembly file, but the
\r
135 * entry points are kept in the C file for the convenience of checking the task
\r
138 static void prvRegTestTaskEntry1( void *pvParameters );
\r
139 extern void vRegTest1Implementation( void );
\r
140 static void prvRegTestTaskEntry2( void *pvParameters );
\r
141 extern void vRegTest2Implementation( void );
\r
144 * Tick hook used by the full demo, which includes code that interacts with
\r
145 * some of the tests.
\r
147 void vFullDemoTickHook( void );
\r
149 /*-----------------------------------------------------------*/
\r
151 /* Timers used to exercise external interrupt processing. */
\r
152 //static timer_instance_t g_timer0, g_timer1;
\r
154 /* Variables incremented by the peripheral timers used to exercise external
\r
156 volatile uint32_t ulTimer0Interrupts = 0, ulTimer1Interrupts = 0;
\r
158 /* The following two variables are used to communicate the status of the
\r
159 register check tasks to the check task. If the variables keep incrementing,
\r
160 then the register check tasks have not discovered any errors. If a variable
\r
161 stops incrementing, then an error has been found. */
\r
162 volatile uint32_t ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
164 /*-----------------------------------------------------------*/
\r
166 void main_full( void )
\r
168 /* Start all the other standard demo/test tasks. They have no particular
\r
169 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
171 vStartDynamicPriorityTasks();
\r
172 vCreateBlockTimeTasks();
\r
173 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
174 vStartRecursiveMutexTasks();
\r
175 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
176 vStartEventGroupTasks();
\r
177 vStartTaskNotifyTask();
\r
178 vCreateAbortDelayTasks();
\r
179 vStartCountingSemaphoreTasks();
\r
180 vStartMessageBufferTasks( configMINIMAL_STACK_SIZE );
\r
181 vStartStreamBufferTasks();
\r
182 vStartStreamBufferInterruptDemo();
\r
184 /* Create the register check tasks, as described at the top of this file.
\r
185 Use xTaskCreateStatic() to create a task using only statically allocated
\r
187 xTaskCreate( prvRegTestTaskEntry1, /* The function that implements the task. */
\r
188 "Reg1", /* The name of the task. */
\r
189 mainREG_TEST_STACK_SIZE_WORDS, /* Size of stack to allocate for the task - in words not bytes!. */
\r
190 mainREG_TEST_TASK_1_PARAMETER, /* Parameter passed into the task. */
\r
191 tskIDLE_PRIORITY, /* Priority of the task. */
\r
192 NULL ); /* Can be used to pass out a handle to the created task. */
\r
193 xTaskCreate( prvRegTestTaskEntry2, "Reg2", mainREG_TEST_STACK_SIZE_WORDS, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
195 /* Create the task that performs the 'check' functionality, as described at
\r
196 the top of this file. */
\r
197 xTaskCreate( prvCheckTask, "Check", mainCHECK_TASK_STACK_SIZE_WORDS, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
199 /* The set of tasks created by the following function call have to be
\r
200 created last as they keep account of the number of tasks they expect to see
\r
202 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
204 /* Start the timers that are used to exercise external interrupt handling. */
\r
205 prvSetupPeripheralTimers();
\r
207 /* Start the scheduler. */
\r
208 vTaskStartScheduler();
\r
210 /* If all is well, the scheduler will now be running, and the following
\r
211 line will never be reached. If the following line does execute, then
\r
212 there was insufficient FreeRTOS heap memory available for the Idle and/or
\r
213 timer tasks to be created. See the memory management section on the
\r
214 FreeRTOS web site for more details on the FreeRTOS heap
\r
215 http://www.freertos.org/a00111.html. */
\r
218 /*-----------------------------------------------------------*/
\r
220 static void prvCheckTask( void *pvParameters )
\r
222 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
223 TickType_t xLastExecutionTime;
\r
224 uint32_t ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
225 uint32_t ulLastTimer0Interrupts = 0, ulLastTimer1Interrupts = 0;
\r
226 char * const pcPassMessage = ".";
\r
227 char * pcStatusMessage = pcPassMessage;
\r
228 extern void vSendString( const char * const pcString );
\r
229 extern void vToggleLED( void );
\r
231 /* Just to stop compiler warnings. */
\r
232 ( void ) pvParameters;
\r
234 /* Output "pass", then an additional '.' character for each successful
\r
236 vSendString( "Pass" );
\r
238 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
239 works correctly. */
\r
240 xLastExecutionTime = xTaskGetTickCount();
\r
242 /* Cycle for ever, delaying then checking all the other tasks are still
\r
243 operating without error. The onboard LED is toggled on each iteration.
\r
244 If an error is detected then the delay period is decreased from
\r
245 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
246 effect of increasing the rate at which the onboard LED toggles, and in so
\r
247 doing gives visual feedback of the system status. */
\r
250 /* Delay until it is time to execute again. */
\r
251 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
253 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
254 that they are all still running, and that none have detected an error. */
\r
255 if( xAreDynamicPriorityTasksStillRunning() == pdFALSE )
\r
257 pcStatusMessage = "ERROR: Dynamic priority demo/tests.\r\n";
\r
260 if ( xAreBlockTimeTestTasksStillRunning() == pdFALSE )
\r
262 pcStatusMessage = "ERROR: Block time demo/tests.\r\n";
\r
265 if ( xAreGenericQueueTasksStillRunning() == pdFALSE )
\r
267 pcStatusMessage = "ERROR: Generic queue demo/tests.\r\n";
\r
270 if ( xAreRecursiveMutexTasksStillRunning() == pdFALSE )
\r
272 pcStatusMessage = "ERROR: Recursive mutex demo/tests.\r\n";
\r
275 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) == pdFALSE )
\r
277 pcStatusMessage = "ERROR: Timer demo/tests.\r\n";
\r
280 if( xAreEventGroupTasksStillRunning() == pdFALSE )
\r
282 pcStatusMessage = "ERROR: Event group demo/tests.\r\n";
\r
285 if( xAreTaskNotificationTasksStillRunning() == pdFALSE )
\r
287 pcStatusMessage = "ERROR: Task notification demo/tests.\r\n";
\r
290 if( xAreAbortDelayTestTasksStillRunning() == pdFALSE )
\r
292 pcStatusMessage = "ERROR: Abort delay.\r\n";
\r
295 if( xAreCountingSemaphoreTasksStillRunning() == pdFALSE )
\r
297 pcStatusMessage = "ERROR: Counting semaphores.\r\n";
\r
300 if( xIsCreateTaskStillRunning() == pdFALSE )
\r
302 pcStatusMessage = "ERROR: Suicide tasks.\r\n";
\r
305 if( xAreMessageBufferTasksStillRunning() == pdFALSE )
\r
307 pcStatusMessage = "ERROR: Message buffer.\r\n";
\r
310 if( xAreStreamBufferTasksStillRunning() == pdFALSE )
\r
312 pcStatusMessage = "ERROR: Stream buffer.\r\n";
\r
315 if( xIsInterruptStreamBufferDemoStillRunning() == pdFALSE )
\r
317 pcStatusMessage = "ERROR: Stream buffer interrupt.\r\n";
\r
320 /* Check that the register test 1 task is still running. */
\r
321 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
323 pcStatusMessage = "ERROR: Register test 1.\r\n";
\r
325 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
327 /* Check that the register test 2 task is still running. */
\r
328 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
330 pcStatusMessage = "ERROR: Register test 2.\r\n";
\r
332 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
334 /* Check interrupts from the peripheral timers are being handled. */
\r
335 if( ulLastTimer0Interrupts == ulTimer0Interrupts )
\r
337 // pcStatusMessage = "ERROR: Peripheral timer 0.\r\n";
\r
339 ulLastTimer0Interrupts = ulTimer0Interrupts;
\r
341 if( ulLastTimer1Interrupts == ulTimer1Interrupts )
\r
343 // pcStatusMessage = "ERROR: Peripheral timer 1.\r\n";
\r
345 ulLastTimer1Interrupts = ulTimer1Interrupts;
\r
347 /* Write the status message to the UART. */
\r
349 vSendString( pcStatusMessage );
\r
351 /* If an error has been found then increase the LED toggle rate by
\r
352 increasing the cycle frequency. */
\r
353 if( pcStatusMessage != pcPassMessage )
\r
355 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
359 /*-----------------------------------------------------------*/
\r
361 static void prvRegTestTaskEntry1( void *pvParameters )
\r
363 /* Although the regtest task is written in assembler, its entry point is
\r
364 written in C for convenience of checking the task parameter is being passed
\r
366 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
368 /* Start the part of the test that is written in assembler. */
\r
369 vRegTest1Implementation();
\r
372 /* The following line will only execute if the task parameter is found to
\r
373 be incorrect. The check task will detect that the regtest loop counter is
\r
374 not being incremented and flag an error. */
\r
375 vTaskDelete( NULL );
\r
377 /*-----------------------------------------------------------*/
\r
379 static void prvRegTestTaskEntry2( void *pvParameters )
\r
381 /* Although the regtest task is written in assembler, its entry point is
\r
382 written in C for convenience of checking the task parameter is being passed
\r
384 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
386 /* Start the part of the test that is written in assembler. */
\r
387 vRegTest2Implementation();
\r
390 /* The following line will only execute if the task parameter is found to
\r
391 be incorrect. The check task will detect that the regtest loop counter is
\r
392 not being incremented and flag an error. */
\r
393 vTaskDelete( NULL );
\r
395 /*-----------------------------------------------------------*/
\r
397 void vFullDemoTickHook( void )
\r
399 /* The full demo includes a software timer demo/test that requires
\r
400 prodding periodically from the tick interrupt. */
\r
401 vTimerPeriodicISRTests();
\r
403 /* Call the periodic event group from ISR demo. */
\r
404 vPeriodicEventGroupsProcessing();
\r
406 /* Use task notifications from an interrupt. */
\r
407 xNotifyTaskFromISR();
\r
409 /* Writes to stream buffer byte by byte to test the stream buffer trigger
\r
410 level functionality. */
\r
411 vPeriodicStreamBufferProcessing();
\r
413 /* Writes a string to a string buffer four bytes at a time to demonstrate
\r
414 a stream being sent from an interrupt to a task. */
\r
415 vBasicStreamBufferSendFromISR();
\r
417 /* Called from vApplicationTickHook() when the project is configured to
\r
418 build the full test/demo applications. */
\r
420 /*-----------------------------------------------------------*/
\r
422 static void prvSetupPeripheralTimers( void )
\r
425 /*-----------------------------------------------------------*/
\r
427 /*Core Timer 0 Interrupt Handler*/
\r
428 uint8_t External_30_IRQHandler( void )
\r
430 ulTimer0Interrupts++;
\r
433 /*-----------------------------------------------------------*/
\r
435 /*Core Timer 1 Interrupt Handler*/
\r
436 uint8_t External_31_IRQHandler( void )
\r
438 ulTimer1Interrupts++;
\r