2 FreeRTOS V7.4.2 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
\r
5 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
10 * Complete, revised, and edited pdf reference manuals are also *
\r
13 * Purchasing FreeRTOS documentation will not only help you, by *
\r
14 * ensuring you get running as quickly as possible and with an *
\r
15 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
16 * the FreeRTOS project to continue with its mission of providing *
\r
17 * professional grade, cross platform, de facto standard solutions *
\r
18 * for microcontrollers - completely free of charge! *
\r
20 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
22 * Thank you for using FreeRTOS, and thank you for your support! *
\r
24 ***************************************************************************
\r
27 This file is part of the FreeRTOS distribution.
\r
29 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
30 the terms of the GNU General Public License (version 2) as published by the
\r
31 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
33 >>>>>>NOTE<<<<<< The modification to the GPL is included to allow you to
\r
34 distribute a combined work that includes FreeRTOS without being obliged to
\r
35 provide the source code for proprietary components outside of the FreeRTOS
\r
38 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
39 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
40 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
\r
41 details. You should have received a copy of the GNU General Public License
\r
42 and the FreeRTOS license exception along with FreeRTOS; if not it can be
\r
43 viewed here: http://www.freertos.org/a00114.html and also obtained by
\r
44 writing to Real Time Engineers Ltd., contact details for whom are available
\r
45 on the FreeRTOS WEB site.
\r
49 ***************************************************************************
\r
51 * Having a problem? Start by reading the FAQ "My application does *
\r
52 * not run, what could be wrong?" *
\r
54 * http://www.FreeRTOS.org/FAQHelp.html *
\r
56 ***************************************************************************
\r
59 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
60 license and Real Time Engineers Ltd. contact details.
\r
62 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
63 including FreeRTOS+Trace - an indispensable productivity tool, and our new
\r
64 fully thread aware and reentrant UDP/IP stack.
\r
66 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
67 Integrity Systems, who sell the code with commercial support,
\r
68 indemnification and middleware, under the OpenRTOS brand.
\r
70 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
71 engineered and independently SIL3 certified version for use in safety and
\r
72 mission critical applications that require provable dependability.
\r
76 *******************************************************************************
\r
77 * -NOTE- The Win32 port is a simulation (or is that emulation?) only! Do not
\r
78 * expect to get real time behaviour from the Win32 port or this demo
\r
79 * application. It is provided as a convenient development and demonstration
\r
80 * test bed only. This was tested using Windows XP on a dual core laptop.
\r
82 * In this example, one simulated millisecond will take approximately 40ms to
\r
83 * execute, and Windows will not be running the FreeRTOS simulator threads
\r
84 * continuously, so the timing information in the FreeRTOS+Trace logs have no
\r
85 * meaningful units. See the documentation page for the Windows simulator for
\r
86 * an explanation of the slow timing:
\r
87 * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html
\r
88 * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -
\r
89 *******************************************************************************
\r
91 * main() creates all the demo application tasks, then starts the scheduler.
\r
92 * The web documentation provides more details of the standard demo application
\r
93 * tasks, which provide no particular functionality but do provide a good
\r
94 * example of how to use the FreeRTOS API.
\r
96 * In addition to the standard demo tasks, the following tasks and tests are
\r
97 * defined and/or created within this file:
\r
99 * "Check" task - This only executes every five seconds but has a high priority
\r
100 * to ensure it gets processor time. Its main function is to check that all the
\r
101 * standard demo tasks are still operational. While no errors have been
\r
102 * discovered the check task will print out "OK" and the current simulated tick
\r
103 * time. If an error is discovered in the execution of a task then the check
\r
104 * task will print out an appropriate error message.
\r
109 /* Standard includes. */
\r
111 #include <stdlib.h>
\r
114 /* Kernel includes. */
\r
115 #include <FreeRTOS.h>
\r
118 #include "timers.h"
\r
119 #include "semphr.h"
\r
121 /* Standard demo includes. */
\r
122 #include "BlockQ.h"
\r
123 #include "integer.h"
\r
124 #include "semtest.h"
\r
126 #include "GenQTest.h"
\r
128 #include "recmutex.h"
\r
130 #include "TimerDemo.h"
\r
131 #include "countsem.h"
\r
133 #include "dynamic.h"
\r
134 #include "QueueSet.h"
\r
136 /* Priorities at which the tasks are created. */
\r
137 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
138 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
139 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
140 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
141 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
142 #define mainFLASH_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
143 #define mainuIP_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
144 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
145 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
146 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
148 #define mainTIMER_TEST_PERIOD ( 50 )
\r
150 /* Task function prototypes. */
\r
151 static void prvCheckTask( void *pvParameters );
\r
153 /* A task that is created from the idle task to test the functionality of
\r
154 eTaskStateGet(). */
\r
155 static void prvTestTask( void *pvParameters );
\r
158 * Writes trace data to a disk file when the trace recording is stopped.
\r
159 * This function will simply overwrite any trace files that already exist.
\r
161 static void prvSaveTraceFile( void );
\r
163 /*-----------------------------------------------------------*/
\r
165 /* The variable into which error messages are latched. */
\r
166 static char *pcStatusMessage = "OK";
\r
168 /* This semaphore is created purely to test using the vSemaphoreDelete() and
\r
169 semaphore tracing API functions. It has no other purpose. */
\r
170 static xSemaphoreHandle xMutexToDelete = NULL;
\r
172 /* The user trace event posted to the trace recording on each tick interrupt.
\r
173 Note tick events will not appear in the trace recording with regular period
\r
174 because this project runs in a Windows simulator, and does not therefore
\r
175 exhibit deterministic behaviour. */
\r
176 traceLabel xTickTraceUserEvent;
\r
178 /*-----------------------------------------------------------*/
\r
182 /* Initialise the trace recorder and create the label used to post user
\r
183 events to the trace recording on each tick interrupt. */
\r
184 vTraceInitTraceData();
\r
185 xTickTraceUserEvent = xTraceOpenLabel( "tick" );
\r
187 /* Start the check task as described at the top of this file. */
\r
188 xTaskCreate( prvCheckTask, ( signed char * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
190 /* Create the standard demo tasks. */
\r
191 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
192 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
193 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
194 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
195 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
196 vStartQueuePeekTasks();
\r
197 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
198 vStartRecursiveMutexTasks();
\r
199 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
200 vStartCountingSemaphoreTasks();
\r
201 vStartDynamicPriorityTasks();
\r
202 vStartQueueSetTasks();
\r
204 /* The suicide tasks must be created last as they need to know how many
\r
205 tasks were running prior to their creation. This then allows them to
\r
206 ascertain whether or not the correct/expected number of tasks are running at
\r
208 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
210 /* Create the semaphore that will be deleted in the idle task hook. This
\r
211 is done purely to test the use of vSemaphoreDelete(). */
\r
212 xMutexToDelete = xSemaphoreCreateMutex();
\r
214 /* Start the trace recording - the recording is written to a file if
\r
215 configASSERT() is called. */
\r
216 printf( "\r\nTrace started. Hit a key to dump trace file to disk.\r\n" );
\r
219 /* Start the scheduler itself. */
\r
220 vTaskStartScheduler();
\r
222 /* Should never get here unless there was not enough heap space to create
\r
223 the idle and other system tasks. */
\r
226 /*-----------------------------------------------------------*/
\r
228 static void prvCheckTask( void *pvParameters )
\r
230 portTickType xNextWakeTime;
\r
231 const portTickType xCycleFrequency = 1000 / portTICK_RATE_MS;
\r
233 /* Just to remove compiler warning. */
\r
234 ( void ) pvParameters;
\r
236 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
237 xNextWakeTime = xTaskGetTickCount();
\r
241 /* Place this task in the blocked state until it is time to run again. */
\r
242 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );
\r
244 /* Check the standard demo tasks are running without error. */
\r
245 if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )
\r
247 pcStatusMessage = "Error: TimerDemo";
\r
249 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
251 pcStatusMessage = "Error: IntMath";
\r
253 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
255 pcStatusMessage = "Error: GenQueue";
\r
257 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
259 pcStatusMessage = "Error: QueuePeek";
\r
261 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
263 pcStatusMessage = "Error: BlockQueue";
\r
265 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
267 pcStatusMessage = "Error: SemTest";
\r
269 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
271 pcStatusMessage = "Error: PollQueue";
\r
273 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
275 pcStatusMessage = "Error: Flop";
\r
277 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
279 pcStatusMessage = "Error: RecMutex";
\r
281 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
283 pcStatusMessage = "Error: CountSem";
\r
285 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
287 pcStatusMessage = "Error: Death";
\r
289 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )
\r
291 pcStatusMessage = "Error: Dynamic\r\n";
\r
293 else if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
295 pcStatusMessage = "Error: Queue set\r\n";
\r
298 /* This is the only task that uses stdout so its ok to call printf()
\r
300 printf( "%s - %d\r\n", pcStatusMessage, xTaskGetTickCount() );
\r
303 /*-----------------------------------------------------------*/
\r
305 static void prvTestTask( void *pvParameters )
\r
307 const unsigned long ulMSToSleep = 5;
\r
309 /* Just to remove compiler warnings. */
\r
310 ( void ) pvParameters;
\r
312 /* This task is just used to test the eTaskStateGet() function. It
\r
313 does not have anything to do. */
\r
316 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
317 tasks waiting to be terminated by the idle task. */
\r
318 Sleep( ulMSToSleep );
\r
321 /*-----------------------------------------------------------*/
\r
323 void vApplicationIdleHook( void )
\r
325 const unsigned long ulMSToSleep = 15;
\r
326 xTaskHandle xIdleTaskHandle, xTimerTaskHandle, xTestTask;
\r
327 signed char *pcTaskName;
\r
328 const unsigned char ucConstQueueNumber = 0xaaU, ucConstTaskNumber = 0x55U;
\r
330 static portBASE_TYPE xTraceRunning = pdTRUE;
\r
332 /* These three functions are only meant for use by trace code, and not for
\r
333 direct use from application code, hence their prototypes are not in queue.h. */
\r
334 extern void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber );
\r
335 extern unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue );
\r
336 extern unsigned char ucQueueGetQueueType( xQueueHandle pxQueue );
\r
337 extern void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );
\r
338 extern unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );
\r
340 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
341 tasks waiting to be terminated by the idle task. */
\r
342 Sleep( ulMSToSleep );
\r
344 /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and
\r
345 xTaskGetIdleTaskHandle() functions. Also try using the function that sets
\r
346 the task number. */
\r
347 xIdleTaskHandle = xTaskGetIdleTaskHandle();
\r
348 xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();
\r
349 vTaskSetTaskNumber( xIdleTaskHandle, ( unsigned long ) ucConstTaskNumber );
\r
350 configASSERT( uxTaskGetTaskNumber( xIdleTaskHandle ) == ucConstTaskNumber );
\r
352 /* This is the idle hook, so the current task handle should equal the
\r
353 returned idle task handle. */
\r
354 if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )
\r
356 pcStatusMessage = "Error: Returned idle task handle was incorrect";
\r
359 /* Check the timer task handle was returned correctly. */
\r
360 pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );
\r
361 if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )
\r
363 pcStatusMessage = "Error: Returned timer task handle was incorrect";
\r
366 /* This task is running, make sure its state is returned as running. */
\r
367 if( eTaskStateGet( xIdleTaskHandle ) != eRunning )
\r
369 pcStatusMessage = "Error: Returned idle task state was incorrect";
\r
372 /* If this task is running, then the timer task must be blocked. */
\r
373 if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )
\r
375 pcStatusMessage = "Error: Returned timer task state was incorrect";
\r
378 /* If xMutexToDelete has not already been deleted, then delete it now.
\r
379 This is done purely to demonstrate the use of, and test, the
\r
380 vSemaphoreDelete() macro. Care must be taken not to delete a semaphore
\r
381 that has tasks blocked on it. */
\r
382 if( xMutexToDelete != NULL )
\r
384 /* Before deleting the semaphore, test the function used to set its
\r
385 number. This would normally only be done from trace software, rather
\r
386 than application code. */
\r
387 vQueueSetQueueNumber( xMutexToDelete, ucConstQueueNumber );
\r
389 /* Before deleting the semaphore, test the functions used to get its
\r
390 type and number. Again, these would normally only be done from trace
\r
391 software, rather than application code. */
\r
392 configASSERT( ucQueueGetQueueNumber( xMutexToDelete ) == ucConstQueueNumber );
\r
393 configASSERT( ucQueueGetQueueType( xMutexToDelete ) == queueQUEUE_TYPE_MUTEX );
\r
394 vSemaphoreDelete( xMutexToDelete );
\r
395 xMutexToDelete = NULL;
\r
397 /* Other tests that should only be performed once follow. The test task
\r
398 is not created on each iteration because to do so would cause the death
\r
399 task to report an error (too many tasks running). */
\r
401 /* Create a test task to use to test other eTaskStateGet() return values. */
\r
402 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )
\r
404 /* If this task is running, the test task must be in the ready state. */
\r
405 if( eTaskStateGet( xTestTask ) != eReady )
\r
407 pcStatusMessage = "Error: Returned test task state was incorrect 1";
\r
410 /* Now suspend the test task and check its state is reported correctly. */
\r
411 vTaskSuspend( xTestTask );
\r
412 if( eTaskStateGet( xTestTask ) != eSuspended )
\r
414 pcStatusMessage = "Error: Returned test task state was incorrect 2";
\r
417 /* Now delete the task and check its state is reported correctly. */
\r
418 vTaskDelete( xTestTask );
\r
419 if( eTaskStateGet( xTestTask ) != eDeleted )
\r
421 pcStatusMessage = "Error: Returned test task state was incorrect 3";
\r
426 /* Exercise heap_4 a bit. The malloc failed hook will trap failed
\r
427 allocations so there is no need to test here. */
\r
428 pvAllocated = pvPortMalloc( ( rand() % 100 ) + 1 );
\r
429 vPortFree( pvAllocated );
\r
431 if( _kbhit() != pdFALSE )
\r
433 if( xTraceRunning == pdTRUE )
\r
435 prvSaveTraceFile();
\r
436 xTraceRunning = pdFALSE;
\r
440 /*-----------------------------------------------------------*/
\r
442 void vApplicationMallocFailedHook( void )
\r
446 /*-----------------------------------------------------------*/
\r
448 void vApplicationStackOverflowHook( void )
\r
450 /* Can be implemented if required, but not required in this
\r
451 environment and running this demo. */
\r
453 /*-----------------------------------------------------------*/
\r
455 void vApplicationTickHook( void )
\r
457 /* Call the periodic timer test, which tests the timer API functions that
\r
458 can be called from an ISR. */
\r
459 vTimerPeriodicISRTests();
\r
461 /* Write to a queue that is in use as part of the queue set demo to
\r
462 demonstrate using queue sets from an ISR. */
\r
463 vQueueSetAccessQueueSetFromISR();
\r
465 /* Write a user event to the trace log.
\r
466 Note tick events will not appear in the trace recording with regular period
\r
467 because this project runs in a Windows simulator, and does not therefore
\r
468 exhibit deterministic behaviour. */
\r
469 vTraceUserEvent( xTickTraceUserEvent );
\r
471 /*-----------------------------------------------------------*/
\r
473 void vAssertCalled( void )
\r
475 taskDISABLE_INTERRUPTS();
\r
477 /* Stop the trace recording. */
\r
479 prvSaveTraceFile();
\r
483 /*-----------------------------------------------------------*/
\r
485 static void prvSaveTraceFile( void )
\r
487 FILE* pxOutputFile;
\r
489 fopen_s( &pxOutputFile, "Trace.dump", "wb");
\r
491 if( pxOutputFile != NULL )
\r
493 fwrite( RecorderDataPtr, sizeof( RecorderDataType ), 1, pxOutputFile );
\r
494 fclose( pxOutputFile );
\r
495 printf( "\r\nTrace output saved to Trace.dump\r\n" );
\r
499 printf( "\r\nFailed to create trace dump file\r\n" );
\r