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