2 FreeRTOS V8.0.0 - Copyright (C) 2014 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 - 2 )
\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 mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
145 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
146 #define mainFLOP_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
147 #define mainQUEUE_OVERWRITE_PRIORITY ( tskIDLE_PRIORITY )
\r
149 #define mainTIMER_TEST_PERIOD ( 50 )
\r
151 /* Task function prototypes. */
\r
152 static void prvCheckTask( void *pvParameters );
\r
154 /* A task that is created from the idle task to test the functionality of
\r
155 eTaskStateGet(). */
\r
156 static void prvTestTask( void *pvParameters );
\r
159 * Called from the idle task hook function to demonstrate a few utility
\r
160 * functions that are not demonstrated by any of the standard demo tasks.
\r
162 static void prvDemonstrateTaskStateAndHandleGetFunctions( void );
\r
165 * Called from the idle task hook function to demonstrate the use of
\r
166 * xTimerPendFunctionCall() as xTimerPendFunctionCall() is not demonstrated by
\r
167 * any of the standard demo tasks.
\r
169 static void prvDemonstratePendingFunctionCall( void );
\r
172 * The function that is pended by prvDemonstratePendingFunctionCall().
\r
174 static void prvPendedFunction( void *pvParameter1, uint32_t ulParameter2 );
\r
177 * A task to demonstrate the use of the xQueueSpacesAvailable() function.
\r
179 static void prvDemoQueueSpaceFunctions( void *pvParameters );
\r
181 /*-----------------------------------------------------------*/
\r
183 /* The variable into which error messages are latched. */
\r
184 static char *pcStatusMessage = "OK";
\r
186 /* This semaphore is created purely to test using the vSemaphoreDelete() and
\r
187 semaphore tracing API functions. It has no other purpose. */
\r
188 static SemaphoreHandle_t xMutexToDelete = NULL;
\r
190 /*-----------------------------------------------------------*/
\r
192 int main_full( void )
\r
194 /* Start the check task as described at the top of this file. */
\r
195 xTaskCreate( prvCheckTask, "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
197 /* Create the standard demo tasks. */
\r
198 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
199 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
200 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
201 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
202 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
203 vStartQueuePeekTasks();
\r
204 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
205 vStartRecursiveMutexTasks();
\r
206 vStartCountingSemaphoreTasks();
\r
207 vStartDynamicPriorityTasks();
\r
208 vStartQueueSetTasks();
\r
209 vStartQueueOverwriteTask( mainQUEUE_OVERWRITE_PRIORITY );
\r
210 xTaskCreate( prvDemoQueueSpaceFunctions, "QSpace", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, NULL );
\r
211 vStartEventGroupTasks();
\r
213 #if( configUSE_PREEMPTION != 0 )
\r
215 /* Don't expect these tasks to pass when preemption is not used. */
\r
216 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
220 /* The suicide tasks must be created last as they need to know how many
\r
221 tasks were running prior to their creation. This then allows them to
\r
222 ascertain whether or not the correct/expected number of tasks are running at
\r
224 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
226 /* Create the semaphore that will be deleted in the idle task hook. This
\r
227 is done purely to test the use of vSemaphoreDelete(). */
\r
228 xMutexToDelete = xSemaphoreCreateMutex();
\r
230 /* Start the scheduler itself. */
\r
231 vTaskStartScheduler();
\r
233 /* Should never get here unless there was not enough heap space to create
\r
234 the idle and other system tasks. */
\r
237 /*-----------------------------------------------------------*/
\r
239 static void prvCheckTask( void *pvParameters )
\r
241 TickType_t xNextWakeTime;
\r
242 const TickType_t xCycleFrequency = 2500 / portTICK_PERIOD_MS;
\r
244 /* Just to remove compiler warning. */
\r
245 ( void ) pvParameters;
\r
247 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
248 xNextWakeTime = xTaskGetTickCount();
\r
252 /* Place this task in the blocked state until it is time to run again. */
\r
253 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );
\r
255 /* Check the standard demo tasks are running without error. */
\r
256 #if( configUSE_PREEMPTION != 0 )
\r
258 /* These tasks are only created when preemption is used. */
\r
259 if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )
\r
261 pcStatusMessage = "Error: TimerDemo";
\r
266 if( xAreEventGroupTasksStillRunning() != pdTRUE )
\r
268 pcStatusMessage = "Error: EventGroup";
\r
270 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
272 pcStatusMessage = "Error: IntMath";
\r
274 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
276 pcStatusMessage = "Error: GenQueue";
\r
278 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
280 pcStatusMessage = "Error: QueuePeek";
\r
282 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
284 pcStatusMessage = "Error: BlockQueue";
\r
286 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
288 pcStatusMessage = "Error: SemTest";
\r
290 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
292 pcStatusMessage = "Error: PollQueue";
\r
294 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
296 pcStatusMessage = "Error: Flop";
\r
298 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
300 pcStatusMessage = "Error: RecMutex";
\r
302 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
304 pcStatusMessage = "Error: CountSem";
\r
306 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
308 pcStatusMessage = "Error: Death";
\r
310 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )
\r
312 pcStatusMessage = "Error: Dynamic";
\r
314 else if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
316 pcStatusMessage = "Error: Queue set";
\r
318 else if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
320 pcStatusMessage = "Error: Queue overwrite";
\r
323 /* This is the only task that uses stdout so its ok to call printf()
\r
325 printf( ( char * ) "%s - %u\r\n", pcStatusMessage, ( unsigned int ) xTaskGetTickCount() );
\r
329 /*-----------------------------------------------------------*/
\r
331 static void prvTestTask( void *pvParameters )
\r
333 const unsigned long ulMSToSleep = 5;
\r
335 /* Just to remove compiler warnings. */
\r
336 ( void ) pvParameters;
\r
338 /* This task is just used to test the eTaskStateGet() function. It
\r
339 does not have anything to do. */
\r
342 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
343 tasks waiting to be terminated by the idle task. */
\r
344 Sleep( ulMSToSleep );
\r
347 /*-----------------------------------------------------------*/
\r
349 /* Called from vApplicationIdleHook(), which is defined in main.c. */
\r
350 void vFullDemoIdleFunction( void )
\r
352 const unsigned long ulMSToSleep = 15;
\r
355 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
356 tasks waiting to be terminated by the idle task. */
\r
357 Sleep( ulMSToSleep );
\r
359 /* Demonstrate a few utility functions that are not demonstrated by any of
\r
360 the standard demo tasks. */
\r
361 prvDemonstrateTaskStateAndHandleGetFunctions();
\r
363 /* Demonstrate the use of xTimerPendFunctionCall(), which is not
\r
364 demonstrated by any of the standard demo tasks. */
\r
365 prvDemonstratePendingFunctionCall();
\r
367 /* If xMutexToDelete has not already been deleted, then delete it now.
\r
368 This is done purely to demonstrate the use of, and test, the
\r
369 vSemaphoreDelete() macro. Care must be taken not to delete a semaphore
\r
370 that has tasks blocked on it. */
\r
371 if( xMutexToDelete != NULL )
\r
373 vSemaphoreDelete( xMutexToDelete );
\r
374 xMutexToDelete = NULL;
\r
377 /* Exercise heap_4 a bit. The malloc failed hook will trap failed
\r
378 allocations so there is no need to test here. */
\r
379 pvAllocated = pvPortMalloc( ( rand() % 100 ) + 1 );
\r
380 vPortFree( pvAllocated );
\r
382 /*-----------------------------------------------------------*/
\r
384 /* Called by vApplicationTickHook(), which is defined in main.c. */
\r
385 void vFullDemoTickHookFunction( void )
\r
387 /* Call the periodic timer test, which tests the timer API functions that
\r
388 can be called from an ISR. */
\r
389 #if( configUSE_PREEMPTION != 0 )
\r
391 /* Only created when preemption is used. */
\r
392 vTimerPeriodicISRTests();
\r
396 /* Call the periodic queue overwrite from ISR demo. */
\r
397 vQueueOverwritePeriodicISRDemo();
\r
399 /* Write to a queue that is in use as part of the queue set demo to
\r
400 demonstrate using queue sets from an ISR. */
\r
401 vQueueSetAccessQueueSetFromISR();
\r
403 /* Exercise event groups from interrupts. */
\r
404 vPeriodicEventGroupsProcessing();
\r
406 /*-----------------------------------------------------------*/
\r
408 static void prvPendedFunction( void *pvParameter1, uint32_t ulParameter2 )
\r
410 static uint32_t ulLastParameter1 = 1000UL, ulLastParameter2 = 0UL;
\r
411 uint32_t ulParameter1;
\r
413 ulParameter1 = ( uint32_t ) pvParameter1;
\r
415 /* Ensure the parameters are as expected. */
\r
416 configASSERT( ulParameter1 == ( ulLastParameter1 + 1 ) );
\r
417 configASSERT( ulParameter2 == ( ulLastParameter2 + 1 ) );
\r
419 /* Remember the parameters for the next time the function is called. */
\r
420 ulLastParameter1 = ulParameter1;
\r
421 ulLastParameter2 = ulParameter2;
\r
423 /*-----------------------------------------------------------*/
\r
425 static void prvDemonstratePendingFunctionCall( void )
\r
427 static uint32_t ulParameter1 = 1000UL, ulParameter2 = 0UL;
\r
428 const TickType_t xDontBlock = 0; /* This is called from the idle task so must *not* attempt to block. */
\r
430 /* prvPendedFunction() just expects the parameters to be incremented by one
\r
431 each time it is called. */
\r
435 /* Pend the function call, sending the parameters. */
\r
436 xTimerPendFunctionCall( prvPendedFunction, ( void * ) ulParameter1, ulParameter2, xDontBlock );
\r
438 /*-----------------------------------------------------------*/
\r
440 static void prvDemonstrateTaskStateAndHandleGetFunctions( void )
\r
442 TaskHandle_t xIdleTaskHandle, xTimerTaskHandle;
\r
444 static portBASE_TYPE xPerformedOneShotTests = pdFALSE;
\r
445 TaskHandle_t xTestTask;
\r
447 /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and
\r
448 xTaskGetIdleTaskHandle() functions. Also try using the function that sets
\r
449 the task number. */
\r
450 xIdleTaskHandle = xTaskGetIdleTaskHandle();
\r
451 xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();
\r
453 /* This is the idle hook, so the current task handle should equal the
\r
454 returned idle task handle. */
\r
455 if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )
\r
457 pcStatusMessage = "Error: Returned idle task handle was incorrect";
\r
460 /* Check the timer task handle was returned correctly. */
\r
461 pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );
\r
462 if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )
\r
464 pcStatusMessage = "Error: Returned timer task handle was incorrect";
\r
467 /* This task is running, make sure it's state is returned as running. */
\r
468 if( eTaskStateGet( xIdleTaskHandle ) != eRunning )
\r
470 pcStatusMessage = "Error: Returned idle task state was incorrect";
\r
473 /* If this task is running, then the timer task must be blocked. */
\r
474 if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )
\r
476 pcStatusMessage = "Error: Returned timer task state was incorrect";
\r
479 /* Other tests that should only be performed once follow. The test task
\r
480 is not created on each iteration because to do so would cause the death
\r
481 task to report an error (too many tasks running). */
\r
482 if( xPerformedOneShotTests == pdFALSE )
\r
484 /* Don't run this part of the test again. */
\r
485 xPerformedOneShotTests = pdTRUE;
\r
487 /* Create a test task to use to test other eTaskStateGet() return values. */
\r
488 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )
\r
490 /* If this task is running, the test task must be in the ready state. */
\r
491 if( eTaskStateGet( xTestTask ) != eReady )
\r
493 pcStatusMessage = "Error: Returned test task state was incorrect 1";
\r
496 /* Now suspend the test task and check its state is reported correctly. */
\r
497 vTaskSuspend( xTestTask );
\r
498 if( eTaskStateGet( xTestTask ) != eSuspended )
\r
500 pcStatusMessage = "Error: Returned test task state was incorrect 2";
\r
503 /* Now delete the task and check its state is reported correctly. */
\r
504 vTaskDelete( xTestTask );
\r
505 if( eTaskStateGet( xTestTask ) != eDeleted )
\r
507 pcStatusMessage = "Error: Returned test task state was incorrect 3";
\r
512 /*-----------------------------------------------------------*/
\r
514 static void prvDemoQueueSpaceFunctions( void *pvParameters )
\r
516 QueueHandle_t xQueue = NULL;
\r
517 const unsigned portBASE_TYPE uxQueueLength = 10;
\r
518 unsigned portBASE_TYPE uxReturn, x;
\r
520 /* Remove compiler warnings. */
\r
521 ( void ) pvParameters;
\r
523 /* Create the queue that will be used. Nothing is actually going to be
\r
524 sent or received so the queue item size is set to 0. */
\r
525 xQueue = xQueueCreate( uxQueueLength, 0 );
\r
526 configASSERT( xQueue );
\r
530 for( x = 0; x < uxQueueLength; x++ )
\r
532 /* Ask how many messages are available... */
\r
533 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
535 /* Check the number of messages being reported as being available
\r
536 is as expected, and force an assert if not. */
\r
537 if( uxReturn != x )
\r
539 /* xQueue cannot be NULL so this is deliberately causing an
\r
540 assert to be triggered as there is an error. */
\r
541 configASSERT( xQueue == NULL );
\r
544 /* Ask how many spaces remain in the queue... */
\r
545 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
547 /* Check the number of spaces being reported as being available
\r
548 is as expected, and force an assert if not. */
\r
549 if( uxReturn != ( uxQueueLength - x ) )
\r
551 /* xQueue cannot be NULL so this is deliberately causing an
\r
552 assert to be triggered as there is an error. */
\r
553 configASSERT( xQueue == NULL );
\r
556 /* Fill one more space in the queue. */
\r
557 xQueueSendToBack( xQueue, NULL, 0 );
\r
560 /* Perform the same check while the queue is full. */
\r
561 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
562 if( uxReturn != uxQueueLength )
\r
564 configASSERT( xQueue == NULL );
\r
567 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
569 if( uxReturn != 0 )
\r
571 configASSERT( xQueue == NULL );
\r
574 /* The queue is full, start again. */
\r
575 xQueueReset( xQueue );
\r
577 #if( configUSE_PREEMPTION == 0 )
\r