2 FreeRTOS V7.0.1 - Copyright (C) 2011 Real Time Engineers Ltd.
\r
5 FreeRTOS supports many tools and architectures. V7.0.0 is sponsored by:
\r
6 Atollic AB - Atollic provides professional embedded systems development
\r
7 tools for C/C++ development, code analysis and test automation.
\r
8 See http://www.atollic.com
\r
11 ***************************************************************************
\r
13 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
14 * Complete, revised, and edited pdf reference manuals are also *
\r
17 * Purchasing FreeRTOS documentation will not only help you, by *
\r
18 * ensuring you get running as quickly as possible and with an *
\r
19 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
20 * the FreeRTOS project to continue with its mission of providing *
\r
21 * professional grade, cross platform, de facto standard solutions *
\r
22 * for microcontrollers - completely free of charge! *
\r
24 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
26 * Thank you for using FreeRTOS, and thank you for your support! *
\r
28 ***************************************************************************
\r
31 This file is part of the FreeRTOS distribution.
\r
33 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
34 the terms of the GNU General Public License (version 2) as published by the
\r
35 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
36 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
37 distribute a combined work that includes FreeRTOS without being obliged to
\r
38 provide the source code for proprietary components outside of the FreeRTOS
\r
39 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
40 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
41 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
42 more details. You should have received a copy of the GNU General Public
\r
43 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
44 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
45 by writing to Richard Barry, contact details for whom are available on the
\r
50 http://www.FreeRTOS.org - Documentation, latest information, license and
\r
53 http://www.SafeRTOS.com - A version that is certified for use in safety
\r
56 http://www.OpenRTOS.com - Commercial support, development, porting,
\r
57 licensing and training services.
\r
61 * main-blinky.c is included when the "Blinky" build configuration is used.
\r
62 * main-full.c is included when the "Full" build configuration is used.
\r
64 * main-blinky.c (this file) defines a very simple demo that creates two tasks,
\r
65 * one queue, and one timer. It also demonstrates how MicroBlaze interrupts
\r
66 * can interact with FreeRTOS tasks/timers.
\r
68 * This simple demo project runs on the Spartan-6 SP605 development board.
\r
70 * The idle hook function:
\r
71 * The idle hook function demonstrates how to query the amount of FreeRTOS heap
\r
72 * space that is remaining (see vApplicationIdleHook() defined in this file).
\r
74 * The main() Function:
\r
75 * main() creates one software timer, one queue, and two tasks. It then starts
\r
78 * The Queue Send Task:
\r
79 * The queue send task is implemented by the prvQueueSendTask() function in
\r
80 * this file. prvQueueSendTask() sits in a loop that causes it to repeatedly
\r
81 * block for 200 milliseconds, before sending the value 100 to the queue that
\r
82 * was created within main(). Once the value is sent, the task loops back
\r
83 * around to block for another 200 milliseconds.
\r
85 * The Queue Receive Task:
\r
86 * The queue receive task is implemented by the prvQueueReceiveTask() function
\r
87 * in this file. prvQueueReceiveTask() sits in a loop that causes it to
\r
88 * repeatedly attempt to read data from the queue that was created within
\r
89 * main(). When data is received, the task checks the value of the data, and
\r
90 * if the value equals the expected 100, toggles the green LED. The 'block
\r
91 * time' parameter passed to the queue receive function specifies that the task
\r
92 * should be held in the Blocked state indefinitely to wait for data to be
\r
93 * available on the queue. The queue receive task will only leave the Blocked
\r
94 * state when the queue send task writes to the queue. As the queue send task
\r
95 * writes to the queue every 200 milliseconds, the queue receive task leaves
\r
96 * the Blocked state every 200 milliseconds, and therefore toggles the LED
\r
97 * every 200 milliseconds.
\r
99 * The LED Software Timer and the Button Interrupt:
\r
100 * The user button SW1 is configured to generate an interrupt each time it is
\r
101 * pressed. The interrupt service routine switches an LED on, and resets the
\r
102 * LED software timer. The LED timer has a 5000 millisecond (5 second) period,
\r
103 * and uses a callback function that is defined to just turn the LED off again.
\r
104 * Therefore, pressing the user button will turn the LED on, and the LED will
\r
105 * remain on until a full five seconds pass without the button being pressed.
\r
108 /* Kernel includes. */
\r
109 #include "FreeRTOS.h"
\r
112 #include "timers.h"
\r
114 /* BSP includes. */
\r
115 #include "xenv_standalone.h"
\r
116 #include "xtmrctr.h"
\r
117 #include "xil_exception.h"
\r
118 #include "microblaze_exceptions_g.h"
\r
120 /* Priorities at which the tasks are created. */
\r
121 #define mainQUEUE_RECEIVE_TASK_PRIORITY ( tskIDLE_PRIORITY + 2 )
\r
122 #define mainQUEUE_SEND_TASK_PRIORITY ( tskIDLE_PRIORITY + 1 )
\r
124 /* The rate at which data is sent to the queue, specified in milliseconds, and
\r
125 converted to ticks using the portTICK_RATE_MS constant. */
\r
126 #define mainQUEUE_SEND_FREQUENCY_MS ( 200 / portTICK_RATE_MS )
\r
128 /* The number of items the queue can hold. This is 1 as the receive task
\r
129 will remove items as they are added, meaning the send task should always find
\r
130 the queue empty. */
\r
131 #define mainQUEUE_LENGTH ( 1 )
\r
133 /* The LED toggle by the queue receive task. */
\r
134 #define mainTASK_CONTROLLED_LED 0x01UL
\r
136 /* The LED turned on by the button interrupt, and turned off by the LED timer. */
\r
137 #define mainTIMER_CONTROLLED_LED 0x02UL
\r
139 /*-----------------------------------------------------------*/
\r
142 * Setup the NVIC, LED outputs, and button inputs.
\r
144 static void prvSetupHardware( void );
\r
147 * The tasks as described in the comments at the top of this file.
\r
149 static void prvQueueReceiveTask( void *pvParameters );
\r
150 static void prvQueueSendTask( void *pvParameters );
\r
153 * The LED timer callback function. This does nothing but switch off the
\r
154 * LED defined by the mainTIMER_CONTROLLED_LED constant.
\r
156 static void vLEDTimerCallback( xTimerHandle xTimer );
\r
158 /*-----------------------------------------------------------*/
\r
160 /* The queue used by both tasks. */
\r
161 static xQueueHandle xQueue = NULL;
\r
163 /* The LED software timer. This uses vLEDTimerCallback() as its callback
\r
165 static xTimerHandle xLEDTimer = NULL;
\r
167 /* Maintains the current LED output state. */
\r
168 static volatile unsigned long ulGPIOState = 0UL;
\r
170 /*-----------------------------------------------------------*/
\r
172 static XTmrCtr xTimer0Instance;
\r
174 /*-----------------------------------------------------------*/
\r
175 #define JUST_TESTING
\r
176 #ifdef JUST_TESTING
\r
177 volatile unsigned long ul1 = 0, ul2 = 0;
\r
179 void vTemp1( void *pvParameters )
\r
188 void vTemp2( void *pvParameters )
\r
199 prvSetupHardware();
\r
201 xTaskCreate( vTemp1, ( signed char * ) "Test1", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );
\r
202 xTaskCreate( vTemp2, ( signed char * ) "Test2", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL );
\r
204 vTaskStartScheduler();
\r
209 #else /* JUST_TESTING */
\r
213 /* Configure the interrupt controller, LED outputs and button inputs. */
\r
214 prvSetupHardware();
\r
216 /* Create the queue. */
\r
217 xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );
\r
219 if( xQueue != NULL )
\r
221 /* Start the two tasks as described in the comments at the top of this
\r
223 xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );
\r
224 xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );
\r
226 /* Create the software timer that is responsible for turning off the LED
\r
227 if the button is not pushed within 5000ms, as described at the top of
\r
229 xLEDTimer = xTimerCreate( ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */
\r
230 ( 5000 / portTICK_RATE_MS ), /* The timer period, in this case 5000ms (5s). */
\r
231 pdFALSE, /* This is a one shot timer, so xAutoReload is set to pdFALSE. */
\r
232 ( void * ) 0, /* The ID is not used, so can be set to anything. */
\r
233 vLEDTimerCallback /* The callback function that switches the LED off. */
\r
236 /* Start the tasks and timer running. */
\r
237 vTaskStartScheduler();
\r
240 /* If all is well, the scheduler will now be running, and the following line
\r
241 will never be reached. If the following line does execute, then there was
\r
242 insufficient FreeRTOS heap memory available for the idle and/or timer tasks
\r
243 to be created. See the memory management section on the FreeRTOS web site
\r
244 for more details. */
\r
247 /*-----------------------------------------------------------*/
\r
248 #endif /* JUST_TESTING */
\r
249 static void vLEDTimerCallback( xTimerHandle xTimer )
\r
251 /* The timer has expired - so no button pushes have occurred in the last
\r
252 five seconds - turn the LED off. NOTE - accessing the LED port should use
\r
253 a critical section because it is accessed from multiple tasks, and the
\r
254 button interrupt - in this trivial case, for simplicity, the critical
\r
255 section is omitted. */
\r
256 ulGPIOState |= mainTIMER_CONTROLLED_LED;
\r
257 //_RB_ MSS_GPIO_set_outputs( ulGPIOState );
\r
259 /*-----------------------------------------------------------*/
\r
261 /* The ISR executed when the user button is pushed. */
\r
262 void GPIO8_IRQHandler( void )
\r
264 portBASE_TYPE xHigherPriorityTaskWoken = pdFALSE;
\r
266 /* The button was pushed, so ensure the LED is on before resetting the
\r
267 LED timer. The LED timer will turn the LED off if the button is not
\r
268 pushed within 5000ms. */
\r
269 ulGPIOState &= ~mainTIMER_CONTROLLED_LED;
\r
270 //_RB_ MSS_GPIO_set_outputs( ulGPIOState );
\r
272 /* This interrupt safe FreeRTOS function can be called from this interrupt
\r
273 because the interrupt priority is below the
\r
274 configMAX_SYSCALL_INTERRUPT_PRIORITY setting in FreeRTOSConfig.h. */
\r
275 xTimerResetFromISR( xLEDTimer, &xHigherPriorityTaskWoken );
\r
277 /* Clear the interrupt before leaving. */
\r
278 //_RB_ MSS_GPIO_clear_irq( MSS_GPIO_8 );
\r
280 /* If calling xTimerResetFromISR() caused a task (in this case the timer
\r
281 service/daemon task) to unblock, and the unblocked task has a priority
\r
282 higher than or equal to the task that was interrupted, then
\r
283 xHigherPriorityTaskWoken will now be set to pdTRUE, and calling
\r
284 portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */
\r
285 portYIELD_FROM_ISR( xHigherPriorityTaskWoken );
\r
287 /*-----------------------------------------------------------*/
\r
289 static void prvQueueSendTask( void *pvParameters )
\r
291 portTickType xNextWakeTime;
\r
292 const unsigned long ulValueToSend = 100UL;
\r
294 /* Initialise xNextWakeTime - this only needs to be done once. */
\r
295 xNextWakeTime = xTaskGetTickCount();
\r
299 /* Place this task in the blocked state until it is time to run again.
\r
300 The block time is specified in ticks, the constant used converts ticks
\r
301 to ms. While in the Blocked state this task will not consume any CPU
\r
303 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );
\r
305 /* Send to the queue - causing the queue receive task to unblock and
\r
306 toggle an LED. 0 is used as the block time so the sending operation
\r
307 will not block - it shouldn't need to block as the queue should always
\r
308 be empty at this point in the code. */
\r
309 xQueueSend( xQueue, &ulValueToSend, 0 );
\r
312 /*-----------------------------------------------------------*/
\r
314 static void prvQueueReceiveTask( void *pvParameters )
\r
316 unsigned long ulReceivedValue;
\r
320 /* Wait until something arrives in the queue - this task will block
\r
321 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in
\r
322 FreeRTOSConfig.h. */
\r
323 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );
\r
325 /* To get here something must have been received from the queue, but
\r
326 is it the expected value? If it is, toggle the green LED. */
\r
327 if( ulReceivedValue == 100UL )
\r
329 /* NOTE - accessing the LED port should use a critical section
\r
330 because it is accessed from multiple tasks, and the button interrupt
\r
331 - in this trivial case, for simplicity, the critical section is
\r
333 if( ( ulGPIOState & mainTASK_CONTROLLED_LED ) != 0 )
\r
335 ulGPIOState &= ~mainTASK_CONTROLLED_LED;
\r
339 ulGPIOState |= mainTASK_CONTROLLED_LED;
\r
341 //_RB_ MSS_GPIO_set_outputs( ulGPIOState );
\r
345 /*-----------------------------------------------------------*/
\r
347 static void prvSetupHardware( void )
\r
349 #ifdef MICROBLAZE_EXCEPTIONS_ENABLED
\r
350 microblaze_enable_exceptions();
\r
353 /*-----------------------------------------------------------*/
\r
355 void vApplicationMallocFailedHook( void )
\r
357 /* Called if a call to pvPortMalloc() fails because there is insufficient
\r
358 free memory available in the FreeRTOS heap. pvPortMalloc() is called
\r
359 internally by FreeRTOS API functions that create tasks, queues, software
\r
360 timers, and semaphores. The size of the FreeRTOS heap is set by the
\r
361 configTOTAL_HEAP_SIZE configuration constant in FreeRTOSConfig.h. */
\r
364 /*-----------------------------------------------------------*/
\r
366 void vApplicationStackOverflowHook( xTaskHandle *pxTask, signed char *pcTaskName )
\r
368 ( void ) pcTaskName;
\r
371 /* Run time stack overflow checking is performed if
\r
372 configconfigCHECK_FOR_STACK_OVERFLOW is defined to 1 or 2. This hook
\r
373 function is called if a stack overflow is detected. */
\r
376 /*-----------------------------------------------------------*/
\r
378 void vApplicationIdleHook( void )
\r
380 volatile size_t xFreeHeapSpace;
\r
382 /* This function is called on each cycle of the idle task. In this case it
\r
383 does nothing useful, other than report the amout of FreeRTOS heap that
\r
384 remains unallocated. */
\r
385 xFreeHeapSpace = xPortGetFreeHeapSize();
\r
387 if( xFreeHeapSpace > 100 )
\r
389 /* By now, the kernel has allocated everything it is going to, so
\r
390 if there is a lot of heap remaining unallocated then
\r
391 the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be
\r
392 reduced accordingly. */
\r
395 /*-----------------------------------------------------------*/
\r
397 void vMainConfigureTimerForRunTimeStats( void )
\r
399 /* This function is not used by the Blinky build configuration, but needs
\r
400 to be defined as the Blinky and Full build configurations share a
\r
401 FreeRTOSConfig.h header file. */
\r
403 /*-----------------------------------------------------------*/
\r
405 unsigned long ulGetRunTimeCounterValue( void )
\r
407 /* This function is not used by the Blinky build configuration, but needs
\r
408 to be defined as the Blinky and Full build configurations share a
\r
409 FreeRTOSConfig.h header file. */
\r
412 /*-----------------------------------------------------------*/
\r
414 void vApplicationSetupTimerInterrupt( void )
\r
416 portBASE_TYPE xStatus;
\r
417 const unsigned char ucTimerCounterNumber = ( unsigned char ) 0U;
\r
418 const unsigned long ulCounterValue = ( ( XPAR_AXI_TIMER_0_CLOCK_FREQ_HZ / configTICK_RATE_HZ ) - 1UL );
\r
419 extern void vTickISR( void *pvUnused );
\r
421 /* Initialise the timer/counter. */
\r
422 xStatus = XTmrCtr_Initialize( &xTimer0Instance, XPAR_AXI_TIMER_0_DEVICE_ID );
\r
424 if( xStatus == XST_SUCCESS )
\r
426 /* Install the tick interrupt handler as the timer ISR. */
\r
427 xStatus = xPortInstallInterruptHandler( XPAR_MICROBLAZE_0_INTC_AXI_TIMER_0_INTERRUPT_INTR, vTickISR, NULL );
\r
430 if( xStatus == pdPASS )
\r
432 vPortEnableInterrupt( XPAR_MICROBLAZE_0_INTC_AXI_TIMER_0_INTERRUPT_INTR );
\r
434 /* Configure the timer interrupt handler. */
\r
435 XTmrCtr_SetHandler( &xTimer0Instance, ( void * ) vTickISR, NULL );
\r
437 /* Set the correct period for the timer. */
\r
438 XTmrCtr_SetResetValue( &xTimer0Instance, ucTimerCounterNumber, ulCounterValue );
\r
440 /* Enable the interrupts. Auto-reload mode is used to generate a
\r
441 periodic tick. Note that interrupts are disabled when this function is
\r
442 called, so interrupts will not start to be processed until the first
\r
443 task has started to run. */
\r
444 XTmrCtr_SetOptions( &xTimer0Instance, ucTimerCounterNumber, ( XTC_INT_MODE_OPTION | XTC_AUTO_RELOAD_OPTION | XTC_DOWN_COUNT_OPTION ) );
\r
446 /* Start the timer. */
\r
447 XTmrCtr_Start( &xTimer0Instance, ucTimerCounterNumber );
\r
450 configASSERT( ( xStatus == pdPASS ) );
\r
454 void vApplicationClearTimerInterrupt( void )
\r
456 unsigned long ulCSR;
\r
458 /* Increment the RTOS tick - this might cause a task to unblock. */
\r
459 vTaskIncrementTick();
\r
461 /* Clear the timer interrupt */
\r
462 ulCSR = XTmrCtr_GetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0 );
\r
463 XTmrCtr_SetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0, ulCSR );
\r