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

   1 /*\r
   2     FreeRTOS V7.3.0 - Copyright (C) 2012 Real Time Engineers Ltd.\r
   3 \r
   4     FEATURES AND PORTS ARE ADDED TO FREERTOS ALL THE TIME.  PLEASE VISIT \r
   5     http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.\r
   6 \r
   7     ***************************************************************************\r
   8      *                                                                       *\r
   9      *    FreeRTOS tutorial books are available in pdf and paperback.        *\r
  10      *    Complete, revised, and edited pdf reference manuals are also       *\r
  11      *    available.                                                         *\r
  12      *                                                                       *\r
  13      *    Purchasing FreeRTOS documentation will not only help you, by       *\r
  14      *    ensuring you get running as quickly as possible and with an        *\r
  15      *    in-depth knowledge of how to use FreeRTOS, it will also help       *\r
  16      *    the FreeRTOS project to continue with its mission of providing     *\r
  17      *    professional grade, cross platform, de facto standard solutions    *\r
  18      *    for microcontrollers - completely free of charge!                  *\r
  19      *                                                                       *\r
  20      *    >>> See http://www.FreeRTOS.org/Documentation for details. <<<     *\r
  21      *                                                                       *\r
  22      *    Thank you for using FreeRTOS, and thank you for your support!      *\r
  23      *                                                                       *\r
  24     ***************************************************************************\r
  25 \r
  26 \r
  27     This file is part of the FreeRTOS distribution.\r
  28 \r
  29     FreeRTOS is free software; you can redistribute it and/or modify it under\r
  30     the terms of the GNU General Public License (version 2) as published by the\r
  31     Free Software Foundation AND MODIFIED BY the FreeRTOS exception.\r
  32     >>>NOTE<<< The modification to the GPL is included to allow you to\r
  33     distribute a combined work that includes FreeRTOS without being obliged to\r
  34     provide the source code for proprietary components outside of the FreeRTOS\r
  35     kernel.  FreeRTOS is distributed in the hope that it will be useful, but\r
  36     WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
  37     or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for\r
  38     more details. You should have received a copy of the GNU General Public\r
  39     License and the FreeRTOS license exception along with FreeRTOS; if not it\r
  40     can be viewed here: http://www.freertos.org/a00114.html and also obtained\r
  41     by writing to Richard Barry, contact details for whom are available on the\r
  42     FreeRTOS WEB site.\r
  43 \r
  44     1 tab == 4 spaces!\r
  45     \r
  46     ***************************************************************************\r
  47      *                                                                       *\r
  48      *    Having a problem?  Start by reading the FAQ "My application does   *\r
  49      *    not run, what could be wrong?"                                     *\r
  50      *                                                                       *\r
  51      *    http://www.FreeRTOS.org/FAQHelp.html                               *\r
  52      *                                                                       *\r
  53     ***************************************************************************\r
  54 \r
  55     \r
  56     http://www.FreeRTOS.org - Documentation, training, latest versions, license \r
  57     and contact details.  \r
  58     \r
  59     http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,\r
  60     including FreeRTOS+Trace - an indispensable productivity tool.\r
  61 \r
  62     Real Time Engineers ltd license FreeRTOS to High Integrity Systems, who sell \r
  63     the code with commercial support, indemnification, and middleware, under \r
  64     the OpenRTOS brand: http://www.OpenRTOS.com.  High Integrity Systems also\r
  65     provide a safety engineered and independently SIL3 certified version under \r
  66     the SafeRTOS brand: http://www.SafeRTOS.com.\r
  67 */\r
  68 \r
  69 /*-----------------------------------------------------------\r
  70  * Implementation of functions defined in portable.h for the ARM CM3 port.\r
  71  *----------------------------------------------------------*/\r
  72 \r
  73 /* Scheduler includes. */\r
  74 #include "FreeRTOS.h"\r
  75 #include "task.h"\r
  76 \r
  77 #ifndef configKERNEL_INTERRUPT_PRIORITY\r
  78         #define configKERNEL_INTERRUPT_PRIORITY 255\r
  79 #endif\r
  80 \r
  81 #if configMAX_SYSCALL_INTERRUPT_PRIORITY == 0\r
  82         #error configMAX_SYSCALL_INTERRUPT_PRIORITY must not be set to 0.  See http://www.FreeRTOS.org/RTOS-Cortex-M3-M4.html\r
  83 #endif\r
  84 \r
  85 #ifndef configSYSTICK_CLOCK_HZ\r
  86         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
  87         #if configUSE_TICKLESS_IDLE == 1\r
  88                 static const unsigned long ulStoppedTimerCompensation = 45UL;\r
  89         #endif\r
  90 #else /* configSYSTICK_CLOCK_HZ */\r
  91         #if configUSE_TICKLESS_IDLE == 1\r
  92                 /* Assumes the SysTick clock is slower than the CPU clock. */\r
  93                 static const unsigned long ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
  94         #endif\r
  95 #endif  /* configSYSTICK_CLOCK_HZ */\r
  96 \r
  97 /* Constants required to manipulate the core.  Registers first... */\r
  98 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
  99 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
 100 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
 101 #define portNVIC_INT_CTRL_REG                           ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )\r
 102 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
 103 /* ...then bits in the registers. */\r
 104 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
 105 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
 106 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
 107 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
 108 #define portNVIC_PENDSVSET_BIT                          ( 1UL << 28UL )\r
 109 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
 110 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
 111 \r
 112 #define portNVIC_PENDSV_PRI                                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
 113 #define portNVIC_SYSTICK_PRI                            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
 114 \r
 115 /* Constants required to set up the initial stack. */\r
 116 #define portINITIAL_XPSR                        ( 0x01000000 )\r
 117 \r
 118 /* Each task maintains its own interrupt status in the critical nesting\r
 119 variable. */\r
 120 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
 121 \r
 122 /*\r
 123  * Setup the timer to generate the tick interrupts.\r
 124  */\r
 125 static void prvSetupTimerInterrupt( void );\r
 126 \r
 127 /*\r
 128  * Exception handlers.\r
 129  */\r
 130 void xPortPendSVHandler( void );\r
 131 void xPortSysTickHandler( void );\r
 132 void vPortSVCHandler( void );\r
 133 \r
 134 /*\r
 135  * Start first task is a separate function so it can be tested in isolation.\r
 136  */\r
 137 static void prvStartFirstTask( void );\r
 138 \r
 139 /*-----------------------------------------------------------*/\r
 140 \r
 141 /*\r
 142  * The number of SysTick increments that make up one tick period.\r
 143  */\r
 144 static unsigned long ulTimerReloadValueForOneTick = 0;\r
 145 \r
 146 /*\r
 147  * The maximum number of tick periods that can be suppressed is limited by the\r
 148  * 24 bit resolution of the SysTick timer.\r
 149  */\r
 150 #if configUSE_TICKLESS_IDLE == 1\r
 151         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
 152 #endif /* configUSE_TICKLESS_IDLE */\r
 153 \r
 154 /*-----------------------------------------------------------*/\r
 155 \r
 156 /*\r
 157  * See header file for description.\r
 158  */\r
 159 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 160 {\r
 161         /* Simulate the stack frame as it would be created by a context switch\r
 162         interrupt. */\r
 163         pxTopOfStack--; /* Offset added to account for the way the MCU uses the stack on entry/exit of interrupts. */\r
 164         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 165         pxTopOfStack--;\r
 166         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 167         pxTopOfStack--;\r
 168         *pxTopOfStack = 0;      /* LR */\r
 169         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 170         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 171         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 172 \r
 173         return pxTopOfStack;\r
 174 }\r
 175 /*-----------------------------------------------------------*/\r
 176 \r
 177 __asm void vPortSVCHandler( void )\r
 178 {\r
 179         PRESERVE8\r
 180 \r
 181         ldr     r3, =pxCurrentTCB       /* Restore the context. */\r
 182         ldr r1, [r3]                    /* Use pxCurrentTCBConst to get the pxCurrentTCB address. */\r
 183         ldr r0, [r1]                    /* The first item in pxCurrentTCB is the task top of stack. */\r
 184         ldmia r0!, {r4-r11}             /* Pop the registers that are not automatically saved on exception entry and the critical nesting count. */\r
 185         msr psp, r0                             /* Restore the task stack pointer. */\r
 186         mov r0, #0\r
 187         msr     basepri, r0\r
 188         orr r14, #0xd\r
 189         bx r14\r
 190 }\r
 191 /*-----------------------------------------------------------*/\r
 192 \r
 193 __asm void prvStartFirstTask( void )\r
 194 {\r
 195         PRESERVE8\r
 196 \r
 197         /* Use the NVIC offset register to locate the stack. */\r
 198         ldr r0, =0xE000ED08\r
 199         ldr r0, [r0]\r
 200         ldr r0, [r0]\r
 201         /* Set the msp back to the start of the stack. */\r
 202         msr msp, r0\r
 203         /* Globally enable interrupts. */\r
 204         cpsie i\r
 205         /* Call SVC to start the first task. */\r
 206         svc 0\r
 207         nop\r
 208 }\r
 209 /*-----------------------------------------------------------*/\r
 210 \r
 211 /*\r
 212  * See header file for description.\r
 213  */\r
 214 portBASE_TYPE xPortStartScheduler( void )\r
 215 {\r
 216         /* Make PendSV, CallSV and SysTick the same priority as the kernel. */\r
 217         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
 218         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
 219 \r
 220         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 221         here already. */\r
 222         prvSetupTimerInterrupt();\r
 223 \r
 224         /* Initialise the critical nesting count ready for the first task. */\r
 225         uxCriticalNesting = 0;\r
 226 \r
 227         /* Start the first task. */\r
 228         prvStartFirstTask();\r
 229 \r
 230         /* Should not get here! */\r
 231         return 0;\r
 232 }\r
 233 /*-----------------------------------------------------------*/\r
 234 \r
 235 void vPortEndScheduler( void )\r
 236 {\r
 237         /* It is unlikely that the CM3 port will require this function as there\r
 238         is nothing to return to.  */\r
 239 }\r
 240 /*-----------------------------------------------------------*/\r
 241 \r
 242 void vPortYieldFromISR( void )\r
 243 {\r
 244         /* Set a PendSV to request a context switch. */\r
 245         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 246 }\r
 247 /*-----------------------------------------------------------*/\r
 248 \r
 249 void vPortEnterCritical( void )\r
 250 {\r
 251         portDISABLE_INTERRUPTS();\r
 252         uxCriticalNesting++;\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 void vPortExitCritical( void )\r
 257 {\r
 258         uxCriticalNesting--;\r
 259         if( uxCriticalNesting == 0 )\r
 260         {\r
 261                 portENABLE_INTERRUPTS();\r
 262         }\r
 263 }\r
 264 /*-----------------------------------------------------------*/\r
 265 \r
 266 __asm void xPortPendSVHandler( void )\r
 267 {\r
 268         extern uxCriticalNesting;\r
 269         extern pxCurrentTCB;\r
 270         extern vTaskSwitchContext;\r
 271 \r
 272         PRESERVE8\r
 273 \r
 274         mrs r0, psp\r
 275 \r
 276         ldr     r3, =pxCurrentTCB               /* Get the location of the current TCB. */\r
 277         ldr     r2, [r3]\r
 278 \r
 279         stmdb r0!, {r4-r11}                     /* Save the remaining registers. */\r
 280         str r0, [r2]                            /* Save the new top of stack into the first member of the TCB. */\r
 281 \r
 282         stmdb sp!, {r3, r14}\r
 283         mov r0, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 284         msr basepri, r0\r
 285         bl vTaskSwitchContext\r
 286         mov r0, #0\r
 287         msr basepri, r0\r
 288         ldmia sp!, {r3, r14}\r
 289 \r
 290         ldr r1, [r3]\r
 291         ldr r0, [r1]                            /* The first item in pxCurrentTCB is the task top of stack. */\r
 292         ldmia r0!, {r4-r11}                     /* Pop the registers and the critical nesting count. */\r
 293         msr psp, r0\r
 294         bx r14\r
 295         nop\r
 296 }\r
 297 /*-----------------------------------------------------------*/\r
 298 \r
 299 void xPortSysTickHandler( void )\r
 300 {\r
 301         #if configUSE_PREEMPTION == 1\r
 302         {\r
 303                 /* If using preemption, also force a context switch. */\r
 304                 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 305         }\r
 306         #endif\r
 307 \r
 308         #if configUSE_TICKLESS_IDLE == 1\r
 309                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;\r
 310         #endif\r
 311 \r
 312         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 313         {\r
 314                 vTaskIncrementTick();\r
 315         }\r
 316         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 317 }\r
 318 /*-----------------------------------------------------------*/\r
 319 \r
 320 #if configUSE_TICKLESS_IDLE == 1\r
 321 \r
 322         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
 323         {\r
 324         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;\r
 325 \r
 326                 /* Make sure the SysTick reload value does not overflow the counter. */\r
 327                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 328                 {\r
 329                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 330                 }\r
 331 \r
 332                 /* Calculate the reload value required to wait xExpectedIdleTime\r
 333                 tick periods.  -1 is used because this code will execute part way\r
 334                 through one of the tick periods, and the fraction of a tick period is\r
 335                 accounted for later. */\r
 336                 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );\r
 337                 if( ulReloadValue > ulStoppedTimerCompensation )\r
 338                 {\r
 339                         ulReloadValue -= ulStoppedTimerCompensation;\r
 340                 }\r
 341 \r
 342                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
 343                 is accounted for as best it can be, but using the tickless mode will\r
 344                 inevitably result in some tiny drift of the time maintained by the\r
 345                 kernel with respect to calendar time. */\r
 346                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 347 \r
 348                 /* If a context switch is pending then abandon the low power entry as\r
 349                 the context switch might have been pended by an external interrupt that\r
 350                 requires processing. */\r
 351                 if( ( portNVIC_INT_CTRL_REG & portNVIC_PENDSVSET_BIT ) != 0 )\r
 352                 {\r
 353                         /* Restart SysTick. */\r
 354                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 355                 }\r
 356                 else\r
 357                 {\r
 358                         /* Adjust the reload value to take into account that the current\r
 359                         time slice is already partially complete. */\r
 360                         ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );\r
 361                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
 362 \r
 363                         /* Clear the SysTick count flag and set the count value back to\r
 364                         zero. */\r
 365                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 366 \r
 367                         /* Restart SysTick. */\r
 368                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 369 \r
 370                         /* Sleep until something happens. */\r
 371                         configPRE_SLEEP_PROCESSING();\r
 372                         __wfi();\r
 373                         configPOST_SLEEP_PROCESSING();\r
 374 \r
 375                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
 376                         accounted for as best it can be, but using the tickless mode will\r
 377                         inevitably result in some tiny drift of the time maintained by the\r
 378                         kernel with respect to calendar time. */\r
 379                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 380 \r
 381                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
 382                         {\r
 383                                 /* The tick interrupt has already executed, and the SysTick\r
 384                                 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.\r
 385                                 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of\r
 386                                 this tick period. */\r
 387                                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
 388 \r
 389                                 /* The tick interrupt handler will already have pended the tick\r
 390                                 processing in the kernel.  As the pending tick will be\r
 391                                 processed as soon as this function exits, the tick value\r
 392                                 maintained by the tick is stepped forward by one less than the\r
 393                                 time spent waiting. */\r
 394                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 395                         }\r
 396                         else\r
 397                         {\r
 398                                 /* Something other than the tick interrupt ended the sleep.\r
 399                                 Work out how long the sleep lasted. */\r
 400                                 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 401 \r
 402                                 /* How many complete tick periods passed while the processor\r
 403                                 was waiting? */\r
 404                                 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;\r
 405 \r
 406                                 /* The reload value is set to whatever fraction of a single tick\r
 407                                 period remains. */\r
 408                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;\r
 409                         }\r
 410 \r
 411                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
 412                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
 413                         value. */\r
 414                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 415                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 416 \r
 417                         vTaskStepTick( ulCompleteTickPeriods );\r
 418                 }\r
 419         }\r
 420 \r
 421 #endif /* #if configUSE_TICKLESS_IDLE */\r
 422 \r
 423 /*-----------------------------------------------------------*/\r
 424 \r
 425 /*\r
 426  * Setup the SysTick timer to generate the tick interrupts at the required\r
 427  * frequency.\r
 428  */\r
 429 void prvSetupTimerInterrupt( void )\r
 430 {\r
 431         /* Calculate the constants required to configure the tick interrupt. */\r
 432         ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 433         #if configUSE_TICKLESS_IDLE == 1\r
 434                 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );\r
 435         #endif /* configUSE_TICKLESS_IDLE */\r
 436 \r
 437         /* Configure SysTick to interrupt at the requested rate. */\r
 438         portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;\r
 439         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 440 }\r
 441 /*-----------------------------------------------------------*/\r
 442 \r
 443 __asm unsigned long ulPortSetInterruptMask( void )\r
 444 {\r
 445         PRESERVE8\r
 446 \r
 447         mrs r0, basepri\r
 448         mov r1, #configMAX_SYSCALL_INTERRUPT_PRIORITY\r
 449         msr basepri, r1\r
 450         bx r14\r
 451 }\r
 452 \r
 453 /*-----------------------------------------------------------*/\r
 454 \r
 455 __asm void vPortClearInterruptMask( unsigned long ulNewMask )\r
 456 {\r
 457         PRESERVE8\r
 458 \r
 459         msr basepri, r0\r
 460         bx r14\r
 461 }\r