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

   1 /*\r
   2         FreeRTOS V4.0.1 - Copyright (C) 2003-2006 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS distribution.\r
   5 \r
   6         FreeRTOS is free software; you can redistribute it and/or modify\r
   7         it under the terms of the GNU General Public License as published by\r
   8         the Free Software Foundation; either version 2 of the License, or\r
   9         (at your option) any later version.\r
  10 \r
  11         FreeRTOS is distributed in the hope that it will be useful,\r
  12         but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14         GNU General Public License for more details.\r
  15 \r
  16         You should have received a copy of the GNU General Public License\r
  17         along with FreeRTOS; if not, write to the Free Software\r
  18         Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  19 \r
  20         A special exception to the GPL can be applied should you wish to distribute\r
  21         a combined work that includes FreeRTOS, without being obliged to provide\r
  22         the source code for any proprietary components.  See the licensing section \r
  23         of http://www.FreeRTOS.org for full details of how and when the exception\r
  24         can be applied.\r
  25 \r
  26         ***************************************************************************\r
  27         See http://www.FreeRTOS.org for documentation, latest information, license \r
  28         and contact details.  Please ensure to read the configuration and relevant \r
  29         port sections of the online documentation.\r
  30         ***************************************************************************\r
  31 */\r
  32 \r
  33 /* \r
  34 \r
  35 Changes from V2.6.0\r
  36 \r
  37         + AVR port - Replaced the inb() and outb() functions with direct memory\r
  38           access.  This allows the port to be built with the 20050414 build of\r
  39           WinAVR.\r
  40 */\r
  41 \r
  42 #include <stdlib.h>\r
  43 #include <avr/interrupt.h>\r
  44 \r
  45 #include "FreeRTOS.h"\r
  46 #include "task.h"\r
  47 \r
  48 /*-----------------------------------------------------------\r
  49  * Implementation of functions defined in portable.h for the AVR port.\r
  50  *----------------------------------------------------------*/\r
  51 \r
  52 /* Start tasks with interrupts enables. */\r
  53 #define portFLAGS_INT_ENABLED                                   ( ( portSTACK_TYPE ) 0x80 )\r
  54 \r
  55 /* Hardware constants for timer 1. */\r
  56 #define portCLEAR_COUNTER_ON_MATCH                              ( ( unsigned portCHAR ) 0x08 )\r
  57 #define portPRESCALE_64                                                 ( ( unsigned portCHAR ) 0x03 )\r
  58 #define portCLOCK_PRESCALER                                             ( ( unsigned portLONG ) 64 )\r
  59 #define portCOMPARE_MATCH_A_INTERRUPT_ENABLE    ( ( unsigned portCHAR ) 0x10 )\r
  60 \r
  61 /*-----------------------------------------------------------*/\r
  62 \r
  63 /* We require the address of the pxCurrentTCB variable, but don't want to know\r
  64 any details of its type. */\r
  65 typedef void tskTCB;\r
  66 extern volatile tskTCB * volatile pxCurrentTCB;\r
  67 \r
  68 /*-----------------------------------------------------------*/\r
  69 \r
  70 /* \r
  71  * Macro to save all the general purpose registers, the save the stack pointer\r
  72  * into the TCB.  \r
  73  * \r
  74  * The first thing we do is save the flags then disable interrupts.  This is to \r
  75  * guard our stack against having a context switch interrupt after we have already \r
  76  * pushed the registers onto the stack - causing the 32 registers to be on the \r
  77  * stack twice. \r
  78  * \r
  79  * r1 is set to zero as the compiler expects it to be thus, however some\r
  80  * of the math routines make use of R1. \r
  81  * \r
  82  * The interrupts will have been disabled during the call to portSAVE_CONTEXT()\r
  83  * so we need not worry about reading/writing to the stack pointer. \r
  84  */\r
  85 \r
  86 #define portSAVE_CONTEXT()                                                                      \\r
  87         asm volatile (  "push   r0                                              \n\t"   \\r
  88                                         "in             r0, __SREG__                    \n\t"   \\r
  89                                         "cli                                                    \n\t"   \\r
  90                                         "push   r0                                              \n\t"   \\r
  91                                         "push   r1                                              \n\t"   \\r
  92                                         "clr    r1                                              \n\t"   \\r
  93                                         "push   r2                                              \n\t"   \\r
  94                                         "push   r3                                              \n\t"   \\r
  95                                         "push   r4                                              \n\t"   \\r
  96                                         "push   r5                                              \n\t"   \\r
  97                                         "push   r6                                              \n\t"   \\r
  98                                         "push   r7                                              \n\t"   \\r
  99                                         "push   r8                                              \n\t"   \\r
 100                                         "push   r9                                              \n\t"   \\r
 101                                         "push   r10                                             \n\t"   \\r
 102                                         "push   r11                                             \n\t"   \\r
 103                                         "push   r12                                             \n\t"   \\r
 104                                         "push   r13                                             \n\t"   \\r
 105                                         "push   r14                                             \n\t"   \\r
 106                                         "push   r15                                             \n\t"   \\r
 107                                         "push   r16                                             \n\t"   \\r
 108                                         "push   r17                                             \n\t"   \\r
 109                                         "push   r18                                             \n\t"   \\r
 110                                         "push   r19                                             \n\t"   \\r
 111                                         "push   r20                                             \n\t"   \\r
 112                                         "push   r21                                             \n\t"   \\r
 113                                         "push   r22                                             \n\t"   \\r
 114                                         "push   r23                                             \n\t"   \\r
 115                                         "push   r24                                             \n\t"   \\r
 116                                         "push   r25                                             \n\t"   \\r
 117                                         "push   r26                                             \n\t"   \\r
 118                                         "push   r27                                             \n\t"   \\r
 119                                         "push   r28                                             \n\t"   \\r
 120                                         "push   r29                                             \n\t"   \\r
 121                                         "push   r30                                             \n\t"   \\r
 122                                         "push   r31                                             \n\t"   \\r
 123                                         "lds    r26, pxCurrentTCB               \n\t"   \\r
 124                                         "lds    r27, pxCurrentTCB + 1   \n\t"   \\r
 125                                         "in             r0, 0x3d                                \n\t"   \\r
 126                                         "st             x+, r0                                  \n\t"   \\r
 127                                         "in             r0, 0x3e                                \n\t"   \\r
 128                                         "st             x+, r0                                  \n\t"   \\r
 129                                 );\r
 130 \r
 131 /* \r
 132  * Opposite to portSAVE_CONTEXT().  Interrupts will have been disabled during\r
 133  * the context save so we can write to the stack pointer. \r
 134  */\r
 135 \r
 136 #define portRESTORE_CONTEXT()                                                           \\r
 137         asm volatile (  "lds    r26, pxCurrentTCB               \n\t"   \\r
 138                                         "lds    r27, pxCurrentTCB + 1   \n\t"   \\r
 139                                         "ld             r28, x+                                 \n\t"   \\r
 140                                         "out    __SP_L__, r28                   \n\t"   \\r
 141                                         "ld             r29, x+                                 \n\t"   \\r
 142                                         "out    __SP_H__, r29                   \n\t"   \\r
 143                                         "pop    r31                                             \n\t"   \\r
 144                                         "pop    r30                                             \n\t"   \\r
 145                                         "pop    r29                                             \n\t"   \\r
 146                                         "pop    r28                                             \n\t"   \\r
 147                                         "pop    r27                                             \n\t"   \\r
 148                                         "pop    r26                                             \n\t"   \\r
 149                                         "pop    r25                                             \n\t"   \\r
 150                                         "pop    r24                                             \n\t"   \\r
 151                                         "pop    r23                                             \n\t"   \\r
 152                                         "pop    r22                                             \n\t"   \\r
 153                                         "pop    r21                                             \n\t"   \\r
 154                                         "pop    r20                                             \n\t"   \\r
 155                                         "pop    r19                                             \n\t"   \\r
 156                                         "pop    r18                                             \n\t"   \\r
 157                                         "pop    r17                                             \n\t"   \\r
 158                                         "pop    r16                                             \n\t"   \\r
 159                                         "pop    r15                                             \n\t"   \\r
 160                                         "pop    r14                                             \n\t"   \\r
 161                                         "pop    r13                                             \n\t"   \\r
 162                                         "pop    r12                                             \n\t"   \\r
 163                                         "pop    r11                                             \n\t"   \\r
 164                                         "pop    r10                                             \n\t"   \\r
 165                                         "pop    r9                                              \n\t"   \\r
 166                                         "pop    r8                                              \n\t"   \\r
 167                                         "pop    r7                                              \n\t"   \\r
 168                                         "pop    r6                                              \n\t"   \\r
 169                                         "pop    r5                                              \n\t"   \\r
 170                                         "pop    r4                                              \n\t"   \\r
 171                                         "pop    r3                                              \n\t"   \\r
 172                                         "pop    r2                                              \n\t"   \\r
 173                                         "pop    r1                                              \n\t"   \\r
 174                                         "pop    r0                                              \n\t"   \\r
 175                                         "out    __SREG__, r0                    \n\t"   \\r
 176                                         "pop    r0                                              \n\t"   \\r
 177                                 );\r
 178 \r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 /*\r
 182  * Perform hardware setup to enable ticks from timer 1, compare match A.\r
 183  */\r
 184 static void prvSetupTimerInterrupt( void );\r
 185 /*-----------------------------------------------------------*/\r
 186 \r
 187 /* \r
 188  * See header file for description. \r
 189  */\r
 190 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 191 {\r
 192 unsigned portSHORT usAddress;\r
 193 \r
 194         /* Place a few bytes of known values on the bottom of the stack. \r
 195         This is just useful for debugging. */\r
 196 \r
 197         *pxTopOfStack = 0x11;\r
 198         pxTopOfStack--;\r
 199         *pxTopOfStack = 0x22;\r
 200         pxTopOfStack--;\r
 201         *pxTopOfStack = 0x33;\r
 202         pxTopOfStack--;\r
 203 \r
 204         /* Simulate how the stack would look after a call to vPortYield() generated by \r
 205         the compiler. */\r
 206 \r
 207         /*lint -e950 -e611 -e923 Lint doesn't like this much - but nothing I can do about it. */\r
 208 \r
 209         /* The start of the task code will be popped off the stack last, so place\r
 210         it on first. */\r
 211         usAddress = ( unsigned portSHORT ) pxCode;\r
 212         *pxTopOfStack = ( portSTACK_TYPE ) ( usAddress & ( unsigned portSHORT ) 0x00ff );\r
 213         pxTopOfStack--;\r
 214 \r
 215         usAddress >>= 8;\r
 216         *pxTopOfStack = ( portSTACK_TYPE ) ( usAddress & ( unsigned portSHORT ) 0x00ff );\r
 217         pxTopOfStack--;\r
 218 \r
 219         /* Next simulate the stack as if after a call to portSAVE_CONTEXT().  \r
 220         portSAVE_CONTEXT places the flags on the stack immediately after r0\r
 221         to ensure the interrupts get disabled as soon as possible, and so ensuring\r
 222         the stack use is minimal should a context switch interrupt occur. */\r
 223         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;        /* R0 */\r
 224         pxTopOfStack--;\r
 225         *pxTopOfStack = portFLAGS_INT_ENABLED;\r
 226         pxTopOfStack--;\r
 227 \r
 228 \r
 229         /* Now the remaining registers.   The compiler expects R1 to be 0. */\r
 230         *pxTopOfStack = ( portSTACK_TYPE ) 0x00;        /* R1 */\r
 231         pxTopOfStack--;\r
 232         *pxTopOfStack = ( portSTACK_TYPE ) 0x02;        /* R2 */\r
 233         pxTopOfStack--;\r
 234         *pxTopOfStack = ( portSTACK_TYPE ) 0x03;        /* R3 */\r
 235         pxTopOfStack--;\r
 236         *pxTopOfStack = ( portSTACK_TYPE ) 0x04;        /* R4 */\r
 237         pxTopOfStack--;\r
 238         *pxTopOfStack = ( portSTACK_TYPE ) 0x05;        /* R5 */\r
 239         pxTopOfStack--;\r
 240         *pxTopOfStack = ( portSTACK_TYPE ) 0x06;        /* R6 */\r
 241         pxTopOfStack--;\r
 242         *pxTopOfStack = ( portSTACK_TYPE ) 0x07;        /* R7 */\r
 243         pxTopOfStack--;\r
 244         *pxTopOfStack = ( portSTACK_TYPE ) 0x08;        /* R8 */\r
 245         pxTopOfStack--;\r
 246         *pxTopOfStack = ( portSTACK_TYPE ) 0x09;        /* R9 */\r
 247         pxTopOfStack--;\r
 248         *pxTopOfStack = ( portSTACK_TYPE ) 0x10;        /* R10 */\r
 249         pxTopOfStack--;\r
 250         *pxTopOfStack = ( portSTACK_TYPE ) 0x11;        /* R11 */\r
 251         pxTopOfStack--;\r
 252         *pxTopOfStack = ( portSTACK_TYPE ) 0x12;        /* R12 */\r
 253         pxTopOfStack--;\r
 254         *pxTopOfStack = ( portSTACK_TYPE ) 0x13;        /* R13 */\r
 255         pxTopOfStack--;\r
 256         *pxTopOfStack = ( portSTACK_TYPE ) 0x14;        /* R14 */\r
 257         pxTopOfStack--;\r
 258         *pxTopOfStack = ( portSTACK_TYPE ) 0x15;        /* R15 */\r
 259         pxTopOfStack--;\r
 260         *pxTopOfStack = ( portSTACK_TYPE ) 0x16;        /* R16 */\r
 261         pxTopOfStack--;\r
 262         *pxTopOfStack = ( portSTACK_TYPE ) 0x17;        /* R17 */\r
 263         pxTopOfStack--;\r
 264         *pxTopOfStack = ( portSTACK_TYPE ) 0x18;        /* R18 */\r
 265         pxTopOfStack--;\r
 266         *pxTopOfStack = ( portSTACK_TYPE ) 0x19;        /* R19 */\r
 267         pxTopOfStack--;\r
 268         *pxTopOfStack = ( portSTACK_TYPE ) 0x20;        /* R20 */\r
 269         pxTopOfStack--;\r
 270         *pxTopOfStack = ( portSTACK_TYPE ) 0x21;        /* R21 */\r
 271         pxTopOfStack--;\r
 272         *pxTopOfStack = ( portSTACK_TYPE ) 0x22;        /* R22 */\r
 273         pxTopOfStack--;\r
 274         *pxTopOfStack = ( portSTACK_TYPE ) 0x23;        /* R23 */\r
 275         pxTopOfStack--;\r
 276 \r
 277         /* Place the parameter on the stack in the expected location. */\r
 278         usAddress = ( unsigned portSHORT ) pvParameters;\r
 279         *pxTopOfStack = ( portSTACK_TYPE ) ( usAddress & ( unsigned portSHORT ) 0x00ff );\r
 280         pxTopOfStack--;\r
 281 \r
 282         usAddress >>= 8;\r
 283         *pxTopOfStack = ( portSTACK_TYPE ) ( usAddress & ( unsigned portSHORT ) 0x00ff );\r
 284         pxTopOfStack--;\r
 285 \r
 286         *pxTopOfStack = ( portSTACK_TYPE ) 0x26;        /* R26 X */\r
 287         pxTopOfStack--;\r
 288         *pxTopOfStack = ( portSTACK_TYPE ) 0x27;        /* R27 */\r
 289         pxTopOfStack--;\r
 290         *pxTopOfStack = ( portSTACK_TYPE ) 0x28;        /* R28 Y */\r
 291         pxTopOfStack--;\r
 292         *pxTopOfStack = ( portSTACK_TYPE ) 0x29;        /* R29 */\r
 293         pxTopOfStack--;\r
 294         *pxTopOfStack = ( portSTACK_TYPE ) 0x30;        /* R30 Z */\r
 295         pxTopOfStack--;\r
 296         *pxTopOfStack = ( portSTACK_TYPE ) 0x031;       /* R31 */\r
 297         pxTopOfStack--;\r
 298 \r
 299         /*lint +e950 +e611 +e923 */\r
 300 \r
 301         return pxTopOfStack;\r
 302 }\r
 303 /*-----------------------------------------------------------*/\r
 304 \r
 305 portBASE_TYPE xPortStartScheduler( void )\r
 306 {\r
 307         /* In this port we ignore the parameter and use the configUSE_PREEMPTION\r
 308         definition instead. */\r
 309 \r
 310         /* Setup the hardware to generate the tick. */\r
 311         prvSetupTimerInterrupt();\r
 312 \r
 313         /* Restore the context of the first task that is going to run. */\r
 314         portRESTORE_CONTEXT();\r
 315 \r
 316         /* Simulate a function call end as generated by the compiler.  We will now\r
 317         jump to the start of the task the context of which we have just restored. */\r
 318         asm volatile ( "ret" );\r
 319 \r
 320         /* Should not get here. */\r
 321         return pdTRUE;\r
 322 }\r
 323 /*-----------------------------------------------------------*/\r
 324 \r
 325 void vPortEndScheduler( void )\r
 326 {\r
 327         /* It is unlikely that the AVR port will get stopped.  If required simply\r
 328         disable the tick interrupt here. */\r
 329 }\r
 330 /*-----------------------------------------------------------*/\r
 331 \r
 332 /*\r
 333  * Manual context switch.  The first thing we do is save the registers so we\r
 334  * can use a naked attribute.\r
 335  */\r
 336 void vPortYield( void ) __attribute__ ( ( naked ) );\r
 337 void vPortYield( void )\r
 338 {\r
 339         portSAVE_CONTEXT();\r
 340         vTaskSwitchContext();\r
 341         portRESTORE_CONTEXT();\r
 342 \r
 343         asm volatile ( "ret" );\r
 344 }\r
 345 /*-----------------------------------------------------------*/\r
 346 \r
 347 /*\r
 348  * Context switch function used by the tick.  This must be identical to \r
 349  * vPortYield() from the call to vTaskSwitchContext() onwards.  The only\r
 350  * difference from vPortYield() is the tick count is incremented as the\r
 351  * call comes from the tick ISR.\r
 352  */\r
 353 void vPortYieldFromTick( void ) __attribute__ ( ( naked ) );\r
 354 void vPortYieldFromTick( void )\r
 355 {\r
 356         portSAVE_CONTEXT();\r
 357         vTaskIncrementTick();\r
 358         vTaskSwitchContext();\r
 359         portRESTORE_CONTEXT();\r
 360 \r
 361         asm volatile ( "ret" );\r
 362 }\r
 363 /*-----------------------------------------------------------*/\r
 364 \r
 365 /*\r
 366  * Setup timer 1 compare match A to generate a tick interrupt.\r
 367  */\r
 368 static void prvSetupTimerInterrupt( void )\r
 369 {\r
 370 unsigned portLONG ulCompareMatch;\r
 371 unsigned portCHAR ucHighByte, ucLowByte;\r
 372 \r
 373         /* Using 16bit timer 1 to generate the tick.  Correct fuses must be\r
 374         selected for the configCPU_CLOCK_HZ clock. */\r
 375 \r
 376         ulCompareMatch = configCPU_CLOCK_HZ / configTICK_RATE_HZ;\r
 377 \r
 378         /* We only have 16 bits so have to scale to get our required tick rate. */\r
 379         ulCompareMatch /= portCLOCK_PRESCALER;\r
 380 \r
 381         /* Adjust for correct value. */\r
 382         ulCompareMatch -= ( unsigned portLONG ) 1;\r
 383 \r
 384         /* Setup compare match value for compare match A.  Interrupts are disabled \r
 385         before this is called so we need not worry here. */\r
 386         ucLowByte = ( unsigned portCHAR ) ( ulCompareMatch & ( unsigned portLONG ) 0xff );\r
 387         ulCompareMatch >>= 8;\r
 388         ucHighByte = ( unsigned portCHAR ) ( ulCompareMatch & ( unsigned portLONG ) 0xff );\r
 389         OCR1AH = ucHighByte;\r
 390         OCR1AL = ucLowByte;\r
 391 \r
 392         /* Setup clock source and compare match behaviour. */\r
 393         ucLowByte = portCLEAR_COUNTER_ON_MATCH | portPRESCALE_64;\r
 394         TCCR1B = ucLowByte;\r
 395 \r
 396         /* Enable the interrupt - this is okay as interrupt are currently globally\r
 397         disabled. */\r
 398         ucLowByte = TIMSK;\r
 399         ucLowByte |= portCOMPARE_MATCH_A_INTERRUPT_ENABLE;\r
 400         TIMSK = ucLowByte;\r
 401 }\r
 402 /*-----------------------------------------------------------*/\r
 403 \r
 404 #if configUSE_PREEMPTION == 1\r
 405 \r
 406         /*\r
 407          * Tick ISR for preemptive scheduler.  We can use a naked attribute as\r
 408          * the context is saved at the start of vPortYieldFromTick().  The tick\r
 409          * count is incremented after the context is saved.\r
 410          */\r
 411         void SIG_OUTPUT_COMPARE1A( void ) __attribute__ ( ( signal, naked ) );\r
 412         void SIG_OUTPUT_COMPARE1A( void )\r
 413         {\r
 414                 vPortYieldFromTick();\r
 415                 asm volatile ( "reti" );\r
 416         }\r
 417 #else\r
 418 \r
 419         /*\r
 420          * Tick ISR for the cooperative scheduler.  All this does is increment the\r
 421          * tick count.  We don't need to switch context, this can only be done by\r
 422          * manual calls to taskYIELD();\r
 423          */\r
 424         void SIG_OUTPUT_COMPARE1A( void ) __attribute__ ( ( signal ) );\r
 425         void SIG_OUTPUT_COMPARE1A( void )\r
 426         {\r
 427                 vTaskIncrementTick();\r
 428         }\r
 429 #endif\r
 430 \r
 431 \r
 432         \r