2 FreeRTOS V7.5.3 - 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
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
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 * A task to demonstrate the use of the xQueueSpacesAvailable() function.
\r
167 static void prvDemoQueueSpaceFunctions( void *pvParameters );
\r
169 /*-----------------------------------------------------------*/
\r
171 /* The variable into which error messages are latched. */
\r
172 static char *pcStatusMessage = "OK";
\r
174 /* This semaphore is created purely to test using the vSemaphoreDelete() and
\r
175 semaphore tracing API functions. It has no other purpose. */
\r
176 static xSemaphoreHandle xMutexToDelete = NULL;
\r
178 /*-----------------------------------------------------------*/
\r
180 int main_full( void )
\r
182 /* Start the check task as described at the top of this file. */
\r
183 xTaskCreate( prvCheckTask, ( signed char * ) "Check", configMINIMAL_STACK_SIZE, NULL, mainCHECK_TASK_PRIORITY, NULL );
\r
185 /* Create the standard demo tasks. */
\r
186 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
187 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
188 vStartPolledQueueTasks( mainQUEUE_POLL_PRIORITY );
\r
189 vStartIntegerMathTasks( mainINTEGER_TASK_PRIORITY );
\r
190 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
191 vStartQueuePeekTasks();
\r
192 vStartMathTasks( mainFLOP_TASK_PRIORITY );
\r
193 vStartRecursiveMutexTasks();
\r
194 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\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
201 /* The suicide tasks must be created last as they need to know how many
\r
202 tasks were running prior to their creation. This then allows them to
\r
203 ascertain whether or not the correct/expected number of tasks are running at
\r
205 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
207 /* Create the semaphore that will be deleted in the idle task hook. This
\r
208 is done purely to test the use of vSemaphoreDelete(). */
\r
209 xMutexToDelete = xSemaphoreCreateMutex();
\r
211 /* Start the scheduler itself. */
\r
212 vTaskStartScheduler();
\r
214 /* Should never get here unless there was not enough heap space to create
\r
215 the idle and other system tasks. */
\r
218 /*-----------------------------------------------------------*/
\r
220 static void prvCheckTask( void *pvParameters )
\r
222 portTickType xNextWakeTime;
\r
223 const portTickType xCycleFrequency = 2500 / portTICK_RATE_MS;
\r
225 /* Just to remove compiler warning. */
\r
226 ( void ) pvParameters;
\r
228 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
229 xNextWakeTime = xTaskGetTickCount();
\r
233 /* Place this task in the blocked state until it is time to run again. */
\r
234 vTaskDelayUntil( &xNextWakeTime, xCycleFrequency );
\r
236 /* Check the standard demo tasks are running without error. */
\r
237 if( xAreTimerDemoTasksStillRunning( xCycleFrequency ) != pdTRUE )
\r
239 pcStatusMessage = "Error: TimerDemo";
\r
241 else if( xAreIntegerMathsTaskStillRunning() != pdTRUE )
\r
243 pcStatusMessage = "Error: IntMath";
\r
245 else if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
247 pcStatusMessage = "Error: GenQueue";
\r
249 else if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
251 pcStatusMessage = "Error: QueuePeek";
\r
253 else if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
255 pcStatusMessage = "Error: BlockQueue";
\r
257 else if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
259 pcStatusMessage = "Error: SemTest";
\r
261 else if( xArePollingQueuesStillRunning() != pdTRUE )
\r
263 pcStatusMessage = "Error: PollQueue";
\r
265 else if( xAreMathsTaskStillRunning() != pdPASS )
\r
267 pcStatusMessage = "Error: Flop";
\r
269 else if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
271 pcStatusMessage = "Error: RecMutex";
\r
273 else if( xAreCountingSemaphoreTasksStillRunning() != pdTRUE )
\r
275 pcStatusMessage = "Error: CountSem";
\r
277 else if( xIsCreateTaskStillRunning() != pdTRUE )
\r
279 pcStatusMessage = "Error: Death";
\r
281 else if( xAreDynamicPriorityTasksStillRunning() != pdPASS )
\r
283 pcStatusMessage = "Error: Dynamic\r\n";
\r
285 else if( xAreQueueSetTasksStillRunning() != pdPASS )
\r
287 pcStatusMessage = "Error: Queue set\r\n";
\r
289 else if( xIsQueueOverwriteTaskStillRunning() != pdPASS )
\r
291 pcStatusMessage = "Error: Queue overwrite\r\n";
\r
294 /* This is the only task that uses stdout so its ok to call printf()
\r
296 printf( "%s - %d\r\n", pcStatusMessage, xTaskGetTickCount() );
\r
299 /*-----------------------------------------------------------*/
\r
301 static void prvTestTask( void *pvParameters )
\r
303 const unsigned long ulMSToSleep = 5;
\r
305 /* Just to remove compiler warnings. */
\r
306 ( void ) pvParameters;
\r
308 /* This task is just used to test the eTaskStateGet() function. It
\r
309 does not have anything to do. */
\r
312 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
313 tasks waiting to be terminated by the idle task. */
\r
314 Sleep( ulMSToSleep );
\r
317 /*-----------------------------------------------------------*/
\r
319 /* Called from vApplicationIdleHook(), which is defined in main.c. */
\r
320 void vFullDemoIdleFunction( void )
\r
322 const unsigned long ulMSToSleep = 15;
\r
323 const unsigned char ucConstQueueNumber = 0xaaU;
\r
326 /* These three functions are only meant for use by trace code, and not for
\r
327 direct use from application code, hence their prototypes are not in queue.h. */
\r
328 extern void vQueueSetQueueNumber( xQueueHandle pxQueue, unsigned char ucQueueNumber );
\r
329 extern unsigned char ucQueueGetQueueNumber( xQueueHandle pxQueue );
\r
330 extern unsigned char ucQueueGetQueueType( xQueueHandle pxQueue );
\r
331 extern void vTaskSetTaskNumber( xTaskHandle xTask, unsigned portBASE_TYPE uxHandle );
\r
332 extern unsigned portBASE_TYPE uxTaskGetTaskNumber( xTaskHandle xTask );
\r
334 /* Sleep to reduce CPU load, but don't sleep indefinitely in case there are
\r
335 tasks waiting to be terminated by the idle task. */
\r
336 Sleep( ulMSToSleep );
\r
338 /* Demonstrate a few utility functions that are not demonstrated by any of
\r
339 the standard demo tasks. */
\r
340 prvDemonstrateTaskStateAndHandleGetFunctions();
\r
342 /* If xMutexToDelete has not already been deleted, then delete it now.
\r
343 This is done purely to demonstrate the use of, and test, the
\r
344 vSemaphoreDelete() macro. Care must be taken not to delete a semaphore
\r
345 that has tasks blocked on it. */
\r
346 if( xMutexToDelete != NULL )
\r
348 /* Before deleting the semaphore, test the function used to set its
\r
349 number. This would normally only be done from trace software, rather
\r
350 than application code. */
\r
351 vQueueSetQueueNumber( xMutexToDelete, ucConstQueueNumber );
\r
353 /* Before deleting the semaphore, test the functions used to get its
\r
354 type and number. Again, these would normally only be done from trace
\r
355 software, rather than application code. */
\r
356 configASSERT( ucQueueGetQueueNumber( xMutexToDelete ) == ucConstQueueNumber );
\r
357 configASSERT( ucQueueGetQueueType( xMutexToDelete ) == queueQUEUE_TYPE_MUTEX );
\r
358 vSemaphoreDelete( xMutexToDelete );
\r
359 xMutexToDelete = NULL;
\r
362 /* Exercise heap_4 a bit. The malloc failed hook will trap failed
\r
363 allocations so there is no need to test here. */
\r
364 pvAllocated = pvPortMalloc( ( rand() % 100 ) + 1 );
\r
365 vPortFree( pvAllocated );
\r
367 /*-----------------------------------------------------------*/
\r
369 /* Called by vApplicationTickHook(), which is defined in main.c. */
\r
370 void vFullDemoTickHookFunction( void )
\r
372 /* Call the periodic timer test, which tests the timer API functions that
\r
373 can be called from an ISR. */
\r
374 vTimerPeriodicISRTests();
\r
376 /* Call the periodic queue overwrite from ISR demo. */
\r
377 vQueueOverwritePeriodicISRDemo();
\r
379 /* Write to a queue that is in use as part of the queue set demo to
\r
380 demonstrate using queue sets from an ISR. */
\r
381 vQueueSetAccessQueueSetFromISR();
\r
383 /*-----------------------------------------------------------*/
\r
385 static void prvDemonstrateTaskStateAndHandleGetFunctions( void )
\r
387 xTaskHandle xIdleTaskHandle, xTimerTaskHandle;
\r
388 const unsigned char ucConstTaskNumber = 0x55U;
\r
389 signed char *pcTaskName;
\r
390 static portBASE_TYPE xPerformedOneShotTests = pdFALSE;
\r
391 xTaskHandle xTestTask;
\r
393 /* Demonstrate the use of the xTimerGetTimerDaemonTaskHandle() and
\r
394 xTaskGetIdleTaskHandle() functions. Also try using the function that sets
\r
395 the task number. */
\r
396 xIdleTaskHandle = xTaskGetIdleTaskHandle();
\r
397 xTimerTaskHandle = xTimerGetTimerDaemonTaskHandle();
\r
398 vTaskSetTaskNumber( xIdleTaskHandle, ( unsigned long ) ucConstTaskNumber );
\r
399 configASSERT( uxTaskGetTaskNumber( xIdleTaskHandle ) == ucConstTaskNumber );
\r
401 /* This is the idle hook, so the current task handle should equal the
\r
402 returned idle task handle. */
\r
403 if( xTaskGetCurrentTaskHandle() != xIdleTaskHandle )
\r
405 pcStatusMessage = "Error: Returned idle task handle was incorrect";
\r
408 /* Check the timer task handle was returned correctly. */
\r
409 pcTaskName = pcTaskGetTaskName( xTimerTaskHandle );
\r
410 if( strcmp( pcTaskName, "Tmr Svc" ) != 0 )
\r
412 pcStatusMessage = "Error: Returned timer task handle was incorrect";
\r
415 /* This task is running, make sure it's state is returned as running. */
\r
416 if( eTaskStateGet( xIdleTaskHandle ) != eRunning )
\r
418 pcStatusMessage = "Error: Returned idle task state was incorrect";
\r
421 /* If this task is running, then the timer task must be blocked. */
\r
422 if( eTaskStateGet( xTimerTaskHandle ) != eBlocked )
\r
424 pcStatusMessage = "Error: Returned timer task state was incorrect";
\r
427 /* Other tests that should only be performed once follow. The test task
\r
428 is not created on each iteration because to do so would cause the death
\r
429 task to report an error (too many tasks running). */
\r
430 if( xPerformedOneShotTests == pdFALSE )
\r
432 /* Don't run this part of the test again. */
\r
433 xPerformedOneShotTests = pdTRUE;
\r
435 /* Create a test task to use to test other eTaskStateGet() return values. */
\r
436 if( xTaskCreate( prvTestTask, "Test", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY, &xTestTask ) == pdPASS )
\r
438 /* If this task is running, the test task must be in the ready state. */
\r
439 if( eTaskStateGet( xTestTask ) != eReady )
\r
441 pcStatusMessage = "Error: Returned test task state was incorrect 1";
\r
444 /* Now suspend the test task and check its state is reported correctly. */
\r
445 vTaskSuspend( xTestTask );
\r
446 if( eTaskStateGet( xTestTask ) != eSuspended )
\r
448 pcStatusMessage = "Error: Returned test task state was incorrect 2";
\r
451 /* Now delete the task and check its state is reported correctly. */
\r
452 vTaskDelete( xTestTask );
\r
453 if( eTaskStateGet( xTestTask ) != eDeleted )
\r
455 pcStatusMessage = "Error: Returned test task state was incorrect 3";
\r
460 /*-----------------------------------------------------------*/
\r
462 static void prvDemoQueueSpaceFunctions( void *pvParameters )
\r
464 xQueueHandle xQueue = NULL;
\r
465 const unsigned portBASE_TYPE uxQueueLength = 10;
\r
466 unsigned portBASE_TYPE uxReturn, x;
\r
468 /* Remove compiler warnings. */
\r
469 ( void ) pvParameters;
\r
471 /* Create the queue that will be used. Nothing is actually going to be
\r
472 sent or received so the queue item size is set to 0. */
\r
473 xQueue = xQueueCreate( uxQueueLength, 0 );
\r
474 configASSERT( xQueue );
\r
478 for( x = 0; x < uxQueueLength; x++ )
\r
480 /* Ask how many messages are available... */
\r
481 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
483 /* Check the number of messages being reported as being available
\r
484 is as expected, and force an assert if not. */
\r
485 if( uxReturn != x )
\r
487 /* xQueue cannot be NULL so this is deliberately causing an
\r
488 assert to be triggered as there is an error. */
\r
489 configASSERT( xQueue == NULL );
\r
492 /* Ask how many spaces remain in the queue... */
\r
493 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
495 /* Check the number of spaces being reported as being available
\r
496 is as expected, and force an assert if not. */
\r
497 if( uxReturn != ( uxQueueLength - x ) )
\r
499 /* xQueue cannot be NULL so this is deliberately causing an
\r
500 assert to be triggered as there is an error. */
\r
501 configASSERT( xQueue == NULL );
\r
504 /* Fill one more space in the queue. */
\r
505 xQueueSendToBack( xQueue, NULL, 0 );
\r
508 /* Perform the same check while the queue is full. */
\r
509 uxReturn = uxQueueMessagesWaiting( xQueue );
\r
510 if( uxReturn != uxQueueLength )
\r
512 configASSERT( xQueue == NULL );
\r
515 uxReturn = uxQueueSpacesAvailable( xQueue );
\r
517 if( uxReturn != 0 )
\r
519 configASSERT( xQueue == NULL );
\r
522 /* The queue is full, start again. */
\r
523 xQueueReset( xQueue );
\r