2 FreeRTOS V8.0.0:rc1 - 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 * main-blinky.c is included when the "Blinky" build configuration is used.
\r
68 * main-full.c is included when the "Full" build configuration is used.
\r
70 * main-blinky.c (this file) defines a very simple demo that creates two tasks,
\r
71 * one queue, and one timer. It also demonstrates how Cortex-M3 interrupts can
\r
72 * interact with FreeRTOS tasks/timers.
\r
74 * This simple demo project runs on the SK-FM3-100PMC evaluation board, which
\r
75 * is populated with an MB9B500 microcontroller.
\r
77 * The idle hook function:
\r
78 * The idle hook function demonstrates how to query the amount of FreeRTOS heap
\r
79 * space that is remaining (see vApplicationIdleHook() defined in this file).
\r
81 * The main() Function:
\r
82 * main() creates one software timer, one queue, and two tasks. It then starts
\r
85 * The Queue Send Task:
\r
86 * The queue send task is implemented by the prvQueueSendTask() function in
\r
87 * this file. prvQueueSendTask() sits in a loop that causes it to repeatedly
\r
88 * block for 200 milliseconds, before sending the value 100 to the queue that
\r
89 * was created within main(). Once the value is sent, the task loops back
\r
90 * around to block for another 200 milliseconds.
\r
92 * The Queue Receive Task:
\r
93 * The queue receive task is implemented by the prvQueueReceiveTask() function
\r
94 * in this file. prvQueueReceiveTask() sits in a loop that causes it to
\r
95 * repeatedly attempt to read data from the queue that was created within
\r
96 * main(). When data is received, the task checks the value of the data, and
\r
97 * if the value equals the expected 100, toggles an LED on the 7 segment
\r
98 * display. The 'block time' parameter passed to the queue receive function
\r
99 * specifies that the task should be held in the Blocked state indefinitely to
\r
100 * wait for data to be available on the queue. The queue receive task will only
\r
101 * leave the Blocked state when the queue send task writes to the queue. As the
\r
102 * queue send task writes to the queue every 200 milliseconds, the queue receive
\r
103 * task leaves the Blocked state every 200 milliseconds, and therefore toggles
\r
104 * the LED every 200 milliseconds.
\r
106 * The LED Software Timer and the Button Interrupt:
\r
107 * The user button SW2 is configured to generate an interrupt each time it is
\r
108 * pressed. The interrupt service routine switches an LED in the 7 segment
\r
109 * display on, and resets the LED software timer. The LED timer has a 5000
\r
110 * millisecond (5 second) period, and uses a callback function that is defined
\r
111 * to just turn the LED off again. Therefore, pressing the user button will
\r
112 * turn the LED on, and the LED will remain on until a full five seconds pass
\r
113 * without the button being pressed.
\r
116 /* Kernel includes. */
\r
117 #include "FreeRTOS.h"
\r
120 #include "timers.h"
\r
122 /* Fujitsu drivers/libraries. */
\r
123 #include "mb9bf506n.h"
\r
124 #include "system_mb9bf50x.h"
\r
126 /* Priorities at which the tasks are created. */
\r
127 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
128 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
130 /* The rate at which data is sent to the queue, specified in milliseconds, and
\r
131 converted to ticks using the portTICK_PERIOD_MS constant. */
\r
132 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_PERIOD_MS )
\r
134 /* The number of items the queue can hold. This is 1 as the receive task
\r
135 will remove items as they are added, meaning the send task should always find
\r
136 the queue empty. */
\r
137 #define mainQUEUE_LENGTH ( 1 )
\r
139 /* The LED toggle by the queue receive task. */
\r
140 #define mainTASK_CONTROLLED_LED 0x8000UL
\r
142 /* The LED turned on by the button interrupt, and turned off by the LED timer. */
\r
143 #define mainTIMER_CONTROLLED_LED 0x8000UL
\r
145 /*-----------------------------------------------------------*/
\r
148 * Setup the NVIC, LED outputs, and button inputs.
\r
150 static void prvSetupHardware( void );
\r
153 * The tasks as described in the comments at the top of this file.
\r
155 static void prvQueueReceiveTask( void *pvParameters );
\r
156 static void prvQueueSendTask( void *pvParameters );
\r
159 * The LED timer callback function. This does nothing but switch off the
\r
160 * LED defined by the mainTIMER_CONTROLLED_LED constant.
\r
162 static void vLEDTimerCallback( TimerHandle_t xTimer );
\r
164 /*-----------------------------------------------------------*/
\r
166 /* The queue used by both tasks. */
\r
167 static QueueHandle_t xQueue = NULL;
\r
169 /* The LED software timer. This uses vLEDTimerCallback() as its callback
\r
171 static TimerHandle_t xLEDTimer = NULL;
\r
173 /*-----------------------------------------------------------*/
\r
177 /* Configure the NVIC, LED outputs and button inputs. */
\r
178 prvSetupHardware();
\r
180 /* Create the queue. */
\r
181 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
\r
183 if( xQueue != NULL )
\r
185 /* Start the two tasks as described in the comments at the top of this
\r
187 xTaskCreate( prvQueueReceiveTask, "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );
\r
188 xTaskCreate( prvQueueSendTask, "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );
\r
190 /* Create the software timer that is responsible for turning off the LED
\r
191 if the button is not pushed within 5000ms, as described at the top of
\r
193 xLEDTimer = xTimerCreate( "LEDTimer", /* A text name, purely to help debugging. */
\r
194 ( 5000 / portTICK_PERIOD_MS ),/* The timer period, in this case 5000ms (5s). */
\r
195 pdFALSE, /* This is a one shot timer, so xAutoReload is set to pdFALSE. */
\r
196 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
197 vLEDTimerCallback /* The callback function that switches the LED off. */
\r
200 /* Start the tasks and timer running. */
\r
201 vTaskStartScheduler();
\r
204 /* If all is well, the scheduler will now be running, and the following line
\r
205 will never be reached. If the following line does execute, then there was
\r
206 insufficient FreeRTOS heap memory available for the idle and/or timer tasks
\r
207 to be created. See the memory management section on the FreeRTOS web site
\r
208 for more details. */
\r
211 /*-----------------------------------------------------------*/
\r
213 static void vLEDTimerCallback( TimerHandle_t xTimer )
\r
215 /* The timer has expired - so no button pushes have occurred in the last
\r
216 five seconds - turn the LED off. NOTE - accessing the LED port should use
\r
217 a critical section because it is accessed from multiple tasks, and the
\r
218 button interrupt - in this trivial case, for simplicity, the critical
\r
219 section is omitted. */
\r
220 FM3_GPIO->PDOR1 |= mainTIMER_CONTROLLED_LED;
\r
222 /*-----------------------------------------------------------*/
\r
224 /* The ISR executed when the user button is pushed. */
\r
225 void INT0_7_Handler( void )
\r
227 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
229 /* The button was pushed, so ensure the LED is on before resetting the
\r
230 LED timer. The LED timer will turn the LED off if the button is not
\r
231 pushed within 5000ms. */
\r
232 FM3_GPIO->PDOR1 &= ~mainTIMER_CONTROLLED_LED;
\r
234 /* This interrupt safe FreeRTOS function can be called from this interrupt
\r
235 because the interrupt priority is below the
\r
236 configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */
\r
237 xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );
\r
239 /* Clear the interrupt before leaving. This just clears all the interrupts
\r
240 for simplicity, as only one is actually used in this simple demo anyway. */
\r
241 FM3_EXTI->EICL = 0x0000;
\r
243 /* If calling xTimerResetFromISR() caused a task (in this case the timer
\r
244 service/daemon task) to unblock, and the unblocked task has a priority
\r
245 higher than or equal to the task that was interrupted, then
\r
246 xHigherPriorityTaskWoken will now be set to pdTRUE, and calling
\r
247 portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */
\r
248 portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );
\r
250 /*-----------------------------------------------------------*/
\r
252 static void prvQueueSendTask( void *pvParameters )
\r
254 TickType_t xNextWakeTime;
\r
255 const unsigned long ulValueToSend = 100UL;
\r
257 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
258 xNextWakeTime = xTaskGetTickCount();
\r
262 /* Place this task in the blocked state until it is time to run again.
\r
263 The block time is specified in ticks, the constant used converts ticks
\r
264 to ms. While in the Blocked state this task will not consume any CPU
\r
266 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );
\r
268 /* Send to the queue - causing the queue receive task to unblock and
\r
269 toggle an LED. 0 is used as the block time so the sending operation
\r
270 will not block - it shouldn't need to block as the queue should always
\r
271 be empty at this point in the code. */
\r
272 xQueueSend( xQueue, &ulValueToSend, 0 );
\r
275 /*-----------------------------------------------------------*/
\r
277 static void prvQueueReceiveTask( void *pvParameters )
\r
279 unsigned long ulReceivedValue;
\r
283 /* Wait until something arrives in the queue - this task will block
\r
284 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
\r
285 FreeRTOSConfig.h. */
\r
286 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
\r
288 /* To get here something must have been received from the queue, but
\r
289 is it the expected value? If it is, toggle the LED. */
\r
290 if( ulReceivedValue == 100UL )
\r
292 /* NOTE - accessing the LED port should use a critical section
\r
293 because it is accessed from multiple tasks, and the button interrupt
\r
294 - in this trivial case, for simplicity, the critical section is
\r
296 if( ( FM3_GPIO->PDOR3 & mainTASK_CONTROLLED_LED ) != 0 )
\r
298 FM3_GPIO->PDOR3 &= ~mainTASK_CONTROLLED_LED;
\r
302 FM3_GPIO->PDOR3 |= mainTASK_CONTROLLED_LED;
\r
307 /*-----------------------------------------------------------*/
\r
309 static void prvSetupHardware( void )
\r
311 const unsigned short usButtonInputBit = 0x01U;
\r
312 const unsigned short usGPIOState = 0xFF00U;
\r
315 SystemCoreClockUpdate();
\r
317 /* Analog inputs are not used on the LED outputs. */
\r
318 FM3_GPIO->ADE = 0x00FF;
\r
320 /* LED seg1 to GPIO output (P18->P1F). */
\r
321 FM3_GPIO->DDR1 = 0xFF00;
\r
322 FM3_GPIO->PFR1 = 0x0000;
\r
324 /* LED seg2 to GPIO output (P30->P3F). */
\r
325 FM3_GPIO->DDR3 = 0xFF00;
\r
326 FM3_GPIO->PFR3 = 0x0000;
\r
328 /* Start with all LEDs off. */
\r
329 FM3_GPIO->PDOR3 = usGPIOState;
\r
330 FM3_GPIO->PDOR1 = usGPIOState;
\r
332 /* Set the switches to input (P18->P1F). */
\r
333 FM3_GPIO->DDR5 = 0x0000;
\r
334 FM3_GPIO->PFR5 = 0x0000;
\r
336 /* Assign the button input as GPIO. */
\r
337 FM3_GPIO->PFR1 |= usButtonInputBit;
\r
339 /* Button interrupt on falling edge. */
\r
340 FM3_EXTI->ELVR = 0x0003;
\r
342 /* Clear all external interrupts. */
\r
343 FM3_EXTI->EICL = 0x0000;
\r
345 /* Enable the button interrupt. */
\r
346 FM3_EXTI->ENIR |= usButtonInputBit;
\r
348 /* Setup the GPIO and the NVIC for the switch used in this simple demo. */
\r
349 NVIC_SetPriority( EXINT0_7_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
350 NVIC_EnableIRQ( EXINT0_7_IRQn );
\r
352 /*-----------------------------------------------------------*/
\r
354 void vApplicationMallocFailedHook( void )
\r
356 /* Called if a call to pvPortMalloc() fails because there is insufficient
\r
357 free memory available in the FreeRTOS heap. pvPortMalloc() is called
\r
358 internally by FreeRTOS API functions that create tasks, queues, software
\r
359 timers, and semaphores. The size of the FreeRTOS heap is set by the
\r
360 configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */
\r
363 /*-----------------------------------------------------------*/
\r
365 void vApplicationStackOverflowHook( TaskHandle_t pxTask, char *pcTaskName )
\r
367 ( void ) pcTaskName;
\r
370 /* Run time stack overflow checking is performed if
\r
371 configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
372 function is called if a stack overflow is detected. */
\r
375 /*-----------------------------------------------------------*/
\r
377 void vApplicationTickHook( void )
\r
379 /* A tick hook is used by the "Full" build configuration. The Full and
\r
380 blinky build configurations share a FreeRTOSConfig.h header file, so this
\r
381 simple build configuration also has to define a tick hook - even though it
\r
382 does not actually use it for anything. */
\r
384 /*-----------------------------------------------------------*/
\r
386 void vApplicationIdleHook( void )
\r
388 volatile size_t xFreeHeapSpace;
\r
390 /* This function is called on each cycle of the idle task. In this case it
\r
391 does nothing useful, other than report the amount of FreeRTOS heap that
\r
392 remains unallocated. */
\r
393 xFreeHeapSpace = xPortGetFreeHeapSize();
\r
395 if( xFreeHeapSpace > 100 )
\r
397 /* By now, the kernel has allocated everything it is going to, so
\r
398 if there is a lot of heap remaining unallocated then
\r
399 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be
\r
400 reduced accordingly. */
\r
403 /*-----------------------------------------------------------*/
\r