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

   1 /*\r
   2     FreeRTOS V7.2.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3         \r
   4 \r
   5     ***************************************************************************\r
   6      *                                                                       *\r
   7      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
   8      *    Complete, revised, and edited pdf reference manuals are also       *\r
   9      *    available.                                                         *\r
  10      *                                                                       *\r
  11      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  12      *    ensuring you get running as quickly as possible and with an        *\r
  13      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  14      *    the FreeRTOS project to continue with its mission of providing     *\r
  15      *    professional grade, cross platform, de facto standard solutions    *\r
  16      *    for microcontrollers - completely free of charge!                  *\r
  17      *                                                                       *\r
  18      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  19      *                                                                       *\r
  20      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  21      *                                                                       *\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 modification to the GPL is included to allow you to\r
  31     distribute a combined work that includes FreeRTOS without being obliged to\r
  32     provide the source code for proprietary components outside of the FreeRTOS\r
  33     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  34     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  35     or 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     ***************************************************************************\r
  45      *                                                                       *\r
  46      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  47      *    not run, what could be wrong?                                      *\r
  48      *                                                                       *\r
  49      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  50      *                                                                       *\r
  51     ***************************************************************************\r
  52 \r
  53     \r
  54     http://www.FreeRTOS.org - Documentation, training, latest information, \r
  55     license and contact details.\r
  56     \r
  57     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  58     including FreeRTOS+Trace - an indispensable productivity tool.\r
  59 \r
  60     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  61     the code with commercial support, indemnification, and middleware, under \r
  62     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  63     provide a safety engineered and independently SIL3 certified version under \r
  64     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  65 */\r
  66 \r
  67 /*-----------------------------------------------------------\r
  68  * Implementation of functions defined in portable.h for the ARM CM4F port.\r
  69  *----------------------------------------------------------*/\r
  70 \r
  71 /* Scheduler includes. */\r
  72 #include "FreeRTOS.h"\r
  73 #include "task.h"\r
  74 \r
  75 #ifndef __TARGET_FPU_VFP \r
  76         #error This port can only be used when the project options are configured to enable hardware floating point support.\r
  77 #endif\r
  78 \r
  79 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
  80         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
  81 #endif\r
  82 \r
  83 /* Constants required to manipulate the NVIC. */\r
  84 #define portNVIC_SYSTICK_CTRL           ( ( volatile unsigned long *) 0xe000e010 )\r
  85 #define portNVIC_SYSTICK_LOAD           ( ( volatile unsigned long *) 0xe000e014 )\r
  86 #define portNVIC_INT_CTRL                       ( ( volatile unsigned long *) 0xe000ed04 )\r
  87 #define portNVIC_SYSPRI2                        ( ( volatile unsigned long *) 0xe000ed20 )\r
  88 #define portNVIC_SYSTICK_CLK            0x00000004\r
  89 #define portNVIC_SYSTICK_INT            0x00000002\r
  90 #define portNVIC_SYSTICK_ENABLE         0x00000001\r
  91 #define portNVIC_PENDSVSET                      0x10000000\r
  92 #define portNVIC_PENDSV_PRI                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
  93 #define portNVIC_SYSTICK_PRI            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
  94 \r
  95 /* Constants required to manipulate the VFP. */\r
  96 #define portFPCCR                                       ( ( volatile unsigned long * ) 0xe000ef34 ) /* Floating point context control register. */\r
  97 #define portASPEN_AND_LSPEN_BITS        ( 0x3UL << 30UL )\r
  98 \r
  99 /* Constants required to set up the initial stack. */\r
 100 #define portINITIAL_XPSR                        ( 0x01000000 )\r
 101 #define portINITIAL_EXEC_RETURN         ( 0xfffffffd )\r
 102 \r
 103 /* Each task maintains its own interrupt status in the critical nesting\r
 104 variable. */\r
 105 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
 106 \r
 107 /* \r
 108  * Setup the timer to generate the tick interrupts.\r
 109  */\r
 110 static void prvSetupTimerInterrupt( void );\r
 111 \r
 112 /*\r
 113  * Exception handlers.\r
 114  */\r
 115 void xPortPendSVHandler( void );\r
 116 void xPortSysTickHandler( void );\r
 117 void vPortSVCHandler( void );\r
 118 \r
 119 /*\r
 120  * Start first task is a separate function so it can be tested in isolation.\r
 121  */\r
 122 static void prvStartFirstTask( void );\r
 123 \r
 124 /*\r
 125  * Functions defined in portasm.s to enable the VFP.\r
 126  */\r
 127 static void prvEnableVFP( void );\r
 128 \r
 129 /*-----------------------------------------------------------*/\r
 130 \r
 131 /* \r
 132  * See header file for description. \r
 133  */\r
 134 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 135 {\r
 136         /* Simulate the stack frame as it would be created by a context switch\r
 137         interrupt. */\r
 138         \r
 139         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 140         of interrupts, and to ensure alignment. */\r
 141         pxTopOfStack--;\r
 142                 \r
 143         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 144         pxTopOfStack--;\r
 145         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 146         pxTopOfStack--;\r
 147         *pxTopOfStack = 0;      /* LR */\r
 148         \r
 149         /* Save code space by skipping register initialisation. */\r
 150         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 151         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 152 \r
 153         /* A save method is being used that requires each task to maintain its\r
 154         own exec return value. */\r
 155         pxTopOfStack--;\r
 156         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
 157 \r
 158         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 159         \r
 160         return pxTopOfStack;\r
 161 }\r
 162 /*-----------------------------------------------------------*/\r
 163 \r
 164 __asm void vPortSVCHandler( void )\r
 165 {\r
 166         PRESERVE8\r
 167 \r
 168         /* Get the location of the current TCB. */\r
 169         ldr     r3, =pxCurrentTCB\r
 170         ldr r1, [r3]\r
 171         ldr r0, [r1]\r
 172         /* Pop the core registers. */\r
 173         ldmia r0!, {r4-r11, r14}\r
 174         msr psp, r0\r
 175         mov r0, #0\r
 176         msr     basepri, r0     \r
 177         bx r14\r
 178 }\r
 179 /*-----------------------------------------------------------*/\r
 180 \r
 181 __asm void prvStartFirstTask( void )\r
 182 {\r
 183         PRESERVE8\r
 184 \r
 185         /* Use the NVIC offset register to locate the stack. */\r
 186         ldr r0, =0xE000ED08\r
 187         ldr r0, [r0]\r
 188         ldr r0, [r0]\r
 189         /* Set the msp back to the start of the stack. */\r
 190         msr msp, r0\r
 191         /* Globally enable interrupts. */\r
 192         cpsie i\r
 193         /* Call SVC to start the first task. */\r
 194         svc 0\r
 195         nop\r
 196 }\r
 197 /*-----------------------------------------------------------*/\r
 198 \r
 199 __asm void prvEnableVFP( void )\r
 200 {\r
 201         PRESERVE8\r
 202         \r
 203         /* The FPU enable bits are in the CPACR. */\r
 204         ldr.w r0, =0xE000ED88\r
 205         ldr     r1, [r0]\r
 206         \r
 207         /* Enable CP10 and CP11 coprocessors, then save back. */\r
 208         orr     r1, r1, #( 0xf << 20 )\r
 209         str r1, [r0]\r
 210         bx      r14     \r
 211         nop\r
 212 }\r
 213 /*-----------------------------------------------------------*/\r
 214 \r
 215 /* \r
 216  * See header file for description. \r
 217  */\r
 218 portBASE_TYPE xPortStartScheduler( void )\r
 219 {\r
 220         /* Make PendSV, CallSV and SysTick the same priroity as the kernel. */\r
 221         *(portNVIC_SYSPRI2) |= portNVIC_PENDSV_PRI;\r
 222         *(portNVIC_SYSPRI2) |= portNVIC_SYSTICK_PRI;\r
 223 \r
 224         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 225         here already. */\r
 226         prvSetupTimerInterrupt();\r
 227         \r
 228         /* Initialise the critical nesting count ready for the first task. */\r
 229         uxCriticalNesting = 0;\r
 230 \r
 231         /* Ensure the VFP is enabled - it should be anyway. */\r
 232         prvEnableVFP();\r
 233         \r
 234         /* Lazy save always. */\r
 235         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
 236         \r
 237         /* Start the first task. */\r
 238         prvStartFirstTask();\r
 239 \r
 240         /* Should not get here! */\r
 241         return 0;\r
 242 }\r
 243 /*-----------------------------------------------------------*/\r
 244 \r
 245 void vPortEndScheduler( void )\r
 246 {\r
 247         /* It is unlikely that the CM4F port will require this function as there\r
 248         is nothing to return to.  */\r
 249 }\r
 250 /*-----------------------------------------------------------*/\r
 251 \r
 252 void vPortYieldFromISR( void )\r
 253 {\r
 254         /* Set a PendSV to request a context switch. */\r
 255         *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;\r
 256 }\r
 257 /*-----------------------------------------------------------*/\r
 258 \r
 259 void vPortEnterCritical( void )\r
 260 {\r
 261         portDISABLE_INTERRUPTS();\r
 262         uxCriticalNesting++;\r
 263 }\r
 264 /*-----------------------------------------------------------*/\r
 265 \r
 266 void vPortExitCritical( void )\r
 267 {\r
 268         uxCriticalNesting--;\r
 269         if( uxCriticalNesting == 0 )\r
 270         {\r
 271                 portENABLE_INTERRUPTS();\r
 272         }\r
 273 }\r
 274 /*-----------------------------------------------------------*/\r
 275 \r
 276 __asm void xPortPendSVHandler( void )\r
 277 {\r
 278         extern uxCriticalNesting;\r
 279         extern pxCurrentTCB;\r
 280         extern vTaskSwitchContext;\r
 281 \r
 282         PRESERVE8\r
 283 \r
 284         mrs r0, psp                                             \r
 285         \r
 286         /* Get the location of the current TCB. */\r
 287         ldr     r3, =pxCurrentTCB                       \r
 288         ldr     r2, [r3]                                                \r
 289 \r
 290         /* Is the task using the FPU context?  If so, push high vfp registers. */\r
 291         tst r14, #0x10\r
 292         it eq\r
 293         vstmdbeq r0!, {s16-s31}\r
 294 \r
 295         /* Save the core registers. */\r
 296         stmdb r0!, {r4-r11, r14}                                \r
 297         \r
 298         /* Save the new top of stack into the first member of the TCB. */\r
 299         str r0, [r2]\r
 300         \r
 301         stmdb sp!, {r3, r14}\r
 302         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 303         msr basepri, r0\r
 304         bl vTaskSwitchContext                   \r
 305         mov r0, #0\r
 306         msr basepri, r0\r
 307         ldmia sp!, {r3, r14}\r
 308 \r
 309         /* The first item in pxCurrentTCB is the task top of stack. */\r
 310         ldr r1, [r3]    \r
 311         ldr r0, [r1]\r
 312         \r
 313         /* Pop the core registers. */\r
 314         ldmia r0!, {r4-r11, r14}\r
 315 \r
 316         /* Is the task using the FPU context?  If so, pop the high vfp registers \r
 317         too. */\r
 318         tst r14, #0x10\r
 319         it eq\r
 320         vldmiaeq r0!, {s16-s31}\r
 321         \r
 322         msr psp, r0                                             \r
 323         bx r14          \r
 324         nop                                     \r
 325 }\r
 326 /*-----------------------------------------------------------*/\r
 327 \r
 328 void xPortSysTickHandler( void )\r
 329 {\r
 330 unsigned long ulDummy;\r
 331 \r
 332         /* If using preemption, also force a context switch. */\r
 333         #if configUSE_PREEMPTION == 1\r
 334                 *(portNVIC_INT_CTRL) = portNVIC_PENDSVSET;      \r
 335         #endif\r
 336 \r
 337         ulDummy = portSET_INTERRUPT_MASK_FROM_ISR();\r
 338         {\r
 339                 vTaskIncrementTick();\r
 340         }\r
 341         portCLEAR_INTERRUPT_MASK_FROM_ISR( ulDummy );\r
 342 }\r
 343 /*-----------------------------------------------------------*/\r
 344 \r
 345 /*\r
 346  * Setup the systick timer to generate the tick interrupts at the required\r
 347  * frequency.\r
 348  */\r
 349 void prvSetupTimerInterrupt( void )\r
 350 {\r
 351         /* Configure SysTick to interrupt at the requested rate. */\r
 352         *(portNVIC_SYSTICK_LOAD) = ( configCPU_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 353         *(portNVIC_SYSTICK_CTRL) = portNVIC_SYSTICK_CLK | portNVIC_SYSTICK_INT | portNVIC_SYSTICK_ENABLE;\r
 354 }\r
 355 /*-----------------------------------------------------------*/\r
 356 \r
 357 __asm void vPortSetInterruptMask( void )\r
 358 {\r
 359         PRESERVE8\r
 360 \r
 361         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 362         msr basepri, r0\r
 363         bx r14\r
 364 }\r
 365 \r
 366 /*-----------------------------------------------------------*/\r
 367 \r
 368 __asm void vPortClearInterruptMask( void )\r
 369 {\r
 370         PRESERVE8\r
 371 \r
 372         mov r0, #0\r
 373         msr basepri, r0\r
 374         bx r14\r
 375 }\r