git.sur5r.net Git - freertos/blob - FreeRTOS/Source/portable/IAR/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 __ARMVFP__\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 #ifndef configSYSTICK_CLOCK_HZ\r
  84         #define configSYSTICK_CLOCK_HZ configCPU_CLOCK_HZ\r
  85         #if configUSE_TICKLESS_IDLE == 1\r
  86                 static const unsigned long ulStoppedTimerCompensation = 45UL;\r
  87         #endif\r
  88 #else /* configSYSTICK_CLOCK_HZ */\r
  89         #if configUSE_TICKLESS_IDLE == 1\r
  90                 /* Assumes the SysTick clock is slower than the CPU clock. */\r
  91                 static const unsigned long ulStoppedTimerCompensation = 45UL / ( configCPU_CLOCK_HZ / configSYSTICK_CLOCK_HZ );\r
  92         #endif\r
  93 #endif  /* configSYSTICK_CLOCK_HZ */\r
  94 \r
  95 /* Constants required to manipulate the core.  Registers first... */\r
  96 #define portNVIC_SYSTICK_CTRL_REG                       ( * ( ( volatile unsigned long * ) 0xe000e010 ) )\r
  97 #define portNVIC_SYSTICK_LOAD_REG                       ( * ( ( volatile unsigned long * ) 0xe000e014 ) )\r
  98 #define portNVIC_SYSTICK_CURRENT_VALUE_REG      ( * ( ( volatile unsigned long * ) 0xe000e018 ) )\r
  99 #define portNVIC_INT_CTRL_REG                           ( * ( ( volatile unsigned long * ) 0xe000ed04 ) )\r
 100 #define portNVIC_SYSPRI2_REG                            ( * ( ( volatile unsigned long * ) 0xe000ed20 ) )\r
 101 /* ...then bits in the registers. */\r
 102 #define portNVIC_SYSTICK_CLK_BIT                        ( 1UL << 2UL )\r
 103 #define portNVIC_SYSTICK_INT_BIT                        ( 1UL << 1UL )\r
 104 #define portNVIC_SYSTICK_ENABLE_BIT                     ( 1UL << 0UL )\r
 105 #define portNVIC_SYSTICK_COUNT_FLAG_BIT         ( 1UL << 16UL )\r
 106 #define portNVIC_PENDSVSET_BIT                          ( 1UL << 28UL )\r
 107 #define portNVIC_PENDSVCLEAR_BIT                        ( 1UL << 27UL )\r
 108 #define portNVIC_PEND_SYSTICK_CLEAR_BIT         ( 1UL << 25UL )\r
 109 \r
 110 #define portNVIC_PENDSV_PRI                     ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 16 )\r
 111 #define portNVIC_SYSTICK_PRI            ( ( ( unsigned long ) configKERNEL_INTERRUPT_PRIORITY ) << 24 )\r
 112 \r
 113 /* Constants required to manipulate the VFP. */\r
 114 #define portFPCCR                                       ( ( volatile unsigned long * ) 0xe000ef34 ) /* Floating point context control register. */\r
 115 #define portASPEN_AND_LSPEN_BITS        ( 0x3UL << 30UL )\r
 116 \r
 117 /* Constants required to set up the initial stack. */\r
 118 #define portINITIAL_XPSR                        ( 0x01000000 )\r
 119 #define portINITIAL_EXEC_RETURN         ( 0xfffffffd )\r
 120 \r
 121 /* Each task maintains its own interrupt status in the critical nesting\r
 122 variable. */\r
 123 static unsigned portBASE_TYPE uxCriticalNesting = 0xaaaaaaaa;\r
 124 \r
 125 /*\r
 126  * Setup the timer to generate the tick interrupts.\r
 127  */\r
 128 static void prvSetupTimerInterrupt( void );\r
 129 \r
 130 /*\r
 131  * Exception handlers.\r
 132  */\r
 133 void xPortSysTickHandler( void );\r
 134 \r
 135 /*\r
 136  * Start first task is a separate function so it can be tested in isolation.\r
 137  */\r
 138 extern void vPortStartFirstTask( void );\r
 139 \r
 140 /*\r
 141  * Turn the VFP on.\r
 142  */\r
 143 extern void vPortEnableVFP( void );\r
 144 \r
 145 /*-----------------------------------------------------------*/\r
 146 \r
 147 /*\r
 148  * The number of SysTick increments that make up one tick period.\r
 149  */\r
 150 static unsigned long ulTimerReloadValueForOneTick = 0;\r
 151 \r
 152 /*\r
 153  * The maximum number of tick periods that can be suppressed is limited by the\r
 154  * 24 bit resolution of the SysTick timer.\r
 155  */\r
 156 #if configUSE_TICKLESS_IDLE == 1\r
 157         static unsigned long xMaximumPossibleSuppressedTicks = 0;\r
 158 #endif /* configUSE_TICKLESS_IDLE */\r
 159 \r
 160 /*-----------------------------------------------------------*/\r
 161 \r
 162 /*\r
 163  * See header file for description.\r
 164  */\r
 165 portSTACK_TYPE *pxPortInitialiseStack( portSTACK_TYPE *pxTopOfStack, pdTASK_CODE pxCode, void *pvParameters )\r
 166 {\r
 167         /* Simulate the stack frame as it would be created by a context switch\r
 168         interrupt. */\r
 169 \r
 170         /* Offset added to account for the way the MCU uses the stack on entry/exit\r
 171         of interrupts, and to ensure alignment. */\r
 172         pxTopOfStack--;\r
 173 \r
 174         *pxTopOfStack = portINITIAL_XPSR;       /* xPSR */\r
 175         pxTopOfStack--;\r
 176         *pxTopOfStack = ( portSTACK_TYPE ) pxCode;      /* PC */\r
 177         pxTopOfStack--;\r
 178         *pxTopOfStack = 0;      /* LR */\r
 179 \r
 180         /* Save code space by skipping register initialisation. */\r
 181         pxTopOfStack -= 5;      /* R12, R3, R2 and R1. */\r
 182         *pxTopOfStack = ( portSTACK_TYPE ) pvParameters;        /* R0 */\r
 183 \r
 184         /* A save method is being used that requires each task to maintain its\r
 185         own exec return value. */\r
 186         pxTopOfStack--;\r
 187         *pxTopOfStack = portINITIAL_EXEC_RETURN;\r
 188 \r
 189         pxTopOfStack -= 8;      /* R11, R10, R9, R8, R7, R6, R5 and R4. */\r
 190 \r
 191         return pxTopOfStack;\r
 192 }\r
 193 /*-----------------------------------------------------------*/\r
 194 \r
 195 /*\r
 196  * See header file for description.\r
 197  */\r
 198 portBASE_TYPE xPortStartScheduler( void )\r
 199 {\r
 200         /* Make PendSV and SysTick the lowest priority interrupts. */\r
 201         portNVIC_SYSPRI2_REG |= portNVIC_PENDSV_PRI;\r
 202         portNVIC_SYSPRI2_REG |= portNVIC_SYSTICK_PRI;\r
 203 \r
 204         /* Start the timer that generates the tick ISR.  Interrupts are disabled\r
 205         here already. */\r
 206         prvSetupTimerInterrupt();\r
 207 \r
 208         /* Initialise the critical nesting count ready for the first task. */\r
 209         uxCriticalNesting = 0;\r
 210 \r
 211         /* Ensure the VFP is enabled - it should be anyway. */\r
 212         vPortEnableVFP();\r
 213 \r
 214         /* Lazy save always. */\r
 215         *( portFPCCR ) |= portASPEN_AND_LSPEN_BITS;\r
 216 \r
 217         /* Start the first task. */\r
 218         vPortStartFirstTask();\r
 219 \r
 220         /* Should not get here! */\r
 221         return 0;\r
 222 }\r
 223 /*-----------------------------------------------------------*/\r
 224 \r
 225 void vPortEndScheduler( void )\r
 226 {\r
 227         /* It is unlikely that the CM4F port will require this function as there\r
 228         is nothing to return to.  */\r
 229 }\r
 230 /*-----------------------------------------------------------*/\r
 231 \r
 232 void vPortYieldFromISR( void )\r
 233 {\r
 234         /* Set a PendSV to request a context switch. */\r
 235         portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 236 }\r
 237 /*-----------------------------------------------------------*/\r
 238 \r
 239 void vPortEnterCritical( void )\r
 240 {\r
 241         portDISABLE_INTERRUPTS();\r
 242         uxCriticalNesting++;\r
 243 }\r
 244 /*-----------------------------------------------------------*/\r
 245 \r
 246 void vPortExitCritical( void )\r
 247 {\r
 248         uxCriticalNesting--;\r
 249         if( uxCriticalNesting == 0 )\r
 250         {\r
 251                 portENABLE_INTERRUPTS();\r
 252         }\r
 253 }\r
 254 /*-----------------------------------------------------------*/\r
 255 \r
 256 void xPortSysTickHandler( void )\r
 257 {\r
 258         /* If using preemption, also force a context switch. */\r
 259         #if configUSE_PREEMPTION == 1\r
 260                 portNVIC_INT_CTRL_REG = portNVIC_PENDSVSET_BIT;\r
 261         #endif\r
 262 \r
 263         #if configUSE_TICKLESS_IDLE == 1\r
 264                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;\r
 265         #endif\r
 266 \r
 267         ( void ) portSET_INTERRUPT_MASK_FROM_ISR();\r
 268         {\r
 269                 vTaskIncrementTick();\r
 270         }\r
 271         portCLEAR_INTERRUPT_MASK_FROM_ISR( 0 );\r
 272 }\r
 273 /*-----------------------------------------------------------*/\r
 274 \r
 275 #if configUSE_TICKLESS_IDLE == 1\r
 276 \r
 277         __weak void vPortSuppressTicksAndSleep( portTickType xExpectedIdleTime )\r
 278         {\r
 279         unsigned long ulReloadValue, ulCompleteTickPeriods, ulCompletedSysTickIncrements;\r
 280 \r
 281                 /* Make sure the SysTick reload value does not overflow the counter. */\r
 282                 if( xExpectedIdleTime > xMaximumPossibleSuppressedTicks )\r
 283                 {\r
 284                         xExpectedIdleTime = xMaximumPossibleSuppressedTicks;\r
 285                 }\r
 286 \r
 287                 /* Calculate the reload value required to wait xExpectedIdleTime\r
 288                 tick periods.  -1 is used because this code will execute part way\r
 289                 through one of the tick periods, and the fraction of a tick period is\r
 290                 accounted for later. */\r
 291                 ulReloadValue = ( ulTimerReloadValueForOneTick * ( xExpectedIdleTime - 1UL ) );\r
 292                 if( ulReloadValue > ulStoppedTimerCompensation )\r
 293                 {\r
 294                         ulReloadValue -= ulStoppedTimerCompensation;\r
 295                 }\r
 296 \r
 297                 /* Stop the SysTick momentarily.  The time the SysTick is stopped for\r
 298                 is accounted for as best it can be, but using the tickless mode will\r
 299                 inevitably result in some tiny drift of the time maintained by the\r
 300                 kernel with respect to calendar time. */\r
 301                 portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 302 \r
 303                 /* If a context switch is pending then abandon the low power entry as\r
 304                 the context switch might have been pended by an external interrupt that\r
 305                 requires processing. */\r
 306                 if( ( portNVIC_INT_CTRL_REG & portNVIC_PENDSVSET_BIT ) != 0 )\r
 307                 {\r
 308                         /* Restart SysTick. */\r
 309                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 310                 }\r
 311                 else\r
 312                 {\r
 313                         /* Adjust the reload value to take into account that the current\r
 314                         time slice is already partially complete. */\r
 315                         ulReloadValue += ( portNVIC_SYSTICK_LOAD_REG - ( portNVIC_SYSTICK_LOAD_REG - portNVIC_SYSTICK_CURRENT_VALUE_REG ) );\r
 316                         portNVIC_SYSTICK_LOAD_REG = ulReloadValue;\r
 317 \r
 318                         /* Clear the SysTick count flag and set the count value back to\r
 319                         zero. */\r
 320                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 321 \r
 322                         /* Restart SysTick. */\r
 323                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 324 \r
 325                         /* Sleep until something happens. */\r
 326                         portPRE_SLEEP_PROCESSING();\r
 327                         __WFI();\r
 328                         portPOST_SLEEP_PROCESSING();\r
 329 \r
 330                         /* Stop SysTick.  Again, the time the SysTick is stopped for is\r
 331                         accounted for as best it can be, but using the tickless mode will\r
 332                         inevitably result in some tiny drift of the time maintained by the\r
 333                         kernel with respect to calendar time. */\r
 334                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT;\r
 335 \r
 336                         if( ( portNVIC_SYSTICK_CTRL_REG & portNVIC_SYSTICK_COUNT_FLAG_BIT ) != 0 )\r
 337                         {\r
 338                                 /* The tick interrupt has already executed, and the SysTick\r
 339                                 count reloaded with the portNVIC_SYSTICK_LOAD_REG value.\r
 340                                 Reset the portNVIC_SYSTICK_LOAD_REG with whatever remains of\r
 341                                 this tick period. */\r
 342                                 portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick - ( ulReloadValue - portNVIC_SYSTICK_CURRENT_VALUE_REG );\r
 343 \r
 344                                 /* The tick interrupt handler will already have pended the tick\r
 345                                 processing in the kernel.  As the pending tick will be\r
 346                                 processed as soon as this function exits, the tick value\r
 347                                 maintained by the tick is stepped forward by one less than the\r
 348                                 time spent waiting. */\r
 349                                 ulCompleteTickPeriods = xExpectedIdleTime - 1UL;\r
 350                         }\r
 351                         else\r
 352                         {\r
 353                                 /* Something other than the tick interrupt ended the sleep.\r
 354                                 Work out how long the sleep lasted. */\r
 355                                 ulCompletedSysTickIncrements = ( xExpectedIdleTime * ulTimerReloadValueForOneTick ) - portNVIC_SYSTICK_CURRENT_VALUE_REG;\r
 356 \r
 357                                 /* How many complete tick periods passed while the processor\r
 358                                 was waiting? */\r
 359                                 ulCompleteTickPeriods = ulCompletedSysTickIncrements / ulTimerReloadValueForOneTick;\r
 360 \r
 361                                 /* The reload value is set to whatever fraction of a single tick\r
 362                                 period remains. */\r
 363                                 portNVIC_SYSTICK_LOAD_REG = ( ( ulCompleteTickPeriods + 1 ) * ulTimerReloadValueForOneTick ) - ulCompletedSysTickIncrements;\r
 364                         }\r
 365 \r
 366                         /* Restart SysTick so it runs from portNVIC_SYSTICK_LOAD_REG\r
 367                         again, then set portNVIC_SYSTICK_LOAD_REG back to its standard\r
 368                         value. */\r
 369                         portNVIC_SYSTICK_CURRENT_VALUE_REG = 0UL;\r
 370                         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 371 \r
 372                         vTaskStepTick( ulCompleteTickPeriods );\r
 373                 }\r
 374         }\r
 375 \r
 376 #endif /* #if configUSE_TICKLESS_IDLE */\r
 377 /*-----------------------------------------------------------*/\r
 378 \r
 379 /*\r
 380  * Setup the systick timer to generate the tick interrupts at the required\r
 381  * frequency.\r
 382  */\r
 383 void prvSetupTimerInterrupt( void )\r
 384 {\r
 385         /* Configure the constants required to setup the tick interrupt. */\r
 386         ulTimerReloadValueForOneTick = ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL;\r
 387         #if configUSE_TICKLESS_IDLE == 1\r
 388                 xMaximumPossibleSuppressedTicks = 0xffffffUL / ( ( configSYSTICK_CLOCK_HZ / configTICK_RATE_HZ ) - 1UL );\r
 389         #endif /* configUSE_TICKLESS_IDLE */\r
 390 \r
 391         /* Configure SysTick to interrupt at the requested rate. */\r
 392         portNVIC_SYSTICK_LOAD_REG = ulTimerReloadValueForOneTick;\r
 393         portNVIC_SYSTICK_CTRL_REG = portNVIC_SYSTICK_CLK_BIT | portNVIC_SYSTICK_INT_BIT | portNVIC_SYSTICK_ENABLE_BIT;\r
 394 }\r
 395 /*-----------------------------------------------------------*/\r
 396 \r