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

   1 /*\r
   2         FreeRTOS.org V4.8.0 - Copyright (C) 2003-2008 Richard Barry.\r
   3 \r
   4         This file is part of the FreeRTOS.org distribution.\r
   5 \r
   6         FreeRTOS.org 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.org 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.org; 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.org, 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         ***************************************************************************\r
  28         *                                                                                                                                                 *\r
  29         * SAVE TIME AND MONEY!  Why not get us to quote to get FreeRTOS.org               *\r
  30         * running on your hardware - or even write all or part of your application*\r
  31         * for you?  See http://www.OpenRTOS.com for details.                                      *\r
  32         *                                                                                                                                                 *\r
  33         ***************************************************************************\r
  34         ***************************************************************************\r
  35 \r
  36         Please ensure to read the configuration and relevant port sections of the\r
  37         online documentation.\r
  38 \r
  39         http://www.FreeRTOS.org - Documentation, latest information, license and \r
  40         contact details.\r
  41 \r
  42         http://www.SafeRTOS.com - A version that is certified for use in safety \r
  43         critical systems.\r
  44 \r
  45         http://www.OpenRTOS.com - Commercial support, development, porting, \r
  46         licensing and training services.\r
  47 */\r
  48 \r
  49 /*-----------------------------------------------------------\r
  50  * Implementation of functions defined in portable.h for the ARM CM3 port.\r
  51  *----------------------------------------------------------*/\r
  52 \r
  53 /* Scheduler includes. */\r
  54 #include "FreeRTOS.h"\r
  55 #include "task.h"\r
  56 \r
  57 /* For backward compatibility, ensure configKERNEL_INTERRUPT_PRIORITY is \r
  58 defined.  The value should also ensure backward compatibility.  \r
  59 FreeRTOS.org versions prior to V4.4.0 did not include this definition. */\r
  60 #ifndef configKERNEL_INTERRUPT_PRIORITY\r
  61         #define configKERNEL_INTERRUPT_PRIORITY 255\r
  62 #endif\r
  63 \r
  64 /* Constants required to manipulate the NVIC. */\r
  65 #define portNVIC_SYSTICK_CTRL           ( ( volatile unsigned portLONG *) 0xe000e010 )\r
  66 #define portNVIC_SYSTICK_LOAD           ( ( volatile unsigned portLONG *) 0xe000e014 )\r
  67 #define portNVIC_INT_CTRL                       ( ( volatile unsigned portLONG *) 0xe000ed04 )\r
  68 #define portNVIC_SYSPRI2                        ( ( volatile unsigned portLONG *) 0xe000ed20 )\r
  69 #define portNVIC_SYSTICK_CLK            0x00000004\r
  70 #define portNVIC_SYSTICK_INT            0x00000002\r
  71 #define portNVIC_SYSTICK_ENABLE         0x00000001\r
  72 #define portNVIC_PENDSVSET                      0x10000000\r
  73 #define portNVIC_PENDSV_PRI                     ( ( ( unsigned portLONG ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
  74 #define portNVIC_SYSTICK_PRI            ( ( ( unsigned portLONG ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
  75 \r
  76 /* Constants required to set up the initial stack. */\r
  77 #define portINITIAL_XPSR                        ( 0x01000000 )\r
  78 \r
  79 /* The priority used by the kernel is assigned to a variable to make access\r
  80 from inline assembler easier. */\r
  81 const unsigned portLONG ulKernelPriority = configKERNEL_INTERRUPT_PRIORITY;\r
  82 \r
  83 /* Each task maintains its own interrupt status in the critical nesting\r
  84 variable. */\r
  85 unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
  86 \r
  87 /* \r
  88  * Setup the timer to generate the tick interrupts.\r
  89  */\r
  90 static void prvSetupTimerInterrupt( void );\r
  91 \r
  92 /*\r
  93  * Exception handlers.\r
  94  */\r
  95 void xPortPendSVHandler( void ) __attribute__ (( naked ));\r
  96 void xPortSysTickHandler( void );\r
  97 void vPortSVCHandler( void ) __attribute__ (( naked ));\r
  98 \r
  99 /*\r
 100  * Start first task is a separate function so it can be tested in isolation.\r
 101  */\r
 102 void vPortStartFirstTask( unsigned long ulValue ) __attribute__ (( naked ));\r
 103 \r
 104 /*-----------------------------------------------------------*/\r
 105 \r
 106 /* \r
 107  * See header file for description. \r
 108  */\r
 109 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 110 {\r
 111         /* Simulate the stack frame as it would be created by a context switch\r
 112         interrupt. */\r
 113         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 114         pxTopOfStack--;\r
 115         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 116         pxTopOfStack--;\r
 117         *pxTopOfStack = 0;      /* LR */\r
 118         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 119         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 120         pxTopOfStack -= 9;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 121         *pxTopOfStack = 0x00000000; /* uxCriticalNesting. */\r
 122 \r
 123         return pxTopOfStack;\r
 124 }\r
 125 /*-----------------------------------------------------------*/\r
 126 \r
 127 void vPortSVCHandler( void )\r
 128 {\r
 129         asm volatile (\r
 130                                         "       ldr     r3, pxCurrentTCBConst2          \n" /* Restore the context. */\r
 131                                         "       ldr r1, [r3]                                    \n" /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */\r
 132                                         "       ldr r0, [r1]                                    \n" /* The first item in pxCurrentTCB is the task top of stack. */\r
 133                                         "       ldmia r0!, {r1, r4-r11}                 \n" /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */\r
 134                                         "       ldr r2, uxCriticalNestingConst2 \n" /* Restore the critical nesting count used by the task. */\r
 135                                         "       str r1, [r2]                                    \n"\r
 136                                         "       msr psp, r0                                             \n" /* Restore the task stack pointer. */\r
 137                                         "       orr r14, #0xd                                   \n"\r
 138                                         "       bx r14                                                  \n"\r
 139                                         "                                                                       \n"\r
 140                                         "       .align 2                                                \n"\r
 141                                         "pxCurrentTCBConst2: .word pxCurrentTCB                         \n"\r
 142                                         "uxCriticalNestingConst2: .word uxCriticalNesting       \n"\r
 143                                 );\r
 144 }\r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 void vPortStartFirstTask( unsigned long ulValue )\r
 148 {\r
 149         /* ulValue is used from the asm code, but the compiler does not know\r
 150         this so remove the warning. */\r
 151         ( void ) ulValue;\r
 152         \r
 153         asm volatile( \r
 154                                         "       msr msp, r0                                                             \n" /* Set the msp back to the start of the stack. */\r
 155                                         "       svc 0                                                                   \n" /* System call to start first task. */\r
 156                                 );\r
 157 }\r
 158 /*-----------------------------------------------------------*/\r
 159 \r
 160 /* \r
 161  * See header file for description. \r
 162  */\r
 163 portBASE_TYPE xPortStartScheduler( void )\r
 164 {\r
 165         /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */\r
 166         *(portNVIC_SYSPRI2) |= portNVIC_PENDSV_PRI;\r
 167         *(portNVIC_SYSPRI2) |= portNVIC_SYSTICK_PRI;\r
 168 \r
 169         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 170         here already. */\r
 171         prvSetupTimerInterrupt();\r
 172         \r
 173         /* Start the first task. */\r
 174         vPortStartFirstTask( *((unsigned portLONG *) 0 ) );\r
 175 \r
 176         /* Should not get here! */\r
 177         return 0;\r
 178 }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 void vPortEndScheduler( void )\r
 182 {\r
 183         /* It is unlikely that the CM3 port will require this function as there\r
 184         is nothing to return to.  */\r
 185 }\r
 186 /*-----------------------------------------------------------*/\r
 187 \r
 188 void vPortYieldFromISR( void )\r
 189 {\r
 190         /* Set a PendSV to request a context switch. */\r
 191         *(portNVIC_INT_CTRL) |= portNVIC_PENDSVSET;\r
 192 \r
 193         /* This function is also called in response to a Yield(), so we want\r
 194         the yield to occur immediately. */\r
 195         portENABLE_INTERRUPTS();\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 void vPortEnterCritical( void )\r
 200 {\r
 201         portDISABLE_INTERRUPTS();\r
 202         uxCriticalNesting++;\r
 203 }\r
 204 /*-----------------------------------------------------------*/\r
 205 \r
 206 void vPortExitCritical( void )\r
 207 {\r
 208         uxCriticalNesting--;\r
 209         if( uxCriticalNesting == 0 )\r
 210         {\r
 211                 portENABLE_INTERRUPTS();\r
 212         }\r
 213 }\r
 214 /*-----------------------------------------------------------*/\r
 215 \r
 216 void xPortPendSVHandler( void )\r
 217 {\r
 218         /* This is a naked function. */\r
 219 \r
 220         __asm volatile\r
 221         ( \r
 222         "       mrs r0, psp                                             \n" \r
 223         "                                                                       \n"\r
 224         "       ldr     r3, pxCurrentTCBConst           \n" /* Get the location of the current TCB. */\r
 225         "       ldr     r2, [r3]                                        \n"     \r
 226         "                                                                       \n"     \r
 227         "       ldr r1, uxCriticalNestingConst  \n" /* Save the remaining registers and the critical nesting count onto the task stack. */\r
 228         "       ldr r1, [r1]                                    \n"\r
 229         "       stmdb r0!, {r1,r4-r11}                  \n"\r
 230         "       str r0, [r2]                                    \n" /* Save the new top of stack into the first member of the TCB. */\r
 231         "                                                                       \n"\r
 232         "       stmdb sp!, {r3, r14}                    \n" \r
 233         "       bl vTaskSwitchContext                   \n"\r
 234         "       ldmia sp!, {r3, r14}                    \n"\r
 235         "                                                                       \n"     /* Restore the context, including the critical nesting count. */\r
 236         "       ldr r1, [r3]                                    \n" \r
 237         "       ldr r2, uxCriticalNestingConst  \n"\r
 238         "       ldr r0, [r1]                                    \n" /* The first item in pxCurrentTCB is the task top of stack. */\r
 239         "       ldmia r0!, {r1, r4-r11}                 \n" /* Pop the registers and the critical nesting count. */\r
 240         "       str r1, [r2]                                    \n" /* Save the new critical nesting value into ulCriticalNesting. */ \r
 241         "       msr psp, r0                                             \n" \r
 242         "       orr r14, #0xd                                   \n"\r
 243         "                                                                       \n"     /* Exit with interrupts in the state required by the task. */   \r
 244         "       cbnz r1, sv_disable_interrupts  \n" /* If the nesting count is greater than 0 we need to exit with interrupts masked. */\r
 245         "       bx r14                                                  \n"\r
 246         "                                                                       \n"\r
 247         "sv_disable_interrupts:                         \n" \r
 248         "       ldr r1, =ulKernelPriority               \n"\r
 249         "       ldr r1, [r1]                                    \n"\r
 250         "       msr     basepri, r1                                     \n"\r
 251         "       bx r14                                                  \n"\r
 252         "                                                                       \n"\r
 253         "       .align 2                                                \n"\r
 254         "pxCurrentTCBConst: .word pxCurrentTCB                          \n"\r
 255         "uxCriticalNestingConst: .word uxCriticalNesting        \n"\r
 256         );\r
 257 }\r
 258 /*-----------------------------------------------------------*/\r
 259 \r
 260 void xPortSysTickHandler( void )\r
 261 {\r
 262         vTaskIncrementTick();\r
 263         \r
 264         /* If using preemption, also force a context switch. */\r
 265         #if configUSE_PREEMPTION == 1\r
 266                 *(portNVIC_INT_CTRL) |= portNVIC_PENDSVSET;     \r
 267         #endif\r
 268 }\r
 269 /*-----------------------------------------------------------*/\r
 270 \r
 271 /*\r
 272  * Setup the systick timer to generate the tick interrupts at the required\r
 273  * frequency.\r
 274  */\r
 275 void prvSetupTimerInterrupt( void )\r
 276 {\r
 277         /* Configure SysTick to interrupt at the requested rate. */\r
 278         *(portNVIC_SYSTICK_LOAD) = configCPU_CLOCK_HZ / configTICK_RATE_HZ;\r
 279         *(portNVIC_SYSTICK_CTRL) = portNVIC_SYSTICK_CLK | portNVIC_SYSTICK_INT | portNVIC_SYSTICK_ENABLE;\r
 280 }\r
 281 /*-----------------------------------------------------------*/\r
 282 \r