2 FreeRTOS V7.5.2 - Copyright (C) 2013 Real Time Engineers Ltd.
\r
4 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
6 ***************************************************************************
\r
8 * FreeRTOS provides completely free yet professionally developed, *
\r
9 * robust, strictly quality controlled, supported, and cross *
\r
10 * platform software that has become a de facto standard. *
\r
12 * Help yourself get started quickly and support the FreeRTOS *
\r
13 * project by purchasing a FreeRTOS tutorial book, reference *
\r
14 * manual, or both from: http://www.FreeRTOS.org/Documentation *
\r
18 ***************************************************************************
\r
20 This file is part of the FreeRTOS distribution.
\r
22 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
23 the terms of the GNU General Public License (version 2) as published by the
\r
24 Free Software Foundation >>!AND MODIFIED BY!<< the FreeRTOS exception.
\r
26 >>! NOTE: The modification to the GPL is included to allow you to distribute
\r
27 >>! a combined work that includes FreeRTOS without being obliged to provide
\r
28 >>! the source code for proprietary components outside of the FreeRTOS
\r
31 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY
\r
32 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
33 FOR A PARTICULAR PURPOSE. Full license text is available from the following
\r
34 link: http://www.freertos.org/a00114.html
\r
38 ***************************************************************************
\r
40 * Having a problem? Start by reading the FAQ "My application does *
\r
41 * not run, what could be wrong?" *
\r
43 * http://www.FreeRTOS.org/FAQHelp.html *
\r
45 ***************************************************************************
\r
47 http://www.FreeRTOS.org - Documentation, books, training, latest versions,
\r
48 license and Real Time Engineers Ltd. contact details.
\r
50 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
51 including FreeRTOS+Trace - an indispensable productivity tool, a DOS
\r
52 compatible FAT file system, and our tiny thread aware UDP/IP stack.
\r
54 http://www.OpenRTOS.com - Real Time Engineers ltd license FreeRTOS to High
\r
55 Integrity Systems to sell under the OpenRTOS brand. Low cost OpenRTOS
\r
56 licenses offer ticketed support, indemnification and middleware.
\r
58 http://www.SafeRTOS.com - High Integrity Systems also provide a safety
\r
59 engineered and independently SIL3 certified version for use in safety and
\r
60 mission critical applications that require provable dependability.
\r
66 * main-blinky.c is included when the "Blinky" build configuration is used.
\r
67 * main-full.c is included when the "Full" build configuration is used.
\r
69 * main-blinky.c (this file) defines a very simple demo that creates two tasks,
\r
70 * one queue, and one timer. It also demonstrates how Cortex-M3 interrupts can
\r
71 * interact with FreeRTOS tasks/timers.
\r
73 * This simple demo project runs on the SK-FM3-100PMC evaluation board, which
\r
74 * is populated with an MB9B500 microcontroller.
\r
76 * The idle hook function:
\r
77 * The idle hook function demonstrates how to query the amount of FreeRTOS heap
\r
78 * space that is remaining (see vApplicationIdleHook() defined in this file).
\r
80 * The main() Function:
\r
81 * main() creates one software timer, one queue, and two tasks. It then starts
\r
84 * The Queue Send Task:
\r
85 * The queue send task is implemented by the prvQueueSendTask() function in
\r
86 * this file. prvQueueSendTask() sits in a loop that causes it to repeatedly
\r
87 * block for 200 milliseconds, before sending the value 100 to the queue that
\r
88 * was created within main(). Once the value is sent, the task loops back
\r
89 * around to block for another 200 milliseconds.
\r
91 * The Queue Receive Task:
\r
92 * The queue receive task is implemented by the prvQueueReceiveTask() function
\r
93 * in this file. prvQueueReceiveTask() sits in a loop that causes it to
\r
94 * repeatedly attempt to read data from the queue that was created within
\r
95 * main(). When data is received, the task checks the value of the data, and
\r
96 * if the value equals the expected 100, toggles an LED on the 7 segment
\r
97 * display. The 'block time' parameter passed to the queue receive function
\r
98 * specifies that the task should be held in the Blocked state indefinitely to
\r
99 * wait for data to be available on the queue. The queue receive task will only
\r
100 * leave the Blocked state when the queue send task writes to the queue. As the
\r
101 * queue send task writes to the queue every 200 milliseconds, the queue receive
\r
102 * task leaves the Blocked state every 200 milliseconds, and therefore toggles
\r
103 * the LED every 200 milliseconds.
\r
105 * The LED Software Timer and the Button Interrupt:
\r
106 * The user button SW2 is configured to generate an interrupt each time it is
\r
107 * pressed. The interrupt service routine switches an LED in the 7 segment
\r
108 * display on, and resets the LED software timer. The LED timer has a 5000
\r
109 * millisecond (5 second) period, and uses a callback function that is defined
\r
110 * to just turn the LED off again. Therefore, pressing the user button will
\r
111 * turn the LED on, and the LED will remain on until a full five seconds pass
\r
112 * without the button being pressed.
\r
115 /* Kernel includes. */
\r
116 #include "FreeRTOS.h"
\r
119 #include "timers.h"
\r
121 /* Fujitsu drivers/libraries. */
\r
122 #include "mb9bf506n.h"
\r
123 #include "system_mb9bf50x.h"
\r
125 /* Priorities at which the tasks are created. */
\r
126 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
127 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
129 /* The rate at which data is sent to the queue, specified in milliseconds, and
\r
130 converted to ticks using the portTICK_RATE_MS constant. */
\r
131 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_RATE_MS )
\r
133 /* The number of items the queue can hold. This is 1 as the receive task
\r
134 will remove items as they are added, meaning the send task should always find
\r
135 the queue empty. */
\r
136 #define mainQUEUE_LENGTH ( 1 )
\r
138 /* The LED toggle by the queue receive task. */
\r
139 #define mainTASK_CONTROLLED_LED 0x8000UL
\r
141 /* The LED turned on by the button interrupt, and turned off by the LED timer. */
\r
142 #define mainTIMER_CONTROLLED_LED 0x8000UL
\r
144 /*-----------------------------------------------------------*/
\r
147 * Setup the NVIC, LED outputs, and button inputs.
\r
149 static void prvSetupHardware( void );
\r
152 * The tasks as described in the comments at the top of this file.
\r
154 static void prvQueueReceiveTask( void *pvParameters );
\r
155 static void prvQueueSendTask( void *pvParameters );
\r
158 * The LED timer callback function. This does nothing but switch off the
\r
159 * LED defined by the mainTIMER_CONTROLLED_LED constant.
\r
161 static void vLEDTimerCallback( xTimerHandle xTimer );
\r
163 /*-----------------------------------------------------------*/
\r
165 /* The queue used by both tasks. */
\r
166 static xQueueHandle xQueue = NULL;
\r
168 /* The LED software timer. This uses vLEDTimerCallback() as its callback
\r
170 static xTimerHandle xLEDTimer = NULL;
\r
172 /*-----------------------------------------------------------*/
\r
176 /* Configure the NVIC, LED outputs and button inputs. */
\r
177 prvSetupHardware();
\r
179 /* Create the queue. */
\r
180 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
\r
182 if( xQueue != NULL )
\r
184 /* Start the two tasks as described in the comments at the top of this
\r
186 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );
\r
187 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );
\r
189 /* Create the software timer that is responsible for turning off the LED
\r
190 if the button is not pushed within 5000ms, as described at the top of
\r
192 xLEDTimer = xTimerCreate( ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */
\r
193 ( 5000 / portTICK_RATE_MS ), /* The timer period, in this case 5000ms (5s). */
\r
194 pdFALSE, /* This is a one shot timer, so xAutoReload is set to pdFALSE. */
\r
195 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
196 vLEDTimerCallback /* The callback function that switches the LED off. */
\r
199 /* Start the tasks and timer running. */
\r
200 vTaskStartScheduler();
\r
203 /* If all is well, the scheduler will now be running, and the following line
\r
204 will never be reached. If the following line does execute, then there was
\r
205 insufficient FreeRTOS heap memory available for the idle and/or timer tasks
\r
206 to be created. See the memory management section on the FreeRTOS web site
\r
207 for more details. */
\r
210 /*-----------------------------------------------------------*/
\r
212 static void vLEDTimerCallback( xTimerHandle xTimer )
\r
214 /* The timer has expired - so no button pushes have occurred in the last
\r
215 five seconds - turn the LED off. NOTE - accessing the LED port should use
\r
216 a critical section because it is accessed from multiple tasks, and the
\r
217 button interrupt - in this trivial case, for simplicity, the critical
\r
218 section is omitted. */
\r
219 FM3_GPIO->PDOR1 |= mainTIMER_CONTROLLED_LED;
\r
221 /*-----------------------------------------------------------*/
\r
223 /* The ISR executed when the user button is pushed. */
\r
224 void INT0_7_Handler( void )
\r
226 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
228 /* The button was pushed, so ensure the LED is on before resetting the
\r
229 LED timer. The LED timer will turn the LED off if the button is not
\r
230 pushed within 5000ms. */
\r
231 FM3_GPIO->PDOR1 &= ~mainTIMER_CONTROLLED_LED;
\r
233 /* This interrupt safe FreeRTOS function can be called from this interrupt
\r
234 because the interrupt priority is below the
\r
235 configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */
\r
236 xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );
\r
238 /* Clear the interrupt before leaving. This just clears all the interrupts
\r
239 for simplicity, as only one is actually used in this simple demo anyway. */
\r
240 FM3_EXTI->EICL = 0x0000;
\r
242 /* If calling xTimerResetFromISR() caused a task (in this case the timer
\r
243 service/daemon task) to unblock, and the unblocked task has a priority
\r
244 higher than or equal to the task that was interrupted, then
\r
245 xHigherPriorityTaskWoken will now be set to pdTRUE, and calling
\r
246 portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */
\r
247 portEND_SWITCHING_ISR( xHigherPriorityTaskWoken );
\r
249 /*-----------------------------------------------------------*/
\r
251 static void prvQueueSendTask( void *pvParameters )
\r
253 portTickType xNextWakeTime;
\r
254 const unsigned long ulValueToSend = 100UL;
\r
256 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
257 xNextWakeTime = xTaskGetTickCount();
\r
261 /* Place this task in the blocked state until it is time to run again.
\r
262 The block time is specified in ticks, the constant used converts ticks
\r
263 to ms. While in the Blocked state this task will not consume any CPU
\r
265 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );
\r
267 /* Send to the queue - causing the queue receive task to unblock and
\r
268 toggle an LED. 0 is used as the block time so the sending operation
\r
269 will not block - it shouldn't need to block as the queue should always
\r
270 be empty at this point in the code. */
\r
271 xQueueSend( xQueue, &ulValueToSend, 0 );
\r
274 /*-----------------------------------------------------------*/
\r
276 static void prvQueueReceiveTask( void *pvParameters )
\r
278 unsigned long ulReceivedValue;
\r
282 /* Wait until something arrives in the queue - this task will block
\r
283 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
\r
284 FreeRTOSConfig.h. */
\r
285 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
\r
287 /* To get here something must have been received from the queue, but
\r
288 is it the expected value? If it is, toggle the LED. */
\r
289 if( ulReceivedValue == 100UL )
\r
291 /* NOTE - accessing the LED port should use a critical section
\r
292 because it is accessed from multiple tasks, and the button interrupt
\r
293 - in this trivial case, for simplicity, the critical section is
\r
295 if( ( FM3_GPIO->PDOR3 & mainTASK_CONTROLLED_LED ) != 0 )
\r
297 FM3_GPIO->PDOR3 &= ~mainTASK_CONTROLLED_LED;
\r
301 FM3_GPIO->PDOR3 |= mainTASK_CONTROLLED_LED;
\r
306 /*-----------------------------------------------------------*/
\r
308 static void prvSetupHardware( void )
\r
310 const unsigned short usButtonInputBit = 0x01U;
\r
311 const unsigned short usGPIOState = 0xFF00U;
\r
314 SystemCoreClockUpdate();
\r
316 /* Analog inputs are not used on the LED outputs. */
\r
317 FM3_GPIO->ADE = 0x00FF;
\r
319 /* LED seg1 to GPIO output (P18->P1F). */
\r
320 FM3_GPIO->DDR1 = 0xFF00;
\r
321 FM3_GPIO->PFR1 = 0x0000;
\r
323 /* LED seg2 to GPIO output (P30->P3F). */
\r
324 FM3_GPIO->DDR3 = 0xFF00;
\r
325 FM3_GPIO->PFR3 = 0x0000;
\r
327 /* Start with all LEDs off. */
\r
328 FM3_GPIO->PDOR3 = usGPIOState;
\r
329 FM3_GPIO->PDOR1 = usGPIOState;
\r
331 /* Set the switches to input (P18->P1F). */
\r
332 FM3_GPIO->DDR5 = 0x0000;
\r
333 FM3_GPIO->PFR5 = 0x0000;
\r
335 /* Assign the button input as GPIO. */
\r
336 FM3_GPIO->PFR1 |= usButtonInputBit;
\r
338 /* Button interrupt on falling edge. */
\r
339 FM3_EXTI->ELVR = 0x0003;
\r
341 /* Clear all external interrupts. */
\r
342 FM3_EXTI->EICL = 0x0000;
\r
344 /* Enable the button interrupt. */
\r
345 FM3_EXTI->ENIR |= usButtonInputBit;
\r
347 /* Setup the GPIO and the NVIC for the switch used in this simple demo. */
\r
348 NVIC_SetPriority( EXINT0_7_IRQn, configLIBRARY_MAX_SYSCALL_INTERRUPT_PRIORITY );
\r
349 NVIC_EnableIRQ( EXINT0_7_IRQn );
\r
351 /*-----------------------------------------------------------*/
\r
353 void vApplicationMallocFailedHook( void )
\r
355 /* Called if a call to pvPortMalloc() fails because there is insufficient
\r
356 free memory available in the FreeRTOS heap. pvPortMalloc() is called
\r
357 internally by FreeRTOS API functions that create tasks, queues, software
\r
358 timers, and semaphores. The size of the FreeRTOS heap is set by the
\r
359 configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */
\r
362 /*-----------------------------------------------------------*/
\r
364 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )
\r
366 ( void ) pcTaskName;
\r
369 /* Run time stack overflow checking is performed if
\r
370 configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
371 function is called if a stack overflow is detected. */
\r
374 /*-----------------------------------------------------------*/
\r
376 void vApplicationTickHook( void )
\r
378 /* A tick hook is used by the "Full" build configuration. The Full and
\r
379 blinky build configurations share a FreeRTOSConfig.h header file, so this
\r
380 simple build configuration also has to define a tick hook - even though it
\r
381 does not actually use it for anything. */
\r
383 /*-----------------------------------------------------------*/
\r
385 void vApplicationIdleHook( void )
\r
387 volatile size_t xFreeHeapSpace;
\r
389 /* This function is called on each cycle of the idle task. In this case it
\r
390 does nothing useful, other than report the amount of FreeRTOS heap that
\r
391 remains unallocated. */
\r
392 xFreeHeapSpace = xPortGetFreeHeapSize();
\r
394 if( xFreeHeapSpace > 100 )
\r
396 /* By now, the kernel has allocated everything it is going to, so
\r
397 if there is a lot of heap remaining unallocated then
\r
398 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be
\r
399 reduced accordingly. */
\r
402 /*-----------------------------------------------------------*/
\r