2 FreeRTOS V6.1.1 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
4 ***************************************************************************
\r
8 * + New to FreeRTOS, *
\r
9 * + Wanting to learn FreeRTOS or multitasking in general quickly *
\r
10 * + Looking for basic training, *
\r
11 * + Wanting to improve your FreeRTOS skills and productivity *
\r
13 * then take a look at the FreeRTOS books - available as PDF or paperback *
\r
15 * "Using the FreeRTOS Real Time Kernel - a Practical Guide" *
\r
16 * http://www.FreeRTOS.org/Documentation *
\r
18 * A pdf reference manual is also available. Both are usually delivered *
\r
19 * to your inbox within 20 minutes to two hours when purchased between 8am *
\r
20 * and 8pm GMT (although please allow up to 24 hours in case of *
\r
21 * exceptional circumstances). Thank you for your support! *
\r
23 ***************************************************************************
\r
25 This file is part of the FreeRTOS distribution.
\r
27 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
28 the terms of the GNU General Public License (version 2) as published by the
\r
29 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
30 ***NOTE*** The exception to the GPL is included to allow you to distribute
\r
31 a combined work that includes FreeRTOS without being obliged to provide the
\r
32 source code for proprietary components outside of the FreeRTOS kernel.
\r
33 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT
\r
34 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
\r
35 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
36 more details. You should have received a copy of the GNU General Public
\r
37 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
38 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
39 by writing to Richard Barry, contact details for whom are available on the
\r
44 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
47 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
50 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
51 licensing and training services.
\r
55 * This simple demo project runs on the STM32 Discovery board, which is
\r
56 * populated with an STM32F100RB Cortex-M3 microcontroller. The discovery board
\r
57 * makes an ideal low cost evaluation platform, but the 8K of RAM provided on the
\r
58 * STM32F100RB does not allow the simple application to demonstrate all of all the
\r
59 * FreeRTOS kernel features. Therefore, this simple demo only actively
\r
60 * demonstrates task, queue, timer and interrupt functionality. In addition, the
\r
61 * demo is configured to include malloc failure, idle and stack overflow hook
\r
64 * The idle hook function:
\r
65 * The idle hook function queries the amount of FreeRTOS heap space that is
\r
66 * remaining (see vApplicationIdleHook() defined in this file). The demo
\r
67 * application is configured use 7K or the available 8K of RAM as the FreeRTOS heap.
\r
68 * Memory is only allocated from this heap during initialisation, and this demo
\r
69 * only actually uses 1.6K bytes of the configured 7K available - leaving 5.4K
\r
70 * bytes of heap space unallocated.
\r
72 * The main() Function:
\r
73 * main() creates one software timer, one queue, and two tasks. It then starts the
\r
76 * The Queue Send Task:
\r
77 * The queue send task is implemented by the prvQueueSendTask() function in this
\r
78 * file. prvQueueSendTask() sits in a loop that causes it to repeatedly block for
\r
79 * 200 milliseconds, before sending the value 100 to the queue that was created
\r
80 * within main(). Once the value is sent, the task loops back around to block for
\r
81 * another 200 milliseconds.
\r
83 * The Queue Receive Task:
\r
84 * The queue receive task is implemented by the prvQueueReceiveTask() function
\r
85 * in this file. prvQueueReceiveTask() sits in a loop that causes repeatedly
\r
86 * attempt to read data from the queue that was created within main(). When data
\r
87 * is received, the task checks the value of the data, and if the value equals
\r
88 * the expected 100, toggles the green LED. The 'block time' parameter passed to
\r
89 * the queue receive function specifies that the task should be held in the Blocked
\r
90 * state indefinitely to wait for data to be available on the queue. The queue
\r
91 * receive task will only leave the Blocked state when the queue send task writes
\r
92 * to the queue. As the queue send task writes to the queue every 200
\r
93 * milliseconds, the queue receive task leaves the Blocked state every 200
\r
94 * milliseconds, and therefore toggles the green LED every 200 milliseconds.
\r
96 * The LED Software Timer and the Button Interrupt:
\r
97 * The user button B1 is configured to generate an interrupt each time it is
\r
98 * pressed. The interrupt service routine switches the red LED on, and resets the
\r
99 * LED software timer. The LED timer has a 5000 millisecond (5 second) period, and
\r
100 * uses a callback function that is defined to just turn the red LED off.
\r
101 * Therefore, pressing the user button will turn the red LED on, and the LED will
\r
102 * remain on until a full five seconds pass without the button being pressed.
\r
105 /* Kernel includes. */
\r
106 #include "FreeRTOS.h"
\r
109 #include "timers.h"
\r
111 /* Microsemi drivers/libraries includes. */
\r
112 #include "mss_gpio.h"
\r
113 #include "mss_watchdog.h"
\r
115 /* Common demo includes. */
\r
116 #include "partest.h"
\r
118 #include "BlockQ.h"
\r
120 #include "blocktim.h"
\r
121 #include "semtest.h"
\r
122 #include "GenQTest.h"
\r
124 #include "recmutex.h"
\r
125 #include "TimerDemo.h"
\r
127 /* Priorities at which the tasks are created. */
\r
128 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
129 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
131 /* The rate at which data is sent to the queue, specified in milliseconds, and
\r
132 converted to ticks using the portTICK_RATE_MS constant. */
\r
133 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_RATE_MS )
\r
135 /* The number of items the queue can hold. This is 1 as the receive task
\r
136 will remove items as they are added, meaning the send task should always find
\r
137 the queue empty. */
\r
138 #define mainQUEUE_LENGTH ( 1 )
\r
140 #define mainCHECK_LED 0x07UL
\r
141 #define mainTIMER_CONTROLLED_LED 0x06UL
\r
142 #define mainTASK_CONTROLLED_LED 0x05UL
\r
144 #define mainTIMER_TEST_PERIOD ( 50 )
\r
146 #define mainCHECK_TASK_PRIORITY ( configMAX_PRIORITIES - 1 )
\r
147 #define mainQUEUE_POLL_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
148 #define mainSEM_TEST_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
149 #define mainBLOCK_Q_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
150 #define mainCREATOR_TASK_PRIORITY ( tskIDLE_PRIORITY + 3 )
\r
151 #define mainFLASH_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
152 #define mainuIP_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
153 #define mainINTEGER_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
154 #define mainGEN_QUEUE_TASK_PRIORITY ( tskIDLE_PRIORITY )
\r
156 /*-----------------------------------------------------------*/
\r
159 * Setup the NVIC, LED outputs, and button inputs.
\r
161 static void prvSetupHardware( void );
\r
164 * The tasks as described in the comments at the top of this file.
\r
166 static void prvQueueReceiveTask( void *pvParameters );
\r
167 static void prvQueueSendTask( void *pvParameters );
\r
170 * The LED timer callback function. This does nothing but switch the red LED
\r
173 static void vLEDTimerCallback( xTimerHandle xTimer );
\r
175 static void vCheckTimerCallback( xTimerHandle xTimer );
\r
178 * This is not a 'standard' partest function, so the prototype is not in
\r
181 void vParTestSetLEDFromISR( unsigned portBASE_TYPE uxLED, signed portBASE_TYPE xValue );
\r
183 /*-----------------------------------------------------------*/
\r
185 /* The queue used by both tasks. */
\r
186 static xQueueHandle xQueue = NULL;
\r
188 /* The LED software timer. This uses vLEDTimerCallback() as its callback
\r
190 static xTimerHandle xLEDTimer = NULL;
\r
192 static xTimerHandle xCheckTimer = NULL;
\r
194 /* The status message that is displayed at the bottom of the "task stats" web
\r
195 page, which is served by the uIP task. This will report any errors picked up
\r
196 by the reg test task. */
\r
197 static const char *pcStatusMessage = NULL;
\r
200 /*-----------------------------------------------------------*/
\r
204 /* Configure the NVIC, LED outputs and button inputs. */
\r
205 prvSetupHardware();
\r
207 /* Create the queue. */
\r
208 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
\r
210 if( xQueue != NULL )
\r
212 /* Start the two tasks as described in the comments at the top of this
\r
214 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );
\r
215 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );
\r
217 /* Create the software timer that is responsible for turning off the LED
\r
218 if the button is not pushed within 5000ms, as described at the top of
\r
220 xLEDTimer = xTimerCreate( ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */
\r
221 ( 5000 / portTICK_RATE_MS ), /* The timer period, in this case 5000ms (5s). */
\r
222 pdFALSE, /* This is a one shot timer, so xAutoReload is set to pdFALSE. */
\r
223 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
224 vLEDTimerCallback /* The callback function that switches the LED off. */
\r
227 xCheckTimer = xTimerCreate( ( const signed char * ) "CheckTimer", /* A text name, purely to help debugging. */
\r
228 ( 3000 / portTICK_RATE_MS ), /* The timer period, in this case 3000ms (3s). */
\r
229 pdTRUE, /* This is an auto-reload timer, so xAutoReload is set to pdTRUE. */
\r
230 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
231 vCheckTimerCallback /* The callback function that inspects the status of all the other tasks. */
\r
234 vStartBlockingQueueTasks( mainBLOCK_Q_PRIORITY );
\r
235 vCreateBlockTimeTasks();
\r
236 vStartSemaphoreTasks( mainSEM_TEST_PRIORITY );
\r
237 vStartGenericQueueTasks( mainGEN_QUEUE_TASK_PRIORITY );
\r
238 vStartLEDFlashTasks( mainFLASH_TASK_PRIORITY );
\r
239 vStartQueuePeekTasks();
\r
240 vStartRecursiveMutexTasks();
\r
241 vStartTimerDemoTask( mainTIMER_TEST_PERIOD );
\r
243 /* Start the tasks and timer running. */
\r
244 vTaskStartScheduler();
\r
247 /* If all is well, the scheduler will now be running, and the following line
\r
248 will never be reached. If the following line does execute, then there was
\r
249 insufficient FreeRTOS heap memory available for the idle and/or timer tasks
\r
250 to be created. See the memory management section on the FreeRTOS web site
\r
251 for more details. */
\r
254 /*-----------------------------------------------------------*/
\r
256 static void vCheckTimerCallback( xTimerHandle xTimer )
\r
258 /* Check the standard demo tasks are running without error. */
\r
259 if( xAreGenericQueueTasksStillRunning() != pdTRUE )
\r
261 /* Increase the rate at which this task cycles, which will increase the
\r
262 rate at which mainCHECK_LED flashes to give visual feedback that an error
\r
264 pcStatusMessage = "Error: GenQueue";
\r
265 // xPrintf( pcStatusMessage );
\r
268 if( xAreQueuePeekTasksStillRunning() != pdTRUE )
\r
270 pcStatusMessage = "Error: QueuePeek\r\n";
\r
271 // xPrintf( pcStatusMessage );
\r
274 if( xAreBlockingQueuesStillRunning() != pdTRUE )
\r
276 pcStatusMessage = "Error: BlockQueue\r\n";
\r
277 // xPrintf( pcStatusMessage );
\r
280 if( xAreBlockTimeTestTasksStillRunning() != pdTRUE )
\r
282 pcStatusMessage = "Error: BlockTime\r\n";
\r
283 // xPrintf( pcStatusMessage );
\r
286 if( xAreSemaphoreTasksStillRunning() != pdTRUE )
\r
288 pcStatusMessage = "Error: SemTest\r\n";
\r
289 // xPrintf( pcStatusMessage );
\r
292 if( xIsCreateTaskStillRunning() != pdTRUE )
\r
294 pcStatusMessage = "Error: Death\r\n";
\r
295 // xPrintf( pcStatusMessage );
\r
298 if( xAreRecursiveMutexTasksStillRunning() != pdTRUE )
\r
300 pcStatusMessage = "Error: RecMutex\r\n";
\r
301 // xPrintf( pcStatusMessage );
\r
304 if( xAreTimerDemoTasksStillRunning( ( 3000 / portTICK_RATE_MS ) ) != pdTRUE )
\r
306 pcStatusMessage = "Error: TimerDemo";
\r
309 /* Toggle the check LED to give an indication of the system status. If
\r
310 the LED toggles every 5 seconds then everything is ok. A faster toggle
\r
311 indicates an error. */
\r
312 vParTestToggleLED( mainCHECK_LED );
\r
314 if( pcStatusMessage != NULL )
\r
316 /* The block time is set to zero as a timer callback must *never*
\r
317 attempt to block. */
\r
318 xTimerChangePeriod( xCheckTimer, ( 500 / portTICK_RATE_MS ), 0 );
\r
321 /*-----------------------------------------------------------*/
\r
323 static void vLEDTimerCallback( xTimerHandle xTimer )
\r
325 /* The timer has expired - so no button pushes have occurred in the last
\r
326 five seconds - turn the LED off. NOTE - accessing the LED port should use
\r
327 a critical section because it is accessed from multiple tasks, and the
\r
328 button interrupt - in this trivial case, for simplicity, the critical
\r
329 section is omitted. */
\r
330 vParTestSetLED( mainTIMER_CONTROLLED_LED, pdFALSE );
\r
332 /*-----------------------------------------------------------*/
\r
334 /* The ISR executed when the user button is pushed. */
\r
335 void GPIO8_IRQHandler( void )
\r
337 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
339 /* The button was pushed, so ensure the LED is on before resetting the
\r
340 LED timer. The LED timer will turn the LED off if the button is not
\r
341 pushed within 5000ms. */
\r
342 vParTestSetLEDFromISR( mainTIMER_CONTROLLED_LED, pdTRUE );
\r
344 /* This interrupt safe FreeRTOS function can be called from this interrupt
\r
345 because the interrupt priority is below the
\r
346 configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */
\r
347 xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );
\r
349 /* Clear the interrupt before leaving. */
\r
350 MSS_GPIO_clear_irq( MSS_GPIO_8 );
\r
352 /* If calling xTimerResetFromISR() caused a task (in this case the timer
\r
353 service/daemon task) to unblock, and the unblocked task has a priority
\r
354 higher than or equal to the task that was interrupted, then
\r
355 xHigherPriorityTaskWoken will now be set to pdTRUE, and calling
\r
356 portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */
\r
357 portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );
\r
359 /*-----------------------------------------------------------*/
\r
361 static void prvQueueSendTask( void *pvParameters )
\r
363 portTickType xNextWakeTime;
\r
364 const unsigned long ulValueToSend = 100UL;
\r
366 /* The suicide tasks must be created last as they need to know how many
\r
367 tasks were running prior to their creation in order to ascertain whether
\r
368 or not the correct/expected number of tasks are running at any given time. */
\r
369 vCreateSuicidalTasks( mainCREATOR_TASK_PRIORITY );
\r
371 xTimerStart( xCheckTimer, portMAX_DELAY );
\r
373 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
374 xNextWakeTime = xTaskGetTickCount();
\r
378 /* Place this task in the blocked state until it is time to run again.
\r
379 The block time is specified in ticks, the constant used converts ticks
\r
380 to ms. While in the Blocked state this task will not consume any CPU
\r
382 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );
\r
384 /* Send to the queue - causing the queue receive task to unblock and
\r
385 toggle an LED. 0 is used as the block time so the sending operation
\r
386 will not block - it shouldn't need to block as the queue should always
\r
387 be empty at this point in the code. */
\r
388 xQueueSend( xQueue, &ulValueToSend, 0 );
\r
391 /*-----------------------------------------------------------*/
\r
393 static void prvQueueReceiveTask( void *pvParameters )
\r
395 unsigned long ulReceivedValue;
\r
399 /* Wait until something arrives in the queue - this task will block
\r
400 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
\r
401 FreeRTOSConfig.h. */
\r
402 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
\r
404 /* To get here something must have been received from the queue, but
\r
405 is it the expected value? If it is, toggle the green LED. */
\r
406 if( ulReceivedValue == 100UL )
\r
408 /* NOTE - accessing the LED port should use a critical section
\r
409 because it is accessed from multiple tasks, and the button interrupt
\r
410 - in this trivial case, for simplicity, the critical section is
\r
412 vParTestToggleLED( mainTASK_CONTROLLED_LED );
\r
416 /*-----------------------------------------------------------*/
\r
418 static void prvSetupHardware( void )
\r
420 /* Disable the Watch Dog Timer */
\r
423 /* Configure the GPIO for the LEDs. */
\r
424 vParTestInitialise();
\r
426 /* Setup the GPIO and the NVIC for the switch used in this simple demo. */
\r
427 NVIC_SetPriority( GPIO8_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
428 NVIC_EnableIRQ( GPIO8_IRQn );
\r
429 MSS_GPIO_config( MSS_GPIO_8, MSS_GPIO_INPUT_MODE | MSS_GPIO_IRQ_EDGE_NEGATIVE );
\r
430 MSS_GPIO_enable_irq( MSS_GPIO_8 );
\r
432 /*-----------------------------------------------------------*/
\r
434 void vApplicationMallocFailedHook( void )
\r
436 /* Called if a call to pvPortMalloc() fails because there is insufficient
\r
437 free memory available in the FreeRTOS heap. pvPortMalloc() is called
\r
438 internally by FreeRTOS API functions that create tasks, queues, software
\r
439 timers, and semaphores. The size of the FreeRTOS heap is set by the
\r
440 configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */
\r
443 /*-----------------------------------------------------------*/
\r
445 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName )
\r
447 ( void ) pcTaskName;
\r
450 /* Run time stack overflow checking is performed if
\r
451 configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
452 function is called if a stack overflow is detected. */
\r
453 taskDISABLE_INTERRUPTS();
\r
456 /*-----------------------------------------------------------*/
\r
458 void vApplicationIdleHook( void )
\r
460 volatile size_t xFreeStackSpace;
\r
462 /* This function is called on each cycle of the idle task. In this case it
\r
463 does nothing useful, other than report the amout of FreeRTOS heap that
\r
464 remains unallocated. */
\r
465 xFreeStackSpace = xPortGetFreeHeapSize();
\r
467 if( xFreeStackSpace > 100 )
\r
469 /* By now, the kernel has allocated everything it is going to, so
\r
470 if there is a lot of heap remaining unallocated then
\r
471 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be
\r
472 reduced accordingly. */
\r
475 /*-----------------------------------------------------------*/
\r
477 char *pcGetTaskStatusMessage( void )
\r
479 /* Not bothered about a critical section here although technically because of
\r
480 the task priorities the pointer could change it will be atomic if not near
\r
481 atomic and its not critical. */
\r
482 if( pcStatusMessage == NULL )
\r
484 return "All tasks running without error";
\r
488 return ( char * ) pcStatusMessage;
\r