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

   1 /*\r
   2     FreeRTOS V6.1.0 - Copyright (C) 2010 Real Time Engineers Ltd.\r
   3 \r
   4     ***************************************************************************\r
   5     *                                                                         *\r
   6     * If you are:                                                             *\r
   7     *                                                                         *\r
   8     *    + New to FreeRTOS,                                                   *\r
   9     *    + Wanting to learn FreeRTOS or multitasking in general quickly       *\r
  10     *    + Looking for basic training,                                        *\r
  11     *    + Wanting to improve your FreeRTOS skills and productivity           *\r
  12     *                                                                         *\r
  13     * then take a look at the FreeRTOS books - available as PDF or paperback  *\r
  14     *                                                                         *\r
  15     *        "Using the FreeRTOS Real Time Kernel - a Practical Guide"        *\r
  16     *                  http://www.FreeRTOS.org/Documentation                  *\r
  17     *                                                                         *\r
  18     * A pdf reference manual is also available.  Both are usually delivered   *\r
  19     * to your inbox within 20 minutes to two hours when purchased between 8am *\r
  20     * and 8pm GMT (although please allow up to 24 hours in case of            *\r
  21     * exceptional circumstances).  Thank you for your support!                *\r
  22     *                                                                         *\r
  23     ***************************************************************************\r
  24 \r
  25     This file is part of the FreeRTOS distribution.\r
  26 \r
  27     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  28     the terms of the GNU General Public License (version 2) as published by the\r
  29     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  30     ***NOTE*** The exception to the GPL is included to allow you to distribute\r
  31     a combined work that includes FreeRTOS without being obliged to provide the\r
  32     source code for proprietary components outside of the FreeRTOS kernel.\r
  33     FreeRTOS is distributed in the hope that it will be useful, but WITHOUT\r
  34     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or\r
  35     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  36     more details. You should have received a copy of the GNU General Public \r
  37     License and the FreeRTOS license exception along with FreeRTOS; if not it \r
  38     can be viewed here: http://www.freertos.org/a00114.html and also obtained \r
  39     by writing to Richard Barry, contact details for whom are available on the\r
  40     FreeRTOS WEB site.\r
  41 \r
  42     1 tab == 4 spaces!\r
  43 \r
  44     http://www.FreeRTOS.org - Documentation, latest information, license and\r
  45     contact details.\r
  46 \r
  47     http://www.SafeRTOS.com - A version that is certified for use in safety\r
  48     critical systems.\r
  49 \r
  50     http://www.OpenRTOS.com - Commercial support, development, porting,\r
  51     licensing and training services.\r
  52 */\r
  53 \r
  54 /*-----------------------------------------------------------\r
  55  * Implementation of functions defined in portable.h for the ARM CM3 port.\r
  56  *----------------------------------------------------------*/\r
  57 \r
  58 /* Scheduler includes. */\r
  59 #include "FreeRTOS.h"\r
  60 #include "task.h"\r
  61 \r
  62 #ifndef configKERNEL_INTERRUPT_PRIORITY\r
  63         #define configKERNEL_INTERRUPT_PRIORITY 255\r
  64 #endif\r
  65 \r
  66 /* Constants required to manipulate the NVIC. */\r
  67 #define portNVIC_SYSTICK_CTRL           ( ( volatile unsigned long *) 0xe000e010 )\r
  68 #define portNVIC_SYSTICK_LOAD           ( ( volatile unsigned long *) 0xe000e014 )\r
  69 #define portNVIC_INT_CTRL                       ( ( volatile unsigned long *) 0xe000ed04 )\r
  70 #define portNVIC_SYSPRI2                        ( ( volatile unsigned long *) 0xe000ed20 )\r
  71 #define portNVIC_SYSTICK_CLK            0x00000004\r
  72 #define portNVIC_SYSTICK_INT            0x00000002\r
  73 #define portNVIC_SYSTICK_ENABLE         0x00000001\r
  74 #define portNVIC_PENDSVSET                      0x10000000\r
  75 #define portNVIC_PENDSV_PRI                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
  76 #define portNVIC_SYSTICK_PRI            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
  77 \r
  78 /* Constants required to set up the initial stack. */\r
  79 #define portINITIAL_XPSR                        ( 0x01000000 )\r
  80 \r
  81 /* Each task maintains its own interrupt status in the critical nesting\r
  82 variable. */\r
  83 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
  84 \r
  85 /* \r
  86  * Setup the timer to generate the tick interrupts.\r
  87  */\r
  88 static void prvSetupTimerInterrupt( void );\r
  89 \r
  90 /*\r
  91  * Exception handlers.\r
  92  */\r
  93 void xPortPendSVHandler( void );\r
  94 void xPortSysTickHandler( void );\r
  95 void vPortSVCHandler( void );\r
  96 \r
  97 /*\r
  98  * Start first task is a separate function so it can be tested in isolation.\r
  99  */\r
 100 void vPortStartFirstTask( void );\r
 101 \r
 102 /*-----------------------------------------------------------*/\r
 103 \r
 104 /* \r
 105  * See header file for description. \r
 106  */\r
 107 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 108 {\r
 109         /* Simulate the stack frame as it would be created by a context switch\r
 110         interrupt. */\r
 111         pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */\r
 112         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 113         pxTopOfStack--;\r
 114         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 115         pxTopOfStack--;\r
 116         *pxTopOfStack = 0;      /* LR */\r
 117         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 118         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 119         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 120 \r
 121         return pxTopOfStack;\r
 122 }\r
 123 /*-----------------------------------------------------------*/\r
 124 \r
 125 __asm void vPortSVCHandler( void )\r
 126 {\r
 127         PRESERVE8\r
 128 \r
 129         ldr     r3, =pxCurrentTCB               /* Restore the context. */\r
 130         ldr r1, [r3]                            /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */\r
 131         ldr r0, [r1]                            /* The first item in pxCurrentTCB is the task top of stack. */\r
 132         ldmia r0!, {r4-r11}             /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */\r
 133         msr psp, r0                                     /* Restore the task stack pointer. */\r
 134         mov r0, #0\r
 135         msr     basepri, r0\r
 136         orr r14, #0xd                           \r
 137         bx r14                                          \r
 138 }\r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 __asm void vPortStartFirstTask( void )\r
 142 {\r
 143         PRESERVE8\r
 144 \r
 145         /* Use the NVIC offset register to locate the stack. */\r
 146         ldr r0, =0xE000ED08\r
 147         ldr r0, [r0]\r
 148         ldr r0, [r0]\r
 149         /* Set the msp back to the start of the stack. */\r
 150         msr msp, r0\r
 151         /* Call SVC to start the first task. */\r
 152         cpsie i\r
 153         svc 0\r
 154         nop\r
 155 }\r
 156 /*-----------------------------------------------------------*/\r
 157 \r
 158 /* \r
 159  * See header file for description. \r
 160  */\r
 161 portBASE_TYPE xPortStartScheduler( void )\r
 162 {\r
 163         /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */\r
 164         *(portNVIC_SYSPRI2) |= portNVIC_PENDSV_PRI;\r
 165         *(portNVIC_SYSPRI2) |= portNVIC_SYSTICK_PRI;\r
 166 \r
 167         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 168         here already. */\r
 169         prvSetupTimerInterrupt();\r
 170         \r
 171         /* Initialise the critical nesting count ready for the first task. */\r
 172         uxCriticalNesting = 0;\r
 173 \r
 174         /* Start the first task. */\r
 175         vPortStartFirstTask();\r
 176 \r
 177         /* Should not get here! */\r
 178         return 0;\r
 179 }\r
 180 /*-----------------------------------------------------------*/\r
 181 \r
 182 void vPortEndScheduler( void )\r
 183 {\r
 184         /* It is unlikely that the CM3 port will require this function as there\r
 185         is nothing to return to.  */\r
 186 }\r
 187 /*-----------------------------------------------------------*/\r
 188 \r
 189 void vPortYieldFromISR( void )\r
 190 {\r
 191         /* Set a PendSV to request a context switch. */\r
 192         *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;\r
 193 }\r
 194 /*-----------------------------------------------------------*/\r
 195 \r
 196 void vPortEnterCritical( void )\r
 197 {\r
 198         portDISABLE_INTERRUPTS();\r
 199         uxCriticalNesting++;\r
 200 }\r
 201 /*-----------------------------------------------------------*/\r
 202 \r
 203 void vPortExitCritical( void )\r
 204 {\r
 205         uxCriticalNesting--;\r
 206         if( uxCriticalNesting == 0 )\r
 207         {\r
 208                 portENABLE_INTERRUPTS();\r
 209         }\r
 210 }\r
 211 /*-----------------------------------------------------------*/\r
 212 \r
 213 __asm void xPortPendSVHandler( void )\r
 214 {\r
 215         extern uxCriticalNesting;\r
 216         extern pxCurrentTCB;\r
 217         extern vTaskSwitchContext;\r
 218 \r
 219         PRESERVE8\r
 220 \r
 221         mrs r0, psp                                              \r
 222 \r
 223         ldr     r3, =pxCurrentTCB                        /* Get the location of the current TCB. */\r
 224         ldr     r2, [r3]                                                \r
 225 \r
 226         stmdb r0!, {r4-r11}                              /* Save the remaining registers. */\r
 227         str r0, [r2]                                     /* Save the new top of stack into the first member of the TCB. */\r
 228 \r
 229         stmdb sp!, {r3, r14}            \r
 230         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 231         msr basepri, r0          \r
 232         bl vTaskSwitchContext\r
 233         mov r0, #0\r
 234         msr basepri, r0\r
 235         ldmia sp!, {r3, r14}                    \r
 236 \r
 237         ldr r1, [r3]                                     \r
 238         ldr r0, [r1]                                     /* The first item in pxCurrentTCB is the task top of stack. */\r
 239         ldmia r0!, {r4-r11}                      /* Pop the registers and the critical nesting count. */\r
 240         msr psp, r0                                              \r
 241         bx r14\r
 242         nop\r
 243 }\r
 244 /*-----------------------------------------------------------*/\r
 245 \r
 246 void xPortSysTickHandler( void )\r
 247 {\r
 248 unsigned long ulDummy;\r
 249 \r
 250         /* If using preemption, also force a context switch. */\r
 251         #if configUSE_PREEMPTION == 1\r
 252                 *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;      \r
 253         #endif\r
 254 \r
 255         ulDummy = portSET_INTERRUPT_MASK_FROM_ISR();\r
 256         {\r
 257                 vTaskIncrementTick();\r
 258         }\r
 259         portCLEAR_INTERRUPT_MASK_FROM_ISR( ulDummy );\r
 260 }\r
 261 /*-----------------------------------------------------------*/\r
 262 \r
 263 /*\r
 264  * Setup the systick timer to generate the tick interrupts at the required\r
 265  * frequency.\r
 266  */\r
 267 void prvSetupTimerInterrupt( void )\r
 268 {\r
 269         /* Configure SysTick to interrupt at the requested rate. */\r
 270         *(portNVIC_SYSTICK_LOAD) = ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 271         *(portNVIC_SYSTICK_CTRL) = portNVIC_SYSTICK_CLK | portNVIC_SYSTICK_INT | portNVIC_SYSTICK_ENABLE;\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 __asm void vPortSetInterruptMask( void )\r
 276 {\r
 277         PRESERVE8\r
 278 \r
 279         push { r0 }\r
 280         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 281         msr basepri, r0\r
 282         pop { r0 }\r
 283         bx r14\r
 284 }\r
 285 \r
 286 /*-----------------------------------------------------------*/\r
 287 \r
 288 __asm void vPortClearInterruptMask( void )\r
 289 {\r
 290         PRESERVE8\r
 291 \r
 292         push { r0 }\r
 293         mov r0, #0\r
 294         msr basepri, r0\r
 295         pop { r0 }\r
 296         bx r14\r
 297 }\r