2 FreeRTOS V7.6.0 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
7 ***************************************************************************
\r
9 * FreeRTOS provides completely free yet professionally developed, *
\r
10 * robust, strictly quality controlled, supported, and cross *
\r
11 * platform software that has become a de facto standard. *
\r
13 * Help yourself get started quickly and support the FreeRTOS *
\r
14 * project by purchasing a FreeRTOS tutorial book, reference *
\r
15 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
19 ***************************************************************************
\r
21 This file is part of the FreeRTOS distribution.
\r
23 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
24 the terms of the GNU General Public License (version 2) as published by the
\r
25 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
27 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
28 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
29 >>! the source code for proprietary components outside of the FreeRTOS
\r
32 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
33 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
34 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
35 link: http://www.freertos.org/a00114.html
\r
39 ***************************************************************************
\r
41 * Having a problem? Start by reading the FAQ "My application does *
\r
42 * not run, what could be wrong?" *
\r
44 * http://www.FreeRTOS.org/FAQHelp.html *
\r
46 ***************************************************************************
\r
48 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
49 license and Real Time Engineers Ltd. contact details.
\r
51 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
52 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
53 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
55 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
56 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
57 licenses offer ticketed support, indemnification and middleware.
\r
59 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
60 engineered and independently SIL3 certified version for use in safety and
\r
61 mission critical applications that require provable dependability.
\r
67 *******************************************************************************
\r
68 * NOTE 1: The Win32 port is a simulation (or is that emulation?) only! Do not
\r
69 * expect to get real time behaviour from the Win32 port or this demo
\r
70 * application. It is provided as a convenient development and demonstration
\r
71 * test bed only. This was tested using Windows XP on a dual core laptop.
\r
73 * Windows will not be running the FreeRTOS simulator threads continuously, so
\r
74 * the timing information in the FreeRTOS+Trace logs have no meaningful units.
\r
75 * See the documentation page for the Windows simulator for an explanation of
\r
77 * http://www.freertos.org/FreeRTOS-Windows-Simulator-Emulator-for-Visual-Studio-and-Eclipse-MingW.html
\r
78 * - READ THE WEB DOCUMENTATION FOR THIS PORT FOR MORE INFORMATION ON USING IT -
\r
80 * NOTE 2: This project provides two demo applications. A simple blinky style
\r
81 * project, and a more comprehensive test and demo application. The
\r
82 * mainCREATE_SIMPLE_BLINKY_DEMO_ONLY setting in main.c is used to select
\r
83 * between the two. See the notes on using mainCREATE_SIMPLE_BLINKY_DEMO_ONLY
\r
84 * in main.c. This file implements the comprehensive test and demo version.
\r
86 * NOTE 3: This file only contains the source code that is specific to the
\r
87 * basic demo. Generic functions, such FreeRTOS hook functions, are defined in
\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
113 /* Kernel includes. */
\r
114 #include <FreeRTOS.h>
\r
117 #include "timers.h"
\r
118 #include "semphr.h"
\r
120 /* Standard demo includes. */
\r
121 #include "BlockQ.h"
\r
122 #include "integer.h"
\r
123 #include "semtest.h"
\r
125 #include "GenQTest.h"
\r
127 #include "recmutex.h"
\r
129 #include "TimerDemo.h"
\r
130 #include "countsem.h"
\r
132 #include "dynamic.h"
\r
133 #include "QueueSet.h"
\r
134 #include "QueueOverwrite.h"
\r
135 #include "EventGroupsDemo.h"
\r
137 /* Priorities at which the tasks are created. */
\r
138 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
139 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
140 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
141 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
142 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
143 #define mainFLASH_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
144 #define mainuIP_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
145 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
146 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
147 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
148 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
150 #define mainTIMER_TEST_PERIOD ( 50 )
\r
152 /* Task function prototypes. */
\r
153 static void prvCheckTask( void *pvParameters );
\r
155 /* A task that is created from the idle task to test the functionality of
\r
156 eTaskStateGet(). */
\r
157 static void prvTestTask( void *pvParameters );
\r
160 * Called from the idle task hook function to demonstrate a few utility
\r
161 * functions that are not demonstrated by any of the standard demo tasks.
\r
163 static void prvDemonstrateTaskStateAndHandleGetFunctions( void );
\r
166 * A task to demonstrate the use of the xQueueSpacesAvailable() function.
\r
168 static void prvDemoQueueSpaceFunctions( void *pvParameters );
\r
170 /*-----------------------------------------------------------*/
\r
172 /* The variable into which error messages are latched. */
\r
173 static char *pcStatusMessage = "OK";
\r
175 /* This semaphore is created purely to test using the vSemaphoreDelete() and
\r
176 semaphore tracing API functions. It has no other purpose. */
\r
177 static xSemaphoreHandle xMutexToDelete = NULL;
\r
179 /*-----------------------------------------------------------*/
\r
181 int main_full( void )
\r
183 /* Start the check task as described at the top of this file. */
\r
184 xTaskCreate( prvCheckTask, ( signed char * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
186 /* Create the standard demo tasks. */
\r
187 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
188 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
189 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
190 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
191 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
192 vStartQueuePeekTasks();
\r
193 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
194 vStartRecursiveMutexTasks();
\r
195 vStartCountingSemaphoreTasks();
\r
196 vStartDynamicPriorityTasks();
\r
197 vStartQueueSetTasks();
\r
198 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
199 xTaskCreate( prvDemoQueueSpaceFunctions, ( signed char * ) "QSpace", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
200 vStartEventGroupTasks();
\r
202 #if( configUSE_PREEMPTION != 0 )
\r
204 /* Don't expect these tasks to pass when preemption is not used. */
\r
205 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
209 /* The suicide tasks must be created last as they need to know how many
\r
210 tasks were running prior to their creation. This then allows them to
\r
211 ascertain whether or not the correct/expected number of tasks are running at
\r
213 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
215 /* Create the semaphore that will be deleted in the idle task hook. This
\r
216 is done purely to test the use of vSemaphoreDelete(). */
\r
217 xMutexToDelete = xSemaphoreCreateMutex();
\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 = 2500 / 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( configUSE_PREEMPTION != 0 )
\r
247 /* These tasks are only created when preemption is used. */
\r
248 if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )
\r
250 pcStatusMessage = "Error: TimerDemo";
\r
255 if( xAreEventGroupTasksStillRunning() != pdTRUE )
\r
257 pcStatusMessage = "Error: EventGroup";
\r
259 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
261 pcStatusMessage = "Error: IntMath";
\r
263 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
265 pcStatusMessage = "Error: GenQueue";
\r
267 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
269 pcStatusMessage = "Error: QueuePeek";
\r
271 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
273 pcStatusMessage = "Error: BlockQueue";
\r
275 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
277 pcStatusMessage = "Error: SemTest";
\r
279 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
281 pcStatusMessage = "Error: PollQueue";
\r
283 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
285 pcStatusMessage = "Error: Flop";
\r
287 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
289 pcStatusMessage = "Error: RecMutex";
\r
291 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
293 pcStatusMessage = "Error: CountSem";
\r
295 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
297 pcStatusMessage = "Error: Death";
\r
299 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )
\r
301 pcStatusMessage = "Error: Dynamic";
\r
303 else if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
305 pcStatusMessage = "Error: Queue set";
\r
307 else if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
309 pcStatusMessage = "Error: Queue overwrite";
\r
312 /* This is the only task that uses stdout so its ok to call printf()
\r
314 printf( ( char * ) "%s - %u\r\n", pcStatusMessage, ( unsigned int ) xTaskGetTickCount() );
\r
318 /*-----------------------------------------------------------*/
\r
320 static void prvTestTask( void *pvParameters )
\r
322 const unsigned long ulMSToSleep = 5;
\r
324 /* Just to remove compiler warnings. */
\r
325 ( void ) pvParameters;
\r
327 /* This task is just used to test the eTaskStateGet() function. It
\r
328 does not have anything to do. */
\r
331 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
332 tasks waiting to be terminated by the idle task. */
\r
333 Sleep( ulMSToSleep );
\r
336 /*-----------------------------------------------------------*/
\r
338 /* Called from vApplicationIdleHook(), which is defined in main.c. */
\r
339 void vFullDemoIdleFunction( void )
\r
341 const unsigned long ulMSToSleep = 15;
\r
342 const unsigned portBASE_TYPE uxConstQueueNumber = 0xaaU;
\r
345 /* These three functions are only meant for use by trace code, and not for
\r
346 direct use from application code, hence their prototypes are not in queue.h. */
\r
347 extern void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned portBASE_TYPE uxQueueNumber );
\r
348 extern unsigned portBASE_TYPE uxQueueGetQueueNumber( xQueueHandle pxQueue );
\r
349 extern unsigned char ucQueueGetQueueType( xQueueHandle pxQueue );
\r
350 extern void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );
\r
351 extern unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );
\r
353 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
354 tasks waiting to be terminated by the idle task. */
\r
355 Sleep( ulMSToSleep );
\r
357 /* Demonstrate a few utility functions that are not demonstrated by any of
\r
358 the standard demo tasks. */
\r
359 prvDemonstrateTaskStateAndHandleGetFunctions();
\r
361 /* If xMutexToDelete has not already been deleted, then delete it now.
\r
362 This is done purely to demonstrate the use of, and test, the
\r
363 vSemaphoreDelete() macro. Care must be taken not to delete a semaphore
\r
364 that has tasks blocked on it. */
\r
365 if( xMutexToDelete != NULL )
\r
367 /* Before deleting the semaphore, test the function used to set its
\r
368 number. This would normally only be done from trace software, rather
\r
369 than application code. */
\r
370 vQueueSetQueueNumber( xMutexToDelete, uxConstQueueNumber );
\r
372 /* Before deleting the semaphore, test the functions used to get its
\r
373 type and number. Again, these would normally only be done from trace
\r
374 software, rather than application code. */
\r
375 configASSERT( uxQueueGetQueueNumber( xMutexToDelete ) == uxConstQueueNumber );
\r
376 configASSERT( ucQueueGetQueueType( xMutexToDelete ) == queueQUEUE_TYPE_MUTEX );
\r
377 vSemaphoreDelete( xMutexToDelete );
\r
378 xMutexToDelete = NULL;
\r
381 /* Exercise heap_4 a bit. The malloc failed hook will trap failed
\r
382 allocations so there is no need to test here. */
\r
383 pvAllocated = pvPortMalloc( ( rand() % 100 ) + 1 );
\r
384 vPortFree( pvAllocated );
\r
386 /*-----------------------------------------------------------*/
\r
388 /* Called by vApplicationTickHook(), which is defined in main.c. */
\r
389 void vFullDemoTickHookFunction( void )
\r
391 /* Call the periodic timer test, which tests the timer API functions that
\r
392 can be called from an ISR. */
\r
393 #if( configUSE_PREEMPTION != 0 )
\r
395 /* Only created when preemption is used. */
\r
396 vTimerPeriodicISRTests();
\r
400 /* Call the periodic queue overwrite from ISR demo. */
\r
401 vQueueOverwritePeriodicISRDemo();
\r
403 /* Write to a queue that is in use as part of the queue set demo to
\r
404 demonstrate using queue sets from an ISR. */
\r
405 vQueueSetAccessQueueSetFromISR();
\r
407 /*-----------------------------------------------------------*/
\r
409 static void prvDemonstrateTaskStateAndHandleGetFunctions( void )
\r
411 xTaskHandle xIdleTaskHandle, xTimerTaskHandle;
\r
412 const unsigned char ucConstTaskNumber = 0x55U;
\r
413 signed char *pcTaskName;
\r
414 static portBASE_TYPE xPerformedOneShotTests = pdFALSE;
\r
415 xTaskHandle xTestTask;
\r
417 /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and
\r
418 xTaskGetIdleTaskHandle() functions. Also try using the function that sets
\r
419 the task number. */
\r
420 xIdleTaskHandle = xTaskGetIdleTaskHandle();
\r
421 xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();
\r
422 vTaskSetTaskNumber( xIdleTaskHandle, ( unsigned long ) ucConstTaskNumber );
\r
423 configASSERT( uxTaskGetTaskNumber( xIdleTaskHandle ) == ucConstTaskNumber );
\r
425 /* This is the idle hook, so the current task handle should equal the
\r
426 returned idle task handle. */
\r
427 if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )
\r
429 pcStatusMessage = "Error: Returned idle task handle was incorrect";
\r
432 /* Check the timer task handle was returned correctly. */
\r
433 pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );
\r
434 if( strcmp( ( char * ) pcTaskName, "Tmr Svc" ) != 0 )
\r
436 pcStatusMessage = "Error: Returned timer task handle was incorrect";
\r
439 /* This task is running, make sure it's state is returned as running. */
\r
440 if( eTaskStateGet( xIdleTaskHandle ) != eRunning )
\r
442 pcStatusMessage = "Error: Returned idle task state was incorrect";
\r
445 /* If this task is running, then the timer task must be blocked. */
\r
446 if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )
\r
448 pcStatusMessage = "Error: Returned timer task state was incorrect";
\r
451 /* Other tests that should only be performed once follow. The test task
\r
452 is not created on each iteration because to do so would cause the death
\r
453 task to report an error (too many tasks running). */
\r
454 if( xPerformedOneShotTests == pdFALSE )
\r
456 /* Don't run this part of the test again. */
\r
457 xPerformedOneShotTests = pdTRUE;
\r
459 /* Create a test task to use to test other eTaskStateGet() return values. */
\r
460 if( xTaskCreate( prvTestTask, ( const signed char * const ) "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )
\r
462 /* If this task is running, the test task must be in the ready state. */
\r
463 if( eTaskStateGet( xTestTask ) != eReady )
\r
465 pcStatusMessage = "Error: Returned test task state was incorrect 1";
\r
468 /* Now suspend the test task and check its state is reported correctly. */
\r
469 vTaskSuspend( xTestTask );
\r
470 if( eTaskStateGet( xTestTask ) != eSuspended )
\r
472 pcStatusMessage = "Error: Returned test task state was incorrect 2";
\r
475 /* Now delete the task and check its state is reported correctly. */
\r
476 vTaskDelete( xTestTask );
\r
477 if( eTaskStateGet( xTestTask ) != eDeleted )
\r
479 pcStatusMessage = "Error: Returned test task state was incorrect 3";
\r
484 /*-----------------------------------------------------------*/
\r
486 static void prvDemoQueueSpaceFunctions( void *pvParameters )
\r
488 xQueueHandle xQueue = NULL;
\r
489 const unsigned portBASE_TYPE uxQueueLength = 10;
\r
490 unsigned portBASE_TYPE uxReturn, x;
\r
492 /* Remove compiler warnings. */
\r
493 ( void ) pvParameters;
\r
495 /* Create the queue that will be used. Nothing is actually going to be
\r
496 sent or received so the queue item size is set to 0. */
\r
497 xQueue = xQueueCreate( uxQueueLength, 0 );
\r
498 configASSERT( xQueue );
\r
502 for( x = 0; x < uxQueueLength; x++ )
\r
504 /* Ask how many messages are available... */
\r
505 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
507 /* Check the number of messages being reported as being available
\r
508 is as expected, and force an assert if not. */
\r
509 if( uxReturn != x )
\r
511 /* xQueue cannot be NULL so this is deliberately causing an
\r
512 assert to be triggered as there is an error. */
\r
513 configASSERT( xQueue == NULL );
\r
516 /* Ask how many spaces remain in the queue... */
\r
517 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
519 /* Check the number of spaces being reported as being available
\r
520 is as expected, and force an assert if not. */
\r
521 if( uxReturn != ( uxQueueLength - x ) )
\r
523 /* xQueue cannot be NULL so this is deliberately causing an
\r
524 assert to be triggered as there is an error. */
\r
525 configASSERT( xQueue == NULL );
\r
528 /* Fill one more space in the queue. */
\r
529 xQueueSendToBack( xQueue, NULL, 0 );
\r
532 /* Perform the same check while the queue is full. */
\r
533 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
534 if( uxReturn != uxQueueLength )
\r
536 configASSERT( xQueue == NULL );
\r
539 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
541 if( uxReturn != 0 )
\r
543 configASSERT( xQueue == NULL );
\r
546 /* The queue is full, start again. */
\r
547 xQueueReset( xQueue );
\r
549 #if( configUSE_PREEMPTION == 0 )
\r