]> git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/MicroBlaze_Spartan-6_EthernetLite/SDKProjects/RTOSDemo/main-blinky.c
84ffa822c0d8429e527a2b0a2eacea72f002c565
[freertos] / FreeRTOS / Demo / MicroBlaze_Spartan-6_EthernetLite / SDKProjects / RTOSDemo / main-blinky.c
1 /*\r
2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
3 \r
4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
6 \r
7     ***************************************************************************\r
8      *                                                                       *\r
9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
10      *    Complete, revised, and edited pdf reference manuals are also       *\r
11      *    available.                                                         *\r
12      *                                                                       *\r
13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
14      *    ensuring you get running as quickly as possible and with an        *\r
15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
16      *    the FreeRTOS project to continue with its mission of providing     *\r
17      *    professional grade, cross platform, de facto standard solutions    *\r
18      *    for microcontrollers - completely free of charge!                  *\r
19      *                                                                       *\r
20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
21      *                                                                       *\r
22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
23      *                                                                       *\r
24     ***************************************************************************\r
25 \r
26 \r
27     This file is part of the FreeRTOS distribution.\r
28 \r
29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
30     the terms of the GNU General Public License (version 2) as published by the\r
31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
33     distribute a combined work that includes FreeRTOS without being obliged to\r
34     provide the source code for proprietary components outside of the FreeRTOS\r
35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
38     more details. You should have received a copy of the GNU General Public\r
39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
41     by writing to Richard Barry, contact details for whom are available on the\r
42     FreeRTOS WEB site.\r
43 \r
44     1 tab == 4 spaces!\r
45     \r
46     ***************************************************************************\r
47      *                                                                       *\r
48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
49      *    not run, what could be wrong?"                                     *\r
50      *                                                                       *\r
51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
52      *                                                                       *\r
53     ***************************************************************************\r
54 \r
55     \r
56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
57     and contact details.  \r
58     \r
59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
60     including FreeRTOS+Trace - an indispensable productivity tool.\r
61 \r
62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
63     the code with commercial support, indemnification, and middleware, under \r
64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
65     provide a safety engineered and independently SIL3 certified version under \r
66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
67 */\r
68 \r
69 /*\r
70  * main-blinky.c is included when the "Blinky" build configuration is used.\r
71  * main-full.c is included when the "Full" build configuration is used.\r
72  *\r
73  * main-blinky.c (this file) defines a very simple demo that creates two tasks,\r
74  * one queue, and one timer.  It also demonstrates how MicroBlaze interrupts\r
75  * can interact with FreeRTOS tasks/timers.\r
76  *\r
77  * This simple demo project was developed and tested on the Spartan-6 SP605 \r
78  * development board, using the hardware configuration found in the hardware\r
79  * project that is already included in the Eclipse project.\r
80  *\r
81  * The idle hook function:\r
82  * The idle hook function demonstrates how to query the amount of FreeRTOS heap\r
83  * space that is remaining (see vApplicationIdleHook() defined in this file).\r
84  *\r
85  * The main() Function:\r
86  * main() creates one software timer, one queue, and two tasks.  It then starts\r
87  * the scheduler.\r
88  *\r
89  * The Queue Send Task:\r
90  * The queue send task is implemented by the prvQueueSendTask() function in\r
91  * this file.  prvQueueSendTask() sits in a loop that causes it to repeatedly\r
92  * block for 200 milliseconds, before sending the value 100 to the queue that\r
93  * was created within main().  Once the value is sent, the task loops back\r
94  * around to block for another 200 milliseconds.\r
95  *\r
96  * The Queue Receive Task:\r
97  * The queue receive task is implemented by the prvQueueReceiveTask() function\r
98  * in this file.  prvQueueReceiveTask() sits in a loop that causes it to\r
99  * repeatedly attempt to read data from the queue that was created within\r
100  * main().  When data is received, the task checks the value of the data, and\r
101  * if the value equals the expected 100, toggles an LED.  The 'block time' \r
102  * parameter passed to the queue receive function specifies that the task\r
103  * should be held in the Blocked state indefinitely to wait for data to be\r
104  * available on the queue.  The queue receive task will only leave the Blocked\r
105  * state when the queue send task writes to the queue.  As the queue send task\r
106  * writes to the queue every 200 milliseconds, the queue receive task leaves\r
107  * the Blocked state every 200 milliseconds, and therefore toggles the LED\r
108  * every 200 milliseconds.\r
109  *\r
110  * The LED Software Timer and the Button Interrupt:\r
111  * The user buttons are configured to generate an interrupt each time one is\r
112  * pressed.  The interrupt service routine switches an LED on, and resets the\r
113  * LED software timer.  The LED timer has a 5000 millisecond (5 second) period,\r
114  * and uses a callback function that is defined to just turn the LED off again.\r
115  * Therefore, pressing the user button will turn the LED on, and the LED will\r
116  * remain on until a full five seconds pass without the button being pressed.\r
117  */\r
118 \r
119 /* Kernel includes. */\r
120 #include "FreeRTOS.h"\r
121 #include "task.h"\r
122 #include "queue.h"\r
123 #include "timers.h"\r
124 \r
125 /* BSP includes. */\r
126 #include "xtmrctr.h"\r
127 #include "xgpio.h"\r
128 \r
129 /* Priorities at which the tasks are created. */\r
130 #define mainQUEUE_RECEIVE_TASK_PRIORITY         ( tskIDLE_PRIORITY + 2 )\r
131 #define mainQUEUE_SEND_TASK_PRIORITY            ( tskIDLE_PRIORITY + 1 )\r
132 \r
133 /* The rate at which data is sent to the queue, specified in milliseconds, and\r
134 converted to ticks using the portTICK_RATE_MS constant. */\r
135 #define mainQUEUE_SEND_FREQUENCY_MS                     ( 200 / portTICK_RATE_MS )\r
136 \r
137 /* The number of items the queue can hold.  This is 1 as the receive task\r
138 will remove items as they are added because it has the higher priority, meaning \r
139 the send task should always find the queue empty. */\r
140 #define mainQUEUE_LENGTH                                        ( 1 )\r
141 \r
142 /* The LED toggled by the queue receive task. */\r
143 #define mainTASK_CONTROLLED_LED                         0x01UL\r
144 \r
145 /* The LED turned on by the button interrupt, and turned off by the LED timer. */\r
146 #define mainTIMER_CONTROLLED_LED                        0x02UL\r
147 \r
148 /* A block time of 0 simply means, "don't block". */\r
149 #define mainDONT_BLOCK                                          ( portTickType ) 0\r
150 \r
151 /*-----------------------------------------------------------*/\r
152 \r
153 /*\r
154  * Setup the NVIC, LED outputs, and button inputs.\r
155  */\r
156 static void prvSetupHardware( void );\r
157 \r
158 /*\r
159  * The tasks as described in the comments at the top of this file.\r
160  */\r
161 static void prvQueueReceiveTask( void *pvParameters );\r
162 static void prvQueueSendTask( void *pvParameters );\r
163 \r
164 /*\r
165  * The LED timer callback function.  This does nothing but switch off the\r
166  * LED defined by the mainTIMER_CONTROLLED_LED constant.\r
167  */\r
168 static void vLEDTimerCallback( xTimerHandle xTimer );\r
169 \r
170 /* \r
171  * The handler executed each time a button interrupt is generated.  This ensures\r
172  * the LED defined by mainTIMER_CONTROLLED_LED is on, and resets the timer so\r
173  * the timer will not turn the LED off for a full 5 seconds after the button\r
174  * interrupt occurred.\r
175  */\r
176 static void prvButtonInputInterruptHandler( void *pvUnused );\r
177 \r
178 /*-----------------------------------------------------------*/\r
179 \r
180 /* The queue used by the queue send and queue receive tasks. */\r
181 static xQueueHandle xQueue = NULL;\r
182 \r
183 /* The LED software timer.  This uses vLEDTimerCallback() as its callback\r
184 function. */\r
185 static xTimerHandle xLEDTimer = NULL;\r
186 \r
187 /* Maintains the current LED output state. */\r
188 static volatile unsigned char ucGPIOState = 0U;\r
189 \r
190 /*-----------------------------------------------------------*/\r
191 \r
192 /* Structures that hold the state of the various peripherals used by this demo.\r
193 These are used by the Xilinx peripheral driver API functions. */\r
194 static XTmrCtr xTimer0Instance;\r
195 static XGpio xOutputGPIOInstance, xInputGPIOInstance;\r
196 \r
197 /* Constants required by the Xilinx peripheral driver API functions that are\r
198 relevant to the particular hardware set up. */\r
199 static const unsigned long ulGPIOOutputChannel = 1UL, ulGPIOInputChannel = 1UL;\r
200 \r
201 /*-----------------------------------------------------------*/\r
202 \r
203 int main( void )\r
204 {\r
205         /* *************************************************************************\r
206         This is a very simple project suitable for getting started with FreeRTOS.  \r
207         If you would prefer a more complex project that demonstrates a lot more \r
208         features and tests, then select the 'Full' build configuration within the \r
209         SDK Eclipse IDE. \r
210         ***************************************************************************/\r
211 \r
212         /* Configure the interrupt controller, LED outputs and button inputs. */\r
213         prvSetupHardware();\r
214 \r
215         /* Create the queue used by the queue send and queue receive tasks as\r
216         described in the comments at the top of this file. */\r
217         xQueue = xQueueCreate( mainQUEUE_LENGTH, sizeof( unsigned long ) );\r
218 \r
219         /* Sanity check that the queue was created. */\r
220         configASSERT( xQueue );\r
221 \r
222         /* Start the two tasks as described in the comments at the top of this \r
223         file. */\r
224         xTaskCreate( prvQueueReceiveTask, ( signed char * ) "Rx", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_RECEIVE_TASK_PRIORITY, NULL );\r
225         xTaskCreate( prvQueueSendTask, ( signed char * ) "TX", configMINIMAL_STACK_SIZE, NULL, mainQUEUE_SEND_TASK_PRIORITY, NULL );\r
226 \r
227         /* Create the software timer that is responsible for turning off the LED\r
228         if the button is not pushed within 5000ms, as described at the top of\r
229         this file.  The timer is not actually started until a button interrupt is\r
230         pushed, as it is not until that point that the LED is turned on. */\r
231         xLEDTimer = xTimerCreate(       ( const signed char * ) "LEDTimer", /* A text name, purely to help debugging. */\r
232                                                                 ( 5000 / portTICK_RATE_MS ),            /* The timer period, in this case 5000ms (5s). */\r
233                                                                 pdFALSE,                                                        /* This is a one shot timer, so xAutoReload is set to pdFALSE. */\r
234                                                                 ( void * ) 0,                                           /* The ID is not used, so can be set to anything. */\r
235                                                                 vLEDTimerCallback                                       /* The callback function that switches the LED off. */\r
236                                                         );\r
237 \r
238         /* Start the tasks and timer running. */\r
239         vTaskStartScheduler();\r
240 \r
241         /* If all is well, the scheduler will now be running, and the following line\r
242         will never be reached.  If the following line does execute, then there was\r
243         insufficient FreeRTOS heap memory available for the idle and/or timer tasks\r
244         to be created.  See the memory management section on the FreeRTOS web site\r
245         for more details. */\r
246         for( ;; );\r
247 }\r
248 /*-----------------------------------------------------------*/\r
249 \r
250 /* The callback is executed when the LED timer expires. */\r
251 static void vLEDTimerCallback( xTimerHandle xTimer )\r
252 {\r
253         /* The timer has expired - so no button pushes have occurred in the last\r
254         five seconds - turn the LED off.  NOTE - accessing the LED port should use\r
255         a critical section because it is accessed from multiple tasks, and the\r
256         button interrupt - in this trivial case, for simplicity, the critical\r
257         section is omitted. */\r
258         ucGPIOState &= ~mainTIMER_CONTROLLED_LED;\r
259         XGpio_DiscreteWrite( &xOutputGPIOInstance, ulGPIOOutputChannel, ucGPIOState );\r
260 }\r
261 /*-----------------------------------------------------------*/\r
262 \r
263 /* The ISR is executed when the user button is pushed. */\r
264 static void prvButtonInputInterruptHandler( void *pvUnused )\r
265 {\r
266 long lHigherPriorityTaskWoken = pdFALSE;\r
267 \r
268         /* The button was pushed, so ensure the LED is on before resetting the\r
269         LED timer.  The LED timer will turn the LED off if the button is not\r
270         pushed within 5000ms. */\r
271         ucGPIOState |= mainTIMER_CONTROLLED_LED;\r
272         XGpio_DiscreteWrite( &xOutputGPIOInstance, ulGPIOOutputChannel, ucGPIOState );\r
273 \r
274         /* Ensure only the ISR safe reset API function is used, as this is executed\r
275         in an interrupt context. */\r
276         xTimerResetFromISR( xLEDTimer, &lHigherPriorityTaskWoken );\r
277 \r
278         /* Clear the interrupt before leaving. */\r
279         XGpio_InterruptClear( &xInputGPIOInstance, ulGPIOInputChannel );\r
280 \r
281         /* If calling xTimerResetFromISR() caused a task (in this case the timer\r
282         service/daemon task) to unblock, and the unblocked task has a priority\r
283         higher than or equal to the task that was interrupted, then\r
284         lHigherPriorityTaskWoken will now be set to pdTRUE, and calling\r
285         portEND_SWITCHING_ISR() will ensure the unblocked task runs next. */\r
286         portYIELD_FROM_ISR( lHigherPriorityTaskWoken );\r
287 }\r
288 /*-----------------------------------------------------------*/\r
289 \r
290 static void prvQueueSendTask( void *pvParameters )\r
291 {\r
292 portTickType xNextWakeTime;\r
293 const unsigned long ulValueToSend = 100UL;\r
294 \r
295         /* Initialise xNextWakeTime - this only needs to be done once. */\r
296         xNextWakeTime = xTaskGetTickCount();\r
297 \r
298         for( ;; )\r
299         {\r
300                 /* Place this task in the blocked state until it is time to run again.\r
301                 The block time is specified in ticks, the constant used converts ticks\r
302                 to ms.  While in the Blocked state this task will not consume any CPU\r
303                 time. */\r
304                 vTaskDelayUntil( &xNextWakeTime, mainQUEUE_SEND_FREQUENCY_MS );\r
305 \r
306                 /* Send to the queue - causing the queue receive task to unblock and\r
307                 toggle an LED.  0 is used as the block time so the sending operation\r
308                 will not block - it shouldn't need to block as the queue should always\r
309                 be empty at this point in the code. */\r
310                 xQueueSend( xQueue, &ulValueToSend, mainDONT_BLOCK );\r
311         }\r
312 }\r
313 /*-----------------------------------------------------------*/\r
314 \r
315 static void prvQueueReceiveTask( void *pvParameters )\r
316 {\r
317 unsigned long ulReceivedValue;\r
318 \r
319         for( ;; )\r
320         {\r
321                 /* Wait until something arrives in the queue - this task will block\r
322                 indefinitely provided INCLUDE_vTaskSuspend is set to 1 in\r
323                 FreeRTOSConfig.h. */\r
324                 xQueueReceive( xQueue, &ulReceivedValue, portMAX_DELAY );\r
325 \r
326                 /*  To get here something must have been received from the queue, but\r
327                 is it the expected value?  If it is, toggle the green LED. */\r
328                 if( ulReceivedValue == 100UL )\r
329                 {\r
330                         /* NOTE - accessing the LED port should use a critical section\r
331                         because it is accessed from multiple tasks, and the button interrupt\r
332                         - in this trivial case, for simplicity, the critical section is\r
333                         omitted. */\r
334                         if( ( ucGPIOState & mainTASK_CONTROLLED_LED ) != 0 )\r
335                         {\r
336                                 ucGPIOState &= ~mainTASK_CONTROLLED_LED;\r
337                         }\r
338                         else\r
339                         {\r
340                                 ucGPIOState |= mainTASK_CONTROLLED_LED;\r
341                         }\r
342 \r
343                         XGpio_DiscreteWrite( &xOutputGPIOInstance, ulGPIOOutputChannel, ucGPIOState );\r
344                 }\r
345         }\r
346 }\r
347 /*-----------------------------------------------------------*/\r
348 \r
349 static void prvSetupHardware( void )\r
350 {\r
351 portBASE_TYPE xStatus;\r
352 const unsigned char ucSetToOutput = 0U;\r
353 \r
354         /* Initialize the GPIO for the LEDs. */\r
355         xStatus = XGpio_Initialize( &xOutputGPIOInstance, XPAR_LEDS_4BITS_DEVICE_ID );\r
356         if( xStatus == XST_SUCCESS )\r
357         {\r
358                 /* All bits on this channel are going to be outputs (LEDs). */\r
359                 XGpio_SetDataDirection( &xOutputGPIOInstance, ulGPIOOutputChannel, ucSetToOutput );\r
360 \r
361                 /* Start with all LEDs off. */\r
362                 ucGPIOState = 0U;\r
363                 XGpio_DiscreteWrite( &xOutputGPIOInstance, ulGPIOOutputChannel, ucGPIOState );\r
364         }\r
365 \r
366         /* Initialise the GPIO for the button inputs. */\r
367         if( xStatus == XST_SUCCESS )\r
368         {\r
369                 xStatus = XGpio_Initialize( &xInputGPIOInstance, XPAR_PUSH_BUTTONS_4BITS_DEVICE_ID );\r
370         }\r
371 \r
372         if( xStatus == XST_SUCCESS )\r
373         {\r
374                 /* Install the handler defined in this task for the button input. \r
375                 *NOTE* The FreeRTOS defined xPortInstallInterruptHandler() API function\r
376                 must be used for this purpose. */\r
377                 xStatus = xPortInstallInterruptHandler( XPAR_MICROBLAZE_0_INTC_PUSH_BUTTONS_4BITS_IP2INTC_IRPT_INTR, prvButtonInputInterruptHandler, NULL );\r
378 \r
379                 if( xStatus == pdPASS )\r
380                 {\r
381                         /* Set buttons to input. */\r
382                         XGpio_SetDataDirection( &xInputGPIOInstance, ulGPIOInputChannel, ~( ucSetToOutput ) );\r
383                         \r
384                         /* Enable the button input interrupts in the interrupt controller.\r
385                         *NOTE* The vPortEnableInterrupt() API function must be used for this\r
386                         purpose. */\r
387                         vPortEnableInterrupt( XPAR_MICROBLAZE_0_INTC_PUSH_BUTTONS_4BITS_IP2INTC_IRPT_INTR );\r
388 \r
389                         /* Enable GPIO channel interrupts. */\r
390                         XGpio_InterruptEnable( &xInputGPIOInstance, ulGPIOInputChannel );\r
391                         XGpio_InterruptGlobalEnable( &xInputGPIOInstance );\r
392                 }\r
393         }\r
394 \r
395         configASSERT( ( xStatus == pdPASS ) );\r
396 }\r
397 /*-----------------------------------------------------------*/\r
398 \r
399 void vApplicationMallocFailedHook( void )\r
400 {\r
401         /* vApplicationMallocFailedHook() will only be called if\r
402         configUSE_MALLOC_FAILED_HOOK is set to 1 in FreeRTOSConfig.h.  It is a hook\r
403         function that will get called if a call to pvPortMalloc() fails. \r
404         pvPortMalloc() is called internally by the kernel whenever a task, queue or\r
405         semaphore is created.  It is also called by various parts of the demo\r
406         application.  If heap_1.c or heap_2.c are used, then the size of the heap\r
407         available to pvPortMalloc() is defined by configTOTAL_HEAP_SIZE in\r
408         FreeRTOSConfig.h, and the xPortGetFreeHeapSize() API function can be used\r
409         to query the size of free heap space that remains (although it does not\r
410         provide information on how the remaining heap might be fragmented). */\r
411         taskDISABLE_INTERRUPTS();\r
412         for( ;; );\r
413 }\r
414 /*-----------------------------------------------------------*/\r
415 \r
416 void vApplicationStackOverflowHook( xTaskHandle pxTask, signed char *pcTaskName )\r
417 {\r
418         ( void ) pcTaskName;\r
419         ( void ) pxTask;\r
420 \r
421         /* vApplicationStackOverflowHook() will only be called if\r
422         configCHECK_FOR_STACK_OVERFLOW is set to either 1 or 2.  The handle and name\r
423         of the offending task will be passed into the hook function via its \r
424         parameters.  However, when a stack has overflowed, it is possible that the\r
425         parameters will have been corrupted, in which case the pxCurrentTCB variable\r
426         can be inspected directly. */\r
427         taskDISABLE_INTERRUPTS();\r
428         for( ;; );\r
429 }\r
430 /*-----------------------------------------------------------*/\r
431 \r
432 void vApplicationIdleHook( void )\r
433 {\r
434 #ifdef EXAMPLE_CODE_ONLY\r
435 \r
436         The following code can only be included if heap_1.c or heap_2.c is used in\r
437         the project.  By default, heap_3.c is used, so the example code is\r
438         excluded.  See http://www.freertos.org/a00111.html for more information on\r
439         memory management options.\r
440 \r
441         volatile size_t xFreeHeapSpace;\r
442 \r
443                 /* vApplicationIdleHook() will only be called if configUSE_IDLE_HOOK is set\r
444                 to 1 in FreeRTOSConfig.h.  It will be called on each iteration of the idle\r
445                 task.  It is essential that code added to this hook function never attempts\r
446                 to block in any way (for example, call xQueueReceive() with a block time\r
447                 specified, or call vTaskDelay()).  If the application makes use of the\r
448                 vTaskDelete() API function (as this demo application does) then it is also\r
449                 important that vApplicationIdleHook() is permitted to return to its calling\r
450                 function, because it is the responsibility of the idle task to clean up\r
451                 memory allocated by the kernel to any task that has since been deleted. */\r
452 \r
453                 /* This implementation of vApplicationIdleHook() simply demonstrates how\r
454                 the xPortGetFreeHeapSize() function can be used. */\r
455                 xFreeHeapSpace = xPortGetFreeHeapSize();\r
456 \r
457                 if( xFreeHeapSpace > 100 )\r
458                 {\r
459                         /* By now, the kernel has allocated everything it is going to, so\r
460                         if there is a lot of heap remaining unallocated then\r
461                         the value of configTOTAL_HEAP_SIZE in FreeRTOSConfig.h can be\r
462                         reduced accordingly. */\r
463                 }\r
464 #endif\r
465 }\r
466 /*-----------------------------------------------------------*/\r
467 \r
468 /* This is an application defined callback function used to install the tick\r
469 interrupt handler.  It is provided as an application callback because the kernel\r
470 will run on lots of different MicroBlaze and FPGA configurations - not all of\r
471 which will have the same timer peripherals defined or available.  This example\r
472 uses the AXI Timer 0.  If that is available on your hardware platform then this\r
473 example callback implementation should not require modification.   The name of\r
474 the interrupt handler that should be installed is vPortTickISR(), which the \r
475 function below declares as an extern. */\r
476 void vApplicationSetupTimerInterrupt( void )\r
477 {\r
478 portBASE_TYPE xStatus;\r
479 const unsigned char ucTimerCounterNumber = ( unsigned char ) 0U;\r
480 const unsigned long ulCounterValue = ( ( XPAR_AXI_TIMER_0_CLOCK_FREQ_HZ / configTICK_RATE_HZ ) - 1UL );\r
481 extern void vPortTickISR( void *pvUnused );\r
482 \r
483         /* Initialise the timer/counter. */\r
484         xStatus = XTmrCtr_Initialize( &xTimer0Instance, XPAR_AXI_TIMER_0_DEVICE_ID );\r
485 \r
486         if( xStatus == XST_SUCCESS )\r
487         {\r
488                 /* Install the tick interrupt handler as the timer ISR. \r
489                 *NOTE* The xPortInstallInterruptHandler() API function must be used for\r
490                 this purpose. */\r
491                 xStatus = xPortInstallInterruptHandler( XPAR_INTC_0_TMRCTR_0_VEC_ID, vPortTickISR, NULL );\r
492         }\r
493 \r
494         if( xStatus == pdPASS )\r
495         {\r
496                 /* Enable the timer interrupt in the interrupt controller.\r
497                 *NOTE* The vPortEnableInterrupt() API function must be used for this\r
498                 purpose. */\r
499                 vPortEnableInterrupt( XPAR_INTC_0_TMRCTR_0_VEC_ID );\r
500 \r
501                 /* Configure the timer interrupt handler. */\r
502                 XTmrCtr_SetHandler( &xTimer0Instance, ( void * ) vPortTickISR, NULL );\r
503 \r
504                 /* Set the correct period for the timer. */\r
505                 XTmrCtr_SetResetValue( &xTimer0Instance, ucTimerCounterNumber, ulCounterValue );\r
506 \r
507                 /* Enable the interrupts.  Auto-reload mode is used to generate a\r
508                 periodic tick.  Note that interrupts are disabled when this function is\r
509                 called, so interrupts will not start to be processed until the first\r
510                 task has started to run. */\r
511                 XTmrCtr_SetOptions( &xTimer0Instance, ucTimerCounterNumber, ( XTC_INT_MODE_OPTION | XTC_AUTO_RELOAD_OPTION | XTC_DOWN_COUNT_OPTION ) );\r
512 \r
513                 /* Start the timer. */\r
514                 XTmrCtr_Start( &xTimer0Instance, ucTimerCounterNumber );\r
515         }\r
516 \r
517         /* Sanity check that the function executed as expected. */\r
518         configASSERT( ( xStatus == pdPASS ) );\r
519 }\r
520 /*-----------------------------------------------------------*/\r
521 \r
522 /* This is an application defined callback function used to clear whichever\r
523 interrupt was installed by the the vApplicationSetupTimerInterrupt() callback\r
524 function - in this case the interrupt generated by the AXI timer.  It is \r
525 provided as an application callback because the kernel will run on lots of \r
526 different MicroBlaze and FPGA configurations - not all of which will have the \r
527 same timer peripherals defined or available.  This example uses the AXI Timer 0.  \r
528 If that is available on your hardware platform then this example callback \r
529 implementation should not require modification provided the example definition\r
530 of vApplicationSetupTimerInterrupt() is also not modified. */\r
531 void vApplicationClearTimerInterrupt( void )\r
532 {\r
533 unsigned long ulCSR;\r
534 \r
535         /* Clear the timer interrupt */\r
536         ulCSR = XTmrCtr_GetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0 );\r
537         XTmrCtr_SetControlStatusReg( XPAR_AXI_TIMER_0_BASEADDR, 0, ulCSR );\r
538 }\r
539 /*-----------------------------------------------------------*/\r
540 \r
541 /* These functions are not used by the Blinky build configuration.  However,\r
542 they need to be defined because the Blinky and Full build configurations share\r
543 a FreeRTOSConifg.h configuration file. */\r
544 void vMainConfigureTimerForRunTimeStats( void ) {}\r
545 unsigned long ulMainGetRunTimeCounterValue( void ) { return 1; }\r