2 FreeRTOS V8.2.1 - Copyright (C) 2015 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 This file is part of the FreeRTOS distribution.
\r
9 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
10 the terms of the GNU General Public License (version 2) as published by the
\r
11 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
13 ***************************************************************************
\r
14 >>! NOTE: The modification to the GPL is included to allow you to !<<
\r
15 >>! distribute a combined work that includes FreeRTOS without being !<<
\r
16 >>! obliged to provide the source code for proprietary components !<<
\r
17 >>! outside of the FreeRTOS kernel. !<<
\r
18 ***************************************************************************
\r
20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
22 FOR A PARTICULAR PURPOSE. Full license text is available on the following
\r
23 link: http://www.freertos.org/a00114.html
\r
25 ***************************************************************************
\r
27 * FreeRTOS provides completely free yet professionally developed, *
\r
28 * robust, strictly quality controlled, supported, and cross *
\r
29 * platform software that is more than just the market leader, it *
\r
30 * is the industry's de facto standard. *
\r
32 * Help yourself get started quickly while simultaneously helping *
\r
33 * to support the FreeRTOS project by purchasing a FreeRTOS *
\r
34 * tutorial book, reference manual, or both: *
\r
35 * http://www.FreeRTOS.org/Documentation *
\r
37 ***************************************************************************
\r
39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading
\r
40 the FAQ page "My application does not run, what could be wrong?". Have you
\r
41 defined configASSERT()?
\r
43 http://www.FreeRTOS.org/support - In return for receiving this top quality
\r
44 embedded software for free we request you assist our global community by
\r
45 participating in the support forum.
\r
47 http://www.FreeRTOS.org/training - Investing in training allows your team to
\r
48 be as productive as possible as early as possible. Now you can receive
\r
49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers
\r
50 Ltd, and the world's leading authority on the world's leading RTOS.
\r
52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
54 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.
\r
57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.
\r
59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High
\r
60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
61 licenses offer ticketed support, indemnification and commercial middleware.
\r
63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
64 engineered and independently SIL3 certified version for use in safety and
\r
65 mission critical applications that require provable dependability.
\r
70 /******************************************************************************
\r
71 * NOTE 1: This project provides two demo applications. A simple blinky style
\r
72 * project, and a more comprehensive test and demo application. The
\r
73 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
\r
74 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
\r
75 * in main.c. This file implements the comprehensive test and demo version.
\r
77 * NOTE 2: This file only contains the source code that is specific to the
\r
78 * full demo. Generic functions, such FreeRTOS hook functions, and functions
\r
79 * required to configure the hardware, are defined in main.c.
\r
81 ******************************************************************************
\r
83 * main_full() creates all the demo application tasks and software timers, then
\r
84 * starts the scheduler. The web documentation provides more details of the
\r
85 * standard demo application tasks, which provide no particular functionality,
\r
86 * but do provide a good example of how to use the FreeRTOS API.
\r
88 * "Reg test" tasks - These fill both the core and floating point registers with
\r
89 * known values, then check that each register maintains its expected value for
\r
90 * the lifetime of the task. Each task uses a different set of values. The reg
\r
91 * test tasks execute with a very low priority, so get preempted very
\r
92 * frequently. A register containing an unexpected value is indicative of an
\r
93 * error in the context switching mechanism.
\r
95 * "Check" task - The check task period is initially set to three seconds. The
\r
96 * task checks that all the standard demo tasks, and the register check tasks,
\r
97 * are not only still executing, but are executing without reporting any errors.
\r
98 * If the check task discovers that a task has either stalled, or reported an
\r
99 * error, then it changes its own execution period from the initial three
\r
100 * seconds, to just 200ms. The check task also toggles an LED each time it is
\r
101 * called. This provides a visual indication of the system status: If the LED
\r
102 * toggles every three seconds, then no issues have been discovered. If the LED
\r
103 * toggles every 200ms, then an issue has been discovered with at least one
\r
107 /* Standard includes. */
\r
110 /* Kernel includes. */
\r
111 #include "FreeRTOS.h"
\r
113 #include "timers.h"
\r
114 #include "semphr.h"
\r
116 /* Standard demo application includes. */
\r
118 #include "semtest.h"
\r
119 #include "dynamic.h"
\r
120 #include "BlockQ.h"
\r
121 #include "blocktim.h"
\r
122 #include "countsem.h"
\r
123 #include "GenQTest.h"
\r
124 #include "recmutex.h"
\r
126 #include "partest.h"
\r
127 #include "comtest2.h"
\r
128 #include "serial.h"
\r
129 #include "TimerDemo.h"
\r
130 #include "QueueOverwrite.h"
\r
131 #include "IntQueue.h"
\r
132 #include "EventGroupsDemo.h"
\r
133 #include "IntSemTest.h"
\r
134 #include "QueueSet.h"
\r
135 #include "TaskNotify.h"
\r
137 /* Priorities for the demo application tasks. */
\r
138 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1UL )
\r
139 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2UL )
\r
140 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3UL )
\r
141 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
142 #define mainCDC_COMMAND_CONSOLE_STACK_SIZE ( configMINIMAL_STACK_SIZE * 2UL )
\r
143 #define mainCOM_TEST_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
144 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
145 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
147 /* The initial priority used by the UART command console task. */
\r
148 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY ( configMAX_PRIORITIES - 2 )
\r
150 /* A block time of zero simply means "don't block". */
\r
151 #define mainDONT_BLOCK ( 0UL )
\r
153 /* The period after which the check timer will expire, in ms, provided no errors
\r
154 have been reported by any of the standard demo tasks. ms are converted to the
\r
155 equivalent in ticks using the portTICK_PERIOD_MS constant. */
\r
156 #define mainNO_ERROR_CHECK_TASK_PERIOD ( 3000UL / portTICK_PERIOD_MS )
\r
158 /* The period at which the check timer will expire, in ms, if an error has been
\r
159 reported in one of the standard demo tasks. ms are converted to the equivalent
\r
160 in ticks using the portTICK_PERIOD_MS constant. */
\r
161 #define mainERROR_CHECK_TASK_PERIOD ( 200UL / portTICK_PERIOD_MS )
\r
163 /* Parameters that are passed into the register check tasks solely for the
\r
164 purpose of ensuring parameters are passed into tasks correctly. */
\r
165 #define mainREG_TEST_TASK_1_PARAMETER ( ( void * ) 0x12345678 )
\r
166 #define mainREG_TEST_TASK_2_PARAMETER ( ( void * ) 0x87654321 )
\r
168 /* The base period used by the timer test tasks. */
\r
169 #define mainTIMER_TEST_PERIOD ( 50 )
\r
171 /* The LED is used to show the demo status. */
\r
172 #define mainTOGGLE_LED() HAL_GPIO_TogglePin( GPIOF, GPIO_PIN_10 )
\r
174 /*-----------------------------------------------------------*/
\r
177 * Called by main() to run the full demo (as opposed to the blinky demo) when
\r
178 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY is set to 0.
\r
180 void main_full( void );
\r
183 * The check task, as described at the top of this file.
\r
185 static void prvCheckTask( void *pvParameters );
\r
188 * Register check tasks, and the tasks used to write over and check the contents
\r
189 * of the FPU registers, as described at the top of this file. The nature of
\r
190 * these files necessitates that they are written in an assembly file, but the
\r
191 * entry points are kept in the C file for the convenience of checking the task
\r
194 static void prvRegTestTaskEntry1( void *pvParameters );
\r
195 extern void vRegTest1Implementation( void );
\r
196 static void prvRegTestTaskEntry2( void *pvParameters );
\r
197 extern void vRegTest2Implementation( void );
\r
200 * Register commands that can be used with FreeRTOS+CLI. The commands are
\r
201 * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.
\r
203 extern void vRegisterSampleCLICommands( void );
\r
206 * The task that manages the FreeRTOS+CLI input and output.
\r
208 extern void vUSBCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );
\r
210 /*-----------------------------------------------------------*/
\r
212 /* The following two variables are used to communicate the status of the
\r
213 register check tasks to the check task. If the variables keep incrementing,
\r
214 then the register check tasks has not discovered any errors. If a variable
\r
215 stops incrementing, then an error has been found. */
\r
216 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;
\r
218 /*-----------------------------------------------------------*/
\r
220 void main_full( void )
\r
222 /* Start all the other standard demo/test tasks. They have not particular
\r
223 functionality, but do demonstrate how to use the FreeRTOS API and test the
\r
225 vStartInterruptQueueTasks();
\r
226 vStartDynamicPriorityTasks();
\r
227 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
228 vCreateBlockTimeTasks();
\r
229 vStartCountingSemaphoreTasks();
\r
230 vStartGenericQueueTasks( tskIDLE_PRIORITY );
\r
231 vStartRecursiveMutexTasks();
\r
232 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
233 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
234 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
235 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
236 vStartEventGroupTasks();
\r
237 vStartInterruptSemaphoreTasks();
\r
238 vStartQueueSetTasks();
\r
239 vStartTaskNotifyTask();
\r
241 /* Create the register check tasks, as described at the top of this file */
\r
242 xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
243 xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );
\r
245 /* Create the task that performs the 'check' functionality, as described at
\r
246 the top of this file. */
\r
247 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
249 /* The set of tasks created by the following function call have to be
\r
250 created last as they keep account of the number of tasks they expect to see
\r
252 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
254 /* Start the scheduler. */
\r
255 vTaskStartScheduler();
\r
257 /* If all is well, the scheduler will now be running, and the following
\r
258 line will never be reached. If the following line does execute, then
\r
259 there was either insufficient FreeRTOS heap memory available for the idle
\r
260 and/or timer tasks to be created, or vTaskStartScheduler() was called from
\r
261 User mode. See the memory management section on the FreeRTOS web site for
\r
262 more details on the FreeRTOS heap http://www.freertos.org/a00111.html. The
\r
263 mode from which main() is called is set in the C start up code and must be
\r
264 a privileged mode (not user mode). */
\r
267 /*-----------------------------------------------------------*/
\r
269 static void prvCheckTask( void *pvParameters )
\r
271 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;
\r
272 TickType_t xLastExecutionTime;
\r
273 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;
\r
274 unsigned long ulErrorFound = pdFALSE;
\r
276 /* Just to stop compiler warnings. */
\r
277 ( void ) pvParameters;
\r
279 /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()
\r
280 works correctly. */
\r
281 xLastExecutionTime = xTaskGetTickCount();
\r
283 /* Cycle for ever, delaying then checking all the other tasks are still
\r
284 operating without error. The onboard LED is toggled on each iteration.
\r
285 If an error is detected then the delay period is decreased from
\r
286 mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD. This has the
\r
287 effect of increasing the rate at which the onboard LED toggles, and in so
\r
288 doing gives visual feedback of the system status. */
\r
291 /* Delay until it is time to execute again. */
\r
292 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );
\r
294 /* Check all the demo tasks (other than the flash tasks) to ensure
\r
295 that they are all still running, and that none have detected an error. */
\r
296 if( xAreIntQueueTasksStillRunning() != pdTRUE )
\r
298 ulErrorFound = 1UL << 0UL;
\r
301 if( xAreMathsTaskStillRunning() != pdTRUE )
\r
303 ulErrorFound = 1UL << 1UL;
\r
306 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )
\r
308 ulErrorFound = 1UL << 2UL;
\r
311 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
313 ulErrorFound = 1UL << 3UL;
\r
316 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
318 ulErrorFound = 1UL << 4UL;
\r
321 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
323 ulErrorFound = 1UL << 5UL;
\r
326 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
328 ulErrorFound = 1UL << 6UL;
\r
331 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
333 ulErrorFound = 1UL << 7UL;
\r
336 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
338 ulErrorFound = 1UL << 8UL;
\r
341 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) xDelayPeriod ) != pdPASS )
\r
343 ulErrorFound = 1UL << 9UL;
\r
346 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
348 ulErrorFound = 1UL << 10UL;
\r
351 if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
353 ulErrorFound = 1UL << 11UL;
\r
356 if( xAreEventGroupTasksStillRunning() != pdPASS )
\r
358 ulErrorFound = 1UL << 12UL;
\r
361 if( xAreInterruptSemaphoreTasksStillRunning() != pdPASS )
\r
363 ulErrorFound = 1UL << 13UL;
\r
366 if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
368 ulErrorFound = 1UL << 14UL;
\r
371 if( xAreTaskNotificationTasksStillRunning() != pdPASS )
\r
373 ulErrorFound = 1UL << 15UL;
\r
376 /* Check that the register test 1 task is still running. */
\r
377 if( ulLastRegTest1Value == ulRegTest1LoopCounter )
\r
379 ulErrorFound = 1UL << 16UL;
\r
381 ulLastRegTest1Value = ulRegTest1LoopCounter;
\r
383 /* Check that the register test 2 task is still running. */
\r
384 if( ulLastRegTest2Value == ulRegTest2LoopCounter )
\r
386 ulErrorFound = 1UL << 17UL;
\r
388 ulLastRegTest2Value = ulRegTest2LoopCounter;
\r
390 /* Toggle the check LED to give an indication of the system status. If
\r
391 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then
\r
392 everything is ok. A faster toggle indicates an error. */
\r
395 if( ulErrorFound != pdFALSE )
\r
397 /* An error has been detected in one of the tasks - flash the LED
\r
398 at a higher frequency to give visible feedback that something has
\r
399 gone wrong (it might just be that the loop back connector required
\r
400 by the comtest tasks has not been fitted). */
\r
401 xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;
\r
405 /*-----------------------------------------------------------*/
\r
407 static void prvRegTestTaskEntry1( void *pvParameters )
\r
409 /* Although the regtest task is written in assembler, its entry point is
\r
410 written in C for convenience of checking the task parameter is being passed
\r
412 if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )
\r
414 /* Start the part of the test that is written in assembler. */
\r
415 vRegTest1Implementation();
\r
418 /* The following line will only execute if the task parameter is found to
\r
419 be incorrect. The check timer will detect that the regtest loop counter is
\r
420 not being incremented and flag an error. */
\r
421 vTaskDelete( NULL );
\r
423 /*-----------------------------------------------------------*/
\r
425 static void prvRegTestTaskEntry2( void *pvParameters )
\r
427 /* Although the regtest task is written in assembler, its entry point is
\r
428 written in C for convenience of checking the task parameter is being passed
\r
430 if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )
\r
432 /* Start the part of the test that is written in assembler. */
\r
433 vRegTest2Implementation();
\r
436 /* The following line will only execute if the task parameter is found to
\r
437 be incorrect. The check timer will detect that the regtest loop counter is
\r
438 not being incremented and flag an error. */
\r
439 vTaskDelete( NULL );
\r
441 /*-----------------------------------------------------------*/
\r