git.sur5r.net Git - freertos/blob - Source/portable/GCC/AVR32_UC3/port.c

   1 /*This file has been prepared for Doxygen automatic documentation generation.*/\r
   2 /*! \file *********************************************************************\r
   3  *\r
   4  * \brief FreeRTOS port source for AVR32 UC3.\r
   5  *\r
   6  * - Compiler:           GNU GCC for AVR32\r
   7  * - Supported devices:  All AVR32 devices can be used.\r
   8  * - AppNote:\r
   9  *\r
  10  * \author               Atmel Corporation: http://www.atmel.com \n\r
  11  *                       Support and FAQ: http://support.atmel.no/\r
  12  *\r
  13  *****************************************************************************/\r
  14 \r
  15 /*\r
  16         FreeRTOS.org V4.5.0 - Copyright (C) 2003-2007 Richard Barry.\r
  17 \r
  18         This file is part of the FreeRTOS.org distribution.\r
  19 \r
  20         FreeRTOS.org is free software; you can redistribute it and/or modify\r
  21         it under the terms of the GNU General Public License as published by\r
  22         the Free Software Foundation; either version 2 of the License, or\r
  23         (at your option) any later version.\r
  24 \r
  25         FreeRTOS.org is distributed in the hope that it will be useful,\r
  26         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  27         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  28         GNU General Public License for more details.\r
  29 \r
  30         You should have received a copy of the GNU General Public License\r
  31         along with FreeRTOS.org; if not, write to the Free Software\r
  32         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  33 \r
  34         A special exception to the GPL can be applied should you wish to distribute\r
  35         a combined work that includes FreeRTOS.org, without being obliged to provide\r
  36         the source code for any proprietary components.  See the licensing section\r
  37         of http://www.FreeRTOS.org for full details of how and when the exception\r
  38         can be applied.\r
  39 \r
  40         ***************************************************************************\r
  41         See http://www.FreeRTOS.org for documentation, latest information, license\r
  42         and contact details.  Please ensure to read the configuration and relevant\r
  43         port sections of the online documentation.\r
  44 \r
  45         Also see http://www.SafeRTOS.com for an IEC 61508 compliant version along\r
  46         with commercial development and support options.\r
  47         ***************************************************************************\r
  48 */\r
  49 \r
  50 \r
  51 /* Standard includes. */\r
  52 #include <sys/cpu.h>\r
  53 #include <sys/usart.h>\r
  54 #include <malloc.h>\r
  55 \r
  56 /* Scheduler includes. */\r
  57 #include "FreeRTOS.h"\r
  58 #include "task.h"\r
  59 \r
  60 /* AVR32 UC3 includes. */\r
  61 #include <avr32/io.h>\r
  62 #include "gpio.h"\r
  63 #if( configTICK_USE_TC==1 )\r
  64         #include "tc.h"\r
  65 #endif\r
  66 \r
  67 \r
  68 /* Constants required to setup the task context. */\r
  69 #define portINITIAL_SR            ( ( portSTACK_TYPE ) 0x00400000 ) /* AVR32 : [M2:M0]=001 I1M=0 I0M=0, GM=0 */\r
  70 #define portINSTRUCTION_SIZE      ( ( portSTACK_TYPE ) 0 )\r
  71 \r
  72 /* Each task maintains its own critical nesting variable. */\r
  73 #define portNO_CRITICAL_NESTING   ( ( unsigned portLONG ) 0 )\r
  74 volatile unsigned portLONG ulCriticalNesting = 9999UL;\r
  75 \r
  76 #if( configTICK_USE_TC==0 )\r
  77         static void prvScheduleNextTick( void );\r
  78 #else\r
  79         static void prvClearTcInt( void );\r
  80 #endif\r
  81 \r
  82 /* Setup the timer to generate the tick interrupts. */\r
  83 static void prvSetupTimerInterrupt( void );\r
  84 \r
  85 /*-----------------------------------------------------------*/\r
  86 \r
  87 /*\r
  88  * Low-level initialization routine called during startup, before the main\r
  89  * function.\r
  90  * This version comes in replacement to the default one provided by Newlib.\r
  91  * Newlib's _init_startup only calls init_exceptions, but Newlib's exception\r
  92  * vectors are not compatible with the SCALL management in the current FreeRTOS\r
  93  * port. More low-level initializations are besides added here.\r
  94  */\r
  95 void _init_startup(void)\r
  96 {\r
  97         /* Import the Exception Vector Base Address. */\r
  98         extern void _evba;\r
  99 \r
 100         #if configHEAP_INIT\r
 101                 extern void __heap_start__;\r
 102                 extern void __heap_end__;\r
 103                 portBASE_TYPE *pxMem;\r
 104         #endif\r
 105 \r
 106         /* Load the Exception Vector Base Address in the corresponding system register. */\r
 107         Set_system_register( AVR32_EVBA, ( int ) &_evba );\r
 108 \r
 109         /* Enable exceptions. */\r
 110         ENABLE_ALL_EXCEPTIONS();\r
 111 \r
 112         /* Initialize interrupt handling. */\r
 113         INTC_init_interrupts();\r
 114 \r
 115         #if configHEAP_INIT\r
 116 \r
 117                 /* Initialize the heap used by malloc. */\r
 118                 for( pxMem = &__heap_start__; pxMem < ( portBASE_TYPE * )&__heap_end__; )\r
 119                 {\r
 120                         *pxMem++ = 0xA5A5A5A5;\r
 121                 }\r
 122 \r
 123         #endif\r
 124 \r
 125         /* Give the used CPU clock frequency to Newlib, so it can work properly. */\r
 126         set_cpu_hz( configCPU_CLOCK_HZ );\r
 127 \r
 128         /* Code section present if and only if the debug trace is activated. */\r
 129         #if configDBG\r
 130         {\r
 131                 static const gpio_map_t DBG_USART_GPIO_MAP =\r
 132                 {\r
 133                         { configDBG_USART_RX_PIN, configDBG_USART_RX_FUNCTION },\r
 134                         { configDBG_USART_TX_PIN, configDBG_USART_TX_FUNCTION }\r
 135                 };\r
 136 \r
 137                 /* Initialize the USART used for the debug trace with the configured parameters. */\r
 138                 set_usart_base( ( void * ) configDBG_USART );\r
 139                 gpio_enable_module( DBG_USART_GPIO_MAP,\r
 140                                     sizeof( DBG_USART_GPIO_MAP ) / sizeof( DBG_USART_GPIO_MAP[0] ) );\r
 141                 usart_init( configDBG_USART_BAUDRATE );\r
 142         }\r
 143         #endif\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 /*\r
 148  * malloc, realloc and free are meant to be called through respectively\r
 149  * pvPortMalloc, pvPortRealloc and vPortFree.\r
 150  * The latter functions call the former ones from within sections where tasks\r
 151  * are suspended, so the latter functions are task-safe. __malloc_lock and\r
 152  * __malloc_unlock use the same mechanism to also keep the former functions\r
 153  * task-safe as they may be called directly from Newlib's functions.\r
 154  * However, all these functions are interrupt-unsafe and SHALL THEREFORE NOT BE\r
 155  * CALLED FROM WITHIN AN INTERRUPT, because __malloc_lock and __malloc_unlock do\r
 156  * not call portENTER_CRITICAL and portEXIT_CRITICAL in order not to disable\r
 157  * interrupts during memory allocation management as this may be a very time-\r
 158  * consuming process.\r
 159  */\r
 160 \r
 161 /*\r
 162  * Lock routine called by Newlib on malloc / realloc / free entry to guarantee a\r
 163  * safe section as memory allocation management uses global data.\r
 164  * See the aforementioned details.\r
 165  */\r
 166 void __malloc_lock(struct _reent *ptr)\r
 167 {\r
 168         vTaskSuspendAll();\r
 169 }\r
 170 \r
 171 /*\r
 172  * Unlock routine called by Newlib on malloc / realloc / free exit to guarantee\r
 173  * a safe section as memory allocation management uses global data.\r
 174  * See the aforementioned details.\r
 175  */\r
 176 void __malloc_unlock(struct _reent *ptr)\r
 177 {\r
 178         xTaskResumeAll();\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 /* Added as there is no such function in FreeRTOS. */\r
 183 void *pvPortRealloc( void *pv, size_t xWantedSize )\r
 184 {\r
 185 void *pvReturn;\r
 186 \r
 187         vTaskSuspendAll();\r
 188         {\r
 189                 pvReturn = realloc( pv, xWantedSize );\r
 190         }\r
 191         xTaskResumeAll();\r
 192 \r
 193         return pvReturn;\r
 194 }\r
 195 /*-----------------------------------------------------------*/\r
 196 \r
 197 /* The cooperative scheduler requires a normal IRQ service routine to\r
 198 simply increment the system tick. */\r
 199 /* The preemptive scheduler is defined as "naked" as the full context is saved\r
 200 on entry as part of the context switch. */\r
 201 __attribute__((__naked__)) static void vTick( void )\r
 202 {\r
 203         /* Save the context of the interrupted task. */\r
 204         portSAVE_CONTEXT_OS_INT();\r
 205 \r
 206         #if( configTICK_USE_TC==1 )\r
 207                 /* Clear the interrupt flag. */\r
 208                 prvClearTcInt();\r
 209         #else\r
 210                 /* Schedule the COUNT&COMPARE match interrupt in (configCPU_CLOCK_HZ/configTICK_RATE_HZ)\r
 211                 clock cycles from now. */\r
 212                 prvScheduleNextTick();\r
 213         #endif\r
 214 \r
 215         /* Because FreeRTOS is not supposed to run with nested interrupts, put all OS\r
 216         calls in a critical section . */\r
 217         portENTER_CRITICAL();\r
 218                 vTaskIncrementTick();\r
 219         portEXIT_CRITICAL();\r
 220 \r
 221         /* Restore the context of the "elected task". */\r
 222         portRESTORE_CONTEXT_OS_INT();\r
 223 }\r
 224 /*-----------------------------------------------------------*/\r
 225 \r
 226 __attribute__((__naked__)) void SCALLYield( void )\r
 227 {\r
 228         /* Save the context of the interrupted task. */\r
 229         portSAVE_CONTEXT_SCALL();\r
 230         vTaskSwitchContext();\r
 231         portRESTORE_CONTEXT_SCALL();\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 /* The code generated by the GCC compiler uses the stack in different ways at\r
 236 different optimisation levels.  The interrupt flags can therefore not always\r
 237 be saved to the stack.  Instead the critical section nesting level is stored\r
 238 in a variable, which is then saved as part of the stack context. */\r
 239 __attribute__((__noinline__)) void vPortEnterCritical( void )\r
 240 {\r
 241         /* Disable interrupts */\r
 242         portDISABLE_INTERRUPTS();\r
 243 \r
 244         /* Now interrupts are disabled ulCriticalNesting can be accessed\r
 245          directly.  Increment ulCriticalNesting to keep a count of how many times\r
 246          portENTER_CRITICAL() has been called. */\r
 247         ulCriticalNesting++;\r
 248 }\r
 249 /*-----------------------------------------------------------*/\r
 250 \r
 251 __attribute__((__noinline__)) void vPortExitCritical( void )\r
 252 {\r
 253         if(ulCriticalNesting > portNO_CRITICAL_NESTING)\r
 254         {\r
 255                 ulCriticalNesting--;\r
 256                 if( ulCriticalNesting == portNO_CRITICAL_NESTING )\r
 257                 {\r
 258                         /* Enable all interrupt/exception. */\r
 259                         portENABLE_INTERRUPTS();\r
 260                 }\r
 261         }\r
 262 }\r
 263 /*-----------------------------------------------------------*/\r
 264 \r
 265 /*\r
 266  * Initialise the stack of a task to look exactly as if a call to\r
 267  * portSAVE_CONTEXT had been called.\r
 268  *\r
 269  * See header file for description.\r
 270  */\r
 271 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 272 {\r
 273         /* Setup the initial stack of the task.  The stack is set exactly as\r
 274         expected by the portRESTORE_CONTEXT() macro. */\r
 275 \r
 276         /* When the task starts, it will expect to find the function parameter in R12. */\r
 277         pxTopOfStack--;\r
 278         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x08080808;                                        /* R8 */\r
 279         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x09090909;                                        /* R9 */\r
 280         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x0A0A0A0A;                                        /* R10 */\r
 281         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x0B0B0B0B;                                        /* R11 */\r
 282         *pxTopOfStack-- = ( portSTACK_TYPE ) pvParameters;                                      /* R12 */\r
 283         *pxTopOfStack-- = ( portSTACK_TYPE ) 0xDEADBEEF;                                        /* R14/LR */\r
 284         *pxTopOfStack-- = ( portSTACK_TYPE ) pxCode + portINSTRUCTION_SIZE; /* R15/PC */\r
 285         *pxTopOfStack-- = ( portSTACK_TYPE ) portINITIAL_SR;                            /* SR */\r
 286         *pxTopOfStack-- = ( portSTACK_TYPE ) 0xFF0000FF;                                        /* R0 */\r
 287         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x01010101;                                        /* R1 */\r
 288         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x02020202;                                        /* R2 */\r
 289         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x03030303;                                        /* R3 */\r
 290         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x04040404;                                        /* R4 */\r
 291         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x05050505;                                        /* R5 */\r
 292         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x06060606;                                        /* R6 */\r
 293         *pxTopOfStack-- = ( portSTACK_TYPE ) 0x07070707;                                        /* R7 */\r
 294         *pxTopOfStack = ( portSTACK_TYPE ) portNO_CRITICAL_NESTING;                     /* ulCriticalNesting */\r
 295 \r
 296         return pxTopOfStack;\r
 297 }\r
 298 /*-----------------------------------------------------------*/\r
 299 \r
 300 portBASE_TYPE xPortStartScheduler( void )\r
 301 {\r
 302         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 303         here already. */\r
 304         prvSetupTimerInterrupt();\r
 305 \r
 306         /* Start the first task. */\r
 307         portRESTORE_CONTEXT();\r
 308 \r
 309         /* Should not get here! */\r
 310         return 0;\r
 311 }\r
 312 /*-----------------------------------------------------------*/\r
 313 \r
 314 void vPortEndScheduler( void )\r
 315 {\r
 316         /* It is unlikely that the AVR32 port will require this function as there\r
 317         is nothing to return to.  */\r
 318 }\r
 319 /*-----------------------------------------------------------*/\r
 320 \r
 321 /* Schedule the COUNT&COMPARE match interrupt in (configCPU_CLOCK_HZ/configTICK_RATE_HZ)\r
 322 clock cycles from now. */\r
 323 #if( configTICK_USE_TC==0 )\r
 324         static void prvScheduleFirstTick(void)\r
 325         {\r
 326                 unsigned long lCycles;\r
 327 \r
 328                 lCycles = Get_system_register(AVR32_COUNT);\r
 329                 lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);\r
 330                 // If lCycles ends up to be 0, make it 1 so that the COMPARE and exception\r
 331                 // generation feature does not get disabled.\r
 332                 if(0 == lCycles)\r
 333                 {\r
 334                         lCycles++;\r
 335                 }\r
 336                 Set_system_register(AVR32_COMPARE, lCycles);\r
 337         }\r
 338         \r
 339         __attribute__((__noinline__)) static void prvScheduleNextTick(void)\r
 340         {\r
 341                 unsigned long lCycles, lCount;\r
 342 \r
 343                 lCycles = Get_system_register(AVR32_COMPARE);\r
 344                 lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);\r
 345                 // If lCycles ends up to be 0, make it 1 so that the COMPARE and exception\r
 346                 // generation feature does not get disabled.\r
 347                 if(0 == lCycles)\r
 348                 {\r
 349                         lCycles++;\r
 350                 }\r
 351                 lCount = Get_system_register(AVR32_COUNT);\r
 352                 if( lCycles < lCount )\r
 353                 {               // We missed a tick, recover for the next.\r
 354                         lCycles += (configCPU_CLOCK_HZ/configTICK_RATE_HZ);\r
 355                 }\r
 356                 Set_system_register(AVR32_COMPARE, lCycles);\r
 357         }\r
 358 #else\r
 359         __attribute__((__noinline__)) static void prvClearTcInt(void)\r
 360         {\r
 361                 AVR32_TC.channel[configTICK_TC_CHANNEL].sr;\r
 362         }\r
 363 #endif\r
 364 /*-----------------------------------------------------------*/\r
 365 \r
 366 /* Setup the timer to generate the tick interrupts. */\r
 367 static void prvSetupTimerInterrupt(void)\r
 368 {\r
 369 #if( configTICK_USE_TC==1 )\r
 370 \r
 371         volatile avr32_tc_t *tc = &AVR32_TC;\r
 372 \r
 373         // Options for waveform genration.\r
 374         tc_waveform_opt_t waveform_opt =\r
 375         {\r
 376         .channel  = configTICK_TC_CHANNEL,             /* Channel selection. */\r
 377 \r
 378         .bswtrg   = TC_EVT_EFFECT_NOOP,                /* Software trigger effect on TIOB. */\r
 379         .beevt    = TC_EVT_EFFECT_NOOP,                /* External event effect on TIOB. */\r
 380         .bcpc     = TC_EVT_EFFECT_NOOP,                /* RC compare effect on TIOB. */\r
 381         .bcpb     = TC_EVT_EFFECT_NOOP,                /* RB compare effect on TIOB. */\r
 382 \r
 383         .aswtrg   = TC_EVT_EFFECT_NOOP,                /* Software trigger effect on TIOA. */\r
 384         .aeevt    = TC_EVT_EFFECT_NOOP,                /* External event effect on TIOA. */\r
 385         .acpc     = TC_EVT_EFFECT_NOOP,                /* RC compare effect on TIOA: toggle. */\r
 386         .acpa     = TC_EVT_EFFECT_NOOP,                /* RA compare effect on TIOA: toggle (other possibilities are none, set and clear). */\r
 387 \r
 388         .wavsel   = TC_WAVEFORM_SEL_UP_MODE_RC_TRIGGER,/* Waveform selection: Up mode without automatic trigger on RC compare. */\r
 389         .enetrg   = FALSE,                             /* External event trigger enable. */\r
 390         .eevt     = 0,                                 /* External event selection. */\r
 391         .eevtedg  = TC_SEL_NO_EDGE,                    /* External event edge selection. */\r
 392         .cpcdis   = FALSE,                             /* Counter disable when RC compare. */\r
 393         .cpcstop  = FALSE,                             /* Counter clock stopped with RC compare. */\r
 394 \r
 395         .burst    = FALSE,                             /* Burst signal selection. */\r
 396         .clki     = FALSE,                             /* Clock inversion. */\r
 397         .tcclks   = TC_CLOCK_SOURCE_TC2                /* Internal source clock 2. */\r
 398         };\r
 399 \r
 400         tc_interrupt_t tc_interrupt =\r
 401         {\r
 402                 .etrgs=0,\r
 403                 .ldrbs=0,\r
 404                 .ldras=0,\r
 405                 .cpcs =1,\r
 406                 .cpbs =0,\r
 407                 .cpas =0,\r
 408                 .lovrs=0,\r
 409                 .covfs=0,\r
 410         };\r
 411 \r
 412 #endif\r
 413 \r
 414         /* Disable all interrupt/exception. */\r
 415         portDISABLE_INTERRUPTS();\r
 416 \r
 417         /* Register the compare interrupt handler to the interrupt controller and\r
 418         enable the compare interrupt. */\r
 419 \r
 420         #if( configTICK_USE_TC==1 )\r
 421         {\r
 422                 INTC_register_interrupt(&vTick, configTICK_TC_IRQ, INT0);\r
 423 \r
 424                 /* Initialize the timer/counter. */\r
 425                 tc_init_waveform(tc, &waveform_opt);\r
 426 \r
 427                 /* Set the compare triggers.\r
 428                 Remember TC counter is 16-bits, so counting second is not possible!\r
 429                 That's why we configure it to count ms. */\r
 430                 tc_write_rc( tc, configTICK_TC_CHANNEL, ( configPBA_CLOCK_HZ / 4) / configTICK_RATE_HZ );\r
 431 \r
 432                 tc_configure_interrupts( tc, configTICK_TC_CHANNEL, &tc_interrupt );\r
 433 \r
 434                 /* Start the timer/counter. */\r
 435                 tc_start(tc, configTICK_TC_CHANNEL);\r
 436         }\r
 437         #else\r
 438         {\r
 439                 INTC_register_interrupt(&vTick, AVR32_CORE_COMPARE_IRQ, INT0);\r
 440                 prvScheduleFirstTick();\r
 441         }\r
 442         #endif\r
 443 }\r