]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Kintex7_EthernetLite/RTOSDemo/src/Full_Demo/main_full.c
Update version number to 9.0.0rc2.
[freertos] / FreeRTOS / Demo / MicroBlaze_Kintex7_EthernetLite / RTOSDemo / src / Full_Demo / main_full.c
1 /*\r
2     FreeRTOS V9.0.0rc2 - Copyright (C) 2016 Real Time Engineers Ltd.\r
3     All rights reserved\r
4 \r
5     VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     This file is part of the FreeRTOS distribution.\r
8 \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
12 \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
19 \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
24 \r
25     ***************************************************************************\r
26      *                                                                       *\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
31      *                                                                       *\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
36      *                                                                       *\r
37     ***************************************************************************\r
38 \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
42 \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
46 \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
51 \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
55 \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
58 \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
62 \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
66 \r
67     1 tab == 4 spaces!\r
68 */\r
69 \r
70 \r
71 /******************************************************************************\r
72  * NOTE 1:  This project provides three demo applications.  A simple blinky\r
73  * style project, a more comprehensive test and demo application, and an\r
74  * lwIP example.  The mainSELECTED_APPLICATION setting in main.c is used to\r
75  * select between the three.  See the notes on using mainSELECTED_APPLICATION\r
76  * in main.c.  This file implements the comprehensive version.\r
77  *\r
78  * NOTE 2:  This file only contains the source code that is specific to the\r
79  * full demo.  Generic functions, such FreeRTOS hook functions, and functions\r
80  * required to configure the hardware, are defined in main.c.\r
81  *\r
82  ******************************************************************************\r
83  *\r
84  * main_full() creates all the demo application tasks and software timers, then\r
85  * starts the scheduler.  The web documentation provides more details of the\r
86  * standard demo application tasks, which provide no particular functionality,\r
87  * but do provide a good example of how to use the FreeRTOS API.\r
88  *\r
89  * In addition to the standard demo tasks, the following tasks and tests are\r
90  * defined and/or created within this file:\r
91  *\r
92  * FreeRTOS+CLI command console.  The command console is access through the\r
93  * UART to USB connector on the ZC702 Zynq development board (marked J2).  For\r
94  * reasons of robustness testing the UART driver is deliberately written to be\r
95  * inefficient and should not be used as a template for a production driver.\r
96  * Type "help" to see a list of registered commands.  The FreeRTOS+CLI license\r
97  * is different to the FreeRTOS license, see http://www.FreeRTOS.org/cli for\r
98  * license and usage details.  The default baud rate is 115200.\r
99  *\r
100  * "Reg test" tasks - These fill both the core and floating point registers with\r
101  * known values, then check that each register maintains its expected value for\r
102  * the lifetime of the task.  Each task uses a different set of values.  The reg\r
103  * test tasks execute with a very low priority, so get preempted very\r
104  * frequently.  A register containing an unexpected value is indicative of an\r
105  * error in the context switching mechanism.\r
106  *\r
107  * "Check" task - The check task period is initially set to three seconds.  The\r
108  * task checks that all the standard demo tasks, and the register check tasks,\r
109  * are not only still executing, but are executing without reporting any errors.\r
110  * If the check task discovers that a task has either stalled, or reported an\r
111  * error, then it changes its own execution period from the initial three\r
112  * seconds, to just 200ms.  The check task also toggles an LED each time it is\r
113  * called.  This provides a visual indication of the system status:  If the LED\r
114  * toggles every three seconds, then no issues have been discovered.  If the LED\r
115  * toggles every 200ms, then an issue has been discovered with at least one\r
116  * task.\r
117  */\r
118 \r
119 /* Standard includes. */\r
120 #include <stdio.h>\r
121 \r
122 /* Kernel includes. */\r
123 #include "FreeRTOS.h"\r
124 #include "task.h"\r
125 #include "timers.h"\r
126 #include "semphr.h"\r
127 \r
128 /* Standard demo application includes. */\r
129 #include "flash_timer.h"\r
130 #include "flop.h"\r
131 #include "semtest.h"\r
132 #include "dynamic.h"\r
133 #include "blocktim.h"\r
134 #include "countsem.h"\r
135 #include "GenQTest.h"\r
136 #include "recmutex.h"\r
137 #include "partest.h"\r
138 #include "serial.h"\r
139 #include "TimerDemo.h"\r
140 #include "EventGroupsDemo.h"\r
141 #include "TaskNotify.h"\r
142 #include "IntSemTest.h"\r
143 \r
144 /* Priorities for the demo application tasks. */\r
145 #define mainSEM_TEST_PRIORITY                           ( tskIDLE_PRIORITY + 1UL )\r
146 #define mainBLOCK_Q_PRIORITY                            ( tskIDLE_PRIORITY + 2UL )\r
147 #define mainCREATOR_TASK_PRIORITY                       ( tskIDLE_PRIORITY + 3UL )\r
148 #define mainFLOP_TASK_PRIORITY                          ( tskIDLE_PRIORITY )\r
149 #define mainUART_COMMAND_CONSOLE_STACK_SIZE     ( configMINIMAL_STACK_SIZE * 2UL )\r
150 #define mainCOM_TEST_TASK_PRIORITY                      ( tskIDLE_PRIORITY + 2 )\r
151 #define mainCHECK_TASK_PRIORITY                         ( configMAX_PRIORITIES - 1 )\r
152 #define mainQUEUE_OVERWRITE_PRIORITY            ( tskIDLE_PRIORITY )\r
153 #define mainFLASH_PRIORITY                                      ( tskIDLE_PRIORITY )\r
154 \r
155 /* The priority used by the UART command console task. */\r
156 #define mainUART_COMMAND_CONSOLE_TASK_PRIORITY  ( configMAX_PRIORITIES - 2 )\r
157 \r
158 /* The LED used by the check timer. */\r
159 #define mainCHECK_LED                                           ( 7 )\r
160 \r
161 \r
162 /* A block time of zero simply means "don't block". */\r
163 #define mainDONT_BLOCK                                          ( 0UL )\r
164 \r
165 /* The period after which the check timer will expire, in ms, provided no errors\r
166 have been reported by any of the standard demo tasks.  ms are converted to the\r
167 equivalent in ticks using the portTICK_PERIOD_MS constant. */\r
168 #define mainNO_ERROR_CHECK_TASK_PERIOD          ( pdMS_TO_TICKS( 3000UL ) )\r
169 \r
170 /* The period at which the check timer will expire, in ms, if an error has been\r
171 reported in one of the standard demo tasks.  ms are converted to the equivalent\r
172 in ticks using the portTICK_PERIOD_MS constant. */\r
173 #define mainERROR_CHECK_TASK_PERIOD             ( pdMS_TO_TICKS( 200UL ) )\r
174 \r
175 /* Parameters that are passed into the register check tasks solely for the\r
176 purpose of ensuring parameters are passed into tasks correctly. */\r
177 #define mainREG_TEST_TASK_1_PARAMETER           ( ( void * ) 0x12345678 )\r
178 #define mainREG_TEST_TASK_2_PARAMETER           ( ( void * ) 0x87654321 )\r
179 \r
180 /* The base period used by the timer test tasks. */\r
181 #define mainTIMER_TEST_PERIOD                           ( 50 )\r
182 \r
183 /* The number of timers to create that just flash LEDs. */\r
184 #define mainNUM_FLASH_TIMERS                            ( 3 )\r
185 /*-----------------------------------------------------------*/\r
186 \r
187 \r
188 /*\r
189  * The check task, as described at the top of this file.\r
190  */\r
191 static void prvCheckTask( void *pvParameters );\r
192 \r
193 /*\r
194  * Register check tasks, and the tasks used to write over and check the contents\r
195  * of the FPU registers, as described at the top of this file.  The nature of\r
196  * these files necessitates that they are written in an assembly file, but the\r
197  * entry points are kept in the C file for the convenience of checking the task\r
198  * parameter.\r
199  */\r
200 static void prvRegTestTaskEntry1( void *pvParameters );\r
201 extern void vRegTest1Implementation( void );\r
202 static void prvRegTestTaskEntry2( void *pvParameters );\r
203 extern void vRegTest2Implementation( void );\r
204 \r
205 /*\r
206  * Register commands that can be used with FreeRTOS+CLI.  The commands are\r
207  * defined in CLI-Commands.c and File-Related-CLI-Command.c respectively.\r
208  */\r
209 extern void vRegisterSampleCLICommands( void );\r
210 \r
211 /*\r
212  * The task that manages the FreeRTOS+CLI input and output.\r
213  */\r
214 extern void vUARTCommandConsoleStart( uint16_t usStackSize, UBaseType_t uxPriority );\r
215 \r
216 /*\r
217  * When the full demo is build the tick hook it used to demonstrate API\r
218  * functions being called from an interrupt and to perform some tests.\r
219  */\r
220 void vFullDemoTickHook( void );\r
221 \r
222 /*\r
223  * When the full demo is build the idle hook is used to create some timers that\r
224  * cannot be created in main() because the timer demo tasks need the entire\r
225  * command queue.\r
226  */\r
227 void vFullDemoIdleHook( void );\r
228 \r
229 /*-----------------------------------------------------------*/\r
230 \r
231 /* The following two variables are used to communicate the status of the\r
232 register check tasks to the check task.  If the variables keep incrementing,\r
233 then the register check tasks have not discovered any errors.  If a variable\r
234 stops incrementing, then an error has been found. */\r
235 volatile unsigned long ulRegTest1LoopCounter = 0UL, ulRegTest2LoopCounter = 0UL;\r
236 \r
237 /*-----------------------------------------------------------*/\r
238 \r
239 void main_full( void )\r
240 {\r
241         /* Start all the other standard demo/test tasks.  They have no particular\r
242         functionality, but do demonstrate how to use the FreeRTOS API and test the\r
243         kernel port. */\r
244         vStartDynamicPriorityTasks();\r
245         vCreateBlockTimeTasks();\r
246         vStartCountingSemaphoreTasks();\r
247         vStartGenericQueueTasks( tskIDLE_PRIORITY );\r
248         vStartRecursiveMutexTasks();\r
249         vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );\r
250         vStartTimerDemoTask( mainTIMER_TEST_PERIOD );\r
251         vStartEventGroupTasks();\r
252         vStartTaskNotifyTask();\r
253         vStartInterruptSemaphoreTasks();\r
254 \r
255         /* Note - the set of standard demo tasks contains two versions of\r
256         vStartMathTasks.c.  One is defined in flop.c, and uses double precision\r
257         floating point numbers and variables.  The other is defined in sp_flop.c,\r
258         and uses single precision floating point numbers and variables.  The\r
259         MicroBlaze floating point unit only handles single precision floating.\r
260         Therefore, to test the floating point hardware, sp_flop.c should be included\r
261         in this project. */\r
262         vStartMathTasks( mainFLOP_TASK_PRIORITY );\r
263 \r
264         /* Start the tasks that implements the command console on the UART, as\r
265         described above. */\r
266         vUARTCommandConsoleStart( mainUART_COMMAND_CONSOLE_STACK_SIZE, mainUART_COMMAND_CONSOLE_TASK_PRIORITY );\r
267 \r
268         /* Register the standard CLI commands. */\r
269         vRegisterSampleCLICommands();\r
270 \r
271         /* Create the register check tasks, as described at the top of this     file */\r
272         xTaskCreate( prvRegTestTaskEntry1, "Reg1", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_1_PARAMETER, tskIDLE_PRIORITY, NULL );\r
273         xTaskCreate( prvRegTestTaskEntry2, "Reg2", configMINIMAL_STACK_SIZE, mainREG_TEST_TASK_2_PARAMETER, tskIDLE_PRIORITY, NULL );\r
274 \r
275         /* Create the task that performs the 'check' functionality,     as described at\r
276         the top of this file. */\r
277         xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );\r
278 \r
279         /* Start the scheduler. */\r
280         vTaskStartScheduler();\r
281 \r
282         /* If all is well, the scheduler will now be running, and the following\r
283         line will never be reached.  If the following line does execute, then\r
284         there was insufficient FreeRTOS heap memory available for the Idle and/or\r
285         timer tasks to be created.  See the memory management section on the\r
286         FreeRTOS web site for more details on the FreeRTOS heap\r
287         http://www.freertos.org/a00111.html. */\r
288         for( ;; );\r
289 }\r
290 /*-----------------------------------------------------------*/\r
291 \r
292 static void prvCheckTask( void *pvParameters )\r
293 {\r
294 TickType_t xDelayPeriod = mainNO_ERROR_CHECK_TASK_PERIOD;\r
295 TickType_t xLastExecutionTime;\r
296 static unsigned long ulLastRegTest1Value = 0, ulLastRegTest2Value = 0;\r
297 unsigned long ulErrorFound = pdFALSE;\r
298 \r
299         /* Just to stop compiler warnings. */\r
300         ( void ) pvParameters;\r
301 \r
302         /* Initialise xLastExecutionTime so the first call to vTaskDelayUntil()\r
303         works correctly. */\r
304         xLastExecutionTime = xTaskGetTickCount();\r
305 \r
306         /* Cycle for ever, delaying then checking all the other tasks are still\r
307         operating without error.  The onboard LED is toggled on each iteration.\r
308         If an error is detected then the delay period is decreased from\r
309         mainNO_ERROR_CHECK_TASK_PERIOD to mainERROR_CHECK_TASK_PERIOD.  This has the\r
310         effect of increasing the rate at which the onboard LED toggles, and in so\r
311         doing gives visual feedback of the system status. */\r
312         for( ;; )\r
313         {\r
314                 /* Delay until it is time to execute again. */\r
315                 vTaskDelayUntil( &xLastExecutionTime, xDelayPeriod );\r
316 \r
317                 /* Check all the demo tasks (other than the flash tasks) to ensure\r
318                 that they are all still running, and that none have detected an error. */\r
319                 if( xAreMathsTaskStillRunning() != pdTRUE )\r
320                 {\r
321                         ulErrorFound |= 1UL << 1UL;\r
322                 }\r
323 \r
324                 if( xAreDynamicPriorityTasksStillRunning() != pdTRUE )\r
325                 {\r
326                         ulErrorFound |= 1UL << 2UL;\r
327                 }\r
328 \r
329                 if ( xAreBlockTimeTestTasksStillRunning() != pdTRUE )\r
330                 {\r
331                         ulErrorFound |= 1UL << 4UL;\r
332                 }\r
333 \r
334                 if ( xAreGenericQueueTasksStillRunning() != pdTRUE )\r
335                 {\r
336                         ulErrorFound |= 1UL << 5UL;\r
337                 }\r
338 \r
339                 if ( xAreRecursiveMutexTasksStillRunning() != pdTRUE )\r
340                 {\r
341                         ulErrorFound |= 1UL << 6UL;\r
342                 }\r
343 \r
344                 if( xAreSemaphoreTasksStillRunning() != pdTRUE )\r
345                 {\r
346                         ulErrorFound |= 1UL << 8UL;\r
347                 }\r
348 \r
349                 if( xAreTimerDemoTasksStillRunning( ( TickType_t ) mainNO_ERROR_CHECK_TASK_PERIOD ) != pdPASS )\r
350                 {\r
351                         ulErrorFound |= 1UL << 9UL;\r
352                 }\r
353 \r
354                 if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )\r
355                 {\r
356                         ulErrorFound |= 1UL << 10UL;\r
357                 }\r
358 \r
359                 if( xAreEventGroupTasksStillRunning() != pdPASS )\r
360                 {\r
361                         ulErrorFound |= 1UL << 12UL;\r
362                 }\r
363 \r
364                 if( xAreTaskNotificationTasksStillRunning() != pdTRUE )\r
365                 {\r
366                         ulErrorFound |= 1UL << 13UL;\r
367                 }\r
368 \r
369                 if( xAreInterruptSemaphoreTasksStillRunning() != pdTRUE )\r
370                 {\r
371                         ulErrorFound |= 1UL << 14UL;\r
372                 }\r
373 \r
374                 /* Check that the register test 1 task is still running. */\r
375                 if( ulLastRegTest1Value == ulRegTest1LoopCounter )\r
376                 {\r
377                         ulErrorFound |= 1UL << 15UL;\r
378                 }\r
379                 ulLastRegTest1Value = ulRegTest1LoopCounter;\r
380 \r
381                 /* Check that the register test 2 task is still running. */\r
382                 if( ulLastRegTest2Value == ulRegTest2LoopCounter )\r
383                 {\r
384                         ulErrorFound |= 1UL << 16UL;\r
385                 }\r
386                 ulLastRegTest2Value = ulRegTest2LoopCounter;\r
387 \r
388                 /* Toggle the check LED to give an indication of the system status.  If\r
389                 the LED toggles every mainNO_ERROR_CHECK_TASK_PERIOD milliseconds then\r
390                 everything is ok.  A faster toggle indicates an error. */\r
391                 vParTestToggleLED( mainCHECK_LED );\r
392 \r
393                 if( ulErrorFound != pdFALSE )\r
394                 {\r
395                         /* An error has been detected in one of the tasks - flash the LED\r
396                         at a higher frequency to give visible feedback that something has\r
397                         gone wrong. */\r
398                         xDelayPeriod = mainERROR_CHECK_TASK_PERIOD;\r
399                 }\r
400         }\r
401 }\r
402 /*-----------------------------------------------------------*/\r
403 \r
404 static void prvRegTestTaskEntry1( void *pvParameters )\r
405 {\r
406         /* Although the regtest task is written in assembler, its entry point is\r
407         written in C for convenience of checking the task parameter is being passed\r
408         in correctly. */\r
409         if( pvParameters == mainREG_TEST_TASK_1_PARAMETER )\r
410         {\r
411                 /* Start the part of the test that is written in assembler. */\r
412                 vRegTest1Implementation();\r
413         }\r
414 \r
415         /* The following line will only execute if the task parameter is found to\r
416         be incorrect.  The check timer will detect that the regtest loop counter is\r
417         not being incremented and flag an error. */\r
418         vTaskDelete( NULL );\r
419 }\r
420 /*-----------------------------------------------------------*/\r
421 \r
422 static void prvRegTestTaskEntry2( void *pvParameters )\r
423 {\r
424         /* Although the regtest task is written in assembler, its entry point is\r
425         written in C for convenience of checking the task parameter is being passed\r
426         in correctly. */\r
427         if( pvParameters == mainREG_TEST_TASK_2_PARAMETER )\r
428         {\r
429                 /* Start the part of the test that is written in assembler. */\r
430                 vRegTest2Implementation();\r
431         }\r
432 \r
433         /* The following line will only execute if the task parameter is found to\r
434         be incorrect.  The check timer will detect that the regtest loop counter is\r
435         not being incremented and flag an error. */\r
436         vTaskDelete( NULL );\r
437 }\r
438 /*-----------------------------------------------------------*/\r
439 \r
440 void vFullDemoTickHook( void )\r
441 {\r
442         /* The full demo includes a software timer demo/test that requires\r
443         prodding periodically from the tick interrupt. */\r
444         vTimerPeriodicISRTests();\r
445 \r
446         /* Call the periodic event group from ISR demo. */\r
447         vPeriodicEventGroupsProcessing();\r
448 \r
449         /* Use task notifications from an interrupt. */\r
450         xNotifyTaskFromISR();\r
451 \r
452         /* Use mutexes from interrupts. */\r
453         vInterruptSemaphorePeriodicTest();\r
454 }\r
455 /*-----------------------------------------------------------*/\r
456 \r
457 void vFullDemoIdleHook( void )\r
458 {\r
459 static uint32_t ulStartedTimers = pdFALSE;\r
460 \r
461         if( ulStartedTimers == pdFALSE )\r
462         {\r
463                 /* The flash timers are not created from main() as the timer demo needs\r
464                 the entire timer command queue in order to perform some tests. */\r
465                 vStartLEDFlashTimers( mainNUM_FLASH_TIMERS );\r
466                 ulStartedTimers = pdTRUE;\r
467         }\r
468 }\r
469 \r
470 \r
471 \r
472 \r