1 /*This file has been prepared for Doxygen automatic documentation generation.*/
\r
2 /*! \file *********************************************************************
\r
4 * \brief FreeRTOS port source for AVR32 UC3.
\r
6 * - Compiler: GNU GCC for AVR32
\r
7 * - Supported devices: All AVR32 devices can be used.
\r
10 * \author Atmel Corporation: http://www.atmel.com \n
\r
11 * Support and FAQ: http://support.atmel.no/
\r
13 *****************************************************************************/
\r
16 FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.
\r
18 FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME. PLEASE VISIT
\r
19 http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.
\r
21 ***************************************************************************
\r
23 * FreeRTOS tutorial books are available in pdf and paperback. *
\r
24 * Complete, revised, and edited pdf reference manuals are also *
\r
27 * Purchasing FreeRTOS documentation will not only help you, by *
\r
28 * ensuring you get running as quickly as possible and with an *
\r
29 * in-depth knowledge of how to use FreeRTOS, it will also help *
\r
30 * the FreeRTOS project to continue with its mission of providing *
\r
31 * professional grade, cross platform, de facto standard solutions *
\r
32 * for microcontrollers - completely free of charge! *
\r
34 * >>> See http://www.FreeRTOS.org/Documentation for details. <<< *
\r
36 * Thank you for using FreeRTOS, and thank you for your support! *
\r
38 ***************************************************************************
\r
41 This file is part of the FreeRTOS distribution.
\r
43 FreeRTOS is free software; you can redistribute it and/or modify it under
\r
44 the terms of the GNU General Public License (version 2) as published by the
\r
45 Free Software Foundation AND MODIFIED BY the FreeRTOS exception.
\r
46 >>>NOTE<<< The modification to the GPL is included to allow you to
\r
47 distribute a combined work that includes FreeRTOS without being obliged to
\r
48 provide the source code for proprietary components outside of the FreeRTOS
\r
49 kernel. FreeRTOS is distributed in the hope that it will be useful, but
\r
50 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
51 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
\r
52 more details. You should have received a copy of the GNU General Public
\r
53 License and the FreeRTOS license exception along with FreeRTOS; if not it
\r
54 can be viewed here: http://www.freertos.org/a00114.html and also obtained
\r
55 by writing to Richard Barry, contact details for whom are available on the
\r
60 ***************************************************************************
\r
62 * Having a problem? Start by reading the FAQ "My application does *
\r
63 * not run, what could be wrong?" *
\r
65 * http://www.FreeRTOS.org/FAQHelp.html *
\r
67 ***************************************************************************
\r
70 http://www.FreeRTOS.org - Documentation, training, latest versions, license
\r
71 and contact details.
\r
73 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,
\r
74 including FreeRTOS+Trace - an indispensable productivity tool.
\r
76 Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell
\r
77 the code with commercial support, indemnification, and middleware, under
\r
78 the OpenRTOS brand: http://www.OpenRTOS.com. High Integrity Systems also
\r
79 provide a safety engineered and independently SIL3 certified version under
\r
80 the SafeRTOS brand: http://www.SafeRTOS.com.
\r
84 /* Standard includes. */
\r
85 #include <sys/cpu.h>
\r
86 #include <sys/usart.h>
\r
89 /* Scheduler includes. */
\r
90 #include "FreeRTOS.h"
\r
93 /* AVR32 UC3 includes. */
\r
94 #include <avr32/io.h>
\r
96 #if( configTICK_USE_TC==1 )
\r
101 /* Constants required to setup the task context. */
\r
102 #define portINITIAL_SR ( ( portSTACK_TYPE ) 0x00400000 ) /* AVR32 : [M2:M0]=001 I1M=0 I0M=0, GM=0 */
\r
103 #define portINSTRUCTION_SIZE ( ( portSTACK_TYPE ) 0 )
\r
105 /* Each task maintains its own critical nesting variable. */
\r
106 #define portNO_CRITICAL_NESTING ( ( unsigned long ) 0 )
\r
107 volatile unsigned long ulCriticalNesting = 9999UL;
\r
109 #if( configTICK_USE_TC==0 )
\r
110 static void prvScheduleNextTick( void );
\r
112 static void prvClearTcInt( void );
\r
115 /* Setup the timer to generate the tick interrupts. */
\r
116 static void prvSetupTimerInterrupt( void );
\r
118 /*-----------------------------------------------------------*/
\r
121 * Low-level initialization routine called during startup, before the main
\r
123 * This version comes in replacement to the default one provided by Newlib.
\r
124 * Newlib's _init_startup only calls init_exceptions, but Newlib's exception
\r
125 * vectors are not compatible with the SCALL management in the current FreeRTOS
\r
126 * port. More low-level initializations are besides added here.
\r
128 void _init_startup(void)
\r
130 /* Import the Exception Vector Base Address. */
\r
133 #if configHEAP_INIT
\r
134 extern void __heap_start__;
\r
135 extern void __heap_end__;
\r
136 portBASE_TYPE *pxMem;
\r
139 /* Load the Exception Vector Base Address in the corresponding system register. */
\r
140 Set_system_register( AVR32_EVBA, ( int ) &_evba );
\r
142 /* Enable exceptions. */
\r
143 ENABLE_ALL_EXCEPTIONS();
\r
145 /* Initialize interrupt handling. */
\r
146 INTC_init_interrupts();
\r
148 #if configHEAP_INIT
\r
150 /* Initialize the heap used by malloc. */
\r
151 for( pxMem = &__heap_start__; pxMem < ( portBASE_TYPE * )&__heap_end__; )
\r
153 *pxMem++ = 0xA5A5A5A5;
\r
158 /* Give the used CPU clock frequency to Newlib, so it can work properly. */
\r
159 set_cpu_hz( configCPU_CLOCK_HZ );
\r
161 /* Code section present if and only if the debug trace is activated. */
\r
164 static const gpio_map_t DBG_USART_GPIO_MAP =
\r
166 { configDBG_USART_RX_PIN, configDBG_USART_RX_FUNCTION },
\r
167 { configDBG_USART_TX_PIN, configDBG_USART_TX_FUNCTION }
\r
170 /* Initialize the USART used for the debug trace with the configured parameters. */
\r
171 set_usart_base( ( void * ) configDBG_USART );
\r
172 gpio_enable_module( DBG_USART_GPIO_MAP,
\r
173 sizeof( DBG_USART_GPIO_MAP ) / sizeof( DBG_USART_GPIO_MAP[0] ) );
\r
174 usart_init( configDBG_USART_BAUDRATE );
\r
178 /*-----------------------------------------------------------*/
\r
181 * malloc, realloc and free are meant to be called through respectively
\r
182 * pvPortMalloc, pvPortRealloc and vPortFree.
\r
183 * The latter functions call the former ones from within sections where tasks
\r
184 * are suspended, so the latter functions are task-safe. __malloc_lock and
\r
185 * __malloc_unlock use the same mechanism to also keep the former functions
\r
186 * task-safe as they may be called directly from Newlib's functions.
\r
187 * However, all these functions are interrupt-unsafe and SHALL THEREFORE NOT BE
\r
188 * CALLED FROM WITHIN AN INTERRUPT, because __malloc_lock and __malloc_unlock do
\r
189 * not call portENTER_CRITICAL and portEXIT_CRITICAL in order not to disable
\r
190 * interrupts during memory allocation management as this may be a very time-
\r
191 * consuming process.
\r
195 * Lock routine called by Newlib on malloc / realloc / free entry to guarantee a
\r
196 * safe section as memory allocation management uses global data.
\r
197 * See the aforementioned details.
\r
199 void __malloc_lock(struct _reent *ptr)
\r
205 * Unlock routine called by Newlib on malloc / realloc / free exit to guarantee
\r
206 * a safe section as memory allocation management uses global data.
\r
207 * See the aforementioned details.
\r
209 void __malloc_unlock(struct _reent *ptr)
\r
213 /*-----------------------------------------------------------*/
\r
215 /* Added as there is no such function in FreeRTOS. */
\r
216 void *pvPortRealloc( void *pv, size_t xWantedSize )
\r
222 pvReturn = realloc( pv, xWantedSize );
\r
228 /*-----------------------------------------------------------*/
\r
230 /* The cooperative scheduler requires a normal IRQ service routine to
\r
231 simply increment the system tick. */
\r
232 /* The preemptive scheduler is defined as "naked" as the full context is saved
\r
233 on entry as part of the context switch. */
\r
234 __attribute__((__naked__)) static void vTick( void )
\r
236 /* Save the context of the interrupted task. */
\r
237 portSAVE_CONTEXT_OS_INT();
\r
239 #if( configTICK_USE_TC==1 )
\r
240 /* Clear the interrupt flag. */
\r
243 /* Schedule the COUNT&COMPARE match interrupt in (configCPU_CLOCK_HZ/configTICK_RATE_HZ)
\r
244 clock cycles from now. */
\r
245 prvScheduleNextTick();
\r
248 /* Because FreeRTOS is not supposed to run with nested interrupts, put all OS
\r
249 calls in a critical section . */
\r
250 portENTER_CRITICAL();
\r
251 vTaskIncrementTick();
\r
252 portEXIT_CRITICAL();
\r
254 /* Restore the context of the "elected task". */
\r
255 portRESTORE_CONTEXT_OS_INT();
\r
257 /*-----------------------------------------------------------*/
\r
259 __attribute__((__naked__)) void SCALLYield( void )
\r
261 /* Save the context of the interrupted task. */
\r
262 portSAVE_CONTEXT_SCALL();
\r
263 vTaskSwitchContext();
\r
264 portRESTORE_CONTEXT_SCALL();
\r
266 /*-----------------------------------------------------------*/
\r
268 /* The code generated by the GCC compiler uses the stack in different ways at
\r
269 different optimisation levels. The interrupt flags can therefore not always
\r
270 be saved to the stack. Instead the critical section nesting level is stored
\r
271 in a variable, which is then saved as part of the stack context. */
\r
272 __attribute__((__noinline__)) void vPortEnterCritical( void )
\r
274 /* Disable interrupts */
\r
275 portDISABLE_INTERRUPTS();
\r
277 /* Now interrupts are disabled ulCriticalNesting can be accessed
\r
278 directly. Increment ulCriticalNesting to keep a count of how many times
\r
279 portENTER_CRITICAL() has been called. */
\r
280 ulCriticalNesting++;
\r
282 /*-----------------------------------------------------------*/
\r
284 __attribute__((__noinline__)) void vPortExitCritical( void )
\r
286 if(ulCriticalNesting > portNO_CRITICAL_NESTING)
\r
288 ulCriticalNesting--;
\r
289 if( ulCriticalNesting == portNO_CRITICAL_NESTING )
\r
291 /* Enable all interrupt/exception. */
\r
292 portENABLE_INTERRUPTS();
\r
296 /*-----------------------------------------------------------*/
\r
299 * Initialise the stack of a task to look exactly as if a call to
\r
300 * portSAVE_CONTEXT had been called.
\r
302 * See header file for description.
\r
304 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )
\r
306 /* Setup the initial stack of the task. The stack is set exactly as
\r
307 expected by the portRESTORE_CONTEXT() macro. */
\r
309 /* When the task starts, it will expect to find the function parameter in R12. */
\r
311 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x08080808; /* R8 */
\r
312 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x09090909; /* R9 */
\r
313 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x0A0A0A0A; /* R10 */
\r
314 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x0B0B0B0B; /* R11 */
\r
315 *pxTopOfStack-- = ( portSTACK_TYPE ) pvParameters; /* R12 */
\r
316 *pxTopOfStack-- = ( portSTACK_TYPE ) 0xDEADBEEF; /* R14/LR */
\r
317 *pxTopOfStack-- = ( portSTACK_TYPE ) pxCode + portINSTRUCTION_SIZE; /* R15/PC */
\r
318 *pxTopOfStack-- = ( portSTACK_TYPE ) portINITIAL_SR; /* SR */
\r
319 *pxTopOfStack-- = ( portSTACK_TYPE ) 0xFF0000FF; /* R0 */
\r
320 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x01010101; /* R1 */
\r
321 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x02020202; /* R2 */
\r
322 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x03030303; /* R3 */
\r
323 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x04040404; /* R4 */
\r
324 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x05050505; /* R5 */
\r
325 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x06060606; /* R6 */
\r
326 *pxTopOfStack-- = ( portSTACK_TYPE ) 0x07070707; /* R7 */
\r
327 *pxTopOfStack = ( portSTACK_TYPE ) portNO_CRITICAL_NESTING; /* ulCriticalNesting */
\r
329 return pxTopOfStack;
\r
331 /*-----------------------------------------------------------*/
\r
333 portBASE_TYPE xPortStartScheduler( void )
\r
335 /* Start the timer that generates the tick ISR. Interrupts are disabled
\r
337 prvSetupTimerInterrupt();
\r
339 /* Start the first task. */
\r
340 portRESTORE_CONTEXT();
\r
342 /* Should not get here! */
\r
345 /*-----------------------------------------------------------*/
\r
347 void vPortEndScheduler( void )
\r
349 /* It is unlikely that the AVR32 port will require this function as there
\r
350 is nothing to return to. */
\r
352 /*-----------------------------------------------------------*/
\r
354 /* Schedule the COUNT&COMPARE match interrupt in (configCPU_CLOCK_HZ/configTICK_RATE_HZ)
\r
355 clock cycles from now. */
\r
356 #if( configTICK_USE_TC==0 )
\r
357 static void prvScheduleFirstTick(void)
\r
359 unsigned long lCycles;
\r
361 lCycles = Get_system_register(AVR32_COUNT);
\r
362 lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);
\r
363 // If lCycles ends up to be 0, make it 1 so that the COMPARE and exception
\r
364 // generation feature does not get disabled.
\r
369 Set_system_register(AVR32_COMPARE, lCycles);
\r
372 __attribute__((__noinline__)) static void prvScheduleNextTick(void)
\r
374 unsigned long lCycles, lCount;
\r
376 lCycles = Get_system_register(AVR32_COMPARE);
\r
377 lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);
\r
378 // If lCycles ends up to be 0, make it 1 so that the COMPARE and exception
\r
379 // generation feature does not get disabled.
\r
384 lCount = Get_system_register(AVR32_COUNT);
\r
385 if( lCycles < lCount )
\r
386 { // We missed a tick, recover for the next.
\r
387 lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);
\r
389 Set_system_register(AVR32_COMPARE, lCycles);
\r
392 __attribute__((__noinline__)) static void prvClearTcInt(void)
\r
394 AVR32_TC.channel[configTICK_TC_CHANNEL].sr;
\r
397 /*-----------------------------------------------------------*/
\r
399 /* Setup the timer to generate the tick interrupts. */
\r
400 static void prvSetupTimerInterrupt(void)
\r
402 #if( configTICK_USE_TC==1 )
\r
404 volatile avr32_tc_t *tc = &AVR32_TC;
\r
406 // Options for waveform genration.
\r
407 tc_waveform_opt_t waveform_opt =
\r
409 .channel = configTICK_TC_CHANNEL, /* Channel selection. */
\r
411 .bswtrg = TC_EVT_EFFECT_NOOP, /* Software trigger effect on TIOB. */
\r
412 .beevt = TC_EVT_EFFECT_NOOP, /* External event effect on TIOB. */
\r
413 .bcpc = TC_EVT_EFFECT_NOOP, /* RC compare effect on TIOB. */
\r
414 .bcpb = TC_EVT_EFFECT_NOOP, /* RB compare effect on TIOB. */
\r
416 .aswtrg = TC_EVT_EFFECT_NOOP, /* Software trigger effect on TIOA. */
\r
417 .aeevt = TC_EVT_EFFECT_NOOP, /* External event effect on TIOA. */
\r
418 .acpc = TC_EVT_EFFECT_NOOP, /* RC compare effect on TIOA: toggle. */
\r
419 .acpa = TC_EVT_EFFECT_NOOP, /* RA compare effect on TIOA: toggle (other possibilities are none, set and clear). */
\r
421 .wavsel = TC_WAVEFORM_SEL_UP_MODE_RC_TRIGGER,/* Waveform selection: Up mode without automatic trigger on RC compare. */
\r
422 .enetrg = FALSE, /* External event trigger enable. */
\r
423 .eevt = 0, /* External event selection. */
\r
424 .eevtedg = TC_SEL_NO_EDGE, /* External event edge selection. */
\r
425 .cpcdis = FALSE, /* Counter disable when RC compare. */
\r
426 .cpcstop = FALSE, /* Counter clock stopped with RC compare. */
\r
428 .burst = FALSE, /* Burst signal selection. */
\r
429 .clki = FALSE, /* Clock inversion. */
\r
430 .tcclks = TC_CLOCK_SOURCE_TC2 /* Internal source clock 2. */
\r
433 tc_interrupt_t tc_interrupt =
\r
447 /* Disable all interrupt/exception. */
\r
448 portDISABLE_INTERRUPTS();
\r
450 /* Register the compare interrupt handler to the interrupt controller and
\r
451 enable the compare interrupt. */
\r
453 #if( configTICK_USE_TC==1 )
\r
455 INTC_register_interrupt(&vTick, configTICK_TC_IRQ, INT0);
\r
457 /* Initialize the timer/counter. */
\r
458 tc_init_waveform(tc, &waveform_opt);
\r
460 /* Set the compare triggers.
\r
461 Remember TC counter is 16-bits, so counting second is not possible!
\r
462 That's why we configure it to count ms. */
\r
463 tc_write_rc( tc, configTICK_TC_CHANNEL, ( configPBA_CLOCK_HZ / 4) / configTICK_RATE_HZ );
\r
465 tc_configure_interrupts( tc, configTICK_TC_CHANNEL, &tc_interrupt );
\r
467 /* Start the timer/counter. */
\r
468 tc_start(tc, configTICK_TC_CHANNEL);
\r
472 INTC_register_interrupt(&vTick, AVR32_CORE_COMPARE_IRQ, INT0);
\r
473 prvScheduleFirstTick();
\r